Fixes

• Make YAML lineWidth to be unlimited
• '401 Unauthorized' message can be handled
• Bump isomorphic-git up to 1.23.0

Features

• Added serialize option to DatabaseOptions: specifying front-matter will cause JSON objects to be saved in Front-Matter-Markdown format.
  • The serialize format specified at create time is stored in .gitddb/info.json.
  • Added SerializeFormatLabel.
• Added logToTransport option to DatabaseOptions
• Added tsLogger property to GitDocumentDB class
• Added runBeforeLiveSync property to Sync class, which allows you to specify a function that must be executed before a sync task is queued.
• Changed the type of a property of schema of DatabaseOptions from JsonDiffOptions to JsonDiffPatchOptions.
• The keyOfUniqueArray property can be used to specify the key stored in the array whose elements are not allowed to be duplicated during synchronization.

Fixes

• Enabled array synchronization.

The old npm package [email protected] was corrupted.
Correct and repackage it to v0.4.6.

Features

• Database-side debounce (experimental)
  • It is possible to debounce consecutive 'put' and 'update' to the same id document.
  • Database-side debouncing is intended to make it easy to debounce persistence procedures of data stores with exclusive locks on the application side in data flows with DB synchronization processing.
  • Debouncing on the database side may seem strange, but this is an experimental implementation and may be changed in the future.

Breaking changes

• Added TaskQueue#start(). start() must be called right after new TaskQueue().
• TaskQueue#clear() was renamed TaskQueue#stop()

Fixed cannot diff and patch error when a JSON object is nested.

Fixed cannot create DB error when integrating GitDocumentDB with Electron Squirrel installer.

GitDocumentDB is now pure TypeScript module.

Major features

• Removed native module (NodeGit) from the default install. It is now easier to integrate GitDocumentDB into your Electron app.
• Added plugin system for remote connection (isomorphic-git or NodeGit).
• Allow multiple Sync instances to sync with multiple remote repositories.

Breaking changes

• Removed loadAppInfo() and saveAppInfo().

Major features

• CRUD
  • Added automated generation of _id.
  • Added -FatDoc methods to manage any data types. Note that they are not fully implemented currently. The only .json can be available safely.
  • Added insert() and update() methods.
• GitDocumentDB Class
  • Added saveAuthor() and loadAuthor() to filter revisions by author.
  • Added loadAppInfo() and saveAppInfo() to manage app specific settings.
  • Added getCommit().
• Collection Class
  • Added CollectionOptions.namePrefix to add prefix to generated _id.
  • Added inheritance of CollectionOptions from parent collection.
  • Added onSyncEvent() and offSyncEvent() to mange sync events in each collection.

Major bug fixes

• Sync Class
  • Fixed memory leak by replacing NodeGit with isomorphic-git.

Breaking changes

• Renewed whole APIs
  • Removed createDB() and remove().
  • Replaced allDocs() with find().
  • Removed backNumber parameter from get().
  • Renamed getBackNumber() to getOldRevision().
  • Renamed getByRevision() to getDocByOid().
  • Renamed getDocHistory() to getHistory().
  • Many other changes..
• Released tutorials and API documents on https://gitddb.com/

Features

• Implemented 'combine-head-with-ours' strategy in combining inconsistent repositories.
• Fixed memory leak caused by NodeGit.
• Added SyncResultCombineDatabase type. trySync() will return it when combining inconsistent repositories.
• Added get_sync_result option to GitDocumentDB#sync() to get the first SyncResult from Sync#init().
• Added database ID and GitDocumentDB#dbId() method.
• Added GitDocumentDB#setRepository() method.
• Changed scope of Sync#remoteRepository from private to public.

Breaking changes

• Removed remoteURL argument from GitDocumentDB#sync()
• Changed return value of GitDocumentDB#open(), createDB() from DatabaseInfo type to DatabaseOpenResult type.
• Changed default value of AllDocsOptions.include_docs from false to true.
• Added .gitddb/info.json instead of .gitddb/lib_version.
• Changed CommitInfo type to NormalizedCommit type.
• Removed GitDocumentDB#fileExt(). Added JSON_EXT instead.

• v0.3.3
  • Add TaskMetadata type with enqueueTime
  • Add TaskMetadata to SyncResult
  • Add enqueueCallback to PutOptions and DeleteOptions
  • Add cancel to TaskStatistics
  • Change sync task enqueuing method from unshift to push
  • Subdivide ChangedFile type into ChangedFileInsert, ChangedFileUpdate, and ChangedFileDelete
  • Add getLogger() and setLogLevel()
• v0.3.2
  • allDocs must return rows[]
• v0.3.1
  • Add Collection#getCollection()

Features

• Added sync methods to GitDocumentDB

  • sync(remoteURL, options) Synchronize with a remote repository
  • getSynchronizer(remoteURL)
  • getRemoteURLs()
  • unregisterRemote(remoteURL)

• Added Sync Class

  • on(event, callback) Add SyncEvent handler
  • off(event, callback) Remove SyncEvent handler
  • pause() Pause synchronization
  • resume(options) Resume synchronization
  • tryPush(options) Try to push with retries
  • trySync() Try to sync with retries

• You can find examples in examples/src/sync.ts

• Added revisions (Get back number of documents)

  • get(docId, backNumber)
  • getByRevision(fileSHA) Get a specific revision of a document
  • getDocHistory(docID) Get revision history of a file from new to old
  • getDocWithMetaData(docId, backNumber) Get a document with metadata(file_sha)

• Added operational transformation for merging documents

• Added insert() method to create a document if not exists.

• Added update() method to update a document if exists.

Breaking changes

• get() and getByRevision() return undefined instead of throwing error.
• Renamed create() to createDB()
• Renamed statistics() to currentStatistics()

Features

• Added prefix search (since 0.2.8)
  • See README.md and examples/

Breaking changes

• collection_path option for allDocs() is removed. Use prefix instead.
• default of recursive options for allDocs() is changed from false to true.

Features

• Added overload method to put() to allow _id for the first argument

Breaking changes

• sub_directory option of allDoc() has been removed. Use collection_path option instead.
• collection_path options of put(), get(), remove() have been removed. Just use Collection Class.

Breaking changes

For Git users

• feat!: save JSON document by using human-readable format

Fix

• Allowed ¥ character in local_dir

Features

• Added Collection API. Documents are gathered together in collections.
  • See https://github.com/sosuisen/git-documentdb/blob/main/docs/git-documentdb.collection.md
• More compatible APIs with PouchDB
• Changed local_dir (former localDir) to be optional.
• Allow more kinds of characters for db_name, local_dir and _id.
• Added remove() method. delete() method is now just an alias of remove().
• Added options for using Collection in put(), get(), remove() and allDocs().

For Git users

• Added commit message option to change commit message.

Breaking changes

• Renamed properties of options and results from camelCase to snake_case (to align with PouchDB).

For Git users

• Added .json extension to repository files.
• Added _id property in a repository document.
• Remove filepath from _id of a JSON document. _id is just a filename now.