@uplift-io/uplift 1.0.0 → 1.1.0

package/dist/{types-BdcszAj8.d.ts → types-Cw4fuNs_.d.ts}

@@ -15,7 +15,13 @@ type UploadedFile = {
     size: number;
     extension?: string | undefined;
     provider: string;
+    outputs?: Record<string, UploadedFile> | undefined;
 };
+type ClientUploadedFile<TOutputNames extends string = never> = UploadedFile & ([
+    TOutputNames
+] extends [never] ? object : {
+    output<TName extends TOutputNames>(name: TName): UploadedFile;
+});
 type UploadErrorCode = "FILE_TOO_LARGE" | "FILE_TOO_SMALL" | "INVALID_TYPE" | "AUTH_FAILED" | "VALIDATION_FAILED" | "UPLOAD_FAILED" | "UNKNOWN";
 declare class UploadError extends Error {
     readonly code: UploadErrorCode;
@@ -53,11 +59,34 @@ type StoragePutInput = {
 type StorageAdapter = {
     provider: string;
     put(input: StoragePutInput): Promise<UploadedFile>;
+    delete?(key: string): Promise<void>;
 };
 type Middleware<TUser = unknown> = (ctx: {
     req: Request;
 }) => TUser | Promise<TUser>;
 type UploadKind = "any" | "image" | "pdf" | "video" | "audio" | "text" | "json" | "csv" | "custom";
+type PreparedUploadFile = {
+    file: UploadInputFile;
+    body: File;
+};
+type TransformContext = PreparedUploadFile;
+type UploadTransform<TKind extends UploadKind = UploadKind> = {
+    readonly __kind?: TKind | undefined;
+    transform(ctx: TransformContext): File | PreparedUploadFile | Promise<File | PreparedUploadFile>;
+};
+type UploadTransformFunction<TKind extends UploadKind = UploadKind> = ((ctx: TransformContext) => File | PreparedUploadFile | Promise<File | PreparedUploadFile>) & {
+    readonly __kind?: TKind | undefined;
+};
+type CompatibleTransform<TKind extends UploadKind> = TKind extends "any" | "custom" ? UploadTransform<UploadKind> | UploadTransformFunction<UploadKind> : UploadTransform<TKind> | UploadTransform<"any"> | UploadTransformFunction<TKind> | UploadTransformFunction<"any">;
+type OutputContext = PreparedUploadFile & {
+    primary: UploadedFile;
+};
+type UploadOutput<TKind extends UploadKind = UploadKind, TName extends string = string> = {
+    readonly __kind?: TKind | undefined;
+    name: TName;
+    produce(ctx: OutputContext): File | PreparedUploadFile | Promise<File | PreparedUploadFile>;
+};
+type CompatibleOutput<TKind extends UploadKind, TName extends string = string> = TKind extends "any" | "custom" ? UploadOutput<UploadKind, TName> : UploadOutput<TKind, TName> | UploadOutput<"any", TName>;
 type UploadRouteDefinition = {
     kind: UploadKind;
     maxBytes?: number;
@@ -102,6 +131,8 @@ type UploadRouteDefinition = {
         min?: DurationValue;
         max?: DurationValue;
     };
+    transforms?: Array<UploadTransform | UploadTransformFunction>;
+    outputs?: Array<UploadOutput>;
 };
 type UploadRoutes = Record<string, {
     _def: UploadRouteDefinition;
@@ -119,10 +150,13 @@ type UpliftApp<TRoutes extends UploadRoutes = UploadRoutes> = {
 type IsMultiple<TRoute> = TRoute extends {
     __multiple?: infer TMultiple;
 } ? TMultiple extends true ? true : false : false;
+type OutputNames<TRoute> = TRoute extends {
+    __outputs?: infer TOutputNames;
+} ? TOutputNames extends string ? TOutputNames : never : never;
 type ClientInput<TRoute> = IsMultiple<TRoute> extends true ? File[] | FileList : File;
-type ClientOutput<TRoute> = IsMultiple<TRoute> extends true ? UploadedFile[] : UploadedFile;
+type ClientOutput<TRoute> = IsMultiple<TRoute> extends true ? Array<ClientUploadedFile<OutputNames<TRoute>>> : ClientUploadedFile<OutputNames<TRoute>>;
 type UploadClient<TApp extends UpliftApp> = {
     [TRouteName in keyof TApp["routes"] & string]: (input: ClientInput<TApp["routes"][TRouteName]>) => Promise<ClientOutput<TApp["routes"][TRouteName]>>;
 };
 
-export { type ClientInput as C, type DurationValue as D, type KeyContext as K, type Middleware as M, type SizeValue as S, type UploadKind as U, type UploadRouteDefinition as a, type UploadInputFile as b, type DoneContext as c, type StandardSchema as d, type UploadRoutes as e, type StorageAdapter as f, type UpliftApp as g, type ClientOutput as h, type StoragePutInput as i, type UploadClient as j, UploadError as k, type UploadErrorCode as l, type UploadedFile as m };
+export { type CompatibleTransform as C, type DurationValue as D, type KeyContext as K, type Middleware as M, type OutputContext as O, type PreparedUploadFile as P, type SizeValue as S, type TransformContext as T, type UploadKind as U, type UploadRouteDefinition as a, type UploadInputFile as b, type DoneContext as c, type StandardSchema as d, type CompatibleOutput as e, type UploadRoutes as f, type StorageAdapter as g, type UpliftApp as h, type ClientInput as i, type ClientOutput as j, type ClientUploadedFile as k, type OutputNames as l, type StoragePutInput as m, type UploadClient as n, UploadError as o, type UploadErrorCode as p, type UploadOutput as q, type UploadTransform as r, type UploadTransformFunction as s, type UploadedFile as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@uplift-io/uplift",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "Dead-simple, type-safe file handling for TypeScript applications.",
   "license": "MIT",
   "homepage": "https://itzfeminisce.github.io/uplift/",