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

package/lib/manifest/manifest-builder.mjs

@@ -1,27 +1,34 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+/**
+ * Root container for a manifest — collects all components and serializes them to JSON.
  *
- * ManifestBuilder collects manifest components and serializes to JSON.
+ * You would normally create one `ManifestBuilder` at the top of your manifest file,
+ * then pass it as the scope to all top-level components (categories, custom objects,
+ * functions, apps, SDUI pages). Each component auto-registers on construction; there
+ * is no separate add or register call.
  *
- * Wiring model (CDK-style scope-first):
- *   - Every component takes its parent scope as the first positional
- *     constructor arg. The scope is either a `ManifestBuilder` (root) or a
- *     `CustomObject` / `CustomObjectFieldSection` for nested children.
- *   - Constructing a component auto-registers it with the builder via the
- *     scope's `_register` hook. There is no public `addComponent` — the
- *     only way a component enters the manifest is by being constructed
- *     with a scope that forwards up to this builder.
- *   - The builder does not walk into components; each component emits the
- *     foreign-key fields (`custom_object_api_name`, `model_rql_name`, ...)
- *     itself in `toDict()`.
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
  *
- * Local operations only (no HTTP):
- *   - preview()         — render manifest as a JSON string
- *   - buildManifest()   — return the manifest as a plain object
- *   - componentsList()  — return the flat list of component dicts
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ * });
+ *
+ * const category = new Category(manifest, { apiName: 'gym__c', name: 'Gym' });
+ * const memberObj = new CustomObject(manifest, { apiName: 'gym_member__c', name: 'Member', category });
+ * // ... define fields, rules, list views, etc. ...
+ *
+ * console.log(manifest.preview());
+ * ```
  */
 export class ManifestBuilder {
-    /** Build a new manifest; `name` defaults to `key` when unset. */
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
     constructor(props) {
         this._components = [];
         if (!props.key) {
@@ -41,7 +48,11 @@ export class ManifestBuilder {
         }
         this._components.push(component);
     }
-    /** Build the manifest object: metadata + flat component list. */
+    /**
+     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     *
+     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     */
     buildManifest() {
         const metadata = {
             key: this.key,
@@ -53,11 +64,22 @@ export class ManifestBuilder {
         const components = this._components.map((c) => c.toDict());
         return { metadata, components };
     }
-    /** Flat list of all component dicts. */
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
     componentsList() {
         return this._components.map((c) => c.toDict());
     }
-    /** Pretty-printed JSON string. */
+    /**
+     * Returns the full manifest as a pretty-printed JSON string.
+     *
+     * Typically used as the final line of a manifest file to emit the output:
+     * `console.log(manifest.preview())`.
+     *
+     * @returns Indented JSON string of the complete manifest.
+     */
     preview() {
         return JSON.stringify(this.buildManifest(), null, 2);
     }

package/lib/manifest/manifest-builder.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;GAqBG;AA0BH,MAAM,OAAO,eAAe;IAM1B,iEAAiE;IACjE,YAAY,KAA2B;QAHtB,gBAAW,GAAwB,EAAE,CAAC;QAIrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED,iEAAiE;IACjE,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED,wCAAwC;IACxC,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED,kCAAkC;IAClC,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}
+{"version":3,"file":"manifest-builder.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AA8CA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAO,eAAe;IAM1B;;;OAGG;IACH,YAAY,KAA2B;QANtB,gBAAW,GAAwB,EAAE,CAAC;QAOrD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAC;QACrC,CAAC;QACD,IAAI,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACrB,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC;QACpC,IAAI,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;IAC7C,CAAC;IAED;;;OAGG;IACH,SAAS,CAAC,SAA4B;QACpC,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YAC3C,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAC;QAC/D,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAED;;;;OAIG;IACH,aAAa;QACX,MAAM,QAAQ,GAAwB;YACpC,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,IAAI,EAAE,IAAI,CAAC,IAAI;SAChB,CAAC;QACF,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACrB,QAAQ,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;QAC7C,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;QAC3D,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACH,cAAc;QACZ,OAAO,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC;IACjD,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,aAAa,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;IACvD,CAAC;CACF"}

package/lib/manifest/manifest-function.d.mts

@@ -1,25 +1,96 @@
 import type { FunctionRuntime } from "./_helpers.mjs";
 import type { ManifestScope } from "./manifest-builder.mjs";
+/**
+ * Initialization properties for {@link ManifestFunction}.
+ */
 export interface ManifestFunctionProps {
-    /** Required. Function api_name (snake_case identifier). */
+    /**
+     * Unique identifier for this function (e.g. `'gym_today_schedule_fn'`).
+     *
+     * Required.
+     */
     apiName: string;
-    /** Required. Display name shown in the UI. */
+    /**
+     * Display name shown in the Rippling UI.
+     *
+     * Required.
+     */
     name: string;
-    /** Optional. TypeScript handler source; must export `onRipplingEvent`. @default '' */
+    /**
+     * TypeScript handler source code. Must export an `onRipplingEvent` function.
+     *
+     * Optional. @default `''`
+     */
     code?: string;
-    /** Optional. Function description. @default '' */
+    /**
+     * Human-readable description of what this function does.
+     *
+     * Optional. @default `''`
+     */
     description?: string;
-    /** Optional. NPM package dependencies. @default null */
+    /**
+     * NPM package dependencies as a `{ packageName: versionRange }` map
+     * (e.g. `{ '@rippling/rippling-sdk': '^0.2.0' }`).
+     *
+     * Optional. @default null
+     */
     dependencies?: Record<string, string>;
-    /** Optional. Raw deployment options. Prefer `runtime`. @default null */
+    /**
+     * Raw deployment options object. Prefer `runtime` for the common case.
+     *
+     * Optional. @default null
+     */
     deploymentOptions?: Record<string, any>;
-    /** Optional. Shorthand: sets `deploymentOptions.runtime`. */
+    /**
+     * Deployment runtime shorthand. Sets `deploymentOptions.runtime` and is merged
+     * with any explicit `deploymentOptions`. One of `'cloudflare-js'` | `'lambda-deno'`
+     * | `'lambda-python'`.
+     *
+     * Optional.
+     */
     runtime?: FunctionRuntime;
-    /** Optional. Outbound domain allowlist. @default null */
+    /**
+     * Outbound domain allowlist. Requests to domains not in this list will be blocked.
+     *
+     * Optional. @default null
+     */
     allowedDomains?: string[];
-    /** Optional. Whether the function runs asynchronously. @default false */
+    /**
+     * Whether this function runs asynchronously (fire-and-forget).
+     *
+     * Optional. @default `false`
+     */
     isAsync?: boolean;
 }
+/**
+ * Defines a serverless function and registers it with the manifest.
+ *
+ * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
+ * serverless infrastructure. Functions are the backing implementation for
+ * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
+ *
+ * This class is named `ManifestFunction` to avoid collision with the JavaScript
+ * built-in `Function`. It is also re-exported as `Function` from the barrel for
+ * convenience.
+ *
+ * @example
+ * ```ts
+ * const todayScheduleFn = new ManifestFunction(manifest, {
+ *   apiName: 'gym_today_schedule_fn',
+ *   name: 'Today\'s schedule (SDUI)',
+ *   description: 'Searchable grid of class sessions',
+ *   runtime: 'lambda-deno',
+ *   code: handlerSource,
+ *   dependencies: {
+ *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
+ *     '@rippling/sdui-builder': '^0.1.0',
+ *   },
+ *   isAsync: false,
+ * });
+ * ```
+ *
+ * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
+ */
 export declare class ManifestFunction {
     private readonly _apiName;
     private readonly _name;
@@ -29,11 +100,20 @@ export declare class ManifestFunction {
     private readonly _deploymentOptions;
     private readonly _allowedDomains;
     private readonly _isAsync;
-    /** Build a new function and auto-register with `scope`; `runtime` is merged into `deploymentOptions` if set. */
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
     constructor(scope: ManifestScope, props: ManifestFunctionProps);
-    /** Backend api_name for this function. */
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
     getApiName(): string;
-    /** Serialize to the backend `FUNCTION` wire shape; empty fields are omitted. */
+    /**
+     * Serializes this function to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'FUNCTION'`. Empty or unset optional fields are omitted.
+     */
     toDict(): Record<string, any>;
 }
 //# sourceMappingURL=manifest-function.d.mts.map

package/lib/manifest/manifest-function.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAUO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B,MAAM,WAAW,qBAAqB;IACpC,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,gHAAgH;gBACpG,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAe9D,0CAA0C;IAC1C,UAAU,IAAI,MAAM;IAIpB,gFAAgF;IAChF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"manifest-function.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAe9D;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/manifest-function.d.ts

@@ -1,25 +1,96 @@
 import type { FunctionRuntime } from "./_helpers.js";
 import type { ManifestScope } from "./manifest-builder.js";
+/**
+ * Initialization properties for {@link ManifestFunction}.
+ */
 export interface ManifestFunctionProps {
-    /** Required. Function api_name (snake_case identifier). */
+    /**
+     * Unique identifier for this function (e.g. `'gym_today_schedule_fn'`).
+     *
+     * Required.
+     */
     apiName: string;
-    /** Required. Display name shown in the UI. */
+    /**
+     * Display name shown in the Rippling UI.
+     *
+     * Required.
+     */
     name: string;
-    /** Optional. TypeScript handler source; must export `onRipplingEvent`. @default '' */
+    /**
+     * TypeScript handler source code. Must export an `onRipplingEvent` function.
+     *
+     * Optional. @default `''`
+     */
     code?: string;
-    /** Optional. Function description. @default '' */
+    /**
+     * Human-readable description of what this function does.
+     *
+     * Optional. @default `''`
+     */
     description?: string;
-    /** Optional. NPM package dependencies. @default null */
+    /**
+     * NPM package dependencies as a `{ packageName: versionRange }` map
+     * (e.g. `{ '@rippling/rippling-sdk': '^0.2.0' }`).
+     *
+     * Optional. @default null
+     */
     dependencies?: Record<string, string>;
-    /** Optional. Raw deployment options. Prefer `runtime`. @default null */
+    /**
+     * Raw deployment options object. Prefer `runtime` for the common case.
+     *
+     * Optional. @default null
+     */
     deploymentOptions?: Record<string, any>;
-    /** Optional. Shorthand: sets `deploymentOptions.runtime`. */
+    /**
+     * Deployment runtime shorthand. Sets `deploymentOptions.runtime` and is merged
+     * with any explicit `deploymentOptions`. One of `'cloudflare-js'` | `'lambda-deno'`
+     * | `'lambda-python'`.
+     *
+     * Optional.
+     */
     runtime?: FunctionRuntime;
-    /** Optional. Outbound domain allowlist. @default null */
+    /**
+     * Outbound domain allowlist. Requests to domains not in this list will be blocked.
+     *
+     * Optional. @default null
+     */
     allowedDomains?: string[];
-    /** Optional. Whether the function runs asynchronously. @default false */
+    /**
+     * Whether this function runs asynchronously (fire-and-forget).
+     *
+     * Optional. @default `false`
+     */
     isAsync?: boolean;
 }
+/**
+ * Defines a serverless function and registers it with the manifest.
+ *
+ * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
+ * serverless infrastructure. Functions are the backing implementation for
+ * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
+ *
+ * This class is named `ManifestFunction` to avoid collision with the JavaScript
+ * built-in `Function`. It is also re-exported as `Function` from the barrel for
+ * convenience.
+ *
+ * @example
+ * ```ts
+ * const todayScheduleFn = new ManifestFunction(manifest, {
+ *   apiName: 'gym_today_schedule_fn',
+ *   name: 'Today\'s schedule (SDUI)',
+ *   description: 'Searchable grid of class sessions',
+ *   runtime: 'lambda-deno',
+ *   code: handlerSource,
+ *   dependencies: {
+ *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
+ *     '@rippling/sdui-builder': '^0.1.0',
+ *   },
+ *   isAsync: false,
+ * });
+ * ```
+ *
+ * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
+ */
 export declare class ManifestFunction {
     private readonly _apiName;
     private readonly _name;
@@ -29,11 +100,20 @@ export declare class ManifestFunction {
     private readonly _deploymentOptions;
     private readonly _allowedDomains;
     private readonly _isAsync;
-    /** Build a new function and auto-register with `scope`; `runtime` is merged into `deploymentOptions` if set. */
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
     constructor(scope: ManifestScope, props: ManifestFunctionProps);
-    /** Backend api_name for this function. */
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
     getApiName(): string;
-    /** Serialize to the backend `FUNCTION` wire shape; empty fields are omitted. */
+    /**
+     * Serializes this function to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'FUNCTION'`. Empty or unset optional fields are omitted.
+     */
     toDict(): Record<string, any>;
 }
 //# sourceMappingURL=manifest-function.d.ts.map

package/lib/manifest/manifest-function.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAUO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B,MAAM,WAAW,qBAAqB;IACpC,2DAA2D;IAC3D,OAAO,EAAE,MAAM,CAAC;IAChB,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,sFAAsF;IACtF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wDAAwD;IACxD,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,wEAAwE;IACxE,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC,6DAA6D;IAC7D,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,yDAAyD;IACzD,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,yEAAyE;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC,gHAAgH;gBACpG,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAe9D,0CAA0C;IAC1C,UAAU,IAAI,MAAM;IAIpB,gFAAgF;IAChF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}
+{"version":3,"file":"manifest-function.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,eAAe,EAAE;OACxB,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IACxC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;OAIG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAS;IACtC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqC;IACnE,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAkC;IACrE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAuB;IACvD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IAEnC;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,qBAAqB;IAe9D;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/manifest-function.js

@@ -1,17 +1,40 @@
 "use strict";
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestFunction = void 0;
+/**
+ * Defines a serverless function and registers it with the manifest.
+ *
+ * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
+ * serverless infrastructure. Functions are the backing implementation for
+ * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
  *
- * Custom function definitions (TypeScript handler code).
- * Backend schema: FUNCTION (v2)
+ * This class is named `ManifestFunction` to avoid collision with the JavaScript
+ * built-in `Function`. It is also re-exported as `Function` from the barrel for
+ * convenience.
  *
- * Named ManifestFunction to avoid collision with the JavaScript built-in Function.
- * Re-exported as both ManifestFunction and Function from the barrel.
+ * @example
+ * ```ts
+ * const todayScheduleFn = new ManifestFunction(manifest, {
+ *   apiName: 'gym_today_schedule_fn',
+ *   name: 'Today\'s schedule (SDUI)',
+ *   description: 'Searchable grid of class sessions',
+ *   runtime: 'lambda-deno',
+ *   code: handlerSource,
+ *   dependencies: {
+ *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
+ *     '@rippling/sdui-builder': '^0.1.0',
+ *   },
+ *   isAsync: false,
+ * });
+ * ```
+ *
+ * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ManifestFunction = void 0;
 class ManifestFunction {
-    /** Build a new function and auto-register with `scope`; `runtime` is merged into `deploymentOptions` if set. */
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
     constructor(scope, props) {
         this._apiName = props.apiName;
         this._name = props.name;
@@ -26,11 +49,17 @@ class ManifestFunction {
         this._isAsync = props.isAsync ?? false;
         scope._register(this);
     }
-    /** Backend api_name for this function. */
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
     getApiName() {
         return this._apiName;
     }
-    /** Serialize to the backend `FUNCTION` wire shape; empty fields are omitted. */
+    /**
+     * Serializes this function to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'FUNCTION'`. Empty or unset optional fields are omitted.
+     */
     toDict() {
         const component = {
             type: 'FUNCTION',

package/lib/manifest/manifest-function.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AA0BH,MAAa,gBAAgB;IAU3B,gHAAgH;IAChH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,0CAA0C;IAC1C,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,gFAAgF;IAChF,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AA9CD,4CA8CC"}
+{"version":3,"file":"manifest-function.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":";;;AAkEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,gBAAgB;IAU3B;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAvDD,4CAuDC"}

package/lib/manifest/manifest-function.mjs

@@ -1,14 +1,37 @@
-/*
- * The contents of this file were inserted manually and are not generated by Stainless.
+/**
+ * Defines a serverless function and registers it with the manifest.
  *
- * Custom function definitions (TypeScript handler code).
- * Backend schema: FUNCTION (v2)
+ * A `ManifestFunction` packages TypeScript handler code that runs on Rippling's
+ * serverless infrastructure. Functions are the backing implementation for
+ * {@link SduiPage} surfaces. The handler must export `onRipplingEvent`.
  *
- * Named ManifestFunction to avoid collision with the JavaScript built-in Function.
- * Re-exported as both ManifestFunction and Function from the barrel.
+ * This class is named `ManifestFunction` to avoid collision with the JavaScript
+ * built-in `Function`. It is also re-exported as `Function` from the barrel for
+ * convenience.
+ *
+ * @example
+ * ```ts
+ * const todayScheduleFn = new ManifestFunction(manifest, {
+ *   apiName: 'gym_today_schedule_fn',
+ *   name: 'Today\'s schedule (SDUI)',
+ *   description: 'Searchable grid of class sessions',
+ *   runtime: 'lambda-deno',
+ *   code: handlerSource,
+ *   dependencies: {
+ *     '@rippling/rippling-sdk': '^0.2.0-alpha.33',
+ *     '@rippling/sdui-builder': '^0.1.0',
+ *   },
+ *   isAsync: false,
+ * });
+ * ```
+ *
+ * @see {@link SduiPage} — wraps a `ManifestFunction` as a navigable UI surface.
  */
 export class ManifestFunction {
-    /** Build a new function and auto-register with `scope`; `runtime` is merged into `deploymentOptions` if set. */
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
     constructor(scope, props) {
         this._apiName = props.apiName;
         this._name = props.name;
@@ -23,11 +46,17 @@ export class ManifestFunction {
         this._isAsync = props.isAsync ?? false;
         scope._register(this);
     }
-    /** Backend api_name for this function. */
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
     getApiName() {
         return this._apiName;
     }
-    /** Serialize to the backend `FUNCTION` wire shape; empty fields are omitted. */
+    /**
+     * Serializes this function to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'FUNCTION'`. Empty or unset optional fields are omitted.
+     */
     toDict() {
         const component = {
             type: 'FUNCTION',

package/lib/manifest/manifest-function.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"manifest-function.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AA0BH,MAAM,OAAO,gBAAgB;IAU3B,gHAAgH;IAChH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,0CAA0C;IAC1C,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,gFAAgF;IAChF,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}
+{"version":3,"file":"manifest-function.mjs","sourceRoot":"","sources":["../../src/lib/manifest/manifest-function.ts"],"names":[],"mappings":"AAkEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,OAAO,gBAAgB;IAU3B;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAA4B;QAC5D,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC;QAC9B,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,EAAE,CAAC;QAC5C,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,CAAC;QAClD,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,kBAAkB,GAAG,EAAE,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;QAC3F,CAAC;QACD,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,CAAC;QAC5C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,KAAK,CAAC;QACvC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,QAAQ,EAAE,IAAI,CAAC,QAAQ;SACxB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QACpE,IAAI,IAAI,CAAC,KAAK;YAAE,SAAS,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;QACrD,IAAI,IAAI,CAAC,aAAa,IAAI,IAAI;YAAE,SAAS,CAAC,cAAc,CAAC,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/E,IAAI,IAAI,CAAC,kBAAkB,IAAI,IAAI;YAAE,SAAS,CAAC,oBAAoB,CAAC,GAAG,IAAI,CAAC,kBAAkB,CAAC;QAC/F,IAAI,IAAI,CAAC,eAAe,IAAI,IAAI;YAAE,SAAS,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC;QACtF,IAAI,IAAI,CAAC,QAAQ;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC;QAChD,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}