npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mayahq/maya-db

v0.0.16

Published

A small, encrypted simple document database meant for client-side use.

Downloads

31

Readme

maya-db

Encrypted, thread-safe local database for Electron apps

  • Process-less - This is just a library, it doesn't spin up a separate "database process" that needs management. No crazy dependency-injection needed to make the database accessible to functions - initialise as many times as you want.
  • In-built encryption - Uses 256-bit AES encryption for all data, unless you tell it not to.
  • Extensible to other platforms - Can be extended to web (storing data in localStorage), cloud (storing data in S3), etc. All you need to do is write a single adapter class.
  • In-built concurrency control - Uses semaphore based locking to enforce concurrency control even between multiple processes.

Quick start

Currently, the database only supports desktop environments. It can be extended to other platforms via custom adapters (see below in docs).

Quick Example: setting data and querying it

    const { localDb } = require('@mayahq/maya-db')

    // The database will be stored inside dbroot
    const dbroot = path.resolve(process.env.HOME, '.maya/localdb')

    // Initialising the database
    const db = localDb({
        encryptionKey: '[64-bit encryption key]',
        root: dbroot
    })

    const personalInfo = {
    	name: 'Dushyant',
      education: {
          college: 'BITS Pilani',
          graduation: 2022,
          degree: {
              type: 'single',
              branch: 'CS'
          }
      },
      address: 'Etihad Stadium, UAE'
    }

    // Creating a new block (file) and storing personalInfo in it
    db.createNewBlock('dushyant')
    db.block('dushyant').lockAndSet(personalInfo)

    // Querying the information stored in a GraphQL-like fashion
    const query = {
       name: null,
       lastName: 'Jain',
       education: {
           college: null,
           degreeType: 'single'
       }
    }
    db.block('dushyant').lockAndGet(query)
    	.then((result) => {
    		console.log(result)
    	})

    // Result is {
    //     name: 'Dushyant',
    //     lastName: 'Jain',
    //     education: {
    //         college: 'BITS Pilani',
    //         degreeType: 'single'
    //     }
    // }

Overview

There are two main entities for modelling storage - Block and Collection. A Block is like a document in MongoDB, while a Collection is just a collection of Blocks. Both blocks and collections are identified by unique filesystem-like "paths".

Though collections have no purpose other than to organise blocks, blocks do have a few features of note -

  • A block can either be completely encrypted or completely unencrypted, independently. It is not possible to change the encryption status of a block (i.e., encrypt and unencrypted block) after it is created.
  • Reading and writing from blocks is "thread-safe", even if multiple processes are trying to write to the same block.

Although blocks and collections are stored as files and directories in desktop environments, accessing them directly will break things. Always access them via the maya-db library.

API

Visit this page for full documentation