@rippling/rippling-sdk 0.2.0-alpha.85 → 0.2.0-alpha.87

package/core/platform/custom-objects/fields.d.mts

@@ -0,0 +1,302 @@
+import type { CustomObjectFieldDerivedAggregatedField, CustomObjectFieldFormulaAttrMetas, CustomObjectFieldRqlDefinition, CustomObjectFieldSection as RestCustomObjectFieldSection } from "../../../resources/custom-objects/fields.mjs";
+import type { AnyCustomObjectDefinition, BooleanFieldDefinition, CurrencyFieldDefinition, CustomObjectIdentity, DateFieldDefinition, DatetimeFieldDefinition, EmailFieldDefinition, FileFieldDefinition, FormulaFieldDefinition, LongTextFieldDefinition, LookupFieldDefinition, LookupTarget, NativeModelTarget, NumberFieldDefinition, ParentChildFieldDefinition, PercentageFieldDefinition, PhoneFieldDefinition, RadioFieldDefinition, SectionDefinition, SelectFieldDefinition, TextFieldDefinition, TimeFieldDefinition, UrlFieldDefinition } from "./types.mjs";
+/**
+ * Internal helper for field factories that expose `required` and `section`.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface BooleanLikeProps<TRequired extends boolean, TSectionKey extends string | undefined> {
+    readonly required?: TRequired;
+    readonly section?: TSectionKey;
+}
+/**
+ * Internal helper for choice-based field factories.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface ChoiceProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
+    readonly options: readonly string[];
+}
+/**
+ * Internal helper for numeric field factories that support decimal-place metadata.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface NumericProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
+    readonly decimalPlaces?: number;
+}
+/**
+ * Internal presentation properties shared by every field factory.
+ *
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface CommonFieldProps<TSectionKey extends string | undefined> {
+    readonly displayName: string;
+    readonly description: string;
+    readonly section?: TSectionKey;
+    readonly enableHistory?: boolean;
+    readonly formulaAttributeMetas?: CustomObjectFieldFormulaAttrMetas;
+    readonly derivedAggregatedField?: CustomObjectFieldDerivedAggregatedField;
+    readonly rqlDefinition?: CustomObjectFieldRqlDefinition;
+    readonly restSection?: RestCustomObjectFieldSection;
+}
+/**
+ * Declares a native Rippling model target for lookup fields.
+ *
+ * @param apiName - Native model API name, for example `'Employee'`.
+ * @returns Immutable native-model target descriptor for lookup fields.
+ * @typeParam TApiName - Native model api name, for example `'Employee'`.
+ */
+export declare function nativeModel<TApiName extends string>(apiName: TApiName): NativeModelTarget<TApiName>;
+/**
+ * Defines a single-line text field.
+ *
+ * @param props - Text-field metadata and presentation properties.
+ * @returns Immutable text field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function text<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+    readonly maxLength?: number;
+}): TextFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a multi-line text field.
+ *
+ * @param props - Long-text field metadata and presentation properties.
+ * @returns Immutable long-text field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function longText<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly maxLength?: number;
+}): LongTextFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines an email-address field.
+ *
+ * @param props - Email-field metadata and presentation properties.
+ * @returns Immutable email field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function email<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+}): EmailFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a URL field.
+ *
+ * @param props - URL-field metadata and presentation properties.
+ * @returns Immutable URL field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function url<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): UrlFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a phone-number field.
+ *
+ * @param props - Phone-field metadata and presentation properties.
+ * @returns Immutable phone field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function phone<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PhoneFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a numeric field.
+ *
+ * @param props - Number-field metadata and presentation properties.
+ * @returns Immutable number field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function number<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+}): NumberFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a currency field.
+ *
+ * @param props - Currency-field metadata and presentation properties.
+ * @returns Immutable currency field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function currency<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
+    readonly currency?: string;
+}): CurrencyFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a percentage field.
+ *
+ * @param props - Percentage-field metadata and presentation properties.
+ * @returns Immutable percentage field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function percentage<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PercentageFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a date-only field.
+ *
+ * @param props - Date-field metadata and presentation properties.
+ * @returns Immutable date field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function date<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DateFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a date-time field.
+ *
+ * @param props - Datetime-field metadata and presentation properties.
+ * @returns Immutable datetime field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function datetime<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DatetimeFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a time-of-day field.
+ *
+ * @param props - Time-field metadata and presentation properties.
+ * @returns Immutable time field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function time<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): TimeFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a multi-select choice field.
+ *
+ * @param props - Multi-select field metadata and presentation properties.
+ * @returns Immutable multi-select field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function select<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): SelectFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a single-select radio field.
+ *
+ * @param props - Radio-field metadata and presentation properties.
+ * @returns Immutable radio field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function radio<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): RadioFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a boolean field.
+ *
+ * @param props - Boolean-field metadata and presentation properties.
+ * @returns Immutable boolean field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function boolean<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): BooleanFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a file attachment field.
+ *
+ * @param props - File-field metadata and presentation properties.
+ * @returns Immutable file field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function file<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly allowedType: 'images' | 'documents' | 'any';
+}): FileFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a many-to-one lookup field.
+ *
+ * @param target - Target object or native model referenced by the lookup.
+ * @param props - Lookup-field metadata and presentation properties.
+ * @returns Immutable lookup field definition.
+ * @typeParam TTarget - Target object or native model referenced by the lookup.
+ * @typeParam TRequired - Whether the lookup is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function lookup<TTarget extends LookupTarget, TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly relatedDataLabel?: string;
+    readonly lookupFilterRqlCondition?: string;
+}): LookupFieldDefinition<TTarget, TRequired, TSectionKey>;
+/**
+ * Defines a parent-child relationship field.
+ *
+ * @param target - Parent object definition referenced by the relationship.
+ * @param props - Parent-child field metadata and presentation properties.
+ * @returns Immutable parent-child field definition.
+ * @typeParam TTarget - Parent object definition referenced by the relationship.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function parentChild<TTarget extends Pick<AnyCustomObjectDefinition, 'name' | 'apiName'>, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & {
+    readonly relatedDataLabel?: string;
+    readonly parentChildType?: 'PRIMARY' | 'SECONDARY';
+    readonly enableParentOwnerInheritance?: boolean;
+    readonly section?: TSectionKey;
+}): ParentChildFieldDefinition<CustomObjectIdentity<TTarget['name']>, TSectionKey>;
+/** Public helper surface for read-only formula fields. */
+export interface FormulaHelpers {
+    /**
+     * Defines a text-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    text<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+        readonly maxLength: number;
+    }): FormulaFieldDefinition<'formula-text', string, TSectionKey>;
+    /**
+     * Defines a numeric formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    number<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-number', number, TSectionKey>;
+    /**
+     * Defines a boolean formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    boolean<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-boolean', boolean, TSectionKey>;
+    /**
+     * Defines a currency-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    currency<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-currency', number, TSectionKey>;
+    /**
+     * Defines a percentage-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    percentage<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-percentage', number, TSectionKey>;
+    /**
+     * Defines a date-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    date<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-date', string, TSectionKey>;
+    /**
+     * Defines a URL-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    url<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-url', string, TSectionKey>;
+}
+/** Typed helpers for read-only formula fields. */
+export declare const formula: FormulaHelpers;
+/**
+ * Immutable helper for authoring section maps in reusable fragments.
+ *
+ * @param definitions - Section definitions to freeze and preserve as-is.
+ * @returns Frozen section-definition map retaining the caller's key/value types.
+ * @typeParam TSections - Concrete section map to preserve in the returned value.
+ */
+export declare function sections<TSections extends Readonly<Record<string, SectionDefinition>>>(definitions: TSections): TSections;
+export {};
+//# sourceMappingURL=fields.d.mts.map

package/core/platform/custom-objects/fields.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.mts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uCAAuC,EACvC,iCAAiC,EACjC,8BAA8B,EAC9B,wBAAwB,IAAI,4BAA4B,EACzD,qDAAiD;AAClD,OAAO,KAAK,EACV,yBAAyB,EAEzB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAGtB,uBAAuB,EACvB,qBAAqB,EACrB,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EAErB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EACnB,oBAAgB;AAEjB;;;;;GAKG;AACH,UAAU,gBAAgB,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;GAKG;AACH,UAAU,WAAW,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACrF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED;;;;;GAKG;AACH,UAAU,YAAY,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACtF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,UAAU,gBAAgB,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC;IACnE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,uCAAuC,CAAC;IAC1E,QAAQ,CAAC,aAAa,CAAC,EAAE,8BAA8B,CAAC;IACxD,QAAQ,CAAC,WAAW,CAAC,EAAE,4BAA4B,CAAC;CACrD;AAkCD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,SAAS,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE5C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1G,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,yBAAyB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOnD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOhD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAA;CAAE,GACpG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,OAAO,SAAS,YAAY,EAC5B,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IACzC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAC5C,GACF,qBAAqB,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,CASxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC,EACnE,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IACnD,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC,GACA,0BAA0B,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAShF;AA+BD,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAC9F,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,MAAM,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAChE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEjE;;;;OAIG;IACH,OAAO,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACjE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAClE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,UAAU,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACpE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,oBAAoB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,GAAG,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC7D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;CAC/D;AAED,kDAAkD;AAClD,eAAO,MAAM,OAAO,EAAE,cA0CpB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,EACpF,WAAW,EAAE,SAAS,GACrB,SAAS,CAEX"}

package/core/platform/custom-objects/fields.d.ts

@@ -0,0 +1,302 @@
+import type { CustomObjectFieldDerivedAggregatedField, CustomObjectFieldFormulaAttrMetas, CustomObjectFieldRqlDefinition, CustomObjectFieldSection as RestCustomObjectFieldSection } from "../../../resources/custom-objects/fields.js";
+import type { AnyCustomObjectDefinition, BooleanFieldDefinition, CurrencyFieldDefinition, CustomObjectIdentity, DateFieldDefinition, DatetimeFieldDefinition, EmailFieldDefinition, FileFieldDefinition, FormulaFieldDefinition, LongTextFieldDefinition, LookupFieldDefinition, LookupTarget, NativeModelTarget, NumberFieldDefinition, ParentChildFieldDefinition, PercentageFieldDefinition, PhoneFieldDefinition, RadioFieldDefinition, SectionDefinition, SelectFieldDefinition, TextFieldDefinition, TimeFieldDefinition, UrlFieldDefinition } from "./types.js";
+/**
+ * Internal helper for field factories that expose `required` and `section`.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface BooleanLikeProps<TRequired extends boolean, TSectionKey extends string | undefined> {
+    readonly required?: TRequired;
+    readonly section?: TSectionKey;
+}
+/**
+ * Internal helper for choice-based field factories.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface ChoiceProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
+    readonly options: readonly string[];
+}
+/**
+ * Internal helper for numeric field factories that support decimal-place metadata.
+ *
+ * @typeParam TRequired - Literal boolean carried through to derived input types.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface NumericProps<TRequired extends boolean, TSectionKey extends string | undefined> extends BooleanLikeProps<TRequired, TSectionKey> {
+    readonly decimalPlaces?: number;
+}
+/**
+ * Internal presentation properties shared by every field factory.
+ *
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+interface CommonFieldProps<TSectionKey extends string | undefined> {
+    readonly displayName: string;
+    readonly description: string;
+    readonly section?: TSectionKey;
+    readonly enableHistory?: boolean;
+    readonly formulaAttributeMetas?: CustomObjectFieldFormulaAttrMetas;
+    readonly derivedAggregatedField?: CustomObjectFieldDerivedAggregatedField;
+    readonly rqlDefinition?: CustomObjectFieldRqlDefinition;
+    readonly restSection?: RestCustomObjectFieldSection;
+}
+/**
+ * Declares a native Rippling model target for lookup fields.
+ *
+ * @param apiName - Native model API name, for example `'Employee'`.
+ * @returns Immutable native-model target descriptor for lookup fields.
+ * @typeParam TApiName - Native model api name, for example `'Employee'`.
+ */
+export declare function nativeModel<TApiName extends string>(apiName: TApiName): NativeModelTarget<TApiName>;
+/**
+ * Defines a single-line text field.
+ *
+ * @param props - Text-field metadata and presentation properties.
+ * @returns Immutable text field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function text<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+    readonly maxLength?: number;
+}): TextFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a multi-line text field.
+ *
+ * @param props - Long-text field metadata and presentation properties.
+ * @returns Immutable long-text field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function longText<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly maxLength?: number;
+}): LongTextFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines an email-address field.
+ *
+ * @param props - Email-field metadata and presentation properties.
+ * @returns Immutable email field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function email<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+}): EmailFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a URL field.
+ *
+ * @param props - URL-field metadata and presentation properties.
+ * @returns Immutable URL field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function url<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): UrlFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a phone-number field.
+ *
+ * @param props - Phone-field metadata and presentation properties.
+ * @returns Immutable phone field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function phone<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PhoneFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a numeric field.
+ *
+ * @param props - Number-field metadata and presentation properties.
+ * @returns Immutable number field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function number<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
+    readonly unique?: boolean;
+}): NumberFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a currency field.
+ *
+ * @param props - Currency-field metadata and presentation properties.
+ * @returns Immutable currency field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function currency<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & NumericProps<TRequired, TSectionKey> & {
+    readonly currency?: string;
+}): CurrencyFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a percentage field.
+ *
+ * @param props - Percentage-field metadata and presentation properties.
+ * @returns Immutable percentage field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function percentage<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): PercentageFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a date-only field.
+ *
+ * @param props - Date-field metadata and presentation properties.
+ * @returns Immutable date field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function date<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DateFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a date-time field.
+ *
+ * @param props - Datetime-field metadata and presentation properties.
+ * @returns Immutable datetime field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function datetime<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): DatetimeFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a time-of-day field.
+ *
+ * @param props - Time-field metadata and presentation properties.
+ * @returns Immutable time field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function time<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): TimeFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a multi-select choice field.
+ *
+ * @param props - Multi-select field metadata and presentation properties.
+ * @returns Immutable multi-select field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function select<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): SelectFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a single-select radio field.
+ *
+ * @param props - Radio-field metadata and presentation properties.
+ * @returns Immutable radio field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function radio<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & ChoiceProps<TRequired, TSectionKey>): RadioFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a boolean field.
+ *
+ * @param props - Boolean-field metadata and presentation properties.
+ * @returns Immutable boolean field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function boolean<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey>): BooleanFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a file attachment field.
+ *
+ * @param props - File-field metadata and presentation properties.
+ * @returns Immutable file field definition.
+ * @typeParam TRequired - Whether the field is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function file<TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly allowedType: 'images' | 'documents' | 'any';
+}): FileFieldDefinition<TRequired, TSectionKey>;
+/**
+ * Defines a many-to-one lookup field.
+ *
+ * @param target - Target object or native model referenced by the lookup.
+ * @param props - Lookup-field metadata and presentation properties.
+ * @returns Immutable lookup field definition.
+ * @typeParam TTarget - Target object or native model referenced by the lookup.
+ * @typeParam TRequired - Whether the lookup is required during record creation.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function lookup<TTarget extends LookupTarget, TRequired extends boolean = false, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & BooleanLikeProps<TRequired, TSectionKey> & {
+    readonly relatedDataLabel?: string;
+    readonly lookupFilterRqlCondition?: string;
+}): LookupFieldDefinition<TTarget, TRequired, TSectionKey>;
+/**
+ * Defines a parent-child relationship field.
+ *
+ * @param target - Parent object definition referenced by the relationship.
+ * @param props - Parent-child field metadata and presentation properties.
+ * @returns Immutable parent-child field definition.
+ * @typeParam TTarget - Parent object definition referenced by the relationship.
+ * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+ */
+export declare function parentChild<TTarget extends Pick<AnyCustomObjectDefinition, 'name' | 'apiName'>, TSectionKey extends string | undefined = string | undefined>(target: TTarget, props: CommonFieldProps<TSectionKey> & {
+    readonly relatedDataLabel?: string;
+    readonly parentChildType?: 'PRIMARY' | 'SECONDARY';
+    readonly enableParentOwnerInheritance?: boolean;
+    readonly section?: TSectionKey;
+}): ParentChildFieldDefinition<CustomObjectIdentity<TTarget['name']>, TSectionKey>;
+/** Public helper surface for read-only formula fields. */
+export interface FormulaHelpers {
+    /**
+     * Defines a text-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    text<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+        readonly maxLength: number;
+    }): FormulaFieldDefinition<'formula-text', string, TSectionKey>;
+    /**
+     * Defines a numeric formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    number<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-number', number, TSectionKey>;
+    /**
+     * Defines a boolean formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    boolean<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-boolean', boolean, TSectionKey>;
+    /**
+     * Defines a currency-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    currency<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-currency', number, TSectionKey>;
+    /**
+     * Defines a percentage-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    percentage<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-percentage', number, TSectionKey>;
+    /**
+     * Defines a date-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    date<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-date', string, TSectionKey>;
+    /**
+     * Defines a URL-valued formula field.
+     *
+     * @typeParam TSectionKey - Allowed section-key union for the enclosing object.
+     */
+    url<TSectionKey extends string | undefined = string | undefined>(props: CommonFieldProps<TSectionKey> & {
+        readonly formula: string;
+    }): FormulaFieldDefinition<'formula-url', string, TSectionKey>;
+}
+/** Typed helpers for read-only formula fields. */
+export declare const formula: FormulaHelpers;
+/**
+ * Immutable helper for authoring section maps in reusable fragments.
+ *
+ * @param definitions - Section definitions to freeze and preserve as-is.
+ * @returns Frozen section-definition map retaining the caller's key/value types.
+ * @typeParam TSections - Concrete section map to preserve in the returned value.
+ */
+export declare function sections<TSections extends Readonly<Record<string, SectionDefinition>>>(definitions: TSections): TSections;
+export {};
+//# sourceMappingURL=fields.d.ts.map

package/core/platform/custom-objects/fields.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fields.d.ts","sourceRoot":"","sources":["../../../src/core/platform/custom-objects/fields.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uCAAuC,EACvC,iCAAiC,EACjC,8BAA8B,EAC9B,wBAAwB,IAAI,4BAA4B,EACzD,oDAAiD;AAClD,OAAO,KAAK,EACV,yBAAyB,EAEzB,sBAAsB,EACtB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EAGtB,uBAAuB,EACvB,qBAAqB,EACrB,YAAY,EACZ,iBAAiB,EACjB,qBAAqB,EACrB,0BAA0B,EAC1B,yBAAyB,EACzB,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,qBAAqB,EAErB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EACnB,mBAAgB;AAEjB;;;;;GAKG;AACH,UAAU,gBAAgB,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS;IAC1F,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC;IAC9B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC;AAED;;;;;GAKG;AACH,UAAU,WAAW,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACrF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACrC;AAED;;;;;GAKG;AACH,UAAU,YAAY,CAAC,SAAS,SAAS,OAAO,EAAE,WAAW,SAAS,MAAM,GAAG,SAAS,CACtF,SAAQ,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC;IAChD,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;;GAIG;AACH,UAAU,gBAAgB,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS;IAC/D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,aAAa,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,qBAAqB,CAAC,EAAE,iCAAiC,CAAC;IACnE,QAAQ,CAAC,sBAAsB,CAAC,EAAE,uCAAuC,CAAC;IAC1E,QAAQ,CAAC,aAAa,CAAC,EAAE,8BAA8B,CAAC;IACxD,QAAQ,CAAC,WAAW,CAAC,EAAE,4BAA4B,CAAC;CACrD;AAkCD;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,QAAQ,SAAS,MAAM,EAAE,OAAO,EAAE,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAEnG;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GACtG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,GAC3E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,GAAG,CACjB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,kBAAkB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE5C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,CAAA;CAAE,GAC1G,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAAE,GACtE,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,UAAU,CACxB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,yBAAyB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOnD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,QAAQ,CACtB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,uBAAuB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOjD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;GAOG;AACH,wBAAgB,MAAM,CACpB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,qBAAqB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO/C;AAED;;;;;;;GAOG;AACH,wBAAgB,KAAK,CACnB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,SAAS,EAAE,WAAW,CAAC,GACzE,oBAAoB,CAAC,SAAS,EAAE,WAAW,CAAC,CAO9C;AAED;;;;;;;GAOG;AACH,wBAAgB,OAAO,CACrB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAC9E,sBAAsB,CAAC,SAAS,EAAE,WAAW,CAAC,CAOhD;AAED;;;;;;;GAOG;AACH,wBAAgB,IAAI,CAClB,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IAAE,QAAQ,CAAC,WAAW,EAAE,QAAQ,GAAG,WAAW,GAAG,KAAK,CAAA;CAAE,GACpG,mBAAmB,CAAC,SAAS,EAAE,WAAW,CAAC,CAE7C;AAED;;;;;;;;;GASG;AACH,wBAAgB,MAAM,CACpB,OAAO,SAAS,YAAY,EAC5B,SAAS,SAAS,OAAO,GAAG,KAAK,EACjC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAClC,gBAAgB,CAAC,SAAS,EAAE,WAAW,CAAC,GAAG;IACzC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,wBAAwB,CAAC,EAAE,MAAM,CAAC;CAC5C,GACF,qBAAqB,CAAC,OAAO,EAAE,SAAS,EAAE,WAAW,CAAC,CASxD;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CACzB,OAAO,SAAS,IAAI,CAAC,yBAAyB,EAAE,MAAM,GAAG,SAAS,CAAC,EACnE,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAE3D,MAAM,EAAE,OAAO,EACf,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;IACrC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IACnC,QAAQ,CAAC,eAAe,CAAC,EAAE,SAAS,GAAG,WAAW,CAAC;IACnD,QAAQ,CAAC,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAChD,QAAQ,CAAC,OAAO,CAAC,EAAE,WAAW,CAAC;CAChC,GACA,0BAA0B,CAAC,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,WAAW,CAAC,CAShF;AA+BD,0DAA0D;AAC1D,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;KAAE,GAC9F,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,MAAM,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAChE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEjE;;;;OAIG;IACH,OAAO,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACjE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,iBAAiB,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,QAAQ,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAClE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,kBAAkB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAEnE;;;;OAIG;IACH,UAAU,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EACpE,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,oBAAoB,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAErE;;;;OAIG;IACH,IAAI,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC9D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,cAAc,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;IAE/D;;;;OAIG;IACH,GAAG,CAAC,WAAW,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC7D,KAAK,EAAE,gBAAgB,CAAC,WAAW,CAAC,GAAG;QAAE,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAClE,sBAAsB,CAAC,aAAa,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC;CAC/D;AAED,kDAAkD;AAClD,eAAO,MAAM,OAAO,EAAE,cA0CpB,CAAC;AAEH;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,SAAS,SAAS,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,EACpF,WAAW,EAAE,SAAS,GACrB,SAAS,CAEX"}