@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,149 +1,149 @@
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.Federation = void 0;
7
- const sdk_1 = require("@contrail/sdk");
8
- const p_limit_1 = __importDefault(require("p-limit"));
9
- const limit = (0, p_limit_1.default)(30);
10
- const FED_CONFIG = {
11
- appIdentifier: '@vibeiq/flexplm-connector',
12
- federationSchema: 'DEFAULT'
13
- };
14
- class Federation {
15
- constructor() {
16
- this.CHUNK_SIZE = 50;
17
- }
18
- async getFederatedMappedRefId(entityType, entityId) {
19
- const criteria = {
20
- reference: entityType + ':' + entityId,
21
- appIdentifier: FED_CONFIG.appIdentifier,
22
- federationSchema: FED_CONFIG.federationSchema
23
- };
24
- console.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
25
- const fedRecords = await new sdk_1.Entities().get({
26
- entityName: 'federation',
27
- criteria
28
- });
29
- const federatedId = (fedRecords[0])
30
- ? fedRecords[0]['mappedReference']
31
- : '';
32
- return federatedId;
33
- }
34
- async createFederatedRecord(eventBody) {
35
- const itemResults = eventBody.payload;
36
- for (let i = 0; i < itemResults.length; i++) {
37
- if (!itemResults[i].federatedId) {
38
- continue;
39
- }
40
- const payload = {
41
- appIdentifier: FED_CONFIG.appIdentifier,
42
- reference: itemResults[i].entityReference,
43
- mappedReference: itemResults[i].federatedId,
44
- federationSchema: FED_CONFIG.federationSchema
45
- };
46
- try {
47
- const results = await new sdk_1.Entities().create({ entityName: 'federation', object: payload });
48
- return results;
49
- }
50
- catch (error) {
51
- console.log('createFederatedRecord-error: ', error);
52
- throw new Error('Error creating federation record: ' + error.message);
53
- }
54
- }
55
- }
56
- async getFederationRecordFromMappedRefId(mappedRefId) {
57
- const criteria = {
58
- appIdentifier: FED_CONFIG.appIdentifier,
59
- mappedReference: mappedRefId,
60
- federationSchema: FED_CONFIG.federationSchema
61
- };
62
- try {
63
- const fedRecords = await new sdk_1.Entities().get({
64
- entityName: 'federation',
65
- criteria
66
- });
67
- return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
68
- }
69
- catch (e) {
70
- console.log('getFederationData-error: ' + e.message);
71
- }
72
- return undefined;
73
- }
74
- static getEntityId(fedRecord) {
75
- const entityString = fedRecord['reference'];
76
- const entitySplit = entityString.split(':');
77
- const entityType = entitySplit[0];
78
- const entityId = entitySplit[1];
79
- return { entityType, entityId };
80
- }
81
- async getEntityFromMappedRefId(mappedRefId) {
82
- const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
83
- console.log('fedRecord: ' + JSON.stringify(fedRecord));
84
- if (!fedRecord) {
85
- console.log('Federation Record doesnt exist. Cant get entity!');
86
- return;
87
- }
88
- const { entityType, entityId } = Federation.getEntityId(fedRecord);
89
- const criteria = {
90
- id: entityId
91
- };
92
- const entities = await new sdk_1.Entities().get({
93
- entityName: entityType,
94
- criteria
95
- });
96
- const entity = (entities && entities[0]) ? entities[0] : undefined;
97
- return entity;
98
- }
99
- async getFederationRecordsFromIds(ids) {
100
- const fedRecords = [];
101
- for (let i = 0; i < ids.length; i++) {
102
- const criteria = {
103
- reference: ids[i],
104
- appIdentifier: FED_CONFIG.appIdentifier,
105
- federationSchema: FED_CONFIG.federationSchema
106
- };
107
- const recs = await new sdk_1.Entities().get({
108
- entityName: 'federation',
109
- criteria
110
- });
111
- if (recs[0]) {
112
- fedRecords.push(recs[0]);
113
- }
114
- }
115
- return fedRecords;
116
- }
117
- async getFederationRecordsFromIdsBulk(ids) {
118
- const chunks = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
119
- const fedRecords = [];
120
- const federatedPromises = [];
121
- const entities = new sdk_1.Entities();
122
- for (const chunk of chunks) {
123
- const fedPromise = limit(async () => {
124
- const criteria = {
125
- references: chunk,
126
- appIdentifier: FED_CONFIG.appIdentifier,
127
- federationSchema: FED_CONFIG.federationSchema
128
- };
129
- const records = await entities.get({
130
- entityName: 'federation',
131
- criteria
132
- });
133
- fedRecords.push(...records);
134
- });
135
- federatedPromises.push(fedPromise);
136
- }
137
- await Promise.all(federatedPromises);
138
- return fedRecords;
139
- }
140
- splitIntoChunksByLen(arr, len) {
141
- const chunks = [], n = arr?.length;
142
- let i = 0;
143
- while (i < n) {
144
- chunks.push(arr.slice(i, i += len));
145
- }
146
- return chunks;
147
- }
148
- }
149
- exports.Federation = Federation;
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.Federation = void 0;
7
+ const sdk_1 = require("@contrail/sdk");
8
+ const p_limit_1 = __importDefault(require("p-limit"));
9
+ const limit = (0, p_limit_1.default)(30);
10
+ const FED_CONFIG = {
11
+ appIdentifier: '@vibeiq/flexplm-connector',
12
+ federationSchema: 'DEFAULT'
13
+ };
14
+ class Federation {
15
+ constructor() {
16
+ this.CHUNK_SIZE = 50;
17
+ }
18
+ async getFederatedMappedRefId(entityType, entityId) {
19
+ const criteria = {
20
+ reference: entityType + ':' + entityId,
21
+ appIdentifier: FED_CONFIG.appIdentifier,
22
+ federationSchema: FED_CONFIG.federationSchema
23
+ };
24
+ console.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
25
+ const fedRecords = await new sdk_1.Entities().get({
26
+ entityName: 'federation',
27
+ criteria
28
+ });
29
+ const federatedId = (fedRecords[0])
30
+ ? fedRecords[0]['mappedReference']
31
+ : '';
32
+ return federatedId;
33
+ }
34
+ async createFederatedRecord(eventBody) {
35
+ const itemResults = eventBody.payload;
36
+ for (let i = 0; i < itemResults.length; i++) {
37
+ if (!itemResults[i].federatedId) {
38
+ continue;
39
+ }
40
+ const payload = {
41
+ appIdentifier: FED_CONFIG.appIdentifier,
42
+ reference: itemResults[i].entityReference,
43
+ mappedReference: itemResults[i].federatedId,
44
+ federationSchema: FED_CONFIG.federationSchema
45
+ };
46
+ try {
47
+ const results = await new sdk_1.Entities().create({ entityName: 'federation', object: payload });
48
+ return results;
49
+ }
50
+ catch (error) {
51
+ console.log('createFederatedRecord-error: ', error);
52
+ throw new Error('Error creating federation record: ' + error.message);
53
+ }
54
+ }
55
+ }
56
+ async getFederationRecordFromMappedRefId(mappedRefId) {
57
+ const criteria = {
58
+ appIdentifier: FED_CONFIG.appIdentifier,
59
+ mappedReference: mappedRefId,
60
+ federationSchema: FED_CONFIG.federationSchema
61
+ };
62
+ try {
63
+ const fedRecords = await new sdk_1.Entities().get({
64
+ entityName: 'federation',
65
+ criteria
66
+ });
67
+ return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
68
+ }
69
+ catch (e) {
70
+ console.log('getFederationData-error: ' + e.message);
71
+ }
72
+ return undefined;
73
+ }
74
+ static getEntityId(fedRecord) {
75
+ const entityString = fedRecord['reference'];
76
+ const entitySplit = entityString.split(':');
77
+ const entityType = entitySplit[0];
78
+ const entityId = entitySplit[1];
79
+ return { entityType, entityId };
80
+ }
81
+ async getEntityFromMappedRefId(mappedRefId) {
82
+ const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
83
+ console.log('fedRecord: ' + JSON.stringify(fedRecord));
84
+ if (!fedRecord) {
85
+ console.log('Federation Record doesnt exist. Cant get entity!');
86
+ return;
87
+ }
88
+ const { entityType, entityId } = Federation.getEntityId(fedRecord);
89
+ const criteria = {
90
+ id: entityId
91
+ };
92
+ const entities = await new sdk_1.Entities().get({
93
+ entityName: entityType,
94
+ criteria
95
+ });
96
+ const entity = (entities && entities[0]) ? entities[0] : undefined;
97
+ return entity;
98
+ }
99
+ async getFederationRecordsFromIds(ids) {
100
+ const fedRecords = [];
101
+ for (let i = 0; i < ids.length; i++) {
102
+ const criteria = {
103
+ reference: ids[i],
104
+ appIdentifier: FED_CONFIG.appIdentifier,
105
+ federationSchema: FED_CONFIG.federationSchema
106
+ };
107
+ const recs = await new sdk_1.Entities().get({
108
+ entityName: 'federation',
109
+ criteria
110
+ });
111
+ if (recs[0]) {
112
+ fedRecords.push(recs[0]);
113
+ }
114
+ }
115
+ return fedRecords;
116
+ }
117
+ async getFederationRecordsFromIdsBulk(ids) {
118
+ const chunks = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
119
+ const fedRecords = [];
120
+ const federatedPromises = [];
121
+ const entities = new sdk_1.Entities();
122
+ for (const chunk of chunks) {
123
+ const fedPromise = limit(async () => {
124
+ const criteria = {
125
+ references: chunk,
126
+ appIdentifier: FED_CONFIG.appIdentifier,
127
+ federationSchema: FED_CONFIG.federationSchema
128
+ };
129
+ const records = await entities.get({
130
+ entityName: 'federation',
131
+ criteria
132
+ });
133
+ fedRecords.push(...records);
134
+ });
135
+ federatedPromises.push(fedPromise);
136
+ }
137
+ await Promise.all(federatedPromises);
138
+ return fedRecords;
139
+ }
140
+ splitIntoChunksByLen(arr, len) {
141
+ const chunks = [], n = arr?.length;
142
+ let i = 0;
143
+ while (i < n) {
144
+ chunks.push(arr.slice(i, i += len));
145
+ }
146
+ return chunks;
147
+ }
148
+ }
149
+ exports.Federation = Federation;
@@ -1,18 +1,22 @@
1
- import { FCConfig, FlexPLMResponseData, PayloadType } from '../interfaces/interfaces';
2
- export declare class FlexPLMConnect {
3
- private config;
4
- private vibeEventEndpoint;
5
- private staticHeaders;
6
- payloadSendAsArray: boolean;
7
- constructor(_config: FCConfig, endPoint?: any, payloadAsArray?: any);
8
- private getRequestOptions;
9
- getCSRF(): Promise<{
10
- nonce_key: any;
11
- nonce: any;
12
- }>;
13
- sendRequest(csrf: any, payload: any): Promise<Response>;
14
- protected processRequest(payload: any): Promise<FlexPLMResponseData>;
15
- sendToFlexPLM(payload: PayloadType): Promise<FlexPLMResponseData>;
16
- sendMultipleToFlexPLM(payload: PayloadType[]): Promise<FlexPLMResponseData>;
17
- getRequest(): Promise<any>;
18
- }
1
+ import { FCConfig, FlexPLMResponseData, PayloadType } from '../interfaces/interfaces';
2
+ export declare class FlexPLMConnect {
3
+ private config;
4
+ private vibeEventEndpoint;
5
+ private staticHeaders;
6
+ payloadSendAsArray: boolean;
7
+ constructor(_config: FCConfig, endPoint?: any, payloadAsArray?: any);
8
+ private getRequestOptions;
9
+ getCSRF(): Promise<{
10
+ nonce_key: any;
11
+ nonce: any;
12
+ }>;
13
+ sendRequest(csrf: any, payload: any): Promise<Response>;
14
+ protected processRequest(payload: any): Promise<FlexPLMResponseData>;
15
+ sendToFlexPLM(payload: PayloadType): Promise<FlexPLMResponseData>;
16
+ sendMultipleToFlexPLM(payload: PayloadType[]): Promise<FlexPLMResponseData>;
17
+ getRequest(params?: {
18
+ urlPath?: string;
19
+ includeUrlContext?: boolean;
20
+ returnFullResponse?: boolean;
21
+ }): Promise<Response | unknown>;
22
+ }