@nimpl/getters 0.0.0-experimental-b3fa49d

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Alex Savelyev <dev@alexdln.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,48 @@
+# @nimpl/getters
+
+(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
+
+Before using the library, read the [Possible Issues](https://nimpl.dev/docs/server-getters#possible-issues)
+
+Visit https://nimpl.dev/docs/server-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.dev/docs/server-getters#get-pathname)
+- [get-app-pathname](https://nimpl.dev/docs/server-getters#get-app-pathname)
+- [get-params](https://nimpl.dev/docs/server-getters#get-params)
+- [get-app-params](https://nimpl.dev/docs/server-getters#get-app-params)
+- [get-page-config](https://nimpl.dev/docs/server-getters#get-page-config)
+- [get-search-params](https://nimpl.dev/docs/server-getters#get-search-params) (_deprecated_)
+
+> _`create-server-context` and `get-server-context` were moved to a separate package - [@nimpl/context](https://nimpl.dev/docs/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`._
+
+## Additional
+
+Please consider giving a star if you like it, it will help promote the implementation in the eyes of the Next.js team. This also motivates the author to continue working on this and other solutions ❤️
+
+Create issues for identified problems, desired getters, or various improvements.

package/get-app-params.d.ts

@@ -0,0 +1,16 @@
+type GetParamsOptions = {
+    /**
+     * In case of error or segments difference
+     * getter will return null
+     * (_f.e. `/_not-found` could be at `/it/removed-page` and it would not have any params_)
+     */
+    ignoreDifferenceError?: true;
+    /** Custom pathname (f.e. `["/example/custom"]`). Usable for rewritten pages in SSR or custom functions */
+    pathname?: string;
+    /** Custom pagePaths list (f.e. `["/example/[slug]/page"]`). Usable for rewritten pages in SSR or custom functions */
+    pagePaths?: string[];
+};
+export declare const getAppParams: (options?: GetParamsOptions) => {
+    [key: string]: string | string[];
+};
+export {};

package/get-app-params.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppParams = void 0;
+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 utils_1 = require("./utils");
+const get_app_pathname_1 = require("./get-app-pathname");
+const getAppParams = (options = {}) => {
+    (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getAppParams");
+    const store = work_async_storage_external_1.workAsyncStorage.getStore();
+    if (!store)
+        return {};
+    const { ignoreDifferenceError, pagePaths, pathname } = options;
+    const pageConfigurationStore = work_async_storage_external_1.workAsyncStorage.getStore();
+    if (!pageConfigurationStore)
+        return {};
+    const { route } = pageConfigurationStore;
+    const pagePath = route;
+    const urlPathname = (0, get_app_pathname_1.getAppPathname)();
+    const targetUrlPathname = pathname || urlPathname;
+    if (!targetUrlPathname)
+        return {};
+    let isInvalid = false;
+    try {
+        if (pagePaths) {
+            for (const userPagePath of pagePaths) {
+                const params = (0, utils_1.parseParams)(targetUrlPathname, userPagePath);
+                if (params === utils_1.INVALID_PARSE) {
+                    isInvalid ||= true;
+                    continue;
+                }
+                return params || {};
+            }
+        }
+        else {
+            const params = (0, utils_1.parseParams)(targetUrlPathname, pagePath);
+            if (params === utils_1.INVALID_PARSE) {
+                isInvalid ||= true;
+            }
+            else {
+                return params || {};
+            }
+        }
+    }
+    catch {
+        isInvalid = true;
+    }
+    if (isInvalid && !ignoreDifferenceError) {
+        const createIssueUrl = new URL("https://github.com/alexdln/nimpl-getters/issues/new");
+        createIssueUrl.searchParams.set("title", "Error parsing segments in get-params");
+        createIssueUrl.searchParams.set("body", `urlPathname: \`${urlPathname}\`;\n\npagePath(s): \`${pagePaths || pagePath}\`;`);
+        createIssueUrl.searchParams.append("labels", "bug");
+        throw new Error(`Something went wrong. Please create an issue on Github: ${createIssueUrl}`);
+    }
+    return {};
+};
+exports.getAppParams = getAppParams;

package/get-app-pathname.d.ts

@@ -0,0 +1 @@
+export declare function getAppPathname(): any;

package/get-app-pathname.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppPathname = getAppPathname;
+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");
+function getAppPathname() {
+    (0, server_getter_in_client_component_error_1.serverGetterInClientComponentError)("getAppPathname");
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    const pageStore = work_unit_async_storage_external_1.workUnitAsyncStorage.getStore();
+    const tags = (Array.isArray(pageStore.implicitTags.tags) && pageStore.implicitTags.tags) ||
+        (Array.isArray(pageStore.implicitTags) && pageStore.implicitTags) ||
+        [];
+    const pageTags = tags.filter((tag) => tag.startsWith("_N_T_/"));
+    const pathnameTag = pageTags[pageTags.length - 1];
+    return pathnameTag.substring(5);
+}

package/get-page-config.d.ts

@@ -0,0 +1,9 @@
+export declare const getPageConfig: () => {
+    pagePath?: undefined;
+    dynamic?: undefined;
+    basePath?: undefined;
+} | {
+    pagePath: string;
+    dynamic: string;
+    basePath: string;
+};

package/get-page-config.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPageConfig = void 0;
+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 = work_async_storage_external_1.workAsyncStorage.getStore();
+    if (!store)
+        return {};
+    const basePath = process.env.__NEXT_ROUTER_BASEPATH || "";
+    const { page, forceDynamic, forceStatic, dynamicShouldError } = store || {};
+    let dynamic = "auto";
+    if (forceDynamic) {
+        dynamic = "force-dynamic";
+    }
+    else if (forceStatic) {
+        dynamic = "force-static";
+    }
+    else if (dynamicShouldError) {
+        dynamic = "error";
+    }
+    return { pagePath: page, dynamic, basePath };
+};
+exports.getPageConfig = getPageConfig;

package/get-params.d.ts

@@ -0,0 +1,16 @@
+type GetParamsOptions = {
+    /**
+     * In case of error or segments difference
+     * getter will return null
+     * (_f.e. `/_not-found` could be at `/it/removed-page` and it would not have any params_)
+     */
+    ignoreDifferenceError?: true;
+    /** Custom pathname (f.e. `["/example/custom"]`). Usable for rewritten pages in SSR or custom functions */
+    pathname?: string;
+    /** Custom pagePaths list (f.e. `["/example/[slug]/page"]`). Usable for rewritten pages in SSR or custom functions */
+    pagePaths?: string[];
+};
+export declare const getParams: (options?: GetParamsOptions) => {
+    [key: string]: string | string[];
+};
+export {};

package/get-params.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getParams = void 0;
+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 = work_async_storage_external_1.workAsyncStorage.getStore();
+    if (!store)
+        return {};
+    const { ignoreDifferenceError, pagePaths, pathname } = options;
+    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)
+        return {};
+    const { route } = pageConfigurationStore;
+    const pagePath = route;
+    const urlPathname = pageStore?.url?.pathname;
+    const targetUrlPathname = pathname || urlPathname;
+    if (!targetUrlPathname)
+        return {};
+    let isInvalid = false;
+    try {
+        if (pagePaths) {
+            for (const userPagePath of pagePaths) {
+                const params = (0, utils_1.parseParams)(targetUrlPathname, userPagePath);
+                if (params === utils_1.INVALID_PARSE) {
+                    isInvalid ||= true;
+                    continue;
+                }
+                return params || {};
+            }
+        }
+        else {
+            const params = (0, utils_1.parseParams)(targetUrlPathname, pagePath);
+            if (params === utils_1.INVALID_PARSE) {
+                isInvalid ||= true;
+            }
+            else {
+                return params || {};
+            }
+        }
+    }
+    catch {
+        isInvalid = true;
+    }
+    if (isInvalid && !ignoreDifferenceError) {
+        const createIssueUrl = new URL("https://github.com/alexdln/nimpl-getters/issues/new");
+        createIssueUrl.searchParams.set("title", "Error parsing segments in get-params");
+        createIssueUrl.searchParams.set("body", `urlPathname: \`${urlPathname}\`;\n\npagePath(s): \`${pagePaths || pagePath}\`;`);
+        createIssueUrl.searchParams.append("labels", "bug");
+        throw new Error(`Something went wrong. Please create an issue on Github: ${createIssueUrl}`);
+    }
+    return {};
+};
+exports.getParams = getParams;

package/get-pathname.d.ts

@@ -0,0 +1 @@
+export declare function getPathname(): string | null;

package/get-pathname.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPathname = getPathname;
+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");
+    // 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 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

@@ -0,0 +1,47 @@
+{
+  "name": "@nimpl/getters",
+  "version": "0.0.0-experimental-b3fa49d",
+  "description": "Implementation of server getters in React Server Components without switching to SSR in next.js",
+  "files": [
+    "**/*.js",
+    "**/*.d.ts"
+  ],
+  "scripts": {
+    "build": "tsc"
+  },
+  "keywords": [
+    "next",
+    "next.js",
+    "server components",
+    "react.js",
+    "get-pathname",
+    "getters",
+    "implementation",
+    "get-params",
+    "app router",
+    "rsc"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/alexdln/nimpl-getters.git"
+  },
+  "author": {
+    "name": "Alex Savelyev",
+    "email": "dev@alexdln.com",
+    "url": "https://github.com/alexdln/"
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "25.0.3",
+    "@types/react": "19.2.7",
+    "next": "16.1.1",
+    "react": "19.2.3",
+    "react-dom": "19.2.3",
+    "typescript": "5.9.3"
+  },
+  "peerDependencies": {
+    "next": ">= 14.0.0",
+    "react": ">= 18.2.0",
+    "react-dom": ">= 18.2.0"
+  }
+}

package/server-getter-in-client-component-error.d.ts

@@ -0,0 +1 @@
+export declare function serverGetterInClientComponentError(getterName: string): void | never;

package/server-getter-in-client-component-error.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serverGetterInClientComponentError = serverGetterInClientComponentError;
+const react_1 = __importDefault(require("react"));
+function serverGetterInClientComponentError(getterName) {
+    if (process.env.NODE_ENV !== "production") {
+        // If useState is defined we're in a client component
+        if (Boolean(react_1.default.useState)) {
+            throw new Error(`${getterName} only works in Server Components`);
+        }
+    }
+}

package/utils.d.ts

@@ -0,0 +1,10 @@
+export declare const normalizePathname: (pathname: string) => string;
+export declare const normalizePagePath: (pagePath: string) => string;
+export declare const parseSegments: (pagePathParts: string[], pathnameParts: string[]) => {
+    [key: string]: string | string[];
+};
+export declare const normalizeInterceptingRoutes: (pageParts: string[]) => string[];
+export declare const INVALID_PARSE: unique symbol;
+export declare const parseParams: (urlPathname: string, pagePath: string) => typeof INVALID_PARSE | {
+    [key: string]: string | string[];
+};

package/utils.js

@@ -0,0 +1,106 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseParams = exports.INVALID_PARSE = exports.normalizeInterceptingRoutes = exports.parseSegments = exports.normalizePagePath = exports.normalizePathname = void 0;
+const normalizePathname = (pathname) => {
+    const cleanPathname = pathname && new URL(pathname, "http://n").pathname;
+    const pathnameWithoutTrailingSlash = cleanPathname?.replace(/^(\/.*)\/$/, "$1");
+    const pathnameWithoutFileType = pathnameWithoutTrailingSlash?.replace(/\/_not-found$/, "");
+    return pathnameWithoutFileType.endsWith("/") ? pathnameWithoutFileType : pathnameWithoutFileType + "/";
+};
+exports.normalizePathname = normalizePathname;
+const normalizePagePath = (pagePath) => {
+    const cleanPagePath = pagePath && new URL(pagePath, "http://n").pathname;
+    const pagePathWithoutFileType = cleanPagePath?.replace(/(\/page|\/_not-found)$/, "/");
+    const pagePathWithoutGroups = pagePathWithoutFileType
+        .split("/")
+        .filter(Boolean)
+        .filter((segment) => !segment.match(/^(\([^)]+\)$|^\@.+$)/g));
+    if (pagePathWithoutGroups.length === 0)
+        return "/";
+    return "/" + pagePathWithoutGroups.join("/") + "/";
+};
+exports.normalizePagePath = normalizePagePath;
+const parseSegments = (pagePathParts, pathnameParts) => {
+    const query = pagePathParts.reduce((acc, cur, index) => {
+        const optionalCatchAllSegment = cur.match(/^\[\[\.\.\.([^\]]+)\]\]$/);
+        if (optionalCatchAllSegment) {
+            const key = optionalCatchAllSegment[1];
+            const segmentParts = pathnameParts.slice(index);
+            if (segmentParts.length) {
+                acc[key] = segmentParts;
+            }
+            return acc;
+        }
+        const catchAllSegment = cur.match(/^\[\.\.\.([^\]]+)\]$/);
+        if (catchAllSegment) {
+            const key = catchAllSegment[1];
+            acc[key] = pathnameParts.slice(index);
+            return acc;
+        }
+        const dynamicSegment = cur.match(/^\[([^\]]+)\]$/);
+        if (dynamicSegment) {
+            const key = dynamicSegment[1];
+            acc[key] = pathnameParts[index];
+            return acc;
+        }
+        return acc;
+    }, {});
+    return query;
+};
+exports.parseSegments = parseSegments;
+const normalizeInterceptingRoutes = (pageParts) => {
+    let skip = 0;
+    const normilizedParts = [];
+    for (const pagepart of [...pageParts].reverse()) {
+        if (skip) {
+            skip -= 1;
+            continue;
+        }
+        if (pagepart.startsWith("(...)")) {
+            normilizedParts.push(pagepart.replace(/^\(\.\.\.\)/, ""));
+            break;
+        }
+        else if (pagepart.startsWith("(.)")) {
+            normilizedParts.push(pagepart.replace(/^\(\.\)/, ""));
+        }
+        else if (pagepart.startsWith("(..)")) {
+            const skipLeafs = pagepart.match(/\(\.\.\)/g);
+            skip += skipLeafs?.length || 0;
+            normilizedParts.push(pagepart.replace(/^(\(\.\.\))+/, ""));
+        }
+        else {
+            normilizedParts.push(pagepart);
+        }
+    }
+    return normilizedParts.reverse();
+};
+exports.normalizeInterceptingRoutes = normalizeInterceptingRoutes;
+exports.INVALID_PARSE = Symbol("Invalid Parse");
+const isSamePaths = (urlPathnameParts, pagePathParts) => {
+    for (let i = 0; i < pagePathParts.length; i++) {
+        const urlPathnamePart = urlPathnameParts[i];
+        const pagePathPart = pagePathParts[i];
+        if (pagePathPart.match(/\[\.\.\.[^\]]+\]/))
+            return true;
+        if (pagePathPart.match(/\[[^\]]+\]/))
+            continue;
+        if (urlPathnamePart !== pagePathPart)
+            return false;
+    }
+    return urlPathnameParts.length === pagePathParts.length;
+};
+const parseParams = (urlPathname, pagePath) => {
+    const cleanUrlPathname = (0, exports.normalizePathname)(urlPathname);
+    const cleanPagePath = (0, exports.normalizePagePath)(pagePath);
+    const pagePathParts = cleanPagePath.split("/").slice(0, -1);
+    const pagePathInterceptedParts = (0, exports.normalizeInterceptingRoutes)(pagePathParts);
+    const pathnameParts = cleanUrlPathname.split("/").slice(0, -1);
+    const isNotFoundPage = pagePath.match(/\/_not-found\/?$/);
+    const isCorrectMatched = isNotFoundPage || isSamePaths(pathnameParts, pagePathInterceptedParts);
+    if (!isCorrectMatched) {
+        return exports.INVALID_PARSE;
+    }
+    const query = (0, exports.parseSegments)(pagePathInterceptedParts, pathnameParts);
+    return query;
+};
+exports.parseParams = parseParams;