oneentry 1.0.176 → 1.0.178

package/esm/templates/templatesInterfaces.d.ts

@@ -17,7 +17,7 @@ interface ITemplatesApi {
     /**
      * Get template objects by type.
      * @handleName getTemplateByType
-     * @param {BlockType} type - Type of templates to fetch. Example: "product".
+     * @param {BlockType} type - Type of templates to fetch. Example: "product_block". A type with no templates gives an empty array.
      * @param {string} [langCode] - Language code. Default: "en_US".
      * @returns {ITemplateEntity[]} Array of `ITemplateEntity` objects of the given type.
      * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
@@ -44,7 +44,7 @@ interface ITemplatesApi {
  * @property {number} generalTypeId - ID of the general type. Example: 67890.
  * @property {string} identifier - Text identifier (marker) of the object. Example: "template_12345".
  * @property {number} version - Version number of the object; changes with each update. Example: 1.
- * @property {BlockType} generalTypeName - General type name. Example: "product".
+ * @property {BlockType} generalTypeName - General type name. Example: "product_block".
  * @property {IAttributeValues} attributeValues - Attribute values keyed by marker; an empty object when there are none.
  * @example
     {

package/esm/templates-preview/templatesPreviewApi.js

@@ -26,7 +26,7 @@ export default class TemplatePreviewsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviews getTemplatePreviews} documentation.
      */
     async getTemplatePreviews(langCode = this.state.lang) {
-        const result = await this._fetchGet(`?langCode=${langCode}`);
+        const result = await this._fetchGet(`?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('TemplatePreviewsResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -42,7 +42,7 @@ export default class TemplatePreviewsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviewByMarker getTemplatePreviewByMarker} documentation.
      */
     async getTemplatePreviewByMarker(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)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('TemplatePreviewEntitySchema'));
         return this._normalizeData(validated, langCode);

package/esm/templates-preview/templatesPreviewInterfaces.d.ts

@@ -27,46 +27,52 @@ interface ITemplatesPreviewApi {
  * @interface ITemplatesPreviewEntity
  * @property {number} id - ID of the object. Example: 3.
  * @property {string} title - Name of the preview template. Example: "Product Template".
- * @property {object} proportions - Preview proportions: the horizontal, vertical and square variants.
+ * @property {object} proportions - Preview proportions: the horizontal, vertical and square variants under `default`.
  * @example
     {
       "default": {
         "horizontal": {
           "width": 234,
           "height": 324,
-          "alignmentType": "middleBottom"
+          "alignmentType": "middleBottom",
+          "weight": 234
         },
         "vertical": {
           "width": 2,
           "height": 3,
-          "alignmentType": "leftTop"
+          "alignmentType": "leftTop",
+          "weight": 2
         },
         "square": {
-          "side": 3,
-          "alignmentType": "leftTop"
-        }
+          "side": 360,
+          "alignmentType": "middleMiddle"
+        },
+        "default": true
       }
     }
- * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the preview.
+ * @property {IProportion | null} proportions.default.horizontal - Horizontal proportion of the preview.
  * @example
     {
       "width": 234,
       "height": 324,
-      "alignmentType": "middleBottom"
+      "alignmentType": "middleBottom",
+      "weight": 234
     }
- * @property {IProportion | null} proportions.vertical - Vertical variant of the preview, or `null`.
+ * @property {IProportion | null} proportions.default.vertical - Vertical variant of the preview, or `null`.
  * @example
     {
       "width": 2,
       "height": 3,
-      "alignmentType": "leftTop"
+      "alignmentType": "leftTop",
+      "weight": 2
     }
- * @property {ISquare} proportions.square - Square variant of the preview.
+ * @property {ISquare} proportions.default.square - Square variant of the preview.
  * @example
     {
-      "side": 3,
-      "alignmentType": "leftTop"
+      "side": 360,
+      "alignmentType": "middleMiddle"
     }
+ * @property {boolean} [proportions.default.default] - Whether these are the default proportions. Example: true.
  * @property {string} identifier - Text identifier (marker) of the object. Example: "preview-templates"
  * @property {number} version - Version number of the object; changes with each update. Example: 1.
  * @property {number} position - Position of the object, used for sorting. Example: 1.
@@ -95,12 +101,14 @@ interface ITemplatesPreviewProportions {
  * @property {IProportion | null} horizontal - Horizontal layout proportion, or null when not configured.
  * @property {IProportion | null} vertical - Vertical layout proportion, or null when not configured.
  * @property {ISquare} square - Square layout proportion.
+ * @property {boolean} [default] - Whether these are the default proportions. Example: true.
  * @description Layout proportion variants of a template preview.
  */
 interface ITemplatesPreviewProportionVariants {
     horizontal: IProportion | null;
     vertical: IProportion | null;
     square: ISquare;
+    default?: boolean;
 }
 /**
  * The `IProportion` interface defines the structure of a proportion object used in template previews.
@@ -108,12 +116,14 @@ interface ITemplatesPreviewProportionVariants {
  * @property {string | number | null} width - Width of the preview. Example: 100.
  * @property {string | number | null} height - Height of the preview. Example: 200.
  * @property {string} alignmentType - Alignment of the preview, such as `center`. Example: "center".
+ * @property {number | null} [weight] - Weight of the proportion; the API sends the width value. Example: 234.
  * @description Represents a proportion object used in template previews.
  */
 interface IProportion {
     width: number | null;
     height: number | null;
     alignmentType: string;
+    weight?: number | null;
 }
 /**
  * The `ISquare` interface defines the structure of a square proportion object used in template previews.

package/esm/templates-preview/templatesPreviewSchemas.d.ts

@@ -10,6 +10,7 @@ export declare const ProportionSchema: z.ZodObject<{
     width: z.ZodNullable<z.ZodNumber>;
     height: z.ZodNullable<z.ZodNumber>;
     alignmentType: z.ZodString;
+    weight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
 }, z.core.$strip>;
 /**
  * Square schema
@@ -31,16 +32,19 @@ export declare const TemplatePreviewEntitySchema: z.ZodObject<{
                 width: z.ZodNullable<z.ZodNumber>;
                 height: z.ZodNullable<z.ZodNumber>;
                 alignmentType: z.ZodString;
+                weight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
             }, z.core.$strip>>;
             vertical: z.ZodNullable<z.ZodObject<{
                 width: z.ZodNullable<z.ZodNumber>;
                 height: z.ZodNullable<z.ZodNumber>;
                 alignmentType: z.ZodString;
+                weight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
             }, z.core.$strip>>;
             square: z.ZodObject<{
                 side: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
                 alignmentType: z.ZodString;
             }, z.core.$strip>;
+            default: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     identifier: z.ZodString;
@@ -60,16 +64,19 @@ export declare const TemplatePreviewsResponseSchema: z.ZodArray<z.ZodObject<{
                 width: z.ZodNullable<z.ZodNumber>;
                 height: z.ZodNullable<z.ZodNumber>;
                 alignmentType: z.ZodString;
+                weight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
             }, z.core.$strip>>;
             vertical: z.ZodNullable<z.ZodObject<{
                 width: z.ZodNullable<z.ZodNumber>;
                 height: z.ZodNullable<z.ZodNumber>;
                 alignmentType: z.ZodString;
+                weight: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
             }, z.core.$strip>>;
             square: z.ZodObject<{
                 side: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
                 alignmentType: z.ZodString;
             }, z.core.$strip>;
+            default: z.ZodOptional<z.ZodBoolean>;
         }, z.core.$strip>;
     }, z.core.$strip>;
     identifier: z.ZodString;

package/esm/templates-preview/templatesPreviewSchemas.js

@@ -10,6 +10,7 @@ export const ProportionSchema = z.object({
     width: z.number().nullable(),
     height: z.number().nullable(),
     alignmentType: z.string(),
+    weight: z.number().nullable().optional(),
 });
 /**
  * Square schema
@@ -30,6 +31,7 @@ export const TemplatePreviewEntitySchema = z.object({
             horizontal: ProportionSchema.nullable(),
             vertical: ProportionSchema.nullable(),
             square: SquareSchema,
+            default: z.boolean().optional(),
         }),
     }),
     identifier: z.string(),

package/esm/user-groups/userGroupsApi.js

@@ -34,7 +34,7 @@ export default class UserGroupsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroups getUserGroups} documentation.
      */
     async getUserGroups(langCode = this.state.lang) {
-        const result = await this._fetchGet(`/?langCode=${langCode}`);
+        const result = await this._fetchGet(`/?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -49,7 +49,7 @@ export default class UserGroupsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getRootUserGroups getRootUserGroups} documentation.
      */
     async getRootUserGroups(langCode = this.state.lang) {
-        const result = await this._fetchGet(`/root?langCode=${langCode}`);
+        const result = await this._fetchGet(`/root?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
         return this._normalizeData(validated, langCode);
@@ -65,7 +65,7 @@ export default class UserGroupsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupById getUserGroupById} documentation.
      */
     async getUserGroupById(id, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/${id}?langCode=${langCode}`);
+        const result = await this._fetchGet(`/${this._pathSegment(String(id))}?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserGroupEntitySchema'));
         return this._normalizeData(validated, langCode);
@@ -81,7 +81,7 @@ export default class UserGroupsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getUserGroupByMarker getUserGroupByMarker} documentation.
      */
     async getUserGroupByMarker(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)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserGroupEntitySchema'));
         return this._normalizeData(validated, langCode);
@@ -98,7 +98,7 @@ export default class UserGroupsApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/user-groups/getChildUserGroupsByMarker getChildUserGroupsByMarker} documentation.
      */
     async getChildUserGroupsByMarker(marker, langCode = this.state.lang) {
-        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/children?langCode=${langCode}`);
+        const result = await this._fetchGet(`/marker/${this._pathSegment(marker)}/children?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserGroupsResponseSchema'));
         return this._normalizeData(validated, langCode);

package/esm/user-groups/userGroupsSchemas.d.ts

@@ -17,11 +17,11 @@ export declare const UserGroupEntitySchema: z.ZodObject<{
     localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
         title: z.ZodString;
         content: z.ZodOptional<z.ZodString>;
-        menuTitle: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>, z.ZodObject<{
         title: z.ZodString;
         content: z.ZodOptional<z.ZodString>;
-        menuTitle: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>]>;
     isVisible: z.ZodBoolean;
     childrenCount: z.ZodString;
@@ -40,11 +40,11 @@ export declare const UserGroupsResponseSchema: z.ZodArray<z.ZodObject<{
     localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodObject<{
         title: z.ZodString;
         content: z.ZodOptional<z.ZodString>;
-        menuTitle: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>>, z.ZodObject<{
         title: z.ZodString;
         content: z.ZodOptional<z.ZodString>;
-        menuTitle: z.ZodOptional<z.ZodString>;
+        menuTitle: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     }, z.core.$strip>]>;
     isVisible: z.ZodBoolean;
     childrenCount: z.ZodString;

package/esm/users/usersApi.d.ts

@@ -58,7 +58,7 @@ export default class UsersApi extends AsyncModules implements IUsersApi {
           },
           "state": {}
         }
-     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg".
      * @param {string} body.authData - Contains authentication credentials for the user. Example:
      * @example
         [

package/esm/users/usersApi.js

@@ -27,10 +27,21 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/getUser getUser} documentation.
      */
     async getUser(langCode = this.state.lang) {
-        const result = await this._fetchGet(`/me?langCode=${langCode}`);
+        const result = await this._fetchGet(`/me?langCode=${encodeURIComponent(langCode)}`);
         // Validate response if validation is enabled
         const validated = await this._validateResponse(result, schema('UserResponseSchema'));
-        return this._normalizeData(validated);
+        // `state` is the caller's own data, stored as written: the normalizer took a
+        // `{ en_US: … }` map in it for a localization and `{ type, value }` for an attribute.
+        // It is kept out of the normalization altogether — `{ attributes: { x: 's' } }`
+        // in it made `getUser` throw a TypeError.
+        if (validated &&
+            typeof validated === 'object' &&
+            !this._isErrorResponse(validated) &&
+            'state' in validated) {
+            const { state, ...rest } = validated;
+            return { ...this._normalizeData(rest, langCode), state };
+        }
+        return this._normalizeData(validated, langCode);
     }
     /**
      * Updating a single user object.
@@ -63,7 +74,7 @@ export default class UsersApi extends AsyncModules {
           },
           "state": {}
         }
-     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg".
      * @param {string} body.authData - Contains authentication credentials for the user. Example:
      * @example
         [
@@ -111,8 +122,13 @@ export default class UsersApi extends AsyncModules {
     async updateUser(body, langCode = this.state.lang) {
         // The language goes onto our own copy; the caller's body is left alone (CMS-909).
         const payload = 'langCode' in body ? body : { ...body, langCode };
-        const result = await this._fetchPut('/me', this._normalizePostBody(payload, langCode));
-        const validated = await this._validateResponse(result, schema('UpdateUserResponseSchema'));
+        // formData is wrapped under the language of the body: a `langCode: 'ru_RU'` in the
+        // body used to be sent with the fields under `en_US`
+        const bodyLang = payload.langCode || langCode;
+        const result = await this._fetchPut('/me', this._normalizePostBody(payload, bodyLang));
+        // An empty 2xx body comes back as `{}`; the method declares `true`. Read before
+        // validation: in strict mode the boolean schema turned that success into a 422
+        const validated = await this._validateResponse(this._asBoolean(result), schema('UpdateUserResponseSchema'));
         return validated;
     }
     /**
@@ -125,8 +141,8 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/archiveUser archiveUser} documentation.
      */
     async archiveUser() {
-        const result = await this._fetchDelete('/me');
-        return result;
+        // An empty 2xx body came back as `{}`; the method declares `true`
+        return this._fetchBoolean(() => this._fetchDelete('/me'));
     }
     /**
      * Delete a single user.
@@ -138,8 +154,7 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteUser deleteUser} documentation.
      */
     async deleteUser() {
-        const result = await this._fetchDelete('/me/account');
-        return result;
+        return this._fetchBoolean(() => this._fetchDelete('/me/account'));
     }
     /**
      * Adds an FCM (Firebase Cloud Messaging) token for sending push notifications.
@@ -152,8 +167,7 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/addFCMToken addFCMToken} documentation.
      */
     async addFCMToken(token) {
-        const result = await this._fetchPost(`/me/fcm-token/${token}`);
-        return result;
+        return this._fetchBoolean(() => this._fetchPost(`/me/fcm-token/${this._pathSegment(token)}`));
     }
     /**
      * Deletes an FCM (Firebase Cloud Messaging) token.
@@ -166,8 +180,7 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/deleteFCMToken deleteFCMToken} documentation.
      */
     async deleteFCMToken(token) {
-        const result = await this._fetchDelete(`/me/fcm-token/${token}`);
-        return result;
+        return this._fetchBoolean(() => this._fetchDelete(`/me/fcm-token/${this._pathSegment(token)}`));
     }
     /**
      * Get the current user's or guest's cart.
@@ -224,7 +237,7 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeCartItem removeCartItem} documentation.
      */
     async removeCartItem(productId) {
-        const result = await this._fetchDelete(`/me/cart/items/${productId}`);
+        const result = await this._fetchDelete(`/me/cart/items/${this._pathSegment(String(productId))}`);
         const validated = await this._validateResponse(result, schema('CartResponseSchema'));
         return this._normalizeData(validated);
     }
@@ -283,7 +296,7 @@ export default class UsersApi extends AsyncModules {
      * @see {@link https://js-sdk.oneentry.cloud/docs/users/removeWishlistItem removeWishlistItem} documentation.
      */
     async removeWishlistItem(productId) {
-        const result = await this._fetchDelete(`/me/wishlist/items/${productId}`);
+        const result = await this._fetchDelete(`/me/wishlist/items/${this._pathSegment(String(productId))}`);
         const validated = await this._validateResponse(result, schema('WishlistResponseSchema'));
         return this._normalizeData(validated);
     }

package/esm/users/usersInterfaces.d.ts

@@ -49,7 +49,7 @@ interface IUsersApi {
           },
           "state": {}
         }
-     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg_form".
+     * @param {string} body.formIdentifier - Identifies the registration form being used. Example: "reg".
      * @param {string} body.authData - Contains authentication credentials for the user. Example:
      * @example
         [
@@ -264,13 +264,7 @@ interface IUsersResponse {
       }
     ]
  * @property {string} formIdentifier - Marker of the form. Example: "form_12345".
- * @property {string} [total] - Deprecated, do not rely on it. A service counter that leaks into the response of a single user: always `"1"`, it carries no data about the user. The API reference does not describe it, and the field may disappear from the response. Example: "1".
- * @property {Array<string | number>} groups - User groups.
- * @example
-    [
-      "group_1",
-      "group_2"
-    ]
+ * @property {Array<string | number>} groups - IDs of the user groups the user belongs to (numbers on the API). Example: [1].
  * @property {object} state - Custom key-value data stored with the user.
  * @example
     {
@@ -288,7 +282,6 @@ interface IUserEntity {
     formData: FormDataType[];
     formIdentifier: string;
     /** @deprecated Service counter leaking into the response, always `"1"`; the field may disappear. */
-    total?: string;
     groups: Array<string | number>;
     state: Record<string, unknown>;
     moduleFormConfigs?: Array<IFormConfig>;

package/esm/web-socket/lazySocket.d.ts

@@ -8,11 +8,12 @@ import type { Socket } from 'socket.io-client';
  * queued and replayed onto the real socket as soon as the chunk resolves, and every later
  * call passes straight through.
  * @param {() => Promise<Socket>} createSocket - Loads Socket.io and creates the socket.
- * @returns {Socket} Stand-in usable exactly like the socket it will become.
+ * @returns {Socket} Stand-in usable like the socket it will become.
  * @description Listener registration is what matters for ordering, and it is safe: the queue is
  * replayed in the same tick the socket is created, before the connection can deliver anything.
- * The one visible difference is that methods returning a value (e.g. `listeners()`) cannot answer
- * before the chunk arrives — they return the proxy instead. Reading state (`id`, `connected`, …)
- * is accurate, and awaiting `socket.io` or other nested objects is only possible once loaded.
+ * Before the chunk arrives: `emitWithAck` returns a Promise settled by the real socket,
+ * `hasListeners`/`listeners` answer from the queued listeners, `socket.io.on(…)` and `volatile` are
+ * queued, assignments (e.g. `socket.auth = …`) are applied to the real socket, and other properties
+ * read `undefined`. A failed chunk load is reported to the `connect_error` listeners.
  */
-export default function createLazySocket(createSocket: () => Promise<Socket>): Socket;
+export default function createLazySocket<S extends Socket = Socket>(createSocket: () => Promise<S>): S;