wiretext - npm Package Compare versions

Comparing version 0.2.1 to 0.3.1

CONTEXT.md

+# Wiretext CLI — Agent Context
+
+Wiretext generates ASCII/Unicode wireframes from structured JSON. The CLI accepts
+the same schema as the MCP server and the web editor.
+
+## Quick Start
+
+```bash
+# Render a wireframe to stdout
+echo '{ "objects": [{ "type": "box", "label": "Hello" }] }' | wiretext render
+
+# Create an editable URL
+wiretext create layout.json
+
+# Create a permanent short URL (mutating — use --dry-run first)
+wiretext share layout.json --dry-run
+wiretext share layout.json
+```
+
+## Agent Guardrails
+
+1. **Always use `--dry-run` before `share`** — share creates a permanent short URL
+   via a POST to the API. Validate first, then share.
+
+2. **Auto-JSON in pipes** — when stdout is not a TTY (piped), output defaults to
+   structured JSON. No need to pass `--json` explicitly in agent pipelines.
+
+3. **Use `wiretext schema` for input format** — get the full JSON Schema at runtime.
+   Do not hardcode field names from documentation; introspect instead.
+
+4. **Use `wiretext context` for layout rules** — the layout guide contains critical
+   sizing, nesting, and z-index rules. Read it before generating wireframes.
+
+5. **Use `wiretext render` for small previews** — preview with render before creating
+   URLs to catch layout issues early without wasting a short URL slot.
+
+## Output Envelope
+
+All commands return a consistent JSON envelope when in JSON mode:
+
+```jsonc
+// Success (create/share)
+{ "ok": true, "url": "https://wiretext.app/w/abc12345" }
+
+// Success (render)
+{ "ok": true, "ascii": "...", "width": 42, "height": 15, "objectCount": 3 }
+
+// Success (share --dry-run)
+{ "ok": true, "dryRun": true, "valid": true, "objectCount": 3, "encodedBytes": 184 }
+
+// Error
+{ "ok": false, "error": "Invalid input: ...", "code": "ERROR" }
+```
+
+## Input Schema
+
+The input format maps 1:1 to the engine's internal types. Use `wiretext schema`
+to get the full JSON Schema. The short version:
+
+```json
+{
+  "objects": [
+    { "type": "box", "label": "Container", "width": 40, "height": 20, "position": { "col": 0, "row": 0 } },
+    { "type": "text", "content": "Hello", "position": { "col": 5, "row": 3 } },
+    { "type": "component", "componentType": "button", "label": "Submit", "position": { "col": 5, "row": 6 } }
+  ],
+  "layers": [
+    { "id": "ui", "name": "UI Elements" }
+  ]
+}
+```
+
+Object types: `box`, `text`, `line`, `arrow`, `connector`, `component`.
+Component types: `button`, `input`, `select`, `checkbox`, `radio`, `table`, `modal`,
+`browser`, `card`, `navbar`, `tabs`, `progress`, `icon`, `image`, `divider`, `toggle`,
+`alert`, `breadcrumb`, `avatar`, `list`, `stepper`, `rating`, `skeleton`.
+
+## MCP Server
+
+For typed tool invocation without shell escaping, use the MCP server instead:
+
+```bash
+npx @wiretext/mcp
+```
+
+Exposes `create_wireframe` and `render_wireframe` tools with Zod-validated schemas
+over stdio JSON-RPC.

package.json

 {
   "name": "wiretext",
-  "version": "0.2.1",
+  "version": "0.3.1",
   "type": "module",
@@ -9,3 +9,4 @@ "bin": {
   "files": [
-    "dist"
+    "dist",
+    "CONTEXT.md"
   ],
@@ -18,3 +19,3 @@ "dependencies": {
   "devDependencies": {
-    "@types/node": "^22.0.0",
+    "@types/node": "^25.3.5",
     "tsup": "^8.0.0",
@@ -21,0 +22,0 @@ "typescript": "^5.7.0"

New alerts

Long strings

Supply chain risk

Contains long string literals, which may be a sign of obfuscated or packed code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

369702

3.36%

Number of package files

3

50%

Lines of code

1507

7.64%

Worsened metrics

Number of low supply chain risk alerts

3

50%

No dependency changes