@magda/connector-sdk 2.3.3 → 3.0.0-alpha.0

package/dist/index-web.d.ts

@@ -1,185 +1,7 @@
-/// <reference types="node" />
-
-export declare interface AspectBuilder {
-    aspectDefinition: AspectDefinition;
-    builderFunctionString: string;
-    setupFunctionString?: string;
-}
-
-/**
-* A type of aspect in the registry, unique for a tenant.
-*/
-export declare class AspectDefinition {
-    /**
-    * The identifier for the aspect type.
-    */
-    'id': string;
-    /**
-    * The name of the aspect.
-    */
-    'name': string;
-    /**
-    * The JSON Schema of this aspect.
-    */
-    'jsonSchema': any;
-}
-
-export declare abstract class BuilderFunctionParameters {
-    /**
-     * The result of invoking the {@link AspectBuilder#setupFunctionString}, or undefined if there is no
-     * {@link AspectBuilder#setupFunctionString} defined for this builder.
-     *
-     * @type {*}
-     * @memberOf BuilderFunctionParameters
-     */
-    setup: any;
-    /**
-     * The transformer that is building aspects.
-     *
-     * @type {JsonTransformer}
-     * @memberof BuilderFunctionParameters
-     */
-    transformer: JsonTransformer;
-    /**
-     * Reports a non-fatal problem creating an aspect.
-     *
-     * @type {ReportProblem}
-     * @memberOf BuilderFunctionParameters
-     */
-    reportProblem: ReportProblem;
-    /**
-     * Provides access to utility libraries that may be helpful in building aspects.
-     *
-     * @type {BuilderFunctionLibraries}
-     * @memberOf BuilderFunctionParameters
-     */
-    libraries: object;
-    [propName: string]: any;
-}
-
-export declare interface BuilderSetupFunctionParameters {
-    /**
-     * The transformer that is building aspects.
-     *
-     * @type {JsonTransformer}
-     * @memberof BuilderFunctionParameters
-     */
-    transformer: JsonTransformer;
-    /**
-     * Provides access to utility libraries that may be helpful in setting up the builder.
-     *
-     * @type {BuilderFunctionLibraries}
-     * @memberOf BuilderFunctionParameters
-     */
-    libraries: object;
-}
-
-export declare function buildersToCompiledAspects(builders: AspectBuilder[], setupParameters: BuilderSetupFunctionParameters, buildParameters: BuilderFunctionParameters): CompiledAspects;
-
-export declare function cleanOrgTitle(title: string): string;
-
-declare interface CompiledAspect {
-    id: string;
-    builderFunction: Function;
-    setupResult: any;
-}
-
-export declare interface CompiledAspects {
-    parameterNames: string[];
-    parameters: BuilderFunctionParameters;
-    aspects: CompiledAspect[];
-}
-
-export declare class ConnectorRecordId {
-    readonly id: string;
-    readonly type: RecordType;
-    readonly sourceId: string;
-    constructor(id: string, type: RecordType, sourceId: string);
-    toString(): string;
-    private get typeId();
-}
-
-/**
- * A base class for transformers for most any JSON-based catalog source.
- * A transformer takes source data and transforms it to registry records and aspects.
- */
-export declare abstract class JsonTransformer {
-    readonly sourceId: string;
-    private datasetAspectBuilders;
-    private distributionAspectBuilders;
-    private organizationAspectBuilders;
-    private organizationAspects;
-    private datasetAspects;
-    private distributionAspects;
-    private tenantId;
-    constructor({ sourceId, libraries, datasetAspectBuilders, distributionAspectBuilders, organizationAspectBuilders }: JsonTransformerOptions);
-    /**
-     * Create a {@link Record} from JSON data representing an organization.
-     *
-     * @param {string} id The ID of the record.
-     * @param {string} name The name of the record.
-     * @param {object} jsonOrganization The JSON data representing the organization.
-     * @returns {Record} The record.
-     *
-     * @memberof JsonConnector
-     */
-    organizationJsonToRecord(jsonOrganization: object): Record_2;
-    datasetJsonToRecord(jsonDataset: object): Record_2;
-    distributionJsonToRecord(jsonDistribution: object, jsonDataset: object): Record_2;
-    getRequiredAspectDefinitions(): AspectDefinition[];
-    abstract getIdFromJsonOrganization(jsonOrganization: any, sourceId: string): ConnectorRecordId;
-    abstract getIdFromJsonDataset(jsonDataset: any, sourceId: string): ConnectorRecordId;
-    abstract getIdFromJsonDistribution(jsonDistribution: any, jsonDataset: any, sourceId: string): ConnectorRecordId;
-    abstract getNameFromJsonOrganization(jsonOrganization: any): string;
-    abstract getNameFromJsonDataset(jsonDataset: any): string;
-    abstract getNameFromJsonDistribution(jsonDistribution: any, jsonDataset: any): string;
-    reviseOrganizationRecord(record: Record_2): Record_2;
-    jsonToRecord(id: ConnectorRecordId, name: string, json: any, aspects: CompiledAspects): Record_2;
-}
-
-export declare interface JsonTransformerOptions {
-    sourceId: string;
-    libraries?: object;
-    datasetAspectBuilders?: AspectBuilder[];
-    distributionAspectBuilders?: AspectBuilder[];
-    organizationAspectBuilders?: AspectBuilder[];
-    maxConcurrency?: number;
-    tenantId: number;
-}
-
-/**
-* 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
-    */
-    'id': string;
-    /**
-    * The name of the record
-    */
-    'name': string;
-    /**
-    * 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).
-    */
-    'sourceTag': string;
-    /**
-    * The identifier of a tenant
-    */
-    'tenantId': number;
-}
-export { Record_2 as Record }
-
-declare type RecordType = "Organization" | "Dataset" | "Distribution" | "Group";
-
-declare interface ReportProblem {
-    (title: string, message?: string, additionalInfo?: any): void;
-}
-
-export declare const TenantConsts: any;
-
-export { }
+export { Record, AspectDefinition } from "@magda/typescript-common/dist/generated/registry/api.js";
+export { default as ConnectorRecordId } from "@magda/typescript-common/dist/ConnectorRecordId.js";
+export { default as cleanOrgTitle } from "@magda/typescript-common/dist/util/cleanOrgTitle.js";
+export { default as JsonTransformer, buildersToCompiledAspects, JsonTransformerOptions, CompiledAspects, BuilderSetupFunctionParameters, BuilderFunctionParameters } from "@magda/typescript-common/dist/JsonTransformer.js";
+import AspectBuilder from "@magda/typescript-common/dist/AspectBuilder.js";
+export { AspectBuilder };
+export declare const TenantConsts: any;

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="node" />
-import http = require('http');
+
+import http from 'node:http';
 import { default as URI_2 } from 'urijs';
 
 export declare interface AspectBuilder {
@@ -15,20 +16,20 @@ declare class AspectCreationFailure {
 }
 
 /**
-* 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;
 }
 
@@ -362,26 +363,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> {
@@ -564,7 +565,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>;
@@ -576,9 +577,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>;
@@ -592,7 +595,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> {
@@ -602,7 +605,7 @@ declare interface MaybePatterns<T, U> {
 
 declare enum MaybeType {
     Nothing = 0,
-    Just = 1,
+    Just = 1
 }
 
 declare interface Monad<T> {
@@ -619,11 +622,6 @@ declare class MultipleDeleteResult {
 declare class Operation {
 }
 
-declare interface OptionalMaybePatterns<T, U> {
-    just?: (t: T) => U;
-    nothing?: () => U;
-}
-
 declare class PatchRecordsRequest {
     'recordIds': Array<string>;
     'jsonPath': JsonPatch;
@@ -635,28 +633,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 }
@@ -1018,24 +1016,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;
 }
 
@@ -1117,30 +1115,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;
 }