Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jahed/firebase-rules
A type-safe Firebase Real-time Database Security Rules builder. Compose and re-use common rules. Reference constants used throughout the project. Catch any errors and typos. Auto-completion.
https://github.com/jahed/firebase-rules
firebase firebase-database firebase-realtime-database firebase-rules json type-safety typescript
Last synced: about 2 months ago
JSON representation
A type-safe Firebase Real-time Database Security Rules builder. Compose and re-use common rules. Reference constants used throughout the project. Catch any errors and typos. Auto-completion.
- Host: GitHub
- URL: https://github.com/jahed/firebase-rules
- Owner: jahed
- License: mit
- Created: 2019-06-28T21:26:57.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-04-24T21:20:38.000Z (over 3 years ago)
- Last Synced: 2024-10-29T23:07:14.179Z (2 months ago)
- Topics: firebase, firebase-database, firebase-realtime-database, firebase-rules, json, type-safety, typescript
- Language: TypeScript
- Homepage: https://jahed.github.io/firebase-rules/
- Size: 338 KB
- Stars: 9
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @jahed/firebase-rules
[](https://www.npmjs.com/package/@jahed/firebase-rules)
[](https://jahed.dev/)
A type-safe Firebase Real-time Database Security Rules builder.
- Compose and re-use common rules.
- Reference constants used throughout the project.
- Catch any errors and typos.
- Auto-completion.
## Installation
```bash
npm install --save-dev @jahed/firebase-rules
```
## Usage
Import the modules you need to build your rules. You can create helper functions
to reduce reptition and give your rules more context. For this example, we'll
just use the modules directly to keep it simple.
```typescript
import { node, props, validate, newData, read, write, equal, auth, allowAll, param, between, oneOf, not, data } from '@jahed/firebase-rules'
const rules = {
rules: node(props({
app: node(
props({
update: node(props({
version: node(validate(newData.isString())),
force: node(validate(newData.isBoolean())),
timestamp: node(validate(newData.isNumber()))
})),
delay: node(validate(newData.isNumber()))
}),
read(allowAll),
write(equal(auth.uid, 'service-admin'))
),
users: node(
param('$userId', $userId => node(
props({
name: node(validate(
newData.isString(val => between(val.length, 0, 24))
)),
created_at: node(validate(
newData.isNumber(newVal => oneOf(
not(data.exists()),
data.isNumber(val => equal(val, newVal))
))
))
}),
write(equal($userId, auth.uid)),
validate(newData.hasChildren(['name', 'created_at']))
)),
read(allowAll)
)
}))
}
const json = JSON.stringify(rules, null, 2)
```
Now you can write `json` to a file and push it to Firebase. The configuration
above will look like this in JSON:
```json
{
"rules": {
"app": {
"update": {
"version": {
".validate": "newData.isString()"
},
"force": {
".validate": "newData.isBoolean()"
},
"timestamp": {
".validate": "newData.isNumber()"
},
"$other": {
".validate": false
}
},
"delay": {
".validate": "newData.isNumber()"
},
"$other": {
".validate": false
},
".read": true,
".write": "(auth.uid === \"service-admin\")"
},
"users": {
"$userId": {
"name": {
".validate": "(newData.isString() && ((newData.val().length > 0) && (newData.val().length < 24)))"
},
"created_at": {
".validate": "(newData.isNumber() && (!data.exists() || (data.isNumber() && (data.val() === newData.val()))))"
},
"$other": {
".validate": false
},
".write": "($userId === auth.uid)",
".validate": "newData.hasChildren([\"name\",\"created_at\"])"
},
".read": true
},
"$other": {
".validate": false
}
}
}
```
For more thorough examples, see [the tests](tests/database.rules.ts).
## API
For complete API documentation, [see the documentation website](https://jahed.github.io/firebase-rules/).
## License
[MIT](LICENSE).