@rippling/rippling-sdk 0.2.0-alpha.78 → 0.2.0-alpha.80

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

@@ -36,40 +36,81 @@ export type CustomFieldDefaultValue = {
     value?: never;
     rqlDefinitionFormula: string;
 };
-interface CustomFieldCommonProps {
+/** Properties shared by formula and user-input custom fields. */
+export interface CustomFieldBaseProps<ModelRqlName extends string = string> {
     fieldId?: string;
     name: string;
     section: CustomFieldSection;
-    modelRqlName: string;
+    modelRqlName: ModelRqlName;
     dataType: CustomFieldDataType;
     apiName: CustomFieldApiName;
+    description?: string | null;
+    displayOrder?: number | null;
+}
+type NonSensitiveCustomFieldPermissionClassification = Exclude<CustomFieldPermissionClassification, 'SENSITIVE_PERSONAL_INFO' | 'SENSITIVE_EMPLOYMENT_INFO'>;
+/** Permission properties required for every Employee custom field. */
+export type EmployeeCustomFieldPermissionProps = {
+    applicableGroup: string;
+} & ({
+    fieldReadAccess: 'ALL_ACCESS';
+    fieldPermissionClassification: NonSensitiveCustomFieldPermissionClassification;
+} | {
+    fieldReadAccess: 'ADMIN_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+    fieldPermissionClassification: CustomFieldPermissionClassification;
+});
+/** Optional permission properties used by non-Employee custom fields. */
+export interface NonEmployeeCustomFieldPermissionProps {
     fieldPermissionClassification?: CustomFieldPermissionClassification | null;
     fieldReadAccess?: CustomFieldReadAccess | null;
-    fieldWriteAccess?: CustomFieldWriteAccess | null;
     applicableGroup?: string | null;
-    description?: string | null;
-    displayOrder?: number | null;
 }
-export type CustomFieldProps = CustomFieldCommonProps & ({
+export type CustomFieldPermissionProps<ModelRqlName extends string = string> = ModelRqlName extends 'Employee' ? EmployeeCustomFieldPermissionProps : NonEmployeeCustomFieldPermissionProps;
+interface CustomFieldUserInputOptions {
+    rqlDefinitionFormula?: null;
+    required?: boolean | null;
+    tip?: string | null;
+    defaultValue?: CustomFieldDefaultValue | null;
+}
+type EmployeeCustomFieldUserInputAccess = {
+    collectDuring: 'ONBOARDING';
+    fieldReadAccess: 'ALL_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS';
+    fieldWriteAccess: 'EMPLOYEE_ACCESS' | 'ADMIN_AND_EMPLOYEE_ACCESS' | 'NO_ACCESS';
+} | {
+    collectDuring?: 'NONE' | 'HIRING' | 'TERMINATING' | null;
+    fieldWriteAccess: CustomFieldWriteAccess;
+};
+interface NonEmployeeCustomFieldUserInputAccess {
+    collectDuring?: CustomFieldCollectionTiming | null;
+    fieldWriteAccess?: CustomFieldWriteAccess | null;
+}
+type CustomFieldUserInputAccess<ModelRqlName extends string> = ModelRqlName extends 'Employee' ? EmployeeCustomFieldUserInputAccess : NonEmployeeCustomFieldUserInputAccess;
+interface CustomFieldFormulaOptions {
     rqlDefinitionFormula: string;
+    fieldWriteAccess: 'NO_ACCESS';
     collectDuring?: null;
     required?: null;
     tip?: null;
     defaultValue?: null;
-} | {
-    rqlDefinitionFormula?: null;
-    collectDuring?: CustomFieldCollectionTiming | null;
-    required?: boolean | null;
-    tip?: string | null;
-    defaultValue?: CustomFieldDefaultValue | null;
-});
+}
+/** A calculated custom field whose value cannot be edited directly. */
+export type FormulaCustomFieldProps<ModelRqlName extends string = string> = CustomFieldBaseProps<ModelRqlName> & CustomFieldPermissionProps<ModelRqlName> & CustomFieldFormulaOptions;
+/** A custom field whose value is supplied by a user or a default value. */
+export type UserInputCustomFieldProps<ModelRqlName extends string = string> = CustomFieldBaseProps<ModelRqlName> & CustomFieldPermissionProps<ModelRqlName> & CustomFieldUserInputOptions & CustomFieldUserInputAccess<ModelRqlName>;
+/** A formula or user-input custom field on the given model. */
+export type CustomFieldProps<ModelRqlName extends string = string> = FormulaCustomFieldProps<ModelRqlName> | UserInputCustomFieldProps<ModelRqlName>;
+/** A calculated Employee custom field. */
+export type EmployeeFormulaCustomFieldProps = FormulaCustomFieldProps<'Employee'>;
+/** An Employee custom field whose value is supplied by a user or a default value. */
+export type EmployeeUserInputCustomFieldProps = UserInputCustomFieldProps<'Employee'>;
+/** Any supported Employee custom field. */
+export type EmployeeCustomFieldProps = EmployeeFormulaCustomFieldProps | EmployeeUserInputCustomFieldProps;
 /** A Custom Field V2 field on a native or custom object. */
-export declare class CustomField {
+export declare class CustomField<const ModelRqlName extends string = string> {
     static readonly componentType: "CUSTOM_FIELD_V2";
     static toDeletionIdentifier(customFieldId: string): ManifestComponentDeletion;
     private readonly _fieldId;
     private readonly props;
-    constructor(scope: ManifestScope, props: CustomFieldProps);
+    constructor(scope: ManifestScope, props: CustomFieldProps<ModelRqlName>);
     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;

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

@@ -1 +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"}
+{"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,iEAAiE;AACjE,MAAM,WAAW,oBAAoB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM;IACxE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,kBAAkB,CAAC;IAC5B,YAAY,EAAE,YAAY,CAAC;IAC3B,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,OAAO,EAAE,kBAAkB,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC9B;AAED,KAAK,+CAA+C,GAAG,OAAO,CAC5D,mCAAmC,EACnC,yBAAyB,GAAG,2BAA2B,CACxD,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,kCAAkC,GAAG;IAAE,eAAe,EAAE,MAAM,CAAA;CAAE,GAAG,CAC3E;IACE,eAAe,EAAE,YAAY,CAAC;IAC9B,6BAA6B,EAAE,+CAA+C,CAAC;CAChF,GACD;IACE,eAAe,EAAE,cAAc,GAAG,2BAA2B,CAAC;IAC9D,6BAA6B,EAAE,mCAAmC,CAAC;CACpE,CACJ,CAAC;AAEF,yEAAyE;AACzE,MAAM,WAAW,qCAAqC;IACpD,6BAA6B,CAAC,EAAE,mCAAmC,GAAG,IAAI,CAAC;IAC3E,eAAe,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAC/C,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,MAAM,MAAM,0BAA0B,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,IACzE,YAAY,SAAS,UAAU,GAAG,kCAAkC,GAClE,qCAAqC,CAAC;AAE1C,UAAU,2BAA2B;IACnC,oBAAoB,CAAC,EAAE,IAAI,CAAC;IAC5B,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;AAED,KAAK,kCAAkC,GACnC;IACE,aAAa,EAAE,YAAY,CAAC;IAC5B,eAAe,EAAE,YAAY,GAAG,2BAA2B,CAAC;IAC5D,gBAAgB,EAAE,iBAAiB,GAAG,2BAA2B,GAAG,WAAW,CAAC;CACjF,GACD;IACE,aAAa,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,aAAa,GAAG,IAAI,CAAC;IACzD,gBAAgB,EAAE,sBAAsB,CAAC;CAC1C,CAAC;AAEN,UAAU,qCAAqC;IAC7C,aAAa,CAAC,EAAE,2BAA2B,GAAG,IAAI,CAAC;IACnD,gBAAgB,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CAClD;AAED,KAAK,0BAA0B,CAAC,YAAY,SAAS,MAAM,IACzD,YAAY,SAAS,UAAU,GAAG,kCAAkC,GAClE,qCAAqC,CAAC;AAE1C,UAAU,yBAAyB;IACjC,oBAAoB,EAAE,MAAM,CAAC;IAC7B,gBAAgB,EAAE,WAAW,CAAC;IAC9B,aAAa,CAAC,EAAE,IAAI,CAAC;IACrB,QAAQ,CAAC,EAAE,IAAI,CAAC;IAChB,GAAG,CAAC,EAAE,IAAI,CAAC;IACX,YAAY,CAAC,EAAE,IAAI,CAAC;CACrB;AAED,uEAAuE;AACvE,MAAM,MAAM,uBAAuB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,IACtE,oBAAoB,CAAC,YAAY,CAAC,GAAG,0BAA0B,CAAC,YAAY,CAAC,GAAG,yBAAyB,CAAC;AAE5G,2EAA2E;AAC3E,MAAM,MAAM,yBAAyB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,IACxE,oBAAoB,CAAC,YAAY,CAAC,GAChC,0BAA0B,CAAC,YAAY,CAAC,GACxC,2BAA2B,GAC3B,0BAA0B,CAAC,YAAY,CAAC,CAAC;AAE7C,+DAA+D;AAC/D,MAAM,MAAM,gBAAgB,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM,IAC7D,uBAAuB,CAAC,YAAY,CAAC,GACrC,yBAAyB,CAAC,YAAY,CAAC,CAAC;AAE5C,0CAA0C;AAC1C,MAAM,MAAM,+BAA+B,GAAG,uBAAuB,CAAC,UAAU,CAAC,CAAC;AAElF,qFAAqF;AACrF,MAAM,MAAM,iCAAiC,GAAG,yBAAyB,CAAC,UAAU,CAAC,CAAC;AAEtF,2CAA2C;AAC3C,MAAM,MAAM,wBAAwB,GAAG,+BAA+B,GAAG,iCAAiC,CAAC;AAqD3G,4DAA4D;AAC5D,qBAAa,WAAW,CAAC,KAAK,CAAC,YAAY,SAAS,MAAM,GAAG,MAAM;IACjE,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,CAAiC;gBAE3C,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB,CAAC,YAAY,CAAC;IA4DvE,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;IAgEd,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

@@ -70,6 +70,7 @@ class CustomField {
         return { type: CustomField.componentType, cfv2_id: customFieldId };
     }
     constructor(scope, props) {
+        const runtimeProps = props;
         if (!props.apiName.endsWith('__cfv2')) {
             throw new Error(`Custom Field V2 api_name must end with __cfv2: ${props.apiName}`);
         }
@@ -77,6 +78,28 @@ class CustomField {
             throw new Error(`Custom field "${props.apiName}" section belongs to "${props.section.getModelRqlName()}", ` +
                 `but the field belongs to "${props.modelRqlName}".`);
         }
+        if (runtimeProps.rqlDefinitionFormula != null && runtimeProps.fieldWriteAccess !== 'NO_ACCESS') {
+            throw new Error(`Formula custom field "${props.apiName}" must have fieldWriteAccess "NO_ACCESS".`);
+        }
+        if (props.modelRqlName === 'Employee') {
+            if (runtimeProps.fieldPermissionClassification == null ||
+                runtimeProps.fieldReadAccess == null ||
+                runtimeProps.fieldWriteAccess == null ||
+                runtimeProps.applicableGroup == null) {
+                throw new Error(`Employee custom field "${props.apiName}" requires fieldPermissionClassification, ` +
+                    `fieldReadAccess, fieldWriteAccess, and applicableGroup.`);
+            }
+            if (runtimeProps.fieldReadAccess === 'ALL_ACCESS' &&
+                (runtimeProps.fieldPermissionClassification === 'SENSITIVE_PERSONAL_INFO' ||
+                    runtimeProps.fieldPermissionClassification === 'SENSITIVE_EMPLOYMENT_INFO')) {
+                throw new Error(`Employee custom field "${props.apiName}" cannot use a sensitive permission classification ` +
+                    `with fieldReadAccess "ALL_ACCESS".`);
+            }
+            if (runtimeProps.collectDuring === 'ONBOARDING' &&
+                (runtimeProps.fieldReadAccess === 'ADMIN_ACCESS' || runtimeProps.fieldWriteAccess === 'ADMIN_ACCESS')) {
+                throw new Error(`Employee onboarding custom field "${props.apiName}" must grant the employee read and write access.`);
+            }
+        }
         this._fieldId = props.fieldId ?? (0, _helpers_1.generateId)('cfv2');
         this.props = {
             ...props,
@@ -110,8 +133,12 @@ class CustomField {
             displayOrder: component['display_order'] ?? null,
         };
         if (typeof formula === 'string') {
+            if (common.fieldWriteAccess != null && common.fieldWriteAccess !== 'NO_ACCESS') {
+                throw new TypeError(`Formula CUSTOM_FIELD_V2 field_write_access must be NO_ACCESS.`);
+            }
             return new CustomField(scope, {
                 ...common,
+                fieldWriteAccess: 'NO_ACCESS',
                 rqlDefinitionFormula: formula,
                 collectDuring: null,
                 required: null,

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

@@ -1 +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"}
+{"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;AAmJX,SAAS,SAAS,CAAI,KAAQ;IAC5B,IAAI,KAAK,IAAI,IAAI;QAAE,OAAO,KAAK,CAAC;IAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAM,CAAC;AAChD,CAAC;AAED,SAAS,2BAA2B,CAAC,QAA6B;IAChE,MAAM,SAAS,GAAG,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,KAAqC;QACrE,MAAM,YAAY,GAAG,KAOpB,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,kDAAkD,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK,KAAK,CAAC,YAAY,EAAE,CAAC;YAC3D,MAAM,IAAI,KAAK,CACb,iBAAiB,KAAK,CAAC,OAAO,yBAAyB,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,KAAK;gBACzF,6BAA6B,KAAK,CAAC,YAAY,IAAI,CACtD,CAAC;QACJ,CAAC;QACD,IAAI,YAAY,CAAC,oBAAoB,IAAI,IAAI,IAAI,YAAY,CAAC,gBAAgB,KAAK,WAAW,EAAE,CAAC;YAC/F,MAAM,IAAI,KAAK,CAAC,yBAAyB,KAAK,CAAC,OAAO,2CAA2C,CAAC,CAAC;QACrG,CAAC;QACD,IAAI,KAAK,CAAC,YAAY,KAAK,UAAU,EAAE,CAAC;YACtC,IACE,YAAY,CAAC,6BAA6B,IAAI,IAAI;gBAClD,YAAY,CAAC,eAAe,IAAI,IAAI;gBACpC,YAAY,CAAC,gBAAgB,IAAI,IAAI;gBACrC,YAAY,CAAC,eAAe,IAAI,IAAI,EACpC,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0BAA0B,KAAK,CAAC,OAAO,4CAA4C;oBACjF,yDAAyD,CAC5D,CAAC;YACJ,CAAC;YACD,IACE,YAAY,CAAC,eAAe,KAAK,YAAY;gBAC7C,CAAC,YAAY,CAAC,6BAA6B,KAAK,yBAAyB;oBACvE,YAAY,CAAC,6BAA6B,KAAK,2BAA2B,CAAC,EAC7E,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,0BAA0B,KAAK,CAAC,OAAO,qDAAqD;oBAC1F,oCAAoC,CACvC,CAAC;YACJ,CAAC;YACD,IACE,YAAY,CAAC,aAAa,KAAK,YAAY;gBAC3C,CAAC,YAAY,CAAC,eAAe,KAAK,cAAc,IAAI,YAAY,CAAC,gBAAgB,KAAK,cAAc,CAAC,EACrG,CAAC;gBACD,MAAM,IAAI,KAAK,CACb,qCAAqC,KAAK,CAAC,OAAO,kDAAkD,CACrG,CAAC;YACJ,CAAC;QACH,CAAC;QACD,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC,OAAO,IAAI,IAAA,qBAAU,EAAC,MAAM,CAAC,CAAC;QACpD,IAAI,CAAC,KAAK,GAAG;YACX,GAAG,KAAK;YACR,QAAQ,EAAE,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC;SACF,CAAC;QACpC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACxB,CAAC;IAED,MAAM,CAAC,gBAAgB,CACrB,gBAAwB,EACxB,UAA0C,EAAE;QAE5C,OAAO,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,IAAI,MAAM,CAAC,gBAAgB,IAAI,IAAI,IAAI,MAAM,CAAC,gBAAgB,KAAK,WAAW,EAAE,CAAC;gBAC/E,MAAM,IAAI,SAAS,CAAC,+DAA+D,CAAC,CAAC;YACvF,CAAC;YACD,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;gBAC5B,GAAG,MAAM;gBACT,gBAAgB,EAAE,WAAW;gBAC7B,oBAAoB,EAAE,OAAO;gBAC7B,aAAa,EAAE,IAAI;gBACnB,QAAQ,EAAE,IAAI;gBACd,GAAG,EAAE,IAAI;gBACT,YAAY,EAAE,IAAI;aACnB,CAAC,CAAC;QACL,CAAC;QAED,MAAM,mBAAmB,GAAG,YAAY,EAAE,CAAC,wBAAwB,CAAC,CAAC;QACrE,MAAM,kBAAkB,GAAG,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC;QACnD,OAAO,IAAI,WAAW,CAAC,KAAK,EAAE;YAC5B,GAAG,MAAM;YACT,oBAAoB,EAAE,IAAI;YAC1B,aAAa,EAAG,SAAS,CAAC,gBAAgB,CAAoD,IAAI,IAAI;YACtG,QAAQ,EAAG,SAAS,CAAC,UAAU,CAAgC,IAAI,IAAI;YACvE,GAAG,EAAG,SAAS,CAAC,KAAK,CAA+B,IAAI,IAAI;YAC5D,YAAY,EACV,OAAO,mBAAmB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,oBAAoB,EAAE,mBAAmB,EAAE;gBACvF,CAAC,CAAC,OAAO,kBAAkB,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,kBAAkB,EAAE;oBACxE,CAAC,CAAC,IAAI;SACT,CAAC,CAAC;IACL,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,UAAU;QACR,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC;IAC5B,CAAC;IAED,eAAe;QACb,OAAO,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;IACjC,CAAC;IAED,MAAM;QACJ,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC;QACrC,MAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC;QAC7C,OAAO;YACL,IAAI,EAAE,WAAW,CAAC,aAAa;YAC/B,MAAM,EAAE,IAAI,CAAC,QAAQ;YACrB,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;YACrB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,YAAY,EAAE;YAC1C,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,YAAY;YACvC,SAAS,EAAE;gBACT,IAAI,EAAE,WAAW,CAAC,aAAa;gBAC/B,UAAU,EAAE,QAAQ,CAAC,SAAS;gBAC9B,YAAY,EAAE,SAAS,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI;gBAClE,QAAQ,EAAE,UAAU,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBACnE,qBAAqB,EAAE,eAAe,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAC1F,YAAY,EAAE,oBAAoB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAC3F,aAAa,EAAE,eAAe,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI;gBAClF,iBAAiB,EAAE,wBAAwB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC,CAAC,IAAI;aACjG;YACD,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO;YAC5B,+BAA+B,EAAE,IAAI,CAAC,KAAK,CAAC,6BAA6B,IAAI,IAAI;YACjF,iBAAiB,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,IAAI;YACrD,kBAAkB,EAAE,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,IAAI;YACvD,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI;YAChD,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;;AAtMH,kCAuMC;AAtMiB,yBAAa,GAAG,iBAA0B,CAAC"}

package/lib/manifest/custom-field.mjs

@@ -67,6 +67,7 @@ export class CustomField {
         return { type: CustomField.componentType, cfv2_id: customFieldId };
     }
     constructor(scope, props) {
+        const runtimeProps = props;
         if (!props.apiName.endsWith('__cfv2')) {
             throw new Error(`Custom Field V2 api_name must end with __cfv2: ${props.apiName}`);
         }
@@ -74,6 +75,28 @@ export class CustomField {
             throw new Error(`Custom field "${props.apiName}" section belongs to "${props.section.getModelRqlName()}", ` +
                 `but the field belongs to "${props.modelRqlName}".`);
         }
+        if (runtimeProps.rqlDefinitionFormula != null && runtimeProps.fieldWriteAccess !== 'NO_ACCESS') {
+            throw new Error(`Formula custom field "${props.apiName}" must have fieldWriteAccess "NO_ACCESS".`);
+        }
+        if (props.modelRqlName === 'Employee') {
+            if (runtimeProps.fieldPermissionClassification == null ||
+                runtimeProps.fieldReadAccess == null ||
+                runtimeProps.fieldWriteAccess == null ||
+                runtimeProps.applicableGroup == null) {
+                throw new Error(`Employee custom field "${props.apiName}" requires fieldPermissionClassification, ` +
+                    `fieldReadAccess, fieldWriteAccess, and applicableGroup.`);
+            }
+            if (runtimeProps.fieldReadAccess === 'ALL_ACCESS' &&
+                (runtimeProps.fieldPermissionClassification === 'SENSITIVE_PERSONAL_INFO' ||
+                    runtimeProps.fieldPermissionClassification === 'SENSITIVE_EMPLOYMENT_INFO')) {
+                throw new Error(`Employee custom field "${props.apiName}" cannot use a sensitive permission classification ` +
+                    `with fieldReadAccess "ALL_ACCESS".`);
+            }
+            if (runtimeProps.collectDuring === 'ONBOARDING' &&
+                (runtimeProps.fieldReadAccess === 'ADMIN_ACCESS' || runtimeProps.fieldWriteAccess === 'ADMIN_ACCESS')) {
+                throw new Error(`Employee onboarding custom field "${props.apiName}" must grant the employee read and write access.`);
+            }
+        }
         this._fieldId = props.fieldId ?? generateId('cfv2');
         this.props = {
             ...props,
@@ -107,8 +130,12 @@ export class CustomField {
             displayOrder: component['display_order'] ?? null,
         };
         if (typeof formula === 'string') {
+            if (common.fieldWriteAccess != null && common.fieldWriteAccess !== 'NO_ACCESS') {
+                throw new TypeError(`Formula CUSTOM_FIELD_V2 field_write_access must be NO_ACCESS.`);
+            }
             return new CustomField(scope, {
                 ...common,
+                fieldWriteAccess: 'NO_ACCESS',
                 rqlDefinitionFormula: formula,
                 collectDuring: null,
                 required: null,

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

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

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

@@ -0,0 +1,115 @@
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.mjs";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.mjs";
+export type CustomSkillStatus = 'active' | 'inactive';
+export type CustomSkillSourceType = 'user' | 'company';
+/**
+ * Initialization properties for {@link CustomSkill}.
+ */
+export interface CustomSkillProps {
+    /**
+     * Source-side identifier for this Custom Skill.
+     *
+     * For a new skill, omit this field and the SDK generates a temporary handle
+     * that Composer maps to the skill's generated database UUID during deploy.
+     *
+     * For an existing skill, use the `source_skill_id` loaded from component
+     * search/extraction.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('skill')
+     */
+    sourceSkillId?: string;
+    /**
+     * Display name shown in Rippling AI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Description used to explain when the skill applies.
+     *
+     * Required. Use `null` to clear this field when updating an existing skill.
+     */
+    description: string | null;
+    /**
+     * Markdown instruction content for the skill.
+     *
+     * Required.
+     */
+    content: string;
+    /**
+     * Optional folder path for organizing skills. Use `null` to clear this field
+     * when updating an existing skill.
+     */
+    path?: string | null;
+    /**
+     * Whether the skill is active or inactive.
+     *
+     * Required.
+     */
+    status: CustomSkillStatus;
+    /**
+     * Skill visibility. `user` creates a personal skill; `company` creates a
+     * company skill.
+     *
+     * Optional create-time visibility. Do not set when updating an existing
+     * skill; use `CustomSkill.loadFromExisting(...)` so the extracted value can
+     * round-trip unchanged.
+     */
+    sourceType?: CustomSkillSourceType;
+}
+/**
+ * Defines a Rippling AI Custom Skill and registers it with the manifest.
+ */
+export declare class CustomSkill {
+    static readonly componentType: "CUSTOM_SKILL";
+    static toDeletionIdentifier(sourceSkillId: string): ManifestComponentDeletion;
+    private readonly _sourceSkillId;
+    private _name;
+    private _description;
+    private _content;
+    private _path;
+    private _status;
+    private _sourceType;
+    /**
+     * @param scope - The manifest to register this skill with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: CustomSkillProps);
+    /**
+     * Loads this skill from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(sourceSkillId: string, options?: ExistingManifestContextOptions): CustomSkill;
+    /** @internal Hydrates a custom skill from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): CustomSkill;
+    /**
+     * Returns this skill's source-side manifest identifier. New skills use a
+     * generated temporary handle; extracted skills use their database UUID.
+     */
+    getSourceSkillId(): string;
+    /**
+     * Replaces the display name for this skill.
+     */
+    setName(name: string): this;
+    /**
+     * Replaces the description for this skill. Pass `null` to clear it.
+     */
+    setDescription(description: string | null): this;
+    /**
+     * Replaces the plaintext markdown instruction content for this skill.
+     */
+    setContent(content: string): this;
+    /**
+     * Replaces the optional folder path for this skill. Pass `null` to clear it,
+     * or `undefined` to omit it from the serialized manifest.
+     */
+    setPath(path: string | null | undefined): this;
+    /**
+     * Replaces whether this skill is active or inactive.
+     */
+    setStatus(status: CustomSkillStatus): this;
+    /**
+     * Serializes this skill to the wire format consumed by the manifest install endpoint.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-skill.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-skill.d.mts","sourceRoot":"","sources":["../../src/lib/manifest/custom-skill.ts"],"names":[],"mappings":"AACA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,wCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,+BAA2B;AAGnF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;AACtD,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,SAAS,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;;;OAIG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,cAAc,CAAU;IAExD,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,yBAAyB;IAO7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAA4B;IACzC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAoC;IAEvD;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB;IAiBzD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,WAAW;IAIzG,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW;IAyBhG;;;OAGG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAKhD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKjC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI;IAK9C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAK1C;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAa9B"}

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

@@ -0,0 +1,115 @@
+import { type ExistingManifestContextOptions } from "./existing-manifest-context.js";
+import type { ManifestComponentDeletion, ManifestScope } from "./manifest-builder.js";
+export type CustomSkillStatus = 'active' | 'inactive';
+export type CustomSkillSourceType = 'user' | 'company';
+/**
+ * Initialization properties for {@link CustomSkill}.
+ */
+export interface CustomSkillProps {
+    /**
+     * Source-side identifier for this Custom Skill.
+     *
+     * For a new skill, omit this field and the SDK generates a temporary handle
+     * that Composer maps to the skill's generated database UUID during deploy.
+     *
+     * For an existing skill, use the `source_skill_id` loaded from component
+     * search/extraction.
+     *
+     * Optional. Auto-generated when omitted. @default generateId('skill')
+     */
+    sourceSkillId?: string;
+    /**
+     * Display name shown in Rippling AI.
+     *
+     * Required.
+     */
+    name: string;
+    /**
+     * Description used to explain when the skill applies.
+     *
+     * Required. Use `null` to clear this field when updating an existing skill.
+     */
+    description: string | null;
+    /**
+     * Markdown instruction content for the skill.
+     *
+     * Required.
+     */
+    content: string;
+    /**
+     * Optional folder path for organizing skills. Use `null` to clear this field
+     * when updating an existing skill.
+     */
+    path?: string | null;
+    /**
+     * Whether the skill is active or inactive.
+     *
+     * Required.
+     */
+    status: CustomSkillStatus;
+    /**
+     * Skill visibility. `user` creates a personal skill; `company` creates a
+     * company skill.
+     *
+     * Optional create-time visibility. Do not set when updating an existing
+     * skill; use `CustomSkill.loadFromExisting(...)` so the extracted value can
+     * round-trip unchanged.
+     */
+    sourceType?: CustomSkillSourceType;
+}
+/**
+ * Defines a Rippling AI Custom Skill and registers it with the manifest.
+ */
+export declare class CustomSkill {
+    static readonly componentType: "CUSTOM_SKILL";
+    static toDeletionIdentifier(sourceSkillId: string): ManifestComponentDeletion;
+    private readonly _sourceSkillId;
+    private _name;
+    private _description;
+    private _content;
+    private _path;
+    private _status;
+    private _sourceType;
+    /**
+     * @param scope - The manifest to register this skill with.
+     * @param props - Initialization properties.
+     */
+    constructor(scope: ManifestScope, props: CustomSkillProps);
+    /**
+     * Loads this skill from the active existing-manifest JSON context.
+     */
+    static loadFromExisting(sourceSkillId: string, options?: ExistingManifestContextOptions): CustomSkill;
+    /** @internal Hydrates a custom skill from existing manifest wire JSON. */
+    static _fromExistingComponent(scope: ManifestScope, component: Record<string, any>): CustomSkill;
+    /**
+     * Returns this skill's source-side manifest identifier. New skills use a
+     * generated temporary handle; extracted skills use their database UUID.
+     */
+    getSourceSkillId(): string;
+    /**
+     * Replaces the display name for this skill.
+     */
+    setName(name: string): this;
+    /**
+     * Replaces the description for this skill. Pass `null` to clear it.
+     */
+    setDescription(description: string | null): this;
+    /**
+     * Replaces the plaintext markdown instruction content for this skill.
+     */
+    setContent(content: string): this;
+    /**
+     * Replaces the optional folder path for this skill. Pass `null` to clear it,
+     * or `undefined` to omit it from the serialized manifest.
+     */
+    setPath(path: string | null | undefined): this;
+    /**
+     * Replaces whether this skill is active or inactive.
+     */
+    setStatus(status: CustomSkillStatus): this;
+    /**
+     * Serializes this skill to the wire format consumed by the manifest install endpoint.
+     */
+    toDict(): Record<string, any>;
+}
+//# sourceMappingURL=custom-skill.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"custom-skill.d.ts","sourceRoot":"","sources":["../../src/lib/manifest/custom-skill.ts"],"names":[],"mappings":"AACA,OAAO,EAA8B,KAAK,8BAA8B,EAAE,uCAAoC;AAC9G,OAAO,KAAK,EAAE,yBAAyB,EAAE,aAAa,EAAE,8BAA2B;AAGnF,MAAM,MAAM,iBAAiB,GAAG,QAAQ,GAAG,UAAU,CAAC;AACtD,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG,SAAS,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;OAUG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;OAIG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB;;;;OAIG;IACH,MAAM,EAAE,iBAAiB,CAAC;IAC1B;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED;;GAEG;AACH,qBAAa,WAAW;IACtB,MAAM,CAAC,QAAQ,CAAC,aAAa,EAAG,cAAc,CAAU;IAExD,MAAM,CAAC,oBAAoB,CAAC,aAAa,EAAE,MAAM,GAAG,yBAAyB;IAO7E,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAS;IACxC,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,YAAY,CAA4B;IAChD,OAAO,CAAC,QAAQ,CAAS;IACzB,OAAO,CAAC,KAAK,CAA4B;IACzC,OAAO,CAAC,OAAO,CAAoB;IACnC,OAAO,CAAC,WAAW,CAAoC;IAEvD;;;OAGG;gBACS,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,gBAAgB;IAiBzD;;OAEG;IACH,MAAM,CAAC,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,GAAE,8BAAmC,GAAG,WAAW;IAIzG,0EAA0E;IAC1E,MAAM,CAAC,sBAAsB,CAAC,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,WAAW;IAyBhG;;;OAGG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAK3B;;OAEG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAKhD;;OAEG;IACH,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKjC;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,IAAI;IAK9C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IAK1C;;OAEG;IACH,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAa9B"}