@notis_ai/cli 0.2.13 → 0.2.14

package/template/.harness/index.html.tmpl

@@ -164,8 +164,35 @@
       });
     });
 
+    /**
+     * Records one runtime call and hands back the entry so the caller can
+     * stamp its outcome once the promise settles. Verify reads `ok` to tell a
+     * route that rendered from real data apart from one that only rendered its
+     * error states, so every runtime path must settle its own entry.
+     */
     function record(op, args) {
-      window.__harness.runtimeCalls.push({ op, args });
+      const entry = { op, args, ok: null, error: null, durationMs: null };
+      entry.startedAt = Date.now();
+      window.__harness.runtimeCalls.push(entry);
+      return entry;
+    }
+
+    function settle(entry, error) {
+      entry.durationMs = Date.now() - entry.startedAt;
+      delete entry.startedAt;
+      entry.ok = !error;
+      entry.error = error ? (error.message ? String(error.message) : String(error)) : null;
+    }
+
+    async function tracked(entry, run) {
+      try {
+        const value = await run();
+        settle(entry, null);
+        return value;
+      } catch (error) {
+        settle(entry, error);
+        throw error;
+      }
     }
 
     async function readJsonOrSnippet(response) {
@@ -214,29 +241,58 @@
         app: descriptor.app,
         route: descriptor.route,
         context: descriptor.context || {},
-        navigate: (args) => record('navigate', args),
+        navigate: (args) => {
+          settle(record('navigate', args), null);
+        },
+        // There is no manager chat here, so the handover is recorded and
+        // reported as drafted without any UI.
+        handover: async (payload) => {
+          settle(record('handover', payload), null);
+          return { status: 'drafted' };
+        },
         registerTopBarSearch: () => {},
         setTopBarSearchValue: () => {},
         setTopBarSearchLoading: () => {},
-        listTools: async () => {
-          record('listTools', {});
-          return descriptor.tools || [];
-        },
-        callTool: async (name, args) => {
-          record('callTool', { name, arguments: args || {} });
-          const fixture = lookupToolFixture(name, args || {});
-          if (fixture !== undefined) {
-            return structuredClone(fixture);
-          }
-          return { ok: true, result: null };
-        },
-        request: async (path, options) => {
-          record('request', { path, options });
-          if (fixtures && fixtures.requests && Object.prototype.hasOwnProperty.call(fixtures.requests, path)) {
-            return structuredClone(fixtures.requests[path]);
-          }
-          return null;
-        },
+        // No change feed here, so `useDatabaseSubscription` reports live=false
+        // and the app keeps whatever manual refresh it offers.
+        subscribeDatabase: () => () => {},
+        // There is no cloud computer behind the harness. Answering "not
+        // available" rather than throwing keeps `useCloudComputer` on the same
+        // fallback branch a user without a cloud computer would see.
+        cloudComputerFacts: async () => tracked(
+          record('cloudComputerFacts', {}),
+          async () => ({
+            available: false,
+            reason: 'unsupported_host',
+            sandbox: null,
+            cli_auth: {
+              gh: { authenticated: null, account: null, checked_at: null, reason: 'unsupported_host' },
+            },
+          }),
+        ),
+        listTools: async () => tracked(
+          record('listTools', {}),
+          async () => descriptor.tools || [],
+        ),
+        callTool: async (name, args) => tracked(
+          record('callTool', { name, arguments: args || {} }),
+          async () => {
+            const fixture = lookupToolFixture(name, args || {});
+            if (fixture !== undefined) {
+              return structuredClone(fixture);
+            }
+            return { ok: true, result: null };
+          },
+        ),
+        request: async (path, options) => tracked(
+          record('request', { path, options }),
+          async () => {
+            if (fixtures && fixtures.requests && Object.prototype.hasOwnProperty.call(fixtures.requests, path)) {
+              return structuredClone(fixtures.requests[path]);
+            }
+            return null;
+          },
+        ),
       };
     }
 
@@ -270,32 +326,45 @@
     function liveRuntime() {
       return {
         ...stubRuntime(),
-        listTools: async () => {
-          record('listTools', {});
-          const result = await runtimeQuery({ method: 'tools/list' });
-          return result.tools || [];
-        },
-        callTool: async (name, args) => {
-          record('callTool', { name, arguments: args || {} });
-          return runtimeQuery({ method: 'tools/call', name, arguments: args || {} });
-        },
-        request: async (path, options) => {
-          record('request', { path, options });
-          const response = await fetch(`${String(apiBase).replace(/\/$/, '')}${path}`, {
-            method: (options && options.method) || 'GET',
-            headers: {
-              Authorization: `Bearer ${jwt}`,
-              ...((options && options.body) ? { 'Content-Type': 'application/json' } : {}),
-              ...((options && options.headers) || {}),
-            },
-            body: options && options.body ? JSON.stringify(options.body) : undefined,
-          });
-          const { payload, snippet } = await readJsonOrSnippet(response);
-          if (!response.ok) {
-            throw new Error((payload && (payload.error || payload.message)) || snippet || `Request failed with status ${response.status}`);
-          }
-          return payload;
-        },
+        listTools: async () => tracked(
+          record('listTools', {}),
+          async () => {
+            const result = await runtimeQuery({ method: 'tools/list' });
+            return result.tools || [];
+          },
+        ),
+        callTool: async (name, args) => tracked(
+          record('callTool', { name, arguments: args || {} }),
+          async () => runtimeQuery({ method: 'tools/call', name, arguments: args || {} }),
+        ),
+        // Live mode must not inherit the stub's canned answer: it would settle
+        // ok: true with fake data and soften the all-calls-failed assertion.
+        cloudComputerFacts: async (options) => tracked(
+          record('cloudComputerFacts', options || {}),
+          async () => runtimeQuery({
+            method: 'cloud_computer/facts',
+            ...(options && options.refresh ? { refresh: true } : {}),
+          }),
+        ),
+        request: async (path, options) => tracked(
+          record('request', { path, options }),
+          async () => {
+            const response = await fetch(`${String(apiBase).replace(/\/$/, '')}${path}`, {
+              method: (options && options.method) || 'GET',
+              headers: {
+                Authorization: `Bearer ${jwt}`,
+                ...((options && options.body) ? { 'Content-Type': 'application/json' } : {}),
+                ...((options && options.headers) || {}),
+              },
+              body: options && options.body ? JSON.stringify(options.body) : undefined,
+            });
+            const { payload, snippet } = await readJsonOrSnippet(response);
+            if (!response.ok) {
+              throw new Error((payload && (payload.error || payload.message)) || snippet || `Request failed with status ${response.status}`);
+            }
+            return payload;
+          },
+        ),
       };
     }
 

package/template/packages/sdk/src/config.ts

@@ -83,23 +83,45 @@ export interface NotisAppAuthor {
 }
 
 export interface NotisAppSkillConfig {
+  /** Stable source-owned key used by other app declarations. */
   key: string;
+  /**
+   * Path to the skill, relative to notis.config.ts. Either a Markdown file
+   * (`./skills/onboarding.md`) or a directory holding SKILL.md plus its
+   * supporting files (`./skills/onboarding/`), which are packaged on deploy
+   * and materialized next to SKILL.md in the sandbox.
+   */
   path: string;
+  /** User-facing name used for the installed skill. */
   name: string;
   description?: string;
 }
 
 export interface NotisAppOnboardingConfig {
+  /** Key of a skill declared in `skills`. */
   skill: string;
+  /** Editable message placed in Notis when onboarding is opened. */
   prompt: string;
 }
 
 export interface NotisAppScreenshotConfig {
+  /** Conventional metadata/screenshot-N.png source path. */
   path: string;
+  /** Meaningful description used by the Store gallery and assistive technology. */
   alt: string;
+  /** Route slug captured by `notis apps screenshot`. */
   route?: string;
+  /**
+   * Named scenario from metadata/screenshot-fixtures.json. Its `tools` and
+   * `requests` override the file-level ones key by key for this capture, and
+   * its `actions` run once the route has mounted -- so one route can be shown
+   * in several states (populated, empty, a panel opened) without the states
+   * leaking into each other.
+   */
   scenario?: string;
+  /** Optional CSS selector captured as the truthful focal region for this Store image. */
   focus?: string;
+  /** Portal color scheme used while rendering this screenshot. Defaults to light. */
   theme?: 'light' | 'dark';
 }
 
@@ -131,6 +153,25 @@ export interface NotisAppCapabilities {
    * bound to the app's own databases.
    */
   workspaceDatabases?: 'read';
+
+  /**
+   * Read a few facts about the user's cloud computer: whether a sandbox exists
+   * and is running, and whether the GitHub CLI is signed in there.
+   *
+   * Without this an app has to infer them — the Workspaces app treated a
+   * configured repository as proof that `gh auth login` had happened, which
+   * cannot show an account name and cannot notice a revoked credential.
+   * `'read'` never creates, resumes or commands a sandbox. Read it with
+   * `useCloudComputer()`.
+   *
+   * `'shell'` additionally asks to command the cloud computer: it unlocks
+   * `LOCAL_NOTIS_RUN_SANDBOX_SHELL` and the sandbox file tools from this app's
+   * views (they are denied to every view otherwise), and implies the read
+   * facts. This is the same authority the user's own agent has on the sandbox,
+   * so the user is asked for it explicitly at install or in the Store grant
+   * step; declare it only when the app's core actions genuinely run there.
+   */
+  cloudComputer?: 'read' | 'shell';
 }
 
 export interface NotisAppConfig {
@@ -154,6 +195,7 @@ export interface NotisAppConfig {
   tagline?: string;
   /** @deprecated Add release entries to the root CHANGELOG.md instead. */
   versionNotes?: string;
+  /** Editorial screenshot order and capture scenarios for the Store listing. */
   screenshots?: NotisAppScreenshotConfig[];
   /**
    * Databases this app owns. A bare string publishes structure only; use the
@@ -167,8 +209,18 @@ export interface NotisAppConfig {
    */
   capabilities?: NotisAppCapabilities;
   routes?: NotisRouteConfig[];
+  /**
+   * Final tool names this app can call at runtime, enforced server-side. Use
+   * names returned by shared discovery, including native `LOCAL_NOTIS_*`,
+   * connected-service names such as `GMAIL_SEND_EMAIL`,
+   * `LOCAL_POSTFORME_*`, and `LOCAL_MCP_<SERVER>_<TOOL>`. App code calls
+   * each declared name directly with `useTool`; metered calls use the shared
+   * credit-cap and usage-billing path.
+   */
   tools?: string[];
+  /** Skills shipped from this app's source tree. */
   skills?: NotisAppSkillConfig[];
+  /** Optional onboarding entrypoint exposed from the app sidebar. */
   onboarding?: NotisAppOnboardingConfig;
 }
 

package/template/packages/sdk/src/documents.ts

@@ -12,6 +12,7 @@ import type {
   DatabasePropertyType,
   DocumentContentType,
   DocumentRecord,
+  SecretPropertyValue,
 } from './runtime';
 
 // ---------------------------------------------------------------------------
@@ -45,6 +46,23 @@ export function extractRichText(value: unknown): string {
     .join('');
 }
 
+/**
+ * Reads a `secret` property value. The platform only ever sends the pointer
+ * ({present, reference, status, metadata}), so this rebuilds it field by field
+ * rather than passing the payload through — an app can never surface secret
+ * material through this helper, whatever the server sent.
+ */
+export function getSecretValue(value: unknown): SecretPropertyValue {
+  const record = asRecord(value);
+  const metadata = asRecord(record?.metadata);
+  return {
+    present: record?.present === true,
+    reference: optionalString(record?.reference),
+    status: optionalString(record?.status),
+    metadata,
+  };
+}
+
 /** Extracts the ids of a normalized relation property value. */
 export function getRelationIds(value: unknown): string[] {
   if (!Array.isArray(value)) return [];
@@ -81,6 +99,9 @@ export function normalizePropertyValue(value: unknown): unknown {
     return items.map((item) => optionalString(asRecord(item)?.id) ?? item).filter(Boolean);
   }
   if (type === 'date') return optionalString(asRecord(record.date)?.start) ?? record.date ?? null;
+  // Before the `type in record` fallthrough: a secret value has no `secret`
+  // key, so passing it through would hand the caller the raw payload.
+  if (type === 'secret') return getSecretValue(record);
   if (type in record) return record[type];
   return value;
 }

package/template/packages/sdk/src/hooks/useCloudComputer.ts

@@ -0,0 +1,97 @@
+'use client';
+
+import { useCallback, useEffect, useRef, useState } from 'react';
+import { useNotisRuntime } from '../provider';
+import type { CloudComputerFacts } from '../runtime';
+
+export interface UseCloudComputerResult {
+  /**
+   * The facts, or null while the first read is in flight. `facts.available`
+   * is false when this host cannot answer — render the app's own fallback.
+   */
+  facts: CloudComputerFacts | null;
+  loading: boolean;
+  error: Error | null;
+  /** Re-read the facts. The platform caches them for a few minutes. */
+  refresh: () => Promise<void>;
+}
+
+const UNAVAILABLE: CloudComputerFacts = {
+  available: false,
+  reason: 'unsupported_host',
+  sandbox: null,
+  cli_auth: {
+    gh: { authenticated: null, account: null, checked_at: null, reason: 'unsupported_host' },
+  },
+};
+
+/**
+ * Read-only facts about the user's cloud computer.
+ *
+ * ```tsx
+ * const { facts } = useCloudComputer();
+ * const gh = facts?.available ? facts.cli_auth.gh : null;
+ *
+ * return gh?.authenticated
+ *   ? <p>Signed in as {gh.account}</p>
+ *   : <GithubConnect />;
+ * ```
+ *
+ * Requires `capabilities.cloudComputer: 'read'` in `notis.config.ts` and the
+ * user's approval at install time. It answers with state the platform already
+ * holds: reading it never creates, resumes or commands a sandbox, and the GitHub
+ * probe only runs when the sandbox is already awake. `authenticated: null`
+ * therefore means *unknown*, not *signed out* — keep the app's own fallback for
+ * that case and for hosts that answer `{ available: false }` (the dev harness,
+ * the vite preview).
+ */
+export function useCloudComputer(): UseCloudComputerResult {
+  const runtime = useNotisRuntime();
+  const [facts, setFacts] = useState<CloudComputerFacts | null>(null);
+  // True from the first committed render: the initial read is already queued
+  // in an effect, and `{ loading: false, facts: null }` would flash a
+  // consumer's fallback branch before the answer arrives.
+  const [loading, setLoading] = useState(true);
+  const [error, setError] = useState<Error | null>(null);
+  const mounted = useRef(true);
+
+  useEffect(() => {
+    mounted.current = true;
+    return () => {
+      mounted.current = false;
+    };
+  }, []);
+
+  const read = useCallback(async (options?: { refresh?: boolean }) => {
+    if (!runtime?.cloudComputerFacts) {
+      setFacts(UNAVAILABLE);
+      setLoading(false);
+      return;
+    }
+
+    setLoading(true);
+    setError(null);
+    try {
+      const next = await runtime.cloudComputerFacts(options);
+      if (mounted.current) setFacts(next);
+    } catch (err) {
+      const e = err instanceof Error ? err : new Error(String(err));
+      if (mounted.current) {
+        setError(e);
+        // A refused or failed read is the same product state as a host that
+        // cannot answer: the app shows its fallback instead of an error.
+        setFacts(UNAVAILABLE);
+      }
+    } finally {
+      if (mounted.current) setLoading(false);
+    }
+  }, [runtime]);
+
+  useEffect(() => {
+    void read();
+  }, [read]);
+
+  const refresh = useCallback(() => read({ refresh: true }), [read]);
+
+  return { facts, loading, error, refresh };
+}

package/template/packages/sdk/src/hooks/useDatabaseSubscription.ts

@@ -0,0 +1,76 @@
+'use client';
+
+import { useEffect, useRef, useState } from 'react';
+import { useNotisRuntime } from '../provider';
+import { useDocuments, type UseDocumentsOptions, type UseDocumentsResult } from './useDocuments';
+import type { DocumentRecord } from '../runtime';
+
+export interface UseDatabaseSubscriptionOptions extends UseDocumentsOptions {
+  /** Set to false to keep the query but skip the change feed. */
+  subscribe?: boolean;
+}
+
+export interface UseDatabaseSubscriptionResult extends UseDocumentsResult {
+  /** Alias of `documents`, for views that think in rows. */
+  rows: DocumentRecord[];
+  /** True while a live change feed is attached to this database. */
+  live: boolean;
+}
+
+/**
+ * Query a Notis database and keep it fresh without polling.
+ *
+ * ```tsx
+ * const { rows, live, refetch } = useDatabaseSubscription('workspaces');
+ * ```
+ *
+ * A change on the database wakes the hook, which then refetches through the
+ * usual `LOCAL_NOTIS_DATABASE_QUERY` path — the change feed is a signal only
+ * and never carries row data. Hosts without a change feed (the dev harness,
+ * the screenshot stub, the vite preview) still return rows; `live` is false
+ * there and the app should keep offering its manual refresh.
+ */
+export function useDatabaseSubscription(
+  databaseSlug: string,
+  options: UseDatabaseSubscriptionOptions = {},
+): UseDatabaseSubscriptionResult {
+  const runtime = useNotisRuntime();
+  const { subscribe = true, ...documentOptions } = options;
+  const { documents, loading, error, refetch } = useDocuments(databaseSlug, documentOptions);
+  const [live, setLive] = useState(false);
+
+  const refetchRef = useRef(refetch);
+  useEffect(() => {
+    refetchRef.current = refetch;
+  }, [refetch]);
+
+  const enabled = options.enabled !== false && subscribe;
+
+  useEffect(() => {
+    if (!runtime?.subscribeDatabase || !enabled || !databaseSlug) {
+      setLive(false);
+      return;
+    }
+
+    let cancelled = false;
+    const unsubscribe = runtime.subscribeDatabase(
+      databaseSlug,
+      () => {
+        refetchRef.current();
+      },
+      {
+        onStatusChange: (isLive) => {
+          if (!cancelled) setLive(isLive);
+        },
+      },
+    );
+
+    return () => {
+      cancelled = true;
+      setLive(false);
+      unsubscribe?.();
+    };
+  }, [runtime, databaseSlug, enabled]);
+
+  return { documents, rows: documents, loading, error, refetch, live };
+}

package/template/packages/sdk/src/hooks/useHandover.ts

@@ -0,0 +1,75 @@
+'use client';
+
+import { useCallback, useState } from 'react';
+import { useNotisRuntime } from '../provider';
+import type { HandoverPayload, HandoverResult } from '../runtime';
+
+export interface UseHandoverResult {
+  /** Hand the work over. Rejects when the host has no manager chat. */
+  handover: (payload: HandoverPayload) => Promise<HandoverResult>;
+  /** True while the manager chat is being prepared. */
+  pending: boolean;
+  error: Error | null;
+  /**
+   * False when the host cannot hand work over (dev harness, vite preview).
+   * Render the app's own fallback — a copyable prompt, say — when it is false.
+   */
+  available: boolean;
+}
+
+/**
+ * Hand a piece of work from app code to the Notis manager chat.
+ *
+ * An app displays work; the manager runs it. `handover` puts the message in
+ * the chat surface that already owns streaming progress, billing, cancellation
+ * and the transcript, and the app watches its own databases for the result.
+ *
+ * ```tsx
+ * const { handover, pending, available } = useHandover();
+ *
+ * return available ? (
+ *   <Button
+ *     disabled={pending}
+ *     onClick={() => { void handover({ prompt: 'Create a workspace on notis to ...' }); }}
+ *   >
+ *     Send to Notis
+ *   </Button>
+ * ) : (
+ *   <CopyablePrompt prompt="Create a workspace on notis to ..." />
+ * );
+ * ```
+ *
+ * Pass `skill` to bind the work to a skill declared in `notis.config.ts`; the
+ * host rejects a key the app does not declare. `autoSend` is accepted for
+ * forward compatibility; today's hosts always return `drafted` and let the
+ * user press send.
+ */
+export function useHandover(): UseHandoverResult {
+  const runtime = useNotisRuntime();
+  const [pending, setPending] = useState(false);
+  const [error, setError] = useState<Error | null>(null);
+
+  const handover = useCallback(
+    async (payload: HandoverPayload): Promise<HandoverResult> => {
+      if (!runtime?.handover) {
+        throw new Error('This Notis host cannot hand work to the manager chat.');
+      }
+
+      setPending(true);
+      setError(null);
+
+      try {
+        return await runtime.handover(payload);
+      } catch (err) {
+        const e = err instanceof Error ? err : new Error(String(err));
+        setError(e);
+        throw e;
+      } finally {
+        setPending(false);
+      }
+    },
+    [runtime],
+  );
+
+  return { handover, pending, error, available: Boolean(runtime?.handover) };
+}

package/template/packages/sdk/src/index.ts

@@ -13,6 +13,11 @@ export { NotisProvider, useNotisRuntime } from './provider';
 export { useNotis } from './hooks/useNotis';
 export { useDocuments } from './hooks/useDocuments';
 export type { UseDocumentsOptions, UseDocumentsResult } from './hooks/useDocuments';
+export { useDatabaseSubscription } from './hooks/useDatabaseSubscription';
+export type {
+  UseDatabaseSubscriptionOptions,
+  UseDatabaseSubscriptionResult,
+} from './hooks/useDatabaseSubscription';
 export { useDocument } from './hooks/useDocument';
 export type { UseDocumentOptions, UseDocumentResult } from './hooks/useDocument';
 export { useUpsertDocument } from './hooks/useUpsertDocument';
@@ -22,6 +27,10 @@ export type { UseDatabaseSchemaResult } from './hooks/useDatabaseSchema';
 export { useTool } from './hooks/useTool';
 export type { ToolCallState, UseToolResult } from './hooks/useTool';
 export { useTools } from './hooks/useTools';
+export { useHandover } from './hooks/useHandover';
+export type { UseHandoverResult } from './hooks/useHandover';
+export { useCloudComputer } from './hooks/useCloudComputer';
+export type { UseCloudComputerResult } from './hooks/useCloudComputer';
 export { useNotisNavigation } from './hooks/useNotisNavigation';
 export { useTopBarSearch } from './hooks/useTopBarSearch';
 export { useBackend } from './hooks/useBackend';
@@ -37,6 +46,7 @@ export {
   extractRichText,
   getDocumentPreview,
   getRelationIds,
+  getSecretValue,
   isPresentString,
   markdownToPlainText,
   normalizeDatabaseProperty,
@@ -64,6 +74,9 @@ export type { MultiSelectDragOverlayProps } from './components/MultiSelectDragOv
 // Types (re-exported for convenience)
 export type {
   AppDescriptor,
+  CloudComputerCliAuthFacts,
+  CloudComputerFacts,
+  CloudComputerSandboxFacts,
   CollectionItem,
   CollectionItemDetail,
   DatabaseDescriptor,
@@ -72,12 +85,16 @@ export type {
   DatabasePropertyType,
   DocumentContentType,
   DocumentRecord,
+  HandoverPayload,
+  HandoverResult,
   NotisDocumentEditorProps,
   NotisRuntime,
   NotisRuntimeContext,
   NotisRuntimeUI,
   QueryFilter,
   RouteDescriptor,
+  SecretPropertyValue,
+  SubscribeDatabaseOptions,
   ToolDescriptor,
   ToolInputSchema,
 } from './runtime';