@seamapi/types 1.18.3 → 1.18.5

package/src/lib/seam/devicedb/route-types.ts

@@ -27,9 +27,9 @@ export interface Routes {
         }
         is_device_supported: boolean
         display_name: string
+        description: string
         product_url: string
         main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown'
-        main_category: 'smartlock' | 'thermostat' | 'noise_sensor'
         aesthetic_variants: Array<{
           slug: string
           display_name: string
@@ -50,7 +50,60 @@ export interface Routes {
               }
             | undefined
         }>
-      }
+        power_sources: Array<
+          | 'battery'
+          | 'hardwired'
+          | 'mechanical_harvesting'
+          | 'wireless'
+          | 'ethernet'
+        >
+      } & (
+        | {
+            main_category: 'smartlock'
+            physical_properties: {
+              lock_type:
+                | 'deadbolt'
+                | 'lever'
+                | 'mortise'
+                | 'lockbox'
+                | 'cylinder'
+                | 'padlock'
+                | 'locker'
+              has_physical_key: boolean
+              has_camera: boolean
+            }
+            software_features: {
+              can_remotely_unlock: boolean
+              can_program_access_codes: boolean
+              can_program_access_schedules: boolean
+              can_program_access_codes_offline: boolean
+            }
+          }
+        | {
+            main_category: 'sensor'
+            physical_properties: {
+              has_noise_sensor: boolean
+              has_humidity_sensor: boolean
+              has_temperature_sensor: boolean
+              has_occupancy_detection: boolean
+            }
+          }
+        | {
+            main_category: 'thermostat'
+            physical_properties: {
+              available_modes: Array<'heat' | 'cool' | 'fan' | 'eco'>
+              is_heat_pump_compatible: boolean
+              has_occupancy_detection: boolean
+              supports_demand_response: boolean
+              has_humidity_sensor: boolean
+              has_temperature_sensor: boolean
+              supports_emergency_heating_mode: boolean
+            }
+            software_features: {
+              can_program_climate_schedules: boolean
+            }
+          }
+      )
     }
   }
   '/v1/device_models/list': {
@@ -68,48 +121,103 @@ export interface Routes {
     commonParams: {}
     formData: {}
     jsonResponse: {
-      device_models: Array<{
-        device_model_id: string
-        manufacturer: {
-          manufacturer_id: string
+      device_models: Array<
+        {
+          device_model_id: string
+          manufacturer: {
+            manufacturer_id: string
+            display_name: string
+            logo?:
+              | {
+                  url: string
+                  width: number
+                  height: number
+                }
+              | undefined
+            integration: 'stable' | 'beta' | 'planned' | 'unsupported'
+            is_connect_webview_supported: boolean
+            requires_seam_support_to_add_account: boolean
+          }
+          is_device_supported: boolean
           display_name: string
-          logo?:
-            | {
-                url: string
-                width: number
-                height: number
+          description: string
+          product_url: string
+          main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown'
+          aesthetic_variants: Array<{
+            slug: string
+            display_name: string
+            primary_color_hex?: string | undefined
+            manufacturer_sku: string
+            front_image?:
+              | {
+                  url: string
+                  width: number
+                  height: number
+                }
+              | undefined
+            back_image?:
+              | {
+                  url: string
+                  width: number
+                  height: number
+                }
+              | undefined
+          }>
+          power_sources: Array<
+            | 'battery'
+            | 'hardwired'
+            | 'mechanical_harvesting'
+            | 'wireless'
+            | 'ethernet'
+          >
+        } & (
+          | {
+              main_category: 'smartlock'
+              physical_properties: {
+                lock_type:
+                  | 'deadbolt'
+                  | 'lever'
+                  | 'mortise'
+                  | 'lockbox'
+                  | 'cylinder'
+                  | 'padlock'
+                  | 'locker'
+                has_physical_key: boolean
+                has_camera: boolean
               }
-            | undefined
-          integration: 'stable' | 'beta' | 'planned' | 'unsupported'
-          is_connect_webview_supported: boolean
-          requires_seam_support_to_add_account: boolean
-        }
-        is_device_supported: boolean
-        display_name: string
-        product_url: string
-        main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown'
-        main_category: 'smartlock' | 'thermostat' | 'noise_sensor'
-        aesthetic_variants: Array<{
-          slug: string
-          display_name: string
-          primary_color_hex?: string | undefined
-          manufacturer_sku: string
-          front_image?:
-            | {
-                url: string
-                width: number
-                height: number
+              software_features: {
+                can_remotely_unlock: boolean
+                can_program_access_codes: boolean
+                can_program_access_schedules: boolean
+                can_program_access_codes_offline: boolean
               }
-            | undefined
-          back_image?:
-            | {
-                url: string
-                width: number
-                height: number
+            }
+          | {
+              main_category: 'sensor'
+              physical_properties: {
+                has_noise_sensor: boolean
+                has_humidity_sensor: boolean
+                has_temperature_sensor: boolean
+                has_occupancy_detection: boolean
               }
-            | undefined
-        }>
-      }>
+            }
+          | {
+              main_category: 'thermostat'
+              physical_properties: {
+                available_modes: Array<'heat' | 'cool' | 'fan' | 'eco'>
+                is_heat_pump_compatible: boolean
+                has_occupancy_detection: boolean
+                supports_demand_response: boolean
+                has_humidity_sensor: boolean
+                has_temperature_sensor: boolean
+                supports_emergency_heating_mode: boolean
+              }
+              software_features: {
+                can_program_climate_schedules: boolean
+              }
+            }
+        )
+      >
     }
   }
   '/v1/manufacturers/get': {

package/lib/seam/devicedb/public-models.d.ts

@@ -1,273 +0,0 @@
-import { z } from 'zod';
-export declare const device_model_v0: z.ZodObject<{
-    main_category: z.ZodString;
-    model_name: z.ZodString;
-    manufacturer_model_id: z.ZodString;
-    connection_type: z.ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
-    support_level: z.ZodEnum<["live", "beta", "unsupported"]>;
-    brand: z.ZodString;
-    icon_url: z.ZodString;
-    seam_device_model_page_url: z.ZodString;
-}, "strip", z.ZodTypeAny, {
-    brand: string;
-    main_category: string;
-    model_name: string;
-    manufacturer_model_id: string;
-    connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
-    support_level: "beta" | "live" | "unsupported";
-    icon_url: string;
-    seam_device_model_page_url: string;
-}, {
-    brand: string;
-    main_category: string;
-    model_name: string;
-    manufacturer_model_id: string;
-    connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
-    support_level: "beta" | "live" | "unsupported";
-    icon_url: string;
-    seam_device_model_page_url: string;
-}>;
-export type DeviceModelV0 = z.infer<typeof device_model_v0>;
-export declare const image_reference: z.ZodObject<{
-    url: z.ZodString;
-    width: z.ZodNumber;
-    height: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    height: number;
-    width: number;
-    url: string;
-}, {
-    height: number;
-    width: number;
-    url: string;
-}>;
-export type ImageReference = z.infer<typeof image_reference>;
-export declare const manufacturer: z.ZodObject<{
-    manufacturer_id: z.ZodString;
-    display_name: z.ZodString;
-    logo: z.ZodOptional<z.ZodObject<{
-        url: z.ZodString;
-        width: z.ZodNumber;
-        height: z.ZodNumber;
-    }, "strip", z.ZodTypeAny, {
-        height: number;
-        width: number;
-        url: string;
-    }, {
-        height: number;
-        width: number;
-        url: string;
-    }>>;
-    integration: z.ZodEnum<["stable", "beta", "planned", "unsupported"]>;
-    is_connect_webview_supported: z.ZodBoolean;
-    requires_seam_support_to_add_account: z.ZodBoolean;
-}, "strip", z.ZodTypeAny, {
-    display_name: string;
-    manufacturer_id: string;
-    integration: "beta" | "stable" | "unsupported" | "planned";
-    is_connect_webview_supported: boolean;
-    requires_seam_support_to_add_account: boolean;
-    logo?: {
-        height: number;
-        width: number;
-        url: string;
-    } | undefined;
-}, {
-    display_name: string;
-    manufacturer_id: string;
-    integration: "beta" | "stable" | "unsupported" | "planned";
-    is_connect_webview_supported: boolean;
-    requires_seam_support_to_add_account: boolean;
-    logo?: {
-        height: number;
-        width: number;
-        url: string;
-    } | undefined;
-}>;
-export type Manufacturer = z.infer<typeof manufacturer>;
-export declare const device_model_v1: z.ZodObject<{
-    device_model_id: z.ZodString;
-    manufacturer: z.ZodObject<{
-        manufacturer_id: z.ZodString;
-        display_name: z.ZodString;
-        logo: z.ZodOptional<z.ZodObject<{
-            url: z.ZodString;
-            width: z.ZodNumber;
-            height: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            height: number;
-            width: number;
-            url: string;
-        }, {
-            height: number;
-            width: number;
-            url: string;
-        }>>;
-        integration: z.ZodEnum<["stable", "beta", "planned", "unsupported"]>;
-        is_connect_webview_supported: z.ZodBoolean;
-        requires_seam_support_to_add_account: z.ZodBoolean;
-    }, "strip", z.ZodTypeAny, {
-        display_name: string;
-        manufacturer_id: string;
-        integration: "beta" | "stable" | "unsupported" | "planned";
-        is_connect_webview_supported: boolean;
-        requires_seam_support_to_add_account: boolean;
-        logo?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }, {
-        display_name: string;
-        manufacturer_id: string;
-        integration: "beta" | "stable" | "unsupported" | "planned";
-        is_connect_webview_supported: boolean;
-        requires_seam_support_to_add_account: boolean;
-        logo?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }>;
-    is_device_supported: z.ZodBoolean;
-    display_name: z.ZodString;
-    description: z.ZodString;
-    product_url: z.ZodString;
-    main_connection_type: z.ZodEnum<["wifi", "zwave", "zigbee", "unknown"]>;
-    main_category: z.ZodEnum<["smartlock", "thermostat", "noise_sensor"]>;
-    aesthetic_variants: z.ZodArray<z.ZodObject<{
-        slug: z.ZodString;
-        display_name: z.ZodString;
-        primary_color_hex: z.ZodOptional<z.ZodString>;
-        manufacturer_sku: z.ZodString;
-        front_image: z.ZodOptional<z.ZodObject<{
-            url: z.ZodString;
-            width: z.ZodNumber;
-            height: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            height: number;
-            width: number;
-            url: string;
-        }, {
-            height: number;
-            width: number;
-            url: string;
-        }>>;
-        back_image: z.ZodOptional<z.ZodObject<{
-            url: z.ZodString;
-            width: z.ZodNumber;
-            height: z.ZodNumber;
-        }, "strip", z.ZodTypeAny, {
-            height: number;
-            width: number;
-            url: string;
-        }, {
-            height: number;
-            width: number;
-            url: string;
-        }>>;
-    }, "strip", z.ZodTypeAny, {
-        display_name: string;
-        slug: string;
-        manufacturer_sku: string;
-        primary_color_hex?: string | undefined;
-        front_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-        back_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }, {
-        display_name: string;
-        slug: string;
-        manufacturer_sku: string;
-        primary_color_hex?: string | undefined;
-        front_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-        back_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }>, "many">;
-}, "strip", z.ZodTypeAny, {
-    description: string;
-    display_name: string;
-    main_category: "thermostat" | "smartlock" | "noise_sensor";
-    device_model_id: string;
-    manufacturer: {
-        display_name: string;
-        manufacturer_id: string;
-        integration: "beta" | "stable" | "unsupported" | "planned";
-        is_connect_webview_supported: boolean;
-        requires_seam_support_to_add_account: boolean;
-        logo?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    };
-    is_device_supported: boolean;
-    product_url: string;
-    main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
-    aesthetic_variants: {
-        display_name: string;
-        slug: string;
-        manufacturer_sku: string;
-        primary_color_hex?: string | undefined;
-        front_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-        back_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }[];
-}, {
-    description: string;
-    display_name: string;
-    main_category: "thermostat" | "smartlock" | "noise_sensor";
-    device_model_id: string;
-    manufacturer: {
-        display_name: string;
-        manufacturer_id: string;
-        integration: "beta" | "stable" | "unsupported" | "planned";
-        is_connect_webview_supported: boolean;
-        requires_seam_support_to_add_account: boolean;
-        logo?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    };
-    is_device_supported: boolean;
-    product_url: string;
-    main_connection_type: "unknown" | "wifi" | "zwave" | "zigbee";
-    aesthetic_variants: {
-        display_name: string;
-        slug: string;
-        manufacturer_sku: string;
-        primary_color_hex?: string | undefined;
-        front_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-        back_image?: {
-            height: number;
-            width: number;
-            url: string;
-        } | undefined;
-    }[];
-}>;
-export type DeviceModelV1 = z.infer<typeof device_model_v1>;

package/lib/seam/devicedb/public-models.js

@@ -1,45 +0,0 @@
-import { z } from 'zod';
-export const device_model_v0 = z.object({
-    main_category: z.string(),
-    model_name: z.string(),
-    manufacturer_model_id: z.string(),
-    connection_type: z.enum(['wifi', 'zwave', 'zigbee', 'unknown']),
-    support_level: z.enum(['live', 'beta', 'unsupported']),
-    brand: z.string(),
-    icon_url: z.string(),
-    seam_device_model_page_url: z.string(),
-});
-export const image_reference = z.object({
-    url: z.string().url(),
-    width: z.number(),
-    height: z.number(),
-});
-export const manufacturer = z.object({
-    manufacturer_id: z.string().uuid(),
-    display_name: z.string(),
-    logo: image_reference.optional(),
-    integration: z.enum(['stable', 'beta', 'planned', 'unsupported']),
-    is_connect_webview_supported: z.boolean(),
-    requires_seam_support_to_add_account: z.boolean(),
-});
-export const device_model_v1 = z.object({
-    device_model_id: z.string().uuid(),
-    manufacturer,
-    is_device_supported: z.boolean(),
-    display_name: z.string(),
-    description: z.string(),
-    product_url: z.string(),
-    main_connection_type: z.enum(['wifi', 'zwave', 'zigbee', 'unknown']),
-    main_category: z.enum(['smartlock', 'thermostat', 'noise_sensor']),
-    aesthetic_variants: z
-        .object({
-        slug: z.string(),
-        display_name: z.string(),
-        primary_color_hex: z.string().optional(),
-        manufacturer_sku: z.string(),
-        front_image: image_reference.optional(),
-        back_image: image_reference.optional(),
-    })
-        .array(),
-});
-//# sourceMappingURL=public-models.js.map

package/lib/seam/devicedb/public-models.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"public-models.js","sourceRoot":"","sources":["../../../src/lib/seam/devicedb/public-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,aAAa,EAAE,CAAC,CAAC,MAAM,EAAE;IACzB,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE;IACtB,qBAAqB,EAAE,CAAC,CAAC,MAAM,EAAE;IACjC,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IAC/D,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,aAAa,CAAC,CAAC;IACtD,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,0BAA0B,EAAE,CAAC,CAAC,MAAM,EAAE;CACvC,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IACrB,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE;IACjB,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE;CACnB,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAClC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;IACjE,4BAA4B,EAAE,CAAC,CAAC,OAAO,EAAE;IACzC,oCAAoC,EAAE,CAAC,CAAC,OAAO,EAAE;CAClD,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,CAAC,MAAM,CAAC;IACtC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;IAClC,YAAY;IACZ,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE;IAChC,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;IACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE;IACvB,oBAAoB,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC;IACpE,aAAa,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,YAAY,EAAE,cAAc,CAAC,CAAC;IAClE,kBAAkB,EAAE,CAAC;SAClB,MAAM,CAAC;QACN,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;QAChB,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE;QACxB,iBAAiB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;QACxC,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE;QAC5B,WAAW,EAAE,eAAe,CAAC,QAAQ,EAAE;QACvC,UAAU,EAAE,eAAe,CAAC,QAAQ,EAAE;KACvC,CAAC;SACD,KAAK,EAAE;CACX,CAAC,CAAA"}

package/src/lib/seam/devicedb/public-models.ts

@@ -1,56 +0,0 @@
-import { z } from 'zod'
-
-export const device_model_v0 = z.object({
-  main_category: z.string(),
-  model_name: z.string(),
-  manufacturer_model_id: z.string(),
-  connection_type: z.enum(['wifi', 'zwave', 'zigbee', 'unknown']),
-  support_level: z.enum(['live', 'beta', 'unsupported']),
-  brand: z.string(),
-  icon_url: z.string(),
-  seam_device_model_page_url: z.string(),
-})
-
-export type DeviceModelV0 = z.infer<typeof device_model_v0>
-
-export const image_reference = z.object({
-  url: z.string().url(),
-  width: z.number(),
-  height: z.number(),
-})
-
-export type ImageReference = z.infer<typeof image_reference>
-
-export const manufacturer = z.object({
-  manufacturer_id: z.string().uuid(),
-  display_name: z.string(),
-  logo: image_reference.optional(),
-  integration: z.enum(['stable', 'beta', 'planned', 'unsupported']),
-  is_connect_webview_supported: z.boolean(),
-  requires_seam_support_to_add_account: z.boolean(),
-})
-
-export type Manufacturer = z.infer<typeof manufacturer>
-
-export const device_model_v1 = z.object({
-  device_model_id: z.string().uuid(),
-  manufacturer,
-  is_device_supported: z.boolean(),
-  display_name: z.string(),
-  description: z.string(),
-  product_url: z.string(),
-  main_connection_type: z.enum(['wifi', 'zwave', 'zigbee', 'unknown']),
-  main_category: z.enum(['smartlock', 'thermostat', 'noise_sensor']),
-  aesthetic_variants: z
-    .object({
-      slug: z.string(),
-      display_name: z.string(),
-      primary_color_hex: z.string().optional(),
-      manufacturer_sku: z.string(),
-      front_image: image_reference.optional(),
-      back_image: image_reference.optional(),
-    })
-    .array(),
-})
-
-export type DeviceModelV1 = z.infer<typeof device_model_v1>