ninepm 0.0.1 → 0.24.1

package/dist/index.d.ts

@@ -0,0 +1,441 @@
+#!/usr/bin/env node
+import type { AccessGrant, AccessGrantType, AccessProviderKey, AppAccessSettings, AppAccessServiceToken, AppAccessToken, AppDatabase, AppRuntime, ContainerRegion, Deployment, ManagedFileObject, ManagedFileShare, ManagedFileUsage, Project } from "./cli-types.js";
+export interface DeployOptions {
+    directory: string;
+    apiUrl: string;
+    token: string;
+    name?: string;
+    slug?: string;
+    description?: string;
+    environment?: string;
+    withDatabase?: boolean;
+    withAuth?: boolean;
+    databaseName?: string;
+    bindingName?: string;
+    runtime?: AppRuntime;
+    entry?: string;
+    port?: number;
+    healthPath?: string;
+    region?: ContainerRegion;
+    alwaysOn?: boolean;
+    volumeGb?: number;
+    allowVolumeDestroy?: boolean;
+    allowNamespaceReset?: boolean;
+    cpus?: number;
+    memoryMb?: number;
+    bundleDir?: string;
+    noBuild?: boolean;
+    pollTimeoutMs?: number;
+    fetchFn?: FetchLike;
+    check?: boolean;
+}
+export interface DeployResult {
+    project: Project;
+    deployment: Deployment;
+    database: AppDatabase | null;
+    uploaded: number;
+    url: string;
+    containerImageBytes?: number;
+}
+export interface ApiOptions {
+    apiUrl: string;
+    token: string;
+    fetchFn?: FetchLike;
+}
+export interface SiteAccessOptions extends ApiOptions {
+    site: string;
+}
+export interface DeleteSiteOptions extends SiteAccessOptions {
+    confirmSlug: string;
+}
+export interface AccessState {
+    access: AppAccessSettings;
+    grants: AccessGrant[];
+    appAccessTokens: AppAccessToken[];
+    serviceTokens: AppAccessServiceToken[];
+}
+export interface FileCommandOptions extends ApiOptions {
+    project?: string;
+}
+export interface FilePutOptions extends FileCommandOptions {
+    localPath: string;
+    remotePath?: string;
+}
+export interface FileGetOptions extends FileCommandOptions {
+    fileId: string;
+    outputPath?: string;
+}
+export interface FileDeleteOptions extends FileCommandOptions {
+    fileId: string;
+}
+export interface FileShareOptions extends FileCommandOptions {
+    fileId: string;
+    mode: "public" | "login_required";
+    expiresInSeconds: number;
+}
+export interface ManagedFileListResult {
+    files: ManagedFileObject[];
+    shares: ManagedFileShare[];
+    usage: ManagedFileUsage;
+}
+export interface ManagedFilePutResult {
+    file: ManagedFileObject;
+    usage: ManagedFileUsage;
+}
+export interface ManagedFileShareResult {
+    share: ManagedFileShare;
+    url: string;
+}
+export interface DeletedSiteResult {
+    projectId: string;
+    slug: string;
+    workers: number;
+    customDomains: number;
+    containerApplications?: number;
+    containerImages?: number;
+    accessApps: number;
+    serviceTokens: number;
+    databases: number;
+    files: number;
+    artifacts: boolean;
+    metadata: boolean;
+}
+export interface CreatedRuntimeToken {
+    token: string;
+    appAccessToken: AppAccessToken;
+}
+export interface CreatedServiceToken {
+    serviceToken: AppAccessServiceToken;
+    clientSecret: string;
+}
+export type FetchLike = (input: string | URL | Request, init?: RequestInit) => Promise<Response>;
+export declare const CLI_VERSION = "0.24.1";
+type CredentialBackend = "macos-keychain" | "windows-dpapi" | "linux-secret-service" | "file-plaintext" | "none";
+export interface CredentialDiagnostics {
+    platform: NodeJS.Platform;
+    preferredBackend: CredentialBackend;
+    storedBackend: CredentialBackend;
+    secure: boolean;
+    stored: boolean;
+    metadataPath: string;
+    secretPath?: string;
+    plaintextPath: string;
+    legacyPlaintextPath: string;
+    fileFallbackAllowed: boolean;
+    nativeStoreDisabled: boolean;
+    warnings: string[];
+}
+export interface WhoamiResult {
+    user: {
+        email: string;
+        role?: string;
+    };
+    apiKey: {
+        prefix: string;
+        expiresAt: string | null;
+    };
+    account?: {
+        org?: string;
+        plan?: string;
+        sitesUsed?: number;
+        sitesQuota?: number;
+        storageUsedBytes?: number;
+        storageQuotaBytes?: number;
+        fileStorageUsedBytes?: number;
+        fileStorageQuotaBytes?: number;
+        tokenExpiresAt?: string | null;
+    };
+}
+export interface PublicWhoamiResult {
+    user: {
+        email: string;
+        role?: string;
+    };
+    account?: {
+        org?: string;
+        plan?: string;
+        sitesUsed?: number;
+        sitesQuota?: number;
+        storageUsedBytes?: number;
+        storageQuotaBytes?: number;
+        fileStorageUsedBytes?: number;
+        fileStorageQuotaBytes?: number;
+        credentialExpiresAt?: string | null;
+    };
+}
+export interface DeployCheckResult {
+    ok: boolean;
+    warnings: string[];
+    errors: string[];
+    files: number;
+    bytes: number;
+}
+export type DetectedFramework = "nextjs" | "astro" | "sveltekit" | "vite";
+export declare function detectFramework(directory: string): DetectedFramework | null;
+export declare const DEFAULT_OPEN_NEXT_CONFIG = "import { defineCloudflareConfig } from \"@opennextjs/cloudflare\";\nexport default defineCloudflareConfig();\n";
+export declare function defaultNextWranglerConfig(appName: string): string;
+export declare function isOpenNextInstalled(directory: string): boolean;
+export declare class DeployError extends Error {
+    readonly slug: string | undefined;
+    constructor(message: string, slug: string | undefined);
+}
+export declare function deployDirectory(initialOptions: DeployOptions): Promise<DeployResult>;
+export declare function checkDeployDirectory(options: DeployOptions): Promise<DeployCheckResult>;
+export declare function whoami(options: ApiOptions): Promise<WhoamiResult>;
+export declare function publicWhoamiResult(result: WhoamiResult): PublicWhoamiResult;
+export declare function getSiteAccess(options: SiteAccessOptions): Promise<AccessState>;
+export declare function setSiteAccessPublic(options: SiteAccessOptions): Promise<AccessState["access"]>;
+export declare function setSiteAccessOtp(options: SiteAccessOptions): Promise<AccessState["access"]>;
+export declare function setSiteAccessIdp(options: SiteAccessOptions & {
+    providers?: AccessProviderKey[];
+}): Promise<AccessState["access"]>;
+export declare function createAccessServiceToken(options: SiteAccessOptions & {
+    name?: string;
+    duration?: string;
+}): Promise<CreatedServiceToken>;
+export declare function revokeAccessServiceToken(options: SiteAccessOptions & {
+    tokenId: string;
+}): Promise<AppAccessServiceToken>;
+export declare function addAccessGrant(options: SiteAccessOptions & {
+    type: AccessGrantType;
+    value: string;
+}): Promise<AccessGrant>;
+export declare function revokeAccessGrant(options: SiteAccessOptions & {
+    type: AccessGrantType;
+    value: string;
+}): Promise<AccessGrant>;
+export declare function createRuntimeAccessToken(options: SiteAccessOptions & {
+    name?: string;
+    expiresAt?: string;
+}): Promise<CreatedRuntimeToken>;
+export declare function revokeRuntimeAccessToken(options: SiteAccessOptions & {
+    tokenId: string;
+}): Promise<AppAccessToken>;
+export interface LatestCliVersion {
+    version: string;
+    publishedAt?: string;
+    tarballSha256?: string;
+}
+export interface CliVersionCheck {
+    current: string;
+    latest: LatestCliVersion;
+    comparison: "behind" | "ahead" | "current";
+}
+export declare function fetchLatestCliVersion(options: {
+    apiUrl: string;
+    fetchFn?: FetchLike;
+    timeoutMs?: number;
+}): Promise<LatestCliVersion>;
+export declare function compareCliVersions(current: string, latest: string): "behind" | "ahead" | "current";
+export declare function checkCliVersion(options: {
+    apiUrl: string;
+    fetchFn?: FetchLike;
+    timeoutMs?: number;
+}): Promise<CliVersionCheck>;
+export interface ListSitesResult {
+    projects: Project[];
+}
+export declare function listSites(options: ApiOptions): Promise<ListSitesResult>;
+export declare function deleteSite(options: DeleteSiteOptions): Promise<DeletedSiteResult>;
+export declare function loginDevice(options: {
+    apiUrl: string;
+    fetchFn?: FetchLike;
+    machineName?: string;
+    allowFileCredentialStore?: boolean;
+}): Promise<{
+    email?: string;
+    storage: string;
+}>;
+export declare function signupDevice(options: {
+    apiUrl: string;
+    fetchFn?: FetchLike;
+    machineName?: string;
+    allowFileCredentialStore?: boolean;
+}): Promise<{
+    email?: string;
+    storage: string;
+}>;
+export declare function listManagedFiles(options: FileCommandOptions): Promise<ManagedFileListResult>;
+export declare function putManagedFile(options: FilePutOptions): Promise<ManagedFilePutResult>;
+export declare function getManagedFile(options: FileGetOptions): Promise<{
+    fileId: string;
+    bytes: Uint8Array;
+    contentType: string;
+}>;
+export declare function deleteManagedFile(options: FileDeleteOptions): Promise<ManagedFilePutResult>;
+export declare function shareManagedFile(options: FileShareOptions): Promise<ManagedFileShareResult>;
+type CliCommand = {
+    kind: "deploy";
+    options: DeployOptions;
+} | {
+    kind: "version";
+} | {
+    kind: "login";
+    apiUrl: string;
+    allowFileCredentialStore: boolean;
+} | {
+    kind: "signup";
+    apiUrl: string;
+    allowFileCredentialStore: boolean;
+} | {
+    kind: "logout";
+} | {
+    kind: "doctor";
+    apiUrl: string;
+    json: boolean;
+} | {
+    kind: "whoami";
+    apiUrl: string;
+    token: string;
+    json: boolean;
+} | {
+    kind: "delete";
+    site: string;
+    confirmSlug: string;
+    apiUrl: string;
+    token: string;
+} | {
+    kind: "apps";
+    apiUrl: string;
+    token: string;
+    json: boolean;
+} | {
+    kind: "logs";
+    site: string;
+    apiUrl: string;
+    token: string;
+    json: boolean;
+    lines?: number;
+} | {
+    kind: "latest";
+    apiUrl: string;
+    json: boolean;
+} | {
+    kind: "support";
+    message: string;
+    subject?: string;
+    site?: string;
+    apiUrl: string;
+    token: string;
+} | {
+    kind: "files";
+    action: {
+        kind: "list";
+        project?: string;
+    } | {
+        kind: "put";
+        localPath: string;
+        remotePath?: string;
+        project?: string;
+    } | {
+        kind: "get";
+        fileId: string;
+        outputPath?: string;
+        project?: string;
+    } | {
+        kind: "delete";
+        fileId: string;
+        project?: string;
+    } | {
+        kind: "share";
+        fileId: string;
+        project?: string;
+        mode: "public" | "login_required";
+        expiresInSeconds: number;
+    };
+    apiUrl: string;
+    token: string;
+} | {
+    kind: "env";
+    action: {
+        kind: "set";
+        site: string;
+        entries: Array<{
+            name: string;
+            value: string;
+            kind: "secret" | "var";
+        }>;
+    } | {
+        kind: "ls";
+        site: string;
+    } | {
+        kind: "rm";
+        site: string;
+        name: string;
+    } | {
+        kind: "request";
+        site: string;
+        name: string;
+        varKind: "secret" | "var";
+    };
+    apiUrl: string;
+    token: string;
+} | {
+    kind: "deployments";
+    action: {
+        kind: "ls";
+        site: string;
+        json: boolean;
+    } | {
+        kind: "rm";
+        deploymentId: string;
+    };
+    apiUrl: string;
+    token: string;
+} | {
+    kind: "access";
+    action: {
+        kind: "show";
+        site: string;
+    } | {
+        kind: "public";
+        site: string;
+    } | {
+        kind: "otp";
+        site: string;
+    } | {
+        kind: "idp";
+        site: string;
+        providers?: AccessProviderKey[];
+    } | {
+        kind: "allow";
+        site: string;
+        grantType: AccessGrantType;
+        value: string;
+    } | {
+        kind: "revoke";
+        site: string;
+        grantType: AccessGrantType;
+        value: string;
+    } | {
+        kind: "service-create";
+        site: string;
+        name?: string;
+        duration?: string;
+    } | {
+        kind: "service-revoke";
+        site: string;
+        tokenId: string;
+    } | {
+        kind: "token-create";
+        site: string;
+        name?: string;
+        expiresAt?: string;
+    } | {
+        kind: "token-revoke";
+        site: string;
+        tokenId: string;
+    };
+    apiUrl: string;
+    token: string;
+};
+export declare function parseArgs(argv: string[]): CliCommand;
+export declare function parseEnvFileEntries(content: string, kind: "secret" | "var"): Array<{
+    name: string;
+    value: string;
+    kind: "secret" | "var";
+}>;
+export declare function credentialDiagnostics(): CredentialDiagnostics;
+export declare class UsageError extends Error {
+}
+export {};