@pilotiq/pilotiq 0.24.1 → 0.24.3

package/src/validation/uniqueValidator.test.ts

@@ -1,196 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { unique } from './uniqueValidator.js'
-import type { ModelLike, ModelQuery } from '../orm/modelDefaults.js'
-
-// ── Fake ModelLike — records every where() call so tests can assert ──
-
-interface FakeQueryOp { op: string; args: unknown[] }
-
-class FakeQuery implements ModelQuery {
-  ops: FakeQueryOp[] = []
-  constructor(private readonly _data: unknown[]) {}
-
-  where(...args: unknown[]): ModelQuery   { this.ops.push({ op: 'where',   args }); return this }
-  orWhere(...args: unknown[]): ModelQuery { this.ops.push({ op: 'orWhere', args }); return this }
-  orderBy(column: string, direction: 'ASC' | 'DESC' = 'ASC'): ModelQuery {
-    this.ops.push({ op: 'orderBy', args: [column, direction] }); return this
-  }
-  async paginate(page: number, perPage?: number) {
-    this.ops.push({ op: 'paginate', args: [page, perPage] })
-    return { data: this._data, total: this._data.length }
-  }
-}
-
-function makeModel(opts: { rows?: unknown[]; primaryKey?: string } = {}) {
-  let lastQuery: FakeQuery | null = null
-  const model = {
-    primaryKey: opts.primaryKey,
-    async find() { return null },
-    async create(data: Record<string, unknown>) { return { id: 'new', ...data } },
-    async update(id: string | number, data: Record<string, unknown>) { return { id, ...data } },
-    async delete() {},
-    query(): ModelQuery {
-      const q = new FakeQuery(opts.rows ?? [])
-      lastQuery = q
-      return q
-    },
-    get lastQuery() { return lastQuery },
-  } as unknown as ModelLike & { lastQuery: FakeQuery | null }
-  return model
-}
-
-describe('unique() validator', () => {
-  it('passes when value is empty (defers to required())', async () => {
-    const model = makeModel({ rows: [{ id: 1, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email' })
-    assert.equal(await v(''),        null)
-    assert.equal(await v(null),      null)
-    assert.equal(await v(undefined), null)
-  })
-
-  it('passes when no row matches', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({ model, column: 'email' })
-    assert.equal(await v('new@b.com', { values: { email: 'new@b.com' } }), null)
-  })
-
-  it('rejects when a row matches and there is no current record (create)', async () => {
-    const model = makeModel({ rows: [{ id: 1, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email' })
-    assert.equal(await v('a@b.com', { values: { email: 'a@b.com' } }), 'Already taken')
-  })
-
-  it('passes on edit when the only matching row is the record under edit', async () => {
-    const model = makeModel({ rows: [{ id: 7, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email' })
-    const ctx = { values: { email: 'a@b.com' }, record: { id: 7, email: 'a@b.com' } }
-    assert.equal(await v('a@b.com', ctx), null)
-  })
-
-  it('rejects on edit when matching row is a DIFFERENT record', async () => {
-    const model = makeModel({ rows: [{ id: 99, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email' })
-    const ctx = { values: { email: 'a@b.com' }, record: { id: 7, email: 'old@b.com' } }
-    assert.equal(await v('a@b.com', ctx), 'Already taken')
-  })
-
-  it('honors primaryKey override on the model', async () => {
-    const model = makeModel({ rows: [{ uuid: 'abc', email: 'a@b.com' }], primaryKey: 'uuid' })
-    const v = unique({ model, column: 'email' })
-    const ctx = { values: { email: 'a@b.com' }, record: { uuid: 'abc' } }
-    assert.equal(await v('a@b.com', ctx), null)
-  })
-
-  it('ignoreRecord:false rejects even when the match is the current record', async () => {
-    const model = makeModel({ rows: [{ id: 7, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email', ignoreRecord: false })
-    const ctx = { values: { email: 'a@b.com' }, record: { id: 7 } }
-    assert.equal(await v('a@b.com', ctx), 'Already taken')
-  })
-
-  it('emits a custom message when configured', async () => {
-    const model = makeModel({ rows: [{ id: 1, email: 'a@b.com' }] })
-    const v = unique({ model, column: 'email', message: 'That email is taken' })
-    assert.equal(await v('a@b.com', { values: { email: 'a@b.com' } }), 'That email is taken')
-  })
-
-  it('caseInsensitive uses LIKE with escaped wildcards', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({ model, column: 'name', caseInsensitive: true })
-    await v('100% solid_steel\\bar', { values: { name: '100% solid_steel\\bar' } })
-    const where = model.lastQuery!.ops.find(o => o.op === 'where')
-    assert.deepEqual(where!.args, ['name', 'LIKE', '100\\% solid\\_steel\\\\bar'])
-  })
-
-  it('caseInsensitive uses plain where for non-strings', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({ model, column: 'count', caseInsensitive: true })
-    await v(42, { values: { count: 42 } })
-    const where = model.lastQuery!.ops.find(o => o.op === 'where')
-    assert.deepEqual(where!.args, ['count', 42])
-  })
-
-  it('applies extra where() clauses for scoped uniqueness', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({
-      model, column: 'name',
-      where: ({ values }) => ({ tenantId: values?.tenantId }),
-    })
-    await v('Alpha', { values: { name: 'Alpha', tenantId: 't-1' } })
-    const wheres = model.lastQuery!.ops.filter(o => o.op === 'where')
-    assert.equal(wheres.length, 2)
-    assert.deepEqual(wheres[0]!.args, ['name', 'Alpha'])
-    assert.deepEqual(wheres[1]!.args, ['tenantId', 't-1'])
-  })
-
-  it('skips where() entries with undefined value', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({
-      model, column: 'name',
-      where: () => ({ tenantId: undefined, status: 'active' }),
-    })
-    await v('Alpha', { values: { name: 'Alpha' } })
-    const wheres = model.lastQuery!.ops.filter(o => o.op === 'where')
-    assert.equal(wheres.length, 2) // primary + status, NOT tenantId
-    assert.deepEqual(wheres[1]!.args, ['status', 'active'])
-  })
-
-  it('falls back to ctx.values key when column option is omitted', async () => {
-    // The validator doesn't know its owning Field's name, so without
-    // `column` it scans ctx.values for a key whose value matches `value`.
-    const model = makeModel({ rows: [{ id: 1, slug: 'taken' }] })
-    const v = unique({ model })
-    assert.equal(await v('taken', { values: { slug: 'taken' } }), 'Already taken')
-    const where = model.lastQuery!.ops.find(o => o.op === 'where')
-    assert.deepEqual(where!.args, ['slug', 'taken'])
-  })
-
-  it('paginates with (1, 2) so we can distinguish own-record from real conflict', async () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({ model, column: 'email' })
-    await v('x@y.com', { values: { email: 'x@y.com' } })
-    const page = model.lastQuery!.ops.find(o => o.op === 'paginate')
-    assert.deepEqual(page!.args, [1, 2])
-  })
-
-  it('rejects on edit when 2+ rows match, even if one is the current record', async () => {
-    // Defensive: shouldn't happen with a real unique index, but if it
-    // does, "every match is me" is false → conflict.
-    const model = makeModel({
-      rows: [{ id: 7, email: 'a@b.com' }, { id: 99, email: 'a@b.com' }],
-    })
-    const v = unique({ model, column: 'email' })
-    const ctx = { values: { email: 'a@b.com' }, record: { id: 7 } }
-    assert.equal(await v('a@b.com', ctx), 'Already taken')
-  })
-
-  it('thrown errors propagate (no silent fail-closed)', async () => {
-    const model = {
-      async find() { return null },
-      async create() { return null },
-      async update() { return null },
-      async delete() {},
-      query(): ModelQuery {
-        return {
-          where() { return this },
-          orWhere() { return this },
-          orderBy() { return this },
-          async paginate() { throw new Error('db down') },
-        } as unknown as ModelQuery
-      },
-    } as ModelLike
-    const v = unique({ model, column: 'email' })
-    await assert.rejects(
-      async () => { await v('a@b.com', { values: { email: 'a@b.com' } }) },
-      /db down/,
-    )
-  })
-
-  it('carries no serialized descriptor (skips client mirroring)', () => {
-    const model = makeModel({ rows: [] })
-    const v = unique({ model, column: 'email' })
-    assert.equal(v.serialized, undefined)
-  })
-})

package/src/validation/uniqueValidator.ts

@@ -1,133 +0,0 @@
-import { makeValidator, type Validator, type ValidatorContext } from './Validator.js'
-import { getPrimaryKey, type ModelLike } from '../orm/modelDefaults.js'
-
-export interface UniqueOptions {
-  /**
-   * The model to probe. Any `ModelLike` works — `query().where(col, value)
-   * .paginate(1, 2)` is the only contract used, so no new ORM method is
-   * required. A class extending `@rudderjs/orm`'s `Model` satisfies this
-   * automatically.
-   */
-  model: ModelLike
-
-  /**
-   * Column to match the field's value against. Defaults to the field's own
-   * name — sufficient for the common `email` / `slug` / `username` case.
-   */
-  column?: string
-
-  /**
-   * Whether to exclude the record under edit from the probe. Defaults to
-   * `true` — on edit, the validator skips when the only matching row IS
-   * the current record (so saving "no change" doesn't trigger a conflict).
-   * Pass `false` to forbid all matches even when editing the same row.
-   *
-   * Has no effect on create — there's no `ctx.record` to ignore.
-   */
-  ignoreRecord?: boolean
-
-  /**
-   * Extra equality clauses for scoped uniqueness. Receives the validator
-   * context (`{ values, record }`) so the scope can read sibling fields:
-   *
-   *     unique({ model: Project, where: ({ values }) => ({ tenantId: values.tenantId }) })
-   *
-   * Each entry is applied as `query().where(key, value)`. Skipped entirely
-   * when the function returns `undefined` or an empty object.
-   */
-  where?: (ctx: ValidatorContext) => Record<string, unknown> | undefined
-
-  /**
-   * Treat string comparisons as case-insensitive. Implemented via SQL
-   * `LIKE` on the value with `%` / `_` / `\` escaped — so it stays an
-   * exact match, just collation-folded. Works on SQLite (default `NOCASE`
-   * for ASCII) and MySQL (default collation), and is collation-dependent
-   * on Postgres. For Postgres apps that need locale-aware folding, use a
-   * `citext` column or a custom `where(fn)` against a generated lower-cased
-   * column instead of this flag.
-   */
-  caseInsensitive?: boolean
-
-  /** Override the default error message. */
-  message?: string
-}
-
-/**
- * Async validator: rejects when another row in the table already has the
- * same value in `column` (subject to `where` / `ignoreRecord`). Empty
- * values pass — pair with `required()` if the field is mandatory.
- *
- * The probe is `M.query().where(column, value).paginate(1, 2)` — pulls at
- * most 2 rows so we can distinguish "no match" / "only own record" /
- * "real conflict" without a `count(*)` contract.
- *
- * Carries no `serialized` descriptor, so the client doesn't try to mirror
- * the rule for live UX. The roundtrip happens once on submit.
- */
-export function unique(opts: UniqueOptions): Validator {
-  const message = opts.message ?? 'Already taken'
-  const ignoreRecord = opts.ignoreRecord ?? true
-
-  return makeValidator(async (value, ctx) => {
-    if (value === undefined || value === null || value === '') return null
-
-    // Resolve column lazily: validators don't know their owning Field's name,
-    // so we accept that the caller either passes `column` explicitly or we
-    // fall back to whichever key in `ctx.values` matches `value`. The
-    // explicit `column` path is the recommended one — the fallback is a
-    // best-effort convenience for the trivial single-field case.
-    const column = opts.column ?? findColumnForValue(ctx, value)
-    if (!column) return null
-
-    let q = opts.model.query()
-
-    if (opts.caseInsensitive && typeof value === 'string') {
-      q = q.where(column, 'LIKE', escapeLikeLiteral(value))
-    } else {
-      q = q.where(column, value)
-    }
-
-    const extra = opts.where?.(ctx ?? {})
-    if (extra) {
-      for (const [key, val] of Object.entries(extra)) {
-        if (val === undefined) continue
-        q = q.where(key, val)
-      }
-    }
-
-    const { data } = await q.paginate(1, 2)
-    if (data.length === 0) return null
-
-    if (ignoreRecord && ctx?.record) {
-      const pk = getPrimaryKey(opts.model)
-      const ownPk = (ctx.record as Record<string, unknown>)[pk]
-      if (ownPk !== undefined && ownPk !== null) {
-        const onlyOwn = data.every(row => {
-          const rowPk = (row as Record<string, unknown>)[pk]
-          return rowPk === ownPk
-        })
-        if (onlyOwn) return null
-      }
-    }
-
-    return message
-  })
-}
-
-function findColumnForValue(ctx: ValidatorContext | undefined, value: unknown): string | undefined {
-  const values = ctx?.values
-  if (!values) return undefined
-  for (const [k, v] of Object.entries(values)) {
-    if (v === value) return k
-  }
-  return undefined
-}
-
-/**
- * Escape SQL `LIKE`'s wildcard chars so the comparison stays an exact
- * match. `%` matches any sequence, `_` any single char, `\` is the
- * escape char itself (with the default LIKE escape).
- */
-function escapeLikeLiteral(s: string): string {
-  return s.replace(/[%_\\]/g, '\\$&')
-}

package/src/validation/validators.test.ts

@@ -1,268 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { TextField } from '../fields/TextField.js'
-import { EmailField } from '../fields/EmailField.js'
-import { NumberField } from '../fields/NumberField.js'
-import { Section } from '../schema/Section.js'
-import { Card } from '../schema/Card.js'
-import { Tabs, Tab } from '../schema/Tabs.js'
-
-import { makeValidator } from './Validator.js'
-import { required, email, minLength, maxLength, min, max, pattern } from './rules.js'
-import { validateSchema, isValid } from './runValidators.js'
-
-describe('built-in validators', () => {
-  describe('required', () => {
-    it('rejects empty string, null, and undefined', () => {
-      const v = required()
-      assert.equal(v(''),         'This field is required')
-      assert.equal(v(null),       'This field is required')
-      assert.equal(v(undefined),  'This field is required')
-    })
-
-    it('accepts non-empty values (including 0 and false)', () => {
-      const v = required()
-      assert.equal(v('hi'),  null)
-      assert.equal(v(0),     null)
-      assert.equal(v(false), null)
-    })
-
-    it('honors a custom message', () => {
-      assert.equal(required('Required!')(''), 'Required!')
-    })
-
-    it('serializes to { rule: "required", message }', () => {
-      assert.deepEqual(required().serialized, { rule: 'required', message: 'This field is required' })
-    })
-  })
-
-  describe('email', () => {
-    it('passes empty values (combine with required for "must have an email")', () => {
-      assert.equal(email()(''),        null)
-      assert.equal(email()(undefined), null)
-    })
-
-    it('rejects malformed emails', () => {
-      assert.equal(email()('not-an-email'), 'Must be a valid email')
-      assert.equal(email()('a@b'),          'Must be a valid email')
-      assert.equal(email()('a@.com'),       'Must be a valid email')
-    })
-
-    it('accepts well-formed emails', () => {
-      assert.equal(email()('user@example.com'), null)
-    })
-  })
-
-  describe('minLength / maxLength', () => {
-    it('minLength rejects shorter strings, accepts equal/longer', () => {
-      const v = minLength(3)
-      assert.equal(v('ab'),  'Must be at least 3 characters')
-      assert.equal(v('abc'), null)
-      assert.equal(v('abcd'),null)
-    })
-
-    it('maxLength rejects longer strings', () => {
-      const v = maxLength(3)
-      assert.equal(v('abcd'), 'Must be at most 3 characters')
-      assert.equal(v('abc'),  null)
-    })
-
-    it('skips non-strings and empty values', () => {
-      assert.equal(minLength(3)(undefined), null)
-      assert.equal(minLength(3)(42),        null)
-    })
-  })
-
-  describe('min / max', () => {
-    it('min/max bound numbers', () => {
-      assert.equal(min(0)(-1),    'Must be at least 0')
-      assert.equal(min(0)(0),     null)
-      assert.equal(max(10)(11),   'Must be at most 10')
-      assert.equal(max(10)(10),   null)
-    })
-
-    it('skips non-numbers and empty', () => {
-      assert.equal(min(0)('hi'),      null)
-      assert.equal(min(0)(undefined), null)
-    })
-  })
-
-  describe('pattern', () => {
-    it('rejects non-matching strings', () => {
-      assert.equal(pattern(/^[a-z]+$/)('Abc'), 'Invalid format')
-      assert.equal(pattern(/^[a-z]+$/)('abc'), null)
-    })
-
-    it('serializes source + flags', () => {
-      const re = /^foo$/i
-      assert.deepEqual(pattern(re).serialized, {
-        rule: 'pattern', source: '^foo$', flags: 'i', message: 'Invalid format',
-      })
-    })
-  })
-
-  describe('makeValidator', () => {
-    it('produces a callable validator without serialized when none provided', () => {
-      const v = makeValidator(val => (val === 'bad' ? 'no' : null))
-      assert.equal(v('bad'), 'no')
-      assert.equal(v('ok'),  null)
-      assert.equal(v.serialized, undefined)
-    })
-  })
-})
-
-describe('Field.validate / runValidators', () => {
-  it('accumulates validators across calls', async () => {
-    const f = TextField.make('x').validate(minLength(3)).validate(maxLength(5))
-    assert.equal((await f.runValidators('a')).length,     1) // minLength
-    assert.equal((await f.runValidators('abcdef')).length, 1) // maxLength
-    assert.equal((await f.runValidators('abcd')).length,  0)
-  })
-
-  it('reports every error, not just the first', async () => {
-    const f = EmailField.make('x').validate([minLength(20), email()])
-    const errors = await f.runValidators('a@b')
-    assert.equal(errors.length, 2)
-  })
-
-  it('honors validator order', async () => {
-    const f = TextField.make('x').validate([minLength(5), maxLength(2)])
-    const errors = await f.runValidators('abc')
-    // both fail; order is [minLength, maxLength]
-    assert.match(errors[0]!, /at least 5/)
-    assert.match(errors[1]!, /at most 2/)
-  })
-
-  it('passes ctx through to validators', async () => {
-    const seenValues: unknown[] = []
-    const v = makeValidator((_value, ctx) => {
-      seenValues.push(ctx?.values)
-      return null
-    })
-    const f = TextField.make('x').validate(v)
-    await f.runValidators('a', { values: { other: 1 } })
-    assert.deepEqual(seenValues, [{ other: 1 }])
-  })
-
-  it('required() flag implicitly adds a required check', async () => {
-    const f = TextField.make('x').required()
-    assert.deepEqual(await f.runValidators(''), ['This field is required'])
-    assert.deepEqual(await f.runValidators('ok'), [])
-  })
-
-  it('does not double-fire required when both flag and validator are set', async () => {
-    const f = TextField.make('x').required().validate(required('Custom required'))
-    const errors = await f.runValidators('')
-    assert.equal(errors.length, 1)
-    assert.equal(errors[0], 'Custom required')
-  })
-
-  it('awaits async validators in declaration order', async () => {
-    const seen: string[] = []
-    const slow = makeValidator(async _v => {
-      await new Promise(r => setTimeout(r, 5))
-      seen.push('slow')
-      return 'slow-error'
-    })
-    const fast = makeValidator(_v => { seen.push('fast'); return 'fast-error' })
-    const f = TextField.make('x').validate([slow, fast])
-    const errors = await f.runValidators('hi')
-    assert.deepEqual(seen, ['slow', 'fast'])
-    assert.deepEqual(errors, ['slow-error', 'fast-error'])
-  })
-})
-
-describe('Field.toMeta serialized rules', () => {
-  it('omits rules array when no validators and not required', () => {
-    const meta = TextField.make('x').toMeta()
-    assert.equal('rules' in meta, false)
-  })
-
-  it('includes a required rule when .required() is set', () => {
-    const meta = TextField.make('x').required().toMeta()
-    assert.deepEqual(meta.rules, [{ rule: 'required', message: 'This field is required' }])
-  })
-
-  it('serializes each validator that carries a descriptor', () => {
-    const meta = EmailField.make('x').validate([email(), minLength(5)]).toMeta()
-    assert.deepEqual(meta.rules, [
-      { rule: 'email',     message: 'Must be a valid email' },
-      { rule: 'minLength', value: 5, message: 'Must be at least 5 characters' },
-    ])
-  })
-
-  it('skips validators without a serialized descriptor', () => {
-    const customOnly = makeValidator(() => null) // no serialized
-    const meta = TextField.make('x').validate(customOnly).toMeta()
-    assert.equal('rules' in meta, false)
-  })
-
-  it('does not duplicate required when both flag and validator are set', () => {
-    const meta = TextField.make('x').required().validate(required('Custom required')).toMeta()
-    assert.equal(meta.rules!.length, 1)
-    assert.equal((meta.rules![0] as { message: string }).message, 'Custom required')
-  })
-})
-
-describe('validateSchema (tree-level runner)', () => {
-  it('walks containers and gathers errors keyed by field name', async () => {
-    const schema = [
-      Section.make('Profile').schema([
-        TextField.make('name').required(),
-        EmailField.make('email').validate(email()),
-      ]),
-      Card.make().schema([
-        NumberField.make('age').validate(min(0)),
-      ]),
-    ]
-    const errors = await validateSchema(schema, { name: '', email: 'bad', age: -1 })
-    assert.deepEqual(errors['name'],  ['This field is required'])
-    assert.deepEqual(errors['email'], ['Must be a valid email'])
-    assert.deepEqual(errors['age'],   ['Must be at least 0'])
-    assert.equal(isValid(errors), false)
-  })
-
-  it('walks deeply-nested Tabs/Tab containers', async () => {
-    const schema = [
-      Tabs.make().tabs([
-        Tab.make('Settings').schema([
-          TextField.make('alias').required(),
-        ]),
-      ]),
-    ]
-    const errors = await validateSchema(schema, { alias: '' })
-    assert.deepEqual(errors['alias'], ['This field is required'])
-  })
-
-  it('returns empty map and isValid=true when everything passes', async () => {
-    const schema = [TextField.make('a').required(), TextField.make('b')]
-    const errors = await validateSchema(schema, { a: 'hello', b: undefined })
-    assert.deepEqual(errors, {})
-    assert.equal(isValid(errors), true)
-  })
-
-  it('passes record through to validator ctx', async () => {
-    let captured: unknown
-    const v = makeValidator((_value, ctx) => { captured = ctx?.record; return null })
-    const schema = [TextField.make('x').validate(v)]
-    await validateSchema(schema, { x: 'hi' }, { id: 42 })
-    assert.deepEqual(captured, { id: 42 })
-  })
-
-  it('readonly fields still validate', async () => {
-    const schema = [TextField.make('x').readonly().required()]
-    const errors = await validateSchema(schema, { x: '' })
-    assert.deepEqual(errors['x'], ['This field is required'])
-  })
-
-  it('awaits async field validators', async () => {
-    const v = makeValidator(async _v => {
-      await new Promise(r => setTimeout(r, 1))
-      return 'async-error'
-    })
-    const schema = [TextField.make('x').validate(v)]
-    const errors = await validateSchema(schema, { x: 'hi' })
-    assert.deepEqual(errors['x'], ['async-error'])
-  })
-})