Skip to content

Commit

Permalink
build(deps): remove uglify and update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
apaparazzi0329 committed Mar 16, 2023
1 parent dc13031 commit 005122b
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 164 deletions.
152 changes: 0 additions & 152 deletions MIGRATION-V6.md

This file was deleted.

65 changes: 65 additions & 0 deletions MIGRATION-V8.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Upgrading to [email protected]
[Breaking Changes](#breaking-changes)
- [UMD bundle watson.js no longer supported](#umd-bundle-watson.js-no-longer-supported)
- [Support for Node v14 dropped](#support-for-node-v14-dropped)
- [Breaking changes by service](#breaking-changes-by-service)

- [New Features by Service](#new-features-by-service)

## Breaking changes

### UMD bundle watson.js no longer supported
The previously generated `watson.js` UMD bundle will no longer be generated to support updated core requirements

### Support for Node v14 Dropped
In preparation for Node 14 EOL, the SDK no longer supports Node version 14, as reflected in the `engines` property in the package.json file. Version 14 will reach end of life on 30 April 2023.

### Breaking changes by service

#### Assistant v2
- Parameter `createSession` removed from `createSession` function
- Interface `Environment` property `language` removed
- Interface `EnvironmentReleaseReference` renamed to `BaseEnvironmentReleaseReference`
- Interface `EnvironmentOrchestration` renamed to `BaseEnvironmentOrchestration`
- Interface `SkillReference` renamed to `EnvironmentSkill`

#### Discovery v2
- Parameter `smartDocumentUnderstanding` removed from `createCollection` function
- Interface `QueryResponsePassage` and `QueryResultPassage` property `confidence` removed
- Interface `DocumentClassifierEnrichment` property `enrichmentId` is no longer an optional
- QueryAggregation interfaces restructured

#### Natural Language Understanding
- All `sentimentModel` functions removed

#### Speech to Text
- `AR_AR_BROADBANDMODEL` model removed in favor of `AR_MS_BROADBANDMODEL` model


### New Features by Service

#### Assistant v2
- `createAssistant` function
- `listAssistants` function
- `deleteAssistant` function
- `updateEnvironment` function
- `createRelease` function
- `deleteRelease` function
- `getSkill` function
- `updateSkill` function
- `exportSkills` function
- `importSkills` function
- `importSkillsStatus` function
- Improved typing for `message` function call
See details of these functions on IBM's documentation site [here](https://cloud.ibm.com/apidocs/assistant-v2?code=node)

#### Discovery v2
- Aggregation types `QueryTopicAggregation` and `QueryTrendAggregation` added

#### Speech to Text
- added `FR_CA_MULTIMEDIA`, `JA_JP_TELEPHONY`, `NL_NL_MULTIMEDIA`, `SV_SE_TELEPHONY` models

#### Text to Speech
- added `EN_AU_HEIDIEXPRESSIVE`, `EN_AU_JACKEXPRESSIVE`, `EN_US_ALLISONEXPRESSIVE`, `EN_US_EMMAEXPRESSIVE`, `EN_US_LISAEXPRESSIVE`, `EN_US_MICHAELEXPRESSIVE`, `KO_KR_JINV3VOICE`
- Parameters `ratePercentage` and `pitchPercentage` added to `synthesize` function
See details of these new parameters on IBM's documentation site [here](https://cloud.ibm.com/apidocs/text-to-speech?code=node#synthesize)
11 changes: 1 addition & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,11 @@

Node.js client library to use the Watson APIs.

## Announcements

### Natural Language Classifier deprecation
On 9 August 2021, IBM announced the deprecation of the Natural Language Classifier service. The service will no longer be available from 8 August 2022. As of 9 September 2021, you will not be able to create new instances. Existing instances will be supported until 8 August 2022. Any instance that still exists on that date will be deleted.

As an alternative, we encourage you to consider migrating to the Natural Language Understanding service on IBM Cloud that uses deep learning to extract data and insights from text such as keywords, categories, sentiment, emotion, and syntax, along with advanced multi-label text classification capabilities, to provide even richer insights for your business or industry. For more information, see [Migrating to Natural Language Understanding](https://cloud.ibm.com/docs/natural-language-classifier?topic=natural-language-classifier-migrating).
### Package Rename
This package has been moved under the name `ibm-watson`. The package is still available at `watson-developer-cloud`, but that will no longer receive updates. Use `ibm-watson` to stay up to date.

## Before you begin
* You need an [IBM Cloud][ibm-cloud-onboarding] account.

## Prerequisites
- **Node >=14**: This SDK is tested with Node versions 14 and up. It may work on previous versions but this is not officially supported.
- **Node >=16**: This SDK is tested with Node versions 16 and up. It may work on previous versions but this is not officially supported.

## Installation

Expand Down
2 changes: 0 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,6 @@
"tslint-config-prettier": "^1.18.0",
"typedoc": "^0.17.8",
"typescript": "^4.9.4",
"uglify-es": "~3.3.9",
"wav": "~1.0.2"
},
"dependencies": {
Expand Down Expand Up @@ -106,7 +105,6 @@
"lint": "npm run eslint:check && npm run tslint:check",
"build": "tsc && cp package.json dist/",
"doc": "jsdoc -c scripts/jsdoc/config.json",
"minify": "uglifyjs --compress --mangle --output dist/dist/watson.min.js --preamble \"// Watson Developer Cloud\n// JavaScript SDK$npm_package_version\n// Generated at `date`\n// Copyright IBM ($npm_package_license)\n// $npm_package_homepage\" -- dist/dist/watson.js",
"tsc-publish-dry": "tsc-publish --no-checks --dry-run",
"postversion": "npm run tsc-publish-dry",
"test-integration": "jest test/integration",
Expand Down

0 comments on commit 005122b

Please sign in to comment.