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

firestore-rulez

v1.0.0

Published

Combines multiple *.rules files into one single firestore.rules file.

Downloads

361

Readme

🔥 Firestore Rulez 🔥

Takes working with Firestore Security Rules to the next level.

This Node.js modules let's you split up your Firestore Security Rules firestore.rules file into multiple files. The module will combine the files, and if you wish, even add useful helpers functions to the mix so you don't have to define them yourself.

Give it a go and feel free to add additional helper functions to the repository!

Requirements

Make sure you have Node.js installed on your system (the newer, the better).

Installation

NPM:

npm i firestore-rulez --save-dev

yarn:

yarn add firestore-rulez --dev

Basic Usage

  1. Create a subfolder called /rules.

  2. Add as many .rules files to the folder as you like.

  3. Generate firestore.rules via the following command in your console:

firestore-rulez

Advanced Usage

  1. Create config file at project root

  2. Generate .rules files and helper functions inline with config file

  3. Generate firestore.rules via the following command in your console:

firestore-rulez

Generate rules file

You can run Firestore-Rulez by hitting firestore-rulez in your CLI.

firestore-rulez

This will create the firestore.rules file combining your files in the following way:

service cloud.firestore {
	match /databases/{database}/documents {

    // -> LIBRARY HELPER FUNCTIONS, if enabled

    // -> YOUR HELPER FUNCTIONS, if enabled

    // -> YOUR RULES FILES

  }
}

Configuration File Syntax

Firestore-Rulez can be configured by adding a rulez.config.js file to the project root or ./rules folders.

The file is to export a object with the following syntax:

| Field | Default Value | Type | Description | | ----- | --------------- | ----- | ------------- | | helpers | ["authUserEmail", "authUserEmailIsVerified", "authUserUid", "existingData", "hasAmtOfWriteFields", "incomingData", "isAuthenticated"] | array(strings) | boolean | used to add helper functions to the output, this can be true to include all helper functions or false to include non of the helper functions or an array of the function names | | custom_helpers_folder | null | null | string | path to user defined helper functions | | rules_version | "1" | "1" | "2" | 1 | 2 | which version is the rules written in | | rules_folder | "rules" | string | folder where the rule fragments can be found | | rules_output | "firestore.rules" | string | name of the file to output to | | use_firebase_config | false | boolean | use the firebase config file firebase.json to get the rules output file name and location |

Default Configuration File

module.exports = {
  helpers: [
    "authUserEmail",
    "authUserEmailIsVerified",
    "authUserUid",
    "existingData",
    "hasAmtOfWriteFields",
    "incomingData",
    "isAuthenticated",
  ],
  custom_helpers_folder: null,
  rules_version: 1,
  rules_folder: "rules",
  rules_output: "firestore.rules",
  use_firebase_config: false,
};

Helper Functions

The following helper functions are present, if the helpers option is enabled or the function is included: | name | description | | --- | ---| | isAuthenticated | Checks if user is authenticated | | authUserUid | Returns Current Auth User's Uid | | authUserEmail | Returns Current Auth User's Email | | authUserEmailIsVerified | Returns wether Current Auth User's Email is verified | | existingData | Returns the existing data | | incomingData | Returns the incoming data | | hasAmtOfWriteFields | Checks if the request has X write fields |

Use the name of the functionin the rules files and in the configuration file to enable them in the configuration or set the helpers function to true to include them all.

isAuthenticated

// Checks if user is authenticated
function isAuthenticated() {
  return request.auth != null;
}

authUserUid

// Returns Current Auth User's Uid
function authUserUid() {
  return request.auth.uid;
}

authUserEmail

// Returns Current Auth User's Email
function authUserEmail() {
  return request.auth.token.email;
}

authUserEmailIsVerified

// Returns wether Current Auth User's Email is verified
function authUserEmailIsVerified() {
  return request.auth.token.email_verified;
}

existingData

// Returns the existing data
function existingData() {
  return resource.data;
}

incomingData

// Returns the incoming data
function incomingData() {
  return request.resource.data;
}

hasAmtOfWriteFields

// Checks if the request has X write fields
function hasAmtOfWriteFields(size) {
  return request.writeFields.size() == size;
}

Credits

Thanks to OneLunch Man for inspiring me to build this module on Stack Overflow and to Bullfrog1234 for the amazing pull-request #5 making this module rule(z) even more!