@theplaintheory/svelte 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,54 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @theplaintheory/svelte
+
+Svelte and SvelteKit stores for [Plain Theory](https://www.theplaintheory.in) consent, with types. Svelte 4 and 5. SSR-safe.
+
+```bash
+npm install @theplaintheory/svelte
+```
+
+## Set up
+
+Put the script tag first in `<head>` in `src/app.html` (copy it from the dashboard's **Install** page), or load it from your root layout:
+
+```svelte
+<!-- src/routes/+layout.svelte -->
+<script lang="ts">
+  import { onMount } from "svelte";
+  import { init } from "@theplaintheory/svelte";
+  onMount(() => init({ siteKey: "pk_YOUR_SITE_KEY" }));
+</script>
+
+<slot />
+```
+
+## Use it
+
+```svelte
+<script lang="ts">
+  import { allowed, consent, consentScript, openPreferences, ready, setLanguage } from "@theplaintheory/svelte";
+  const marketing = allowed("marketing");
+</script>
+
+<div use:consentScript={{ category: "analytics", src: "https://www.googletagmanager.com/gtag/js?id=G-XXXX" }}></div>
+
+{#if $marketing}
+  <iframe src="https://www.youtube.com/embed/…" title="Video"></iframe>
+{:else}
+  <p>Allow marketing cookies to watch this video.</p>
+{/if}
+
+{#if $ready}<p>Language: {$consent?.language}</p>{/if}
+<button on:click={openPreferences}>Privacy choices</button>
+```
+
+| Export | What it is |
+| --- | --- |
+| `init(options)` | Loads the script once (browser only). |
+| `consent` | Store: the state, `null` on the server and until ready. |
+| `ready`, `allowed(category)` | Boolean stores. |
+| `consentScript` | Action: add a third-party script once allowed. |
+| `acceptAll`, `rejectAll`, `setConsent`, `openPreferences`, `revoke`, `setLanguage` | Actions; queued until the script loads. |
+
+Everything from [`@theplaintheory/consent`](https://www.npmjs.com/package/@theplaintheory/consent) is re-exported.
+
+MIT · [Docs](https://www.theplaintheory.in/docs#frameworks)

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import { type Category, type ConsentState, type LoadOptions } from "@theplaintheory/consent";
+import { type Readable } from "svelte/store";
+export type { Categories, Category, ConsentState, Framework, LoadOptions, PlainConsentApi } from "@theplaintheory/consent";
+export { getConsent, isAllowed, loadPlainConsent, loadScriptWhenAllowed, onConsentChange, whenAllowed } from "@theplaintheory/consent";
+/**
+ * Load plain-consent.js once. Call from a browser-only place, e.g. `onMount` in your root
+ * +layout.svelte. Safe to call on the server: it resolves to undefined there.
+ */
+export declare function init(options: LoadOptions): Promise<import("@theplaintheory/consent").PlainConsentApi | undefined>;
+/** Consent state: null on the server and until the script is ready. Works with `$consent` in Svelte 4 and 5. */
+export declare const consent: Readable<ConsentState | null>;
+/** True once the script has loaded the site's settings (false on the server). */
+export declare const ready: Readable<boolean>;
+/** A store that is true while `category` is allowed (`essential` is always true). */
+export declare const allowed: (category: Category) => Readable<boolean>;
+/**
+ * Svelte action: add a third-party script once `category` is allowed (deduplicated, never removed).
+ *
+ *   <div use:consentScript={{ category: "analytics", src: "https://www.googletagmanager.com/gtag/js?id=G-XXXX" }} />
+ */
+export declare function consentScript(_node: Element, params: {
+    category: Category;
+    src: string;
+    attributes?: Record<string, string>;
+}): {};
+/** Actions that queue safely before the script loads. */
+export declare const acceptAll: () => void;
+export declare const rejectAll: () => void;
+export declare const setConsent: (partial: Partial<Record<Category, boolean>>) => void;
+/** open the preferences panel (wire it to a "Privacy choices" link in your footer) */
+export declare const openPreferences: () => void;
+/** forget the choice and ask again */
+export declare const revoke: () => void;
+/** show the notice in one of the site's languages; "" for the default */
+export declare const setLanguage: (code: string) => void;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAoF,KAAK,QAAQ,EAAE,KAAK,YAAY,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC/K,OAAO,EAAqB,KAAK,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEhE,YAAY,EAAE,UAAU,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC3H,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEvI;;;GAGG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,WAAW,0EAMxC;AAED,gHAAgH;AAChH,eAAO,MAAM,OAAO,EAAE,QAAQ,CAAC,YAAY,GAAG,IAAI,CAIhD,CAAC;AAEH,iFAAiF;AACjF,eAAO,MAAM,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAuC,CAAC;AAE5E,qFAAqF;AACrF,eAAO,MAAM,OAAO,GAAI,UAAU,QAAQ,KAAG,QAAQ,CAAC,OAAO,CAAoD,CAAC;AAElH;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE;IAAE,QAAQ,EAAE,QAAQ,CAAC;IAAC,GAAG,EAAE,MAAM,CAAC;IAAC,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAAE,MAG7H;AAED,yDAAyD;AACzD,eAAO,MAAM,SAAS,YAA2B,CAAC;AAClD,eAAO,MAAM,SAAS,YAA2B,CAAC;AAClD,eAAO,MAAM,UAAU,uDAAqB,CAAC;AAC7C,sFAAsF;AACtF,eAAO,MAAM,eAAe,YAAsB,CAAC;AACnD,sCAAsC;AACtC,eAAO,MAAM,MAAM,YAAwB,CAAC;AAC5C,yEAAyE;AACzE,eAAO,MAAM,WAAW,wBAA6B,CAAC"}

package/dist/index.js

@@ -0,0 +1,47 @@
+import { consentActions, consentStore, isAllowed, loadPlainConsent, loadScriptWhenAllowed } from "@theplaintheory/consent";
+import { derived, readable } from "svelte/store";
+export { getConsent, isAllowed, loadPlainConsent, loadScriptWhenAllowed, onConsentChange, whenAllowed } from "@theplaintheory/consent";
+/**
+ * Load plain-consent.js once. Call from a browser-only place, e.g. `onMount` in your root
+ * +layout.svelte. Safe to call on the server: it resolves to undefined there.
+ */
+export function init(options) {
+    if (typeof window === "undefined")
+        return Promise.resolve(undefined);
+    return loadPlainConsent(options).catch((e) => {
+        console.warn(e);
+        return undefined;
+    });
+}
+/** Consent state: null on the server and until the script is ready. Works with `$consent` in Svelte 4 and 5. */
+export const consent = readable(null, (set) => {
+    if (typeof window === "undefined")
+        return;
+    set(consentStore.getSnapshot());
+    return consentStore.subscribe(() => set(consentStore.getSnapshot()));
+});
+/** True once the script has loaded the site's settings (false on the server). */
+export const ready = derived(consent, (s) => s !== null);
+/** A store that is true while `category` is allowed (`essential` is always true). */
+export const allowed = (category) => derived(consent, (s) => isAllowed(category, s));
+/**
+ * Svelte action: add a third-party script once `category` is allowed (deduplicated, never removed).
+ *
+ *   <div use:consentScript={{ category: "analytics", src: "https://www.googletagmanager.com/gtag/js?id=G-XXXX" }} />
+ */
+export function consentScript(_node, params) {
+    var _a;
+    void loadScriptWhenAllowed(params.category, params.src, (_a = params.attributes) !== null && _a !== void 0 ? _a : {});
+    return {};
+}
+/** Actions that queue safely before the script loads. */
+export const acceptAll = consentActions.acceptAll;
+export const rejectAll = consentActions.rejectAll;
+export const setConsent = consentActions.set;
+/** open the preferences panel (wire it to a "Privacy choices" link in your footer) */
+export const openPreferences = consentActions.open;
+/** forget the choice and ask again */
+export const revoke = consentActions.revoke;
+/** show the notice in one of the site's languages; "" for the default */
+export const setLanguage = consentActions.setLanguage;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,YAAY,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAsD,MAAM,yBAAyB,CAAC;AAC/K,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAiB,MAAM,cAAc,CAAC;AAGhE,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,eAAe,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAEvI;;;GAGG;AACH,MAAM,UAAU,IAAI,CAAC,OAAoB;IACvC,IAAI,OAAO,MAAM,KAAK,WAAW;QAAE,OAAO,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACrE,OAAO,gBAAgB,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC,CAAU,EAAE,EAAE;QACpD,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChB,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC,CAAC;AACL,CAAC;AAED,gHAAgH;AAChH,MAAM,CAAC,MAAM,OAAO,GAAkC,QAAQ,CAAsB,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE;IAChG,IAAI,OAAO,MAAM,KAAK,WAAW;QAAE,OAAO;IAC1C,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC;IAChC,OAAO,YAAY,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;AACvE,CAAC,CAAC,CAAC;AAEH,iFAAiF;AACjF,MAAM,CAAC,MAAM,KAAK,GAAsB,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;AAE5E,qFAAqF;AACrF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,QAAkB,EAAqB,EAAE,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;AAElH;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAc,EAAE,MAAgF;;IAC5H,KAAK,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,EAAE,MAAA,MAAM,CAAC,UAAU,mCAAI,EAAE,CAAC,CAAC;IACjF,OAAO,EAAE,CAAC;AACZ,CAAC;AAED,yDAAyD;AACzD,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;AAClD,MAAM,CAAC,MAAM,SAAS,GAAG,cAAc,CAAC,SAAS,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,cAAc,CAAC,GAAG,CAAC;AAC7C,sFAAsF;AACtF,MAAM,CAAC,MAAM,eAAe,GAAG,cAAc,CAAC,IAAI,CAAC;AACnD,sCAAsC;AACtC,MAAM,CAAC,MAAM,MAAM,GAAG,cAAc,CAAC,MAAM,CAAC;AAC5C,yEAAyE;AACzE,MAAM,CAAC,MAAM,WAAW,GAAG,cAAc,CAAC,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,50 @@
-{
-  "name": "@theplaintheory/svelte",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+{
+  "name": "@theplaintheory/svelte",
+  "version": "1.0.0",
+  "description": "Svelte and SvelteKit stores for Plain Theory consent. Works with Svelte 4 and 5.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  },
+  "dependencies": {
+    "@theplaintheory/consent": "^1.0.0"
+  },
+  "peerDependencies": {
+    "svelte": ">=4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gagankarthik/theplaintheory.git",
+    "directory": "packages/svelte"
+  },
+  "homepage": "https://www.theplaintheory.in/docs#frameworks",
+  "keywords": [
+    "consent",
+    "cmp",
+    "cookie banner",
+    "gdpr",
+    "ccpa",
+    "dpdpa",
+    "svelte",
+    "sveltekit",
+    "store"
+  ]
+}