@rljson/edge 0.0.0 → 0.0.1

package/dist/edge_version.d.ts

@@ -0,0 +1,2 @@
+/** The version of the `@rljson/edge` package. */
+export declare const edgeVersion = "0.0.1";

package/dist/example.d.ts

@@ -1 +1,7 @@
-export declare const example: () => void;
+/**
+ * Runs the code examples of the README and prints what they produce.
+ *
+ * test/example.spec.ts runs it and compares the output with a golden file,
+ * so the README examples stay in sync with the code.
+ */
+export declare const example: () => Promise<void>;

package/dist/index.d.ts

@@ -1 +1,23 @@
-export { Edge } from './edge.ts';
+export { Edge, mergeConfigs } from './edge.ts';
+export type { EStats } from './edge.ts';
+export { edgeDefaults, resolveEdgeConfig } from './config/config.ts';
+export type { EBrandsConfig, ECadConfig, EConfig, ELayersConfig, EPartsConfig, EPricesConfig, EProgress, EResolvedConfig, EResolvedLayers, ERevisionsConfig, ESharing, EWorkshopsConfig, } from './config/config.ts';
+export { edgePresetNames, edgePresets } from './config/presets.ts';
+export type { EPresetName } from './config/presets.ts';
+export { EMemorySink } from './core/sink.ts';
+export type { ESink } from './core/sink.ts';
+export type { EEstimate } from './core/estimate.ts';
+export { carWorldTableKeys } from './car-world/car-world.ts';
+export type { EAddress, EBrand, ECadMeta, ECarWorld, ECarWorldTableKey, EManufacturer, EPart, EPerson, EPrice, EWorkshop, } from './car-world/car-world.ts';
+export { carWorldTableCfgs } from './car-world/table-cfgs.ts';
+export { manufacturers } from './dictionaries/manufacturers.ts';
+export type { EManufacturerEntry } from './dictionaries/manufacturers.ts';
+export { modelsOf, vehicles } from './dictionaries/vehicles.ts';
+export type { EBodyType, EFuel, EVehicleModel, } from './dictionaries/vehicles.ts';
+export { assemblies, materialsOf, standardParts, } from './dictionaries/parts.ts';
+export type { EAssembly, EStandardPart, ESubAssembly, } from './dictionaries/parts.ts';
+export { cadDetails, cadMaterials, cadSystems } from './dictionaries/cad.ts';
+export type { ECadSystem } from './dictionaries/cad.ts';
+export { cities, citiesIn, cityNamed, streets } from './dictionaries/places.ts';
+export type { ECity } from './dictionaries/places.ts';
+export { firstNames, lastNames } from './dictionaries/people.ts';

package/dist/src/example.ts

@@ -6,22 +6,64 @@
 
 import { Edge } from './edge.ts';
 
+// .............................................................................
+/**
+ * Prints a line of an example's result.
+ * @param text - The line
+ */
+const print = (text: string) => console.log(`  ${text}`);
 
-export const example = () => {
-  // Print methods
-  const l = console.log;
-  const h1 = (text: string) => l(`${text}`);
-  const h2 = (text: string) => l(`  ${text.split('\n')}`);
-  const p = (text: string) => l(`    ${text}`);
+// .............................................................................
+/** Generates the tiny preset in memory: the first README example */
+const generateExample = async (): Promise<void> => {
+  console.log('Generate a world');
+  const { world, stats } = await Edge.preset('tiny').generate();
+  print(`${stats.cars} cars, ${stats.rowsTotal} rows`);
+  print(`${world.manufacturers._data[0].name}`);
+};
+
+// .............................................................................
+/** Configures a world and estimates it first: the second README example */
+const configureExample = async (): Promise<void> => {
+  console.log('Configure a world');
+  const edge = new Edge({
+    manufacturers: { count: 2, catalogsPerManufacturer: 2 },
+    catalogs: { carsPerCatalog: 20, revisions: { count: 1 } },
+    layers: {
+      prices: { currencies: ['EUR', 'CHF'], range: { min: 20000, max: 80000 } },
+      brands: { modelsPerManufacturer: 3, popularity: 'zipf' },
+      workshops: { perCatalog: 4 },
+      parts: { depth: 3, fanOut: 2 },
+      cad: { depth: 2, fanOut: 3 },
+    },
+  });
+  print(`estimated rows: ${edge.estimate().rowsTotal}`);
+  const { stats } = await edge.generate();
+  print(`generated rows: ${stats.rowsTotal}`);
+};
 
-  // Example
-  h1('Edge.example');
-  h2('Returns an instance of the Edge.');
-  const example = Edge.example;
-  p(JSON.stringify(example, null, 2));
+// .............................................................................
+/** Streams the rows through a callback: the third README example */
+const streamExample = async (): Promise<void> => {
+  console.log('Stream the rows through a callback');
+  const rowsPerTable: Record<string, number> = {};
+  await Edge.preset('small').run({
+    onRow: (table) => {
+      rowsPerTable[table] = (rowsPerTable[table] ?? 0) + 1;
+    },
+  });
+  print(`prices: ${rowsPerTable.prices}, parts: ${rowsPerTable.parts}`);
 };
 
-/*
-// Run via "npx vite-node src/example.ts"
-example();
-*/
+// .............................................................................
+/**
+ * Runs the code examples of the README and prints what they produce.
+ *
+ * test/example.spec.ts runs it and compares the output with a golden file,
+ * so the README examples stay in sync with the code.
+ */
+export const example = async (): Promise<void> => {
+  await generateExample();
+  await configureExample();
+  await streamExample();
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rljson/edge",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "Example Data Generator",
   "homepage": "https://github.com/rljson/edge",
   "bugs": "https://github.com/rljson/edge/issues",
@@ -26,8 +26,8 @@
     "@rljson/dna-rljson": "^0.2.0",
     "@tssuite/helix-js": "^0.3.0",
     "@types/node": "^26.6.4",
-    "@typescript-eslint/eslint-plugin": "^8.71.0",
-    "@typescript-eslint/parser": "^8.71.0",
+    "@typescript-eslint/eslint-plugin": "^8.71.1",
+    "@typescript-eslint/parser": "^8.71.1",
     "@vitest/coverage-v8": "^5.0.3",
     "cross-env": "^10.1.0",
     "eslint": "^10.12.0",
@@ -37,7 +37,7 @@
     "jsdoc": "^4.0.5",
     "read-pkg": "^10.1.0",
     "typescript": "~6.0.3",
-    "typescript-eslint": "^8.71.0",
+    "typescript-eslint": "^8.71.1",
     "vite": "^8.3.2",
     "vite-node": "^6.0.0",
     "vite-plugin-dts": "^5.1.2",