@seamapi/types 1.1113.0 → 1.1115.0

package/package.json

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

package/src/lib/seam/connect/internal/schemas.ts

@@ -58,6 +58,7 @@ export {
   guest_resource,
   instant_key,
   instant_key_preview,
+  instant_key_theme,
   listing_resource,
   lock_device_type,
   magic_link,

package/src/lib/seam/connect/models/colors.ts

@@ -7,3 +7,33 @@ export const hex_color_code = z.string().refine((value) => {
 
   return true
 }, 'Must be a hex color')
+
+const css_number = String.raw`[+-]?(?:\d+\.?\d*|\.\d+)`
+const css_alpha = String.raw`(?:\s*/\s*${css_number}%?)?`
+const css_color_patterns = [
+  /^#(?:[\da-f]{3,4}|[\da-f]{6}|[\da-f]{8})$/i,
+  new RegExp(
+    String.raw`^oklch\(\s*${css_number}%?\s+${css_number}%?\s+${css_number}(?:deg)?${css_alpha}\s*\)$`,
+    'i',
+  ),
+  new RegExp(
+    String.raw`^rgba?\(\s*${css_number}%?(?:\s*,\s*|\s+)${css_number}%?(?:\s*,\s*|\s+)${css_number}%?(?:(?:\s*,\s*|\s*/\s*)${css_number}%?)?\s*\)$`,
+    'i',
+  ),
+  new RegExp(
+    String.raw`^hsla?\(\s*${css_number}(?:deg)?(?:\s*,\s*|\s+)${css_number}%(?:\s*,\s*|\s+)${css_number}%(?:(?:\s*,\s*|\s*/\s*)${css_number}%?)?\s*\)$`,
+    'i',
+  ),
+  new RegExp(String.raw`^${css_number}\s+${css_number}%\s+${css_number}%$`),
+]
+
+export const css_color = z
+  .string()
+  .max(100)
+  .refine(
+    (value) =>
+      css_color_patterns.some((css_color_pattern) =>
+        css_color_pattern.test(value.trim()),
+      ),
+    'Must be a CSS color: a hex code, `oklch()`, `rgb()`, or `hsl()`',
+  )

package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts

@@ -1,6 +1,6 @@
 import * as z from 'zod/v3'
 
-import { hex_color_code } from '../colors.js'
+import { css_color, hex_color_code } from '../colors.js'
 import { datetime } from '../datetime.js'
 
 export const customer_portal_theme = z.object({
@@ -12,6 +12,98 @@ export const customer_portal_theme = z.object({
   mono_font_family: z.string().optional(),
 })
 
+const instant_key_theme_colors = z
+  .object({
+    background: css_color.optional().describe('App background.'),
+    foreground: css_color.optional().describe('Default text color.'),
+    card: css_color.optional().describe('Card background.'),
+    card_foreground: css_color.optional().describe('Text color on cards.'),
+    popover: css_color.optional().describe('Dialog and sheet background.'),
+    popover_foreground: css_color
+      .optional()
+      .describe('Text color on dialogs and sheets.'),
+    primary: css_color.optional().describe('Primary buttons and highlights.'),
+    primary_foreground: css_color
+      .optional()
+      .describe('Text color on `primary`.'),
+    secondary: css_color.optional().describe('Secondary buttons.'),
+    secondary_foreground: css_color
+      .optional()
+      .describe('Text color on `secondary`.'),
+    muted: css_color
+      .optional()
+      .describe('Subtle backgrounds, such as the unlock sheet header.'),
+    muted_foreground: css_color.optional().describe('Secondary text.'),
+    accent: css_color.optional().describe('Pressed and hovered backgrounds.'),
+    accent_foreground: css_color.optional().describe('Text color on `accent`.'),
+    destructive: css_color
+      .optional()
+      .describe('Errors and destructive actions.'),
+    destructive_foreground: css_color
+      .optional()
+      .describe('Text color on `destructive`.'),
+    border: css_color.optional().describe('Borders and dividers.'),
+    input: css_color.optional().describe('Input borders.'),
+    ring: css_color.optional().describe('Focus rings.'),
+    success: css_color.optional().describe('Successful unlocks.'),
+    success_foreground: css_color
+      .optional()
+      .describe('Text color on `success`.'),
+    key_card: css_color.optional().describe('Start of the key card gradient.'),
+    key_card_end: css_color
+      .optional()
+      .describe('End of the key card gradient.'),
+    key_card_foreground: css_color
+      .optional()
+      .describe('Text and logo color on the key card.'),
+    unlock: css_color
+      .optional()
+      .describe('Start of the unlock button gradient.'),
+    unlock_end: css_color
+      .optional()
+      .describe('End of the unlock button gradient.'),
+    unlock_foreground: css_color
+      .optional()
+      .describe('Icon color on the unlock button.'),
+  })
+  .strict()
+
+export const instant_key_theme = z.object({
+  radius: z
+    .string()
+    .regex(
+      /^(?:\d+\.?\d*|\.\d+)(?:rem|px)?$/,
+      'Must be a length in `rem` or `px`, like `0.875rem` or `14px`',
+    )
+    .optional()
+    .describe(
+      'Corner radius for the Instant Key UI, as a CSS length such as `0.875rem` or `14px`.',
+    ),
+  font_family: z
+    .string()
+    .max(200)
+    .optional()
+    .describe(
+      'Font family for the Instant Key UI. The apps use the closest system typeface: sans-serif, serif, or monospace.',
+    ),
+  key_card_texture: z
+    .enum(['default', 'none'])
+    .optional()
+    .describe(
+      'Whether the key card shows its default texture over the key card gradient, or the gradient alone.',
+    ),
+  light: instant_key_theme_colors
+    .optional()
+    .describe(
+      "Light-mode colors, named after shadcn/ui's CSS variables in snake_case. Values are CSS colors in hex, `oklch()`, `rgb()`, or `hsl()` form. Colors you omit use the Seam default.",
+    ),
+  dark: instant_key_theme_colors
+    .optional()
+    .describe(
+      'Dark-mode colors, in the same form as `light`. When omitted, dark mode uses the Seam default with your `primary`, `primary_foreground`, and `ring` colors.',
+    ),
+})
+
 export const message_overrides = z.record(
   z.string(),
   z.record(z.string(), z.string()),
@@ -32,6 +124,9 @@ export const customization_profile = z.object({
   primary_color: z.string().optional(),
   secondary_color: z.string().optional(),
   customer_portal_theme: customer_portal_theme.optional(),
+  instant_key_theme: instant_key_theme
+    .optional()
+    .describe('Theme for the Instant Keys apps.'),
   message_overrides: message_overrides.optional(),
 }).describe(`
   ---

package/src/lib/seam/connect/models/devices/device-metadata.ts

@@ -997,12 +997,11 @@ export const device_metadata = z
           .string()
           .optional()
           .describe(`Product type for a Sensi device.`),
+        /** @deprecated Seam no longer sets this field. */
         dual_setpoints_not_supported: z
           .boolean()
           .optional()
-          .describe(
-            `Set to true when the device does not support the /dual-setpoints API endpoint.`,
-          ),
+          .describe(`Deprecated. Seam no longer sets this field.`),
       })
       .partial()
       .describe(`Metadata for a Sensi device.`),

package/src/lib/seam/connect/models/instant-keys/instant-key.ts

@@ -1,5 +1,6 @@
 import * as z from 'zod/v3'
 
+import { instant_key_theme } from '../customization-profiles/customization-profile.js'
 import { datetime } from '../datetime.js'
 
 export const instant_key = z.object({
@@ -50,6 +51,12 @@ export const instant_key = z.object({
         .url()
         .optional()
         .describe('URL of the logo displayed on the Instant Key.'),
+      instant_key_theme: instant_key_theme.optional().describe(`
+        ---
+        undocumented: Unreleased.
+        ---
+        Theme for the Instant Keys apps, from the customization profile's \`instant_key_theme\`. Omitted when the profile has none, in which case the apps use the Seam default theme.
+      `),
     })
     .optional()
     .describe('Customization applied to the Instant Key UI.'),