@dimah-s3/server 0.7.4 → 0.8.0

package/dist/plugin/types.d.ts

@@ -1,43 +1,16 @@
-import type { ServerErrors } from "../errors";
-import type { DeleteConfig, DownloadConfig, MultipartConfig, UploadConfig, DimahS3Config } from "../types/config";
-export type { ServerErrors };
+import type { Endpoint } from "better-call";
+import type { DeleteConfig, DownloadConfig, MultipartConfig, UploadConfig, DimahS3Config, ResolvedDimahS3Config } from "../types/config";
 /**
  * Hook fields a plugin may contribute. Scalars like `enabled` / `method`
  * stay user-owned on {@link DimahS3Config}.
  */
 export type DimahS3PluginHooks = {
     guard?: DimahS3Config["guard"];
-    upload?: Pick<UploadConfig, "presignGuard" | "onPresigned" | "confirmGuard" | "onConfirmed">;
-    download?: Pick<DownloadConfig, "presignGuard" | "onPresigned">;
-    delete?: Pick<DeleteConfig, "guard" | "onDeleted">;
+    upload?: Pick<UploadConfig, "guard" | "onPresigned" | "confirmGuard" | "onConfirmed" | "prefix" | "resolveKey">;
+    download?: Pick<DownloadConfig, "guard" | "onPresigned" | "prefix" | "resolveKey">;
+    delete?: Pick<DeleteConfig, "guard" | "onDeleted" | "prefix" | "resolveKey">;
     multipart?: Pick<MultipartConfig, "initGuard" | "partGuard" | "completeGuard" | "abortGuard" | "listGuard" | "onInit" | "onComplete" | "onAbort" | "onList">;
 };
-/**
- * Context passed to a plugin endpoint handler.
- * Global `config.guard` already ran before this is invoked.
- */
-export type PluginEndpointContext = {
-    request: Request;
-    url: URL;
-    config: Readonly<DimahS3Config>;
-    /** English error factories with stable `code` for client localization. */
-    errors: ServerErrors;
-    /** Parse the request JSON body (returns `null` when missing/invalid). */
-    json: <T extends Record<string, unknown>>() => Promise<T | null>;
-};
-/** HTTP endpoint contributed by a server plugin. */
-export type PluginEndpoint = {
-    /** Relative path under `plugins/{id}/` (e.g. `"objects"` → `plugins/db/objects`). */
-    path: string;
-    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
-    /** Optional HTTP status for successful JSON responses. */
-    status?: number;
-    handler: (ctx: PluginEndpointContext) => Promise<unknown>;
-};
-/** Endpoint after plugin id is attached for mounting. */
-export type ResolvedPluginEndpoint = PluginEndpoint & {
-    pluginId: string;
-};
 /**
  * Environment passed to {@link DimahS3Plugin.init}.
  * Config is pre-merge (user config only) — use for feature-flag checks.
@@ -56,8 +29,9 @@ export type PluginInitEnv = {
  *   flattened instance (`s3[id]`).
  * @typeParam TContext — exposed on `s3.context[id]` and `s3[id]` after
  *   `dimahS3()`.
+ * @typeParam TEndpoints — better-call endpoints merged onto `s3.api`.
  */
-export type DimahS3Plugin<Id extends string = string, TContext extends Record<string, unknown> = Record<string, unknown>> = {
+export type DimahS3Plugin<Id extends string = string, TContext extends Record<string, unknown> = Record<string, unknown>, TEndpoints extends Record<string, Endpoint> = Record<string, Endpoint>> = {
     /** Unique id — duplicate ids throw at init. */
     id: Id;
     /**
@@ -75,27 +49,33 @@ export type DimahS3Plugin<Id extends string = string, TContext extends Record<st
     /** Lifecycle / guard hooks merged ahead of user config hooks. */
     hooks?: DimahS3PluginHooks;
     /**
-     * Extra HTTP routes mounted under `plugins/{id}/{path}` on the shared
-     * handler. Use {@link createEndpoint} to build entries.
+     * Extra HTTP routes on the shared handler. Use {@link createS3Endpoint}.
+     * Paths are absolute under `basePath` (e.g. `/db/objects`).
      */
-    endpoints?: Record<string, PluginEndpoint>;
+    endpoints?: TEndpoints;
     /** Opaque context keyed by `id` on the dimahS3 instance. */
     context?: TContext;
 };
-export type AppliedPlugins<C extends Record<string, unknown> = Record<string, unknown>> = {
+export type AppliedPlugins<C extends Record<string, unknown> = Record<string, unknown>, E extends Record<string, Endpoint> = Record<string, Endpoint>> = {
     /** Config with plugin hooks chained ahead of user hooks. */
-    config: DimahS3Config;
+    config: ResolvedDimahS3Config;
     /** Plugin contexts keyed by plugin id. */
     context: C;
     getPlugin: (id: string) => DimahS3Plugin | undefined;
-    /** Plugin HTTP endpoints ready to mount on the handler. */
-    endpoints: ResolvedPluginEndpoint[];
+    /** Plugin HTTP endpoints merged onto `s3.api` and the router. */
+    endpoints: E;
 };
 /** Map plugin ids → their `context` types. */
 export type PluginContextMap<P extends readonly DimahS3Plugin[]> = {
     [K in P[number] as K["id"]]: K extends DimahS3Plugin<string, infer Ctx> ? Ctx : never;
 };
+/** Map plugin endpoint names → better-call endpoints. */
+export type PluginEndpointMap<P extends readonly DimahS3Plugin[]> = P extends readonly [] ? Record<string, never> : UnionToIntersection<P[number] extends {
+    endpoints?: infer E;
+} ? E extends Record<string, Endpoint> ? E : Record<string, never> : Record<string, never>>;
+type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : Record<string, never>;
 /** Keys reserved on the dimahS3 instance — plugins may not use these as ids. */
-export declare const RESERVED_PLUGIN_IDS: readonly ["handler", "api", "context", "getPlugin"];
+export declare const RESERVED_PLUGIN_IDS: readonly ["handler", "api", "context", "getPlugin", "$ERROR_CODES", "$Infer"];
 export type ReservedPluginId = (typeof RESERVED_PLUGIN_IDS)[number];
+export {};
 //# sourceMappingURL=types.d.ts.map

package/dist/plugin/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAC9C,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,eAAe,EACf,YAAY,EACZ,aAAa,EACd,MAAM,iBAAiB,CAAC;AAEzB,YAAY,EAAE,YAAY,EAAE,CAAC;AAE7B;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,IAAI,CACX,YAAY,EACZ,cAAc,GAAG,aAAa,GAAG,cAAc,GAAG,aAAa,CAChE,CAAC;IACF,QAAQ,CAAC,EAAE,IAAI,CAAC,cAAc,EAAE,cAAc,GAAG,aAAa,CAAC,CAAC;IAChE,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,WAAW,CAAC,CAAC;IACnD,SAAS,CAAC,EAAE,IAAI,CACd,eAAe,EACb,WAAW,GACX,WAAW,GACX,eAAe,GACf,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,QAAQ,CACX,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,GAAG,CAAC;IACT,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAChC,0EAA0E;IAC1E,MAAM,EAAE,YAAY,CAAC;IACrB,yEAAyE;IACzE,IAAI,EAAE,CAAC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;CAClE,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,cAAc,GAAG;IAC3B,qFAAqF;IACrF,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpD,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,CAAC,GAAG,EAAE,qBAAqB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3D,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,sBAAsB,GAAG,cAAc,GAAG;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC;AAE3E;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,8DAA8D;IAC9D,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAChC,8CAA8C;IAC9C,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,aAAa,GAAG,SAAS,CAAC;CACtD,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,aAAa,CACvB,EAAE,SAAS,MAAM,GAAG,MAAM,EAC1B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAChE;IACF,+CAA+C;IAC/C,EAAE,EAAE,EAAE,CAAC;IACP;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,IAAI,CAAC;IACpC,iEAAiE;IACjE,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAC3C,4DAA4D;IAC5D,OAAO,CAAC,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACzD;IACF,4DAA4D;IAC5D,MAAM,EAAE,aAAa,CAAC;IACtB,0CAA0C;IAC1C,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,aAAa,GAAG,SAAS,CAAC;IACrD,2DAA2D;IAC3D,SAAS,EAAE,sBAAsB,EAAE,CAAC;CACrC,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,IAAI;KAChE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GACnE,GAAG,GACH,KAAK;CACV,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,mBAAmB,YAC9B,SAAS,EACT,KAAK,EACL,SAAS,EACT,WAAW,CACH,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/plugin/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,eAAe,EACf,YAAY,EACZ,aAAa,EACb,qBAAqB,EACtB,MAAM,iBAAiB,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,CAAC,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,CAAC,EAAE,IAAI,CACX,YAAY,EACV,OAAO,GACP,aAAa,GACb,cAAc,GACd,aAAa,GACb,QAAQ,GACR,YAAY,CACf,CAAC;IACF,QAAQ,CAAC,EAAE,IAAI,CACb,cAAc,EACd,OAAO,GAAG,aAAa,GAAG,QAAQ,GAAG,YAAY,CAClD,CAAC;IACF,MAAM,CAAC,EAAE,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,WAAW,GAAG,QAAQ,GAAG,YAAY,CAAC,CAAC;IAC7E,SAAS,CAAC,EAAE,IAAI,CACd,eAAe,EACb,WAAW,GACX,WAAW,GACX,eAAe,GACf,YAAY,GACZ,WAAW,GACX,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,QAAQ,CACX,CAAC;CACH,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,8DAA8D;IAC9D,MAAM,EAAE,QAAQ,CAAC,aAAa,CAAC,CAAC;IAChC,8CAA8C;IAC9C,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,aAAa,GAAG,SAAS,CAAC;CACtD,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,MAAM,aAAa,CACvB,EAAE,SAAS,MAAM,GAAG,MAAM,EAC1B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClE,UAAU,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IACpE;IACF,+CAA+C;IAC/C,EAAE,EAAE,EAAE,CAAC;IACP;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IAC9B;;;;OAIG;IACH,IAAI,CAAC,EAAE,CAAC,GAAG,EAAE,aAAa,KAAK,IAAI,CAAC;IACpC,iEAAiE;IACjE,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IACvB,4DAA4D;IAC5D,OAAO,CAAC,EAAE,QAAQ,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3D,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAC3D;IACF,4DAA4D;IAC5D,MAAM,EAAE,qBAAqB,CAAC;IAC9B,0CAA0C;IAC1C,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,aAAa,GAAG,SAAS,CAAC;IACrD,iEAAiE;IACjE,SAAS,EAAE,CAAC,CAAC;CACd,CAAC;AAEF,8CAA8C;AAC9C,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,IAAI;KAChE,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,SAAS,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,CAAC,GACnE,GAAG,GACH,KAAK;CACV,CAAC;AAEF,yDAAyD;AACzD,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,SAAS,aAAa,EAAE,IAC9D,CAAC,SAAS,SAAS,EAAE,GACjB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACrB,mBAAmB,CACjB,CAAC,CAAC,MAAM,CAAC,SAAS;IAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;CAAE,GACrC,CAAC,SAAS,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAChC,CAAC,GACD,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GACvB,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAC1B,CAAC;AAER,KAAK,mBAAmB,CAAC,CAAC,IAAI,CAC5B,CAAC,SAAS,OAAO,GAAG,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,KAAK,CAC3C,SAAS,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,GAC1B,CAAC,GACD,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AAE1B,gFAAgF;AAChF,eAAO,MAAM,mBAAmB,YAC9B,SAAS,EACT,KAAK,EACL,SAAS,EACT,WAAW,EACX,cAAc,EACd,QAAQ,CACA,CAAC;AAEX,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC"}

package/dist/plugins.d.ts

@@ -0,0 +1,7 @@
+export { applyPlugins, chainHooks, definePlugin, FEATURE_HOOK_KEYS, RESERVED_PLUGIN_IDS, } from "./plugin";
+export type { AppliedPlugins, DimahS3Plugin, DimahS3PluginHooks, FeatureName, PluginContextMap, PluginEndpointMap, PluginInitEnv, ReservedPluginId, } from "./plugin";
+export { createS3Endpoint, createS3Middleware } from "./api";
+export type { CoreEndpoints, S3EndpointContext } from "./api";
+export { CORE_ENDPOINT_NAMES } from "./api";
+export type { DeleteGuardContext, DeleteOnDeletedContext, DimahS3Config, DownloadConfig, DownloadOnPresignedContext, DownloadPresignGuardContext, FeatureToggle, GuardContext, KeyPrefix, MultipartAbortGuardContext, MultipartCompleteGuardContext, MultipartConfig, MultipartInitGuardContext, MultipartListGuardContext, MultipartOnAbortContext, MultipartOnCompleteContext, MultipartOnInitContext, MultipartOnListContext, MultipartPartGuardContext, MultipartUploadContext, ResolveKeyContext, ResolvedDimahS3Config, UploadConfig, UploadConfirmGuardContext, UploadOnConfirmedContext, UploadOnPresignedContext, UploadPresignGuardContext, } from "./types";
+//# sourceMappingURL=plugins.d.ts.map

package/dist/plugins.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugins.d.ts","sourceRoot":"","sources":["../src/plugins.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,iBAAiB,EACjB,mBAAmB,GACpB,MAAM,UAAU,CAAC;AAClB,YAAY,EACV,cAAc,EACd,aAAa,EACb,kBAAkB,EAClB,WAAW,EACX,gBAAgB,EAChB,iBAAiB,EACjB,aAAa,EACb,gBAAgB,GACjB,MAAM,UAAU,CAAC;AAElB,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,OAAO,CAAC;AAC7D,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,OAAO,CAAC;AAE5C,YAAY,EACV,kBAAkB,EAClB,sBAAsB,EACtB,aAAa,EACb,cAAc,EACd,0BAA0B,EAC1B,2BAA2B,EAC3B,aAAa,EACb,YAAY,EACZ,SAAS,EACT,0BAA0B,EAC1B,6BAA6B,EAC7B,eAAe,EACf,yBAAyB,EACzB,yBAAyB,EACzB,uBAAuB,EACvB,0BAA0B,EAC1B,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EACzB,sBAAsB,EACtB,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,yBAAyB,EACzB,wBAAwB,EACxB,wBAAwB,EACxB,yBAAyB,GAC1B,MAAM,SAAS,CAAC"}