0.11.0

Note: APIs may be subject to change.

Breaking changes:

• For *AsStream APIs the JSON response bodies on errors are now automatically converted to objects. This change does not impact successful responses (resolve) cases where the type of the result property remains a Readable stream. For error (reject) cases the type of result changes from a Readable to an Object containing the JSON response. This avoids the need for callers to detect and deserialize the error result content and aligns the errors from *AsStream calls with other errors in the SDK. It also allows an error from an *AsStream response to produce a useful message and benefit from the other error message improvements in this release. Other properties on an error in a *AsStream rejectremain unchanged.

Changes:

• Added new allow fallback option to find query options models.
• Improved error message output and added trace ID to error responses.
• Updated dependencies.
• Updated documentation.

0.10.3

Note: APIs may be subject to change.

Changes:

• Fixed missing CloudantV1 named export.

0.10.2

Note: APIs may be subject to change.

Changes:

• Updated dependencies.
• Updated documentation.

0.10.1

Note: APIs may be subject to change.

Changes:

• Updated dependencies.
• Cleanup examples

0.10.0

Note: APIs may be subject to change.

Breaking Changes:

• The default service URL changed from http://localhost:5984 to https://~replace-with-cloudant-host~.cloudantnosqldb.appdomain.cloud. This change is only breaking for users that do not configure the client with a URL and connect to a local server running on port 5984 (for example a test CouchDB server).
• Attachments included inline in model responses (for example by setting attachments: true when retrieving a document) are now automatically decoded from a Base64 string into a Buffer. This does not impact attachments retrieved directly (for example using getAttachment) and it does not impact *AsStream raw IO responses.

Changes:

• Add missing owner field for replication documents.
• Allow retrieval of additional vendor properties from server information model.
• Update dependencies (including ibm-cloud-sdk-core@5.0.0 that reduces the package footprint by removing test dependencies).
• Update documentation.

0.9.2

Note: APIs may be subject to change.

Changes:

• Add instanceStartTime to detect database recreation in database information model.
• Updated dependencies.

0.9.1

Note: APIs may be subject to change.

Changes:

• New model extensions for _explain index analysis.
• Removed incorrect accept header parameter from POST /{db}/_design_docs.
• Updated dependencies.
• Updated documentation.

0.9.0

Note: APIs may be subject to change.

Breaking Changes:

• For the full list of code changes needed for this version see 0.9.0 API changes.
• Unify parameter and property name case conventions across models.
• Preserve leading _ metadata names in models that also accept user-defined properties (i.e. documents) to eliminate the risk of clashing e.g. _id and a user-defined id.

Changes:

• Fix unexpected 401 responses from infrequent requests occuring close to an IAM token expiry time (via updated core dependency).
• Updated dependencies.

0.8.3

Note: APIs may be subject to change.

Changes:

• Added missing parameters for CouchDB global changes (not applicable to Cloudant).
• Updated TS output format to es2022 and module format to node16.
• Updated dependencies.
• Updated documentation.

0.8.2

Note: APIs may be subject to change.

Changes:

• Updated dependencies.