@stacksjs/database 0.75.369 → 0.75.371

package/dist/erd.d.ts

@@ -40,6 +40,8 @@ export declare function toDiagrammableModel(definition: {
  * because it reads as schema rather than as a typo.
  */
 export declare function relationEdges(models: DiagrammableModel[]): DiagramEdge[];
+/** The level `options` asks for, with `columns: false` still meaning `none`. */
+export declare function erdDetailFrom(options: RenderErdOptions): ErdDetail;
 /**
  * A Mermaid `erDiagram` for these models.
  *
@@ -48,6 +50,8 @@ export declare function relationEdges(models: DiagrammableModel[]): DiagramEdge[
  * the detail of each table.
  */
 export declare function renderErd(models: DiagrammableModel[], options?: RenderErdOptions): string;
+/** Mermaid's own default `maxTextSize`, past which it draws an error box. */
+export declare const MERMAID_MAX_TEXT_SIZE: unknown;
 /** One model, reduced to what a diagram needs. */
 export declare interface DiagrammableModel {
   name: string
@@ -72,5 +76,19 @@ export declare interface DiagramEdge {
 }
 export declare interface RenderErdOptions {
   columns?: boolean
+  detail?: ErdDetail
   only?: string[]
 }
+/**
+ * How much of each table the diagram draws.
+ *
+ * Mermaid stops rendering a diagram whose source passes `maxTextSize`, which
+ * is 50,000 characters unless the page says otherwise, and replaces the whole
+ * thing with an error box. Columns are the bulk of an ER diagram's text - on a
+ * 155-table schema they were 76% of it - so the dial that keeps a diagram
+ * renderable is how many of them are drawn, not how many tables are.
+ *
+ * `keys` keeps the primary and foreign keys, which is what makes an ER diagram
+ * worth reading: it is the column a relationship is made of.
+ */
+export type ErdDetail = 'full' | 'keys' | 'none';

package/dist/erd.js

@@ -1,3 +1,3 @@
-import{foreignKeyForModel}from"./vschema";const SAFE_TYPE=/^[a-z][a-z0-9_]*$/;export function columnType(attribute){const rules=attribute?.validation?.rule?.rules,head=Array.isArray(rules)?rules[0]?.name:void 0;if(typeof head==="string"&&SAFE_TYPE.test(head))return head;const fallback=attribute?.default;if(typeof fallback==="boolean")return"boolean";if(typeof fallback==="number")return"number";if(typeof fallback==="string")return"string";return"unknown"}export function relatedModelNames(raw){if(typeof raw==="string")return[raw];if(Array.isArray(raw))return raw.map((entry)=>typeof entry==="string"?entry:entry?.model).filter((entry)=>Boolean(entry));if(raw&&typeof raw==="object")return Object.keys(raw);return[]}export function toDiagrammableModel(definition,table){const primaryKey=definition?.primaryKey||"id",traits=definition?.traits??{},columns=[{name:primaryKey,type:"number",key:"PK"}];if(traits.useUuid)columns.push({name:"uuid",type:"string",key:"UK"});for(const[name,attribute]of Object.entries(definition?.attributes??{})){const unique=Boolean(attribute?.unique);columns.push({name,type:columnType(attribute),...unique?{key:"UK"}:{}})}const belongsTo=relatedModelNames(definition?.belongsTo);for(const parent of belongsTo){const column=foreignKeyForModel(parent);if(!columns.some((existing)=>existing.name===column))columns.push({name:column,type:"number",key:"FK"})}if(traits.useTimestamps){columns.push({name:"created_at",type:"datetime"});columns.push({name:"updated_at",type:"datetime"})}if(traits.useSoftDeletes)columns.push({name:"deleted_at",type:"datetime"});return{name:definition?.name??table,table,primaryKey,columns,belongsTo,hasOne:relatedModelNames(definition?.hasOne),hasMany:relatedModelNames(definition?.hasMany)}}export function relationEdges(models){const tableByModel=new Map(models.map((model)=>[model.name,model.table])),seen=new Set,edges=[],add=(from,to,cardinality,label)=>{const key=[from,to].sort().join("\x00");if(seen.has(key))return;seen.add(key);edges.push({from,to,cardinality,label})},sorted=[...models].sort((a,b)=>a.table.localeCompare(b.table));for(const model of sorted){for(const child of[...model.hasMany].sort()){const table=tableByModel.get(child);if(table)add(model.table,table,"||--o{","has many")}for(const child of[...model.hasOne].sort()){const table=tableByModel.get(child);if(table)add(model.table,table,"||--o|","has one")}}for(const model of sorted)for(const parent of[...model.belongsTo].sort()){const table=tableByModel.get(parent);if(table)add(table,model.table,"||--o{","has many")}return edges}export function renderErd(models,options={}){const sorted=[...options.only&&options.only.length>0?models.filter((model)=>options.only.includes(model.table)||options.only.includes(model.name)):models].sort((a,b)=>a.table.localeCompare(b.table)),lines=["erDiagram"];for(const edge of relationEdges(sorted))lines.push(`  ${edge.from} ${edge.cardinality} ${edge.to} : "${edge.label}"`);if(options.columns===!1)return lines.join(`
-`);for(const model of sorted){lines.push(`  ${model.table} {`);for(const column of model.columns)lines.push(`    ${column.type} ${column.name}${column.key?` ${column.key}`:""}`);lines.push("  }")}return lines.join(`
+import{foreignKeyForModel}from"./vschema";const SAFE_TYPE=/^[a-z][a-z0-9_]*$/;export function columnType(attribute){const rules=attribute?.validation?.rule?.rules,head=Array.isArray(rules)?rules[0]?.name:void 0;if(typeof head==="string"&&SAFE_TYPE.test(head))return head;const fallback=attribute?.default;if(typeof fallback==="boolean")return"boolean";if(typeof fallback==="number")return"number";if(typeof fallback==="string")return"string";return"unknown"}export function relatedModelNames(raw){if(typeof raw==="string")return[raw];if(Array.isArray(raw))return raw.map((entry)=>typeof entry==="string"?entry:entry?.model).filter((entry)=>Boolean(entry));if(raw&&typeof raw==="object")return Object.keys(raw);return[]}export function toDiagrammableModel(definition,table){const primaryKey=definition?.primaryKey||"id",traits=definition?.traits??{},columns=[{name:primaryKey,type:"number",key:"PK"}];if(traits.useUuid)columns.push({name:"uuid",type:"string",key:"UK"});for(const[name,attribute]of Object.entries(definition?.attributes??{})){const unique=Boolean(attribute?.unique);columns.push({name,type:columnType(attribute),...unique?{key:"UK"}:{}})}const belongsTo=relatedModelNames(definition?.belongsTo);for(const parent of belongsTo){const column=foreignKeyForModel(parent);if(!columns.some((existing)=>existing.name===column))columns.push({name:column,type:"number",key:"FK"})}if(traits.useTimestamps){columns.push({name:"created_at",type:"datetime"});columns.push({name:"updated_at",type:"datetime"})}if(traits.useSoftDeletes)columns.push({name:"deleted_at",type:"datetime"});return{name:definition?.name??table,table,primaryKey,columns,belongsTo,hasOne:relatedModelNames(definition?.hasOne),hasMany:relatedModelNames(definition?.hasMany)}}export function relationEdges(models){const tableByModel=new Map(models.map((model)=>[model.name,model.table])),seen=new Set,edges=[],add=(from,to,cardinality,label)=>{const key=[from,to].sort().join("\x00");if(seen.has(key))return;seen.add(key);edges.push({from,to,cardinality,label})},sorted=[...models].sort((a,b)=>a.table.localeCompare(b.table));for(const model of sorted){for(const child of[...model.hasMany].sort()){const table=tableByModel.get(child);if(table)add(model.table,table,"||--o{","has many")}for(const child of[...model.hasOne].sort()){const table=tableByModel.get(child);if(table)add(model.table,table,"||--o|","has one")}}for(const model of sorted)for(const parent of[...model.belongsTo].sort()){const table=tableByModel.get(parent);if(table)add(table,model.table,"||--o{","has many")}return edges}export const MERMAID_MAX_TEXT_SIZE=50000;export function erdDetailFrom(options){if(options.detail)return options.detail;return options.columns===!1?"none":"full"}export function renderErd(models,options={}){const sorted=[...options.only&&options.only.length>0?models.filter((model)=>options.only.includes(model.table)||options.only.includes(model.name)):models].sort((a,b)=>a.table.localeCompare(b.table)),lines=["erDiagram"];for(const edge of relationEdges(sorted))lines.push(`  ${edge.from} ${edge.cardinality} ${edge.to} : "${edge.label}"`);const detail=erdDetailFrom(options);if(detail==="none")return lines.join(`
+`);for(const model of sorted){const columns=detail==="keys"?model.columns.filter((column)=>column.key):model.columns;lines.push(`  ${model.table} {`);for(const column of columns)lines.push(`    ${column.type} ${column.name}${column.key?` ${column.key}`:""}`);lines.push("  }")}return lines.join(`
 `)}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@stacksjs/database",
   "type": "module",
   "sideEffects": false,
-  "version": "0.75.369",
+  "version": "0.75.371",
   "description": "The Stacks database integration.",
   "author": "Chris Breuer",
   "contributors": [
@@ -66,26 +66,26 @@
     "prepublishOnly": "bun run build"
   },
   "dependencies": {
-    "@stacksjs/config": "0.75.369",
-    "@stacksjs/env": "0.75.369",
-    "@stacksjs/error-handling": "0.75.369",
-    "@stacksjs/faker": "0.75.369",
-    "@stacksjs/features": "0.75.369",
-    "@stacksjs/logging": "0.75.369",
-    "@stacksjs/model-meta": "0.75.369",
-    "@stacksjs/path": "0.75.369",
-    "@stacksjs/query-builder": "0.75.369",
-    "@stacksjs/security": "0.75.369",
-    "@stacksjs/storage": "0.75.369",
-    "@stacksjs/strings": "0.75.369",
+    "@stacksjs/config": "0.75.371",
+    "@stacksjs/env": "0.75.371",
+    "@stacksjs/error-handling": "0.75.371",
+    "@stacksjs/faker": "0.75.371",
+    "@stacksjs/features": "0.75.371",
+    "@stacksjs/logging": "0.75.371",
+    "@stacksjs/model-meta": "0.75.371",
+    "@stacksjs/path": "0.75.371",
+    "@stacksjs/query-builder": "0.75.371",
+    "@stacksjs/security": "0.75.371",
+    "@stacksjs/storage": "0.75.371",
+    "@stacksjs/strings": "0.75.371",
     "@stacksjs/ts-validation": "^0.5.6",
     "bun-query-builder": "^0.3.28",
     "dynamodb-tooling": "^0.3.6"
   },
   "devDependencies": {
-    "@stacksjs/cli": "0.75.369",
-    "@stacksjs/router": "0.75.369",
-    "@stacksjs/utils": "0.75.369",
+    "@stacksjs/cli": "0.75.371",
+    "@stacksjs/router": "0.75.371",
+    "@stacksjs/utils": "0.75.371",
     "better-dx": "^0.2.24"
   }
 }