@ustorage/sdk 0.1.0

package/dist/core/index.d.cts

@@ -0,0 +1,273 @@
+type BrowserAuth = {
+    bearerToken: string | (() => string | Promise<string>);
+    uploadToken?: never;
+} | {
+    uploadToken: string | (() => string | Promise<string>);
+    bearerToken?: never;
+};
+interface NodeCredentialAuth {
+    accessKey: string;
+    secretKey: string;
+}
+interface BearerAuth {
+    bearerToken: string | (() => string | Promise<string>);
+}
+declare function resolveToken(value: string | (() => string | Promise<string>)): Promise<string>;
+
+type HeaderValue = string | undefined | null;
+interface HttpRequestOptions {
+    method: string;
+    path: string;
+    headers?: Record<string, HeaderValue>;
+    query?: Record<string, string | number | boolean | undefined | null>;
+    body?: unknown;
+    signal?: AbortSignal;
+}
+interface HttpClient {
+    request<T>(options: HttpRequestOptions): Promise<T>;
+}
+type AuthHeadersProvider = (request?: {
+    method: string;
+    path: string;
+    body?: BodyInit;
+}) => Record<string, string> | Promise<Record<string, string>>;
+declare class FetchHttpClient implements HttpClient {
+    private readonly baseUrl;
+    private readonly authHeaders?;
+    private readonly fetchImpl;
+    constructor(options: {
+        baseUrl: string;
+        authHeaders?: AuthHeadersProvider;
+        fetchImpl?: typeof fetch;
+    });
+    request<T>(options: HttpRequestOptions): Promise<T>;
+    private url;
+    private pathWithQuery;
+}
+
+type UploadBody = BodyInit | ArrayBufferView;
+interface UploadChunk {
+    body: UploadBody;
+    size: number;
+}
+interface UploadSource {
+    readonly name: string;
+    readonly size: number;
+    readonly type?: string;
+    fingerprint(key?: string): string | Promise<string>;
+    slice(start: number, end: number): UploadChunk | Promise<UploadChunk>;
+}
+interface ResumeStore {
+    get(key: string): Promise<string | undefined> | string | undefined;
+    set(key: string, uploadId: string): Promise<void> | void;
+    delete(key: string): Promise<void> | void;
+}
+declare class MemoryResumeStore implements ResumeStore {
+    private readonly values;
+    get(key: string): string | undefined;
+    set(key: string, uploadId: string): void;
+    delete(key: string): void;
+}
+
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type UploadStatus = 'uploading' | 'completed' | 'failed' | 'canceled' | 'expired' | string;
+interface CreateUploadTokenRequest {
+    bucket_name: string;
+    key: string;
+    workspace_name?: string | null;
+    mime_type?: string | null;
+    max_file_size?: number | null;
+    expires_in?: number | null;
+}
+interface CreateUploadTokenResponse {
+    token: string;
+    bucket_name: string;
+    key: string;
+    expires_at: string;
+}
+interface CreateUploadSessionRequest {
+    bucket_name: string;
+    key: string;
+    workspace_name?: string | null;
+    mime_type?: string | null;
+    file_size: number;
+    chunk_size: number;
+    total_chunks: number;
+    checksum?: string | null;
+    metadata?: JsonValue;
+    overwrite?: boolean | null;
+    visibility?: 'public' | 'private' | null;
+}
+interface CreateUploadSessionResponse {
+    upload_id: string;
+    file_id: string;
+    workspace_id: string;
+    bucket_id: string;
+    chunk_size: number;
+    total_chunks: number;
+    expires_at: string;
+}
+interface UploadChunkResponse {
+    upload_id: string;
+    chunk_index: number;
+    status: string;
+    uploaded_chunks: number;
+    total_chunks: number;
+    uploaded_size: number;
+    file_size: number;
+    progress: number;
+}
+interface UploadStatusResponse {
+    upload_id: string;
+    file_id: string;
+    status: UploadStatus;
+    uploaded_chunks: number[];
+    missing_chunks: number[];
+    total_chunks: number;
+    uploaded_size: number;
+    file_size: number;
+    progress: number;
+    error?: JsonValue;
+    expires_at: string;
+}
+interface CompleteUploadRequest {
+    checksum?: string | null;
+}
+interface CompleteUploadResponse {
+    upload_id: string;
+    file_id: string;
+    status: string;
+    public_id?: string;
+    visibility?: 'public' | 'private' | string;
+    url?: string;
+    expires_at?: string | null;
+}
+interface CreateFileUrlRequest {
+    file_id?: string | null;
+    bucket?: string | null;
+    bucket_id?: string | null;
+    key?: string | null;
+    path?: string | null;
+    expires_in?: number | null;
+}
+interface CreateFileUrlResponse {
+    file_id: string;
+    public_id: string;
+    visibility: 'public' | 'private' | string;
+    url: string;
+    expires_at: string | null;
+}
+interface GetObjectUrlInput {
+    fileId?: string;
+    bucket?: string;
+    bucketId?: string;
+    key?: string;
+    path?: string;
+    expiresIn?: number;
+}
+interface GetObjectUrlResult {
+    fileId: string;
+    publicId: string;
+    visibility: 'public' | 'private' | string;
+    url: string;
+    expiresAt: string | null;
+}
+interface ErrorResponse {
+    error: {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    request_id?: string;
+}
+
+declare class UploadApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    createUploadToken(request: CreateUploadTokenRequest): Promise<CreateUploadTokenResponse>;
+    createSession(request: CreateUploadSessionRequest): Promise<CreateUploadSessionResponse>;
+    createFileUrl(request: CreateFileUrlRequest): Promise<CreateFileUrlResponse>;
+    uploadChunk(uploadId: string, index: number, body: UploadBody, checksum?: string, signal?: AbortSignal): Promise<UploadChunkResponse>;
+    getStatus(uploadId: string): Promise<UploadStatusResponse>;
+    complete(uploadId: string, request?: CompleteUploadRequest): Promise<CompleteUploadResponse>;
+    cancel(uploadId: string): Promise<void>;
+}
+
+interface PutObjectOptions {
+    bucketName: string;
+    key: string;
+    workspaceName?: string;
+    contentType?: string | null;
+    metadata?: JsonValue;
+    checksum?: false | 'sha256' | {
+        file?: string;
+        chunks?: Record<number, string>;
+    };
+    resume?: boolean;
+    resumeKey?: string;
+    overwrite?: boolean;
+    visibility?: 'public' | 'private';
+    chunkSize?: number;
+    signal?: AbortSignal;
+    onProgress?: (event: UploadProgressEvent) => void;
+}
+interface UploadFileOptions extends Omit<PutObjectOptions, 'key'> {
+    key?: string;
+}
+interface UploadProgressEvent {
+    uploadId: string;
+    chunkIndex?: number;
+    uploadedChunks: number;
+    totalChunks: number;
+    uploadedSize: number;
+    fileSize: number;
+    progress: number;
+}
+interface UploadObjectResult extends CompleteUploadResponse {
+    uploadId: string;
+    fileId: string;
+    publicId?: string;
+    visibility?: 'public' | 'private' | string;
+    url?: string;
+    expiresAt?: string | null;
+}
+declare class Uploader {
+    private readonly uploads;
+    private readonly resumeStore?;
+    constructor(uploads: UploadApi, resumeStore?: ResumeStore | undefined);
+    putObject(source: UploadSource, options: PutObjectOptions): Promise<UploadObjectResult>;
+    private chunkChecksum;
+}
+
+interface UStorageClientOptions {
+    uploadBaseUrl: string;
+    authHeaders?: AuthHeadersProvider;
+    uploadHttpClient?: HttpClient;
+    resumeStore?: ResumeStore;
+}
+declare class UStorageCoreClient {
+    readonly uploads: UploadApi;
+    private readonly uploader;
+    constructor(options: UStorageClientOptions);
+    getObjectUrl(input: GetObjectUrlInput): Promise<GetObjectUrlResult>;
+    getSignedUrl(input: GetObjectUrlInput): Promise<GetObjectUrlResult>;
+    protected uploadSource(source: UploadSource, options: PutObjectOptions): Promise<UploadObjectResult>;
+}
+
+declare class UStorageError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    constructor(message: string, options: {
+        code: string;
+        status: number;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+declare function toUStorageError(status: number, body: unknown): UStorageError;
+
+export { type AuthHeadersProvider, type BearerAuth, type BrowserAuth, type CompleteUploadRequest, type CompleteUploadResponse, type CreateFileUrlRequest, type CreateFileUrlResponse, type CreateUploadSessionRequest, type CreateUploadSessionResponse, type CreateUploadTokenRequest, type CreateUploadTokenResponse, type ErrorResponse, FetchHttpClient, type GetObjectUrlInput, type GetObjectUrlResult, type HeaderValue, type HttpClient, type HttpRequestOptions, type JsonValue, MemoryResumeStore, type NodeCredentialAuth, type PutObjectOptions, type ResumeStore, type UStorageClientOptions, UStorageCoreClient, UStorageError, UploadApi, type UploadBody, type UploadChunk, type UploadChunkResponse, type UploadFileOptions, type UploadObjectResult, type UploadProgressEvent, type UploadSource, type UploadStatus, type UploadStatusResponse, Uploader, resolveToken, toUStorageError };

package/dist/core/index.d.ts

@@ -0,0 +1,273 @@
+type BrowserAuth = {
+    bearerToken: string | (() => string | Promise<string>);
+    uploadToken?: never;
+} | {
+    uploadToken: string | (() => string | Promise<string>);
+    bearerToken?: never;
+};
+interface NodeCredentialAuth {
+    accessKey: string;
+    secretKey: string;
+}
+interface BearerAuth {
+    bearerToken: string | (() => string | Promise<string>);
+}
+declare function resolveToken(value: string | (() => string | Promise<string>)): Promise<string>;
+
+type HeaderValue = string | undefined | null;
+interface HttpRequestOptions {
+    method: string;
+    path: string;
+    headers?: Record<string, HeaderValue>;
+    query?: Record<string, string | number | boolean | undefined | null>;
+    body?: unknown;
+    signal?: AbortSignal;
+}
+interface HttpClient {
+    request<T>(options: HttpRequestOptions): Promise<T>;
+}
+type AuthHeadersProvider = (request?: {
+    method: string;
+    path: string;
+    body?: BodyInit;
+}) => Record<string, string> | Promise<Record<string, string>>;
+declare class FetchHttpClient implements HttpClient {
+    private readonly baseUrl;
+    private readonly authHeaders?;
+    private readonly fetchImpl;
+    constructor(options: {
+        baseUrl: string;
+        authHeaders?: AuthHeadersProvider;
+        fetchImpl?: typeof fetch;
+    });
+    request<T>(options: HttpRequestOptions): Promise<T>;
+    private url;
+    private pathWithQuery;
+}
+
+type UploadBody = BodyInit | ArrayBufferView;
+interface UploadChunk {
+    body: UploadBody;
+    size: number;
+}
+interface UploadSource {
+    readonly name: string;
+    readonly size: number;
+    readonly type?: string;
+    fingerprint(key?: string): string | Promise<string>;
+    slice(start: number, end: number): UploadChunk | Promise<UploadChunk>;
+}
+interface ResumeStore {
+    get(key: string): Promise<string | undefined> | string | undefined;
+    set(key: string, uploadId: string): Promise<void> | void;
+    delete(key: string): Promise<void> | void;
+}
+declare class MemoryResumeStore implements ResumeStore {
+    private readonly values;
+    get(key: string): string | undefined;
+    set(key: string, uploadId: string): void;
+    delete(key: string): void;
+}
+
+type JsonValue = string | number | boolean | null | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type UploadStatus = 'uploading' | 'completed' | 'failed' | 'canceled' | 'expired' | string;
+interface CreateUploadTokenRequest {
+    bucket_name: string;
+    key: string;
+    workspace_name?: string | null;
+    mime_type?: string | null;
+    max_file_size?: number | null;
+    expires_in?: number | null;
+}
+interface CreateUploadTokenResponse {
+    token: string;
+    bucket_name: string;
+    key: string;
+    expires_at: string;
+}
+interface CreateUploadSessionRequest {
+    bucket_name: string;
+    key: string;
+    workspace_name?: string | null;
+    mime_type?: string | null;
+    file_size: number;
+    chunk_size: number;
+    total_chunks: number;
+    checksum?: string | null;
+    metadata?: JsonValue;
+    overwrite?: boolean | null;
+    visibility?: 'public' | 'private' | null;
+}
+interface CreateUploadSessionResponse {
+    upload_id: string;
+    file_id: string;
+    workspace_id: string;
+    bucket_id: string;
+    chunk_size: number;
+    total_chunks: number;
+    expires_at: string;
+}
+interface UploadChunkResponse {
+    upload_id: string;
+    chunk_index: number;
+    status: string;
+    uploaded_chunks: number;
+    total_chunks: number;
+    uploaded_size: number;
+    file_size: number;
+    progress: number;
+}
+interface UploadStatusResponse {
+    upload_id: string;
+    file_id: string;
+    status: UploadStatus;
+    uploaded_chunks: number[];
+    missing_chunks: number[];
+    total_chunks: number;
+    uploaded_size: number;
+    file_size: number;
+    progress: number;
+    error?: JsonValue;
+    expires_at: string;
+}
+interface CompleteUploadRequest {
+    checksum?: string | null;
+}
+interface CompleteUploadResponse {
+    upload_id: string;
+    file_id: string;
+    status: string;
+    public_id?: string;
+    visibility?: 'public' | 'private' | string;
+    url?: string;
+    expires_at?: string | null;
+}
+interface CreateFileUrlRequest {
+    file_id?: string | null;
+    bucket?: string | null;
+    bucket_id?: string | null;
+    key?: string | null;
+    path?: string | null;
+    expires_in?: number | null;
+}
+interface CreateFileUrlResponse {
+    file_id: string;
+    public_id: string;
+    visibility: 'public' | 'private' | string;
+    url: string;
+    expires_at: string | null;
+}
+interface GetObjectUrlInput {
+    fileId?: string;
+    bucket?: string;
+    bucketId?: string;
+    key?: string;
+    path?: string;
+    expiresIn?: number;
+}
+interface GetObjectUrlResult {
+    fileId: string;
+    publicId: string;
+    visibility: 'public' | 'private' | string;
+    url: string;
+    expiresAt: string | null;
+}
+interface ErrorResponse {
+    error: {
+        code: string;
+        message: string;
+        details?: unknown;
+    };
+    request_id?: string;
+}
+
+declare class UploadApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    createUploadToken(request: CreateUploadTokenRequest): Promise<CreateUploadTokenResponse>;
+    createSession(request: CreateUploadSessionRequest): Promise<CreateUploadSessionResponse>;
+    createFileUrl(request: CreateFileUrlRequest): Promise<CreateFileUrlResponse>;
+    uploadChunk(uploadId: string, index: number, body: UploadBody, checksum?: string, signal?: AbortSignal): Promise<UploadChunkResponse>;
+    getStatus(uploadId: string): Promise<UploadStatusResponse>;
+    complete(uploadId: string, request?: CompleteUploadRequest): Promise<CompleteUploadResponse>;
+    cancel(uploadId: string): Promise<void>;
+}
+
+interface PutObjectOptions {
+    bucketName: string;
+    key: string;
+    workspaceName?: string;
+    contentType?: string | null;
+    metadata?: JsonValue;
+    checksum?: false | 'sha256' | {
+        file?: string;
+        chunks?: Record<number, string>;
+    };
+    resume?: boolean;
+    resumeKey?: string;
+    overwrite?: boolean;
+    visibility?: 'public' | 'private';
+    chunkSize?: number;
+    signal?: AbortSignal;
+    onProgress?: (event: UploadProgressEvent) => void;
+}
+interface UploadFileOptions extends Omit<PutObjectOptions, 'key'> {
+    key?: string;
+}
+interface UploadProgressEvent {
+    uploadId: string;
+    chunkIndex?: number;
+    uploadedChunks: number;
+    totalChunks: number;
+    uploadedSize: number;
+    fileSize: number;
+    progress: number;
+}
+interface UploadObjectResult extends CompleteUploadResponse {
+    uploadId: string;
+    fileId: string;
+    publicId?: string;
+    visibility?: 'public' | 'private' | string;
+    url?: string;
+    expiresAt?: string | null;
+}
+declare class Uploader {
+    private readonly uploads;
+    private readonly resumeStore?;
+    constructor(uploads: UploadApi, resumeStore?: ResumeStore | undefined);
+    putObject(source: UploadSource, options: PutObjectOptions): Promise<UploadObjectResult>;
+    private chunkChecksum;
+}
+
+interface UStorageClientOptions {
+    uploadBaseUrl: string;
+    authHeaders?: AuthHeadersProvider;
+    uploadHttpClient?: HttpClient;
+    resumeStore?: ResumeStore;
+}
+declare class UStorageCoreClient {
+    readonly uploads: UploadApi;
+    private readonly uploader;
+    constructor(options: UStorageClientOptions);
+    getObjectUrl(input: GetObjectUrlInput): Promise<GetObjectUrlResult>;
+    getSignedUrl(input: GetObjectUrlInput): Promise<GetObjectUrlResult>;
+    protected uploadSource(source: UploadSource, options: PutObjectOptions): Promise<UploadObjectResult>;
+}
+
+declare class UStorageError extends Error {
+    readonly code: string;
+    readonly status: number;
+    readonly requestId?: string;
+    readonly details?: unknown;
+    constructor(message: string, options: {
+        code: string;
+        status: number;
+        requestId?: string;
+        details?: unknown;
+    });
+}
+declare function toUStorageError(status: number, body: unknown): UStorageError;
+
+export { type AuthHeadersProvider, type BearerAuth, type BrowserAuth, type CompleteUploadRequest, type CompleteUploadResponse, type CreateFileUrlRequest, type CreateFileUrlResponse, type CreateUploadSessionRequest, type CreateUploadSessionResponse, type CreateUploadTokenRequest, type CreateUploadTokenResponse, type ErrorResponse, FetchHttpClient, type GetObjectUrlInput, type GetObjectUrlResult, type HeaderValue, type HttpClient, type HttpRequestOptions, type JsonValue, MemoryResumeStore, type NodeCredentialAuth, type PutObjectOptions, type ResumeStore, type UStorageClientOptions, UStorageCoreClient, UStorageError, UploadApi, type UploadBody, type UploadChunk, type UploadChunkResponse, type UploadFileOptions, type UploadObjectResult, type UploadProgressEvent, type UploadSource, type UploadStatus, type UploadStatusResponse, Uploader, resolveToken, toUStorageError };