@nimpl/getters 1.4.1-canary.1 → 2.0.0-canary.0

package/README.md

@@ -2,39 +2,45 @@
 
 (Former [next-impl-getters](https://www.npmjs.com/package/next-impl-getters))
 
-Implementation of server getters in React Server Components without switching to SSR in next.js
+Implementation of server getters in React Server Components without switching to SSR in Next.js
 
 Before using the library, read the [Possible Issues](https://nimpl.tech/getters/possible-issues)
 
 Visit https://nimpl.tech/getters to view the full documentation.
 
+Use `@nimpl/getters 2.x` for Next.js v15. For earlier versions of Next.js use `@nimpl/getters 1.x`.
+
 ## Installation
 
 **Using npm:**
+
 ```bash
 npm i @nimpl/getters
 ```
 
 **Using yarn:**
+
 ```bash
 yarn add @nimpl/getters
 ```
 
 ## Current Getters
 
-* [get-pathname](https://nimpl.tech/getters/current-getters/get-pathname)
-* [get-page-config](https://nimpl.tech/getters/current-getters/get-page-config)
-* [get-params](https://nimpl.tech/getters/current-getters/get-params)
-* [get-search-params](https://nimpl.tech/getters/current-getters/get-search-params) (*deprecated*)
+- [get-pathname](https://nimpl.tech/getters/current-getters/get-pathname)
+- [get-page-config](https://nimpl.tech/getters/current-getters/get-page-config)
+- [get-params](https://nimpl.tech/getters/current-getters/get-params)
+- [get-search-params](https://nimpl.tech/getters/current-getters/get-search-params) (_deprecated_)
+
+> _`create-server-context` and `get-server-context` were moved to a separate package - [@nimpl/context](https://nimpl.tech/context)_
 
 ## Stability
 
 All getters are covered with tests. Tests are run on every release and every 6 hours on the latest **Canary** version of `Next.js`.
 
-In this way, you can be sure not only of the stability of the code, but also that if there is a breaking change in `Next.js`, this will immediately become known. *Even before the release of a stable version of `Next.js`.*
+In this way, you can be sure not only of the stability of the code, but also that if there is a breaking change in `Next.js`, this will immediately become known. _Even before the release of a stable version of `Next.js`._
 
 ## Additional
 
-Please consider giving a star if you like it, it will help promote the implementation in the eyes of the next.js team.
+Please consider giving a star if you like it, it will help promote the implementation in the eyes of the Next.js team.
 
 Create tasks for identified issues, desired getters, or various improvements.

package/get-page-config.d.ts

@@ -1,11 +1,9 @@
 export declare const getPageConfig: () => {
     pagePath?: undefined;
     dynamic?: undefined;
-    revalidate?: undefined;
     basePath?: undefined;
 } | {
-    pagePath: string | undefined;
+    pagePath: string;
     dynamic: string;
-    revalidate: import("next/dist/server/lib/revalidate").Revalidate | undefined;
     basePath: string;
 };

package/get-page-config.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPageConfig = void 0;
-const static_generation_async_storage_external_1 = require("next/dist/client/components/static-generation-async-storage.external");
+const work_async_storage_external_1 = require("next/dist/server/app-render/work-async-storage.external");
 const server_getter_in_client_component_error_1 = require("./server-getter-in-client-component-error");
 const getPageConfig = () => {
     (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getPageConfig");
-    const store = static_generation_async_storage_external_1.staticGenerationAsyncStorage.getStore();
+    const store = work_async_storage_external_1.workAsyncStorage.getStore();
     if (!store)
         return {};
     const basePath = process.env.__NEXT_ROUTER_BASEPATH || "";
-    const { pagePath, forceDynamic, forceStatic, dynamicShouldError, revalidate } = store || {};
+    const { page, forceDynamic, forceStatic, dynamicShouldError } = store || {};
     let dynamic = "auto";
     if (forceDynamic) {
         dynamic = "force-dynamic";
@@ -20,6 +20,6 @@ const getPageConfig = () => {
     else if (dynamicShouldError) {
         dynamic = "error";
     }
-    return { pagePath, dynamic, revalidate, basePath };
+    return { pagePath: page, dynamic, basePath };
 };
 exports.getPageConfig = getPageConfig;

package/get-params.d.ts

@@ -12,5 +12,5 @@ type GetParamsOptions = {
 };
 export declare const getParams: (options?: GetParamsOptions) => {
     [key: string]: string | string[];
-} | null;
+};
 export {};

package/get-params.js

@@ -1,16 +1,24 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getParams = void 0;
-const static_generation_async_storage_external_1 = require("next/dist/client/components/static-generation-async-storage.external");
+const work_async_storage_external_1 = require("next/dist/server/app-render/work-async-storage.external");
+const work_unit_async_storage_external_1 = require("next/dist/server/app-render/work-unit-async-storage.external");
 const server_getter_in_client_component_error_1 = require("./server-getter-in-client-component-error");
 const utils_1 = require("./utils");
 const getParams = (options = {}) => {
     (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getParams");
-    const store = static_generation_async_storage_external_1.staticGenerationAsyncStorage.getStore();
+    const store = work_async_storage_external_1.workAsyncStorage.getStore();
     if (!store)
         return {};
     const { ignoreDifferenceError, pagePaths, pathname } = options;
-    const { urlPathname, pagePath = "/" } = store;
+    const pageConfigurationStore = work_async_storage_external_1.workAsyncStorage.getStore();
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const pageStore = work_unit_async_storage_external_1.workUnitAsyncStorage.getStore();
+    if (!pageConfigurationStore || !pageStore?.url?.pathname)
+        return {};
+    const { route } = pageConfigurationStore;
+    const pagePath = route;
+    const urlPathname = pageStore.url.pathname;
     const targetUrlPathname = pathname || urlPathname;
     let isInvalid = false;
     try {
@@ -21,7 +29,7 @@ const getParams = (options = {}) => {
                     isInvalid ||= true;
                     continue;
                 }
-                return params;
+                return params || {};
             }
         }
         else {
@@ -30,7 +38,7 @@ const getParams = (options = {}) => {
                 isInvalid ||= true;
             }
             else {
-                return params;
+                return params || {};
             }
         }
     }
@@ -44,6 +52,6 @@ const getParams = (options = {}) => {
         createIssueUrl.searchParams.append("labels", "bug");
         throw new Error(`Something went wrong. Please create an issue on Github: ${createIssueUrl}`);
     }
-    return null;
+    return {};
 };
 exports.getParams = getParams;

package/get-pathname.js

@@ -1,17 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPathname = void 0;
-const static_generation_async_storage_external_1 = require("next/dist/client/components/static-generation-async-storage.external");
+const work_async_storage_external_1 = require("next/dist/server/app-render/work-async-storage.external");
+const work_unit_async_storage_external_1 = require("next/dist/server/app-render/work-unit-async-storage.external");
 const has_base_path_1 = require("next/dist/client/has-base-path");
 const remove_base_path_1 = require("next/dist/client/remove-base-path");
 const server_getter_in_client_component_error_1 = require("./server-getter-in-client-component-error");
+const utils_1 = require("./utils");
 function getPathname() {
     (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getPathname");
-    const store = static_generation_async_storage_external_1.staticGenerationAsyncStorage.getStore();
-    if (!store)
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const pageStore = work_unit_async_storage_external_1.workUnitAsyncStorage.getStore();
+    let originalPathname = pageStore?.url?.pathname;
+    if (!originalPathname) {
+        const pageConfigurationStore = work_async_storage_external_1.workAsyncStorage.getStore();
+        originalPathname =
+            pageConfigurationStore?.route &&
+                (0, utils_1.normalizeInterceptingRoutes)(pageConfigurationStore.route.split("/")).join("/");
+    }
+    if (!originalPathname) {
         return null;
-    const { urlPathname } = store;
-    const url = new URL(urlPathname, "http://n");
+    }
+    const url = new URL(originalPathname, "http://n");
     const pathname = (0, has_base_path_1.hasBasePath)(url.pathname) ? (0, remove_base_path_1.removeBasePath)(url.pathname) : url.pathname;
     return pathname;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimpl/getters",
-  "version": "1.4.1-canary.1",
+  "version": "2.0.0-canary.0",
   "description": "Implementation of server getters in React Server Components without switching to SSR in next.js",
   "files": [
     "**/*.js",
@@ -35,7 +35,7 @@
     "@types/react": "18.3.2",
     "react": "18.3.1",
     "react-dom": "18.3.1",
-    "next": "14.2.3",
+    "next": "15.0.0",
     "typescript": "5.4.5"
   },
   "peerDependencies": {

package/get-search-params.d.ts

@@ -1,4 +0,0 @@
-/** @deprecated getSearchParams is deprecated. [Read more](https://nimpl.tech/getters/current-getters/get-search-params) */
-export declare function getSearchParams(opts?: {
-    ignoreDynamicOptionErrors?: boolean;
-}): URLSearchParams;

package/get-search-params.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSearchParams = void 0;
-const static_generation_async_storage_external_1 = require("next/dist/client/components/static-generation-async-storage.external");
-const server_getter_in_client_component_error_1 = require("./server-getter-in-client-component-error");
-const navigation_1 = require("next/navigation");
-const internal_utils_1 = require("next/dist/server/internal-utils");
-/** @deprecated getSearchParams is deprecated. [Read more](https://nimpl.tech/getters/current-getters/get-search-params) */
-function getSearchParams(opts) {
-    (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getSearchParams");
-    console.error("getSearchParams is deprecated. Read more - https://nimpl.tech/getters/current-getters/get-search-params");
-    const store = static_generation_async_storage_external_1.staticGenerationAsyncStorage.getStore();
-    if (!store)
-        return new URLSearchParams();
-    const { urlPathname, forceStatic, forceDynamic, dynamicShouldError } = store;
-    if (!opts?.ignoreDynamicOptionErrors) {
-        if (forceStatic) {
-            throw new Error("Сannot get client search parameters with dynamic=force-static setting");
-        }
-        else if (dynamicShouldError) {
-            throw new Error("Сannot get client search parameters with dynamic=error setting");
-        }
-        else if (!forceDynamic) {
-            console.warn("Do not use getSearchParams with unselected dynamic setting, use force-dynamic instead");
-        }
-    }
-    const url = new URL(urlPathname, "http://n");
-    const strippedUrl = (0, internal_utils_1.stripInternalSearchParams)(url, true);
-    const readonlySearchParams = new navigation_1.ReadonlyURLSearchParams(strippedUrl.searchParams);
-    return readonlySearchParams;
-}
-exports.getSearchParams = getSearchParams;