@openpkg-ts/react 0.2.0 → 0.2.1
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.
- package/dist/index.js +1 -1
- package/dist/shared/{chunk-0h2j0jvb.js → chunk-j3c78zxw.js} +3 -3
- package/dist/styled.d.ts +88 -88
- package/dist/styled.js +11 -13
- package/package.json +6 -6
package/dist/index.js
CHANGED
|
@@ -18,8 +18,8 @@ var __toESM = (mod, isNodeMode, target) => {
|
|
|
18
18
|
var __commonJS = (cb, mod) => () => (mod || cb((mod = { exports: {} }).exports, mod), mod.exports);
|
|
19
19
|
|
|
20
20
|
// src/components/headless/CollapsibleMethod.tsx
|
|
21
|
+
import { formatReturnType, formatSchema, getMemberBadges } from "@openpkg-ts/sdk";
|
|
21
22
|
import { useEffect, useState } from "react";
|
|
22
|
-
import { getMemberBadges, formatReturnType, formatSchema } from "@openpkg-ts/sdk";
|
|
23
23
|
import { jsx, jsxs } from "react/jsx-runtime";
|
|
24
24
|
|
|
25
25
|
function formatParamPreview(params) {
|
|
@@ -220,8 +220,8 @@ function ExampleBlock({
|
|
|
220
220
|
}
|
|
221
221
|
|
|
222
222
|
// src/components/headless/ExpandableProperty.tsx
|
|
223
|
-
import { useState as useState3 } from "react";
|
|
224
223
|
import { formatSchema as formatSchema2 } from "@openpkg-ts/sdk";
|
|
224
|
+
import { useState as useState3 } from "react";
|
|
225
225
|
import { jsx as jsx3, jsxs as jsxs3 } from "react/jsx-runtime";
|
|
226
226
|
|
|
227
227
|
function getNestedProperties(schema) {
|
|
@@ -365,7 +365,7 @@ function ExpandableProperty({
|
|
|
365
365
|
}
|
|
366
366
|
|
|
367
367
|
// src/components/headless/MembersTable.tsx
|
|
368
|
-
import {
|
|
368
|
+
import { formatSchema as formatSchema3, getMemberBadges as getMemberBadges2 } from "@openpkg-ts/sdk";
|
|
369
369
|
import { jsx as jsx4, jsxs as jsxs4 } from "react/jsx-runtime";
|
|
370
370
|
|
|
371
371
|
function groupMembersByKind(members) {
|
package/dist/styled.d.ts
CHANGED
|
@@ -1,3 +1,31 @@
|
|
|
1
|
+
import { OpenPkg, SpecExample, SpecExport, SpecSchema, SpecSignatureParameter } from "@openpkg-ts/spec";
|
|
2
|
+
import { APIParameterSchema, CodeExample, Language } from "@openpkg-ts/ui/docskit";
|
|
3
|
+
/**
|
|
4
|
+
* Convert SpecSchema to APIParameterSchema for nested object display.
|
|
5
|
+
*/
|
|
6
|
+
declare function specSchemaToAPISchema(schema: SpecSchema | undefined): APIParameterSchema | undefined;
|
|
7
|
+
/**
|
|
8
|
+
* Convert a SpecSignatureParameter to APIParameterItem props.
|
|
9
|
+
*/
|
|
10
|
+
declare function specParamToAPIParam(param: SpecSignatureParameter): {
|
|
11
|
+
name: string;
|
|
12
|
+
type: string;
|
|
13
|
+
required: boolean;
|
|
14
|
+
description?: string;
|
|
15
|
+
children?: APIParameterSchema;
|
|
16
|
+
};
|
|
17
|
+
/**
|
|
18
|
+
* Convert SpecExample[] to CodeExample[] for APICodePanel.
|
|
19
|
+
*/
|
|
20
|
+
declare function specExamplesToCodeExamples(examples: SpecExample[] | undefined, defaultLang?: string): CodeExample[];
|
|
21
|
+
/**
|
|
22
|
+
* Extract unique languages from examples for language selector.
|
|
23
|
+
*/
|
|
24
|
+
declare function getLanguagesFromExamples(examples: SpecExample[] | undefined): Language[];
|
|
25
|
+
/**
|
|
26
|
+
* Build import statement for an export.
|
|
27
|
+
*/
|
|
28
|
+
declare function buildImportStatement(exp: SpecExport, spec: OpenPkg): string;
|
|
1
29
|
import { SpecMember } from "@openpkg-ts/spec";
|
|
2
30
|
interface CollapsibleMethodProps {
|
|
3
31
|
/** Method member to display */
|
|
@@ -28,27 +56,27 @@ interface CollapsibleMethodProps {
|
|
|
28
56
|
* ```
|
|
29
57
|
*/
|
|
30
58
|
declare function CollapsibleMethod({ member, defaultExpanded, className, renderHeader, renderContent }: CollapsibleMethodProps): React.ReactNode;
|
|
31
|
-
import { SpecExample } from "@openpkg-ts/spec";
|
|
59
|
+
import { SpecExample as SpecExample2 } from "@openpkg-ts/spec";
|
|
32
60
|
interface ExampleBlockProps {
|
|
33
61
|
/** Examples to display (string or SpecExample) */
|
|
34
|
-
examples: (string |
|
|
62
|
+
examples: (string | SpecExample2)[];
|
|
35
63
|
/** Custom className */
|
|
36
64
|
className?: string;
|
|
37
65
|
/** Custom example renderer */
|
|
38
|
-
renderExample?: (example: string |
|
|
66
|
+
renderExample?: (example: string | SpecExample2, index: number) => React.ReactNode;
|
|
39
67
|
}
|
|
40
68
|
/**
|
|
41
69
|
* Normalize example to string content.
|
|
42
70
|
*/
|
|
43
|
-
declare function getExampleCode(example: string |
|
|
71
|
+
declare function getExampleCode(example: string | SpecExample2): string;
|
|
44
72
|
/**
|
|
45
73
|
* Get example title if available.
|
|
46
74
|
*/
|
|
47
|
-
declare function getExampleTitle(example: string |
|
|
75
|
+
declare function getExampleTitle(example: string | SpecExample2): string | undefined;
|
|
48
76
|
/**
|
|
49
77
|
* Get example language.
|
|
50
78
|
*/
|
|
51
|
-
declare function getExampleLanguage(example: string |
|
|
79
|
+
declare function getExampleLanguage(example: string | SpecExample2): string;
|
|
52
80
|
/**
|
|
53
81
|
* Clean code by removing markdown fences.
|
|
54
82
|
*/
|
|
@@ -68,10 +96,10 @@ declare function cleanCode(code: string): string;
|
|
|
68
96
|
* ```
|
|
69
97
|
*/
|
|
70
98
|
declare function ExampleBlock({ examples, className, renderExample }: ExampleBlockProps): React.ReactNode;
|
|
71
|
-
import { SpecSchema, SpecSignatureParameter } from "@openpkg-ts/spec";
|
|
99
|
+
import { SpecSchema as SpecSchema2, SpecSignatureParameter as SpecSignatureParameter2 } from "@openpkg-ts/spec";
|
|
72
100
|
interface ExpandablePropertyProps {
|
|
73
101
|
/** Parameter to display */
|
|
74
|
-
param:
|
|
102
|
+
param: SpecSignatureParameter2;
|
|
75
103
|
/** Nesting depth */
|
|
76
104
|
depth?: number;
|
|
77
105
|
/** Custom className */
|
|
@@ -81,7 +109,7 @@ interface NestedPropertyProps {
|
|
|
81
109
|
/** Property name */
|
|
82
110
|
name: string;
|
|
83
111
|
/** Property schema */
|
|
84
|
-
schema:
|
|
112
|
+
schema: SpecSchema2;
|
|
85
113
|
/** Is required */
|
|
86
114
|
required?: boolean;
|
|
87
115
|
/** Nesting depth */
|
|
@@ -138,19 +166,19 @@ declare function MemberRow({ member }: MemberRowProps): React.ReactNode;
|
|
|
138
166
|
* ```
|
|
139
167
|
*/
|
|
140
168
|
declare function MembersTable({ members, className, groupByKind, renderMember }: MembersTableProps): React.ReactNode;
|
|
141
|
-
import { SpecMember as SpecMember3, SpecSignatureParameter as
|
|
169
|
+
import { SpecMember as SpecMember3, SpecSignatureParameter as SpecSignatureParameter3 } from "@openpkg-ts/spec";
|
|
142
170
|
interface ParamTableProps {
|
|
143
171
|
/** Parameters or members to display */
|
|
144
|
-
items: (
|
|
172
|
+
items: (SpecSignatureParameter3 | SpecMember3)[];
|
|
145
173
|
/** Show required indicator */
|
|
146
174
|
showRequired?: boolean;
|
|
147
175
|
/** Custom className */
|
|
148
176
|
className?: string;
|
|
149
177
|
/** Render custom row */
|
|
150
|
-
renderRow?: (item:
|
|
178
|
+
renderRow?: (item: SpecSignatureParameter3 | SpecMember3, index: number) => React.ReactNode;
|
|
151
179
|
}
|
|
152
180
|
interface ParamRowProps {
|
|
153
|
-
item:
|
|
181
|
+
item: SpecSignatureParameter3 | SpecMember3;
|
|
154
182
|
showRequired?: boolean;
|
|
155
183
|
}
|
|
156
184
|
/**
|
|
@@ -172,10 +200,10 @@ declare function ParamRow({ item, showRequired }: ParamRowProps): React.ReactNod
|
|
|
172
200
|
* ```
|
|
173
201
|
*/
|
|
174
202
|
declare function ParamTable({ items, showRequired, className, renderRow }: ParamTableProps): React.ReactNode;
|
|
175
|
-
import { SpecExport } from "@openpkg-ts/spec";
|
|
203
|
+
import { SpecExport as SpecExport2 } from "@openpkg-ts/spec";
|
|
176
204
|
interface SignatureProps {
|
|
177
205
|
/** The to render signature for */
|
|
178
|
-
export:
|
|
206
|
+
export: SpecExport2;
|
|
179
207
|
/** Index of signature to render (for overloaded functions) */
|
|
180
208
|
signatureIndex?: number;
|
|
181
209
|
/** Custom className */
|
|
@@ -198,16 +226,16 @@ interface SignatureProps {
|
|
|
198
226
|
* ```
|
|
199
227
|
*/
|
|
200
228
|
declare function Signature({ export: exp, signatureIndex, className, children }: SignatureProps): React.ReactNode;
|
|
201
|
-
import { SpecMember as SpecMember4, SpecSignatureParameter as
|
|
229
|
+
import { SpecMember as SpecMember4, SpecSignatureParameter as SpecSignatureParameter4 } from "@openpkg-ts/spec";
|
|
202
230
|
interface TypeTableProps {
|
|
203
231
|
/** Members or parameters to display */
|
|
204
|
-
items: (
|
|
232
|
+
items: (SpecSignatureParameter4 | SpecMember4)[];
|
|
205
233
|
/** Show required indicator */
|
|
206
234
|
showRequired?: boolean;
|
|
207
235
|
/** Custom className */
|
|
208
236
|
className?: string;
|
|
209
237
|
/** Render custom row */
|
|
210
|
-
renderRow?: (item:
|
|
238
|
+
renderRow?: (item: SpecSignatureParameter4 | SpecMember4, index: number) => React.ReactNode;
|
|
211
239
|
}
|
|
212
240
|
/**
|
|
213
241
|
* Headless type table for displaying interface/type members.
|
|
@@ -219,11 +247,11 @@ interface TypeTableProps {
|
|
|
219
247
|
*/
|
|
220
248
|
declare function TypeTable({ items, showRequired, className, renderRow }: TypeTableProps): React.ReactNode;
|
|
221
249
|
import { CodeTab, CodeTabs, CodeTabsProps, ImportSection, ImportSectionProps } from "@openpkg-ts/ui/api";
|
|
222
|
-
import { OpenPkg } from "@openpkg-ts/spec";
|
|
223
250
|
import { DocsInstance } from "@openpkg-ts/sdk";
|
|
251
|
+
import { OpenPkg as OpenPkg2 } from "@openpkg-ts/spec";
|
|
224
252
|
interface APIPageProps {
|
|
225
253
|
/** Direct spec object */
|
|
226
|
-
spec?:
|
|
254
|
+
spec?: OpenPkg2;
|
|
227
255
|
/** Or docs instance from createDocs() */
|
|
228
256
|
instance?: DocsInstance;
|
|
229
257
|
/** Export ID to render, or undefined for index page */
|
|
@@ -254,22 +282,22 @@ interface APIPageProps {
|
|
|
254
282
|
* ```
|
|
255
283
|
*/
|
|
256
284
|
declare function APIPage({ spec, instance, id, baseHref, description, renderExample }: APIPageProps): React.ReactNode;
|
|
257
|
-
import { OpenPkg as
|
|
285
|
+
import { OpenPkg as OpenPkg3, SpecExport as SpecExport3 } from "@openpkg-ts/spec";
|
|
258
286
|
import { ReactNode as ReactNode2 } from "react";
|
|
259
287
|
interface ClassPageProps {
|
|
260
|
-
export:
|
|
261
|
-
spec:
|
|
288
|
+
export: SpecExport3;
|
|
289
|
+
spec: OpenPkg3;
|
|
262
290
|
}
|
|
263
291
|
/**
|
|
264
292
|
* Stripe-style class page with two-column layout.
|
|
265
293
|
* Left: constructor, methods, properties. Right: sticky code examples.
|
|
266
294
|
*/
|
|
267
295
|
declare function ClassPage({ export: exp, spec }: ClassPageProps): ReactNode2;
|
|
268
|
-
import { OpenPkg as
|
|
296
|
+
import { OpenPkg as OpenPkg4, SpecExport as SpecExport4 } from "@openpkg-ts/spec";
|
|
269
297
|
import { ReactNode as ReactNode3 } from "react";
|
|
270
298
|
interface EnumPageProps {
|
|
271
|
-
export:
|
|
272
|
-
spec:
|
|
299
|
+
export: SpecExport4;
|
|
300
|
+
spec: OpenPkg4;
|
|
273
301
|
}
|
|
274
302
|
/**
|
|
275
303
|
* Stripe-style enum page with two-column layout.
|
|
@@ -292,11 +320,11 @@ interface ExportCardProps {
|
|
|
292
320
|
* Features function name styling, description, and hover effects.
|
|
293
321
|
*/
|
|
294
322
|
declare function ExportCard({ name, description, href, kind, className }: ExportCardProps): React.ReactNode;
|
|
295
|
-
import { OpenPkg as
|
|
323
|
+
import { OpenPkg as OpenPkg5 } from "@openpkg-ts/spec";
|
|
296
324
|
import { ReactNode as ReactNode4 } from "react";
|
|
297
325
|
interface ExportIndexPageProps {
|
|
298
326
|
/** OpenPkg spec */
|
|
299
|
-
spec:
|
|
327
|
+
spec: OpenPkg5;
|
|
300
328
|
/** Base href for links (e.g., '/docs/api') */
|
|
301
329
|
baseHref: string;
|
|
302
330
|
/** Optional intro description */
|
|
@@ -313,11 +341,11 @@ interface ExportIndexPageProps {
|
|
|
313
341
|
* AI SDK-style clean layout with responsive 2-column grid.
|
|
314
342
|
*/
|
|
315
343
|
declare function ExportIndexPage({ spec, baseHref, description, className, showSearch, showFilters }: ExportIndexPageProps): ReactNode4;
|
|
316
|
-
import { OpenPkg as
|
|
344
|
+
import { OpenPkg as OpenPkg6, SpecExportKind } from "@openpkg-ts/spec";
|
|
317
345
|
import { ReactNode as ReactNode5 } from "react";
|
|
318
346
|
interface FullAPIReferencePageProps {
|
|
319
347
|
/** OpenPkg spec */
|
|
320
|
-
spec:
|
|
348
|
+
spec: OpenPkg6;
|
|
321
349
|
/** Filter to specific kinds (default: all) */
|
|
322
350
|
kinds?: SpecExportKind[];
|
|
323
351
|
/** Show kind filter buttons (default: true) */
|
|
@@ -348,32 +376,32 @@ interface FullAPIReferencePageProps {
|
|
|
348
376
|
* ```
|
|
349
377
|
*/
|
|
350
378
|
declare function FullAPIReferencePage({ spec, kinds, showFilters, showTOC, title, description, className }: FullAPIReferencePageProps): ReactNode5;
|
|
351
|
-
import { OpenPkg as
|
|
379
|
+
import { OpenPkg as OpenPkg7, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
|
|
352
380
|
import { ReactNode as ReactNode6 } from "react";
|
|
353
381
|
interface FunctionPageProps {
|
|
354
|
-
export:
|
|
355
|
-
spec:
|
|
382
|
+
export: SpecExport5;
|
|
383
|
+
spec: OpenPkg7;
|
|
356
384
|
}
|
|
357
385
|
/**
|
|
358
386
|
* Stripe-style function page with two-column layout.
|
|
359
387
|
* Left: parameters, returns. Right: sticky code examples.
|
|
360
388
|
*/
|
|
361
389
|
declare function FunctionPage({ export: exp, spec }: FunctionPageProps): ReactNode6;
|
|
362
|
-
import { OpenPkg as
|
|
390
|
+
import { OpenPkg as OpenPkg8, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
|
|
363
391
|
import { ReactNode as ReactNode7 } from "react";
|
|
364
392
|
interface InterfacePageProps {
|
|
365
|
-
export:
|
|
366
|
-
spec:
|
|
393
|
+
export: SpecExport6;
|
|
394
|
+
spec: OpenPkg8;
|
|
367
395
|
}
|
|
368
396
|
/**
|
|
369
397
|
* Stripe-style interface/type page with two-column layout.
|
|
370
398
|
* Left: properties, methods. Right: sticky code examples.
|
|
371
399
|
*/
|
|
372
400
|
declare function InterfacePage({ export: exp, spec }: InterfacePageProps): ReactNode7;
|
|
373
|
-
import { SpecSchema as
|
|
401
|
+
import { SpecSchema as SpecSchema3, SpecSignatureParameter as SpecSignatureParameter5 } from "@openpkg-ts/spec";
|
|
374
402
|
interface ParameterItemProps {
|
|
375
403
|
/** Parameter to display */
|
|
376
|
-
param:
|
|
404
|
+
param: SpecSignatureParameter5;
|
|
377
405
|
/** Nesting depth for indentation */
|
|
378
406
|
depth?: number;
|
|
379
407
|
/** Custom className */
|
|
@@ -383,7 +411,7 @@ interface NestedPropertyItemProps {
|
|
|
383
411
|
/** Property name */
|
|
384
412
|
name: string;
|
|
385
413
|
/** Property schema */
|
|
386
|
-
schema:
|
|
414
|
+
schema: SpecSchema3;
|
|
387
415
|
/** Is this property required */
|
|
388
416
|
required?: boolean;
|
|
389
417
|
/** Nesting depth */
|
|
@@ -397,108 +425,80 @@ interface NestedPropertyItemProps {
|
|
|
397
425
|
* Will be removed in next major version.
|
|
398
426
|
*/
|
|
399
427
|
declare function ParameterItem({ param, depth, className }: ParameterItemProps): React.ReactNode;
|
|
400
|
-
import { OpenPkg as
|
|
428
|
+
import { OpenPkg as OpenPkg9, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
|
|
401
429
|
import { ReactNode as ReactNode8 } from "react";
|
|
402
430
|
interface ClassSectionProps {
|
|
403
|
-
export:
|
|
404
|
-
spec:
|
|
431
|
+
export: SpecExport7;
|
|
432
|
+
spec: OpenPkg9;
|
|
405
433
|
}
|
|
406
434
|
/**
|
|
407
435
|
* Class section for use in single-page API reference.
|
|
408
436
|
* Renders an APISection with constructor, methods, and properties.
|
|
409
437
|
*/
|
|
410
438
|
declare function ClassSection({ export: exp, spec }: ClassSectionProps): ReactNode8;
|
|
411
|
-
import { OpenPkg as
|
|
439
|
+
import { OpenPkg as OpenPkg10, SpecExport as SpecExport8 } from "@openpkg-ts/spec";
|
|
412
440
|
import { ReactNode as ReactNode9 } from "react";
|
|
413
441
|
interface EnumSectionProps {
|
|
414
|
-
export:
|
|
415
|
-
spec:
|
|
442
|
+
export: SpecExport8;
|
|
443
|
+
spec: OpenPkg10;
|
|
416
444
|
}
|
|
417
445
|
/**
|
|
418
446
|
* Enum section for use in single-page API reference.
|
|
419
447
|
* Renders an APISection with enum members.
|
|
420
448
|
*/
|
|
421
449
|
declare function EnumSection({ export: exp, spec }: EnumSectionProps): ReactNode9;
|
|
422
|
-
import { OpenPkg as
|
|
450
|
+
import { OpenPkg as OpenPkg11, SpecExport as SpecExport9 } from "@openpkg-ts/spec";
|
|
423
451
|
import { ReactNode as ReactNode10 } from "react";
|
|
424
452
|
interface ExportSectionProps {
|
|
425
|
-
export:
|
|
426
|
-
spec:
|
|
453
|
+
export: SpecExport9;
|
|
454
|
+
spec: OpenPkg11;
|
|
427
455
|
}
|
|
428
456
|
/**
|
|
429
457
|
* Router component that renders the appropriate section based on kind.
|
|
430
458
|
* Used by FullAPIReferencePage to render each inline.
|
|
431
459
|
*/
|
|
432
460
|
declare function ExportSection({ export: exp, spec }: ExportSectionProps): ReactNode10;
|
|
433
|
-
import { OpenPkg as
|
|
461
|
+
import { OpenPkg as OpenPkg12, SpecExport as SpecExport10 } from "@openpkg-ts/spec";
|
|
434
462
|
import { ReactNode as ReactNode11 } from "react";
|
|
435
463
|
interface FunctionSectionProps {
|
|
436
|
-
export:
|
|
437
|
-
spec:
|
|
464
|
+
export: SpecExport10;
|
|
465
|
+
spec: OpenPkg12;
|
|
438
466
|
}
|
|
439
467
|
/**
|
|
440
468
|
* Function section for use in single-page API reference.
|
|
441
469
|
* Renders an APISection with parameters and returns.
|
|
442
470
|
*/
|
|
443
471
|
declare function FunctionSection({ export: exp, spec }: FunctionSectionProps): ReactNode11;
|
|
444
|
-
import { OpenPkg as
|
|
472
|
+
import { OpenPkg as OpenPkg13, SpecExport as SpecExport11 } from "@openpkg-ts/spec";
|
|
445
473
|
import { ReactNode as ReactNode12 } from "react";
|
|
446
474
|
interface InterfaceSectionProps {
|
|
447
|
-
export:
|
|
448
|
-
spec:
|
|
475
|
+
export: SpecExport11;
|
|
476
|
+
spec: OpenPkg13;
|
|
449
477
|
}
|
|
450
478
|
/**
|
|
451
479
|
* Interface/type section for use in single-page API reference.
|
|
452
480
|
* Renders an APISection with properties and methods.
|
|
453
481
|
*/
|
|
454
482
|
declare function InterfaceSection({ export: exp, spec }: InterfaceSectionProps): ReactNode12;
|
|
455
|
-
import { OpenPkg as
|
|
483
|
+
import { OpenPkg as OpenPkg14, SpecExport as SpecExport12 } from "@openpkg-ts/spec";
|
|
456
484
|
import { ReactNode as ReactNode13 } from "react";
|
|
457
485
|
interface VariableSectionProps {
|
|
458
|
-
export:
|
|
459
|
-
spec:
|
|
486
|
+
export: SpecExport12;
|
|
487
|
+
spec: OpenPkg14;
|
|
460
488
|
}
|
|
461
489
|
/**
|
|
462
490
|
* Variable/constant section for use in single-page API reference.
|
|
463
491
|
* Renders an APISection with type information.
|
|
464
492
|
*/
|
|
465
493
|
declare function VariableSection({ export: exp, spec }: VariableSectionProps): ReactNode13;
|
|
466
|
-
import { OpenPkg as
|
|
494
|
+
import { OpenPkg as OpenPkg15, SpecExport as SpecExport13 } from "@openpkg-ts/spec";
|
|
467
495
|
import { ReactNode as ReactNode14 } from "react";
|
|
468
496
|
interface VariablePageProps {
|
|
469
|
-
export:
|
|
470
|
-
spec:
|
|
497
|
+
export: SpecExport13;
|
|
498
|
+
spec: OpenPkg15;
|
|
471
499
|
}
|
|
472
500
|
/**
|
|
473
501
|
* Stripe-style variable/constant page with two-column layout.
|
|
474
502
|
*/
|
|
475
503
|
declare function VariablePage({ export: exp, spec }: VariablePageProps): ReactNode14;
|
|
476
|
-
import { OpenPkg as OpenPkg15, SpecExample as SpecExample2, SpecExport as SpecExport13, SpecSchema as SpecSchema3, SpecSignatureParameter as SpecSignatureParameter5 } from "@openpkg-ts/spec";
|
|
477
|
-
import { APIParameterSchema, CodeExample, Language } from "@openpkg-ts/ui/docskit";
|
|
478
|
-
/**
|
|
479
|
-
* Convert SpecSchema to APIParameterSchema for nested object display.
|
|
480
|
-
*/
|
|
481
|
-
declare function specSchemaToAPISchema(schema: SpecSchema3 | undefined): APIParameterSchema | undefined;
|
|
482
|
-
/**
|
|
483
|
-
* Convert a SpecSignatureParameter to APIParameterItem props.
|
|
484
|
-
*/
|
|
485
|
-
declare function specParamToAPIParam(param: SpecSignatureParameter5): {
|
|
486
|
-
name: string;
|
|
487
|
-
type: string;
|
|
488
|
-
required: boolean;
|
|
489
|
-
description?: string;
|
|
490
|
-
children?: APIParameterSchema;
|
|
491
|
-
};
|
|
492
|
-
/**
|
|
493
|
-
* Convert SpecExample[] to CodeExample[] for APICodePanel.
|
|
494
|
-
*/
|
|
495
|
-
declare function specExamplesToCodeExamples(examples: SpecExample2[] | undefined, defaultLang?: string): CodeExample[];
|
|
496
|
-
/**
|
|
497
|
-
* Extract unique languages from examples for language selector.
|
|
498
|
-
*/
|
|
499
|
-
declare function getLanguagesFromExamples(examples: SpecExample2[] | undefined): Language[];
|
|
500
|
-
/**
|
|
501
|
-
* Build import statement for an export.
|
|
502
|
-
*/
|
|
503
|
-
declare function buildImportStatement(exp: SpecExport13, spec: OpenPkg15): string;
|
|
504
504
|
export { specSchemaToAPISchema, specParamToAPIParam, specExamplesToCodeExamples, groupMembersByKind, getLanguagesFromExamples, getExampleTitle, getExampleLanguage, getExampleCode, cleanCode, buildImportStatement, VariableSectionProps, VariableSection, VariablePageProps, VariablePage, TypeTableProps, TypeTable, SignatureProps, Signature, ParameterItemProps, ParameterItem, ParamTableProps, ParamTable, ParamRowProps, ParamRow, NestedPropertyProps, NestedPropertyItemProps, NestedProperty, MembersTableProps, MembersTable, MemberRowProps, MemberRow, MemberGroups, InterfaceSectionProps, InterfaceSection, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, FunctionSectionProps, FunctionSection, FunctionPageProps, FunctionPage, FullAPIReferencePageProps, FullAPIReferencePage, ExportSectionProps, ExportSection, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, ExpandablePropertyProps, ExpandableProperty, ExampleBlockProps, ExampleBlock, EnumSectionProps, EnumSection, EnumPageProps, EnumPage, CollapsibleMethodProps, CollapsibleMethod, CodeTabsProps, CodeTabs, CodeTab, ClassSectionProps, ClassSection, ClassPageProps, ClassPage, APIPageProps, APIPage };
|
package/dist/styled.js
CHANGED
|
@@ -17,7 +17,7 @@ import {
|
|
|
17
17
|
getExampleLanguage,
|
|
18
18
|
getExampleTitle,
|
|
19
19
|
groupMembersByKind
|
|
20
|
-
} from "./shared/chunk-
|
|
20
|
+
} from "./shared/chunk-j3c78zxw.js";
|
|
21
21
|
|
|
22
22
|
// ../../node_modules/@swc/helpers/cjs/_interop_require_wildcard.cjs
|
|
23
23
|
var require__interop_require_wildcard = __commonJS((exports) => {
|
|
@@ -3165,14 +3165,6 @@ var require_link = __commonJS((exports, module) => {
|
|
|
3165
3165
|
module.exports = exports.default;
|
|
3166
3166
|
}
|
|
3167
3167
|
});
|
|
3168
|
-
// src/components/styled/index.ts
|
|
3169
|
-
import {
|
|
3170
|
-
CodeTabs,
|
|
3171
|
-
ImportSection
|
|
3172
|
-
} from "@openpkg-ts/ui/api";
|
|
3173
|
-
|
|
3174
|
-
// src/components/styled/sections/ClassSection.tsx
|
|
3175
|
-
import { APIParameterItem, APISection, ParameterList } from "@openpkg-ts/ui/docskit";
|
|
3176
3168
|
|
|
3177
3169
|
// src/adapters/spec-to-docskit.ts
|
|
3178
3170
|
import { formatSchema } from "@openpkg-ts/sdk";
|
|
@@ -3300,9 +3292,15 @@ function buildImportStatement(exp, spec) {
|
|
|
3300
3292
|
}
|
|
3301
3293
|
return `import { ${alias} } from '${importPath}'`;
|
|
3302
3294
|
}
|
|
3295
|
+
// src/components/styled/index.ts
|
|
3296
|
+
import {
|
|
3297
|
+
CodeTabs,
|
|
3298
|
+
ImportSection
|
|
3299
|
+
} from "@openpkg-ts/ui/api";
|
|
3303
3300
|
|
|
3304
3301
|
// src/components/styled/sections/ClassSection.tsx
|
|
3305
3302
|
import { formatSchema as formatSchema2 } from "@openpkg-ts/sdk";
|
|
3303
|
+
import { APIParameterItem, APISection, ParameterList } from "@openpkg-ts/ui/docskit";
|
|
3306
3304
|
import { jsx, jsxs } from "react/jsx-runtime";
|
|
3307
3305
|
|
|
3308
3306
|
function formatMethodSignature(member) {
|
|
@@ -3785,8 +3783,8 @@ function ExportIndexPage({
|
|
|
3785
3783
|
}
|
|
3786
3784
|
|
|
3787
3785
|
// src/components/styled/sections/FunctionSection.tsx
|
|
3788
|
-
import { APIParameterItem as APIParameterItem3, APISection as APISection3, ParameterList as ParameterList3, ResponseBlock } from "@openpkg-ts/ui/docskit";
|
|
3789
3786
|
import { formatSchema as formatSchema3 } from "@openpkg-ts/sdk";
|
|
3787
|
+
import { APIParameterItem as APIParameterItem3, APISection as APISection3, ParameterList as ParameterList3, ResponseBlock } from "@openpkg-ts/ui/docskit";
|
|
3790
3788
|
import { jsx as jsx7, jsxs as jsxs5 } from "react/jsx-runtime";
|
|
3791
3789
|
|
|
3792
3790
|
function FunctionSection({ export: exp, spec }) {
|
|
@@ -3909,8 +3907,8 @@ function FunctionPage({ export: exp, spec }) {
|
|
|
3909
3907
|
}
|
|
3910
3908
|
|
|
3911
3909
|
// src/components/styled/sections/InterfaceSection.tsx
|
|
3912
|
-
import { APIParameterItem as APIParameterItem4, APISection as APISection4, ParameterList as ParameterList4 } from "@openpkg-ts/ui/docskit";
|
|
3913
3910
|
import { formatSchema as formatSchema4 } from "@openpkg-ts/sdk";
|
|
3911
|
+
import { APIParameterItem as APIParameterItem4, APISection as APISection4, ParameterList as ParameterList4 } from "@openpkg-ts/ui/docskit";
|
|
3914
3912
|
import { jsx as jsx9, jsxs as jsxs6 } from "react/jsx-runtime";
|
|
3915
3913
|
|
|
3916
3914
|
function formatMethodSignature2(member) {
|
|
@@ -4034,8 +4032,8 @@ function InterfacePage({ export: exp, spec }) {
|
|
|
4034
4032
|
}
|
|
4035
4033
|
|
|
4036
4034
|
// src/components/styled/sections/VariableSection.tsx
|
|
4037
|
-
import { APIParameterItem as APIParameterItem5, APISection as APISection5, ParameterList as ParameterList5 } from "@openpkg-ts/ui/docskit";
|
|
4038
4035
|
import { formatSchema as formatSchema5 } from "@openpkg-ts/sdk";
|
|
4036
|
+
import { APIParameterItem as APIParameterItem5, APISection as APISection5, ParameterList as ParameterList5 } from "@openpkg-ts/ui/docskit";
|
|
4039
4037
|
import { jsx as jsx11, jsxs as jsxs7 } from "react/jsx-runtime";
|
|
4040
4038
|
|
|
4041
4039
|
function VariableSection({ export: exp, spec }) {
|
|
@@ -4479,10 +4477,10 @@ function FullAPIReferencePage({
|
|
|
4479
4477
|
});
|
|
4480
4478
|
}
|
|
4481
4479
|
// src/components/styled/ParameterItem.tsx
|
|
4480
|
+
import { formatSchema as formatSchema6 } from "@openpkg-ts/sdk";
|
|
4482
4481
|
import { cn as cn4 } from "@openpkg-ts/ui/lib/utils";
|
|
4483
4482
|
import { ChevronRight } from "lucide-react";
|
|
4484
4483
|
import { useState as useState3 } from "react";
|
|
4485
|
-
import { formatSchema as formatSchema6 } from "@openpkg-ts/sdk";
|
|
4486
4484
|
import { jsx as jsx16, jsxs as jsxs10 } from "react/jsx-runtime";
|
|
4487
4485
|
|
|
4488
4486
|
function getNestedProperties(schema) {
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@openpkg-ts/react",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "React components for OpenPkg specs",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"openpkg",
|
|
@@ -9,10 +9,10 @@
|
|
|
9
9
|
"typescript",
|
|
10
10
|
"api-docs"
|
|
11
11
|
],
|
|
12
|
-
"homepage": "https://github.com/
|
|
12
|
+
"homepage": "https://github.com/ryanwaits/openpkg-ts#readme",
|
|
13
13
|
"repository": {
|
|
14
14
|
"type": "git",
|
|
15
|
-
"url": "git+https://github.com/
|
|
15
|
+
"url": "git+https://github.com/ryanwaits/openpkg-ts.git",
|
|
16
16
|
"directory": "packages/react"
|
|
17
17
|
},
|
|
18
18
|
"license": "MIT",
|
|
@@ -41,9 +41,9 @@
|
|
|
41
41
|
"typecheck": "tsc --noEmit"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@openpkg-ts/spec": "
|
|
45
|
-
"@openpkg-ts/sdk": "
|
|
46
|
-
"@openpkg-ts/ui": "
|
|
44
|
+
"@openpkg-ts/spec": "^0.27.1",
|
|
45
|
+
"@openpkg-ts/sdk": "^0.30.1",
|
|
46
|
+
"@openpkg-ts/ui": "^0.1.2",
|
|
47
47
|
"lucide-react": "^0.468.0"
|
|
48
48
|
},
|
|
49
49
|
"peerDependencies": {
|