From d84005bc174833055e10e4f33c72c96f7c01b81e Mon Sep 17 00:00:00 2001 From: abhishek Date: Fri, 13 Mar 2026 03:12:30 +0530 Subject: [PATCH 1/2] Add structured outputs package This introduces a new @openuidev/structured-outputs package with parser/schema utilities, tests, and docs, plus a Next.js invoice demo that streams model output into parsed JSON. --- .../invoices-structured-output/.gitignore | 41 ++ examples/invoices-structured-output/README.md | 40 + .../eslint.config.mjs | 18 + .../invoices-structured-output/next.config.ts | 8 + .../invoices-structured-output/package.json | 29 + .../postcss.config.mjs | 7 + .../src/app/api/generate/route.ts | 82 +++ .../src/app/favicon.ico | Bin 0 -> 25931 bytes .../src/app/globals.css | 5 + .../src/app/layout.tsx | 19 + .../src/app/page.tsx | 392 ++++++++++ .../src/app/schemas.ts | 160 ++++ .../invoices-structured-output/tsconfig.json | 34 + packages/structured-outputs/README.md | 137 ++++ packages/structured-outputs/eslint.config.cjs | 57 ++ packages/structured-outputs/package.json | 59 ++ .../src/__tests__/defineType.test.ts | 379 ++++++++++ .../src/__tests__/parser.test.ts | 478 ++++++++++++ .../src/__tests__/prompt.test.ts | 348 +++++++++ .../src/__tests__/schemaMap.test.ts | 208 ++++++ .../src/__tests__/zod.test.ts | 256 +++++++ packages/structured-outputs/src/defineType.ts | 58 ++ packages/structured-outputs/src/index.ts | 10 + .../structured-outputs/src/parser/core.ts | 693 ++++++++++++++++++ .../structured-outputs/src/parser/prompt.ts | 194 +++++ packages/structured-outputs/src/schema.ts | 82 +++ packages/structured-outputs/src/schemaMap.ts | 119 +++ packages/structured-outputs/src/types.ts | 49 ++ packages/structured-outputs/src/utils/zod.ts | 155 ++++ .../structured-outputs/tsconfig.eslint.json | 6 + packages/structured-outputs/tsconfig.json | 17 + pnpm-lock.yaml | 329 ++++++++- 32 files changed, 4450 insertions(+), 19 deletions(-) create mode 100644 examples/invoices-structured-output/.gitignore create mode 100644 examples/invoices-structured-output/README.md create mode 100644 examples/invoices-structured-output/eslint.config.mjs create mode 100644 examples/invoices-structured-output/next.config.ts create mode 100644 examples/invoices-structured-output/package.json create mode 100644 examples/invoices-structured-output/postcss.config.mjs create mode 100644 examples/invoices-structured-output/src/app/api/generate/route.ts create mode 100644 examples/invoices-structured-output/src/app/favicon.ico create mode 100644 examples/invoices-structured-output/src/app/globals.css create mode 100644 examples/invoices-structured-output/src/app/layout.tsx create mode 100644 examples/invoices-structured-output/src/app/page.tsx create mode 100644 examples/invoices-structured-output/src/app/schemas.ts create mode 100644 examples/invoices-structured-output/tsconfig.json create mode 100644 packages/structured-outputs/README.md create mode 100644 packages/structured-outputs/eslint.config.cjs create mode 100644 packages/structured-outputs/package.json create mode 100644 packages/structured-outputs/src/__tests__/defineType.test.ts create mode 100644 packages/structured-outputs/src/__tests__/parser.test.ts create mode 100644 packages/structured-outputs/src/__tests__/prompt.test.ts create mode 100644 packages/structured-outputs/src/__tests__/schemaMap.test.ts create mode 100644 packages/structured-outputs/src/__tests__/zod.test.ts create mode 100644 packages/structured-outputs/src/defineType.ts create mode 100644 packages/structured-outputs/src/index.ts create mode 100644 packages/structured-outputs/src/parser/core.ts create mode 100644 packages/structured-outputs/src/parser/prompt.ts create mode 100644 packages/structured-outputs/src/schema.ts create mode 100644 packages/structured-outputs/src/schemaMap.ts create mode 100644 packages/structured-outputs/src/types.ts create mode 100644 packages/structured-outputs/src/utils/zod.ts create mode 100644 packages/structured-outputs/tsconfig.eslint.json create mode 100644 packages/structured-outputs/tsconfig.json diff --git a/examples/invoices-structured-output/.gitignore b/examples/invoices-structured-output/.gitignore new file mode 100644 index 000000000..5ef6a5207 --- /dev/null +++ b/examples/invoices-structured-output/.gitignore @@ -0,0 +1,41 @@ +# 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* +.pnpm-debug.log* + +# env files (can opt-in for committing if needed) +.env* + +# vercel +.vercel + +# typescript +*.tsbuildinfo +next-env.d.ts diff --git a/examples/invoices-structured-output/README.md b/examples/invoices-structured-output/README.md new file mode 100644 index 000000000..31ef7f4e5 --- /dev/null +++ b/examples/invoices-structured-output/README.md @@ -0,0 +1,40 @@ +# Invoice Structured Output Example + +A Next.js app demonstrating `@openuidev/structured-output` — the standalone OpenUI Lang library for schema-driven structured output from LLMs. + +## What it does + +1. **Select an invoice format** — Standard, Freelance, or International +2. **Describe the invoice** — or use the provided sample prompt +3. **Watch the LLM stream** — the raw OpenUI Lang appears on the left as tokens arrive +4. **See parsed JSON** — the streaming parser progressively builds the validated JSON on the right + +The backend generates a system prompt from the Zod schema using `schema.prompt()`, sends it to the LLM, and streams back the raw OpenUI Lang. The frontend uses `schema.streamingParser()` to parse and validate the output in real time. + +## Setup + +```bash +# From the monorepo root +pnpm install + +# Add your OpenRouter API key +cp examples/invoices-structured-output/.env.example examples/invoices-structured-output/.env.local +# Edit .env.local with your key + +# Run the dev server +pnpm --filter invoices-structured-output dev +``` + +## Invoice Formats + +| Format | Description | +| --- | --- | +| **Standard** | Simple business invoice with line items, tax rate, and totals | +| **Freelance** | Consulting invoice with hourly time entries and project details | +| **International** | Multi-currency invoice with addresses, tax breakdown, and shipping | + +## Key files + +- `src/app/schemas.ts` — Invoice type definitions using `defineType` and `createSchema` +- `src/app/api/generate/route.ts` — API route that generates the prompt and streams LLM output +- `src/app/page.tsx` — Frontend with format picker, streaming display, and parsed JSON view diff --git a/examples/invoices-structured-output/eslint.config.mjs b/examples/invoices-structured-output/eslint.config.mjs new file mode 100644 index 000000000..05e726d1b --- /dev/null +++ b/examples/invoices-structured-output/eslint.config.mjs @@ -0,0 +1,18 @@ +import { defineConfig, globalIgnores } from "eslint/config"; +import nextVitals from "eslint-config-next/core-web-vitals"; +import nextTs from "eslint-config-next/typescript"; + +const eslintConfig = defineConfig([ + ...nextVitals, + ...nextTs, + // Override default ignores of eslint-config-next. + globalIgnores([ + // Default ignores of eslint-config-next: + ".next/**", + "out/**", + "build/**", + "next-env.d.ts", + ]), +]); + +export default eslintConfig; diff --git a/examples/invoices-structured-output/next.config.ts b/examples/invoices-structured-output/next.config.ts new file mode 100644 index 000000000..596190563 --- /dev/null +++ b/examples/invoices-structured-output/next.config.ts @@ -0,0 +1,8 @@ +import type { NextConfig } from "next"; + +const nextConfig: NextConfig = { + transpilePackages: ["@openuidev/structured-output"], + serverExternalPackages: ["openai"], +}; + +export default nextConfig; diff --git a/examples/invoices-structured-output/package.json b/examples/invoices-structured-output/package.json new file mode 100644 index 000000000..86ea4d38f --- /dev/null +++ b/examples/invoices-structured-output/package.json @@ -0,0 +1,29 @@ +{ + "name": "invoices-structured-output", + "version": "0.1.0", + "private": true, + "scripts": { + "dev": "next dev", + "build": "next build", + "start": "next start", + "lint": "eslint" + }, + "dependencies": { + "@openuidev/structured-output": "workspace:^", + "next": "16.1.6", + "openai": "^6.27.0", + "react": "19.2.3", + "react-dom": "19.2.3", + "zod": "^4.3.6" + }, + "devDependencies": { + "@tailwindcss/postcss": "^4", + "@types/node": "^20", + "@types/react": "^19", + "@types/react-dom": "^19", + "eslint": "^9", + "eslint-config-next": "16.1.6", + "tailwindcss": "^4", + "typescript": "^5" + } +} diff --git a/examples/invoices-structured-output/postcss.config.mjs b/examples/invoices-structured-output/postcss.config.mjs new file mode 100644 index 000000000..61e36849c --- /dev/null +++ b/examples/invoices-structured-output/postcss.config.mjs @@ -0,0 +1,7 @@ +const config = { + plugins: { + "@tailwindcss/postcss": {}, + }, +}; + +export default config; diff --git a/examples/invoices-structured-output/src/app/api/generate/route.ts b/examples/invoices-structured-output/src/app/api/generate/route.ts new file mode 100644 index 000000000..1d442d69e --- /dev/null +++ b/examples/invoices-structured-output/src/app/api/generate/route.ts @@ -0,0 +1,82 @@ +import { NextRequest } from "next/server"; +import OpenAI from "openai"; +import { invoiceSchemaMap } from "../../schemas"; + +let _client: OpenAI | null = null; +function getClient() { + if (!_client) { + _client = new OpenAI({ apiKey: process.env.OPENAI_API_KEY }); + } + return _client; +} + +const BUSINESS_PREAMBLE = `You are an expert accounting assistant that generates structured invoice data. +Given a description of an invoice, extract or generate all relevant fields with realistic data. +Use plausible business names, dates, amounts, and tax calculations. +All monetary amounts should be numbers (not strings). Dates should be in YYYY-MM-DD format. +Ensure line item amounts equal quantity × unitPrice. Ensure totals are arithmetically correct.`; + +export async function POST(req: NextRequest) { + const { userPrompt } = (await req.json()) as { + userPrompt: string; + }; + + const systemPrompt = invoiceSchemaMap.prompt({ + preamble: BUSINESS_PREAMBLE, + additionalRules: [ + "All dates must be YYYY-MM-DD format", + "Monetary amounts must be numbers with up to 2 decimal places", + "NEVER use arithmetic expressions like 8*125 or 10+20 — always write the pre-computed numeric result (e.g. 1000, 30)", + "Ensure mathematical consistency: subtotal = sum of item amounts, total = subtotal + tax + shipping", + ], + }); + + console.log(systemPrompt); + + const stream = await getClient().chat.completions.create({ + model: "gpt-5", + stream: true, + messages: [ + { role: "system", content: systemPrompt }, + { role: "user", content: userPrompt }, + ], + reasoning_effort: "minimal", + }); + + const encoder = new TextEncoder(); + + const readable = new ReadableStream({ + async start(controller) { + const send = (type: string, content: string) => + controller.enqueue(encoder.encode(JSON.stringify({ type, content }) + "\n")); + + try { + for await (const chunk of stream) { + const delta = chunk.choices?.[0]?.delta as Record | undefined; + if (!delta) continue; + + const thinking = + (delta.reasoning as string | undefined) ?? + (delta.reasoning_content as string | undefined); + if (thinking) send("thinking", thinking); + + const content = delta.content as string | undefined; + if (content) send("content", content); + } + } catch (err) { + const message = err instanceof Error ? err.message : "Stream error"; + send("error", message); + } finally { + controller.close(); + } + }, + }); + + return new Response(readable, { + headers: { + "Content-Type": "application/x-ndjson; charset=utf-8", + "Transfer-Encoding": "chunked", + "Cache-Control": "no-cache", + }, + }); +} diff --git a/examples/invoices-structured-output/src/app/favicon.ico b/examples/invoices-structured-output/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/examples/invoices-structured-output/src/app/globals.css b/examples/invoices-structured-output/src/app/globals.css new file mode 100644 index 000000000..4d985b6e1 --- /dev/null +++ b/examples/invoices-structured-output/src/app/globals.css @@ -0,0 +1,5 @@ +@import "tailwindcss"; + +html { + font-size: 150%; +} diff --git a/examples/invoices-structured-output/src/app/layout.tsx b/examples/invoices-structured-output/src/app/layout.tsx new file mode 100644 index 000000000..d1e2d8562 --- /dev/null +++ b/examples/invoices-structured-output/src/app/layout.tsx @@ -0,0 +1,19 @@ +import type { Metadata } from "next"; +import "./globals.css"; + +export const metadata: Metadata = { + title: "Invoice Structured Output", + description: "Generate structured invoice data using OpenUI Lang and streaming LLM output", +}; + +export default function RootLayout({ + children, +}: Readonly<{ + children: React.ReactNode; +}>) { + return ( + + {children} + + ); +} diff --git a/examples/invoices-structured-output/src/app/page.tsx b/examples/invoices-structured-output/src/app/page.tsx new file mode 100644 index 000000000..e86b9c350 --- /dev/null +++ b/examples/invoices-structured-output/src/app/page.tsx @@ -0,0 +1,392 @@ +"use client"; + +import { useState, useRef, useCallback, useEffect } from "react"; +import type { ParseResult } from "@openuidev/structured-output"; +import { invoiceMeta, invoiceSchemaMap, type InvoiceFormat } from "./schemas"; + +type GenerationState = "idle" | "streaming" | "done" | "error"; + +const FORMAT_ICONS: Record = { + standard: "receipt", + freelance: "schedule", + international: "public", +}; + +export default function Page() { + const [format, setFormat] = useState("standard"); + const [userPrompt, setUserPrompt] = useState(invoiceMeta.standard.samplePrompt); + const [state, setState] = useState("idle"); + const [rawOutput, setRawOutput] = useState(""); + const [thinking, setThinking] = useState(""); + const [parsedResult, setParsedResult] = useState | null>(null); + const [errorMessage, setErrorMessage] = useState(""); + const [jsonTab, setJsonTab] = useState<"result" | "schema" | "systemPrompt">("result"); + + const abortRef = useRef(null); + const scrollRef = useRef(null); + + // Auto-scroll output when streaming + useEffect(() => { + if (state === "streaming" && scrollRef.current) { + scrollRef.current.scrollTop = scrollRef.current.scrollHeight; + } + }, [rawOutput, thinking, parsedResult, state]); + + const handleGenerate = useCallback(async () => { + const entry = invoiceMeta[format]; + const prompt = userPrompt.trim() || entry.samplePrompt; + + abortRef.current?.abort(); + const controller = new AbortController(); + abortRef.current = controller; + + setState("streaming"); + setRawOutput(""); + setThinking(""); + setParsedResult(null); + setErrorMessage(""); + + try { + const res = await fetch("/api/generate", { + method: "POST", + headers: { "Content-Type": "application/json" }, + body: JSON.stringify({ format, userPrompt: prompt }), + signal: controller.signal, + }); + + if (!res.ok) { + const err = await res.json(); + throw new Error(err.error ?? `HTTP ${res.status}`); + } + + const reader = res.body?.getReader(); + if (!reader) throw new Error("No response body"); + + const decoder = new TextDecoder(); + const parser = invoiceSchemaMap.streamingParser(); + let accContent = ""; + let accThinking = ""; + let lineBuf = ""; + + while (true) { + const { done, value } = await reader.read(); + if (done) break; + + lineBuf += decoder.decode(value, { stream: true }); + const lines = lineBuf.split("\n"); + lineBuf = lines.pop() ?? ""; + + for (const line of lines) { + if (!line.trim()) continue; + try { + const evt = JSON.parse(line) as { type: string; content: string }; + if (evt.type === "thinking") { + accThinking += evt.content; + setThinking(accThinking); + } else if (evt.type === "content") { + accContent += evt.content; + setRawOutput(accContent); + const result = parser.push(evt.content); + setParsedResult({ ...result }); + } else if (evt.type === "error") { + throw new Error(evt.content); + } + } catch (e) { + if (e instanceof SyntaxError) continue; + throw e; + } + } + } + + const finalResult = parser.getResult(); + setParsedResult({ ...finalResult }); + setState("done"); + } catch (err) { + if ((err as Error).name === "AbortError") return; + setErrorMessage((err as Error).message); + setState("error"); + } + }, [format, userPrompt]); + + const handleStop = useCallback(() => { + abortRef.current?.abort(); + setState("done"); + }, []); + + const copyToClipboard = (text: string) => { + navigator.clipboard.writeText(text); + }; + + return ( +
+ + {/* Header */} +
+
+
+
+ + description + +
+
+

+ Invoice Extractor +

+

+ Natural language to structured output. Select an invoice type and click on "Extract Invoice" to see the structured JSON result. +

+
+
+ +
+
+ +
+ {/* Left Column: Input & Selection */} +
+ +
+
+

+ + Invoice in natural language +

+ +
+ + {/* Unified Input Card */} +
+