@lde/sparql-importer 0.4.1 → 1.0.0

package/dist/index.d.ts

@@ -1,16 +1,29 @@
-import { Dataset, Distribution } from '@lde/dataset';
+import { Distribution } from '@lde/dataset';
+import { Downloader } from '@lde/distribution-downloader';
+import { TaskRunner } from '@lde/task-runner';
+/** Store-agnostic options shared by all {@link Importer} implementations. */
+export interface ImporterOptions {
+    taskRunner: TaskRunner<unknown>;
+    downloader?: Downloader;
+    /** Cache indices and skip re-indexing when source data is unchanged. @default true */
+    cacheIndex?: boolean;
+}
 /**
- * An Importer takes a {@link Dataset}, selects a suitable {@link Distribution}
+ * An Importer selects a suitable {@link Distribution} from the given candidates
  * and imports it to a SPARQL server.
  *
- * This assumes that all Distributions of the Dataset are roughly equivalent:
+ * This assumes that all Distributions of a dataset are roughly equivalent:
  * https://docs.nde.nl/requirements-datasets/#dataset-distributions.
  */
 export interface Importer {
     /**
-     * Import a {@link Dataset} to a SPARQL server.
+     * Import one of the given {@link Distribution}s to a SPARQL server.
+     *
+     * The importer picks the first distribution whose format it supports,
+     * downloads it, and indexes it. Returns {@link NotSupported} when none of
+     * the distributions use a supported format.
      */
-    import(dataset: Dataset): Promise<NotSupported | ImportFailed | ImportSuccessful>;
+    import(distributions: Distribution[]): Promise<NotSupported | ImportFailed | ImportSuccessful>;
 }
 export declare class ImportSuccessful {
     readonly distribution: Distribution;

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAErD;;;;;;GAMG;AAEH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,MAAM,CACJ,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,YAAY,GAAG,YAAY,GAAG,gBAAgB,CAAC,CAAC;CAC5D;AAOD,qBAAa,gBAAgB;aAET,YAAY,EAAE,YAAY;aAC1B,UAAU,CAAC,EAAE,MAAM;aACnB,WAAW,CAAC,EAAE,MAAM;gBAFpB,YAAY,EAAE,YAAY,EAC1B,UAAU,CAAC,EAAE,MAAM,YAAA,EACnB,WAAW,CAAC,EAAE,MAAM,YAAA;CAEvC;AAED,qBAAa,YAAY;aAEL,YAAY,EAAE,YAAY;aAC1B,KAAK,EAAE,MAAM;gBADb,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,MAAM;CAEhC;AAED,qBAAa,YAAY;aACK,YAAY,CAAC,EAAE,YAAY;gBAA3B,YAAY,CAAC,EAAE,YAAY,YAAA;CACxD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,EAAE,UAAU,EAAE,MAAM,8BAA8B,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,6EAA6E;AAC7E,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC;IAChC,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,sFAAsF;IACtF,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;;;OAMG;IACH,MAAM,CACJ,aAAa,EAAE,YAAY,EAAE,GAC5B,OAAO,CAAC,YAAY,GAAG,YAAY,GAAG,gBAAgB,CAAC,CAAC;CAC5D;AAED,qBAAa,gBAAgB;aAET,YAAY,EAAE,YAAY;aAC1B,UAAU,CAAC,EAAE,MAAM;aACnB,WAAW,CAAC,EAAE,MAAM;gBAFpB,YAAY,EAAE,YAAY,EAC1B,UAAU,CAAC,EAAE,MAAM,YAAA,EACnB,WAAW,CAAC,EAAE,MAAM,YAAA;CAEvC;AAED,qBAAa,YAAY;aAEL,YAAY,EAAE,YAAY;aAC1B,KAAK,EAAE,MAAM;gBADb,YAAY,EAAE,YAAY,EAC1B,KAAK,EAAE,MAAM;CAEhC;AAED,qBAAa,YAAY;aACK,YAAY,CAAC,EAAE,YAAY;gBAA3B,YAAY,CAAC,EAAE,YAAY,YAAA;CACxD"}

package/dist/index.js

@@ -1,7 +1,3 @@
-// interface Events {
-//   imported: [statements: number];
-//   end: [statements: number];
-// }
 export class ImportSuccessful {
     distribution;
     identifier;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lde/sparql-importer",
-  "version": "0.4.1",
+  "version": "1.0.0",
   "repository": {
     "url": "git+https://github.com/ldelements/lde.git",
     "directory": "packages/sparql-importer"
@@ -24,6 +24,8 @@
   ],
   "dependencies": {
     "@lde/dataset": "0.7.2",
+    "@lde/distribution-downloader": "0.5.3",
+    "@lde/task-runner": "0.2.10",
     "tslib": "^2.3.0"
   }
 }