@signaltree/ng-forms 4.0.9 → 4.0.12

package/src/audit/index.d.ts

@@ -0,0 +1,15 @@
+import { Middleware } from '@signaltree/core';
+
+interface AuditEntry<T = unknown> {
+    timestamp: number;
+    changes: Partial<T>;
+    metadata?: {
+        userId?: string;
+        source?: string;
+        description?: string;
+    };
+}
+declare function createAuditMiddleware<T>(auditLog: AuditEntry<T>[], getMetadata?: () => AuditEntry<T>['metadata']): Middleware<T>;
+
+export { createAuditMiddleware };
+export type { AuditEntry };

package/src/history/index.d.ts

@@ -0,0 +1,24 @@
+import { Signal } from '@angular/core';
+
+interface FormTree<T extends Record<string, unknown>> {
+    form: any;
+    unwrap(): T;
+    destroy(): void;
+    setValues(values: Partial<T>): void;
+}
+interface FormHistory<T> {
+    past: T[];
+    present: T;
+    future: T[];
+}
+declare function withFormHistory<T extends Record<string, unknown>>(formTree: FormTree<T>, options?: {
+    capacity?: number;
+}): FormTree<T> & {
+    undo: () => void;
+    redo: () => void;
+    clearHistory: () => void;
+    history: Signal<FormHistory<T>>;
+};
+
+export { withFormHistory };
+export type { FormHistory };

package/src/rxjs/index.d.ts

@@ -0,0 +1,6 @@
+import { Signal } from '@angular/core';
+import { Observable } from 'rxjs';
+
+declare function toObservable<T>(signal: Signal<T>): Observable<T>;
+
+export { toObservable };

package/LICENSE

@@ -1,54 +0,0 @@
-BUSINESS SOURCE LICENSE 1.1
-
-Copyright (c) 2025 Jonathan D Borgia
-
-This Business Source License 1.1 ("License") governs the use of the software and associated documentation files (the "Software"). You are granted a limited license to use the Software under the terms of this License.
-
-1. Definitions
-
-"Change Date" means the date on which the Change License set out in section 6 will apply to the Software. The Change Date for this release is 2028-09-05.
-
-"Change License" means the open source license that will apply to the Software on and after the Change Date. The Change License for this release is the MIT License.
-
-"Licensor" means the copyright owner granting rights under this License (Jonathan D Borgia).
-
-"You" ("Licensee") means an individual or legal entity exercising rights under this License who has not violated the terms of this License or had their rights terminated.
-
-2. License Grant
-
-Subject to the terms and conditions of this License, Licensor hereby grants You a non-exclusive, non-transferable, worldwide license to use, reproduce, display, perform, and distribute the Software, and to make modifications and derivative works for internal use, until the Change Date.
-
-3. Commercial Use
-
-You may use the Software in commercial applications, including for providing services, selling products that include the Software, or otherwise exploiting the Software commercially, subject to the other terms of this License.
-
-4. Limitations and Conditions
-
-a. You may not remove or alter this License, the copyright notice, or notices of the Change Date.
-
-b. You may not publicly offer a modified version of the Software that would directly compete with Licensor's public offering of the Software if doing so would circumvent the intent of this License.
-
-c. Except as expressly provided in this License, no rights are granted to You under any patent or trademark of Licensor.
-
-5. Disclaimer and Limitation of Liability
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. TO THE FULLEST EXTENT PERMITTED BY LAW, LICENSOR WILL NOT BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY ARISING FROM OR RELATING TO THE SOFTWARE.
-
-6. Change License
-
-On and after the Change Date specified above, the Software will be licensed under the Change License (MIT License) on the same terms and conditions as set forth by that Change License.
-
-7. Governing Law
-
-This License will be governed by and construed in accordance with the laws of the State of New York, USA, without regard to conflict of law principles.
-
-8. Accepting this License
-
-You accept this License by copying, modifying, or distributing the Software or any portion thereof.
-
----
-
-LICENSE NOTE
-
-- Original license file replaced on 2025-09-05 to Business Source License 1.1. Change Date: 2028-09-05. Change License: MIT.
-  or standard modifications for your own applications.

package/eslint.config.mjs

@@ -1,48 +0,0 @@
-import nx from '@nx/eslint-plugin';
-import baseConfig from '../../eslint.config.mjs';
-
-export default [
-  ...baseConfig,
-  {
-    files: ['**/*.json'],
-    rules: {
-      '@nx/dependency-checks': [
-        'error',
-        {
-          ignoredFiles: ['{projectRoot}/eslint.config.{js,cjs,mjs,ts,cts,mts}'],
-        },
-      ],
-    },
-    languageOptions: {
-      parser: await import('jsonc-eslint-parser'),
-    },
-  },
-  ...nx.configs['flat/angular'],
-  ...nx.configs['flat/angular-template'],
-  {
-    files: ['**/*.ts'],
-    rules: {
-      '@angular-eslint/directive-selector': [
-        'error',
-        {
-          type: 'attribute',
-          prefix: 'signalTree',
-          style: 'camelCase',
-        },
-      ],
-      '@angular-eslint/component-selector': [
-        'error',
-        {
-          type: 'element',
-          prefix: 'signaltree',
-          style: 'kebab-case',
-        },
-      ],
-    },
-  },
-  {
-    files: ['**/*.html'],
-    // Override or add rules here
-    rules: {},
-  },
-];

package/jest.config.ts

@@ -1,21 +0,0 @@
-export default {
-  displayName: 'ng-forms',
-  preset: '../../jest.preset.js',
-  setupFilesAfterEnv: ['<rootDir>/src/test-setup.ts'],
-  coverageDirectory: '../../coverage/packages/ng-forms',
-  transform: {
-    '^.+\\.(ts|mjs|js|html)$': [
-      'jest-preset-angular',
-      {
-        tsconfig: '<rootDir>/tsconfig.spec.json',
-        stringifyContentPathRegex: '\\.(html|svg)$',
-      },
-    ],
-  },
-  transformIgnorePatterns: ['node_modules/(?!.*\\.mjs$)'],
-  snapshotSerializers: [
-    'jest-preset-angular/build/serializers/no-ng-attributes',
-    'jest-preset-angular/build/serializers/ng-snapshot',
-    'jest-preset-angular/build/serializers/html-comment',
-  ],
-};

package/ng-package.json

@@ -1,8 +0,0 @@
-{
-  "$schema": "../../node_modules/ng-packagr/ng-package.schema.json",
-  "dest": "../../dist/packages/ng-forms",
-  "lib": {
-    "entryFile": "src/index.ts"
-  },
-  "allowedNonPeerDependencies": ["@signaltree/shared", "@signaltree/core"]
-}

package/project.json

@@ -1,48 +0,0 @@
-{
-  "name": "ng-forms",
-  "$schema": "../../node_modules/nx/schemas/project-schema.json",
-  "sourceRoot": "packages/ng-forms/src",
-  "prefix": "signaltree",
-  "projectType": "library",
-  "release": {
-    "version": {
-      "manifestRootsToUpdate": ["dist/{projectRoot}"],
-      "currentVersionResolver": "git-tag",
-      "fallbackCurrentVersionResolver": "disk"
-    }
-  },
-  "tags": [],
-  "targets": {
-    "build": {
-      "executor": "@nx/angular:package",
-      "outputs": ["{workspaceRoot}/dist/{projectRoot}"],
-      "options": {
-        "project": "packages/ng-forms/ng-package.json"
-      },
-      "configurations": {
-        "production": {
-          "tsConfig": "packages/ng-forms/tsconfig.lib.prod.json"
-        },
-        "development": {
-          "tsConfig": "packages/ng-forms/tsconfig.lib.json"
-        }
-      },
-      "defaultConfiguration": "production"
-    },
-    "nx-release-publish": {
-      "options": {
-        "packageRoot": "dist/{projectRoot}"
-      }
-    },
-    "test": {
-      "executor": "@nx/jest:jest",
-      "outputs": ["{workspaceRoot}/coverage/{projectRoot}"],
-      "options": {
-        "jestConfig": "packages/ng-forms/jest.config.ts"
-      }
-    },
-    "lint": {
-      "executor": "@nx/eslint:lint"
-    }
-  }
-}

package/src/audit/audit.ts

@@ -1,75 +0,0 @@
-/// <reference path="../types/signaltree-core.d.ts" />
-import { getChanges } from '@signaltree/shared';
-
-import type { Middleware } from '@signaltree/core';
-/**
- * Audit log entry recording form changes
- */
-export interface AuditEntry<T = unknown> {
-  /** Timestamp when change occurred */
-  timestamp: number;
-  /** Changed fields and their new values */
-  changes: Partial<T>;
-  /** Optional metadata about the change */
-  metadata?: {
-    /** User ID who made the change */
-    userId?: string;
-    /** Source of the change (e.g., 'ui', 'api', 'import') */
-    source?: string;
-    /** Human-readable description */
-    description?: string;
-  };
-}
-
-/**
- * Creates an audit middleware for form change tracking.
- * Automatically logs all form state changes with timestamps and optional metadata.
- *
- * @param auditLog - Array to collect audit entries
- * @param getMetadata - Optional function to provide metadata for each change
- * @returns Middleware that records form changes
- *
- * @example
- * ```typescript
- * const auditLog: AuditEntry<MyFormData>[] = [];
- *
- * const form = createFormTree(
- *   { name: '', email: '' },
- *   {
- *     middleware: [
- *       createAuditMiddleware(auditLog, () => ({
- *         userId: currentUser.id,
- *         source: 'form-editor'
- *       }))
- *     ]
- *   }
- * );
- *
- * form.$.name.set('John');
- *
- * console.log(auditLog);
- * // [{
- * //   timestamp: 1234567890,
- * //   changes: { name: 'John' },
- * //   metadata: { userId: '123', source: 'form-editor' }
- * // }]
- * ```
- */
-export function createAuditMiddleware<T>(
-  auditLog: AuditEntry<T>[],
-  getMetadata?: () => AuditEntry<T>['metadata']
-): Middleware<T> {
-  return {
-    id: 'audit',
-    after: (_action: string, _payload: unknown, oldState: T, newState: T) => {
-      const changes = getChanges(oldState, newState);
-      if (Object.keys(changes).length > 0) {
-        auditLog.push({
-          timestamp: Date.now(),
-          changes,
-          metadata: getMetadata?.(),
-        });
-      }
-    },
-  };
-}

package/src/audit/index.ts

@@ -1 +0,0 @@
-export { createAuditMiddleware, type AuditEntry } from './audit';

package/src/audit/ng-package.json

@@ -1,5 +0,0 @@
-{
-  "lib": {
-    "entryFile": "index.ts"
-  }
-}

package/src/core/async-validators.ts

@@ -1,80 +0,0 @@
-import { firstValueFrom, isObservable } from 'rxjs';
-
-/**
- * @fileoverview Tree-shakeable async validator functions for form fields
- */
-
-import type { FormTreeAsyncValidatorFn } from './ng-forms';
-
-/**
- * Creates an async uniqueness validator
- *
- * @param checkFn - Async function that returns true if value already exists
- * @param message - Custom error message (default: "Already exists")
- * @returns Async validator function
- *
- * @example
- * ```typescript
- * createFormTree(data, {
- *   asyncValidators: {
- *     email: unique(
- *       async (email) => {
- *         const response = await fetch(`/api/check-email?email=${email}`);
- *         const { exists } = await response.json();
- *         return exists;
- *       },
- *       'This email is already registered'
- *     )
- *   }
- * });
- * ```
- */
-export function unique(
-  checkFn: (value: unknown) => Promise<boolean>,
-  message = 'Already exists'
-): FormTreeAsyncValidatorFn<unknown> {
-  return async (value: unknown) => {
-    if (!value) return null;
-    const exists = await checkFn(value);
-    return exists ? message : null;
-  };
-}
-
-/**
- * Creates a debounced async validator
- *
- * @param validator - The async validator to debounce
- * @param delayMs - Delay in milliseconds before running validation
- * @returns Debounced async validator
- *
- * @example
- * ```typescript
- * createFormTree(data, {
- *   asyncValidators: {
- *     username: debounce(
- *       unique(checkUsername, 'Username taken'),
- *       500 // Wait 500ms after user stops typing
- *     )
- *   }
- * });
- * ```
- */
-export function debounce(
-  validator: FormTreeAsyncValidatorFn<unknown>,
-  delayMs: number
-): FormTreeAsyncValidatorFn<unknown> {
-  let timeoutId: ReturnType<typeof setTimeout>;
-
-  return async (value: unknown) => {
-    return new Promise((resolve) => {
-      clearTimeout(timeoutId);
-      timeoutId = setTimeout(async () => {
-        const maybeAsync = validator(value);
-        const result = isObservable(maybeAsync)
-          ? await firstValueFrom(maybeAsync)
-          : await maybeAsync;
-        resolve(result);
-      }, delayMs);
-    });
-  };
-}

package/src/core/ng-forms.spec.ts

@@ -1,204 +0,0 @@
-import { AuditEntry, createAuditMiddleware } from '../audit/audit';
-import { toObservable } from '../rxjs/rxjs-bridge';
-import { unique } from './async-validators';
-import { createFormTree, SIGNAL_FORM_DIRECTIVES, SignalValueDirective } from './ng-forms';
-import { email as emailValidator, minLength, pattern, required } from './validators';
-
-interface TestFormData extends Record<string, unknown> {
-  username: string;
-  email: string;
-  age: number;
-  preferences: {
-    newsletter: boolean;
-    theme: string;
-  };
-  tags: string[];
-}
-
-describe('NgForms', () => {
-  let initialFormData: TestFormData;
-
-  beforeEach(() => {
-    initialFormData = {
-      username: '',
-      email: '',
-      age: 0,
-      preferences: {
-        newsletter: false,
-        theme: 'light',
-      },
-      tags: [],
-    };
-  });
-
-  describe('createFormTree', () => {
-    it('should create a form tree with form-specific signals', () => {
-      const form = createFormTree(initialFormData);
-
-      expect(form.state).toBeDefined();
-      expect(form.$).toBe(form.state); // Alias
-      expect(form.errors).toBeDefined();
-      expect(form.asyncErrors).toBeDefined();
-      expect(form.touched).toBeDefined();
-      expect(form.asyncValidating).toBeDefined();
-      expect(form.dirty).toBeDefined();
-      expect(form.valid).toBeDefined();
-      expect(form.submitting).toBeDefined();
-    });
-
-    it('should support field validation', async () => {
-      const form = createFormTree(initialFormData, {
-        validators: {
-          username: required('Username is required'),
-          email: emailValidator('Invalid email'),
-        },
-      });
-
-      form.setValue('username', '');
-      await new Promise((resolve) => setTimeout(resolve, 0)); // Allow async validation
-
-      expect(form.errors()['username']).toBe('Username is required');
-      expect(form.valid()).toBe(false);
-    });
-
-    it('should track touched fields', () => {
-      const form = createFormTree(initialFormData);
-
-      expect(form.touched()['username']).toBeUndefined();
-
-      form.setValue('username', 'test');
-
-      expect(form.touched()['username']).toBe(true);
-    });
-
-    it('should mark form as dirty when values change', () => {
-      const form = createFormTree(initialFormData);
-
-      expect(form.dirty()).toBe(false);
-
-      form.setValue('username', 'test');
-
-      expect(form.dirty()).toBe(true);
-    });
-
-    it('should support form reset', () => {
-      const form = createFormTree(initialFormData);
-
-      form.setValue('username', 'test');
-      form.setValue('email', 'test@example.com');
-
-      expect(form.dirty()).toBe(true);
-      expect(form.state.username()).toBe('test');
-
-      form.reset();
-
-      expect(form.dirty()).toBe(false);
-      expect(form.state.username()).toBe('');
-      expect(Object.keys(form.errors()).length).toBe(0);
-    });
-
-    it('should support async validation', async () => {
-      const form = createFormTree(initialFormData, {
-        asyncValidators: {
-          username: unique(
-            async (value: unknown) => value === 'taken',
-            'Username already exists'
-          ),
-        },
-      });
-
-      form.setValue('username', 'taken');
-      await new Promise((resolve) => setTimeout(resolve, 100));
-
-      expect(form.asyncErrors()['username']).toBe('Username already exists');
-      expect(form.valid()).toBe(false);
-    });
-
-    it('should support form submission', async () => {
-      const form = createFormTree(initialFormData, {
-        validators: {
-          username: required(),
-        },
-      });
-
-      form.setValue('username', 'testuser');
-      form.setValue('email', 'test@example.com');
-
-      const submitData = await form.submit(async (values) => {
-        return { success: true, data: values };
-      });
-
-      expect(submitData.success).toBe(true);
-      expect(submitData.data['username']).toBe('testuser');
-    });
-  });
-
-  describe('SignalValueDirective', () => {
-    it('should be defined and exportable', () => {
-      expect(SignalValueDirective).toBeDefined();
-      expect(SIGNAL_FORM_DIRECTIVES).toContain(SignalValueDirective);
-    });
-  });
-
-  describe('validators', () => {
-    it('should provide required validator', () => {
-      const requiredValidator = required('This field is required');
-
-      expect(requiredValidator('')).toBe('This field is required');
-      expect(requiredValidator('value')).toBe(null);
-    });
-
-    it('should provide email validator', () => {
-      const emailValidatorFn = emailValidator();
-
-      expect(emailValidatorFn('notanemail')).toBe('Invalid email');
-      expect(emailValidatorFn('test@example.com')).toBe(null);
-    });
-
-    it('should provide minLength validator', () => {
-      const minLengthValidator = minLength(5);
-
-      expect(minLengthValidator('abc')).toBe('Min 5 characters');
-      expect(minLengthValidator('abcdef')).toBe(null);
-    });
-
-    it('should provide pattern validator', () => {
-      const patternValidator = pattern(/^\d+$/, 'Must be numeric');
-
-      expect(patternValidator('abc')).toBe('Must be numeric');
-      expect(patternValidator('123')).toBe(null);
-    });
-  });
-
-  describe('asyncValidators', () => {
-    it('should provide unique validator', async () => {
-      const uniqueValidator = unique(
-        async (value: unknown) => value === 'taken',
-        'Already exists'
-      );
-
-      expect(await uniqueValidator('available')).toBe(null);
-      expect(await uniqueValidator('taken')).toBe('Already exists');
-    });
-  });
-
-  describe('createAuditMiddleware', () => {
-    it('should track changes in audit log', () => {
-      const auditLog: AuditEntry[] = [];
-      const middleware = createAuditMiddleware(auditLog, () => ({
-        userId: 'test-user',
-      }));
-
-      expect(middleware.id).toBe('audit');
-      expect(typeof middleware.after).toBe('function');
-    });
-  });
-
-  describe('toObservable', () => {
-    it('should convert signal to observable', (done) => {
-      // This would need proper Angular testing setup for full test
-      expect(typeof toObservable).toBe('function');
-      done();
-    });
-  });
-});