oneentry 1.0.159 → 1.0.161

package/esm/forms/formsSchemas.js

@@ -0,0 +1,32 @@
+import { z } from 'zod';
+/**
+ * Form entity schema
+ * Includes all fields returned by the API
+ */
+export const FormEntitySchema = z.object({
+    id: z.number(),
+    identifier: z.string(),
+    localizeInfos: z.union([z.record(z.string(), z.any()), z.array(z.any())]),
+    version: z.number(),
+    position: z.number(),
+    processingType: z.string(),
+    type: z.string().nullable(),
+    attributeSetId: z.number().nullable(),
+    templateId: z.number().nullable(),
+    total: z.union([z.number(), z.string()]).optional(),
+    attributes: z
+        .union([z.array(z.any()), z.record(z.string(), z.any())])
+        .optional(),
+    moduleFormConfigs: z.array(z.any()).optional(),
+});
+/**
+ * Forms response schema (paginated)
+ */
+export const FormsResponseSchema = z.object({
+    total: z.number(),
+    items: z.array(FormEntitySchema),
+});
+/**
+ * Single form response schema
+ */
+export const SingleFormSchema = FormEntitySchema;

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

@@ -0,0 +1,124 @@
+import AsyncModules from '../base/asyncModules.js';
+import type StateModule from '../base/stateModule.js';
+import type { IError } from '../base/utils.js';
+import type { IBodyPostFormData, IFormsByMarkerDataEntity, IFormsData, IFormsDataSearchResponse, IFormsDataVectorSearch, IPostFormResponse, IUpdateFormsData } from './formsDataInterfaces.js';
+/**
+ * Controllers for working with form data
+ * @handle /api/content/form-data
+ * @class FormsDataApi
+ * @augments AsyncModules
+ * @implements {IFormsData}
+ * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
+ */
+export default class FormsDataApi extends AsyncModules implements IFormsData {
+    protected state: StateModule;
+    protected _url: string;
+    /**
+     * Constructor for FormsDataApi class.
+     */
+    constructor(state: StateModule);
+    /**
+     * Creating an object of data save information by form
+     * @handleName postFormsData
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
+        {
+          "formIdentifier": "test-form",
+          "formModuleConfigId": 2,
+          "moduleEntityIdentifier": "blog",
+          "replayTo": null,
+          "status": "sent",
+          "formData": [
+            {
+            "marker": "name",
+            "type": "string",
+            "value": "Test"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
+        [
+          {
+            "marker": "name",
+            "type": "string",
+            "value": "Jack"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
+     */
+    postFormsData(body: IBodyPostFormData, langCode?: string): Promise<IPostFormResponse | IError>;
+    /**
+     * Get one object of form data by marker.
+     * @handleName getFormsDataByMarker
+     * @param {string} marker - Marker of the form. Example: "contact_form".
+     * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
+     * @param {object} [body] - Request body.
+     * @example
+        {
+          "entityIdentifier": 14,
+          "entityparentIdentifier": 167,
+          "userIdentifier": "",
+          "status": ["new", "approved"],
+          "dateFrom": "2025-01-01",
+          "dateTo": ""
+        }
+     * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
+     * @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<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
+     */
+    getFormsDataByMarker(marker: string, formModuleConfigId: number, body?: object, isExtended?: number, langCode?: string, offset?: number, limit?: number): Promise<IFormsByMarkerDataEntity | IError>;
+    /**
+     * Update one object of form data by id. Requires user authentication.
+     * @handleName updateFormsDataByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataByid updateFormsDataByid} documentation.
+     */
+    updateFormsDataByid(id: number, body?: object): Promise<IUpdateFormsData | IError>;
+    /**
+     * Update form data status by id. Requires user authentication.
+     * @handleName updateFormsDataStatusByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @param {object} body - Request body.
+     * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataStatusByid updateFormsDataStatusByid} documentation.
+     */
+    updateFormsDataStatusByid(id: number, body?: object): Promise<boolean | IError>;
+    /**
+     * Delete one object of form data by id. Requires user authentication.
+     * @handleName deleteFormsDataByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/deleteFormsDataByid deleteFormsDataByid} documentation.
+     */
+    deleteFormsDataByid(id: number): Promise<boolean | IError>;
+    /**
+     * Semantic (vector) search for form data.
+     * @handleName getFormsDataByVectorSearch
+     * @param {IFormsDataVectorSearch} body - Vector search body. Example: `{ queryText: "order confirmation" }`.
+     * @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<IFormsDataSearchResponse | IError>} Returns an object with an array of found form data records and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for form data.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByVectorSearch getFormsDataByVectorSearch} documentation.
+     */
+    getFormsDataByVectorSearch(body: IFormsDataVectorSearch, langCode?: string, offset?: number, limit?: number): Promise<IFormsDataSearchResponse | IError>;
+}

package/esm/forms-data/formsDataApi.js

@@ -0,0 +1,210 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import AsyncModules from '../base/asyncModules.js';
+import createSchemaLoader from '../base/lazySchema.js';
+import FileUploadingApi from '../file-uploading/fileUploadingApi.js';
+const schema = createSchemaLoader(() => import('./formsDataSchemas.js'));
+/**
+ * Controllers for working with form data
+ * @handle /api/content/form-data
+ * @class FormsDataApi
+ * @augments AsyncModules
+ * @implements {IFormsData}
+ * @description This class provides methods to interact with form data, including retrieving all forms data, creating new form data entries, and fetching form data by marker.
+ */
+export default class FormsDataApi extends AsyncModules {
+    /**
+     * Constructor for FormsDataApi class.
+     */
+    constructor(state) {
+        super(state);
+        this._url = state.url + '/api/content/form-data';
+    }
+    /**
+     * Creating an object of data save information by form
+     * @handleName postFormsData
+     * @param {IBodyPostFormData} body - Request body.
+     * @example
+        {
+          "formIdentifier": "test-form",
+          "formModuleConfigId": 2,
+          "moduleEntityIdentifier": "blog",
+          "replayTo": null,
+          "status": "sent",
+          "formData": [
+            {
+            "marker": "name",
+            "type": "string",
+            "value": "Test"
+            }
+          ]
+        }
+     * @param {string} body.formIdentifier - The identifier for the form. Example: "form".
+     * @param {number} body.formModuleConfigId - The ID of the form module configuration. Example: 2.
+     * @param {string} body.moduleEntityIdentifier - The identifier of the module entity. Example: "form".
+     * @param {string | null} [body.replayTo] - The email address to which the reply should be sent.
+     * @param {string | null} [body.status] - The status of the form submission.
+     * @param {FormDataType[]} body.formData - Form data.
+     * @example
+        [
+          {
+            "marker": "name",
+            "type": "string",
+            "value": "Jack"
+          }
+        ]
+     * @param {string} body.formData[].marker - The marker identifying the form field. Example: "name".
+     * @param {string} body.formData[].type - The type of the form field. Example: "string".
+     * @param {string} body.formData[].value - The value of the form field. Example: "Jack".
+     * @param {string} [langCode] - Language code. Default: "en_US".
+     * @returns {Promise<IPostFormResponse | IError>} Returns an object containing the created form data entry and message.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/postFormsData postFormsData} documentation.
+     */
+    async postFormsData(body, langCode = this.state.lang) {
+        const formData = {};
+        // filter button fields; keep spam fields so the captcha token in their `value` reaches the server
+        formData[langCode] = Array.isArray(body.formData)
+            ? body.formData.filter((fd) => fd.type !== 'button')
+            : [body.formData].filter((fd) => fd.type !== 'button');
+        /**
+         * Handle file uploads if fileQuery is present
+         * Check if there is any element in formData[langCode] that contains one of the specified types
+         */
+        if (formData[langCode].find((fd) => ['file', 'image', 'groupOfImages'].includes(fd.type))) {
+            // Create an instance of FileUploadingApi with the current state
+            const fileUploader = new FileUploadingApi(this.state);
+            // Process each element in formData[langCode] asynchronously
+            formData[langCode] = await Promise.all(formData[langCode].map(async (fd) => {
+                // Check if the type is one of the specified types
+                if (['file', 'image', 'groupOfImages'].includes(fd.type)) {
+                    // If fileQuery does not exist, we create it and assign it to an object with the following properties:
+                    if (!fd.fileQuery) {
+                        const fileQuery = {
+                            type: 'page',
+                            entity: 'editor',
+                            // Generate a random 4-digit ID
+                            id: Number(Math.floor(Math.random() * 10000)
+                                .toString()
+                                .padStart(4, '0')),
+                        };
+                        fd.fileQuery = fileQuery;
+                    }
+                    // Convert fd.value to an array if it is a FileList, otherwise use it directly
+                    const filesArray = typeof FileList !== 'undefined' && fd.value instanceof FileList
+                        ? Array.from(fd.value)
+                        : fd.value;
+                    // If filesArray is an array, upload each file asynchronously
+                    if (Array.isArray(filesArray)) {
+                        const uploadPromises = filesArray.map((file) => fileUploader.upload(file, fd.fileQuery).catch((e) => e));
+                        fd.value = (await Promise.all(uploadPromises)).flat();
+                    }
+                    // If fd.value is a single File or Blob, upload it
+                    else if (fd.value instanceof File || fd.value instanceof Blob) {
+                        fd.value = await fileUploader
+                            .upload(fd.value, fd.fileQuery)
+                            .catch((e) => e); // Catch any errors during upload
+                    }
+                    // Remove the 'fileQuery' property from the object after processing
+                    delete fd.fileQuery;
+                    // Remove  the 'contentType' property from the file object because it is not needed and not valid
+                    fd.value.map((file) => {
+                        delete file.contentType;
+                    });
+                }
+                // Return the processed form data element
+                return fd;
+            }));
+        }
+        body.formData = formData;
+        const result = await this._fetchPost(``, body);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('PostFormResponseSchema'));
+        return this._normalizeData(validated);
+    }
+    /**
+     * Get one object of form data by marker.
+     * @handleName getFormsDataByMarker
+     * @param {string} marker - Marker of the form. Example: "contact_form".
+     * @param {number} formModuleConfigId - Form module configuration ID. Example: 4.
+     * @param {object} [body] - Request body.
+     * @example
+        {
+          "entityIdentifier": 14,
+          "entityparentIdentifier": 167,
+          "userIdentifier": "",
+          "status": ["new", "approved"],
+          "dateFrom": "2025-01-01",
+          "dateTo": ""
+        }
+     * @param {number} [isExtended] - Flag for getting additional fields. Example: 1.
+     * @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<IFormsByMarkerDataEntity | IError>} Returns an object containing the form data or an error object if there was an issue.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByMarker getFormsDataByMarker} documentation.
+     */
+    async getFormsDataByMarker(marker, formModuleConfigId, body = {}, isExtended = 0, langCode = this.state.lang, offset = 0, limit = 30) {
+        const result = await this._fetchPost(`/marker/${marker}?formModuleConfigId=${formModuleConfigId}&isExtended=${isExtended}&langCode=${langCode}&offset=${offset}&limit=${limit}`, body);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('FormsByMarkerDataResponseSchema'));
+        return this._normalizeData(validated, langCode);
+    }
+    /**
+     * Update one object of form data by id. Requires user authentication.
+     * @handleName updateFormsDataByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @returns {Promise<IUpdateFormsData | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataByid updateFormsDataByid} documentation.
+     */
+    async updateFormsDataByid(id, body = {}) {
+        const result = await this._fetchPut(`/${id}`, body);
+        // Validate response if validation is enabled
+        const validated = await this._validateResponse(result, schema('UpdateFormsDataSchema'));
+        return validated;
+    }
+    /**
+     * Update form data status by id. Requires user authentication.
+     * @handleName updateFormsDataStatusByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @param {object} body - Request body.
+     * @returns {Promise<boolean | IError>} Returns an object containing the updated form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/updateFormsDataStatusByid updateFormsDataStatusByid} documentation.
+     */
+    async updateFormsDataStatusByid(id, body = {}) {
+        const result = await this._fetchPut(`/${id}/update-status`, body);
+        return result;
+    }
+    /**
+     * Delete one object of form data by id. Requires user authentication.
+     * @handleName deleteFormsDataByid
+     * @param {number} id - ID of the form data. Example: 1.
+     * @returns {Promise<boolean | IError>} Returns an object containing the deleted form data or an error object if there was an issue.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/deleteFormsDataByid deleteFormsDataByid} documentation.
+     */
+    async deleteFormsDataByid(id) {
+        const result = await this._fetchDelete(`/${id}`);
+        return result;
+    }
+    /**
+     * Semantic (vector) search for form data.
+     * @handleName getFormsDataByVectorSearch
+     * @param {IFormsDataVectorSearch} body - Vector search body. Example: `{ queryText: "order confirmation" }`.
+     * @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<IFormsDataSearchResponse | IError>} Returns an object with an array of found form data records and total count.
+     * @throws {IError} When isShell=false and an error occurs during the fetch
+     * @description This method performs a semantic (vector) search for form data.
+     * @see {@link https://js-sdk.oneentry.cloud/docs/forms-data/getFormsDataByVectorSearch getFormsDataByVectorSearch} documentation.
+     */
+    async getFormsDataByVectorSearch(body, langCode = this.state.lang, offset = 0, limit = 30) {
+        const query = {
+            langCode,
+            offset,
+            limit,
+        };
+        const result = await this._fetchPost(`/vector/search?` + this._queryParamsToString(query), body);
+        return this._normalizeData(result, langCode);
+    }
+}