@rippling/rippling-sdk 0.2.0-alpha.100

package/lib/manifest/custom-field.mjs

@@ -0,0 +1,207 @@
+import { generateId } from "./_helpers.mjs";
+import { getExistingManifestContext } from "./existing-manifest-context.mjs";
+import { requireObjectComponentField, requireStringComponentField } from "./_existing-component-fields.mjs";
+export const CUSTOM_FIELD_TYPES = [
+    'TEXT',
+    'DATE',
+    'NUMBER',
+    'CURRENCY',
+    'PERCENTAGE',
+    'SELECT',
+    'FILE',
+    'ID',
+    'RADIO',
+    'TEXTAREA',
+    'RANGE',
+    'REFERENCE_ID',
+    'BOOLEAN',
+    'ADDRESS',
+    'OG_REFERENCE_FIELD',
+    'EMAIL',
+    'URL',
+];
+function cloneJson(value) {
+    if (value == null)
+        return value;
+    return JSON.parse(JSON.stringify(value));
+}
+function customFieldDataTypeFromWire(dataType) {
+    const fieldType = requireStringComponentField(dataType, 'field_type', CustomField.componentType);
+    switch (fieldType) {
+        case 'NUMBER':
+            return {
+                fieldType,
+                decimalPlaces: dataType['num_of_decimal_places'] ?? null,
+            };
+        case 'CURRENCY':
+            return { fieldType, currency: dataType['currency'] ?? null };
+        case 'SELECT':
+        case 'RADIO': {
+            const options = dataType['options_list'];
+            if (!Array.isArray(options) || !options.every((option) => typeof option === 'string')) {
+                throw new TypeError(`CUSTOM_FIELD_V2 data_type.options_list must be a string array.`);
+            }
+            return { fieldType, options };
+        }
+        case 'ID':
+            return {
+                fieldType,
+                numberOfCharacters: dataType['num_of_chars'] ?? null,
+                characterType: dataType['type_of_chars'] ?? null,
+            };
+        case 'OG_REFERENCE_FIELD':
+            return {
+                fieldType,
+                referencedModelRqlName: requireStringComponentField(dataType, 'og_model_rql_name', CustomField.componentType),
+            };
+        default:
+            if (!CUSTOM_FIELD_TYPES.includes(fieldType)) {
+                throw new TypeError(`Unsupported CUSTOM_FIELD_V2 field_type: ${fieldType}`);
+            }
+            return { fieldType };
+    }
+}
+/** A Custom Field V2 field on a native or custom object. */
+export class CustomField {
+    static toDeletionIdentifier(customFieldId) {
+        return { type: CustomField.componentType, cfv2_id: customFieldId };
+    }
+    constructor(scope, props) {
+        const runtimeProps = props;
+        if (!props.apiName.endsWith('__cfv2')) {
+            throw new Error(`Custom Field V2 api_name must end with __cfv2: ${props.apiName}`);
+        }
+        if (props.section.getModelRqlName() !== props.modelRqlName) {
+            throw new Error(`Custom field "${props.apiName}" section belongs to "${props.section.getModelRqlName()}", ` +
+                `but the field belongs to "${props.modelRqlName}".`);
+        }
+        if (runtimeProps.rqlDefinitionFormula != null && runtimeProps.fieldWriteAccess !== 'NO_ACCESS') {
+            throw new Error(`Formula custom field "${props.apiName}" must have fieldWriteAccess "NO_ACCESS".`);
+        }
+        if (props.modelRqlName === 'Employee') {
+            if (runtimeProps.fieldPermissionClassification == null ||
+                runtimeProps.fieldReadAccess == null ||
+                runtimeProps.fieldWriteAccess == null ||
+                runtimeProps.applicableGroupId == null) {
+                throw new Error(`Employee custom field "${props.apiName}" requires fieldPermissionClassification, ` +
+                    `fieldReadAccess, fieldWriteAccess, and applicableGroupId.`);
+            }
+            if (runtimeProps.fieldReadAccess === 'ALL_ACCESS' &&
+                (runtimeProps.fieldPermissionClassification === 'SENSITIVE_PERSONAL_INFO' ||
+                    runtimeProps.fieldPermissionClassification === 'SENSITIVE_EMPLOYMENT_INFO')) {
+                throw new Error(`Employee custom field "${props.apiName}" cannot use a sensitive permission classification ` +
+                    `with fieldReadAccess "ALL_ACCESS".`);
+            }
+            if (runtimeProps.collectDuring === 'ONBOARDING' &&
+                (runtimeProps.fieldReadAccess === 'ADMIN_ACCESS' || runtimeProps.fieldWriteAccess === 'ADMIN_ACCESS')) {
+                throw new Error(`Employee onboarding custom field "${props.apiName}" must grant the employee read and write access.`);
+            }
+        }
+        this._fieldId = props.fieldId ?? generateId('cfv2');
+        this.props = {
+            ...props,
+            dataType: cloneJson(props.dataType),
+        };
+        scope._register(this);
+    }
+    static loadFromExisting(fieldIdOrApiName, options = {}) {
+        return getExistingManifestContext(options).loadCustomField(fieldIdOrApiName);
+    }
+    /** @internal Hydrates a custom field from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component, section) {
+        const dataType = requireObjectComponentField(component, 'data_type', CustomField.componentType);
+        const defaultValue = component['default_value'];
+        const formula = component['rql_definition_formula'];
+        const applicableGroupId = component['applicable_group_id'] == null ?
+            null
+            : requireStringComponentField(component, 'applicable_group_id', CustomField.componentType);
+        const common = {
+            fieldId: requireStringComponentField(component, 'obj_id', CustomField.componentType),
+            name: requireStringComponentField(component, 'name', CustomField.componentType),
+            section,
+            modelRqlName: requireStringComponentField(component, 'model_rql_name', CustomField.componentType),
+            apiName: requireStringComponentField(component, 'api_name', CustomField.componentType),
+            dataType: customFieldDataTypeFromWire(dataType),
+            fieldPermissionClassification: component['field_permission_classification'] ?? null,
+            fieldReadAccess: component['field_read_access'] ?? null,
+            fieldWriteAccess: component['field_write_access'] ?? null,
+            applicableGroupId,
+            description: component['description'] ?? null,
+            displayOrder: component['display_order'] ?? null,
+        };
+        if (typeof formula === 'string') {
+            if (common.fieldWriteAccess != null && common.fieldWriteAccess !== 'NO_ACCESS') {
+                throw new TypeError(`Formula CUSTOM_FIELD_V2 field_write_access must be NO_ACCESS.`);
+            }
+            return new CustomField(scope, {
+                ...common,
+                fieldWriteAccess: 'NO_ACCESS',
+                rqlDefinitionFormula: formula,
+                collectDuring: null,
+                required: null,
+                tip: null,
+                defaultValue: null,
+            });
+        }
+        const defaultValueFormula = defaultValue?.['rql_definition_formula'];
+        const staticDefaultValue = defaultValue?.['value'];
+        return new CustomField(scope, {
+            ...common,
+            rqlDefinitionFormula: null,
+            collectDuring: component['collect_during'] ?? null,
+            required: component['required'] ?? null,
+            tip: component['tip'] ?? null,
+            defaultValue: typeof defaultValueFormula === 'string' ? { rqlDefinitionFormula: defaultValueFormula }
+                : typeof staticDefaultValue === 'string' ? { value: staticDefaultValue }
+                    : null,
+        });
+    }
+    getFieldId() {
+        return this._fieldId;
+    }
+    getApiName() {
+        return this.props.apiName;
+    }
+    getModelRqlName() {
+        return this.props.modelRqlName;
+    }
+    toDict() {
+        const dataType = this.props.dataType;
+        const defaultValue = this.props.defaultValue;
+        return {
+            type: CustomField.componentType,
+            obj_id: this._fieldId,
+            name: this.props.name,
+            section: this.props.section.getSectionId(),
+            model_rql_name: this.props.modelRqlName,
+            data_type: {
+                type: CustomField.componentType,
+                field_type: dataType.fieldType,
+                options_list: 'options' in dataType ? [...dataType.options] : null,
+                currency: 'currency' in dataType ? dataType.currency ?? null : null,
+                num_of_decimal_places: 'decimalPlaces' in dataType ? dataType.decimalPlaces ?? null : null,
+                num_of_chars: 'numberOfCharacters' in dataType ? dataType.numberOfCharacters ?? null : null,
+                type_of_chars: 'characterType' in dataType ? dataType.characterType ?? null : null,
+                og_model_rql_name: 'referencedModelRqlName' in dataType ? dataType.referencedModelRqlName : null,
+            },
+            api_name: this.props.apiName,
+            field_permission_classification: this.props.fieldPermissionClassification ?? null,
+            field_read_access: this.props.fieldReadAccess ?? null,
+            field_write_access: this.props.fieldWriteAccess ?? null,
+            collect_during: this.props.collectDuring ?? null,
+            applicable_group_id: this.props.applicableGroupId ?? null,
+            description: this.props.description ?? null,
+            required: this.props.required ?? null,
+            tip: this.props.tip ?? null,
+            rql_definition_formula: this.props.rqlDefinitionFormula ?? null,
+            default_value: defaultValue == null ? null : ({
+                type: CustomField.componentType,
+                value: 'value' in defaultValue ? defaultValue.value : null,
+                rql_definition_formula: 'rqlDefinitionFormula' in defaultValue ? defaultValue.rqlDefinitionFormula : null,
+            }),
+            display_order: this.props.displayOrder ?? null,
+        };
+    }
+}
+CustomField.componentType = 'CUSTOM_FIELD_V2';
+//# sourceMappingURL=custom-field.mjs.map

package/lib/manifest/custom-field.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-field.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,uBAAmB;AAExC,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAE9G,OAAO,EAAE,2BAA2B,EAAE,2BAA2B,EAAE,yCAAqC;AAExG,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,MAAM;IACN,MAAM;IACN,QAAQ;IACR,UAAU;IACV,YAAY;IACZ,QAAQ;IACR,MAAM;IACN,IAAI;IACJ,OAAO;IACP,UAAU;IACV,OAAO;IACP,cAAc;IACd,SAAS;IACT,SAAS;IACT,oBAAoB;IACpB,OAAO;IACP,KAAK;CACG,CAAC;AAmJX,SAAS,SAAS,CAAI,KAAQ;IAC5B,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAM,CAAC;AAChD,CAAC;AAED,SAAS,2BAA2B,CAAC,QAA6B;IAChE,MAAM,SAAS,GAAG,2BAA2B,CAC3C,QAAQ,EACR,YAAY,EACZ,WAAW,CAAC,aAAa,CACP,CAAC;IACrB,QAAQ,SAAS,EAAE,CAAC;QAClB,KAAK,QAAQ;YACX,OAAO;gBACL,SAAS;gBACT,aAAa,EAAG,QAAQ,CAAC,uBAAuB,CAA+B,IAAI,IAAI;aACxF,CAAC;QACJ,KAAK,UAAU;YACb,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAG,QAAQ,CAAC,UAAU,CAA+B,IAAI,IAAI,EAAE,CAAC;QAC9F,KAAK,QAAQ,CAAC;QACd,KAAK,OAAO,CAAC,CAAC,CAAC;YACb,MAAM,OAAO,GAAG,QAAQ,CAAC,cAAc,CAAC,CAAC;YACzC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,MAAM,KAAK,QAAQ,CAAC,EAAE,CAAC;gBACtF,MAAM,IAAI,SAAS,CAAC,gEAAgE,CAAC,CAAC;YACxF,CAAC;YACD,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAChC,CAAC;QACD,KAAK,IAAI;YACP,OAAO;gBACL,SAAS;gBACT,kBAAkB,EAAG,QAAQ,CAAC,cAAc,CAA+B,IAAI,IAAI;gBACnF,aAAa,EACV,QAAQ,CAAC,eAAe,CAAyD,IAAI,IAAI;aAC7F,CAAC;QACJ,KAAK,oBAAoB;YACvB,OAAO;gBACL,SAAS;gBACT,sBAAsB,EAAE,2BAA2B,CACjD,QAAQ,EACR,mBAAmB,EACnB,WAAW,CAAC,aAAa,CAC1B;aACF,CAAC;QACJ;YACE,IAAI,CAAE,kBAAwC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACnE,MAAM,IAAI,SAAS,CAAC,2CAA2C,SAAS,EAAE,CAAC,CAAC;YAC9E,CAAC;YACD,OAAO,EAAE,SAAS,EAAE,CAAC;IACzB,CAAC;AACH,CAAC;AAED,4DAA4D;AAC5D,MAAM,OAAO,WAAW;IAGtB,MAAM,CAAC,oBAAoB,CAAC,aAAqB;QAC/C,OAAO,EAAE,IAAI,EAAE,WAAW,CAAC,aAAa,EAAE,OAAO,EAAE,aAAa,EAAE,CAAC;IACrE,CAAC;IAKD,YAAY,KAAoB,EAAE,KAAqC;QACrE,MAAM,YAAY,GAAG,KAOpB,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,kDAAkD,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,KAAK,CAAC,YAAY,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,yBAAyB,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK;gBACzF,6BAA6B,KAAK,CAAC,YAAY,IAAI,CACtD,CAAC;QACJ,CAAC;QACD,IAAI,YAAY,CAAC,oBAAoB,IAAI,IAAI,IAAI,YAAY,CAAC,gBAAgB,KAAK,WAAW,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,CAAC,OAAO,2CAA2C,CAAC,CAAC;QACrG,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;YACtC,IACE,YAAY,CAAC,6BAA6B,IAAI,IAAI;gBAClD,YAAY,CAAC,eAAe,IAAI,IAAI;gBACpC,YAAY,CAAC,gBAAgB,IAAI,IAAI;gBACrC,YAAY,CAAC,iBAAiB,IAAI,IAAI,EACtC,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0BAA0B,KAAK,CAAC,OAAO,4CAA4C;oBACjF,2DAA2D,CAC9D,CAAC;YACJ,CAAC;YACD,IACE,YAAY,CAAC,eAAe,KAAK,YAAY;gBAC7C,CAAC,YAAY,CAAC,6BAA6B,KAAK,yBAAyB;oBACvE,YAAY,CAAC,6BAA6B,KAAK,2BAA2B,CAAC,EAC7E,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0BAA0B,KAAK,CAAC,OAAO,qDAAqD;oBAC1F,oCAAoC,CACvC,CAAC;YACJ,CAAC;YACD,IACE,YAAY,CAAC,aAAa,KAAK,YAAY;gBAC3C,CAAC,YAAY,CAAC,eAAe,KAAK,cAAc,IAAI,YAAY,CAAC,gBAAgB,KAAK,cAAc,CAAC,EACrG,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,qCAAqC,KAAK,CAAC,OAAO,kDAAkD,CACrG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG;YACX,GAAG,KAAK;YACR,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;SACF,CAAC;QACpC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,gBAAwB,EACxB,UAA0C,EAAE;QAE5C,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAC/E,CAAC;IAED,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,CAC3B,KAAoB,EACpB,SAA8B,EAC9B,OAA2B;QAE3B,MAAM,QAAQ,GAAG,2BAA2B,CAAC,SAAS,EAAE,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;QAChG,MAAM,YAAY,GAAG,SAAS,CAAC,eAAe,CAA2C,CAAC;QAC1F,MAAM,OAAO,GAAG,SAAS,CAAC,wBAAwB,CAAC,CAAC;QACpD,MAAM,iBAAiB,GACrB,SAAS,CAAC,qBAAqB,CAAC,IAAI,IAAI,CAAC,CAAC;YACxC,IAAI;YACN,CAAC,CAAC,2BAA2B,CAAC,SAAS,EAAE,qBAAqB,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;QAC7F,MAAM,MAAM,GAAG;YACb,OAAO,EAAE,2BAA2B,CAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,aAAa,CAAC;YACpF,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC;YAC/E,OAAO;YACP,YAAY,EAAE,2BAA2B,CAAC,SAAS,EAAE,gBAAgB,EAAE,WAAW,CAAC,aAAa,CAAC;YACjG,OAAO,EAAE,2BAA2B,CAClC,SAAS,EACT,UAAU,EACV,WAAW,CAAC,aAAa,CACJ;YACvB,QAAQ,EAAE,2BAA2B,CAAC,QAAQ,CAAC;YAC/C,6BAA6B,EAC1B,SAAS,CAAC,iCAAiC,CAG9B,IAAI,IAAI;YACxB,eAAe,EAAG,SAAS,CAAC,mBAAmB,CAA8C,IAAI,IAAI;YACrG,gBAAgB,EACb,SAAS,CAAC,oBAAoB,CAA+C,IAAI,IAAI;YACxF,iBAAiB;YACjB,WAAW,EAAG,SAAS,CAAC,aAAa,CAA+B,IAAI,IAAI;YAC5E,YAAY,EAAG,SAAS,CAAC,eAAe,CAA+B,IAAI,IAAI;SAChF,CAAC;QACF,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;YAChC,IAAI,MAAM,CAAC,gBAAgB,IAAI,IAAI,IAAI,MAAM,CAAC,gBAAgB,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;YACvF,CAAC;YACD,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;gBAC5B,GAAG,MAAM;gBACT,gBAAgB,EAAE,WAAW;gBAC7B,oBAAoB,EAAE,OAAO;gBAC7B,aAAa,EAAE,IAAI;gBACnB,QAAQ,EAAE,IAAI;gBACd,GAAG,EAAE,IAAI;gBACT,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,mBAAmB,GAAG,YAAY,EAAE,CAAC,wBAAwB,CAAC,CAAC;QACrE,MAAM,kBAAkB,GAAG,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;YAC5B,GAAG,MAAM;YACT,oBAAoB,EAAE,IAAI;YAC1B,aAAa,EAAG,SAAS,CAAC,gBAAgB,CAAoD,IAAI,IAAI;YACtG,QAAQ,EAAG,SAAS,CAAC,UAAU,CAAgC,IAAI,IAAI;YACvE,GAAG,EAAG,SAAS,CAAC,KAAK,CAA+B,IAAI,IAAI;YAC5D,YAAY,EACV,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,mBAAmB,EAAE;gBACvF,CAAC,CAAC,OAAO,kBAAkB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE;oBACxE,CAAC,CAAC,IAAI;SACT,CAAC,CAAC;IACL,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IACjC,CAAC;IAED,MAAM;QACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACrC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QAC7C,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,aAAa;YAC/B,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE;YAC1C,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACvC,SAAS,EAAE;gBACT,IAAI,EAAE,WAAW,CAAC,aAAa;gBAC/B,UAAU,EAAE,QAAQ,CAAC,SAAS;gBAC9B,YAAY,EAAE,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;gBAClE,QAAQ,EAAE,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBACnE,qBAAqB,EAAE,eAAe,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAC1F,YAAY,EAAE,oBAAoB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAC3F,aAAa,EAAE,eAAe,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAClF,iBAAiB,EAAE,wBAAwB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI;aACjG;YACD,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC5B,+BAA+B,EAAE,IAAI,CAAC,KAAK,CAAC,6BAA6B,IAAI,IAAI;YACjF,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI;YACrD,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI;YACvD,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI;YAChD,mBAAmB,EAAE,IAAI,CAAC,KAAK,CAAC,iBAAiB,IAAI,IAAI;YACzD,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,IAAI,IAAI;YAC3C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI;YACrC,GAAG,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,IAAI,IAAI;YAC3B,sBAAsB,EAAE,IAAI,CAAC,KAAK,CAAC,oBAAoB,IAAI,IAAI;YAC/D,aAAa,EACX,YAAY,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC5B;gBACE,IAAI,EAAE,WAAW,CAAC,aAAa;gBAC/B,KAAK,EAAE,OAAO,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI;gBAC1D,sBAAsB,EACpB,sBAAsB,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,CAAC,IAAI;aACpF,CACF;YACH,aAAa,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI;SAC/C,CAAC;IACJ,CAAC;;AAlMe,yBAAa,GAAG,iBAA0B,CAAC"}

package/lib/manifest/custom-object-action.d.mts

@@ -0,0 +1,45 @@
+import type { CustomObject } from "./custom-object.mjs";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion } from "./manifest-builder.mjs";
+import type { ManifestFunction } from "./manifest-function.mjs";
+export type CustomObjectActionVisibilityPreference = 'LIST_VIEW' | 'DETAIL_VIEW';
+export interface CustomObjectActionDeletionIdentifier {
+    actionId: string;
+    objectRqlName: string;
+}
+export interface CustomObjectActionProps {
+    /** Stable identifier for this action. Auto-generated when omitted. */
+    actionId?: string;
+    /** Display name shown in the list or detail view. */
+    name: string;
+    /** Function invoked by the action. */
+    function: ManifestFunction;
+    /** Views where the action is shown. */
+    visibilityPreferences: CustomObjectActionVisibilityPreference[];
+}
+export interface CustomObjectActionLoadFromExistingOptions extends ExistingManifestContextOptions {
+    customObjectApiName?: string;
+}
+/** Defines an action shown on a custom object's list or detail view. */
+export declare class CustomObjectAction {
+    static readonly componentType: "CUSTOM_OBJECT_ACTION";
+    static toDeletionIdentifier(identifier: CustomObjectActionDeletionIdentifier): ManifestComponentDeletion;
+    private readonly _actionId;
+    private readonly _objectRqlName;
+    private _name;
+    private _functionApiName;
+    private _visibilityPreferences;
+    constructor(customObject: CustomObject, props: CustomObjectActionProps);
+    static loadFromExisting(actionId: string, options?: CustomObjectActionLoadFromExistingOptions): CustomObjectAction;
+    /** @internal Hydrates an action from existing manifest wire JSON. */
+    static _fromExistingComponent(customObject: CustomObject, component: Record<string, any>, resolveFunction: (apiName: string) => ManifestFunction): CustomObjectAction;
+    getActionId(): string;
+    /** Replaces the action's display name. */
+    setName(name: string): this;
+    /** Replaces the function invoked by this action. */
+    setFunction(fn: ManifestFunction): this;
+    /** Replaces the views where this action is shown. */
+    setVisibilityPreferences(preferences: CustomObjectActionVisibilityPreference[]): this;
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object-action.d.mts.map

package/lib/manifest/custom-object-action.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-action.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-action.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAAwB;AACpD,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,+BAA2B;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,gCAA4B;AAG5D,MAAM,MAAM,sCAAsC,GAAG,WAAW,GAAG,aAAa,CAAC;AAEjF,MAAM,WAAW,oCAAoC;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,uCAAuC;IACvC,qBAAqB,EAAE,sCAAsC,EAAE,CAAC;CACjE;AAED,MAAM,WAAW,yCAA0C,SAAQ,8BAA8B;IAC/F,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,wEAAwE;AACxE,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,sBAAsB,CAAU;IAEhE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,oCAAoC,GAAG,yBAAyB;IAQxG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,sBAAsB,CAA2C;gBAE7D,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,uBAAuB;IAUtE,MAAM,CAAC,gBAAgB,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,yCAA8C,GACtD,kBAAkB;IAIrB,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAC3B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,kBAAkB;IAerB,WAAW,IAAI,MAAM;IAIrB,0CAA0C;IAC1C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAM3B,oDAAoD;IACpD,WAAW,CAAC,EAAE,EAAE,gBAAgB,GAAG,IAAI;IAKvC,qDAAqD;IACrD,wBAAwB,CAAC,WAAW,EAAE,sCAAsC,EAAE,GAAG,IAAI;IAKrF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAW9B"}

package/lib/manifest/custom-object-action.d.ts

@@ -0,0 +1,45 @@
+import type { CustomObject } from "./custom-object.js";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion } from "./manifest-builder.js";
+import type { ManifestFunction } from "./manifest-function.js";
+export type CustomObjectActionVisibilityPreference = 'LIST_VIEW' | 'DETAIL_VIEW';
+export interface CustomObjectActionDeletionIdentifier {
+    actionId: string;
+    objectRqlName: string;
+}
+export interface CustomObjectActionProps {
+    /** Stable identifier for this action. Auto-generated when omitted. */
+    actionId?: string;
+    /** Display name shown in the list or detail view. */
+    name: string;
+    /** Function invoked by the action. */
+    function: ManifestFunction;
+    /** Views where the action is shown. */
+    visibilityPreferences: CustomObjectActionVisibilityPreference[];
+}
+export interface CustomObjectActionLoadFromExistingOptions extends ExistingManifestContextOptions {
+    customObjectApiName?: string;
+}
+/** Defines an action shown on a custom object's list or detail view. */
+export declare class CustomObjectAction {
+    static readonly componentType: "CUSTOM_OBJECT_ACTION";
+    static toDeletionIdentifier(identifier: CustomObjectActionDeletionIdentifier): ManifestComponentDeletion;
+    private readonly _actionId;
+    private readonly _objectRqlName;
+    private _name;
+    private _functionApiName;
+    private _visibilityPreferences;
+    constructor(customObject: CustomObject, props: CustomObjectActionProps);
+    static loadFromExisting(actionId: string, options?: CustomObjectActionLoadFromExistingOptions): CustomObjectAction;
+    /** @internal Hydrates an action from existing manifest wire JSON. */
+    static _fromExistingComponent(customObject: CustomObject, component: Record<string, any>, resolveFunction: (apiName: string) => ManifestFunction): CustomObjectAction;
+    getActionId(): string;
+    /** Replaces the action's display name. */
+    setName(name: string): this;
+    /** Replaces the function invoked by this action. */
+    setFunction(fn: ManifestFunction): this;
+    /** Replaces the views where this action is shown. */
+    setVisibilityPreferences(preferences: CustomObjectActionVisibilityPreference[]): this;
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object-action.d.ts.map

package/lib/manifest/custom-object-action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-action.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-action.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,2BAAwB;AACpD,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,8BAA2B;AACpE,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA4B;AAG5D,MAAM,MAAM,sCAAsC,GAAG,WAAW,GAAG,aAAa,CAAC;AAEjF,MAAM,WAAW,oCAAoC;IACnD,QAAQ,EAAE,MAAM,CAAC;IACjB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,sEAAsE;IACtE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,sCAAsC;IACtC,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,uCAAuC;IACvC,qBAAqB,EAAE,sCAAsC,EAAE,CAAC;CACjE;AAED,MAAM,WAAW,yCAA0C,SAAQ,8BAA8B;IAC/F,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,wEAAwE;AACxE,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,sBAAsB,CAAU;IAEhE,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,oCAAoC,GAAG,yBAAyB;IAQxG,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,gBAAgB,CAAS;IACjC,OAAO,CAAC,sBAAsB,CAA2C;gBAE7D,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,uBAAuB;IAUtE,MAAM,CAAC,gBAAgB,CACrB,QAAQ,EAAE,MAAM,EAChB,OAAO,GAAE,yCAA8C,GACtD,kBAAkB;IAIrB,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAC3B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,eAAe,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,gBAAgB,GACrD,kBAAkB;IAerB,WAAW,IAAI,MAAM;IAIrB,0CAA0C;IAC1C,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAM3B,oDAAoD;IACpD,WAAW,CAAC,EAAE,EAAE,gBAAgB,GAAG,IAAI;IAKvC,qDAAqD;IACrD,wBAAwB,CAAC,WAAW,EAAE,sCAAsC,EAAE,GAAG,IAAI;IAKrF,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAW9B"}

package/lib/manifest/custom-object-action.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomObjectAction = void 0;
+const _helpers_1 = require("./_helpers.js");
+const existing_manifest_context_1 = require("./existing-manifest-context.js");
+const _existing_component_fields_1 = require("./_existing-component-fields.js");
+/** Defines an action shown on a custom object's list or detail view. */
+class CustomObjectAction {
+    static toDeletionIdentifier(identifier) {
+        return {
+            type: CustomObjectAction.componentType,
+            action_id: identifier.actionId,
+            object_rql_name: identifier.objectRqlName,
+        };
+    }
+    constructor(customObject, props) {
+        if (!props.name.trim())
+            throw new Error('CustomObjectAction: name cannot be empty');
+        this._actionId = props.actionId ?? (0, _helpers_1.generateId)('action');
+        this._objectRqlName = customObject.getApiName();
+        this._name = props.name;
+        this._functionApiName = props.function.getApiName();
+        this._visibilityPreferences = [...props.visibilityPreferences];
+        customObject._register(this);
+    }
+    static loadFromExisting(actionId, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadCustomObjectAction(actionId, options);
+    }
+    /** @internal Hydrates an action from existing manifest wire JSON. */
+    static _fromExistingComponent(customObject, component, resolveFunction) {
+        return new CustomObjectAction(customObject, {
+            actionId: (0, _existing_component_fields_1.requireStringComponentField)(component, 'action_id', CustomObjectAction.componentType),
+            name: (0, _existing_component_fields_1.requireStringComponentField)(component, 'name', CustomObjectAction.componentType),
+            function: resolveFunction((0, _existing_component_fields_1.requireStringComponentField)(component, 'function_api_name', CustomObjectAction.componentType)),
+            visibilityPreferences: (0, _existing_component_fields_1.requireArrayComponentField)(component, 'visibility_preferences', CustomObjectAction.componentType),
+        });
+    }
+    getActionId() {
+        return this._actionId;
+    }
+    /** Replaces the action's display name. */
+    setName(name) {
+        if (!name.trim())
+            throw new Error('CustomObjectAction: name cannot be empty');
+        this._name = name;
+        return this;
+    }
+    /** Replaces the function invoked by this action. */
+    setFunction(fn) {
+        this._functionApiName = fn.getApiName();
+        return this;
+    }
+    /** Replaces the views where this action is shown. */
+    setVisibilityPreferences(preferences) {
+        this._visibilityPreferences = [...preferences];
+        return this;
+    }
+    toDict() {
+        return {
+            type: CustomObjectAction.componentType,
+            action_id: this._actionId,
+            object_rql_name: this._objectRqlName,
+            name: this._name,
+            function_api_name: this._functionApiName,
+            object_type: 'CUSTOM',
+            visibility_preferences: this._visibilityPreferences,
+        };
+    }
+}
+exports.CustomObjectAction = CustomObjectAction;
+CustomObjectAction.componentType = 'CUSTOM_OBJECT_ACTION';
+//# sourceMappingURL=custom-object-action.js.map

package/lib/manifest/custom-object-action.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-action.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-action.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AAExC,8EAA8G;AAG9G,gFAAuG;AAwBvG,wEAAwE;AACxE,MAAa,kBAAkB;IAG7B,MAAM,CAAC,oBAAoB,CAAC,UAAgD;QAC1E,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,SAAS,EAAE,UAAU,CAAC,QAAQ;YAC9B,eAAe,EAAE,UAAU,CAAC,aAAa;SAC1C,CAAC;IACJ,CAAC;IAQD,YAAY,YAA0B,EAAE,KAA8B;QACpE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACpF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,IAAA,qBAAU,EAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACpD,IAAI,CAAC,sBAAsB,GAAG,CAAC,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC/D,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,QAAgB,EAChB,UAAqD,EAAE;QAEvD,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAC3B,YAA0B,EAC1B,SAA8B,EAC9B,eAAsD;QAEtD,OAAO,IAAI,kBAAkB,CAAC,YAAY,EAAE;YAC1C,QAAQ,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,WAAW,EAAE,kBAAkB,CAAC,aAAa,CAAC;YAC/F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,aAAa,CAAC;YACtF,QAAQ,EAAE,eAAe,CACvB,IAAA,wDAA2B,EAAC,SAAS,EAAE,mBAAmB,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAC9F;YACD,qBAAqB,EAAE,IAAA,uDAA0B,EAC/C,SAAS,EACT,wBAAwB,EACxB,kBAAkB,CAAC,aAAa,CACjC;SACF,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,0CAA0C;IAC1C,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9E,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oDAAoD;IACpD,WAAW,CAAC,EAAoB;QAC9B,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD,wBAAwB,CAAC,WAAqD;QAC5E,IAAI,CAAC,sBAAsB,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,cAAc;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,QAAQ;YACrB,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;SACpD,CAAC;IACJ,CAAC;;AAvFH,gDAwFC;AAvFiB,gCAAa,GAAG,sBAA+B,CAAC"}

package/lib/manifest/custom-object-action.mjs

@@ -0,0 +1,68 @@
+import { generateId } from "./_helpers.mjs";
+import { getExistingManifestContext } from "./existing-manifest-context.mjs";
+import { requireArrayComponentField, requireStringComponentField } from "./_existing-component-fields.mjs";
+/** Defines an action shown on a custom object's list or detail view. */
+export class CustomObjectAction {
+    static toDeletionIdentifier(identifier) {
+        return {
+            type: CustomObjectAction.componentType,
+            action_id: identifier.actionId,
+            object_rql_name: identifier.objectRqlName,
+        };
+    }
+    constructor(customObject, props) {
+        if (!props.name.trim())
+            throw new Error('CustomObjectAction: name cannot be empty');
+        this._actionId = props.actionId ?? generateId('action');
+        this._objectRqlName = customObject.getApiName();
+        this._name = props.name;
+        this._functionApiName = props.function.getApiName();
+        this._visibilityPreferences = [...props.visibilityPreferences];
+        customObject._register(this);
+    }
+    static loadFromExisting(actionId, options = {}) {
+        return getExistingManifestContext(options).loadCustomObjectAction(actionId, options);
+    }
+    /** @internal Hydrates an action from existing manifest wire JSON. */
+    static _fromExistingComponent(customObject, component, resolveFunction) {
+        return new CustomObjectAction(customObject, {
+            actionId: requireStringComponentField(component, 'action_id', CustomObjectAction.componentType),
+            name: requireStringComponentField(component, 'name', CustomObjectAction.componentType),
+            function: resolveFunction(requireStringComponentField(component, 'function_api_name', CustomObjectAction.componentType)),
+            visibilityPreferences: requireArrayComponentField(component, 'visibility_preferences', CustomObjectAction.componentType),
+        });
+    }
+    getActionId() {
+        return this._actionId;
+    }
+    /** Replaces the action's display name. */
+    setName(name) {
+        if (!name.trim())
+            throw new Error('CustomObjectAction: name cannot be empty');
+        this._name = name;
+        return this;
+    }
+    /** Replaces the function invoked by this action. */
+    setFunction(fn) {
+        this._functionApiName = fn.getApiName();
+        return this;
+    }
+    /** Replaces the views where this action is shown. */
+    setVisibilityPreferences(preferences) {
+        this._visibilityPreferences = [...preferences];
+        return this;
+    }
+    toDict() {
+        return {
+            type: CustomObjectAction.componentType,
+            action_id: this._actionId,
+            object_rql_name: this._objectRqlName,
+            name: this._name,
+            function_api_name: this._functionApiName,
+            object_type: 'CUSTOM',
+            visibility_preferences: this._visibilityPreferences,
+        };
+    }
+}
+CustomObjectAction.componentType = 'CUSTOM_OBJECT_ACTION';
+//# sourceMappingURL=custom-object-action.mjs.map

package/lib/manifest/custom-object-action.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-action.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,uBAAmB;AAExC,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAG9G,OAAO,EAAE,0BAA0B,EAAE,2BAA2B,EAAE,yCAAqC;AAwBvG,wEAAwE;AACxE,MAAM,OAAO,kBAAkB;IAG7B,MAAM,CAAC,oBAAoB,CAAC,UAAgD;QAC1E,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,SAAS,EAAE,UAAU,CAAC,QAAQ;YAC9B,eAAe,EAAE,UAAU,CAAC,aAAa;SAC1C,CAAC;IACJ,CAAC;IAQD,YAAY,YAA0B,EAAE,KAA8B;QACpE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QACpF,IAAI,CAAC,SAAS,GAAG,KAAK,CAAC,QAAQ,IAAI,UAAU,CAAC,QAAQ,CAAC,CAAC;QACxD,IAAI,CAAC,cAAc,GAAG,YAAY,CAAC,UAAU,EAAE,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,gBAAgB,GAAG,KAAK,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC;QACpD,IAAI,CAAC,sBAAsB,GAAG,CAAC,GAAG,KAAK,CAAC,qBAAqB,CAAC,CAAC;QAC/D,YAAY,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC/B,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,QAAgB,EAChB,UAAqD,EAAE;QAEvD,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IACvF,CAAC;IAED,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAC3B,YAA0B,EAC1B,SAA8B,EAC9B,eAAsD;QAEtD,OAAO,IAAI,kBAAkB,CAAC,YAAY,EAAE;YAC1C,QAAQ,EAAE,2BAA2B,CAAC,SAAS,EAAE,WAAW,EAAE,kBAAkB,CAAC,aAAa,CAAC;YAC/F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,aAAa,CAAC;YACtF,QAAQ,EAAE,eAAe,CACvB,2BAA2B,CAAC,SAAS,EAAE,mBAAmB,EAAE,kBAAkB,CAAC,aAAa,CAAC,CAC9F;YACD,qBAAqB,EAAE,0BAA0B,CAC/C,SAAS,EACT,wBAAwB,EACxB,kBAAkB,CAAC,aAAa,CACjC;SACF,CAAC,CAAC;IACL,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,0CAA0C;IAC1C,OAAO,CAAC,IAAY;QAClB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9E,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAClB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,oDAAoD;IACpD,WAAW,CAAC,EAAoB;QAC9B,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAC,UAAU,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,qDAAqD;IACrD,wBAAwB,CAAC,WAAqD;QAC5E,IAAI,CAAC,sBAAsB,GAAG,CAAC,GAAG,WAAW,CAAC,CAAC;QAC/C,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,cAAc;YACpC,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,iBAAiB,EAAE,IAAI,CAAC,gBAAgB;YACxC,WAAW,EAAE,QAAQ;YACrB,sBAAsB,EAAE,IAAI,CAAC,sBAAsB;SACpD,CAAC;IACJ,CAAC;;AAtFe,gCAAa,GAAG,sBAA+B,CAAC"}

package/lib/manifest/custom-object-field-section.d.mts

@@ -0,0 +1,88 @@
+import type { CustomObject } from "./custom-object.mjs";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion } from "./manifest-builder.mjs";
+export interface CustomObjectFieldSectionLoadFromExistingOptions extends ExistingManifestContextOptions {
+    customObjectApiName?: string;
+}
+/**
+ * Initialization properties for {@link CustomObjectFieldSection}.
+ */
+export interface CustomObjectFieldSectionProps {
+    /**
+     * Display name of the section shown as a group header on the detail page
+     * (e.g. `'Profile'`, `'Membership'`).
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Stable identifier for this section. Pass a human-readable slug
+     * (e.g. `'sec_gm_profile'`) to keep it stable across manifest regenerations.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('sec')
+     */
+    sectionId?: string;
+}
+/**
+ * Defines a field section and registers it with the manifest.
+ *
+ * A field section is a named group of fields displayed together on a custom
+ * object's detail page. Every custom field must receive one of these sections
+ * through its `section` prop.
+ *
+ * @example
+ * ```ts
+ * const profileSection = new CustomObjectFieldSection(memberObj, {
+ *   name: 'Profile',
+ *   sectionId: 'sec_gm_profile',
+ * });
+ *
+ * const firstName = new TextField(memberObj, {
+ *   apiName: 'first_name__c',
+ *   displayName: 'First name',
+ *   section: profileSection,
+ * });
+ * ```
+ *
+ * @see {@link CustomObjectPageLayout} — controls which sections appear on which tab.
+ */
+export declare class CustomObjectFieldSection {
+    static readonly componentType: "CUSTOM_OBJECT_FIELD_SECTION";
+    static toDeletionIdentifier(sectionId: string): ManifestComponentDeletion;
+    private readonly _sectionId;
+    private readonly _name;
+    private readonly _model;
+    /**
+     * @param customObject - The custom object this section belongs to.
+     * @param props - Initialization properties.
+     */
+    constructor(customObject: CustomObject, props: CustomObjectFieldSectionProps);
+    /**
+     * Loads this field section from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(sectionId: string, options?: CustomObjectFieldSectionLoadFromExistingOptions): CustomObjectFieldSection;
+    /** @internal Hydrates a field section from existing manifest wire JSON. */
+    static _fromExistingComponent(customObject: CustomObject, component: Record<string, any>): CustomObjectFieldSection;
+    /**
+     * Returns the stable identifier for this section (e.g. `'sec_gm_profile'`).
+     *
+     * Use this value in page layout field entries via `getSectionId()`, or pass
+     * the section instance directly to field `section` props.
+     */
+    getSectionId(): string;
+    /**
+     * Returns the display name of this field section.
+     */
+    getName(): string;
+    /**
+     * Returns the api_name of the custom object this section belongs to.
+     */
+    getModelApiName(): string;
+    /**
+     * Serializes this section to the wire format consumed by the manifest install endpoint.
+     *
+     * @returns A plain object with `type: 'CUSTOM_OBJECT_FIELD_SECTION'`.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-object-field-section.d.mts.map

package/lib/manifest/custom-object-field-section.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-object-field-section.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-object-field-section.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,4BAAwB;AACpD,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,+BAA2B;AAGpE,MAAM,WAAW,+CAAgD,SAAQ,8BAA8B;IACrG,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC5C;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,wBAAwB;IACnC,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,6BAA6B,CAAU;IAEvE,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB;IAOzE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAe;IAEtC;;;OAGG;gBACS,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,6BAA6B;IAO5E;;OAEG;IACH,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,+CAAoD,GAC5D,wBAAwB;IAI3B,2EAA2E;IAC3E,MAAM,CAAC,sBAAsB,CAC3B,YAAY,EAAE,YAAY,EAC1B,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAC7B,wBAAwB;IAO3B;;;;;OAKG;IACH,YAAY,IAAI,MAAM;IAItB;;OAEG;IACH,OAAO,IAAI,MAAM;IAIjB;;OAEG;IACH,eAAe,IAAI,MAAM;IAIzB;;;;OAIG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAQ9B"}