@camstack/addon-provider-reolink 0.1.1

package/assets/icon.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xml:space="preserve" id="Layer_1" x="0" y="0" version="1.1" viewBox="0 0 512 512"><style>.st0{fill:#1ea2e9}</style><path d="M62.9 87.7C155.8-18.8 317.5-29.9 424.1 63.1c37.7 32.9 65 76.1 78.4 124.4 35 126-30.7 258.1-152.2 306.3-32.5 12.7-67.1 18.9-101.9 18.2-82.7-1.2-165.5 0-248.2-1.1V252.5c.5-60.7 22.7-119.1 62.7-164.8m72 47.7c-32.2 32.2-50.2 75.9-50.1 121.4-.3 56.3 0 112.7 0 169 50.5 1.5 100.9 0 151.4 1.1 27.2.7 54.9-1.1 80.3-11.5 88.2-33.5 132.6-132.1 99.1-220.3S283.4 62.6 195.2 96c-22.7 8.6-43.3 22-60.4 39.2z" class="st0"/><path d="M182.9 158.9c53.3-40.6 129.5-30.3 170.1 23s30.3 129.5-23 170.1c-20 15.3-44.3 23.9-69.4 24.8-42 .5-84-.9-126.1-.5v-124c.9-36.9 18.8-71.3 48.4-93.4" class="st0"/></svg>

package/dist/addon.d.mts

@@ -0,0 +1,72 @@
+import { BaseDeviceProvider, DeviceType, DeviceConstructor, IDevice, ProviderRegistration, ConfigUISchema, CreateDeviceSpec, FieldProbeResult } from '@camstack/types';
+
+declare class ReolinkProviderAddon extends BaseDeviceProvider {
+    protected readonly addonId = "provider-reolink";
+    protected readonly providerName = "Reolink";
+    protected readonly deviceClasses: Partial<Record<DeviceType, DeviceConstructor<IDevice>>>;
+    /**
+     * Short-lived cache that bridges `testCreationField` and
+     * `onCreateDevice` — Slice 15 socket reuse. Both code paths key off
+     * `AutodetectCache.keyFor({host, username, password, uid, transport})`
+     * so a Test click and the subsequent Save share one Baichuan login.
+     */
+    private readonly autodetectCache;
+    constructor();
+    /**
+     * Reolink stableId derivation — uniform `mac → host(IP)` chain for
+     * every device type (camera, NVR, Home Hub).
+     *
+     * Priority:
+     *   1. mac  — hardware MAC from post-login `getNetworkInfo` (cmd 76+93,
+     *             no channel → host's interface). Durable across firmware
+     *             updates + DHCP renewals. Persisted in `deviceCache.mac`
+     *             by `onCreateDevice` AFTER `enrichHostIdentifiersFromLiveApi`.
+     *   2. host — operator-typed IP/hostname (DHCP-reservable). Always
+     *             present on Reolink adds (`onCreateDevice` validates
+     *             `persistHost` is non-empty before this code path).
+     *
+     * The legacy uid / serialNumber / autodetect deviceInfo data are NOT
+     * used for the stable key — they're often unreliable on the lib's
+     * TCP path (e.g. Home Hub returns `serialNumber: "00000000000000"`
+     * sentinel + the lib substitutes channel-0 data into `deviceInfo`
+     * when host probes flap mid-handshake). The mac/host chain is uniform
+     * and works on every Reolink device the lib supports.
+     *
+     * Re-adopt safety: re-adding the same physical device with its mac
+     * resolved reuses the same row. If the mac wasn't resolved (rare —
+     * `getNetworkInfo` works on every Reolink firmware we've tested),
+     * the host fallback at least gives a stable row per IP — operator
+     * can DHCP-reserve to make this durable.
+     */
+    protected generateStableId(_type: DeviceType, config?: Record<string, unknown>): string;
+    protected onShutdown(): Promise<void>;
+    protected onInitialize(): Promise<ProviderRegistration[]>;
+    /**
+     * Handle a broker-issued source-refresh request. With the lazy-publish
+     * model the broker always emits this on first dial of a
+     * `lazy:rfc4571:` placeholder URL — and re-emits it whenever the
+     * upstream rfc4571 socket idle-tears-down between consumer windows.
+     * We respond by materializing ONLY the requested camStream's upstream
+     * Baichuan session (`materializeStreamSocket`) — never republishing
+     * the full stream list. That keeps the firmware-side session count at
+     * "one per actively-watched (channel, profile) tuple" and avoids
+     * burning sessions on unrelated streams.
+     *
+     * The legacy fallback (when `camStreamId` is missing) re-publishes
+     * the full lazy stream list — the broker can then re-issue refresh
+     * for whichever stream needs it.
+     */
+    private refreshDeviceStreams;
+    protected onGetCreationSchema(type: DeviceType): Promise<ConfigUISchema | null>;
+    protected onCreateDevice(type: DeviceType, config: Record<string, unknown>): Promise<CreateDeviceSpec>;
+    private applyNvrCgiSanityCheck;
+    testCreationField(input: {
+        type: DeviceType;
+        key: string;
+        value: unknown;
+        formValues?: Record<string, unknown>;
+    }): Promise<FieldProbeResult>;
+    private republishAll;
+}
+
+export { ReolinkProviderAddon };

package/dist/addon.d.ts

@@ -0,0 +1,72 @@
+import { BaseDeviceProvider, DeviceType, DeviceConstructor, IDevice, ProviderRegistration, ConfigUISchema, CreateDeviceSpec, FieldProbeResult } from '@camstack/types';
+
+declare class ReolinkProviderAddon extends BaseDeviceProvider {
+    protected readonly addonId = "provider-reolink";
+    protected readonly providerName = "Reolink";
+    protected readonly deviceClasses: Partial<Record<DeviceType, DeviceConstructor<IDevice>>>;
+    /**
+     * Short-lived cache that bridges `testCreationField` and
+     * `onCreateDevice` — Slice 15 socket reuse. Both code paths key off
+     * `AutodetectCache.keyFor({host, username, password, uid, transport})`
+     * so a Test click and the subsequent Save share one Baichuan login.
+     */
+    private readonly autodetectCache;
+    constructor();
+    /**
+     * Reolink stableId derivation — uniform `mac → host(IP)` chain for
+     * every device type (camera, NVR, Home Hub).
+     *
+     * Priority:
+     *   1. mac  — hardware MAC from post-login `getNetworkInfo` (cmd 76+93,
+     *             no channel → host's interface). Durable across firmware
+     *             updates + DHCP renewals. Persisted in `deviceCache.mac`
+     *             by `onCreateDevice` AFTER `enrichHostIdentifiersFromLiveApi`.
+     *   2. host — operator-typed IP/hostname (DHCP-reservable). Always
+     *             present on Reolink adds (`onCreateDevice` validates
+     *             `persistHost` is non-empty before this code path).
+     *
+     * The legacy uid / serialNumber / autodetect deviceInfo data are NOT
+     * used for the stable key — they're often unreliable on the lib's
+     * TCP path (e.g. Home Hub returns `serialNumber: "00000000000000"`
+     * sentinel + the lib substitutes channel-0 data into `deviceInfo`
+     * when host probes flap mid-handshake). The mac/host chain is uniform
+     * and works on every Reolink device the lib supports.
+     *
+     * Re-adopt safety: re-adding the same physical device with its mac
+     * resolved reuses the same row. If the mac wasn't resolved (rare —
+     * `getNetworkInfo` works on every Reolink firmware we've tested),
+     * the host fallback at least gives a stable row per IP — operator
+     * can DHCP-reserve to make this durable.
+     */
+    protected generateStableId(_type: DeviceType, config?: Record<string, unknown>): string;
+    protected onShutdown(): Promise<void>;
+    protected onInitialize(): Promise<ProviderRegistration[]>;
+    /**
+     * Handle a broker-issued source-refresh request. With the lazy-publish
+     * model the broker always emits this on first dial of a
+     * `lazy:rfc4571:` placeholder URL — and re-emits it whenever the
+     * upstream rfc4571 socket idle-tears-down between consumer windows.
+     * We respond by materializing ONLY the requested camStream's upstream
+     * Baichuan session (`materializeStreamSocket`) — never republishing
+     * the full stream list. That keeps the firmware-side session count at
+     * "one per actively-watched (channel, profile) tuple" and avoids
+     * burning sessions on unrelated streams.
+     *
+     * The legacy fallback (when `camStreamId` is missing) re-publishes
+     * the full lazy stream list — the broker can then re-issue refresh
+     * for whichever stream needs it.
+     */
+    private refreshDeviceStreams;
+    protected onGetCreationSchema(type: DeviceType): Promise<ConfigUISchema | null>;
+    protected onCreateDevice(type: DeviceType, config: Record<string, unknown>): Promise<CreateDeviceSpec>;
+    private applyNvrCgiSanityCheck;
+    testCreationField(input: {
+        type: DeviceType;
+        key: string;
+        value: unknown;
+        formValues?: Record<string, unknown>;
+    }): Promise<FieldProbeResult>;
+    private republishAll;
+}
+
+export { ReolinkProviderAddon };