@open-xamu-co/firebase-nuxt 1.0.0-next.1

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.
Files changed (4) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/LICENSE +7 -0
  3. package/README.md +95 -0
  4. package/package.json +165 -0
package/CHANGELOG.md ADDED
@@ -0,0 +1,13 @@
1
+ Firebase nuxt
2
+
3
+ # 1.0.0-next.1 (2026-01-08)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * include upload worker ([00facd4](https://github.com/xamu-co/firebase-nuxt/commit/00facd4048c90f6f363b61c452175c48b7e92bfa))
9
+
10
+
11
+ ### Features
12
+
13
+ * initial commit ([a3e9a1d](https://github.com/xamu-co/firebase-nuxt/commit/a3e9a1d81d2b947216c0c2c1d48f03bdd4c3acb7))
package/LICENSE ADDED
@@ -0,0 +1,7 @@
1
+ Copyright 2023 @xamu-co
2
+
3
+ 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:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ 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/README.md ADDED
@@ -0,0 +1,95 @@
1
+ # Xamu nuxt firebase module
2
+
3
+ Powered by Nuxt.js
4
+
5
+ ## Prerequisites
6
+
7
+ See [Enviroment variables](#environment-variables)
8
+
9
+ A firebase service account would be required. You could find a sample on the discord server
10
+
11
+ See [Enviroment variables](#environment-variables)
12
+
13
+ ## Setup
14
+
15
+ Make sure to install the dependencies:
16
+
17
+ ```bash
18
+ yarn install
19
+ ```
20
+
21
+ ## Development
22
+
23
+ Start the development server on http://localhost:3000
24
+
25
+ ```bash
26
+ yarn dev
27
+ ```
28
+
29
+ When updating dependencies, make sure to check the lock file. Your dependencies could resolve to different versions than expected.
30
+
31
+ ## Production
32
+
33
+ Build the application for production:
34
+
35
+ ```bash
36
+ yarn build
37
+ ```
38
+
39
+ ## Extras
40
+
41
+ Due to an [issue with volar](https://github.com/vuejs/language-tools/issues/5018#issuecomment-2495098549), typescript version is fixed at @5.6.3
42
+
43
+ Firebase requires 2 keys, the private one from recaptcha, and the site key from recaptcha enterprise. The former one is passed from the config file.
44
+
45
+ It is required to manually authorize [IAM for App Hosting](https://stackoverflow.com/questions/79473624/firebase-app-hosting-unable-to-retrieve-secrets-from-cloud-secret-manager)
46
+
47
+ ```bash
48
+ # Replace secretName, backendName & userEmail
49
+ firebase apphosting:secrets:grantaccess secretName --backend backendName
50
+ # Also for emulation
51
+ firebase apphosting:secrets:grantaccess secretName --emails userEmail
52
+ ```
53
+
54
+ For app check create the key from Recaptcha v3 console instead of enterprise to avoid issues with legacy keys validation. The debug token allows bypassing the validation on dev environments
55
+
56
+ ### Enviroment variables
57
+
58
+ ```
59
+ # Firebase, public
60
+ F_API_KEY=
61
+ F_AUTH_DOMAIN="FIREBASE-PROJECT-ID.firebaseapp.com"
62
+ F_PROJECT_ID="FIREBASE-PROJECT-ID"
63
+ F_STORAGE_BUCKET="FIREBASE-PROJECT-ID.firebasestorage.app"
64
+ F_MESSAGING_SENDER_ID=
65
+ F_APP_ID=
66
+ F_MEASUREMENT_ID=
67
+ # Service account, private
68
+ F_PRIVATE_KEY=""
69
+ F_CLIENT_EMAIL=""
70
+ # App check, site key, public
71
+ RECAPTCHA_ENTERPRISE_SITE_KEY=
72
+
73
+ # Google fonts
74
+ FONTS_API_KEY=
75
+
76
+ # Project
77
+ ORIGIN=
78
+ COUNTRIES_API=
79
+ # Allow search engines to index the site
80
+ INDEXABLE=false
81
+ # Match instance locally
82
+ INSTANCE=""
83
+ # App name, this will override the site name on the head
84
+ APP_NAME=""
85
+
86
+ # Debugging
87
+ DEBUG_APP_CHECK=false
88
+ DEBUG_FIREBASE=false
89
+ # Compile css on runtime
90
+ DEBUG_CSS=false
91
+ # Enable nuxt devtools
92
+ DEBUG_NUXT=false
93
+ # Disable server cache
94
+ DEBUG_NITRO=false
95
+ ```
package/package.json ADDED
@@ -0,0 +1,165 @@
1
+ {
2
+ "name": "@open-xamu-co/firebase-nuxt",
3
+ "version": "1.0.0-next.1",
4
+ "description": "Nuxt 3 module for the xamu project",
5
+ "author": "@xamu-co",
6
+ "type": "module",
7
+ "repository": {
8
+ "type": "git",
9
+ "url": "git+https://github.com/xamu-co/firebase-nuxt.git"
10
+ },
11
+ "keywords": [
12
+ "nuxt layer firebase",
13
+ "nuxt layer",
14
+ "nuxt"
15
+ ],
16
+ "license": "MIT",
17
+ "bugs": {
18
+ "url": "https://github.com/xamu-co/firebase-nuxt/issues"
19
+ },
20
+ "homepage": "https://github.com/xamu-co/firebase-nuxt#readme",
21
+ "publishConfig": {
22
+ "access": "public",
23
+ "registry": "https://registry.npmjs.org/"
24
+ },
25
+ "scripts": {
26
+ "build": "yarn build:prepack && nuxt-module-build build",
27
+ "build:prepack": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
28
+ "dev": "nuxi dev playground",
29
+ "dev:build": "nuxi build playground",
30
+ "test": "vitest run",
31
+ "test:watch": "vitest watch",
32
+ "release": "semantic-release",
33
+ "release:dry": "semantic-release --dry-run",
34
+ "lint:eslint": "eslint --ext .ts,.js,.vue --ignore-path .prettierignore .",
35
+ "lint:prettier": "prettier . --check --ignore-unknown",
36
+ "lint:stylelint": "node scripts/stylelint.cjs",
37
+ "lint": "yarn lint:eslint && yarn lint:prettier && yarn lint:stylelint",
38
+ "typecheck": "yarn build:prepack",
39
+ "prepare": "node .husky/install.mjs && nuxt-module-build prepare"
40
+ },
41
+ "packageManager": "yarn@4.8.0",
42
+ "engines": {
43
+ "node": ">=20.19.3"
44
+ },
45
+ "exports": {
46
+ ".": {
47
+ "types": "./dist/types.d.mts",
48
+ "import": "./dist/module.mjs",
49
+ "default": "./dist/module.mjs"
50
+ },
51
+ "./client": {
52
+ "types": "./dist/runtime/client/types/index.d.ts",
53
+ "import": "./dist/runtime/client/types/index.d.ts",
54
+ "default": "./dist/runtime/client/types/index.d.ts"
55
+ },
56
+ "./client/*": {
57
+ "types": "./dist/runtime/client/*.d.ts",
58
+ "import": "./dist/runtime/client/*.ts",
59
+ "default": "./dist/runtime/client/*.ts"
60
+ },
61
+ "./functions": {
62
+ "types": "./dist/runtime/functions/types/index.d.ts",
63
+ "import": "./dist/runtime/functions/types/index.d.ts",
64
+ "default": "./dist/runtime/functions/types/index.d.ts"
65
+ },
66
+ "./functions/*": {
67
+ "types": "./dist/runtime/functions/*.d.ts",
68
+ "import": "./dist/runtime/functions/*.ts",
69
+ "default": "./dist/runtime/functions/*.ts"
70
+ },
71
+ "./server": {
72
+ "types": "./dist/runtime/server/types/index.d.ts",
73
+ "import": "./dist/runtime/server/types/index.d.ts",
74
+ "default": "./dist/runtime/server/types/index.d.ts"
75
+ },
76
+ "./server/*": {
77
+ "types": "./dist/runtime/server/*.d.ts",
78
+ "import": "./dist/runtime/server/*.ts",
79
+ "default": "./dist/runtime/server/*.ts"
80
+ }
81
+ },
82
+ "files": [
83
+ "dist"
84
+ ],
85
+ "dependencies": {
86
+ "@nuxt/kit": "^3.20.2",
87
+ "@open-xamu-co/ui-common-enums": "^4.0.0-next.1",
88
+ "@open-xamu-co/ui-common-helpers": "^4.0.0-next.2",
89
+ "@open-xamu-co/ui-nuxt": "^4.0.0-next.4",
90
+ "@pinia/nuxt": "^0.11.0",
91
+ "firebase": "^11.0.2",
92
+ "firebase-admin": "^13.6.0",
93
+ "firebase-functions": "^6.6.0",
94
+ "lodash-es": "^4.17.21",
95
+ "nuxt-csurf": "^1.6.5",
96
+ "pinia": "^3.0.2",
97
+ "vue-router-better-scroller": "^0.0.0"
98
+ },
99
+ "devDependencies": {
100
+ "@commitlint/cli": "^9.1.1",
101
+ "@commitlint/config-conventional": "^9.1.1",
102
+ "@firebase/app-types": "^0.9.0",
103
+ "@nuxt/module-builder": "^1.0.2",
104
+ "@nuxt/schema": "^3.20.2",
105
+ "@nuxt/test-utils": "^3.21.0",
106
+ "@open-xamu-co/eslint-config": "^3.0.1",
107
+ "@open-xamu-co/ui-common-types": "^4.0.0-next.3",
108
+ "@open-xamu-co/ui-styles": "^5.0.0-next.2",
109
+ "@semantic-release/changelog": "^6.0.3",
110
+ "@semantic-release/exec": "^7.0.3",
111
+ "@semantic-release/git": "^10.0.1",
112
+ "@types/accept-language-parser": "^1.5.8",
113
+ "@types/lodash-es": "^4",
114
+ "@typescript-eslint/eslint-plugin": "^6.15.0",
115
+ "@typescript-eslint/parser": "^6.15.0",
116
+ "cross-env": "^10.1.0",
117
+ "cssnano": "^6.0.1",
118
+ "cssnano-preset-advanced": "^6.0.1",
119
+ "eslint": "^8.56.0",
120
+ "eslint-config-prettier": "^8.8.0",
121
+ "eslint-import-resolver-typescript": "^3.5.5",
122
+ "eslint-plugin-import": "^2.27.5",
123
+ "eslint-plugin-prettier": "^5.0.0",
124
+ "eslint-plugin-vue": "^9.15.1",
125
+ "husky": "^9.1.7",
126
+ "lint-staged": "^16.2.7",
127
+ "nuxi": "^3.31.2",
128
+ "nuxt": "^3.20.2",
129
+ "postcss": "^8.5.6",
130
+ "postcss-cli": "^11.0.1",
131
+ "postcss-html": "^1.8.0",
132
+ "postcss-merge-at-rules": "vis97c/postcss-merge-at-rules",
133
+ "postcss-precision": "vis97c/postcss-precision",
134
+ "postcss-preset-env": "^8.4.1",
135
+ "postcss-scss": "^4.0.9",
136
+ "postcss-sort-media-queries": "^5.2.0",
137
+ "prettier": "^3.7.4",
138
+ "sass": "^1.97.0",
139
+ "semantic-release": "^24.2.3",
140
+ "semantic-release-yarn": "^3.0.2",
141
+ "stylelint": "^16.26.1",
142
+ "stylelint-config-recommended-scss": "^16.0.2",
143
+ "stylelint-config-recommended-vue": "^1.6.1",
144
+ "stylelint-config-standard-scss": "^16.0.0",
145
+ "stylelint-prettier": "^5.0.3",
146
+ "typescript": "^5.9.3",
147
+ "vitest": "^4.0.16",
148
+ "vue-tsc": "^3.2.1"
149
+ },
150
+ "lint-staged": {
151
+ "*.{ts,js,vue}": [
152
+ "eslint --fix",
153
+ "prettier --write"
154
+ ]
155
+ },
156
+ "commitlint": {
157
+ "extends": [
158
+ "@commitlint/config-conventional"
159
+ ]
160
+ },
161
+ "browserslist": [
162
+ "defaults"
163
+ ],
164
+ "stableVersion": "0.0.1"
165
+ }