oneentry 1.0.176 → 1.0.177

package/dist/auth-provider/authProviderApi.d.ts

@@ -90,7 +90,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * @handleName generateCode
      * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "reg".
      * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Obtaining a code to activate the user.
@@ -102,7 +102,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
      * @handleName checkCode
      * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "reg".
      * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -140,7 +140,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
             }
           ]
         }
-     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
      * @example
         [
           {
@@ -253,7 +253,7 @@ export default class AuthProviderApi extends AsyncModules implements IAuthProvid
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
+     * @returns {Promise<IAuthEntity | IError>} Returns the tokens of the signed-in user; they are stored in the state like after `auth`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User registration (authorization) via OAUTH.
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/oauth oauth} documentation.

package/dist/auth-provider/authProviderApi.js

@@ -126,17 +126,19 @@ class AuthProviderApi extends asyncModules_1.default {
     async signUp(marker, body, langCode = this.state.lang) {
         // `langCode` goes onto our own copy — the caller's body stays as it was
         // given, so a retry or a second parallel call sends the same thing (CMS-909).
-        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/sign-up`, this._normalizePostBody({ ...body, langCode }, langCode));
+        const result = await this._asSignIn()._fetchPost(`/marker/${this._pathSegment(marker)}/users/sign-up`, this._normalizePostBody({ ...body, langCode }, langCode));
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('SignUpResponseSchema'));
-        return this._normalizeData(validated);
+        // The fields went in under `langCode`; without it a sign-up in another language
+        // returned `formData` still keyed by that language
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Getting a user activation code. The code is returned via the appropriate user notification method.
      * @handleName generateCode
      * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier - Identifier (login) of the user, such as an email address. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "reg".
      * @returns {Promise<void | IError>} Returns void if the code is successfully generated, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description Obtaining a code to activate the user.
@@ -148,14 +150,15 @@ class AuthProviderApi extends asyncModules_1.default {
             eventIdentifier,
         };
         const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/generate-code`, data);
-        return result;
+        // An empty 2xx body is read as `{}`; the method returns nothing on success
+        return this._isErrorResponse(result) ? result : undefined;
     }
     /**
      * User activation code verification. Returns true (if the code is correct) or false (if it is incorrect).
      * @handleName checkCode
      * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {string} userIdentifier  - The text identifier of the user's object (user login). Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "user_registration".
+     * @param {string} eventIdentifier - Marker of the event the code is generated for. Example: "reg".
      * @param {string} code - One-time code the user received. Example: "123456".
      * @returns {Promise<boolean | IError>} Returns true if the code is correct, or an error object if there was an issue.
      * @throws {IError} When isShell=false and an error occurs during the fetch
@@ -169,7 +172,7 @@ class AuthProviderApi extends asyncModules_1.default {
             code,
         };
         const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/check-code`, data);
-        return result;
+        return this._asBoolean(result);
     }
     /**
      * User activate.
@@ -188,7 +191,7 @@ class AuthProviderApi extends asyncModules_1.default {
             code: code,
         };
         const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/activate`, data);
-        return result;
+        return this._asBoolean(result);
     }
     /**
      * User authorization.
@@ -208,7 +211,7 @@ class AuthProviderApi extends asyncModules_1.default {
             }
           ]
         }
-     * @param {{ marker: string; value: string | number }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
+     * @param {{ marker: string; value: string }[]} body.authData - An array of authentication data objects, each containing a marker and its corresponding value.
      * @example
         [
           {
@@ -224,12 +227,14 @@ class AuthProviderApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/auth auth} documentation.
      */
     async auth(marker, body) {
-        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/auth`, body);
+        const result = await this._asSignIn()._fetchPost(`/marker/${this._pathSegment(marker)}/users/auth`, body);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('AuthResponseSchema'));
         if (!('statusCode' in validated)) {
             this.state.accessToken = validated.accessToken;
             this.state.refreshToken = validated.refreshToken;
+            // The automatic refresh has to use the provider the session was opened with
+            this.state.providerMarker = marker;
             if (this.state.saveFunction && validated.refreshToken) {
                 this.state.saveFunction(validated.refreshToken);
             }
@@ -248,10 +253,17 @@ class AuthProviderApi extends asyncModules_1.default {
      */
     async refresh(marker, token) {
         const data = { refreshToken: token };
-        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/refresh`, data);
-        if (!('statusCode' in result)) {
+        // Sent as is: through the regular path a restored session (refresh token, no access
+        // token) first refreshed on its own, rotated this very token and the call answered 400
+        const result = await this._asSignIn()._fetchPost(`/marker/${this._pathSegment(marker)}/users/refresh`, data);
+        // Tokens are stored only when the answer carries them: an empty 2xx body came back
+        // as `{}` and wiped the session (`saveFunction(undefined)`)
+        if (!this._isErrorResponse(result) &&
+            typeof (result === null || result === void 0 ? void 0 : result.refreshToken) === 'string' &&
+            typeof (result === null || result === void 0 ? void 0 : result.accessToken) === 'string') {
             this.state.accessToken = result.accessToken;
             this.state.refreshToken = result.refreshToken;
+            this.state.providerMarker = marker;
             if (this.state.saveFunction) {
                 this.state.saveFunction(result.refreshToken);
             }
@@ -270,11 +282,51 @@ class AuthProviderApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/logout logout} documentation.
      */
     async logout(marker, token) {
-        const data = {
-            refreshToken: token,
+        var _a;
+        // Logout needs a bearer, so a restored session refreshes first — and that rotates the
+        // token passed in. Refresh up front and log out with the rotated one, or the call
+        // answered 400 and the session stayed alive
+        const wasCurrent = token === this.state.refreshToken;
+        if (!this.state.accessToken &&
+            !this.state.customAuth &&
+            wasCurrent &&
+            this._canRefresh() &&
+            (await this.refreshToken())) {
+            token = this.state.refreshToken;
+        }
+        const path = `/marker/${this._pathSegment(marker)}/users/logout`;
+        // Sent quietly and without throwing: a 401 mid-session refreshes and rotates the token
+        // the body carries, the retry answers 400 — that attempt is not the caller's failure
+        const attempt = async (refreshToken) => {
+            try {
+                return this._asBoolean(await this._asSubRequest()._fetchPost(path, {
+                    refreshToken,
+                }));
+            }
+            catch (error) {
+                return error;
+            }
         };
-        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/logout`, data);
-        if (result) {
+        let result = await attempt(token);
+        if (this._isErrorResponse(result) &&
+            wasCurrent &&
+            this.state.refreshToken &&
+            this.state.refreshToken !== token) {
+            result = await attempt(this.state.refreshToken);
+        }
+        if (this._isErrorResponse(result)) {
+            const handler = (_a = this.state.errorsFunctions) === null || _a === void 0 ? void 0 : _a[result.statusCode];
+            if (handler) {
+                await handler(result);
+            }
+            if (!this.state.isShell) {
+                throw result;
+            }
+            return result;
+        }
+        // An error object is truthy too: a failed logout used to wipe the tokens of a
+        // session that is still alive on the server
+        if (result && !this._isErrorResponse(result)) {
             this.state.accessToken = undefined;
             this.state.refreshToken = undefined;
             if (this.state.saveFunction) {
@@ -295,14 +347,16 @@ class AuthProviderApi extends asyncModules_1.default {
      */
     async logoutAll(marker) {
         const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/logout-all`);
-        if (result) {
+        // An error object is truthy too: a failed logout used to wipe the tokens of a
+        // session that is still alive on the server
+        if (result && !this._isErrorResponse(result)) {
             this.state.accessToken = undefined;
             this.state.refreshToken = undefined;
             if (this.state.saveFunction) {
                 this.state.saveFunction('');
             }
         }
-        return result;
+        return this._asBoolean(result);
     }
     /**
      * Change password.
@@ -329,7 +383,7 @@ class AuthProviderApi extends asyncModules_1.default {
             password2: repeatPassword !== null && repeatPassword !== void 0 ? repeatPassword : newPassword,
         };
         const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/users/change-password`, data);
-        return result;
+        return this._asBoolean(result);
     }
     /**
      * Get all auth providers objects.
@@ -343,7 +397,7 @@ class AuthProviderApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/getAuthProviders getAuthProviders} documentation.
      */
     async getAuthProviders(langCode = this.state.lang, offset = 0, limit = 30) {
-        const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        const result = await this._fetchGet(`?langCode=${encodeURIComponent(langCode)}&offset=${encodeURIComponent(String(offset))}&limit=${encodeURIComponent(String(limit))}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('AuthProvidersResponseSchema'));
         return this._normalizeData(validated);
@@ -359,7 +413,7 @@ class AuthProviderApi extends asyncModules_1.default {
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/getAuthProviderByMarker getAuthProviderByMarker} documentation.
      */
     async getAuthProviderByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}?langCode=${encodeURIComponent(langCode)}`);
         return this._normalizeData(result);
     }
     /**
@@ -373,7 +427,9 @@ class AuthProviderApi extends asyncModules_1.default {
      */
     async getActiveSessionsByMarker(marker) {
         const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/users/sessions`);
-        return this._normalizeData(result);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('ActiveSessionsResponseSchema'));
+        return this._normalizeData(validated);
     }
     /**
      * User registration (authorization) via OAUTH.
@@ -389,13 +445,24 @@ class AuthProviderApi extends asyncModules_1.default {
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {Promise<ISignUpEntity | IError>} Returns a user object.
+     * @returns {Promise<IAuthEntity | IError>} Returns the tokens of the signed-in user; they are stored in the state like after `auth`.
      * @throws {IError} When isShell=false and an error occurs during the fetch
      * @description User registration (authorization) via OAUTH.
      * @see {@link https://js-sdk.oneentry.cloud/docs/auth-provider/oauth oauth} documentation.
      */
     async oauth(marker, body, langCode = this.state.lang) {
-        const result = await this._fetchPost(`/marker/${this._pathSegment(marker)}/oauth`, this._normalizePostBody(body, langCode));
+        // A sign-in like `auth`: no current session, no refresh on 401, and the issued
+        // tokens are kept — they used to stay out of the state
+        const result = await this._asSignIn()._fetchPost(`/marker/${this._pathSegment(marker)}/oauth`, this._normalizePostBody(body, langCode));
+        if (!this._isErrorResponse(result) &&
+            typeof (result === null || result === void 0 ? void 0 : result.accessToken) === 'string') {
+            this.state.accessToken = result.accessToken;
+            this.state.refreshToken = result.refreshToken;
+            this.state.providerMarker = marker;
+            if (this.state.saveFunction && result.refreshToken) {
+                this.state.saveFunction(result.refreshToken);
+            }
+        }
         return result;
     }
 }

package/dist/auth-provider/authProviderSchemas.d.ts

@@ -24,6 +24,7 @@ export declare const SignUpResponseSchema: z.ZodObject<{
     importId: z.ZodNullable<z.ZodOptional<z.ZodAny>>;
     deletedAt: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     isDeleted: z.ZodOptional<z.ZodBoolean>;
+    oauthSub: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     state: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
     rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     attributeSetId: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;

package/dist/auth-provider/authProviderSchemas.js

@@ -28,6 +28,7 @@ exports.SignUpResponseSchema = zod_1.z.object({
     importId: zod_1.z.any().optional().nullable(),
     deletedAt: zod_1.z.string().optional().nullable(),
     isDeleted: zod_1.z.boolean().optional(),
+    oauthSub: zod_1.z.string().nullable().optional(),
     state: zod_1.z.record(zod_1.z.string(), zod_1.z.any()).optional(),
     rating: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()).optional(),
     attributeSetId: zod_1.z.number().nullable().optional(),

package/dist/auth-provider/authProvidersInterfaces.d.ts

@@ -47,7 +47,7 @@ interface IAuthProvider {
      * @handleName generateCode
      * @param {string} marker - The marker identifying the auth provider. Example: "email".
      * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The event identifier related to the code generation. Example: "user_registration".
+     * @param {string} eventIdentifier - The event identifier related to the code generation. Example: "reg".
      * @returns {void} A promise that resolves to void or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description This method generates an activation code for a user.
@@ -58,7 +58,7 @@ interface IAuthProvider {
      * @handleName checkCode
      * @param {string} marker - The marker identifying the auth provider. Example: "email".
      * @param {string} userIdentifier - The user's identifier. Example: "example@oneentry.cloud".
-     * @param {string} eventIdentifier - The event identifier related to the code verification. Example: "user_registration".
+     * @param {string} eventIdentifier - The event identifier related to the code verification. Example: "reg".
      * @param {string} code - The activation code to verify. Example: "123456".
      * @returns {boolean} A promise that resolves to a boolean indicating success or failure, or an error.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -162,7 +162,7 @@ interface IAuthProvider {
     getActiveSessionsByMarker(marker: string): Promise<IActiveSession[] | IError>;
     /**
      * User registration (authorization) via OAUTH.
-     * @handleName oauthSignUp
+     * @handleName oauth
      * @param {string} marker - Marker of the auth provider. Example: "email".
      * @param {IOauthData} body - OAuth data for registration.
      * @example
@@ -174,7 +174,7 @@ interface IAuthProvider {
           "redirect_uri": "http://localhost:3000"
         }
      * @param {string} [langCode] - Language code. Default: "en_US".
-     * @returns {ISignUpEntity} Returns a user object.
+     * @returns {IAuthEntity} Returns the tokens of the signed-in user; they are stored in the state like after `auth`.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
      * @description User registration (authorization) via OAUTH.
      */
@@ -267,6 +267,7 @@ interface IOauthData {
  * @property {unknown} [importId] - Import identifier. Example: null.
  * @property {string | null} [deletedAt] - Deletion date, or `null`. Example: null.
  * @property {boolean} [isDeleted] - Whether the user account is deleted. Example: false.
+ * @property {string | null} [oauthSub] - Subject of the OAuth account the user is linked to; `null` for a user signed up by e-mail. Example: null.
  * @property {Record<string, unknown>} [state] - Custom key-value data stored with the user. Example: {}.
  * @property {IRating} [rating] - Rating data: average value, likes and dislikes, and the calculation method.
  * @property {number | null} [attributeSetId] - ID of the attribute set attached to the user, or `null` when none is attached. Example: null.
@@ -286,6 +287,7 @@ interface ISignUpEntity {
     importId?: unknown;
     deletedAt?: string | null;
     isDeleted?: boolean;
+    oauthSub?: string | null;
     state?: Record<string, unknown>;
     rating?: IRating;
     attributeSetId?: number | null;
@@ -334,7 +336,7 @@ interface IAuthEntity {
  * @property {number} version - Version number of the auth provider; changes with each update. Example: 1.
  * @property {string} identifier - Marker of the auth provider. Example: "email".
  * @property {string} type - Type of the auth provider, for example `"email"`. Example: "email".
- * @property {string | null} formIdentifier - Marker of the form linked to the auth provider, or `null` if there is none. Example: "reg_form".
+ * @property {string | null} formIdentifier - Marker of the form linked to the auth provider, or `null` if there is none. Example: "reg".
  * @property {string} userGroupIdentifier - Identifier of the user group linked to the auth provider. Example: "guest".
  * @property {boolean} isActive - Whether the auth provider is active. Example: true.
  * @property {boolean} isCheckCode - Whether the auth provider requires a verification code. Example: false.
@@ -428,4 +430,4 @@ interface IDeviceInfo {
     browser: string;
     location: string;
 }
-export type { IActiveSession, IAuthData, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, ICodeEntity, IDeviceInfo, INotificationData, IOauthData, ISignUpData, ISignUpEntity, };
+export type { IActiveSession, IAuthData, IAuthEntity, IAuthFormData, IAuthPostBody, IAuthProvider, IAuthProvidersEntity, IAuthProvidersEntityConfig, ICodeEntity, IDeviceInfo, INotificationData, IOauthData, ISignUpData, ISignUpEntity, };

package/dist/base/asyncModules.d.ts

@@ -22,7 +22,7 @@ export default abstract class AsyncModules extends SyncModules {
      * body — and a caught exception — instead of throwing, so a failed request
      * is indistinguishable from a successful one by control flow alone.
      * @param {unknown} value - Value returned by a request.
-     * @returns {boolean} True when the value is an API error (statusCode >= 400) or a thrown error object.
+     * @returns {boolean} True when the value is an API error (statusCode >= 400), the shell error of a request that got no answer (statusCode 0) or a thrown error object.
      * @description Recognizes both the OneEntry error body and errors caught by browserResponse (e.g. a network failure).
      */
     protected _isErrorResponse(value: unknown): value is IError;
@@ -36,6 +36,58 @@ export default abstract class AsyncModules extends SyncModules {
      * validation disabled (the default) never pulls Zod into its bundle.
      */
     protected _validateResponse<T>(data: unknown, loadSchema?: () => Promise<z.ZodSchema<T>>): Promise<T | IError>;
+    /**
+     * A view of this module for sign-in and sign-up requests.
+     * @returns {this} An object that shares the module's state but sends the request without the current session.
+     * @description A sign-in with a wrong password answers `401`, the status of an expired token:
+     * with a session open the SDK used to refresh that session and send the same wrong password
+     * again — two failed attempts for one, and a rotated refresh token. Such a request carries
+     * no `Authorization` header and never triggers a token refresh.
+     */
+    protected _asSignIn(): this;
+    /**
+     * Set on the view `_asSignIn` returns: the request is a sign-in or sign-up.
+     */
+    protected _signIn: boolean;
+    /**
+     * A view of this module for requests the SDK makes on its own behalf.
+     * @returns {this} An object that shares the module's state but does not call `errors.customErrors`.
+     * @description The products of page blocks and the templates of pages are loaded by the SDK
+     * itself, and a failure there leaves an empty value. A `customErrors` handler (a Next.js
+     * `notFound()`) used to fire for them as if the page itself had failed.
+     */
+    protected _asSubRequest(): this;
+    /**
+     * Set on the view `_asSubRequest` returns.
+     */
+    protected _subRequest: boolean;
+    /**
+     * `_asSubRequest` for another module the SDK calls on its own behalf.
+     * @param {T} module - A module created by the SDK for a nested request.
+     * @returns {T} Its view that does not call `errors.customErrors`.
+     */
+    protected static _subRequestOf<T extends AsyncModules>(module: T): T;
+    /**
+     * Reads the answer of a call that returns `true` on success.
+     * @param {T} result - What the request returned.
+     * @returns {T | true} `true` for an empty 2xx body (read as `{}`), the value otherwise.
+     */
+    protected _asBoolean<T>(result: T): T | true;
+    /**
+     * Whether a refresh may be attempted now.
+     * @returns {boolean} False while the device metadata is the one the platform rejected as malformed.
+     */
+    protected _canRefresh(): boolean;
+    /**
+     * A view of this module whose requests go to another base URL.
+     * @param {string} url - The base URL for the view's requests.
+     * @returns {this} An object that shares the module's state and methods but has its own `_url`.
+     * @description For the few endpoints that live outside the module's base path. The base URL
+     * used to be swapped on the module itself for the duration of the call; two calls in flight
+     * at once (`Promise.all`) then sent one of them to the other base path, and the second
+     * `finally` restored the swapped URL — every later call of the instance went there too.
+     */
+    protected _withBaseUrl(url: string): this;
     /**
      * Prepares a caller value (a marker) to be one segment of a request path.
      * @param {string} value - The value to put into the path.
@@ -47,6 +99,15 @@ export default abstract class AsyncModules extends SyncModules {
      * API gets a marker it rejects as invalid rather than another route.
      */
     protected _pathSegment(value: string): string;
+    /**
+     * Prepares a caller path (a page URL) for a request path, keeping its `/`.
+     * @param {string} value - The path to put into the request path.
+     * @returns {string} Each `/`-separated part encoded by `_pathSegment`.
+     * @description A page URL may hold `/`, so it cannot be one segment; each part is
+     * encoded instead. `getProductsByPageUrl('../../all')` resolved to
+     * `POST /products/all` — the whole catalogue instead of one page.
+     */
+    protected _pathSegments(value: string): string;
     /**
      * Performs an HTTP GET request.
      * @param {string} path - The path to append to the base URL.