@vertexvis/plm-cli 0.1.3

package/lib/lib/tree/tree-node.js

@@ -0,0 +1,150 @@
+"use strict";
+// tree-node.ts
+// USAGE EXAMPLE:
+// import { TreeNode } from './tree-node'
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeNode = void 0;
+// const root = new TreeNode<string>('root')
+// const a = new TreeNode('child A', root)
+// new TreeNode('grandchild A1', a)
+// new TreeNode('child B', root)
+// console.log(root.size)       // 4
+// console.log(root.depth)      // 0
+// console.log(a.depth)         // 1
+// console.log(root.contains('A1'))  // true
+// for (const node of root) {
+//   console.log(node.data)
+// }
+// console.log(root.dump())
+/**
+ * A simple tree node class that can be used to create a tree structure.
+ * Each node can have multiple children and a single parent.
+ * The class provides methods to traverse the tree, check properties of nodes,
+ * and manipulate the tree structure.
+ *
+ * @template T The type of the data stored in the node.
+ * @class TreeNode
+ */
+class TreeNode {
+    constructor(data = null, parent) {
+        this.parent = null;
+        this.children = [];
+        this.data = data;
+        if (parent) {
+            this.parent = parent;
+            parent.children.push(this);
+        }
+    }
+    /** Pre-order traversal generator
+     * @param {TreeNode<U>} node - The node to start traversal from.
+     * @returns {Generator<TreeNode<U>>} A generator yielding nodes in pre-order.
+     */
+    static *preorder(node) {
+        yield node;
+        for (const child of node.children) {
+            yield* TreeNode.preorder(child);
+        }
+    }
+    /** Total number of nodes in this subtree (includes this node) */
+    get size() {
+        let count = 1;
+        for (const child of this.children) {
+            count += child.size;
+        }
+        return count;
+    }
+    isRoot() {
+        return this.parent === null;
+    }
+    isLeaf() {
+        return this.children.length === 0;
+    }
+    hasChildren() {
+        return this.children.length > 0;
+    }
+    hasSiblings() {
+        return this.parent !== null && this.parent.children.length > 1;
+    }
+    isEmpty() {
+        return this.children.length === 0;
+    }
+    /** Distance from this node up to the root (root.depth === 0) */
+    get depth() {
+        let d = 0;
+        let current = this.parent;
+        while (current !== null) {
+            d++;
+            current = current.parent;
+        }
+        return d;
+    }
+    /** Number of direct children */
+    get numChildren() {
+        return this.children.length;
+    }
+    /** Number of siblings (including this node) */
+    get numSiblings() {
+        return this.parent ? this.parent.children.length : 0;
+    }
+    /** Allow `for (const n of someNode) { … }`
+     * @returns {Iterator<TreeNode<T>>} An iterator over nodes in pre-order.
+     */
+    [Symbol.iterator]() {
+        return TreeNode.preorder(this);
+    }
+    /** True if any node in this subtree holds `obj` (by `===`)
+     * @param {T} obj - The object to search for.
+     * @returns {boolean} True if found, false otherwise.
+     */
+    contains(obj) {
+        for (const node of this) {
+            if (node.data === obj)
+                return true;
+        }
+        return false;
+    }
+    /** Remove all descendants (but not this node itself)
+     * @returns {void}
+     */
+    clear() {
+        for (const child of this.children) {
+            child.clear();
+        }
+        this.children = [];
+    }
+    /** Grab the data payload in pre-order as a flat array
+     * @returns {(T | null)[]} Array of data values in pre-order.
+     */
+    toArray() {
+        const out = [];
+        for (const node of TreeNode.preorder(this)) {
+            out.push(node.data);
+        }
+        return out;
+    }
+    /** Returns a string representation of this node
+     * @returns {string} String representation of the node.
+     */
+    toString({ node, data, } = {}) {
+        const role = this.isRoot() ? '(root)' : '';
+        const childInfo = this.isLeaf()
+            ? '(leaf)'
+            : `has ${this.children.length.toString()} child node${this.children.length === 1 ? '' : 's'}`;
+        return node
+            ? node(this)
+            : `[TreeNode ${role} ${childInfo}, data=[${data ? data(this.data) : JSON.stringify(this.data).slice(0, 160)}]]`;
+    }
+    /** Human-readable dump with ASCII-tree lines
+     * @returns {string} A multi-line string representation of the tree.
+     */
+    dump({ node, data, } = {}) {
+        let result = '';
+        for (const treeNode of TreeNode.preorder(this)) {
+            const d = treeNode.depth;
+            const prefix = d > 0 ? '│   '.repeat(d - 1) + '└── ' : '';
+            result += prefix + treeNode.toString({ node, data }) + '\n';
+        }
+        return result;
+    }
+}
+exports.TreeNode = TreeNode;

package/lib/lib/vertex-api/client.d.ts

@@ -0,0 +1,2 @@
+import { VertexClient } from '@vertexvis/api-client-node';
+export declare function getClient(): Promise<VertexClient>;

package/lib/lib/vertex-api/client.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getClient = void 0;
+const api_client_node_1 = require("@vertexvis/api-client-node");
+let clientPromise;
+function buildClient() {
+    if (!process.env.VERTEX_CLIENT_ID ||
+        !process.env.VERTEX_CLIENT_SECRET ||
+        !process.env.VERTEX_API_HOST) {
+        throw new Error('VERTEX_CLIENT_ID, VERTEX_CLIENT_SECRET, and VERTEX_API_HOST must be set in configuration or environment variables');
+    }
+    return api_client_node_1.VertexClient.build({
+        basePath: process.env.VERTEX_API_HOST,
+        client: {
+            id: process.env.VERTEX_CLIENT_ID,
+            secret: process.env.VERTEX_CLIENT_SECRET,
+        },
+    });
+}
+function getClient() {
+    if (clientPromise === undefined) {
+        clientPromise = buildClient();
+    }
+    return clientPromise;
+}
+exports.getClient = getClient;

package/lib/lib/vertex-api/get-part-revision-instance-tree.d.ts

@@ -0,0 +1,10 @@
+import { PartData, PartRevisionData, PartRevisionInstanceData, VertexClient } from '@vertexvis/api-client-node';
+import { TreeNode } from '../tree/tree-node';
+interface PartAndPartRevision {
+    part: PartData;
+    partRevision: PartRevisionData;
+}
+export declare function fetchPartRevisionInstanceTree(partRevisionId: string): Promise<TreeNode<PartRevisionInstanceData>>;
+export declare function getUniquePartRevisionsForInstanceTree(partRevisionId: string): Promise<Array<PartAndPartRevision>>;
+export declare function fetchPartRevisionInstances(client: VertexClient, partRevisionId: string): Promise<Array<PartRevisionInstanceData>>;
+export {};

package/lib/lib/vertex-api/get-part-revision-instance-tree.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchPartRevisionInstances = exports.getUniquePartRevisionsForInstanceTree = exports.fetchPartRevisionInstanceTree = void 0;
+const tslib_1 = require("tslib");
+const p_limit_1 = (0, tslib_1.__importDefault)(require("p-limit"));
+const tree_node_1 = require("../tree/tree-node");
+const client_1 = require("./client");
+const API_LIMIT = process.env.VERTEX_API_LIMIT
+    ? parseInt(process.env.VERTEX_API_LIMIT, 10)
+    : 20;
+const limit = (0, p_limit_1.default)(API_LIMIT);
+async function fetchPartRevisionInstanceTree(partRevisionId) {
+    const rootNode = new tree_node_1.TreeNode({
+        id: partRevisionId,
+        type: 'part-revision',
+        attributes: {},
+        relationships: {
+            partRevision: { data: { id: partRevisionId, type: 'part-revision' } },
+        },
+    });
+    const client = await (0, client_1.getClient)();
+    const partRevisionInstanceCache = new Map();
+    await addInstanceChildrenRecursively(client, rootNode, partRevisionInstanceCache);
+    // console.log(`Found total of ${partRevisionInstanceCache.size} unique part revisions in the instance tree.`);
+    // console.log(`${[...partRevisionInstanceCache.entries()].map(([k,v]) => `Part Revision ID: ${k}, Instance Count: ${v.length}`).join('\n')}`);
+    // console.log(JSON.stringify([...partRevisionInstanceCache.entries()], null, 2));
+    return rootNode;
+}
+exports.fetchPartRevisionInstanceTree = fetchPartRevisionInstanceTree;
+async function getUniquePartRevisionsForInstanceTree(partRevisionId) {
+    const rootNode = new tree_node_1.TreeNode({
+        id: partRevisionId,
+        type: 'part-revision',
+        attributes: {},
+        relationships: {
+            partRevision: { data: { id: partRevisionId, type: 'part-revision' } },
+        },
+    });
+    const client = await (0, client_1.getClient)();
+    const partRevisionInstanceCache = new Map();
+    await addInstanceChildrenRecursively(client, rootNode, partRevisionInstanceCache);
+    const uniquePartRevisions = [...partRevisionInstanceCache.keys()];
+    const results = await Promise.all(uniquePartRevisions.map(async (prId) => {
+        const partRevision = await limit(() => client.partRevisions.getPartRevision({
+            id: prId,
+            fieldsPartRevision: 'suppliedId,created,metadata',
+        }));
+        if (partRevision.data.data === null ||
+            partRevision.data.data === undefined) {
+            console.warn(`Part Revision ID: ${prId} not found when fetching unique part revisions.`);
+            return undefined;
+        }
+        const partRelationship = partRevision.data.data.relationships.part;
+        if (partRelationship === null || partRelationship === undefined) {
+            console.warn(`Part relationship not found for part revision ${prId}.`);
+            return undefined;
+        }
+        const part = await client.parts.getPart({ id: partRelationship.id });
+        return {
+            partRevision: partRevision.data.data,
+            part: part.data.data,
+        };
+    }));
+    // console.log(`Fetched total of ${results.length} unique part revisions in the instance tree.`);
+    // console.log(JSON.stringify(results, null, 2));
+    return results.filter((r) => r !== undefined);
+}
+exports.getUniquePartRevisionsForInstanceTree = getUniquePartRevisionsForInstanceTree;
+async function addInstanceChildrenRecursively(client, node, partRevisionInstanceCache) {
+    var _a, _b, _c;
+    if (!((_c = (_b = (_a = node.data) === null || _a === void 0 ? void 0 : _a.relationships.partRevision) === null || _b === void 0 ? void 0 : _b.data) === null || _c === void 0 ? void 0 : _c.id)) {
+        console.warn(`Node [${node.toString()}] does not have a part revision relationship. Skipping children fetch.`);
+        return;
+    }
+    const partRevisionId = node.data.relationships.partRevision.data.id;
+    let instances = partRevisionInstanceCache.get(partRevisionId);
+    if (instances === null || instances === undefined) {
+        instances = await fetchPartRevisionInstances(client, partRevisionId);
+        partRevisionInstanceCache.set(partRevisionId, instances);
+    }
+    await Promise.allSettled(instances.map(async (instance) => {
+        const childNode = new tree_node_1.TreeNode(instance);
+        node.children.push(childNode);
+        childNode.parent = node;
+        await addInstanceChildrenRecursively(client, childNode, partRevisionInstanceCache);
+    }));
+}
+async function fetchPartRevisionInstances(client, partRevisionId) {
+    // Fetch the whole instance tree for a given part revision from the platform APIs
+    // console.log(`Fetching instance tree for Part Revision ID: ${partRevisionId}`);
+    const instanceTreeResponse = await limit(() => client.partRevisionInstances.getPartRevisionInstanceList({
+        filterParent: partRevisionId,
+    }));
+    // console.log(`Fetched ${instanceTreeResponse.data.data.length} instance tree items.`);
+    return instanceTreeResponse.data.data.sort((a, b) => { var _a, _b; return ((_a = a.attributes.ordinal) !== null && _a !== void 0 ? _a : 0) - ((_b = b.attributes.ordinal) !== null && _b !== void 0 ? _b : 0); });
+}
+exports.fetchPartRevisionInstances = fetchPartRevisionInstances;

package/lib/lib/vertex-api/index.d.ts

@@ -0,0 +1,2 @@
+export * from './client';
+export * from './get-part-revision-instance-tree';

package/lib/lib/vertex-api/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./client"), exports);
+(0, tslib_1.__exportStar)(require("./get-part-revision-instance-tree"), exports);

package/oclif.manifest.json

@@ -0,0 +1 @@
+{"version":"0.1.3","commands":{"configure":{"id":"configure","description":"Manage config at /home/runner/.vertex-plm/config.json (env vars override config at runtime)","pluginName":"@vertexvis/plm-cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false},"VERTEX_CLIENT_ID":{"name":"VERTEX_CLIENT_ID","type":"option","description":"Vertex client id"},"VERTEX_CLIENT_SECRET":{"name":"VERTEX_CLIENT_SECRET","type":"option","description":"Vertex client secret"},"VERTEX_API_HOST":{"name":"VERTEX_API_HOST","type":"option","description":"Vertex API host (e.g. https://api.example.com)"},"VERTEX_PLM_HOST":{"name":"VERTEX_PLM_HOST","type":"option","description":"Vertex PLM host (e.g. https://plm.example.com)"},"VERTEX_PLM_API_KEY":{"name":"VERTEX_PLM_API_KEY","type":"option","description":"Vertex PLM API key"},"interactive":{"name":"interactive","type":"boolean","description":"Prompt for missing values (leave blank to keep current)","allowNo":false},"unset":{"name":"unset","type":"option","description":"Unset one or more config keys"},"reset":{"name":"reset","type":"boolean","description":"Delete config file and reset all values","allowNo":false},"show":{"name":"show","type":"boolean","description":"Show current config (secrets redacted)","allowNo":false}},"args":[]},"set-overwrite":{"id":"set-overwrite","description":"Set overwrite flag for a given part revision","pluginName":"@vertexvis/plm-cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"plmPartId","description":"PLM part ID (string)","required":true},{"name":"plmRevisionId","description":"PLM revision ID (string)","required":true},{"name":"plmIterationId","description":"PLM iteration ID (string, optional)","required":false}]},"view-part-jobs":{"id":"view-part-jobs","description":"View PLM kernel jobs for a given part revision","pluginName":"@vertexvis/plm-cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"plmPartId","description":"PLM part ID (string)","required":true},{"name":"plmRevisionId","description":"PLM revision ID (string)","required":true},{"name":"plmIterationId","description":"PLM iteration ID (string, optional)","required":false}]},"view-part-structure":{"id":"view-part-structure","description":"View structure for a given part revision","pluginName":"@vertexvis/plm-cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"plmPartId","description":"PLM part ID (string)","required":true},{"name":"plmRevisionId","description":"PLM revision ID (string)","required":true},{"name":"plmIterationId","description":"PLM iteration ID (string, optional)","required":false}]},"view-part":{"id":"view-part","description":"Find a registered part revision","pluginName":"@vertexvis/plm-cli","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help","allowNo":false}},"args":[{"name":"plmPartId","description":"PLM part ID (string)","required":true},{"name":"plmRevisionId","description":"PLM revision ID (string)","required":true},{"name":"plmIterationId","description":"PLM iteration ID (string, optional)","required":false}]}}}

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@vertexvis/plm-cli",
+  "version": "0.1.3",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "bin": {
+    "vertex-plm": "./bin/run"
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e",
+  "engines": {
+    "node": ">=16.0.0"
+  },
+  "files": [
+    "/bin",
+    "/lib",
+    "/oclif.manifest.json"
+  ],
+  "oclif": {
+    "commands": "./lib/commands",
+    "bin": "vertex-plm",
+    "plugins": [
+      "@oclif/plugin-help"
+    ]
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rm -rf coverage lib && rm -f oclif.manifest.json",
+    "format": "prettier --write './**/*.+(js|jsx|ts|tsx|json|yml|yaml|md|mdx|html|css)'",
+    "lint": "eslint . --ext .ts",
+    "postpack": "rm -f oclif.manifest.json",
+    "pre-commit": "yarn lint && yarn format",
+    "prepack": "yarn clean && yarn build && oclif-dev manifest",
+    "setup": "yarn",
+    "test": "TS_NODE_PROJECT=test/tsconfig.json nyc mocha",
+    "version": "git add package.json"
+  },
+  "dependencies": {
+    "@oclif/command": "^1",
+    "@oclif/config": "^1.18.9",
+    "@oclif/plugin-help": "^3.3.1",
+    "@vertexvis/api-client-node": "^0.40.0",
+    "cli-ux": "^5.6.7",
+    "p-limit": "^3.1",
+    "tslib": "2.8.1"
+  },
+  "devDependencies": {
+    "@istanbuljs/nyc-config-typescript": "^1.0",
+    "@oclif/dev-cli": "^1",
+    "@oclif/parser": "^3.8",
+    "@oclif/test": "^1.2",
+    "@types/chai": "^4.3",
+    "@types/mocha": "^9",
+    "@types/node": "~16.11.26",
+    "@vertexvis/eslint-config-vertexvis-typescript": "0.4",
+    "chai": "^4.3",
+    "eslint": "^7",
+    "eslint-config-oclif": "3.1.0",
+    "eslint-config-oclif-typescript": "^1.0",
+    "eslint-plugin-promise": "^5.2",
+    "eslint-plugin-simple-import-sort": "^7.0",
+    "mocha": "^9",
+    "nyc": "^15.1",
+    "prettier": "^2.5",
+    "sinon": "^12.0",
+    "source-map-support": "^0.5",
+    "ts-node": "^10.4",
+    "typescript": "4.4.x"
+  }
+}