Feat/pgroll cli edit remove xatatype

.changeset/light-cycles-repair.md

@@ -0,0 +1,5 @@
+---
+'@xata.io/client': major
+---
+
+Make XataApiClient to use ES Proxies

.changeset/pre.json

@@ -0,0 +1,15 @@
+{
+  "mode": "pre",
+  "tag": "next",
+  "initialVersions": {
+    "@xata.io/cli": "0.15.3",
+    "@xata.io/client": "0.28.2",
+    "@xata.io/codegen": "0.28.2",
+    "@xata.io/importer": "1.1.3",
+    "@xata.io/drizzle": "0.0.13",
+    "@xata.io/kysely": "0.1.13",
+    "@xata.io/netlify": "0.1.23",
+    "@xata.io/plugin-client-opentelemetry": "0.2.37"
+  },
+  "changesets": []
+}

.changeset/violet-worms-develop.md

@@ -0,0 +1,12 @@
+---
+'@xata.io/cli': major
+'@xata.io/client': major
+'@xata.io/codegen': major
+'@xata.io/importer': major
+'@xata.io/drizzle': major
+'@xata.io/kysely': major
+'@xata.io/netlify': major
+'@xata.io/plugin-client-opentelemetry': major
+---
+
+Version 1.0

.github/workflows/build-pr.yml

@@ -110,8 +110,6 @@ jobs:
           cat << EOF > .changeset/force-canary-build.md
           ---
           '@xata.io/plugin-client-opentelemetry': patch
-          '@xata.io/plugin-client-cloudflare': patch
-          '@xata.io/plugin-client-cache': patch
           '@xata.io/drizzle': patch
           '@xata.io/kysely': patch
           '@xata.io/pgroll': patch

.github/workflows/release.yml

@@ -52,8 +52,9 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GIT_TOKEN }}
         run: |
-          npx changeset version
-          npx changeset publish
+          npx changeset pre exit
+          npx changeset version --snapshot next
+          npx changeset publish --tag next --no-git-tag
 
       - name: Create Release Pull Request or Publish to npm
         uses: changesets/action@v1

cli/package.json

@@ -49,8 +49,8 @@
     "relaxed-json": "^1.0.3",
     "semver": "^7.6.0",
     "text-table": "^0.2.0",
-    "tslib": "^2.6.2",
     "tmp": "^0.2.3",
+    "tslib": "^2.6.2",
     "which": "^4.0.0",
     "zod": "^3.23.4"
   },

cli/src/base.ts

@@ -281,7 +281,7 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
         message: 'New workspace name'
       });
       if (!name) return this.error('No workspace name provided');
-      const workspace = await xata.api.workspaces.createWorkspace({ data: { name } });
+      const workspace = await xata.api.workspaces.createWorkspace({ body: { name } });
       return workspace.id;
     } else if (workspaces.workspaces.length === 1) {
       const workspace = workspaces.workspaces[0].id;
@@ -309,7 +309,9 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     options: { allowCreate?: boolean } = {}
   ): Promise<{ name: string; region: string }> {
     const xata = await this.getXataClient();
-    const { databases: dbs = [] } = await xata.api.database.getDatabaseList({ workspace });
+    const { databases: dbs = [] } = await xata.api.databases.getDatabaseList({
+      pathParams: { workspaceId: workspace }
+    });
 
     if (dbs.length > 0) {
       const choices = dbs.map((db) => ({
@@ -355,7 +357,9 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     } = {}
   ): Promise<string> {
     const xata = await this.getXataClient();
-    const { branches = [] } = await xata.api.branches.getBranchList({ workspace, region, database });
+    const { branches = [] } = await xata.api.branch.getBranchList({
+      pathParams: { workspace, region, dbName: database }
+    });
 
     const EMPTY_CHOICE = '$empty';
     const CREATE_CHOICE = '$create';
@@ -421,7 +425,7 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     );
     if (!name) return this.error('No database name provided');
 
-    const { regions } = await xata.api.database.listRegions({ workspace });
+    const { regions } = await xata.api.databases.listRegions({ pathParams: { workspaceId: workspace } });
     const { region } = await this.prompt(
       {
         type: 'select',
@@ -434,7 +438,10 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     );
     if (!region) return this.error('No region selected');
 
-    const result = await xata.api.database.createDatabase({ workspace, database: name, data: { region } });
+    const result = await xata.api.databases.createDatabase({
+      pathParams: { workspaceId: workspace, dbName: name },
+      body: { region }
+    });
 
     return { name: result.databaseName, region };
   }
@@ -455,9 +462,12 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
     });
 
     if (!from) {
-      await xata.api.branches.createBranch({ workspace, region, database, branch: name });
+      await xata.api.branch.createBranch({ pathParams: { workspace, region, dbBranchName: `${database}:${name}` } });
     } else {
-      await xata.api.branches.createBranch({ workspace, region, database, branch: name, from });
+      await xata.api.branch.createBranch({
+        pathParams: { workspace, region, dbBranchName: `${database}:${name}` },
+        body: { from }
+      });
     }
 
     return name;
@@ -566,11 +576,8 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
   async deploySchema(workspace: string, region: string, database: string, branch: string, schema: Schemas.Schema) {
     const xata = await this.getXataClient();
     const compare = await xata.api.migrations.compareBranchWithUserSchema({
-      workspace,
-      region,
-      database,
-      branch,
-      schema
+      pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+      body: { schema }
     });
 
     if (compare.edits.operations.length === 0) {
@@ -587,7 +594,10 @@ export abstract class BaseCommand<T extends typeof Command> extends Command {
       });
       if (!confirm) return this.exit(1);
 
-      await xata.api.migrations.applyBranchSchemaEdit({ workspace, region, database, branch, edits: compare.edits });
+      await xata.api.migrations.applyBranchSchemaEdit({
+        pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+        body: { edits: compare.edits }
+      });
     }
   }
 

cli/src/commands/branch/create.ts

@@ -32,7 +32,10 @@ export default class BranchCreate extends BaseCommand<typeof BranchCreate> {
     const { from } = flags;
 
     try {
-      const result = await xata.api.branches.createBranch({ workspace, region, database, branch, from });
+      const result = await xata.api.branch.createBranch({
+        pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+        body: { from }
+      });
 
       if (this.jsonEnabled()) return result;
 

cli/src/commands/branch/delete.ts

@@ -37,7 +37,7 @@ export default class BranchDelete extends BaseCommand<typeof BranchDelete> {
     if (!confirm) return this.exit(1);
     if (confirm !== branch) return this.error('The branch name did not match');
 
-    await xata.api.branches.deleteBranch({ workspace, region, database, branch });
+    await xata.api.branch.deleteBranch({ pathParams: { workspace, region, dbBranchName: `${database}:${branch}` } });
 
     if (this.jsonEnabled()) return {};
 

cli/src/commands/branch/list.ts

@@ -19,7 +19,7 @@ export default class BranchList extends BaseCommand<typeof BranchList> {
     const { workspace, region, database } = await this.getParsedDatabaseURL(flags.db);
 
     const xata = await this.getXataClient();
-    const { branches } = await xata.api.branches.getBranchList({ workspace, region, database });
+    const { branches } = await xata.api.branch.getBranchList({ pathParams: { workspace, region, dbName: database } });
 
     if (this.jsonEnabled()) return branches;
 

cli/src/commands/dbs/delete.ts

@@ -39,7 +39,7 @@ export default class DatabasesDelete extends BaseCommand<typeof DatabasesDelete>
     if (!confirm) return this.exit(1);
     if (confirm !== database) return this.error('The database name did not match');
 
-    await xata.api.database.deleteDatabase({ workspace, database });
+    await xata.api.databases.deleteDatabase({ pathParams: { workspaceId: workspace, dbName: database } });
 
     if (this.jsonEnabled()) return {};
 

cli/src/commands/dbs/list.ts

@@ -25,7 +25,9 @@ export default class DatabasesList extends BaseCommand<typeof DatabasesList> {
       (await this.getWorkspace());
 
     const xata = await this.getXataClient();
-    const { databases: dbs = [] } = await xata.api.database.getDatabaseList({ workspace });
+    const { databases: dbs = [] } = await xata.api.databases.getDatabaseList({
+      pathParams: { workspaceId: workspace }
+    });
 
     if (this.jsonEnabled()) return dbs;
 

cli/src/commands/dbs/rename.ts

@@ -43,7 +43,10 @@ export default class DatabasesRename extends BaseCommand<typeof DatabasesRename>
     if (!confirm) return this.exit(1);
     if (confirm !== database) return this.error('The database name did not match');
 
-    await xata.api.database.renameDatabase({ workspace, database, newName });
+    await xata.api.databases.renameDatabase({
+      pathParams: { workspaceId: workspace, dbName: database },
+      body: { newName }
+    });
 
     if (this.jsonEnabled()) return {};
 

cli/src/commands/import/csv.ts

@@ -218,12 +218,10 @@ export default class ImportCSV extends BaseCommand<typeof ImportCSV> {
         { name: table, columns: columns.filter((c) => c.name !== 'id') }
       ]
     };
+
     const { edits } = await xata.api.migrations.compareBranchWithUserSchema({
-      workspace,
-      region,
-      database,
-      branch: 'main',
-      schema: newSchema
+      pathParams: { workspace, region, dbBranchName: `${database}:main` },
+      body: { schema: newSchema }
     });
     if (edits.operations.length > 0) {
       const destructiveOperations = edits.operations
@@ -263,7 +261,11 @@ export default class ImportCSV extends BaseCommand<typeof ImportCSV> {
       if (!applyMigrations) {
         process.exit(1);
       }
-      await xata.api.migrations.applyBranchSchemaEdit({ workspace, region, database, branch, edits });
+
+      await xata.api.migrations.applyBranchSchemaEdit({
+        pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+        body: { edits }
+      });
     }
   }
 }

cli/src/commands/init/index.ts

@@ -187,7 +187,7 @@ export default class Init extends BaseCommand<typeof Init> {
     if (this.projectConfig?.codegen?.output) {
       const { schema: currentSchema } = await (
         await this.getXataClient()
-      ).api.branches.getBranchDetails({ workspace, database, region, branch });
+      ).api.branch.getBranchDetails({ pathParams: { workspace, region, dbBranchName: `${database}:${branch}` } });
 
       const hasTables = currentSchema?.tables && currentSchema?.tables.length > 0;
       const hasColumns = currentSchema?.tables.some((t) => t.columns.length > 0);
@@ -434,7 +434,7 @@ export default class Init extends BaseCommand<typeof Init> {
     let retries = 0;
     while (retries++ < maxRetries) {
       try {
-        await xata.api.branches.getBranchList({ workspace, region, database });
+        await xata.api.branch.getBranchList({ pathParams: { workspace, region, dbName: database } });
         return;
       } catch (err) {
         if (err instanceof Error && err.message.includes('Invalid API key')) {

cli/src/commands/pull/index.ts

@@ -53,22 +53,18 @@ export default class Pull extends BaseCommand<typeof Pull> {
 
     let logs: Schemas.MigrationHistoryItem[] | Schemas.Commit[] = [];
     if (isBranchPgRollEnabled(details)) {
-      const { migrations } = await xata.api.branches.pgRollMigrationHistory({
-        workspace,
-        region,
-        database,
-        branch
+      const { migrations } = await xata.api.migrations.getMigrationHistory({
+        pathParams: { workspace, region, dbBranchName: `${database}:${branch}` }
       });
       logs = migrations;
     } else {
       const data = await xata.api.migrations.getBranchSchemaHistory({
-        workspace,
-        region,
-        database,
-        branch,
-        // TODO: Fix pagination in the API to start from last known migration and not from the beginning
-        // Also paginate until we get all migrations
-        page: { size: 200 }
+        pathParams: { workspace, region, dbBranchName: `${database}:${branch}` },
+        body: {
+          // TODO: Fix pagination in the API to start from last known migration and not from the beginning
+          // Also paginate until we get all migrations
+          page: { size: 200 }
+        }
       });
       logs = data.logs;
     }