@abyss-project/storage 1.0.0

package/dist/types/interface/index.d.ts

@@ -0,0 +1,9 @@
+export * from './models/application.model';
+export * from './models/application-webhook.model';
+export * from './models/application-webhook-history.model';
+export * from './models/application-file.model';
+export * from './models/pre-sign-url.model';
+export * from './models/application-file-thumbnail.model';
+export * from './models/stream-media.model';
+export * from './api';
+export * from './dto';

package/dist/types/interface/index.js

@@ -0,0 +1,25 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./models/application.model"), exports);
+__exportStar(require("./models/application-webhook.model"), exports);
+__exportStar(require("./models/application-webhook-history.model"), exports);
+__exportStar(require("./models/application-file.model"), exports);
+__exportStar(require("./models/pre-sign-url.model"), exports);
+__exportStar(require("./models/application-file-thumbnail.model"), exports);
+__exportStar(require("./models/stream-media.model"), exports);
+__exportStar(require("./api"), exports);
+__exportStar(require("./dto"), exports);

package/dist/types/interface/models/application-file-thumbnail.model.d.ts

@@ -0,0 +1,15 @@
+import { IApplicationFile } from './application-file.model';
+export interface IApplicationFileThumbnail {
+    id?: string;
+    name: string;
+    sizeOctet: number;
+    publicAccessId: string;
+    customPublicAccessId: string | null;
+    resolutionX: number;
+    resolutionY: number;
+    mimeType: string;
+    applicationFileId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    applicationFile?: IApplicationFile;
+}

package/dist/types/interface/models/application-file-thumbnail.model.js

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

package/dist/types/interface/models/application-file.model.d.ts

@@ -0,0 +1,28 @@
+import { IApplicationFileThumbnail } from './application-file-thumbnail.model';
+import { Algorithm, ChecksumAlgorithm } from '../../enum';
+import { IApplication } from './application.model';
+import { ApplicationFileMetadata } from '../dto';
+import * as mindee from 'mindee';
+export interface IApplicationFile {
+    id?: string;
+    name: string;
+    publicAccessId: string | null;
+    customPublicAccessId: string | null;
+    publicAccessPassword: string | null;
+    sizeOctet: number;
+    algorithm: Algorithm | null;
+    checksum: string;
+    checksumAlgorithm: ChecksumAlgorithm;
+    mimeType: string | null;
+    metadata: ApplicationFileMetadata | null;
+    ocrMetadata: {
+        receipt?: mindee.PredictResponse<mindee.product.ReceiptV5> | null;
+    } | null;
+    tag: string[];
+    bucket: string | null;
+    applicationId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    application?: IApplication;
+    applicationFileThumbnail?: IApplicationFileThumbnail[];
+}

package/dist/types/interface/models/application-file.model.js

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

package/dist/types/interface/models/application-webhook-history.model.d.ts

@@ -0,0 +1,16 @@
+import { WebhookType } from '../../enum';
+import { IApplicationWebhook } from './application-webhook.model';
+export interface IApplicationWebhookHistory {
+    id?: string;
+    applicationWebhookId: string;
+    body: Record<string, unknown>;
+    response: string | null;
+    responseCode: number | null;
+    webhookId: string;
+    groupId: string;
+    type: WebhookType;
+    sendAt: Date;
+    updatedAt?: Date;
+    createdAt?: Date;
+    applicationWebhook?: IApplicationWebhook;
+}

package/dist/types/interface/models/application-webhook-history.model.js

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

package/dist/types/interface/models/application-webhook.model.d.ts

@@ -0,0 +1,17 @@
+import { WebhookType } from '../../enum';
+import { IApplicationWebhookHistory } from './application-webhook-history.model';
+import { IApplication } from './application.model';
+export interface IApplicationWebhook {
+    id?: string;
+    webhookSecret: string;
+    webhookUrl: string;
+    isEnabled: boolean;
+    name: string;
+    description: string;
+    scopes: WebhookType[];
+    applicationId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    application?: IApplication;
+    applicationWebhookHistory?: IApplicationWebhookHistory[];
+}

package/dist/types/interface/models/application-webhook.model.js

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

package/dist/types/interface/models/application.model.d.ts

@@ -0,0 +1,12 @@
+import { IPreSignUrl } from './pre-sign-url.model';
+import { IApplicationFile } from './application-file.model';
+import { IApplicationWebhook } from './application-webhook.model';
+export interface IApplication {
+    id?: string;
+    projectId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    applicationWebhook?: IApplicationWebhook[];
+    applicationFile?: IApplicationFile[];
+    preSignUrl?: IPreSignUrl[];
+}

package/dist/types/interface/models/application.model.js

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

package/dist/types/interface/models/log-console.model.d.ts

@@ -0,0 +1,17 @@
+import { LogType } from '../..';
+import { ILogEndpoint } from './log-endpoint.model';
+import { LogLevel } from 'abyss_core';
+export interface ILogConsole {
+    id?: string;
+    processId: number;
+    context: string | null;
+    requestId: string | null;
+    level: LogLevel;
+    message: string;
+    stack: string | null;
+    type: LogType;
+    dateValue: Date;
+    updatedAt?: Date;
+    createdAt?: Date;
+    logEndpoint?: ILogEndpoint;
+}

package/dist/types/interface/models/log-console.model.js

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

package/dist/types/interface/models/log-endpoint.model.d.ts

@@ -0,0 +1,22 @@
+import { ILogConsole } from '..';
+import { APIMethod } from 'abyss_core';
+export interface ILogEndpoint {
+    id?: string;
+    requestId: string;
+    processId: number;
+    controller: string | null;
+    endpoint: string;
+    requestParams: Record<string, unknown>;
+    requestQuery: Record<string, unknown>;
+    requestBody: Record<string, unknown>;
+    responseBody: Record<string, unknown>;
+    httpResultCode: number;
+    ips: string[];
+    durationInMs: number;
+    method: APIMethod;
+    dateValue: Date;
+    logConsoleId?: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    logConsole?: ILogConsole;
+}

package/dist/types/interface/models/log-endpoint.model.js

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

package/dist/types/interface/models/picture-collection.model.d.ts

@@ -0,0 +1,17 @@
+import { PictureCollectionSource, PictureCollectionType } from '../../enum';
+import { IApplicationFile } from './application-file.model';
+export interface IPictureCollection {
+    id?: string;
+    name: string;
+    externalId: string;
+    type: PictureCollectionType;
+    source: PictureCollectionSource;
+    isIAGenerated: boolean;
+    isFreemium: boolean;
+    slug: string | null;
+    keywords: string[];
+    applicationFileId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    applicationFile?: IApplicationFile;
+}

package/dist/types/interface/models/picture-collection.model.js

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

package/dist/types/interface/models/pre-sign-url.model.d.ts

@@ -0,0 +1,11 @@
+import { IApplication } from './application.model';
+export interface IPreSignUrl {
+    id?: string;
+    token: string;
+    applicationId: string;
+    generatedAt: Date;
+    usedAt: Date | null;
+    updatedAt?: Date;
+    createdAt?: Date;
+    application?: IApplication;
+}

package/dist/types/interface/models/pre-sign-url.model.js

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

package/dist/types/interface/models/stream-media.model.d.ts

@@ -0,0 +1,9 @@
+import { StreamMediaType } from '../../enum';
+export interface IStreamMedia {
+    id?: string;
+    name: string;
+    type: StreamMediaType;
+    isTranscoded: boolean;
+    updatedAt?: Date;
+    createdAt?: Date;
+}

package/dist/types/interface/models/stream-media.model.js

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

package/dist/types/interface/models/user-application-file-thumbnail.model.d.ts

@@ -0,0 +1,14 @@
+import { IUserApplicationFile } from './user-application-file.model';
+export interface IUserApplicationFileThumbnail {
+    id?: string;
+    name: string;
+    sizeOctet: number;
+    publicAccessId: string;
+    resolutionX: number;
+    resolutionY: number;
+    mimeType: string;
+    userApplicationFileId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    userApplicationFile?: IUserApplicationFile;
+}

package/dist/types/interface/models/user-application-file-thumbnail.model.js

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

package/dist/types/interface/models/user-application-file.model.d.ts

@@ -0,0 +1,20 @@
+import { IUserApplicationFileThumbnail } from './user-application-file-thumbnail.model';
+import { Algorithm } from 'abyss_crypt_core';
+import { ChecksumAlgorithm } from '../../enum';
+import { IUserApplication } from './user-application.model';
+export interface IUserApplicationFile {
+    id?: string;
+    name: string;
+    publicAccessId: string | null;
+    publicAccessPassword: string | null;
+    sizeOctet: number;
+    algorithm: Algorithm | null;
+    checksum: string;
+    checksumAlgorithm: ChecksumAlgorithm;
+    mimeType: string | null;
+    userApplicationId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    userApplication?: IUserApplication;
+    userApplicationFileThumbnail?: IUserApplicationFileThumbnail[];
+}

package/dist/types/interface/models/user-application-file.model.js

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

package/dist/types/interface/models/user-application-webhook-history.model.d.ts

@@ -0,0 +1,16 @@
+import { WebhookType } from '../../enum';
+import { IUserApplicationWebhook } from './user-application-webhook.model';
+export interface IUserApplicationWebhookHistory {
+    id?: string;
+    userApplicationWebhookId: string;
+    body: Record<string, unknown>;
+    response: string | null;
+    responseCode: number | null;
+    webhookId: string;
+    groupId: string;
+    type: WebhookType;
+    sendAt: Date;
+    updatedAt?: Date;
+    createdAt?: Date;
+    userApplicationWebhook?: IUserApplicationWebhook;
+}

package/dist/types/interface/models/user-application-webhook-history.model.js

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

package/dist/types/interface/models/user-application-webhook.model.d.ts

@@ -0,0 +1,17 @@
+import { WebhookType } from '../../enum';
+import { IUserApplicationWebhookHistory } from './user-application-webhook-history.model';
+import { IUserApplication } from './user-application.model';
+export interface IUserApplicationWebhook {
+    id?: string;
+    webhookSecret: string;
+    webhookUrl: string;
+    isEnabled: boolean;
+    name: string;
+    description: string;
+    scopes: WebhookType[];
+    userApplicationId: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    userApplication?: IUserApplication;
+    userApplicationWebhookHistory?: IUserApplicationWebhookHistory[];
+}

package/dist/types/interface/models/user-application-webhook.model.js

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

package/dist/types/interface/models/user-application.model.d.ts

@@ -0,0 +1,15 @@
+import { IPreSignUrl } from './pre-sign-url.model';
+import { IUserApplicationFile } from './user-application-file.model';
+import { IUserApplicationWebhook } from './user-application-webhook.model';
+import { IUser } from './user.model';
+export interface IUserApplication {
+    id?: string;
+    userId: string;
+    apiKey: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+    user?: IUser;
+    userApplicationWebhook?: IUserApplicationWebhook[];
+    userApplicationFile?: IUserApplicationFile[];
+    preSignUrl?: IPreSignUrl[];
+}

package/dist/types/interface/models/user-application.model.js

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

package/dist/types/interface/models/user.model.d.ts

@@ -0,0 +1,8 @@
+export interface IUser {
+    id?: string;
+    isAdmin: boolean;
+    alias: string;
+    apiKey: string;
+    updatedAt?: Date;
+    createdAt?: Date;
+}

package/dist/types/interface/models/user.model.js

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

package/dist/types/models/index.d.ts

@@ -0,0 +1 @@
+export * from './transfer.model';

package/dist/types/models/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./transfer.model"), exports);

package/dist/types/models/transfer.model.d.ts

@@ -0,0 +1,36 @@
+import { CancelTokenSource } from 'axios';
+import dayjs from 'dayjs';
+export declare enum TransferType {
+    UPLOAD = "UPLOAD",
+    DOWNLOAD = "DOWNLOAD"
+}
+export declare enum TransferState {
+    STARTING = "STARTING",
+    PROCESSING = "PROCESSING",
+    CANCELED = "CANCELED",
+    COMPLETED = "COMPLETED"
+}
+export declare class Transfer {
+    id: string;
+    name: string;
+    type: TransferType;
+    cancelTokenSource: CancelTokenSource;
+    size: number;
+    sizeProcessed: number;
+    progress: number;
+    startedAt: dayjs.Dayjs;
+    endedAt?: dayjs.Dayjs;
+    state: TransferState;
+    action: () => void;
+    progressEventStack: ProgressEvent[];
+    speedStack: number[];
+    constructor(data: {
+        name: string;
+        type: TransferType;
+        cancelTokenSource?: CancelTokenSource;
+    });
+    onProgress(event: ProgressEvent): void;
+    cancel(): void;
+    completeEmptyDownload(): void;
+    setAction(action: () => void): void;
+}

package/dist/types/models/transfer.model.js

@@ -0,0 +1,73 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Transfer = exports.TransferState = exports.TransferType = void 0;
+const axios_1 = __importDefault(require("axios"));
+const dayjs_1 = __importDefault(require("dayjs"));
+const uuid_1 = require("uuid");
+var TransferType;
+(function (TransferType) {
+    TransferType["UPLOAD"] = "UPLOAD";
+    TransferType["DOWNLOAD"] = "DOWNLOAD";
+})(TransferType = exports.TransferType || (exports.TransferType = {}));
+var TransferState;
+(function (TransferState) {
+    TransferState["STARTING"] = "STARTING";
+    TransferState["PROCESSING"] = "PROCESSING";
+    TransferState["CANCELED"] = "CANCELED";
+    TransferState["COMPLETED"] = "COMPLETED";
+})(TransferState = exports.TransferState || (exports.TransferState = {}));
+class Transfer {
+    constructor(data) {
+        this.id = (0, uuid_1.v4)();
+        this.name = data.name;
+        this.type = data.type;
+        this.cancelTokenSource = data.cancelTokenSource || axios_1.default.CancelToken.source();
+        this.size = 0;
+        this.sizeProcessed = 0;
+        this.progress = 0;
+        this.startedAt = (0, dayjs_1.default)();
+        this.state = TransferState.STARTING;
+        this.action = () => {
+        };
+        this.progressEventStack = [];
+        this.speedStack = [];
+    }
+    onProgress(event) {
+        var _a;
+        if (this.state === TransferState.STARTING) {
+            this.size = event.total;
+            this.state = TransferState.PROCESSING;
+        }
+        this.sizeProcessed = event.loaded;
+        this.progress = (this.sizeProcessed / this.size) * 100;
+        this.progressEventStack.push(event);
+        const oldEvent = this.progressEventStack
+            .reverse()
+            .find((elem) => event.timeStamp - elem.timeStamp > 1000);
+        this.speedStack.push(event.loaded - ((_a = oldEvent === null || oldEvent === void 0 ? void 0 : oldEvent.loaded) !== null && _a !== void 0 ? _a : 0));
+        if (this.size === this.sizeProcessed) {
+            this.endedAt = (0, dayjs_1.default)();
+            this.state = TransferState.COMPLETED;
+        }
+        this.action();
+    }
+    cancel() {
+        this.cancelTokenSource.cancel();
+        this.state = TransferState.CANCELED;
+        this.endedAt = (0, dayjs_1.default)();
+        this.action();
+    }
+    completeEmptyDownload() {
+        this.state = TransferState.COMPLETED;
+        this.progress = 100;
+        this.endedAt = (0, dayjs_1.default)();
+        this.action();
+    }
+    setAction(action) {
+        this.action = action;
+    }
+}
+exports.Transfer = Transfer;

package/dist/utils/error.utils.d.ts

@@ -0,0 +1,15 @@
+import { Code, ErrorType } from '../types';
+type ErrorParams = {
+    code: Code;
+    type: ErrorType;
+    message?: string;
+};
+export declare class ServiceException extends Error {
+    private readonly code;
+    private readonly type;
+    getCode(): Code;
+    getType(): ErrorType;
+    constructor(params: ErrorParams);
+}
+export declare const handleError: (error: Error | ErrorParams, _params?: ErrorParams) => Error;
+export {};

package/dist/utils/error.utils.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleError = exports.ServiceException = void 0;
+class ServiceException extends Error {
+    getCode() {
+        return this.code;
+    }
+    getType() {
+        return this.type;
+    }
+    constructor(params) {
+        super(params.message);
+        this.code = params.code;
+        this.type = params.type;
+    }
+}
+exports.ServiceException = ServiceException;
+const handleError = (error, _params) => {
+    if (error instanceof Error) {
+        return error;
+    }
+    return new ServiceException(error);
+};
+exports.handleError = handleError;

package/dist/utils/index.d.ts

@@ -0,0 +1 @@
+export * from './error.utils';

package/dist/utils/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./error.utils"), exports);

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@abyss-project/storage",
+  "version": "1.0.0",
+  "description": "Core package to interact with Abyss-Storage",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [],
+  "author": "scylla",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://gitlab.com/abyss-group/abyss-storage/abyss-storage"
+  },
+  "homepage": "https://gitlab.com/abyss-group/abyss-storage/abyss-storage",
+  "dependencies": {
+    "axios": "^1.2.2",
+    "axios-retry": "^3.4.0",
+    "dayjs": "^1.10.7",
+    "form-data": "^4.0.0",
+    "mindee": "^4.14.0",
+    "uuid": "^9.0.0"
+  },
+  "devDependencies": {
+    "@date-io/dayjs": "^2.11.0",
+    "@types/express-serve-static-core": "^4.17.31",
+    "@types/fs-extra": "^9.0.13",
+    "@types/lodash": "^4.14.177",
+    "@types/node": "^17.0.4",
+    "@types/uuid": "^8.3.0",
+    "@typescript-eslint/eslint-plugin": "^4.27.0",
+    "@typescript-eslint/parser": "^4.27.0",
+    "eslint": "^7.28.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-config-standard": "^16.0.3",
+    "eslint-plugin-filenames-simple": "^0.7.0",
+    "eslint-plugin-import": "^2.27.4",
+    "eslint-plugin-node": "^11.1.0",
+    "eslint-plugin-prettier": "^3.4.0",
+    "eslint-plugin-promise": "^5.1.0",
+    "prettier": "2.3.1",
+    "sequelize-cli": "^6.2.0",
+    "typescript": "^4.1.5"
+  },
+  "scripts": {
+    "lint": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --fix",
+    "lint:check": "eslint \"{src,apps,libs,test,core}/**/*.ts\" --max-warnings 0",
+    "tsc": "tsc",
+    "build": "tsc",
+    "prepublish": "tsc"
+  }
+}