@wisemen/nestjs-custom-fields 0.0.0 → 0.0.1

package/LICENSE.md

@@ -0,0 +1,59 @@
+# PolyForm Strict License 1.0.0
+
+<https://polyformproject.org/licenses/strict/1.0.0>
+
+## Acceptance
+
+In order to get any license under these terms, you must agree to them as both strict obligations and conditions to all your licenses.
+
+## Copyright License
+
+The licensor grants you a copyright license for the software to do everything you might do with the software that would otherwise infringe the licensor's copyright in it for any permitted purpose, other than distributing the software or making changes or new works based on the software.
+
+## Patent License
+
+The licensor grants you a patent license for the software that covers patent claims the licensor can license, or becomes able to license, that you would infringe by using the software.
+
+## Noncommercial Purposes
+
+Any noncommercial purpose is a permitted purpose.
+
+## Personal Uses
+
+Personal use for research, experiment, and testing for the benefit of public knowledge, personal study, private entertainment, hobby projects, amateur pursuits, or religious observance, without any anticipated commercial application, is use for a permitted purpose.
+
+## Noncommercial Organizations
+
+Use by any charitable organization, educational institution, public research organization, public safety or health organization, environmental protection organization, or government institution is use for a permitted purpose regardless of the source of funding or obligations resulting from the funding.
+
+## Fair Use
+
+You may have "fair use" rights for the software under the law. These terms do not limit them.
+
+## No Other Rights
+
+These terms do not allow you to sublicense or transfer any of your licenses to anyone else, or prevent the licensor from granting licenses to anyone else.  These terms do not imply any other licenses.
+
+## Patent Defense
+
+If you make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+## Violations
+
+The first time you are notified in writing that you have violated any of these terms, or done anything with the software not covered by your licenses, your licenses can nonetheless continue if you come into full compliance with these terms, and take practical steps to correct past violations, within 32 days of receiving notice.  Otherwise, all your licenses end immediately.
+
+## No Liability
+
+***As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.***
+
+## Definitions
+
+The **licensor** is the individual or entity offering these terms, and the **software** is the software the licensor makes available under these terms.
+
+**You** refers to the individual or entity agreeing to these terms.
+
+**Your company** is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization.  **Control** means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise.  Control can be direct or indirect.
+
+**Your licenses** are all the licenses granted to you for the software under these terms.
+
+**Use** means anything you do with the software requiring one of your licenses.

package/README.md

@@ -0,0 +1,279 @@
+# @wisemen/nestjs-custom-fields
+
+Custom field definitions and values for NestJS applications with TypeORM
+persistence, DTO support, and runtime validation.
+
+Custom field definitions are developer-managed. This package does not target
+end-user managed custom field creation.
+
+It is intended that custom field definitions are read-only for users.
+Creating, updating, and deleting definitions is handled manually by developers
+through migrations or `playground.ts` scripts.
+
+Definition uniqueness is scoped by `entityType`. For non-tenant definitions,
+`key` must be unique per `entityType`. For tenant-scoped definitions,
+`key + tenantUuid` must be unique per `entityType`.
+
+## Step 1: Register The Exported Entity And Create The Table
+
+This package already exports the effective `CustomFieldDefinition` TypeORM
+entity. Add it to your datasource entities yourself so TypeORM knows about the
+table metadata. After that, generate and run a migration so the table and the
+exported entity's partial unique indexes are created in your database.
+
+```ts
+import { DataSource } from 'typeorm'
+import { CustomFieldDefinition } from '@wisemen/nestjs-custom-fields'
+
+const datasource = new DataSource({
+  entities: ['dist/src/**/*.entity.js', CustomFieldDefinition]
+})
+```
+
+## Step 2: Define Definitions And Insert Them In The Database
+
+Create a definition with `customFieldDefinition(...)`, then insert it yourself.
+The package does not discover definitions automatically. At the moment this is
+mainly done through a migration or through `playground.ts`.
+
+For persisted definitions, `tenantUuid` is part of the definition shape and
+should be `null` for non-tenant definitions or a tenant UUID for tenant-scoped
+definitions. This is different from repository lookups, where `tenantUuid` is
+optional and can simply be omitted.
+
+`key` uniqueness is enforced per `entityType`. Use a unique `key` for global
+definitions, and a unique `key + tenantUuid` combination for tenant-specific
+definitions.
+
+It is recommended to define your `entityType` values in an enum instead of
+repeating string literals across your application.
+
+```ts
+import type { INestApplicationContext } from '@nestjs/common'
+import { NestFactory } from '@nestjs/core'
+import { JobContainer } from '@wisemen/app-container/fastify'
+import { LocalizedString } from '@wisemen/localized-string'
+import { DataSource } from 'typeorm'
+import {
+  CustomFieldDefinition,
+  CustomFieldType,
+  customFieldDefinition
+} from '@wisemen/nestjs-custom-fields'
+
+enum CustomFieldEntityType {
+  TICKET = 'ticket'
+}
+
+export class Playground extends JobContainer {
+  async bootstrap(): Promise<INestApplicationContext> {
+    return await NestFactory.createApplicationContext(PlayGroundModule)
+  }
+
+  async execute(app: INestApplicationContext): Promise<void> {
+    const priorityField = customFieldDefinition(CustomFieldType.SINGLE_SELECT, {
+      tenantUuid: null,
+      entityType: CustomFieldEntityType.TICKET,
+      key: 'priority',
+      label: new LocalizedString([{ locale: 'en', value: 'Priority' }]),
+      description: null,
+      isRequired: true,
+      choices: [
+        {
+          value: 'low',
+          order: 1,
+          label: new LocalizedString([{ locale: 'en', value: 'Low' }])
+        },
+        {
+          value: 'high',
+          order: 2,
+          label: new LocalizedString([{ locale: 'en', value: 'High' }])
+        }
+      ]
+    })
+
+    await app.get(DataSource).manager.insert(CustomFieldDefinition, priorityField)
+  }
+}
+```
+
+## Step 3: Store Values On The Entity With The Custom Column
+
+Resolved custom field values live on your own entity. Use
+`@CustomFieldValueColumn()` for the persisted values column.
+
+```ts
+import { Entity, PrimaryGeneratedColumn } from 'typeorm'
+import {
+  CustomFieldValueColumn,
+  type CustomFieldValue
+} from '@wisemen/nestjs-custom-fields'
+
+@Entity()
+export class Ticket {
+  @PrimaryGeneratedColumn('uuid')
+  uuid: string
+
+  @CustomFieldValueColumn({ nullable: true })
+  customFields: CustomFieldValue[] | null
+}
+```
+
+## Step 4: Receive And Show Values With DTOs
+
+Requests and responses use the DTO layer from this package. For incoming
+payloads, use `CustomFieldValueDto` with `@IsCustomFields()`. For outgoing
+payloads, map stored values back with `CustomFieldValueDto.from(...)`.
+
+Calling `parse()` on a DTO turns the transport-friendly input into the domain
+custom field value shape, including richer value objects when needed. For
+example, a `MonetaryDto` is parsed into the package's monetary value object
+instead of staying a plain JSON structure.
+
+```ts
+import { ApiProperty } from '@nestjs/swagger'
+import {
+  CustomFieldValueApiExtraModels,
+  CustomFieldValueDto,
+  CustomFieldValueDtoApiProperty,
+  IsCustomFields
+} from '@wisemen/nestjs-custom-fields'
+
+@CustomFieldValueApiExtraModels()
+export class UpdateTicketCommand {
+  @CustomFieldValueDtoApiProperty({ isArray: true })
+  @IsCustomFields()
+  customFields: CustomFieldValueDto[]
+}
+
+@CustomFieldValueApiExtraModels()
+export class TicketResponseDto {
+  @ApiProperty({ type: String, format: 'uuid' })
+  uuid: string
+
+  @CustomFieldValueDtoApiProperty({ isArray: true })
+  customFields: CustomFieldValueDto[]
+
+  constructor(ticket: Ticket) {
+    this.uuid = ticket.uuid
+    this.customFields = ticket.customFields?.map(value => CustomFieldValueDto.from(value)) ?? []
+  }
+}
+```
+
+`@IsCustomFields()` already applies array validation, nested DTO validation,
+and uniqueness on `definitionUuid`.
+
+```ts
+import {
+  CustomFieldType,
+  MonetaryCustomFieldValueDto
+} from '@wisemen/nestjs-custom-fields'
+
+const dto = new MonetaryCustomFieldValueDto()
+dto.definitionUuid = definitionUuid
+dto.value = {
+  amount: '12.50',
+  currency: 'EUR',
+  precision: 2
+}
+
+const parsed = dto.parse()
+
+// parsed is now a domain custom field value object:
+// {
+//   definitionUuid,
+//   type: CustomFieldType.MONETARY,
+//   value: dto.value.parse()
+// }
+```
+
+## Step 5: Retrieve Definitions For Validation
+
+When you process submitted values, retrieve the matching definitions through
+`CustomFieldDefinitionsRepository` and validate against them with
+`validateCustomFieldValues(...)`. If you also want to return definitions from
+an API, map the same repository results with `CustomFieldDefinitionResponse`.
+To inject the repository, register `CustomFieldDefinitionRepositoryModule` in
+the Nest module that owns your use case or controller.
+
+`validateCustomFieldValues(...)` throws `CustomFieldValueValidationError` when
+the submitted values do not match the definitions. In controllers, document
+that error according to the `@wisemen/api-error` package pattern by registering
+it with `@ApiErrorResponse(...)`.
+
+```ts
+import { Module } from '@nestjs/common'
+import { CustomFieldDefinitionRepositoryModule } from '@wisemen/nestjs-custom-fields'
+
+@Module({
+  imports: [CustomFieldDefinitionRepositoryModule],
+  providers: [UpdateTicketCustomFieldsUseCase]
+})
+export class UpdateTicketModule {}
+```
+
+On repository lookups, `tenantUuid` is optional. Omit it to work with
+non-tenant definitions, or set it to retrieve tenant-specific definitions in a
+multi-tenant setup.
+
+After DTO parsing, validate the resolved values against the definitions that
+apply for that entity and tenant. This is the runtime check that enforces the
+definition rules.
+
+```ts
+import { Injectable } from '@nestjs/common'
+import {
+  CustomFieldDefinitionResponse,
+  CustomFieldDefinitionsRepository,
+  validateCustomFieldValues
+} from '@wisemen/nestjs-custom-fields'
+
+enum CustomFieldEntityType {
+  TICKET = 'ticket'
+}
+
+@Injectable()
+export class UpdateTicketCustomFieldsUseCase {
+  constructor(
+    private readonly repository: CustomFieldDefinitionsRepository
+  ) {}
+
+  async execute(command: UpdateTicketCommand): Promise<void> {
+    const definitions = await this.repository.findDefinitions({
+      entityType: CustomFieldEntityType.TICKET
+    })
+
+    const values = command.customFields.map(value => value.parse())
+
+    validateCustomFieldValues(definitions, values)
+
+    // Persist the validated values here.
+  }
+}
+```
+
+If you want to return definitions from a read endpoint, use
+`CustomFieldDefinitionResponse` to map the repository results into the response
+shape:
+
+```ts
+async function findTicketDefinitions(
+  repository: CustomFieldDefinitionsRepository
+): Promise<CustomFieldDefinitionResponse[]> {
+  const definitions = await repository.findDefinitions({
+    entityType: CustomFieldEntityType.TICKET
+  })
+
+  return definitions.map(definition => new CustomFieldDefinitionResponse(definition))
+}
+```
+
+```ts
+import { ApiErrorResponse } from '@wisemen/api-error'
+import { CustomFieldValueValidationError } from '@wisemen/nestjs-custom-fields'
+
+@ApiErrorResponse(CustomFieldValueValidationError)
+async update(...): Promise<void> {
+  // controller logic
+}
+```

package/dist/custom-field-choice.d.ts

@@ -0,0 +1,6 @@
+import { LocalizedString } from '@wisemen/localized-string';
+export interface CustomFieldChoice {
+    value: string;
+    label: LocalizedString;
+    order: number;
+}

package/dist/custom-field-choice.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=custom-field-choice.js.map

package/dist/custom-field-choice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-choice.js","sourceRoot":"","sources":["../lib/custom-field-choice.ts"],"names":[],"mappings":""}

package/dist/custom-field-definition.d.ts

@@ -0,0 +1,41 @@
+import { CustomFieldChoice } from '#src/custom-field-choice.js';
+import { CustomFieldDefinitionUuid } from '#src/custom-field-definition.uuid.js';
+import { CustomFieldRules, CustomFieldRulesByType } from '#src/custom-field-rules.js';
+import { CustomFieldChoicesModeByType, CustomFieldRulesModeByType } from '#src/custom-field-type-contract.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import { LocalizedString } from '@wisemen/localized-string';
+export interface CustomFieldDefinitionData {
+    uuid: CustomFieldDefinitionUuid;
+    tenantUuid: string | null;
+    entityType: string;
+    key: string;
+    label: LocalizedString;
+    description: LocalizedString | null;
+    type: CustomFieldType;
+    isRequired: boolean;
+    choices: CustomFieldChoice[] | null;
+    rules: CustomFieldRules | null;
+}
+type BaseCustomFieldDefinitionFields<T extends CustomFieldType> = Omit<CustomFieldDefinitionData, 'type' | 'choices' | 'rules'> & {
+    type: T;
+};
+type CustomFieldDefinitionChoicesField<T extends CustomFieldType> = CustomFieldChoicesModeByType<T> extends 'required' ? {
+    choices: CustomFieldChoice[];
+} : {
+    choices: null;
+};
+type CustomFieldDefinitionRulesField<T extends CustomFieldType> = CustomFieldRulesModeByType<T> extends 'required' ? {
+    rules: CustomFieldRulesByType<T>;
+} : CustomFieldRulesModeByType<T> extends 'optional' ? {
+    rules: CustomFieldRulesByType<T> | null;
+} : {
+    rules: null;
+};
+export type CustomFieldDefinitionFieldsByType<T extends CustomFieldType> = BaseCustomFieldDefinitionFields<T> & CustomFieldDefinitionChoicesField<T> & CustomFieldDefinitionRulesField<T>;
+export type ResolvedCustomFieldDefinitionFields = {
+    [T in CustomFieldType]: CustomFieldDefinitionFieldsByType<T>;
+}[CustomFieldType];
+export type CustomFieldDefinitionFieldsMap = {
+    [T in CustomFieldType]: CustomFieldDefinitionFieldsByType<T>;
+};
+export {};

package/dist/custom-field-definition.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=custom-field-definition.js.map

package/dist/custom-field-definition.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-definition.js","sourceRoot":"","sources":["../lib/custom-field-definition.ts"],"names":[],"mappings":""}

package/dist/custom-field-definition.uuid.d.ts

@@ -0,0 +1,7 @@
+export type Uuid<Brand extends string> = string & {
+    readonly __brand: 'uuid';
+} & {
+    readonly __uuid: Brand;
+};
+export declare function generateUuid<Brand extends Uuid<string> | null>(): Exclude<Brand, null>;
+export type CustomFieldDefinitionUuid = Uuid<'CustomFieldDefinition'>;

package/dist/custom-field-definition.uuid.js

@@ -0,0 +1,4 @@
+export function generateUuid() {
+    return crypto.randomUUID();
+}
+//# sourceMappingURL=custom-field-definition.uuid.js.map

package/dist/custom-field-definition.uuid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-definition.uuid.js","sourceRoot":"","sources":["../lib/custom-field-definition.uuid.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,YAAY;IAC1B,OAAO,MAAM,CAAC,UAAU,EAA0B,CAAA;AACpD,CAAC"}

package/dist/custom-field-rules.d.ts

@@ -0,0 +1,28 @@
+import { CustomFieldType } from './enum/custom-field-type.enum.js';
+import type { CustomFieldRuleConfigByType } from './custom-field-type-contract.js';
+import type { BooleanCustomFieldRules as BooleanCustomFieldRulesModel } from '#src/custom-field-types/boolean/boolean.rules.js';
+import type { DateCustomFieldRules as DateCustomFieldRulesModel } from '#src/custom-field-types/date/date.rules.js';
+import type { MonetaryCustomFieldRules as MonetaryCustomFieldRulesModel } from '#src/custom-field-types/monetary/monetary.rules.js';
+import type { MultiSelectCustomFieldRules as MultiSelectCustomFieldRulesModel } from '#src/custom-field-types/multi-select/multi-select.rules.js';
+import type { NumberCustomFieldRules as NumberCustomFieldRulesModel } from '#src/custom-field-types/number/number.rules.js';
+import type { SelectCustomFieldRules as SelectCustomFieldRulesModel } from '#src/custom-field-types/single-select/single-select.rules.js';
+import type { TextArrayCustomFieldRules as TextArrayCustomFieldRulesModel } from '#src/custom-field-types/text-array/text-array.rules.js';
+import type { TextCustomFieldRules as TextCustomFieldRulesModel } from '#src/custom-field-types/text/text.rules.js';
+import type { TimestampCustomFieldRules as TimestampCustomFieldRulesModel } from '#src/custom-field-types/timestamp/timestamp.rules.js';
+type CustomFieldRulesFor<T extends CustomFieldType> = {
+    type: T;
+} & CustomFieldRuleConfigByType<T>;
+export type TextCustomFieldRules = TextCustomFieldRulesModel;
+export type TextArrayCustomFieldRules = TextArrayCustomFieldRulesModel;
+export type NumberCustomFieldRules = NumberCustomFieldRulesModel;
+export type BooleanCustomFieldRules = BooleanCustomFieldRulesModel;
+export type DateCustomFieldRules = DateCustomFieldRulesModel;
+export type TimestampCustomFieldRules = TimestampCustomFieldRulesModel;
+export type SelectCustomFieldRules = SelectCustomFieldRulesModel;
+export type MultiSelectCustomFieldRules = MultiSelectCustomFieldRulesModel;
+export type MonetaryCustomFieldRules = MonetaryCustomFieldRulesModel;
+export type CustomFieldRulesByType<T extends CustomFieldType> = CustomFieldRulesFor<T>;
+export type CustomFieldRules = {
+    [T in CustomFieldType]: CustomFieldRulesByType<T>;
+}[CustomFieldType];
+export {};

package/dist/custom-field-rules.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=custom-field-rules.js.map

package/dist/custom-field-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-rules.js","sourceRoot":"","sources":["../lib/custom-field-rules.ts"],"names":[],"mappings":""}

package/dist/custom-field-type-contract.d.ts

@@ -0,0 +1,38 @@
+import type { BooleanCustomFieldTypeContract } from '#src/custom-field-types/boolean/boolean.contract.js';
+import type { DateCustomFieldTypeContract } from '#src/custom-field-types/date/date.contract.js';
+import type { MonetaryCustomFieldTypeContract } from '#src/custom-field-types/monetary/monetary.contract.js';
+import type { MultiSelectCustomFieldTypeContract } from '#src/custom-field-types/multi-select/multi-select.contract.js';
+import type { NumberCustomFieldTypeContract } from '#src/custom-field-types/number/number.contract.js';
+import type { SingleSelectCustomFieldTypeContract } from '#src/custom-field-types/single-select/single-select.contract.js';
+import type { TextArrayCustomFieldTypeContract } from '#src/custom-field-types/text-array/text-array.contract.js';
+import type { TextCustomFieldTypeContract } from '#src/custom-field-types/text/text.contract.js';
+import type { TimestampCustomFieldTypeContract } from '#src/custom-field-types/timestamp/timestamp.contract.js';
+import { CustomFieldType } from './enum/custom-field-type.enum.js';
+type Satisfies<T extends U, U> = T;
+export type CustomFieldRulesMode = 'required' | 'optional' | 'none';
+export type CustomFieldChoicesMode = 'required' | 'none';
+export interface CustomFieldTypeContractBase {
+    value: unknown;
+    columnValue: unknown;
+    rules: unknown;
+    rulesMode: CustomFieldRulesMode;
+    choicesMode: CustomFieldChoicesMode;
+}
+export type DefineContract<T extends CustomFieldTypeContractBase & Record<Exclude<keyof T, keyof CustomFieldTypeContractBase>, never>> = T;
+export type CustomFieldTypeContract = Satisfies<{
+    [CustomFieldType.TEXT]: TextCustomFieldTypeContract;
+    [CustomFieldType.TEXT_ARRAY]: TextArrayCustomFieldTypeContract;
+    [CustomFieldType.NUMBER]: NumberCustomFieldTypeContract;
+    [CustomFieldType.BOOLEAN]: BooleanCustomFieldTypeContract;
+    [CustomFieldType.TIMESTAMP]: TimestampCustomFieldTypeContract;
+    [CustomFieldType.DATE]: DateCustomFieldTypeContract;
+    [CustomFieldType.SINGLE_SELECT]: SingleSelectCustomFieldTypeContract;
+    [CustomFieldType.MULTI_SELECT]: MultiSelectCustomFieldTypeContract;
+    [CustomFieldType.MONETARY]: MonetaryCustomFieldTypeContract;
+}, Record<CustomFieldType, CustomFieldTypeContractBase>>;
+export type CustomFieldDomainValueByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['value'];
+export type CustomFieldColumnValueByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['columnValue'];
+export type CustomFieldRuleConfigByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['rules'];
+export type CustomFieldRulesModeByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['rulesMode'];
+export type CustomFieldChoicesModeByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['choicesMode'];
+export {};

package/dist/custom-field-type-contract.js

@@ -0,0 +1,2 @@
+import { CustomFieldType } from './enum/custom-field-type.enum.js';
+//# sourceMappingURL=custom-field-type-contract.js.map

package/dist/custom-field-type-contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom-field-type-contract.js","sourceRoot":"","sources":["../lib/custom-field-type-contract.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,eAAe,EAAE,MAAM,kCAAkC,CAAA"}

package/dist/custom-field-types/boolean/boolean.contract.d.ts

@@ -0,0 +1,8 @@
+import type { DefineContract } from '#src/custom-field-type-contract.js';
+export type BooleanCustomFieldTypeContract = DefineContract<{
+    value: boolean;
+    columnValue: boolean;
+    rules: Record<never, never>;
+    rulesMode: 'none';
+    choicesMode: 'none';
+}>;

package/dist/custom-field-types/boolean/boolean.contract.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=boolean.contract.js.map

package/dist/custom-field-types/boolean/boolean.contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.contract.js","sourceRoot":"","sources":["../../../lib/custom-field-types/boolean/boolean.contract.ts"],"names":[],"mappings":""}

package/dist/custom-field-types/boolean/boolean.custom-field-definition.factory.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/custom-field-types/boolean/boolean.custom-field-definition.factory.unit.test.js

@@ -0,0 +1,21 @@
+import { describe, it } from 'node:test';
+import { expect } from 'expect';
+import { LocalizedString } from '@wisemen/localized-string';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import { customFieldDefinition } from '#src/factory/custom-field-definition.factory.js';
+describe('boolean customFieldDefinition', () => {
+    it('creates a boolean custom field definition', () => {
+        const definition = customFieldDefinition(CustomFieldType.BOOLEAN, {
+            tenantUuid: null,
+            entityType: 'invoice',
+            key: 'approved',
+            label: new LocalizedString([{ locale: 'en', value: 'Approved' }]),
+            description: null,
+            isRequired: false
+        });
+        expect(definition.type).toBe(CustomFieldType.BOOLEAN);
+        expect(definition.choices).toBeNull();
+        expect(definition.rules).toBeNull();
+    });
+});
+//# sourceMappingURL=boolean.custom-field-definition.factory.unit.test.js.map

package/dist/custom-field-types/boolean/boolean.custom-field-definition.factory.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.custom-field-definition.factory.unit.test.js","sourceRoot":"","sources":["../../../lib/custom-field-types/boolean/boolean.custom-field-definition.factory.unit.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAA;AAEvF,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACnD,MAAM,UAAU,GAAG,qBAAqB,CAAC,eAAe,CAAC,OAAO,EAAE;YAChE,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;YACrB,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;YACjE,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;QAEF,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAA;QACrD,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAA;QACrC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAA;IACrC,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.d.ts

@@ -0,0 +1 @@
+export declare function validateBooleanCustomFieldValue(): void;

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.js

@@ -0,0 +1,2 @@
+export function validateBooleanCustomFieldValue() { }
+//# sourceMappingURL=boolean.custom-field-value.validator.js.map

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.custom-field-value.validator.js","sourceRoot":"","sources":["../../../lib/custom-field-types/boolean/boolean.custom-field-value.validator.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,+BAA+B,KAAU,CAAC"}

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.unit.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.unit.test.js

@@ -0,0 +1,24 @@
+import { describe, it } from 'node:test';
+import { LocalizedString } from '@wisemen/localized-string';
+import { customFieldDefinition } from '#src/factory/custom-field-definition.factory.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import { validateCustomFieldValue } from '#src/validators/custom-field-value.validator.js';
+import { expect } from 'expect';
+describe('boolean validateCustomFieldValue', () => {
+    it('accepts a boolean custom field value', () => {
+        const definition = customFieldDefinition(CustomFieldType.BOOLEAN, {
+            tenantUuid: null,
+            entityType: 'invoice',
+            key: 'approved',
+            label: new LocalizedString([{ locale: 'en', value: 'Approved' }]),
+            description: null,
+            isRequired: false
+        });
+        expect(() => validateCustomFieldValue(definition, {
+            definitionUuid: definition.uuid,
+            type: CustomFieldType.BOOLEAN,
+            value: true
+        })).not.toThrow();
+    });
+});
+//# sourceMappingURL=boolean.custom-field-value.validator.unit.test.js.map

package/dist/custom-field-types/boolean/boolean.custom-field-value.validator.unit.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.custom-field-value.validator.unit.test.js","sourceRoot":"","sources":["../../../lib/custom-field-types/boolean/boolean.custom-field-value.validator.unit.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,WAAW,CAAA;AACxC,OAAO,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAA;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAC1F,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B,QAAQ,CAAC,kCAAkC,EAAE,GAAG,EAAE;IAChD,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,UAAU,GAAG,qBAAqB,CAAC,eAAe,CAAC,OAAO,EAAE;YAChE,UAAU,EAAE,IAAI;YAChB,UAAU,EAAE,SAAS;YACrB,GAAG,EAAE,UAAU;YACf,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;YACjE,WAAW,EAAE,IAAI;YACjB,UAAU,EAAE,KAAK;SAClB,CAAC,CAAA;QAEF,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,UAAU,EAAE;YAChD,cAAc,EAAE,UAAU,CAAC,IAAI;YAC/B,IAAI,EAAE,eAAe,CAAC,OAAO;YAC7B,KAAK,EAAE,IAAI;SACZ,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

package/dist/custom-field-types/boolean/boolean.definition-validation.d.ts

@@ -0,0 +1,7 @@
+import type { ResolvedCustomFieldDefinitionFields } from '#src/custom-field-definition.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+type BooleanCustomFieldDefinition = Extract<ResolvedCustomFieldDefinitionFields, {
+    type: CustomFieldType.BOOLEAN;
+}>;
+export declare function validateBooleanCustomFieldDefinition(definition: BooleanCustomFieldDefinition): void;
+export {};

package/dist/custom-field-types/boolean/boolean.definition-validation.js

@@ -0,0 +1,10 @@
+import { CustomFieldDefinitionError } from '#src/errors/custom-field-definition.error.js';
+export function validateBooleanCustomFieldDefinition(definition) {
+    if (definition.choices !== null) {
+        throw new CustomFieldDefinitionError('Only select custom fields can define choices');
+    }
+    if (definition.rules !== null) {
+        throw new CustomFieldDefinitionError('Boolean custom field can not define rules');
+    }
+}
+//# sourceMappingURL=boolean.definition-validation.js.map

package/dist/custom-field-types/boolean/boolean.definition-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"boolean.definition-validation.js","sourceRoot":"","sources":["../../../lib/custom-field-types/boolean/boolean.definition-validation.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAA;AAKzF,MAAM,UAAU,oCAAoC,CAAC,UAAwC;IAC3F,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAChC,MAAM,IAAI,0BAA0B,CAAC,8CAA8C,CAAC,CAAA;IACtF,CAAC;IAED,IAAI,UAAU,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;QAC9B,MAAM,IAAI,0BAA0B,CAAC,2CAA2C,CAAC,CAAA;IACnF,CAAC;AACH,CAAC"}

package/dist/custom-field-types/boolean/boolean.dto.d.ts

@@ -0,0 +1,9 @@
+import { BaseCustomFieldValueDto } from '#src/dto/base-custom-field-value.dto.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import { BooleanCustomFieldValue } from '#src/custom-field-types/boolean/boolean.value.js';
+export declare class BooleanCustomFieldValueDto extends BaseCustomFieldValueDto {
+    type: CustomFieldType.BOOLEAN;
+    value: boolean;
+    parse(): BooleanCustomFieldValue;
+    static from(customFieldValue: BooleanCustomFieldValue): BooleanCustomFieldValueDto;
+}