@form-flow/core 2.0.0 → 2.0.2

package/README.md

@@ -34,6 +34,64 @@ pnpm add @form-flow/core
 
 ---
 
+## Breaking Changes v2.0.0
+
+### `FieldControlType` is now generic
+
+`FieldControlType` no longer represents only the built-in control types. It now accepts custom control types through a generic parameter.
+
+```ts
+type FieldControlType<TCustom extends string = never> =
+  BuiltInFieldControlType | Exclude<TCustom, BuiltInFieldControlType>;
+```
+
+This means:
+
+- use `BuiltInFieldControlType` when you need the built-in union only
+- use `FieldControlType<"myCustomType" | "anotherType">` for built-in + custom types
+- stop using `CustomFieldControlType` in new code; it is still exported only as a deprecated compatibility alias
+
+Migration examples:
+
+```ts
+// Before
+type BuiltInOnly = FieldControlType;
+type AllControls = CustomFieldControlType<"rating" | "currency">;
+
+// After
+type BuiltInOnly = BuiltInFieldControlType;
+type AllControls = FieldControlType<"rating" | "currency">;
+```
+
+Custom field definition example:
+
+```ts
+type AppFieldTypes = "switch" | "slider" | "radio";
+
+const fields: FieldDefinition<AppFieldTypes>[] = [
+
+];
+```
+
+If your code relied on `FieldControlType` being built-in only, this is a breaking change and you should migrate those usages to `BuiltInFieldControlType`.
+
+### `FORM_FLOW_OPERATORS_MAP` is no longer publicly exported
+
+The package root no longer exposes `FORM_FLOW_OPERATORS_MAP` as part of the public API.
+
+Use `FormFlowOperatorRegistry` instead:
+
+```ts
+import { FormFlowOperatorRegistry } from "@form-flow/core";
+
+const operators = FormFlowOperatorRegistry.getAll();
+const eqOperator = FormFlowOperatorRegistry.get("eq");
+```
+
+If you were importing `FORM_FLOW_OPERATORS_MAP` from `@form-flow/core`, this is a breaking change and you should migrate those usages to `FormFlowOperatorRegistry`.
+
+---
+
 ## 📖 Quick Start
 
 ### Basic Example
@@ -231,26 +289,37 @@ console.log(availableRules); // ["disabledIf", "readonlyIf"]
 ### Type Definitions
 
 ```ts
-type BaseFieldDefinition<T = any> = {
+type BuiltInFieldControlType =
+  | "text"
+  | "number"
+  | "date"
+  | "singleSelect"
+  | "multipleSelect"
+  | "checkbox";
+
+type FieldControlType<TCustom extends string = never> =
+  BuiltInFieldControlType | Exclude<TCustom, BuiltInFieldControlType>;
+
+type BaseFieldDefinition<TCustom extends string = never> = {
   id: string;
-  type: string;
+  type: FieldControlType<TCustom>;
   label: string;
 };
 
 // Field with conditional rules
-type FieldDefinition<T = any> = BaseFieldDefinition<T> & {
+type FieldDefinition<TCustom extends string = never> = BaseFieldDefinition<TCustom> & {
   visibleIf?: FieldRuleGroupDefinition;
   requiredIf?: FieldRuleGroupDefinition;
   disabledIf?: FieldRuleGroupDefinition;
   readonlyIf?: FieldRuleGroupDefinition;
 };
 
-type RuleContextFieldDefinition<T = any> = BaseFieldDefinition<T>;
+type RuleContextFieldDefinition<TCustom extends string = never> = BaseFieldDefinition<TCustom>;
 
-type FormFlowDefinition<T = any> = {
+type FormFlowDefinition<TCustom extends string = never> = {
   formId: string;
-  fields: FieldDefinition<T>[];
-  ruleContextFields?: RuleContextFieldDefinition<T>[];
+  fields: FieldDefinition<TCustom>[];
+  ruleContextFields?: RuleContextFieldDefinition<TCustom>[];
 };
 
 // Atomic rule

package/dist/models/operator-registry.d.ts

@@ -3,16 +3,16 @@ export declare const OperatorRegistry: {
     /**
      * Get the definition of a specific operator by key.
      */
-    get: (key: RuleOperatorKey) => RuleOperatorMeta | undefined;
+    get: <TCustom extends string = never>(key: RuleOperatorKey) => RuleOperatorMeta<TCustom> | undefined;
     /**
      * Get all operator definitions (e.g., for building UI pickers).
      */
-    getAll: () => RuleOperatorsMap;
+    getAll: <TCustom extends string = never>() => RuleOperatorsMap<TCustom>;
     /**
      * Register one or more operator overrides or additions.
      * Existing operators with the same key will be replaced.
      */
-    register: (overrides: RuleOperatorsMap) => void;
+    register: <TCustom extends string = never>(overrides: RuleOperatorsMap<TCustom>) => void;
     /**
      * Reset the registry to the original default operator map.
      */

package/dist/models/operator-registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"operator-registry.d.ts","sourceRoot":"","sources":["../../src/models/operator-registry.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAK3G,eAAO,MAAM,gBAAgB;IACzB;;OAEG;eACQ,eAAe,KAAG,gBAAgB,GAAG,SAAS;IAEzD;;OAEG;kBACS,gBAAgB;IAE5B;;;OAGG;0BACmB,gBAAgB;IAItC;;OAEG;;CAIN,CAAC"}
+{"version":3,"file":"operator-registry.d.ts","sourceRoot":"","sources":["../../src/models/operator-registry.ts"],"names":[],"mappings":"AACA,OAAO,EAA2B,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAK3G,eAAO,MAAM,gBAAgB;IACzB;;OAEG;UACG,OAAO,SAAS,MAAM,eAAe,eAAe,KAAG,gBAAgB,CAAC,OAAO,CAAC,GAAG,SAAS;IAElG;;OAEG;aACM,OAAO,SAAS,MAAM,eAAa,gBAAgB,CAAC,OAAO,CAAC;IAErE;;;OAGG;eACQ,OAAO,SAAS,MAAM,qBAAqB,gBAAgB,CAAC,OAAO,CAAC;IAI/E;;OAEG;;CAIN,CAAC"}

package/dist/models/operator-registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"operator-registry.js","sourceRoot":"","sources":["../../src/models/operator-registry.ts"],"names":[],"mappings":";;;AAAA,uBAAuB;AACvB,2CAA2G;AAE3G,4CAA4C;AAC5C,IAAI,QAAQ,GAAqB,EAAE,GAAG,mCAAuB,EAAE,CAAC;AAEnD,QAAA,gBAAgB,GAAG;IAC5B;;OAEG;IACH,GAAG,EAAE,CAAC,GAAoB,EAAgC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC;IAE1E;;OAEG;IACH,MAAM,EAAE,GAAqB,EAAE,CAAC,QAAQ;IAExC;;;OAGG;IACH,QAAQ,EAAE,CAAC,SAA2B,EAAE,EAAE;QACtC,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,SAAS,EAAE,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,KAAK,EAAE,GAAG,EAAE;QACR,QAAQ,GAAG,EAAE,GAAG,mCAAuB,EAAE,CAAC;IAC9C,CAAC;CACJ,CAAC"}
+{"version":3,"file":"operator-registry.js","sourceRoot":"","sources":["../../src/models/operator-registry.ts"],"names":[],"mappings":";;;AAAA,uBAAuB;AACvB,2CAA2G;AAE3G,4CAA4C;AAC5C,IAAI,QAAQ,GAA6B,EAAE,GAAG,mCAAuB,EAAE,CAAC;AAE3D,QAAA,gBAAgB,GAAG;IAC5B;;OAEG;IACH,GAAG,EAAE,CAAiC,GAAoB,EAAyC,EAAE,CAAC,QAAQ,CAAC,GAAG,CAA8B;IAEhJ;;OAEG;IACH,MAAM,EAAE,GAA8D,EAAE,CAAC,QAAqC;IAE9G;;;OAGG;IACH,QAAQ,EAAE,CAAiC,SAAoC,EAAE,EAAE;QAC/E,QAAQ,GAAG,EAAE,GAAG,QAAQ,EAAE,GAAG,SAAS,EAAE,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,KAAK,EAAE,GAAG,EAAE;QACR,QAAQ,GAAG,EAAE,GAAG,mCAAuB,EAAE,CAAC;IAC9C,CAAC;CACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@form-flow/core",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "TypeScript engine for conditional UI states (visible, required, disabled, readonly) on form fields",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",