@rippling/rippling-sdk 0.2.0-alpha.82 → 0.2.0-alpha.84

package/core/platform/manifest/custom-objects/object-list-page.d.mts

@@ -0,0 +1,43 @@
+import { FunctionResponse, type FunctionContext, type SduiPageFunctionEvent } from "../../../../functions.mjs";
+import type { AnyCustomObjectDefinition } from "../../custom-objects/types.mjs";
+import type { ManifestCustomObjectTarget } from "./conditions.mjs";
+/**
+ * Standard input shape for object-list page functions that only render their
+ * initial SDUI page.
+ */
+export type TypedObjectListPageInput = SduiPageFunctionEvent<{
+    action: 'init';
+}>;
+/**
+ * Standard output body for object-list page functions that return one rendered
+ * SDUI spec.
+ */
+export interface TypedObjectListPageOutput {
+    /** JSON-serialized SDUI spec payload returned to the platform. */
+    readonly spec: string;
+}
+/**
+ * Builds the standard SDUI function response for a custom-object-backed object
+ * list page.
+ *
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export declare function createTypedObjectListPageResponse<TDefinition extends AnyCustomObjectDefinition>(target: ManifestCustomObjectTarget<TDefinition>): FunctionResponse<TypedObjectListPageOutput>;
+/**
+ * Handles the standard custom-object object-list page event shape.
+ *
+ * The event and context are accepted so callers can keep an exported
+ * `onRipplingEvent(event, context)` signature that matches backend IO-contract
+ * derivation expectations, while delegating the repetitive response plumbing to
+ * this helper.
+ *
+ * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
+ * @param context - Function context supplied by the platform.
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export declare function handleTypedObjectListPageEvent<TDefinition extends AnyCustomObjectDefinition>(event: TypedObjectListPageInput, context: FunctionContext, target: ManifestCustomObjectTarget<TDefinition>): Promise<FunctionResponse<TypedObjectListPageOutput>>;
+//# sourceMappingURL=object-list-page.d.mts.map

package/core/platform/manifest/custom-objects/object-list-page.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-list-page.d.mts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,kCAA8B;AAM3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,uCAAmC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,yBAAqB;AAG/D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAcD;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,SAAS,yBAAyB,EAC7F,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,gBAAgB,CAAC,yBAAyB,CAAC,CAc7C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,8BAA8B,CAAC,WAAW,SAAS,yBAAyB,EAChG,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,OAAO,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAItD"}

package/core/platform/manifest/custom-objects/object-list-page.d.ts

@@ -0,0 +1,43 @@
+import { FunctionResponse, type FunctionContext, type SduiPageFunctionEvent } from "../../../../functions.js";
+import type { AnyCustomObjectDefinition } from "../../custom-objects/types.js";
+import type { ManifestCustomObjectTarget } from "./conditions.js";
+/**
+ * Standard input shape for object-list page functions that only render their
+ * initial SDUI page.
+ */
+export type TypedObjectListPageInput = SduiPageFunctionEvent<{
+    action: 'init';
+}>;
+/**
+ * Standard output body for object-list page functions that return one rendered
+ * SDUI spec.
+ */
+export interface TypedObjectListPageOutput {
+    /** JSON-serialized SDUI spec payload returned to the platform. */
+    readonly spec: string;
+}
+/**
+ * Builds the standard SDUI function response for a custom-object-backed object
+ * list page.
+ *
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export declare function createTypedObjectListPageResponse<TDefinition extends AnyCustomObjectDefinition>(target: ManifestCustomObjectTarget<TDefinition>): FunctionResponse<TypedObjectListPageOutput>;
+/**
+ * Handles the standard custom-object object-list page event shape.
+ *
+ * The event and context are accepted so callers can keep an exported
+ * `onRipplingEvent(event, context)` signature that matches backend IO-contract
+ * derivation expectations, while delegating the repetitive response plumbing to
+ * this helper.
+ *
+ * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
+ * @param context - Function context supplied by the platform.
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export declare function handleTypedObjectListPageEvent<TDefinition extends AnyCustomObjectDefinition>(event: TypedObjectListPageInput, context: FunctionContext, target: ManifestCustomObjectTarget<TDefinition>): Promise<FunctionResponse<TypedObjectListPageOutput>>;
+//# sourceMappingURL=object-list-page.d.ts.map

package/core/platform/manifest/custom-objects/object-list-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-list-page.d.ts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,KAAK,eAAe,EAAE,KAAK,qBAAqB,EAAE,iCAA8B;AAM3G,OAAO,KAAK,EAAE,yBAAyB,EAAE,sCAAmC;AAC5E,OAAO,KAAK,EAAE,0BAA0B,EAAE,wBAAqB;AAG/D;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,qBAAqB,CAAC;IAAE,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC,CAAC;AAEjF;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,kEAAkE;IAClE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAcD;;;;;;;GAOG;AACH,wBAAgB,iCAAiC,CAAC,WAAW,SAAS,yBAAyB,EAC7F,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,gBAAgB,CAAC,yBAAyB,CAAC,CAc7C;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAsB,8BAA8B,CAAC,WAAW,SAAS,yBAAyB,EAChG,KAAK,EAAE,wBAAwB,EAC/B,OAAO,EAAE,eAAe,EACxB,MAAM,EAAE,0BAA0B,CAAC,WAAW,CAAC,GAC9C,OAAO,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC,CAItD"}

package/core/platform/manifest/custom-objects/object-list-page.js

@@ -0,0 +1,54 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createTypedObjectListPageResponse = createTypedObjectListPageResponse;
+exports.handleTypedObjectListPageEvent = handleTypedObjectListPageEvent;
+const custom_apps_1 = require("@rippling/pebble-sdui-web/catalogs/custom-apps");
+const functions_1 = require("../../../../functions.js");
+function isManifestRegistration(target) {
+    return typeof target === 'object' && target != null && 'definition' in target && 'object' in target;
+}
+function resolveObjectApiName(target) {
+    return isManifestRegistration(target) ? target.definition.apiName : target.apiName;
+}
+/**
+ * Builds the standard SDUI function response for a custom-object-backed object
+ * list page.
+ *
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+function createTypedObjectListPageResponse(target) {
+    const spec = (0, custom_apps_1.render)({
+        root: (0, custom_apps_1.ObjectListView)({
+            props: { objectApiName: resolveObjectApiName(target) },
+        }),
+        state: {},
+    });
+    return new functions_1.FunctionResponse({
+        body: { spec: JSON.stringify(spec) },
+        statusCode: 200,
+        headers: {},
+        message: '',
+    });
+}
+/**
+ * Handles the standard custom-object object-list page event shape.
+ *
+ * The event and context are accepted so callers can keep an exported
+ * `onRipplingEvent(event, context)` signature that matches backend IO-contract
+ * derivation expectations, while delegating the repetitive response plumbing to
+ * this helper.
+ *
+ * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
+ * @param context - Function context supplied by the platform.
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+async function handleTypedObjectListPageEvent(event, context, target) {
+    void event;
+    void context;
+    return createTypedObjectListPageResponse(target);
+}
+//# sourceMappingURL=object-list-page.js.map

package/core/platform/manifest/custom-objects/object-list-page.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-list-page.js","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":";;AA8CA,8EAgBC;AAgBD,wEAQC;AAtFD,gFAAwF;AACxF,wDAA2G;AAyB3G,SAAS,sBAAsB,CAC7B,MAA+C;IAE/C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,IAAI,YAAY,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,CAAC;AACtG,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAA+C;IAE/C,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AACrF,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,iCAAiC,CAC/C,MAA+C;IAE/C,MAAM,IAAI,GAAG,IAAA,oBAAM,EAAC;QAClB,IAAI,EAAE,IAAA,4BAAc,EAAC;YACnB,KAAK,EAAE,EAAE,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,EAAE;SACvD,CAAC;QACF,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IAEH,OAAO,IAAI,4BAAgB,CAA4B;QACrD,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QACpC,UAAU,EAAE,GAAG;QACf,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACI,KAAK,UAAU,8BAA8B,CAClD,KAA+B,EAC/B,OAAwB,EACxB,MAA+C;IAE/C,KAAK,KAAK,CAAC;IACX,KAAK,OAAO,CAAC;IACb,OAAO,iCAAiC,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC"}

package/core/platform/manifest/custom-objects/object-list-page.mjs

@@ -0,0 +1,50 @@
+import { ObjectListView, render } from '@rippling/pebble-sdui-web/catalogs/custom-apps';
+import { FunctionResponse } from "../../../../functions.mjs";
+function isManifestRegistration(target) {
+    return typeof target === 'object' && target != null && 'definition' in target && 'object' in target;
+}
+function resolveObjectApiName(target) {
+    return isManifestRegistration(target) ? target.definition.apiName : target.apiName;
+}
+/**
+ * Builds the standard SDUI function response for a custom-object-backed object
+ * list page.
+ *
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export function createTypedObjectListPageResponse(target) {
+    const spec = render({
+        root: ObjectListView({
+            props: { objectApiName: resolveObjectApiName(target) },
+        }),
+        state: {},
+    });
+    return new FunctionResponse({
+        body: { spec: JSON.stringify(spec) },
+        statusCode: 200,
+        headers: {},
+        message: '',
+    });
+}
+/**
+ * Handles the standard custom-object object-list page event shape.
+ *
+ * The event and context are accepted so callers can keep an exported
+ * `onRipplingEvent(event, context)` signature that matches backend IO-contract
+ * derivation expectations, while delegating the repetitive response plumbing to
+ * this helper.
+ *
+ * @param event - Incoming SDUI page event, expected to be the standard init-only object-list shape.
+ * @param context - Function context supplied by the platform.
+ * @param target - Typed custom-object definition or manifest registration that owns the object list page.
+ * @returns Function response containing the rendered ObjectListView spec.
+ * @typeParam TDefinition - Typed custom-object definition whose API name should back the list page.
+ */
+export async function handleTypedObjectListPageEvent(event, context, target) {
+    void event;
+    void context;
+    return createTypedObjectListPageResponse(target);
+}
+//# sourceMappingURL=object-list-page.mjs.map

package/core/platform/manifest/custom-objects/object-list-page.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"object-list-page.mjs","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/object-list-page.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,gDAAgD,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAoD,kCAA8B;AAyB3G,SAAS,sBAAsB,CAC7B,MAA+C;IAE/C,OAAO,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,IAAI,IAAI,IAAI,YAAY,IAAI,MAAM,IAAI,QAAQ,IAAI,MAAM,CAAC;AACtG,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAA+C;IAE/C,OAAO,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC;AACrF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,iCAAiC,CAC/C,MAA+C;IAE/C,MAAM,IAAI,GAAG,MAAM,CAAC;QAClB,IAAI,EAAE,cAAc,CAAC;YACnB,KAAK,EAAE,EAAE,aAAa,EAAE,oBAAoB,CAAC,MAAM,CAAC,EAAE;SACvD,CAAC;QACF,KAAK,EAAE,EAAE;KACV,CAAC,CAAC;IAEH,OAAO,IAAI,gBAAgB,CAA4B;QACrD,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE;QACpC,UAAU,EAAE,GAAG;QACf,OAAO,EAAE,EAAE;QACX,OAAO,EAAE,EAAE;KACZ,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,CAAC,KAAK,UAAU,8BAA8B,CAClD,KAA+B,EAC/B,OAAwB,EACxB,MAA+C;IAE/C,KAAK,KAAK,CAAC;IACX,KAAK,OAAO,CAAC;IACb,OAAO,iCAAiC,CAAC,MAAM,CAAC,CAAC;AACnD,CAAC"}

package/core/platform/manifest/custom-objects/page-layout.d.mts

@@ -0,0 +1,142 @@
+import { CustomObjectPageLayout, type CustomObjectFieldSection, type CustomObjectPageLayoutProps, type CustomTab, type FieldsSection, type PageLayoutSection, type SectionField, type SystemSectionEdit, type SystemTabEdit, type TabEdits, type TabWithSections } from "../../../../lib/manifest.mjs";
+import type { AnyCustomObjectDefinition } from "../../custom-objects/types.mjs";
+import type { ManifestRegistration } from "./types.mjs";
+import type { TypedManifestFieldInput } from "./field-resolution.mjs";
+/**
+ * Field object accepted inside typed page-layout field arrays.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export interface TypedSectionField<TDefinition extends AnyCustomObjectDefinition> extends Omit<SectionField, 'field'> {
+    /** Field to display, expressed as a typed field-name string or manifest field reference. */
+    readonly field: TypedManifestFieldInput<TDefinition>;
+}
+/**
+ * Field-array entry accepted by typed page-layout helpers.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export type TypedSectionFieldInput<TDefinition extends AnyCustomObjectDefinition> = TypedManifestFieldInput<TDefinition> | TypedSectionField<TDefinition>;
+/**
+ * `fields_section` shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedFieldsSection<TDefinition extends AnyCustomObjectDefinition> extends Omit<FieldsSection, 'fields'> {
+    /** Fields to display in this section, expressed using typed field-name strings or manifest field refs. */
+    readonly fields: readonly TypedSectionFieldInput<TDefinition>[];
+}
+/**
+ * Page-layout section shape accepted by the typed page-layout helper.
+ *
+ * Only `fields_section.fields` is specialized in this first pass; other section
+ * variants continue to use the low-level manifest shapes unchanged.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export type TypedPageLayoutSection<TDefinition extends AnyCustomObjectDefinition> = TypedFieldsSection<TDefinition> | Exclude<PageLayoutSection, FieldsSection>;
+/**
+ * Tab-with-sections shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedTabWithSections<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabWithSections, 'sections'> {
+    /** Sections inside this tab. */
+    readonly sections: readonly TypedPageLayoutSection<TDefinition>[];
+}
+/**
+ * Tab shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export type TypedPageLayoutTab<TDefinition extends AnyCustomObjectDefinition> = TypedTabWithSections<TDefinition> | CustomTab;
+/**
+ * System-section edit shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedSystemSectionEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemSectionEdit, 'newFields'> {
+    /** Fields to append to the target system section. */
+    readonly newFields?: readonly TypedSectionFieldInput<TDefinition>[];
+}
+/**
+ * System-tab edit shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedSystemTabEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
+    /** New sections to add to the target system tab. */
+    readonly newSections?: readonly TypedPageLayoutSection<TDefinition>[];
+    /** Edits to built-in sections inside the target system tab. */
+    readonly systemSectionEdits?: Readonly<Record<string, TypedSystemSectionEdit<TDefinition>>>;
+}
+/**
+ * `tabEdits` shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedTabEdits<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabEdits, 'newTabs' | 'systemTabEdits'> {
+    /** New tabs to add to the layout. */
+    readonly newTabs?: readonly TypedPageLayoutTab<TDefinition>[];
+    /** Edits to existing system tabs. */
+    readonly systemTabEdits?: Readonly<Record<string, TypedSystemTabEdit<TDefinition>>>;
+}
+/**
+ * Initialization properties for {@link defineTypedPageLayout}.
+ *
+ * This first pass focuses on the common field-array surfaces:
+ * - `tabEdits.newTabs[].sections[].fields`
+ * - `tabEdits.systemTabEdits.*.newSections[].fields`
+ * - `tabEdits.systemTabEdits.*.systemSectionEdits.*.newFields`
+ *
+ * Other page-layout configuration remains identical to the low-level manifest API.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedCustomObjectPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> extends Omit<CustomObjectPageLayoutProps, 'tabEdits'> {
+    /** Typed page-layout tab edits. */
+    readonly tabEdits?: TypedTabEdits<TDefinition>;
+}
+/**
+ * Initialization properties for {@link defineBasicTypedPageLayout}.
+ *
+ * This is the typed equivalent of {@link CustomObjectPageLayout.basic}: a
+ * single-tab, single-section layout for the common case where callers do not
+ * need to customize tab structure.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export interface TypedBasicPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> {
+    /** Optional existing manifest section that should own every listed field. */
+    readonly section?: CustomObjectFieldSection;
+    /** Optional fields to place in the generated General section. */
+    readonly fields?: readonly TypedManifestFieldInput<TDefinition>[];
+}
+/**
+ * Registers a typed page layout for a manifest custom object.
+ *
+ * This helper sits on top of the low-level {@link CustomObjectPageLayout}
+ * manifest class. It preserves the runtime behavior of that class while adding
+ * object-specific string-literal IntelliSense for the most common field-array
+ * authoring surfaces.
+ *
+ * @param registration - Manifest registration produced from the typed object definition.
+ * @param props - Typed page-layout properties to materialize into the manifest class.
+ * @returns Low-level manifest page-layout instance with typed field arrays resolved.
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export declare function defineTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props: TypedCustomObjectPageLayoutProps<TDefinition>): CustomObjectPageLayout;
+/**
+ * Registers the common single-tab "basic" layout using typed field-name strings.
+ *
+ * Use this helper when the low-level {@link CustomObjectPageLayout.basic}
+ * behavior is sufficient and you want the shortest typed path from schema to a
+ * working page layout.
+ *
+ * @param registration - Manifest registration produced from the typed object definition.
+ * @param props - Optional basic-layout properties.
+ * @returns Low-level manifest page-layout instance created through `CustomObjectPageLayout.basic(...)`.
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export declare function defineBasicTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props?: TypedBasicPageLayoutProps<TDefinition>): CustomObjectPageLayout;
+//# sourceMappingURL=page-layout.d.mts.map

package/core/platform/manifest/custom-objects/page-layout.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-layout.d.mts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/page-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,eAAe,EACrB,qCAAiC;AAClC,OAAO,KAAK,EAAE,yBAAyB,EAAE,uCAAmC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,oBAAgB;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,+BAA2B;AAGlE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,yBAAyB,CAC9E,SAAQ,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;IACnC,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,uBAAuB,CAAC,WAAW,CAAC,GACpC,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,MAAM,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,kBAAkB,CAAC,WAAW,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,WAAW,SAAS,yBAAyB,CACjF,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC;IACzC,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,IACxE,oBAAoB,CAAC,WAAW,CAAC,GACjC,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,CACnF,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IAC5C,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACrE;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,oBAAoB,CAAC;IACjE,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;IACtE,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAC7F;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,WAAW,SAAS,yBAAyB,CAC1E,SAAQ,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,gBAAgB,CAAC;IACpD,qCAAqC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9D,qCAAqC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACrF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gCAAgC,CAAC,WAAW,SAAS,yBAAyB,CAC7F,SAAQ,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC;IACrD,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,yBAAyB;IACtF,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAC5C,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAgLD;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,SAAS,yBAAyB,EACjF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,EAAE,gCAAgC,CAAC,WAAW,CAAC,GACnD,sBAAsB,CAWxB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,SAAS,yBAAyB,EACtF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,GAAE,yBAAyB,CAAC,WAAW,CAAM,GACjD,sBAAsB,CAOxB"}

package/core/platform/manifest/custom-objects/page-layout.d.ts

@@ -0,0 +1,142 @@
+import { CustomObjectPageLayout, type CustomObjectFieldSection, type CustomObjectPageLayoutProps, type CustomTab, type FieldsSection, type PageLayoutSection, type SectionField, type SystemSectionEdit, type SystemTabEdit, type TabEdits, type TabWithSections } from "../../../../lib/manifest.js";
+import type { AnyCustomObjectDefinition } from "../../custom-objects/types.js";
+import type { ManifestRegistration } from "./types.js";
+import type { TypedManifestFieldInput } from "./field-resolution.js";
+/**
+ * Field object accepted inside typed page-layout field arrays.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export interface TypedSectionField<TDefinition extends AnyCustomObjectDefinition> extends Omit<SectionField, 'field'> {
+    /** Field to display, expressed as a typed field-name string or manifest field reference. */
+    readonly field: TypedManifestFieldInput<TDefinition>;
+}
+/**
+ * Field-array entry accepted by typed page-layout helpers.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export type TypedSectionFieldInput<TDefinition extends AnyCustomObjectDefinition> = TypedManifestFieldInput<TDefinition> | TypedSectionField<TDefinition>;
+/**
+ * `fields_section` shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedFieldsSection<TDefinition extends AnyCustomObjectDefinition> extends Omit<FieldsSection, 'fields'> {
+    /** Fields to display in this section, expressed using typed field-name strings or manifest field refs. */
+    readonly fields: readonly TypedSectionFieldInput<TDefinition>[];
+}
+/**
+ * Page-layout section shape accepted by the typed page-layout helper.
+ *
+ * Only `fields_section.fields` is specialized in this first pass; other section
+ * variants continue to use the low-level manifest shapes unchanged.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export type TypedPageLayoutSection<TDefinition extends AnyCustomObjectDefinition> = TypedFieldsSection<TDefinition> | Exclude<PageLayoutSection, FieldsSection>;
+/**
+ * Tab-with-sections shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedTabWithSections<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabWithSections, 'sections'> {
+    /** Sections inside this tab. */
+    readonly sections: readonly TypedPageLayoutSection<TDefinition>[];
+}
+/**
+ * Tab shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export type TypedPageLayoutTab<TDefinition extends AnyCustomObjectDefinition> = TypedTabWithSections<TDefinition> | CustomTab;
+/**
+ * System-section edit shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedSystemSectionEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemSectionEdit, 'newFields'> {
+    /** Fields to append to the target system section. */
+    readonly newFields?: readonly TypedSectionFieldInput<TDefinition>[];
+}
+/**
+ * System-tab edit shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedSystemTabEdit<TDefinition extends AnyCustomObjectDefinition> extends Omit<SystemTabEdit, 'newSections' | 'systemSectionEdits'> {
+    /** New sections to add to the target system tab. */
+    readonly newSections?: readonly TypedPageLayoutSection<TDefinition>[];
+    /** Edits to built-in sections inside the target system tab. */
+    readonly systemSectionEdits?: Readonly<Record<string, TypedSystemSectionEdit<TDefinition>>>;
+}
+/**
+ * `tabEdits` shape accepted by the typed page-layout helper.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedTabEdits<TDefinition extends AnyCustomObjectDefinition> extends Omit<TabEdits, 'newTabs' | 'systemTabEdits'> {
+    /** New tabs to add to the layout. */
+    readonly newTabs?: readonly TypedPageLayoutTab<TDefinition>[];
+    /** Edits to existing system tabs. */
+    readonly systemTabEdits?: Readonly<Record<string, TypedSystemTabEdit<TDefinition>>>;
+}
+/**
+ * Initialization properties for {@link defineTypedPageLayout}.
+ *
+ * This first pass focuses on the common field-array surfaces:
+ * - `tabEdits.newTabs[].sections[].fields`
+ * - `tabEdits.systemTabEdits.*.newSections[].fields`
+ * - `tabEdits.systemTabEdits.*.systemSectionEdits.*.newFields`
+ *
+ * Other page-layout configuration remains identical to the low-level manifest API.
+ *
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export interface TypedCustomObjectPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> extends Omit<CustomObjectPageLayoutProps, 'tabEdits'> {
+    /** Typed page-layout tab edits. */
+    readonly tabEdits?: TypedTabEdits<TDefinition>;
+}
+/**
+ * Initialization properties for {@link defineBasicTypedPageLayout}.
+ *
+ * This is the typed equivalent of {@link CustomObjectPageLayout.basic}: a
+ * single-tab, single-section layout for the common case where callers do not
+ * need to customize tab structure.
+ *
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export interface TypedBasicPageLayoutProps<TDefinition extends AnyCustomObjectDefinition> {
+    /** Optional existing manifest section that should own every listed field. */
+    readonly section?: CustomObjectFieldSection;
+    /** Optional fields to place in the generated General section. */
+    readonly fields?: readonly TypedManifestFieldInput<TDefinition>[];
+}
+/**
+ * Registers a typed page layout for a manifest custom object.
+ *
+ * This helper sits on top of the low-level {@link CustomObjectPageLayout}
+ * manifest class. It preserves the runtime behavior of that class while adding
+ * object-specific string-literal IntelliSense for the most common field-array
+ * authoring surfaces.
+ *
+ * @param registration - Manifest registration produced from the typed object definition.
+ * @param props - Typed page-layout properties to materialize into the manifest class.
+ * @returns Low-level manifest page-layout instance with typed field arrays resolved.
+ * @typeParam TDefinition - Object definition whose valid field arrays should be enforced.
+ */
+export declare function defineTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props: TypedCustomObjectPageLayoutProps<TDefinition>): CustomObjectPageLayout;
+/**
+ * Registers the common single-tab "basic" layout using typed field-name strings.
+ *
+ * Use this helper when the low-level {@link CustomObjectPageLayout.basic}
+ * behavior is sufficient and you want the shortest typed path from schema to a
+ * working page layout.
+ *
+ * @param registration - Manifest registration produced from the typed object definition.
+ * @param props - Optional basic-layout properties.
+ * @returns Low-level manifest page-layout instance created through `CustomObjectPageLayout.basic(...)`.
+ * @typeParam TDefinition - Object definition whose valid field inputs should be enforced.
+ */
+export declare function defineBasicTypedPageLayout<TDefinition extends AnyCustomObjectDefinition>(registration: ManifestRegistration<TDefinition>, props?: TypedBasicPageLayoutProps<TDefinition>): CustomObjectPageLayout;
+//# sourceMappingURL=page-layout.d.ts.map

package/core/platform/manifest/custom-objects/page-layout.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-layout.d.ts","sourceRoot":"","sources":["../../../../src/core/platform/manifest/custom-objects/page-layout.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,sBAAsB,EACtB,KAAK,wBAAwB,EAC7B,KAAK,2BAA2B,EAChC,KAAK,SAAS,EACd,KAAK,aAAa,EAClB,KAAK,iBAAiB,EAEtB,KAAK,YAAY,EAEjB,KAAK,iBAAiB,EACtB,KAAK,aAAa,EAClB,KAAK,QAAQ,EACb,KAAK,eAAe,EACrB,oCAAiC;AAClC,OAAO,KAAK,EAAE,yBAAyB,EAAE,sCAAmC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAgB;AACpD,OAAO,KAAK,EAAE,uBAAuB,EAAE,8BAA2B;AAGlE;;;;GAIG;AACH,MAAM,WAAW,iBAAiB,CAAC,WAAW,SAAS,yBAAyB,CAC9E,SAAQ,IAAI,CAAC,YAAY,EAAE,OAAO,CAAC;IACnC,4FAA4F;IAC5F,QAAQ,CAAC,KAAK,EAAE,uBAAuB,CAAC,WAAW,CAAC,CAAC;CACtD;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,uBAAuB,CAAC,WAAW,CAAC,GACpC,iBAAiB,CAAC,WAAW,CAAC,CAAC;AAEnC;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,QAAQ,CAAC;IACrC,0GAA0G;IAC1G,QAAQ,CAAC,MAAM,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACjE;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,IAC5E,kBAAkB,CAAC,WAAW,CAAC,GAC/B,OAAO,CAAC,iBAAiB,EAAE,aAAa,CAAC,CAAC;AAE9C;;;;GAIG;AACH,MAAM,WAAW,oBAAoB,CAAC,WAAW,SAAS,yBAAyB,CACjF,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC;IACzC,gCAAgC;IAChC,QAAQ,CAAC,QAAQ,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,IACxE,oBAAoB,CAAC,WAAW,CAAC,GACjC,SAAS,CAAC;AAEd;;;;GAIG;AACH,MAAM,WAAW,sBAAsB,CAAC,WAAW,SAAS,yBAAyB,CACnF,SAAQ,IAAI,CAAC,iBAAiB,EAAE,WAAW,CAAC;IAC5C,qDAAqD;IACrD,QAAQ,CAAC,SAAS,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;CACrE;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB,CAAC,WAAW,SAAS,yBAAyB,CAC/E,SAAQ,IAAI,CAAC,aAAa,EAAE,aAAa,GAAG,oBAAoB,CAAC;IACjE,oDAAoD;IACpD,QAAQ,CAAC,WAAW,CAAC,EAAE,SAAS,sBAAsB,CAAC,WAAW,CAAC,EAAE,CAAC;IACtE,+DAA+D;IAC/D,QAAQ,CAAC,kBAAkB,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CAC7F;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,WAAW,SAAS,yBAAyB,CAC1E,SAAQ,IAAI,CAAC,QAAQ,EAAE,SAAS,GAAG,gBAAgB,CAAC;IACpD,qCAAqC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,kBAAkB,CAAC,WAAW,CAAC,EAAE,CAAC;IAC9D,qCAAqC;IACrC,QAAQ,CAAC,cAAc,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;CACrF;AAED;;;;;;;;;;;GAWG;AACH,MAAM,WAAW,gCAAgC,CAAC,WAAW,SAAS,yBAAyB,CAC7F,SAAQ,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC;IACrD,mCAAmC;IACnC,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CAChD;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,yBAAyB,CAAC,WAAW,SAAS,yBAAyB;IACtF,6EAA6E;IAC7E,QAAQ,CAAC,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAC5C,iEAAiE;IACjE,QAAQ,CAAC,MAAM,CAAC,EAAE,SAAS,uBAAuB,CAAC,WAAW,CAAC,EAAE,CAAC;CACnE;AAgLD;;;;;;;;;;;;GAYG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,SAAS,yBAAyB,EACjF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,EAAE,gCAAgC,CAAC,WAAW,CAAC,GACnD,sBAAsB,CAWxB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,0BAA0B,CAAC,WAAW,SAAS,yBAAyB,EACtF,YAAY,EAAE,oBAAoB,CAAC,WAAW,CAAC,EAC/C,KAAK,GAAE,yBAAyB,CAAC,WAAW,CAAM,GACjD,sBAAsB,CAOxB"}