@sqlrooms/mosaic 0.6.0 → 0.8.0

package/README.md

@@ -0,0 +1,67 @@
+This package is part of the SQLRooms framework. It provides React components and hooks for integrating [Mosaic](https://idl.uw.edu/mosaic/) - a visualization library for data exploration and analysis - into SQLRooms applications.
+
+## Overview
+
+Mosaic is a JavaScript library for data visualization and analysis developed by the [Interactive Data Lab (IDL)](https://idl.uw.edu/) at the University of Washington. It combines the expressiveness of declarative visualization grammars with the power of reactive programming and SQL queries.
+
+One of Mosaic's powerful features is its cross-filtering capability powered by DuckDB, allowing users to interactively filter and explore large datasets with millions of records directly in the browser. This enables creating interactive dashboards where selections in one chart automatically filter data in other charts. For an example of this functionality, see the [Cross-Filter Flights demo](https://idl.uw.edu/mosaic/examples/flights-200k.html) which demonstrates interactive filtering across multiple visualizations of a 200,000-record flight dataset.
+
+This package provides:
+
+- React components for rendering Vega-Lite charts using Mosaic
+- Hooks for integrating Mosaic with DuckDB in SQLRooms applications
+- Utilities for working with Mosaic specifications
+
+## Installation
+
+```bash
+npm install @sqlrooms/mosaic
+```
+
+## Usage
+
+### VgPlotChart Component
+
+The `VgPlotChart` component renders a Vega-Lite chart using the Mosaic library:
+
+```tsx
+import {VgPlotChart, Spec} from '@sqlrooms/mosaic';
+
+const spec: Spec = {
+  // Your Vega-Lite specification
+};
+
+function MyChart() {
+  return <VgPlotChart spec={spec} />;
+}
+```
+
+### useMosaic Hook
+
+The `useMosaic` hook provides access to the Mosaic connector for DuckDB:
+
+```tsx
+import {useMosaic} from '@sqlrooms/mosaic';
+
+function MyComponent() {
+  const {isMosaicLoading, mosaicConnector} = useMosaic();
+
+  if (isMosaicLoading) {
+    return <div>Loading...</div>;
+  }
+
+  // Use mosaicConnector to interact with DuckDB through Mosaic
+  return <div>Mosaic is ready!</div>;
+}
+```
+
+## Resources
+
+- [Mosaic Documentation](https://idl.uw.edu/mosaic/)
+- [Cross-Filter Flights Demo](https://idl.uw.edu/mosaic/examples/flights-200k.html)
+- [Vega-Lite Documentation](https://vega.github.io/vega-lite/)
+- [DuckDB Documentation](https://duckdb.org/docs/)
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export { getMosaicConnector, useMosaic } from './use-mosaic';
 export { VgPlotChart } from './VgPlotChart';
 export type { Spec } from '@uwdata/mosaic-spec';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC1C,YAAY,EAAC,IAAI,EAAC,MAAM,qBAAqB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC;AAC1C,YAAY,EAAC,IAAI,EAAC,MAAM,qBAAqB,CAAC"}

package/dist/index.js

@@ -1,3 +1,7 @@
+/**
+ * {@include ../README.md}
+ * @packageDocumentation
+ */
 export { getMosaicConnector, useMosaic } from './use-mosaic';
 export { VgPlotChart } from './VgPlotChart';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC","sourcesContent":["export {getMosaicConnector, useMosaic} from './use-mosaic';\nexport {VgPlotChart} from './VgPlotChart';\nexport type {Spec} from '@uwdata/mosaic-spec';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,kBAAkB,EAAE,SAAS,EAAC,MAAM,cAAc,CAAC;AAC3D,OAAO,EAAC,WAAW,EAAC,MAAM,eAAe,CAAC","sourcesContent":["/**\n * {@include ../README.md}\n * @packageDocumentation\n */\nexport {getMosaicConnector, useMosaic} from './use-mosaic';\nexport {VgPlotChart} from './VgPlotChart';\nexport type {Spec} from '@uwdata/mosaic-spec';\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sqlrooms/mosaic",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "module": "dist/index.js",
@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@ai-sdk/provider": "^1.0.7",
-    "@sqlrooms/duckdb": "0.6.0",
+    "@sqlrooms/duckdb": "0.8.0",
     "@uwdata/mosaic-core": "^0.12.2",
     "@uwdata/mosaic-spec": "^0.12.2",
     "@uwdata/vgplot": "^0.12.2"
@@ -35,5 +35,5 @@
     "lint": "eslint .",
     "typedoc": "typedoc"
   },
-  "gitHead": "f46dfe6b5d135e1a039b49b3ba71cda7150eab0f"
+  "gitHead": "99b46a96ab900e6b005bcd30cfbfe7b3c9d51f8d"
 }