oneentry 1.0.159 → 1.0.161

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

@@ -0,0 +1,24 @@
+/**
+ * Validation schemas for FileUploading module
+ * @description Zod schemas for validating file uploading-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Upload return schema
+ * Includes filename, downloadLink, and size
+ */
+export declare const UploadingReturnSchema: z.ZodObject<{
+    filename: z.ZodString;
+    downloadLink: z.ZodString;
+    size: z.ZodNumber;
+    contentType: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Upload response schema (array of upload results)
+ */
+export declare const UploadResponseSchema: z.ZodArray<z.ZodObject<{
+    filename: z.ZodString;
+    downloadLink: z.ZodString;
+    size: z.ZodNumber;
+    contentType: z.ZodString;
+}, z.core.$strip>>;

package/esm/file-uploading/fileUploadingSchemas.js

@@ -0,0 +1,19 @@
+/**
+ * Validation schemas for FileUploading module
+ * @description Zod schemas for validating file uploading-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Upload return schema
+ * Includes filename, downloadLink, and size
+ */
+export const UploadingReturnSchema = z.object({
+    filename: z.string(),
+    downloadLink: z.string(),
+    size: z.number(),
+    contentType: z.string(),
+});
+/**
+ * Upload response schema (array of upload results)
+ */
+export const UploadResponseSchema = z.array(UploadingReturnSchema);

package/esm/filters/filtersApi.d.ts

@@ -0,0 +1,32 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IContentFilter, IFiltersApi } from './filtersInterfaces.js';
+/**
+ * Controllers for working with content filters.
+ * @handle /api/content/filters
+ * @class FiltersApi
+ * @augments AsyncModules
+ * @implements {IFiltersApi}
+ * @description This class provides methods to retrieve content filters.
+ */
+export default class FiltersApi extends AsyncModules implements IFiltersApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for FiltersApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
+     */
+    getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
+}

package/esm/filters/filtersApi.js

@@ -0,0 +1,36 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./filtersSchemas.js'));
+/**
+ * Controllers for working with content filters.
+ * @handle /api/content/filters
+ * @class FiltersApi
+ * @augments AsyncModules
+ * @implements {IFiltersApi}
+ * @description This class provides methods to retrieve content filters.
+ */
+export default class FiltersApi extends AsyncModules {
+    /**
+     * Constructor for FiltersApi class.
+     * @param {StateModule} state - The state module.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/filters';
+    }
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/filters/getFilterByMarker getFilterByMarker} documentation.
+     */
+    async getFilterByMarker(marker, langCode = this.state.lang) {
+        const data = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        const validated = await this._validateResponse(data, schema('ContentFilterSchema'));
+        return this._normalizeData(validated);
+    }
+}

package/esm/filters/filtersInterfaces.d.ts

@@ -0,0 +1,56 @@
+import type { IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * Interface for the Filters API module.
+ * @interface IFiltersApi
+ * @description This interface defines methods for retrieving content filters.
+ */
+interface IFiltersApi {
+    /**
+     * Get a filter by its marker (tree of items).
+     * @handleName getFilterByMarker
+     * @param {string} marker - Filter marker. Example: "main".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IContentFilter | IError>} Returns the filter with its items tree.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Retrieves a single content filter by marker.
+     */
+    getFilterByMarker(marker: string, langCode?: string): Promise<IContentFilter | IError>;
+}
+/**
+ * Type of a filter item tree node.
+ * @description Type of a filter item tree node (including `custom` for custom entries).
+ */
+type TContentFilterItemType = 'page' | 'product' | 'admin' | 'attribute' | 'discount' | 'personal-discount' | 'bonus' | 'payment-method' | 'custom';
+/**
+ * Content filter item (tree node).
+ * @interface IContentFilterItem
+ * @property {TContentFilterItemType} type - Tree node type. Example: "page".
+ * @property {string | null} [marker] - Marker of the linked entity, or null for type=page. Example: "about".
+ * @property {string | null} [url] - Page URL (only for type=page; null otherwise). Example: "about".
+ * @property {ILocalizeInfo} [localizeInfos] - Localized info of the linked entity in the requested locale.
+ * @property {string | string[] | null} [value] - Unified node value: an array of values in range for a range attribute, a resolved title for a legacy checkbox attribute, the discount value for discount/personal-discount/bonus, the object id for product/admin/payment-method, and null for a page. Example: ["25", "50", "75"].
+ * @property {number} [position] - Numeric position (per-level). Example: 1.
+ * @property {IContentFilterItem[]} [children] - Nested tree nodes (regular and custom items in a single array).
+ * @description A single node of a content filter items tree.
+ */
+interface IContentFilterItem {
+    type: TContentFilterItemType;
+    marker?: string | null;
+    url?: string | null;
+    localizeInfos?: ILocalizeInfo;
+    value?: string | string[] | null;
+    position?: number;
+    children?: IContentFilterItem[];
+}
+/**
+ * Content filter.
+ * @interface IContentFilter
+ * @property {ILocalizeInfo} localizeInfos - Localized info of the filter in the requested locale.
+ * @property {IContentFilterItem[]} [items] - Filter items tree (regular items + custom items in a single array).
+ * @description A content filter with its localized info and items tree.
+ */
+interface IContentFilter {
+    localizeInfos: ILocalizeInfo;
+    items?: IContentFilterItem[];
+}
+export type { IContentFilter, IContentFilterItem, IFiltersApi, TContentFilterItemType, };

package/esm/filters/filtersInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/filters/filtersSchemas.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Validation schemas for Filters module
+ * @description Zod schemas for validating filters-related API responses (raw API data, before normalization)
+ */
+import { z } from 'zod';
+/**
+ * Raw content filter item shape (before normalization), used to type the recursive schema.
+ * @description Raw filter item tree node as returned by the API (localizeInfos kept as a locale map).
+ */
+type IContentFilterItemRaw = {
+    type: string;
+    marker?: string | null;
+    url?: string | null;
+    localizeInfos?: Record<string, unknown>;
+    value?: string | string[] | null;
+    position?: number;
+    children?: IContentFilterItemRaw[];
+};
+/**
+ * Content filter item schema (recursive)
+ * @description Schema for a single filter item tree node; `children` recurses into the same schema
+ */
+export declare const ContentFilterItemSchema: z.ZodType<IContentFilterItemRaw>;
+/**
+ * Content filter schema
+ * @description Schema for a content filter returned by getFilterByMarker
+ */
+export declare const ContentFilterSchema: z.ZodObject<{
+    localizeInfos: z.ZodRecord<z.ZodString, z.ZodUnknown>;
+    items: z.ZodOptional<z.ZodArray<z.ZodType<IContentFilterItemRaw, unknown, z.core.$ZodTypeInternals<IContentFilterItemRaw, unknown>>>>;
+}, z.core.$strip>;
+export {};

package/esm/filters/filtersSchemas.js

@@ -0,0 +1,29 @@
+/**
+ * Validation schemas for Filters module
+ * @description Zod schemas for validating filters-related API responses (raw API data, before normalization)
+ */
+import { z } from 'zod';
+/**
+ * Content filter item schema (recursive)
+ * @description Schema for a single filter item tree node; `children` recurses into the same schema
+ */
+export const ContentFilterItemSchema = z.lazy(() => z.object({
+    type: z.string(),
+    marker: z.string().nullable().optional(),
+    url: z.string().nullable().optional(),
+    localizeInfos: z.record(z.string(), z.unknown()).optional(),
+    value: z
+        .union([z.string(), z.array(z.string())])
+        .nullable()
+        .optional(),
+    position: z.number().optional(),
+    children: z.array(ContentFilterItemSchema).optional(),
+}));
+/**
+ * Content filter schema
+ * @description Schema for a content filter returned by getFilterByMarker
+ */
+export const ContentFilterSchema = z.object({
+    localizeInfos: z.record(z.string(), z.unknown()),
+    items: z.array(ContentFilterItemSchema).optional(),
+});

package/esm/forms/formsApi.d.ts

@@ -0,0 +1,44 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IForms, IFormsEntity, IFormsResponse } from './formsInterfaces.js';
+/**
+ * Controllers for forms objects
+ * @class FormsApi
+ * @augments AsyncModules
+ * @implements {IForms}
+ * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
+ */
+export default class FormsApi extends AsyncModules implements IForms {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all forms.
+     * @handleName getAllForms
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
+     */
+    getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsResponse | IError>;
+    /**
+     * Get one form by form marker.
+     * @handleName getFormByMarker
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
+     */
+    getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
+}

package/esm/forms/formsApi.js

@@ -0,0 +1,54 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./formsSchemas.js'));
+/**
+ * Controllers for forms objects
+ * @class FormsApi
+ * @augments AsyncModules
+ * @implements {IForms}
+ * @description This class provides methods to interact with forms, including retrieving all forms and getting a form by its marker.
+ */
+export default class FormsApi extends AsyncModules {
+    /**
+     * Initializes the FormsApi with the provided state module.
+     * @class
+     * @class FormsApi
+     * @param {StateModule} state - The state module containing configuration data.
+     * @description Constructor initializes the FormsApi with a given state.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/forms';
+    }
+    /**
+     * Get all forms.
+     * @handleName getAllForms
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @param {number} [offset] - Parameter for pagination. Default: 0.
+     * @param {number} [limit] - Parameter for pagination. Default: 30.
+     * @returns {Promise<IFormsResponse | IError>} Returns paginated object with array of FormEntity and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getAllForms getAllForms} documentation.
+     */
+    async getAllForms(langCode = this.state.lang, offset = 0, limit = 30) {
+        const result = await this._fetchGet(`?langCode=${langCode}&offset=${offset}&limit=${limit}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('FormsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Get one form by form marker.
+     * @handleName getFormByMarker
+     * @param {string} marker - Marker of form. Example: "contact_form".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IFormsEntity | IError>} Returns object of type FormEntity.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms/getFormByMarker getFormByMarker} documentation.
+     */
+    async getFormByMarker(marker, langCode = this.state.lang) {
+        const result = await this._fetchGet(`/marker/${marker}?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('FormEntitySchema'));
+        return this._normalizeData(validated, langCode);
+    }
+}

package/esm/forms/formsInterfaces.d.ts

@@ -0,0 +1,237 @@
+import type { IPosition } from '../admins/adminsInterfaces.js';
+import type { AttributeType, IAttributeValidators, IListTitle } from '../attribute-sets/attributeSetsInterfaces.js';
+import type { IAttributeLocalizeInfo, IError, ILocalizeInfo } from '../base/utils.js';
+/**
+ * Interface for retrieving forms in the system.
+ * @interface IForms
+ * @description This interface defines methods for retrieving forms in the system.
+ */
+interface IForms {
+    /**
+     * Retrieves all forms in the system.
+     * @handleName getAllForms
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     * @param {number} [offset] - Optional offset for pagination. Default: 0.
+     * @param {number} [limit] - Optional limit for pagination. Default: 30.
+     * @returns {IFormsEntity[]} A promise that resolves to an array of form entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves all forms in the system.
+     */
+    getAllForms(langCode?: string, offset?: number, limit?: number): Promise<IFormsResponse | IError>;
+    /**
+     * Retrieves a form by its marker.
+     * @handleName getFormByMarker
+     * @param {string} marker - The marker identifying the form. Example: "contact_form".
+     * @param {string} [langCode] - The language code for localization. Default: "en_US".
+     * @returns {IFormsEntity} A promise that resolves to a form entity or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method retrieves a form by its marker.
+     */
+    getFormByMarker(marker: string, langCode?: string): Promise<IFormsEntity | IError>;
+}
+/**
+ * Represents the structure of a form page.
+ * @interface IFromPages
+ * @property {number} id - The unique identifier of the form page. Example: 123.
+ * @property {number} pageId - The identifier of the page. Example: 12.
+ * @property {number} formId - The identifier of the form. Example: 321.
+ * @property {number} positionId - The identifier of the position. Example: 1.
+ * @property {IPosition} position - The position object.
+ * @example
+    {
+      "id": 1,
+      "position": 1,
+      "objectId": 2,
+      "objectType": "admin",
+      "isLocked": false,
+      "objectCategoryId": 1
+    }
+ * @description This interface defines the structure of a form page.
+ */
+interface IFromPages {
+    id: number;
+    pageId: number;
+    formId: number;
+    positionId: number;
+    position: IPosition;
+}
+/**
+ * Represents the structure of a form entity.
+ * @interface IFormsEntity
+ * @property {number} id - The identifier of the object. Example: 12345.
+ * @property {number | null} attributeSetId - The identifier of the attribute set being used, or null if not applicable. Example: 1234.
+ * @property {string | null} type - Form type. Example: "contact".
+ * @property {IFormLocalizeInfo} localizeInfos - The name of the form and form-side localization fields (success/error messages, processing config, etc.).
+ * @example
+    {
+      "key": "value"
+    }
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {string} identifier - The textual identifier for the record field. Example: "form_contact_us".
+ * @property {string} processingType - Type of form processing. Example: "async".
+ * @property {number | null} templateId - The identifier of the template used by the form, or null if no template is used. Example: 6789.
+ * @property {IFormAttribute[]} attributes - Form fields with their localization, validators and form-specific flags, sorted by `position`. The API returns an empty object for forms with no attributes — the SDK normalizes it to an empty array.
+ * @property {number | string} [total] - Total count of related entries. Example: "1".
+ * @property {IFormConfig[]} [moduleFormConfigs] - Array of module form configurations associated with the form.
+ * @description This interface defines the structure of a form entity, including its identifiers, attributes, and processing data.
+ */
+interface IFormsEntity {
+    id: number;
+    attributeSetId: number | null;
+    type: 'order' | 'sign_in_up' | 'collection' | 'data' | 'rating' | null;
+    localizeInfos: IFormLocalizeInfo;
+    version: number;
+    position: number;
+    identifier: string;
+    processingType: string;
+    templateId: number | null;
+    attributes: IFormAttribute[];
+    total?: number | string;
+    moduleFormConfigs?: IFormConfig[];
+}
+/**
+ * @interface IFormLocalizeInfo
+ * @property {string} [title] - Localized name of the form. Optional — the payload is an empty object when the form has no localization for the requested language (e.g. in list responses). Example: "Contact form".
+ * @property {string} [titleForSite] - Public-facing title shown on the website. Example: "Form title (for application)".
+ * @property {string} [successMessage] - Message shown to the user after successful submission.
+ * @property {string} [unsuccessMessage] - Message shown to the user after a failed submission.
+ * @property {string} [urlAddress] - URL where the form data is sent for processing (used by `processingType: "url"`).
+ * @property {string} [database] - Database flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
+ * @property {string} [script] - Script flag/id used by the form processor (stringly-typed in the API: "0" / "1" / id).
+ * @description Localization payload of a form — extends {@link ILocalizeInfo} with form-side fields (messages, processing config). Unlike the base type, `title` is optional here.
+ */
+interface IFormLocalizeInfo extends Omit<ILocalizeInfo, 'title'> {
+    title?: string;
+    titleForSite?: string;
+    successMessage?: string;
+    unsuccessMessage?: string;
+    urlAddress?: string;
+    database?: string;
+    script?: string;
+}
+/**
+ * @interface IFormAttribute
+ * @property {string} marker - Field marker (machine name). Example: "email".
+ * @property {AttributeType} type - Attribute data type (e.g. "string", "file").
+ * @property {number} position - Sort position of the field. Example: 1.
+ * @property {boolean} isVisible - Whether the field is exposed to the user. Example: true.
+ * @property {IAttributeLocalizeInfo} localizeInfos - Localized labels for the field. For `timeInterval` attributes, also carries the `intervals` schedule payload.
+ * @property {unknown} initialValue - Default value applied when the field is not filled.
+ * @property {IListTitle[]} listTitles - Predefined options for `list`/`radioButton` fields; empty array for other types.
+ * @property {IAttributeValidators} validators - Validation rules; empty object when no validators are configured.
+ * @property {Record<string, unknown>} settings - Field-specific configuration; empty object by default.
+ * @property {Record<string, IFormAttributeAdditionalField>} additionalFields - Nested sub-fields keyed by marker; empty object when none.
+ * @property {boolean} [isLogin] - Whether this field carries the login value used for authentication. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isSignUp] - Whether this field is required during sign-up. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isPassword] - Whether this field carries the password value used for authentication. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isSignUpRequired] - Whether this field is required during sign-up. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isNotificationEmail] - Whether this field stores the email used for notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isNotificationPhonePush] - Whether this field stores the phone number used for push notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @property {boolean} [isNotificationPhoneSMS] - Whether this field stores the phone number used for SMS notifications. Optional — present only on attributes of sign-in/sign-up forms. Example: false.
+ * @description Definition of a single field inside a form — extends a generic attribute with form-specific authentication / notification flags (returned only for sign-in/sign-up forms).
+ */
+interface IFormAttribute {
+    marker: string;
+    type: AttributeType;
+    position: number;
+    isVisible: boolean;
+    localizeInfos: IAttributeLocalizeInfo;
+    initialValue: unknown;
+    listTitles: IListTitle[];
+    validators: IAttributeValidators;
+    settings: Record<string, unknown>;
+    additionalFields: Record<string, IFormAttributeAdditionalField>;
+    isLogin?: boolean;
+    isSignUp?: boolean;
+    isPassword?: boolean;
+    isSignUpRequired?: boolean;
+    isNotificationEmail?: boolean;
+    isNotificationPhonePush?: boolean;
+    isNotificationPhoneSMS?: boolean;
+    [key: string]: unknown;
+}
+/**
+ * @interface IFormAttributeAdditionalField
+ * @property {string} [marker] - Marker of the additional field. Optional — the API returns entries as `{ type, value }`, the marker itself is the key of the `additionalFields` map. Example: "additional_field".
+ * @property {string} type - Type of the additional field. Example: "string".
+ * @property {unknown} value - Value of the additional field, normalized like any other attribute value: `number | null` for numeric types, the file object itself for a single-file `image`/`file`, `null` when empty. Example: "Additional field data".
+ * @description A single nested entry inside {@link IFormAttribute}'s `additionalFields` map.
+ */
+interface IFormAttributeAdditionalField {
+    marker?: string;
+    type: string;
+    value: unknown;
+}
+/**
+ * Represents the structure of a form configuration.
+ * @interface IFormConfig
+ * @property {number} id - The identifier of the form configuration. Example: 123.
+ * @property {string} [formIdentifier] - The form identifier (only in products/pages API). Example: "review".
+ * @property {string} moduleIdentifier - The identifier of the module associated with the form configuration. Example: "module_identifier".
+ * @property {boolean} isGlobal - Indicates whether the form configuration is global. Example: true.
+ * @property {boolean} isClosed - Indicates whether the form configuration is closed. Example: true.
+ * @property {boolean} [isModerate] - Indicates whether the form requires moderation (only in products/pages API). Example: false.
+ * @property {boolean} [viewOnlyUserData] - Indicates whether the form configuration allows viewing user data (used in forms API). Example: true.
+ * @property {boolean} [commentOnlyUserData] - Indicates whether the form configuration allows commenting on user data (used in forms API). Example: true.
+ * @property {boolean} [viewOnlyMyData] - Indicates whether the form configuration allows viewing my data (used in products/pages API). Example: false.
+ * @property {boolean} [commentOnlyMyData] - Indicates whether the form configuration allows commenting on my data (used in products/pages API). Example: false.
+ * @property {object[]} entityIdentifiers - An array of entity identifiers associated with the form configuration.
+ * @property {string} entityIdentifiers[].id - Entity identifier. Example: "catalog".
+ * @property {boolean} entityIdentifiers[].isNested - Indicates if entity is nested. Example: false.
+ * @property {string[]} [nestedEntityIdentifiers] - An array of nested entity identifier strings (only in products/pages API). Example: ["catalog"].
+ * @property {string[]} [exceptionIds] - An array of exception identifiers.
+ * @property {number} [formDataCount] - Total count of form data entries (only in products/pages API). Example: 306.
+ * @property {Record<string, number>} [entityFormDataCount] - Form data count per entity identifier (only in products/pages API). Example: `{"catalog": 306}`.
+ * @property {boolean | null} [isRating] - Indicates whether this form config is for ratings. Example: null.
+ * @property {boolean | null} [isAnonymous] - Indicates whether anonymous submissions are allowed. Example: null.
+ * @property {boolean | null} [allowHalfRatings] - Indicates whether half ratings are allowed. Example: null.
+ * @property {boolean | null} [allowRerating] - Indicates whether re-rating is allowed. Example: null.
+ * @property {number | null} [maxRatingScale] - Maximum rating scale value. Example: 5.
+ * @property {string} [ratingCalculation] - Rating calculation method. Example: "average".
+ * @description This interface defines the structure of a form configuration, including its identifiers, module association, and entity identifiers. Different APIs return different field variants.
+ */
+interface IFormConfig {
+    id: number;
+    formIdentifier?: string;
+    moduleIdentifier: string;
+    isGlobal: boolean;
+    isClosed: boolean;
+    isModerate?: boolean;
+    viewOnlyUserData?: boolean;
+    commentOnlyUserData?: boolean;
+    viewOnlyMyData?: boolean;
+    commentOnlyMyData?: boolean;
+    entityIdentifiers: IEntityIdentifier[];
+    nestedEntityIdentifiers?: string[];
+    exceptionIds?: string[];
+    formDataCount?: number;
+    entityFormDataCount?: Record<string, number>;
+    isRating?: boolean | null;
+    isAnonymous?: boolean | null;
+    allowHalfRatings?: boolean | null;
+    allowRerating?: boolean | null;
+    maxRatingScale?: number | null;
+    ratingCalculation?: string;
+}
+/**
+ * @interface IEntityIdentifier
+ * @property {string} id - Entity identifier (e.g. page or product marker). Example: "blog".
+ * @property {boolean} isNested - Whether the entit, is treated as ,ested unde, its parent. Exa,ple: false.
+ * @description Reference to an entity attached to a form configuration.
+ */
+interface IEntityIdentifier {
+    id: string;
+    isNested: boolean;
+}
+/**
+ * Represents the paginated response structure for forms.
+ * @interface IFormsResponse
+ * @property {number} total - Total items count.
+ * @property {IFormsEntity[]} items - Array of form entities.
+ */
+interface IFormsResponse {
+    total: number;
+    items: IFormsEntity[];
+}
+export type { IEntityIdentifier, IFormAttribute, IFormAttributeAdditionalField, IFormConfig, IFormLocalizeInfo, IForms, IFormsEntity, IFormsResponse, IFromPages, };

package/esm/forms/formsInterfaces.js

@@ -0,0 +1 @@
+export {};

package/esm/forms/formsSchemas.d.ts

@@ -0,0 +1,56 @@
+import { z } from 'zod';
+/**
+ * Form entity schema
+ * Includes all fields returned by the API
+ */
+export declare const FormEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    processingType: z.ZodString;
+    type: z.ZodNullable<z.ZodString>;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    templateId: z.ZodNullable<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;
+/**
+ * Forms response schema (paginated)
+ */
+export declare const FormsResponseSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    items: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        identifier: z.ZodString;
+        localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
+        version: z.ZodNumber;
+        position: z.ZodNumber;
+        processingType: z.ZodString;
+        type: z.ZodNullable<z.ZodString>;
+        attributeSetId: z.ZodNullable<z.ZodNumber>;
+        templateId: z.ZodNullable<z.ZodNumber>;
+        total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+        attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+        moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Single form response schema
+ */
+export declare const SingleFormSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    identifier: z.ZodString;
+    localizeInfos: z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodAny>, z.ZodArray<z.ZodAny>]>;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    processingType: z.ZodString;
+    type: z.ZodNullable<z.ZodString>;
+    attributeSetId: z.ZodNullable<z.ZodNumber>;
+    templateId: z.ZodNullable<z.ZodNumber>;
+    total: z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>;
+    attributes: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodAny>, z.ZodRecord<z.ZodString, z.ZodAny>]>>;
+    moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
+}, z.core.$strip>;