cabloy 5.1.97 → 5.1.98

package/vona/src/suite-vendor/a-file/modules/a-file/src/controller/file.ts

@@ -0,0 +1,167 @@
+import type { IUploadFile } from 'vona-module-a-upload';
+import type { IDecoratorControllerOptions } from 'vona-module-a-web';
+
+import { BeanBase } from 'vona';
+import { Core } from 'vona-module-a-core';
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Passport } from 'vona-module-a-user';
+import { Arg, Controller, Web } from 'vona-module-a-web';
+
+import { DtoFileDirectUploadRequest } from '../dto/fileDirectUploadRequest.ts';
+import { DtoFileDirectUploadResponse } from '../dto/fileDirectUploadResponse.ts';
+import { DtoFileDownloadRequest } from '../dto/fileDownloadRequest.ts';
+import { DtoFileUploadResponse } from '../dto/fileUploadResponse.ts';
+import { DtoFileUploadTokenRequest } from '../dto/fileUploadTokenRequest.ts';
+import { DtoFileUploadTokenResponse } from '../dto/fileUploadTokenResponse.ts';
+import { DtoFileUploadUrlRequest } from '../dto/fileUploadUrlRequest.ts';
+
+export interface IControllerOptionsFile extends IDecoratorControllerOptions {}
+
+@Controller<IControllerOptionsFile>({ path: 'file' })
+export class ControllerFile extends BeanBase {
+  @Web.post('upload-token')
+  @Api.body(DtoFileUploadTokenResponse)
+  async createUploadToken(@Arg.body() data: DtoFileUploadTokenRequest) {
+    return await this.bean.fileUploadPolicy.createUploadToken(data);
+  }
+
+  @Web.post('upload')
+  @Core.fileUpload()
+  @Api.body(DtoFileUploadResponse)
+  @Api.contentType('application/json')
+  async upload(@Arg.field('token') token: string, @Arg.file('file') file: IUploadFile) {
+    const payload = await this.bean.fileUploadPolicy.verifyUploadToken(
+      token,
+      this.ctx.route.routePathRaw,
+    );
+    await this.bean.fileUploadPolicy.validateUploadFile(
+      {
+        file: file.file,
+        filename: file.info.filename,
+        mimeType: file.info.mimeType,
+      },
+      payload,
+    );
+    const uploadedFile = await this.bean.file.upload(
+      payload.providerName,
+      {
+        file: file.file,
+        filename: file.info.filename,
+        contentType: file.info.mimeType,
+        public: payload.public,
+      },
+      {
+        clientName: payload.clientName,
+        meta: payload.meta,
+        public: payload.public,
+        fileScene: payload.fileScene,
+      },
+    );
+    return {
+      ...uploadedFile,
+      url: await this.bean.file.getDownloadUrl(uploadedFile.id),
+      signed: !uploadedFile.public,
+    };
+  }
+
+  @Web.post('direct-upload')
+  @Api.body(DtoFileDirectUploadResponse)
+  async createDirectUpload(@Arg.body() data: DtoFileDirectUploadRequest) {
+    const policy = await this.bean.fileUploadPolicy.resolveUploadPolicy({
+      fileScene: data.fileScene,
+      size: data.size,
+      mimeType: data.mimeType,
+    });
+    return await this.bean.file.createDirectUpload(
+      policy.providerName,
+      {
+        filename: data.filename,
+        contentType: data.contentType,
+        size: data.size,
+        objectKey: data.objectKey,
+        public: policy.public,
+        expiry: data.expiry,
+      },
+      {
+        clientName: policy.clientName,
+        meta: policy.meta,
+        public: policy.public,
+        fileScene: policy.fileScene,
+      },
+    );
+  }
+
+  @Web.post('upload-url')
+  @Api.body(DtoFileUploadResponse)
+  async uploadUrl(@Arg.body() data: DtoFileUploadUrlRequest) {
+    const policy = await this.bean.fileUploadPolicy.resolveUploadPolicy({
+      fileScene: data.fileScene,
+      size: data.size,
+      mimeType: data.mimeType,
+    });
+    const uploadedFile = await this.bean.file.uploadUrl(
+      policy.providerName,
+      {
+        url: data.url,
+        filename: data.filename,
+        contentType: data.contentType,
+        size: data.size,
+        objectKey: data.objectKey,
+        public: policy.public,
+      },
+      {
+        clientName: policy.clientName,
+        meta: policy.meta,
+        public: policy.public,
+        fileScene: policy.fileScene,
+      },
+    );
+    return {
+      ...uploadedFile,
+      url: await this.bean.file.getDownloadUrl(uploadedFile.id),
+      signed: !uploadedFile.public,
+    };
+  }
+
+  @Web.get('download/:fileId')
+  @Passport.public()
+  async download(
+    @Arg.param('fileId', v.tableIdentity()) fileId: number,
+    @Arg.query(v.object(DtoFileDownloadRequest)) query: DtoFileDownloadRequest,
+  ) {
+    const file = await this.bean.file.get(fileId);
+    if (!file) return this.app.throw(404);
+    if (!file.public) {
+      const payload = await this.bean.fileUploadPolicy.verifyDownloadToken(
+        query.token,
+        this.scope.util.combineApiPath(`file/download/${fileId}`, false, true),
+      );
+      if (String(payload.fileId) !== String(fileId)) {
+        return this.app.throw(401);
+      }
+    }
+    const result = await this.bean.file.download(
+      fileId,
+      file.public
+        ? undefined
+        : {
+            signed: false,
+            responseMode: 'buffer',
+          },
+    );
+    if (result.kind === 'url') {
+      if (!result.url) {
+        throw new Error(`file download url missing: ${fileId}`);
+      }
+      this.ctx.redirect(result.url);
+      return;
+    }
+    if (result.contentType) {
+      this.ctx.type = result.contentType;
+    }
+    if (result.filename) {
+      this.ctx.attachment(result.filename);
+    }
+    this.ctx.body = result.buffer;
+  }
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileDirectUploadRequest.ts

@@ -0,0 +1,33 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IDtoOptionsFileDirectUploadRequest extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileDirectUploadRequest>()
+export class DtoFileDirectUploadRequest {
+  @Api.field(z.string())
+  fileScene: keyof IFileSceneRecord;
+
+  @Api.field(v.optional())
+  filename?: string;
+
+  @Api.field(z.number().int().positive())
+  size: number;
+
+  @Api.field(z.string())
+  mimeType: string;
+
+  @Api.field(v.optional())
+  contentType?: string;
+
+  @Api.field(v.optional())
+  objectKey?: string;
+
+  @Api.field(v.optional())
+  expiry?: string;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileDirectUploadResponse.ts

@@ -0,0 +1,41 @@
+import type { TableIdentity } from 'table-identity';
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+import type { IFileProviderRecord } from '../types/fileProvider.ts';
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IDtoOptionsFileDirectUploadResponse extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileDirectUploadResponse>()
+export class DtoFileDirectUploadResponse {
+  @Api.field(v.tableIdentity())
+  id: TableIdentity;
+
+  @Api.field(z.string())
+  provider: keyof IFileProviderRecord;
+
+  @Api.field()
+  clientName: string;
+
+  @Api.field()
+  resourceId: string;
+
+  @Api.field()
+  uploadUrl: string;
+
+  @Api.field(v.optional(), z.record(z.string(), z.string()))
+  headers?: Record<string, string>;
+
+  @Api.field(v.optional(), z.enum(['PUT', 'POST']))
+  method?: 'PUT' | 'POST';
+
+  @Api.field(v.optional())
+  filename?: string;
+
+  @Api.field(v.optional(), z.string())
+  fileScene?: keyof IFileSceneRecord;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileDownloadRequest.ts

@@ -0,0 +1,12 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+
+export interface IDtoOptionsFileDownloadRequest extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileDownloadRequest>()
+export class DtoFileDownloadRequest {
+  @Api.field(v.optional())
+  token?: string;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileUploadResponse.ts

@@ -0,0 +1,59 @@
+import type { TableIdentity } from 'table-identity';
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+import type { IFileProviderRecord } from '../types/fileProvider.ts';
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IDtoOptionsFileUploadResponse extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileUploadResponse>()
+export class DtoFileUploadResponse {
+  @Api.field(v.tableIdentity())
+  id: TableIdentity;
+
+  @Api.field(z.string())
+  provider: keyof IFileProviderRecord;
+
+  @Api.field()
+  clientName: string;
+
+  @Api.field()
+  resourceId: string;
+
+  @Api.field(v.optional())
+  bucket?: string;
+
+  @Api.field(v.optional())
+  objectKey?: string;
+
+  @Api.field(v.optional())
+  filename?: string;
+
+  @Api.field(v.optional())
+  contentType?: string;
+
+  @Api.field(v.optional())
+  size?: number;
+
+  @Api.field(v.optional())
+  etag?: string;
+
+  @Api.field(v.optional())
+  public?: boolean;
+
+  @Api.field(v.optional(), z.string())
+  fileScene?: keyof IFileSceneRecord;
+
+  @Api.field(v.optional())
+  uploadedAt?: Date;
+
+  @Api.field(v.optional())
+  url?: string;
+
+  @Api.field(v.optional())
+  signed?: boolean;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileUploadTokenRequest.ts

@@ -0,0 +1,24 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IDtoOptionsFileUploadTokenRequest extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileUploadTokenRequest>()
+export class DtoFileUploadTokenRequest {
+  @Api.field(z.string())
+  fileScene: keyof IFileSceneRecord;
+
+  @Api.field(z.number().int().positive())
+  size: number;
+
+  @Api.field(z.string())
+  mimeType: string;
+
+  @Api.field(v.optional(), z.number().int().positive())
+  expiresIn?: number;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileUploadTokenResponse.ts

@@ -0,0 +1,16 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+export interface IDtoOptionsFileUploadTokenResponse extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileUploadTokenResponse>()
+export class DtoFileUploadTokenResponse {
+  @Api.field(z.string())
+  token: string;
+
+  @Api.field(v.optional(), z.number().int().positive())
+  expiresIn?: number;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/dto/fileUploadUrlRequest.ts

@@ -0,0 +1,33 @@
+import type { IDecoratorDtoOptions } from 'vona-module-a-web';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Dto } from 'vona-module-a-web';
+import z from 'zod';
+
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IDtoOptionsFileUploadUrlRequest extends IDecoratorDtoOptions {}
+
+@Dto<IDtoOptionsFileUploadUrlRequest>()
+export class DtoFileUploadUrlRequest {
+  @Api.field(z.string())
+  fileScene: keyof IFileSceneRecord;
+
+  @Api.field(z.string().url())
+  url: string;
+
+  @Api.field(z.number().int().positive())
+  size: number;
+
+  @Api.field(z.string())
+  mimeType: string;
+
+  @Api.field(v.optional())
+  filename?: string;
+
+  @Api.field(v.optional())
+  contentType?: string;
+
+  @Api.field(v.optional())
+  objectKey?: string;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/entity/file.ts

@@ -0,0 +1,55 @@
+import type { IDecoratorEntityOptions } from 'vona-module-a-orm';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Entity, EntityBase } from 'vona-module-a-orm';
+import z from 'zod';
+
+import type { IFileProviderRecord } from '../types/fileProvider.ts';
+import type { IFileSceneRecord } from '../types/fileScene.ts';
+
+export interface IEntityOptionsFile extends IDecoratorEntityOptions {}
+
+@Entity<IEntityOptionsFile>('aFile')
+export class EntityFile extends EntityBase {
+  @Api.field(z.string())
+  providerName: keyof IFileProviderRecord;
+
+  @Api.field()
+  clientName: string;
+
+  @Api.field()
+  resourceId: string;
+
+  @Api.field(v.optional())
+  bucket?: string;
+
+  @Api.field(v.optional())
+  objectKey?: string;
+
+  @Api.field(v.optional())
+  filename?: string;
+
+  @Api.field(v.optional())
+  contentType?: string;
+
+  @Api.field(v.optional())
+  size?: number;
+
+  @Api.field(v.optional())
+  etag?: string;
+
+  @Api.field(v.optional())
+  public?: boolean;
+
+  @Api.field(v.optional())
+  meta?: Record<string, any>;
+
+  @Api.field(v.optional())
+  storagePath?: string;
+
+  @Api.field(v.optional())
+  deliveryBaseUrl?: string;
+
+  @Api.field(v.optional(), z.string())
+  fileScene?: keyof IFileSceneRecord;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/entity/fileProvider.ts

@@ -0,0 +1,24 @@
+import type { IDecoratorEntityOptions } from 'vona-module-a-orm';
+
+import { Api, v } from 'vona-module-a-openapiutils';
+import { Entity, EntityBaseSimple } from 'vona-module-a-orm';
+import z from 'zod';
+
+import type { IFileProviderClientOptions, IFileProviderRecord } from '../types/fileProvider.ts';
+
+export interface IEntityOptionsFileProvider extends IDecoratorEntityOptions {}
+
+@Entity<IEntityOptionsFileProvider>('aFileProvider')
+export class EntityFileProvider extends EntityBaseSimple {
+  @Api.field(v.default(false))
+  disabled: boolean;
+
+  @Api.field(z.string())
+  providerName: keyof IFileProviderRecord;
+
+  @Api.field()
+  clientName: string;
+
+  @Api.field(v.optional())
+  clientOptions?: IFileProviderClientOptions;
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/index.ts

@@ -0,0 +1,4 @@
+export * from './.metadata/locales.ts';
+export * from './.metadata/index.ts';
+export * from './lib/index.ts';
+export * from './types/index.ts';

package/vona/src/suite-vendor/a-file/modules/a-file/src/lib/fileProvider.ts

@@ -0,0 +1,7 @@
+import { createBeanDecorator } from 'vona';
+
+import type { IDecoratorFileProviderOptions } from '../types/fileProvider.ts';
+
+export function FileProvider<T extends IDecoratorFileProviderOptions>(options?: T): ClassDecorator {
+  return createBeanDecorator('fileProvider', options);
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/lib/fileScene.ts

@@ -0,0 +1,7 @@
+import { createBeanDecorator } from 'vona';
+
+import type { IDecoratorFileSceneOptions } from '../types/fileScene.ts';
+
+export function FileScene(options?: IDecoratorFileSceneOptions): ClassDecorator {
+  return createBeanDecorator('fileScene', options);
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/lib/fileUploadValidation.ts

@@ -0,0 +1,15 @@
+import path from 'node:path';
+
+export function matchesFileMimeType(mimeType: string, mimeTypes: string[]) {
+  return mimeTypes.some(item => {
+    if (item === mimeType) return true;
+    if (item.endsWith('/*')) {
+      return mimeType.startsWith(`${item.slice(0, -1)}`);
+    }
+    return false;
+  });
+}
+
+export function getFileExtension(filename?: string) {
+  return path.extname(filename ?? '').toLowerCase();
+}

package/vona/src/suite-vendor/a-file/modules/a-file/src/lib/index.ts

@@ -0,0 +1,3 @@
+export * from './fileProvider.ts';
+export * from './fileScene.ts';
+export * from './fileUploadValidation.ts';

package/vona/src/suite-vendor/a-file/modules/a-file/src/model/file.ts

@@ -0,0 +1,10 @@
+import type { IDecoratorModelOptions } from 'vona-module-a-orm';
+
+import { BeanModelBase, Model } from 'vona-module-a-orm';
+
+import { EntityFile } from '../entity/file.ts';
+
+export interface IModelOptionsFile extends IDecoratorModelOptions<EntityFile> {}
+
+@Model<IModelOptionsFile>({ entity: EntityFile, disableDeleted: true })
+export class ModelFile extends BeanModelBase<EntityFile> {}

package/vona/src/suite-vendor/a-file/modules/a-file/src/model/fileProvider.ts

@@ -0,0 +1,10 @@
+import type { IDecoratorModelOptions } from 'vona-module-a-orm';
+
+import { BeanModelBase, Model } from 'vona-module-a-orm';
+
+import { EntityFileProvider } from '../entity/fileProvider.ts';
+
+export interface IModelOptionsFileProvider extends IDecoratorModelOptions<EntityFileProvider> {}
+
+@Model<IModelOptionsFileProvider>({ entity: EntityFileProvider, disableDeleted: true })
+export class ModelFileProvider extends BeanModelBase<EntityFileProvider> {}

package/vona/src/suite-vendor/a-file/modules/a-file/src/types/file.ts

@@ -0,0 +1,144 @@
+import type { TableIdentity } from 'table-identity';
+
+import type { IFileProviderClientOptions, IFileProviderRecord } from './fileProvider.ts';
+import type { IFileSceneRecord } from './fileScene.ts';
+
+export type TypeFileMeta = Record<string, unknown>;
+export type TypeFileDeliveryExpiry = Date | string | number;
+
+export interface IFileDeliveryOptions {
+  signed?: boolean;
+  expiresIn?: number;
+  expiresAt?: TypeFileDeliveryExpiry;
+  responseMode?: 'auto' | 'buffer' | 'url';
+}
+
+export interface IFileUploadInput<TMeta extends TypeFileMeta = TypeFileMeta> {
+  file: string;
+  filename?: string;
+  contentType?: string;
+  size?: number;
+  objectKey?: string;
+  public?: boolean;
+  meta?: TMeta;
+}
+
+export interface IFileUploadUrlInput<TMeta extends TypeFileMeta = TypeFileMeta> {
+  url: string;
+  filename?: string;
+  contentType?: string;
+  size?: number;
+  objectKey?: string;
+  public?: boolean;
+  meta?: TMeta;
+}
+
+export interface IFileDirectUploadInput<TMeta extends TypeFileMeta = TypeFileMeta> {
+  filename?: string;
+  contentType?: string;
+  size?: number;
+  objectKey?: string;
+  public?: boolean;
+  meta?: TMeta;
+  expiry?: TypeFileDeliveryExpiry;
+}
+
+export interface IFileUploadContextResolved<TMeta extends TypeFileMeta = TypeFileMeta> {
+  fileScene: keyof IFileSceneRecord;
+  providerName: keyof IFileProviderRecord;
+  clientName: string;
+  public: boolean;
+  meta?: TMeta;
+}
+
+export interface IFileDownloadResult {
+  kind: 'url' | 'buffer';
+  url?: string;
+  buffer?: Buffer;
+  filename?: string;
+  contentType?: string;
+  signed?: boolean;
+}
+
+export interface IFileProviderResource<TMeta extends TypeFileMeta = TypeFileMeta, TRaw = unknown> {
+  resourceId: string;
+  bucket?: string;
+  objectKey?: string;
+  filename?: string;
+  contentType?: string;
+  size?: number;
+  etag?: string;
+  public?: boolean;
+  meta?: TMeta;
+  storagePath?: string;
+  deliveryBaseUrl?: string;
+  raw?: TRaw;
+}
+
+export interface IFileProviderDirectUploadResource<
+  TMeta extends TypeFileMeta = TypeFileMeta,
+  TRaw = unknown,
+> extends IFileProviderResource<TMeta, TRaw> {
+  uploadUrl: string;
+  headers?: Record<string, string>;
+  method?: 'PUT' | 'POST';
+}
+
+export interface IFileResource<
+  TMeta extends TypeFileMeta = TypeFileMeta,
+  TRaw = unknown,
+> extends IFileProviderResource<TMeta, TRaw> {
+  id: TableIdentity;
+  provider: keyof IFileProviderRecord;
+  clientName: string;
+  fileScene?: keyof IFileSceneRecord | string;
+  uploadedAt?: Date;
+}
+
+export interface IFileDirectUploadResult<
+  TMeta extends TypeFileMeta = TypeFileMeta,
+  TRaw = unknown,
+> extends IFileResource<TMeta, TRaw> {
+  uploadUrl: string;
+  headers?: Record<string, string>;
+  method?: 'PUT' | 'POST';
+}
+
+export interface IFileUploadOptions<
+  TClientOptions extends IFileProviderClientOptions = IFileProviderClientOptions,
+  TMeta extends TypeFileMeta = TypeFileMeta,
+> {
+  clientName?: string;
+  clientOptions?: TClientOptions;
+  public?: boolean;
+  meta?: TMeta;
+  fileScene?: keyof IFileSceneRecord;
+}
+
+export interface IFileUploadPolicyResolved<
+  TMeta extends TypeFileMeta = TypeFileMeta,
+> extends IFileUploadContextResolved<TMeta> {
+  maxSize?: number;
+  mimeTypes?: string[];
+  extensions?: string[];
+  multiple?: boolean;
+  fileSize: number;
+  mimeType: string;
+}
+
+export interface IFileUploadTokenPayload<
+  TMeta extends TypeFileMeta = TypeFileMeta,
+> extends IFileUploadPolicyResolved<TMeta> {
+  kind: 'fileUpload';
+}
+
+export interface IFileDownloadTokenPayload {
+  kind: 'fileDownload';
+  fileId: TableIdentity;
+}
+
+declare module 'vona' {
+  export interface ILoggerChildRecord {
+    file: never;
+  }
+}