oneentry 1.0.102 → 1.0.105

package/dist/system/systemInterfaces.d.ts

@@ -2,4 +2,4 @@ interface ISystem {
     test404(): Promise<any>;
     test500(): Promise<any>;
 }
-export { ISystem };
+export type { ISystem };

package/dist/templates/templatesApi.d.ts

@@ -1,7 +1,7 @@
 import AsyncModules from '../base/asyncModules';
-import { ITemplatesApi, ITemplateEntity } from './templatesInterfaces';
-import { IError, Types } from "../base/utils";
-import StateModule from "../base/stateModule";
+import type StateModule from '../base/stateModule';
+import type { IError, Types } from '../base/utils';
+import type { ITemplateEntity, ITemplatesApi } from './templatesInterfaces';
 /**
  * Controllers for working with template objects
  */
@@ -11,6 +11,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     constructor(state: StateModule);
     /**
      * Get all template objects grouped by types.
+     *
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
@@ -30,6 +31,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      *
      * @param {number} id - Template id
      * @param {string} [langCode] - Optional parameter language code
+     *
      * @returns Returns a TemplateEntity object
      */
     getTemplateById(id: number, langCode?: string): Promise<ITemplateEntity | IError>;
@@ -38,6 +40,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
      *
      * @param {number} marker - Template marker
      * @param {string} [langCode] - Optional parameter language code
+     *
      * @returns Returns a TemplateEntity object
      */
     getTemplateByMarker(marker: string, langCode?: string): Promise<ITemplateEntity | IError>;

package/dist/templates/templatesApi.js

@@ -1,6 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+/* eslint-disable @typescript-eslint/no-explicit-any */
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects
  */
@@ -11,6 +15,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     }
     /**
      * Get all template objects grouped by types.
+     *
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns an object GroupedTemplatesObject, which contains an array of template objects TemplateEntity
@@ -18,7 +23,8 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     async getAllTemplates(langCode = this.state.lang) {
         const response = await this._fetchGet(`/all?langCode=${langCode}`);
         const result = {};
-        for (let item in response) {
+        // eslint-disable-next-line no-restricted-syntax
+        for (const item in response) {
             result[item] = this._normalizeData(response[item], langCode);
         }
         return result;
@@ -40,6 +46,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      *
      * @param {number} id - Template id
      * @param {string} [langCode] - Optional parameter language code
+     *
      * @returns Returns a TemplateEntity object
      */
     async getTemplateById(id, langCode = this.state.lang) {
@@ -51,6 +58,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
      *
      * @param {number} marker - Template marker
      * @param {string} [langCode] - Optional parameter language code
+     *
      * @returns Returns a TemplateEntity object
      */
     async getTemplateByMarker(marker, langCode = this.state.lang) {

package/dist/templates/templatesInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { AttributeType, IError, Types } from "../base/utils";
+import type { AttributeType, IError, Types } from '../base/utils';
 /**
  * Represents an interface object of Templates Api.
  *
@@ -39,4 +39,4 @@ interface ITemplateEntity {
     attributeValues: AttributeType;
     attributeSetIdentifier: string | null;
 }
-export { ITemplatesApi, ITemplateEntity, };
+export type { ITemplateEntity, ITemplatesApi };

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

@@ -1,7 +1,7 @@
-import AsyncModules from "../base/asyncModules";
-import { ITemplatesPreview, ITemplatesPreviewEntity } from "./templatesPreviewInterfaces";
-import StateModule from "../base/stateModule";
-import { IError } from "../base/utils";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { ITemplatesPreview, ITemplatesPreviewEntity } from './templatesPreviewInterfaces';
 /**
  * Controllers for working with template objects for preview
  */
@@ -11,6 +11,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     constructor(state: StateModule);
     /**
      * Get all template objects.
+     *
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns all TemplatePreviewsEntity template objects

package/dist/templates-preview/templatesPreviewApi.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with template objects for preview
  */
@@ -11,6 +14,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     }
     /**
      * Get all template objects.
+     *
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns all TemplatePreviewsEntity template objects

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

@@ -1,11 +1,10 @@
-import { AttributeType, IError } from "../base/utils";
+import type { AttributeType, IError } from '../base/utils';
 /**
  * Represents an interface object of Templates Preview Api.
  *
+ * @interface
  * @property {function} getTemplatesPreview - Get all template objects.
- *
  * @property {function} getTemplatesPreviewById - Get one template object by id.
- *
  * @property {function} getTemplatesPreviewByMarker - Get one template object by marker.
  */
 interface ITemplatesPreview {
@@ -24,15 +23,13 @@ interface ITemplatesPreview {
  * @property {number} position - The position of the object.
  * @property {AttributeType} attributeValues - Attribute values from index.
  * @property {string} attributeSetIdentifier - Text identifier used for a set of attributes
- *
- *
  */
 interface ITemplatesPreviewEntity {
     id: number;
     version: number;
     identifier: string;
     attributeValues: AttributeType;
-    attributeSetIdentifier: string;
+    attributeSetIdentifier: string | null;
     proportion: {
         horizontal: IProportion | null;
         vertical: IProportion | null;
@@ -41,15 +38,29 @@ interface ITemplatesPreviewEntity {
     title: string;
     position: number;
 }
+/**
+ * IProportion
+ *
+ * @property {string | number | null} width -
+ * @property {string | number | null} height -
+ * @property {string} marker -
+ * @property {string} alignmentType -
+ */
 interface IProportion {
-    height: number | null;
-    weight: number | null;
+    width: string | number | null;
+    height: string | number | null;
     marker: string;
     alignmentType: string;
 }
+/**
+ * ISquare
+ * @property {string} marker -
+ * @property {number | string} side -
+ * @property {string} alignmentType -
+ */
 interface ISquare {
     marker: string;
-    slide: number;
+    side: number | string;
     alignmentType: string;
 }
-export { ITemplatesPreview, ITemplatesPreviewEntity, ISquare, IProportion };
+export type { IProportion, ISquare, ITemplatesPreview, ITemplatesPreviewEntity, };

package/dist/users/usersApi.d.ts

@@ -1,7 +1,7 @@
-import AsyncModules from "../base/asyncModules";
-import { IUserBody, IUserEntity, IUsers } from "./usersInterfaces";
-import StateModule from "../base/stateModule";
-import { IError } from "../base/utils";
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IError } from '../base/utils';
+import type { IUserBody, IUserEntity, IUsers } from './usersInterfaces';
 /**
  * Controllers for working with users
  */
@@ -47,8 +47,18 @@ export default class UsersApi extends AsyncModules implements IUsers {
      * }
      */
     updateUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
+    /**
+     * Delete a single user object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
+     * @param {object} data - Request body.
+     * @param {string} langCode - Optional language field
+     *
+     */
+    deleteUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
     /**
      * Adds FCM token for sending Push notification.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {string} token - Cloud messaging token.
@@ -56,6 +66,7 @@ export default class UsersApi extends AsyncModules implements IUsers {
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
      * Delete FCM token.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {string} token - Cloud messaging token.

package/dist/users/usersApi.js

@@ -1,6 +1,9 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users
  */
@@ -52,11 +55,34 @@ class UsersApi extends asyncModules_1.default {
     async updateUser(data, langCode = this.state.lang) {
         if (!('langCode' in data))
             data['langCode'] = langCode;
-        const result = await this._fetchPut('/me', data.hasOwnProperty('formData') ? this._normalizePostBody(data, langCode) : data);
+        const result = await this._fetchPut('/me', 
+        // eslint-disable-next-line no-prototype-builtins
+        data.hasOwnProperty('formData')
+            ? this._normalizePostBody(data, langCode)
+            : data);
+        return result;
+    }
+    /**
+     * Delete a single user object.
+     * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
+     *
+     * @param {object} data - Request body.
+     * @param {string} langCode - Optional language field
+     *
+     */
+    async deleteUser(data, langCode = this.state.lang) {
+        if (!('langCode' in data))
+            data['langCode'] = langCode;
+        const result = await this._fetchDelete('/me', 
+        // eslint-disable-next-line no-prototype-builtins
+        data.hasOwnProperty('formData')
+            ? this._normalizePostBody(data, langCode)
+            : data);
         return result;
     }
     /**
      * Adds FCM token for sending Push notification.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {string} token - Cloud messaging token.
@@ -67,6 +93,7 @@ class UsersApi extends asyncModules_1.default {
     }
     /**
      * Delete FCM token.
+     *
      * @description This method requires user authorization. For more information about configuring the authorization module, see the documentation in the configuration settings section of the SDK.
      *
      * @param {string} token - Cloud messaging token.

package/dist/users/usersInterfaces.d.ts

@@ -1,6 +1,6 @@
-import { IAuthFormData } from "../auth-provider/authProvidersInterfaces";
-import { FormDataType } from "../formsData/formsDataInterfaces";
-import { IError } from "../base/utils";
+import type { IAuthFormData } from '../auth-provider/authProvidersInterfaces';
+import type { IError } from '../base/utils';
+import type { FormDataType } from '../formsData/formsDataInterfaces';
 /**
  * Represents a interface object of Users Api.
  *
@@ -16,6 +16,9 @@ interface IUsers {
     addFCMToken(token: string): Promise<boolean | IError>;
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }
+/**
+ * IUserEntity
+ */
 interface IUserEntity {
     id: number;
     identifier: string;
@@ -25,6 +28,9 @@ interface IUserEntity {
     groups: Array<string>;
     state: Record<string, any>;
 }
+/**
+ * IUserBody
+ */
 interface IUserBody {
     formIdentifier: string;
     langCode?: string;
@@ -40,4 +46,4 @@ interface IUserBody {
     };
     state?: Record<string, any>;
 }
-export { IUsers, IUserEntity, IUserBody, };
+export type { IUserBody, IUserEntity, IUsers };

package/dist/web-socket/wsApi.d.ts

@@ -1,7 +1,7 @@
-import AsyncModules from "../base/asyncModules";
-import StateModule from "../base/stateModule";
-import { Socket } from "socket.io-client";
-import { IWS } from "./wsInterfaces";
+import type { Socket } from 'socket.io-client';
+import AsyncModules from '../base/asyncModules';
+import type StateModule from '../base/stateModule';
+import type { IWS } from './wsInterfaces';
 /**
  * Controllers for working with users
  */

package/dist/web-socket/wsApi.js

@@ -1,7 +1,10 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-const asyncModules_1 = require("../base/asyncModules");
 const socket_io_client_1 = require("socket.io-client");
+const asyncModules_1 = __importDefault(require("../base/asyncModules"));
 /**
  * Controllers for working with users
  */
@@ -20,21 +23,19 @@ class WsApi extends asyncModules_1.default {
      * socket.on('my_event', callback)
      */
     connect() {
-        if (this.state.accessToken) {
-            const socket = (0, socket_io_client_1.io)(this.state.url, {
-                autoConnect: true,
-                path: '/api/content/ws',
-                transports: ['websocket'],
-                extraHeaders: {
-                    "Authorization": 'Bearer ' + this.state.accessToken,
-                    "x-app-token": this.state.token
-                }
-            });
-            return socket;
-        }
-        else {
+        if (!this.state.accessToken) {
             console.error('User is unauthorized');
         }
+        const socket = (0, socket_io_client_1.io)(this.state.url, {
+            autoConnect: true,
+            path: '/api/content/ws',
+            transports: ['websocket'],
+            extraHeaders: {
+                Authorization: 'Bearer ' + this.state.accessToken,
+                'x-app-token': this.state.token,
+            },
+        });
+        return socket;
     }
 }
 exports.default = WsApi;

package/dist/web-socket/wsInterfaces.d.ts

@@ -1,4 +1,4 @@
-import { Socket } from "socket.io-client";
+import type { Socket } from 'socket.io-client';
 /**
  * Represents a interface object of WebSocket IO.
  *
@@ -7,4 +7,4 @@ import { Socket } from "socket.io-client";
 interface IWS {
     connect(): Socket;
 }
-export { IWS };
+export type { IWS };

package/package.json

@@ -1,14 +1,37 @@
 {
   "name": "oneentry",
-  "version": "1.0.102",
-  "description": "",
+  "version": "1.0.105",
+  "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
     "/dist"
   ],
   "scripts": {
-    "test": "jest"
+    "productionBuild": "run-s lint testAll build",
+    "testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes locales menus orders pages payments payments productstatuses products templates templatespreview users",
+    "admins": "npx jest src/admins/admins.spec.ts",
+    "attributesets": "npx jest src/attribute-sets/attributesets.spec.ts",
+    "authProvider": "npx jest src/auth-provider/authProvider.spec.ts",
+    "blocks": "npx jest src/blocks/blocks.spec.ts",
+    "fileuploading": "npx jest src/file-uploading/fileuploading.spec.ts",
+    "forms": "npx jest src/forms/forms.spec.ts",
+    "formsdata": "npx jest src/formsData/formsdata.spec.ts",
+    "generaltypes": "npx jest src/general-types/generaltypes.spec.ts",
+    "integrationcollections": "npx jest src/integration-collections/integrationcollections.spec.ts",
+    "locales": "npx jest src/locales/locales.spec.ts",
+    "menus": "npx jest src/menus/menus.spec.ts",
+    "orders": "npx jest src/orders/orders.spec.ts",
+    "pages": "npx jest src/pages/pages.spec.ts",
+    "payments": "npx jest src/payments/payments.spec.ts",
+    "productstatuses": "npx jest src/product-statuses/productstatuses.spec.ts",
+    "products": "npx jest src/products/products.spec.ts",
+    "templates": "npx jest src/templates/templates.spec.ts",
+    "templatespreview": "npx jest src/templates-preview/templatespreview.spec.ts",
+    "users": "npx jest src/users/users.spec.ts",
+    "lint": "npx eslint",
+    "build": "npx tsc",
+    "tsdoc": "tsdoc --src=src/admins/adminsApi.ts,src/attribute-sets/attributeSetsApi.ts,src/index.ts"
   },
   "bin": {
     "oneentry": "./configure.js"
@@ -17,14 +40,27 @@
   "license": "ISC",
   "dependencies": {
     "io": "^1.5.3",
-    "jsdoc": "^4.0.2",
-    "socket.io-client": "^4.7.5"
+    "socket.io-client": "^4.8.1"
   },
   "devDependencies": {
-    "@types/jest": "^29.5.11",
-    "@types/node": "^20.10.5",
+    "@jest/globals": "^29.7.0",
+    "@microsoft/tsdoc": "^0.15.1",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/jest": "^29.5.14",
+    "@types/node": "^22.10.10",
+    "@typescript-eslint/eslint-plugin": "^8.21.0",
+    "@typescript-eslint/parser": "^8.21.0",
+    "eslint": "^8.57.1",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-jest": "^28.11.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "typescript": "^5.3.3"
+    "npm-run-all": "^4.1.5",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "tsdoc-markdown": "^1.1.1",
+    "typescript": "^5.7.3"
   }
 }