@vertexvis/plm-cli 0.1.3

package/lib/commands/view-part-jobs.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const args_1 = require("../lib/args");
+const base_1 = (0, tslib_1.__importDefault)(require("../lib/base"));
+const plm_api_1 = require("../lib/plm-api");
+class ViewPartJobs extends base_1.default {
+    async run() {
+        const { args } = this.parse(ViewPartJobs);
+        const ids = (0, args_1.parsePlmIds)({
+            plmPartId: args.plmPartId,
+            plmRevisionId: args.plmRevisionId,
+            plmIterationId: args.plmIterationId,
+        });
+        console.log(`Looking for registered part revision jobs with IDs:\n${JSON.stringify(ids, null, 2)}`);
+        const registeredPart = await (0, plm_api_1.findRegisteredPartRevision)({
+            partId: ids.plmPartId,
+            partRevisionId: ids.plmRevisionId,
+            iterationId: ids.plmIterationId,
+        });
+        if (registeredPart === null) {
+            console.log('Part revision not found in PLM.');
+            return;
+        }
+        console.log('Found registered part revision in PLM:');
+        console.log(JSON.stringify(registeredPart, null, 2));
+        const registeredPartRevisionJobs = await (0, plm_api_1.getRegisteredPartRevisionJobs)({
+            id: registeredPart.id,
+        });
+        if (registeredPartRevisionJobs === null) {
+            console.log('No jobs found for the registered part revision.');
+        }
+        else {
+            console.log('Registered Part Revision Jobs:');
+            console.log(JSON.stringify(registeredPartRevisionJobs, null, 2));
+        }
+    }
+}
+exports.default = ViewPartJobs;
+ViewPartJobs.description = 'View PLM kernel jobs for a given part revision';
+ViewPartJobs.args = [
+    {
+        name: 'plmPartId',
+        required: true,
+        description: 'PLM part ID (string)',
+    },
+    {
+        name: 'plmRevisionId',
+        required: true,
+        description: 'PLM revision ID (string)',
+    },
+    {
+        name: 'plmIterationId',
+        required: false,
+        description: 'PLM iteration ID (string, optional)',
+    },
+];
+ViewPartJobs.flags = Object.assign({}, base_1.default.flags);

package/lib/commands/view-part-structure.d.ts

@@ -0,0 +1,13 @@
+import BaseCommand from '../lib/base';
+export default class ViewPartStructure extends BaseCommand {
+    static description: string;
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+    static flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/view-part-structure.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const args_1 = require("../lib/args");
+const base_1 = (0, tslib_1.__importDefault)(require("../lib/base"));
+const plm_api_1 = require("../lib/plm-api");
+const vertex_api_1 = require("../lib/vertex-api");
+class ViewPartStructure extends base_1.default {
+    async run() {
+        const { args } = this.parse(ViewPartStructure);
+        const ids = (0, args_1.parsePlmIds)({
+            plmPartId: args.plmPartId,
+            plmRevisionId: args.plmRevisionId,
+            plmIterationId: args.plmIterationId,
+        });
+        console.log(`Looking for part revision with IDs:\n${JSON.stringify(ids, null, 2)}`);
+        const registeredPart = await (0, plm_api_1.findRegisteredPartRevision)({
+            partId: ids.plmPartId,
+            partRevisionId: ids.plmRevisionId,
+            iterationId: ids.plmIterationId,
+        });
+        if (registeredPart === null) {
+            console.log('Part revision not found in PLM.');
+            return;
+        }
+        console.log('Found registered part revision in PLM:');
+        console.log(JSON.stringify(registeredPart, null, 2));
+        console.log('Fetching part revision structure data from the platform...');
+        const partStructure = await (0, vertex_api_1.fetchPartRevisionInstanceTree)(registeredPart.vertexPartRevisionId);
+        console.log(`Part Revision Instance Tree [${partStructure.size} node${partStructure.size === 1 ? '' : 's'}]:`);
+        console.log(partStructure.dump());
+    }
+}
+exports.default = ViewPartStructure;
+ViewPartStructure.description = 'View structure for a given part revision';
+ViewPartStructure.args = [
+    {
+        name: 'plmPartId',
+        required: true,
+        description: 'PLM part ID (string)',
+    },
+    {
+        name: 'plmRevisionId',
+        required: true,
+        description: 'PLM revision ID (string)',
+    },
+    {
+        name: 'plmIterationId',
+        required: false,
+        description: 'PLM iteration ID (string, optional)',
+    },
+];
+ViewPartStructure.flags = Object.assign({}, base_1.default.flags);

package/lib/commands/view-part.d.ts

@@ -0,0 +1,13 @@
+import BaseCommand from '../lib/base';
+export default class ViewPart extends BaseCommand {
+    static description: string;
+    static args: {
+        name: string;
+        required: boolean;
+        description: string;
+    }[];
+    static flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+    };
+    run(): Promise<void>;
+}

package/lib/commands/view-part.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const args_1 = require("../lib/args");
+const base_1 = (0, tslib_1.__importDefault)(require("../lib/base"));
+const plm_api_1 = require("../lib/plm-api");
+const vertex_api_1 = require("../lib/vertex-api");
+class ViewPart extends base_1.default {
+    async run() {
+        var _a, _b, _c;
+        const { args } = this.parse(ViewPart);
+        const ids = (0, args_1.parsePlmIds)({
+            plmPartId: args.plmPartId,
+            plmRevisionId: args.plmRevisionId,
+            plmIterationId: args.plmIterationId,
+        });
+        console.log(`Looking for part revision with IDs:\n${JSON.stringify(ids, null, 2)}`);
+        const registeredPart = await (0, plm_api_1.findRegisteredPartRevision)({
+            partId: ids.plmPartId,
+            partRevisionId: ids.plmRevisionId,
+            iterationId: ids.plmIterationId,
+        });
+        const client = await (0, vertex_api_1.getClient)();
+        if (registeredPart === null) {
+            console.log('Part revision not found in PLM Integration Service.');
+            console.log('Checking Vertex Platform for any matching part revisions...');
+            const platformPart = await client.parts.getParts({
+                filterSuppliedId: ids.plmPartId,
+            });
+            if (((_a = platformPart.data) === null || _a === void 0 ? void 0 : _a.data.length) > 0) {
+                const partId = platformPart.data.data[0].id;
+                const partRevs = await client.partRevisions.getPartRevisions({
+                    id: partId,
+                    filterSuppliedId: ids.plmRevisionId,
+                });
+                if (((_b = partRevs.data) === null || _b === void 0 ? void 0 : _b.data.length) > 0) {
+                    console.log('Found matching part revision(s) in Vertex Platform:');
+                    console.log(JSON.stringify(partRevs.data.data, null, 2));
+                }
+                else {
+                    console.log('Part exists in Vertex Platform, but no revisions match the given revision ID.');
+                    console.log('Part details:');
+                    console.log(JSON.stringify(platformPart.data.data[0], null, 2));
+                }
+            }
+        }
+        else {
+            console.log('Found registered part revision in PLM Integration Service:');
+            console.log(JSON.stringify(registeredPart, null, 2));
+            const platformPartRev = await client.partRevisions.getPartRevision({
+                id: registeredPart.vertexPartRevisionId,
+                fieldsPartRevision: 'metadata',
+            });
+            if ((_c = platformPartRev.data) === null || _c === void 0 ? void 0 : _c.data) {
+                console.log('Corresponding Part Revision in Vertex Platform:');
+                console.log(JSON.stringify(platformPartRev.data.data, null, 2));
+            }
+            else {
+                console.log('Corresponding Part Revision not found in Vertex Platform.');
+            }
+        }
+    }
+}
+exports.default = ViewPart;
+ViewPart.description = 'Find a registered part revision';
+ViewPart.args = [
+    {
+        name: 'plmPartId',
+        required: true,
+        description: 'PLM part ID (string)',
+    },
+    {
+        name: 'plmRevisionId',
+        required: true,
+        description: 'PLM revision ID (string)',
+    },
+    {
+        name: 'plmIterationId',
+        required: false,
+        description: 'PLM iteration ID (string, optional)',
+    },
+];
+ViewPart.flags = Object.assign({}, base_1.default.flags);

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { run } from '@oclif/command';

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+var command_1 = require("@oclif/command");
+Object.defineProperty(exports, "run", { enumerable: true, get: function () { return command_1.run; } });

package/lib/lib/args.d.ts

@@ -0,0 +1,11 @@
+export interface PlmIds {
+    plmPartId: string;
+    plmRevisionId: string;
+    plmIterationId?: string;
+}
+export declare function requireNonEmpty(value: unknown, name: string): string;
+export declare function parsePlmIds(opts: {
+    plmPartId: unknown;
+    plmRevisionId: unknown;
+    plmIterationId?: unknown;
+}): PlmIds;

package/lib/lib/args.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePlmIds = exports.requireNonEmpty = void 0;
+function requireNonEmpty(value, name) {
+    if (typeof value !== 'string' || value.trim().length === 0) {
+        throw new Error(`${name} must be a non-empty string`);
+    }
+    return value;
+}
+exports.requireNonEmpty = requireNonEmpty;
+function parsePlmIds(opts) {
+    const plmPartId = requireNonEmpty(opts.plmPartId, 'plm-part-id');
+    const plmRevisionId = requireNonEmpty(opts.plmRevisionId, 'plm-revision-id');
+    const plmIterationIdRaw = opts.plmIterationId;
+    const plmIterationId = typeof plmIterationIdRaw === 'string' && plmIterationIdRaw.trim().length > 0
+        ? plmIterationIdRaw
+        : undefined;
+    return { plmPartId, plmRevisionId, plmIterationId };
+}
+exports.parsePlmIds = parsePlmIds;

package/lib/lib/base.d.ts

@@ -0,0 +1,7 @@
+import { Command } from '@oclif/command';
+export default abstract class BaseCommand extends Command {
+    static readonly flags: {
+        help: import("@oclif/parser/lib/flags").IBooleanFlag<void>;
+    };
+    init(): Promise<void>;
+}

package/lib/lib/base.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@oclif/command");
+const config_1 = require("./config");
+class BaseCommand extends command_1.Command {
+    async init() {
+        await (0, config_1.loadConfigToEnv)();
+    }
+}
+exports.default = BaseCommand;
+BaseCommand.flags = {
+    help: command_1.flags.help({ char: 'h' }),
+};

package/lib/lib/config.d.ts

@@ -0,0 +1,15 @@
+export declare type VertexConfig = Partial<{
+    VERTEX_CLIENT_ID: string;
+    VERTEX_CLIENT_SECRET: string;
+    VERTEX_API_HOST: string;
+    VERTEX_PLM_HOST: string;
+    VERTEX_PLM_API_KEY: string;
+}>;
+export declare function getConfigPath(): string;
+export declare function readConfig(): Promise<VertexConfig>;
+export declare function writeConfig(config: VertexConfig): Promise<void>;
+export declare function deleteConfigFile(): Promise<void>;
+export declare function loadConfigToEnv(): Promise<VertexConfig>;
+export declare function redactConfig(cfg: VertexConfig): VertexConfig;
+export declare const CONFIG_KEYS: readonly ["VERTEX_CLIENT_ID", "VERTEX_CLIENT_SECRET", "VERTEX_API_HOST", "VERTEX_PLM_HOST", "VERTEX_PLM_API_KEY"];
+export declare type ConfigKey = (typeof CONFIG_KEYS)[number];

package/lib/lib/config.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CONFIG_KEYS = exports.redactConfig = exports.loadConfigToEnv = exports.deleteConfigFile = exports.writeConfig = exports.readConfig = exports.getConfigPath = void 0;
+const tslib_1 = require("tslib");
+const promises_1 = require("node:fs/promises");
+const node_os_1 = (0, tslib_1.__importDefault)(require("node:os"));
+const node_path_1 = require("node:path");
+const CONFIG_DIR = (0, node_path_1.join)(node_os_1.default.homedir(), '.vertex-plm');
+const CONFIG_FILE = (0, node_path_1.join)(CONFIG_DIR, 'config.json');
+function getConfigPath() {
+    return CONFIG_FILE;
+}
+exports.getConfigPath = getConfigPath;
+async function readConfig() {
+    try {
+        const raw = await (0, promises_1.readFile)(CONFIG_FILE, 'utf8');
+        const parsed = JSON.parse(raw);
+        return parsed && typeof parsed === 'object' ? parsed : {};
+    }
+    catch (_a) {
+        return {};
+    }
+}
+exports.readConfig = readConfig;
+async function writeConfig(config) {
+    await (0, promises_1.mkdir)(CONFIG_DIR, { recursive: true });
+    await (0, promises_1.writeFile)(CONFIG_FILE, JSON.stringify(config, null, 2) + '\n', 'utf8');
+}
+exports.writeConfig = writeConfig;
+async function deleteConfigFile() {
+    // rm with force avoids throwing if file doesn't exist
+    await (0, promises_1.rm)(CONFIG_FILE, { force: true });
+}
+exports.deleteConfigFile = deleteConfigFile;
+async function loadConfigToEnv() {
+    const cfg = await readConfig();
+    for (const [k, v] of Object.entries(cfg)) {
+        if (typeof v !== 'string' || v.trim() === '')
+            continue;
+        if (process.env[k] === null ||
+            process.env[k] === undefined ||
+            process.env[k] === '') {
+            process.env[k] = v;
+        }
+    }
+    return cfg;
+}
+exports.loadConfigToEnv = loadConfigToEnv;
+function redactConfig(cfg) {
+    return Object.assign(Object.assign(Object.assign({}, cfg), (cfg.VERTEX_CLIENT_SECRET ? { VERTEX_CLIENT_SECRET: '********' } : {})), (cfg.VERTEX_PLM_API_KEY ? { VERTEX_PLM_API_KEY: '********' } : {}));
+}
+exports.redactConfig = redactConfig;
+exports.CONFIG_KEYS = [
+    'VERTEX_CLIENT_ID',
+    'VERTEX_CLIENT_SECRET',
+    'VERTEX_API_HOST',
+    'VERTEX_PLM_HOST',
+    'VERTEX_PLM_API_KEY',
+];

package/lib/lib/plm-api/find-registered-part-revision.d.ts

@@ -0,0 +1,6 @@
+import { RegisteredPartRevision } from './plm-api';
+export declare function findRegisteredPartRevision({ partId, partRevisionId, iterationId, }: {
+    partId: string;
+    partRevisionId: string;
+    iterationId?: string;
+}): Promise<RegisteredPartRevision | null>;

package/lib/lib/plm-api/find-registered-part-revision.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findRegisteredPartRevision = void 0;
+const plm_api_1 = require("./plm-api");
+async function findRegisteredPartRevision({ partId, partRevisionId, iterationId, }) {
+    // Implementation to find the part revision in the PLM system
+    // console.log(`Finding part revision in PLM for Part ID: ${partId}, Part Revision ID: ${partRevisionId}, Iteration ID: ${iterationId}`);
+    const VERTEX_PLM_HOST = process.env.VERTEX_PLM_HOST;
+    if (!VERTEX_PLM_HOST) {
+        throw new Error('VERTEX_PLM_HOST is not set in configuration or environment variables');
+    }
+    const requestOptions = {
+        method: 'GET',
+        headers: (0, plm_api_1.getPlmHeaders)(),
+    };
+    const response = await fetch(`${VERTEX_PLM_HOST}/registered-part-revisions?plmRevisionId=${partRevisionId}${partId ? `&plmPartId=${partId}` : ''}${iterationId ? `&plmIterationId=${iterationId}` : ''}`, requestOptions);
+    const result = await response.json();
+    if (result.items && result.items.length > 0) {
+        return result.items[0];
+    }
+    // console.log(`Registered part revision not found in PLM. [Part: ${partId}, Revision: ${partRevisionId}, Iteration: ${iterationId}]`);
+    return null;
+}
+exports.findRegisteredPartRevision = findRegisteredPartRevision;

package/lib/lib/plm-api/get-registered-part-revision-jobs.d.ts

@@ -0,0 +1,3 @@
+export declare function getRegisteredPartRevisionJobs({ id, }: {
+    id: string;
+}): Promise<Record<string, unknown>[] | null>;

package/lib/lib/plm-api/get-registered-part-revision-jobs.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRegisteredPartRevisionJobs = void 0;
+const plm_api_1 = require("./plm-api");
+async function getRegisteredPartRevisionJobs({ id, }) {
+    // Implementation to find jobs for the part revision in the PLM kernel
+    var _a;
+    const VERTEX_PLM_HOST = process.env.VERTEX_PLM_HOST;
+    if (!VERTEX_PLM_HOST) {
+        throw new Error('VERTEX_PLM_HOST is not set in configuration or environment variables');
+    }
+    const requestOptions = {
+        method: 'GET',
+        headers: (0, plm_api_1.getPlmHeaders)(),
+    };
+    const response = await fetch(`${VERTEX_PLM_HOST}/registered-part-revisions/${id}/jobs`, requestOptions);
+    try {
+        const result = await response.json();
+        return (_a = result.items) !== null && _a !== void 0 ? _a : null;
+    }
+    catch (error) {
+        return null;
+    }
+}
+exports.getRegisteredPartRevisionJobs = getRegisteredPartRevisionJobs;

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

@@ -0,0 +1,4 @@
+export * from './find-registered-part-revision';
+export * from './get-registered-part-revision-jobs';
+export * from './plm-api';
+export * from './set-overwrite-policy';

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

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./find-registered-part-revision"), exports);
+(0, tslib_1.__exportStar)(require("./get-registered-part-revision-jobs"), exports);
+(0, tslib_1.__exportStar)(require("./plm-api"), exports);
+(0, tslib_1.__exportStar)(require("./set-overwrite-policy"), exports);

package/lib/lib/plm-api/plm-api.d.ts

@@ -0,0 +1,9 @@
+export interface RegisteredPartRevision {
+    id: string;
+    createdAt: string;
+    registeredPartId: string;
+    plmRevisionId: string;
+    plmDisplayName: string;
+    vertexPartRevisionId: string;
+}
+export declare function getPlmHeaders(): Headers;

package/lib/lib/plm-api/plm-api.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPlmHeaders = void 0;
+function getPlmHeaders() {
+    const VERTEX_PLM_API_KEY = process.env.VERTEX_PLM_API_KEY;
+    if (!VERTEX_PLM_API_KEY) {
+        throw new Error('VERTEX_PLM_API_KEY is not set in configuration or environment variables');
+    }
+    const headers = new Headers();
+    headers.append('Accept', 'application/json');
+    headers.append('x-api-key', VERTEX_PLM_API_KEY);
+    return headers;
+}
+exports.getPlmHeaders = getPlmHeaders;

package/lib/lib/plm-api/set-overwrite-policy.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Implementation to set a registered part revision in the PLM kernel to be overwritten
+ * @returns {Promise<void>} Resolves when the policy has been set.
+ */
+export declare function setOverwritePolicy({ registeredPartRevisionId, }: {
+    registeredPartRevisionId: string;
+}): Promise<void>;

package/lib/lib/plm-api/set-overwrite-policy.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setOverwritePolicy = void 0;
+const plm_api_1 = require("./plm-api");
+/**
+ * Implementation to set a registered part revision in the PLM kernel to be overwritten
+ * @returns {Promise<void>} Resolves when the policy has been set.
+ */
+async function setOverwritePolicy({ registeredPartRevisionId, }) {
+    const VERTEX_PLM_HOST = process.env.VERTEX_PLM_HOST;
+    if (!VERTEX_PLM_HOST) {
+        throw new Error('VERTEX_PLM_HOST is not set in configuration or environment variables');
+    }
+    const requestOptions = {
+        method: 'POST',
+        headers: (0, plm_api_1.getPlmHeaders)(),
+        body: JSON.stringify({ revisionId: registeredPartRevisionId }),
+    };
+    const response = await fetch(`${VERTEX_PLM_HOST}/policies`, requestOptions);
+    if (response.status !== 201) {
+        throw new Error(`Failed to set registered part revision to overwrite. Status: ${response.status}`);
+    }
+}
+exports.setOverwritePolicy = setOverwritePolicy;

package/lib/lib/prompt.d.ts

@@ -0,0 +1,2 @@
+export declare function promptText(label: string, current?: string): Promise<string | undefined>;
+export declare function promptSecret(label: string, hasCurrent: boolean): Promise<string | undefined>;

package/lib/lib/prompt.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.promptSecret = exports.promptText = void 0;
+const tslib_1 = require("tslib");
+const cli_ux_1 = (0, tslib_1.__importDefault)(require("cli-ux"));
+async function promptText(label, current) {
+    const suffix = current ? ` (current: ${current})` : '';
+    const ans = await cli_ux_1.default.prompt(`${label}${suffix}`);
+    const v = String(ans !== null && ans !== void 0 ? ans : '').trim();
+    return v.length > 0 ? v : undefined;
+}
+exports.promptText = promptText;
+async function promptSecret(label, hasCurrent) {
+    const suffix = hasCurrent ? ' (current: ********)' : '';
+    const ans = await cli_ux_1.default.prompt(`${label}${suffix}`, { type: 'hide' });
+    const v = String(ans !== null && ans !== void 0 ? ans : '').trim();
+    return v.length > 0 ? v : undefined;
+}
+exports.promptSecret = promptSecret;

package/lib/lib/tree/tree-node.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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
+ */
+export declare class TreeNode<T> implements Iterable<TreeNode<T>> {
+    parent: TreeNode<T> | null;
+    children: TreeNode<T>[];
+    data: T | null;
+    constructor(data?: T | null, parent?: TreeNode<T>);
+    /** 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<U>(node: TreeNode<U>): Generator<TreeNode<U>>;
+    /** Total number of nodes in this subtree (includes this node) */
+    get size(): number;
+    isRoot(): boolean;
+    isLeaf(): boolean;
+    hasChildren(): boolean;
+    hasSiblings(): boolean;
+    isEmpty(): boolean;
+    /** Distance from this node up to the root (root.depth === 0) */
+    get depth(): number;
+    /** Number of direct children */
+    get numChildren(): number;
+    /** Number of siblings (including this node) */
+    get numSiblings(): number;
+    /** Allow `for (const n of someNode) { … }`
+     * @returns {Iterator<TreeNode<T>>} An iterator over nodes in pre-order.
+     */
+    [Symbol.iterator](): Iterator<TreeNode<T>>;
+    /** 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: T): boolean;
+    /** Remove all descendants (but not this node itself)
+     * @returns {void}
+     */
+    clear(): void;
+    /** Grab the data payload in pre-order as a flat array
+     * @returns {(T | null)[]} Array of data values in pre-order.
+     */
+    toArray(): (T | null)[];
+    /** Returns a string representation of this node
+     * @returns {string} String representation of the node.
+     */
+    toString({ node, data, }?: {
+        node?: (node: TreeNode<T>) => string;
+        data?: (data: T | null) => string;
+    }): string;
+    /** Human-readable dump with ASCII-tree lines
+     * @returns {string} A multi-line string representation of the tree.
+     */
+    dump({ node, data, }?: {
+        node?: (node: TreeNode<T>) => string;
+        data?: (data: T | null) => string;
+    }): string;
+}