@dropthis/cli 0.4.1 → 0.6.0

package/node_modules/@dropthis/node/dist/drops-BPdmUPCT.d.ts

@@ -0,0 +1,394 @@
+type DropthisClientOptions = {
+    apiKey?: string;
+    baseUrl?: string;
+    timeoutMs?: number;
+    uploadTimeoutMs?: number;
+    fetch?: typeof globalThis.fetch;
+};
+type RequestOptions = {
+    authenticated?: boolean;
+    idempotencyKey?: string;
+    ifRevision?: number;
+    timeoutMs?: number;
+};
+type DropthisErrorResponse = {
+    code: string;
+    message: string;
+    statusCode: number | null;
+    type?: string;
+    title?: string;
+    detail?: string | null;
+    instance?: string | null;
+    param?: string | null;
+    currentRevision?: number;
+    requestId?: string | null;
+    suggestion?: string | null;
+    retryable?: boolean | null;
+    body?: unknown;
+};
+type DropthisResult<T> = {
+    data: T;
+    error: null;
+    headers: Record<string, string>;
+} | {
+    data: null;
+    error: DropthisErrorResponse;
+    headers: Record<string, string>;
+};
+type ActionResolve = {
+    method: string;
+    url?: string | null;
+    endpoint?: string | null;
+};
+type DropAction = {
+    code: string;
+    kind: "api" | "human";
+    priority: "required" | "suggested";
+    message: string;
+    resolve?: ActionResolve | null;
+};
+type TierInfo = {
+    name: string;
+    maxSizeBytes: number;
+    ttlDays: number | null;
+    persistent: boolean;
+    badge: boolean;
+};
+type Limitations = {
+    actions: DropAction[];
+};
+type DropResponse = {
+    id: string;
+    slug: string;
+    url: string;
+    deploymentId: string | null;
+    title: string;
+    contentType: string;
+    visibility: string;
+    status: string;
+    revision: number;
+    contentRevision: number;
+    accessRevision: number;
+    sizeBytes: number;
+    renderMode: string;
+    warnings: Array<Record<string, unknown>>;
+    createdAt: string;
+    expiresAt: string | null;
+    object: string;
+    accessible: boolean;
+    persistent: boolean;
+    badgeApplied: boolean;
+    tier: TierInfo;
+    limitations: Limitations;
+};
+type DropDeploymentResponse = {
+    id: string;
+    dropId: string;
+    revision: number;
+    status: string;
+    storagePrefix: string;
+    entry: string | null;
+    contentType: string;
+    renderMode: string;
+    files: Array<Record<string, unknown>>;
+    warnings: Array<Record<string, unknown>>;
+    sizeBytes: number;
+    classificationVersion: number;
+    classificationReason: string;
+    errorCode: string | null;
+    errorMessage: string | null;
+    createdAt: string;
+    readyAt: string | null;
+    publishedAt: string | null;
+};
+type ListDeploymentsParams = {
+    cursor?: string | null;
+    limit?: number;
+};
+type ListDeploymentsResponse = {
+    deployments: DropDeploymentResponse[];
+    nextCursor: string | null;
+};
+type ListPage<T> = {
+    object: "list";
+    data: T[];
+    hasMore: boolean;
+    nextCursor: string | null;
+    autoPagingToArray(options?: {
+        limit?: number;
+    }): Promise<T[]>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+};
+type Action = {
+    code: string;
+    kind: string;
+    method?: string | null;
+    endpoint?: string | null;
+    message: string;
+};
+type EmailOtpResponse = {
+    ok: true;
+    expiresIn: number;
+    nextAction?: Action | null;
+};
+type SessionResponse = {
+    object: "session";
+    token: string;
+    accountId: string;
+    isNewAccount: boolean;
+    expiresIn: number;
+};
+type ApiKeyResponse = {
+    object: "api_key";
+    id: string;
+    keyLast4: string;
+    label: string;
+    createdAt: string;
+};
+type ApiKeyCreatedResponse = ApiKeyResponse & {
+    key: string;
+    accountId?: string | null;
+    isNewAccount?: boolean;
+};
+type AccountResponse = {
+    id: string;
+    email: string;
+    displayName: string | null;
+    plan: string;
+    status: string;
+    createdAt: string;
+};
+type ListDropsParams = {
+    cursor?: string | null;
+    limit?: number;
+};
+type UploadManifestFile = {
+    path: string;
+    contentType: string;
+    sizeBytes: number;
+    checksumSha256?: string | null;
+};
+type CreateUploadSessionRequest = {
+    schemaVersion?: 1;
+    files: UploadManifestFile[];
+    entry?: string | null;
+};
+type UploadTarget = {
+    strategy: "single_put" | "multipart";
+    url: string;
+    headers: Record<string, string>;
+    expiresAt: string;
+};
+type CreateUploadSessionFileResponse = {
+    fileId: string;
+    path: string;
+    objectKey: string;
+    upload: UploadTarget;
+};
+type UploadSessionFileResponse = {
+    fileId: string;
+    path: string;
+    contentType: string;
+    sizeBytes: number;
+    objectKey: string;
+    verified: boolean;
+};
+type UploadSessionResponse = {
+    uploadId: string;
+    status: string;
+    expiresAt: string;
+    entry?: string | null;
+    files: UploadSessionFileResponse[];
+    nextAction?: Action | null;
+};
+type CreateUploadSessionResponse = {
+    uploadId: string;
+    expiresAt: string;
+    files: CreateUploadSessionFileResponse[];
+    nextAction?: Action | null;
+};
+type CompleteUploadSessionRequest = {
+    files?: Record<string, {
+        parts?: Array<{
+            partNumber: number;
+            etag: string;
+        }> | null;
+    }>;
+};
+type DropOptions = {
+    /** Change the vanity slug (update only). */
+    slug?: string;
+    /** Drop title. */
+    title?: string;
+    /** public (default) or unlisted. */
+    visibility?: "public" | "unlisted";
+    /** Require password to view. Pass `null` to remove password protection. */
+    password?: string | null;
+    /** Prevent search-engine indexing. Pass `null` to allow indexing (default). */
+    noindex?: boolean | null;
+    /** Auto-delete after this ISO 8601 date. Pass `null` to clear. */
+    expiresAt?: string | Date | null;
+    /** Entry file for multi-file bundles (default: index.html). */
+    entry?: string;
+    /** Attach JSON key-value pairs, e.g. `{ source: "ci" }`. */
+    metadata?: Record<string, unknown>;
+};
+type PrepareOptions = {
+    /** Glob patterns to ignore when publishing directories. */
+    ignore?: string[];
+    /** Disable default ignore patterns. */
+    ignoreDefaults?: boolean;
+    /** Override MIME type (auto-detected from extension). */
+    contentType?: string;
+    /** Set filename when publishing from stdin or bytes. */
+    path?: string;
+};
+type RequestControls = {
+    /** Prevent duplicate publishes on retry (auto-generated by CLI). */
+    idempotencyKey?: string;
+    /** Fail if current revision doesn't match -- optimistic lock (update only). */
+    ifRevision?: number;
+};
+type PublishOptions = DropOptions & PrepareOptions & RequestControls;
+type PublishFileInput = {
+    path: string;
+    contentType?: string;
+    content?: string;
+    contentBase64?: string;
+    bytes?: Uint8Array;
+};
+type PublishInput = string | string[] | URL | Uint8Array | {
+    kind: "content";
+    content: string;
+    contentType?: string;
+    path?: string;
+} | {
+    kind: "source_url";
+    sourceUrl: string;
+} | {
+    kind: "files";
+    files: PublishFileInput[];
+    entry?: string;
+};
+
+declare class Transport {
+    readonly apiKey: string | undefined;
+    readonly baseUrl: string;
+    readonly timeoutMs: number;
+    readonly uploadTimeoutMs: number;
+    readonly fetchImpl: typeof globalThis.fetch;
+    constructor(options?: DropthisClientOptions | string);
+    putSignedUrl(url: string, body: Uint8Array | Blob | ReadableStream, headers: Record<string, string>): Promise<DropthisResult<{
+        etag: string | null;
+    }>>;
+    request<T>(method: string, path: string, options?: RequestOptions & {
+        body?: unknown;
+        bodyCase?: "snake" | "raw";
+        params?: Record<string, string | number | boolean | null | undefined>;
+    }): Promise<DropthisResult<T>>;
+}
+
+/**
+ * A file ready to be staged for upload. The body is lazy: the orchestrator
+ * calls `getBody()` per file when it is ready to push bytes to the signed URL.
+ * This keeps the resolution layer pure and lets the filesystem layer (node.ts)
+ * defer reads/streams until upload time.
+ */
+type PreparedUploadFile = {
+    path: string;
+    contentType: string;
+    sizeBytes: number;
+    checksumSha256?: string;
+    getBody(): Promise<Uint8Array | Blob | ReadableStream>;
+};
+type PreparedPublishRequest = {
+    kind: "staged";
+    manifest: CreateUploadSessionRequest;
+    files: PreparedUploadFile[];
+    options: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+} | {
+    kind: "source";
+    sourceUrl: string;
+    options: Record<string, unknown>;
+    metadata?: Record<string, unknown>;
+};
+/**
+ * The canonical publish inputs that can be resolved with no filesystem access:
+ * the {@link PublishInput} union minus `string[]` (which is inherently a list
+ * of filesystem paths handled by node.ts).
+ */
+type InMemoryPublishInput = string | URL | Uint8Array | {
+    kind: "content";
+    content: string;
+    contentType?: string;
+    path?: string;
+} | {
+    kind: "source_url";
+    sourceUrl: string;
+} | {
+    kind: "files";
+    files: PublishFileInput[];
+    entry?: string;
+};
+
+declare class AccountResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    get(): Promise<DropthisResult<AccountResponse>>;
+    update(input: {
+        displayName: string | null;
+    }): Promise<DropthisResult<AccountResponse>>;
+    delete(): Promise<DropthisResult<null>>;
+}
+
+declare class ApiKeysResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(): Promise<DropthisResult<{
+        object: "list";
+        data: ApiKeyResponse[];
+    }>>;
+    create(input: {
+        label: string;
+    }): Promise<DropthisResult<ApiKeyCreatedResponse>>;
+    delete(keyId: string): Promise<DropthisResult<{
+        ok: true;
+    }>>;
+}
+
+declare class DeploymentsResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(dropId: string, params?: ListDeploymentsParams): Promise<DropthisResult<ListDeploymentsResponse>>;
+    get(dropId: string, deploymentId: string): Promise<DropthisResult<DropDeploymentResponse>>;
+}
+
+declare class CursorPage<T> implements ListPage<T> {
+    readonly object: "list";
+    readonly data: T[];
+    readonly hasMore: boolean;
+    readonly nextCursor: string | null;
+    private readonly fetchNextPage;
+    constructor(input: {
+        data: T[];
+        hasMore: boolean;
+        nextCursor: string | null;
+        fetchNextPage?: (() => Promise<DropthisResult<CursorPage<T>>>) | undefined;
+    });
+    autoPagingToArray(options?: {
+        limit?: number;
+    }): Promise<T[]>;
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+}
+
+declare class DropsResource {
+    private readonly transport;
+    constructor(transport: Transport);
+    list(params?: ListDropsParams): Promise<DropthisResult<CursorPage<DropResponse>>>;
+    get(dropId: string): Promise<DropthisResult<DropResponse>>;
+    update(dropId: string, options?: DropOptions & RequestControls): Promise<DropthisResult<DropResponse>>;
+    delete(dropId: string): Promise<DropthisResult<null>>;
+}
+
+export { AccountResource as A, type CompleteUploadSessionRequest as C, DeploymentsResource as D, type EmailOtpResponse as E, type InMemoryPublishInput as I, type Limitations as L, type PrepareOptions as P, type RequestControls as R, type SessionResponse as S, type TierInfo as T, type UploadManifestFile as U, type ActionResolve as a, ApiKeysResource as b, type CreateUploadSessionRequest as c, type CreateUploadSessionResponse as d, CursorPage as e, type DropAction as f, type DropDeploymentResponse as g, type DropOptions as h, type DropResponse as i, DropsResource as j, type DropthisClientOptions as k, type DropthisErrorResponse as l, type DropthisResult as m, type ListDeploymentsParams as n, type ListDeploymentsResponse as o, type ListPage as p, type PreparedPublishRequest as q, type PreparedUploadFile as r, type PublishFileInput as s, type PublishInput as t, type PublishOptions as u, type RequestOptions as v, Transport as w, type UploadSessionFileResponse as x, type UploadSessionResponse as y, type UploadTarget as z };