@tinacms/astro 0.0.1

package/LICENSE

@@ -0,0 +1,176 @@
+                                Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

package/README.md

@@ -0,0 +1,148 @@
+# @tinacms/astro
+
+The one-stop [TinaCMS](https://tina.io) integration for Astro. Ships:
+
+- A vanilla-Astro **rich-text renderer** that mirrors the React `TinaMarkdown` API — same `content` prop, same `components` map shape, but emits pure HTML with no React in the page tree.
+- The framework-agnostic **`@tinacms/bridge`** re-exported under `@tinacms/astro/bridge` so you only install one package.
+
+## Install
+
+```bash
+pnpm add @tinacms/astro
+```
+
+Requires Astro 5.
+
+## Usage
+
+```astro
+---
+import TinaMarkdown from '@tinacms/astro';
+import { tinaField } from '@tinacms/astro/tina-field';
+
+const post = await client.queries.post({ relativePath: 'hello.md' });
+---
+<article>
+  <h1 data-tina-field={tinaField(post.data.post, 'title')}>
+    {post.data.post.title}
+  </h1>
+  <div data-tina-field={tinaField(post.data.post, '_body')}>
+    <TinaMarkdown content={post.data.post._body} />
+  </div>
+</article>
+```
+
+Wire the bridge in your base layout to enable click-to-focus and live preview:
+
+```astro
+<head>
+  <script type="application/tina+json" set:html={JSON.stringify(form)} />
+  <script>
+    import { init } from '@tinacms/astro/bridge';
+    init();
+  </script>
+</head>
+```
+
+## Subpath exports
+
+| Subpath | What it gives you |
+|---------|-------------------|
+| `@tinacms/astro` | `TinaMarkdown` (default) |
+| `@tinacms/astro/types` | `TinaRichTextContent`, `CustomComponentsMap`, `TinaRichTextNode`, `MdxElement`, `TextElement` |
+| `@tinacms/astro/sanitize` | `sanitizeHref` / `sanitizeImageSrc` for CMS-supplied URLs |
+| `@tinacms/astro/bridge` | `init` and the rest of `@tinacms/bridge` |
+| `@tinacms/astro/tina-field` | `tinaField()` helper |
+| `@tinacms/astro/preview` | `readOverlay()` server helper for island refresh endpoints |
+
+## Custom MDX components
+
+Register Astro components against the names Tina uses for them in the editor:
+
+```astro
+---
+import TinaMarkdown from '@tinacms/astro';
+import type { CustomComponentsMap } from '@tinacms/astro/types';
+import BlockQuote from '../components/BlockQuote.astro';
+import NewsletterSignup from '../components/NewsletterSignup.astro';
+
+const components: CustomComponentsMap = {
+  BlockQuote,
+  NewsletterSignup,
+};
+---
+<TinaMarkdown content={post.data.post._body} components={components} />
+```
+
+The renderer dispatches `mdxJsxFlowElement` and `mdxJsxTextElement` nodes by `node.name`. Unknown names render a visible placeholder so you spot missing registrations during development.
+
+## Default-tag overrides
+
+The same `components` map can override the default HTML tag a node renders to. Useful for styling without forking the renderer:
+
+```ts
+const components: CustomComponentsMap = {
+  p: Paragraph,        // Tailwind-styled <p>
+  h1: Heading1,
+  blockquote: BlockquoteTag,
+  code_block: CodeBlock, // e.g. shiki-highlighted
+  a: Anchor,
+  img: Img,
+};
+```
+
+Supported override keys: `p`, `h1`–`h6`, `ul`, `ol`, `li`, `blockquote`, `lic`, `a`, `img`, `code_block`, `hr`, `break`.
+
+## Visual editing markers
+
+The renderer doesn't emit `data-tina-field` attributes — wrap the call site to add them at whatever granularity makes sense:
+
+```astro
+---
+import { tinaField } from '@tinacms/astro/tina-field';
+import TinaMarkdown from '@tinacms/astro';
+---
+<div data-tina-field={tinaField(post.data.post, '_body')}>
+  <TinaMarkdown content={post.data.post._body} components={components} />
+</div>
+```
+
+Coarse-grained boundaries (the whole `_body`) are usually what you want — clicking any rich-text node focuses the editor on that field.
+
+## Supported node types
+
+| Type | Default rendering | Override key |
+|------|-------------------|--------------|
+| `p`, `h1`–`h6` | `<p>`, `<h1>`–`<h6>` | same |
+| `ul`, `ol`, `li` | `<ul>`, `<ol>`, `<li>` | same |
+| `blockquote` | `<blockquote>` | `blockquote` |
+| `lic` | `<div>` | `lic` |
+| `a` | `<a href={sanitized}>` | `a` |
+| `img` | `<img src={sanitized}>` | `img` |
+| `code_block` | `<pre><code class="language-…">` | `code_block` |
+| `hr` | `<hr>` | `hr` |
+| `break` | `<br>` | `break` |
+| `text` (with `bold`/`italic`/`underline`/`strikethrough`/`code`/`highlight`) | nested `<strong>`/`<em>`/`<u>`/`<s>`/`<code>`/`<mark>` | n/a |
+| `mdxJsxFlowElement`, `mdxJsxTextElement` | dispatched by `node.name` | n/a — register by name |
+| `html`, `html_inline` | raw HTML via `set:html` | n/a |
+| `invalid_markdown` | `<pre>{value}</pre>` | n/a |
+
+CMS-supplied URLs in `a` and `img` nodes pass through `sanitizeHref` / `sanitizeImageSrc`, blocking `javascript:`, `data:`, `vbscript:`, and protocol-relative URLs. Both helpers are exposed on `@tinacms/astro/sanitize` for use in your own components (e.g. block-level Hero images, navigation anchors).
+
+## Testing
+
+Tests use Astro 5's [`experimental_AstroContainer`](https://docs.astro.build/en/reference/container-reference/). Fixtures are synced from `@tinacms/mdx`'s parser test corpus so renderer assertions track real editor output.
+
+```bash
+pnpm test
+```
+
+To pull a fresh fixture set after adding a new node type to `@tinacms/mdx`:
+
+```bash
+pnpm sync-fixtures
+```
+
+## License
+
+Apache 2.0

package/dist/bridge.d.ts

@@ -0,0 +1 @@
+export * from "../src/bridge"

package/dist/bridge.js

@@ -0,0 +1 @@
+export * from "@tinacms/bridge";

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from "../src/index"

package/dist/index.js

@@ -0,0 +1,4 @@
+const TinaMarkdown$1 = TinaMarkdown;
+export {
+  TinaMarkdown$1 as default
+};

package/dist/preview.d.ts

@@ -0,0 +1 @@
+export * from "../src/preview"

package/dist/preview.js

@@ -0,0 +1 @@
+export * from "@tinacms/bridge/preview";

package/dist/sanitize.d.ts

@@ -0,0 +1 @@
+export * from "../src/sanitize"

package/dist/sanitize.js

@@ -0,0 +1,45 @@
+function sanitizeHref(value, fallback = "#") {
+  if (typeof value !== "string")
+    return fallback;
+  const trimmed = value.trim();
+  if (!trimmed)
+    return fallback;
+  const lower = trimmed.toLowerCase();
+  if (lower.startsWith("javascript:") || lower.startsWith("data:") || lower.startsWith("vbscript:")) {
+    return fallback;
+  }
+  if (trimmed.startsWith("/") && !trimmed.startsWith("//") || trimmed.startsWith("./") || trimmed.startsWith("../") || trimmed.startsWith("#")) {
+    return trimmed;
+  }
+  try {
+    const url = new URL(trimmed);
+    if (url.protocol === "http:" || url.protocol === "https:" || url.protocol === "mailto:") {
+      return trimmed;
+    }
+  } catch {
+    return fallback;
+  }
+  return fallback;
+}
+function sanitizeImageSrc(src) {
+  if (typeof src !== "string")
+    return "";
+  const trimmed = src.trim();
+  if (!trimmed)
+    return "";
+  if (trimmed.startsWith("./") || trimmed.startsWith("../") || trimmed.startsWith("/") && !trimmed.startsWith("//")) {
+    return trimmed;
+  }
+  try {
+    const url = new URL(trimmed);
+    if (url.protocol === "http:" || url.protocol === "https:")
+      return trimmed;
+  } catch {
+    return "";
+  }
+  return "";
+}
+export {
+  sanitizeHref,
+  sanitizeImageSrc
+};

package/dist/tina-field.d.ts

@@ -0,0 +1 @@
+export * from "../src/tina-field"

package/dist/tina-field.js

@@ -0,0 +1 @@
+export * from "@tinacms/bridge/tina-field";

package/dist/types.d.ts

@@ -0,0 +1 @@
+export * from "../src/types"

package/dist/types.js

@@ -0,0 +1 @@
+

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@tinacms/astro",
+  "version": "0.0.1",
+  "type": "module",
+  "main": "src/TinaMarkdown.astro",
+  "types": "dist/index.d.ts",
+  "files": [
+    "package.json",
+    "README.md",
+    "src/TinaMarkdown.astro",
+    "src/Node.astro",
+    "src/Leaf.astro",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./src/TinaMarkdown.astro"
+    },
+    "./types": {
+      "types": "./dist/types.d.ts",
+      "default": "./dist/types.js"
+    },
+    "./sanitize": {
+      "types": "./dist/sanitize.d.ts",
+      "default": "./dist/sanitize.js"
+    },
+    "./bridge": {
+      "types": "./dist/bridge.d.ts",
+      "default": "./dist/bridge.js"
+    },
+    "./tina-field": {
+      "types": "./dist/tina-field.d.ts",
+      "default": "./dist/tina-field.js"
+    },
+    "./preview": {
+      "types": "./dist/preview.d.ts",
+      "default": "./dist/preview.js"
+    }
+  },
+  "license": "Apache-2.0",
+  "buildConfig": {
+    "entryPoints": [
+      "src/index.ts",
+      "src/types.ts",
+      "src/sanitize.ts",
+      "src/bridge.ts",
+      "src/tina-field.ts",
+      "src/preview.ts"
+    ]
+  },
+  "dependencies": {
+    "@tinacms/bridge": "0.0.1"
+  },
+  "peerDependencies": {
+    "astro": "^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.1",
+    "astro": "^5.16.0",
+    "typescript": "^5.7.3",
+    "vite": "^6.0.0",
+    "vitest": "^3.0.0",
+    "@tinacms/scripts": "1.6.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "repository": {
+    "url": "https://github.com/tinacms/tinacms.git",
+    "directory": "packages/@tinacms/astro"
+  },
+  "scripts": {
+    "types": "tsc",
+    "build": "tinacms-scripts build",
+    "test": "vitest run",
+    "test-watch": "vitest",
+    "sync-fixtures": "node ./scripts/sync-fixtures.mjs"
+  }
+}

package/src/Leaf.astro

@@ -0,0 +1,42 @@
+---
+/**
+ * Recursive text-formatting renderer. Each formatting flag (bold, italic,
+ * underline, strikethrough, code, highlight) wraps the node in its tag and
+ * recurses via `Astro.self` with that flag cleared, so combinations stack
+ * naturally (`<strong><em><code>...</code></em></strong>`).
+ */
+import type { TextElement } from './types';
+
+interface Props {
+  node: TextElement;
+}
+
+const { node } = Astro.props;
+---
+{node.bold ? (
+  <strong>
+    <Astro.self node={{ ...node, bold: false }} />
+  </strong>
+) : node.italic ? (
+  <em>
+    <Astro.self node={{ ...node, italic: false }} />
+  </em>
+) : node.underline ? (
+  <u>
+    <Astro.self node={{ ...node, underline: false }} />
+  </u>
+) : node.strikethrough ? (
+  <s>
+    <Astro.self node={{ ...node, strikethrough: false }} />
+  </s>
+) : node.code ? (
+  <code>
+    <Astro.self node={{ ...node, code: false }} />
+  </code>
+) : node.highlight ? (
+  <mark style={node.highlightColor ? `background-color:${node.highlightColor}` : undefined}>
+    <Astro.self node={{ ...node, highlight: false, highlightColor: undefined }} />
+  </mark>
+) : (
+  <Fragment>{node.text}</Fragment>
+)}

package/src/Node.astro

@@ -0,0 +1,66 @@
+---
+/**
+ * Per-node dispatcher. Picks one of the per-type components based on
+ * `node.type`. Mirrors the switch-on-type in
+ * `packages/tinacms/src/rich-text/index.tsx`. Each node-type group has its
+ * own component; one-liner fallbacks (`hr`, `break`, raw HTML, invalid)
+ * stay inline because splitting them out would just rename a single tag.
+ */
+import CodeBlockNode from './CodeBlockNode.astro';
+import Container from './Container.astro';
+import ImageNode from './ImageNode.astro';
+import Leaf from './Leaf.astro';
+import LinkNode from './LinkNode.astro';
+import MdxNode from './MdxNode.astro';
+import type {
+  CustomComponentsMap,
+  MdxElement,
+  TextElement,
+  TinaRichTextNode,
+} from './types';
+
+interface Props {
+  node: TinaRichTextNode;
+  components: CustomComponentsMap;
+}
+
+const { node, components } = Astro.props;
+const t = node.type;
+const Override = components[t];
+
+const containerTypes = new Set([
+  'p',
+  'h1',
+  'h2',
+  'h3',
+  'h4',
+  'h5',
+  'h6',
+  'ol',
+  'ul',
+  'li',
+  'lic',
+  'blockquote',
+]);
+---
+{containerTypes.has(t) ? (
+  <Container node={node as TinaRichTextNode & { children: TinaRichTextNode[] }} components={components} />
+) : t === 'a' ? (
+  <LinkNode node={node as { url: string; children: TinaRichTextNode[] }} components={components} />
+) : t === 'img' ? (
+  <ImageNode node={node as { url: string; alt?: string; caption?: string }} components={components} />
+) : t === 'code_block' ? (
+  <CodeBlockNode node={node as { value?: string; lang?: string; children?: { children: TextElement[] }[] }} components={components} />
+) : t === 'text' ? (
+  <Leaf node={node as TextElement} />
+) : t === 'mdxJsxFlowElement' || t === 'mdxJsxTextElement' ? (
+  <MdxNode node={node as MdxElement} components={components} />
+) : t === 'hr' ? (
+  Override ? <Override /> : <hr />
+) : t === 'break' ? (
+  Override ? <Override /> : <br />
+) : t === 'html' || t === 'html_inline' ? (
+  <Fragment set:html={(node as { value: string }).value} />
+) : t === 'invalid_markdown' ? (
+  <pre>{(node as { value: string }).value}</pre>
+) : null}

package/src/TinaMarkdown.astro

@@ -0,0 +1,28 @@
+---
+/**
+ * Astro port of the React TinaMarkdown renderer in
+ * `packages/tinacms/src/rich-text/index.tsx`.
+ *
+ * Walks Tina's rich-text Plate AST and emits Astro markup. Custom MDX
+ * components registered on `components` are dispatched by `node.name`
+ * (mdxJsxFlowElement / mdxJsxTextElement). Default tags (p, h1-h6, ul, ol,
+ * li, blockquote, etc.) can be overridden by registering the tag name on
+ * the same map. Recurses via this same component for nested rich-text.
+ */
+import Node from './Node.astro';
+import type { CustomComponentsMap, TinaRichTextContent } from './types';
+
+interface Props {
+  content: TinaRichTextContent;
+  components?: CustomComponentsMap;
+}
+
+const { content, components = {} } = Astro.props;
+
+const nodes = !content
+  ? []
+  : Array.isArray(content)
+    ? content
+    : (content.children ?? []);
+---
+{nodes.map((node) => <Node node={node} components={components} />)}