@formicoidea/labre-framework-wardley 0.61.0 → 1.1.0

package/dist/renderer-json-import.d.ts

@@ -0,0 +1,71 @@
+import type { InterchangeImportContext, InterchangeImportResult } from '@formicoidea/labre-core/interchange';
+/**
+ * The renderer JSON reader's remarks whose wording is FIXED, as
+ * `[key, English]` pairs — the shape and the reason of
+ * `WARDLEY_OWM_IMPORT_REMARKS`: a reader has no `std`, so it hands the key
+ * over and `reportInterchangeImport` resolves it. Contributed to the
+ * manifest by `./translations.ts`.
+ */
+export declare const WARDLEY_JSON_IMPORT_REMARKS: {
+    readonly notJson: readonly ["com.labre.wardley.import.json.remark.not-json", "This file is not JSON, so nothing was read from it."];
+    readonly notAMap: readonly ["com.labre.wardley.import.json.remark.not-a-map", "This JSON is not a wardley-map-renderer map: it has no `components` list, so nothing was read from it."];
+    readonly invalidComponent: readonly ["com.labre.wardley.import.json.remark.invalid-component", "this component lacks an id, a name, a type or a numeric position, so it was not imported."];
+    readonly invalidRelation: readonly ["com.labre.wardley.import.json.remark.invalid-relation", "a relation lacks its consumer or its supplier, so it was not imported."];
+    readonly undeclaredEnd: readonly ["com.labre.wardley.import.json.remark.undeclared-end", "a relation names this, and no component of the file has this id, so the relation was not imported."];
+    readonly duplicateId: readonly ["com.labre.wardley.import.json.remark.duplicate-id", "this id is used by more than one component. Both are on the map, and every relation naming it means the first."];
+    readonly invalidEvolution: readonly ["com.labre.wardley.import.json.remark.invalid-evolution", "an evolution of this component has no numeric target position, so it was not imported."];
+    readonly outOfRange: readonly ["com.labre.wardley.import.json.remark.out-of-range", "its position falls outside 0…1, so it is drawn off the map’s plot."];
+    readonly noGeometry: readonly ["com.labre.wardley.import.json.remark.no-geometry", "this pipeline has no usable `pipelineGeometry`, so it was drawn at the toolbar’s size around its position. The file did not say how wide it is."];
+    readonly droppedField: readonly ["com.labre.wardley.import.json.remark.dropped-field", "{{count}} `{{kind}}` field(s) have nothing on this canvas to show them, so they were not imported."];
+};
+/**
+ * A `@formicoidea/wardley-map-renderer` JSON map, read as a Wardley map made
+ * of what a user places from the TOOLBAR (ADR 0012 P3, ADR 0045, PO decisions
+ * of 2026-10-28).
+ *
+ * ## Only what shows, made of the toolbar's own artefacts
+ *
+ * The OWM path the connector used drew a second component at the target of
+ * every evolution, a pipeline's name twice with its square centred, and lost
+ * the source's squares and colours (the connector's bench). Here every
+ * Wardley element is a `WARDLEY_TOOLBOX` builder's, given its real
+ * parameters; what the toolbox has no item for is a plain shape or a free
+ * text, grouped with the component it belongs to; and what nothing can show
+ * is dropped and named in the report. No id and no field of the file is
+ * stored on any element.
+ *
+ * ## The mapping
+ *
+ * | renderer field                                   | on the canvas                                                                 |
+ * | ------------------------------------------------ | ----------------------------------------------------------------------------- |
+ * | `type` anchor / component / pipeline; `subtype` market / ecosystem; a `method` | the toolbox anchor, component, pipeline, market, ecosystem, method item |
+ * | `subtype` userNeed / solution / supplier / functional | a plain component (the subtype has no look)                              |
+ * | `label.name` / `label.position`                  | the toolbox name, moved by the offset (`jsonLabelBox`)                        |
+ * | `position.*.scalar`                              | the node's centre on the plot (visibility 0 is the TOP)                       |
+ * | `position.evolution.range`                       | a thin plain rect at the node's height, under it, in its group               |
+ * | `nature` activity / data / practice / knowledge  | the `wardley:nature` tag; the other five are dropped                          |
+ * | `description`                                    | a free text under the name, in the component's group                         |
+ * | `color`                                          | the node's stroke (an unknown name paints black, as in the renderer)         |
+ * | `method` (category, recommendation)              | the method item and its `wardley:method` tag; a pair naming none of the nine leaves it untagged (it paints as Make) |
+ * | `accelerator` / `deaccelerator`                  | the toolbox climate arrow beside the node, where the renderer draws it      |
+ * | `step`                                           | a numbered plain dot at the node's upper left, in its group                  |
+ * | `evolvesTo[].position` / `evolveType` / `inertia` | the toolbox change arrow to that point, `evolveType` as its label, an inertia item on each phase line it crosses (at its middle when it crosses none) |
+ * | `pipelineGeometry`                               | the pipeline's body stretched to the box, its handle at `handleEvolution`    |
+ * | `relations[]` and their `type`, `flow`           | the toolbox dependency link, consumer first; Flow blue and thicker, Constraint black and as thick; `flow.label` its text, `flow.style` its dash or double width |
+ * | `title` / `context`                              | free texts above / under the map                                              |
+ * | `renderConfig` axis and phase labels and toggles | the map's own fields                                                          |
+ * | `id`s, component `inertia`, a pipeline's `position`, subtype / nature on a pipeline, the rest of `renderConfig`, unknown fields | **dropped**, named in the report |
+ *
+ * ## An evolution is an arrow to a point, never a twin
+ *
+ * The toolbar's Arrow tool, dragged from a component and dropped on the empty
+ * map, leaves the change-arrow connector with a free end
+ * (`ConnectorTool.dragEnd` keeps `target: { position }`), and the renderer
+ * draws an evolution as an arrow and no second node. So it is that.
+ *
+ * ## A bad document is a report
+ *
+ * Text that is not JSON, or JSON with no `components` list, imports nothing
+ * and the report says why; the reader never throws.
+ */
+export declare function importWardleyRendererJson(source: string, _context?: InterchangeImportContext): InterchangeImportResult;