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

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;