@asaidimu/anansi 1.4.0 → 1.4.1

package/index.d.cts

@@ -5,21 +5,111 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import LightningFS from '@isomorphic-git/lightning-fs';
 
 /**
- * SchemaDefinition.ts
+ * hints.ts
  *
- * Defines a robust schema specification for modeling data structures in an ERP system.
- * Supports atomic schemas with reusable nested definitions (now as mini-SchemaDefinitions),
- * flexible constraints, and indexing. Inspired by SQL pragmatism, it allows circular references
- * (via 'reference' and 'nestedSchema.id') and relies on tooling for runtime handling
- * (e.g., breaking validation/serialization loops). Intended for use with an IDE that validates
- * syntax and semantics at publish time. Versioning is managed at the root level only,
- * avoiding unnecessary API complexity.
- *
- * NOTE: Most places where a Record<string, something> is used, and something has
- * a name property,then string should be treated as an id and will be a uuid.
- * for display purposes: validation, code generation, e.t.c something.name
- * should be prefered
+ * Defines type hints for generating form input controls based on schema field definitions.
+ * Each hint type corresponds to a specific input control, providing metadata for code generation.
+ */
+/**
+ * Hints for generating a file input control.
+ */
+type FileHint = {
+    type: "file";
+    label?: string;
+    embed?: boolean;
+    mimes?: string | string[];
+    size?: {
+        max?: number;
+        min?: number;
+    };
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+};
+/**
+ * Hints for generating a text-based input control.
+ */
+type TextHint = {
+    type: "text" | "email" | "tel" | "url" | "textarea";
+    label?: string;
+    placeholder?: string;
+};
+/**
+ * Hints for generating a secret input control (e.g., passwords, API keys).
  */
+type SecretHint = {
+    type: "secret";
+    label?: string;
+    placeholder?: string;
+    password?: boolean;
+};
+/**
+ * Hints for generating a number-based input control.
+ */
+type NumberHint = {
+    type: "number" | "range";
+    label?: string;
+    step?: number;
+};
+/**
+ * Hints for generating a boolean input control.
+ */
+type BooleanHint = {
+    type: "checkbox" | "radio";
+    label?: string;
+    radioLabels?: {
+        true: string;
+        false: string;
+    };
+};
+/**
+ * Hints for generating an enum input control.
+ */
+type EnumHint = {
+    type: "select" | "radio";
+    label?: string;
+};
+/**
+ * Hints for generating an array input control.
+ */
+type ArrayHint = {
+    type: "list";
+    label?: string;
+    itemHint?: {
+        type: string;
+    };
+};
+/**
+ * Hints for generating a set input control.
+ */
+type SetHint = {
+    type: "tags";
+    label?: string;
+    itemHint?: {
+        type: string;
+    };
+};
+/**
+ * Hints for generating an object input control.
+ */
+type ObjectHint = {
+    type: "group";
+    label?: string;
+    collapsible?: boolean;
+};
+/**
+ * Hints for generating a dynamic input control.
+ */
+type DynamicHint = {
+    type: "text";
+    label?: string;
+};
+/**
+ * Union type for all possible input hints.
+ */
+type InputHint = FileHint | TextHint | SecretHint | NumberHint | BooleanHint | EnumHint | ArrayHint | SetHint | ObjectHint | DynamicHint;
+
 /**
  * Logical operators for combining constraints or index conditions.
  */
@@ -27,7 +117,7 @@ type LogicalOperator = "and" | "or" | "not" | "nor" | "xor";
 /**
  * Basic field types supported by the schema system.
  */
-type FieldType = "string" | "number" | "boolean" | "array" | "set" | "enum" | "object" | "dynamic";
+type FieldType = "string" | "number" | "boolean" | "array" | "set" | "enum" | "object" | "record" | "dynamic";
 /**
  * Index types for optimizing different query patterns.
  */
@@ -54,6 +144,9 @@ type ConstraintsMap = Record<string, Predicate>;
  * Names of supported predicates, derived from a PredicateMap.
  */
 type PredicateName<T extends PredicateMap = any> = keyof T;
+/**
+ * Parameters for predicates, tailored to each field type.
+ */
 /**
  * Parameters for predicates, tailored to each field type.
  */
@@ -69,7 +162,7 @@ type PredicateParameters<T extends FieldType> = T extends "string" ? string | st
     maxItems: number;
 } : T extends "object" ? {
     schema: Record<string, unknown>;
-} : T extends "dynamic" ? any : never;
+} : T extends "record" ? Record<string, unknown> : T extends "dynamic" ? any : never;
 /** @deprecated Use PredicateParameters instead. */
 type ConstraintParameters<T extends FieldType> = PredicateParameters<T>;
 /**
@@ -120,6 +213,9 @@ interface FieldDefinition<T> {
     };
     description?: string;
     unique?: boolean;
+    hint?: {
+        input: InputHint;
+    };
 }
 /**
  * Condition for partial indexes, allowing conditional indexing based on field values.

package/index.d.ts

@@ -5,21 +5,111 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import LightningFS from '@isomorphic-git/lightning-fs';
 
 /**
- * SchemaDefinition.ts
+ * hints.ts
  *
- * Defines a robust schema specification for modeling data structures in an ERP system.
- * Supports atomic schemas with reusable nested definitions (now as mini-SchemaDefinitions),
- * flexible constraints, and indexing. Inspired by SQL pragmatism, it allows circular references
- * (via 'reference' and 'nestedSchema.id') and relies on tooling for runtime handling
- * (e.g., breaking validation/serialization loops). Intended for use with an IDE that validates
- * syntax and semantics at publish time. Versioning is managed at the root level only,
- * avoiding unnecessary API complexity.
- *
- * NOTE: Most places where a Record<string, something> is used, and something has
- * a name property,then string should be treated as an id and will be a uuid.
- * for display purposes: validation, code generation, e.t.c something.name
- * should be prefered
+ * Defines type hints for generating form input controls based on schema field definitions.
+ * Each hint type corresponds to a specific input control, providing metadata for code generation.
+ */
+/**
+ * Hints for generating a file input control.
+ */
+type FileHint = {
+    type: "file";
+    label?: string;
+    embed?: boolean;
+    mimes?: string | string[];
+    size?: {
+        max?: number;
+        min?: number;
+    };
+    dimensions?: {
+        width: number;
+        height: number;
+    };
+};
+/**
+ * Hints for generating a text-based input control.
+ */
+type TextHint = {
+    type: "text" | "email" | "tel" | "url" | "textarea";
+    label?: string;
+    placeholder?: string;
+};
+/**
+ * Hints for generating a secret input control (e.g., passwords, API keys).
  */
+type SecretHint = {
+    type: "secret";
+    label?: string;
+    placeholder?: string;
+    password?: boolean;
+};
+/**
+ * Hints for generating a number-based input control.
+ */
+type NumberHint = {
+    type: "number" | "range";
+    label?: string;
+    step?: number;
+};
+/**
+ * Hints for generating a boolean input control.
+ */
+type BooleanHint = {
+    type: "checkbox" | "radio";
+    label?: string;
+    radioLabels?: {
+        true: string;
+        false: string;
+    };
+};
+/**
+ * Hints for generating an enum input control.
+ */
+type EnumHint = {
+    type: "select" | "radio";
+    label?: string;
+};
+/**
+ * Hints for generating an array input control.
+ */
+type ArrayHint = {
+    type: "list";
+    label?: string;
+    itemHint?: {
+        type: string;
+    };
+};
+/**
+ * Hints for generating a set input control.
+ */
+type SetHint = {
+    type: "tags";
+    label?: string;
+    itemHint?: {
+        type: string;
+    };
+};
+/**
+ * Hints for generating an object input control.
+ */
+type ObjectHint = {
+    type: "group";
+    label?: string;
+    collapsible?: boolean;
+};
+/**
+ * Hints for generating a dynamic input control.
+ */
+type DynamicHint = {
+    type: "text";
+    label?: string;
+};
+/**
+ * Union type for all possible input hints.
+ */
+type InputHint = FileHint | TextHint | SecretHint | NumberHint | BooleanHint | EnumHint | ArrayHint | SetHint | ObjectHint | DynamicHint;
+
 /**
  * Logical operators for combining constraints or index conditions.
  */
@@ -27,7 +117,7 @@ type LogicalOperator = "and" | "or" | "not" | "nor" | "xor";
 /**
  * Basic field types supported by the schema system.
  */
-type FieldType = "string" | "number" | "boolean" | "array" | "set" | "enum" | "object" | "dynamic";
+type FieldType = "string" | "number" | "boolean" | "array" | "set" | "enum" | "object" | "record" | "dynamic";
 /**
  * Index types for optimizing different query patterns.
  */
@@ -54,6 +144,9 @@ type ConstraintsMap = Record<string, Predicate>;
  * Names of supported predicates, derived from a PredicateMap.
  */
 type PredicateName<T extends PredicateMap = any> = keyof T;
+/**
+ * Parameters for predicates, tailored to each field type.
+ */
 /**
  * Parameters for predicates, tailored to each field type.
  */
@@ -69,7 +162,7 @@ type PredicateParameters<T extends FieldType> = T extends "string" ? string | st
     maxItems: number;
 } : T extends "object" ? {
     schema: Record<string, unknown>;
-} : T extends "dynamic" ? any : never;
+} : T extends "record" ? Record<string, unknown> : T extends "dynamic" ? any : never;
 /** @deprecated Use PredicateParameters instead. */
 type ConstraintParameters<T extends FieldType> = PredicateParameters<T>;
 /**
@@ -120,6 +213,9 @@ interface FieldDefinition<T> {
     };
     description?: string;
     unique?: boolean;
+    hint?: {
+        input: InputHint;
+    };
 }
 /**
  * Condition for partial indexes, allowing conditional indexing based on field values.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@asaidimu/anansi",
-  "version": "1.4.0",
+  "version": "1.4.1",
   "description": "A toolkit for advanced data modelling",
   "main": "index.js",
   "types": "index.d.ts",