Skip to content

Commit 4ca4ae5

Browse files
committed
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.
1 parent 0160b49 commit 4ca4ae5

File tree

4 files changed

+44
-64
lines changed

4 files changed

+44
-64
lines changed

NOTICE.txt

Lines changed: 24 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
MarkLogic® Node Client API
1+
Progress® MarkLogic® Node Client API
22

33
Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
44

@@ -10,43 +10,51 @@ Unless required by applicable law or agreed to in writing, software distributed
1010

1111
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 [email protected]. Please specify the product and version for which you are requesting source code.
1212

13-
The following software may be included in this project (last updated TBD January 28, 2025):
13+
The following software may be included in this project (last updated October 29, 2025):
1414

1515
-------------------------------------------------------------------------
16-
MarkLogic® Node Client API
16+
17+
Progress® MarkLogic® Node Client API
18+
1719
Third-Party Notices
1820

19-
This document provides notices information for the third-party components used by MarkLogic® Node Client API.
21+
This document provides notices information for the third-party components used by Progress® MarkLogic® Node Client API.
2022

2123
Third Party Components
2224

23-
@fastify/busboy 1.2.1 (MIT)
25+
@fastify/busboy 3.2.0 (MIT)
2426
big-integer 1.6.52 (Public Domain)
2527
concat-stream 2.0.0 (MIT)
2628
duplexify 4.1.3 (MIT)
27-
form-data 4.0.1 (MIT)
28-
json-text-sequence 1.0.1 (MIT)
29-
Kerberos 2.2.1 (Apache-2.0)
29+
form-data 4.0.4 (MIT)
30+
json-text-sequence 4.0.2 (MIT)
3031
multipart-stream 2.0.1 (MIT)
3132
qs 6.14.0 (BSD-3-Clause)
3233
through2 4.0.2 (MIT)
33-
vinyl 3.0.0 (MIT)
34-
www-authenticate 0.6.3 (MIT)
34+
3535

3636
Common Licenses
37+
3738
Apache License 2.0 (Apache-2.0)
3839

3940
************************************************************
41+
4042
Third-Party Components
41-
************************************************************
4243

43-
The following is a list of the third-party components used by MarkLogic® Node Client API.
44+
The following is a list of the third-party components used by Progress® MarkLogic® Node Client API.
45+
46+
************************************************************
4447

45-
@fastify/busboy 1.2.1 (MIT)
48+
@fastify/busboy 3.2.0 (MIT)
4649

4750
https://www.npmjs.com/package/@fastify/busboy
4851

52+
MIT License
53+
4954
Copyright Brian White. All rights reserved.
55+
Copyright (c) 2021-present The Fastify team
56+
57+
The Fastify team members are listed at https://github.com/fastify/fastify#team.
5058

5159
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:
5260

@@ -104,7 +112,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
104112

105113
************************************************************
106114

107-
form-data 4.0.1 (MIT)
115+
form-data 4.0.4 (MIT)
108116

109117
https://www.npmjs.com/package/form-data
110118

@@ -118,7 +126,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
118126

119127
************************************************************
120128

121-
json-text-sequence 1.0.1 (MIT)
129+
json-text-sequence 4.0.2 (MIT)
122130

123131
https://www.npmjs.com/package/json-text-sequence
124132

@@ -134,14 +142,6 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
134142

135143
************************************************************
136144

137-
Kerberos 2.2.1 (Apache-2.0)
138-
139-
https://www.npmjs.com/package/kerberos
140-
141-
For the full text of the Apache-2.0 license, see Apache License 2.0 (Apache-2.0)
142-
143-
************************************************************
144-
145145
multipart-stream 2.0.1 (MIT)
146146

147147
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
194194

195195
************************************************************
196196

197-
Vinyl 3.0.0 (MIT)
198-
199-
https://www.npmjs.com/package/vinyl
200-
201-
202-
The MIT License (MIT)
203-
204-
Copyright (c) 2013, 2016-2022 Blaine Bublitz <[email protected]> and Eric Schoffstall <[email protected]>
205-
206-
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:
207-
208-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
209-
210-
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.
211-
212-
************************************************************
213-
214-
www-authenticate 0.6.3 (MIT)
215-
216-
https://www.npmjs.com/package/www-authenticate
217-
218-
Copyright (c) 2013 Randy McLaughlin
219-
220-
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
221-
conditions:
222-
223-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
224-
225-
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.
226-
227-
************************************************************
228-
229-
This section shows the text of common third-party licenses used by MarkLogic® Node Client API:
197+
This section shows the text of common third-party licenses used by Progress® MarkLogic® Node Client API:
230198

231199
Apache License 2.0 (Apache-2.0)
232200
https://spdx.org/licenses/Apache-2.0.html
@@ -307,4 +275,3 @@ limitations under the License.
307275

308276

309277
====================
310-

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
1-
# MarkLogic Node.js Client API
1+
# Progress® MarkLogic® Node Client API
22

3-
The MarkLogic Node.js Client API provides access to the MarkLogic database
4-
from Node.js applications.
3+
The Progress® MarkLogic® Node Client API provides access to the MarkLogic database from Node.js applications.
54

65
## Features
76

@@ -18,6 +17,19 @@ from Node.js applications.
1817
* Generate query based views, redaction on rows
1918
* Data Movement SDK - move large amounts of data into, out of, or within a MarkLogic cluster
2019

20+
## System Requirements
21+
22+
The Node Client 4.0.0 release requires Node.js 22 or higher. Testing has verified that the client will
23+
run successfully on Node 20, but we recommend 22 or higher based on
24+
[the Node.js release roadmap](https://nodejs.org/en/about/previous-releases), as Node 20 enters
25+
end-of-life in April 2026 while Node 22 is supported through April 2027.
26+
27+
For Node Client 3.x releases, Node.js 16 or higher is required.
28+
29+
The Node Client depends on the [MarkLogic REST API](https://docs.progress.com/bundle/marklogic-server-develop-rest-api-12/page/topics/intro.html)
30+
for connecting to MarkLogic. The Node Client supports major versions 10, 11, and 12 of MarkLogic, though some features require
31+
a certain version of MarkLogic due to the underlying REST API support being added in that version of MarkLogic.
32+
2133
## Getting Started
2234

2335
You can install the marklogic package as a dependency for your Node.js project
@@ -51,10 +63,10 @@ const db = marklogic.createDatabaseClient({
5163
enableGzippedResponses: true
5264
});
5365

54-
// For MarkLogic Cloud
66+
// For Progress Data Cloud
5567
const db = marklogic.createDatabaseClient({
5668
apiKey: 'changeme',
57-
host: 'example.beta.marklogic.com',
69+
host: 'example.dev.progress.cloud',
5870
authType: 'cloud',
5971
// basePath is optional.
6072
basePath: '/marklogic/test',
@@ -100,7 +112,7 @@ in the online resources. To run the examples, follow the instructions here:
100112

101113
## Support
102114

103-
The MarkLogic Node.js Client API is maintained by MarkLogic Engineering.
115+
The Progress® MarkLogic® Node Client API is maintained by MarkLogic Engineering.
104116
It is designed for use in production applications with MarkLogic Server.
105117
Everyone is encouraged to file bug reports, feature requests, and pull
106118
requests through GitHub. This input is critical and will be carefully

examples/all.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ fs.readdir('./examples', function(err, filenames) {
2929
'all.js': true,
3030
'before-load.js': true,
3131
'example-util.js': true,
32+
'progress-cloud-connection.js': true,
3233
'setup.js': true
3334
};
3435

jsdoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
},
66
"templates": {
77
"theme": "marklogic",
8-
"systemName": "MarkLogic Node.js Client API",
8+
"systemName": "Progress® MarkLogic® Node Client API",
99
"copyright": "Copyright (c) 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.",
1010
"navType": "vertical",
1111
"inverseNav": true,

0 commit comments

Comments
 (0)