deepspace 0.10.0 → 0.10.2

package/dist/public-BGRX_Cjd.d.ts

@@ -0,0 +1,234 @@
+import { ReactNode, ReactElement, ComponentType } from 'react';
+
+type DocumentationAssistantAccess = 'disabled' | 'public' | 'authenticated';
+type DocumentationMcpAccess = 'disabled' | 'public';
+declare const DOCUMENTATION_CONTEXTUAL_ACTIONS: readonly ["copy", "view", "assistant", "chatgpt", "claude", "mcp", "add-mcp", "cursor", "vscode"];
+type DocumentationContextualAction = (typeof DOCUMENTATION_CONTEXTUAL_ACTIONS)[number];
+interface DocumentationFontConfig {
+    family: string;
+    weight?: number | string;
+    source?: string;
+    format?: string;
+}
+interface DocumentationThemeConfig {
+    preset?: string;
+    accent?: string;
+    background?: string;
+    backgroundDark?: string;
+    backgroundDecoration?: 'none' | 'gradient' | 'grid';
+    bodyFont?: DocumentationFontConfig;
+    headingFont?: DocumentationFontConfig;
+    monoFont?: DocumentationFontConfig;
+    codeBlockMode?: 'dark' | 'system';
+    eyebrowStyle?: 'section' | 'breadcrumbs' | 'none';
+    logo?: string;
+    logoDark?: string;
+    logoHref?: string;
+    favicon?: string;
+    defaultMode?: 'light' | 'dark' | 'system';
+    strictMode?: boolean;
+}
+interface DocumentationLinkConfig {
+    label: string;
+    href: string;
+}
+interface DocumentationNavGroup {
+    group: string;
+    pages: DocumentationNavigationItem[];
+}
+type DocumentationNavigationItem = string | DocumentationLinkConfig | DocumentationNavGroup;
+declare const DOCUMENTATION_OPENAPI_SAMPLE_LANGUAGES: readonly ["curl", "javascript", "python", "go"];
+type DocumentationOpenApiSampleLanguage = (typeof DOCUMENTATION_OPENAPI_SAMPLE_LANGUAGES)[number];
+type DocumentationOpenApiSampleDefaults = 'required' | 'all';
+interface DocumentationOpenApiExamplesConfig {
+    languages: DocumentationOpenApiSampleLanguage[];
+    defaults: DocumentationOpenApiSampleDefaults;
+    autogenerate: boolean;
+}
+interface DocumentationOpenApiConfig {
+    source: string;
+    route?: string;
+    label?: string;
+    playground?: boolean;
+    baseUrl?: string;
+    examples?: DocumentationOpenApiExamplesConfig;
+}
+interface DocumentationAssistantConfig {
+    access: DocumentationAssistantAccess;
+    model?: string;
+    suggestions?: string[];
+}
+interface DocumentationMcpConfig {
+    access: DocumentationMcpAccess;
+}
+interface DocumentationContextualConfig {
+    actions: DocumentationContextualAction[];
+}
+interface DocumentationSeoConfig {
+    noindex?: boolean;
+    ogImage?: string;
+    metaTags?: Record<string, string>;
+}
+interface DocumentationConfig {
+    $schema?: string;
+    name: string;
+    description?: string;
+    source: string;
+    output: string;
+    url?: string;
+    /** Explicit custom hostnames that mount this documentation at `/`. */
+    domains: string[];
+    theme: DocumentationThemeConfig;
+    navigation?: DocumentationNavigationItem[];
+    links: DocumentationLinkConfig[];
+    footer: DocumentationLinkConfig[];
+    redirects: Record<string, string>;
+    openapi: DocumentationOpenApiConfig[];
+    assistant: DocumentationAssistantConfig;
+    mcp: DocumentationMcpConfig;
+    contextual: DocumentationContextualConfig;
+    seo: DocumentationSeoConfig;
+}
+interface DocumentationHeading {
+    depth: number;
+    id: string;
+    text: string;
+}
+interface DocumentationPage {
+    sourcePath: string;
+    relativePath: string;
+    route: string;
+    title: string;
+    description?: string;
+    hidden: boolean;
+    noindex: boolean;
+    markdown: string;
+    html: string;
+    text: string;
+    headings: DocumentationHeading[];
+    sourceFormat: 'markdown' | 'mdx' | 'generated';
+    kind: 'page' | 'openapi';
+    openapi?: DocumentationOpenApiOperation;
+}
+interface DocumentationNavigationPage {
+    kind: 'page';
+    route: string;
+    label: string;
+}
+interface DocumentationNavigationLink {
+    kind: 'link';
+    href: string;
+    label: string;
+}
+interface DocumentationNavigationGroup {
+    kind: 'group';
+    label: string;
+    items: DocumentationNavigationNode[];
+}
+type DocumentationNavigationNode = DocumentationNavigationPage | DocumentationNavigationLink | DocumentationNavigationGroup;
+interface DocumentationOpenApiParameter {
+    name: string;
+    in: string;
+    required: boolean;
+    description?: string;
+    schema?: unknown;
+    example?: unknown;
+}
+interface DocumentationOpenApiResponse {
+    status: string;
+    description: string;
+    schema?: unknown;
+}
+interface DocumentationOpenApiCodeSample {
+    language: string;
+    label: string;
+    syntax: string;
+    code: string;
+    generated: boolean;
+}
+interface DocumentationOpenApiOperation {
+    method: string;
+    path: string;
+    operationId: string;
+    summary: string;
+    description?: string;
+    tags: string[];
+    parameters: DocumentationOpenApiParameter[];
+    requestBody?: unknown;
+    responses: DocumentationOpenApiResponse[];
+    security?: unknown;
+    baseUrl?: string;
+    playground: boolean;
+    codeSamples: DocumentationOpenApiCodeSample[];
+}
+interface DocumentationRuntimePageLink {
+    route: string;
+    title: string;
+}
+interface DocumentationRuntimePage {
+    route: string;
+    title: string;
+    description?: string;
+    html: string;
+    headings: DocumentationHeading[];
+    kind: DocumentationPage['kind'];
+    markdownUrl: string;
+    openapi?: DocumentationOpenApiOperation;
+}
+interface DocumentationRuntimeData {
+    /** Public mount (`/docs` on an app host, empty on an explicit documentation domain). */
+    basePath: string;
+    config: Pick<DocumentationConfig, 'name' | 'description' | 'theme' | 'links' | 'footer' | 'assistant' | 'mcp' | 'contextual'>;
+    page: DocumentationRuntimePage;
+    navigation: DocumentationNavigationNode[];
+    breadcrumbs: string[];
+    previous?: DocumentationRuntimePageLink;
+    next?: DocumentationRuntimePageLink;
+}
+
+interface DocumentationAppProps {
+    data: DocumentationRuntimeData;
+    /** Rendered page body. Omit children to use the compiler's static HTML. */
+    children?: ReactNode;
+    navigating?: boolean;
+    onNavigate?: (href: string) => void;
+    onPrefetch?: (href: string) => void;
+}
+declare function DocumentationApp({ data, children, navigating, onNavigate, }: DocumentationAppProps): ReactElement;
+
+interface TitledProps {
+    children?: ReactNode;
+    label?: string;
+    title?: string;
+}
+declare function Note(props: TitledProps): ReactElement;
+declare function Tip(props: TitledProps): ReactElement;
+declare function Warning(props: TitledProps): ReactElement;
+declare function Info(props: TitledProps): ReactElement;
+declare function Card({ children, href, label, title }: TitledProps & {
+    href?: string;
+}): ReactElement;
+declare function Accordion({ children, label, title }: TitledProps): ReactElement;
+declare function AccordionGroup({ children }: TitledProps): ReactElement;
+declare function Step({ children, label, title }: TitledProps): ReactElement;
+declare function Steps({ children }: TitledProps): ReactElement;
+declare function Tab({ children, label, title }: TitledProps): ReactElement;
+declare function Tabs({ children }: TitledProps): ReactElement;
+declare function CodeGroup({ children, label, title }: TitledProps): ReactElement;
+
+type DocumentationPageComponent = ComponentType<{
+    components?: Record<string, ComponentType<never>>;
+}>;
+interface DocumentationSiteProps extends DocumentationAppProps {
+    /** The current compiled Markdown or MDX page. */
+    children: ReactNode;
+}
+type DocumentationSiteComponent = ComponentType<DocumentationSiteProps>;
+/** The polished SDK-owned documentation shell. */
+declare const DefaultDocumentation: typeof DocumentationApp;
+declare function DocumentationContent({ data, Page, }: {
+    data: DocumentationRuntimeData;
+    Page?: DocumentationPageComponent;
+}): ReactElement;
+
+export { Accordion as A, Card as C, type DocumentationRuntimeData as D, Info as I, Note as N, Step as S, Tab as T, Warning as W, type DocumentationPageComponent as a, type DocumentationSiteComponent as b, AccordionGroup as c, CodeGroup as d, DefaultDocumentation as e, DocumentationApp as f, type DocumentationAppProps as g, DocumentationContent as h, type DocumentationSiteProps as i, Steps as j, Tabs as k, Tip as l };

package/dist/schema.d.ts

@@ -0,0 +1,186 @@
+/**
+ * Shared type definitions for the DeepSpace SDK
+ *
+ * Types used by both client-side SDK and server-side workers.
+ */
+type ColumnInterpretation = {
+    kind: 'plain';
+} | {
+    kind: 'currency';
+    symbol: string;
+    decimals: number;
+} | {
+    kind: 'date';
+    format?: string;
+} | {
+    kind: 'datetime';
+    format?: string;
+} | {
+    kind: 'boolean';
+    trueLabel?: string;
+    falseLabel?: string;
+} | {
+    kind: 'percent';
+    decimals?: number;
+} | {
+    kind: 'select';
+    options: string[];
+} | {
+    kind: 'multiselect';
+    options: string[];
+} | {
+    kind: 'url';
+} | {
+    kind: 'email';
+} | {
+    kind: 'json';
+} | {
+    kind: 'reference';
+    targetTable: string;
+    displayColumn: string;
+};
+interface ColumnDefinition {
+    /** Stable ID override (survives renames). Falls back to `col_{name}`. */
+    id?: string;
+    name: string;
+    storage: 'number' | 'text';
+    interpretation: ColumnInterpretation | string;
+    expression?: string;
+    userBound?: boolean;
+    immutable?: boolean;
+    required?: boolean;
+    default?: unknown;
+    timestampTrigger?: {
+        field: string;
+        value?: unknown;
+    };
+}
+type PermissionLevel = boolean | 'own' | 'unclaimed-or-own' | 'collaborator' | 'team' | 'access' | 'published' | 'shared';
+interface RolePermissions {
+    read: PermissionLevel;
+    /** Create has no existing record to evaluate, so it is an explicit grant. */
+    create: boolean;
+    update: PermissionLevel;
+    delete: PermissionLevel;
+    /** If set, only these columns can be updated by this role. */
+    writableFields?: string[];
+}
+interface CollectionSchema {
+    name: string;
+    /** Every collection is stored in typed SQL columns. */
+    columns: ColumnDefinition[];
+    /** Composite uniqueness constraint (for example `['userId', 'taskId']`). */
+    uniqueOn?: string[];
+    /** Ownership column; defaults to the row creator. */
+    ownerField?: string;
+    /** Column containing a JSON array of collaborator user ids. */
+    collaboratorsField?: string;
+    /** Column containing the team id used by team permission rules. */
+    teamField?: string;
+    /** A string is public when equal to `public`; an object supplies an exact value. */
+    visibilityField?: string | {
+        field: string;
+        value: unknown;
+    };
+    /** Permissions per role; `*` is the catch-all role. */
+    permissions: Record<string, RolePermissions>;
+    /** Default role assigned on the `users` collection. */
+    defaultRole?: string;
+}
+
+/**
+ * Collection Schema Definitions & Validation
+ *
+ * All collections use typed SQL columns. No document-mode / fields-based storage.
+ */
+
+/** Standard user columns. Apps spread these into their users schema. */
+declare const USERS_COLUMNS: ColumnDefinition[];
+declare const BASE_USERS_SCHEMA: CollectionSchema;
+
+/**
+ * AI Chat Schemas
+ *
+ * Pre-built collection schemas for DO-backed AI chat history.
+ * The worker is the only writer; the client reads via `useQuery`.
+ */
+
+declare const AI_CHATS_SCHEMA: CollectionSchema;
+declare const AI_MESSAGES_SCHEMA: CollectionSchema;
+
+/**
+ * Messaging Schemas
+ *
+ * Pre-built collection schemas for messaging functionality.
+ * Any app can import these to add channels, messages, reactions, etc.
+ *
+ * @example
+ * ```typescript
+ * import { CHANNELS_SCHEMA, MESSAGES_SCHEMA, REACTIONS_SCHEMA } from 'deepspace/worker'
+ * export const schemas = [usersSchema, CHANNELS_SCHEMA, MESSAGES_SCHEMA, REACTIONS_SCHEMA]
+ * ```
+ */
+
+declare const CHANNELS_SCHEMA: CollectionSchema;
+declare const MESSAGES_SCHEMA: CollectionSchema;
+declare const REACTIONS_SCHEMA: CollectionSchema;
+declare const CHANNEL_MEMBERS_SCHEMA: CollectionSchema;
+declare const CHANNEL_INVITATIONS_SCHEMA: CollectionSchema;
+declare const READ_RECEIPTS_SCHEMA: CollectionSchema;
+
+/**
+ * Shared conversation schemas for RecordRoom-based conversations.
+ *
+ * These define the collections inside a per-conversation RecordRoom DO.
+ * Used by apps that have messaging/conversation features (slack-clone,
+ * helpdesk, mail, reddit-clone, etc.).
+ *
+ * Each conversation gets its own RecordRoom DO keyed by `conv:{id}`.
+ */
+
+declare const CONVERSATION_SCHEMAS: CollectionSchema[];
+/**
+ * Voting schemas for Reddit-style apps.
+ * Add these alongside CONVERSATION_SCHEMAS for apps that need voting.
+ */
+declare const VOTING_SCHEMAS: CollectionSchema[];
+
+/**
+ * Directory DO Schemas
+ *
+ * Purpose-built collections for the `dir:{appName}` global DO type.
+ * This is the cross-app-visible directory layer — any app can subscribe
+ * to another app's directory in real-time via SHARED_CONNECTIONS.
+ *
+ * Five collections covering all standard communication/social patterns:
+ * - conversations: channels, DMs, email threads, support chats
+ * - conversation_state: per-user metadata (read cursor, stars, labels, folders)
+ * - communities: groups, forums, boards, projects
+ * - memberships: user membership in communities
+ * - posts: feed items, tweets, Q&A questions, announcements
+ *
+ * Domain-specific data (tickets, CRM, procurement) stays in app DOs.
+ * Message content stays in conv:{id} DOs (CONVERSATION_SCHEMAS).
+ */
+
+/** All directory schemas for the `dir:{appName}` global DO type. */
+declare const DIRECTORY_SCHEMAS: CollectionSchema[];
+
+/**
+ * Workspace DO Schemas
+ *
+ * All collections for the workspace:default Durable Object.
+ * This DO consolidates shared, cross-app business data:
+ *
+ * - teams / team_members — workspace-wide team management (replaces built-in teams)
+ * - tasks / projects / tags — team-scoped task management
+ * - people — shared contacts directory
+ * - transactions / accounts — shared financial ledger
+ *
+ * Team-scoped collections use teamField RBAC: members see only
+ * their team's records; admins see everything.
+ */
+
+declare const WORKSPACE_SCHEMAS: CollectionSchema[];
+
+export { AI_CHATS_SCHEMA, AI_MESSAGES_SCHEMA, BASE_USERS_SCHEMA, CHANNELS_SCHEMA, CHANNEL_INVITATIONS_SCHEMA, CHANNEL_MEMBERS_SCHEMA, CONVERSATION_SCHEMAS, type CollectionSchema, type ColumnDefinition, type ColumnInterpretation, DIRECTORY_SCHEMAS, MESSAGES_SCHEMA, type PermissionLevel, REACTIONS_SCHEMA, READ_RECEIPTS_SCHEMA, type RolePermissions, USERS_COLUMNS, VOTING_SCHEMAS, WORKSPACE_SCHEMAS };