postext 1.33.11 → 1.34.0

package/dist/composed/templates.d.ts

@@ -0,0 +1,133 @@
+import type { Dimension, ElementPlacement } from '../types';
+import type { FrameConfig, FrameSize, LabelStyle, PageTemplate, PageTemplateGrid, ResolvedFrame, ResolvedFrameFit, ResolvedLabelStyle, ResolvedPageTemplate, ResolvePageTemplateOptions } from './types';
+export declare const DEFAULT_FRAME_FIT: Readonly<ResolvedFrameFit>;
+/** What a frame that sets nothing comes to (besides its name). */
+export declare const DEFAULT_FRAME: {
+    width: FrameSize;
+    height: FrameSize;
+    layer: number;
+    rotate: number;
+    verticalAlign: "top";
+    columns: number;
+    exclude: "none";
+    flow: boolean;
+    pin: boolean;
+    grow: number;
+    shrink: number;
+    priority: number;
+    optional: boolean;
+    crossGutter: boolean;
+};
+export declare const DEFAULT_FRAME_GROUP: {
+    kind: "stack";
+    gap: Dimension;
+    align: "start";
+};
+export declare const DEFAULT_PAGE_TEMPLATE: {
+    area: "content";
+    spread: boolean;
+    gutter: Dimension;
+    role: string;
+};
+export declare const DEFAULT_LABEL_STYLE: {
+    fontStyle: "normal";
+    textTransform: "none";
+    minScale: number;
+};
+export declare const FRAME_VERTICAL_ALIGNS: readonly ["top", "middle", "bottom", "justify"];
+export declare const FRAME_EXCLUDES: readonly ["none", "push"];
+export declare const FRAME_TAKES: readonly ["h1", "h2", "h3", "h4", "h5", "h6"];
+export declare const FRAME_GROUP_KINDS: readonly ["stack", "row"];
+export declare const FRAME_GROUP_ALIGNS: readonly ["start", "center", "end", "space-between"];
+export declare const TEMPLATE_AREAS: readonly ["content", "trim", "bleed"];
+export declare const FRAME_WRITING_MODES: readonly ["horizontal-tb", "vertical-rl"];
+export declare const FRAME_DIRECTIONS: readonly ["ltr", "rtl"];
+export declare const LABEL_FONT_STYLES: readonly ["normal", "italic"];
+export declare const LABEL_TEXT_TRANSFORMS: readonly ["none", "uppercase"];
+/** A length the engine can use: a finite, non-negative value in a known
+ *  unit. */
+export declare function isFrameDimension(v: unknown): v is Dimension;
+/** `v` as a frame size, or undefined when it is none. A percentage is
+ *  clamped to 0 … 100. */
+export declare function normalizeFrameSize(v: unknown): FrameSize | undefined;
+/** The id an anchor names (`'#dinero'` → `'dinero'`), or undefined. */
+export declare function anchorTarget(placement: ElementPlacement | undefined): string | undefined;
+/** The frame a `continueIn` of the form `'#frame'` names. */
+export declare function continueInFrame(continueIn: unknown): string | undefined;
+/** The template a `continueIn` of the form `'template:<id>'` names. */
+export declare function continueInTemplate(continueIn: unknown): string | undefined;
+/** The chain of template indices from `index` up to its root, nearest
+ *  first; `null` when it loops back on itself. A parent that does not
+ *  exist ends the chain (the template stands alone). */
+export declare function templateChain(templates: readonly PageTemplate[], index: number, byId?: Map<string, number>): number[] | null;
+/** The index of the template `id` means: the first with that id. */
+export declare function templateIndex(templates: readonly PageTemplate[] | undefined, id: string): number | undefined;
+/** A problem resolution met, with the JSON pointer of the field at fault.
+ *  `validatePageTemplates` reports them as config warnings. */
+export interface TemplateIssue {
+    kind: 'frameDuplicate' | 'frameStyleUnknown' | 'frameAnchorUnknown' | 'groupFrameUnknown' | 'groupFrameTwice' | 'frameChainLoop' | 'overflowTargetUnknown';
+    path: string;
+    value: string;
+    used: string;
+    /** For a name that does not exist: the closest that does (filled by the
+     *  validator). */
+    known?: readonly string[];
+}
+/** A frame as the layout reads it: every default filled in, sizes read
+ *  from `width`/`height` and else `placement.size`, values the engine
+ *  cannot use replaced by their default. */
+export declare function normalizeFrame(frame: FrameConfig, grid?: Required<PageTemplateGrid>, where?: {
+    configPath: string;
+    fieldPaths: Record<string, string>;
+}): ResolvedFrame;
+/** What `resolvePageTemplate` reads of a configuration: the raw or the
+ *  resolved one alike. */
+export interface PageTemplateSource {
+    pageTemplates?: readonly PageTemplate[];
+    /** The callout style ids frames may name. Unset: not checked. */
+    calloutStyles?: readonly {
+        id: string;
+    }[];
+}
+/**
+ * Resolve the template at `index` of `templates` (see
+ * {@link resolvePageTemplate}), with the issues met on the way. `prefix`
+ * is the JSON pointer of the list (`/pageTemplates`).
+ * @internal the validator's; hosts call `resolvePageTemplate`.
+ */
+export declare function resolveTemplateAt(templates: readonly PageTemplate[], index: number, options?: ResolvePageTemplateOptions & {
+    calloutStyleIds?: ReadonlySet<string>;
+    prefix?: string;
+}): {
+    template: ResolvedPageTemplate;
+    issues: TemplateIssue[];
+} | undefined;
+/**
+ * The template `id` of `config.pageTemplates`, ready to lay out: its
+ * `extends` chain merged (scalar fields replace, `grid` merges key by key,
+ * frames and groups merge by `name` with `remove: true` dropping one,
+ * decoration elements merge by `id`), then the variant of the page's side
+ * (`options.parity`; none on a spread), then every default filled in and
+ * every reference settled (see `validatePageTemplates` for what is fixed
+ * and reported). Undefined when no template has that id, or its chain
+ * loops. The first template with an id is the one it means.
+ *
+ * Memoised per `pageTemplates` array (the resolved configuration holds a
+ * copy of its own): treat the result as read-only, and give a changed list
+ * as a new array.
+ */
+export declare function resolvePageTemplate(config: PageTemplateSource | undefined, id: string, options?: ResolvePageTemplateOptions): ResolvedPageTemplate | undefined;
+/** The label styles with their defaults filled in. */
+export declare function resolveLabelStyles(styles: readonly LabelStyle[] | undefined): ResolvedLabelStyle[];
+/**
+ * The page templates as stored. Every field is kept as written, a value
+ * equal to its default included: in a template that `extends` another, or
+ * in a variant, it overrides the parent's, so it is never a restated
+ * default. Keys set to `undefined` are left out, and an empty list is no
+ * list.
+ */
+export declare function stripPageTemplatesDefaults(templates: readonly PageTemplate[] | undefined): PageTemplate[] | undefined;
+/** The label styles without the values that restate a default (and `name`
+ *  equal to `id`); an empty list is no list. */
+export declare function stripLabelStylesDefaults(styles: readonly LabelStyle[] | undefined): LabelStyle[] | undefined;
+//# sourceMappingURL=templates.d.ts.map

package/dist/composed/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/composed/templates.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAA6B,SAAS,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AACvF,OAAO,KAAK,EACV,WAAW,EAIX,SAAS,EACT,UAAU,EAEV,YAAY,EACZ,gBAAgB,EAEhB,aAAa,EACb,gBAAgB,EAEhB,kBAAkB,EAClB,oBAAoB,EACpB,0BAA0B,EAC3B,MAAM,SAAS,CAAC;AAQjB,eAAO,MAAM,iBAAiB,EAAE,QAAQ,CAAC,gBAAgB,CAKxD,CAAC;AAEF,kEAAkE;AAClE,eAAO,MAAM,aAAa;WACP,SAAS;YACR,SAAS;;;;;;;;;;;;;CAa5B,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;CAI/B,CAAC;AAEF,eAAO,MAAM,qBAAqB;;;;;CAKjC,CAAC;AAEF,eAAO,MAAM,mBAAmB;;;;CAI/B,CAAC;AAEF,eAAO,MAAM,qBAAqB,iDAAkD,CAAC;AACrF,eAAO,MAAM,cAAc,2BAA4B,CAAC;AACxD,eAAO,MAAM,WAAW,+CAAgD,CAAC;AACzE,eAAO,MAAM,iBAAiB,2BAA4B,CAAC;AAC3D,eAAO,MAAM,kBAAkB,sDAAuD,CAAC;AACvF,eAAO,MAAM,cAAc,uCAAwC,CAAC;AACpE,eAAO,MAAM,mBAAmB,2CAA4C,CAAC;AAC7E,eAAO,MAAM,gBAAgB,yBAA0B,CAAC;AACxD,eAAO,MAAM,iBAAiB,+BAAgC,CAAC;AAC/D,eAAO,MAAM,qBAAqB,gCAAiC,CAAC;AAWpE;YACY;AACZ,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,SAAS,CAE3D;AAED;0BAC0B;AAC1B,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,SAAS,CAMpE;AAED,uEAAuE;AACvE,wBAAgB,YAAY,CAAC,SAAS,EAAE,gBAAgB,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,CAGxF;AAED,6DAA6D;AAC7D,wBAAgB,eAAe,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAEvE;AAED,uEAAuE;AACvE,wBAAgB,kBAAkB,CAAC,UAAU,EAAE,OAAO,GAAG,MAAM,GAAG,SAAS,CAE1E;AAeD;;wDAEwD;AACxD,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,sBAAqB,GAAG,MAAM,EAAE,GAAG,IAAI,CAY3H;AAED,oEAAoE;AACpE,wBAAgB,aAAa,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,GAAG,SAAS,EAAE,EAAE,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAE5G;AA2BD;+DAC+D;AAC/D,MAAM,WAAW,aAAa;IAC5B,IAAI,EACA,gBAAgB,GAChB,mBAAmB,GACnB,oBAAoB,GACpB,mBAAmB,GACnB,iBAAiB,GACjB,gBAAgB,GAChB,uBAAuB,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb;sBACkB;IAClB,KAAK,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CAC3B;AAuID;;4CAE4C;AAC5C,wBAAgB,cAAc,CAC5B,KAAK,EAAE,WAAW,EAClB,IAAI,CAAC,EAAE,QAAQ,CAAC,gBAAgB,CAAC,EACjC,KAAK,GAAE;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAuC,GACrG,aAAa,CA6Cf;AAuND;0BAC0B;AAC1B,MAAM,WAAW,kBAAkB;IACjC,aAAa,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IACxC,iEAAiE;IACjE,aAAa,CAAC,EAAE,SAAS;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CAC3C;AAUD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,SAAS,YAAY,EAAE,EAClC,KAAK,EAAE,MAAM,EACb,OAAO,GAAE,0BAA0B,GAAG;IAAE,eAAe,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAO,GACpG;IAAE,QAAQ,EAAE,oBAAoB,CAAC;IAAC,MAAM,EAAE,aAAa,EAAE,CAAA;CAAE,GAAG,SAAS,CA2DzE;AAID;;;;;;;;;;;;;GAaG;AACH,wBAAgB,mBAAmB,CACjC,MAAM,EAAE,kBAAkB,GAAG,SAAS,EACtC,EAAE,EAAE,MAAM,EACV,OAAO,GAAE,0BAA+B,GACvC,oBAAoB,GAAG,SAAS,CAiBlC;AAMD,sDAAsD;AACtD,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,GAAG,kBAAkB,EAAE,CAQlG;AAeD;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,SAAS,YAAY,EAAE,GAAG,SAAS,GAAG,YAAY,EAAE,GAAG,SAAS,CAGrH;AAED;gDACgD;AAChD,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,SAAS,UAAU,EAAE,GAAG,SAAS,GAAG,UAAU,EAAE,GAAG,SAAS,CAU5G"}