@graphty/cytoscape-extensions 0.0.19 → 0.0.21

package/README.md

@@ -45,7 +45,8 @@ draw();
 ## Loading
 
 - With npm and a bundler (Vite, webpack, esbuild, Rollup), import the package as above. It is ES modules only; the
-  WebGPU code, the generators, each dataset and the file formats load on first use.
+  WebGPU code, the generators and the file formats load on first use, and every dataset downloads from graphty.app
+  when asked for.
 - With no build step, import the ES module build from a CDN:
   `https://cdn.jsdelivr.net/npm/@graphty/cytoscape-extensions/dist/cdn/cytoscape-extensions.js`.
 - With a classic `<script src>` tag, load `dist/cytoscape-extensions.bundle.js` after Cytoscape. It registers

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@graphty/cytoscape-extensions",
-  "version": "0.0.19",
+  "version": "0.0.21",
   "description": "Graphty layouts, algorithms, graph generators, sample datasets and file import/export as Cytoscape.js extensions",
   "author": "Adam Powers <apowers@ato.ms>",
   "type": "module",
@@ -71,9 +71,9 @@
   },
   "homepage": "https://github.com/graphty-org/graphty-monorepo/tree/master/cytoscape-extensions#readme",
   "dependencies": {
-    "@graphty/graph-io": "^0.3.40",
-    "@graphty/graph-samples": "^0.1.32",
-    "@graphty/webgpu-graph-algorithms": "^0.6.54"
+    "@graphty/graph-io": "^0.3.41",
+    "@graphty/graph-samples": "^0.1.34",
+    "@graphty/webgpu-graph-algorithms": "^0.6.56"
   },
   "peerDependencies": {
     "@graphty/algorithms": "^3.0.0",
@@ -96,15 +96,16 @@
     "eslint": "^9.29.0",
     "prettier": "^3.4.2",
     "storybook": "^9.0.11",
+    "tsx": "^4.20.3",
     "typedoc": "^0.28.15",
     "typedoc-plugin-markdown": "^4.9.0",
     "typedoc-vitepress-theme": "^1.1.2",
     "typescript": "^5.9.3",
     "vite": "^7.0.5",
     "vitest": "4.1.11",
-    "@graphty/algorithms": "^3.4.7",
-    "@graphty/graph-format": "^1.4.1",
-    "@graphty/layout": "^2.5.3"
+    "@graphty/algorithms": "^3.4.9",
+    "@graphty/graph-format": "^1.4.2",
+    "@graphty/layout": "^2.5.5"
   },
   "scripts": {
     "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json && vite build --config vite.bundle.config.ts --mode cdn --logLevel warn && vite build --config vite.bundle.config.ts --logLevel warn",
@@ -121,6 +122,6 @@
     "ready:commit": "npm run build && npm run lint && npm run test:run",
     "docs:reference": "UPDATE_REFERENCE=1 vitest run test/reference.test.ts",
     "docs:api": "typedoc && node ../tools/sanitize-api-docs.js docs/api/generated",
-    "size": "node scripts/size.mjs"
+    "size": "node scripts/size-budgets.test.mjs && node scripts/size.mjs"
   }
 }

package/src/graph-data.ts

@@ -40,8 +40,8 @@ export interface GraphtyGraphData {
      */
     graphtyGenerate<N extends GeneratorName>(name: N, options: GeneratorOptions<N>): Promise<AddedGraph>;
     /**
-     * Adds a sample dataset: `cy.graphtyDataset("karate")`. The small ones ship with the package; the large ones
-     * (road-ny, ogbn-arxiv, com-dblp) are downloaded from graphty.app. Throws, adding nothing, when the core already holds one of the graph's node ids.
+     * Adds a sample dataset: `cy.graphtyDataset("karate")`, downloaded from graphty.app (`options.baseUrl` for a
+     * mirror of your own). Throws, adding nothing, when the core already holds one of the graph's node ids.
      * `options.signal` cancels it: once aborted, it rejects with the signal's reason and adds nothing, whatever
      * `options.fetch` does with the signal.
      */

package/src/samples.ts

@@ -1,7 +1,7 @@
 /**
  * `@graphty/cytoscape-extensions/samples`: the seeded generators and the sample datasets of @graphty/graph-samples
- * as Cytoscape elements. cy.graphtyGenerate() and cy.graphtyDataset() load this module on their first call, and
- * each bundled dataset is a module of its own, loaded only when it is asked for.
+ * as Cytoscape elements. cy.graphtyGenerate() and cy.graphtyDataset() load this module on their first call; every
+ * dataset downloads from graphty.app when it is asked for (no dataset's data ships in the package).
  */
 
 import { fromEdgeArrays, type GraphSnapshot } from "@graphty/graph-format";
@@ -94,35 +94,28 @@ export { NAMED_GRAPH_NAMES } from "@graphty/graph-samples/generators";
 /** The options of a generator. */
 export type GeneratorOptions<N extends GeneratorName> = Parameters<(typeof GENERATORS)[N]>[0];
 
-// One static specifier per dataset, so a bundler splits each into a chunk of its own.
-const BUNDLED: Record<string, () => Promise<SampleGraph>> = {
-    karate: () => import("@graphty/graph-samples/datasets/karate").then((m) => m.karate()),
-    "florentine-families": () =>
-        import("@graphty/graph-samples/datasets/florentine-families").then((m) => m.florentineFamilies()),
-    "davis-southern-women": () =>
-        import("@graphty/graph-samples/datasets/davis-southern-women").then((m) => m.davisSouthernWomen()),
-    "les-miserables": () => import("@graphty/graph-samples/datasets/les-miserables").then((m) => m.lesMiserables()),
-    football: () => import("@graphty/graph-samples/datasets/football").then((m) => m.football()),
-    "political-books": () => import("@graphty/graph-samples/datasets/political-books").then((m) => m.politicalBooks()),
-    dolphins: () => import("@graphty/graph-samples/datasets/dolphins").then((m) => m.dolphins()),
-    "contiguous-usa": () => import("@graphty/graph-samples/datasets/contiguous-usa").then((m) => m.contiguousUsa()),
-    "knuth-miles": () => import("@graphty/graph-samples/datasets/knuth-miles").then((m) => m.knuthMiles()),
-    "celegans-neural": () => import("@graphty/graph-samples/datasets/celegans-neural").then((m) => m.celegansNeural()),
-    "political-blogs": () => import("@graphty/graph-samples/datasets/political-blogs").then((m) => m.politicalBlogs()),
-    openflights: () => import("@graphty/graph-samples/datasets/openflights").then((m) => m.openflights()),
-    "yeast-perturbation": () =>
-        import("@graphty/graph-samples/datasets/yeast-perturbation").then((m) => m.yeastPerturbation()),
-    "stelzl-interactome": () =>
-        import("@graphty/graph-samples/datasets/stelzl-interactome").then((m) => m.stelzlInteractome()),
-    "wikipathways-senescence-autophagy": () =>
-        import("@graphty/graph-samples/datasets/wikipathways-senescence-autophagy").then((m) =>
-            m.wikipathwaysSenescenceAutophagy(),
-        ),
-    "go-slim-generic": () => import("@graphty/graph-samples/datasets/go-slim-generic").then((m) => m.goSlimGeneric()),
-};
-
-/** The datasets that ship inside @graphty/graph-samples; the hosted ones (graph-samples' DATASETS) are fetched. */
-export const BUNDLED_DATASET_NAMES: readonly string[] = Object.keys(BUNDLED);
+/**
+ * The small datasets, which the package used to bundle. Every dataset now downloads from graphty.app like the rest.
+ * @deprecated every dataset is downloaded; graph-samples' `DATASET_NAMES` lists them all
+ */
+export const BUNDLED_DATASET_NAMES: readonly string[] = [
+    "karate",
+    "florentine-families",
+    "davis-southern-women",
+    "les-miserables",
+    "football",
+    "political-books",
+    "dolphins",
+    "contiguous-usa",
+    "knuth-miles",
+    "celegans-neural",
+    "political-blogs",
+    "openflights",
+    "yeast-perturbation",
+    "stelzl-interactome",
+    "wikipathways-senescence-autophagy",
+    "go-slim-generic",
+];
 
 /**
  * The number of single-character edits that turn one string into the other.
@@ -240,24 +233,22 @@ export function generateElements<N extends GeneratorName>(name: N, options: Gene
 }
 
 /**
- * Loads a sample dataset: a bundled one from its own module, any other from graphty.app (see graph-samples'
- * `DATASETS` for the list, with each one's source, citation and license). A drawn dataset's saved `x` and `y` become
- * node positions, placed where Cytoscape drew them.
+ * Loads a sample dataset from graphty.app (see graph-samples' `DATASETS` for the list, with each one's source,
+ * citation and license). A drawn dataset's saved `x` and `y` become node positions, placed where Cytoscape drew them.
  * @param name - the dataset name, e.g. "karate"
- * @param options - for a hosted dataset: the base URL and fetch implementation; for any dataset, an abort signal
+ * @param options - the base URL (a mirror of your own), the fetch implementation and an abort signal
  * @returns the elements and the direction
  * @throws the signal's reason (an AbortError) when it is aborted before the dataset is decoded
  * @throws RangeError for a name that is not a known dataset, unless `baseUrl` is given
  */
 export async function datasetElements(name: string, options: FetchDatasetOptions = {}): Promise<SampleElements> {
-    // checked here too, not only by fetch: a bundled dataset is not fetched, and a custom fetch may ignore the signal
+    // checked here too, not only by fetch: a custom fetch may ignore the signal
     options.signal?.throwIfAborted();
-    const load = BUNDLED[name];
     // only graphty.app's own list is checked: a custom baseUrl may serve any name
-    if (load === undefined && options.baseUrl === undefined && !DATASET_NAMES.includes(name)) {
+    if (options.baseUrl === undefined && !DATASET_NAMES.includes(name)) {
         throw unknownName("dataset", name, DATASET_NAMES);
     }
-    const graph = load === undefined ? await fetchDataset(name, options) : await load();
+    const graph = await fetchDataset(name, options);
     options.signal?.throwIfAborted();
     const r = fromSample(graph);
     // a drawn dataset's saved x and y (y growing upward) become the position Cytoscape drew (y growing downward)