@asaidimu/anansi 2.0.0 → 2.1.0

package/index.d.cts

@@ -419,63 +419,6 @@ interface IndexDefinition {
  * @template T - The TypeScript type this schema represents. When `literal` is `true`, this `T`
  * corresponds to the actual primitive type (e.g., `string`, `number`).
  * When `literal` is `false`, `T` is typically an object type.
- *
- * @example
- * // Example of a concrete, object-based nested schema (like a fixed address structure)
- * ```typescript
- * const addressSchema: NestedSchemaDefinition = {
- * name: "AddressSchema",
- * description: "A concrete schema for geographical addresses.",
- * fields: {
- * street: { name: "street", type: "string", description: "Street name and number." },
- * city: { name: "city", type: "string", description: "City or town." },
- * zip: { name: "zip", type: "string", description: "Postal or zip code." }
- * },
- * concrete: true // Suitable for RDBMS table mapping
- * };
- * ```
- *
- * @example
- * // Example of a non-concrete, object-based nested schema with discriminated fields (like a contact method)
- * ```typescript
- * const contactSchema: NestedSchemaDefinition = {
- * name: "ContactMethod",
- * description: "Represents various contact methods using a discriminated union.",
- * fields: [
- * {
- * fields: {
- * type: { name: "type", type: "enum", values: ["email"], required: true },
- * email: { name: "email", type: "string", hint: { input: { type: "email" } } }
- * },
- * when: { field: "type", value: "email" }
- * },
- * {
- * fields: {
- * type: { name: "type", type: "enum", values: ["phone"], required: true },
- * phone: { name: "phone", type: "string", hint: { input: { type: "tel" } } }
- * },
- * when: { field: "type", value: "phone" }
- * }
- * ],
- * concrete: false // Allows for discriminated field sets
- * };
- * ```
- *
- * @example
- * // Example of a literal nested schema (reusable email string definition)
- * ```typescript
- * const emailStringSchema: NestedSchemaDefinition<string> = {
- * name: "EmailAddressString",
- * description: "A literal schema for a validated email address string.",
- * literal: true,
- * type: "string",
- * constraints: {
- * predicates: {
- * matches: "/^[^\s@]+@[^\s@]+\\.[^\s@]+$/" // Regex for email format validation
- * }
- * }
- * };
- * ```
  */
 type NestedSchemaDefinition<T> = {
     /**
@@ -489,23 +432,22 @@ type NestedSchemaDefinition<T> = {
      * This is crucial for documentation and understanding the schema's intent.
      */
     description?: string;
-} & (
-/**
+} & /**
  * Defines a literal nested schema.
  * When `literal` is `true`, this `NestedSchemaDefinition` represents a direct primitive value
- * (string, number, or boolean) rather than an object with fields.
+ * rather than an object with fields.
  * This is particularly useful for:
  * - Defining reusable primitive types with specific constraints (e.g., a regex for an "EmailAddress" string).
  * - Enabling direct unions between primitive types and object types within a `FieldDefinition`
  * (e.g., `FieldType: "union"`, where one `FieldSchema` references a literal type).
- */
-{
+ */ ({
     literal: true;
     /**
      * The basic primitive type that this literal schema represents.
-     * Must be one of "string", "number", or "boolean".
      */
-    type: "string" | "number" | "boolean";
+    type: "string" | "number" | "boolean" | "array" | "set" | "enum" | "record";
+    /** For type 'enum', specifies the allowed values. */
+    values?: Array<string | number>;
     /**
      * An optional default value for this literal schema.
      * If provided, the type of `default` must strictly match the `type` specified.
@@ -524,12 +466,12 @@ type NestedSchemaDefinition<T> = {
      * @example `{ uiComponent: "emailInput", validationMessage: "Invalid email format" }`
      */
     metadata?: Record<string, any>;
-} | 
+}
 /**
  * Defines a structured nested schema that represents an object with defined fields.
  * This is the traditional way of defining complex data structures within the schema.
  */
-{
+ | {
     /**
      * Explicitly indicates that this is a non-literal, structured schema.
      * Default value is `false` if omitted.

package/index.d.ts

@@ -419,63 +419,6 @@ interface IndexDefinition {
  * @template T - The TypeScript type this schema represents. When `literal` is `true`, this `T`
  * corresponds to the actual primitive type (e.g., `string`, `number`).
  * When `literal` is `false`, `T` is typically an object type.
- *
- * @example
- * // Example of a concrete, object-based nested schema (like a fixed address structure)
- * ```typescript
- * const addressSchema: NestedSchemaDefinition = {
- * name: "AddressSchema",
- * description: "A concrete schema for geographical addresses.",
- * fields: {
- * street: { name: "street", type: "string", description: "Street name and number." },
- * city: { name: "city", type: "string", description: "City or town." },
- * zip: { name: "zip", type: "string", description: "Postal or zip code." }
- * },
- * concrete: true // Suitable for RDBMS table mapping
- * };
- * ```
- *
- * @example
- * // Example of a non-concrete, object-based nested schema with discriminated fields (like a contact method)
- * ```typescript
- * const contactSchema: NestedSchemaDefinition = {
- * name: "ContactMethod",
- * description: "Represents various contact methods using a discriminated union.",
- * fields: [
- * {
- * fields: {
- * type: { name: "type", type: "enum", values: ["email"], required: true },
- * email: { name: "email", type: "string", hint: { input: { type: "email" } } }
- * },
- * when: { field: "type", value: "email" }
- * },
- * {
- * fields: {
- * type: { name: "type", type: "enum", values: ["phone"], required: true },
- * phone: { name: "phone", type: "string", hint: { input: { type: "tel" } } }
- * },
- * when: { field: "type", value: "phone" }
- * }
- * ],
- * concrete: false // Allows for discriminated field sets
- * };
- * ```
- *
- * @example
- * // Example of a literal nested schema (reusable email string definition)
- * ```typescript
- * const emailStringSchema: NestedSchemaDefinition<string> = {
- * name: "EmailAddressString",
- * description: "A literal schema for a validated email address string.",
- * literal: true,
- * type: "string",
- * constraints: {
- * predicates: {
- * matches: "/^[^\s@]+@[^\s@]+\\.[^\s@]+$/" // Regex for email format validation
- * }
- * }
- * };
- * ```
  */
 type NestedSchemaDefinition<T> = {
     /**
@@ -489,23 +432,22 @@ type NestedSchemaDefinition<T> = {
      * This is crucial for documentation and understanding the schema's intent.
      */
     description?: string;
-} & (
-/**
+} & /**
  * Defines a literal nested schema.
  * When `literal` is `true`, this `NestedSchemaDefinition` represents a direct primitive value
- * (string, number, or boolean) rather than an object with fields.
+ * rather than an object with fields.
  * This is particularly useful for:
  * - Defining reusable primitive types with specific constraints (e.g., a regex for an "EmailAddress" string).
  * - Enabling direct unions between primitive types and object types within a `FieldDefinition`
  * (e.g., `FieldType: "union"`, where one `FieldSchema` references a literal type).
- */
-{
+ */ ({
     literal: true;
     /**
      * The basic primitive type that this literal schema represents.
-     * Must be one of "string", "number", or "boolean".
      */
-    type: "string" | "number" | "boolean";
+    type: "string" | "number" | "boolean" | "array" | "set" | "enum" | "record";
+    /** For type 'enum', specifies the allowed values. */
+    values?: Array<string | number>;
     /**
      * An optional default value for this literal schema.
      * If provided, the type of `default` must strictly match the `type` specified.
@@ -524,12 +466,12 @@ type NestedSchemaDefinition<T> = {
      * @example `{ uiComponent: "emailInput", validationMessage: "Invalid email format" }`
      */
     metadata?: Record<string, any>;
-} | 
+}
 /**
  * Defines a structured nested schema that represents an object with defined fields.
  * This is the traditional way of defining complex data structures within the schema.
  */
-{
+ | {
     /**
      * Explicitly indicates that this is a non-literal, structured schema.
      * Default value is `false` if omitted.

package/package.json

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