@wisemen/nestjs-custom-fields 4.2.1 → 5.0.0

package/README.md

@@ -162,6 +162,76 @@ you `switch` over `CustomFieldType` or build a `Record<CustomFieldType, ...>`;
 those no longer type-check until the new case is added. No database migration is
 needed: `type` is stored as `varchar` and `rules` as `jsonb`.
 
+### Progress Fields
+
+Use `CustomFieldType.PROGRESS` for a progress bar. The definition's `choices`
+are the bar's segments, and `rules` set a `ProgressCustomFieldColor` for every
+choice and an optional `icon`. The value is `{ total?, segments }`: `segments`
+is a list of `{ key, amount }`, where `key` is a choice value and `amount` is a
+finite number of at least 0. Keys can appear only once. A missing segment
+counts as 0, so `{ segments: [] }` is a valid value.
+
+Each segment fills `amount / total` of the bar. Set `total` when it is known,
+such as `100` for a percentage: it must be greater than 0, the amounts can not
+add up to more than it, and the rest of the bar stays empty. Leave `total` out
+when it is not known: the total is then the sum of the amounts and the bar is
+always fully filled.
+
+```ts
+import { ProgressCustomFieldColor } from '@wisemen/nestjs-custom-fields'
+
+const tasksField = customFieldDefinition(CustomFieldType.PROGRESS, {
+  tenantUuid: null,
+  entityType: CustomFieldEntityType.TICKET,
+  key: 'tasks',
+  label: new LocalizedString([{ locale: 'en', value: 'Tasks' }]),
+  description: null,
+  isRequired: false,
+  choices: [
+    {
+      value: 'completed',
+      order: 1,
+      label: new LocalizedString([{ locale: 'en', value: 'Completed' }])
+    },
+    {
+      value: 'in_progress',
+      order: 2,
+      label: new LocalizedString([{ locale: 'en', value: 'In progress' }])
+    }
+  ],
+  rules: {
+    icon: 'tasks',
+    colors: {
+      completed: ProgressCustomFieldColor.SUCCESS,
+      in_progress: ProgressCustomFieldColor.WARNING
+    }
+  }
+})
+
+// 2 completed and 3 in progress, total unknown: 2/5 green, 3/5 yellow
+const value = {
+  segments: [
+    { key: 'completed', amount: 2 },
+    { key: 'in_progress', amount: 3 }
+  ]
+}
+
+// 20% completed: 20/100 green, the rest empty
+const percentage = {
+  total: 100,
+  segments: [{ key: 'completed', amount: 20 }]
+}
+```
+
+The icon is an app-defined string, like `entityType`: the package stores it
+as-is. Leave it out to render the bar without an icon; an empty string is
+rejected.
+
+When upgrading from 4.x to 5.0.0, handle `CustomFieldType.PROGRESS` wherever
+you `switch` over `CustomFieldType` or build a `Record<CustomFieldType, ...>`;
+those no longer type-check until the new case is added. No database migration is
+needed: `type` is stored as `varchar`, and `choices` and `rules` as `jsonb`.
+
 ## Step 3: Store Values On The Entity With The Custom Column
 
 Resolved custom field values live on your own entity. Use

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

@@ -5,6 +5,7 @@ import type { DateCustomFieldRules as DateCustomFieldRulesModel } from '#src/cus
 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 { ProgressCustomFieldRules as ProgressCustomFieldRulesModel } from '#src/custom-field-types/progress/progress.rules.js';
 import type { ReferenceCustomFieldRules as ReferenceCustomFieldRulesModel } from '#src/custom-field-types/reference/reference.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';
@@ -23,6 +24,7 @@ export type SelectCustomFieldRules = SelectCustomFieldRulesModel;
 export type MultiSelectCustomFieldRules = MultiSelectCustomFieldRulesModel;
 export type MonetaryCustomFieldRules = MonetaryCustomFieldRulesModel;
 export type ReferenceCustomFieldRules = ReferenceCustomFieldRulesModel;
+export type ProgressCustomFieldRules = ProgressCustomFieldRulesModel;
 export type CustomFieldRulesByType<T extends CustomFieldType> = CustomFieldRulesFor<T>;
 export type CustomFieldRules = {
     [T in CustomFieldType]: CustomFieldRulesByType<T>;

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

@@ -3,6 +3,7 @@ import type { DateCustomFieldTypeContract } from '#src/custom-field-types/date/d
 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 { ProgressCustomFieldTypeContract } from '#src/custom-field-types/progress/progress.contract.js';
 import type { ReferenceCustomFieldTypeContract } from '#src/custom-field-types/reference/reference.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';
@@ -31,6 +32,7 @@ export type CustomFieldTypeContract = Satisfies<{
     [CustomFieldType.MULTI_SELECT]: MultiSelectCustomFieldTypeContract;
     [CustomFieldType.MONETARY]: MonetaryCustomFieldTypeContract;
     [CustomFieldType.REFERENCE]: ReferenceCustomFieldTypeContract;
+    [CustomFieldType.PROGRESS]: ProgressCustomFieldTypeContract;
 }, Record<CustomFieldType, CustomFieldTypeContractBase>>;
 export type CustomFieldDomainValueByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['value'];
 export type CustomFieldColumnValueByType<T extends CustomFieldType> = CustomFieldTypeContract[T]['columnValue'];

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

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

package/dist/custom-field-types/index.d.ts

@@ -3,6 +3,7 @@ export * from '#src/custom-field-types/date/index.js';
 export * from '#src/custom-field-types/monetary/index.js';
 export * from '#src/custom-field-types/multi-select/index.js';
 export * from '#src/custom-field-types/number/index.js';
+export * from '#src/custom-field-types/progress/index.js';
 export * from '#src/custom-field-types/reference/index.js';
 export * from '#src/custom-field-types/single-select/index.js';
 export * from '#src/custom-field-types/text-array/index.js';

package/dist/custom-field-types/index.js

@@ -3,6 +3,7 @@ export * from '#src/custom-field-types/date/index.js';
 export * from '#src/custom-field-types/monetary/index.js';
 export * from '#src/custom-field-types/multi-select/index.js';
 export * from '#src/custom-field-types/number/index.js';
+export * from '#src/custom-field-types/progress/index.js';
 export * from '#src/custom-field-types/reference/index.js';
 export * from '#src/custom-field-types/single-select/index.js';
 export * from '#src/custom-field-types/text-array/index.js';

package/dist/custom-field-types/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/custom-field-types/index.ts"],"names":[],"mappings":"AAAA,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,2CAA2C,CAAA;AACzD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,yCAAyC,CAAA;AACvD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,gDAAgD,CAAA;AAC9D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,4CAA4C,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../lib/custom-field-types/index.ts"],"names":[],"mappings":"AAAA,cAAc,0CAA0C,CAAA;AACxD,cAAc,uCAAuC,CAAA;AACrD,cAAc,2CAA2C,CAAA;AACzD,cAAc,+CAA+C,CAAA;AAC7D,cAAc,yCAAyC,CAAA;AACvD,cAAc,2CAA2C,CAAA;AACzD,cAAc,4CAA4C,CAAA;AAC1D,cAAc,gDAAgD,CAAA;AAC9D,cAAc,6CAA6C,CAAA;AAC3D,cAAc,uCAAuC,CAAA;AACrD,cAAc,4CAA4C,CAAA"}

package/dist/custom-field-types/progress/index.d.ts

@@ -0,0 +1,7 @@
+export * from '#src/custom-field-types/progress/progress.color.js';
+export * from '#src/custom-field-types/progress/progress.contract.js';
+export * from '#src/custom-field-types/progress/progress.definition-validation.js';
+export * from '#src/custom-field-types/progress/progress.dto.js';
+export * from '#src/custom-field-types/progress/progress.rules.js';
+export * from '#src/custom-field-types/progress/progress.custom-field-value.validator.js';
+export * from '#src/custom-field-types/progress/progress.value.js';

package/dist/custom-field-types/progress/index.js

@@ -0,0 +1,8 @@
+export * from '#src/custom-field-types/progress/progress.color.js';
+export * from '#src/custom-field-types/progress/progress.contract.js';
+export * from '#src/custom-field-types/progress/progress.definition-validation.js';
+export * from '#src/custom-field-types/progress/progress.dto.js';
+export * from '#src/custom-field-types/progress/progress.rules.js';
+export * from '#src/custom-field-types/progress/progress.custom-field-value.validator.js';
+export * from '#src/custom-field-types/progress/progress.value.js';
+//# sourceMappingURL=index.js.map

package/dist/custom-field-types/progress/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/index.ts"],"names":[],"mappings":"AAAA,cAAc,oDAAoD,CAAA;AAClE,cAAc,uDAAuD,CAAA;AACrE,cAAc,oEAAoE,CAAA;AAClF,cAAc,kDAAkD,CAAA;AAChE,cAAc,oDAAoD,CAAA;AAClE,cAAc,2EAA2E,CAAA;AACzF,cAAc,oDAAoD,CAAA"}

package/dist/custom-field-types/progress/progress.color.d.ts

@@ -0,0 +1,25 @@
+export declare enum ProgressCustomFieldColor {
+    MOSS = "moss",
+    GREEN_LIGHT = "green-light",
+    GREEN = "green",
+    TEAL = "teal",
+    CYAN = "cyan",
+    BLUE_LIGHT = "blue-light",
+    BLUE = "blue",
+    BLUE_DARK = "blue-dark",
+    INDIGO = "indigo",
+    VIOLET = "violet",
+    PURPLE = "purple",
+    FUCHSIA = "fuchsia",
+    PINK = "pink",
+    ROSE = "rose",
+    ORANGE_DARK = "orange-dark",
+    ORANGE = "orange",
+    YELLOW = "yellow",
+    ERROR = "error",
+    WARNING = "warning",
+    SUCCESS = "success",
+    INFO = "info",
+    BRAND = "brand",
+    NEUTRAL = "neutral"
+}

package/dist/custom-field-types/progress/progress.color.js

@@ -0,0 +1,27 @@
+export var ProgressCustomFieldColor;
+(function (ProgressCustomFieldColor) {
+    ProgressCustomFieldColor["MOSS"] = "moss";
+    ProgressCustomFieldColor["GREEN_LIGHT"] = "green-light";
+    ProgressCustomFieldColor["GREEN"] = "green";
+    ProgressCustomFieldColor["TEAL"] = "teal";
+    ProgressCustomFieldColor["CYAN"] = "cyan";
+    ProgressCustomFieldColor["BLUE_LIGHT"] = "blue-light";
+    ProgressCustomFieldColor["BLUE"] = "blue";
+    ProgressCustomFieldColor["BLUE_DARK"] = "blue-dark";
+    ProgressCustomFieldColor["INDIGO"] = "indigo";
+    ProgressCustomFieldColor["VIOLET"] = "violet";
+    ProgressCustomFieldColor["PURPLE"] = "purple";
+    ProgressCustomFieldColor["FUCHSIA"] = "fuchsia";
+    ProgressCustomFieldColor["PINK"] = "pink";
+    ProgressCustomFieldColor["ROSE"] = "rose";
+    ProgressCustomFieldColor["ORANGE_DARK"] = "orange-dark";
+    ProgressCustomFieldColor["ORANGE"] = "orange";
+    ProgressCustomFieldColor["YELLOW"] = "yellow";
+    ProgressCustomFieldColor["ERROR"] = "error";
+    ProgressCustomFieldColor["WARNING"] = "warning";
+    ProgressCustomFieldColor["SUCCESS"] = "success";
+    ProgressCustomFieldColor["INFO"] = "info";
+    ProgressCustomFieldColor["BRAND"] = "brand";
+    ProgressCustomFieldColor["NEUTRAL"] = "neutral";
+})(ProgressCustomFieldColor || (ProgressCustomFieldColor = {}));
+//# sourceMappingURL=progress.color.js.map

package/dist/custom-field-types/progress/progress.color.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"progress.color.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/progress.color.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,wBAwBX;AAxBD,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,uDAA2B,CAAA;IAC3B,2CAAe,CAAA;IACf,yCAAa,CAAA;IACb,yCAAa,CAAA;IACb,qDAAyB,CAAA;IACzB,yCAAa,CAAA;IACb,mDAAuB,CAAA;IACvB,6CAAiB,CAAA;IACjB,6CAAiB,CAAA;IACjB,6CAAiB,CAAA;IACjB,+CAAmB,CAAA;IACnB,yCAAa,CAAA;IACb,yCAAa,CAAA;IACb,uDAA2B,CAAA;IAC3B,6CAAiB,CAAA;IACjB,6CAAiB,CAAA;IACjB,2CAAe,CAAA;IACf,+CAAmB,CAAA;IACnB,+CAAmB,CAAA;IACnB,yCAAa,CAAA;IACb,2CAAe,CAAA;IACf,+CAAmB,CAAA;AACrB,CAAC,EAxBW,wBAAwB,KAAxB,wBAAwB,QAwBnC"}

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

@@ -0,0 +1,20 @@
+import type { DefineContract } from '#src/custom-field-type-contract.js';
+import type { ProgressCustomFieldColor } from '#src/custom-field-types/progress/progress.color.js';
+export interface ProgressCustomFieldSegment {
+    key: string;
+    amount: number;
+}
+export interface ProgressCustomFieldData {
+    total?: number;
+    segments: ProgressCustomFieldSegment[];
+}
+export type ProgressCustomFieldTypeContract = DefineContract<{
+    value: ProgressCustomFieldData;
+    columnValue: ProgressCustomFieldData;
+    rules: {
+        icon?: string;
+        colors: Record<string, ProgressCustomFieldColor>;
+    };
+    rulesMode: 'required';
+    choicesMode: 'required';
+}>;

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

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

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

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

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

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

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

@@ -0,0 +1,67 @@
+import { describe, it } from 'node:test';
+import { expect } from 'expect';
+import { LocalizedString } from '@wisemen/localized-string';
+import { CustomFieldDefinitionError } from '#src/errors/custom-field-definition.error.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import { customFieldDefinition } from '#src/factory/custom-field-definition.factory.js';
+import { ProgressCustomFieldColor } from '#src/custom-field-types/progress/progress.color.js';
+const choices = [
+    { value: 'completed', order: 1, label: new LocalizedString([{ locale: 'en', value: 'Completed' }]) },
+    { value: 'in_progress', order: 2, label: new LocalizedString([{ locale: 'en', value: 'In progress' }]) }
+];
+const rules = {
+    icon: 'tasks',
+    colors: {
+        completed: ProgressCustomFieldColor.SUCCESS,
+        in_progress: ProgressCustomFieldColor.WARNING
+    }
+};
+function progressDefinition(overrides = {}) {
+    return customFieldDefinition(CustomFieldType.PROGRESS, {
+        tenantUuid: null,
+        entityType: 'project',
+        key: 'tasks',
+        label: new LocalizedString([{ locale: 'en', value: 'Tasks' }]),
+        description: null,
+        isRequired: false,
+        choices: overrides.choices ?? choices,
+        rules: overrides.rules ?? rules
+    });
+}
+describe('progress customFieldDefinition', () => {
+    it('creates a progress custom field definition', () => {
+        const definition = progressDefinition();
+        expect(definition.type).toBe(CustomFieldType.PROGRESS);
+        expect(definition.choices).toEqual(choices);
+        expect(definition.rules).toEqual({ type: CustomFieldType.PROGRESS, ...rules });
+    });
+    it('creates a progress custom field definition without an icon', () => {
+        const definition = progressDefinition({ rules: { colors: rules.colors } });
+        expect(definition.rules).toEqual({ type: CustomFieldType.PROGRESS, colors: rules.colors });
+    });
+    it('rejects a progress field without choices', () => {
+        expect(() => progressDefinition({ choices: [], rules: { icon: 'tasks', colors: {} } }))
+            .toThrow(new CustomFieldDefinitionError('Progress custom field must define at least one choice'));
+    });
+    it('rejects a progress field with duplicate choice values', () => {
+        expect(() => progressDefinition({ choices: [choices[0], { ...choices[1], value: 'completed' }] }))
+            .toThrow(new CustomFieldDefinitionError('Custom field choice value must be unique'));
+    });
+    it('rejects a progress field with an empty icon', () => {
+        expect(() => progressDefinition({ rules: { ...rules, icon: '  ' } }))
+            .toThrow(new CustomFieldDefinitionError('Progress custom field icon can not be empty'));
+    });
+    it('rejects a progress field without a color for every choice', () => {
+        expect(() => progressDefinition({ rules: { ...rules, colors: { completed: ProgressCustomFieldColor.SUCCESS } } }))
+            .toThrow(new CustomFieldDefinitionError('Progress custom field must define a color for every choice'));
+    });
+    it('rejects a progress field with a color for an unknown choice', () => {
+        expect(() => progressDefinition({ rules: { ...rules, colors: { ...rules.colors, blocked: ProgressCustomFieldColor.ERROR } } }))
+            .toThrow(new CustomFieldDefinitionError('Progress custom field colors can only be defined for choices'));
+    });
+    it('rejects a progress field with an unsupported color', () => {
+        expect(() => progressDefinition({ rules: { ...rules, colors: { ...rules.colors, completed: 'lime' } } }))
+            .toThrow(new CustomFieldDefinitionError('Progress custom field color must be a supported color'));
+    });
+});
+//# sourceMappingURL=progress.custom-field-definition.factory.unit.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"progress.custom-field-definition.factory.unit.test.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/progress.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,0BAA0B,EAAE,MAAM,8CAA8C,CAAA;AACzF,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACrE,OAAO,EAAE,qBAAqB,EAAE,MAAM,iDAAiD,CAAA;AACvF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAA;AAI7F,MAAM,OAAO,GAAwB;IACnC,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE;IACpG,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE;CACzG,CAAA;AAED,MAAM,KAAK,GAA6C;IACtD,IAAI,EAAE,OAAO;IACb,MAAM,EAAE;QACN,SAAS,EAAE,wBAAwB,CAAC,OAAO;QAC3C,WAAW,EAAE,wBAAwB,CAAC,OAAO;KAC9C;CACF,CAAA;AAED,SAAS,kBAAkB,CACzB,YAAiG,EAAE;IAEnG,OAAO,qBAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE;QACrD,UAAU,EAAE,IAAI;QAChB,UAAU,EAAE,SAAS;QACrB,GAAG,EAAE,OAAO;QACZ,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC9D,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,KAAK;QACjB,OAAO,EAAE,SAAS,CAAC,OAAO,IAAI,OAAO;QACrC,KAAK,EAAE,SAAS,CAAC,KAAK,IAAI,KAAK;KAChC,CAAC,CAAA;AACJ,CAAC;AAED,QAAQ,CAAC,gCAAgC,EAAE,GAAG,EAAE;IAC9C,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,UAAU,GAAG,kBAAkB,EAAE,CAAA;QAEvC,MAAM,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;QACtD,MAAM,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,CAAA;QAC3C,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;IAChF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;QACpE,MAAM,UAAU,GAAG,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;QAE1E,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,eAAe,CAAC,QAAQ,EAAE,MAAM,EAAE,KAAK,CAAC,MAAM,EAAE,CAAC,CAAA;IAC5F,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;aACpF,OAAO,CAAC,IAAI,0BAA0B,CAAC,uDAAuD,CAAC,CAAC,CAAA;IACrG,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;QAC/D,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,OAAO,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,CAAC;aAC/F,OAAO,CAAC,IAAI,0BAA0B,CAAC,0CAA0C,CAAC,CAAC,CAAA;IACxF,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC;aAClE,OAAO,CAAC,IAAI,0BAA0B,CAAC,6CAA6C,CAAC,CAAC,CAAA;IAC3F,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;QACnE,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,SAAS,EAAE,wBAAwB,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;aAC/G,OAAO,CAAC,IAAI,0BAA0B,CAAC,4DAA4D,CAAC,CAAC,CAAA;IAC1G,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6DAA6D,EAAE,GAAG,EAAE;QACrE,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,OAAO,EAAE,wBAAwB,CAAC,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC;aAC5H,OAAO,CAAC,IAAI,0BAA0B,CAAC,8DAA8D,CAAC,CAAC,CAAA;IAC5G,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;QAC5D,MAAM,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,MAAM,EAAE,EAAE,GAAG,KAAK,CAAC,MAAM,EAAE,SAAS,EAAE,MAAkC,EAAE,EAAE,EAAE,CAAC,CAAC;aAClI,OAAO,CAAC,IAAI,0BAA0B,CAAC,uDAAuD,CAAC,CAAC,CAAA;IACrG,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

@@ -0,0 +1,6 @@
+import type { CustomFieldDefinitionFieldsByType } from '#src/custom-field-definition.js';
+import type { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import type { ProgressCustomFieldData } from '#src/custom-field-types/progress/progress.contract.js';
+type ProgressCustomFieldDefinition = CustomFieldDefinitionFieldsByType<CustomFieldType.PROGRESS>;
+export declare function validateProgressCustomFieldValue(definition: ProgressCustomFieldDefinition, value: ProgressCustomFieldData): void;
+export {};

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

@@ -0,0 +1,34 @@
+import { CustomFieldValueValidationError } from '#src/validators/custom-field-value-validation.error.js';
+export function validateProgressCustomFieldValue(definition, value) {
+    if (definition.choices === null) {
+        throw new CustomFieldValueValidationError('Progress custom field definition must define choices');
+    }
+    const seenKeys = new Set();
+    let sum = 0;
+    for (const segment of value.segments) {
+        if (!definition.choices.some(choice => choice.value === segment.key)) {
+            throw new CustomFieldValueValidationError('Progress custom field value keys must be defined choices');
+        }
+        if (seenKeys.has(segment.key)) {
+            throw new CustomFieldValueValidationError('Progress custom field value can not contain duplicate keys');
+        }
+        if (!Number.isFinite(segment.amount)) {
+            throw new CustomFieldValueValidationError('Progress custom field value amount must be a finite number');
+        }
+        if (segment.amount < 0) {
+            throw new CustomFieldValueValidationError('Progress custom field value amount can not be negative');
+        }
+        seenKeys.add(segment.key);
+        sum += segment.amount;
+    }
+    if (value.total === undefined) {
+        return;
+    }
+    if (!Number.isFinite(value.total) || value.total <= 0) {
+        throw new CustomFieldValueValidationError('Progress custom field value total must be a finite number greater than zero');
+    }
+    if (sum > value.total) {
+        throw new CustomFieldValueValidationError('Progress custom field value amounts can not exceed the total');
+    }
+}
+//# sourceMappingURL=progress.custom-field-value.validator.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"progress.custom-field-value.validator.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/progress.custom-field-value.validator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,+BAA+B,EAAE,MAAM,wDAAwD,CAAA;AAMxG,MAAM,UAAU,gCAAgC,CAC9C,UAAyC,EACzC,KAA8B;IAE9B,IAAI,UAAU,CAAC,OAAO,KAAK,IAAI,EAAE,CAAC;QAChC,MAAM,IAAI,+BAA+B,CAAC,sDAAsD,CAAC,CAAA;IACnG,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAA;IAClC,IAAI,GAAG,GAAG,CAAC,CAAA;IAEX,KAAK,MAAM,OAAO,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC;QACrC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YACrE,MAAM,IAAI,+BAA+B,CAAC,0DAA0D,CAAC,CAAA;QACvG,CAAC;QAED,IAAI,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,+BAA+B,CAAC,4DAA4D,CAAC,CAAA;QACzG,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,IAAI,+BAA+B,CAAC,4DAA4D,CAAC,CAAA;QACzG,CAAC;QAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvB,MAAM,IAAI,+BAA+B,CAAC,wDAAwD,CAAC,CAAA;QACrG,CAAC;QAED,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,CAAA;QACzB,GAAG,IAAI,OAAO,CAAC,MAAM,CAAA;IACvB,CAAC;IAED,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAM;IACR,CAAC;IAED,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,KAAK,IAAI,CAAC,EAAE,CAAC;QACtD,MAAM,IAAI,+BAA+B,CAAC,6EAA6E,CAAC,CAAA;IAC1H,CAAC;IAED,IAAI,GAAG,GAAG,KAAK,CAAC,KAAK,EAAE,CAAC;QACtB,MAAM,IAAI,+BAA+B,CAAC,8DAA8D,CAAC,CAAA;IAC3G,CAAC;AACH,CAAC"}

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

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

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

@@ -0,0 +1,91 @@
+import { describe, it } from 'node:test';
+import { expect } from 'expect';
+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 { CustomFieldValueValidationError } from '#src/validators/custom-field-value-validation.error.js';
+import { ProgressCustomFieldColor } from '#src/custom-field-types/progress/progress.color.js';
+const definition = customFieldDefinition(CustomFieldType.PROGRESS, {
+    tenantUuid: null,
+    entityType: 'project',
+    key: 'tasks',
+    label: new LocalizedString([{ locale: 'en', value: 'Tasks' }]),
+    description: null,
+    isRequired: false,
+    choices: [
+        { value: 'completed', order: 1, label: new LocalizedString([{ locale: 'en', value: 'Completed' }]) },
+        { value: 'in_progress', order: 2, label: new LocalizedString([{ locale: 'en', value: 'In progress' }]) }
+    ],
+    rules: {
+        icon: 'tasks',
+        colors: {
+            completed: ProgressCustomFieldColor.SUCCESS,
+            in_progress: ProgressCustomFieldColor.WARNING
+        }
+    }
+});
+function validate(value) {
+    validateCustomFieldValue(definition, {
+        definitionUuid: definition.uuid,
+        type: CustomFieldType.PROGRESS,
+        value
+    });
+}
+describe('progress validateCustomFieldValue', () => {
+    it('accepts amounts for defined choices', () => {
+        expect(() => validate({
+            segments: [
+                { key: 'completed', amount: 2 },
+                { key: 'in_progress', amount: 3 }
+            ]
+        })).not.toThrow();
+    });
+    it('accepts a decimal amount', () => {
+        expect(() => validate({ segments: [{ key: 'completed', amount: 0.42 }] })).not.toThrow();
+    });
+    it('accepts an empty value', () => {
+        expect(() => validate({ segments: [] })).not.toThrow();
+    });
+    it('rejects a key that is not a defined choice', () => {
+        expect(() => validate({ segments: [{ key: 'blocked', amount: 1 }] }))
+            .toThrow(new CustomFieldValueValidationError('Progress custom field value keys must be defined choices'));
+    });
+    it('rejects duplicate keys', () => {
+        expect(() => validate({
+            segments: [
+                { key: 'completed', amount: 1 },
+                { key: 'completed', amount: 2 }
+            ]
+        })).toThrow(new CustomFieldValueValidationError('Progress custom field value can not contain duplicate keys'));
+    });
+    it('rejects a negative amount', () => {
+        expect(() => validate({ segments: [{ key: 'completed', amount: -1 }] }))
+            .toThrow(new CustomFieldValueValidationError('Progress custom field value amount can not be negative'));
+    });
+    it('rejects a non-finite amount', () => {
+        expect(() => validate({ segments: [{ key: 'completed', amount: Number.POSITIVE_INFINITY }] }))
+            .toThrow(new CustomFieldValueValidationError('Progress custom field value amount must be a finite number'));
+    });
+    it('accepts amounts below the total', () => {
+        expect(() => validate({ total: 100, segments: [{ key: 'completed', amount: 20 }] })).not.toThrow();
+    });
+    it('rejects amounts that exceed the total', () => {
+        expect(() => validate({
+            total: 4,
+            segments: [
+                { key: 'completed', amount: 2 },
+                { key: 'in_progress', amount: 3 }
+            ]
+        })).toThrow(new CustomFieldValueValidationError('Progress custom field value amounts can not exceed the total'));
+    });
+    it('rejects a total of zero', () => {
+        expect(() => validate({ total: 0, segments: [] }))
+            .toThrow(new CustomFieldValueValidationError('Progress custom field value total must be a finite number greater than zero'));
+    });
+    it('rejects a non-finite total', () => {
+        expect(() => validate({ total: Number.POSITIVE_INFINITY, segments: [] }))
+            .toThrow(new CustomFieldValueValidationError('Progress custom field value total must be a finite number greater than zero'));
+    });
+});
+//# sourceMappingURL=progress.custom-field-value.validator.unit.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"progress.custom-field-value.validator.unit.test.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/progress.custom-field-value.validator.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,qBAAqB,EAAE,MAAM,iDAAiD,CAAA;AACvF,OAAO,EAAE,eAAe,EAAE,MAAM,qCAAqC,CAAA;AACrE,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAA;AAC1F,OAAO,EAAE,+BAA+B,EAAE,MAAM,wDAAwD,CAAA;AACxG,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAA;AAG7F,MAAM,UAAU,GAAG,qBAAqB,CAAC,eAAe,CAAC,QAAQ,EAAE;IACjE,UAAU,EAAE,IAAI;IAChB,UAAU,EAAE,SAAS;IACrB,GAAG,EAAE,OAAO;IACZ,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;IAC9D,WAAW,EAAE,IAAI;IACjB,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE;QACP,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,CAAC,EAAE;QACpG,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,IAAI,eAAe,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,aAAa,EAAE,CAAC,CAAC,EAAE;KACzG;IACD,KAAK,EAAE;QACL,IAAI,EAAE,OAAO;QACb,MAAM,EAAE;YACN,SAAS,EAAE,wBAAwB,CAAC,OAAO;YAC3C,WAAW,EAAE,wBAAwB,CAAC,OAAO;SAC9C;KACF;CACF,CAAC,CAAA;AAEF,SAAS,QAAQ,CAAC,KAA8B;IAC9C,wBAAwB,CAAC,UAAU,EAAE;QACnC,cAAc,EAAE,UAAU,CAAC,IAAI;QAC/B,IAAI,EAAE,eAAe,CAAC,QAAQ;QAC9B,KAAK;KACN,CAAC,CAAA;AACJ,CAAC;AAED,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;IACjD,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;QAC7C,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;YACpB,QAAQ,EAAE;gBACR,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC/B,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE;aAClC;SACF,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,0BAA0B,EAAE,GAAG,EAAE;QAClC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IAC1F,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IACxD,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4CAA4C,EAAE,GAAG,EAAE;QACpD,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aAClE,OAAO,CAAC,IAAI,+BAA+B,CAAC,0DAA0D,CAAC,CAAC,CAAA;IAC7G,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;QAChC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;YACpB,QAAQ,EAAE;gBACR,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC/B,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;aAChC;SACF,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,+BAA+B,CAAC,4DAA4D,CAAC,CAAC,CAAA;IAChH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACnC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;aACrE,OAAO,CAAC,IAAI,+BAA+B,CAAC,wDAAwD,CAAC,CAAC,CAAA;IAC3G,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;QACrC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,iBAAiB,EAAE,CAAC,EAAE,CAAC,CAAC;aAC3F,OAAO,CAAC,IAAI,+BAA+B,CAAC,4DAA4D,CAAC,CAAC,CAAA;IAC/G,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;QACzC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAA;IACpG,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC;YACpB,KAAK,EAAE,CAAC;YACR,QAAQ,EAAE;gBACR,EAAE,GAAG,EAAE,WAAW,EAAE,MAAM,EAAE,CAAC,EAAE;gBAC/B,EAAE,GAAG,EAAE,aAAa,EAAE,MAAM,EAAE,CAAC,EAAE;aAClC;SACF,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,+BAA+B,CAAC,8DAA8D,CAAC,CAAC,CAAA;IAClH,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACjC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;aAC/C,OAAO,CAAC,IAAI,+BAA+B,CAAC,6EAA6E,CAAC,CAAC,CAAA;IAChI,CAAC,CAAC,CAAA;IAEF,EAAE,CAAC,4BAA4B,EAAE,GAAG,EAAE;QACpC,MAAM,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,EAAE,KAAK,EAAE,MAAM,CAAC,iBAAiB,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC,CAAC;aACtE,OAAO,CAAC,IAAI,+BAA+B,CAAC,6EAA6E,CAAC,CAAC,CAAA;IAChI,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}

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

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

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

@@ -0,0 +1,44 @@
+import { CustomFieldDefinitionError } from '#src/errors/custom-field-definition.error.js';
+import { ProgressCustomFieldColor } from '#src/custom-field-types/progress/progress.color.js';
+export function validateProgressCustomFieldDefinition(definition) {
+    validateProgressChoices(definition.choices);
+    const rules = definition.rules;
+    if (rules === null) {
+        throw new CustomFieldDefinitionError('Progress custom field rules are required');
+    }
+    if (rules.icon !== undefined && rules.icon.trim() === '') {
+        throw new CustomFieldDefinitionError('Progress custom field icon can not be empty');
+    }
+    const choiceValues = new Set(definition.choices.map(choice => choice.value));
+    for (const [key, color] of Object.entries(rules.colors)) {
+        if (!choiceValues.has(key)) {
+            throw new CustomFieldDefinitionError('Progress custom field colors can only be defined for choices');
+        }
+        if (!Object.values(ProgressCustomFieldColor).includes(color)) {
+            throw new CustomFieldDefinitionError('Progress custom field color must be a supported color');
+        }
+    }
+    for (const choice of definition.choices) {
+        if (rules.colors[choice.value] === undefined) {
+            throw new CustomFieldDefinitionError('Progress custom field must define a color for every choice');
+        }
+    }
+}
+function validateProgressChoices(choices) {
+    if (choices.length === 0) {
+        throw new CustomFieldDefinitionError('Progress custom field must define at least one choice');
+    }
+    const choiceValues = new Set();
+    const choiceOrders = new Set();
+    for (const choice of choices) {
+        if (choiceValues.has(choice.value)) {
+            throw new CustomFieldDefinitionError('Custom field choice value must be unique');
+        }
+        if (choiceOrders.has(choice.order)) {
+            throw new CustomFieldDefinitionError('Custom field choice order must be unique');
+        }
+        choiceValues.add(choice.value);
+        choiceOrders.add(choice.order);
+    }
+}
+//# sourceMappingURL=progress.definition-validation.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"progress.definition-validation.js","sourceRoot":"","sources":["../../../lib/custom-field-types/progress/progress.definition-validation.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAA;AAEzF,OAAO,EAAE,wBAAwB,EAAE,MAAM,oDAAoD,CAAA;AAI7F,MAAM,UAAU,qCAAqC,CAAC,UAAyC;IAC7F,uBAAuB,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;IAE3C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAA;IAE9B,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACnB,MAAM,IAAI,0BAA0B,CAAC,0CAA0C,CAAC,CAAA;IAClF,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;QACzD,MAAM,IAAI,0BAA0B,CAAC,6CAA6C,CAAC,CAAA;IACrF,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;IAE5E,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAC3B,MAAM,IAAI,0BAA0B,CAAC,8DAA8D,CAAC,CAAA;QACtG,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7D,MAAM,IAAI,0BAA0B,CAAC,uDAAuD,CAAC,CAAA;QAC/F,CAAC;IACH,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,UAAU,CAAC,OAAO,EAAE,CAAC;QACxC,IAAI,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,SAAS,EAAE,CAAC;YAC7C,MAAM,IAAI,0BAA0B,CAAC,4DAA4D,CAAC,CAAA;QACpG,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,OAA4B;IAC3D,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzB,MAAM,IAAI,0BAA0B,CAAC,uDAAuD,CAAC,CAAA;IAC/F,CAAC;IAED,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAA;IACtC,MAAM,YAAY,GAAG,IAAI,GAAG,EAAU,CAAA;IAEtC,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,0BAA0B,CAAC,0CAA0C,CAAC,CAAA;QAClF,CAAC;QAED,IAAI,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,0BAA0B,CAAC,0CAA0C,CAAC,CAAA;QAClF,CAAC;QAED,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC9B,YAAY,CAAC,GAAG,CAAC,MAAM,CAAC,KAAK,CAAC,CAAA;IAChC,CAAC;AACH,CAAC"}

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

@@ -0,0 +1,22 @@
+import { BaseCustomFieldValueDto } from '#src/dto/base-custom-field-value.dto.js';
+import { CustomFieldType } from '#src/enum/custom-field-type.enum.js';
+import type { ProgressCustomFieldData, ProgressCustomFieldSegment } from '#src/custom-field-types/progress/progress.contract.js';
+import type { ProgressCustomFieldValue } from '#src/custom-field-types/progress/progress.value.js';
+export declare class ProgressCustomFieldSegmentDto {
+    key: string;
+    amount: number;
+    parse(): ProgressCustomFieldSegment;
+    static from(segment: ProgressCustomFieldSegment): ProgressCustomFieldSegmentDto;
+}
+export declare class ProgressCustomFieldDataDto {
+    total?: number;
+    segments: ProgressCustomFieldSegmentDto[];
+    parse(): ProgressCustomFieldData;
+    static from(data: ProgressCustomFieldData): ProgressCustomFieldDataDto;
+}
+export declare class ProgressCustomFieldValueDto extends BaseCustomFieldValueDto {
+    type: CustomFieldType.PROGRESS;
+    value: ProgressCustomFieldDataDto;
+    parse(): ProgressCustomFieldValue;
+    static from(customFieldValue: ProgressCustomFieldValue): ProgressCustomFieldValueDto;
+}