@contrail/flexplm 1.7.4-alpha.7bbda17 → 1.7.4-alpha.aaaa660

package/lib/cli/commands/config-create.js

@@ -79,7 +79,7 @@ class ConfigCreateCommand {
         }
         fs.writeFileSync(outPath, rendered, 'utf8');
         console.log(`Created ${outPath}`);
-        console.log('Only "orgName" and "appIdentifier" are required. See the "_availableAttributes" block in the file for other attributes this org can set (apiHost, identifierAtts, LCSMaterial, etc.) — add the ones you need as real top-level keys, then delete "_availableAttributes"; the connector ignores it and applies defaults at runtime for anything you omit.');
+        console.log('"orgName" and "appIdentifier" are pre-filled, but this file is not complete yet: FlexPLM connectivity also requires apiHost, userName, and password. See the "_availableAttributes" block in the file for these and other attributes this org can set (identifierAtts, LCSMaterial, etc.) — add the ones you need as real top-level keys, then delete "_availableAttributes"; the connector ignores it and applies defaults at runtime for anything you omit.');
     }
 }
 exports.ConfigCreateCommand = ConfigCreateCommand;

package/lib/cli/commands/config-create.spec.js

@@ -59,6 +59,11 @@ describe('ConfigCreateCommand', () => {
         expect(config.orgName).toEqual('acme');
         expect(config.appIdentifier).toEqual('@vibeiq/flexplm-connector');
     });
+    it('trims whitespace around the orgName input', async () => {
+        answers = ['  acme  ', '@vibeiq/flexplm-connector'];
+        await new config_create_1.ConfigCreateCommand().run();
+        expect(fs.existsSync(path.join(tempDir, 'acme-flexplmConfig.json'))).toBe(true);
+    });
     it('defaults appIdentifier to @vibeiq/flexplm-connector when left blank', async () => {
         answers = ['acme', ''];
         await new config_create_1.ConfigCreateCommand().run();

package/lib/cli/commands/config-upload.spec.js

@@ -26,32 +26,72 @@ describe('ConfigUploadCommand.parseArgs', () => {
         const opts = config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '-b', 'feature/x']);
         expect(opts.branch).toEqual('feature/x');
     });
+    it('parses options before the file path', () => {
+        const opts = config_upload_1.ConfigUploadCommand.parseArgs(['-m', 'msg', '-b', 'br', 'config.json']);
+        expect(opts).toEqual({
+            filePath: 'config.json',
+            message: 'msg',
+            branch: 'br',
+            skipGit: false,
+            updateConfig: false,
+        });
+    });
     it('parses --skip-git flag', () => {
         const opts = config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '--skip-git']);
         expect(opts.skipGit).toBe(true);
     });
+    it('accepts the legacy --skipGit alias', () => {
+        const opts = config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '--skipGit']);
+        expect(opts.skipGit).toBe(true);
+    });
     it('parses --update-config flag', () => {
         const opts = config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '--update-config']);
         expect(opts.updateConfig).toBe(true);
     });
+    it('parses all options together', () => {
+        const opts = config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '-m', 'msg', '-b', 'br', '--skip-git', '--update-config']);
+        expect(opts).toEqual({
+            filePath: 'config.json',
+            message: 'msg',
+            branch: 'br',
+            skipGit: true,
+            updateConfig: true,
+        });
+    });
     it('throws when -m is missing its value', () => {
         expect(() => config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '-m'])).toThrow(/-m requires a commit message/);
     });
+    it('throws when -b is missing its value', () => {
+        expect(() => config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '-b'])).toThrow(/-b requires a branch name/);
+    });
     it('throws on unknown option', () => {
         expect(() => config_upload_1.ConfigUploadCommand.parseArgs(['config.json', '--bogus'])).toThrow(/Unknown option: --bogus/);
     });
+    it('throws when an extra positional argument is supplied', () => {
+        expect(() => config_upload_1.ConfigUploadCommand.parseArgs(['config.json', 'extra.json'])).toThrow(/Unexpected argument: extra\.json/);
+    });
     it('throws when no file path is provided', () => {
         expect(() => config_upload_1.ConfigUploadCommand.parseArgs([])).toThrow(/missing <path\.json>/);
     });
+    it('throws when only options are provided', () => {
+        expect(() => config_upload_1.ConfigUploadCommand.parseArgs(['--skip-git'])).toThrow(/missing <path\.json>/);
+    });
 });
 describe('ConfigUploadCommand.buildCommitMessage', () => {
     it('appends fileId to the first line of a single-line message', () => {
         expect(config_upload_1.ConfigUploadCommand.buildCommitMessage('initial commit', 'abc123')).toEqual('initial commit [fileId: abc123]');
     });
+    it('only appends fileId to the first line of a multi-line message', () => {
+        const result = config_upload_1.ConfigUploadCommand.buildCommitMessage('header line\nbody line 1\nbody line 2', 'xyz');
+        expect(result).toEqual('header line [fileId: xyz]\nbody line 1\nbody line 2');
+    });
     it('handles CRLF line endings', () => {
         const result = config_upload_1.ConfigUploadCommand.buildCommitMessage('header\r\nbody', 'fid');
         expect(result).toEqual('header [fileId: fid]\nbody');
     });
+    it('handles an empty message', () => {
+        expect(config_upload_1.ConfigUploadCommand.buildCommitMessage('', 'fid')).toEqual(' [fileId: fid]');
+    });
 });
 describe('ConfigUploadCommand.run', () => {
     const fs = require('fs');

package/lib/cli/template/config-template.json.template

@@ -4,19 +4,27 @@
 
   "_availableAttributes": {
     "_note": "Reference only — the connector never reads this key. Add any of the attributes below as real top-level keys if this org needs them, then delete this whole \"_availableAttributes\" block.",
-    "apiHost": "FlexPLM API host base URL (required for the connector to reach FlexPLM)",
-    "userName": "FlexPLM user name used for Basic Auth (required)",
-    "password": "FlexPLM password used for Basic Auth (required)",
-    "plmEnviornment": "Sent as the PLM_ENV header on every FlexPLM request",
+    "apiHost": "FlexPLM API host base URL. Required — throws NEED_CONFIG_VALUES if missing",
+    "userName": "FlexPLM user name used for Basic Auth. Required; rewritten to a () => string getter",
+    "password": "FlexPLM password used for Basic Auth. Required; rewritten to a () => string getter",
     "urlContext": "Path prefix for FlexPLM URLs. Default: '/Windchill'",
-    "csrfEndpoint": "CSRF token endpoint path. Default: '/servlet/rest/security/csrf'",
-    "vibeEventEndpoint": "Endpoint VibeIQ posts inbound events to. Default: '/rfa/vibeiq/vibeEvents'",
     "itemPreDevelopmentLifecycleStages": "Item lifecycle stages during which items are not synced to FlexPLM. Default: ['concept']",
-    "identifierAtts": "Map of FlexPLM object class to identifier attribute name(s), e.g. { \"LCSProduct\": [\"itemNumber\"] }",
-    "LCSMaterial": "{ \"processAsItem\": true } routes LCSMaterial to item:material instead of custom-entity",
-    "sendMode": "Map of event type to send mode, e.g. { \"ASYNC_PUBLISH_SEASON\": \"vibeiqfile\" }",
-    "payloadDefaultAsArray": "Whether outbound payload values default to arrays. Default: true",
-    "flexplmConnect": "{ \"staticHeaders\": { ... } } adds custom static headers to every FlexPLM request",
-    "propertyMapping": "Reserved for custom property-mapping overrides"
+    "logLevel": "Possible values: error/warn/info/debug. Default: info",
+    "identifierAtts": "Deprecated. Map of FlexPLM object class to identifier attribute name(s), e.g. { \"LCSProduct\": [\"itemNumber\"] }",
+    "plmEnviornment": "Sent as the PLM_ENV header on every FlexPLM request. Only used by 1 customer. NOTE: this key is intentionally spelled \"plmEnviornment\" (matching the connector's actual config key) — do not \"fix\" the spelling to \"plmEnvironment\", it will silently stop working",
+    "propertyMapping": "Deprecated. Reserved for custom property-mapping overrides",
+    "complexConfig": "Object of additional attributes (see below) merged onto the top level of the config, then deleted; __proto__/constructor/prototype keys are stripped for safety. e.g. { \"complexConfig\": { \"csrfEndpoint\": \"...\" } }",
+    "csrfEndpoint (in complexConfig)": "CSRF token endpoint path. Default: '/servlet/rest/security/csrf'",
+    "dataConverter.useDisplayForEnumerationMatching (in complexConfig)": "Default: false",
+    "dataConverter.verboseDebug (in complexConfig)": "Default: false",
+    "flexplmConnect.staticHeaders (in complexConfig)": "Extra static headers added to every FlexPLM request",
+    "LCSMaterial.processAsItem (in complexConfig)": "true routes LCSMaterial to item:material instead of custom-entity. Default: false",
+    "max_thumbnail_size (in complexConfig)": "Max thumbnail size in bytes. Default: 5 MB",
+    "payloadDefaultAsArray (in complexConfig)": "Whether outbound payload values default to arrays. Default: true",
+    "search.<entityType>.useIdentityServiceForInboundData (in complexConfig)": "entityType is one of: item, color, custom-entity, project-item. Default: false",
+    "sendMode.ASYNC_PUBLISH_SEASON (in complexConfig)": "Default: 'vibeiqfile'",
+    "syncOptionSets (in complexConfig)": "Array of { flexInternalName, vibeSlug }",
+    "useDistinctRestEndPointForImages (in complexConfig)": "Default: false; when true routes image fetch through /rfa/vibeiq/image instead of the raw URL",
+    "vibeEventEndpoint (in complexConfig)": "Endpoint VibeIQ posts inbound events to. Default: '/rfa/vibeiq/vibeEvents'"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.7.4-alpha.7bbda17",
+  "version": "1.7.4-alpha.aaaa660",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",