mirror of
https://github.com/hanzoai/insights.git
synced 2026-10-30 16:15:31 +00:00
zeekay
1b367e2b62
The tree was a debranded snapshot of upstream taken around 2026-02-20, and upstream has moved about five months since. This replaces it with upstream master, mechanically re-derived: bin/debrand does the rename, and the pipeline and squashed migrations are restored from the shipped tree. Not a merge. The previous import replaced the tree wholesale in a single commit, so there is no shared content history to merge against. Reproducing the rename on the new tree is what actually converges. What survives: .hanzo/workflows, the Dockerfiles and bin/docker* entrypoints, compose files, LLM.md, and insights/migrations. The squashed initial migration is load-bearing — the live database records it by name, so upstream's ~918 individual migrations cannot come back. Nine products are dropped as unreferenced. Twenty-one more that we do not run are kept anyway because the core app still imports them; unpicking those is a refactor and does not belong in a rebase. This base does not build yet, and the reasons are not in the rename: upstream now wants Python 3.13.13 against our 3.12.12 and Django 5.2 against our 4.2, and the dependency manifests still name upstream packages that we republish under our own names. Those are decisions, not renames.
189 lines
7.5 KiB
TypeScript
189 lines
7.5 KiB
TypeScript
import { OnboardingComponentsContext, createInstallation } from 'scenes/onboarding/shared/OnboardingDocsContentWrapper'
|
|
|
|
import { StepDefinition } from '../steps'
|
|
import { SDK_DEFAULTS_DATE } from './_snippets/sdkDefaults'
|
|
|
|
export const getSvelteClientSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, CalloutBox, dedent } = ctx
|
|
|
|
return [
|
|
{
|
|
title: 'Install the package',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>Install the Insights JavaScript library using your package manager:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'bash',
|
|
file: 'npm',
|
|
code: dedent`
|
|
npm install insights-js
|
|
`,
|
|
},
|
|
{
|
|
language: 'bash',
|
|
file: 'yarn',
|
|
code: dedent`
|
|
yarn add insights-js
|
|
`,
|
|
},
|
|
{
|
|
language: 'bash',
|
|
file: 'pnpm',
|
|
code: dedent`
|
|
pnpm add insights-js
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
</>
|
|
),
|
|
},
|
|
{
|
|
title: 'Initialize Insights',
|
|
badge: 'required',
|
|
content: (
|
|
<>
|
|
<Markdown>
|
|
If you haven't created a root layout already, create a new file called `+layout.js` in your
|
|
`src/routes` folder. Check the environment is the browser, and initialize Insights if so:
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'javascript',
|
|
file: 'src/routes/+layout.js',
|
|
code: dedent`
|
|
import insights from 'insights-js'
|
|
import { browser } from '$app/environment';
|
|
import { onMount } from 'svelte';
|
|
|
|
export const load = async () => {
|
|
if (browser) {
|
|
insights.init(
|
|
'<ph_project_token>',
|
|
{
|
|
api_host: '<ph_client_api_host>',
|
|
defaults: '${SDK_DEFAULTS_DATE}'
|
|
}
|
|
)
|
|
}
|
|
|
|
return
|
|
};
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<CalloutBox type="fyi" title="SvelteKit layout">
|
|
<Markdown>
|
|
Learn more about [SvelteKit layouts](https://kit.svelte.dev/docs/routing#layout) in the
|
|
official documentation.
|
|
</Markdown>
|
|
</CalloutBox>
|
|
</>
|
|
),
|
|
},
|
|
]
|
|
}
|
|
|
|
export const getSvelteServerSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { CodeBlock, Markdown, CalloutBox, dedent } = ctx
|
|
|
|
return [
|
|
{
|
|
title: 'Server-side setup',
|
|
badge: 'optional',
|
|
content: (
|
|
<>
|
|
<Markdown>Install `insights-node` using your package manager:</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'bash',
|
|
file: 'npm',
|
|
code: dedent`
|
|
npm install insights-node --save
|
|
`,
|
|
},
|
|
{
|
|
language: 'bash',
|
|
file: 'yarn',
|
|
code: dedent`
|
|
yarn add insights-node
|
|
`,
|
|
},
|
|
{
|
|
language: 'bash',
|
|
file: 'pnpm',
|
|
code: dedent`
|
|
pnpm add insights-node
|
|
`,
|
|
},
|
|
{
|
|
language: 'bash',
|
|
file: 'Bun',
|
|
code: dedent`
|
|
bun add insights-node
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<Markdown>
|
|
Then, initialize the Insights Node client where you'd like to use it on the server side. For
|
|
example, in a load function:
|
|
</Markdown>
|
|
<CodeBlock
|
|
blocks={[
|
|
{
|
|
language: 'javascript',
|
|
file: 'routes/+page.server.js',
|
|
code: dedent`
|
|
import { Insights } from 'insights-node';
|
|
|
|
export async function load() {
|
|
const insights = new Insights('<ph_project_token>', { host: '<ph_client_api_host>' });
|
|
|
|
insights.capture({
|
|
distinctId: 'distinct_id_of_the_user',
|
|
event: 'event_name',
|
|
})
|
|
|
|
await insights.shutdown()
|
|
}
|
|
`,
|
|
},
|
|
]}
|
|
/>
|
|
<CalloutBox type="fyi" title="Note">
|
|
<Markdown>
|
|
Make sure to always call `insights.shutdown()` after capturing events from the server-side.
|
|
Insights queues events into larger batches, and this call forces all batched events to be
|
|
flushed immediately.
|
|
</Markdown>
|
|
</CalloutBox>
|
|
</>
|
|
),
|
|
},
|
|
]
|
|
}
|
|
|
|
export const getSvelteSteps = (ctx: OnboardingComponentsContext): StepDefinition[] => {
|
|
const { snippets } = ctx
|
|
const JSEventCapture = snippets?.JSEventCapture
|
|
|
|
return [
|
|
...getSvelteClientSteps(ctx),
|
|
...getSvelteServerSteps(ctx),
|
|
{
|
|
title: 'Send events',
|
|
badge: undefined,
|
|
content: <>{JSEventCapture && <JSEventCapture />}</>,
|
|
},
|
|
]
|
|
}
|
|
|
|
export const SvelteInstallation = createInstallation(getSvelteSteps)
|