Beautiful, AI-native markdown IDE and LLM wiki
TypeScript 2nd-brainagent-skillsclaudecodexcompany-braindocsknowledge-knowledge-baseknowledge-managementllmllm-wikillm-wiki-karpathymarkdownmarkdown-editormdmdxnotespkmsecond-brainskills
import type { SyncMode } from '@inkeep/open-knowledge-core/config/auto-sync-mode';
import type {
PushPermissionWire as GitPushPermission,
PullOutcome,
SyncErrorCode,
SyncStatusSchema,
} from '@inkeep/open-knowledge-core/schemas/api';
import { useEffect, useState } from 'react';
import { subscribeToDocumentsChanged } from '@/lib/documents-events';
type GitSyncState =
| 'dormant'
| 'idle'
| 'fetching'
| 'pulling'
| 'pushing'
| 'conflict'
| 'offline'
| 'auth-error'
| 'disabled';
type ClientFieldsNotOnWire = Exclude<keyof GitSyncStatus, keyof typeof SyncStatusSchema.shape>;
const _noClientOnlyFields: [ClientFieldsNotOnWire] extends [never] ? true : ClientFieldsNotOnWire =
true;
void _noClientOnlyFields;
export interface GitSyncStatus {
state: GitSyncState;
lastSyncUtc: string | null;
lastRunUtc?: string | null;
lastPullOkUtc?: string | null;
lastPushOkUtc?: string | null;
lastFetchUtc: string | null;
lastPullUtc?: string | null;
lastPullOutcome?: PullOutcome | null;
ahead: number;
behind: number;
conflictCount: number;
hasRemote: boolean;
syncEnabled: boolean;
syncMode?: SyncMode;
identityUnresolved?: boolean;
remote?: {
label: string;
webUrl: string | null;
transport?: 'https' | 'http' | 'ssh' | 'git';
} | null;
pushError?: string;
pushErrorCode?: SyncErrorCode;
pullError?: string;
pullErrorCode?: SyncErrorCode;
pausedReason?: string;
blockingPaths?: string[];
refusedSymlinkPaths?: string[];
pushPermission?: GitPushPermission;
}
type SyncStatusFetchError = 'network' | 'server';
interface FetchSyncStatusResult {
status: GitSyncStatus | null;
error?: SyncStatusFetchError;
}
async function fetchSyncStatus(): Promise<FetchSyncStatusResult> {
try {
const res = await fetch('/api/sync/status');
if (!res.ok) return { status: null, error: 'server' };
return { status: (await res.json()) as GitSyncStatus };
} catch {
return { status: null, error: 'network' };
}
}
export function useGitSyncStatus(): GitSyncStatus | null {
return useGitSyncStatusDetailed().status;
}
export function useGitSyncStatusDetailed(): {
status: GitSyncStatus | null;
fetchError: SyncStatusFetchError | null;
} {
const [status, setStatus] = useState<GitSyncStatus | null>(null);
const [fetchError, setFetchError] = useState<SyncStatusFetchError | null>(null);
function refresh() {
void fetchSyncStatus().then(({ status: s, error }) => {
setFetchError(error ?? null);
if (s) setStatus(s);
});
}
// biome-ignore lint/correctness/useExhaustiveDependencies: refresh is intentionally stable (defined in component scope)
useEffect(() => {
refresh();
}, []);
// biome-ignore lint/correctness/useExhaustiveDependencies: refresh is intentionally stable (defined in component scope)
useEffect(() => {
return subscribeToDocumentsChanged((channels) => {
if (channels.includes('sync-status')) {
refresh();
}
});
}, []);
return { status, fetchError };
}