@usestatemachines/cli 0.0.0-stage → 0.1.0

package/dist/errors.d.ts

@@ -0,0 +1,784 @@
+import type { JsonValue } from './command.js';
+export type ExitCode = 0 | 1 | 2 | 3 | 130;
+export type FailureExitCode = Exclude<ExitCode, 0>;
+export interface NextCommand {
+    readonly command: string;
+    readonly reason: string;
+}
+export declare const errorCatalog: {
+    'cli.resource_failed': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.unexpected_status': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.env_requires_login': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.env_path_refused': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.env_invalid': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.env_changed': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.git': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.child_start': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.package_install': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.invalid_environment_credential': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.no_credential': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.credential_expired': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.credential_revoked': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.profile_not_found': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.not_linked': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.workspace_mismatch': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.organization_mismatch': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.origin_mismatch': {
+        message: string;
+        exitCode: 3;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.keychain_denied': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.keychain_timeout': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.keychain_unavailable': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.credential_store_mismatch': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.credentials_invalid': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.input_required': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.invalid_arguments': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: false;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.path_refused': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: false;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.wait_timeout': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.config_too_new': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.file_not_utf8': {
+        message: string;
+        exitCode: 2;
+        retryable: false;
+        userActionRequired: true;
+        next: never[];
+    };
+    'cli.config_invalid': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.config_locked': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.config_lock_invalid': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.config_io': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.login_busy': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.profile_changed': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.logout_pending': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: true;
+        next: {
+            command: string;
+            reason: string;
+        }[];
+    };
+    'cli.network': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.invalid_response': {
+        message: string;
+        exitCode: 1;
+        retryable: true;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.invalid_result': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.cancelled': {
+        message: string;
+        exitCode: 130;
+        retryable: false;
+        userActionRequired: false;
+        next: never[];
+    };
+    'cli.internal': {
+        message: string;
+        exitCode: 1;
+        retryable: false;
+        userActionRequired: false;
+        next: never[];
+    };
+};
+export type CliErrorCode = keyof typeof errorCatalog;
+export interface ErrorDocument {
+    readonly error: {
+        readonly code: string;
+        readonly message: string;
+        readonly requestId: string | null;
+        readonly retryable: boolean;
+        readonly next: readonly NextCommand[];
+        readonly userActionRequired: boolean;
+        readonly details: JsonValue;
+    };
+}
+export interface CliErrorOptions {
+    readonly message?: string;
+    readonly requestId?: string | null;
+    readonly next?: readonly NextCommand[];
+    readonly details?: JsonValue;
+    readonly userActionRequired?: boolean;
+}
+export declare class CliError extends Error {
+    readonly code: CliErrorCode;
+    readonly exitCode: FailureExitCode;
+    readonly document: ErrorDocument;
+    constructor(code: CliErrorCode, options?: CliErrorOptions);
+}
+export interface ApiErrorInput {
+    readonly status: number;
+    readonly code: string | null;
+    readonly message: string;
+    readonly requestId: string | null;
+    readonly details: JsonValue;
+}
+export declare class ApiError extends Error {
+    readonly status: number;
+    readonly exitCode: FailureExitCode;
+    readonly document: ErrorDocument;
+    constructor(input: ApiErrorInput);
+}
+export declare const keychainFailures: string[];
+export declare function failedWith(error: unknown, codes: readonly string[]): boolean;
+export declare function unconfirmedRevocations(count: number): {
+    problem: string;
+    remedy: string;
+};
+export declare function withErrorDetails(error: CliError | ApiError, details: JsonValue): CliError | ApiError;
+export declare function normalizeError(error: unknown): CliError | ApiError;
+export declare function errorHelp(): ({
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 3;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: false;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: false;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 2;
+    retryable: false;
+    userActionRequired: true;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: true;
+    next: {
+        command: string;
+        reason: string;
+    }[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: true;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 130;
+    retryable: false;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+} | {
+    message: string;
+    exitCode: 1;
+    retryable: false;
+    userActionRequired: false;
+    next: never[];
+    code: string;
+})[];
+export declare const exitCodeHelp: ({
+    code: 0;
+    meaning: string;
+} | {
+    code: 1;
+    meaning: string;
+} | {
+    code: 2;
+    meaning: string;
+} | {
+    code: 3;
+    meaning: string;
+} | {
+    code: 130;
+    meaning: string;
+})[];