@scadable/astro

Render your always-current legal documents (privacy policy, terms of use, and more) in an Astro site. You publish each document once in the SCADABLE app; these components show whatever version is currently published, so updating a document never means a rebuild on your side. One thing to provide: your public token.

Install

npm install @scadable/astro

Use

Astro component libraries ship the raw .astro files, so you import the component you want directly from the package and drop it on the matching page.

---
// src/pages/privacy.astro
import PrivacyPolicy from '@scadable/astro/PrivacyPolicy.astro';
---
<main>
  <PrivacyPolicy token="YOUR_PUBLIC_TOKEN" />
</main>

---
// src/pages/terms.astro
import TermsOfUse from '@scadable/astro/TermsOfUse.astro';
---
<main>
  <TermsOfUse token="YOUR_PUBLIC_TOKEN" />
</main>

Get YOUR_PUBLIC_TOKEN from the SCADABLE app after you publish a document.

Any document type

PrivacyPolicy and TermsOfUse are thin wrappers over a generic ScadablePolicy component. Use it directly to render any document type by setting docType (it defaults to "privacy_policy"). A new document type is a prop value, never a new package.

---
import ScadablePolicy from '@scadable/astro/ScadablePolicy.astro';
---
<ScadablePolicy token="YOUR_PUBLIC_TOKEN" docType="terms_of_use" />

How it works (hybrid: SEO + live)

The document is fetched in the component frontmatter at build / SSR time and baked into the static HTML, so the legal text and the "by scadable.com" backlink are crawlable for SEO and paint instantly with no layout shift. A small hoisted script then re-fetches the document in the browser and swaps it in, so edits you make in SCADABLE go live with no rebuild on your side. If a strict Content-Security-Policy blocks the browser fetch (or the visitor is offline), the baked copy stays put, so the page is never blank.

Because the policy is baked at build time, a fresh static build reflects the document as it was published then; the browser refresh keeps already-deployed pages current in between builds. If you render with an adapter (SSR) instead of a static build, each request bakes the current version.

Props

These props apply to PrivacyPolicy, TermsOfUse, and ScadablePolicy.

| Prop | Type | Default | Notes | | --- | --- | --- | --- | | token | string | required | Your scope's public token. | | class / className | string | none | Class on the wrapper element. Either name works. | | baseUrl | string | https://api.scadable.com | Override the API base. | | docType | string | "privacy_policy" | Which document to render. Only on ScadablePolicy (the wrappers fix it). |

Just the data

If you want to render it yourself, the fetch client and types come from @scadable/core and are re-exported here for convenience:

import { fetchPolicy } from '@scadable/astro';

const policy = await fetchPolicy('YOUR_PUBLIC_TOKEN', { docType: 'terms_of_use' });
// { scope_name, domain, doc_type, version, effective_date, updated_at, html }

policy.html is a self-styled HTML content fragment that inherits the host page's text color, safe to inject inline. It already includes the "by scadable.com" backlink.

Notes

• This package only talks to the public SCADABLE API. It stores no secrets.
• The rendered HTML is your own published document content from the SCADABLE API.
• The frontmatter fetch runs at build / SSR time. If the document is not published yet (or the API is unreachable) that build will fail loudly, which is the right signal that there is nothing to bake. Publish the document first, then build.