ARK Database Wrapper

Common errors

• Error: Cannot find module 'ark-database'

  cause The package `ark-database` is not installed or incorrectly referenced in your project.
  fix Run `npm install ark-database` to add it to your project's dependencies.

• npm WARN ark-database@18.3.0 requires a peer of hapi@>=9.x.x but none is installed.

  cause The `hapi` peer dependency requirement for `ark-database` is not met in your project.
  fix Install a compatible version of Hapi: `npm install hapi@^9.0.0`. Note that Hapi v9 is very old and potentially insecure for modern applications.

• TypeError: db.someMethod is not a function

  cause Attempting to call a database method that does not exist or has an unexpected signature (e.g., expecting a Promise when it's callback-based).
  fix Verify the exact method name and its expected arguments (callback or Promise return) by consulting the library's source code, as documentation may be incomplete or outdated.

Warnings

• breaking The `ark-database` package and its core dependency, `locator-kn/ark`, have been abandoned since late 2017. There will be no further updates, bug fixes, or security patches.
  Fix: Migrate to a currently maintained database abstraction layer or ORM. This package is unsuitable for new development or production environments.
• gotcha The API is inconsistent, with some methods using traditional Node.js callbacks while others might have been partially refactored to return Promises (as indicated by a long-standing open GitHub issue). This requires careful inspection of the source code for each method used.
  Fix: Always check the source code for the specific method's signature or assume a callback API. Wrap callback-based methods in Promises manually if Promise-based usage is desired (e.g., using `util.promisify`).
• breaking The package has a strict `hapi` peer dependency ('>=9.x.x'). Running this package with newer or significantly older versions of Hapi, or with non-Hapi environments, will likely result in installation failures or runtime errors.
  Fix: Ensure your project explicitly installs a compatible Hapi version. However, given Hapi's evolution and this package's abandonment, finding a compatible and secure Hapi version for modern Node.js may be challenging.

Install

• npm install ark-database npm
• yarn add ark-database yarn
• pnpm add ark-database pnpm

Imports

• Database

  const Database = require('ark-database');

  This package primarily uses CommonJS `require` syntax. Given its last update in 2017, it does not officially support ES Modules.

Quickstart

This quickstart demonstrates the core usage of `ark-database` including initialization and performing basic CRUD operations (get, create, delete) using its callback-based API.

const Database = require('ark-database');

// Initialize the database wrapper for a specific tenant/user context
const db = new Database('alice'); 

// Example: Get a user by ID using a callback
db.getUserById('1234567890', function(err, res) {
   if (err) {
      console.error('Error fetching user:', err);
      return;
   }
   console.log('User found:', res);
});

// Example: Create a new trip entry
const newTrip = { 
  id: 'trip-abc-123',
  userId: 'alice',
  destination: 'Wonderland',
  startDate: new Date(),
  status: 'planned'
};
db.createTrip(newTrip, function(err, res) {
   if (err) {
      console.error('Error creating trip:', err);
      return;
   }
   console.log('Trip created:', res);
});

// Example: Delete a location by ID
db.deleteLocationById('12322456576567', function(err, res) {
   if (err) {
      console.error('Error deleting location:', err);
      return;
   }
   console.log('Location deleted result:', res);
});