tsquare 0.2.0 → 0.3.0

package/README.md

@@ -28,15 +28,29 @@ Requires Node 20 or newer. To work on tsquare itself, clone the repo, run `npm i
 
 ## Playground
 
+Online at [tsquare.dev/playground](https://tsquare.dev/playground), or locally:
+
 ```bash
 npx tsquare playground   # http://localhost:4321
 ```
 
-- **Editor:** live render as you type, problems listed by line (click one to jump there), and SVG/PNG export. Paste a whole model reply and it keeps just the code block.
-- **Components:** every component with its props and a rendered example you can open in the editor. It's generated from the catalog, so it can't drift from what the renderer accepts.
-- **Prompt:** the system prompt for models, with a copy button.
+- **Editor:** syntax highlighting, autocomplete for components, options, props, icons and colors, and problems underlined by line. Paste a whole model reply and it keeps just the code block.
+- **Preview:** renders as you type. Zoom and pan (⌘/Ctrl + scroll or pinch), jump to a single screen, or go full screen.
+- **Links:** copy a share link that reopens the wireframe in the playground, or an image link (SVG, PNG, Markdown, HTML) to embed it anywhere.
+- **Examples** with thumbnails, **light and dark** themes, a resizable split, and SVG/PNG export.
+- **Components:** every component with its props and a rendered example. **Prompt:** the system prompt for models, with a copy button.
+
+The local playground uses the same renderer as the CLI; its links point to tsquare.dev. In this repo, `npm run playground` runs it from source.
+
+## Image links
+
+A wireframe can be embedded anywhere an image works (Notion, GitHub, docs sites) with a link that contains the wireframe itself:
+
+```markdown
+![Login](https://tsquare.dev/svg/zNYwxDsIwEAT7vGJ…)
+```
 
-It runs on a local server with the same renderer as the CLI. In this repo, `npm run playground` runs it from source.
+The playground's **Copy link** menu makes these. The text is compressed into the URL, not encrypted, so anyone with the link can read it; see [privacy](https://tsquare.dev/privacy). `encodeWireframe` and `decodeWireframe` in the library produce and read the same links.
 
 ## The language
 
@@ -51,7 +65,7 @@ One element per line; children are indented two spaces under their parent. The f
 | `tabs items=[All notes, Pinned]` | lists in `[ ]`, items separated by commas; an item can contain spaces |
 | `data=[["$1,200", "Smith, J"]]` | quote an item that contains a comma (`\"` for a quote inside quotes) |
 | `tabbar items=[{label=Home icon=home}]` | objects in `{ }` |
-| `# note to self` | comment |
+| `# note to self` | a comment, on its own line only; elsewhere `#` is text (`[#1001, #1002]`) |
 
 If a bare word could mean two props (for example `start`, which is both an `align` and a `justify` value), write it as `key=value`. Code fences (```` ``` ````) are ignored, so a model's reply can be rendered as-is.
 
@@ -136,7 +150,7 @@ How often models write valid tsquare on the first try, with no repair round:
 
 | | Sonnet | Haiku |
 |---|---|---|
-| Valid on the first try (20 requests) | 100% | 85% |
+| Valid on the first try (20 requests) | 100% | 80% |
 | Median tokens per wireframe (JSON took about 4× as many) | 184 | 210 |
 | Color checks passed (7 requests) | 11/11 | 11/11 |
 

package/dist/catalog.d.ts

@@ -264,7 +264,8 @@ export declare const componentDefinitions: {
                 md: "md";
                 sm: "sm";
             }>>>;
-            icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            leadingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            trailingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             fullWidth: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
         }, z.core.$strip>;
         slots: never[];
@@ -425,7 +426,7 @@ export declare const componentDefinitions: {
                 image: "image";
                 none: "none";
             }>>>;
-            icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            leadingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             trailing: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
                 badge: "badge";
                 chevron: "chevron";
@@ -442,8 +443,7 @@ export declare const componentDefinitions: {
         example: {
             title: string;
             subtitle: string;
-            leading: string;
-            icon: string;
+            leadingIcon: string;
             trailing: string;
         };
     };
@@ -787,7 +787,8 @@ export declare const catalog: import("@json-render/core").Catalog<{
                     md: "md";
                     sm: "sm";
                 }>>>;
-                icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                leadingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                trailingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                 fullWidth: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
             }, z.core.$strip>;
             slots: never[];
@@ -948,7 +949,7 @@ export declare const catalog: import("@json-render/core").Catalog<{
                     image: "image";
                     none: "none";
                 }>>>;
-                icon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                leadingIcon: z.ZodOptional<z.ZodNullable<z.ZodString>>;
                 trailing: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
                     badge: "badge";
                     chevron: "chevron";
@@ -965,8 +966,7 @@ export declare const catalog: import("@json-render/core").Catalog<{
             example: {
                 title: string;
                 subtitle: string;
-                leading: string;
-                icon: string;
+                leadingIcon: string;
                 trailing: string;
             };
         };
@@ -1019,3 +1019,37 @@ export declare const catalog: import("@json-render/core").Catalog<{
     };
 }>;
 export type ComponentName = keyof typeof componentDefinitions;
+/**
+ * A ListItem's effective leading and trailing kinds. Setting the value implies
+ * the kind (leadingIcon → leading=icon, trailingIcon → trailing=icon,
+ * trailingText → trailing=text), so writing only the value still shows it.
+ * The renderer and checkSpec both use this, so they can't disagree.
+ */
+export declare function listItemEnds(p: {
+    leading?: string | null;
+    leadingIcon?: string | null;
+    trailing?: string | null;
+    trailingIcon?: string | null;
+    trailingText?: string | null;
+}): {
+    leading: string | undefined;
+    trailing: string | undefined;
+};
+/**
+ * Props renamed in 0.3.0, still accepted under their old names so existing
+ * wireframes and render URLs keep working. The prompt, docs and autocomplete
+ * only teach the new names, and `tsquare fmt` rewrites the old ones.
+ */
+export declare const RENAMED_PROPS: Record<string, Record<string, string>>;
+/** Rewrites renamed props to their current names, in place. Safe to call more than once. */
+export declare function upgradeRenamedProps(spec: {
+    elements: Record<string, {
+        type: string;
+        props?: Record<string, unknown>;
+    }>;
+}): {
+    elements: Record<string, {
+        type: string;
+        props?: Record<string, unknown>;
+    }>;
+};