@magda/minion-sdk 1.2.0-rc.0 → 2.0.0-alpha.0

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 /// <reference types="node" />
 import express from 'express';
 import http = require('http');
+import { Response as Response_2 } from 'request';
 import { default as URI_2 } from 'urijs';
 import yargs from 'yargs';
 
@@ -45,8 +46,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>;
     }>;
@@ -55,8 +57,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;
     }>;
@@ -92,6 +95,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>;
@@ -320,6 +324,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
      *
@@ -599,8 +630,16 @@ declare class RegistryClient {
     protected tenantId: number;
     protected jwt: string | undefined;
     constructor({ baseUrl, maxRetries, secondsBetweenRetries, tenantId }: RegistryOptions);
+    toServerError(error: {
+        body: any;
+        response: Response_2;
+    }): ServerError | {
+        body: any;
+        response: Response_2;
+    };
     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>;
     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>;
@@ -622,6 +661,16 @@ declare interface RegistryOptions {
     tenantId: number;
 }
 
+declare class ServerError extends Error {
+    statusCode: number;
+    constructor(message?: string, statusCode?: number);
+    toData(): {
+        isError: boolean;
+        errorCode: number;
+        errorMessage: string;
+    };
+}
+
 declare class WebHook {
     'id': string;
     'name': string;
@@ -636,6 +685,11 @@ declare class WebHook {
     'retryCount': number;
     'isRunning': any;
     'isProcessing': any;
+    'ownerId': string;
+    'creatorId': string;
+    'editorId': string;
+    'createTime': Date;
+    'editTime': Date;
 }
 
 /**