@vizabi/reader-ddfcsv 4.5.2 → 4.5.4

package/.nyc_output/processinfo/574fe7f0-58f6-4de2-9524-16e72b784218.json

@@ -0,0 +1 @@
+{"parent":null,"pid":24795,"argv":["/home/test/.nvm/versions/node/v22.19.0/bin/node","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/node_modules/.bin/mocha"],"execArgv":[],"cwd":"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv","time":1771812751168,"ppid":24784,"coverageFilename":"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/.nyc_output/574fe7f0-58f6-4de2-9524-16e72b784218.json","externalId":"","uuid":"574fe7f0-58f6-4de2-9524-16e72b784218","files":[]}

package/.nyc_output/processinfo/9aede69f-00e6-432d-bdeb-2c9f4084a6dc.json

@@ -0,0 +1 @@
+{"parent":"574fe7f0-58f6-4de2-9524-16e72b784218","pid":24809,"argv":["/home/test/.nvm/versions/node/v22.19.0/bin/node","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/node_modules/mocha/lib/cli/cli.js","test/**/*.spec.ts","--no-config","--no-package","--require","source-map-support/register","--full-trace","--timeout","20000","--recursive","--diff","--extension","js","--extension","cjs","--extension","mjs","--reporter","spec","--slow","75","--ui","bdd","--watch-ignore","node_modules","--watch-ignore",".git"],"execArgv":["--import=tsx"],"cwd":"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv","time":1771812752509,"ppid":24795,"coverageFilename":"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/.nyc_output/9aede69f-00e6-432d-bdeb-2c9f4084a6dc.json","externalId":"","uuid":"9aede69f-00e6-432d-bdeb-2c9f4084a6dc","files":["/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/index.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/file-readers/backend-file-reader.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddfcsv-error.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/interfaces.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddfcsv-reader.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddf-csv.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/resource-selection-optimizer/index.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/resource-selection-optimizer/in-clause-under-conjunction.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/file-readers/github-path-adapter.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/test-cases/concepts.ts","/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/test-cases/entities.ts"]}

package/.nyc_output/processinfo/index.json

@@ -0,0 +1 @@
+{"processes":{"574fe7f0-58f6-4de2-9524-16e72b784218":{"parent":null,"children":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"]},"9aede69f-00e6-432d-bdeb-2c9f4084a6dc":{"parent":"574fe7f0-58f6-4de2-9524-16e72b784218","children":[]}},"files":{"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/index.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/file-readers/backend-file-reader.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddfcsv-error.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/interfaces.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddfcsv-reader.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/ddf-csv.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/resource-selection-optimizer/index.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/resource-selection-optimizer/in-clause-under-conjunction.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/file-readers/github-path-adapter.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/test-cases/concepts.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"],"/mnt/c/Users/kukusya/Documents/projects/reader-ddfcsv/src/test-cases/entities.ts":["9aede69f-00e6-432d-bdeb-2c9f4084a6dc"]},"externalIds":{}}

package/README.md

@@ -1,112 +1,122 @@
 # Vizabi DDFcsv reader
+This package implements [DDF model](https://open-numbers.github.io/ddf.html) for datasets made of csv files and a datapackage.json. 
+Once initialised, this reader can receive DDFQL queries, perform data searching, filtering, joinery etc and output an tidy data array for data visualisation.
 
+See live example here https://observablehq.com/@vizabi/ddfcsv-reader
 ## Install
-
-```
+```bash
 npm i @vizabi/reader-ddfcsv
 ```
-
 ## Usage
-
-```
-const Vizabi = require('vizabi');
-const ddfCsvReader = require('reader-ddfcsv');
-const readerObject = ddfCsvReader.getDDFCsvReaderObject();
-Vizabi.Reader.extend('ddf-csv-reader', readerObject);
-// ...
+There are two implementations: for frontend and backend. Additionally, you can customise file reading plugin, so that for example backend implementation would fetch files online instead of reading locally.
+
+* Backend implementation is at `lib/src/index.js`, also usable via es6 import `import DDFCsvReader from "@vizabi/reader-ddfcsv"`, as aliased by "main" field in package.json
+
+* Frontend implementation is at `lib-web/src/index-web.js`, also bundled and minified to `dist/reader-ddfcsv.js`
+### On Backend
+```js
+//this will import "lib/src/index.js", aliased by "main" in package.json
+import DDFCsvReader from "@vizabi/reader-ddfcsv"; 
+
+//init
+const readerInstance = new DDFCsvReader.getDDFCsvReaderObject();
+readerInstance.init({path: "path/to/local/dataset/root"});
+
+//test reading some concepts
+const concepts = await readerInstance.read({
+	from: "concepts",
+	language: "en",
+	select: {key: ["concept"], value: ["concept_type", "name"]},
+	where: {}
+})
 ```
-
-## Build
+### On Frontend
+On a plain webpage use
+```js
+import "@vizabi/reader-ddfcsv/dist/reader-ddfcsv.js";
+
+//init
+const ddfReader = new DDFCsvReader.getDDFCsvReaderObject();
+reader.init({
+	path: "https://github.com/open-numbers/ddf--gapminder--fasttrack.git"
+})
+
+const data = await readerInstance.read({
+	from: "datapoints",
+	language: "en",
+	select: {key: ["country", "time"], value: ["gdp_pcap", "lex", "pop"]},
+	where: {}
+})
 
 ```
-git clone https://github.com/vizabi/reader-ddfcsv.git
-cd reader-ddfcsv
-npm i
-npm run build
-```
-
-### Run tests
-
+  
+In Observable notebooks use
 ```
-npm test
+DDFCsvReader = require('https://unpkg.com/@vizabi/reader-ddfcsv@4.5.3')
 ```
 
-And after this you can see `dist` folder that contains two sets:
-
-  * `bundle.js` and `bundle.js.map`
-  * `bundle.web.js` and `bundle.web.js.map`
-  
-First one is for using with electron app or tests. Second one is only for using in browser.
+which will redirect to https://unpkg.com/@vizabi/reader-ddfcsv@4.5.3/dist/reader-ddfcsv.js
 
-## File readers
+See the [Live demo](https://observablehq.com/@vizabi/ddfcsv-reader)
+## Custom file readers
+Each implementation has its own default file readers built-in:
+* FrontendFileReader is a part of `lib-web/src/index-web.js` version, also usable from `dist/reader-ddfcsv.js`
+* BackendFileReader is a part of `lib/src/index.js` version.
 
-`Vizabi DDFcsv reader` has 2 file readers:
- 
-  * FrontendFileReader is a part of `bundle.js` version.
-  * BackendFileReader is a part of `bundle.web.js` version.
-  
+You can find in the source code and import them readers separately
+```js
+import { FrontendFileReader } from "@vizabi/reader-ddfcsv/lib-web/src/index-web.js";
+```
+### FrontendFileReader
+This reader is designed for file reading via HTTP protocol. It uses `fetch`, which since v4.5.2 is no longer polyfilled
 ### BackendFileReader
+This reader is designed for file reading via OS file system. It uses `fs` and `path`
+### Frankensteining: Using FrontendFileReader in a Backend instance
+The backend version of `DDFCsvReader` defaults to `fs` for local files.
+To fetch data from GitHub (or any remote source), inject the `FrontendFileReader`:
 
-This reader is designed for file reading via OS file system.
-  
-### FrontendFileReader
+```js
 
-This reader is designed for file reading via HTTP protocol.
+import DDFCsvReader from "@vizabi/reader-ddfcsv";
+import { FrontendFileReader } from "@vizabi/reader-ddfcsv/lib-web/src/index-web.js";
 
-## DDFcsv reader usage for DDF data reading examples:
+//init
+const readerInstance = new DDFCsvReader.prepareDDFCsvReaderObject(new FrontendFileReader)();
+readerInstance.init({ path: "https://github.com/open-numbers/ddf--gapminder--ai_worldview_benchmark.git" });
 
-```
-import {BackendFileReader, Ddf} from 'reader-ddfcsv';
-
-const backendFileReader = new BackendFileReader();
-const ddf = new Ddf('your-ddf-folder', backendFileReader);
-
-ddf.getIndex(indexErr => {
-  // process indexErr here ...
-    
-  ddf.getConcepts((conceptsErr, conceptsData) => {
-    // process conceptsErr here ...
-
-    // process conceptsData here ...
-
-    ddf.getAllDataPointsContent(
-      (dataPointsFileErr, dataPointsData) => {
-        // process dataPointsFileErr here ...
-        
-        // process dataPointsData here ...
-      },
-      dataPointsAllErr => {
-        // process dataPointsAllErr here ...
-
-        // data reading finish
-      });
-  });
-});
-```
+//usage example
+const concepts = await readerInstance.read({
+	from: "concepts",
+	language: "en",
+	select: {key: ["concept"], value: ["concept_type", "name"]},
+	where: {}
+})
 
-or 
+```
 
+## Data reading examples:
+Once you can access concepts of a dataset you can run any other DDFQL query, see [DDFQL specs](https://open-numbers.github.io/ddf.html)
+
+```js
+//typical datapoint query
+data = readerInstance.read({
+	from: "datapoints",
+	language: "en",
+	select: {key: ["country", "time"], value: ["gdp_pcap", "lex", "pop"]},
+	where: {}
+})
 ```
-import {BackendFileReader, Ddf} from 'reader-ddfcsv';
-
-const backendFileReader = new BackendFileReader();
-const ddf = new Ddf('your-ddf-folder', backendFileReader);
-// for example, :
-const query = {
-  from: 'entities',
-  animatable: 'time',
-    select: {
-      key: ['geo'],
-      value: ['geo.name', '_default', 'geo.world_4region']
-    },
-    where: {'geo.is--country': true},
-    grouping: {},
-    orderBy: null
-  };
-  
-ddf.processRequest(query, (err, data) => {
-    // process err here ...
 
-    // process expected data here ...
-};
+interactive example: https://observablehq.com/@vizabi/ddfcsv-reader
+
+## Build
+```bash
+git clone https://github.com/vizabi/reader-ddfcsv.git
+cd reader-ddfcsv
+npm i
+npm run build
 ```
+## Run tests
+```bash
+npm test
+```

package/coverage/base.css

@@ -0,0 +1,224 @@
+body, html {
+  margin:0; padding: 0;
+  height: 100%;
+}
+body {
+    font-family: Helvetica Neue, Helvetica, Arial;
+    font-size: 14px;
+    color:#333;
+}
+.small { font-size: 12px; }
+*, *:after, *:before {
+  -webkit-box-sizing:border-box;
+     -moz-box-sizing:border-box;
+          box-sizing:border-box;
+  }
+h1 { font-size: 20px; margin: 0;}
+h2 { font-size: 14px; }
+pre {
+    font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
+    margin: 0;
+    padding: 0;
+    -moz-tab-size: 2;
+    -o-tab-size:  2;
+    tab-size: 2;
+}
+a { color:#0074D9; text-decoration:none; }
+a:hover { text-decoration:underline; }
+.strong { font-weight: bold; }
+.space-top1 { padding: 10px 0 0 0; }
+.pad2y { padding: 20px 0; }
+.pad1y { padding: 10px 0; }
+.pad2x { padding: 0 20px; }
+.pad2 { padding: 20px; }
+.pad1 { padding: 10px; }
+.space-left2 { padding-left:55px; }
+.space-right2 { padding-right:20px; }
+.center { text-align:center; }
+.clearfix { display:block; }
+.clearfix:after {
+  content:'';
+  display:block;
+  height:0;
+  clear:both;
+  visibility:hidden;
+  }
+.fl { float: left; }
+@media only screen and (max-width:640px) {
+  .col3 { width:100%; max-width:100%; }
+  .hide-mobile { display:none!important; }
+}
+
+.quiet {
+  color: #7f7f7f;
+  color: rgba(0,0,0,0.5);
+}
+.quiet a { opacity: 0.7; }
+
+.fraction {
+  font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
+  font-size: 10px;
+  color: #555;
+  background: #E8E8E8;
+  padding: 4px 5px;
+  border-radius: 3px;
+  vertical-align: middle;
+}
+
+div.path a:link, div.path a:visited { color: #333; }
+table.coverage {
+  border-collapse: collapse;
+  margin: 10px 0 0 0;
+  padding: 0;
+}
+
+table.coverage td {
+  margin: 0;
+  padding: 0;
+  vertical-align: top;
+}
+table.coverage td.line-count {
+    text-align: right;
+    padding: 0 5px 0 20px;
+}
+table.coverage td.line-coverage {
+    text-align: right;
+    padding-right: 10px;
+    min-width:20px;
+}
+
+table.coverage td span.cline-any {
+    display: inline-block;
+    padding: 0 5px;
+    width: 100%;
+}
+.missing-if-branch {
+    display: inline-block;
+    margin-right: 5px;
+    border-radius: 3px;
+    position: relative;
+    padding: 0 4px;
+    background: #333;
+    color: yellow;
+}
+
+.skip-if-branch {
+    display: none;
+    margin-right: 10px;
+    position: relative;
+    padding: 0 4px;
+    background: #ccc;
+    color: white;
+}
+.missing-if-branch .typ, .skip-if-branch .typ {
+    color: inherit !important;
+}
+.coverage-summary {
+  border-collapse: collapse;
+  width: 100%;
+}
+.coverage-summary tr { border-bottom: 1px solid #bbb; }
+.keyline-all { border: 1px solid #ddd; }
+.coverage-summary td, .coverage-summary th { padding: 10px; }
+.coverage-summary tbody { border: 1px solid #bbb; }
+.coverage-summary td { border-right: 1px solid #bbb; }
+.coverage-summary td:last-child { border-right: none; }
+.coverage-summary th {
+  text-align: left;
+  font-weight: normal;
+  white-space: nowrap;
+}
+.coverage-summary th.file { border-right: none !important; }
+.coverage-summary th.pct { }
+.coverage-summary th.pic,
+.coverage-summary th.abs,
+.coverage-summary td.pct,
+.coverage-summary td.abs { text-align: right; }
+.coverage-summary td.file { white-space: nowrap;  }
+.coverage-summary td.pic { min-width: 120px !important;  }
+.coverage-summary tfoot td { }
+
+.coverage-summary .sorter {
+    height: 10px;
+    width: 7px;
+    display: inline-block;
+    margin-left: 0.5em;
+    background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
+}
+.coverage-summary .sorted .sorter {
+    background-position: 0 -20px;
+}
+.coverage-summary .sorted-desc .sorter {
+    background-position: 0 -10px;
+}
+.status-line {  height: 10px; }
+/* yellow */
+.cbranch-no { background: yellow !important; color: #111; }
+/* dark red */
+.red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
+.low .chart { border:1px solid #C21F39 }
+.highlighted,
+.highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
+  background: #C21F39 !important;
+}
+/* medium red */
+.cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
+/* light red */
+.low, .cline-no { background:#FCE1E5 }
+/* light green */
+.high, .cline-yes { background:rgb(230,245,208) }
+/* medium green */
+.cstat-yes { background:rgb(161,215,106) }
+/* dark green */
+.status-line.high, .high .cover-fill { background:rgb(77,146,33) }
+.high .chart { border:1px solid rgb(77,146,33) }
+/* dark yellow (gold) */
+.status-line.medium, .medium .cover-fill { background: #f9cd0b; }
+.medium .chart { border:1px solid #f9cd0b; }
+/* light yellow */
+.medium { background: #fff4c2; }
+
+.cstat-skip { background: #ddd; color: #111; }
+.fstat-skip { background: #ddd; color: #111 !important; }
+.cbranch-skip { background: #ddd !important; color: #111; }
+
+span.cline-neutral { background: #eaeaea; }
+
+.coverage-summary td.empty {
+    opacity: .5;
+    padding-top: 4px;
+    padding-bottom: 4px;
+    line-height: 1;
+    color: #888;
+}
+
+.cover-fill, .cover-empty {
+  display:inline-block;
+  height: 12px;
+}
+.chart {
+  line-height: 0;
+}
+.cover-empty {
+    background: white;
+}
+.cover-full {
+    border-right: none !important;
+}
+pre.prettyprint {
+    border: none !important;
+    padding: 0 !important;
+    margin: 0 !important;
+}
+.com { color: #999 !important; }
+.ignore-none { color: #999; font-weight: normal; }
+
+.wrapper {
+  min-height: 100%;
+  height: auto !important;
+  height: 100%;
+  margin: 0 auto -48px;
+}
+.footer, .push {
+  height: 48px;
+}

package/coverage/block-navigation.js

@@ -0,0 +1,87 @@
+/* eslint-disable */
+var jumpToCode = (function init() {
+    // Classes of code we would like to highlight in the file view
+    var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
+
+    // Elements to highlight in the file listing view
+    var fileListingElements = ['td.pct.low'];
+
+    // We don't want to select elements that are direct descendants of another match
+    var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
+
+    // Selector that finds elements on the page to which we can jump
+    var selector =
+        fileListingElements.join(', ') +
+        ', ' +
+        notSelector +
+        missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
+
+    // The NodeList of matching elements
+    var missingCoverageElements = document.querySelectorAll(selector);
+
+    var currentIndex;
+
+    function toggleClass(index) {
+        missingCoverageElements
+            .item(currentIndex)
+            .classList.remove('highlighted');
+        missingCoverageElements.item(index).classList.add('highlighted');
+    }
+
+    function makeCurrent(index) {
+        toggleClass(index);
+        currentIndex = index;
+        missingCoverageElements.item(index).scrollIntoView({
+            behavior: 'smooth',
+            block: 'center',
+            inline: 'center'
+        });
+    }
+
+    function goToPrevious() {
+        var nextIndex = 0;
+        if (typeof currentIndex !== 'number' || currentIndex === 0) {
+            nextIndex = missingCoverageElements.length - 1;
+        } else if (missingCoverageElements.length > 1) {
+            nextIndex = currentIndex - 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    function goToNext() {
+        var nextIndex = 0;
+
+        if (
+            typeof currentIndex === 'number' &&
+            currentIndex < missingCoverageElements.length - 1
+        ) {
+            nextIndex = currentIndex + 1;
+        }
+
+        makeCurrent(nextIndex);
+    }
+
+    return function jump(event) {
+        if (
+            document.getElementById('fileSearch') === document.activeElement &&
+            document.activeElement != null
+        ) {
+            // if we're currently focused on the search input, we don't want to navigate
+            return;
+        }
+
+        switch (event.which) {
+            case 78: // n
+            case 74: // j
+                goToNext();
+                break;
+            case 66: // b
+            case 75: // k
+            case 80: // p
+                goToPrevious();
+                break;
+        }
+    };
+})();
+window.addEventListener('keydown', jumpToCode);