@punks/backend-entity-manager 0.0.121 → 0.0.122

package/dist/cjs/types/abstractions/files.d.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" />
+export type FileData = {
+    content: Buffer;
+    contentType: string;
+    fileName: string;
+    folderPath: string;
+    metadata?: Record<string, any>;
+};
+export type FileDownloadUrl = {
+    downloadUrl: string;
+    contentType: string;
+    fileName: string;
+};
+export type FileReference = {
+    fileId: string;
+    reference: string;
+    providerId: string;
+};
+export interface IFileManager {
+    uploadFile(file: FileData): Promise<FileReference>;
+    getFileContent(fileId: string): Promise<FileData>;
+    getFileDownloadUrl(fileId: string): Promise<FileDownloadUrl>;
+}
+export type FilesReferenceData = {
+    reference: string;
+    providerId: string;
+    metadata?: Record<string, any>;
+    fileName: string;
+    filePath: string;
+    fileSize: number;
+    contentType: string;
+};
+export type FileReferenceRecord = FilesReferenceData & {
+    fileId: string;
+    createdOn: Date;
+    updatedOn: Date;
+};
+export interface IFilesReferenceRepository {
+    getReference(fileId: string): Promise<FileReferenceRecord>;
+    createReference(file: FilesReferenceData): Promise<FileReferenceRecord>;
+    updateReference(fileId: string, file: FilesReferenceData): Promise<FileReferenceRecord>;
+    deleteReference(fileId: string): Promise<void>;
+}
+export type FileProviderReference = {
+    reference: string;
+};
+export type FileProviderUploadData = {
+    fileName: string;
+    content: Buffer;
+    contentType: string;
+};
+export type FileProviderDownloadData = {
+    content: Buffer;
+};
+export type FileProviderDownloadUrl = {
+    downloadUrl: string;
+};
+export interface IFileProvider {
+    getProviderId(): string;
+    uploadFile(file: FileProviderUploadData): Promise<FileProviderReference>;
+    deleteFile(reference: FileProviderReference): Promise<void>;
+    downloadFile(reference: FileProviderReference): Promise<FileProviderDownloadData>;
+    getFileProviderDownloadUrl(reference: FileProviderReference): Promise<FileProviderDownloadUrl>;
+}

package/dist/cjs/types/abstractions/index.d.ts

@@ -11,6 +11,7 @@ export * from "./email";
 export * from "./errors";
 export { IEntityEventsManager } from "./events";
 export { EntitiesExportFile, EntitiesExportInput, EntitiesExportOptions, EntitiesExportResult, EntitiesImportExportSettings, EntitiesSampleDownloadOptions, EntitiesSampleDownloadResult, EntityExportBucketSettings, } from "./export";
+export * from "./files";
 export * from "./filters";
 export { EntitiesImportInput, EntitiesImportResult, EntitiesImportStatistics, } from "./import";
 export * from "./localization";

package/dist/cjs/types/abstractions/settings.d.ts

@@ -1,7 +1,8 @@
 import { EntitiesImportExportSettings } from "./export";
 export type EntityManagerSettings = {
     importExport: EntitiesImportExportSettings;
-    defaultBuckerProvider: string;
+    defaultBucketProvider: string;
+    defaultFilesProvider: string;
 };
 export type EntityVersioningOptions = {
     enabled: boolean;

package/dist/cjs/types/platforms/nest/__test__/server/database/core/entities/appFileReference.entity.d.ts

@@ -0,0 +1,13 @@
+export type AppFileReferenceEntityId = string;
+export declare class AppFileReferenceEntity {
+    id: string;
+    reference: string;
+    provider: string;
+    folder: string;
+    fileName: string;
+    contentType: string;
+    fileSize: number;
+    metadata?: any;
+    createdOn: Date;
+    updatedOn: Date;
+}

package/dist/cjs/types/platforms/nest/__test__/server/database/core/index.d.ts

@@ -14,6 +14,7 @@ import { DynamicModule } from "@nestjs/common";
 import { AppEntityVersionEntity } from "./entities/appEntityVersion.entity";
 import { AppDirectoryEntity } from "./entities/appDirectory.entity";
 import { CrmContactEntity } from "./entities/crmContact.entity";
+import { AppFileReferenceEntity } from "./entities/appFileReference.entity";
 export declare const mockDatabaseProviders: (dataSource: DataSource) => ({
     provide: string | Function;
     useValue: import("typeorm").Repository<AppCompanyEntity>;
@@ -26,6 +27,9 @@ export declare const mockDatabaseProviders: (dataSource: DataSource) => ({
 } | {
     provide: string | Function;
     useValue: import("typeorm").Repository<AppEntityVersionEntity>;
+} | {
+    provide: string | Function;
+    useValue: import("typeorm").Repository<AppFileReferenceEntity>;
 } | {
     provide: string | Function;
     useValue: import("typeorm").Repository<FooEntity>;

package/dist/cjs/types/platforms/nest/__test__/server/database/core/repositories/appFileReference.repository.d.ts

@@ -0,0 +1,11 @@
+import { Repository } from "typeorm";
+import { NestTypeOrmRepository } from "../../../../..";
+import { AppFileReferenceEntity, AppFileReferenceEntityId } from "../entities/appFileReference.entity";
+import { FileReferenceRecord, FilesReferenceData, IFilesReferenceRepository } from "../../../../../../../abstractions";
+export declare class AppFileReferenceRepository extends NestTypeOrmRepository<AppFileReferenceEntity, AppFileReferenceEntityId> implements IFilesReferenceRepository {
+    constructor(repository: Repository<AppFileReferenceEntity>);
+    getReference(fileId: string): Promise<FileReferenceRecord>;
+    createReference(file: FilesReferenceData): Promise<FileReferenceRecord>;
+    updateReference(fileId: string, file: FilesReferenceData): Promise<FileReferenceRecord>;
+    deleteReference(fileId: string): Promise<void>;
+}

package/dist/cjs/types/platforms/nest/__test__/server/database/core/repositories.d.ts

@@ -2,6 +2,7 @@ import { AppCompanyRepository } from "./repositories/appCompany.repository";
 import { AppDirectoryRepository } from "./repositories/appDirectory.repository";
 import { AppDivisionRepository } from "./repositories/appDivision.repository";
 import { AppEntityVersionRepository } from "./repositories/appEntityVersion.repository";
+import { AppFileReferenceRepository } from "./repositories/appFileReference.repository";
 import { AppOrganizationRepository } from "./repositories/appOrganization.repository";
 import { AppRoleRepository } from "./repositories/appRole.repository";
 import { AppTenantRepository } from "./repositories/appTenant.repository";
@@ -12,4 +13,4 @@ import { AppUserProfileRepository } from "./repositories/appUserProfile.reposito
 import { AppUserRoleRepository } from "./repositories/appUserRole.repository";
 import { CrmContactRepository } from "./repositories/crmContact.repository";
 import { FooRepository } from "./repositories/foo.repository";
-export declare const CoreDatabaseRepositories: (typeof AppCompanyRepository | typeof AppDirectoryRepository | typeof AppDivisionRepository | typeof AppEntityVersionRepository | typeof AppOrganizationRepository | typeof AppRoleRepository | typeof AppTenantRepository | typeof AppUserRepository | typeof AppUserGroupRepository | typeof AppUserGroupMemberRepository | typeof AppUserProfileRepository | typeof AppUserRoleRepository | typeof CrmContactRepository | typeof FooRepository)[];
+export declare const CoreDatabaseRepositories: (typeof AppCompanyRepository | typeof AppDirectoryRepository | typeof AppDivisionRepository | typeof AppEntityVersionRepository | typeof AppFileReferenceRepository | typeof AppOrganizationRepository | typeof AppRoleRepository | typeof AppTenantRepository | typeof AppUserRepository | typeof AppUserGroupRepository | typeof AppUserGroupMemberRepository | typeof AppUserProfileRepository | typeof AppUserRoleRepository | typeof CrmContactRepository | typeof FooRepository)[];

package/dist/cjs/types/platforms/nest/decorators/files.d.ts

@@ -0,0 +1,7 @@
+export interface FileProviderProps {
+    providerId: string;
+}
+export declare const WpFileProvider: (providerId: string) => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;
+export interface FileReferenceRepositoryProps {
+}
+export declare const WpFileReferenceRepository: () => <TFunction extends Function, Y>(target: object | TFunction, propertyKey?: string | symbol | undefined, descriptor?: TypedPropertyDescriptor<Y> | undefined) => void;

package/dist/cjs/types/platforms/nest/decorators/symbols.d.ts

@@ -16,5 +16,7 @@ export declare const EntityManagerSymbols: {
     EmailProvider: symbol;
     EmailTemplate: symbol;
     BucketProvider: symbol;
+    FileProvider: symbol;
+    FileReferenceRepository: symbol;
     PipelineTemplate: symbol;
 };

package/dist/cjs/types/platforms/nest/plugins/buckets/aws-s3/index.d.ts

@@ -1,4 +1,4 @@
 export { AwsS3BucketError as AwsS2BucketError } from "./errors";
 export { AwsBucketModule } from "./module";
-export { AwsS3BucketProvider } from "./provider";
+export { AwsS3BucketProvider } from "./provider/bucket";
 export { AwsBucketSettings } from "./settings";

package/dist/cjs/types/platforms/nest/plugins/buckets/aws-s3/provider/bucket.d.ts

@@ -0,0 +1,14 @@
+/// <reference types="node" />
+import { BucketFileDeleteInput, BucketFileDownloadInput, BucketFilePublicUrlCreateInput, BucketFileUploadInput, BucketFolderEnsureInput, BucketFolderExistsInput, BucketFolderListInput, BucketFolderListResult, IBucketProvider } from "../../../../../../abstractions/buckets";
+export declare class AwsS3BucketProvider implements IBucketProvider {
+    private readonly client;
+    constructor();
+    folderList(input: BucketFolderListInput): Promise<BucketFolderListResult>;
+    folderEnsure(input: BucketFolderEnsureInput): Promise<void>;
+    folderCreate(input: BucketFolderEnsureInput): Promise<void>;
+    folderExists(input: BucketFolderExistsInput): Promise<boolean>;
+    fileDownload(input: BucketFileDownloadInput): Promise<Buffer>;
+    filePublicUrlCreate(input: BucketFilePublicUrlCreateInput): Promise<string>;
+    fileUpload(input: BucketFileUploadInput): Promise<void>;
+    fileDelete(input: BucketFileDeleteInput): Promise<void>;
+}

package/dist/cjs/types/platforms/nest/plugins/buckets/aws-s3/provider/files.d.ts

@@ -0,0 +1,12 @@
+import { FileProviderDownloadData, FileProviderDownloadUrl, FileProviderReference, FileProviderUploadData, IFileProvider } from "../../../../../../abstractions";
+import { AwsS3BucketProvider } from "./bucket";
+export declare class AwsS3FileProvider implements IFileProvider {
+    private readonly bucket;
+    constructor(bucket: AwsS3BucketProvider);
+    getProviderId(): string;
+    uploadFile(file: FileProviderUploadData): Promise<FileProviderReference>;
+    deleteFile(reference: FileProviderReference): Promise<void>;
+    downloadFile(reference: FileProviderReference): Promise<FileProviderDownloadData>;
+    getFileProviderDownloadUrl(reference: FileProviderReference): Promise<FileProviderDownloadUrl>;
+    private getBucketFileUploadPath;
+}

package/dist/cjs/types/platforms/nest/plugins/buckets/aws-s3/provider/index.d.ts

@@ -1,14 +1,2 @@
-/// <reference types="node" />
-import { BucketFileDeleteInput, BucketFileDownloadInput, BucketFilePublicUrlCreateInput, BucketFileUploadInput, BucketFolderEnsureInput, BucketFolderExistsInput, BucketFolderListInput, BucketFolderListResult, IBucketProvider } from "../../../../../../abstractions/buckets";
-export declare class AwsS3BucketProvider implements IBucketProvider {
-    private readonly client;
-    constructor();
-    folderList(input: BucketFolderListInput): Promise<BucketFolderListResult>;
-    folderEnsure(input: BucketFolderEnsureInput): Promise<void>;
-    folderCreate(input: BucketFolderEnsureInput): Promise<void>;
-    folderExists(input: BucketFolderExistsInput): Promise<boolean>;
-    fileDownload(input: BucketFileDownloadInput): Promise<Buffer>;
-    filePublicUrlCreate(input: BucketFilePublicUrlCreateInput): Promise<string>;
-    fileUpload(input: BucketFileUploadInput): Promise<void>;
-    fileDelete(input: BucketFileDeleteInput): Promise<void>;
-}
+export { AwsS3BucketProvider } from "./bucket";
+export { AwsS3FileProvider } from "./files";

package/dist/cjs/types/platforms/nest/plugins/buckets/aws-s3/settings/index.d.ts

@@ -1,8 +1,13 @@
 import { AppInMemorySettings } from "../../../../../../settings";
+export type AwsBucketPaths = {
+    filesUpload: string;
+};
 export type AwsBucketSettings = {
     awsAccessKeyId?: string;
     awsSecretAccessKey?: string;
     region?: string;
     defaultBucket: string;
+    publicLinksExpirationMinutes: number;
+    paths: AwsBucketPaths;
 };
 export declare const awsBucketSettings: AppInMemorySettings<AwsBucketSettings>;

package/dist/cjs/types/platforms/nest/plugins/buckets/testing/mock.d.ts

@@ -1,5 +1,15 @@
 /// <reference types="node" />
+import { FileProviderDownloadData, FileProviderDownloadUrl, FileProviderReference, FileProviderUploadData, IFileProvider } from "../../../../../abstractions";
 import { BucketFileDeleteInput, BucketFileDownloadInput, BucketFilePublicUrlCreateInput, BucketFileUploadInput, BucketFolderEnsureInput, BucketFolderExistsInput, BucketFolderListInput, BucketFolderListResult, IBucketProvider } from "../../../../../abstractions/buckets";
+export declare class InMemoryFileProvider implements IFileProvider {
+    private readonly provider;
+    constructor();
+    getProviderId(): string;
+    uploadFile(file: FileProviderUploadData): Promise<FileProviderReference>;
+    deleteFile(reference: FileProviderReference): Promise<void>;
+    downloadFile(reference: FileProviderReference): Promise<FileProviderDownloadData>;
+    getFileProviderDownloadUrl(reference: FileProviderReference): Promise<FileProviderDownloadUrl>;
+}
 export declare class InMemoryBucketProvider implements IBucketProvider {
     private inMemoryStorage;
     private inMemoryFolders;

package/dist/cjs/types/platforms/nest/processors/initializer/index.d.ts

@@ -20,7 +20,9 @@ export declare class EntityManagerInitializer {
     private registerEntities;
     private executeInitializers;
     private executeSeeders;
+    private registerFileProviders;
     private registerBucketProviders;
+    private registerFilesReferenceRepositoryProviders;
     private registerEventTrackingProviders;
     private registerVersioningProviders;
     private registerEmailProviders;
@@ -41,4 +43,6 @@ export declare class EntityManagerInitializer {
     private discoverEmailProviders;
     private discoverEventTrackingProviders;
     private discoverBucketProviders;
+    private discoverFileProviders;
+    private discoverFilesReferenceRepositoryProviders;
 }

package/dist/cjs/types/platforms/nest/services/files/index.d.ts

@@ -0,0 +1,12 @@
+import { FileData, FileDownloadUrl, FileReference, IFileManager } from "../../../../abstractions";
+import { EntityManagerRegistry } from "../../ioc";
+export declare class FilesService implements IFileManager {
+    private readonly registry;
+    constructor(registry: EntityManagerRegistry);
+    uploadFile(file: FileData): Promise<FileReference>;
+    getFileContent(fileId: string): Promise<FileData>;
+    getFileDownloadUrl(fileId: string): Promise<FileDownloadUrl>;
+    private getFileProvider;
+    private get defaultFileProvider();
+    private get referencesRepo();
+}

package/dist/cjs/types/platforms/nest/services/index.d.ts

@@ -2,5 +2,6 @@ export { AppSessionService } from "./session";
 export { AppHashingService } from "./hashing";
 export { EntityManagerService } from "./manager";
 export { EmailService } from "./email";
+export { FilesService } from "./files";
 export { EventsService } from "./events";
 export { TrackingService } from "./tracking";

package/dist/cjs/types/platforms/nest/services/providers.d.ts

@@ -1,7 +1,8 @@
 import { EmailService } from "./email";
 import { EventsService } from "./events";
+import { FilesService } from "./files";
 import { AppHashingService } from "./hashing";
 import { EntityManagerService } from "./manager";
 import { AppSessionService } from "./session";
 import { TrackingService } from "./tracking";
-export declare const Services: (typeof AppSessionService | typeof AppHashingService | typeof EntityManagerService | typeof EmailService | typeof EventsService | typeof TrackingService)[];
+export declare const Services: (typeof AppSessionService | typeof AppHashingService | typeof EntityManagerService | typeof EmailService | typeof FilesService | typeof EventsService | typeof TrackingService)[];

package/dist/cjs/types/providers/services.d.ts

@@ -1,4 +1,4 @@
-import { IAuthenticationContext, IAuthenticationContextProvider, IBucketProvider, IEmailProvider, IEmailTemplatesCollection, IEntityFacets, IEntitySerializer, IEntityVersioningProvider, IEventLog, IEventsTracker } from "../abstractions";
+import { IAuthenticationContext, IAuthenticationContextProvider, IBucketProvider, IEmailProvider, IEmailTemplatesCollection, IEntityFacets, IEntitySerializer, IEntityVersioningProvider, IEventLog, IEventsTracker, IFileProvider, IFilesReferenceRepository } from "../abstractions";
 import { IEntitiesCountAction, IEntitiesDeleteAction, IEntitiesExportAction, IEntitiesImportAction, IEntitiesSampleDownloadAction, IEntitiesSearchAction, IEntityActions, IEntityCreateAction, IEntityDeleteAction, IEntityExistsAction, IEntityGetAction, IEntityUpdateAction, IEntityUpsertAction, IEntityVersionsSearchAction } from "../abstractions/actions";
 import { IEntityAdapter } from "../abstractions/adapters";
 import { IEntityAuthorizationMiddleware } from "../abstractions/authorization";
@@ -79,8 +79,13 @@ export declare class EntitiesServiceLocator {
     resolveEntityVersioningProvider<TEntityVersioningProvider extends IEntityVersioningProvider>(): TEntityVersioningProvider;
     registerEntityVersioningProvider<TEntityVersioningProvider extends IEntityVersioningProvider>(instance: TEntityVersioningProvider): void;
     resolveDefaultBucketProvider<TBucketProvider extends IBucketProvider>(): TBucketProvider;
-    resolveBucketProviders<TBucketProvider extends IBucketProvider>(): TBucketProvider[];
-    registerBucketProvider<TBucketProvider extends IBucketProvider>(name: string, instance: TBucketProvider): void;
+    resolveDefaultFilesProvider<TFileProvider extends IFileProvider>(): TFileProvider;
+    resolveBucketProviders<TBucketProvider extends IFileProvider>(): TBucketProvider[];
+    registerBucketProvider<TBucketProvider extends IBucketProvider>(name: string, instance: TBucketProvider): this;
+    resolveFileProvider<TFileProvider extends IFileProvider>(providerId: string): TFileProvider;
+    registerFileProvider<TFileProvider extends IFileProvider>(name: string, instance: TFileProvider): this;
+    resolveFilesReferenceRepositoryProviders<TFilesReferenceRepo extends IFilesReferenceRepository>(): TFilesReferenceRepo;
+    registerFilesReferenceRepositoryProviders<TFilesReferenceRepo extends IFilesReferenceRepository>(instance: TFilesReferenceRepo): void;
     resolveEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(): TEventsTracker;
     registerEventsTracker<TEventsTracker extends IEventsTracker<TEventLog>, TEventLog extends IEventLog<unknown>>(instance: TEventsTracker): void;
     resolveEmailTemplatesCollection(): IEmailTemplatesCollection;

package/dist/cjs/types/symbols/ioc.d.ts

@@ -67,6 +67,9 @@ export declare const EntityServices: {
     };
 };
 export declare const GlobalServices: {
+    Files: {
+        IFilesReferenceRepo: string;
+    };
     Events: {
         IEventEmitter: string;
         IEventsTracker: string;
@@ -81,6 +84,7 @@ export declare const GlobalServices: {
         IEmailProvider: string;
         IEmailTemplatesCollection: string;
         IBucketProvider: string;
+        IFileProvider: string;
     };
     Settings: {
         EntityManagerSettings: string;