merpeeps-pack-flowchart 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Merpeeps contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,62 @@
1
+ # merpeeps-pack-flowchart
2
+
3
+ The Merpeeps Flowchart stencil pack, distributed as **YAML data only**.
4
+ Includes ten stencils for processes, decisions, terminals, subprocesses,
5
+ data stores, connectors, preparation, input/output, manual operations, and
6
+ rounded steps.
7
+
8
+ ## Install and read
9
+
10
+ ```bash
11
+ npm install merpeeps-pack-flowchart
12
+ ```
13
+
14
+ From a Node.js ES module:
15
+
16
+ ```js
17
+ import { readFileSync } from 'node:fs';
18
+ import { createRequire } from 'node:module';
19
+
20
+ const require = createRequire(import.meta.url);
21
+ const yaml = readFileSync(require.resolve('merpeeps-pack-flowchart'), 'utf8');
22
+ ```
23
+
24
+ The explicit data path `merpeeps-pack-flowchart/flowchart.merpeeps-pack.yml`
25
+ resolves to the same file. Pass the text to your host application's YAML
26
+ parser and compatible Merpeeps pack loader. This package does not include a
27
+ parser or runtime dependencies. Do not import or require the YAML directly as
28
+ JavaScript; `require.resolve` locates the data without executing it.
29
+
30
+ ## Contents and scope
31
+
32
+ The tarball contains only:
33
+
34
+ - `flowchart.merpeeps-pack.yml`
35
+ - `LICENSE`
36
+ - `README.md`
37
+ - `package.json`
38
+
39
+ The YAML defines stencil labels, text, shapes, and hints. This pack leaves
40
+ colours to the host defaults and declares no icons or custom icon geometry.
41
+ It includes no new artwork. Your host supplies shape rendering; this package
42
+ supplies neither a renderer nor glyph implementations.
43
+
44
+ Installing with npm only makes the data available to your project. It does
45
+ not automatically install anything into the Merpeeps desktop app or register
46
+ a Mermaid plugin. The desktop already embeds this same default pack.
47
+ The separate `merpeeps-mermaid-layout` package provides layout functionality,
48
+ not an automatic installation mechanism for this pack.
49
+
50
+ ## Source and publishing
51
+
52
+ The canonical source is
53
+ [`src/Merpeeps.Core/Packs/flowchart.merpeeps-pack.yml`](https://github.com/sargemonkey/merpeeps/blob/main/src/Merpeeps.Core/Packs/flowchart.merpeeps-pack.yml).
54
+ From the repository, `npm pack` and `npm publish` run `prepack` to copy that
55
+ file and the root MIT license into this package. Edit the canonical YAML, not
56
+ the generated package copy. Installing the resulting tarball needs no
57
+ repository checkout, build, or install lifecycle script.
58
+
59
+ See the [pack usage guide](https://github.com/sargemonkey/merpeeps/blob/main/docs/GUIDE.md#stencil-packs)
60
+ and the [manual publishing checklist](https://github.com/sargemonkey/merpeeps/blob/main/docs/PUBLISHING.md).
61
+
62
+ MIT licensed — see [LICENSE](./LICENSE).
@@ -0,0 +1,57 @@
1
+ id: flowchart
2
+ name: Flowchart
3
+ spec: 1
4
+ licence: MIT
5
+
6
+ # Plain mermaid flowchart shapes, named for what they mean rather than what they
7
+ # look like — the reason to pick a rhombus is that it is a decision.
8
+ stencils:
9
+ - label: Process
10
+ text: Process
11
+ shape: Rectangle
12
+ hint: A step that does something
13
+
14
+ - label: Decision
15
+ text: Decision?
16
+ shape: Rhombus
17
+ hint: A branch — label the edges yes/no
18
+
19
+ - label: Terminal
20
+ text: Start
21
+ shape: Stadium
22
+ hint: Where a flow begins or ends
23
+
24
+ - label: Subprocess
25
+ text: Subprocess
26
+ shape: Subroutine
27
+ hint: A step defined elsewhere
28
+
29
+ - label: Data store
30
+ text: Store
31
+ shape: Cylinder
32
+ hint: A database or persistent store
33
+
34
+ - label: Connector
35
+ text: A
36
+ shape: Circle
37
+ hint: Joins flows across a page break
38
+
39
+ - label: Preparation
40
+ text: Prepare
41
+ shape: Hexagon
42
+ hint: Setup or initialisation
43
+
44
+ - label: Input / output
45
+ text: Input
46
+ shape: Parallelogram
47
+ hint: Data entering or leaving
48
+
49
+ - label: Manual operation
50
+ text: Manual step
51
+ shape: Trapezoid
52
+ hint: A step a person performs
53
+
54
+ - label: Rounded
55
+ text: Step
56
+ shape: RoundedRect
57
+ hint: A softer process box
package/package.json ADDED
@@ -0,0 +1,46 @@
1
+ {
2
+ "name": "merpeeps-pack-flowchart",
3
+ "version": "0.1.0",
4
+ "description": "Data-only Merpeeps flowchart stencil pack for processes, decisions, terminals, and other standard flow shapes.",
5
+ "keywords": [
6
+ "merpeeps",
7
+ "mermaid",
8
+ "flowchart",
9
+ "process",
10
+ "diagram",
11
+ "stencils",
12
+ "yaml",
13
+ "data-only"
14
+ ],
15
+ "license": "MIT",
16
+ "author": "Merpeeps contributors",
17
+ "repository": {
18
+ "type": "git",
19
+ "url": "git+https://github.com/sargemonkey/merpeeps.git",
20
+ "directory": "packages/merpeeps-pack-flowchart"
21
+ },
22
+ "homepage": "https://github.com/sargemonkey/merpeeps/blob/main/docs/GUIDE.md#stencil-packs",
23
+ "bugs": {
24
+ "url": "https://github.com/sargemonkey/merpeeps/issues"
25
+ },
26
+ "main": "./flowchart.merpeeps-pack.yml",
27
+ "exports": {
28
+ ".": "./flowchart.merpeeps-pack.yml",
29
+ "./flowchart.merpeeps-pack.yml": "./flowchart.merpeeps-pack.yml"
30
+ },
31
+ "files": [
32
+ "flowchart.merpeeps-pack.yml",
33
+ "LICENSE",
34
+ "README.md",
35
+ "package.json"
36
+ ],
37
+ "scripts": {
38
+ "prepack": "node ../../scripts/prepare-domain-pack.mjs flowchart",
39
+ "release:check": "node ../../oracle/package-consumer-test.mjs merpeeps-pack-flowchart",
40
+ "prepublishOnly": "npm run release:check"
41
+ },
42
+ "publishConfig": {
43
+ "access": "public",
44
+ "registry": "https://registry.npmjs.org/"
45
+ }
46
+ }