@shopvirge/shopvirge-client 0.3.5 → 0.4.5

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/README.md CHANGED
@@ -85,22 +85,13 @@ OpenAPI.interceptors.response.use((response) => {
85
85
 
86
86
  ## Development
87
87
 
88
- ### Regenerate the client
89
-
90
- From the `packages/shopvirge-client/` directory:
88
+ This package lives in `npm/` of [virge-io/shopvirge-client](https://github.com/virge-io/shopvirge-client) and is generated from the `openapi.json` in the repository root. Run everything from `npm/` with pnpm.
91
89
 
92
90
  ```bash
93
- # From a local openapi.json file
94
- yarn openapi-ts
95
-
96
- # From the live API
97
- yarn openapi-ts-live
91
+ pnpm generate # regenerate src/api/generated from ../openapi.json
92
+ pnpm generate:live # fetch the live spec from api.shopvirge.com first, then generate + sync-version
93
+ pnpm sync-version # copy the spec's info.version into package.json
94
+ pnpm build # ESM bundle + types into dist/
98
95
  ```
99
96
 
100
- ### Sync package version
101
-
102
- After regenerating, sync the package version from the OpenAPI spec:
103
-
104
- ```bash
105
- yarn sync-version
106
- ```
97
+ Releases: merge a version bump to `main` and the publish workflow publishes it to npm. See the repository README for the full flow.