ngx-t-workflow-typings 1.0.0

package/dist/schemas/ProcessStep/ProcessStep.schema.js

@@ -0,0 +1,135 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adjudicationScoreSheetSchema = exports.processStepSchema = exports.adjudicationReviewedMicroFlowSubmissionSchema = void 0;
+exports.validateProcessStep = validateProcessStep;
+const joi_1 = __importDefault(require("joi"));
+const EscalationLevel_schema_1 = require("../Backend/EscalationLevel.schema");
+const FollowUpOperation_schema_1 = require("../Backend/FollowUpOperation.schema");
+const WorkflowSchedule_schema_1 = require("../Schedule/WorkflowSchedule.schema");
+const WORKFLOW_STEP_TYPES = [
+    'initiate',
+    'review',
+    'append',
+    'process',
+    'decision',
+    'end',
+    'bulkMail',
+    'adjudication',
+    'publicPortal',
+    'archive',
+    'checkout',
+    'checkin',
+];
+const WORKFLOW_STEP_STATUS = [
+    'pending',
+    'in-progress',
+    'rejected',
+    'escalated',
+    'complete',
+];
+const pointSchema = joi_1.default.object({
+    x: joi_1.default.number().required(),
+    y: joi_1.default.number().required(),
+});
+const nodeDecisionConditionSchema = joi_1.default.object({
+    expression: joi_1.default.string().required(),
+    valueAccessRules: joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.array()).required(),
+});
+const nodeBaseConnectionSchema = joi_1.default.object({
+    id: joi_1.default.string().required(),
+    outputId: joi_1.default.string().required(),
+    inputId: joi_1.default.alternatives().try(joi_1.default.string(), joi_1.default.valid(null)).required(),
+    text: joi_1.default.string().required(),
+    endColor: joi_1.default.string().optional(),
+    startColor: joi_1.default.string().optional(),
+    type: joi_1.default.string().optional(),
+});
+const nodeInputOutSchema = joi_1.default.object({
+    id: joi_1.default.string().required(),
+    side: joi_1.default.string().valid('left', 'right', 'top', 'bottom').required(),
+    label: joi_1.default.string().required(),
+    inEdit: joi_1.default.boolean().optional(),
+    decisionsCondition: nodeDecisionConditionSchema.optional(),
+    connections: joi_1.default.array().items(nodeBaseConnectionSchema).optional(),
+});
+const adjudicationScoreSheetSchema = joi_1.default.object({
+    formControlName: joi_1.default.string().required(),
+    totalPoints: joi_1.default.number().required(),
+    description: joi_1.default.string().required(),
+});
+exports.adjudicationScoreSheetSchema = adjudicationScoreSheetSchema;
+const adjudicationObjectSchema = joi_1.default.object({
+    scoreStepId: joi_1.default.string().required(),
+    scoreSheetWorkflowId: joi_1.default.string().required(),
+    scoreSheet: joi_1.default.array().items(adjudicationScoreSheetSchema).required(),
+});
+const processStepSchema = joi_1.default.object({
+    label: joi_1.default.string().required(),
+    icon: joi_1.default.string().optional(),
+    color: joi_1.default.string().optional(),
+    systemStep: joi_1.default.boolean().required(),
+    stepType: joi_1.default.string().valid(...WORKFLOW_STEP_TYPES).required(),
+    stepId: joi_1.default.string().required(),
+    position: pointSchema.required(),
+    inputs: joi_1.default.array().items(nodeInputOutSchema).required(),
+    outputs: joi_1.default.array().items(nodeInputOutSchema).required(),
+    controlName: joi_1.default.string().optional(),
+    duration: WorkflowSchedule_schema_1.durationSchema.optional(),
+    reference: joi_1.default.string().optional(),
+    bulkEmail: joi_1.default.object().pattern(joi_1.default.string(), joi_1.default.string()).optional(),
+    documentValueWithEmail: joi_1.default.string().optional(),
+    listPropertyWithEmail: joi_1.default.string().optional(),
+    initiateNextWorkflow: joi_1.default.boolean().optional(),
+    publicPortalConfig: joi_1.default.string().optional(),
+    postExpiryDateControlName: joi_1.default.string().optional(),
+    nextWorkflowId: joi_1.default.string().optional(),
+    nextWorkflowScheduleDateControlName: joi_1.default.string().optional(),
+    scheduleNextWorkflow: joi_1.default.boolean().optional(),
+    scheduleMultiItems: joi_1.default.boolean().optional(),
+    scheduleMultiItemsControlName: joi_1.default.string().optional(),
+    publicPortalFunctionalScoreSheetStep: joi_1.default.number().optional(),
+    class: joi_1.default.string().required(),
+    escalationRulee: joi_1.default.array().items(EscalationLevel_schema_1.escalationLevelSchema).optional(),
+    adjudication: joi_1.default.alternatives().try(adjudicationObjectSchema, joi_1.default.string()).required(),
+    microFlowSubmissions: joi_1.default.array().items(joi_1.default.string()).optional(),
+    workflowStepWithMicroFlowTransitions: joi_1.default.string().optional(),
+    adjudicationPricePreferenceCalculation: joi_1.default.string().optional(),
+    adjudicationPricePreferenceCalculationPriceKey: joi_1.default.string().optional(),
+    adjudicationMicroFlowStepWithReview: joi_1.default.string().optional(),
+    adjudicationRespondentNameKey: joi_1.default.string().optional(),
+    adjudicationRespondentCodeKey: joi_1.default.string().optional(),
+    workflowFormForScoreSheet: joi_1.default.string().optional(),
+    adjudicationStepWithScoreSheetControlName: joi_1.default.string().optional(),
+    adjudicationMicroFlowStepWithAssignPoints: joi_1.default.string().optional(),
+    microFlow: joi_1.default.string().required(),
+    formId: joi_1.default.string().optional(),
+    members: joi_1.default.array().items(joi_1.default.string()).optional(),
+    followUpOperations: joi_1.default.array()
+        .items(FollowUpOperation_schema_1.backEndFollowUpOperationSchema)
+        .required(),
+    active: joi_1.default.boolean().optional(),
+    status: joi_1.default.string().valid(...WORKFLOW_STEP_STATUS).required(),
+});
+exports.processStepSchema = processStepSchema;
+exports.adjudicationReviewedMicroFlowSubmissionSchema = joi_1.default.object({
+    id: joi_1.default.string().required(),
+    supplierNumber: joi_1.default.string().required(),
+    nameOfBidder: joi_1.default.string().required(),
+    responsePreferenceCalculationKey: joi_1.default.number().required(),
+    adj_microFlow_review: joi_1.default.boolean().required(),
+    createdAt: joi_1.default.date().required(),
+    updatedAt: joi_1.default.date().required(),
+});
+function validateProcessStep(data) {
+    const { error } = processStepSchema.validate(data, { abortEarly: false });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}

package/dist/schemas/ProcessStep/index.d.ts

@@ -0,0 +1 @@
+export { processStepSchema, adjudicationScoreSheetSchema, adjudicationReviewedMicroFlowSubmissionSchema, validateProcessStep, } from './ProcessStep.schema';

package/dist/schemas/ProcessStep/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateProcessStep = exports.adjudicationReviewedMicroFlowSubmissionSchema = exports.adjudicationScoreSheetSchema = exports.processStepSchema = void 0;
+var ProcessStep_schema_1 = require("./ProcessStep.schema");
+Object.defineProperty(exports, "processStepSchema", { enumerable: true, get: function () { return ProcessStep_schema_1.processStepSchema; } });
+Object.defineProperty(exports, "adjudicationScoreSheetSchema", { enumerable: true, get: function () { return ProcessStep_schema_1.adjudicationScoreSheetSchema; } });
+Object.defineProperty(exports, "adjudicationReviewedMicroFlowSubmissionSchema", { enumerable: true, get: function () { return ProcessStep_schema_1.adjudicationReviewedMicroFlowSubmissionSchema; } });
+Object.defineProperty(exports, "validateProcessStep", { enumerable: true, get: function () { return ProcessStep_schema_1.validateProcessStep; } });

package/dist/schemas/Schedule/WorkflowSchedule.schema.d.ts

@@ -0,0 +1,16 @@
+import Joi from 'joi';
+export declare const durationSchema: Joi.ObjectSchema<any>;
+export declare const workScheduleSchema: Joi.ObjectSchema<any>;
+export declare const taskSLAConfigSchema: Joi.ObjectSchema<any>;
+export declare function validateDuration(data: unknown): {
+    key: string;
+    message: string;
+}[];
+export declare function validateWorkSchedule(data: unknown): {
+    key: string;
+    message: string;
+}[];
+export declare function validateTaskSLAConfig(data: unknown): {
+    key: string;
+    message: string;
+}[];

package/dist/schemas/Schedule/WorkflowSchedule.schema.js

@@ -0,0 +1,74 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.taskSLAConfigSchema = exports.workScheduleSchema = exports.durationSchema = void 0;
+exports.validateDuration = validateDuration;
+exports.validateWorkSchedule = validateWorkSchedule;
+exports.validateTaskSLAConfig = validateTaskSLAConfig;
+const joi_1 = __importDefault(require("joi"));
+const DAYS_OF_WEEK = [
+    'Monday',
+    'Tuesday',
+    'Wednesday',
+    'Thursday',
+    'Friday',
+    'Saturday',
+    'Sunday',
+];
+exports.durationSchema = joi_1.default.object({
+    value: joi_1.default.number().required(),
+    unit: joi_1.default.string().valid('minutes', 'hours', 'days').required(),
+});
+exports.workScheduleSchema = joi_1.default.object({
+    workDayHours: joi_1.default.number().required(),
+    shiftStart: joi_1.default.string().required(),
+    shiftEnd: joi_1.default.string().required(),
+    workDays: joi_1.default.array()
+        .items(joi_1.default.string().valid(...DAYS_OF_WEEK))
+        .required(),
+    excludeHolidays: joi_1.default.boolean().required(),
+    holidayCalendarId: joi_1.default.string().optional(),
+});
+exports.taskSLAConfigSchema = joi_1.default.object({
+    id: joi_1.default.string().required(),
+    name: joi_1.default.string().required(),
+    duration: exports.durationSchema.optional(),
+    schedule: exports.workScheduleSchema.required(),
+    escalation: joi_1.default.object({
+        warningThresholdPercent: joi_1.default.number().required(),
+        notifyAssignee: joi_1.default.boolean().required(),
+        notifyManager: joi_1.default.boolean().required(),
+    }).optional(),
+});
+function validateDuration(data) {
+    const { error } = exports.durationSchema.validate(data, { abortEarly: false });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}
+function validateWorkSchedule(data) {
+    const { error } = exports.workScheduleSchema.validate(data, { abortEarly: false });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}
+function validateTaskSLAConfig(data) {
+    const { error } = exports.taskSLAConfigSchema.validate(data, { abortEarly: false });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}

package/dist/schemas/Schedule/index.d.ts

@@ -0,0 +1 @@
+export { durationSchema, workScheduleSchema, taskSLAConfigSchema, validateDuration, validateWorkSchedule, validateTaskSLAConfig, } from './WorkflowSchedule.schema';

package/dist/schemas/Schedule/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateTaskSLAConfig = exports.validateWorkSchedule = exports.validateDuration = exports.taskSLAConfigSchema = exports.workScheduleSchema = exports.durationSchema = void 0;
+var WorkflowSchedule_schema_1 = require("./WorkflowSchedule.schema");
+Object.defineProperty(exports, "durationSchema", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.durationSchema; } });
+Object.defineProperty(exports, "workScheduleSchema", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.workScheduleSchema; } });
+Object.defineProperty(exports, "taskSLAConfigSchema", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.taskSLAConfigSchema; } });
+Object.defineProperty(exports, "validateDuration", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.validateDuration; } });
+Object.defineProperty(exports, "validateWorkSchedule", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.validateWorkSchedule; } });
+Object.defineProperty(exports, "validateTaskSLAConfig", { enumerable: true, get: function () { return WorkflowSchedule_schema_1.validateTaskSLAConfig; } });

package/dist/schemas/Tag/TransactionTag.schema.d.ts

@@ -0,0 +1,9 @@
+import Joi from 'joi';
+export declare const iTagMetadataSchema: Joi.ObjectSchema<any>;
+export declare const iAuditEntrySchema: Joi.ObjectSchema<any>;
+export declare const iTagAssignmentSchema: Joi.ObjectSchema<any>;
+export declare const iTransactionTagSchema: Joi.ObjectSchema<any>;
+export declare function validateITransactionTag(data: unknown): {
+    key: string;
+    message: string;
+}[];

package/dist/schemas/Tag/TransactionTag.schema.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.iTransactionTagSchema = exports.iTagAssignmentSchema = exports.iAuditEntrySchema = exports.iTagMetadataSchema = void 0;
+exports.validateITransactionTag = validateITransactionTag;
+const joi_1 = __importDefault(require("joi"));
+exports.iTagMetadataSchema = joi_1.default.object({
+    category: joi_1.default.string().optional(),
+    color: joi_1.default.string().optional(),
+    priority: joi_1.default.number().optional(),
+}).pattern(joi_1.default.string(), joi_1.default.alternatives().try(joi_1.default.string(), joi_1.default.number(), joi_1.default.boolean()));
+exports.iAuditEntrySchema = joi_1.default.object({
+    action: joi_1.default.string().required(),
+    userId: joi_1.default.string().required(),
+    timestamp: joi_1.default.date().required(),
+    details: joi_1.default.object().required(),
+});
+exports.iTagAssignmentSchema = joi_1.default.object({
+    transactionId: joi_1.default.string().required(),
+    assignedBy: joi_1.default.string().required(),
+    assignedAt: joi_1.default.date().required(),
+    metadata: joi_1.default.object().optional(),
+});
+exports.iTransactionTagSchema = joi_1.default.object({
+    _id: joi_1.default.string().required(),
+    name: joi_1.default.string().required(),
+    description: joi_1.default.string().optional(),
+    metadata: exports.iTagMetadataSchema.required(),
+    busy: joi_1.default.boolean().optional(),
+    isActive: joi_1.default.boolean().required(),
+    assignments: joi_1.default.array().items(exports.iTagAssignmentSchema).required(),
+    auditTrail: joi_1.default.array().items(exports.iAuditEntrySchema).required(),
+    createdBy: joi_1.default.string().required(),
+    departmentId: joi_1.default.string().required(),
+    updatedBy: joi_1.default.string().required(),
+    createdAt: joi_1.default.date().required(),
+    updatedAt: joi_1.default.date().required(),
+    systemTag: joi_1.default.boolean().required(),
+});
+function validateITransactionTag(data) {
+    const { error } = exports.iTransactionTagSchema.validate(data, {
+        abortEarly: false,
+    });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}

package/dist/schemas/Tag/index.d.ts

@@ -0,0 +1 @@
+export { iTagMetadataSchema, iAuditEntrySchema, iTagAssignmentSchema, iTransactionTagSchema, validateITransactionTag, } from './TransactionTag.schema';

package/dist/schemas/Tag/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateITransactionTag = exports.iTransactionTagSchema = exports.iTagAssignmentSchema = exports.iAuditEntrySchema = exports.iTagMetadataSchema = void 0;
+var TransactionTag_schema_1 = require("./TransactionTag.schema");
+Object.defineProperty(exports, "iTagMetadataSchema", { enumerable: true, get: function () { return TransactionTag_schema_1.iTagMetadataSchema; } });
+Object.defineProperty(exports, "iAuditEntrySchema", { enumerable: true, get: function () { return TransactionTag_schema_1.iAuditEntrySchema; } });
+Object.defineProperty(exports, "iTagAssignmentSchema", { enumerable: true, get: function () { return TransactionTag_schema_1.iTagAssignmentSchema; } });
+Object.defineProperty(exports, "iTransactionTagSchema", { enumerable: true, get: function () { return TransactionTag_schema_1.iTransactionTagSchema; } });
+Object.defineProperty(exports, "validateITransactionTag", { enumerable: true, get: function () { return TransactionTag_schema_1.validateITransactionTag; } });

package/dist/schemas/Workflow/WorkflowModel.schema.d.ts

@@ -0,0 +1,6 @@
+import Joi from 'joi';
+export declare const workflowModelSchema: Joi.ObjectSchema<any>;
+export declare function validateWorkflowModel(data: unknown): {
+    key: string;
+    message: string;
+}[];

package/dist/schemas/Workflow/WorkflowModel.schema.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.workflowModelSchema = void 0;
+exports.validateWorkflowModel = validateWorkflowModel;
+const joi_1 = __importDefault(require("joi"));
+const ProcessStep_schema_1 = require("../ProcessStep/ProcessStep.schema");
+const documentSectionConfigSchema = joi_1.default.object({
+    sectionTitle: joi_1.default.string().required(),
+    icon: joi_1.default.string().required(),
+    getSectionList: joi_1.default.object({
+        submissionId: joi_1.default.string().required(),
+        httpEndPoint: joi_1.default.string().required(),
+    }).required(),
+    documentDetailsConfig: joi_1.default.object({
+        title: joi_1.default.string().required(),
+    }).optional(),
+    sectionGroup: joi_1.default.string().required(),
+    docuListConfig: joi_1.default.object({
+        segments: joi_1.default.array().required(),
+        activeSegment: joi_1.default.string().required(),
+        labelConfiguration: joi_1.default.array().required(),
+    }).optional(),
+});
+exports.workflowModelSchema = joi_1.default.object({
+    processTree: joi_1.default.array().items(ProcessStep_schema_1.processStepSchema).required(),
+    departmentId: joi_1.default.string().required(),
+    superAdmin: joi_1.default.string().required(),
+    _id: joi_1.default.string().required(),
+    createdAt: joi_1.default.date().required(),
+    updatedAt: joi_1.default.date().required(),
+    name: joi_1.default.string().required(),
+    isDocument: joi_1.default.boolean().required(),
+    documentConfig: documentSectionConfigSchema.optional(),
+    checkInAndOutWorkflow: joi_1.default.boolean().optional(),
+    checkInAndOutWorkflowId: joi_1.default.string().optional(),
+});
+function validateWorkflowModel(data) {
+    const { error } = exports.workflowModelSchema.validate(data, { abortEarly: false });
+    if (error) {
+        return error.details.map((detail) => ({
+            key: detail.path.join('.'),
+            message: detail.message,
+        }));
+    }
+    return [];
+}

package/dist/schemas/Workflow/index.d.ts

@@ -0,0 +1 @@
+export { workflowModelSchema, validateWorkflowModel, } from './WorkflowModel.schema';

package/dist/schemas/Workflow/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateWorkflowModel = exports.workflowModelSchema = void 0;
+var WorkflowModel_schema_1 = require("./WorkflowModel.schema");
+Object.defineProperty(exports, "workflowModelSchema", { enumerable: true, get: function () { return WorkflowModel_schema_1.workflowModelSchema; } });
+Object.defineProperty(exports, "validateWorkflowModel", { enumerable: true, get: function () { return WorkflowModel_schema_1.validateWorkflowModel; } });

package/dist/schemas/index.d.ts

@@ -0,0 +1,6 @@
+export * from './Backend/index';
+export * from './Document/index';
+export * from './ProcessStep/index';
+export * from './Schedule/index';
+export * from './Tag/index';
+export * from './Workflow/index';

package/dist/schemas/index.js

@@ -0,0 +1,22 @@
+"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("./Backend/index"), exports);
+__exportStar(require("./Document/index"), exports);
+__exportStar(require("./ProcessStep/index"), exports);
+__exportStar(require("./Schedule/index"), exports);
+__exportStar(require("./Tag/index"), exports);
+__exportStar(require("./Workflow/index"), exports);

package/dist/types/util.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Utility types for schema-interface coupling and type helpers.
+ */
+export type {};

package/dist/types/util.type.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * Utility types for schema-interface coupling and type helpers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "ngx-t-workflow-typings",
+  "version": "1.0.0",
+  "description": "Typings and interfaces for the ngx-t-workflows library.",
+  "keywords": [
+    "typings",
+    "typescript",
+    "workflow"
+  ],
+  "license": "ISC",
+  "type": "commonjs",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "npm run clean && tsc",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "peerDependencies": {
+    "ngx-t-forms-types": "^0.0.16",
+    "rxjs": "^7.8.2"
+  },
+  "dependencies": {
+    "joi": "^18.0.2"
+  },
+  "devDependencies": {
+    "@types/joi": "^17.2.2",
+    "ngx-t-forms-types": "^0.0.16",
+    "rimraf": "^6.1.3",
+    "typescript": "^5.9.3"
+  }
+}