@cookieyes/nextjs 0.5.1 → 0.5.2

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.
Files changed (3) hide show
  1. package/README.md +22 -4
  2. package/dist/index.d.ts +1 -1
  3. package/package.json +4 -4
package/README.md CHANGED
@@ -22,7 +22,7 @@
22
22
  <a href="#quick-start">Quick start</a> ·
23
23
  <a href="#pages-router">Pages Router</a> ·
24
24
  <a href="#troubleshooting">Troubleshooting</a> ·
25
- <a href="https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.md">Docs</a>
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
  ---
@@ -45,6 +45,24 @@
45
45
  - **Next.js** ≥ 14 (App Router or Pages Router)
46
46
  - **React** ≥ 18 and **React DOM** ≥ 18 (peer dependencies)
47
47
 
48
+ <!-- PEER-MATRIX:START — generated by apps/web/scripts/generate-peer-matrix-reference.mjs from
49
+ matrix/matrix-results.json. Do not hand-edit between these markers; run
50
+ `pnpm generate:peer-matrix-readme` instead. -->
51
+ | Next.js | React | React DOM | Verified | Build + typecheck | SSR (HTML + cookie value) | Behaviour (jsdom) |
52
+ |---|---|---|---|---|---|---|
53
+ | 14.0.0 (declared floor) | 18.0.0 (declared floor) | 18.0.0 | 2026-08-27 | pass | pass | pass |
54
+ | 15.5.24 | 18.3.1 | 18.3.1 | 2026-08-27 | pass | pass | pass |
55
+ | 16.3.0 | 19.2.8 | 19.2.8 | 2026-08-27 | pass | pass | pass |
56
+
57
+ Verified by installing the exact versions above, building a real Next.js app, server-rendering it and asserting the banner's HTML (and a returning visitor's cookie value) is correct, then running behaviour assertions in `jsdom` via [`@cookieyes/test`](../test). Node 20, pnpm. See [rationale](https://github.com/cookieyes/cookieyes#compatibility) for why this stops short of a real browser.
58
+
59
+ **Not verified by this table:**
60
+ - Any Next.js/React version outside the rows above.
61
+ - npm/yarn as the install client.
62
+ - No real browser paint or hydration — SSR is asserted via server-rendered HTML/fetch only; client behaviour is asserted in jsdom, not a browser DOM (no Playwright).
63
+ - Node, package-manager and module-resolution dimensions are not yet varied — every combination above ran on Node 20 / pnpm / moduleResolution=bundler.
64
+ <!-- PEER-MATRIX:END -->
65
+
48
66
  ## Quick start
49
67
 
50
68
  **1. Install the package**
@@ -65,7 +83,7 @@ Because `initCookieYes()` and the components are client-side, this file **must**
65
83
  > `@cookieyes/react` verbatim, so the same guidance applies: **`useConsent()`**
66
84
  > in client components, and for Server Components or route handlers (no React
67
85
  > hooks available), read the raw cookie with `parseCookie` from
68
- > `@cookieyes/core`. See the [shared decision tree](../../docs/which-api-should-i-use.md)
86
+ > `@cookieyes/core`. See the [shared decision tree](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/which-api.mdx)
69
87
  > and [`@cookieyes/react`'s Hooks section](../react/README.md#hooks) for the
70
88
  > full low-level surface.
71
89
 
@@ -310,7 +328,7 @@ It also adds **server-only** exports on their own subpath, kept out of the `"use
310
328
  | `@cookieyes/nextjs/server` | `getServerConsent(options?)` | Reads the request's cookies and returns a returning visitor's stored decision (or `null`), for `<CookieYesProvider initialConsent>` |
311
329
  | `@cookieyes/nextjs/server` | `<GoogleConsentMode />` | Renders the Google Consent Mode deny-by-default into the page `<head>` (see below) |
312
330
 
313
- - Full option reference: **[Configuration](https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.md)**.
331
+ - Full option reference: **[Configuration](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx)**.
314
332
  - Component/hook reference: the **[`@cookieyes/react` README](https://github.com/cookieyes/cookieyes/tree/main/sdk/react#readme)**.
315
333
 
316
334
  ## Troubleshooting
@@ -337,7 +355,7 @@ Still stuck? [Open an issue](https://github.com/cookieyes/cookieyes/issues).
337
355
 
338
356
  - [Open an issue](https://github.com/cookieyes/cookieyes/issues) — bug reports and feature requests.
339
357
  - Email — [support@cookieyes.com](mailto:support@cookieyes.com).
340
- - [Full documentation](https://github.com/cookieyes/cookieyes/blob/main/docs/configuration.md).
358
+ - [Full documentation](https://github.com/cookieyes/cookieyes/blob/main/apps/web/content/docs/getting-started/configuration.mdx).
341
359
 
342
360
  _(A community chat channel is on the roadmap.)_
343
361
 
package/dist/index.d.ts CHANGED
@@ -1 +1 @@
1
- export { ActiveUI, AnyStopHandler, Banner, Builder, BuiltInIntegration, CY_PART, CY_STATE, CategoryDef, CategoryText, ColorScheme, ColorSchemePref, ConsentActions, ConsentBackend, ConsentCategory, ConsentChangePayload, ConsentConfig, ConsentEventListener, ConsentEventOptions, ConsentEventPayload, ConsentEventType, ConsentManager, ConsentPayload, ConsentRuntime, ConsentRuntimeMode, ConsentRuntimeOptions, ConsentSnapshot, ConsentStore, ConsentStoreState, CookieBanner, CookieBannerProps, CookieOptOut, CookieOptOutProps, CookiePreferences, CookiePreferencesProps, CookieYesConfig, CookieYesOfflineConfig, CookieYesProvider, CookieYesProviderProps, CookieYesRuntime, CookieYesSelfHostedConfig, CookieYesSnapshot, CyPart, CyState, DEFAULT_CATEGORIES, GatedFrame, GatedScript, GoogleConsentSignal, HeaderSource, I18nConfig, LanguageInfo, OptOut, PartialTranslations, Preferences, RecallButton, RegionConfig, RegionDecision, RegionDetector, RegionSource, Regulation, ReloadNotice, ReloadNoticeState, ReloadOnlyHandler, ResolvedCategories, RuntimeMode, ScriptEntry, ServerConsentOptions, StopHandler, TextDirection, ThemeConfig, TranslationMap, UseLanguageResult, UseReloadNoticeResult, createCookieYes, defaultTranslations, getCookieYes, getOrCreateConsentRuntime, getTextDirection, initCookieYes, mergeTranslations, readGpc, readServerConsent, regionFromHeaders, registerStopHandler, resetConsentRuntime, resetCookieYes, resolveBuiltInIntegration, resolveCategories, resolveRegion, resolveTranslations, useBannerVisibility, useCategories, useConsent, useConsentActions, useConsentCategory, useConsentRuntime, useLanguage, useOnConsentChange, useOptOutOpen, usePreferencesOpen, useRegion, useRegulation, useReloadNotice, useTranslations } from '@cookieyes/react';
1
+ export { ActiveUI, AnyStopHandler, Banner, BannerPart, Builder, BuiltInIntegration, CY_PART, CY_STATE, CategoryDef, CategoryText, ColorScheme, ColorSchemePref, ConsentActions, ConsentBackend, ConsentCategory, ConsentChangePayload, ConsentConfig, ConsentEventListener, ConsentEventOptions, ConsentEventPayload, ConsentEventType, ConsentManager, ConsentPayload, ConsentRuntime, ConsentRuntimeMode, ConsentRuntimeOptions, ConsentSnapshot, ConsentStore, ConsentStoreState, CookieBanner, CookieBannerProps, CookieOptOut, CookieOptOutProps, CookiePreferences, CookiePreferencesProps, CookieYesConfig, CookieYesOfflineConfig, CookieYesProvider, CookieYesProviderProps, CookieYesRuntime, CookieYesSelfHostedConfig, CookieYesSnapshot, CyPart, CyState, DEFAULT_CATEGORIES, DialogPart, GatedFrame, GatedScript, GoogleConsentSignal, HeaderSource, I18nConfig, LanguageInfo, OptOut, OptOutPart, PartialTranslations, Preferences, RecallButton, RegionConfig, RegionDecision, RegionDetector, RegionSource, Regulation, ReloadNotice, ReloadNoticeState, ReloadOnlyHandler, ResolvedCategories, RuntimeMode, ScriptEntry, ServerConsentOptions, StopHandler, TextDirection, ThemeConfig, TranslationMap, UseLanguageResult, UseReloadNoticeResult, createCookieYes, defaultTranslations, getCookieYes, getOrCreateConsentRuntime, getTextDirection, initCookieYes, mergeTranslations, readGpc, readServerConsent, regionFromHeaders, registerStopHandler, resetConsentRuntime, resetCookieYes, resolveBuiltInIntegration, resolveCategories, resolveRegion, resolveTranslations, useBannerVisibility, useCategories, useConsent, useConsentActions, useConsentCategory, useConsentRuntime, useLanguage, useOnConsentChange, useOptOutOpen, usePreferencesOpen, useRegion, useRegulation, useReloadNotice, useTranslations } from '@cookieyes/react';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cookieyes/nextjs",
3
- "version": "0.5.1",
3
+ "version": "0.5.2",
4
4
  "description": "Next.js App Router adapter for the CookieYes consent SDK",
5
5
  "keywords": [
6
6
  "cookie consent",
@@ -61,9 +61,9 @@
61
61
  "react-dom": ">=18.0.0"
62
62
  },
63
63
  "dependencies": {
64
- "@cookieyes/core": "0.4.0",
65
- "@cookieyes/react": "0.5.0",
66
- "@cookieyes/scripts": "0.1.1"
64
+ "@cookieyes/core": "0.5.0",
65
+ "@cookieyes/react": "0.6.0",
66
+ "@cookieyes/scripts": "0.2.0"
67
67
  },
68
68
  "devDependencies": {
69
69
  "@types/node": "^26.1.1",