@bharatbxhipment/xhipment-models-v2 1.0.0 → 1.0.4

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 +39 -1
  2. package/package.json +17 -5
package/README.md CHANGED
@@ -1 +1,39 @@
1
- # xhipment-models-v2
1
+ # @bharatbxhipment/xhipment-models-v2
2
+
3
+ Mongoose schemas and TypeScript types for Xhipment application.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @bharatbxhipment/xhipment-models-v2
9
+ ```
10
+
11
+
12
+ ## Features
13
+
14
+ - ✅ Full TypeScript support with `.d.ts` files
15
+ - ✅ Mongoose schemas ready to use
16
+ - ✅ Type-safe interfaces
17
+ - ✅ Source maps for debugging
18
+ - ✅ Automatic publishing via GitHub Actions
19
+
20
+ ## Requirements
21
+
22
+ - Node.js >= 14
23
+ - mongoose >= 8.0.0
24
+
25
+ ## Development
26
+
27
+ ### Build
28
+ ```bash
29
+ npm run build
30
+ ```
31
+
32
+ ### Publish
33
+ The package automatically publishes to npm when:
34
+ - Version changes in `package.json` and pushed to `main` branch
35
+ - Manually triggered via GitHub Actions
36
+
37
+ ## License
38
+
39
+ ISC
package/package.json CHANGED
@@ -1,21 +1,33 @@
1
1
  {
2
2
  "name": "@bharatbxhipment/xhipment-models-v2",
3
- "version": "1.0.0",
3
+ "version": "1.0.4",
4
4
  "description": "Mongoose schemas and TypeScript types for Xhipment application",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
7
- "files": ["dist"],
7
+ "files": [
8
+ "dist"
9
+ ],
8
10
  "scripts": {
9
11
  "test": "echo \"Error: no test specified\" && exit 1",
10
12
  "build": "tsc",
11
- "prepublishOnly": "npm run build"
13
+ "prepublishOnly": "npm run build",
14
+ "version:patch": "npm version patch -m 'chore: bump version to %s' && git push --follow-tags",
15
+ "version:minor": "npm version minor -m 'chore: bump version to %s' && git push --follow-tags",
16
+ "version:major": "npm version major -m 'chore: bump version to %s' && git push --follow-tags",
17
+ "release": "npm run build && npm run version:patch"
12
18
  },
13
- "keywords": ["mongoose", "schemas", "typescript", "xhipment", "models"],
19
+ "keywords": [
20
+ "mongoose",
21
+ "schemas",
22
+ "typescript",
23
+ "xhipment",
24
+ "models"
25
+ ],
14
26
  "author": "",
15
27
  "license": "ISC",
16
28
  "repository": {
17
29
  "type": "git",
18
- "url": "https://github.com/your-username/xhipment-models-v2.git"
30
+ "url": "https://github.com/Xhipment/xhipment-models-v2.git"
19
31
  },
20
32
  "devDependencies": {
21
33
  "typescript": "^5.9.3"