@contrail/flexplm 1.3.0 → 1.3.1-alpha.585afc1

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 (149) hide show
  1. package/lib/cli/commands/compile.d.ts +1 -0
  2. package/lib/cli/commands/compile.js +71 -0
  3. package/lib/cli/commands/compile.spec.d.ts +1 -0
  4. package/lib/cli/commands/compile.spec.js +80 -0
  5. package/lib/cli/commands/create.d.ts +1 -0
  6. package/lib/cli/commands/create.js +75 -0
  7. package/lib/cli/commands/create.spec.d.ts +1 -0
  8. package/lib/cli/commands/create.spec.js +78 -0
  9. package/lib/cli/commands/upload.d.ts +10 -0
  10. package/lib/cli/commands/upload.js +219 -0
  11. package/lib/cli/commands/upload.spec.d.ts +1 -0
  12. package/lib/cli/commands/upload.spec.js +88 -0
  13. package/lib/cli/index.d.ts +2 -0
  14. package/lib/cli/index.js +64 -0
  15. package/lib/cli/index.spec.d.ts +1 -0
  16. package/lib/cli/index.spec.js +79 -0
  17. package/lib/cli/template/mapping-template.ts.template +18 -0
  18. package/lib/entity-processor/base-entity-processor.d.ts +89 -42
  19. package/lib/entity-processor/base-entity-processor.js +438 -385
  20. package/lib/entity-processor/base-entity-processor.spec.d.ts +1 -1
  21. package/lib/entity-processor/base-entity-processor.spec.js +398 -397
  22. package/lib/flexplm-request.d.ts +3 -3
  23. package/lib/flexplm-request.js +34 -34
  24. package/lib/flexplm-utils.d.ts +5 -5
  25. package/lib/flexplm-utils.js +33 -33
  26. package/lib/flexplm-utils.spec.d.ts +1 -1
  27. package/lib/flexplm-utils.spec.js +26 -26
  28. package/lib/index.d.ts +23 -22
  29. package/lib/index.js +39 -38
  30. package/lib/interfaces/interfaces.d.ts +105 -105
  31. package/lib/interfaces/interfaces.js +2 -2
  32. package/lib/interfaces/item-family-changes.d.ts +20 -20
  33. package/lib/interfaces/item-family-changes.js +56 -56
  34. package/lib/interfaces/mapping-file.d.ts +429 -0
  35. package/lib/interfaces/mapping-file.js +2 -0
  36. package/lib/interfaces/publish-change-data.d.ts +19 -19
  37. package/lib/interfaces/publish-change-data.js +32 -32
  38. package/lib/publish/base-process-publish-assortment-callback.d.ts +9 -9
  39. package/lib/publish/base-process-publish-assortment-callback.js +38 -38
  40. package/lib/publish/base-process-publish-assortment.d.ts +118 -93
  41. package/lib/publish/base-process-publish-assortment.js +998 -944
  42. package/lib/publish/base-process-publish-assortment.spec.d.ts +1 -1
  43. package/lib/publish/base-process-publish-assortment.spec.js +1688 -1670
  44. package/lib/publish/mockData.d.ts +1389 -1389
  45. package/lib/publish/mockData.js +4524 -4519
  46. package/lib/transform/identifier-conversion-spec-mockData.js +472 -444
  47. package/lib/transform/identifier-conversion.d.ts +51 -15
  48. package/lib/transform/identifier-conversion.js +248 -212
  49. package/lib/transform/identifier-conversion.spec.d.ts +1 -1
  50. package/lib/transform/identifier-conversion.spec.js +343 -339
  51. package/lib/util/config-defaults.d.ts +8 -8
  52. package/lib/util/config-defaults.js +88 -85
  53. package/lib/util/config-defaults.spec.d.ts +1 -1
  54. package/lib/util/config-defaults.spec.js +302 -293
  55. package/lib/util/data-converter-spec-mockData.js +219 -205
  56. package/lib/util/data-converter.d.ts +136 -39
  57. package/lib/util/data-converter.js +718 -592
  58. package/lib/util/data-converter.spec.d.ts +1 -1
  59. package/lib/util/data-converter.spec.js +906 -904
  60. package/lib/util/error-response-object.d.ts +9 -4
  61. package/lib/util/error-response-object.js +54 -47
  62. package/lib/util/error-response-object.spec.d.ts +1 -1
  63. package/lib/util/error-response-object.spec.js +99 -99
  64. package/lib/util/event-short-message-status.d.ts +19 -19
  65. package/lib/util/event-short-message-status.js +24 -23
  66. package/lib/util/federation.d.ts +15 -15
  67. package/lib/util/federation.js +157 -149
  68. package/lib/util/flexplm-connect.d.ts +29 -22
  69. package/lib/util/flexplm-connect.js +190 -176
  70. package/lib/util/flexplm-connect.spec.d.ts +1 -1
  71. package/lib/util/flexplm-connect.spec.js +88 -88
  72. package/lib/util/logger-config.d.ts +1 -1
  73. package/lib/util/logger-config.js +27 -26
  74. package/lib/util/map-util-spec-mockData.js +219 -205
  75. package/lib/util/map-utils.d.ts +33 -6
  76. package/lib/util/map-utils.js +42 -15
  77. package/lib/util/map-utils.spec.d.ts +1 -1
  78. package/lib/util/map-utils.spec.js +89 -89
  79. package/lib/util/mockData.d.ts +80 -80
  80. package/lib/util/mockData.js +103 -103
  81. package/lib/util/thumbnail-util.d.ts +55 -34
  82. package/lib/util/thumbnail-util.js +242 -215
  83. package/lib/util/thumbnail-util.spec.d.ts +1 -1
  84. package/lib/util/thumbnail-util.spec.js +440 -434
  85. package/lib/util/type-conversion-utils-spec-mockData.js +259 -259
  86. package/lib/util/type-conversion-utils.d.ts +163 -23
  87. package/lib/util/type-conversion-utils.js +408 -265
  88. package/lib/util/type-conversion-utils.spec.d.ts +1 -1
  89. package/lib/util/type-conversion-utils.spec.js +868 -868
  90. package/lib/util/type-defaults.d.ts +74 -16
  91. package/lib/util/type-defaults.js +279 -221
  92. package/lib/util/type-defaults.spec.d.ts +1 -1
  93. package/lib/util/type-defaults.spec.js +516 -516
  94. package/lib/util/type-utils.d.ts +34 -13
  95. package/lib/util/type-utils.js +137 -114
  96. package/lib/util/type-utils.spec.d.ts +1 -1
  97. package/lib/util/type-utils.spec.js +192 -190
  98. package/package.json +21 -6
  99. package/scripts/copy-template.js +10 -0
  100. package/.claude/settings.local.json +0 -8
  101. package/.github/pull_request_template.md +0 -31
  102. package/.github/workflows/flexplm-lib.yml +0 -27
  103. package/.github/workflows/publish-to-npm.yml +0 -124
  104. package/CHANGELOG.md +0 -32
  105. package/publish.bat +0 -5
  106. package/publish.sh +0 -5
  107. package/src/entity-processor/base-entity-processor.spec.ts +0 -460
  108. package/src/entity-processor/base-entity-processor.ts +0 -515
  109. package/src/flexplm-request.ts +0 -28
  110. package/src/flexplm-utils.spec.ts +0 -27
  111. package/src/flexplm-utils.ts +0 -29
  112. package/src/index.ts +0 -22
  113. package/src/interfaces/interfaces.ts +0 -122
  114. package/src/interfaces/item-family-changes.ts +0 -67
  115. package/src/interfaces/publish-change-data.ts +0 -43
  116. package/src/publish/base-process-publish-assortment-callback.ts +0 -50
  117. package/src/publish/base-process-publish-assortment.spec.ts +0 -1992
  118. package/src/publish/base-process-publish-assortment.ts +0 -1134
  119. package/src/publish/mockData.ts +0 -4561
  120. package/src/transform/identifier-conversion-spec-mockData.ts +0 -496
  121. package/src/transform/identifier-conversion.spec.ts +0 -354
  122. package/src/transform/identifier-conversion.ts +0 -282
  123. package/src/util/config-defaults.spec.ts +0 -350
  124. package/src/util/config-defaults.ts +0 -93
  125. package/src/util/data-converter-spec-mockData.ts +0 -231
  126. package/src/util/data-converter.spec.ts +0 -1041
  127. package/src/util/data-converter.ts +0 -762
  128. package/src/util/error-response-object.spec.ts +0 -116
  129. package/src/util/error-response-object.ts +0 -50
  130. package/src/util/event-short-message-status.ts +0 -22
  131. package/src/util/federation.ts +0 -172
  132. package/src/util/flexplm-connect.spec.ts +0 -132
  133. package/src/util/flexplm-connect.ts +0 -208
  134. package/src/util/logger-config.ts +0 -20
  135. package/src/util/map-util-spec-mockData.ts +0 -231
  136. package/src/util/map-utils.spec.ts +0 -103
  137. package/src/util/map-utils.ts +0 -41
  138. package/src/util/mockData.ts +0 -101
  139. package/src/util/thumbnail-util.spec.ts +0 -508
  140. package/src/util/thumbnail-util.ts +0 -272
  141. package/src/util/type-conversion-utils-spec-mockData.ts +0 -271
  142. package/src/util/type-conversion-utils.spec.ts +0 -968
  143. package/src/util/type-conversion-utils.ts +0 -460
  144. package/src/util/type-defaults.spec.ts +0 -669
  145. package/src/util/type-defaults.ts +0 -281
  146. package/src/util/type-utils.spec.ts +0 -227
  147. package/src/util/type-utils.ts +0 -144
  148. package/tsconfig.json +0 -29
  149. package/tslint.json +0 -57
@@ -1,149 +1,157 @@
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
+ // console.log('createFederatedRecord: ' + JSON.stringify(payload));
47
+ try {
48
+ const results = await new sdk_1.Entities().create({ entityName: 'federation', object: payload });
49
+ return results;
50
+ // console.log(JSON.stringify(results));
51
+ }
52
+ catch (error) {
53
+ console.log('createFederatedRecord-error: ', error);
54
+ throw new Error('Error creating federation record: ' + error.message);
55
+ }
56
+ }
57
+ }
58
+ async getFederationRecordFromMappedRefId(mappedRefId) {
59
+ const criteria = {
60
+ appIdentifier: FED_CONFIG.appIdentifier,
61
+ mappedReference: mappedRefId,
62
+ federationSchema: FED_CONFIG.federationSchema
63
+ };
64
+ try {
65
+ const fedRecords = await new sdk_1.Entities().get({
66
+ entityName: 'federation',
67
+ criteria
68
+ });
69
+ return (fedRecords && fedRecords[0]) ? fedRecords[0] : undefined;
70
+ }
71
+ catch (e) {
72
+ console.log('getFederationData-error: ' + e.message);
73
+ }
74
+ return undefined;
75
+ }
76
+ static getEntityId(fedRecord) {
77
+ const entityString = fedRecord['reference'];
78
+ const entitySplit = entityString.split(':');
79
+ const entityType = entitySplit[0];
80
+ const entityId = entitySplit[1];
81
+ return { entityType, entityId };
82
+ }
83
+ async getEntityFromMappedRefId(mappedRefId) {
84
+ // console.log('!---getEntityFromMappedRefId: ' + mappedRefId);
85
+ const fedRecord = await this.getFederationRecordFromMappedRefId(mappedRefId);
86
+ console.log('fedRecord: ' + JSON.stringify(fedRecord));
87
+ if (!fedRecord) {
88
+ //Not creating from FlexPLM at this time.
89
+ console.log('Federation Record doesnt exist. Cant get entity!');
90
+ return;
91
+ }
92
+ const { entityType, entityId } = Federation.getEntityId(fedRecord);
93
+ // console.log(entityType + ':' + entityId);
94
+ const criteria = {
95
+ id: entityId
96
+ };
97
+ const entities = await new sdk_1.Entities().get({
98
+ entityName: entityType,
99
+ criteria
100
+ });
101
+ const entity = (entities && entities[0]) ? entities[0] : undefined;
102
+ // console.log(' entities: ' +JSON.stringify(entities));
103
+ return entity;
104
+ }
105
+ async getFederationRecordsFromIds(ids) {
106
+ const fedRecords = [];
107
+ for (let i = 0; i < ids.length; i++) {
108
+ const criteria = {
109
+ reference: ids[i],
110
+ appIdentifier: FED_CONFIG.appIdentifier,
111
+ federationSchema: FED_CONFIG.federationSchema
112
+ };
113
+ // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
114
+ const recs = await new sdk_1.Entities().get({
115
+ entityName: 'federation',
116
+ criteria
117
+ });
118
+ if (recs[0]) {
119
+ fedRecords.push(recs[0]);
120
+ }
121
+ }
122
+ return fedRecords;
123
+ }
124
+ async getFederationRecordsFromIdsBulk(ids) {
125
+ const chunks = this.splitIntoChunksByLen(ids, this.CHUNK_SIZE);
126
+ const fedRecords = [];
127
+ const federatedPromises = [];
128
+ const entities = new sdk_1.Entities();
129
+ for (const chunk of chunks) {
130
+ const fedPromise = limit(async () => {
131
+ const criteria = {
132
+ references: chunk,
133
+ appIdentifier: FED_CONFIG.appIdentifier,
134
+ federationSchema: FED_CONFIG.federationSchema
135
+ };
136
+ // this.logger.log('getFederatedMappedRefId: ' + JSON.stringify(criteria));
137
+ const records = await entities.get({
138
+ entityName: 'federation',
139
+ criteria
140
+ });
141
+ fedRecords.push(...records);
142
+ });
143
+ federatedPromises.push(fedPromise);
144
+ }
145
+ await Promise.all(federatedPromises);
146
+ return fedRecords;
147
+ }
148
+ splitIntoChunksByLen(arr, len) {
149
+ const chunks = [], n = arr?.length;
150
+ let i = 0;
151
+ while (i < n) {
152
+ chunks.push(arr.slice(i, i += len));
153
+ }
154
+ return chunks;
155
+ }
156
+ }
157
+ exports.Federation = Federation;
@@ -1,22 +1,29 @@
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
- }
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
+ /** Runs a GET request to FlexPLM.
18
+ * @param params - Optional configuration for the request.
19
+ * @param params.urlPath - Custom URL path to use instead of the default `/servlet/rest` + endpoint.
20
+ * @param params.includeUrlContext - Whether to include the urlContext in the URL. Defaults to `true`.
21
+ * @param params.returnFullResponse - If `true`, returns the raw `Response` object instead of parsed JSON. Defaults to `false`.
22
+ * @returns The parsed JSON response body, or the raw `Response` object if `returnFullResponse` is `true`.
23
+ */
24
+ getRequest(params?: {
25
+ urlPath?: string;
26
+ includeUrlContext?: boolean;
27
+ returnFullResponse?: boolean;
28
+ }): Promise<Response | unknown>;
29
+ }