@sigmacomputing/react-embed-sdk 0.2.0 → 0.2.1

package/dist/index.d.mts

@@ -1,6 +1,52 @@
 import { WorkbookLoadedEvent, WorkbookErrorEvent } from '@sigmacomputing/embed-sdk';
+export * from '@sigmacomputing/embed-sdk';
 
-declare function useWorkbookLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onLoaded: (event: WorkbookLoadedEvent) => void): void;
-declare function useWorkbookError(iframeRef: React.RefObject<HTMLIFrameElement>, onError: (event: WorkbookErrorEvent) => void): void;
+type OnLoaded = (event: WorkbookLoadedEvent) => void;
+type OnError = (event: WorkbookErrorEvent) => void;
+/**
+ * Listen for a workbook loaded event, and execute the given callback when it occurs.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const [loading, setLoading] = useState(true);
+ *   const loadingCallback = useCallback(() => setLoading(false), []);
+ *   const iframeRef = useRef<HTMLIFrameElement>(null);
+ *   useWorkbookLoaded(iframeRef, loadingCallback);
+ *   return (
+ *    <iframe
+ *      className{loading ? "hidden" : "show"}
+ *      ref={iframeRef}
+ *      src="https://sigmacomputing.app/embed"
+ *    />
+ *   );
+ * }
+ * ```
+ *
+ */
+declare function useWorkbookLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onLoaded: OnLoaded): void;
+/**
+ * Listen for a workbook error event, and execute the given callback when it occurs.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const [error, setError] = useState<string | null>(null);
+ *   const onError = useCallback((event: WorkbookErrorEvent) => {
+ *     sendToErrorReporting(event.message);
+ *     setError(event.message);
+ *   }, []);
+ *   const iframeRef = useRef<HTMLIFrameElement>(null);
+ *   return (
+ *    <iframe
+ *      ref={iframeRef}
+ *      src="https://sigmacomputing.app/embed"
+ *    />
+ *   );
+ * }
+ * ```
+ *
+ */
+declare function useWorkbookError(iframeRef: React.RefObject<HTMLIFrameElement>, onError: OnError): void;
 
-export { useWorkbookError, useWorkbookLoaded };
+export { type OnError, type OnLoaded, useWorkbookError, useWorkbookLoaded };

package/dist/index.d.ts

@@ -1,6 +1,52 @@
 import { WorkbookLoadedEvent, WorkbookErrorEvent } from '@sigmacomputing/embed-sdk';
+export * from '@sigmacomputing/embed-sdk';
 
-declare function useWorkbookLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onLoaded: (event: WorkbookLoadedEvent) => void): void;
-declare function useWorkbookError(iframeRef: React.RefObject<HTMLIFrameElement>, onError: (event: WorkbookErrorEvent) => void): void;
+type OnLoaded = (event: WorkbookLoadedEvent) => void;
+type OnError = (event: WorkbookErrorEvent) => void;
+/**
+ * Listen for a workbook loaded event, and execute the given callback when it occurs.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const [loading, setLoading] = useState(true);
+ *   const loadingCallback = useCallback(() => setLoading(false), []);
+ *   const iframeRef = useRef<HTMLIFrameElement>(null);
+ *   useWorkbookLoaded(iframeRef, loadingCallback);
+ *   return (
+ *    <iframe
+ *      className{loading ? "hidden" : "show"}
+ *      ref={iframeRef}
+ *      src="https://sigmacomputing.app/embed"
+ *    />
+ *   );
+ * }
+ * ```
+ *
+ */
+declare function useWorkbookLoaded(iframeRef: React.RefObject<HTMLIFrameElement>, onLoaded: OnLoaded): void;
+/**
+ * Listen for a workbook error event, and execute the given callback when it occurs.
+ *
+ * @example
+ * ```
+ * function MyEmbed() {
+ *   const [error, setError] = useState<string | null>(null);
+ *   const onError = useCallback((event: WorkbookErrorEvent) => {
+ *     sendToErrorReporting(event.message);
+ *     setError(event.message);
+ *   }, []);
+ *   const iframeRef = useRef<HTMLIFrameElement>(null);
+ *   return (
+ *    <iframe
+ *      ref={iframeRef}
+ *      src="https://sigmacomputing.app/embed"
+ *    />
+ *   );
+ * }
+ * ```
+ *
+ */
+declare function useWorkbookError(iframeRef: React.RefObject<HTMLIFrameElement>, onError: OnError): void;
 
-export { useWorkbookError, useWorkbookLoaded };
+export { type OnError, type OnLoaded, useWorkbookError, useWorkbookLoaded };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sigmacomputing/react-embed-sdk",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "React JavaScript SDK to interact with Sigma Computing's Embed API",
   "scripts": {
     "prepublish": "npm run build",
@@ -23,11 +23,12 @@
     "react-dom": "^16.8 || ^17 || ^18"
   },
   "devDependencies": {
+    "@sigmacomputing/typescript-config": "*",
     "@types/react": "^18.2.66",
     "react": "^18.2.0",
     "react-dom": "^18.2.0"
   },
   "dependencies": {
-    "@sigmacomputing/embed-sdk": "^0.2.0"
+    "@sigmacomputing/embed-sdk": "latest"
   }
 }