oneentry 1.0.161 → 1.0.162

package/esm/discounts/discountsInterfaces.d.ts

@@ -134,6 +134,7 @@ interface IDiscountCondition {
  * @property {Record<string, unknown>} [bonusEvent] - Bonus event configuration.
  * @property {number} [position] - Position number for sorting. Example: 1.
  * @property {number | string} [total] - Total count of related entries. Example: "1".
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  */
 interface IDiscountsEntity {
     id: number;
@@ -157,6 +158,7 @@ interface IDiscountsEntity {
     bonusEvent?: Record<string, unknown> | null;
     position?: number;
     total?: number | string;
+    distance?: number;
 }
 /**
  * @interface IDiscountValue

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

@@ -112,13 +112,15 @@ interface IFormsDataVectorSearch {
         "value": "Test"
       }
     ]
- * @property {string} [userIdentifier] - Text identifier of the user who submitted the form. Example: "user_12345".
- * @property {string} [entityIdentifier] - Text identifier of the entity the record belongs to. Example: "product_1".
- * @property {number} [parentId] - Identifier of the parent form data record. Example: 1.
+ * @property {string | null} [userIdentifier] - Text identifier of the user who submitted the form, or `null` for an anonymous submission. Example: null.
+ * @property {string} [entityIdentifier] - Text identifier of the entity the record belongs to. Example: "blog".
+ * @property {number | null} [parentId] - Identifier of the parent form data record, or `null` for a top-level record. Example: null.
  * @property {string} [ip] - IP address the form was submitted from. Example: "127.0.0.1".
  * @property {string} [fingerprint] - Device fingerprint of the sender. Example: "UQ_123456_abcdef".
  * @property {boolean} [isUserAdmin] - Whether the record was submitted by an admin. Example: false.
  * @property {'sent' | 'banned' | 'deleted' | 'moderation' | 'approved'} [status] - Moderation status of the record. Example: "sent".
+ * @property {number} [formModuleId] - Identifier of the form module the record belongs to. Example: 2.
+ * @property {number} [distance] - Cosine distance to the query. Returned only when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines a form data record as returned by the semantic (vector) search endpoint. Unlike IFormDataEntity it carries the moderation and sender fields of the raw record.
  */
 interface IFormDataSearchEntity {
@@ -126,13 +128,15 @@ interface IFormDataSearchEntity {
     formIdentifier?: string;
     time?: Date | string;
     formData?: FormDataType[];
-    userIdentifier?: string;
+    userIdentifier?: string | null;
     entityIdentifier?: string;
-    parentId?: number;
+    parentId?: number | null;
     ip?: string;
     fingerprint?: string;
     isUserAdmin?: boolean;
     status?: 'sent' | 'banned' | 'deleted' | 'moderation' | 'approved';
+    formModuleId?: number;
+    distance?: number;
 }
 /**
  * @interface IFormsDataSearchResponse

package/esm/menus/menusInterfaces.d.ts

@@ -44,6 +44,8 @@ interface IMenus {
     }
  * @property {number} position - The menu position. Example: 1.
  * @property {number | null} parentId - The menu parent id. Example: null.
+ * @property {'page' | 'custom' | null} [parentType] - Kind of the parent item: `page` for a menu page, `custom` for a custom item; `null` together with `parentId` means top level. Page ids and custom item ids overlap, so the parent is ambiguous without it. Example: null.
+ * @property {'page' | 'custom'} [itemType] - Kind of this item itself: `page` or `custom`. This is the value the item's children must pass in `parentType`. Example: "page".
  * @description This interface defines the structure of a menu page entity, including its identifiers, localization information, attributes, and hierarchical relationships.
  */
 interface IMenusPages {
@@ -54,6 +56,8 @@ interface IMenusPages {
     attributeValues: IAttributeValues;
     position: number;
     parentId: number | null;
+    parentType?: 'page' | 'custom' | null;
+    itemType?: 'page' | 'custom';
 }
 /**
  * @interface IMenusEntity

package/esm/menus/menusSchemas.js

@@ -12,6 +12,8 @@ export const MenusPagesSchema = z.lazy(() => z.object({
     attributeValues: z.record(z.string(), z.any()),
     position: z.number(),
     parentId: z.number().nullable(),
+    parentType: z.enum(['page', 'custom']).nullable().optional(),
+    itemType: z.enum(['page', 'custom']).optional(),
 }));
 /**
  * Menu entity schema

package/esm/orders/ordersInterfaces.d.ts

@@ -601,6 +601,7 @@ interface IOrderSplit {
  * @property {ILocalizeInfo | null} [paymentStatusLocalizeInfos] - Localized payment status name; null while no payment status is assigned.
  * @property {IOrderDiscountConfig | null} [discountConfig] - Resolved discount configuration applied to the order (orderDiscounts, productDiscounts, coupon, settings, bonus, totals); null on older orders without a resolved discount config.
  * @property {IOrderSplit} [split] - Split (staged) payment configuration; present on the by-id order endpoint.
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description Represents an order storage object created by the user.
  */
 interface IOrderByMarkerEntity {
@@ -628,6 +629,7 @@ interface IOrderByMarkerEntity {
     paymentStatusLocalizeInfos?: ILocalizeInfo | null;
     discountConfig?: IOrderDiscountConfig | null;
     split?: IOrderSplit;
+    distance?: number;
 }
 /**
  * Interface representing an order status object.

package/esm/orders/ordersSchemas.d.ts

@@ -112,6 +112,7 @@ export declare const OrderEntitySchema: z.ZodObject<{
             status: z.ZodString;
         }, z.core.$strip>>;
     }, z.core.$strip>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Orders list response schema
@@ -180,6 +181,7 @@ export declare const OrdersResponseSchema: z.ZodObject<{
                 status: z.ZodString;
             }, z.core.$strip>>;
         }, z.core.$strip>>;
+        distance: z.ZodOptional<z.ZodNumber>;
     }, z.core.$strip>>;
     total: z.ZodNumber;
 }, z.core.$strip>;

package/esm/orders/ordersSchemas.js

@@ -97,6 +97,7 @@ export const OrderEntitySchema = z.object({
         })),
     })
         .optional(),
+    distance: z.number().optional(),
 });
 /**
  * Orders list response schema

package/esm/pages/pagesApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules.js';
 import type StateModule from '../base/stateModule.js';
 import type { IError } from '../base/utils.js';
-import type { IPageConfig, IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock } from './pagesInterfaces.js';
+import type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock } from './pagesInterfaces.js';
 /**
  * Controllers for working with page objects, including catalog pages
  * @handle /api/content/pages
@@ -80,16 +80,6 @@ export default class PagesApi extends AsyncModules implements IPagesApi {
      * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getBlocksByPageUrl getBlocksByPageUrl} documentation.
      */
     getBlocksByPageUrl(url: string, langCode?: string): Promise<IPositionBlock[] | IError>;
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Get settings for the page.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
-     */
-    getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage

package/esm/pages/pagesApi.js

@@ -174,23 +174,6 @@ export default class PagesApi extends AsyncModules {
         }));
         return normalizeResponse;
     }
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {Promise<IPageConfig | IError>} Returns a ConfigPage object with page display settings
-     * @throws {IError} When isShell=false and an error occurs during the fetch
-     * @description Get settings for the page.
-     * @see {@link https://js-sdk.oneentry.cloud/docs/pages/getConfigPageByUrl getConfigPageByUrl} documentation.
-     */
-    async getConfigPageByUrl(url) {
-        // Fetch data from the server using a GET request to retrieve forms for the specified page URL and language code
-        const result = await this._fetchGet(`/${url}/config`);
-        // Validate response if validation is enabled
-        const validated = await this._validateResponse(result, schema('PageConfigSchema'));
-        // return fetched data
-        return validated;
-    }
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage

package/esm/pages/pagesInterfaces.d.ts

@@ -66,15 +66,6 @@ interface IPagesApi {
      * @description This method gets all blocks by page url.
      */
     getBlocksByPageUrl(url: string, langCode?: LangType): Promise<IPositionBlock[] | IError>;
-    /**
-     * Get settings for the page.
-     * @handleName getConfigPageByUrl
-     * @param {string} url - Page URL. Example: "about".
-     * @returns {IPageConfig} Returns a ConfigPage object with page display settings
-     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
-     * @description This method gets settings for the page.
-     */
-    getConfigPageByUrl(url: string): Promise<IPageConfig | IError>;
     /**
      * Quick search for page objects with limited output.
      * @handleName searchPage
@@ -124,16 +115,6 @@ interface IPagesResponse {
     items: IPagesEntity[];
     total: number;
 }
-/**
- * @interface IPageConfig
- * @property {number | null} rowsPerPage - Number of lines per page. Example: 1.
- * @property {number | null} productsPerRow - Number of products per page. Example: 1.
- * @description This interface defines the configuration for pagination in pages, including the number of rows and products displayed per page.
- */
-interface IPageConfig {
-    rowsPerPage: number | null;
-    productsPerRow: number | null;
-}
 /**
  * @interface IPositionForm
  * @property {number} id - The identifier of the object. Example: 1764.
@@ -306,6 +287,7 @@ type PageType = 'catalog_page' | 'common_page' | 'error_page' | 'external_page';
  * @property {IRating} [rating] - Rating data.
  * @property {string} [total] - Total number of products linked to the page. Example: "10".
  * @property {string | null} [categoryPath] - Category path string; null for nested pages that have no own category path. Example: "catalog".
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description This interface defines the structure of a page entity, including its identifiers, attributes, and hierarchical relationships.
  */
 interface IPagesEntity {
@@ -330,6 +312,7 @@ interface IPagesEntity {
     childrenCount?: number;
     total?: string;
     categoryPath?: string | null;
+    distance?: number;
 }
 /**
  * @interface IPageSearchResult
@@ -341,4 +324,4 @@ interface IPageSearchResult {
     id: number;
     title: string;
 }
-export type { IPageConfig, IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock, IPositionForm, PageType, };
+export type { IPagesApi, IPageSearchResult, IPagesEntity, IPagesResponse, IPagesVectorSearch, IPositionBlock, IPositionForm, PageType, };

package/esm/pages/pagesSchemas.d.ts

@@ -34,6 +34,7 @@ export declare const PageEntitySchema: z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Pages response schema (array of pages)
@@ -65,6 +66,7 @@ export declare const PagesResponseSchema: z.ZodArray<z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>>;
 /**
  * Page search result schema
@@ -111,11 +113,5 @@ export declare const SinglePageSchema: z.ZodObject<{
     childrenCount: z.ZodOptional<z.ZodNumber>;
     total: z.ZodOptional<z.ZodString>;
     categoryPath: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-/**
- * Page config schema
- */
-export declare const PageConfigSchema: z.ZodObject<{
-    rowsPerPage: z.ZodNullable<z.ZodNumber>;
-    productsPerRow: z.ZodNullable<z.ZodNumber>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;

package/esm/pages/pagesSchemas.js

@@ -30,6 +30,7 @@ export const PageEntitySchema = z.object({
     childrenCount: z.number().optional(),
     total: z.string().optional(),
     categoryPath: z.string().nullable().optional(),
+    distance: z.number().optional(),
 });
 /**
  * Pages response schema (array of pages)
@@ -51,10 +52,3 @@ export const PageSearchResponseSchema = z.array(PageSearchResultSchema);
  * Single page response schema
  */
 export const SinglePageSchema = PageEntitySchema;
-/**
- * Page config schema
- */
-export const PageConfigSchema = z.object({
-    rowsPerPage: z.number().nullable(),
-    productsPerRow: z.number().nullable(),
-});

package/esm/users/usersInterfaces.d.ts

@@ -278,6 +278,7 @@ interface IUsersResponse {
     }
  * @property {Array<IFormConfig>} [moduleFormConfigs] - Optional array of form configuration objects associated with the user.
  * @property {IRating} [rating] - Rating data.
+ * @property {number} [distance] - Cosine distance to the query. Returned only by the semantic (vector) search endpoint when `debug: true` is passed in the search body. Example: 0.12.
  * @description Represents a user entity with various properties, including identifiers, form data, and user groups.
  */
 interface IUserEntity {
@@ -291,6 +292,7 @@ interface IUserEntity {
     state: Record<string, unknown>;
     moduleFormConfigs?: Array<IFormConfig>;
     rating?: IRating;
+    distance?: number;
 }
 /**
  * @interface IUserBody

package/esm/users/usersSchemas.d.ts

@@ -18,6 +18,7 @@ export declare const UserResponseSchema: z.ZodObject<{
     state: z.ZodRecord<z.ZodString, z.ZodAny>;
     moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
     rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    distance: z.ZodOptional<z.ZodNumber>;
 }, z.core.$strip>;
 /**
  * Update user response schema (returns true on success)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.161",
+  "version": "1.0.162",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "module": "esm/index.js",
@@ -48,7 +48,7 @@
   },
   "scripts": {
     "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
-    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.161"
+    "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.162"
   },
   "sideEffects": false,
   "files": [