@magda/minion-sdk 2.0.0-alpha.0 → 2.0.0-alpha.3

package/dist/index.d.ts

@@ -1,7 +1,6 @@
 /// <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';
 
@@ -103,24 +102,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;
 }
 
 /**
@@ -290,10 +283,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;
@@ -512,6 +501,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.
@@ -558,7 +558,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
@@ -630,17 +630,11 @@ 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>;
+    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>;
 }
@@ -661,16 +655,6 @@ 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;