@magda/registry-client 2.3.0 → 2.3.2-alpha.0

package/README.md

@@ -8,41 +8,42 @@ This package provides NodeJs client library to connect to a Magda Registry.
 
 ```typescript
 export declare class RegistryClient {
-    protected baseUri: uri.URI;
-    protected aspectDefinitionsApi: AspectDefinitionsApi;
-    protected recordsApi: RecordsApi;
-    protected webHooksApi: WebHooksApi;
-    protected recordAspectsApi: RecordAspectsApi;
-    protected maxRetries: number;
-    protected secondsBetweenRetries: number;
-    protected tenantId: number;
-    protected jwt: string | undefined;
-    constructor({
-        baseUrl,
-        maxRetries,
-        secondsBetweenRetries,
-        tenantId
-    }: RegistryOptions);
-    getRecordUrl(id: string): string;
-    getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
-    getRecord(
-        id: string,
-        aspect?: Array<string>,
-        optionalAspect?: Array<string>,
-        dereference?: boolean
-    ): Promise<Record | Error>;
-    getRecords<I extends Record>(
-        aspect?: Array<string>,
-        optionalAspect?: Array<string>,
-        pageToken?: string,
-        dereference?: boolean,
-        limit?: number,
-        aspectQueries?: string[]
-    ): Promise<RecordsPage<I> | Error>;
-    getRecordsPageTokens(
-        aspect?: Array<string>,
-        limit?: number
-    ): Promise<string[] | Error>;
+  protected baseUri: uri.URI;
+  protected aspectDefinitionsApi: AspectDefinitionsApi;
+  protected recordsApi: RecordsApi;
+  protected webHooksApi: WebHooksApi;
+  protected recordAspectsApi: RecordAspectsApi;
+  protected maxRetries: number;
+  protected secondsBetweenRetries: number;
+  protected tenantId: number;
+  protected jwt: string | undefined;
+  constructor({
+    baseUrl,
+    maxRetries,
+    secondsBetweenRetries,
+    tenantId
+  }: RegistryOptions);
+  getRecordUrl(id: string): string;
+  getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
+  getRecord(
+    id: string,
+    aspect?: Array<string>,
+    optionalAspect?: Array<string>,
+    dereference?: boolean
+  ): Promise<Record | Error>;
+  getRecords<I extends Record>(
+    aspect?: Array<string>,
+    optionalAspect?: Array<string>,
+    pageToken?: string,
+    dereference?: boolean,
+    limit?: number,
+    aspectQueries?: string[],
+    q?: string
+  ): Promise<RecordsPage<I> | Error>;
+  getRecordsPageTokens(
+    aspect?: Array<string>,
+    limit?: number
+  ): Promise<string[] | Error>;
 }
 ```
 
@@ -50,40 +51,40 @@ export declare class RegistryClient {
 
 ```typescript
 export declare class AuthorizedRegistryClient extends RegistryClient {
-    protected options: AuthorizedRegistryOptions;
-    protected jwt: string;
-    constructor(options: AuthorizedRegistryOptions);
-    putAspectDefinition(
-        aspectDefinition: AspectDefinition,
-        tenantId?: number
-    ): Promise<AspectDefinition | Error>;
-    postHook(hook: WebHook): Promise<WebHook | Error>;
-    putHook(hook: WebHook): Promise<WebHook | Error>;
-    getHook(hookId: string): Promise<Maybe<WebHook> | Error>;
-    getHooks(): Promise<WebHook[] | Error>;
-    resumeHook(
-        webhookId: string,
-        succeeded?: boolean,
-        lastEventIdReceived?: string,
-        active?: boolean
-    ): Promise<WebHookAcknowledgementResponse | Error>;
-    putRecord(record: Record, tenantId?: number): Promise<Record | Error>;
-    putRecordAspect(
-        recordId: string,
-        aspectId: string,
-        aspect: any,
-        tenantId?: number
-    ): Promise<Record | Error>;
-    patchRecordAspect(
-        recordId: string,
-        aspectId: string,
-        aspectPatch: Operation[],
-        tenantId?: number
-    ): Promise<Record | Error>;
-    deleteBySource(
-        sourceTagToPreserve: string,
-        sourceId: string,
-        tenantId?: number
-    ): Promise<MultipleDeleteResult | "Processing" | Error>;
+  protected options: AuthorizedRegistryOptions;
+  protected jwt: string;
+  constructor(options: AuthorizedRegistryOptions);
+  putAspectDefinition(
+    aspectDefinition: AspectDefinition,
+    tenantId?: number
+  ): Promise<AspectDefinition | Error>;
+  postHook(hook: WebHook): Promise<WebHook | Error>;
+  putHook(hook: WebHook): Promise<WebHook | Error>;
+  getHook(hookId: string): Promise<Maybe<WebHook> | Error>;
+  getHooks(): Promise<WebHook[] | Error>;
+  resumeHook(
+    webhookId: string,
+    succeeded?: boolean,
+    lastEventIdReceived?: string,
+    active?: boolean
+  ): Promise<WebHookAcknowledgementResponse | Error>;
+  putRecord(record: Record, tenantId?: number): Promise<Record | Error>;
+  putRecordAspect(
+    recordId: string,
+    aspectId: string,
+    aspect: any,
+    tenantId?: number
+  ): Promise<Record | Error>;
+  patchRecordAspect(
+    recordId: string,
+    aspectId: string,
+    aspectPatch: Operation[],
+    tenantId?: number
+  ): Promise<Record | Error>;
+  deleteBySource(
+    sourceTagToPreserve: string,
+    sourceId: string,
+    tenantId?: number
+  ): Promise<MultipleDeleteResult | "Processing" | Error>;
 }
 ```

package/dist/index.d.ts

@@ -468,9 +468,10 @@ declare class RecordsApi {
      * @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 q full text search query
      * @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, reversePageTokenOrder?: 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, q?: string, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<Record_2>;
     }>;
@@ -482,9 +483,10 @@ declare class RecordsApi {
      * @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 q full text search query
      * @param xMagdaSession Magda internal session id
      */
-    getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, xMagdaSession?: string): Promise<{
+    getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: Array<RecordSummary>;
     }>;
@@ -531,9 +533,10 @@ declare class RecordsApi {
      * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
      * @param aspectQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. NOTE: This is an early stage API and may change greatly in the future
      * @param aspectOrQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. Queries passing via this parameter will be grouped with OR logic.
+     * @param q full text search query
      * @param xMagdaSession Magda internal session id
      */
-    getCount(xMagdaTenantId: number, aspect?: Array<string>, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, xMagdaSession?: string): Promise<{
+    getCount(xMagdaTenantId: number, aspect?: Array<string>, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, q?: string, xMagdaSession?: string): Promise<{
         response: http.IncomingMessage;
         body: CountResponse;
     }>;
@@ -662,7 +665,7 @@ export 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, reversePageTokenOrder?: 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, q?: string): Promise<RecordsPage<I> | ServerError>;
     getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | ServerError>;
 }
 

package/dist/index.js

@@ -11387,8 +11387,8 @@ class RegistryClient {
             }
         });
     }
-    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);
+    getRecords(aspect, optionalAspect, pageToken, dereference, limit, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, q) {
+        const operation = (pageToken) => () => this.recordsApi.getAll(this.tenantId, aspect, optionalAspect, pageToken, undefined, limit, dereference, aspectQueries, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, q, 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"));
@@ -12729,9 +12729,10 @@ class RecordsApi {
      * @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 q full text search query
      * @param xMagdaSession Magda internal session id
      */
-    getAll(xMagdaTenantId, aspect, optionalAspect, pageToken, start, limit, dereference, aspectQuery, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, xMagdaSession) {
+    getAll(xMagdaTenantId, aspect, optionalAspect, pageToken, start, limit, dereference, aspectQuery, aspectOrQuery, orderBy, orderByDir, orderNullFirst, reversePageTokenOrder, q, xMagdaSession) {
         const localVarPath = this.basePath + '/records';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -12776,6 +12777,9 @@ class RecordsApi {
         if (reversePageTokenOrder !== undefined) {
             queryParameters['reversePageTokenOrder'] = reversePageTokenOrder;
         }
+        if (q !== undefined) {
+            queryParameters['q'] = q;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
@@ -12820,9 +12824,10 @@ class RecordsApi {
      * @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 q full text search query
      * @param xMagdaSession Magda internal session id
      */
-    getAllSummary(xMagdaTenantId, pageToken, start, limit, reversePageTokenOrder, xMagdaSession) {
+    getAllSummary(xMagdaTenantId, pageToken, start, limit, reversePageTokenOrder, q, xMagdaSession) {
         const localVarPath = this.basePath + '/records/summary';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -12843,6 +12848,9 @@ class RecordsApi {
         if (reversePageTokenOrder !== undefined) {
             queryParameters['reversePageTokenOrder'] = reversePageTokenOrder;
         }
+        if (q !== undefined) {
+            queryParameters['q'] = q;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;
@@ -13069,9 +13077,10 @@ class RecordsApi {
      * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
      * @param aspectQuery Filter the records returned by a value within the aspect JSON. Expressed as 'aspectId.path.to.field:value', url encoded. NOTE: This is an early stage API and may change greatly in the future
      * @param aspectOrQuery Filter the records returned by a value within the aspect JSON. Expressed as 'aspectId.path.to.field:value', url encoded. Queries passing via this parameter will be grouped with OR logic.
+     * @param q full text search query
      * @param xMagdaSession Magda internal session id
      */
-    getCount(xMagdaTenantId, aspect, aspectQuery, aspectOrQuery, xMagdaSession) {
+    getCount(xMagdaTenantId, aspect, aspectQuery, aspectOrQuery, q, xMagdaSession) {
         const localVarPath = this.basePath + '/records/count';
         let queryParameters = {};
         let headerParams = Object.assign({}, this.defaultHeaders);
@@ -13089,6 +13098,9 @@ class RecordsApi {
         if (aspectOrQuery !== undefined) {
             queryParameters['aspectOrQuery'] = aspectOrQuery;
         }
+        if (q !== undefined) {
+            queryParameters['q'] = q;
+        }
         headerParams['X-Magda-Tenant-Id'] = xMagdaTenantId;
         headerParams['X-Magda-Session'] = xMagdaSession;
         let useFormData = false;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@magda/registry-client",
   "description": "MAGDA Registry Client",
-  "version": "2.3.0",
+  "version": "2.3.2-alpha.0",
   "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.3.0",
+    "@magda/typescript-common": "^2.3.2-alpha.0",
     "@microsoft/api-extractor": "~7.15.2",
     "ts-loader": "^6.2.1",
     "typescript": "~4.2.4",