@matech/thebigpos-sdk 3.22.0-pr-5850-7345 → 3.23.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/.husky/pre-commit +3 -0
- package/README.md +0 -39
- package/dist/index.d.ts +630 -521
- package/dist/index.js +74 -8
- package/dist/index.js.map +1 -1
- package/index.js +1 -1
- package/package.json +10 -24
- package/scripts/apply-json-patch-content-type.js +56 -0
- package/src/index.ts +173 -11
- package/tsconfig.json +27 -0
- package/dist/index.cjs +0 -6453
- package/dist/index.cjs.map +0 -7
package/README.md
CHANGED
|
@@ -40,44 +40,5 @@ apiClient.api.getSiteConfiguration().then((response) => {
|
|
|
40
40
|
});
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
## Generate SDK from Swagger
|
|
44
|
-
|
|
45
|
-
To regenerate the SDK from a specific API version, run:
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/{version}/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --enum-style union
|
|
49
|
-
```
|
|
50
|
-
|
|
51
|
-
Replace `{version}` with the target API version (e.g. `v2.34.0`):
|
|
52
|
-
|
|
53
|
-
```bash
|
|
54
|
-
npx swagger-typescript-api generate -p https://api.thebigpos.dev/swagger/v2.34.0/swagger.json -o ./src -n index.ts -r true --axios --enum-names-as-values --enum-style union
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
Then apply the PATCH content-type fixup, passing the **same** spec that was given
|
|
58
|
-
to the generator. The generator does not propagate `application/json-patch+json`,
|
|
59
|
-
so this step sets each PATCH method's content type from the spec (no hard-coded
|
|
60
|
-
endpoint list):
|
|
61
|
-
|
|
62
|
-
```bash
|
|
63
|
-
node scripts/apply-json-patch-content-type.js https://api.thebigpos.dev/swagger/v2.34.0/swagger.json
|
|
64
|
-
yarn build
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
## Publishing
|
|
68
|
-
|
|
69
|
-
1. Update the `version` field in `package.json` before publishing.
|
|
70
|
-
2. Build the project:
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
yarn build
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
3. Publish to npm:
|
|
77
|
-
|
|
78
|
-
```bash
|
|
79
|
-
yarn publish
|
|
80
|
-
```
|
|
81
|
-
|
|
82
43
|
____
|
|
83
44
|
© 2024 Mortgage Automation Technologies. All rights reserved
|