Compare commits

...

1 Commits

Author SHA1 Message Date
Steven Hall 33c30ba7a1 WIP 2025-04-04 14:34:22 +01:00
12 changed files with 141 additions and 13 deletions
+7 -7
View File
@@ -35,7 +35,7 @@
},
"packages/colors": {
"name": "@gitbook/colors",
"version": "0.3.0",
"version": "0.3.1",
"devDependencies": {
"typescript": "^5.5.3",
},
@@ -49,7 +49,7 @@
},
"packages/gitbook": {
"name": "gitbook",
"version": "0.8.2",
"version": "0.9.1",
"dependencies": {
"@gitbook/api": "*",
"@gitbook/cache-do": "workspace:*",
@@ -136,7 +136,7 @@
},
"packages/gitbook-v2": {
"name": "gitbook-v2",
"version": "0.2.2",
"version": "0.2.3",
"dependencies": {
"@gitbook/api": "*",
"@gitbook/cache-tags": "workspace:*",
@@ -162,7 +162,7 @@
"name": "@gitbook/icons",
"version": "0.2.0",
"bin": {
"gitbook-icons": "./bin/gitbook-icons.js",
"gitbook-icons": "./bin/gitbook-icons.js"
},
"dependencies": {
"@fortawesome/fontawesome-free": "^6.6.0",
@@ -180,7 +180,7 @@
},
"packages/openapi-parser": {
"name": "@gitbook/openapi-parser",
"version": "2.1.1",
"version": "2.1.2",
"dependencies": {
"@scalar/openapi-parser": "^0.10.10",
"@scalar/openapi-types": "^0.1.9",
@@ -219,7 +219,7 @@
"name": "@gitbook/react-math",
"version": "0.6.0",
"bin": {
"gitbook-math": "./bin/gitbook-math.js",
"gitbook-math": "./bin/gitbook-math.js"
},
"dependencies": {
"object-hash": "^3.0.0",
@@ -234,7 +234,7 @@
},
"packages/react-openapi": {
"name": "@gitbook/react-openapi",
"version": "1.1.6",
"version": "1.1.8",
"dependencies": {
"@gitbook/openapi-parser": "workspace:*",
"@scalar/api-client-react": "^1.2.5",
@@ -179,4 +179,9 @@ export interface GitBookDataFetcher {
integrationName: string;
request: api.RenderIntegrationUI;
}): Promise<DataFetcherResponse<api.ContentKitRenderOutput>>;
getAction(params: {
url: string
claims: any
}): Promise<DataFetcherResponse<{ text: string; url: string; icon?: string }>>;
}
@@ -25,10 +25,21 @@ export async function POST(req: NextRequest) {
);
}
const result = await revalidateTags(json.tags);
try {
const result = await revalidateTags(json.tags);
return NextResponse.json({
success: true,
stats: result.stats,
});
} catch (err: unknown) {
return NextResponse.json(
{
error: 'Failed to revalidate tags',
message: err instanceof Error ? err.message : 'Internal Server Error',
stack: err instanceof Error ? err.stack : '',
},
{ status: 500 }
);
}
return NextResponse.json({
success: true,
stats: result.stats,
});
}
@@ -13,6 +13,7 @@ import assertNever from 'assert-never';
import { Annotation } from './Annotation/Annotation';
import type { DocumentContextProps } from './DocumentView';
import { Emoji } from './Emoji';
import { InlineAction } from './InlineAction';
import { InlineImage } from './InlineImage';
import { InlineLink } from './InlineLink';
import { InlineMath } from './Math';
@@ -61,6 +62,8 @@ export function Inline<
return <Mention {...contextProps} inline={inline} />;
case 'inline-image':
return <InlineImage {...contextProps} inline={inline} />;
case 'action':
return <InlineAction {...contextProps} inline={inline} />;
default:
assertNever(inline);
}
@@ -0,0 +1,33 @@
import { getVisitorAuthClaims } from '@/lib/adaptive';
import { getDataOrNull } from '@v2/lib/data';
import { getSiteURLDataFromMiddleware } from '@v2/lib/middleware';
import type { InlineProps } from './Inline';
import { TrackEventButton } from './TrackEventButton';
export async function InlineAction(props: InlineProps<any>) {
const { inline, context } = props;
if (!context.contentContext) {
throw new Error('inline action requires a contentContext');
}
const action = inline.data.action;
if (action.type === 'url') {
return <TrackEventButton action={inline.data.action} resolved={{ url: action.url, text: action.text }} />
}
// API action
const { dataFetcher } = context.contentContext;
const siteData = await getSiteURLDataFromMiddleware();
const claims = getVisitorAuthClaims(siteData)
const resolved = await getDataOrNull(dataFetcher.getAction({ url: inline.data.action.url, claims }));
if (!resolved) {
throw new Error('inline action not found');
}
return <TrackEventButton action={inline.data.action} resolved={resolved} />
}
@@ -0,0 +1,36 @@
'use client';
import { tcls } from '@/lib/tailwind';
import { useTrackEvent } from '../Insights';
import { LoadingButton } from '../primitives';
export function TrackEventButton(props: {
action: any;
resolved: { url: string; text: string };
}) {
const { action, resolved } = props;
const trackEvent = useTrackEvent();
return (
<LoadingButton
onClick={async () => {
trackEvent({ type: 'action_click', action: action });
window.open(resolved.url, '_blank', 'noopener noreferrer');
}}
href={resolved.url}
variant="primary"
size="medium"
className={tcls(
'theme-bold:bg-header-link theme-bold:text-header-background theme-bold:shadow-none theme-bold:hover:bg-header-link theme-bold:hover:text-header-background theme-bold:hover:shadow-none'
)}
// insights={{
// type: 'link_click',
// link: {
// target: linkTarget,
// position: SiteInsightsLinkPosition.Header,
// },
// }}
>
{resolved.text}
</LoadingButton>
);
}
@@ -93,6 +93,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
const flushEventsSync = useEventCallback(() => {
const session = getSession();
const visitorId = visitorIdRef.current;
console.log('flushEventsSync');
if (!visitorId) {
throw new Error('Visitor ID should be set before flushing events');
}
@@ -126,6 +127,8 @@ export function InsightsProvider(props: InsightsProviderProps) {
};
}
console.log('allEvents', allEvents.length)
if (allEvents.length > 0) {
if (enabled) {
sendEvents({
@@ -143,6 +146,7 @@ export function InsightsProvider(props: InsightsProviderProps) {
const visitorId = visitorIdRef.current ?? (await getVisitorId(appURL));
visitorIdRef.current = visitorId;
console.log('flushBatchedEvents');
flushEventsSync();
}, 1500);
@@ -167,6 +171,8 @@ export function InsightsProvider(props: InsightsProviderProps) {
context,
};
console.log('trackEvent', event, eventsRef.current[pathname].pageContext);
if (eventsRef.current[pathname].pageContext !== undefined) {
// If the pageId is set, we know that the page_view event has been tracked
// and we can flush the events
@@ -6,7 +6,7 @@ import { type ClassValue, tcls } from '@/lib/tailwind';
import { Link, type LinkInsightsProps } from './Link';
type ButtonProps = {
export type ButtonProps = {
href?: string;
variant?: 'primary' | 'secondary';
size?: 'default' | 'medium' | 'small';
@@ -0,0 +1,16 @@
'use client';
import { tcls } from '@/lib/tailwind';
import { useTransition } from 'react';
import { Button, type ButtonProps } from './Button';
export function LoadingButton({ href, onClick, className, ...rest }: ButtonProps & { onClick: () => Promise<void> }) {
const [isPending, startTransition] = useTransition();
const handleClick = (e) => {
e.preventDefault();
startTransition(onClick);
return false;
}
return <Button className={tcls(className, isPending ? 'animate-pulse' : '')} {...rest} onClick={handleClick} />
}
@@ -8,3 +8,4 @@ export * from './StyledLink';
export * from './DateRelative';
export * from './Emoji';
export * from './LoadingPane';
export * from './LoadingButton';
+1
View File
@@ -6,6 +6,7 @@ import { headers } from 'next/headers';
export async function shouldTrackEvents(): Promise<boolean> {
const headersList = await headers();
return true;
if (
process.env.NODE_ENV === 'development' ||
(process.env.GITBOOK_BLOCK_PAGE_VIEWS_TRACKING &&
+16
View File
@@ -270,6 +270,22 @@ async function getDataFetcherV1(): Promise<GitBookDataFetcher> {
return result;
});
},
getAction(params) {
return wrapDataFetcherError(async () => {
console.log('fetching', params.url);
const url = new URL(params.url);
Object.keys(params.claims).forEach((key) => {
url.searchParams.append(key, params.claims[key]);
});
const result = await fetch(url.toString());
console.log('fetched', result.statusText)
if (!result) {
throw new DataFetcherError('Action not found', 404);
}
return await result.json();
});
}
};
return dataFetcher;