@aristid/leav-types 0.0.3 → 0.0.4-b0a5cfe

package/apps/core/src/utils/helpers/getDefaultActionsList.d.ts

@@ -0,0 +1,4 @@
+import { ActionsListConfig } from '../../_types/actionsList';
+import { IAttribute } from '../../_types/attribute';
+declare const _default: (attribute: IAttribute) => ActionsListConfig;
+export default _default;

package/apps/core/src/utils/helpers/getLibraryDefaultAttributes.d.ts

@@ -0,0 +1,3 @@
+import { LibraryBehavior } from '../../_types/library';
+declare const _default: (behavior: LibraryBehavior, libraryId: string) => string[];
+export default _default;

package/apps/core/src/utils/helpers/getPreviewsAttributes.d.ts

@@ -0,0 +1,2 @@
+export declare const getPreviewsAttributeName: (libraryId: string) => string;
+export declare const getPreviewsStatusAttributeName: (libraryId: string) => string;

package/apps/core/src/utils/helpers/getValuesToDisplay.d.ts

@@ -0,0 +1,2 @@
+import { IValue } from '_types/value';
+export declare const getValuesToDisplay: (values: IValue[]) => IValue[];

package/apps/core/src/utils/helpers/getValuesToDisplay.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/apps/core/src/utils/index.d.ts

@@ -0,0 +1,3 @@
+export { default as logger } from './logger/logger';
+export { default } from './utils';
+export { TypeGuards } from './typeGuards';

package/apps/core/src/utils/logger/logger.d.ts

@@ -0,0 +1,39 @@
+import * as logger from 'winston';
+interface IDeps {
+    config?: any;
+}
+export default function ({ config }?: IDeps): {
+    default: logger.Winston;
+    config: logger.Config;
+    transports: logger.Transports;
+    Transport: logger.TransportStatic;
+    Logger: logger.LoggerStatic;
+    Container: logger.ContainerStatic;
+    loggers: logger.ContainerInstance;
+    exception: logger.Exception;
+    exitOnError: boolean;
+    level: string;
+    log: logger.LogMethod;
+    silly: logger.LeveledLogMethod;
+    debug: logger.LeveledLogMethod;
+    verbose: logger.LeveledLogMethod;
+    info: logger.LeveledLogMethod;
+    warn: logger.LeveledLogMethod;
+    error: logger.LeveledLogMethod;
+    query(options: logger.QueryOptions, callback?: (err: Error, results: any) => void): any;
+    query(callback: (err: Error, results: any) => void): any;
+    stream(options?: any): NodeJS.ReadableStream;
+    handleExceptions(...transports: logger.TransportInstance[]): void;
+    unhandleExceptions(...transports: logger.TransportInstance[]): void;
+    add(transport: logger.TransportInstance, options?: logger.TransportOptions, created?: boolean): logger.LoggerInstance;
+    clear(): void;
+    remove(transport: string | logger.TransportInstance): logger.LoggerInstance;
+    startTimer(): logger.ProfileHandler;
+    profile(id: string, msg?: string, meta?: any, callback?: (err: Error, level: string, msg: string, meta: any) => void): logger.LoggerInstance;
+    addColors(target: logger.AbstractConfigSetColors): any;
+    setLevels(target: logger.AbstractConfigSetLevels): any;
+    cli(): logger.LoggerInstance;
+    close(): void;
+    configure(options: logger.LoggerOptions): void;
+};
+export {};

package/apps/core/src/utils/preview/preview.d.ts

@@ -0,0 +1 @@
+export declare const getPreviewUrl: () => string;

package/apps/core/src/utils/typeGuards/index.d.ts

@@ -0,0 +1,6 @@
+import { IVariableValue } from '../../domain/helpers/calculationVariable';
+import { IStandardValue, IValue } from '../../_types/value';
+export declare const TypeGuards: {
+    isVariableIValue: (value: IVariableValue["payload"]) => value is IValue;
+    isIStandardValue: (value: IValue) => value is IStandardValue;
+};

package/apps/core/src/utils/typeGuards/typeGuards.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/apps/core/src/utils/utils.d.ts

@@ -0,0 +1,97 @@
+import { i18n } from 'i18next';
+import { ActionsListConfig } from '_types/actionsList';
+import { IConfig } from '_types/config';
+import { ErrorFieldDetailMessage, Errors, IExtendedErrorMsg } from '../_types/errors';
+import { ILibrary, ILibraryPreviewsSettings, LibraryBehavior } from '_types/library';
+import { IValue } from '_types/value';
+import ValidationError from '../errors/ValidationError';
+import { IAttribute } from '../_types/attribute';
+import { IPreviewAttributesSettings, IPreviewVersion } from '../_types/filesManager';
+export type ToAny<T> = {
+    [P in keyof T]: any;
+};
+export interface IUtils {
+    libNameToQueryName(name: string): string;
+    libNameToTypeName(name: string): string;
+    /**
+     * Validate ID format: must be only alphanum characters and underscores
+     *
+     * @param id
+     */
+    isIdValid(id: string): boolean;
+    /**
+     * Validate endpoint format: if external, can be any URL, if internal must be only alphanum characters and dashes
+     *
+     * @param id
+     * @param isExternal
+     */
+    isEndpointValid(id: string, isExternal: boolean): boolean;
+    /**
+     * Rethrow an error prefixed by optional message.
+     * The same given error is re-thrown so stacktrace is kept intact
+     *
+     * @param err
+     * @param message
+     */
+    rethrow(err: Error, message?: string): never;
+    pipe(...fns: any[]): any;
+    mergeConcat<T = object, U = object>(object: T, sources: U): T & U;
+    nameValArrayToObj(arr?: Array<{}>, keyFieldName?: string, valueFieldName?: string): {
+        [key: string]: any;
+    };
+    objToNameValArray<T extends {}>(obj: {}, keyFieldName?: string, valueFieldName?: string): T[];
+    /**
+     * Get the tree library associated with the library given
+     *
+     * @param library
+     */
+    getLibraryTreeId(library: string): string;
+    /**
+     * Get the directories library associated with the library given
+     *
+     * @param library
+     */
+    getDirectoriesLibraryId(library: string): string;
+    /**
+     * Get the files library associated with the directories library given
+     *
+     * @param directoriesLibrary
+     */
+    getFilesLibraryId(directoriesLibrary: string): string;
+    forceArray<T>(val: T | T[]): T[];
+    getDefaultActionsList(attribute: IAttribute): ActionsListConfig;
+    getLibraryDefaultAttributes(behavior: LibraryBehavior, libraryId: string): string[];
+    timestampToDate(t: number | string): Date;
+    dateToTimestamp(d: Date): number;
+    isStandardAttribute(attribute: IAttribute): boolean;
+    isLinkAttribute(attribute: IAttribute): boolean;
+    isTreeAttribute(attribute: IAttribute): boolean;
+    /**
+     * Extract library and record ID from the "_to" field
+     *
+     * @param value Edge destination in the form of "<library>/<record_id>"
+     */
+    decomposeValueEdgeDestination(value: string): {
+        library: string;
+        id: string;
+    };
+    translateError(error: Errors | IExtendedErrorMsg | string, lang: string): string;
+    getFullApplicationEndpoint(endpoint?: string): string;
+    getCoreEntityCacheKey(entityType: string, entityId: string): string;
+    getRecordsCacheKey(libraryId: string, recordId: string): string;
+    generateExplicitValidationError<T>(field: keyof T, message: ErrorFieldDetailMessage, lang?: string): ValidationError<T>;
+    deleteFile(path: string): Promise<void>;
+    getUnixTime(): number;
+    getFileExtension(filename: string): string | null;
+    getProcessIdentifier(): string;
+    getPreviewsAttributeName(libraryId: string): string;
+    getPreviewsStatusAttributeName(libraryId: string): string;
+    getPreviewAttributesSettings(library: ILibrary): IPreviewAttributesSettings;
+    previewsSettingsToVersions(previewsSettings: ILibraryPreviewsSettings[]): IPreviewVersion[];
+    areValuesIdentical(value1: IValue, value2: IValue): boolean;
+}
+export interface IUtilsDeps {
+    config?: IConfig;
+    translator?: i18n;
+}
+export default function ({ config, translator }?: IUtilsDeps): IUtils;

package/apps/core/src/utils/utils.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/libs/app-root-path/src/index.d.ts

@@ -0,0 +1 @@
+export declare const appRootPath: () => string;

package/libs/config-manager/src/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Load appropriate config based on application environment.
+ * We first load default config, then env specified config (production, development...).
+ * Finally, config can be overridden locally with "local.js" config file
+ *
+ * If one of these files is missing, it will be silently ignored.
+ *
+ * @return {Promise} Full config
+ */
+export declare function loadConfig<T extends {} = {}>(dirPath: string, env: string): Promise<T>;

package/libs/message-broker/src/amqpService.d.ts

@@ -0,0 +1,20 @@
+import * as amqp from 'amqplib';
+import { IAmqp, onMessageFunc } from './types/amqp';
+export interface IAmqpService {
+    publisher: {
+        connection: amqp.Connection;
+        channel: amqp.ConfirmChannel;
+    };
+    consumer: {
+        connection: amqp.Connection;
+        channel: amqp.ConfirmChannel;
+    };
+    publish(exchange: string, routingKey: string, msg: string, priority?: number): Promise<boolean>;
+    consume(queue: string, routingKey: string, onMessage: onMessageFunc, consumerTag?: string): Promise<amqp.Replies.Consume>;
+    close(): Promise<void>;
+}
+interface IDeps {
+    config: IAmqp;
+}
+export default function ({ config }: IDeps): Promise<IAmqpService>;
+export {};

package/libs/message-broker/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default as amqpService } from './amqpService';
+export type { IAmqpService } from './amqpService';

package/libs/message-broker/src/types/amqp.d.ts

@@ -0,0 +1,15 @@
+import * as amqp from 'amqplib';
+export interface IAmqp {
+    connOpt: amqp.Options.Connect;
+    exchange: string;
+    type: string;
+    prefetch?: number;
+}
+export interface IAmqpConn {
+    connection: amqp.Connection;
+    channel: amqp.ConfirmChannel;
+}
+export interface IMessageBody {
+    [key: string]: any;
+}
+export type onMessageFunc = (msg: amqp.ConsumeMessage) => Promise<void>;

package/libs/utils/src/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const idFormatRegex: RegExp;
+export declare const endpointFormatRegex: RegExp;

package/libs/utils/src/index.d.ts

@@ -0,0 +1,11 @@
+export * from './constants';
+export * from './types/applications';
+export * from './types/errors';
+export * from './types/events';
+export * from './types/files';
+export * from './types/forms';
+export * from './types/helpers';
+export * from './types/logs';
+export * from './types/previews';
+export * from './types/values';
+export * from './utils';

package/libs/utils/src/types/applications.d.ts

@@ -0,0 +1 @@
+export declare const CONSULTED_APPS_KEY = "applications_consultation";

package/libs/utils/src/types/attributes.d.ts

@@ -0,0 +1,7 @@
+export declare enum AttributeType {
+    advanced = "advanced",
+    advanced_link = "advanced_link",
+    simple = "simple",
+    simple_link = "simple_link",
+    tree = "tree"
+}

package/libs/utils/src/types/errors.d.ts

@@ -0,0 +1,5 @@
+export declare enum ErrorTypes {
+    VALIDATION_ERROR = "VALIDATION_ERROR",
+    PERMISSION_ERROR = "PERMISSION_ERROR",
+    INTERNAL_ERROR = "INTERNAL_ERROR"
+}

package/libs/utils/src/types/events.d.ts

@@ -0,0 +1,75 @@
+export interface IEvent {
+    time: number;
+    userId: string;
+    emitter: string;
+    queryId: string;
+    instanceId: string;
+}
+/*** Database events ***/
+export declare enum EventAction {
+    API_KEY_DELETE = "API_KEY_DELETE",
+    API_KEY_SAVE = "API_KEY_SAVE",
+    APP_DELETE = "APP_DELETE",
+    APP_SAVE = "APP_SAVE",
+    ATTRIBUTE_DELETE = "ATTRIBUTE_DELETE",
+    ATTRIBUTE_SAVE = "ATTRIBUTE_SAVE",
+    EXPORT_START = "EXPORT_START",
+    EXPORT_END = "EXPORT_END",
+    DATA_IMPORT_START = "DATA_IMPORT_START",
+    DATA_IMPORT_END = "DATA_IMPORT_END",
+    CONFIG_IMPORT_START = "CONFIG_IMPORT_START",
+    CONFIG_IMPORT_END = "CONFIG_IMPORT_END",
+    GLOBAL_SETTINGS_SAVE = "GLOBAL_SETTINGS_SAVE",
+    LIBRARY_DELETE = "LIBRARY_DELETE",
+    LIBRARY_PURGE = "LIBRARY_PURGE",
+    LIBRARY_SAVE = "LIBRARY_SAVE",
+    TASKS_DELETE = "TASKS_DELETE",
+    PERMISSION_SAVE = "PERMISSION_SAVE",
+    RECORD_DELETE = "RECORD_DELETE",
+    RECORD_SAVE = "RECORD_SAVE",
+    TREE_ADD_ELEMENT = "TREE_ADD_ELEMENT",
+    TREE_DELETE = "TREE_DELETE",
+    TREE_DELETE_ELEMENT = "TREE_DELETE_ELEMENT",
+    TREE_MOVE_ELEMENT = "TREE_MOVE_ELEMENT",
+    TREE_SAVE = "TREE_SAVE",
+    VALUE_DELETE = "VALUE_DELETE",
+    VALUE_SAVE = "VALUE_SAVE",
+    VERSION_PROFILE_DELETE = "VERSION_PROFILE_DELETE",
+    VERSION_PROFILE_SAVE = "VERSION_PROFILE_SAVE"
+}
+export interface IDbPayload {
+    trigger?: string;
+    action: EventAction | string;
+    topic: {
+        record?: {
+            id: string;
+            libraryId: string;
+        };
+        library?: string;
+        attribute?: string;
+        tree?: string;
+        profile?: string;
+        permission?: {
+            type: string;
+            applyTo?: any;
+        };
+        apiKey?: string;
+        application?: string;
+        filename?: string;
+    };
+    before?: any;
+    after?: any;
+    metadata?: any;
+}
+export interface IDbEvent extends IEvent {
+    payload: IDbPayload;
+}
+/*** PubSub events ***/
+export type PublishedEvent<T> = IEvent & T;
+export interface IPubSubEvent extends IEvent {
+    payload: IPubSubPayload;
+}
+export interface IPubSubPayload {
+    triggerName: string;
+    data: any;
+}

package/libs/utils/src/types/files.d.ts

@@ -0,0 +1,16 @@
+export declare enum FileType {
+    IMAGE = "image",
+    VIDEO = "video",
+    AUDIO = "audio",
+    DOCUMENT = "document",
+    OTHER = "other"
+}
+export type FileRecord = Record<string, any> & {
+    type: FileType;
+};
+export interface IPreviewScalar {
+    pdf?: string;
+    file: FileRecord;
+    original: string;
+    [key: string]: string | FileRecord;
+}

package/libs/utils/src/types/forms.d.ts

@@ -0,0 +1,54 @@
+import { IKeyValue } from './helpers';
+export declare enum FormUIElementTypes {
+    DIVIDER = "divider",
+    FIELDS_CONTAINER = "fields_container",
+    TAB_FIELDS_CONTAINER = "tab_fields_container",
+    TEXT_BLOCK = "text_block",
+    TABS = "tabs"
+}
+export declare enum FormFieldTypes {
+    TEXT_INPUT = "input_field",
+    DATE = "date",
+    CHECKBOX = "checkbox",
+    ENCRYPTED = "encrypted",
+    DROPDOWN = "dropdown",
+    LINK = "link",
+    TREE = "tree"
+}
+export declare enum TabsDirection {
+    HORIZONTAL = "horizontal",
+    VERTICAL = "vertical"
+}
+export interface ICommonFieldsSettings {
+    label?: Record<string, string | null>;
+    attribute?: string;
+    useAttributeLabel?: boolean;
+}
+export interface IRequiredFieldsSettings extends ICommonFieldsSettings {
+    required?: boolean;
+}
+export interface IFormDividerSettings {
+    title?: string;
+}
+export interface IFormTabSettings {
+    label?: IKeyValue<string>;
+    id: string;
+}
+export interface IFormTabsSettings {
+    tabs: IFormTabSettings[];
+    direction: TabsDirection;
+}
+export interface IFormTextBlockSettings {
+    content?: string;
+}
+export interface IFormDateFieldSettings extends ICommonFieldsSettings {
+    withTime: boolean;
+}
+export interface IFormLinkFieldSettings extends ICommonFieldsSettings {
+    columns: Array<{
+        id: string;
+        label: Record<string, string>;
+    }>;
+    displayRecordIdentity: boolean;
+}
+export declare const FORM_ROOT_CONTAINER_ID = "__root";

package/libs/utils/src/types/helpers.d.ts

@@ -0,0 +1,13 @@
+export interface IKeyValue<T> {
+    [key: string]: T;
+}
+export type AnyPrimitive = string | number | boolean;
+export type Override<T1, T2> = Omit<T1, keyof T2> & T2;
+export type WithTypename<T> = {
+    [P in keyof T]: T[P] extends object ? WithTypename<T[P]> : T[P];
+} & {
+    readonly __typename?: string;
+};
+export type Mockify<T> = {
+    [P in keyof T]?: T[P] extends (...args: any[]) => any ? jest.Mock<ReturnType<T[P]> extends never ? never : any> : T[P];
+};

package/libs/utils/src/types/logs.d.ts

@@ -0,0 +1,2 @@
+import { IDbEvent, IDbPayload } from './events';
+export type Log = Omit<IDbEvent, 'payload' | 'emitter'> & IDbPayload;

package/libs/utils/src/types/previews.d.ts

@@ -0,0 +1,5 @@
+export declare enum PreviewPriority {
+    LOW = 1,
+    MEDIUM = 2,
+    HIGH = 3
+}

package/libs/utils/src/types/values.d.ts

@@ -0,0 +1,4 @@
+export interface IDateRangeValue {
+    from: string;
+    to: string;
+}

package/libs/utils/src/utils.d.ts

@@ -0,0 +1,68 @@
+import { AttributeType } from './types/attributes';
+import { FileType } from './types/files';
+import { IKeyValue } from './types/helpers';
+export declare const getGraphqlTypeFromLibraryName: (library: string) => string;
+export declare const getGraphqlQueryNameFromLibraryName: (library: string) => string;
+export declare const isFileAllowed: (fsPath: string, allowList: string[], ignoreList: string[], filePath: string) => boolean;
+export declare const localizedTranslation: (translations: Record<string, string>, availableLanguages: string[]) => string;
+/**
+ *
+ * @param str
+ * @param format 'hsl' || 'rgb' || 'hex'
+ * @param saturation in percent, default to 30
+ * @param luminosity in percent, default to 80
+ */
+export declare const stringToColor: (str?: string | null, format?: string, saturation?: number, luminosity?: number) => string;
+export declare const getInvertColor: (color: string) => string;
+/**
+ * Parse string to extract args.
+ * Arg is a string with format:
+ * -[argName] argValue
+ *
+ * eg. "-library product -type link" => {library: product, type: link}
+ * @param mapping
+ */
+export declare const extractArgsFromString: (mapping: string) => {
+    [arg: string]: string;
+};
+export declare const objectToNameValueArray: <T>(obj: IKeyValue<T>) => Array<{
+    name: string;
+    value: T;
+}>;
+export declare const nameValArrayToObj: (arr?: Array<{}>, keyFieldName?: string, valueFieldName?: string) => {
+    [key: string]: any;
+};
+export declare const getFileType: (fileName: string) => FileType;
+/**
+ * Return a simplified call stack (for the function who called this function, not this one, obviously)
+ *
+ * @param depth Number of calls to return
+ */
+export declare const getCallStack: (depth?: number) => string[];
+export declare const getInitials: (label: string, length?: number) => string;
+export declare const _getInitialEngine: (words: string[], length: number) => string;
+/**
+ * Format an ID: remove accents, any special characters, replace spaces by underscore and make sure there is no double underscore
+ *
+ * @param id
+ * @returns formatted ID
+ */
+export declare const slugifyString: (id: string, separator?: "-" | "_") => string;
+/**
+ * Returns a hash code from a string
+ * @param  {String} str The string to hash.
+ * @return {Number}    A 32bit integer
+ */
+export declare const simpleStringHash: (str: string) => number;
+export declare const getFlagByLang: (lang: string) => string;
+export declare const getLogsIndexName: (instanceId: string) => string;
+export declare const waitFor: (predicate: () => Promise<boolean> | boolean, options?: {
+    timeout?: number;
+    interval?: number;
+}) => Promise<boolean>;
+export declare const isTypeLink: (type: AttributeType) => type is AttributeType.advanced_link | AttributeType.simple_link;
+export declare const isTypeStandard: (type: AttributeType) => type is AttributeType.advanced | AttributeType.simple;
+/**
+ * Return a new object without the keys passed in parameter
+ */
+export declare const omit: <T extends object, K extends keyof T>(obj: T, ...keys: K[]) => Omit<T, K>;

package/package.json

@@ -1,17 +1,13 @@
 {
   "name": "@aristid/leav-types",
-  "version": "0.0.3",
+  "version": "0.0.4-b0a5cfe",
   "description": "Shared Leav types",
   "scripts": {
     "tscheck": "",
     "test:ci": "",
     "test:commit": "",
-    "publish": "npm publish --access public",
-    "publish:next": "npm publish --tag next"
+    "publish": "npm publish --verbose --access public"
   },
   "license": "LGPL3",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/leav-solutions/leav-engine.git"
-  }
-}
+  "repository": "https://github.com/leav-solutions/leav-engine"
+}