@magda/minion-sdk 2.3.3 → 3.0.0-alpha.1

package/dist/index.d.ts

@@ -1,34 +1,30 @@
-/// <reference types="node" />
 import express from 'express';
-import http = require('http');
 import { default as URI_2 } from 'urijs';
 import yargs from 'yargs';
 
 /**
-* A type of aspect in the registry, unique for a tenant.
-*/
+ * A type of aspect in the registry, unique for a tenant.
+ */
 export declare class AspectDefinition {
     /**
-    * The identifier for the aspect type.
-    */
+     * The identifier for the aspect type.
+     */
     'id': string;
     /**
-    * The name of the aspect.
-    */
+     * The name of the aspect.
+     */
     'name': string;
     /**
-    * The JSON Schema of this aspect.
-    */
+     * The JSON Schema of this aspect.
+     */
     'jsonSchema': any;
 }
 
 declare class AspectDefinitionsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: AspectDefinitionsApiApiKeys, value: string): void;
     /**
      * Create a new aspect
@@ -38,7 +34,7 @@ declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     create(xMagdaTenantId: number, aspect: AspectDefinition, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -48,7 +44,7 @@ declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAll(xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<AspectDefinition>;
     }>;
     /**
@@ -59,7 +55,7 @@ declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(xMagdaTenantId: number, id: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -71,7 +67,7 @@ declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchById(xMagdaTenantId: number, id: string, aspectPatch: Array<Operation>, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
     /**
@@ -83,7 +79,7 @@ declare class AspectDefinitionsApi {
      * @param xMagdaSession Magda internal session id
      */
     putById(xMagdaTenantId: number, id: string, aspect: AspectDefinition, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: AspectDefinition;
     }>;
 }
@@ -122,13 +118,13 @@ export declare interface AuthorizedRegistryOptions extends RegistryOptions {
 }
 
 /**
-                                                 * Builds an argv object that will accept command line arguments used by all common argv minions.
-                                                 *
-                                                 * @param id
-                                                 * @param defaultPort
-                                                 * @param defaultInternalUrl
-                                                 * @param additions
-                                                 */
+ * Builds an argv object that will accept command line arguments used by all common argv minions.
+ *
+ * @param id
+ * @param defaultPort
+ * @param defaultInternalUrl
+ * @param additions
+ */
 export declare function commonYargs<T extends MinionArguments = MinionArguments>(defaultPort: number, defaultInternalUrl: string, additions?: (a: yargs.Argv<MinionArguments>) => yargs.Argv<T>): T;
 
 declare class CountResponse {
@@ -150,26 +146,26 @@ declare interface Eq<T> {
 }
 
 /**
-* A page of events.
-*/
+ * A page of events.
+ */
 declare class EventsPage {
     /**
-    * Whether there are more events available.
-    */
+     * Whether there are more events available.
+     */
     'hasMore': boolean;
     /**
-    * A token to be used to get the next page of events.
-    */
+     * A token to be used to get the next page of events.
+     */
     'nextPageToken': string;
     /**
-    * The events in this page.
-    */
+     * The events in this page.
+     */
     'events': Array<RegistryEvent>;
 }
 
 /**
-* The type of a registry modification event.
-*/
+ * The type of a registry modification event.
+ */
 declare type EventType = 'CreateRecord' | 'CreateAspectDefinition' | 'CreateRecordAspect' | 'PatchRecord' | 'PatchAspectDefinition' | 'PatchRecordAspect' | 'DeleteRecord' | 'DeleteAspectDefinition' | 'DeleteRecordAspect';
 
 declare interface Functor<T> {
@@ -193,7 +189,7 @@ declare class JsValue {
 
 declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     private type;
-    private value;
+    private value?;
     constructor(type: MaybeType, value?: T);
     static sequence<T>(t: {
         [k: string]: Maybe<T>;
@@ -205,9 +201,11 @@ declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     }) => Maybe<{
         [k: string]: any;
     }>;
-    static maybe<T>(t: T): Maybe<T>;
+    static maybe<T>(t?: T | null): Maybe<T>;
     static just<T>(t: T): Maybe<T>;
     static nothing<T>(): Maybe<T>;
+    static isJust<T>(t: Maybe<T>): boolean;
+    static isNothing<T>(t: Maybe<T>): boolean;
     unit<U>(u: U): Maybe<U>;
     bind<U>(f: (t: T) => Maybe<U>): Maybe<U>;
     of: <U>(u: U) => Maybe<U>;
@@ -221,7 +219,7 @@ declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
     valueOr<U extends T>(defaultValue: U): T | U;
     valueOrCompute<U extends T>(defaultValueFunction: () => U): T | U;
     valueOrThrow(error?: Error): T;
-    do(patterns?: OptionalMaybePatterns<T, void>): Maybe<T>;
+    do(patterns?: Partial<MaybePatterns<T, void>>): Maybe<T>;
 }
 
 declare interface MaybePatterns<T, U> {
@@ -231,39 +229,41 @@ declare interface MaybePatterns<T, U> {
 
 declare enum MaybeType {
     Nothing = 0,
-    Just = 1,
+    Just = 1
 }
 
 declare function minion(options: MinionOptions): Promise<void>;
 export default minion;
 
 export declare type MinionArguments = {
-  listenPort: string | number;
-  internalUrl: string;
-  jwtSecret: string;
-  userId: string;
-  registryUrl: string;
-  enableMultiTenant: boolean;
-  tenantUrl: string;
-  retries: string | number;
-  crawlerRecordFetchNumber?: string | number;};
+    listenPort: string | number;
+    internalUrl: string;
+    jwtSecret: string;
+    userId: string;
+    registryUrl: string;
+    enableMultiTenant: boolean;
+    tenantUrl: string;
+    retries: string | number;
+    crawlerRecordFetchNumber?: string | number;
+};
 
 export declare interface MinionOptions {
-  argv: MinionArguments;
-  id: string;
-  aspects: string[];
-  optionalAspects: string[];
-  writeAspectDefs: AspectDefinition[];
-  async?: boolean;
-  onRecordFound: onRecordFoundType;
-  express?: () => express.Express;
-  maxRetries?: number;
-  concurrency?: number;
-  crawlerRecordFetchNumber?: number;
-  includeEvents?: boolean;
-  includeRecords?: boolean;
-  includeAspectDefinitions?: boolean;
-  dereference?: boolean;}
+    argv: MinionArguments;
+    id: string;
+    aspects: string[];
+    optionalAspects: string[];
+    writeAspectDefs: AspectDefinition[];
+    async?: boolean;
+    onRecordFound: onRecordFoundType;
+    express?: () => express.Express;
+    maxRetries?: number;
+    concurrency?: number;
+    crawlerRecordFetchNumber?: number;
+    includeEvents?: boolean;
+    includeRecords?: boolean;
+    includeAspectDefinitions?: boolean;
+    dereference?: boolean;
+}
 
 declare interface Monad<T> {
     unit<U>(t: U): Monad<U>;
@@ -281,11 +281,6 @@ export declare type onRecordFoundType = (record: Record_2, registry: AuthorizedR
 declare class Operation {
 }
 
-declare interface OptionalMaybePatterns<T, U> {
-    just?: (t: T) => U;
-    nothing?: () => U;
-}
-
 declare class PatchRecordsRequest {
     'recordIds': Array<string>;
     'jsonPath': JsonPatch;
@@ -297,28 +292,28 @@ declare class PutRecordsAspectRequest {
 }
 
 /**
-* A record in the registry, usually including data for one or more aspects, unique for a tenant.
-*/
+ * A record in the registry, usually including data for one or more aspects, unique for a tenant.
+ */
 declare class Record_2 {
     /**
-    * The identifier of the record
-    */
+     * The identifier of the record
+     */
     'id': string;
     /**
-    * The name of the record
-    */
+     * The name of the record
+     */
     'name': string;
     /**
-    * The aspects included in this record
-    */
+     * The aspects included in this record
+     */
     'aspects': any;
     /**
-    * A tag representing the action by the source of this record (e.g. an id for a individual crawl of a data portal).
-    */
+     * 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;
     /**
-    * The identifier of a tenant
-    */
+     * The identifier of a tenant
+     */
     'tenantId': number;
 }
 export { Record_2 as Record }
@@ -326,10 +321,8 @@ export { Record_2 as Record }
 declare class RecordAspectsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordAspectsApiApiKeys, value: string): void;
     /**
      * Delete a record aspect by ID
@@ -340,7 +333,7 @@ declare class RecordAspectsApi {
      * @param xMagdaTenantId 0
      */
     deleteById(recordId: string, aspectId: string, xMagdaSession: string, xMagdaTenantId: number): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -355,7 +348,7 @@ declare class RecordAspectsApi {
      * @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;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -367,7 +360,7 @@ declare class RecordAspectsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAspectsCount(xMagdaTenantId: number, recordId: string, keyword?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: CountResponse;
     }>;
     /**
@@ -379,7 +372,7 @@ declare class RecordAspectsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(xMagdaTenantId: number, recordId: string, aspectId: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
     /**
@@ -392,7 +385,7 @@ declare class RecordAspectsApi {
      * @param xMagdaTenantId 0
      */
     patchById(recordId: string, aspectId: string, aspectPatch: Array<Operation>, xMagdaSession: string, xMagdaTenantId: number): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
     /**
@@ -406,7 +399,7 @@ declare class RecordAspectsApi {
      * @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, merge?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: any;
     }>;
 }
@@ -417,10 +410,8 @@ declare enum RecordAspectsApiApiKeys {
 declare class RecordHistoryApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordHistoryApiApiKeys, value: string): void;
     /**
      * Get a list of all events affecting this record
@@ -436,7 +427,7 @@ declare class RecordHistoryApi {
      * @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.
      */
     history(xMagdaTenantId: number, recordId: string, xMagdaSession: string, pageToken?: string, start?: number, limit?: number, aspect?: Array<string>, dereference?: boolean, reversePageTokenOrder?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: EventsPage;
     }>;
     /**
@@ -447,7 +438,7 @@ declare class RecordHistoryApi {
      * @param eventId The ID of the last event to be applied to the record.  The event with this ID need not actually apply to the record, in which case that last event prior to this even that does apply will be used.
      */
     version(xMagdaTenantId: number, recordId: string, eventId: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
 }
@@ -458,10 +449,8 @@ declare enum RecordHistoryApiApiKeys {
 declare class RecordsApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: RecordsApiApiKeys, value: string): void;
     /**
      * Create a new record
@@ -471,7 +460,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     create(xMagdaTenantId: number, record: Record_2, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
     /**
@@ -482,7 +471,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteById(xMagdaTenantId: number, recordId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -494,7 +483,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteRecordsAspectArrayItems(xMagdaTenantId: number, aspectId: string, requestData: DeleteRecordsAspectArrayItemsRequest, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -517,7 +506,7 @@ declare class RecordsApi {
      * @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, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<Record_2>;
     }>;
     /**
@@ -532,7 +521,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<RecordSummary>;
     }>;
     /**
@@ -546,7 +535,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(id: string, xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
     /**
@@ -557,7 +546,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
     /**
@@ -568,7 +557,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getByIdSummary(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: RecordSummary;
     }>;
     /**
@@ -582,7 +571,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getCount(xMagdaTenantId: number, aspect?: Array<string>, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, q?: string, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: CountResponse;
     }>;
     /**
@@ -594,7 +583,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     getPageTokens(xMagdaTenantId: number, aspect?: Array<string>, limit?: number, xMagdaSession?: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<string>;
     }>;
     /**
@@ -606,7 +595,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchById(xMagdaTenantId: number, id: string, recordPatch: Array<Operation>, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
     /**
@@ -617,7 +606,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     patchRecords(xMagdaTenantId: number, requestData: PatchRecordsRequest, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -630,7 +619,7 @@ declare class RecordsApi {
      * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
      */
     putById(xMagdaTenantId: number, id: string, record: Record_2, xMagdaSession: string, merge?: boolean): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Record_2;
     }>;
     /**
@@ -643,7 +632,7 @@ declare class RecordsApi {
      * @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;
+        response: Response;
         body: Array<any>;
     }>;
     /**
@@ -655,7 +644,7 @@ declare class RecordsApi {
      * @param xMagdaSession Magda internal session id
      */
     trimBySourceTag(xMagdaTenantId: number, sourceTagToPreserve: string, sourceId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: MultipleDeleteResult;
     }>;
 }
@@ -671,24 +660,24 @@ declare interface RecordsPage<I extends Record_2> {
 }
 
 /**
-* A summary of a record in the registry.  Summaries specify which aspects are available, but do not include data for any aspects.
-*/
+ * A summary of a record in the registry.  Summaries specify which aspects are available, but do not include data for any aspects.
+ */
 declare class RecordSummary {
     /**
-    * The identifier of the record
-    */
+     * The identifier of the record
+     */
     'id': string;
     /**
-    * The name of the record
-    */
+     * The name of the record
+     */
     'name': string;
     /**
-    * The list of aspect IDs for which this record has data
-    */
+     * The list of aspect IDs for which this record has data
+     */
     'aspects': Array<string>;
     /**
-    * The identifier of the tenant
-    */
+     * The identifier of the tenant
+     */
     'tenantId': number;
 }
 
@@ -762,30 +751,30 @@ declare class WebHook {
 }
 
 /**
-* Asynchronously acknowledges receipt of a web hook notification.
-*/
+ * Asynchronously acknowledges receipt of a web hook notification.
+ */
 declare class WebHookAcknowledgement {
     /**
-    * True if the web hook was received successfully and the listener is ready for further notifications.  False if the web hook was not received and the same notification should be repeated.
-    */
+     * True if the web hook was received successfully and the listener is ready for further notifications.  False if the web hook was not received and the same notification should be repeated.
+     */
     'succeeded': boolean;
     /**
-    * The ID of the last event received by the listener.  This should be the value of the `lastEventId` property of the web hook payload that is being acknowledged.  This value is ignored if `succeeded` is false.
-    */
+     * The ID of the last event received by the listener.  This should be the value of the `lastEventId` property of the web hook payload that is being acknowledged.  This value is ignored if `succeeded` is false.
+     */
     'lastEventIdReceived': any;
     /**
-    * Should the webhook be active or inactive?
-    */
+     * Should the webhook be active or inactive?
+     */
     'active': any;
 }
 
 /**
-* The response to an asynchronous web hook acknowledgement.
-*/
+ * The response to an asynchronous web hook acknowledgement.
+ */
 declare class WebHookAcknowledgementResponse {
     /**
-    * The ID of the last event successfully received by the listener.  Further notifications will start after this event.
-    */
+     * The ID of the last event successfully received by the listener.  Further notifications will start after this event.
+     */
     'lastEventIdReceived': number;
 }
 
@@ -801,10 +790,8 @@ declare class WebHookConfig {
 declare class WebHooksApi {
     protected basePath: string;
     protected defaultHeaders: any;
-    protected _useQuerystring: boolean;
     protected authentications: any;
     constructor(basePath?: string);
-    set useQuerystring(value: boolean);
     setApiKey(key: WebHooksApiApiKeys, value: string): void;
     /**
      * Acknowledge a previously-deferred web hook
@@ -814,7 +801,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     ack(id: string, acknowledgement: WebHookAcknowledgement, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHookAcknowledgementResponse;
     }>;
     /**
@@ -824,7 +811,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     create(hook: WebHook, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
     /**
@@ -834,7 +821,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     deleteById(hookId: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: DeleteResult;
     }>;
     /**
@@ -843,7 +830,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     getAll(xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: Array<WebHook>;
     }>;
     /**
@@ -853,7 +840,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     getById(id: string, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
     /**
@@ -864,7 +851,7 @@ declare class WebHooksApi {
      * @param xMagdaSession Magda internal session id
      */
     putById(id: string, hook: WebHook, xMagdaSession: string): Promise<{
-        response: http.IncomingMessage;
+        response: Response;
         body: WebHook;
     }>;
 }