@magda/registry-client 1.3.0-rc.0 → 2.0.0-alpha.2

package/dist/index.d.ts

@@ -43,8 +43,9 @@ 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>;
     }>;
@@ -53,8 +54,9 @@ 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;
     }>;
@@ -90,6 +92,7 @@ declare enum AspectDefinitionsApiApiKeys {
 export declare class AuthorizedRegistryClient extends RegistryClient {
     protected jwt: string;
     constructor(options: AuthorizedRegistryOptions);
+    getAspectDefinition(aspectId: string): Promise<AspectDefinition>;
     putAspectDefinition(aspectDefinition: AspectDefinition, tenantId?: number): Promise<AspectDefinition | Error>;
     postHook(hook: WebHook): Promise<WebHook | Error>;
     putHook(hook: WebHook): Promise<WebHook | Error>;
@@ -97,24 +100,18 @@ export declare class AuthorizedRegistryClient extends RegistryClient {
     getHooks(): Promise<WebHook[] | Error>;
     resumeHook(webhookId: string, succeeded?: boolean, lastEventIdReceived?: string, active?: boolean): Promise<WebHookAcknowledgementResponse | Error>;
     putRecord(record: Record_2, tenantId?: number): Promise<Record_2 | Error>;
+    patchRecord(recordId: string, recordPatch: Operation[], tenantId?: number): Promise<Record_2 | Error>;
     putRecordAspect(recordId: string, aspectId: string, aspect: any, tenantId?: number): Promise<Record_2 | Error>;
+    deleteRecordAspect(recordId: string, aspectId: string, tenantId?: number): Promise<DeleteResult | Error>;
     patchRecordAspect(recordId: string, aspectId: string, aspectPatch: Operation[], tenantId?: number): Promise<Record_2 | Error>;
     deleteBySource(sourceTagToPreserve: string, sourceId: string, tenantId?: number): Promise<MultipleDeleteResult | "Processing" | Error>;
     getRecordHistory(id: string, pageToken?: string, start?: number, limit?: number): Promise<EventsPage | Error>;
 }
 
-declare interface AuthorizedRegistryJwtOptions extends RegistryOptions {
-    jwt: string;
-    userId?: never;
-    jwtSecret?: never;
-}
-
-export declare type AuthorizedRegistryOptions = AuthorizedRegistryUserIdAndJwtSecretOptions | AuthorizedRegistryJwtOptions;
-
-declare interface AuthorizedRegistryUserIdAndJwtSecretOptions extends RegistryOptions {
-    userId: string;
-    jwtSecret: string;
-    jwt?: never;
+export declare interface AuthorizedRegistryOptions extends RegistryOptions {
+    jwt?: string;
+    userId?: string;
+    jwtSecret?: string;
 }
 
 declare class CountResponse {
@@ -246,10 +243,6 @@ declare class Record_2 {
     */
     '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;
@@ -280,6 +273,33 @@ 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
      *
@@ -441,6 +461,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.
@@ -487,7 +518,7 @@ declare class RecordsApi {
      */
     patchById(xMagdaTenantId: number, id: string, recordPatch: Array<Operation>, xMagdaSession: string): Promise<{
         response: http.IncomingMessage;
-        body: AspectDefinition;
+        body: Record_2;
     }>;
     /**
      * Modify a record by ID
@@ -561,7 +592,9 @@ export declare class RegistryClient {
     constructor({ baseUrl, maxRetries, secondsBetweenRetries, tenantId }: RegistryOptions);
     getRecordUrl(id: string): string;
     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>;
 }
@@ -598,6 +631,11 @@ export declare class WebHook {
     'retryCount': number;
     'isRunning': any;
     'isProcessing': any;
+    'ownerId': string;
+    'creatorId': string;
+    'editorId': string;
+    'createTime': Date;
+    'editTime': Date;
 }
 
 /**