sveltekit-firebase-helpers 0.0.4 → 0.0.6

package/README.md

@@ -54,6 +54,8 @@ import { options } from './firebase'
 export const handle = createOptionsHandle(options)
 ```
 
+Optionally pass an additional number of seconds to the `createOptionsHandle` call to publicly cache the response (default = 300, set 0 to disable).
+
 Example `options.ts`:
 
 ```ts
@@ -88,7 +90,7 @@ You can test the handle is working correctly by requesting the `/__/firebase/ini
 To proxy auth requests so you can use `signInWithRedirect` on browsers that block 3rd party cookies (now all of them) use `createAuthHandle` passing in the `application-id.firebaseapp.com` domain name from you Firebase app config, e.g. `captaincodeman-experiment.firebaseapp.com`.
 
 ```ts
-import { createOptionsHandle } from "sveltekit-firebase-helpers";
+import { createProxyHandle } from "sveltekit-firebase-helpers";
 import { env } from '$env/dynamic/public'
 
 const auth_domain = env.PUBLIC_FIREBASE_AUTH_DOMAIN
@@ -98,6 +100,15 @@ export const handle = createProxyHandle(auth_domain)
 
 Any requests to `/__/auth/...` will be proxied to the `auth_domain` configured, effectively making your app serve the firebase auth endpoints itself to get around the 3rd party cookie restrictions.
 
+If you need to set any additional http headers you can pass an optional `HeadersInit` as a separate object, e.g.:
+
+```ts
+export const handle = createProxyHandle(
+	auth_domain,
+	{ 'Cross-Origin-Embedder-Policy': 'require-corp' }
+)
+```
+
 #### Combined Handle
 
 An alternative is to use a single combined `createHandle` function that will add each individual handle if the property it needs is included.
@@ -112,7 +123,16 @@ import { auth } from './routes/firebase-server'
 
 const auth_domain = env.PUBLIC_FIREBASE_AUTH_DOMAIN
 
-export const handle = createHandle({ auth, options, auth_domain })
+// optional additional http response headers
+const init = { 'Cross-Origin-Embedder-Policy': 'require-corp' }
+
+export const handle = createHandle({
+  auth,
+  options,
+  max_age: 86400,
+  auth_domain,
+  init,
+})
 ```
 
 ### Service Worker
@@ -160,3 +180,7 @@ One additional advantage of this is that your client-side auth dependencies are
 When using `signInWithRedirect` your page loads and will automatically handle the redirect token or you may call `getRedirectResult` to get the result yourself. At this point, your SvelteKit `load` functions will have already run with an unauthenticated user so to update your app data you may need to call `invalidateAll` to re-run the load functions. But because of the polling delay, the service-worker may not have the auth token yet so we've provided a `syncAuthToken` method that will send it to the client - call it before the `invalidateAll`.
 
 The same situation happens if you update the auth claims on the server inside any endpoint or form action. You can use `syncAuthToken` to ensure that any `invalidateAll` call will include the latest token when data is refreshed from the server.
+
+## Project configuration
+
+TODO: detail project configutation for local development with and without Firebase Auth Emulator, and what .env settings should be used.

package/dist/index.d.ts

@@ -7,13 +7,14 @@ declare function syncAuthToken(auth: Auth): Promise<void>;
 
 declare function createAuthHandle(auth: Auth$1): Handle;
 
-declare function createOptionsHandle(options: FirebaseOptions): Handle;
+declare function createOptionsHandle(options: FirebaseOptions, max_age?: number): Handle;
 
 declare function createProxyHandle(auth_domain: string, init?: HeadersInit): Handle;
 
 declare function createHandle(config: {
     auth?: Auth$1;
     options?: FirebaseOptions;
+    max_age?: number;
     auth_domain?: string;
     init?: HeadersInit;
 }): Handle;
@@ -27,7 +28,7 @@ declare global {
 }
 
 /// <reference no-default-lib="true"/>
-declare function addFirebaseAuth(config: {
+declare function addFirebaseAuth(config?: {
     auth_emulator?: string;
 }): void;
 

package/dist/index.js

@@ -1 +1 @@
-import{getIdToken as k}from"firebase/auth";async function C(t){if(t.currentUser){let o=await k(t.currentUser,!0),{serviceWorker:n}=navigator,{controller:r}=n;r&&await new Promise(c=>{n.addEventListener("message",()=>c(),{once:!0}),r.postMessage({type:"useToken",useToken:o})})}}function y(t){return async({event:n,resolve:r})=>{let{locals:c,request:e}=n,s=e.headers.get("Authorization")?.split("Bearer ")[1];if(s)try{c.user=await t.verifyIdToken(s)}catch(a){console.error(a)}return r(n)}}var g=globalThis.process?.env?.NODE_ENV,_=g&&!g.toLowerCase().startsWith("prod");function w(t,o){let n=JSON.stringify(t),r=new Headers(o?.headers);return r.has("content-length")||r.set("content-length",b.encode(n).byteLength.toString()),r.has("content-type")||r.set("content-type","application/json"),new Response(n,{...o,headers:r})}var b=new TextEncoder;function H(t){return async({event:n,resolve:r})=>{let{request:c,url:e}=n;return c.method==="GET"&&e.pathname.startsWith("/__/firebase/init.json")?w(t):r(n)}}function T(t,o){return async({event:r,resolve:c})=>{let{request:e,url:i}=r;if(e.method==="GET"&&i.pathname.startsWith("/__/auth/")){i.host=t,i.port="443";let s=await fetch(i,{headers:{"Accept-Encoding":"identity"}}),a=await s.text(),f=new Headers({...o,"Cache-Control":s.headers.get("Cache-Control"),"Content-Type":s.headers.get("Content-Type"),Vary:"accept-encoding"});return new Response(a,{headers:f})}return c(r)}}function l(...t){let o=t.length;return o?({event:n,resolve:r})=>{return c(0,n,{});function c(e,i,s){let a=t[e];return a({event:i,resolve:(f,u)=>{let h=async({html:d,done:x})=>(u?.transformPageChunk&&(d=await u.transformPageChunk({html:d,done:x})??""),s?.transformPageChunk&&(d=await s.transformPageChunk({html:d,done:x})??""),d),p=s?.filterSerializedResponseHeaders??u?.filterSerializedResponseHeaders,m=s?.preload??u?.preload;return e<o-1?c(e+1,f,{transformPageChunk:h,filterSerializedResponseHeaders:p,preload:m}):r(f,{transformPageChunk:h,filterSerializedResponseHeaders:p,preload:m})}})}}:({event:n,resolve:r})=>r(n)}function ye(t){let o=[];return t.auth&&o.push(y(t.auth)),t.options&&o.push(H(t.options)),t.auth_domain&&o.push(T(t.auth_domain,t.init)),l(...o)}import{initializeApp as E}from"firebase/app";import{getIdToken as R,initializeAuth as S,connectAuthEmulator as j,indexedDBLocalPersistence as O}from"firebase/auth";function He(t){let o=new Promise(async(e,i)=>{let a=await(await fetch("/__/firebase/init.json")).json(),f=E(a),u=S(f,{persistence:[O]});t.auth_emulator&&j(u,t.auth_emulator),await u.authStateReady(),e(u)}),n;self.addEventListener("message",e=>{function i(){self.clients.matchAll({}).then(function(s){s&&s.length&&s[0].postMessage({ack:!0})})}if(e.data)switch(e.data.type){case"useToken":n=e.data.useToken,i(),setTimeout(()=>n=void 0,5e3);break}});async function r(){let e=await o;if(e.currentUser)try{return await R(e.currentUser)}catch{return null}else return null}async function c(e){try{if(e.method!=="GET")if(e.headers.get("Content-Type")?.indexOf("json")!==-1){let i=await e.json();return JSON.stringify(i)}else return e.text()}catch{}}self.addEventListener("fetch",e=>{if(new URL(e.request.url).origin!==location.origin)return;async function s(){let a=e.request,f=n??await r();if(f){let u=new Headers(a.headers);u.append("Authorization","Bearer "+f);let h=await c(a);try{a=new Request(a.url,{method:a.method,headers:u,mode:"same-origin",credentials:a.credentials,cache:a.cache,redirect:a.redirect,referrer:a.referrer,body:h})}catch{}}return fetch(a)}e.respondWith(s())})}export{He as addFirebaseAuth,y as createAuthHandle,ye as createHandle,H as createOptionsHandle,T as createProxyHandle,C as syncAuthToken};
+import{getIdToken as k}from"firebase/auth";async function W(t){if(t.currentUser){let n=await k(t.currentUser,!0),{serviceWorker:s}=navigator,{controller:r}=s;r&&await new Promise(c=>{s.addEventListener("message",()=>c(),{once:!0}),r.postMessage({type:"useToken",useToken:n})})}}function y(t){return async({event:s,resolve:r})=>{let{locals:c,request:e}=s,o=e.headers.get("Authorization")?.split("Bearer ")[1];if(o)try{c.user=await t.verifyIdToken(o)}catch(i){console.error(i)}return r(s)}}var g=globalThis.process?.env?.NODE_ENV,_=g&&!g.toLowerCase().startsWith("prod");function w(t,n){let s=JSON.stringify(t),r=new Headers(n?.headers);return r.has("content-length")||r.set("content-length",b.encode(s).byteLength.toString()),r.has("content-type")||r.set("content-type","application/json"),new Response(s,{...n,headers:r})}var b=new TextEncoder;function H(t,n=300){return async({event:r,resolve:c})=>{let{request:e,setHeaders:a,url:o}=r;return e.method==="GET"&&o.pathname.startsWith("/__/firebase/init.json")?(n&&a({"Cache-Control":`public, max-age: ${n}`}),w(t)):c(r)}}function T(t,n){return async({event:r,resolve:c})=>{let{request:e,url:a}=r;if(e.method==="GET"&&a.pathname.startsWith("/__/auth/")){a.host=t,a.port="443";let o=await fetch(a,{headers:{"Accept-Encoding":"identity"}}),i=await o.text(),f=new Headers({...n,"Cache-Control":o.headers.get("Cache-Control"),"Content-Type":o.headers.get("Content-Type"),Vary:"accept-encoding"});return new Response(i,{headers:f})}return c(r)}}function l(...t){let n=t.length;return n?({event:s,resolve:r})=>{return c(0,s,{});function c(e,a,o){let i=t[e];return i({event:a,resolve:(f,u)=>{let h=async({html:d,done:x})=>(u?.transformPageChunk&&(d=await u.transformPageChunk({html:d,done:x})??""),o?.transformPageChunk&&(d=await o.transformPageChunk({html:d,done:x})??""),d),p=o?.filterSerializedResponseHeaders??u?.filterSerializedResponseHeaders,m=o?.preload??u?.preload;return e<n-1?c(e+1,f,{transformPageChunk:h,filterSerializedResponseHeaders:p,preload:m}):r(f,{transformPageChunk:h,filterSerializedResponseHeaders:p,preload:m})}})}}:({event:s,resolve:r})=>r(s)}function ye(t){let n=[];return t.auth&&n.push(y(t.auth)),t.options&&n.push(H(t.options,t.max_age)),t.auth_domain&&n.push(T(t.auth_domain,t.init)),l(...n)}import{initializeApp as E}from"firebase/app";import{getIdToken as R,initializeAuth as S,connectAuthEmulator as j,indexedDBLocalPersistence as O}from"firebase/auth";function He(t){let n=new Promise(async(e,a)=>{let i=await(await fetch("/__/firebase/init.json")).json(),f=E(i),u=S(f,{persistence:[O]});t?.auth_emulator&&j(u,t.auth_emulator),await u.authStateReady(),e(u)}),s;self.addEventListener("message",e=>{function a(){self.clients.matchAll({}).then(function(o){o&&o.length&&o[0].postMessage({ack:!0})})}if(e.data)switch(e.data.type){case"useToken":s=e.data.useToken,a(),setTimeout(()=>s=void 0,5e3);break}});async function r(){let e=await n;if(e.currentUser)try{return await R(e.currentUser)}catch{return null}else return null}async function c(e){try{if(e.method!=="GET")if(e.headers.get("Content-Type")?.indexOf("json")!==-1){let a=await e.json();return JSON.stringify(a)}else return e.text()}catch{}}self.addEventListener("fetch",e=>{if(new URL(e.request.url).origin!==location.origin)return;async function o(){let i=e.request,f=s??await r();if(f){let u=new Headers(i.headers);u.append("Authorization","Bearer "+f);let h=await c(i);try{i=new Request(i.url,{method:i.method,headers:u,mode:"same-origin",credentials:i.credentials,cache:i.cache,redirect:i.redirect,referrer:i.referrer,body:h})}catch{}}return fetch(i)}e.respondWith(o())})}export{He as addFirebaseAuth,y as createAuthHandle,ye as createHandle,H as createOptionsHandle,T as createProxyHandle,W as syncAuthToken};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sveltekit-firebase-helpers",
   "description": "Helpers for using Firebase with SvelteKit",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "files": [
     "dist",
     "!dist/**/*.test.*",
@@ -25,21 +25,21 @@
     "svelte": "^5.0.0"
   },
   "devDependencies": {
-    "@sveltejs/adapter-auto": "^6.0.0",
-    "@sveltejs/kit": "^2.16.0",
-    "@sveltejs/vite-plugin-svelte": "^5.0.0",
+    "@sveltejs/adapter-auto": "^6.0.1",
+    "@sveltejs/kit": "^2.22.2",
+    "@sveltejs/vite-plugin-svelte": "^5.1.0",
     "esm-env": "^1.2.2",
-    "firebase": "^11.9.1",
+    "firebase": "^11.10.0",
     "firebase-admin": "^13.4.0",
-    "prettier": "^3.4.2",
-    "prettier-plugin-svelte": "^3.3.3",
-    "publint": "^0.3.2",
-    "svelte": "^5.0.0",
-    "svelte-check": "^4.0.0",
+    "prettier": "^3.6.2",
+    "prettier-plugin-svelte": "^3.4.0",
+    "publint": "^0.3.12",
+    "svelte": "^5.35.1",
+    "svelte-check": "^4.2.2",
     "tsup": "^8.5.0",
-    "typescript": "^5.0.0",
-    "vite": "^6.2.6",
-    "vite-plugin-devtools-json": "^0.2.0",
+    "typescript": "^5.8.3",
+    "vite": "^6.3.5",
+    "vite-plugin-devtools-json": "^0.2.1",
     "vite-plugin-mkcert": "^1.17.8"
   },
   "keywords": [