@astrojs/db 0.3.4 → 0.3.6-nightly-01234567890

package/dist/cli/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

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

@@ -0,0 +1 @@
+export declare function cmd(): Promise<void>;

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

@@ -0,0 +1,4 @@
+import type { AstroConfig } from 'astro';
+export declare function cmd({}: {
+    config: Pick<AstroConfig, 'db'>;
+}): Promise<void>;

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

@@ -0,0 +1 @@
+export declare function cmd(): Promise<void>;

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

@@ -0,0 +1,4 @@
+import type { AstroConfig } from 'astro';
+export declare function cmd({ config }: {
+    config: Pick<AstroConfig, 'db'>;
+}): Promise<void>;

package/dist/cli/util.d.ts

@@ -0,0 +1,34 @@
+export declare function createRemoteDbClient(appToken: string): import("drizzle-orm/sqlite-proxy").SqliteRemoteDatabase<Record<string, never>>;
+export declare const STUDIO_ADMIN_TABLE = "ReservedAstroStudioAdmin";
+export declare const STUDIO_ADMIN_TABLE_ROW_ID = "admin";
+export declare const adminTable: import("drizzle-orm/sqlite-core").SQLiteTableWithColumns<{
+    name: "ReservedAstroStudioAdmin";
+    schema: undefined;
+    columns: {
+        id: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "id";
+            tableName: "ReservedAstroStudioAdmin";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+        collections: import("drizzle-orm/sqlite-core").SQLiteColumn<{
+            name: "collections";
+            tableName: "ReservedAstroStudioAdmin";
+            dataType: "string";
+            columnType: "SQLiteText";
+            data: string;
+            driverParam: string;
+            notNull: true;
+            hasDefault: false;
+            enumValues: [string, ...string[]];
+            baseColumn: never;
+        }, object>;
+    };
+    dialect: "sqlite";
+}>;

package/dist/config.d.ts

@@ -1,12 +1,13 @@
 import type { SQLiteInsertValue } from 'drizzle-orm/sqlite-core';
 import type { SqliteDB, Table } from './internal.js';
 import type { MaybeArray, collectionSchema } from './types.js';
-import { type BooleanField, type DBFieldInput, type DateFieldInput, type JsonField, type NumberField, type TextField, type indexSchema, type MaybePromise } from './types.js';
+import { type BooleanField, type DBFieldInput, type DateFieldInput, type JsonField, type NumberField, type TextField, type MaybePromise } from './types.js';
 import { z } from 'zod';
+export type DBFieldsConfig = z.input<typeof collectionSchema>['fields'];
 export type DBDataContext = {
     db: SqliteDB;
-    seed<TFields extends FieldsConfig>(collection: ResolvedCollectionConfig<TFields>, data: MaybeArray<SQLiteInsertValue<Table<string, 
-    /** TODO: true type inference */ Record<Extract<keyof TFields, string>, FieldsConfig[number]>>>>): Promise<any> /** TODO: type output */;
+    seed<TFields extends DBFieldsConfig>(collection: ResolvedCollectionConfig<TFields>, data: MaybeArray<SQLiteInsertValue<Table<string, 
+    /** TODO: true type inference */ Record<Extract<keyof TFields, string>, DBFieldsConfig[number]>>>>): Promise<any> /** TODO: type output */;
     mode: 'dev' | 'build';
 };
 export declare const dbConfigSchema: z.ZodObject<{
@@ -112,19 +113,9 @@ export declare const dbConfigSchema: z.ZodObject<{
             unique?: boolean | undefined;
             default?: unknown;
         }>]>>;
-        indexes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            on: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
-            unique: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }>>>;
+        writable: z.ZodLiteral<false>;
         table: z.ZodAny;
         _setMeta: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
-        writable: z.ZodLiteral<false>;
     }, "strip", z.ZodTypeAny, {
         fields: Record<string, {
             type: "boolean";
@@ -161,10 +152,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: false;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }, {
@@ -203,10 +190,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: false;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }>, z.ZodObject<{
@@ -310,19 +293,9 @@ export declare const dbConfigSchema: z.ZodObject<{
             unique?: boolean | undefined;
             default?: unknown;
         }>]>>;
-        indexes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-            on: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
-            unique: z.ZodOptional<z.ZodBoolean>;
-        }, "strip", z.ZodTypeAny, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }>>>;
+        writable: z.ZodLiteral<true>;
         table: z.ZodAny;
         _setMeta: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
-        writable: z.ZodLiteral<true>;
     }, "strip", z.ZodTypeAny, {
         fields: Record<string, {
             type: "boolean";
@@ -359,10 +332,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: true;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }, {
@@ -401,10 +370,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: true;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }>]>>>;
@@ -447,10 +412,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: false;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     } | {
@@ -489,10 +450,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: true;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }> | undefined;
@@ -535,10 +492,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: false;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     } | {
@@ -577,10 +530,6 @@ export declare const dbConfigSchema: z.ZodObject<{
             default?: unknown;
         }>;
         writable: true;
-        indexes?: Record<string, {
-            on: (string | string[]) & (string | string[] | undefined);
-            unique?: boolean | undefined;
-        }> | undefined;
         table?: any;
         _setMeta?: ((...args: unknown[]) => unknown) | undefined;
     }> | undefined;
@@ -693,19 +642,9 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 unique?: boolean | undefined;
                 default?: unknown;
             }>]>>;
-            indexes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-                on: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
-                unique: z.ZodOptional<z.ZodBoolean>;
-            }, "strip", z.ZodTypeAny, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }>>>;
+            writable: z.ZodLiteral<false>;
             table: z.ZodAny;
             _setMeta: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
-            writable: z.ZodLiteral<false>;
         }, "strip", z.ZodTypeAny, {
             fields: Record<string, {
                 type: "boolean";
@@ -742,10 +681,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }, {
@@ -784,10 +719,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }>, z.ZodObject<{
@@ -891,19 +822,9 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 unique?: boolean | undefined;
                 default?: unknown;
             }>]>>;
-            indexes: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodObject<{
-                on: z.ZodUnion<[z.ZodString, z.ZodArray<z.ZodString, "many">]>;
-                unique: z.ZodOptional<z.ZodBoolean>;
-            }, "strip", z.ZodTypeAny, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }>>>;
+            writable: z.ZodLiteral<true>;
             table: z.ZodAny;
             _setMeta: z.ZodOptional<z.ZodFunction<z.ZodTuple<[], z.ZodUnknown>, z.ZodUnknown>>;
-            writable: z.ZodLiteral<true>;
         }, "strip", z.ZodTypeAny, {
             fields: Record<string, {
                 type: "boolean";
@@ -940,10 +861,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }, {
@@ -982,10 +899,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }>]>>>;
@@ -1028,10 +941,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         } | {
@@ -1070,10 +979,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }> | undefined;
@@ -1116,10 +1021,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         } | {
@@ -1158,10 +1059,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }> | undefined;
@@ -1206,10 +1103,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         } | {
@@ -1248,10 +1141,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }> | undefined;
@@ -1296,10 +1185,6 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: false;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         } | {
@@ -1338,30 +1223,21 @@ export declare const astroConfigWithDbSchema: z.ZodObject<{
                 default?: unknown;
             }>;
             writable: true;
-            indexes?: Record<string, {
-                on: (string | string[]) & (string | string[] | undefined);
-                unique?: boolean | undefined;
-            }> | undefined;
             table?: any;
             _setMeta?: ((...args: unknown[]) => unknown) | undefined;
         }> | undefined;
         data?: ((...args: unknown[]) => void | Promise<void>) | undefined;
     } | undefined;
 }>;
-export type FieldsConfig = z.input<typeof collectionSchema>['fields'];
-interface CollectionConfig<TFields extends FieldsConfig> extends Pick<z.input<typeof collectionSchema>, 'fields' | 'indexes'> {
+type CollectionConfig<TFields extends DBFieldsConfig> = {
     fields: TFields;
-    indexes?: Record<string, IndexConfig<TFields>>;
-}
-interface IndexConfig<TFields extends FieldsConfig> extends z.input<typeof indexSchema> {
-    on: MaybeArray<Extract<keyof TFields, string>>;
-}
-export type ResolvedCollectionConfig<TFields extends FieldsConfig = FieldsConfig, Writable extends boolean = boolean> = CollectionConfig<TFields> & {
+};
+export type ResolvedCollectionConfig<TFields extends DBFieldsConfig = DBFieldsConfig, Writable extends boolean = boolean> = CollectionConfig<TFields> & {
     writable: Writable;
     table: Table<string, TFields>;
 };
-export declare function defineCollection<TFields extends FieldsConfig>(userConfig: CollectionConfig<TFields>): ResolvedCollectionConfig<TFields, false>;
-export declare function defineWritableCollection<TFields extends FieldsConfig>(userConfig: CollectionConfig<TFields>): ResolvedCollectionConfig<TFields, true>;
+export declare function defineCollection<TFields extends DBFieldsConfig>(userConfig: CollectionConfig<TFields>): ResolvedCollectionConfig<TFields, false>;
+export declare function defineWritableCollection<TFields extends DBFieldsConfig>(userConfig: CollectionConfig<TFields>): ResolvedCollectionConfig<TFields, true>;
 export type AstroConfigWithDB = z.infer<typeof astroConfigWithDbSchema>;
 type FieldOpts<T extends DBFieldInput> = Omit<T, 'type'>;
 export declare const field: {

package/dist/core/cli/commands/gen/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/core/cli/commands/link/index.js

@@ -27,12 +27,16 @@ async function cmd({ flags }) {
   });
   if (!response.ok) {
     if (response.status === 401) {
-      console.error(`${bgRed("Unauthorized")}
+      console.error(
+        `${bgRed("Unauthorized")}
 
   Are you logged in?
-  Run ${cyan("astro db login")} to authenticate and then try linking again.
+  Run ${cyan(
+          "astro db login"
+        )} to authenticate and then try linking again.
 
-`);
+`
+      );
       process.exit(1);
     }
     console.error(`Failed to link project: ${response.status} ${response.statusText}`);

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

@@ -6,7 +6,7 @@ import { red } from "kleur/colors";
 import prompts from "prompts";
 import { recreateTables, seedData } from "../../../queries.js";
 import { getManagedAppTokenOrExit } from "../../../tokens.js";
-import { collectionsSchema } from "../../../types.js";
+import { tablesSchema } from "../../../types.js";
 import { getRemoteDatabaseUrl } from "../../../utils.js";
 import { getMigrationQueries } from "../../migration-queries.js";
 import {
@@ -112,9 +112,9 @@ async function pushData({
     const libsqlClient = createClient({ url: ":memory:" });
     await recreateTables({
       db: drizzleLibsql(libsqlClient),
-      collections: collectionsSchema.parse(config.db.collections ?? {})
+      tables: tablesSchema.parse(config.db.tables ?? {})
     });
-    for (const [collectionName, { writable }] of Object.entries(config.db.collections ?? {})) {
+    for (const [collectionName, { writable }] of Object.entries(config.db.tables ?? {})) {
       if (!writable) {
         queries.push({
           sql: `DELETE FROM ${sqlite.escapeName(collectionName)}`,

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

@@ -1,4 +1,9 @@
-import { getMigrationStatus, MIGRATION_NEEDED, MIGRATIONS_NOT_INITIALIZED, MIGRATIONS_UP_TO_DATE } from "../../migrations.js";
+import {
+  getMigrationStatus,
+  MIGRATION_NEEDED,
+  MIGRATIONS_NOT_INITIALIZED,
+  MIGRATIONS_UP_TO_DATE
+} from "../../migrations.js";
 import { getMigrationQueries } from "../../migration-queries.js";
 async function cmd({ config, flags }) {
   const status = await getMigrationStatus(config);

package/dist/core/cli/index.js

@@ -1,6 +1,7 @@
 import { STUDIO_CONFIG_MISSING_CLI_ERROR } from "../errors.js";
 async function cli({ flags, config }) {
-  const command = flags._[3];
+  const args = flags._;
+  const command = args[2] === "db" ? args[3] : args[2];
   if (!config.db?.studio) {
     console.log(STUDIO_CONFIG_MISSING_CLI_ERROR);
     process.exit(1);
@@ -10,8 +11,9 @@ async function cli({ flags, config }) {
       const { cmd } = await import("./commands/shell/index.js");
       return await cmd({ config, flags });
     }
+    case "gen":
     case "sync": {
-      const { cmd } = await import("./commands/sync/index.js");
+      const { cmd } = await import("./commands/gen/index.js");
       return await cmd({ config, flags });
     }
     case "push": {
@@ -52,11 +54,11 @@ ${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 login          Authenticate your machine with Astro Studio
+astro logout         End your authenticated session with Astro Studio
+astro link           Link this directory to an Astro Studio project
 
-astro db sync        Creates snapshot based on your schema
+astro db gen         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,8 +1,8 @@
-import type { DBCollection, DBSnapshot } from '../types.js';
+import { type DBTable, type DBSnapshot } from '../types.js';
 /** Dependency injected for unit testing */
 type AmbiguityResponses = {
     collectionRenames: Record<string, string>;
-    fieldRenames: {
+    columnRenames: {
         [collectionName: string]: Record<string, string>;
     };
 };
@@ -16,8 +16,8 @@ export declare function getMigrationQueries({ oldSnapshot, newSnapshot, ambiguit
 }>;
 export declare function getCollectionChangeQueries({ collectionName, oldCollection, newCollection, ambiguityResponses, }: {
     collectionName: string;
-    oldCollection: DBCollection;
-    newCollection: DBCollection;
+    oldCollection: DBTable;
+    newCollection: DBTable;
     ambiguityResponses?: AmbiguityResponses;
 }): Promise<{
     queries: string[];