UNPKG

triplecheck-repository-firestore

Version:

Database utility for using Firestore with TripleCheck broker.

137 lines (133 loc) • 8.42 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>triplecheck-repository-firestore</title> <meta name="description" content="Documentation for triplecheck-repository-firestore"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">triplecheck-repository-firestore</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>triplecheck-repository-firestore</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <div class="tsd-panel tsd-typography"> <a href="#triplecheck-repository-firestore" id="triplecheck-repository-firestore" style="color: inherit; text-decoration: none;"> <h1>triplecheck-repository-firestore</h1> </a> <p><img src="readme/triplecheck-repository.png" alt="TripleCheck database repository"></p> <a href="#triplecheck-firestore-database-repository" id="triplecheck-firestore-database-repository" style="color: inherit; text-decoration: none;"> <h2>TripleCheck: Firestore database repository</h2> </a> <p>Database utility for using Firestore with TripleCheck broker. It implements the repository base at <a href="https://github.com/mikaelvesavuori/triplecheck-core">triplecheck-core</a>.</p> <a href="#instructions" id="instructions" style="color: inherit; text-decoration: none;"> <h2>Instructions</h2> </a> <p>In your <code>triplecheck-broker</code> implementation, do a regular import for <code>triplecheck-repository-firestore</code> and pass the repository to the broker. A basic implementation could look like:</p> <pre><code class="language-TypeScript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">FirestoreRepository</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;triplecheck-repository-firestore&#039;</span><span style="color: #000000">;</span> <span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">TripleCheckBroker</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;triplecheck-broker&#039;</span><span style="color: #000000">;</span> <span style="color: #008000">// If inside Google Cloud Platform:</span> <span style="color: #008000">// Pass the repo your Firestore configuration and the collection name</span> <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">repository</span><span style="color: #000000"> = </span><span style="color: #795E26">FirestoreRepository</span><span style="color: #000000">(</span><span style="color: #0000FF">undefined</span><span style="color: #000000">, </span><span style="color: #A31515">&quot;your-database-name&quot;</span><span style="color: #000000">);</span> <span style="color: #008000">// If outside Google Cloud Platform:</span> <span style="color: #008000">// Pass the repo your Firestore configuration and the collection name</span> <span style="color: #008000">// Keyfile/config only needed when running outside of GCP context</span> <span style="color: #008000">// @see https://cloud.google.com/firestore/docs/quickstart-servers</span> <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">repository</span><span style="color: #000000"> = </span><span style="color: #795E26">FirestoreRepository</span><span style="color: #000000">({</span> <span style="color: #000000"> </span><span style="color: #001080">projectId:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;your-project-id&#039;</span><span style="color: #000000">,</span> <span style="color: #000000"> </span><span style="color: #001080">keyFilename:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;keyfile.json&#039;</span> <span style="color: #000000">}, </span><span style="color: #A31515">&quot;your-database-name&quot;</span><span style="color: #000000">);</span> <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">request</span><span style="color: #000000"> = </span><span style="color: #A31515">&quot;Get this from your API request and transform it as needed&quot;</span><span style="color: #000000">;</span> <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">payload</span><span style="color: #000000"> = </span><span style="color: #A31515">&quot;Body&quot;</span><span style="color: #000000">;</span> <span style="color: #0000FF">const</span><span style="color: #000000"> { </span><span style="color: #0070C1">responseData</span><span style="color: #000000">, </span><span style="color: #0070C1">status</span><span style="color: #000000">, </span><span style="color: #0070C1">headers</span><span style="color: #000000"> } = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">TripleCheckBroker</span><span style="color: #000000">(</span> <span style="color: #000000"> </span><span style="color: #001080">request</span><span style="color: #000000">,</span> <span style="color: #000000"> </span><span style="color: #001080">payload</span><span style="color: #000000">,</span> <span style="color: #000000"> </span><span style="color: #001080">repository</span> <span style="color: #000000">);</span> </code></pre> </div> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class=" "> <a href="modules.html">Exports</a> </li> <li class=" tsd-kind-module"> <a href="modules/firestorerepository.html">Firestore<wbr>Repository</a> </li> <li class=" tsd-kind-module"> <a href="modules/index.html">index</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>