@hexpro/qr-code-studio 0.0.0-stage → 0.1.0

package/dist/design/types.js

@@ -0,0 +1,29 @@
+/**
+ * The public shape of the design layer, as docs/CONTRACTS.md (`design`) gives
+ * it.
+ *
+ * Additions to the contract, each optional so an entry written to the
+ * contract alone still works, and each listed in the branch report:
+ *
+ * - `ModuleShape.fillsCell`. A classic code is one clean outline only if the
+ *   builder knows a shape is the whole cell, and asking the shape is the one
+ *   way that stays true for a third party's square.
+ * - `FillEntry.space`. A palette scattered over modules is resolved once per
+ *   module, a diagonal split once over the symbol; the resolver cannot tell
+ *   which from the signature.
+ * - `BuildContext.overlay`, and `applyConstraints` returning the overlay
+ *   beside the design. What a content type prints over every code of its
+ *   kind (the Swiss QR-bill's cross) belongs to the content, not to a design
+ *   a person can reuse on any code and share as a link, so it never enters
+ *   the design document; the constraints name it and the caller hands it to
+ *   `buildScene`.
+ * - `QrDesignV1.output.sizeBasis`: whether `sizeMm` is the whole artwork's
+ *   width or the symbol's own. Optional within version 1, so every version 1
+ *   document stays valid and means what it meant.
+ * - `validateDesign(input, registries, { fonts })`: the registry a caption's
+ *   font is checked against, as `BuildContext.fonts` is for the scene.
+ * - `DesignConstraints` repeats `PayloadConstraints`, because this layer may
+ *   not import the payload layer. The two are structurally the same type.
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/design/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/design/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG"}

package/dist/design/validate.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Checking a design document.
+ *
+ * A design arrives from a file, a link or a form, so the checker assumes
+ * nothing about its shape and reports every problem it finds, each with the
+ * exact path to it and a message key, and never the offending value: a
+ * design's colours are harmless, but its name and caption are text a person
+ * typed, and an issue is the thing that gets pasted into a bug report.
+ *
+ * Problems with one obvious fix are fixed and reported as warnings, and the
+ * fixed design is returned:
+ *
+ * - keys the schema does not know are dropped (an entry's unknown parameters
+ *   too);
+ * - `light`, `logo`, a logo's `plate`, `frame` and `regions` left out mean
+ *   none, `output` and its colour space left out mean screen colour, and a
+ *   gradient's `space` left out means the symbol's;
+ * - an angle outside 0 to 360 is brought round into it;
+ * - a paint on a picture logo, which only icons take, is dropped, as is a
+ *   caption on a frame that has nowhere to put one;
+ * - embedded images nothing uses are dropped.
+ *
+ * A caption in a font the font registry does not hold is a warning and is
+ * kept as it is: the website registers a person's own fonts at runtime, so a
+ * design made there may name one that this registry has not been given yet,
+ * and the scene builder leaves such a caption out rather than set it in
+ * another font.
+ *
+ * Anything else is an error and the design comes back null. Region pairs
+ * that would not make a finder the strict reader finds are a warning: the
+ * design is valid, and the studio uses the warning to steer the choice.
+ */
+import type { Issue } from '../core/issue.js';
+import type { FontRegistry } from '../text/types.js';
+import type { DesignRegistries, QrDesignV1 } from './types.js';
+/**
+ * Every problem at once. `design` is the input made valid where that is
+ * unambiguous, or null. `options.fonts` is where a caption's font is looked
+ * up, the built-in family by default: a contract addition, as for
+ * `buildScene`'s context.
+ */
+export declare function validateDesign(input: unknown, registries: DesignRegistries, options?: {
+    readonly fonts?: FontRegistry;
+}): {
+    readonly design: QrDesignV1 | null;
+    readonly issues: readonly Issue[];
+};
+//# sourceMappingURL=validate.d.ts.map

package/dist/design/validate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../src/design/validate.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAGH,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAK9C,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,kBAAkB,CAAC;AAMrD,OAAO,KAAK,EAKX,gBAAgB,EAOhB,UAAU,EAIV,MAAM,YAAY,CAAC;AAwxBpB;;;;;GAKG;AACH,wBAAgB,cAAc,CAC7B,KAAK,EAAE,OAAO,EACd,UAAU,EAAE,gBAAgB,EAC5B,OAAO,GAAE;IAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,YAAY,CAAA;CAAO,GAC7C;IAAE,QAAQ,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,SAAS,KAAK,EAAE,CAAA;CAAE,CAkL3E"}