Develop 2

.github/workflows/pr-workflow.yaml

@@ -0,0 +1,16 @@
+name: 🏷️ JIRA ID Validator
+
+on:
+  # Using pull_request_target instead of pull_request to handle PRs from forks
+  pull_request_target:
+    types: [opened, edited, reopened, synchronize]
+    # No branch filtering - will run on all PRs
+
+jobs:
+  jira-pr-check:
+    name: 🏷️ Validate JIRA ticket ID
+    # Use the reusable workflow from the central repository
+    uses: marklogic/pr-workflows/.github/workflows/jira-id-check.yml@main
+    with:
+      # Pass the PR title from the event context
+      pr-title: ${{ github.event.pull_request.title }}

.npmignore

@@ -5,6 +5,7 @@ test-app/
 test-basic/
 test-basic-proxy/
 test-complete/
+test-complete-app/
 test-complete-proxy/
 wiki_images/
 CONTRIBUTING.md

CHANGELOG.md

@@ -1,4 +1,35 @@
 # CHANGELOG
+
+## 3.7.0
+#### New Functionality
+
+- Can now encode and decode vectors through the `base64Encode` and `base64Decode` functions in the new lib/vector-util.js library. 
+   Encoding vectors before writing them to documents in MarkLogic 12 helps reduce the amount of disk space and memory consumed by vectors.
+- MarkLogic 12 users can now use `minVersion` and `maxVersion` to change default TLS version from 1.3 to a different version.
+
+#### Bug Fix
+- https://github.com/marklogic/node-client-api/issues/917
+
+- Fix for security vulnerabilities -
+  https://github.com/advisories/GHSA-fjxv-7rqg-78g4
+  https://github.com/advisories/GHSA-8cj5-5rvv-wf4v
+  https://github.com/advisories/GHSA-c2qf-rxjj-qqgw
+  https://github.com/advisories/GHSA-3XGQ-45JJ-V275
+
+
+## 3.6.0
+#### New Functionality
+
+- MarkLogic 12 users can now use the `shortestPath` and `annTopK` methods in the Optic plan builder.
+- MarkLogic 12 users can now use the `bm25`, `zero`, and `random` score methods in the Optic plan builder.
+
+#### Bug Fix
+- Fix for security vulnerabilities -
+  https://github.com/advisories/GHSA-3xgq-45jj-v275
+  https://github.com/advisories/GHSA-952p-6rrq-rcjv
+  https://github.com/advisories/GHSA-mwcw-c2x4-8c55
+  https://github.com/advisories/GHSA-76p7-773f-r4q5
+
 ## 3.5.0
 #### New Functionality
 

CODEOWNERS

@@ -0,0 +1,6 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+# These owners will be the default owners for everything in the repo.
+* @anu3990 @billfarber @rjrudin @stevebio
+

Jenkinsfile

@@ -18,7 +18,6 @@ def runTests(String type,String version){
         ./node_modules/.bin/mocha --timeout 10000 -R xunit test-basic/ --reporter mocha-junit-reporter --reporter-options mochaFile=$WORKSPACE/test-basic-reports.xml -g \'logging|archivePath\' --invert  || true
         ./node_modules/.bin/gulp setupProxyTests || true
         ./node_modules/.bin/mocha --timeout 10000 -R xunit test-basic-proxy/lib/**/*.js --reporter mocha-junit-reporter --reporter-options mochaFile=$WORKSPACE/test-basic-proxy-reports.xml -g \'logging|archivePath\' --invert  || true
-        node etc/test-teardown.js -u admin:admin
     '''
 
 }
@@ -53,7 +52,7 @@ def runE2ETests(String type,String version){
         cd ..
         ./node_modules/.bin/mocha --no-parallel -R xunit --timeout 60000  test-complete/ --reporter mocha-junit-reporter --reporter-options mochaFile=$WORKSPACE/test-complete-results.xml  || true
         cd test-complete-proxy
-        npm install --global gulp-cli
+        npm install gulp-cli
         gulp loadToModulesDB
         gulp generateFnClasses
         gulp copyFnClasses
@@ -92,12 +91,12 @@ pipeline{
           JAVA_HOME_DIR="/home/builder/java/openjdk-1.8.0-262"
     }
     stages{
-        stage('runtests-11.3.0'){
+        stage('runtests-11.3.1'){
             agent {label 'nodeclientpool'}
             steps{
                 runAuditReport()
-                runTests('Release','11.3.0')
-                runE2ETests('Release','11.3.0')
+                runTests('Release','11.3.1')
+                runE2ETests('Release','11.3.1')
             }
         }
         stage('regressions'){

README.md

@@ -88,8 +88,8 @@ db.createCollection(
 ### Resources
 
 * [Node.js Client API Documentation](https://docs.marklogic.com/jsdoc/index.html)
-* [Node.js Application Developer's Guide](http://docs.marklogic.com/guide/node-dev)
-* [MarkLogic Training for the Node.js Client API](http://www.marklogic.com/training-courses/developing-marklogic-applications-i-node-js/)
+* [Node.js Application Developer's Guide](https://docs.progress.com/bundle/marklogic-server-develop-with-node-js-11/page/topics/intro.html)
+* [MarkLogic Overview](https://www.progress.com/marklogic)
 
 ### Code Examples
 

config-optic/connectdef.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 'use strict';
 
 var name = 'nodeOpticFunctionalTest';

config-optic/setupqa.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 'use strict';
 
 var util = require('../node_modules/core-util-is/lib/util.js');

config-optic/teardown.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 'use strict';
 
 var util = require('../node_modules/core-util-is/lib/util.js');

config-optic/testlib.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 'use strict';
 var valcheck = require('../node_modules/core-util-is/lib/util.js');
 

etc/test-config-qa-ssl.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var testHost = 'localhost';
 
 var restPort     = '8016';

etc/test-config-qa.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var testHost = 'localhost';
 
 var restPort     = '8024';

etc/test-config.js

@@ -1,21 +1,10 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 let testHost = 'localhost';
 
 let restPort     = '8015';
+let restSslPort     = '8017';
 let restAuthType = 'DIGEST';
 
 let managePort     = '8002';
@@ -148,5 +137,14 @@ module.exports = {
         host:     testHost,
         port:     restPort,
         authType: 'oauth'
+    },
+    restConnectionForTls: {
+        host:     testHost,
+        port:     restSslPort,
+        user:     restWriterUser,
+        password: restWriterPassword,
+        authType: restAuthType,
+        ssl: true,
+        rejectUnauthorized: false
     }
 };

etc/test-lib.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 'use strict';
 var valcheck = require('core-util-is');
 

etc/test-setup-dmsdk-qa.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var valcheck = require('core-util-is');
 
 var marklogic = require('../lib/marklogic.js');

etc/test-setup-prompt.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var read   = require("read");
 var mlutil = require('../lib/mlutil.js');
 

etc/test-setup-qa.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2020 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var valcheck = require('core-util-is');
 
 var marklogic = require('../lib/marklogic.js');

etc/test-setup-users.js

@@ -1,18 +1,6 @@
 /*
- * Copyright (c) 2022 MarkLogic Corporation
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *    http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
+* Copyright © 2015-2025 Progress Software Corporation and/or its subsidiaries or affiliates. All Rights Reserved.
+*/
 var valcheck = require('core-util-is');
 
 var testlib    = require('./test-lib.js');