oneentry 1.0.60 → 1.0.61

package/README.md

@@ -41,13 +41,13 @@ const {
         System,
         Templates,
         TemplatePreviews
-} = defineOneEntry('your-url')
+} = defineOneEntry('your-url');
 ```
 
 Or
 
 ```js
-const api = defineOneEntry('your-url')
+const api = defineOneEntry('your-url');
 ```
 
 The second parameter of the function takes a configuration object with the keys "token", "langCode" and "multipleResponse".
@@ -98,7 +98,7 @@ Now you can use the following links to jump to specific entries:
 
 
 ```js
-const { Admins } = defineOneEntry('your-url')
+const { Admins } = defineOneEntry('your-url');
 ```
 
 ### Admins.getAdminsInfo(langCode, offset, limit)
@@ -625,7 +625,9 @@ Example return:
 
 ## <h2 id="fileuploading"> FileUploading </h2>
 
+```js
 const { FileUploading } = defineOneEntry('your-url');
+```
 
 ### FileUploading.upload(data, fileQuery)
 
@@ -709,7 +711,9 @@ Example return:
 ## <h2 id="forms"> Forms </h2>
 
 
+```js
 const { Forms } = defineOneEntry('your-url');
+```
 
 ### Forms.getAllForms(langCode, offset, limit)
 
@@ -917,15 +921,27 @@ example: List [ OrderedMap { "type": "list", "marker": "l1", "position": 2, "lis
 
 ## <h2 id="formdata"> FormData </h2>
 
+```js
 const { FormData } = defineOneEntry('your-url');
+```
 
-### FormData.postFormsData(data)
+### FormData.postFormsData(data, langCode)
 
 ```js
-const value = await FormData.postFormsData(data)
+const body = {
+    formIdentifier: 'test',
+    formData: {
+        marker: 'test',
+        value: 'Test',
+    },
+}
+
+const value = await FormData.postFormsData(body)
 ```
 
-> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormDataDto.
+> This method retrieves all form data objects from the API. It returns a Promise that resolves to an array of objects of type CreateFormData. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument 
+
+
 
 Example return:
 
@@ -1063,7 +1079,9 @@ example: test-form <br>
 
 ## <h2 id="generaltypes"> GeneralTypes </h2>
 
+```js
 const { GeneralTypes } = defineOneEntry('your-url');
+```
 
 ### GeneralTypes.getAllTypes()
 
@@ -1103,7 +1121,7 @@ Enum:
 ## <h2 id="locales"> Locales </h2>
 
 ```js
-const { Locales } = defineOneEntry('your-url')
+const { Locales } = defineOneEntry('your-url');
 ```
 
 ### Locales.getLocales()
@@ -1174,7 +1192,7 @@ description:position number
 
 
 ```js
-const { Markers } = defineOneEntry('your-url')
+const { Markers } = defineOneEntry('your-url');
 ```
 
 ### Markers.getMarkers(offset, limit)
@@ -1408,7 +1426,7 @@ example: List [ OrderedMap { "id": 11, "pageUrl": "122", "localizeInfos": Ordere
 ## <h2 id="orders"> Orders </h2>
 
 ```js
-const { Orders } = defineOneEntry('your-url')
+const { Orders } = defineOneEntry('your-url');
 ```
 
 ### Orders.getOrderByMarker(marker, langCode)
@@ -1466,7 +1484,7 @@ example:  [{ "identifier": "p1" }] <br>
 </details>
 
 
-### Orders.createOrder(marker, data)
+### Orders.createOrder(marker, data, langCode)
 
 ```js
  const body = {
@@ -1506,11 +1524,12 @@ example:  [{ "identifier": "p1" }] <br>
 const value = await Pages.createOrder('my-order', body)
 ```
 
-> This method retrieves one order storage object by marker.
+> This method retrieves one order storage object by marker. The method will add the default language to the request body. If you want to change the language, just pass it with the second argument
 
 Example return:
 ```json
 {
+  "id": 17,
   "statusIdentifier": "inprogress",
   "formIdentifier": "order-form",
   "paymentIdentifier": "payment-1",
@@ -1540,7 +1559,6 @@ Example return:
   "totalSum": "12.00",
   "currency": "USD",
   "createdDate": "2023-01-01 12:12",
-  "price": 20,
   "paymentAccountIdentifier": "payment-1",
   "paymentAccountLocalizeInfos": {
     "title": "Account 1"
@@ -1602,7 +1620,7 @@ example: { "title": "Account 1" } <br>
 
 
 ```js
-const { Pages } = defineOneEntry('your-url')
+const { Pages } = defineOneEntry('your-url');
 ```
 
 ### Pages.getRootPages(langCode)
@@ -2564,7 +2582,7 @@ Example return:
 ## <h2 id="payments"> Payments </h2>
 
 ```js
-const { Payments } = defineOneEntry('your-url')
+const { Payments } = defineOneEntry('your-url');
 ```
 
 ### Payments.getSessions(limit, offset)
@@ -3082,7 +3100,7 @@ const value = await Payments.webhookPaypal()
 
 
 ```js
-const { Products } = defineOneEntry('your-url')
+const { Products } = defineOneEntry('your-url');
 ```
 
 >This module accepts a set of user parameters called userQuery. If the parameters are not passed to the method, the default value will be applied.
@@ -4173,7 +4191,7 @@ true
 
 
 ```js
-const { System } = defineOneEntry('your-url')
+const { System } = defineOneEntry('your-url');
 ```
 
 ### System.test404()
@@ -4197,7 +4215,7 @@ const value = await System.test500()
 
 
 ```js
-const { Templates } = defineOneEntry('your-url')
+const { Templates } = defineOneEntry('your-url');
 ```
 
 ### Templates.getAllTemplates()
@@ -4359,7 +4377,7 @@ general type name <br>
 
 
 ```js
-const { TemplatePreviews } = defineOneEntry('your-url')
+const { TemplatePreviews } = defineOneEntry('your-url');
 ```
 
 ### TemplatePreviews.getTemplatePreviews()

package/dist/formsData/formsDataApi.d.ts

@@ -20,21 +20,20 @@ export default class FormsDataApi extends OneEntry implements IFormsData {
      * Find all product page objects with pagination and multiple filtering.
      *
      * @param {object} [data] - Request body.
-     * Example Value:
-     * {
-     *   "formIdentifier": "my-form",
-     *   "formData": [
-     *     {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "langCode": "en_US"
-     *     }
-     *   ]
+     * @param {string} langCode - Optional language field
+     *
+     * @example
+     * const body = {
+     *    formIdentifier: 'test',
+     *    formData: {
+     *        marker: 'test',
+     *        value: 'Test',
+     *    },
      * }
      *
      * @returns - Returns created FormData objects.
      */
-    postFormsData(data: IFormsPost): Promise<IFormsDataEntity>;
+    postFormsData(data: IFormsPost, langCode?: string): Promise<IFormsDataEntity>;
     /**
      * Get one object of form data by marker.
      *

package/dist/formsData/formsDataApi.js

@@ -26,21 +26,23 @@ class FormsDataApi extends oneEntry_1.default {
      * Find all product page objects with pagination and multiple filtering.
      *
      * @param {object} [data] - Request body.
-     * Example Value:
-     * {
-     *   "formIdentifier": "my-form",
-     *   "formData": [
-     *     {
-     *       "marker": "name_1",
-     *       "value": "Name",
-     *       "langCode": "en_US"
-     *     }
-     *   ]
+     * @param {string} langCode - Optional language field
+     *
+     * @example
+     * const body = {
+     *    formIdentifier: 'test',
+     *    formData: {
+     *        marker: 'test',
+     *        value: 'Test',
+     *    },
      * }
      *
      * @returns - Returns created FormData objects.
      */
-    async postFormsData(data) {
+    async postFormsData(data, langCode = this._defaultLangCode) {
+        const formData = {};
+        formData[langCode] = Array.isArray(data.formData) ? data.formData : [data.formData];
+        data.formData = formData;
         const result = await this._fetchPost('', JSON.stringify(data));
         return this._dataPostProcess(result);
     }

package/dist/formsData/formsDataInterfaces.d.ts

@@ -9,7 +9,7 @@
  */
 interface IFormsData {
     getFormsData(langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
-    postFormsData(data: IFormsPost): Promise<IFormsDataEntity>;
+    postFormsData(data: IFormsPost, langCode?: string): Promise<IFormsDataEntity>;
     getFormsDataByMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<Array<IFormsDataEntity>>;
 }
 /**
@@ -30,13 +30,6 @@ interface IFormsDataEntity {
     attributeSetIdentifier?: string;
 }
 /**
- * @property {string} [formIdentifier] - Text identifier of the form object (marker)
- *
- * Form data get by langcode identifier
- * @example formData['en_US']
- *
- * @property {langCode.<object>}
- *
  * Contains an array of data form objects with the following values
  *
  * @property {string} marker Form data marker.
@@ -44,13 +37,8 @@ interface IFormsDataEntity {
  * @property {string} value Form data value.
  */
 interface IFormData {
-    [langcode: string]: Array<{
-        marker?: string;
-        value?: string;
-    }> | {
-        marker?: string;
-        value?: string;
-    };
+    marker?: string;
+    value?: string;
 }
 /**
  * interface to create an object of information about saving data using the form
@@ -64,6 +52,6 @@ interface IFormsPost {
     id?: number;
     formIdentifier: string;
     time?: Date | string;
-    formData: IFormData;
+    formData: IFormData | Array<IFormData>;
 }
 export { IFormsPost, IFormsData, IFormData, IFormsDataEntity };

package/dist/orders/ordersApi.d.ts

@@ -20,29 +20,21 @@ export default class OrdersApi extends OneEntry implements IOrdersApi {
      *
      * @param {string} marker - Textual identifier of the order storage object
      * @param {IOrderData} data - Object for creating an order
+     * @param {String} langCode - Optional language field
      *
      * @example
-     * {
+     * const body = {
      *   "formIdentifier": "bar-orders-form",
      *   "paymentIdentifier": "usd-payment",
      *   "formData": {
-     *     "en_US": [
-     *       {
-     *         "marker": "name_1",
-     *         "value": "Name"
-     *       }
-     *     ]
+     *       "marker": "name_1",
+     *       "value": "Name"
      *   },
      *   "products": [
      *     {
      *       "productId": 1,
      *       "quantity": 2,
      *       "price": "23.02"
-     *     },
-     *     {
-     *       "productId": 2,
-     *       "quantity": 3,
-     *       "price": "3.02"
      *     }
      *   ],
      *   "currency": "USD"
@@ -50,5 +42,5 @@ export default class OrdersApi extends OneEntry implements IOrdersApi {
      *
      * @returns Returns object for creating an order.
      */
-    createOrder(marker: string, data: IOrderData): Promise<IBaseOrdersEntity>;
+    createOrder(marker: string, data: IOrderData, langCode?: string): Promise<IBaseOrdersEntity>;
 }

package/dist/orders/ordersApi.js

@@ -26,29 +26,21 @@ class OrdersApi extends oneEntry_1.default {
      *
      * @param {string} marker - Textual identifier of the order storage object
      * @param {IOrderData} data - Object for creating an order
+     * @param {String} langCode - Optional language field
      *
      * @example
-     * {
+     * const body = {
      *   "formIdentifier": "bar-orders-form",
      *   "paymentIdentifier": "usd-payment",
      *   "formData": {
-     *     "en_US": [
-     *       {
-     *         "marker": "name_1",
-     *         "value": "Name"
-     *       }
-     *     ]
+     *       "marker": "name_1",
+     *       "value": "Name"
      *   },
      *   "products": [
      *     {
      *       "productId": 1,
      *       "quantity": 2,
      *       "price": "23.02"
-     *     },
-     *     {
-     *       "productId": 2,
-     *       "quantity": 3,
-     *       "price": "3.02"
      *     }
      *   ],
      *   "currency": "USD"
@@ -56,7 +48,10 @@ class OrdersApi extends oneEntry_1.default {
      *
      * @returns Returns object for creating an order.
      */
-    async createOrder(marker, data) {
+    async createOrder(marker, data, langCode = this._defaultLangCode) {
+        const formData = {};
+        formData[langCode] = Array.isArray(data.formData) ? data.formData : [data.formData];
+        data.formData = formData;
         const result = await this._fetchPost(`/marker/${marker}/order`, data);
         return this._normalizeData(result);
     }

package/dist/orders/ordersInterfaces.d.ts

@@ -29,6 +29,7 @@ interface IOrdersFormData {
 }
 /**
  * @interface
+ * @property {number} id
  * @property {string} statusIdentifier - Text identifier of the order status.
  * @property {string} formIdentifier - Text identifier of the form status.
  * @property {string} paymentIdentifier - Text identifier of the order payment.
@@ -37,11 +38,11 @@ interface IOrdersFormData {
  * @property {string} totalSum - Total order amount.
  * @property {string} currency - Currency used to pay for the order.
  * @property {string} createdDate - Date when the order was created.
- * @property {number} price - Price of the product per unit (at the time of ordering).
  * @property {string} paymentAccountIdentifier - Textual identifier for the order payment.
  * @property {Record<string, any>} paymentAccountLocalizeInfos - Payment account name considering localization.
  */
 interface IBaseOrdersEntity {
+    id: number;
     statusIdentifier: string;
     formIdentifier: string;
     paymentIdentifier: string;
@@ -50,7 +51,6 @@ interface IBaseOrdersEntity {
     totalSum: string;
     currency: string;
     createdDate: string;
-    price: number;
     paymentAccountIdentifier: string;
     paymentAccountLocalizeInfos: Record<string, any>;
 }
@@ -93,7 +93,7 @@ interface IOrderProductData {
  * @property {string} formIdentifier - Text identifier of the form object linked to the order repository.
  * @property {string} paymentIdentifier - Text identifier of the payment object linked to the order repository.
  * @property {string} [statusIdentifier] - Text identifier of the order status object (if not specified, the default status will be assigned).
- * @property {Record<string, Array<IOrderMarkerData>>} formData - Form data linked to the order repositor.
+ * @property {IOrderMarkerData | Array<IOrderMarkerData>} formData - Form data linked to the order repositor.
  * @property {Array<IOrderProductData>} products - An array of ordered products.
  * @property {string} currency - Currency used for order paymen.
  */
@@ -101,7 +101,7 @@ interface IOrderData {
     formIdentifier: string;
     paymentIdentifier: string;
     statusIdentifier?: string;
-    formData: Record<string, Array<IOrderMarkerData>>;
+    formData: IOrderMarkerData | Array<IOrderMarkerData>;
     products: Array<IOrderProductData>;
     currency: string;
 }

package/dist/products/productsApi.d.ts

@@ -144,36 +144,6 @@ export default class ProductApi extends OneEntry implements IProductApi {
      * @param {array} [data] - Request body.
      *
      * @param {string} [langCode] Language code parameter. Default "en_US".
-     *
-     * @example
-     * const objects = [
-     *
-     *   {
-     *
-     *     attributeMarker: "price",
-     *
-     *     conditionMarker: "mth",
-     *
-     *     conditionValue: 1,
-     *
-     *     pageId: 0,
-     *
-     *   },
-     *
-     *   {
-     *
-     *     attributeMarker: "price",
-     *
-     *     conditionMarker: "lth",
-     *
-     *     conditionValue: 3,
-     *
-     *     pageId: 0,
-     *
-     *   },
-     *
-     * ];
-     *
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
@@ -183,6 +153,24 @@ export default class ProductApi extends OneEntry implements IProductApi {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
+     *
+     * @example
+     * const body = [
+     *{
+     *  attributeMarker: "price",
+     *  conditionMarker: "mth",
+     *  conditionValue: 1,
+     *  pageId: 0
+     *},
+     *{
+     *  attributeMarker: "price",
+     *  conditionMarker: "lth",
+     *  conditionValue: 3,
+     *  pageId: 0
+     *},
+     *];
+     *
+     *
      * @returns  Array with ProductEntity objects
      */
     filterProduct(data: Array<IFilterParams>, langCode?: string, userQuery?: IProductsQuery): Promise<Array<IProductsEntity>>;

package/dist/products/productsApi.js

@@ -179,36 +179,6 @@ class ProductApi extends oneEntry_1.default {
      * @param {array} [data] - Request body.
      *
      * @param {string} [langCode] Language code parameter. Default "en_US".
-     *
-     * @example
-     * const objects = [
-     *
-     *   {
-     *
-     *     attributeMarker: "price",
-     *
-     *     conditionMarker: "mth",
-     *
-     *     conditionValue: 1,
-     *
-     *     pageId: 0,
-     *
-     *   },
-     *
-     *   {
-     *
-     *     attributeMarker: "price",
-     *
-     *     conditionMarker: "lth",
-     *
-     *     conditionValue: 3,
-     *
-     *     pageId: 0,
-     *
-     *   },
-     *
-     * ];
-     *
      * @param {IProductsQuery} [userQuery] - Optional set query parameters.
      * @param {number} [userQuery.limit] - Optional parameter for pagination, default is 0
      *
@@ -218,6 +188,24 @@ class ProductApi extends oneEntry_1.default {
      *
      * @param {string} [userQuery.sortKey] - Optional field to sort by
      *
+     *
+     * @example
+     * const body = [
+     *{
+     *  attributeMarker: "price",
+     *  conditionMarker: "mth",
+     *  conditionValue: 1,
+     *  pageId: 0
+     *},
+     *{
+     *  attributeMarker: "price",
+     *  conditionMarker: "lth",
+     *  conditionValue: 3,
+     *  pageId: 0
+     *},
+     *];
+     *
+     *
      * @returns  Array with ProductEntity objects
      */
     async filterProduct(data, langCode = this._defaultLangCode, userQuery) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oneentry",
-  "version": "1.0.60",
+  "version": "1.0.61",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",