Skip to content

PermissionSetBuildConfigSchema

const PermissionSetBuildConfigSchema: ZodPreprocess<ZodObject<{ fieldPermissions: ZodOptional<ZodRecord<ZodString, ZodObject<{ editable: ZodOptional<ZodBoolean>; readable: ZodOptional<ZodBoolean>; }, $strip>>>; hasActivationRequired: ZodDefault<ZodOptional<ZodBoolean>>; objectPermissions: ZodOptional<ZodRecord<ZodString, ZodPreprocess<ZodObject<{ allowCreate: ZodOptional<ZodBoolean>; allowDelete: ZodOptional<ZodBoolean>; allowEdit: ZodOptional<ZodBoolean>; allowRead: ZodOptional<ZodBoolean>; modifyAllRecords: ZodOptional<ZodBoolean>; viewAllFields: ZodOptional<ZodBoolean>; viewAllRecords: ZodOptional<ZodBoolean>; }, $strip>, unknown>>>; recordTypeVisibilities: ZodOptional<ZodRecord<ZodString, ZodObject<{ visible: ZodOptional<ZodBoolean>; }, $strip>>>; tabSettings: ZodOptional<ZodRecord<ZodString, ZodPreprocess<ZodObject<{ visibility: ZodOptional<ZodEnum<{ Available: …; None: …; Visible: …; }>>; }, $strip>, unknown>>>; userPermissions: ZodOptional<ZodRecord<ZodString, ZodBoolean>>; }, $strip>, unknown>

Defined in: packages/simply-permissions-core/src/schemas/permissionSetBuildConfig.ts:87

Schema for a permission set’s overrides: the file passed to simply permissions build --config, or a PermissionSetBuildFileSchema’s config. Each section is named for the PermissionSet element it sets. objectPermissions, fieldPermissions, tabSettings, and recordTypeVisibilities are keyed by Object / Object.Field / Tab / Object.RecordType API names; hasActivationRequired applies to the permission set as a whole.