@7365admin1/module-hygiene 1.7.0
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.
- package/.changeset/README.md +8 -0
- package/.changeset/config.json +11 -0
- package/.github/workflows/main.yml +17 -0
- package/.github/workflows/publish.yml +39 -0
- package/CHANGELOG.md +110 -0
- package/PUBLISHING.md +269 -0
- package/dist/index.d.ts +549 -0
- package/dist/index.js +5703 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +5706 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +48 -0
- package/tsconfig.json +108 -0
- package/tsup.config.ts +10 -0
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
# Changesets
|
|
2
|
+
|
|
3
|
+
Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
|
|
4
|
+
with multi-package repos, or single-package repos to help you version and publish your code. You can
|
|
5
|
+
find the full documentation for it [in our repository](https://github.com/changesets/changesets)
|
|
6
|
+
|
|
7
|
+
We have a quick list of common questions to get you started engaging with this project in
|
|
8
|
+
[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
|
|
3
|
+
"changelog": "@changesets/cli/changelog",
|
|
4
|
+
"commit": false,
|
|
5
|
+
"fixed": [],
|
|
6
|
+
"linked": [],
|
|
7
|
+
"access": "public",
|
|
8
|
+
"baseBranch": "main",
|
|
9
|
+
"updateInternalDependencies": "patch",
|
|
10
|
+
"ignore": []
|
|
11
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
name: CI
|
|
2
|
+
on:
|
|
3
|
+
push:
|
|
4
|
+
branches:
|
|
5
|
+
- "**"
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
build:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
steps:
|
|
11
|
+
- uses: actions/checkout@v4
|
|
12
|
+
- uses: actions/setup-node@v4
|
|
13
|
+
with:
|
|
14
|
+
node-version: 20.x
|
|
15
|
+
cache: "yarn"
|
|
16
|
+
- run: yarn install --frozen-lockfile
|
|
17
|
+
- run: yarn lint && yarn build
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
name: Publish
|
|
2
|
+
on:
|
|
3
|
+
workflow_run:
|
|
4
|
+
workflows: [CI]
|
|
5
|
+
branches: [main]
|
|
6
|
+
types: [completed]
|
|
7
|
+
|
|
8
|
+
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
|
9
|
+
|
|
10
|
+
permissions:
|
|
11
|
+
contents: write
|
|
12
|
+
pull-requests: write
|
|
13
|
+
|
|
14
|
+
jobs:
|
|
15
|
+
publish:
|
|
16
|
+
if: ${{ github.event.workflow_run.conclusion == 'success' }}
|
|
17
|
+
runs-on: ubuntu-latest
|
|
18
|
+
steps:
|
|
19
|
+
- uses: actions/checkout@v4
|
|
20
|
+
|
|
21
|
+
- uses: actions/setup-node@v4
|
|
22
|
+
with:
|
|
23
|
+
node-version: 20.x
|
|
24
|
+
cache: "yarn" # Use yarn for caching
|
|
25
|
+
cache-dependency-path: yarn.lock # Cache Yarn lockfile
|
|
26
|
+
|
|
27
|
+
- run: yarn install --immutable # Install dependencies with immutable lockfile
|
|
28
|
+
|
|
29
|
+
- name: Create .npmrc for publishing
|
|
30
|
+
run: |
|
|
31
|
+
echo '//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}' > ~/.npmrc
|
|
32
|
+
|
|
33
|
+
- name: Create Release Pull Request or Publish
|
|
34
|
+
id: changesets
|
|
35
|
+
uses: changesets/action@v1
|
|
36
|
+
with:
|
|
37
|
+
publish: yarn release # Use yarn for publishing
|
|
38
|
+
env:
|
|
39
|
+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# @iservice365/module-hygiene
|
|
2
|
+
|
|
3
|
+
## 1.7.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- Hygiene Dashboard - Initial Release
|
|
8
|
+
|
|
9
|
+
## 1.6.0
|
|
10
|
+
|
|
11
|
+
### Minor Changes
|
|
12
|
+
|
|
13
|
+
- Hygiene Module Cleanup and Filters
|
|
14
|
+
|
|
15
|
+
## 1.5.1
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- Add supply name field in display request items
|
|
20
|
+
|
|
21
|
+
## 1.5.0
|
|
22
|
+
|
|
23
|
+
### Minor Changes
|
|
24
|
+
|
|
25
|
+
- Hygiene Schedule Task - Release
|
|
26
|
+
|
|
27
|
+
## 1.4.0
|
|
28
|
+
|
|
29
|
+
### Minor Changes
|
|
30
|
+
|
|
31
|
+
- Hygiene Schedule Task - Initial Release
|
|
32
|
+
|
|
33
|
+
## 1.3.0
|
|
34
|
+
|
|
35
|
+
### Minor Changes
|
|
36
|
+
|
|
37
|
+
- b90e31f: Update Modules - New features
|
|
38
|
+
|
|
39
|
+
### Patch Changes
|
|
40
|
+
|
|
41
|
+
- Updated dependencies [b90e31f]
|
|
42
|
+
- @iservice365/module-hygiene@1.3.0
|
|
43
|
+
|
|
44
|
+
## 1.2.0
|
|
45
|
+
|
|
46
|
+
### Minor Changes
|
|
47
|
+
|
|
48
|
+
- 1170b7a: Hygiene Request Item - Release
|
|
49
|
+
- d68da92: Hygiene Display Supply - Release
|
|
50
|
+
|
|
51
|
+
## 1.1.0
|
|
52
|
+
|
|
53
|
+
### Minor Changes
|
|
54
|
+
|
|
55
|
+
- 0f65fa2: Hygiene Supply Stock and Request Item - Initial Release
|
|
56
|
+
|
|
57
|
+
## 1.0.3
|
|
58
|
+
|
|
59
|
+
### Patch Changes
|
|
60
|
+
|
|
61
|
+
- fa485c3: Update dependencies
|
|
62
|
+
- 3ac64f5: Fix export modules
|
|
63
|
+
|
|
64
|
+
## 1.0.2
|
|
65
|
+
|
|
66
|
+
### Patch Changes
|
|
67
|
+
|
|
68
|
+
- 73be6af: Update dependencies
|
|
69
|
+
|
|
70
|
+
## 1.0.1
|
|
71
|
+
|
|
72
|
+
### Patch Changes
|
|
73
|
+
|
|
74
|
+
- e7a734b: Update dependencies
|
|
75
|
+
|
|
76
|
+
## 1.0.0
|
|
77
|
+
|
|
78
|
+
### Major Changes
|
|
79
|
+
|
|
80
|
+
- 05f4523: Initial release
|
|
81
|
+
|
|
82
|
+
## 0.2.0
|
|
83
|
+
|
|
84
|
+
### Minor Changes
|
|
85
|
+
|
|
86
|
+
- 4a9a008: Add new dependencies
|
|
87
|
+
|
|
88
|
+
## 0.1.2
|
|
89
|
+
|
|
90
|
+
### Patch Changes
|
|
91
|
+
|
|
92
|
+
- 6c38dd8: Dependencies - update
|
|
93
|
+
|
|
94
|
+
## 0.1.1
|
|
95
|
+
|
|
96
|
+
### Patch Changes
|
|
97
|
+
|
|
98
|
+
- 41083ab: Dependencies - update
|
|
99
|
+
|
|
100
|
+
## 0.1.0
|
|
101
|
+
|
|
102
|
+
### Minor Changes
|
|
103
|
+
|
|
104
|
+
- 7fe7aae: Cleaning check list - initial implementation
|
|
105
|
+
|
|
106
|
+
## 0.0.1
|
|
107
|
+
|
|
108
|
+
### Patch Changes
|
|
109
|
+
|
|
110
|
+
- e03017c: init
|
package/PUBLISHING.md
ADDED
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
# Publishing Guide
|
|
2
|
+
|
|
3
|
+
This document explains how to publish new versions of `@7365admin1/module-hygiene` to npm using changesets and GitHub Actions.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
The package uses an automated publishing workflow powered by [Changesets](https://github.com/changesets/changesets) and GitHub Actions. When you make changes and create a changeset, the workflow automatically:
|
|
8
|
+
|
|
9
|
+
1. Creates a "Version Packages" PR with version bumps
|
|
10
|
+
2. Publishes to npm when you merge that PR
|
|
11
|
+
|
|
12
|
+
## Quick Start
|
|
13
|
+
|
|
14
|
+
### 1. Make Your Changes
|
|
15
|
+
|
|
16
|
+
Make your code changes in a new branch as usual.
|
|
17
|
+
|
|
18
|
+
### 2. Create a Changeset
|
|
19
|
+
|
|
20
|
+
Before committing, create a changeset to document your changes:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
npx changeset
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
You'll be prompted to:
|
|
27
|
+
- Select the type of change: `patch`, `minor`, or `major`
|
|
28
|
+
- Write a summary of your changes
|
|
29
|
+
|
|
30
|
+
This creates a `.changeset/[random-name].md` file.
|
|
31
|
+
|
|
32
|
+
### 3. Commit and Push
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
git add .
|
|
36
|
+
git commit -m "feat: your feature description"
|
|
37
|
+
git push
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
### 4. Create a Pull Request
|
|
41
|
+
|
|
42
|
+
Create a PR to merge your branch into `main`.
|
|
43
|
+
|
|
44
|
+
### 5. Merge Your PR
|
|
45
|
+
|
|
46
|
+
Once approved, merge your PR to `main`.
|
|
47
|
+
|
|
48
|
+
### 6. Bot Creates Version PR (Automatic)
|
|
49
|
+
|
|
50
|
+
After merging, the GitHub Actions bot will automatically:
|
|
51
|
+
- Detect your changeset
|
|
52
|
+
- Create a new PR titled "Version Packages"
|
|
53
|
+
- Update `package.json` with the new version
|
|
54
|
+
- Update `CHANGELOG.md`
|
|
55
|
+
- Remove the changeset file
|
|
56
|
+
|
|
57
|
+
### 7. Merge the Version PR
|
|
58
|
+
|
|
59
|
+
Review and merge the "Version Packages" PR. This will:
|
|
60
|
+
- Bump the version in `package.json`
|
|
61
|
+
- Automatically publish to npm 🚀
|
|
62
|
+
|
|
63
|
+
## Workflow Diagram
|
|
64
|
+
|
|
65
|
+
```
|
|
66
|
+
You: Make changes + create changeset
|
|
67
|
+
↓
|
|
68
|
+
You: Push and create PR
|
|
69
|
+
↓
|
|
70
|
+
You: Merge PR to main
|
|
71
|
+
↓
|
|
72
|
+
Bot: Creates "Version Packages" PR (automatic)
|
|
73
|
+
↓
|
|
74
|
+
You: Merge "Version Packages" PR
|
|
75
|
+
↓
|
|
76
|
+
Bot: Publishes to npm (automatic)
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
## Version Types
|
|
80
|
+
|
|
81
|
+
When creating a changeset, you'll choose a version bump type:
|
|
82
|
+
|
|
83
|
+
- **patch** (1.7.0 → 1.7.1): Bug fixes, minor changes
|
|
84
|
+
- **minor** (1.7.0 → 1.8.0): New features, backward compatible
|
|
85
|
+
- **major** (1.7.0 → 2.0.0): Breaking changes
|
|
86
|
+
|
|
87
|
+
## Common Commands
|
|
88
|
+
|
|
89
|
+
### Create a Changeset
|
|
90
|
+
```bash
|
|
91
|
+
npx changeset
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Create an Empty Changeset
|
|
95
|
+
```bash
|
|
96
|
+
npx changeset add --empty
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
### Check Which Packages Would Be Published
|
|
100
|
+
```bash
|
|
101
|
+
npx changeset status
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### Manually Version (Local Testing Only)
|
|
105
|
+
```bash
|
|
106
|
+
npx changeset version
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Manually Publish (Not Recommended)
|
|
110
|
+
```bash
|
|
111
|
+
yarn run release
|
|
112
|
+
```
|
|
113
|
+
> ⚠️ **Note**: Manual publishing requires 2FA or an automation token. Use GitHub Actions instead.
|
|
114
|
+
|
|
115
|
+
## GitHub Setup
|
|
116
|
+
|
|
117
|
+
### Required Secrets
|
|
118
|
+
|
|
119
|
+
The repository needs the following GitHub secret:
|
|
120
|
+
|
|
121
|
+
**`NPM_TOKEN`**
|
|
122
|
+
- Location: Settings → Secrets and variables → Actions
|
|
123
|
+
- Type: Granular Access Token (Automation)
|
|
124
|
+
- Value: Your npm automation token
|
|
125
|
+
- Permissions: Read and Write for packages, with 2FA bypass enabled
|
|
126
|
+
|
|
127
|
+
### Workflow Files
|
|
128
|
+
|
|
129
|
+
- `.github/workflows/main.yml` - CI workflow (builds and tests)
|
|
130
|
+
- `.github/workflows/publish.yml` - Publish workflow (creates PRs and publishes)
|
|
131
|
+
|
|
132
|
+
## Configuration Files
|
|
133
|
+
|
|
134
|
+
### `.changeset/config.json`
|
|
135
|
+
|
|
136
|
+
```json
|
|
137
|
+
{
|
|
138
|
+
"$schema": "https://unpkg.com/@changesets/config@2.3.0/schema.json",
|
|
139
|
+
"changelog": "@changesets/cli/changelog",
|
|
140
|
+
"commit": false,
|
|
141
|
+
"access": "public",
|
|
142
|
+
"baseBranch": "main"
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
Key settings:
|
|
147
|
+
- `"access": "public"` - Package is published as public (free)
|
|
148
|
+
- `"baseBranch": "main"` - PRs are created against main
|
|
149
|
+
|
|
150
|
+
### `package.json`
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"name": "@7365admin1/module-hygiene",
|
|
155
|
+
"version": "1.7.0",
|
|
156
|
+
"author": "7365admin1",
|
|
157
|
+
"publishConfig": {
|
|
158
|
+
"access": "public"
|
|
159
|
+
}
|
|
160
|
+
}
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Key settings:
|
|
164
|
+
- `"publishConfig.access": "public"` - Ensures scoped package is public
|
|
165
|
+
|
|
166
|
+
## Troubleshooting
|
|
167
|
+
|
|
168
|
+
### "Version didn't update on npm"
|
|
169
|
+
|
|
170
|
+
**Solution**: Make sure you merged the bot's "Version Packages" PR. The version only publishes after merging that PR, not your original PR.
|
|
171
|
+
|
|
172
|
+
### "No Version Packages PR was created"
|
|
173
|
+
|
|
174
|
+
**Possible causes**:
|
|
175
|
+
1. No changeset file was committed
|
|
176
|
+
2. CI workflow failed
|
|
177
|
+
3. Check GitHub Actions logs for errors
|
|
178
|
+
|
|
179
|
+
**Solution**: Run `npx changeset status` locally to verify changesets exist.
|
|
180
|
+
|
|
181
|
+
### "402 Payment Required" Error
|
|
182
|
+
|
|
183
|
+
**Cause**: Scoped packages (`@username/package`) are private by default and require payment.
|
|
184
|
+
|
|
185
|
+
**Solution**: Ensure `publishConfig.access` is set to `"public"` in `package.json`.
|
|
186
|
+
|
|
187
|
+
### "403 Forbidden" or "401 Unauthorized"
|
|
188
|
+
|
|
189
|
+
**Cause**: Invalid or expired npm token.
|
|
190
|
+
|
|
191
|
+
**Solution**:
|
|
192
|
+
1. Generate a new Granular Access Token (Automation type) on npmjs.com
|
|
193
|
+
2. Update the `NPM_TOKEN` secret in GitHub
|
|
194
|
+
3. Ensure token has "Bypass 2FA" enabled
|
|
195
|
+
|
|
196
|
+
### "Changeset not found" Error
|
|
197
|
+
|
|
198
|
+
**Cause**: Changeset file wasn't committed or was deleted.
|
|
199
|
+
|
|
200
|
+
**Solution**: Run `npx changeset` again and commit the generated `.changeset/*.md` file.
|
|
201
|
+
|
|
202
|
+
## Best Practices
|
|
203
|
+
|
|
204
|
+
### 1. Always Create Changesets
|
|
205
|
+
|
|
206
|
+
Never merge code changes without a changeset. It ensures:
|
|
207
|
+
- Version tracking
|
|
208
|
+
- Changelog updates
|
|
209
|
+
- Proper npm publishing
|
|
210
|
+
|
|
211
|
+
### 2. Write Clear Changeset Summaries
|
|
212
|
+
|
|
213
|
+
Your changeset summary becomes the changelog entry. Make it:
|
|
214
|
+
- Clear and concise
|
|
215
|
+
- User-focused (what changed, not how)
|
|
216
|
+
- Action-oriented (e.g., "Added X feature" not "Adding X feature")
|
|
217
|
+
|
|
218
|
+
### 3. Don't Skip the Version PR
|
|
219
|
+
|
|
220
|
+
Always review and merge the "Version Packages" PR. It shows exactly what will be published.
|
|
221
|
+
|
|
222
|
+
### 4. Use Yarn for Local Development
|
|
223
|
+
|
|
224
|
+
The project uses Yarn for dependency management:
|
|
225
|
+
|
|
226
|
+
```bash
|
|
227
|
+
yarn install
|
|
228
|
+
yarn build
|
|
229
|
+
yarn lint
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### 5. Keep `.npmrc` Private
|
|
233
|
+
|
|
234
|
+
The `.npmrc` file contains your authentication token. It's in `.gitignore` - **never commit it!**
|
|
235
|
+
|
|
236
|
+
## Security
|
|
237
|
+
|
|
238
|
+
### npm Authentication
|
|
239
|
+
|
|
240
|
+
- **GitHub Actions**: Uses `NPM_TOKEN` secret (automation token)
|
|
241
|
+
- **Local Publishing**: Uses `.npmrc` file (not committed to git)
|
|
242
|
+
|
|
243
|
+
### Token Types
|
|
244
|
+
|
|
245
|
+
- **Automation tokens**: Bypass 2FA, designed for CI/CD
|
|
246
|
+
- **Publish tokens**: Require 2FA, for manual publishing
|
|
247
|
+
|
|
248
|
+
Always use automation tokens for GitHub Actions.
|
|
249
|
+
|
|
250
|
+
## Package Information
|
|
251
|
+
|
|
252
|
+
- **Name**: `@7365admin1/module-hygiene`
|
|
253
|
+
- **Registry**: https://registry.npmjs.org/
|
|
254
|
+
- **Package Page**: https://www.npmjs.com/package/@7365admin1/module-hygiene
|
|
255
|
+
- **Author**: 7365admin1
|
|
256
|
+
- **License**: MIT
|
|
257
|
+
|
|
258
|
+
## Need Help?
|
|
259
|
+
|
|
260
|
+
If you encounter issues:
|
|
261
|
+
|
|
262
|
+
1. Check the [Changesets documentation](https://github.com/changesets/changesets)
|
|
263
|
+
2. Review GitHub Actions workflow logs
|
|
264
|
+
3. Verify npm token is valid and has correct permissions
|
|
265
|
+
4. Ensure `.changeset/config.json` has `"access": "public"`
|
|
266
|
+
|
|
267
|
+
---
|
|
268
|
+
|
|
269
|
+
**Last Updated**: January 2026
|