@astrojs/db 0.2.2 → 0.3.1

package/config-augment.d.ts

@@ -1,4 +1,4 @@
 declare namespace Config {
-	type DBUserConfig = import('./dist/config.js').DBUserConfig;
+	type DBUserConfig = import('./dist/core/types.js').DBUserConfig;
 	export interface Database extends DBUserConfig {}
 }

package/dist/core/cli/commands/link/index.d.ts

@@ -0,0 +1,8 @@
+import type { AstroConfig } from 'astro';
+import type { Arguments } from 'yargs-parser';
+export declare function cmd({ flags }: {
+    config: AstroConfig;
+    flags: Arguments;
+}): Promise<void>;
+export declare function promptProjectName(defaultName?: string): Promise<string>;
+export declare function promptWorkspaceName(defaultName?: string): Promise<string>;

package/dist/core/cli/commands/link/index.js

@@ -0,0 +1,64 @@
+import { mkdir, writeFile } from "node:fs/promises";
+import prompts from "prompts";
+import { PROJECT_ID_FILE, getSessionIdFromFile } from "../../../tokens.js";
+import { getAstroStudioUrl } from "../../../utils.js";
+import { MISSING_SESSION_ID_ERROR } from "../../../errors.js";
+async function cmd({ flags }) {
+  const linkUrl = new URL(getAstroStudioUrl() + "/auth/cli/link");
+  const sessionToken = await getSessionIdFromFile();
+  if (!sessionToken) {
+    console.error(MISSING_SESSION_ID_ERROR);
+    process.exit(1);
+  }
+  let body = { id: flags._[4] };
+  if (!body.id) {
+    const workspaceIdName = await promptWorkspaceName();
+    const projectIdName = await promptProjectName();
+    body = { projectIdName, workspaceIdName };
+  }
+  const response = await fetch(linkUrl, {
+    method: "POST",
+    headers: {
+      Authorization: `Bearer ${await getSessionIdFromFile()}`,
+      "Content-Type": "application/json"
+    },
+    body: JSON.stringify(body)
+  });
+  if (!response.ok) {
+    console.error(`Failed to link project: ${response.status} ${response.statusText}`);
+    process.exit(1);
+  }
+  const { data } = await response.json();
+  await mkdir(new URL(".", PROJECT_ID_FILE), { recursive: true });
+  await writeFile(PROJECT_ID_FILE, `${data.id}`);
+  console.info("Project linked.");
+}
+async function promptProjectName(defaultName) {
+  const { projectName } = await prompts({
+    type: "text",
+    name: "projectName",
+    message: "Project ID",
+    initial: defaultName
+  });
+  if (typeof projectName !== "string") {
+    process.exit(0);
+  }
+  return projectName;
+}
+async function promptWorkspaceName(defaultName) {
+  const { workspaceName } = await prompts({
+    type: "text",
+    name: "workspaceName",
+    message: "Workspace ID",
+    initial: defaultName
+  });
+  if (typeof workspaceName !== "string") {
+    process.exit(0);
+  }
+  return workspaceName;
+}
+export {
+  cmd,
+  promptProjectName,
+  promptWorkspaceName
+};

package/dist/core/cli/commands/login/index.d.ts

@@ -0,0 +1,6 @@
+import type { AstroConfig } from 'astro';
+import type { Arguments } from 'yargs-parser';
+export declare function cmd({ flags }: {
+    config: AstroConfig;
+    flags: Arguments;
+}): Promise<void>;

package/dist/core/cli/commands/login/index.js

@@ -0,0 +1,46 @@
+import { cyan } from "kleur/colors";
+import { mkdir, writeFile } from "node:fs/promises";
+import { createServer } from "node:http";
+import ora from "ora";
+import { getAstroStudioUrl } from "../../../utils.js";
+import open from "open";
+import { SESSION_LOGIN_FILE } from "../../../tokens.js";
+function serveAndResolveSession() {
+  let resolve, reject;
+  const sessionPromise = new Promise((_resolve, _reject) => {
+    resolve = _resolve;
+    reject = _reject;
+  });
+  const server = createServer((req, res) => {
+    res.writeHead(200);
+    res.end();
+    const url = new URL(req.url ?? "/", `http://${req.headers.host}`);
+    const session = url.searchParams.get("session");
+    if (!session) {
+      reject();
+    } else {
+      resolve(session);
+    }
+  }).listen(5710, "localhost");
+  return sessionPromise.finally(() => {
+    server.closeAllConnections();
+    server.close();
+  });
+}
+async function cmd({ flags }) {
+  let session = flags.session;
+  const loginUrl = getAstroStudioUrl() + "/auth/cli";
+  if (!session) {
+    console.log(`Opening ${cyan(loginUrl)} in your browser...`);
+    console.log(`If something goes wrong, copy-and-paste the URL into your browser.`);
+    open(loginUrl);
+    const spinner = ora("Waiting for confirmation...");
+    session = await serveAndResolveSession();
+    spinner.succeed("Successfully logged in!");
+  }
+  await mkdir(new URL(".", SESSION_LOGIN_FILE), { recursive: true });
+  await writeFile(SESSION_LOGIN_FILE, `${session}`);
+}
+export {
+  cmd
+};

package/dist/core/cli/commands/logout/index.d.ts

@@ -0,0 +1,6 @@
+import type { AstroConfig } from 'astro';
+import type { Arguments } from 'yargs-parser';
+export declare function cmd({}: {
+    config: AstroConfig;
+    flags: Arguments;
+}): Promise<void>;

package/dist/core/cli/commands/logout/index.js

@@ -0,0 +1,9 @@
+import { unlink } from "node:fs/promises";
+import { SESSION_LOGIN_FILE } from "../../../tokens.js";
+async function cmd({}) {
+  await unlink(SESSION_LOGIN_FILE);
+  console.log("Successfully logged out of Astro Studio.");
+}
+export {
+  cmd
+};

package/dist/core/cli/commands/push/index.js

@@ -1,57 +1,68 @@
 import { createClient } from "@libsql/client";
-import deepDiff from "deep-diff";
 import { drizzle } from "drizzle-orm/sqlite-proxy";
-import { appTokenError } from "../../../errors.js";
+import { red } from "kleur/colors";
+import prompts from "prompts";
+import { setupDbTables } from "../../../queries.js";
+import { getManagedAppTokenOrExit } from "../../../tokens.js";
+import { collectionsSchema } from "../../../types.js";
+import { getRemoteDatabaseUrl } from "../../../utils.js";
+import { getMigrationQueries } from "../../migration-queries.js";
 import {
-  createCurrentSnapshot,
   createEmptySnapshot,
   getMigrations,
-  initializeFromMigrations,
+  getMigrationStatus,
   loadInitialSnapshot,
-  loadMigration
+  loadMigration,
+  MIGRATION_NEEDED,
+  MIGRATIONS_NOT_INITIALIZED,
+  MIGRATIONS_UP_TO_DATE
 } from "../../migrations.js";
-import { getAstroStudioEnv, getRemoteDatabaseUrl } from "../../../utils.js";
-import { getMigrationQueries } from "../../migration-queries.js";
-import { setupDbTables } from "../../../queries.js";
-const { diff } = deepDiff;
+import { MISSING_SESSION_ID_ERROR } from "../../../errors.js";
 async function cmd({ config, flags }) {
-  const isSeedData = flags.seed;
   const isDryRun = flags.dryRun;
-  const appToken = flags.token ?? getAstroStudioEnv().ASTRO_STUDIO_APP_TOKEN;
-  const currentSnapshot = createCurrentSnapshot(config);
-  const allMigrationFiles = await getMigrations();
-  if (allMigrationFiles.length === 0) {
-    console.log("Project not yet initialized!");
+  const appToken = await getManagedAppTokenOrExit(flags.token);
+  const migration = await getMigrationStatus(config);
+  if (migration.state === "no-migrations-found") {
+    console.log(MIGRATIONS_NOT_INITIALIZED);
     process.exit(1);
-  }
-  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
-  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
-  if (calculatedDiff) {
-    console.log("Changes detected!");
-    console.log(calculatedDiff);
+  } else if (migration.state === "ahead") {
+    console.log(MIGRATION_NEEDED);
     process.exit(1);
   }
-  if (!appToken) {
-    console.error(appTokenError);
+  const allLocalMigrations = await getMigrations();
+  let missingMigrations = [];
+  try {
+    const { data } = await prepareMigrateQuery({
+      migrations: allLocalMigrations,
+      appToken: appToken.token
+    });
+    missingMigrations = data;
+  } catch (error) {
+    if (error instanceof Error) {
+      if (error.message.startsWith("{")) {
+        const { error: { code } = { code: "" } } = JSON.parse(error.message);
+        if (code === "TOKEN_UNAUTHORIZED") {
+          console.error(MISSING_SESSION_ID_ERROR);
+        }
+      }
+    }
+    console.error(error);
     process.exit(1);
   }
-  const allLocalMigrations = await getMigrations();
-  const { data: missingMigrations } = await prepareMigrateQuery({
-    migrations: allLocalMigrations,
-    appToken
-  });
   if (missingMigrations.length === 0) {
-    console.info("No migrations to push! Your database is up to date!");
-    process.exit(0);
-  }
-  if (missingMigrations.length > 0) {
+    console.log(MIGRATIONS_UP_TO_DATE);
+  } else {
     console.log(`Pushing ${missingMigrations.length} migrations...`);
-    await pushSchema({ migrations: missingMigrations, appToken, isDryRun, currentSnapshot });
-  }
-  if (isSeedData) {
-    console.info("Pushing data...");
-    await pushData({ config, appToken, isDryRun });
+    await pushSchema({
+      migrations: missingMigrations,
+      appToken: appToken.token,
+      isDryRun,
+      currentSnapshot: migration.currentSnapshot
+    });
   }
+  console.info("Pushing data...");
+  await pushData({ config, appToken: appToken.token, isDryRun });
+  await appToken.destroy();
   console.info("Push complete!");
 }
 async function pushSchema({
@@ -63,10 +74,26 @@ async function pushSchema({
   const initialSnapshot = migrations.find((m) => m === "0000_snapshot.json");
   const filteredMigrations = migrations.filter((m) => m !== "0000_snapshot.json");
   const missingMigrationContents = await Promise.all(filteredMigrations.map(loadMigration));
-  const initialMigrationBatch = initialSnapshot ? await getMigrationQueries({
+  const initialMigrationBatch = initialSnapshot ? (await getMigrationQueries({
     oldSnapshot: createEmptySnapshot(),
     newSnapshot: await loadInitialSnapshot()
-  }) : [];
+  })).queries : [];
+  const confirmations = missingMigrationContents.reduce((acc, curr) => {
+    return [...acc, ...curr.confirm || []];
+  }, []);
+  if (confirmations.length > 0) {
+    const response = await prompts([
+      ...confirmations.map((message, index) => ({
+        type: "confirm",
+        name: String(index),
+        message: red("Warning: ") + message + "\nContinue?",
+        initial: true
+      }))
+    ]);
+    if (Object.values(response).length === 0 || Object.values(response).some((value) => value === false)) {
+      process.exit(1);
+    }
+  }
   const queries = missingMigrationContents.reduce((acc, curr) => {
     return [...acc, ...curr.db];
   }, initialMigrationBatch);
@@ -98,7 +125,7 @@ async function pushData({
     await setupDbTables({
       db,
       mode: "build",
-      collections: config.db.collections ?? {},
+      collections: collectionsSchema.parse(config.db.collections ?? {}),
       data: config.db.data
     });
   }
@@ -116,12 +143,13 @@ async function pushData({
   });
 }
 async function runMigrateQuery({
-  queries,
+  queries: baseQueries,
   migrations,
   snapshot,
   appToken,
   isDryRun
 }) {
+  const queries = ["pragma defer_foreign_keys=true;", ...baseQueries];
   const requestBody = {
     snapshot,
     migrations,
@@ -132,7 +160,7 @@ async function runMigrateQuery({
     console.info("[DRY RUN] Batch query:", JSON.stringify(requestBody, null, 2));
     return new Response(null, { status: 200 });
   }
-  const url = new URL("/db/migrate/run", getRemoteDatabaseUrl());
+  const url = new URL("/migrations/run", getRemoteDatabaseUrl());
   return await fetch(url, {
     method: "POST",
     headers: new Headers({
@@ -145,7 +173,7 @@ async function prepareMigrateQuery({
   migrations,
   appToken
 }) {
-  const url = new URL("/db/migrate/prepare", getRemoteDatabaseUrl());
+  const url = new URL("/migrations/prepare", getRemoteDatabaseUrl());
   const requestBody = {
     migrations,
     experimentalVersion: 1

package/dist/core/cli/commands/shell/index.js

@@ -1,16 +1,13 @@
 import { sql } from "drizzle-orm";
-import { appTokenError } from "../../../errors.js";
-import { getAstroStudioEnv, getRemoteDatabaseUrl } from "../../../utils.js";
 import { createRemoteDatabaseClient } from "../../../../runtime/db-client.js";
+import { getManagedAppTokenOrExit } from "../../../tokens.js";
+import { getRemoteDatabaseUrl } from "../../../utils.js";
 async function cmd({ flags }) {
   const query = flags.query;
-  const appToken = flags.token ?? getAstroStudioEnv().ASTRO_STUDIO_APP_TOKEN;
-  if (!appToken) {
-    console.error(appTokenError);
-    process.exit(1);
-  }
-  const db = createRemoteDatabaseClient(appToken, getRemoteDatabaseUrl());
+  const appToken = await getManagedAppTokenOrExit(flags.token);
+  const db = createRemoteDatabaseClient(appToken.token, getRemoteDatabaseUrl());
   const result = await db.run(sql.raw(query));
+  await appToken.destroy();
   console.log(result);
 }
 export {

package/dist/core/cli/commands/sync/index.js

@@ -1,43 +1,36 @@
-import deepDiff from "deep-diff";
-import { writeFile } from "fs/promises";
+import { writeFile } from "node:fs/promises";
 import {
-  createCurrentSnapshot,
-  getMigrations,
-  initializeFromMigrations,
+  MIGRATIONS_CREATED,
+  MIGRATIONS_UP_TO_DATE,
+  getMigrationStatus,
   initializeMigrationsDirectory
 } from "../../migrations.js";
 import { getMigrationQueries } from "../../migration-queries.js";
-const { diff } = deepDiff;
+import { bgRed, red, reset } from "kleur/colors";
 async function cmd({ config }) {
-  const currentSnapshot = createCurrentSnapshot(config);
-  const allMigrationFiles = await getMigrations();
-  if (allMigrationFiles.length === 0) {
-    await initializeMigrationsDirectory(currentSnapshot);
-    console.log("Project initialized!");
+  const migration = await getMigrationStatus(config);
+  if (migration.state === "no-migrations-found") {
+    await initializeMigrationsDirectory(migration.currentSnapshot);
+    console.log(MIGRATIONS_CREATED);
     return;
-  }
-  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
-  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
-  if (!calculatedDiff) {
-    console.log("No changes detected!");
+  } else if (migration.state === "up-to-date") {
+    console.log(MIGRATIONS_UP_TO_DATE);
     return;
   }
-  const migrationQueries = await getMigrationQueries({
-    oldSnapshot: prevSnapshot,
-    newSnapshot: currentSnapshot
+  const { oldSnapshot, newSnapshot, newFilename, diff } = migration;
+  const { queries: migrationQueries, confirmations } = await getMigrationQueries({
+    oldSnapshot,
+    newSnapshot
   });
-  const largestNumber = allMigrationFiles.reduce((acc, curr) => {
-    const num = parseInt(curr.split("_")[0]);
-    return num > acc ? num : acc;
-  }, 0);
+  confirmations.map((message) => console.log(bgRed(" !!! ") + " " + red(message)));
   const migrationFileContent = {
-    diff: calculatedDiff,
-    db: migrationQueries
+    diff,
+    db: migrationQueries,
+    // TODO(fks): Encode the relevant data, instead of the raw message.
+    // This will give `db push` more control over the formatting of the message.
+    confirm: confirmations.map((c) => reset(c))
   };
-  const migrationFileName = `./migrations/${String(largestNumber + 1).padStart(
-    4,
-    "0"
-  )}_migration.json`;
+  const migrationFileName = `./migrations/${newFilename}`;
   await writeFile(migrationFileName, JSON.stringify(migrationFileContent, void 0, 2));
   console.log(migrationFileName + " created!");
 }

package/dist/core/cli/commands/verify/index.d.ts

@@ -1,6 +1,6 @@
 import type { AstroConfig } from 'astro';
 import type { Arguments } from 'yargs-parser';
-export declare function cmd({ config }: {
+export declare function cmd({ config, flags }: {
     config: AstroConfig;
     flags: Arguments;
 }): Promise<void>;

package/dist/core/cli/commands/verify/index.js

@@ -1,21 +1,25 @@
-import deepDiff from "deep-diff";
-import { getMigrations, initializeFromMigrations } from "../../migrations.js";
-const { diff } = deepDiff;
-async function cmd({ config }) {
-  const currentSnapshot = JSON.parse(JSON.stringify(config.db?.collections ?? {}));
-  const allMigrationFiles = await getMigrations();
-  if (allMigrationFiles.length === 0) {
-    console.log("Project not yet initialized!");
-    process.exit(1);
+import { getMigrationStatus, MIGRATION_NEEDED, MIGRATIONS_NOT_INITIALIZED, MIGRATIONS_UP_TO_DATE } from "../../migrations.js";
+async function cmd({ config, flags }) {
+  const status = await getMigrationStatus(config);
+  const { state } = status;
+  if (flags.json) {
+    console.log(JSON.stringify(status));
+    process.exit(state === "up-to-date" ? 0 : 1);
   }
-  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
-  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
-  if (calculatedDiff) {
-    console.log("Changes detected!");
-    process.exit(1);
+  switch (state) {
+    case "no-migrations-found": {
+      console.log(MIGRATIONS_NOT_INITIALIZED);
+      process.exit(1);
+    }
+    case "ahead": {
+      console.log(MIGRATION_NEEDED);
+      process.exit(1);
+    }
+    case "up-to-date": {
+      console.log(MIGRATIONS_UP_TO_DATE);
+      return;
+    }
   }
-  console.log("No changes detected.");
-  return;
 }
 export {
   cmd

package/dist/core/cli/index.js

@@ -1,21 +1,38 @@
+import { STUDIO_CONFIG_MISSING_CLI_ERROR } from "../errors.js";
 async function cli({ flags, config }) {
   const command = flags._[3];
+  if (!config.db?.studio) {
+    console.log(STUDIO_CONFIG_MISSING_CLI_ERROR);
+    process.exit(1);
+  }
   switch (command) {
     case "shell": {
-      const { cmd: shellCommand } = await import("./commands/shell/index.js");
-      return await shellCommand({ config, flags });
+      const { cmd } = await import("./commands/shell/index.js");
+      return await cmd({ config, flags });
     }
     case "sync": {
-      const { cmd: syncCommand } = await import("./commands/sync/index.js");
-      return await syncCommand({ config, flags });
+      const { cmd } = await import("./commands/sync/index.js");
+      return await cmd({ config, flags });
     }
     case "push": {
-      const { cmd: pushCommand } = await import("./commands/push/index.js");
-      return await pushCommand({ config, flags });
+      const { cmd } = await import("./commands/push/index.js");
+      return await cmd({ config, flags });
     }
     case "verify": {
-      const { cmd: verifyCommand } = await import("./commands/verify/index.js");
-      return await verifyCommand({ config, flags });
+      const { cmd } = await import("./commands/verify/index.js");
+      return await cmd({ config, flags });
+    }
+    case "login": {
+      const { cmd } = await import("./commands/login/index.js");
+      return await cmd({ config, flags });
+    }
+    case "logout": {
+      const { cmd } = await import("./commands/logout/index.js");
+      return await cmd({ config, flags });
+    }
+    case "link": {
+      const { cmd } = await import("./commands/link/index.js");
+      return await cmd({ config, flags });
     }
     default: {
       if (command == null) {
@@ -35,6 +52,10 @@ ${showHelp()}`);
 		
 Usage:
 
+astro db login       Authenticate your machine with Astro Studio
+astro db logout      End your authenticated session with Astro Studio
+astro db link        Link this directory to an Astro Studio project
+
 astro db sync        Creates snapshot based on your schema
 astro db push        Pushes migrations to Astro Studio
 astro db verify      Verifies migrations have been pushed and errors if not`;

package/dist/core/cli/migration-queries.d.ts

@@ -1,18 +1,26 @@
 import type { DBCollection, DBSnapshot } from '../types.js';
-interface PromptResponses {
-    allowDataLoss: boolean;
-    fieldRenames: Record<string, string | false>;
-    collectionRenames: Record<string, string | false>;
-}
-export declare function getMigrationQueries({ oldSnapshot, newSnapshot, promptResponses, }: {
+/** Dependency injected for unit testing */
+type AmbiguityResponses = {
+    collectionRenames: Record<string, string>;
+    fieldRenames: {
+        [collectionName: string]: Record<string, string>;
+    };
+};
+export declare function getMigrationQueries({ oldSnapshot, newSnapshot, ambiguityResponses, }: {
     oldSnapshot: DBSnapshot;
     newSnapshot: DBSnapshot;
-    promptResponses?: PromptResponses;
-}): Promise<string[]>;
-export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, promptResponses, }: {
+    ambiguityResponses?: AmbiguityResponses;
+}): Promise<{
+    queries: string[];
+    confirmations: string[];
+}>;
+export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, ambiguityResponses, }: {
     collectionName: string;
     oldCollection: DBCollection;
     newCollection: DBCollection;
-    promptResponses?: PromptResponses;
-}): Promise<string[]>;
+    ambiguityResponses?: AmbiguityResponses;
+}): Promise<{
+    queries: string[];
+    confirmations: string[];
+}>;
 export {};