@jnode/db 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,386 @@
+# `@jnode/db`
+
+Simple database package for Node.js.
+
+## Installation
+
+```
+npm i @jnode/db
+```
+
+## Quick start
+
+### Import
+
+```js
+// Import from the main entry
+const { jdb, dble, ljson } = require('@jnode/db');
+
+// Or import from subpaths
+const { JDBFile } = require('@jnode/db/jdb');
+const { DBLEFile, DBLEUInt32Field, DBLEStringField } = require('@jnode/db/dble');
+const { LJSONFile } = require('@jnode/db/ljson');
+```
+
+### Start with a simple LJSON database
+
+LJSON is perfect for small, append-only or simple text-based data.
+
+```js
+const { LJSONFile } = require('@jnode/db/ljson');
+
+(async () => {
+  // Load or create a database
+  const db = await LJSONFile.load('./data.ljson');
+
+  // Push new data
+  await db.push({ name: 'Alice', score: 10 });
+  await db.push({ name: 'Bob', score: 15 });
+
+  // Update data (adds to numbers/strings, merges objects, etc.)
+  await db.update(0, { score: 5 }); // Alice's score becomes 15
+
+  // Overwrite or delete
+  await db.overwrite(1, { name: 'Bob', score: 20 });
+  await db.delete(0); // Deletes Alice
+})();
+```
+
+### Start a complex DBLE database
+
+DBLE is a fast, structured, binary-based database with schema definitions.
+
+```js
+const { DBLEFile, DBLEUInt32Field, DBLEStringField } = require('@jnode/db/dble');
+
+(async () => {
+  // Create a new DBLE database with a defined schema
+  const db = await DBLEFile.create('./users.dble', {
+    fields:[
+      new DBLEUInt32Field('id', true), // 'id' is a key (indexed)
+      new DBLEStringField(255, 'username')
+    ]
+  });
+
+  // Append lines (rows)
+  await db.appendLine({ id: 1, username: 'justapple' });
+  await db.appendLine({ id: 2, username: 'nick' });
+
+  // Fast query using indexed keys
+  const nickData = await db.readLineByField('id', 2);
+  console.log(nickData.fields.username); // 'nick'
+
+  // Safely close the database
+  await db.close();
+})();
+```
+
+## How it works?
+
+The `@jnode/db` package provides three core components to handle different data persistence needs seamlessly:
+
+1. **JDB** (`.jdb`): The base binary file format manager. It handles basic file magic headers, versions, and provides raw file access wrappers.
+2. **DBLE** (`.dble`): Stands for **JDB Lite Extended**. It is a simple, fast, schema-defined binary database built on top of JDB. It supports fixed-length fields, typed records, automatic indexing, deleted space reuse, and dynamic extended fields.
+3. **LJSON** (`.ljson`): Stands for **LineJSON**. It follows the `JLD` (JustLineData) text-based format. It stores an array of JSON objects line-by-line and processes append-only mutations like updates, deletions, and overwrites, making it extremely durable for logging or small configs.
+
+**Advanced Usage (DBLE):** Because DBLE queues its async file operations internally to ensure data integrity, executing multiple interdependent queries could sometimes face race conditions if another script block appends data concurrently. If you want to run complex logic that involves multiple operations, you can use the internal task queue method `._doTask(async () => { ... })` and pass `true` to the `skipQueue` argument of any method called inside. This bypasses the queue check internally and ensures your complex block runs uninterruptedly and safely!
+
+------
+
+# Reference
+
+## Class: `jdb.JDBFile`
+
+The base JDB file manager for handling binary file headers.
+
+### Static method: `JDBFile.load(path)`
+
+- `path` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Path to the file.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a[\<jdb.JDBFile\>](#class-jdbjdbfile).
+
+Opens an existing JDB file and verifies its format and magic string.
+
+### Static method: `JDBFile.create(path[, options])`
+
+- `path` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Path to the file.
+- `options`[\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `dbType` [\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) A 4-byte identifier for the database type (E.g., `0x44424C45` for DBLE). **Default:** `0`.
+  - `dbVersion` [\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) The version of the specific database format. **Default:** `0`.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a [\<jdb.JDBFile\>](#class-jdbjdbfile).
+
+Creates a new JDB file (fails if the file already exists).
+
+### Static method: `JDBFile.forceCreate(path[, options])`
+
+- `path` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Path to the file.
+- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) Same as[`JDBFile.create()`](#staticmethod-jdbfilecreatepath-options).
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a [\<jdb.JDBFile\>](#class-jdbjdbfile).
+
+Forces creation of a new JDB file, overwriting if it already exists.
+
+### `jdb.close()`
+
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+
+Closes the internal file handle safely.
+
+### `jdb.sync()`
+
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+
+Synchronizes the file's data and metadata to the storage device.
+
+### `jdb.datasync()`
+
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+
+Synchronizes only the file's data to the storage device.
+
+### Inner method: `jdb._init([options])`
+
+### Inner method: `jdb._loadHead()`
+
+Internal methods to initialize and load file headers.
+
+## Class: `dble.DBLEFile`
+
+The main manager for DBLE files, which extends `JDBFile`.
+
+### Static method: `DBLEFile.load(path[, options])`
+
+- `path`[\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Path to the file.
+- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `types` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object) Custom field types mappings.
+  - `maxLineCache` / `maxLineCacheSize` [\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) Controls the LRU cache limit for read lines.
+  - `scanBufferLines` / `scanBufferSize` [\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) Controls buffer block sizes when iterating sequentially.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a[\<dble.DBLEFile\>](#class-dbledblefile).
+
+### Static method: `DBLEFile.create(path, options)`
+
+### Static method: `DBLEFile.forceCreate(path, options)`
+
+- `path` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Path to the file.
+- `options`[\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `fields` [\<DBLEField[]\>](#class-dbledblefield) **Required.** An array of field instances defining the table structure.
+  - `extBaseLength`[\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) Optional override to calculate extension field base length manually.
+  - Plus `DBLEFile.load` options.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a[\<dble.DBLEFile\>](#class-dbledblefile).
+
+Creates (or forcefully overwrites) a DBLE database file.
+
+### `dble.getField(line, field[, skipQueue])`
+
+- `line`[\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) The index of the line/row.
+- `field`[\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Field name.
+- `skipQueue` [\<boolean\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type) Skip the internal task queue execution lock.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Resolves with the parsed field value.
+
+Retrieves a specific field from a specific line.
+
+### `dble.getExt(line[, skipQueue])`
+
+Retrieves the concatenated binary extended data for a line. Returns a [\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer).
+
+### `dble.getLineByField(field, query[, skipQueue])`
+
+Finds the numeric line index where the specified `field` matches the `query`. If the field was declared with `isKey: true`, this operation is `O(1)` via index map. Otherwise, it executes a sequential scan.
+
+### `dble.readLine(line[, skipQueue])`
+
+Reads a full line structure at the target index. The resolved object looks like: `{ type, nextLine, fields: { ... } }`.
+
+### `dble.readLineByField(field, query[, skipQueue])`
+
+Combination of `getLineByField` and `readLine`. Returns the parsed line object.
+
+### `dble.findLine(fn[, skipQueue])`
+
+Iterates over all lines and returns the line index when the async callback `fn(parsedLine)` returns `true`.
+
+### `dble.forEachLine(fn, start, to[, skipQueue])`
+
+Executes the callback `fn(parsedLine, lineIndex)` on every valid database line starting from `start` up to `to`.
+
+### `dble.setLine(line, fields[, skipQueue])`
+
+Updates specific fields on an existing line. Pass `{}` to fields to just touch it, or pass an object with partial properties. Also updates indexes seamlessly. If `line` is not a number, it behaves like `appendLine`.
+
+### `dble.setLineByField(field, query, fields[, skipQueue])`
+
+Finds the line via field/query matching, and updates it.
+
+### `dble.appendLine(fields[, skipQueue])`
+
+Appends a new record to the database, or overwrites an empty (deleted) line dynamically for disk space reuse. Returns the new line index.
+
+### `dble.deleteLine(line, releaseSpace[, skipQueue])`
+
+Flags a line as deleted. If `releaseSpace` is `true`, it dynamically links the block to the empty line manager to allow future `appendLine` calls to overwrite this spot.
+
+### `dble.deleteLineByField(field, query, releaseSpace[, skipQueue])`
+
+Finds a line by a query and deletes it.
+
+### `dble.cleanUp([skipQueue])`
+
+Loops over the DB sequentially, completely clearing up lines marked as deleted and moving them to the empty reusable line linked list.
+
+### `dble.setExt(line, ext[, skipQueue])`
+
+Saves an arbitrary binary[\<Buffer\>](https://nodejs.org/docs/latest/api/buffer.html#class-buffer) to a line's extension block. If the buffer is large, it automatically chunks it across multiple linked empty lines.
+
+### `dble.setExtByField(field, query, ext[, skipQueue])`
+
+Finds a line by field query and sets its extended buffer data.
+
+### `dble.close()`
+
+### `dble.sync([skipQueue])`
+
+### `dble.datasync([skipQueue])`
+
+File handle operations natively routed to the base JDB class.
+
+### Inner method: `dble._doTask(func, skipQueue)`
+
+Advanced tool. Runs your `func` exclusively inside the DB task queue, locking other async modifications from messing with your state.
+
+### Inner methods: `_init`, `_loadHead`, `_loadIndices`, `_getLineBuffer`, `_writeLineBuffer`, `_appendLineBuffer`, `_getLastEmptyLine`, `_clearLinesFrom`, `_readlines`, `_parseLine`, etc
+
+Internal lifecycle and binary chunking methods.
+
+## Class: `dble.DBLEField`
+
+The base interface for field typings in DBLE. You instantiate these classes in the `fields` array when creating a new database.
+
+### Built-in Field Types
+
+Access these via `require('@jnode/db/dble')` or `dble.defaultDBLETypes`:
+
+- `DBLEInt8Field(name, isKey, isRelative)` / `DBLEUInt8Field`
+- `DBLEInt16Field(name, isKey, isRelative)` / `DBLEUInt16Field`
+- `DBLEInt32Field(name, isKey, isRelative)` / `DBLEUInt32Field`
+- `DBLEBigInt64Field(name, isKey, isRelative)` / `DBLEBigUInt64Field`
+- `DBLEFloatField(name, isKey, isRelative)` / `DBLEDoubleField`
+- `DBLEStringField(maxLength, name, isKey, isRelative)`
+- `DBLEBufferField(maxLength, name, isKey, isRelative)`
+- `DBLEAnyField(length, name, isKey, isRelative)`
+
+*Note: The `maxLength` argument is required for String and Buffer types to enforce DBLE's fixed-length binary schema standard.*
+
+## Class: `ljson.LJSONFile`
+
+Manages text-based LJSON files. This works by keeping a stateful memory representation of the JSON array, and appending modification operations (like `+`, `=`, `-`) to the file stream iteratively.
+
+### Static method: `LJSONFile.load(file[, options])`
+
+- `file` [\<string\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#string_type) Target LJSON file path.
+- `options` [\<Object\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)
+  - `disableCleanupOnStart` [\<boolean\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#boolean_type) Stop LJSON from compacting its mutation logs on load.
+- Returns: [\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise) Fulfills with a [\<ljson.LJSONFile\>](#class-ljsonljsonfile).
+
+Loads the JLD formatted LJSON file. If it doesn't exist, an empty file will be created.
+
+### Static method: `LJSONFile.forceCreate(file[, options])`
+
+Overwrites a file with a fresh, empty LJSON database.
+
+### `ljson.cleanUp(force)`
+
+Rewrites the entire file on disk, collapsing all mutation lines (updates, overwrites, deletions) into a clean, flat list of final JSON representations.
+
+### `ljson.push(json)`
+
+- `json` [\<any\>] Valid JSON.
+- Returns:[\<Promise\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
+
+Appends a new line with the object directly to the database.
+
+### `ljson.update(index, json)`
+
+- `index` [\<number\>](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#number_type) The array index to modify.
+- `json` [\<any\>] The mutation payload.
+
+Applies a mutation diff based on the original data type:
+
+- **String / Number**: `original += update`
+- **Boolean**: `original = update !== original`
+- **Object**: `Object.assign(original, update)`
+- **Array**: `original.push(...update)`
+
+### `ljson.overwrite(index, json)`
+
+Overwrites the target index entirely with the new `json` payload.
+
+### `ljson.delete(index)`
+
+Removes the index element from the database. Note that this shifts subsequent indexes.
+
+### Inner method: `ljson._loadData(data)`
+
+Parses textual JLD lines and applies all operators into the memory array.
+
+------
+
+# Format Specifications
+
+## DBLE Format Specification
+
+```
+---- File Head
+[4 Byte] "JDBD"
+[UInt8 ] Version, 1
+[3 Byte] RSV
+[4 Byte] DB Type, "DBLE"
+[UInt8 ] DB Version, 1
+[3 Byte] RSV
+---- DB Head
+[Array ] Definition[16 Bit] Flag (isLast, isKey, isRelative RSV...)
+  [UInt16] Field Length
+  [UInt8 ] Type Name Length
+  [String] Type Name
+  [UInt8 ] Field Name Length
+  [String] Field Name
+  [n Byte] (OPTIONAL) Field Relative Data[UInt16] Extend Field Base Length (making each line 2 ** N bytes)
+[UInt32] Last Empty Line (0xFFFFFFFF for null)
+[n Byte] Padding (making 'File Head' + 'DB Head' N * Line Length)
+---- DB Body
+[Array ] Lines
+  [2 Bit ] Type (Normal Start, Extended, Empty, Deleted Start)
+  [14 Bit] Flag[UInt32] Extended Line At/Last Empty Line (if type is 'Empty', 0xFFFFFFFF for null)
+  [Array ] Line Data
+    [n Byte] Field Data
+```
+
+## LJSON Format Specification
+
+This is a simple text-based, line-based data format.
+
+### JLD v1 File head line
+
+> `JLD` stands for **JustLineData**, a subtype of JDB but is text-and-line-based while a `.jdb` file is binary based.
+
+```
+@ JLD 01 <DATA-TYPE (4 ASCII Character)> <DATA-VERSION (2 HEX)>
+[@ <OTHER-HEADERS...>]...
+<ACTUAL-DATA>...
+```
+
+For LJSON, we use:
+
+```
+@ JLD 01 LJSO 01
+```
+
+### Line types
+
+- `<JSON>` JSON data line. E.G. `{"name":"nick"}`.
+- `/ <CONTENT>` Comment. Only for temporary use, we won't keep the comment lines.
+- `+ <INDEX> <JSON>` Update line. Update JSON's data type must be same as original JSON's data type. Works in different ways according to the data type:
+  - **String**: `original += update`.
+  - **Number**: `original += update`.
+  - **Boolean**: `original = update !== original`.
+  - **Object**: `Object.assign(original, update)`
+  - **Array**: `original.push(...update)`
+- `= <INDEX> <JSON>` Overwrite line.
+- `- <INDEX>` Delete line.

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@jnode/db",
+  "version": "1.0.0",
+  "description": "Simple database package for Node.js.",
+  "main": "./src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./jdb": "./src/jdb.js",
+    "./dble": "./src/dble.js",
+    "./ljson": "./src/ljson.js"
+  },
+  "scripts": {
+    "test": "echo \"Hello, database.\""
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/japple-jnode/db.git"
+  },
+  "keywords": [
+    "JustNode",
+    "JustApple",
+    "Database",
+    "JSON",
+    "DB",
+    "JDB",
+    "DBLE",
+    "LJSON"
+  ],
+  "author": "JustApple <apple@justapple.tw>",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/japple-jnode/db/issues"
+  },
+  "homepage": "https://github.com/japple-jnode/db#readme"
+}