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

package/dist/JsonTransformer.js

@@ -0,0 +1,225 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BuilderFunctionParameters = exports.buildersToCompiledAspects = void 0;
+const createServiceError_1 = __importDefault(require("./createServiceError"));
+/**
+ * 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.
+ */
+class JsonTransformer {
+    constructor({ sourceId, libraries = {}, datasetAspectBuilders = [], distributionAspectBuilders = [], organizationAspectBuilders = [] }) {
+        this.sourceId = sourceId;
+        this.datasetAspectBuilders = datasetAspectBuilders.slice();
+        this.distributionAspectBuilders = distributionAspectBuilders.slice();
+        this.organizationAspectBuilders = organizationAspectBuilders.slice();
+        const setupParameters = {
+            transformer: this,
+            libraries
+        };
+        const datasetParameters = new DatasetBuilderFunctionParameters();
+        datasetParameters.libraries = libraries;
+        datasetParameters.transformer = this;
+        const distributionParameters = new DistributionBuilderFunctionParameters();
+        distributionParameters.libraries = libraries;
+        distributionParameters.transformer = this;
+        const organizationParameters = new OrganizationBuilderFunctionParameters();
+        organizationParameters.libraries = libraries;
+        organizationParameters.transformer = this;
+        this.datasetAspects = buildersToCompiledAspects(datasetAspectBuilders, setupParameters, datasetParameters);
+        this.distributionAspects = buildersToCompiledAspects(distributionAspectBuilders, setupParameters, distributionParameters);
+        this.organizationAspects = buildersToCompiledAspects(organizationAspectBuilders, setupParameters, organizationParameters);
+    }
+    /**
+     * 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) {
+        this.organizationAspects.parameters.organization = jsonOrganization;
+        const id = this.getIdFromJsonOrganization(jsonOrganization, this.sourceId);
+        const name = this.getNameFromJsonOrganization(jsonOrganization);
+        const theRecord = this.jsonToRecord(id, name, jsonOrganization, this.organizationAspects);
+        return this.reviseOrganizationRecord(theRecord);
+    }
+    datasetJsonToRecord(jsonDataset) {
+        this.datasetAspects.parameters.dataset = jsonDataset;
+        const id = this.getIdFromJsonDataset(jsonDataset, this.sourceId);
+        const name = this.getNameFromJsonDataset(jsonDataset);
+        return this.jsonToRecord(id, name, jsonDataset, this.datasetAspects);
+    }
+    distributionJsonToRecord(jsonDistribution, jsonDataset) {
+        this.distributionAspects.parameters.dataset = jsonDataset;
+        this.distributionAspects.parameters.distribution = jsonDistribution;
+        const id = this.getIdFromJsonDistribution(jsonDistribution, jsonDataset, this.sourceId);
+        const name = this.getNameFromJsonDistribution(jsonDistribution, jsonDataset);
+        return this.jsonToRecord(id, name, jsonDistribution, this.distributionAspects);
+    }
+    getRequiredAspectDefinitions() {
+        const allBuilders = this.datasetAspectBuilders
+            .concat(this.distributionAspectBuilders)
+            .concat(this.organizationAspectBuilders);
+        const builderAspectDefinitions = allBuilders.map((builder) => builder.aspectDefinition);
+        return builderAspectDefinitions.concat([
+            {
+                id: "dataset-distributions",
+                name: "Dataset Distributions",
+                jsonSchema: require("@magda/registry-aspects/dataset-distributions.schema.json")
+            },
+            {
+                id: "source",
+                name: "Source",
+                jsonSchema: require("@magda/registry-aspects/source.schema.json")
+            },
+            {
+                id: "dataset-publisher",
+                name: "Dataset Publisher",
+                jsonSchema: require("@magda/registry-aspects/dataset-publisher.schema.json")
+            }
+        ]);
+    }
+    reviseOrganizationRecord(record) {
+        return record;
+    }
+    jsonToRecord(id, name, json, aspects) {
+        const problems = [];
+        function reportProblem(title, message, additionalInfo) {
+            problems.push({ title, message, additionalInfo });
+        }
+        aspects.parameters.reportProblem = reportProblem;
+        const generatedAspects = {};
+        aspects.aspects.forEach((aspect) => {
+            try {
+                aspects.parameters.setup = aspect.setupResult;
+                const aspectValue = aspect.builderFunction(...aspects.parameterNames.map((parameter) => aspects.parameters[parameter]));
+                if (aspectValue !== undefined) {
+                    generatedAspects[aspect.id] = aspectValue;
+                }
+            }
+            catch (e) {
+                const exception = createServiceError_1.default(e);
+                reportProblem("Exception while creating aspect " + aspect.id, exception.toString());
+            }
+        });
+        if (!generatedAspects["source"]) {
+            generatedAspects["source"] = {};
+        }
+        if (problems.length > 0) {
+            generatedAspects["source"].problems = problems;
+        }
+        else {
+            generatedAspects["source"].problems = undefined;
+        }
+        return {
+            // If the id is undefined it'll be rejected by the JsonConnector
+            id: id && id.toString(),
+            name: name,
+            aspects: generatedAspects,
+            sourceTag: undefined,
+            tenantId: this.tenantId,
+            authnReadPolicyId: undefined
+        };
+    }
+}
+exports.default = JsonTransformer;
+function buildersToCompiledAspects(builders, setupParameters, buildParameters) {
+    const setupParameterNames = Object.keys(setupParameters);
+    const buildParameterNames = Object.keys(buildParameters);
+    return {
+        parameterNames: buildParameterNames,
+        parameters: buildParameters,
+        aspects: builders.map((builder) => {
+            let setupResult = undefined;
+            if (builder.setupFunctionString) {
+                const setupFunction = new Function(...setupParameterNames, builder.setupFunctionString);
+                const setupParametersUntyped = setupParameters;
+                setupResult = setupFunction.apply(undefined, setupParameterNames.map((name) => setupParametersUntyped[name]));
+            }
+            const builderFunction = new Function(...buildParameterNames, builder.builderFunctionString);
+            return {
+                id: builder.aspectDefinition.id,
+                builderFunction: builderFunction,
+                setupResult: setupResult
+            };
+        })
+    };
+}
+exports.buildersToCompiledAspects = buildersToCompiledAspects;
+class BuilderFunctionParameters {
+    constructor() {
+        /**
+         * The result of invoking the {@link AspectBuilder#setupFunctionString}, or undefined if there is no
+         * {@link AspectBuilder#setupFunctionString} defined for this builder.
+         *
+         * @type {*}
+         * @memberOf BuilderFunctionParameters
+         */
+        this.setup = undefined;
+        /**
+         * Reports a non-fatal problem creating an aspect.
+         *
+         * @type {ReportProblem}
+         * @memberOf BuilderFunctionParameters
+         */
+        this.reportProblem = undefined;
+        /**
+         * Provides access to utility libraries that may be helpful in building aspects.
+         *
+         * @type {BuilderFunctionLibraries}
+         * @memberOf BuilderFunctionParameters
+         */
+        this.libraries = undefined;
+    }
+}
+exports.BuilderFunctionParameters = BuilderFunctionParameters;
+class DatasetBuilderFunctionParameters extends BuilderFunctionParameters {
+    constructor() {
+        super(...arguments);
+        /**
+         * The JSON dataset from which to build aspects.
+         *
+         * @type {object}
+         * @memberOf DatasetBuilderFunctionParameters
+         */
+        this.dataset = undefined;
+    }
+}
+class DistributionBuilderFunctionParameters extends BuilderFunctionParameters {
+    constructor() {
+        super(...arguments);
+        /**
+         * The JSON distribution from which to build aspects.
+         *
+         * @type {object}
+         * @memberOf DistributionBuilderFunctionParameters
+         */
+        this.distribution = undefined;
+        /**
+         * The JSON dataset that owns the distribution.
+         *
+         * @type {object}
+         * @memberOf DatasetBuilderFunctionParameters
+         */
+        this.dataset = undefined;
+    }
+}
+class OrganizationBuilderFunctionParameters extends BuilderFunctionParameters {
+    constructor() {
+        super(...arguments);
+        /**
+         * The JSON organization from which to build aspects.
+         *
+         * @type {object}
+         * @memberOf OrganizationBuilderFunctionParameters
+         */
+        this.organization = undefined;
+    }
+}
+//# sourceMappingURL=JsonTransformer.js.map

package/dist/JsonTransformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JsonTransformer.js","sourceRoot":"","sources":["../src/JsonTransformer.ts"],"names":[],"mappings":";;;;;;AAGA,8EAAsD;AAEtD;;;GAGG;AACH,MAA8B,eAAe;IAUzC,YAAY,EACR,QAAQ,EACR,SAAS,GAAG,EAAE,EACd,qBAAqB,GAAG,EAAE,EAC1B,0BAA0B,GAAG,EAAE,EAC/B,0BAA0B,GAAG,EAAE,EACV;QACrB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC,KAAK,EAAE,CAAC;QAC3D,IAAI,CAAC,0BAA0B,GAAG,0BAA0B,CAAC,KAAK,EAAE,CAAC;QACrE,IAAI,CAAC,0BAA0B,GAAG,0BAA0B,CAAC,KAAK,EAAE,CAAC;QAErE,MAAM,eAAe,GAAmC;YACpD,WAAW,EAAE,IAAI;YACjB,SAAS;SACZ,CAAC;QAEF,MAAM,iBAAiB,GAAG,IAAI,gCAAgC,EAAE,CAAC;QACjE,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC;QACxC,iBAAiB,CAAC,WAAW,GAAG,IAAI,CAAC;QAErC,MAAM,sBAAsB,GAAG,IAAI,qCAAqC,EAAE,CAAC;QAC3E,sBAAsB,CAAC,SAAS,GAAG,SAAS,CAAC;QAC7C,sBAAsB,CAAC,WAAW,GAAG,IAAI,CAAC;QAE1C,MAAM,sBAAsB,GAAG,IAAI,qCAAqC,EAAE,CAAC;QAC3E,sBAAsB,CAAC,SAAS,GAAG,SAAS,CAAC;QAC7C,sBAAsB,CAAC,WAAW,GAAG,IAAI,CAAC;QAE1C,IAAI,CAAC,cAAc,GAAG,yBAAyB,CAC3C,qBAAqB,EACrB,eAAe,EACf,iBAAiB,CACpB,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,yBAAyB,CAChD,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,CACzB,CAAC;QACF,IAAI,CAAC,mBAAmB,GAAG,yBAAyB,CAChD,0BAA0B,EAC1B,eAAe,EACf,sBAAsB,CACzB,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,wBAAwB,CAAC,gBAAwB;QAC7C,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG,gBAAgB,CAAC;QAEpE,MAAM,EAAE,GAAG,IAAI,CAAC,yBAAyB,CACrC,gBAAgB,EAChB,IAAI,CAAC,QAAQ,CAChB,CAAC;QAEF,MAAM,IAAI,GAAG,IAAI,CAAC,2BAA2B,CAAC,gBAAgB,CAAC,CAAC;QAEhE,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAC/B,EAAE,EACF,IAAI,EACJ,gBAAgB,EAChB,IAAI,CAAC,mBAAmB,CAC3B,CAAC;QAEF,OAAO,IAAI,CAAC,wBAAwB,CAAC,SAAS,CAAC,CAAC;IACpD,CAAC;IAED,mBAAmB,CAAC,WAAmB;QACnC,IAAI,CAAC,cAAc,CAAC,UAAU,CAAC,OAAO,GAAG,WAAW,CAAC;QAErD,MAAM,EAAE,GAAG,IAAI,CAAC,oBAAoB,CAAC,WAAW,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjE,MAAM,IAAI,GAAG,IAAI,CAAC,sBAAsB,CAAC,WAAW,CAAC,CAAC;QACtD,OAAO,IAAI,CAAC,YAAY,CAAC,EAAE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IAED,wBAAwB,CACpB,gBAAwB,EACxB,WAAmB;QAEnB,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,OAAO,GAAG,WAAW,CAAC;QAC1D,IAAI,CAAC,mBAAmB,CAAC,UAAU,CAAC,YAAY,GAAG,gBAAgB,CAAC;QAEpE,MAAM,EAAE,GAAG,IAAI,CAAC,yBAAyB,CACrC,gBAAgB,EAChB,WAAW,EACX,IAAI,CAAC,QAAQ,CAChB,CAAC;QACF,MAAM,IAAI,GAAG,IAAI,CAAC,2BAA2B,CACzC,gBAAgB,EAChB,WAAW,CACd,CAAC;QACF,OAAO,IAAI,CAAC,YAAY,CACpB,EAAE,EACF,IAAI,EACJ,gBAAgB,EAChB,IAAI,CAAC,mBAAmB,CAC3B,CAAC;IACN,CAAC;IAED,4BAA4B;QACxB,MAAM,WAAW,GAAG,IAAI,CAAC,qBAAqB;aACzC,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC;aACvC,MAAM,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QAC7C,MAAM,wBAAwB,GAAG,WAAW,CAAC,GAAG,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,gBAAgB,CACxC,CAAC;QACF,OAAO,wBAAwB,CAAC,MAAM,CAAC;YACnC;gBACI,EAAE,EAAE,uBAAuB;gBAC3B,IAAI,EAAE,uBAAuB;gBAC7B,UAAU,EAAE,OAAO,CAAC,2DAA2D,CAAC;aACnF;YACD;gBACI,EAAE,EAAE,QAAQ;gBACZ,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE,OAAO,CAAC,4CAA4C,CAAC;aACpE;YACD;gBACI,EAAE,EAAE,mBAAmB;gBACvB,IAAI,EAAE,mBAAmB;gBACzB,UAAU,EAAE,OAAO,CAAC,uDAAuD,CAAC;aAC/E;SACJ,CAAC,CAAC;IACP,CAAC;IAuBD,wBAAwB,CAAC,MAAc;QACnC,OAAO,MAAM,CAAC;IAClB,CAAC;IAEM,YAAY,CACf,EAAqB,EACrB,IAAY,EACZ,IAAS,EACT,OAAwB;QAExB,MAAM,QAAQ,GAAoB,EAAE,CAAC;QAErC,SAAS,aAAa,CAClB,KAAa,EACb,OAAgB,EAChB,cAAoB;YAEpB,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,OAAO,CAAC,UAAU,CAAC,aAAa,GAAG,aAAa,CAAC;QAEjD,MAAM,gBAAgB,GAAY,EAAE,CAAC;QACrC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YAC/B,IAAI;gBACA,OAAO,CAAC,UAAU,CAAC,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC;gBAC9C,MAAM,WAAW,GAAG,MAAM,CAAC,eAAe,CACtC,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,CACzB,CAAC,SAAS,EAAE,EAAE,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,CAC/C,CACJ,CAAC;gBACF,IAAI,WAAW,KAAK,SAAS,EAAE;oBAC3B,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC;iBAC7C;aACJ;YAAC,OAAO,CAAC,EAAE;gBACR,MAAM,SAAS,GAAG,4BAAkB,CAAC,CAAC,CAAC,CAAC;gBACxC,aAAa,CACT,kCAAkC,GAAG,MAAM,CAAC,EAAE,EAC9C,SAAS,CAAC,QAAQ,EAAE,CACvB,CAAC;aACL;QACL,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,EAAE;YAC7B,gBAAgB,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;SACnC;QAED,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,gBAAgB,CAAC,QAAQ,CAAC,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAClD;aAAM;YACH,gBAAgB,CAAC,QAAQ,CAAC,CAAC,QAAQ,GAAG,SAAS,CAAC;SACnD;QAED,OAAO;YACH,gEAAgE;YAChE,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,QAAQ,EAAE;YACvB,IAAI,EAAE,IAAI;YACV,OAAO,EAAE,gBAAgB;YACzB,SAAS,EAAE,SAAS;YACpB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,iBAAiB,EAAE,SAAS;SAC/B,CAAC;IACN,CAAC;CACJ;AApOD,kCAoOC;AAED,SAAgB,yBAAyB,CACrC,QAAyB,EACzB,eAA+C,EAC/C,eAA0C;IAE1C,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACzD,MAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAEzD,OAAO;QACH,cAAc,EAAE,mBAAmB;QACnC,UAAU,EAAE,eAAe;QAC3B,OAAO,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC9B,IAAI,WAAW,GAAG,SAAS,CAAC;YAC5B,IAAI,OAAO,CAAC,mBAAmB,EAAE;gBAC7B,MAAM,aAAa,GAAG,IAAI,QAAQ,CAC9B,GAAG,mBAAmB,EACtB,OAAO,CAAC,mBAAmB,CAC9B,CAAC;gBACF,MAAM,sBAAsB,GAAQ,eAAe,CAAC;gBACpD,WAAW,GAAG,aAAa,CAAC,KAAK,CAC7B,SAAS,EACT,mBAAmB,CAAC,GAAG,CACnB,CAAC,IAAI,EAAE,EAAE,CAAC,sBAAsB,CAAC,IAAI,CAAC,CACzC,CACJ,CAAC;aACL;YAED,MAAM,eAAe,GAAG,IAAI,QAAQ,CAChC,GAAG,mBAAmB,EACtB,OAAO,CAAC,qBAAqB,CAChC,CAAC;YAEF,OAAO;gBACH,EAAE,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAAE;gBAC/B,eAAe,EAAE,eAAe;gBAChC,WAAW,EAAE,WAAW;aAC3B,CAAC;QACN,CAAC,CAAC;KACL,CAAC;AACN,CAAC;AAvCD,8DAuCC;AAwDD,MAAsB,yBAAyB;IAA/C;QACI;;;;;;WAMG;QACH,UAAK,GAAQ,SAAS,CAAC;QAUvB;;;;;WAKG;QACH,kBAAa,GAAkB,SAAS,CAAC;QAEzC;;;;;WAKG;QACH,cAAS,GAAW,SAAS,CAAC;IAGlC,CAAC;CAAA;AAnCD,8DAmCC;AAED,MAAM,gCAAiC,SAAQ,yBAAyB;IAAxE;;QACI;;;;;WAKG;QACH,YAAO,GAAW,SAAS,CAAC;IAChC,CAAC;CAAA;AAED,MAAM,qCAAsC,SAAQ,yBAAyB;IAA7E;;QACI;;;;;WAKG;QACH,iBAAY,GAAW,SAAS,CAAC;QAEjC;;;;;WAKG;QACH,YAAO,GAAW,SAAS,CAAC;IAChC,CAAC;CAAA;AAED,MAAM,qCAAsC,SAAQ,yBAAyB;IAA7E;;QACI;;;;;WAKG;QACH,iBAAY,GAAW,SAAS,CAAC;IACrC,CAAC;CAAA"}