@magda/typescript-common 1.3.0-rc.0 → 2.0.0-alpha.2

package/dist/authorization-api/model.d.ts

@@ -11,35 +11,39 @@ declare global {
         }
     }
 }
-export interface PublicUser {
-    id?: string;
+export interface UserRecord {
+    id: string;
     displayName: string;
-    photoURL?: string;
+    photoURL: string;
     isAdmin: boolean;
+    orgUnitId: string;
+    email: string;
+    source: string;
+    sourceId: string;
+}
+export declare type PublicUser = Partial<Pick<UserRecord, "id" | "photoURL" | "orgUnitId">> & Omit<UserRecord, "id" | "photoURL" | "orgUnitId" | "email" | "source" | "sourceId"> & {
     roles?: Role[];
     permissions?: Permission[];
     managingOrgUnitIds?: string[];
-    orgUnitId?: string;
     orgUnit?: OrgUnit;
-}
+};
+export declare type User = PublicUser & Pick<UserRecord, "email" | "source" | "sourceId">;
+export declare type CreateUserData = Partial<Omit<UserRecord, "email" | "displayName" | "id">> & Pick<UserRecord, "displayName" | "email">;
 export declare type OrgUnitRelationshipType = "ancestor" | "descendant" | "equal" | "unrelated";
-export interface OrgUnit {
-    id?: string;
-    name?: string;
-    description?: string;
-    relationship?: OrgUnitRelationshipType;
-    left?: number;
-    right?: number;
-    createBy?: string;
-    createTime?: Date;
-    editBy?: string;
-    editTime?: Date;
-}
-export interface User extends PublicUser {
-    email: string;
-    source: string;
-    sourceId: string;
+export interface OrgUnitRecord {
+    id: string;
+    name: string;
+    description: string;
+    left: number;
+    right: number;
+    createBy: string;
+    createTime: Date;
+    editBy: string;
+    editTime: Date;
 }
+export declare type OrgUnit = Partial<OrgUnitRecord> & {
+    relationship?: OrgUnitRelationshipType;
+};
 export interface APIKeyRecord {
     id: string;
     user_id: string;
@@ -77,6 +81,36 @@ export interface Permission {
     editBy?: string;
     editTime?: Date;
 }
+export interface PermissionRecord {
+    id: string;
+    name: string;
+    description: string;
+    resource_id: string;
+    user_ownership_constraint: boolean;
+    org_unit_ownership_constraint: boolean;
+    pre_authorised_constraint: boolean;
+    owner_id: string;
+    create_time: string;
+    create_by: string;
+    edit_time: string;
+    edit_by: string;
+}
+export interface CreateRolePermissionInputData extends Omit<PermissionRecord, "id" | "owner_id" | "create_by" | "create_time" | "edit_by" | "edit_time"> {
+    operationIds: string[];
+}
+export declare type OperationRecord = {
+    id: string;
+    uri: string;
+    name: string;
+    description: string;
+    resource_id: string;
+};
+export declare type ResourceRecord = {
+    id: string;
+    uri: string;
+    name: string;
+    description: string;
+};
 export interface UserToken {
     id: string;
 }
@@ -85,15 +119,10 @@ export interface UserToken {
  * You only need this when you try to figure out user characteristic (unknown) via Known information of a dataset.
  * i.e. set `input.user` to unknown then calculate residual rules via partial evaluation.
  */
-export interface DatasetAccessControlMetaData {
-    /**
-     * We do allow "archived" as defined in `publishing.schema.json`
-     * But we probably should avoid using it as there is no story behinds it.
-     */
-    publishingState: "draft" | "published" | "archived";
+export interface AccessControlMetaData {
     accessControl?: {
         ownerId?: string;
-        orgUnitOwnerId?: string;
+        orgUnitId?: string;
         preAuthorisedPermissionIds?: string[];
     };
 }

package/dist/createNoCacheFetchOptions.d.ts

@@ -0,0 +1,15 @@
+export default function createNoCacheFetchOptions(fetchOptions?: RequestInit): {
+    body?: BodyInit;
+    cache?: RequestCache;
+    credentials?: RequestCredentials;
+    headers?: HeadersInit;
+    integrity?: string;
+    keepalive?: boolean;
+    method?: string;
+    mode?: RequestMode;
+    redirect?: RequestRedirect;
+    referrer?: string;
+    referrerPolicy?: ReferrerPolicy;
+    signal?: AbortSignal;
+    window?: any;
+};

package/dist/createNoCacheFetchOptions.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function createNoCacheFetchOptions(fetchOptions = {}) {
+    const noCacheHeaders = {
+        "Cache-Control": "no-cache, no-store, must-revalidate",
+        Pragma: "no-cache",
+        Expires: "0"
+    };
+    const options = Object.assign({}, fetchOptions);
+    if (!options.headers) {
+        options.headers = Object.assign({}, noCacheHeaders);
+    }
+    else {
+        options.headers = Object.assign(Object.assign({}, options.headers), noCacheHeaders);
+    }
+    options.cache = "reload";
+    return options;
+}
+exports.default = createNoCacheFetchOptions;
+//# sourceMappingURL=createNoCacheFetchOptions.js.map

package/dist/createNoCacheFetchOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createNoCacheFetchOptions.js","sourceRoot":"","sources":["../src/createNoCacheFetchOptions.ts"],"names":[],"mappings":";;AAAA,SAAwB,yBAAyB,CAC7C,eAA4B,EAAE;IAE9B,MAAM,cAAc,GAAG;QACnB,eAAe,EAAE,qCAAqC;QACtD,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,GAAG;KACf,CAAC;IACF,MAAM,OAAO,qBAAQ,YAAY,CAAE,CAAC;IACpC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE;QAClB,OAAO,CAAC,OAAO,qBAAQ,cAAc,CAAE,CAAC;KAC3C;SAAM;QACH,OAAO,CAAC,OAAO,mCAAQ,OAAO,CAAC,OAAO,GAAK,cAAc,CAAE,CAAC;KAC/D;IACD,OAAO,CAAC,KAAK,GAAG,QAAQ,CAAC;IACzB,OAAO,OAAO,CAAC;AACnB,CAAC;AAhBD,4CAgBC"}

package/dist/express/getNoCacheHeaders.d.ts

@@ -0,0 +1,6 @@
+declare const getNoCacheHeaders: () => {
+    "Cache-Control": string;
+    Expires: string;
+    "Last-Modified": string;
+};
+export default getNoCacheHeaders;

package/dist/express/getNoCacheHeaders.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const getNoCacheHeaders = () => ({
+    "Cache-Control": "max-age=0, no-cache, must-revalidate, proxy-revalidate",
+    Expires: "Thu, 01 Jan 1970 00:00:00 GMT",
+    "Last-Modified": new Date().toUTCString()
+});
+exports.default = getNoCacheHeaders;
+//# sourceMappingURL=getNoCacheHeaders.js.map

package/dist/express/getNoCacheHeaders.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getNoCacheHeaders.js","sourceRoot":"","sources":["../../src/express/getNoCacheHeaders.ts"],"names":[],"mappings":";;AAAA,MAAM,iBAAiB,GAAG,GAAG,EAAE,CAAC,CAAC;IAC7B,eAAe,EAAE,wDAAwD;IACzE,OAAO,EAAE,+BAA+B;IACxC,eAAe,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;CAC5C,CAAC,CAAC;AAEH,kBAAe,iBAAiB,CAAC"}

package/dist/express/setResponseNoCache.d.ts

@@ -0,0 +1,3 @@
+import { Response } from "express";
+declare const setResponseNoCache: (res: Response) => Response<any>;
+export default setResponseNoCache;

package/dist/express/setResponseNoCache.js

@@ -0,0 +1,9 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const getNoCacheHeaders_1 = __importDefault(require("./getNoCacheHeaders"));
+const setResponseNoCache = (res) => res.set(getNoCacheHeaders_1.default());
+exports.default = setResponseNoCache;
+//# sourceMappingURL=setResponseNoCache.js.map

package/dist/express/setResponseNoCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"setResponseNoCache.js","sourceRoot":"","sources":["../../src/express/setResponseNoCache.ts"],"names":[],"mappings":";;;;;AACA,4EAAoD;AAEpD,MAAM,kBAAkB,GAAG,CAAC,GAAa,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,2BAAiB,EAAE,CAAC,CAAC;AAE3E,kBAAe,kBAAkB,CAAC"}

package/dist/fetchRequest.d.ts

@@ -0,0 +1,11 @@
+declare type RequestContentTypeJson = "application/json";
+declare type RequestContentTypePlainText = "text/plain";
+declare type RequestContentTypeForm = "application/x-www-form-urlencoded";
+declare type RequestContentTypeBinary = "application/octet-stream";
+declare type RequestContentTypeMultipartForm = "multipart/form-data";
+declare type RequestContentType = RequestContentTypeJson | RequestContentTypePlainText | RequestContentTypeForm | RequestContentTypeBinary | RequestContentTypeMultipartForm;
+export declare function setDefaultRequestInitOptions(options: RequestInit): void;
+export declare function getDefaultRequestInitOptions(): RequestInit;
+export default function fetchRequest<T = any, CT = string>(method: string, url: string, body?: any, contentType?: CT | RequestContentType | undefined | null, returnHeaders?: false, extraRequestOptions?: RequestInit): Promise<T>;
+export default function fetchRequest<T = any, CT = string>(method: string, url: string, body?: any, contentType?: CT | RequestContentType | undefined | null, returnHeaders?: true, extraRequestOptions?: RequestInit): Promise<[T, Headers]>;
+export {};

package/dist/fetchRequest.js

@@ -0,0 +1,62 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDefaultRequestInitOptions = exports.setDefaultRequestInitOptions = void 0;
+const isomorphic_fetch_1 = __importDefault(require("isomorphic-fetch"));
+const merge_1 = __importDefault(require("lodash/merge"));
+const ServerError_1 = __importDefault(require("./ServerError"));
+let defaultRequestInitOptions = {};
+function setDefaultRequestInitOptions(options) {
+    defaultRequestInitOptions = options;
+}
+exports.setDefaultRequestInitOptions = setDefaultRequestInitOptions;
+function getDefaultRequestInitOptions() {
+    return defaultRequestInitOptions;
+}
+exports.getDefaultRequestInitOptions = getDefaultRequestInitOptions;
+function fetchRequest(method, url, body = undefined, contentType = "application/json", returnHeaders = false, extraRequestOptions = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const defaultOptions = Object.assign({}, (defaultRequestInitOptions ? defaultRequestInitOptions : {}));
+        const fetchOptions = merge_1.default(defaultOptions, Object.assign({ method }, extraRequestOptions));
+        if (body !== undefined) {
+            if (contentType === "application/json") {
+                fetchOptions.body = JSON.stringify(body);
+                fetchOptions.headers = {
+                    "Content-type": "application/json"
+                };
+            }
+            else {
+                fetchOptions.body = body;
+                if (typeof contentType === "string") {
+                    fetchOptions.headers = {
+                        "Content-type": contentType
+                    };
+                }
+            }
+        }
+        const response = yield isomorphic_fetch_1.default(url, fetchOptions);
+        if (response.status >= 200 && response.status < 300) {
+            // wrapping this in try/catch as the request succeeded
+            // this is just haggling over response content
+            return returnHeaders
+                ? [(yield response.json()), response.headers]
+                : (yield response.json());
+        }
+        // --- get responseText and remove any HTML tags
+        const responseText = (yield response.text()).replace(/<(.|\n)*?>/g, "");
+        throw new ServerError_1.default(responseText, response.status);
+    });
+}
+exports.default = fetchRequest;
+//# sourceMappingURL=fetchRequest.js.map

package/dist/fetchRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetchRequest.js","sourceRoot":"","sources":["../src/fetchRequest.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,wEAAqC;AACrC,yDAAiC;AACjC,gEAAwC;AAexC,IAAI,yBAAyB,GAAgB,EAAE,CAAC;AAEhD,SAAgB,4BAA4B,CAAC,OAAoB;IAC7D,yBAAyB,GAAG,OAAO,CAAC;AACxC,CAAC;AAFD,oEAEC;AAED,SAAgB,4BAA4B;IACxC,OAAO,yBAAyB,CAAC;AACrC,CAAC;AAFD,oEAEC;AAoBD,SAA8B,YAAY,CACtC,MAAc,EACd,GAAW,EACX,OAAY,SAAS,EACrB,cAIa,kBAAkB,EAC/B,gBAAyB,KAAK,EAC9B,sBAAmC,EAAE;;QAErC,MAAM,cAAc,qBACb,CAAC,yBAAyB,CAAC,CAAC,CAAC,yBAAyB,CAAC,CAAC,CAAC,EAAE,CAAC,CAClE,CAAC;QACF,MAAM,YAAY,GAAG,eAAK,CAAC,cAAc,kBACrC,MAAM,IACH,mBAAmB,EACxB,CAAC;QACH,IAAI,IAAI,KAAK,SAAS,EAAE;YACpB,IAAI,WAAW,KAAK,kBAAkB,EAAE;gBACpC,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBACzC,YAAY,CAAC,OAAO,GAAG;oBACnB,cAAc,EAAE,kBAAkB;iBACrC,CAAC;aACL;iBAAM;gBACH,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC;gBACzB,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;oBACjC,YAAY,CAAC,OAAO,GAAG;wBACnB,cAAc,EAAE,WAAW;qBAC9B,CAAC;iBACL;aACJ;SACJ;QAED,MAAM,QAAQ,GAAG,MAAM,0BAAK,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;QAEhD,IAAI,QAAQ,CAAC,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE;YACjD,sDAAsD;YACtD,8CAA8C;YAC9C,OAAO,aAAa;gBAChB,CAAC,CAAE,CAAC,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,EAAE,QAAQ,CAAC,OAAO,CAAkB;gBACpE,CAAC,CAAE,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAO,CAAC;SACxC;QACD,gDAAgD;QAChD,MAAM,YAAY,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;QACxE,MAAM,IAAI,qBAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IACzD,CAAC;CAAA;AA/CD,+BA+CC"}

package/dist/generated/registry/api.d.ts

@@ -88,10 +88,6 @@ export declare class Record {
     */
     'aspects': any;
     /**
-    * The read authorization policy id of a record
-    */
-    'authnReadPolicyId': string;
-    /**
     * A tag representing the action by the source of this record (e.g. an id for a individual crawl of a data portal).
     */
     'sourceTag': string;
@@ -143,6 +139,11 @@ export declare class WebHook {
     'retryCount': number;
     'isRunning': any;
     'isProcessing': any;
+    'ownerId': string;
+    'creatorId': string;
+    'editorId': string;
+    'createTime': Date;
+    'editTime': Date;
 }
 /**
 * Asynchronously acknowledges receipt of a web hook notification.
@@ -230,8 +231,9 @@ export declare class AspectDefinitionsApi {
      * Get a list of all aspects
      *
      * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId: number): Promise<{
+    getAll(xMagdaTenantId: number, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<AspectDefinition>;
     }>;
@@ -240,8 +242,9 @@ export declare class AspectDefinitionsApi {
      *
      * @param xMagdaTenantId 0
      * @param id ID of the aspect to be fetched.
+     * @param xMagdaSession Magda internal session id
      */
-    getById(xMagdaTenantId: number, id: string): Promise<{
+    getById(xMagdaTenantId: number, id: string, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: AspectDefinition;
     }>;
@@ -292,6 +295,33 @@ export declare class RecordAspectsApi {
         response: http.IncomingMessage;
         body: DeleteResult;
     }>;
+    /**
+     * Get a list of a record&#39;s aspects
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch aspects.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param aspectIdOnly When set to true, will respond only an array contains aspect id only.
+     * @param start The index of the first record to retrieve.
+     * @param limit The maximum number of records to receive.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspects(xMagdaTenantId: number, recordId: string, keyword?: string, aspectIdOnly?: boolean, start?: number, limit?: number, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: Array<any>;
+    }>;
+    /**
+     * Get the number of aspects that a record has
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspectsCount(xMagdaTenantId: number, recordId: string, keyword?: string, xMagdaSession?: string): Promise<{
+        response: http.IncomingMessage;
+        body: CountResponse;
+    }>;
     /**
      * Get a record aspect by ID
      *
@@ -449,6 +479,17 @@ export declare class RecordsApi {
         response: http.IncomingMessage;
         body: Record;
     }>;
+    /**
+     * 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;
+    }>;
     /**
      * Get a summary record by ID
      * Gets a summary record, including all the aspect ids for which this record has data.
@@ -495,7 +536,7 @@ export declare class RecordsApi {
      */
     patchById(xMagdaTenantId: number, id: string, recordPatch: Array<Operation>, xMagdaSession: string): Promise<{
         response: http.IncomingMessage;
-        body: AspectDefinition;
+        body: Record;
     }>;
     /**
      * Modify a record by ID

package/dist/generated/registry/api.js

@@ -214,8 +214,9 @@ class AspectDefinitionsApi {
      * Get a list of all aspects
      *
      * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId) {
+    getAll(xMagdaTenantId, xMagdaSession) {
         const localVarPath = this.basePath + '/aspects';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -225,6 +226,7 @@ class AspectDefinitionsApi {
             throw new Error('Required parameter xMagdaTenantId was null or undefined when calling getAll.');
         }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
+        headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
         let requestOptions = {
             method: 'GET',
@@ -264,8 +266,9 @@ class AspectDefinitionsApi {
      *
      * @param xMagdaTenantId 0
      * @param id ID of the aspect to be fetched.
+     * @param xMagdaSession Magda internal session id
      */
-    getById(xMagdaTenantId, id) {
+    getById(xMagdaTenantId, id, xMagdaSession) {
         const localVarPath = this.basePath + '/aspects/{id}'
             .replace('{' + 'id' + '}', String(id));
         let queryParameters = {};
@@ -280,6 +283,7 @@ class AspectDefinitionsApi {
             throw new Error('Required parameter id was null or undefined when calling getById.');
         }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
+        headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
         let requestOptions = {
             method: 'GET',
@@ -545,6 +549,140 @@ class RecordAspectsApi {
             });
         });
     }
+    /**
+     * Get a list of a record's aspects
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch aspects.
+     * @param keyword Specify the keyword to search in the all aspects' aspectId & data fields.
+     * @param aspectIdOnly When set to true, will respond only an array contains aspect id only.
+     * @param start The index of the first record to retrieve.
+     * @param limit The maximum number of records to receive.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspects(xMagdaTenantId, recordId, keyword, aspectIdOnly, start, limit, xMagdaSession) {
+        const localVarPath = this.basePath + '/records/{recordId}/aspects'
+            .replace('{' + 'recordId' + '}', String(recordId));
+        let queryParameters = {};
+        let headerParams = Object.assign({}, this.defaultHeaders);
+        let formParams = {};
+        // 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 getAspects.');
+        }
+        // verify required parameter 'recordId' is not null or undefined
+        if (recordId === null || recordId === undefined) {
+            throw new Error('Required parameter recordId was null or undefined when calling getAspects.');
+        }
+        if (keyword !== undefined) {
+            queryParameters['keyword'] = keyword;
+        }
+        if (aspectIdOnly !== undefined) {
+            queryParameters['aspectIdOnly'] = aspectIdOnly;
+        }
+        if (start !== undefined) {
+            queryParameters['start'] = start;
+        }
+        if (limit !== undefined) {
+            queryParameters['limit'] = limit;
+        }
+        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 the number of aspects that a record has
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspectsCount(xMagdaTenantId, recordId, keyword, xMagdaSession) {
+        const localVarPath = this.basePath + '/records/{recordId}/aspects/count'
+            .replace('{' + 'recordId' + '}', String(recordId));
+        let queryParameters = {};
+        let headerParams = Object.assign({}, this.defaultHeaders);
+        let formParams = {};
+        // 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 getAspectsCount.');
+        }
+        // verify required parameter 'recordId' is not null or undefined
+        if (recordId === null || recordId === undefined) {
+            throw new Error('Required parameter recordId was null or undefined when calling getAspectsCount.');
+        }
+        if (keyword !== undefined) {
+            queryParameters['keyword'] = keyword;
+        }
+        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 record aspect by ID
      *
@@ -1305,6 +1443,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.