@venizia/ignis 0.2.0-3 → 0.2.0-31

package/dist/components/static-asset/controller/factory.d.ts

@@ -1,8 +1,9 @@
-import { BaseHelper } from '@venizia/ignis-helpers/core';
+import { TRouteContext } from '../../../base/controllers';
+import { IObjectLocation, IObjectRef, IStorageHelper } from '@venizia/ignis-helpers';
 import { ValueOrPromise } from '@venizia/ignis-helpers/common';
-import { IStorageHelper } from '@venizia/ignis-helpers';
+import { BaseHelper } from '@venizia/ignis-helpers/core';
 import { Env } from 'hono';
-import { TMetaLinkConfig, TStaticAssetExtraOptions, TStaticAssetsComponentOptions, TStaticAssetStorageType } from '../common';
+import { TDefineExtraRoutes, TMetaLinkConfig, TResolveObjectName, TStaticAssetExtraOptions, TStaticAssetsComponentOptions, TStaticAssetStorageType } from '../common';
 export interface IAssetControllerOptions {
     controller: TStaticAssetsComponentOptions[string]['controller'];
     storage: TStaticAssetStorageType;
@@ -10,7 +11,31 @@ export interface IAssetControllerOptions {
     useMetaLink?: boolean;
     metaLink?: TMetaLinkConfig;
     options?: TStaticAssetExtraOptions;
+    /** Decides the stored object name of each uploaded file. Absent leaves the storage helper's own naming untouched. */
+    resolveObjectName?: TResolveObjectName;
+    /** Registers the application's own routes on the generated controller, after every built-in one. */
+    /** Registers the application's own routes BEFORE every built-in one, so a literal path wins over the catch-all `rawObjectPath` produces. */
+    defineRoutesBefore?: TDefineExtraRoutes;
+    defineExtraRoutes?: TDefineExtraRoutes;
 }
+/** The URL of one object, in the shape its controller serves: no `/buckets/<name>` with a configured bucket, and a raw path with `rawObjectPath`. */
+export declare const buildObjectLink: (opts: IObjectLocation & {
+    basePath: string;
+    hasConfiguredBucket?: boolean;
+    rawObjectPath?: boolean;
+}) => string;
+/**
+ * The served type comes from the object NAME, never the backend or the uploader: a renderable type on
+ * the API origin is stored XSS. Exported so a hand-written route makes the same decision - the
+ * backend's own content-type is dropped by `WHITELIST_HEADERS`.
+ */
+export declare const resolveServedContentType: (opts: {
+    helper: IStorageHelper;
+    object: IObjectRef;
+}) => {
+    contentType: string;
+    isRenderable: boolean;
+};
 export declare class AssetControllerFactory extends BaseHelper {
     constructor();
     static defineAssetController(opts: IAssetControllerOptions): {
@@ -25,6 +50,37 @@ export declare class AssetControllerFactory extends BaseHelper {
                 args: unknown;
                 task: () => Promise<R>;
             }): Promise<any>;
+            normalizeCountData<ResponseSchema extends unknown, RequestContext extends TRouteContext<Env> = TRouteContext<Env>, ResponseData extends {
+                count: number;
+                data?: import("@venizia/ignis-helpers").TNullable<ResponseSchema>;
+            } = {
+                count: number;
+                data?: import("@venizia/ignis-helpers").TNullable<ResponseSchema>;
+            }>(opts: {
+                context: RequestContext;
+                payload: ResponseData;
+            }): ResponseData | import("@venizia/ignis-helpers").TNullable<ResponseSchema>;
+            respond<R>(opts: {
+                context: TRouteContext<Env>;
+                format: import("../../../base/controllers").TResponseFormat;
+                payload: {
+                    count: number;
+                    data?: import("@venizia/ignis-helpers").TNullable<R>;
+                };
+                range?: import("../../../base/controllers").TDataRange;
+            }): import("@venizia/ignis-helpers").TNullable<R> | {
+                count: number;
+                data?: import("@venizia/ignis-helpers").TNullable<R>;
+            };
+            setListHeaders(opts: {
+                context: TRouteContext<Env>;
+                count: number;
+            } & ({
+                range: import("../../../base/controllers").TDataRange;
+            } | {
+                offset: number;
+                total: number;
+            })): void;
             toHonoHandler<ResponseType = unknown>(opts: {
                 handler: import("../../../base/controllers").TRouteHandler<ResponseType, Env>;
             }): import("hono").Handler<Env, string, import("hono").Input, (Response | Promise<Response>) | (import("@hono/zod-openapi").RouteConfigToTypedResponse<import("@hono/zod-openapi").RouteConfig> | Promise<import("@hono/zod-openapi").RouteConfigToTypedResponse<import("@hono/zod-openapi").RouteConfig>>)>;
@@ -62,12 +118,12 @@ export declare class AssetControllerFactory extends BaseHelper {
             getRouteConfigs<RouteConfig extends import("../../../base/controllers").IAuthRouteConfig>(opts: {
                 configs: RouteConfig;
             }): RouteConfig & {
-                getRoutingPath(): RouteConfig["path"] extends infer T ? T extends RouteConfig["path"] ? T extends `${infer Head}/{${infer Param}}${infer Tail}` ? `${Head}/:${Param}${Tail extends `${infer Head_1}/{${infer Param_1}}${infer Tail_1}` ? `${Head_1}/:${Param_1}${Tail_1 extends `${infer Head_2}/{${infer Param_2}}${infer Tail_2}` ? `${Head_2}/:${Param_2}${Tail_2 extends `${infer Head_3}/{${infer Param_3}}${infer Tail_3}` ? `${Head_3}/:${Param_3}${Tail_3 extends `${infer Head_4}/{${infer Param_4}}${infer Tail_4}` ? `${Head_4}/:${Param_4}${Tail_4 extends `${infer Head_5}/{${infer Param_5}}${infer Tail_5}` ? `${Head_5}/:${Param_5}${Tail_5 extends `${infer Head_6}/{${infer Param_6}}${infer Tail_6}` ? `${Head_6}/:${Param_6}${Tail_6 extends `${infer Head_7}/{${infer Param_7}}${infer Tail_7}` ? `${Head_7}/:${Param_7}${Tail_7 extends `${infer Head_8}/{${infer Param_8}}${infer Tail_8}` ? `${Head_8}/:${Param_8}${Tail_8 extends `${infer Head_9}/{${infer Param_9}}${infer Tail_9}` ? `${Head_9}/:${Param_9}${Tail_9 extends `${infer Head_10}/{${infer Param_10}}${infer Tail_10}` ? `${Head_10}/:${Param_10}${any}` : Tail_9}` : Tail_8}` : Tail_7}` : Tail_6}` : Tail_5}` : Tail_4}` : Tail_3}` : Tail_2}` : Tail_1}` : Tail}` : T : never : never;
+                getRoutingPath(): RouteConfig["path"] extends infer T ? T extends RouteConfig["path"] ? T extends `${infer Start}/{${infer Param}}${infer Rest}` ? `${Start}/:${Param}${Rest extends `${infer Start_1}/{${infer Param_1}}${infer Rest_1}` ? `${Start_1}/:${Param_1}${Rest_1 extends `${infer Start_2}/{${infer Param_2}}${infer Rest_2}` ? `${Start_2}/:${Param_2}${Rest_2 extends `${infer Start_3}/{${infer Param_3}}${infer Rest_3}` ? `${Start_3}/:${Param_3}${Rest_3 extends `${infer Start_4}/{${infer Param_4}}${infer Rest_4}` ? `${Start_4}/:${Param_4}${Rest_4 extends `${infer Start_5}/{${infer Param_5}}${infer Rest_5}` ? `${Start_5}/:${Param_5}${Rest_5 extends `${infer Start_6}/{${infer Param_6}}${infer Rest_6}` ? `${Start_6}/:${Param_6}${Rest_6 extends `${infer Start_7}/{${infer Param_7}}${infer Rest_7}` ? `${Start_7}/:${Param_7}${Rest_7 extends `${infer Start_8}/{${infer Param_8}}${infer Rest_8}` ? `${Start_8}/:${Param_8}${Rest_8 extends `${infer Start_9}/{${infer Param_9}}${infer Rest_9}` ? `${Start_9}/:${Param_9}${Rest_9 extends `${infer Start_10}/{${infer Param_10}}${infer Rest_10}` ? `${Start_10}/:${Param_10}${any}` : Rest_9}` : Rest_8}` : Rest_7}` : Rest_6}` : Rest_5}` : Rest_4}` : Rest_3}` : Rest_2}` : Rest_1}` : Rest}` : T : never : never;
             };
             getJSXRouteConfigs<RouteConfig extends import("../../../base/controllers").IAuthRouteConfig>(opts: {
                 configs: RouteConfig;
             }): RouteConfig & {
-                getRoutingPath(): RouteConfig["path"] extends infer T ? T extends RouteConfig["path"] ? T extends `${infer Head}/{${infer Param}}${infer Tail}` ? `${Head}/:${Param}${Tail extends `${infer Head_1}/{${infer Param_1}}${infer Tail_1}` ? `${Head_1}/:${Param_1}${Tail_1 extends `${infer Head_2}/{${infer Param_2}}${infer Tail_2}` ? `${Head_2}/:${Param_2}${Tail_2 extends `${infer Head_3}/{${infer Param_3}}${infer Tail_3}` ? `${Head_3}/:${Param_3}${Tail_3 extends `${infer Head_4}/{${infer Param_4}}${infer Tail_4}` ? `${Head_4}/:${Param_4}${Tail_4 extends `${infer Head_5}/{${infer Param_5}}${infer Tail_5}` ? `${Head_5}/:${Param_5}${Tail_5 extends `${infer Head_6}/{${infer Param_6}}${infer Tail_6}` ? `${Head_6}/:${Param_6}${Tail_6 extends `${infer Head_7}/{${infer Param_7}}${infer Tail_7}` ? `${Head_7}/:${Param_7}${Tail_7 extends `${infer Head_8}/{${infer Param_8}}${infer Tail_8}` ? `${Head_8}/:${Param_8}${Tail_8 extends `${infer Head_9}/{${infer Param_9}}${infer Tail_9}` ? `${Head_9}/:${Param_9}${Tail_9 extends `${infer Head_10}/{${infer Param_10}}${infer Tail_10}` ? `${Head_10}/:${Param_10}${any}` : Tail_9}` : Tail_8}` : Tail_7}` : Tail_6}` : Tail_5}` : Tail_4}` : Tail_3}` : Tail_2}` : Tail_1}` : Tail}` : T : never : never;
+                getRoutingPath(): RouteConfig["path"] extends infer T ? T extends RouteConfig["path"] ? T extends `${infer Start}/{${infer Param}}${infer Rest}` ? `${Start}/:${Param}${Rest extends `${infer Start_1}/{${infer Param_1}}${infer Rest_1}` ? `${Start_1}/:${Param_1}${Rest_1 extends `${infer Start_2}/{${infer Param_2}}${infer Rest_2}` ? `${Start_2}/:${Param_2}${Rest_2 extends `${infer Start_3}/{${infer Param_3}}${infer Rest_3}` ? `${Start_3}/:${Param_3}${Rest_3 extends `${infer Start_4}/{${infer Param_4}}${infer Rest_4}` ? `${Start_4}/:${Param_4}${Rest_4 extends `${infer Start_5}/{${infer Param_5}}${infer Rest_5}` ? `${Start_5}/:${Param_5}${Rest_5 extends `${infer Start_6}/{${infer Param_6}}${infer Rest_6}` ? `${Start_6}/:${Param_6}${Rest_6 extends `${infer Start_7}/{${infer Param_7}}${infer Rest_7}` ? `${Start_7}/:${Param_7}${Rest_7 extends `${infer Start_8}/{${infer Param_8}}${infer Rest_8}` ? `${Start_8}/:${Param_8}${Rest_8 extends `${infer Start_9}/{${infer Param_9}}${infer Rest_9}` ? `${Start_9}/:${Param_9}${Rest_9 extends `${infer Start_10}/{${infer Param_10}}${infer Rest_10}` ? `${Start_10}/:${Param_10}${any}` : Rest_9}` : Rest_8}` : Rest_7}` : Rest_6}` : Rest_5}` : Rest_4}` : Rest_3}` : Rest_2}` : Rest_1}` : Rest}` : T : never : never;
             };
             scope: string;
             identifier: string;

package/dist/components/static-asset/controller/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../src/components/static-asset/controller/factory.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAY,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAQ,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAGL,cAAc,EAIf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAIL,eAAe,EAEf,wBAAwB,EACxB,6BAA6B,EAC7B,uBAAuB,EAGxB,MAAM,WAAW,CAAC;AAGnB,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC;IAChE,OAAO,EAAE,uBAAuB,CAAC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,OAAO,CAAC,EAAE,wBAAwB,CAAC;CACpC;AAuBD,qBAAa,sBAAuB,SAAQ,UAAU;;IAKpD,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,uBAAuB;;YAkBtD,6FAA6F;2CAC9D;gBAAE,KAAK,EAAE,MAAM,EAAE,CAAA;aAAE,GAAG,IAAI;uBAYrC,cAAc,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAxDiC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAif/E"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../../../src/components/static-asset/controller/factory.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAEvE,OAAO,EAGL,eAAe,EAEf,UAAU,EAEV,cAAc,EAKf,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAAQ,cAAc,EAAE,MAAM,+BAA+B,CAAC;AACrE,OAAO,EAAE,UAAU,EAAY,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAE3B,OAAO,EAIL,kBAAkB,EAElB,eAAe,EAEf,kBAAkB,EAClB,wBAAwB,EACxB,6BAA6B,EAC7B,uBAAuB,EAGxB,MAAM,WAAW,CAAC;AAGnB,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,6BAA6B,CAAC,MAAM,CAAC,CAAC,YAAY,CAAC,CAAC;IAChE,OAAO,EAAE,uBAAuB,CAAC;IACjC,MAAM,EAAE,cAAc,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,OAAO,CAAC,EAAE,wBAAwB,CAAC;IAEnC,qHAAqH;IACrH,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;IAEvC,oGAAoG;IACpG,4IAA4I;IAC5I,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;CACxC;AAqBD,qJAAqJ;AACrJ,eAAO,MAAM,eAAe,GAC1B,MAAM,eAAe,GAAG;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,KACA,MAQF,CAAC;AAcF;;;;GAIG;AACH,eAAO,MAAM,wBAAwB,GAAI,MAAM;IAC7C,MAAM,EAAE,cAAc,CAAC;IACvB,MAAM,EAAE,UAAU,CAAC;CACpB,KAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,OAAO,CAAA;CAS/C,CAAC;AAyDF,qBAAa,sBAAuB,SAAQ,UAAU;;IAKpD,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,uBAAuB;;YAoCtD,6FAA6F;2CAC9D;gBAAE,KAAK,EAAE,MAAM,EAAE,CAAA;aAAE,GAAG,IAAI;uBAYrC,cAAc,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;qBAxLN,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4tBxC"}