@boboddy/sdk 0.5.0 → 0.5.2

package/dist/definitions/steps/step-features.d.ts

@@ -1,3 +1,4 @@
+import { z } from "zod";
 import type { ZodObject, ZodRawShape } from "zod";
 type FeatureSignalSpec = {
     key: string;
@@ -17,24 +18,69 @@ export type AnyStepFeature = StepFeature;
 type UnionToIntersection<U> = (U extends unknown ? (x: U) => void : never) extends (x: infer I) => void ? I : never;
 export type FeatureResultExtensions<TFeatures extends readonly AnyStepFeature[]> = [TFeatures[number]] extends [never] ? Record<never, never> : UnionToIntersection<TFeatures[number] extends StepFeature<infer R> ? R : never>;
 export type FeatureSignalKeys<TFeatures extends readonly AnyStepFeature[]> = NonNullable<TFeatures[number]["__signalKeys"]>;
-export type NotificationKind = "feedback_request" | "status_update" | "blocked" | "result_ready" | "warning";
-export type NotificationPriority = "low" | "normal" | "high" | "urgent";
-export type NotificationChannel = "in_app" | "work_item_platform_comment" | "email" | "slack";
+declare const notificationKindSchema: z.ZodEnum<{
+    blocked: "blocked";
+    feedback_request: "feedback_request";
+    status_update: "status_update";
+    result_ready: "result_ready";
+    warning: "warning";
+}>;
+export type NotificationKind = z.infer<typeof notificationKindSchema>;
+declare const notificationPrioritySchema: z.ZodEnum<{
+    high: "high";
+    low: "low";
+    normal: "normal";
+    urgent: "urgent";
+}>;
+export type NotificationPriority = z.infer<typeof notificationPrioritySchema>;
+declare const notificationChannelSchema: z.ZodEnum<{
+    in_app: "in_app";
+    work_item_platform_comment: "work_item_platform_comment";
+    email: "email";
+    slack: "slack";
+}>;
+export type NotificationChannel = z.infer<typeof notificationChannelSchema>;
 export type FeedbackRequestUrgency = "blocking" | "clarification" | "assumption" | "informational";
-export type NotificationItem = {
-    kind: NotificationKind;
-    title: string;
-    body: string;
-    priority: NotificationPriority;
-    suggestedChannels?: NotificationChannel[];
-    /**
-     * Kind-specific structured payload. For `feedback_request`:
-     * `{ category, urgency, suggestedKey? }`.
-     */
-    payload?: Record<string, unknown>;
-};
 declare const NOTIFICATION_SIGNAL_KEY: "$boboddy_notifications_v1";
 declare const NOTIFICATION_RESULT_KEY: "$boboddy_notifications_v1";
+declare const notificationItemSchema: z.ZodObject<{
+    kind: z.ZodEnum<{
+        blocked: "blocked";
+        feedback_request: "feedback_request";
+        status_update: "status_update";
+        result_ready: "result_ready";
+        warning: "warning";
+    }>;
+    title: z.ZodString;
+    body: z.ZodString;
+    priority: z.ZodEnum<{
+        high: "high";
+        low: "low";
+        normal: "normal";
+        urgent: "urgent";
+    }>;
+    suggestedChannels: z.ZodOptional<z.ZodArray<z.ZodEnum<{
+        in_app: "in_app";
+        work_item_platform_comment: "work_item_platform_comment";
+        email: "email";
+        slack: "slack";
+    }>>>;
+    payload: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+/** A single notification. Inferred from `notificationItemSchema` — the
+ * schema is the source of truth; this type can never drift from what's
+ * actually validated and pushed as JSON Schema. */
+export type NotificationItem = z.infer<typeof notificationItemSchema>;
+/**
+ * The shape `Notify.*` returns: a step result fragment carrying one or more
+ * notifications. Spread it into a larger result object, or return it
+ * directly if the notification *is* the step's whole result — either way it
+ * slots into the same `$boboddy_notifications_v1` field `Features.notifications()`
+ * wires a signal extractor for.
+ */
+export type NotificationResultFragment = {
+    readonly [NOTIFICATION_RESULT_KEY]: NotificationItem[];
+};
 type NotificationsFeature = StepFeature<{
     [NOTIFICATION_RESULT_KEY]?: NotificationItem[];
 }, typeof NOTIFICATION_SIGNAL_KEY>;
@@ -45,23 +91,38 @@ export type FeedbackRequestItem = {
     suggestedKey?: string;
 };
 export declare const Features: {
-    readonly notifications: (() => NotificationsFeature) & {
-        signal: {
-            key: "$boboddy_notifications_v1";
-            find(signals: Array<{
-                key: string;
-                valueJson: unknown;
-            }>): NotificationItem[] | undefined;
-        };
-    };
+    readonly notifications: () => NotificationsFeature;
     /**
-     * Convenience wrapper that emits `feedback_request` notifications.
-     * Backed by the same `$boboddy_notifications_v1` signal.
+     * A real specialization of `notifications()`, not an alias: narrows every
+     * emitted item to `kind: "feedback_request"` and swaps in a
+     * feedback-request-specific prompt section. Backed by the same
+     * `$boboddy_notifications_v1` signal.
      */
-    readonly feedbackRequests: (() => NotificationsFeature) & {
-        signal: {
-            key: "$boboddy_notifications_v1";
-        };
-    };
+    readonly feedbackRequests: () => NotificationsFeature;
+};
+export declare const NotificationSignal: {
+    readonly key: "$boboddy_notifications_v1";
+    readonly find: (signals: Array<{
+        key: string;
+        valueJson: unknown;
+    }>) => NotificationItem[] | undefined;
+};
+export declare const Notify: {
+    /** The one generic constructor. Field names match `NotificationItem`
+     * exactly, so a new optional field never forces a call-site rewrite. */
+    readonly create: (item: NotificationItem) => NotificationResultFragment;
+    /** Build a notification for the in-app inbox — the one channel the
+     * platform always delivers, so it's the safest default when the caller
+     * doesn't need a specific channel. */
+    readonly inApp: (title: string, body: string, priority: NotificationPriority, options?: {
+        kind?: NotificationKind;
+        payload?: Record<string, unknown>;
+    }) => NotificationResultFragment;
+    /** Build a `kind: "feedback_request"` notification — the value-builder
+     * counterpart to `Features.feedbackRequests()`. */
+    readonly feedbackRequest: (question: string, category: string, urgency: FeedbackRequestUrgency, suggestedKey?: string) => NotificationResultFragment;
+    /** Combine several notification result fragments (e.g. more than one
+     * `Notify.*` call) into a single result value. */
+    readonly merge: (...fragments: NotificationResultFragment[]) => NotificationResultFragment;
 };
 export {};

package/dist/definitions/validation/index.d.ts

@@ -1,2 +1,4 @@
 export * from "./json-schema-paths";
 export * from "./validate-definition-specs";
+export * from "./validate-input-bindings";
+export * from "./validation-issue";