@openpolicy/sdk/dist/auto-collected.d.ts

Public API for defining privacy policies with OpenPolicy

//#region src/auto-collected.d.ts
/**
 * Populated by `@openpolicy/vite` during a Vite build from `collecting()` calls
 * across the project. The plugin also emits `openpolicy.gen.ts` (alongside
 * your `openpolicy.ts`, meant to be committed) which augments
 * `ScannedCollectionKeys` so `defineConfig` requires `data.context` to cover
 * every scanned key.
 *
 * @example
 * ```ts
 * import { ContractPrerequisite, dataCollected, defineConfig, LegalBases } from "@openpolicy/sdk";
 *
 * export default defineConfig({
 *   data: {
 *     collected: dataCollected,
 *     context: {
 *       "Account Information": {
 *         purpose: "To authenticate users",
 *         lawfulBasis: LegalBases.Contract,
 *         retention: "Until account deletion",
 *         provision: ContractPrerequisite("We cannot operate your account."),
 *       },
 *     },
 *   },
 * });
 * ```
 */
declare const dataCollected: Record<keyof ScannedCollectionKeys & string, string[]>;
/**
 * Augmented by `openpolicy.gen.ts` (emitted by `@openpolicy/vite` alongside
 * your config, meant to be committed) with one key per scanned `collecting()`
 * category. `defineConfig` reads this interface to require a `data.context`
 * entry for every scanned key.
 */
interface ScannedCollectionKeys {}
/**
 * Placeholder populated by `@openpolicy/vite` during a Vite
 * build. The plugin intercepts this module's resolution and replaces it with
 * the third-party services discovered via `thirdParty()` calls, so the literal
 * default below is only used as a fallback when no auto-collect plugin is
 * active — in which case spreading it into `thirdParties` is a no-op.
 *
 * @example
 * ```ts
 * import { thirdParties, defineConfig } from "@openpolicy/sdk";
 *
 * export default defineConfig({
 *   privacy: {
 *     thirdParties: [
 *       ...thirdParties,
 *       { name: "Manually-added Service", purpose: "Analytics", policyUrl: "https://example.com/privacy" },
 *     ],
 *   },
 * });
 * ```
 */
declare const thirdParties: {
  name: string;
  purpose: string;
  policyUrl: string;
}[];
/**
 * Placeholder populated by `@openpolicy/vite` during a Vite build. The plugin
 * intercepts this module's resolution and replaces it with the cookie
 * categories discovered via `defineCookie()` calls and optionally the
 * project's `package.json`. The literal default below is only used as a
 * fallback when no plugin is active — `essential` is always true; other
 * categories default to false.
 *
 * Spread into `cookies.used` and pair with `cookies.context` (whose
 * required keys are derived from this sentinel via `ScannedCookieKeys`).
 *
 * @example
 * ```ts
 * import { cookies, defineConfig, LegalBases } from "@openpolicy/sdk";
 *
 * export default defineConfig({
 *   company: { ... },
 *   effectiveDate: "2026-01-01",
 *   jurisdictions: ["eu", "us-ca"],
 *   cookies: {
 *     used: cookies,
 *     context: {
 *       essential: { lawfulBasis: LegalBases.LegalObligation },
 *       analytics: { lawfulBasis: LegalBases.Consent },
 *     },
 *   },
 * });
 * ```
 */
declare const cookies: {
  essential: true;
  [key: string]: boolean;
};
/**
 * Augmented by `openpolicy.gen.ts` (emitted by `@openpolicy/vite` alongside
 * your config, meant to be committed) with one key per scanned cookie
 * category. `defineConfig` reads this interface to require a
 * `cookies.context` entry for every scanned cookie category.
 */
interface ScannedCookieKeys {}
//#endregion
export { ScannedCollectionKeys, ScannedCookieKeys, cookies, dataCollected, thirdParties };
//# sourceMappingURL=auto-collected.d.ts.map