From 4ca4ae5a22bb119695ecbd5d41e245ed1617bd2d Mon Sep 17 00:00:00 2001 From: Rob Rudin Date: Thu, 30 Oct 2025 10:12:21 -0400 Subject: [PATCH] MLE-24976 Updated NOTICE and README for 4.0.0 And excluded an example file from "all.js" because it is just a reference example. --- NOTICE.txt | 81 +++++++++++++++---------------------------------- README.md | 24 +++++++++++---- examples/all.js | 1 + jsdoc.json | 2 +- 4 files changed, 44 insertions(+), 64 deletions(-) diff --git a/NOTICE.txt b/NOTICE.txt index 9468467e..370f6d29 100644 --- a/NOTICE.txt +++ b/NOTICE.txt @@ -1,4 +1,4 @@ -MarkLogic® Node Client API +Progress® MarkLogic® Node Client API Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved. @@ -10,43 +10,51 @@ Unless required by applicable law or agreed to in writing, software distributed To the extent required by the applicable open-source license, a complete machine-readable copy of the source code corresponding to such code is available upon request. This offer is valid to anyone in receipt of this information and shall expire three years following the date of the final distribution of this product version by Progress Software Corporation. To obtain such source code, send an email to Legal-thirdpartyreview@progress.com. Please specify the product and version for which you are requesting source code. -The following software may be included in this project (last updated TBD January 28, 2025): +The following software may be included in this project (last updated October 29, 2025): ------------------------------------------------------------------------- -MarkLogic® Node Client API + +Progress® MarkLogic® Node Client API + Third-Party Notices -This document provides notices information for the third-party components used by MarkLogic® Node Client API. +This document provides notices information for the third-party components used by Progress® MarkLogic® Node Client API. Third Party Components - @fastify/busboy 1.2.1 (MIT) + @fastify/busboy 3.2.0 (MIT) big-integer 1.6.52 (Public Domain) concat-stream 2.0.0 (MIT) duplexify 4.1.3 (MIT) - form-data 4.0.1 (MIT) - json-text-sequence 1.0.1 (MIT) - Kerberos 2.2.1 (Apache-2.0) + form-data 4.0.4 (MIT) + json-text-sequence 4.0.2 (MIT) multipart-stream 2.0.1 (MIT) qs 6.14.0 (BSD-3-Clause) through2 4.0.2 (MIT) - vinyl 3.0.0 (MIT) - www-authenticate 0.6.3 (MIT) + Common Licenses + Apache License 2.0 (Apache-2.0) ************************************************************ + Third-Party Components -************************************************************ - The following is a list of the third-party components used by MarkLogic® Node Client API. + The following is a list of the third-party components used by Progress® MarkLogic® Node Client API. + +************************************************************ -@fastify/busboy 1.2.1 (MIT) +@fastify/busboy 3.2.0 (MIT) https://www.npmjs.com/package/@fastify/busboy +MIT License + Copyright Brian White. All rights reserved. +Copyright (c) 2021-present The Fastify team + +The Fastify team members are listed at https://github.com/fastify/fastify#team. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: @@ -104,7 +112,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ************************************************************ -form-data 4.0.1 (MIT) +form-data 4.0.4 (MIT) https://www.npmjs.com/package/form-data @@ -118,7 +126,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ************************************************************ -json-text-sequence 1.0.1 (MIT) +json-text-sequence 4.0.2 (MIT) https://www.npmjs.com/package/json-text-sequence @@ -134,14 +142,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ************************************************************ -Kerberos 2.2.1 (Apache-2.0) - -https://www.npmjs.com/package/kerberos - -For the full text of the Apache-2.0 license, see Apache License 2.0 (Apache-2.0) - -************************************************************ - multipart-stream 2.0.1 (MIT) https://www.npmjs.com/package/multipart-stream @@ -194,39 +194,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI ************************************************************ -Vinyl 3.0.0 (MIT) - -https://www.npmjs.com/package/vinyl - - -The MIT License (MIT) - -Copyright (c) 2013, 2016-2022 Blaine Bublitz and Eric Schoffstall - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -************************************************************ - -www-authenticate 0.6.3 (MIT) - -https://www.npmjs.com/package/www-authenticate - -Copyright (c) 2013 Randy McLaughlin - -Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following -conditions: - -The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. - -************************************************************ - -This section shows the text of common third-party licenses used by MarkLogic® Node Client API: +This section shows the text of common third-party licenses used by Progress® MarkLogic® Node Client API: Apache License 2.0 (Apache-2.0) https://spdx.org/licenses/Apache-2.0.html @@ -307,4 +275,3 @@ limitations under the License. ==================== - diff --git a/README.md b/README.md index 02b5c1fc..b604670f 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -# MarkLogic Node.js Client API +# Progress® MarkLogic® Node Client API -The MarkLogic Node.js Client API provides access to the MarkLogic database -from Node.js applications. +The Progress® MarkLogic® Node Client API provides access to the MarkLogic database from Node.js applications. ## Features @@ -18,6 +17,19 @@ from Node.js applications. * Generate query based views, redaction on rows * Data Movement SDK - move large amounts of data into, out of, or within a MarkLogic cluster +## System Requirements + +The Node Client 4.0.0 release requires Node.js 22 or higher. Testing has verified that the client will +run successfully on Node 20, but we recommend 22 or higher based on +[the Node.js release roadmap](https://nodejs.org/en/about/previous-releases), as Node 20 enters +end-of-life in April 2026 while Node 22 is supported through April 2027. + +For Node Client 3.x releases, Node.js 16 or higher is required. + +The Node Client depends on the [MarkLogic REST API](https://docs.progress.com/bundle/marklogic-server-develop-rest-api-12/page/topics/intro.html) +for connecting to MarkLogic. The Node Client supports major versions 10, 11, and 12 of MarkLogic, though some features require +a certain version of MarkLogic due to the underlying REST API support being added in that version of MarkLogic. + ## Getting Started You can install the marklogic package as a dependency for your Node.js project @@ -51,10 +63,10 @@ const db = marklogic.createDatabaseClient({ enableGzippedResponses: true }); -// For MarkLogic Cloud +// For Progress Data Cloud const db = marklogic.createDatabaseClient({ apiKey: 'changeme', - host: 'example.beta.marklogic.com', + host: 'example.dev.progress.cloud', authType: 'cloud', // basePath is optional. basePath: '/marklogic/test', @@ -100,7 +112,7 @@ in the online resources. To run the examples, follow the instructions here: ## Support -The MarkLogic Node.js Client API is maintained by MarkLogic Engineering. +The Progress® MarkLogic® Node Client API is maintained by MarkLogic Engineering. It is designed for use in production applications with MarkLogic Server. Everyone is encouraged to file bug reports, feature requests, and pull requests through GitHub. This input is critical and will be carefully diff --git a/examples/all.js b/examples/all.js index 60610059..0c9f8685 100644 --- a/examples/all.js +++ b/examples/all.js @@ -29,6 +29,7 @@ fs.readdir('./examples', function(err, filenames) { 'all.js': true, 'before-load.js': true, 'example-util.js': true, + 'progress-cloud-connection.js': true, 'setup.js': true }; diff --git a/jsdoc.json b/jsdoc.json index 038307d0..471fbcca 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -5,7 +5,7 @@ }, "templates": { "theme": "marklogic", - "systemName": "MarkLogic Node.js Client API", + "systemName": "Progress® MarkLogic® Node Client API", "copyright": "Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.", "navType": "vertical", "inverseNav": true,