@freshpointcz/fresh-core 0.0.11 → 0.0.12

package/dist/index.d.mts

@@ -0,0 +1,431 @@
+import dayjs, { Dayjs } from 'dayjs';
+import { Logger } from 'winston';
+import { BaseEntity, ColumnOptions, Repository, DataSourceOptions } from 'typeorm';
+import { Job } from 'node-schedule';
+import * as eslint from 'eslint';
+import * as typescript_eslint_dist_compatibility_types from 'typescript-eslint/dist/compatibility-types';
+
+/**
+ * Static DateUtils class
+ */
+declare class DateUtils {
+    /** Holidays 2025-2030 as YYYY-MM-DD strings */
+    static HOLIDAYS_STR: readonly string[];
+    /** Holidays 2025-2030 as UTC timestamps */
+    static HOLIDAYS: readonly number[];
+    static fromISOtoSQLtimestamp(ts?: string): string;
+    static toSQLtimestamp(ts: Dayjs): string;
+    static fromSQLtimestamp(mysqlDate: string): Dayjs;
+    static getSqlTimestampFromNowCzech(): string;
+    static fromISO(isoDate: string): Dayjs;
+    static getDate(ts: string): dayjs.Dayjs;
+    static getNow(): Dayjs;
+    static getNowCzech(): Dayjs;
+    static clone(ts: Dayjs): Dayjs;
+    static getLastSunday(weeksOffset?: number): Dayjs;
+    static dayInWeek(ts?: Dayjs): 1 | 2 | 3 | 4 | 5 | 6 | 7;
+    static isWorkdayDay(ts: Dayjs): boolean;
+    static getDiffInMinutesWithNow(inputTime: Dayjs): number;
+    static isInLastDays(numOfDays: number, timestampInput: string | Dayjs): boolean;
+}
+
+type Deferred<T> = {
+    promise: Promise<T>;
+    resolve: (value: T) => void;
+    reject: (err: any) => void;
+};
+/**
+ * Deferred promise is like "fake" which is used to manually resolve/reject later on with different promise
+ * With resolve and reject outside for easier change of promise
+ * is used as placeholder untill real promise is assigned
+ */
+declare function createDeferred<T>(): Deferred<T>;
+
+/**
+ * Experimental class to maintain just one promise for some process flow.
+ * Currently is in singleton design, so can be used only in one proces. (currently: all-product-availability-per-day)
+ */
+declare class SinglePromiseWaiter<T = any> {
+    private static _instance;
+    static getInstance<T = any>(): SinglePromiseWaiter<any>;
+    private _promise;
+    get promise(): Promise<T> | null;
+    set promise(promise: Promise<T> | null);
+    get hasPromise(): boolean;
+}
+
+declare const logger: Logger;
+
+declare function isValidCron(expr: string): boolean;
+
+declare abstract class Singleton {
+    private static instances;
+    constructor();
+    protected abstract onInit(): void;
+}
+
+type Status = "ok" | "error" | "not-authorized" | "not-authenticated" | "internal-server-error" | "validation-error";
+
+declare class StatusDto {
+    /**
+     * Call result status
+     */
+    status: Status;
+    /**
+     * UTC Timestamp
+     * @example "2021-12-01T13:23:39.305Z"
+     */
+    timestamp: string;
+    /**
+     * Details (optional)
+     */
+    details?: string;
+    constructor(status: Status, details?: string, timestamp?: string);
+}
+
+declare const AMOUNT_UNIT: {
+    readonly 1: {
+        readonly symbol: "g";
+        readonly translations: {
+            readonly en: "gram";
+            readonly cs: "gram";
+        };
+    };
+    readonly 2: {
+        readonly symbol: "kg";
+        readonly translations: {
+            readonly en: "kilogram";
+            readonly cs: "kilogram";
+        };
+    };
+    readonly 3: {
+        readonly symbol: "ml";
+        readonly translations: {
+            readonly en: "milliliter";
+            readonly cs: "mililitr";
+        };
+    };
+    readonly 4: {
+        readonly symbol: "l";
+        readonly translations: {
+            readonly en: "liter";
+            readonly cs: "litr";
+        };
+    };
+};
+
+/**
+ * Default Entity with needed columns for every basic entity `id`, `uuid`, `created_at`, `updated_at` and `deleted_at`;
+ */
+declare abstract class FreshEntity extends BaseEntity {
+    id: number;
+    uuid: string;
+    created_at: Date;
+    updated_at: Date;
+    deleted_at: Date | null;
+    /** After manual construction `id` is irrelevant. Refer to `uuid` only, because that will be inserted into DB */
+    constructor();
+}
+
+/**
+ * Abstract class for hypertable entity
+ * @description
+ * @property `timestamp` is PrimaryKey of type 'timestamptz'
+ * @property `created_at` is timestamp of insert into DB
+ *
+ * @usage add into generated migration these snippets:
+ ** up: await queryRunner.query(`SELECT create_hypertable('my_hyper_table', 'timestamp', if_not_exists => TRUE);`);
+ ** down: await queryRunner.query(`SELECT drop_hypertable('my_hyper_table', if_exists => TRUE);`);
+ */
+declare abstract class FreshHyperEntity extends BaseEntity {
+    timestamp: Date;
+    created_at: Date;
+    /** After manual construction `id` is irrelevant */
+    constructor(timestamp?: Date);
+}
+
+declare enum ActionCommandCode {
+    RESTART_PC = 1,
+    RESTART_APPLICATION = 2,
+    RESTART_ROUTER = 3,
+    RESTART_REMOTE_CONTROL = 4,
+    SYNCHRONIZE = 5,
+    DIAGNOSE_LOCKS = 6,
+    /** download config, save it locally and upload local config, if nothing found on server then just upload */
+    SYNCHRONIZE_CONFIG = 7
+}
+
+declare enum DepotPoolStatus {
+    NEW = 0,
+    PICKED = 1,
+    WRITTEN_OFF = 2,
+    ACTIVE = 3,
+    TERMINATED = 4
+}
+
+declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLY_HINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    MULTI_STATUS = 207,
+    ALREADY_REPORTED = 208,
+    IM_USED = 226,
+    MULTIPLE_CHOICES = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    USE_PROXY = 305,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    IM_A_TEAPOT = 418,
+    MISDIRECTED_REQUEST = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    LOCKED = 423,
+    FAILED_DEPENDENCY = 424,
+    TOO_EARLY = 425,
+    UPGRADE_REQUIRED = 426,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
+    UNAVAILABLE_FOR_LEGAL_REASONS = 451,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505,
+    VARIANT_ALSO_NEGOTIATES = 506,
+    INSUFFICIENT_STORAGE = 507,
+    LOOP_DETECTED = 508,
+    NOT_EXTENDED = 510,
+    NETWORK_AUTHENTICATION_REQUIRED = 511
+}
+
+declare enum LanguageCode {
+    CS = "cs",
+    EN = "en",
+    DE = "de",
+    PL = "pl",
+    SK = "sk"
+}
+
+declare enum PaymentMethod {
+    CODE = 0,
+    CARD = 1,
+    NONE = 2
+}
+
+declare enum TransactionType {
+    WRITEOFF = 0,
+    SALE = 1,
+    LOST = 2,
+    ADD = 3,
+    DELIVERY = 4,
+    DEPOT_WRITEOFF = 5,
+    DEPOT_ADD = 6,
+    RETURN = 7,
+    INVENTORY_SURPLUS = 8,
+    INVENTORY_MISSING = 9
+}
+
+declare abstract class FreshTranslationBase<T extends FreshEntity> extends BaseEntity {
+    id: number;
+    languageCode: LanguageCode;
+    /**
+     * @description relation column to parent Entity
+     * @override with your Entity specific relation using
+     *
+     ** `@ManyToOne(type => YourEntity, { onDelete: "CASCADE" })`
+        `baseEntity: YourEntity;`
+     *
+     * @usage
+     * In parent must be this definition
+     ** `@OneToMany(() => EntityTranslation, (t) => t.baseEntity, {
+            cascade: true,
+        })
+        translations!: EntityTranslation[];`
+        `translations: EntityTranslation[];`
+    */
+    abstract baseEntity: T;
+    constructor();
+}
+
+/**
+ * Extended typeorm `column` decorator for timestamp columns
+ *
+ * @description
+ * Is timestamp column with timezones and as default value passes current timestamp.
+ *
+ * * type: 'timestamptz'
+ * * nullable: false
+ * * default: () => 'CURRENT_TIMESTAMP'
+ */
+declare function TimestampColumn(options?: ColumnOptions): PropertyDecorator;
+
+declare abstract class FreshDao<T extends BaseEntity> {
+    protected abstract repo: Repository<T>;
+}
+
+declare class Category extends FreshEntity {
+}
+
+declare class Device extends FreshEntity {
+}
+
+declare class Manufacturer extends FreshEntity {
+}
+
+declare class Product extends FreshEntity {
+}
+
+declare class Subcategory extends FreshEntity {
+}
+
+type Maybe<T> = T | null;
+
+declare abstract class DataHelper<T> {
+    private _data?;
+    private _dataPromise;
+    protected deviceIds: Promise<number[]>;
+    constructor(startDataRetrieve: boolean | undefined, deviceIds: Promise<number[]>);
+    protected get data(): Maybe<T> | undefined;
+    protected set data(value: Maybe<T>);
+    protected get dataPromise(): Maybe<Promise<Maybe<T>>>;
+    protected set dataPromise(value: Maybe<Promise<Maybe<T>>>);
+    getData(): Promise<Maybe<T>>;
+    abstract startDataRetrieval(): Promise<Maybe<T>>;
+}
+
+declare abstract class FreshJob<T = void> extends Singleton {
+    private _jobName;
+    private _cronExpression;
+    private _job;
+    /**
+     * @param cronExpression must be cron of just numbers ex.: `0 5 * * 4`
+     * By default timezone is added " Europe/Prague"
+     */
+    constructor(jobName: string, cronExpression: string, jobEnabled: boolean);
+    /** Just logging */
+    protected onInit(rescheduled?: boolean): void;
+    get jobName(): string;
+    protected set jobName(value: string);
+    get cronExpression(): string;
+    protected set cronExpression(value: string);
+    protected get job(): Job | null;
+    protected set job(value: Job | null);
+    abstract invoke(): T | Promise<T>;
+}
+
+declare class ApiError extends Error {
+    private _statusCode;
+    get statusCode(): number;
+    private _statusDto;
+    get statusDto(): any;
+    constructor(statusCode: number, status: Status, detail?: string);
+}
+
+declare const FRESH_ESLINT_CONFIG: {
+    files: string[];
+    ignores: string[];
+    languageOptions: {
+        parser: typescript_eslint_dist_compatibility_types.CompatibleParser;
+        ecmaVersion: string;
+        sourceType: string;
+    };
+    plugins: {
+        "@typescript-eslint": typescript_eslint_dist_compatibility_types.CompatiblePlugin;
+        prettier: eslint.ESLint.Plugin;
+    };
+    rules: {
+        "prefer-const": string;
+        yoda: string[];
+        "no-multiple-empty-lines": (string | {
+            max: number;
+        })[];
+        semi: string[];
+        curly: string[];
+        "object-curly-spacing": string[];
+        "no-dupe-else-if": string;
+        "no-duplicate-imports": string;
+        "no-cond-assign": string[];
+        "no-async-promise-executor": string;
+        "no-fallthrough": string;
+        eqeqeq: string[];
+        "prettier/prettier": (string | {
+            printWidth: number;
+            tabWidth: number;
+            useTabs: boolean;
+            semi: boolean;
+            singleQuote: boolean;
+            trailingComma: string;
+            bracketSpacing: boolean;
+            endOfLine: string;
+        })[];
+        "@typescript-eslint/naming-convention": (string | {
+            selector: string[];
+            format: string[];
+            leadingUnderscore: string;
+            modifiers?: undefined;
+        } | {
+            selector: string;
+            format: string[];
+            leadingUnderscore?: undefined;
+            modifiers?: undefined;
+        } | {
+            selector: string;
+            modifiers: string[];
+            format: string[];
+            leadingUnderscore?: undefined;
+        })[];
+    };
+}[];
+
+/**
+ * @usage
+ * configurate dotenv before dependency import
+ * @example
+ * `import { config } from 'dotenv';`
+ * `config();`
+ * `import { PgDataSourceOptions } from '@freshpointcz/fresh-package';`
+ */
+declare const PG_DATA_SOURCE_OPTIONS: DataSourceOptions;
+
+interface HealthCheckResult {
+    server: boolean;
+    db?: boolean | {
+        postgres?: boolean;
+        mariaDb?: boolean;
+    };
+    extras?: {
+        [extraServiceToCheck: string]: boolean;
+    };
+}
+
+export { AMOUNT_UNIT, ActionCommandCode, ApiError, Category, DataHelper, DateUtils, type Deferred, DepotPoolStatus, Device, FreshDao, FreshEntity, FreshHyperEntity, FreshJob, FreshTranslationBase, type HealthCheckResult, HttpStatus, LanguageCode, Manufacturer, type Maybe, PaymentMethod, PG_DATA_SOURCE_OPTIONS as PgDataSourceOptions, Product, SinglePromiseWaiter, Singleton, type Status, StatusDto, Subcategory, TimestampColumn, TransactionType, createDeferred, FRESH_ESLINT_CONFIG as freshEslintConfig, isValidCron, logger };