pwa-auth 3.3.6 → 3.3.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +176 -176
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,32 +6,34 @@ Visit the [Live Demo](https://pwa-authentic.firebaseapp.com)
|
|
|
6
6
|
|
|
7
7
|
pwa-auth.js is a bundle of 5 Custom HTML Elements for Firebase (IAM) Authenication using email and password, with the ability to change username, icon, email, password, or delete your own account and it's content all together.
|
|
8
8
|
|
|
9
|
-
pwa-auth.js (Authentication
|
|
9
|
+
pwa-auth.js (Website Authentication Components) is a quick and simple way to sign-up, log-in, log-out, modify, or delete a firebase account information from your own personal domain.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Place 5 Custom HTML Tags, reference CSS, and Initialize a Firebase Instance. By either <b>Standard</b> or <b>Modular</b> ECMA Script.
|
|
12
12
|
|
|
13
13
|
Continue reading to understand how to install this project:
|
|
14
14
|
|
|
15
|
-
##
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
-
|
|
20
|
-
|
|
21
|
-
|
|
15
|
+
## Library
|
|
16
|
+
```javascript
|
|
17
|
+
// ES - Modules
|
|
18
|
+
import './pwa-auth';
|
|
19
|
+
// Optional - copy CoreJS Project Bundle
|
|
20
|
+
'npm/pwa-auth/source/**/*'
|
|
21
|
+
// - source/
|
|
22
|
+
// - pwa-auth.js
|
|
23
|
+
// - pwa-styles.css
|
|
24
|
+
// - empty.jpg
|
|
25
|
+
// - Third Party License .txt
|
|
26
|
+
```
|
|
22
27
|
|
|
23
|
-
##
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
-
|
|
32
|
-
- Links and Hashes:
|
|
33
|
-
- Semantics:
|
|
34
|
-
- Descriptions
|
|
28
|
+
## Prerequisites
|
|
29
|
+
Google:
|
|
30
|
+
- Google Analytics
|
|
31
|
+
- Firebase Project
|
|
32
|
+
Firebase:
|
|
33
|
+
- Authentication
|
|
34
|
+
- email login
|
|
35
|
+
- Cloud Storage
|
|
36
|
+
- storage bucket
|
|
35
37
|
|
|
36
38
|
## Technical Summary
|
|
37
39
|
- Type Strong with [TypeScript](https://www.typescriptlang.org)
|
|
@@ -40,26 +42,13 @@ Continue reading to understand how to install this project:
|
|
|
40
42
|
- Authentication with Google's [Firebase](https://www.firebase.com)
|
|
41
43
|
- Firebase Initialization Object: `window.process = { env: { FIREBASE_CONFIG: `
|
|
42
44
|
|
|
43
|
-
##
|
|
44
|
-
-
|
|
45
|
-
|
|
46
|
-
-
|
|
47
|
-
|
|
48
|
-
- Pages:
|
|
49
|
-
- `<user-settings>` Account Settings
|
|
50
|
-
- `<user-login>` Auth: Email Log-in / email Subscribe
|
|
51
|
-
- `<email-reset>` Password Reset
|
|
52
|
-
|
|
53
|
-
<!-- ## Entry Point / Content -->
|
|
54
|
-
|
|
55
|
-
## Abstraction Layer
|
|
56
|
-
- The Observer Patterns:
|
|
57
|
-
- Event emitters:
|
|
58
|
-
- Custom Events
|
|
59
|
-
|
|
60
|
-
<!-- ## Navigation -->
|
|
45
|
+
## Atomic Engineering
|
|
46
|
+
- Development (Server-side) Environment: [Node JavaScript](https://nodejs.org)
|
|
47
|
+
- Backend: Google Cloud: [Firebase](https://firebase.google.com/)
|
|
48
|
+
- Predicate State Behavior: [Redux](https://redux.js.org/)
|
|
49
|
+
- Frontend (Client-side): [Lit](https://lit.dev)
|
|
61
50
|
|
|
62
|
-
|
|
51
|
+
Outline:
|
|
63
52
|
- Register through Email and Password
|
|
64
53
|
- Log-in
|
|
65
54
|
- Log-out
|
|
@@ -69,84 +58,76 @@ Continue reading to understand how to install this project:
|
|
|
69
58
|
- Upload Profile Picture
|
|
70
59
|
- Delete Account
|
|
71
60
|
|
|
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
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
- Optional: Custom CSS Properties
|
|
141
|
-
```
|
|
61
|
+
## Enrichment
|
|
62
|
+
Development:
|
|
63
|
+
- Redux State Connection
|
|
64
|
+
- Global Functions
|
|
65
|
+
Optional:
|
|
66
|
+
- CSS Custom Properties
|
|
67
|
+
|
|
68
|
+
## Website Components
|
|
69
|
+
Button:
|
|
70
|
+
- `<user-icon>`
|
|
71
|
+
- Email Log-in
|
|
72
|
+
- Email Subscribe
|
|
73
|
+
- Icon
|
|
74
|
+
Drop-down Drawer:
|
|
75
|
+
- `<user-drawer>`
|
|
76
|
+
- Email Log-in
|
|
77
|
+
- Email Subscribe
|
|
78
|
+
- Menu with Log-out
|
|
79
|
+
Pages:
|
|
80
|
+
- `<user-settings>`
|
|
81
|
+
- Account Settings
|
|
82
|
+
- `<user-login>`
|
|
83
|
+
- Email Log-in
|
|
84
|
+
- Email Subscribe
|
|
85
|
+
- `<email-reset>`
|
|
86
|
+
- Password Reset
|
|
87
|
+
|
|
88
|
+
## Observer Patterns
|
|
89
|
+
`<user-icon>`
|
|
90
|
+
- property: subscribe: (Initial State): Subscribe
|
|
91
|
+
- property: subscribe: else (Initial State): Login
|
|
92
|
+
- property: empty: location of empty image
|
|
93
|
+
`<user-drawer>`
|
|
94
|
+
- feature: Top-down drawer: 1.4 seconds
|
|
95
|
+
- property: url: location of `<pwa-settings>` Tag
|
|
96
|
+
- property: subscribe: (Initial State): Subscribe
|
|
97
|
+
- property: subscribe: else (Initial State): Login
|
|
98
|
+
`<user-login>`
|
|
99
|
+
- feature: regular visible page component
|
|
100
|
+
`<user-settings>`
|
|
101
|
+
- 1 Photo Upload Feature, view uploaded bucket of photos, photo ediotr
|
|
102
|
+
- empty property: location of empty image
|
|
103
|
+
- Unavailable Photo
|
|
104
|
+
- Update Username
|
|
105
|
+
- Update Email / Verify
|
|
106
|
+
- Update Password
|
|
107
|
+
- Delete Account, Photos, Information
|
|
108
|
+
|
|
109
|
+
## Logical States
|
|
110
|
+
`<user-icon>`
|
|
111
|
+
- state: Logged-out: txt: Login Button
|
|
112
|
+
- state: Logged-out: txt: Subscribe Button
|
|
113
|
+
- state: Logged-in: photo: Icon Button
|
|
114
|
+
`<user-drawer>`
|
|
115
|
+
- state: logged-out: Sign-up by Email Addresses and Password
|
|
116
|
+
- state: logged-out: Sign-in by Email Addresses and Password
|
|
117
|
+
- state: logged-in: Settings Page Link, Log-out Button
|
|
118
|
+
`<user-login>`
|
|
119
|
+
- state: logged-out: Sign-up by Email Addresses and Password
|
|
120
|
+
- state: logged-out: Sign-in by Email Addresses and Password
|
|
121
|
+
- state: logged-in: content: `<slot></slot>`
|
|
122
|
+
|
|
123
|
+
Implementation
|
|
124
|
+
===
|
|
125
|
+
|
|
126
|
+
## Firebase Instance Configuration
|
|
127
|
+
pwa-auth.js is built upon the Firebase SDK (Software Development Kit).
|
|
128
|
+
The entire bundle is one instance of firebase that takes in the configuration information, internally.
|
|
142
129
|
|
|
143
130
|
## Boilerplate
|
|
144
|
-
For HTML projects, copy js bundle to disk
|
|
145
|
-
- source/
|
|
146
|
-
- pwa-auth.js
|
|
147
|
-
- pwa-auth.js.map
|
|
148
|
-
- pwa-styles.css
|
|
149
|
-
- empty.jpg
|
|
150
131
|
```html
|
|
151
132
|
<head>
|
|
152
133
|
|
|
@@ -171,10 +152,88 @@ For HTML projects, copy js bundle to disk
|
|
|
171
152
|
if (lolalhost) { window.process = { env: { FIREBASE_CONFIG: 'etc.' } } }
|
|
172
153
|
</script>
|
|
173
154
|
|
|
174
|
-
<!--
|
|
155
|
+
<!-- Optional: Copy the Project Files from 'source' Folder -->
|
|
175
156
|
<script type="module" src="./path_to/pwa-auth.js"></script>
|
|
176
157
|
|
|
158
|
+
<!-- Optional: Custom CSS Properties -->
|
|
159
|
+
<style>
|
|
160
|
+
|
|
161
|
+
/* <user-icon> */
|
|
162
|
+
:root {
|
|
163
|
+
--pwa_icon_background_color: #6cc04a;
|
|
164
|
+
--pwa_icon_radius: 6px;
|
|
165
|
+
--pwa_icon_border: 2px solid black;
|
|
166
|
+
--pwa_icon_padding: 0px 16px;
|
|
167
|
+
--pwa_icon_hover_color: lightgrey;
|
|
168
|
+
--pwa_icon_font: 'Arial', sans-serif;
|
|
169
|
+
--pwa_icon_height: 32px; /* state: Logged-out (sync) */
|
|
170
|
+
--pwa_icon_diameter: 32px; /* state: Logged-in (sync) */
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
/* <user-drawer> */
|
|
174
|
+
:root {
|
|
175
|
+
--pwa_drawer_background_color: #fff;
|
|
176
|
+
--pwa_drawer_border-radius: 20px;
|
|
177
|
+
--pwa_drawer_border: 3px #303030 solid;
|
|
178
|
+
--pwa_drawer_z-index: 2;
|
|
179
|
+
--pwa_drawer_text_color: #303030;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
/* <user-settings> */
|
|
183
|
+
:root {
|
|
184
|
+
--pwa_settings_background_color: grey;
|
|
185
|
+
--pwa_nav_button_color: grey;
|
|
186
|
+
--pwa_nav_highlight_color: black;
|
|
187
|
+
--pwa_divider_color: grey;
|
|
188
|
+
--pwa_header_color: black;
|
|
189
|
+
--pwa_input_background_color: #E1E5EB;
|
|
190
|
+
--pwa_label_text_color: black;
|
|
191
|
+
--pwa_button_text_color: #fff;
|
|
192
|
+
--pwa_button_background_color: #6cc04a;
|
|
193
|
+
--pwa_button_border_color: #60b23e;
|
|
194
|
+
}
|
|
195
|
+
|
|
196
|
+
/* shared core elements */
|
|
197
|
+
:root {
|
|
198
|
+
--section_background_color: white;
|
|
199
|
+
}
|
|
200
|
+
|
|
201
|
+
</style>
|
|
202
|
+
|
|
177
203
|
</head>
|
|
204
|
+
|
|
205
|
+
<body>
|
|
206
|
+
<user-icon>
|
|
207
|
+
<user-drawer>
|
|
208
|
+
<user-login>
|
|
209
|
+
<user-settings>
|
|
210
|
+
<email-reset>
|
|
211
|
+
</body>
|
|
212
|
+
```
|
|
213
|
+
|
|
214
|
+
## Project Type: ECMA Script Modules
|
|
215
|
+
Eports: classes and objects
|
|
216
|
+
```javascript
|
|
217
|
+
// Custom HTML Element Classes
|
|
218
|
+
import 'pwa-auth';
|
|
219
|
+
// <user-icon subscribe emptyArtwork="./images/empty.jpg"></user-icon>
|
|
220
|
+
// <user-drawer subscribe settingsURL="./settings"></user-drawer>
|
|
221
|
+
// <user-settings emptyArtwork="./images/empty.jpg"></user-settings>
|
|
222
|
+
|
|
223
|
+
// Firebase Objects
|
|
224
|
+
import { db, storage, auth, user } from 'pwa-auth';
|
|
225
|
+
// db - firestore database reference
|
|
226
|
+
// storage - firebase storage reference
|
|
227
|
+
// auth - user object reference
|
|
228
|
+
// user - active user boolean reference
|
|
229
|
+
|
|
230
|
+
// Firebase-Redux States
|
|
231
|
+
import { store } from 'pwa-auth';
|
|
232
|
+
// store.verified
|
|
233
|
+
// store.userId
|
|
234
|
+
// store.name
|
|
235
|
+
// store.email
|
|
236
|
+
// store.photoURL
|
|
178
237
|
```
|
|
179
238
|
|
|
180
239
|
## Implementation - Drawer
|
|
@@ -210,65 +269,6 @@ For HTML projects, copy js bundle to disk
|
|
|
210
269
|
</body>
|
|
211
270
|
```
|
|
212
271
|
|
|
213
|
-
## CSS Custom Properties
|
|
214
|
-
```css
|
|
215
|
-
/* <user-icon> --> <button> */
|
|
216
|
-
:root {
|
|
217
|
-
--pwa_icon_background_color: #6cc04a;
|
|
218
|
-
--pwa_icon_radius: 6px;
|
|
219
|
-
--pwa_icon_border: 2px solid black;
|
|
220
|
-
--pwa_icon_padding: 0px 16px;
|
|
221
|
-
--pwa_icon_hover_color: lightgrey;
|
|
222
|
-
--pwa_icon_font: 'Arial', sans-serif;
|
|
223
|
-
--pwa_icon_height: 32px; /* state: Logged-out (sync) */
|
|
224
|
-
--pwa_icon_diameter: 32px; /* state: Logged-in (sync) */
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
/* <user-drawer> */
|
|
228
|
-
:root {
|
|
229
|
-
--pwa_drawer_background_color: #fff;
|
|
230
|
-
--pwa_drawer_border-radius: 20px;
|
|
231
|
-
--pwa_drawer_border: 3px #303030 solid;
|
|
232
|
-
--pwa_drawer_z-index: 2;
|
|
233
|
-
--pwa_drawer_text_color: #303030;
|
|
234
|
-
}
|
|
235
|
-
|
|
236
|
-
/* <user-settings> */
|
|
237
|
-
:root {
|
|
238
|
-
--pwa_settings_background_color: grey;
|
|
239
|
-
--pwa_nav_button_color: grey;
|
|
240
|
-
--pwa_nav_highlight_color: black;
|
|
241
|
-
--pwa_divider_color: grey;
|
|
242
|
-
--pwa_header_color: black;
|
|
243
|
-
--pwa_input_background_color: #E1E5EB;
|
|
244
|
-
--pwa_label_text_color: black;
|
|
245
|
-
--pwa_button_text_color: #fff;
|
|
246
|
-
--pwa_button_background_color: #6cc04a;
|
|
247
|
-
--pwa_button_border_color: #60b23e;
|
|
248
|
-
}
|
|
249
|
-
|
|
250
|
-
/* shared core elements */
|
|
251
|
-
:root {
|
|
252
|
-
--section_background_color: white;
|
|
253
|
-
}
|
|
254
|
-
```
|
|
255
|
-
|
|
256
|
-
## Global Namespaced Firebase Instance Configuration
|
|
257
|
-
pwa-auth.js is built upon the Firebase SDK (Software Development Kit).
|
|
258
|
-
The entire bundle is one instance of firebase that takes in the configuration information, internally.
|
|
259
|
-
|
|
260
|
-
## Project Bundles
|
|
261
|
-
```javascript
|
|
262
|
-
import './pwa-auth/source/development/pwa-auth';
|
|
263
|
-
import './pwa-auth/source/esm/pwa-auth';
|
|
264
|
-
```
|
|
265
|
-
|
|
266
|
-
## Technological Engineering
|
|
267
|
-
- Development (Server-side) Environment: [Node JavaScript](https://nodejs.org)
|
|
268
|
-
- Backend: Google Cloud: [Firebase](https://firebase.google.com/)
|
|
269
|
-
- Predicate State Behavior: [Redux](https://redux.js.org/)
|
|
270
|
-
- Frontend (Client-side): [Lit](https://lit.dev)
|
|
271
|
-
|
|
272
272
|
## Feedback
|
|
273
273
|
All feedback, comments, bugs, and requests are welcome.
|
|
274
274
|
* [Jack's Publishing](https://www.jackspublishing.com)
|
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
"url": "https://www.jackspublishing.com",
|
|
7
7
|
"email": "jack.solutionbox@gmail.com"
|
|
8
8
|
},
|
|
9
|
-
"version": "3.3.
|
|
9
|
+
"version": "3.3.7",
|
|
10
10
|
"description": "pwa-auth is a collection of four HTML webomponents for User Management to display a login button with icon picture state once logged in. Sign up and login within a drawer and optionally a static for a page. Being able to log out, change account details, and delete account.",
|
|
11
11
|
"homepage": "https://pwa-authentic.firebaseapp.com",
|
|
12
12
|
"repository": {
|