@quatrain/core 1.0.0-beta12 → 1.0.0-beta14

package/lib/Core.d.ts

@@ -9,6 +9,7 @@ export interface AuthAdapter extends AbstractAuthAdapter {
 }
 export declare class Core {
     static defaultBackend: string;
+    static defaultStorage: string;
     static userClass: typeof User;
     static classRegistry: {
         [key: string]: any;
@@ -17,6 +18,7 @@ export declare class Core {
     static auth: AuthAdapter | AbstractAuthAdapter;
     static timestamp: () => string;
     protected static _backends: BackendRegistry<any>;
+    protected static _storages: BackendRegistry<any>;
     static definition(key: string): {
         manifest: {
             type: StringConstructor;
@@ -25,6 +27,8 @@ export declare class Core {
     };
     static addBackend(backend: AbstractAdapter, alias: string, setDefault?: boolean): void;
     static getBackend<T extends AbstractAdapter>(alias?: string): T;
+    static addStorage(backend: AbstractAdapter, alias: string, setDefault?: boolean): void;
+    static getStorage<T extends AbstractAdapter>(alias?: string): T;
     static addClass(name: string, obj: any): void;
     static getClass(name: string): any;
     /**

package/lib/Core.js

@@ -26,6 +26,20 @@ class Core {
             throw new Error(`Unknown backend alias: '${alias}'`);
         }
     }
+    static addStorage(backend, alias, setDefault = false) {
+        Core._storages[alias] = backend;
+        if (setDefault) {
+            Core.defaultStorage = alias;
+        }
+    }
+    static getStorage(alias = this.defaultStorage) {
+        if (this._storages[alias]) {
+            return this._storages[alias];
+        }
+        else {
+            throw new Error(`Unknown storage alias: '${alias}'`);
+        }
+    }
     static addClass(name, obj) {
         Core.classRegistry[name] = obj;
     }
@@ -52,9 +66,11 @@ class Core {
 }
 exports.Core = Core;
 Core.defaultBackend = '@default';
+Core.defaultStorage = '@default';
 Core.userClass = User_1.User;
 Core.classRegistry = {};
 Core.logger = console;
 // How timestamp are formatted
 Core.timestamp = () => new Date().toISOString();
 Core._backends = {};
+Core._storages = {};

package/lib/components/ObjectUri.d.ts

@@ -22,10 +22,26 @@ export declare class ObjectUri {
     set class(objClass: any);
     get class(): any;
     get backend(): string;
+    /**
+     * Returns the full path of the resource
+     * including optional parents' path
+     * @returns string
+     */
     get path(): string;
+    /**
+     * Returns the own path of the resource
+     * without the optional parents' paths
+     * @returns string
+     */
+    get ownPath(): string;
     get parent(): ObjectUri | undefined;
     set label(label: string | undefined);
     get label(): string | undefined;
+    /**
+     * Return the full path litteral
+     * including the backend alias
+     * @returns string
+     */
     get literal(): string;
     set path(path: string);
     get uid(): string | undefined;

package/lib/components/ObjectUri.js

@@ -72,7 +72,22 @@ class ObjectUri {
     get backend() {
         return this._backend;
     }
+    /**
+     * Returns the full path of the resource
+     * including optional parents' path
+     * @returns string
+     */
     get path() {
+        return this._parent
+            ? `${this._parent.path}${ObjectUri.DEFAULT}${this._path}`
+            : this._path;
+    }
+    /**
+     * Returns the own path of the resource
+     * without the optional parents' paths
+     * @returns string
+     */
+    get ownPath() {
         return this._path;
     }
     get parent() {
@@ -84,6 +99,11 @@ class ObjectUri {
     get label() {
         return this._label;
     }
+    /**
+     * Return the full path litteral
+     * including the backend alias
+     * @returns string
+     */
     get literal() {
         return this._str.includes(':')
             ? this._str

package/lib/index.d.ts

@@ -30,5 +30,12 @@ import { AuthAction, AuthParameters, AuthParametersKeys } from './Auth';
 import { AuthInterface, AbstractAuthAdapter, AuthenticationError } from './authentication';
 import { AbstractAdapter, MockAdapter, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit } from './backends';
 import { BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError } from './common/ResourcesErrors';
+import { AbstractStorageAdapter } from './storages/AbstractStorageAdapter';
+import { FileType } from './storages/types/FileType';
+import { BlobType } from './storages/types/BlobType';
+import { BlobMediaType } from './storages/types/BlobMediaType';
+import { StorageAdapterInterface } from './storages/StorageAdapterInterface';
+import { FileResponseLink } from './storages/types/FileResponseLink';
+import { FileResponseUrl } from './storages/types/FileResponseUrl';
 import { AbstractCloudWrapper } from './wrappers/cloud/AbstractCloudWrapper';
-export { statuses, utils, Core, Property, BaseProperty, BasePropertyType, BooleanProperty, BooleanPropertyType, DateTimeProperty, DateTimePropertyType, EnumProperty, EnumPropertyType, HashProperty, HashPropertyType, ObjectProperty, ObjectPropertyType, StringProperty, StringPropertyType, AbstractAdapter, RepositoryClass, MockAdapter, ObjectUri, DataObjectClass, DataObject, AbstractObject, BaseObject, BaseObjectCore, BaseObjectProperties, AuthAction, AuthParameters, AuthParametersKeys, AuthInterface, AbstractAuthAdapter, AuthenticationError, BackendParameters, BackendParametersKeys, BackendRecordType, BackendAction, BaseRepository, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit, Middleware, InjectMetaMiddleware, InjectKeywordsMiddleware, User, UserType, Proxy, UserRepository, Entity, EntityType, EntityRepository, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError, AbstractCloudWrapper, };
+export { statuses, utils, Core, Property, BaseProperty, BasePropertyType, BooleanProperty, BooleanPropertyType, DateTimeProperty, DateTimePropertyType, EnumProperty, EnumPropertyType, HashProperty, HashPropertyType, ObjectProperty, ObjectPropertyType, StringProperty, StringPropertyType, AbstractAdapter, RepositoryClass, MockAdapter, ObjectUri, DataObjectClass, DataObject, AbstractObject, BaseObject, BaseObjectCore, BaseObjectProperties, AuthAction, AuthParameters, AuthParametersKeys, AuthInterface, AbstractAuthAdapter, AuthenticationError, BackendParameters, BackendParametersKeys, BackendRecordType, BackendAction, BaseRepository, BackendError, Query, QueryMetaType, QueryResultType, Filter, Filters, Limits, Sorting, SortAndLimit, Middleware, InjectMetaMiddleware, InjectKeywordsMiddleware, User, UserType, Proxy, UserRepository, Entity, EntityType, EntityRepository, BadRequestError, UnauthorizedError, ForbiddenError, NotFoundError, GoneError, FileType, BlobType, BlobMediaType, StorageAdapterInterface, AbstractStorageAdapter, FileResponseLink, FileResponseUrl, AbstractCloudWrapper, };

package/lib/index.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AbstractCloudWrapper = exports.GoneError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.EntityRepository = exports.Entity = exports.UserRepository = exports.User = exports.InjectKeywordsMiddleware = exports.InjectMetaMiddleware = exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseRepository = exports.BackendAction = exports.AuthenticationError = exports.AbstractAuthAdapter = exports.AuthAction = exports.BaseObjectProperties = exports.BaseObjectCore = exports.AbstractObject = exports.DataObject = exports.ObjectUri = exports.MockAdapter = exports.AbstractAdapter = exports.StringProperty = exports.ObjectProperty = exports.HashProperty = exports.EnumProperty = exports.DateTimeProperty = exports.BooleanProperty = exports.BaseProperty = exports.Property = exports.Core = exports.utils = exports.statuses = void 0;
+exports.AbstractCloudWrapper = exports.AbstractStorageAdapter = exports.GoneError = exports.NotFoundError = exports.ForbiddenError = exports.UnauthorizedError = exports.BadRequestError = exports.EntityRepository = exports.Entity = exports.UserRepository = exports.User = exports.InjectKeywordsMiddleware = exports.InjectMetaMiddleware = exports.SortAndLimit = exports.Sorting = exports.Limits = exports.Filters = exports.Filter = exports.Query = exports.BackendError = exports.BaseRepository = exports.BackendAction = exports.AuthenticationError = exports.AbstractAuthAdapter = exports.AuthAction = exports.BaseObjectProperties = exports.BaseObjectCore = exports.AbstractObject = exports.DataObject = exports.ObjectUri = exports.MockAdapter = exports.AbstractAdapter = exports.StringProperty = exports.ObjectProperty = exports.HashProperty = exports.EnumProperty = exports.DateTimeProperty = exports.BooleanProperty = exports.BaseProperty = exports.Property = exports.Core = exports.utils = exports.statuses = void 0;
 const Core_1 = require("./Core");
 Object.defineProperty(exports, "Core", { enumerable: true, get: function () { return Core_1.Core; } });
 const statuses = __importStar(require("./common/statuses"));
@@ -96,5 +96,7 @@ Object.defineProperty(exports, "UnauthorizedError", { enumerable: true, get: fun
 Object.defineProperty(exports, "ForbiddenError", { enumerable: true, get: function () { return ResourcesErrors_1.ForbiddenError; } });
 Object.defineProperty(exports, "NotFoundError", { enumerable: true, get: function () { return ResourcesErrors_1.NotFoundError; } });
 Object.defineProperty(exports, "GoneError", { enumerable: true, get: function () { return ResourcesErrors_1.GoneError; } });
+const AbstractStorageAdapter_1 = require("./storages/AbstractStorageAdapter");
+Object.defineProperty(exports, "AbstractStorageAdapter", { enumerable: true, get: function () { return AbstractStorageAdapter_1.AbstractStorageAdapter; } });
 const AbstractCloudWrapper_1 = require("./wrappers/cloud/AbstractCloudWrapper");
 Object.defineProperty(exports, "AbstractCloudWrapper", { enumerable: true, get: function () { return AbstractCloudWrapper_1.AbstractCloudWrapper; } });

package/lib/storages/AbstractStorageAdapter.d.ts

@@ -0,0 +1,16 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { FileType } from './types/FileType';
+import { StorageAdapterInterface } from './StorageAdapterInterface';
+export declare abstract class AbstractStorageAdapter implements StorageAdapterInterface {
+    abstract create(file: FileType, stream: Readable): Promise<FileType>;
+    abstract download(file: FileType, path: string): Promise<string>;
+    abstract getUrl(file: FileType, expiresIn?: number, action?: string, extra?: any): Promise<any>;
+    abstract delete(file: FileType): Promise<Boolean>;
+    abstract stream(file: FileType, res: any): Promise<any>;
+    abstract getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>;
+    abstract getReadable(file: FileType): Promise<Readable>;
+    abstract generateThumbnail(file: FileType, sizes: number[]): Promise<any>;
+    abstract generateImageThumbnail(file: FileType, sizes: number[]): Promise<any>;
+    abstract generateVideoThumbnail(file: FileType, sizes: number[]): Promise<any>;
+}

package/lib/storages/AbstractStorageAdapter.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractStorageAdapter = void 0;
+//import { APIResponseLink, ResponsePublicUrl } from './types'
+class AbstractStorageAdapter {
+}
+exports.AbstractStorageAdapter = AbstractStorageAdapter;

package/lib/storages/StorageAdapterInterface.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="node" />
+import { Readable } from "stream";
+import { FileType } from "./types/FileType";
+/**
+ * These are the public functions that any storage interface must expose
+ */
+export interface StorageAdapterInterface {
+    create(file: FileType, stream: Readable): Promise<FileType>;
+    delete(file: FileType): Promise<Boolean>;
+    stream(file: FileType, res: any): Promise<any>;
+    download(file: FileType, path: string): Promise<string>;
+    getUrl(file: FileType, expiresIn?: number, action?: string, extra?: any): Promise<any>;
+    getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>;
+    getReadable(filePath: FileType): Promise<Readable>;
+    generateThumbnail(file: FileType, sizes: number[]): Promise<any>;
+    generateImageThumbnail(file: FileType, sizes: number[]): Promise<any>;
+    generateVideoThumbnail(file: FileType, sizes: number[]): Promise<any>;
+}

package/lib/storages/index.d.ts

@@ -0,0 +1,8 @@
+import { FileType } from './types/FileType';
+import { BlobType } from './types/BlobType';
+import { BlobMediaType } from './types/BlobMediaType';
+import { FileResponseLink } from './types/FileResponseLink';
+import { FileResponseUrl } from './types/FileResponseUrl';
+import { StorageAdapterInterface } from './StorageAdapterInterface';
+import { AbstractStorageAdapter } from './AbstractStorageAdapter';
+export { FileType, BlobType, BlobMediaType, FileResponseLink, FileResponseUrl, StorageAdapterInterface, AbstractStorageAdapter, };

package/lib/storages/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractStorageAdapter = void 0;
+const AbstractStorageAdapter_1 = require("./AbstractStorageAdapter");
+Object.defineProperty(exports, "AbstractStorageAdapter", { enumerable: true, get: function () { return AbstractStorageAdapter_1.AbstractStorageAdapter; } });

package/lib/storages/types/BlobMediaType.d.ts

@@ -0,0 +1,8 @@
+import { BlobType } from "./BlobType";
+export interface BlobMediaType extends BlobType {
+    width?: number;
+    height?: number;
+    bitrate?: number;
+    thumb128?: string;
+    thumb256?: string;
+}

package/lib/storages/types/BlobMediaType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/storages/types/BlobType.d.ts

@@ -0,0 +1,6 @@
+import { FileType } from './FileType';
+export interface BlobType extends FileType {
+    size: number;
+    contentType: string;
+    isTempFile?: boolean;
+}

package/lib/storages/types/BlobType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/storages/types/FileResponseLink.d.ts

@@ -0,0 +1,7 @@
+export type FileResponseLink = {
+    href: string;
+    type: 'PUT' | 'POST' | 'GET';
+    accept: string;
+    size?: number;
+    expiresIn?: number;
+};

package/lib/storages/types/FileResponseLink.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/storages/types/FileResponseUrl.d.ts

@@ -0,0 +1,4 @@
+export type FileResponseUrl = {
+    url: string;
+    expiresIn: number;
+};

package/lib/storages/types/FileResponseUrl.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/storages/types/FileType.d.ts

@@ -0,0 +1,15 @@
+export interface FileType {
+    bucket: string;
+    ref: string;
+    label?: string;
+    contentType?: string;
+    size?: number;
+    framerate?: number;
+    duration?: number;
+    bitrate?: number;
+    width?: number;
+    height?: number;
+    thumb128?: string;
+    thumb256?: string;
+    [x: string]: any;
+}

package/lib/storages/types/FileType.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/storages/types.d.ts

@@ -0,0 +1,5 @@
+export type APIMoveFile = {
+    cloud: string;
+    ref: string;
+    bucket: string;
+};

package/lib/storages/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
    "name": "@quatrain/core",
-   "version": "1.0.0-beta12",
+   "version": "1.0.0-beta14",
    "description": "Core objects for business apps",
    "main": "lib/index.js",
    "types": "lib/index.d.ts",

package/lib/authentication/middlewares/Middleware.d.ts

@@ -1,5 +0,0 @@
-import { AuthAction } from '../../Auth';
-import { User } from '../../components/User';
-export default interface Middleware {
-    execute: (user: User, action: AuthAction) => void;
-}