Files
DataStack/app/vcon/sdk/page.tsx
T

326 lines
11 KiB
TypeScript
Raw Normal View History

2026-10-23 11:43:49 -05:00
'use client';
import { PageShell } from '@/components/layout/PageShell';
2026-10-23 11:43:49 -05:00
import { Button } from '@/components/ui/Button';
import { Card } from '@/components/ui/Card';
import { CodeBlock } from '@/components/ui/CodeBlock';
2026-10-23 11:43:49 -05:00
import { Select } from '@/components/ui/Input';
import { Panel } from '@/components/ui/Panel';
import { StatStrip } from '@/components/ui/StatStrip';
2026-10-23 11:43:49 -05:00
import { useToast } from '@/components/ui/Toast';
2026-11-16 23:10:44 +06:00
import { getCached, setCached } from '@/lib/vconCache';
import { resolvePublicEndpoints } from '@/lib/vconUiHelpers';
2026-10-23 19:56:38 -07:00
import { useEffect, useState } from 'react';
2026-10-23 11:43:49 -05:00
interface SdkClientItem {
clientId: string;
name: string;
status?: 'active' | 'revoked';
tokenPreview?: string;
token?: string;
}
2026-10-23 11:43:49 -05:00
export default function SdkGuidePage() {
const { success, error } = useToast();
const [clients, setClients] = useState<SdkClientItem[]>(() =>
getCached<SdkClientItem[]>('vcon:clients', [])
);
2026-11-16 23:10:44 +06:00
const [selectedClientId, setSelectedClientId] = useState<string>(() => {
const cached = getCached<SdkClientItem[]>('vcon:clients', []);
return cached.find((c) => c.status !== 'revoked')?.clientId ?? cached[0]?.clientId ?? '';
2026-11-16 23:10:44 +06:00
});
const [selectedClientToken, setSelectedClientToken] = useState<string>('');
const [loadingToken, setLoadingToken] = useState<boolean>(false);
const [serverUrl, setServerUrl] = useState<string>('http://localhost:4000');
const [apiUrl, setApiUrl] = useState<string>('http://localhost:3000');
2026-10-23 11:43:49 -05:00
useEffect(() => {
const initialPort = getCached<number>('vcon:server-port', 4000);
const initialEndpoints = resolvePublicEndpoints(window.location, initialPort);
setServerUrl(initialEndpoints.serverUrl);
setApiUrl(initialEndpoints.apiUrl);
async function loadSdkContext() {
2026-10-23 11:43:49 -05:00
try {
const [clientsRes, metricsRes] = await Promise.all([
fetch('/api/clients', { cache: 'no-store' }),
fetch('/api/metrics', { cache: 'no-store' }).catch(() => null),
]);
if (clientsRes.status === 401 || metricsRes?.status === 401) {
window.location.assign('/vcon/login');
return;
}
if (clientsRes.ok) {
const data = await clientsRes.json();
const list = setCached<SdkClientItem[]>('vcon:clients', data.clients || []);
2026-10-23 11:43:49 -05:00
setClients(list);
if (list.length > 0) {
setSelectedClientId((prev) =>
list.some((c) => c.clientId === prev)
? prev
: list.find((c) => c.status !== 'revoked')?.clientId ?? list[0].clientId
);
2026-10-23 11:43:49 -05:00
}
}
if (metricsRes && metricsRes.ok) {
const metricsData = await metricsRes.json().catch(() => null);
const runtimePort = Number(metricsData?.runtime?.serverPort);
if (Number.isFinite(runtimePort) && runtimePort > 0) {
setCached('vcon:server-port', runtimePort);
const resolved = resolvePublicEndpoints(window.location, runtimePort);
setServerUrl(resolved.serverUrl);
setApiUrl(resolved.apiUrl);
}
}
2026-10-23 11:43:49 -05:00
} catch {
// Retain cached list on transient network error
2026-10-23 11:43:49 -05:00
}
}
void loadSdkContext();
2026-10-23 11:43:49 -05:00
}, []);
useEffect(() => {
if (!selectedClientId) {
setSelectedClientToken('');
return;
}
let cancelled = false;
setSelectedClientToken('');
setLoadingToken(true);
async function fetchToken() {
try {
const res = await fetch(
`/api/clients/${encodeURIComponent(selectedClientId)}?includeToken=true`,
{ cache: 'no-store' }
);
if (res.status === 401) {
window.location.assign('/vcon/login');
return;
}
if (res.ok) {
const data = await res.json();
if (!cancelled) {
setSelectedClientToken(String(data?.client?.token || ''));
}
} else if (!cancelled) {
setSelectedClientToken('');
}
} catch {
if (!cancelled) setSelectedClientToken('');
} finally {
if (!cancelled) setLoadingToken(false);
}
}
void fetchToken();
return () => {
cancelled = true;
};
}, [selectedClientId]);
const activeClient =
clients.find((c) => c.clientId === selectedClientId) || clients[0];
const resolvedToken = loadingToken
? ''
: selectedClientToken || activeClient?.token || '';
const sampleToken = loadingToken
? 'LOADING_CLIENT_JWT_TOKEN...'
: resolvedToken || 'YOUR_SIGNED_CLIENT_JWT_TOKEN';
2026-10-23 11:43:49 -05:00
const configSnippet = `# config.datastack.py — Place in your Python project root
DATASTACK_CONFIG = {
"SERVER_URL": "${serverUrl}",
"API_URL": "${apiUrl}",
"CLIENT_TOKEN": "${sampleToken}",
"CLIENT_ID": "${activeClient?.clientId || ''}",
"AUTO_CONNECT": True,
"ENABLE_HTTP_FALLBACK": True,
"HEARTBEAT_INTERVAL_SEC": 5.0,
"MAX_RETRIES": 3,
"BATCH_CHUNK_SIZE": 250,
"OFFLINE_SPOOL_ENABLED": True,
"OFFLINE_SPOOL_DIR": ".datastack_spool",
}`;
2026-10-23 11:43:49 -05:00
const pythonSnippet = `from datastack import DataStack
2026-10-23 11:43:49 -05:00
# Automatically discovers config.datastack.py and connects
client = DataStack()
2026-10-23 11:43:49 -05:00
# 1. Single Event (WebSocket + Auto HTTP Fallback + Offline Spool)
res = client.send({
"event_type": "page_view",
"url": "/products/wireless-headphones",
"user_id": "usr_9942"
})
print("Event response:", res)
2026-10-23 11:43:49 -05:00
# 2. Batch Events
batch_res = client.send_batch([
{"sensor": "temp", "value": 24.5, "unit": "C"},
{"sensor": "humidity", "value": 61.2, "unit": "%"}
])
print("Batch response:", batch_res)
# 3. Direct File Ingestion (.csv, .json, .jsonl)
file_res = client.send_file("events_dataset.csv", chunk_size=250)
print("File ingestion:", file_res)
# 4. Inspect Connection & Heartbeat IDLE Status
print("SDK Status:", client.status())
client.disconnect()`;
2026-10-23 11:43:49 -05:00
const copySnippet = async (text: string, label: string) => {
try {
if (!navigator?.clipboard?.writeText) {
throw new Error('Clipboard API unavailable in this browser context');
}
await navigator.clipboard.writeText(text);
success('Copied', `${label} copied`);
} catch (copyErr) {
error(
'Copy failed',
copyErr instanceof Error
? copyErr.message
: 'Unable to copy to clipboard. Copy manually from the code block.'
);
}
2026-10-23 11:43:49 -05:00
};
return (
<PageShell
title="Python SDK"
actions={
<>
{resolvedToken && (
<Button
size="xs"
variant="secondary"
icon="Key"
disabled={loadingToken}
onClick={() => void copySnippet(resolvedToken, 'Client JWT token')}
>
Copy Token
</Button>
)}
<Button
size="xs"
variant="secondary"
icon="FileCode"
disabled={loadingToken}
onClick={() => void copySnippet(configSnippet, 'config.datastack.py')}
>
Copy Config
</Button>
<Button
size="xs"
variant="secondary"
icon="Copy"
onClick={() => void copySnippet(pythonSnippet, 'Python SDK snippet')}
>
Copy Code
</Button>
</>
}
>
<StatStrip
items={[
{ label: 'SDK package', value: 'datastack (v2.2.0)', dot: 'ok' },
{ label: 'Transport', value: 'WS + HTTP Fallback + Offline Spool' },
{ label: 'Server endpoint', value: serverUrl },
{
label: 'Active client',
value: activeClient
? activeClient.status === 'revoked'
? `${activeClient.clientId} (revoked)`
: activeClient.clientId
: 'None selected',
dot: activeClient?.status === 'revoked' ? 'off' : activeClient ? 'ok' : undefined,
},
]}
/>
<Card
compact
className="flex w-full flex-col gap-1.5 bg-[var(--surface)] px-3 py-2.5"
>
<div className="flex items-center justify-between gap-2 font-mono text-[11.5px]">
<span className="truncate text-[var(--accent)]">
pip install /path/to/datastack/sdk/python/datastack
</span>
<Button
size="xs"
variant="ghost"
icon="Copy"
aria-label="Copy pip install command"
onClick={() =>
void copySnippet(
'pip install /path/to/datastack/sdk/python/datastack',
'Pip command'
)
}
/>
</div>
<p className="text-[11px] text-[var(--text-faint)]">
Self-hosted package bundled in <code className="font-mono text-[var(--text-muted)]">sdk/python/datastack</code>. From inside the repo run{' '}
<code className="font-mono text-[var(--text-muted)]">pip install ./sdk/python/datastack</code>, or build a portable wheel with{' '}
<code className="font-mono text-[var(--text-muted)]">pip wheel ./sdk/python/datastack -w dist/</code> for external projects.
</p>
</Card>
2026-10-23 11:43:49 -05:00
<Panel
title="Step 1 — config.datastack.py"
className="w-full"
action={
<div className="flex items-center gap-2">
{clients.length > 0 && (
<div className="w-[190px]">
<Select
compact
aria-label="Select SDK client"
value={selectedClientId}
onChange={(e) => setSelectedClientId(e.target.value)}
>
{clients.map((c) => (
<option key={c.clientId} value={c.clientId}>
{c.clientId}
</option>
))}
</Select>
</div>
)}
<Button
size="xs"
variant="ghost"
icon="Copy"
aria-label="Copy config.datastack.py"
disabled={loadingToken}
onClick={() => void copySnippet(configSnippet, 'config.datastack.py')}
/>
</div>
}
>
<CodeBlock>{configSnippet}</CodeBlock>
</Panel>
<Panel
title="Step 2 — Application Usage (Events, Batches & Direct CSV/JSON Files)"
className="w-full"
action={
<Button
size="xs"
variant="ghost"
icon="Copy"
aria-label="Copy Python SDK snippet"
onClick={() => void copySnippet(pythonSnippet, 'Python SDK snippet')}
/>
}
>
<CodeBlock>{pythonSnippet}</CodeBlock>
</Panel>
</PageShell>
2026-10-23 11:43:49 -05:00
);
}