legal-terms 0.1.9

package/cli.mjs

@@ -0,0 +1,158 @@
+#!/usr/bin/env node
+/**
+ * Print a configured Terms of Service + Privacy Policy as Markdown, HTML or
+ * plain text — for a repo's `TERMS.md`, a static page, or a diff of what a
+ * config change does to the policy text.
+ *
+ * @example
+ * ```sh
+ * npx legal-terms-privacy-policy --app-name Acme --variant full > TERMS.md
+ * npx legal-terms-privacy-policy --app-name Acme --format html --standalone \
+ *   --no-part california --exclude social-features > terms.html
+ * ```
+ */
+import { register } from 'node:module';
+
+register('./ts-loader.mjs', import.meta.url);
+
+const { renderMarkdown, renderHtml, renderText, resolveLegalDoc } = await import(
+  new URL('./src/index.ts', import.meta.url).href
+);
+
+const USAGE = `
+legal-terms-privacy-policy — print a configurable Terms of Service + Privacy Policy
+
+Usage:
+  legal-terms-privacy-policy [options]
+
+Document:
+  --variant <summary|full>    Which presentation to print (default: full)
+  --format <markdown|html|text|json>
+                              Output format (default: markdown)
+  --standalone                For --format html, emit a full page with styles
+
+Values substituted into the text:
+  --app-name <name>           Product name (default: Our Service)
+  --company-name <name>       Legal entity (default: same as --app-name)
+  --contact-email <email>     Address for legal and privacy requests
+  --home-url <url>            Target of the "Back to Home" link
+  --last-revised <date>       Revision date shown under the title
+  --effective-date <date>     Effective date (default: same as --last-revised)
+  --jurisdiction <region>     Region the Services are offered in
+  --minimum-age <n>           Minimum age to hold an account
+  --children-age <n>          COPPA age threshold
+  --deletion-days <n>         Days to purge data after account deletion
+
+Choosing what appears:
+  --no-part <id>              Drop a named part; repeatable. One of:
+                              ai, privacy, cookies, california, children,
+                              security, thirdParty
+  --part <id>                 Force a part back on; repeatable
+  --include <id>              Keep only these section ids; repeatable
+  --exclude <id>              Drop these section ids; repeatable
+  --order <id,id,...>         Put these sections first, in this order
+  --no-numbers                Do not number the full-text sections
+  --title <text>              Override the document title
+
+  --list-sections             Print the section ids of the chosen variant
+  -h, --help                  Show this help
+`.trim();
+
+const PART_IDS = new Set([
+  'ai',
+  'privacy',
+  'cookies',
+  'california',
+  'children',
+  'security',
+  'thirdParty',
+]);
+
+function parseArgs(argv) {
+  const options = { parts: {}, include: [], exclude: [] };
+  let format = 'markdown';
+  let standalone = false;
+  let listSections = false;
+
+  /** Flags that take the next argv entry as their value. */
+  const valueFlags = {
+    '--variant': 'variant',
+    '--app-name': 'appName',
+    '--company-name': 'companyName',
+    '--contact-email': 'contactEmail',
+    '--home-url': 'homeUrl',
+    '--last-revised': 'lastRevisedDate',
+    '--effective-date': 'effectiveDate',
+    '--jurisdiction': 'jurisdiction',
+    '--minimum-age': 'minimumAge',
+    '--children-age': 'childrenAge',
+    '--deletion-days': 'dataDeletionDays',
+    '--title': 'title',
+  };
+
+  for (let i = 0; i < argv.length; i++) {
+    const arg = argv[i];
+    if (arg === '-h' || arg === '--help') {
+      console.log(USAGE);
+      process.exit(0);
+    } else if (arg === '--list-sections') {
+      listSections = true;
+    } else if (arg === '--standalone') {
+      standalone = true;
+    } else if (arg === '--no-numbers') {
+      options.features = { ...options.features, numbered: false };
+    } else if (arg === '--format') {
+      format = argv[++i];
+    } else if (arg === '--no-part' || arg === '--part') {
+      const id = argv[++i];
+      if (!PART_IDS.has(id)) {
+        console.error(`Unknown part "${id}". Expected one of: ${[...PART_IDS].join(', ')}`);
+        process.exit(1);
+      }
+      options.parts[id] = arg === '--part';
+    } else if (arg === '--include') {
+      options.include.push(argv[++i]);
+    } else if (arg === '--exclude') {
+      options.exclude.push(argv[++i]);
+    } else if (arg === '--order') {
+      options.order = argv[++i].split(',').map((s) => s.trim()).filter(Boolean);
+    } else if (valueFlags[arg]) {
+      options[valueFlags[arg]] = argv[++i];
+    } else {
+      console.error(`Unknown option "${arg}". Run with --help for usage.`);
+      process.exit(1);
+    }
+  }
+  return { options, format, standalone, listSections };
+}
+
+const { options, format, standalone, listSections } = parseArgs(process.argv.slice(2));
+
+if (listSections) {
+  const doc = resolveLegalDoc(options);
+  for (const section of doc.sections) {
+    console.log(section.id);
+    for (const sub of section.subsections ?? []) console.log(`  ${sub.id}`);
+  }
+  process.exit(0);
+}
+
+switch (format) {
+  case 'markdown':
+  case 'md':
+    process.stdout.write(renderMarkdown(options));
+    break;
+  case 'html':
+    process.stdout.write(renderHtml(options, { standalone }) + '\n');
+    break;
+  case 'text':
+  case 'txt':
+    process.stdout.write(renderText(options));
+    break;
+  case 'json':
+    process.stdout.write(JSON.stringify(resolveLegalDoc(options), null, 2) + '\n');
+    break;
+  default:
+    console.error(`Unknown format "${format}". Expected markdown, html, text or json.`);
+    process.exit(1);
+}

package/package.json

@@ -0,0 +1,82 @@
+{
+  "name": "legal-terms",
+  "version": "0.1.9",
+  "description": "Configurable Terms of Service and Privacy Policy — a scannable summary and the full legal text, with every section addable, removable and reorderable. React page, plus Markdown/HTML/text renderers and a CLI.",
+  "type": "module",
+  "author": "vtempest",
+  "license": "rights.institute/prosper",
+  "main": "./src/index.ts",
+  "types": "./src/index.ts",
+  "module": "./src/index.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.ts",
+      "import": "./src/index.ts",
+      "require": "./src/index.ts"
+    },
+    "./react": {
+      "types": "./src/react/index.ts",
+      "import": "./src/react/index.ts"
+    },
+    "./content/full": "./src/content/full.ts",
+    "./content/summary": "./src/content/summary.ts",
+    "./package.json": "./package.json",
+    "./*": "./src/*"
+  },
+  "bin": {
+    "legal-terms-privacy-policy": "./cli.mjs"
+  },
+  "files": [
+    "src",
+    "cli.mjs",
+    "readme.md"
+  ],
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "coverage": "vitest run --coverage",
+    "test:ci": "vitest run --reporter=default --reporter=junit --outputFile=./junit.xml --coverage",
+    "typecheck": "tsc --noEmit",
+    "demo": "node cli.mjs --app-name 'Example App' --variant full --format markdown",
+    "pub": "npm version patch && npm publish"
+  },
+  "keywords": [
+    "terms-of-service",
+    "privacy-policy",
+    "legal",
+    "gdpr",
+    "ccpa",
+    "coppa",
+    "compliance",
+    "react",
+    "nextjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/OpenSourceAGI/dev-tools-starter-agent.git",
+    "directory": "packages/legal-terms-privacy-policy"
+  },
+  "homepage": "https://github.com/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/legal-terms-privacy-policy",
+  "peerDependencies": {
+    "lucide-react": ">=0.4.0",
+    "react": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "lucide-react": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.0",
+    "@types/react-dom": "^19.2.0",
+    "@vitest/coverage-v8": "^4.1.0",
+    "lucide-react": "^1.43.0",
+    "react": "^19.2.8",
+    "react-dom": "^19.2.8",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.0"
+  }
+}

package/readme.md

@@ -0,0 +1,226 @@
+<!-- template-git-repo:badges:start -->
+<p align="center">
+    <a href="https://starterdocs.vtempest.workers.dev/docs/packages/legal-terms-privacy-policy"><img src="https://img.shields.io/badge/Docs-blue?logo=ReadTheDocs&logoColor=white" alt="Documentation" /></a>
+    <a href="https://stackblitz.com/github/OpenSourceAGI/dev-tools-starter-agent/tree/master/packages/legal-terms-privacy-policy"><img height="20px" src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" /></a>
+    <br />
+    <a href="https://www.npmjs.com/package/legal-terms-privacy-policy"><img src="https://img.shields.io/npm/dm/legal-terms-privacy-policy.svg" alt="NPM Monthly Downloads" /></a>
+    <a href="https://www.npmjs.com/package/legal-terms-privacy-policy"><img src="https://img.shields.io/npm/v/legal-terms-privacy-policy.svg" alt="npm version" /></a>
+    <a href="https://www.npmjs.com/package/legal-terms-privacy-policy"><img src="https://img.shields.io/npm/dt/legal-terms-privacy-policy.svg" alt="NPM Total Downloads" /></a>
+    <a href="https://www.npmjs.com/package/legal-terms-privacy-policy"><img src="https://img.shields.io/npm/types/legal-terms-privacy-policy" alt="TypeScript types" /></a>
+    <a href="https://packagephobia.com/result?p=legal-terms-privacy-policy"><img src="https://packagephobia.com/badge?p=legal-terms-privacy-policy" alt="Install size" /></a>
+</p>
+<!-- template-git-repo:badges:end -->
+
+<!-- skills:install:start -->
+**🤖 Agent skill** — `npx skills@latest add https://github.com/OpenSourceAGI/dev-tools-starter-agent --skill legal-terms-privacy-policy` ([what it covers](../../skills/legal-terms-privacy-policy/SKILL.md))
+<!-- skills:install:end -->
+
+# legal-terms-privacy-policy
+
+One combined **Terms of Service + Privacy Policy**, in two presentations of the same policy, with every section addable, removable and reorderable from config.
+
+- **Summary** — the scannable card-and-icon layout published at [rights.institute/terms-privacy](https://rights.institute/terms-privacy).
+- **Full text** — the long-form legal document published by QwkSearch, Debate AI and AI Broker.
+
+Ship both and let readers switch between them, or pin a page to one. Nothing in the package needs editing to adopt it: the product name, contact address, dates, which clauses appear and in what order all come from props.
+
+> Not legal advice. This is boilerplate to start from — have a lawyer review the text you publish.
+
+## Install
+
+```sh
+npm install legal-terms-privacy-policy
+```
+
+The package ships TypeScript source rather than a build output, matching the other packages in this monorepo. In a Next.js app, add it to `transpilePackages`:
+
+```js
+// next.config.js
+export default { transpilePackages: ['legal-terms-privacy-policy'] };
+```
+
+`react` and `lucide-react` are optional peers — needed only for the React page, not for the Markdown/HTML/text renderers or the CLI.
+
+## React page
+
+```tsx
+import { LegalTermsPrivacyPolicy } from 'legal-terms-privacy-policy/react';
+
+export default function TermsPage() {
+  return (
+    <LegalTermsPrivacyPolicy
+      appName="QwkSearch"
+      contactEmail="legal@qwksearch.com"
+      lastRevisedDate="March 1, 2026"
+      defaultVariant="full"
+    />
+  );
+}
+```
+
+The component renders the whole page — back link, title, badges, revision date, the summary ⇄ full-text switch, section navigation and the body. It is Tailwind-styled and works in light and dark.
+
+### Controlling the variant
+
+Uncontrolled, the switch keeps its own state starting from `defaultVariant`. Pass `variant` and `onVariantChange` to drive it from the URL instead:
+
+```tsx
+'use client';
+const [variant, setVariant] = useState<Variant>('summary');
+<LegalTermsPrivacyPolicy variant={variant} onVariantChange={setVariant} appName="Acme" />;
+```
+
+To publish only one presentation, set `variant` and turn the switch off:
+
+```tsx
+<LegalTermsPrivacyPolicy appName="Acme" variant="full" features={{ variantSwitch: false }} />
+```
+
+## Configuration
+
+Every option below works the same way in the React component, the renderers and the CLI.
+
+### Values substituted into the text
+
+The legal text carries `{{token}}` placeholders. Unknown tokens are left visible rather than blanked, so a typo shows up on the page instead of silently deleting a clause.
+
+| Option | Default | Appears in |
+| --- | --- | --- |
+| `appName` | `"Our Service"` | Throughout |
+| `companyName` | same as `appName` | Liability, contact, footer |
+| `contactEmail` | `"legal@example.com"` | Accounts, retention, contact |
+| `homeUrl` | `"/"` | "Back to Home" link |
+| `lastRevisedDate` | `"January 1, 2025"` | Under the title |
+| `effectiveDate` | same as `lastRevisedDate` | Under the title |
+| `jurisdiction` | `"the United States"` | Introduction |
+| `minimumAge` | `18` | Acceptance of Terms |
+| `childrenAge` | `13` | Children's Privacy |
+| `dataDeletionDays` | `30` | Data Security and Retention |
+| `tokens` | `{}` | Extra placeholders for your own sections |
+
+### Adding and removing parts
+
+`parts` switches named groups of clauses on or off in one go:
+
+```tsx
+<LegalTermsPrivacyPolicy
+  appName="Grab URL"
+  parts={{ ai: false, california: false }}   // no model in the loop, no CA notice
+/>
+```
+
+| Part | Covers |
+| --- | --- |
+| `core` | Introduction, changes, accounts, use, materials, feedback, warranties, termination, contact. Always on — switching it off is ignored. |
+| `ai` | The Artificial Intelligence Ethical Use Policy and AI-specific clauses |
+| `privacy` | Collection, use, disclosure and retention of personal data |
+| `cookies` | Cookies, tracking technologies and Do Not Track |
+| `california` | The CCPA/CPRA resident notice |
+| `children` | The COPPA under-13 notice |
+| `security` | Security measures and data retention |
+| `thirdParty` | Third-party links and social features |
+
+For finer control, work by section id — `include` keeps only what you name, `exclude` drops it, and both reach subsections:
+
+```tsx
+exclude={['social-features', 'california-selling']}
+include={['introduction', 'privacy-policy', 'contact']}
+```
+
+Naming a parent in `include` keeps its whole subtree (`['ai-ethics']` is the section and its four sub-policies); naming only a child keeps the parent as its heading (`['california-rights']` renders under "California Residents"). `exclude` still applies inside an included parent.
+
+Run `npx legal-terms-privacy-policy --list-sections` (add `--variant summary`) to see every id.
+
+### Rewriting and adding sections
+
+`replace` patches a section by id, merging over the built-in one — pass only the fields you are changing:
+
+```tsx
+replace={{
+  contact: { blocks: [{ type: 'p', text: 'Write to {{companyName}}, 1 Main St.' }] },
+  'california-selling': { title: 'We Do Not Sell Your Data' },
+}}
+```
+
+`add` inserts your own sections, anchored to an existing one:
+
+```tsx
+add={[{
+  after: 'termination',
+  section: {
+    id: 'arbitration',
+    title: 'Arbitration and Governing Law',
+    icon: 'Scale',
+    accent: 'slate',
+    blocks: [
+      { type: 'p', text: 'Disputes with {{companyName}} are resolved by binding arbitration.' },
+      { type: 'ul', lead: 'Exceptions:', items: ['Small claims court', 'Injunctive relief'] },
+    ],
+  },
+}]}
+```
+
+Anchors are `after`, `before` or `at` (an index); with none of them, the section is appended. `order` puts named sections first, in the order given, and leaves the rest in place.
+
+### Block types
+
+Sections hold `blocks`, so caller-authored content renders in every format:
+
+| Block | Shape |
+| --- | --- |
+| `p` | `{ type: 'p', text, strong? }` |
+| `ol` / `ul` | `{ type: 'ol', lead?, items }` — items are strings or `{ text, items }` for one nested level |
+| `cards` | `{ type: 'cards', columns?: 1-4, center?, items: [{ title, text?, items?, icon? }] }` |
+| `note` | `{ type: 'note', title?, text?, items?, icon? }` |
+
+Card and note blocks render as tinted tiles in the summary variant and flatten to headings and lists in the full-text variant, so you only write them once. `icon` names a [lucide](https://lucide.dev) icon; unknown names fall back to a document glyph, or pass your own components through the `icons` prop.
+
+### Chrome
+
+`features` toggles the page furniture: `backLink`, `sidebar`, `tableOfContents`, `copyButtons`, `badges`, `variantSwitch`, `footer`, `numbered`. `badges` (the array) sets the compliance pills — `['GDPR Compliant', 'CCPA Compliant', 'Cookie Policy']` by default; pass `[]` to drop them.
+
+## Rendering without React
+
+```ts
+import { renderMarkdown, renderHtml, renderText, resolveLegalDoc } from 'legal-terms-privacy-policy';
+
+const config = { appName: 'Acme', contactEmail: 'legal@acme.com', parts: { ai: false } };
+
+renderMarkdown(config);                      // TERMS.md, MDX docs page
+renderHtml(config, { standalone: true });    // complete styled page
+renderText(config);                          // email, CLI, in-app agreement dialog
+resolveLegalDoc(config).sections;            // the resolved tree, to render yourself
+```
+
+`LEGAL_CSS` is exported for pairing with the HTML fragment. Interpolated values are HTML-escaped, and emails and URLs in the text become links.
+
+## CLI
+
+```sh
+npx legal-terms-privacy-policy --app-name Acme --variant full > TERMS.md
+
+npx legal-terms-privacy-policy \
+  --app-name Acme --contact-email legal@acme.com \
+  --format html --standalone \
+  --no-part california --exclude social-features > terms.html
+
+npx legal-terms-privacy-policy --list-sections --variant summary
+```
+
+`--format` takes `markdown`, `html`, `text` or `json`. Run `--help` for the full list.
+
+## Keeping the two variants honest
+
+The summary is a plain-language restatement; the full text is what binds. If you edit one, edit the other — `src/content/summary.ts` and `src/content/full.ts` are the two files to keep in step. Publishing a summary whose claims the full text does not support is the failure mode this package is shaped to avoid, which is why the switch is on by default.
+
+## Tests
+
+```sh
+npm test
+```
+
+Covers token substitution, part and id filtering, patching, insertion, ordering, and each renderer — including that neither variant ships an unsubstituted `{{token}}` and that interpolated values cannot inject markup.
+
+## License
+
+[PROSPER 1.0.0](https://rights.institute/prosper)