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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +49 -0
  2. package/dist/http/README.md +49 -0
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -8,6 +8,55 @@ A flexible, fast and developer friendly Data Server for [Static Suite](https://w
8
8
 
9
9
  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).
10
10
 
11
+ - [Static Suite Data Server](#static-suite-data-server)
12
+ - [Options](#options)
13
+ - [Options from file.](#options-from-file)
14
+ - [Usage](#usage)
15
+ - [SSG develop/build phase](#ssg-developbuild-phase)
16
+ - [Previewing a content from Drupal](#previewing-a-content-from-drupal)
17
+ - [Developing/debugging queries on a local environment](#developingdebugging-queries-on-a-local-environment)
18
+ - [Data structure](#data-structure)
19
+ - [Store internal structure](#store-internal-structure)
20
+ - [Getting a file](#getting-a-file)
21
+ - [Getting a subset of files](#getting-a-subset-of-files)
22
+ - [Subset options](#subset-options)
23
+ - [Return value](#return-value)
24
+ - [Getting a subset of files via HTTP](#getting-a-subset-of-files-via-http)
25
+ - [Return value](#return-value-1)
26
+ - [Indexes](#indexes)
27
+ - [Custom indexes](#custom-indexes)
28
+ - [Queries](#queries)
29
+ - [Hooks](#hooks)
30
+ - [Available hooks](#available-hooks)
31
+ - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
32
+ - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
33
+ - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
+ - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
+ - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
36
+ - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
37
+ - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
+ - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
+ - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
+ - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
41
+ - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
42
+ - [Hook example](#hook-example)
43
+ - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
44
+ - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
45
+ - [Tasks](#tasks)
46
+ - [Dumps](#dumps)
47
+ - [Dependency tags](#dependency-tags)
48
+ - [Dependency tagger](#dependency-tagger)
49
+ - [`setDependency(tag: string, dependsOnTags: string[]): void`](#setdependencytag-string-dependsontags-string-void)
50
+ - [`addDependency(tag: string, dependsOnTags: string[]): void`](#adddependencytag-string-dependsontags-string-void)
51
+ - [`deleteDependency(tag: string, dependsOnTags?: string[]): void`](#deletedependencytag-string-dependsontags-string-void)
52
+ - [`invalidateTags(tags: string[]): void`](#invalidatetagstags-string-void)
53
+ - [Dependency tags example](#dependency-tags-example)
54
+ - [`File taxonomy.hook.js`](#file-taxonomyhookjs-1)
55
+ - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs-1)
56
+ - [Run modes](#run-modes)
57
+ - [Dev run mode](#dev-run-mode)
58
+ - [Prod run mode](#prod-run-mode)
59
+
11
60
  ## Options
12
61
 
13
62
  - `dataDir` / `--data-dir`: path to the directory where data from Static Suite is stored. Required.
package/dist/http/README.md CHANGED
@@ -8,6 +8,55 @@ A flexible, fast and developer friendly Data Server for [Static Suite](https://w
8
8
 
9
9
  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).
10
10
 
11
+ - [Static Suite Data Server](#static-suite-data-server)
12
+ - [Options](#options)
13
+ - [Options from file.](#options-from-file)
14
+ - [Usage](#usage)
15
+ - [SSG develop/build phase](#ssg-developbuild-phase)
16
+ - [Previewing a content from Drupal](#previewing-a-content-from-drupal)
17
+ - [Developing/debugging queries on a local environment](#developingdebugging-queries-on-a-local-environment)
18
+ - [Data structure](#data-structure)
19
+ - [Store internal structure](#store-internal-structure)
20
+ - [Getting a file](#getting-a-file)
21
+ - [Getting a subset of files](#getting-a-subset-of-files)
22
+ - [Subset options](#subset-options)
23
+ - [Return value](#return-value)
24
+ - [Getting a subset of files via HTTP](#getting-a-subset-of-files-via-http)
25
+ - [Return value](#return-value-1)
26
+ - [Indexes](#indexes)
27
+ - [Custom indexes](#custom-indexes)
28
+ - [Queries](#queries)
29
+ - [Hooks](#hooks)
30
+ - [Available hooks](#available-hooks)
31
+ - [`onModuleLoad({config, store, logger }): void`](#onmoduleloadconfig-store-logger--void)
32
+ - [`onStoreLoadStart({ store, logger, dependencyTagger }): void`](#onstoreloadstart-store-logger-dependencytagger--void)
33
+ - [`onProcessFile({ store, logger, dependencyTagger, relativeFilepath, fileContent }): fileContent`](#onprocessfile-store-logger-dependencytagger-relativefilepath-filecontent--filecontent)
34
+ - [`onStoreItemAdd({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemadd-store-logger-dependencytagger-relativefilepath-storeitem--void)
35
+ - [`onStoreLoadDone({ store, logger, dependencyTagger }): void`](#onstoreloaddone-store-logger-dependencytagger--void)
36
+ - [`onStoreChangeStart({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangestart-store-logger-dependencytagger-changedfiles--void)
37
+ - [`onStoreItemBeforeUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitembeforeupdate-store-logger-dependencytagger-relativefilepath-storeitem--void)
38
+ - [`onStoreItemAfterUpdate({ store, logger, dependencyTagger, relativeFilepath, storeItem, previousStoreItem }): void`](#onstoreitemafterupdate-store-logger-dependencytagger-relativefilepath-storeitem-previousstoreitem--void)
39
+ - [`onStoreItemDelete({ store, logger, dependencyTagger, relativeFilepath, storeItem }): void`](#onstoreitemdelete-store-logger-dependencytagger-relativefilepath-storeitem--void)
40
+ - [`onStoreChangeDone({ store, logger, dependencyTagger, changedFiles }): void`](#onstorechangedone-store-logger-dependencytagger-changedfiles--void)
41
+ - [`onDumpCreate(options: OnDumpHookOptions): Dump`](#ondumpcreateoptions-ondumphookoptions-dump)
42
+ - [Hook example](#hook-example)
43
+ - [`File taxonomy.hook.js`](#file-taxonomyhookjs)
44
+ - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs)
45
+ - [Tasks](#tasks)
46
+ - [Dumps](#dumps)
47
+ - [Dependency tags](#dependency-tags)
48
+ - [Dependency tagger](#dependency-tagger)
49
+ - [`setDependency(tag: string, dependsOnTags: string[]): void`](#setdependencytag-string-dependsontags-string-void)
50
+ - [`addDependency(tag: string, dependsOnTags: string[]): void`](#adddependencytag-string-dependsontags-string-void)
51
+ - [`deleteDependency(tag: string, dependsOnTags?: string[]): void`](#deletedependencytag-string-dependsontags-string-void)
52
+ - [`invalidateTags(tags: string[]): void`](#invalidatetagstags-string-void)
53
+ - [Dependency tags example](#dependency-tags-example)
54
+ - [`File taxonomy.hook.js`](#file-taxonomyhookjs-1)
55
+ - [`File listContentsByTermId.query.js`](#file-listcontentsbytermidqueryjs-1)
56
+ - [Run modes](#run-modes)
57
+ - [Dev run mode](#dev-run-mode)
58
+ - [Prod run mode](#prod-run-mode)
59
+
11
60
  ## Options
12
61
 
13
62
  - `dataDir` / `--data-dir`: path to the directory where data from Static Suite is stored. Required.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@static-suite/static-suite-data-server",
3
- "version": "0.0.22",
3
+ "version": "0.0.23",
4
4
  "description": "A flexible, fast and developer friendly Data Server for Static Suite",
5
5
  "main": "./dist/lib/index.js",
6
6
  "typings": "./dist/lib/index.d.ts",