@malloy-publisher/sdk 0.0.80 → 0.0.82

package/dist/components/Model/Model.d.ts

@@ -1,3 +1,4 @@
+import { QueryExplorerResult } from './SourcesExplorer';
 interface ModelProps {
     modelPath: string;
     versionId?: string;
@@ -5,6 +6,7 @@ interface ModelProps {
     hideResultIcons?: boolean;
     expandEmbeddings?: boolean;
     hideEmbeddingIcons?: boolean;
+    onChange?: (query: QueryExplorerResult) => void;
 }
-export default function Model({ modelPath, expandResults, hideResultIcons, expandEmbeddings, hideEmbeddingIcons, }: ModelProps): import("react/jsx-runtime").JSX.Element;
+export default function Model({ modelPath, versionId, expandResults, hideResultIcons, expandEmbeddings, hideEmbeddingIcons, onChange, }: ModelProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/components/Model/ModelExplorer.d.ts

@@ -0,0 +1,19 @@
+import { QueryExplorerResult } from './SourcesExplorer';
+export interface ModelExplorerProps {
+    modelPath: string;
+    versionId?: string;
+    /** Display options forwarded to ModelCell */
+    expandResults?: boolean;
+    hideResultIcons?: boolean;
+    expandEmbeddings?: boolean;
+    hideEmbeddingIcons?: boolean;
+    /** Callback when the explorer changes (e.g. when a query is selected). */
+    onChange?: (query: QueryExplorerResult) => void;
+}
+/**
+ * ModelExplorer renders the main explorer UI for a Malloy model. It shows the
+ * selected source (via `SourceExplorerComponent`) along with the list of named
+ * queries for that model. This logic was originally embedded inside `Model.tsx`
+ * but has been extracted for easier reuse.
+ */
+export declare function ModelExplorer({ modelPath, versionId, expandResults, hideResultIcons, expandEmbeddings, hideEmbeddingIcons, onChange, }: ModelExplorerProps): import("react/jsx-runtime").JSX.Element;

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

@@ -1,4 +1,7 @@
 export { default as Model } from './Model';
+export { ModelExplorer } from './ModelExplorer';
 export { SourcesExplorer } from './SourcesExplorer';
 export { SourceExplorerComponent } from './SourcesExplorer';
 export type { SourceAndPath } from './SourcesExplorer';
+export { useModelData } from './useModelData';
+export type { ModelExplorerProps } from './ModelExplorer';

package/dist/components/Model/useModelData.d.ts

@@ -0,0 +1,8 @@
+import { CompiledModel } from '../../client';
+import { UseQueryResult } from '@tanstack/react-query';
+import { ApiError } from '../ApiErrorDisplay';
+/**
+ * Custom hook for fetching model data. Combines usePackage context with
+ * useQueryWithApiError to fetch a compiled model.
+ */
+export declare function useModelData(modelPath: string, versionId?: string): UseQueryResult<CompiledModel, ApiError>;

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

@@ -1,3 +1,4 @@
 export { default as Package } from './Package';
 export * from './PackageProvider';
 export { PackageProvider as PublisherPackageProvider, usePackage as usePublisherPackage, } from './PackageProvider';
+export { default as Models } from './Models';

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

@@ -1 +1,2 @@
 export { default as Project, ProjectProvider, useProject } from './Project';
+export { default as Packages } from './Packages';

package/dist/components/Workbook/BrowserWorkbookStorage.d.ts

@@ -0,0 +1,11 @@
+import { PackageContextProps } from '../Package';
+import { WorkbookLocator, WorkbookStorage, Workspace } from './WorkbookStorage';
+export declare class BrowserWorkbookStorage implements WorkbookStorage {
+    private makeKey;
+    listWorkspaces(context: PackageContextProps, writeableOnly: boolean): Promise<Workspace[]>;
+    listWorkbooks(workspace: Workspace, context: PackageContextProps): Promise<WorkbookLocator[]>;
+    getWorkbook(context: PackageContextProps, path: WorkbookLocator): Promise<string>;
+    deleteWorkbook(context: PackageContextProps, path: WorkbookLocator): Promise<void>;
+    saveWorkbook(context: PackageContextProps, path: WorkbookLocator, notebook: string): Promise<void>;
+    moveWorkbook(context: PackageContextProps, from: WorkbookLocator, to: WorkbookLocator): Promise<void>;
+}

package/dist/components/{MutableNotebook → Workbook}/EditableMalloyCell.d.ts

@@ -1,8 +1,8 @@
 import { SourceAndPath } from '../Model';
 import { QueryExplorerResult } from '../Model/SourcesExplorer';
-import { NotebookCellValue } from '../NotebookManager';
+import { WorkbookCellValue } from './WorkbookManager';
 interface EditableMalloyCellProps {
-    cell: NotebookCellValue;
+    cell: WorkbookCellValue;
     sourceAndPaths: SourceAndPath[];
     onQueryChange: (query: QueryExplorerResult) => void;
     onSourceChange?: (index: number) => void;

package/dist/components/{MutableNotebook → Workbook}/MutableCell.d.ts

@@ -1,15 +1,15 @@
 import { default as React } from 'react';
 import { SourceAndPath } from '../Model/SourcesExplorer';
-import { NotebookCellValue } from '../NotebookManager';
+import { WorkbookCellValue } from './WorkbookManager';
 interface NotebookCellProps {
-    cell: NotebookCellValue;
+    cell: WorkbookCellValue;
     expandCodeCell?: boolean;
     expandEmbedding?: boolean;
     hideEmbeddingIcons?: boolean;
     editingMalloy?: boolean;
     editingMarkdown?: boolean;
     sourceAndPaths: SourceAndPath[];
-    onCellChange: (cell: NotebookCellValue) => void;
+    onCellChange: (cell: WorkbookCellValue) => void;
     onClose: () => void;
     onEdit: () => void;
     onDelete: () => void;

package/dist/components/Workbook/Workbook.d.ts

@@ -0,0 +1,9 @@
+import { WorkbookLocator } from './WorkbookStorage';
+interface WorkbookProps {
+    workbookPath?: WorkbookLocator;
+    expandCodeCells?: boolean;
+    expandEmbeddings?: boolean;
+    hideEmbeddingIcons?: boolean;
+}
+export default function Workbook({ workbookPath, expandCodeCells, expandEmbeddings, hideEmbeddingIcons, }: WorkbookProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/Workbook/WorkbookList.d.ts

@@ -0,0 +1,7 @@
+import { default as React } from 'react';
+import { WorkbookLocator } from './WorkbookStorage';
+interface WorkbookListProps {
+    onWorkbookClick: (workbook: WorkbookLocator, event: React.MouseEvent) => void;
+}
+export declare function WorkbookList({ onWorkbookClick }: WorkbookListProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/components/Workbook/WorkbookManager.d.ts

@@ -0,0 +1,87 @@
+import { PackageContextProps } from '../Package';
+import { WorkbookLocator, WorkbookStorage } from './WorkbookStorage';
+/**
+ * Interface representing the data structure of a Mutable Workbook
+ * @interface WorkbookData
+ * @property {string[]} models - Array of model paths used in the workbook
+ * @property {WorkbookCellValue[]} cells - Array of cells in the workbook
+ * @property {WorkbookLocator} workbookPath - Path to the workbook file (relative to project/package)
+ */
+export interface WorkbookData {
+    models: string[];
+    cells: WorkbookCellValue[];
+    workbookPath: WorkbookLocator;
+}
+/**
+ * Interface representing a cell in the workbook
+ * @interface WorkbookCellValue
+ * @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 WorkbookCellValue {
+    isMarkdown: boolean;
+    value?: string;
+    result?: string;
+    modelPath?: string;
+    sourceName?: string;
+    queryInfo?: string;
+}
+/**
+ * Class for managing workbook operations
+ * @class WorkbookManager
+ */
+export declare class WorkbookManager {
+    private workbookData;
+    private isSaved;
+    private workbookStorage;
+    private packageContext;
+    /**
+     * Creates a new WorkbookManager instance
+     * @param {WorkbookStorage} workbookStorage - Storage implementation
+     * @param {PackageContextProps} packageContext - Package context for storage
+     * @param {WorkbookData} workbookData - Initial workbook data
+     */
+    constructor(workbookStorage: WorkbookStorage, packageContext: PackageContextProps, workbookData: WorkbookData);
+    /**
+     * Gets the current workbook data
+     * @returns {WorkbookData} The current workbook data
+     */
+    getWorkbookData(): WorkbookData;
+    /**
+     * Gets the current workbook path
+     * @returns {string} The path to the workbook
+     */
+    getWorkbookPath(): WorkbookLocator;
+    /**
+     * Renames the workbook and updates storage
+     * @param {string} workbookPath - New path for the workbook
+     * @returns {WorkbookManager} The updated WorkbookManager instance
+     */
+    renameWorkbook(workbookPath: string): Promise<WorkbookManager>;
+    getCells(): WorkbookCellValue[];
+    deleteCell(index: number): WorkbookManager;
+    insertCell(index: number, cell: WorkbookCellValue): WorkbookManager;
+    setCell(index: number, cell: WorkbookCellValue): WorkbookManager;
+    setModels(models: string[]): WorkbookManager;
+    getModels(): string[];
+    updateWorkbookData(workbookData: WorkbookData): WorkbookManager;
+    saveWorkbook(): Promise<WorkbookManager>;
+    /**
+     * Converts the workbook data to a Malloy workbook string.
+     * @returns {string} The Malloy workbook string
+     */
+    toMalloyWorkbook(): string;
+    static newWorkbook(workbookStorage: WorkbookStorage, packageContext: PackageContextProps): WorkbookManager;
+    /**
+     * Creates a new workbook manager by loading from local storage.
+     * Returns an empty instance if the workbook is not found.
+     * @param workbookStorage - The storage implementation
+     * @param userContext - The user context for storage
+     * @param workbookPath - The path to the workbook file (relative to project/package)
+     */
+    static loadWorkbook(workbookStorage: WorkbookStorage, packageContext: PackageContextProps, workbookPath: WorkbookLocator): Promise<WorkbookManager>;
+}

package/dist/components/Workbook/WorkbookStorage.d.ts

@@ -0,0 +1,18 @@
+import { PackageContextProps } from '../Package';
+export interface Workspace {
+    name: string;
+    writeable: boolean;
+    description: string;
+}
+export interface WorkbookLocator {
+    path: string;
+    workspace: string;
+}
+export interface WorkbookStorage {
+    listWorkspaces(context: PackageContextProps, writeableOnly: boolean): Promise<Workspace[]>;
+    listWorkbooks(workspace: Workspace, context: PackageContextProps): Promise<WorkbookLocator[]>;
+    getWorkbook(context: PackageContextProps, path: WorkbookLocator): Promise<string>;
+    deleteWorkbook(context: PackageContextProps, path: WorkbookLocator): Promise<void>;
+    saveWorkbook(context: PackageContextProps, path: WorkbookLocator, workbook: string): Promise<void>;
+    moveWorkbook(context: PackageContextProps, from: WorkbookLocator, to: WorkbookLocator): Promise<void>;
+}

package/dist/components/Workbook/WorkbookStorageProvider.d.ts

@@ -0,0 +1,12 @@
+import { default as React } from 'react';
+import { WorkbookStorage } from './WorkbookStorage';
+export interface WorkbookStorageProviderProps {
+    children: React.ReactNode;
+    workbookStorage: WorkbookStorage;
+}
+interface WorkbookStorageContextValue {
+    workbookStorage: WorkbookStorage;
+}
+export declare function WorkbookStorageProvider({ children, workbookStorage, }: WorkbookStorageProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useWorkbookStorage(): WorkbookStorageContextValue;
+export {};

package/dist/components/Workbook/index.d.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/dist/components/index.d.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';