docstra 2.2.0 → 2.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.
Files changed (9) hide show
  1. package/dist/client/index.d.mts +1 -2
  2. package/dist/client/index.d.ts +1 -2
  3. package/dist/mdx/index.d.mts +1 -2
  4. package/dist/mdx/index.d.ts +1 -2
  5. package/dist/types--ZO7HfIm.d.mts +74 -0
  6. package/dist/types--ZO7HfIm.d.ts +74 -0
  7. package/package.json +2 -2
  8. package/dist/types-DVK5_X07.d.mts +0 -25
  9. package/dist/types-DVK5_X07.d.ts +0 -25
package/dist/client/index.d.mts CHANGED
@@ -1,6 +1,5 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
- import { I as IDocstraProvider, D as DocstraContextType } from '../types-DVK5_X07.mjs';
3
- import { SidebarItem } from 'docstra-types';
2
+ import { I as IDocstraProvider, D as DocstraContextType, S as SidebarItem } from '../types--ZO7HfIm.mjs';
4
3
 
5
4
  declare function DocstraProvider({ children, docstraConfig, page }: IDocstraProvider): react_jsx_runtime.JSX.Element;
6
5
  declare function useDocstra(): DocstraContextType;
package/dist/client/index.d.ts CHANGED
@@ -1,6 +1,5 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
- import { I as IDocstraProvider, D as DocstraContextType } from '../types-DVK5_X07.js';
3
- import { SidebarItem } from 'docstra-types';
2
+ import { I as IDocstraProvider, D as DocstraContextType, S as SidebarItem } from '../types--ZO7HfIm.js';
4
3
 
5
4
  declare function DocstraProvider({ children, docstraConfig, page }: IDocstraProvider): react_jsx_runtime.JSX.Element;
6
5
  declare function useDocstra(): DocstraContextType;
package/dist/mdx/index.d.mts CHANGED
@@ -1,7 +1,6 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
- import { C as CalloutProps } from '../types-DVK5_X07.mjs';
2
+ import { C as CalloutProps } from '../types--ZO7HfIm.mjs';
3
3
  export * from 'docstra-mdx';
4
- import 'docstra-types';
5
4
 
6
5
  declare function Callout({ type, children }: CalloutProps): react_jsx_runtime.JSX.Element;
7
6
 
package/dist/mdx/index.d.ts CHANGED
@@ -1,7 +1,6 @@
1
1
  import * as react_jsx_runtime from 'react/jsx-runtime';
2
- import { C as CalloutProps } from '../types-DVK5_X07.js';
2
+ import { C as CalloutProps } from '../types--ZO7HfIm.js';
3
3
  export * from 'docstra-mdx';
4
- import 'docstra-types';
5
4
 
6
5
  declare function Callout({ type, children }: CalloutProps): react_jsx_runtime.JSX.Element;
7
6
 
package/dist/types--ZO7HfIm.d.mts ADDED
@@ -0,0 +1,74 @@
1
+ interface DocstraContextType {
2
+ openSidebar: boolean;
3
+ setOpenSidebar: (open: boolean) => void;
4
+ docstraConfig: DocstraConfig;
5
+ openSearchBox: boolean;
6
+ setOpenSearchBox: (open: boolean) => void;
7
+ packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun';
8
+ setPackageManager: (packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun') => void;
9
+ sidebarItems?: SidebarItem[];
10
+ page: any;
11
+ }
12
+ interface IDocstraProvider {
13
+ children: React.ReactNode;
14
+ docstraConfig: DocstraConfig;
15
+ page: any;
16
+ }
17
+ interface DocstraConfig {
18
+ editOnGithub: {
19
+ owner: string;
20
+ repo: string;
21
+ path: string;
22
+ branch: string;
23
+ };
24
+ feedback?: {
25
+ enabled?: boolean;
26
+ formSyncFormID?: string;
27
+ watermark?: boolean;
28
+ };
29
+ navbar?: {
30
+ logo?: {
31
+ link: string;
32
+ src: string;
33
+ alt: string;
34
+ className?: string;
35
+ };
36
+ links?: {
37
+ name: string;
38
+ href: string;
39
+ }[];
40
+ };
41
+ }
42
+ type SidebarItem = {
43
+ type: 'page';
44
+ title: string;
45
+ nav_title?: string;
46
+ href: string;
47
+ icon?: string;
48
+ } | {
49
+ type: 'section';
50
+ title: string;
51
+ nav_title?: string;
52
+ href: string;
53
+ group_title?: string;
54
+ children: SidebarItem[];
55
+ icon?: string;
56
+ defaultOpen?: boolean;
57
+ collapsible?: boolean;
58
+ } | {
59
+ type: 'separator';
60
+ label: string;
61
+ } | {
62
+ type: 'link';
63
+ title: string;
64
+ nav_title?: string;
65
+ href: string;
66
+ external?: boolean;
67
+ };
68
+ type CalloutType = 'info' | 'warning' | 'error';
69
+ interface CalloutProps {
70
+ type?: CalloutType;
71
+ children: React.ReactNode;
72
+ }
73
+
74
+ export type { CalloutProps as C, DocstraContextType as D, IDocstraProvider as I, SidebarItem as S };
package/dist/types--ZO7HfIm.d.ts ADDED
@@ -0,0 +1,74 @@
1
+ interface DocstraContextType {
2
+ openSidebar: boolean;
3
+ setOpenSidebar: (open: boolean) => void;
4
+ docstraConfig: DocstraConfig;
5
+ openSearchBox: boolean;
6
+ setOpenSearchBox: (open: boolean) => void;
7
+ packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun';
8
+ setPackageManager: (packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun') => void;
9
+ sidebarItems?: SidebarItem[];
10
+ page: any;
11
+ }
12
+ interface IDocstraProvider {
13
+ children: React.ReactNode;
14
+ docstraConfig: DocstraConfig;
15
+ page: any;
16
+ }
17
+ interface DocstraConfig {
18
+ editOnGithub: {
19
+ owner: string;
20
+ repo: string;
21
+ path: string;
22
+ branch: string;
23
+ };
24
+ feedback?: {
25
+ enabled?: boolean;
26
+ formSyncFormID?: string;
27
+ watermark?: boolean;
28
+ };
29
+ navbar?: {
30
+ logo?: {
31
+ link: string;
32
+ src: string;
33
+ alt: string;
34
+ className?: string;
35
+ };
36
+ links?: {
37
+ name: string;
38
+ href: string;
39
+ }[];
40
+ };
41
+ }
42
+ type SidebarItem = {
43
+ type: 'page';
44
+ title: string;
45
+ nav_title?: string;
46
+ href: string;
47
+ icon?: string;
48
+ } | {
49
+ type: 'section';
50
+ title: string;
51
+ nav_title?: string;
52
+ href: string;
53
+ group_title?: string;
54
+ children: SidebarItem[];
55
+ icon?: string;
56
+ defaultOpen?: boolean;
57
+ collapsible?: boolean;
58
+ } | {
59
+ type: 'separator';
60
+ label: string;
61
+ } | {
62
+ type: 'link';
63
+ title: string;
64
+ nav_title?: string;
65
+ href: string;
66
+ external?: boolean;
67
+ };
68
+ type CalloutType = 'info' | 'warning' | 'error';
69
+ interface CalloutProps {
70
+ type?: CalloutType;
71
+ children: React.ReactNode;
72
+ }
73
+
74
+ export type { CalloutProps as C, DocstraContextType as D, IDocstraProvider as I, SidebarItem as S };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docstra",
3
- "version": "2.2.0",
3
+ "version": "2.2.1",
4
4
  "description": "The Modern Documentation Framework for Next.js",
5
5
  "files": [
6
6
  "dist"
@@ -41,7 +41,7 @@
41
41
  "lucide-react": "^0.554.0",
42
42
  "react-toast-msg": "^2.7.0",
43
43
  "tailwind-merge": "^3.4.0",
44
- "docstra-mdx": "0.2.0"
44
+ "docstra-mdx": "0.2.1"
45
45
  },
46
46
  "peerDependencies": {
47
47
  "next": ">=16.0.0",
package/dist/types-DVK5_X07.d.mts DELETED
@@ -1,25 +0,0 @@
1
- import { DocstraConfig, SidebarItem } from 'docstra-types';
2
-
3
- interface DocstraContextType {
4
- openSidebar: boolean;
5
- setOpenSidebar: (open: boolean) => void;
6
- docstraConfig: DocstraConfig;
7
- openSearchBox: boolean;
8
- setOpenSearchBox: (open: boolean) => void;
9
- packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun';
10
- setPackageManager: (packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun') => void;
11
- sidebarItems?: SidebarItem[];
12
- page: any;
13
- }
14
- interface IDocstraProvider {
15
- children: React.ReactNode;
16
- docstraConfig: DocstraConfig;
17
- page: any;
18
- }
19
- type CalloutType = 'info' | 'warning' | 'error';
20
- interface CalloutProps {
21
- type?: CalloutType;
22
- children: React.ReactNode;
23
- }
24
-
25
- export type { CalloutProps as C, DocstraContextType as D, IDocstraProvider as I };
package/dist/types-DVK5_X07.d.ts DELETED
@@ -1,25 +0,0 @@
1
- import { DocstraConfig, SidebarItem } from 'docstra-types';
2
-
3
- interface DocstraContextType {
4
- openSidebar: boolean;
5
- setOpenSidebar: (open: boolean) => void;
6
- docstraConfig: DocstraConfig;
7
- openSearchBox: boolean;
8
- setOpenSearchBox: (open: boolean) => void;
9
- packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun';
10
- setPackageManager: (packageManager: 'npm' | 'yarn' | 'pnpm' | 'bun') => void;
11
- sidebarItems?: SidebarItem[];
12
- page: any;
13
- }
14
- interface IDocstraProvider {
15
- children: React.ReactNode;
16
- docstraConfig: DocstraConfig;
17
- page: any;
18
- }
19
- type CalloutType = 'info' | 'warning' | 'error';
20
- interface CalloutProps {
21
- type?: CalloutType;
22
- children: React.ReactNode;
23
- }
24
-
25
- export type { CalloutProps as C, DocstraContextType as D, IDocstraProvider as I };