@scadable/privacy 0.1.0 → 0.2.0

package/dist/PolicyLive.cjs

@@ -0,0 +1,85 @@
+"use client";
+'use strict';
+
+var React = require('react');
+var jsxRuntime = require('react/jsx-runtime');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var React__namespace = /*#__PURE__*/_interopNamespace(React);
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://api.scadable.com";
+async function fetchPolicy(token, options = {}) {
+  if (!token) {
+    throw new Error("@scadable/privacy: a policy token is required");
+  }
+  const baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
+  const docType = options.docType ?? "privacy_policy";
+  const revalidate = options.revalidate ?? 3600;
+  const url = `${baseUrl}/policy/${encodeURIComponent(token)}?doc_type=${encodeURIComponent(docType)}&format=json`;
+  const init = revalidate === false ? { cache: "no-store" } : { next: { revalidate } };
+  const res = await fetch(url, init);
+  if (!res.ok) {
+    throw new Error(`@scadable/privacy: failed to load policy (${res.status}) for token "${token}"`);
+  }
+  return await res.json();
+}
+function PolicyLive({
+  token,
+  initialHtml,
+  initialVersion,
+  initialUpdatedAt,
+  className,
+  showVersion = false,
+  baseUrl,
+  docType
+}) {
+  const [html, setHtml] = React__namespace.useState(initialHtml);
+  const [version, setVersion] = React__namespace.useState(initialVersion);
+  const [updatedAt, setUpdatedAt] = React__namespace.useState(initialUpdatedAt ?? null);
+  React__namespace.useEffect(() => {
+    let alive = true;
+    const opts = { revalidate: false };
+    if (baseUrl) opts.baseUrl = baseUrl;
+    if (docType) opts.docType = docType;
+    fetchPolicy(token, opts).then((p) => {
+      if (!alive || !p?.html) return;
+      setHtml(p.html);
+      setVersion(p.version);
+      setUpdatedAt(p.updated_at);
+    }).catch(() => {
+    });
+    return () => {
+      alive = false;
+    };
+  }, [token, baseUrl, docType]);
+  return /* @__PURE__ */ jsxRuntime.jsxs("div", { className, children: [
+    /* @__PURE__ */ jsxRuntime.jsx("div", { dangerouslySetInnerHTML: { __html: html } }),
+    showVersion && updatedAt ? /* @__PURE__ */ jsxRuntime.jsxs("p", { style: { fontSize: 12, color: "#9ca3af", marginTop: 24 }, children: [
+      "Version ",
+      version,
+      ". Last updated ",
+      new Date(updatedAt).toLocaleDateString(),
+      "."
+    ] }) : null
+  ] });
+}
+
+exports.PolicyLive = PolicyLive;

package/dist/PolicyLive.d.cts

@@ -0,0 +1,29 @@
+import * as React from 'react';
+
+interface PolicyLiveProps {
+    /** The public token from the SCADABLE app. */
+    token: string;
+    /** HTML baked in at build / server-render time, so it is crawlable and paints instantly. */
+    initialHtml: string;
+    initialVersion?: number;
+    initialUpdatedAt?: string | null;
+    /** Optional wrapper class so you can style/position the policy. */
+    className?: string;
+    /** Show a small "Version N, last updated ..." line under the policy. Default false. */
+    showVersion?: boolean;
+    /** Override the API base (forwarded to the browser fetch). */
+    baseUrl?: string;
+    /** Which document to fetch (forwarded to the browser fetch). */
+    docType?: string;
+}
+/**
+ * The client half of <PrivacyPolicy>. It renders the build-time HTML immediately, so
+ * the legal text and the "by scadable.com" backlink are in the static HTML (crawlable
+ * for SEO, no layout shift), then re-fetches the live policy in the browser so edits
+ * made in SCADABLE show up with no redeploy on the customer's side. If the browser
+ * fetch is blocked (a strict Content-Security-Policy) or offline, it keeps the baked
+ * copy, so the page is never blank.
+ */
+declare function PolicyLive({ token, initialHtml, initialVersion, initialUpdatedAt, className, showVersion, baseUrl, docType, }: PolicyLiveProps): React.JSX.Element;
+
+export { PolicyLive, type PolicyLiveProps };

package/dist/PolicyLive.d.ts

@@ -0,0 +1,29 @@
+import * as React from 'react';
+
+interface PolicyLiveProps {
+    /** The public token from the SCADABLE app. */
+    token: string;
+    /** HTML baked in at build / server-render time, so it is crawlable and paints instantly. */
+    initialHtml: string;
+    initialVersion?: number;
+    initialUpdatedAt?: string | null;
+    /** Optional wrapper class so you can style/position the policy. */
+    className?: string;
+    /** Show a small "Version N, last updated ..." line under the policy. Default false. */
+    showVersion?: boolean;
+    /** Override the API base (forwarded to the browser fetch). */
+    baseUrl?: string;
+    /** Which document to fetch (forwarded to the browser fetch). */
+    docType?: string;
+}
+/**
+ * The client half of <PrivacyPolicy>. It renders the build-time HTML immediately, so
+ * the legal text and the "by scadable.com" backlink are in the static HTML (crawlable
+ * for SEO, no layout shift), then re-fetches the live policy in the browser so edits
+ * made in SCADABLE show up with no redeploy on the customer's side. If the browser
+ * fetch is blocked (a strict Content-Security-Policy) or offline, it keeps the baked
+ * copy, so the page is never blank.
+ */
+declare function PolicyLive({ token, initialHtml, initialVersion, initialUpdatedAt, className, showVersion, baseUrl, docType, }: PolicyLiveProps): React.JSX.Element;
+
+export { PolicyLive, type PolicyLiveProps };

package/dist/PolicyLive.js

@@ -0,0 +1,63 @@
+"use client";
+import * as React from 'react';
+import { jsxs, jsx } from 'react/jsx-runtime';
+
+// src/client.ts
+var DEFAULT_BASE_URL = "https://api.scadable.com";
+async function fetchPolicy(token, options = {}) {
+  if (!token) {
+    throw new Error("@scadable/privacy: a policy token is required");
+  }
+  const baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
+  const docType = options.docType ?? "privacy_policy";
+  const revalidate = options.revalidate ?? 3600;
+  const url = `${baseUrl}/policy/${encodeURIComponent(token)}?doc_type=${encodeURIComponent(docType)}&format=json`;
+  const init = revalidate === false ? { cache: "no-store" } : { next: { revalidate } };
+  const res = await fetch(url, init);
+  if (!res.ok) {
+    throw new Error(`@scadable/privacy: failed to load policy (${res.status}) for token "${token}"`);
+  }
+  return await res.json();
+}
+function PolicyLive({
+  token,
+  initialHtml,
+  initialVersion,
+  initialUpdatedAt,
+  className,
+  showVersion = false,
+  baseUrl,
+  docType
+}) {
+  const [html, setHtml] = React.useState(initialHtml);
+  const [version, setVersion] = React.useState(initialVersion);
+  const [updatedAt, setUpdatedAt] = React.useState(initialUpdatedAt ?? null);
+  React.useEffect(() => {
+    let alive = true;
+    const opts = { revalidate: false };
+    if (baseUrl) opts.baseUrl = baseUrl;
+    if (docType) opts.docType = docType;
+    fetchPolicy(token, opts).then((p) => {
+      if (!alive || !p?.html) return;
+      setHtml(p.html);
+      setVersion(p.version);
+      setUpdatedAt(p.updated_at);
+    }).catch(() => {
+    });
+    return () => {
+      alive = false;
+    };
+  }, [token, baseUrl, docType]);
+  return /* @__PURE__ */ jsxs("div", { className, children: [
+    /* @__PURE__ */ jsx("div", { dangerouslySetInnerHTML: { __html: html } }),
+    showVersion && updatedAt ? /* @__PURE__ */ jsxs("p", { style: { fontSize: 12, color: "#9ca3af", marginTop: 24 }, children: [
+      "Version ",
+      version,
+      ". Last updated ",
+      new Date(updatedAt).toLocaleDateString(),
+      "."
+    ] }) : null
+  ] });
+}
+
+export { PolicyLive };

package/dist/index.cjs

@@ -1,5 +1,6 @@
 'use strict';
 
+var PolicyLive = require('./PolicyLive.cjs');
 var jsxRuntime = require('react/jsx-runtime');
 
 // src/client.ts
@@ -26,19 +27,25 @@ async function PrivacyPolicy({
   ...options
 }) {
   const policy = await fetchPolicy(token, options);
-  return /* @__PURE__ */ jsxRuntime.jsxs("div", { className, children: [
-    /* @__PURE__ */ jsxRuntime.jsx("div", { dangerouslySetInnerHTML: { __html: policy.html } }),
-    showVersion && policy.updated_at ? /* @__PURE__ */ jsxRuntime.jsxs("p", { style: { fontSize: 12, color: "#9ca3af", marginTop: 24 }, children: [
-      "Version ",
-      policy.version,
-      ". Last updated",
-      " ",
-      new Date(policy.updated_at).toLocaleDateString(),
-      "."
-    ] }) : null
-  ] });
+  return /* @__PURE__ */ jsxRuntime.jsx(
+    PolicyLive.PolicyLive,
+    {
+      token,
+      initialHtml: policy.html,
+      initialVersion: policy.version,
+      initialUpdatedAt: policy.updated_at,
+      className,
+      showVersion,
+      baseUrl: options.baseUrl,
+      docType: options.docType
+    }
+  );
 }
 
+Object.defineProperty(exports, "PolicyLive", {
+  enumerable: true,
+  get: function () { return PolicyLive.PolicyLive; }
+});
 exports.DEFAULT_BASE_URL = DEFAULT_BASE_URL;
 exports.PrivacyPolicy = PrivacyPolicy;
 exports.fetchPolicy = fetchPolicy;

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-import * as React from 'react';
+import * as react from 'react';
+export { PolicyLive, PolicyLiveProps } from './PolicyLive';
 
 interface Policy {
     /** The name you gave the scope (your company / site). */
@@ -46,12 +47,14 @@ interface PrivacyPolicyProps extends FetchPolicyOptions {
     showVersion?: boolean;
 }
 /**
- * A React Server Component that renders your always-current privacy policy.
+ * Renders your always-current privacy policy.
  *
- * It is server-rendered, so the legal text is in the initial HTML (crawlable),
- * and cached via Next.js ISR (the `revalidate` option), so it stays current
- * without fetching on every request. The HTML comes from the SCADABLE API
- * (your own published, trusted content), injected as a content fragment.
+ * Hybrid by design. The policy HTML is fetched at build / server-render time and baked
+ * into the static HTML, so the legal text and the "by scadable.com" backlink are
+ * crawlable for SEO and paint instantly. It is then re-fetched in the browser (see
+ * {@link PolicyLive}) so edits you make in SCADABLE go live with no redeploy on your
+ * side. If a strict Content-Security-Policy blocks the browser fetch, the baked copy
+ * stays put, so the page is never blank.
  *
  * ```tsx
  * import { PrivacyPolicy } from '@scadable/privacy';
@@ -61,6 +64,6 @@ interface PrivacyPolicyProps extends FetchPolicyOptions {
  * }
  * ```
  */
-declare function PrivacyPolicy({ token, className, showVersion, ...options }: PrivacyPolicyProps): Promise<React.JSX.Element>;
+declare function PrivacyPolicy({ token, className, showVersion, ...options }: PrivacyPolicyProps): Promise<react.JSX.Element>;
 
 export { DEFAULT_BASE_URL, type FetchPolicyOptions, type Policy, PrivacyPolicy, type PrivacyPolicyProps, fetchPolicy };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-import * as React from 'react';
+import * as react from 'react';
+export { PolicyLive, PolicyLiveProps } from './PolicyLive';
 
 interface Policy {
     /** The name you gave the scope (your company / site). */
@@ -46,12 +47,14 @@ interface PrivacyPolicyProps extends FetchPolicyOptions {
     showVersion?: boolean;
 }
 /**
- * A React Server Component that renders your always-current privacy policy.
+ * Renders your always-current privacy policy.
  *
- * It is server-rendered, so the legal text is in the initial HTML (crawlable),
- * and cached via Next.js ISR (the `revalidate` option), so it stays current
- * without fetching on every request. The HTML comes from the SCADABLE API
- * (your own published, trusted content), injected as a content fragment.
+ * Hybrid by design. The policy HTML is fetched at build / server-render time and baked
+ * into the static HTML, so the legal text and the "by scadable.com" backlink are
+ * crawlable for SEO and paint instantly. It is then re-fetched in the browser (see
+ * {@link PolicyLive}) so edits you make in SCADABLE go live with no redeploy on your
+ * side. If a strict Content-Security-Policy blocks the browser fetch, the baked copy
+ * stays put, so the page is never blank.
  *
  * ```tsx
  * import { PrivacyPolicy } from '@scadable/privacy';
@@ -61,6 +64,6 @@ interface PrivacyPolicyProps extends FetchPolicyOptions {
  * }
  * ```
  */
-declare function PrivacyPolicy({ token, className, showVersion, ...options }: PrivacyPolicyProps): Promise<React.JSX.Element>;
+declare function PrivacyPolicy({ token, className, showVersion, ...options }: PrivacyPolicyProps): Promise<react.JSX.Element>;
 
 export { DEFAULT_BASE_URL, type FetchPolicyOptions, type Policy, PrivacyPolicy, type PrivacyPolicyProps, fetchPolicy };

package/dist/index.js

@@ -1,4 +1,6 @@
-import { jsxs, jsx } from 'react/jsx-runtime';
+import { PolicyLive } from './PolicyLive.js';
+export { PolicyLive } from './PolicyLive.js';
+import { jsx } from 'react/jsx-runtime';
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.scadable.com";
@@ -24,17 +26,19 @@ async function PrivacyPolicy({
   ...options
 }) {
   const policy = await fetchPolicy(token, options);
-  return /* @__PURE__ */ jsxs("div", { className, children: [
-    /* @__PURE__ */ jsx("div", { dangerouslySetInnerHTML: { __html: policy.html } }),
-    showVersion && policy.updated_at ? /* @__PURE__ */ jsxs("p", { style: { fontSize: 12, color: "#9ca3af", marginTop: 24 }, children: [
-      "Version ",
-      policy.version,
-      ". Last updated",
-      " ",
-      new Date(policy.updated_at).toLocaleDateString(),
-      "."
-    ] }) : null
-  ] });
+  return /* @__PURE__ */ jsx(
+    PolicyLive,
+    {
+      token,
+      initialHtml: policy.html,
+      initialVersion: policy.version,
+      initialUpdatedAt: policy.updated_at,
+      className,
+      showVersion,
+      baseUrl: options.baseUrl,
+      docType: options.docType
+    }
+  );
 }
 
 export { DEFAULT_BASE_URL, PrivacyPolicy, fetchPolicy };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scadable/privacy",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Render your always-current SCADABLE privacy policy in a Next.js app.",
   "license": "MIT",
   "type": "module",
@@ -20,7 +20,7 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsup",
+    "build": "tsup && node scripts/postbuild-directives.mjs",
     "dev": "tsup --watch",
     "typecheck": "tsc --noEmit",
     "prepublishOnly": "npm run build"