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 00000000..718d6fea Binary files /dev/null and b/playgrounds/nextjs/src/app/favicon.ico differ 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, + }) + }} + > + +