@orangecheck/legal 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 OrangeCheck (OCHK)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,95 @@
+# @orangecheck/legal
+
+Family-internal legal-document engine for the `.ochk.io` sub-sites. **Not for
+third-party integration.**
+
+It composes **Terms of Service** and **Privacy Policy** pages from one shared
+clause library plus per-profile content, so the whole family stays in sync
+from a single source of truth — while the commercial products keep the
+variants they genuinely need.
+
+## Why this exists
+
+The ecosystem outgrew "one Terms page on ochk.io". The non-custodial protocol
+sites, a consumer product that pays users in sats, a paid encrypted vault, and
+an enterprise B2B product cannot share one legal document. This package keeps
+the boilerplate shared and the divergence explicit.
+
+## Profiles
+
+| Profile    | Sites                                                             |
+|------------|-------------------------------------------------------------------|
+| `protocol` | ochk.io + the six verb sites + docs + analytics (one shared doc)  |
+| `me`       | me.ochk.io — consumer identity that pays users in sats            |
+| `vault`    | vault.ochk.io — paid end-to-end-encrypted secrets vault           |
+| `fleet`    | fleet.ochk.io — enterprise managed agent infrastructure           |
+
+The nine `protocol` sites do **not** host their own pages — their footers link
+to ochk.io. Only the three commercial products self-host.
+
+## Usage
+
+```tsx
+// src/pages/terms.tsx on a self-hosting site
+import { buildDoc, LegalDocument } from '@orangecheck/legal';
+import { Seo } from '@/components/layout/Seo';
+
+const doc = buildDoc('me', 'terms'); // pure + synchronous
+
+export default function TermsPage() {
+    return (
+        <>
+            <Seo title={doc.metaTitle} description={doc.metaDescription} canonical="/terms" />
+            <div className="container py-12">
+                <LegalDocument doc={doc} />
+            </div>
+        </>
+    );
+}
+```
+
+Tailwind 4 must scan the package so its utility classes emit. In `globals.css`:
+
+```css
+@source '../../node_modules/@orangecheck/legal';
+```
+
+Footer links resolve through one helper:
+
+```ts
+import { legalHref } from '@orangecheck/legal';
+legalHref('me', 'terms');     // → '/terms'
+legalHref('stamp', 'terms');  // → 'https://ochk.io/terms'
+```
+
+Security pages stay bespoke per product but share the disclosure block:
+
+```tsx
+import { SecurityDisclosure } from '@orangecheck/legal';
+<SecurityDisclosure securityContact="security@ochk.io" />
+```
+
+## Authoring
+
+- Shared clauses live in `src/content/clauses.ts`.
+- Each profile composes them in `src/content/<profile>.ts`.
+- Strings use `[[TOKEN]]` placeholders (`ENTITY`, `PRODUCT`, `HOST`, `CONTACT`,
+  `SECURITY_CONTACT`, `GOVERNING_LAW`, `ARBITRATION_SEAT`) resolved by
+  `buildDoc`.
+- A `stub` block renders a visible **"pending · counsel review"** notice — used
+  for money, custody, refund, SLA, and regulated-activity sections that must be
+  finalized by counsel before the commercial products reach general
+  availability.
+
+### Entity of record
+
+No formal legal entity is registered yet. `LEGAL_ENTITY` in `src/constants.ts`
+is the single swap point — set it (and `LEGAL_ENTITY_LONG`) when the entity is
+formed, rebuild, and publish; every document family-wide updates.
+
+## Build
+
+```
+npm install
+npm run build
+```

package/dist/index.d.mts

@@ -0,0 +1,86 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type LegalProfile = 'protocol' | 'me' | 'vault' | 'fleet';
+type DocKind = 'terms' | 'privacy';
+type BulletItem = string | {
+    k: string;
+    v: string;
+};
+type Block = {
+    kind: 'para';
+    text: string;
+} | {
+    kind: 'subhead';
+    text: string;
+} | {
+    kind: 'bullets';
+    items: BulletItem[];
+} | {
+    kind: 'callout';
+    text: string;
+    emphatic?: boolean;
+} | {
+    kind: 'stub';
+    text: string;
+};
+interface Section {
+    id: string;
+    num?: string;
+    heading: string;
+    hint?: string;
+    blocks: Block[];
+}
+interface DocSpec {
+    kind: DocKind;
+    eyebrow: string;
+    title: string;
+    description: string;
+    metaTitle: string;
+    metaDescription: string;
+    effective: string;
+    updated: string;
+    preamble?: Block[];
+    sections: Section[];
+    summary?: string;
+}
+interface LegalDoc extends DocSpec {
+    site: string;
+    profile: LegalProfile;
+}
+interface SiteContext {
+    slug: string;
+    profile: LegalProfile;
+    host: string;
+    product: string;
+    productShort: string;
+    contact: string;
+    securityContact: string;
+    selfHosted: boolean;
+}
+
+declare function buildDoc(siteSlug: string, kind: DocKind): LegalDoc;
+
+interface LegalDocumentProps {
+    doc: LegalDoc;
+}
+declare function LegalDocument({ doc }: LegalDocumentProps): react_jsx_runtime.JSX.Element;
+
+interface SecurityDisclosureProps {
+    securityContact?: string;
+    heading?: string | null;
+}
+declare function SecurityDisclosure({ securityContact, heading, }: SecurityDisclosureProps): react_jsx_runtime.JSX.Element;
+
+declare const LEGAL_SITES: Record<string, SiteContext>;
+declare const PROTOCOL_LINKED_SITES: readonly ["attest", "lock", "vote", "stamp", "agent", "pledge", "docs", "analytics"];
+declare function getSiteContext(slug: string): SiteContext;
+declare function legalHref(siteSlug: string, kind: 'terms' | 'privacy' | 'security'): string;
+
+declare const LEGAL_ENTITY = "OrangeCheck";
+declare const LEGAL_ENTITY_LONG = "OrangeCheck (OCHK), an unincorporated project";
+declare const ENTITY_PENDING = true;
+declare const CONTACT_GENERAL = "hello@ochk.io";
+declare const CONTACT_SECURITY = "security@ochk.io";
+declare const CONTACT_PRIVACY = "hello@ochk.io";
+
+export { type Block, type BulletItem, CONTACT_GENERAL, CONTACT_PRIVACY, CONTACT_SECURITY, type DocKind, type DocSpec, ENTITY_PENDING, LEGAL_ENTITY, LEGAL_ENTITY_LONG, LEGAL_SITES, type LegalDoc, LegalDocument, type LegalDocumentProps, type LegalProfile, PROTOCOL_LINKED_SITES, type Section, SecurityDisclosure, type SecurityDisclosureProps, type SiteContext, buildDoc, getSiteContext, legalHref };

package/dist/index.d.ts

@@ -0,0 +1,86 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+
+type LegalProfile = 'protocol' | 'me' | 'vault' | 'fleet';
+type DocKind = 'terms' | 'privacy';
+type BulletItem = string | {
+    k: string;
+    v: string;
+};
+type Block = {
+    kind: 'para';
+    text: string;
+} | {
+    kind: 'subhead';
+    text: string;
+} | {
+    kind: 'bullets';
+    items: BulletItem[];
+} | {
+    kind: 'callout';
+    text: string;
+    emphatic?: boolean;
+} | {
+    kind: 'stub';
+    text: string;
+};
+interface Section {
+    id: string;
+    num?: string;
+    heading: string;
+    hint?: string;
+    blocks: Block[];
+}
+interface DocSpec {
+    kind: DocKind;
+    eyebrow: string;
+    title: string;
+    description: string;
+    metaTitle: string;
+    metaDescription: string;
+    effective: string;
+    updated: string;
+    preamble?: Block[];
+    sections: Section[];
+    summary?: string;
+}
+interface LegalDoc extends DocSpec {
+    site: string;
+    profile: LegalProfile;
+}
+interface SiteContext {
+    slug: string;
+    profile: LegalProfile;
+    host: string;
+    product: string;
+    productShort: string;
+    contact: string;
+    securityContact: string;
+    selfHosted: boolean;
+}
+
+declare function buildDoc(siteSlug: string, kind: DocKind): LegalDoc;
+
+interface LegalDocumentProps {
+    doc: LegalDoc;
+}
+declare function LegalDocument({ doc }: LegalDocumentProps): react_jsx_runtime.JSX.Element;
+
+interface SecurityDisclosureProps {
+    securityContact?: string;
+    heading?: string | null;
+}
+declare function SecurityDisclosure({ securityContact, heading, }: SecurityDisclosureProps): react_jsx_runtime.JSX.Element;
+
+declare const LEGAL_SITES: Record<string, SiteContext>;
+declare const PROTOCOL_LINKED_SITES: readonly ["attest", "lock", "vote", "stamp", "agent", "pledge", "docs", "analytics"];
+declare function getSiteContext(slug: string): SiteContext;
+declare function legalHref(siteSlug: string, kind: 'terms' | 'privacy' | 'security'): string;
+
+declare const LEGAL_ENTITY = "OrangeCheck";
+declare const LEGAL_ENTITY_LONG = "OrangeCheck (OCHK), an unincorporated project";
+declare const ENTITY_PENDING = true;
+declare const CONTACT_GENERAL = "hello@ochk.io";
+declare const CONTACT_SECURITY = "security@ochk.io";
+declare const CONTACT_PRIVACY = "hello@ochk.io";
+
+export { type Block, type BulletItem, CONTACT_GENERAL, CONTACT_PRIVACY, CONTACT_SECURITY, type DocKind, type DocSpec, ENTITY_PENDING, LEGAL_ENTITY, LEGAL_ENTITY_LONG, LEGAL_SITES, type LegalDoc, LegalDocument, type LegalDocumentProps, type LegalProfile, PROTOCOL_LINKED_SITES, type Section, SecurityDisclosure, type SecurityDisclosureProps, type SiteContext, buildDoc, getSiteContext, legalHref };