@magda/registry-client 2.0.0-alpha.0 → 2.0.0-alpha.1

package/dist/index.d.ts

@@ -472,6 +472,17 @@ declare class RecordsApi {
         response: http.IncomingMessage;
         body: Record_2;
     }>;
+    /**
+     * Get a record in full by ID
+     * Get a record with all attached aspects data by the record ID.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: Record_2;
+    }>;
     /**
      * Get a summary record by ID
      * Gets a summary record, including all the aspect ids for which this record has data.
@@ -601,6 +612,7 @@ export declare class RegistryClient {
     getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
     getAspectDefinition(aspectId: string, jwtToken?: string): Promise<AspectDefinition>;
     getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | Error>;
+    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): Promise<RecordsPage<I> | Error>;
     getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | Error>;
 }

package/dist/index.js

@@ -11354,6 +11354,20 @@ class RegistryClient {
             .then((result) => result.body)
             .catch(createServiceError_1.default);
     }
+    getRecordInFull(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                const res = yield this.recordsApi.getByIdInFull(encodeURIComponent(id), this.tenantId, this.jwt);
+                if (typeof res.body === "string") {
+                    throw new Error("Invalid non-json response: " + res.body);
+                }
+                return res.body;
+            }
+            catch (e) {
+                throw this.toServerError(e);
+            }
+        });
+    }
     getRecords(aspect, optionalAspect, pageToken, dereference, limit, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst) {
         const operation = (pageToken) => () => this.recordsApi.getAll(this.tenantId, aspect, optionalAspect, pageToken, undefined, limit, dereference, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst, this.jwt);
         return retry_1.default(operation(pageToken), this.secondsBetweenRetries, this.maxRetries, (e, retriesLeft) => console.log(formatServiceError_1.default("Failed to GET records.", e, retriesLeft)))
@@ -12820,6 +12834,63 @@ class RecordsApi {
             });
         });
     }
+    /**
+     * Get a record in full by ID
+     * Get a record with all attached aspects data by the record ID.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getByIdInFull(id, xMagdaTenantId, xMagdaSession) {
+        const localVarPath = this.basePath + '/records/inFull/{id}'
+            .replace('{' + 'id' + '}', String(id));
+        let queryParameters = {};
+        let headerParams = Object.assign({}, this.defaultHeaders);
+        let formParams = {};
+        // verify required parameter 'id' is not null or undefined
+        if (id === null || id === undefined) {
+            throw new Error('Required parameter id was null or undefined when calling getByIdInFull.');
+        }
+        // verify required parameter 'xMagdaTenantId' is not null or undefined
+        if (xMagdaTenantId === null || xMagdaTenantId === undefined) {
+            throw new Error('Required parameter xMagdaTenantId was null or undefined when calling getByIdInFull.');
+        }
+        headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
+        headerParams['X-Magda-Session'] = xMagdaSession;
+        let useFormData = false;
+        let requestOptions = {
+            method: 'GET',
+            qs: queryParameters,
+            headers: headerParams,
+            uri: localVarPath,
+            useQuerystring: this._useQuerystring,
+            json: true,
+        };
+        this.authentications.default.applyToRequest(requestOptions);
+        if (Object.keys(formParams).length) {
+            if (useFormData) {
+                requestOptions.formData = formParams;
+            }
+            else {
+                requestOptions.form = formParams;
+            }
+        }
+        return new Promise((resolve, reject) => {
+            request(requestOptions, (error, response, body) => {
+                if (error) {
+                    reject(error);
+                }
+                else {
+                    if (response.statusCode >= 200 && response.statusCode <= 299) {
+                        resolve({ response: response, body: body });
+                    }
+                    else {
+                        reject({ response: response, body: body });
+                    }
+                }
+            });
+        });
+    }
     /**
      * Get a summary record by ID
      * Gets a summary record, including all the aspect ids for which this record has data.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/registry-client",
   "description": "MAGDA Registry Client",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "scripts": {
     "prebuild": "rimraf dist tsconfig.tsbuildinfo",
     "build": "webpack && api-extractor run -l",
@@ -12,7 +12,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
-    "@magda/typescript-common": "^2.0.0-alpha.0",
+    "@magda/typescript-common": "^2.0.0-alpha.1",
     "@microsoft/api-extractor": "^7.7.8",
     "ts-loader": "^6.2.1",
     "typescript": "^3.7.2",