oneentry 1.0.106 → 1.0.109

package/dist/products/productsApi.js

@@ -22,12 +22,12 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination and filter.
      *
-     * @param {Array<IFilterParams>} body - Request body. Default [].
+     * @param {Array<IFilterParams>} [body] - Request body. Default [].
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
      * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      * @param {number} [userQuery.statusId] - Optional parameter - search by status id
@@ -78,8 +78,8 @@ class ProductApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
@@ -97,13 +97,13 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {Array<IFilterParams>} body - Request body.
      * @param {number} id - Page id.
+     * @param {Array<IFilterParams>} body - Request body.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
      * @param {string} [userQuery.statusMarker] - Optional identifier of the product page status
      * @param {string} [userQuery.conditionValue] - Optional value that is being searched
      * @param {string} [userQuery.conditionMarker] - Optional identifier of the filter condition by which values are filtered
@@ -146,8 +146,8 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for information about products and prices for the selected category.
      *
-     * @param {string} url - Page url.
-     * @param {string} langCode - Language code.
+     * @param {string} [url] - Page url.
+     * @param {string} [langCode] - Language code.
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
      * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
@@ -173,8 +173,8 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Search for all products with pagination for the selected category.
      *
-     * @param {Array<IFilterParams>} body - Request body.
-     * @param {string} url - Page url.
+     * @param {string} [url] - Page url.
+     * @param {Array<IFilterParams>} [body] - Request body.
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
@@ -227,8 +227,8 @@ class ProductApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
      * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
@@ -246,8 +246,8 @@ class ProductApi extends asyncModules_1.default {
      * @param {string} [langCode] - Language code parameter. Default "en_US"
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      *
-     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 30
-     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.offset] - Optional parameter for pagination, default is 0
+     * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 30
      * @param {string} [userQuery.sortOrder] - Optional sorting order DESC | ASC
      * @param {string} [userQuery.sortKey] - Optional field to sort by (id, title, date, price, position, status)
      *
@@ -267,7 +267,7 @@ class ProductApi extends asyncModules_1.default {
      * Retrieve one product object.
      *
      * @param {number} [id] - Product id.
-     * @param {string} [langCode] Language code parameter. Default "en_US".
+     * @param {string} [langCode] - Language code parameter. Default "en_US".
      *
      * @returns  ProductEntity object.
      */
@@ -278,7 +278,7 @@ class ProductApi extends asyncModules_1.default {
     /**
      * Getting a product block object by product id.
      *
-     * @param {number} id - Product id
+     * @param {number} [id] - Product id
      */
     async getProductBlockById(id) {
         const response = await this._fetchGet(`/${id}/blocks`);

package/dist/products/productsInterfaces.d.ts

@@ -77,7 +77,7 @@ interface IFilterParams {
  * @property {object} additional - Additional value from the index.
  * @property {Record<string, any>} localizeInfos - The name of the products, taking into account localization.
  * @property {boolean} isVisible - A sign of page visibility.
- * @property {boolean} [isPositionLocked] - Sorting position lock indicator (optional).
+ * @property {boolean} isPositionLocked - Sorting position lock indicator (optional).
  * @property {number | null} statusIdentifier - Product page status identifiers (may be null).
  * @property {Array<number>} relatedIds - Ids of related product pages.
  * @property {string} attributeSetIdentifier - Set of attributes id.

package/dist/templates/templatesApi.d.ts

@@ -20,7 +20,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get template objects by type.
      *
-     * @param {Types} type - Product marker
+     * @param {Types} [type] - type
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object
@@ -29,7 +29,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get one template object by id.
      *
-     * @param {number} id - Template id
+     * @param {number} [id] - Template id
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object
@@ -38,7 +38,7 @@ export default class TemplatesPreviewApi extends AsyncModules implements ITempla
     /**
      * Get one template object by id.
      *
-     * @param {number} marker - Template marker
+     * @param {number} [marker] - Template marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object

package/dist/templates/templatesApi.js

@@ -32,7 +32,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get template objects by type.
      *
-     * @param {Types} type - Product marker
+     * @param {Types} [type] - type
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object
@@ -44,7 +44,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get one template object by id.
      *
-     * @param {number} id - Template id
+     * @param {number} [id] - Template id
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object
@@ -56,7 +56,7 @@ class TemplatesPreviewApi extends asyncModules_1.default {
     /**
      * Get one template object by id.
      *
-     * @param {number} marker - Template marker
+     * @param {number} [marker] - Template marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplateEntity object

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

@@ -20,7 +20,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Get one template object by id.
      *
-     * @param {number} id - Product marker
+     * @param {number} [id] - Product marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplatePreviewsEntity object
@@ -29,7 +29,7 @@ export default class TemplatePreviewsApi extends AsyncModules implements ITempla
     /**
      * Get one template object by marker.
      *
-     * @param {string} marker - Product marker
+     * @param {string} [marker] - Product marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplatePreviewsEntity object

package/dist/templates-preview/templatesPreviewApi.js

@@ -26,7 +26,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Get one template object by id.
      *
-     * @param {number} id - Product marker
+     * @param {number} [id] - Product marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplatePreviewsEntity object
@@ -38,7 +38,7 @@ class TemplatePreviewsApi extends asyncModules_1.default {
     /**
      * Get one template object by marker.
      *
-     * @param {string} marker - Product marker
+     * @param {string} [marker] - Product marker
      * @param {string} [langCode] - Optional parameter language code
      *
      * @returns Returns a TemplatePreviewsEntity object

package/dist/users/usersApi.d.ts

@@ -14,15 +14,15 @@ export default class UsersApi extends AsyncModules implements IUsers {
      *
      * @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} [langCode] Required parameter lang code.
+     * @param {string} [langCode] - lang code.
      */
     getUser(langCode?: string): Promise<IUserEntity | IError>;
     /**
      * Updating 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
+     * @param {object} [body] - Request body.
+     * @param {string} [langCode] - Optional language field
      *
      * @example
      * {
@@ -46,22 +46,22 @@ export default class UsersApi extends AsyncModules implements IUsers {
      *   "state": {}
      * }
      */
-    updateUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
+    updateUser(body: 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
+     * @param {object} [body] - Request body.
+     * @param {string} [langCode] - Optional language field
      *
      */
-    deleteUser(data: IUserBody, langCode?: string): Promise<boolean | IError>;
+    deleteUser(body: 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.
+     * @param {string} [token] - Cloud messaging token.
      */
     addFCMToken(token: string): Promise<boolean | IError>;
     /**
@@ -69,7 +69,7 @@ export default class UsersApi extends AsyncModules implements IUsers {
      *
      * @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.
+     * @param {string} [token] - Cloud messaging token.
      */
     deleteFCMToken(token: string): Promise<boolean | IError>;
 }

package/dist/users/usersApi.js

@@ -17,7 +17,7 @@ class UsersApi extends asyncModules_1.default {
      *
      * @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} [langCode] Required parameter lang code.
+     * @param {string} [langCode] - lang code.
      */
     async getUser(langCode = this.state.lang) {
         const result = await this._fetchGet(`/me?langCode=${langCode}`);
@@ -27,8 +27,8 @@ class UsersApi extends asyncModules_1.default {
      * Updating 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
+     * @param {object} [body] - Request body.
+     * @param {string} [langCode] - Optional language field
      *
      * @example
      * {
@@ -52,32 +52,32 @@ class UsersApi extends asyncModules_1.default {
      *   "state": {}
      * }
      */
-    async updateUser(data, langCode = this.state.lang) {
-        if (!('langCode' in data))
-            data['langCode'] = langCode;
+    async updateUser(body, langCode = this.state.lang) {
+        if (!('langCode' in body))
+            body['langCode'] = langCode;
         const result = await this._fetchPut('/me', 
         // eslint-disable-next-line no-prototype-builtins
-        data.hasOwnProperty('formData')
-            ? this._normalizePostBody(data, langCode)
-            : data);
+        body.hasOwnProperty('formData')
+            ? this._normalizePostBody(body, langCode)
+            : body);
         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
+     * @param {object} [body] - Request body.
+     * @param {string} [langCode] - Optional language field
      *
      */
-    async deleteUser(data, langCode = this.state.lang) {
-        if (!('langCode' in data))
-            data['langCode'] = langCode;
+    async deleteUser(body, langCode = this.state.lang) {
+        if (!('langCode' in body))
+            body['langCode'] = langCode;
         const result = await this._fetchDelete('/me', 
         // eslint-disable-next-line no-prototype-builtins
-        data.hasOwnProperty('formData')
-            ? this._normalizePostBody(data, langCode)
-            : data);
+        body.hasOwnProperty('formData')
+            ? this._normalizePostBody(body, langCode)
+            : body);
         return result;
     }
     /**
@@ -85,7 +85,7 @@ class UsersApi extends asyncModules_1.default {
      *
      * @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.
+     * @param {string} [token] - Cloud messaging token.
      */
     async addFCMToken(token) {
         const result = await this._fetchPost(`/me/fcm-token/${token}`);
@@ -96,7 +96,7 @@ class UsersApi extends asyncModules_1.default {
      *
      * @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.
+     * @param {string} [token] - Cloud messaging token.
      */
     async deleteFCMToken(token) {
         const result = await this._fetchDelete(`/me/fcm-token/${token}`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.106",
+  "version": "1.0.109",
   "description": "OneEntry NPM package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -8,8 +8,8 @@
     "/dist"
   ],
   "scripts": {
-    "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",
+    "productionBuild": "run-s lint testAll build readme",
+    "testAll": "run-s admins attributesets authProvider blocks fileuploading forms formsdata generaltypes integrationcollections 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",
@@ -31,7 +31,7 @@
     "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"
+    "readme": "node readme.js"
   },
   "bin": {
     "oneentry": "./configure.js"
@@ -47,9 +47,9 @@
     "@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",
+    "@types/node": "^22.13.0",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-import": "^2.31.0",
@@ -60,7 +60,6 @@
     "npm-run-all": "^4.1.5",
     "prettier": "^3.4.2",
     "ts-jest": "^29.2.5",
-    "tsdoc-markdown": "^1.1.1",
     "typescript": "^5.7.3"
   }
-}
+}

package/readme.js

@@ -0,0 +1,103 @@
+import fs from 'fs';
+
+let modules = [
+  {
+    name: 'admins',
+    path: 'admins',
+  },
+  {
+    name: 'attributesets',
+    path: 'attribute-sets',
+  },
+  {
+    name: 'authprovider',
+    path: 'auth-provider',
+  },
+  {
+    name: 'blocks',
+    path: 'blocks',
+  },
+  {
+    name: 'events',
+    path: 'events',
+  },
+  {
+    name: 'fileuploading',
+    path: 'file-uploading',
+  },
+  {
+    name: 'forms',
+    path: 'forms',
+  },
+  {
+    name: 'formsdata',
+    path: 'formsData',
+  },
+  {
+    name: 'generaltypes',
+    path: 'general-types',
+  },
+  {
+    name: 'integrationcollections',
+    path: 'integration-collections',
+  },
+  {
+    name: 'locales',
+    path: 'locales',
+  },
+  {
+    name: 'menus',
+    path: 'menus',
+  },
+  {
+    name: 'orders',
+    path: 'orders',
+  },
+  {
+    name: 'pages',
+    path: 'pages',
+  },
+  {
+    name: 'payments',
+    path: 'payments',
+  },
+  {
+    name: 'productstatuses',
+    path: 'product-statuses',
+  },
+  {
+    name: 'products',
+    path: 'products',
+  },
+  {
+    name: 'system',
+    path: 'system',
+  },
+  {
+    name: 'templates',
+    path: 'templates',
+  },
+  {
+    name: 'templatepreviews',
+    path: 'templates-preview',
+  },
+  {
+    name: 'users',
+    path: 'users',
+  },
+  {
+    name: 'ws',
+    path: 'web-socket',
+  },
+];
+
+let template = fs.readFileSync('./template.md').toString();
+
+modules.forEach((module) => {
+  let file = fs
+    .readFileSync('./src/' + module.path + '/' + module.name + '.md')
+    .toString();
+  template = template.replace('# {{' + module.name + '}}', file);
+});
+
+fs.writeFileSync(`./README.md`, template);