@magda/connector-sdk 6.0.0-alpha.9 → 6.0.0

package/dist/index.d.ts

@@ -831,6 +831,17 @@ declare class RecordsApi {
         response: Response;
         body: Array<any>;
     }>;
+    /**
+     * Filter a list of record ids by access
+     * Request body is a JSON array of record ids. Returns only readable record ids.
+     * @param requestData A JSON array of record ids, e.g. [\&quot;id1\&quot;, \&quot;id2\&quot;]
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    filterByAccess(requestData: Array<string>, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<string>;
+    }>;
     /**
      * Get a list of all records
      *
@@ -1048,6 +1059,7 @@ declare class RegistryClient {
     getRecordInFull(id: string): Promise<Record_2>;
     getRecords<I extends Record_2>(aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, dereference?: boolean, limit?: number, aspectQueries?: string[], aspectOrQuery?: string[], orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, reversePageTokenOrder?: boolean, q?: string): Promise<RecordsPage<I> | ServerError>;
     getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | ServerError>;
+    filterRecordsByAccess(records: string[], jwtToken?: string, tenantId?: number): Promise<string[] | ServerError>;
 }
 
 declare class RegistryEvent {

package/dist/index.js

@@ -11222,9 +11222,9 @@ var require_yallist = __commonJS({
   }
 });
 
-// ../../node_modules/lru-cache/index.js
+// ../../magda-typescript-common/node_modules/lru-cache/index.js
 var require_lru_cache = __commonJS({
-  "../../node_modules/lru-cache/index.js"(exports, module) {
+  "../../magda-typescript-common/node_modules/lru-cache/index.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     var Yallist = require_yallist();
@@ -40079,9 +40079,9 @@ var require_application = __commonJS({
   }
 });
 
-// ../../node_modules/negotiator/lib/charset.js
+// ../../node_modules/express/node_modules/negotiator/lib/charset.js
 var require_charset = __commonJS({
-  "../../node_modules/negotiator/lib/charset.js"(exports, module) {
+  "../../node_modules/express/node_modules/negotiator/lib/charset.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     module.exports = preferredCharsets;
@@ -40168,9 +40168,9 @@ var require_charset = __commonJS({
   }
 });
 
-// ../../node_modules/negotiator/lib/encoding.js
+// ../../node_modules/express/node_modules/negotiator/lib/encoding.js
 var require_encoding2 = __commonJS({
-  "../../node_modules/negotiator/lib/encoding.js"(exports, module) {
+  "../../node_modules/express/node_modules/negotiator/lib/encoding.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     module.exports = preferredEncodings;
@@ -40268,9 +40268,9 @@ var require_encoding2 = __commonJS({
   }
 });
 
-// ../../node_modules/negotiator/lib/language.js
+// ../../node_modules/express/node_modules/negotiator/lib/language.js
 var require_language = __commonJS({
-  "../../node_modules/negotiator/lib/language.js"(exports, module) {
+  "../../node_modules/express/node_modules/negotiator/lib/language.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     module.exports = preferredLanguages;
@@ -40368,9 +40368,9 @@ var require_language = __commonJS({
   }
 });
 
-// ../../node_modules/negotiator/lib/mediaType.js
+// ../../node_modules/express/node_modules/negotiator/lib/mediaType.js
 var require_mediaType = __commonJS({
-  "../../node_modules/negotiator/lib/mediaType.js"(exports, module) {
+  "../../node_modules/express/node_modules/negotiator/lib/mediaType.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     module.exports = preferredMediaTypes;
@@ -40532,9 +40532,9 @@ var require_mediaType = __commonJS({
   }
 });
 
-// ../../node_modules/negotiator/index.js
+// ../../node_modules/express/node_modules/negotiator/index.js
 var require_negotiator = __commonJS({
-  "../../node_modules/negotiator/index.js"(exports, module) {
+  "../../node_modules/express/node_modules/negotiator/index.js"(exports, module) {
     "use strict";
     init_cjs_shim();
     var preferredCharsets = require_charset();
@@ -57014,6 +57014,49 @@ var RecordsApi = class {
     }
     return fetchWithRequestOptions(requestOptions);
   }
+  /**
+   * Filter a list of record ids by access
+   * Request body is a JSON array of record ids. Returns only readable record ids.
+   * @param requestData A JSON array of record ids, e.g. [\"id1\", \"id2\"]
+   * @param xMagdaTenantId 0
+   * @param xMagdaSession Magda internal session id
+   */
+  filterByAccess(requestData, xMagdaTenantId, xMagdaSession) {
+    const localVarPath = this.basePath + "/records/filterByAccess";
+    let queryParameters = {};
+    let headerParams = Object.assign({}, this.defaultHeaders);
+    let formParams = {};
+    if (requestData === null || requestData === void 0) {
+      throw new Error("Required parameter requestData was null or undefined when calling filterByAccess.");
+    }
+    if (xMagdaTenantId === null || xMagdaTenantId === void 0) {
+      throw new Error("Required parameter xMagdaTenantId was null or undefined when calling filterByAccess.");
+    }
+    if (isNotEmpty(xMagdaTenantId)) {
+      headerParams["X-Magda-Tenant-Id"] = xMagdaTenantId;
+    }
+    if (isNotEmpty(xMagdaSession)) {
+      headerParams["X-Magda-Session"] = xMagdaSession;
+    }
+    let useFormData = false;
+    const requestOptions = {
+      method: "POST",
+      qs: queryParameters,
+      headers: headerParams,
+      uri: localVarPath,
+      json: true,
+      body: requestData
+    };
+    this.authentications.default.applyToRequest(requestOptions);
+    if (Object.keys(formParams).length) {
+      if (useFormData) {
+        requestOptions.formData = formParams;
+      } else {
+        requestOptions.form = formParams;
+      }
+    }
+    return fetchWithRequestOptions(requestOptions);
+  }
   /**
    * Get a list of all records
    *
@@ -58079,6 +58122,12 @@ var RegistryClient = class {
     const operation = () => this.recordsApi.getPageTokens(this.tenantId, aspect, limit, this.jwt);
     return retry(operation, this.secondsBetweenRetries, this.maxRetries, (e, retriesLeft) => console.log(formatServiceError("Failed to GET records page tokens.", e, retriesLeft))).then((result) => result.body).catch(toServerError("getRecordsPageTokens"));
   }
+  async filterRecordsByAccess(records, jwtToken, tenantId) {
+    const resolvedTenantId = tenantId ?? this.tenantId;
+    const resolvedJwt = jwtToken ?? this.jwt;
+    const operation = () => () => this.recordsApi.filterByAccess(records, resolvedTenantId, resolvedJwt);
+    return retry(operation(), this.secondsBetweenRetries, this.maxRetries, (e, retriesLeft) => console.log(formatServiceError("Failed to filter records by access.", e, retriesLeft))).then((result) => result.body).catch(toServerError("filterRecordsByAccess"));
+  }
 };
 
 // ../../magda-typescript-common/dist/session/buildJwt.js

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@magda/connector-sdk",
   "description": "MAGDA Connector SDK",
-  "version": "6.0.0-alpha.9",
+  "version": "6.0.0",
   "type": "module",
   "exports": {
     ".": "./dist/index.js",
     "./package.json": "./package.json"
   },
   "engines": {
-    "node": ">=18.19.0"
+    "node": ">=22.0.0"
   },
   "scripts": {
     "prebuild": "rimraf dist tsconfig.tsbuildinfo",
@@ -16,12 +16,12 @@
     "build-main": "node esbuild.js",
     "build-types": "tsc --emitDeclarationOnly",
     "build-types-bundle": "api-extractor run --local",
-    "release": "npm publish || echo \"Skip releasing npm package @magda/connector-sdk.\""
+    "release": "node \"$(git rev-parse --show-toplevel)/ci-scripts/npm-publish-release.js\""
   },
   "author": "",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@magda/typescript-common": "^6.0.0-alpha.9",
+    "@magda/typescript-common": "^6.0.0",
     "@microsoft/api-extractor": "~7.39.0",
     "@types/yargs": "^12.0.8",
     "esbuild": "^0.19.10",