paratix 0.0.1 → 0.1.0

package/dist/cli.d.ts

@@ -0,0 +1,62 @@
+import { E as Environment, S as ServerDefinition } from './types-BPzPHfax.js';
+
+/**
+ * Type guard that checks whether `value` has the shape of a
+ * {@link ServerDefinition} — an object with a non-empty string `name`,
+ * a non-empty string `host`, a valid `ssh` config, and a non-empty `run` array.
+ *
+ * @param value - The value to inspect.
+ * @returns `true` when `value` satisfies the structural requirements of `ServerDefinition`.
+ */
+declare function isServerDefinitionLike(value: unknown): value is ServerDefinition;
+/**
+ * Collects human-readable error messages for every property of `value` that
+ * does not conform to the `ServerDefinition` shape.
+ *
+ * @param value - The value to validate.
+ * @returns An array of error strings, empty when `value` is structurally valid.
+ */
+declare function collectDefinitionErrors(value: unknown): string[];
+/**
+ * Prints a structured error message to stderr, including the cause chain and
+ * optionally the full stack trace when `verbose` is `true`.
+ *
+ * @param error - The caught value (may be any type).
+ * @param verbose - When `true`, the stack trace of `error` is printed.
+ */
+declare function printExceptionError(error: unknown, verbose: boolean): void;
+/**
+ * Handles a failed attempt to load the `tsx` runtime.
+ *
+ * When the failed import is for a TypeScript file (`.ts`, `.mts`, `.cts`), a
+ * clear error message is printed to stderr and the process exits with code 2.
+ * For JavaScript files the failure is silently ignored because `tsx` is not
+ * required there.
+ *
+ * @param filePath - The resolved path of the playbook file being loaded.
+ */
+declare function handleTsxLoadFailure(filePath: string): void;
+/**
+ * Returns whether the current CLI module is the direct process entrypoint.
+ *
+ * This resolves symlinks on both sides so pnpm-style executable shims and
+ * symlinked `node_modules` entries still count as direct execution.
+ *
+ * @param moduleUrl - The current module URL, usually `import.meta.url`.
+ * @param candidateEntryScript - The process entry script path, usually `process.argv[1]`.
+ * @returns `true` when both paths resolve to the same file on disk.
+ */
+declare function isDirectCliExecution(moduleUrl: string, candidateEntryScript?: string): boolean;
+declare function applyCliEnvironmentOverrides(environment: Environment, options: {
+    firstRun: boolean;
+}): Environment;
+declare function applyCliProcessEnvironment(options: {
+    firstRun: boolean;
+}): void;
+declare function loadServerDefinitionFromFile(file: string, options: {
+    firstRun: boolean;
+}): Promise<ServerDefinition>;
+declare function parsePositiveNumber(value: string): number;
+declare function collectEnvironment(value: string, previous: Record<string, string>): Record<string, string>;
+
+export { applyCliEnvironmentOverrides, applyCliProcessEnvironment, collectDefinitionErrors, collectEnvironment, handleTsxLoadFailure, isDirectCliExecution, isServerDefinitionLike, loadServerDefinitionFromFile, parsePositiveNumber, printExceptionError };