@zazuko/query-rdf-data-cube - npm Package Compare versions

Comparing version 0.1.2 to 0.2.0

CHANGELOG.md

@@ -0,1 +1,11 @@
+<a name="0.2.0"></a>
+# [0.2.0](https://github.com/zazuko/query-rdf-data-cube/compare/v0.1.2...v0.2.0) (2019-10-21)
+
+
+### Features
+
+* **datacube:** get extra metadata on datacubes ([8ee33f9](https://github.com/zazuko/query-rdf-data-cube/commit/8ee33f9))
+
+
+
 <a name="0.1.2"></a>
@@ -2,0 +12,0 @@ ## [0.1.2](https://github.com/zazuko/query-rdf-data-cube/compare/v0.1.1...v0.1.2) (2019-09-30)

dist/es/datacube.d.ts

 import { Literal, NamedNode } from "rdf-js";
 import { Attribute, Component, Dimension, Measure } from "./components";
-import { EntryPointOptions } from "./entrypoint";
+import { BaseOptions } from "./entrypoint";
 import { Query, QueryOptions } from "./query";
@@ -20,6 +20,7 @@ /**
 }
-export interface DataCubeOptions extends EntryPointOptions {
+export interface DataCubeOptions extends BaseOptions {
     iri: NamedNode;
+    graphIri: NamedNode;
     labels?: Label[];
-    graphIri: NamedNode;
+    extraMetadata?: Map<string, any>;
 }
@@ -38,2 +39,3 @@ /**
     graphIri?: string;
+    extraMetadata: Map<string, Literal>;
     private languages;
@@ -40,0 +42,0 @@ private fetcher;

dist/es/entrypoint.d.ts

 import { NamedNode } from "rdf-js";
 import { DataCube } from "./datacube";
 import { SparqlFetcherOptions } from "./sparqlfetcher";
-export interface EntryPointOptions {
+/**
+ * @ignore
+ */
+export interface ExtraMetadatum {
+    variable: string;
+    iri: string;
+    multilang?: boolean;
+}
+export interface BaseOptions {
     languages?: string[];
     fetcher?: SparqlFetcherOptions;
 }
+export interface EntryPointOptions extends BaseOptions {
+    extraMetadata?: ExtraMetadatum[];
+}
 export declare type SerializedDataCubeEntryPoint = {
@@ -25,2 +36,3 @@ endpoint: string;
     private graphsLoaded;
+    private extraMetadata;
     /**
@@ -34,2 +46,3 @@ * A DataCubeEntryPoint queries a SPARQL endpoint and retrieves [[DataCube]]s and
      * Passed down to [[DataCube]]s and [[Query]].
+     * @param options.extraMetadata Metadata to fetch, see examples/extra-metadata.ts
      */
@@ -36,0 +49,0 @@ constructor(endpoint: string, options?: EntryPointOptions);

dist/es/query.d.ts

 import { Literal, NamedNode } from "rdf-js";
 import { Component } from "./components";
 import { DataCube } from "./datacube";
-import { EntryPointOptions } from "./entrypoint";
+import { BaseOptions } from "./entrypoint";
 import { IExpr, Operator } from "./expressions";
@@ -11,3 +11,3 @@ import { FilterPattern, SelectQuery } from "./sparqljs";
 declare type Selects = Record<string, Component>;
-export interface QueryOptions extends EntryPointOptions {
+export interface QueryOptions extends BaseOptions {
 }
@@ -14,0 +14,0 @@ /**

dist/es/queryutils.d.ts

@@ -1,6 +0,22 @@
-import { Variable } from "rdf-js";
+import { Literal, Variable } from "rdf-js";
 import { IExpr } from "./expressions";
 import { Operator } from "./expressions/operator";
-import { BindPattern, BlockPattern, Expression, FilterPattern, OperationExpression } from "./sparqljs";
+import { BindPattern, BlockPattern, Expression, FilterPattern, OperationExpression, PropertyPath, Triple } from "./sparqljs";
 /**
+ * @ignore
+ */
+export declare const prefixes: {
+    rdfs: string;
+    rdf: string;
+    xsd: string;
+    qb: string;
+    dc11: string;
+    dcterms: string;
+    skos: string;
+};
+/**
+ * @ignore
+ */
+export declare const labelPredicate: PropertyPath;
+/**
  * Convert [[Operator]] arguments into SPARQL.js `Expression`s
@@ -23,3 +39,3 @@ * @ignore
  */
-export declare function generateLangOptionals(binding: Variable, labelBinding: Variable, langs: string[]): BlockPattern[];
+export declare function generateLangOptionals(binding: Variable, labelBinding: Variable, predicate: Triple["predicate"], langs?: string[]): BlockPattern[];
 /**
@@ -29,13 +45,24 @@ * @ignore
 export declare function generateLangCoalesce(labelBinding: Variable, langs: string[]): BindPattern;
+export interface SerializedLiteral {
+    value: string;
+    termType: string;
+    language: string;
+    datatype: {
+        value: string;
+        termType: string;
+    };
+}
 /**
- * @ignore
+ * Serialize a Literal to a POJO.
+ *
+ * @param {Literal} lit
+ * @returns SerializedLiteral
  */
-export declare const prefixes: {
-    rdfs: string;
-    rdf: string;
-    xsd: string;
-    qb: string;
-    dc11: string;
-    dcterms: string;
-    skos: string;
-};
+export declare function literalToJSON(lit: Literal): SerializedLiteral;
+/**
+ * Deserialize a Literal from a POJO.
+ *
+ * @param {SerializedLiteral} lit
+ * @returns Literal
+ */
+export declare function literalFromJSON(lit: SerializedLiteral): Literal;

dist/node/datacube.d.ts

 import { Literal, NamedNode } from "rdf-js";
 import { Attribute, Component, Dimension, Measure } from "./components";
-import { EntryPointOptions } from "./entrypoint";
+import { BaseOptions } from "./entrypoint";
 import { Query, QueryOptions } from "./query";
@@ -20,6 +20,7 @@ /**
 }
-export interface DataCubeOptions extends EntryPointOptions {
+export interface DataCubeOptions extends BaseOptions {
     iri: NamedNode;
+    graphIri: NamedNode;
     labels?: Label[];
-    graphIri: NamedNode;
+    extraMetadata?: Map<string, any>;
 }
@@ -38,2 +39,3 @@ /**
     graphIri?: string;
+    extraMetadata: Map<string, Literal>;
     private languages;
@@ -40,0 +42,0 @@ private fetcher;

dist/node/entrypoint.d.ts

 import { NamedNode } from "rdf-js";
 import { DataCube } from "./datacube";
 import { SparqlFetcherOptions } from "./sparqlfetcher";
-export interface EntryPointOptions {
+/**
+ * @ignore
+ */
+export interface ExtraMetadatum {
+    variable: string;
+    iri: string;
+    multilang?: boolean;
+}
+export interface BaseOptions {
     languages?: string[];
     fetcher?: SparqlFetcherOptions;
 }
+export interface EntryPointOptions extends BaseOptions {
+    extraMetadata?: ExtraMetadatum[];
+}
 export declare type SerializedDataCubeEntryPoint = {
@@ -25,2 +36,3 @@ endpoint: string;
     private graphsLoaded;
+    private extraMetadata;
     /**
@@ -34,2 +46,3 @@ * A DataCubeEntryPoint queries a SPARQL endpoint and retrieves [[DataCube]]s and
      * Passed down to [[DataCube]]s and [[Query]].
+     * @param options.extraMetadata Metadata to fetch, see examples/extra-metadata.ts
      */
@@ -36,0 +49,0 @@ constructor(endpoint: string, options?: EntryPointOptions);

dist/node/query.d.ts

 import { Literal, NamedNode } from "rdf-js";
 import { Component } from "./components";
 import { DataCube } from "./datacube";
-import { EntryPointOptions } from "./entrypoint";
+import { BaseOptions } from "./entrypoint";
 import { IExpr, Operator } from "./expressions";
@@ -11,3 +11,3 @@ import { FilterPattern, SelectQuery } from "./sparqljs";
 declare type Selects = Record<string, Component>;
-export interface QueryOptions extends EntryPointOptions {
+export interface QueryOptions extends BaseOptions {
 }
@@ -14,0 +14,0 @@ /**

dist/node/queryutils.d.ts

@@ -1,6 +0,22 @@
-import { Variable } from "rdf-js";
+import { Literal, Variable } from "rdf-js";
 import { IExpr } from "./expressions";
 import { Operator } from "./expressions/operator";
-import { BindPattern, BlockPattern, Expression, FilterPattern, OperationExpression } from "./sparqljs";
+import { BindPattern, BlockPattern, Expression, FilterPattern, OperationExpression, PropertyPath, Triple } from "./sparqljs";
 /**
+ * @ignore
+ */
+export declare const prefixes: {
+    rdfs: string;
+    rdf: string;
+    xsd: string;
+    qb: string;
+    dc11: string;
+    dcterms: string;
+    skos: string;
+};
+/**
+ * @ignore
+ */
+export declare const labelPredicate: PropertyPath;
+/**
  * Convert [[Operator]] arguments into SPARQL.js `Expression`s
@@ -23,3 +39,3 @@ * @ignore
  */
-export declare function generateLangOptionals(binding: Variable, labelBinding: Variable, langs: string[]): BlockPattern[];
+export declare function generateLangOptionals(binding: Variable, labelBinding: Variable, predicate: Triple["predicate"], langs?: string[]): BlockPattern[];
 /**
@@ -29,13 +45,24 @@ * @ignore
 export declare function generateLangCoalesce(labelBinding: Variable, langs: string[]): BindPattern;
+export interface SerializedLiteral {
+    value: string;
+    termType: string;
+    language: string;
+    datatype: {
+        value: string;
+        termType: string;
+    };
+}
 /**
- * @ignore
+ * Serialize a Literal to a POJO.
+ *
+ * @param {Literal} lit
+ * @returns SerializedLiteral
  */
-export declare const prefixes: {
-    rdfs: string;
-    rdf: string;
-    xsd: string;
-    qb: string;
-    dc11: string;
-    dcterms: string;
-    skos: string;
-};
+export declare function literalToJSON(lit: Literal): SerializedLiteral;
+/**
+ * Deserialize a Literal from a POJO.
+ *
+ * @param {SerializedLiteral} lit
+ * @returns Literal
+ */
+export declare function literalFromJSON(lit: SerializedLiteral): Literal;

package.json

 {
   "name": "@zazuko/query-rdf-data-cube",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Query (or introspect) [RDF Data Cubes](https://www.w3.org/TR/vocab-data-cube/) with a JavaScript API, without writing SPARQL.",
@@ -54,15 +54,15 @@ "scripts": {
     "@types/clone": "^0.1.30",
-    "@types/jest": "^24.0.18",
+    "@types/jest": "^24.0.19",
     "@types/node-fetch": "^2.5.2",
-    "conventional-changelog-cli": "^2.0.23",
-    "coveralls": "^3.0.6",
+    "conventional-changelog-cli": "^2.0.25",
+    "coveralls": "^3.0.7",
     "fetch-vcr": "^3.0.1",
     "gh-pages": "^2.1.1",
-    "husky": "^3.0.5",
+    "husky": "^3.0.9",
     "jest": "^24.9.0",
-    "lint-staged": "^9.3.0",
+    "lint-staged": "^9.4.2",
     "prettier": "^1.18.2",
     "rimraf": "^3.0.0",
-    "rollup": "^1.21.4",
-    "rollup-plugin-typescript2": "^0.24.2",
+    "rollup": "^1.25.1",
+    "rollup-plugin-typescript2": "^0.24.3",
     "ts-jest": "^24.1.0",
@@ -73,3 +73,3 @@ "ts-node": "^8.4.1",
     "typedoc-clarity-theme": "^1.1.0",
-    "typescript": "^3.6.3"
+    "typescript": "^3.6.4"
   },
@@ -76,0 +76,0 @@ "jest": {

README.md

@@ -50,3 +50,3 @@ # [@zazuko/query-rdf-data-cube](https://github.com/zazuko/query-rdf-data-cube)
 
-See the `examples/` folder at the root of this repository.
+See the [`examples/`](https://github.com/zazuko/query-rdf-data-cube/tree/master/examples) folder at the root of this repository.
 
@@ -53,0 +53,0 @@ ## Working Locally

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

208353

increased by5.16%

Number of package files

31

increased by6.9%

Lines of code

5525

increased by5.86%

No dependency changes