@static-suite/static-suite-data-server 0.0.11 → 0.0.12

package/README.md

@@ -163,6 +163,52 @@ const results = store.data
   .items.filter(article => article.data.content.title.includes('foo'));
 ```
 
+### Getting a subset of files via HTTP
+
+It is also possible to get a subset of files via HTTP, querying the HTTP endpoint `/subset` with the following options passed as query strings:
+
+- `dir`: optional base directory to filter files. It requires a trailing slash, but not a leading slash, e.g.- `en/entity/node/article/`
+- `variant`: Optional name of a variant file.
+  - Use `_main` to obtain the default variant.
+  - Use any other string, e.g.- `card`, to obtain the card variant.
+  - Use "null" to avoid searching for any variant.
+  - Defaults to `_main`.
+- `ext`: Optional file extension, without dots. Defaults to `json`.
+- `recursive`: Optional flag to search for files recursively. Defaults to `true`.
+- `as`: Optional flag to get the subset as filenames or URLs. Possible values: `filename` or `url`. Defaults to `filename`.
+
+#### Return value
+
+An array of filenames in the subset.
+
+```http
+// Get a subset of all nodes in English with "json" extension.
+http://localhost:57471/subset?dir=en/entity/node/
+
+// Return value
+[
+  "en/entity/node/article/1.json",
+  "en/entity/node/page/4.json",
+  "en/entity/node/gallery/6.json",
+  ...
+]
+```
+
+An array of URLs in the subset.
+
+```http
+// Get a subset of all nodes in English with "json" extension.
+http://localhost:57471/subset?dir=en/entity/node/&as=url
+
+// Return value
+[
+  "/path/to/public/url-1",
+  "/path/to/public/url-2",
+  "/path/to/public/url-3",
+  ...
+]
+```
+
 ### Indexes
 
 Apart from the main data Map, files are also automatically stored in two more maps (indexes) to be able to access them faster:

package/dist/http/README.md

@@ -163,6 +163,52 @@ const results = store.data
   .items.filter(article => article.data.content.title.includes('foo'));
 ```
 
+### Getting a subset of files via HTTP
+
+It is also possible to get a subset of files via HTTP, querying the HTTP endpoint `/subset` with the following options passed as query strings:
+
+- `dir`: optional base directory to filter files. It requires a trailing slash, but not a leading slash, e.g.- `en/entity/node/article/`
+- `variant`: Optional name of a variant file.
+  - Use `_main` to obtain the default variant.
+  - Use any other string, e.g.- `card`, to obtain the card variant.
+  - Use "null" to avoid searching for any variant.
+  - Defaults to `_main`.
+- `ext`: Optional file extension, without dots. Defaults to `json`.
+- `recursive`: Optional flag to search for files recursively. Defaults to `true`.
+- `as`: Optional flag to get the subset as filenames or URLs. Possible values: `filename` or `url`. Defaults to `filename`.
+
+#### Return value
+
+An array of filenames in the subset.
+
+```http
+// Get a subset of all nodes in English with "json" extension.
+http://localhost:57471/subset?dir=en/entity/node/
+
+// Return value
+[
+  "en/entity/node/article/1.json",
+  "en/entity/node/page/4.json",
+  "en/entity/node/gallery/6.json",
+  ...
+]
+```
+
+An array of URLs in the subset.
+
+```http
+// Get a subset of all nodes in English with "json" extension.
+http://localhost:57471/subset?dir=en/entity/node/&as=url
+
+// Return value
+[
+  "/path/to/public/url-1",
+  "/path/to/public/url-2",
+  "/path/to/public/url-3",
+  ...
+]
+```
+
 ### Indexes
 
 Apart from the main data Map, files are also automatically stored in two more maps (indexes) to be able to access them faster:

package/dist/http/routes/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/http/routes/index.ts"],"names":[],"mappings":"AAkCA,QAAA,MAAM,MAAM,4CAAW,CAAC;AAgCxB,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/http/routes/index.ts"],"names":[],"mappings":"AAmCA,QAAA,MAAM,MAAM,4CAAW,CAAC;AAiCxB,eAAe,MAAM,CAAC"}

package/dist/http/routes/index.js

@@ -12,6 +12,7 @@ const dump_1 = require("./dump");
 const dependency_1 = require("./dependency");
 const indexUrl_1 = require("./indexUrl");
 const indexUUID_1 = require("./indexUUID");
+const subset_1 = require("./subset");
 const routes = (0, express_1.Router)();
 routes.get('/', home_1.home);
 routes.get('/docs', docs_1.docs);
@@ -42,4 +43,5 @@ routes.get('/dependency', dependency_1.dependencyIndex);
 routes.get(['/data/*', '/data'], data_1.data);
 routes.get(['/index/url/*', '/index/url'], indexUrl_1.indexUrl);
 routes.get(['/index/uuid/*', '/index/uuid'], indexUUID_1.indexUUID);
+routes.get('/subset', subset_1.subset);
 exports.default = routes;

package/dist/http/routes/subset.d.ts

@@ -0,0 +1,4 @@
+import { Request, Response } from 'express';
+declare const subset: (req: Request, res: Response) => void;
+export { subset };
+//# sourceMappingURL=subset.d.ts.map

package/dist/http/routes/subset.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subset.d.ts","sourceRoot":"","sources":["../../../src/http/routes/subset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAK5C,QAAA,MAAM,MAAM,QAAS,OAAO,OAAO,QAAQ,KAAG,IAmC7C,CAAC;AAEF,OAAO,EAAE,MAAM,EAAE,CAAC"}

package/dist/http/routes/subset.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.subset = void 0;
+const store_1 = require("../../lib/store");
+const dataDir_1 = require("../../lib/store/dataDir");
+const subset = (req, res) => {
+    dataDir_1.dataDirManager.update();
+    const options = {};
+    if (req.query.dir) {
+        options.dir = req.query.dir;
+    }
+    if (req.query.variant) {
+        if (req.query.variant === 'null') {
+            options.variant = undefined;
+        }
+        else {
+            options.variant = req.query.variant;
+        }
+    }
+    if (req.query.ext) {
+        options.ext = req.query.ext;
+    }
+    if (req.query.recursive) {
+        options.recursive = req.query.recursive === 'true';
+    }
+    const returnedSubset = store_1.store.data.subset(options);
+    let result;
+    if (req.query.as === 'url') {
+        result = returnedSubset.items
+            .map(item => item.data?.content?.url?.path)
+            .filter(path => !!path);
+    }
+    else {
+        result = returnedSubset.filenames;
+    }
+    res.status(200);
+    res.set({
+        'Content-Type': 'application/json',
+    });
+    res.send(result);
+};
+exports.subset = subset;

package/dist/lib/store/store.types.d.ts

@@ -116,7 +116,7 @@ export type StoreSubsetOptions = {
      * Use null to avoid searching for any variant.
      * Defaults to '_main'.
      */
-    variant?: string;
+    variant?: string | null;
     /**
      * Optional file extension, without dots. Defaults to 'json'.
      */

package/dist/lib/store/store.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"store.types.d.ts","sourceRoot":"","sources":["../../../src/lib/store/store.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;OASG;IACH,GAAG,CAAC,gBAAgB,EAAE,MAAM,GAAG,YAAY,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;IAEnC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;IAEnC;;;;;OAKG;IACH,aAAa,IAAI,YAAY,CAAC;IAE9B;;;;;;;;OAQG;IACH,uBAAuB,CACrB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,GAAG,GACf,YAAY,CAAC;IAEhB;;;;OAIG;IACH,KAAK,IAAI,YAAY,CAAC;CACvB,CAAC"}
+{"version":3,"file":"store.types.d.ts","sourceRoot":"","sources":["../../../src/lib/store/store.types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAS,CAAC,CAAC,EAAE,CAAC,CAAE,SAAQ,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;IAChD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACH,MAAM,CAAC,OAAO,EAAE,kBAAkB,GAAG,WAAW,CAAC;CAClD;AAED;;GAEG;AACH,MAAM,MAAM,KAAK,GAAG;IAClB;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;OAMG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,IAAI,EAAE,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE7B;;OAEG;IACH,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE;QACL;;WAEG;QACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEtB;;WAEG;QACH,IAAI,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAEvB;;WAEG;QACH,MAAM,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC1B,CAAC;CACH,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;;;;OAKG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,GAAG,EAAE,GAAG,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEtB;;OAEG;IACH,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;;;;;OASG;IACH,GAAG,CAAC,gBAAgB,EAAE,MAAM,GAAG,YAAY,CAAC;IAE5C;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;IAEnC;;;;;;;;;OASG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,YAAY,CAAC;IAEnC;;;;;OAKG;IACH,aAAa,IAAI,YAAY,CAAC;IAE9B;;;;;;;;OAQG;IACH,uBAAuB,CACrB,gBAAgB,EAAE,MAAM,EACxB,WAAW,EAAE,GAAG,GACf,YAAY,CAAC;IAEhB;;;;OAIG;IACH,KAAK,IAAI,YAAY,CAAC;CACvB,CAAC"}

package/dist/static-suite-data-server.d.ts

@@ -435,7 +435,7 @@ declare type StoreSubsetOptions = {
      * Use null to avoid searching for any variant.
      * Defaults to '_main'.
      */
-    variant?: string;
+    variant?: string | null;
     /**
      * Optional file extension, without dots. Defaults to 'json'.
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@static-suite/static-suite-data-server",
-  "version": "0.0.11",
+  "version": "0.0.12",
   "description": "A flexible, fast and developer friendly Data Server for Static Suite",
   "main": "./dist/lib/index.js",
   "typings": "./dist/lib/index.d.ts",

package/src/http/routes/index.ts

@@ -31,6 +31,7 @@ import {
 } from './dependency';
 import { indexUrl } from './indexUrl';
 import { indexUUID } from './indexUUID';
+import { subset } from './subset';
 
 const routes = Router();
 
@@ -63,5 +64,6 @@ routes.get('/dependency', dependencyIndex);
 routes.get(['/data/*', '/data'], data);
 routes.get(['/index/url/*', '/index/url'], indexUrl);
 routes.get(['/index/uuid/*', '/index/uuid'], indexUUID);
+routes.get('/subset', subset);
 
 export default routes;

package/src/http/routes/subset.ts

@@ -0,0 +1,43 @@
+import { Request, Response } from 'express';
+import { StoreSubsetOptions } from 'lib/store/store.types';
+import { store } from '../../lib/store';
+import { dataDirManager } from '../../lib/store/dataDir';
+
+const subset = (req: Request, res: Response): void => {
+  dataDirManager.update();
+  const options: StoreSubsetOptions = {};
+  if (req.query.dir) {
+    options.dir = req.query.dir as string;
+  }
+  if (req.query.variant) {
+    if (req.query.variant === 'null') {
+      options.variant = undefined;
+    } else {
+      options.variant = req.query.variant as string;
+    }
+  }
+  if (req.query.ext) {
+    options.ext = req.query.ext as string;
+  }
+  if (req.query.recursive) {
+    options.recursive = req.query.recursive === 'true';
+  }
+
+  const returnedSubset = store.data.subset(options);
+  let result;
+  if (req.query.as === 'url') {
+    result = returnedSubset.items
+      .map(item => item.data?.content?.url?.path)
+      .filter(path => !!path);
+  } else {
+    result = returnedSubset.filenames;
+  }
+
+  res.status(200);
+  res.set({
+    'Content-Type': 'application/json',
+  });
+  res.send(result);
+};
+
+export { subset };

package/src/lib/store/store.types.ts

@@ -125,7 +125,7 @@ export type StoreSubsetOptions = {
    * Use null to avoid searching for any variant.
    * Defaults to '_main'.
    */
-  variant?: string;
+  variant?: string | null;
 
   /**
    * Optional file extension, without dots. Defaults to 'json'.