oneentry 1.0.162 → 1.0.164

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 (67) hide show
  1. package/README.md +18 -0
  2. package/changelog.md +67 -0
  3. package/dist/admins/adminsSchemas.d.ts +6 -22
  4. package/dist/admins/adminsSchemas.js +2 -9
  5. package/dist/attribute-sets/attributeSetsInterfaces.d.ts +6 -6
  6. package/dist/auth-provider/authProvidersInterfaces.d.ts +4 -4
  7. package/dist/base/attributes.d.ts +105 -0
  8. package/dist/base/attributes.js +172 -0
  9. package/dist/base/utils.d.ts +95 -2
  10. package/dist/base/validation.d.ts +29 -0
  11. package/dist/base/validation.js +96 -1
  12. package/dist/blocks/blocksInterfaces.d.ts +1 -1
  13. package/dist/blocks/blocksSchemas.d.ts +6 -6
  14. package/dist/blocks/blocksSchemas.js +2 -1
  15. package/dist/discounts/discountsInterfaces.d.ts +1 -1
  16. package/dist/forms/formsInterfaces.d.ts +2 -0
  17. package/dist/forms-data/formsDataApi.d.ts +16 -6
  18. package/dist/forms-data/formsDataApi.js +14 -4
  19. package/dist/forms-data/formsDataInterfaces.d.ts +48 -15
  20. package/dist/index.d.ts +1 -0
  21. package/dist/index.js +9 -1
  22. package/dist/integration-collections/integrationCollectionsInterfaces.d.ts +6 -6
  23. package/dist/menus/menusInterfaces.d.ts +1 -1
  24. package/dist/menus/menusSchemas.js +2 -1
  25. package/dist/orders/ordersInterfaces.d.ts +1 -1
  26. package/dist/pages/pagesSchemas.d.ts +3 -3
  27. package/dist/pages/pagesSchemas.js +2 -1
  28. package/dist/product-statuses/productStatusesInterfaces.d.ts +2 -2
  29. package/dist/products/productsSchemas.d.ts +5 -5
  30. package/dist/products/productsSchemas.js +3 -2
  31. package/dist/templates/templatesInterfaces.d.ts +1 -1
  32. package/dist/templates/templatesSchemas.d.ts +3 -3
  33. package/dist/templates/templatesSchemas.js +2 -1
  34. package/dist/templates-preview/templatesPreviewInterfaces.d.ts +2 -2
  35. package/esm/admins/adminsSchemas.d.ts +6 -22
  36. package/esm/admins/adminsSchemas.js +2 -9
  37. package/esm/attribute-sets/attributeSetsInterfaces.d.ts +6 -6
  38. package/esm/auth-provider/authProvidersInterfaces.d.ts +4 -4
  39. package/esm/base/attributes.d.ts +105 -0
  40. package/esm/base/attributes.js +163 -0
  41. package/esm/base/utils.d.ts +95 -2
  42. package/esm/base/validation.d.ts +29 -0
  43. package/esm/base/validation.js +95 -0
  44. package/esm/blocks/blocksInterfaces.d.ts +1 -1
  45. package/esm/blocks/blocksSchemas.d.ts +6 -6
  46. package/esm/blocks/blocksSchemas.js +2 -1
  47. package/esm/discounts/discountsInterfaces.d.ts +1 -1
  48. package/esm/forms/formsInterfaces.d.ts +2 -0
  49. package/esm/forms-data/formsDataApi.d.ts +16 -6
  50. package/esm/forms-data/formsDataApi.js +14 -4
  51. package/esm/forms-data/formsDataInterfaces.d.ts +48 -15
  52. package/esm/index.d.ts +1 -0
  53. package/esm/index.js +1 -0
  54. package/esm/integration-collections/integrationCollectionsInterfaces.d.ts +6 -6
  55. package/esm/menus/menusInterfaces.d.ts +1 -1
  56. package/esm/menus/menusSchemas.js +2 -1
  57. package/esm/orders/ordersInterfaces.d.ts +1 -1
  58. package/esm/pages/pagesSchemas.d.ts +3 -3
  59. package/esm/pages/pagesSchemas.js +2 -1
  60. package/esm/product-statuses/productStatusesInterfaces.d.ts +2 -2
  61. package/esm/products/productsSchemas.d.ts +5 -5
  62. package/esm/products/productsSchemas.js +3 -2
  63. package/esm/templates/templatesInterfaces.d.ts +1 -1
  64. package/esm/templates/templatesSchemas.d.ts +3 -3
  65. package/esm/templates/templatesSchemas.js +2 -1
  66. package/esm/templates-preview/templatesPreviewInterfaces.d.ts +2 -2
  67. package/package.json +2 -2
@@ -24,7 +24,7 @@ interface ICollectionsApi {
24
24
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
25
25
  * @description This method gets all collections.
26
26
  */
27
- getICollections(langCode: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
27
+ getICollections(langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionEntity[] | IError>;
28
28
  /**
29
29
  * Get a single collection object by id.
30
30
  * @handleName getICollectionById
@@ -34,7 +34,7 @@ interface ICollectionsApi {
34
34
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
35
35
  * @description This method gets a single collection object by id.
36
36
  */
37
- getICollectionById(id: number, langCode: string): Promise<ICollectionEntity | IError>;
37
+ getICollectionById(id: number, langCode?: string): Promise<ICollectionEntity | IError>;
38
38
  /**
39
39
  * Get all records belonging to the collection by collection id.
40
40
  * @handleName getICollectionRowsById
@@ -56,7 +56,7 @@ interface ICollectionsApi {
56
56
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
57
57
  * @description This method gets all records belonging to the collection by collection id.
58
58
  */
59
- getICollectionRowsById(id: number, langCode: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
59
+ getICollectionRowsById(id: number, langCode?: string, userQuery?: ICollectionQuery): Promise<ICollectionRowsResponce | IError>;
60
60
  /**
61
61
  * Check for the existence of a text identifier (marker).
62
62
  * @handleName validateICollectionMarker
@@ -90,7 +90,7 @@ interface ICollectionsApi {
90
90
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
91
91
  * @description This method gets one record from the collection.
92
92
  */
93
- getICollectionRowByMarkerAndId(marker: string, id: number, langCode: string): Promise<ICollectionRow | IError>;
93
+ getICollectionRowByMarkerAndId(marker: string, id: number, langCode?: string): Promise<ICollectionRow | IError>;
94
94
  /**
95
95
  * Create a record in the collection.
96
96
  * @handleName createICollectionRow
@@ -112,7 +112,7 @@ interface ICollectionsApi {
112
112
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
113
113
  * @description This method creates a record in the collection.
114
114
  */
115
- createICollectionRow(marker: string, body: ICollectionFormObject, langCode: string): Promise<ICollectionRow | IError>;
115
+ createICollectionRow(marker: string, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
116
116
  /**
117
117
  * Edit a record in the collection.
118
118
  * @handleName updateICollectionRow
@@ -135,7 +135,7 @@ interface ICollectionsApi {
135
135
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
136
136
  * @description This method edits a record in the collection.
137
137
  */
138
- updateICollectionRow(marker: string, id: number, body: ICollectionFormObject, langCode: string): Promise<ICollectionRow | IError>;
138
+ updateICollectionRow(marker: string, id: number, body: ICollectionFormObject, langCode?: string): Promise<ICollectionRow | IError>;
139
139
  /**
140
140
  * Deletion of collection record object
141
141
  * @handleName deleteICollectionRowByMarkerAndId
@@ -13,7 +13,7 @@ interface IMenus {
13
13
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
14
14
  * @description This method gets pages includes in menu by marker.
15
15
  */
16
- getMenusByMarker(marker: string, langCode: string): Promise<IMenusEntity | IError>;
16
+ getMenusByMarker(marker: string, langCode?: string): Promise<IMenusEntity | IError>;
17
17
  }
18
18
  /**
19
19
  * @interface IMenusPages
@@ -1,4 +1,5 @@
1
1
  import { z } from 'zod';
2
+ import { AttributeValuesSchema } from '../base/validation.js';
2
3
  /**
3
4
  * Menu pages schema (recursive)
4
5
  * Can have children that are also menu pages
@@ -9,7 +10,7 @@ export const MenusPagesSchema = z.lazy(() => z.object({
9
10
  id: z.number().nullable(),
10
11
  pageUrl: z.string().nullable(),
11
12
  localizeInfos: z.record(z.string(), z.any()),
12
- attributeValues: z.record(z.string(), z.any()),
13
+ attributeValues: AttributeValuesSchema,
13
14
  position: z.number(),
14
15
  parentId: z.number().nullable(),
15
16
  parentType: z.enum(['page', 'custom']).nullable().optional(),
@@ -132,7 +132,7 @@ interface IOrdersApi {
132
132
  * @throws {IError} When isShell=false and an error occurs during the fetch
133
133
  * @see For more information about configuring the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider authorization module}, see the documentation in the {@link https://js-sdk.oneentry.cloud/docs/category/authprovider configuration settings section of the SDK}.
134
134
  */
135
- getAllStatusesByStorageMarker(marker: string, langCode: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
135
+ getAllStatusesByStorageMarker(marker: string, langCode?: string, offset?: number, limit?: number): Promise<IOrderStatus[] | IError>;
136
136
  /**
137
137
  * Get all refund requests for an order.
138
138
  * @handleName getOrderRefunds
@@ -22,7 +22,7 @@ export declare const PageEntitySchema: z.ZodObject<{
22
22
  }>;
23
23
  templateIdentifier: z.ZodNullable<z.ZodString>;
24
24
  attributeSetIdentifier: z.ZodNullable<z.ZodString>;
25
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
25
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
26
26
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
27
27
  rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
28
28
  isSync: z.ZodBoolean;
@@ -54,7 +54,7 @@ export declare const PagesResponseSchema: z.ZodArray<z.ZodObject<{
54
54
  }>;
55
55
  templateIdentifier: z.ZodNullable<z.ZodString>;
56
56
  attributeSetIdentifier: z.ZodNullable<z.ZodString>;
57
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
57
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
58
58
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
59
59
  rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
60
60
  isSync: z.ZodBoolean;
@@ -101,7 +101,7 @@ export declare const SinglePageSchema: z.ZodObject<{
101
101
  }>;
102
102
  templateIdentifier: z.ZodNullable<z.ZodString>;
103
103
  attributeSetIdentifier: z.ZodNullable<z.ZodString>;
104
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
104
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
105
105
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
106
106
  rating: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
107
107
  isSync: z.ZodBoolean;
@@ -3,6 +3,7 @@
3
3
  * @description Zod schemas for validating pages-related API responses
4
4
  */
5
5
  import { z } from 'zod';
6
+ import { AttributeValuesSchema } from '../base/validation.js';
6
7
  /**
7
8
  * Page entity schema
8
9
  * Includes all fields returned by the API
@@ -18,7 +19,7 @@ export const PageEntitySchema = z.object({
18
19
  type: z.enum(['catalog_page', 'common_page', 'error_page', 'external_page']),
19
20
  templateIdentifier: z.string().nullable(),
20
21
  attributeSetIdentifier: z.string().nullable(),
21
- attributeValues: z.record(z.string(), z.any()),
22
+ attributeValues: AttributeValuesSchema,
22
23
  moduleFormConfigs: z.array(z.any()).optional(),
23
24
  rating: z.record(z.string(), z.unknown()).optional(),
24
25
  isSync: z.boolean(),
@@ -12,7 +12,7 @@ interface IProductStatusesApi {
12
12
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
13
13
  * @description This method searches for all product status objects.
14
14
  */
15
- getProductStatuses(langCode: string): Promise<IProductStatusEntity[] | IError>;
15
+ getProductStatuses(langCode?: string): Promise<IProductStatusEntity[] | IError>;
16
16
  /**
17
17
  * Search for a product status object by its textual identifier (marker).
18
18
  * @handleName getProductsByStatusMarker
@@ -22,7 +22,7 @@ interface IProductStatusesApi {
22
22
  * @throws {IError} If there is an error during the fetch operation, it will return an error object.
23
23
  * @description This method searches for a product status object by its textual identifier (marker).
24
24
  */
25
- getProductsByStatusMarker(marker: string, langCode: string): Promise<IProductStatusEntity | IError>;
25
+ getProductsByStatusMarker(marker: string, langCode?: string): Promise<IProductStatusEntity | IError>;
26
26
  /**
27
27
  * Check the existence of a textual identifier.
28
28
  * @handleName validateMarker
@@ -41,7 +41,7 @@ export declare const ProductEntitySchema: z.ZodObject<{
41
41
  }, z.core.$strip>;
42
42
  sku: z.ZodNullable<z.ZodString>;
43
43
  isSync: z.ZodBoolean;
44
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
44
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
45
45
  categories: z.ZodArray<z.ZodString>;
46
46
  isVisible: z.ZodBoolean;
47
47
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -83,7 +83,7 @@ export declare const ProductsResponseSchema: z.ZodObject<{
83
83
  }, z.core.$strip>;
84
84
  sku: z.ZodNullable<z.ZodString>;
85
85
  isSync: z.ZodBoolean;
86
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
86
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
87
87
  categories: z.ZodArray<z.ZodString>;
88
88
  isVisible: z.ZodBoolean;
89
89
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -127,7 +127,7 @@ export declare const SingleProductSchema: z.ZodObject<{
127
127
  }, z.core.$strip>;
128
128
  sku: z.ZodNullable<z.ZodString>;
129
129
  isSync: z.ZodBoolean;
130
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
130
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
131
131
  categories: z.ZodArray<z.ZodString>;
132
132
  isVisible: z.ZodBoolean;
133
133
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -189,7 +189,7 @@ export declare const ProductBlockSchema: z.ZodObject<{
189
189
  templateIdentifier: z.ZodNullable<z.ZodString>;
190
190
  isVisible: z.ZodBoolean;
191
191
  isSync: z.ZodBoolean;
192
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
192
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
193
193
  }, z.core.$strip>;
194
194
  /**
195
195
  * Related products schema
@@ -210,7 +210,7 @@ export declare const RelatedProductsSchema: z.ZodArray<z.ZodObject<{
210
210
  }, z.core.$strip>;
211
211
  sku: z.ZodNullable<z.ZodString>;
212
212
  isSync: z.ZodBoolean;
213
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
213
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
214
214
  categories: z.ZodArray<z.ZodString>;
215
215
  isVisible: z.ZodBoolean;
216
216
  moduleFormConfigs: z.ZodOptional<z.ZodArray<z.ZodAny>>;
@@ -3,6 +3,7 @@
3
3
  * @description Zod schemas for validating products-related API responses
4
4
  */
5
5
  import { z } from 'zod';
6
+ import { AttributeValuesSchema } from '../base/validation.js';
6
7
  /**
7
8
  * Product price schema
8
9
  */
@@ -41,7 +42,7 @@ export const ProductEntitySchema = z.object({
41
42
  }),
42
43
  sku: z.string().nullable(),
43
44
  isSync: z.boolean(),
44
- attributeValues: z.record(z.string(), z.any()),
45
+ attributeValues: AttributeValuesSchema,
45
46
  categories: z.array(z.string()),
46
47
  isVisible: z.boolean(),
47
48
  moduleFormConfigs: z.array(z.any()).optional(),
@@ -113,7 +114,7 @@ export const ProductBlockSchema = z.object({
113
114
  templateIdentifier: z.string().nullable(),
114
115
  isVisible: z.boolean(),
115
116
  isSync: z.boolean(),
116
- attributeValues: z.record(z.string(), z.any()),
117
+ attributeValues: AttributeValuesSchema,
117
118
  });
118
119
  /**
119
120
  * Related products schema
@@ -23,7 +23,7 @@ interface ITemplatesApi {
23
23
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
24
24
  * @description This method gets template objects by type.
25
25
  */
26
- getTemplateByType(type: BlockType, langCode: string): Promise<ITemplateEntity[] | IError>;
26
+ getTemplateByType(type: BlockType, langCode?: string): Promise<ITemplateEntity[] | IError>;
27
27
  /**
28
28
  * Get one template object by id.
29
29
  * @handleName getTemplateByMarker
@@ -15,7 +15,7 @@ export declare const TemplateEntitySchema: z.ZodObject<{
15
15
  identifier: z.ZodString;
16
16
  version: z.ZodNumber;
17
17
  generalTypeName: z.ZodString;
18
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
18
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
19
19
  position: z.ZodNumber;
20
20
  }, z.core.$strip>;
21
21
  /**
@@ -29,7 +29,7 @@ export declare const TemplatesResponseSchema: z.ZodArray<z.ZodObject<{
29
29
  identifier: z.ZodString;
30
30
  version: z.ZodNumber;
31
31
  generalTypeName: z.ZodString;
32
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
32
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
33
33
  position: z.ZodNumber;
34
34
  }, z.core.$strip>>;
35
35
  /**
@@ -43,6 +43,6 @@ export declare const GroupedTemplatesResponseSchema: z.ZodRecord<z.ZodString, z.
43
43
  identifier: z.ZodString;
44
44
  version: z.ZodNumber;
45
45
  generalTypeName: z.ZodString;
46
- attributeValues: z.ZodRecord<z.ZodString, z.ZodAny>;
46
+ attributeValues: z.ZodRecord<z.ZodString, z.ZodUnknown>;
47
47
  position: z.ZodNumber;
48
48
  }, z.core.$strip>>>;
@@ -3,6 +3,7 @@
3
3
  * @description Zod schemas for validating templates-related API responses
4
4
  */
5
5
  import { z } from 'zod';
6
+ import { AttributeValuesSchema } from '../base/validation.js';
6
7
  /**
7
8
  * Template entity schema
8
9
  * Includes all fields returned by the API
@@ -15,7 +16,7 @@ export const TemplateEntitySchema = z.object({
15
16
  identifier: z.string(),
16
17
  version: z.number(),
17
18
  generalTypeName: z.string(),
18
- attributeValues: z.record(z.string(), z.any()),
19
+ attributeValues: AttributeValuesSchema,
19
20
  position: z.number(),
20
21
  });
21
22
  /**
@@ -10,7 +10,7 @@ interface ITemplatesPreviewApi {
10
10
  * @returns {ITemplatesPreviewEntity[]} A promise resolving to an array of template preview entities or an error.
11
11
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
12
12
  */
13
- getTemplatePreviews(langCode: string): Promise<ITemplatesPreviewEntity[] | IError>;
13
+ getTemplatePreviews(langCode?: string): Promise<ITemplatesPreviewEntity[] | IError>;
14
14
  /**
15
15
  * Retrieves a specific template preview object by its marker.
16
16
  * @handleName getTemplatePreviewByMarker
@@ -20,7 +20,7 @@ interface ITemplatesPreviewApi {
20
20
  * @throws {IError} - If there is an error during the fetch operation, it will return an error object.
21
21
  * @description This method retrieves a specific template preview object by its marker.
22
22
  */
23
- getTemplatePreviewByMarker(marker: string, langCode: string): Promise<ITemplatesPreviewEntity | IError>;
23
+ getTemplatePreviewByMarker(marker: string, langCode?: string): Promise<ITemplatesPreviewEntity | IError>;
24
24
  }
25
25
  /**
26
26
  * The `ITemplatesPreview` interface defines the structure of template preview entities.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "oneentry",
3
- "version": "1.0.162",
3
+ "version": "1.0.164",
4
4
  "description": "OneEntry NPM package",
5
5
  "main": "dist/index.js",
6
6
  "module": "esm/index.js",
@@ -48,7 +48,7 @@
48
48
  },
49
49
  "scripts": {
50
50
  "prepublishOnly": "node ../scripts/smoke-pack.js --files-only",
51
- "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.162"
51
+ "postpublish": "node ../scripts/verify-published.js --named defineOneEntry --expect 1.0.164"
52
52
  },
53
53
  "sideEffects": false,
54
54
  "files": [