Skip to content

Commit 07f1a77

Browse files
mettekoumettekou
committed
feat(#2056)!: support Pinia Colada
Work in progress.
1 parent 5dc47e0 commit 07f1a77

16 files changed

+3155
-0
lines changed

‎packages/openapi-pinia-colada/.npmignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.turbo
2+
test
3+
vitest.config.ts
4+
tsconfig*.json
5+
biome.json

‎packages/openapi-pinia-colada/CHANGELOG.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# openapi-pinia-colada
2+
3+
## 0.0.1
4+
5+
### Patch Changes
6+
7+
- [#](https://github.com/openapi-ts/openapi-typescript/pull/) [``](https://github.com/openapi-ts/openapi-typescript/commit/335530c4f8f966d0154f19504585c462f5f5a409) Thanks [@mettekou](https://github.com/mettekou)! - Initial release

‎packages/openapi-pinia-colada/CONTRIBUTING.md

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing
2+
3+
Thanks for being willing to contribute! 🙏
4+
5+
**Working on your first Pull Request (PR)?** You can learn how from this free series [How to Contribute to an Open Source Project on GitHub](https://app.egghead.io/playlists/how-to-contribute-to-an-open-source-project-on-github).
6+
7+
## Open issues
8+
9+
Please check out the [the open issues](https://github.com/openapi-ts/openapi-typescript/issues). Issues labelled [**Good First Issue**](https://github.com/openapi-ts/openapi-typescript/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) are especially good to start with.
10+
11+
Contributing doesn’t have to be in code. Simply answering questions in open issues or providing workarounds is as important as making pull requests.
12+
13+
## Writing code
14+
15+
### Setup
16+
17+
1. Install [pnpm](https://pnpm.io/)
18+
2. [Fork this repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo) and clone your copy locally
19+
3. Run `pnpm i` to install dependencies
20+
21+
### Testing
22+
23+
This library uses [Vitest](https://vitest.dev/) for testing. There’s a great [VS Code extension](https://marketplace.visualstudio.com/items?itemName=ZixuanChen.vitest-explorer) you can optionally use if you’d like in-editor debugging tools.
24+
25+
To run the entire test suite, run:
26+
27+
```bash
28+
pnpm test
29+
```
30+
31+
To run an individual test:
32+
33+
```bash
34+
pnpm test -- [partial filename]
35+
```
36+
37+
To start the entire test suite in watch mode:
38+
39+
```bash
40+
npx vitest
41+
```
42+
43+
#### TypeScript tests
44+
45+
**Don’t neglect writing TS tests!** In the test suite, you’ll see `// @ts-expect-error` comments. These are critical tests in and of themselves—they are asserting that TypeScript throws an error when it should be throwing an error (the test suite will actually fail in places if a TS error is _not_ raised).
46+
47+
As this is just a minimal fetch wrapper meant to provide deep type inference for API schemas, **testing TS types** is arguably more important than testing the runtime. So please make liberal use of `// @ts-expect-error`, and as a general rule of thumb, write more **unwanted** output tests than _wanted_ output tests.
48+
49+
### Running linting
50+
51+
Linting is handled via [Biome](https://biomejs.dev), a faster ESLint replacement. It was installed with `pnpm i` and can be run with:
52+
53+
```bash
54+
pnpm run lint
55+
```
56+
57+
### Changelogs
58+
59+
The changelog is generated via [changesets](https://github.com/changesets/changesets), and is separate from Git commit messages and pull request titles. To write a human-readable changelog for your changes, run:
60+
61+
```
62+
npx changeset
63+
```
64+
65+
This will ask if it’s a `patch`, `minor`, or `major` change ([semver](https://semver.org/)), along with a plain description of what you did. Commit this new file along with the rest of your PR, and during the next release this will go into the official changelog!
66+
67+
## Opening a Pull Request
68+
69+
Pull requests are **welcome** for this repo!
70+
71+
Bugfixes will always be accepted, though in some cases some small changes may be requested.
72+
73+
However, if adding a feature or breaking change, please **open an issue first to discuss.** This ensures no time or work is wasted writing code that won’t be accepted to the project (see [Project Goals](https://openapi-ts.dev/openapi-fetch/about/#project-goals)). Undiscussed feature work may be rejected at the discretion of the maintainers.
74+
75+
### Writing the commit
76+
77+
Create a new branch for your PR with `git checkout -b your-branch-name`. Add the relevant code as well as docs and tests. When you push everything up (`git push`), navigate back to your repo in GitHub and you should see a prompt to open a new PR.
78+
79+
While best practices for commit messages are encouraged (e.g. start with an imperative verb, keep it short, use the body if needed), this repo doesn’t follow any specific guidelines. Clarity is favored over strict rules. Changelogs are generated separately from git (see [the Changelogs section](#changelogs)).
80+
81+
### Writing the PR notes
82+
83+
**Please fill out the template!** It’s a very lightweight template 🙂.
84+
85+
### Adding docs
86+
87+
If you added a feature, or changed how something worked, please [update the docs](../../docs/)!
88+
89+
### Passing CI
90+
91+
All PRs must fix lint errors, and all tests must pass. PRs will not be merged until all CI checks are “green” (✅).

‎packages/openapi-pinia-colada/LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2024 Dylan Meysmans
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎packages/openapi-pinia-colada/README.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# openapi-pinia-colada
2+
3+
openapi-pinia-colada is a type-safe tiny wrapper (1 kb) around [`@pinia/colada`](https://pinia-colada.esm.dev/) to work with OpenAPI schema.
4+
5+
It works by using [`openapi-fetch`](../openapi-fetch) and [`openapi-typescript`](../openapi-typescript) so you get all the following features:
6+
7+
- ✅ No typos in URLs or params.
8+
- ✅ All parameters, request bodies, and responses are type-checked and 100% match your schema
9+
- ✅ No manual typing of your API
10+
- ✅ Eliminates `any` types that hide bugs
11+
- ✅ Eliminates `as` type overrides that can also hide bugs
12+
13+
## Setup
14+
15+
Install this library along with [`openapi-fetch`](../openapi-fetch) and [`openapi-typescript`](../openapi-typescript):
16+
17+
```bash
18+
npm i openapi-pinia-colada openapi-fetch
19+
npm i -D openapi-typescript typescript
20+
```
21+
22+
Next, generate TypeScript types from your OpenAPI schema using openapi-typescript:
23+
24+
```bash
25+
npx openapi-typescript ./path/to/api/v1.yaml -o ./src/lib/api/v1.d.ts
26+
```
27+
28+
## Usage
29+
30+
Once your types have been generated from your schema, you can create a [fetch client](../openapi-fetch), a Pinia Colada client and start querying your API.
31+
32+
```vue
33+
<script lang="ts" setup>
34+
import createFetchClient from "openapi-fetch";
35+
import createClient from "openapi-pinia-colada";
36+
import type { paths } from "./my-openapi-3-schema"; // generated by openapi-typescript
37+
38+
const fetchClient = createFetchClient<paths>({
39+
baseUrl: "https://myapi.dev/v1/",
40+
});
41+
const $api = createClient(fetchClient);
42+
43+
const { data, error, isPending } = $api.useQuery(
44+
"get",
45+
"/blogposts/{post_id}",
46+
{
47+
params: {
48+
path: { post_id: 5 },
49+
},
50+
}
51+
);
52+
</script>
53+
54+
<template>
55+
<div v-if="isPending || !data">Loading...</div>
56+
<div v-else-if="error">{{`An error occurred: ${error.message}`}}</div>
57+
<div v-else>{{data.title}}</div>
58+
</template>
59+
```
60+
61+
> You can find more information about `createFetchClient` in the [openapi-fetch documentation](../openapi-fetch).
62+
63+
## 📓 Docs
64+
65+
[View Docs](https://openapi-ts.dev/openapi-pinia-colada/)

‎packages/openapi-pinia-colada/biome.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
3+
"extends": ["../../biome.json"],
4+
"files": {
5+
"ignore": ["./test/fixtures/"]
6+
},
7+
"linter": {
8+
"rules": {
9+
"complexity": {
10+
"noBannedTypes": "off"
11+
},
12+
"suspicious": {
13+
"noConfusingVoidType": "off"
14+
}
15+
}
16+
}
17+
}

‎packages/openapi-pinia-colada/package.json

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
{
2+
"name": "openapi-pinia-colada",
3+
"description": "Fast, type-safe @pinia/colada client to work with your OpenAPI schema.",
4+
"version": "0.0.1",
5+
"author": {
6+
"name": "Dylan Meysmans",
7+
"email": "[email protected]"
8+
},
9+
"license": "MIT",
10+
"type": "module",
11+
"main": "./dist/index.js",
12+
"module": "./dist/index.js",
13+
"types": "./dist/index.d.ts",
14+
"exports": {
15+
".": {
16+
"import": {
17+
"types": "./dist/index.d.ts",
18+
"default": "./dist/index.js"
19+
},
20+
"require": {
21+
"types": "./dist/index.d.cts",
22+
"default": "./dist/index.cjs"
23+
}
24+
},
25+
"./*": "./*"
26+
},
27+
"homepage": "https://openapi-ts.dev",
28+
"repository": {
29+
"type": "git",
30+
"url": "https://github.com/openapi-ts/openapi-typescript",
31+
"directory": "packages/openapi-pinia-colada"
32+
},
33+
"bugs": {
34+
"url": "https://github.com/openapi-ts/openapi-typescript/issues"
35+
},
36+
"keywords": [
37+
"openapi",
38+
"swagger",
39+
"rest",
40+
"api",
41+
"oapi_3",
42+
"oapi_3_1",
43+
"typescript",
44+
"fetch",
45+
"vue",
46+
"pinia-colada",
47+
"pinia"
48+
],
49+
"scripts": {
50+
"build": "pnpm run build:clean && pnpm run build:esm && pnpm run build:cjs",
51+
"build:clean": "del-cli dist",
52+
"build:esm": "tsc -p tsconfig.build.json",
53+
"build:cjs": "esbuild --bundle --platform=node --target=es2019 --outfile=dist/index.cjs --external:typescript src/index.ts",
54+
"dev": "tsc -p tsconfig.build.json --watch",
55+
"format": "biome format . --write",
56+
"lint": "biome check .",
57+
"generate-types": "openapi-typescript test/fixtures/api.yaml -o test/fixtures/api.d.ts",
58+
"pretest": "pnpm run generate-types",
59+
"test": "pnpm run \"/^test:/\"",
60+
"test:js": "vitest run",
61+
"test:ts": "tsc --noEmit",
62+
"version": "pnpm run prepare && pnpm run build"
63+
},
64+
"dependencies": {
65+
"openapi-typescript-helpers": "workspace:^"
66+
},
67+
"devDependencies": {
68+
"@pinia/colada": "^0.13.0",
69+
"@testing-library/vue": "^8.1.0",
70+
"@vitejs/plugin-vue": "^5.2.1",
71+
"del-cli": "^5.1.0",
72+
"esbuild": "^0.24.0",
73+
"execa": "^8.0.1",
74+
"msw": "^2.7.0",
75+
"openapi-fetch": "workspace:^",
76+
"openapi-typescript": "workspace:^"
77+
},
78+
"peerDependencies": {
79+
"@pinia/colada": "^0.13.0",
80+
"openapi-fetch": "workspace:^"
81+
}
82+
}

0 commit comments

Comments
 (0)