merpeeps-pack-state 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Merpeeps contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,63 @@
+# merpeeps-pack-state
+
+The Merpeeps State machine stencil pack, distributed as **YAML data only**.
+Includes four stencils: Start, State, Choice, and End, with shape and colour
+defaults for initial markers, ordinary states, guarded branches, and final
+markers.
+
+## Install and read
+
+```bash
+npm install merpeeps-pack-state
+```
+
+From a Node.js ES module:
+
+```js
+import { readFileSync } from 'node:fs';
+import { createRequire } from 'node:module';
+
+const require = createRequire(import.meta.url);
+const yaml = readFileSync(require.resolve('merpeeps-pack-state'), 'utf8');
+```
+
+The explicit data path `merpeeps-pack-state/state.merpeeps-pack.yml` resolves
+to the same file. Pass the text to your host application's YAML parser and
+compatible Merpeeps pack loader. This package does not include a parser or
+runtime dependencies. Do not import or require the YAML directly as
+JavaScript; `require.resolve` locates the data without executing it.
+
+## Contents and scope
+
+The tarball contains only:
+
+- `state.merpeeps-pack.yml`
+- `LICENSE`
+- `README.md`
+- `package.json`
+
+The YAML defines stencil labels, text, shapes, fill and stroke defaults, and
+hints. This pack declares no icons or custom icon geometry and includes no
+new artwork. Your host supplies shape rendering and any mapping to Mermaid
+state syntax; this package supplies neither a renderer nor glyph
+implementations.
+
+Installing with npm only makes the data available to your project. It does
+not automatically install anything into the Merpeeps desktop app or register
+a Mermaid plugin. The desktop already embeds this same default pack.
+The separate `merpeeps-mermaid-layout` package provides layout functionality,
+not an automatic installation mechanism for this pack.
+
+## Source and publishing
+
+The canonical source is
+[`src/Merpeeps.Core/Packs/state.merpeeps-pack.yml`](https://github.com/sargemonkey/merpeeps/blob/main/src/Merpeeps.Core/Packs/state.merpeeps-pack.yml).
+From the repository, `npm pack` and `npm publish` run `prepack` to copy that
+file and the root MIT license into this package. Edit the canonical YAML, not
+the generated package copy. Installing the resulting tarball needs no
+repository checkout, build, or install lifecycle script.
+
+See the [pack usage guide](https://github.com/sargemonkey/merpeeps/blob/main/docs/GUIDE.md#stencil-packs)
+and the [manual publishing checklist](https://github.com/sargemonkey/merpeeps/blob/main/docs/PUBLISHING.md).
+
+MIT licensed — see [LICENSE](./LICENSE).

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "merpeeps-pack-state",
+  "version": "0.1.0",
+  "description": "Data-only Merpeeps state machine stencil pack for start markers, states, choices, and end markers.",
+  "keywords": [
+    "merpeeps",
+    "mermaid",
+    "state-machine",
+    "state-diagram",
+    "diagram",
+    "stencils",
+    "yaml",
+    "data-only"
+  ],
+  "license": "MIT",
+  "author": "Merpeeps contributors",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sargemonkey/merpeeps.git",
+    "directory": "packages/merpeeps-pack-state"
+  },
+  "homepage": "https://github.com/sargemonkey/merpeeps/blob/main/docs/GUIDE.md#stencil-packs",
+  "bugs": {
+    "url": "https://github.com/sargemonkey/merpeeps/issues"
+  },
+  "main": "./state.merpeeps-pack.yml",
+  "exports": {
+    ".": "./state.merpeeps-pack.yml",
+    "./state.merpeeps-pack.yml": "./state.merpeeps-pack.yml"
+  },
+  "files": [
+    "state.merpeeps-pack.yml",
+    "LICENSE",
+    "README.md",
+    "package.json"
+  ],
+  "scripts": {
+    "prepack": "node ../../scripts/prepare-domain-pack.mjs state",
+    "release:check": "node ../../oracle/package-consumer-test.mjs merpeeps-pack-state",
+    "prepublishOnly": "npm run release:check"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/state.merpeeps-pack.yml

@@ -0,0 +1,35 @@
+id: state
+name: State machine
+spec: 1
+licence: MIT
+
+# The start and end markers are drawn as circles here; the state adapter maps
+# them to mermaid's [*].
+stencils:
+  - label: Start
+    text: Start
+    shape: Circle
+    fill: "#F5F5F5"
+    stroke: "#666666"
+    hint: Initial pseudo-state
+
+  - label: State
+    text: Idle
+    shape: RoundedRect
+    fill: "#DAE8FC"
+    stroke: "#6C8EBF"
+    hint: A state the machine rests in
+
+  - label: Choice
+    text: Choice
+    shape: Rhombus
+    fill: "#FFE6CC"
+    stroke: "#D79B00"
+    hint: A guarded branch between states
+
+  - label: End
+    text: End
+    shape: DoubleCircle
+    fill: "#F5F5F5"
+    stroke: "#666666"
+    hint: Final pseudo-state