@dineug/erd-editor 3.10.0 → 4.1.0

package/dist/utils/tableGroup.d.ts

@@ -0,0 +1,142 @@
+import { RootState } from '../engine/state';
+import { Point, Table, TableGroup } from '../internal-types';
+import { Rect } from '../konva/scene/metrics';
+import { GeometrySource } from './draw-relationship/geometrySource';
+export type TableGroupRectOptions = {
+    /** Tables the box leaves out though they are members, the ones a drag holds. */
+    excludeTableIds?: ReadonlyArray<string>;
+};
+/** A group's box options, and the members it is read from when the caller holds them. */
+export type TableGroupMemberOptions = TableGroupRectOptions & {
+    /** The group's member tables, which spares a walk over every table of the document. */
+    members?: ReadonlyArray<Table>;
+};
+/**
+ * The group a table is in, or '' for none: a groupId naming no group the
+ * document lists reads as none, whatever the table saved.
+ */
+export declare function getTableGroupId({ doc }: RootState, table: Table): string;
+/** The ids of the tables a group holds, in document order; none for a group the document does not list. */
+export declare function getTableGroupMemberIds(state: RootState, groupId: string): string[];
+/**
+ * A rect grown by the padding on every side and by the title bar on top too,
+ * so the bar a group draws along the top of its box clears what it holds.
+ */
+export declare function padRect(rect: Rect, padding?: number): Rect;
+/**
+ * The box a group is drawn and hit in: its stored rect united with each member
+ * table's rect and the padding around it, title bar included, so a member that
+ * grows never sticks out and nothing is written for it.
+ *
+ * @example
+ * const box = getTableGroupRect(state, group, { excludeTableIds: dragged });
+ */
+export declare function getTableGroupRect(state: RootState, group: TableGroup, { excludeTableIds, members, }?: TableGroupMemberOptions): Rect;
+/**
+ * Each group's box seeded at its stored rect, keyed by id, for one walk over
+ * the tables to grow with growTableGroupBox: every box out of one pass, where
+ * a box apiece walks every table once per group.
+ */
+export declare function seedTableGroupBoxes(groups: ReadonlyArray<TableGroup>): Map<string, Rect>;
+/**
+ * Grows the box of the group a table names by the table's rect and padding; a
+ * table naming no seeded group, a removed one among them, grows none.
+ */
+export declare function growTableGroupBox(boxes: Map<string, Rect>, table: Table, rect: Rect): void;
+/**
+ * The box of every group the document lists, keyed by id, each as
+ * getTableGroupRect reads it, out of one walk over the tables.
+ *
+ * @example
+ * const boxes = getTableGroupRects(state, { excludeTableIds: dragged });
+ */
+export declare function getTableGroupRects(state: RootState, { excludeTableIds }?: TableGroupRectOptions): Map<string, Rect>;
+/**
+ * The member tables of every group the document lists, keyed by id, each list
+ * in document order, out of one walk over the tables; a group with no member
+ * is left out.
+ */
+export declare function getTableGroupMembers(state: RootState): Map<string, Table[]>;
+/**
+ * The rect a group made from tables takes: their bounds and the padding around
+ * them, or null for no table the document lists.
+ */
+export declare function getTablesGroupRect(state: RootState, tableIds: ReadonlyArray<string>): Rect | null;
+/** A group and the rect a placement gives it. */
+export type TableGroupWrap = Rect & {
+    id: string;
+};
+/**
+ * The rect each listed group with a member takes once every table named stands
+ * at its point: its members' bounds and the padding, what an automatic
+ * placement writes. A group with no member keeps its rect and is left out.
+ *
+ * @example
+ * const resizes = getTableGroupWraps(state, points).map(resizeTableGroupAction);
+ */
+export declare function getTableGroupWraps(state: RootState, points?: ReadonlyArray<Point & {
+    id: string;
+}>): TableGroupWrap[];
+/** The centre of a table's box, the point every membership test reads. */
+export declare function getTableCenter(state: RootState, table: Table): Point;
+/** Whether the point lies in the rect, its edges included. */
+export declare function isPointInRect({ x, y }: Point, rect: Rect): boolean;
+/**
+ * The topmost group whose box holds the point: the highest zIndex, and of two
+ * at one the later in doc.tableGroupIds, the one drawn over the other. Null
+ * where no group's box reaches.
+ *
+ * @example
+ * const group = findTableGroupAt(state, getTableCenter(state, table));
+ */
+export declare function findTableGroupAt(state: RootState, point: Point, options?: TableGroupRectOptions): TableGroup | null;
+/** Where findTableGroupsAt reads the boxes: built from the tables, or handed in built. */
+export type TableGroupFindOptions = TableGroupRectOptions & {
+    /** Every group's box, keyed as getTableGroupRects keys them, read in place of building them. */
+    boxes?: ReadonlyMap<string, Rect>;
+};
+/**
+ * The topmost group at each point, as findTableGroupAt finds it, every box
+ * read once for all of them, which a drag of many tables asks every step; no
+ * point, and no box is built.
+ *
+ * @example
+ * const groups = findTableGroupsAt(state, centers, { excludeTableIds: ids });
+ */
+export declare function findTableGroupsAt(state: RootState, points: ReadonlyArray<Point>, { boxes, ...options }?: TableGroupFindOptions): Array<TableGroup | null>;
+/** The zIndex that lifts a group over every other group, tables and memos aside. */
+export declare const nextTableGroupZIndex: (groups: TableGroup[]) => number;
+/**
+ * Whether the document shows its groups, boxes and header colors alike. The
+ * bit hides them, so a document saved before groups existed shows them.
+ */
+export declare const isTableGroupShown: ({ settings }: RootState) => boolean;
+/** A group's color as an opaque hex and the black or white text drawn over it. */
+export type TableGroupColors = {
+    background: string;
+    foreground: string;
+};
+/**
+ * The colors a group paints with, or null for a group with no color or one
+ * toOpaqueHex cannot read, which the neutral theme colors paint instead.
+ */
+export declare function getTableGroupColors(group: TableGroup): TableGroupColors | null;
+/**
+ * The colors a member table's header takes from its group, or null where it
+ * keeps its own: in a view, while groups are hidden, out of any group, or in
+ * a group with no color it can read.
+ *
+ * @example
+ * const tint = getTableHeaderTint(state, table, source);
+ */
+export declare function getTableHeaderTint(state: RootState, table: Table, source?: GeometrySource): TableGroupColors | null;
+/**
+ * The colors a header takes from the group named, one already read as listed ('' for none), as
+ * getTableHeaderTint decides them: a scene naming each table's group off one read of the list hands
+ * it here, so a group coming or going re-renders no table it does not reach.
+ *
+ * @example
+ * const tint = getTableGroupTint(state, props.tableGroupId, source);
+ */
+export declare function getTableGroupTint(state: RootState, groupId: string, source?: GeometrySource): TableGroupColors | null;
+//# sourceMappingURL=tableGroup.d.ts.map

package/dist/utils/tableKeys.d.ts

@@ -19,17 +19,25 @@ export type ColumnKey = {
     name: string;
     columnIds: string[];
 };
-/** One alternate key: a unique index of the table and the columns it keys, in key order. */
-export type AlternateKey = {
+/** A unique index of the table and the columns of the table it keys, in key order. */
+export type UniqueIndexKey = {
     indexId: string;
     columnIds: string[];
 };
+/** One alternate key: a unique index over two or more of the table's columns. */
+export type AlternateKey = UniqueIndexKey;
 /**
  * The keys a table's columns declare, primary key first and then each unique
  * column in column order. Only the columns edit them, so a list showing them
  * beside the index entities shows them read only.
  */
-export declare function getColumnKeys({ collections }: KeyState, table: Table): ColumnKey[];
+export declare function getColumnKeys({ collections, settings }: Pick<RootState, 'collections' | 'settings'>, table: Table): ColumnKey[];
+/**
+ * Each unique index of the table in index list order, with the columns of the
+ * table it keys in key order: over two or more an alternate key, over one the
+ * unique key of that column.
+ */
+export declare function getUniqueIndexKeys(state: KeyState, table: Table): UniqueIndexKey[];
 /**
  * The table's alternate keys, AK1 first: its unique indexes over two or more
  * of its columns, ordered by where those columns stand in the table. Neither

package/dist/utils/takeover.d.ts

@@ -0,0 +1,6 @@
+import { RootState } from '../engine/state';
+/** The overlays that take the whole canvas over, each standing a scene of its own there. */
+export declare const TAKEOVERS: ("automaticTablePlacement" | "diffViewer" | "timeTravel")[];
+/** Whether an overlay that takes the canvas over is up, which keeps Find and Replace and the Explorer shut. */
+export declare const isTakenOver: ({ editor }: RootState) => boolean;
+//# sourceMappingURL=takeover.d.ts.map

package/dist/utils/virtualRange.d.ts

@@ -0,0 +1,15 @@
+/** How many rows a virtual list draws past each edge of its view, so a short scroll finds them drawn already. */
+export declare const VIRTUAL_OVERSCAN = 8;
+/** The rows a list renders, first to last, both included; none while last is below first. */
+export type VirtualRange = {
+    first: number;
+    last: number;
+};
+/** The rows the screen shows at a scroll offset, with the overscan either side. */
+export declare function visibleRange(count: number, scrollTop: number, height: number, rowHeight: number): VirtualRange;
+/**
+ * The scroll offset nearest the one given that shows a row whole: the same
+ * while it shows, else the row's top or bottom at the edge it is past.
+ */
+export declare function offsetToShow(index: number, scrollTop: number, height: number, rowHeight: number): number;
+//# sourceMappingURL=virtualRange.d.ts.map

package/dist/workers/elkLayout.shared-worker.js

@@ -1 +1 @@
-import*as e from"comlink";typeof document>`u`&&Reflect.set(globalThis,`document`,{});const t={force:`force`,layeredHorizontal:`layeredHorizontal`,layeredVertical:`layeredVertical`,flow:`flow`,viewLayered:`viewLayered`};t.force;function n(e){return e!==t.force}function r(e){return e===t.flow}const i={"elk.algorithm":`layered`,"elk.layered.spacing.baseValue":`40`,"elk.spacing.componentComponent":`80`,"elk.layered.spacing.edgeNodeBetweenLayers":`120`,"elk.layered.considerModelOrder.strategy":`PREFER_EDGES`,"elk.layered.crossingMinimization.forceNodeModelOrder":`true`,"elk.layered.mergeEdges":`true`,"elk.layered.nodePlacement.strategy":`INTERACTIVE`,"elk.layered.layering.strategy":`INTERACTIVE`},a={"elk.alignment":`LEFT`},o={"elk.aspectRatio":`0.5625`},s={"elk.spacing.nodeNode":`80`,"elk.separateConnectedComponents":`true`,"elk.spacing.componentComponent":`160`},c=e=>({...s,"elk.algorithm":`layered`,"elk.direction":e,"elk.layered.spacing.nodeNodeBetweenLayers":`160`,"elk.layered.cycleBreaking.strategy":`DEPTH_FIRST`});function l(e){switch(e){case t.layeredHorizontal:return c(`RIGHT`);case t.layeredVertical:return c(`DOWN`);case t.flow:return{...c(`RIGHT`),"elk.layered.nodePlacement.strategy":`SIMPLE`,"elk.layered.spacing.edgeNodeBetweenLayers":`80`};case t.viewLayered:return{...i}}}function u(e){return e===t.viewLayered?{...a}:null}const d=[...new Set(Object.values(t).filter(n).map(e=>l(e)[`elk.algorithm`]))],f=`EAST`,p=e=>`edge-${e}-source`,m=e=>`edge-${e}-target`;function h(e,t){return e.side===t.side?e.side===f?e.row-t.row:t.row-e.row:e.side===f?-1:1}function g(e){let t=/* @__PURE__ */ new Map,n=(e,n)=>{let r=t.get(e);r?r.push(n):t.set(e,[n])};return e.forEach((e,t)=>{n(e.source,{id:p(t),row:e.sourceRow,side:f}),n(e.target,{id:m(t),row:e.targetRow,side:`WEST`})}),new Map([...t].map(([e,t])=>[e,t.sort(h).map(({id:e,side:t})=>({id:e,width:8,height:8,layoutOptions:{"elk.port.side":t}}))]))}function _({placement:e,nodes:t,edges:n}){let i=r(e)?g(n):null;return{id:`root`,layoutOptions:l(e),children:t.map(t=>v(t,e,i)),edges:n.map(({source:e,target:t},n)=>({id:`edge-${n}`,sources:[i?p(n):e],targets:[i?m(n):t]}))}}function v({id:e,width:t,height:n,x:r,y:i,children:a},s,c){if(a?.length)return{id:e,width:t,height:n,layoutOptions:{...o},children:a.map(e=>v(e,s,c))};let l={...u(s),...c?{"elk.portConstraints":`FIXED_ORDER`}:{}};return{id:e,width:t,height:n,...r===void 0?{}:{x:r},...i===void 0?{}:{y:i},...Object.keys(l).length?{layoutOptions:l}:{},...c?{ports:c.get(e)??[]}:{}}}function y(e,t,n){return e.flatMap(({id:e,x:r,y:i,children:a})=>{let o=t+(r??0),s=n+(i??0);return a?.length?y(a,o,s):[{id:e,x:o,y:s}]})}let b=null;function x(){return b??=import(`elkjs/lib/elk.bundled.js`).then(({default:e})=>new e({algorithms:d})),b}const S=new class{async ready(){return await x(),!0}async layout(e){return y((await(await x()).layout(_(e))).children??[],0,0)}};self.onconnect=t=>{let n=t.ports[0];e.expose(S,n)};
+import*as e from"comlink";typeof document>`u`&&Reflect.set(globalThis,`document`,{});const t={force:`force`,layeredHorizontal:`layeredHorizontal`,layeredVertical:`layeredVertical`,flow:`flow`,viewLayered:`viewLayered`};t.force;function n(e){return e!==t.force}function r(e){return e===t.flow}const i={"elk.padding":`[top=52,left=24,bottom=24,right=24]`},a={"elk.padding":`[top=0,left=0,bottom=0,right=0]`,"elk.hierarchyHandling":`INCLUDE_CHILDREN`},o={"elk.algorithm":`layered`,"elk.layered.spacing.baseValue":`40`,"elk.spacing.componentComponent":`80`,"elk.layered.spacing.edgeNodeBetweenLayers":`120`,"elk.layered.considerModelOrder.strategy":`PREFER_EDGES`,"elk.layered.crossingMinimization.forceNodeModelOrder":`true`,"elk.layered.mergeEdges":`true`,"elk.layered.nodePlacement.strategy":`INTERACTIVE`,"elk.layered.layering.strategy":`INTERACTIVE`},s={"elk.alignment":`LEFT`},c={"elk.aspectRatio":`0.5625`},l={"elk.spacing.nodeNode":`80`,"elk.separateConnectedComponents":`true`,"elk.spacing.componentComponent":`160`},u=e=>({...l,"elk.algorithm":`layered`,"elk.direction":e,"elk.layered.spacing.nodeNodeBetweenLayers":`160`,"elk.layered.cycleBreaking.strategy":`DEPTH_FIRST`});function d(e){switch(e){case t.layeredHorizontal:return u(`RIGHT`);case t.layeredVertical:return u(`DOWN`);case t.flow:return{...u(`RIGHT`),"elk.layered.nodePlacement.strategy":`SIMPLE`,"elk.layered.spacing.edgeNodeBetweenLayers":`80`};case t.viewLayered:return{...o}}}function f(e){return e===t.viewLayered?{...s}:null}function p(e,t){switch(t){case`tableGroup`:return{...d(e),...i};case`component`:return{...d(e),...a};default:return{...c}}}const m=[...new Set(Object.values(t).filter(n).map(e=>d(e)[`elk.algorithm`]))],h=`EAST`,g=e=>`edge-${e}-source`,_=e=>`edge-${e}-target`;function v(e,t){return e.side===t.side?e.side===h?e.row-t.row:t.row-e.row:e.side===h?-1:1}function y(e){let t=/* @__PURE__ */ new Map,n=(e,n)=>{let r=t.get(e);r?r.push(n):t.set(e,[n])};return e.forEach((e,t)=>{n(e.source,{id:g(t),row:e.sourceRow,side:h}),n(e.target,{id:_(t),row:e.targetRow,side:`WEST`})}),new Map([...t].map(([e,t])=>[e,t.sort(v).map(({id:e,side:t})=>({id:e,width:8,height:8,layoutOptions:{"elk.port.side":t}}))]))}function b(e,t=/* @__PURE__ */ new Map){return e.forEach(({id:e,children:n=[]})=>{n.forEach(n=>t.set(n.id,e)),b(n,t)}),t}function x(e,t){let n=[];for(let r=e.get(t);r;r=e.get(r))n.push(r);return n}function S(e,t,n){let r=new Set(x(e,t));return x(e,n).find(e=>r.has(e))??null}function C({placement:e,nodes:t,edges:n}){let i=r(e)?y(n):null,a=b(t),o=/* @__PURE__ */ new Map;return n.forEach(({source:e,target:t},n)=>{let r=S(a,e,t),s={id:`edge-${n}`,sources:[i?g(n):e],targets:[i?_(n):t]},c=o.get(r);c?c.push(s):o.set(r,[s])}),{id:`root`,layoutOptions:d(e),children:t.map(t=>w(t,e,i,o)),edges:o.get(null)??[]}}function w({id:e,width:t,height:n,x:r,y:i,children:a,kind:o},s,c,l){if(a?.length){let r=l.get(e);return{id:e,width:t,height:n,layoutOptions:p(s,o),children:a.map(e=>w(e,s,c,l)),...r?{edges:r}:{}}}let u={...f(s),...c?{"elk.portConstraints":`FIXED_ORDER`}:{}};return{id:e,width:t,height:n,...r===void 0?{}:{x:r},...i===void 0?{}:{y:i},...Object.keys(u).length?{layoutOptions:u}:{},...c?{ports:c.get(e)??[]}:{}}}function T(e,t,n){return e.flatMap(({id:e,x:r,y:i,children:a})=>{let o=t+(r??0),s=n+(i??0);return a?.length?T(a,o,s):[{id:e,x:o,y:s}]})}let E=null;function D(){return E??=import(`elkjs/lib/elk.bundled.js`).then(({default:e})=>new e({algorithms:m})),E}const O=new class{async ready(){return await D(),!0}async layout(e){return T((await(await D()).layout(C(e))).children??[],0,0)}};self.onconnect=t=>{let n=t.ports[0];e.expose(O,n)};