@flusys/nestjs-shared 1.1.0-beta → 1.2.0-rc.1

package/constants/permissions.d.ts

@@ -0,0 +1,306 @@
+export declare const USER_PERMISSIONS: {
+    readonly CREATE: "user.create";
+    readonly READ: "user.read";
+    readonly UPDATE: "user.update";
+    readonly DELETE: "user.delete";
+};
+export declare const COMPANY_PERMISSIONS: {
+    readonly CREATE: "company.create";
+    readonly READ: "company.read";
+    readonly UPDATE: "company.update";
+    readonly DELETE: "company.delete";
+};
+export declare const BRANCH_PERMISSIONS: {
+    readonly CREATE: "branch.create";
+    readonly READ: "branch.read";
+    readonly UPDATE: "branch.update";
+    readonly DELETE: "branch.delete";
+};
+export declare const ACTION_PERMISSIONS: {
+    readonly CREATE: "action.create";
+    readonly READ: "action.read";
+    readonly UPDATE: "action.update";
+    readonly DELETE: "action.delete";
+};
+export declare const ROLE_PERMISSIONS: {
+    readonly CREATE: "role.create";
+    readonly READ: "role.read";
+    readonly UPDATE: "role.update";
+    readonly DELETE: "role.delete";
+};
+export declare const ROLE_ACTION_PERMISSIONS: {
+    readonly READ: "role-action.read";
+    readonly ASSIGN: "role-action.assign";
+};
+export declare const USER_ROLE_PERMISSIONS: {
+    readonly READ: "user-role.read";
+    readonly ASSIGN: "user-role.assign";
+};
+export declare const USER_ACTION_PERMISSIONS: {
+    readonly READ: "user-action.read";
+    readonly ASSIGN: "user-action.assign";
+};
+export declare const COMPANY_ACTION_PERMISSIONS: {
+    readonly READ: "company-action.read";
+    readonly ASSIGN: "company-action.assign";
+};
+export declare const FILE_PERMISSIONS: {
+    readonly CREATE: "file.create";
+    readonly READ: "file.read";
+    readonly UPDATE: "file.update";
+    readonly DELETE: "file.delete";
+};
+export declare const FOLDER_PERMISSIONS: {
+    readonly CREATE: "folder.create";
+    readonly READ: "folder.read";
+    readonly UPDATE: "folder.update";
+    readonly DELETE: "folder.delete";
+};
+export declare const STORAGE_CONFIG_PERMISSIONS: {
+    readonly CREATE: "storage-config.create";
+    readonly READ: "storage-config.read";
+    readonly UPDATE: "storage-config.update";
+    readonly DELETE: "storage-config.delete";
+};
+export declare const UPLOAD_CONFIG_PERMISSIONS: {
+    readonly DELETE: "upload-config.delete";
+};
+export declare const EMAIL_CONFIG_PERMISSIONS: {
+    readonly CREATE: "email-config.create";
+    readonly READ: "email-config.read";
+    readonly UPDATE: "email-config.update";
+    readonly DELETE: "email-config.delete";
+};
+export declare const EMAIL_TEMPLATE_PERMISSIONS: {
+    readonly CREATE: "email-template.create";
+    readonly READ: "email-template.read";
+    readonly UPDATE: "email-template.update";
+    readonly DELETE: "email-template.delete";
+};
+export declare const FORM_PERMISSIONS: {
+    readonly CREATE: "form.create";
+    readonly READ: "form.read";
+    readonly UPDATE: "form.update";
+    readonly DELETE: "form.delete";
+};
+export declare const FORM_RESULT_PERMISSIONS: {
+    readonly CREATE: "form-result.create";
+    readonly READ: "form-result.read";
+    readonly UPDATE: "form-result.update";
+    readonly DELETE: "form-result.delete";
+};
+export declare const EVENT_PERMISSIONS: {
+    readonly CREATE: "event.create";
+    readonly READ: "event.read";
+    readonly UPDATE: "event.update";
+    readonly DELETE: "event.delete";
+};
+export declare const NOTIFICATION_PERMISSIONS: {
+    readonly CREATE: "notification.create";
+    readonly READ: "notification.read";
+    readonly UPDATE: "notification.update";
+    readonly DELETE: "notification.delete";
+};
+export declare const LANGUAGE_PERMISSIONS: {
+    readonly CREATE: "language.create";
+    readonly READ: "language.read";
+    readonly UPDATE: "language.update";
+    readonly DELETE: "language.delete";
+};
+export declare const TRANSLATION_KEY_PERMISSIONS: {
+    readonly CREATE: "translation-key.create";
+    readonly READ: "translation-key.read";
+    readonly UPDATE: "translation-key.update";
+    readonly DELETE: "translation-key.delete";
+};
+export declare const TRANSLATION_PERMISSIONS: {
+    readonly CREATE: "translation.create";
+    readonly READ: "translation.read";
+    readonly UPDATE: "translation.update";
+    readonly DELETE: "translation.delete";
+};
+export declare const TASK_BOARD_PERMISSIONS: {
+    readonly CREATE: "task-board.create";
+    readonly READ: "task-board.read";
+    readonly UPDATE: "task-board.update";
+    readonly DELETE: "task-board.delete";
+    readonly MANAGE_MEMBERS: "task-board.manage-members";
+};
+export declare const TASK_LIST_PERMISSIONS: {
+    readonly CREATE: "task-list.create";
+    readonly READ: "task-list.read";
+    readonly UPDATE: "task-list.update";
+    readonly DELETE: "task-list.delete";
+};
+export declare const TASK_PERMISSIONS: {
+    readonly CREATE: "task.create";
+    readonly READ: "task.read";
+    readonly UPDATE: "task.update";
+    readonly DELETE: "task.delete";
+    readonly MOVE: "task.move";
+    readonly ASSIGN: "task.assign";
+};
+export declare const TASK_LABEL_PERMISSIONS: {
+    readonly CREATE: "task-label.create";
+    readonly READ: "task-label.read";
+    readonly UPDATE: "task-label.update";
+    readonly DELETE: "task-label.delete";
+};
+export declare const TASK_COMMENT_PERMISSIONS: {
+    readonly CREATE: "task-comment.create";
+    readonly READ: "task-comment.read";
+    readonly DELETE: "task-comment.delete";
+};
+export declare const PERMISSIONS: {
+    readonly USER: {
+        readonly CREATE: "user.create";
+        readonly READ: "user.read";
+        readonly UPDATE: "user.update";
+        readonly DELETE: "user.delete";
+    };
+    readonly COMPANY: {
+        readonly CREATE: "company.create";
+        readonly READ: "company.read";
+        readonly UPDATE: "company.update";
+        readonly DELETE: "company.delete";
+    };
+    readonly BRANCH: {
+        readonly CREATE: "branch.create";
+        readonly READ: "branch.read";
+        readonly UPDATE: "branch.update";
+        readonly DELETE: "branch.delete";
+    };
+    readonly ACTION: {
+        readonly CREATE: "action.create";
+        readonly READ: "action.read";
+        readonly UPDATE: "action.update";
+        readonly DELETE: "action.delete";
+    };
+    readonly ROLE: {
+        readonly CREATE: "role.create";
+        readonly READ: "role.read";
+        readonly UPDATE: "role.update";
+        readonly DELETE: "role.delete";
+    };
+    readonly ROLE_ACTION: {
+        readonly READ: "role-action.read";
+        readonly ASSIGN: "role-action.assign";
+    };
+    readonly USER_ROLE: {
+        readonly READ: "user-role.read";
+        readonly ASSIGN: "user-role.assign";
+    };
+    readonly USER_ACTION: {
+        readonly READ: "user-action.read";
+        readonly ASSIGN: "user-action.assign";
+    };
+    readonly COMPANY_ACTION: {
+        readonly READ: "company-action.read";
+        readonly ASSIGN: "company-action.assign";
+    };
+    readonly FILE: {
+        readonly CREATE: "file.create";
+        readonly READ: "file.read";
+        readonly UPDATE: "file.update";
+        readonly DELETE: "file.delete";
+    };
+    readonly FOLDER: {
+        readonly CREATE: "folder.create";
+        readonly READ: "folder.read";
+        readonly UPDATE: "folder.update";
+        readonly DELETE: "folder.delete";
+    };
+    readonly STORAGE_CONFIG: {
+        readonly CREATE: "storage-config.create";
+        readonly READ: "storage-config.read";
+        readonly UPDATE: "storage-config.update";
+        readonly DELETE: "storage-config.delete";
+    };
+    readonly EMAIL_CONFIG: {
+        readonly CREATE: "email-config.create";
+        readonly READ: "email-config.read";
+        readonly UPDATE: "email-config.update";
+        readonly DELETE: "email-config.delete";
+    };
+    readonly EMAIL_TEMPLATE: {
+        readonly CREATE: "email-template.create";
+        readonly READ: "email-template.read";
+        readonly UPDATE: "email-template.update";
+        readonly DELETE: "email-template.delete";
+    };
+    readonly FORM: {
+        readonly CREATE: "form.create";
+        readonly READ: "form.read";
+        readonly UPDATE: "form.update";
+        readonly DELETE: "form.delete";
+    };
+    readonly FORM_RESULT: {
+        readonly CREATE: "form-result.create";
+        readonly READ: "form-result.read";
+        readonly UPDATE: "form-result.update";
+        readonly DELETE: "form-result.delete";
+    };
+    readonly EVENT: {
+        readonly CREATE: "event.create";
+        readonly READ: "event.read";
+        readonly UPDATE: "event.update";
+        readonly DELETE: "event.delete";
+    };
+    readonly NOTIFICATION: {
+        readonly CREATE: "notification.create";
+        readonly READ: "notification.read";
+        readonly UPDATE: "notification.update";
+        readonly DELETE: "notification.delete";
+    };
+    readonly LANGUAGE: {
+        readonly CREATE: "language.create";
+        readonly READ: "language.read";
+        readonly UPDATE: "language.update";
+        readonly DELETE: "language.delete";
+    };
+    readonly TRANSLATION_KEY: {
+        readonly CREATE: "translation-key.create";
+        readonly READ: "translation-key.read";
+        readonly UPDATE: "translation-key.update";
+        readonly DELETE: "translation-key.delete";
+    };
+    readonly TRANSLATION: {
+        readonly CREATE: "translation.create";
+        readonly READ: "translation.read";
+        readonly UPDATE: "translation.update";
+        readonly DELETE: "translation.delete";
+    };
+    readonly TASK_BOARD: {
+        readonly CREATE: "task-board.create";
+        readonly READ: "task-board.read";
+        readonly UPDATE: "task-board.update";
+        readonly DELETE: "task-board.delete";
+        readonly MANAGE_MEMBERS: "task-board.manage-members";
+    };
+    readonly TASK_LIST: {
+        readonly CREATE: "task-list.create";
+        readonly READ: "task-list.read";
+        readonly UPDATE: "task-list.update";
+        readonly DELETE: "task-list.delete";
+    };
+    readonly TASK: {
+        readonly CREATE: "task.create";
+        readonly READ: "task.read";
+        readonly UPDATE: "task.update";
+        readonly DELETE: "task.delete";
+        readonly MOVE: "task.move";
+        readonly ASSIGN: "task.assign";
+    };
+    readonly TASK_LABEL: {
+        readonly CREATE: "task-label.create";
+        readonly READ: "task-label.read";
+        readonly UPDATE: "task-label.update";
+        readonly DELETE: "task-label.delete";
+    };
+    readonly TASK_COMMENT: {
+        readonly CREATE: "task-comment.create";
+        readonly READ: "task-comment.read";
+        readonly DELETE: "task-comment.delete";
+    };
+};
+export type PermissionCode = (typeof PERMISSIONS)[keyof typeof PERMISSIONS][keyof (typeof PERMISSIONS)[keyof typeof PERMISSIONS]];

package/decorators/api-response.decorator.d.ts

@@ -1,3 +1,3 @@
 import { Type } from '@nestjs/common';
-export type ArrayResponseType = 'list' | 'bulk';
+export type ArrayResponseType = 'list' | 'bulk' | 'single';
 export declare const ApiResponseDto: <T extends Type<unknown>>(dto: T, isArray?: boolean, arrayType?: ArrayResponseType) => <TFunction extends Function, Y>(target: TFunction | object, propertyKey?: string | symbol, descriptor?: TypedPropertyDescriptor<Y>) => void;

package/decorators/current-user.decorator.d.ts

@@ -1 +1 @@
-export declare const CurrentUser: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>>)[]) => ParameterDecorator;
+export declare const CurrentUser: (...dataOrPipes: (string | import("@nestjs/common").PipeTransform<any, any> | import("@nestjs/common").Type<import("@nestjs/common").PipeTransform<any, any>> | undefined)[]) => ParameterDecorator;

package/decorators/index.d.ts

@@ -1,4 +1,5 @@
 export * from './api-response.decorator';
 export * from './current-user.decorator';
+export * from './log-action.decorator';
 export * from './public.decorator';
 export * from './require-permission.decorator';

package/decorators/log-action.decorator.d.ts

@@ -0,0 +1,8 @@
+export interface ILogActionOptions {
+    action?: string;
+    module?: string;
+    includeParams?: boolean;
+    includeResult?: boolean;
+    logLevel?: 'debug' | 'info' | 'warn';
+}
+export declare function LogAction(options?: ILogActionOptions): MethodDecorator;

package/decorators/require-permission.decorator.d.ts

@@ -1,4 +1,4 @@
-import { PermissionCondition } from '../interfaces/permission.interface';
+import { IPermissionLogic } from '../interfaces/permission.interface';
 export declare const RequirePermission: (...permissions: string[]) => import("@nestjs/common").CustomDecorator<string>;
 export declare const RequireAnyPermission: (...permissions: string[]) => import("@nestjs/common").CustomDecorator<string>;
-export declare const RequirePermissionCondition: (condition: PermissionCondition) => import("@nestjs/common").CustomDecorator<string>;
+export declare const RequirePermissionLogic: (logic: IPermissionLogic) => import("@nestjs/common").CustomDecorator<string>;

package/dtos/delete.dto.d.ts

@@ -1,4 +1,5 @@
 export declare class DeleteDto {
     id: string | string[];
     type: 'delete' | 'restore' | 'permanent';
+    deletedById?: string;
 }

package/dtos/filter-and-pagination.dto.d.ts

@@ -5,9 +5,7 @@ export declare class FilterAndPaginationDto {
     sort?: Record<string, 'ASC' | 'DESC'>;
     select?: string[];
     withDeleted?: boolean;
-    extraKey?: string[];
 }
 export declare class GetByIdBodyDto {
     select?: string[];
-    extraKey?: string[];
 }

package/dtos/get-by-ids.dto.d.ts

@@ -0,0 +1,4 @@
+export declare class GetByIdsDto {
+    ids: string[];
+    select?: string[] | string;
+}

package/dtos/index.d.ts

@@ -1,5 +1,6 @@
 export * from './delete.dto';
 export * from './filter-and-pagination.dto';
+export * from './get-by-ids.dto';
 export * from './identity-response.dto';
 export * from './pagination.dto';
 export * from './response-payload.dto';

package/dtos/response-payload.dto.d.ts

@@ -6,6 +6,8 @@ export declare class RequestMetaDto {
 export declare class SingleResponseDto<T> {
     success: boolean;
     message: string;
+    messageKey?: string;
+    messageVariables?: Record<string, string | number>;
     data?: T;
     _meta?: RequestMetaDto;
 }
@@ -20,6 +22,8 @@ export declare class PaginationMetaDto {
 export declare class ListResponseDto<T> {
     success: boolean;
     message: string;
+    messageKey?: string;
+    messageVariables?: Record<string, string | number>;
     data?: T[];
     meta: PaginationMetaDto;
     _meta?: RequestMetaDto;
@@ -32,6 +36,8 @@ export declare class BulkMetaDto {
 export declare class BulkResponseDto<T> {
     success: boolean;
     message: string;
+    messageKey?: string;
+    messageVariables?: Record<string, string | number>;
     data?: T[];
     meta: BulkMetaDto;
     _meta?: RequestMetaDto;
@@ -39,25 +45,7 @@ export declare class BulkResponseDto<T> {
 export declare class MessageResponseDto {
     success: boolean;
     message: string;
+    messageKey?: string;
+    messageVariables?: Record<string, string | number>;
     _meta?: RequestMetaDto;
 }
-export declare class ValidationErrorDto {
-    field: string;
-    message: string;
-    constraint?: string;
-}
-export declare class ErrorResponseDto {
-    success: false;
-    message: string;
-    code?: string;
-    errors?: ValidationErrorDto[];
-    _meta?: RequestMetaDto;
-}
-export declare class ResponsePayloadDto<T> {
-    success: boolean;
-    message: string;
-    data?: T;
-    meta?: PaginationMetaDto | BulkMetaDto;
-    _meta?: RequestMetaDto;
-}
-export type ApiResponse<T> = SingleResponseDto<T> | ListResponseDto<T> | BulkResponseDto<T> | MessageResponseDto | ErrorResponseDto;

package/entities/index.d.ts

@@ -1,2 +1,3 @@
 export * from './identity';
+export * from './raw-type';
 export * from './user-root';

package/entities/raw-type.d.ts

@@ -0,0 +1 @@
+export type RawEntity = Record<string, unknown>;

package/enums/index.d.ts

@@ -0,0 +1,3 @@
+export * from './notification-type.enum';
+export * from './participant-status.enum';
+export * from './recurrence-type.enum';

package/enums/notification-type.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum NotificationType {
+    INFO = "info",
+    WARNING = "warning",
+    SUCCESS = "success",
+    ERROR = "error"
+}

package/enums/participant-status.enum.d.ts

@@ -0,0 +1,6 @@
+export declare enum ParticipantStatus {
+    PENDING = "pending",
+    ACCEPTED = "accepted",
+    DECLINED = "declined",
+    TENTATIVE = "tentative"
+}

package/enums/recurrence-type.enum.d.ts

@@ -0,0 +1,7 @@
+export declare enum RecurrenceType {
+    NONE = "none",
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    BIWEEKLY = "biweekly",
+    MONTHLY = "monthly"
+}

package/exceptions/base-app.exception.d.ts

@@ -0,0 +1,41 @@
+import { HttpException, HttpStatus } from '@nestjs/common';
+export interface IValidationError {
+    field: string;
+    message: string;
+}
+export interface IBaseAppExceptionOptions {
+    message: string;
+    messageKey?: string;
+    messageVariables?: Record<string, unknown>;
+    status?: HttpStatus;
+    errors?: IValidationError[];
+    metadata?: Record<string, unknown>;
+}
+export declare class BaseAppException extends HttpException {
+    readonly messageKey: string;
+    readonly messageVariables?: Record<string, unknown>;
+    readonly errors?: IValidationError[];
+    readonly metadata?: Record<string, unknown>;
+    constructor(options: IBaseAppExceptionOptions);
+}
+export declare class NotFoundException extends BaseAppException {
+    constructor(entity: string, id?: string);
+}
+export declare class ValidationException extends BaseAppException {
+    constructor(errors: IValidationError[]);
+}
+export declare class UnauthorizedException extends BaseAppException {
+    constructor(message?: string);
+}
+export declare class ForbiddenException extends BaseAppException {
+    constructor(message?: string);
+}
+export declare class ConflictException extends BaseAppException {
+    constructor(entity: string, field?: string);
+}
+export declare class InternalServerException extends BaseAppException {
+    constructor(message?: string);
+}
+export declare class ServiceUnavailableException extends BaseAppException {
+    constructor(service: string);
+}

package/exceptions/index.d.ts

@@ -1 +1,2 @@
+export * from './base-app.exception';
 export * from './permission.exception';

package/exceptions/permission.exception.d.ts

@@ -1,9 +1,9 @@
 import { ForbiddenException, InternalServerErrorException } from '@nestjs/common';
 export declare class PermissionSystemUnavailableException extends InternalServerErrorException {
-    constructor(message?: string);
+    constructor();
 }
 export declare class InsufficientPermissionsException extends ForbiddenException {
-    constructor(missingPermissions: string[], operator?: 'and' | 'or');
+    constructor(missingPermissions: string[], operator?: 'AND' | 'OR');
 }
 export declare class NoPermissionsFoundException extends ForbiddenException {
     constructor();