@magda/minion-sdk 2.0.0-alpha.5 → 2.0.0-alpha.8

package/dist/index.d.ts

@@ -122,13 +122,13 @@ export declare interface AuthorizedRegistryOptions extends RegistryOptions {
 }
 
 /**
-                               * Builds an argv object that will accept command line arguments used by all common argv minions.
-                               *
-                               * @param id
-                               * @param defaultPort
-                               * @param defaultInternalUrl
-                               * @param additions
-                               */
+                                                 * Builds an argv object that will accept command line arguments used by all common argv minions.
+                                                 *
+                                                 * @param id
+                                                 * @param defaultPort
+                                                 * @param defaultInternalUrl
+                                                 * @param additions
+                                                 */
 export declare function commonYargs<T extends MinionArguments = MinionArguments>(defaultPort: number, defaultInternalUrl: string, additions?: (a: yargs.Argv<MinionArguments>) => yargs.Argv<T>): T;
 
 declare class CountResponse {
@@ -245,7 +245,8 @@ export declare type MinionArguments = {
   registryUrl: string;
   enableMultiTenant: boolean;
   tenantUrl: string;
-  retries: string | number;};
+  retries: string | number;
+  crawlerRecordFetchNumber?: string | number;};
 
 export declare interface MinionOptions {
   argv: MinionArguments;
@@ -428,8 +429,9 @@ declare class RecordHistoryApi {
      * @param limit The maximum number of events to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
      * @param aspect The aspects for which to included in event history, specified as multiple occurrences of this query parameter.
      * @param dereference true to automatically dereference links to other records; false to leave them as links.  Dereferencing a link means including the record itself where the link would be.  Dereferencing only happens one level deep, regardless of the value of this parameter.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
      */
-    history(xMagdaTenantId: number, recordId: string, xMagdaSession: string, pageToken?: string, start?: number, limit?: number, aspect?: Array<string>, dereference?: boolean): Promise<{
+    history(xMagdaTenantId: number, recordId: string, xMagdaSession: string, pageToken?: string, start?: number, limit?: number, aspect?: Array<string>, dereference?: boolean, reversePageTokenOrder?: boolean): Promise<{
         response: http.IncomingMessage;
         body: EventsPage;
     }>;
@@ -506,9 +508,10 @@ declare class RecordsApi {
      * @param orderBy Specify the field to sort the result. Aspect field can be supported in a format like aspectId.path.to.field
      * @param orderByDir Specify the order by direction. Either &#x60;asc&#x60; or &#x60;desc&#x60;
      * @param orderNullFirst Specify whether nulls appear before (&#x60;true&#x60;) or after (&#x60;false&#x60;) non-null values in the sort ordering.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
      * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, start?: number, limit?: number, dereference?: boolean, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, xMagdaSession?: string): Promise<{
+    getAll(xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, start?: number, limit?: number, dereference?: boolean, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, reversePageTokenOrder?: boolean, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<Record_2>;
     }>;
@@ -519,9 +522,10 @@ declare class RecordsApi {
      * @param pageToken A token that identifies the start of a page of results.  This token should not be interpreted as having any meaning, but it can be obtained from a previous page of results.
      * @param start The index of the first record to retrieve.  When possible, specify pageToken instead as it will result in better performance.  If this parameter and pageToken are both specified, this parameter is interpreted as the index after the pageToken of the first record to retrieve.
      * @param limit The maximum number of records to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
      * @param xMagdaSession Magda internal session id
      */
-    getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, xMagdaSession?: string): Promise<{
+    getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<RecordSummary>;
     }>;
@@ -698,7 +702,7 @@ declare class RegistryClient {
     getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | ServerError>;
     getRecordAspect(id: string, aspectId: string): Promise<any | ServerError>;
     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> | ServerError>;
+    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): Promise<RecordsPage<I> | ServerError>;
     getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | ServerError>;
 }
 

package/dist/index.js

@@ -38187,8 +38187,9 @@ class RecordHistoryApi {
      * @param limit The maximum number of events to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
      * @param aspect The aspects for which to included in event history, specified as multiple occurrences of this query parameter.
      * @param dereference true to automatically dereference links to other records; false to leave them as links.  Dereferencing a link means including the record itself where the link would be.  Dereferencing only happens one level deep, regardless of the value of this parameter.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to `true`, higher pageToken records (newer records) will be returned.
      */
-    history(xMagdaTenantId, recordId, xMagdaSession, pageToken, start, limit, aspect, dereference) {
+    history(xMagdaTenantId, recordId, xMagdaSession, pageToken, start, limit, aspect, dereference, reversePageTokenOrder) {
         const localVarPath = this.basePath + '/records/{recordId}/history'
             .replace('{' + 'recordId' + '}', String(recordId));
         let queryParameters = {};
@@ -38221,6 +38222,9 @@ class RecordHistoryApi {
         if (dereference !== undefined) {
             queryParameters['dereference'] = dereference;
         }
+        if (reversePageTokenOrder !== undefined) {
+            queryParameters['reversePageTokenOrder'] = reversePageTokenOrder;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
@@ -38552,9 +38556,10 @@ class RecordsApi {
      * @param orderBy Specify the field to sort the result. Aspect field can be supported in a format like aspectId.path.to.field
      * @param orderByDir Specify the order by direction. Either `asc` or `desc`
      * @param orderNullFirst Specify whether nulls appear before (`true`) or after (`false`) non-null values in the sort ordering.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to `true`, higher pageToken records (newer records) will be returned.
      * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId, aspect, optionalAspect, pageToken, start, limit, dereference, aspectQuery, aspectOrQuery, orderBy, orderByDir, orderNullFirst, xMagdaSession) {
+    getAll(xMagdaTenantId, aspect, optionalAspect, pageToken, start, limit, dereference, aspectQuery, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, xMagdaSession) {
         const localVarPath = this.basePath + '/records';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -38596,6 +38601,9 @@ class RecordsApi {
         if (orderNullFirst !== undefined) {
             queryParameters['orderNullFirst'] = orderNullFirst;
         }
+        if (reversePageTokenOrder !== undefined) {
+            queryParameters['reversePageTokenOrder'] = reversePageTokenOrder;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
@@ -38639,9 +38647,10 @@ class RecordsApi {
      * @param pageToken A token that identifies the start of a page of results.  This token should not be interpreted as having any meaning, but it can be obtained from a previous page of results.
      * @param start The index of the first record to retrieve.  When possible, specify pageToken instead as it will result in better performance.  If this parameter and pageToken are both specified, this parameter is interpreted as the index after the pageToken of the first record to retrieve.
      * @param limit The maximum number of records to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to `true`, higher pageToken records (newer records) will be returned.
      * @param xMagdaSession Magda internal session id
      */
-    getAllSummary(xMagdaTenantId, pageToken, start, limit, xMagdaSession) {
+    getAllSummary(xMagdaTenantId, pageToken, start, limit, reversePageTokenOrder, xMagdaSession) {
         const localVarPath = this.basePath + '/records/summary';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -38659,6 +38668,9 @@ class RecordsApi {
         if (limit !== undefined) {
             queryParameters['limit'] = limit;
         }
+        if (reversePageTokenOrder !== undefined) {
+            queryParameters['reversePageTokenOrder'] = reversePageTokenOrder;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
@@ -61202,8 +61214,8 @@ class RegistryClient {
             }
         });
     }
-    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);
+    getRecords(aspect, optionalAspect, pageToken, dereference, limit, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder) {
+        const operation = (pageToken) => () => this.recordsApi.getAll(this.tenantId, aspect, optionalAspect, pageToken, undefined, limit, dereference, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, 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)))
             .then((result) => result.body)
             .catch(exports.toServerError("getRecords"));
@@ -84289,14 +84301,14 @@ class Crawler {
     return this.isCrawling;
   }
   crawlExistingRecords() {
-    var _a;
+    var _a, _b, _c, _d;
     return __awaiter(this, void 0, void 0, function* () {
       try {
         this.resetCrawler();
         this.isCrawling = true;
         console.info("Crawling existing records in registry");
         const crawlerRecordFetchNumber = ((_a = this.options) === null || _a === void 0 ? void 0 : _a.crawlerRecordFetchNumber) ? this.options.crawlerRecordFetchNumber :
-        DEFAULT_CRAWLER_RECORD_FETCH_NUMBER;
+        ((_c = (_b = this.options) === null || _b === void 0 ? void 0 : _b.argv) === null || _c === void 0 ? void 0 : _c.crawlerRecordFetchNumber) ? (_d = this.options) === null || _d === void 0 ? void 0 : _d.argv.crawlerRecordFetchNumber : DEFAULT_CRAWLER_RECORD_FETCH_NUMBER;
         const registryPage = AsyncPage_1.default.create(previous => {
           if (previous && previous.hasMore === false) {
             console.info("No more records left");

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/minion-sdk",
   "description": "MAGDA Minion SDK",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.8",
   "scripts": {
     "prebuild": "rimraf dist tsconfig.tsbuildinfo",
     "build": "webpack && api-extractor run -l",
@@ -12,8 +12,8 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "devDependencies": {
-    "@magda/minion-framework": "^2.0.0-alpha.5",
-    "@magda/typescript-common": "^2.0.0-alpha.5",
+    "@magda/minion-framework": "^2.0.0-alpha.8",
+    "@magda/typescript-common": "^2.0.0-alpha.8",
     "@microsoft/api-extractor": "^7.7.8",
     "ts-loader": "^6.2.1",
     "typescript": "^3.7.2",