@pilotiq/pilotiq 0.24.1 → 0.24.2

package/src/fields/FileUploadField.test.ts

@@ -1,143 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { FileUploadField, FileUpload } from './FileUploadField.js'
-import { coerceFormValues } from '../elements/dispatchForm.js'
-
-describe('FileUploadField', () => {
-  it('emits fieldType "fileUpload"', () => {
-    const meta = FileUploadField.make('cover').toMeta()
-    assert.equal(meta.fieldType, 'fileUpload')
-  })
-
-  it('exports an alias `FileUpload`', () => {
-    assert.equal(FileUpload, FileUploadField)
-  })
-
-  it('default flags: multiple=false, preview=true', () => {
-    const meta = FileUploadField.make('x').toMeta()
-    assert.equal(meta['multiple'], false)
-    assert.equal(meta['preview'],  true)
-  })
-
-  it('emits accept / maxSize / directory only when set', () => {
-    const a = FileUploadField.make('x').toMeta()
-    assert.equal('accept'    in a, false)
-    assert.equal('maxSize'   in a, false)
-    assert.equal('directory' in a, false)
-
-    const b = FileUploadField.make('x')
-      .accept(['image/png', 'image/jpeg'])
-      .maxSize(5_000_000)
-      .directory('articles/covers')
-      .toMeta()
-    assert.deepEqual(b['accept'], ['image/png', 'image/jpeg'])
-    assert.equal(b['maxSize'], 5_000_000)
-    assert.equal(b['directory'], 'articles/covers')
-  })
-
-  it('multiple() flips to multi-file mode', () => {
-    const meta = FileUploadField.make('x').multiple().toMeta()
-    assert.equal(meta['multiple'], true)
-  })
-
-  it('preview(false) suppresses thumbnail', () => {
-    const meta = FileUploadField.make('x').preview(false).toMeta()
-    assert.equal(meta['preview'], false)
-  })
-
-  it('emits uploadUrl from RenderContext', () => {
-    const meta = FileUploadField.make('x').toMeta({ uploadUrl: '/admin/_uploads' })
-    assert.equal(meta['uploadUrl'], '/admin/_uploads')
-  })
-
-  it('omits uploadUrl when ctx does not supply one', () => {
-    const meta = FileUploadField.make('x').toMeta()
-    assert.equal('uploadUrl' in meta, false)
-  })
-
-  describe('image editor (Phase A)', () => {
-    it('imageEditor() stamps imageEditor:true', () => {
-      const meta = FileUploadField.make('photo').imageEditor().toMeta()
-      assert.equal(meta['imageEditor'], true)
-    })
-
-    it('imageEditor() absent by default', () => {
-      const meta = FileUploadField.make('photo').toMeta()
-      assert.equal('imageEditor' in meta, false)
-    })
-
-    it('imageEditorAspectRatioOptions() stamps options array', () => {
-      const opts = [{ ratio: 16 / 9, label: 'Widescreen' }, { ratio: 1, label: 'Square' }]
-      const meta = FileUploadField.make('photo').imageEditor().imageEditorAspectRatioOptions(opts).toMeta()
-      assert.deepEqual(meta['imageEditorAspectRatioOptions'], opts)
-    })
-
-    it('circleCropper() stamps circleCropper:true', () => {
-      const meta = FileUploadField.make('photo').imageEditor().circleCropper().toMeta()
-      assert.equal(meta['circleCropper'], true)
-    })
-
-    it('automaticallyCropImagesToAspectRatio() stamps flag', () => {
-      const meta = FileUploadField.make('photo').imageEditor().automaticallyCropImagesToAspectRatio().toMeta()
-      assert.equal(meta['automaticallyCropImagesToAspectRatio'], true)
-    })
-
-    it('automaticallyResize() stamps width+height', () => {
-      const meta = FileUploadField.make('photo').automaticallyResize(800, 600).toMeta()
-      assert.deepEqual(meta['automaticallyResize'], { width: 800, height: 600 })
-    })
-
-    it('avatar() sets imageEditor + circleCropper + multiple:false', () => {
-      const meta = FileUploadField.make('avatar').avatar().toMeta()
-      assert.equal(meta['imageEditor'],    true)
-      assert.equal(meta['circleCropper'],  true)
-      assert.equal(meta['multiple'],       false)
-    })
-
-    it('avatar() does not override an explicit multiple(true)', () => {
-      // avatar() forces multiple false — explicit multiple() after avatar() wins
-      const meta = FileUploadField.make('avatar').avatar().multiple(true).toMeta()
-      assert.equal(meta['multiple'], true)
-    })
-  })
-
-  describe('coerceFormValues', () => {
-    it('passes URL string through (single mode)', () => {
-      const out = coerceFormValues(
-        [FileUploadField.make('cover')],
-        { cover: '/uploads/abc.png' },
-      )
-      assert.equal(out['cover'], '/uploads/abc.png')
-    })
-
-    it('passes string[] through (multi mode)', () => {
-      const out = coerceFormValues(
-        [FileUploadField.make('files').multiple()],
-        { files: ['/uploads/a.png', '/uploads/b.png'] },
-      )
-      assert.deepEqual(out['files'], ['/uploads/a.png', '/uploads/b.png'])
-    })
-
-    it('decodes JSON-array string into string[]', () => {
-      const out = coerceFormValues(
-        [FileUploadField.make('files').multiple()],
-        { files: '["/uploads/a.png","/uploads/b.png"]' },
-      )
-      assert.deepEqual(out['files'], ['/uploads/a.png', '/uploads/b.png'])
-    })
-
-    it('empty string → null', () => {
-      const out = coerceFormValues(
-        [FileUploadField.make('cover')],
-        { cover: '' },
-      )
-      assert.equal(out['cover'], null)
-    })
-
-    it('missing key → null', () => {
-      const out = coerceFormValues([FileUploadField.make('cover')], {})
-      assert.equal(out['cover'], null)
-    })
-  })
-})

package/src/fields/FileUploadField.ts

@@ -1,159 +0,0 @@
-import { Field, type FieldMeta } from './Field.js'
-import type { RenderContext } from '../schema/resolveSchema.js'
-
-export type PanelLayout = 'list' | 'grid' | 'integrated'
-
-export interface AspectRatioOption {
-  /** Numeric ratio, e.g. `16/9`, `4/3`, `1` for square. */
-  ratio: number
-  /** Human-readable label shown in the editor picker, e.g. `'Widescreen'`. */
-  label: string
-}
-
-/**
- * File upload. The field stores the resolved upload's URL string —
- * `string` for single-file mode, `string[]` for multi.
- *
- * The actual upload mechanism is a separate POST endpoint. The renderer
- * picks a file → POSTs multipart to the panel's `_uploads` route → the
- * adapter (`localUpload` / S3 / etc.) writes the file → the route
- * returns `{ ok, url }` → the renderer stashes that URL in the form
- * state. On submit, the field value is just that URL.
- */
-export class FileUploadField extends Field {
-  private _accept?: string[]
-  private _maxSize?: number
-  private _multiple = false
-  private _preview = true
-  private _directory?: string
-  private _downloadable = false
-  private _openable = false
-  private _reorderable = false
-  private _appendFiles = false
-  private _panelLayout: PanelLayout = 'list'
-  private _imageEditor = false
-  private _imageEditorAspectRatioOptions?: AspectRatioOption[]
-  private _circleCropper = false
-  private _automaticallyCropImagesToAspectRatio = false
-  private _automaticallyResize?: { width: number; height: number }
-
-  private constructor(name: string) {
-    super(name, 'fileUpload')
-  }
-
-  static make(name: string): FileUploadField {
-    return new FileUploadField(name)
-  }
-
-  /** Restrict accepted MIME types — passed verbatim to the file input + validated server-side. */
-  accept(mimes: string[]): this { this._accept = mimes; return this }
-
-  /** Max upload size in bytes. Server-side enforced; client-side surfaces the limit too. */
-  maxSize(bytes: number): this { this._maxSize = bytes; return this }
-
-  /** Switch to multi-file mode. Value becomes `string[]` instead of `string`. */
-  multiple(value: boolean = true): this { this._multiple = value; return this }
-
-  /** Show a thumbnail / file-name preview when the value is set. Default true. */
-  preview(value: boolean = true): this { this._preview = value; return this }
-
-  /**
-   * Sub-directory hint passed to the adapter. Adapters honor this
-   * differently (`localUpload` writes to `<root>/<directory>/...`,
-   * S3 prepends to the key, etc.).
-   */
-  directory(d: string): this { this._directory = d; return this }
-
-  /** Add a download button to each uploaded file item. */
-  downloadable(value: boolean = true): this { this._downloadable = value; return this }
-
-  /** Make the file thumbnail/icon link to the file (open in new tab). */
-  openable(value: boolean = true): this { this._openable = value; return this }
-
-  /** Allow files to be reordered via drag-and-drop. Only useful with `multiple()`. */
-  reorderable(value: boolean = true): this { this._reorderable = value; return this }
-
-  /**
-   * Append new uploads to the existing file list instead of replacing it.
-   * By default new picks replace the current value. Combine with `multiple()`.
-   */
-  appendFiles(value: boolean = true): this { this._appendFiles = value; return this }
-
-  /** Display layout for the uploaded file list. `'grid'` shows square tiles; `'integrated'` embeds the upload button as a tile. */
-  panelLayout(layout: PanelLayout): this { this._panelLayout = layout; return this }
-
-  /** Open a crop/resize modal after the user selects an image, before it is uploaded. */
-  imageEditor(value: boolean = true): this { this._imageEditor = value; return this }
-
-  /** Aspect ratio presets shown in the image editor picker. */
-  imageEditorAspectRatioOptions(options: AspectRatioOption[]): this { this._imageEditorAspectRatioOptions = options; return this }
-
-  /** Render a circular crop overlay in the image editor. */
-  circleCropper(value: boolean = true): this { this._circleCropper = value; return this }
-
-  /**
-   * When aspect ratio options are configured, automatically apply the first
-   * ratio and skip showing the editor UI unless the user explicitly opens it.
-   */
-  automaticallyCropImagesToAspectRatio(value: boolean = true): this { this._automaticallyCropImagesToAspectRatio = value; return this }
-
-  /**
-   * Resize the image to the given dimensions on the server after upload.
-   * Requires `@rudderjs/image` to be installed and the upload adapter to
-   * forward the `resize_width` / `resize_height` FormData fields.
-   */
-  automaticallyResize(width: number, height: number): this { this._automaticallyResize = { width, height }; return this }
-
-  /**
-   * Shorthand for `.imageEditor().circleCropper().multiple(false)`.
-   * Ideal for single avatar / profile-picture fields.
-   */
-  avatar(value: boolean = true): this {
-    if (value) { this._imageEditor = true; this._circleCropper = true; this._multiple = false }
-    return this
-  }
-
-  getAccept(): string[] | undefined { return this._accept }
-  getMaxSize(): number | undefined { return this._maxSize }
-  isMultiple(): boolean { return this._multiple }
-  hasPreview(): boolean { return this._preview }
-  getDirectory(): string | undefined { return this._directory }
-  isDownloadable(): boolean { return this._downloadable }
-  isOpenable(): boolean { return this._openable }
-  isReorderable(): boolean { return this._reorderable }
-  doesAppendFiles(): boolean { return this._appendFiles }
-  getPanelLayout(): PanelLayout { return this._panelLayout }
-  hasImageEditor(): boolean { return this._imageEditor }
-  getImageEditorAspectRatioOptions(): AspectRatioOption[] | undefined { return this._imageEditorAspectRatioOptions }
-  hasCircleCropper(): boolean { return this._circleCropper }
-  doesAutomaticallyCrop(): boolean { return this._automaticallyCropImagesToAspectRatio }
-  getAutomaticallyResize(): { width: number; height: number } | undefined { return this._automaticallyResize }
-
-  override toMeta(ctx?: RenderContext): FieldMeta {
-    return {
-      ...this.buildMeta(ctx),
-      multiple: this._multiple,
-      preview:  this._preview,
-      ...(this._accept     ? { accept: this._accept }     : {}),
-      ...(this._maxSize !== undefined ? { maxSize: this._maxSize } : {}),
-      ...(this._directory  ? { directory: this._directory }  : {}),
-      ...(this._downloadable           ? { downloadable: true }             : {}),
-      ...(this._openable               ? { openable: true }                 : {}),
-      ...(this._reorderable            ? { reorderable: true }              : {}),
-      ...(this._appendFiles            ? { appendFiles: true }              : {}),
-      ...(this._panelLayout !== 'list' ? { panelLayout: this._panelLayout } : {}),
-      ...(this._imageEditor ? { imageEditor: true } : {}),
-      ...(this._imageEditorAspectRatioOptions?.length ? { imageEditorAspectRatioOptions: this._imageEditorAspectRatioOptions } : {}),
-      ...(this._circleCropper ? { circleCropper: true } : {}),
-      ...(this._automaticallyCropImagesToAspectRatio ? { automaticallyCropImagesToAspectRatio: true } : {}),
-      ...(this._automaticallyResize ? { automaticallyResize: this._automaticallyResize } : {}),
-      // `uploadUrl` is stamped via RenderContext by the page-data
-      // builders. Without it the renderer falls back to a clear error
-      // ("no upload URL configured"); the route handler (and therefore
-      // the URL) is registered alongside the panel.
-      ...(ctx?.uploadUrl ? { uploadUrl: ctx.uploadUrl } : {}),
-    }
-  }
-}
-
-export const FileUpload = FileUploadField

package/src/fields/HiddenField.test.ts

@@ -1,27 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { HiddenField, Hidden } from './HiddenField.js'
-
-describe('HiddenField', () => {
-  it('emits fieldType "hidden"', () => {
-    const meta = HiddenField.make('source').toMeta()
-    assert.equal(meta.fieldType, 'hidden')
-    assert.equal(meta.name,      'source')
-  })
-
-  it('exports an alias `Hidden`', () => {
-    assert.equal(Hidden, HiddenField)
-  })
-
-  it('supports default value', () => {
-    const meta = HiddenField.make('csrf').default('xyz').toMeta()
-    assert.equal(meta.defaultValue, 'xyz')
-  })
-
-  it('inherits the cross-field plumbing (label, etc.)', () => {
-    const meta = HiddenField.make('x').label('Internal').toMeta()
-    // label always emits, even though renderer ignores it for hidden type
-    assert.equal(meta.label, 'Internal')
-  })
-})

package/src/fields/HiddenField.ts

@@ -1,28 +0,0 @@
-import { Field, type FieldMeta } from './Field.js'
-import type { RenderContext } from '../schema/resolveSchema.js'
-
-/**
- * A non-rendered field that round-trips a value through the form
- * without exposing it to the user. Useful for source-attribution
- * stamps, CSRF round-trips, computed values that the server needs to
- * see, etc.
- *
- * Distinct from `Form`'s built-in `_formId` discriminator — that's
- * framework chrome. `Hidden` is for app-level state.
- */
-export class HiddenField extends Field {
-  private constructor(name: string) {
-    super(name, 'hidden')
-  }
-
-  static make(name: string): HiddenField {
-    return new HiddenField(name)
-  }
-
-  override toMeta(ctx?: RenderContext): FieldMeta {
-    return this.buildMeta(ctx)
-  }
-}
-
-/** Public alias so callers can write `Hidden.make()`. */
-export const Hidden = HiddenField

package/src/fields/KeyValueField.test.ts

@@ -1,105 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import { KeyValueField, KeyValue } from './KeyValueField.js'
-import { coerceFormValues } from '../elements/dispatchForm.js'
-
-describe('KeyValueField', () => {
-  it('emits fieldType "keyValue"', () => {
-    const meta = KeyValueField.make('headers').toMeta()
-    assert.equal(meta.fieldType, 'keyValue')
-  })
-
-  it('exports an alias `KeyValue`', () => {
-    assert.equal(KeyValue, KeyValueField)
-  })
-
-  it('emits keyLabel/valueLabel/addLabel defaults', () => {
-    const meta = KeyValueField.make('x').toMeta()
-    assert.equal(meta['keyLabel'],   'Key')
-    assert.equal(meta['valueLabel'], 'Value')
-    assert.equal(meta['addLabel'],   'Add row')
-  })
-
-  it('emits custom labels when set', () => {
-    const meta = KeyValueField.make('x')
-      .keyLabel('Header')
-      .valueLabel('Setting')
-      .addLabel('Add header')
-      .toMeta()
-    assert.equal(meta['keyLabel'],   'Header')
-    assert.equal(meta['valueLabel'], 'Setting')
-    assert.equal(meta['addLabel'],   'Add header')
-  })
-
-  it('emits reorderable only when set', () => {
-    assert.equal('reorderable' in KeyValueField.make('x').toMeta(),                      false)
-    assert.equal(KeyValueField.make('x').reorderable().toMeta()['reorderable'],          true)
-  })
-
-  describe('coerceFormValues', () => {
-    it('parses JSON string body to object', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('headers')],
-        { headers: '{"X-Source":"admin","X-Trace":"abc"}' },
-      )
-      assert.deepEqual(out['headers'], { 'X-Source': 'admin', 'X-Trace': 'abc' })
-    })
-
-    it('passes already-object values through', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('headers')],
-        { headers: { foo: 'bar' } },
-      )
-      assert.deepEqual(out['headers'], { foo: 'bar' })
-    })
-
-    it('filters out the empty placeholder row { "": "" }', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('headers')],
-        { headers: '{"":"","real":"value"}' },
-      )
-      assert.deepEqual(out['headers'], { real: 'value' })
-    })
-
-    it('preserves rows with empty value but non-empty key', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('h')],
-        { h: '{"key":""}' },
-      )
-      assert.deepEqual(out['h'], { key: '' })
-    })
-
-    it('empty string body → {}', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('h')],
-        { h: '' },
-      )
-      assert.deepEqual(out['h'], {})
-    })
-
-    it('null body → {}', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('h')],
-        { h: null },
-      )
-      assert.deepEqual(out['h'], {})
-    })
-
-    it('malformed JSON → {}', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('h')],
-        { h: '{not-json' },
-      )
-      assert.deepEqual(out['h'], {})
-    })
-
-    it('stringifies non-string values', () => {
-      const out = coerceFormValues(
-        [KeyValueField.make('h')],
-        { h: { count: 5 } },
-      )
-      assert.deepEqual(out['h'], { count: '5' })
-    })
-  })
-})

package/src/fields/KeyValueField.ts

@@ -1,55 +0,0 @@
-import { Field, type FieldMeta } from './Field.js'
-import type { RenderContext } from '../schema/resolveSchema.js'
-
-/**
- * Edits a flat `Record<string, string>`. Server-canonical shape:
- *
- *   { "X-Source": "admin", "X-Trace": "abc123" }
- *
- * The client serializes the map as a JSON string in a hidden input on
- * submit; `coerceFormValues` parses it back into an object. Keeping
- * the wire-format JSON dodges the bracket-notation parser footguns
- * across `application/x-www-form-urlencoded` and `multipart/form-data`.
- */
-export class KeyValueField extends Field {
-  private _keyLabel = 'Key'
-  private _valueLabel = 'Value'
-  private _addLabel = 'Add row'
-  private _reorderable = false
-
-  private constructor(name: string) {
-    super(name, 'keyValue')
-  }
-
-  static make(name: string): KeyValueField {
-    return new KeyValueField(name)
-  }
-
-  keyLabel(label: string): this   { this._keyLabel = label; return this }
-  valueLabel(label: string): this { this._valueLabel = label; return this }
-  addLabel(label: string): this   { this._addLabel = label; return this }
-
-  /**
-   * Show up/down arrow controls per row. Drag-and-drop ordering not
-   * shipped in v1 — call back to up/down only when the persisted
-   * order matters.
-   */
-  reorderable(value: boolean = true): this { this._reorderable = value; return this }
-
-  getKeyLabel(): string { return this._keyLabel }
-  getValueLabel(): string { return this._valueLabel }
-  getAddLabel(): string { return this._addLabel }
-  isReorderable(): boolean { return this._reorderable }
-
-  override toMeta(ctx?: RenderContext): FieldMeta {
-    return {
-      ...this.buildMeta(ctx),
-      keyLabel:    this._keyLabel,
-      valueLabel:  this._valueLabel,
-      addLabel:    this._addLabel,
-      ...(this._reorderable ? { reorderable: true } : {}),
-    }
-  }
-}
-
-export const KeyValue = KeyValueField