ai-props 0.1.2 → 2.0.2

package/test/validate.test.ts

@@ -0,0 +1,324 @@
+/**
+ * Tests for ai-props validation utilities
+ */
+
+import { describe, it, expect } from 'vitest'
+import {
+  validateProps,
+  hasRequiredProps,
+  getMissingProps,
+  isComplete,
+  getMissingFromSchema,
+  sanitizeProps,
+  mergeWithDefaults,
+  createValidator,
+  assertValidProps,
+} from '../src/validate.js'
+
+describe('validateProps', () => {
+  it('validates simple string props', () => {
+    const result = validateProps(
+      { name: 'John', email: 'john@example.com' },
+      { name: 'User name', email: 'Email address' }
+    )
+
+    expect(result.valid).toBe(true)
+    expect(result.errors).toHaveLength(0)
+  })
+
+  it('validates props with type hints', () => {
+    const result = validateProps(
+      { name: 'John', age: 25 },
+      { name: 'User name', age: 'Age (number)' }
+    )
+
+    expect(result.valid).toBe(true)
+    expect(result.errors).toHaveLength(0)
+  })
+
+  it('detects type mismatches', () => {
+    const result = validateProps(
+      { name: 'John', age: 'twenty-five' },
+      { name: 'User name', age: 'Age (number)' }
+    )
+
+    expect(result.valid).toBe(false)
+    expect(result.errors).toHaveLength(1)
+    expect(result.errors[0]?.path).toBe('age')
+    expect(result.errors[0]?.expected).toBe('number')
+  })
+
+  it('validates boolean props', () => {
+    const validResult = validateProps(
+      { active: true },
+      { active: 'Is active (boolean)' }
+    )
+    expect(validResult.valid).toBe(true)
+
+    const invalidResult = validateProps(
+      { active: 'yes' },
+      { active: 'Is active (boolean)' }
+    )
+    expect(invalidResult.valid).toBe(false)
+  })
+
+  it('validates array props', () => {
+    const result = validateProps(
+      { tags: ['a', 'b', 'c'] },
+      { tags: ['Tag names'] }
+    )
+
+    expect(result.valid).toBe(true)
+  })
+
+  it('detects array type mismatch', () => {
+    const result = validateProps(
+      { tags: 'not-an-array' },
+      { tags: ['Tag names'] }
+    )
+
+    expect(result.valid).toBe(false)
+    expect(result.errors[0]?.expected).toBe('array')
+  })
+
+  it('validates nested objects', () => {
+    const result = validateProps(
+      { user: { name: 'John', age: 25 } },
+      { user: { name: 'User name', age: 'Age (number)' } }
+    )
+
+    expect(result.valid).toBe(true)
+  })
+
+  it('detects nested object errors', () => {
+    const result = validateProps(
+      { user: { name: 'John', age: 'invalid' } },
+      { user: { name: 'User name', age: 'Age (number)' } }
+    )
+
+    expect(result.valid).toBe(false)
+    expect(result.errors[0]?.path).toBe('user.age')
+  })
+
+  it('handles missing optional props', () => {
+    const result = validateProps(
+      { name: 'John' },
+      { name: 'User name', bio: 'Biography' }
+    )
+
+    // Missing props without value are considered optional
+    expect(result.valid).toBe(true)
+  })
+
+  it('validates string schemas', () => {
+    const validResult = validateProps(
+      { value: 'test' },
+      'A test value'
+    )
+    expect(validResult.valid).toBe(true)
+
+    const invalidResult = validateProps(
+      {},
+      'A test value'
+    )
+    expect(invalidResult.valid).toBe(false)
+  })
+})
+
+describe('hasRequiredProps', () => {
+  it('returns true when all required props present', () => {
+    expect(hasRequiredProps(
+      { name: 'John', email: 'john@example.com' },
+      ['name', 'email']
+    )).toBe(true)
+  })
+
+  it('returns false when required prop missing', () => {
+    expect(hasRequiredProps(
+      { name: 'John' },
+      ['name', 'email']
+    )).toBe(false)
+  })
+
+  it('returns true for empty required array', () => {
+    expect(hasRequiredProps({ name: 'John' }, [])).toBe(true)
+  })
+
+  it('handles undefined values', () => {
+    expect(hasRequiredProps(
+      { name: 'John', email: undefined },
+      ['name', 'email']
+    )).toBe(false)
+  })
+})
+
+describe('getMissingProps', () => {
+  it('returns empty array when all present', () => {
+    expect(getMissingProps(
+      { name: 'John', email: 'john@example.com' },
+      ['name', 'email']
+    )).toEqual([])
+  })
+
+  it('returns missing prop keys', () => {
+    expect(getMissingProps(
+      { name: 'John' },
+      ['name', 'email', 'phone']
+    )).toEqual(['email', 'phone'])
+  })
+})
+
+describe('isComplete', () => {
+  it('returns true when all schema keys present', () => {
+    expect(isComplete(
+      { name: 'John', age: 25 },
+      { name: 'Name', age: 'Age (number)' }
+    )).toBe(true)
+  })
+
+  it('returns false when keys missing', () => {
+    expect(isComplete(
+      { name: 'John' },
+      { name: 'Name', age: 'Age (number)' }
+    )).toBe(false)
+  })
+
+  it('handles string schemas', () => {
+    expect(isComplete({ value: 'test' }, 'A value')).toBe(true)
+    expect(isComplete({}, 'A value')).toBe(false)
+  })
+})
+
+describe('getMissingFromSchema', () => {
+  it('returns empty array when complete', () => {
+    expect(getMissingFromSchema(
+      { name: 'John', age: 25 },
+      { name: 'Name', age: 'Age' }
+    )).toEqual([])
+  })
+
+  it('returns missing schema keys', () => {
+    expect(getMissingFromSchema(
+      { name: 'John' },
+      { name: 'Name', age: 'Age', email: 'Email' }
+    )).toEqual(['age', 'email'])
+  })
+
+  it('handles string schemas', () => {
+    expect(getMissingFromSchema({}, 'A value')).toEqual(['value'])
+    expect(getMissingFromSchema({ value: 'x' }, 'A value')).toEqual([])
+  })
+})
+
+describe('sanitizeProps', () => {
+  it('removes extra keys not in schema', () => {
+    const result = sanitizeProps(
+      { name: 'John', extra: 'value', another: 123 },
+      { name: 'User name' }
+    )
+
+    expect(result).toEqual({ name: 'John' })
+  })
+
+  it('keeps all schema keys present in props', () => {
+    const result = sanitizeProps(
+      { name: 'John', age: 25 },
+      { name: 'Name', age: 'Age', email: 'Email' }
+    )
+
+    expect(result).toEqual({ name: 'John', age: 25 })
+  })
+
+  it('handles string schemas', () => {
+    const result = sanitizeProps(
+      { value: 'test', extra: 'ignored' },
+      'A value'
+    )
+
+    expect(result).toEqual({ value: 'test' })
+  })
+})
+
+describe('mergeWithDefaults', () => {
+  it('merges defaults with provided props', () => {
+    const result = mergeWithDefaults(
+      { name: 'John' },
+      { name: 'Default', age: 0 },
+      { name: 'Name', age: 'Age (number)' }
+    )
+
+    expect(result).toEqual({ name: 'John', age: 0 })
+  })
+
+  it('props override defaults', () => {
+    const result = mergeWithDefaults(
+      { name: 'John', age: 25 },
+      { name: 'Default', age: 0 },
+      { name: 'Name', age: 'Age' }
+    )
+
+    expect(result).toEqual({ name: 'John', age: 25 })
+  })
+
+  it('coerces types according to schema', () => {
+    const result = mergeWithDefaults(
+      { count: '42' },
+      { count: 0 },
+      { count: 'Count (number)' }
+    )
+
+    expect(result.count).toBe(42)
+    expect(typeof result.count).toBe('number')
+  })
+
+  it('handles integer type hint', () => {
+    const result = mergeWithDefaults(
+      { count: 42.7 },
+      {},
+      { count: 'Count (integer)' }
+    )
+
+    expect(result.count).toBe(42)
+  })
+})
+
+describe('createValidator', () => {
+  it('creates reusable validator function', () => {
+    const validate = createValidator({ name: 'Name', age: 'Age (number)' })
+
+    const valid = validate({ name: 'John', age: 25 })
+    expect(valid.valid).toBe(true)
+
+    const invalid = validate({ name: 'John', age: 'invalid' })
+    expect(invalid.valid).toBe(false)
+  })
+})
+
+describe('assertValidProps', () => {
+  it('does not throw for valid props', () => {
+    expect(() => {
+      assertValidProps(
+        { name: 'John', age: 25 },
+        { name: 'Name', age: 'Age (number)' }
+      )
+    }).not.toThrow()
+  })
+
+  it('throws for invalid props', () => {
+    expect(() => {
+      assertValidProps(
+        { name: 'John', age: 'invalid' },
+        { name: 'Name', age: 'Age (number)' }
+      )
+    }).toThrow('Invalid props')
+  })
+
+  it('includes error details in message', () => {
+    expect(() => {
+      assertValidProps(
+        { age: 'invalid' },
+        { age: 'Age (number)' }
+      )
+    }).toThrow('age')
+  })
+})

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts", "**/*.spec.ts"]
+}

package/vitest.config.ts

@@ -0,0 +1,15 @@
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+  test: {
+    globals: true,
+    environment: 'node',
+    include: ['test/**/*.test.ts'],
+    coverage: {
+      provider: 'v8',
+      reporter: ['text', 'json', 'html'],
+      include: ['src/**/*.ts'],
+      exclude: ['src/**/*.d.ts'],
+    },
+  },
+})

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2024 AI Primitives
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

package/dist/AI.d.ts

@@ -1,27 +0,0 @@
-import { z } from 'zod';
-import { type SchemaObject } from './utils/schema';
-type ModelType = string | {
-    provider: string;
-    model: string;
-};
-interface AIProps<T extends Record<string, unknown>, O extends 'object' | 'array' = 'object'> {
-    schema: z.ZodSchema<T> | SchemaObject;
-    prompt: string;
-    model?: ModelType;
-    output?: O;
-    count?: number;
-    cols?: number;
-    mode?: 'json';
-    stream?: boolean;
-    apiEndpoint?: string;
-    headers?: Record<string, string>;
-    experimental_telemetry?: boolean;
-    experimental_providerMetadata?: boolean;
-    className?: string;
-    itemClassName?: string;
-    gap?: string;
-    children: (props: O extends 'array' ? T[] : T) => React.ReactNode;
-}
-export declare function AI<T extends Record<string, unknown>, O extends 'object' | 'array' = 'object'>({ children, prompt, schema: rawSchema, model, output, count, cols, mode, stream, apiEndpoint, headers, experimental_telemetry, experimental_providerMetadata, className, itemClassName, gap, }: AIProps<T, O>): string | number | boolean | Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
-export {};
-//# sourceMappingURL=AI.d.ts.map

package/dist/AI.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AI.d.ts","sourceRoot":"","sources":["../src/AI.tsx"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,OAAO,EAAuC,KAAK,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAEvF,KAAK,SAAS,GAAG,MAAM,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAE7D,UAAU,OAAO,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,QAAQ,GAAG,OAAO,GAAG,QAAQ;IAC1F,MAAM,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,YAAY,CAAA;IACrC,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,SAAS,CAAA;IACjB,MAAM,CAAC,EAAE,CAAC,CAAA;IACV,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,sBAAsB,CAAC,EAAE,OAAO,CAAA;IAChC,6BAA6B,CAAC,EAAE,OAAO,CAAA;IACvC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,SAAS,OAAO,GAAG,CAAC,EAAE,GAAG,CAAC,KAAK,KAAK,CAAC,SAAS,CAAA;CAClE;AAMD,wBAAgB,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,CAAC,SAAS,QAAQ,GAAG,OAAO,GAAG,QAAQ,EAAE,EAC7F,QAAQ,EACR,MAAM,EACN,MAAM,EAAE,SAAS,EACjB,KAAe,EACf,MAAsB,EACtB,KAAK,EACL,IAAI,EACJ,IAAa,EACb,MAAc,EACd,WAAW,EACX,OAAO,EACP,sBAAsB,EACtB,6BAA6B,EAC7B,SAAS,EACT,aAAa,EACb,GAAY,GACb,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC,gIAoGf"}

package/dist/AI.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=AI.test.d.ts.map

package/dist/AI.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"AI.test.d.ts","sourceRoot":"","sources":["../src/AI.test.tsx"],"names":[],"mappings":""}