Uttori Storage Provider - JSON File

Uttori Storage Provider using JSON files on disk.

This repo exports both a Uttori Plugin compliant Plugin class as well as the underlying StorageProvider class.

Install

npm install --save @uttori/storage-provider-json-file

Config

{
  contentDirectory: '',
  historyDirectory: '',
  extension: 'json',
  spacesDocument: null,
  spacesHistory: null,
  updateTimestamps: true,
  useHistory: true,
  // Registration Events
  events: {
    add: ['storage-add'],
    delete: ['storage-delete'],
    get: ['storage-get'],
    getHistory: ['storage-get-history'],
    getRevision: ['storage-get-revision'],
    getQuery: ['storage-query'],
    update: ['storage-update'],
    validateConfig: ['validate-config'],
  },
}

Example

// When part of UttoriWiki:
import { Plugin as StorageProviderJSON } from '@uttori/storage-provider-json-file';

// When stand alone:
import StorageProvider from '@uttori/storage-provider-json-file';

const s = new StorageProvider({
  contentDirectory: 'example/content',
  historyDirectory: 'example/history',
  extension: 'json',
  spacesDocument: null,
  spacesHistory: null,
});
await s.add({
  title: 'Example Title',
  slug: 'example-title',
  content: '## Example Title',
  html: '',
  updateDate: 1459310452001,
  createDate: 1459310452001,
  tags: ['Example Tag'],
  customData: {
    keyA: 'value-a',
    keyB: 'value-b',
    keyC: 'value-c',
  },
});
const results = await s.getQuery('SELECT tags FROM documents WHERE slug IS_NOT_NULL ORDER BY slug ASC LIMIT 1');
➜  results === [
      { tags: ['Example Tag'] },
    ]
const results = await s.getQuery('SELECT COUNT(*) FROM documents WHERE slug IS_NOT_NULL ORDER BY RANDOM ASC LIMIT -1');
➜  results === 1

API Reference

Classes

StorageProvider

Storage for Uttori documents using JSON files stored on the local file system.

Typedefs

UttoriDocument

StorageProviderConfig

StorageProvider

Storage for Uttori documents using JSON files stored on the local file system.

Kind: global class
Properties

• StorageProvider
  • new StorageProvider(config)
  • instance
    • .documents : Record.<string, UttoriDocument>
    • .all ⇒ Promise.<Record.<string, UttoriDocument>>
    • .getQuery ⇒ Promise.<(Array.<UttoriDocument>|number)>
    • .get ⇒ Promise.<(UttoriDocument|undefined)>
    • .add
    • .updateValid ℗
    • .update
    • .delete
    • .getHistory ⇒ Promise.<Array.<string>>
    • .getRevision ⇒ Promise.<(UttoriDocument|undefined)>
    • .updateHistory
  • static
    • .ensureDirectory(directory)

new StorageProvider(config)

Creates an instance of StorageProvider.

Example (Init StorageProvider)

const storageProvider = new StorageProvider({ contentDirectory: 'content', historyDirectory: 'history', spacesDocument: 2 });

storageProvider.documents : Record.<string, UttoriDocument>

The collection of documents where the slug is the key and the value is the document.

Kind: instance property of StorageProvider

storageProvider.all ⇒ Promise.<Record.<string, UttoriDocument>>

Returns all documents.

Kind: instance property of StorageProvider
Returns: Promise.<Record.<string, UttoriDocument>> - All documents.
Example

storageProvider.all();
➜ { first-document: { slug: 'first-document', ... }, ...}

storageProvider.getQuery ⇒ Promise.<(Array.<UttoriDocument>|number)>

Returns all documents matching a given query.

Kind: instance property of StorageProvider
Returns: Promise.<(Array.<UttoriDocument>|number)> - Promise object represents all matching documents.

storageProvider.get ⇒ Promise.<(UttoriDocument|undefined)>

Returns a document for a given slug.

Kind: instance property of StorageProvider
Returns: Promise.<(UttoriDocument|undefined)> - Promise object represents the returned UttoriDocument.

storageProvider.add

Saves a document to the file system.

Kind: instance property of StorageProvider

storageProvider.updateValid ℗

Updates a document and saves to the file system.

Kind: instance property of StorageProvider
Access: private

storageProvider.update

Updates a document and figures out how to save to the file system.

Kind: instance property of StorageProvider

storageProvider.delete

Removes a document from the file system.

Kind: instance property of StorageProvider

storageProvider.getHistory ⇒ Promise.<Array.<string>>

Returns the history of edits for a given slug.

Kind: instance property of StorageProvider
Returns: Promise.<Array.<string>> - Promise object represents the returned history.

storageProvider.getRevision ⇒ Promise.<(UttoriDocument|undefined)>

Returns a specifc revision from the history of edits for a given slug and revision timestamp.

Kind: instance property of StorageProvider
Returns: Promise.<(UttoriDocument|undefined)> - Promise object represents the returned revision of the document.

storageProvider.updateHistory

Updates History for a given slug, renaming the store file and history directory as needed.

Kind: instance property of StorageProvider

StorageProvider.ensureDirectory(directory)

Ensure a directory exists, and if not create it.

Kind: static method of StorageProvider

UttoriDocument

Kind: global typedef
Properties

StorageProviderConfig

Kind: global typedef
Properties

Tests

To run the test suite, first install the dependencies, then run npm test:

npm install
npm test
DEBUG=Uttori* npm test

Contributors

• Matthew Callis

License

• MIT