zudoku 0.37.0 → 0.37.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/lib/components/Zudoku.js +3 -2
- package/dist/lib/components/Zudoku.js.map +1 -1
- package/dist/lib/core/plugins.d.ts +7 -5
- package/dist/vite/api/schema-codegen.d.ts +1 -1
- package/dist/vite/api/schema-codegen.js +8 -4
- package/dist/vite/api/schema-codegen.js.map +1 -1
- package/dist/vite/plugin-api.js +1 -1
- package/dist/vite/plugin-api.js.map +1 -1
- package/lib/zudoku.components.js +237 -235
- package/lib/zudoku.components.js.map +1 -1
- package/lib/zudoku.plugins.js.map +1 -1
- package/package.json +2 -2
- package/src/lib/components/Zudoku.tsx +5 -2
- package/src/lib/core/plugins.ts +8 -8
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"zudoku.plugins.js","sources":["../src/lib/core/plugins.ts"],"sourcesContent":["import type { LucideIcon } from \"lucide-react\";\nimport {
|
|
1
|
+
{"version":3,"file":"zudoku.plugins.js","sources":["../src/lib/core/plugins.ts"],"sourcesContent":["import type { LucideIcon } from \"lucide-react\";\nimport type { ReactElement } from \"react\";\nimport type { Location, RouteObject } from \"react-router\";\nimport type { Sidebar } from \"../../config/validators/SidebarSchema.js\";\nimport type { MdxComponentsType } from \"../util/MdxComponents.js\";\nimport type {\n ApiIdentity,\n ZudokuContext,\n ZudokuEvents,\n} from \"./ZudokuContext.js\";\n\nexport type ZudokuPlugin =\n | CommonPlugin\n | ProfileMenuPlugin\n | NavigationPlugin\n | ApiIdentityPlugin\n | SearchProviderPlugin\n | EventConsumerPlugin;\n\nexport type { RouteObject };\n\nexport interface NavigationPlugin {\n getRoutes: () => RouteObject[];\n getSidebar?: (path: string, context: ZudokuContext) => Promise<Sidebar>;\n}\n\nexport const createApiIdentityPlugin = (\n plugin: ApiIdentityPlugin,\n): ApiIdentityPlugin => plugin;\n\nexport const createProfileMenuPlugin = (\n plugin: ProfileMenuPlugin,\n): ProfileMenuPlugin => plugin;\n\nexport interface ApiIdentityPlugin {\n getIdentities: (context: ZudokuContext) => Promise<ApiIdentity[]>;\n}\n\nexport interface SearchProviderPlugin {\n renderSearch: (o: {\n isOpen: boolean;\n onClose: () => void;\n }) => React.JSX.Element | null;\n}\n\nexport interface ProfileMenuPlugin {\n getProfileMenuItems: (context: ZudokuContext) => ProfileNavigationItem[];\n}\n\nexport type ProfileNavigationItem = {\n label: string;\n path?: string;\n weight?: number;\n category?: \"top\" | \"middle\" | \"bottom\";\n children?: ProfileNavigationItem[];\n icon?: LucideIcon;\n};\n\nexport interface CommonPlugin {\n initialize?: (\n context: ZudokuContext,\n ) => Promise<void | boolean> | void | boolean;\n getHead?: ({ location }: { location: Location }) => ReactElement | undefined;\n getMdxComponents?: () => MdxComponentsType;\n}\n\nexport type EventConsumerPlugin<Event extends ZudokuEvents = ZudokuEvents> = {\n events: { [K in keyof Event]: Event[K] };\n};\n\nexport const isEventConsumerPlugin = (\n obj: ZudokuPlugin,\n): obj is EventConsumerPlugin =>\n \"events\" in obj && typeof obj.events === \"object\";\n\nexport const isProfileMenuPlugin = (\n obj: ZudokuPlugin,\n): obj is ProfileMenuPlugin =>\n \"getProfileMenuItems\" in obj && typeof obj.getProfileMenuItems === \"function\";\n\nexport const isNavigationPlugin = (\n obj: ZudokuPlugin,\n): obj is NavigationPlugin =>\n \"getRoutes\" in obj && typeof obj.getRoutes === \"function\";\n\nexport const isSearchPlugin = (\n obj: ZudokuPlugin,\n): obj is SearchProviderPlugin =>\n \"renderSearch\" in obj && typeof obj.renderSearch === \"function\";\n\nexport const needsInitialization = (obj: ZudokuPlugin): obj is CommonPlugin =>\n \"initialize\" in obj && typeof obj.initialize === \"function\";\n\nexport const hasHead = (obj: ZudokuPlugin): obj is CommonPlugin =>\n \"getHead\" in obj && typeof obj.getHead === \"function\";\n\nexport const isMdxProviderPlugin = (obj: ZudokuPlugin): obj is CommonPlugin =>\n \"getMdxComponents\" in obj && typeof obj.getMdxComponents === \"function\";\n\nexport const isApiIdentityPlugin = (\n obj: ZudokuPlugin,\n): obj is ApiIdentityPlugin =>\n \"getIdentities\" in obj && typeof obj.getIdentities === \"function\";\n"],"names":["createApiIdentityPlugin","plugin","createProfileMenuPlugin","isEventConsumerPlugin","obj","isProfileMenuPlugin","isNavigationPlugin","isSearchPlugin","needsInitialization","hasHead","isMdxProviderPlugin","isApiIdentityPlugin"],"mappings":"AA0Ba,MAAAA,IAA0B,CACrCC,MACsBA,GAEXC,IAA0B,CACrCD,MACsBA,GAsCXE,IAAwB,CACnCC,MAEA,YAAYA,KAAO,OAAOA,EAAI,UAAW,UAE9BC,IAAsB,CACjCD,MAEA,yBAAyBA,KAAO,OAAOA,EAAI,uBAAwB,YAExDE,IAAqB,CAChCF,MAEA,eAAeA,KAAO,OAAOA,EAAI,aAAc,YAEpCG,IAAiB,CAC5BH,MAEA,kBAAkBA,KAAO,OAAOA,EAAI,gBAAiB,YAE1CI,IAAsB,CAACJ,MAClC,gBAAgBA,KAAO,OAAOA,EAAI,cAAe,YAEtCK,IAAU,CAACL,MACtB,aAAaA,KAAO,OAAOA,EAAI,WAAY,YAEhCM,IAAsB,CAACN,MAClC,sBAAsBA,KAAO,OAAOA,EAAI,oBAAqB,YAElDO,IAAsB,CACjCP,MAEA,mBAAmBA,KAAO,OAAOA,EAAI,iBAAkB;"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zudoku",
|
|
3
|
-
"version": "0.37.
|
|
3
|
+
"version": "0.37.1",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"homepage": "https://zudoku.dev",
|
|
6
6
|
"repository": {
|
|
@@ -226,7 +226,7 @@
|
|
|
226
226
|
"strip-ansi": "7.1.0",
|
|
227
227
|
"tailwind-merge": "2.6.0",
|
|
228
228
|
"tailwindcss": "3.4.17",
|
|
229
|
-
"tsx": "^4.19.
|
|
229
|
+
"tsx": "^4.19.3",
|
|
230
230
|
"ulidx": "2.4.1",
|
|
231
231
|
"unified": "^11.0.5",
|
|
232
232
|
"unist-util-visit": "5.0.0",
|
|
@@ -11,7 +11,7 @@ import {
|
|
|
11
11
|
useState,
|
|
12
12
|
} from "react";
|
|
13
13
|
import { ErrorBoundary } from "react-error-boundary";
|
|
14
|
-
import { Outlet, useNavigation } from "react-router";
|
|
14
|
+
import { Outlet, useLocation, useNavigation } from "react-router";
|
|
15
15
|
import { hasHead, isMdxProviderPlugin } from "../core/plugins.js";
|
|
16
16
|
import {
|
|
17
17
|
ZudokuContext,
|
|
@@ -37,6 +37,7 @@ const ZudokoInner = memo(
|
|
|
37
37
|
[props.overrides],
|
|
38
38
|
);
|
|
39
39
|
|
|
40
|
+
const location = useLocation();
|
|
40
41
|
const mdxComponents = useMemo(() => {
|
|
41
42
|
const componentsFromPlugins = (props.plugins ?? [])
|
|
42
43
|
.filter(isMdxProviderPlugin)
|
|
@@ -74,7 +75,9 @@ const ZudokoInner = memo(
|
|
|
74
75
|
);
|
|
75
76
|
|
|
76
77
|
const heads = props.plugins
|
|
77
|
-
?.flatMap((plugin) =>
|
|
78
|
+
?.flatMap((plugin) =>
|
|
79
|
+
hasHead(plugin) ? (plugin.getHead?.({ location }) ?? []) : [],
|
|
80
|
+
)
|
|
78
81
|
// eslint-disable-next-line react/no-array-index-key
|
|
79
82
|
.map((entry, i) => <Helmet key={i}>{entry}</Helmet>);
|
|
80
83
|
|
package/src/lib/core/plugins.ts
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import type { LucideIcon } from "lucide-react";
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
2
|
+
import type { ReactElement } from "react";
|
|
3
|
+
import type { Location, RouteObject } from "react-router";
|
|
4
4
|
import type { Sidebar } from "../../config/validators/SidebarSchema.js";
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
import type { MdxComponentsType } from "../util/MdxComponents.js";
|
|
6
|
+
import type {
|
|
7
|
+
ApiIdentity,
|
|
8
|
+
ZudokuContext,
|
|
9
|
+
ZudokuEvents,
|
|
10
10
|
} from "./ZudokuContext.js";
|
|
11
11
|
|
|
12
12
|
export type ZudokuPlugin =
|
|
@@ -60,7 +60,7 @@ export interface CommonPlugin {
|
|
|
60
60
|
initialize?: (
|
|
61
61
|
context: ZudokuContext,
|
|
62
62
|
) => Promise<void | boolean> | void | boolean;
|
|
63
|
-
getHead?: () => ReactElement | undefined;
|
|
63
|
+
getHead?: ({ location }: { location: Location }) => ReactElement | undefined;
|
|
64
64
|
getMdxComponents?: () => MdxComponentsType;
|
|
65
65
|
}
|
|
66
66
|
|