@talonic/docs 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/dist/index.d.ts +670 -0
  2. package/dist/index.js +4785 -0
  3. package/dist/index.js.map +1 -0
  4. package/dist/seo.d.ts +555 -0
  5. package/dist/seo.js +358 -0
  6. package/dist/styles/void-docs.css +53 -0
  7. package/dist/tailwind-preset.cjs +64 -0
  8. package/dist/tailwind-preset.d.cts +45 -0
  9. package/dist/tailwind-preset.d.ts +45 -0
  10. package/dist/tailwind-preset.js +43 -0
  11. package/package.json +48 -0
package/dist/index.d.ts ADDED
@@ -0,0 +1,670 @@
1
+ import * as react_jsx_runtime from 'react/jsx-runtime';
2
+ import { ReactNode } from 'react';
3
+
4
+ /** Regex-based JSON syntax highlighter. */
5
+ declare function highlightJson(raw: string): React.ReactNode[];
6
+ /** Copyable code block with optional JSON syntax highlighting. */
7
+ declare function CodeBlock({ children, language, title, }: {
8
+ children: string;
9
+ language?: string;
10
+ title?: string;
11
+ }): react_jsx_runtime.JSX.Element;
12
+
13
+ interface DownloadMarkdownProps {
14
+ contentRef: React.RefObject<HTMLElement | null>;
15
+ filename: string;
16
+ }
17
+ declare function DownloadMarkdown({ contentRef, filename }: DownloadMarkdownProps): react_jsx_runtime.JSX.Element;
18
+
19
+ type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
20
+ interface Param {
21
+ name: string;
22
+ type: string;
23
+ required?: boolean;
24
+ description: string;
25
+ default?: string;
26
+ }
27
+ interface NavSection {
28
+ id: string;
29
+ label: string;
30
+ children?: {
31
+ id: string;
32
+ label: string;
33
+ }[];
34
+ }
35
+ declare function MethodBadge({ method }: {
36
+ method: HttpMethod;
37
+ }): react_jsx_runtime.JSX.Element;
38
+ declare function InlineCode({ children }: {
39
+ children: ReactNode;
40
+ }): react_jsx_runtime.JSX.Element;
41
+ declare function SectionHeading({ id, children }: {
42
+ id: string;
43
+ children: ReactNode;
44
+ }): react_jsx_runtime.JSX.Element;
45
+ declare function SubHeading({ id, children }: {
46
+ id: string;
47
+ children: ReactNode;
48
+ }): react_jsx_runtime.JSX.Element;
49
+ declare function Callout({ type, children }: {
50
+ type?: 'info' | 'warning';
51
+ children: ReactNode;
52
+ }): react_jsx_runtime.JSX.Element;
53
+ declare function P({ children }: {
54
+ children: ReactNode;
55
+ }): react_jsx_runtime.JSX.Element;
56
+ declare function ParamTable({ params, title, }: {
57
+ params: Param[];
58
+ title?: string;
59
+ }): react_jsx_runtime.JSX.Element;
60
+ declare function EndpointBlock({ method, path, summary, description, children, }: {
61
+ method: HttpMethod;
62
+ path: string;
63
+ summary: string;
64
+ description?: string;
65
+ children?: ReactNode;
66
+ }): react_jsx_runtime.JSX.Element;
67
+ declare function UiExcerpt({ title, caption, children }: {
68
+ title: string;
69
+ caption?: string;
70
+ children: ReactNode;
71
+ }): react_jsx_runtime.JSX.Element;
72
+ declare function TierBadge({ tier }: {
73
+ tier: 1 | 2 | 3;
74
+ }): react_jsx_runtime.JSX.Element;
75
+ declare function CellDot({ color, label }: {
76
+ color: string;
77
+ label: string;
78
+ }): react_jsx_runtime.JSX.Element;
79
+ declare function MockNavItem({ label, active, indent }: {
80
+ label: string;
81
+ active?: boolean;
82
+ indent?: boolean;
83
+ }): react_jsx_runtime.JSX.Element;
84
+ declare function PipelineStage({ label, state }: {
85
+ label: string;
86
+ state: 'done' | 'active' | 'pending';
87
+ }): react_jsx_runtime.JSX.Element;
88
+ declare function PipelineConnector({ done }: {
89
+ done?: boolean;
90
+ }): react_jsx_runtime.JSX.Element;
91
+
92
+ /**
93
+ * Link component type — allows consumers to inject their
94
+ * framework's link component (e.g. Next.js Link).
95
+ */
96
+ type LinkComponent = (props: {
97
+ href: string;
98
+ className?: string;
99
+ children: ReactNode;
100
+ }) => ReactNode;
101
+ declare function Sidebar({ title, sections, activeId, onNavigate, mobileOpen, onMobileClose, footerLinks, LinkComponent: Link, }: {
102
+ title: string;
103
+ sections: NavSection[];
104
+ activeId: string;
105
+ onNavigate: (id: string) => void;
106
+ mobileOpen: boolean;
107
+ onMobileClose: () => void;
108
+ footerLinks?: {
109
+ label: string;
110
+ href: string;
111
+ }[];
112
+ LinkComponent?: LinkComponent;
113
+ }): react_jsx_runtime.JSX.Element;
114
+
115
+ /** Comprehensive API reference documentation for the Talonic platform. */
116
+ declare function ApiReference({ LinkComponent }: {
117
+ LinkComponent?: LinkComponent;
118
+ }): react_jsx_runtime.JSX.Element;
119
+
120
+ /** Comprehensive platform guide covering every feature of the Talonic platform. */
121
+ declare function PlatformGuide({ LinkComponent }: {
122
+ LinkComponent?: LinkComponent;
123
+ }): react_jsx_runtime.JSX.Element;
124
+
125
+ /**
126
+ * SEO metadata, navigation data, and machine-readable content exports
127
+ * for @talonic/docs consumers to build sitemaps, JSON-LD, llms.txt, etc.
128
+ */
129
+
130
+ declare const API_NAV_SECTIONS: NavSection[];
131
+ declare const PLATFORM_NAV_SECTIONS: NavSection[];
132
+ interface SectionMeta {
133
+ id: string;
134
+ title: string;
135
+ description: string;
136
+ }
137
+ declare const API_SECTION_META: SectionMeta[];
138
+ declare const PLATFORM_SECTION_META: SectionMeta[];
139
+ declare const OPENAPI_SPEC: {
140
+ openapi: string;
141
+ info: {
142
+ title: string;
143
+ version: string;
144
+ description: string;
145
+ contact: {
146
+ url: string;
147
+ };
148
+ };
149
+ servers: {
150
+ url: string;
151
+ description: string;
152
+ }[];
153
+ security: {
154
+ bearerAuth: never[];
155
+ }[];
156
+ components: {
157
+ securitySchemes: {
158
+ bearerAuth: {
159
+ type: "http";
160
+ scheme: string;
161
+ description: string;
162
+ };
163
+ };
164
+ };
165
+ paths: {
166
+ '/v1/extract': {
167
+ post: {
168
+ operationId: string;
169
+ summary: string;
170
+ description: string;
171
+ tags: string[];
172
+ requestBody: {
173
+ content: {
174
+ 'multipart/form-data': {
175
+ schema: {
176
+ type: string;
177
+ properties: {
178
+ file: {
179
+ type: string;
180
+ format: string;
181
+ description: string;
182
+ };
183
+ file_url: {
184
+ type: string;
185
+ description: string;
186
+ };
187
+ document_id: {
188
+ type: string;
189
+ description: string;
190
+ };
191
+ schema: {
192
+ type: string;
193
+ description: string;
194
+ };
195
+ schema_id: {
196
+ type: string;
197
+ description: string;
198
+ };
199
+ instructions: {
200
+ type: string;
201
+ description: string;
202
+ };
203
+ include_markdown: {
204
+ type: string;
205
+ description: string;
206
+ };
207
+ };
208
+ };
209
+ };
210
+ };
211
+ };
212
+ responses: {
213
+ '200': {
214
+ description: string;
215
+ };
216
+ '202': {
217
+ description: string;
218
+ };
219
+ };
220
+ };
221
+ };
222
+ '/v1/documents': {
223
+ get: {
224
+ operationId: string;
225
+ summary: string;
226
+ tags: string[];
227
+ parameters: ({
228
+ name: string;
229
+ in: string;
230
+ schema: {
231
+ type: string;
232
+ enum?: undefined;
233
+ default?: undefined;
234
+ };
235
+ } | {
236
+ name: string;
237
+ in: string;
238
+ schema: {
239
+ type: string;
240
+ enum: string[];
241
+ default?: undefined;
242
+ };
243
+ } | {
244
+ name: string;
245
+ in: string;
246
+ schema: {
247
+ type: string;
248
+ default: number;
249
+ enum?: undefined;
250
+ };
251
+ })[];
252
+ responses: {
253
+ '200': {
254
+ description: string;
255
+ };
256
+ };
257
+ };
258
+ };
259
+ '/v1/documents/{id}': {
260
+ get: {
261
+ operationId: string;
262
+ summary: string;
263
+ tags: string[];
264
+ parameters: {
265
+ name: string;
266
+ in: string;
267
+ required: boolean;
268
+ schema: {
269
+ type: string;
270
+ };
271
+ }[];
272
+ responses: {
273
+ '200': {
274
+ description: string;
275
+ };
276
+ };
277
+ };
278
+ delete: {
279
+ operationId: string;
280
+ summary: string;
281
+ tags: string[];
282
+ parameters: {
283
+ name: string;
284
+ in: string;
285
+ required: boolean;
286
+ schema: {
287
+ type: string;
288
+ };
289
+ }[];
290
+ responses: {
291
+ '200': {
292
+ description: string;
293
+ };
294
+ };
295
+ };
296
+ };
297
+ '/v1/documents/{id}/markdown': {
298
+ get: {
299
+ operationId: string;
300
+ summary: string;
301
+ tags: string[];
302
+ parameters: {
303
+ name: string;
304
+ in: string;
305
+ required: boolean;
306
+ schema: {
307
+ type: string;
308
+ };
309
+ }[];
310
+ responses: {
311
+ '200': {
312
+ description: string;
313
+ };
314
+ };
315
+ };
316
+ };
317
+ '/v1/extractions': {
318
+ get: {
319
+ operationId: string;
320
+ summary: string;
321
+ tags: string[];
322
+ parameters: ({
323
+ name: string;
324
+ in: string;
325
+ schema: {
326
+ type: string;
327
+ default?: undefined;
328
+ };
329
+ } | {
330
+ name: string;
331
+ in: string;
332
+ schema: {
333
+ type: string;
334
+ default: number;
335
+ };
336
+ })[];
337
+ responses: {
338
+ '200': {
339
+ description: string;
340
+ };
341
+ };
342
+ };
343
+ };
344
+ '/v1/extractions/{id}': {
345
+ get: {
346
+ operationId: string;
347
+ summary: string;
348
+ tags: string[];
349
+ parameters: {
350
+ name: string;
351
+ in: string;
352
+ required: boolean;
353
+ schema: {
354
+ type: string;
355
+ };
356
+ }[];
357
+ responses: {
358
+ '200': {
359
+ description: string;
360
+ };
361
+ };
362
+ };
363
+ };
364
+ '/v1/extractions/{id}/data': {
365
+ get: {
366
+ operationId: string;
367
+ summary: string;
368
+ tags: string[];
369
+ parameters: ({
370
+ name: string;
371
+ in: string;
372
+ required: boolean;
373
+ schema: {
374
+ type: string;
375
+ default?: undefined;
376
+ };
377
+ } | {
378
+ name: string;
379
+ in: string;
380
+ schema: {
381
+ type: string;
382
+ default: string;
383
+ };
384
+ required?: undefined;
385
+ })[];
386
+ responses: {
387
+ '200': {
388
+ description: string;
389
+ };
390
+ };
391
+ };
392
+ patch: {
393
+ operationId: string;
394
+ summary: string;
395
+ tags: string[];
396
+ parameters: {
397
+ name: string;
398
+ in: string;
399
+ required: boolean;
400
+ schema: {
401
+ type: string;
402
+ };
403
+ }[];
404
+ responses: {
405
+ '200': {
406
+ description: string;
407
+ };
408
+ };
409
+ };
410
+ };
411
+ '/v1/schemas': {
412
+ get: {
413
+ operationId: string;
414
+ summary: string;
415
+ tags: string[];
416
+ responses: {
417
+ '200': {
418
+ description: string;
419
+ };
420
+ };
421
+ };
422
+ post: {
423
+ operationId: string;
424
+ summary: string;
425
+ tags: string[];
426
+ responses: {
427
+ '201': {
428
+ description: string;
429
+ };
430
+ };
431
+ };
432
+ };
433
+ '/v1/schemas/{id}': {
434
+ get: {
435
+ operationId: string;
436
+ summary: string;
437
+ tags: string[];
438
+ parameters: {
439
+ name: string;
440
+ in: string;
441
+ required: boolean;
442
+ schema: {
443
+ type: string;
444
+ };
445
+ }[];
446
+ responses: {
447
+ '200': {
448
+ description: string;
449
+ };
450
+ };
451
+ };
452
+ put: {
453
+ operationId: string;
454
+ summary: string;
455
+ tags: string[];
456
+ parameters: {
457
+ name: string;
458
+ in: string;
459
+ required: boolean;
460
+ schema: {
461
+ type: string;
462
+ };
463
+ }[];
464
+ responses: {
465
+ '200': {
466
+ description: string;
467
+ };
468
+ };
469
+ };
470
+ delete: {
471
+ operationId: string;
472
+ summary: string;
473
+ tags: string[];
474
+ parameters: {
475
+ name: string;
476
+ in: string;
477
+ required: boolean;
478
+ schema: {
479
+ type: string;
480
+ };
481
+ }[];
482
+ responses: {
483
+ '200': {
484
+ description: string;
485
+ };
486
+ };
487
+ };
488
+ };
489
+ '/v1/jobs': {
490
+ get: {
491
+ operationId: string;
492
+ summary: string;
493
+ tags: string[];
494
+ responses: {
495
+ '200': {
496
+ description: string;
497
+ };
498
+ };
499
+ };
500
+ };
501
+ '/v1/jobs/{id}': {
502
+ get: {
503
+ operationId: string;
504
+ summary: string;
505
+ tags: string[];
506
+ parameters: {
507
+ name: string;
508
+ in: string;
509
+ required: boolean;
510
+ schema: {
511
+ type: string;
512
+ };
513
+ }[];
514
+ responses: {
515
+ '200': {
516
+ description: string;
517
+ };
518
+ };
519
+ };
520
+ };
521
+ '/v1/jobs/{id}/cancel': {
522
+ post: {
523
+ operationId: string;
524
+ summary: string;
525
+ tags: string[];
526
+ parameters: {
527
+ name: string;
528
+ in: string;
529
+ required: boolean;
530
+ schema: {
531
+ type: string;
532
+ };
533
+ }[];
534
+ responses: {
535
+ '200': {
536
+ description: string;
537
+ };
538
+ };
539
+ };
540
+ };
541
+ '/v1/sources': {
542
+ get: {
543
+ operationId: string;
544
+ summary: string;
545
+ tags: string[];
546
+ responses: {
547
+ '200': {
548
+ description: string;
549
+ };
550
+ };
551
+ };
552
+ post: {
553
+ operationId: string;
554
+ summary: string;
555
+ tags: string[];
556
+ responses: {
557
+ '201': {
558
+ description: string;
559
+ };
560
+ };
561
+ };
562
+ };
563
+ '/v1/sources/{id}': {
564
+ get: {
565
+ operationId: string;
566
+ summary: string;
567
+ tags: string[];
568
+ parameters: {
569
+ name: string;
570
+ in: string;
571
+ required: boolean;
572
+ schema: {
573
+ type: string;
574
+ };
575
+ }[];
576
+ responses: {
577
+ '200': {
578
+ description: string;
579
+ };
580
+ };
581
+ };
582
+ patch: {
583
+ operationId: string;
584
+ summary: string;
585
+ tags: string[];
586
+ parameters: {
587
+ name: string;
588
+ in: string;
589
+ required: boolean;
590
+ schema: {
591
+ type: string;
592
+ };
593
+ }[];
594
+ responses: {
595
+ '200': {
596
+ description: string;
597
+ };
598
+ };
599
+ };
600
+ delete: {
601
+ operationId: string;
602
+ summary: string;
603
+ tags: string[];
604
+ parameters: {
605
+ name: string;
606
+ in: string;
607
+ required: boolean;
608
+ schema: {
609
+ type: string;
610
+ };
611
+ }[];
612
+ responses: {
613
+ '200': {
614
+ description: string;
615
+ };
616
+ };
617
+ };
618
+ };
619
+ '/v1/sources/{id}/documents': {
620
+ get: {
621
+ operationId: string;
622
+ summary: string;
623
+ tags: string[];
624
+ parameters: {
625
+ name: string;
626
+ in: string;
627
+ required: boolean;
628
+ schema: {
629
+ type: string;
630
+ };
631
+ }[];
632
+ responses: {
633
+ '200': {
634
+ description: string;
635
+ };
636
+ };
637
+ };
638
+ post: {
639
+ operationId: string;
640
+ summary: string;
641
+ tags: string[];
642
+ parameters: {
643
+ name: string;
644
+ in: string;
645
+ required: boolean;
646
+ schema: {
647
+ type: string;
648
+ };
649
+ }[];
650
+ responses: {
651
+ '200': {
652
+ description: string;
653
+ };
654
+ };
655
+ };
656
+ };
657
+ };
658
+ };
659
+ declare const API_FAQ: {
660
+ question: string;
661
+ answer: string;
662
+ }[];
663
+ declare const PLATFORM_FAQ: {
664
+ question: string;
665
+ answer: string;
666
+ }[];
667
+ declare const LLMS_TXT = "# Talonic\n\n> Extract any document into schema-validated data with a single API call.\n\nTalonic is an AI-powered document structuring platform. It ingests unstructured documents (PDFs, scans, images, spreadsheets), discovers fields through semantic clustering, and produces structured datasets with per-cell provenance, confidence scores, and reasoning traces.\n\n## Documentation\n\n- [API Documentation](https://talonic.com/docs): Complete REST API reference\n- [Platform Guide](https://talonic.com/docs/platform): Product documentation and feature guide\n- [OpenAPI Spec](https://talonic.com/docs/openapi.json): Machine-readable API specification\n\n## API Quick Start\n\nBase URL: https://api.talonic.com\nAuth: Bearer token (tlnc_ prefix)\n\nExtract a document:\n```\ncurl -X POST https://api.talonic.com/v1/extract \\\n -H \"Authorization: Bearer tlnc_sk_live_...\" \\\n -F \"file=@document.pdf\" \\\n -F 'schema={\"vendor_name\":\"string\",\"total\":\"number\"}'\n```\n\n## Key Endpoints\n\n- POST /v1/extract \u2014 Extract structured data from a document\n- GET /v1/documents \u2014 List and manage documents\n- GET /v1/extractions \u2014 Query extraction results\n- POST /v1/schemas \u2014 Create reusable extraction schemas\n- GET /v1/jobs \u2014 Track async extraction jobs\n- POST /v1/sources \u2014 Manage document sources with API keys\n\n## Platform Features\n\n- 25+ file format support (PDF, DOCX, images, spreadsheets, archives)\n- Field Registry: unified knowledge graph of canonical fields with tier system\n- 4-phase extraction pipeline: Resolve \u2192 Agent \u2192 Validate \u2192 Re-read\n- Document linking and case discovery through shared entities\n- Validation checks, golden samples, and approval gates\n- Export to webhooks, REST APIs, SFTP, email, cloud storage\n- HMAC-SHA256 signed webhooks with retry policy\n\n## Optional\n\n- [API Documentation (Markdown)](https://talonic.com/docs/api.md)\n- [Platform Guide (Markdown)](https://talonic.com/docs/platform.md)\n";
668
+ declare const LLMS_FULL_TXT_HEADER = "# Talonic \u2014 Full Documentation\n\n> This file contains the complete Talonic documentation for LLM consumption.\n> For a summary, see llms.txt.\n\n";
669
+
670
+ export { API_FAQ, API_NAV_SECTIONS, API_SECTION_META, ApiReference, Callout, CellDot, CodeBlock, DownloadMarkdown, EndpointBlock, type HttpMethod, InlineCode, LLMS_FULL_TXT_HEADER, LLMS_TXT, type LinkComponent, MethodBadge, MockNavItem, type NavSection, OPENAPI_SPEC, P, PLATFORM_FAQ, PLATFORM_NAV_SECTIONS, PLATFORM_SECTION_META, type Param, ParamTable, PipelineConnector, PipelineStage, PlatformGuide, SectionHeading, type SectionMeta, Sidebar, SubHeading, TierBadge, UiExcerpt, highlightJson };