Skip to content

OpenPanel is an open-source web and product analytics platform, an open-source alternative to Mixpanel with optional self-hosting.

feat: add tracking code on project settings

Carl-Gerhard Lindesvärd127246623581
diff --git a/apps/start/src/components/clients/table/columns.tsx b/apps/start/src/components/clients/table/columns.tsx
index adc707c3c..5a7de0ba8 100644
--- a/apps/start/src/components/clients/table/columns.tsx
+++ b/apps/start/src/components/clients/table/columns.tsx
@@ -1,7 +1,7 @@
-import { formatDateTime, formatTime } from '@/utils/date';
+import { DropdownMenuSeparator } from '@radix-ui/react-dropdown-menu';
+import { useMutation, useQueryClient } from '@tanstack/react-query';
import type { ColumnDef } from '@tanstack/react-table';
-import { isToday } from 'date-fns';
-
+import { toast } from 'sonner';
import { ColumnCreatedAt } from '@/components/column-created-at';
import CopyInput from '@/components/forms/copy-input';
import { createActionColumn } from '@/components/ui/data-table/data-table-helpers';
@@ -10,9 +10,6 @@ import { handleError, useTRPC } from '@/integrations/trpc/react';
import { pushModal, showConfirm } from '@/modals';
import type { RouterOutputs } from '@/trpc/client';
import { clipboard } from '@/utils/clipboard';
-import { DropdownMenuSeparator } from '@radix-ui/react-dropdown-menu';
-import { useMutation, useQueryClient } from '@tanstack/react-query';
-import { toast } from 'sonner';
export function useColumns() {
const columns: ColumnDef<RouterOutputs['client']['list'][number]>[] = [
@@ -51,7 +48,7 @@ export function useColumns() {
queryClient.invalidateQueries(trpc.client.list.pathFilter());
},
onError: handleError,
- }),
+ })
);
return (
<>
@@ -67,7 +64,6 @@ export function useColumns() {
</DropdownMenuItem>
<DropdownMenuSeparator />
<DropdownMenuItem
- variant="destructive"
onClick={() => {
showConfirm({
title: 'Revoke client',
@@ -79,6 +75,7 @@ export function useColumns() {
},
});
}}
+ variant="destructive"
>
Revoke
</DropdownMenuItem>
diff --git a/apps/start/src/components/clients/table/index.tsx b/apps/start/src/components/clients/table/index.tsx
index 5ef59cf74..5bb5a4a94 100644
--- a/apps/start/src/components/clients/table/index.tsx
+++ b/apps/start/src/components/clients/table/index.tsx
@@ -1,17 +1,16 @@
import type { UseQueryResult } from '@tanstack/react-query';
-
+import { PlusIcon } from 'lucide-react';
+import { useColumns } from './columns';
import { Button } from '@/components/ui/button';
import { DataTable } from '@/components/ui/data-table/data-table';
import { DataTableToolbar } from '@/components/ui/data-table/data-table-toolbar';
import { useTable } from '@/components/ui/data-table/use-table';
import { pushModal } from '@/modals';
import type { RouterOutputs } from '@/trpc/client';
-import { PlusIcon } from 'lucide-react';
-import { useColumns } from './columns';
-type Props = {
+interface Props {
query: UseQueryResult<RouterOutputs['client']['list'], unknown>;
-};
+}
export const ClientsTable = ({ query }: Props) => {
const columns = useColumns();
@@ -30,13 +29,13 @@ export const ClientsTable = ({ query }: Props) => {
<DataTableToolbar table={table}>
<Button
icon={PlusIcon}
- responsive
onClick={() => pushModal('AddClient')}
+ responsive
>
Create client
</Button>
</DataTableToolbar>
- <DataTable table={table} loading={isLoading} />
+ <DataTable loading={isLoading} table={table} />
</>
);
};
diff --git a/apps/start/src/components/onboarding/connect-web.tsx b/apps/start/src/components/onboarding/connect-web.tsx
index e41fc39c6..a1b4a9dee 100644
--- a/apps/start/src/components/onboarding/connect-web.tsx
+++ b/apps/start/src/components/onboarding/connect-web.tsx
@@ -27,7 +27,7 @@ const ConnectWeb = ({ client }: Props) => {
</script>
<script src="https://openpanel.dev/op1.js" defer async></script>`;
return (
- <>
+ <div className="col gap-4">
<div className="col gap-2">
<div className="row items-center justify-between gap-4">
<div className="flex items-center gap-2 font-bold text-xl capitalize">
@@ -44,7 +44,7 @@ const ConnectWeb = ({ client }: Props) => {
</Button>
</div>
</div>
- <Syntax className="border" code={code} />
+ <Syntax className="border" code={code} copyable={false} />
</div>
<div className="col gap-4">
<p className="text-center text-muted-foreground text-sm">
@@ -80,7 +80,7 @@ const ConnectWeb = ({ client }: Props) => {
</a>
</p>
</div>
- </>
+ </div>
);
};
diff --git a/apps/start/src/routeTree.gen.ts b/apps/start/src/routeTree.gen.ts
index 5b7eba9a5..221cc39de 100644
--- a/apps/start/src/routeTree.gen.ts
+++ b/apps/start/src/routeTree.gen.ts
@@ -69,6 +69,7 @@ import { Route as AppOrganizationIdProjectIdProfilesTabsIndexRouteImport } from
import { Route as AppOrganizationIdProjectIdNotificationsTabsIndexRouteImport } from './routes/_app.$organizationId.$projectId.notifications._tabs.index'
import { Route as AppOrganizationIdProjectIdEventsTabsIndexRouteImport } from './routes/_app.$organizationId.$projectId.events._tabs.index'
import { Route as AppOrganizationIdProjectIdSettingsTabsWidgetsRouteImport } from './routes/_app.$organizationId.$projectId.settings._tabs.widgets'
+import { Route as AppOrganizationIdProjectIdSettingsTabsTrackingRouteImport } from './routes/_app.$organizationId.$projectId.settings._tabs.tracking'
import { Route as AppOrganizationIdProjectIdSettingsTabsImportsRouteImport } from './routes/_app.$organizationId.$projectId.settings._tabs.imports'
import { Route as AppOrganizationIdProjectIdSettingsTabsEventsRouteImport } from './routes/_app.$organizationId.$projectId.settings._tabs.events'
import { Route as AppOrganizationIdProjectIdSettingsTabsDetailsRouteImport } from './routes/_app.$organizationId.$projectId.settings._tabs.details'
@@ -475,6 +476,12 @@ const AppOrganizationIdProjectIdSettingsTabsWidgetsRoute =
path: '/widgets',
getParentRoute: () => AppOrganizationIdProjectIdSettingsTabsRoute,
} as any)
+const AppOrganizationIdProjectIdSettingsTabsTrackingRoute =
+ AppOrganizationIdProjectIdSettingsTabsTrackingRouteImport.update({
+ id: '/tracking',
+ path: '/tracking',
+ getParentRoute: () => AppOrganizationIdProjectIdSettingsTabsRoute,
+ } as any)
const AppOrganizationIdProjectIdSettingsTabsImportsRoute =
AppOrganizationIdProjectIdSettingsTabsImportsRouteImport.update({
id: '/imports',
@@ -634,6 +641,7 @@ export interface FileRoutesByFullPath {
'/$organizationId/$projectId/settings/details': typeof AppOrganizationIdProjectIdSettingsTabsDetailsRoute
'/$organizationId/$projectId/settings/events': typeof AppOrganizationIdProjectIdSettingsTabsEventsRoute
'/$organizationId/$projectId/settings/imports': typeof AppOrganizationIdProjectIdSettingsTabsImportsRoute
+ '/$organizationId/$projectId/settings/tracking': typeof AppOrganizationIdProjectIdSettingsTabsTrackingRoute
'/$organizationId/$projectId/settings/widgets': typeof AppOrganizationIdProjectIdSettingsTabsWidgetsRoute
'/$organizationId/$projectId/events/': typeof AppOrganizationIdProjectIdEventsTabsIndexRoute
'/$organizationId/$projectId/notifications/': typeof AppOrganizationIdProjectIdNotificationsTabsIndexRoute
@@ -701,6 +709,7 @@ export interface FileRoutesByTo {
'/$organizationId/$projectId/settings/details': typeof AppOrganizationIdProjectIdSettingsTabsDetailsRoute
'/$organizationId/$projectId/settings/events': typeof AppOrganizationIdProjectIdSettingsTabsEventsRoute
'/$organizationId/$projectId/settings/imports': typeof AppOrganizationIdProjectIdSettingsTabsImportsRoute
+ '/$organizationId/$projectId/settings/tracking': typeof AppOrganizationIdProjectIdSettingsTabsTrackingRoute
'/$organizationId/$projectId/settings/widgets': typeof AppOrganizationIdProjectIdSettingsTabsWidgetsRoute
'/$organizationId/$projectId/profiles/$profileId/events': typeof AppOrganizationIdProjectIdProfilesProfileIdTabsEventsRoute
'/$organizationId/$projectId/profiles/$profileId/sessions': typeof AppOrganizationIdProjectIdProfilesProfileIdTabsSessionsRoute
@@ -781,6 +790,7 @@ export interface FileRoutesById {
'/_app/$organizationId/$projectId/settings/_tabs/details': typeof AppOrganizationIdProjectIdSettingsTabsDetailsRoute
'/_app/$organizationId/$projectId/settings/_tabs/events': typeof AppOrganizationIdProjectIdSettingsTabsEventsRoute
'/_app/$organizationId/$projectId/settings/_tabs/imports': typeof AppOrganizationIdProjectIdSettingsTabsImportsRoute
+ '/_app/$organizationId/$projectId/settings/_tabs/tracking': typeof AppOrganizationIdProjectIdSettingsTabsTrackingRoute
'/_app/$organizationId/$projectId/settings/_tabs/widgets': typeof AppOrganizationIdProjectIdSettingsTabsWidgetsRoute
'/_app/$organizationId/$projectId/events/_tabs/': typeof AppOrganizationIdProjectIdEventsTabsIndexRoute
'/_app/$organizationId/$projectId/notifications/_tabs/': typeof AppOrganizationIdProjectIdNotificationsTabsIndexRoute
@@ -855,6 +865,7 @@ export interface FileRouteTypes {
| '/$organizationId/$projectId/settings/details'
| '/$organizationId/$projectId/settings/events'
| '/$organizationId/$projectId/settings/imports'
+ | '/$organizationId/$projectId/settings/tracking'
| '/$organizationId/$projectId/settings/widgets'
| '/$organizationId/$projectId/events/'
| '/$organizationId/$projectId/notifications/'
@@ -922,6 +933,7 @@ export interface FileRouteTypes {
| '/$organizationId/$projectId/settings/details'
| '/$organizationId/$projectId/settings/events'
| '/$organizationId/$projectId/settings/imports'
+ | '/$organizationId/$projectId/settings/tracking'
| '/$organizationId/$projectId/settings/widgets'
| '/$organizationId/$projectId/profiles/$profileId/events'
| '/$organizationId/$projectId/profiles/$profileId/sessions'
@@ -1001,6 +1013,7 @@ export interface FileRouteTypes {
| '/_app/$organizationId/$projectId/settings/_tabs/details'
| '/_app/$organizationId/$projectId/settings/_tabs/events'
| '/_app/$organizationId/$projectId/settings/_tabs/imports'
+ | '/_app/$organizationId/$projectId/settings/_tabs/tracking'
| '/_app/$organizationId/$projectId/settings/_tabs/widgets'
| '/_app/$organizationId/$projectId/events/_tabs/'
| '/_app/$organizationId/$projectId/notifications/_tabs/'
@@ -1493,6 +1506,13 @@ declare module '@tanstack/react-router' {
preLoaderRoute: typeof AppOrganizationIdProjectIdSettingsTabsWidgetsRouteImport
parentRoute: typeof AppOrganizationIdProjectIdSettingsTabsRoute
}
+ '/_app/$organizationId/$projectId/settings/_tabs/tracking': {
+ id: '/_app/$organizationId/$projectId/settings/_tabs/tracking'
+ path: '/tracking'
+ fullPath: '/$organizationId/$projectId/settings/tracking'
+ preLoaderRoute: typeof AppOrganizationIdProjectIdSettingsTabsTrackingRouteImport
+ parentRoute: typeof AppOrganizationIdProjectIdSettingsTabsRoute
+ }
'/_app/$organizationId/$projectId/settings/_tabs/imports': {
id: '/_app/$organizationId/$projectId/settings/_tabs/imports'
path: '/imports'
@@ -1766,6 +1786,7 @@ interface AppOrganizationIdProjectIdSettingsTabsRouteChildren {
AppOrganizationIdProjectIdSettingsTabsDetailsRoute: typeof AppOrganizationIdProjectIdSettingsTabsDetailsRoute
AppOrganizationIdProjectIdSettingsTabsEventsRoute: typeof AppOrganizationIdProjectIdSettingsTabsEventsRoute
AppOrganizationIdProjectIdSettingsTabsImportsRoute: typeof AppOrganizationIdProjectIdSettingsTabsImportsRoute
+ AppOrganizationIdProjectIdSettingsTabsTrackingRoute: typeof AppOrganizationIdProjectIdSettingsTabsTrackingRoute
AppOrganizationIdProjectIdSettingsTabsWidgetsRoute: typeof AppOrganizationIdProjectIdSettingsTabsWidgetsRoute
AppOrganizationIdProjectIdSettingsTabsIndexRoute: typeof AppOrganizationIdProjectIdSettingsTabsIndexRoute
}
@@ -1780,6 +1801,8 @@ const AppOrganizationIdProjectIdSettingsTabsRouteChildren: AppOrganizationIdProj
AppOrganizationIdProjectIdSettingsTabsEventsRoute,
AppOrganizationIdProjectIdSettingsTabsImportsRoute:
AppOrganizationIdProjectIdSettingsTabsImportsRoute,
+ AppOrganizationIdProjectIdSettingsTabsTrackingRoute:
+ AppOrganizationIdProjectIdSettingsTabsTrackingRoute,
AppOrganizationIdProjectIdSettingsTabsWidgetsRoute:
AppOrganizationIdProjectIdSettingsTabsWidgetsRoute,
AppOrganizationIdProjectIdSettingsTabsIndexRoute:
diff --git a/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tracking.tsx b/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tracking.tsx
new file mode 100644
index 000000000..dbebd244c
--- /dev/null
+++ b/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tracking.tsx
@@ -0,0 +1,116 @@
+import type { IServiceClient } from '@openpanel/db';
+import { frameworks } from '@openpanel/sdk-info';
+import { useQuery } from '@tanstack/react-query';
+import { createFileRoute } from '@tanstack/react-router';
+import { CopyIcon } from 'lucide-react';
+import { useEffect, useState } from 'react';
+import Syntax from '@/components/syntax';
+import { Button } from '@/components/ui/button';
+import { Combobox } from '@/components/ui/combobox';
+import { useAppContext } from '@/hooks/use-app-context';
+import { useAppParams } from '@/hooks/use-app-params';
+import { useTRPC } from '@/integrations/trpc/react';
+import { pushModal } from '@/modals';
+import { clipboard } from '@/utils/clipboard';
+
+export const Route = createFileRoute(
+ '/_app/$organizationId/$projectId/settings/_tabs/tracking'
+)({
+ component: Component,
+});
+
+function Component() {
+ const { projectId } = useAppParams();
+ const trpc = useTRPC();
+ const query = useQuery(trpc.client.list.queryOptions({ projectId }));
+ return <ConnectWeb clients={query.data ?? []} />;
+}
+
+interface Props {
+ clients: IServiceClient[];
+}
+
+const ConnectWeb = ({ clients }: Props) => {
+ const [client, setClient] = useState<IServiceClient | null>(null);
+ useEffect(() => {
+ if (!client && clients && clients.length > 0) {
+ setClient(clients[0]);
+ }
+ }, [clients]);
+ const context = useAppContext();
+ const code = `<script>
+ window.op=window.op||function(){var n=[];return new Proxy(function(){arguments.length&&n.push([].slice.call(arguments))},{get:function(t,r){return"q"===r?n:function(){n.push([r].concat([].slice.call(arguments)))}} ,has:function(t,r){return"q"===r}}) }();
+ window.op('init', {${context.isSelfHosted ? `\n\tapiUrl: '${context.apiUrl}',` : ''}
+ clientId: '${client?.id ?? 'YOUR_CLIENT_ID'}',
+ trackScreenViews: true,
+ trackOutgoingLinks: true,
+ trackAttributes: true,
+ // sessionReplay: {
+ // enabled: true,
+ // },
+ });
+</script>
+<script src="https://openpanel.dev/op1.js" defer async></script>`;
+ return (
+ <div className="col gap-4">
+ <div className="col gap-2">
+ <div className="row items-center justify-between gap-4">
+ <Combobox
+ items={clients.map((c) => ({
+ value: c.id,
+ label: c.name,
+ }))}
+ onChange={(id) =>
+ setClient(clients.find((c) => c.id === id) ?? null)
+ }
+ placeholder="Select client"
+ searchable
+ value={client?.id ?? null}
+ />
+ <Button
+ icon={CopyIcon}
+ onClick={() => clipboard(code, null)}
+ variant="outline"
+ >
+ Copy
+ </Button>
+ </div>
+ <Syntax className="border" code={code} copyable={false} />
+ </div>
+ <div className="col gap-4">
+ <p className="text-center text-muted-foreground text-sm">
+ Or pick a framework below to get started.
+ </p>
+ <div className="grid gap-4 md:grid-cols-2">
+ {frameworks.map((framework) => (
+ <button
+ className="flex items-center gap-4 rounded-md border p-2 text-left"
+ key={framework.name}
+ onClick={() =>
+ pushModal('Instructions', {
+ framework,
+ client,
+ })
+ }
+ type="button"
+ >
+ <div className="h-10 w-10 rounded-md bg-def-200 p-2">
+ <framework.IconComponent className="h-full w-full" />
+ </div>
+ <div className="flex-1 font-semibold">{framework.name}</div>
+ </button>
+ ))}
+ </div>
+ <p className="text-center text-muted-foreground text-sm">
+ Missing a framework?{' '}
+ <a
+ className="text-foreground underline"
+ href="mailto:[email protected]"
+ >
+ Let us know!
+ </a>
+ </p>
+ </div>
+ </div>
+ );
+};
diff --git a/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tsx b/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tsx
index 2acfa01d9..205fb7bca 100644
--- a/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tsx
+++ b/apps/start/src/routes/_app.$organizationId.$projectId.settings._tabs.tsx
@@ -1,16 +1,16 @@
-import FullPageLoadingState from '@/components/full-page-loading-state';
-import { PageHeader } from '@/components/page-header';
-import { Tabs, TabsList, TabsTrigger } from '@/components/ui/tabs';
-import { PAGE_TITLES, createProjectTitle } from '@/utils/title';
import {
- Outlet,
createFileRoute,
+ Outlet,
useLocation,
useRouter,
} from '@tanstack/react-router';
+import FullPageLoadingState from '@/components/full-page-loading-state';
+import { PageHeader } from '@/components/page-header';
+import { Tabs, TabsList, TabsTrigger } from '@/components/ui/tabs';
+import { createProjectTitle, PAGE_TITLES } from '@/utils/title';
export const Route = createFileRoute(
- '/_app/$organizationId/$projectId/settings/_tabs',
+ '/_app/$organizationId/$projectId/settings/_tabs'
)({
component: ProjectDashboard,
head: () => {
@@ -27,7 +27,7 @@ export const Route = createFileRoute(
await queryClient.prefetchQuery(
trpc.project.getProjectWithClients.queryOptions({
projectId: params.projectId,
- }),
+ })
);
},
pendingComponent: FullPageLoadingState,
@@ -42,6 +42,7 @@ function ProjectDashboard() {
{ id: 'details', label: 'Details' },
{ id: 'events', label: 'Events' },
{ id: 'clients', label: 'Clients' },
+ { id: 'tracking', label: 'Tracking script' },
{ id: 'widgets', label: 'Widgets' },
{ id: 'imports', label: 'Imports' },
];
@@ -56,11 +57,11 @@ function ProjectDashboard() {
return (
<div className="container p-8">
<PageHeader
- title="Project settings"
description="Manage your project settings here"
+ title="Project settings"
/>
- <Tabs value={tab} onValueChange={handleTabChange} className="mt-2 mb-8">
+ <Tabs className="mt-2 mb-8" onValueChange={handleTabChange} value={tab}>
<TabsList>
{settingsTabs.map((tab) => (
<TabsTrigger key={tab.id} value={tab.id}>