@forwardslashns/taskit-validation-messages 1.0.0

package/.github/.workflows/npm-publish.yml

@@ -0,0 +1,27 @@
+name: Node.js Package
+
+on:
+  push:
+    branches: master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22
+      - run: npm ci
+
+  publish-npm:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+      - run: npm ci
+      - run: npm publish

package/README.md

@@ -0,0 +1,11 @@
+# Taskit Validation Messages
+
+This package provides a centralized list of validation messages used across both frontend and backend of the project. It ensures consistent error display and simplifies maintenance by keeping all validation messages in one place, without altering code in development repositories.
+
+# VALIDATION_MESSAGES
+
+The package exposes validation messages that can be retrieved using specific aliases. These messages are organized by the features they belong to, making it easier to manage and update them.
+
+# getValidationMessage
+
+This mechanism allows for the retrieval and dynamic creation of validation messages by passing their aliases and any required parameters. Parameters are optional and passed as objects, following the structure defined within each validation message itself.

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import { getValidationMessage } from "./validation/validation-message.formatter";
+import { VALIDATION_MESSAGES } from "./validation/validation-messages";
+export { VALIDATION_MESSAGES, getValidationMessage };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,2CAA2C,CAAC;AACjF,OAAO,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAEvE,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,CAAC"}

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValidationMessage = exports.VALIDATION_MESSAGES = void 0;
+const validation_message_formatter_1 = require("./validation/validation-message.formatter");
+Object.defineProperty(exports, "getValidationMessage", { enumerable: true, get: function () { return validation_message_formatter_1.getValidationMessage; } });
+const validation_messages_1 = require("./validation/validation-messages");
+Object.defineProperty(exports, "VALIDATION_MESSAGES", { enumerable: true, get: function () { return validation_messages_1.VALIDATION_MESSAGES; } });

package/dist/validation/validation-message.formatter.d.ts

@@ -0,0 +1,12 @@
+import { VALIDATION_MESSAGES } from './validation-messages';
+type Features = keyof typeof VALIDATION_MESSAGES;
+type ErrorType<F extends Features> = keyof (typeof VALIDATION_MESSAGES)[F];
+type ErrorMessageParams<F extends Features, E extends ErrorType<F>> = (typeof VALIDATION_MESSAGES)[F][E] extends {
+    params: infer P extends readonly string[];
+} ? P : [];
+type MessageParams<T extends readonly string[]> = {
+    [K in T[number]]: string;
+};
+export declare const getValidationMessage: <FeatureType extends Features, FeatureErrorType extends ErrorType<FeatureType>>(feature: FeatureType, featureError: FeatureErrorType, params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>) => string;
+export {};
+//# sourceMappingURL=validation-message.formatter.d.ts.map

package/dist/validation/validation-message.formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-message.formatter.d.ts","sourceRoot":"","sources":["../../src/validation/validation-message.formatter.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D,KAAK,QAAQ,GAAG,MAAM,OAAO,mBAAmB,CAAC;AACjD,KAAK,SAAS,CAAC,CAAC,SAAS,QAAQ,IAAI,MAAM,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC;AAC3E,KAAK,kBAAkB,CACrB,CAAC,SAAS,QAAQ,EAClB,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,IACpB,CAAC,OAAO,mBAAmB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS;IAC7C,MAAM,EAAE,MAAM,CAAC,SAAS,SAAS,MAAM,EAAE,CAAC;CAC3C,GACG,CAAC,GACD,EAAE,CAAC;AACP,KAAK,aAAa,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,IAAI;KAAG,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,GAAG,MAAM;CAAE,CAAC;AAM/E,eAAO,MAAM,oBAAoB,GAC/B,WAAW,SAAS,QAAQ,EAC5B,gBAAgB,SAAS,SAAS,CAAC,WAAW,CAAC,EAE/C,SAAS,WAAW,EACpB,cAAc,gBAAgB,EAC9B,SAAS,aAAa,CAAC,kBAAkB,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAC,KACxE,MAuDF,CAAC"}

package/dist/validation/validation-message.formatter.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getValidationMessage = void 0;
+const validation_messages_1 = require("./validation-messages");
+const getValidationMessage = (feature, featureError, params) => {
+    const messageConfig = validation_messages_1.VALIDATION_MESSAGES[feature][featureError];
+    if (!messageConfig) {
+        throw new Error(`Validation error message is not defined properly in configuration for feature: '${String(feature)}', error: '${String(featureError)}')`);
+    }
+    const inputParams = params || {};
+    const errorSuffix = `for feature: ${String(feature)}, error: ${String(featureError)}`;
+    let message = messageConfig.message;
+    const expectedParams = messageConfig.params?.length
+        ? messageConfig.params
+        : [];
+    if (!message) {
+        throw new Error(`Validation error message is not defined properly in configuration ${errorSuffix}`);
+    }
+    if (params && !expectedParams.length) {
+        throw new Error(`Validation error params are not defined properly in configuration ${errorSuffix}`);
+    }
+    expectedParams.forEach((param) => {
+        if (!(param in inputParams)) {
+            const missingParamMessage = `Missing parameter: ${param} ${errorSuffix}`;
+            throw new Error(missingParamMessage);
+        }
+    });
+    const matchingParamsInsideCurlyBraces = /\{([^}]+)\}/g;
+    let match;
+    while ((match = matchingParamsInsideCurlyBraces.exec(message)) !== null) {
+        const potentialParam = match[1];
+        if (expectedParams.length && !expectedParams.includes(potentialParam)) {
+            const typoMessage = `Potential typo in parameter name: {${potentialParam}} in message ${errorSuffix}. Expected parameters: ${expectedParams.join(', ')}`;
+            throw new Error(typoMessage);
+        }
+    }
+    expectedParams.forEach((param) => {
+        message = message.replace(`{${param}}`, inputParams[param]);
+    });
+    return message;
+};
+exports.getValidationMessage = getValidationMessage;

package/dist/validation/validation-messages.d.ts

@@ -0,0 +1,306 @@
+export declare const VALIDATION_MESSAGES: {
+    readonly DATA_FILTER: {
+        readonly MISSING_PAGE_SIZE: {
+            readonly message: "Request is invalid, 'pageSize' must exist if 'pageNumber' exists";
+        };
+        readonly MISSING_PAGE_NUMBER: {
+            readonly message: "Request is invalid, 'pageNumber' must exist if 'pageSize' exists";
+        };
+        readonly MISSING_SORT_BY: {
+            readonly message: "Request is invalid, 'sortBy' must exist if 'sortType' exists";
+        };
+        readonly MISSING_SORT_TYPE: {
+            readonly message: "Request is invalid, 'sortType' must exist if 'sortBy' exists";
+        };
+    };
+    readonly ACCOUNT_CATEGORY: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing account category id in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "Account category with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "Account category with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly OPTION_IN_USE: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+    };
+    readonly ACCOUNT_ID: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing account id identifier in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "Account id with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "Account id with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly ACCOUNT_CATEGORY_ID_DOES_NOT_EXIST: {
+            readonly message: "Account category with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly OPTION_IN_USE: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+    };
+    readonly BUSINESS_ACTIVITY: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing business activity id in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "Business activity with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "Business activity with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly OPTION_IN_USE: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+    };
+    readonly CLIENT: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing client id in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "Client with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly ACCOUNT_ID_DOES_NOT_EXIST: {
+            readonly message: "Account id with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly FILING_CATEGORY_ID_DOES_NOT_EXIST: {
+            readonly message: "Filing category with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly FILING_TYPE_ID_DOES_NOT_EXIST: {
+            readonly message: "Filing type with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly STATE_ID_DOES_NOT_EXIST: {
+            readonly message: "State with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly BUSINESS_ACTIVITY_ID_DOES_NOT_EXIST: {
+            readonly message: "Business activity with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly BILLING_TYPE_ID_DOES_NOT_EXIST: {
+            readonly message: "Billing type with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly ENTITY_TYPE_ID_DOES_NOT_EXIST: {
+            readonly message: "Entity type with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly CLIENT_WITH_SAME_FEDERAL_LEGAL_ID_EXISTS: {
+            readonly message: "This ID is already in use. Please enter a different ID.";
+        };
+        readonly INVALID_CLIENT_ACTIVITY_STATUS: {
+            readonly message: "The 'Is active' field only applies to our clients. Please update the client type to 'Not our client' or update the 'Is active' status to 'Active'.";
+        };
+        readonly INVALID_FEDERAL_LEGAL_ID: {
+            readonly message: "Enter a valid {legalIdType} (e.g. {legalIdValue})";
+            readonly params: readonly ["legalIdType", "legalIdValue"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "Client with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly NOT_ALIGNED_DATE_ESTABLISHED_ENTITY_TYPE_STARTING_DATE: {
+            readonly message: "One or more entity types have a start date that is before the client's date established, {clientDateEstablished}. ({entityType} starting {entityTypeStartingDate}). Please update the entity type start dates to be on or after the client's date established, or update the client's date established.";
+            readonly params: readonly ["clientDateEstablished", "entityType", "entityTypeStartingDate"];
+        };
+        readonly NOT_ALIGNED_DATE_ESTABLISHED_FILING_TYPE_STARTING_DATE: {
+            readonly message: "The filing type status {filingType} starts on {filingTypeStartingDate} which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the filing type status or the client's date established.";
+            readonly params: readonly ["clientDateEstablished", "filingType", "filingTypeStartingDate"];
+        };
+        readonly NOT_ALIGNED_DATE_ESTABLISHED_DOMESTIC_STATE_STARTING_DATE: {
+            readonly message: "The state, {domesticState}, starts on {domesticStateStartingDate}, which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the state or the client's date established.";
+            readonly params: readonly ["clientDateEstablished", "domesticState", "domesticStateStartingDate"];
+        };
+        readonly NOT_ALIGNED_DATE_ESTABLISHED_CLOSE_DATE: {
+            readonly message: "Adjust the close date to be after the date established.";
+        };
+        readonly NOT_ALIGNED_CLOSE_DATE_ENTITY_TYPE_STARTING_DATE: {
+            readonly message: "One or more entity types have start dates that are after the client's close date, {clientCloseDate}. {entityType} starting {entityTypeStartingDate}. Please update the entity type/s end date/s to be on or before the client's close date, or update the client's close date.";
+            readonly params: readonly ["clientCloseDate", "entityType", "entityTypeStartingDate"];
+        };
+        readonly NOT_ALIGNED_CLOSE_DATE_FILING_TYPE_STARTING_DATE: {
+            readonly message: "One or more filing type statuses have a start date which is after the client’s close date of {clientCloseDate}. {filingType}, starting {filingTypeStartingDate}. Please update the start date to be earlier than the client’s close date, or update the client's close date.";
+            readonly params: readonly ["clientCloseDate", "filingType", "filingTypeStartingDate"];
+        };
+        readonly NOT_ALIGNED_CLOSE_DATE_DOMEASTIC_STATE_STARTING_DATE: {
+            readonly message: "One or more states have a start date which is after the client's close date of {clientCloseDate}. {domesticState} starting {domesticStateStartingDate}. Please update the state/s start date/s to be before the client's close date, or update the client's close date.";
+            readonly params: readonly ["clientCloseDate", "domesticState", "domesticStateStartingDate"];
+        };
+        readonly ENTITY_TYPE_STARTING_DATE_NOT_POPULATED: {
+            readonly message: "Current Entity Type Starting Date cannot be Empty";
+        };
+        readonly FILING_TYPE_STARTING_DATE_NOT_POPULATED: {
+            readonly message: "Current Filing Type Starting Date cannot be Empty";
+        };
+        readonly DOMESTIC_STATE_STARTING_DATE_NOT_POPULATED: {
+            readonly message: "Current Domestic State Starting Date cannot be Empty";
+        };
+        readonly NOT_ALIGNED_ENTITY_TYPE_STARTING_ENDING_DATE: {
+            readonly message: "Entity type starting date needs to be before the ending date";
+        };
+        readonly NOT_ALIGNED_FILING_TYPE_STARTING_ENDING_DATE: {
+            readonly message: "Filing type starting date needs to be before the ending date";
+        };
+        readonly NOT_ALIGNED_DOMESTIC_STATE_STARTING_ENDING_DATE: {
+            readonly message: "Domestic state starting date needs to be before the ending date";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ACCOUNT_ID: {
+            readonly message: "Choose an Account ID";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BUSINESS_ACTIVITY_ID: {
+            readonly message: "Choose a Business Activity";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BILLING_TYPE_ID: {
+            readonly message: "Choose a Billing Type";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_FILING_CATEGORY_ID: {
+            readonly message: "Choose a Filing Category";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_CONTACT: {
+            readonly message: "Create a Contact - One contact needs to have been saved to this client";
+        };
+        readonly CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ADDRESS: {
+            readonly message: "Create an Address - One address needs to have been saved to this client";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_CLIENT_CIRCLE_EXIST: {
+            readonly message: "This client cannot be deleted because it has client circle associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_CLIENT_PROJECT_TEMPLATES_EXIST: {
+            readonly message: "This client cannot be deleted because it has client project templates associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_ADDITIONAL_INFORMATION_EXIST: {
+            readonly message: "This client cannot be deleted because it has additional information associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_BANK_ACCOUNTS_EXIST: {
+            readonly message: "This client cannot be deleted because it has bank accounts associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_WORKLOGS_EXIST: {
+            readonly message: "This client cannot be deleted because it has worklogs associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_INVOICES_EXIST: {
+            readonly message: "This client cannot be deleted because it has invoices associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_PAYMENTS_EXIST: {
+            readonly message: "This client cannot be deleted because it has payments associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_DOCUMENTS_EXIST: {
+            readonly message: "This client cannot be deleted because it has documents associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_JOURNALS_EXIST: {
+            readonly message: "This client cannot be deleted because it has journals associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_FUTURES_EXIST: {
+            readonly message: "This client cannot be deleted because it has futures associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_PROJECTS_EXIST: {
+            readonly message: "This client cannot be deleted because it has projects associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_TASKS_EXIST: {
+            readonly message: "This client cannot be deleted because it has tasks associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_ADDRESSES_EXIST: {
+            readonly message: "This client cannot be deleted because it has addresses associated";
+        };
+        readonly CLIENT_COULD_NOT_BE_DELETED_CONTACTS_EXIST: {
+            readonly message: "This client cannot be deleted because it has contacts associated";
+        };
+    };
+    readonly FILING_CATEGORY: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing filing category id in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "Filing category with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "Filing category with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly OPTION_IN_USE: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+    };
+    readonly STATE: {
+        readonly INVALID_REQUEST: {
+            readonly message: "Missing state id in request";
+        };
+        readonly ID_DOES_NOT_EXIST: {
+            readonly message: "State with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly NAME_ALREADY_EXISTS: {
+            readonly message: "State with the same name '{name}' already exists";
+            readonly params: readonly ["name"];
+        };
+        readonly STATE_TYPE_ID_DOES_NOT_EXIST: {
+            readonly message: "State type with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly IS_PARENT_OF_OTHER_STATES: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+        readonly PARENT_ID_DOES_NOT_EXIST: {
+            readonly message: "Parent state with id '{id}' does not exist";
+            readonly params: readonly ["id"];
+        };
+        readonly PARENT_STATE_TYPE_NOT_ALLOWED: {
+            readonly message: "Parent state '{parentName}' has type '{parentType}' which is not allowed parent type for state '{stateName}' with type '{stateType}'";
+            readonly params: readonly ["parentName", "parentType", "stateName", "stateType"];
+        };
+        readonly OPTION_IN_USE: {
+            readonly message: "This option is currently in use and cannot be deleted.";
+        };
+    };
+    readonly USER: {
+        readonly USERNAME_DOES_NOT_EXIST: {
+            readonly message: "User with username {username} does not exist.";
+            readonly params: readonly ["username"];
+        };
+        readonly INVALID_PASSWORD: {
+            readonly message: "User with username {username} password does not match.";
+            readonly params: readonly ["username"];
+        };
+        readonly INVALID_RESET_PASSWORD_TOKEN: {
+            readonly message: "Invalid or expired reset token.";
+        };
+        readonly RESET_PASSWORD_LINK_ALREADY_USED: {
+            readonly message: "Reset password link has already been used. Please request a new one.";
+        };
+        readonly RESET_PASSWORD_LINK_NOT_LATEST: {
+            readonly message: "Reset password link is no longer valid. Please use the most recent one.";
+        };
+    };
+    readonly USER_PREFERENCE: {
+        readonly FEATURE_DOES_NOT_EXIST: {
+            readonly message: "Feature with name {feature} does not exist";
+            readonly params: readonly ["feature"];
+        };
+        readonly INVALID_REQUEST: {
+            readonly message: "Request is invalid";
+        };
+        readonly PREFERENCE_DOES_NOT_BELONG_TO_USER: {
+            readonly message: "Preference does not belong to the user";
+        };
+        readonly INVALID_COLUMN_ORDER: {
+            readonly message: "Invalid columnOrder values";
+        };
+    };
+};
+//# sourceMappingURL=validation-messages.d.ts.map

package/dist/validation/validation-messages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"validation-messages.d.ts","sourceRoot":"","sources":["../../src/validation/validation-messages.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoTtB,CAAC"}

package/dist/validation/validation-messages.js

@@ -0,0 +1,312 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VALIDATION_MESSAGES = void 0;
+exports.VALIDATION_MESSAGES = {
+    DATA_FILTER: {
+        MISSING_PAGE_SIZE: {
+            message: `Request is invalid, 'pageSize' must exist if 'pageNumber' exists`,
+        },
+        MISSING_PAGE_NUMBER: {
+            message: `Request is invalid, 'pageNumber' must exist if 'pageSize' exists`,
+        },
+        MISSING_SORT_BY: {
+            message: `Request is invalid, 'sortBy' must exist if 'sortType' exists`,
+        },
+        MISSING_SORT_TYPE: {
+            message: `Request is invalid, 'sortType' must exist if 'sortBy' exists`,
+        },
+    },
+    ACCOUNT_CATEGORY: {
+        INVALID_REQUEST: {
+            message: 'Missing account category id in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `Account category with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `Account category with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        OPTION_IN_USE: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+    },
+    ACCOUNT_ID: {
+        INVALID_REQUEST: {
+            message: 'Missing account id identifier in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `Account id with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `Account id with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        ACCOUNT_CATEGORY_ID_DOES_NOT_EXIST: {
+            message: `Account category with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        OPTION_IN_USE: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+    },
+    BUSINESS_ACTIVITY: {
+        INVALID_REQUEST: {
+            message: 'Missing business activity id in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `Business activity with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `Business activity with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        OPTION_IN_USE: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+    },
+    CLIENT: {
+        INVALID_REQUEST: {
+            message: 'Missing client id in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `Client with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        ACCOUNT_ID_DOES_NOT_EXIST: {
+            message: `Account id with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        FILING_CATEGORY_ID_DOES_NOT_EXIST: {
+            message: `Filing category with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        FILING_TYPE_ID_DOES_NOT_EXIST: {
+            message: `Filing type with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        STATE_ID_DOES_NOT_EXIST: {
+            message: `State with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        BUSINESS_ACTIVITY_ID_DOES_NOT_EXIST: {
+            message: `Business activity with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        BILLING_TYPE_ID_DOES_NOT_EXIST: {
+            message: `Billing type with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        ENTITY_TYPE_ID_DOES_NOT_EXIST: {
+            message: `Entity type with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        CLIENT_WITH_SAME_FEDERAL_LEGAL_ID_EXISTS: {
+            message: `This ID is already in use. Please enter a different ID.`,
+        },
+        INVALID_CLIENT_ACTIVITY_STATUS: {
+            message: `The 'Is active' field only applies to our clients. Please update the client type to 'Not our client' or update the 'Is active' status to 'Active'.`,
+        },
+        INVALID_FEDERAL_LEGAL_ID: {
+            message: `Enter a valid {legalIdType} (e.g. {legalIdValue})`,
+            params: ['legalIdType', 'legalIdValue'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `Client with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        NOT_ALIGNED_DATE_ESTABLISHED_ENTITY_TYPE_STARTING_DATE: {
+            message: `One or more entity types have a start date that is before the client's date established, {clientDateEstablished}. ({entityType} starting {entityTypeStartingDate}). Please update the entity type start dates to be on or after the client's date established, or update the client's date established.`,
+            params: ['clientDateEstablished', 'entityType', 'entityTypeStartingDate'],
+        },
+        NOT_ALIGNED_DATE_ESTABLISHED_FILING_TYPE_STARTING_DATE: {
+            message: `The filing type status {filingType} starts on {filingTypeStartingDate} which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the filing type status or the client's date established.`,
+            params: ['clientDateEstablished', 'filingType', 'filingTypeStartingDate'],
+        },
+        NOT_ALIGNED_DATE_ESTABLISHED_DOMESTIC_STATE_STARTING_DATE: {
+            message: `The state, {domesticState}, starts on {domesticStateStartingDate}, which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the state or the client's date established.`,
+            params: [
+                'clientDateEstablished',
+                'domesticState',
+                'domesticStateStartingDate',
+            ],
+        },
+        NOT_ALIGNED_DATE_ESTABLISHED_CLOSE_DATE: {
+            message: `Adjust the close date to be after the date established.`,
+        },
+        NOT_ALIGNED_CLOSE_DATE_ENTITY_TYPE_STARTING_DATE: {
+            message: `One or more entity types have start dates that are after the client's close date, {clientCloseDate}. {entityType} starting {entityTypeStartingDate}. Please update the entity type/s end date/s to be on or before the client's close date, or update the client's close date.`,
+            params: ['clientCloseDate', 'entityType', 'entityTypeStartingDate'],
+        },
+        NOT_ALIGNED_CLOSE_DATE_FILING_TYPE_STARTING_DATE: {
+            message: `One or more filing type statuses have a start date which is after the client’s close date of {clientCloseDate}. {filingType}, starting {filingTypeStartingDate}. Please update the start date to be earlier than the client’s close date, or update the client's close date.`,
+            params: ['clientCloseDate', 'filingType', 'filingTypeStartingDate'],
+        },
+        NOT_ALIGNED_CLOSE_DATE_DOMEASTIC_STATE_STARTING_DATE: {
+            message: `One or more states have a start date which is after the client's close date of {clientCloseDate}. {domesticState} starting {domesticStateStartingDate}. Please update the state/s start date/s to be before the client's close date, or update the client's close date.`,
+            params: ['clientCloseDate', 'domesticState', 'domesticStateStartingDate'],
+        },
+        ENTITY_TYPE_STARTING_DATE_NOT_POPULATED: {
+            message: `Current Entity Type Starting Date cannot be Empty`,
+        },
+        FILING_TYPE_STARTING_DATE_NOT_POPULATED: {
+            message: `Current Filing Type Starting Date cannot be Empty`,
+        },
+        DOMESTIC_STATE_STARTING_DATE_NOT_POPULATED: {
+            message: `Current Domestic State Starting Date cannot be Empty`,
+        },
+        NOT_ALIGNED_ENTITY_TYPE_STARTING_ENDING_DATE: {
+            message: `Entity type starting date needs to be before the ending date`,
+        },
+        NOT_ALIGNED_FILING_TYPE_STARTING_ENDING_DATE: {
+            message: `Filing type starting date needs to be before the ending date`,
+        },
+        NOT_ALIGNED_DOMESTIC_STATE_STARTING_ENDING_DATE: {
+            message: `Domestic state starting date needs to be before the ending date`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ACCOUNT_ID: {
+            message: `Choose an Account ID`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BUSINESS_ACTIVITY_ID: {
+            message: `Choose a Business Activity`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BILLING_TYPE_ID: {
+            message: `Choose a Billing Type`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_FILING_CATEGORY_ID: {
+            message: `Choose a Filing Category`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_CONTACT: {
+            message: `Create a Contact - One contact needs to have been saved to this client`,
+        },
+        CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ADDRESS: {
+            message: `Create an Address - One address needs to have been saved to this client`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_CLIENT_CIRCLE_EXIST: {
+            message: `This client cannot be deleted because it has client circle associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_CLIENT_PROJECT_TEMPLATES_EXIST: {
+            message: `This client cannot be deleted because it has client project templates associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_ADDITIONAL_INFORMATION_EXIST: {
+            message: `This client cannot be deleted because it has additional information associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_BANK_ACCOUNTS_EXIST: {
+            message: `This client cannot be deleted because it has bank accounts associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_WORKLOGS_EXIST: {
+            message: `This client cannot be deleted because it has worklogs associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_INVOICES_EXIST: {
+            message: `This client cannot be deleted because it has invoices associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_PAYMENTS_EXIST: {
+            message: `This client cannot be deleted because it has payments associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_DOCUMENTS_EXIST: {
+            message: `This client cannot be deleted because it has documents associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_JOURNALS_EXIST: {
+            message: `This client cannot be deleted because it has journals associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_FUTURES_EXIST: {
+            message: `This client cannot be deleted because it has futures associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_PROJECTS_EXIST: {
+            message: `This client cannot be deleted because it has projects associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_TASKS_EXIST: {
+            message: `This client cannot be deleted because it has tasks associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_ADDRESSES_EXIST: {
+            message: `This client cannot be deleted because it has addresses associated`,
+        },
+        CLIENT_COULD_NOT_BE_DELETED_CONTACTS_EXIST: {
+            message: `This client cannot be deleted because it has contacts associated`,
+        },
+    },
+    FILING_CATEGORY: {
+        INVALID_REQUEST: {
+            message: 'Missing filing category id in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `Filing category with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `Filing category with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        OPTION_IN_USE: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+    },
+    STATE: {
+        INVALID_REQUEST: {
+            message: 'Missing state id in request',
+        },
+        ID_DOES_NOT_EXIST: {
+            message: `State with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        NAME_ALREADY_EXISTS: {
+            message: `State with the same name '{name}' already exists`,
+            params: ['name'],
+        },
+        STATE_TYPE_ID_DOES_NOT_EXIST: {
+            message: `State type with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        IS_PARENT_OF_OTHER_STATES: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+        PARENT_ID_DOES_NOT_EXIST: {
+            message: `Parent state with id '{id}' does not exist`,
+            params: ['id'],
+        },
+        PARENT_STATE_TYPE_NOT_ALLOWED: {
+            message: `Parent state '{parentName}' has type '{parentType}' which is not allowed parent type for state '{stateName}' with type '{stateType}'`,
+            params: ['parentName', 'parentType', 'stateName', 'stateType'],
+        },
+        OPTION_IN_USE: {
+            message: `This option is currently in use and cannot be deleted.`,
+        },
+    },
+    USER: {
+        USERNAME_DOES_NOT_EXIST: {
+            message: `User with username {username} does not exist.`,
+            params: ['username'],
+        },
+        INVALID_PASSWORD: {
+            message: `User with username {username} password does not match.`,
+            params: ['username'],
+        },
+        INVALID_RESET_PASSWORD_TOKEN: {
+            message: `Invalid or expired reset token.`,
+        },
+        RESET_PASSWORD_LINK_ALREADY_USED: {
+            message: `Reset password link has already been used. Please request a new one.`,
+        },
+        RESET_PASSWORD_LINK_NOT_LATEST: {
+            message: `Reset password link is no longer valid. Please use the most recent one.`,
+        },
+    },
+    USER_PREFERENCE: {
+        FEATURE_DOES_NOT_EXIST: {
+            message: `Feature with name {feature} does not exist`,
+            params: ['feature'],
+        },
+        INVALID_REQUEST: {
+            message: 'Request is invalid',
+        },
+        PREFERENCE_DOES_NOT_BELONG_TO_USER: {
+            message: 'Preference does not belong to the user',
+        },
+        INVALID_COLUMN_ORDER: {
+            message: 'Invalid columnOrder values',
+        },
+    },
+};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@forwardslashns/taskit-validation-messages",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "scripts": {
+    "build": "rimraf ./dist && tsc",
+    "prepublishOnly": "npm run build"
+  },
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "author": "forwardslash",
+  "license": "ISC",
+  "description": "Validation messages for Taskit and mechanism for reading these messages dynamically.",
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@types/node": "^22.9.1",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.8.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/fws-solutions/taskit-validation-messages.git"
+  },
+  "bugs": {
+    "url": "https://github.com/fws-solutions/taskit-validation-messages/issues"
+  },
+  "homepage": "https://github.com/fws-solutions/taskit-validation-messages#readme"
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+import { getValidationMessage } from "./validation/validation-message.formatter";
+import { VALIDATION_MESSAGES } from "./validation/validation-messages";
+
+export { VALIDATION_MESSAGES, getValidationMessage };

package/src/validation/validation-message.formatter.ts

@@ -0,0 +1,81 @@
+import { VALIDATION_MESSAGES } from './validation-messages';
+
+type Features = keyof typeof VALIDATION_MESSAGES;
+type ErrorType<F extends Features> = keyof (typeof VALIDATION_MESSAGES)[F];
+type ErrorMessageParams<
+  F extends Features,
+  E extends ErrorType<F>,
+> = (typeof VALIDATION_MESSAGES)[F][E] extends {
+  params: infer P extends readonly string[];
+}
+  ? P
+  : [];
+type MessageParams<T extends readonly string[]> = { [K in T[number]]: string };
+type MessageConfig = {
+  message: string;
+  params?: readonly string[];
+};
+
+export const getValidationMessage = <
+  FeatureType extends Features,
+  FeatureErrorType extends ErrorType<FeatureType>,
+>(
+  feature: FeatureType,
+  featureError: FeatureErrorType,
+  params?: MessageParams<ErrorMessageParams<FeatureType, FeatureErrorType>>
+): string => {
+  const messageConfig = VALIDATION_MESSAGES[feature][
+    featureError
+  ] as MessageConfig;
+
+  if (!messageConfig) {
+    throw new Error(
+      `Validation error message is not defined properly in configuration for feature: '${String(feature)}', error: '${String(featureError)}')`
+    );
+  }
+
+  const inputParams = params || {};
+  const errorSuffix = `for feature: ${String(feature)}, error: ${String(featureError)}`;
+  let message = messageConfig.message;
+  const expectedParams = messageConfig.params?.length
+    ? messageConfig.params
+    : [];
+
+  if (!message) {
+    throw new Error(
+      `Validation error message is not defined properly in configuration ${errorSuffix}`
+    );
+  }
+
+  if (params && !expectedParams.length) {
+    throw new Error(
+      `Validation error params are not defined properly in configuration ${errorSuffix}`
+    );
+  }
+
+  expectedParams.forEach((param) => {
+    if (!(param in inputParams)) {
+      const missingParamMessage = `Missing parameter: ${param} ${errorSuffix}`;
+      throw new Error(missingParamMessage);
+    }
+  });
+
+  const matchingParamsInsideCurlyBraces = /\{([^}]+)\}/g;
+  let match;
+  while ((match = matchingParamsInsideCurlyBraces.exec(message)) !== null) {
+    const potentialParam = match[1];
+    if (expectedParams.length && !expectedParams.includes(potentialParam)) {
+      const typoMessage = `Potential typo in parameter name: {${potentialParam}} in message ${errorSuffix}. Expected parameters: ${expectedParams.join(', ')}`;
+      throw new Error(typoMessage);
+    }
+  }
+
+  expectedParams.forEach((param) => {
+    message = message.replace(
+      `{${param}}`,
+      (inputParams as Record<string, string>)[param]
+    );
+  });
+
+  return message;
+};

package/src/validation/validation-messages.ts

@@ -0,0 +1,309 @@
+export const VALIDATION_MESSAGES = {
+  DATA_FILTER: {
+    MISSING_PAGE_SIZE: {
+      message: `Request is invalid, 'pageSize' must exist if 'pageNumber' exists`,
+    },
+    MISSING_PAGE_NUMBER: {
+      message: `Request is invalid, 'pageNumber' must exist if 'pageSize' exists`,
+    },
+    MISSING_SORT_BY: {
+      message: `Request is invalid, 'sortBy' must exist if 'sortType' exists`,
+    },
+    MISSING_SORT_TYPE: {
+      message: `Request is invalid, 'sortType' must exist if 'sortBy' exists`,
+    },
+  },
+  ACCOUNT_CATEGORY: {
+    INVALID_REQUEST: {
+      message: 'Missing account category id in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `Account category with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `Account category with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    OPTION_IN_USE: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+  },
+  ACCOUNT_ID: {
+    INVALID_REQUEST: {
+      message: 'Missing account id identifier in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `Account id with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `Account id with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    ACCOUNT_CATEGORY_ID_DOES_NOT_EXIST: {
+      message: `Account category with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    OPTION_IN_USE: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+  },
+  BUSINESS_ACTIVITY: {
+    INVALID_REQUEST: {
+      message: 'Missing business activity id in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `Business activity with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `Business activity with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    OPTION_IN_USE: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+  },
+  CLIENT: {
+    INVALID_REQUEST: {
+      message: 'Missing client id in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `Client with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    ACCOUNT_ID_DOES_NOT_EXIST: {
+      message: `Account id with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    FILING_CATEGORY_ID_DOES_NOT_EXIST: {
+      message: `Filing category with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    FILING_TYPE_ID_DOES_NOT_EXIST: {
+      message: `Filing type with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    STATE_ID_DOES_NOT_EXIST: {
+      message: `State with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    BUSINESS_ACTIVITY_ID_DOES_NOT_EXIST: {
+      message: `Business activity with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    BILLING_TYPE_ID_DOES_NOT_EXIST: {
+      message: `Billing type with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    ENTITY_TYPE_ID_DOES_NOT_EXIST: {
+      message: `Entity type with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    CLIENT_WITH_SAME_FEDERAL_LEGAL_ID_EXISTS: {
+      message: `This ID is already in use. Please enter a different ID.`,
+    },
+    INVALID_CLIENT_ACTIVITY_STATUS: {
+      message: `The 'Is active' field only applies to our clients. Please update the client type to 'Not our client' or update the 'Is active' status to 'Active'.`,
+    },
+    INVALID_FEDERAL_LEGAL_ID: {
+      message: `Enter a valid {legalIdType} (e.g. {legalIdValue})`,
+      params: ['legalIdType', 'legalIdValue'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `Client with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    NOT_ALIGNED_DATE_ESTABLISHED_ENTITY_TYPE_STARTING_DATE: {
+      message: `One or more entity types have a start date that is before the client's date established, {clientDateEstablished}. ({entityType} starting {entityTypeStartingDate}). Please update the entity type start dates to be on or after the client's date established, or update the client's date established.`,
+      params: ['clientDateEstablished', 'entityType', 'entityTypeStartingDate'],
+    },
+    NOT_ALIGNED_DATE_ESTABLISHED_FILING_TYPE_STARTING_DATE: {
+      message: `The filing type status {filingType} starts on {filingTypeStartingDate} which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the filing type status or the client's date established.`,
+      params: ['clientDateEstablished', 'filingType', 'filingTypeStartingDate'],
+    },
+    NOT_ALIGNED_DATE_ESTABLISHED_DOMESTIC_STATE_STARTING_DATE: {
+      message: `The state, {domesticState}, starts on {domesticStateStartingDate}, which is earlier than the client's date established, {clientDateEstablished}. Please adjust the start date of the state or the client's date established.`,
+      params: [
+        'clientDateEstablished',
+        'domesticState',
+        'domesticStateStartingDate',
+      ],
+    },
+    NOT_ALIGNED_DATE_ESTABLISHED_CLOSE_DATE: {
+      message: `Adjust the close date to be after the date established.`,
+    },
+    NOT_ALIGNED_CLOSE_DATE_ENTITY_TYPE_STARTING_DATE: {
+      message: `One or more entity types have start dates that are after the client's close date, {clientCloseDate}. {entityType} starting {entityTypeStartingDate}. Please update the entity type/s end date/s to be on or before the client's close date, or update the client's close date.`,
+      params: ['clientCloseDate', 'entityType', 'entityTypeStartingDate'],
+    },
+    NOT_ALIGNED_CLOSE_DATE_FILING_TYPE_STARTING_DATE: {
+      message: `One or more filing type statuses have a start date which is after the client’s close date of {clientCloseDate}. {filingType}, starting {filingTypeStartingDate}. Please update the start date to be earlier than the client’s close date, or update the client's close date.`,
+      params: ['clientCloseDate', 'filingType', 'filingTypeStartingDate'],
+    },
+    NOT_ALIGNED_CLOSE_DATE_DOMEASTIC_STATE_STARTING_DATE: {
+      message: `One or more states have a start date which is after the client's close date of {clientCloseDate}. {domesticState} starting {domesticStateStartingDate}. Please update the state/s start date/s to be before the client's close date, or update the client's close date.`,
+      params: ['clientCloseDate', 'domesticState', 'domesticStateStartingDate'],
+    },
+    ENTITY_TYPE_STARTING_DATE_NOT_POPULATED: {
+      message: `Current Entity Type Starting Date cannot be Empty`,
+    },
+    FILING_TYPE_STARTING_DATE_NOT_POPULATED: {
+      message: `Current Filing Type Starting Date cannot be Empty`,
+    },
+    DOMESTIC_STATE_STARTING_DATE_NOT_POPULATED: {
+      message: `Current Domestic State Starting Date cannot be Empty`,
+    },
+    NOT_ALIGNED_ENTITY_TYPE_STARTING_ENDING_DATE: {
+      message: `Entity type starting date needs to be before the ending date`,
+    },
+    NOT_ALIGNED_FILING_TYPE_STARTING_ENDING_DATE: {
+      message: `Filing type starting date needs to be before the ending date`,
+    },
+    NOT_ALIGNED_DOMESTIC_STATE_STARTING_ENDING_DATE: {
+      message: `Domestic state starting date needs to be before the ending date`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ACCOUNT_ID: {
+      message: `Choose an Account ID`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BUSINESS_ACTIVITY_ID: {
+      message: `Choose a Business Activity`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_BILLING_TYPE_ID: {
+      message: `Choose a Billing Type`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_FILING_CATEGORY_ID: {
+      message: `Choose a Filing Category`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_CONTACT: {
+      message: `Create a Contact - One contact needs to have been saved to this client`,
+    },
+    CLIENT_COULD_NOT_BE_LOCKED_WITHOUT_ADDRESS: {
+      message: `Create an Address - One address needs to have been saved to this client`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_CLIENT_CIRCLE_EXIST: {
+      message: `This client cannot be deleted because it has client circle associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_CLIENT_PROJECT_TEMPLATES_EXIST: {
+      message: `This client cannot be deleted because it has client project templates associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_ADDITIONAL_INFORMATION_EXIST: {
+      message: `This client cannot be deleted because it has additional information associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_BANK_ACCOUNTS_EXIST: {
+      message: `This client cannot be deleted because it has bank accounts associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_WORKLOGS_EXIST: {
+      message: `This client cannot be deleted because it has worklogs associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_INVOICES_EXIST: {
+      message: `This client cannot be deleted because it has invoices associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_PAYMENTS_EXIST: {
+      message: `This client cannot be deleted because it has payments associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_DOCUMENTS_EXIST: {
+      message: `This client cannot be deleted because it has documents associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_JOURNALS_EXIST: {
+      message: `This client cannot be deleted because it has journals associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_FUTURES_EXIST: {
+      message: `This client cannot be deleted because it has futures associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_PROJECTS_EXIST: {
+      message: `This client cannot be deleted because it has projects associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_TASKS_EXIST: {
+      message: `This client cannot be deleted because it has tasks associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_ADDRESSES_EXIST: {
+      message: `This client cannot be deleted because it has addresses associated`,
+    },
+    CLIENT_COULD_NOT_BE_DELETED_CONTACTS_EXIST: {
+      message: `This client cannot be deleted because it has contacts associated`,
+    },
+  },
+  FILING_CATEGORY: {
+    INVALID_REQUEST: {
+      message: 'Missing filing category id in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `Filing category with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `Filing category with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    OPTION_IN_USE: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+  },
+  STATE: {
+    INVALID_REQUEST: {
+      message: 'Missing state id in request',
+    },
+    ID_DOES_NOT_EXIST: {
+      message: `State with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    NAME_ALREADY_EXISTS: {
+      message: `State with the same name '{name}' already exists`,
+      params: ['name'],
+    },
+    STATE_TYPE_ID_DOES_NOT_EXIST: {
+      message: `State type with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    IS_PARENT_OF_OTHER_STATES: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+    PARENT_ID_DOES_NOT_EXIST: {
+      message: `Parent state with id '{id}' does not exist`,
+      params: ['id'],
+    },
+    PARENT_STATE_TYPE_NOT_ALLOWED: {
+      message: `Parent state '{parentName}' has type '{parentType}' which is not allowed parent type for state '{stateName}' with type '{stateType}'`,
+      params: ['parentName', 'parentType', 'stateName', 'stateType'],
+    },
+    OPTION_IN_USE: {
+      message: `This option is currently in use and cannot be deleted.`,
+    },
+  },
+  USER: {
+    USERNAME_DOES_NOT_EXIST: {
+      message: `User with username {username} does not exist.`,
+      params: ['username'],
+    },
+    INVALID_PASSWORD: {
+      message: `User with username {username} password does not match.`,
+      params: ['username'],
+    },
+    INVALID_RESET_PASSWORD_TOKEN: {
+      message: `Invalid or expired reset token.`,
+    },
+    RESET_PASSWORD_LINK_ALREADY_USED: {
+      message: `Reset password link has already been used. Please request a new one.`,
+    },
+    RESET_PASSWORD_LINK_NOT_LATEST: {
+      message: `Reset password link is no longer valid. Please use the most recent one.`,
+    },
+  },
+  USER_PREFERENCE: {
+    FEATURE_DOES_NOT_EXIST: {
+      message: `Feature with name {feature} does not exist`,
+      params: ['feature'],
+    },
+    INVALID_REQUEST: {
+      message: 'Request is invalid',
+    },
+    PREFERENCE_DOES_NOT_BELONG_TO_USER: {
+      message: 'Preference does not belong to the user',
+    },
+    INVALID_COLUMN_ORDER: {
+      message: 'Invalid columnOrder values',
+    },
+  },
+} as const;

package/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "Node16",
+    "moduleResolution": "node16",
+    "strict": true,
+    "esModuleInterop": true,
+    "declaration": true,
+    "declarationMap": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "outDir": "./dist",
+    "rootDir": "./src"
+  },
+  "include": ["src/**/*", "types/**/*"],
+  "exclude": ["node_modules"]
+}