@astrojs/db 0.5.0 → 0.6.1

package/dist/core/types.js

@@ -14,6 +14,7 @@ const baseColumnSchema = z.object({
   label: z.string().optional(),
   optional: z.boolean().optional().default(false),
   unique: z.boolean().optional().default(false),
+  deprecated: z.boolean().optional().default(false),
   // Defined when `defineReadableTable()` is called
   name: z.string().optional(),
   // TODO: rename to `tableName`. Breaking schema change
@@ -115,7 +116,8 @@ const foreignKeysSchema = z.object({
 const tableSchema = z.object({
   columns: columnsSchema,
   indexes: z.record(indexSchema).optional(),
-  foreignKeys: z.array(foreignKeysSchema).optional()
+  foreignKeys: z.array(foreignKeysSchema).optional(),
+  deprecated: z.boolean().optional().default(false)
 });
 const tablesSchema = z.preprocess((rawTables) => {
   const tables = z.record(z.any()).parse(rawTables, { errorMap });

package/dist/core/utils.d.ts

@@ -4,4 +4,3 @@ export declare function getAstroStudioEnv(envMode?: string): Record<`ASTRO_STUDI
 export declare function getRemoteDatabaseUrl(): string;
 export declare function getAstroStudioUrl(): string;
 export declare function getDbDirectoryUrl(root: URL | string): URL;
-export declare function getMigrationsDirectoryUrl(root: URL | string): URL;

package/dist/core/utils.js

@@ -14,13 +14,9 @@ function getAstroStudioUrl() {
 function getDbDirectoryUrl(root) {
   return new URL("db/", root);
 }
-function getMigrationsDirectoryUrl(root) {
-  return new URL("migrations/", getDbDirectoryUrl(root));
-}
 export {
   getAstroStudioEnv,
   getAstroStudioUrl,
   getDbDirectoryUrl,
-  getMigrationsDirectoryUrl,
   getRemoteDatabaseUrl
 };

package/dist/runtime/config.d.ts

@@ -4,6 +4,7 @@ export declare const column: {
         name?: string | undefined;
         label?: string | undefined;
         unique?: boolean | undefined;
+        deprecated?: boolean | undefined;
         collection?: string | undefined;
     } & ({
         primaryKey?: false | undefined;
@@ -20,6 +21,7 @@ export declare const column: {
                 name?: string | undefined;
                 label?: string | undefined;
                 unique?: boolean | undefined;
+                deprecated?: boolean | undefined;
                 collection?: string | undefined;
             } & {
                 primaryKey?: false | undefined;
@@ -29,6 +31,7 @@ export declare const column: {
                 name?: string | undefined;
                 label?: string | undefined;
                 unique?: boolean | undefined;
+                deprecated?: boolean | undefined;
                 collection?: string | undefined;
             } & {
                 primaryKey: true;
@@ -48,6 +51,7 @@ export declare const column: {
         label?: string | undefined;
         optional?: boolean | undefined;
         unique?: boolean | undefined;
+        deprecated?: boolean | undefined;
         collection?: string | undefined;
         default?: boolean | import("drizzle-orm").SQL<any> | undefined;
     }>(opts?: T_1) => {
@@ -61,6 +65,7 @@ export declare const column: {
         name?: string | undefined;
         label?: string | undefined;
         unique?: boolean | undefined;
+        deprecated?: boolean | undefined;
         collection?: string | undefined;
         default?: string | import("drizzle-orm").SQL<any> | undefined;
         multiline?: boolean | undefined;
@@ -77,6 +82,7 @@ export declare const column: {
                 name?: string | undefined;
                 label?: string | undefined;
                 unique?: boolean | undefined;
+                deprecated?: boolean | undefined;
                 collection?: string | undefined;
                 default?: string | import("drizzle-orm").SQL<any> | undefined;
                 multiline?: boolean | undefined;
@@ -87,6 +93,7 @@ export declare const column: {
                 name?: string | undefined;
                 label?: string | undefined;
                 unique?: boolean | undefined;
+                deprecated?: boolean | undefined;
                 collection?: string | undefined;
                 default?: string | import("drizzle-orm").SQL<any> | undefined;
                 multiline?: boolean | undefined;
@@ -107,6 +114,7 @@ export declare const column: {
         label?: string | undefined;
         optional?: boolean | undefined;
         unique?: boolean | undefined;
+        deprecated?: boolean | undefined;
         collection?: string | undefined;
         default?: Date | import("drizzle-orm").SQL<any> | undefined;
     }>(opts?: T_3): {
@@ -121,6 +129,7 @@ export declare const column: {
         label?: string | undefined;
         optional?: boolean | undefined;
         unique?: boolean | undefined;
+        deprecated?: boolean | undefined;
         collection?: string | undefined;
         default?: unknown;
     }>(opts?: T_4): {

package/dist/runtime/db-client.js

@@ -5,7 +5,6 @@ import { z } from "zod";
 const isWebContainer = !!process.versions?.webcontainer;
 function createLocalDatabaseClient({ dbUrl }) {
   const url = isWebContainer ? "file:content.db" : dbUrl;
-  console.log("memory", process.env.TEST_IN_MEMORY_DB);
   const client = createClient({ url: process.env.TEST_IN_MEMORY_DB ? ":memory:" : url });
   const db = drizzleLibsql(client);
   return db;

package/dist/runtime/queries.d.ts

@@ -10,6 +10,7 @@ export declare function recreateTables({ db, tables }: {
     db: SqliteDB;
     tables: DBTables;
 }): Promise<void>;
+export declare function getDropTableIfExistsQuery(tableName: string): string;
 export declare function getCreateTableQuery(tableName: string, table: DBTable): string;
 export declare function getCreateIndexQueries(tableName: string, table: Pick<DBTable, 'indexes'>): string[];
 export declare function getCreateForeignKeyQueries(tableName: string, table: DBTable): string[];
@@ -19,6 +20,7 @@ export declare function getReferencesConfig(column: DBColumn): {
     type: "number";
     schema: ({
         unique: boolean;
+        deprecated: boolean;
         name?: string | undefined;
         label?: string | undefined;
         collection?: string | undefined;
@@ -30,6 +32,7 @@ export declare function getReferencesConfig(column: DBColumn): {
         references?: any | undefined;
     }) | ({
         unique: boolean;
+        deprecated: boolean;
         name?: string | undefined;
         label?: string | undefined;
         collection?: string | undefined;
@@ -44,6 +47,7 @@ export declare function getReferencesConfig(column: DBColumn): {
     type: "text";
     schema: ({
         unique: boolean;
+        deprecated: boolean;
         name?: string | undefined;
         label?: string | undefined;
         collection?: string | undefined;
@@ -56,6 +60,7 @@ export declare function getReferencesConfig(column: DBColumn): {
         references?: any | undefined;
     }) | ({
         unique: boolean;
+        deprecated: boolean;
         name?: string | undefined;
         label?: string | undefined;
         collection?: string | undefined;

package/dist/runtime/queries.js

@@ -46,6 +46,9 @@ async function recreateTables({ db, tables }) {
     ...setupQueries.map((q) => db.run(q))
   ]);
 }
+function getDropTableIfExistsQuery(tableName) {
+  return `DROP TABLE IF EXISTS ${sqlite.escapeName(tableName)}`;
+}
 function getCreateTableQuery(tableName, table) {
   let query = `CREATE TABLE ${sqlite.escapeName(tableName)} (`;
   const colQueries = [];
@@ -193,6 +196,7 @@ export {
   getCreateForeignKeyQueries,
   getCreateIndexQueries,
   getCreateTableQuery,
+  getDropTableIfExistsQuery,
   getModifiers,
   getReferencesConfig,
   hasDefault,

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@astrojs/db",
-  "version": "0.5.0",
+  "version": "0.6.1",
   "description": "",
   "license": "MIT",
   "type": "module",
-  "types": "./index.d.ts",
   "author": "withastro",
+  "types": "./index.d.ts",
   "main": "./dist/index.js",
   "exports": {
     ".": {
@@ -51,7 +51,6 @@
   },
   "files": [
     "index.d.ts",
-    "config-augment.d.ts",
     "dist"
   ],
   "keywords": [
@@ -83,7 +82,7 @@
     "mocha": "^10.2.0",
     "typescript": "^5.2.2",
     "vite": "^5.1.4",
-    "astro": "4.4.9",
+    "astro": "4.4.11",
     "astro-scripts": "0.0.14"
   },
   "scripts": {

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

@@ -1,8 +0,0 @@
-import type { AstroConfig } from 'astro';
-import type { Arguments } from 'yargs-parser';
-import type { DBConfig } from '../../../types.js';
-export declare function cmd({ astroConfig, dbConfig, }: {
-    astroConfig: AstroConfig;
-    dbConfig: DBConfig;
-    flags: Arguments;
-}): Promise<void>;

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

@@ -1,47 +0,0 @@
-import { writeFile } from "node:fs/promises";
-import { relative } from "node:path";
-import { fileURLToPath } from "node:url";
-import { bgRed, bold, red, reset } from "kleur/colors";
-import { getMigrationsDirectoryUrl } from "../../../utils.js";
-import { getMigrationQueries } from "../../migration-queries.js";
-import {
-  MIGRATIONS_CREATED,
-  MIGRATIONS_UP_TO_DATE,
-  getMigrationStatus,
-  initializeMigrationsDirectory
-} from "../../migrations.js";
-async function cmd({
-  astroConfig,
-  dbConfig
-}) {
-  const migration = await getMigrationStatus({ dbConfig, root: astroConfig.root });
-  const migrationsDir = getMigrationsDirectoryUrl(astroConfig.root);
-  if (migration.state === "no-migrations-found") {
-    await initializeMigrationsDirectory(migration.currentSnapshot, migrationsDir);
-    console.log(MIGRATIONS_CREATED);
-    return;
-  } else if (migration.state === "up-to-date") {
-    console.log(MIGRATIONS_UP_TO_DATE);
-    return;
-  }
-  const { oldSnapshot, newSnapshot, newFilename, diff } = migration;
-  const { queries: migrationQueries, confirmations } = await getMigrationQueries({
-    oldSnapshot,
-    newSnapshot
-  });
-  confirmations.map((message) => console.log(bgRed(" !!! ") + " " + red(message)));
-  const content = {
-    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 fileUrl = new URL(newFilename, migrationsDir);
-  const relativePath = relative(fileURLToPath(astroConfig.root), fileURLToPath(fileUrl));
-  await writeFile(fileUrl, JSON.stringify(content, void 0, 2));
-  console.log(bold(relativePath) + " created!");
-}
-export {
-  cmd
-};

package/dist/core/cli/migrations.d.ts

@@ -1,37 +0,0 @@
-import deepDiff from 'deep-diff';
-import { type DBConfig, type DBSnapshot } from '../types.js';
-export type MigrationStatus = {
-    state: 'no-migrations-found';
-    currentSnapshot: DBSnapshot;
-} | {
-    state: 'ahead';
-    oldSnapshot: DBSnapshot;
-    newSnapshot: DBSnapshot;
-    diff: deepDiff.Diff<DBSnapshot, DBSnapshot>[];
-    newFilename: string;
-    summary: string;
-    newFileContent?: string;
-} | {
-    state: 'up-to-date';
-    currentSnapshot: DBSnapshot;
-};
-export declare const INITIAL_SNAPSHOT = "0000_snapshot.json";
-export declare function getMigrationStatus({ dbConfig, root, }: {
-    dbConfig: DBConfig;
-    root: URL;
-}): Promise<MigrationStatus>;
-export declare const MIGRATIONS_CREATED: string;
-export declare const MIGRATIONS_UP_TO_DATE: string;
-export declare const MIGRATIONS_NOT_INITIALIZED: string;
-export declare const MIGRATION_NEEDED: string;
-export declare function getMigrations(dir: URL): Promise<string[]>;
-export declare function loadMigration(migration: string, dir: URL): Promise<{
-    diff: any[];
-    db: string[];
-    confirm?: string[];
-}>;
-export declare function loadInitialSnapshot(dir: URL): Promise<DBSnapshot>;
-export declare function initializeMigrationsDirectory(currentSnapshot: DBSnapshot, dir: URL): Promise<void>;
-export declare function initializeFromMigrations(allMigrationFiles: string[], dir: URL): Promise<DBSnapshot>;
-export declare function createCurrentSnapshot({ tables }: DBConfig): DBSnapshot;
-export declare function createEmptySnapshot(): DBSnapshot;

package/dist/core/cli/migrations.js

@@ -1,135 +0,0 @@
-import deepDiff from "deep-diff";
-import { mkdir, readFile, readdir, writeFile } from "fs/promises";
-import { cyan, green, yellow } from "kleur/colors";
-import {} from "../types.js";
-import { getMigrationsDirectoryUrl } from "../utils.js";
-const { applyChange, diff: generateDiff } = deepDiff;
-const INITIAL_SNAPSHOT = "0000_snapshot.json";
-async function getMigrationStatus({
-  dbConfig,
-  root
-}) {
-  const currentSnapshot = createCurrentSnapshot(dbConfig);
-  const dir = getMigrationsDirectoryUrl(root);
-  const allMigrationFiles = await getMigrations(dir);
-  if (allMigrationFiles.length === 0) {
-    return {
-      state: "no-migrations-found",
-      currentSnapshot
-    };
-  }
-  const previousSnapshot = await initializeFromMigrations(allMigrationFiles, dir);
-  const diff = generateDiff(previousSnapshot, currentSnapshot);
-  if (diff) {
-    const n = getNewMigrationNumber(allMigrationFiles);
-    const newFilename = `${String(n + 1).padStart(4, "0")}_migration.json`;
-    return {
-      state: "ahead",
-      oldSnapshot: previousSnapshot,
-      newSnapshot: currentSnapshot,
-      diff,
-      newFilename,
-      summary: generateDiffSummary(diff)
-    };
-  }
-  return {
-    state: "up-to-date",
-    currentSnapshot
-  };
-}
-const MIGRATIONS_CREATED = `${green(
-  "\u25A0 Migrations initialized!"
-)}
-
-  To execute your migrations, run
-  ${cyan("astro db push")}`;
-const MIGRATIONS_UP_TO_DATE = `${green(
-  "\u25A0 No migrations needed!"
-)}
-
-  Your database is up to date.
-`;
-const MIGRATIONS_NOT_INITIALIZED = `${yellow(
-  "\u25B6 No migrations found!"
-)}
-
-  To scaffold your migrations folder, run
-  ${cyan("astro db sync")}
-`;
-const MIGRATION_NEEDED = `${yellow(
-  "\u25B6 Changes detected!"
-)}
-
-  To create the necessary migration file, run
-  ${cyan("astro db sync")}
-`;
-function generateDiffSummary(diff) {
-  return JSON.stringify(diff, null, 2);
-}
-function getNewMigrationNumber(allMigrationFiles) {
-  const len = allMigrationFiles.length - 1;
-  return allMigrationFiles.reduce((acc, curr) => {
-    const num = Number.parseInt(curr.split("_")[0] ?? len, 10);
-    return num > acc ? num : acc;
-  }, 0);
-}
-async function getMigrations(dir) {
-  const migrationFiles = await readdir(dir).catch((err) => {
-    if (err.code === "ENOENT") {
-      return [];
-    }
-    throw err;
-  });
-  return migrationFiles;
-}
-async function loadMigration(migration, dir) {
-  return JSON.parse(await readFile(new URL(migration, dir), "utf-8"));
-}
-async function loadInitialSnapshot(dir) {
-  const snapshot = JSON.parse(await readFile(new URL(INITIAL_SNAPSHOT, dir), "utf-8"));
-  if (snapshot.experimentalVersion === 1) {
-    return snapshot;
-  }
-  if (!snapshot.schema) {
-    return { experimentalVersion: 1, schema: snapshot };
-  }
-  throw new Error("Invalid snapshot format");
-}
-async function initializeMigrationsDirectory(currentSnapshot, dir) {
-  await mkdir(dir, { recursive: true });
-  await writeFile(new URL(INITIAL_SNAPSHOT, dir), JSON.stringify(currentSnapshot, void 0, 2));
-}
-async function initializeFromMigrations(allMigrationFiles, dir) {
-  const prevSnapshot = await loadInitialSnapshot(dir);
-  for (const migration of allMigrationFiles) {
-    if (migration === INITIAL_SNAPSHOT)
-      continue;
-    const migrationContent = await loadMigration(migration, dir);
-    migrationContent.diff.forEach((change) => {
-      applyChange(prevSnapshot, {}, change);
-    });
-  }
-  return prevSnapshot;
-}
-function createCurrentSnapshot({ tables = {} }) {
-  const schema = JSON.parse(JSON.stringify(tables));
-  return { experimentalVersion: 1, schema };
-}
-function createEmptySnapshot() {
-  return { experimentalVersion: 1, schema: {} };
-}
-export {
-  INITIAL_SNAPSHOT,
-  MIGRATIONS_CREATED,
-  MIGRATIONS_NOT_INITIALIZED,
-  MIGRATIONS_UP_TO_DATE,
-  MIGRATION_NEEDED,
-  createCurrentSnapshot,
-  createEmptySnapshot,
-  getMigrationStatus,
-  getMigrations,
-  initializeFromMigrations,
-  initializeMigrationsDirectory,
-  loadInitialSnapshot,
-  loadMigration
-};