@cookieyes/core 0.4.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +9 -7
- package/dist/categories-D1vlERV6.d.ts +776 -0
- package/dist/index.cjs +1 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +60 -710
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/integrations.cjs +2 -0
- package/dist/integrations.cjs.map +1 -0
- package/dist/integrations.d.ts +1 -0
- package/dist/integrations.js +2 -0
- package/dist/integrations.js.map +1 -0
- package/dist/network-blocker--Z2J__Xr.cjs +2 -0
- package/dist/network-blocker--Z2J__Xr.cjs.map +1 -0
- package/dist/network-blocker-zdjGiuQN.js +2 -0
- package/dist/network-blocker-zdjGiuQN.js.map +1 -0
- package/dist/network-blocker.cjs +2 -0
- package/dist/network-blocker.cjs.map +1 -0
- package/dist/network-blocker.d.ts +1 -0
- package/dist/network-blocker.js +2 -0
- package/dist/network-blocker.js.map +1 -0
- package/package.json +6 -1
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@
|
|
|
22
22
|
<a href="#quick-start">Quick start</a> ·
|
|
23
23
|
<a href="#api">API</a> ·
|
|
24
24
|
<a href="#troubleshooting">Troubleshooting</a> ·
|
|
25
|
-
<a href="https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.
|
|
25
|
+
<a href="https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx">Docs</a>
|
|
26
26
|
</p>
|
|
27
27
|
|
|
28
28
|
---
|
|
@@ -64,7 +64,7 @@ bun add @cookieyes/core
|
|
|
64
64
|
**2. Initialise the runtime**
|
|
65
65
|
|
|
66
66
|
> **Which API should I use?** `consentStore.subscribe` is the recommended way to
|
|
67
|
-
> read consent outside React. See the [shared decision tree](
|
|
67
|
+
> read consent outside React. See the [shared decision tree](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/which-api.mdx)
|
|
68
68
|
> if you're not sure which API applies to your situation — core also exposes a
|
|
69
69
|
> handful of lower-level options (see [Low-level / advanced API](#low-level--advanced-api))
|
|
70
70
|
> for specific edge cases.
|
|
@@ -154,9 +154,9 @@ still works today and logs a one-time console warning, and will be removed
|
|
|
154
154
|
Both accept the canonical `CookieYesConfig` and return `{ consentManager, consentStore }` (a
|
|
155
155
|
singleton — call `resetConsentRuntime()` to clear it, mainly for tests). `initCookieYes` is an
|
|
156
156
|
alias provided so one setup name reads across every package. Every option is documented once in
|
|
157
|
-
**[Configuration](https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.
|
|
157
|
+
**[Configuration](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx)**.
|
|
158
158
|
Migrating off the deprecated `overrides.regulation` / `backendURL` keys? See the
|
|
159
|
-
**[migration guide](https://github.com/cookieyes/cookieyes/blob/main/docs/migration
|
|
159
|
+
**[migration guide](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/migration.mdx)**.
|
|
160
160
|
|
|
161
161
|
**`config`** (`CookieYesConfig`):
|
|
162
162
|
|
|
@@ -239,7 +239,7 @@ await consentStore.setLanguage("fr"); // switch live; loads via i18n.loadLangu
|
|
|
239
239
|
```
|
|
240
240
|
|
|
241
241
|
Missing text falls back to English; custom categories translate by id (see the
|
|
242
|
-
[configuration guide](https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.
|
|
242
|
+
[configuration guide](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx)).
|
|
243
243
|
In React, use the `useTranslations()` / `useLanguage()` hooks instead.
|
|
244
244
|
|
|
245
245
|
## Region-based regulation (geo-detection)
|
|
@@ -294,7 +294,9 @@ is lost.
|
|
|
294
294
|
|
|
295
295
|
There are three layers:
|
|
296
296
|
|
|
297
|
-
1. **Network blocking** (`networkBlocker` / `blockNetwork`) —
|
|
297
|
+
1. **Network blocking** (`networkBlocker` / `blockNetwork`) — see
|
|
298
|
+
[Network blocking](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/network-blocking.mdx) for what it
|
|
299
|
+
can and cannot stop, its measured cost, and starter rules for common vendors. It intercepts
|
|
298
300
|
`fetch`, `XMLHttpRequest`, **and `navigator.sendBeacon`** to blocked domains,
|
|
299
301
|
in real time, for as long as the page is open. `sendBeacon` matters because
|
|
300
302
|
GA4/Meta use it for exit/unload tracking that fetch/XHR interception misses.
|
|
@@ -526,7 +528,7 @@ Still stuck? [Open an issue](https://github.com/cookieyes/cookieyes/issues).
|
|
|
526
528
|
|
|
527
529
|
- [Open an issue](https://github.com/cookieyes/cookieyes/issues) — bug reports and feature requests.
|
|
528
530
|
- Email — [support@cookieyes.com](mailto:support@cookieyes.com).
|
|
529
|
-
- [Full documentation](https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.
|
|
531
|
+
- [Full documentation](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx).
|
|
530
532
|
|
|
531
533
|
_(A community chat channel is on the roadmap.)_
|
|
532
534
|
|