From f8abece84fa0921dd3b3ca00f3985d1ab61d80e7 Mon Sep 17 00:00:00 2001 From: unnoq Date: Tue, 19 Nov 2024 14:29:43 +0700 Subject: [PATCH] chore: openapi, contract, nextjs, expressjs playgrounds --- playgrounds/contract-openapi/.gitignore | 4 + .../contract-openapi/.vscode/settings.json | 3 + playgrounds/contract-openapi/package.json | 28 ++++ .../contract-openapi/src/contract/auth.ts | 46 ++++++ .../contract-openapi/src/contract/index.ts | 29 ++++ .../contract-openapi/src/contract/planet.ts | 81 +++++++++ .../contract-openapi/src/data/planet.ts | 38 +++++ playgrounds/contract-openapi/src/main.ts | 112 +++++++++++++ playgrounds/contract-openapi/src/orpc.ts | 32 ++++ .../contract-openapi/src/playground-client.ts | 21 +++ .../contract-openapi/src/playground-react.ts | 22 +++ .../contract-openapi/src/router/auth.ts | 33 ++++ .../contract-openapi/src/router/index.ts | 29 ++++ .../contract-openapi/src/router/planet.ts | 93 +++++++++++ .../contract-openapi/src/schemas/auth.ts | 30 ++++ .../contract-openapi/src/schemas/planet.ts | 62 +++++++ .../contract-openapi/src/schemas/user.ts | 36 ++++ playgrounds/contract-openapi/tsconfig.json | 25 +++ playgrounds/expressjs/.gitignore | 4 + playgrounds/expressjs/.vscode/settings.json | 3 + playgrounds/expressjs/package.json | 34 ++++ playgrounds/expressjs/src/data/planet.ts | 38 +++++ playgrounds/expressjs/src/main.ts | 102 ++++++++++++ playgrounds/expressjs/src/orpc.ts | 28 ++++ .../expressjs/src/playground-client.ts | 21 +++ playgrounds/expressjs/src/playground-react.ts | 22 +++ playgrounds/expressjs/src/router/auth.ts | 69 ++++++++ playgrounds/expressjs/src/router/index.ts | 29 ++++ playgrounds/expressjs/src/router/planet.ts | 154 ++++++++++++++++++ playgrounds/expressjs/src/schemas/auth.ts | 30 ++++ playgrounds/expressjs/src/schemas/planet.ts | 62 +++++++ playgrounds/expressjs/src/schemas/user.ts | 36 ++++ playgrounds/expressjs/tsconfig.json | 25 +++ playgrounds/nextjs/.gitignore | 43 +++++ playgrounds/nextjs/.vscode/settings.json | 3 + playgrounds/nextjs/README.md | 36 ++++ playgrounds/nextjs/next.config.ts | 7 + playgrounds/nextjs/package.json | 29 ++++ playgrounds/nextjs/public/file.svg | 1 + playgrounds/nextjs/public/globe.svg | 1 + playgrounds/nextjs/public/next.svg | 1 + playgrounds/nextjs/public/vercel.svg | 1 + playgrounds/nextjs/public/window.svg | 1 + playgrounds/nextjs/src/app/actions.ts | 12 ++ .../nextjs/src/app/api/[...rest]/route.ts | 25 +++ playgrounds/nextjs/src/app/error.tsx | 9 + playgrounds/nextjs/src/app/favicon.ico | Bin 0 -> 25931 bytes playgrounds/nextjs/src/app/layout.tsx | 21 +++ playgrounds/nextjs/src/app/loading.tsx | 3 + playgrounds/nextjs/src/app/page.tsx | 140 ++++++++++++++++ playgrounds/nextjs/src/app/providers.tsx | 17 ++ playgrounds/nextjs/src/app/scalar/route.ts | 41 +++++ playgrounds/nextjs/src/app/spec/route.ts | 36 ++++ playgrounds/nextjs/src/data/planet.ts | 38 +++++ playgrounds/nextjs/src/lib/orpc.ts | 13 ++ playgrounds/nextjs/src/orpc.ts | 28 ++++ playgrounds/nextjs/src/playground-client.ts | 16 ++ playgrounds/nextjs/src/playground-react.ts | 19 +++ playgrounds/nextjs/src/router/auth.ts | 69 ++++++++ playgrounds/nextjs/src/router/index.ts | 29 ++++ playgrounds/nextjs/src/router/planet.ts | 154 ++++++++++++++++++ playgrounds/nextjs/src/schemas/auth.ts | 30 ++++ playgrounds/nextjs/src/schemas/planet.ts | 62 +++++++ playgrounds/nextjs/src/schemas/user.ts | 36 ++++ playgrounds/nextjs/tsconfig.json | 27 +++ playgrounds/openapi/.gitignore | 4 + playgrounds/openapi/.vscode/settings.json | 3 + playgrounds/openapi/package.json | 27 +++ playgrounds/openapi/src/data/planet.ts | 38 +++++ playgrounds/openapi/src/main.ts | 111 +++++++++++++ playgrounds/openapi/src/orpc.ts | 28 ++++ playgrounds/openapi/src/playground-client.ts | 21 +++ playgrounds/openapi/src/playground-react.ts | 22 +++ playgrounds/openapi/src/router/auth.ts | 69 ++++++++ playgrounds/openapi/src/router/index.ts | 29 ++++ playgrounds/openapi/src/router/planet.ts | 154 ++++++++++++++++++ playgrounds/openapi/src/schemas/auth.ts | 30 ++++ playgrounds/openapi/src/schemas/planet.ts | 62 +++++++ playgrounds/openapi/src/schemas/user.ts | 36 ++++ playgrounds/openapi/tsconfig.json | 25 +++ 80 files changed, 2988 insertions(+) create mode 100644 playgrounds/contract-openapi/.gitignore create mode 100644 playgrounds/contract-openapi/.vscode/settings.json create mode 100644 playgrounds/contract-openapi/package.json create mode 100644 playgrounds/contract-openapi/src/contract/auth.ts create mode 100644 playgrounds/contract-openapi/src/contract/index.ts create mode 100644 playgrounds/contract-openapi/src/contract/planet.ts create mode 100644 playgrounds/contract-openapi/src/data/planet.ts create mode 100644 playgrounds/contract-openapi/src/main.ts create mode 100644 playgrounds/contract-openapi/src/orpc.ts create mode 100644 playgrounds/contract-openapi/src/playground-client.ts create mode 100644 playgrounds/contract-openapi/src/playground-react.ts create mode 100644 playgrounds/contract-openapi/src/router/auth.ts create mode 100644 playgrounds/contract-openapi/src/router/index.ts create mode 100644 playgrounds/contract-openapi/src/router/planet.ts create mode 100644 playgrounds/contract-openapi/src/schemas/auth.ts create mode 100644 playgrounds/contract-openapi/src/schemas/planet.ts create mode 100644 playgrounds/contract-openapi/src/schemas/user.ts create mode 100644 playgrounds/contract-openapi/tsconfig.json create mode 100644 playgrounds/expressjs/.gitignore create mode 100644 playgrounds/expressjs/.vscode/settings.json create mode 100644 playgrounds/expressjs/package.json create mode 100644 playgrounds/expressjs/src/data/planet.ts create mode 100644 playgrounds/expressjs/src/main.ts create mode 100644 playgrounds/expressjs/src/orpc.ts create mode 100644 playgrounds/expressjs/src/playground-client.ts create mode 100644 playgrounds/expressjs/src/playground-react.ts create mode 100644 playgrounds/expressjs/src/router/auth.ts create mode 100644 playgrounds/expressjs/src/router/index.ts create mode 100644 playgrounds/expressjs/src/router/planet.ts create mode 100644 playgrounds/expressjs/src/schemas/auth.ts create mode 100644 playgrounds/expressjs/src/schemas/planet.ts create mode 100644 playgrounds/expressjs/src/schemas/user.ts create mode 100644 playgrounds/expressjs/tsconfig.json create mode 100644 playgrounds/nextjs/.gitignore create mode 100644 playgrounds/nextjs/.vscode/settings.json create mode 100644 playgrounds/nextjs/README.md create mode 100644 playgrounds/nextjs/next.config.ts create mode 100644 playgrounds/nextjs/package.json create mode 100644 playgrounds/nextjs/public/file.svg create mode 100644 playgrounds/nextjs/public/globe.svg create mode 100644 playgrounds/nextjs/public/next.svg create mode 100644 playgrounds/nextjs/public/vercel.svg create mode 100644 playgrounds/nextjs/public/window.svg create mode 100644 playgrounds/nextjs/src/app/actions.ts create mode 100644 playgrounds/nextjs/src/app/api/[...rest]/route.ts create mode 100644 playgrounds/nextjs/src/app/error.tsx create mode 100644 playgrounds/nextjs/src/app/favicon.ico create mode 100644 playgrounds/nextjs/src/app/layout.tsx create mode 100644 playgrounds/nextjs/src/app/loading.tsx create mode 100644 playgrounds/nextjs/src/app/page.tsx create mode 100644 playgrounds/nextjs/src/app/providers.tsx create mode 100644 playgrounds/nextjs/src/app/scalar/route.ts create mode 100644 playgrounds/nextjs/src/app/spec/route.ts create mode 100644 playgrounds/nextjs/src/data/planet.ts create mode 100644 playgrounds/nextjs/src/lib/orpc.ts create mode 100644 playgrounds/nextjs/src/orpc.ts create mode 100644 playgrounds/nextjs/src/playground-client.ts create mode 100644 playgrounds/nextjs/src/playground-react.ts create mode 100644 playgrounds/nextjs/src/router/auth.ts create mode 100644 playgrounds/nextjs/src/router/index.ts create mode 100644 playgrounds/nextjs/src/router/planet.ts create mode 100644 playgrounds/nextjs/src/schemas/auth.ts create mode 100644 playgrounds/nextjs/src/schemas/planet.ts create mode 100644 playgrounds/nextjs/src/schemas/user.ts create mode 100644 playgrounds/nextjs/tsconfig.json create mode 100644 playgrounds/openapi/.gitignore create mode 100644 playgrounds/openapi/.vscode/settings.json create mode 100644 playgrounds/openapi/package.json create mode 100644 playgrounds/openapi/src/data/planet.ts create mode 100644 playgrounds/openapi/src/main.ts create mode 100644 playgrounds/openapi/src/orpc.ts create mode 100644 playgrounds/openapi/src/playground-client.ts create mode 100644 playgrounds/openapi/src/playground-react.ts create mode 100644 playgrounds/openapi/src/router/auth.ts create mode 100644 playgrounds/openapi/src/router/index.ts create mode 100644 playgrounds/openapi/src/router/planet.ts create mode 100644 playgrounds/openapi/src/schemas/auth.ts create mode 100644 playgrounds/openapi/src/schemas/planet.ts create mode 100644 playgrounds/openapi/src/schemas/user.ts create mode 100644 playgrounds/openapi/tsconfig.json diff --git a/playgrounds/contract-openapi/.gitignore b/playgrounds/contract-openapi/.gitignore new file mode 100644 index 00000000..3e3ded4e --- /dev/null +++ b/playgrounds/contract-openapi/.gitignore @@ -0,0 +1,4 @@ +node_modules +pnpm-lock.yaml +package-lock.json +yarn.lock \ No newline at end of file diff --git a/playgrounds/contract-openapi/.vscode/settings.json b/playgrounds/contract-openapi/.vscode/settings.json new file mode 100644 index 00000000..17293413 --- /dev/null +++ b/playgrounds/contract-openapi/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "editor.formatOnSave": true, +} \ No newline at end of file diff --git a/playgrounds/contract-openapi/package.json b/playgrounds/contract-openapi/package.json new file mode 100644 index 00000000..a5e6df1e --- /dev/null +++ b/playgrounds/contract-openapi/package.json @@ -0,0 +1,28 @@ +{ + "name": "orpc-openapi-playground", + "version": "0.0.0", + "description": "oRPC OpenAPI Playground", + "type": "module", + "scripts": { + "dev": "tsx --watch src/main.ts", + "start": "tsx src/main.ts" + }, + "keywords": ["orpc", "openapi", "playground", "unnoq"], + "author": "", + "license": "ISC", + "devDependencies": { + "@types/node": "^22.9.0", + "tsx": "^4.19.2", + "typescript": "^5.6.3" + }, + "dependencies": { + "@orpc/client": "latest", + "@orpc/contract": "latest", + "@orpc/openapi": "latest", + "@orpc/react": "latest", + "@orpc/server": "latest", + "@orpc/zod": "latest", + "@whatwg-node/server": "^0.9.55", + "zod": "^3.23.8" + } +} diff --git a/playgrounds/contract-openapi/src/contract/auth.ts b/playgrounds/contract-openapi/src/contract/auth.ts new file mode 100644 index 00000000..a4cb49fa --- /dev/null +++ b/playgrounds/contract-openapi/src/contract/auth.ts @@ -0,0 +1,46 @@ +import { oc } from '@orpc/contract' +import { CredentialSchema, TokenSchema } from '../schemas/auth' +import { NewUserSchema, UserSchema } from '../schemas/user' + +export const signup = oc + .route({ + method: 'POST', + path: '/signup', + summary: 'Sign up a new user', + }) + .input(NewUserSchema) + .output(UserSchema) + +export const signin = oc + .route({ + method: 'POST', + path: '/signin', + summary: 'Sign in a user', + }) + .input(CredentialSchema) + .output(TokenSchema) + +export const refresh = oc + .route({ + method: 'POST', + path: '/refresh', + summary: 'Refresh a token', + }) + .input(TokenSchema) + .output(TokenSchema) + +export const revoke = oc + .route({ + method: 'DELETE', + path: '/revoke', + summary: 'Revoke a token', + }) + .input(TokenSchema) + +export const me = oc + .route({ + method: 'GET', + path: '/me', + summary: 'Get the current user', + }) + .output(UserSchema) diff --git a/playgrounds/contract-openapi/src/contract/index.ts b/playgrounds/contract-openapi/src/contract/index.ts new file mode 100644 index 00000000..a6a11d03 --- /dev/null +++ b/playgrounds/contract-openapi/src/contract/index.ts @@ -0,0 +1,29 @@ +import { oc } from '@orpc/contract' +import { me, refresh, revoke, signin, signup } from './auth' +import { + createPlanet, + deletePlanet, + findPlanet, + listPlanets, + updatePlanet, + updatePlanetImage, +} from './planet' + +export const contract = oc.router({ + auth: oc.tags('Authentication').prefix('/auth').router({ + signup, + signin, + refresh, + revoke, + me, + }), + + planet: oc.tags('Planets').prefix('/planets').router({ + list: listPlanets, + create: createPlanet, + find: findPlanet, + update: updatePlanet, + updateImage: updatePlanetImage, + delete: deletePlanet, + }), +}) diff --git a/playgrounds/contract-openapi/src/contract/planet.ts b/playgrounds/contract-openapi/src/contract/planet.ts new file mode 100644 index 00000000..81abe3ec --- /dev/null +++ b/playgrounds/contract-openapi/src/contract/planet.ts @@ -0,0 +1,81 @@ +import { oc } from '@orpc/contract' +import { oz } from '@orpc/zod' +import { z } from 'zod' +import { planets } from '../data/planet' +import { + NewPlanetSchema, + PlanetSchema, + UpdatePlanetSchema, +} from '../schemas/planet' + +export const listPlanets = oc + .route({ + method: 'GET', + path: '/', + summary: 'List all planets', + }) + .input( + z.object({ + limit: z.number().int().min(1).max(100).optional(), + cursor: z.number().int().min(0).default(0), + }), + ) + .output(oz.openapi(z.array(PlanetSchema), { examples: [planets] })) + +export const createPlanet = oc + .route({ + method: 'POST', + path: '/', + summary: 'Create a planet', + }) + .input(NewPlanetSchema) + .output(PlanetSchema) + +export const findPlanet = oc + .route({ + method: 'GET', + path: '/{id}', + summary: 'Find a planet', + }) + .input( + z.object({ + id: z.number().int().min(1), + }), + ) + .output(PlanetSchema) + +export const updatePlanet = oc + .route({ + method: 'PUT', + path: '/{id}', + summary: 'Update a planet', + }) + .input(UpdatePlanetSchema) + .output(PlanetSchema) + +export const updatePlanetImage = oc + .route({ + method: 'PATCH', + path: '/{id}/image', + summary: 'Update a planet image', + }) + .input( + z.object({ + id: z.number().int().min(1), + image: oz.file().type('image/*').optional(), + }), + ) + .output(PlanetSchema) + +export const deletePlanet = oc + .route({ + method: 'DELETE', + path: '/{id}', + summary: 'Delete a planet', + deprecated: true, + }) + .input( + z.object({ + id: z.number().int().min(1), + }), + ) diff --git a/playgrounds/contract-openapi/src/data/planet.ts b/playgrounds/contract-openapi/src/data/planet.ts new file mode 100644 index 00000000..7f6a9868 --- /dev/null +++ b/playgrounds/contract-openapi/src/data/planet.ts @@ -0,0 +1,38 @@ +import type { z } from 'zod' +import type { PlanetSchema } from '../schemas/planet' + +export const planets: z.infer[] = [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + { + id: 2, + name: 'Mars', + description: 'The planet Mars', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + { + id: 3, + name: 'Jupiter', + description: 'The planet Jupiter', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, +] diff --git a/playgrounds/contract-openapi/src/main.ts b/playgrounds/contract-openapi/src/main.ts new file mode 100644 index 00000000..0f53f6c5 --- /dev/null +++ b/playgrounds/contract-openapi/src/main.ts @@ -0,0 +1,112 @@ +import { createServer } from 'node:http' +import { generateOpenAPI } from '@orpc/openapi' +import { createFetchHandler } from '@orpc/server/fetch' +import { createServerAdapter } from '@whatwg-node/server' +import { contract } from './contract' +import { router } from './router' + +const orpcHandler = createFetchHandler({ + router, + hooks(context, meta) { + meta.onError((e) => console.error(e)) + }, +}) + +const server = createServer( + createServerAdapter((request: Request) => { + const url = new URL(request.url) + + const context = request.headers.get('Authorization') + ? { user: { id: 'test', name: 'John Doe', email: 'john@doe.com' } } + : {} + + if (url.pathname.startsWith('/api')) { + return orpcHandler({ + request, + prefix: '/api', + context, + }) + } + + if (url.pathname === '/spec.json') { + const spec = generateOpenAPI({ + router: contract, + info: { + title: 'ORPC Playground', + version: '1.0.0', + description: ` +The example OpenAPI Playground for ORPC. + +## Resources + +* [Github](https://github.com/unnoq/orpc) +* [Documentation](https://orpc.unnoq.com) + `, + }, + servers: [ + { url: '/api' /** Should use absolute URLs in production */ }, + ], + security: [{ bearerAuth: [] }], + components: { + securitySchemes: { + bearerAuth: { + type: 'http', + scheme: 'bearer', + }, + }, + }, + }) + + return new Response(JSON.stringify(spec), { + headers: { + 'Content-Type': 'application/json', + }, + }) + } + + return new Response( + ` + + + + ORPC Playground + + + + + + + + + + + + `, + { + headers: { + 'Content-Type': 'text/html', + }, + }, + ) + }), +) + +server.listen(2026, () => { + // biome-ignore lint/suspicious/noConsole: + console.log('Playground is available at http://localhost:2026') +}) diff --git a/playgrounds/contract-openapi/src/orpc.ts b/playgrounds/contract-openapi/src/orpc.ts new file mode 100644 index 00000000..4502c297 --- /dev/null +++ b/playgrounds/contract-openapi/src/orpc.ts @@ -0,0 +1,32 @@ +import { os, ORPCError } from '@orpc/server' +import type { z } from 'zod' +import { contract } from './contract' +import type { UserSchema } from './schemas/user' + +export type ORPCContext = { user?: z.infer; db: any } + +const osBase = os.context().use((input, context, meta) => { + const start = Date.now() + + meta.onFinish(() => { + // biome-ignore lint/suspicious/noConsole: + console.log(`[${meta.path.join('/')}] ${Date.now() - start}ms`) + }) +}) + +const authedBase = osBase.use((input, context, meta) => { + if (!context.user) { + throw new ORPCError({ + code: 'UNAUTHORIZED', + }) + } + + return { + context: { + user: context.user, + }, + } +}) + +export const osw = osBase.contract(contract) +export const authed = authedBase.contract(contract) diff --git a/playgrounds/contract-openapi/src/playground-client.ts b/playgrounds/contract-openapi/src/playground-client.ts new file mode 100644 index 00000000..33ad36e3 --- /dev/null +++ b/playgrounds/contract-openapi/src/playground-client.ts @@ -0,0 +1,21 @@ +/** + * This file is where you can play with type of oRPC Client. + */ + +import { createORPCClient } from '@orpc/client' +import type { contract } from './contract' + +const orpc = createORPCClient({ + baseURL: 'http://localhost:2026/api', +}) + +const planets = await orpc.planet.list({}) + +const planet = await orpc.planet.find({ id: 1 }) + +const token = await orpc.auth.signin({ + email: 'john@doe.com', + password: '123456', +}) + +// ... diff --git a/playgrounds/contract-openapi/src/playground-react.ts b/playgrounds/contract-openapi/src/playground-react.ts new file mode 100644 index 00000000..8a8460c3 --- /dev/null +++ b/playgrounds/contract-openapi/src/playground-react.ts @@ -0,0 +1,22 @@ +/** + * This file is where you can play with type of oRPC React. + */ + +import { createORPCReact } from '@orpc/react' +import type { contract } from './contract' + +const { orpc } = createORPCReact() + +const listQuery = orpc.planet.list.useInfiniteQuery({ + input: {}, + getNextPageParam: (lastPage) => (lastPage.at(-1)?.id ?? -1) + 1, +}) + +const utils = orpc.useUtils() + +utils.planet.invalidate() + +const queries = orpc.useQueries((o) => [ + o.planet.find({ id: 1 }), + o.planet.list({}), +]) diff --git a/playgrounds/contract-openapi/src/router/auth.ts b/playgrounds/contract-openapi/src/router/auth.ts new file mode 100644 index 00000000..39d930e3 --- /dev/null +++ b/playgrounds/contract-openapi/src/router/auth.ts @@ -0,0 +1,33 @@ +import { authed, osw } from '../orpc' + +export const signup = osw.auth.signup.handler(async (input, context, meta) => { + return { + id: crypto.randomUUID(), + email: input.email, + name: input.name, + } +}) + +export const signin = osw.auth.signin.handler(async (input, context, meta) => { + return { + token: 'token', + } +}) + +export const refresh = authed.auth.refresh.handler( + async (input, context, meta) => { + return { + token: 'new-token', + } + }, +) + +export const revoke = authed.auth.revoke.handler( + async (input, context, meta) => { + // Do something + }, +) + +export const me = authed.auth.me.handler(async (input, context, meta) => { + return context.user +}) diff --git a/playgrounds/contract-openapi/src/router/index.ts b/playgrounds/contract-openapi/src/router/index.ts new file mode 100644 index 00000000..14efa25f --- /dev/null +++ b/playgrounds/contract-openapi/src/router/index.ts @@ -0,0 +1,29 @@ +import { osw } from '../orpc' +import { me, refresh, revoke, signin, signup } from './auth' +import { + createPlanet, + deletePlanet, + findPlanet, + listPlanets, + updatePlanet, + updatePlanetImage, +} from './planet' + +export const router = osw.router({ + auth: osw.auth.router({ + signup, + signin, + refresh, + revoke, + me, + }), + + planet: osw.planet.router({ + list: listPlanets, + create: createPlanet, + find: findPlanet, + update: updatePlanet, + updateImage: updatePlanetImage, + delete: deletePlanet, + }), +}) diff --git a/playgrounds/contract-openapi/src/router/planet.ts b/playgrounds/contract-openapi/src/router/planet.ts new file mode 100644 index 00000000..10e41d04 --- /dev/null +++ b/playgrounds/contract-openapi/src/router/planet.ts @@ -0,0 +1,93 @@ +import { ORPCError } from '@orpc/server' +import { planets } from '../data/planet' +import { authed } from '../orpc' + +export const listPlanets = authed.planet.list.handler( + async (input, context, meta) => { + return planets + }, +) + +export const createPlanet = authed.planet.create.handler( + async (input, context, meta) => { + const id = planets.length + 1 + + const planet = { + id, + name: input.name, + description: input.description, + imageUrl: input.image ? 'https://picsum.photos/200/300' : undefined, + creator: context.user, + } + + planets.push(planet) + + return planet + }, +) + +export const findPlanet = authed.planet.find.handler( + async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + return planet + }, +) + +export const updatePlanet = authed.planet.update.handler( + async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planet.name = input.name ?? planet.name + planet.description = input.description ?? planet.description + planet.imageUrl = input.image ? 'https://picsum.photos/200/300' : undefined + + return planet + }, +) + +export const updatePlanetImage = authed.planet.updateImage.handler( + async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planet.imageUrl = input.image ? 'https://picsum.photos/200/300' : undefined + + return planet + }, +) + +export const deletePlanet = authed.planet.delete.handler( + async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planets.splice(planets.indexOf(planet), 1) + }, +) diff --git a/playgrounds/contract-openapi/src/schemas/auth.ts b/playgrounds/contract-openapi/src/schemas/auth.ts new file mode 100644 index 00000000..3086caf2 --- /dev/null +++ b/playgrounds/contract-openapi/src/schemas/auth.ts @@ -0,0 +1,30 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' + +export const CredentialSchema = oz.openapi( + z.object({ + email: z.string().email(), + password: z.string(), + }), + { + examples: [ + { + email: 'john@doe.com', + password: '123456', + }, + ], + }, +) + +export const TokenSchema = oz.openapi( + z.object({ + token: z.string(), + }), + { + examples: [ + { + token: '****', + }, + ], + }, +) diff --git a/playgrounds/contract-openapi/src/schemas/planet.ts b/playgrounds/contract-openapi/src/schemas/planet.ts new file mode 100644 index 00000000..c732afc3 --- /dev/null +++ b/playgrounds/contract-openapi/src/schemas/planet.ts @@ -0,0 +1,62 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' +import { UserSchema } from './user' + +export const NewPlanetSchema = oz.openapi( + z.object({ + name: z.string(), + description: z.string().optional(), + image: oz.file().type('image/*').optional(), + }), + { + examples: [ + { + name: 'Earth', + description: 'The planet Earth', + }, + ], + }, +) + +export const UpdatePlanetSchema = oz.openapi( + z.object({ + id: z.number().int().min(1), + name: z.string(), + description: z.string().optional(), + image: oz.file().type('image/*').optional(), + }), + { + examples: [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + }, + ], + }, +) + +export const PlanetSchema = oz.openapi( + z.object({ + id: z.number().int().min(1), + name: z.string(), + description: z.string().optional(), + imageUrl: z.string().url().optional(), + creator: UserSchema, + }), + { + examples: [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + ], + }, +) diff --git a/playgrounds/contract-openapi/src/schemas/user.ts b/playgrounds/contract-openapi/src/schemas/user.ts new file mode 100644 index 00000000..2917b581 --- /dev/null +++ b/playgrounds/contract-openapi/src/schemas/user.ts @@ -0,0 +1,36 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' + +export const NewUserSchema = oz.openapi( + z.object({ + name: z.string(), + email: z.string().email(), + password: z.string(), + }), + { + examples: [ + { + name: 'John Doe', + email: 'john@doe.com', + password: '123456', + }, + ], + }, +) + +export const UserSchema = oz.openapi( + z.object({ + id: z.string(), + name: z.string(), + email: z.string().email(), + }), + { + examples: [ + { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + ], + }, +) diff --git a/playgrounds/contract-openapi/tsconfig.json b/playgrounds/contract-openapi/tsconfig.json new file mode 100644 index 00000000..00177678 --- /dev/null +++ b/playgrounds/contract-openapi/tsconfig.json @@ -0,0 +1,25 @@ +{ + "$schema": "https://json.schemastore.org/tsconfig", + "compilerOptions": { + "target": "ES2022", + "lib": ["ES2022"], + "useDefineForClassFields": true, + "moduleDetection": "force", + "module": "ES2022", + "types": ["node"], + + "moduleResolution": "bundler", + "resolveJsonModule": true, + "jsx": "react-jsx", + + "noEmit": true, + "strict": true, + "outDir": "${configDir}/dist", + "noUncheckedIndexedAccess": true, + "noUncheckedSideEffectImports": true, + "noImplicitOverride": true, + "esModuleInterop": true, + "isolatedModules": true, + "skipLibCheck": true + } +} \ No newline at end of file diff --git a/playgrounds/expressjs/.gitignore b/playgrounds/expressjs/.gitignore new file mode 100644 index 00000000..3e3ded4e --- /dev/null +++ b/playgrounds/expressjs/.gitignore @@ -0,0 +1,4 @@ +node_modules +pnpm-lock.yaml +package-lock.json +yarn.lock \ No newline at end of file diff --git a/playgrounds/expressjs/.vscode/settings.json b/playgrounds/expressjs/.vscode/settings.json new file mode 100644 index 00000000..17293413 --- /dev/null +++ b/playgrounds/expressjs/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "editor.formatOnSave": true, +} \ No newline at end of file diff --git a/playgrounds/expressjs/package.json b/playgrounds/expressjs/package.json new file mode 100644 index 00000000..c5133ee8 --- /dev/null +++ b/playgrounds/expressjs/package.json @@ -0,0 +1,34 @@ +{ + "name": "orpc-openapi-playground", + "version": "0.0.0", + "description": "oRPC OpenAPI Playground", + "type": "module", + "scripts": { + "dev": "tsx --watch src/main.ts", + "start": "tsx src/main.ts" + }, + "keywords": [ + "orpc", + "openapi", + "playground", + "unnoq" + ], + "author": "", + "license": "ISC", + "devDependencies": { + "@types/express": "^5.0.0", + "@types/node": "^22.9.0", + "tsx": "^4.19.2", + "typescript": "^5.6.3" + }, + "dependencies": { + "@orpc/client": "latest", + "@orpc/openapi": "latest", + "@orpc/react": "latest", + "@orpc/server": "latest", + "@orpc/zod": "latest", + "@whatwg-node/server": "^0.9.55", + "express": "^4.21.1", + "zod": "^3.23.8" + } +} diff --git a/playgrounds/expressjs/src/data/planet.ts b/playgrounds/expressjs/src/data/planet.ts new file mode 100644 index 00000000..7f6a9868 --- /dev/null +++ b/playgrounds/expressjs/src/data/planet.ts @@ -0,0 +1,38 @@ +import type { z } from 'zod' +import type { PlanetSchema } from '../schemas/planet' + +export const planets: z.infer[] = [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + { + id: 2, + name: 'Mars', + description: 'The planet Mars', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + { + id: 3, + name: 'Jupiter', + description: 'The planet Jupiter', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, +] diff --git a/playgrounds/expressjs/src/main.ts b/playgrounds/expressjs/src/main.ts new file mode 100644 index 00000000..8ec4c0cd --- /dev/null +++ b/playgrounds/expressjs/src/main.ts @@ -0,0 +1,102 @@ +import { generateOpenAPI } from '@orpc/openapi' +import { createFetchHandler } from '@orpc/server/fetch' +import { createServerAdapter } from '@whatwg-node/server' +import express from 'express' +import { router } from './router' + +const app = express() + +const orpcHandler = createFetchHandler({ + router, + hooks(context, meta) { + meta.onError((e) => console.error(e)) + }, +}) + +app.get( + '/api/*', + createServerAdapter((request: Request) => { + const context = request.headers.get('Authorization') + ? { user: { id: 'test', name: 'John Doe', email: 'john@doe.com' } } + : {} + + return orpcHandler({ + request, + prefix: '/api', + context, + }) + }), +) + +app.get('/spec.json', async (req, res) => { + const spec = generateOpenAPI({ + router, + info: { + title: 'ORPC Playground', + version: '1.0.0', + description: ` +The example OpenAPI Playground for ORPC. + +## Resources + +* [Github](https://github.com/unnoq/orpc) +* [Documentation](https://orpc.unnoq.com) + `, + }, + servers: [{ url: '/api' /** Should use absolute URLs in production */ }], + security: [{ bearerAuth: [] }], + components: { + securitySchemes: { + bearerAuth: { + type: 'http', + scheme: 'bearer', + }, + }, + }, + }) + + res.json(spec) +}) + +app.get('/', (req, res) => { + const html = ` + + + + ORPC Playground + + + + + + + + + + + + ` + + res.setHeader('Content-Type', 'text/html') + res.send(html) +}) + +app.listen(2026, () => { + // biome-ignore lint/suspicious/noConsole: + console.log('Playground is available at http://localhost:2026') +}) diff --git a/playgrounds/expressjs/src/orpc.ts b/playgrounds/expressjs/src/orpc.ts new file mode 100644 index 00000000..c52e649b --- /dev/null +++ b/playgrounds/expressjs/src/orpc.ts @@ -0,0 +1,28 @@ +import { os, ORPCError } from '@orpc/server' +import type { z } from 'zod' +import type { UserSchema } from './schemas/user' + +export type ORPCContext = { user?: z.infer; db: any } + +export const osw = os.context().use((input, context, meta) => { + const start = Date.now() + + meta.onFinish(() => { + // biome-ignore lint/suspicious/noConsole: + console.log(`[${meta.path.join('/')}] ${Date.now() - start}ms`) + }) +}) + +export const authed = osw.use((input, context, meta) => { + if (!context.user) { + throw new ORPCError({ + code: 'UNAUTHORIZED', + }) + } + + return { + context: { + user: context.user, + }, + } +}) diff --git a/playgrounds/expressjs/src/playground-client.ts b/playgrounds/expressjs/src/playground-client.ts new file mode 100644 index 00000000..82ad64c9 --- /dev/null +++ b/playgrounds/expressjs/src/playground-client.ts @@ -0,0 +1,21 @@ +/** + * This file is where you can play with type of oRPC Client. + */ + +import { createORPCClient } from '@orpc/client' +import type { router } from './router' + +const orpc = createORPCClient({ + baseURL: 'http://localhost:2026/api', +}) + +const planets = await orpc.planet.list({}) + +const planet = await orpc.planet.find({ id: 1 }) + +const token = await orpc.auth.signin({ + email: 'john@doe.com', + password: '123456', +}) + +// ... diff --git a/playgrounds/expressjs/src/playground-react.ts b/playgrounds/expressjs/src/playground-react.ts new file mode 100644 index 00000000..45ac6baa --- /dev/null +++ b/playgrounds/expressjs/src/playground-react.ts @@ -0,0 +1,22 @@ +/** + * This file is where you can play with type of oRPC React. + */ + +import { createORPCReact } from '@orpc/react' +import type { router } from './router' + +const { orpc } = createORPCReact() + +const listQuery = orpc.planet.list.useInfiniteQuery({ + input: {}, + getNextPageParam: (lastPage) => (lastPage.at(-1)?.id ?? -1) + 1, +}) + +const utils = orpc.useUtils() + +utils.planet.invalidate() + +const queries = orpc.useQueries((o) => [ + o.planet.find({ id: 1 }), + o.planet.list({}), +]) diff --git a/playgrounds/expressjs/src/router/auth.ts b/playgrounds/expressjs/src/router/auth.ts new file mode 100644 index 00000000..16f7e56e --- /dev/null +++ b/playgrounds/expressjs/src/router/auth.ts @@ -0,0 +1,69 @@ +import { authed, osw } from '../orpc' +import { CredentialSchema, TokenSchema } from '../schemas/auth' +import { NewUserSchema, UserSchema } from '../schemas/user' + +export const signup = osw + .route({ + method: 'POST', + path: '/signup', + summary: 'Sign up a new user', + }) + .input(NewUserSchema) + .output(UserSchema) + .handler(async (input, context, meta) => { + return { + id: crypto.randomUUID(), + email: input.email, + name: input.name, + } + }) + +export const signin = osw + .route({ + method: 'POST', + path: '/signin', + summary: 'Sign in a user', + }) + .input(CredentialSchema) + .output(TokenSchema) + .handler(async (input, context, meta) => { + return { + token: 'token', + } + }) + +export const refresh = authed + .route({ + method: 'POST', + path: '/refresh', + summary: 'Refresh a token', + }) + .input(TokenSchema) + .output(TokenSchema) + .handler(async (input, context, meta) => { + return { + token: 'new-token', + } + }) + +export const revoke = authed + .route({ + method: 'DELETE', + path: '/revoke', + summary: 'Revoke a token', + }) + .input(TokenSchema) + .handler(async (input, context, meta) => { + // Do something + }) + +export const me = authed + .route({ + method: 'GET', + path: '/me', + summary: 'Get the current user', + }) + .output(UserSchema) + .handler(async (input, context, meta) => { + return context.user + }) diff --git a/playgrounds/expressjs/src/router/index.ts b/playgrounds/expressjs/src/router/index.ts new file mode 100644 index 00000000..f21652da --- /dev/null +++ b/playgrounds/expressjs/src/router/index.ts @@ -0,0 +1,29 @@ +import { osw } from '../orpc' +import { me, refresh, revoke, signin, signup } from './auth' +import { + createPlanet, + deletePlanet, + findPlanet, + listPlanets, + updatePlanet, + updatePlanetImage, +} from './planet' + +export const router = osw.router({ + auth: osw.tags('Authentication').prefix('/auth').router({ + signup, + signin, + refresh, + revoke, + me, + }), + + planet: osw.tags('Planets').prefix('/planets').router({ + list: listPlanets, + create: createPlanet, + find: findPlanet, + update: updatePlanet, + updateImage: updatePlanetImage, + delete: deletePlanet, + }), +}) diff --git a/playgrounds/expressjs/src/router/planet.ts b/playgrounds/expressjs/src/router/planet.ts new file mode 100644 index 00000000..8cdd428a --- /dev/null +++ b/playgrounds/expressjs/src/router/planet.ts @@ -0,0 +1,154 @@ +import { ORPCError } from '@orpc/server' +import { oz } from '@orpc/zod' +import { z } from 'zod' +import { planets } from '../data/planet' +import { authed } from '../orpc' +import { + NewPlanetSchema, + PlanetSchema, + UpdatePlanetSchema, +} from '../schemas/planet' + +export const listPlanets = authed + .route({ + method: 'GET', + path: '/', + summary: 'List all planets', + }) + .input( + z.object({ + limit: z.number().int().min(1).max(100).optional(), + cursor: z.number().int().min(0).default(0), + }), + ) + .output(oz.openapi(z.array(PlanetSchema), { examples: [planets] })) + .handler(async (input, context, meta) => { + return planets + }) + +export const createPlanet = authed + .route({ + method: 'POST', + path: '/', + summary: 'Create a planet', + }) + .input(NewPlanetSchema) + .output(PlanetSchema) + .handler(async (input, context, meta) => { + const id = planets.length + 1 + + const planet = { + id, + name: input.name, + description: input.description, + imageUrl: input.image ? 'https://picsum.photos/200/300' : undefined, + creator: context.user, + } + + planets.push(planet) + + return planet + }) + +export const findPlanet = authed + .route({ + method: 'GET', + path: '/{id}', + summary: 'Find a planet', + }) + .input( + z.object({ + id: z.number().int().min(1), + }), + ) + .output(PlanetSchema) + .handler(async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + return planet + }) + +export const updatePlanet = authed + .route({ + method: 'PUT', + path: '/{id}', + summary: 'Update a planet', + }) + .input(UpdatePlanetSchema) + .output(PlanetSchema) + .handler(async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planet.name = input.name ?? planet.name + planet.description = input.description ?? planet.description + planet.imageUrl = input.image ? 'https://picsum.photos/200/300' : undefined + + return planet + }) + +export const updatePlanetImage = authed + .route({ + method: 'PATCH', + path: '/{id}/image', + summary: 'Update a planet image', + }) + .input( + z.object({ + id: z.number().int().min(1), + image: oz.file().type('image/*').optional(), + }), + ) + .output(PlanetSchema) + .handler(async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planet.imageUrl = input.image ? 'https://picsum.photos/200/300' : undefined + + return planet + }) + +export const deletePlanet = authed + .route({ + method: 'DELETE', + path: '/{id}', + summary: 'Delete a planet', + deprecated: true, + }) + .input( + z.object({ + id: z.number().int().min(1), + }), + ) + .handler(async (input, context, meta) => { + const planet = planets.find((planet) => planet.id === input.id) + + if (!planet) { + throw new ORPCError({ + code: 'NOT_FOUND', + message: 'Planet not found', + }) + } + + planets.splice(planets.indexOf(planet), 1) + }) diff --git a/playgrounds/expressjs/src/schemas/auth.ts b/playgrounds/expressjs/src/schemas/auth.ts new file mode 100644 index 00000000..3086caf2 --- /dev/null +++ b/playgrounds/expressjs/src/schemas/auth.ts @@ -0,0 +1,30 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' + +export const CredentialSchema = oz.openapi( + z.object({ + email: z.string().email(), + password: z.string(), + }), + { + examples: [ + { + email: 'john@doe.com', + password: '123456', + }, + ], + }, +) + +export const TokenSchema = oz.openapi( + z.object({ + token: z.string(), + }), + { + examples: [ + { + token: '****', + }, + ], + }, +) diff --git a/playgrounds/expressjs/src/schemas/planet.ts b/playgrounds/expressjs/src/schemas/planet.ts new file mode 100644 index 00000000..c732afc3 --- /dev/null +++ b/playgrounds/expressjs/src/schemas/planet.ts @@ -0,0 +1,62 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' +import { UserSchema } from './user' + +export const NewPlanetSchema = oz.openapi( + z.object({ + name: z.string(), + description: z.string().optional(), + image: oz.file().type('image/*').optional(), + }), + { + examples: [ + { + name: 'Earth', + description: 'The planet Earth', + }, + ], + }, +) + +export const UpdatePlanetSchema = oz.openapi( + z.object({ + id: z.number().int().min(1), + name: z.string(), + description: z.string().optional(), + image: oz.file().type('image/*').optional(), + }), + { + examples: [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + }, + ], + }, +) + +export const PlanetSchema = oz.openapi( + z.object({ + id: z.number().int().min(1), + name: z.string(), + description: z.string().optional(), + imageUrl: z.string().url().optional(), + creator: UserSchema, + }), + { + examples: [ + { + id: 1, + name: 'Earth', + description: 'The planet Earth', + imageUrl: 'https://picsum.photos/200/300', + creator: { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + }, + ], + }, +) diff --git a/playgrounds/expressjs/src/schemas/user.ts b/playgrounds/expressjs/src/schemas/user.ts new file mode 100644 index 00000000..2917b581 --- /dev/null +++ b/playgrounds/expressjs/src/schemas/user.ts @@ -0,0 +1,36 @@ +import { oz } from '@orpc/zod' +import { z } from 'zod' + +export const NewUserSchema = oz.openapi( + z.object({ + name: z.string(), + email: z.string().email(), + password: z.string(), + }), + { + examples: [ + { + name: 'John Doe', + email: 'john@doe.com', + password: '123456', + }, + ], + }, +) + +export const UserSchema = oz.openapi( + z.object({ + id: z.string(), + name: z.string(), + email: z.string().email(), + }), + { + examples: [ + { + id: '1', + name: 'John Doe', + email: 'john@doe.com', + }, + ], + }, +) diff --git a/playgrounds/expressjs/tsconfig.json b/playgrounds/expressjs/tsconfig.json new file mode 100644 index 00000000..00177678 --- /dev/null +++ b/playgrounds/expressjs/tsconfig.json @@ -0,0 +1,25 @@ +{ + "$schema": "https://json.schemastore.org/tsconfig", + "compilerOptions": { + "target": "ES2022", + "lib": ["ES2022"], + "useDefineForClassFields": true, + "moduleDetection": "force", + "module": "ES2022", + "types": ["node"], + + "moduleResolution": "bundler", + "resolveJsonModule": true, + "jsx": "react-jsx", + + "noEmit": true, + "strict": true, + "outDir": "${configDir}/dist", + "noUncheckedIndexedAccess": true, + "noUncheckedSideEffectImports": true, + "noImplicitOverride": true, + "esModuleInterop": true, + "isolatedModules": true, + "skipLibCheck": true + } +} \ No newline at end of file diff --git a/playgrounds/nextjs/.gitignore b/playgrounds/nextjs/.gitignore new file mode 100644 index 00000000..e995283b --- /dev/null +++ b/playgrounds/nextjs/.gitignore @@ -0,0 +1,43 @@ +# See https://help.github.com/articles/ignoring-files/ for more about ignoring files. + +# dependencies +/node_modules +/.pnp +.pnp.* +.yarn/* +!.yarn/patches +!.yarn/plugins +!.yarn/releases +!.yarn/versions + +# testing +/coverage + +# next.js +/.next/ +/out/ + +# production +/build + +# misc +.DS_Store +*.pem + +# debug +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# env files (can opt-in for committing if needed) +.env* + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts +pnpm-lock.yaml +package-lock.json +yarn.lock \ No newline at end of file diff --git a/playgrounds/nextjs/.vscode/settings.json b/playgrounds/nextjs/.vscode/settings.json new file mode 100644 index 00000000..17293413 --- /dev/null +++ b/playgrounds/nextjs/.vscode/settings.json @@ -0,0 +1,3 @@ +{ + "editor.formatOnSave": true, +} \ No newline at end of file diff --git a/playgrounds/nextjs/README.md b/playgrounds/nextjs/README.md new file mode 100644 index 00000000..e215bc4c --- /dev/null +++ b/playgrounds/nextjs/README.md @@ -0,0 +1,36 @@ +This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). + +## Getting Started + +First, run the development server: + +```bash +npm run dev +# or +yarn dev +# or +pnpm dev +# or +bun dev +``` + +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. + +You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. + +This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. + +## Learn More + +To learn more about Next.js, take a look at the following resources: + +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. + +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! + +## Deploy on Vercel + +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. + +Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. diff --git a/playgrounds/nextjs/next.config.ts b/playgrounds/nextjs/next.config.ts new file mode 100644 index 00000000..e9ffa308 --- /dev/null +++ b/playgrounds/nextjs/next.config.ts @@ -0,0 +1,7 @@ +import type { NextConfig } from "next"; + +const nextConfig: NextConfig = { + /* config options here */ +}; + +export default nextConfig; diff --git a/playgrounds/nextjs/package.json b/playgrounds/nextjs/package.json new file mode 100644 index 00000000..3e8c358d --- /dev/null +++ b/playgrounds/nextjs/package.json @@ -0,0 +1,29 @@ +{ + "name": "orpc-nextjs-playground", + "version": "0.1.0", + "private": true, + "scripts": { + "dev": "next dev", + "build": "next build", + "start": "next start", + "lint": "next lint" + }, + "dependencies": { + "@orpc/client": "latest", + "@orpc/openapi": "latest", + "@orpc/react": "latest", + "@orpc/server": "latest", + "@orpc/zod": "latest", + "@tanstack/react-query": "^5.60.5", + "next": "15.0.3", + "react": "19.0.0-rc-66855b96-20241106", + "react-dom": "19.0.0-rc-66855b96-20241106", + "zod": "^3.23.8" + }, + "devDependencies": { + "@types/node": "^20", + "@types/react": "^18", + "@types/react-dom": "^18", + "typescript": "^5" + } +} diff --git a/playgrounds/nextjs/public/file.svg b/playgrounds/nextjs/public/file.svg new file mode 100644 index 00000000..004145cd --- /dev/null +++ b/playgrounds/nextjs/public/file.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/playgrounds/nextjs/public/globe.svg b/playgrounds/nextjs/public/globe.svg new file mode 100644 index 00000000..567f17b0 --- /dev/null +++ b/playgrounds/nextjs/public/globe.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/playgrounds/nextjs/public/next.svg b/playgrounds/nextjs/public/next.svg new file mode 100644 index 00000000..5174b28c --- /dev/null +++ b/playgrounds/nextjs/public/next.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/playgrounds/nextjs/public/vercel.svg b/playgrounds/nextjs/public/vercel.svg new file mode 100644 index 00000000..77053960 --- /dev/null +++ b/playgrounds/nextjs/public/vercel.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/playgrounds/nextjs/public/window.svg b/playgrounds/nextjs/public/window.svg new file mode 100644 index 00000000..b2b2a44f --- /dev/null +++ b/playgrounds/nextjs/public/window.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/playgrounds/nextjs/src/app/actions.ts b/playgrounds/nextjs/src/app/actions.ts new file mode 100644 index 00000000..82ffddc0 --- /dev/null +++ b/playgrounds/nextjs/src/app/actions.ts @@ -0,0 +1,12 @@ +'use server' + +import { os } from '@orpc/server' +import { redirect } from 'next/navigation' + +export const pong = os.handler(async () => { + return 'pong' +}) + +export const visitScalar = os.handler(async () => { + redirect('/scalar') +}) diff --git a/playgrounds/nextjs/src/app/api/[...rest]/route.ts b/playgrounds/nextjs/src/app/api/[...rest]/route.ts new file mode 100644 index 00000000..bc6c1955 --- /dev/null +++ b/playgrounds/nextjs/src/app/api/[...rest]/route.ts @@ -0,0 +1,25 @@ +import { router } from '@/router' +import { createFetchHandler } from '@orpc/server/fetch' + +const handler = createFetchHandler({ + router, + serverless: true, +}) + +function handleRequest(request: Request) { + const context = request.headers.get('Authorization') + ? { user: { id: 'test', name: 'John Doe', email: 'john@doe.com' } } + : {} + + return handler({ + request, + prefix: '/api', + context, + }) +} + +export const GET = handleRequest +export const POST = handleRequest +export const PUT = handleRequest +export const DELETE = handleRequest +export const PATCH = handleRequest diff --git a/playgrounds/nextjs/src/app/error.tsx b/playgrounds/nextjs/src/app/error.tsx new file mode 100644 index 00000000..b2b429b0 --- /dev/null +++ b/playgrounds/nextjs/src/app/error.tsx @@ -0,0 +1,9 @@ +'use client' + +export default function ErrorPage({ error }: { error: Error }) { + return ( +
+

Error: {error.message}

+
+ ) +} diff --git a/playgrounds/nextjs/src/app/favicon.ico b/playgrounds/nextjs/src/app/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..718d6fea4835ec2d246af9800eddb7ffb276240c GIT binary patch literal 25931 zcmeHv30#a{`}aL_*G&7qml|y<+KVaDM2m#dVr!KsA!#An?kSQM(q<_dDNCpjEux83 zLb9Z^XxbDl(w>%i@8hT6>)&Gu{h#Oeyszu?xtw#Zb1mO{pgX9699l+Qppw7jXaYf~-84xW z)w4x8?=youko|}Vr~(D$UXIbiXABHh`p1?nn8Po~fxRJv}|0e(BPs|G`(TT%kKVJAdg5*Z|x0leQq0 zkdUBvb#>9F()jo|T~kx@OM8$9wzs~t2l;K=woNssA3l6|sx2r3+kdfVW@e^8e*E}v zA1y5{bRi+3Z`uD3{F7LgFJDdvm;nJilkzDku>BwXH(8ItVCXk*-lSJnR?-2UN%hJ){&rlvg`CDTj z)Bzo!3v7Ou#83zEDEFcKt(f1E0~=rqeEbTnMvWR#{+9pg%7G8y>u1OVRUSoox-ovF z2Ydma(;=YuBY(eI|04{hXzZD6_f(v~H;C~y5=DhAC{MMS>2fm~1H_t2$56pc$NH8( z5bH|<)71dV-_oCHIrzrT`2s-5w_+2CM0$95I6X8p^r!gHp+j_gd;9O<1~CEQQGS8) zS9Qh3#p&JM-G8rHekNmKVewU;pJRcTAog68KYo^dRo}(M>36U4Us zfgYWSiHZL3;lpWT=zNAW>Dh#mB!_@Lg%$ms8N-;aPqMn+C2HqZgz&9~Eu z4|Kp<`$q)Uw1R?y(~S>ePdonHxpV1#eSP1B;Ogo+-Pk}6#0GsZZ5!||ev2MGdh}_m z{DeR7?0-1^zVs&`AV6Vt;r3`I`OI_wgs*w=eO%_#7Kepl{B@xiyCANc(l zzIyd4y|c6PXWq9-|KM8(zIk8LPk(>a)zyFWjhT!$HJ$qX1vo@d25W<fvZQ2zUz5WRc(UnFMKHwe1| zWmlB1qdbiA(C0jmnV<}GfbKtmcu^2*P^O?MBLZKt|As~ge8&AAO~2K@zbXelK|4T<{|y4`raF{=72kC2Kn(L4YyenWgrPiv z@^mr$t{#X5VuIMeL!7Ab6_kG$&#&5p*Z{+?5U|TZ`B!7llpVmp@skYz&n^8QfPJzL z0G6K_OJM9x+Wu2gfN45phANGt{7=C>i34CV{Xqlx(fWpeAoj^N0Biu`w+MVcCUyU* zDZuzO0>4Z6fbu^T_arWW5n!E45vX8N=bxTVeFoep_G#VmNlQzAI_KTIc{6>c+04vr zx@W}zE5JNSU>!THJ{J=cqjz+4{L4A{Ob9$ZJ*S1?Ggg3klFp!+Y1@K+pK1DqI|_gq z5ZDXVpge8-cs!o|;K73#YXZ3AShj50wBvuq3NTOZ`M&qtjj#GOFfgExjg8Gn8>Vq5 z`85n+9|!iLCZF5$HJ$Iu($dm?8~-ofu}tEc+-pyke=3!im#6pk_Wo8IA|fJwD&~~F zc16osQ)EBo58U7XDuMexaPRjU@h8tXe%S{fA0NH3vGJFhuyyO!Uyl2^&EOpX{9As0 zWj+P>{@}jxH)8|r;2HdupP!vie{sJ28b&bo!8`D^x}TE$%zXNb^X1p@0PJ86`dZyj z%ce7*{^oo+6%&~I!8hQy-vQ7E)0t0ybH4l%KltWOo~8cO`T=157JqL(oq_rC%ea&4 z2NcTJe-HgFjNg-gZ$6!Y`SMHrlj}Etf7?r!zQTPPSv}{so2e>Fjs1{gzk~LGeesX%r(Lh6rbhSo_n)@@G-FTQy93;l#E)hgP@d_SGvyCp0~o(Y;Ee8{ zdVUDbHm5`2taPUOY^MAGOw*>=s7=Gst=D+p+2yON!0%Hk` zz5mAhyT4lS*T3LS^WSxUy86q&GnoHxzQ6vm8)VS}_zuqG?+3td68_x;etQAdu@sc6 zQJ&5|4(I?~3d-QOAODHpZ=hlSg(lBZ!JZWCtHHSj`0Wh93-Uk)_S%zsJ~aD>{`A0~ z9{AG(e|q3g5B%wYKRxiL2Y$8(4w6bzchKuloQW#e&S3n+P- z8!ds-%f;TJ1>)v)##>gd{PdS2Oc3VaR`fr=`O8QIO(6(N!A?pr5C#6fc~Ge@N%Vvu zaoAX2&(a6eWy_q&UwOhU)|P3J0Qc%OdhzW=F4D|pt0E4osw;%<%Dn58hAWD^XnZD= z>9~H(3bmLtxpF?a7su6J7M*x1By7YSUbxGi)Ot0P77`}P3{)&5Un{KD?`-e?r21!4vTTnN(4Y6Lin?UkSM z`MXCTC1@4A4~mvz%Rh2&EwY))LeoT=*`tMoqcEXI>TZU9WTP#l?uFv+@Dn~b(>xh2 z;>B?;Tz2SR&KVb>vGiBSB`@U7VIWFSo=LDSb9F{GF^DbmWAfpms8Sx9OX4CnBJca3 zlj9(x!dIjN?OG1X4l*imJNvRCk}F%!?SOfiOq5y^mZW)jFL@a|r-@d#f7 z2gmU8L3IZq0ynIws=}~m^#@&C%J6QFo~Mo4V`>v7MI-_!EBMMtb%_M&kvAaN)@ZVw z+`toz&WG#HkWDjnZE!6nk{e-oFdL^$YnbOCN}JC&{$#$O27@|Tn-skXr)2ml2~O!5 zX+gYoxhoc7qoU?C^3~&!U?kRFtnSEecWuH0B0OvLodgUAi}8p1 zrO6RSXHH}DMc$&|?D004DiOVMHV8kXCP@7NKB zgaZq^^O<7PoKEp72kby@W0Z!Y*Ay{&vfg#C&gG@YVR9g?FEocMUi1gSN$+V+ayF45{a zuDZDTN}mS|;BO%gEf}pjBfN2-gIrU#G5~cucA;dokXW89%>AyXJJI z9X4UlIWA|ZYHgbI z5?oFk@A=Ik7lrEQPDH!H+b`7_Y~aDb_qa=B2^Y&Ow41cU=4WDd40dp5(QS-WMN-=Y z9g;6_-JdNU;|6cPwf$ak*aJIcwL@1n$#l~zi{c{EW?T;DaW*E8DYq?Umtz{nJ&w-M zEMyTDrC&9K$d|kZe2#ws6)L=7K+{ zQw{XnV6UC$6-rW0emqm8wJoeZK)wJIcV?dST}Z;G0Arq{dVDu0&4kd%N!3F1*;*pW zR&qUiFzK=@44#QGw7k1`3t_d8&*kBV->O##t|tonFc2YWrL7_eqg+=+k;!F-`^b8> z#KWCE8%u4k@EprxqiV$VmmtiWxDLgnGu$Vs<8rppV5EajBXL4nyyZM$SWVm!wnCj-B!Wjqj5-5dNXukI2$$|Bu3Lrw}z65Lc=1G z^-#WuQOj$hwNGG?*CM_TO8Bg-1+qc>J7k5c51U8g?ZU5n?HYor;~JIjoWH-G>AoUP ztrWWLbRNqIjW#RT*WqZgPJXU7C)VaW5}MiijYbABmzoru6EmQ*N8cVK7a3|aOB#O& zBl8JY2WKfmj;h#Q!pN%9o@VNLv{OUL?rixHwOZuvX7{IJ{(EdPpuVFoQqIOa7giLVkBOKL@^smUA!tZ1CKRK}#SSM)iQHk)*R~?M!qkCruaS!#oIL1c z?J;U~&FfH#*98^G?i}pA{ z9Jg36t4=%6mhY(quYq*vSxptes9qy|7xSlH?G=S@>u>Ebe;|LVhs~@+06N<4CViBk zUiY$thvX;>Tby6z9Y1edAMQaiH zm^r3v#$Q#2T=X>bsY#D%s!bhs^M9PMAcHbCc0FMHV{u-dwlL;a1eJ63v5U*?Q_8JO zT#50!RD619#j_Uf))0ooADz~*9&lN!bBDRUgE>Vud-i5ck%vT=r^yD*^?Mp@Q^v+V zG#-?gKlr}Eeqifb{|So?HM&g91P8|av8hQoCmQXkd?7wIJwb z_^v8bbg`SAn{I*4bH$u(RZ6*xUhuA~hc=8czK8SHEKTzSxgbwi~9(OqJB&gwb^l4+m`k*Q;_?>Y-APi1{k zAHQ)P)G)f|AyjSgcCFps)Fh6Bca*Xznq36!pV6Az&m{O8$wGFD? zY&O*3*J0;_EqM#jh6^gMQKpXV?#1?>$ml1xvh8nSN>-?H=V;nJIwB07YX$e6vLxH( zqYwQ>qxwR(i4f)DLd)-$P>T-no_c!LsN@)8`e;W@)-Hj0>nJ-}Kla4-ZdPJzI&Mce zv)V_j;(3ERN3_@I$N<^|4Lf`B;8n+bX@bHbcZTopEmDI*Jfl)-pFDvo6svPRoo@(x z);_{lY<;);XzT`dBFpRmGrr}z5u1=pC^S-{ce6iXQlLGcItwJ^mZx{m$&DA_oEZ)B{_bYPq-HA zcH8WGoBG(aBU_j)vEy+_71T34@4dmSg!|M8Vf92Zj6WH7Q7t#OHQqWgFE3ARt+%!T z?oLovLVlnf?2c7pTc)~cc^($_8nyKwsN`RA-23ed3sdj(ys%pjjM+9JrctL;dy8a( z@en&CQmnV(()bu|Y%G1-4a(6x{aLytn$T-;(&{QIJB9vMox11U-1HpD@d(QkaJdEb zG{)+6Dos_L+O3NpWo^=gR?evp|CqEG?L&Ut#D*KLaRFOgOEK(Kq1@!EGcTfo+%A&I z=dLbB+d$u{sh?u)xP{PF8L%;YPPW53+@{>5W=Jt#wQpN;0_HYdw1{ksf_XhO4#2F= zyPx6Lx2<92L-;L5PD`zn6zwIH`Jk($?Qw({erA$^bC;q33hv!d!>%wRhj# zal^hk+WGNg;rJtb-EB(?czvOM=H7dl=vblBwAv>}%1@{}mnpUznfq1cE^sgsL0*4I zJ##!*B?=vI_OEVis5o+_IwMIRrpQyT_Sq~ZU%oY7c5JMIADzpD!Upz9h@iWg_>>~j zOLS;wp^i$-E?4<_cp?RiS%Rd?i;f*mOz=~(&3lo<=@(nR!_Rqiprh@weZlL!t#NCc zO!QTcInq|%#>OVgobj{~ixEUec`E25zJ~*DofsQdzIa@5^nOXj2T;8O`l--(QyU^$t?TGY^7#&FQ+2SS3B#qK*k3`ye?8jUYSajE5iBbJls75CCc(m3dk{t?- zopcER9{Z?TC)mk~gpi^kbbu>b-+a{m#8-y2^p$ka4n60w;Sc2}HMf<8JUvhCL0B&Btk)T`ctE$*qNW8L$`7!r^9T+>=<=2qaq-;ll2{`{Rg zc5a0ZUI$oG&j-qVOuKa=*v4aY#IsoM+1|c4Z)<}lEDvy;5huB@1RJPquU2U*U-;gu z=En2m+qjBzR#DEJDO`WU)hdd{Vj%^0V*KoyZ|5lzV87&g_j~NCjwv0uQVqXOb*QrQ zy|Qn`hxx(58c70$E;L(X0uZZ72M1!6oeg)(cdKO ze0gDaTz+ohR-#d)NbAH4x{I(21yjwvBQfmpLu$)|m{XolbgF!pmsqJ#D}(ylp6uC> z{bqtcI#hT#HW=wl7>p!38sKsJ`r8}lt-q%Keqy%u(xk=yiIJiUw6|5IvkS+#?JTBl z8H5(Q?l#wzazujH!8o>1xtn8#_w+397*_cy8!pQGP%K(Ga3pAjsaTbbXJlQF_+m+-UpUUent@xM zg%jqLUExj~o^vQ3Gl*>wh=_gOr2*|U64_iXb+-111aH}$TjeajM+I20xw(((>fej-@CIz4S1pi$(#}P7`4({6QS2CaQS4NPENDp>sAqD z$bH4KGzXGffkJ7R>V>)>tC)uax{UsN*dbeNC*v}#8Y#OWYwL4t$ePR?VTyIs!wea+ z5Urmc)X|^`MG~*dS6pGSbU+gPJoq*^a=_>$n4|P^w$sMBBy@f*Z^Jg6?n5?oId6f{ z$LW4M|4m502z0t7g<#Bx%X;9<=)smFolV&(V^(7Cv2-sxbxopQ!)*#ZRhTBpx1)Fc zNm1T%bONzv6@#|dz(w02AH8OXe>kQ#1FMCzO}2J_mST)+ExmBr9cva-@?;wnmWMOk z{3_~EX_xadgJGv&H@zK_8{(x84`}+c?oSBX*Ge3VdfTt&F}yCpFP?CpW+BE^cWY0^ zb&uBN!Ja3UzYHK-CTyA5=L zEMW{l3Usky#ly=7px648W31UNV@K)&Ub&zP1c7%)`{);I4b0Q<)B}3;NMG2JH=X$U zfIW4)4n9ZM`-yRj67I)YSLDK)qfUJ_ij}a#aZN~9EXrh8eZY2&=uY%2N0UFF7<~%M zsB8=erOWZ>Ct_#^tHZ|*q`H;A)5;ycw*IcmVxi8_0Xk}aJA^ath+E;xg!x+As(M#0=)3!NJR6H&9+zd#iP(m0PIW8$ z1Y^VX`>jm`W!=WpF*{ioM?C9`yOR>@0q=u7o>BP-eSHqCgMDj!2anwH?s%i2p+Q7D zzszIf5XJpE)IG4;d_(La-xenmF(tgAxK`Y4sQ}BSJEPs6N_U2vI{8=0C_F?@7<(G; zo$~G=8p+076G;`}>{MQ>t>7cm=zGtfbdDXm6||jUU|?X?CaE?(<6bKDYKeHlz}DA8 zXT={X=yp_R;HfJ9h%?eWvQ!dRgz&Su*JfNt!Wu>|XfU&68iRikRrHRW|ZxzRR^`eIGt zIeiDgVS>IeExKVRWW8-=A=yA`}`)ZkWBrZD`hpWIxBGkh&f#ijr449~m`j6{4jiJ*C!oVA8ZC?$1RM#K(_b zL9TW)kN*Y4%^-qPpMP7d4)o?Nk#>aoYHT(*g)qmRUb?**F@pnNiy6Fv9rEiUqD(^O zzyS?nBrX63BTRYduaG(0VVG2yJRe%o&rVrLjbxTaAFTd8s;<<@Qs>u(<193R8>}2_ zuwp{7;H2a*X7_jryzriZXMg?bTuegABb^87@SsKkr2)0Gyiax8KQWstw^v#ix45EVrcEhr>!NMhprl$InQMzjSFH54x5k9qHc`@9uKQzvL4ihcq{^B zPrVR=o_ic%Y>6&rMN)hTZsI7I<3&`#(nl+3y3ys9A~&^=4?PL&nd8)`OfG#n zwAMN$1&>K++c{^|7<4P=2y(B{jJsQ0a#U;HTo4ZmWZYvI{+s;Td{Yzem%0*k#)vjpB zia;J&>}ICate44SFYY3vEelqStQWFihx%^vQ@Do(sOy7yR2@WNv7Y9I^yL=nZr3mb zXKV5t@=?-Sk|b{XMhA7ZGB@2hqsx}4xwCW!in#C zI@}scZlr3-NFJ@NFaJlhyfcw{k^vvtGl`N9xSo**rDW4S}i zM9{fMPWo%4wYDG~BZ18BD+}h|GQKc-g^{++3MY>}W_uq7jGHx{mwE9fZiPCoxN$+7 zrODGGJrOkcPQUB(FD5aoS4g~7#6NR^ma7-!>mHuJfY5kTe6PpNNKC9GGRiu^L31uG z$7v`*JknQHsYB!Tm_W{a32TM099djW%5e+j0Ve_ct}IM>XLF1Ap+YvcrLV=|CKo6S zb+9Nl3_YdKP6%Cxy@6TxZ>;4&nTneadr z_ES90ydCev)LV!dN=#(*f}|ZORFdvkYBni^aLbUk>BajeWIOcmHP#8S)*2U~QKI%S zyrLmtPqb&TphJ;>yAxri#;{uyk`JJqODDw%(Z=2`1uc}br^V%>j!gS)D*q*f_-qf8&D;W1dJgQMlaH5er zN2U<%Smb7==vE}dDI8K7cKz!vs^73o9f>2sgiTzWcwY|BMYHH5%Vn7#kiw&eItCqa zIkR2~Q}>X=Ar8W|^Ms41Fm8o6IB2_j60eOeBB1Br!boW7JnoeX6Gs)?7rW0^5psc- zjS16yb>dFn>KPOF;imD}e!enuIniFzv}n$m2#gCCv4jM#ArwlzZ$7@9&XkFxZ4n!V zj3dyiwW4Ki2QG{@i>yuZXQizw_OkZI^-3otXC{!(lUpJF33gI60ak;Uqitp74|B6I zgg{b=Iz}WkhCGj1M=hu4#Aw173YxIVbISaoc z-nLZC*6Tgivd5V`K%GxhBsp@SUU60-rfc$=wb>zdJzXS&-5(NRRodFk;Kxk!S(O(a0e7oY=E( zAyS;Ow?6Q&XA+cnkCb{28_1N8H#?J!*$MmIwLq^*T_9-z^&UE@A(z9oGYtFy6EZef LrJugUA?W`A8`#=m literal 0 HcmV?d00001 diff --git a/playgrounds/nextjs/src/app/layout.tsx b/playgrounds/nextjs/src/app/layout.tsx new file mode 100644 index 00000000..f3a13444 --- /dev/null +++ b/playgrounds/nextjs/src/app/layout.tsx @@ -0,0 +1,21 @@ +import type { Metadata } from 'next' +import { Providers } from './providers' + +export const metadata: Metadata = { + title: 'ORPC Playground', + description: 'End-to-end typesafe APIs builder, Developer-first simplicity', +} + +export default function RootLayout({ + children, +}: Readonly<{ + children: React.ReactNode +}>) { + return ( + + + {children} + + + ) +} diff --git a/playgrounds/nextjs/src/app/loading.tsx b/playgrounds/nextjs/src/app/loading.tsx new file mode 100644 index 00000000..09367d77 --- /dev/null +++ b/playgrounds/nextjs/src/app/loading.tsx @@ -0,0 +1,3 @@ +export default function Loading() { + return
Loading...
+} diff --git a/playgrounds/nextjs/src/app/page.tsx b/playgrounds/nextjs/src/app/page.tsx new file mode 100644 index 00000000..79073cb4 --- /dev/null +++ b/playgrounds/nextjs/src/app/page.tsx @@ -0,0 +1,140 @@ +'use client' + +import { orpc } from '@/lib/orpc' +import { pong, visitScalar } from './actions' + +export default function Home() { + return ( +
+

ORPC Playground

+

+ You can visit the Scalar API Reference page. +

+ + +
+ +
+ +
+ ) +} + +function SSRListPlanets() { + const { data, refetch, fetchNextPage, hasNextPage } = + orpc.planet.list.useSuspenseInfiniteQuery({ + input: {}, + getNextPageParam: (lastPage) => (lastPage.at(-1)?.id ?? -1) + 1, + }) + + return ( + + + + + + + + + + + {data.pages.flatMap((page, i) => + page.map((planet) => ( + + + + + + + )), + )} + + + + + + + +
IDNameDescriptionImage
{planet.id}{planet.name}{planet.description}{planet.imageUrl}
+ + + +
+ ) +} + +function AddPlanet() { + const utils = orpc.useUtils() + + const { mutate } = orpc.planet.create.useMutation({ + onSuccess() { + utils.planet.invalidate() + }, + onError(error) { + alert(error.message) + }, + }) + + return ( +
{ + e.preventDefault() + const form = new FormData(e.target as HTMLFormElement) + + const name = form.get('name') as string + const description = + (form.get('description') as string | null) ?? undefined + const image = form.get('image') as File + + mutate({ + name, + description, + image: image.size > 0 ? image : undefined, + }) + }} + > + +