@diagrammo/dgmo 0.15.0 → 0.15.1

package/dist/index.d.cts

@@ -1,3 +1,33 @@
+/**
+ * Compact view state schema (ADR-6).
+ * All fields optional. Only non-default values are encoded.
+ * `tag: null` means "user chose none"; absent `tag` means "use DSL default" (ADR-5).
+ */
+interface CompactViewState {
+    tag?: string | null;
+    cs?: number[];
+    cg?: string[];
+    swim?: string | null;
+    cl?: string[];
+    cc?: string[];
+    rm?: string;
+    htv?: Record<string, string[]>;
+    ha?: string[];
+    sem?: boolean;
+    cm?: boolean;
+    c4l?: string;
+    c4s?: string;
+    c4c?: string;
+    rps?: number;
+    spd?: number;
+    io?: Record<string, number>;
+    hd?: boolean;
+    cbd?: boolean;
+    rq?: string;
+    an?: boolean;
+    fl?: boolean;
+}
+
 type DgmoSeverity = 'error' | 'warning';
 interface DgmoError {
     line: number;
@@ -112,6 +142,9 @@ declare const themes: {
     readonly transparent: "transparent";
 };
 
+/** Get palette by id. Returns Nord if id is unrecognized (FR10). */
+declare function getPalette(id: string): PaletteConfig;
+
 /**
  * All built-in palettes, keyed by camelCase id. Use directly with render():
  *
@@ -144,6 +177,12 @@ interface RenderOptions {
      *   'throw'  — throw an Error with the diagnostics
      */
     onError?: 'svg' | 'silent' | 'throw';
+    /**
+     * Pre-applied interactive view state — collapsed sections/columns,
+     * active swimlane tag-group, etc. Used to render a specific view
+     * non-interactively (server-side render, share-link decode).
+     */
+    viewState?: CompactViewState;
 }
 interface RenderResult {
     svg: string;
@@ -170,6 +209,11 @@ interface EncodeDiagramUrlOptions {
     palette?: PaletteConfig;
     theme?: Theme;
     filename?: string;
+    /**
+     * Initial view state to embed in the URL — re-applied when the link is
+     * decoded so recipients open the diagram in the same configuration.
+     */
+    viewState?: CompactViewState;
 }
 /**
  * Encode DGMO text into a shareable URL. Returns null if the compressed
@@ -188,4 +232,4 @@ interface DecodedDiagramUrl {
  */
 declare function decodeDiagramUrl(url: string): DecodedDiagramUrl | null;
 
-export { type DecodedDiagramUrl, type DgmoError, type DgmoSeverity, type EncodeDiagramUrlOptions, type PaletteColors, type PaletteConfig, type RenderOptions, type RenderResult, type Theme, decodeDiagramUrl, encodeDiagramUrl, formatDgmoError, palettes, render, themes, parseDgmo as validate };
+export { type CompactViewState, type DecodedDiagramUrl, type DgmoError, type DgmoSeverity, type EncodeDiagramUrlOptions, type PaletteColors, type PaletteConfig, type RenderOptions, type RenderResult, type Theme, decodeDiagramUrl, encodeDiagramUrl, formatDgmoError, getPalette, palettes, render, themes, parseDgmo as validate };

package/dist/index.d.ts

@@ -1,3 +1,33 @@
+/**
+ * Compact view state schema (ADR-6).
+ * All fields optional. Only non-default values are encoded.
+ * `tag: null` means "user chose none"; absent `tag` means "use DSL default" (ADR-5).
+ */
+interface CompactViewState {
+    tag?: string | null;
+    cs?: number[];
+    cg?: string[];
+    swim?: string | null;
+    cl?: string[];
+    cc?: string[];
+    rm?: string;
+    htv?: Record<string, string[]>;
+    ha?: string[];
+    sem?: boolean;
+    cm?: boolean;
+    c4l?: string;
+    c4s?: string;
+    c4c?: string;
+    rps?: number;
+    spd?: number;
+    io?: Record<string, number>;
+    hd?: boolean;
+    cbd?: boolean;
+    rq?: string;
+    an?: boolean;
+    fl?: boolean;
+}
+
 type DgmoSeverity = 'error' | 'warning';
 interface DgmoError {
     line: number;
@@ -112,6 +142,9 @@ declare const themes: {
     readonly transparent: "transparent";
 };
 
+/** Get palette by id. Returns Nord if id is unrecognized (FR10). */
+declare function getPalette(id: string): PaletteConfig;
+
 /**
  * All built-in palettes, keyed by camelCase id. Use directly with render():
  *
@@ -144,6 +177,12 @@ interface RenderOptions {
      *   'throw'  — throw an Error with the diagnostics
      */
     onError?: 'svg' | 'silent' | 'throw';
+    /**
+     * Pre-applied interactive view state — collapsed sections/columns,
+     * active swimlane tag-group, etc. Used to render a specific view
+     * non-interactively (server-side render, share-link decode).
+     */
+    viewState?: CompactViewState;
 }
 interface RenderResult {
     svg: string;
@@ -170,6 +209,11 @@ interface EncodeDiagramUrlOptions {
     palette?: PaletteConfig;
     theme?: Theme;
     filename?: string;
+    /**
+     * Initial view state to embed in the URL — re-applied when the link is
+     * decoded so recipients open the diagram in the same configuration.
+     */
+    viewState?: CompactViewState;
 }
 /**
  * Encode DGMO text into a shareable URL. Returns null if the compressed
@@ -188,4 +232,4 @@ interface DecodedDiagramUrl {
  */
 declare function decodeDiagramUrl(url: string): DecodedDiagramUrl | null;
 
-export { type DecodedDiagramUrl, type DgmoError, type DgmoSeverity, type EncodeDiagramUrlOptions, type PaletteColors, type PaletteConfig, type RenderOptions, type RenderResult, type Theme, decodeDiagramUrl, encodeDiagramUrl, formatDgmoError, palettes, render, themes, parseDgmo as validate };
+export { type CompactViewState, type DecodedDiagramUrl, type DgmoError, type DgmoSeverity, type EncodeDiagramUrlOptions, type PaletteColors, type PaletteConfig, type RenderOptions, type RenderResult, type Theme, decodeDiagramUrl, encodeDiagramUrl, formatDgmoError, getPalette, palettes, render, themes, parseDgmo as validate };