consentik-cmp 0.1.0

package/README.md

@@ -0,0 +1,74 @@
+# consentik-cmp
+
+React component and hook for integrating the [Consentik](https://consentik.com) cookie consent banner.
+
+Ships with TypeScript declarations.
+
+## Installation
+
+```bash
+npm install consentik-cmp
+# or
+pnpm add consentik-cmp
+# or
+yarn add consentik-cmp
+```
+
+## Usage
+
+### Component
+
+```tsx
+import { ConsentikCMP } from 'consentik-cmp';
+
+function App() {
+  return (
+    <>
+      <ConsentikCMP
+        config={{
+          instanceId: 'your-instance-id',
+          siteId: 'your-site-id'
+        }}
+      />
+      {/* rest of your app */}
+    </>
+  );
+}
+```
+
+### Hook
+
+```tsx
+import { useConsentik } from 'consentik-cmp';
+
+function App() {
+  useConsentik({
+    instanceId: 'your-instance-id',
+    siteId: 'your-site-id'
+  });
+
+  return <div>{/* your app */}</div>;
+}
+```
+
+### Config Options
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `instanceId` | `string` | Yes | Your Consentik instance ID |
+| `siteId` | `string` | Yes | Your Consentik site ID |
+| `timestamp` | `number` | No | Cache bust value. Defaults to `new Date().getMinutes()` |
+
+## Framework Compatibility
+
+Works with any React-based framework:
+- React (CRA, Vite)
+- Next.js (App Router & Pages Router)
+- Remix
+- Gatsby
+
+The script is injected client-side via `useEffect`, so it is SSR-safe.
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,14 @@
+interface ConsentikConfig {
+    instanceId: string;
+    siteId: string;
+    timestamp?: number;
+}
+
+declare function useConsentik(config: ConsentikConfig): void;
+
+interface ConsentikCMPProps {
+    config: ConsentikConfig;
+}
+declare function ConsentikCMP({ config }: ConsentikCMPProps): null;
+
+export { ConsentikCMP, type ConsentikConfig, useConsentik };

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+interface ConsentikConfig {
+    instanceId: string;
+    siteId: string;
+    timestamp?: number;
+}
+
+declare function useConsentik(config: ConsentikConfig): void;
+
+interface ConsentikCMPProps {
+    config: ConsentikConfig;
+}
+declare function ConsentikCMP({ config }: ConsentikCMPProps): null;
+
+export { ConsentikCMP, type ConsentikConfig, useConsentik };

package/dist/index.js

@@ -0,0 +1,61 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  ConsentikCMP: () => ConsentikCMP,
+  useConsentik: () => useConsentik
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/useConsentik.ts
+var import_react = require("react");
+var SCRIPT_ID = "cst-package";
+var BASE_URL = "https://cmp.consentik.com/sites";
+function useConsentik(config) {
+  const { instanceId, siteId, timestamp } = config;
+  const cachedTimestamp = (0, import_react.useRef)(timestamp != null ? timestamp : (/* @__PURE__ */ new Date()).getMinutes());
+  (0, import_react.useEffect)(() => {
+    if (document.getElementById(SCRIPT_ID)) {
+      return;
+    }
+    const script = document.createElement("script");
+    script.id = SCRIPT_ID;
+    script.async = true;
+    script.src = `${BASE_URL}/${instanceId}/${siteId}/index.js?v=${cachedTimestamp.current}`;
+    const firstScript = document.getElementsByTagName("script")[0];
+    if (firstScript == null ? void 0 : firstScript.parentNode) {
+      firstScript.parentNode.insertBefore(script, firstScript);
+    } else {
+      document.head.appendChild(script);
+    }
+  }, []);
+}
+
+// src/ConsentikCMP.tsx
+function ConsentikCMP({ config }) {
+  useConsentik(config);
+  return null;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  ConsentikCMP,
+  useConsentik
+});

package/dist/index.mjs

@@ -0,0 +1,33 @@
+// src/useConsentik.ts
+import { useEffect, useRef } from "react";
+var SCRIPT_ID = "cst-package";
+var BASE_URL = "https://cmp.consentik.com/sites";
+function useConsentik(config) {
+  const { instanceId, siteId, timestamp } = config;
+  const cachedTimestamp = useRef(timestamp != null ? timestamp : (/* @__PURE__ */ new Date()).getMinutes());
+  useEffect(() => {
+    if (document.getElementById(SCRIPT_ID)) {
+      return;
+    }
+    const script = document.createElement("script");
+    script.id = SCRIPT_ID;
+    script.async = true;
+    script.src = `${BASE_URL}/${instanceId}/${siteId}/index.js?v=${cachedTimestamp.current}`;
+    const firstScript = document.getElementsByTagName("script")[0];
+    if (firstScript == null ? void 0 : firstScript.parentNode) {
+      firstScript.parentNode.insertBefore(script, firstScript);
+    } else {
+      document.head.appendChild(script);
+    }
+  }, []);
+}
+
+// src/ConsentikCMP.tsx
+function ConsentikCMP({ config }) {
+  useConsentik(config);
+  return null;
+}
+export {
+  ConsentikCMP,
+  useConsentik
+};

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "consentik-cmp",
+  "version": "0.1.0",
+  "description": "React component and hook for integrating Consentik cookie consent banner",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:cov": "jest --coverage",
+    "lint": "tsc --noEmit",
+    "prepublishOnly": "pnpm run build"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@testing-library/react": "^14.0.0",
+    "@types/jest": "^29.5.0",
+    "@types/react": "^18.2.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "ts-jest": "^29.1.0",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.0",
+    "typescript": "^5.4.0"
+  },
+  "keywords": [
+    "consentik",
+    "cookie-consent",
+    "gdpr",
+    "react",
+    "cmp"
+  ],
+  "license": "MIT"
+}