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

package/dist/browser/psuedoParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"psuedoParser.js","sourceRoot":"","sources":["../../src/psuedoParser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,MAAM,OAAO,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,MAAM,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,MAAM,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,SAAS,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","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"]}

package/dist/browser/utils/constants.d.ts

@@ -0,0 +1,8 @@
+export declare const SDK_VERSION: string;
+export declare const DEFAULT_USER_AGENT: string;
+export declare const DEFAULT_REPOSITORY_LOCATION = "https://devicemodels.azure.com";
+export declare const DEFAULT_API_VERSION = "2021-02-11";
+export declare const DEPENDENCY_MODE_DISABLED = "disabled";
+export declare const DEPENDENCY_MODE_ENABLED = "enabled";
+export declare const DEPENDENCY_MODE_TRY_FROM_EXPANDED = "tryFromExpanded";
+//# sourceMappingURL=constants.d.ts.map

package/dist/browser/utils/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/utils/constants.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,WAAW,EAAE,MAAuB,CAAC;AAClD,eAAO,MAAM,kBAAkB,QAAoE,CAAC;AACpG,eAAO,MAAM,2BAA2B,mCAAmC,CAAC;AAC5E,eAAO,MAAM,mBAAmB,eAAe,CAAC;AAEhD,eAAO,MAAM,wBAAwB,aAAa,CAAC;AACnD,eAAO,MAAM,uBAAuB,YAAY,CAAC;AACjD,eAAO,MAAM,iCAAiC,oBAAoB,CAAC"}

package/dist/browser/utils/path-browser.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-browser.d.mts","sourceRoot":"","sources":["../../../src/utils/path-browser.mts"],"names":[],"mappings":"AAGA,wBAAgB,WAAW,IAAI,OAAO,CAErC;AAED,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE9C"}

package/dist/browser/utils/path-browser.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"path-browser.mjs","sourceRoot":"","sources":["../../../src/utils/path-browser.mts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,MAAM,UAAU,WAAW;IACzB,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,OAAO,IAAI,CAAC;AACd,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nexport function isLocalPath(): boolean {\n  return false;\n}\n\nexport function normalize(text: string): string {\n  return text;\n}\n"]}

package/dist/browser/utils/path.d.ts

@@ -0,0 +1,3 @@
+export declare function isLocalPath(): boolean;
+export declare function normalize(text: string): string;
+//# sourceMappingURL=path-browser.d.mts.map

package/{dist-esm/src/utils/path.browser.js → dist/browser/utils/path.js}

@@ -6,4 +6,4 @@ export function isLocalPath() {
 export function normalize(text) {
     return text;
 }
-//# sourceMappingURL=path.browser.js.map
+//# sourceMappingURL=path-browser.mjs.map

package/dist/commonjs/dependencyResolutionType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * either dependency resolution is disabled, and only the client will get only the model linked to the dtmi,
+ * it is enabled, and the client will resolve all dependency models linked to the dtmi within the endpoint,
+ * or it is set to tryFromExpanded, where the client will attempt to get the expanded JSON format from the endpoint,
+ * and in the event of failure will fallback on the standard enabled dependency resolution.
+ *
+ */
+export type dependencyResolutionType = "disabled" | "enabled" | "tryFromExpanded";
+//# sourceMappingURL=dependencyResolutionType.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dependencyResolutionType.d.ts","sourceRoot":"","sources":["../../src/dependencyResolutionType.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,MAAM,MAAM,wBAAwB,GAAG,UAAU,GAAG,SAAS,GAAG,iBAAiB,CAAC"}

package/dist/commonjs/dependencyResolutionType.js

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

package/dist/commonjs/dependencyResolutionType.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dependencyResolutionType.js","sourceRoot":"","sources":["../../src/dependencyResolutionType.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * either dependency resolution is disabled, and only the client will get only the model linked to the dtmi,\n * it is enabled, and the client will resolve all dependency models linked to the dtmi within the endpoint,\n * or it is set to tryFromExpanded, where the client will attempt to get the expanded JSON format from the endpoint,\n * and in the event of failure will fallback on the standard enabled dependency resolution.\n *\n */\nexport type dependencyResolutionType = \"disabled\" | \"enabled\" | \"tryFromExpanded\";\n"]}

package/dist/commonjs/dtmiConventions.d.ts

@@ -0,0 +1,25 @@
+/**
+ * isValidDtmi validates if a given dtmi matches the convention.
+ * This is based on the DTMI spec:
+ * https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier
+ *
+ * @param dtmi - digital twins model identifier string
+ */
+export declare function isValidDtmi(dtmi: string): boolean;
+/**
+ * Given the dtmi and repository uri, will get a fully qualified model uri.
+ *
+ * @param dtmi - digital twins model identifier string
+ * @param repositoryUri - base URI for repository
+ * @param expanded - is the Model URI .json or .expanded.json
+ */
+export declare function getModelUri(dtmi: string, repositoryUri: string, expanded?: boolean): string;
+/**
+ * convertDtmiToPath converts a given dtmi string to a path.
+ *
+ * @param dtmi - digital twins model identifier string
+ * @param expanded - is the Model URI .json or .expanded.json
+ * @internal
+ */
+export declare function convertDtmiToPath(dtmi: string, expanded: boolean): string;
+//# sourceMappingURL=dtmiConventions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dtmiConventions.d.ts","sourceRoot":"","sources":["../../src/dtmiConventions.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAKjD;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CACzB,IAAI,EAAE,MAAM,EACZ,aAAa,EAAE,MAAM,EACrB,QAAQ,GAAE,OAAe,GACxB,MAAM,CAMR;AAED;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,GAAG,MAAM,CAczE"}

package/dist/commonjs/dtmiConventions.js

@@ -0,0 +1,57 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDtmi = isValidDtmi;
+exports.getModelUri = getModelUri;
+exports.convertDtmiToPath = convertDtmiToPath;
+/**
+ * isValidDtmi validates if a given dtmi matches the convention.
+ * This is based on the DTMI spec:
+ * https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier
+ *
+ * @param dtmi - digital twins model identifier string
+ */
+function isValidDtmi(dtmi) {
+    if (typeof dtmi !== "string")
+        return false;
+    const re = /^dtmi:[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?(?::[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?)*;[1-9][0-9]{0,8}$/;
+    return re.test(dtmi); // true if dtmi matches regular expression, false otherwise
+}
+/**
+ * Given the dtmi and repository uri, will get a fully qualified model uri.
+ *
+ * @param dtmi - digital twins model identifier string
+ * @param repositoryUri - base URI for repository
+ * @param expanded - is the Model URI .json or .expanded.json
+ */
+function getModelUri(dtmi, repositoryUri, expanded = false) {
+    if (!repositoryUri.endsWith("/")) {
+        repositoryUri = repositoryUri.concat("/");
+    }
+    const modelUri = repositoryUri + convertDtmiToPath(dtmi, expanded);
+    return modelUri;
+}
+/**
+ * convertDtmiToPath converts a given dtmi string to a path.
+ *
+ * @param dtmi - digital twins model identifier string
+ * @param expanded - is the Model URI .json or .expanded.json
+ * @internal
+ */
+function convertDtmiToPath(dtmi, expanded) {
+    // presently this dtmi to path function does not return the path with a
+    // file format at the end, i.e. does not append .json or .expanded.json.
+    // that happens in the dtmiToQualifiedPath function
+    if (isValidDtmi(dtmi)) {
+        let thePath = `${dtmi.toLowerCase().replace(/:/gm, "/").replace(/;/gm, "-")}.json`;
+        if (expanded) {
+            thePath = thePath.replace(".json", ".expanded.json");
+        }
+        return thePath;
+    }
+    else {
+        throw new Error("DTMI provided is invalid. Ensure it follows DTMI conventions.");
+    }
+}
+//# sourceMappingURL=dtmiConventions.js.map

package/dist/commonjs/dtmiConventions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dtmiConventions.js","sourceRoot":"","sources":["../../src/dtmiConventions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;AASlC,kCAKC;AASD,kCAUC;AASD,8CAcC;AAtDD;;;;;;GAMG;AACH,SAAgB,WAAW,CAAC,IAAY;IACtC,IAAI,OAAO,IAAI,KAAK,QAAQ;QAAE,OAAO,KAAK,CAAC;IAC3C,MAAM,EAAE,GACN,yGAAyG,CAAC;IAC5G,OAAO,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,2DAA2D;AACnF,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,WAAW,CACzB,IAAY,EACZ,aAAqB,EACrB,WAAoB,KAAK;IAEzB,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACjC,aAAa,GAAG,aAAa,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IAC5C,CAAC;IACD,MAAM,QAAQ,GAAG,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IACnE,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAAC,IAAY,EAAE,QAAiB;IAC/D,uEAAuE;IACvE,wEAAwE;IACxE,mDAAmD;IAEnD,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,IAAI,OAAO,GAAG,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC;QACnF,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;QACvD,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAC;IACnF,CAAC;AACH,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * isValidDtmi validates if a given dtmi matches the convention.\n * This is based on the DTMI spec:\n * https://github.com/Azure/opendigitaltwins-dtdl/blob/master/DTDL/v2/dtdlv2.md#digital-twin-model-identifier\n *\n * @param dtmi - digital twins model identifier string\n */\nexport function isValidDtmi(dtmi: string): boolean {\n  if (typeof dtmi !== \"string\") return false;\n  const re =\n    /^dtmi:[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?(?::[A-Za-z](?:[A-Za-z0-9_]*[A-Za-z0-9])?)*;[1-9][0-9]{0,8}$/;\n  return re.test(dtmi); // true if dtmi matches regular expression, false otherwise\n}\n\n/**\n * Given the dtmi and repository uri, will get a fully qualified model uri.\n *\n * @param dtmi - digital twins model identifier string\n * @param repositoryUri - base URI for repository\n * @param expanded - is the Model URI .json or .expanded.json\n */\nexport function getModelUri(\n  dtmi: string,\n  repositoryUri: string,\n  expanded: boolean = false,\n): string {\n  if (!repositoryUri.endsWith(\"/\")) {\n    repositoryUri = repositoryUri.concat(\"/\");\n  }\n  const modelUri = repositoryUri + convertDtmiToPath(dtmi, expanded);\n  return modelUri;\n}\n\n/**\n * convertDtmiToPath converts a given dtmi string to a path.\n *\n * @param dtmi - digital twins model identifier string\n * @param expanded - is the Model URI .json or .expanded.json\n * @internal\n */\nexport function convertDtmiToPath(dtmi: string, expanded: boolean): string {\n  // presently this dtmi to path function does not return the path with a\n  // file format at the end, i.e. does not append .json or .expanded.json.\n  // that happens in the dtmiToQualifiedPath function\n\n  if (isValidDtmi(dtmi)) {\n    let thePath = `${dtmi.toLowerCase().replace(/:/gm, \"/\").replace(/;/gm, \"-\")}.json`;\n    if (expanded) {\n      thePath = thePath.replace(\".json\", \".expanded.json\");\n    }\n    return thePath;\n  } else {\n    throw new Error(\"DTMI provided is invalid. Ensure it follows DTMI conventions.\");\n  }\n}\n"]}

package/dist/commonjs/dtmiResolver.d.ts

@@ -0,0 +1,20 @@
+import type { OperationOptions } from "@azure/core-client";
+import type { DTDL } from "./psuedoDtdl.js";
+import type { Fetcher } from "./fetcherAbstract.js";
+/**
+ * DtmiResolver handles reformatting the DTMIs to paths and passing options
+ * down to the configured fetcher. It is almost like a middle man between the
+ * user-facing API and the PsuedoParser (which identifies if there are sub-dependencies
+ * to resolve), and the configured fetcher, which will go out to the endpoint,
+ * either in the filesystem or through a URI, and actually get the model we want.
+ *
+ * @internal
+ */
+export declare class DtmiResolver {
+    private _fetcher;
+    constructor(fetcher: Fetcher);
+    resolve(dtmis: string[], expandedModel: boolean, options?: OperationOptions): Promise<{
+        [dtmi: string]: DTDL;
+    }>;
+}
+//# sourceMappingURL=dtmiResolver.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"dtmiResolver.d.ts","sourceRoot":"","sources":["../../src/dtmiResolver.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGpD;;;;;;;;GAQG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAU;gBACd,OAAO,EAAE,OAAO;IAItB,OAAO,CACX,KAAK,EAAE,MAAM,EAAE,EACf,aAAa,EAAE,OAAO,EACtB,OAAO,CAAC,EAAE,gBAAgB,GACzB,OAAO,CAAC;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC;CAiCrC"}

package/dist/commonjs/dtmiResolver.js

@@ -0,0 +1,55 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DtmiResolver = void 0;
+const dtmiConventions_js_1 = require("./dtmiConventions.js");
+const exceptions_js_1 = require("./exceptions.js");
+const logger_js_1 = require("./logger.js");
+/**
+ * DtmiResolver handles reformatting the DTMIs to paths and passing options
+ * down to the configured fetcher. It is almost like a middle man between the
+ * user-facing API and the PsuedoParser (which identifies if there are sub-dependencies
+ * to resolve), and the configured fetcher, which will go out to the endpoint,
+ * either in the filesystem or through a URI, and actually get the model we want.
+ *
+ * @internal
+ */
+class DtmiResolver {
+    constructor(fetcher) {
+        this._fetcher = fetcher;
+    }
+    async resolve(dtmis, expandedModel, options) {
+        const modelMap = {};
+        const dtdlPromises = dtmis.map(async (dtmi) => {
+            const dtdlPath = (0, dtmiConventions_js_1.convertDtmiToPath)(dtmi, expandedModel);
+            logger_js_1.logger.info(`Model ${dtmi} located in repository at ${dtdlPath}`);
+            const dtdl = await this._fetcher.fetch(dtdlPath, options);
+            if (expandedModel) {
+                if (Array.isArray(dtdl)) {
+                    const modelIds = dtdl.map((model) => model["@id"]);
+                    if (!modelIds.includes(dtmi)) {
+                        throw new exceptions_js_1.ModelError(`DTMI mismatch on expanded DTDL - Request: ${dtmi}, Response: ${modelIds}`);
+                    }
+                    for (const model of dtdl) {
+                        modelMap[model["@id"]] = model;
+                    }
+                }
+                else {
+                    throw new exceptions_js_1.ModelError("Expanded format should always return an array of models.");
+                }
+            }
+            else {
+                const model = dtdl;
+                if (model["@id"] !== dtmi) {
+                    throw new exceptions_js_1.ModelError(`DTMI mismatch - Request: ${dtmi}, Response ${model["@id"]}`);
+                }
+                modelMap[`${dtmi}`] = model;
+            }
+        });
+        await Promise.all(dtdlPromises);
+        return modelMap;
+    }
+}
+exports.DtmiResolver = DtmiResolver;
+//# sourceMappingURL=dtmiResolver.js.map

package/dist/commonjs/dtmiResolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dtmiResolver.js","sourceRoot":"","sources":["../../src/dtmiResolver.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAIlC,6DAAyD;AACzD,mDAA6C;AAE7C,2CAAqC;AAErC;;;;;;;;GAQG;AACH,MAAa,YAAY;IAEvB,YAAY,OAAgB;QAC1B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,OAAO,CACX,KAAe,EACf,aAAsB,EACtB,OAA0B;QAE1B,MAAM,QAAQ,GAA6B,EAAE,CAAC;QAC9C,MAAM,YAAY,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,EAAE,EAAE;YAC5C,MAAM,QAAQ,GAAG,IAAA,sCAAiB,EAAC,IAAI,EAAE,aAAa,CAAC,CAAC;YACxD,kBAAM,CAAC,IAAI,CAAC,SAAS,IAAI,6BAA6B,QAAQ,EAAE,CAAC,CAAC;YAClE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;YAC1D,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;oBACxB,MAAM,QAAQ,GAAc,IAAe,CAAC,GAAG,CAAC,CAAC,KAAW,EAAE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;oBAC/E,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC7B,MAAM,IAAI,0BAAU,CAClB,6CAA6C,IAAI,eAAe,QAAQ,EAAE,CAC3E,CAAC;oBACJ,CAAC;oBACD,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE,CAAC;wBACzB,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,GAAG,KAAK,CAAC;oBACjC,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAI,0BAAU,CAAC,0DAA0D,CAAC,CAAC;gBACnF,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,KAAK,GAAG,IAAY,CAAC;gBAC3B,IAAI,KAAK,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;oBAC1B,MAAM,IAAI,0BAAU,CAAC,4BAA4B,IAAI,cAAc,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;gBACrF,CAAC;gBAED,QAAQ,CAAC,GAAG,IAAI,EAAE,CAAC,GAAG,KAAK,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAChC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AA3CD,oCA2CC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationOptions } from \"@azure/core-client\";\nimport type { DTDL } from \"./psuedoDtdl.js\";\nimport { convertDtmiToPath } from \"./dtmiConventions.js\";\nimport { ModelError } from \"./exceptions.js\";\nimport type { Fetcher } from \"./fetcherAbstract.js\";\nimport { logger } from \"./logger.js\";\n\n/**\n * DtmiResolver handles reformatting the DTMIs to paths and passing options\n * down to the configured fetcher. It is almost like a middle man between the\n * user-facing API and the PsuedoParser (which identifies if there are sub-dependencies\n * to resolve), and the configured fetcher, which will go out to the endpoint,\n * either in the filesystem or through a URI, and actually get the model we want.\n *\n * @internal\n */\nexport class DtmiResolver {\n  private _fetcher: Fetcher;\n  constructor(fetcher: Fetcher) {\n    this._fetcher = fetcher;\n  }\n\n  async resolve(\n    dtmis: string[],\n    expandedModel: boolean,\n    options?: OperationOptions,\n  ): Promise<{ [dtmi: string]: DTDL }> {\n    const modelMap: { [dtmi: string]: DTDL } = {};\n    const dtdlPromises = dtmis.map(async (dtmi) => {\n      const dtdlPath = convertDtmiToPath(dtmi, expandedModel);\n      logger.info(`Model ${dtmi} located in repository at ${dtdlPath}`);\n      const dtdl = await this._fetcher.fetch(dtdlPath, options);\n      if (expandedModel) {\n        if (Array.isArray(dtdl)) {\n          const modelIds: string[] = (dtdl as DTDL[]).map((model: DTDL) => model[\"@id\"]);\n          if (!modelIds.includes(dtmi)) {\n            throw new ModelError(\n              `DTMI mismatch on expanded DTDL - Request: ${dtmi}, Response: ${modelIds}`,\n            );\n          }\n          for (const model of dtdl) {\n            modelMap[model[\"@id\"]] = model;\n          }\n        } else {\n          throw new ModelError(\"Expanded format should always return an array of models.\");\n        }\n      } else {\n        const model = dtdl as DTDL;\n        if (model[\"@id\"] !== dtmi) {\n          throw new ModelError(`DTMI mismatch - Request: ${dtmi}, Response ${model[\"@id\"]}`);\n        }\n\n        modelMap[`${dtmi}`] = model;\n      }\n    });\n\n    await Promise.all(dtdlPromises);\n    return modelMap;\n  }\n}\n"]}

package/dist/commonjs/exceptions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * A ModelError will be thrown in the even the Model in the repo is malformed in some standard way.
+ */
+export declare class ModelError extends Error {
+    constructor(message: string);
+}
+//# sourceMappingURL=exceptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../src/exceptions.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAK5B"}

package/dist/commonjs/exceptions.js

@@ -0,0 +1,16 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ModelError = void 0;
+/**
+ * A ModelError will be thrown in the even the Model in the repo is malformed in some standard way.
+ */
+class ModelError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "ModelError";
+    }
+}
+exports.ModelError = ModelError;
+//# sourceMappingURL=exceptions.js.map

package/dist/commonjs/exceptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.js","sourceRoot":"","sources":["../../src/exceptions.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC;;GAEG;AACH,MAAa,UAAW,SAAQ,KAAK;IACnC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,IAAI,GAAG,YAAY,CAAC;IAC3B,CAAC;CACF;AAND,gCAMC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * A ModelError will be thrown in the even the Model in the repo is malformed in some standard way.\n */\nexport class ModelError extends Error {\n  constructor(message: string) {\n    super(message);\n\n    this.name = \"ModelError\";\n  }\n}\n"]}

package/dist/commonjs/fetcherAbstract.d.ts

@@ -0,0 +1,11 @@
+import type { OperationOptions } from "@azure/core-client";
+import type { DTDL } from "./psuedoDtdl.js";
+/**
+ * Base Interface for Fetchers, which fetch models from endpoints.
+ *
+ * @internal
+ */
+export interface Fetcher {
+    fetch(path: string, options?: OperationOptions): Promise<DTDL | DTDL[]>;
+}
+//# sourceMappingURL=fetcherAbstract.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherAbstract.d.ts","sourceRoot":"","sources":["../../src/fetcherAbstract.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;GAIG;AACH,MAAM,WAAW,OAAO;IACtB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC,CAAC;CACzE"}

package/dist/commonjs/fetcherAbstract.js

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

package/dist/commonjs/fetcherAbstract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherAbstract.js","sourceRoot":"","sources":["../../src/fetcherAbstract.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 { DTDL } from \"./psuedoDtdl.js\";\n\n/**\n * Base Interface for Fetchers, which fetch models from endpoints.\n *\n * @internal\n */\nexport interface Fetcher {\n  fetch(path: string, options?: OperationOptions): Promise<DTDL | DTDL[]>;\n}\n"]}

package/dist/commonjs/fetcherFilesystem.d.ts

@@ -0,0 +1,14 @@
+import type { Fetcher } from "./fetcherAbstract.js";
+import type { DTDL } from "./psuedoDtdl.js";
+/**
+ * The Filesystem Fetcher implements the generic Fetcher interface
+ * so that models are fetched from a filesystem endpoint.
+ *
+ * @internal
+ */
+export declare class FilesystemFetcher implements Fetcher {
+    private _baseFilePath;
+    constructor(baseFilePath: string);
+    fetch(filePath: string): Promise<DTDL | DTDL[]>;
+}
+//# sourceMappingURL=fetcherFilesystem.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherFilesystem.d.ts","sourceRoot":"","sources":["../../src/fetcherFilesystem.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAEpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAe5C;;;;;GAKG;AACH,qBAAa,iBAAkB,YAAW,OAAO;IAC/C,OAAO,CAAC,aAAa,CAAS;gBAElB,YAAY,EAAE,MAAM;IAI1B,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC;CAoBtD"}

package/dist/commonjs/fetcherFilesystem.js

@@ -0,0 +1,56 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FilesystemFetcher = void 0;
+const tslib_1 = require("tslib");
+const node_fs_1 = tslib_1.__importDefault(require("node:fs"));
+const path = tslib_1.__importStar(require("node:path"));
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+const logger_js_1 = require("./logger.js");
+function readFilePromise(filePath) {
+    return new Promise((resolve, reject) => {
+        node_fs_1.default.readFile(filePath, "utf8", (err, data) => {
+            if (err !== undefined) {
+                reject(err);
+            }
+            else {
+                resolve(data);
+            }
+            return 0;
+        });
+    });
+}
+/**
+ * The Filesystem Fetcher implements the generic Fetcher interface
+ * so that models are fetched from a filesystem endpoint.
+ *
+ * @internal
+ */
+class FilesystemFetcher {
+    constructor(baseFilePath) {
+        this._baseFilePath = baseFilePath;
+    }
+    async fetch(filePath) {
+        logger_js_1.logger.info(`Fetching ${filePath} from local filesystem`);
+        const absolutePath = path.join(this._baseFilePath, filePath);
+        if (absolutePath.indexOf(this._baseFilePath) !== 0) {
+            throw new Error("Attempted to escape base file path");
+        }
+        try {
+            logger_js_1.logger.info(`File open on ${absolutePath}`);
+            const dtdlFile = await readFilePromise(absolutePath);
+            const parsedDtdl = JSON.parse(dtdlFile);
+            return parsedDtdl;
+        }
+        catch (e) {
+            const options = {
+                code: "ResourceNotFound",
+                statusCode: e === null || e === void 0 ? void 0 : e.status,
+            };
+            throw new core_rest_pipeline_1.RestError("Failed to fetch from Filesystem", options);
+        }
+    }
+}
+exports.FilesystemFetcher = FilesystemFetcher;
+//# sourceMappingURL=fetcherFilesystem.js.map

package/dist/commonjs/fetcherFilesystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherFilesystem.js","sourceRoot":"","sources":["../../src/fetcherFilesystem.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAElC,8DAAyB;AACzB,wDAAkC;AAElC,kEAAsD;AAEtD,2CAAqC;AAGrC,SAAS,eAAe,CAAC,QAAgB;IACvC,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,iBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;YAC1C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACtB,MAAM,CAAC,GAAG,CAAC,CAAC;YACd,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC;YACD,OAAO,CAAC,CAAC;QACX,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAa,iBAAiB;IAG5B,YAAY,YAAoB;QAC9B,IAAI,CAAC,aAAa,GAAG,YAAY,CAAC;IACpC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,QAAgB;QAC1B,kBAAM,CAAC,IAAI,CAAC,YAAY,QAAQ,wBAAwB,CAAC,CAAC;QAC1D,MAAM,YAAY,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC;QAC7D,IAAI,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;YACnD,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,CAAC;YACH,kBAAM,CAAC,IAAI,CAAC,gBAAgB,YAAY,EAAE,CAAC,CAAC;YAC5C,MAAM,QAAQ,GAAG,MAAM,eAAe,CAAC,YAAY,CAAC,CAAC;YACrD,MAAM,UAAU,GAAkB,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACvD,OAAO,UAAU,CAAC;QACpB,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YAChB,MAAM,OAAO,GAAqB;gBAChC,IAAI,EAAE,kBAAkB;gBACxB,UAAU,EAAE,CAAC,aAAD,CAAC,uBAAD,CAAC,CAAE,MAAM;aACtB,CAAC;YACF,MAAM,IAAI,8BAAS,CAAC,iCAAiC,EAAE,OAAO,CAAC,CAAC;QAClE,CAAC;IACH,CAAC;CACF;AA3BD,8CA2BC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport fs from \"node:fs\";\nimport * as path from \"node:path\";\nimport type { RestErrorOptions } from \"@azure/core-rest-pipeline\";\nimport { RestError } from \"@azure/core-rest-pipeline\";\nimport type { Fetcher } from \"./fetcherAbstract.js\";\nimport { logger } from \"./logger.js\";\nimport type { DTDL } from \"./psuedoDtdl.js\";\n\nfunction readFilePromise(filePath: string): Promise<string> {\n  return new Promise((resolve, reject) => {\n    fs.readFile(filePath, \"utf8\", (err, data) => {\n      if (err !== undefined) {\n        reject(err);\n      } else {\n        resolve(data);\n      }\n      return 0;\n    });\n  });\n}\n\n/**\n * The Filesystem Fetcher implements the generic Fetcher interface\n * so that models are fetched from a filesystem endpoint.\n *\n * @internal\n */\nexport class FilesystemFetcher implements Fetcher {\n  private _baseFilePath: string;\n\n  constructor(baseFilePath: string) {\n    this._baseFilePath = baseFilePath;\n  }\n\n  async fetch(filePath: string): Promise<DTDL | DTDL[]> {\n    logger.info(`Fetching ${filePath} from local filesystem`);\n    const absolutePath = path.join(this._baseFilePath, filePath);\n    if (absolutePath.indexOf(this._baseFilePath) !== 0) {\n      throw new Error(\"Attempted to escape base file path\");\n    }\n\n    try {\n      logger.info(`File open on ${absolutePath}`);\n      const dtdlFile = await readFilePromise(absolutePath);\n      const parsedDtdl: DTDL | DTDL[] = JSON.parse(dtdlFile);\n      return parsedDtdl;\n    } catch (e: any) {\n      const options: RestErrorOptions = {\n        code: \"ResourceNotFound\",\n        statusCode: e?.status,\n      };\n      throw new RestError(\"Failed to fetch from Filesystem\", options);\n    }\n  }\n}\n"]}

package/dist/commonjs/fetcherHTTP.d.ts

@@ -0,0 +1,16 @@
+import type { OperationOptions, ServiceClient } from "@azure/core-client";
+import type { Fetcher } from "./fetcherAbstract.js";
+import type { DTDL } from "./psuedoDtdl.js";
+/**
+ * The HTTP Fetcher implements the Fetcher interface to
+ * retrieve models through HTTP calls.
+ *
+ * @internal
+ */
+export declare class HttpFetcher implements Fetcher {
+    private _client;
+    private _baseURL;
+    constructor(baseURL: string, client: ServiceClient);
+    fetch(path: string, options?: OperationOptions): Promise<DTDL | DTDL[]>;
+}
+//# sourceMappingURL=fetcherHTTP.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherHTTP.d.ts","sourceRoot":"","sources":["../../src/fetcherHTTP.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,gBAAgB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAS1E,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAE5C;;;;;GAKG;AACH,qBAAa,WAAY,YAAW,OAAO;IACzC,OAAO,CAAC,OAAO,CAAgB;IAC/B,OAAO,CAAC,QAAQ,CAAS;gBAGb,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa;IAK5C,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,EAAE,CAAC;CAiC9E"}

package/dist/commonjs/fetcherHTTP.js

@@ -0,0 +1,56 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpFetcher = void 0;
+const core_rest_pipeline_1 = require("@azure/core-rest-pipeline");
+const logger_js_1 = require("./logger.js");
+/**
+ * The HTTP Fetcher implements the Fetcher interface to
+ * retrieve models through HTTP calls.
+ *
+ * @internal
+ */
+class HttpFetcher {
+    // eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters
+    constructor(baseURL, client) {
+        this._client = client;
+        this._baseURL = baseURL;
+    }
+    async fetch(path, options) {
+        var _a, _b;
+        logger_js_1.logger.info(`Fetching ${path} from remote endpoint`);
+        if (!options) {
+            options = {};
+        }
+        const myURL = this._baseURL + "/" + path;
+        const requestMethod = "GET";
+        const requestHeader = (0, core_rest_pipeline_1.createHttpHeaders)((_a = options.requestOptions) === null || _a === void 0 ? void 0 : _a.customHeaders);
+        const requestOptions = {
+            url: myURL,
+            method: requestMethod,
+            headers: requestHeader,
+            timeout: (_b = options.requestOptions) === null || _b === void 0 ? void 0 : _b.timeout,
+            abortSignal: options.abortSignal,
+            tracingOptions: options.tracingOptions,
+            allowInsecureConnection: true,
+        };
+        const request = (0, core_rest_pipeline_1.createPipelineRequest)(requestOptions);
+        const res = await this._client.sendRequest(request);
+        if (res.status >= 200 && res.status < 400) {
+            const dtdlAsString = res.bodyAsText || "";
+            const parsedDtdl = JSON.parse(dtdlAsString);
+            return parsedDtdl;
+        }
+        else {
+            throw new core_rest_pipeline_1.RestError("Error on HTTP Request in remote model fetcher", {
+                code: "ResourceNotFound",
+                statusCode: res.status,
+                response: res,
+                request: request,
+            });
+        }
+    }
+}
+exports.HttpFetcher = HttpFetcher;
+//# sourceMappingURL=fetcherHTTP.js.map

package/dist/commonjs/fetcherHTTP.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetcherHTTP.js","sourceRoot":"","sources":["../../src/fetcherHTTP.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AASlC,kEAAgG;AAChG,2CAAqC;AAIrC;;;;;GAKG;AACH,MAAa,WAAW;IAItB,wEAAwE;IACxE,YAAY,OAAe,EAAE,MAAqB;QAChD,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAC1B,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,OAA0B;;QAClD,kBAAM,CAAC,IAAI,CAAC,YAAY,IAAI,uBAAuB,CAAC,CAAC;QACrD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,GAAG,GAAG,GAAG,IAAI,CAAC;QACzC,MAAM,aAAa,GAAgB,KAAK,CAAC;QACzC,MAAM,aAAa,GAAgB,IAAA,sCAAiB,EAAC,MAAA,OAAO,CAAC,cAAc,0CAAE,aAAa,CAAC,CAAC;QAC5F,MAAM,cAAc,GAAG;YACrB,GAAG,EAAE,KAAK;YACV,MAAM,EAAE,aAAa;YACrB,OAAO,EAAE,aAAa;YACtB,OAAO,EAAE,MAAA,OAAO,CAAC,cAAc,0CAAE,OAAO;YACxC,WAAW,EAAE,OAAO,CAAC,WAAW;YAChC,cAAc,EAAE,OAAO,CAAC,cAAc;YACtC,uBAAuB,EAAE,IAAI;SAC9B,CAAC;QACF,MAAM,OAAO,GAAoB,IAAA,0CAAqB,EAAC,cAAc,CAAC,CAAC;QACvE,MAAM,GAAG,GAAqB,MAAM,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC;QAEtE,IAAI,GAAG,CAAC,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC1C,MAAM,YAAY,GAAG,GAAG,CAAC,UAAU,IAAI,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAkB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;YAC3D,OAAO,UAAU,CAAC;QACpB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,8BAAS,CAAC,+CAA+C,EAAE;gBACnE,IAAI,EAAE,kBAAkB;gBACxB,UAAU,EAAE,GAAG,CAAC,MAAM;gBACtB,QAAQ,EAAE,GAAG;gBACb,OAAO,EAAE,OAAO;aACjB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;CACF;AA3CD,kCA2CC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { OperationOptions, ServiceClient } from \"@azure/core-client\";\nimport type {\n  HttpHeaders,\n  HttpMethods,\n  PipelineRequest,\n  PipelineResponse,\n} from \"@azure/core-rest-pipeline\";\nimport { createHttpHeaders, createPipelineRequest, RestError } from \"@azure/core-rest-pipeline\";\nimport { logger } from \"./logger.js\";\nimport type { Fetcher } from \"./fetcherAbstract.js\";\nimport type { DTDL } from \"./psuedoDtdl.js\";\n\n/**\n * The HTTP Fetcher implements the Fetcher interface to\n * retrieve models through HTTP calls.\n *\n * @internal\n */\nexport class HttpFetcher implements Fetcher {\n  private _client: ServiceClient;\n  private _baseURL: string;\n\n  // eslint-disable-next-line @azure/azure-sdk/ts-use-interface-parameters\n  constructor(baseURL: string, client: ServiceClient) {\n    this._client = client;\n    this._baseURL = baseURL;\n  }\n\n  async fetch(path: string, options?: OperationOptions): Promise<DTDL | DTDL[]> {\n    logger.info(`Fetching ${path} from remote endpoint`);\n    if (!options) {\n      options = {};\n    }\n    const myURL = this._baseURL + \"/\" + path;\n    const requestMethod: HttpMethods = \"GET\";\n    const requestHeader: HttpHeaders = createHttpHeaders(options.requestOptions?.customHeaders);\n    const requestOptions = {\n      url: myURL,\n      method: requestMethod,\n      headers: requestHeader,\n      timeout: options.requestOptions?.timeout,\n      abortSignal: options.abortSignal,\n      tracingOptions: options.tracingOptions,\n      allowInsecureConnection: true,\n    };\n    const request: PipelineRequest = createPipelineRequest(requestOptions);\n    const res: PipelineResponse = await this._client.sendRequest(request);\n\n    if (res.status >= 200 && res.status < 400) {\n      const dtdlAsString = res.bodyAsText || \"\";\n      const parsedDtdl: DTDL | DTDL[] = JSON.parse(dtdlAsString);\n      return parsedDtdl;\n    } else {\n      throw new RestError(\"Error on HTTP Request in remote model fetcher\", {\n        code: \"ResourceNotFound\",\n        statusCode: res.status,\n        response: res,\n        request: request,\n      });\n    }\n  }\n}\n"]}

package/dist/commonjs/index.d.ts

@@ -0,0 +1,41 @@
+/**
+ * This is the ModelsRepositoryClient Library for JavaScript.
+ *
+ * @remarks
+ * This ModelsRepositoryClient is built around getting DTDL Models from a user-specified
+ * location. The two main variables are the repositoryLocation, which is a path or URI to either a remote
+ * or local repository where the models are located, and the dtmis, which can be one or more dtmis that
+ * will be mapped to specific models contained in the repository location that the user wishes to get.
+ *
+ * @example
+ * Inline code:
+ * ```typescript
+ * import lib
+ * import {ModelsRepositoryClient} from "../../../src";
+ *
+ * const repositoryEndpoint = "devicemodels.azure.com";
+ * const dtmi = process.argv[2] || "dtmi:azure:DeviceManagement:DeviceInformation;1";
+ *
+ * console.log(repositoryEndpoint, dtmi);
+ *
+ * async function main() {
+ *   const client = new ModelsRepositoryClient({repositoryLocation: repositoryEndpoint});
+ *   const result = await client.getModels(dtmi, {dependencyResolution: 'tryFromExpanded'});
+ *   console.log(result);
+ * }
+ *
+ * main().catch((err) => {
+ *   console.error("The sample encountered an error:", err);
+ * });
+ *
+ * ```
+ *
+ * @packageDocumentation
+ */
+export { ModelsRepositoryClient } from "./modelsRepositoryClient.js";
+export { GetModelsOptions } from "./interfaces/getModelsOptions.js";
+export { ModelsRepositoryClientOptions } from "./interfaces/modelsRepositoryClientOptions.js";
+export { dependencyResolutionType } from "./dependencyResolutionType.js";
+export { ModelError } from "./exceptions.js";
+export { getModelUri, isValidDtmi } from "./dtmiConventions.js";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,6BAA6B,EAAE,MAAM,+CAA+C,CAAC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/commonjs/index.js

@@ -0,0 +1,47 @@
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isValidDtmi = exports.getModelUri = exports.ModelError = exports.ModelsRepositoryClient = void 0;
+/**
+ * This is the ModelsRepositoryClient Library for JavaScript.
+ *
+ * @remarks
+ * This ModelsRepositoryClient is built around getting DTDL Models from a user-specified
+ * location. The two main variables are the repositoryLocation, which is a path or URI to either a remote
+ * or local repository where the models are located, and the dtmis, which can be one or more dtmis that
+ * will be mapped to specific models contained in the repository location that the user wishes to get.
+ *
+ * @example
+ * Inline code:
+ * ```typescript
+ * import lib
+ * import {ModelsRepositoryClient} from "../../../src";
+ *
+ * const repositoryEndpoint = "devicemodels.azure.com";
+ * const dtmi = process.argv[2] || "dtmi:azure:DeviceManagement:DeviceInformation;1";
+ *
+ * console.log(repositoryEndpoint, dtmi);
+ *
+ * async function main() {
+ *   const client = new ModelsRepositoryClient({repositoryLocation: repositoryEndpoint});
+ *   const result = await client.getModels(dtmi, {dependencyResolution: 'tryFromExpanded'});
+ *   console.log(result);
+ * }
+ *
+ * main().catch((err) => {
+ *   console.error("The sample encountered an error:", err);
+ * });
+ *
+ * ```
+ *
+ * @packageDocumentation
+ */
+var modelsRepositoryClient_js_1 = require("./modelsRepositoryClient.js");
+Object.defineProperty(exports, "ModelsRepositoryClient", { enumerable: true, get: function () { return modelsRepositoryClient_js_1.ModelsRepositoryClient; } });
+var exceptions_js_1 = require("./exceptions.js");
+Object.defineProperty(exports, "ModelError", { enumerable: true, get: function () { return exceptions_js_1.ModelError; } });
+var dtmiConventions_js_1 = require("./dtmiConventions.js");
+Object.defineProperty(exports, "getModelUri", { enumerable: true, get: function () { return dtmiConventions_js_1.getModelUri; } });
+Object.defineProperty(exports, "isValidDtmi", { enumerable: true, get: function () { return dtmiConventions_js_1.isValidDtmi; } });
+//# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAEH,yEAAqE;AAA5D,mIAAA,sBAAsB,OAAA;AAI/B,iDAA6C;AAApC,2GAAA,UAAU,OAAA;AACnB,2DAAgE;AAAvD,iHAAA,WAAW,OAAA;AAAE,iHAAA,WAAW,OAAA","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * This is the ModelsRepositoryClient Library for JavaScript.\n *\n * @remarks\n * This ModelsRepositoryClient is built around getting DTDL Models from a user-specified\n * location. The two main variables are the repositoryLocation, which is a path or URI to either a remote\n * or local repository where the models are located, and the dtmis, which can be one or more dtmis that\n * will be mapped to specific models contained in the repository location that the user wishes to get.\n *\n * @example\n * Inline code:\n * ```typescript\n * import lib\n * import {ModelsRepositoryClient} from \"../../../src\";\n *\n * const repositoryEndpoint = \"devicemodels.azure.com\";\n * const dtmi = process.argv[2] || \"dtmi:azure:DeviceManagement:DeviceInformation;1\";\n *\n * console.log(repositoryEndpoint, dtmi);\n *\n * async function main() {\n *   const client = new ModelsRepositoryClient({repositoryLocation: repositoryEndpoint});\n *   const result = await client.getModels(dtmi, {dependencyResolution: 'tryFromExpanded'});\n *   console.log(result);\n * }\n *\n * main().catch((err) => {\n *   console.error(\"The sample encountered an error:\", err);\n * });\n *\n * ```\n *\n * @packageDocumentation\n */\n\nexport { ModelsRepositoryClient } from \"./modelsRepositoryClient.js\";\nexport { GetModelsOptions } from \"./interfaces/getModelsOptions.js\";\nexport { ModelsRepositoryClientOptions } from \"./interfaces/modelsRepositoryClientOptions.js\";\nexport { dependencyResolutionType } from \"./dependencyResolutionType.js\";\nexport { ModelError } from \"./exceptions.js\";\nexport { getModelUri, isValidDtmi } from \"./dtmiConventions.js\";\n"]}

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

@@ -0,0 +1,14 @@
+import type { OperationOptions } from "@azure/core-client";
+import type { dependencyResolutionType } from "../dependencyResolutionType.js";
+/**
+ * Options for getting models.
+ */
+export interface GetModelsOptions extends OperationOptions {
+    /**
+     * 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. This overwrites the default dependencyResolution settings of the client.
+     */
+    dependencyResolution?: dependencyResolutionType;
+}
+//# sourceMappingURL=getModelsOptions.d.ts.map