@azure/iot-modelsrepository 1.0.0-alpha.20241122.2 → 1.0.0-alpha.20241126.1

package/dist/commonjs/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.12"
+      "packageVersion": "7.48.0"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/iot-modelsrepository",
-  "version": "1.0.0-alpha.20241122.2",
+  "version": "1.0.0-alpha.20241126.1",
   "description": "Device Model Repository Library with typescript type definitions for node.js and browser.",
   "sdk-type": "client",
   "main": "./dist/commonjs/index.js",
@@ -57,7 +57,7 @@
   "prettier": "@azure/eslint-plugin-azure-sdk/prettier.json",
   "dependencies": {
     "@azure/core-client": "^1.9.2",
-    "@azure/core-rest-pipeline": ">=1.18.0-alpha <1.18.0-alphb",
+    "@azure/core-rest-pipeline": "^1.18.0",
     "@azure/core-tracing": "^1.2.0",
     "@azure/core-util": "^1.11.0",
     "@azure/logger": "^1.1.4",

package/dist/iot-modelsrepository.d.ts

@@ -1,173 +0,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
- */
-
-import type { CommonClientOptions } from '@azure/core-client';
-import type { OperationOptions } from '@azure/core-client';
-
-/**
- * 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 declare type dependencyResolutionType = "disabled" | "enabled" | "tryFromExpanded";
-
-/**
- * Options for getting models.
- */
-export declare 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;
-}
-
-/**
- * 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;
-
-/**
- * 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;
-
-/**
- * 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);
-}
-
-/**
- * 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;
-    }>;
-}
-
-/**
- * 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 declare 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;
-}
-
-export { }