@pilotiq/pilotiq 0.23.1 → 0.24.2

package/src/PilotiqRegistry.ts

@@ -1,36 +0,0 @@
-import type { Pilotiq } from './Pilotiq.js'
-
-const g = globalThis as Record<string, unknown>
-const STORE_KEY = '__pilotiq_registry'
-if (!g[STORE_KEY]) g[STORE_KEY] = new Map<string, Pilotiq>()
-const map = g[STORE_KEY] as Map<string, Pilotiq>
-
-export const PilotiqRegistry = {
-  register(panel: Pilotiq): void {
-    const name = panel.getConfig().name
-    if (map.has(name)) {
-      throw new Error(`[Pilotiq] A panel named "${name}" is already registered.`)
-    }
-    map.set(name, panel)
-  },
-
-  all(): Pilotiq[] {
-    return [...map.values()]
-  },
-
-  get(name: string): Pilotiq | undefined {
-    return map.get(name)
-  },
-
-  findByPath(path: string): Pilotiq | undefined {
-    for (const panel of map.values()) {
-      if (panel.getConfig().path === path) return panel
-    }
-    return undefined
-  },
-
-  /** @internal — for testing and dev hot-reload */
-  reset(): void {
-    map.clear()
-  },
-}

package/src/PilotiqServiceProvider.ts

@@ -1,121 +0,0 @@
-import { ServiceProvider } from '@rudderjs/core'
-import type { Application } from '@rudderjs/core'
-import type { Pilotiq } from './Pilotiq.js'
-import { PilotiqRegistry } from './PilotiqRegistry.js'
-import { registerPilotiqRoutes } from './routes.js'
-import { migrateThemeOverrides } from './theme/migrate.js'
-import { prismaThemeStorage } from './theme/storage.js'
-import type { PanelGlobalDelegate, ThemeStorageAdapter } from './theme/storage.js'
-
-// ─── Service Provider ─────────────────────────────────────
-
-const autoFallbackWarned = new Set<string>()
-
-class PilotiqServiceProvider extends ServiceProvider {
-  private panels: Pilotiq[]
-
-  constructor(app: Application, panels: Pilotiq[]) {
-    super(app)
-    this.panels = panels
-  }
-
-  register(): void {
-    PilotiqRegistry.reset()
-    for (const panel of this.panels) {
-      PilotiqRegistry.register(panel)
-    }
-  }
-
-  async boot(): Promise<void> {
-    const { router } = await import('@rudderjs/router') as {
-      router: Parameters<typeof registerPilotiqRoutes>[0]
-    }
-
-    for (const panel of PilotiqRegistry.all()) {
-      if (panel.getConfig().themeEditor) {
-        await loadThemeOverrides(this.app, panel)
-      }
-      registerPilotiqRoutes(router, panel)
-    }
-  }
-}
-
-/**
- * Resolve the panel's theme storage adapter and hydrate any persisted
- * overrides onto the panel.
- *
- * - Explicit `themeEditor({ storage })`: errors bubble (the user opted
- *   in, misconfiguration should surface loudly).
- * - Implicit Prisma fallback: errors swallowed for back-compat with a
- *   one-time deprecation warning. Removing this branch is the breaking
- *   change scheduled for the next minor.
- */
-async function loadThemeOverrides(app: Application, panel: Pilotiq): Promise<void> {
-  const adapter = resolveThemeStorage(app, panel)
-  if (!adapter) return
-
-  const isExplicit = panel.getConfig().themeStorage === adapter
-  if (!isExplicit) panel._setThemeStorage(adapter)
-
-  try {
-    const overrides = await adapter.load()
-    if (overrides) panel.setThemeOverrides(migrateThemeOverrides(overrides))
-  } catch (e) {
-    if (isExplicit) throw e
-    // Implicit fallback: swallow connection / schema errors. Removed
-    // alongside the auto-fallback branch in a future minor.
-  }
-}
-
-function resolveThemeStorage(app: Application, panel: Pilotiq): ThemeStorageAdapter | null {
-  const explicit = panel.getConfig().themeStorage
-  if (explicit) return explicit
-
-  let prisma: PanelGlobalDelegate | null
-  try {
-    prisma = app.make('prisma') as PanelGlobalDelegate
-  } catch {
-    return null
-  }
-  if (!prisma || typeof prisma.panelGlobal?.findUnique !== 'function') return null
-
-  const panelName = panel.getConfig().name
-  if (!autoFallbackWarned.has(panelName)) {
-    autoFallbackWarned.add(panelName)
-    console.warn(
-      `[pilotiq] themeEditor() on panel "${panelName}" is using the implicit ` +
-      `Prisma fallback for theme persistence. Pass storage explicitly — ` +
-      `themeEditor({ storage: prismaThemeStorage(prisma, { slug: '${panelName}__theme' }) }) — ` +
-      `the implicit fallback is deprecated and will be removed in a future minor.`,
-    )
-  }
-  return prismaThemeStorage(prisma, { slug: `${panelName}__theme` })
-}
-
-/** @internal — test seam; resets the "deprecation already warned" memo. */
-export function _resetThemeFallbackWarned(): void {
-  autoFallbackWarned.clear()
-}
-
-// ─── Factory ──────────────────────────────────────────────
-
-/**
- * Register one or more Pilotiq panels and mount their view routes.
- *
- * @example
- * import { pilotiq } from '@pilotiq/pilotiq'
- * import { adminPanel } from './app/Pilotiq/AdminPanel.js'
- *
- * export default [
- *   pilotiq([adminPanel]),
- * ]
- */
-export function pilotiq(
-  panelList: Pilotiq[],
-): new (app: Application) => ServiceProvider {
-  return class PilotiqProvider extends PilotiqServiceProvider {
-    constructor(app: Application) {
-      super(app, panelList)
-    }
-  }
-}

package/src/RelationManager.test.ts

@@ -1,400 +0,0 @@
-import { describe, it } from 'node:test'
-import assert from 'node:assert/strict'
-
-import {
-  RelationManager,
-  RESERVED_RELATIONSHIP_TOKENS,
-  safeManagerPolicy,
-  normalizeRelationMode,
-  type RelationManagerContext,
-} from './RelationManager.js'
-import {
-  getMorphRelationDescriptor,
-  computeMorphPayload,
-  type ModelLike,
-} from './orm/modelDefaults.js'
-import { Form } from './elements/Form.js'
-import { Table } from './elements/Table.js'
-import { Column } from './Column.js'
-import { TextField } from './fields/TextField.js'
-
-/** Stub manager-context for tests that don't care about URL templating. */
-const stubCtx: RelationManagerContext = {
-  basePath:     '/admin',
-  parentSlug:   'users',
-  parentId:     '1',
-  relationship: 'posts',
-  parentRecord: { id: '1' },
-  mode:         'hasMany',
-}
-
-describe('RelationManager (static API)', () => {
-  it('default form/table/detail are no-ops', () => {
-    class M extends RelationManager {
-      static override relationship = 'posts'
-    }
-    const f = M.form(Form.make(), stubCtx)
-    const t = M.table(Table.make(), stubCtx)
-    assert.equal(f.getChildren(), undefined)
-    assert.equal(t.getChildren(), undefined)
-    assert.deepEqual(M.detail({}, {}), [])
-  })
-
-  it('subclass overrides receive the builder and configure it', () => {
-    class PostsManager extends RelationManager {
-      static override relationship = 'posts'
-      static override label        = 'Posts'
-
-      static override form(form: Form): Form {
-        return form.schema([TextField.make('title').required()])
-      }
-      static override table(table: Table): Table {
-        return table.columns([Column.make('title').sortable()])
-      }
-    }
-
-    // Subclass overrides may drop trailing parameters they don't need —
-    // TypeScript narrows the call signature to the override's, so callers
-    // through the subclass type pass only `(form)` / `(table)`. The
-    // framework calls via `typeof RelationManager`, which sees the base
-    // signature including `ctx`.
-    const f = PostsManager.form(Form.make())
-    const t = PostsManager.table(Table.make())
-    assert.equal(f.getChildren()?.length, 1)
-    assert.equal(t.getChildren()?.length, 1)
-  })
-
-  it('subclass overrides may consume the context to configure the builder', () => {
-    let capturedCtx: RelationManagerContext | undefined
-
-    class PostsManager extends RelationManager {
-      static override relationship = 'posts'
-
-      static override table(table: Table, ctx: RelationManagerContext): Table {
-        capturedCtx = ctx
-        return table.columns([Column.make('title').sortable()])
-      }
-    }
-
-    PostsManager.table(Table.make(), stubCtx)
-    assert.equal(capturedCtx?.basePath,     '/admin')
-    assert.equal(capturedCtx?.parentSlug,   'users')
-    assert.equal(capturedCtx?.parentId,     '1')
-    assert.equal(capturedCtx?.relationship, 'posts')
-  })
-
-  it('getRelationship throws when the subclass forgot to set it', () => {
-    class Forgot extends RelationManager {}
-    assert.throws(
-      () => Forgot.getRelationship(),
-      /static relationship must be set/,
-    )
-  })
-
-  it('getRelationship returns the configured key', () => {
-    class M extends RelationManager {
-      static override relationship = 'comments'
-    }
-    assert.equal(M.getRelationship(), 'comments')
-  })
-
-  it('getLabel falls back to a sentence-cased relationship name', () => {
-    class M extends RelationManager {
-      static override relationship = 'posts'
-    }
-    assert.equal(M.getLabel(), 'Posts')
-  })
-
-  it('getLabel uses the explicit override when set', () => {
-    class M extends RelationManager {
-      static override relationship = 'lineItems'
-      static override label        = 'Line items'
-    }
-    assert.equal(M.getLabel(), 'Line items')
-  })
-
-  it('getLabelSingular naively strips a trailing s when label not set', () => {
-    class Posts extends RelationManager { static override relationship = 'posts' }
-    class Categories extends RelationManager { static override relationship = 'categories' }
-
-    assert.equal(Posts.getLabelSingular(), 'Post')
-    // Naive — irregular plurals get the wrong answer; users override.
-    assert.equal(Categories.getLabelSingular(), 'Categorie')
-  })
-
-  it('getLabelSingular uses the explicit override when set', () => {
-    class M extends RelationManager {
-      static override relationship   = 'children'
-      static override labelSingular  = 'Child'
-    }
-    assert.equal(M.getLabelSingular(), 'Child')
-  })
-
-  it('getIcon and getRecordTitleAttribute return undefined by default', () => {
-    class M extends RelationManager { static override relationship = 'posts' }
-    assert.equal(M.getIcon(), undefined)
-    assert.equal(M.getRecordTitleAttribute(), undefined)
-  })
-
-  it('getIcon and getRecordTitleAttribute pass through configured values', () => {
-    class M extends RelationManager {
-      static override relationship          = 'posts'
-      static override icon                  = 'newspaper'
-      static override recordTitleAttribute  = 'title'
-    }
-    assert.equal(M.getIcon(), 'newspaper')
-    assert.equal(M.getRecordTitleAttribute(), 'title')
-  })
-
-  describe('authorization predicates', () => {
-    it('every can* defaults to true', async () => {
-      class M extends RelationManager { static override relationship = 'posts' }
-      const parent = { id: 1 }
-      const child  = { id: 9 }
-
-      assert.equal(await M.canViewAny(null, parent), true)
-      assert.equal(await M.canView(null, child, parent),    true)
-      assert.equal(await M.canCreate(null, parent),         true)
-      assert.equal(await M.canEdit(null, child, parent),    true)
-      assert.equal(await M.canDelete(null, child, parent),  true)
-    })
-
-    it('subclass overrides flow through', async () => {
-      class M extends RelationManager {
-        static override relationship = 'posts'
-        static override async canCreate(_user: unknown, parent: unknown): Promise<boolean> {
-          return (parent as { canPost?: boolean }).canPost === true
-        }
-      }
-      assert.equal(await M.canCreate(null, { canPost: true }),  true)
-      assert.equal(await M.canCreate(null, { canPost: false }), false)
-      assert.equal(await M.canCreate(null, {}),                 false)
-    })
-  })
-
-  describe('reserved-token set', () => {
-    it('blocks the URL tokens that collide with action / form routes', () => {
-      // Sanity: the route table reserves these — managers can't claim them.
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('edit'),     true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('delete'),   true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_form'),    true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_action'),  true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_search'),  true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_uploads'), true)
-    })
-
-    it('allows ordinary relationship names', () => {
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('posts'),    false)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('comments'), false)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('tags'),     false)
-    })
-
-    it('reserves the M2M tokens', () => {
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_attach'),      true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_detach'),      true)
-      assert.equal(RESERVED_RELATIONSHIP_TOKENS.has('_bulk-detach'), true)
-    })
-  })
-
-  describe('M2M predicates', () => {
-    it('canAttach + canDetach default to true', async () => {
-      class M extends RelationManager { static override relationship = 'tags' }
-      const parent = { id: 1 }
-      const child  = { id: 9 }
-      assert.equal(await M.canAttach(null, parent),         true)
-      assert.equal(await M.canDetach(null, child, parent),  true)
-    })
-
-    it('canAttach override flows through', async () => {
-      class M extends RelationManager {
-        static override relationship = 'tags'
-        static override async canAttach(_user: unknown, parent: unknown): Promise<boolean> {
-          return (parent as { canManageTags?: boolean }).canManageTags === true
-        }
-      }
-      assert.equal(await M.canAttach(null, { canManageTags: true }),  true)
-      assert.equal(await M.canAttach(null, { canManageTags: false }), false)
-    })
-  })
-
-  describe('safeManagerPolicy — M2M short-circuit', () => {
-    it('canAttach does NOT fall through to the related Resource', async () => {
-      class M extends RelationManager { static override relationship = 'tags' }
-      const Related = {
-        // If fall-through happened, this would be consulted; we want it ignored.
-        canCreate: async () => false,
-      }
-      // Manager hasn't overridden canAttach (default true). With the
-      // managerOnly short-circuit, we should see `true` even though
-      // Related.canCreate returns false.
-      assert.equal(
-        await safeManagerPolicy(M, 'canAttach', Related as never, null, { id: 1 }),
-        true,
-      )
-    })
-
-    it('canDetach does NOT fall through to the related Resource', async () => {
-      class M extends RelationManager { static override relationship = 'tags' }
-      const Related = { canDelete: async () => false }
-      assert.equal(
-        await safeManagerPolicy(M, 'canDetach', Related as never, null, { id: 1 }, { id: 9 }),
-        true,
-      )
-    })
-
-    it('canAttach manager override is honored over the default-true', async () => {
-      class M extends RelationManager {
-        static override relationship = 'tags'
-        static override async canAttach(): Promise<boolean> { return false }
-      }
-      assert.equal(
-        await safeManagerPolicy(M, 'canAttach', undefined, null, { id: 1 }),
-        false,
-      )
-    })
-
-    it('throwing canDetach predicate fails closed', async () => {
-      class M extends RelationManager {
-        static override relationship = 'tags'
-        static override async canDetach(): Promise<boolean> { throw new Error('boom') }
-      }
-      assert.equal(
-        await safeManagerPolicy(M, 'canDetach', undefined, null, { id: 1 }, { id: 9 }),
-        false,
-      )
-    })
-  })
-})
-
-describe('normalizeRelationMode (polymorphic follow-up)', () => {
-  it('maps belongsToMany to its own mode', () => {
-    assert.equal(normalizeRelationMode('belongsToMany'), 'belongsToMany')
-  })
-
-  it('collapses morphMany and morphOne into morphMany', () => {
-    assert.equal(normalizeRelationMode('morphMany'), 'morphMany')
-    assert.equal(normalizeRelationMode('morphOne'),  'morphMany')
-  })
-
-  it('maps morphTo to its own mode', () => {
-    assert.equal(normalizeRelationMode('morphTo'), 'morphTo')
-  })
-
-  it('maps morphToMany to its own mode (polymorphic M2M owning side)', () => {
-    assert.equal(normalizeRelationMode('morphToMany'), 'morphToMany')
-  })
-
-  it('maps morphedByMany to its own mode (polymorphic M2M inverse side)', () => {
-    assert.equal(normalizeRelationMode('morphedByMany'), 'morphedByMany')
-  })
-
-  it('falls back to hasMany for hasMany / hasOne / belongsTo / unknown / empty', () => {
-    assert.equal(normalizeRelationMode('hasMany'),      'hasMany')
-    assert.equal(normalizeRelationMode('hasOne'),       'hasMany')
-    assert.equal(normalizeRelationMode('belongsTo'),    'hasMany')
-    assert.equal(normalizeRelationMode('unknownType'),  'hasMany')
-    assert.equal(normalizeRelationMode(''),             'hasMany')
-  })
-})
-
-describe('getMorphRelationDescriptor', () => {
-  function modelWithRelations(relations: Record<string, unknown>): ModelLike {
-    const M: ModelLike = {
-      async find()   { return null },
-      async create() { throw new Error('not used') },
-      async update() { throw new Error('not used') },
-      async delete() { /* no-op */ },
-      query()        { throw new Error('not used') },
-    }
-    Object.assign(M as object, { relations })
-    return M
-  }
-
-  it('returns descriptor for morphMany', () => {
-    const M = modelWithRelations({
-      comments: { type: 'morphMany', model: () => ({} as ModelLike), morphName: 'commentable' },
-    })
-    const desc = getMorphRelationDescriptor(M, 'comments')
-    assert.ok(desc)
-    assert.equal(desc.morphName, 'commentable')
-    assert.equal(typeof desc.model, 'function')
-  })
-
-  it('returns descriptor for morphOne', () => {
-    const M = modelWithRelations({
-      avatar: { type: 'morphOne', model: () => ({} as ModelLike), morphName: 'imageable' },
-    })
-    const desc = getMorphRelationDescriptor(M, 'avatar')
-    assert.ok(desc)
-    assert.equal(desc.morphName, 'imageable')
-  })
-
-  it('returns undefined for morphTo (no model thunk on the child side)', () => {
-    const M = modelWithRelations({
-      commentable: { type: 'morphTo', morphName: 'commentable', types: () => [] },
-    })
-    assert.equal(getMorphRelationDescriptor(M, 'commentable'), undefined)
-  })
-
-  it('returns undefined for non-polymorphic relation types', () => {
-    const M = modelWithRelations({
-      posts: { type: 'hasMany', model: () => ({} as ModelLike), foreignKey: 'userId' },
-    })
-    assert.equal(getMorphRelationDescriptor(M, 'posts'), undefined)
-  })
-
-  it('returns undefined when morphName is missing or non-string', () => {
-    const M = modelWithRelations({
-      bad: { type: 'morphMany', model: () => ({} as ModelLike) },
-    })
-    assert.equal(getMorphRelationDescriptor(M, 'bad'), undefined)
-  })
-
-  it('honors morphType override in the relation entry', () => {
-    const M = modelWithRelations({
-      comments: { type: 'morphMany', model: () => ({} as ModelLike), morphName: 'commentable', morphType: 'aliased' },
-    })
-    const desc = getMorphRelationDescriptor(M, 'comments')!
-    assert.equal(desc.morphType, 'aliased')
-  })
-})
-
-describe('computeMorphPayload', () => {
-  function makeRecord(klass: { name?: string; morphAlias?: string; primaryKey?: string }, props: Record<string, unknown>) {
-    const rec = { ...props }
-    Object.setPrototypeOf(rec, { constructor: klass })
-    return rec
-  }
-
-  it('builds {nameId, nameType} from parent.constructor.name and primaryKey', () => {
-    const parent = makeRecord({ name: 'Post', primaryKey: 'id' }, { id: 42 })
-    const payload = computeMorphPayload(parent, { morphName: 'commentable' })
-    assert.deepEqual(payload, { commentableId: 42, commentableType: 'Post' })
-  })
-
-  it('honors parent.constructor.morphAlias over class name', () => {
-    const parent = makeRecord({ name: 'BlogPost', morphAlias: 'post', primaryKey: 'id' }, { id: 7 })
-    const payload = computeMorphPayload(parent, { morphName: 'commentable' })
-    assert.equal(payload['commentableType'], 'post')
-  })
-
-  it('honors descriptor.morphType over the class-level alias', () => {
-    const parent = makeRecord({ name: 'Post', morphAlias: 'post', primaryKey: 'id' }, { id: 7 })
-    const payload = computeMorphPayload(parent, { morphName: 'commentable', morphType: 'override' })
-    assert.equal(payload['commentableType'], 'override')
-  })
-
-  it('uses constructor.primaryKey when set, falls back to id', () => {
-    const parent = makeRecord({ name: 'Tag', primaryKey: 'uuid' }, { uuid: 'abc-123' })
-    const payload = computeMorphPayload(parent, { morphName: 'taggable' })
-    assert.equal(payload['taggableId'], 'abc-123')
-  })
-
-  it('throws when parent primary key is unset', () => {
-    const parent = makeRecord({ name: 'Post', primaryKey: 'id' }, {})
-    assert.throws(
-      () => computeMorphPayload(parent, { morphName: 'commentable' }),
-      /parent\.id is unset/,
-    )
-  })
-})