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

firebase-database-rules-builder

v0.0.2

Published

Firebase database rules builder

Downloads

4

Readme

Firebase database rules builder

This library helps to produce firebase database rules from javascript or typescript code.

Steps of process are:

  1. Define rules using library helpers
  2. Build rules object
  3. Save rules object as JSON

Define rules

Rules can be defined as plain object with properties that describe your database models and values that received from library helpers. Helper produce rule value object with set of members that are relevant to context. In general, rule value objects implements firebase database security rules API described in documentation.

For example:

var lib = require('firebase-database-rules-builder');
var newData = lib.newData;

var isNewDataString = newData.isString();
var isNewDataStringLessThan100 = newData.valString().length.lessThan.evaluate(100);

{
    role: {
        ".validate": newData.isNumber()
    },
    name: {
        ".validate": isNewDataString.and.evaluate(isNewDataStringLessThan100)
    },
    description: {
        ".validate": isNewDataString
    }
}

Using typescript and providing models type information you can achieve rule properties auto completion and compile time checking.

For example:

import { Collection, newData } from 'firebase-database-rules-builder';

interface User {

    name: string;

}

...

{
    users: <Collection<User>>{
        "$id": {
            ".indexOn": [
                "name", // allowed property
                "role"  // not allowed property, compile time error
            ],
            name: { // allowed property
                ".validate": newData.isString()
                    .and.add // not existing property, compile time error
            },
            role: {} // not existing property, compile time error
        }
    }
}

For more examples see tests.

Build rules

To build rules instantiate class Builder and call method build with rules.

import { Builder } from 'firebase-database-rules-builder';

const rules = ...

const builder = new Builder();
const result = builder.build(rules);

Save rules

To save rules you can use JSON object and file system module.

import { writeFileSync } from 'fs';

const result = ...

writeFileSync('./database.rules.json', JSON.stringify(result, null, 4));