@contrail/flexplm 1.3.0-alpha.0 → 1.3.0-alpha.3

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 (123) hide show
  1. package/.github/pull_request_template.md +31 -31
  2. package/.github/workflows/flexplm-lib.yml +27 -27
  3. package/CHANGELOG.md +1 -1
  4. package/lib/entity-processor/base-entity-processor.d.ts +42 -0
  5. package/lib/entity-processor/base-entity-processor.js +377 -0
  6. package/lib/entity-processor/base-entity-processor.spec.d.ts +1 -0
  7. package/lib/entity-processor/base-entity-processor.spec.js +426 -0
  8. package/lib/flexplm-request.d.ts +3 -0
  9. package/lib/flexplm-request.js +34 -0
  10. package/lib/flexplm-utils.d.ts +5 -0
  11. package/lib/flexplm-utils.js +33 -0
  12. package/lib/flexplm-utils.spec.d.ts +1 -0
  13. package/lib/flexplm-utils.spec.js +26 -0
  14. package/lib/index.d.ts +22 -0
  15. package/lib/index.js +38 -0
  16. package/lib/interfaces/interfaces.d.ts +105 -0
  17. package/lib/interfaces/interfaces.js +2 -0
  18. package/lib/interfaces/item-family-changes.d.ts +20 -0
  19. package/lib/interfaces/item-family-changes.js +56 -0
  20. package/lib/interfaces/publish-change-data.d.ts +19 -0
  21. package/lib/interfaces/publish-change-data.js +32 -0
  22. package/lib/publish/base-process-publish-assortment-callback.d.ts +9 -0
  23. package/lib/publish/base-process-publish-assortment-callback.js +38 -0
  24. package/lib/publish/base-process-publish-assortment.d.ts +93 -0
  25. package/lib/publish/base-process-publish-assortment.js +944 -0
  26. package/lib/publish/base-process-publish-assortment.spec.d.ts +1 -0
  27. package/lib/publish/base-process-publish-assortment.spec.js +1670 -0
  28. package/lib/publish/mockData.d.ts +1389 -0
  29. package/lib/publish/mockData.js +4519 -0
  30. package/lib/transform/identifier-conversion-spec-mockData.d.ts +0 -0
  31. package/lib/transform/identifier-conversion-spec-mockData.js +444 -0
  32. package/lib/transform/identifier-conversion.d.ts +15 -0
  33. package/lib/transform/identifier-conversion.js +212 -0
  34. package/lib/transform/identifier-conversion.spec.d.ts +1 -0
  35. package/lib/transform/identifier-conversion.spec.js +339 -0
  36. package/lib/util/config-defaults.d.ts +8 -0
  37. package/lib/util/config-defaults.js +85 -0
  38. package/lib/util/config-defaults.spec.d.ts +1 -0
  39. package/lib/util/config-defaults.spec.js +293 -0
  40. package/lib/util/data-converter-spec-mockData.d.ts +0 -0
  41. package/lib/util/data-converter-spec-mockData.js +205 -0
  42. package/lib/util/data-converter.d.ts +39 -0
  43. package/lib/util/data-converter.js +592 -0
  44. package/lib/util/data-converter.spec.d.ts +1 -0
  45. package/lib/util/data-converter.spec.js +904 -0
  46. package/lib/util/error-response-object.d.ts +4 -0
  47. package/lib/util/error-response-object.js +47 -0
  48. package/lib/util/error-response-object.spec.d.ts +1 -0
  49. package/lib/util/error-response-object.spec.js +99 -0
  50. package/lib/util/event-short-message-status.d.ts +18 -0
  51. package/lib/util/event-short-message-status.js +22 -0
  52. package/lib/util/federation.d.ts +15 -0
  53. package/lib/util/federation.js +149 -0
  54. package/lib/util/flexplm-connect.d.ts +22 -0
  55. package/lib/util/flexplm-connect.js +176 -0
  56. package/lib/util/flexplm-connect.spec.d.ts +1 -0
  57. package/lib/util/flexplm-connect.spec.js +88 -0
  58. package/lib/util/logger-config.d.ts +1 -0
  59. package/lib/util/logger-config.js +26 -0
  60. package/lib/util/map-util-spec-mockData.d.ts +0 -0
  61. package/lib/util/map-util-spec-mockData.js +205 -0
  62. package/lib/util/map-utils.d.ts +6 -0
  63. package/lib/util/map-utils.js +15 -0
  64. package/lib/util/map-utils.spec.d.ts +1 -0
  65. package/lib/util/map-utils.spec.js +89 -0
  66. package/lib/util/mockData.d.ts +79 -0
  67. package/lib/util/mockData.js +99 -0
  68. package/lib/util/thumbnail-util.d.ts +28 -0
  69. package/lib/util/thumbnail-util.js +202 -0
  70. package/lib/util/thumbnail-util.spec.d.ts +1 -0
  71. package/lib/util/thumbnail-util.spec.js +398 -0
  72. package/lib/util/type-conversion-utils-spec-mockData.d.ts +0 -0
  73. package/lib/util/type-conversion-utils-spec-mockData.js +259 -0
  74. package/lib/util/type-conversion-utils.d.ts +23 -0
  75. package/lib/util/type-conversion-utils.js +266 -0
  76. package/lib/util/type-conversion-utils.spec.d.ts +1 -0
  77. package/lib/util/type-conversion-utils.spec.js +868 -0
  78. package/lib/util/type-defaults.d.ts +16 -0
  79. package/lib/util/type-defaults.js +221 -0
  80. package/lib/util/type-defaults.spec.d.ts +1 -0
  81. package/lib/util/type-defaults.spec.js +516 -0
  82. package/lib/util/type-utils.d.ts +13 -0
  83. package/lib/util/type-utils.js +114 -0
  84. package/lib/util/type-utils.spec.d.ts +1 -0
  85. package/lib/util/type-utils.spec.js +190 -0
  86. package/package.json +1 -1
  87. package/publish.bat +4 -4
  88. package/publish.sh +4 -4
  89. package/src/entity-processor/base-entity-processor.spec.ts +157 -0
  90. package/src/entity-processor/base-entity-processor.ts +21 -2
  91. package/src/flexplm-request.ts +28 -28
  92. package/src/flexplm-utils.spec.ts +27 -27
  93. package/src/flexplm-utils.ts +29 -29
  94. package/src/index.ts +21 -21
  95. package/src/interfaces/item-family-changes.ts +66 -66
  96. package/src/interfaces/publish-change-data.ts +42 -42
  97. package/src/publish/base-process-publish-assortment-callback.ts +50 -50
  98. package/src/transform/identifier-conversion-spec-mockData.ts +495 -495
  99. package/src/transform/identifier-conversion.spec.ts +353 -353
  100. package/src/transform/identifier-conversion.ts +281 -281
  101. package/src/util/config-defaults.spec.ts +350 -350
  102. package/src/util/config-defaults.ts +92 -92
  103. package/src/util/data-converter-spec-mockData.ts +230 -230
  104. package/src/util/error-response-object.spec.ts +115 -115
  105. package/src/util/error-response-object.ts +49 -49
  106. package/src/util/federation.ts +172 -172
  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 +97 -97
  112. package/src/util/thumbnail-util.spec.ts +190 -0
  113. package/src/util/thumbnail-util.ts +109 -1
  114. package/src/util/type-conversion-utils.spec.ts +25 -25
  115. package/src/util/type-conversion-utils.ts +10 -9
  116. package/src/util/type-defaults.spec.ts +668 -668
  117. package/src/util/type-defaults.ts +280 -280
  118. package/src/util/type-utils.spec.ts +227 -227
  119. package/src/util/type-utils.ts +144 -144
  120. package/tsconfig.json +28 -26
  121. package/tslint.json +57 -57
  122. package/scripts/output.png +0 -0
  123. package/scripts/test-get-request.ts +0 -35
@@ -0,0 +1,426 @@
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 updateEntity with thumbnail updates 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
+ const updateEntitySpy = jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockCreatedEntity);
328
+ syncInboundImagesSpy.mockResolvedValue(true);
329
+ const thumbnailUpdates = { primaryViewableId: 'pv-new', primaryFileUrl: 'https://files/new.png' };
330
+ syncThumbnailSpy.mockResolvedValue(thumbnailUpdates);
331
+ const result = await btep.handleIncomingUpsert(mockEvent);
332
+ expect(syncThumbnailSpy).toBeCalledTimes(1);
333
+ expect(syncThumbnailSpy).toBeCalledWith({ entityId: 'created-1', primaryViewableId: 'pv-created', event: mockEvent, entityName: 'test' });
334
+ expect(updateEntitySpy).toBeCalledWith('test', mockCreatedEntity, thumbnailUpdates);
335
+ expect(result).toBe(mockCreatedEntity);
336
+ });
337
+ it('should not call updateEntity after create when syncThumbnailToVibeIQ returns undefined', async () => {
338
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
339
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({ entity: { name: 'new' } });
340
+ jest.spyOn(btep, 'createEntity').mockResolvedValue(mockCreatedEntity);
341
+ const updateEntitySpy = jest.spyOn(btep, 'updateEntity');
342
+ syncInboundImagesSpy.mockResolvedValue(true);
343
+ syncThumbnailSpy.mockResolvedValue(undefined);
344
+ const result = await btep.handleIncomingUpsert(mockEvent);
345
+ expect(syncThumbnailSpy).toBeCalledTimes(1);
346
+ expect(updateEntitySpy).not.toHaveBeenCalled();
347
+ expect(result).toBe(mockCreatedEntity);
348
+ });
349
+ it('should not sync images after create when syncInboundImages returns false', async () => {
350
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
351
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({ entity: { name: 'new' } });
352
+ jest.spyOn(btep, 'createEntity').mockResolvedValue(mockCreatedEntity);
353
+ syncInboundImagesSpy.mockResolvedValue(false);
354
+ const result = await btep.handleIncomingUpsert(mockEvent);
355
+ expect(syncInboundImagesSpy).toBeCalledTimes(1);
356
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
357
+ expect(result).toBe(mockCreatedEntity);
358
+ });
359
+ it('should merge thumbnail updates with property diffs on update', async () => {
360
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
361
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({ name: 'changed' });
362
+ const updateEntitySpy = jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockUpdatedEntity);
363
+ syncInboundImagesSpy.mockResolvedValue(true);
364
+ const thumbnailUpdates = { primaryViewableId: 'pv-new' };
365
+ syncThumbnailSpy.mockResolvedValue(thumbnailUpdates);
366
+ const result = await btep.handleIncomingUpsert(mockEvent);
367
+ expect(syncThumbnailSpy).toBeCalledTimes(1);
368
+ expect(syncThumbnailSpy).toBeCalledWith({ entityId: 'existing-1', primaryViewableId: undefined, event: mockEvent, entityName: 'test' });
369
+ expect(updateEntitySpy).toBeCalledWith('test', mockExistingEntity, { name: 'changed', primaryViewableId: 'pv-new' });
370
+ expect(result).toBe(mockUpdatedEntity);
371
+ });
372
+ it('should update entity with only thumbnail changes when no property diffs', async () => {
373
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
374
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({});
375
+ const updateEntitySpy = jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockUpdatedEntity);
376
+ syncInboundImagesSpy.mockResolvedValue(true);
377
+ const thumbnailUpdates = { primaryViewableId: 'pv-new' };
378
+ syncThumbnailSpy.mockResolvedValue(thumbnailUpdates);
379
+ const result = await btep.handleIncomingUpsert(mockEvent);
380
+ expect(updateEntitySpy).toBeCalledWith('test', mockExistingEntity, { primaryViewableId: 'pv-new' });
381
+ expect(result).toBe(mockUpdatedEntity);
382
+ });
383
+ it('should not sync images on update when syncInboundImages returns false', async () => {
384
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
385
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({ name: 'changed' });
386
+ jest.spyOn(btep, 'updateEntity').mockResolvedValue(mockUpdatedEntity);
387
+ syncInboundImagesSpy.mockResolvedValue(false);
388
+ const result = await btep.handleIncomingUpsert(mockEvent);
389
+ expect(syncInboundImagesSpy).toBeCalledTimes(1);
390
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
391
+ expect(result).toBe(mockUpdatedEntity);
392
+ });
393
+ it('should not sync images on early return from getIncomingEntity', async () => {
394
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({
395
+ earlyReturn: { status: 400, data: { message: 'error' }, shortStatusMessage: 'FAIL' }
396
+ });
397
+ await btep.handleIncomingUpsert(mockEvent);
398
+ expect(syncInboundImagesSpy).toBeCalledTimes(0);
399
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
400
+ });
401
+ it('should not sync images on early return from getCreateEntity', async () => {
402
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: null });
403
+ jest.spyOn(btep, 'getCreateEntity').mockResolvedValue({
404
+ earlyReturn: { status: 400, data: { message: 'not creatable' }, shortStatusMessage: 'NOT_CREATABLE' }
405
+ });
406
+ await btep.handleIncomingUpsert(mockEvent);
407
+ expect(syncInboundImagesSpy).toBeCalledTimes(0);
408
+ expect(syncThumbnailSpy).toBeCalledTimes(0);
409
+ });
410
+ it('should return no changes when no property diffs and no thumbnail updates', async () => {
411
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
412
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({});
413
+ syncInboundImagesSpy.mockResolvedValue(true);
414
+ syncThumbnailSpy.mockResolvedValue(undefined);
415
+ const result = await btep.handleIncomingUpsert(mockEvent);
416
+ expect(result).toEqual({ status: 200, data: { message: 'No Changes to persist for entity: existing-1' } });
417
+ });
418
+ it('should return no changes when syncInboundImages is false and no property diffs', async () => {
419
+ jest.spyOn(btep, 'getIncomingEntity').mockResolvedValue({ entity: mockExistingEntity });
420
+ jest.spyOn(btep, 'getUpdatesForEntity').mockResolvedValue({});
421
+ syncInboundImagesSpy.mockResolvedValue(false);
422
+ const result = await btep.handleIncomingUpsert(mockEvent);
423
+ expect(result).toEqual({ status: 200, data: { message: 'No Changes to persist for entity: existing-1' } });
424
+ });
425
+ });
426
+ });
@@ -0,0 +1,3 @@
1
+ export declare class FlexPLMRequest {
2
+ static request(path: string, data: any): Promise<any>;
3
+ }
@@ -0,0 +1,34 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.FlexPLMRequest = void 0;
7
+ const axios_1 = __importDefault(require("axios"));
8
+ const BASE_URL = 'https://PP-2006031951wo.portal.ptc.io/Windchill/servlet/rest/cdee';
9
+ const BASE_CONFIG = {
10
+ method: 'POST',
11
+ headers: {
12
+ 'Accept': 'application/json',
13
+ 'Content-Type': 'application/json',
14
+ 'CSRF_NONCE': '2OaLp+0dWNBtrkTwtdDC491zaacu6Hykvqi/lpl6bZgJ/QXBrK/B1J5FErMkmAmktr/I3thcbO1Xn3HJ7Ne/l9kpaedUmn7H75Xey4ZbNLsenW+anM3vxIZ7ELosk3k=',
15
+ 'Authorization': 'Basic d2NhZG1pbjpSZXRhaWwyMDIwLQ==',
16
+ 'Cookie': 'JSESSIONID=36D5B3C74C1F963C6C73E9AF5B6BDA78.tomcat1; JSESSIONID=B8090C802D8548EA773C97F5886FAB79.tomcat1',
17
+ },
18
+ };
19
+ class FlexPLMRequest {
20
+ static async request(path, data) {
21
+ const config = Object.assign({}, BASE_CONFIG);
22
+ config.url = BASE_URL + path;
23
+ config.data = data;
24
+ try {
25
+ const resp = await (0, axios_1.default)(config);
26
+ return Promise.resolve(resp.data);
27
+ }
28
+ catch (error) {
29
+ console.error(`${FlexPLMRequest} error: ${error.message}`);
30
+ return Promise.resolve(null);
31
+ }
32
+ }
33
+ }
34
+ exports.FlexPLMRequest = FlexPLMRequest;
@@ -0,0 +1,5 @@
1
+ export declare class FlexPLMUtils {
2
+ static convertTypePath: (path: string) => string;
3
+ static getParentTypePath: (path: string) => string;
4
+ static computeLevelFromPath(path: string): number;
5
+ }
@@ -0,0 +1,33 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.FlexPLMUtils = void 0;
4
+ class FlexPLMUtils {
5
+ static computeLevelFromPath(path) {
6
+ return (path.match(/:/g) || []).length + 1;
7
+ }
8
+ }
9
+ exports.FlexPLMUtils = FlexPLMUtils;
10
+ FlexPLMUtils.convertTypePath = (path) => {
11
+ if (!path) {
12
+ return null;
13
+ }
14
+ let newPath = path;
15
+ while (newPath.indexOf('\\') > 1) {
16
+ newPath = newPath.replace('\\', ':');
17
+ }
18
+ while (newPath.indexOf('[') > 1) {
19
+ newPath = newPath.replace('[', '*');
20
+ }
21
+ while (newPath.indexOf(']') > 1) {
22
+ newPath = newPath.replace(']', '*');
23
+ }
24
+ while (newPath.indexOf(' ') > 1) {
25
+ newPath = newPath.replace(' ', '_');
26
+ }
27
+ newPath = newPath.toLowerCase();
28
+ return newPath;
29
+ };
30
+ FlexPLMUtils.getParentTypePath = (path) => {
31
+ const newPath = FlexPLMUtils.convertTypePath(path);
32
+ return (!newPath || newPath.indexOf(':') < 0) ? null : newPath.substring(0, newPath.lastIndexOf(':'));
33
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ const flexplm_utils_1 = require("./flexplm-utils");
4
+ describe('Types Controller', () => {
5
+ beforeEach(async () => {
6
+ });
7
+ it('should convert a type path', () => {
8
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('Product')).toEqual('product');
9
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('Product\\Apparel')).toEqual('product:apparel');
10
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('Product\\Skin Care')).toEqual('product:skin_care');
11
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('Product\\Apparel\\Shirt')).toEqual('product:apparel:shirt');
12
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('Product\\Apparel\\[Shirt]')).toEqual('product:apparel:*shirt*');
13
+ expect(flexplm_utils_1.FlexPLMUtils.convertTypePath('')).toBeNull();
14
+ });
15
+ it('should compute level in tree', () => {
16
+ expect(flexplm_utils_1.FlexPLMUtils.computeLevelFromPath('product')).toEqual(1);
17
+ expect(flexplm_utils_1.FlexPLMUtils.computeLevelFromPath('product:apparel')).toEqual(2);
18
+ expect(flexplm_utils_1.FlexPLMUtils.computeLevelFromPath('product:apparel:dress:mini')).toEqual(4);
19
+ });
20
+ it('should get a parent type path', () => {
21
+ expect(flexplm_utils_1.FlexPLMUtils.getParentTypePath('product')).toBeNull();
22
+ expect(flexplm_utils_1.FlexPLMUtils.getParentTypePath('product:apparel')).toEqual('product');
23
+ expect(flexplm_utils_1.FlexPLMUtils.getParentTypePath('product:apparel:stuff')).toEqual('product:apparel');
24
+ expect(flexplm_utils_1.FlexPLMUtils.getParentTypePath('Product\\Apparel')).toEqual('product');
25
+ });
26
+ });
package/lib/index.d.ts ADDED
@@ -0,0 +1,22 @@
1
+ export * from './flexplm-request';
2
+ export * from './flexplm-utils';
3
+ export * from './util/config-defaults';
4
+ export * from './util/data-converter';
5
+ export * from './util/error-response-object';
6
+ export * from './util/event-short-message-status';
7
+ export * from './util/federation';
8
+ export * from './util/flexplm-connect';
9
+ export * from './interfaces/interfaces';
10
+ export * from './util/logger-config';
11
+ export * from './util/thumbnail-util';
12
+ export * from './util/type-conversion-utils';
13
+ export * from './util/type-defaults';
14
+ export * from './util/type-utils';
15
+ export * from './util/map-utils';
16
+ export * from './interfaces/interfaces';
17
+ export * from './interfaces/item-family-changes';
18
+ export * from './interfaces/publish-change-data';
19
+ export * from './publish/base-process-publish-assortment';
20
+ export * from './publish/base-process-publish-assortment-callback';
21
+ export * from './entity-processor/base-entity-processor';
22
+ export * from './transform/identifier-conversion';
package/lib/index.js ADDED
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./flexplm-request"), exports);
18
+ __exportStar(require("./flexplm-utils"), exports);
19
+ __exportStar(require("./util/config-defaults"), exports);
20
+ __exportStar(require("./util/data-converter"), exports);
21
+ __exportStar(require("./util/error-response-object"), exports);
22
+ __exportStar(require("./util/event-short-message-status"), exports);
23
+ __exportStar(require("./util/federation"), exports);
24
+ __exportStar(require("./util/flexplm-connect"), exports);
25
+ __exportStar(require("./interfaces/interfaces"), exports);
26
+ __exportStar(require("./util/logger-config"), exports);
27
+ __exportStar(require("./util/thumbnail-util"), exports);
28
+ __exportStar(require("./util/type-conversion-utils"), exports);
29
+ __exportStar(require("./util/type-defaults"), exports);
30
+ __exportStar(require("./util/type-utils"), exports);
31
+ __exportStar(require("./util/map-utils"), exports);
32
+ __exportStar(require("./interfaces/interfaces"), exports);
33
+ __exportStar(require("./interfaces/item-family-changes"), exports);
34
+ __exportStar(require("./interfaces/publish-change-data"), exports);
35
+ __exportStar(require("./publish/base-process-publish-assortment"), exports);
36
+ __exportStar(require("./publish/base-process-publish-assortment-callback"), exports);
37
+ __exportStar(require("./entity-processor/base-entity-processor"), exports);
38
+ __exportStar(require("./transform/identifier-conversion"), exports);