@magda/typescript-common 1.1.0-alpha.2 → 1.1.0-alpha.3

package/dist/JsonConnector.js

@@ -0,0 +1,427 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const AspectCreationFailure_1 = __importDefault(require("./AspectCreationFailure"));
+const AsyncPage_1 = __importStar(require("./AsyncPage"));
+const ConnectorRecordId_1 = __importDefault(require("./ConnectorRecordId"));
+const ConnectionResult_1 = __importDefault(require("./ConnectionResult"));
+const RecordCreationFailure_1 = __importDefault(require("./RecordCreationFailure"));
+const unionToThrowable_1 = __importDefault(require("./util/unionToThrowable"));
+const yargs_1 = require("yargs");
+const express_1 = __importDefault(require("express"));
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const process_1 = __importDefault(require("process"));
+const uuid_1 = require("uuid");
+const lodash_1 = __importDefault(require("lodash"));
+/**
+ * A base class for connectors for most any JSON-based catalog source.
+ */
+class JsonConnector {
+    constructor({ source, transformer, registry, maxConcurrency = 1, sourceTag = uuid_1.v4() }) {
+        this.source = source;
+        this.transformer = transformer;
+        this.registry = registry;
+        this.maxConcurrency = maxConcurrency;
+        this.sourceTag = sourceTag;
+        this.configData = this.readConfigData();
+    }
+    readConfigData() {
+        try {
+            const argv = yargs_1.parse(process_1.default.argv);
+            if (!argv) {
+                throw new Error("failed to parse commandline parameter!");
+            }
+            let configData;
+            if (!argv.config) {
+                if (!argv.id) {
+                    configData = {
+                        id: this.source.id,
+                        name: this.source.name
+                    };
+                    if (this.source.extras) {
+                        configData.extras = this.source.extras;
+                    }
+                    if (this.source.presetRecordAspects) {
+                        configData.presetRecordAspects = this.source.presetRecordAspects;
+                    }
+                }
+                else {
+                    configData = {
+                        id: argv.id,
+                        name: argv.name
+                    };
+                    if (argv.extras) {
+                        configData.extras = argv.extras;
+                    }
+                    if (argv.presetRecordAspects) {
+                        configData.presetRecordAspects = argv.presetRecordAspects;
+                    }
+                }
+            }
+            else {
+                configData = JSON.parse(fs_1.default.readFileSync(argv.config, {
+                    encoding: "utf-8"
+                }));
+            }
+            if (!configData) {
+                throw new Error("invalid empty config data.");
+            }
+            if (!configData.id) {
+                throw new Error("invalid config data, missing compulsory `id`.");
+            }
+            if (!configData.name) {
+                throw new Error("invalid config data, missing compulsory `name`.");
+            }
+            if (configData.presetRecordAspects &&
+                !configData.presetRecordAspects.length) {
+                console.log("Warning: `presetRecordAspects` exists but is not an array. It will not be used.");
+            }
+            return configData;
+        }
+        catch (e) {
+            throw new Error(`Can't read connector config data: ${e}`);
+        }
+    }
+    createAspectDefinitions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = new ConnectionResult_1.default();
+            const allAspectDefinitions = this.transformer.getRequiredAspectDefinitions();
+            const aspectBuilderPage = AsyncPage_1.default.single(allAspectDefinitions);
+            yield AsyncPage_1.forEachAsync(aspectBuilderPage, this.maxConcurrency, (aspectDefinition) => __awaiter(this, void 0, void 0, function* () {
+                const aspectDefinitionOrError = yield this.registry.putAspectDefinition(aspectDefinition);
+                if (aspectDefinitionOrError instanceof Error) {
+                    result.aspectDefinitionFailures.push(new AspectCreationFailure_1.default(aspectDefinition.id, aspectDefinitionOrError));
+                }
+                else {
+                    ++result.aspectDefinitionsConnected;
+                }
+            }));
+            return result;
+        });
+    }
+    createOrganization(organizationJson) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.putRecord(this.transformer.organizationJsonToRecord(organizationJson), "Organization");
+        });
+    }
+    createDataset(datasetJson) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.putRecord(this.transformer.datasetJsonToRecord(datasetJson), "Dataset");
+        });
+    }
+    createDistribution(distributionJson, datasetJson) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.putRecord(this.transformer.distributionJsonToRecord(distributionJson, datasetJson), "Distribution");
+        });
+    }
+    createOrganizations() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = new ConnectionResult_1.default();
+            if (this.source.hasFirstClassOrganizations) {
+                const organizations = this.source.getJsonFirstClassOrganizations();
+                yield AsyncPage_1.forEachAsync(organizations, this.maxConcurrency, (organization) => __awaiter(this, void 0, void 0, function* () {
+                    if (!organization) {
+                        return;
+                    }
+                    const recordOrError = yield this.createOrganization(organization);
+                    if (recordOrError instanceof Error) {
+                        result.organizationFailures.push(new RecordCreationFailure_1.default(this.transformer.getIdFromJsonOrganization(organization, this.source.id), undefined, recordOrError));
+                    }
+                    else {
+                        ++result.organizationsConnected;
+                    }
+                }));
+            }
+            return result;
+        });
+    }
+    createDatasetsAndDistributions() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const result = new ConnectionResult_1.default();
+            const datasets = this.source.getJsonDatasets();
+            yield AsyncPage_1.forEachAsync(datasets, this.maxConcurrency, (dataset) => __awaiter(this, void 0, void 0, function* () {
+                const record = this.transformer.datasetJsonToRecord(dataset);
+                const distributions = this.source.getJsonDistributions(dataset);
+                if (distributions) {
+                    const distributionIds = [];
+                    yield AsyncPage_1.forEachAsync(distributions, 1, (distribution) => __awaiter(this, void 0, void 0, function* () {
+                        const recordOrError = yield this.createDistribution(distribution, dataset);
+                        if (recordOrError instanceof Error) {
+                            result.distributionFailures.push(new RecordCreationFailure_1.default(this.transformer.getIdFromJsonDistribution(distribution, dataset, this.source.id), this.transformer.getIdFromJsonDataset(dataset, this.source.id), recordOrError));
+                        }
+                        else {
+                            ++result.distributionsConnected;
+                            distributionIds.push(this.transformer.getIdFromJsonDistribution(distribution, dataset, this.source.id));
+                        }
+                    }));
+                    record.aspects["dataset-distributions"] = {
+                        distributions: distributionIds.map((id) => id.toString())
+                    };
+                }
+                if (this.source.hasFirstClassOrganizations) {
+                    const publisher = this.source.getJsonDatasetPublisherId(dataset);
+                    if (publisher) {
+                        record.aspects["dataset-publisher"] = {
+                            publisher: new ConnectorRecordId_1.default(publisher, "Organization", this.source.id).toString()
+                        };
+                    }
+                }
+                else {
+                    const publisher = yield this.source.getJsonDatasetPublisher(dataset);
+                    if (publisher) {
+                        const publisherId = this.transformer.getIdFromJsonOrganization(publisher, this.source.id);
+                        if (publisherId) {
+                            const recordOrError = yield this.createOrganization(publisher);
+                            if (recordOrError instanceof Error) {
+                                result.organizationFailures.push(new RecordCreationFailure_1.default(publisherId, undefined, recordOrError));
+                            }
+                            else {
+                                record.aspects["dataset-publisher"] = {
+                                    publisher: publisherId.toString()
+                                };
+                                ++result.organizationsConnected;
+                            }
+                        }
+                    }
+                }
+                const recordOrError = yield this.putRecord(record, "Dataset");
+                if (recordOrError instanceof Error) {
+                    result.datasetFailures.push(new RecordCreationFailure_1.default(this.transformer.getIdFromJsonDataset(dataset, this.source.id), undefined, recordOrError));
+                }
+                else {
+                    ++result.datasetsConnected;
+                }
+            }));
+            return result;
+        });
+    }
+    trimRecords() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.registry
+                .deleteBySource(this.sourceTag, this.source.id)
+                .then(unionToThrowable_1.default)
+                .then((deletionResult) => {
+                const result = new ConnectionResult_1.default();
+                if (deletionResult !== undefined &&
+                    deletionResult !== "Processing") {
+                    result.recordsTrimmed = deletionResult.count;
+                }
+                else {
+                    result.trimStillProcessing = true;
+                }
+                return result;
+            });
+        });
+    }
+    /**
+     * Runs the connector, creating aspect definitions, organizations, datasets, and distributions in the
+     * registry as necessary.
+     *
+     * @returns {Promise<ConnectionResult>}
+     * @memberof JsonConnector
+     */
+    run() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const aspectResult = yield this.createAspectDefinitions();
+            const organizationResult = yield this.createOrganizations();
+            const datasetAndDistributionResult = yield this.createDatasetsAndDistributions();
+            const recordsTrimmedResult = yield this.trimRecords();
+            return ConnectionResult_1.default.combine(aspectResult, organizationResult, datasetAndDistributionResult, recordsTrimmedResult);
+        });
+    }
+    runInteractive(options) {
+        const transformerForBrowserPath = path_1.default.resolve(process_1.default.cwd(), "dist", "createTransformerForBrowser.js");
+        if (!fs_1.default.existsSync(transformerForBrowserPath)) {
+            throw new Error("Cannot run this connector in interactive mode because dist/createTransformerForBrowser.js does not exist.");
+        }
+        var app = express_1.default();
+        app.use(require("body-parser").json());
+        if (options.timeoutSeconds > 0) {
+            this.shutdownOnIdle(app, options.timeoutSeconds);
+        }
+        app.get("/v0/status", (req, res) => {
+            res.send("OK");
+        });
+        app.get("/v0/config", (req, res) => {
+            res.send(options.transformerOptions);
+        });
+        app.get("/v0/datasets/:id", (req, res) => {
+            this.source.getJsonDataset(req.params.id).then(function (dataset) {
+                res.send(dataset);
+            });
+        });
+        app.get("/v0/datasets/:id/distributions", (req, res) => {
+            this.source.getJsonDataset(req.params.id).then((dataset) => {
+                return AsyncPage_1.asyncPageToArray(this.source.getJsonDistributions(dataset)).then((distributions) => {
+                    res.send(distributions);
+                });
+            });
+        });
+        app.get("/v0/datasets/:id/publisher", (req, res) => {
+            this.source.getJsonDataset(req.params.id).then((dataset) => {
+                return this.source
+                    .getJsonDatasetPublisher(dataset)
+                    .then((publisher) => {
+                    res.send(publisher);
+                });
+            });
+        });
+        app.get("/v0/search/datasets", (req, res) => {
+            AsyncPage_1.asyncPageToArray(this.source.searchDatasetsByTitle(req.query.title, 10)).then((datasets) => {
+                res.send(datasets);
+            });
+        });
+        if (this.source.hasFirstClassOrganizations) {
+            app.get("/v0/organizations/:id", (req, res) => {
+                this.source
+                    .getJsonFirstClassOrganization(req.params.id)
+                    .then(function (organization) {
+                    res.send(organization);
+                });
+            });
+            app.get("/v0/search/organizations", (req, res) => {
+                AsyncPage_1.asyncPageToArray(this.source.searchFirstClassOrganizationsByTitle(req.query.title, 5)).then((organizations) => {
+                    res.send(organizations);
+                });
+            });
+        }
+        app.get("/v0/test-harness.js", function (req, res) {
+            res.sendFile(transformerForBrowserPath);
+        });
+        app.listen(options.listenPort);
+        console.log(`Listening on port ${options.listenPort}.`);
+    }
+    shutdownOnIdle(express, timeoutSeconds) {
+        // Arrange to shut down the Express server after the idle timeout expires.
+        let timeoutId;
+        function resetTimeout() {
+            if (timeoutId !== undefined) {
+                clearTimeout(timeoutId);
+            }
+            timeoutId = setTimeout(function () {
+                console.log("Shutting down due to idle timeout.");
+                // TODO: Should just shut down the HTTP server instead of the whole process.
+                process_1.default.exit(0);
+            }, timeoutSeconds * 1000);
+        }
+        express.use(function (req, res, next) {
+            resetTimeout();
+            next();
+        });
+        resetTimeout();
+    }
+    putRecord(record, recordType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!record.id) {
+                const noIdMessage = `Tried to put record with no id: ${JSON.stringify(record)}`;
+                console.error(noIdMessage);
+                return Promise.resolve(new Error(noIdMessage));
+            }
+            return this.registry.putRecord(Object.assign(Object.assign({}, this.attachConnectorDataToSource(this.attachConnectorPresetAspects(record, recordType))), { sourceTag: this.sourceTag }));
+        });
+    }
+    /**
+     * Copy `extras` from connector config data to
+     * records `source` aspect
+     */
+    attachConnectorDataToSource(record) {
+        if (!record ||
+            !record.aspects ||
+            !record.aspects.source ||
+            !this.configData.extras) {
+            return record;
+        }
+        const deepDataCopy = lodash_1.default.merge({}, this.configData.extras);
+        record.aspects.source["extras"] = deepDataCopy;
+        return record;
+    }
+    attachConnectorPresetAspects(record, recordType) {
+        if (!this.configData.presetRecordAspects ||
+            !this.configData.presetRecordAspects.length) {
+            // --- no `presetRecordAspects` config, do nothing
+            return record;
+        }
+        const presetRecordAspects = this.configData.presetRecordAspects.filter((presetAspect) => {
+            if (!presetAspect.recordType) {
+                // --- if not specified, apply to all records
+                return true;
+            }
+            return (presetAspect.recordType.toUpperCase() ===
+                recordType.toUpperCase());
+        });
+        if (!presetRecordAspects.length) {
+            return record;
+        }
+        if (!record.aspects) {
+            record.aspects = {};
+        }
+        presetRecordAspects.forEach((presetRecordAspect) => {
+            if (typeof presetRecordAspect !== "object") {
+                return;
+            }
+            const { id, data } = presetRecordAspect;
+            if (!id || !data) {
+                return;
+            }
+            const opType = String(presetRecordAspect.opType).toUpperCase();
+            //--- avoid deep merge from altering data later
+            const deepDataCopy = lodash_1.default.merge({}, data);
+            if (!record.aspects[id]) {
+                record.aspects[id] = deepDataCopy;
+                return;
+            }
+            if (opType === "FILL") {
+                return;
+            }
+            else if (opType === "REPLACE") {
+                record.aspects[id] = deepDataCopy;
+                return;
+            }
+            else if (opType === "MERGE_RIGHT") {
+                record.aspects[id] = lodash_1.default.merge(record.aspects[id], deepDataCopy);
+                return;
+            }
+            else {
+                // --- MERGE_LEFT should be default operation
+                record.aspects[id] = lodash_1.default.mergeWith(deepDataCopy, record.aspects[id], 
+                // --- if target property is null, it should be overwritten as well
+                (a, b) => (b === null ? a : undefined));
+                return;
+            }
+        });
+        return record;
+    }
+}
+exports.default = JsonConnector;
+//# sourceMappingURL=JsonConnector.js.map

package/dist/JsonConnector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonConnector.js","sourceRoot":"","sources":["../src/JsonConnector.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,oFAA4D;AAC5D,yDAAwE;AACxE,4EAAoE;AACpE,0EAAkD;AAClD,oFAA4D;AAG5D,+EAAuD;AACvD,iCAA2C;AAE3C,sDAA8B;AAC9B,4CAAoB;AACpB,gDAAwB;AACxB,sDAA8B;AAC9B,+BAAoC;AACpC,oDAAuB;AAEvB;;GAEG;AACH,MAAqB,aAAa;IAQ9B,YAAY,EACR,MAAM,EACN,WAAW,EACX,QAAQ,EACR,cAAc,GAAG,CAAC,EAClB,SAAS,GAAG,SAAM,EAAE,EACD;QACnB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,cAAc,EAAE,CAAC;IAC5C,CAAC;IAED,cAAc;QACV,IAAI;YACA,MAAM,IAAI,GAAG,aAAS,CAAC,iBAAO,CAAC,IAAI,CAAC,CAAC;YACrC,IAAI,CAAC,IAAI,EAAE;gBACP,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAC;aAC7D;YAED,IAAI,UAA+B,CAAC;YAEpC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACd,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;oBACV,UAAU,GAAG;wBACT,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE;wBAClB,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,IAAI;qBACzB,CAAC;oBACF,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE;wBACpB,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;qBAC1C;oBACD,IAAI,IAAI,CAAC,MAAM,CAAC,mBAAmB,EAAE;wBACjC,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,MAAM,CAAC,mBAAmB,CAAC;qBACpE;iBACJ;qBAAM;oBACH,UAAU,GAAG;wBACT,EAAE,EAAE,IAAI,CAAC,EAAY;wBACrB,IAAI,EAAE,IAAI,CAAC,IAAc;qBAC5B,CAAC;oBACF,IAAI,IAAI,CAAC,MAAM,EAAE;wBACb,UAAU,CAAC,MAAM,GAAG,IAAI,CAAC,MAA0C,CAAC;qBACvE;oBACD,IAAI,IAAI,CAAC,mBAAmB,EAAE;wBAC1B,UAAU,CAAC,mBAAmB,GAAG,IAAI,CAAC,mBAAwD,CAAC;qBAClG;iBACJ;aACJ;iBAAM;gBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CACnB,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,MAAgB,EAAE;oBACnC,QAAQ,EAAE,OAAO;iBACpB,CAAC,CACL,CAAC;aACL;YAED,IAAI,CAAC,UAAU,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;aACjD;YAED,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE;gBAChB,MAAM,IAAI,KAAK,CACX,+CAA+C,CAClD,CAAC;aACL;YAED,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE;gBAClB,MAAM,IAAI,KAAK,CACX,iDAAiD,CACpD,CAAC;aACL;YAED,IACI,UAAU,CAAC,mBAAmB;gBAC9B,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,EACxC;gBACE,OAAO,CAAC,GAAG,CACP,iFAAiF,CACpF,CAAC;aACL;YAED,OAAO,UAAU,CAAC;SACrB;QAAC,OAAO,CAAC,EAAE;YACR,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,EAAE,CAAC,CAAC;SAC7D;IACL,CAAC;IAEK,uBAAuB;;YACzB,MAAM,MAAM,GAAG,IAAI,0BAAgB,EAAE,CAAC;YAEtC,MAAM,oBAAoB,GAAG,IAAI,CAAC,WAAW,CAAC,4BAA4B,EAAE,CAAC;YAE7E,MAAM,iBAAiB,GAAG,mBAAS,CAAC,MAAM,CACtC,oBAAoB,CACvB,CAAC;YACF,MAAM,wBAAY,CACd,iBAAiB,EACjB,IAAI,CAAC,cAAc,EACnB,CAAO,gBAAgB,EAAE,EAAE;gBACvB,MAAM,uBAAuB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,mBAAmB,CACnE,gBAAgB,CACnB,CAAC;gBACF,IAAI,uBAAuB,YAAY,KAAK,EAAE;oBAC1C,MAAM,CAAC,wBAAwB,CAAC,IAAI,CAChC,IAAI,+BAAqB,CACrB,gBAAgB,CAAC,EAAE,EACnB,uBAAuB,CAC1B,CACJ,CAAC;iBACL;qBAAM;oBACH,EAAE,MAAM,CAAC,0BAA0B,CAAC;iBACvC;YACL,CAAC,CAAA,CACJ,CAAC;YAEF,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEK,kBAAkB,CACpB,gBAAwB;;YAExB,OAAO,IAAI,CAAC,SAAS,CACjB,IAAI,CAAC,WAAW,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,EAC3D,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,aAAa,CAAC,WAAmB;;YACnC,OAAO,IAAI,CAAC,SAAS,CACjB,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,WAAW,CAAC,EACjD,SAAS,CACZ,CAAC;QACN,CAAC;KAAA;IAEK,kBAAkB,CACpB,gBAAwB,EACxB,WAAmB;;YAEnB,OAAO,IAAI,CAAC,SAAS,CACjB,IAAI,CAAC,WAAW,CAAC,wBAAwB,CACrC,gBAAgB,EAChB,WAAW,CACd,EACD,cAAc,CACjB,CAAC;QACN,CAAC;KAAA;IAEK,mBAAmB;;YACrB,MAAM,MAAM,GAAG,IAAI,0BAAgB,EAAE,CAAC;YAEtC,IAAI,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE;gBACxC,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,8BAA8B,EAAE,CAAC;gBACnE,MAAM,wBAAY,CACd,aAAa,EACb,IAAI,CAAC,cAAc,EACnB,CAAO,YAAY,EAAE,EAAE;oBACnB,IAAI,CAAC,YAAY,EAAE;wBACf,OAAO;qBACV;oBACD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC/C,YAAY,CACf,CAAC;oBACF,IAAI,aAAa,YAAY,KAAK,EAAE;wBAChC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAC5B,IAAI,+BAAqB,CACrB,IAAI,CAAC,WAAW,CAAC,yBAAyB,CACtC,YAAY,EACZ,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,EACD,SAAS,EACT,aAAa,CAChB,CACJ,CAAC;qBACL;yBAAM;wBACH,EAAE,MAAM,CAAC,sBAAsB,CAAC;qBACnC;gBACL,CAAC,CAAA,CACJ,CAAC;aACL;YAED,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEK,8BAA8B;;YAChC,MAAM,MAAM,GAAG,IAAI,0BAAgB,EAAE,CAAC;YAEtC,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC;YAC/C,MAAM,wBAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,cAAc,EAAE,CAAO,OAAO,EAAE,EAAE;gBAChE,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,mBAAmB,CAAC,OAAO,CAAC,CAAC;gBAE7D,MAAM,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAAC;gBAChE,IAAI,aAAa,EAAE;oBACf,MAAM,eAAe,GAAwB,EAAE,CAAC;oBAChD,MAAM,wBAAY,CAAC,aAAa,EAAE,CAAC,EAAE,CAAO,YAAY,EAAE,EAAE;wBACxD,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC/C,YAAY,EACZ,OAAO,CACV,CAAC;wBACF,IAAI,aAAa,YAAY,KAAK,EAAE;4BAChC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAC5B,IAAI,+BAAqB,CACrB,IAAI,CAAC,WAAW,CAAC,yBAAyB,CACtC,YAAY,EACZ,OAAO,EACP,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,EACD,IAAI,CAAC,WAAW,CAAC,oBAAoB,CACjC,OAAO,EACP,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,EACD,aAAa,CAChB,CACJ,CAAC;yBACL;6BAAM;4BACH,EAAE,MAAM,CAAC,sBAAsB,CAAC;4BAChC,eAAe,CAAC,IAAI,CAChB,IAAI,CAAC,WAAW,CAAC,yBAAyB,CACtC,YAAY,EACZ,OAAO,EACP,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,CACJ,CAAC;yBACL;oBACL,CAAC,CAAA,CAAC,CAAC;oBAEH,MAAM,CAAC,OAAO,CAAC,uBAAuB,CAAC,GAAG;wBACtC,aAAa,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC;qBAC5D,CAAC;iBACL;gBAED,IAAI,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE;oBACxC,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,yBAAyB,CACnD,OAAO,CACV,CAAC;oBACF,IAAI,SAAS,EAAE;wBACX,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG;4BAClC,SAAS,EAAE,IAAI,2BAAiB,CAC5B,SAAS,EACT,cAAc,EACd,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,CAAC,QAAQ,EAAE;yBACf,CAAC;qBACL;iBACJ;qBAAM;oBACH,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,uBAAuB,CACvD,OAAO,CACV,CAAC;oBACF,IAAI,SAAS,EAAE;wBACX,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,yBAAyB,CAC1D,SAAS,EACT,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,CAAC;wBAEF,IAAI,WAAW,EAAE;4BACb,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC/C,SAAS,CACZ,CAAC;4BACF,IAAI,aAAa,YAAY,KAAK,EAAE;gCAChC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAC5B,IAAI,+BAAqB,CACrB,WAAW,EACX,SAAS,EACT,aAAa,CAChB,CACJ,CAAC;6BACL;iCAAM;gCACH,MAAM,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG;oCAClC,SAAS,EAAE,WAAW,CAAC,QAAQ,EAAE;iCACpC,CAAC;gCACF,EAAE,MAAM,CAAC,sBAAsB,CAAC;6BACnC;yBACJ;qBACJ;iBACJ;gBAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;gBAC9D,IAAI,aAAa,YAAY,KAAK,EAAE;oBAChC,MAAM,CAAC,eAAe,CAAC,IAAI,CACvB,IAAI,+BAAqB,CACrB,IAAI,CAAC,WAAW,CAAC,oBAAoB,CACjC,OAAO,EACP,IAAI,CAAC,MAAM,CAAC,EAAE,CACjB,EACD,SAAS,EACT,aAAa,CAChB,CACJ,CAAC;iBACL;qBAAM;oBACH,EAAE,MAAM,CAAC,iBAAiB,CAAC;iBAC9B;YACL,CAAC,CAAA,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC;QAClB,CAAC;KAAA;IAEK,WAAW;;YACb,OAAO,IAAI,CAAC,QAAQ;iBACf,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;iBAC9C,IAAI,CAAC,0BAAgB,CAAC;iBACtB,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;gBACrB,MAAM,MAAM,GAAG,IAAI,0BAAgB,EAAE,CAAC;gBAEtC,IACI,cAAc,KAAK,SAAS;oBAC5B,cAAc,KAAK,YAAY,EACjC;oBACE,MAAM,CAAC,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC;iBAChD;qBAAM;oBACH,MAAM,CAAC,mBAAmB,GAAG,IAAI,CAAC;iBACrC;gBAED,OAAO,MAAM,CAAC;YAClB,CAAC,CAAC,CAAC;QACX,CAAC;KAAA;IAED;;;;;;OAMG;IACG,GAAG;;YACL,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAC1D,MAAM,kBAAkB,GAAG,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YAC5D,MAAM,4BAA4B,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC;YACjF,MAAM,oBAAoB,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEtD,OAAO,0BAAgB,CAAC,OAAO,CAC3B,YAAY,EACZ,kBAAkB,EAClB,4BAA4B,EAC5B,oBAAoB,CACvB,CAAC;QACN,CAAC;KAAA;IAED,cAAc,CAAC,OAA2C;QACtD,MAAM,yBAAyB,GAAG,cAAI,CAAC,OAAO,CAC1C,iBAAO,CAAC,GAAG,EAAE,EACb,MAAM,EACN,gCAAgC,CACnC,CAAC;QACF,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,yBAAyB,CAAC,EAAE;YAC3C,MAAM,IAAI,KAAK,CACX,2GAA2G,CAC9G,CAAC;SACL;QAED,IAAI,GAAG,GAAG,iBAAO,EAAE,CAAC;QACpB,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAEvC,IAAI,OAAO,CAAC,cAAc,GAAG,CAAC,EAAE;YAC5B,IAAI,CAAC,cAAc,CAAC,GAAG,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC;SACpD;QAED,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC/B,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC/B,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,kBAAkB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACrC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,UAAU,OAAO;gBAC5D,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACtB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,gCAAgC,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACnD,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvD,OAAO,4BAAgB,CACnB,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,OAAO,CAAC,CAC5C,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;oBACrB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,4BAA4B,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YAC/C,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE;gBACvD,OAAO,IAAI,CAAC,MAAM;qBACb,uBAAuB,CAAC,OAAO,CAAC;qBAChC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;oBAChB,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;YACxC,4BAAgB,CACZ,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,GAAG,CAAC,KAAK,CAAC,KAAe,EAAE,EAAE,CAAC,CACnE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE;gBAChB,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACvB,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;QAEH,IAAI,IAAI,CAAC,MAAM,CAAC,0BAA0B,EAAE;YACxC,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC1C,IAAI,CAAC,MAAM;qBACN,6BAA6B,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;qBAC5C,IAAI,CAAC,UAAU,YAAY;oBACxB,GAAG,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC3B,CAAC,CAAC,CAAC;YACX,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,GAAG,CAAC,0BAA0B,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;gBAC7C,4BAAgB,CACZ,IAAI,CAAC,MAAM,CAAC,oCAAoC,CAC5C,GAAG,CAAC,KAAK,CAAC,KAAe,EACzB,CAAC,CACJ,CACJ,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,EAAE;oBACrB,GAAG,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC5B,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;SACN;QAED,GAAG,CAAC,GAAG,CAAC,qBAAqB,EAAE,UAAU,GAAG,EAAE,GAAG;YAC7C,GAAG,CAAC,QAAQ,CAAC,yBAAyB,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAC/B,OAAO,CAAC,GAAG,CAAC,qBAAqB,OAAO,CAAC,UAAU,GAAG,CAAC,CAAC;IAC5D,CAAC;IAEO,cAAc,CAAC,OAAwB,EAAE,cAAsB;QACnE,0EAA0E;QAC1E,IAAI,SAAuB,CAAC;QAE5B,SAAS,YAAY;YACjB,IAAI,SAAS,KAAK,SAAS,EAAE;gBACzB,YAAY,CAAC,SAAS,CAAC,CAAC;aAC3B;YAED,SAAS,GAAG,UAAU,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,oCAAoC,CAAC,CAAC;gBAElD,4EAA4E;gBAC5E,iBAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,CAAC,EAAE,cAAc,GAAG,IAAI,CAAC,CAAC;QAC9B,CAAC;QAED,OAAO,CAAC,GAAG,CAAC,UAAU,GAAG,EAAE,GAAG,EAAE,IAAI;YAChC,YAAY,EAAE,CAAC;YACf,IAAI,EAAE,CAAC;QACX,CAAC,CAAC,CAAC;QAEH,YAAY,EAAE,CAAC;IACnB,CAAC;IAEY,SAAS,CAClB,MAAc,EACd,UAAsB;;YAEtB,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE;gBACZ,MAAM,WAAW,GAAG,mCAAmC,IAAI,CAAC,SAAS,CACjE,MAAM,CACT,EAAE,CAAC;gBAEJ,OAAO,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;gBAE3B,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC;aAClD;YAED,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,iCACvB,IAAI,CAAC,2BAA2B,CAC/B,IAAI,CAAC,4BAA4B,CAAC,MAAM,EAAE,UAAU,CAAC,CACxD,KACD,SAAS,EAAE,IAAI,CAAC,SAAS,IAC3B,CAAC;QACP,CAAC;KAAA;IAED;;;OAGG;IACK,2BAA2B,CAAC,MAAc;QAC9C,IACI,CAAC,MAAM;YACP,CAAC,MAAM,CAAC,OAAO;YACf,CAAC,MAAM,CAAC,OAAO,CAAC,MAAM;YACtB,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EACzB;YACE,OAAO,MAAM,CAAC;SACjB;QACD,MAAM,YAAY,GAAG,gBAAC,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACzD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,YAAY,CAAC;QAC/C,OAAO,MAAM,CAAC;IAClB,CAAC;IAEO,4BAA4B,CAChC,MAAc,EACd,UAAsB;QAEtB,IACI,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB;YACpC,CAAC,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,EAC7C;YACE,kDAAkD;YAClD,OAAO,MAAM,CAAC;SACjB;QACD,MAAM,mBAAmB,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,MAAM,CAClE,CAAC,YAAY,EAAE,EAAE;YACb,IAAI,CAAC,YAAY,CAAC,UAAU,EAAE;gBAC1B,6CAA6C;gBAC7C,OAAO,IAAI,CAAC;aACf;YACD,OAAO,CACH,YAAY,CAAC,UAAU,CAAC,WAAW,EAAE;gBACrC,UAAU,CAAC,WAAW,EAAE,CAC3B,CAAC;QACN,CAAC,CACJ,CAAC;QAEF,IAAI,CAAC,mBAAmB,CAAC,MAAM,EAAE;YAC7B,OAAO,MAAM,CAAC;SACjB;QAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE;YACjB,MAAM,CAAC,OAAO,GAAG,EAAE,CAAC;SACvB;QACD,mBAAmB,CAAC,OAAO,CAAC,CAAC,kBAAkB,EAAE,EAAE;YAC/C,IAAI,OAAO,kBAAkB,KAAK,QAAQ,EAAE;gBACxC,OAAO;aACV;YAED,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,kBAAkB,CAAC;YACxC,IAAI,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE;gBACd,OAAO;aACV;YAED,MAAM,MAAM,GAAG,MAAM,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC/D,+CAA+C;YAC/C,MAAM,YAAY,GAAG,gBAAC,CAAC,KAAK,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;YAEvC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBACrB,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;gBAClC,OAAO;aACV;YAED,IAAI,MAAM,KAAK,MAAM,EAAE;gBACnB,OAAO;aACV;iBAAM,IAAI,MAAM,KAAK,SAAS,EAAE;gBAC7B,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC;gBAClC,OAAO;aACV;iBAAM,IAAI,MAAM,KAAK,aAAa,EAAE;gBACjC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,gBAAC,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,YAAY,CAAC,CAAC;gBAC/D,OAAO;aACV;iBAAM;gBACH,6CAA6C;gBAC7C,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,gBAAC,CAAC,SAAS,CAC5B,YAAY,EACZ,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAClB,mEAAmE;gBACnE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CACzC,CAAC;gBACF,OAAO;aACV;QACL,CAAC,CAAC,CAAC;QACH,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AA1jBD,gCA0jBC"}

package/dist/JsonTransformer.d.ts

@@ -0,0 +1,112 @@
+import { AspectDefinition, Record } from "./generated/registry/api";
+import AspectBuilder from "./AspectBuilder";
+import ConnectorRecordId from "./ConnectorRecordId";
+/**
+ * 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 default 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;
+    datasetJsonToRecord(jsonDataset: object): Record;
+    distributionJsonToRecord(jsonDistribution: object, jsonDataset: object): Record;
+    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): Record;
+    jsonToRecord(id: ConnectorRecordId, name: string, json: any, aspects: CompiledAspects): Record;
+}
+export declare function buildersToCompiledAspects(builders: AspectBuilder[], setupParameters: BuilderSetupFunctionParameters, buildParameters: BuilderFunctionParameters): CompiledAspects;
+export interface JsonTransformerOptions {
+    sourceId: string;
+    libraries?: object;
+    datasetAspectBuilders?: AspectBuilder[];
+    distributionAspectBuilders?: AspectBuilder[];
+    organizationAspectBuilders?: AspectBuilder[];
+    maxConcurrency?: number;
+    tenantId: number;
+}
+export interface CompiledAspects {
+    parameterNames: string[];
+    parameters: BuilderFunctionParameters;
+    aspects: CompiledAspect[];
+}
+interface CompiledAspect {
+    id: string;
+    builderFunction: Function;
+    setupResult: any;
+}
+interface ReportProblem {
+    (title: string, message?: string, additionalInfo?: any): void;
+}
+export 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 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 {};