@workwell-global/toolkit

Shared utilities, types, and helpers for Workwell Global projects.

📖 Documentation

For complete documentation, please see the docs folder:

• Quick Start Guide - Complete publishing and usage instructions
• Next.js Troubleshooting - Comprehensive solutions for Next.js projects
• Consuming Project Setup - General setup guide for any TypeScript project
• Publishing Checklist - Step-by-step publishing guide

Quick Install

npm install @workwell-global/toolkit

Quick Usage

// Import types from specific modules
import type { TEvent } from '@workwell-global/toolkit/models/event'
import type { TNotificationRequest } from '@workwell-global/toolkit/models/notification'
import type { IAccount } from '@workwell-global/toolkit/models/objects'

// Import enums
import { RBACPermissions, Regions } from '@workwell-global/toolkit/enums'

// Import utilities
import { formatDate } from '@workwell-global/toolkit/utils/date-and-time'
import { encodeString } from '@workwell-global/toolkit/utils/encoding'

Available Subpath Exports

• @workwell-global/toolkit/enums
• @workwell-global/toolkit/models/crm-dynamics
• @workwell-global/toolkit/models/event
• @workwell-global/toolkit/models/integration-auth0
• @workwell-global/toolkit/models/notification
• @workwell-global/toolkit/models/objects
• @workwell-global/toolkit/models/types
• @workwell-global/toolkit/models/user-settings
• @workwell-global/toolkit/utils
• @workwell-global/toolkit/utils/date-and-time
• @workwell-global/toolkit/utils/encoding
• @workwell-global/toolkit/utils/strings

🚀 Getting Started

See docs/QUICK-START.md for complete instructions.

🔧 Troubleshooting

Having issues? Check:

1. Next.js Troubleshooting Guide - For Next.js specific issues
2. Consuming Project Setup - For general TypeScript setup

📦 Publishing

See docs/PUBLISHING-CHECKLIST.md for the complete publishing process.

IMPLEMENTATION PROGRESS - API

app/api/jove/webhook uses utils/strings/santitize: sanitizeFileName app/api/veriff/webhook uses utils/strings/manipulation: wordsToTitleCase

app/mappings/contactMapper uses models/objects: IContact # models/crm-dynamics: IContact

app/mappings/userPermissionsMapper.ts uses enums/LinkedRoles: Status

IMPLEMENTATION PROGRESS - SERVICES

app/mappings/webPortalLoginMapper.ts uses

• models/crm-dynamics: I365WebPortalLogin
• models/objects: IWebPortalLogin

app/mappings/bankAccountMapper.ts uses

• models/crm-dynamics: I365WebBackAccount
• models/objects: IBankAccount

uses models/objects/ uses models/objects/ uses models/objects/ uses models/objects/