@openpolicy/vite 0.0.2 → 0.0.5

package/dist/index.d.ts

@@ -1,6 +1,11 @@
-export declare function openPolicy(_options?: {
-    formats?: Array<"jsx" | "pdf" | "markdown">;
-}): {
-    name: string;
-};
+import type { Plugin } from "vite";
+import type { OutputFormat } from "@openpolicy/core";
+export interface OpenPolicyOptions {
+    config?: string;
+    formats?: OutputFormat[];
+    outDir?: string;
+}
+export declare function writeScaffold(configPath: string): Promise<void>;
+export declare function generatePolicies(configPath: string, outDir: string, formats: OutputFormat[]): Promise<void>;
+export declare function openPolicy(options?: OpenPolicyOptions): Plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wBAAgB,UAAU,CAAC,QAAQ,CAAC,EAAE;IACrC,OAAO,CAAC,EAAE,KAAK,CAAC,KAAK,GAAG,KAAK,GAAG,UAAU,CAAC,CAAC;CAC5C;;EAEA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,KAAK,EAAE,YAAY,EAAuB,MAAM,kBAAkB,CAAC;AAK1E,MAAM,WAAW,iBAAiB;IACjC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,MAAM,CAAC,EAAE,MAAM,CAAC;CAChB;AA0BD,wBAAsB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAErE;AAED,wBAAsB,gBAAgB,CACrC,UAAU,EAAE,MAAM,EAClB,MAAM,EAAE,MAAM,EACd,OAAO,EAAE,YAAY,EAAE,GACrB,OAAO,CAAC,IAAI,CAAC,CA8Bf;AAED,wBAAgB,UAAU,CAAC,OAAO,GAAE,iBAAsB,GAAG,MAAM,CAoClE"}

package/dist/index.js

@@ -1,7 +1,348 @@
+// ../core/dist/index.js
+function renderHTML(sections) {
+  return sections.map((section) => `<h2>${section.title}</h2><p>${section.body}</p>`).join(`
+`);
+}
+function renderMarkdown(sections) {
+  return sections.map((section) => `## ${section.title}
+
+${section.body}`).join(`
+
+---
+
+`);
+}
+function buildCcpaSupplement(config) {
+  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}.`
+  };
+}
+function buildContact(config) {
+  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}`
+  };
+}
+function buildCookies(config) {
+  const enabled = [];
+  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:
+
+${enabled.map((e) => `- ${e}`).join(`
+`)}` : "We do not use cookies or tracking technologies on our service.";
+  return {
+    id: "cookies",
+    title: "Cookies and Tracking",
+    body
+  };
+}
+function buildDataCollected(config) {
+  const entries = Object.entries(config.dataCollected);
+  const lines = entries.map(([category, items]) => {
+    const itemList = items.map((item) => `  - ${item}`).join(`
+`);
+    return `**${category}:**
+${itemList}`;
+  });
+  return {
+    id: "data-collected",
+    title: "Information We Collect",
+    body: `We collect the following categories of information:
+
+${lines.join(`
+
+`)}`
+  };
+}
+function buildDataRetention(config) {
+  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:
+
+${lines.join(`
+`)}`
+  };
+}
+function buildGdprSupplement(config) {
+  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.`
+  };
+}
+function buildIntroduction(config) {
+  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}.`
+  };
+}
+function buildLegalBasis(config) {
+  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:
+
+${config.legalBasis}`
+  };
+}
+function buildThirdParties(config) {
+  const lines = config.thirdParties.map((tp) => `- **${tp.name}** — ${tp.purpose}`);
+  const body = lines.length > 0 ? `We share data with the following third-party services:
+
+${lines.join(`
+`)}` : "We do not share your data with third-party services.";
+  return {
+    id: "third-parties",
+    title: "Third-Party Services",
+    body
+  };
+}
+var RIGHTS_LABELS = {
+  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"
+};
+function buildUserRights(config) {
+  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:
+
+${lines.join(`
+`)}`
+  };
+}
+var SECTION_BUILDERS = [
+  buildIntroduction,
+  buildDataCollected,
+  buildLegalBasis,
+  buildDataRetention,
+  buildCookies,
+  buildThirdParties,
+  buildUserRights,
+  buildGdprSupplement,
+  buildCcpaSupplement,
+  buildContact
+];
+function compilePrivacyPolicy(config, options = { formats: ["markdown"] }) {
+  const sections = SECTION_BUILDERS.map((builder) => builder(config)).filter((s) => s !== null);
+  return options.formats.map((format) => {
+    switch (format) {
+      case "markdown":
+        return { format, content: renderMarkdown(sections), sections };
+      case "html":
+        return { format, content: renderHTML(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}`);
+    }
+  });
+}
+function validatePrivacyPolicy(config) {
+  const issues = [];
+  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"
+    });
+  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`
+        });
+    }
+  }
+  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;
+}
+function compilePolicy(input, options) {
+  switch (input.type) {
+    case "privacy": {
+      const { type: _, ...config } = input;
+      return compilePrivacyPolicy(config, options);
+    }
+  }
+}
+
 // src/index.ts
-function openPolicy(_options) {
-  return { name: "openpolicy" };
+import { resolve, join } from "node:path";
+import { writeFile, mkdir, access } from "node:fs/promises";
+var SCAFFOLD_TEMPLATE = `import { definePrivacyPolicy } from "@openpolicy/sdk";
+
+export default definePrivacyPolicy({
+  effectiveDate: "${new Date().toISOString().slice(0, 10)}",
+  company: {
+    name: "Your Company",
+    legalName: "Your Company, Inc.",
+    address: "123 Main St, City, State, ZIP",
+    contact: "privacy@yourcompany.com",
+  },
+  dataCollected: {
+    "Personal Information": ["Full name", "Email address"],
+  },
+  legalBasis: "Legitimate interests and consent",
+  retention: {
+    "All personal data": "As long as necessary for the purposes described in this policy",
+  },
+  cookies: { essential: true, analytics: false, marketing: false },
+  thirdParties: [],
+  userRights: ["access", "erasure"],
+  jurisdictions: ["us"],
+});
+`;
+async function writeScaffold(configPath) {
+  await writeFile(configPath, SCAFFOLD_TEMPLATE, "utf8");
+}
+async function generatePolicies(configPath, outDir, formats) {
+  const mod = await import(`${configPath}?t=${Date.now()}`);
+  const config = mod["default"] ?? mod["module.exports"] ?? mod;
+  if (config === null || config === undefined || typeof config !== "object") {
+    throw new Error(`[openpolicy] Config must export a non-null object: ${configPath}`);
+  }
+  const issues = validatePrivacyPolicy(config);
+  for (const issue of issues) {
+    if (issue.level === "error") {
+      throw new Error(`[openpolicy] Validation error: ${issue.message}`);
+    }
+    console.warn(`[openpolicy] Warning: ${issue.message}`);
+  }
+  const results = compilePolicy({ type: "privacy", ...config }, { formats });
+  await mkdir(outDir, { recursive: true });
+  for (const result of results) {
+    const ext = result.format === "markdown" ? "md" : result.format;
+    await writeFile(join(outDir, `privacy-policy.${ext}`), result.content, "utf8");
+  }
+}
+function openPolicy(options = {}) {
+  const formats = options.formats ?? ["markdown"];
+  let resolvedConfigPath;
+  let resolvedOutDir;
+  return {
+    name: "openpolicy",
+    configResolved(config) {
+      resolvedConfigPath = resolve(config.root, options.config ?? "privacy.config.ts");
+      resolvedOutDir = resolve(config.root, options.outDir ?? "public/policies");
+    },
+    async buildStart() {
+      const configExists = await access(resolvedConfigPath).then(() => true, () => false);
+      if (!configExists) {
+        await writeScaffold(resolvedConfigPath);
+        console.log(`[openpolicy] Scaffolded config at ${resolvedConfigPath}`);
+        return;
+      }
+      await generatePolicies(resolvedConfigPath, resolvedOutDir, formats);
+    },
+    configureServer(server) {
+      server.watcher.add(resolvedConfigPath);
+      server.watcher.on("change", async (path) => {
+        if (path !== resolvedConfigPath)
+          return;
+        try {
+          await generatePolicies(resolvedConfigPath, resolvedOutDir, formats);
+          console.log("[openpolicy] Policies regenerated");
+        } catch (err) {
+          console.error("[openpolicy]", err);
+        }
+      });
+    }
+  };
 }
 export {
-  openPolicy
+  writeScaffold,
+  openPolicy,
+  generatePolicies
 };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@openpolicy/vite",
-	"version": "0.0.2",
+	"version": "0.0.5",
 	"type": "module",
 	"description": "Vite plugin for compiling OpenPolicy privacy policy documents at build time",
 	"license": "MIT",
@@ -14,18 +14,14 @@
 		"README.md"
 	],
 	"exports": {
-		".": "./src/index.ts"
-	},
-	"publishConfig": {
-		"exports": {
-			".": {
-				"import": "./dist/index.js",
-				"types": "./dist/index.d.ts"
-			}
+		".": {
+			"import": "./dist/index.js",
+			"types": "./dist/index.d.ts"
 		}
 	},
 	"scripts": {
-		"build": "bun build ./src/index.ts --outdir dist && tsc --emitDeclarationOnly",
+		"dev": "bun build ./src/index.ts --outdir dist --watch",
+		"build": "bun build ./src/index.ts --outdir dist --target node && tsc --emitDeclarationOnly",
 		"check-types": "tsc --noEmit",
 		"test": "bun test"
 	},
@@ -33,6 +29,8 @@
 		"vite": ">=4.0.0"
 	},
 	"devDependencies": {
-		"@openpolicy/tooling": "workspace:*"
+		"@openpolicy/core": "workspace:*",
+		"@openpolicy/tooling": "workspace:*",
+		"vite": "^5.0.0"
 	}
 }