oneentry 1.0.28 → 1.0.30

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/README.md +291 -212
  2. package/dist/admins/adminsApi.d.ts +5 -1
  3. package/dist/admins/adminsApi.js +6 -3
  4. package/dist/admins/adminsInterfaces.d.ts +3 -3
  5. package/dist/admins/adminsInterfaces.js +0 -1
  6. package/dist/base/oneEntry.js +0 -1
  7. package/dist/base/utils.d.ts +15 -1
  8. package/dist/base/utils.js +0 -1
  9. package/dist/blocks/blocksApi.d.ts +27 -0
  10. package/dist/blocks/blocksApi.js +38 -0
  11. package/dist/blocks/blocksInterfaces.d.ts +38 -0
  12. package/dist/blocks/blocksInterfaces.js +2 -0
  13. package/dist/file-uploding/fileUploadingApi.d.ts +26 -14
  14. package/dist/file-uploding/fileUploadingApi.js +30 -16
  15. package/dist/file-uploding/fileUploadingInterfaces.d.ts +29 -3
  16. package/dist/file-uploding/fileUploadingInterfaces.js +0 -1
  17. package/dist/forms/formsApi.d.ts +9 -2
  18. package/dist/forms/formsApi.js +11 -5
  19. package/dist/forms/formsInterfaces.d.ts +9 -9
  20. package/dist/forms/formsInterfaces.js +0 -1
  21. package/dist/formsData/formsDataApi.d.ts +9 -2
  22. package/dist/formsData/formsDataApi.js +11 -5
  23. package/dist/formsData/formsDataInterfaces.d.ts +4 -2
  24. package/dist/formsData/formsDataInterfaces.js +0 -1
  25. package/dist/general-types/GeneralTypesApi.js +0 -1
  26. package/dist/general-types/generalTypesInterfaces.js +0 -1
  27. package/dist/index.js +0 -1
  28. package/dist/locales/localesApi.js +0 -1
  29. package/dist/locales/localesInterfaces.js +0 -1
  30. package/dist/menus/menusApi.js +0 -1
  31. package/dist/menus/menusInterfaces.js +0 -1
  32. package/dist/pages/pagesApi.js +0 -1
  33. package/dist/pages/pagesInterfaces.d.ts +16 -26
  34. package/dist/pages/pagesInterfaces.js +0 -1
  35. package/dist/product-statuses/productStatusesApi.js +0 -1
  36. package/dist/product-statuses/productStatusesInterfaces.js +0 -1
  37. package/dist/products/productsApi.js +0 -1
  38. package/dist/products/productsInterfaces.d.ts +0 -6
  39. package/dist/products/productsInterfaces.js +0 -1
  40. package/dist/system/systemApi.js +0 -1
  41. package/dist/system/systemInterfaces.js +0 -1
  42. package/dist/templates/templatesApi.js +0 -1
  43. package/dist/templates/templatesInterfaces.d.ts +5 -2
  44. package/dist/templates/templatesInterfaces.js +0 -1
  45. package/dist/templates-preview/templatesPreviewApi.js +0 -1
  46. package/dist/templates-preview/templatesPreviewInterfaces.js +0 -1
  47. package/package.json +1 -1
@@ -1,6 +1,4 @@
1
- import { AttributeType, LangType, LocalizeType, Types } from "../base/utils";
2
- import { IAttributeSetEntity } from "../base/utils";
3
- import { IFormsEntity } from "../forms/formsInterfaces";
1
+ import { AttributeType, IAttributes, LangType, LocalizeType, Types } from "../base/utils";
4
2
  /**
5
3
  * Represents an interface object of Pages Api.
6
4
  *
@@ -50,29 +48,25 @@ interface IPageConfig {
50
48
  *
51
49
  * @interface
52
50
  * @property {number} id - The identifier of the object.
53
- * @property {Date | string} updatedDate - The date of last updated.
54
51
  * @property {number} version - The version number of the object.
55
52
  * @property {string} identifier - The textual identifier for the record field.
56
- * @property {IAttributesSets} attributesSets - The attributes with values used by the object.
53
+ * @property {IAttributes} attributes - Array of attribute values from the used attribute set for displaying the form (taking into account the specified language).
57
54
  * @property {number} attributeSetId - The identifier of the attribute set being used.
58
55
  * @property {string} processingType - Type of form processing.
59
- * @property {ILocalizeInfos} localizeInfos - The name of the page, taking into account localization.
56
+ * @property {LocalizeType} localizeInfos - The name of the page, taking into account localization.
60
57
  * @property {object} processingData - Form data.
61
58
  * @property {number} position - The position of the object.
62
- * @property {number} positionId - The position id.
63
59
  */
64
60
  interface IPositionForm {
65
61
  id: number;
66
- updatedDate: Date | string;
67
62
  version: number;
68
63
  identifier: string;
69
- attributesSets: IAttributeSetEntity;
64
+ attributes: IAttributes;
70
65
  attributeSetId: number;
71
66
  processingType: string;
72
67
  localizeInfos: LocalizeType;
73
68
  processingData: object;
74
69
  position: number;
75
- positionId: number;
76
70
  }
77
71
  /**
78
72
  * Represents an object with various properties.
@@ -87,29 +81,15 @@ interface IPositionForm {
87
81
  * @property {boolean} isVisible - A sign of page visibility.
88
82
  * @property {number} products - The number of products linked to the page.
89
83
  * @property {number} attributeSetId - Set of attributes id.
90
- * @property {Array<IFormsEntity>} forms - Array of identifier values of the Form Entity objects to which the page is linked (optional).
91
- * @property {Array<IFormsEntity>} blocks - array of identifier values of BlockEntity objects to which the page is linked (optional).
92
84
  * @property {boolean} isSync - Indication of page indexing.
93
85
  * @property {string} templateIdentifier - User id of the linked template.
94
- * @property {Array<[langCode:string]:object>} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
86
+ * @property {AttributeType} attributeValues - Array of attribute values from the index (represented as a pair of user attribute id: attribute value).
95
87
  * @property {number} position - Item number (for sorting).
96
88
  * @property {Types} type - Page type.
97
89
  * @property {number} childrenCount - Children count.
98
90
  */
99
91
  interface IPagesEntity {
100
- id: number;
101
- parentId: number | null;
102
- config: Record<string, number>;
103
- pageUrl: string;
104
- depth: number;
105
- localizeInfos: LocalizeType;
106
- isVisible: boolean;
107
- products: number;
108
92
  attributeSetId: number;
109
- forms?: Array<IFormsEntity>;
110
- blocks?: Array<object>;
111
- isSync: boolean;
112
- templateIdentifier: string;
113
93
  /**
114
94
  * Language-specific attribute values.
115
95
  * @example attributeValues['en_US']
@@ -117,8 +97,18 @@ interface IPagesEntity {
117
97
  * @property {langCode.<object>}
118
98
  */
119
99
  attributeValues: AttributeType;
100
+ childrenCount: number;
101
+ config: Record<string, number>;
102
+ depth: number;
103
+ id: number;
104
+ isSync: boolean;
105
+ isVisible: boolean;
106
+ localizeInfos: LocalizeType;
107
+ pageUrl: string;
108
+ parentId: number | null;
120
109
  position: number;
110
+ products: number;
111
+ templateIdentifier: string;
121
112
  type: Types;
122
- childrenCount: number;
123
113
  }
124
114
  export { IPageApi, IPageConfig, IPagesEntity, IPositionForm };
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=pagesInterfaces.js.map
@@ -53,4 +53,3 @@ class ProductStatusesApi extends oneEntry_1.default {
53
53
  }
54
54
  }
55
55
  exports.default = ProductStatusesApi;
56
- //# sourceMappingURL=productStatusesApi.js.map
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=productStatusesInterfaces.js.map
@@ -269,4 +269,3 @@ class ProductApi extends oneEntry_1.default {
269
269
  }
270
270
  }
271
271
  exports.default = ProductApi;
272
- //# sourceMappingURL=productsApi.js.map
@@ -97,7 +97,6 @@ interface IFilterParams {
97
97
  * @property {boolean} isVisible - A sign of page visibility.
98
98
  * @property {number | null} statusId - Product page status identifiers (may be null).
99
99
  * @property {Array<number>} relatedIds - Ids of related product pages.
100
- * @property {object} productPages - ProductPageEntity objects associated with the product page.
101
100
  * @property {number} attributeSetId - Set of attributes id.
102
101
  * @property {boolean} isSync - Indication of page indexing.
103
102
  * @property {number} price - The value of the product page price taken from the index.
@@ -111,11 +110,6 @@ interface IProductsEntity {
111
110
  isVisible: boolean;
112
111
  statusId: number | null;
113
112
  relatedIds: number[];
114
- productPages: {
115
- id: number;
116
- pageId: number;
117
- productId: number;
118
- }[];
119
113
  attributeSetId: number;
120
114
  isSync: number | boolean;
121
115
  price: number;
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=productsInterfaces.js.map
@@ -19,4 +19,3 @@ class SystemApi extends oneEntry_1.default {
19
19
  }
20
20
  }
21
21
  exports.default = SystemApi;
22
- //# sourceMappingURL=systemApi.js.map
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=systemInterfaces.js.map
@@ -31,4 +31,3 @@ class TemplatesPreviewApi extends oneEntry_1.default {
31
31
  }
32
32
  }
33
33
  exports.default = TemplatesPreviewApi;
34
- //# sourceMappingURL=templatesApi.js.map
@@ -1,3 +1,4 @@
1
+ import { IGeneralTypesEntity } from "../general-types/generalTypesInterfaces";
1
2
  import { ILocalizeInfos, Types } from "../base/utils";
2
3
  /**
3
4
  * Represents an interface object of Templates Api.
@@ -15,7 +16,7 @@ interface ITemplatesApi {
15
16
  *
16
17
  * @interface
17
18
  * @property {number} id - The unique identifier of the position.
18
- * @property {Date | string} updatedDate - The date of last updated.
19
+ * @property {Date | string} updateDate - The date of last updated.
19
20
  * @property {number} version - The version number of the object.
20
21
  * @property {string} identifier - The textual identifier for the record field.
21
22
  * @property {IGeneralTypesEntity} generalType - General type Entity object.
@@ -23,6 +24,7 @@ interface ITemplatesApi {
23
24
  * @property {ILocalizeInfos} localizeInfos - The name of the template, taking into account localization.
24
25
  * @property {number} position - The position of the object.
25
26
  * @property {number | string} positionId - Id of the item object.
27
+ * @property {Types} generalTypeName - General type name.
26
28
  *
27
29
  */
28
30
  interface ITemplateEntity {
@@ -30,10 +32,11 @@ interface ITemplateEntity {
30
32
  updateDate: string | Date;
31
33
  version: number;
32
34
  identifier: string;
33
- isSync: boolean;
35
+ generalType: IGeneralTypesEntity;
34
36
  generalTypeId: number;
35
37
  localizeInfos: ILocalizeInfos;
36
38
  position: number;
39
+ positionId: number;
37
40
  generalTypeName: Types;
38
41
  }
39
42
  export { ITemplatesApi, ITemplateEntity };
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=templatesInterfaces.js.map
@@ -42,4 +42,3 @@ class PageApi extends oneEntry_1.default {
42
42
  }
43
43
  }
44
44
  exports.default = PageApi;
45
- //# sourceMappingURL=templatesPreviewApi.js.map
@@ -1,3 +1,2 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=templatesPreviewInterfaces.js.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oneentry",
3
- "version": "1.0.28",
3
+ "version": "1.0.30",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",