@texturehq/device 1.3.0

package/README.md

@@ -0,0 +1,110 @@
+# @texturehq/device
+
+[![npm version](https://img.shields.io/npm/v/@texturehq/device.svg)](https://www.npmjs.com/package/@texturehq/device)
+
+A type-safe TypeScript client for working with device data in the Texture platform. This package provides strongly-typed interfaces and utilities for querying and validating device information, manufacturers, and device models.
+
+## Features
+
+- Type-safe API for querying device data
+- Comprehensive TypeScript definitions for all device-related entities
+- Built-in validation for device data structures
+- Utilities for working with manufacturers and device models
+- Full TypeScript support
+
+## Installation
+
+```bash
+npm install @texturehq/device
+# or
+yarn add @texturehq/device
+```
+
+## Usage
+
+### Querying Manufacturers
+
+```typescript
+import { getManufacturers, getManufacturer, Manufacturer } from "@texturehq/device";
+
+// Get all manufacturers
+const listManufacturers = async () => {
+  const response = await getManufacturers();
+  const manufacturers: Manufacturer[] = response.manufacturers;
+
+  // Work with strongly-typed manufacturer data
+  manufacturers.forEach(manufacturer => {
+    console.log(manufacturer.name, manufacturer.slug);
+  });
+};
+
+// Get a specific manufacturer
+const getSpecificManufacturer = async () => {
+  const manufacturer = await getManufacturer({ slug: "bmw" });
+  console.log(manufacturer.name, manufacturer.supportedRegions);
+};
+```
+
+### Working with Device Models
+
+```typescript
+import { getDeviceModels, getDeviceModel, DeviceModel } from "@texturehq/device";
+
+// Get all device models
+const listDeviceModels = async () => {
+  const response = await getDeviceModels();
+  const models: DeviceModel[] = response.deviceModels;
+
+  // Access strongly-typed model information
+  models.forEach(model => {
+    console.log(model.name, model.manufacturer, model.capabilities);
+  });
+};
+
+// Get a specific device model
+const getSpecificModel = async () => {
+  const model = await getDeviceModel({ slug: "i4-edrive40" });
+  console.log(model.name, model.specifications);
+};
+```
+
+## Available Types
+
+The package exports several TypeScript interfaces for working with device data:
+
+### Core Types
+- `Manufacturer` - Represents a device manufacturer
+- `DeviceModel` - Represents a specific model from a manufacturer
+- `Device` - Represents an individual device instance
+- `DeviceCapability` - Describes what a device can do
+- `Region` - Represents supported geographical regions
+
+### API Response Types
+- `ManufacturersResponse` - Response structure for manufacturer queries
+- `DeviceModelsResponse` - Response structure for device model queries
+
+## Error Handling
+
+All API methods can throw the following errors:
+
+```typescript
+import { DeviceError } from "@texturehq/device";
+
+try {
+  const manufacturer = await getManufacturer({ slug: "invalid-slug" });
+} catch (error) {
+  if (error instanceof DeviceError) {
+    // Handle device-specific errors
+    console.error(error.message, error.code);
+  } else {
+    // Handle other errors
+    console.error("Unexpected error", error);
+  }
+}
+```
+
+For more details on using this package and integrating with Texture's device ecosystem, consult [our documentation](https://docs.texturehq.com) or [contact us](https://www.texturehq.com/contact/).
+
+## License
+
+MIT

package/dist/common/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const PRODUCTION_CACHE_BASE_URL: "https://device.cms.texturehq.com";
+export declare const PRODUCTION_BASE_URL: "https://texturehq.payloadcms.app";
+//# sourceMappingURL=constants.d.ts.map

package/dist/common/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,oCAA8C,CAAC;AACrF,eAAO,MAAM,mBAAmB,oCAA8C,CAAC"}

package/dist/common/constants.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PRODUCTION_BASE_URL = exports.PRODUCTION_CACHE_BASE_URL = void 0;
+exports.PRODUCTION_CACHE_BASE_URL = "https://device.cms.texturehq.com";
+exports.PRODUCTION_BASE_URL = "https://texturehq.payloadcms.app";
+//# sourceMappingURL=constants.js.map

package/dist/common/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/common/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,yBAAyB,GAAG,kCAA2C,CAAC;AACxE,QAAA,mBAAmB,GAAG,kCAA2C,CAAC"}

package/dist/common/exceptions.d.ts

@@ -0,0 +1,5 @@
+export declare class NetworkError extends Error {
+    statusCode: number;
+    constructor(message: string, statusCode: number);
+}
+//# sourceMappingURL=exceptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.d.ts","sourceRoot":"","sources":["../../src/common/exceptions.ts"],"names":[],"mappings":"AAAA,qBAAa,YAAa,SAAQ,KAAK;IACrC,UAAU,EAAE,MAAM,CAAC;gBACP,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;CAKhD"}

package/dist/common/exceptions.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NetworkError = void 0;
+class NetworkError extends Error {
+    statusCode;
+    constructor(message, statusCode) {
+        super(message);
+        this.name = "NetworkError";
+        this.statusCode = statusCode;
+    }
+}
+exports.NetworkError = NetworkError;
+//# sourceMappingURL=exceptions.js.map

package/dist/common/exceptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"exceptions.js","sourceRoot":"","sources":["../../src/common/exceptions.ts"],"names":[],"mappings":";;;AAAA,MAAa,YAAa,SAAQ,KAAK;IACrC,UAAU,CAAS;IACnB,YAAY,OAAe,EAAE,UAAkB;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC;QAC3B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IAC/B,CAAC;CACF;AAPD,oCAOC"}

package/dist/common/logger.d.ts

@@ -0,0 +1,2 @@
+export declare const baseLogger: import("@texturehq/logger").FunctionLogger;
+//# sourceMappingURL=logger.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/common/logger.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,UAAU,4CAAgE,CAAC"}

package/dist/common/logger.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.baseLogger = void 0;
+const logger_1 = require("@texturehq/logger");
+exports.baseLogger = (0, logger_1.createLogger)({ name: "device-package" }).component("package");
+//# sourceMappingURL=logger.js.map

package/dist/common/logger.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../../src/common/logger.ts"],"names":[],"mappings":";;;AAAA,8CAAiD;AAEpC,QAAA,UAAU,GAAG,IAAA,qBAAY,EAAC,EAAE,IAAI,EAAE,gBAAgB,EAAE,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC"}

package/dist/common/supportLevel.d.ts

@@ -0,0 +1,6 @@
+import { z } from "zod";
+export declare const SupportLevels: readonly ["planned", "development", "uat", "production", "blocked"];
+export type SupportLevel = (typeof SupportLevels)[number];
+export declare const SupportLevelEnum: z.ZodEnum<["planned", "development", "uat", "production", "blocked"]>;
+export declare const SupportLevelLabelMap: Record<SupportLevel, string>;
+//# sourceMappingURL=supportLevel.d.ts.map

package/dist/common/supportLevel.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportLevel.d.ts","sourceRoot":"","sources":["../../src/common/supportLevel.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,aAAa,qEAAsE,CAAC;AACjG,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAC1D,eAAO,MAAM,gBAAgB,uEAAwB,CAAC;AAEtD,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,YAAY,EAAE,MAAM,CAM7D,CAAC"}

package/dist/common/supportLevel.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportLevelLabelMap = exports.SupportLevelEnum = exports.SupportLevels = void 0;
+const zod_1 = require("zod");
+exports.SupportLevels = ["planned", "development", "uat", "production", "blocked"];
+exports.SupportLevelEnum = zod_1.z.enum(exports.SupportLevels);
+exports.SupportLevelLabelMap = {
+    planned: "Planned",
+    blocked: "Blocked",
+    development: "Development",
+    uat: "User Acceptance Testing",
+    production: "Production",
+};
+//# sourceMappingURL=supportLevel.js.map

package/dist/common/supportLevel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"supportLevel.js","sourceRoot":"","sources":["../../src/common/supportLevel.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AAEX,QAAA,aAAa,GAAG,CAAC,SAAS,EAAE,aAAa,EAAE,KAAK,EAAE,YAAY,EAAE,SAAS,CAAU,CAAC;AAEpF,QAAA,gBAAgB,GAAG,OAAC,CAAC,IAAI,CAAC,qBAAa,CAAC,CAAC;AAEzC,QAAA,oBAAoB,GAAiC;IAChE,OAAO,EAAE,SAAS;IAClB,OAAO,EAAE,SAAS;IAClB,WAAW,EAAE,aAAa;IAC1B,GAAG,EAAE,yBAAyB;IAC9B,UAAU,EAAE,YAAY;CACzB,CAAC"}

package/dist/common/utils/index.d.ts

@@ -0,0 +1,2 @@
+export declare const fromGraphQLSafeString: (str: string) => string;
+//# sourceMappingURL=index.d.ts.map

package/dist/common/utils/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,qBAAqB,QAAS,MAAM,KAAG,MAEnD,CAAC"}

package/dist/common/utils/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fromGraphQLSafeString = void 0;
+const fromGraphQLSafeString = (str) => {
+    return str.replace(/__/g, ":").replace(/_/g, "-");
+};
+exports.fromGraphQLSafeString = fromGraphQLSafeString;
+//# sourceMappingURL=index.js.map

package/dist/common/utils/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/common/utils/index.ts"],"names":[],"mappings":";;;AAAO,MAAM,qBAAqB,GAAG,CAAC,GAAW,EAAU,EAAE;IACzD,OAAO,GAAG,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;AACtD,CAAC,CAAC;AAFW,QAAA,qBAAqB,yBAEhC"}

package/dist/common/utils/retryAxios.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import { Logger } from "@texturehq/logger";
+export interface RetryOptions {
+    /**
+     * The number of retries to attempt before failing.
+     * @default 3
+     */
+    retries?: number;
+}
+/**
+ * Configures axios instance with retry capabilities
+ * @param logger Logger instance to use for retry logging
+ * @param retryOptions Optional retry configuration
+ * @param axiosInstance Optional axios instance to configure (defaults to global axios)
+ * @returns The configured axios instance
+ */
+export declare function configureAxiosRetry(logger: Logger, retryOptions?: RetryOptions, axiosInstance?: AxiosInstance): AxiosInstance;
+//# sourceMappingURL=retryAxios.d.ts.map

package/dist/common/utils/retryAxios.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryAxios.d.ts","sourceRoot":"","sources":["../../../src/common/utils/retryAxios.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,aAAa,EAAE,MAAM,OAAO,CAAC;AAE7C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAE3C,MAAM,WAAW,YAAY;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,MAAM,EACd,YAAY,CAAC,EAAE,YAAY,EAC3B,aAAa,GAAE,aAAqB,GACnC,aAAa,CAgBf"}

package/dist/common/utils/retryAxios.js

@@ -0,0 +1,32 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.configureAxiosRetry = void 0;
+const axios_1 = __importDefault(require("axios"));
+const axios_retry_1 = __importDefault(require("axios-retry"));
+/**
+ * Configures axios instance with retry capabilities
+ * @param logger Logger instance to use for retry logging
+ * @param retryOptions Optional retry configuration
+ * @param axiosInstance Optional axios instance to configure (defaults to global axios)
+ * @returns The configured axios instance
+ */
+function configureAxiosRetry(logger, retryOptions, axiosInstance = axios_1.default) {
+    if (!retryOptions) {
+        return axiosInstance;
+    }
+    const retryConfig = {
+        retries: retryOptions.retries || 3,
+        retryDelay: axios_retry_1.default.exponentialDelay,
+        onRetry: (retryCount, error) => {
+            logger.warn("retryCount", { retryCount });
+            logger.warn("error", { error });
+        },
+    };
+    (0, axios_retry_1.default)(axiosInstance, retryConfig);
+    return axiosInstance;
+}
+exports.configureAxiosRetry = configureAxiosRetry;
+//# sourceMappingURL=retryAxios.js.map

package/dist/common/utils/retryAxios.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retryAxios.js","sourceRoot":"","sources":["../../../src/common/utils/retryAxios.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA6C;AAC7C,8DAA4D;AAW5D;;;;;;GAMG;AACH,SAAgB,mBAAmB,CACjC,MAAc,EACd,YAA2B,EAC3B,gBAA+B,eAAK;IAEpC,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,MAAM,WAAW,GAAsB;QACrC,OAAO,EAAE,YAAY,CAAC,OAAO,IAAI,CAAC;QAClC,UAAU,EAAE,qBAAU,CAAC,gBAAgB;QACvC,OAAO,EAAE,CAAC,UAAU,EAAE,KAAK,EAAE,EAAE;YAC7B,MAAM,CAAC,IAAI,CAAC,YAAY,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC;YAC1C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;QAClC,CAAC;KACF,CAAC;IAEF,IAAA,qBAAU,EAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IACvC,OAAO,aAAa,CAAC;AACvB,CAAC;AApBD,kDAoBC"}

package/dist/deviceModel/entities.d.ts

@@ -0,0 +1,211 @@
+import { z } from "zod";
+export declare const AvailableCommandSchema: z.ZodObject<{
+    /**
+     * The unique identifier for the command.
+     */
+    slug: z.ZodEffects<z.ZodString, string, string>;
+    support_level: z.ZodEnum<["planned", "development", "uat", "production", "blocked"]>;
+}, "strip", z.ZodTypeAny, {
+    slug: string;
+    support_level: "blocked" | "planned" | "development" | "uat" | "production";
+}, {
+    slug: string;
+    support_level: "blocked" | "planned" | "development" | "uat" | "production";
+}>;
+export declare const DeviceModelSchema: z.ZodObject<{
+    /**
+     * The unique identifier for the device model.
+     * @example "tesla:panel"
+     */
+    slug: z.ZodString;
+    /**
+     * The human readable name of the manufacturer.
+     * @example "PV Panel"
+     */
+    name: z.ZodString;
+    /**
+     * The type of the device.
+     * @example "inverter"
+     */
+    type: z.ZodEnum<["battery", "charger", "inverter", "thermostat", "vehicle"]>;
+    /**
+     * The manufacturer of the device.
+     */
+    manufacturer: z.ZodObject<{
+        slug: z.ZodString;
+        name: z.ZodString;
+        supportLevel: z.ZodEnum<["planned", "development", "uat", "production", "blocked"]>;
+        logo: z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodString;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }>;
+        icon: z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodString;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }>;
+        vectorIcon: z.ZodObject<{
+            url: z.ZodString;
+            alt: z.ZodString;
+            width: z.ZodNumber;
+            height: z.ZodNumber;
+        }, "strip", z.ZodTypeAny, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }, {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        slug: string;
+        logo: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        icon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        supportLevel: "blocked" | "planned" | "development" | "uat" | "production";
+        vectorIcon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+    }, {
+        name: string;
+        slug: string;
+        logo: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        icon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        supportLevel: "blocked" | "planned" | "development" | "uat" | "production";
+        vectorIcon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+    }>;
+    /**
+     * The commands available for the device.
+     */
+    available_commands: z.ZodArray<z.ZodObject<{
+        /**
+         * The unique identifier for the command.
+         */
+        slug: z.ZodEffects<z.ZodString, string, string>;
+        support_level: z.ZodEnum<["planned", "development", "uat", "production", "blocked"]>;
+    }, "strip", z.ZodTypeAny, {
+        slug: string;
+        support_level: "blocked" | "planned" | "development" | "uat" | "production";
+    }, {
+        slug: string;
+        support_level: "blocked" | "planned" | "development" | "uat" | "production";
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    type: "battery" | "charger" | "inverter" | "thermostat" | "vehicle";
+    name: string;
+    slug: string;
+    manufacturer: {
+        name: string;
+        slug: string;
+        logo: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        icon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        supportLevel: "blocked" | "planned" | "development" | "uat" | "production";
+        vectorIcon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+    };
+    available_commands: {
+        slug: string;
+        support_level: "blocked" | "planned" | "development" | "uat" | "production";
+    }[];
+}, {
+    type: "battery" | "charger" | "inverter" | "thermostat" | "vehicle";
+    name: string;
+    slug: string;
+    manufacturer: {
+        name: string;
+        slug: string;
+        logo: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        icon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+        supportLevel: "blocked" | "planned" | "development" | "uat" | "production";
+        vectorIcon: {
+            height: number;
+            width: number;
+            url: string;
+            alt: string;
+        };
+    };
+    available_commands: {
+        slug: string;
+        support_level: "blocked" | "planned" | "development" | "uat" | "production";
+    }[];
+}>;
+export type DeviceModel = z.infer<typeof DeviceModelSchema>;
+//# sourceMappingURL=entities.d.ts.map

package/dist/deviceModel/entities.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/deviceModel/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB,eAAO,MAAM,sBAAsB;IACjC;;OAEG;;;;;;;;;EAGH,CAAC;AAEH,eAAO,MAAM,iBAAiB;IAC5B;;;OAGG;;IAEH;;;OAGG;;IAEH;;;OAGG;;IAEH;;OAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAEH;;OAEG;;QA7BH;;WAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA6BH,CAAC;AAEH,MAAM,MAAM,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAC"}

package/dist/deviceModel/entities.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DeviceModelSchema = exports.AvailableCommandSchema = void 0;
+const zod_1 = require("zod");
+const entities_1 = require("../deviceType/entities");
+const entities_2 = require("../manufacturer/entities");
+const supportLevel_1 = require("../common/supportLevel");
+const utils_1 = require("../common/utils");
+exports.AvailableCommandSchema = zod_1.z.object({
+    /**
+     * The unique identifier for the command.
+     */
+    slug: zod_1.z.string().transform(utils_1.fromGraphQLSafeString),
+    support_level: supportLevel_1.SupportLevelEnum,
+});
+exports.DeviceModelSchema = zod_1.z.object({
+    /**
+     * The unique identifier for the device model.
+     * @example "tesla:panel"
+     */
+    slug: zod_1.z.string(),
+    /**
+     * The human readable name of the manufacturer.
+     * @example "PV Panel"
+     */
+    name: zod_1.z.string(),
+    /**
+     * The type of the device.
+     * @example "inverter"
+     */
+    type: entities_1.DeviceTypeEnum,
+    /**
+     * The manufacturer of the device.
+     */
+    manufacturer: entities_2.ManufacturerSchema,
+    /**
+     * The commands available for the device.
+     */
+    available_commands: zod_1.z.array(exports.AvailableCommandSchema),
+});
+//# sourceMappingURL=entities.js.map

package/dist/deviceModel/entities.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/deviceModel/entities.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,qDAAwD;AACxD,uDAA8D;AAC9D,yDAA0D;AAC1D,2CAAwD;AAE3C,QAAA,sBAAsB,GAAG,OAAC,CAAC,MAAM,CAAC;IAC7C;;OAEG;IACH,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,SAAS,CAAC,6BAAqB,CAAC;IACjD,aAAa,EAAE,+BAAgB;CAChC,CAAC,CAAC;AAEU,QAAA,iBAAiB,GAAG,OAAC,CAAC,MAAM,CAAC;IACxC;;;OAGG;IACH,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB;;;OAGG;IACH,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB;;;OAGG;IACH,IAAI,EAAE,yBAAc;IACpB;;OAEG;IACH,YAAY,EAAE,6BAAkB;IAChC;;OAEG;IACH,kBAAkB,EAAE,OAAC,CAAC,KAAK,CAAC,8BAAsB,CAAC;CACpD,CAAC,CAAC"}

package/dist/deviceModel/getDeviceModel/index.d.ts

@@ -0,0 +1,29 @@
+import { Logger } from "@texturehq/logger";
+import { DeviceModel } from "../entities";
+export interface GetDeviceModelOptions {
+    /**
+     * The slug of the device model to retrieve from the CMS.
+     */
+    slug: string;
+    /**
+     * The base URL of the Payload CMS instance.
+     * @default "https://device.cms.texturehq.com"
+     */
+    baseApiUrl?: string;
+    /**
+     * The base URL for images coming from Payload CMS.
+     * @default "https://texturehq.payloadcms.app"
+     */
+    baseImageUrl?: string;
+    /**
+     * The logger instance to use during the getDeviceModel operation.
+     */
+    logger?: Logger;
+}
+/**
+ * Retrieves a device model from the Device CMS.
+ * @param options The options to use during the getDeviceModel operation.
+ * @returns {Promise<DeviceModel | null>} The device model retrieved from the CMS or null if no device model was found.
+ */
+export declare const getDeviceModel: (options: GetDeviceModelOptions) => Promise<DeviceModel | null>;
+//# sourceMappingURL=index.d.ts.map

package/dist/deviceModel/getDeviceModel/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/deviceModel/getDeviceModel/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAI3C,OAAO,EAAE,WAAW,EAAqB,MAAM,aAAa,CAAC;AAI7D,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,eAAO,MAAM,cAAc,YAAmB,qBAAqB,KAAG,QAAQ,WAAW,GAAG,IAAI,CAmC/F,CAAC"}

package/dist/deviceModel/getDeviceModel/index.js

@@ -0,0 +1,50 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDeviceModel = void 0;
+const axios_1 = __importDefault(require("axios"));
+const logger_1 = require("../../common/logger");
+const exceptions_1 = require("../../common/exceptions");
+const entities_1 = require("../entities");
+const constants_1 = require("../../common/constants");
+const manufacturer_1 = require("../../manufacturer");
+/**
+ * Retrieves a device model from the Device CMS.
+ * @param options The options to use during the getDeviceModel operation.
+ * @returns {Promise<DeviceModel | null>} The device model retrieved from the CMS or null if no device model was found.
+ */
+const getDeviceModel = async (options) => {
+    const defaultLogger = logger_1.baseLogger.function("getDeviceModel");
+    const { slug, baseApiUrl = constants_1.PRODUCTION_CACHE_BASE_URL, baseImageUrl = constants_1.PRODUCTION_BASE_URL, logger = defaultLogger, } = options;
+    const operation = logger.operation("get device model from Payload CMS API");
+    try {
+        operation.start({ options });
+        const response = await axios_1.default.get(`${baseApiUrl}/api/device_models?where[slug][equals]=${slug}`);
+        if (response.status !== 200) {
+            const errorMessage = `Request to ${baseApiUrl}/api/device_models failed with status ${response.status}`;
+            operation.fail(errorMessage);
+            throw new exceptions_1.NetworkError(errorMessage, response.status);
+        }
+        if (response?.data?.docs?.length !== 1) {
+            operation.fail({ response: response.data });
+            return null;
+        }
+        const result = response.data.docs[0];
+        if (!result.manufacturer)
+            throw new Error(`Device (ID: ${result.id}) has no manufacturer.`);
+        const deviceModel = entities_1.DeviceModelSchema.parse({
+            ...result,
+            manufacturer: (0, manufacturer_1.parseManufacturer)(result.manufacturer, baseImageUrl),
+        });
+        operation.end({ deviceModel });
+        return deviceModel;
+    }
+    catch (error) {
+        operation.fail("Unknown error occurred while fetching device model from Payload CMS API.");
+        throw error;
+    }
+};
+exports.getDeviceModel = getDeviceModel;
+//# sourceMappingURL=index.js.map

package/dist/deviceModel/getDeviceModel/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/deviceModel/getDeviceModel/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAA0B;AAE1B,gDAAiD;AAEjD,wDAAuD;AACvD,0CAA6D;AAC7D,sDAAwF;AACxF,qDAAuD;AAuBvD;;;;GAIG;AACI,MAAM,cAAc,GAAG,KAAK,EAAE,OAA8B,EAA+B,EAAE;IAClG,MAAM,aAAa,GAAG,mBAAU,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC5D,MAAM,EACJ,IAAI,EACJ,UAAU,GAAG,qCAAyB,EACtC,YAAY,GAAG,+BAAmB,EAClC,MAAM,GAAG,aAAa,GACvB,GAAG,OAAO,CAAC;IACZ,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,uCAAuC,CAAC,CAAC;IAE5E,IAAI,CAAC;QACH,SAAS,CAAC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAC7B,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAqB,GAAG,UAAU,0CAA0C,IAAI,EAAE,CAAC,CAAC;QACpH,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC5B,MAAM,YAAY,GAAG,cAAc,UAAU,yCAAyC,QAAQ,CAAC,MAAM,EAAE,CAAC;YACxG,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAC7B,MAAM,IAAI,yBAAY,CAAC,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxD,CAAC;QAED,IAAI,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,KAAK,CAAC,EAAE,CAAC;YACvC,SAAS,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;QACd,CAAC;QACD,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACrC,IAAI,CAAC,MAAM,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,MAAM,CAAC,EAAE,wBAAwB,CAAC,CAAC;QAC5F,MAAM,WAAW,GAAG,4BAAiB,CAAC,KAAK,CAAC;YAC1C,GAAG,MAAM;YACT,YAAY,EAAE,IAAA,gCAAiB,EAAC,MAAM,CAAC,YAAY,EAAE,YAAY,CAAC;SACnE,CAAC,CAAC;QACH,SAAS,CAAC,GAAG,CAAC,EAAE,WAAW,EAAE,CAAC,CAAC;QAC/B,OAAO,WAAW,CAAC;IACrB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,SAAS,CAAC,IAAI,CAAC,0EAA0E,CAAC,CAAC;QAC3F,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAnCW,QAAA,cAAc,kBAmCzB"}