@camstack/types 1.2.12 → 1.2.14

package/dist/notification/timelapse-rule.d.ts

@@ -0,0 +1,136 @@
+/**
+ * TimelapseRule — the STANDALONE scheduled timelapse producer's rule model.
+ *
+ * Spec: `docs/superpowers/specs/2026-07-24-nc-occupancy-timelapse-design.md`
+ * §3.2/§3.3.
+ *
+ * Deliberately NOT a capability definition and NOT an `NcRule`:
+ *  - Every `NcDelivery` member is a *persisted-pipeline-record* trigger. A
+ *    timelapse fires on a SCHEDULE WINDOW BOUNDARY, evaluates no pipeline
+ *    record, and produces a video it assembled itself — so it rides no
+ *    delivery-enum member (the enum is frozen) and no cap method. This file is
+ *    a plain typed schema; it does NOT go through `npm run codegen`.
+ *  - It shares only the delivery leg (`notification-output.send`) and the
+ *    persistence/ownership patterns with the Notification Center, reusing
+ *    {@link NcScheduleSchema} (weekly windows, midnight-crossing, invertible)
+ *    and {@link NcRuleTargetSchema} (target ref + passthrough params).
+ *
+ * Ownership is SERVER-DERIVED. `ownerUserId` / `createdBy` / `createdAt` /
+ * `updatedAt` / `id` / `lastGeneratedAt` live on the PERSISTED rule only —
+ * {@link TimelapseRuleInputSchema} and {@link TimelapseRulePatchSchema} do not
+ * carry them, so a forged client payload can never claim or re-own a rule
+ * (Zod strips unknown keys). The store stamps them from the resolved caller.
+ */
+import { z } from 'zod';
+/** `{{var}}` templating over camera/rule/time — same vocabulary as `NcRule`. */
+export declare const TimelapseTemplateSchema: z.ZodObject<{
+    title: z.ZodOptional<z.ZodString>;
+    body: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type TimelapseTemplate = z.infer<typeof TimelapseTemplateSchema>;
+/**
+ * Client-supplied timelapse-rule fields. The server stamps id / createdBy /
+ * createdAt / updatedAt / ownerUserId / lastGeneratedAt — none of them appear
+ * here (see the ownership note above).
+ */
+export declare const TimelapseRuleInputSchema: z.ZodObject<{
+    name: z.ZodString;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    deviceIds: z.ZodArray<z.ZodNumber>;
+    schedule: z.ZodObject<{
+        windows: z.ZodArray<z.ZodObject<{
+            days: z.ZodArray<z.ZodNumber>;
+            startMinute: z.ZodNumber;
+            endMinute: z.ZodNumber;
+        }, z.core.$strip>>;
+        timezone: z.ZodOptional<z.ZodString>;
+        invert: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    cadenceSec: z.ZodDefault<z.ZodNumber>;
+    framerate: z.ZodDefault<z.ZodNumber>;
+    targets: z.ZodArray<z.ZodObject<{
+        targetId: z.ZodString;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    template: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        body: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    priority: z.ZodDefault<z.ZodNumber>;
+}, z.core.$strip>;
+export type TimelapseRuleInput = z.infer<typeof TimelapseRuleInputSchema>;
+/**
+ * Partial patch for an update — any subset of the INPUT fields, with NO
+ * defaults (an absent key means "leave unchanged", never "reset to default").
+ * Provenance and ownership are absent by construction: a patch can rename or
+ * retune a rule, never re-own it or forge its generation state.
+ *
+ * CLEAR SIGNAL: `template` is the one OPTIONAL field an editor can REMOVE, so
+ * it is `.nullable()` here and NOWHERE else. Wire representation:
+ *  - key absent          → leave the template unchanged
+ *  - `"template": null`  → CLEAR it (the persisted rule loses the key)
+ *  - `"template": {...}` → replace it
+ * `undefined` is deliberately NOT the clear signal: it does not survive
+ * `JSON.stringify`, so a viewer editor could not express "remove". The
+ * PERSISTED rule never carries `null` — the store drops the key (see
+ * `TimelapseStore.update`).
+ */
+export declare const TimelapseRulePatchSchema: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    enabled: z.ZodOptional<z.ZodBoolean>;
+    deviceIds: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    schedule: z.ZodOptional<z.ZodObject<{
+        windows: z.ZodArray<z.ZodObject<{
+            days: z.ZodArray<z.ZodNumber>;
+            startMinute: z.ZodNumber;
+            endMinute: z.ZodNumber;
+        }, z.core.$strip>>;
+        timezone: z.ZodOptional<z.ZodString>;
+        invert: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>>;
+    cadenceSec: z.ZodOptional<z.ZodNumber>;
+    framerate: z.ZodOptional<z.ZodNumber>;
+    targets: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        targetId: z.ZodString;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>>;
+    template: z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        body: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>>;
+    priority: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+export type TimelapseRulePatch = z.infer<typeof TimelapseRulePatchSchema>;
+/** A persisted timelapse rule. */
+export declare const TimelapseRuleSchema: z.ZodObject<{
+    name: z.ZodString;
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    deviceIds: z.ZodArray<z.ZodNumber>;
+    schedule: z.ZodObject<{
+        windows: z.ZodArray<z.ZodObject<{
+            days: z.ZodArray<z.ZodNumber>;
+            startMinute: z.ZodNumber;
+            endMinute: z.ZodNumber;
+        }, z.core.$strip>>;
+        timezone: z.ZodOptional<z.ZodString>;
+        invert: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strip>;
+    cadenceSec: z.ZodDefault<z.ZodNumber>;
+    framerate: z.ZodDefault<z.ZodNumber>;
+    targets: z.ZodArray<z.ZodObject<{
+        targetId: z.ZodString;
+        params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    }, z.core.$strip>>;
+    template: z.ZodOptional<z.ZodObject<{
+        title: z.ZodOptional<z.ZodString>;
+        body: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
+    priority: z.ZodDefault<z.ZodNumber>;
+    id: z.ZodString;
+    ownerUserId: z.ZodOptional<z.ZodString>;
+    lastGeneratedAt: z.ZodOptional<z.ZodNumber>;
+    createdBy: z.ZodString;
+    createdAt: z.ZodNumber;
+    updatedAt: z.ZodNumber;
+}, z.core.$strip>;
+export type TimelapseRule = z.infer<typeof TimelapseRuleSchema>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@camstack/types",
-  "version": "1.2.12",
+  "version": "1.2.14",
   "description": "Shared types, interfaces, and model catalogs for the CamStack detection ecosystem",
   "keywords": [
     "camstack",