@alstar/studio 0.0.0-beta.5 → 0.0.0-beta.7

package/queries/getBlockTrees.ts

@@ -0,0 +1,316 @@
+// types-and-runtime.ts
+// import Database from "better-sqlite3";
+import { DatabaseSync } from "node:sqlite";
+import { sql } from "../utils/sql.ts";
+
+/* =========================
+   Runtime helpers (preserve literal types)
+   ========================= */
+export type FieldType = "text" | "slug" | "markdown" | "image" | "blocks";
+
+export function defineField<const T extends { name: string; label: string; type: FieldType; fields?: readonly any[] }>(def: T) {
+  return def;
+}
+
+export function defineBlock<const T extends { name: string; label: string; type: string; fields?: readonly any[] }>(def: T) {
+  return def;
+}
+
+export function defineStructure<const T extends readonly any[]>(blocks: T) {
+  return blocks;
+}
+
+/* =========================
+   DB base type (every row shape)
+   ========================= */
+export type DBBase = {
+  id: number;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  label: string;
+  type: string;
+  sort_order: number;
+  value: string | null;
+  options: any | null;
+  status: string;
+  parent_id: number | null;
+  depth: number;
+};
+
+/* =========================
+   Type-level mapping: from structure literal -> runtime result types
+   ========================= */
+
+type ArrayElement<T> = T extends readonly (infer U)[] ? U : never;
+
+/** PrimitiveLeaf: non-'blocks' field instance */
+type PrimitiveLeafNode<Name extends string, TypeStr extends string> = DBBase & {
+  readonly name: Name;
+  readonly type: TypeStr;
+  readonly children?: []; // leaf has no children array
+  readonly fields?: {};   // leaf has empty fields
+};
+
+/** Blocks wrapper node (a field with type 'blocks') */
+type BlocksWrapperNode<Name extends string, SubBlocks extends readonly any[]> = DBBase & {
+  readonly name: Name;
+  readonly type: "blocks";
+  // children are the instances of BlockNodeFromDefs for nested block defs
+  readonly children: BlockNodeFromDefs<SubBlocks>[];
+  readonly fields: {}; // wrapper itself doesn't define extra fields in DSL
+};
+
+/** For a FieldDef literal F, produce its runtime node type */
+type FieldNodeFromLiteral<F> =
+  F extends { name: infer N extends string; type: infer FT extends string }
+    ? FT extends "blocks"
+      ? F extends { fields: infer SB extends readonly any[] }
+        ? BlocksWrapperNode<N, SB>
+        : PrimitiveLeafNode<N, FT>
+      : PrimitiveLeafNode<N, FT>
+    : never;
+
+/** Given an array of FieldDefs, produce a mapping name -> appropriate Node */
+type FieldsFromFieldDefs<TDefs> =
+  TDefs extends readonly any[]
+    ? {
+        [P in ArrayElement<TDefs> as P extends { name: infer N extends string } ? N : never]:
+          FieldNodeFromLiteral<P>;
+      }
+    : {};
+
+/** A Block node (for a BlockDef literal B) */
+type BlockNodeFromLiteral<B> =
+  B extends { name: infer BN extends string; type: infer BT extends string; fields?: infer BF extends readonly any[] }
+    ? DBBase & {
+        readonly name: BN;
+        readonly type: BT;
+        // The block's fields mapping is built from B.fields (may include blocks wrappers)
+        readonly fields: FieldsFromFieldDefs<BF>;
+        // Block instances themselves do not keep a top-level children array (their nested content is in fields),
+        // except for "blocks" wrapper nodes (which are FieldNodes, not BlockNodes).
+        readonly children?: []; // mainly unused for normal block instances
+      }
+    : never;
+
+/** Build union type for an array of BlockDefs */
+type BlockNodeFromDefs<TDefs extends readonly any[]> =
+  ArrayElement<TDefs> extends infer B ? (B extends any ? BlockNodeFromLiteral<B> : never) : never;
+
+/** Final result type returned by getBlockTrees for a given structure */
+export type BlockTreeFromStructure<TStructure extends readonly any[]> =
+  BlockNodeFromDefs<TStructure>[];
+
+
+/* =========================
+   RUNTIME: fetch + build + transform
+   ========================= */
+
+/**
+ * Builds adjacency (map of id->node) and attaches children arrays.
+ * Then transforms nodes so that:
+ *  - each node gets .fields where immediate children are mapped by child.name
+ *  - if node.type === "blocks" -> keep node.children as the array of nested blocks
+ *  - otherwise -> clear node.children (we represent children via fields on the parent)
+ */
+function buildForestRows(rows: (DBBase)[]) {
+  const map = new Map<number, any>();
+  for (const r of rows) {
+    // copy DBBase row into mutable node
+    map.set(r.id, {
+      ...r,
+      children: [],
+      fields: {}
+    });
+  }
+
+  const roots: any[] = [];
+  for (const r of rows) {
+    const node = map.get(r.id)!;
+    if (r.parent_id === null) {
+      roots.push(node);
+    } else {
+      const parent = map.get(r.parent_id);
+      if (parent) parent.children.push(node);
+    }
+  }
+
+  // Recursively transform nodes bottom-up
+  function transformNode(node: any) {
+    // first transform children
+    for (const child of node.children) {
+      transformNode(child);
+    }
+
+    // build fields map from immediate children keyed by child.name
+    const fields: Record<string, any> = {};
+    for (const child of node.children) {
+      // assign the transformed child as field value
+      fields[child.name] = child;
+    }
+
+    node.fields = fields;
+
+    // Important: keep the children array only for 'blocks' wrapper nodes,
+    // because wrappers need to hold their nested block instances under children.
+    // For all other nodes we clear children (they are exposed via node.fields)
+    if (node.type !== "blocks") {
+      node.children = [];
+    }
+    return node;
+  }
+
+  return roots.map(transformNode);
+}
+
+function rootQuery(filterSql: string, depthLimit?: number) {
+  const depthLimitClause =
+    depthLimit !== undefined ? `WHERE d.depth + 1 <= ${depthLimit}` : ''
+
+  return sql`
+    with recursive
+      ancestors as (
+        select
+          id,
+          created_at,
+          updated_at,
+          name,
+          label,
+          type,
+          sort_order,
+          value,
+          options,
+          status,
+          parent_id,
+          0 as depth
+        from
+          blocks
+        where
+          ${filterSql}
+        union all
+        select
+          b.id,
+          b.created_at,
+          b.updated_at,
+          b.name,
+          b.label,
+          b.type,
+          b.sort_order,
+          b.value,
+          b.options,
+          b.status,
+          b.parent_id,
+          a.depth + 1
+        from
+          blocks b
+          inner join ancestors a on b.id = a.parent_id
+      ),
+      roots as (
+        select
+          id,
+          created_at,
+          updated_at,
+          name,
+          label,
+          type,
+          sort_order,
+          value,
+          options,
+          status,
+          parent_id,
+          0 as depth
+        from
+          ancestors
+        where
+          parent_id is null
+      ),
+      descendants as (
+        select
+          id,
+          created_at,
+          updated_at,
+          name,
+          label,
+          type,
+          sort_order,
+          value,
+          options,
+          status,
+          parent_id,
+          depth
+        from
+          roots
+        union all
+        select
+          b.id,
+          b.created_at,
+          b.updated_at,
+          b.name,
+          b.label,
+          b.type,
+          b.sort_order,
+          b.value,
+          b.options,
+          b.status,
+          b.parent_id,
+          d.depth + 1
+        from
+          blocks b
+          inner join descendants d on b.parent_id = d.id ${depthLimitClause}
+      )
+    select
+      *
+    from
+      descendants
+    order by
+      parent_id,
+      sort_order;
+  `
+}
+
+function buildFilterSql(params: Record<string, any>) {
+  const entries = Object.entries(params)
+  const filterSql = entries
+    .map(([key, value]) =>
+      value === null ? `${key} is null` : `${key} = :${key}`,
+    )
+    .join(' and ')
+
+  let sqlParams: Record<keyof typeof params, any> = {}
+
+  for (const param in params) {
+    if (params[param] !== null) {
+      sqlParams[param] = params[param]
+    }
+  }
+
+  return { filterSql, sqlParams }
+}
+
+/**
+ * Generic typed getBlockTrees:
+ * - TStructure: the structure literal you pass
+ * - returns: Array of typed block nodes derived from that structure
+ *
+ * NOTE: the runtime SQL must return rows for the correct tree (use your
+ * previous recursive CTE with explicit columns + depth reset for roots).
+ */
+export function getBlockTrees<
+  TStructure extends readonly any[]
+>(
+  db: DatabaseSync,
+  _structure: TStructure,           // used for typing; at runtime it's not strictly needed
+  // sql: string,                      // the recursive SQL with explicit columns (see earlier messages)
+  params: Record<string, any> = {}
+): BlockTreeFromStructure<TStructure> {
+  const { filterSql, sqlParams } = buildFilterSql(params)
+  // run SQL (you must provide the SQL string matching your earlier working CTE)
+  const rows = db.prepare(rootQuery(filterSql)).all(sqlParams) as DBBase[]; // depth included in DBBase.depth
+
+  // build + transform
+  const forest = buildForestRows(rows);
+
+  // cast to compile-time derived type (we ensure runtime shape matches the type)
+  return forest as unknown as BlockTreeFromStructure<TStructure>;
+}

package/queries/getBlocks.ts

@@ -0,0 +1,214 @@
+import { DatabaseSync } from "node:sqlite";
+import { sql } from "../utils/sql.ts";
+
+// --- Field & block definitions ---
+type FieldType = 'text' | 'slug' | 'markdown' | 'blocks' | 'image';
+
+interface BaseField {
+  label: string;
+  type: FieldType;
+}
+
+interface TextField extends BaseField {
+  type: 'text' | 'slug' | 'markdown';
+}
+
+interface ImageField extends BaseField {
+  type: 'image';
+}
+
+interface BlocksField extends BaseField {
+  type: 'blocks';
+  children: Record<string, BlockDef>;
+}
+
+type FieldDef = TextField | ImageField | BlocksField;
+
+interface BlockDef {
+  label: string;
+  type: string;
+  fields: Record<string, FieldDef>;
+}
+
+// --- Identity helpers (preserve literal types) ---
+export function defineField<T extends FieldDef>(field: T) {
+  return field;
+}
+
+export function defineBlock<T extends BlockDef>(block: T) {
+  return block;
+}
+
+export function defineStructure<T extends Record<string, BlockDef>>(structure: T) {
+  return structure;
+}
+
+// --- Type mapping from structure to data ---
+type FieldToType<F extends FieldDef> =
+  F['type'] extends 'text' | 'slug' | 'markdown' ? string :
+  F['type'] extends 'image' ? string :
+  F['type'] extends 'blocks'
+    ? {
+        [K in keyof F['children']]: {
+          type: K;
+          data: BlockData<F['children'][K]>;
+        }
+      }[keyof F['children']][]
+    : never;
+
+type BlockData<B extends BlockDef> = {
+  [K in keyof B['fields']]: FieldToType<B['fields'][K]>;
+};
+
+type StructureData<S extends Record<string, BlockDef>> = {
+  [K in keyof S]: BlockData<S[K]>;
+};
+
+// This will be inferred after you define your structure
+export type CMSData<S extends Record<string, BlockDef>> = StructureData<S>;
+
+
+interface DBBase {
+  id: number;
+  created_at: string;
+  updated_at: string;
+  name: string;
+  label: string;
+  type: string;
+  sort_order: number;
+  value: string | null;
+  options: any;
+  status: string;
+  parent_id: number | null;
+}
+
+export function buildTypedForest<
+  S extends Record<string, BlockDef>,
+  K extends keyof S
+>(
+  rows: DBBase[],
+  rootDef: S[K]
+): CMSData<S>[K][] {
+  const map = new Map<number, DBBase & { children: DBBase[] }>();
+
+  // Initialize with children arrays
+  for (const r of rows) {
+    map.set(r.id, { ...r, children: [] });
+  }
+
+  // Link children to parents
+  const roots: (DBBase & { children: DBBase[] })[] = [];
+  for (const r of rows) {
+    const node = map.get(r.id)!;
+    if (r.parent_id === null) {
+      roots.push(node);
+    } else {
+      const parent = map.get(r.parent_id);
+      if (parent) parent.children.push(node);
+    }
+  }
+
+  // Recursive transformer: maps a DB row into typed data
+  function transformNode<D extends FieldDef | BlockDef>(
+    node: DBBase & DBBase['type'] extends 'blocks' ? { children: DBBase[] } : {},
+    def: D
+  ): any {
+    if ('fields' in def) {
+      // It's a BlockDef
+      const result: any = {};
+      for (const key in def.fields) {
+        const fieldDef = def.fields[key];
+        const childNode = node.children.find(c => c.name === key);
+        result[key] = childNode
+          ? transformNode(childNode, fieldDef)
+          : getDefaultValue(fieldDef);
+      }
+      return result;
+    } else {
+      // It's a FieldDef
+      if (def.type === 'text' || def.type === 'slug' || def.type === 'markdown') {
+        return node.value ?? '';
+      }
+      if (def.type === 'image') {
+        return node.value ?? '';
+      }
+      if (def.type === 'blocks') {
+        return node.children.map(child => {
+          const childDef = def.children[child.name as keyof typeof def.children];
+          return {
+            type: child.name as keyof typeof def.children,
+            data: transformNode(child, childDef)
+          };
+        });
+      }
+    }
+  }
+
+  // Provide safe defaults for missing fields
+  function getDefaultValue(fieldDef: FieldDef): any {
+    if (fieldDef.type === 'blocks') return [];
+    return '';
+  }
+
+  // Map all root nodes into typed data
+  return roots.map(root => transformNode(root, rootDef));
+}
+
+
+function rootQuery(filterSql: string, depthLimit?: number) {
+  const depthLimitClause =
+    depthLimit !== undefined ? `WHERE d.depth + 1 <= ${depthLimit}` : '';
+
+  return sql`
+    with recursive
+      ancestors as (
+        select
+          id, created_at, updated_at, name, label, type, sort_order, value, options, status, parent_id,
+          0 as depth
+        from blocks
+        where ${filterSql}
+        union all
+        select
+          b.id, b.created_at, b.updated_at, b.name, b.label, b.type, b.sort_order, b.value, b.options, b.status, b.parent_id,
+          a.depth + 1
+        from blocks b
+        inner join ancestors a on b.id = a.parent_id
+      ),
+      roots as (
+        select * from ancestors where parent_id is null
+      ),
+      descendants as (
+        select * from roots
+        union all
+        select
+          b.id, b.created_at, b.updated_at, b.name, b.label, b.type, b.sort_order, b.value, b.options, b.status, b.parent_id,
+          d.depth + 1
+        from blocks b
+        inner join descendants d on b.parent_id = d.id ${depthLimitClause}
+      )
+    select * from descendants
+    order by parent_id, sort_order
+  `;
+}
+
+export function queryTypedRoot<
+  S extends Record<string, BlockDef>,
+  K extends keyof S
+>(
+  db: DatabaseSync,
+  structure: S,
+  blockType: K,
+  opts: { id?: number; depthLimit?: number }
+): CMSData<S>[K][] {
+  let filterSql: string;
+  if (opts.id !== undefined) {
+    filterSql = `id = ${opts.id}`;
+  } else {
+    filterSql = `type = '${String(structure[blockType].type)}'`;
+  }
+
+  const sql = rootQuery(filterSql, opts.depthLimit);
+  const rows = db.prepare(sql).all() as unknown as DBBase[];
+
+  return buildTypedForest(rows, structure[blockType]);
+}

package/queries/index.ts

@@ -1 +1,2 @@
 export * as query from './block.ts'
+export { getBlockTrees } from './getBlockTrees.ts'

package/queries/structure-types.ts

@@ -0,0 +1,97 @@
+// structure-types.ts
+import { type DBBase } from "./db-types.ts";
+
+/**
+ * Extract helpers
+ */
+type ArrayElement<T> = T extends readonly (infer U)[] ? U : never;
+
+/**
+ * Field definition shape inferred from defineField(...) (the runtime helper)
+ * We keep it generic as "any" shape but with the important properties present
+ */
+type FieldDef = {
+  readonly name: string;
+  readonly type: string;
+  readonly fields?: readonly any[]; // only present when type === 'blocks'
+};
+
+/**
+ * Block definition shape inferred from defineBlock(...) (the runtime helper)
+ */
+type BlockDef = {
+  readonly name: string;
+  readonly type: string;
+  readonly fields?: readonly FieldDef[];
+};
+
+/**
+ * Primitive field node (non-'blocks'): DBBase + kept fields but no children
+ */
+type PrimitiveFieldNode<TField extends FieldDef> =
+  DBBase & {
+    readonly name: TField["name"];
+    readonly type: TField["type"];
+    // no children (leaf), no nested fields
+    readonly children?: [];
+    readonly fields?: {}; // empty object for leaf
+  };
+
+/**
+ * For 'blocks' typed field, we need:
+ * - the block node representing the 'blocks' wrapper (has DBBase props)
+ * - its 'children' are an array of BlockNodes corresponding to nested block defs supplied in the field's 'fields' array
+ * - its 'fields' property is the mapping of its own child-field names (can be empty)
+ */
+type BlocksFieldNode<
+  TField extends FieldDef,
+  TFieldDefs extends readonly BlockDef[]
+> = DBBase & {
+  readonly name: TField["name"];      // e.g. "blocks" or "images"
+  readonly type: "blocks";            // literally 'blocks'
+  readonly children: BlockNodeFromBlockDefs<TFieldDefs>[]; // children are instances of the nested blocks
+  readonly fields: FieldsFromFieldDefs<TFieldDefs[number]["fields"]>; // the blocks-wrapper's own fields mapping (if any)
+};
+
+/**
+ * Build the 'fields' object for a set of FieldDef[].
+ * Maps each field name -> either PrimitiveFieldNode or BlocksFieldNode recursively.
+ */
+type FieldsFromFieldDefs<TDefs> =
+  // If no fields
+  TDefs extends readonly any[]
+    ? {
+        // For each field F in TDefs, map F['name'] -> node type
+        [F in ArrayElement<TDefs> as F extends { name: infer N extends string } ? N : never]:
+          F extends { type: "blocks"; fields: readonly BlockDef[] }
+            ? BlocksFieldNode<F, F["fields"]>
+            : PrimitiveFieldNode<F>;
+      }
+    : {};
+
+/**
+ * A Block node type for a particular BlockDef.
+ * - fields: mapping derived from the block's declared fields
+ * - children: by default [], because in our final shape all immediate children are placed under 'fields' of the parent.
+ *   BUT for nodes that are themselves 'blocks' wrappers (i.e. appear as a Block instance of a nested block def),
+ *   their 'children' will contain actual child blocks (these are handled via BlocksFieldNode above).
+ */
+export type BlockNode<T extends BlockDef> = DBBase & {
+  readonly name: T["name"];
+  readonly type: T["type"];
+  readonly fields: FieldsFromFieldDefs<T["fields"]>;
+  // for regular block nodes, children will usually be [] (top-level parent's children moved into fields)
+  readonly children: [];
+};
+
+/**
+ * Construct BlockNode unions for a set of block defs (used when blocks field has multiple block subdefs)
+ */
+type BlockNodeFromBlockDefs<TDefs extends readonly BlockDef[]> =
+  ArrayElement<TDefs> extends infer B ? (B extends BlockDef ? BlockNode<B> : never) : never;
+
+/**
+ * The top-level forest return type when you pass a structure: it's an array of BlockNode of any top-level BlockDef
+ */
+export type BlockTreeFromStructure<TStructure extends readonly BlockDef[]> =
+  BlockNodeFromBlockDefs<TStructure>;

package/schemas.ts

@@ -7,11 +7,22 @@ export const blocksTable = {
     name TEXT not null,
     label TEXT not null,
     type TEXT not null,
-    sort_order INTEGER not null default 0,
     value TEXT,
     options JSON,
     status TEXT default 'enabled',
-    parent_block_id INTEGER,
-    foreign key (parent_block_id) references blocks (id)
+    sort_order INTEGER not null default 0,
+    _depth INTEGER,
+    parent_id INTEGER,
+    foreign key (parent_id) references blocks (id)
+  `,
+}
+
+// -- API keys
+export const apiKeysTable = {
+  tableName: 'api_keys',
+  columns: sql`
+    name TEXT not null,
+    value TEXT,
+    hint TEXT
   `,
 }