@venizia/ignis 0.2.0-9 → 0.2.0

package/dist/components/static-asset/controller/base.definition.js

@@ -1,10 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StaticAssetDefinitions = void 0;
+exports.StaticAssetDefinitions = exports.buildAssetDefinitions = void 0;
 const ignis_kernel_1 = require("@venizia/ignis-kernel");
 const zod_openapi_1 = require("@hono/zod-openapi");
 const common_1 = require("@venizia/ignis-helpers/common");
-const ignis_helpers_1 = require("@venizia/ignis-helpers");
+/** The labels both upload paths take. They ride the BODY, not the URL - an identifier in a query string lands in every access log between the client and here. */
+const uploadLabels = () => ({
+    principalType: zod_openapi_1.z.string().optional(),
+    principalId: zod_openapi_1.z.string().or(zod_openapi_1.z.number()).optional(),
+    variant: zod_openapi_1.z.string().optional(),
+    sequence: zod_openapi_1.z.coerce.number().int().optional(),
+});
 const MultipartBodySchema = zod_openapi_1.z.object({
     files: zod_openapi_1.z.union([zod_openapi_1.z.instanceof(File), zod_openapi_1.z.array(zod_openapi_1.z.instanceof(File))]).openapi({
         type: 'array',
@@ -13,324 +19,282 @@ const MultipartBodySchema = zod_openapi_1.z.object({
             format: 'binary',
         },
     }),
+    ...uploadLabels(),
+    folderPath: zod_openapi_1.z.string().optional().openapi({
+        description: 'Target folder path for uploaded files (e.g., "photos/2024")',
+        example: 'photos/2024',
+    }),
 });
-exports.StaticAssetDefinitions = {
-    GET_BUCKETS: {
-        method: 'get',
-        path: '/buckets',
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
-                name: zod_openapi_1.z.string(),
-                creationDate: zod_openapi_1.z.iso.datetime(),
-            })),
-        }),
+const bucketNameParam = () => zod_openapi_1.z.string().openapi({
+    param: {
+        name: 'bucketName',
+        in: 'path',
     },
-    GET_BUCKET_BY_NAME: {
-        method: 'get',
-        path: '/buckets/{bucketName}',
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
-            }),
+    example: 'images',
+});
+const objectNameParam = () => zod_openapi_1.z.string().openapi({
+    param: {
+        name: 'objectName',
+        in: 'path',
+        description: 'Object name or path (e.g., "photo.jpg" or "photos/2024/photo.jpg")',
+    },
+    example: 'photos/2024/photo.jpg',
+});
+const fileStreamResponses = () => ({
+    [common_1.HTTP.ResultCodes.RS_2.Ok]: {
+        description: 'File stream response',
+        content: {
+            'application/octet-stream': {
+                schema: {
+                    type: 'string',
+                    format: 'binary',
+                },
+            },
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z
-                .object({
-                name: zod_openapi_1.z.string(),
-                creationDate: zod_openapi_1.z.iso.datetime(),
-            })
-                .nullable(),
-        }),
     },
-    CREATE_BUCKET: {
-        method: 'post',
-        path: '/buckets/{bucketName}',
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
+    ...(0, ignis_kernel_1.errorResponses)(),
+});
+/**
+ * Builds the route configs of one asset controller.
+ * `hasConfiguredBucket` drops `/buckets/{bucketName}` and its param from every object route.
+ * `rawObjectPath` appends the `{.+}` catch-all, the spelling `@hono/zod-openapi` translates.
+ */
+const buildAssetDefinitions = (opts) => {
+    const { hasConfiguredBucket = false, rawObjectPath = false } = opts;
+    const bucketPrefix = hasConfiguredBucket ? '' : '/buckets/{bucketName}';
+    // `{objectName}` is ONE segment: a folder path travels percent-encoded (`photos%2F2024%2Ff.jpg`).
+    // The catch-all also matches a RAW nested path; the encoded form keeps working either way.
+    const objectSegment = rawObjectPath ? '{objectName}{.+}' : '{objectName}';
+    // A configured bucket is never in the URL, so a route whose only param was `bucketName` carries none.
+    const bucketRequest = () => hasConfiguredBucket ? {} : { params: zod_openapi_1.z.object({ bucketName: bucketNameParam() }) };
+    const objectRequest = () => ({
+        params: hasConfiguredBucket
+            ? zod_openapi_1.z.object({ objectName: objectNameParam() })
+            : zod_openapi_1.z.object({ bucketName: bucketNameParam(), objectName: objectNameParam() }),
+    });
+    return {
+        GET_BUCKETS: {
+            method: 'get',
+            path: '/buckets',
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
+                    name: zod_openapi_1.z.string(),
+                    creationDate: zod_openapi_1.z.iso.datetime(),
+                })),
             }),
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z
-                .object({
-                name: zod_openapi_1.z.string(),
-                creationDate: zod_openapi_1.z.iso.datetime(),
-            })
-                .nullable(),
-        }),
-    },
-    GET_OBJECT_BY_NAME: {
-        method: 'get',
-        path: '/buckets/{bucketName}/objects/{objectName}',
-        // Native Hono path: /buckets/:bucketName/objects/:objectName{.+} - the regex param is what allows folder paths (photos/2024/file.jpg).
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
-                objectName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'objectName',
-                        in: 'path',
-                        description: 'Object name or path (e.g., "photo.jpg" or "photos/2024/photo.jpg")',
-                    },
-                    example: 'photos/2024/photo.jpg',
-                }),
+        GET_BUCKET_BY_NAME: {
+            method: 'get',
+            path: bucketPrefix,
+            request: {
+                params: zod_openapi_1.z.object({ bucketName: bucketNameParam() }),
+            },
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z
+                    .object({
+                    name: zod_openapi_1.z.string(),
+                    creationDate: zod_openapi_1.z.iso.datetime(),
+                })
+                    .nullable(),
             }),
         },
-        responses: {
-            [common_1.HTTP.ResultCodes.RS_2.Ok]: {
-                description: 'File stream response',
-                content: {
-                    'application/octet-stream': {
-                        schema: {
-                            type: 'string',
-                            format: 'binary',
-                        },
-                    },
-                },
+        CREATE_BUCKET: {
+            method: 'post',
+            path: bucketPrefix,
+            request: {
+                params: zod_openapi_1.z.object({ bucketName: bucketNameParam() }),
             },
-            ['4xx | 5xx']: (0, ignis_kernel_1.jsonContent)({ description: 'Error Response', schema: ignis_helpers_1.ErrorSchema }),
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z
+                    .object({
+                    name: zod_openapi_1.z.string(),
+                    creationDate: zod_openapi_1.z.iso.datetime(),
+                })
+                    .nullable(),
+            }),
         },
-    },
-    DOWNLOAD_OBJECT_BY_NAME: {
-        method: 'get',
-        path: '/buckets/{bucketName}/download/{objectName}',
-        // Native Hono path: /buckets/:bucketName/download/:objectName{.+} - the action prefix must precede the wildcard because the Hono catch-all is greedy.
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
-                objectName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'objectName',
-                        in: 'path',
-                        description: 'Object name or path (e.g., "photo.jpg" or "photos/2024/photo.jpg")',
-                    },
-                    example: 'photos/2024/photo.jpg',
+        DELETE_BUCKET: {
+            method: 'delete',
+            path: bucketPrefix,
+            request: {
+                params: zod_openapi_1.z.object({ bucketName: bucketNameParam() }),
+            },
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.object({
+                    isDeleted: zod_openapi_1.z.boolean(),
                 }),
             }),
         },
-        responses: {
-            [common_1.HTTP.ResultCodes.RS_2.Ok]: {
-                description: 'File stream response',
-                content: {
-                    'application/octet-stream': {
-                        schema: {
-                            type: 'string',
-                            format: 'binary',
+        GET_OBJECT_BY_NAME: {
+            method: 'get',
+            path: `${bucketPrefix}/objects/${objectSegment}`,
+            request: objectRequest(),
+            responses: fileStreamResponses(),
+        },
+        DOWNLOAD_OBJECT_BY_NAME: {
+            method: 'get',
+            path: `${bucketPrefix}/download/${objectSegment}`,
+            request: objectRequest(),
+            responses: fileStreamResponses(),
+        },
+        UPLOAD_POLICY: {
+            method: 'post',
+            path: `${bucketPrefix}/upload-policy`,
+            request: {
+                body: {
+                    content: {
+                        'application/json': {
+                            schema: zod_openapi_1.z.object({
+                                files: zod_openapi_1.z.array(zod_openapi_1.z.object({
+                                    fileName: zod_openapi_1.z.string().min(1),
+                                    contentType: zod_openapi_1.z.string().optional(),
+                                    size: zod_openapi_1.z.number().int().nonnegative().optional(),
+                                })),
+                            }),
                         },
                     },
                 },
             },
-            ['4xx | 5xx']: (0, ignis_kernel_1.jsonContent)({ description: 'Error Response', schema: ignis_helpers_1.ErrorSchema }),
-        },
-    },
-    UPLOAD: {
-        method: 'post',
-        path: '/buckets/{bucketName}/upload',
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
+                    postURL: zod_openapi_1.z.string(),
+                    formData: zod_openapi_1.z.record(zod_openapi_1.z.string(), zod_openapi_1.z.string()),
+                    objectName: zod_openapi_1.z.string(),
+                    commitToken: zod_openapi_1.z.string(),
+                    expiresAt: zod_openapi_1.z.string(),
+                })),
+                description: 'One signed POST policy per file, plus the token its commit is claimed with',
             }),
-            query: zod_openapi_1.z.object({
-                principalType: zod_openapi_1.z.string().optional(),
-                principalId: zod_openapi_1.z.string().or(zod_openapi_1.z.number()).optional(),
-                variant: zod_openapi_1.z.string().optional(),
-                folderPath: zod_openapi_1.z
-                    .string()
-                    .optional()
-                    .openapi({
-                    param: {
-                        name: 'folderPath',
-                        in: 'query',
-                        description: 'Target folder path for uploaded files (e.g., "photos/2024")',
-                    },
-                    example: 'photos/2024',
-                }),
-            }),
-            body: {
-                content: {
-                    'multipart/form-data': {
-                        schema: MultipartBodySchema,
+        },
+        UPLOAD_COMMIT: {
+            method: 'post',
+            path: `${bucketPrefix}/upload-commit`,
+            request: {
+                body: {
+                    content: {
+                        'application/json': {
+                            // The labels sit beside the token, not inside it: the token is an HMAC over
+                            // { bucket, key, expiresAt } and deliberately carries no business fields.
+                            schema: zod_openapi_1.z.object({ commitToken: zod_openapi_1.z.string().min(1), ...uploadLabels() }),
+                        },
                     },
                 },
             },
-        },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
-                objectName: zod_openapi_1.z.string(),
-                link: zod_openapi_1.z.string(),
-                bucketName: zod_openapi_1.z.string(),
-                metaLink: zod_openapi_1.z.any().optional(),
-                metaLinkError: zod_openapi_1.z.string().optional(),
-            })),
-        }),
-    },
-    DELETE_BUCKET: {
-        method: 'delete',
-        path: '/buckets/{bucketName}',
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.object({
+                    bucket: zod_openapi_1.z.object({ name: zod_openapi_1.z.string() }),
+                    object: zod_openapi_1.z.object({ key: zod_openapi_1.z.string() }),
+                    link: zod_openapi_1.z.string(),
+                    metaLink: zod_openapi_1.z
+                        .union([zod_openapi_1.z.object({ data: zod_openapi_1.z.any() }), zod_openapi_1.z.object({ error: zod_openapi_1.z.string() })])
+                        .optional(),
                 }),
+                description: 'The object at its final key, copied out of the pending prefix',
             }),
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.object({
-                isDeleted: zod_openapi_1.z.boolean(),
-            }),
-        }),
-    },
-    DELETE_OBJECT: {
-        method: 'delete',
-        path: '/buckets/{bucketName}/objects/{objectName}',
-        // Native Hono path: /buckets/:bucketName/objects/:objectName{.+}
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
-                objectName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'objectName',
-                        in: 'path',
-                        description: 'Object name or path (e.g., "photo.jpg" or "photos/2024/photo.jpg")',
+        UPLOAD: {
+            method: 'post',
+            path: `${bucketPrefix}/objects`,
+            request: {
+                ...bucketRequest(),
+                body: {
+                    content: {
+                        'multipart/form-data': {
+                            schema: MultipartBodySchema,
+                        },
                     },
-                    example: 'photos/2024/photo.jpg',
-                }),
+                },
+            },
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
+                    bucket: zod_openapi_1.z.object({ name: zod_openapi_1.z.string() }),
+                    object: zod_openapi_1.z.object({
+                        key: zod_openapi_1.z.string(),
+                        size: zod_openapi_1.z.number(),
+                        contentType: zod_openapi_1.z.string(),
+                    }),
+                    link: zod_openapi_1.z.string(),
+                    metaLink: zod_openapi_1.z
+                        .union([zod_openapi_1.z.object({ data: zod_openapi_1.z.any() }), zod_openapi_1.z.object({ error: zod_openapi_1.z.string() })])
+                        .optional(),
+                })),
             }),
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.object({
-                success: zod_openapi_1.z.boolean(),
-            }),
-        }),
-    },
-    LIST_OBJECTS: {
-        method: 'get',
-        path: '/buckets/{bucketName}/objects',
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
+        DELETE_OBJECT: {
+            method: 'delete',
+            path: `${bucketPrefix}/objects/${objectSegment}`,
+            request: objectRequest(),
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.object({
+                    success: zod_openapi_1.z.boolean(),
                 }),
             }),
-            query: zod_openapi_1.z.object({
-                prefix: zod_openapi_1.z
-                    .string()
-                    .optional()
-                    .openapi({
-                    param: {
-                        name: 'prefix',
-                        in: 'query',
-                        description: 'Filter objects by prefix',
-                    },
-                    example: 'folder/',
-                }),
-                recursive: zod_openapi_1.z
-                    .string()
-                    .optional()
-                    .openapi({
-                    param: {
-                        name: 'recursive',
-                        in: 'query',
-                        description: 'Recursive listing',
-                    },
-                    example: 'true',
-                }),
-                maxKeys: zod_openapi_1.z
-                    .string()
-                    .optional()
-                    .openapi({
-                    param: {
-                        name: 'maxKeys',
-                        in: 'query',
-                        description: 'Maximum number of objects to return',
-                    },
-                    example: '100',
+        },
+        LIST_OBJECTS: {
+            method: 'get',
+            path: `${bucketPrefix}/objects`,
+            request: {
+                ...bucketRequest(),
+                query: zod_openapi_1.z.object({
+                    prefix: zod_openapi_1.z
+                        .string()
+                        .optional()
+                        .openapi({
+                        param: {
+                            name: 'prefix',
+                            in: 'query',
+                            description: 'Filter objects by prefix',
+                        },
+                        example: 'folder/',
+                    }),
+                    recursive: zod_openapi_1.z
+                        .string()
+                        .optional()
+                        .openapi({
+                        param: {
+                            name: 'recursive',
+                            in: 'query',
+                            description: 'Recursive listing',
+                        },
+                        example: 'true',
+                    }),
+                    maxKeys: zod_openapi_1.z
+                        .string()
+                        .optional()
+                        .openapi({
+                        param: {
+                            name: 'maxKeys',
+                            in: 'query',
+                            description: 'Maximum number of objects to return',
+                        },
+                        example: '100',
+                    }),
                 }),
+            },
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
+                    name: zod_openapi_1.z.string().optional(),
+                    size: zod_openapi_1.z.number().optional(),
+                    lastModified: zod_openapi_1.z.iso.datetime().optional(),
+                    etag: zod_openapi_1.z.string().optional(),
+                    prefix: zod_openapi_1.z.string().optional(),
+                })),
             }),
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.array(zod_openapi_1.z.object({
-                name: zod_openapi_1.z.string().optional(),
-                size: zod_openapi_1.z.number().optional(),
-                lastModified: zod_openapi_1.z.iso.datetime().optional(),
-                etag: zod_openapi_1.z.string().optional(),
-                prefix: zod_openapi_1.z.string().optional(),
-            })),
-        }),
-    },
-    RECREATE_METALINK: {
-        method: 'put',
-        path: '/buckets/{bucketName}/meta-links/{objectName}',
-        // Native Hono path: /buckets/:bucketName/meta-links/:objectName{.+} - the action prefix must precede the wildcard because the Hono catch-all is greedy.
-        request: {
-            params: zod_openapi_1.z.object({
-                bucketName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'bucketName',
-                        in: 'path',
-                    },
-                    example: 'images',
-                }),
-                objectName: zod_openapi_1.z.string().openapi({
-                    param: {
-                        name: 'objectName',
-                        in: 'path',
-                        description: 'Object name or path (e.g., "photo.jpg" or "photos/2024/photo.jpg")',
-                    },
-                    example: 'photos/2024/photo.jpg',
+        RECREATE_METALINK: {
+            method: 'put',
+            path: `${bucketPrefix}/meta-links/${objectSegment}`,
+            request: objectRequest(),
+            responses: (0, ignis_kernel_1.jsonResponse)({
+                schema: zod_openapi_1.z.object({
+                    success: zod_openapi_1.z.boolean(),
+                    metaLink: zod_openapi_1.z.any().optional(),
                 }),
             }),
         },
-        responses: (0, ignis_kernel_1.jsonResponse)({
-            schema: zod_openapi_1.z.object({
-                success: zod_openapi_1.z.boolean(),
-                metaLink: zod_openapi_1.z.any().optional(),
-            }),
-        }),
-    },
+    };
 };
+exports.buildAssetDefinitions = buildAssetDefinitions;
+/** The bucket-in-path shape, unchanged - every existing importer keeps working. */
+exports.StaticAssetDefinitions = (0, exports.buildAssetDefinitions)({});
 //# sourceMappingURL=base.definition.js.map