@ultdai/pulse 0.2.0 → 0.3.0

package/dist/contracts/index.d.ts

@@ -177,11 +177,37 @@ export declare const PulseTypeDefinitionSchema: z.ZodObject<{
     version: z.ZodNumber;
 }, z.core.$strict>;
 export declare const SignalReducerSchema: z.ZodEnum<{
+    "additive-window": "additive-window";
     "distinct-per-window": "distinct-per-window";
     lifecycle: "lifecycle";
     presence: "presence";
 }>;
 export declare const SignalTypeDefinitionSchema: z.ZodObject<{
+    additive: z.ZodOptional<z.ZodObject<{
+        baseScopeFields: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        cohortAtField: z.ZodString;
+        dedupeFields: z.ZodArray<z.ZodString>;
+        dimensionSets: z.ZodArray<z.ZodObject<{
+            kind: z.ZodString;
+            fields: z.ZodArray<z.ZodString>;
+        }, z.core.$strict>>;
+        latenessMs: z.ZodNumber;
+        metricRules: z.ZodArray<z.ZodObject<{
+            name: z.ZodString;
+            op: z.ZodEnum<{
+                count: "count";
+                sum: "sum";
+            }>;
+            unitField: z.ZodOptional<z.ZodString>;
+            valueField: z.ZodOptional<z.ZodString>;
+            when: z.ZodOptional<z.ZodObject<{
+                field: z.ZodString;
+                equals: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+            }, z.core.$strict>>;
+        }, z.core.$strict>>;
+        primaryMetric: z.ZodString;
+        stableScopeField: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
     id: z.ZodString;
     inputPulseTypes: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
@@ -203,6 +229,7 @@ export declare const SignalTypeDefinitionSchema: z.ZodObject<{
         timeoutMs: z.ZodNumber;
     }, z.core.$strict>>;
     reducer: z.ZodEnum<{
+        "additive-window": "additive-window";
         "distinct-per-window": "distinct-per-window";
         lifecycle: "lifecycle";
         presence: "presence";
@@ -229,6 +256,7 @@ export declare const MetricPulseTargetSchema: z.ZodObject<{
     refs: z.ZodArray<z.ZodObject<{
         signalId: z.ZodString;
         dimension: z.ZodString;
+        scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strict>>;
     sessionStartedAt: z.ZodString;
     shardCount: z.ZodNumber;
@@ -289,6 +317,7 @@ export declare const RoutedMetricPulseSchema: z.ZodObject<{
         refs: z.ZodArray<z.ZodObject<{
             signalId: z.ZodString;
             dimension: z.ZodString;
+            scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strict>>;
         sessionStartedAt: z.ZodString;
         shardCount: z.ZodNumber;
@@ -299,6 +328,86 @@ export declare const RoutedMetricPulseSchema: z.ZodObject<{
         windowStartAt: z.ZodOptional<z.ZodString>;
     }, z.core.$strict>;
 }, z.core.$strict>;
+/** A pulse carries a bounded vector of exact, non-sampled metric additions. */
+export declare const AdditivePulseTargetSchema: z.ZodObject<{
+    dedupeKey: z.ZodString;
+    generation: z.ZodNumber;
+    latenessMs: z.ZodNumber;
+    metrics: z.ZodRecord<z.ZodString, z.ZodNumber>;
+    organizationId: z.ZodString;
+    ownerId: z.ZodString;
+    primaryMetric: z.ZodString;
+    refs: z.ZodArray<z.ZodObject<{
+        signalId: z.ZodString;
+        dimension: z.ZodString;
+        scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    }, z.core.$strict>>;
+    shardCount: z.ZodNumber;
+    shardIndex: z.ZodNumber;
+    signalTypeId: z.ZodString;
+    stableScopeKey: z.ZodOptional<z.ZodString>;
+    windowEndAt: z.ZodString;
+    windowStartAt: z.ZodString;
+}, z.core.$strict>;
+export declare const RoutedAdditivePulseSchema: z.ZodObject<{
+    pulse: z.ZodObject<{
+        data: z.ZodDefault<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+        eventId: z.ZodOptional<z.ZodString>;
+        id: z.ZodString;
+        organizationId: z.ZodString;
+        sampling: z.ZodDefault<z.ZodObject<{
+            applied: z.ZodBoolean;
+            appliedKeepProbability: z.ZodNumber;
+            effectiveKeepProbability: z.ZodNumber;
+            ingressApplied: z.ZodBoolean;
+            ingressKeepProbability: z.ZodNumber;
+            ingressMethod: z.ZodEnum<{
+                none: "none";
+                "pulse-hash-v1": "pulse-hash-v1";
+            }>;
+            knownKeepProbability: z.ZodNullable<z.ZodNumber>;
+            method: z.ZodEnum<{
+                none: "none";
+                "pulse-hash-v1": "pulse-hash-v1";
+            }>;
+            policyId: z.ZodNullable<z.ZodString>;
+            policyRevision: z.ZodNullable<z.ZodNumber>;
+            unit: z.ZodEnum<{
+                member: "member";
+                pulse: "pulse";
+            }>;
+        }, z.core.$strict>>;
+        source: z.ZodString;
+        subject: z.ZodOptional<z.ZodObject<{
+            id: z.ZodString;
+            type: z.ZodString;
+        }, z.core.$strip>>;
+        type: z.ZodString;
+        typeVersion: z.ZodNumber;
+        occurredAt: z.ZodString;
+        receivedAt: z.ZodString;
+    }, z.core.$strict>;
+    target: z.ZodObject<{
+        dedupeKey: z.ZodString;
+        generation: z.ZodNumber;
+        latenessMs: z.ZodNumber;
+        metrics: z.ZodRecord<z.ZodString, z.ZodNumber>;
+        organizationId: z.ZodString;
+        ownerId: z.ZodString;
+        primaryMetric: z.ZodString;
+        refs: z.ZodArray<z.ZodObject<{
+            signalId: z.ZodString;
+            dimension: z.ZodString;
+            scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+        }, z.core.$strict>>;
+        shardCount: z.ZodNumber;
+        shardIndex: z.ZodNumber;
+        signalTypeId: z.ZodString;
+        stableScopeKey: z.ZodOptional<z.ZodString>;
+        windowEndAt: z.ZodString;
+        windowStartAt: z.ZodString;
+    }, z.core.$strict>;
+}, z.core.$strict>;
 export declare const LifecyclePulseTargetSchema: z.ZodObject<{
     generation: z.ZodNumber;
     groupId: z.ZodString;
@@ -312,6 +421,7 @@ export declare const LifecyclePulseTargetSchema: z.ZodObject<{
     refs: z.ZodArray<z.ZodObject<{
         signalId: z.ZodString;
         dimension: z.ZodString;
+        scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
     }, z.core.$strict>>;
     scopeId: z.ZodString;
     sessionStartedAt: z.ZodString;
@@ -372,6 +482,7 @@ export declare const RoutedLifecyclePulseSchema: z.ZodObject<{
         refs: z.ZodArray<z.ZodObject<{
             signalId: z.ZodString;
             dimension: z.ZodString;
+            scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
         }, z.core.$strict>>;
         scopeId: z.ZodString;
         sessionStartedAt: z.ZodString;
@@ -393,15 +504,20 @@ export declare const MetricSnapshotSchema: z.ZodObject<{
     varianceEstimate: z.ZodOptional<z.ZodNumber>;
     generation: z.ZodNumber;
     kind: z.ZodEnum<{
+        "additive-window": "additive-window";
         "distinct-per-window": "distinct-per-window";
         presence: "presence";
     }>;
+    latenessMs: z.ZodOptional<z.ZodNumber>;
+    metrics: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodNumber>>;
     observedAt: z.ZodString;
     organizationId: z.ZodString;
     originId: z.ZodString;
     recovering: z.ZodBoolean;
     revision: z.ZodNumber;
     sampledCount: z.ZodNumber;
+    scope: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    scopeKind: z.ZodOptional<z.ZodString>;
     shardCount: z.ZodNumber;
     signalId: z.ZodString;
     signalTypeId: z.ZodString;
@@ -517,6 +633,7 @@ export declare const LivePulseTargetSchema: z.ZodObject<{
     memberId: z.ZodString;
     organizationId: z.ZodString;
     reducer: z.ZodEnum<{
+        "additive-window": "additive-window";
         "distinct-per-window": "distinct-per-window";
         lifecycle: "lifecycle";
         presence: "presence";
@@ -570,6 +687,7 @@ export declare const RoutedLivePulseSchema: z.ZodObject<{
         memberId: z.ZodString;
         organizationId: z.ZodString;
         reducer: z.ZodEnum<{
+            "additive-window": "additive-window";
             "distinct-per-window": "distinct-per-window";
             lifecycle: "lifecycle";
             presence: "presence";
@@ -667,6 +785,8 @@ export type LiveShardSnapshot = z.infer<typeof LiveShardSnapshotSchema>;
 export type MetricPulseTarget = z.infer<typeof MetricPulseTargetSchema>;
 export type MetricSnapshot = z.infer<typeof MetricSnapshotSchema>;
 export type RoutedMetricPulse = z.infer<typeof RoutedMetricPulseSchema>;
+export type RoutedAdditivePulse = z.infer<typeof RoutedAdditivePulseSchema>;
+export type AdditivePulseTarget = z.infer<typeof AdditivePulseTargetSchema>;
 export type RoutedLifecyclePulse = z.infer<typeof RoutedLifecyclePulseSchema>;
 export type LifecyclePulseTarget = z.infer<typeof LifecyclePulseTargetSchema>;
 export type LifecycleDecision = z.infer<typeof LifecycleDecisionSchema>;

package/dist/index.js

@@ -11,22 +11,29 @@ var compilePayloadSchema = (value) => {
   const required = new Set(schema.required);
   const fields = {};
   for (const [name, field] of Object.entries(schema.properties)) {
-    let validator;
-    if (field.enum) {
-      if (field.enum.length === 0 || field.enum.some((item) => typeof item !== "string")) {
-        throw new Error(`Invalid enum for ${name}.`);
-      }
-      validator = z.enum(field.enum);
-    } else if (field.type === "string") {
+    let validator2;
+    if (field.pattern !== void 0 && field.type !== "string") {
+      throw new Error(`Pattern is only supported for string field ${name}.`);
+    }
+    if (field.type === "string" || field.type === void 0 && field.enum?.every((item) => typeof item === "string")) {
       let string = z.string();
       if (field.minLength !== void 0)
         string = string.min(field.minLength);
       if (field.maxLength !== void 0)
         string = string.max(field.maxLength);
+      if (field.pattern !== void 0) {
+        let pattern;
+        try {
+          pattern = new RegExp(field.pattern);
+        } catch {
+          throw new Error(`Invalid pattern for ${name}.`);
+        }
+        string = string.regex(pattern);
+      }
       if (field.format === "date-time") {
-        validator = string.refine((item) => Number.isFinite(Date.parse(item)), "Invalid date-time.");
+        validator2 = string.refine((item) => Number.isFinite(Date.parse(item)), "Invalid date-time.");
       } else if (field.format === void 0) {
-        validator = string;
+        validator2 = string;
       } else {
         throw new Error(`Unsupported string format for ${name}.`);
       }
@@ -36,20 +43,46 @@ var compilePayloadSchema = (value) => {
         number = number.min(field.minimum);
       if (field.maximum !== void 0)
         number = number.max(field.maximum);
-      validator = number;
+      validator2 = number;
     } else if (field.type === "boolean") {
-      validator = z.boolean();
+      validator2 = z.boolean();
     } else {
       throw new Error(`Unsupported payload field ${name}.`);
     }
-    fields[name] = required.has(name) ? validator : validator.optional();
+    if (field.enum !== void 0) {
+      const enumType = field.type === "number" || field.type === "integer" ? "number" : "string";
+      if (field.enum.length === 0 || field.enum.some((item) => typeof item !== enumType)) {
+        throw new Error(`Invalid enum for ${name}.`);
+      }
+      const allowed = new Set(field.enum);
+      validator2 = validator2.refine((item) => allowed.has(item), "Invalid enum value.");
+    }
+    fields[name] = required.has(name) ? validator2 : validator2.optional();
   }
   for (const name of required) {
     if (!fields[name])
       throw new Error(`Required payload field ${name} is undefined.`);
   }
   const object = z.object(fields);
-  return schema.additionalProperties === false ? object.strict() : object.passthrough();
+  const validator = schema.additionalProperties === false ? object.strict() : object.passthrough();
+  if (!schema.dependentRequired)
+    return validator;
+  for (const [field, dependents] of Object.entries(schema.dependentRequired)) {
+    if (!fields[field] || !Array.isArray(dependents) || dependents.some((dependent) => !fields[dependent])) {
+      throw new Error(`Invalid dependentRequired for ${field}.`);
+    }
+  }
+  return validator.superRefine((payload, context) => {
+    for (const [field, dependents] of Object.entries(schema.dependentRequired ?? {})) {
+      if (payload[field] === void 0)
+        continue;
+      for (const dependent of dependents) {
+        if (payload[dependent] === void 0) {
+          context.addIssue({ code: "custom", path: [dependent], message: `${dependent} is required with ${field}.` });
+        }
+      }
+    }
+  });
 };
 
 // ../../libs/contracts/dist/index.js
@@ -205,8 +238,36 @@ var PulseTypeDefinitionSchema = z2.object({
     context.addIssue({ code: "custom", path: ["lifecycle"], message: "Lifecycle pulses need explicit IDs, live delivery, and an interval only for observations." });
   }
 });
-var SignalReducerSchema = z2.enum(["presence", "distinct-per-window", "lifecycle"]);
+var SignalReducerSchema = z2.enum(["presence", "distinct-per-window", "lifecycle", "additive-window"]);
+var MetricNameSchema = z2.string().regex(/^[A-Za-z][A-Za-z0-9_]*$/).max(64);
+var AdditiveMetricRuleSchema = z2.object({
+  name: MetricNameSchema,
+  op: z2.enum(["count", "sum"]),
+  unitField: z2.string().trim().min(1).max(200).optional(),
+  valueField: z2.string().trim().min(1).max(200).optional(),
+  when: z2.object({
+    field: z2.string().trim().min(1).max(200),
+    equals: z2.union([z2.string(), z2.number().finite(), z2.boolean()])
+  }).strict().optional()
+}).strict().superRefine((rule, context) => {
+  if (rule.op === "sum" !== Boolean(rule.valueField)) {
+    context.addIssue({ code: "custom", path: ["valueField"], message: "Sum needs valueField; count must not have one." });
+  }
+});
 var SignalTypeDefinitionSchema = z2.object({
+  additive: z2.object({
+    baseScopeFields: z2.array(z2.string().trim().min(1).max(100)).max(4).optional(),
+    cohortAtField: z2.string().trim().min(1).max(200),
+    dedupeFields: z2.array(z2.string().trim().min(1).max(200)).min(1).max(4),
+    dimensionSets: z2.array(z2.object({
+      kind: z2.string().trim().min(1).max(100),
+      fields: z2.array(z2.string().trim().min(1).max(100)).max(4)
+    }).strict()).min(1).max(16),
+    latenessMs: z2.number().int().min(0).max(36e5),
+    metricRules: z2.array(AdditiveMetricRuleSchema).min(1).max(32),
+    primaryMetric: MetricNameSchema,
+    stableScopeField: z2.string().trim().min(1).max(200).optional()
+  }).strict().optional(),
   id: z2.string().trim().min(1).max(100),
   inputPulseTypes: z2.array(z2.object({
     id: z2.string().trim().min(1).max(100),
@@ -246,8 +307,26 @@ var SignalTypeDefinitionSchema = z2.object({
   if (definition.reducer === "lifecycle" && (!definition.lifecycle || !definition.partitionKey || !definition.dimensions?.length)) {
     context.addIssue({ code: "custom", path: ["lifecycle"], message: "Lifecycle needs a configuration, partition key and dimensions." });
   }
+  if (definition.reducer === "additive-window") {
+    const additive = definition.additive;
+    if (!additive || !definition.windowMs || !definition.partitionKey) {
+      context.addIssue({ code: "custom", path: ["additive"], message: "Additive window needs metrics, windowMs and partitionKey." });
+    } else {
+      const names = additive.metricRules.map((rule) => rule.name);
+      if (new Set(names).size !== names.length || !names.includes(additive.primaryMetric)) {
+        context.addIssue({ code: "custom", path: ["additive", "metricRules"], message: "Metric names must be unique and include the primary metric." });
+      }
+      const kinds = additive.dimensionSets.map((set) => set.kind);
+      const sets = additive.dimensionSets.map((set) => JSON.stringify(set.fields));
+      if (new Set(sets).size !== sets.length || new Set(kinds).size !== kinds.length) {
+        context.addIssue({ code: "custom", path: ["additive", "dimensionSets"], message: "Dimension sets and kinds must be unique." });
+      }
+    }
+  } else if (definition.additive) {
+    context.addIssue({ code: "custom", path: ["additive"], message: "Only additive-window signals may define additive metrics." });
+  }
   const schedule = definition.shardSchedule ?? [];
-  if (schedule.length > 0 && (!definition.partitionKey || !definition.dimensions?.length)) {
+  if (schedule.length > 0 && (!definition.partitionKey || !definition.dimensions?.length && !definition.additive?.dimensionSets.length)) {
     context.addIssue({ code: "custom", path: ["partitionKey"], message: "Scheduled routing needs partitionKey and dimensions." });
   }
   if (schedule.length > 0 && definition.reducer === "presence" && !definition.presence?.startedAtField) {
@@ -269,7 +348,8 @@ var SignalTypeDefinitionSchema = z2.object({
 });
 var MetricSignalRefSchema = z2.object({
   signalId: z2.string().trim().min(1).max(500),
-  dimension: z2.string().trim().min(1).max(100)
+  dimension: z2.string().trim().min(1).max(100),
+  scope: z2.record(z2.string().trim().min(1).max(100), z2.string().trim().min(1).max(200)).optional()
 }).strict();
 var MetricPulseTargetSchema = z2.object({
   generation: z2.number().int().positive(),
@@ -301,6 +381,33 @@ var RoutedMetricPulseSchema = z2.object({
   pulse: RawPulseSchema,
   target: MetricPulseTargetSchema
 }).strict();
+var AdditivePulseTargetSchema = z2.object({
+  dedupeKey: z2.string().trim().min(1).max(500),
+  generation: z2.number().int().positive(),
+  latenessMs: z2.number().int().min(0).max(36e5),
+  metrics: z2.record(MetricNameSchema, z2.number().int().safe().nonnegative()),
+  organizationId: z2.string().trim().min(1).max(100),
+  ownerId: z2.string().trim().min(1).max(500),
+  primaryMetric: MetricNameSchema,
+  refs: z2.array(MetricSignalRefSchema).min(1).max(16),
+  shardCount: z2.number().int().min(1).max(65536),
+  shardIndex: z2.number().int().nonnegative(),
+  signalTypeId: z2.string().trim().min(1).max(100),
+  stableScopeKey: z2.string().trim().min(1).max(500).optional(),
+  windowEndAt: isoDateTime,
+  windowStartAt: isoDateTime
+}).strict().superRefine((target, context) => {
+  if (target.shardIndex >= target.shardCount || Date.parse(target.windowStartAt) >= Date.parse(target.windowEndAt)) {
+    context.addIssue({ code: "custom", path: ["shardIndex"], message: "Invalid additive shard or window." });
+  }
+  if (!Object.hasOwn(target.metrics, target.primaryMetric)) {
+    context.addIssue({ code: "custom", path: ["metrics"], message: "Additive metrics must include the primary metric." });
+  }
+  if (new Set(target.refs.map((ref) => ref.signalId)).size !== target.refs.length) {
+    context.addIssue({ code: "custom", path: ["refs"], message: "Additive signal references must be unique." });
+  }
+});
+var RoutedAdditivePulseSchema = z2.object({ pulse: RawPulseSchema, target: AdditivePulseTargetSchema }).strict();
 var LifecyclePulseTargetSchema = z2.object({
   generation: z2.number().int().positive(),
   groupId: z2.string().trim().min(1).max(100),
@@ -335,22 +442,38 @@ var MetricSnapshotSchema = z2.object({
   estimatedCount: z2.number().finite().nonnegative(),
   varianceEstimate: z2.number().finite().nonnegative().optional(),
   generation: z2.number().int().positive(),
-  kind: z2.enum(["presence", "distinct-per-window"]),
+  kind: z2.enum(["presence", "distinct-per-window", "additive-window"]),
+  latenessMs: z2.number().int().min(0).max(36e5).optional(),
+  metrics: z2.record(MetricNameSchema, z2.number().int().safe().nonnegative()).optional(),
   observedAt: isoDateTime,
   organizationId: z2.string().trim().min(1).max(100),
   originId: z2.string().trim().min(1).max(200),
   recovering: z2.boolean(),
   revision: z2.number().int().nonnegative(),
   sampledCount: z2.number().int().nonnegative(),
+  scope: z2.record(z2.string().trim().min(1).max(100), z2.string().trim().min(1).max(200)).optional(),
+  scopeKind: z2.string().trim().min(1).max(100).optional(),
   shardCount: z2.number().int().min(1).max(65536),
   signalId: z2.string().trim().min(1).max(500),
   signalTypeId: z2.string().trim().min(1).max(100),
   windowEndAt: isoDateTime.optional(),
   windowStartAt: isoDateTime.optional()
 }).strict().superRefine((snapshot, context) => {
-  if (snapshot.kind === "distinct-per-window" && (!snapshot.windowStartAt || !snapshot.windowEndAt)) {
+  if ((snapshot.kind === "distinct-per-window" || snapshot.kind === "additive-window") && (!snapshot.windowStartAt || !snapshot.windowEndAt)) {
     context.addIssue({ code: "custom", path: ["windowStartAt"], message: "Distinct snapshot needs a window." });
   }
+  if (snapshot.kind === "additive-window" && !snapshot.metrics) {
+    context.addIssue({ code: "custom", path: ["metrics"], message: "Additive snapshot needs metrics." });
+  }
+  if (snapshot.kind === "additive-window" && snapshot.latenessMs === void 0) {
+    context.addIssue({ code: "custom", path: ["latenessMs"], message: "Additive snapshot needs its lateness bound." });
+  }
+  if (snapshot.kind === "additive-window" && (!snapshot.scope || !snapshot.scopeKind)) {
+    context.addIssue({ code: "custom", path: ["scope"], message: "Additive snapshot needs a structured scope." });
+  }
+  if (snapshot.kind !== "additive-window" && snapshot.metrics) {
+    context.addIssue({ code: "custom", path: ["metrics"], message: "Only additive snapshots carry metrics." });
+  }
   if (snapshot.kind === "presence" && (snapshot.windowStartAt || snapshot.windowEndAt)) {
     context.addIssue({ code: "custom", path: ["windowStartAt"], message: "Presence snapshot must not have a window." });
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ultdai/pulse",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "type": "module",
   "files": ["dist", "README.md"],
   "publishConfig": { "access": "public" },
@@ -14,7 +14,7 @@
   },
   "scripts": {
     "build": "node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true })\" && tsc -p tsconfig.json --emitDeclarationOnly && node scripts/bundle.mjs",
-    "prepack": "pnpm --dir ../../libs/contracts run build && pnpm run build",
+    "prepack": "corepack pnpm --dir ../../libs/contracts run build && corepack pnpm run build",
     "test": "vitest run test --exclude 'dist/**'",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },