@contrail/flexplm 1.3.1-alpha.7db7b62 → 1.3.1-alpha.97cfe70

package/lib/cli/commands/compile.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cli/commands/compile.spec.js

@@ -0,0 +1,80 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+const compile_1 = require("./compile");
+describe('runCompile', () => {
+    let tempDir;
+    let originalCwd;
+    let logSpy;
+    let stderrSpy;
+    beforeEach(() => {
+        originalCwd = process.cwd();
+        tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'flexplm-compile-'));
+        process.chdir(tempDir);
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        stderrSpy = jest.spyOn(process.stderr, 'write').mockImplementation(() => true);
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+        stderrSpy.mockRestore();
+        process.chdir(originalCwd);
+        fs.rmSync(tempDir, { recursive: true, force: true });
+    });
+    it('transpiles a .ts file to a sibling .js file', async () => {
+        const tsPath = path.join(tempDir, 'mapping.ts');
+        fs.writeFileSync(tsPath, `export const mapping = { orgName: 'acme' };\n`, 'utf8');
+        await (0, compile_1.runCompile)('mapping.ts');
+        const jsPath = path.join(tempDir, 'mapping.js');
+        expect(fs.existsSync(jsPath)).toBe(true);
+        const js = fs.readFileSync(jsPath, 'utf8');
+        expect(js).toContain('exports.mapping');
+        expect(js).toContain("orgName: 'acme'");
+    });
+    it('resolves the input path relative to cwd', async () => {
+        const subdir = path.join(tempDir, 'nested');
+        fs.mkdirSync(subdir);
+        const tsPath = path.join(subdir, 'm.ts');
+        fs.writeFileSync(tsPath, 'export const x = 1;\n', 'utf8');
+        await (0, compile_1.runCompile)('nested/m.ts');
+        expect(fs.existsSync(path.join(subdir, 'm.js'))).toBe(true);
+    });
+    it('throws when the input file does not exist', async () => {
+        await expect((0, compile_1.runCompile)('nope.ts')).rejects.toThrow(/File not found/);
+    });
+    it('throws when the input is not a .ts file', async () => {
+        const jsPath = path.join(tempDir, 'mapping.js');
+        fs.writeFileSync(jsPath, 'module.exports = {};', 'utf8');
+        await expect((0, compile_1.runCompile)('mapping.js')).rejects.toThrow(/Expected a \.ts file/);
+    });
+    it('throws on a TypeScript syntax error', async () => {
+        const tsPath = path.join(tempDir, 'broken.ts');
+        fs.writeFileSync(tsPath, 'export const = ;\n', 'utf8');
+        await expect((0, compile_1.runCompile)('broken.ts')).rejects.toThrow(/Compile failed/);
+        expect(fs.existsSync(path.join(tempDir, 'broken.js'))).toBe(false);
+    });
+});

package/lib/cli/commands/create.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,78 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = __importStar(require("fs"));
+const os = __importStar(require("os"));
+const path = __importStar(require("path"));
+let nextAnswer = '';
+jest.mock('readline', () => ({
+    createInterface: () => ({
+        question: (_q, cb) => cb(nextAnswer),
+        close: () => { },
+    }),
+}));
+const create_1 = require("./create");
+describe('runCreate', () => {
+    let tempDir;
+    let originalCwd;
+    let logSpy;
+    beforeEach(() => {
+        originalCwd = process.cwd();
+        tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'flexplm-create-'));
+        process.chdir(tempDir);
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        nextAnswer = '';
+    });
+    afterEach(() => {
+        logSpy.mockRestore();
+        process.chdir(originalCwd);
+        fs.rmSync(tempDir, { recursive: true, force: true });
+    });
+    it('writes <orgName>-transformMapping.ts with the placeholder replaced', async () => {
+        nextAnswer = 'acme';
+        await (0, create_1.runCreate)();
+        const outPath = path.join(tempDir, 'acme-transformMapping.ts');
+        expect(fs.existsSync(outPath)).toBe(true);
+        const contents = fs.readFileSync(outPath, 'utf8');
+        expect(contents).toContain("orgName: 'acme'");
+        expect(contents).not.toContain('<ORG_NAME>');
+    });
+    it('trims whitespace around the orgName input', async () => {
+        nextAnswer = '  acme  ';
+        await (0, create_1.runCreate)();
+        expect(fs.existsSync(path.join(tempDir, 'acme-transformMapping.ts'))).toBe(true);
+    });
+    it('throws when orgName is empty', async () => {
+        nextAnswer = '   ';
+        await expect((0, create_1.runCreate)()).rejects.toThrow(/orgName is required/);
+    });
+    it('refuses to overwrite an existing file', async () => {
+        const existing = path.join(tempDir, 'acme-transformMapping.ts');
+        fs.writeFileSync(existing, 'do not clobber', 'utf8');
+        nextAnswer = 'acme';
+        await expect((0, create_1.runCreate)()).rejects.toThrow(/Refusing to overwrite/);
+        expect(fs.readFileSync(existing, 'utf8')).toEqual('do not clobber');
+    });
+});

package/lib/cli/commands/upload.d.ts

@@ -1 +1,10 @@
+interface UploadOptions {
+    filePath: string;
+    message?: string;
+    branch?: string;
+    skipGit: boolean;
+}
+export declare function parseUploadArgs(args: string[]): UploadOptions;
+export declare function buildCommitMessage(userMessage: string, fileId: string): string;
 export declare function runUpload(args: string[]): Promise<void>;
+export {};

package/lib/cli/commands/upload.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.runUpload = void 0;
+exports.runUpload = exports.buildCommitMessage = exports.parseUploadArgs = void 0;
 const child_process_1 = require("child_process");
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
@@ -91,6 +91,7 @@ function parseUploadArgs(args) {
     }
     return { filePath, message, branch, skipGit };
 }
+exports.parseUploadArgs = parseUploadArgs;
 function runGit(args, cwd) {
     return (0, child_process_1.execFileSync)('git', args, { cwd, encoding: 'utf8', stdio: ['ignore', 'pipe', 'pipe'] });
 }
@@ -112,8 +113,10 @@ function buildCommitMessage(userMessage, fileId) {
     lines[0] = `${lines[0]} [fileId: ${fileId}]`;
     return lines.join('\n');
 }
+exports.buildCommitMessage = buildCommitMessage;
 async function commitToGit(absPath, fileId, options) {
     const repoDir = path.dirname(absPath);
+    const relPath = path.basename(absPath);
     const versionCheck = tryRunGit(['--version'], repoDir);
     if (!versionCheck.ok) {
         console.log('git command not available; skipping git commit.');
@@ -124,9 +127,9 @@ async function commitToGit(absPath, fileId, options) {
         console.log(`Not inside a git working tree (${repoDir}); skipping git commit.`);
         return;
     }
-    const tracked = tryRunGit(['ls-files', '--error-unmatch', absPath], repoDir);
+    const tracked = tryRunGit(['ls-files', '--error-unmatch', relPath], repoDir);
     if (!tracked.ok) {
-        const answer = (await prompt(`File is not tracked by git: ${absPath}\nAdd it to git? (y/N): `)).toLowerCase();
+        const answer = (await prompt(`File is not tracked by git: ${relPath}\nAdd it to git? (y/N): `)).toLowerCase();
         if (answer !== 'y' && answer !== 'yes') {
             console.log('Nothing was done in git.');
             return;
@@ -147,11 +150,11 @@ async function commitToGit(absPath, fileId, options) {
         }
     }
     const finalMessage = buildCommitMessage(message, fileId);
-    const addResult = tryRunGit(['add', '--', absPath], repoDir);
+    const addResult = tryRunGit(['add', '--', relPath], repoDir);
     if (!addResult.ok) {
         throw new Error(`git add failed: ${addResult.stderr.trim()}`);
     }
-    const commitResult = tryRunGit(['commit', '-m', finalMessage, '--', absPath], repoDir);
+    const commitResult = tryRunGit(['commit', '-m', finalMessage, '--', relPath], repoDir);
     if (!commitResult.ok) {
         throw new Error(`git commit failed: ${commitResult.stderr.trim() || commitResult.stdout.trim()}`);
     }

package/lib/cli/commands/upload.spec.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('@contrail/sdk', () => ({
+    Entities: jest.fn(),
+    Files: jest.fn(),
+    login: jest.fn(),
+}));
+const upload_1 = require("./upload");
+describe('parseUploadArgs', () => {
+    it('parses a bare file path', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js']);
+        expect(opts).toEqual({
+            filePath: 'mapping.js',
+            message: undefined,
+            branch: undefined,
+            skipGit: false,
+        });
+    });
+    it('parses -m commit message option', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js', '-m', 'my message']);
+        expect(opts.message).toEqual('my message');
+        expect(opts.skipGit).toBe(false);
+    });
+    it('parses -b branch option', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js', '-b', 'feature/x']);
+        expect(opts.branch).toEqual('feature/x');
+    });
+    it('parses --skip-git flag', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js', '--skip-git']);
+        expect(opts.skipGit).toBe(true);
+    });
+    it('accepts the legacy --skipGit alias', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js', '--skipGit']);
+        expect(opts.skipGit).toBe(true);
+    });
+    it('parses options before the file path', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['-m', 'msg', '-b', 'br', 'mapping.js']);
+        expect(opts).toEqual({
+            filePath: 'mapping.js',
+            message: 'msg',
+            branch: 'br',
+            skipGit: false,
+        });
+    });
+    it('parses all options together', () => {
+        const opts = (0, upload_1.parseUploadArgs)(['mapping.js', '-m', 'msg', '-b', 'br', '--skip-git']);
+        expect(opts).toEqual({
+            filePath: 'mapping.js',
+            message: 'msg',
+            branch: 'br',
+            skipGit: true,
+        });
+    });
+    it('throws when -m is missing its value', () => {
+        expect(() => (0, upload_1.parseUploadArgs)(['mapping.js', '-m'])).toThrow(/-m requires a commit message/);
+    });
+    it('throws when -b is missing its value', () => {
+        expect(() => (0, upload_1.parseUploadArgs)(['mapping.js', '-b'])).toThrow(/-b requires a branch name/);
+    });
+    it('throws on unknown option', () => {
+        expect(() => (0, upload_1.parseUploadArgs)(['mapping.js', '--bogus'])).toThrow(/Unknown option: --bogus/);
+    });
+    it('throws when an extra positional argument is supplied', () => {
+        expect(() => (0, upload_1.parseUploadArgs)(['mapping.js', 'extra.js'])).toThrow(/Unexpected argument: extra\.js/);
+    });
+    it('throws when no file path is provided', () => {
+        expect(() => (0, upload_1.parseUploadArgs)([])).toThrow(/missing <path\.js>/);
+    });
+    it('throws when only options are provided', () => {
+        expect(() => (0, upload_1.parseUploadArgs)(['--skip-git'])).toThrow(/missing <path\.js>/);
+    });
+});
+describe('buildCommitMessage', () => {
+    it('appends fileId to the first line of a single-line message', () => {
+        expect((0, upload_1.buildCommitMessage)('initial commit', 'abc123')).toEqual('initial commit [fileId: abc123]');
+    });
+    it('only appends fileId to the first line of a multi-line message', () => {
+        const result = (0, upload_1.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 = (0, upload_1.buildCommitMessage)('header\r\nbody', 'fid');
+        expect(result).toEqual('header [fileId: fid]\nbody');
+    });
+    it('handles an empty message', () => {
+        expect((0, upload_1.buildCommitMessage)('', 'fid')).toEqual(' [fileId: fid]');
+    });
+});

package/lib/cli/index.d.ts

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-export {};
+export declare function main(): Promise<void>;

package/lib/cli/index.js

@@ -1,6 +1,7 @@
 #!/usr/bin/env node
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.main = void 0;
 const create_1 = require("./commands/create");
 const compile_1 = require("./commands/compile");
 const upload_1 = require("./commands/upload");
@@ -54,7 +55,10 @@ async function main() {
             process.exit(1);
     }
 }
-main().catch((err) => {
-    console.error(err && err.message ? err.message : err);
-    process.exit(1);
-});
+exports.main = main;
+if (require.main === module) {
+    main().catch((err) => {
+        console.error(err && err.message ? err.message : err);
+        process.exit(1);
+    });
+}

package/lib/cli/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/cli/index.spec.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+jest.mock('./commands/create', () => ({ runCreate: jest.fn().mockResolvedValue(undefined) }));
+jest.mock('./commands/compile', () => ({ runCompile: jest.fn().mockResolvedValue(undefined) }));
+jest.mock('./commands/upload', () => ({ runUpload: jest.fn().mockResolvedValue(undefined) }));
+const create_1 = require("./commands/create");
+const compile_1 = require("./commands/compile");
+const upload_1 = require("./commands/upload");
+const index_1 = require("./index");
+describe('cli main dispatcher', () => {
+    let originalArgv;
+    let logSpy;
+    let errorSpy;
+    let exitSpy;
+    beforeEach(() => {
+        originalArgv = process.argv;
+        create_1.runCreate.mockClear();
+        compile_1.runCompile.mockClear();
+        upload_1.runUpload.mockClear();
+        logSpy = jest.spyOn(console, 'log').mockImplementation(() => { });
+        errorSpy = jest.spyOn(console, 'error').mockImplementation(() => { });
+        exitSpy = jest.spyOn(process, 'exit').mockImplementation(((code) => {
+            throw new Error(`__EXIT__:${code}`);
+        }));
+    });
+    afterEach(() => {
+        process.argv = originalArgv;
+        logSpy.mockRestore();
+        errorSpy.mockRestore();
+        exitSpy.mockRestore();
+    });
+    function setArgv(...args) {
+        process.argv = ['node', 'cli', ...args];
+    }
+    it('dispatches the create command', async () => {
+        setArgv('create');
+        await (0, index_1.main)();
+        expect(create_1.runCreate).toHaveBeenCalledTimes(1);
+        expect(compile_1.runCompile).not.toHaveBeenCalled();
+        expect(upload_1.runUpload).not.toHaveBeenCalled();
+    });
+    it('dispatches the compile command with its argument', async () => {
+        setArgv('compile', 'mapping.ts');
+        await (0, index_1.main)();
+        expect(compile_1.runCompile).toHaveBeenCalledWith('mapping.ts');
+    });
+    it('exits when compile is missing its argument', async () => {
+        setArgv('compile');
+        await expect((0, index_1.main)()).rejects.toThrow('__EXIT__:1');
+        expect(compile_1.runCompile).not.toHaveBeenCalled();
+        expect(errorSpy).toHaveBeenCalledWith(expect.stringMatching(/missing <path\.ts>/));
+    });
+    it('dispatches the upload command and forwards remaining args', async () => {
+        setArgv('upload', 'mapping.js', '-m', 'msg', '--skip-git');
+        await (0, index_1.main)();
+        expect(upload_1.runUpload).toHaveBeenCalledWith(['mapping.js', '-m', 'msg', '--skip-git']);
+    });
+    it('exits when upload is missing its argument', async () => {
+        setArgv('upload');
+        await expect((0, index_1.main)()).rejects.toThrow('__EXIT__:1');
+        expect(upload_1.runUpload).not.toHaveBeenCalled();
+        expect(errorSpy).toHaveBeenCalledWith(expect.stringMatching(/missing <path\.js>/));
+    });
+    it.each(['help', '-h', '--help'])('prints usage for %s', async (helpFlag) => {
+        setArgv(helpFlag);
+        await (0, index_1.main)();
+        expect(logSpy).toHaveBeenCalledWith(expect.stringMatching(/Usage: flexplm-mapping/));
+    });
+    it('prints usage when no command is provided', async () => {
+        setArgv();
+        await (0, index_1.main)();
+        expect(logSpy).toHaveBeenCalledWith(expect.stringMatching(/Usage: flexplm-mapping/));
+    });
+    it('exits on an unknown command', async () => {
+        setArgv('bogus');
+        await expect((0, index_1.main)()).rejects.toThrow('__EXIT__:1');
+        expect(errorSpy).toHaveBeenCalledWith(expect.stringMatching(/Unknown command: bogus/));
+    });
+});

package/lib/interfaces/mapping-file.d.ts

@@ -71,7 +71,7 @@ export interface DirectionalSection {
      * (flex2vibe) for a row when it cannot be derived from the row itself.
      *
      * Consulted by `TypeConversionUtils.getObjectTypePath` /
-     * `getEntityTypePathFromOjbect` after the explicit `flexPLMTypePath` /
+     * `getEntityTypePathFromObject` after the explicit `flexPLMTypePath` /
      * `vibeIQTypePath` property and before the `TypeDefaults` fallback.
      *
      * @example
@@ -95,7 +95,7 @@ export interface DirectionalSection {
      *   custStyleNumber: 'styleNumber',
      * }
      */
-    rekey?: Record<string, unknown>;
+    rekey?: RekeyTransformers;
     /**
      * Lookup table consumed by REMOVE tasks in {@link DirectionalSection.transformOrder}.
      *

package/lib/util/type-conversion-utils.d.ts

@@ -92,6 +92,7 @@ export declare class TypeConversionUtils {
      * @returns Promise<string>
      */
     static getEntityClassFromObject(fileId: any, mapFileUtil: any, object: any): Promise<string>;
+    static getEntityTypePathFromOjbect(fileId: any, mapFileUtil: any, object: any): Promise<string>;
     /** Takes in a FlexPLM object and returns the correct VibeIQ
    * type associated to the object. Order of precedence
    * Property 'vibeIQTypePath'
@@ -104,7 +105,7 @@ export declare class TypeConversionUtils {
    * @param entity VibeIQ entity
    * @returns Promise<string>
    */
-    static getEntityTypePathFromOjbect(fileId: any, mapFileUtil: any, object: any): Promise<string>;
+    static getEntityTypePathFromObject(fileId: any, mapFileUtil: any, object: any): Promise<string>;
     /**Takes in a FlexPLM object and returns the correct
    * identifier properties.  Order of precedence
    * Property 'vibeIQIdentifierProperties'

package/lib/util/type-conversion-utils.js

@@ -199,6 +199,9 @@ class TypeConversionUtils {
         }
         return type_defaults_1.TypeDefaults.getDefaultEntityClass(object);
     }
+    static async getEntityTypePathFromOjbect(fileId, mapFileUtil, object) {
+        return await this.getEntityTypePathFromObject(fileId, mapFileUtil, object);
+    }
     /** Takes in a FlexPLM object and returns the correct VibeIQ
    * type associated to the object. Order of precedence
    * Property 'vibeIQTypePath'
@@ -211,7 +214,7 @@ class TypeConversionUtils {
    * @param entity VibeIQ entity
    * @returns Promise<string>
    */
-    static async getEntityTypePathFromOjbect(fileId, mapFileUtil, object) {
+    static async getEntityTypePathFromObject(fileId, mapFileUtil, object) {
         let typePath = object['vibeIQTypePath'];
         if (typePath) {
             return typePath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contrail/flexplm",
-  "version": "1.3.1-alpha.7db7b62",
+  "version": "1.3.1-alpha.97cfe70",
   "description": "Library used for integration with flexplm.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -55,9 +55,9 @@
     "testEnvironment": "node"
   },
   "dependencies": {
-    "@contrail/app-framework": "^2.0.0",
+    "@contrail/app-framework": "^1.4.3",
     "@contrail/sdk": "^1.5.10",
-    "@contrail/transform-data": "^1.3.2-alpha.fd132c3",
+    "@contrail/transform-data": "^1.3.2-alpha.40a88b2",
     "@contrail/util": "^1.3.1",
     "axios": "^1.4.0",
     "p-limit": "^3.1.0"