oneentry 1.0.166 → 1.0.168

package/dist/file-uploading/fileUploadingSchemas.d.ts

@@ -22,3 +22,76 @@ export declare const UploadResponseSchema: z.ZodArray<z.ZodObject<{
     size: z.ZodNumber;
     contentType: z.ZodString;
 }, z.core.$strip>>;
+/**
+ * One record a found file is attached to
+ */
+export declare const FileSearchOwnerSchema: z.ZodObject<{
+    tableName: z.ZodString;
+    dataId: z.ZodNumber;
+    title: z.ZodString;
+    langCode: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Matching fragment of a found file
+ */
+export declare const FileSearchSnippetSchema: z.ZodObject<{
+    text: z.ZodString;
+    pageFrom: z.ZodNullable<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+ * One found file
+ */
+export declare const FileSearchItemSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    storageKey: z.ZodString;
+    extension: z.ZodString;
+    title: z.ZodNullable<z.ZodString>;
+    langCode: z.ZodNullable<z.ZodString>;
+    pageCount: z.ZodNullable<z.ZodNumber>;
+    rank: z.ZodNumber;
+    snippet: z.ZodNullable<z.ZodObject<{
+        text: z.ZodString;
+        pageFrom: z.ZodNullable<z.ZodNumber>;
+    }, z.core.$strip>>;
+    owners: z.ZodArray<z.ZodObject<{
+        tableName: z.ZodString;
+        dataId: z.ZodNumber;
+        title: z.ZodString;
+        langCode: z.ZodString;
+    }, z.core.$strip>>;
+    ownersTotal: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * File content search response
+ */
+export declare const FileSearchResponseSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    offset: z.ZodNumber;
+    limit: z.ZodNumber;
+    queryLanguage: z.ZodObject<{
+        resolved: z.ZodArray<z.ZodString>;
+        source: z.ZodString;
+        candidates: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>;
+    warnings: z.ZodArray<z.ZodString>;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        storageKey: z.ZodString;
+        extension: z.ZodString;
+        title: z.ZodNullable<z.ZodString>;
+        langCode: z.ZodNullable<z.ZodString>;
+        pageCount: z.ZodNullable<z.ZodNumber>;
+        rank: z.ZodNumber;
+        snippet: z.ZodNullable<z.ZodObject<{
+            text: z.ZodString;
+            pageFrom: z.ZodNullable<z.ZodNumber>;
+        }, z.core.$strip>>;
+        owners: z.ZodArray<z.ZodObject<{
+            tableName: z.ZodString;
+            dataId: z.ZodNumber;
+            title: z.ZodString;
+            langCode: z.ZodString;
+        }, z.core.$strip>>;
+        ownersTotal: z.ZodNumber;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/file-uploading/fileUploadingSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.UploadResponseSchema = exports.UploadingReturnSchema = void 0;
+exports.FileSearchResponseSchema = exports.FileSearchItemSchema = exports.FileSearchSnippetSchema = exports.FileSearchOwnerSchema = exports.UploadResponseSchema = exports.UploadingReturnSchema = void 0;
 /**
  * Validation schemas for FileUploading module
  * @description Zod schemas for validating file uploading-related API responses
@@ -20,3 +20,49 @@ exports.UploadingReturnSchema = zod_1.z.object({
  * Upload response schema (array of upload results)
  */
 exports.UploadResponseSchema = zod_1.z.array(exports.UploadingReturnSchema);
+/**
+ * One record a found file is attached to
+ */
+exports.FileSearchOwnerSchema = zod_1.z.object({
+    tableName: zod_1.z.string(),
+    dataId: zod_1.z.number(),
+    title: zod_1.z.string(),
+    langCode: zod_1.z.string(),
+});
+/**
+ * Matching fragment of a found file
+ */
+exports.FileSearchSnippetSchema = zod_1.z.object({
+    text: zod_1.z.string(),
+    pageFrom: zod_1.z.number().nullable(),
+});
+/**
+ * One found file
+ */
+exports.FileSearchItemSchema = zod_1.z.object({
+    id: zod_1.z.number(),
+    storageKey: zod_1.z.string(),
+    extension: zod_1.z.string(),
+    title: zod_1.z.string().nullable(),
+    langCode: zod_1.z.string().nullable(),
+    pageCount: zod_1.z.number().nullable(),
+    rank: zod_1.z.number(),
+    snippet: exports.FileSearchSnippetSchema.nullable(),
+    owners: zod_1.z.array(exports.FileSearchOwnerSchema),
+    ownersTotal: zod_1.z.number(),
+});
+/**
+ * File content search response
+ */
+exports.FileSearchResponseSchema = zod_1.z.object({
+    total: zod_1.z.number(),
+    offset: zod_1.z.number(),
+    limit: zod_1.z.number(),
+    queryLanguage: zod_1.z.object({
+        resolved: zod_1.z.array(zod_1.z.string()),
+        source: zod_1.z.string(),
+        candidates: zod_1.z.array(zod_1.z.string()),
+    }),
+    warnings: zod_1.z.array(zod_1.z.string()),
+    items: zod_1.z.array(exports.FileSearchItemSchema),
+});

package/dist/forms-data/formsDataInterfaces.d.ts

@@ -420,6 +420,133 @@ interface IUpdateFormsData {
  * Contains an array of data form objects with the following values
  */
 type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeText | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | IBodyTypeRadioButtonList | Record<string, unknown>;
+/**
+ * Value shapes accepted by a SUBMISSION (`POST /form-data`).
+ *
+ * For three field kinds they are not the shapes a page attribute uses, and a
+ * body written from the read types is refused. Measured on
+ * rwah2o.oneentry.cloud, 2026-09-12 and again 2026-09-28 (CMS-888).
+ *
+ * `list` takes a list of strings; the `[{ title, value }]` form of a page
+ * attribute answers `400 formData's marker '<marker>' value[0] must be a string`.
+ *
+ * `text` takes a one-element array holding exactly ONE of `plainValue`,
+ * `htmlValue` or `mdValue`, and no `params`. The object form answers
+ * `400 … value must be an array`, `params` answers `… is not allowed`, and two
+ * representations answer `Only one of htmlValue, plainValue or mdValue can be provided`.
+ *
+ * `spam` takes the captcha event, not the bare token.
+ */
+type FormDataPostType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyPostTypeText | IBodyPostTypeList | IBodyPostTypeSpam | IBodyTypeTextWithHeader | IBodyTypeImageGroupOfImages | IBodyTypeFile | Record<string, unknown>;
+/**
+ * Represents a `list` field of a form SUBMISSION.
+ * @interface IBodyPostTypeList
+ * @property {string} marker - marker name. Example: "recipient".
+ * @property {string} type - Type value. Example: "list".
+ * @property {string[]} value - Chosen options as plain strings. Example: ["Tom Hoffart"].
+ * @example
+    {
+      "marker": "recipient",
+      "type": "list",
+      "value": ["Tom Hoffart"]
+    }
+ * @description A submission sends the chosen options as strings. The `[{ title, value }]`
+ * shape a page attribute stores is refused here with `value[0] must be a string`.
+ */
+interface IBodyPostTypeList {
+    marker: string;
+    type: 'list';
+    value: string[];
+}
+/**
+ * Represents a `text` field of a form SUBMISSION.
+ * @interface IBodyPostTypeText
+ * @property {string} marker - marker name. Example: "your_message".
+ * @property {string} type - Type value. Example: "text".
+ * @property {ITextSubmissionValue[]} value - One-element array holding exactly one representation.
+ * @example
+    {
+      "marker": "your_message",
+      "type": "text",
+      "value": [{ "plainValue": "Hello" }]
+    }
+ * @description The array holds one object carrying exactly one of `plainValue`,
+ * `htmlValue` or `mdValue`. Editor `params` are refused, and so is sending two
+ * representations at once.
+ */
+interface IBodyPostTypeText {
+    marker: string;
+    type: 'text';
+    value: ITextSubmissionValue[];
+}
+/**
+ * @interface ITextSubmissionValuePlain
+ * @property {string} plainValue - Plain-text representation. Example: "Hello".
+ * @description Plain-text branch of a submitted text value.
+ */
+interface ITextSubmissionValuePlain {
+    plainValue: string;
+}
+/**
+ * @interface ITextSubmissionValueHtml
+ * @property {string} htmlValue - HTML representation. Example: "<p>Hello</p>".
+ * @description HTML branch of a submitted text value.
+ */
+interface ITextSubmissionValueHtml {
+    htmlValue: string;
+}
+/**
+ * @interface ITextSubmissionValueMd
+ * @property {string} mdValue - Markdown representation. Must not be empty. Example: "**Hello**".
+ * @description Markdown branch of a submitted text value.
+ */
+interface ITextSubmissionValueMd {
+    mdValue: string;
+}
+/**
+ * Exactly one representation of a submitted text value.
+ */
+type ITextSubmissionValue = ITextSubmissionValuePlain | ITextSubmissionValueHtml | ITextSubmissionValueMd;
+/**
+ * Represents a `spam` (captcha) field of a form SUBMISSION.
+ * @interface IBodyPostTypeSpam
+ * @property {string} marker - marker name. Example: "spam".
+ * @property {string} type - Type value. Example: "spam".
+ * @property {ICaptchaValue} value - The captcha event, not the bare token.
+ * @example
+    {
+      "marker": "spam",
+      "type": "spam",
+      "value": { "event": { "token": "<reCAPTCHA v3 token>", "siteKey": "6Ldjk7Yt…" } }
+    }
+ * @description The field carries a reCAPTCHA v3 token obtained in the browser.
+ * A bare string is refused with the same sentence as a wrong token —
+ * `Captcha Validation Failed, captcha type is: google` — so a malformed value
+ * is indistinguishable from a bot.
+ */
+interface IBodyPostTypeSpam {
+    marker: string;
+    type: 'spam';
+    value: ICaptchaValue;
+}
+/**
+ * @interface ICaptchaEvent
+ * @property {string} token - The token issued by the captcha provider in the browser.
+ * @property {string} siteKey - The site key the token was issued for. Example: "6Ldjk7Yt…".
+ * @description The captcha payload of a `spam` field.
+ */
+interface ICaptchaEvent {
+    token: string;
+    siteKey: string;
+}
+/**
+ * @interface ICaptchaValue
+ * @property {ICaptchaEvent} event - The captcha payload.
+ * @description Wrapper the platform expects around the captcha payload.
+ */
+interface ICaptchaValue {
+    event: ICaptchaEvent;
+}
 /**
  * Represents the structure of the body for posting form data.
  * @interface IBodyPostFormData
@@ -428,7 +555,7 @@ type FormDataType = IBodyTypeStringNumberFloat | IBodyTypeTimeDate | IBodyTypeTe
  * @property {string} moduleEntityIdentifier - Text identifier (marker) of the module entity. Example: "blog".
  * @property {string | null} replayTo - Email to reply to. Example: "some@email.com".
  * @property {string} status - Status of the form. Example: "sent".
- * @property {FormDataType[]} formData - Array of form data objects.
+ * @property {FormDataPostType[]} formData - Array of form data objects. A submission's value shapes differ from the read shapes — see FormDataPostType.
  * @example
     [
       {
@@ -455,7 +582,7 @@ interface IBodyPostFormData {
     moduleEntityIdentifier: string;
     replayTo: string | null;
     status: string;
-    formData: FormDataType[];
+    formData: FormDataPostType[];
     fileQuery?: IUploadingQuery;
 }
 /**
@@ -711,4 +838,4 @@ interface IListOptionValue {
     value: string;
     extended: IListOptionExtended;
 }
-export type { FormDataStatus, FormDataType, IBodyPostFormData, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };
+export type { FormDataPostType, FormDataStatus, FormDataType, IBodyPostFormData, IBodyPostTypeList, IBodyPostTypeSpam, IBodyPostTypeText, IBodyTypeFile, IBodyTypeImageGroupOfImages, IBodyTypeRadioButtonList, IBodyTypeStringNumberFloat, IBodyTypeText, IBodyTypeTextWithHeader, IBodyTypeTimeDate, ICaptchaEvent, ICaptchaValue, IFileValue, IFormByMarkerDataEntity, IFormDataEntity, IFormDataSearchEntity, IFormsByMarkerDataEntity, IFormsData, IFormsDataEntity, IFormsDataFilter, IFormsDataSearchResponse, IFormsDataVectorSearch, IImageValue, IImageValueParams, IListOptionExtended, IListOptionValue, IPostFormResponse, IPostFormResponseData, ITextEditorParams, ITextSubmissionValue, ITextValue, ITextWithHeaderValue, ITimeDateValue, IUpdateFormsData, };

package/dist/index.d.ts

@@ -28,6 +28,7 @@ import SystemApi from './system/systemApi';
 import TemplatesApi from './templates/templatesApi';
 import TemplatePreviewsApi from './templates-preview/templatesPreviewApi';
 import UserActivityApi from './user-activity/userActivityApi';
+import UserGroupsApi from './user-groups/userGroupsApi';
 import UsersApi from './users/usersApi';
 import WsApi from './web-socket/wsApi';
 export { getAdditionalFields, getAttributeFile, getAttributeFiles, isFileAttribute, isListAttribute, isNumberAttribute, isStringAttribute, } from './base/attributes';
@@ -62,6 +63,7 @@ export type * from './types';
  * @property {TemplatesApi} Templates - Templates API module.
  * @property {TemplatePreviewsApi} TemplatePreviews - Template previews API module.
  * @property {UserActivityApi} UserActivity - User activity API module.
+ * @property {UserGroupsApi} UserGroups - User groups API module.
  * @property {UsersApi} Users - Users API module.
  * @property {WsApi} WS - WebSocket API module.
  */
@@ -118,6 +120,8 @@ interface IDefineApi {
     TemplatePreviews: TemplatePreviewsApi;
     /** User/guest activity tracking: trackUserActivity */
     UserActivity: UserActivityApi;
+    /** User groups tree: getUserGroups, getRootUserGroups, getUserGroupByMarker, getChildUserGroupsByMarker */
+    UserGroups: UserGroupsApi;
     /** Current authenticated user: getUser, updateUser */
     Users: UsersApi;
     /** WebSocket real-time updates */

package/dist/index.js

@@ -35,6 +35,7 @@ const systemApi_1 = __importDefault(require("./system/systemApi"));
 const templatesApi_1 = __importDefault(require("./templates/templatesApi"));
 const templatesPreviewApi_1 = __importDefault(require("./templates-preview/templatesPreviewApi"));
 const userActivityApi_1 = __importDefault(require("./user-activity/userActivityApi"));
+const userGroupsApi_1 = __importDefault(require("./user-groups/userGroupsApi"));
 const usersApi_1 = __importDefault(require("./users/usersApi"));
 const wsApi_1 = __importDefault(require("./web-socket/wsApi"));
 var attributes_1 = require("./base/attributes");
@@ -107,6 +108,7 @@ function defineOneEntry(url, config) {
     const Templates = new templatesApi_1.default(stateModule);
     const TemplatePreviews = new templatesPreviewApi_1.default(stateModule);
     const UserActivity = new userActivityApi_1.default(stateModule);
+    const UserGroups = new userGroupsApi_1.default(stateModule);
     const Users = new usersApi_1.default(stateModule);
     const WS = new wsApi_1.default(stateModule);
     return {
@@ -136,6 +138,7 @@ function defineOneEntry(url, config) {
         Templates,
         TemplatePreviews,
         UserActivity,
+        UserGroups,
         Users,
         WS,
     };

package/dist/orders/ordersApi.d.ts

@@ -70,6 +70,20 @@ export default class OrdersApi extends AsyncModules implements IOrdersApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderByMarkerAndId getOrderByMarkerAndId} documentation.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization. Unlike `getOrderByMarkerAndId`,
+     * it does not need the storage marker — use it when only the order id is at hand, for
+     * example on the return URL of a payment provider or in a link from a notification.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderById getOrderById} documentation.
+     */
+    getOrderById(id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder

package/dist/orders/ordersApi.js

@@ -124,6 +124,25 @@ class OrdersApi extends asyncModules_1.default {
         const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
         return this._normalizeData(validated);
     }
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method requires user authorization. Unlike `getOrderByMarkerAndId`,
+     * it does not need the storage marker — use it when only the order id is at hand, for
+     * example on the return URL of a payment provider or in a link from a notification.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/orders/getOrderById getOrderById} documentation.
+     */
+    async getOrderById(id, langCode = this.state.lang) {
+        const result = await this._withOrdersUrl(() => this._fetchGet(`/${id}?langCode=${langCode}`));
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('OrderEntitySchema'));
+        return this._normalizeData(validated);
+    }
     /**
      * Preview order calculation with discounts and coupons (without saving).
      * @handleName previewOrder

package/dist/orders/ordersInterfaces.d.ts

@@ -52,6 +52,17 @@ interface IOrdersApi {
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getOrderByMarkerAndId(marker: string, id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
+    /**
+     * Getting a single order created by the user, by its own id.
+     * @handleName getOrderById
+     * @param {number} id - ID of the order object. Example: 12345.
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IOrderByMarkerEntity | IError>} Returns an object with the order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets a single order by its own id, without the storage marker. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getOrderById(id: number, langCode?: string): Promise<IOrderByMarkerEntity | IError>;
     /**
      * Creation of an order in the order storage.
      * @handleName createOrder

package/dist/payments/paymentsApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
 import type StateModule from '../base/stateModule';
 import type { IError } from '../base/utils';
-import type { IAccountsEntity, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
+import type { IAccountsEntity, IPaymentProgress, IPaymentsApi, ISessionEntity, ISessionsEntity } from './paymentsInterfaces';
 /**
  * Controllers for working with payments
  * @handle /api/content/payments
@@ -85,4 +85,17 @@ export default class PaymentsApi extends AsyncModules implements IPaymentsApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getAccountById getAccountById} documentation.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
+    /**
+     * Get the payment progress of an order: its stages and whether they are paid.
+     * @handleName getPaymentStagesByOrderId
+     * @param {number} id - ID of the order object. Example: 1.
+     * @returns {Promise<IPaymentProgress | IError>} Returns the payment progress of the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description An order can be paid in stages rather than in one payment — `partial` says
+     * which case it is, `completed` says whether nothing is left to pay, and every stage carries
+     * its own `status`. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getPaymentStagesByOrderId getPaymentStagesByOrderId} documentation.
+     */
+    getPaymentStagesByOrderId(id: number): Promise<IPaymentProgress | IError>;
 }

package/dist/payments/paymentsApi.js

@@ -157,5 +157,23 @@ class PaymentsApi extends asyncModules_1.default {
         const result = await this._fetchGet(`/accounts/${id}`);
         return this._normalizeData(result);
     }
+    /**
+     * Get the payment progress of an order: its stages and whether they are paid.
+     * @handleName getPaymentStagesByOrderId
+     * @param {number} id - ID of the order object. Example: 1.
+     * @returns {Promise<IPaymentProgress | IError>} Returns the payment progress of the order.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description An order can be paid in stages rather than in one payment — `partial` says
+     * which case it is, `completed` says whether nothing is left to pay, and every stage carries
+     * its own `status`. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/payments/getPaymentStagesByOrderId getPaymentStagesByOrderId} documentation.
+     */
+    async getPaymentStagesByOrderId(id) {
+        const result = await this._fetchGet(`/stages/order/${id}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('PaymentProgressSchema'));
+        return this._normalizeData(validated);
+    }
 }
 exports.default = PaymentsApi;

package/dist/payments/paymentsInterfaces.d.ts

@@ -66,6 +66,16 @@ interface IPaymentsApi {
      * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
      */
     getAccountById(id: number): Promise<IAccountsEntity | IError>;
+    /**
+     * Get the payment progress of an order: its stages and whether they are paid.
+     * @handleName getPaymentStagesByOrderId
+     * @param {number} id - ID of the order object. Example: 1.
+     * @returns {IPaymentProgress} Returns the payment progress of the order.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets the payment stages of an order. This method requires user authorization.
+     * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the  {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
+     */
+    getPaymentStagesByOrderId(id: number): Promise<IPaymentProgress | IError>;
 }
 /**
  * @interface ISessionsEntity
@@ -186,4 +196,36 @@ interface IPaymentAccountTestSettings {
     signingSecretKey?: string;
     useWebHookValidation?: boolean;
 }
-export type { IAccountsEntity, IIntent, IPaymentAccountSettings, IPaymentAccountTestSettings, IPaymentsApi, ISessionEntity, ISessionsEntity, };
+/**
+ * The `IPaymentProgress` interface describes the payment progress of an order.
+ * @interface IPaymentProgress
+ * @property {boolean} completed - True when every stage of the order has been paid. Example: false.
+ * @property {boolean} partial - True when the order is paid in stages rather than in one payment. Example: true.
+ * @property {IPaymentStage[]} stages - The stages themselves, in the order the API returns them.
+ * @description This interface describes the payment progress of an order — whether it is fully paid, whether it is split into stages, and the stages themselves.
+ */
+interface IPaymentProgress {
+    completed: boolean;
+    partial: boolean;
+    stages: IPaymentStage[];
+}
+/**
+ * The `IPaymentStage` interface describes one payment stage of an order.
+ * @interface IPaymentStage
+ * @property {string} marker - Marker of the attribute that set the price of the stage. Example: "part_a".
+ * @property {number} sessionId - Identifier of the payment session bound to the stage. Example: 100.
+ * @property {number} productId - Identifier of the product the stage belongs to. Example: 200.
+ * @property {string} title - Title of the stage. Example: "Part A".
+ * @property {number} value - Price of the stage. Example: 150.
+ * @property {"planned" | "completed"} status - Stage status: "planned" — not paid yet, "completed" — paid. Example: "planned".
+ * @description This interface describes one payment stage of an order.
+ */
+interface IPaymentStage {
+    marker: string;
+    sessionId: number;
+    productId: number;
+    title: string;
+    value: number;
+    status: 'planned' | 'completed';
+}
+export type { IAccountsEntity, IIntent, IPaymentAccountSettings, IPaymentAccountTestSettings, IPaymentProgress, IPaymentsApi, IPaymentStage, ISessionEntity, ISessionsEntity, };

package/dist/payments/paymentsSchemas.d.ts

@@ -92,3 +92,35 @@ export declare const PaymentAccountsResponseSchema: z.ZodArray<z.ZodObject<{
     localizeInfos: z.ZodRecord<z.ZodString, z.ZodAny>;
     updatedDate: z.ZodString;
 }, z.core.$strip>>;
+/**
+ * Payment stage schema
+ */
+export declare const PaymentStageSchema: z.ZodObject<{
+    marker: z.ZodString;
+    sessionId: z.ZodNumber;
+    productId: z.ZodNumber;
+    title: z.ZodString;
+    value: z.ZodNumber;
+    status: z.ZodEnum<{
+        completed: "completed";
+        planned: "planned";
+    }>;
+}, z.core.$strip>;
+/**
+ * Payment progress schema — stages of one order plus their aggregate state
+ */
+export declare const PaymentProgressSchema: z.ZodObject<{
+    completed: z.ZodBoolean;
+    partial: z.ZodBoolean;
+    stages: z.ZodArray<z.ZodObject<{
+        marker: z.ZodString;
+        sessionId: z.ZodNumber;
+        productId: z.ZodNumber;
+        title: z.ZodString;
+        value: z.ZodNumber;
+        status: z.ZodEnum<{
+            completed: "completed";
+            planned: "planned";
+        }>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/payments/paymentsSchemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
+exports.PaymentProgressSchema = exports.PaymentStageSchema = exports.PaymentAccountsResponseSchema = exports.PaymentAccountSchema = exports.SinglePaymentSessionSchema = exports.PaymentSessionsResponseSchema = exports.PaymentSessionSchema = void 0;
 const zod_1 = require("zod");
 /**
  * Payment session schema
@@ -54,3 +54,22 @@ exports.PaymentAccountSchema = zod_1.z.object({
  * Payment accounts response schema
  */
 exports.PaymentAccountsResponseSchema = zod_1.z.array(exports.PaymentAccountSchema);
+/**
+ * Payment stage schema
+ */
+exports.PaymentStageSchema = zod_1.z.object({
+    marker: zod_1.z.string(),
+    sessionId: zod_1.z.number(),
+    productId: zod_1.z.number(),
+    title: zod_1.z.string(),
+    value: zod_1.z.number(),
+    status: zod_1.z.enum(['planned', 'completed']),
+});
+/**
+ * Payment progress schema — stages of one order plus their aggregate state
+ */
+exports.PaymentProgressSchema = zod_1.z.object({
+    completed: zod_1.z.boolean(),
+    partial: zod_1.z.boolean(),
+    stages: zod_1.z.array(exports.PaymentStageSchema),
+});

package/dist/search/searchApi.d.ts

@@ -26,10 +26,11 @@ export default class SearchApi extends AsyncModules implements ISearchApi {
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
      * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
      * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Searches names and attribute values of visible records across entity types.
+     * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.
      * @see {@link https://js-sdk.oneentry.cloud/docs/search/globalSearch globalSearch} documentation.
      */
-    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number): Promise<IGlobalSearchResponse | IError>;
+    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number, langCode?: string): Promise<IGlobalSearchResponse | IError>;
 }

package/dist/search/searchApi.js

@@ -64,19 +64,23 @@ class SearchApi extends asyncModules_1.default {
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
      * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
      * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Searches names and attribute values of visible records across entity types.
+     * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.
      * @see {@link https://js-sdk.oneentry.cloud/docs/search/globalSearch globalSearch} documentation.
      */
-    async globalSearch(query, types, visibility, offset, limit) {
+    async globalSearch(query, types, visibility, offset, limit, langCode = this.state.lang) {
         // `types` is sent comma-separated — the array stringifies to exactly that.
+        // `langCode` is not optional decoration: the index is per language, and
+        // without it a word of a second locale answers an empty group (CMS-912).
         const params = {
             q: query,
             types,
             visibility,
             offset,
             limit,
+            langCode,
         };
         const data = await this._fetchGet(`?` + this._queryParamsToString(params));
         const validated = await this._validateResponse(data, schema('GlobalSearchResponseSchema'));

package/dist/search/searchInterfaces.d.ts

@@ -13,11 +13,12 @@ interface ISearchApi {
      * @param {'all' | 'visible' | 'hidden'} [visibility] - Visibility filter of the searched records. Default: "all".
      * @param {number} [offset] - Drilldown mode offset. Pass it only together with a single accessible type in `types`.
      * @param {number} [limit] - Drilldown mode page size. Pass it only together with a single accessible type in `types`, otherwise the API answers 400 "Drilldown mode (limit/offset) requires exactly one accessible type in `types`". Without it every group is returned in full.
+     * @param {string} [langCode] - Language code. Default: "en_US". The search index is per language: a word of a second locale is found only when its own langCode is sent (CMS-912).
      * @returns {Promise<IGlobalSearchResponse | IError>} Returns the query and the found records grouped by entity type.
      * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Searches names and attribute values of visible records across entity types.
+     * @description Searches names and attribute values of visible records across entity types. The index is per language — the request carries `langCode`, so a bilingual project finds a word of either locale.
      */
-    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number): Promise<IGlobalSearchResponse | IError>;
+    globalSearch(query: string, types?: TGlobalSearchEntityType[], visibility?: 'all' | 'visible' | 'hidden', offset?: number, limit?: number, langCode?: string): Promise<IGlobalSearchResponse | IError>;
 }
 /**
  * Entity type a global search group or item belongs to.

package/dist/types.d.ts

@@ -31,5 +31,6 @@ export type * from './system/systemInterfaces';
 export type * from './templates/templatesInterfaces';
 export type * from './templates-preview/templatesPreviewInterfaces';
 export type * from './user-activity/userActivityInterfaces';
+export type * from './user-groups/userGroupsInterfaces';
 export type * from './users/usersInterfaces';
 export type * from './web-socket/wsInterfaces';