@openpolicy/core 0.0.12 → 0.0.13

package/README.md

@@ -6,7 +6,7 @@ This is an internal package used by `@openpolicy/sdk`, `@openpolicy/vite`, and `
 
 ## What it does
 
-- Compiles `PrivacyPolicyConfig` and `TermsOfServiceConfig` definitions to Markdown and HTML
+- Compiles `PrivacyPolicyConfig` and `TermsOfServiceConfig` definitions to Markdown, HTML, and PDF
 - Validates policy configs and returns structured warnings and errors
 - Exports section builders, renderers, and all core types
 
@@ -17,18 +17,19 @@ If you're building a custom integration (e.g. a framework plugin not covered by
 ```ts
 import { compilePolicy } from "@openpolicy/core";
 
-const results = compilePolicy(
+const results = await compilePolicy(
   {
     type: "privacy",
     effectiveDate: "2026-01-01",
     company: { name: "Acme", legalName: "Acme, Inc.", address: "...", contact: "privacy@acme.com" },
     // ... rest of config
   },
-  { formats: ["markdown", "html"] },
+  { formats: ["markdown", "html", "pdf"] },
 );
 
 for (const result of results) {
-  console.log(result.format, result.content);
+  // result.content is string for markdown/html, Buffer for pdf
+  console.log(result.format, result.filename);
 }
 ```
 

package/dist/index.d.ts

@@ -3,11 +3,6 @@ type OutputFormat = "markdown" | "html" | "pdf" | "jsx";
 type CompileOptions = {
   formats: OutputFormat[];
 };
-type PolicySection = {
-  id: string;
-  title: string;
-  body: string;
-};
 type Jurisdiction = "us" | "eu" | "ca" | "au" | "nz" | "other";
 type CompanyConfig = {
   name: string;
@@ -149,26 +144,84 @@ type ValidationIssue = {
   message: string;
 };
 //#endregion
-//#region src/cookie.d.ts
-declare function compileCookiePolicy(config: CookiePolicyConfig, options?: CompileOptions): {
-  format: OutputFormat;
-  content: string;
-  sections: PolicySection[];
-}[];
+//#region src/documents/types.d.ts
+type NodeContext = {
+  reason?: string;
+};
+type TextNode = {
+  type: "text";
+  value: string;
+  context?: NodeContext;
+};
+type BoldNode = {
+  type: "bold";
+  value: string;
+  context?: NodeContext;
+};
+type ItalicNode = {
+  type: "italic";
+  value: string;
+  context?: NodeContext;
+};
+type LinkNode = {
+  type: "link";
+  href: string;
+  value: string;
+  context?: NodeContext;
+};
+type InlineNode = TextNode | BoldNode | ItalicNode | LinkNode;
+type HeadingNode = {
+  type: "heading";
+  level?: 1 | 2 | 3 | 4 | 5 | 6;
+  value: string;
+  context?: NodeContext;
+};
+type ParagraphNode = {
+  type: "paragraph";
+  children: InlineNode[];
+  context?: NodeContext;
+};
+type ListItemNode = {
+  type: "listItem";
+  children: (InlineNode | ListNode)[];
+  context?: NodeContext;
+};
+type ListNode = {
+  type: "list";
+  ordered?: boolean;
+  items: ListItemNode[];
+  context?: NodeContext;
+};
+type ContentNode = HeadingNode | ParagraphNode | ListNode;
+type DocumentSection = {
+  type: "section";
+  id: string;
+  content: ContentNode[];
+  context?: NodeContext;
+};
+type PolicyType = "privacy" | "terms" | "cookie";
+type Document = {
+  type: "document";
+  policyType: PolicyType;
+  sections: DocumentSection[];
+  context?: NodeContext;
+};
+type Node = Document | DocumentSection | ContentNode | ListItemNode | InlineNode;
 //#endregion
-//#region src/privacy.d.ts
-declare function compilePrivacyPolicy(config: PrivacyPolicyConfig, options?: CompileOptions): {
-  format: OutputFormat;
-  content: string;
-  sections: PolicySection[];
-}[];
+//#region src/documents/helpers.d.ts
+declare const heading: (value: string, levelOrContext?: (1 | 2 | 3 | 4 | 5 | 6) | NodeContext, context?: NodeContext) => HeadingNode;
+declare const text: (value: string, context?: NodeContext) => TextNode;
+declare const bold: (value: string, context?: NodeContext) => BoldNode;
+declare const italic: (value: string, context?: NodeContext) => ItalicNode;
+declare const link: (href: string, value: string, context?: NodeContext) => LinkNode;
+declare const p: (children: (string | InlineNode)[], context?: NodeContext) => ParagraphNode;
+declare const li: (children: (string | InlineNode | ListNode)[], context?: NodeContext) => ListItemNode;
+declare const ul: (items: ListItemNode[], context?: NodeContext) => ListNode;
+declare const ol: (items: ListItemNode[], context?: NodeContext) => ListNode;
+declare const section: (id: string, content: ContentNode[], context?: NodeContext) => DocumentSection;
 //#endregion
-//#region src/terms.d.ts
-declare function compileTermsOfService(config: TermsOfServiceConfig, options?: CompileOptions): {
-  format: OutputFormat;
-  content: string;
-  sections: PolicySection[];
-}[];
+//#region src/documents/index.d.ts
+declare function compile(input: PolicyInput): Document;
 //#endregion
 //#region src/validate.d.ts
 declare function validatePrivacyPolicy(config: PrivacyPolicyConfig): ValidationIssue[];
@@ -181,11 +234,6 @@ declare function validateTermsOfService(config: TermsOfServiceConfig): Validatio
 //#endregion
 //#region src/index.d.ts
 declare function expandOpenPolicyConfig(config: OpenPolicyConfig): PolicyInput[];
-declare function compilePolicy(input: PolicyInput, options?: CompileOptions): {
-  format: OutputFormat;
-  content: string;
-  sections: PolicySection[];
-}[];
 //#endregion
-export { type CompanyConfig, type CompileOptions, type CookiePolicyConfig, type DisputeResolutionMethod, type Jurisdiction, type OpenPolicyConfig, type OutputFormat, type PolicyInput, type PolicySection, type PrivacyPolicyConfig, type TermsOfServiceConfig, type ValidationIssue, compileCookiePolicy, compilePolicy, compilePrivacyPolicy, compileTermsOfService, expandOpenPolicyConfig, isOpenPolicyConfig, validateCookiePolicy, validatePrivacyPolicy, validateTermsOfService };
+export { type BoldNode, type CompanyConfig, type CompileOptions, type ContentNode, type CookiePolicyConfig, type DisputeResolutionMethod, type Document, type DocumentSection, type HeadingNode, type InlineNode, type ItalicNode, type Jurisdiction, type LinkNode, type ListItemNode, type ListNode, type Node, type NodeContext, type OpenPolicyConfig, type OutputFormat, type ParagraphNode, type PolicyInput, type PolicyType, type PrivacyPolicyConfig, type TermsOfServiceConfig, type TextNode, type ValidationIssue, bold, compile, expandOpenPolicyConfig, heading, isOpenPolicyConfig, italic, li, link, ol, p, section, text, ul, validateCookiePolicy, validatePrivacyPolicy, validateTermsOfService };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/cookie.ts","../src/privacy.ts","../src/terms.ts","../src/validate.ts","../src/validate-cookie.ts","../src/validate-terms.ts","../src/index.ts"],"mappings":";KAAY,YAAA;AAAA,KAEA,cAAA;EAAmB,OAAA,EAAS,YAAA;AAAA;AAAA,KAE5B,aAAA;EACX,EAAA;EACA,KAAA;EACA,IAAA;AAAA;AAAA,KAGW,YAAA;AAAA,KAEA,aAAA;EACX,IAAA;EACA,SAAA;EACA,OAAA;EACA,OAAA;AAAA;AAAA,KAGW,mBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,aAAA,EAAe,MAAA;EACf,UAAA;EACA,SAAA,EAAW,MAAA;EACX,OAAA;IAAW,SAAA;IAAoB,SAAA;IAAoB,SAAA;EAAA;EACnD,YAAA;IAAgB,IAAA;IAAc,OAAA;EAAA;EAC9B,UAAA;EACA,aAAA,EAAe,YAAA;EAEf,QAAA;IACC,QAAA;IACA,SAAA;EAAA;AAAA;AAAA,KAIU,uBAAA;AAAA,KAKA,oBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,UAAA;IAAc,OAAA;EAAA;EACd,WAAA;IAAgB,UAAA;IAAoB,wBAAA;EAAA;EACpC,QAAA;IACC,oBAAA;IACA,6BAAA;IACA,mBAAA;EAAA;EAED,cAAA;EACA,WAAA;IACC,eAAA;IACA,uBAAA;IACA,kBAAA;IACA,uBAAA;EAAA;EAED,oBAAA;IACC,kBAAA;IACA,eAAA;EAAA;EAED,QAAA;IACC,eAAA;IACA,YAAA;IACA,kBAAA;EAAA;EAED,YAAA;IAAiB,iBAAA;IAA4B,kBAAA;EAAA;EAC7C,WAAA;IACC,mBAAA;IACA,gBAAA;IACA,mBAAA;EAAA;EAED,WAAA;IAAgB,mBAAA;IAA8B,YAAA;EAAA;EAC9C,qBAAA;IACC,uBAAA;IACA,YAAA;EAAA;EAED,eAAA;IAAoB,sBAAA;IAAiC,KAAA;EAAA;EACrD,kBAAA;IAAuB,IAAA;IAAc,OAAA;EAAA;EACrC,iBAAA;IACC,MAAA,EAAQ,uBAAA;IACR,KAAA;IACA,iBAAA;EAAA;EAED,YAAA;IAAgB,YAAA;EAAA;EAChB,aAAA;IAAkB,YAAA;IAAsB,gBAAA;EAAA;EACxC,gBAAA;AAAA;AAAA,KAGW,kBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,OAAA;IACC,SAAA;IACA,SAAA;IACA,UAAA;IACA,SAAA;EAAA;EAED,YAAA;IAAiB,IAAA;IAAc,OAAA;IAAiB,SAAA;EAAA;EAChD,oBAAA;EACA,gBAAA;IACC,SAAA;IACA,kBAAA;IACA,WAAA;EAAA;EAED,aAAA,EAAe,YAAA;AAAA;AAAA,KAGJ,WAAA;EACN,IAAA;AAAA,IAAoB,mBAAA;EACpB,IAAA;AAAA,IAAkB,oBAAA;EAClB,IAAA;AAAA,IAAmB,kBAAA;AAAA,KAEb,gBAAA;EACX,OAAA,EAAS,aAAA;EACT,OAAA,GAAU,IAAA,CAAK,mBAAA;EACf,KAAA,GAAQ,IAAA,CAAK,oBAAA;EACb,MAAA,GAAS,IAAA,CAAK,kBAAA;AAAA;AAAA,iBAGC,kBAAA,CAAmB,KAAA,YAAiB,KAAA,IAAS,gBAAA;AAAA,KAUjD,eAAA;EACX,KAAA;EACA,OAAA;AAAA;;;iBC7Fe,mBAAA,CACf,MAAA,EAAQ,kBAAA,EACR,OAAA,GAAS,cAAA;EACL,MAAA,EAAQ,YAAA;EAAc,OAAA;EAAiB,QAAA,EAAU,aAAA;AAAA;;;iBCLtC,oBAAA,CACf,MAAA,EAAQ,mBAAA,EACR,OAAA,GAAS,cAAA;EACL,MAAA,EAAQ,YAAA;EAAc,OAAA;EAAiB,QAAA,EAAU,aAAA;AAAA;;;iBCStC,qBAAA,CACf,MAAA,EAAQ,oBAAA,EACR,OAAA,GAAS,cAAA;EACL,MAAA,EAAQ,YAAA;EAAc,OAAA;EAAiB,QAAA,EAAU,aAAA;AAAA;;;iBCnDtC,qBAAA,CACf,MAAA,EAAQ,mBAAA,GACN,eAAA;;;iBCFa,oBAAA,CACf,MAAA,EAAQ,kBAAA,GACN,eAAA;;;iBCFa,sBAAA,CACf,MAAA,EAAQ,oBAAA,GACN,eAAA;;;iBCuBa,sBAAA,CACf,MAAA,EAAQ,gBAAA,GACN,WAAA;AAAA,iBAkBa,aAAA,CAAc,KAAA,EAAO,WAAA,EAAa,OAAA,GAAU,cAAA;UAAc,YAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/types.ts","../src/documents/types.ts","../src/documents/helpers.ts","../src/documents/index.ts","../src/validate.ts","../src/validate-cookie.ts","../src/validate-terms.ts","../src/index.ts"],"mappings":";KAAY,YAAA;AAAA,KAEA,cAAA;EAAmB,OAAA,EAAS,YAAA;AAAA;AAAA,KAE5B,YAAA;AAAA,KAEA,aAAA;EACX,IAAA;EACA,SAAA;EACA,OAAA;EACA,OAAA;AAAA;AAAA,KAGW,mBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,aAAA,EAAe,MAAA;EACf,UAAA;EACA,SAAA,EAAW,MAAA;EACX,OAAA;IAAW,SAAA;IAAoB,SAAA;IAAoB,SAAA;EAAA;EACnD,YAAA;IAAgB,IAAA;IAAc,OAAA;EAAA;EAC9B,UAAA;EACA,aAAA,EAAe,YAAA;EAEf,QAAA;IACC,QAAA;IACA,SAAA;EAAA;AAAA;AAAA,KAIU,uBAAA;AAAA,KAKA,oBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,UAAA;IAAc,OAAA;EAAA;EACd,WAAA;IAAgB,UAAA;IAAoB,wBAAA;EAAA;EACpC,QAAA;IACC,oBAAA;IACA,6BAAA;IACA,mBAAA;EAAA;EAED,cAAA;EACA,WAAA;IACC,eAAA;IACA,uBAAA;IACA,kBAAA;IACA,uBAAA;EAAA;EAED,oBAAA;IACC,kBAAA;IACA,eAAA;EAAA;EAED,QAAA;IACC,eAAA;IACA,YAAA;IACA,kBAAA;EAAA;EAED,YAAA;IAAiB,iBAAA;IAA4B,kBAAA;EAAA;EAC7C,WAAA;IACC,mBAAA;IACA,gBAAA;IACA,mBAAA;EAAA;EAED,WAAA;IAAgB,mBAAA;IAA8B,YAAA;EAAA;EAC9C,qBAAA;IACC,uBAAA;IACA,YAAA;EAAA;EAED,eAAA;IAAoB,sBAAA;IAAiC,KAAA;EAAA;EACrD,kBAAA;IAAuB,IAAA;IAAc,OAAA;EAAA;EACrC,iBAAA;IACC,MAAA,EAAQ,uBAAA;IACR,KAAA;IACA,iBAAA;EAAA;EAED,YAAA;IAAgB,YAAA;EAAA;EAChB,aAAA;IAAkB,YAAA;IAAsB,gBAAA;EAAA;EACxC,gBAAA;AAAA;AAAA,KAGW,kBAAA;EACX,aAAA;EACA,OAAA,EAAS,aAAA;EACT,OAAA;IACC,SAAA;IACA,SAAA;IACA,UAAA;IACA,SAAA;EAAA;EAED,YAAA;IAAiB,IAAA;IAAc,OAAA;IAAiB,SAAA;EAAA;EAChD,oBAAA;EACA,gBAAA;IACC,SAAA;IACA,kBAAA;IACA,WAAA;EAAA;EAED,aAAA,EAAe,YAAA;AAAA;AAAA,KAGJ,WAAA;EACN,IAAA;AAAA,IAAoB,mBAAA;EACpB,IAAA;AAAA,IAAkB,oBAAA;EAClB,IAAA;AAAA,IAAmB,kBAAA;AAAA,KAEb,gBAAA;EACX,OAAA,EAAS,aAAA;EACT,OAAA,GAAU,IAAA,CAAK,mBAAA;EACf,KAAA,GAAQ,IAAA,CAAK,oBAAA;EACb,MAAA,GAAS,IAAA,CAAK,kBAAA;AAAA;AAAA,iBAGC,kBAAA,CAAmB,KAAA,YAAiB,KAAA,IAAS,gBAAA;AAAA,KAUjD,eAAA;EACX,KAAA;EACA,OAAA;AAAA;;;KC/HW,WAAA;EACX,MAAA;AAAA;AAAA,KAIW,QAAA;EAAa,IAAA;EAAc,KAAA;EAAe,OAAA,GAAU,WAAA;AAAA;AAAA,KACpD,QAAA;EAAa,IAAA;EAAc,KAAA;EAAe,OAAA,GAAU,WAAA;AAAA;AAAA,KACpD,UAAA;EACX,IAAA;EACA,KAAA;EACA,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,QAAA;EACX,IAAA;EACA,IAAA;EACA,KAAA;EACA,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,UAAA,GAAa,QAAA,GAAW,QAAA,GAAW,UAAA,GAAa,QAAA;AAAA,KAGhD,WAAA;EACX,IAAA;EACA,KAAA;EACA,KAAA;EACA,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,aAAA;EACX,IAAA;EACA,QAAA,EAAU,UAAA;EACV,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,YAAA;EACX,IAAA;EACA,QAAA,GAAW,UAAA,GAAa,QAAA;EACxB,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,QAAA;EACX,IAAA;EACA,OAAA;EACA,KAAA,EAAO,YAAA;EACP,OAAA,GAAU,WAAA;AAAA;AAAA,KAEC,WAAA,GAAc,WAAA,GAAc,aAAA,GAAgB,QAAA;AAAA,KAG5C,eAAA;EACX,IAAA;EACA,EAAA;EACA,OAAA,EAAS,WAAA;EACT,OAAA,GAAU,WAAA;AAAA;AAAA,KAGC,UAAA;AAAA,KAGA,QAAA;EACX,IAAA;EACA,UAAA,EAAY,UAAA;EACZ,QAAA,EAAU,eAAA;EACV,OAAA,GAAU,WAAA;AAAA;AAAA,KAIC,IAAA,GACT,QAAA,GACA,eAAA,GACA,WAAA,GACA,YAAA,GACA,UAAA;;;cCtDU,OAAA,GACZ,KAAA,UACA,cAAA,6BAA2C,WAAA,EAC3C,OAAA,GAAU,WAAA,KACR,WAAA;AAAA,cAUU,IAAA,GAAQ,KAAA,UAAe,OAAA,GAAU,WAAA,KAAc,QAAA;AAAA,cAK/C,IAAA,GAAQ,KAAA,UAAe,OAAA,GAAU,WAAA,KAAc,QAAA;AAAA,cAK/C,MAAA,GAAU,KAAA,UAAe,OAAA,GAAU,WAAA,KAAc,UAAA;AAAA,cAKjD,IAAA,GACZ,IAAA,UACA,KAAA,UACA,OAAA,GAAU,WAAA,KACR,QAAA;AAAA,cACU,CAAA,GACZ,QAAA,YAAoB,UAAA,KACpB,OAAA,GAAU,WAAA,KACR,aAAA;AAAA,cAKU,EAAA,GACZ,QAAA,YAAoB,UAAA,GAAa,QAAA,KACjC,OAAA,GAAU,WAAA,KACR,YAAA;AAAA,cAKU,EAAA,GAAM,KAAA,EAAO,YAAA,IAAgB,OAAA,GAAU,WAAA,KAAc,QAAA;AAAA,cAKrD,EAAA,GAAM,KAAA,EAAO,YAAA,IAAgB,OAAA,GAAU,WAAA,KAAc,QAAA;AAAA,cAMrD,OAAA,GACZ,EAAA,UACA,OAAA,EAAS,WAAA,IACT,OAAA,GAAU,WAAA,KACR,eAAA;;;iBC1Ea,OAAA,CAAQ,KAAA,EAAO,WAAA,GAAc,QAAA;;;iBCJ7B,qBAAA,CACf,MAAA,EAAQ,mBAAA,GACN,eAAA;;;iBCFa,oBAAA,CACf,MAAA,EAAQ,kBAAA,GACN,eAAA;;;iBCFa,sBAAA,CACf,MAAA,EAAQ,oBAAA,GACN,eAAA;;;iBC8Ca,sBAAA,CACf,MAAA,EAAQ,gBAAA,GACN,WAAA"}