zudello-integration-sdk 1.0.3 → 1.0.5

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 (5) hide show
  1. package/package.json +21 -21
  2. package/src/sdk/submodules/myobAcumatica/Universal.js +138 -105
  3. package/src/utils/logger.js +8 -0
  4. package/src/utils/metadata.js +12 -1
  5. package/src/utils/tags.js +8 -0
package/package.json CHANGED
@@ -1,23 +1,23 @@
1
1
  {
2
- "name": "zudello-integration-sdk",
3
- "version": "1.0.3",
4
- "description": "Zudello Integrations SDK",
5
- "main": "./src/index.js",
6
- "repository": {
7
- "type": "git",
8
- "url": "https://github.com/zudello/integration-sdk.git"
9
- },
10
- "files": [
11
- "src"
12
- ],
13
- "dependencies": {
14
- "@aws-sdk/client-s3": "^3.658.0",
15
- "axios": "^1.6.7",
16
- "dotenv": "^16.4.5",
17
- "lodash": "^4.17.21",
18
- "moment-timezone": "^0.5.45",
19
- "perf_hooks": "^0.0.1",
20
- "standard": "^17.1.0"
21
- },
22
- "license": "MIT"
2
+ "name": "zudello-integration-sdk",
3
+ "version": "1.0.5",
4
+ "description": "Zudello Integrations SDK",
5
+ "main": "./src/index.js",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "https://github.com/zudello/integration-sdk.git"
9
+ },
10
+ "files": [
11
+ "src"
12
+ ],
13
+ "dependencies": {
14
+ "@aws-sdk/client-s3": "^3.658.0",
15
+ "axios": "^1.6.7",
16
+ "dotenv": "^16.4.5",
17
+ "lodash": "^4.17.21",
18
+ "moment-timezone": "^0.5.45",
19
+ "perf_hooks": "^0.0.1",
20
+ "standard": "^17.1.0"
21
+ },
22
+ "license": "MIT"
23
23
  }
package/src/sdk/submodules/myobAcumatica/Universal.js CHANGED
@@ -1,109 +1,142 @@
1
- 'use strict'
1
+ "use strict";
2
2
 
3
3
  class UniversalModule {
4
- /**
5
- * Constructor.
6
- * @param {class} parentModule Object of MYOBAccumatica class.
7
- */
8
- constructor (parentModule) {
9
- this.module = parentModule
10
- }
11
-
12
- /**
13
- * Universal Request By URL and Method.
14
- * @param {string} url URL of request.
15
- * @param {string} method Method of request.
16
- * @param {object} qs Some available filters inside: offset, limit.
17
- * @param {object} body Some available data inside.
18
- * @returns {object} Universal Request Response.
19
- */
20
- async request ({ url, method, qs = {}, body = {} }) {
21
- const validateIsEmpty = this.module.validator.isEmpty({ url, method })
22
-
23
- if (!validateIsEmpty.valid) {
24
- return this.module.responseHandler.error(validateIsEmpty.errors)
25
- }
26
-
27
- return await this.module.makeRequest('GET', `${this.module.apiURL}/zintegrations/action/5f752f97-03f9-4893-8245-7d03cf217e37`, {
28
- mappable_parameters: {
29
- url: {
30
- value: url
31
- },
32
- method: {
33
- value: method
34
- },
35
- qs: {
36
- isMap: true,
37
- value: JSON.stringify(qs)
38
- },
39
- body: {
40
- isMap: true,
41
- value: JSON.stringify(body)
42
- }
43
- }
44
- })
45
- }
46
-
47
- /**
48
- * Universal List By URL and Method.
49
- * @param {string} url URL of listed data.
50
- * @param {string} method Method of listed data.
51
- * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
52
- * @returns {object} Universal List Response.
53
- */
54
- async list ({ url, method, qs = {} }) {
55
- const validateIsEmpty = this.module.validator.isEmpty({ url, method })
56
-
57
- if (!validateIsEmpty.valid) {
58
- return this.module.responseHandler.error(validateIsEmpty.errors)
59
- }
60
-
61
- if (!qs.$skip) {
62
- qs.$skip = 0
63
- }
64
-
65
- if (!qs.$top) {
66
- qs.$top = 100
67
- }
68
-
69
- return await this.request({ url, method, qs })
70
- }
71
-
72
- /**
73
- * Universal Auto Pagination Listing By URL and Method.
74
- * @param {string} url URL of listed data.
75
- * @param {string} method Method of listed data.
76
- * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
77
- * @returns {object} Auto Pagination responses.
78
- */
79
- async * autoPaginationList ({ url, method, qs = {} }) {
80
- if (!qs.$skip) {
81
- qs.$skip = 0
82
- }
83
-
84
- if (!qs.$top) {
85
- qs.$top = 100
86
- }
87
-
88
- let response = await this.list({ url, method, qs })
89
- let currentPageCount = response?.data?.length
90
- let currentOffset = qs.$skip
91
-
92
- yield response
93
-
94
- if (currentPageCount && currentPageCount === qs.$top) {
95
- while (currentPageCount === qs.$top) {
96
- currentOffset = currentOffset + qs.$top
97
-
98
- qs.$skip = currentOffset
99
-
100
- response = await this.list({ url, method, qs })
101
- currentPageCount = response?.data?.length
102
-
103
- yield response
104
- }
105
- }
106
- }
4
+ /**
5
+ * Constructor.
6
+ * @param {class} parentModule Object of MYOBAccumatica class.
7
+ */
8
+ constructor(parentModule) {
9
+ this.module = parentModule;
10
+ }
11
+
12
+ /**
13
+ * Universal Request By URL and Method.
14
+ * @param {string} url URL of request.
15
+ * @param {string} method Method of request.
16
+ * @param {object} qs Some available filters inside: offset, limit.
17
+ * @param {object} body Some available data inside.
18
+ * @returns {object} Universal Request Response.
19
+ */
20
+ async request({ url, method, qs = {}, body = {} }) {
21
+ const validateIsEmpty = this.module.validator.isEmpty({ url, method });
22
+
23
+ if (!validateIsEmpty.valid) {
24
+ return this.module.responseHandler.error(validateIsEmpty.errors);
25
+ }
26
+
27
+ return await this.module.makeRequest(
28
+ "GET",
29
+ `${this.module.apiURL}/zintegrations/action/5f752f97-03f9-4893-8245-7d03cf217e37`,
30
+ {
31
+ mappable_parameters: {
32
+ url: {
33
+ value: url,
34
+ },
35
+ method: {
36
+ value: method,
37
+ },
38
+ qs: {
39
+ isMap: true,
40
+ value: JSON.stringify(qs),
41
+ },
42
+ body: {
43
+ isMap: true,
44
+ value: JSON.stringify(body),
45
+ },
46
+ },
47
+ }
48
+ );
49
+ }
50
+
51
+ /**
52
+ * Universal List By URL and Method.
53
+ * @param {string} url URL of listed data.
54
+ * @param {string} method Method of listed data.
55
+ * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
56
+ * @returns {object} Universal List Response.
57
+ */
58
+ async list({ url, method, qs = {} }) {
59
+ const validateIsEmpty = this.module.validator.isEmpty({ url, method });
60
+
61
+ if (!validateIsEmpty.valid) {
62
+ return this.module.responseHandler.error(validateIsEmpty.errors);
63
+ }
64
+
65
+ if (!qs.$skip) {
66
+ qs.$skip = 0;
67
+ }
68
+
69
+ if (!qs.$top) {
70
+ qs.$top = 100;
71
+ }
72
+
73
+ return await this.request({ url, method, qs });
74
+ }
75
+
76
+ /**
77
+ * Universal Auto Pagination Listing By URL and Method.
78
+ * @param {string} url URL of listed data.
79
+ * @param {string} method Method of listed data.
80
+ * @param {object} qs Some available filters inside: $top, $skip, $filter, $extend.
81
+ * @returns {object} Auto Pagination responses.
82
+ */
83
+ async *autoPaginationList({ url, method, qs = {} }) {
84
+ if (!qs.$skip) {
85
+ qs.$skip = 0;
86
+ }
87
+
88
+ if (!qs.$top) {
89
+ qs.$top = 100;
90
+ }
91
+
92
+ let response = await this.list({ url, method, qs });
93
+ let currentPageCount = response?.data?.length;
94
+ let currentOffset = qs.$skip;
95
+
96
+ yield response;
97
+
98
+ if (currentPageCount && currentPageCount === qs.$top) {
99
+ while (currentPageCount === qs.$top) {
100
+ currentOffset = currentOffset + qs.$top;
101
+
102
+ qs.$skip = currentOffset;
103
+
104
+ response = await this.list({ url, method, qs });
105
+ currentPageCount = response?.data?.length;
106
+
107
+ yield response;
108
+ }
109
+ }
110
+ }
111
+
112
+ /**
113
+ * Attachment Request By URL and Method.
114
+ * @param {string} url URL of request.
115
+ * @param {string} attachment URL of the attachment.
116
+ * @returns {object} Universal Request Response.
117
+ */
118
+ async attach({ url, method, qs = {}, body = {} }) {
119
+ const validateIsEmpty = this.module.validator.isEmpty({ url, attachment });
120
+
121
+ if (!validateIsEmpty.valid) {
122
+ return this.module.responseHandler.error(validateIsEmpty.errors);
123
+ }
124
+
125
+ return await this.module.makeRequest(
126
+ "GET",
127
+ `${this.module.apiURL}/zintegrations/action/086840ce-942c-44ee-b2dd-ca66e5dd7b02`,
128
+ {
129
+ mappable_parameters: {
130
+ url: {
131
+ value: url,
132
+ },
133
+ attachment: {
134
+ value: attachment,
135
+ },
136
+ },
137
+ }
138
+ );
139
+ }
107
140
  }
108
141
 
109
- module.exports = UniversalModule
142
+ module.exports = UniversalModule;
package/src/utils/logger.js CHANGED
@@ -117,6 +117,14 @@ class Logger {
117
117
  getLogs() {
118
118
  return this.logs
119
119
  }
120
+
121
+ /**
122
+ * Logs setter.
123
+ * @param {array} logs Array of log objects
124
+ */
125
+ setLogs(logs = []) {
126
+ this.logs = logs
127
+ }
120
128
  }
121
129
 
122
130
  module.exports = Logger
package/src/utils/metadata.js CHANGED
@@ -45,7 +45,7 @@ class Metadata {
45
45
 
46
46
  /**
47
47
  * Retrieves all metadata and global metadata.
48
- *
48
+ *
49
49
  * @returns {Object} An object containing both metadata and globalMetadata arrays.
50
50
  */
51
51
  getAll() {
@@ -55,6 +55,17 @@ class Metadata {
55
55
  }
56
56
  }
57
57
 
58
+ /**
59
+ * Metadata setter.
60
+ *
61
+ * @param {array} metadata Metadata
62
+ * @param {array} globalMetadata Global Metadata
63
+ */
64
+ setAll(metadata = [], globalMetadata = []) {
65
+ this.metadata = metadata
66
+ this.globalMetadata = globalMetadata
67
+ }
68
+
58
69
  /**
59
70
  * Sets the value for a specified key in either metadata or global metadata.
60
71
  *
package/src/utils/tags.js CHANGED
@@ -27,6 +27,14 @@ class Tags {
27
27
  getAll() {
28
28
  return this.tags
29
29
  }
30
+
31
+ /**
32
+ * Tags setter.
33
+ * @param {array} tags An array of tags.
34
+ */
35
+ setAll(tags = []) {
36
+ this.tags = tags
37
+ }
30
38
  }
31
39
 
32
40
  module.exports = Tags