admindb 1.2.1 → 2.1.0

package/dist/data/generator.d.ts

@@ -1,86 +0,0 @@
-/**
- * Data generator / seeder engine.
- *
- * Given a table's schema, every column can be filled with realistic fake data
- * from a chosen "strategy" — first name, email, UUID, a random integer, a value
- * sampled from a referenced table's foreign key, a fixed value, and so on.
- *
- * Responsibilities:
- *  - auto-detect a sensible default strategy per column (column name + type +
- *    foreign key), so the "Seed data" page works with zero configuration;
- *  - generate N rows of concrete, type-coerced values (ready for SQLite
- *    binding via `db.insertRows`);
- *  - render the generated rows as a multi-row INSERT for the "preview SQL"
- *    mode that never executes.
- */
-import type { SqliteDatabase, TableInfoData, ForeignKeyInfo, WhereClause } from '../db/database';
-/** Hard cap on how many rows a single seed run may generate. */
-export declare const MAX_SEED_ROWS = 5000;
-export type GeneratorStrategyId = 'skip' | 'null' | 'fixed' | 'list' | 'first' | 'last' | 'fullname' | 'email' | 'username' | 'phone' | 'city' | 'country' | 'postal' | 'address' | 'url' | 'domain' | 'ip' | 'uuid' | 'words' | 'sentence' | 'int' | 'decimal' | 'date' | 'datetime' | 'time' | 'bool' | 'bytes' | 'json' | 'hash' | 'token' | 'fk';
-/** Per-column generator settings. Which options are meaningful depends on `strategy`. */
-export interface ColumnPlan {
-    strategy: GeneratorStrategyId;
-    /** `fixed` / `list` and the string-ish options. */
-    value?: string;
-    /** `list` — random value picked from this set. */
-    values?: string[];
-    /** `int` / `decimal` range. */
-    min?: number;
-    max?: number;
-    /** `decimal` — digits after the decimal point. */
-    precision?: number;
-    /** `date` / `datetime` bounds (ISO strings). */
-    from?: string;
-    to?: string;
-    /** `words` / `bytes` / `hash` / `token` — length bounds. */
-    minLen?: number;
-    maxLen?: number;
-    /** `json` — object keys to include (comma-separated in the UI). */
-    jsonKeys?: string[];
-    /** `json` — per-key allowed values, derived from CHECK constraints. */
-    jsonValues?: Record<string, string[]>;
-}
-/** A strategy choice offered to the UI for a column. */
-export interface StrategyDescriptor {
-    id: GeneratorStrategyId;
-    label: string;
-}
-/** Everything the "Seed data" page needs to render one column's controls. */
-export interface ColumnGeneratorConfig {
-    name: string;
-    type: string;
-    pk: boolean;
-    notnull: boolean;
-    hasDefault: boolean;
-    /** True when a single-column UNIQUE index enforces uniqueness on this column. */
-    unique: boolean;
-    /** The foreign key this column participates in (as the child), if any. */
-    fk: ForeignKeyInfo | null;
-    strategies: StrategyDescriptor[];
-    defaultPlan: ColumnPlan;
-}
-export interface GenerateResult {
-    /** One entry per generated row: the columns/values to bind (skipped columns are absent). */
-    rows: WhereClause[][];
-    /** Non-fatal notes surfaced to the user (e.g. a NOT NULL column being skipped). */
-    warnings: string[];
-}
-/**
- * Compute per-column generator configuration for a table (default strategies,
- * available strategies, FK metadata). Pure — no DB access — so the page route
- * and the API can share it.
- */
-export declare function buildColumnConfigs(info: TableInfoData): ColumnGeneratorConfig[];
-/**
- * Validate/normalize a client-supplied per-column plan. Returns null when the
- * payload is not a usable plan. Strategy validity against the column's allowed
- * set is enforced later by `generateRows`.
- */
-export declare function sanitizeColumnPlan(raw: unknown): ColumnPlan | null;
-export declare function generateRows(db: SqliteDatabase, info: TableInfoData, configs: ColumnGeneratorConfig[], count: number, plan?: Record<string, ColumnPlan>): Promise<GenerateResult>;
-/**
- * Render generated rows as a sequence of INSERT statements for preview
- * ("generate but never execute"). Each row is its own statement so per-row
- * column lists (with skips) stay valid.
- */
-export declare function buildSeedInsertSql(table: string, rows: WhereClause[][]): string;