@nimpl/getters 2.0.0 → 2.1.0

package/README.md

@@ -4,9 +4,9 @@
 
 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/docs/getters#possible-issues)
+Before using the library, read the [Possible Issues](https://nimpl.tech/docs/server-getters#possible-issues)
 
-Visit https://nimpl.tech/docs/getters to view the full documentation.
+Visit https://nimpl.tech/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`.
 
@@ -26,10 +26,12 @@ yarn add @nimpl/getters
 
 ## Current Getters
 
-- [get-pathname](https://nimpl.tech/docs/getters#get-pathname)
-- [get-params](https://nimpl.tech/docs/getters#get-params)
-- [get-page-config](https://nimpl.tech/docs/getters#get-page-config)
-- [get-search-params](https://nimpl.tech/docs/getters#get-search-params) (_deprecated_)
+- [get-pathname](https://nimpl.tech/docs/server-getters#get-pathname)
+- [get-app-pathname](https://nimpl.tech/docs/server-getters#get-app-pathname)
+- [get-params](https://nimpl.tech/docs/server-getters#get-params)
+- [get-app-params](https://nimpl.tech/docs/server-getters#get-app-params)
+- [get-page-config](https://nimpl.tech/docs/server-getters#get-page-config)
+- [get-search-params](https://nimpl.tech/docs/server-getters#get-search-params) (_deprecated_)
 
 > _`create-server-context` and `get-server-context` were moved to a separate package - [@nimpl/context](https://nimpl.tech/docs/context)_
 

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,58 @@
+"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 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 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();
+    // 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 = (0, get_app_pathname_1.getAppPathname)();
+    const targetUrlPathname = pathname || urlPathname;
+    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/vordgi/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,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAppPathname = void 0;
+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 pageTags = pageStore.implicitTags.filter((tag) => tag.startsWith("_N_T_/"));
+    const pathnameTag = pageTags[pageTags.length - 1];
+    return pathnameTag.substring(5);
+}
+exports.getAppPathname = getAppPathname;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nimpl/getters",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Implementation of server getters in React Server Components without switching to SSR in next.js",
   "files": [
     "**/*.js",
@@ -18,6 +18,7 @@
     "getters",
     "implementation",
     "get-params",
+    "app router",
     "rsc"
   ],
   "repository": {