@seamapi/types 1.18.4 → 1.18.5

package/lib/seam/devicedb/public-models/device-model-v1.js

@@ -0,0 +1,80 @@
+import { z } from 'zod';
+import { image_reference } from './image-reference.js';
+import { manufacturer } from './manufacturer.js';
+const smartlock = z.object({
+    main_category: z.literal('smartlock'),
+    physical_properties: z.object({
+        lock_type: z.enum([
+            'deadbolt',
+            'lever',
+            'mortise',
+            'lockbox',
+            'cylinder',
+            'padlock',
+            'locker',
+        ]),
+        has_physical_key: z.boolean(),
+        has_camera: z.boolean(),
+    }),
+    software_features: z.object({
+        can_remotely_unlock: z.boolean(),
+        can_program_access_codes: z.boolean(),
+        can_program_access_schedules: z.boolean(),
+        can_program_access_codes_offline: z.boolean(),
+    }),
+});
+const sensor = z.object({
+    main_category: z.literal('sensor'),
+    physical_properties: z.object({
+        has_noise_sensor: z.boolean(),
+        has_humidity_sensor: z.boolean(),
+        has_temperature_sensor: z.boolean(),
+        has_occupancy_detection: z.boolean(),
+    }),
+});
+const thermostat = z.object({
+    main_category: z.literal('thermostat'),
+    physical_properties: z.object({
+        available_modes: z.enum(['heat', 'cool', 'fan', 'eco']).array(),
+        is_heat_pump_compatible: z.boolean(),
+        has_occupancy_detection: z.boolean(),
+        supports_demand_response: z.boolean(),
+        has_humidity_sensor: z.boolean(),
+        has_temperature_sensor: z.boolean(),
+        supports_emergency_heating_mode: z.boolean(),
+    }),
+    software_features: z.object({
+        can_program_climate_schedules: z.boolean(),
+    }),
+});
+export const device_model_category_specific_properties = z.discriminatedUnion('main_category', [smartlock, sensor, thermostat]);
+export const base_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']),
+    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(),
+    power_sources: z
+        .enum([
+        'battery',
+        'hardwired',
+        'mechanical_harvesting',
+        'wireless',
+        'ethernet',
+    ])
+        .array(),
+});
+export const device_model_v1 = base_device_model_v1.and(device_model_category_specific_properties);
+//# sourceMappingURL=device-model-v1.js.map

package/lib/seam/devicedb/public-models/device-model-v1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"device-model-v1.js","sourceRoot":"","sources":["../../../../src/lib/seam/devicedb/public-models/device-model-v1.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAA;AAEhD,MAAM,SAAS,GAAG,CAAC,CAAC,MAAM,CAAC;IACzB,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IACrC,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC5B,SAAS,EAAE,CAAC,CAAC,IAAI,CAAC;YAChB,UAAU;YACV,OAAO;YACP,SAAS;YACT,SAAS;YACT,UAAU;YACV,SAAS;YACT,QAAQ;SACT,CAAC;QACF,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;QAC7B,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE;KACxB,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE;QAChC,wBAAwB,EAAE,CAAC,CAAC,OAAO,EAAE;QACrC,4BAA4B,EAAE,CAAC,CAAC,OAAO,EAAE;QACzC,gCAAgC,EAAE,CAAC,CAAC,OAAO,EAAE;KAC9C,CAAC;CACH,CAAC,CAAA;AAEF,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;IACtB,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;IAClC,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC5B,gBAAgB,EAAE,CAAC,CAAC,OAAO,EAAE;QAC7B,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE;QAChC,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE;QACnC,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE;KACrC,CAAC;CACH,CAAC,CAAA;AAEF,MAAM,UAAU,GAAG,CAAC,CAAC,MAAM,CAAC;IAC1B,aAAa,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC;IACtC,mBAAmB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC5B,eAAe,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,KAAK,EAAE;QAC/D,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE;QACpC,uBAAuB,EAAE,CAAC,CAAC,OAAO,EAAE;QACpC,wBAAwB,EAAE,CAAC,CAAC,OAAO,EAAE;QACrC,mBAAmB,EAAE,CAAC,CAAC,OAAO,EAAE;QAChC,sBAAsB,EAAE,CAAC,CAAC,OAAO,EAAE;QACnC,+BAA+B,EAAE,CAAC,CAAC,OAAO,EAAE;KAC7C,CAAC;IACF,iBAAiB,EAAE,CAAC,CAAC,MAAM,CAAC;QAC1B,6BAA6B,EAAE,CAAC,CAAC,OAAO,EAAE;KAC3C,CAAC;CACH,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,yCAAyC,GAAG,CAAC,CAAC,kBAAkB,CAC3E,eAAe,EACf,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,CAAC,CAChC,CAAA;AAED,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,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,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;IACV,aAAa,EAAE,CAAC;SACb,IAAI,CAAC;QACJ,SAAS;QACT,WAAW;QACX,uBAAuB;QACvB,UAAU;QACV,UAAU;KACX,CAAC;SACD,KAAK,EAAE;CACX,CAAC,CAAA;AAIF,MAAM,CAAC,MAAM,eAAe,GAAG,oBAAoB,CAAC,GAAG,CACrD,yCAAyC,CAC1C,CAAA"}

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

@@ -0,0 +1,15 @@
+import { z } from 'zod';
+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>;

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

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+export const image_reference = z.object({
+    url: z.string().url(),
+    width: z.number(),
+    height: z.number(),
+});
+//# sourceMappingURL=image-reference.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"image-reference.js","sourceRoot":"","sources":["../../../../src/lib/seam/devicedb/public-models/image-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,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"}

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

@@ -0,0 +1,4 @@
+export * from './device-model-v0.js';
+export * from './device-model-v1.js';
+export * from './image-reference.js';
+export * from './manufacturer.js';

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

@@ -0,0 +1,5 @@
+export * from './device-model-v0.js';
+export * from './device-model-v1.js';
+export * from './image-reference.js';
+export * from './manufacturer.js';
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/seam/devicedb/public-models/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,sBAAsB,CAAA;AACpC,cAAc,mBAAmB,CAAA"}

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

@@ -0,0 +1,44 @@
+import { z } from 'zod';
+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>;

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

@@ -0,0 +1,11 @@
+import { z } from 'zod';
+import { image_reference } from './image-reference.js';
+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(),
+});
+//# sourceMappingURL=manufacturer.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manufacturer.js","sourceRoot":"","sources":["../../../../src/lib/seam/devicedb/public-models/manufacturer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD,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"}

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

@@ -28,7 +28,6 @@ export interface Routes {
                 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;
@@ -45,7 +44,43 @@ export interface Routes {
                         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;
+                };
+                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': {
@@ -80,7 +115,6 @@ export interface Routes {
                 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;
@@ -97,7 +131,43 @@ export interface Routes {
                         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;
+                };
+                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/manufacturers/get': {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.18.4",
+  "version": "1.18.5",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/devicedb/index.ts

@@ -1,4 +1,4 @@
-import * as schemas from './public-models.js'
+import * as schemas from './public-models/index.js'
 
 export type { Routes } from './route-types.js'
 export { schemas }
@@ -7,4 +7,4 @@ export type {
   DeviceModelV1,
   ImageReference,
   Manufacturer,
-} from './public-models.js'
+} from './public-models/index.js'

package/src/lib/seam/devicedb/public-models/device-model-v0.ts

@@ -0,0 +1,14 @@
+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>

package/src/lib/seam/devicedb/public-models/device-model-v1.ts

@@ -0,0 +1,95 @@
+import { z } from 'zod'
+
+import { image_reference } from './image-reference.js'
+import { manufacturer } from './manufacturer.js'
+
+const smartlock = z.object({
+  main_category: z.literal('smartlock'),
+  physical_properties: z.object({
+    lock_type: z.enum([
+      'deadbolt',
+      'lever',
+      'mortise',
+      'lockbox',
+      'cylinder',
+      'padlock',
+      'locker',
+    ]),
+    has_physical_key: z.boolean(),
+    has_camera: z.boolean(),
+  }),
+  software_features: z.object({
+    can_remotely_unlock: z.boolean(),
+    can_program_access_codes: z.boolean(),
+    can_program_access_schedules: z.boolean(),
+    can_program_access_codes_offline: z.boolean(),
+  }),
+})
+
+const sensor = z.object({
+  main_category: z.literal('sensor'),
+  physical_properties: z.object({
+    has_noise_sensor: z.boolean(),
+    has_humidity_sensor: z.boolean(),
+    has_temperature_sensor: z.boolean(),
+    has_occupancy_detection: z.boolean(),
+  }),
+})
+
+const thermostat = z.object({
+  main_category: z.literal('thermostat'),
+  physical_properties: z.object({
+    available_modes: z.enum(['heat', 'cool', 'fan', 'eco']).array(),
+    is_heat_pump_compatible: z.boolean(),
+    has_occupancy_detection: z.boolean(),
+    supports_demand_response: z.boolean(),
+    has_humidity_sensor: z.boolean(),
+    has_temperature_sensor: z.boolean(),
+    supports_emergency_heating_mode: z.boolean(),
+  }),
+  software_features: z.object({
+    can_program_climate_schedules: z.boolean(),
+  }),
+})
+
+export const device_model_category_specific_properties = z.discriminatedUnion(
+  'main_category',
+  [smartlock, sensor, thermostat],
+)
+
+export const base_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']),
+  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(),
+  power_sources: z
+    .enum([
+      'battery',
+      'hardwired',
+      'mechanical_harvesting',
+      'wireless',
+      'ethernet',
+    ])
+    .array(),
+})
+
+export type BaseDeviceModelV1 = z.infer<typeof base_device_model_v1>
+
+export const device_model_v1 = base_device_model_v1.and(
+  device_model_category_specific_properties,
+)
+
+export type DeviceModelV1 = z.infer<typeof device_model_v1>

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

@@ -0,0 +1,9 @@
+import { z } from 'zod'
+
+export const image_reference = z.object({
+  url: z.string().url(),
+  width: z.number(),
+  height: z.number(),
+})
+
+export type ImageReference = z.infer<typeof image_reference>

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

@@ -0,0 +1,4 @@
+export * from './device-model-v0.js'
+export * from './device-model-v1.js'
+export * from './image-reference.js'
+export * from './manufacturer.js'

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

@@ -0,0 +1,14 @@
+import { z } from 'zod'
+
+import { image_reference } from './image-reference.js'
+
+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>