@thzero/library_client_firebase 0.18.24 → 0.18.26

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 CHANGED
@@ -1,117 +1,117 @@
1
- ![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_client_firebase)
2
- ![David](https://img.shields.io/david/thzero/library_client_firebase)
3
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
-
5
- # library_client_firebase
6
-
7
- ## Requirements
8
-
9
- ### NodeJs
10
-
11
- [NodeJs](https://nodejs.org) version 18+
12
-
13
- ## Installation
14
-
15
- [![NPM](https://nodei.co/npm/@thzero/library_client_firebase.png?compact=true)](https://npmjs.org/package/@thzero/library_client_firebase)
16
-
17
- ## Configuration
18
-
19
- ### Firebase
20
-
21
- Google Firebase (https://firebase.google.com) provides the social based authentication; currently only Google social accounts are supported.
22
-
23
- * Add a new project
24
- * If not already completed when setting up the server application
25
- * Setup **Authentication**, enabled Google in the **Sign-in method**.
26
- * If not already completed when setting up the server application
27
- * Get the Firebase SDK configuration
28
- * Go to Project Overview->Settings->General
29
- * Click **Add App** and select **Web**
30
- * Click *Firebase SDK snippet*, select **Config*
31
- * Select the JSON object and store it
32
- * The contents of the JSON object will be stored as key/value pairs in the external/firebase confib object (below)
33
- * Supports Firebase Analytics.
34
- * Go to Project Overview->Settings->Integrations
35
- * Enable the Google Analytics.
36
- * Copy the 'measurementId' key//value pair into the external/firebase config object (below)
37
-
38
- ### Application Configuration
39
-
40
- * In the configuration files (development.json and production.json) of the application
41
- * Add the following onfiguration block to contain the firebase key.
42
-
43
- ```
44
- ,
45
- "external": {
46
- "firebase": <firebase key JSON object from above goes here>
47
- }
48
- ```
49
-
50
- ### Locales
51
-
52
- Merge the following to the 'src/locals/en/index.json' file:
53
-
54
- ```
55
- {
56
- "admin": {
57
- "users": "Users"
58
- },
59
- "forms": {
60
- "externalId": "External Id",
61
- "news": {
62
- "requiresAuth": "Requires Authentication",
63
- },
64
- "role": "Role",
65
- "roles": "Roles",
66
- },
67
- "news": {
68
- "requiresAuth": "Authenticated",
69
- },
70
- "users": {
71
- "actions": "Actions",
72
- "externalId": "External Id",
73
- "id": "Id",
74
- "name": "Name",
75
- "role": "Role",
76
- "roles": "Roles"
77
- }
78
- }
79
- ```
80
-
81
- ### Main.js
82
-
83
- * Add the following import statement to the 'main.js' file.
84
-
85
- ```
86
- import bootStarter from '@thzero/library_client_firebase/boot/starter';
87
- ```
88
-
89
- * Adjust the start method of the 'main.js' file to iclude 'bootAuth' as the last parameter.
90
-
91
- ```
92
- start(app, router, store, vuetify, [ ... ], bootStarter);
93
- ```
94
-
95
- ### Route.js
96
-
97
- Routes can be denoted as not requiring authentication. To do so, tag on the route the following in the 'meta node'.
98
-
99
- ```
100
- requiresAuth: false
101
- ```
102
-
103
- It is advised that the following routes should have authentication turned off.
104
-
105
- * Home
106
- * About
107
- * Open Source
108
- * Auth
109
- * Not Found
110
- * Blank
111
-
112
- It is advised that the following routes should have authentication turned on.
113
-
114
- * Admin
115
- * Settings
116
- * Support
117
- * Any application routes that require authenticated users.
1
+ ![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_client_firebase)
2
+ ![David](https://img.shields.io/david/thzero/library_client_firebase)
3
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
4
+
5
+ # library_client_firebase
6
+
7
+ ## Requirements
8
+
9
+ ### NodeJs
10
+
11
+ [NodeJs](https://nodejs.org) version 18+
12
+
13
+ ## Installation
14
+
15
+ [![NPM](https://nodei.co/npm/@thzero/library_client_firebase.png?compact=true)](https://npmjs.org/package/@thzero/library_client_firebase)
16
+
17
+ ## Configuration
18
+
19
+ ### Firebase
20
+
21
+ Google Firebase (https://firebase.google.com) provides the social based authentication; currently only Google social accounts are supported.
22
+
23
+ * Add a new project
24
+ * If not already completed when setting up the server application
25
+ * Setup **Authentication**, enabled Google in the **Sign-in method**.
26
+ * If not already completed when setting up the server application
27
+ * Get the Firebase SDK configuration
28
+ * Go to Project Overview->Settings->General
29
+ * Click **Add App** and select **Web**
30
+ * Click *Firebase SDK snippet*, select **Config*
31
+ * Select the JSON object and store it
32
+ * The contents of the JSON object will be stored as key/value pairs in the external/firebase confib object (below)
33
+ * Supports Firebase Analytics.
34
+ * Go to Project Overview->Settings->Integrations
35
+ * Enable the Google Analytics.
36
+ * Copy the 'measurementId' key//value pair into the external/firebase config object (below)
37
+
38
+ ### Application Configuration
39
+
40
+ * In the configuration files (development.json and production.json) of the application
41
+ * Add the following onfiguration block to contain the firebase key.
42
+
43
+ ```
44
+ ,
45
+ "external": {
46
+ "firebase": <firebase key JSON object from above goes here>
47
+ }
48
+ ```
49
+
50
+ ### Locales
51
+
52
+ Merge the following to the 'src/locals/en/index.json' file:
53
+
54
+ ```
55
+ {
56
+ "admin": {
57
+ "users": "Users"
58
+ },
59
+ "forms": {
60
+ "externalId": "External Id",
61
+ "news": {
62
+ "requiresAuth": "Requires Authentication",
63
+ },
64
+ "role": "Role",
65
+ "roles": "Roles",
66
+ },
67
+ "news": {
68
+ "requiresAuth": "Authenticated",
69
+ },
70
+ "users": {
71
+ "actions": "Actions",
72
+ "externalId": "External Id",
73
+ "id": "Id",
74
+ "name": "Name",
75
+ "role": "Role",
76
+ "roles": "Roles"
77
+ }
78
+ }
79
+ ```
80
+
81
+ ### Main.js
82
+
83
+ * Add the following import statement to the 'main.js' file.
84
+
85
+ ```
86
+ import bootStarter from '@thzero/library_client_firebase/boot/starter';
87
+ ```
88
+
89
+ * Adjust the start method of the 'main.js' file to iclude 'bootAuth' as the last parameter.
90
+
91
+ ```
92
+ start(app, router, store, vuetify, [ ... ], bootStarter);
93
+ ```
94
+
95
+ ### Route.js
96
+
97
+ Routes can be denoted as not requiring authentication. To do so, tag on the route the following in the 'meta node'.
98
+
99
+ ```
100
+ requiresAuth: false
101
+ ```
102
+
103
+ It is advised that the following routes should have authentication turned off.
104
+
105
+ * Home
106
+ * About
107
+ * Open Source
108
+ * Auth
109
+ * Not Found
110
+ * Blank
111
+
112
+ It is advised that the following routes should have authentication turned on.
113
+
114
+ * Admin
115
+ * Settings
116
+ * Support
117
+ * Any application routes that require authenticated users.
package/boot/starter.js CHANGED
@@ -1,51 +1,51 @@
1
- // import { initializeApp } from 'firebase/app';
2
- // import { getAuth } from "firebase/auth";
3
- // import { getAnalytics } from "firebase/analytics";
4
-
5
- import LibraryClientConstants from '@thzero/library_client/constants';
6
-
7
- import LibraryClientUtility from '@thzero/library_client/utility/index';
8
- import LibraryCommonUtility from '@thzero/library_common/utility/index';
9
-
10
- // import config from 'local-config';
11
-
12
- // export default async ({
13
- export default async ({router}) => {
14
- const auth = LibraryClientUtility.$injector.getService(LibraryClientConstants.InjectorKeys.SERVICE_AUTH);
15
- return await auth.initialize(LibraryCommonUtility.correlationId(), router);
16
- // const configExternal = config.external;
17
- // if (!configExternal)
18
- // throw Error('Invalid external config.');
19
- // const configFirebase = configExternal.firebase;
20
- // if (!configFirebase)
21
- // throw Error('Invalid firebase config.');
22
- // initializeApp(configFirebase);
23
- // if (configFirebase.measurementId)
24
- // getAnalytics();
25
-
26
- // let outsideResolve;
27
- // let outsideReject;
28
- // const promiseAuth = new Promise(function(resolve, reject) {
29
- // outsideResolve = resolve;
30
- // outsideReject = reject;
31
- // });
32
-
33
- // const firebaseAuth = getAuth();
34
- // // eslint-disable-next-line
35
- // let init = false;
36
- // firebaseAuth.onAuthStateChanged(async function(user) {
37
- // const auth = LibraryClientUtility.$injector.getService(LibraryClientConstants.InjectorKeys.SERVICE_AUTH);
38
- // await auth.onAuthStateChanged(user);
39
- // if (!init) {
40
- // init = true;
41
- // outsideResolve(true);
42
- // return;
43
- // }
44
-
45
- // outsideReject();
46
- // });
47
-
48
- // setup();
49
-
50
- // return promiseAuth;
51
- };
1
+ // import { initializeApp } from 'firebase/app';
2
+ // import { getAuth } from "firebase/auth";
3
+ // import { getAnalytics } from "firebase/analytics";
4
+
5
+ import LibraryClientConstants from '@thzero/library_client/constants';
6
+
7
+ import LibraryClientUtility from '@thzero/library_client/utility/index';
8
+ import LibraryCommonUtility from '@thzero/library_common/utility/index';
9
+
10
+ // import config from 'local-config';
11
+
12
+ // export default async ({
13
+ export default async ({router}) => {
14
+ const auth = LibraryClientUtility.$injector.getService(LibraryClientConstants.InjectorKeys.SERVICE_AUTH);
15
+ return await auth.initialize(LibraryCommonUtility.correlationId(), router);
16
+ // const configExternal = config.external;
17
+ // if (!configExternal)
18
+ // throw Error('Invalid external config.');
19
+ // const configFirebase = configExternal.firebase;
20
+ // if (!configFirebase)
21
+ // throw Error('Invalid firebase config.');
22
+ // initializeApp(configFirebase);
23
+ // if (configFirebase.measurementId)
24
+ // getAnalytics();
25
+
26
+ // let outsideResolve;
27
+ // let outsideReject;
28
+ // const promiseAuth = new Promise(function(resolve, reject) {
29
+ // outsideResolve = resolve;
30
+ // outsideReject = reject;
31
+ // });
32
+
33
+ // const firebaseAuth = getAuth();
34
+ // // eslint-disable-next-line
35
+ // let init = false;
36
+ // firebaseAuth.onAuthStateChanged(async function(user) {
37
+ // const auth = LibraryClientUtility.$injector.getService(LibraryClientConstants.InjectorKeys.SERVICE_AUTH);
38
+ // await auth.onAuthStateChanged(user);
39
+ // if (!init) {
40
+ // init = true;
41
+ // outsideResolve(true);
42
+ // return;
43
+ // }
44
+
45
+ // outsideReject();
46
+ // });
47
+
48
+ // setup();
49
+
50
+ // return promiseAuth;
51
+ };
package/license.md CHANGED
@@ -1,9 +1,9 @@
1
- MIT License
2
-
3
- Copyright (c) 2020-2025 thZero.com
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
-
7
- The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
-
1
+ MIT License
2
+
3
+ Copyright (c) 2020-2026 thZero.com
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
+
7
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
9
  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
package/openSource.js CHANGED
@@ -1,32 +1,32 @@
1
- export default () => {
2
- return [
3
- {
4
- category: 'client',
5
- name: '@thzero/library_client',
6
- url: 'https://github.com/thzero/library_client',
7
- licenseName: 'MIT',
8
- licenseUrl: 'https://github.com/thzero/library_client/blob/master/license.md'
9
- },
10
- {
11
- category: 'client',
12
- name: '@thzero/library_client_firebase',
13
- url: 'https://github.com/thzero/library_client_firebase',
14
- licenseName: 'MIT',
15
- licenseUrl: 'https://github.com/thzero/library_client_firebase/blob/master/license.md'
16
- },
17
- {
18
- category: 'client',
19
- name: '@thzero/library_common',
20
- url: 'https://github.com/thzero/library_common',
21
- licenseName: 'MIT',
22
- licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
23
- },
24
- {
25
- category: 'client',
26
- name: 'firebase',
27
- url: 'https://github.com/firebase/firebase-js-sdk',
28
- licenseName: 'MIT',
29
- licenseUrl: 'https://github.com/firebase/firebase-js-sdk/blob/master/LICENSE'
30
- }
31
- ];
1
+ export default () => {
2
+ return [
3
+ {
4
+ category: 'client',
5
+ name: '@thzero/library_client',
6
+ url: 'https://github.com/thzero/library_client',
7
+ licenseName: 'MIT',
8
+ licenseUrl: 'https://github.com/thzero/library_client/blob/master/license.md'
9
+ },
10
+ {
11
+ category: 'client',
12
+ name: '@thzero/library_client_firebase',
13
+ url: 'https://github.com/thzero/library_client_firebase',
14
+ licenseName: 'MIT',
15
+ licenseUrl: 'https://github.com/thzero/library_client_firebase/blob/master/license.md'
16
+ },
17
+ {
18
+ category: 'client',
19
+ name: '@thzero/library_common',
20
+ url: 'https://github.com/thzero/library_common',
21
+ licenseName: 'MIT',
22
+ licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
23
+ },
24
+ {
25
+ category: 'client',
26
+ name: 'firebase',
27
+ url: 'https://github.com/firebase/firebase-js-sdk',
28
+ licenseName: 'MIT',
29
+ licenseUrl: 'https://github.com/firebase/firebase-js-sdk/blob/master/LICENSE'
30
+ }
31
+ ];
32
32
  }
package/package.json CHANGED
@@ -1,29 +1,29 @@
1
- {
2
- "name": "@thzero/library_client_firebase",
3
- "version": "0.18.24",
4
- "version_major": 0,
5
- "version_minor": 18,
6
- "version_patch": 24,
7
- "version_date": "12/30/2025",
8
- "author": "thZero",
9
- "license": "MIT",
10
- "repository": {
11
- "type": "git",
12
- "url": "git+https://github.com/thzero/library_client_firebase.git"
13
- },
14
- "bugs": {
15
- "url": "https://github.com/thzero/library_client_firebase/issues"
16
- },
17
- "homepage": "https://github.com/thzero/library_client_firebase#readme",
18
- "scripts": {
19
- "cli-update": "library-cli --updateversion --pi",
20
- "test": "echo \"Error: no test specified\" && exit 1"
21
- },
22
- "dependencies": {
23
- "firebase": "^12.7.0"
24
- },
25
- "peerDependencies": {
26
- "@thzero/library_client": "^0.18",
27
- "@thzero/library_common": "^0.18"
28
- }
1
+ {
2
+ "name": "@thzero/library_client_firebase",
3
+ "version": "0.18.26",
4
+ "version_major": 0,
5
+ "version_minor": 18,
6
+ "version_patch": 26,
7
+ "version_date": "02/06/2026",
8
+ "author": "thZero",
9
+ "license": "MIT",
10
+ "repository": {
11
+ "type": "git",
12
+ "url": "git+https://github.com/thzero/library_client_firebase.git"
13
+ },
14
+ "bugs": {
15
+ "url": "https://github.com/thzero/library_client_firebase/issues"
16
+ },
17
+ "homepage": "https://github.com/thzero/library_client_firebase#readme",
18
+ "scripts": {
19
+ "cli-update": "library-cli --updateversion --pi",
20
+ "test": "echo \"Error: no test specified\" && exit 1"
21
+ },
22
+ "dependencies": {
23
+ "firebase": "^12.8.0"
24
+ },
25
+ "peerDependencies": {
26
+ "@thzero/library_client": "^0.18",
27
+ "@thzero/library_common": "^0.18"
28
+ }
29
29
  }