@seamapi/react 5.0.0 → 5.1.1

package/lib/seam/ecosystem/types.d.ts

@@ -0,0 +1,312 @@
+/**
+ * Response types for the public Seam Ecosystem API (PartnerDB and DeviceDB).
+ *
+ * Hand-copied from the zod schemas in `seamapi/ecosystem` `public-types/`
+ * (origin/main 055335c, 2026-10-17) to avoid a zod runtime dependency.
+ * Fields stored verbatim from the source as JSON are typed as `unknown`.
+ * Keep in sync with Ecosystem until it publishes its types as a package.
+ */
+export interface EcosystemIndustry {
+    industry_id: string;
+    slug: string;
+    display_name: string;
+    short_name: string | null;
+}
+export interface EcosystemSolution {
+    solution_id: string;
+    slug: string;
+    display_name: string;
+    short_name: string | null;
+    type: 'software' | 'service';
+}
+export type PartnerAssetKind = 'square_logo' | 'square_logo_mono' | 'horizontal_logo' | 'horizontal_logo_mono' | 'product_image';
+export interface PartnerAsset {
+    partner_asset_id: string;
+    kind: PartnerAssetKind;
+    url: string;
+    mime: string;
+    width: number | null;
+    height: number | null;
+    sort_order: number;
+}
+export interface Partner {
+    partner_id: string;
+    slug: string;
+    display_name: string;
+    website: string | null;
+    description_md: string | null;
+    is_live: boolean;
+    is_featured: boolean;
+    legacy_industry_featured: boolean;
+    industries: EcosystemIndustry[];
+    solutions: EcosystemSolution[];
+    assets: PartnerAsset[];
+    created_at: string;
+    updated_at: string;
+}
+export type SupportLevel = 'device_category' | 'manufacturer' | 'provider' | 'capability';
+export type ObservedStatus = 'active' | 'trace' | 'none' | 'unknown';
+export type DeclaredStatus = 'enabled' | 'disabled' | 'not_via_seam';
+export interface SupportResolution {
+    supported: boolean;
+    resolved_level: SupportLevel | null;
+    declared_status: DeclaredStatus | null;
+    observed_status: ObservedStatus | null;
+    note: string | null;
+}
+export interface CompatiblePartner extends Partner {
+    support: SupportResolution;
+}
+export type EmbedKeyOwnerKind = 'partner' | 'manufacturer' | 'seam';
+/** The public record of an embed key, as returned by `embed/resolve`. */
+export interface EmbedKey {
+    embed_key_id: string;
+    display_name: string;
+    owner_kind: EmbedKeyOwnerKind;
+    partner_id: string | null;
+    manufacturer_slug: string | null;
+    allowed_origins: string[];
+    config: Record<string, unknown>;
+    revoked_at: string | null;
+    created_at: string;
+}
+export interface EmbedCapabilityExclusion {
+    device_category: string;
+    /** Empty means every manufacturer in the category. */
+    manufacturer_slug: string;
+    /** Empty means every provider in the category. */
+    provider_slug: string;
+}
+export interface EmbedExclusions {
+    excluded_manufacturers: string[];
+    excluded_device_types: string[];
+    unsupported_providers: string[];
+    capability: string;
+    capability_exclusions: EmbedCapabilityExclusion[];
+}
+/** The manufacturer a manufacturer-owned key scopes DeviceDB widgets to (DEVDB-439). */
+export interface EmbedManufacturerContext {
+    manufacturer_slug: string;
+}
+export interface EmbedResolution {
+    embed_key: EmbedKey;
+    /** Set for manufacturer-owned keys; null for partner and Seam keys. */
+    manufacturer_context?: EmbedManufacturerContext | null;
+    exclusions: EmbedExclusions;
+}
+export interface MediaFormat {
+    object_key: string;
+    url: string;
+    mime: string | null;
+    width: number | null;
+    height: number | null;
+    bytes: number | null;
+    sha256: string | null;
+}
+export type MediaFormatName = 'thumbnail' | 'small' | 'medium' | 'large';
+export type DeviceAssetKind = 'square_logo' | 'square_logo_mono' | 'horizontal_logo' | 'horizontal_logo_mono' | 'default_device_image' | 'featured' | 'variant_image';
+export interface DeviceAsset {
+    asset_id: string;
+    kind: DeviceAssetKind;
+    object_key: string;
+    url: string;
+    mime: string | null;
+    width: number | null;
+    height: number | null;
+    bytes: number | null;
+    sha256: string | null;
+    sort_order: number;
+    formats: Partial<Record<MediaFormatName, MediaFormat>>;
+    created_at: string;
+    updated_at: string;
+}
+export interface DeviceTypeRef {
+    device_type_id: string;
+    slug: string;
+    display_name: string;
+    is_accessory: boolean;
+}
+export interface ManufacturerRef {
+    manufacturer_id: string;
+    slug: string;
+    display_name: string | null;
+}
+export interface ProviderRef {
+    provider_id: string;
+    slug: string;
+    display_name: string | null;
+}
+export type CapabilityName = 'device_connectivity' | 'can_program_online_access_codes' | 'can_program_offline_access_codes' | 'can_remotely_unlock' | 'can_remotely_lock' | 'can_encode_plastic_cards' | 'can_provision_mobile_keys' | 'can_provision_wallet_keys' | 'can_hvac_cool' | 'can_hvac_heat' | 'can_hvac_auto' | 'can_hvac_fan' | 'can_program_thermostat_weekly_programs' | 'can_monitor';
+export type CapabilitySupported = 'yes' | 'no' | 'conditionally';
+export type IntegrationSupportLevel = 'inquire' | 'unavailable' | 'planned' | 'in-progress' | 'beta' | 'stable';
+export interface CapabilityReport {
+    details: string;
+    requirements?: Record<string, {
+        message: string;
+        device_slugs?: string[];
+        [key: string]: unknown;
+    }>;
+    dependencies?: string[];
+    [key: string]: unknown;
+}
+export interface CapabilityDetail {
+    capability_id: string;
+    name: CapabilityName;
+    supported: CapabilitySupported;
+    integration_support_level: IntegrationSupportLevel | null;
+    report: CapabilityReport | null;
+    report_raw: CapabilityReport | null;
+    locale: string;
+    computed_at: string;
+}
+export interface ProviderCapabilities {
+    provider: ProviderRef;
+    capabilities: CapabilityDetail[];
+}
+export interface DeviceModelVariant {
+    device_model_variant_id: string;
+    color_name: string | null;
+    style_name: string | null;
+    primary_color_hex: string | null;
+    manufacturer_model_id: string | null;
+    asin: string | null;
+    gtins: unknown;
+    marketplace_listings: unknown;
+    sort_order: number;
+    images: DeviceAsset[];
+    created_at: string;
+    updated_at: string;
+}
+export interface DeviceModel {
+    device_model_id: string;
+    slug: string;
+    display_name: string | null;
+    description_md: string | null;
+    product_url: string | null;
+    is_forbidden_to_3dparty: boolean | null;
+    no_longer_sold: boolean | null;
+    shop_listings: unknown;
+    last_commerce_search_at: string | null;
+    manufacturer: ManufacturerRef | null;
+    device_type: DeviceTypeRef | null;
+    device_type_properties: unknown;
+    variants: DeviceModelVariant[];
+    featured_image: DeviceAsset | null;
+    providers: ProviderRef[];
+    capabilities_by_provider: ProviderCapabilities[];
+    capabilities_stale: boolean;
+    created_at: string;
+    updated_at: string;
+}
+export interface DeviceImageFormat {
+    url: string;
+    width: number | null;
+    height: number | null;
+}
+export interface DeviceImage {
+    url: string;
+    mime: string | null;
+    width: number | null;
+    height: number | null;
+    formats: Partial<Record<MediaFormatName, DeviceImageFormat>>;
+}
+export interface CapabilitySummary {
+    name: CapabilityName;
+    supported: CapabilitySupported;
+    integration_support_level: IntegrationSupportLevel | null;
+    report: CapabilityReport | null;
+}
+export interface DeviceModelSummaryVariant {
+    device_model_variant_id: string;
+    color_name: string | null;
+    style_name: string | null;
+    primary_color_hex: string | null;
+    manufacturer_model_id: string | null;
+    images: DeviceImage[];
+    /** Only with `include=commerce`. */
+    asin?: string | null;
+    /** Only with `include=commerce`. */
+    gtins?: unknown;
+    /** Only with `include=commerce`. */
+    marketplace_listings?: unknown;
+}
+export interface DeviceModelSummary {
+    device_model_id: string;
+    slug: string;
+    display_name: string | null;
+    description_md: string | null;
+    product_url: string | null;
+    no_longer_sold: boolean | null;
+    is_forbidden_to_3dparty: boolean | null;
+    manufacturer: ManufacturerRef | null;
+    device_type: DeviceTypeRef | null;
+    device_type_properties: unknown;
+    featured_image: DeviceImage | null;
+    variants: DeviceModelSummaryVariant[];
+    providers: ProviderRef[];
+    capabilities_by_provider: Array<{
+        provider: ProviderRef;
+        capabilities: CapabilitySummary[];
+    }>;
+    capabilities_stale: boolean;
+    /** Only with `include=commerce`. */
+    shop_listings?: unknown;
+    /** Only with `include=commerce`. */
+    last_commerce_search_at?: string | null;
+    updated_at: string;
+}
+export interface ManufacturerDefaultDeviceImage {
+    device_type: DeviceTypeRef;
+    asset: DeviceAsset;
+}
+export interface Manufacturer {
+    manufacturer_id: string;
+    slug: string;
+    display_name: string | null;
+    website: string | null;
+    headquarters: string | null;
+    country_of_origin: string | null;
+    parent_org: string | null;
+    inc_date: string | null;
+    customer_support_phone: string | null;
+    customer_support_email: string | null;
+    customer_support_url: string | null;
+    description_md: string | null;
+    seam_api_guide: string | null;
+    commerce_footprint: unknown;
+    last_commerce_search_at: string | null;
+    logos: DeviceAsset[];
+    default_device_images: ManufacturerDefaultDeviceImage[];
+    providers: ProviderRef[];
+    device_model_count: number;
+    created_at: string;
+    updated_at: string;
+}
+export interface Pagination {
+    has_next_page: boolean;
+    next_page_cursor: string | null;
+}
+export interface CompatibilityResponse {
+    partners: CompatiblePartner[];
+}
+export interface DeviceModelsListResponse {
+    device_models: DeviceModel[];
+    pagination: Pagination;
+}
+export interface DeviceModelSummariesListResponse {
+    device_models: DeviceModelSummary[];
+    pagination: Pagination;
+}
+export interface ManufacturersListResponse {
+    manufacturers: Manufacturer[];
+    pagination: Pagination;
+}
+export interface EcosystemErrorResponse {
+    ok: false;
+    error: {
+        type: string;
+        message: string;
+        data?: Record<string, unknown>;
+        request_id?: string;
+    };
+}

package/lib/seam/ecosystem/types.js

@@ -0,0 +1,10 @@
+/**
+ * Response types for the public Seam Ecosystem API (PartnerDB and DeviceDB).
+ *
+ * Hand-copied from the zod schemas in `seamapi/ecosystem` `public-types/`
+ * (origin/main 055335c, 2026-10-17) to avoid a zod runtime dependency.
+ * Fields stored verbatim from the source as JSON are typed as `unknown`.
+ * Keep in sync with Ecosystem until it publishes its types as a package.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/lib/seam/ecosystem/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG"}

package/lib/seam/ecosystem/use-compatible-partners.d.ts

@@ -0,0 +1,21 @@
+import type { CompatiblePartner } from '../../../lib/seam/ecosystem/types.js';
+import { type UseEcosystemQueryResult } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+export interface UseCompatiblePartnersParams {
+    /** Device category, e.g., `smartlock`, `thermostat`, `sensor`, `intercom`. */
+    deviceType: string;
+    /** DeviceDB manufacturer slug, e.g., `schlage`. */
+    manufacturer?: string | undefined;
+    /** DeviceDB provider slug, e.g., `salto-ks`. */
+    provider?: string | undefined;
+    /** DeviceDB capability, e.g., `can_provision_mobile_keys`. */
+    capability?: string | undefined;
+    /** Industry slug, e.g., `short-term-rental`. */
+    industry?: string | undefined;
+}
+export type UseCompatiblePartnersData = CompatiblePartner[];
+/**
+ * The live partners that support a device category, manufacturer, provider
+ * or capability through Seam, from Ecosystem `GET /v1/compatibility`.
+ * Declared-first: a partner is listed only where Seam or the partner declared support.
+ */
+export declare function useCompatiblePartners({ deviceType, manufacturer, provider, capability, industry, }: UseCompatiblePartnersParams): UseEcosystemQueryResult<'partners', UseCompatiblePartnersData>;

package/lib/seam/ecosystem/use-compatible-partners.js

@@ -0,0 +1,36 @@
+import { useQuery } from '@tanstack/react-query';
+import { fetchEcosystem, } from '../../../lib/seam/ecosystem/client.js';
+import { useEcosystemContext } from '../../../lib/seam/ecosystem/EcosystemProvider.js';
+import { retryEcosystemQuery, } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+/**
+ * The live partners that support a device category, manufacturer, provider
+ * or capability through Seam, from Ecosystem `GET /v1/compatibility`.
+ * Declared-first: a partner is listed only where Seam or the partner declared support.
+ */
+export function useCompatiblePartners({ deviceType, manufacturer = '', provider = '', capability = '', industry = '', }) {
+    const { embedKey, endpoint } = useEcosystemContext();
+    const params = {
+        device_category: deviceType.trim(),
+        manufacturer_slug: manufacturer.trim(),
+        provider_slug: provider.trim(),
+        capability: capability.trim(),
+        industry: industry.trim(),
+    };
+    const { data, ...rest } = useQuery({
+        enabled: params.device_category.length > 0,
+        queryKey: [
+            'ecosystem',
+            endpoint,
+            embedKey ?? null,
+            'compatibility',
+            params,
+        ],
+        queryFn: async ({ signal }) => {
+            const { partners } = await fetchEcosystem('compatibility', { endpoint, embedKey, params, signal });
+            return partners;
+        },
+        retry: retryEcosystemQuery,
+    });
+    return { ...rest, partners: data };
+}
+//# sourceMappingURL=use-compatible-partners.js.map

package/lib/seam/ecosystem/use-compatible-partners.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-compatible-partners.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/use-compatible-partners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAEL,cAAc,GACf,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAK7E,OAAO,EACL,mBAAmB,GAEpB,MAAM,kDAAkD,CAAA;AAiBzD;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,EACpC,UAAU,EACV,YAAY,GAAG,EAAE,EACjB,QAAQ,GAAG,EAAE,EACb,UAAU,GAAG,EAAE,EACf,QAAQ,GAAG,EAAE,GACe;IAI5B,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,mBAAmB,EAAE,CAAA;IAEpD,MAAM,MAAM,GAAG;QACb,eAAe,EAAE,UAAU,CAAC,IAAI,EAAE;QAClC,iBAAiB,EAAE,YAAY,CAAC,IAAI,EAAE;QACtC,aAAa,EAAE,QAAQ,CAAC,IAAI,EAAE;QAC9B,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE;QAC7B,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE;KAC1B,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAGhC;QACA,OAAO,EAAE,MAAM,CAAC,eAAe,CAAC,MAAM,GAAG,CAAC;QAC1C,QAAQ,EAAE;YACR,WAAW;YACX,QAAQ;YACR,QAAQ,IAAI,IAAI;YAChB,eAAe;YACf,MAAM;SACP;QACD,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YAC5B,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,cAAc,CACvC,eAAe,EACf,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CACvC,CAAA;YACD,OAAO,QAAQ,CAAA;QACjB,CAAC;QACD,KAAK,EAAE,mBAAmB;KAC3B,CAAC,CAAA;IAEF,OAAO,EAAE,GAAG,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAA;AACpC,CAAC"}

package/lib/seam/ecosystem/use-ecosystem-device-model-summaries.d.ts

@@ -0,0 +1,11 @@
+import type { DeviceModelSummary } from '../../../lib/seam/ecosystem/types.js';
+import type { UseEcosystemDeviceModelsParams } from '../../../lib/seam/ecosystem/use-ecosystem-device-models.js';
+import { type UseEcosystemQueryResult } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+export type UseEcosystemDeviceModelSummariesParams = UseEcosystemDeviceModelsParams;
+export type UseEcosystemDeviceModelSummariesData = DeviceModelSummary[];
+/**
+ * Published device models in the slim summary shape from Ecosystem
+ * `GET /v1/device_models/summaries/list` (no commerce data),
+ * following pagination to return every matching model.
+ */
+export declare function useEcosystemDeviceModelSummaries({ manufacturer, deviceType, provider, capability, enabled, }?: UseEcosystemDeviceModelSummariesParams): UseEcosystemQueryResult<'deviceModels', UseEcosystemDeviceModelSummariesData>;

package/lib/seam/ecosystem/use-ecosystem-device-model-summaries.js

@@ -0,0 +1,53 @@
+import { useQuery } from '@tanstack/react-query';
+import { fetchEcosystem, } from '../../../lib/seam/ecosystem/client.js';
+import { useEcosystemContext } from '../../../lib/seam/ecosystem/EcosystemProvider.js';
+import { retryEcosystemQuery, } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+const pageSize = 500;
+const maxPages = 20;
+/**
+ * Published device models in the slim summary shape from Ecosystem
+ * `GET /v1/device_models/summaries/list` (no commerce data),
+ * following pagination to return every matching model.
+ */
+export function useEcosystemDeviceModelSummaries({ manufacturer = '', deviceType = '', provider = '', capability = '', enabled = true, } = {}) {
+    const { embedKey, endpoint } = useEcosystemContext();
+    const params = {
+        manufacturer: manufacturer.trim(),
+        device_type: deviceType.trim(),
+        provider: provider.trim(),
+        capability: capability.trim(),
+    };
+    const { data, ...rest } = useQuery({
+        enabled,
+        queryKey: [
+            'ecosystem',
+            endpoint,
+            embedKey ?? null,
+            'device_models',
+            'summaries',
+            'list',
+            params,
+        ],
+        queryFn: async ({ signal }) => {
+            const deviceModels = [];
+            let pageCursor;
+            for (let page = 0; page < maxPages; page++) {
+                const res = await fetchEcosystem('device_models/summaries/list', {
+                    endpoint,
+                    embedKey,
+                    params: { ...params, limit: pageSize, page_cursor: pageCursor },
+                    signal,
+                });
+                deviceModels.push(...res.device_models);
+                const { has_next_page: hasNextPage, next_page_cursor: nextPageCursor } = res.pagination;
+                if (!hasNextPage || nextPageCursor == null)
+                    break;
+                pageCursor = nextPageCursor;
+            }
+            return deviceModels;
+        },
+        retry: retryEcosystemQuery,
+    });
+    return { ...rest, deviceModels: data };
+}
+//# sourceMappingURL=use-ecosystem-device-model-summaries.js.map

package/lib/seam/ecosystem/use-ecosystem-device-model-summaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-ecosystem-device-model-summaries.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/use-ecosystem-device-model-summaries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAEL,cAAc,GACf,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAM7E,OAAO,EACL,mBAAmB,GAEpB,MAAM,kDAAkD,CAAA;AAOzD,MAAM,QAAQ,GAAG,GAAG,CAAA;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAA;AAEnB;;;;GAIG;AACH,MAAM,UAAU,gCAAgC,CAAC,EAC/C,YAAY,GAAG,EAAE,EACjB,UAAU,GAAG,EAAE,EACf,QAAQ,GAAG,EAAE,EACb,UAAU,GAAG,EAAE,EACf,OAAO,GAAG,IAAI,MAC4B,EAAE;IAI5C,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,mBAAmB,EAAE,CAAA;IAEpD,MAAM,MAAM,GAAG;QACb,YAAY,EAAE,YAAY,CAAC,IAAI,EAAE;QACjC,WAAW,EAAE,UAAU,CAAC,IAAI,EAAE;QAC9B,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE;KAC9B,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAGhC;QACA,OAAO;QACP,QAAQ,EAAE;YACR,WAAW;YACX,QAAQ;YACR,QAAQ,IAAI,IAAI;YAChB,eAAe;YACf,WAAW;YACX,MAAM;YACN,MAAM;SACP;QACD,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YAC5B,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,IAAI,UAA8B,CAAA;YAClC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;gBAC3C,MAAM,GAAG,GAAG,MAAM,cAAc,CAC9B,8BAA8B,EAC9B;oBACE,QAAQ;oBACR,QAAQ;oBACR,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE;oBAC/D,MAAM;iBACP,CACF,CAAA;gBACD,YAAY,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,CAAA;gBACvC,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GACpE,GAAG,CAAC,UAAU,CAAA;gBAChB,IAAI,CAAC,WAAW,IAAI,cAAc,IAAI,IAAI;oBAAE,MAAK;gBACjD,UAAU,GAAG,cAAc,CAAA;YAC7B,CAAC;YACD,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,KAAK,EAAE,mBAAmB;KAC3B,CAAC,CAAA;IAEF,OAAO,EAAE,GAAG,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA;AACxC,CAAC"}

package/lib/seam/ecosystem/use-ecosystem-device-models.d.ts

@@ -0,0 +1,20 @@
+import type { DeviceModel } from '../../../lib/seam/ecosystem/types.js';
+import { type UseEcosystemQueryResult } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+export interface UseEcosystemDeviceModelsParams {
+    /** DeviceDB manufacturer slug, e.g., `schlage`. */
+    manufacturer?: string | undefined;
+    /** DeviceDB device type slug, e.g., `smartlock`. */
+    deviceType?: string | undefined;
+    /** DeviceDB provider slug, e.g., `salto-ks`. */
+    provider?: string | undefined;
+    /** Only device models with a computed capability of this name. */
+    capability?: string | undefined;
+    /** Set to false to wait before fetching. */
+    enabled?: boolean | undefined;
+}
+export type UseEcosystemDeviceModelsData = DeviceModel[];
+/**
+ * Published device models from Ecosystem `GET /v1/device_models/list`,
+ * following pagination to return every matching model.
+ */
+export declare function useEcosystemDeviceModels({ manufacturer, deviceType, provider, capability, enabled, }?: UseEcosystemDeviceModelsParams): UseEcosystemQueryResult<'deviceModels', UseEcosystemDeviceModelsData>;

package/lib/seam/ecosystem/use-ecosystem-device-models.js

@@ -0,0 +1,51 @@
+import { useQuery } from '@tanstack/react-query';
+import { fetchEcosystem, } from '../../../lib/seam/ecosystem/client.js';
+import { useEcosystemContext } from '../../../lib/seam/ecosystem/EcosystemProvider.js';
+import { retryEcosystemQuery, } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+const pageSize = 500;
+const maxPages = 20;
+/**
+ * Published device models from Ecosystem `GET /v1/device_models/list`,
+ * following pagination to return every matching model.
+ */
+export function useEcosystemDeviceModels({ manufacturer = '', deviceType = '', provider = '', capability = '', enabled = true, } = {}) {
+    const { embedKey, endpoint } = useEcosystemContext();
+    const params = {
+        manufacturer: manufacturer.trim(),
+        device_type: deviceType.trim(),
+        provider: provider.trim(),
+        capability: capability.trim(),
+    };
+    const { data, ...rest } = useQuery({
+        enabled,
+        queryKey: [
+            'ecosystem',
+            endpoint,
+            embedKey ?? null,
+            'device_models',
+            'list',
+            params,
+        ],
+        queryFn: async ({ signal }) => {
+            const deviceModels = [];
+            let pageCursor;
+            for (let page = 0; page < maxPages; page++) {
+                const res = await fetchEcosystem('device_models/list', {
+                    endpoint,
+                    embedKey,
+                    params: { ...params, limit: pageSize, page_cursor: pageCursor },
+                    signal,
+                });
+                deviceModels.push(...res.device_models);
+                const { has_next_page: hasNextPage, next_page_cursor: nextPageCursor } = res.pagination;
+                if (!hasNextPage || nextPageCursor == null)
+                    break;
+                pageCursor = nextPageCursor;
+            }
+            return deviceModels;
+        },
+        retry: retryEcosystemQuery,
+    });
+    return { ...rest, deviceModels: data };
+}
+//# sourceMappingURL=use-ecosystem-device-models.js.map

package/lib/seam/ecosystem/use-ecosystem-device-models.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-ecosystem-device-models.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/use-ecosystem-device-models.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAEL,cAAc,GACf,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAK7E,OAAO,EACL,mBAAmB,GAEpB,MAAM,kDAAkD,CAAA;AAiBzD,MAAM,QAAQ,GAAG,GAAG,CAAA;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAA;AAEnB;;;GAGG;AACH,MAAM,UAAU,wBAAwB,CAAC,EACvC,YAAY,GAAG,EAAE,EACjB,UAAU,GAAG,EAAE,EACf,QAAQ,GAAG,EAAE,EACb,UAAU,GAAG,EAAE,EACf,OAAO,GAAG,IAAI,MACoB,EAAE;IAIpC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,mBAAmB,EAAE,CAAA;IAEpD,MAAM,MAAM,GAAG;QACb,YAAY,EAAE,YAAY,CAAC,IAAI,EAAE;QACjC,WAAW,EAAE,UAAU,CAAC,IAAI,EAAE;QAC9B,QAAQ,EAAE,QAAQ,CAAC,IAAI,EAAE;QACzB,UAAU,EAAE,UAAU,CAAC,IAAI,EAAE;KAC9B,CAAA;IAED,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAGhC;QACA,OAAO;QACP,QAAQ,EAAE;YACR,WAAW;YACX,QAAQ;YACR,QAAQ,IAAI,IAAI;YAChB,eAAe;YACf,MAAM;YACN,MAAM;SACP;QACD,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YAC5B,MAAM,YAAY,GAAkB,EAAE,CAAA;YACtC,IAAI,UAA8B,CAAA;YAClC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;gBAC3C,MAAM,GAAG,GAAG,MAAM,cAAc,CAC9B,oBAAoB,EACpB;oBACE,QAAQ;oBACR,QAAQ;oBACR,MAAM,EAAE,EAAE,GAAG,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE;oBAC/D,MAAM;iBACP,CACF,CAAA;gBACD,YAAY,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,CAAA;gBACvC,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GACpE,GAAG,CAAC,UAAU,CAAA;gBAChB,IAAI,CAAC,WAAW,IAAI,cAAc,IAAI,IAAI;oBAAE,MAAK;gBACjD,UAAU,GAAG,cAAc,CAAA;YAC7B,CAAC;YACD,OAAO,YAAY,CAAA;QACrB,CAAC;QACD,KAAK,EAAE,mBAAmB;KAC3B,CAAC,CAAA;IAEF,OAAO,EAAE,GAAG,IAAI,EAAE,YAAY,EAAE,IAAI,EAAE,CAAA;AACxC,CAAC"}

package/lib/seam/ecosystem/use-ecosystem-manufacturers.d.ts

@@ -0,0 +1,11 @@
+import type { Manufacturer } from '../../../lib/seam/ecosystem/types.js';
+import { type UseEcosystemQueryResult } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+export interface UseEcosystemManufacturersParams {
+    /** Only manufacturers with these slugs. */
+    slugs?: string[] | undefined;
+    /** Set to false to wait before fetching. */
+    enabled?: boolean | undefined;
+}
+export type UseEcosystemManufacturersData = Manufacturer[];
+/** Published manufacturers from Ecosystem `GET /v1/manufacturers/list`. */
+export declare function useEcosystemManufacturers({ slugs, enabled, }?: UseEcosystemManufacturersParams): UseEcosystemQueryResult<'manufacturers', UseEcosystemManufacturersData>;

package/lib/seam/ecosystem/use-ecosystem-manufacturers.js

@@ -0,0 +1,49 @@
+import { useQuery } from '@tanstack/react-query';
+import { fetchEcosystem, } from '../../../lib/seam/ecosystem/client.js';
+import { useEcosystemContext } from '../../../lib/seam/ecosystem/EcosystemProvider.js';
+import { retryEcosystemQuery, } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+const pageSize = 500;
+const maxPages = 10;
+/** Published manufacturers from Ecosystem `GET /v1/manufacturers/list`. */
+export function useEcosystemManufacturers({ slugs, enabled = true, } = {}) {
+    const { embedKey, endpoint } = useEcosystemContext();
+    const sortedSlugs = slugs == null
+        ? null
+        : [...new Set(slugs)].sort((a, b) => a.localeCompare(b));
+    const { data, ...rest } = useQuery({
+        enabled: enabled && (sortedSlugs == null || sortedSlugs.length > 0),
+        queryKey: [
+            'ecosystem',
+            endpoint,
+            embedKey ?? null,
+            'manufacturers',
+            'list',
+            { slugs: sortedSlugs },
+        ],
+        queryFn: async ({ signal }) => {
+            const manufacturers = [];
+            let pageCursor;
+            for (let page = 0; page < maxPages; page++) {
+                const res = await fetchEcosystem('manufacturers/list', {
+                    endpoint,
+                    embedKey,
+                    params: {
+                        slugs: sortedSlugs ?? undefined,
+                        limit: pageSize,
+                        page_cursor: pageCursor,
+                    },
+                    signal,
+                });
+                manufacturers.push(...res.manufacturers);
+                const { has_next_page: hasNextPage, next_page_cursor: nextPageCursor } = res.pagination;
+                if (!hasNextPage || nextPageCursor == null)
+                    break;
+                pageCursor = nextPageCursor;
+            }
+            return manufacturers;
+        },
+        retry: retryEcosystemQuery,
+    });
+    return { ...rest, manufacturers: data };
+}
+//# sourceMappingURL=use-ecosystem-manufacturers.js.map

package/lib/seam/ecosystem/use-ecosystem-manufacturers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-ecosystem-manufacturers.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/use-ecosystem-manufacturers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAA;AAEhD,OAAO,EAEL,cAAc,GACf,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,MAAM,yCAAyC,CAAA;AAK7E,OAAO,EACL,mBAAmB,GAEpB,MAAM,kDAAkD,CAAA;AAWzD,MAAM,QAAQ,GAAG,GAAG,CAAA;AACpB,MAAM,QAAQ,GAAG,EAAE,CAAA;AAEnB,2EAA2E;AAC3E,MAAM,UAAU,yBAAyB,CAAC,EACxC,KAAK,EACL,OAAO,GAAG,IAAI,MACqB,EAAE;IAIrC,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,mBAAmB,EAAE,CAAA;IAEpD,MAAM,WAAW,GACf,KAAK,IAAI,IAAI;QACX,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAA;IAE5D,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,QAAQ,CAGhC;QACA,OAAO,EAAE,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC;QACnE,QAAQ,EAAE;YACR,WAAW;YACX,QAAQ;YACR,QAAQ,IAAI,IAAI;YAChB,eAAe;YACf,MAAM;YACN,EAAE,KAAK,EAAE,WAAW,EAAE;SACvB;QACD,OAAO,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE;YAC5B,MAAM,aAAa,GAAmB,EAAE,CAAA;YACxC,IAAI,UAA8B,CAAA;YAClC,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,CAAC;gBAC3C,MAAM,GAAG,GAAG,MAAM,cAAc,CAC9B,oBAAoB,EACpB;oBACE,QAAQ;oBACR,QAAQ;oBACR,MAAM,EAAE;wBACN,KAAK,EAAE,WAAW,IAAI,SAAS;wBAC/B,KAAK,EAAE,QAAQ;wBACf,WAAW,EAAE,UAAU;qBACxB;oBACD,MAAM;iBACP,CACF,CAAA;gBACD,aAAa,CAAC,IAAI,CAAC,GAAG,GAAG,CAAC,aAAa,CAAC,CAAA;gBACxC,MAAM,EAAE,aAAa,EAAE,WAAW,EAAE,gBAAgB,EAAE,cAAc,EAAE,GACpE,GAAG,CAAC,UAAU,CAAA;gBAChB,IAAI,CAAC,WAAW,IAAI,cAAc,IAAI,IAAI;oBAAE,MAAK;gBACjD,UAAU,GAAG,cAAc,CAAA;YAC7B,CAAC;YACD,OAAO,aAAa,CAAA;QACtB,CAAC;QACD,KAAK,EAAE,mBAAmB;KAC3B,CAAC,CAAA;IAEF,OAAO,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAA;AACzC,CAAC"}

package/lib/seam/ecosystem/use-ecosystem-query-result.d.ts

@@ -0,0 +1,7 @@
+import type { UseQueryResult } from '@tanstack/react-query';
+import type { EcosystemApiError } from '../../../lib/seam/ecosystem/client.js';
+export type UseEcosystemQueryResult<Field extends string, Data> = Omit<UseQueryResult<Data, EcosystemApiError>, 'data'> & {
+    [key in Field]?: Data;
+};
+/** Retry server and network errors, but not client errors such as an invalid embed key. */
+export declare const retryEcosystemQuery: (failureCount: number, error: EcosystemApiError) => boolean;

package/lib/seam/ecosystem/use-ecosystem-query-result.js

@@ -0,0 +1,7 @@
+/** Retry server and network errors, but not client errors such as an invalid embed key. */
+export const retryEcosystemQuery = (failureCount, error) => {
+    if (error.status >= 400 && error.status < 500)
+        return false;
+    return failureCount < 2;
+};
+//# sourceMappingURL=use-ecosystem-query-result.js.map

package/lib/seam/ecosystem/use-ecosystem-query-result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-ecosystem-query-result.js","sourceRoot":"","sources":["../../../src/lib/seam/ecosystem/use-ecosystem-query-result.ts"],"names":[],"mappings":"AAWA,2FAA2F;AAC3F,MAAM,CAAC,MAAM,mBAAmB,GAAG,CACjC,YAAoB,EACpB,KAAwB,EACf,EAAE;IACX,IAAI,KAAK,CAAC,MAAM,IAAI,GAAG,IAAI,KAAK,CAAC,MAAM,GAAG,GAAG;QAAE,OAAO,KAAK,CAAA;IAC3D,OAAO,YAAY,GAAG,CAAC,CAAA;AACzB,CAAC,CAAA"}

package/lib/seam/ecosystem/use-embed-key-resolution.d.ts

@@ -0,0 +1,20 @@
+import type { EmbedResolution } from '../../../lib/seam/ecosystem/types.js';
+import { type UseEcosystemQueryResult } from '../../../lib/seam/ecosystem/use-ecosystem-query-result.js';
+export interface UseEmbedKeyResolutionParams {
+    /** Resolve the partner's capability exclusions for this capability. */
+    capability?: string | undefined;
+}
+export type UseEmbedKeyResolutionData = EmbedResolution;
+/**
+ * Validates the provider's embed key against the page origin with
+ * Ecosystem `GET /v1/embed/resolve` and returns the key's public record
+ * and, for partner keys, what the partner's widgets must not show.
+ * Disabled when there is no embed key.
+ */
+export declare function useEmbedKeyResolution({ capability, }?: UseEmbedKeyResolutionParams): UseEcosystemQueryResult<'embedResolution', UseEmbedKeyResolutionData>;
+/**
+ * The manufacturer an embed key is scoped to, if any.
+ * Prefers the `manufacturer_context` Ecosystem returns for manufacturer keys (DEVDB-439),
+ * and falls back to the key's own `manufacturer_slug`.
+ */
+export declare const getEmbedKeyManufacturer: (resolution: EmbedResolution | null | undefined) => string | null;