oneentry 1.0.159 → 1.0.161

package/esm/templates/templatesApi.d.ts

@@ -0,0 +1,53 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { BlockType } from '../blocks/blocksInterfaces.js';
+import type { ITemplateEntity, ITemplatesApi } from './templatesInterfaces.js';
+/**
+ * Controllers for working with template objects
+ * @module TemplateController
+ * @handle /api/content/templates
+ * @description This module provides a set of controllers for handling operations related to template objects.
+ */
+export default class TemplatesPreviewApi extends AsyncModules implements ITemplatesApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all template objects grouped by types.
+     * @handleName getAllTemplates
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function is designed to fetch organized template objects in groups based on their types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
+     */
+    getAllTemplates(langCode?: string): Promise<Record<BlockType, ITemplateEntity[]> | IError>;
+    /**
+     * Get template objects by type.
+     * @handleName getTemplateByType
+     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetch template objects that belong to a specific type, with an optional filter by language.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
+     */
+    getTemplateByType(type: BlockType, langCode?: string): Promise<ITemplateEntity[] | IError>;
+    /**
+     * Get one template object by marker.
+     * @handleName getTemplateByMarker
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetch a specific template object based on its unique marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.
+     */
+    getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
+}

package/esm/templates/templatesApi.js

@@ -0,0 +1,78 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./templatesSchemas.js'));
+/**
+ * Controllers for working with template objects
+ * @module TemplateController
+ * @handle /api/content/templates
+ * @description This module provides a set of controllers for handling operations related to template objects.
+ */
+export default class TemplatesPreviewApi extends AsyncModules {
+    /**
+     * Constructor for TemplatesApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatesApi class with the provided state module instance.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/templates';
+    }
+    /**
+     * Get all template objects grouped by types.
+     * @handleName getAllTemplates
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<Record<BlockType, ITemplateEntity[]> | IError>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This function is designed to fetch organized template objects in groups based on their types.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getAllTemplates getAllTemplates} documentation.
+     */
+    async getAllTemplates(langCode = this.state.lang) {
+        const response = await this._fetchGet(`/all?langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(response, schema('GroupedTemplatesResponseSchema'));
+        const result = {};
+        if (validated &&
+            typeof validated === 'object' &&
+            !('statusCode' in validated)) {
+            const grouped = validated;
+            // eslint-disable-next-line no-restricted-syntax
+            for (const item in grouped) {
+                result[item] = this._normalizeData(grouped[item], langCode);
+            }
+        }
+        return result;
+    }
+    /**
+     * Get template objects by type.
+     * @handleName getTemplateByType
+     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplateEntity[] | IError>} Returns a TemplateEntity object.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetch template objects that belong to a specific type, with an optional filter by language.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByType getTemplateByType} documentation.
+     */
+    async getTemplateByType(type, langCode = this.state.lang) {
+        const result = await this._fetchGet(`?type=${type}&langCode=${langCode}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('TemplatesResponseSchema'));
+        return this._normalizeData(validated);
+    }
+    /**
+     * Get one template object by marker.
+     * @handleName getTemplateByMarker
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplateEntity | IError>} Returns a TemplateEntity object
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description Fetch a specific template object based on its unique marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates/getTemplateByMarker getTemplateByMarker} documentation.
+     */
+    async getTemplateByMarker(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('TemplateEntitySchema'));
+        return this._normalizeData(validated);
+    }
+}

package/esm/templates/templatesInterfaces.d.ts

@@ -0,0 +1,68 @@
+import type { IAttributeValues, IError } from '../base/utils.js';
+import type { BlockType } from '../blocks/blocksInterfaces.js';
+/**
+ * @interface ITemplatesApi
+ * @description This interface defines methods for retrieving templates in the system, including fetching all templates, specific templates by type or ID, and by marker.
+ */
+interface ITemplatesApi {
+    /**
+     * Get all template objects grouped by types.
+     * @handleName getAllTemplates
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Record<BlockType, ITemplateEntity[]>} Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets all template objects grouped by types.
+     */
+    getAllTemplates(langCode?: string): Promise<Record<BlockType, ITemplateEntity[]> | IError>;
+    /**
+     * Get template objects by type.
+     * @handleName getTemplateByType
+     * @param {BlockType} type - The type of templates to retrieve. This parameter specifies the category or classification of templates being requested. Example: "product".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity[]} Returns a TemplateEntity object.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets template objects by type.
+     */
+    getTemplateByType(type: BlockType, langCode: string): Promise<ITemplateEntity[] | IError>;
+    /**
+     * Get one template object by id.
+     * @handleName getTemplateByMarker
+     * @param {string} marker - The unique marker of the template to retrieve. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {ITemplateEntity} Returns a TemplateEntity object
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     * @description This method gets one template object by id.
+     */
+    getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;
+}
+/**
+ * The template entity interface
+ * @interface ITemplateEntity
+ * @property {number} id - The unique identifier of the position. Example: 12345.
+ * @property {string | null} attributeSetIdentifier - Set of attributes id. Example: "attribute_set_1".
+ * @property {string} title - The name of the template. Example: "Product Template".
+ * @property {number} generalTypeId - General type Entity id. Example: 67890.
+ * @property {string} identifier - The textual identifier for the record field. Example: "template_12345".
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {BlockType} generalTypeName - General type name. Example: "product".
+ * @property {IAttributeValues} attributeValues - Map of attribute values keyed by marker; empty object when none.
+ * @example
+    {
+      "id": 1,
+      "value": "some"
+    }
+ * @property {number} position - The position of the object. Example: 1.
+ * @description This interface defines the structure of a template entity, including its identifiers, attributes, and general type information.
+ */
+interface ITemplateEntity {
+    id: number;
+    attributeSetIdentifier: string | null;
+    title: string;
+    generalTypeId: number;
+    identifier: string;
+    version: number;
+    generalTypeName: BlockType;
+    attributeValues: IAttributeValues;
+    position: number;
+}
+export type { ITemplateEntity, ITemplatesApi };

package/esm/templates/templatesInterfaces.js

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

package/esm/templates/templatesSchemas.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Validation schemas for Templates module
+ * @description Zod schemas for validating templates-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Template entity schema
+ * Includes all fields returned by the API
+ */
+export declare const TemplateEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    generalTypeId: z.ZodNumber;
+    identifier: z.ZodString;
+    version: z.ZodNumber;
+    generalTypeName: z.ZodString;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    position: z.ZodNumber;
+}, z.core.$strip>;
+/**
+ * Templates response schema (array of templates)
+ */
+export declare const TemplatesResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    generalTypeId: z.ZodNumber;
+    identifier: z.ZodString;
+    version: z.ZodNumber;
+    generalTypeName: z.ZodString;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    position: z.ZodNumber;
+}, z.core.$strip>>;
+/**
+ * Grouped templates response schema (by type)
+ */
+export declare const GroupedTemplatesResponseSchema: z.ZodRecord<z.ZodString, z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    attributeSetIdentifier: z.ZodNullable<z.ZodString>;
+    title: z.ZodString;
+    generalTypeId: z.ZodNumber;
+    identifier: z.ZodString;
+    version: z.ZodNumber;
+    generalTypeName: z.ZodString;
+    attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
+    position: z.ZodNumber;
+}, z.core.$strip>>>;

package/esm/templates/templatesSchemas.js

@@ -0,0 +1,28 @@
+/**
+ * Validation schemas for Templates module
+ * @description Zod schemas for validating templates-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Template entity schema
+ * Includes all fields returned by the API
+ */
+export const TemplateEntitySchema = z.object({
+    id: z.number(),
+    attributeSetIdentifier: z.string().nullable(),
+    title: z.string(),
+    generalTypeId: z.number(),
+    identifier: z.string(),
+    version: z.number(),
+    generalTypeName: z.string(),
+    attributeValues: z.record(z.string(), z.any()),
+    position: z.number(),
+});
+/**
+ * Templates response schema (array of templates)
+ */
+export const TemplatesResponseSchema = z.array(TemplateEntitySchema);
+/**
+ * Grouped templates response schema (by type)
+ */
+export const GroupedTemplatesResponseSchema = z.record(z.string(), z.array(TemplateEntitySchema));

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

@@ -0,0 +1,40 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { ITemplatesPreviewApi, ITemplatesPreviewEntity } from './templatesPreviewInterfaces.js';
+/**
+ * Controllers for working with template objects for preview.
+ * @handle /api/content/template-previews
+ * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
+ */
+export default class TemplatePreviewsApi extends AsyncModules implements ITemplatesPreviewApi {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
+    constructor(state: StateModule);
+    /**
+     * Get all template objects.
+     * @handleName getTemplatePreviews
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity[] | IError>} - Returns all TemplatePreviewsEntity template objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to fetch all available template objects.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviews getTemplatePreviews} documentation.
+     */
+    getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
+    /**
+     * Retrieves a template object by its marker.
+     * @handleName getTemplatePreviewByMarker
+     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to fetch a specific template object based on the provided marker.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/templates-preview/getTemplatePreviewByMarker getTemplatePreviewByMarker} documentation.
+     */
+    getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
+}

package/esm/templates-preview/templatesPreviewApi.js

@@ -0,0 +1,50 @@
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+const schema = createSchemaLoader(() => import('./templatesPreviewSchemas.js'));
+/**
+ * Controllers for working with template objects for preview.
+ * @handle /api/content/template-previews
+ * @description This module provides a set of controllers for managing and retrieving template objects designed for preview purposes.
+ */
+export default class TemplatePreviewsApi extends AsyncModules {
+    /**
+     * Constructor for the TemplatePreviewsApi class.
+     * @param {StateModule} state - The state module instance.
+     * @description Initializes the TemplatePreviewsApi class with the provided state module instance.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/template-previews';
+    }
+    /**
+     * Get all template objects.
+     * @handleName getTemplatePreviews
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity[] | IError>} - Returns all TemplatePreviewsEntity template objects.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to fetch all available template objects.
+     * @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}`);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('TemplatePreviewsResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Retrieves a template object by its marker.
+     * @handleName getTemplatePreviewByMarker
+     * @param {string} marker - The unique product marker used to identify the template. If not provided, a default behavior or error may occur. Example: "template_12345".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<ITemplatesPreviewEntity | IError>} - A promise that resolves to a TemplatePreviewsEntity object representing the template.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method is used to fetch a specific template object based on the provided marker.
+     * @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/${marker}?langCode=${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

@@ -0,0 +1,129 @@
+import type { IError } from '../base/utils.js';
+/**
+ * @interface ITemplatesPreviewApi
+ * @description This interface defines methods for retrieving template previews in the system, including fetching all previews, specific previews by marker.
+ */
+interface ITemplatesPreviewApi {
+    /**
+     * Retrieves all template preview objects.
+     * @param {string} langCode - Language code for localization. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity[]} A promise resolving to an array of template preview entities or an error.
+     * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
+     */
+    getTemplatePreviews(langCode: string): Promise<ITemplatesPreviewEntity[] | IError>;
+    /**
+     * Retrieves a specific template preview object by its marker.
+     * @handleName getTemplatePreviewByMarker
+     * @param {string} marker     - The marker of the template preview. Example: "template_12345".
+     * @param {string} [langCode] - Language code for localization. Default: "en_US".
+     * @returns {ITemplatesPreviewEntity | IError} A promise resolving to the template preview 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 specific template preview object by its marker.
+     */
+    getTemplatePreviewByMarker(marker: string, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
+}
+/**
+ * The `ITemplatesPreview` interface defines the structure of template preview entities.
+ * @interface ITemplatesPreviewEntity
+ * @property {number} id - The unique identifier of the position. Example: 3.
+ * @property {string} title - The name of the template preview. Example: "Product Template"..
+ * @property {object} proportions - Object contains info by proportions template preview.
+ * @example
+    {
+      "default": {
+        "horizontal": {
+          "width": 234,
+          "height": 324,
+          "alignmentType": "middleBottom"
+        },
+        "vertical": {
+          "width": 2,
+          "height": 3,
+          "alignmentType": "leftTop"
+        },
+        "square": {
+          "side": 3,
+          "alignmentType": "leftTop"
+        }
+      }
+    }
+ * @property {IProportion | null} proportions.horizontal - Horizontal proportion of the template preview.
+ * @example
+    {
+      "width": 234,
+      "height": 324,
+      "alignmentType": "middleBottom"
+    }
+ * @property {IProportion | null} proportions.vertical - Vertical proportion of the template preview.
+ * @example
+    {
+      "width": 2,
+      "height": 3,
+      "alignmentType": "leftTop"
+    }
+ * @property {ISquare} proportions.square - Square proportion of the template preview.
+ * @example
+    {
+      "side": 3,
+      "alignmentType": "leftTop"
+    }
+ * @property {string} identifier - The textual identifier for the record field. Example: "preview-templates"
+ * @property {number} version - The version number of the object. Example: 1.
+ * @property {number} position - The position of the object. Example: 1.
+ * @property {boolean} isUsed - Indicates whether the template preview is used. Example: true.
+ * @description This interface defines the structure of a template preview entity, including its identifiers, attributes, proportions, and title.
+ */
+interface ITemplatesPreviewEntity {
+    id: number;
+    title: string;
+    proportions: ITemplatesPreviewProportions;
+    identifier: string;
+    version: number;
+    position: number;
+    isUsed: boolean;
+}
+/**
+ * @interface ITemplatesPreviewProportions
+ * @property {ITemplatesPreviewProportionVariants} default - Default proportion variants for horizontal, vertical, and square layouts.
+ * @description Container for proportion variants of a template preview.
+ */
+interface ITemplatesPreviewProportions {
+    default: ITemplatesPreviewProportionVariants;
+}
+/**
+ * @interface ITemplatesPreviewProportionVariants
+ * @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.
+ * @description Layout proportion variants of a template preview.
+ */
+interface ITemplatesPreviewProportionVariants {
+    horizontal: IProportion | null;
+    vertical: IProportion | null;
+    square: ISquare;
+}
+/**
+ * The `IProportion` interface defines the structure of a proportion object used in template previews.
+ * @interface IProportion
+ * @property {string | number | null} width - width of the template preview. Example: 100.
+ * @property {string | number | null} height - height of the template preview. Example: 200.
+ * @property {string} alignmentType - alignment type of the template preview. Example: "center".
+ * @description Represents a proportion object used in template previews.
+ */
+interface IProportion {
+    width: number | null;
+    height: number | null;
+    alignmentType: string;
+}
+/**
+ * The `ISquare` interface defines the structure of a square proportion object used in template previews.
+ * @interface ISquare
+ * @property {number | string} side - Side length of the square template preview, can be a number or string. Example: 100.
+ * @property {string} alignmentType - Alignment type of the square template preview. Example: "center".
+ * @description Represents a square proportion object used in template previews.
+ */
+interface ISquare {
+    side: number | string;
+    alignmentType: string;
+}
+export type { IProportion, ISquare, ITemplatesPreviewApi, ITemplatesPreviewEntity, ITemplatesPreviewProportions, ITemplatesPreviewProportionVariants, };

package/esm/templates-preview/templatesPreviewInterfaces.js

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

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

@@ -0,0 +1,79 @@
+/**
+ * Validation schemas for TemplatesPreviews module
+ * @description Zod schemas for validating templates previews-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Proportion schema
+ */
+export declare const ProportionSchema: z.ZodObject<{
+    width: z.ZodNullable<z.ZodNumber>;
+    height: z.ZodNullable<z.ZodNumber>;
+    alignmentType: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Square schema
+ */
+export declare const SquareSchema: z.ZodObject<{
+    side: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+    alignmentType: z.ZodString;
+}, z.core.$strip>;
+/**
+ * Template preview entity schema
+ * Includes all fields returned by the API
+ */
+export declare const TemplatePreviewEntitySchema: z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+    proportions: z.ZodObject<{
+        default: z.ZodObject<{
+            horizontal: z.ZodNullable<z.ZodObject<{
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>>;
+            vertical: z.ZodNullable<z.ZodObject<{
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>>;
+            square: z.ZodObject<{
+                side: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    identifier: z.ZodString;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    isUsed: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * Template previews response schema (array of template previews)
+ */
+export declare const TemplatePreviewsResponseSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    title: z.ZodString;
+    proportions: z.ZodObject<{
+        default: z.ZodObject<{
+            horizontal: z.ZodNullable<z.ZodObject<{
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>>;
+            vertical: z.ZodNullable<z.ZodObject<{
+                width: z.ZodNullable<z.ZodNumber>;
+                height: z.ZodNullable<z.ZodNumber>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>>;
+            square: z.ZodObject<{
+                side: z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>;
+                alignmentType: z.ZodString;
+            }, z.core.$strip>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    identifier: z.ZodString;
+    version: z.ZodNumber;
+    position: z.ZodNumber;
+    isUsed: z.ZodBoolean;
+}, z.core.$strip>>;

package/esm/templates-preview/templatesPreviewSchemas.js

@@ -0,0 +1,43 @@
+/**
+ * Validation schemas for TemplatesPreviews module
+ * @description Zod schemas for validating templates previews-related API responses
+ */
+import { z } from 'zod';
+/**
+ * Proportion schema
+ */
+export const ProportionSchema = z.object({
+    width: z.number().nullable(),
+    height: z.number().nullable(),
+    alignmentType: z.string(),
+});
+/**
+ * Square schema
+ */
+export const SquareSchema = z.object({
+    side: z.union([z.number(), z.string()]),
+    alignmentType: z.string(),
+});
+/**
+ * Template preview entity schema
+ * Includes all fields returned by the API
+ */
+export const TemplatePreviewEntitySchema = z.object({
+    id: z.number(),
+    title: z.string(),
+    proportions: z.object({
+        default: z.object({
+            horizontal: ProportionSchema.nullable(),
+            vertical: ProportionSchema.nullable(),
+            square: SquareSchema,
+        }),
+    }),
+    identifier: z.string(),
+    version: z.number(),
+    position: z.number(),
+    isUsed: z.boolean(),
+});
+/**
+ * Template previews response schema (array of template previews)
+ */
+export const TemplatePreviewsResponseSchema = z.array(TemplatePreviewEntitySchema);

package/esm/types.d.ts

@@ -0,0 +1,35 @@
+/**
+ * OneEntry SDK public types.
+ * @description Aggregates every public interface and type of the SDK in a single entry point,
+ * so consumers can import them from 'oneentry' or 'oneentry/types' instead of deep paths
+ * like 'oneentry/dist/attribute-sets/attributeSetsInterfaces'.
+ */
+export type * from './admins/adminsInterfaces.js';
+export type * from './attribute-sets/attributeSetsInterfaces.js';
+export type * from './auth-provider/authProvidersInterfaces.js';
+export type * from './base/utils.js';
+export type * from './blocks/blocksInterfaces.js';
+export type * from './discounts/discountsInterfaces.js';
+export type * from './events/eventsInterfaces.js';
+export type * from './file-uploading/fileUploadingInterfaces.js';
+export type * from './filters/filtersInterfaces.js';
+export type * from './forms/formsInterfaces.js';
+export type * from './forms-data/formsDataInterfaces.js';
+export type * from './general-types/generalTypesInterfaces.js';
+export type * from './integration-collections/integrationCollectionsInterfaces.js';
+export type * from './locales/localesInterfaces.js';
+export type * from './menus/menusInterfaces.js';
+export type * from './orders/ordersInterfaces.js';
+export type * from './pages/pagesInterfaces.js';
+export type * from './payments/paymentsInterfaces.js';
+export type * from './product-statuses/productStatusesInterfaces.js';
+export type * from './products/productsInterfaces.js';
+export type * from './search/searchInterfaces.js';
+export type * from './sitemap/sitemapInterfaces.js';
+export type * from './subscriptions/subscriptionsInterfaces.js';
+export type * from './system/systemInterfaces.js';
+export type * from './templates/templatesInterfaces.js';
+export type * from './templates-preview/templatesPreviewInterfaces.js';
+export type * from './user-activity/userActivityInterfaces.js';
+export type * from './users/usersInterfaces.js';
+export type * from './web-socket/wsInterfaces.js';