Fix error in authproto by using virtual modules to load astro:db or unstorage

Author: essential-randomness

astro-authproto/package.json

@@ -22,6 +22,18 @@
         "types": "./dist/helpers.d.ts",
         "default": "./dist/helpers.js"
       }
+    },
+    "./stores/unstorage": {
+      "import": {
+        "types": "./dist/stores/unstorage.d.ts",
+        "default": "./dist/stores/unstorage.js"
+      }
+    },
+    "./stores/db": {
+      "import": {
+        "types": "./dist/stores/db.d.ts",
+        "default": "./dist/stores/db.js"
+      }
     }
   },
   "files": [
@@ -55,7 +67,6 @@
   },
   "homepage": "https://github.com/FujoWebDev/fujocoded-plugins#readme",
   "dependencies": {
-    "@astrojs/db": "^0.17.1",
     "@atproto/api": "^0.17.3",
     "@atproto/identity": "^0.4.8",
     "@atproto/jwk-jose": "^0.1.4",
@@ -64,9 +75,15 @@
     "unstorage": "^1.16.1"
   },
   "devDependencies": {
-    "tsdown": "^0.14.1"
+    "tsdown": "^0.17.2"
   },
   "peerDependencies": {
+    "@astrojs/db": "^0.17.1",
     "astro": "^5.13.0"
+  },
+  "peerDependenciesMeta": {
+    "@astrojs/db": {
+      "optional": true
+    }
   }
 }

astro-authproto/src/components/Login.astro

@@ -9,6 +9,7 @@ interface Props {
 const { redirect: redirectUrl } = Astro.props;
 const currentUser = Astro.locals.loggedInUser;
 
+// @ts-expect-error
 const { class: cssClass, 'class:list': cssClassList } = Astro.props;
 ---
 

astro-authproto/src/config-module.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Type definitions for "fujocoded:authproto/config".
+ *
+ * This file declares types for fujocoded:authproto's virtual modules. These
+ * modules are "imports" that don't map to real files, but are injected into the
+ * application by Vite.
+ *
+ * We need a sepate type definition file for virtual modules, because TypeScript has
+ * two separate modes for .d.ts files:
+ * 1. "Script" mode, which can declare new modules (does NOT support import/export)
+ * 2. "Module" mode, which can only augment existing modules (supports import/export)
+ *
+ * In this case, we need both types, so we add this file (config-module.d.ts) for module
+ * declarations.
+ *
+ * See: https://www.totaltypescript.com/books/total-typescript-essentials/modules-scripts-and-declaration-files#module-augmentation-vs-module-overriding
+ */
+declare module "fujocoded:authproto/config" {
+  export const applicationName: string;
+  export const applicationDomain: string;
+  export const defaultDevUser: string | null;
+  export const externalDomain: string | undefined;
+  export const storage: import("unstorage").Storage | null;
+  export const scopes: string[];
+  export const driverName: string;
+  export const redirectAfterLogin: string;
+  export const redirectAfterLogout: string;
+}
+
+declare module "fujocoded:authproto/stores" {
+  export {
+    StateStore,
+    SessionStore,
+  } from "@fujocoded/authproto/stores/unstorage";
+}
+
+// astro:db types - @astrojs/db is an optional peer dependency
+declare module "astro:db" {
+  export const db: any;
+  export function eq(column: any, value: any): any;
+  export function defineDb(config: any): any;
+  export function defineTable(config: any): any;
+  export const column: {
+    text(): any;
+    number(): any;
+    boolean(): any;
+    date(): any;
+    json(): any;
+  };
+}

astro-authproto/src/index.ts

@@ -1,8 +1,7 @@
 import type { AstroIntegration, InjectedRoute } from "astro";
 import path from "node:path";
 import { addVirtualImports } from "astro-integration-kit";
-import "@astrojs/db";
-import { getConfig, type ConfigOptions } from "./lib/config.js";
+import { getConfig, getStoresImport, type ConfigOptions } from "./lib/config.js";
 import { readFile } from "node:fs/promises";
 
 export const LOGGED_IN_DID_TEMPLATE = "{loggedInUser.did}";
@@ -34,8 +33,8 @@ const addOAuthRoutes = (injectRoute: (_: InjectedRoute) => void) => {
 
 /**
  * Add two routes ATProto OAuth clients must have:
- * - `/client-metadata.json`, information about the client's identity
- *   and requested access
+ * - `/client-metadata.json`, information about the client's identity and
+ *   requested access
  * - `/jwks.json`, information about the cryptographic keys used in the
  *   authorization request
  */
@@ -82,6 +81,11 @@ export default (
             }),
             context: "server",
           },
+          {
+            id: "fujocoded:authproto/stores",
+            content: getStoresImport(configOptions.driver?.name),
+            context: "server",
+          },
         ],
       });
 
@@ -99,17 +103,24 @@ export default (
         );
       }
       if (!configOptions.driver) {
-        logger.warn(
-          "The ATproto OAuth integration requires a configured session driver in production. This will be ok for dev mode."
-        );
+        if (process.env.NODE_ENV === "development") {
+          logger.warn(
+            "The ATproto OAuth integration requires a configured session driver in production. This will be ok for dev mode."
+          );
+        } else {
+          throw new Error(
+            "The ATproto OAuth integration requires a configured session driver in production."
+          );
+        }
       }
       if (!config.server.host && process.env.NODE_ENV === "development") {
         logger.error(
           "ATproto requires the local redirect URL to be 127.0.0.1 (not localhost) but your site is not running on a network address. Run `astro dev --host` to fix this."
         );
       }
       if (config.output === "static") {
-        // TODO: check if a static site with some routes marked as dynamic works.
+        // TODO: check if a static site with some routes marked as dynamic
+        // works.
         logger.warn(
           `Your Astro output config is "static". The login status is only available on dynamically rendered pages.`
         );

astro-authproto/src/lib/auth.ts

@@ -7,19 +7,17 @@ import { JoseKey } from "@atproto/jwk-jose";
 import { DidResolver } from "@atproto/identity";
 import {
   scopes,
-  driverName,
   applicationName,
   externalDomain,
 } from "fujocoded:authproto/config";
 
-const REDIRECT_PATH = "/oauth/callback";
+// We import the stores from the virtual module "fujocoded:authproto/stores"
+// so we don't force projects using this integration to bundle all our dependencies,
+// even for stores they don't use. Doing otherwise would cause errors if the consumer
+// is (for example) NOT using "astro:db", but our code requires it for the bundle.
+import * as Stores from "fujocoded:authproto/stores";
 
-let Stores;
-if (driverName == "astro:db") {
-  Stores = await import("./auth-storage-db.js");
-} else {
-  Stores = await import("./auth-storage-unstorage.js");
-}
+const REDIRECT_PATH = "/oauth/callback";
 
 /**
  * Creates OAuth client metadata for the given domain.

astro-authproto/src/lib/config.ts

@@ -1,16 +1,14 @@
-import type { BuiltinDriverOptions } from "unstorage";
+import type { BuiltinDriverOptions, BuiltinDriverName } from "unstorage";
 
 type AstroDriverOption = { name: "astro:db"; options?: never };
-type OptionsType<
-  T extends keyof BuiltinDriverOptions = keyof BuiltinDriverOptions,
-> = {
-  name: T;
-  options: BuiltinDriverOptions[T];
-};
+type OptionsType<T extends BuiltinDriverName = BuiltinDriverName> =
+  T extends keyof BuiltinDriverOptions
+    ? { name: T; options: BuiltinDriverOptions[T] }
+    : { name: T; options?: never };
 export type AllDriverOptions =
   | {
-      [K in keyof BuiltinDriverOptions]: OptionsType<K>;
-    }[keyof BuiltinDriverOptions]
+      [K in BuiltinDriverName]: OptionsType<K>;
+    }[BuiltinDriverName]
   | { name: "astro:db"; options?: never };
 
 export type OAuthScope =
@@ -65,6 +63,13 @@ export interface ConfigOptions {
   */
 }
 
+export const getStoresImport = (driverName?: string) => {
+  if (driverName === "astro:db") {
+    return `export { StateStore, SessionStore } from "@fujocoded/authproto/stores/db";`;
+  }
+  return `export { StateStore, SessionStore } from "@fujocoded/authproto/stores/unstorage";`;
+};
+
 export const getConfig = ({ options, isDev }: { options: ConfigOptions, isDev: boolean }) => {
   const finalDriver = options.driver ?? {
     name: "memory",

…tro-authproto/src/lib/auth-storage-db.ts astro-authproto/src/stores/db.tsastro-authproto/src/lib/auth-storage-db.ts renamed to astro-authproto/src/stores/db.ts astro-authproto/src/lib/auth-storage-db.ts renamed to astro-authproto/src/stores/db.ts

@@ -1,5 +1,3 @@
-/// <reference types="astro/client" />
-
 declare global {
   namespace App {
     interface SessionData {
@@ -16,13 +14,4 @@ declare global {
   }
 }
 
-declare module "fujocoded:authproto/config" {
-  export const applicationName: string;
-  export const applicationDomain: string;
-  export const defaultDevUser: string | null;
-  export const storage: import("unstorage").Storage;
-  export const scopes: import("./lib/config.ts").OAuthScope[];
-  export const driverName: import("./lib/config.ts").AllDriverOptions["name"];
-}
-
 export {};

…hproto/src/lib/auth-storage-unstorage.ts astro-authproto/src/stores/unstorage.tsastro-authproto/src/lib/auth-storage-unstorage.ts renamed to astro-authproto/src/stores/unstorage.ts astro-authproto/src/lib/auth-storage-unstorage.ts renamed to astro-authproto/src/stores/unstorage.ts

@@ -1,5 +1,4 @@
 {
-  "extends": "astro/tsconfigs/strict",
   "compilerOptions": {
     /* Base Options: */
     "esModuleInterop": true,
@@ -8,7 +7,7 @@
     "lib": ["es2022", "DOM"],
     "allowJs": true,
     "resolveJsonModule": true,
-    "moduleDetection": "force",
+    "moduleDetection": "auto",
     "isolatedModules": true,
     /* Strictness */
     "strict": true,
@@ -19,9 +18,9 @@
     "sourceMap": true,
     "declaration": true,
     "allowImportingTsExtensions": true,
-    "noEmit": true,
-    "types": ["./src/types.d.ts"]
+    "noEmit": true
   },
   "include": ["./src/**/*"],
-  "exclude": ["node_modules"]
+  "exclude": ["node_modules"],
+  "files": ["./src/types.d.ts", "./src/config-module.d.ts"]
 }