@astrojs/db 0.0.0-10646-20240402132948

package/dist/core/integration/file-url.js

@@ -0,0 +1,81 @@
+import fs from "node:fs";
+import path from "node:path";
+import { pathToFileURL } from "node:url";
+async function copyFile(toDir, fromUrl, toUrl) {
+  await fs.promises.mkdir(toDir, { recursive: true });
+  await fs.promises.rename(fromUrl, toUrl);
+}
+function fileURLIntegration() {
+  const fileNames = [];
+  function createVitePlugin(command) {
+    let referenceIds = [];
+    return {
+      name: "@astrojs/db/file-url",
+      enforce: "pre",
+      async load(id) {
+        if (id.endsWith("?fileurl")) {
+          const filePath = id.slice(0, id.indexOf("?"));
+          if (command === "build") {
+            const data = await fs.promises.readFile(filePath);
+            const name = path.basename(filePath);
+            const referenceId = this.emitFile({
+              name,
+              source: data,
+              type: "asset"
+            });
+            referenceIds.push(referenceId);
+            return `export default import.meta.ROLLUP_FILE_URL_${referenceId};`;
+          } else {
+            return `export default new URL(${JSON.stringify(pathToFileURL(filePath).toString())})`;
+          }
+        }
+      },
+      generateBundle() {
+        for (const referenceId of referenceIds) {
+          fileNames.push(this.getFileName(referenceId));
+        }
+        referenceIds = [];
+      }
+    };
+  }
+  let config;
+  return {
+    name: "@astrojs/db/file-url",
+    hooks: {
+      "astro:config:setup"({ updateConfig, command }) {
+        updateConfig({
+          vite: {
+            plugins: [createVitePlugin(command)]
+          }
+        });
+      },
+      "astro:config:done": ({ config: _config }) => {
+        config = _config;
+      },
+      async "astro:build:done"() {
+        if (config.output === "static") {
+          const unlinks = [];
+          for (const fileName of fileNames) {
+            const url = new URL(fileName, config.outDir);
+            unlinks.push(fs.promises.unlink(url));
+          }
+          await Promise.all(unlinks);
+          const assetDir = new URL(config.build.assets, config.outDir);
+          await fs.promises.rmdir(assetDir).catch(() => []);
+        } else {
+          const moves = [];
+          for (const fileName of fileNames) {
+            const fromUrl = new URL(fileName, config.build.client);
+            const toUrl = new URL(fileName, config.build.server);
+            const toDir = new URL("./", toUrl);
+            moves.push(copyFile(toDir, fromUrl, toUrl));
+          }
+          await Promise.all(moves);
+        }
+      }
+    }
+  };
+}
+export {
+  fileURLIntegration
+};

package/dist/core/integration/index.d.ts

@@ -0,0 +1,2 @@
+import type { AstroIntegration } from 'astro';
+export declare function integration(): AstroIntegration[];

package/dist/core/integration/index.js

@@ -0,0 +1,160 @@
+import { existsSync } from "fs";
+import { dirname } from "path";
+import { fileURLToPath } from "url";
+import { mkdir, writeFile } from "fs/promises";
+import { blue, yellow } from "kleur/colors";
+import { loadEnv } from "vite";
+import parseArgs from "yargs-parser";
+import { SEED_DEV_FILE_NAME } from "../../runtime/queries.js";
+import { AstroDbError } from "../../runtime/utils.js";
+import { CONFIG_FILE_NAMES, DB_PATH } from "../consts.js";
+import { resolveDbConfig } from "../load-file.js";
+import { getManagedAppTokenOrExit } from "../tokens.js";
+import { getDbDirectoryUrl } from "../utils.js";
+import { fileURLIntegration } from "./file-url.js";
+import { typegenInternal } from "./typegen.js";
+import { resolved, vitePluginDb } from "./vite-plugin-db.js";
+import { vitePluginInjectEnvTs } from "./vite-plugin-inject-env-ts.js";
+function astroDBIntegration() {
+  let connectToStudio = false;
+  let configFileDependencies = [];
+  let root;
+  let appToken;
+  let tables = {
+    get() {
+      throw new Error("[astro:db] INTERNAL Tables not loaded yet");
+    }
+  };
+  let seedFiles = {
+    get() {
+      throw new Error("[astro:db] INTERNAL Seed files not loaded yet");
+    }
+  };
+  let command;
+  let output = "server";
+  return {
+    name: "astro:db",
+    hooks: {
+      "astro:config:setup": async ({ updateConfig, config, command: _command, logger }) => {
+        command = _command;
+        root = config.root;
+        output = config.output;
+        if (command === "preview")
+          return;
+        let dbPlugin = void 0;
+        const args = parseArgs(process.argv.slice(3));
+        connectToStudio = process.env.ASTRO_INTERNAL_TEST_REMOTE || args["remote"];
+        if (connectToStudio) {
+          appToken = await getManagedAppTokenOrExit();
+          dbPlugin = vitePluginDb({
+            connectToStudio,
+            appToken: appToken.token,
+            tables,
+            root: config.root,
+            srcDir: config.srcDir
+          });
+        } else {
+          dbPlugin = vitePluginDb({
+            connectToStudio: false,
+            tables,
+            seedFiles,
+            root: config.root,
+            srcDir: config.srcDir
+          });
+        }
+        updateConfig({
+          vite: {
+            assetsInclude: [DB_PATH],
+            plugins: [dbPlugin, vitePluginInjectEnvTs(config, logger)]
+          }
+        });
+      },
+      "astro:config:done": async ({ config }) => {
+        if (command === "preview")
+          return;
+        const { dbConfig, dependencies, integrationSeedPaths } = await resolveDbConfig(config);
+        tables.get = () => dbConfig.tables;
+        seedFiles.get = () => integrationSeedPaths;
+        configFileDependencies = dependencies;
+        const localDbUrl = new URL(DB_PATH, config.root);
+        if (!connectToStudio && !existsSync(localDbUrl)) {
+          await mkdir(dirname(fileURLToPath(localDbUrl)), { recursive: true });
+          await writeFile(localDbUrl, "");
+        }
+        await typegenInternal({ tables: tables.get() ?? {}, root: config.root });
+      },
+      "astro:server:setup": async ({ server, logger }) => {
+        const filesToWatch = [
+          ...CONFIG_FILE_NAMES.map((c) => new URL(c, getDbDirectoryUrl(root))),
+          ...configFileDependencies.map((c) => new URL(c, root))
+        ];
+        server.watcher.on("all", (event, relativeEntry) => {
+          const entry = new URL(relativeEntry, root);
+          if (filesToWatch.some((f) => entry.href === f.href)) {
+            server.restart();
+          }
+        });
+        setTimeout(() => {
+          logger.info(
+            connectToStudio ? "Connected to remote database." : "New local database created."
+          );
+          if (connectToStudio)
+            return;
+          const localSeedPaths = SEED_DEV_FILE_NAME.map(
+            (name) => new URL(name, getDbDirectoryUrl(root))
+          );
+          let seedInFlight = false;
+          if (seedFiles.get().length || localSeedPaths.find((path) => existsSync(path))) {
+            loadSeedModule();
+          }
+          const eagerReloadIntegrationSeedPaths = seedFiles.get().map((s) => typeof s === "string" && s.startsWith(".") ? new URL(s, root) : s).filter((s) => s instanceof URL);
+          const eagerReloadSeedPaths = [...eagerReloadIntegrationSeedPaths, ...localSeedPaths];
+          server.watcher.on("all", (event, relativeEntry) => {
+            if (event === "unlink" || event === "unlinkDir")
+              return;
+            const entry = new URL(relativeEntry, root);
+            if (eagerReloadSeedPaths.find((path) => entry.href === path.href)) {
+              loadSeedModule();
+            }
+          });
+          function loadSeedModule() {
+            if (seedInFlight)
+              return;
+            seedInFlight = true;
+            const mod = server.moduleGraph.getModuleById(resolved.seedVirtual);
+            if (mod)
+              server.moduleGraph.invalidateModule(mod);
+            server.ssrLoadModule(resolved.seedVirtual).then(() => {
+              logger.info("Seeded database.");
+            }).catch((e) => {
+              logger.error(e instanceof Error ? e.message : String(e));
+            }).finally(() => {
+              seedInFlight = false;
+            });
+          }
+        }, 100);
+      },
+      "astro:build:start": async ({ logger }) => {
+        if (!connectToStudio && !databaseFileEnvDefined() && (output === "server" || output === "hybrid")) {
+          const message = `Attempting to build without the --remote flag or the ASTRO_DATABASE_FILE environment variable defined. You probably want to pass --remote to astro build.`;
+          const hint = "Learn more connecting to Studio: https://docs.astro.build/en/guides/astro-db/#connect-to-astro-studio";
+          throw new AstroDbError(message, hint);
+        }
+        logger.info("database: " + (connectToStudio ? yellow("remote") : blue("local database.")));
+      },
+      "astro:build:done": async ({}) => {
+        await appToken?.destroy();
+      }
+    }
+  };
+}
+function databaseFileEnvDefined() {
+  const env = loadEnv("", process.cwd());
+  return env.ASTRO_DATABASE_FILE != null || process.env.ASTRO_DATABASE_FILE != null;
+}
+function integration() {
+  return [astroDBIntegration(), fileURLIntegration()];
+}
+export {
+  integration
+};

package/dist/core/integration/typegen.d.ts

@@ -0,0 +1,7 @@
+import type { AstroConfig } from 'astro';
+import type { DBTables } from '../types.js';
+export declare function typegen(astroConfig: Pick<AstroConfig, 'root' | 'integrations'>): Promise<void>;
+export declare function typegenInternal({ tables, root }: {
+    tables: DBTables;
+    root: URL;
+}): Promise<void>;

package/dist/core/integration/typegen.js

@@ -0,0 +1,33 @@
+import { existsSync } from "node:fs";
+import { mkdir, writeFile } from "node:fs/promises";
+import { DB_TYPES_FILE, RUNTIME_IMPORT } from "../consts.js";
+import { resolveDbConfig } from "../load-file.js";
+async function typegen(astroConfig) {
+  const { dbConfig } = await resolveDbConfig(astroConfig);
+  await typegenInternal({ tables: dbConfig.tables, root: astroConfig.root });
+}
+async function typegenInternal({ tables, root }) {
+  const content = `// This file is generated by Astro DB
+declare module 'astro:db' {
+${Object.entries(tables).map(([name, table]) => generateTableType(name, table)).join("\n")}
+}
+`;
+  const dotAstroDir = new URL(".astro/", root);
+  if (!existsSync(dotAstroDir)) {
+    await mkdir(dotAstroDir);
+  }
+  await writeFile(new URL(DB_TYPES_FILE, dotAstroDir), content);
+}
+function generateTableType(name, table) {
+  const sanitizedColumnsList = Object.entries(table.columns).filter(([, val]) => !val.schema.deprecated);
+  const sanitizedColumns = Object.fromEntries(sanitizedColumnsList);
+  let tableType = `	export const ${name}: import(${RUNTIME_IMPORT}).Table<
+		${JSON.stringify(name)},
+		${JSON.stringify(sanitizedColumns)}
+	>;`;
+  return tableType;
+}
+export {
+  typegen,
+  typegenInternal
+};

package/dist/core/integration/vite-plugin-db.d.ts

@@ -0,0 +1,39 @@
+import type { DBTables } from '../types.js';
+import { type VitePlugin } from '../utils.js';
+export declare const resolved: {
+    virtual: string;
+    seedVirtual: string;
+};
+export type LateTables = {
+    get: () => DBTables;
+};
+export type LateSeedFiles = {
+    get: () => Array<string | URL>;
+};
+type VitePluginDBParams = {
+    connectToStudio: false;
+    tables: LateTables;
+    seedFiles: LateSeedFiles;
+    srcDir: URL;
+    root: URL;
+} | {
+    connectToStudio: true;
+    tables: LateTables;
+    appToken: string;
+    srcDir: URL;
+    root: URL;
+};
+export declare function vitePluginDb(params: VitePluginDBParams): VitePlugin;
+export declare function getConfigVirtualModContents(): string;
+export declare function getLocalVirtualModContents({ tables, root, seedFiles, shouldSeed, }: {
+    tables: DBTables;
+    seedFiles: Array<string | URL>;
+    root: URL;
+    shouldSeed: boolean;
+}): string;
+export declare function getStudioVirtualModContents({ tables, appToken, isBuild, }: {
+    tables: DBTables;
+    appToken: string;
+    isBuild: boolean;
+}): string;
+export {};

package/dist/core/integration/vite-plugin-db.js

@@ -0,0 +1,134 @@
+import { fileURLToPath } from "node:url";
+import { normalizePath } from "vite";
+import { SEED_DEV_FILE_NAME } from "../../runtime/queries.js";
+import { DB_PATH, RUNTIME_CONFIG_IMPORT, RUNTIME_IMPORT, VIRTUAL_MODULE_ID } from "../consts.js";
+import { getDbDirectoryUrl, getRemoteDatabaseUrl } from "../utils.js";
+const WITH_SEED_VIRTUAL_MODULE_ID = "astro:db:seed";
+const resolved = {
+  virtual: "\0" + VIRTUAL_MODULE_ID,
+  seedVirtual: "\0" + WITH_SEED_VIRTUAL_MODULE_ID
+};
+function vitePluginDb(params) {
+  const srcDirPath = normalizePath(fileURLToPath(params.srcDir));
+  let command = "build";
+  return {
+    name: "astro:db",
+    enforce: "pre",
+    configResolved(resolvedConfig) {
+      command = resolvedConfig.command;
+    },
+    async resolveId(id, rawImporter) {
+      if (id !== VIRTUAL_MODULE_ID)
+        return;
+      if (params.connectToStudio)
+        return resolved.virtual;
+      const importer = rawImporter ? await this.resolve(rawImporter) : null;
+      if (!importer)
+        return resolved.virtual;
+      if (importer.id.startsWith(srcDirPath)) {
+        return resolved.seedVirtual;
+      }
+      return resolved.virtual;
+    },
+    async load(id) {
+      if (id !== resolved.virtual && id !== resolved.seedVirtual)
+        return;
+      if (params.connectToStudio) {
+        return getStudioVirtualModContents({
+          appToken: params.appToken,
+          tables: params.tables.get(),
+          isBuild: command === "build"
+        });
+      }
+      return getLocalVirtualModContents({
+        root: params.root,
+        tables: params.tables.get(),
+        seedFiles: params.seedFiles.get(),
+        shouldSeed: id === resolved.seedVirtual
+      });
+    }
+  };
+}
+function getConfigVirtualModContents() {
+  return `export * from ${RUNTIME_CONFIG_IMPORT}`;
+}
+function getLocalVirtualModContents({
+  tables,
+  root,
+  seedFiles,
+  shouldSeed
+}) {
+  const userSeedFilePaths = SEED_DEV_FILE_NAME.map(
+    // Format as /db/[name].ts
+    // for Vite import.meta.glob
+    (name) => new URL(name, getDbDirectoryUrl("file:///")).pathname
+  );
+  const resolveId = (id) => id.startsWith(".") ? normalizePath(fileURLToPath(new URL(id, root))) : id;
+  const integrationSeedImportStatements = [];
+  const integrationSeedImportNames = [];
+  seedFiles.forEach((pathOrUrl, index) => {
+    const path = typeof pathOrUrl === "string" ? resolveId(pathOrUrl) : pathOrUrl.pathname;
+    const importName = "integration_seed_" + index;
+    integrationSeedImportStatements.push(`import ${importName} from ${JSON.stringify(path)};`);
+    integrationSeedImportNames.push(importName);
+  });
+  const dbUrl = new URL(DB_PATH, root);
+  return `
+import { asDrizzleTable, createLocalDatabaseClient, normalizeDatabaseUrl } from ${RUNTIME_IMPORT};
+${shouldSeed ? `import { seedLocal } from ${RUNTIME_IMPORT};` : ""}
+${shouldSeed ? integrationSeedImportStatements.join("\n") : ""}
+
+const dbUrl = normalizeDatabaseUrl(import.meta.env.ASTRO_DATABASE_FILE, ${JSON.stringify(dbUrl)});
+export const db = createLocalDatabaseClient({ dbUrl });
+
+${shouldSeed ? `await seedLocal({
+	db,
+	tables: ${JSON.stringify(tables)},
+	userSeedGlob: import.meta.glob(${JSON.stringify(userSeedFilePaths)}, { eager: true }),
+	integrationSeedFunctions: [${integrationSeedImportNames.join(",")}],
+});` : ""}
+
+export * from ${RUNTIME_CONFIG_IMPORT};
+
+${getStringifiedTableExports(tables)}`;
+}
+function getStudioVirtualModContents({
+  tables,
+  appToken,
+  isBuild
+}) {
+  function appTokenArg() {
+    if (isBuild) {
+      return "process.env.ASTRO_STUDIO_APP_TOKEN";
+    } else {
+      return JSON.stringify(appToken);
+    }
+  }
+  function dbUrlArg() {
+    const dbStr = JSON.stringify(getRemoteDatabaseUrl());
+    return `import.meta.env.ASTRO_STUDIO_REMOTE_DB_URL ?? ${dbStr}`;
+  }
+  return `
+import {asDrizzleTable, createRemoteDatabaseClient} from ${RUNTIME_IMPORT};
+
+export const db = await createRemoteDatabaseClient(${appTokenArg()}, ${dbUrlArg()});
+
+export * from ${RUNTIME_CONFIG_IMPORT};
+
+${getStringifiedTableExports(tables)}
+	`;
+}
+function getStringifiedTableExports(tables) {
+  return Object.entries(tables).map(
+    ([name, table]) => `export const ${name} = asDrizzleTable(${JSON.stringify(name)}, ${JSON.stringify(
+      table
+    )}, false)`
+  ).join("\n");
+}
+export {
+  getConfigVirtualModContents,
+  getLocalVirtualModContents,
+  getStudioVirtualModContents,
+  resolved,
+  vitePluginDb
+};

package/dist/core/integration/vite-plugin-inject-env-ts.d.ts

@@ -0,0 +1,11 @@
+import type { AstroIntegrationLogger } from 'astro';
+import type { VitePlugin } from '../utils.js';
+export declare function vitePluginInjectEnvTs({ srcDir, root }: {
+    srcDir: URL;
+    root: URL;
+}, logger: AstroIntegrationLogger): VitePlugin;
+export declare function setUpEnvTs({ srcDir, root, logger, }: {
+    srcDir: URL;
+    root: URL;
+    logger: AstroIntegrationLogger;
+}): Promise<void>;

package/dist/core/integration/vite-plugin-inject-env-ts.js

@@ -0,0 +1,53 @@
+import { existsSync } from "node:fs";
+import { readFile, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { bold } from "kleur/colors";
+import { normalizePath } from "vite";
+import { DB_TYPES_FILE } from "../consts.js";
+function vitePluginInjectEnvTs({ srcDir, root }, logger) {
+  return {
+    name: "db-inject-env-ts",
+    enforce: "post",
+    async config() {
+      await setUpEnvTs({ srcDir, root, logger });
+    }
+  };
+}
+async function setUpEnvTs({
+  srcDir,
+  root,
+  logger
+}) {
+  const envTsPath = getEnvTsPath({ srcDir });
+  const envTsPathRelativetoRoot = normalizePath(
+    path.relative(fileURLToPath(root), fileURLToPath(envTsPath))
+  );
+  if (existsSync(envTsPath)) {
+    let typesEnvContents = await readFile(envTsPath, "utf-8");
+    const dotAstroDir = new URL(".astro/", root);
+    if (!existsSync(dotAstroDir))
+      return;
+    const dbTypeReference = getDBTypeReference({ srcDir, dotAstroDir });
+    if (!typesEnvContents.includes(dbTypeReference)) {
+      typesEnvContents = `${dbTypeReference}
+${typesEnvContents}`;
+      await writeFile(envTsPath, typesEnvContents, "utf-8");
+      logger.info(`Added ${bold(envTsPathRelativetoRoot)} types`);
+    }
+  }
+}
+function getDBTypeReference({ srcDir, dotAstroDir }) {
+  const dbTypesFile = new URL(DB_TYPES_FILE, dotAstroDir);
+  const contentTypesRelativeToSrcDir = normalizePath(
+    path.relative(fileURLToPath(srcDir), fileURLToPath(dbTypesFile))
+  );
+  return `/// <reference path=${JSON.stringify(contentTypesRelativeToSrcDir)} />`;
+}
+function getEnvTsPath({ srcDir }) {
+  return new URL("env.d.ts", srcDir);
+}
+export {
+  setUpEnvTs,
+  vitePluginInjectEnvTs
+};