@rippling/rippling-sdk 0.2.0-alpha.33 → 0.2.0-alpha.35

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

@@ -0,0 +1,110 @@
+/**
+ * Any object that can be included in a manifest.
+ *
+ * Implement `toDict()` to return the component's wire-format dict.
+ * All built-in SDK classes implement this interface automatically.
+ */
+export interface ManifestComponent {
+    toDict(): Record<string, any>;
+}
+/**
+ * A scope — anything that can accept child component registrations.
+ *
+ * Implemented by {@link ManifestBuilder} (the root) and by nestable parents
+ * like `CustomObject` that forward registrations up to the builder.
+ * Pass a scope as the first argument when constructing any manifest component.
+ */
+export interface ManifestScope {
+    /** @internal Register a child component; builder-bound scopes forward up. */
+    _register(component: ManifestComponent): void;
+}
+/**
+ * Initialization properties for {@link ManifestBuilder}.
+ */
+export interface ManifestBuilderProps {
+    /**
+     * Unique project key for this manifest (e.g. `'gym_membership_management'`).
+     *
+     * Required.
+     */
+    key: string;
+    /**
+     * Display name for this manifest.
+     *
+     * Optional. Defaults to `key` when not provided.
+     */
+    name?: string;
+    /**
+     * Human-readable description of what this manifest contains.
+     *
+     * Optional.
+     */
+    description?: string;
+}
+/**
+ * Root container for a manifest — collects all components and serializes them 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.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
+ *
+ * @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 declare class ManifestBuilder implements ManifestScope {
+    readonly key: string;
+    readonly name: string;
+    readonly description: string;
+    private readonly _components;
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
+    constructor(props: ManifestBuilderProps);
+    /**
+     * @internal Scope hook invoked by child constructors. Components enter the
+     * manifest here — there is no other path.
+     */
+    _register(component: ManifestComponent): void;
+    /**
+     * Returns the manifest as a plain object with `metadata` and a flat `components` array.
+     *
+     * @returns `{ metadata: { key, name, description? }, components: Record<string, any>[] }`
+     */
+    buildManifest(): {
+        metadata: Record<string, any>;
+        components: Record<string, any>[];
+    };
+    /**
+     * Returns the flat list of all registered component dicts.
+     *
+     * @returns An array of wire-format component objects, in registration order.
+     */
+    componentsList(): Record<string, any>[];
+    /**
+     * 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(): string;
+}
+//# sourceMappingURL=manifest-builder.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-builder.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,WAAW,iBAAiB;IAChC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;CAC/B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,aAAa;IAC5B,6EAA6E;IAC7E,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,qBAAa,eAAgB,YAAW,aAAa;IACnD,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAA2B;IAEvD;;;OAGG;gBACS,KAAK,EAAE,oBAAoB;IASvC;;;OAGG;IACH,SAAS,CAAC,SAAS,EAAE,iBAAiB,GAAG,IAAI;IAO7C;;;;OAIG;IACH,aAAa,IAAI;QAAE,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE;IAYrF;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;IAIvC;;;;;;;OAOG;IACH,OAAO,IAAI,MAAM;CAGlB"}

package/lib/manifest/manifest-builder.js

@@ -0,0 +1,91 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestBuilder = void 0;
+/**
+ * Root container for a manifest — collects all components and serializes them 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.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
+ *
+ * @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());
+ * ```
+ */
+class ManifestBuilder {
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
+    constructor(props) {
+        this._components = [];
+        if (!props.key) {
+            throw new Error('key is required');
+        }
+        this.key = props.key;
+        this.name = props.name || props.key;
+        this.description = props.description ?? '';
+    }
+    /**
+     * @internal Scope hook invoked by child constructors. Components enter the
+     * manifest here — there is no other path.
+     */
+    _register(component) {
+        if (typeof component.toDict !== 'function') {
+            throw new TypeError('Component must have a toDict() method');
+        }
+        this._components.push(component);
+    }
+    /**
+     * 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,
+            name: this.name,
+        };
+        if (this.description) {
+            metadata['description'] = this.description;
+        }
+        const components = this._components.map((c) => c.toDict());
+        return { metadata, components };
+    }
+    /**
+     * 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());
+    }
+    /**
+     * 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);
+    }
+}
+exports.ManifestBuilder = ManifestBuilder;
+//# sourceMappingURL=manifest-builder.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-builder.js","sourceRoot":"","sources":["../../src/lib/manifest/manifest-builder.ts"],"names":[],"mappings":";;;AA8CA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAa,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;AAnED,0CAmEC"}

package/lib/manifest/manifest-builder.mjs

@@ -0,0 +1,87 @@
+/**
+ * Root container for a manifest — collects all components and serializes them 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.
+ *
+ * After defining all components, call `preview()` to emit the manifest as a
+ * pretty-printed JSON string, or `buildManifest()` to get the plain object.
+ *
+ * @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 {
+    /**
+     * @param props - Initialization properties.
+     * @throws {Error} If `props.key` is empty or missing.
+     */
+    constructor(props) {
+        this._components = [];
+        if (!props.key) {
+            throw new Error('key is required');
+        }
+        this.key = props.key;
+        this.name = props.name || props.key;
+        this.description = props.description ?? '';
+    }
+    /**
+     * @internal Scope hook invoked by child constructors. Components enter the
+     * manifest here — there is no other path.
+     */
+    _register(component) {
+        if (typeof component.toDict !== 'function') {
+            throw new TypeError('Component must have a toDict() method');
+        }
+        this._components.push(component);
+    }
+    /**
+     * 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,
+            name: this.name,
+        };
+        if (this.description) {
+            metadata['description'] = this.description;
+        }
+        const components = this._components.map((c) => c.toDict());
+        return { metadata, components };
+    }
+    /**
+     * 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());
+    }
+    /**
+     * 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);
+    }
+}
+//# sourceMappingURL=manifest-builder.mjs.map

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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,119 @@
+import type { FunctionRuntime } from "./_helpers.mjs";
+import type { ManifestScope } from "./manifest-builder.mjs";
+/**
+ * Initialization properties for {@link ManifestFunction}.
+ */
+export interface ManifestFunctionProps {
+    /**
+     * Unique identifier for this function (e.g. `'gym_today_schedule_fn'`).
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown in the Rippling UI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * TypeScript handler source code. Must export an `onRipplingEvent` function.
+     *
+     * Optional. @default `''`
+     */
+    code?: string;
+    /**
+     * Human-readable description of what this function does.
+     *
+     * Optional. @default `''`
+     */
+    description?: string;
+    /**
+     * NPM package dependencies as a `{ packageName: versionRange }` map
+     * (e.g. `{ '@rippling/rippling-sdk': '^0.2.0' }`).
+     *
+     * Optional. @default null
+     */
+    dependencies?: Record<string, string>;
+    /**
+     * Raw deployment options object. Prefer `runtime` for the common case.
+     *
+     * Optional. @default null
+     */
+    deploymentOptions?: Record<string, any>;
+    /**
+     * Deployment runtime shorthand. Sets `deploymentOptions.runtime` and is merged
+     * with any explicit `deploymentOptions`. One of `'cloudflare-js'` | `'lambda-deno'`
+     * | `'lambda-python'`.
+     *
+     * Optional.
+     */
+    runtime?: FunctionRuntime;
+    /**
+     * Outbound domain allowlist. Requests to domains not in this list will be blocked.
+     *
+     * Optional. @default null
+     */
+    allowedDomains?: string[];
+    /**
+     * 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;
+    private readonly _code;
+    private readonly _description;
+    private readonly _dependencies;
+    private readonly _deploymentOptions;
+    private readonly _allowedDomains;
+    private readonly _isAsync;
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: ManifestFunctionProps);
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
+    getApiName(): string;
+    /**
+     * 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,119 @@
+import type { FunctionRuntime } from "./_helpers.js";
+import type { ManifestScope } from "./manifest-builder.js";
+/**
+ * Initialization properties for {@link ManifestFunction}.
+ */
+export interface ManifestFunctionProps {
+    /**
+     * Unique identifier for this function (e.g. `'gym_today_schedule_fn'`).
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown in the Rippling UI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * TypeScript handler source code. Must export an `onRipplingEvent` function.
+     *
+     * Optional. @default `''`
+     */
+    code?: string;
+    /**
+     * Human-readable description of what this function does.
+     *
+     * Optional. @default `''`
+     */
+    description?: string;
+    /**
+     * NPM package dependencies as a `{ packageName: versionRange }` map
+     * (e.g. `{ '@rippling/rippling-sdk': '^0.2.0' }`).
+     *
+     * Optional. @default null
+     */
+    dependencies?: Record<string, string>;
+    /**
+     * Raw deployment options object. Prefer `runtime` for the common case.
+     *
+     * Optional. @default null
+     */
+    deploymentOptions?: Record<string, any>;
+    /**
+     * Deployment runtime shorthand. Sets `deploymentOptions.runtime` and is merged
+     * with any explicit `deploymentOptions`. One of `'cloudflare-js'` | `'lambda-deno'`
+     * | `'lambda-python'`.
+     *
+     * Optional.
+     */
+    runtime?: FunctionRuntime;
+    /**
+     * Outbound domain allowlist. Requests to domains not in this list will be blocked.
+     *
+     * Optional. @default null
+     */
+    allowedDomains?: string[];
+    /**
+     * 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;
+    private readonly _code;
+    private readonly _description;
+    private readonly _dependencies;
+    private readonly _deploymentOptions;
+    private readonly _allowedDomains;
+    private readonly _isAsync;
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: ManifestFunctionProps);
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
+    getApiName(): string;
+    /**
+     * 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,85 @@
+"use strict";
+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`.
+ *
+ * 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.
+ */
+class ManifestFunction {
+    /**
+     * @param scope - The manifest to register this function with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope, props) {
+        this._apiName = props.apiName;
+        this._name = props.name;
+        this._code = props.code ?? '';
+        this._description = props.description ?? '';
+        this._dependencies = props.dependencies;
+        this._deploymentOptions = props.deploymentOptions;
+        if (props.runtime) {
+            this._deploymentOptions = { ...(this._deploymentOptions ?? {}), runtime: props.runtime };
+        }
+        this._allowedDomains = props.allowedDomains;
+        this._isAsync = props.isAsync ?? false;
+        scope._register(this);
+    }
+    /**
+     * Returns the api_name of this function (e.g. `'gym_today_schedule_fn'`).
+     */
+    getApiName() {
+        return this._apiName;
+    }
+    /**
+     * 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',
+            name: this._name,
+            api_name: this._apiName,
+        };
+        if (this._description)
+            component['description'] = this._description;
+        if (this._code)
+            component['code_draft'] = this._code;
+        if (this._dependencies != null)
+            component['dependencies'] = this._dependencies;
+        if (this._deploymentOptions != null)
+            component['deployment_options'] = this._deploymentOptions;
+        if (this._allowedDomains != null)
+            component['allowed_domains'] = this._allowedDomains;
+        if (this._isAsync)
+            component['is_async'] = true;
+        return component;
+    }
+}
+exports.ManifestFunction = ManifestFunction;
+//# sourceMappingURL=manifest-function.js.map

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

@@ -0,0 +1 @@
+{"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"}