@unisource/sdk 0.2.0 → 0.3.0

package/dist/index.d.ts

@@ -1,478 +0,0 @@
-import { z } from "zod";
-
-//#region src/primitives.d.ts
-declare const nonEmptyString: z.ZodString;
-declare const positiveInt: z.ZodNumber;
-declare const unixTimestamp: z.ZodNumber;
-declare const uploadDestinationSchema: z.ZodEnum<{
-  appwrite: "appwrite";
-  r2: "r2";
-}>;
-type UploadDestination = z.infer<typeof uploadDestinationSchema>;
-declare const uploadStatusSchema: z.ZodEnum<{
-  completed: "completed";
-  failed: "failed";
-  pending: "pending";
-}>;
-type UploadStatus = z.infer<typeof uploadStatusSchema>;
-declare const apiErrorSchema: z.ZodObject<{
-  error: z.ZodString;
-  message: z.ZodString;
-}, z.core.$strip>;
-type ApiError = z.infer<typeof apiErrorSchema>;
-//#endregion
-//#region src/uploads.d.ts
-declare const uploadR2InitRequestSchema: z.ZodObject<{
-  filename: z.ZodString;
-  size: z.ZodNumber;
-  mime_type: z.ZodString;
-}, z.core.$strip>;
-type UploadR2InitRequest = z.infer<typeof uploadR2InitRequestSchema>;
-declare const uploadR2InitResponseSchema: z.ZodObject<{
-  upload_id: z.ZodString;
-  destination: z.ZodLiteral<"r2">;
-  presigned_url: z.ZodString;
-  storage_key: z.ZodString;
-  bucket: z.ZodString;
-  expires_at: z.ZodNumber;
-}, z.core.$strip>;
-type UploadR2InitResponse = z.infer<typeof uploadR2InitResponseSchema>;
-declare const uploadAppwriteInitRequestSchema: z.ZodObject<{
-  filename: z.ZodString;
-  size: z.ZodNumber;
-  mime_type: z.ZodString;
-}, z.core.$strip>;
-type UploadAppwriteInitRequest = z.infer<typeof uploadAppwriteInitRequestSchema>;
-declare const uploadAppwriteInitResponseSchema: z.ZodObject<{
-  upload_id: z.ZodString;
-  destination: z.ZodLiteral<"appwrite">;
-  appwrite_endpoint: z.ZodString;
-  appwrite_project_id: z.ZodString;
-  appwrite_bucket_id: z.ZodString;
-  file_id: z.ZodString;
-  expires_at: z.ZodNumber;
-}, z.core.$strip>;
-type UploadAppwriteInitResponse = z.infer<typeof uploadAppwriteInitResponseSchema>;
-declare const uploadLifecycleRequestSchema: z.ZodObject<{
-  upload_id: z.ZodString;
-}, z.core.$strip>;
-type UploadLifecycleRequest = z.infer<typeof uploadLifecycleRequestSchema>;
-declare const uploadCompleteResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  upload_id: z.ZodString;
-  status: z.ZodLiteral<"completed">;
-}, z.core.$strip>;
-type UploadCompleteResponse = z.infer<typeof uploadCompleteResponseSchema>;
-declare const uploadFailResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  upload_id: z.ZodString;
-  status: z.ZodLiteral<"failed">;
-}, z.core.$strip>;
-type UploadFailResponse = z.infer<typeof uploadFailResponseSchema>;
-declare const FILES_DEFAULT_LIMIT = 25;
-declare const FILES_MAX_LIMIT = 100;
-/** Raw upload record — returned by admin `/files` endpoints. */
-declare const uploadRecordSchema: z.ZodObject<{
-  id: z.ZodString;
-  service_id: z.ZodString;
-  user_id: z.ZodNullable<z.ZodString>;
-  filename: z.ZodString;
-  size: z.ZodNumber;
-  mime_type: z.ZodString;
-  destination: z.ZodEnum<{
-    appwrite: "appwrite";
-    r2: "r2";
-  }>;
-  status: z.ZodEnum<{
-    completed: "completed";
-    failed: "failed";
-    pending: "pending";
-  }>;
-  expires_at: z.ZodNumber;
-  created_at: z.ZodNumber;
-  updated_at: z.ZodNumber;
-}, z.core.$strip>;
-type UploadRecord = z.infer<typeof uploadRecordSchema>;
-declare const uploadsListResponseSchema: z.ZodObject<{
-  items: z.ZodArray<z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodNullable<z.ZodString>;
-    filename: z.ZodString;
-    size: z.ZodNumber;
-    mime_type: z.ZodString;
-    destination: z.ZodEnum<{
-      appwrite: "appwrite";
-      r2: "r2";
-    }>;
-    status: z.ZodEnum<{
-      completed: "completed";
-      failed: "failed";
-      pending: "pending";
-    }>;
-    expires_at: z.ZodNumber;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>>;
-  next_cursor: z.ZodNullable<z.ZodString>;
-  limit: z.ZodNumber;
-}, z.core.$strip>;
-type UploadsListResponse = z.infer<typeof uploadsListResponseSchema>;
-//#endregion
-//#region src/fileRecords.d.ts
-/**
- * A confirmed file record owned by a user.
- * Internal fields (storage_key, bucket) are intentionally excluded from the public API.
- */
-declare const fileRecordSchema: z.ZodObject<{
-  id: z.ZodString;
-  service_id: z.ZodString;
-  user_id: z.ZodString;
-  folder_id: z.ZodNullable<z.ZodString>;
-  upload_id: z.ZodNullable<z.ZodString>;
-  filename: z.ZodString;
-  size: z.ZodNumber;
-  mime_type: z.ZodString;
-  storage_destination: z.ZodEnum<{
-    appwrite: "appwrite";
-    r2: "r2";
-  }>;
-  is_trashed: z.ZodBoolean;
-  trashed_at: z.ZodNullable<z.ZodNumber>;
-  created_at: z.ZodNumber;
-  updated_at: z.ZodNumber;
-}, z.core.$strip>;
-type FileRecord = z.infer<typeof fileRecordSchema>;
-declare const fileRecordsListQuerySchema: z.ZodObject<{
-  folder_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-  is_trashed: z.ZodOptional<z.ZodBoolean>;
-  cursor: z.ZodOptional<z.ZodString>;
-  limit: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-type FileRecordsListQuery = z.infer<typeof fileRecordsListQuerySchema>;
-declare const fileRecordsListResponseSchema: z.ZodObject<{
-  items: z.ZodArray<z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    folder_id: z.ZodNullable<z.ZodString>;
-    upload_id: z.ZodNullable<z.ZodString>;
-    filename: z.ZodString;
-    size: z.ZodNumber;
-    mime_type: z.ZodString;
-    storage_destination: z.ZodEnum<{
-      appwrite: "appwrite";
-      r2: "r2";
-    }>;
-    is_trashed: z.ZodBoolean;
-    trashed_at: z.ZodNullable<z.ZodNumber>;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>>;
-  next_cursor: z.ZodNullable<z.ZodString>;
-  limit: z.ZodNumber;
-}, z.core.$strip>;
-type FileRecordsListResponse = z.infer<typeof fileRecordsListResponseSchema>;
-declare const fileRecordDetailResponseSchema: z.ZodObject<{
-  file: z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    folder_id: z.ZodNullable<z.ZodString>;
-    upload_id: z.ZodNullable<z.ZodString>;
-    filename: z.ZodString;
-    size: z.ZodNumber;
-    mime_type: z.ZodString;
-    storage_destination: z.ZodEnum<{
-      appwrite: "appwrite";
-      r2: "r2";
-    }>;
-    is_trashed: z.ZodBoolean;
-    trashed_at: z.ZodNullable<z.ZodNumber>;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>;
-}, z.core.$strip>;
-type FileRecordDetailResponse = z.infer<typeof fileRecordDetailResponseSchema>;
-declare const fileMoveRequestSchema: z.ZodObject<{
-  folder_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-type FileMoveRequest = z.infer<typeof fileMoveRequestSchema>;
-declare const fileDownloadUrlResponseSchema: z.ZodObject<{
-  upload_id: z.ZodString;
-  destination: z.ZodEnum<{
-    appwrite: "appwrite";
-    r2: "r2";
-  }>;
-  download_url: z.ZodString;
-  expires_at: z.ZodNumber;
-}, z.core.$strip>;
-type FileDownloadUrlResponse = z.infer<typeof fileDownloadUrlResponseSchema>;
-declare const fileDeleteResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  id: z.ZodString;
-  permanent: z.ZodBoolean;
-}, z.core.$strip>;
-type FileDeleteResponse = z.infer<typeof fileDeleteResponseSchema>;
-declare const fileRestoreResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  id: z.ZodString;
-}, z.core.$strip>;
-type FileRestoreResponse = z.infer<typeof fileRestoreResponseSchema>;
-//#endregion
-//#region src/folders.d.ts
-declare const folderSchema: z.ZodObject<{
-  id: z.ZodString;
-  service_id: z.ZodString;
-  user_id: z.ZodString;
-  parent_id: z.ZodNullable<z.ZodString>;
-  name: z.ZodString;
-  color_tag: z.ZodNullable<z.ZodString>;
-  is_trashed: z.ZodBoolean;
-  trashed_at: z.ZodNullable<z.ZodNumber>;
-  created_at: z.ZodNumber;
-  updated_at: z.ZodNumber;
-}, z.core.$strip>;
-type Folder = z.infer<typeof folderSchema>;
-declare const folderListQuerySchema: z.ZodObject<{
-  parent_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-  is_trashed: z.ZodOptional<z.ZodBoolean>;
-  cursor: z.ZodOptional<z.ZodString>;
-  limit: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-type FolderListQuery = z.infer<typeof folderListQuerySchema>;
-declare const folderListResponseSchema: z.ZodObject<{
-  items: z.ZodArray<z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    parent_id: z.ZodNullable<z.ZodString>;
-    name: z.ZodString;
-    color_tag: z.ZodNullable<z.ZodString>;
-    is_trashed: z.ZodBoolean;
-    trashed_at: z.ZodNullable<z.ZodNumber>;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>>;
-  next_cursor: z.ZodNullable<z.ZodString>;
-  limit: z.ZodNumber;
-}, z.core.$strip>;
-type FolderListResponse = z.infer<typeof folderListResponseSchema>;
-declare const folderCreateRequestSchema: z.ZodObject<{
-  name: z.ZodString;
-  parent_id: z.ZodOptional<z.ZodString>;
-  color_tag: z.ZodOptional<z.ZodString>;
-}, z.core.$strip>;
-type FolderCreateRequest = z.infer<typeof folderCreateRequestSchema>;
-declare const folderCreateResponseSchema: z.ZodObject<{
-  folder: z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    parent_id: z.ZodNullable<z.ZodString>;
-    name: z.ZodString;
-    color_tag: z.ZodNullable<z.ZodString>;
-    is_trashed: z.ZodBoolean;
-    trashed_at: z.ZodNullable<z.ZodNumber>;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>;
-}, z.core.$strip>;
-type FolderCreateResponse = z.infer<typeof folderCreateResponseSchema>;
-declare const folderUpdateRequestSchema: z.ZodObject<{
-  name: z.ZodOptional<z.ZodString>;
-  color_tag: z.ZodOptional<z.ZodNullable<z.ZodString>>;
-}, z.core.$strip>;
-type FolderUpdateRequest = z.infer<typeof folderUpdateRequestSchema>;
-declare const folderUpdateResponseSchema: z.ZodObject<{
-  folder: z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    parent_id: z.ZodNullable<z.ZodString>;
-    name: z.ZodString;
-    color_tag: z.ZodNullable<z.ZodString>;
-    is_trashed: z.ZodBoolean;
-    trashed_at: z.ZodNullable<z.ZodNumber>;
-    created_at: z.ZodNumber;
-    updated_at: z.ZodNumber;
-  }, z.core.$strip>;
-}, z.core.$strip>;
-type FolderUpdateResponse = z.infer<typeof folderUpdateResponseSchema>;
-declare const folderDeleteResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  id: z.ZodString;
-  permanent: z.ZodBoolean;
-  folders_deleted: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-type FolderDeleteResponse = z.infer<typeof folderDeleteResponseSchema>;
-declare const folderRestoreResponseSchema: z.ZodObject<{
-  success: z.ZodLiteral<true>;
-  id: z.ZodString;
-}, z.core.$strip>;
-type FolderRestoreResponse = z.infer<typeof folderRestoreResponseSchema>;
-//#endregion
-//#region src/services.d.ts
-/** Public service info returned to admins. Never exposes secrets. */
-declare const serviceSchema: z.ZodObject<{
-  id: z.ZodString;
-  name: z.ZodString;
-  max_storage_bytes: z.ZodNumber;
-  current_used_bytes: z.ZodNumber;
-  max_file_size_bytes: z.ZodNumber;
-  created_at: z.ZodNumber;
-}, z.core.$strip>;
-type Service = z.infer<typeof serviceSchema>;
-declare const serviceDetailResponseSchema: z.ZodObject<{
-  service: z.ZodObject<{
-    id: z.ZodString;
-    name: z.ZodString;
-    max_storage_bytes: z.ZodNumber;
-    current_used_bytes: z.ZodNumber;
-    max_file_size_bytes: z.ZodNumber;
-    created_at: z.ZodNumber;
-  }, z.core.$strip>;
-}, z.core.$strip>;
-type ServiceDetailResponse = z.infer<typeof serviceDetailResponseSchema>;
-declare const serviceUsageResponseSchema: z.ZodObject<{
-  service_id: z.ZodString;
-  max_storage_bytes: z.ZodNumber;
-  current_used_bytes: z.ZodNumber;
-  used_percent: z.ZodNumber;
-}, z.core.$strip>;
-type ServiceUsageResponse = z.infer<typeof serviceUsageResponseSchema>;
-declare const auditEventActionSchema: z.ZodEnum<{
-  file_deleted: "file_deleted";
-  folder_deleted: "folder_deleted";
-  quota_exceeded: "quota_exceeded";
-  upload_completed: "upload_completed";
-}>;
-type AuditEventAction = z.infer<typeof auditEventActionSchema>;
-declare const auditEventSchema: z.ZodObject<{
-  id: z.ZodString;
-  service_id: z.ZodString;
-  user_id: z.ZodString;
-  action: z.ZodEnum<{
-    file_deleted: "file_deleted";
-    folder_deleted: "folder_deleted";
-    quota_exceeded: "quota_exceeded";
-    upload_completed: "upload_completed";
-  }>;
-  resource_type: z.ZodEnum<{
-    file: "file";
-    folder: "folder";
-    service: "service";
-  }>;
-  resource_id: z.ZodString;
-  metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-  ip_address: z.ZodNullable<z.ZodString>;
-  created_at: z.ZodNumber;
-}, z.core.$strip>;
-type AuditEvent = z.infer<typeof auditEventSchema>;
-declare const auditLogListQuerySchema: z.ZodObject<{
-  user_id: z.ZodOptional<z.ZodString>;
-  action: z.ZodOptional<z.ZodEnum<{
-    file_deleted: "file_deleted";
-    folder_deleted: "folder_deleted";
-    quota_exceeded: "quota_exceeded";
-    upload_completed: "upload_completed";
-  }>>;
-  resource_type: z.ZodOptional<z.ZodEnum<{
-    file: "file";
-    folder: "folder";
-    service: "service";
-  }>>;
-  cursor: z.ZodOptional<z.ZodString>;
-  limit: z.ZodOptional<z.ZodNumber>;
-}, z.core.$strip>;
-type AuditLogListQuery = z.infer<typeof auditLogListQuerySchema>;
-declare const auditLogListResponseSchema: z.ZodObject<{
-  items: z.ZodArray<z.ZodObject<{
-    id: z.ZodString;
-    service_id: z.ZodString;
-    user_id: z.ZodString;
-    action: z.ZodEnum<{
-      file_deleted: "file_deleted";
-      folder_deleted: "folder_deleted";
-      quota_exceeded: "quota_exceeded";
-      upload_completed: "upload_completed";
-    }>;
-    resource_type: z.ZodEnum<{
-      file: "file";
-      folder: "folder";
-      service: "service";
-    }>;
-    resource_id: z.ZodString;
-    metadata: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
-    ip_address: z.ZodNullable<z.ZodString>;
-    created_at: z.ZodNumber;
-  }, z.core.$strip>>;
-  next_cursor: z.ZodNullable<z.ZodString>;
-  limit: z.ZodNumber;
-}, z.core.$strip>;
-type AuditLogListResponse = z.infer<typeof auditLogListResponseSchema>;
-//#endregion
-//#region src/client.d.ts
-declare class UnisourceError extends Error {
-  readonly status: number;
-  readonly body: ApiError;
-  constructor(message: string, status: number, body: ApiError);
-}
-declare class UnisourceNetworkError extends Error {
-  readonly cause: unknown;
-  constructor(message: string, cause: unknown);
-}
-interface UnisourceClientConfig {
-  /** Base URL of the UniSource API, e.g. https://api.usrc.dev */
-  baseUrl: string;
-  /** Service identifier — tells the backend which service this client belongs to */
-  serviceId: string;
-  /**
-   * Returns a fresh JWT or API key for each request.
-   * Return null/undefined to send unauthenticated requests.
-   */
-  getToken: () => string | null | undefined | Promise<string | null | undefined>;
-}
-declare class UnisourceClient {
-  private config;
-  constructor(config: UnisourceClientConfig);
-  readonly upload: {
-    /** Initiate an R2 upload — returns a presigned PUT URL */r2Init: (body: UploadR2InitRequest) => Promise<UploadR2InitResponse>; /** Initiate an Appwrite upload — returns credentials for direct SDK upload */
-    appwriteInit: (body: UploadAppwriteInitRequest) => Promise<UploadAppwriteInitResponse>; /** Confirm that the file was successfully uploaded to storage */
-    complete: (body: UploadLifecycleRequest) => Promise<UploadCompleteResponse>; /** Mark an upload as failed and release reserved quota */
-    fail: (body: UploadLifecycleRequest) => Promise<UploadFailResponse>;
-  };
-  readonly myFiles: {
-    /** List files owned by the authenticated user */list: (query?: FileRecordsListQuery) => Promise<FileRecordsListResponse>; /** Get a single file record */
-    get: (id: string) => Promise<FileRecordDetailResponse>; /** Get a time-limited download URL (never cached by proxy) */
-    downloadUrl: (id: string) => Promise<FileDownloadUrlResponse>; /** Move file to a different folder (null = root) */
-    move: (id: string, body: FileMoveRequest) => Promise<{
-      file: FileRecord;
-    }>; /** Soft-delete (move to trash) or permanently delete */
-    delete: (id: string, query?: {
-      permanent?: boolean;
-    }) => Promise<FileDeleteResponse>; /** Restore a file from trash */
-    restore: (id: string) => Promise<FileRestoreResponse>;
-  };
-  readonly folders: {
-    /** List folders owned by the authenticated user */list: (query?: FolderListQuery) => Promise<FolderListResponse>; /** Create a new folder */
-    create: (body: FolderCreateRequest) => Promise<FolderCreateResponse>; /** Update folder name or color tag */
-    update: (id: string, body: FolderUpdateRequest) => Promise<FolderUpdateResponse>; /** Soft-delete or permanently delete a folder and its contents */
-    delete: (id: string, query?: {
-      permanent?: boolean;
-    }) => Promise<FolderDeleteResponse>; /** Restore a folder from trash */
-    restore: (id: string) => Promise<FolderRestoreResponse>;
-  };
-  readonly admin: {
-    /** Get service info and quota limits */serviceDetail: () => Promise<ServiceDetailResponse>; /** Get real-time storage usage for the service */
-    usage: () => Promise<ServiceUsageResponse>; /** List all uploads (pending/completed/failed) for this service */
-    listUploads: (query?: {
-      status?: string;
-      cursor?: string;
-      limit?: number;
-    }) => Promise<UploadsListResponse>; /** List audit log events for this service */
-    auditLog: (query?: AuditLogListQuery) => Promise<AuditLogListResponse>;
-  };
-}
-//#endregion
-export { type ApiError, type AuditEvent, type AuditEventAction, type AuditLogListQuery, type AuditLogListResponse, FILES_DEFAULT_LIMIT, FILES_MAX_LIMIT, type FileDeleteResponse, type FileDownloadUrlResponse, type FileMoveRequest, type FileRecord, type FileRecordDetailResponse, type FileRecordsListQuery, type FileRecordsListResponse, type FileRestoreResponse, type Folder, type FolderCreateRequest, type FolderCreateResponse, type FolderDeleteResponse, type FolderListQuery, type FolderListResponse, type FolderRestoreResponse, type FolderUpdateRequest, type FolderUpdateResponse, type Service, type ServiceDetailResponse, type ServiceUsageResponse, UnisourceClient, type UnisourceClientConfig, UnisourceError, UnisourceNetworkError, type UploadAppwriteInitRequest, type UploadAppwriteInitResponse, type UploadCompleteResponse, type UploadDestination, type UploadFailResponse, type UploadLifecycleRequest, type UploadR2InitRequest, type UploadR2InitResponse, type UploadRecord, type UploadStatus, type UploadsListResponse, apiErrorSchema, auditEventActionSchema, auditEventSchema, auditLogListQuerySchema, auditLogListResponseSchema, fileDeleteResponseSchema, fileDownloadUrlResponseSchema, fileMoveRequestSchema, fileRecordDetailResponseSchema, fileRecordSchema, fileRecordsListQuerySchema, fileRecordsListResponseSchema, fileRestoreResponseSchema, folderCreateRequestSchema, folderCreateResponseSchema, folderDeleteResponseSchema, folderListQuerySchema, folderListResponseSchema, folderRestoreResponseSchema, folderSchema, folderUpdateRequestSchema, folderUpdateResponseSchema, nonEmptyString, positiveInt, serviceDetailResponseSchema, serviceSchema, serviceUsageResponseSchema, unixTimestamp, uploadAppwriteInitRequestSchema, uploadAppwriteInitResponseSchema, uploadCompleteResponseSchema, uploadDestinationSchema, uploadFailResponseSchema, uploadLifecycleRequestSchema, uploadR2InitRequestSchema, uploadR2InitResponseSchema, uploadRecordSchema, uploadStatusSchema, uploadsListResponseSchema };

package/src/uploadDestination.ts

@@ -1,4 +0,0 @@
-import { z } from 'zod';
-
-export const uploadDestinationSchema = z.enum(['r2', 'appwrite']);
-export type UploadDestination = z.infer<typeof uploadDestinationSchema>;