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

package/lib/manifest/app.d.mts

@@ -0,0 +1,113 @@
+import { CustomObject } from "./custom-object.mjs";
+import type { ManifestScope } from "./manifest-builder.mjs";
+import { SduiPage } from "./sdui-page.mjs";
+/**
+ * A single page entry in an {@link App}.
+ *
+ * - Pass a {@link CustomObject} to create an object-page tab.
+ * - Pass an {@link SduiPage} to create a custom SDUI surface tab.
+ */
+export type AppPage = CustomObject | SduiPage;
+/**
+ * S3 icon reference for an {@link App}.
+ */
+export interface AppIcon {
+    /** S3 bucket holding the icon asset. */
+    s3Bucket: string;
+    /** S3 key (path) within `s3Bucket`. */
+    s3Key: string;
+}
+/**
+ * Initialization properties for {@link App}.
+ */
+export interface AppProps {
+    /**
+     * Unique identifier for this app (e.g. `'gym_membership_management_app'`).
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown as the app title in the Rippling UI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Human-readable description of what this app does.
+     *
+     * Optional. @default null
+     */
+    description?: string;
+    /**
+     * App type discriminator.
+     *
+     * Optional. @default `'custom'`
+     */
+    appType?: string;
+    /**
+     * S3 icon for this app.
+     *
+     * Optional. @default null
+     */
+    icon?: AppIcon;
+    /**
+     * Pages shown as tabs in the app. Pass {@link CustomObject} instances for object-page
+     * tabs and {@link SduiPage} instances for custom SDUI surfaces. Tab order matches
+     * the array order.
+     *
+     * Optional. @default `[]`
+     */
+    pages?: AppPage[];
+}
+/**
+ * Defines a Rippling app and registers it with the manifest.
+ *
+ * An app is the top-level navigation container. It groups one or more pages —
+ * either custom-object record pages or SDUI surfaces — as tabs visible to users.
+ * You would normally define the app last in your manifest file, after all objects,
+ * functions, and SDUI pages have been declared.
+ *
+ * @example
+ * ```ts
+ * new App(manifest, {
+ *   apiName: 'gym_membership_management_app',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ *   appType: 'custom',
+ *   pages: [memberObj, trainerObj, sessionObj, todaySchedulePage, checkInDeskPage],
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — object-page tab source.
+ * @see {@link SduiPage} — SDUI surface tab source.
+ */
+export declare class App {
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _description;
+    private readonly _appType;
+    private readonly _icon;
+    /** Wire-format pages, resolved eagerly at construction. */
+    private readonly _pages;
+    /**
+     * @param scope - The manifest to register this app with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: AppProps);
+    /**
+     * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
+     */
+    getApiName(): string;
+    /**
+     * Returns the display name of this app.
+     */
+    getName(): string;
+    /**
+     * Serializes this app to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_APP'`. Optional fields are omitted when unset.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=app.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,KAAK,EAAE,aAAa,EAAE;OACtB,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAoBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/app.d.ts

@@ -0,0 +1,113 @@
+import { CustomObject } from "./custom-object.js";
+import type { ManifestScope } from "./manifest-builder.js";
+import { SduiPage } from "./sdui-page.js";
+/**
+ * A single page entry in an {@link App}.
+ *
+ * - Pass a {@link CustomObject} to create an object-page tab.
+ * - Pass an {@link SduiPage} to create a custom SDUI surface tab.
+ */
+export type AppPage = CustomObject | SduiPage;
+/**
+ * S3 icon reference for an {@link App}.
+ */
+export interface AppIcon {
+    /** S3 bucket holding the icon asset. */
+    s3Bucket: string;
+    /** S3 key (path) within `s3Bucket`. */
+    s3Key: string;
+}
+/**
+ * Initialization properties for {@link App}.
+ */
+export interface AppProps {
+    /**
+     * Unique identifier for this app (e.g. `'gym_membership_management_app'`).
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown as the app title in the Rippling UI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Human-readable description of what this app does.
+     *
+     * Optional. @default null
+     */
+    description?: string;
+    /**
+     * App type discriminator.
+     *
+     * Optional. @default `'custom'`
+     */
+    appType?: string;
+    /**
+     * S3 icon for this app.
+     *
+     * Optional. @default null
+     */
+    icon?: AppIcon;
+    /**
+     * Pages shown as tabs in the app. Pass {@link CustomObject} instances for object-page
+     * tabs and {@link SduiPage} instances for custom SDUI surfaces. Tab order matches
+     * the array order.
+     *
+     * Optional. @default `[]`
+     */
+    pages?: AppPage[];
+}
+/**
+ * Defines a Rippling app and registers it with the manifest.
+ *
+ * An app is the top-level navigation container. It groups one or more pages —
+ * either custom-object record pages or SDUI surfaces — as tabs visible to users.
+ * You would normally define the app last in your manifest file, after all objects,
+ * functions, and SDUI pages have been declared.
+ *
+ * @example
+ * ```ts
+ * new App(manifest, {
+ *   apiName: 'gym_membership_management_app',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ *   appType: 'custom',
+ *   pages: [memberObj, trainerObj, sessionObj, todaySchedulePage, checkInDeskPage],
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — object-page tab source.
+ * @see {@link SduiPage} — SDUI surface tab source.
+ */
+export declare class App {
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _description;
+    private readonly _appType;
+    private readonly _icon;
+    /** Wire-format pages, resolved eagerly at construction. */
+    private readonly _pages;
+    /**
+     * @param scope - The manifest to register this app with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: AppProps);
+    /**
+     * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
+     */
+    getApiName(): string;
+    /**
+     * Returns the display name of this app.
+     */
+    getName(): string;
+    /**
+     * Serializes this app to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_APP'`. Optional fields are omitted when unset.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=app.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;OAChB,KAAK,EAAE,aAAa,EAAE;OACtB,EAAE,QAAQ,EAAE;AAEnB;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,YAAY,GAAG,QAAQ,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IACf;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC;CACnB;AAoBD;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,GAAG;IACd,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAqB;IAClD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAqB;IAC9C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsB;IAC5C,2DAA2D;IAC3D,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAwB;IAE/C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,QAAQ;IAUjD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAc9B"}

package/lib/manifest/app.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.App = void 0;
+const custom_object_1 = require("./custom-object.js");
+function resolvePage(entry) {
+    if (entry instanceof custom_object_1.CustomObject) {
+        const apiName = entry.getApiName();
+        return {
+            api_name: apiName,
+            page_type: 'object_page',
+            object_rql_name: apiName,
+        };
+    }
+    else {
+        const sduiPageId = entry.getSduiPageId();
+        return {
+            api_name: sduiPageId,
+            page_type: 'sdui_page',
+            sdui_page_id: sduiPageId,
+        };
+    }
+}
+/**
+ * Defines a Rippling app and registers it with the manifest.
+ *
+ * An app is the top-level navigation container. It groups one or more pages —
+ * either custom-object record pages or SDUI surfaces — as tabs visible to users.
+ * You would normally define the app last in your manifest file, after all objects,
+ * functions, and SDUI pages have been declared.
+ *
+ * @example
+ * ```ts
+ * new App(manifest, {
+ *   apiName: 'gym_membership_management_app',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ *   appType: 'custom',
+ *   pages: [memberObj, trainerObj, sessionObj, todaySchedulePage, checkInDeskPage],
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — object-page tab source.
+ * @see {@link SduiPage} — SDUI surface tab source.
+ */
+class App {
+    /**
+     * @param scope - The manifest to register this app with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope, props) {
+        this._apiName = props.apiName;
+        this._name = props.name;
+        this._description = props.description;
+        this._appType = props.appType;
+        this._icon = props.icon;
+        this._pages = (props.pages ?? []).map(resolvePage);
+        scope._register(this);
+    }
+    /**
+     * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
+     */
+    getApiName() {
+        return this._apiName;
+    }
+    /**
+     * Returns the display name of this app.
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Serializes this app to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_APP'`. Optional fields are omitted when unset.
+     */
+    toDict() {
+        const component = {
+            type: 'CUSTOM_APP',
+            api_name: this._apiName,
+            name: this._name,
+        };
+        if (this._description != null)
+            component['description'] = this._description;
+        if (this._icon != null) {
+            component['icon'] = { s3_bucket: this._icon.s3Bucket, s3_key: this._icon.s3Key };
+        }
+        if (this._appType != null)
+            component['app_type'] = this._appType;
+        if (this._pages.length > 0)
+            component['pages'] = this._pages.map((p) => ({ ...p }));
+        return component;
+    }
+}
+exports.App = App;
+//# sourceMappingURL=app.js.map

package/lib/manifest/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":";;;AAAA,sDAA+C;AAkE/C,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,4BAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,GAAG;IASd;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAxDD,kBAwDC"}

package/lib/manifest/app.mjs

@@ -0,0 +1,91 @@
+import { CustomObject } from "./custom-object.mjs";
+function resolvePage(entry) {
+    if (entry instanceof CustomObject) {
+        const apiName = entry.getApiName();
+        return {
+            api_name: apiName,
+            page_type: 'object_page',
+            object_rql_name: apiName,
+        };
+    }
+    else {
+        const sduiPageId = entry.getSduiPageId();
+        return {
+            api_name: sduiPageId,
+            page_type: 'sdui_page',
+            sdui_page_id: sduiPageId,
+        };
+    }
+}
+/**
+ * Defines a Rippling app and registers it with the manifest.
+ *
+ * An app is the top-level navigation container. It groups one or more pages —
+ * either custom-object record pages or SDUI surfaces — as tabs visible to users.
+ * You would normally define the app last in your manifest file, after all objects,
+ * functions, and SDUI pages have been declared.
+ *
+ * @example
+ * ```ts
+ * new App(manifest, {
+ *   apiName: 'gym_membership_management_app',
+ *   name: 'Gym Membership Management',
+ *   description: 'Members, trainers, schedules, and check-in',
+ *   appType: 'custom',
+ *   pages: [memberObj, trainerObj, sessionObj, todaySchedulePage, checkInDeskPage],
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — object-page tab source.
+ * @see {@link SduiPage} — SDUI surface tab source.
+ */
+export class App {
+    /**
+     * @param scope - The manifest to register this app with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope, props) {
+        this._apiName = props.apiName;
+        this._name = props.name;
+        this._description = props.description;
+        this._appType = props.appType;
+        this._icon = props.icon;
+        this._pages = (props.pages ?? []).map(resolvePage);
+        scope._register(this);
+    }
+    /**
+     * Returns the api_name of this app (e.g. `'gym_membership_management_app'`).
+     */
+    getApiName() {
+        return this._apiName;
+    }
+    /**
+     * Returns the display name of this app.
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Serializes this app to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_APP'`. Optional fields are omitted when unset.
+     */
+    toDict() {
+        const component = {
+            type: 'CUSTOM_APP',
+            api_name: this._apiName,
+            name: this._name,
+        };
+        if (this._description != null)
+            component['description'] = this._description;
+        if (this._icon != null) {
+            component['icon'] = { s3_bucket: this._icon.s3Bucket, s3_key: this._icon.s3Key };
+        }
+        if (this._appType != null)
+            component['app_type'] = this._appType;
+        if (this._pages.length > 0)
+            component['pages'] = this._pages.map((p) => ({ ...p }));
+        return component;
+    }
+}
+//# sourceMappingURL=app.mjs.map

package/lib/manifest/app.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.mjs","sourceRoot":"","sources":["../../src/lib/manifest/app.ts"],"names":[],"mappings":"OAAO,EAAE,YAAY,EAAE;AAkEvB,SAAS,WAAW,CAAC,KAAc;IACjC,IAAI,KAAK,YAAY,YAAY,EAAE,CAAC;QAClC,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,EAAE,CAAC;QACnC,OAAO;YACL,QAAQ,EAAE,OAAO;YACjB,SAAS,EAAE,aAAa;YACxB,eAAe,EAAE,OAAO;SACzB,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,MAAM,UAAU,GAAG,KAAK,CAAC,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,UAAU;YACpB,SAAS,EAAE,WAAW;YACtB,YAAY,EAAE,UAAU;SACzB,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,OAAO,GAAG;IASd;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAe;QAC/C,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,CAAC;QACtC,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,MAAM,GAAG,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;QACnD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,MAAM,SAAS,GAAwB;YACrC,IAAI,EAAE,YAAY;YAClB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI;YAAE,SAAS,CAAC,aAAa,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC;QAC5E,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,SAAS,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;QACnF,CAAC;QACD,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI;YAAE,SAAS,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC;QACjE,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,SAAS,CAAC,OAAO,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;QACpF,OAAO,SAAS,CAAC;IACnB,CAAC;CACF"}

package/lib/manifest/category.d.mts

@@ -0,0 +1,79 @@
+import type { ManifestScope } from "./manifest-builder.mjs";
+/**
+ * Initialization properties for {@link Category}.
+ */
+export interface CategoryProps {
+    /**
+     * Unique identifier for this category (e.g. `'gym__c'`). Must end with `__c`.
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown in the Rippling UI (e.g. `'Gym'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Human-readable description of what this category groups.
+     *
+     * Optional. @default null
+     */
+    description?: string | null;
+}
+/**
+ * Defines a category and registers it with the manifest.
+ *
+ * A category is the navigation grouping that organizes related custom objects
+ * in the Rippling sidebar. You would normally define one category per domain,
+ * then pass it (or its api_name string) to each {@link CustomObject} in that domain.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ * });
+ *
+ * const gymCategory = new Category(manifest, {
+ *   apiName: 'gym__c',
+ *   name: 'Gym',
+ *   description: 'Memberships, staff, schedules, and attendance',
+ * });
+ *
+ * // Pass the instance to any CustomObject in this domain:
+ * const memberObj = new CustomObject(manifest, {
+ *   apiName: 'gym_member__c',
+ *   name: 'Member',
+ *   category: gymCategory,
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — references this category via instance or api_name string.
+ */
+export declare class Category {
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _description;
+    /**
+     * @param scope - The manifest to register this category with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: CategoryProps);
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
+    getApiName(): string;
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
+    getName(): string;
+    /**
+     * Serializes this category to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_CATEGORY'` and all configured fields.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=category.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"category.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/category.d.ts

@@ -0,0 +1,79 @@
+import type { ManifestScope } from "./manifest-builder.js";
+/**
+ * Initialization properties for {@link Category}.
+ */
+export interface CategoryProps {
+    /**
+     * Unique identifier for this category (e.g. `'gym__c'`). Must end with `__c`.
+     *
+     * Required.
+     */
+    apiName: string;
+    /**
+     * Display name shown in the Rippling UI (e.g. `'Gym'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Human-readable description of what this category groups.
+     *
+     * Optional. @default null
+     */
+    description?: string | null;
+}
+/**
+ * Defines a category and registers it with the manifest.
+ *
+ * A category is the navigation grouping that organizes related custom objects
+ * in the Rippling sidebar. You would normally define one category per domain,
+ * then pass it (or its api_name string) to each {@link CustomObject} in that domain.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ * });
+ *
+ * const gymCategory = new Category(manifest, {
+ *   apiName: 'gym__c',
+ *   name: 'Gym',
+ *   description: 'Memberships, staff, schedules, and attendance',
+ * });
+ *
+ * // Pass the instance to any CustomObject in this domain:
+ * const memberObj = new CustomObject(manifest, {
+ *   apiName: 'gym_member__c',
+ *   name: 'Member',
+ *   category: gymCategory,
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — references this category via instance or api_name string.
+ */
+export declare class Category {
+    private readonly _apiName;
+    private readonly _name;
+    private readonly _description;
+    /**
+     * @param scope - The manifest to register this category with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: CategoryProps);
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
+    getApiName(): string;
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
+    getName(): string;
+    /**
+     * Serializes this category to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_CATEGORY'` and all configured fields.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=category.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"category.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":"OAAO,KAAK,EAAE,aAAa,EAAE;AAE7B;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,qBAAa,QAAQ;IACnB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAgB;IAE7C;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa;IAOtD;;OAEG;IACH,UAAU,IAAI,MAAM;IAIpB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}

package/lib/manifest/category.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Category = void 0;
+/**
+ * Defines a category and registers it with the manifest.
+ *
+ * A category is the navigation grouping that organizes related custom objects
+ * in the Rippling sidebar. You would normally define one category per domain,
+ * then pass it (or its api_name string) to each {@link CustomObject} in that domain.
+ *
+ * @example
+ * ```ts
+ * const manifest = new ManifestBuilder({
+ *   key: 'gym_membership_management',
+ *   name: 'Gym Membership Management',
+ * });
+ *
+ * const gymCategory = new Category(manifest, {
+ *   apiName: 'gym__c',
+ *   name: 'Gym',
+ *   description: 'Memberships, staff, schedules, and attendance',
+ * });
+ *
+ * // Pass the instance to any CustomObject in this domain:
+ * const memberObj = new CustomObject(manifest, {
+ *   apiName: 'gym_member__c',
+ *   name: 'Member',
+ *   category: gymCategory,
+ * });
+ * ```
+ *
+ * @see {@link CustomObject} — references this category via instance or api_name string.
+ */
+class Category {
+    /**
+     * @param scope - The manifest to register this category with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope, props) {
+        this._apiName = props.apiName;
+        this._name = props.name;
+        this._description = props.description ?? null;
+        scope._register(this);
+    }
+    /**
+     * Returns the api_name of this category (e.g. `'gym__c'`).
+     */
+    getApiName() {
+        return this._apiName;
+    }
+    /**
+     * Returns the display name of this category (e.g. `'Gym'`).
+     */
+    getName() {
+        return this._name;
+    }
+    /**
+     * Serializes this category to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_CATEGORY'` and all configured fields.
+     */
+    toDict() {
+        return {
+            type: 'CUSTOM_CATEGORY',
+            api_name: this._apiName,
+            name: this._name,
+            description: this._description ?? null,
+        };
+    }
+}
+exports.Category = Category;
+//# sourceMappingURL=category.js.map

package/lib/manifest/category.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"category.js","sourceRoot":"","sources":["../../src/lib/manifest/category.ts"],"names":[],"mappings":";;;AA0BA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAa,QAAQ;IAKnB;;;OAGG;IACH,YAAY,KAAoB,EAAE,KAAoB;QACpD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC;QAC9B,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,WAAW,IAAI,IAAI,CAAC;QAC9C,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED;;OAEG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED;;OAEG;IACH,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;;OAIG;IACH,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,iBAAiB;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,WAAW,EAAE,IAAI,CAAC,YAAY,IAAI,IAAI;SACvC,CAAC;IACJ,CAAC;CACF;AA3CD,4BA2CC"}