Skip to content

Commit

Permalink
upd: version
Browse files Browse the repository at this point in the history
  • Loading branch information
@siarheidudko
siarheidudko committed May 30, 2020
1 parent d23cbe9 commit f7d1e82
Show file tree
Hide file tree
Showing 49 changed files with 684 additions and 238 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# 1.1.0 / 2020-05-31

## :tada: Enhancements
- Added the ability to transfer users with passwords

# 1.0.0 / 2020-05-30

## :tada: Stable version
- Firebase.Auth backup
- Firebase.Firestore backup
- Firebase.Storage backup
- Firebase.Auth clean
- Firebase.Firestore clean
- Firebase.Storage clean
- Firebase.Auth restore
- Firebase.Firestore restore
- Firebase.Storage restore
16 changes: 16 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,17 @@ Engine to Backup, Clean, Restore. Work for Firebase.Firestore, Firebase.Storage,
| backup | b | Path to backup or restore file. Default: ./{$PROJECT_ID + $TIMESTAMP}.backup |
| --nocompress | -nc | Do not use data compression |

## Launch parameters (only for password recovery for users in Firebase.Auth)

| Name | Short name | Description |
|-----------------------|------------|----------------------------------------------------------------------------------|
| algorithm | alg | The password hashing information (algorithm, only SCRYPT). Default: SCRYPT |
| base64_signer_key | bsk | The password hashing information (key in base64 encoding). Default: user passwords are not restored if not set. |
| base64_salt_separator | bss | The password hashing information (salt separator in base64). Default: Bw== |
| rounds | rnd | The password hashing information (rounds). Default: 8 |
| mem_cost | mc | The password hashing information (memory cost). Default: 14 |


## Use

With full names
Expand All @@ -36,6 +47,11 @@ With short names
firebase-engine o="b, c" p="./test.json" b="test.backup"
```

With password recovery for users
```bash
firebase-engine operations="restore" path="./test.json" services="firestore, auth" backup="test.backup" bsk="nMyNs6sFWp0GZ/JSW2tsNGvGZ70oiv13gxO7ub7rxPwK271P945BiZmjrdsBRbgZmzPPgwATLR6FaXq3rUspVg=="
```

## Open Source

[See source docs](https://siarheidudko.github.io/firebase-engine)
Expand Down
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/classes/_firebaseengine_.firebaseengine.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L8">FirebaseEngine.ts:8</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/FirebaseEngine.ts#L8">FirebaseEngine.ts:8</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -152,7 +152,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> admin</h3>
<div class="tsd-signature tsd-kind-icon">admin<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">App</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L25">FirebaseEngine.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/FirebaseEngine.ts#L25">FirebaseEngine.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -167,7 +167,7 @@ <h3>jobs</h3>
<div class="tsd-signature tsd-kind-icon">jobs<span class="tsd-signature-symbol">:</span> <a href="_jobs_jobs_.jobs.html" class="tsd-signature-type">Jobs</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L29">FirebaseEngine.ts:29</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/FirebaseEngine.ts#L29">FirebaseEngine.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -182,7 +182,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> settings</h3>
<div class="tsd-signature tsd-kind-icon">settings<span class="tsd-signature-symbol">:</span> <a href="../interfaces/_utils_initialization_.settings.html" class="tsd-signature-type">Settings</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L21">FirebaseEngine.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/FirebaseEngine.ts#L21">FirebaseEngine.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -204,7 +204,7 @@ <h3>exit</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/FirebaseEngine.ts#L33">FirebaseEngine.ts:33</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/FirebaseEngine.ts#L33">FirebaseEngine.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
22 changes: 11 additions & 11 deletions docs/classes/_jobs_backup_auth_.jobbackupauth.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L9">jobs/backup/auth.ts:9</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/auth.ts#L9">jobs/backup/auth.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -166,7 +166,7 @@ <h3>admin</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#admin">admin</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L28">utils/template.ts:28</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L28">utils/template.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -181,7 +181,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> auth</h3>
<div class="tsd-signature tsd-kind-icon">auth<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Auth.Auth</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L21">jobs/backup/auth.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/auth.ts#L21">jobs/backup/auth.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -197,7 +197,7 @@ <h3>counter</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#counter">counter</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L80">utils/template.ts:80</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L80">utils/template.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -213,7 +213,7 @@ <h3>settings</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#settings">settings</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L24">utils/template.ts:24</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L24">utils/template.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -229,7 +229,7 @@ <h3>start<wbr>Timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#starttimestamp">startTimestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L95">utils/template.ts:95</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L95">utils/template.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -245,7 +245,7 @@ <h3>stringifer<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#stringiferstream">stringiferStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L128">utils/template.ts:128</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L128">utils/template.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -261,7 +261,7 @@ <h3>writer</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#writer">writer</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L124">utils/template.ts:124</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L124">utils/template.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -284,7 +284,7 @@ <h3>get<wbr>Work<wbr>Time</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#getworktime">getWorkTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L84">utils/template.ts:84</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L84">utils/template.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -306,7 +306,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> recursive<wbr>Backup</h
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L25">jobs/backup/auth.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/auth.ts#L25">jobs/backup/auth.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -335,7 +335,7 @@ <h3>run</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/auth.ts#L51">jobs/backup/auth.ts:51</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/auth.ts#L51">jobs/backup/auth.ts:51</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
24 changes: 12 additions & 12 deletions docs/classes/_jobs_backup_firestore_.jobbackupfirestore.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L9">jobs/backup/firestore.ts:9</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/firestore.ts#L9">jobs/backup/firestore.ts:9</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -167,7 +167,7 @@ <h3>admin</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#admin">admin</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L28">utils/template.ts:28</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L28">utils/template.ts:28</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -183,7 +183,7 @@ <h3>counter</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#counter">counter</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L80">utils/template.ts:80</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L80">utils/template.ts:80</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -198,7 +198,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> firestore</h3>
<div class="tsd-signature tsd-kind-icon">firestore<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Firestore.Firestore</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L21">jobs/backup/firestore.ts:21</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/firestore.ts#L21">jobs/backup/firestore.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -214,7 +214,7 @@ <h3>settings</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobtemplate.html">JobTemplate</a>.<a href="_utils_template_.jobtemplate.html#settings">settings</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L24">utils/template.ts:24</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L24">utils/template.ts:24</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -230,7 +230,7 @@ <h3>start<wbr>Timestamp</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#starttimestamp">startTimestamp</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L95">utils/template.ts:95</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L95">utils/template.ts:95</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -246,7 +246,7 @@ <h3>stringifer<wbr>Stream</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#stringiferstream">stringiferStream</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L128">utils/template.ts:128</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L128">utils/template.ts:128</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -262,7 +262,7 @@ <h3>writer</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.jobbackupservicetemplate.html">JobBackupServiceTemplate</a>.<a href="_utils_template_.jobbackupservicetemplate.html#writer">writer</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L124">utils/template.ts:124</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L124">utils/template.ts:124</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -284,7 +284,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> document<wbr>Backup</h3
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L25">jobs/backup/firestore.ts:25</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/firestore.ts#L25">jobs/backup/firestore.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -313,7 +313,7 @@ <h3>get<wbr>Work<wbr>Time</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#getworktime">getWorkTime</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/utils/template.ts#L84">utils/template.ts:84</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/utils/template.ts#L84">utils/template.ts:84</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand All @@ -335,7 +335,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> recursive<wbr>Backup</h
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L49">jobs/backup/firestore.ts:49</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/firestore.ts#L49">jobs/backup/firestore.ts:49</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down Expand Up @@ -364,7 +364,7 @@ <h3>run</h3>
<aside class="tsd-sources">
<p>Overrides <a href="_utils_template_.joboneservicetemplate.html">JobOneServiceTemplate</a>.<a href="_utils_template_.joboneservicetemplate.html#run">run</a></p>
<ul>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/2428345/src/jobs/backup/firestore.ts#L63">jobs/backup/firestore.ts:63</a></li>
<li>Defined in <a href="https://github.com/siarheidudko/firebase-engine/blob/d23cbe9/src/jobs/backup/firestore.ts#L63">jobs/backup/firestore.ts:63</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
Expand Down
Loading

0 comments on commit f7d1e82

Please sign in to comment.