@stemy/backend 5.1.1 → 5.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stemy/backend",
-  "version": "5.1.1",
+  "version": "5.2.1",
   "license": "MIT",
   "repository": "git@github.com:stemyke/node-backend.git",
   "builders": "builders.json",

package/public_api.d.ts

@@ -1,7 +1,9 @@
 import { IBackendConfig, IDependencyContainer, IRequest, IUser, Provider } from "./common-types";
 export { FilterPredicate, isNullOrUndefined, isDefined, getType, isObject, isArray, isBuffer, isBoolean, isDate, isPrimitive, isString, isFunction, isConstructor, isType, isInterface, ucFirst, lcFirst, isObjectId, firstItem, lastItem, regroup, uniqueItems, getValue, groupBy, convertValue, toImage, bufferToStream, streamToBuffer, copyStream, mkdirRecursive, deleteFile, readFile, readAndDeleteFile, writeFile, valueToPromise, promiseTimeout, getConstructorName, getFunctionParams, getFileName, getExtension, createIdString, idToString, createTransformer, broadcast, rand, random, multiSubscription, observableFromFunction, padLeft, padRight, camelCaseToDash, gzipPromised, gunzipPromised, deleteFromBucket, filter, copy, assign, md5, runCommand, ConsoleColor, IJsonColors, colorize, jsonHighlight, replaceSpecialChars, regexEscape, flatten, wrapError, getDirName, prepareUrl, prepareUrlSlash, prepareUrlEmpty, fileTypeFromBuffer, fileTypeFromStream } from "./utils";
 export { IsFile, IsObjectId } from "./validators";
-export { FIXTURE, JOB, TERMINAL_COMMAND, EXPRESS, HTTP_SERVER, SOCKET_SERVER, SOCKET_CONTROLLERS, PARAMETER, DI_CONTAINER, OPENAPI_VALIDATION, Type, FactoryProvider, IDependencyContainer, ClassBasedProvider, ValueBasedProvider, FactoryBasedProvider, TokenBasedProvider, SyringeProvider, Provider, Constructor, InferGeneric, PickMatching, OmitFirstArg, IMatchField, IProjectOptions, IUnwindOptions, IFixture, IFixtureOutput, SchemaConverter, OpenApiValidation, ParamResolver, Parameter, SocketParam, SocketParams, ISocketMessage, IMessageBridge, IJob, IJobTask, JobParams, JobScheduleRange, JobScheduleTime, ITerminalFile, ITerminal, ITerminalCommand, IProgress, IAssetCropInfo, IAssetMeta, IAssetImageParams, IAsset, ILazyAsset, IUser, IClientSocket, IRequestBase, IRequest, IGalleryImage, IGallerySize, IGalleryImageHandler, ITranslations, IPaginationMeta, IPaginationBase, IPagination, IPaginationParams, FontFormat, IFileType, RoutingOptions, SocketOptions, IBackendConfig } from "./common-types";
+export { FIXTURE, JOB, TERMINAL_COMMAND, EXPRESS, HTTP_SERVER, SOCKET_SERVER, SOCKET_CONTROLLERS, PARAMETER, DI_CONTAINER, OPENAPI_VALIDATION, Type, FactoryProvider, IDependencyContainer, ClassBasedProvider, ValueBasedProvider, FactoryBasedProvider, TokenBasedProvider, SyringeProvider, Provider, Constructor, InferGeneric, PickMatching, OmitFirstArg, IMatchField, IProjectOptions, IUnwindOptions, IFixture, IFixtureOutput, SchemaConverter, OpenApiValidation, ParamResolver, Parameter, SocketParam, SocketParams, ISocketMessage, IMessageBridge, IJob, IJobTask, JobParams, JobScheduleRange, JobScheduleTime, ITerminalFile, ITerminal, ITerminalCommand, IProgress, IAssetCropInfo, IImageMeta, IAssetMeta, IAssetImageParams, IAsset, IAssetUploadStream, IAssetUploadOpts, IAssetDriver, ILazyAsset, IUser, IClientSocket, IRequestBase, IRequest, IGalleryImage, IGallerySize, IGalleryImageHandler, ITranslations, IPaginationMeta, IPaginationBase, IPagination, IPaginationParams, FontFormat, IFileType, RoutingOptions, SocketOptions, IBackendConfig } from "./common-types";
+export { AssetLocalDriver } from "./services/drivers/asset-local.driver";
+export { AssetGridDriver } from "./services/drivers/asset-grid.driver";
 export { AssetProcessor } from "./services/asset-processor";
 export { AssetResolver } from "./services/asset-resolver";
 export { Assets } from "./services/assets";

package/rest-controllers/assets.controller.d.ts

@@ -6,6 +6,7 @@ import { IAsset } from "../common-types";
 import { Assets } from "../services/assets";
 import { AssetResolver } from "../services/asset-resolver";
 import { AssetImageParams } from "../requests/asset-image-params";
+type AssetReqType = 'Image' | 'Asset';
 export declare class AssetsController {
     readonly assets: Assets;
     readonly assetResolver: AssetResolver;
@@ -18,7 +19,9 @@ export declare class AssetsController {
     getImage(id: string, params: AssetImageParams, res: Response): Promise<Readable>;
     getFileByName(name: string, res: Response): Promise<Readable>;
     getImageByName(name: string, params: AssetImageParams, res: Response): Promise<Readable>;
-    protected setAssetHeaders(type: string, asset: IAsset, res: Response): void;
-    protected getAsset(type: string, id: string, lazy: boolean, res: Response): Promise<IAsset>;
-    protected getAssetByName(type: string, filename: string, res: Response): Promise<IAsset>;
+    protected setAssetHeaders(asset: IAsset, res: Response): void;
+    protected getAsset(type: AssetReqType, id: string, lazy: boolean, res: Response): Promise<IAsset>;
+    protected getAssetByName(type: AssetReqType, filename: string, res: Response): Promise<IAsset>;
+    protected resolveFinalAsset(type: AssetReqType, asset: IAsset): Promise<IAsset>;
 }
+export {};

package/services/asset-resolver.d.ts

@@ -1,3 +1,4 @@
+import { ObjectId } from "bson";
 import { IAsset } from "../common-types";
 import { Assets } from "./assets";
 import { LazyAssets } from "./lazy-assets";
@@ -5,5 +6,5 @@ export declare class AssetResolver {
     readonly assets: Assets;
     readonly lazyAssets: LazyAssets;
     constructor(assets: Assets, lazyAssets: LazyAssets);
-    resolve(id: string, lazy?: boolean): Promise<IAsset>;
+    resolve(id: string | ObjectId, lazy?: boolean): Promise<IAsset>;
 }

package/services/assets.d.ts

@@ -1,22 +1,23 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Readable } from "stream";
-import { Collection, GridFSBucket } from "mongodb";
+import { ObjectId } from "bson";
+import { Collection } from "mongodb";
 import { FilterQuery } from "mongoose";
-import { IAsset, IAssetMeta, IFileType } from "../common-types";
+import { IAsset, IAssetDriver, IAssetMeta, IFileType } from "../common-types";
 import { MongoConnector } from "./mongo-connector";
 import { AssetProcessor } from "./asset-processor";
 export declare class Assets {
     readonly connector: MongoConnector;
     readonly assetProcessor: AssetProcessor;
-    readonly bucket: GridFSBucket;
+    readonly driver: IAssetDriver;
     readonly collection: Collection<Partial<IAsset>>;
-    constructor(connector: MongoConnector, assetProcessor: AssetProcessor);
+    constructor(connector: MongoConnector, assetProcessor: AssetProcessor, driver: IAssetDriver);
     write(stream: Readable, contentType?: string, metadata?: IAssetMeta): Promise<IAsset>;
     writeBuffer(buffer: Buffer, metadata?: IAssetMeta, contentType?: string): Promise<IAsset>;
     writeUrl(url: string, metadata?: IAssetMeta): Promise<IAsset>;
     download(url: string, contentType?: string): Promise<IAsset>;
-    read(id: string): Promise<IAsset>;
+    read(id: string | ObjectId): Promise<IAsset>;
     find(where: FilterQuery<IAsset>): Promise<IAsset>;
     findMany(where: FilterQuery<IAsset>): Promise<ReadonlyArray<IAsset>>;
     deleteMany(where: FilterQuery<IAsset>): Promise<ReadonlyArray<string>>;

package/services/drivers/asset-grid.driver.d.ts

@@ -0,0 +1,11 @@
+import { GridFSBucket, ObjectId } from 'mongodb';
+import { IAssetDriver, IAssetUploadOpts } from '../../common-types';
+import { MongoConnector } from "../mongo-connector";
+export declare class AssetGridDriver implements IAssetDriver {
+    readonly metaCollection: string;
+    protected bucket: GridFSBucket;
+    constructor(connector: MongoConnector);
+    openUploadStream(filename: string, opts?: IAssetUploadOpts): import("mongodb").GridFSBucketWriteStream;
+    openDownloadStream(id: ObjectId): import("mongodb").GridFSBucketReadStream;
+    delete(id: ObjectId): Promise<void>;
+}

package/services/drivers/asset-local.driver.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import type { ObjectId } from 'mongodb';
+import { IAssetDriver, IAssetUploadOpts, IAssetUploadStream } from '../../common-types';
+export declare class AssetLocalDriver implements IAssetDriver {
+    protected dir: string;
+    readonly metaCollection: string;
+    constructor(dir: string);
+    openUploadStream(filename: string, opts?: IAssetUploadOpts): IAssetUploadStream;
+    openDownloadStream(id: ObjectId): import("fs").ReadStream;
+    delete(id: ObjectId): Promise<void>;
+}

package/services/entities/asset.d.ts

@@ -1,17 +1,17 @@
 /// <reference types="node" />
 /// <reference types="node" />
 import { Readable } from "stream";
-import { Collection, GridFSBucket } from "mongodb";
+import { Collection } from "mongodb";
 import { ObjectId } from "bson";
-import { IAsset, IAssetImageParams, IAssetMeta } from "../../common-types";
+import { IAsset, IAssetDriver, IAssetImageParams, IAssetMeta } from "../../common-types";
 import { BaseEntity } from "./base-entity";
 export declare class Asset extends BaseEntity<IAsset> implements IAsset {
-    protected bucket: GridFSBucket;
+    protected driver: IAssetDriver;
     get filename(): string;
     get contentType(): string;
     get metadata(): IAssetMeta;
     get stream(): Readable;
-    constructor(id: ObjectId, data: Partial<IAsset>, collection: Collection, bucket: GridFSBucket);
+    constructor(id: ObjectId, data: Partial<IAsset>, collection: Collection, driver: IAssetDriver);
     unlink(): Promise<string>;
     setMeta(metadata: Partial<IAssetMeta>): Promise<any>;
     getBuffer(): Promise<Buffer>;

package/services/entities/base-entity.d.ts

@@ -1,12 +1,12 @@
 import { Collection } from "mongodb";
 import { ObjectId } from "bson";
 export declare class BaseEntity<T> {
-    readonly mId: ObjectId;
+    readonly oid: ObjectId;
     protected data: Partial<T>;
     protected collection: Collection<any>;
     get id(): string;
     protected deleted: boolean;
-    constructor(mId: ObjectId, data: Partial<T>, collection: Collection<any>);
+    constructor(oid: ObjectId, data: Partial<T>, collection: Collection<any>);
     save(): Promise<any>;
     load(): Promise<this>;
     toJSON(): any;

package/services/lazy-assets.d.ts

@@ -1,3 +1,4 @@
+import { ObjectId } from "bson";
 import { Collection } from "mongodb";
 import { FilterQuery } from "mongoose";
 import { IJob, ILazyAsset, JobParams, Type } from "../common-types";
@@ -15,7 +16,7 @@ export declare class LazyAssets {
     protected collection: Collection<Partial<ILazyAsset>>;
     constructor(connector: MongoConnector, assets: Assets, progresses: Progresses, logger: Logger, jobMan: JobManager);
     create(jobType: Type<IJob>, jobParamsObj?: JobParams, jobQue?: string): Promise<ILazyAsset>;
-    read(id: string): Promise<ILazyAsset>;
+    read(id: string | ObjectId): Promise<ILazyAsset>;
     find(where: FilterQuery<ILazyAsset>): Promise<ILazyAsset>;
     unlink(id: string): Promise<any>;
 }

package/services/mongo-connector.d.ts

@@ -1,14 +1,12 @@
-import { Db, GridFSBucket } from "mongodb";
+import { Db } from "mongodb";
 import mongoose from "mongoose";
 import { Configuration } from "./configuration";
 export declare class MongoConnector {
     readonly configuration: Configuration;
     get connection(): mongoose.Connection;
     get database(): Db;
-    get bucket(): GridFSBucket;
     protected conn: mongoose.Connection;
     protected db: Db;
-    protected fsBucket: GridFSBucket;
     constructor(configuration: Configuration);
     connect(): Promise<Db>;
 }