appwrite-utils-cli 0.0.269 → 0.0.270

package/README.md

@@ -76,6 +76,9 @@ Replace `--args` with the appropriate options:
 - `--wipe-users` or `--wipeUsers`: Wipe all user data.
 - `--write-data` or `--writeData`: Write converted imported data to file
 - `--sync`: Synchronize your project's config and generate schema for your database
+- `--endpoint`: Set a different endpoint for the migration target
+- `--project`: Set a different project ID for the migration target
+- `--key`: Set a different API key for the migration target
 
 For example, to run migrations in a development environment and import data:
 
@@ -89,16 +92,33 @@ To initialize your project, generate schemas, but not import data:
 npx --package=appwrite-utils-cli@latest appwrite-migrate --init
 ```
 
+To sync:
+
+```bash
+# If you have no appwriteConfig
+npx --package=appwrite-utils-cli@latest appwrite-migrate --init
+
+# Otherwise, you can remove everything in the config file down to the word collections, just leave your Databases, then run
+npx --package=appwrite-utils-cli@latest appwrite-migrate --sync
+```
+
+### OpenAPI Generation (almost done, in progress)
+
+Recently, I have also added an optional OpenAPI generation for each attribute in the schema. This is because I needed it and because I felt it would be nice to have. This is done using [this package](https://github.com/asteasolutions/zod-to-openapi), many thanks to them.
+
+To use it, add a `description` to any attribute or collection, and it will export that schema to the `appwrite/openapi` folder
+
 This setup ensures that developers have robust tools at their fingertips to manage complex Appwrite projects effectively from the command line. I also have added logging automatically for information and errors as the console can be hard to keep up with.
 
 ### Roadmap
 
-- Syncing configuration
+- Syncing configuration (DONE)
 - Better file format for config (potentially)
 - Separation of collections and import configuration from main config
 
 ### Changelog
 
+- 0.0.270: Fixed enums in `--sync`, added optional OpenAPI generation (in progress, almost done, but wanted to push other changes), added `--endpoint`, `--project`, `--key` as optional parameters to change the target destination (shoutout to [pingu24k](https://github.com/pingu2k4) for pointing out these bugs and suggesting those changes for endpoint customization)
 - 0.0.254: Added `--sync` to synchronize your Appwrite instance with your local `appwriteConfig.yaml` and generate schemas
 - 0.0.253: Added `--writeData` (or `--write-data`) to command to write the output of the import data to a file called dataLoaderOutput in your root dir
 - 0.0.23: Added batching to user deletion

package/dist/main.js

@@ -3,7 +3,6 @@ import { UtilsController } from "./utilsController.js";
 const args = process.argv.slice(2);
 async function main() {
     const controller = new UtilsController();
-    await controller.init();
     let sync = false;
     let runProd = false;
     let runStaging = false;
@@ -15,6 +14,9 @@ async function main() {
     let importData = false;
     let wipeDocuments = false;
     let shouldWriteFile = false;
+    let endpoint;
+    let project;
+    let key;
     if (args.includes("--sync")) {
         sync = true;
     }
@@ -48,6 +50,15 @@ async function main() {
     if (args.includes("--write-data") || args.includes("--writeData")) {
         shouldWriteFile = true;
     }
+    if (args.includes("--endpoint")) {
+        endpoint = args[args.indexOf("--endpoint") + 1];
+    }
+    if (args.includes("--project")) {
+        project = args[args.indexOf("--project") + 1];
+    }
+    if (args.includes("--key")) {
+        key = args[args.indexOf("--key") + 1];
+    }
     if (args.includes("--init")) {
         await controller.run({
             sync: sync,
@@ -63,6 +74,9 @@ async function main() {
             importData: false,
             checkDuplicates: false,
             shouldWriteFile: shouldWriteFile,
+            endpoint: endpoint,
+            project: project,
+            key: key,
         });
     }
     else {
@@ -80,6 +94,9 @@ async function main() {
             importData: importData,
             checkDuplicates: false,
             shouldWriteFile: shouldWriteFile,
+            endpoint: endpoint,
+            project: project,
+            key: key,
         });
     }
 }

package/dist/migrations/appwriteToX.d.ts

@@ -12,6 +12,8 @@ export declare class AppwriteToX {
         size: number;
         xdefault?: string | null | undefined;
         encrypted?: boolean | undefined;
+        format?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "integer";
@@ -21,6 +23,7 @@ export declare class AppwriteToX {
         min?: number | undefined;
         max?: number | undefined;
         xdefault?: number | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "float";
@@ -30,6 +33,7 @@ export declare class AppwriteToX {
         min?: number | undefined;
         max?: number | undefined;
         xdefault?: number | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "boolean";
@@ -37,6 +41,7 @@ export declare class AppwriteToX {
         required: boolean;
         array: boolean;
         xdefault?: boolean | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "datetime";
@@ -44,6 +49,7 @@ export declare class AppwriteToX {
         required: boolean;
         array: boolean;
         xdefault?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "email";
@@ -51,6 +57,7 @@ export declare class AppwriteToX {
         required: boolean;
         array: boolean;
         xdefault?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "ip";
@@ -58,6 +65,7 @@ export declare class AppwriteToX {
         required: boolean;
         array: boolean;
         xdefault?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "url";
@@ -65,6 +73,7 @@ export declare class AppwriteToX {
         required: boolean;
         array: boolean;
         xdefault?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "enum";
@@ -73,6 +82,7 @@ export declare class AppwriteToX {
         array: boolean;
         elements: string[];
         xdefault?: string | null | undefined;
+        description?: string | Record<string, string> | null | undefined;
     } | {
         key: string;
         type: "relationship";
@@ -89,6 +99,7 @@ export declare class AppwriteToX {
             originalIdField: string;
             targetField?: string | undefined;
         } | undefined;
+        description?: string | Record<string, string> | null | undefined;
     })[]>;
     appwriteFolderPath: string;
     constructor(config: AppwriteConfig, appwriteFolderPath: string);

package/dist/migrations/appwriteToX.js

@@ -56,7 +56,14 @@ export class AppwriteToX {
                 // Parse the collection permissions and attributes
                 const collPermissions = this.parsePermissionsArray(collection.$permissions);
                 const collAttributes = attributesSchema
-                    .parse(collection.attributes)
+                    .parse(collection.attributes.map((attr) => {
+                    if (attr.type === "string" &&
+                        attr.format &&
+                        attr.format.length > 0) {
+                        return { ...attr, type: attr.format };
+                    }
+                    return attr;
+                }))
                     .filter((attribute) => attribute.type === "relationship"
                     ? attribute.side !== "child"
                     : true);

package/dist/migrations/backup.d.ts

@@ -176,6 +176,7 @@ export type OperationCreate = z.infer<typeof OperationCreateSchema>;
 export declare const getMigrationCollectionSchemas: () => {
     CurrentOperations: {
         collection: {
+            name: string;
             attributes: ({
                 key: string;
                 type: "string";
@@ -185,6 +186,8 @@ export declare const getMigrationCollectionSchemas: () => {
                 size: number;
                 xdefault?: string | null | undefined;
                 encrypted?: boolean | undefined;
+                format?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "integer";
@@ -194,6 +197,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "float";
@@ -203,6 +207,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "boolean";
@@ -210,6 +215,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: boolean | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "datetime";
@@ -217,6 +223,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "email";
@@ -224,6 +231,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "ip";
@@ -231,6 +239,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "url";
@@ -238,6 +247,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "enum";
@@ -246,6 +256,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 array: boolean;
                 elements: string[];
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "relationship";
@@ -262,8 +273,8 @@ export declare const getMigrationCollectionSchemas: () => {
                     originalIdField: string;
                     targetField?: string | undefined;
                 } | undefined;
+                description?: string | Record<string, string> | null | undefined;
             })[];
-            name: string;
             $id: string;
             enabled: boolean;
             documentSecurity: boolean;
@@ -313,6 +324,7 @@ export declare const getMigrationCollectionSchemas: () => {
                     targetField: string;
                 } | undefined;
             }[];
+            description?: string | undefined;
             databaseId?: string | undefined;
         };
         attributes: ({
@@ -324,6 +336,8 @@ export declare const getMigrationCollectionSchemas: () => {
             size: number;
             xdefault?: string | null | undefined;
             encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "integer";
@@ -333,6 +347,7 @@ export declare const getMigrationCollectionSchemas: () => {
             min?: number | undefined;
             max?: number | undefined;
             xdefault?: number | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "float";
@@ -342,6 +357,7 @@ export declare const getMigrationCollectionSchemas: () => {
             min?: number | undefined;
             max?: number | undefined;
             xdefault?: number | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "boolean";
@@ -349,6 +365,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: boolean | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "datetime";
@@ -356,6 +373,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "email";
@@ -363,6 +381,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "ip";
@@ -370,6 +389,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "url";
@@ -377,6 +397,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "enum";
@@ -385,6 +406,7 @@ export declare const getMigrationCollectionSchemas: () => {
             array: boolean;
             elements: string[];
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "relationship";
@@ -401,10 +423,12 @@ export declare const getMigrationCollectionSchemas: () => {
                 originalIdField: string;
                 targetField?: string | undefined;
             } | undefined;
+            description?: string | Record<string, string> | null | undefined;
         })[];
     };
     Batches: {
         collection: {
+            name: string;
             attributes: ({
                 key: string;
                 type: "string";
@@ -414,6 +438,8 @@ export declare const getMigrationCollectionSchemas: () => {
                 size: number;
                 xdefault?: string | null | undefined;
                 encrypted?: boolean | undefined;
+                format?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "integer";
@@ -423,6 +449,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "float";
@@ -432,6 +459,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 min?: number | undefined;
                 max?: number | undefined;
                 xdefault?: number | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "boolean";
@@ -439,6 +467,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: boolean | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "datetime";
@@ -446,6 +475,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "email";
@@ -453,6 +483,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "ip";
@@ -460,6 +491,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "url";
@@ -467,6 +499,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 required: boolean;
                 array: boolean;
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "enum";
@@ -475,6 +508,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 array: boolean;
                 elements: string[];
                 xdefault?: string | null | undefined;
+                description?: string | Record<string, string> | null | undefined;
             } | {
                 key: string;
                 type: "relationship";
@@ -491,8 +525,8 @@ export declare const getMigrationCollectionSchemas: () => {
                     originalIdField: string;
                     targetField?: string | undefined;
                 } | undefined;
+                description?: string | Record<string, string> | null | undefined;
             })[];
-            name: string;
             $id: string;
             enabled: boolean;
             documentSecurity: boolean;
@@ -542,6 +576,7 @@ export declare const getMigrationCollectionSchemas: () => {
                     targetField: string;
                 } | undefined;
             }[];
+            description?: string | undefined;
             databaseId?: string | undefined;
         };
         attributes: ({
@@ -553,6 +588,8 @@ export declare const getMigrationCollectionSchemas: () => {
             size: number;
             xdefault?: string | null | undefined;
             encrypted?: boolean | undefined;
+            format?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "integer";
@@ -562,6 +599,7 @@ export declare const getMigrationCollectionSchemas: () => {
             min?: number | undefined;
             max?: number | undefined;
             xdefault?: number | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "float";
@@ -571,6 +609,7 @@ export declare const getMigrationCollectionSchemas: () => {
             min?: number | undefined;
             max?: number | undefined;
             xdefault?: number | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "boolean";
@@ -578,6 +617,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: boolean | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "datetime";
@@ -585,6 +625,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "email";
@@ -592,6 +633,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "ip";
@@ -599,6 +641,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "url";
@@ -606,6 +649,7 @@ export declare const getMigrationCollectionSchemas: () => {
             required: boolean;
             array: boolean;
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "enum";
@@ -614,6 +658,7 @@ export declare const getMigrationCollectionSchemas: () => {
             array: boolean;
             elements: string[];
             xdefault?: string | null | undefined;
+            description?: string | Record<string, string> | null | undefined;
         } | {
             key: string;
             type: "relationship";
@@ -630,6 +675,7 @@ export declare const getMigrationCollectionSchemas: () => {
                 originalIdField: string;
                 targetField?: string | undefined;
             } | undefined;
+            description?: string | Record<string, string> | null | undefined;
         })[];
     };
 };