@seamapi/types 1.25.0 → 1.26.1

package/lib/seam/devicedb/route-specs.js

@@ -0,0 +1,49 @@
+import { z } from 'zod';
+import * as schemas from './public-models/index.js';
+export const routes = {
+    '/api/v1/device_models/get': {
+        auth: 'publishable_key',
+        methods: ['GET', 'OPTIONS'],
+        queryParams: z.object({
+            device_model_id: z.string().uuid(),
+        }),
+        jsonResponse: z.object({
+            device_model: schemas.device_model_v1,
+        }),
+    },
+    '/api/v1/device_models/list': {
+        auth: 'publishable_key',
+        methods: ['GET', 'OPTIONS'],
+        queryParams: z.object({
+            main_category: schemas.device_category,
+            manufacturer_id: z.string().uuid().optional(),
+            manufacturer_ids: z.string().uuid().array().optional(),
+            integration_status: schemas.manufacturer.shape.integration.optional(),
+            text_search: z.string().optional(),
+        }),
+        jsonResponse: z.object({
+            device_models: schemas.device_model_v1.array(),
+        }),
+    },
+    '/api/v1/manufacturers/get': {
+        auth: 'publishable_key',
+        methods: ['GET', 'OPTIONS'],
+        queryParams: z.object({
+            manufacturer_id: z.string().uuid(),
+        }),
+        jsonResponse: z.object({
+            manufacturer: schemas.manufacturer,
+        }),
+    },
+    '/api/v1/manufacturers/list': {
+        auth: 'publishable_key',
+        methods: ['GET', 'OPTIONS'],
+        queryParams: z.object({
+            integration_status: schemas.manufacturer.shape.integration.optional(),
+        }),
+        jsonResponse: z.object({
+            manufacturers: schemas.manufacturer.array(),
+        }),
+    },
+};
+//# sourceMappingURL=route-specs.js.map

package/lib/seam/devicedb/route-specs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"route-specs.js","sourceRoot":"","sources":["../../../src/lib/seam/devicedb/route-specs.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,KAAK,OAAO,MAAM,0BAA0B,CAAA;AAEnD,MAAM,CAAC,MAAM,MAAM,GAAG;IACpB,2BAA2B,EAAE;QAC3B,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;SACnC,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,YAAY,EAAE,OAAO,CAAC,eAAe;SACtC,CAAC;KACH;IACD,4BAA4B,EAAE;QAC5B,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,aAAa,EAAE,OAAO,CAAC,eAAe;YACtC,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE;YAC7C,gBAAgB,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,CAAC,QAAQ,EAAE;YACtD,kBAAkB,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE;YACrE,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;SACnC,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,aAAa,EAAE,OAAO,CAAC,eAAe,CAAC,KAAK,EAAE;SAC/C,CAAC;KACH;IACD,2BAA2B,EAAE;QAC3B,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE;SACnC,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,YAAY,EAAE,OAAO,CAAC,YAAY;SACnC,CAAC;KACH;IACD,4BAA4B,EAAE;QAC5B,IAAI,EAAE,iBAAiB;QACvB,OAAO,EAAE,CAAC,KAAK,EAAE,SAAS,CAAC;QAC3B,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,kBAAkB,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE;SACtE,CAAC;QACF,YAAY,EAAE,CAAC,CAAC,MAAM,CAAC;YACrB,aAAa,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE;SAC5C,CAAC;KACH;CACO,CAAA"}

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

@@ -105,7 +105,7 @@ export interface Routes {
         route: '/v1/device_models/list';
         method: 'GET' | 'OPTIONS';
         queryParams: {
-            main_category?: string | undefined;
+            main_category: 'smartlock' | 'sensor' | 'thermostat' | 'relay' | 'intercom' | 'accessory';
             manufacturer_id?: string | undefined;
             manufacturer_ids?: string[] | undefined;
             integration_status?: ('stable' | 'beta' | 'planned' | 'unsupported' | 'inquire') | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.25.0",
+  "version": "1.26.1",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -59,6 +59,7 @@
     "prebuild:ts": "del 'index.*' 'connect.*' 'devicedb.*' 'lib'",
     "postbuild:ts": "tsc-alias --project tsconfig.build.json",
     "typecheck": "tsc",
+    "docs:build": "typedoc",
     "lint": "eslint --ignore-path .gitignore .",
     "prelint": "prettier --check --ignore-path .gitignore .",
     "postversion": "git push --follow-tags",
@@ -96,6 +97,7 @@
     "tsup": "^7.1.0",
     "tsx": "^3.12.1",
     "type-fest": "^4.3.1",
+    "typedoc": "^0.25.2",
     "typescript": "^5.0.2",
     "zod": "^3.21.4"
   }

package/src/lib/seam/connect/openapi.ts

@@ -1520,6 +1520,7 @@ export default {
                   common_code_key: { type: 'string' },
                   device_id: { format: 'uuid', type: 'string' },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },
                   starts_at: { type: 'string' },
@@ -1595,6 +1596,7 @@ export default {
                     type: 'array',
                   },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },
                   starts_at: { type: 'string' },
@@ -1667,6 +1669,7 @@ export default {
                     type: 'array',
                   },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },
                   starts_at: { type: 'string' },
@@ -2091,6 +2094,7 @@ export default {
                   access_code_id: { format: 'uuid', type: 'string' },
                   allow_external_modification: { type: 'boolean' },
                   force: { type: 'boolean' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['access_code_id'],
@@ -2134,6 +2138,7 @@ export default {
                   access_code_id: { format: 'uuid', type: 'string' },
                   allow_external_modification: { type: 'boolean' },
                   force: { type: 'boolean' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   sync: { default: false, type: 'boolean' },
                 },
                 required: ['access_code_id'],
@@ -2407,6 +2412,7 @@ export default {
                   access_code_id: { format: 'uuid', type: 'string' },
                   allow_external_modification: { type: 'boolean' },
                   force: { type: 'boolean' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   is_managed: { type: 'boolean' },
                 },
                 required: ['access_code_id', 'is_managed'],
@@ -2450,6 +2456,7 @@ export default {
                   access_code_id: { format: 'uuid', type: 'string' },
                   allow_external_modification: { type: 'boolean' },
                   force: { type: 'boolean' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   is_managed: { type: 'boolean' },
                 },
                 required: ['access_code_id', 'is_managed'],
@@ -2507,6 +2514,7 @@ export default {
                   },
                   device_id: { format: 'uuid', type: 'string' },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   is_managed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },
@@ -2572,6 +2580,7 @@ export default {
                   },
                   device_id: { format: 'uuid', type: 'string' },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   is_managed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },
@@ -2639,6 +2648,7 @@ export default {
                   },
                   device_id: { format: 'uuid', type: 'string' },
                   ends_at: { type: 'string' },
+                  is_external_modification_allowed: { type: 'boolean' },
                   is_managed: { type: 'boolean' },
                   name: { type: 'string' },
                   prefer_native_scheduling: { type: 'boolean' },

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

@@ -15,6 +15,7 @@ export interface Routes {
       prefer_native_scheduling?: boolean | undefined
       use_backup_access_code_pool?: boolean | undefined
       allow_external_modification?: boolean | undefined
+      is_external_modification_allowed?: boolean | undefined
     }
     commonParams: {}
     formData: {}
@@ -82,6 +83,7 @@ export interface Routes {
       prefer_native_scheduling?: boolean | undefined
       use_backup_access_code_pool?: boolean | undefined
       allow_external_modification?: boolean | undefined
+      is_external_modification_allowed?: boolean | undefined
     }
     commonParams: {}
     formData: {}
@@ -309,6 +311,7 @@ export interface Routes {
     jsonBody: {}
     commonParams: {
       access_code_id: string
+      is_external_modification_allowed?: boolean | undefined
       allow_external_modification?: boolean | undefined
       force?: boolean | undefined
       sync?: boolean
@@ -418,6 +421,7 @@ export interface Routes {
       access_code_id: string
       is_managed: boolean
       allow_external_modification?: boolean | undefined
+      is_external_modification_allowed?: boolean | undefined
       force?: boolean | undefined
     }
     formData: {}
@@ -437,6 +441,7 @@ export interface Routes {
       prefer_native_scheduling?: boolean | undefined
       use_backup_access_code_pool?: boolean | undefined
       allow_external_modification?: boolean | undefined
+      is_external_modification_allowed?: boolean | undefined
       access_code_id: string
       device_id?: string | undefined
       type?: ('ongoing' | 'time_bound') | undefined

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

@@ -1,10 +1,14 @@
 import * as schemas from './public-models/index.js'
 
-export type { Routes } from './route-types.js'
+export * from './route-specs.js'
+export * from './route-types.js'
 export { schemas }
 
 export type {
+  DeviceCategory,
+  DeviceConnectionType,
   DeviceModelV1,
   ImageReference,
   Manufacturer,
+  ManufacturerIntegrationSupportLevel,
 } from './public-models/index.js'

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

@@ -3,8 +3,28 @@ import { z } from 'zod'
 import { image_reference } from './image-reference.js'
 import { manufacturer } from './manufacturer.js'
 
+export const device_category = z.enum([
+  'smartlock',
+  'sensor',
+  'thermostat',
+  'relay',
+  'intercom',
+  'accessory',
+])
+
+export type DeviceCategory = z.infer<typeof device_category>
+
+export const device_connection_type = z.enum([
+  'wifi',
+  'zwave',
+  'zigbee',
+  'unknown',
+])
+
+export type DeviceConnectionType = z.infer<typeof device_connection_type>
+
 const smartlock = z.object({
-  main_category: z.literal('smartlock'),
+  main_category: z.literal(device_category.enum.smartlock),
   physical_properties: z.object({
     lock_type: z.enum([
       'deadbolt',
@@ -28,7 +48,7 @@ const smartlock = z.object({
 })
 
 const sensor = z.object({
-  main_category: z.literal('sensor'),
+  main_category: z.literal(device_category.enum.sensor),
   physical_properties: z.object({
     has_noise_sensor: z.boolean(),
     has_humidity_sensor: z.boolean(),
@@ -37,8 +57,8 @@ const sensor = z.object({
   }),
 })
 
-const thermostat = z.object({
-  main_category: z.literal('thermostat'),
+export const thermostat = z.object({
+  main_category: z.literal(device_category.enum.thermostat),
   physical_properties: z.object({
     available_modes: z.enum(['heat', 'cool', 'fan', 'eco']).array(),
     is_heat_pump_compatible: z.boolean(),
@@ -56,11 +76,11 @@ const thermostat = z.object({
 export type ThermostatPropertiesV1 = z.infer<typeof thermostat>
 
 const relay = z.object({
-  main_category: z.literal('relay'),
+  main_category: z.literal(device_category.enum.relay),
 })
 
 const intercom = z.object({
-  main_category: z.literal('intercom'),
+  main_category: z.literal(device_category.enum.intercom),
   physical_properties: z.object({
     has_camera: z.boolean(),
   }),
@@ -71,7 +91,7 @@ const intercom = z.object({
 })
 
 const accessory = z.object({
-  main_category: z.literal('accessory'),
+  main_category: z.literal(device_category.enum.accessory),
 })
 
 export const device_model_category_specific_properties = z.discriminatedUnion(
@@ -86,7 +106,7 @@ export const base_device_model_v1 = z.object({
   display_name: z.string(),
   description: z.string(),
   product_url: z.string().optional(),
-  main_connection_type: z.enum(['wifi', 'zwave', 'zigbee', 'unknown']),
+  main_connection_type: device_connection_type,
   aesthetic_variants: z
     .object({
       slug: z.string(),

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

@@ -2,11 +2,23 @@ import { z } from 'zod'
 
 import { image_reference } from './image-reference.js'
 
+export const manufacturer_integration_support_level = z.enum([
+  'stable',
+  'beta',
+  'planned',
+  'unsupported',
+  'inquire',
+])
+
+export type ManufacturerIntegrationSupportLevel = z.infer<
+  typeof manufacturer_integration_support_level
+>
+
 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', 'inquire']),
+  integration: manufacturer_integration_support_level,
   is_connect_webview_supported: z.boolean(),
   requires_seam_support_to_add_account: z.boolean(),
 })

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

@@ -0,0 +1,50 @@
+import { z } from 'zod'
+
+import * as schemas from './public-models/index.js'
+
+export const routes = {
+  '/api/v1/device_models/get': {
+    auth: 'publishable_key',
+    methods: ['GET', 'OPTIONS'],
+    queryParams: z.object({
+      device_model_id: z.string().uuid(),
+    }),
+    jsonResponse: z.object({
+      device_model: schemas.device_model_v1,
+    }),
+  },
+  '/api/v1/device_models/list': {
+    auth: 'publishable_key',
+    methods: ['GET', 'OPTIONS'],
+    queryParams: z.object({
+      main_category: schemas.device_category,
+      manufacturer_id: z.string().uuid().optional(),
+      manufacturer_ids: z.string().uuid().array().optional(),
+      integration_status: schemas.manufacturer.shape.integration.optional(),
+      text_search: z.string().optional(),
+    }),
+    jsonResponse: z.object({
+      device_models: schemas.device_model_v1.array(),
+    }),
+  },
+  '/api/v1/manufacturers/get': {
+    auth: 'publishable_key',
+    methods: ['GET', 'OPTIONS'],
+    queryParams: z.object({
+      manufacturer_id: z.string().uuid(),
+    }),
+    jsonResponse: z.object({
+      manufacturer: schemas.manufacturer,
+    }),
+  },
+  '/api/v1/manufacturers/list': {
+    auth: 'publishable_key',
+    methods: ['GET', 'OPTIONS'],
+    queryParams: z.object({
+      integration_status: schemas.manufacturer.shape.integration.optional(),
+    }),
+    jsonResponse: z.object({
+      manufacturers: schemas.manufacturer.array(),
+    }),
+  },
+} as const

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

@@ -132,7 +132,13 @@ export interface Routes {
     route: '/v1/device_models/list'
     method: 'GET' | 'OPTIONS'
     queryParams: {
-      main_category?: string | undefined
+      main_category:
+        | 'smartlock'
+        | 'sensor'
+        | 'thermostat'
+        | 'relay'
+        | 'intercom'
+        | 'accessory'
       manufacturer_id?: string | undefined
       manufacturer_ids?: string[] | undefined
       integration_status?: