@rippling/rippling-sdk 0.2.0-alpha.34 → 0.2.0-alpha.36

package/lib/manifest/rule.d.mts

@@ -1,34 +1,99 @@
 import { type TriggerType, type UpdateTriggerType } from "./_helpers.mjs";
 import type { CustomObject } from "./custom-object.mjs";
 import type { Field } from "./field.mjs";
+/**
+ * A single action performed when a {@link Rule} fires.
+ */
 export interface RuleAction {
-    /** Target field — live `Field` ref. */
+    /**
+     * The field to set when this action runs.
+     *
+     * Required.
+     */
     targetField: Field;
     /**
-     * Set the target to a fixed value. Mutually exclusive with `rqlFormula`.
-     * For `SELECT` / `RADIO` targets, the wire payload uses a list (multichoice
-     * shape); pass a string/one value or an array — both are normalized to an array.
+     * Set the target field to a fixed value. Mutually exclusive with `rqlFormula`.
+     *
+     * Optional. For `SELECT` / `RADIO` fields, pass a string or single-element array —
+     * both are normalized to an array on the wire.
      */
     fixedValue?: any;
-    /** Set the target to the result of an RQL formula. */
+    /**
+     * Set the target field to the result of an RQL formula. Mutually exclusive with `fixedValue`.
+     *
+     * Optional.
+     */
     rqlFormula?: string;
 }
+/**
+ * Initialization properties for {@link Rule}.
+ */
 export interface RuleProps {
-    /** Required. Display name of the flow. */
+    /**
+     * Display name of this automation rule shown in the UI.
+     *
+     * Required.
+     */
     flowName: string;
-    /** Required. When the flow fires. */
+    /**
+     * When this rule fires. One of `'CREATE'` | `'UPDATE'` | `'CREATE_OR_UPDATE'`.
+     *
+     * Required. The constructor throws if an invalid value is passed.
+     */
     triggerType: TriggerType;
-    /** Identity override. Override the flow identifier. @default generateId('flow') */
+    /**
+     * Stable identifier for this rule. Pass a human-readable slug
+     * (e.g. `'gym_default_enrollment_status'`) to keep it stable across regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('flow')
+     */
     flowId?: string;
-    /** Optional. RQL formula guard — fires only when truthy. @default null */
+    /**
+     * RQL formula guard — the rule fires only when this expression is truthy.
+     *
+     * Optional. @default null
+     */
     rqlCondition?: string;
-    /** Conditional. Update-trigger condition type. @default 'MEETS_CONDITION_AFTER_ONLY' */
+    /**
+     * Controls when an `UPDATE` trigger fires relative to the condition.
+     * One of `'MEETS_CONDITION_AFTER_ONLY'` | `'MEETS_CONDITION_BEFORE_OR_AFTER'`.
+     *
+     * Conditional. Only meaningful when `triggerType` is `'UPDATE'` or `'CREATE_OR_UPDATE'`.
+     * @default `'MEETS_CONDITION_AFTER_ONLY'`
+     */
     updateTriggerType?: UpdateTriggerType;
-    /** Optional. Internal description. @default null */
+    /**
+     * Internal description of this rule (for developer reference only).
+     *
+     * Optional. @default null
+     */
     description?: string;
-    /** Optional. Actions to run when the flow fires. @default [] */
+    /**
+     * Actions to run when the rule fires. Each action sets one field to a fixed value
+     * or RQL formula result.
+     *
+     * Optional. @default `[]`
+     */
     actions?: RuleAction[];
 }
+/**
+ * Defines a record-triggered automation rule and registers it with the manifest.
+ *
+ * A rule fires automatically when a record on the parent custom object is created,
+ * updated, or both — depending on `triggerType`. Each rule runs a list of actions
+ * that set field values, optionally guarded by an RQL condition.
+ *
+ * @example
+ * ```ts
+ * new Rule(enrollmentObj, {
+ *   flowId: 'gym_default_enrollment_status',
+ *   flowName: 'Default attendance to Registered',
+ *   triggerType: 'CREATE',
+ *   description: 'New roster rows start as Registered unless changed',
+ *   actions: [{ targetField: enrollmentAttendanceField, fixedValue: ['Registered'] }],
+ * });
+ * ```
+ */
 export declare class Rule {
     private readonly _flowId;
     private readonly _customObjectApiName;
@@ -38,13 +103,26 @@ export declare class Rule {
     private readonly _updateTriggerType;
     private readonly _description;
     private readonly _actions;
-    /** Build a new rule and auto-register with the CO's scope; validates `triggerType`. */
+    /**
+     * @param customObject - The custom object this rule is attached to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.triggerType` is not one of `'CREATE'`, `'UPDATE'`, `'CREATE_OR_UPDATE'`.
+     */
     constructor(customObject: CustomObject, props: RuleProps);
-    /** Backend flow_id used as this rule's identifier. */
+    /**
+     * Returns the stable identifier for this rule (e.g. `'gym_default_enrollment_status'`).
+     */
     getFlowId(): string;
-    /** api_name of the CustomObject this rule lives on. */
+    /**
+     * Returns the api_name of the custom object this rule is attached to.
+     */
     getCustomObjectApiName(): string;
-    /** Serialize to the backend `CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW` wire shape. */
+    /**
+     * Serializes this rule to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW'`.
+     * Optional fields are omitted when unset; `actions` is omitted when empty.
+     */
     toDict(): Record<string, any>;
 }
 //# sourceMappingURL=rule.d.mts.map

package/lib/manifest/rule.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"rule.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"OAWO,EAAc,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE;OACxD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAIrB,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,WAAW,EAAE,KAAK,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,WAAW,EAAE,WAAW,CAAC;IACzB,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wFAAwF;IACxF,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AA0BD,qBAAa,IAAI;IACf,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAgC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IAExC,uFAAuF;gBAC3E,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS;IAiBxD,sDAAsD;IACtD,SAAS,IAAI,MAAM;IAInB,uDAAuD;IACvD,sBAAsB,IAAI,MAAM;IAIhC,iFAAiF;IACjF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"rule.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"OAAO,EAAc,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE;OACxD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAErB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC;IACnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AA0BD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,IAAI;IACf,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAgC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IAExC;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS;IAkBxD;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;;OAKG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/rule.d.ts

@@ -1,34 +1,99 @@
 import { type TriggerType, type UpdateTriggerType } from "./_helpers.js";
 import type { CustomObject } from "./custom-object.js";
 import type { Field } from "./field.js";
+/**
+ * A single action performed when a {@link Rule} fires.
+ */
 export interface RuleAction {
-    /** Target field — live `Field` ref. */
+    /**
+     * The field to set when this action runs.
+     *
+     * Required.
+     */
     targetField: Field;
     /**
-     * Set the target to a fixed value. Mutually exclusive with `rqlFormula`.
-     * For `SELECT` / `RADIO` targets, the wire payload uses a list (multichoice
-     * shape); pass a string/one value or an array — both are normalized to an array.
+     * Set the target field to a fixed value. Mutually exclusive with `rqlFormula`.
+     *
+     * Optional. For `SELECT` / `RADIO` fields, pass a string or single-element array —
+     * both are normalized to an array on the wire.
      */
     fixedValue?: any;
-    /** Set the target to the result of an RQL formula. */
+    /**
+     * Set the target field to the result of an RQL formula. Mutually exclusive with `fixedValue`.
+     *
+     * Optional.
+     */
     rqlFormula?: string;
 }
+/**
+ * Initialization properties for {@link Rule}.
+ */
 export interface RuleProps {
-    /** Required. Display name of the flow. */
+    /**
+     * Display name of this automation rule shown in the UI.
+     *
+     * Required.
+     */
     flowName: string;
-    /** Required. When the flow fires. */
+    /**
+     * When this rule fires. One of `'CREATE'` | `'UPDATE'` | `'CREATE_OR_UPDATE'`.
+     *
+     * Required. The constructor throws if an invalid value is passed.
+     */
     triggerType: TriggerType;
-    /** Identity override. Override the flow identifier. @default generateId('flow') */
+    /**
+     * Stable identifier for this rule. Pass a human-readable slug
+     * (e.g. `'gym_default_enrollment_status'`) to keep it stable across regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('flow')
+     */
     flowId?: string;
-    /** Optional. RQL formula guard — fires only when truthy. @default null */
+    /**
+     * RQL formula guard — the rule fires only when this expression is truthy.
+     *
+     * Optional. @default null
+     */
     rqlCondition?: string;
-    /** Conditional. Update-trigger condition type. @default 'MEETS_CONDITION_AFTER_ONLY' */
+    /**
+     * Controls when an `UPDATE` trigger fires relative to the condition.
+     * One of `'MEETS_CONDITION_AFTER_ONLY'` | `'MEETS_CONDITION_BEFORE_OR_AFTER'`.
+     *
+     * Conditional. Only meaningful when `triggerType` is `'UPDATE'` or `'CREATE_OR_UPDATE'`.
+     * @default `'MEETS_CONDITION_AFTER_ONLY'`
+     */
     updateTriggerType?: UpdateTriggerType;
-    /** Optional. Internal description. @default null */
+    /**
+     * Internal description of this rule (for developer reference only).
+     *
+     * Optional. @default null
+     */
     description?: string;
-    /** Optional. Actions to run when the flow fires. @default [] */
+    /**
+     * Actions to run when the rule fires. Each action sets one field to a fixed value
+     * or RQL formula result.
+     *
+     * Optional. @default `[]`
+     */
     actions?: RuleAction[];
 }
+/**
+ * Defines a record-triggered automation rule and registers it with the manifest.
+ *
+ * A rule fires automatically when a record on the parent custom object is created,
+ * updated, or both — depending on `triggerType`. Each rule runs a list of actions
+ * that set field values, optionally guarded by an RQL condition.
+ *
+ * @example
+ * ```ts
+ * new Rule(enrollmentObj, {
+ *   flowId: 'gym_default_enrollment_status',
+ *   flowName: 'Default attendance to Registered',
+ *   triggerType: 'CREATE',
+ *   description: 'New roster rows start as Registered unless changed',
+ *   actions: [{ targetField: enrollmentAttendanceField, fixedValue: ['Registered'] }],
+ * });
+ * ```
+ */
 export declare class Rule {
     private readonly _flowId;
     private readonly _customObjectApiName;
@@ -38,13 +103,26 @@ export declare class Rule {
     private readonly _updateTriggerType;
     private readonly _description;
     private readonly _actions;
-    /** Build a new rule and auto-register with the CO's scope; validates `triggerType`. */
+    /**
+     * @param customObject - The custom object this rule is attached to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.triggerType` is not one of `'CREATE'`, `'UPDATE'`, `'CREATE_OR_UPDATE'`.
+     */
     constructor(customObject: CustomObject, props: RuleProps);
-    /** Backend flow_id used as this rule's identifier. */
+    /**
+     * Returns the stable identifier for this rule (e.g. `'gym_default_enrollment_status'`).
+     */
     getFlowId(): string;
-    /** api_name of the CustomObject this rule lives on. */
+    /**
+     * Returns the api_name of the custom object this rule is attached to.
+     */
     getCustomObjectApiName(): string;
-    /** Serialize to the backend `CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW` wire shape. */
+    /**
+     * Serializes this rule to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW'`.
+     * Optional fields are omitted when unset; `actions` is omitted when empty.
+     */
     toDict(): Record<string, any>;
 }
 //# sourceMappingURL=rule.d.ts.map

package/lib/manifest/rule.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"OAWO,EAAc,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE;OACxD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAIrB,MAAM,WAAW,UAAU;IACzB,uCAAuC;IACvC,WAAW,EAAE,KAAK,CAAC;IACnB;;;;OAIG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB,sDAAsD;IACtD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,SAAS;IACxB,0CAA0C;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,qCAAqC;IACrC,WAAW,EAAE,WAAW,CAAC;IACzB,mFAAmF;IACnF,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0EAA0E;IAC1E,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,wFAAwF;IACxF,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC,oDAAoD;IACpD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,gEAAgE;IAChE,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AA0BD,qBAAa,IAAI;IACf,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAgC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IAExC,uFAAuF;gBAC3E,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS;IAiBxD,sDAAsD;IACtD,SAAS,IAAI,MAAM;IAInB,uDAAuD;IACvD,sBAAsB,IAAI,MAAM;IAIhC,iFAAiF;IACjF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"rule.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"OAAO,EAAc,KAAK,WAAW,EAAE,KAAK,iBAAiB,EAAE;OACxD,KAAK,EAAE,YAAY,EAAE;OACrB,KAAK,EAAE,KAAK,EAAE;AAErB;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,WAAW,EAAE,KAAK,CAAC;IACnB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,GAAG,CAAC;IACjB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,EAAE,WAAW,CAAC;IACzB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;;;OAMG;IACH,iBAAiB,CAAC,EAAE,iBAAiB,CAAC;IACtC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;CACxB;AA0BD;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,IAAI;IACf,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAS;IAC9C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAc;IAC3C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IACnD,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAgC;IACnE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAe;IAExC;;;;OAIG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,SAAS;IAkBxD;;OAEG;IACH,SAAS,IAAI,MAAM;IAInB;;OAEG;IACH,sBAAsB,IAAI,MAAM;IAIhC;;;;;OAKG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/rule.js

@@ -1,18 +1,7 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * Record-triggered flows (automation rules) for custom objects.
- * Backend schema: CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW (v2)
- *
- * Construction is CDK-style: `new Rule(customObject, props)` — the CO is
- * the first positional arg, and the rule auto-registers with the manifest
- * via the CO's scope chain.
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Rule = void 0;
 const _helpers_1 = require("./_helpers.js");
-const VALID_TRIGGERS = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
 /** SELECT / RADIO rule actions use list `fixed_value` (Rippling rule builder). */
 function fixedValueToWire(targetField, value) {
     const ft = targetField.getFieldType();
@@ -36,9 +25,32 @@ function actionToDict(action) {
     }
     return out;
 }
+/**
+ * Defines a record-triggered automation rule and registers it with the manifest.
+ *
+ * A rule fires automatically when a record on the parent custom object is created,
+ * updated, or both — depending on `triggerType`. Each rule runs a list of actions
+ * that set field values, optionally guarded by an RQL condition.
+ *
+ * @example
+ * ```ts
+ * new Rule(enrollmentObj, {
+ *   flowId: 'gym_default_enrollment_status',
+ *   flowName: 'Default attendance to Registered',
+ *   triggerType: 'CREATE',
+ *   description: 'New roster rows start as Registered unless changed',
+ *   actions: [{ targetField: enrollmentAttendanceField, fixedValue: ['Registered'] }],
+ * });
+ * ```
+ */
 class Rule {
-    /** Build a new rule and auto-register with the CO's scope; validates `triggerType`. */
+    /**
+     * @param customObject - The custom object this rule is attached to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.triggerType` is not one of `'CREATE'`, `'UPDATE'`, `'CREATE_OR_UPDATE'`.
+     */
     constructor(customObject, props) {
+        const VALID_TRIGGERS = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
         if (!VALID_TRIGGERS.includes(props.triggerType)) {
             throw new Error(`Invalid trigger_type: ${props.triggerType}. Must be one of: ${VALID_TRIGGERS.join(', ')}`);
         }
@@ -52,15 +64,24 @@ class Rule {
         this._actions = [...(props.actions ?? [])];
         customObject._register(this);
     }
-    /** Backend flow_id used as this rule's identifier. */
+    /**
+     * Returns the stable identifier for this rule (e.g. `'gym_default_enrollment_status'`).
+     */
     getFlowId() {
         return this._flowId;
     }
-    /** api_name of the CustomObject this rule lives on. */
+    /**
+     * Returns the api_name of the custom object this rule is attached to.
+     */
     getCustomObjectApiName() {
         return this._customObjectApiName;
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW` wire shape. */
+    /**
+     * Serializes this rule to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW'`.
+     * Optional fields are omitted when unset; `actions` is omitted when empty.
+     */
     toDict() {
         const component = {
             type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW',

package/lib/manifest/rule.js.map

@@ -1 +1 @@
-{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":";AAAA;;;;;;;;;GASG;;;AAEH,4CAAkF;AAIlF,MAAM,cAAc,GAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAgC/E,kFAAkF;AAClF,SAAS,gBAAgB,CAAC,WAAkB,EAAE,KAAU;IACtD,MAAM,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IACtC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,MAAM,GAAG,GAAwB;QAC/B,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE;KAC9C,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC9B,GAAG,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/E,CAAC;SAAM,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QACrC,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAa,IAAI;IAUf,uFAAuF;IACvF,YAAY,YAA0B,EAAE,KAAgB;QACtD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,yBAAyB,KAAK,CAAC,WAAW,qBAAqB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3C,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,sDAAsD;IACtD,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,uDAAuD;IACvD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,iFAAiF;IACjF,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,qCAAqC;YAC3C,cAAc,EAAE,IAAI,CAAC,oBAAoB;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAChG,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACrF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AArDD,oBAqDC"}
+{"version":3,"file":"rule.js","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":";;;AAAA,4CAAkF;AAiFlF,kFAAkF;AAClF,SAAS,gBAAgB,CAAC,WAAkB,EAAE,KAAU;IACtD,MAAM,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IACtC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,MAAM,GAAG,GAAwB;QAC/B,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE;KAC9C,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC9B,GAAG,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/E,CAAC;SAAM,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QACrC,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,IAAI;IAUf;;;;OAIG;IACH,YAAY,YAA0B,EAAE,KAAgB;QACtD,MAAM,cAAc,GAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,yBAAyB,KAAK,CAAC,WAAW,qBAAqB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3C,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,qCAAqC;YAC3C,cAAc,EAAE,IAAI,CAAC,oBAAoB;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAChG,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACrF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAnED,oBAmEC"}

package/lib/manifest/rule.mjs

@@ -1,15 +1,4 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
- *
- * Record-triggered flows (automation rules) for custom objects.
- * Backend schema: CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW (v2)
- *
- * Construction is CDK-style: `new Rule(customObject, props)` — the CO is
- * the first positional arg, and the rule auto-registers with the manifest
- * via the CO's scope chain.
- */
 import { generateId } from "./_helpers.mjs";
-const VALID_TRIGGERS = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
 /** SELECT / RADIO rule actions use list `fixed_value` (Rippling rule builder). */
 function fixedValueToWire(targetField, value) {
     const ft = targetField.getFieldType();
@@ -33,9 +22,32 @@ function actionToDict(action) {
     }
     return out;
 }
+/**
+ * Defines a record-triggered automation rule and registers it with the manifest.
+ *
+ * A rule fires automatically when a record on the parent custom object is created,
+ * updated, or both — depending on `triggerType`. Each rule runs a list of actions
+ * that set field values, optionally guarded by an RQL condition.
+ *
+ * @example
+ * ```ts
+ * new Rule(enrollmentObj, {
+ *   flowId: 'gym_default_enrollment_status',
+ *   flowName: 'Default attendance to Registered',
+ *   triggerType: 'CREATE',
+ *   description: 'New roster rows start as Registered unless changed',
+ *   actions: [{ targetField: enrollmentAttendanceField, fixedValue: ['Registered'] }],
+ * });
+ * ```
+ */
 export class Rule {
-    /** Build a new rule and auto-register with the CO's scope; validates `triggerType`. */
+    /**
+     * @param customObject - The custom object this rule is attached to.
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.triggerType` is not one of `'CREATE'`, `'UPDATE'`, `'CREATE_OR_UPDATE'`.
+     */
     constructor(customObject, props) {
+        const VALID_TRIGGERS = ['CREATE', 'UPDATE', 'CREATE_OR_UPDATE'];
         if (!VALID_TRIGGERS.includes(props.triggerType)) {
             throw new Error(`Invalid trigger_type: ${props.triggerType}. Must be one of: ${VALID_TRIGGERS.join(', ')}`);
         }
@@ -49,15 +61,24 @@ export class Rule {
         this._actions = [...(props.actions ?? [])];
         customObject._register(this);
     }
-    /** Backend flow_id used as this rule's identifier. */
+    /**
+     * Returns the stable identifier for this rule (e.g. `'gym_default_enrollment_status'`).
+     */
     getFlowId() {
         return this._flowId;
     }
-    /** api_name of the CustomObject this rule lives on. */
+    /**
+     * Returns the api_name of the custom object this rule is attached to.
+     */
     getCustomObjectApiName() {
         return this._customObjectApiName;
     }
-    /** Serialize to the backend `CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW` wire shape. */
+    /**
+     * Serializes this rule to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW'`.
+     * Optional fields are omitted when unset; `actions` is omitted when empty.
+     */
     toDict() {
         const component = {
             type: 'CUSTOM_OBJECT_RECORD_TRIGGERED_FLOW',

package/lib/manifest/rule.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"rule.mjs","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;OAEI,EAAE,UAAU,EAA4C;AAI/D,MAAM,cAAc,GAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;AAgC/E,kFAAkF;AAClF,SAAS,gBAAgB,CAAC,WAAkB,EAAE,KAAU;IACtD,MAAM,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IACtC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,MAAM,GAAG,GAAwB;QAC/B,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE;KAC9C,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC9B,GAAG,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/E,CAAC;SAAM,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QACrC,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,OAAO,IAAI;IAUf,uFAAuF;IACvF,YAAY,YAA0B,EAAE,KAAgB;QACtD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,yBAAyB,KAAK,CAAC,WAAW,qBAAqB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3C,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,sDAAsD;IACtD,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED,uDAAuD;IACvD,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED,iFAAiF;IACjF,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,qCAAqC;YAC3C,cAAc,EAAE,IAAI,CAAC,oBAAoB;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAChG,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACrF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"rule.mjs","sourceRoot":"","sources":["../../src/lib/manifest/rule.ts"],"names":[],"mappings":"OAAO,EAAE,UAAU,EAA4C;AAiF/D,kFAAkF;AAClF,SAAS,gBAAgB,CAAC,WAAkB,EAAE,KAAU;IACtD,MAAM,EAAE,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC;IACtC,IAAI,EAAE,KAAK,QAAQ,IAAI,EAAE,KAAK,OAAO,EAAE,CAAC;QACtC,OAAO,KAAK,CAAC;IACf,CAAC;IACD,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,KAAK,CAAC;IACf,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACtC,MAAM,GAAG,GAAwB;QAC/B,YAAY,EAAE,MAAM,CAAC,WAAW,CAAC,UAAU,EAAE;KAC9C,CAAC;IACF,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QAC9B,GAAG,CAAC,aAAa,CAAC,GAAG,gBAAgB,CAAC,MAAM,CAAC,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/E,CAAC;SAAM,IAAI,MAAM,CAAC,UAAU,IAAI,IAAI,EAAE,CAAC;QACrC,GAAG,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,UAAU,CAAC;IACzC,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,IAAI;IAUf;;;;OAIG;IACH,YAAY,YAA0B,EAAE,KAAgB;QACtD,MAAM,cAAc,GAAkB,CAAC,QAAQ,EAAE,QAAQ,EAAE,kBAAkB,CAAC,CAAC;QAC/E,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YAChD,MAAM,IAAI,KAAK,CACb,yBAAyB,KAAK,CAAC,WAAW,qBAAqB,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC3F,CAAC;QACJ,CAAC;QACD,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,CAAC,oBAAoB,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QACtD,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC;QAC3C,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;OAEG;IACH,sBAAsB;QACpB,OAAO,IAAI,CAAC,oBAAoB,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,qCAAqC;YAC3C,cAAc,EAAE,IAAI,CAAC,oBAAoB;YACzC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,YAAY,EAAE,IAAI,CAAC,YAAY;SAChC,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,qBAAqB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAChG,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,eAAe,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAChF,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QACrF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/manifest/sdui-page.d.mts

@@ -1,33 +1,89 @@
 import type { ManifestFunction } from "./manifest-function.mjs";
 import type { ManifestScope } from "./manifest-builder.mjs";
+/**
+ * Initialization properties for {@link SduiPage}.
+ */
 export interface SduiPageProps {
-    /** Required. Unique ID for this page within the package. */
+    /**
+     * Unique identifier for this page within the package (e.g. `'gym_today_schedule'`).
+     *
+     * Required.
+     */
     sduiPageId: string;
-    /** Required. Display name shown as the tab label. */
+    /**
+     * Display name shown as the tab label in the app (e.g. `'Today\'s schedule'`).
+     *
+     * Required.
+     */
     name: string;
     /**
-     * Required. Backing function. Pass a live `ManifestFunction` ref (the SDK
-     * reads its api_name) or a raw api_name string for functions authored
-     * outside this manifest.
+     * The function that renders this page. Pass a live {@link ManifestFunction} reference,
+     * or a raw api_name string for functions defined outside this manifest.
+     *
+     * Required.
      */
     function: ManifestFunction | string;
-    /** Optional. Human-readable description. */
+    /**
+     * Human-readable description of what this page shows.
+     *
+     * Optional. @default `''`
+     */
     description?: string;
 }
+/**
+ * Defines an SDUI page and registers it with the manifest.
+ *
+ * An SDUI page is a custom UI surface backed by a {@link ManifestFunction}. It appears
+ * as a tab in a Rippling {@link App}. You would normally define SDUI pages after the
+ * functions they reference, then pass them to an `App` via `pages`.
+ *
+ * @example
+ * ```ts
+ * const todaySchedulePage = new SduiPage(manifest, {
+ *   sduiPageId: 'gym_today_schedule',
+ *   name: 'Today\'s schedule',
+ *   function: todayScheduleFn,
+ *   description: 'SDUI list of class sessions for front desk',
+ * });
+ *
+ * new App(manifest, {
+ *   apiName: 'gym_membership_management_app',
+ *   name: 'Gym Membership Management',
+ *   pages: [memberObj, trainerObj, todaySchedulePage],
+ * });
+ * ```
+ *
+ * @see {@link ManifestFunction} — provides the handler that renders this page.
+ * @see {@link App} — hosts this page as a tab via `pages`.
+ */
 export declare class SduiPage {
     private readonly _sduiPageId;
     private readonly _name;
     private readonly _functionApiName;
     private readonly _description;
-    /** Build a new SDUI page and auto-register with `scope`; resolves the function api_name eagerly. */
+    /**
+     * @param scope - The manifest to register this page with.
+     * @param props - Initialization properties.
+     * @throws {Error} If `sduiPageId`, `name`, or `function` is missing.
+     */
     constructor(scope: ManifestScope, props: SduiPageProps);
-    /** Identifier slug for this page within the package. */
+    /**
+     * Returns the unique page identifier (e.g. `'gym_today_schedule'`).
+     */
     getSduiPageId(): string;
-    /** Display name (tab label). */
+    /**
+     * Returns the display name (tab label) of this page.
+     */
     getName(): string;
-    /** api_name of the function backing this page. */
+    /**
+     * Returns the api_name of the function backing this page.
+     */
     getFunctionApiName(): string;
-    /** Serialize to the backend `SDUI_PAGE` wire shape. */
+    /**
+     * Serializes this SDUI page to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'SDUI_PAGE'`.
+     */
     toDict(): Record<string, any>;
 }
 //# sourceMappingURL=sdui-page.d.mts.map

package/lib/manifest/sdui-page.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"sdui-page.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"OAUO,KAAK,EAAE,gBAAgB,EAAE;OACzB,KAAK,EAAE,aAAa,EAAE;AAE7B,MAAM,WAAW,aAAa;IAC5B,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;IACnB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC,oGAAoG;gBACxF,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAWtD,wDAAwD;IACxD,aAAa,IAAI,MAAM;IAIvB,gCAAgC;IAChC,OAAO,IAAI,MAAM;IAIjB,kDAAkD;IAClD,kBAAkB,IAAI,MAAM;IAI5B,uDAAuD;IACvD,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAS9B"}
+{"version":3,"file":"sdui-page.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/sdui-page.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,gBAAgB,EAAE;OACzB,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,QAAQ,EAAE,gBAAgB,GAAG,MAAM,CAAC;IACpC;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAS;IAC1C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IAEtC;;;;OAIG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAWtD;;OAEG;IACH,aAAa,IAAI,MAAM;IAIvB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,kBAAkB,IAAI,MAAM;IAI5B;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAS9B"}