@static-suite/static-suite-data-server 0.0.22 → 0.0.24

package/.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
 yarn build

package/README.md

@@ -8,6 +8,55 @@ A flexible, fast and developer friendly Data Server for [Static Suite](https://w
 
 Data Server supports static JSON includes (`entityInclude`, `configInclude`, `localeInclude` and `customInclude`) and the dynamic `queryInclude`, keeping track of the relationships between includes and data: when a file changes, it knows which other files should also change, thus enabling _incremental builds_ for any kind of SSG (Gatsby, Next.js, etc).
 
+- [Static Suite Data Server](#static-suite-data-server)
+  - [Options](#options)
+  - [Options from file.](#options-from-file)
+  - [Usage](#usage)
+    - [SSG develop/build phase](#ssg-developbuild-phase)
+    - [Previewing a content from Drupal](#previewing-a-content-from-drupal)
+    - [Developing/debugging queries on a local environment](#developingdebugging-queries-on-a-local-environment)
+  - [Data structure](#data-structure)
+    - [Store internal structure](#store-internal-structure)
+    - [Getting a file](#getting-a-file)
+    - [Getting a subset of files](#getting-a-subset-of-files)
+      - [Subset options](#subset-options)
+      - [Return value](#return-value)
+    - [Getting a subset of files via HTTP](#getting-a-subset-of-files-via-http)
+      - [Return value](#return-value-1)
+    - [Indexes](#indexes)
+      - [Custom indexes](#custom-indexes)
+  - [Queries](#queries)
+  - [Hooks](#hooks)
+    - [Available hooks](#available-hooks)
+      - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
+      - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
+      - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
+      - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
+      - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
+      - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
+      - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
+      - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
+    - [Hook example](#hook-example)
+      - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
+      - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
+  - [Tasks](#tasks)
+  - [Dumps](#dumps)
+  - [Dependency tags](#dependency-tags)
+    - [Dependency tagger](#dependency-tagger)
+      - [`setDependency(tag: string, dependsOnTags: string[]): void`](#setdependencytag-string-dependsontags-string-void)
+      - [`addDependency(tag: string, dependsOnTags: string[]): void`](#adddependencytag-string-dependsontags-string-void)
+      - [`deleteDependency(tag: string, dependsOnTags?: string[]): void`](#deletedependencytag-string-dependsontags-string-void)
+      - [`invalidateTags(tags: string[]): void`](#invalidatetagstags-string-void)
+    - [Dependency tags example](#dependency-tags-example)
+      - [`File taxonomy.hook.js`](#file-taxonomyhookjs-1)
+      - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs-1)
+  - [Run modes](#run-modes)
+    - [Dev run mode](#dev-run-mode)
+    - [Prod run mode](#prod-run-mode)
+
 ## Options
 
 - `dataDir` / `--data-dir`: path to the directory where data from Static Suite is stored. Required.

package/__mocks__/clear-module.js

@@ -1,4 +1,5 @@
-module.exports = moduleId => {
+/* eslint-disable no-undef */
+module.exports = () => {
   // Jest completely takes over the require system for the
   // code under test. Therefore, it does not implement require.cache.
   // Until that problem is fixed, we must reset all modules

package/dist/bin/serve.js

@@ -1,6 +1,5 @@
 #!/usr/bin/env node
 "use strict";
-/* eslint-disable import/first */
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/http/README.md

@@ -8,6 +8,55 @@ A flexible, fast and developer friendly Data Server for [Static Suite](https://w
 
 Data Server supports static JSON includes (`entityInclude`, `configInclude`, `localeInclude` and `customInclude`) and the dynamic `queryInclude`, keeping track of the relationships between includes and data: when a file changes, it knows which other files should also change, thus enabling _incremental builds_ for any kind of SSG (Gatsby, Next.js, etc).
 
+- [Static Suite Data Server](#static-suite-data-server)
+  - [Options](#options)
+  - [Options from file.](#options-from-file)
+  - [Usage](#usage)
+    - [SSG develop/build phase](#ssg-developbuild-phase)
+    - [Previewing a content from Drupal](#previewing-a-content-from-drupal)
+    - [Developing/debugging queries on a local environment](#developingdebugging-queries-on-a-local-environment)
+  - [Data structure](#data-structure)
+    - [Store internal structure](#store-internal-structure)
+    - [Getting a file](#getting-a-file)
+    - [Getting a subset of files](#getting-a-subset-of-files)
+      - [Subset options](#subset-options)
+      - [Return value](#return-value)
+    - [Getting a subset of files via HTTP](#getting-a-subset-of-files-via-http)
+      - [Return value](#return-value-1)
+    - [Indexes](#indexes)
+      - [Custom indexes](#custom-indexes)
+  - [Queries](#queries)
+  - [Hooks](#hooks)
+    - [Available hooks](#available-hooks)
+      - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
+      - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
+      - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
+      - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
+      - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
+      - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
+      - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
+      - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
+      - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
+    - [Hook example](#hook-example)
+      - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
+      - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
+  - [Tasks](#tasks)
+  - [Dumps](#dumps)
+  - [Dependency tags](#dependency-tags)
+    - [Dependency tagger](#dependency-tagger)
+      - [`setDependency(tag: string, dependsOnTags: string[]): void`](#setdependencytag-string-dependsontags-string-void)
+      - [`addDependency(tag: string, dependsOnTags: string[]): void`](#adddependencytag-string-dependsontags-string-void)
+      - [`deleteDependency(tag: string, dependsOnTags?: string[]): void`](#deletedependencytag-string-dependsontags-string-void)
+      - [`invalidateTags(tags: string[]): void`](#invalidatetagstags-string-void)
+    - [Dependency tags example](#dependency-tags-example)
+      - [`File taxonomy.hook.js`](#file-taxonomyhookjs-1)
+      - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs-1)
+  - [Run modes](#run-modes)
+    - [Dev run mode](#dev-run-mode)
+    - [Prod run mode](#prod-run-mode)
+
 ## Options
 
 - `dataDir` / `--data-dir`: path to the directory where data from Static Suite is stored. Required.