@unisource/sdk 0.1.2 → 0.3.0

package/src/folders.ts

@@ -0,0 +1,97 @@
+import { z } from 'zod';
+import { nonEmptyString, positiveInt, FILES_MAX_LIMIT } from './primitives';
+
+// ─── Folder record ────────────────────────────────────────────────────────────
+
+export const folderSchema = z.object({
+  id: nonEmptyString,
+  service_id: nonEmptyString,
+  user_id: nonEmptyString,
+  parent_id: nonEmptyString.nullable(),
+  name: nonEmptyString,
+  color_tag: z.string().nullable(),
+  is_trashed: z.boolean(),
+  trashed_at: positiveInt.nullable(),
+  created_at: positiveInt,
+  updated_at: positiveInt,
+});
+export type Folder = z.infer<typeof folderSchema>;
+
+// ─── List ─────────────────────────────────────────────────────────────────────
+
+export const folderListQuerySchema = z
+  .object({
+    parent_id: nonEmptyString.nullable().optional(),
+    trashed: z.boolean().optional(),
+    is_trashed: z.boolean().optional(),
+    cursor: nonEmptyString.optional(),
+    limit: z.number().int().min(1).max(FILES_MAX_LIMIT).optional(),
+  })
+  .refine(
+    (v) => !(v.trashed !== undefined && v.is_trashed !== undefined),
+    { message: 'Use either trashed or is_trashed, not both' }
+  );
+export type FolderListQuery = z.infer<typeof folderListQuerySchema>;
+
+export const folderListResponseSchema = z.object({
+  items: z.array(folderSchema),
+  next_cursor: z.string().nullable(),
+  limit: positiveInt,
+});
+export type FolderListResponse = z.infer<typeof folderListResponseSchema>;
+
+// ─── Create ───────────────────────────────────────────────────────────────────
+
+export const folderCreateRequestSchema = z.object({
+  name: nonEmptyString,
+  parent_id: nonEmptyString.optional(),
+  color_tag: z.string().optional(),
+});
+export type FolderCreateRequest = z.infer<typeof folderCreateRequestSchema>;
+
+export const folderCreateResponseSchema = z.object({
+  folder: folderSchema,
+});
+export type FolderCreateResponse = z.infer<typeof folderCreateResponseSchema>;
+
+// ─── Update ───────────────────────────────────────────────────────────────────
+
+export const folderUpdateRequestSchema = z
+  .object({
+    name: nonEmptyString.optional(),
+    color_tag: z.string().nullable().optional(),
+  })
+  .refine((v) => v.name !== undefined || v.color_tag !== undefined, {
+    message: 'At least one of name or color_tag must be provided',
+  });
+export type FolderUpdateRequest = z.infer<typeof folderUpdateRequestSchema>;
+
+export const folderUpdateResponseSchema = z.object({
+  folder: folderSchema,
+});
+export type FolderUpdateResponse = z.infer<typeof folderUpdateResponseSchema>;
+
+// ─── Delete ───────────────────────────────────────────────────────────────────
+
+export const folderDeleteResponseSchema = z.object({
+  success: z.literal(true),
+  id: nonEmptyString,
+  permanent: z.boolean(),
+  folders_deleted: z.number().int().nonnegative().optional(),
+});
+export type FolderDeleteResponse = z.infer<typeof folderDeleteResponseSchema>;
+
+// ─── Single folder detail ─────────────────────────────────────────────────────
+
+export const folderDetailResponseSchema = z.object({
+  folder: folderSchema,
+});
+export type FolderDetailResponse = z.infer<typeof folderDetailResponseSchema>;
+
+// ─── Restore ──────────────────────────────────────────────────────────────────
+
+export const folderRestoreResponseSchema = z.object({
+  success: z.literal(true),
+  id: nonEmptyString,
+});
+export type FolderRestoreResponse = z.infer<typeof folderRestoreResponseSchema>;

package/src/index.ts

@@ -1,125 +1,198 @@
-import { z } from 'zod';
-
-export const FILES_DEFAULT_LIMIT = 25;
-export const FILES_MAX_LIMIT = 100;
-
-const nonEmptyStringSchema = z.string().trim().min(1);
-const positiveIntegerSchema = z.number().int().positive();
-
-export const uploadDestinationSchema = z.enum(['r2', 'appwrite']);
-export type UploadDestination = z.infer<typeof uploadDestinationSchema>;
-
-export const uploadStatusSchema = z.enum(['pending', 'completed', 'failed']);
-export type UploadStatus = z.infer<typeof uploadStatusSchema>;
-
-export const apiErrorSchema = z.object({
-  error: nonEmptyStringSchema,
-  message: nonEmptyStringSchema,
-});
-export type ApiError = z.infer<typeof apiErrorSchema>;
-
-export const uploadR2InitRequestSchema = z.object({
-  filename: nonEmptyStringSchema,
-  size: positiveIntegerSchema,
-  mime_type: nonEmptyStringSchema,
-  bucket: nonEmptyStringSchema.optional(),
-});
-export type UploadR2InitRequest = z.infer<typeof uploadR2InitRequestSchema>;
-
-export const uploadR2InitResponseSchema = z.object({
-  upload_id: nonEmptyStringSchema,
-  destination: z.literal('r2'),
-  presigned_url: z.string().url(),
-  storage_key: nonEmptyStringSchema,
-  bucket: nonEmptyStringSchema,
-  expires_at: positiveIntegerSchema,
-});
-export type UploadR2InitResponse = z.infer<typeof uploadR2InitResponseSchema>;
-
-export const uploadAppwriteInitRequestSchema = z.object({
-  filename: nonEmptyStringSchema,
-  size: positiveIntegerSchema,
-  mime_type: nonEmptyStringSchema,
-});
-export type UploadAppwriteInitRequest = z.infer<typeof uploadAppwriteInitRequestSchema>;
-
-export const uploadAppwriteInitResponseSchema = z.object({
-  upload_id: nonEmptyStringSchema,
-  destination: z.literal('appwrite'),
-  appwrite_endpoint: z.string().url(),
-  appwrite_project_id: nonEmptyStringSchema,
-  appwrite_bucket_id: nonEmptyStringSchema,
-  file_id: nonEmptyStringSchema,
-  expires_at: positiveIntegerSchema,
-});
-export type UploadAppwriteInitResponse = z.infer<typeof uploadAppwriteInitResponseSchema>;
-
-export const uploadLifecycleRequestSchema = z.object({
-  upload_id: nonEmptyStringSchema,
-});
-export type UploadLifecycleRequest = z.infer<typeof uploadLifecycleRequestSchema>;
-
-export const uploadCompleteResponseSchema = z.object({
-  success: z.literal(true),
-  upload_id: nonEmptyStringSchema,
-  status: z.literal('completed'),
-});
-export type UploadCompleteResponse = z.infer<typeof uploadCompleteResponseSchema>;
-
-export const uploadFailResponseSchema = z.object({
-  success: z.literal(true),
-  upload_id: nonEmptyStringSchema,
-  status: z.literal('failed'),
-});
-export type UploadFailResponse = z.infer<typeof uploadFailResponseSchema>;
-
-export const fileRecordSchema = z.object({
-  id: nonEmptyStringSchema,
-  filename: nonEmptyStringSchema,
-  size: positiveIntegerSchema,
-  mime_type: nonEmptyStringSchema,
-  destination: uploadDestinationSchema,
-  storage_key: nonEmptyStringSchema,
-  bucket: nonEmptyStringSchema,
-  status: uploadStatusSchema,
-  expires_at: positiveIntegerSchema,
-  created_at: positiveIntegerSchema,
-  updated_at: positiveIntegerSchema,
-});
-export type FileRecord = z.infer<typeof fileRecordSchema>;
-
-export const filesListQuerySchema = z.object({
-  limit: z.number().int().min(1).max(FILES_MAX_LIMIT).optional(),
-  cursor: nonEmptyStringSchema.optional(),
-  destination: uploadDestinationSchema.optional(),
-  status: uploadStatusSchema.optional(),
-});
-export type FilesListQuery = z.infer<typeof filesListQuerySchema>;
-
-export const filesListResponseSchema = z.object({
-  items: z.array(fileRecordSchema),
-  next_cursor: z.string().nullable(),
-  limit: z.number().int().min(1).max(FILES_MAX_LIMIT),
-});
-export type FilesListResponse = z.infer<typeof filesListResponseSchema>;
-
-export const fileDetailsResponseSchema = z.object({
-  file: fileRecordSchema,
-});
-export type FileDetailsResponse = z.infer<typeof fileDetailsResponseSchema>;
-
-export const fileDownloadUrlResponseSchema = z.object({
-  upload_id: nonEmptyStringSchema,
-  destination: uploadDestinationSchema,
-  download_url: z.string().url(),
-  expires_at: positiveIntegerSchema,
-});
-export type FileDownloadUrlResponse = z.infer<typeof fileDownloadUrlResponseSchema>;
-
-export const fileDeleteResponseSchema = z.object({
-  success: z.literal(true),
-  upload_id: nonEmptyStringSchema,
-  destination: uploadDestinationSchema,
-  storage_not_found: z.boolean(),
-});
-export type FileDeleteResponse = z.infer<typeof fileDeleteResponseSchema>;
+// ─── Primitives ───────────────────────────────────────────────────────────────
+export {
+  nonEmptyString,
+  positiveInt,
+  unixTimestamp,
+  uploadDestinationSchema,
+  uploadStatusSchema,
+  apiErrorSchema,
+  FILES_DEFAULT_LIMIT,
+  FILES_MAX_LIMIT,
+} from './primitives';
+export type { UploadDestination, UploadStatus, ApiError } from './primitives';
+
+
+// ─── Upload ───────────────────────────────────────────────────────────────────
+export {
+  uploadR2InitRequestSchema,
+  uploadR2InitResponseSchema,
+  uploadAppwriteInitRequestSchema,
+  uploadAppwriteInitResponseSchema,
+  uploadLifecycleRequestSchema,
+  uploadCompleteResponseSchema,
+  uploadFailResponseSchema,
+  uploadRecordSchema,
+  uploadsListResponseSchema,
+  uploadRecordDetailResponseSchema,
+} from './uploads';
+export type {
+  UploadR2InitRequest,
+  UploadR2InitResponse,
+  UploadAppwriteInitRequest,
+  UploadAppwriteInitResponse,
+  UploadLifecycleRequest,
+  UploadCompleteResponse,
+  UploadFailResponse,
+  UploadRecord,
+  UploadsListResponse,
+  UploadRecordDetailResponse,
+} from './uploads';
+
+// ─── File Records ─────────────────────────────────────────────────────────────
+export {
+  fileRecordSchema,
+  fileRecordsListQuerySchema,
+  fileRecordsListResponseSchema,
+  fileRecordDetailResponseSchema,
+  fileMoveRequestSchema,
+  fileDownloadUrlResponseSchema,
+  fileDeleteResponseSchema,
+  fileRestoreResponseSchema,
+  fileUpdateRequestSchema,
+  fileUpdateResponseSchema,
+} from './fileRecords';
+export type {
+  FileRecord,
+  FileRecordsListQuery,
+  FileRecordsListResponse,
+  FileRecordDetailResponse,
+  FileMoveRequest,
+  FileDownloadUrlResponse,
+  FileDeleteResponse,
+  FileRestoreResponse,
+  FileUpdateRequest,
+  FileUpdateResponse,
+} from './fileRecords';
+
+// ─── Folders ─────────────────────────────────────────────────────────────────
+export {
+  folderSchema,
+  folderListQuerySchema,
+  folderListResponseSchema,
+  folderDetailResponseSchema,
+  folderCreateRequestSchema,
+  folderCreateResponseSchema,
+  folderUpdateRequestSchema,
+  folderUpdateResponseSchema,
+  folderDeleteResponseSchema,
+  folderRestoreResponseSchema,
+} from './folders';
+export type {
+  Folder,
+  FolderListQuery,
+  FolderListResponse,
+  FolderDetailResponse,
+  FolderCreateRequest,
+  FolderCreateResponse,
+  FolderUpdateRequest,
+  FolderUpdateResponse,
+  FolderDeleteResponse,
+  FolderRestoreResponse,
+} from './folders';
+
+// ─── Services & Audit ─────────────────────────────────────────────────────────
+export {
+  serviceSchema,
+  serviceDetailResponseSchema,
+  adminServiceUpdateRequestSchema,
+  adminServiceUpdateResponseSchema,
+  serviceUsageResponseSchema,
+  auditEventActionSchema,
+  auditEventSchema,
+  auditLogListQuerySchema,
+  auditLogListResponseSchema,
+  adminUserSchema,
+  adminUserListResponseSchema,
+  adminUserUpdateRequestSchema,
+  adminUserUpdateResponseSchema,
+  adminUserPasswordResetRequestSchema,
+  adminUserPasswordResetResponseSchema,
+} from './services';
+export type {
+  Service,
+  ServiceDetailResponse,
+  AdminServiceUpdateRequest,
+  AdminServiceUpdateResponse,
+  ServiceUsageResponse,
+  AuditEventAction,
+  AuditEvent,
+  AuditLogListQuery,
+  AuditLogListResponse,
+  AdminUser,
+  AdminUserListResponse,
+  AdminUserUpdateRequest,
+  AdminUserUpdateResponse,
+  AdminUserPasswordResetRequest,
+  AdminUserPasswordResetResponse,
+} from './services';
+
+// ─── Main Storage ─────────────────────────────────────────────────────────────
+export * from './mainStorage';
+
+// ─── Releases ───────────────────────────────────────────────────────────────
+export {
+  releaseDTOSchema,
+  releaseUploadInitRequestSchema,
+  releaseUploadInitResponseSchema,
+  releaseUploadCompleteRequestSchema,
+  releaseUploadCompleteResponseSchema,
+  releaseUploadFailResponseSchema,
+  releasesListQuerySchema,
+  releasesListResponseSchema,
+  releaseUpdateRequestSchema,
+  releaseDeleteResponseSchema,
+  releaseSyncManifestSchema,
+  releaseSyncRequestSchema,
+  releaseSyncResultSchema,
+  releaseSyncResponseSchema,
+} from './releases';
+export type {
+  ReleaseDTO,
+  ReleaseUploadInitRequest,
+  ReleaseUploadInitResponse,
+  ReleaseUploadCompleteRequest,
+  ReleaseUploadCompleteResponse,
+  ReleaseUploadFailResponse,
+  ReleasesListQuery,
+  ReleasesListResponse,
+  ReleaseUpdateRequest,
+  ReleaseDeleteResponse,
+  ReleaseSyncManifest,
+  ReleaseSyncRequest,
+  ReleaseSyncResult,
+  ReleaseSyncResponse,
+} from './releases';
+
+// ─── Share Links ─────────────────────────────────────────────────────────────
+export {
+  shareLinkSchema,
+  shareLinkCreateRequestSchema,
+  shareLinkUpdateRequestSchema,
+  shareLinkListResponseSchema,
+  shareLinkCreateResponseSchema,
+  shareLinkUpdateResponseSchema,
+  shareLinkDeleteResponseSchema,
+  publicFileAccessResponseSchema,
+  publicFileLockedResponseSchema,
+} from './shareLinks';
+export type {
+  ShareLink,
+  ShareLinkCreateRequest,
+  ShareLinkUpdateRequest,
+  ShareLinkListResponse,
+  ShareLinkCreateResponse,
+  ShareLinkUpdateResponse,
+  ShareLinkDeleteResponse,
+  PublicFileAccessResponse,
+  PublicFileLockedResponse,
+} from './shareLinks';
+
+// ─── HTTP Client ─────────────────────────────────────────────────────────────
+export {
+  UnisourceClient,
+  UnisourceError,
+  UnisourceNetworkError,
+  getPublicFileInfo,
+  unlockPublicFile,
+} from './client';
+export type { UnisourceClientConfig } from './client';

package/src/mainStorage.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+import { nonEmptyString } from './primitives';
+import { fileRecordSchema } from './fileRecords';
+
+// ─── List ──────────────────────────────────────────────────────────────────────
+
+export const mainStorageListQuerySchema = z.object({
+  limit: z.number().int().positive().optional(),
+  cursor: nonEmptyString.optional(),
+});
+export type MainStorageListQuery = z.infer<typeof mainStorageListQuerySchema>;
+
+export const mainStorageListResponseSchema = z.object({
+  items: z.array(fileRecordSchema),
+  next_cursor: z.string().nullable(),
+});
+export type MainStorageListResponse = z.infer<typeof mainStorageListResponseSchema>;
+
+// ─── Rename ────────────────────────────────────────────────────────────────────
+
+export const mainStorageRenameRequestSchema = z.object({
+  filename: nonEmptyString,
+});
+export type MainStorageRenameRequest = z.infer<typeof mainStorageRenameRequestSchema>;
+
+// ─── Delete ────────────────────────────────────────────────────────────────────
+
+export const mainStorageDeleteResponseSchema = z.object({
+  success: z.boolean(),
+  file_id: nonEmptyString,
+});
+export type MainStorageDeleteResponse = z.infer<typeof mainStorageDeleteResponseSchema>;
+
+// ─── Restore ───────────────────────────────────────────────────────────────────
+
+export const mainStorageRestoreResponseSchema = z.object({
+  success: z.boolean(),
+  file_id: nonEmptyString,
+});
+export type MainStorageRestoreResponse = z.infer<typeof mainStorageRestoreResponseSchema>;

package/src/primitives.ts

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+
+// ─── Primitives ─────────────────────────────────────────────────────────────
+
+export const nonEmptyString = z.string().trim().min(1);
+export const positiveInt = z.number().int().positive();
+export const unixTimestamp = z.number().int().nonnegative();
+
+// ─── Pagination constants ─────────────────────────────────────────────────────
+
+export const FILES_DEFAULT_LIMIT = 25;
+export const FILES_MAX_LIMIT = 100;
+
+// ─── Upload Destination ──────────────────────────────────────────────────────
+
+export const uploadDestinationSchema = z.enum(['r2', 'appwrite']);
+export type UploadDestination = z.infer<typeof uploadDestinationSchema>;
+
+// ─── Upload Status ────────────────────────────────────────────────────────────
+
+export const uploadStatusSchema = z.enum(['pending', 'completed', 'failed']);
+export type UploadStatus = z.infer<typeof uploadStatusSchema>;
+
+// ─── API Error ────────────────────────────────────────────────────────────────
+
+export const apiErrorSchema = z.object({
+  error: nonEmptyString,
+  message: nonEmptyString,
+});
+export type ApiError = z.infer<typeof apiErrorSchema>;

package/src/releases.ts

@@ -0,0 +1,132 @@
+import { z } from 'zod';
+import { nonEmptyString, positiveInt, uploadStatusSchema } from './primitives';
+
+const releaseIdSchema = z.string().trim().min(1).max(128);
+const releaseNameSchema = z.string().trim().min(1).max(256);
+const releaseFilenameSchema = z.string().trim().min(1).max(255);
+const releaseTagsSchema = z.array(z.string().trim().min(1).max(64)).max(32);
+const releaseNotesSchema = z.string().trim().max(10_000).nullable().optional();
+const releaseR2KeySchema = z.string().trim().min(1).max(1024);
+
+// ─── Release DTO ─────────────────────────────────────────────────────────────
+
+export const releaseDTOSchema = z.object({
+  id: nonEmptyString,
+  service_id: nonEmptyString,
+  name: nonEmptyString,
+  size: z.number().int().nonnegative(),
+  r2_key: nonEmptyString,
+  tags: z.array(nonEmptyString),
+  notes: z.string().nullable(),
+  force_update: z.boolean(),
+  uploaded_by: nonEmptyString,
+  upload_status: uploadStatusSchema,
+  created_at: nonEmptyString,
+});
+export type ReleaseDTO = z.infer<typeof releaseDTOSchema>;
+
+// ─── Upload Lifecycle ───────────────────────────────────────────────────────
+
+export const releaseUploadInitRequestSchema = z.object({
+  name: releaseNameSchema,
+  filename: releaseFilenameSchema,
+  tags: releaseTagsSchema.optional().default([]),
+  notes: releaseNotesSchema,
+  force_update: z.boolean().optional().default(false),
+});
+export type ReleaseUploadInitRequest = z.input<typeof releaseUploadInitRequestSchema>;
+
+export const releaseUploadInitResponseSchema = z.object({
+  release_id: nonEmptyString,
+  presigned_url: z.string().url(),
+  r2_key: nonEmptyString,
+  expires_at: positiveInt,
+});
+export type ReleaseUploadInitResponse = z.infer<typeof releaseUploadInitResponseSchema>;
+
+export const releaseUploadCompleteRequestSchema = z.object({
+  release_id: releaseIdSchema,
+  size: z.number().int().nonnegative(),
+});
+export type ReleaseUploadCompleteRequest = z.infer<typeof releaseUploadCompleteRequestSchema>;
+
+export const releaseUploadCompleteResponseSchema = z.object({
+  success: z.literal(true),
+  release_id: nonEmptyString,
+  status: z.literal('completed'),
+});
+export type ReleaseUploadCompleteResponse = z.infer<typeof releaseUploadCompleteResponseSchema>;
+
+export const releaseUploadFailResponseSchema = z.object({
+  success: z.literal(true),
+  release_id: nonEmptyString,
+  status: z.literal('failed'),
+});
+export type ReleaseUploadFailResponse = z.infer<typeof releaseUploadFailResponseSchema>;
+
+// ─── List ───────────────────────────────────────────────────────────────────
+
+export const releasesListQuerySchema = z.object({
+  limit: z.number().int().positive().max(100).optional(),
+  cursor: nonEmptyString.optional(),
+});
+export type ReleasesListQuery = z.infer<typeof releasesListQuerySchema>;
+
+export const releasesListResponseSchema = z.object({
+  items: z.array(releaseDTOSchema),
+  next_cursor: z.string().nullable(),
+});
+export type ReleasesListResponse = z.infer<typeof releasesListResponseSchema>;
+
+// ─── Update ─────────────────────────────────────────────────────────────────
+
+export const releaseUpdateRequestSchema = z
+  .object({
+    name: releaseNameSchema.optional(),
+    tags: releaseTagsSchema.optional(),
+    notes: releaseNotesSchema,
+    force_update: z.boolean().optional(),
+  })
+  .refine((body) => Object.values(body).some((value) => value !== undefined), {
+    message: 'At least one field must be provided',
+  });
+export type ReleaseUpdateRequest = z.infer<typeof releaseUpdateRequestSchema>;
+
+// ─── Delete ─────────────────────────────────────────────────────────────────
+
+export const releaseDeleteResponseSchema = z.object({
+  success: z.literal(true),
+  release_id: nonEmptyString,
+});
+export type ReleaseDeleteResponse = z.infer<typeof releaseDeleteResponseSchema>;
+
+// ─── Sync ───────────────────────────────────────────────────────────────────
+
+export const releaseSyncManifestSchema = z.object({
+  id: releaseIdSchema.optional(),
+  name: releaseNameSchema,
+  r2_key: releaseR2KeySchema,
+  size: z.number().int().nonnegative(),
+  tags: releaseTagsSchema.optional().default([]),
+  notes: releaseNotesSchema,
+  force_update: z.boolean().optional().default(false),
+});
+export type ReleaseSyncManifest = z.input<typeof releaseSyncManifestSchema>;
+
+export const releaseSyncRequestSchema = z.object({
+  releases: z.array(releaseSyncManifestSchema).min(1).max(100),
+});
+export type ReleaseSyncRequest = z.input<typeof releaseSyncRequestSchema>;
+
+export const releaseSyncResultSchema = z.object({
+  release_id: nonEmptyString,
+  success: z.boolean(),
+  status: uploadStatusSchema,
+});
+export type ReleaseSyncResult = z.infer<typeof releaseSyncResultSchema>;
+
+export const releaseSyncResponseSchema = z.object({
+  synced: z.number().int().nonnegative(),
+  results: z.array(releaseSyncResultSchema),
+});
+export type ReleaseSyncResponse = z.infer<typeof releaseSyncResponseSchema>;