@comunica/types - npm Package Compare versions

Comparing version 4.1.0 to 4.2.0

lib/IDataset.d.ts

+import type { Algebra } from 'sparqlalgebrajs';
+import type { QueryResultCardinality } from './IMetadata';
+/**
+ * Abstraction to allow grouping of metadata by dataset, in case multiple datasets
+ * expose their metadata through the same source URI and thus the same stream.
+ */
+export interface IDataset {
+    /**
+     * The unique URI of this dataset.
+     */
+    uri: string;
+    /**
+     * The URI from which this dataset was discovered.
+     */
+    source: string;
+    /**
+     * Calculate the cardinality of the given operation within this dataset.
+     * @param {Algebra.Operation} operation SPARQL algebra operation.
+     * @returns {QueryResultCardinality} Upper bound for the cardinality.
+     */
+    getCardinality: (operation: Algebra.Operation) => QueryResultCardinality | undefined;
+}

lib/IDataset.js

+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IDataset.js.map

lib/IDataset.js.map

+{"version":3,"file":"IDataset.js","sourceRoot":"","sources":["IDataset.ts"],"names":[],"mappings":"","sourcesContent":["import type { Algebra } from 'sparqlalgebrajs';\nimport type { QueryResultCardinality } from './IMetadata';\n\n/**\n * Abstraction to allow grouping of metadata by dataset, in case multiple datasets\n * expose their metadata through the same source URI and thus the same stream.\n */\nexport interface IDataset {\n  /**\n   * The unique URI of this dataset.\n   */\n  uri: string;\n  /**\n   * The URI from which this dataset was discovered.\n   */\n  source: string;\n  /**\n   * Calculate the cardinality of the given operation within this dataset.\n   * @param {Algebra.Operation} operation SPARQL algebra operation.\n   * @returns {QueryResultCardinality} Upper bound for the cardinality.\n   */\n  getCardinality: (operation: Algebra.Operation) => QueryResultCardinality | undefined;\n}\n"]}

lib/IAggregatedStore.d.ts

@@ -36,2 +36,12 @@ /// <reference types="node" />
     /**
+     * Indicate whether or not an IAggregatedStore has ended.
+     * @returns {boolean} return true if the store has ended
+     */
+    hasEnded: () => boolean;
+    /**
+     * Register a listener that will be invoked when the store has ended.
+     * @param listener A listener.
+     */
+    addEndListener: (listener: () => void) => void;
+    /**
      * Update the metadata of the base iterator, from which the aggregated store is being populated.
@@ -38,0 +48,0 @@ * @param metadata The metadata object.

lib/IAggregatedStore.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"IAggregatedStore.js","sourceRoot":"","sources":["IAggregatedStore.ts"],"names":[],"mappings":"","sourcesContent":["// eslint-disable-next-line import/no-nodejs-modules\nimport type { EventEmitter } from 'node:events';\nimport type * as RDF from '@rdfjs/types';\nimport type { AsyncIterator } from 'asynciterator';\nimport type { MetadataBindings } from './IMetadata';\n\n/**\n * A StreamingStore allows data lookup and insertion to happen in parallel.\n * Concretely, this means that `match()` calls happening before `import()` calls, will still consider those triples that\n * are inserted later, which is done by keeping the response streams of `match()` open.\n * Only when the `end()` method is invoked, all response streams will close, and the StreamingStore will be considered\n * immutable.\n *\n * WARNING: `end()` MUST be called at some point, otherwise all `match` streams will remain unended.\n */\nexport interface IAggregatedStore<Q extends RDF.BaseQuad = RDF.Quad>\n  extends RDF.Source<Q>, RDF.Sink<RDF.Stream<Q>, EventEmitter> {\n  /**\n   * If this aggregated has started processing.\n   */\n  started: boolean;\n\n  /**\n   * The sources that are indexed in this store.\n   */\n  containedSources: Set<string>;\n\n  /**\n   * If iterators created during the `match` call are still running.\n   */\n  hasRunningIterators: () => boolean;\n\n  /**\n   * Mark this store as ended.\n   *\n   * This will make sure that all running and future `match` calls will end,\n   * and all next `import` calls to this store will throw an error.\n   */\n  end: () => void;\n\n  /**\n   * Update the metadata of the base iterator, from which the aggregated store is being populated.\n   * @param metadata The metadata object.\n   * @param updateState If the metadata state of derived iterators should be immediately updated.\n   */\n  setBaseMetadata: (metadata: MetadataBindings, updateStates: boolean) => void;\n\n  /**\n   * Register a listener that will be invoked when a new iterator is returned from match().\n   * @param listener A listener.\n   */\n  addIteratorCreatedListener: (listener: () => void) => void;\n  /**\n   * Remove the given iterator creation listener.\n   * @param listener A listener.\n   */\n  removeIteratorCreatedListener: (listener: () => void) => void;\n\n  match: (\n    subject?: RDF.Term | null,\n    predicate?: RDF.Term | null,\n    object?: RDF.Term | null,\n    graph?: RDF.Term | null,\n  ) => AsyncIterator<Q>;\n}\n"]}
+{"version":3,"file":"IAggregatedStore.js","sourceRoot":"","sources":["IAggregatedStore.ts"],"names":[],"mappings":"","sourcesContent":["// eslint-disable-next-line import/no-nodejs-modules\nimport type { EventEmitter } from 'node:events';\nimport type * as RDF from '@rdfjs/types';\nimport type { AsyncIterator } from 'asynciterator';\nimport type { MetadataBindings } from './IMetadata';\n\n/**\n * A StreamingStore allows data lookup and insertion to happen in parallel.\n * Concretely, this means that `match()` calls happening before `import()` calls, will still consider those triples that\n * are inserted later, which is done by keeping the response streams of `match()` open.\n * Only when the `end()` method is invoked, all response streams will close, and the StreamingStore will be considered\n * immutable.\n *\n * WARNING: `end()` MUST be called at some point, otherwise all `match` streams will remain unended.\n */\nexport interface IAggregatedStore<Q extends RDF.BaseQuad = RDF.Quad>\n  extends RDF.Source<Q>, RDF.Sink<RDF.Stream<Q>, EventEmitter> {\n  /**\n   * If this aggregated has started processing.\n   */\n  started: boolean;\n\n  /**\n   * The sources that are indexed in this store.\n   */\n  containedSources: Set<string>;\n\n  /**\n   * If iterators created during the `match` call are still running.\n   */\n  hasRunningIterators: () => boolean;\n\n  /**\n   * Mark this store as ended.\n   *\n   * This will make sure that all running and future `match` calls will end,\n   * and all next `import` calls to this store will throw an error.\n   */\n  end: () => void;\n\n  /**\n   * Indicate whether or not an IAggregatedStore has ended.\n   * @returns {boolean} return true if the store has ended\n   */\n  hasEnded: () => boolean;\n\n  /**\n   * Register a listener that will be invoked when the store has ended.\n   * @param listener A listener.\n   */\n  addEndListener: (listener: () => void) => void;\n\n  /**\n   * Update the metadata of the base iterator, from which the aggregated store is being populated.\n   * @param metadata The metadata object.\n   * @param updateState If the metadata state of derived iterators should be immediately updated.\n   */\n  setBaseMetadata: (metadata: MetadataBindings, updateStates: boolean) => void;\n\n  /**\n   * Register a listener that will be invoked when a new iterator is returned from match().\n   * @param listener A listener.\n   */\n  addIteratorCreatedListener: (listener: () => void) => void;\n  /**\n   * Remove the given iterator creation listener.\n   * @param listener A listener.\n   */\n  removeIteratorCreatedListener: (listener: () => void) => void;\n\n  match: (\n    subject?: RDF.Term | null,\n    predicate?: RDF.Term | null,\n    object?: RDF.Term | null,\n    graph?: RDF.Term | null,\n  ) => AsyncIterator<Q>;\n}\n"]}

lib/index.d.ts

@@ -7,2 +7,3 @@ export * from './Bindings';
 export * from './IDataDestination';
+export * from './IDataset';
 export * from './IJoinEntry';
@@ -9,0 +10,0 @@ export * from './IMetadata';

lib/index.js

@@ -23,2 +23,3 @@ "use strict";
 __exportStar(require("./IDataDestination"), exports);
+__exportStar(require("./IDataset"), exports);
 __exportStar(require("./IJoinEntry"), exports);
@@ -25,0 +26,0 @@ __exportStar(require("./IMetadata"), exports);

lib/index.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wDAAsC;AACtC,mDAAiC;AACjC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAA2C;AAC3C,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAC/B,0DAAwC;AACxC,iDAA+B;AAC/B,8DAA4C;AAC5C,kEAAgD;AAChD,8DAA4C;AAC5C,0CAAwB;AACxB,2CAAyB;AACzB,wDAAsC","sourcesContent":["export * from './Bindings';\nexport * from './ComunicaDataFactory';\nexport * from './IActionContext';\nexport * from './IAggregatedStore';\nexport * from './ICliArgsHandler';\nexport * from './IDataDestination';\nexport * from './IJoinEntry';\nexport * from './IMetadata';\nexport * from './IPhysicalQueryPlanLogger';\nexport * from './IProxyHandler';\nexport * from './IQueryContext';\nexport * from './IQueryEngine';\nexport * from './IQueryOperationResult';\nexport * from './IQuerySource';\nexport * from './statistics/IStatisticBase';\nexport * from './statistics/IDiscoverEventData';\nexport * from './statistics/IPartialResult';\nexport * from './ILink';\nexport * from './Logger';\nexport * from './ExpressionEvaluator';\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,6CAA2B;AAC3B,wDAAsC;AACtC,mDAAiC;AACjC,qDAAmC;AACnC,oDAAkC;AAClC,qDAAmC;AACnC,6CAA2B;AAC3B,+CAA6B;AAC7B,8CAA4B;AAC5B,6DAA2C;AAC3C,kDAAgC;AAChC,kDAAgC;AAChC,iDAA+B;AAC/B,0DAAwC;AACxC,iDAA+B;AAC/B,8DAA4C;AAC5C,kEAAgD;AAChD,8DAA4C;AAC5C,0CAAwB;AACxB,2CAAyB;AACzB,wDAAsC","sourcesContent":["export * from './Bindings';\nexport * from './ComunicaDataFactory';\nexport * from './IActionContext';\nexport * from './IAggregatedStore';\nexport * from './ICliArgsHandler';\nexport * from './IDataDestination';\nexport * from './IDataset';\nexport * from './IJoinEntry';\nexport * from './IMetadata';\nexport * from './IPhysicalQueryPlanLogger';\nexport * from './IProxyHandler';\nexport * from './IQueryContext';\nexport * from './IQueryEngine';\nexport * from './IQueryOperationResult';\nexport * from './IQuerySource';\nexport * from './statistics/IStatisticBase';\nexport * from './statistics/IDiscoverEventData';\nexport * from './statistics/IPartialResult';\nexport * from './ILink';\nexport * from './Logger';\nexport * from './ExpressionEvaluator';\n"]}

lib/IQueryContext.d.ts

@@ -40,2 +40,3 @@ import type * as RDF from '@rdfjs/types';
     recoverBrokenLinks?: boolean;
+    distinctConstruct?: boolean;
 }

lib/IQueryContext.js.map

@@ -1,1 +0,1 @@
-{"version":3,"file":"IQueryContext.js","sourceRoot":"","sources":["IQueryContext.ts"],"names":[],"mappings":"","sourcesContent":["import type * as RDF from '@rdfjs/types';\nimport type { FunctionArgumentsCache } from './ExpressionEvaluator';\nimport type { IDataDestination } from './IDataDestination';\nimport type { IProxyHandler } from './IProxyHandler';\nimport type { SourceType } from './IQueryEngine';\nimport type { QueryExplainMode } from './IQueryOperationResult';\nimport type { Logger } from './Logger';\n\n/**\n * Query context when a string-based query was passed.\n */\nexport type QueryStringContext = RDF.QueryStringContext & RDF.QuerySourceContext<SourceType> & IQueryContextCommon;\n/**\n * Query context when an algebra-based query was passed.\n */\nexport type QueryAlgebraContext = RDF.QueryAlgebraContext & RDF.QuerySourceContext<SourceType> & IQueryContextCommon;\n\n/**\n * Common query context interface\n */\nexport interface IQueryContextCommon {\n  // Types of these entries should be aligned with contextKeyShortcuts in ActorInitQueryBase\n  // and Keys in @comunica/context-entries\n\n  // Inherited from RDF.QueryStringContext: sources\n  destination?: IDataDestination;\n  initialBindings?: RDF.Bindings;\n  // Inherited from RDF.QueryStringContext: queryFormat?: string;\n  // Inherited from RDF.QueryStringContext: baseIRI?: string;\n  log?: Logger;\n  datetime?: Date;\n  // Inherited from RDF.QueryStringContext: queryTimestamp?: Date;\n  httpProxyHandler?: IProxyHandler;\n  lenient?: boolean;\n  httpIncludeCredentials?: boolean;\n  httpAuth?: string;\n  httpTimeout?: number;\n  httpBodyTimeout?: boolean;\n  httpRetryCount?: number;\n  httpRetryDelayFallback?: number;\n  httpRetryDelayLimit?: number;\n  fetch?: typeof fetch;\n  readOnly?: boolean;\n  extensionFunctionCreator?: (functionNamedNode: RDF.NamedNode)\n  => ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined;\n  functionArgumentsCache?: FunctionArgumentsCache;\n  extensionFunctions?: Record<string, (args: RDF.Term[]) => Promise<RDF.Term>>;\n  explain?: QueryExplainMode;\n  recoverBrokenLinks?: boolean;\n}\n"]}
+{"version":3,"file":"IQueryContext.js","sourceRoot":"","sources":["IQueryContext.ts"],"names":[],"mappings":"","sourcesContent":["import type * as RDF from '@rdfjs/types';\nimport type { FunctionArgumentsCache } from './ExpressionEvaluator';\nimport type { IDataDestination } from './IDataDestination';\nimport type { IProxyHandler } from './IProxyHandler';\nimport type { SourceType } from './IQueryEngine';\nimport type { QueryExplainMode } from './IQueryOperationResult';\nimport type { Logger } from './Logger';\n\n/**\n * Query context when a string-based query was passed.\n */\nexport type QueryStringContext = RDF.QueryStringContext & RDF.QuerySourceContext<SourceType> & IQueryContextCommon;\n/**\n * Query context when an algebra-based query was passed.\n */\nexport type QueryAlgebraContext = RDF.QueryAlgebraContext & RDF.QuerySourceContext<SourceType> & IQueryContextCommon;\n\n/**\n * Common query context interface\n */\nexport interface IQueryContextCommon {\n  // Types of these entries should be aligned with contextKeyShortcuts in ActorInitQueryBase\n  // and Keys in @comunica/context-entries\n\n  // Inherited from RDF.QueryStringContext: sources\n  destination?: IDataDestination;\n  initialBindings?: RDF.Bindings;\n  // Inherited from RDF.QueryStringContext: queryFormat?: string;\n  // Inherited from RDF.QueryStringContext: baseIRI?: string;\n  log?: Logger;\n  datetime?: Date;\n  // Inherited from RDF.QueryStringContext: queryTimestamp?: Date;\n  httpProxyHandler?: IProxyHandler;\n  lenient?: boolean;\n  httpIncludeCredentials?: boolean;\n  httpAuth?: string;\n  httpTimeout?: number;\n  httpBodyTimeout?: boolean;\n  httpRetryCount?: number;\n  httpRetryDelayFallback?: number;\n  httpRetryDelayLimit?: number;\n  fetch?: typeof fetch;\n  readOnly?: boolean;\n  extensionFunctionCreator?: (functionNamedNode: RDF.NamedNode)\n  => ((args: RDF.Term[]) => Promise<RDF.Term>) | undefined;\n  functionArgumentsCache?: FunctionArgumentsCache;\n  extensionFunctions?: Record<string, (args: RDF.Term[]) => Promise<RDF.Term>>;\n  explain?: QueryExplainMode;\n  recoverBrokenLinks?: boolean;\n  distinctConstruct?: boolean;\n}\n"]}

package.json

 {
   "name": "@comunica/types",
-  "version": "4.1.0",
+  "version": "4.2.0",
   "description": "Typings module for Comunica",
@@ -51,3 +51,3 @@ "lsd:module": true,
   },
-  "gitHead": "711446473d18f5fd47aa1a67e6c23582234221ec"
+  "gitHead": "94e1eacab069551590cc250074b36bce08720c4c"
 }

No alert changes

Improved metrics

Total package byte prevSize

164454

2.71%

Number of package files

88

4.76%

Lines of code

1328

2.87%

No dependency changes