@astrojs/db 0.1.0

package/LICENSE

@@ -0,0 +1,59 @@
+MIT License
+
+Copyright (c) 2021 Fred K. Schott
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+"""
+This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/sveltejs/kit repository:
+
+Copyright (c) 2020 [these people](https://github.com/sveltejs/kit/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+"""
+
+"""
+This license applies to parts of the `packages/create-astro` and `packages/astro` subdirectories originating from the https://github.com/vitejs/vite repository:
+
+MIT License
+
+Copyright (c) 2019-present, Yuxi (Evan) You and Vite contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""

package/components/Renderer.astro

@@ -0,0 +1,14 @@
+---
+import { Renderer as MarkdocRenderer } from '@astrojs/markdoc/components';
+import { Markdoc } from '@astrojs/markdoc/config';
+
+interface Props {
+	content: string;
+}
+
+const { content } = Astro.props;
+
+const ast = Markdoc.parse(content);
+---
+
+<MarkdocRenderer stringifiedAst={JSON.stringify(ast)} config={{}} />

package/components/astro-env.d.ts

@@ -0,0 +1 @@
+/// <reference types="astro/client" />

package/components/index.ts

@@ -0,0 +1,2 @@
+// @ts-expect-error: missing types
+export { default as Renderer } from './Renderer.astro';

package/components/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "astro/tsconfigs/strict",
+  "include": ["."],
+  "compilerOptions": {
+    "strictNullChecks": true
+  }
+}

package/config-augment.d.ts

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

package/dist/cli/commands/push/index.d.ts

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

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

@@ -0,0 +1,144 @@
+import deepDiff from "deep-diff";
+import { eq, sql } from "drizzle-orm";
+import { SQLiteAsyncDialect } from "drizzle-orm/sqlite-core";
+import { appTokenError } from "../../../errors.js";
+import { collectionToTable, createLocalDatabaseClient } from "../../../internal.js";
+import { getMigrations, initializeFromMigrations, loadInitialSnapshot, loadMigration } from "../../../migrations.js";
+import {
+  STUDIO_ADMIN_TABLE_ROW_ID,
+  adminTable,
+  createRemoteDatabaseClient,
+  getAstroStudioEnv,
+  getRemoteDatabaseUrl,
+  migrationsTable
+} from "../../../utils.js";
+import { getMigrationQueries } from "../../queries.js";
+const { diff } = deepDiff;
+const sqliteDialect = new SQLiteAsyncDialect();
+async function cmd({ config, flags }) {
+  const isSeedData = flags.seed;
+  const isDryRun = flags.dryRun;
+  const currentDb = config.db?.collections ?? {};
+  const currentSnapshot = JSON.parse(JSON.stringify(currentDb));
+  const allMigrationFiles = await getMigrations();
+  if (allMigrationFiles.length === 0) {
+    console.log("Project not yet initialized!");
+    process.exit(1);
+  }
+  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
+  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
+  if (calculatedDiff) {
+    console.log("Changes detected!");
+    process.exit(1);
+  }
+  const appToken = getAstroStudioEnv().ASTRO_STUDIO_APP_TOKEN;
+  if (!appToken) {
+    console.error(appTokenError);
+    process.exit(1);
+  }
+  const db = createRemoteDatabaseClient(appToken);
+  await db.run(
+    sql`CREATE TABLE IF NOT EXISTS ReservedAstroStudioMigrations ( name TEXT PRIMARY KEY )`
+  );
+  const allRemoteMigrations = await db.select().from(migrationsTable);
+  const allLocalMigrations = await getMigrations();
+  const missingMigrations = allLocalMigrations.filter((migration) => {
+    return !allRemoteMigrations.find((m) => m.name === migration);
+  });
+  if (missingMigrations.length === 0) {
+    console.info("No migrations to push! Your database is up to date!");
+  } else {
+    console.log(`Pushing ${missingMigrations.length} migrations...`);
+    await pushSchema({ migrations: missingMigrations, appToken, isDryRun, db, currentSnapshot });
+  }
+  if (isSeedData) {
+    console.info("Pushing data...");
+    await tempDataPush({ currentDb, appToken, isDryRun });
+  }
+  console.info("Push complete!");
+}
+async function pushSchema({
+  migrations,
+  appToken,
+  isDryRun,
+  db,
+  currentSnapshot
+}) {
+  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({
+    oldCollections: {},
+    newCollections: await loadInitialSnapshot()
+  }) : [];
+  const missingMigrationBatch = missingMigrationContents.reduce((acc, curr) => {
+    return [...acc, ...curr.db];
+  }, initialMigrationBatch);
+  const queries = missingMigrationBatch.map((q) => sql.raw(q));
+  await runBatchQuery({ queries, appToken, isDryRun });
+  await db.insert(migrationsTable).values(migrations.map((m) => ({ name: m })));
+  await db.update(adminTable).set({ collections: JSON.stringify(currentSnapshot) }).where(eq(adminTable.id, STUDIO_ADMIN_TABLE_ROW_ID));
+}
+async function tempDataPush({
+  currentDb,
+  appToken,
+  isDryRun
+}) {
+  const db = await createLocalDatabaseClient({
+    collections: JSON.parse(JSON.stringify(currentDb)),
+    dbUrl: ":memory:",
+    seeding: true
+  });
+  const queries = [];
+  for (const [name, collection] of Object.entries(currentDb)) {
+    console.log(name, collection);
+    if (collection.writable || !collection.data)
+      continue;
+    const table = collectionToTable(name, collection);
+    const insert = db.insert(table).values(await collection.data());
+    queries.push(insert.toSQL());
+  }
+  console.log(queries);
+  const url = new URL("/db/query", getRemoteDatabaseUrl());
+  const requestBody = queries.map((q) => ({
+    sql: q.sql,
+    args: q.params
+  }));
+  if (isDryRun) {
+    console.info("[DRY RUN] Batch data seed:", JSON.stringify(requestBody, null, 2));
+    return new Response(null, { status: 200 });
+  }
+  return await fetch(url, {
+    method: "POST",
+    headers: new Headers({
+      Authorization: `Bearer ${appToken}`
+    }),
+    body: JSON.stringify(requestBody)
+  });
+}
+async function runBatchQuery({
+  queries: sqlQueries,
+  appToken,
+  isDryRun
+}) {
+  const queries = sqlQueries.map((q) => sqliteDialect.sqlToQuery(q));
+  const requestBody = queries.map((q) => ({
+    sql: q.sql,
+    args: q.params
+  }));
+  if (isDryRun) {
+    console.info("[DRY RUN] Batch query:", JSON.stringify(requestBody, null, 2));
+    return new Response(null, { status: 200 });
+  }
+  const url = new URL("/db/query", getRemoteDatabaseUrl());
+  return await fetch(url, {
+    method: "POST",
+    headers: new Headers({
+      Authorization: `Bearer ${appToken}`
+    }),
+    body: JSON.stringify(requestBody)
+  });
+}
+export {
+  cmd
+};

package/dist/cli/commands/sync/index.d.ts

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

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

@@ -0,0 +1,45 @@
+import deepDiff from "deep-diff";
+import { writeFile } from "fs/promises";
+import {
+  getMigrations,
+  initializeFromMigrations,
+  initializeMigrationsDirectory
+} from "../../../migrations.js";
+import { getMigrationQueries } from "../../queries.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) {
+    await initializeMigrationsDirectory(currentSnapshot);
+    console.log("Project initialized!");
+    return;
+  }
+  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
+  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
+  if (!calculatedDiff) {
+    console.log("No changes detected!");
+    return;
+  }
+  const migrationQueries = await getMigrationQueries({
+    oldCollections: prevSnapshot,
+    newCollections: currentSnapshot
+  });
+  const largestNumber = allMigrationFiles.reduce((acc, curr) => {
+    const num = parseInt(curr.split("_")[0]);
+    return num > acc ? num : acc;
+  }, 0);
+  const migrationFileContent = {
+    diff: calculatedDiff,
+    db: migrationQueries
+  };
+  const migrationFileName = `./migrations/${String(largestNumber + 1).padStart(
+    4,
+    "0"
+  )}_migration.json`;
+  await writeFile(migrationFileName, JSON.stringify(migrationFileContent, void 0, 2));
+  console.log(migrationFileName + " created!");
+}
+export {
+  cmd
+};

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

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

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

@@ -0,0 +1,25 @@
+import deepDiff from "deep-diff";
+import {
+  getMigrations,
+  initializeFromMigrations
+} from "../../../migrations.js";
+const { diff, applyChange } = 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);
+  }
+  const prevSnapshot = await initializeFromMigrations(allMigrationFiles);
+  const calculatedDiff = diff(prevSnapshot, currentSnapshot);
+  if (calculatedDiff) {
+    console.log("Changes detected!");
+    process.exit(1);
+  }
+  console.log("No changes detected.");
+  return;
+}
+export {
+  cmd
+};

package/dist/cli/index.d.ts

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

package/dist/cli/index.js

@@ -0,0 +1,24 @@
+async function cli({ flags, config }) {
+  const command = flags._[3];
+  switch (command) {
+    case "sync": {
+      const { cmd: syncCommand } = await import("./commands/sync/index.js");
+      return await syncCommand({ config, flags });
+    }
+    case "push": {
+      const { cmd: pushCommand } = await import("./commands/push/index.js");
+      return await pushCommand({ config, flags });
+    }
+    case "verify": {
+      const { cmd: verifyCommand } = await import("./commands/verify/index.js");
+      return await verifyCommand({ config, flags });
+    }
+    default: {
+      console.error(`Unknown command: ${command}`);
+      return;
+    }
+  }
+}
+export {
+  cli
+};

package/dist/cli/queries.d.ts

@@ -0,0 +1,19 @@
+import type { DBCollection, DBCollections } from '../types.js';
+interface PromptResponses {
+    allowDataLoss: boolean;
+    fieldRenames: Record<string, string | false>;
+    collectionRenames: Record<string, string | false>;
+}
+export declare function getMigrationQueries({ oldCollections, newCollections, promptResponses, }: {
+    oldCollections: DBCollections;
+    newCollections: DBCollections;
+    promptResponses?: PromptResponses;
+}): Promise<string[]>;
+export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, promptResponses, }: {
+    collectionName: string;
+    oldCollection: DBCollection;
+    newCollection: DBCollection;
+    promptResponses?: PromptResponses;
+}): Promise<string[]>;
+export declare function getCreateTableQuery(collectionName: string, collection: DBCollection): string;
+export {};