@azure/iot-modelsrepository 1.0.0-alpha.20241120.1 → 1.0.0-alpha.20241125.1

package/dist/commonjs/interfaces/getModelsOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getModelsOptions.d.ts","sourceRoot":"","sources":["../../../src/interfaces/getModelsOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE/E;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;CACjD"}

package/dist/commonjs/interfaces/getModelsOptions.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=getModelsOptions.js.map

package/dist/commonjs/interfaces/getModelsOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getModelsOptions.js","sourceRoot":"","sources":["../../../src/interfaces/getModelsOptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationOptions } from \"@azure/core-client\";\nimport type { dependencyResolutionType } from \"../dependencyResolutionType.js\";\n\n/**\n * Options for getting models.\n */\nexport interface GetModelsOptions extends OperationOptions {\n  /**\n   * This is the format of dependency resolution (no dependency resolution, standard dependency\n   * resolution, resolution using the expanded json format) that will be used when retrieving\n   * models. This overwrites the default dependencyResolution settings of the client.\n   */\n  dependencyResolution?: dependencyResolutionType;\n}\n"]}

package/dist/commonjs/interfaces/modelsRepositoryClientOptions.d.ts

@@ -0,0 +1,25 @@
+import type { CommonClientOptions } from "@azure/core-client";
+import type { dependencyResolutionType } from "../dependencyResolutionType.js";
+/**
+ * Options for creating a Pipeline to use with ModelsRepositoryClient.
+ * It serves to configure the client itself, for instance by specifying
+ * the repository location to use on any getModels call.
+ */
+export interface ModelsRepositoryClientOptions extends CommonClientOptions {
+    /**
+     * This is the base location (URI or path) that requests will be made against for this client.
+     */
+    repositoryLocation?: string;
+    /**
+     * Though currently not relevant, can be used in future iterations to specify the API Version
+     * of the service.
+     */
+    apiVersion?: string;
+    /**
+     * This is the format of dependency resolution (no dependency resolution, standard dependency
+     * resolution, resolution using the expanded json format) that will be used when retrieving
+     * models.
+     */
+    dependencyResolution?: dependencyResolutionType;
+}
+//# sourceMappingURL=modelsRepositoryClientOptions.d.ts.map

package/dist/commonjs/interfaces/modelsRepositoryClientOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryClientOptions.d.ts","sourceRoot":"","sources":["../../../src/interfaces/modelsRepositoryClientOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAC9D,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,gCAAgC,CAAC;AAE/E;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,mBAAmB;IACxE;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,wBAAwB,CAAC;CACjD"}

package/dist/commonjs/interfaces/modelsRepositoryClientOptions.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=modelsRepositoryClientOptions.js.map

package/dist/commonjs/interfaces/modelsRepositoryClientOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryClientOptions.js","sourceRoot":"","sources":["../../../src/interfaces/modelsRepositoryClientOptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { CommonClientOptions } from \"@azure/core-client\";\nimport type { dependencyResolutionType } from \"../dependencyResolutionType.js\";\n\n/**\n * Options for creating a Pipeline to use with ModelsRepositoryClient.\n * It serves to configure the client itself, for instance by specifying\n * the repository location to use on any getModels call.\n */\nexport interface ModelsRepositoryClientOptions extends CommonClientOptions {\n  /**\n   * This is the base location (URI or path) that requests will be made against for this client.\n   */\n  repositoryLocation?: string;\n  /**\n   * Though currently not relevant, can be used in future iterations to specify the API Version\n   * of the service.\n   */\n  apiVersion?: string;\n\n  /**\n   * This is the format of dependency resolution (no dependency resolution, standard dependency\n   * resolution, resolution using the expanded json format) that will be used when retrieving\n   * models.\n   */\n  dependencyResolution?: dependencyResolutionType;\n}\n"]}

package/dist/commonjs/logger.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The Azure Logger configuration for this package.
+ * See: https://www.npmjs.com/package/\@azure/logger
+ */
+export declare const logger: import("@azure/logger").AzureLogger;
+//# sourceMappingURL=logger.d.ts.map

package/dist/commonjs/logger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":"AAKA;;;GAGG;AACH,eAAO,MAAM,MAAM,qCAA6C,CAAC"}

package/dist/commonjs/logger.js

@@ -0,0 +1,12 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const logger_1 = require("@azure/logger");
+/**
+ * The Azure Logger configuration for this package.
+ * See: https://www.npmjs.com/package/\@azure/logger
+ */
+exports.logger = (0, logger_1.createClientLogger)("iot-modelsrepository");
+//# sourceMappingURL=logger.js.map

package/dist/commonjs/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/logger.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,0CAAmD;AAEnD;;;GAGG;AACU,QAAA,MAAM,GAAG,IAAA,2BAAkB,EAAC,sBAAsB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The Azure Logger configuration for this package.\n * See: https://www.npmjs.com/package/\\@azure/logger\n */\nexport const logger = createClientLogger(\"iot-modelsrepository\");\n"]}

package/dist/commonjs/modelsRepositoryClient.d.ts

@@ -0,0 +1,68 @@
+import type { dependencyResolutionType } from "./dependencyResolutionType.js";
+import type { ModelsRepositoryClientOptions } from "./interfaces/modelsRepositoryClientOptions.js";
+import type { GetModelsOptions } from "./interfaces/getModelsOptions.js";
+/**
+ * Initializes a new instance of the IoT Models Repository Client.
+ */
+export declare class ModelsRepositoryClient {
+    private _repositoryLocation;
+    private _dependencyResolution;
+    private _apiVersion;
+    private _fetcher;
+    private _resolver;
+    private _pseudoParser;
+    /**
+     * The ModelsRepositoryClient constructor
+     * @param options - The models repository client options that govern the behavior of the client.
+     */
+    constructor(options?: ModelsRepositoryClientOptions);
+    /**
+     * improves the readability of the constructor.
+     * based on a boolean returns the proper dependency resolution setting string.
+     */
+    private _checkDefaultDependencyResolution;
+    /**
+     * Though currently not relevant, can specify API Version for communicating with
+     * the service.
+     */
+    get apiVersion(): string;
+    /**
+     * Configured repository location for this instance. Will be used as the endpoint to get the models from.
+     */
+    get repositoryLocation(): string;
+    /**
+     * Configured type of dependency resolution for this instance. Dictates how the client deals with model dependencies.
+     */
+    get dependencyResolution(): dependencyResolutionType;
+    /**
+     * Because of the local / remote optionality of this client, the service client
+     * must be dynamically generated based on the repository location. If the provided
+     * repository location is a remote location, then this private method will be used
+     * to create the IoT Models Repository Service Client.
+     */
+    private _createClient;
+    /**
+     * The fetcher is an abstraction necessary since this client can communicate with remote or local
+     * Model Repositories based on the provided location. It will analyze the provided location based
+     * on that create either an HTTP Fetcher, which uses the IoT Models Repository Service Client,
+     * or a Filesystem Fetcher.
+     */
+    private _createFetcher;
+    /**
+     * Retrieve one or more models based upon on or more provided dtmis.
+     * @param dtmis - one dtmi represented as a string
+     * @param options - options to govern behavior of model getter.
+     */
+    getModels(dtmis: string, options?: GetModelsOptions): Promise<{
+        [dtmi: string]: unknown;
+    }>;
+    /**
+     * Retrieve one or more models based upon on or more provided dtmis.
+     * @param dtmis - dtmi strings in an array.
+     * @param options - options to govern behavior of model getter.
+     */
+    getModels(dtmis: string[], options?: GetModelsOptions): Promise<{
+        [dtmi: string]: unknown;
+    }>;
+}
+//# sourceMappingURL=modelsRepositoryClient.d.ts.map

package/dist/commonjs/modelsRepositoryClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryClient.d.ts","sourceRoot":"","sources":["../../src/modelsRepositoryClient.ts"],"names":[],"mappings":"AAgBA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AAG9E,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AAInG,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGzE;;GAEG;AACH,qBAAa,sBAAsB;IACjC,OAAO,CAAC,mBAAmB,CAAS;IACpC,OAAO,CAAC,qBAAqB,CAA2B;IACxD,OAAO,CAAC,WAAW,CAAS;IAC5B,OAAO,CAAC,QAAQ,CAAU;IAC1B,OAAO,CAAC,SAAS,CAAe;IAChC,OAAO,CAAC,aAAa,CAAe;IAEpC;;;OAGG;gBACS,OAAO,GAAE,6BAAkC;IAevD;;;OAGG;IACH,OAAO,CAAC,iCAAiC;IAQzC;;;OAGG;IACH,IAAI,UAAU,IAAI,MAAM,CAEvB;IAED;;OAEG;IACH,IAAI,kBAAkB,IAAI,MAAM,CAE/B;IAED;;OAEG;IACH,IAAI,oBAAoB,IAAI,wBAAwB,CAEnD;IAED;;;;;OAKG;IACH,OAAO,CAAC,aAAa;IA0BrB;;;;;OAKG;IACH,OAAO,CAAC,cAAc;IAkCtB;;;;OAIG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAChG;;;;OAIG;IACG,SAAS,CACb,KAAK,EAAE,MAAM,EAAE,EACf,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CAiDxC"}

package/dist/commonjs/modelsRepositoryClient.js

@@ -0,0 +1,179 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelsRepositoryClient = void 0;
+const tslib_1 = require("tslib");
+const constants_js_1 = require("./utils/constants.js");
+const core_client_1 = require("@azure/core-client");
+const path_js_1 = require("./utils/path.js");
+const fetcherFilesystem_js_1 = require("./fetcherFilesystem.js");
+const dtmiResolver_js_1 = require("./dtmiResolver.js");
+const psuedoParser_js_1 = require("./psuedoParser.js");
+const logger_js_1 = require("./logger.js");
+const modelsRepositoryServiceClient_js_1 = require("./modelsRepositoryServiceClient.js");
+const fetcherHTTP_js_1 = require("./fetcherHTTP.js");
+/**
+ * Initializes a new instance of the IoT Models Repository Client.
+ */
+class ModelsRepositoryClient {
+    /**
+     * The ModelsRepositoryClient constructor
+     * @param options - The models repository client options that govern the behavior of the client.
+     */
+    constructor(options = {}) {
+        this._repositoryLocation = options.repositoryLocation || constants_js_1.DEFAULT_REPOSITORY_LOCATION;
+        logger_js_1.logger.info(`Client configured for repository location ${this._repositoryLocation}`);
+        this._dependencyResolution =
+            options.dependencyResolution ||
+                this._checkDefaultDependencyResolution(!!options.repositoryLocation);
+        logger_js_1.logger.info(`Client configured for dependency mode: ${this._dependencyResolution}`);
+        this._fetcher = this._createFetcher(this._repositoryLocation, options);
+        this._resolver = new dtmiResolver_js_1.DtmiResolver(this._fetcher);
+        this._pseudoParser = new psuedoParser_js_1.PseudoParser(this._resolver);
+        // Store api version here (for now). Currently doesn't do anything
+        this._apiVersion = options.apiVersion || constants_js_1.DEFAULT_API_VERSION;
+    }
+    /**
+     * improves the readability of the constructor.
+     * based on a boolean returns the proper dependency resolution setting string.
+     */
+    _checkDefaultDependencyResolution(customRepository) {
+        if (customRepository) {
+            return "enabled";
+        }
+        else {
+            return "tryFromExpanded";
+        }
+    }
+    /**
+     * Though currently not relevant, can specify API Version for communicating with
+     * the service.
+     */
+    get apiVersion() {
+        return this._apiVersion;
+    }
+    /**
+     * Configured repository location for this instance. Will be used as the endpoint to get the models from.
+     */
+    get repositoryLocation() {
+        return this._repositoryLocation;
+    }
+    /**
+     * Configured type of dependency resolution for this instance. Dictates how the client deals with model dependencies.
+     */
+    get dependencyResolution() {
+        return this._dependencyResolution;
+    }
+    /**
+     * Because of the local / remote optionality of this client, the service client
+     * must be dynamically generated based on the repository location. If the provided
+     * repository location is a remote location, then this private method will be used
+     * to create the IoT Models Repository Service Client.
+     */
+    _createClient(options) {
+        const pipelineOptions = tslib_1.__rest(options, []);
+        if (!pipelineOptions.userAgentOptions) {
+            pipelineOptions.userAgentOptions = {};
+        }
+        if (pipelineOptions.userAgentOptions.userAgentPrefix) {
+            pipelineOptions.userAgentOptions.userAgentPrefix = `${pipelineOptions.userAgentOptions.userAgentPrefix} ${constants_js_1.DEFAULT_USER_AGENT}`;
+        }
+        else {
+            pipelineOptions.userAgentOptions.userAgentPrefix = constants_js_1.DEFAULT_USER_AGENT;
+        }
+        const internalPipelineOptions = Object.assign(Object.assign({}, pipelineOptions), {
+            loggingOptions: {
+                logger: logger_js_1.logger.info,
+            },
+        });
+        const pipeline = (0, core_client_1.createClientPipeline)(internalPipelineOptions);
+        const client = new modelsRepositoryServiceClient_js_1.IoTModelsRepositoryServiceClient(this._repositoryLocation, { pipeline });
+        return client;
+    }
+    /**
+     * The fetcher is an abstraction necessary since this client can communicate with remote or local
+     * Model Repositories based on the provided location. It will analyze the provided location based
+     * on that create either an HTTP Fetcher, which uses the IoT Models Repository Service Client,
+     * or a Filesystem Fetcher.
+     */
+    _createFetcher(location, options) {
+        let locationURL;
+        let fetcher;
+        if ((0, path_js_1.isLocalPath)(location)) {
+            // POSIX Filesystem Path or Windows Filesystem Path
+            logger_js_1.logger.info(`Repository location identified as filesystem path - using FilesystemFetcher`);
+            fetcher = new fetcherFilesystem_js_1.FilesystemFetcher((0, path_js_1.normalize)(location));
+        }
+        else {
+            locationURL = new URL(location);
+            const prot = locationURL.protocol;
+            if (prot.includes("http") || prot.includes("https")) {
+                logger_js_1.logger.info(`Repository location identified as HTTP/HTTPS endpoint - using HttpFetcher`);
+                const client = this._createClient(options);
+                fetcher = new fetcherHTTP_js_1.HttpFetcher(location, client);
+            }
+            else if (prot.includes("file")) {
+                // filesystem URI
+                logger_js_1.logger.info("Repository Location identified as filesystem URI - using FilesystemFetcher");
+                fetcher = new fetcherFilesystem_js_1.FilesystemFetcher(location);
+            }
+            else if (prot === "" && location.search(/\.[a-zA-Z]{2,63}$/)) {
+                // Web URL with protocol unspecified - default to HTTPS
+                logger_js_1.logger.info("Repository Location identified as remote endpoint without protocol specified - using HttpFetcher");
+                const fLocation = "https://" + location;
+                const client = this._createClient(options);
+                fetcher = new fetcherHTTP_js_1.HttpFetcher(fLocation, client);
+            }
+            else {
+                throw new EvalError(`Unable to identify location: ${location}`);
+            }
+        }
+        return fetcher;
+    }
+    async getModels(dtmis, options) {
+        let modelMap;
+        if (!Array.isArray(dtmis)) {
+            dtmis = [dtmis];
+        }
+        const dependencyResolution = (options === null || options === void 0 ? void 0 : options.dependencyResolution) || this._dependencyResolution;
+        if (dependencyResolution === constants_js_1.DEPENDENCY_MODE_DISABLED) {
+            logger_js_1.logger.info("Getting models w/ dependency resolution mode: disabled");
+            logger_js_1.logger.info(`Retreiving model(s): ${dtmis}...`);
+            modelMap = await this._resolver.resolve(dtmis, false, options);
+        }
+        else if (dependencyResolution === constants_js_1.DEPENDENCY_MODE_ENABLED) {
+            logger_js_1.logger.info(`Getting models w/ dependency resolution mode: enabled`);
+            logger_js_1.logger.info(`Retreiving model(s): ${dtmis}...`);
+            const baseModelMap = await this._resolver.resolve(dtmis, false, options);
+            const baseModelList = Object.keys(baseModelMap).map((key) => baseModelMap[key]);
+            logger_js_1.logger.info(`Retreiving model dependencies for ${dtmis}...`);
+            modelMap = await this._pseudoParser.expand(baseModelList, false);
+        }
+        else if (dependencyResolution === constants_js_1.DEPENDENCY_MODE_TRY_FROM_EXPANDED) {
+            logger_js_1.logger.info(`Getting models w/ dependency resolution mode: tryFromExpanded`);
+            try {
+                logger_js_1.logger.info(`Retreiving expanded model(s): ${dtmis}...`);
+                modelMap = await this._resolver.resolve(dtmis, true, options);
+            }
+            catch (e) {
+                if (e.name === "RestError" && e.code === "ResouceNotFound") {
+                    logger_js_1.logger.info("Could not retrieve model(s) from expanded model DTDL - ");
+                    const baseModelMap = await this._resolver.resolve(dtmis, false, options);
+                    const baseModelList = Object.keys(baseModelMap).map((key) => baseModelMap[key]);
+                    logger_js_1.logger.info(`Retreiving model dependencies for ${dtmis}...`);
+                    modelMap = await this._pseudoParser.expand(baseModelList, true);
+                }
+                else {
+                    throw e;
+                }
+            }
+        }
+        else {
+            throw EvalError(`Invalid dependency resolution mode: ${dependencyResolution}`);
+        }
+        return modelMap;
+    }
+}
+exports.ModelsRepositoryClient = ModelsRepositoryClient;
+//# sourceMappingURL=modelsRepositoryClient.js.map

package/dist/commonjs/modelsRepositoryClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryClient.js","sourceRoot":"","sources":["../../src/modelsRepositoryClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,uDAO8B;AAE9B,oDAA0D;AAE1D,6CAAyD;AACzD,iEAA2D;AAE3D,uDAAiD;AACjD,uDAAiD;AAEjD,2CAAqC;AACrC,yFAAsF;AACtF,qDAA+C;AAI/C;;GAEG;AACH,MAAa,sBAAsB;IAQjC;;;OAGG;IACH,YAAY,UAAyC,EAAE;QACrD,IAAI,CAAC,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,IAAI,0CAA2B,CAAC;QACrF,kBAAM,CAAC,IAAI,CAAC,6CAA6C,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC;QACrF,IAAI,CAAC,qBAAqB;YACxB,OAAO,CAAC,oBAAoB;gBAC5B,IAAI,CAAC,iCAAiC,CAAC,CAAC,CAAC,OAAO,CAAC,kBAAkB,CAAC,CAAC;QACvE,kBAAM,CAAC,IAAI,CAAC,0CAA0C,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC;QACpF,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,IAAI,8BAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACjD,IAAI,CAAC,aAAa,GAAG,IAAI,8BAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAEtD,kEAAkE;QAClE,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,UAAU,IAAI,kCAAmB,CAAC;IAC/D,CAAC;IAED;;;OAGG;IACK,iCAAiC,CAAC,gBAAyB;QACjE,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,SAAS,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,OAAO,iBAAiB,CAAC;QAC3B,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED;;OAEG;IACH,IAAI,kBAAkB;QACpB,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAI,oBAAoB;QACtB,OAAO,IAAI,CAAC,qBAAqB,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACK,aAAa,CAAC,OAAsC;QAC1D,MAAW,eAAe,kBAAK,OAAO,EAAhC,EAAsB,CAAU,CAAC;QAEvC,IAAI,CAAC,eAAe,CAAC,gBAAgB,EAAE,CAAC;YACtC,eAAe,CAAC,gBAAgB,GAAG,EAAE,CAAC;QACxC,CAAC;QACD,IAAI,eAAe,CAAC,gBAAgB,CAAC,eAAe,EAAE,CAAC;YACrD,eAAe,CAAC,gBAAgB,CAAC,eAAe,GAAG,GAAG,eAAe,CAAC,gBAAgB,CAAC,eAAe,IAAI,iCAAkB,EAAE,CAAC;QACjI,CAAC;aAAM,CAAC;YACN,eAAe,CAAC,gBAAgB,CAAC,eAAe,GAAG,iCAAkB,CAAC;QACxE,CAAC;QAED,MAAM,uBAAuB,mCACxB,eAAe,GACf;YACD,cAAc,EAAE;gBACd,MAAM,EAAE,kBAAM,CAAC,IAAI;aACpB;SACF,CACF,CAAC;QAEF,MAAM,QAAQ,GAAG,IAAA,kCAAoB,EAAC,uBAAuB,CAAC,CAAC;QAC/D,MAAM,MAAM,GAAG,IAAI,mEAAgC,CAAC,IAAI,CAAC,mBAAmB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5F,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACK,cAAc,CAAC,QAAgB,EAAE,OAAsC;QAC7E,IAAI,WAAW,CAAC;QAChB,IAAI,OAAO,CAAC;QACZ,IAAI,IAAA,qBAAW,EAAC,QAAQ,CAAC,EAAE,CAAC;YAC1B,mDAAmD;YACnD,kBAAM,CAAC,IAAI,CAAC,6EAA6E,CAAC,CAAC;YAC3F,OAAO,GAAG,IAAI,wCAAiB,CAAC,IAAA,mBAAS,EAAC,QAAQ,CAAC,CAAC,CAAC;QACvD,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,CAAC;YAChC,MAAM,IAAI,GAAG,WAAW,CAAC,QAAQ,CAAC;YAClC,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,kBAAM,CAAC,IAAI,CAAC,2EAA2E,CAAC,CAAC;gBACzF,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAC3C,OAAO,GAAG,IAAI,4BAAW,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC9C,CAAC;iBAAM,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC;gBACjC,iBAAiB;gBACjB,kBAAM,CAAC,IAAI,CAAC,4EAA4E,CAAC,CAAC;gBAC1F,OAAO,GAAG,IAAI,wCAAiB,CAAC,QAAQ,CAAC,CAAC;YAC5C,CAAC;iBAAM,IAAI,IAAI,KAAK,EAAE,IAAI,QAAQ,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE,CAAC;gBAC/D,uDAAuD;gBACvD,kBAAM,CAAC,IAAI,CACT,kGAAkG,CACnG,CAAC;gBACF,MAAM,SAAS,GAAG,UAAU,GAAG,QAAQ,CAAC;gBACxC,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC;gBAC3C,OAAO,GAAG,IAAI,4BAAW,CAAC,SAAS,EAAE,MAAM,CAAC,CAAC;YAC/C,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,SAAS,CAAC,gCAAgC,QAAQ,EAAE,CAAC,CAAC;YAClE,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;IAiBD,KAAK,CAAC,SAAS,CACb,KAAwB,EACxB,OAA0B;QAE1B,IAAI,QAAqC,CAAC;QAC1C,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;YAC1B,KAAK,GAAG,CAAC,KAAK,CAAC,CAAC;QAClB,CAAC;QAED,MAAM,oBAAoB,GAAG,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,oBAAoB,KAAI,IAAI,CAAC,qBAAqB,CAAC;QAEzF,IAAI,oBAAoB,KAAK,uCAAwB,EAAE,CAAC;YACtD,kBAAM,CAAC,IAAI,CAAC,wDAAwD,CAAC,CAAC;YACtE,kBAAM,CAAC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,CAAC;YAChD,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;QACjE,CAAC;aAAM,IAAI,oBAAoB,KAAK,sCAAuB,EAAE,CAAC;YAC5D,kBAAM,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;YACrE,kBAAM,CAAC,IAAI,CAAC,wBAAwB,KAAK,KAAK,CAAC,CAAC;YAChD,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;YACzE,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;YAChF,kBAAM,CAAC,IAAI,CAAC,qCAAqC,KAAK,KAAK,CAAC,CAAC;YAC7D,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QACnE,CAAC;aAAM,IAAI,oBAAoB,KAAK,gDAAiC,EAAE,CAAC;YACtE,kBAAM,CAAC,IAAI,CAAC,+DAA+D,CAAC,CAAC;YAC7E,IAAI,CAAC;gBACH,kBAAM,CAAC,IAAI,CAAC,iCAAiC,KAAK,KAAK,CAAC,CAAC;gBACzD,QAAQ,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;YAChE,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;oBAC3D,kBAAM,CAAC,IAAI,CAAC,yDAAyD,CAAC,CAAC;oBACvE,MAAM,YAAY,GAAgC,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAC5E,KAAK,EACL,KAAK,EACL,OAAO,CACR,CAAC;oBACF,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC;oBAChF,kBAAM,CAAC,IAAI,CAAC,qCAAqC,KAAK,KAAK,CAAC,CAAC;oBAC7D,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,aAAuB,EAAE,IAAI,CAAC,CAAC;gBAC5E,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,CAAC;gBACV,CAAC;YACH,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,SAAS,CAAC,uCAAuC,oBAAoB,EAAE,CAAC,CAAC;QACjF,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AApMD,wDAoMC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport {\n  DEFAULT_API_VERSION,\n  DEFAULT_REPOSITORY_LOCATION,\n  DEFAULT_USER_AGENT,\n  DEPENDENCY_MODE_DISABLED,\n  DEPENDENCY_MODE_ENABLED,\n  DEPENDENCY_MODE_TRY_FROM_EXPANDED,\n} from \"./utils/constants.js\";\nimport type { InternalClientPipelineOptions } from \"@azure/core-client\";\nimport { createClientPipeline } from \"@azure/core-client\";\nimport type { Fetcher } from \"./fetcherAbstract.js\";\nimport { isLocalPath, normalize } from \"./utils/path.js\";\nimport { FilesystemFetcher } from \"./fetcherFilesystem.js\";\nimport type { dependencyResolutionType } from \"./dependencyResolutionType.js\";\nimport { DtmiResolver } from \"./dtmiResolver.js\";\nimport { PseudoParser } from \"./psuedoParser.js\";\nimport type { ModelsRepositoryClientOptions } from \"./interfaces/modelsRepositoryClientOptions.js\";\nimport { logger } from \"./logger.js\";\nimport { IoTModelsRepositoryServiceClient } from \"./modelsRepositoryServiceClient.js\";\nimport { HttpFetcher } from \"./fetcherHTTP.js\";\nimport type { GetModelsOptions } from \"./interfaces/getModelsOptions.js\";\nimport type { DTDL } from \"./psuedoDtdl.js\";\n\n/**\n * Initializes a new instance of the IoT Models Repository Client.\n */\nexport class ModelsRepositoryClient {\n  private _repositoryLocation: string;\n  private _dependencyResolution: dependencyResolutionType;\n  private _apiVersion: string;\n  private _fetcher: Fetcher;\n  private _resolver: DtmiResolver;\n  private _pseudoParser: PseudoParser;\n\n  /**\n   * The ModelsRepositoryClient constructor\n   * @param options - The models repository client options that govern the behavior of the client.\n   */\n  constructor(options: ModelsRepositoryClientOptions = {}) {\n    this._repositoryLocation = options.repositoryLocation || DEFAULT_REPOSITORY_LOCATION;\n    logger.info(`Client configured for repository location ${this._repositoryLocation}`);\n    this._dependencyResolution =\n      options.dependencyResolution ||\n      this._checkDefaultDependencyResolution(!!options.repositoryLocation);\n    logger.info(`Client configured for dependency mode: ${this._dependencyResolution}`);\n    this._fetcher = this._createFetcher(this._repositoryLocation, options);\n    this._resolver = new DtmiResolver(this._fetcher);\n    this._pseudoParser = new PseudoParser(this._resolver);\n\n    // Store api version here (for now). Currently doesn't do anything\n    this._apiVersion = options.apiVersion || DEFAULT_API_VERSION;\n  }\n\n  /**\n   * improves the readability of the constructor.\n   * based on a boolean returns the proper dependency resolution setting string.\n   */\n  private _checkDefaultDependencyResolution(customRepository: boolean): dependencyResolutionType {\n    if (customRepository) {\n      return \"enabled\";\n    } else {\n      return \"tryFromExpanded\";\n    }\n  }\n\n  /**\n   * Though currently not relevant, can specify API Version for communicating with\n   * the service.\n   */\n  get apiVersion(): string {\n    return this._apiVersion;\n  }\n\n  /**\n   * Configured repository location for this instance. Will be used as the endpoint to get the models from.\n   */\n  get repositoryLocation(): string {\n    return this._repositoryLocation;\n  }\n\n  /**\n   * Configured type of dependency resolution for this instance. Dictates how the client deals with model dependencies.\n   */\n  get dependencyResolution(): dependencyResolutionType {\n    return this._dependencyResolution;\n  }\n\n  /**\n   * Because of the local / remote optionality of this client, the service client\n   * must be dynamically generated based on the repository location. If the provided\n   * repository location is a remote location, then this private method will be used\n   * to create the IoT Models Repository Service Client.\n   */\n  private _createClient(options: ModelsRepositoryClientOptions): IoTModelsRepositoryServiceClient {\n    const { ...pipelineOptions } = options;\n\n    if (!pipelineOptions.userAgentOptions) {\n      pipelineOptions.userAgentOptions = {};\n    }\n    if (pipelineOptions.userAgentOptions.userAgentPrefix) {\n      pipelineOptions.userAgentOptions.userAgentPrefix = `${pipelineOptions.userAgentOptions.userAgentPrefix} ${DEFAULT_USER_AGENT}`;\n    } else {\n      pipelineOptions.userAgentOptions.userAgentPrefix = DEFAULT_USER_AGENT;\n    }\n\n    const internalPipelineOptions: InternalClientPipelineOptions = {\n      ...pipelineOptions,\n      ...{\n        loggingOptions: {\n          logger: logger.info,\n        },\n      },\n    };\n\n    const pipeline = createClientPipeline(internalPipelineOptions);\n    const client = new IoTModelsRepositoryServiceClient(this._repositoryLocation, { pipeline });\n    return client;\n  }\n\n  /**\n   * The fetcher is an abstraction necessary since this client can communicate with remote or local\n   * Model Repositories based on the provided location. It will analyze the provided location based\n   * on that create either an HTTP Fetcher, which uses the IoT Models Repository Service Client,\n   * or a Filesystem Fetcher.\n   */\n  private _createFetcher(location: string, options: ModelsRepositoryClientOptions): Fetcher {\n    let locationURL;\n    let fetcher;\n    if (isLocalPath(location)) {\n      // POSIX Filesystem Path or Windows Filesystem Path\n      logger.info(`Repository location identified as filesystem path - using FilesystemFetcher`);\n      fetcher = new FilesystemFetcher(normalize(location));\n    } else {\n      locationURL = new URL(location);\n      const prot = locationURL.protocol;\n      if (prot.includes(\"http\") || prot.includes(\"https\")) {\n        logger.info(`Repository location identified as HTTP/HTTPS endpoint - using HttpFetcher`);\n        const client = this._createClient(options);\n        fetcher = new HttpFetcher(location, client);\n      } else if (prot.includes(\"file\")) {\n        // filesystem URI\n        logger.info(\"Repository Location identified as filesystem URI - using FilesystemFetcher\");\n        fetcher = new FilesystemFetcher(location);\n      } else if (prot === \"\" && location.search(/\\.[a-zA-Z]{2,63}$/)) {\n        // Web URL with protocol unspecified - default to HTTPS\n        logger.info(\n          \"Repository Location identified as remote endpoint without protocol specified - using HttpFetcher\",\n        );\n        const fLocation = \"https://\" + location;\n        const client = this._createClient(options);\n        fetcher = new HttpFetcher(fLocation, client);\n      } else {\n        throw new EvalError(`Unable to identify location: ${location}`);\n      }\n    }\n\n    return fetcher;\n  }\n\n  /**\n   * Retrieve one or more models based upon on or more provided dtmis.\n   * @param dtmis - one dtmi represented as a string\n   * @param options - options to govern behavior of model getter.\n   */\n  async getModels(dtmis: string, options?: GetModelsOptions): Promise<{ [dtmi: string]: unknown }>;\n  /**\n   * Retrieve one or more models based upon on or more provided dtmis.\n   * @param dtmis - dtmi strings in an array.\n   * @param options - options to govern behavior of model getter.\n   */\n  async getModels(\n    dtmis: string[],\n    options?: GetModelsOptions,\n  ): Promise<{ [dtmi: string]: unknown }>;\n  async getModels(\n    dtmis: string | string[],\n    options?: GetModelsOptions,\n  ): Promise<{ [dtmi: string]: unknown }> {\n    let modelMap: { [dtmi: string]: unknown };\n    if (!Array.isArray(dtmis)) {\n      dtmis = [dtmis];\n    }\n\n    const dependencyResolution = options?.dependencyResolution || this._dependencyResolution;\n\n    if (dependencyResolution === DEPENDENCY_MODE_DISABLED) {\n      logger.info(\"Getting models w/ dependency resolution mode: disabled\");\n      logger.info(`Retreiving model(s): ${dtmis}...`);\n      modelMap = await this._resolver.resolve(dtmis, false, options);\n    } else if (dependencyResolution === DEPENDENCY_MODE_ENABLED) {\n      logger.info(`Getting models w/ dependency resolution mode: enabled`);\n      logger.info(`Retreiving model(s): ${dtmis}...`);\n      const baseModelMap = await this._resolver.resolve(dtmis, false, options);\n      const baseModelList = Object.keys(baseModelMap).map((key) => baseModelMap[key]);\n      logger.info(`Retreiving model dependencies for ${dtmis}...`);\n      modelMap = await this._pseudoParser.expand(baseModelList, false);\n    } else if (dependencyResolution === DEPENDENCY_MODE_TRY_FROM_EXPANDED) {\n      logger.info(`Getting models w/ dependency resolution mode: tryFromExpanded`);\n      try {\n        logger.info(`Retreiving expanded model(s): ${dtmis}...`);\n        modelMap = await this._resolver.resolve(dtmis, true, options);\n      } catch (e: any) {\n        if (e.name === \"RestError\" && e.code === \"ResouceNotFound\") {\n          logger.info(\"Could not retrieve model(s) from expanded model DTDL - \");\n          const baseModelMap: { [dtmi: string]: unknown } = await this._resolver.resolve(\n            dtmis,\n            false,\n            options,\n          );\n          const baseModelList = Object.keys(baseModelMap).map((key) => baseModelMap[key]);\n          logger.info(`Retreiving model dependencies for ${dtmis}...`);\n          modelMap = await this._pseudoParser.expand(baseModelList as DTDL[], true);\n        } else {\n          throw e;\n        }\n      }\n    } else {\n      throw EvalError(`Invalid dependency resolution mode: ${dependencyResolution}`);\n    }\n\n    return modelMap;\n  }\n}\n"]}

package/dist/commonjs/modelsRepositoryServiceClient.d.ts

@@ -0,0 +1,22 @@
+import type { ServiceClientOptions } from "@azure/core-client";
+import { ServiceClient } from "@azure/core-client";
+interface IoTModelsRepositoryServiceClientOptions extends ServiceClientOptions {
+    version?: string;
+    endpoint?: string;
+}
+/**
+ * @internal
+ */
+export declare class IoTModelsRepositoryServiceClient extends ServiceClient {
+    url: string;
+    version: string;
+    /**
+     * Initializes a new instance of the IoTModelsRepositoryServiceClient class.
+     *
+     * @param url - The URL of the service account or table that is the target of the desired operation.
+     * @param options - The parameter options
+     */
+    constructor(url: string, options?: IoTModelsRepositoryServiceClientOptions);
+}
+export {};
+//# sourceMappingURL=modelsRepositoryServiceClient.d.ts.map

package/dist/commonjs/modelsRepositoryServiceClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryServiceClient.d.ts","sourceRoot":"","sources":["../../src/modelsRepositoryServiceClient.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGnD,UAAU,uCAAwC,SAAQ,oBAAoB;IAE5E,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,qBAAa,gCAAiC,SAAQ,aAAa;IACjE,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;gBACS,GAAG,EAAE,MAAM,EAAE,OAAO,GAAE,uCAA4C;CAgB/E"}

package/dist/commonjs/modelsRepositoryServiceClient.js

@@ -0,0 +1,30 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IoTModelsRepositoryServiceClient = void 0;
+const core_client_1 = require("@azure/core-client");
+const constants_js_1 = require("./utils/constants.js");
+/**
+ * @internal
+ */
+class IoTModelsRepositoryServiceClient extends core_client_1.ServiceClient {
+    /**
+     * Initializes a new instance of the IoTModelsRepositoryServiceClient class.
+     *
+     * @param url - The URL of the service account or table that is the target of the desired operation.
+     * @param options - The parameter options
+     */
+    constructor(url, options = {}) {
+        const defaults = {
+            baseUri: `${url}`,
+            requestContentType: "application/json; charset=utf-8",
+        };
+        const optionsWithDefaults = Object.assign(Object.assign({}, defaults), options);
+        super(optionsWithDefaults);
+        this.url = url;
+        this.version = options.version || constants_js_1.DEFAULT_API_VERSION;
+    }
+}
+exports.IoTModelsRepositoryServiceClient = IoTModelsRepositoryServiceClient;
+//# sourceMappingURL=modelsRepositoryServiceClient.js.map

package/dist/commonjs/modelsRepositoryServiceClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"modelsRepositoryServiceClient.js","sourceRoot":"","sources":["../../src/modelsRepositoryServiceClient.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,oDAAmD;AACnD,uDAA2D;AAS3D;;GAEG;AACH,MAAa,gCAAiC,SAAQ,2BAAa;IAIjE;;;;;OAKG;IACH,YAAY,GAAW,EAAE,UAAmD,EAAE;QAC5E,MAAM,QAAQ,GAA4C;YACxD,OAAO,EAAE,GAAG,GAAG,EAAE;YACjB,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,mBAAmB,mCACpB,QAAQ,GACR,OAAO,CACX,CAAC;QAEF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,kCAAmB,CAAC;IACxD,CAAC;CACF;AA1BD,4EA0BC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { ServiceClientOptions } from \"@azure/core-client\";\nimport { ServiceClient } from \"@azure/core-client\";\nimport { DEFAULT_API_VERSION } from \"./utils/constants.js\";\n\ninterface IoTModelsRepositoryServiceClientOptions extends ServiceClientOptions {\n  // API Version to be used during HTTP Calls.\n  version?: string;\n  // Endpoint that will be base of URLs for HTTP calls.\n  endpoint?: string;\n}\n\n/**\n * @internal\n */\nexport class IoTModelsRepositoryServiceClient extends ServiceClient {\n  url: string;\n  version: string;\n\n  /**\n   * Initializes a new instance of the IoTModelsRepositoryServiceClient class.\n   *\n   * @param url - The URL of the service account or table that is the target of the desired operation.\n   * @param options - The parameter options\n   */\n  constructor(url: string, options: IoTModelsRepositoryServiceClientOptions = {}) {\n    const defaults: IoTModelsRepositoryServiceClientOptions = {\n      baseUri: `${url}`,\n      requestContentType: \"application/json; charset=utf-8\",\n    };\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n    };\n\n    super(optionsWithDefaults);\n\n    this.url = url;\n    this.version = options.version || DEFAULT_API_VERSION;\n  }\n}\n"]}

package/dist/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/dist/commonjs/psuedoDtdl.d.ts

@@ -0,0 +1,16 @@
+interface Contents {
+    "@type": string;
+    name: string;
+    schema: string;
+}
+/**
+ * @internal
+ */
+export interface DTDL {
+    "@context": any[];
+    "@id": string;
+    extends: string | Array<any>;
+    contents: Contents[];
+}
+export {};
+//# sourceMappingURL=psuedoDtdl.d.ts.map

package/dist/commonjs/psuedoDtdl.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"psuedoDtdl.d.ts","sourceRoot":"","sources":["../../src/psuedoDtdl.ts"],"names":[],"mappings":"AAGA,UAAU,QAAQ;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB,UAAU,EAAE,GAAG,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;IAC7B,QAAQ,EAAE,QAAQ,EAAE,CAAC;CACtB"}

package/dist/commonjs/psuedoDtdl.js

@@ -0,0 +1,5 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=psuedoDtdl.js.map

package/dist/commonjs/psuedoDtdl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"psuedoDtdl.js","sourceRoot":"","sources":["../../src/psuedoDtdl.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\ninterface Contents {\n  \"@type\": string;\n  name: string;\n  schema: string;\n}\n\n/**\n * @internal\n */\nexport interface DTDL {\n  \"@context\": any[];\n  \"@id\": string;\n  extends: string | Array<any>;\n  contents: Contents[];\n}\n"]}

package/dist/commonjs/psuedoParser.d.ts

@@ -0,0 +1,23 @@
+import type { DTDL } from "./psuedoDtdl.js";
+import type { DtmiResolver } from "./dtmiResolver.js";
+/**
+ * The PsuedoParser is an interesting implementation. Essentially, this
+ * codebase works in tandem with a Digital Twins Parser, which simultaneously
+ * defines the DTDL structure and validates models match the correct DTDL format.
+ * In lieu of using that Parser as a dependency (for a complex network of reasons),
+ * we implement this class, which kind of parses. Because it uses the resovler too,
+ * we can, during psuedo-parsing, identify any times we should resolve a dependency,
+ * and then resolve the dependencies until the dependency tree is fully resolved.
+ *
+ * @internal
+ */
+export declare class PseudoParser {
+    private _resolver;
+    constructor(resolver: DtmiResolver);
+    expand(models: DTDL[], tryFromExpanded: boolean): Promise<{
+        [dtmi: string]: DTDL;
+    }>;
+    private _expand;
+    private _getModelDependencies;
+}
+//# sourceMappingURL=psuedoParser.d.ts.map

package/dist/commonjs/psuedoParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"psuedoParser.d.ts","sourceRoot":"","sources":["../../src/psuedoParser.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAGtD;;;;;;;;;;GAUG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,SAAS,CAAe;gBAGpB,QAAQ,EAAE,YAAY;IAI5B,MAAM,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE,eAAe,EAAE,OAAO,GAAG,OAAO,CAAC;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;YAc3E,OAAO;IAoCrB,OAAO,CAAC,qBAAqB;CAmC9B"}

package/dist/commonjs/psuedoParser.js

@@ -0,0 +1,102 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PseudoParser = void 0;
+const logger_js_1 = require("./logger.js");
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+/**
+ * The PsuedoParser is an interesting implementation. Essentially, this
+ * codebase works in tandem with a Digital Twins Parser, which simultaneously
+ * defines the DTDL structure and validates models match the correct DTDL format.
+ * In lieu of using that Parser as a dependency (for a complex network of reasons),
+ * we implement this class, which kind of parses. Because it uses the resovler too,
+ * we can, during psuedo-parsing, identify any times we should resolve a dependency,
+ * and then resolve the dependencies until the dependency tree is fully resolved.
+ *
+ * @internal
+ */
+class PseudoParser {
+    // eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
+    constructor(resolver) {
+        this._resolver = resolver;
+    }
+    async expand(models, tryFromExpanded) {
+        const expandedMap = {};
+        for (let i = 0; i < models.length; i++) {
+            const model = models[i];
+            if (model["@id"] !== undefined) {
+                expandedMap[model["@id"]] = model;
+            }
+            else {
+                throw Error(`model ${model} does not contain @id member`);
+            }
+            await this._expand(model, expandedMap, tryFromExpanded);
+        }
+        return expandedMap;
+    }
+    async _expand(model, modelMap, tryFromExpanded) {
+        logger_js_1.logger.info(`Expanding model: ${model["@id"]}`);
+        const dependencies = this._getModelDependencies(model);
+        const dependenciesToResolve = dependencies.filter((dependency) => {
+            return !(dependency in modelMap);
+        });
+        if (dependenciesToResolve.length !== 0) {
+            logger_js_1.logger.info(`Outstanding dependencies found: ${dependenciesToResolve}`);
+            let resolvedDependenciesMap;
+            try {
+                resolvedDependenciesMap = await this._resolver.resolve(dependenciesToResolve, tryFromExpanded);
+            }
+            catch (e) {
+                if (e instanceof core_rest_pipeline_1.RestError) {
+                    resolvedDependenciesMap = await this._resolver.resolve(dependenciesToResolve, false);
+                }
+                else {
+                    throw e;
+                }
+            }
+            Object.keys(resolvedDependenciesMap).forEach((key) => {
+                modelMap[key] = resolvedDependenciesMap[key];
+            });
+            const promiseList = [];
+            Object.values(resolvedDependenciesMap).forEach((dependencyModel) => {
+                promiseList.push(this._expand(dependencyModel, modelMap, tryFromExpanded));
+            });
+            await Promise.all(promiseList);
+        }
+    }
+    _getModelDependencies(model) {
+        const dependencies = [];
+        if (model.contents !== undefined) {
+            const contents = model.contents;
+            contents.forEach((element) => {
+                if (element["@type"] &&
+                    typeof element["@type"] === "string" &&
+                    element["@type"] === "Component") {
+                    if (element.schema && typeof element.schema === "string") {
+                        dependencies.push(element.schema);
+                    }
+                }
+            });
+        }
+        if (model.extends !== undefined) {
+            if (typeof model.extends === "string") {
+                dependencies.push(model.extends);
+            }
+            else if (Array.isArray(model.extends)) {
+                model.extends.forEach((element) => {
+                    if (typeof element === "string") {
+                        dependencies.push(element);
+                    }
+                    else if (typeof element === "object") {
+                        dependencies.push(this._getModelDependencies(element));
+                    }
+                });
+            }
+        }
+        const noDuplicates = Array.from(new Set(dependencies));
+        return noDuplicates;
+    }
+}
+exports.PseudoParser = PseudoParser;
+//# sourceMappingURL=psuedoParser.js.map

package/dist/commonjs/psuedoParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"psuedoParser.js","sourceRoot":"","sources":["../../src/psuedoParser.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,2CAAqC;AAErC,kEAAsD;AAEtD;;;;;;;;;;GAUG;AACH,MAAa,YAAY;IAGvB,wEAAwE;IACxE,YAAY,QAAsB;QAChC,IAAI,CAAC,SAAS,GAAG,QAAQ,CAAC;IAC5B,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,MAAc,EAAE,eAAwB;QACnD,MAAM,WAAW,GAA6B,EAAE,CAAC;QACjD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACvC,MAAM,KAAK,GAAS,MAAM,CAAC,CAAC,CAAC,CAAC;YAC9B,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC/B,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC;YACpC,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,CAAC,SAAS,KAAK,8BAA8B,CAAC,CAAC;YAC5D,CAAC;YACD,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,WAAW,EAAE,eAAe,CAAC,CAAC;QAC1D,CAAC;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,KAAW,EACX,QAAkC,EAClC,eAAwB;QAExB,kBAAM,CAAC,IAAI,CAAC,oBAAoB,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAChD,MAAM,YAAY,GAAG,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,qBAAqB,GAAG,YAAY,CAAC,MAAM,CAAC,CAAC,UAAkB,EAAE,EAAE;YACvE,OAAO,CAAC,CAAC,UAAU,IAAI,QAAQ,CAAC,CAAC;QACnC,CAAC,CAAC,CAAC;QACH,IAAI,qBAAqB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACvC,kBAAM,CAAC,IAAI,CAAC,mCAAmC,qBAAqB,EAAE,CAAC,CAAC;YACxE,IAAI,uBAAiD,CAAC;YACtD,IAAI,CAAC;gBACH,uBAAuB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CACpD,qBAAqB,EACrB,eAAe,CAChB,CAAC;YACJ,CAAC;YAAC,OAAO,CAAM,EAAE,CAAC;gBAChB,IAAI,CAAC,YAAY,8BAAS,EAAE,CAAC;oBAC3B,uBAAuB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,qBAAqB,EAAE,KAAK,CAAC,CAAC;gBACvF,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,CAAC;gBACV,CAAC;YACH,CAAC;YACD,MAAM,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBACnD,QAAQ,CAAC,GAAG,CAAC,GAAG,uBAAuB,CAAC,GAAG,CAAS,CAAC;YACvD,CAAC,CAAC,CAAC;YACH,MAAM,WAAW,GAAoB,EAAE,CAAC;YACxC,MAAM,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;gBACjE,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,eAAuB,EAAE,QAAQ,EAAE,eAAe,CAAC,CAAC,CAAC;YACrF,CAAC,CAAC,CAAC;YACH,MAAM,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACjC,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,KAAW;QACvC,MAAM,YAAY,GAAG,EAAE,CAAC;QAExB,IAAI,KAAK,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;YAChC,QAAQ,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;gBAC3B,IACE,OAAO,CAAC,OAAO,CAAC;oBAChB,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,QAAQ;oBACpC,OAAO,CAAC,OAAO,CAAC,KAAK,WAAW,EAChC,CAAC;oBACD,IAAI,OAAO,CAAC,MAAM,IAAI,OAAO,OAAO,CAAC,MAAM,KAAK,QAAQ,EAAE,CAAC;wBACzD,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;oBACpC,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAC;QACL,CAAC;QAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAChC,IAAI,OAAO,KAAK,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBACtC,YAAY,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACnC,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBACxC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;oBAChC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;wBAChC,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;oBAC7B,CAAC;yBAAM,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;wBACvC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC;oBACzD,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,MAAM,YAAY,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;QACvD,OAAO,YAAY,CAAC;IACtB,CAAC;CACF;AA7FD,oCA6FC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { DTDL } from \"./psuedoDtdl.js\";\nimport { logger } from \"./logger.js\";\nimport type { DtmiResolver } from \"./dtmiResolver.js\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\n\n/**\n * The PsuedoParser is an interesting implementation. Essentially, this\n * codebase works in tandem with a Digital Twins Parser, which simultaneously\n * defines the DTDL structure and validates models match the correct DTDL format.\n * In lieu of using that Parser as a dependency (for a complex network of reasons),\n * we implement this class, which kind of parses. Because it uses the resovler too,\n * we can, during psuedo-parsing, identify any times we should resolve a dependency,\n * and then resolve the dependencies until the dependency tree is fully resolved.\n *\n * @internal\n */\nexport class PseudoParser {\n  private _resolver: DtmiResolver;\n\n  // eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters\n  constructor(resolver: DtmiResolver) {\n    this._resolver = resolver;\n  }\n\n  async expand(models: DTDL[], tryFromExpanded: boolean): Promise<{ [dtmi: string]: DTDL }> {\n    const expandedMap: { [dtmi: string]: DTDL } = {};\n    for (let i = 0; i < models.length; i++) {\n      const model: DTDL = models[i];\n      if (model[\"@id\"] !== undefined) {\n        expandedMap[model[\"@id\"]] = model;\n      } else {\n        throw Error(`model ${model} does not contain @id member`);\n      }\n      await this._expand(model, expandedMap, tryFromExpanded);\n    }\n    return expandedMap;\n  }\n\n  private async _expand(\n    model: DTDL,\n    modelMap: { [dtmi: string]: DTDL },\n    tryFromExpanded: boolean,\n  ): Promise<void> {\n    logger.info(`Expanding model: ${model[\"@id\"]}`);\n    const dependencies = this._getModelDependencies(model);\n    const dependenciesToResolve = dependencies.filter((dependency: string) => {\n      return !(dependency in modelMap);\n    });\n    if (dependenciesToResolve.length !== 0) {\n      logger.info(`Outstanding dependencies found: ${dependenciesToResolve}`);\n      let resolvedDependenciesMap: { [s: string]: unknown };\n      try {\n        resolvedDependenciesMap = await this._resolver.resolve(\n          dependenciesToResolve,\n          tryFromExpanded,\n        );\n      } catch (e: any) {\n        if (e instanceof RestError) {\n          resolvedDependenciesMap = await this._resolver.resolve(dependenciesToResolve, false);\n        } else {\n          throw e;\n        }\n      }\n      Object.keys(resolvedDependenciesMap).forEach((key) => {\n        modelMap[key] = resolvedDependenciesMap[key] as DTDL;\n      });\n      const promiseList: Promise<void>[] = [];\n      Object.values(resolvedDependenciesMap).forEach((dependencyModel) => {\n        promiseList.push(this._expand(dependencyModel as DTDL, modelMap, tryFromExpanded));\n      });\n      await Promise.all(promiseList);\n    }\n  }\n\n  private _getModelDependencies(model: DTDL): string[] {\n    const dependencies = [];\n\n    if (model.contents !== undefined) {\n      const contents = model.contents;\n      contents.forEach((element) => {\n        if (\n          element[\"@type\"] &&\n          typeof element[\"@type\"] === \"string\" &&\n          element[\"@type\"] === \"Component\"\n        ) {\n          if (element.schema && typeof element.schema === \"string\") {\n            dependencies.push(element.schema);\n          }\n        }\n      });\n    }\n\n    if (model.extends !== undefined) {\n      if (typeof model.extends === \"string\") {\n        dependencies.push(model.extends);\n      } else if (Array.isArray(model.extends)) {\n        model.extends.forEach((element) => {\n          if (typeof element === \"string\") {\n            dependencies.push(element);\n          } else if (typeof element === \"object\") {\n            dependencies.push(this._getModelDependencies(element));\n          }\n        });\n      }\n    }\n\n    const noDuplicates = Array.from(new Set(dependencies));\n    return noDuplicates;\n  }\n}\n"]}