Codegen

# 1. Types for the document (openapi-typescript)
openapi-typescript api/openapi.json -o src/lib/api/schema.gen.ts
# 2. Endpoint modules
slq-codegen --spec api/openapi.json --types src/lib/api/schema.gen.ts --config slq.codegen.ts
# CI: exit 1 when a committed module differs from what the document produces
slq-codegen --check

// slq.codegen.ts — loaded with Node's own type stripping
import { defineConfig, kebab } from '@svelte-lean/query-codegen';

export default defineConfig({
	spec: 'api/openapi.json',
	types: 'src/lib/api/schema.gen.ts',
	out: (tag) => `src/lib/features/${kebab(tag)}/api/${kebab(tag)}.gen.ts`, // one module per tag
	envelope: 'data', // unwrap this property of documented responses (Laravel resources)
	untagged: 'System', // module of operations without a tag
	names: { 'markets.index': 'listMarkets' }, // operationId or `METHOD path` → export name
	exclude: ['admin-db.query'], // written by hand instead
	tags: { defaults: true },
	typesImport: '$lib/api/schema.gen'
});

// Generated by @svelte-lean/query-codegen from openapi.json (tag "Markets"): endpoints. Do not edit.
import { defineMutation, defineQuery, tag, type } from '@svelte-lean/query';
import type { ListMarketsParams, Market, UpdateMarketInput } from './markets.types.gen';
import * as policy from './markets.policy';

declare module '@svelte-lean/query' {
	interface Tags {
		Market: number;
		Markets: void;
	}
	interface Permissions {
		'markets.view': true;
		'markets.edit': true;
	}
}

export const listMarkets = defineQuery<'api/markets', Market[], ListMarketsParams>({
	get: 'api/markets',
	params: type<ListMarketsParams>(),
	result: type<Market[]>(),
	entity: 'Market', // default tags: GET /markets answers objects with an id
	tags: ['Markets'],
	...policy.listMarkets // the policy module wins
});

export const updateMarket = defineMutation<'api/markets/{market}', Market, UpdateMarketInput>({
	put: 'api/markets/{market}',
	body: type<UpdateMarketInput>(),
	result: type<Market>(),
	invalidates: (_, input) => [tag('Market', input.market), 'Markets'],
	access: 'markets.edit', // from x-permission
	...policy.updateMarket
});

// src/lib/features/markets/api/markets.policy.ts — what the document does not say, by hand
import { all, type MutationPolicy, type QueryPolicy } from '@svelte-lean/query';
import type { ListMarkets, UpdateMarket } from './markets.types.gen';

export const listMarkets = {
	fresh: '10m',
	persist: true,
	access: all('markets.view', (params) => params.region !== 'internal')
} satisfies QueryPolicy<ListMarkets['params'], ListMarkets['result']>;

export const updateMarket = {
	queue: (input) => `market:${input.market}` // one write per market at a time
} satisfies MutationPolicy<UpdateMarket['input'], UpdateMarket['result']>;