@iservice365/module-hygiene 0.0.1 → 0.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @iservice365/module-hygiene
 
+## 0.1.1
+
+### Patch Changes
+
+- 41083ab: Dependencies - update
+
+## 0.1.0
+
+### Minor Changes
+
+- 7fe7aae: Cleaning check list - initial implementation
+
 ## 0.0.1
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,2 +1,504 @@
+import Joi from 'joi';
+import * as mongodb from 'mongodb';
+import { ObjectId, ClientSession } from 'mongodb';
+import * as bson from 'bson';
+import { Request, Response, NextFunction } from 'express';
 
-export { }
+interface TManageAreaChecklist {
+    _id: string | ObjectId;
+    name: string;
+}
+type TArea = {
+    _id?: ObjectId;
+    name: string;
+    site?: string | ObjectId;
+    createdBy?: string | ObjectId;
+    checklist?: TManageAreaChecklist[];
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+};
+type TAreaUpdate = Pick<TArea, "name">;
+type TAreaUpdateChecklist = NonNullable<Pick<TArea, "checklist">>;
+declare const areaSchema: Joi.ObjectSchema<any>;
+declare function MArea(value: TArea): {
+    name: string;
+    site: string | ObjectId | undefined;
+    createdBy: string | ObjectId | undefined;
+    checklist: TManageAreaChecklist[] | undefined;
+    status: string;
+    createdAt: Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useAreaRepository(): {
+    createIndex: () => Promise<void>;
+    createTextIndex: () => Promise<void>;
+    createUniqueIndex: () => Promise<void>;
+    createArea: (value: TArea, session?: ClientSession) => Promise<ObjectId>;
+    getAreas: ({ page, limit, search, startDate, endDate, site, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        startDate?: string | Date | undefined;
+        endDate?: string | Date | undefined;
+        site?: string | ObjectId | undefined;
+    }) => Promise<{}>;
+    getAreaById: (_id: string | ObjectId) => Promise<{}>;
+    getAreaByName: (name: string, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    updateArea: (_id: string | ObjectId, value: TAreaUpdate) => Promise<number>;
+    updateAreaChecklist: (_id: string | ObjectId, value: TAreaUpdateChecklist) => Promise<number>;
+    deleteArea: (_id: string | ObjectId, session?: ClientSession) => Promise<number>;
+};
+
+declare function useAreaService(): {
+    uploadByFile: ({ dataJson, createdBy, site, }: {
+        dataJson: string;
+        createdBy: string | ObjectId;
+        site: string | ObjectId;
+    }) => Promise<{
+        message: string;
+    }>;
+};
+
+interface MulterRequest extends Request {
+    file?: {
+        buffer: Buffer;
+        originalname: string;
+        mimetype: string;
+        size: number;
+    };
+}
+
+declare function useAreaController(): {
+    createArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAreaById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    uploadByFile: (req: MulterRequest, res: Response, next: NextFunction) => Promise<Response<any, Record<string, any>> | undefined>;
+};
+
+interface TToiletLocationChecklist {
+    _id: string | ObjectId;
+    name: string;
+}
+interface TGetToiletLocationsQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: Record<string, any>;
+    startDate?: Date | string;
+    endDate?: Date | string;
+    site: ObjectId | string;
+}
+type TToiletLocation = {
+    _id?: ObjectId;
+    name: string;
+    createdBy?: string | ObjectId;
+    checklist?: TToiletLocationChecklist[];
+    status?: string;
+    site?: string | ObjectId;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: Date | string;
+};
+type TToiletUpdateChecklist = NonNullable<Pick<TToiletLocation, "checklist">>;
+declare const toiletLocationSchema: Joi.ObjectSchema<any>;
+declare function MToiletLocation(value: TToiletLocation): {
+    name: string;
+    site: string | ObjectId | undefined;
+    createdBy: string | ObjectId | undefined;
+    checklist: TToiletLocationChecklist[] | undefined;
+    status: string;
+    createdAt: Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useToiletLocationRepository(): {
+    createIndexes: () => Promise<void>;
+    createUniqueIndex: () => Promise<void>;
+    getToiletLocations: ({ page, limit, search, sort, startDate, endDate, site, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        sort?: Record<string, any> | undefined;
+        startDate?: string | Date | undefined;
+        endDate?: string | Date | undefined;
+        site?: string | ObjectId | undefined;
+    }) => Promise<{}>;
+    create: (value: TToiletLocation, session?: ClientSession) => Promise<ObjectId>;
+    updateToiletLocation: (_id: string | ObjectId, value: TToiletLocation) => Promise<number>;
+    deleteToiletLocation: (_id: string | ObjectId, session?: ClientSession) => Promise<number>;
+    getToiletLocationByName: (name: string, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    getToiletLocationById: (_id: string | ObjectId) => Promise<{}>;
+    updateToiletLocationChecklist: (_id: string | ObjectId, value: TToiletUpdateChecklist) => Promise<number>;
+};
+
+declare function useToiletLocationService(): {
+    uploadByFile: ({ dataJson, createdBy, site, }: {
+        dataJson: string;
+        createdBy: string | ObjectId;
+        site: string | ObjectId;
+    }) => Promise<{
+        message: string;
+    }>;
+};
+
+declare function useToiletLocationController(): {
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    createToiletLocation: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateToiletLocation: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteToiletLocation: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateToiletLocationChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getToiletLocationById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    uploadByFile: (req: MulterRequest, res: Response, next: NextFunction) => Promise<Response<any, Record<string, any>> | undefined>;
+};
+
+declare const allowedTypes: string[];
+declare const allowedStatus: string[];
+interface TParentChecklistStatus {
+    type: (typeof allowedTypes)[number];
+    site: string | ObjectId;
+    status: (typeof allowedStatus)[number];
+    completedAt: string | Date;
+}
+type TParentChecklist = {
+    _id?: ObjectId;
+    date: Date;
+    status?: TParentChecklistStatus[];
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+};
+declare const parentChecklistSchema: Joi.ObjectSchema<any>;
+declare function MParentChecklist(value: TParentChecklist): {
+    date: Date;
+    status: TParentChecklistStatus[] | undefined;
+    createdAt: Date;
+    updatedAt: string | Date;
+};
+
+declare function useParentChecklistRepo(): {
+    createIndex: () => Promise<void>;
+    createParentChecklist: (value: TParentChecklist, session?: ClientSession) => Promise<ObjectId>;
+    getAllParentChecklist: ({ page, limit, search, site, type, startDate, endDate, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        site: ObjectId | string;
+        type: (typeof allowedTypes)[number];
+        startDate?: string | Date | undefined;
+        endDate?: string | Date | undefined;
+    }) => Promise<{}>;
+    updateParentChecklistStatuses: (date?: Date) => Promise<mongodb.BulkWriteResult | null>;
+};
+
+declare function useParentChecklistController(): {
+    createParentChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAllParentChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+interface TUnit {
+    _id?: ObjectId;
+    name: string;
+    site?: string | ObjectId;
+    createdBy?: string | ObjectId;
+    status?: string;
+    createdAt?: string | Date;
+    updatedAt?: string | Date;
+    deletedAt?: string | Date;
+}
+type TUnitUpdate = Partial<Pick<TUnit, "name">>;
+interface TGetUnitsQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    startDate?: Date | string;
+    endDate?: Date | string;
+    site: ObjectId | string;
+}
+declare const unitSchema: Joi.ObjectSchema<any>;
+declare function MUnit(value: TUnit): {
+    name: string;
+    createdBy: string | ObjectId | undefined;
+    site: string | ObjectId | undefined;
+    status: string;
+    createdAt: Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useUnitService(): {
+    uploadByFile: ({ dataJson, createdBy, site, }: {
+        dataJson: string;
+        createdBy: string | ObjectId;
+        site: string | ObjectId;
+    }) => Promise<{
+        message: string;
+    }>;
+};
+
+declare function useUnitRepository(): {
+    createIndex: () => Promise<void>;
+    createTextIndex: () => Promise<void>;
+    createUniqueIndex: () => Promise<void>;
+    createUnit: (value: TUnit, session?: ClientSession) => Promise<ObjectId>;
+    getUnits: ({ page, limit, search, startDate, endDate, site, }: TGetUnitsQuery) => Promise<{}>;
+    getUnitByName: (name: string, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    getUnitById: (id: string | ObjectId, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    updateUnit: (_id: string | ObjectId, value: TUnitUpdate) => Promise<number>;
+    deleteUnit: (_id: string | ObjectId, session?: ClientSession) => Promise<number>;
+};
+
+declare function useUnitController(): {
+    createUnit: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateUnit: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteUnit: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    uploadByFile: (req: MulterRequest, res: Response, next: NextFunction) => Promise<Response<any, Record<string, any>> | undefined>;
+};
+
+interface TScheduleTaskAreaCheckList {
+    _id: string | ObjectId;
+    name: string;
+}
+interface TGetScheduleTaskAreasQuery {
+    page?: number;
+    limit?: number;
+    search?: string;
+    sort?: Record<string, any>;
+    startDate?: Date | string;
+    endDate?: Date | string;
+    site: ObjectId | string;
+}
+type TScheduleTaskArea = {
+    _id?: ObjectId;
+    name: string;
+    site?: string | ObjectId;
+    createdBy?: string | ObjectId;
+    checklist?: TScheduleTaskAreaCheckList[];
+    status?: string;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+    deletedAt?: Date | string;
+};
+declare const scheduleTaskAreaSchema: Joi.ObjectSchema<any>;
+declare function MScheduleTaskArea(value: TScheduleTaskArea): {
+    name: string;
+    site: string | ObjectId | undefined;
+    createdBy: string | ObjectId | undefined;
+    checklist: TScheduleTaskAreaCheckList[] | undefined;
+    status: string;
+    createdAt: Date;
+    updatedAt: string | Date;
+    deletedAt: string | Date;
+};
+
+declare function useScheduleTaskAreaRepository(): {
+    createUniqueIndex: () => Promise<void>;
+    createScheduleTaskArea: (value: TScheduleTaskArea, session?: ClientSession) => Promise<ObjectId>;
+    updateScheduleTaskArea: (_id: string | ObjectId, params: TScheduleTaskArea) => Promise<number>;
+    deleteScheduleTaskArea: (_id: string | ObjectId, session?: ClientSession) => Promise<number>;
+    getScheduleTaskAreas: ({ page, limit, search, startDate, endDate, site, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        startDate?: string | Date | undefined;
+        endDate?: string | Date | undefined;
+        site?: string | ObjectId | undefined;
+    }) => Promise<{}>;
+    createIndexes: () => Promise<void>;
+    getScheduleTaskAreaByName: (name: string, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    getScheduleTaskAreaById: (id: string | ObjectId, site?: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    getAreaById: (_id: string | ObjectId) => Promise<{}>;
+};
+
+declare function useScheduleTaskAreaService(): {
+    uploadByFile: ({ dataJson, createdBy, site, }: {
+        dataJson: string;
+        createdBy: string | ObjectId;
+        site: string | ObjectId;
+    }) => Promise<{
+        message: string;
+    }>;
+};
+
+declare function useScheduleTaskAreaController(): {
+    getAll: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAreaById: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    createScheduleTaskArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    updateScheduleTaskArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    deleteScheduleTaskArea: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    uploadByFile: (req: MulterRequest, res: Response, next: NextFunction) => Promise<Response<any, Record<string, any>> | undefined>;
+};
+
+type TAreaChecklist = {
+    _id?: ObjectId;
+    type: (typeof allowedTypes)[number];
+    site: string | ObjectId;
+    parentChecklist: string | ObjectId;
+    area: string | ObjectId;
+    name?: string;
+    metadata?: TAreaChecklistMetadata;
+    status?: (typeof allowedStatus)[number];
+    createdBy?: string | ObjectId;
+    createdAt?: Date | string;
+    acceptedBy?: string | ObjectId;
+    acceptedAt?: Date | string;
+    startedAt?: Date | string;
+    endedAt?: Date | string;
+    signature?: string;
+    updatedAt?: Date | string;
+};
+type TAreaChecklistMetadata = {
+    attachments?: string[];
+};
+type TAreaChecklistCreate = Pick<TAreaChecklist, "type" | "site" | "parentChecklist" | "createdBy"> & {
+    areas: Array<{
+        area: string | ObjectId;
+        name?: string;
+    }>;
+};
+declare const areaChecklistSchema: Joi.ObjectSchema<any>;
+declare function MAreaChecklist(value: TAreaChecklist): {
+    type: string;
+    site: string | ObjectId;
+    parentChecklist: string | ObjectId;
+    area: string | ObjectId;
+    name: string;
+    status: string;
+    createdBy: string | ObjectId;
+    createdAt: Date;
+    acceptedBy: string | ObjectId;
+    acceptedAt: string | Date;
+    startedAt: string | Date;
+    endedAt: string | Date;
+    signature: string;
+    updatedAt: string | Date;
+};
+
+declare function useAreaChecklistRepo(): {
+    createIndex: () => Promise<void>;
+    createTextIndex: () => Promise<void>;
+    createAreaChecklist: (value: TAreaChecklist, session?: ClientSession) => Promise<ObjectId>;
+    getAllAreaChecklist: ({ page, limit, search, site, type, parentChecklist, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        site: string | ObjectId;
+        type: (typeof allowedTypes)[number];
+        parentChecklist: string | ObjectId;
+    }) => Promise<{}>;
+    getAreaChecklistHistory: ({ page, limit, search, site, type, parentChecklist, status, createdAt, user, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        site: string | ObjectId;
+        type: (typeof allowedTypes)[number];
+        parentChecklist: string | ObjectId;
+        status?: string | undefined;
+        createdAt?: string | Date | undefined;
+        user?: string | ObjectId | undefined;
+    }) => Promise<{}>;
+    getAreaChecklistHistoryDetails: (_id: string | ObjectId) => Promise<{}>;
+    acceptAreaChecklist: (_id: string | ObjectId, acceptedBy: string | ObjectId) => Promise<number>;
+    attachImageAreaChecklist: (_id: string | ObjectId, attachments: string[], session?: ClientSession) => Promise<number>;
+    submitAreaChecklist: (_id: string | ObjectId, signature: string) => Promise<number>;
+    completeAreaChecklist: (_id: string | ObjectId, signature: string) => Promise<number>;
+};
+
+declare function useAreaChecklistController(): {
+    createAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAllAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAreaChecklistHistory: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAreaChecklistHistoryDetails: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    acceptAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    attachImageAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    submitAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    completeAreaChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+type TUnitChecklistMetadataWorkOrder = {
+    attachments?: Array<string>;
+    subject: string;
+    category: string | ObjectId;
+    highPriority?: boolean;
+    block?: string;
+    level?: string;
+    unit?: string;
+    location?: string;
+    description: string;
+    createdBy: string | ObjectId;
+    createdByName?: string;
+    serviceProvider?: string | ObjectId;
+    organization?: string | ObjectId;
+    site?: string | ObjectId;
+};
+type TUnitChecklistMetadata = {
+    attachments?: string[];
+    remarks?: string;
+    workOrder?: TUnitChecklistMetadataWorkOrder;
+};
+type TUnitChecklist = {
+    _id?: ObjectId;
+    site: string | ObjectId;
+    type: (typeof allowedTypes)[number];
+    parentChecklist: string | ObjectId;
+    areaChecklist: string | ObjectId;
+    unit: ObjectId;
+    name?: string;
+    approve?: boolean;
+    reject?: boolean;
+    checkedBy?: string | ObjectId;
+    metadata?: TUnitChecklistMetadata;
+    createdBy?: string | ObjectId;
+    createdAt?: Date | string;
+    updatedAt?: Date | string;
+};
+type TUnitChecklistApprove = Partial<Pick<TUnitChecklist, "approve" | "reject" | "checkedBy">>;
+type TUnitChecklistReject = Partial<Pick<TUnitChecklist, "approve" | "reject" | "checkedBy" | "metadata">>;
+declare const unitChecklistSchema: Joi.ObjectSchema<any>;
+declare function MUnitChecklist(value: TUnitChecklist): {
+    site: string | ObjectId;
+    type: string;
+    parentChecklist: string | ObjectId;
+    areaChecklist: string | ObjectId;
+    unit: ObjectId;
+    name: string;
+    approve: boolean;
+    reject: boolean;
+    createdBy: string | ObjectId;
+    createdAt: Date;
+    updatedAt: string | Date;
+};
+
+declare function useUnitChecklistRepo(): {
+    createIndex: () => Promise<void>;
+    createTextIndex: () => Promise<void>;
+    createUnitChecklist: (value: TUnitChecklist, session?: ClientSession) => Promise<ObjectId>;
+    getAllUnitChecklist: ({ page, limit, search, site, type, parentChecklist, areaChecklist, }: {
+        page?: number | undefined;
+        limit?: number | undefined;
+        search?: string | undefined;
+        site: string | ObjectId;
+        type: (typeof allowedTypes)[number];
+        parentChecklist: string | ObjectId;
+        areaChecklist: string | ObjectId;
+    }) => Promise<{}>;
+    getUnitChecklistById: (_id: string | ObjectId) => Promise<mongodb.WithId<bson.Document> | null>;
+    updateUnitChecklist: (_id: string | ObjectId, value: TUnitChecklistApprove | TUnitChecklistReject, session?: ClientSession) => Promise<number>;
+};
+
+declare function useUnitChecklistController(): {
+    createUnitChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    getAllUnitChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    approveUnitChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+    rejectUnitChecklist: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+};
+
+export { MArea, MAreaChecklist, MParentChecklist, MScheduleTaskArea, MToiletLocation, MUnit, MUnitChecklist, TArea, TAreaChecklist, TAreaChecklistCreate, TAreaChecklistMetadata, TAreaUpdate, TAreaUpdateChecklist, TGetScheduleTaskAreasQuery, TGetToiletLocationsQuery, TGetUnitsQuery, TManageAreaChecklist, TParentChecklist, TParentChecklistStatus, TScheduleTaskArea, TScheduleTaskAreaCheckList, TToiletLocation, TToiletLocationChecklist, TToiletUpdateChecklist, TUnit, TUnitChecklist, TUnitChecklistApprove, TUnitChecklistMetadata, TUnitChecklistMetadataWorkOrder, TUnitChecklistReject, TUnitUpdate, allowedStatus, allowedTypes, areaChecklistSchema, areaSchema, parentChecklistSchema, scheduleTaskAreaSchema, toiletLocationSchema, unitChecklistSchema, unitSchema, useAreaChecklistController, useAreaChecklistRepo, useAreaController, useAreaRepository, useAreaService, useParentChecklistController, useParentChecklistRepo, useScheduleTaskAreaController, useScheduleTaskAreaRepository, useScheduleTaskAreaService, useToiletLocationController, useToiletLocationRepository, useToiletLocationService, useUnitChecklistController, useUnitChecklistRepo, useUnitController, useUnitRepository, useUnitService };