@workwell-global/toolkit 1.0.6 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +46 -49
  2. package/package.json +66 -13
package/README.md CHANGED
@@ -1,67 +1,64 @@
1
- # Introduction
2
- TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
1
+ # @workwell-global/toolkit
3
2
 
4
- # Getting Started
5
- TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
6
- 1. Installation process
7
- 2. Software dependencies
8
- 3. Latest releases
9
- 4. API references
3
+ Shared utilities, types, and helpers for Workwell Global projects.
10
4
 
11
- # Build and Test
5
+ ## 📖 Documentation
12
6
 
13
- ## Publishing a New Version
7
+ For complete documentation, please see the [docs](./docs) folder:
14
8
 
15
- Before publishing, ensure you're logged into npm:
16
- ```bash
17
- npm login
18
- ```
9
+ - **[Quick Start Guide](./docs/QUICK-START.md)** - Complete publishing and usage instructions
10
+ - **[Next.js Troubleshooting](./docs/NEXTJS-TROUBLESHOOTING.md)** - Comprehensive solutions for Next.js projects
11
+ - **[Consuming Project Setup](./docs/CONSUMING-PROJECT-SETUP.md)** - General setup guide for any TypeScript project
12
+ - **[Publishing Checklist](./docs/PUBLISHING-CHECKLIST.md)** - Step-by-step publishing guide
19
13
 
20
- Then follow these steps to publish:
14
+ ## Quick Install
21
15
 
22
- 1. **Commit your changes** (required before version bump):
23
16
  ```bash
24
- git add .
25
- git commit -m "Your commit message describing changes"
17
+ npm install @workwell-global/toolkit
26
18
  ```
27
19
 
28
- 2. **Rebuild and publish the package**:
29
- ```bash
30
- npm run build
31
- npm version patch # or 'minor' or 'major'
32
- npm publish
33
- ```
20
+ ## Quick Usage
34
21
 
35
- 3. **Push changes and tags to git**:
36
- ```bash
37
- git push && git push --tags
38
- ```
22
+ ```typescript
23
+ // Import types from specific modules
24
+ import type { TEvent } from '@workwell-global/toolkit/models/event'
25
+ import type { TNotificationRequest } from '@workwell-global/toolkit/models/notification'
26
+ import type { IAccount } from '@workwell-global/toolkit/models/objects'
39
27
 
40
- ## Using in Your Project
28
+ // Import enums
29
+ import { RBACPermissions, Regions } from '@workwell-global/toolkit/enums'
41
30
 
42
- In your consuming project, update the package:
43
- ```bash
44
- npm update @workwell-global/toolkit
45
- # or install specific version
46
- npm install @workwell-global/toolkit@latest
31
+ // Import utilities
32
+ import { formatDate } from '@workwell-global/toolkit/utils/date-and-time'
33
+ import { encodeString } from '@workwell-global/toolkit/utils/encoding'
47
34
  ```
48
35
 
49
- ### Troubleshooting
36
+ ## Available Subpath Exports
50
37
 
51
- **If npm publish fails with "Access token expired":**
52
- ```bash
53
- npm logout
54
- npm login
55
- npm publish
56
- ```
38
+ - `@workwell-global/toolkit/enums`
39
+ - `@workwell-global/toolkit/models/crm-dynamics`
40
+ - `@workwell-global/toolkit/models/event`
41
+ - `@workwell-global/toolkit/models/integration-auth0`
42
+ - `@workwell-global/toolkit/models/notification`
43
+ - `@workwell-global/toolkit/models/objects`
44
+ - `@workwell-global/toolkit/models/types`
45
+ - `@workwell-global/toolkit/models/user-settings`
46
+ - `@workwell-global/toolkit/utils`
47
+ - `@workwell-global/toolkit/utils/date-and-time`
48
+ - `@workwell-global/toolkit/utils/encoding`
49
+ - `@workwell-global/toolkit/utils/strings`
50
+
51
+ ## 🚀 Getting Started
52
+
53
+ See [docs/QUICK-START.md](./docs/QUICK-START.md) for complete instructions.
54
+
55
+ ## 🔧 Troubleshooting
56
+
57
+ Having issues? Check:
58
+ 1. **[Next.js Troubleshooting Guide](./docs/NEXTJS-TROUBLESHOOTING.md)** - For Next.js specific issues
59
+ 2. **[Consuming Project Setup](./docs/CONSUMING-PROJECT-SETUP.md)** - For general TypeScript setup
57
60
 
58
- **If npm version fails with "Git working directory not clean":**
59
- Commit your changes first before running `npm version patch`
61
+ ## 📦 Publishing
60
62
 
61
- # Contribute
62
- TODO: Explain how other users and developers can contribute to make your code better.
63
+ See [docs/PUBLISHING-CHECKLIST.md](./docs/PUBLISHING-CHECKLIST.md) for the complete publishing process.
63
64
 
64
- If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
65
- - [ASP.NET Core](https://github.com/aspnet/Home)
66
- - [Visual Studio Code](https://github.com/Microsoft/vscode)
67
- - [Chakra Core](https://github.com/Microsoft/ChakraCore)
package/package.json CHANGED
@@ -1,17 +1,71 @@
1
1
  {
2
- "name": "@workwell-global/toolkit",
3
- "version": "1.0.6",
2
+ "author": "",
4
3
  "description": "Shared utilities and helpers for Workwell Global",
4
+ "keywords": [],
5
+ "license": "MIT",
5
6
  "main": "dist/index.js",
7
+ "name": "@workwell-global/toolkit",
8
+ "type": "module",
6
9
  "types": "dist/index.d.ts",
7
- "scripts": {
8
- "build": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
9
- "prepare": "npm run build"
10
+ "version": "1.0.9",
11
+ "files": [
12
+ "dist"
13
+ ],
14
+ "publishConfig": {
15
+ "access": "public",
16
+ "registry": "https://registry.npmjs.org/"
17
+ },
18
+ "typesVersions": {
19
+ "*": {
20
+ "*": [
21
+ "./dist/index.d.ts"
22
+ ],
23
+ "enums": [
24
+ "./dist/enums/index.d.ts"
25
+ ],
26
+ "models/crm-dynamics": [
27
+ "./dist/models/crm-dynamics/index.d.ts"
28
+ ],
29
+ "models/event": [
30
+ "./dist/models/event/index.d.ts"
31
+ ],
32
+ "models/integration-auth0": [
33
+ "./dist/models/integration-auth0/index.d.ts"
34
+ ],
35
+ "models/notification": [
36
+ "./dist/models/notification/index.d.ts"
37
+ ],
38
+ "models/objects": [
39
+ "./dist/models/objects/index.d.ts"
40
+ ],
41
+ "models/types": [
42
+ "./dist/models/types/index.d.ts"
43
+ ],
44
+ "models/user-settings": [
45
+ "./dist/models/user-settings/index.d.ts"
46
+ ],
47
+ "utils": [
48
+ "./dist/utils/index.d.ts"
49
+ ],
50
+ "utils/date-and-time": [
51
+ "./dist/utils/date-and-time/index.d.ts"
52
+ ],
53
+ "utils/encoding": [
54
+ "./dist/utils/encoding/index.d.ts"
55
+ ],
56
+ "utils/strings": [
57
+ "./dist/utils/strings/index.d.ts"
58
+ ]
59
+ }
10
60
  },
11
61
  "repository": {
12
62
  "type": "git",
13
63
  "url": "https://jsaservices@dev.azure.com/jsaservices/Workwell%20Global%20-%20package%20-%20toolkit/_git/Workwell%20Global%20-%20package%20-%20toolkit"
14
64
  },
65
+ "scripts": {
66
+ "build": "tsc -p tsconfig.json && tsc-alias -p tsconfig.json",
67
+ "prepare": "npm run build"
68
+ },
15
69
  "exports": {
16
70
  ".": {
17
71
  "types": "./dist/index.d.ts",
@@ -91,18 +145,17 @@
91
145
  "import": "./dist/utils/strings/index.js",
92
146
  "require": "./dist/utils/strings/index.js",
93
147
  "default": "./dist/utils/strings/index.js"
148
+ },
149
+ "./*": {
150
+ "types": "./dist/*.d.ts",
151
+ "import": "./dist/*.js",
152
+ "require": "./dist/*.js",
153
+ "default": "./dist/*.js"
94
154
  }
95
155
  },
96
- "keywords": [],
97
- "author": "",
98
- "license": "ISC",
99
- "type": "module",
100
- "files": [
101
- "dist"
102
- ],
103
156
  "dependencies": {
104
157
  "crypto-js": "^4.2.0",
105
- "zod": "^3.22.2"
158
+ "zod": "^3.23.8"
106
159
  },
107
160
  "devDependencies": {
108
161
  "@types/crypto-js": "^4.2.2",