@axi-engine/fields 0.3.5 → 0.3.7

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as _axi_engine_utils from '@axi-engine/utils';
-import { Subscribable, ConstructorRegistry, Emitter, Constructor, PathType } from '@axi-engine/utils';
+import { Subscribable, ConstructorRegistry, Emitter, Constructor, PathType, DataStorage } from '@axi-engine/utils';
 
 interface Policy<T> {
     readonly id: string;
@@ -789,7 +789,7 @@ interface StoreCreateFieldOptions {
  * It acts as a facade, simplifying access to the underlying FieldTree and providing
  * both type-safe and dynamic methods for manipulating data.
  */
-interface Store {
+interface Store extends DataStorage {
     /**
      * Retrieves the raw value of a Field at a specific path.
      * @template T The expected type of the value.
@@ -955,8 +955,55 @@ declare class DataStore implements Store {
     remove(path: PathType): void;
     private isPathToRootFields;
     private getDestinationFields;
+    has(path: PathType): boolean;
+    /** implementation of the DataStore from utils */
+    get(path: PathType): unknown;
+    set(path: PathType, value: unknown): void;
+    create(path: PathType, value: unknown): void;
+    upset(path: PathType, value: unknown): void;
+    delete(path: PathType): void;
 }
 
+/**
+ * Type guard that checks if a value is an instance of the `Fields` class.
+ * It verifies this by checking the static `typeName` property on the instance.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a `Fields` instance, otherwise `false`.
+ */
+declare function isFields(value: unknown): value is Fields;
+/**
+ * Type guard that checks if a value is an instance of the `FieldTree` class.
+ * It verifies this by checking the static `typeName` property on the instance.
+ *
+ * @param value The value to check.
+ * @returns {boolean} `true` if the value is a `FieldTree` instance, otherwise `false`.
+ */
+declare function isFieldTree(value: unknown): value is FieldTree<any>;
+/**
+ * Type guard that checks if an unknown value conforms to the `Store` interface.
+ *
+ * It performs a structural check (duck typing) by verifying the presence of methods
+ * that are unique to the `Store` interface and are not part of the simpler `DataSource`
+ * or `DataStorage` contracts, such as `createFields` and `createTree`.
+ *
+ * @param value The `unknown` value to check.
+ * @returns {boolean} `true` if the value is a `Store`-like object, `false` otherwise.
+ *
+ * @example
+ * function processData(source: DataSource) {
+ *   if (isStore(source)) {
+ *     // Inside this block, TypeScript now knows `source` is a full `Store`.
+ *     // We can safely call Store-specific methods like `createFields`.
+ *     source.createFields('new.data.group');
+ *   } else {
+ *     // Fallback logic for simpler data sources that are not a `Store`.
+ *     console.warn('Cannot create new groups with a simple data source.');
+ *   }
+ * }
+ */
+declare function isStore(value: unknown): value is Store;
+
 /**
  * Creates and configures a FieldRegistry with all the core field types.
  * @returns {FieldRegistry} A pre-configured FieldRegistry instance.
@@ -994,4 +1041,4 @@ declare function createCoreFieldSystem(config?: CoreFieldSystemConfig): {
     serializer: FieldTreeSerializer<CoreFields>;
 };
 
-export { type BooleanField, ClampMaxPolicy, ClampMaxPolicySerializerHandler, ClampMinPolicy, ClampMinPolicySerializerHandler, ClampPolicy, ClampPolicySerializerHandler, CoreBooleanField, type CoreBooleanFieldOptions, CoreField, type CoreFieldSystemConfig, CoreFieldTree, CoreFields, CoreFieldsFactory, CoreNumericField, type CoreNumericFieldOptions, CoreStringField, type CoreStringFieldOptions, CoreTreeNodeFactory, DataStore, type Field, type FieldOptions, FieldRegistry, FieldSerializer, type FieldSnapshot, FieldTree, type FieldTreeFactory, FieldTreeSerializer, type FieldTreeSnapshot, Fields, type FieldsFactory, FieldsSerializer, type FieldsSnapshot, type NumericField, Policies, type Policy, PolicySerializer, type PolicySerializerHandler, type Store, type StoreCreateFieldOptions, type StringField, type TreeNode, clampMaxPolicy, clampMinPolicy, clampPolicy, createCoreFieldRegistry, createCoreFieldSystem, createCorePolicySerializer, createCoreTreeNodeFactory, createCoreTreeSerializer, createTypedMethodsMixin };
+export { type BooleanField, ClampMaxPolicy, ClampMaxPolicySerializerHandler, ClampMinPolicy, ClampMinPolicySerializerHandler, ClampPolicy, ClampPolicySerializerHandler, CoreBooleanField, type CoreBooleanFieldOptions, CoreField, type CoreFieldSystemConfig, CoreFieldTree, CoreFields, CoreFieldsFactory, CoreNumericField, type CoreNumericFieldOptions, CoreStringField, type CoreStringFieldOptions, CoreTreeNodeFactory, DataStore, type Field, type FieldOptions, FieldRegistry, FieldSerializer, type FieldSnapshot, FieldTree, type FieldTreeFactory, FieldTreeSerializer, type FieldTreeSnapshot, Fields, type FieldsFactory, FieldsSerializer, type FieldsSnapshot, type NumericField, Policies, type Policy, PolicySerializer, type PolicySerializerHandler, type Store, type StoreCreateFieldOptions, type StringField, type TreeNode, clampMaxPolicy, clampMinPolicy, clampPolicy, createCoreFieldRegistry, createCoreFieldSystem, createCorePolicySerializer, createCoreTreeNodeFactory, createCoreTreeSerializer, createTypedMethodsMixin, isFieldTree, isFields, isStore };