Skip to content

Commit 8f3ccfd

Browse files
committed
feat: add provider-specific migration resource enums and snake_case resource types
1 parent 40d238d commit 8f3ccfd

22 files changed

+303
-193
lines changed

docs/examples/migrations/create-appwrite-migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, AppwriteMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.createAppwriteMigration({
11-
resources: [Resources.User],
11+
resources: [AppwriteMigrationResource.User],
1212
endpoint: 'https://example.com',
1313
projectId: '<PROJECT_ID>',
1414
apiKey: '<API_KEY>'

docs/examples/migrations/create-firebase-migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, FirebaseMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.createFirebaseMigration({
11-
resources: [Resources.User],
11+
resources: [FirebaseMigrationResource.User],
1212
serviceAccount: '<SERVICE_ACCOUNT>'
1313
});
1414

docs/examples/migrations/create-n-host-migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, NHostMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.createNHostMigration({
11-
resources: [Resources.User],
11+
resources: [NHostMigrationResource.User],
1212
subdomain: '<SUBDOMAIN>',
1313
region: '<REGION>',
1414
adminSecret: '<ADMIN_SECRET>',

docs/examples/migrations/create-supabase-migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, SupabaseMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.createSupabaseMigration({
11-
resources: [Resources.User],
11+
resources: [SupabaseMigrationResource.User],
1212
endpoint: 'https://example.com',
1313
apiKey: '<API_KEY>',
1414
databaseHost: '<DATABASE_HOST>',

docs/examples/migrations/get-appwrite-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, AppwriteMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.getAppwriteReport({
11-
resources: [Resources.User],
11+
resources: [AppwriteMigrationResource.User],
1212
endpoint: 'https://example.com',
1313
projectID: '<PROJECT_ID>',
1414
key: '<KEY>'

docs/examples/migrations/get-firebase-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, FirebaseMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.getFirebaseReport({
11-
resources: [Resources.User],
11+
resources: [FirebaseMigrationResource.User],
1212
serviceAccount: '<SERVICE_ACCOUNT>'
1313
});
1414

docs/examples/migrations/get-n-host-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, NHostMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.getNHostReport({
11-
resources: [Resources.User],
11+
resources: [NHostMigrationResource.User],
1212
subdomain: '<SUBDOMAIN>',
1313
region: '<REGION>',
1414
adminSecret: '<ADMIN_SECRET>',

docs/examples/migrations/get-supabase-report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
```javascript
2-
import { Client, Migrations, Resources } from "@appwrite.io/console";
2+
import { Client, Migrations, SupabaseMigrationResource } from "@appwrite.io/console";
33

44
const client = new Client()
55
.setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
@@ -8,7 +8,7 @@ const client = new Client()
88
const migrations = new Migrations(client);
99

1010
const result = await migrations.getSupabaseReport({
11-
resources: [Resources.User],
11+
resources: [SupabaseMigrationResource.User],
1212
endpoint: 'https://example.com',
1313
apiKey: '<API_KEY>',
1414
databaseHost: '<DATABASE_HOST>',

docs/examples/sites/create-deployment.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ const sites = new Sites(client);
1010
const result = await sites.createDeployment({
1111
siteId: '<SITE_ID>',
1212
code: document.getElementById('uploader').files[0],
13-
activate: false,
1413
installCommand: '<INSTALL_COMMAND>', // optional
1514
buildCommand: '<BUILD_COMMAND>', // optional
16-
outputDirectory: '<OUTPUT_DIRECTORY>' // optional
15+
outputDirectory: '<OUTPUT_DIRECTORY>', // optional
16+
activate: false // optional
1717
});
1818

1919
console.log(result);
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
export enum AppwriteMigrationResource {
2+
User = 'user',
3+
Team = 'team',
4+
Membership = 'membership',
5+
Database = 'database',
6+
Table = 'table',
7+
Column = 'column',
8+
Index = 'index',
9+
Row = 'row',
10+
Document = 'document',
11+
Attribute = 'attribute',
12+
Collection = 'collection',
13+
Bucket = 'bucket',
14+
File = 'file',
15+
Function = 'function',
16+
Deployment = 'deployment',
17+
EnvironmentVariable = 'environment_variable',
18+
Site = 'site',
19+
SiteDeployment = 'site_deployment',
20+
SiteVariable = 'site_variable',
21+
}

0 commit comments

Comments
 (0)