@contrail/flexplm 1.2.1 → 1.3.0-alpha.04c91a9

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 (125) hide show
  1. package/.github/pull_request_template.md +31 -31
  2. package/.github/workflows/flexplm-lib.yml +27 -27
  3. package/.github/workflows/publish-to-npm.yml +131 -0
  4. package/CHANGELOG.md +10 -0
  5. package/lib/entity-processor/base-entity-processor.d.ts +42 -42
  6. package/lib/entity-processor/base-entity-processor.js +385 -363
  7. package/lib/entity-processor/base-entity-processor.spec.d.ts +1 -1
  8. package/lib/entity-processor/base-entity-processor.spec.js +397 -302
  9. package/lib/flexplm-request.d.ts +3 -3
  10. package/lib/flexplm-request.js +34 -34
  11. package/lib/flexplm-utils.d.ts +5 -5
  12. package/lib/flexplm-utils.js +33 -33
  13. package/lib/flexplm-utils.spec.d.ts +1 -1
  14. package/lib/flexplm-utils.spec.js +26 -26
  15. package/lib/index.d.ts +22 -22
  16. package/lib/index.js +38 -38
  17. package/lib/interfaces/interfaces.d.ts +105 -105
  18. package/lib/interfaces/interfaces.js +2 -2
  19. package/lib/interfaces/item-family-changes.d.ts +20 -20
  20. package/lib/interfaces/item-family-changes.js +56 -56
  21. package/lib/interfaces/publish-change-data.d.ts +19 -19
  22. package/lib/interfaces/publish-change-data.js +32 -32
  23. package/lib/publish/base-process-publish-assortment-callback.d.ts +9 -9
  24. package/lib/publish/base-process-publish-assortment-callback.js +38 -38
  25. package/lib/publish/base-process-publish-assortment.d.ts +93 -93
  26. package/lib/publish/base-process-publish-assortment.js +944 -944
  27. package/lib/publish/base-process-publish-assortment.spec.d.ts +1 -1
  28. package/lib/publish/base-process-publish-assortment.spec.js +1670 -1670
  29. package/lib/publish/mockData.d.ts +1389 -1389
  30. package/lib/publish/mockData.js +4519 -4519
  31. package/lib/transform/identifier-conversion-spec-mockData.js +444 -444
  32. package/lib/transform/identifier-conversion.d.ts +15 -15
  33. package/lib/transform/identifier-conversion.js +212 -212
  34. package/lib/transform/identifier-conversion.spec.d.ts +1 -1
  35. package/lib/transform/identifier-conversion.spec.js +339 -339
  36. package/lib/util/config-defaults.d.ts +8 -8
  37. package/lib/util/config-defaults.js +85 -85
  38. package/lib/util/config-defaults.spec.d.ts +1 -1
  39. package/lib/util/config-defaults.spec.js +293 -293
  40. package/lib/util/data-converter-spec-mockData.js +205 -205
  41. package/lib/util/data-converter.d.ts +39 -39
  42. package/lib/util/data-converter.js +592 -592
  43. package/lib/util/data-converter.spec.d.ts +1 -1
  44. package/lib/util/data-converter.spec.js +904 -904
  45. package/lib/util/error-response-object.d.ts +4 -4
  46. package/lib/util/error-response-object.js +47 -47
  47. package/lib/util/error-response-object.spec.d.ts +1 -1
  48. package/lib/util/error-response-object.spec.js +99 -99
  49. package/lib/util/event-short-message-status.d.ts +19 -18
  50. package/lib/util/event-short-message-status.js +23 -22
  51. package/lib/util/federation.d.ts +15 -15
  52. package/lib/util/federation.js +149 -149
  53. package/lib/util/flexplm-connect.d.ts +22 -18
  54. package/lib/util/flexplm-connect.js +176 -171
  55. package/lib/util/flexplm-connect.spec.d.ts +1 -0
  56. package/lib/util/flexplm-connect.spec.js +88 -0
  57. package/lib/util/logger-config.d.ts +1 -1
  58. package/lib/util/logger-config.js +26 -26
  59. package/lib/util/map-util-spec-mockData.js +205 -205
  60. package/lib/util/map-utils.d.ts +6 -6
  61. package/lib/util/map-utils.js +15 -15
  62. package/lib/util/map-utils.spec.d.ts +1 -1
  63. package/lib/util/map-utils.spec.js +89 -89
  64. package/lib/util/mockData.d.ts +80 -79
  65. package/lib/util/mockData.js +103 -99
  66. package/lib/util/thumbnail-util.d.ts +34 -19
  67. package/lib/util/thumbnail-util.js +215 -114
  68. package/lib/util/thumbnail-util.spec.d.ts +1 -1
  69. package/lib/util/thumbnail-util.spec.js +434 -242
  70. package/lib/util/type-conversion-utils-spec-mockData.js +259 -241
  71. package/lib/util/type-conversion-utils.d.ts +23 -21
  72. package/lib/util/type-conversion-utils.js +265 -223
  73. package/lib/util/type-conversion-utils.spec.d.ts +1 -1
  74. package/lib/util/type-conversion-utils.spec.js +868 -708
  75. package/lib/util/type-defaults.d.ts +16 -16
  76. package/lib/util/type-defaults.js +221 -221
  77. package/lib/util/type-defaults.spec.d.ts +1 -1
  78. package/lib/util/type-defaults.spec.js +516 -516
  79. package/lib/util/type-utils.d.ts +13 -13
  80. package/lib/util/type-utils.js +114 -114
  81. package/lib/util/type-utils.spec.d.ts +1 -1
  82. package/lib/util/type-utils.spec.js +190 -190
  83. package/package.json +1 -1
  84. package/publish.bat +4 -4
  85. package/publish.sh +4 -4
  86. package/src/entity-processor/base-entity-processor.spec.ts +122 -0
  87. package/src/entity-processor/base-entity-processor.ts +31 -2
  88. package/src/flexplm-request.ts +28 -28
  89. package/src/flexplm-utils.spec.ts +27 -27
  90. package/src/flexplm-utils.ts +29 -29
  91. package/src/index.ts +21 -21
  92. package/src/interfaces/item-family-changes.ts +66 -66
  93. package/src/interfaces/publish-change-data.ts +42 -42
  94. package/src/publish/base-process-publish-assortment-callback.ts +50 -50
  95. package/src/transform/identifier-conversion-spec-mockData.ts +495 -495
  96. package/src/transform/identifier-conversion.spec.ts +353 -353
  97. package/src/transform/identifier-conversion.ts +281 -281
  98. package/src/util/config-defaults.spec.ts +350 -350
  99. package/src/util/config-defaults.ts +92 -92
  100. package/src/util/data-converter-spec-mockData.ts +230 -230
  101. package/src/util/error-response-object.spec.ts +115 -115
  102. package/src/util/error-response-object.ts +49 -49
  103. package/src/util/event-short-message-status.ts +1 -0
  104. package/src/util/federation.ts +172 -172
  105. package/src/util/flexplm-connect.spec.ts +132 -0
  106. package/src/util/flexplm-connect.ts +14 -5
  107. package/src/util/logger-config.ts +19 -19
  108. package/src/util/map-util-spec-mockData.ts +230 -230
  109. package/src/util/map-utils.spec.ts +102 -102
  110. package/src/util/map-utils.ts +40 -40
  111. package/src/util/mockData.ts +101 -97
  112. package/src/util/thumbnail-util.spec.ts +239 -0
  113. package/src/util/thumbnail-util.ts +140 -5
  114. package/src/util/type-conversion-utils-spec-mockData.ts +18 -0
  115. package/src/util/type-conversion-utils.spec.ts +184 -0
  116. package/src/util/type-conversion-utils.ts +75 -1
  117. package/src/util/type-defaults.spec.ts +668 -668
  118. package/src/util/type-defaults.ts +280 -280
  119. package/src/util/type-utils.spec.ts +227 -227
  120. package/src/util/type-utils.ts +144 -144
  121. package/tsconfig.json +23 -26
  122. package/tslint.json +57 -57
  123. package/.claude/settings.local.json +0 -8
  124. package/scripts/output.png +0 -0
  125. package/scripts/test-get-request.ts +0 -35
@@ -1,302 +1,397 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const sdk_1 = require("@contrail/sdk");
4
- const transform_data_1 = require("@contrail/transform-data");
5
- const data_converter_1 = require("../util/data-converter");
6
- const base_entity_processor_1 = require("./base-entity-processor");
7
- const mockRootType = {
8
- typeProperties: [
9
- { slug: 'rootText' }
10
- ]
11
- };
12
- const mockTypeUtilGetByRootAndPath = jest.fn((options) => {
13
- return Promise.resolve(mockRootType);
14
- });
15
- jest.mock('@contrail/sdk', () => {
16
- const origModule = jest.requireActual('@contrail/sdk');
17
- return {
18
- __esModule: true,
19
- ...origModule,
20
- Types: jest.fn().mockImplementation(() => {
21
- return {
22
- getByRootAndPath: mockTypeUtilGetByRootAndPath
23
- };
24
- })
25
- };
26
- });
27
- class TestBaseEntityProcessor extends base_entity_processor_1.BaseEntityProcessor {
28
- getIncomingEntity(event, inboundData) {
29
- throw new Error("Method not implemented.");
30
- }
31
- getCreateEntity(inboundData) {
32
- throw new Error("Method not implemented.");
33
- }
34
- getOutgoingUpsertPayload(entityType, event) {
35
- throw new Error("Method not implemented.");
36
- }
37
- }
38
- describe('BaseEntityProcessor', () => {
39
- describe('getOutboundEntityUpdates', () => {
40
- const config = {};
41
- const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
42
- const dc = new data_converter_1.DataConverter(config, mapFileUtil);
43
- it('no payload', async () => {
44
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
45
- const event = {};
46
- const flexResponse = {};
47
- const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
48
- expect(updates).toBeUndefined();
49
- });
50
- it('flexPayload.status === OK', async () => {
51
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
52
- const event = {};
53
- const flexResponse = {
54
- data: {
55
- payload: [
56
- {
57
- status: 'OK'
58
- }
59
- ]
60
- }
61
- };
62
- const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
63
- const returnValue = {
64
- name: 'Test'
65
- };
66
- const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
67
- const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
68
- expect(getTransformedDataSpy).toBeCalledTimes(1);
69
- expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
70
- expect(updates).toBe(returnValue);
71
- });
72
- it('flexPayload.status === FAIL', async () => {
73
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
74
- const event = {};
75
- const flexResponse = {
76
- data: {
77
- payload: [
78
- {
79
- status: 'FAIL'
80
- }
81
- ]
82
- }
83
- };
84
- const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
85
- const returnValue = {
86
- name: 'Test'
87
- };
88
- const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
89
- const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
90
- expect(getTransformedDataSpy).toBeCalledTimes(0);
91
- expect(getUpdatesForEntitySpy).toBeCalledTimes(0);
92
- expect(updates).toBeUndefined();
93
- });
94
- it('should set flexPLMObjectClass when data exists but flexPLMObjectClass is missing', async () => {
95
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
96
- const event = { newData: { id: '123' } };
97
- const flexResponse = {
98
- data: {
99
- payload: [
100
- {
101
- status: 'OK',
102
- objectClass: 'Material',
103
- data: {
104
- name: 'Test Material'
105
- }
106
- }
107
- ]
108
- }
109
- };
110
- const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
111
- const returnValue = {
112
- name: 'Test'
113
- };
114
- const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
115
- await btep.getOutboundEntityUpdates(event, flexResponse);
116
- expect(flexResponse.data.payload[0].data['flexPLMObjectClass']).toBe('Material');
117
- expect(getTransformedDataSpy).toBeCalledTimes(1);
118
- expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
119
- expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
120
- });
121
- it('should not override existing flexPLMObjectClass', async () => {
122
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
123
- const event = { newData: { id: '123' } };
124
- const flexResponse = {
125
- data: {
126
- payload: [
127
- {
128
- status: 'OK',
129
- objectClass: 'Material',
130
- data: {
131
- name: 'Test Material',
132
- flexPLMObjectClass: 'ExistingClass'
133
- }
134
- }
135
- ]
136
- }
137
- };
138
- const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
139
- const returnValue = {
140
- name: 'Test'
141
- };
142
- const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
143
- await btep.getOutboundEntityUpdates(event, flexResponse);
144
- expect(flexResponse.data.payload[0].data.flexPLMObjectClass).toBe('ExistingClass');
145
- expect(getTransformedDataSpy).toBeCalledTimes(1);
146
- expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
147
- expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
148
- });
149
- it('should skip setting flexPLMObjectClass when data is null or undefined', async () => {
150
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
151
- const event = { newData: { id: '123' } };
152
- const flexResponse = {
153
- data: {
154
- payload: [
155
- {
156
- status: 'OK',
157
- objectClass: 'Material',
158
- data: null
159
- }
160
- ]
161
- }
162
- };
163
- const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
164
- const returnValue = {
165
- name: 'Test'
166
- };
167
- const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
168
- await btep.getOutboundEntityUpdates(event, flexResponse);
169
- expect(getTransformedDataSpy).toBeCalledTimes(1);
170
- expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
171
- expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
172
- });
173
- });
174
- describe('queryEntityWithSubType', () => {
175
- const config = {};
176
- const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
177
- beforeEach(() => {
178
- jest.clearAllMocks();
179
- });
180
- it('entity parameter not set', async () => {
181
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
182
- const entity = '';
183
- const subType = 'test';
184
- const propertyCriteria = { a: 'val' };
185
- expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
186
- });
187
- it('entityTypePath not set', async () => {
188
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
189
- const entity = 'test';
190
- const subType = '';
191
- const propertyCriteria = {};
192
- expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
193
- });
194
- it('propertyCriteria not set', async () => {
195
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
196
- const entity = 'test';
197
- const subType = 'test';
198
- const propertyCriteria = {};
199
- expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
200
- });
201
- it('basic queryEntityWithSubTypeCriteria test', async () => {
202
- const dc = new data_converter_1.DataConverter(config, mapFileUtil);
203
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
204
- const entityType = 'custom-entity';
205
- const entityTypePath = 'custom-entity:sample';
206
- const rootCriteria = {
207
- rootText: 'root'
208
- };
209
- const subCriteria = {
210
- sampleText: 'sample',
211
- typePath: entityTypePath
212
- };
213
- const propertyCriteria = Object.assign({}, rootCriteria, subCriteria);
214
- const rootCriteriaResults = Object.assign({}, rootCriteria);
215
- const mockGetByRootTypeProperties = jest.spyOn(btep, 'getRootTypePropertyKeys').mockReturnValue(['rootText']);
216
- const mockDCgetAllObjectReferences = jest.spyOn(dc, 'getAllObjectReferences').mockReturnValue(Promise.resolve([]));
217
- const results = await btep.queryEntityWithSubTypeCriteria(entityType, entityTypePath, propertyCriteria);
218
- expect(results).toEqual([]);
219
- expect(mockTypeUtilGetByRootAndPath).toBeCalledTimes(1);
220
- expect(mockTypeUtilGetByRootAndPath).toBeCalledWith({ root: entityType });
221
- expect(mockGetByRootTypeProperties).toBeCalledTimes(1);
222
- expect(mockGetByRootTypeProperties).toBeCalledWith(mockRootType, propertyCriteria);
223
- expect(mockDCgetAllObjectReferences).toBeCalledTimes(1);
224
- expect(mockDCgetAllObjectReferences).toBeCalledWith(entityType, rootCriteriaResults, subCriteria);
225
- });
226
- });
227
- describe('getCriteriaForEntity', () => {
228
- const config = {};
229
- const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
230
- beforeEach(() => {
231
- jest.clearAllMocks();
232
- });
233
- it('entity parameter not set', async () => {
234
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
235
- const entity = '';
236
- const subType = 'test';
237
- const propertyCriteria = { a: 'val' };
238
- expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
239
- });
240
- it('entityTypePath not set', async () => {
241
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
242
- const entity = 'test';
243
- const subType = '';
244
- const propertyCriteria = {};
245
- expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
246
- });
247
- it('propertyCriteria not set', async () => {
248
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
249
- const entity = 'test';
250
- const subType = 'test';
251
- const propertyCriteria = {};
252
- expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
253
- });
254
- it('basic getCriteriaForEntity test', async () => {
255
- const dc = new data_converter_1.DataConverter(config, mapFileUtil);
256
- const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
257
- const entityType = 'custom-entity';
258
- const entityTypePath = 'custom-entity:sample';
259
- const rootCriteria = {
260
- rootText: 'root'
261
- };
262
- const subCriteria = {
263
- sampleText: 'sample',
264
- typePath: entityTypePath
265
- };
266
- const propertyCriteria = Object.assign({}, rootCriteria, subCriteria);
267
- const rootCriteriaResults = Object.assign({}, rootCriteria);
268
- const subCriteriaResults = Object.assign({}, subCriteria);
269
- const mockGetByRootTypeProperties = jest.spyOn(btep, 'getRootTypePropertyKeys').mockReturnValue(['rootText']);
270
- const { rootTypeCriteria, subTypeCriteria } = await btep.getCriteriaForEntity(entityType, entityTypePath, propertyCriteria);
271
- expect(mockTypeUtilGetByRootAndPath).toBeCalledTimes(1);
272
- expect(mockTypeUtilGetByRootAndPath).toBeCalledWith({ root: entityType });
273
- expect(mockGetByRootTypeProperties).toBeCalledTimes(1);
274
- expect(mockGetByRootTypeProperties).toBeCalledWith(mockRootType, propertyCriteria);
275
- expect(rootTypeCriteria).toEqual(rootCriteriaResults);
276
- expect(subTypeCriteria).toEqual(subCriteriaResults);
277
- });
278
- });
279
- describe('getRootTypePropertyKeys', () => {
280
- it('rootType parameter not set', async () => {
281
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
282
- const rootType = '';
283
- expect(async () => { await btep.getRootTypePropertyKeys(rootType); }).rejects.toThrow();
284
- });
285
- it('get keys from rootType.typeProperties', async () => {
286
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
287
- const rootType = {
288
- typeProperties: ['a', 'b']
289
- };
290
- const keys = await btep.getRootTypePropertyKeys(rootType);
291
- expect(keys).not.toEqual(['a', 'b']);
292
- });
293
- it('get keys from rootType.typeProperties', async () => {
294
- const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
295
- const rootType = {
296
- typeProperties: [{ slug: 'a' }, { slug: 'b' }]
297
- };
298
- const keys = await btep.getRootTypePropertyKeys(rootType);
299
- expect(keys).toEqual(['a', 'b']);
300
- });
301
- });
302
- });
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const sdk_1 = require("@contrail/sdk");
4
+ const transform_data_1 = require("@contrail/transform-data");
5
+ const data_converter_1 = require("../util/data-converter");
6
+ const base_entity_processor_1 = require("./base-entity-processor");
7
+ const type_conversion_utils_1 = require("../util/type-conversion-utils");
8
+ const thumbnail_util_1 = require("../util/thumbnail-util");
9
+ const mockRootType = {
10
+ typeProperties: [
11
+ { slug: 'rootText' }
12
+ ]
13
+ };
14
+ const mockTypeUtilGetByRootAndPath = jest.fn((options) => {
15
+ return Promise.resolve(mockRootType);
16
+ });
17
+ jest.mock('@contrail/sdk', () => {
18
+ const origModule = jest.requireActual('@contrail/sdk');
19
+ return {
20
+ __esModule: true,
21
+ ...origModule,
22
+ Types: jest.fn().mockImplementation(() => {
23
+ return {
24
+ getByRootAndPath: mockTypeUtilGetByRootAndPath
25
+ };
26
+ })
27
+ };
28
+ });
29
+ class TestBaseEntityProcessor extends base_entity_processor_1.BaseEntityProcessor {
30
+ getIncomingEntity(event, inboundData) {
31
+ throw new Error("Method not implemented.");
32
+ }
33
+ getCreateEntity(inboundData) {
34
+ throw new Error("Method not implemented.");
35
+ }
36
+ getOutgoingUpsertPayload(entityType, event) {
37
+ throw new Error("Method not implemented.");
38
+ }
39
+ }
40
+ describe('BaseEntityProcessor', () => {
41
+ describe('getOutboundEntityUpdates', () => {
42
+ const config = {};
43
+ const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
44
+ const dc = new data_converter_1.DataConverter(config, mapFileUtil);
45
+ it('no payload', async () => {
46
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
47
+ const event = {};
48
+ const flexResponse = {};
49
+ const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
50
+ expect(updates).toBeUndefined();
51
+ });
52
+ it('flexPayload.status === OK', async () => {
53
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
54
+ const event = {};
55
+ const flexResponse = {
56
+ data: {
57
+ payload: [
58
+ {
59
+ status: 'OK'
60
+ }
61
+ ]
62
+ }
63
+ };
64
+ const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
65
+ const returnValue = {
66
+ name: 'Test'
67
+ };
68
+ const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
69
+ const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
70
+ expect(getTransformedDataSpy).toBeCalledTimes(1);
71
+ expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
72
+ expect(updates).toBe(returnValue);
73
+ });
74
+ it('flexPayload.status === FAIL', async () => {
75
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
76
+ const event = {};
77
+ const flexResponse = {
78
+ data: {
79
+ payload: [
80
+ {
81
+ status: 'FAIL'
82
+ }
83
+ ]
84
+ }
85
+ };
86
+ const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
87
+ const returnValue = {
88
+ name: 'Test'
89
+ };
90
+ const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
91
+ const updates = await btep.getOutboundEntityUpdates(event, flexResponse);
92
+ expect(getTransformedDataSpy).toBeCalledTimes(0);
93
+ expect(getUpdatesForEntitySpy).toBeCalledTimes(0);
94
+ expect(updates).toBeUndefined();
95
+ });
96
+ it('should set flexPLMObjectClass when data exists but flexPLMObjectClass is missing', async () => {
97
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
98
+ const event = { newData: { id: '123' } };
99
+ const flexResponse = {
100
+ data: {
101
+ payload: [
102
+ {
103
+ status: 'OK',
104
+ objectClass: 'Material',
105
+ data: {
106
+ name: 'Test Material'
107
+ }
108
+ }
109
+ ]
110
+ }
111
+ };
112
+ const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
113
+ const returnValue = {
114
+ name: 'Test'
115
+ };
116
+ const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
117
+ await btep.getOutboundEntityUpdates(event, flexResponse);
118
+ expect(flexResponse.data.payload[0].data['flexPLMObjectClass']).toBe('Material');
119
+ expect(getTransformedDataSpy).toBeCalledTimes(1);
120
+ expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
121
+ expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
122
+ });
123
+ it('should not override existing flexPLMObjectClass', async () => {
124
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
125
+ const event = { newData: { id: '123' } };
126
+ const flexResponse = {
127
+ data: {
128
+ payload: [
129
+ {
130
+ status: 'OK',
131
+ objectClass: 'Material',
132
+ data: {
133
+ name: 'Test Material',
134
+ flexPLMObjectClass: 'ExistingClass'
135
+ }
136
+ }
137
+ ]
138
+ }
139
+ };
140
+ const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
141
+ const returnValue = {
142
+ name: 'Test'
143
+ };
144
+ const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
145
+ await btep.getOutboundEntityUpdates(event, flexResponse);
146
+ expect(flexResponse.data.payload[0].data.flexPLMObjectClass).toBe('ExistingClass');
147
+ expect(getTransformedDataSpy).toBeCalledTimes(1);
148
+ expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
149
+ expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
150
+ });
151
+ it('should skip setting flexPLMObjectClass when data is null or undefined', async () => {
152
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
153
+ const event = { newData: { id: '123' } };
154
+ const flexResponse = {
155
+ data: {
156
+ payload: [
157
+ {
158
+ status: 'OK',
159
+ objectClass: 'Material',
160
+ data: null
161
+ }
162
+ ]
163
+ }
164
+ };
165
+ const getTransformedDataSpy = jest.spyOn(btep, 'getTransformedData').mockReturnValue(Promise.resolve({}));
166
+ const returnValue = {
167
+ name: 'Test'
168
+ };
169
+ const getUpdatesForEntitySpy = jest.spyOn(btep, 'getUpdatesForEntity').mockReturnValue(Promise.resolve(returnValue));
170
+ await btep.getOutboundEntityUpdates(event, flexResponse);
171
+ expect(getTransformedDataSpy).toBeCalledTimes(1);
172
+ expect(getTransformedDataSpy).toBeCalledWith(flexResponse.data.payload[0]);
173
+ expect(getUpdatesForEntitySpy).toBeCalledTimes(1);
174
+ });
175
+ });
176
+ describe('queryEntityWithSubType', () => {
177
+ const config = {};
178
+ const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
179
+ beforeEach(() => {
180
+ jest.clearAllMocks();
181
+ });
182
+ it('entity parameter not set', async () => {
183
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
184
+ const entity = '';
185
+ const subType = 'test';
186
+ const propertyCriteria = { a: 'val' };
187
+ expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
188
+ });
189
+ it('entityTypePath not set', async () => {
190
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
191
+ const entity = 'test';
192
+ const subType = '';
193
+ const propertyCriteria = {};
194
+ expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
195
+ });
196
+ it('propertyCriteria not set', async () => {
197
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
198
+ const entity = 'test';
199
+ const subType = 'test';
200
+ const propertyCriteria = {};
201
+ expect(async () => { await btep.queryEntityWithSubTypeCriteria(entity, subType, propertyCriteria); }).rejects.toThrow();
202
+ });
203
+ it('basic queryEntityWithSubTypeCriteria test', async () => {
204
+ const dc = new data_converter_1.DataConverter(config, mapFileUtil);
205
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
206
+ const entityType = 'custom-entity';
207
+ const entityTypePath = 'custom-entity:sample';
208
+ const rootCriteria = {
209
+ rootText: 'root'
210
+ };
211
+ const subCriteria = {
212
+ sampleText: 'sample',
213
+ typePath: entityTypePath
214
+ };
215
+ const propertyCriteria = Object.assign({}, rootCriteria, subCriteria);
216
+ const rootCriteriaResults = Object.assign({}, rootCriteria);
217
+ const mockGetByRootTypeProperties = jest.spyOn(btep, 'getRootTypePropertyKeys').mockReturnValue(['rootText']);
218
+ const mockDCgetAllObjectReferences = jest.spyOn(dc, 'getAllObjectReferences').mockReturnValue(Promise.resolve([]));
219
+ const results = await btep.queryEntityWithSubTypeCriteria(entityType, entityTypePath, propertyCriteria);
220
+ expect(results).toEqual([]);
221
+ expect(mockTypeUtilGetByRootAndPath).toBeCalledTimes(1);
222
+ expect(mockTypeUtilGetByRootAndPath).toBeCalledWith({ root: entityType });
223
+ expect(mockGetByRootTypeProperties).toBeCalledTimes(1);
224
+ expect(mockGetByRootTypeProperties).toBeCalledWith(mockRootType, propertyCriteria);
225
+ expect(mockDCgetAllObjectReferences).toBeCalledTimes(1);
226
+ expect(mockDCgetAllObjectReferences).toBeCalledWith(entityType, rootCriteriaResults, subCriteria);
227
+ });
228
+ });
229
+ describe('getCriteriaForEntity', () => {
230
+ const config = {};
231
+ const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
232
+ beforeEach(() => {
233
+ jest.clearAllMocks();
234
+ });
235
+ it('entity parameter not set', async () => {
236
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
237
+ const entity = '';
238
+ const subType = 'test';
239
+ const propertyCriteria = { a: 'val' };
240
+ expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
241
+ });
242
+ it('entityTypePath not set', async () => {
243
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
244
+ const entity = 'test';
245
+ const subType = '';
246
+ const propertyCriteria = {};
247
+ expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
248
+ });
249
+ it('propertyCriteria not set', async () => {
250
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
251
+ const entity = 'test';
252
+ const subType = 'test';
253
+ const propertyCriteria = {};
254
+ expect(async () => { await btep.getCriteriaForEntity(entity, subType, propertyCriteria); }).rejects.toThrow();
255
+ });
256
+ it('basic getCriteriaForEntity test', async () => {
257
+ const dc = new data_converter_1.DataConverter(config, mapFileUtil);
258
+ const btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
259
+ const entityType = 'custom-entity';
260
+ const entityTypePath = 'custom-entity:sample';
261
+ const rootCriteria = {
262
+ rootText: 'root'
263
+ };
264
+ const subCriteria = {
265
+ sampleText: 'sample',
266
+ typePath: entityTypePath
267
+ };
268
+ const propertyCriteria = Object.assign({}, rootCriteria, subCriteria);
269
+ const rootCriteriaResults = Object.assign({}, rootCriteria);
270
+ const subCriteriaResults = Object.assign({}, subCriteria);
271
+ const mockGetByRootTypeProperties = jest.spyOn(btep, 'getRootTypePropertyKeys').mockReturnValue(['rootText']);
272
+ const { rootTypeCriteria, subTypeCriteria } = await btep.getCriteriaForEntity(entityType, entityTypePath, propertyCriteria);
273
+ expect(mockTypeUtilGetByRootAndPath).toBeCalledTimes(1);
274
+ expect(mockTypeUtilGetByRootAndPath).toBeCalledWith({ root: entityType });
275
+ expect(mockGetByRootTypeProperties).toBeCalledTimes(1);
276
+ expect(mockGetByRootTypeProperties).toBeCalledWith(mockRootType, propertyCriteria);
277
+ expect(rootTypeCriteria).toEqual(rootCriteriaResults);
278
+ expect(subTypeCriteria).toEqual(subCriteriaResults);
279
+ });
280
+ });
281
+ describe('getRootTypePropertyKeys', () => {
282
+ it('rootType parameter not set', async () => {
283
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
284
+ const rootType = '';
285
+ expect(async () => { await btep.getRootTypePropertyKeys(rootType); }).rejects.toThrow();
286
+ });
287
+ it('get keys from rootType.typeProperties', async () => {
288
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
289
+ const rootType = {
290
+ typeProperties: ['a', 'b']
291
+ };
292
+ const keys = await btep.getRootTypePropertyKeys(rootType);
293
+ expect(keys).not.toEqual(['a', 'b']);
294
+ });
295
+ it('get keys from rootType.typeProperties', async () => {
296
+ const btep = new TestBaseEntityProcessor({}, {}, {}, 'test');
297
+ const rootType = {
298
+ typeProperties: [{ slug: 'a' }, { slug: 'b' }]
299
+ };
300
+ const keys = await btep.getRootTypePropertyKeys(rootType);
301
+ expect(keys).toEqual(['a', 'b']);
302
+ });
303
+ });
304
+ describe('handleIncomingUpsert - inbound image sync', () => {
305
+ const config = {};
306
+ const mapFileUtil = new transform_data_1.MapFileUtil(new sdk_1.Entities());
307
+ const dc = new data_converter_1.DataConverter(config, mapFileUtil);
308
+ const mockEvent = { objectClass: 'TestClass', federatedId: 'fed-123', data: { name: 'test' }, entityReference: 'ref-1', eventType: 'PERSIST' };
309
+ const mockInboundData = { name: 'transformed-test' };
310
+ const mockCreatedEntity = { id: 'created-1', name: 'created', primaryViewableId: 'pv-created' };
311
+ const mockUpdatedEntity = { id: 'updated-1', name: 'updated', primaryViewableId: 'pv-updated' };
312
+ const mockExistingEntity = { id: 'existing-1', name: 'existing', typeId: 'type-1', roles: [] };
313
+ let btep;
314
+ let syncInboundImagesSpy;
315
+ let syncThumbnailSpy;
316
+ beforeEach(() => {
317
+ jest.clearAllMocks();
318
+ btep = new TestBaseEntityProcessor(config, dc, mapFileUtil, 'test');
319
+ jest.spyOn(btep, 'getTransformedData').mockResolvedValue(mockInboundData);
320
+ syncInboundImagesSpy = jest.spyOn(type_conversion_utils_1.TypeConversionUtils, 'syncInboundImages');
321
+ syncThumbnailSpy = jest.spyOn(thumbnail_util_1.ThumbnailUtil.prototype, 'syncThumbnailToVibeIQ').mockResolvedValue(undefined);
322
+ });
323
+ it('should call syncThumbnailToVibeIQ with entity after create when syncInboundImages returns true', async () => {
324
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
325
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({ entity: { name: 'new' } });
326
+ jest.spyOn(btep, 'createEntity').mockResolvedValue(mockCreatedEntity);
327
+ syncInboundImagesSpy.mockResolvedValue(true);
328
+ const result = await btep.handleIncomingUpsert(mockEvent);
329
+ expect(syncThumbnailSpy).toBeCalledTimes(1);
330
+ expect(syncThumbnailSpy).toBeCalledWith({ entityId: 'created-1', primaryViewableId: 'pv-created', event: mockEvent, entityName: 'test' });
331
+ expect(result).toBe(mockCreatedEntity);
332
+ });
333
+ it('should not sync images after create when syncInboundImages returns false', async () => {
334
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
335
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({ entity: { name: 'new' } });
336
+ jest.spyOn(btep, 'createEntity').mockResolvedValue(mockCreatedEntity);
337
+ syncInboundImagesSpy.mockResolvedValue(false);
338
+ const result = await btep.handleIncomingUpsert(mockEvent);
339
+ expect(syncInboundImagesSpy).toBeCalledTimes(1);
340
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
341
+ expect(result).toBe(mockCreatedEntity);
342
+ });
343
+ it('should call syncThumbnailToVibeIQ with entity and update with property diffs on update', async () => {
344
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
345
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({ name: 'changed' });
346
+ const updateEntitySpy = jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockUpdatedEntity);
347
+ syncInboundImagesSpy.mockResolvedValue(true);
348
+ const result = await btep.handleIncomingUpsert(mockEvent);
349
+ expect(syncThumbnailSpy).toBeCalledTimes(1);
350
+ expect(syncThumbnailSpy).toBeCalledWith({ entityId: 'existing-1', primaryViewableId: undefined, event: mockEvent, entityName: 'test' });
351
+ expect(updateEntitySpy).toBeCalledWith('test', mockExistingEntity, { name: 'changed' });
352
+ expect(result).toBe(mockUpdatedEntity);
353
+ });
354
+ it('should not sync images on update when syncInboundImages returns false', async () => {
355
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
356
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({ name: 'changed' });
357
+ jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockUpdatedEntity);
358
+ syncInboundImagesSpy.mockResolvedValue(false);
359
+ const result = await btep.handleIncomingUpsert(mockEvent);
360
+ expect(syncInboundImagesSpy).toBeCalledTimes(1);
361
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
362
+ expect(result).toBe(mockUpdatedEntity);
363
+ });
364
+ it('should not sync images on early return from getIncomingEntity', async () => {
365
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({
366
+ earlyReturn: { status: 400, data: { message: 'error' }, shortStatusMessage: 'FAIL' }
367
+ });
368
+ await btep.handleIncomingUpsert(mockEvent);
369
+ expect(syncInboundImagesSpy).toBeCalledTimes(0);
370
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
371
+ });
372
+ it('should not sync images on early return from getCreateEntity', async () => {
373
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
374
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({
375
+ earlyReturn: { status: 400, data: { message: 'not creatable' }, shortStatusMessage: 'NOT_CREATABLE' }
376
+ });
377
+ await btep.handleIncomingUpsert(mockEvent);
378
+ expect(syncInboundImagesSpy).toBeCalledTimes(0);
379
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
380
+ });
381
+ it('should return no changes when no property diffs and no thumbnail updates', async () => {
382
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
383
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({});
384
+ syncInboundImagesSpy.mockResolvedValue(true);
385
+ syncThumbnailSpy.mockResolvedValue(undefined);
386
+ const result = await btep.handleIncomingUpsert(mockEvent);
387
+ expect(result).toEqual({ status: 200, data: { message: 'No Changes to persist for entity: existing-1' } });
388
+ });
389
+ it('should return no changes when syncInboundImages is false and no property diffs', async () => {
390
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
391
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({});
392
+ syncInboundImagesSpy.mockResolvedValue(false);
393
+ const result = await btep.handleIncomingUpsert(mockEvent);
394
+ expect(result).toEqual({ status: 200, data: { message: 'No Changes to persist for entity: existing-1' } });
395
+ });
396
+ });
397
+ });