@malloy-publisher/sdk 0.0.34 → 0.0.35

package/README.md

@@ -1,3 +1,24 @@
 # Malloy Publisher SDK
 
 The Malloy Publisher SDK is a comprehensive toolkit designed to facilitate the development and testing of Malloy packages.
+
+## Providers
+The SDK components rely on React Providers to supply context information.
+There are current 2 Providers, 1 for Packages, 1 for Project components.
+### Example Usage:
+**ProjectProvider**
+```react
+ <ProjectProvider server={server} projectName={projectName}>
+    <Project navigate={navigate} />
+</ProjectProvider>
+``` 
+**PackageProvider**
+```react
+<PackageProvider
+    server={server}
+    projectName={projectName}
+    packageName={packageName}
+    >
+    <Package navigate={navigate} />
+</PackageProvider>
+```

package/dist/{RenderedResult-9A74lwfO.cjs → RenderedResult-DphykkT6.cjs}

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./vendor-BH1c2Hhy.cjs"),m=require("./index-TNDWxBXR.cjs"),n=require("react");function v({result:r,height:c,isFillElement:i,onSizeChange:s,onDrill:f}){const e=n.useRef(null);n.useEffect(()=>{if(e.current){const t=l.createViz();for(;e.current.firstChild;)e.current.removeChild(e.current.firstChild);t.setResult(JSON.parse(r)),t.render(e.current)}},[r,e]),n.useEffect(()=>{if(!e.current)return;const t=e.current,u=()=>{if(t){const d=t.offsetHeight;d>0?s&&s(d):i&&t.firstChild&&(t.firstChild.offsetHeight==0?i(!0):i(!1))}},h=setTimeout(u,100),o=new MutationObserver(u);return o.observe(t,{childList:!0,subtree:!0,attributes:!0}),()=>{clearTimeout(h),o.disconnect()}},[s,r]);const l=new m.index_umdExports.MalloyRenderer({onClick:f});return a.jsxRuntimeExports.jsx("div",{ref:e,style:{width:"100%",height:c?`${c}px`:"100%"}})}exports.default=v;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=require("./vendor-BH1c2Hhy.cjs"),m=require("./index-nKbldp0y.cjs"),n=require("react");function v({result:r,height:c,isFillElement:i,onSizeChange:s,onDrill:f}){const e=n.useRef(null);n.useEffect(()=>{if(e.current){const t=l.createViz();for(;e.current.firstChild;)e.current.removeChild(e.current.firstChild);t.setResult(JSON.parse(r)),t.render(e.current)}},[r,e]),n.useEffect(()=>{if(!e.current)return;const t=e.current,u=()=>{if(t){const d=t.offsetHeight;d>0?s&&s(d):i&&t.firstChild&&(t.firstChild.offsetHeight==0?i(!0):i(!1))}},h=setTimeout(u,100),o=new MutationObserver(u);return o.observe(t,{childList:!0,subtree:!0,attributes:!0}),()=>{clearTimeout(h),o.disconnect()}},[s,r]);const l=new m.index_umdExports.MalloyRenderer({onClick:f});return a.jsxRuntimeExports.jsx("div",{ref:e,style:{width:"100%",height:c?`${c}px`:"100%"}})}exports.default=v;

package/dist/client/api.d.ts

@@ -315,6 +315,12 @@ export interface Model {
      * @memberof Model
      */
     'path'?: string;
+    /**
+     * Error message for this model object.
+     * @type {string}
+     * @memberof Model
+     */
+    'error'?: string;
 }
 /**
  *
@@ -359,6 +365,12 @@ export interface Notebook {
      * @memberof Notebook
      */
     'path'?: string;
+    /**
+     * Error message for this notebook object.
+     * @type {string}
+     * @memberof Notebook
+     */
+    'error'?: string;
 }
 /**
  * Notebook cell.
@@ -545,6 +557,12 @@ export interface QueryResult {
      * @memberof QueryResult
      */
     'result'?: string;
+    /**
+     * Resource path to the query result.
+     * @type {string}
+     * @memberof QueryResult
+     */
+    'resource'?: string;
 }
 /**
  * A scheduled task.

package/dist/components/ApiErrorDisplay.d.ts

@@ -0,0 +1,13 @@
+export interface ApiError extends Error {
+    status?: number;
+    data?: {
+        code: string;
+        message: string;
+    };
+}
+interface ApiErrorDisplayProps {
+    error: ApiError;
+    context?: string;
+}
+export declare function ApiErrorDisplay({ error, context }: ApiErrorDisplayProps): import("react/jsx-runtime").JSX.Element;
+export {};

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

@@ -1,18 +1,13 @@
 interface ModelCellProps {
-    server: string;
-    projectName: string;
-    packageName: string;
     modelPath: string;
-    versionId: string;
     sourceName?: string;
     queryName: string;
     expandResult?: boolean;
     hideResultIcon?: boolean;
     expandEmbedding?: boolean;
     hideEmbeddingIcon?: boolean;
-    accessToken?: string;
     noView?: boolean;
     annotations?: string[];
 }
-export declare function ModelCell({ server, projectName, packageName, modelPath, versionId, sourceName, queryName, expandResult, hideResultIcon, expandEmbedding, hideEmbeddingIcon, accessToken, noView, annotations, }: ModelCellProps): import("react/jsx-runtime").JSX.Element;
+export declare function ModelCell({ modelPath, sourceName, queryName, expandResult, hideResultIcon, expandEmbedding, hideEmbeddingIcon, noView, annotations, }: ModelCellProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,9 +1 @@
-interface PackageProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
-    accessToken?: string;
-}
-export default function Package({ server, projectName, packageName, versionId, accessToken, }: PackageProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function Config(): import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1 @@
-interface ConnectionsProps {
-    server?: string;
-    projectName: string;
-    accessToken: string;
-    navigate: (to: string, event?: React.MouseEvent) => void;
-}
-export default function Connections(connectionProps: ConnectionsProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function Connections(): import("react/jsx-runtime").JSX.Element;

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

@@ -1,9 +1 @@
-interface DatabaseProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
-    accessToken: string;
-}
-export default function DatabaseView({ server, projectName, packageName, versionId, accessToken, }: DatabaseProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function Databases(): import("react/jsx-runtime").JSX.Element;

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

@@ -1,10 +1,5 @@
 interface ModelsProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
     navigate: (to: string, event?: React.MouseEvent) => void;
-    accessToken?: string;
 }
-export default function Models({ server, projectName, packageName, versionId, navigate, accessToken, }: ModelsProps): import("react/jsx-runtime").JSX.Element;
+export default function Models({ navigate }: ModelsProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,10 +1,5 @@
-interface ModelsProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
+interface NotebooksProps {
     navigate: (to: string, event?: React.MouseEvent) => void;
-    accessToken?: string;
 }
-export default function Notebooks({ server, projectName, packageName, versionId, navigate, accessToken, }: ModelsProps): import("react/jsx-runtime").JSX.Element;
+export default function Notebooks({ navigate }: NotebooksProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,10 +1,5 @@
 interface PackageProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
     navigate?: (to: string, event?: React.MouseEvent) => void;
-    accessToken?: string;
 }
-export default function Package({ server, projectName, packageName, versionId, navigate, accessToken, }: PackageProps): import("react/jsx-runtime").JSX.Element;
+export default function Package({ navigate }: PackageProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -0,0 +1,14 @@
+import { ReactNode } from 'react';
+export interface PackageContextProps {
+    server?: string;
+    projectName: string;
+    packageName: string;
+    versionId?: string;
+    accessToken?: string;
+}
+interface PackageProviderProps extends PackageContextProps {
+    children: ReactNode;
+}
+export declare const PackageProvider: ({ server, projectName, packageName, versionId, accessToken, children, }: PackageProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare function usePackage(): PackageContextProps;
+export {};

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

@@ -1,9 +1 @@
-interface PackageProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
-    versionId?: string;
-    accessToken: string;
-}
-export default function Package({ server, projectName, packageName, versionId, accessToken, }: PackageProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function Schedules(): import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -1,7 +1 @@
-interface AboutProps {
-    server?: string;
-    projectName: string;
-    accessToken?: string;
-}
-export default function About({ server, projectName, accessToken, }: AboutProps): import("react/jsx-runtime").JSX.Element;
-export {};
+export default function About(): import("react/jsx-runtime").JSX.Element;

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

@@ -1,8 +1,5 @@
 interface ConnectionExplorerProps {
-    server?: string;
-    projectName: string;
     connectionName: string;
-    accessToken?: string;
 }
-export default function ConnectionExplorer({ server, projectName, connectionName, accessToken, }: ConnectionExplorerProps): import("react/jsx-runtime").JSX.Element;
+export default function ConnectionExplorer({ connectionName, }: ConnectionExplorerProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,8 +1,5 @@
-interface ProjectProps {
-    server?: string;
-    projectName: string;
+interface PackagesProps {
     navigate: (to: string, event?: React.MouseEvent) => void;
-    accessToken?: string;
 }
-export default function Project({ server, projectName, navigate, accessToken, }: ProjectProps): import("react/jsx-runtime").JSX.Element;
+export default function Packages({ navigate }: PackagesProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

@@ -1,8 +1,16 @@
-interface ProjectProps {
+import { ReactNode } from 'react';
+export interface ProjectContextProps {
     server?: string;
     projectName: string;
-    navigate: (to: string, event?: React.MouseEvent) => void;
     accessToken?: string;
 }
-export default function Project({ server, projectName, navigate, accessToken, }: ProjectProps): import("react/jsx-runtime").JSX.Element;
+interface ProjectProviderProps extends ProjectContextProps {
+    children: ReactNode;
+}
+export declare const ProjectProvider: ({ server, projectName, accessToken, children, }: ProjectProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare function useProject(): ProjectContextProps;
+interface ProjectProps {
+    navigate: (to: string, event?: React.MouseEvent) => void;
+}
+export default function Project({ navigate }: ProjectProps): import("react/jsx-runtime").JSX.Element;
 export {};

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

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

package/dist/components/QueryResult/QueryResult.d.ts

@@ -1,13 +1,8 @@
 interface QueryResultProps {
-    server?: string;
-    projectName: string;
-    packageName: string;
     modelPath: string;
-    versionId?: string;
     query?: string;
     sourceName?: string;
     queryName?: string;
-    accessToken?: string;
 }
-export default function QueryResult({ server, projectName, packageName, modelPath, versionId, query, sourceName, queryName, accessToken, }: QueryResultProps): import("react/jsx-runtime").JSX.Element;
+export default function QueryResult({ modelPath, query, sourceName, queryName, }: QueryResultProps): import("react/jsx-runtime").JSX.Element;
 export {};