@trillboards/edge-sdk 0.2.3 → 0.2.6

package/dist/setupMode.d.ts

@@ -0,0 +1,98 @@
+import { SetupSessionClient } from './SetupSessionClient';
+import { probeHost, type ChannelProbeResult } from './ChannelProber';
+import { discoverOnvifHosts, sweepLanForRecorders } from './discovery';
+import type { SetupProgressReporter } from './setupProgress';
+/**
+ * setupMode — `trillboards-edge setup`: the connector side of the
+ * validate-first onboarding flow (direction-inverted pairing).
+ *
+ *   1. start a SETUP SESSION and DISPLAY the short code (the owner claims it
+ *      in the portal — the ad-screen direction: device shows, owner types)
+ *   2. poll; once claimed, run LAN discovery (ONVIF multicast + a TCP
+ *      port-sweep for the huge no-ONVIF analog-DVR installed base) and report
+ *   3. execute probe/discover commands (ChannelProber — NVR-safe: auth
+ *      circuit-breaker, session-slot caps, real enumeration), streaming
+ *      per-channel results + thumbnails as they settle
+ *   4. when the owner finalizes, receive the config (screens + device tokens +
+ *      credential-free connection recipes), reassemble full rtsp:// URLs from
+ *      the LOCALLY-held credentials (they never round-trip through the
+ *      server), write trillboards.config.json, and exit 0 — the platform
+ *      wrapper then starts + verifies the background sensing service exactly
+ *      as in the honest-pairing flow.
+ *
+ * NVR credentials live ONLY in memory here (delivered per probe command) and
+ * are persisted solely into the local config file (0600) at finalize.
+ */
+export interface SetupModeOptions {
+    apiBaseUrl: string;
+    /** Portal opened for the automatic signed-in browser handoff. */
+    portalBaseUrl?: string;
+    configPath: string;
+    connectorVersion: string;
+    ffmpegPath?: string;
+    /** Overall wait for the owner to complete the wizard. Default 2h. */
+    maxWaitMs?: number;
+    client?: SetupSessionClient;
+    log?: (line: string) => void;
+    /** Injection points for tests. */
+    discover?: typeof discoverOnvifHosts;
+    sweep?: typeof sweepLanForRecorders;
+    probe?: typeof probeHost;
+    sleep?: (ms: number) => Promise<void>;
+    /** Injectable browser opener; false keeps the displayed-code fallback. */
+    openPortal?: (url: string) => Promise<boolean>;
+    /** Customer-safe structured progress for native installer applications. */
+    progress?: SetupProgressReporter;
+    /** Stable LAN identity fallback for recorders without ONVIF serials. */
+    lookupMac?: (host: string) => Promise<string | null>;
+}
+/** Stable, non-PII connector fingerprint (same derivation as cli.ts pairing). */
+export declare function setupHostFingerprint(): string;
+/**
+ * Build the one-time browser handoff without sending the setup code to the web
+ * server. URL fragments stay client-side; the portal consumes and removes it.
+ */
+export declare function buildSetupPortalUrl(displayCode: string, portalBaseUrl?: string): string;
+/** Open the setup handoff in the owner's default browser. Never uses a shell. */
+export declare function openSetupPortal(url: string, platform?: NodeJS.Platform): Promise<boolean>;
+export declare function normalizeDirectStreamUrl(input: string): string;
+export declare function mergeDiscoveredHosts(onvifHosts: unknown[], sweptHosts: unknown[]): unknown[];
+/**
+ * Merge a finalized setup into the local config.
+ *
+ * The finalized channel set is authoritative for each recorder touched by this
+ * setup. That prevents deleted/replaced portal cameras from remaining as hidden
+ * local sensing loops, while feeds from other recorders and direct RTSPS links
+ * remain intact.
+ */
+export declare function mergeConfigFile(existingRaw: string | null, incoming: {
+    apiBaseUrl: string;
+    cloudSensing: {
+        enabled: boolean;
+        periodicIntervalMs?: number;
+    };
+    localSensing?: {
+        enabled: boolean;
+        allowCloudFallback?: boolean;
+    };
+    cameras: Array<{
+        name: string;
+        screenId: string;
+        deviceToken: string;
+        channelKey: string;
+        host?: string;
+        port?: number;
+        pathTemplate?: string;
+        transport?: 'tcp' | 'udp';
+        sourceType?: 'recorder' | 'direct_url';
+    }>;
+}, credsByHost: Map<string, {
+    username: string;
+    password: string;
+}>, directUrlsByChannelKey?: Map<string, string>, probedByChannelKey?: Map<string, ChannelProbeResult>, macByHost?: Map<string, string>): Record<string, unknown>;
+/**
+ * Run the interactive setup session. Returns 0 on config-written, 2 on
+ * session-expired (restart for a fresh code), 1 on hard errors.
+ */
+export declare function runSetupMode(opts: SetupModeOptions): Promise<number>;
+//# sourceMappingURL=setupMode.d.ts.map

package/dist/setupMode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"setupMode.d.ts","sourceRoot":"","sources":["../src/setupMode.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,kBAAkB,EAA+C,MAAM,sBAAsB,CAAC;AACvG,OAAO,EACL,SAAS,EAMT,KAAK,kBAAkB,EACxB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AAKvE,OAAO,KAAK,EAAE,qBAAqB,EAAuB,MAAM,iBAAiB,CAAC;AAElF;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAC;IACnB,iEAAiE;IACjE,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,gBAAgB,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,qEAAqE;IACrE,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,GAAG,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,EAAE,OAAO,kBAAkB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,oBAAoB,CAAC;IACpC,KAAK,CAAC,EAAE,OAAO,SAAS,CAAC;IACzB,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC,0EAA0E;IAC1E,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAC/C,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,qBAAqB,CAAC;IACjC,wEAAwE;IACxE,SAAS,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;CACtD;AAED,iFAAiF;AACjF,wBAAgB,oBAAoB,IAAI,MAAM,CAG7C;AAOD;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,WAAW,EAAE,MAAM,EACnB,aAAa,GAAE,MAAgC,GAC9C,MAAM,CAaR;AAED,iFAAiF;AACjF,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,GAAE,MAAM,CAAC,QAA2B,GAAG,OAAO,CAAC,OAAO,CAAC,CAiC3G;AAED,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAsB9D;AAeD,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,OAAO,EAAE,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,EAAE,CAuB5F;AAiDD;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,EAC1B,QAAQ,EAAE;IACR,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAChE,YAAY,CAAC,EAAE;QAAE,OAAO,EAAE,OAAO,CAAC;QAAC,kBAAkB,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;IAClE,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,UAAU,EAAE,MAAM,CAAC;QACnB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC;QAC1B,UAAU,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;KACxC,CAAC,CAAC;CACJ,EACD,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EAChE,sBAAsB,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAa,EACvD,kBAAkB,GAAE,GAAG,CAAC,MAAM,EAAE,kBAAkB,CAAa,EAC/D,SAAS,GAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAa,GACzC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgIzB;AAED;;;GAGG;AACH,wBAAsB,YAAY,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAue1E"}