@rippling/rippling-sdk 0.2.0-alpha.76 → 0.2.0-alpha.77

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

@@ -0,0 +1,30 @@
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
+export interface CustomFieldSectionProps {
+    sectionId?: string;
+    name: string;
+    modelRqlName: string;
+    isRipplingDefined?: boolean;
+    identifierSlug?: string | null;
+    displayOrder?: number | null;
+}
+/** A section that groups Custom Field V2 fields on a native or custom object. */
+export declare class CustomFieldSection {
+    static readonly componentType: "CUSTOM_FIELD_SECTION";
+    static toDeletionIdentifier(sectionId: string): ManifestComponentDeletion;
+    private readonly _sectionId;
+    private readonly _name;
+    private readonly _modelRqlName;
+    private readonly _isRipplingDefined;
+    private readonly _identifierSlug;
+    private readonly _displayOrder;
+    constructor(scope: ManifestScope, props: CustomFieldSectionProps);
+    static loadFromExisting(sectionId: string, options?: ExistingManifestContextOptions): CustomFieldSection;
+    /** @internal Hydrates a section from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): CustomFieldSection;
+    getSectionId(): string;
+    getName(): string;
+    getModelRqlName(): string;
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-field-section.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-section.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-field-section.ts"],"names":[],"mappings":"AACA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAGnF,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,iFAAiF;AACjF,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,sBAAsB,CAAU;IAEhE,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB;IAIzE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;gBAElC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,uBAAuB;IAUhE,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,8BAAmC,GAC3C,kBAAkB;IAIrB,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB;IAevG,YAAY,IAAI,MAAM;IAItB,OAAO,IAAI,MAAM;IAIjB,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAW9B"}

package/lib/manifest/custom-field-section.d.ts

@@ -0,0 +1,30 @@
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
+export interface CustomFieldSectionProps {
+    sectionId?: string;
+    name: string;
+    modelRqlName: string;
+    isRipplingDefined?: boolean;
+    identifierSlug?: string | null;
+    displayOrder?: number | null;
+}
+/** A section that groups Custom Field V2 fields on a native or custom object. */
+export declare class CustomFieldSection {
+    static readonly componentType: "CUSTOM_FIELD_SECTION";
+    static toDeletionIdentifier(sectionId: string): ManifestComponentDeletion;
+    private readonly _sectionId;
+    private readonly _name;
+    private readonly _modelRqlName;
+    private readonly _isRipplingDefined;
+    private readonly _identifierSlug;
+    private readonly _displayOrder;
+    constructor(scope: ManifestScope, props: CustomFieldSectionProps);
+    static loadFromExisting(sectionId: string, options?: ExistingManifestContextOptions): CustomFieldSection;
+    /** @internal Hydrates a section from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): CustomFieldSection;
+    getSectionId(): string;
+    getName(): string;
+    getModelRqlName(): string;
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-field-section.d.ts.map

package/lib/manifest/custom-field-section.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-section.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-field-section.ts"],"names":[],"mappings":"AACA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF,MAAM,WAAW,uBAAuB;IACtC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,iFAAiF;AACjF,qBAAa,kBAAkB;IAC7B,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,sBAAsB,CAAU;IAEhE,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,yBAAyB;IAIzE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAS;IACvC,OAAO,CAAC,QAAQ,CAAC,kBAAkB,CAAU;IAC7C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAgB;IAChD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAgB;gBAElC,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,uBAAuB;IAUhE,MAAM,CAAC,gBAAgB,CACrB,SAAS,EAAE,MAAM,EACjB,OAAO,GAAE,8BAAmC,GAC3C,kBAAkB;IAIrB,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,kBAAkB;IAevG,YAAY,IAAI,MAAM;IAItB,OAAO,IAAI,MAAM;IAIjB,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAW9B"}

package/lib/manifest/custom-field-section.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomFieldSection = 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");
+/** A section that groups Custom Field V2 fields on a native or custom object. */
+class CustomFieldSection {
+    static toDeletionIdentifier(sectionId) {
+        return { type: CustomFieldSection.componentType, section_id: sectionId };
+    }
+    constructor(scope, props) {
+        this._sectionId = props.sectionId ?? (0, _helpers_1.generateId)('cf_section');
+        this._name = props.name;
+        this._modelRqlName = props.modelRqlName;
+        this._isRipplingDefined = props.isRipplingDefined ?? false;
+        this._identifierSlug = props.identifierSlug ?? null;
+        this._displayOrder = props.displayOrder ?? null;
+        scope._register(this);
+    }
+    static loadFromExisting(sectionId, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadCustomFieldSection(sectionId);
+    }
+    /** @internal Hydrates a section from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        return new CustomFieldSection(scope, {
+            sectionId: (0, _existing_component_fields_1.requireStringComponentField)(component, 'obj_id', CustomFieldSection.componentType),
+            name: (0, _existing_component_fields_1.requireStringComponentField)(component, 'name', CustomFieldSection.componentType),
+            modelRqlName: (0, _existing_component_fields_1.requireStringComponentField)(component, 'model_rql_name', CustomFieldSection.componentType),
+            isRipplingDefined: component['is_rippling_defined'] === true,
+            identifierSlug: component['identifier_slug'] ?? null,
+            displayOrder: component['display_order'] ?? null,
+        });
+    }
+    getSectionId() {
+        return this._sectionId;
+    }
+    getName() {
+        return this._name;
+    }
+    getModelRqlName() {
+        return this._modelRqlName;
+    }
+    toDict() {
+        return {
+            type: CustomFieldSection.componentType,
+            obj_id: this._sectionId,
+            name: this._name,
+            is_rippling_defined: this._isRipplingDefined,
+            model_rql_name: this._modelRqlName,
+            identifier_slug: this._identifierSlug,
+            display_order: this._displayOrder,
+        };
+    }
+}
+exports.CustomFieldSection = CustomFieldSection;
+CustomFieldSection.componentType = 'CUSTOM_FIELD_SECTION';
+//# sourceMappingURL=custom-field-section.js.map

package/lib/manifest/custom-field-section.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-section.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-field-section.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AACxC,8EAA8G;AAE9G,gFAA2E;AAW3E,iFAAiF;AACjF,MAAa,kBAAkB;IAG7B,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QAC3C,OAAO,EAAE,IAAI,EAAE,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC3E,CAAC;IASD,YAAY,KAAoB,EAAE,KAA8B;QAC9D,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,IAAI,IAAA,qBAAU,EAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,IAAI,KAAK,CAAC;QAC3D,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC;QAChD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,SAAiB,EACjB,UAA0C,EAAE;QAE5C,OAAO,IAAA,sDAA0B,EAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE;YACnC,SAAS,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,QAAQ,EAAE,kBAAkB,CAAC,aAAa,CAAC;YAC7F,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,aAAa,CAAC;YACtF,YAAY,EAAE,IAAA,wDAA2B,EACvC,SAAS,EACT,gBAAgB,EAChB,kBAAkB,CAAC,aAAa,CACjC;YACD,iBAAiB,EAAE,SAAS,CAAC,qBAAqB,CAAC,KAAK,IAAI;YAC5D,cAAc,EAAG,SAAS,CAAC,iBAAiB,CAA+B,IAAI,IAAI;YACnF,YAAY,EAAG,SAAS,CAAC,eAAe,CAA+B,IAAI,IAAI;SAChF,CAAC,CAAC;IACL,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,MAAM,EAAE,IAAI,CAAC,UAAU;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,mBAAmB,EAAE,IAAI,CAAC,kBAAkB;YAC5C,cAAc,EAAE,IAAI,CAAC,aAAa;YAClC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;;AArEH,gDAsEC;AArEiB,gCAAa,GAAG,sBAA+B,CAAC"}

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

@@ -0,0 +1,54 @@
+import { generateId } from "./_helpers.mjs";
+import { getExistingManifestContext } from "./existing-manifest-context.mjs";
+import { requireStringComponentField } from "./_existing-component-fields.mjs";
+/** A section that groups Custom Field V2 fields on a native or custom object. */
+export class CustomFieldSection {
+    static toDeletionIdentifier(sectionId) {
+        return { type: CustomFieldSection.componentType, section_id: sectionId };
+    }
+    constructor(scope, props) {
+        this._sectionId = props.sectionId ?? generateId('cf_section');
+        this._name = props.name;
+        this._modelRqlName = props.modelRqlName;
+        this._isRipplingDefined = props.isRipplingDefined ?? false;
+        this._identifierSlug = props.identifierSlug ?? null;
+        this._displayOrder = props.displayOrder ?? null;
+        scope._register(this);
+    }
+    static loadFromExisting(sectionId, options = {}) {
+        return getExistingManifestContext(options).loadCustomFieldSection(sectionId);
+    }
+    /** @internal Hydrates a section from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component) {
+        return new CustomFieldSection(scope, {
+            sectionId: requireStringComponentField(component, 'obj_id', CustomFieldSection.componentType),
+            name: requireStringComponentField(component, 'name', CustomFieldSection.componentType),
+            modelRqlName: requireStringComponentField(component, 'model_rql_name', CustomFieldSection.componentType),
+            isRipplingDefined: component['is_rippling_defined'] === true,
+            identifierSlug: component['identifier_slug'] ?? null,
+            displayOrder: component['display_order'] ?? null,
+        });
+    }
+    getSectionId() {
+        return this._sectionId;
+    }
+    getName() {
+        return this._name;
+    }
+    getModelRqlName() {
+        return this._modelRqlName;
+    }
+    toDict() {
+        return {
+            type: CustomFieldSection.componentType,
+            obj_id: this._sectionId,
+            name: this._name,
+            is_rippling_defined: this._isRipplingDefined,
+            model_rql_name: this._modelRqlName,
+            identifier_slug: this._identifierSlug,
+            display_order: this._displayOrder,
+        };
+    }
+}
+CustomFieldSection.componentType = 'CUSTOM_FIELD_SECTION';
+//# sourceMappingURL=custom-field-section.mjs.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-section.mjs","sourceRoot":"","sources":["../../src/lib/manifest/custom-field-section.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,uBAAmB;AACxC,OAAO,EAAE,0BAA0B,EAAuC,wCAAoC;AAE9G,OAAO,EAAE,2BAA2B,EAAE,yCAAqC;AAW3E,iFAAiF;AACjF,MAAM,OAAO,kBAAkB;IAG7B,MAAM,CAAC,oBAAoB,CAAC,SAAiB;QAC3C,OAAO,EAAE,IAAI,EAAE,kBAAkB,CAAC,aAAa,EAAE,UAAU,EAAE,SAAS,EAAE,CAAC;IAC3E,CAAC;IASD,YAAY,KAAoB,EAAE,KAA8B;QAC9D,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,SAAS,IAAI,UAAU,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,CAAC;QACxC,IAAI,CAAC,kBAAkB,GAAG,KAAK,CAAC,iBAAiB,IAAI,KAAK,CAAC;QAC3D,IAAI,CAAC,eAAe,GAAG,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC;QACpD,IAAI,CAAC,aAAa,GAAG,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC;QAChD,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,SAAiB,EACjB,UAA0C,EAAE;QAE5C,OAAO,0BAA0B,CAAC,OAAO,CAAC,CAAC,sBAAsB,CAAC,SAAS,CAAC,CAAC;IAC/E,CAAC;IAED,qEAAqE;IACrE,MAAM,CAAC,sBAAsB,CAAC,KAAoB,EAAE,SAA8B;QAChF,OAAO,IAAI,kBAAkB,CAAC,KAAK,EAAE;YACnC,SAAS,EAAE,2BAA2B,CAAC,SAAS,EAAE,QAAQ,EAAE,kBAAkB,CAAC,aAAa,CAAC;YAC7F,IAAI,EAAE,2BAA2B,CAAC,SAAS,EAAE,MAAM,EAAE,kBAAkB,CAAC,aAAa,CAAC;YACtF,YAAY,EAAE,2BAA2B,CACvC,SAAS,EACT,gBAAgB,EAChB,kBAAkB,CAAC,aAAa,CACjC;YACD,iBAAiB,EAAE,SAAS,CAAC,qBAAqB,CAAC,KAAK,IAAI;YAC5D,cAAc,EAAG,SAAS,CAAC,iBAAiB,CAA+B,IAAI,IAAI;YACnF,YAAY,EAAG,SAAS,CAAC,eAAe,CAA+B,IAAI,IAAI;SAChF,CAAC,CAAC;IACL,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,OAAO;QACL,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,MAAM;QACJ,OAAO;YACL,IAAI,EAAE,kBAAkB,CAAC,aAAa;YACtC,MAAM,EAAE,IAAI,CAAC,UAAU;YACvB,IAAI,EAAE,IAAI,CAAC,KAAK;YAChB,mBAAmB,EAAE,IAAI,CAAC,kBAAkB;YAC5C,cAAc,EAAE,IAAI,CAAC,aAAa;YAClC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,aAAa,EAAE,IAAI,CAAC,aAAa;SAClC,CAAC;IACJ,CAAC;;AApEe,gCAAa,GAAG,sBAA+B,CAAC"}

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

@@ -0,0 +1,82 @@
+import { CustomFieldSection } from "./custom-field-section.mjs";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
+export declare const CUSTOM_FIELD_TYPES: readonly ["TEXT", "DATE", "NUMBER", "CURRENCY", "PERCENTAGE", "SELECT", "FILE", "ID", "RADIO", "TEXTAREA", "RANGE", "REFERENCE_ID", "BOOLEAN", "ADDRESS", "OG_REFERENCE_FIELD", "EMAIL", "URL"];
+export type CustomFieldType = (typeof CUSTOM_FIELD_TYPES)[number];
+export type CustomFieldApiName = `${string}__cfv2`;
+export type CustomFieldUniqueIDCharacterType = 'DIGITS_ONLY' | 'TEXT_ONLY' | 'DIGITS_TEXT_BOTH';
+type CustomFieldSimpleType = Exclude<CustomFieldType, 'NUMBER' | 'CURRENCY' | 'SELECT' | 'RADIO' | 'ID' | 'OG_REFERENCE_FIELD'>;
+export type CustomFieldDataType = {
+    fieldType: CustomFieldSimpleType;
+} | {
+    fieldType: 'NUMBER';
+    decimalPlaces?: number | null;
+} | {
+    fieldType: 'CURRENCY';
+    currency?: string | null;
+} | {
+    fieldType: 'SELECT' | 'RADIO';
+    options: readonly string[];
+} | {
+    fieldType: 'ID';
+    numberOfCharacters?: number | null;
+    characterType?: CustomFieldUniqueIDCharacterType | null;
+} | {
+    fieldType: 'OG_REFERENCE_FIELD';
+    referencedModelRqlName: string;
+};
+export type CustomFieldPermissionClassification = 'BASIC_PERSONAL_INFO' | 'PERSONAL_INFO' | 'SENSITIVE_PERSONAL_INFO' | 'BASIC_EMPLOYMENT_INFO' | 'EMPLOYMENT_INFO' | 'SENSITIVE_EMPLOYMENT_INFO';
+export type CustomFieldReadAccess = 'ALL_ACCESS' | 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+export type CustomFieldWriteAccess = 'EMPLOYEE_ACCESS' | 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS' | 'NO_ACCESS';
+export type CustomFieldCollectionTiming = 'NONE' | 'HIRING' | 'ONBOARDING' | 'TERMINATING';
+export type CustomFieldDefaultValue = {
+    value: string;
+    rqlDefinitionFormula?: never;
+} | {
+    value?: never;
+    rqlDefinitionFormula: string;
+};
+interface CustomFieldCommonProps {
+    fieldId?: string;
+    name: string;
+    section: CustomFieldSection;
+    modelRqlName: string;
+    dataType: CustomFieldDataType;
+    apiName: CustomFieldApiName;
+    fieldPermissionClassification?: CustomFieldPermissionClassification | null;
+    fieldReadAccess?: CustomFieldReadAccess | null;
+    fieldWriteAccess?: CustomFieldWriteAccess | null;
+    applicableGroup?: string | null;
+    description?: string | null;
+    displayOrder?: number | null;
+}
+export type CustomFieldProps = CustomFieldCommonProps & ({
+    rqlDefinitionFormula: string;
+    collectDuring?: null;
+    required?: null;
+    tip?: null;
+    defaultValue?: null;
+} | {
+    rqlDefinitionFormula?: null;
+    collectDuring?: CustomFieldCollectionTiming | null;
+    required?: boolean | null;
+    tip?: string | null;
+    defaultValue?: CustomFieldDefaultValue | null;
+});
+/** A Custom Field V2 field on a native or custom object. */
+export declare class CustomField {
+    static readonly componentType: "CUSTOM_FIELD_V2";
+    static toDeletionIdentifier(customFieldId: string): ManifestComponentDeletion;
+    private readonly _fieldId;
+    private readonly props;
+    constructor(scope: ManifestScope, props: CustomFieldProps);
+    static loadFromExisting(fieldIdOrApiName: string, options?: ExistingManifestContextOptions): CustomField;
+    /** @internal Hydrates a custom field from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>, section: CustomFieldSection): CustomField;
+    getFieldId(): string;
+    getApiName(): CustomFieldApiName;
+    getModelRqlName(): string;
+    toDict(): Record<string, any>;
+}
+export {};
+//# sourceMappingURL=custom-field.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-field.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,mCAA+B;AAC5D,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAGnF,eAAO,MAAM,kBAAkB,iMAkBrB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,GAAG,MAAM,QAAQ,CAAC;AAEnD,MAAM,MAAM,gCAAgC,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,CAAC;AAEhG,KAAK,qBAAqB,GAAG,OAAO,CAClC,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,IAAI,GAAG,oBAAoB,CACzE,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B;IAAE,SAAS,EAAE,qBAAqB,CAAA;CAAE,GACpC;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACtD;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACnD;IAAE,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC;IAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAC7D;IACE,SAAS,EAAE,IAAI,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,aAAa,CAAC,EAAE,gCAAgC,GAAG,IAAI,CAAC;CACzD,GACD;IAAE,SAAS,EAAE,oBAAoB,CAAC;IAAC,sBAAsB,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,mCAAmC,GAC3C,qBAAqB,GACrB,eAAe,GACf,yBAAyB,GACzB,uBAAuB,GACvB,iBAAiB,GACjB,2BAA2B,CAAC;AAEhC,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,cAAc,GAAG,2BAA2B,CAAC;AAEhG,MAAM,MAAM,sBAAsB,GAC9B,iBAAiB,GACjB,cAAc,GACd,2BAA2B,GAC3B,WAAW,CAAC;AAEhB,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,aAAa,CAAC;AAE3F,MAAM,MAAM,uBAAuB,GAC/B;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,oBAAoB,CAAC,EAAE,KAAK,CAAA;CAAE,GAC/C;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,UAAU,sBAAsB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,CAAC;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,6BAA6B,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAC3E,eAAe,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GACnD,CACI;IACE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB,GACD;IACE,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACnD,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC/C,CACJ,CAAC;AAqDJ,4DAA4D;AAC5D,qBAAa,WAAW;IACtB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,iBAAiB,CAAU;IAE3D,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,yBAAyB;IAI7E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAmB;gBAE7B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB;IAkBzD,MAAM,CAAC,gBAAgB,CACrB,gBAAgB,EAAE,MAAM,EACxB,OAAO,GAAE,8BAAmC,GAC3C,WAAW;IAId,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,OAAO,EAAE,kBAAkB,GAC1B,WAAW;IA4Dd,UAAU,IAAI,MAAM;IAIpB,UAAU,IAAI,kBAAkB;IAIhC,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAyC9B"}

package/lib/manifest/custom-field.d.ts

@@ -0,0 +1,82 @@
+import { CustomFieldSection } from "./custom-field-section.js";
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
+export declare const CUSTOM_FIELD_TYPES: readonly ["TEXT", "DATE", "NUMBER", "CURRENCY", "PERCENTAGE", "SELECT", "FILE", "ID", "RADIO", "TEXTAREA", "RANGE", "REFERENCE_ID", "BOOLEAN", "ADDRESS", "OG_REFERENCE_FIELD", "EMAIL", "URL"];
+export type CustomFieldType = (typeof CUSTOM_FIELD_TYPES)[number];
+export type CustomFieldApiName = `${string}__cfv2`;
+export type CustomFieldUniqueIDCharacterType = 'DIGITS_ONLY' | 'TEXT_ONLY' | 'DIGITS_TEXT_BOTH';
+type CustomFieldSimpleType = Exclude<CustomFieldType, 'NUMBER' | 'CURRENCY' | 'SELECT' | 'RADIO' | 'ID' | 'OG_REFERENCE_FIELD'>;
+export type CustomFieldDataType = {
+    fieldType: CustomFieldSimpleType;
+} | {
+    fieldType: 'NUMBER';
+    decimalPlaces?: number | null;
+} | {
+    fieldType: 'CURRENCY';
+    currency?: string | null;
+} | {
+    fieldType: 'SELECT' | 'RADIO';
+    options: readonly string[];
+} | {
+    fieldType: 'ID';
+    numberOfCharacters?: number | null;
+    characterType?: CustomFieldUniqueIDCharacterType | null;
+} | {
+    fieldType: 'OG_REFERENCE_FIELD';
+    referencedModelRqlName: string;
+};
+export type CustomFieldPermissionClassification = 'BASIC_PERSONAL_INFO' | 'PERSONAL_INFO' | 'SENSITIVE_PERSONAL_INFO' | 'BASIC_EMPLOYMENT_INFO' | 'EMPLOYMENT_INFO' | 'SENSITIVE_EMPLOYMENT_INFO';
+export type CustomFieldReadAccess = 'ALL_ACCESS' | 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+export type CustomFieldWriteAccess = 'EMPLOYEE_ACCESS' | 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS' | 'NO_ACCESS';
+export type CustomFieldCollectionTiming = 'NONE' | 'HIRING' | 'ONBOARDING' | 'TERMINATING';
+export type CustomFieldDefaultValue = {
+    value: string;
+    rqlDefinitionFormula?: never;
+} | {
+    value?: never;
+    rqlDefinitionFormula: string;
+};
+interface CustomFieldCommonProps {
+    fieldId?: string;
+    name: string;
+    section: CustomFieldSection;
+    modelRqlName: string;
+    dataType: CustomFieldDataType;
+    apiName: CustomFieldApiName;
+    fieldPermissionClassification?: CustomFieldPermissionClassification | null;
+    fieldReadAccess?: CustomFieldReadAccess | null;
+    fieldWriteAccess?: CustomFieldWriteAccess | null;
+    applicableGroup?: string | null;
+    description?: string | null;
+    displayOrder?: number | null;
+}
+export type CustomFieldProps = CustomFieldCommonProps & ({
+    rqlDefinitionFormula: string;
+    collectDuring?: null;
+    required?: null;
+    tip?: null;
+    defaultValue?: null;
+} | {
+    rqlDefinitionFormula?: null;
+    collectDuring?: CustomFieldCollectionTiming | null;
+    required?: boolean | null;
+    tip?: string | null;
+    defaultValue?: CustomFieldDefaultValue | null;
+});
+/** A Custom Field V2 field on a native or custom object. */
+export declare class CustomField {
+    static readonly componentType: "CUSTOM_FIELD_V2";
+    static toDeletionIdentifier(customFieldId: string): ManifestComponentDeletion;
+    private readonly _fieldId;
+    private readonly props;
+    constructor(scope: ManifestScope, props: CustomFieldProps);
+    static loadFromExisting(fieldIdOrApiName: string, options?: ExistingManifestContextOptions): CustomField;
+    /** @internal Hydrates a custom field from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>, section: CustomFieldSection): CustomField;
+    getFieldId(): string;
+    getApiName(): CustomFieldApiName;
+    getModelRqlName(): string;
+    toDict(): Record<string, any>;
+}
+export {};
+//# sourceMappingURL=custom-field.d.ts.map

package/lib/manifest/custom-field.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-field.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,kBAAkB,EAAE,kCAA+B;AAC5D,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF,eAAO,MAAM,kBAAkB,iMAkBrB,CAAC;AAEX,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AAClE,MAAM,MAAM,kBAAkB,GAAG,GAAG,MAAM,QAAQ,CAAC;AAEnD,MAAM,MAAM,gCAAgC,GAAG,aAAa,GAAG,WAAW,GAAG,kBAAkB,CAAC;AAEhG,KAAK,qBAAqB,GAAG,OAAO,CAClC,eAAe,EACf,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,IAAI,GAAG,oBAAoB,CACzE,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAC3B;IAAE,SAAS,EAAE,qBAAqB,CAAA;CAAE,GACpC;IAAE,SAAS,EAAE,QAAQ,CAAC;IAAC,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACtD;IAAE,SAAS,EAAE,UAAU,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,GACnD;IAAE,SAAS,EAAE,QAAQ,GAAG,OAAO,CAAC;IAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAA;CAAE,GAC7D;IACE,SAAS,EAAE,IAAI,CAAC;IAChB,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,aAAa,CAAC,EAAE,gCAAgC,GAAG,IAAI,CAAC;CACzD,GACD;IAAE,SAAS,EAAE,oBAAoB,CAAC;IAAC,sBAAsB,EAAE,MAAM,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,mCAAmC,GAC3C,qBAAqB,GACrB,eAAe,GACf,yBAAyB,GACzB,uBAAuB,GACvB,iBAAiB,GACjB,2BAA2B,CAAC;AAEhC,MAAM,MAAM,qBAAqB,GAAG,YAAY,GAAG,cAAc,GAAG,2BAA2B,CAAC;AAEhG,MAAM,MAAM,sBAAsB,GAC9B,iBAAiB,GACjB,cAAc,GACd,2BAA2B,GAC3B,WAAW,CAAC;AAEhB,MAAM,MAAM,2BAA2B,GAAG,MAAM,GAAG,QAAQ,GAAG,YAAY,GAAG,aAAa,CAAC;AAE3F,MAAM,MAAM,uBAAuB,GAC/B;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,oBAAoB,CAAC,EAAE,KAAK,CAAA;CAAE,GAC/C;IAAE,KAAK,CAAC,EAAE,KAAK,CAAC;IAAC,oBAAoB,EAAE,MAAM,CAAA;CAAE,CAAC;AAEpD,UAAU,sBAAsB;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,CAAC;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,6BAA6B,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAC3E,eAAe,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IACjD,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,MAAM,MAAM,gBAAgB,GAAG,sBAAsB,GACnD,CACI;IACE,oBAAoB,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB,GACD;IACE,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAC5B,aAAa,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACnD,QAAQ,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,YAAY,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAC;CAC/C,CACJ,CAAC;AAqDJ,4DAA4D;AAC5D,qBAAa,WAAW;IACtB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,iBAAiB,CAAU;IAE3D,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,yBAAyB;IAI7E,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAmB;gBAE7B,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB;IAkBzD,MAAM,CAAC,gBAAgB,CACrB,gBAAgB,EAAE,MAAM,EACxB,OAAO,GAAE,8BAAmC,GAC3C,WAAW;IAId,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,CAC3B,KAAK,EAAE,aAAa,EACpB,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAC9B,OAAO,EAAE,kBAAkB,GAC1B,WAAW;IA4Dd,UAAU,IAAI,MAAM;IAIpB,UAAU,IAAI,kBAAkB;IAIhC,eAAe,IAAI,MAAM;IAIzB,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAyC9B"}

package/lib/manifest/custom-field.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomField = exports.CUSTOM_FIELD_TYPES = 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");
+exports.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 = (0, _existing_component_fields_1.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: (0, _existing_component_fields_1.requireStringComponentField)(dataType, 'og_model_rql_name', CustomField.componentType),
+            };
+        default:
+            if (!exports.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. */
+class CustomField {
+    static toDeletionIdentifier(customFieldId) {
+        return { type: CustomField.componentType, cfv2_id: customFieldId };
+    }
+    constructor(scope, 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}".`);
+        }
+        this._fieldId = props.fieldId ?? (0, _helpers_1.generateId)('cfv2');
+        this.props = {
+            ...props,
+            dataType: cloneJson(props.dataType),
+        };
+        scope._register(this);
+    }
+    static loadFromExisting(fieldIdOrApiName, options = {}) {
+        return (0, existing_manifest_context_1.getExistingManifestContext)(options).loadCustomField(fieldIdOrApiName);
+    }
+    /** @internal Hydrates a custom field from existing manifest wire JSON. */
+    static _fromExistingComponent(scope, component, section) {
+        const dataType = (0, _existing_component_fields_1.requireObjectComponentField)(component, 'data_type', CustomField.componentType);
+        const defaultValue = component['default_value'];
+        const formula = component['rql_definition_formula'];
+        const applicableGroup = component['applicable_group'] == null ?
+            null
+            : (0, _existing_component_fields_1.requireObjectComponentField)(component, 'applicable_group', CustomField.componentType);
+        const common = {
+            fieldId: (0, _existing_component_fields_1.requireStringComponentField)(component, 'obj_id', CustomField.componentType),
+            name: (0, _existing_component_fields_1.requireStringComponentField)(component, 'name', CustomField.componentType),
+            section,
+            modelRqlName: (0, _existing_component_fields_1.requireStringComponentField)(component, 'model_rql_name', CustomField.componentType),
+            apiName: (0, _existing_component_fields_1.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,
+            applicableGroup: applicableGroup == null ? null : ((0, _existing_component_fields_1.requireStringComponentField)(applicableGroup, 'me_obj_id', CustomField.componentType)),
+            description: component['description'] ?? null,
+            displayOrder: component['display_order'] ?? null,
+        };
+        if (typeof formula === 'string') {
+            return new CustomField(scope, {
+                ...common,
+                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: this.props.applicableGroup ?? 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,
+        };
+    }
+}
+exports.CustomField = CustomField;
+CustomField.componentType = 'CUSTOM_FIELD_V2';
+//# sourceMappingURL=custom-field.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field.js","sourceRoot":"","sources":["../../src/lib/manifest/custom-field.ts"],"names":[],"mappings":";;;AAAA,4CAAwC;AAExC,8EAA8G;AAE9G,gFAAwG;AAE3F,QAAA,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;AA+EX,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,IAAA,wDAA2B,EAC3C,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,IAAA,wDAA2B,EACjD,QAAQ,EACR,mBAAmB,EACnB,WAAW,CAAC,aAAa,CAC1B;aACF,CAAC;QACJ;YACE,IAAI,CAAE,0BAAwC,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,MAAa,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,KAAuB;QACvD,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,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG;YACX,GAAG,KAAK;YACR,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;SACpC,CAAC;QACF,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,gBAAwB,EACxB,UAA0C,EAAE;QAE5C,OAAO,IAAA,sDAA0B,EAAC,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,IAAA,wDAA2B,EAAC,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,eAAe,GACnB,SAAS,CAAC,kBAAkB,CAAC,IAAI,IAAI,CAAC,CAAC;YACrC,IAAI;YACN,CAAC,CAAC,IAAA,wDAA2B,EAAC,SAAS,EAAE,kBAAkB,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;QAC1F,MAAM,MAAM,GAAG;YACb,OAAO,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,QAAQ,EAAE,WAAW,CAAC,aAAa,CAAC;YACpF,IAAI,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,MAAM,EAAE,WAAW,CAAC,aAAa,CAAC;YAC/E,OAAO;YACP,YAAY,EAAE,IAAA,wDAA2B,EAAC,SAAS,EAAE,gBAAgB,EAAE,WAAW,CAAC,aAAa,CAAC;YACjG,OAAO,EAAE,IAAA,wDAA2B,EAClC,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,eAAe,EACb,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAC/B,IAAA,wDAA2B,EAAC,eAAe,EAAE,WAAW,EAAE,WAAW,CAAC,aAAa,CAAC,CACrF;YACH,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,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;gBAC5B,GAAG,MAAM;gBACT,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,gBAAgB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI;YACpD,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;;AAxJH,kCAyJC;AAxJiB,yBAAa,GAAG,iBAA0B,CAAC"}