@malloy-publisher/sdk 0.0.80 → 0.0.81

package/src/components/Workbook/WorkbookStorage.ts

@@ -0,0 +1,54 @@
+import { PackageContextProps } from "../Package";
+
+export interface Workspace {
+   name: string;
+   writeable: boolean;
+   description: string;
+}
+
+export interface WorkbookLocator {
+   path: string;
+   workspace: string;
+}
+
+export interface WorkbookStorage {
+   // Lists all available workspaces for the context.
+   listWorkspaces(
+      context: PackageContextProps,
+      writeableOnly: boolean,
+   ): Promise<Workspace[]>;
+
+   // Lists all available workbooks for the context.
+   // Workbooks names are like S3 paths- / denote hierarchical
+   // folders, but otherwise folders are not "real" objects
+   listWorkbooks(
+      workspace: Workspace,
+      context: PackageContextProps,
+   ): Promise<WorkbookLocator[]>;
+
+   // Returns the workbook at the specific path, throws an exception if no such workbook exists (or cannot be accessed)
+   getWorkbook(
+      context: PackageContextProps,
+      path: WorkbookLocator,
+   ): Promise<string>;
+
+   // Deletes the workbook at the specified path, or throws an
+   // Exception on failure
+   deleteWorkbook(
+      context: PackageContextProps,
+      path: WorkbookLocator,
+   ): Promise<void>;
+
+   saveWorkbook(
+      context: PackageContextProps,
+      path: WorkbookLocator,
+      workbook: string,
+   ): Promise<void>;
+
+   // Moves workbook from the "from" path to the "to" path
+   moveWorkbook(
+      context: PackageContextProps,
+      from: WorkbookLocator,
+      to: WorkbookLocator,
+   ): Promise<void>;
+}

package/src/components/Workbook/WorkbookStorageProvider.tsx

@@ -0,0 +1,37 @@
+import React, { createContext, useContext, useMemo } from "react";
+import type { WorkbookStorage } from "./WorkbookStorage";
+
+export interface WorkbookStorageProviderProps {
+   children: React.ReactNode;
+   workbookStorage: WorkbookStorage;
+}
+
+interface WorkbookStorageContextValue {
+   workbookStorage: WorkbookStorage;
+}
+
+const WorkbookStorageContext = createContext<
+   WorkbookStorageContextValue | undefined
+>(undefined);
+
+export function WorkbookStorageProvider({
+   children,
+   workbookStorage,
+}: WorkbookStorageProviderProps) {
+   const value = useMemo(() => ({ workbookStorage }), [workbookStorage]);
+   return (
+      <WorkbookStorageContext.Provider value={value}>
+         {children}
+      </WorkbookStorageContext.Provider>
+   );
+}
+
+export function useWorkbookStorage() {
+   const context = useContext(WorkbookStorageContext);
+   if (!context) {
+      throw new Error(
+         "useWorkbookStorage must be used within a WorkbookStorageProvider",
+      );
+   }
+   return context;
+}

package/src/components/Workbook/index.ts

@@ -0,0 +1,7 @@
+export type { WorkbookStorage } from "./WorkbookStorage";
+export { default as Workbook } from "./Workbook";
+export { WorkbookList } from "./WorkbookList";
+export { WorkbookStorageProvider } from "./WorkbookStorageProvider";
+export type { WorkbookLocator, Workspace } from "./WorkbookStorage";
+export { BrowserWorkbookStorage } from "./BrowserWorkbookStorage";
+export { WorkbookManager } from "./WorkbookManager";

package/src/components/index.ts

@@ -1,6 +1,6 @@
 export * from "./Model";
 export * from "./Notebook";
-export * from "./MutableNotebook";
+export * from "./Workbook";
 export * from "./Package";
 export * from "./Project";
 export * from "./QueryResult";
@@ -10,3 +10,5 @@ export { useRouterClickHandler } from "./click_helper";
 export { ServerProvider, useServer } from "./ServerProvider";
 export type { ServerContextValue, ServerProviderProps } from "./ServerProvider";
 export { AnalyzePackageButton } from "./AnalyzePackageButton";
+export type { PackageContextProps } from "./Package";
+export type { WorkbookStorage } from "./Workbook";

package/dist/components/MutableNotebook/BrowserNotebookStorage.d.ts

@@ -1,9 +0,0 @@
-import { NotebookStorage, UserContext } from './NotebookStorage';
-export declare class BrowserNotebookStorage implements NotebookStorage {
-    private makeKey;
-    listNotebooks(context: UserContext): string[];
-    getNotebook(context: UserContext, path: string): string;
-    deleteNotebook(context: UserContext, path: string): void;
-    saveNotebook(context: UserContext, path: string, notebook: string): void;
-    moveNotebook(context: UserContext, from: string, to: string): void;
-}

package/dist/components/MutableNotebook/MutableNotebook.d.ts

@@ -1,8 +0,0 @@
-interface MutableNotebookProps {
-    notebookPath?: string;
-    expandCodeCells?: boolean;
-    expandEmbeddings?: boolean;
-    hideEmbeddingIcons?: boolean;
-}
-export default function MutableNotebook({ notebookPath, expandCodeCells, expandEmbeddings, hideEmbeddingIcons, }: MutableNotebookProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/MutableNotebook/MutableNotebookList.d.ts

@@ -1,6 +0,0 @@
-import { default as React } from 'react';
-interface MutableNotebookListProps {
-    onNotebookClick: (notebook: string, event: React.MouseEvent) => void;
-}
-export declare function MutableNotebookList({ onNotebookClick, }: MutableNotebookListProps): import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/components/MutableNotebook/NotebookStorage.d.ts

@@ -1,11 +0,0 @@
-export interface UserContext {
-    project: string;
-    package: string;
-}
-export interface NotebookStorage {
-    listNotebooks(context: UserContext): string[];
-    getNotebook(context: UserContext, path: string): string;
-    deleteNotebook(context: UserContext, path: string): void;
-    saveNotebook(context: UserContext, path: string, notebook: string): void;
-    moveNotebook(context: UserContext, from: string, to: string): void;
-}

package/dist/components/MutableNotebook/NotebookStorageProvider.d.ts

@@ -1,14 +0,0 @@
-import { default as React } from 'react';
-import { NotebookStorage, UserContext } from './NotebookStorage';
-interface NotebookStorageProviderProps {
-    children: React.ReactNode;
-    userContext: UserContext;
-    notebookStorage: NotebookStorage;
-}
-interface NotebookStorageContextValue {
-    notebookStorage: NotebookStorage;
-    userContext: UserContext;
-}
-export default function NotebookStorageProvider({ children, userContext, notebookStorage, }: NotebookStorageProviderProps): import("react/jsx-runtime").JSX.Element;
-export declare function useNotebookStorage(): NotebookStorageContextValue;
-export {};

package/dist/components/MutableNotebook/index.d.ts

@@ -1,5 +0,0 @@
-export { BrowserNotebookStorage } from './BrowserNotebookStorage';
-export { default as MutableNotebook } from './MutableNotebook';
-export type { NotebookStorage, UserContext } from './NotebookStorage';
-export { MutableNotebookList } from './MutableNotebookList';
-export { default as NotebookStorageProvider, useNotebookStorage, } from './NotebookStorageProvider';

package/dist/components/NotebookManager.d.ts

@@ -1,86 +0,0 @@
-import { NotebookStorage, UserContext } from './MutableNotebook/NotebookStorage';
-/**
- * Interface representing the data structure of a Mutable Notebook
- * @interface NotebookData
- * @property {string[]} models - Array of model paths used in the notebook
- * @property {NotebookCellValue[]} cells - Array of cells in the notebook
- * @property {string} notebookPath - Path to the notebook file (relative to project/package)
- */
-export interface NotebookData {
-    models: string[];
-    cells: NotebookCellValue[];
-    notebookPath: string;
-}
-/**
- * Interface representing a cell in the notebook
- * @interface NotebookCellValue
- * @property {boolean} isMarkdown - Whether the cell is a markdown cell
- * @property {string} [value] - The content of the cell
- * @property {string} [result] - The result of executing the cell
- * @property {string} [modelPath] - modelPath associated with the query in the cell
- * @property {string} [sourceName] - Name of the source associated with the cell
- * @property {string} [queryInfo] - Information about the query in the cell
- */
-export interface NotebookCellValue {
-    isMarkdown: boolean;
-    value?: string;
-    result?: string;
-    modelPath?: string;
-    sourceName?: string;
-    queryInfo?: string;
-}
-/**
- * Class for managing notebook operations
- * @class NotebookManager
- */
-export declare class NotebookManager {
-    private notebookData;
-    private isSaved;
-    private notebookStorage;
-    private userContext;
-    /**
-     * Creates a new NotebookManager instance
-     * @param {NotebookStorage} notebookStorage - Storage implementation
-     * @param {UserContext} userContext - User context for storage
-     * @param {NotebookData} notebookData - Initial notebook data
-     */
-    constructor(notebookStorage: NotebookStorage, userContext: UserContext, notebookData: NotebookData);
-    /**
-     * Gets the current notebook data
-     * @returns {NotebookData} The current notebook data
-     */
-    getNotebookData(): NotebookData;
-    /**
-     * Gets the current notebook path
-     * @returns {string} The path to the notebook
-     */
-    getNotebookPath(): string;
-    /**
-     * Renames the notebook and updates storage
-     * @param {string} notebookPath - New path for the notebook
-     * @returns {NotebookManager} The updated NotebookManager instance
-     */
-    renameNotebook(notebookPath: string): NotebookManager;
-    getCells(): NotebookCellValue[];
-    deleteCell(index: number): NotebookManager;
-    insertCell(index: number, cell: NotebookCellValue): NotebookManager;
-    setCell(index: number, cell: NotebookCellValue): NotebookManager;
-    setModels(models: string[]): NotebookManager;
-    getModels(): string[];
-    updateNotebookData(notebookData: NotebookData): NotebookManager;
-    saveNotebook(): NotebookManager;
-    /**
-     * Converts the notebook data to a Malloy notebook string.
-     * @returns {string} The Malloy notebook string
-     */
-    toMalloyNotebook(): string;
-    static newNotebook(notebookStorage: NotebookStorage, userContext: UserContext): NotebookManager;
-    /**
-     * Creates a new notebook manager by loading from local storage.
-     * Returns an empty instance if the notebook is not found.
-     * @param notebookStorage - The storage implementation
-     * @param userContext - The user context for storage
-     * @param notebookPath - The path to the notebook file (relative to project/package)
-     */
-    static loadNotebook(notebookStorage: NotebookStorage, userContext: UserContext, notebookPath: string): NotebookManager;
-}

package/src/components/MutableNotebook/BrowserNotebookStorage.ts

@@ -1,58 +0,0 @@
-import type { NotebookStorage, UserContext } from "./NotebookStorage";
-
-export class BrowserNotebookStorage implements NotebookStorage {
-   private makeKey(context: UserContext, path?: string): string {
-      let key = `BROWSER_NOTEBOOK_STORAGE__${context.project}/${context.package}`;
-      if (path) {
-         key += `/${path}`;
-      }
-      return key;
-   }
-
-   listNotebooks(context: UserContext): string[] {
-      const prefix = this.makeKey(context);
-      const keys: string[] = [];
-      for (let i = 0; i < localStorage.length; i++) {
-         const key = localStorage.key(i);
-         if (key && key.startsWith(prefix + "/")) {
-            // Extract the notebook path after the prefix
-            const notebookPath = key.substring(prefix.length + 1);
-            keys.push(notebookPath);
-         }
-      }
-      return keys;
-   }
-
-   getNotebook(context: UserContext, path: string): string {
-      const key = this.makeKey(context, path);
-      const notebook = localStorage.getItem(key);
-      if (notebook === null) {
-         throw new Error(`Notebook not found at path: ${path}`);
-      }
-      return notebook;
-   }
-
-   deleteNotebook(context: UserContext, path: string): void {
-      const key = this.makeKey(context, path);
-      if (localStorage.getItem(key) === null) {
-         throw new Error(`Notebook not found at path: ${path}`);
-      }
-      localStorage.removeItem(key);
-   }
-
-   saveNotebook(context: UserContext, path: string, notebook: string): void {
-      const key = this.makeKey(context, path);
-      localStorage.setItem(key, notebook);
-   }
-
-   moveNotebook(context: UserContext, from: string, to: string): void {
-      const fromKey = this.makeKey(context, from);
-      const toKey = this.makeKey(context, to);
-      const notebook = localStorage.getItem(fromKey);
-      if (notebook === null) {
-         throw new Error(`Notebook not found at path: ${from}`);
-      }
-      localStorage.setItem(toKey, notebook);
-      localStorage.removeItem(fromKey);
-   }
-}

package/src/components/MutableNotebook/MutableNotebookList.tsx

@@ -1,69 +0,0 @@
-import { Box, Divider, List, ListItem, ListItemText } from "@mui/material";
-import React from "react";
-import { useNotebookStorage } from "./NotebookStorageProvider";
-
-interface MutableNotebookListProps {
-   onNotebookClick: (notebook: string, event: React.MouseEvent) => void;
-}
-
-export function MutableNotebookList({
-   onNotebookClick,
-}: MutableNotebookListProps) {
-   const { notebookStorage, userContext } = useNotebookStorage();
-   const [notebooks, setNotebooks] = React.useState<string[]>([]);
-
-   React.useEffect(() => {
-      if (notebookStorage && userContext) {
-         setNotebooks(notebookStorage.listNotebooks(userContext));
-      }
-   }, [notebookStorage, userContext]);
-
-   return (
-      <>
-         <Divider />
-         <Box
-            sx={{
-               maxHeight: "300px",
-               overflow: "auto",
-               "&::-webkit-scrollbar": {
-                  width: "8px",
-               },
-               "&::-webkit-scrollbar-track": {
-                  background: "transparent",
-               },
-               "&::-webkit-scrollbar-thumb": {
-                  background: "rgba(0,0,0,0.2)",
-                  borderRadius: "4px",
-               },
-            }}
-         >
-            <List dense>
-               {notebooks.length === 0 && (
-                  <ListItem>
-                     <ListItemText
-                        primary="No notebooks found."
-                        sx={{ textAlign: "center" }}
-                     />
-                  </ListItem>
-               )}
-               {notebooks.map((notebook) => (
-                  <ListItem
-                     key={notebook}
-                     onClick={(event: React.MouseEvent) =>
-                        onNotebookClick(notebook, event)
-                     }
-                     sx={{
-                        cursor: "pointer",
-                        "&:hover": {
-                           backgroundColor: "action.hover",
-                        },
-                     }}
-                  >
-                     <ListItemText primary={notebook} />
-                  </ListItem>
-               ))}
-            </List>
-         </Box>
-      </>
-   );
-}

package/src/components/MutableNotebook/NotebookStorage.ts

@@ -1,27 +0,0 @@
-export interface UserContext {
-   // UserContext holds the project & package associated with
-   // the notebook. PublisherStorage interfaces will
-   // implement this and add data representing configuration,
-   // user permissions, and access tokens.
-   project: string;
-   package: string;
-}
-
-export interface NotebookStorage {
-   // Lists all available notebooks for the context.
-   // Notebooks names are like S3 paths- / denote hierarchical
-   // folders, but otherwise folders are not "real" objects
-   listNotebooks(context: UserContext): string[];
-
-   // Returns the notebook at the specific path, throws an exception if no such notebook exists (or cannot be accessed)
-   getNotebook(context: UserContext, path: string): string;
-
-   // Deletes the notebook at the specified path, or throws an
-   // Exception on failure
-   deleteNotebook(context: UserContext, path: string): void;
-
-   saveNotebook(context: UserContext, path: string, notebook: string): void;
-
-   // Moves notebook from the "from" path to the "to" path
-   moveNotebook(context: UserContext, from: string, to: string): void;
-}

package/src/components/MutableNotebook/NotebookStorageProvider.tsx

@@ -1,43 +0,0 @@
-import React, { createContext, useContext, useMemo } from "react";
-import type { NotebookStorage, UserContext } from "./NotebookStorage";
-
-interface NotebookStorageProviderProps {
-   children: React.ReactNode;
-   userContext: UserContext;
-   notebookStorage: NotebookStorage;
-}
-
-interface NotebookStorageContextValue {
-   notebookStorage: NotebookStorage;
-   userContext: UserContext;
-}
-
-const NotebookStorageContext = createContext<
-   NotebookStorageContextValue | undefined
->(undefined);
-
-export default function NotebookStorageProvider({
-   children,
-   userContext,
-   notebookStorage,
-}: NotebookStorageProviderProps) {
-   const value = useMemo(
-      () => ({ notebookStorage, userContext }),
-      [notebookStorage, userContext],
-   );
-   return (
-      <NotebookStorageContext.Provider value={value}>
-         {children}
-      </NotebookStorageContext.Provider>
-   );
-}
-
-export function useNotebookStorage() {
-   const context = useContext(NotebookStorageContext);
-   if (!context) {
-      throw new Error(
-         "useNotebookStorage must be used within a NotebookStorageProvider",
-      );
-   }
-   return context;
-}

package/src/components/MutableNotebook/index.ts

@@ -1,8 +0,0 @@
-export { BrowserNotebookStorage } from "./BrowserNotebookStorage";
-export { default as MutableNotebook } from "./MutableNotebook";
-export type { NotebookStorage, UserContext } from "./NotebookStorage";
-export { MutableNotebookList } from "./MutableNotebookList";
-export {
-   default as NotebookStorageProvider,
-   useNotebookStorage,
-} from "./NotebookStorageProvider";