@comunica/statistic-link-discovery 3.2.4-alpha.47.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © 2017–now Ruben Taelman, Joachim Van Herwegen
+Comunica Association and Ghent University – imec, Belgium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,39 @@
+# Comunica Statistic Link Discovery
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Fstatistic-link-discovery.svg)](https://www.npmjs.com/package/@comunica/statistic-link-discovery)
+
+A statistics tracker package for tracking discovered links during query execution in Comunica. This class must be added to the context with the key defined in the class.
+
+This module is part of the [Comunica framework](https://github.com/comunica/comunica),
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/statistic-link-discovery
+```
+
+## Using the tracker
+
+```javascript
+    const QueryEngine = require('@comunica/query-sparql').QueryEngine;
+    const myEngine = new QueryEngine();
+    const statisticTracker = new StatisticLinkDiscovery();
+
+    // Print any data emitted by the tracker
+    statisticTracker.on((data) => console.log(data));
+
+    // Add the tracker to the context
+    let context = {sources: ['https://fragments.dbpedia.org/2015/en']};
+    context[statisticTracker.key.name] = statisticTracker;
+
+    // Execute the query
+    const bindingsStream = await myEngine.queryBindings(`
+    SELECT ?s ?p ?o WHERE {
+        ?s ?p ?o
+    } LIMIT 10`, context);
+    bindingsStream.on('data', (binding) => {
+        console.log(binding.toString());
+    });
+```

package/lib/StatisticLinkDiscovery.d.ts

@@ -0,0 +1,10 @@
+import type { ActionContextKey } from '@comunica/core';
+import { StatisticBase } from '@comunica/statistic-base';
+import type { IDiscoverEventData, ILink, IStatisticBase } from '@comunica/types';
+export declare class StatisticLinkDiscovery extends StatisticBase<IDiscoverEventData> {
+    key: ActionContextKey<IStatisticBase<IDiscoverEventData>>;
+    count: number;
+    metadata: Record<string, Record<any, any>[]>;
+    constructor();
+    updateStatistic(link: ILink, parent: ILink): boolean;
+}

package/lib/StatisticLinkDiscovery.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StatisticLinkDiscovery = void 0;
+const context_entries_1 = require("@comunica/context-entries");
+const statistic_base_1 = require("@comunica/statistic-base");
+class StatisticLinkDiscovery extends statistic_base_1.StatisticBase {
+    constructor() {
+        super();
+        this.count = 0;
+        this.metadata = {};
+        this.key = context_entries_1.KeysStatistics.discoveredLinks;
+    }
+    updateStatistic(link, parent) {
+        const discoveredLinkMetadata = {
+            ...link.metadata,
+            discoveredTimestamp: performance.now(),
+            discoverOrder: this.count,
+        };
+        // Retain previous metadata if this link has already been discovered, and add any metadata in the passed link
+        this.metadata[link.url] = this.metadata[link.url] ?
+            [...this.metadata[link.url], discoveredLinkMetadata] :
+            [discoveredLinkMetadata];
+        this.emit({
+            edge: [parent.url, link.url],
+            metadataChild: this.metadata[link.url],
+            metadataParent: this.metadata[parent.url],
+        });
+        this.count++;
+        return true;
+    }
+}
+exports.StatisticLinkDiscovery = StatisticLinkDiscovery;
+//# sourceMappingURL=StatisticLinkDiscovery.js.map

package/lib/StatisticLinkDiscovery.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"StatisticLinkDiscovery.js","sourceRoot":"","sources":["StatisticLinkDiscovery.ts"],"names":[],"mappings":";;;AAAA,+DAA2D;AAE3D,6DAAyD;AAGzD,MAAa,sBAAuB,SAAQ,8BAAiC;IAY3E;QACE,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC;QACf,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACnB,IAAI,CAAC,GAAG,GAAG,gCAAc,CAAC,eAAe,CAAC;IAC5C,CAAC;IAEM,eAAe,CAAC,IAAW,EAAE,MAAa;QAC/C,MAAM,sBAAsB,GAAG;YAC7B,GAAG,IAAI,CAAC,QAAQ;YAChB,mBAAmB,EAAE,WAAW,CAAC,GAAG,EAAE;YACtC,aAAa,EAAE,IAAI,CAAC,KAAK;SAC1B,CAAC;QACF,6GAA6G;QAC7G,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAC/C,CAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,sBAAsB,CAAE,CAAC,CAAC;YACxD,CAAE,sBAAsB,CAAE,CAAC;QAC/B,IAAI,CAAC,IAAI,CAAC;YACR,IAAI,EAAE,CAAE,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,CAAE;YAC9B,aAAa,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC;YACtC,cAAc,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;SAC1C,CAAC,CAAC;QACH,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArCD,wDAqCC","sourcesContent":["import { KeysStatistics } from '@comunica/context-entries';\nimport type { ActionContextKey } from '@comunica/core';\nimport { StatisticBase } from '@comunica/statistic-base';\nimport type { IDiscoverEventData, ILink, IStatisticBase } from '@comunica/types';\n\nexport class StatisticLinkDiscovery extends StatisticBase<IDiscoverEventData> {\n  // Key this statistic tracker should be saved under in context\n  public key: ActionContextKey<IStatisticBase<IDiscoverEventData>>;\n\n  // Number of discover events tracked\n  public count: number;\n\n  // Metadata is saved as follows: First key indicates what url this metadata belongs to, while value is\n  // a list of all metadata objects recorded. This list can contain multiple Records as links can be discovered from\n  // multiple data sources.\n  public metadata: Record<string, Record<any, any>[]>;\n\n  public constructor() {\n    super();\n    this.count = 0;\n    this.metadata = {};\n    this.key = KeysStatistics.discoveredLinks;\n  }\n\n  public updateStatistic(link: ILink, parent: ILink): boolean {\n    const discoveredLinkMetadata = {\n      ...link.metadata,\n      discoveredTimestamp: performance.now(),\n      discoverOrder: this.count,\n    };\n    // Retain previous metadata if this link has already been discovered, and add any metadata in the passed link\n    this.metadata[link.url] = this.metadata[link.url] ?\n        [ ...this.metadata[link.url], discoveredLinkMetadata ] :\n        [ discoveredLinkMetadata ];\n    this.emit({\n      edge: [ parent.url, link.url ],\n      metadataChild: this.metadata[link.url],\n      metadataParent: this.metadata[parent.url],\n    });\n    this.count++;\n    return true;\n  }\n}\n"]}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './StatisticLinkDiscovery';

package/lib/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./StatisticLinkDiscovery"), exports);
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2DAAyC","sourcesContent":["export * from './StatisticLinkDiscovery';\n"]}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@comunica/statistic-link-discovery",
+  "version": "3.2.4-alpha.47.0",
+  "description": "Comunica package that defines the statistic tracking link discovery events",
+  "license": "MIT",
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/comunica-association"
+  },
+  "homepage": "https://comunica.dev/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/statistic-link-discovery"
+  },
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "keywords": [
+    "comunica",
+    "statistic",
+    "link discovery"
+  ],
+  "sideEffects": false,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "bin/**/*.d.ts",
+    "bin/**/*.js",
+    "bin/**/*.js.map",
+    "lib/**/*.d.ts",
+    "lib/**/*.js",
+    "lib/**/*.js.map"
+  ],
+  "scripts": {
+    "build": "node \"../../node_modules/typescript/bin/tsc\""
+  },
+  "dependencies": {
+    "@comunica/context-entries": "3.2.4-alpha.47.0",
+    "@comunica/core": "3.2.4-alpha.47.0",
+    "@comunica/statistic-base": "3.2.4-alpha.47.0",
+    "@comunica/types": "3.2.4-alpha.47.0"
+  },
+  "gitHead": "85bd4c5cf07dfc293ebbc3a1416b70e2db8bfc48"
+}