@dineug/erd-editor 3.10.0 → 4.0.0

package/dist/services/export-png/index.d.ts

@@ -1,3 +1,4 @@
+import { LocaleMessages } from '../../i18n/translate';
 import { Theme } from '../../themes/tokens';
 import { ResolutionReduction } from './renderPng';
 import { ToWidth } from './textWidth';
@@ -27,29 +28,61 @@ export type DocumentPngOptions = {
      * than to be called across a boundary a function does not cross.
      */
     toWidth: ToWidth;
+    /** Image pixels per scene unit: the scale a dialog picks, 1 when left out. */
     pixelRatio?: number;
     /**
-     * The zoom the image is drawn at, which is the editor's own rather than the
-     * document's whenever the author asked for the zoom not to be saved. Left
-     * out, the image is drawn at the zoom the document carries.
+     * The language the scene's own words are drawn in, a table with no name say.
+     * Left out, the scene draws them in English.
      */
-    zoomLevel?: number;
+    i18n?: LocaleMessages;
     /**
-     * Called once, after a file exists, when the box outran what a canvas holds
-     * and the image had to be scaled down. A caller with somewhere to put it is
-     * what turns a silent loss of resolution into something the author is told.
+     * Called once, after a file exists, when the pixels the scale asked for
+     * outran what a canvas holds, with those and the pixels written. A caller
+     * with somewhere to put it tells the author of a loss that is otherwise silent.
      */
     onResolutionReduced?: (reduction: ResolutionReduction) => void;
     /** Called as the export moves, for a caller that shows it is running. */
     onProgress?: (progress: ExportPngProgress) => void;
 };
 /**
- * A png of everything the document draws, at the zoom it is being read at. The
- * scene is drawn again from the document rather than read off the screen, so
- * the image holds the whole document however far it was scrolled away.
+ * A png of everything the document draws, at 100% whatever zoom it is being
+ * read at. The scene is drawn again from the document rather than read off the
+ * screen, so the image holds the whole document however far it was scrolled away.
  *
  * @example
  * const blob = await createDocumentPng({ doc: toJson(store.state), theme, toWidth });
  */
-export declare function createDocumentPng({ doc, theme, toWidth, pixelRatio, zoomLevel, onResolutionReduced, onProgress, }: DocumentPngOptions): Promise<Blob>;
+export declare function createDocumentPng({ doc, theme, toWidth, pixelRatio, i18n, onResolutionReduced, onProgress, }: DocumentPngOptions): Promise<Blob>;
+export type DocumentPreviewOptions = Pick<DocumentPngOptions, 'doc' | 'theme' | 'toWidth' | 'i18n'> & {
+    /** The longest side the preview may take, in pixels. */
+    maxSide: number;
+};
+/** A small png of the export, and the box the export itself is measured by. */
+export type DocumentPreview = {
+    blob: Blob;
+    width: number;
+    height: number;
+    /** The box the export holds, in scene units, margin included. */
+    documentWidth: number;
+    documentHeight: number;
+};
+/**
+ * The export drawn small, for a dialog to show before any file is written. It
+ * takes the same path as the export, worker first, so the picture is the one
+ * the file will hold, its scale capped at the side it is given.
+ *
+ * @example
+ * const preview = await createDocumentPreview({ doc, theme, toWidth, maxSide: 1280 });
+ */
+export declare function createDocumentPreview({ doc, theme, toWidth, maxSide, i18n, }: DocumentPreviewOptions): Promise<DocumentPreview>;
+export type DocumentSvgOptions = Pick<DocumentPngOptions, 'doc' | 'theme' | 'toWidth' | 'i18n'>;
+/**
+ * An svg of everything the document draws, at 100% as the png is. It takes
+ * the png's path, worker first, and leaves the scale out, since a vector is
+ * sized by the box alone and holds no canvas ceiling to cut it.
+ *
+ * @example
+ * const svg = await createDocumentSvg({ doc, theme, toWidth });
+ */
+export declare function createDocumentSvg({ doc, theme, toWidth, i18n, }: DocumentSvgOptions): Promise<string>;
 //# sourceMappingURL=index.d.ts.map

package/dist/services/export-png/renderPng.d.ts

@@ -1,24 +1,32 @@
+import { LocaleMessages } from '../../i18n/translate';
 import { Theme } from '../../themes/tokens';
+import { ExportSize } from './exportBox';
 import { ToWidth } from './textWidth';
-/** The box that was asked for and the raster that fitted inside a canvas. */
-export type ResolutionReduction = {
-    documentWidth: number;
-    documentHeight: number;
-    width: number;
-    height: number;
-};
+/**
+ * The raster the scale asked for and the one that fitted inside a canvas, in
+ * the very fields the export dialog reads its warning from.
+ */
+export type ResolutionReduction = Omit<ExportSize, 'reduced'>;
 /** Everything a png needs that survives a structured clone to another realm. */
 export type RenderPngRequest = {
     doc: string;
     theme: Theme;
     pixelRatio: number;
-    /** The zoom to draw at; the document's own when the caller names none. */
-    zoomLevel?: number;
+    /**
+     * The longest side the drawn box may take, in pixels, for an image that only
+     * previews an export. Left out, the box is drawn at the export's zoom.
+     */
+    maxSide?: number;
+    /** The language the scene's own words are drawn in; English when left out. */
+    i18n?: LocaleMessages;
 };
 export type RenderPngResult = {
     blob: Blob;
     width: number;
     height: number;
+    /** The box the image holds, in scene units, margin included. */
+    documentWidth: number;
+    documentHeight: number;
     /**
      * Null when the box kept every pixel it was written with. A realm that drew
      * the image is the only one that knows this, so it is carried back rather
@@ -34,7 +42,7 @@ export type RenderPngResult = {
  * @example
  * const { blob } = await renderDocumentPng({ doc, theme, pixelRatio: 1, toWidth });
  */
-export declare function renderDocumentPng({ doc, theme, pixelRatio, zoomLevel, toWidth, }: RenderPngRequest & {
+export declare function renderDocumentPng({ doc, theme, pixelRatio, maxSide, i18n, toWidth, }: RenderPngRequest & {
     toWidth: ToWidth;
 }): Promise<RenderPngResult>;
 //# sourceMappingURL=renderPng.d.ts.map

package/dist/services/export-png/renderSvg.d.ts

@@ -0,0 +1,22 @@
+import { LocaleMessages } from '../../i18n/translate';
+import { Theme } from '../../themes/tokens';
+import { ToWidth } from './textWidth';
+/** Everything an svg needs that survives a structured clone to another realm. */
+export type RenderSvgRequest = {
+    doc: string;
+    theme: Theme;
+    /** The language the scene's own words are drawn in; English when left out. */
+    i18n?: LocaleMessages;
+};
+/**
+ * The whole document as an svg, at the export's zoom and with no scale, since
+ * a vector has no pixels to multiply. It draws the scene the png draws, in
+ * whichever realm calls it, and reads the svg off that scene's nodes.
+ *
+ * @example
+ * const svg = await renderDocumentSvg({ doc, theme, toWidth });
+ */
+export declare function renderDocumentSvg({ doc, theme, i18n, toWidth, }: RenderSvgRequest & {
+    toWidth: ToWidth;
+}): Promise<string>;
+//# sourceMappingURL=renderSvg.d.ts.map

package/dist/services/export-png/sceneSvg.d.ts

@@ -0,0 +1,54 @@
+import { Stage } from 'konva/lib/Stage';
+import { Rect } from '../../konva/scene/metrics';
+/** The seven node kinds the scene is built of, by the class name konva gives each. */
+export declare const SVG_NODE_KINDS: readonly ["Layer", "Group", "Rect", "Text", "Path", "Line", "Circle"];
+export type SvgNodeKind = (typeof SVG_NODE_KINDS)[number];
+/**
+ * What the writer reads off each kind. A layer is placed past the box mapped
+ * onto the Stage, which the viewBox maps instead, and a text is written in the
+ * lines konva wrapped and cut it to.
+ */
+export declare const SVG_WRITTEN_ATTRIBUTES: Record<SvgNodeKind, readonly string[]>;
+/**
+ * What the writer leaves out on purpose: names and the editor's bookkeeping,
+ * what only the hit canvas reads, and the shadows an exported svg draws none of.
+ */
+export declare const SVG_SKIPPED_ATTRIBUTES: readonly string[];
+export type SceneSvgOptions = {
+    /**
+     * What the image holds, in scene units, which the viewBox is and, an export
+     * being drawn at 100%, its width and height too.
+     */
+    box: Rect;
+    /** The factor the layers place that box onto the Stage by. */
+    scale: number;
+};
+/**
+ * A colour as the file writes it: an opaque colour, and the alpha it carried
+ * apart from it, rounded to the digits an opacity is written in.
+ */
+export type Paint = {
+    color: string;
+    opacity: number;
+};
+/**
+ * Whether a colour paints anything at all, and how. A hit box answers the
+ * pointer with a transparent fill, which the svg has no pointer to answer, so
+ * it is left out, as is a colour whose alpha rounds to none.
+ *
+ * @example
+ * toPaint('transparent'); // null
+ * toPaint('#00071b7f'); // { color: '#00071b', opacity: 0.498 }
+ */
+export declare function toPaint(color: unknown): Paint | null;
+/**
+ * The scene on a Stage as one svg document, walked node by node, so it runs
+ * wherever the Stage was drawn, a worker included. The fonts are named, never
+ * embedded, and the shadows are left out, as the export dialog promises.
+ *
+ * @example
+ * const { stage, box, scale } = scene;
+ * const svg = toSceneSvg(stage, { box, scale });
+ */
+export declare function toSceneSvg(stage: Stage, options: SceneSvgOptions): string;
+//# sourceMappingURL=sceneSvg.d.ts.map

package/dist/services/shiki/graphqlGrammar.d.ts

@@ -0,0 +1,8 @@
+import { LanguageRegistration } from 'shiki/core';
+/**
+ * Shiki's GraphQL grammar without its embeddedLangs, the JavaScript, TypeScript,
+ * JSX and TSX of a GraphQL string inside a script, which no generated schema
+ * holds: they took the inlined shiki worker past Chromium's 2 MiB url limit.
+ */
+export declare const graphqlGrammar: LanguageRegistration;
+//# sourceMappingURL=graphqlGrammar.d.ts.map