@magda/registry-client 2.0.0-alpha.2 → 2.0.0-alpha.5

package/dist/index.d.ts

@@ -93,19 +93,24 @@ 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>;
-    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_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>;
+    putAspectDefinition(aspectDefinition: AspectDefinition, tenantId?: number): Promise<AspectDefinition | ServerError>;
+    postHook(hook: WebHook): Promise<WebHook | ServerError>;
+    putHook(hook: WebHook): Promise<WebHook | ServerError>;
+    getHook(hookId: string): Promise<Maybe<WebHook> | ServerError>;
+    getHooks(): Promise<WebHook[] | ServerError>;
+    resumeHook(webhookId: string, succeeded?: boolean, lastEventIdReceived?: string, active?: boolean): Promise<WebHookAcknowledgementResponse | ServerError>;
+    creatRecord(record: Record_2, tenantId?: number): Promise<Record_2 | ServerError>;
+    putRecord(record: Record_2, tenantId?: number): Promise<Record_2 | ServerError>;
+    patchRecord(recordId: string, recordPatch: Operation[], tenantId?: number): Promise<Record_2 | ServerError>;
+    patchRecords(recordIds: string[], recordPatch: Operation[], tenantId?: number): Promise<string[] | ServerError>;
+    putRecordAspect(recordId: string, aspectId: string, aspect: any, merge?: boolean, tenantId?: number): Promise<any | ServerError>;
+    putRecordsAspect(recordIds: string[], aspectId: string, aspectData: any, merge?: boolean, tenantId?: number): Promise<string[] | ServerError>;
+    deleteRecordsAspectArrayItems(recordIds: string[], aspectId: string, jsonPath: string, items: (string | number)[], tenantId?: number): Promise<string[] | ServerError>;
+    deleteRecordAspect(recordId: string, aspectId: string, tenantId?: number): Promise<DeleteResult | ServerError>;
+    patchRecordAspect(recordId: string, aspectId: string, aspectPatch: Operation[], tenantId?: number): Promise<Record_2 | ServerError>;
+    deleteBySource(sourceTagToPreserve: string, sourceId: string, tenantId?: number): Promise<MultipleDeleteResult | "Processing" | ServerError>;
+    deleteRecord(id: string, tenantId?: number): Promise<DeleteResult | ServerError>;
+    getRecordHistory(id: string, pageToken?: string, start?: number, limit?: number): Promise<EventsPage | ServerError>;
 }
 
 export declare interface AuthorizedRegistryOptions extends RegistryOptions {
@@ -118,6 +123,12 @@ declare class CountResponse {
     'count': number;
 }
 
+declare class DeleteRecordsAspectArrayItemsRequest {
+    'recordIds': Array<string>;
+    'jsonPath': string;
+    'items': Array<JsValue>;
+}
+
 declare class DeleteResult {
     'deleted': boolean;
 }
@@ -161,6 +172,10 @@ declare class JsObject {
     };
 }
 
+declare class JsonPatch {
+    'ops': Array<Operation>;
+}
+
 declare class JsValue {
 }
 
@@ -226,6 +241,16 @@ declare interface OptionalMaybePatterns<T, U> {
     nothing?: () => U;
 }
 
+declare class PatchRecordsRequest {
+    'recordIds': Array<string>;
+    'jsonPath': JsonPatch;
+}
+
+declare class PutRecordsAspectRequest {
+    'recordIds': Array<string>;
+    'data': JsObject;
+}
+
 /**
 * A record in the registry, usually including data for one or more aspects, unique for a tenant.
 */
@@ -333,8 +358,9 @@ declare class RecordAspectsApi {
      * @param aspect The record aspect to save.
      * @param xMagdaSession Magda internal session id
      * @param xMagdaTenantId 0
+     * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
      */
-    putById(recordId: string, aspectId: string, aspect: any, xMagdaSession: string, xMagdaTenantId: number): Promise<{
+    putById(recordId: string, aspectId: string, aspect: any, xMagdaSession: string, xMagdaTenantId: number, merge?: boolean): Promise<{
         response: http.IncomingMessage;
         body: any;
     }>;
@@ -413,6 +439,18 @@ declare class RecordsApi {
         response: http.IncomingMessage;
         body: DeleteResult;
     }>;
+    /**
+     * Remove items from records&#39; aspect data
+     * Remove items from records&#39; aspect data
+     * @param xMagdaTenantId 0
+     * @param aspectId ID of the aspect to update.
+     * @param requestData An json object has key &#39;recordIds&#39;, &#39;jsonPath&#39;, &#39;items&#39;
+     * @param xMagdaSession Magda internal session id
+     */
+    deleteRecordsAspectArrayItems(xMagdaTenantId: number, aspectId: string, requestData: DeleteRecordsAspectArrayItemsRequest, xMagdaSession: string): Promise<{
+        response: http.IncomingMessage;
+        body: Array<any>;
+    }>;
     /**
      * Get a list of all records
      *
@@ -512,7 +550,7 @@ declare class RecordsApi {
      * Modify a record by applying a JSON Patch
      * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
      * @param xMagdaTenantId 0
-     * @param id ID of the aspect to be saved.
+     * @param id ID of the record to be pacthed.
      * @param recordPatch The RFC 6902 patch to apply to the aspect.
      * @param xMagdaSession Magda internal session id
      */
@@ -520,6 +558,17 @@ declare class RecordsApi {
         response: http.IncomingMessage;
         body: Record_2;
     }>;
+    /**
+     * Modify a list of records by applying the same JSON Patch
+     * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
+     * @param xMagdaTenantId 0
+     * @param requestData An json object has key &#39;recordIds&#39; &amp; &#39;jsonPath&#39;
+     * @param xMagdaSession Magda internal session id
+     */
+    patchRecords(xMagdaTenantId: number, requestData: PatchRecordsRequest, xMagdaSession: string): Promise<{
+        response: http.IncomingMessage;
+        body: Array<any>;
+    }>;
     /**
      * Modify a record by ID
      * Modifies a record.  Aspects included in the request are created or updated, but missing aspects are not removed.
@@ -532,6 +581,19 @@ declare class RecordsApi {
         response: http.IncomingMessage;
         body: Record_2;
     }>;
+    /**
+     * Modify a list of records&#39;s aspect with same new data
+     * Modify a list of records&#39;s aspect with same new data
+     * @param xMagdaTenantId 0
+     * @param aspectId ID of the aspect to update.
+     * @param requestData An json object has key &#39;recordIds&#39; &amp; &#39;data&#39;
+     * @param xMagdaSession Magda internal session id
+     * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
+     */
+    putRecordsAspect(xMagdaTenantId: number, aspectId: string, requestData: PutRecordsAspectRequest, xMagdaSession: string, merge?: boolean): Promise<{
+        response: http.IncomingMessage;
+        body: Array<any>;
+    }>;
     /**
      * Trim by source tag
      * Trims records with the provided source that DON&#39;T have the supplied source tag
@@ -591,12 +653,13 @@ export declare class RegistryClient {
     protected jwt: string | undefined;
     constructor({ baseUrl, maxRetries, secondsBetweenRetries, tenantId }: RegistryOptions);
     getRecordUrl(id: string): string;
-    getAspectDefinitions(): Promise<AspectDefinition[] | Error>;
+    getAspectDefinitions(): Promise<AspectDefinition[] | ServerError>;
     getAspectDefinition(aspectId: string, jwtToken?: string): Promise<AspectDefinition>;
-    getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | Error>;
+    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> | Error>;
-    getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | Error>;
+    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>;
+    getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | ServerError>;
 }
 
 export declare class RegistryEvent {
@@ -615,6 +678,16 @@ export declare interface RegistryOptions {
     tenantId: number;
 }
 
+declare class ServerError extends Error {
+    statusCode: number;
+    constructor(message?: string, statusCode?: number);
+    toData(): {
+        isError: boolean;
+        errorCode: number;
+        errorMessage: string;
+    };
+}
+
 export declare const TenantConsts: any;
 
 export declare class WebHook {