@openpolicy/core 0.0.2 → 0.0.3

package/package.json

@@ -1,12 +1,27 @@
 {
 	"name": "@openpolicy/core",
-	"version": "0.0.2",
+	"version": "0.0.3",
 	"type": "module",
+	"description": "Core package for OpenPolicy",
+	"license": "MIT",
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/openpolicy/openpolicy",
+		"directory": "packages/core"
+	},
+	"files": [
+		"dist",
+		"README.md"
+	],
 	"exports": {
-		".": "./src/index.ts"
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
+		}
 	},
 	"scripts": {
-		"build": "bun build ./src/index.ts --outdir dist",
+		"dev": "bun build ./src/index.ts --outdir dist --watch",
+		"build": "bun build ./src/index.ts --outdir dist && tsc --emitDeclarationOnly",
 		"check-types": "tsc --noEmit",
 		"test": "bun test"
 	},

package/.turbo/turbo-build.log

@@ -1,6 +0,0 @@
-
-$ bun build ./src/index.ts --outdir dist
-Bundled 14 modules in 4ms
-
-  index.js  9.17 KB  (entry point)
-

package/.turbo/turbo-check-types.log

@@ -1 +0,0 @@
-$ tsc --noEmit

package/.turbo/turbo-test.log

@@ -1,18 +0,0 @@
-$ bun test
-bun test v1.2.21 (7c45ed97)
-
-src/index.test.ts:
-(pass) compilePolicy routes privacy input to markdown [1.32ms]
-
-src/privacy.test.ts:
-(pass) default markdown output contains company name [0.07ms]
-(pass) US-only config: no legal-basis or gdpr-supplement sections [0.04ms]
-(pass) EU config: legal-basis + gdpr-supplement sections present [0.19ms]
-(pass) CA config: ccpa-supplement section present [0.03ms]
-(pass) multi-jurisdiction (us + eu + ca): all jurisdiction sections present [0.01ms]
-(pass) requesting pdf format throws 'not yet implemented' [0.42ms]
-
- 7 pass
- 0 fail
- 17 expect() calls
-Ran 7 tests across 2 files. [68.00ms]

package/CHANGELOG.md

@@ -1,7 +0,0 @@
-# @openpolicy/core
-
-## 0.0.2
-
-### Patch Changes
-
-- Fixes

package/src/index.test.ts

@@ -1,28 +0,0 @@
-import { expect, test } from "bun:test";
-import { compilePolicy } from "./index";
-import type { PolicyInput } from "./types";
-
-const input: PolicyInput = {
-	type: "privacy",
-	effectiveDate: "2026-01-01",
-	company: {
-		name: "Acme Inc.",
-		legalName: "Acme Corporation",
-		address: "123 Main St, Springfield, USA",
-		contact: "privacy@acme.com",
-	},
-	dataCollected: { "Account Information": ["Name", "Email"] },
-	legalBasis: "Legitimate interests",
-	retention: { "Account data": "Until deletion" },
-	cookies: { essential: true, analytics: false, marketing: false },
-	thirdParties: [],
-	userRights: ["access"],
-	jurisdictions: ["us"],
-};
-
-test("compilePolicy routes privacy input to markdown", () => {
-	const results = compilePolicy(input);
-	expect(results).toBeArray();
-	expect(results[0]?.format).toBe("markdown");
-	expect(results[0]?.content).toContain("Acme Inc.");
-});

package/src/index.ts

@@ -1,23 +0,0 @@
-export { compilePrivacyPolicy } from "./privacy";
-export type {
-	CompileOptions,
-	Jurisdiction,
-	OutputFormat,
-	PolicyInput,
-	PolicySection,
-	PrivacyPolicyConfig,
-	ValidationIssue,
-} from "./types";
-export { validatePrivacyPolicy } from "./validate";
-
-import { compilePrivacyPolicy } from "./privacy";
-import type { CompileOptions, PolicyInput } from "./types";
-
-export function compilePolicy(input: PolicyInput, options?: CompileOptions) {
-	switch (input.type) {
-		case "privacy": {
-			const { type: _, ...config } = input;
-			return compilePrivacyPolicy(config, options);
-		}
-	}
-}

package/src/privacy.test.ts

@@ -1,80 +0,0 @@
-import { expect, test } from "bun:test";
-import { compilePrivacyPolicy } from "./privacy";
-import type { PrivacyPolicyConfig } from "./types";
-
-const baseConfig: PrivacyPolicyConfig = {
-	effectiveDate: "2026-01-01",
-	company: {
-		name: "Acme Inc.",
-		legalName: "Acme Corporation",
-		address: "123 Main St, Springfield, USA",
-		contact: "privacy@acme.com",
-	},
-	dataCollected: {
-		"Account Information": ["Name", "Email address"],
-		"Usage Data": ["IP address", "Browser type"],
-	},
-	legalBasis: "Legitimate interests and consent",
-	retention: {
-		"Account data": "Until account deletion",
-		"Usage logs": "90 days",
-	},
-	cookies: { essential: true, analytics: true, marketing: false },
-	thirdParties: [{ name: "Stripe", purpose: "Payment processing" }],
-	userRights: ["access", "erasure", "portability"],
-	jurisdictions: ["us"],
-};
-
-test("default markdown output contains company name", () => {
-	const results = compilePrivacyPolicy(baseConfig);
-	expect(results[0]?.format).toBe("markdown");
-	expect(results[0]?.content).toContain("Acme Inc.");
-});
-
-test("US-only config: no legal-basis or gdpr-supplement sections", () => {
-	const results = compilePrivacyPolicy(baseConfig);
-	const ids = results[0]?.sections.map((s) => s.id);
-	expect(ids).not.toContain("legal-basis");
-	expect(ids).not.toContain("gdpr-supplement");
-	expect(ids).not.toContain("ccpa-supplement");
-});
-
-test("EU config: legal-basis + gdpr-supplement sections present", () => {
-	const config: PrivacyPolicyConfig = { ...baseConfig, jurisdictions: ["eu"] };
-	const results = compilePrivacyPolicy(config);
-	const ids = results[0]?.sections.map((s) => s.id);
-	expect(ids).toContain("legal-basis");
-	expect(ids).toContain("gdpr-supplement");
-});
-
-test("CA config: ccpa-supplement section present", () => {
-	const config: PrivacyPolicyConfig = { ...baseConfig, jurisdictions: ["ca"] };
-	const results = compilePrivacyPolicy(config);
-	const ids = results[0]?.sections.map((s) => s.id);
-	expect(ids).toContain("ccpa-supplement");
-	expect(ids).not.toContain("legal-basis");
-	expect(ids).not.toContain("gdpr-supplement");
-});
-
-test("multi-jurisdiction (us + eu + ca): all jurisdiction sections present", () => {
-	const config: PrivacyPolicyConfig = {
-		...baseConfig,
-		jurisdictions: ["us", "eu", "ca"],
-	};
-	const results = compilePrivacyPolicy(config);
-
-	if (results.length === 0) {
-		throw new Error("No results");
-	}
-
-	const ids = results[0]?.sections.map((s) => s.id);
-	expect(ids).toContain("legal-basis");
-	expect(ids).toContain("gdpr-supplement");
-	expect(ids).toContain("ccpa-supplement");
-});
-
-test("requesting pdf format throws 'not yet implemented'", () => {
-	expect(() => compilePrivacyPolicy(baseConfig, { formats: ["pdf"] })).toThrow(
-		"not yet implemented",
-	);
-});

package/src/privacy.ts

@@ -1,54 +0,0 @@
-import { renderMarkdown } from "./renderers/markdown";
-import { buildCcpaSupplement } from "./templates/privacy/ccpa-supplement";
-import { buildContact } from "./templates/privacy/contact";
-import { buildCookies } from "./templates/privacy/cookies";
-import { buildDataCollected } from "./templates/privacy/data-collected";
-import { buildDataRetention } from "./templates/privacy/data-retention";
-import { buildGdprSupplement } from "./templates/privacy/gdpr-supplement";
-import { buildIntroduction } from "./templates/privacy/introduction";
-import { buildLegalBasis } from "./templates/privacy/legal-basis";
-import { buildThirdParties } from "./templates/privacy/third-parties";
-import { buildUserRights } from "./templates/privacy/user-rights";
-import type {
-	CompileOptions,
-	OutputFormat,
-	PolicySection,
-	PrivacyPolicyConfig,
-} from "./types";
-
-const SECTION_BUILDERS: ((
-	config: PrivacyPolicyConfig,
-) => PolicySection | null)[] = [
-	buildIntroduction,
-	buildDataCollected,
-	buildLegalBasis,
-	buildDataRetention,
-	buildCookies,
-	buildThirdParties,
-	buildUserRights,
-	buildGdprSupplement,
-	buildCcpaSupplement,
-	buildContact,
-];
-
-export function compilePrivacyPolicy(
-	config: PrivacyPolicyConfig,
-	options: CompileOptions = { formats: ["markdown"] },
-): { format: OutputFormat; content: string; sections: PolicySection[] }[] {
-	const sections = SECTION_BUILDERS.map((builder) => builder(config)).filter(
-		(s): s is PolicySection => s !== null,
-	);
-
-	return options.formats.map((format) => {
-		switch (format) {
-			case "markdown":
-				return { format, content: renderMarkdown(sections), sections };
-			case "pdf":
-				throw new Error("pdf format is not yet implemented");
-			case "jsx":
-				throw new Error("jsx format is not yet implemented");
-			default:
-				throw new Error(`Unsupported format: ${format}`);
-		}
-	});
-}

package/src/renderers/markdown.ts

@@ -1,7 +0,0 @@
-import type { PolicySection } from "../types";
-
-export function renderMarkdown(sections: PolicySection[]): string {
-	return sections
-		.map((section) => `## ${section.title}\n\n${section.body}`)
-		.join("\n\n---\n\n");
-}

package/src/templates/privacy/ccpa-supplement.ts

@@ -1,23 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildCcpaSupplement(
-	config: PrivacyPolicyConfig,
-): PolicySection | null {
-	if (!config.jurisdictions.includes("ca")) return null;
-
-	return {
-		id: "ccpa-supplement",
-		title: "California Privacy Rights (CCPA)",
-		body: `This section applies to California residents under the California Consumer Privacy Act (CCPA) and the California Privacy Rights Act (CPRA).
-
-**Categories of Personal Information Collected:** We collect the categories of personal information described in the "Information We Collect" section above.
-
-**Your California Rights:**
-- **Right to Know:** You may request information about the personal information we have collected about you, including the categories of sources, the business purpose for collection, and the categories of third parties with whom we share information.
-- **Right to Delete:** You may request deletion of personal information we have collected from you, subject to certain exceptions.
-- **Right to Opt-Out:** You may opt out of the sale or sharing of your personal information.
-- **Right to Non-Discrimination:** We will not discriminate against you for exercising your California privacy rights.
-
-To exercise your rights, contact us at ${config.company.contact}.`,
-	};
-}

package/src/templates/privacy/contact.ts

@@ -1,14 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildContact(config: PrivacyPolicyConfig): PolicySection {
-	return {
-		id: "contact",
-		title: "Contact Us",
-		body: `If you have questions or concerns about this Privacy Policy or our data practices, please contact us:
-
-**${config.company.legalName}**
-${config.company.address}
-
-Email: ${config.company.contact}`,
-	};
-}

package/src/templates/privacy/cookies.ts

@@ -1,28 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildCookies(config: PrivacyPolicyConfig): PolicySection {
-	const enabled: string[] = [];
-	if (config.cookies.essential)
-		enabled.push(
-			"**Essential cookies** — required for the service to function",
-		);
-	if (config.cookies.analytics)
-		enabled.push(
-			"**Analytics cookies** — help us understand how visitors interact with our service",
-		);
-	if (config.cookies.marketing)
-		enabled.push(
-			"**Marketing cookies** — used to deliver relevant advertisements",
-		);
-
-	const body =
-		enabled.length > 0
-			? `We use the following types of cookies and tracking technologies:\n\n${enabled.map((e) => `- ${e}`).join("\n")}`
-			: "We do not use cookies or tracking technologies on our service.";
-
-	return {
-		id: "cookies",
-		title: "Cookies and Tracking",
-		body,
-	};
-}

package/src/templates/privacy/data-collected.ts

@@ -1,15 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildDataCollected(config: PrivacyPolicyConfig): PolicySection {
-	const entries = Object.entries(config.dataCollected);
-	const lines = entries.map(([category, items]) => {
-		const itemList = items.map((item) => `  - ${item}`).join("\n");
-		return `**${category}:**\n${itemList}`;
-	});
-
-	return {
-		id: "data-collected",
-		title: "Information We Collect",
-		body: `We collect the following categories of information:\n\n${lines.join("\n\n")}`,
-	};
-}

package/src/templates/privacy/data-retention.ts

@@ -1,14 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildDataRetention(config: PrivacyPolicyConfig): PolicySection {
-	const entries = Object.entries(config.retention);
-	const lines = entries.map(
-		([category, period]) => `- **${category}:** ${period}`,
-	);
-
-	return {
-		id: "data-retention",
-		title: "Data Retention",
-		body: `We retain your information for the following periods:\n\n${lines.join("\n")}`,
-	};
-}

package/src/templates/privacy/gdpr-supplement.ts

@@ -1,19 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildGdprSupplement(
-	config: PrivacyPolicyConfig,
-): PolicySection | null {
-	if (!config.jurisdictions.includes("eu")) return null;
-
-	return {
-		id: "gdpr-supplement",
-		title: "GDPR Supplemental Disclosures",
-		body: `This section applies to individuals in the European Economic Area (EEA) under the General Data Protection Regulation (GDPR).
-
-**Data Controller:** ${config.company.legalName}, ${config.company.address}
-
-**Your GDPR Rights:** In addition to the rights listed above, you have the right to lodge a complaint with your local data protection authority if you believe we have not handled your data in accordance with applicable law.
-
-**International Transfers:** If we transfer your personal data outside the EEA, we ensure adequate safeguards are in place in accordance with GDPR requirements.`,
-	};
-}

package/src/templates/privacy/introduction.ts

@@ -1,13 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildIntroduction(config: PrivacyPolicyConfig): PolicySection {
-	return {
-		id: "introduction",
-		title: "Introduction",
-		body: `This Privacy Policy describes how ${config.company.name} ("we", "us", or "our") collects, uses, and shares information about you when you use our services.
-
-**Effective Date:** ${config.effectiveDate}
-
-If you have questions about this policy, please contact us at ${config.company.contact}.`,
-	};
-}

package/src/templates/privacy/legal-basis.ts

@@ -1,13 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildLegalBasis(
-	config: PrivacyPolicyConfig,
-): PolicySection | null {
-	if (!config.jurisdictions.includes("eu")) return null;
-
-	return {
-		id: "legal-basis",
-		title: "Legal Basis for Processing",
-		body: `We process your personal data under the following legal basis:\n\n${config.legalBasis}`,
-	};
-}

package/src/templates/privacy/third-parties.ts

@@ -1,18 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-export function buildThirdParties(config: PrivacyPolicyConfig): PolicySection {
-	const lines = config.thirdParties.map(
-		(tp) => `- **${tp.name}** — ${tp.purpose}`,
-	);
-
-	const body =
-		lines.length > 0
-			? `We share data with the following third-party services:\n\n${lines.join("\n")}`
-			: "We do not share your data with third-party services.";
-
-	return {
-		id: "third-parties",
-		title: "Third-Party Services",
-		body,
-	};
-}

package/src/templates/privacy/user-rights.ts

@@ -1,26 +0,0 @@
-import type { PolicySection, PrivacyPolicyConfig } from "../../types";
-
-const RIGHTS_LABELS: Record<string, string> = {
-	access: "Right to access your personal data",
-	rectification: "Right to correct inaccurate data",
-	erasure: "Right to request deletion of your data",
-	portability: "Right to receive your data in a portable format",
-	restriction: "Right to restrict how we process your data",
-	objection: "Right to object to processing",
-	opt_out_sale: "Right to opt out of the sale of your personal information",
-	non_discrimination:
-		"Right to non-discriminatory treatment for exercising your rights",
-};
-
-export function buildUserRights(config: PrivacyPolicyConfig): PolicySection {
-	const lines = config.userRights.map((right) => {
-		const label = RIGHTS_LABELS[right] ?? right;
-		return `- ${label}`;
-	});
-
-	return {
-		id: "user-rights",
-		title: "Your Rights",
-		body: `You have the following rights regarding your personal data:\n\n${lines.join("\n")}`,
-	};
-}

package/src/types.ts

@@ -1,35 +0,0 @@
-export type OutputFormat = "markdown" | "pdf" | "jsx";
-
-export type CompileOptions = { formats: OutputFormat[] };
-
-export type PolicySection = {
-	id: string;
-	title: string;
-	body: string;
-};
-
-export type Jurisdiction = "us" | "eu" | "ca" | "au" | "nz" | "other";
-
-export type PrivacyPolicyConfig = {
-	effectiveDate: string;
-	company: {
-		name: string;
-		legalName: string;
-		address: string;
-		contact: string;
-	};
-	dataCollected: Record<string, string[]>;
-	legalBasis: string;
-	retention: Record<string, string>;
-	cookies: { essential: boolean; analytics: boolean; marketing: boolean };
-	thirdParties: { name: string; purpose: string }[];
-	userRights: string[];
-	jurisdictions: Jurisdiction[];
-};
-
-export type PolicyInput = { type: "privacy" } & PrivacyPolicyConfig;
-
-export type ValidationIssue = {
-	level: "error" | "warning";
-	message: string;
-};

package/src/validate.ts

@@ -1,67 +0,0 @@
-import type { PrivacyPolicyConfig, ValidationIssue } from "./types";
-
-export function validatePrivacyPolicy(
-	config: PrivacyPolicyConfig,
-): ValidationIssue[] {
-	const issues: ValidationIssue[] = [];
-
-	// Required fields
-	if (!config.effectiveDate)
-		issues.push({ level: "error", message: "effectiveDate is required" });
-	if (!config.company.name)
-		issues.push({ level: "error", message: "company.name is required" });
-	if (!config.company.legalName)
-		issues.push({ level: "error", message: "company.legalName is required" });
-	if (!config.company.address)
-		issues.push({ level: "error", message: "company.address is required" });
-	if (!config.company.contact)
-		issues.push({ level: "error", message: "company.contact is required" });
-	if (Object.keys(config.dataCollected).length === 0)
-		issues.push({
-			level: "error",
-			message: "dataCollected must have at least one entry",
-		});
-	if (config.userRights.length === 0)
-		issues.push({
-			level: "warning",
-			message: "userRights is empty — consider listing applicable rights",
-		});
-
-	// GDPR checks
-	if (config.jurisdictions.includes("eu")) {
-		if (!config.legalBasis)
-			issues.push({ level: "error", message: "GDPR requires a legalBasis" });
-		for (const right of [
-			"access",
-			"rectification",
-			"erasure",
-			"portability",
-			"restriction",
-			"objection",
-		]) {
-			if (!config.userRights.includes(right))
-				issues.push({
-					level: "warning",
-					message: `GDPR recommends including the "${right}" right`,
-				});
-		}
-	}
-
-	// CCPA checks
-	if (config.jurisdictions.includes("ca")) {
-		for (const right of [
-			"access",
-			"erasure",
-			"opt_out_sale",
-			"non_discrimination",
-		]) {
-			if (!config.userRights.includes(right))
-				issues.push({
-					level: "warning",
-					message: `CCPA recommends including the "${right}" right`,
-				});
-		}
-	}
-
-	return issues;
-}

package/tsconfig.json

@@ -1,4 +0,0 @@
-{
-	"extends": "@openpolicy/tooling/base",
-	"include": ["src"]
-}