@smarter.sh/ui-chat 0.7.0 → 0.8.0

package/dist/types/src/components/DocsDialog/Component.d.ts

@@ -0,0 +1,8 @@
+import { type DocSection } from "@/components/DocsDialog/data";
+import "@/components/DocsDialog/styles.css";
+interface DocsDialogProps {
+    onClose: () => void;
+    sections?: DocSection[];
+}
+declare function DocsDialog({ onClose, sections }: DocsDialogProps): import("react").JSX.Element;
+export default DocsDialog;

package/dist/types/src/components/DocsDialog/data.d.ts

@@ -0,0 +1,18 @@
+/** A technical reference that the Docs dialog links to. */
+export interface DocLink {
+    title: string;
+    url: string;
+    description: string;
+}
+/** A tab of the Docs dialog: the technical references for one audience. */
+export interface DocSection {
+    title: string;
+    description: string;
+    links: DocLink[];
+}
+/** The technical references for prompt engineers, who build LLMClients in the sandbox. */
+export declare const PROMPT_ENGINEER_LINKS: DocLink[];
+/** The technical references for software engineers, who build the applications that host them. */
+export declare const SOFTWARE_ENGINEER_LINKS: DocLink[];
+/** The tabs of the Docs dialog, from left to right. The first one is selected when it opens. */
+export declare const DOC_SECTIONS: DocSection[];

package/dist/types/src/components/DocsDialog/index.d.ts

@@ -0,0 +1,2 @@
+import DocsDialog from "@/components/DocsDialog/Component";
+export default DocsDialog;

package/dist/types/src/components/SmarterChat/Component.d.ts

@@ -12,9 +12,13 @@
  * The user can resize the chat and the Console by dragging the separator between them, and can
  * hide the Console, which slides out to the right. In sandbox mode, the thread also displays
  * Smarter's system, tool and meta data messages. In production mode, it displays only the
- * conversation, as the LLMClient's users see it. The Console's server logs follow the mode: DEBUG
+ * conversation, as the LLMClient's users see it, and the Console and its toggle button are hidden. The Console's server logs follow the mode: DEBUG
  * and above in sandbox mode, and the server's own log level in production mode. A new chat also
- * clears the Console's server logs.
+ * clears the Console's server logs. Sandbox mode also has a Docs button, which opens a dialog of
+ * links to the technical references for prompt engineers and software engineers.
+ *
+ * The LLMClient's styles (its manifest's spec.config.styles) set its logo, which is displayed in
+ * the header, its avatars, its background image, its fonts and its colors. See lib/styles.ts.
  *
  * This is the component that the @smarter.sh/ui-chat npm package exports, and that the Smarter web
  * console's LLMClient prompt workbench renders. See main.tsx.

package/dist/types/src/components/SmarterChat/icons.d.ts

@@ -15,3 +15,5 @@ export declare function ConsoleIcon({ visible }: {
 export declare function SandboxIcon(): import("react").JSX.Element;
 /** A shield: production mode, which displays the conversation only, as its users see it. (bi-shield-check) */
 export declare function ProductionIcon(): import("react").JSX.Element;
+/** An open book: the Docs dialog, which links to the technical references. (bi-book) */
+export declare function DocsIcon(): import("react").JSX.Element;