appwrite-utils-cli 0.0.279 → 0.0.280

package/dist/migrations/appwriteToX.js

@@ -2,7 +2,7 @@ import { SchemaGenerator } from "./schemaStrings.js";
 import { Databases, Query } from "node-appwrite";
 import { fetchAllCollections } from "./collections.js";
 import { fetchAllDatabases } from "./databases.js";
-import { collectionSchema, attributeSchema, AppwriteConfigSchema, permissionsSchema, attributesSchema, indexesSchema, } from "appwrite-utils";
+import { CollectionSchema, attributeSchema, AppwriteConfigSchema, permissionsSchema, attributesSchema, indexesSchema, } from "appwrite-utils";
 import { getDatabaseFromConfig } from "./afterImportActions.js";
 export class AppwriteToX {
     config;
@@ -88,7 +88,7 @@ export class AppwriteToX {
                 this.collToAttributeMap.set(collection.name, collAttributes);
                 const collIndexes = indexesSchema.parse(collection.indexes);
                 // Prepare the collection object to be added or updated
-                const collToPush = collectionSchema.parse({
+                const collToPush = CollectionSchema.parse({
                     $id: collection.$id,
                     name: collection.name,
                     enabled: collection.enabled,

package/dist/migrations/backup.d.ts

@@ -16,21 +16,21 @@ export declare const BackupSchema: z.ZodObject<{
         data: string;
     }>, "many">>;
 }, "strip", z.ZodTypeAny, {
-    $id: string;
-    $createdAt: string;
-    $updatedAt: string;
-    database: string;
     collections: string[];
     documents: {
         collectionId: string;
         data: string;
     }[];
-}, {
     $id: string;
     $createdAt: string;
     $updatedAt: string;
     database: string;
+}, {
     collections: string[];
+    $id: string;
+    $createdAt: string;
+    $updatedAt: string;
+    database: string;
     documents?: {
         collectionId: string;
         data: string;
@@ -54,15 +54,15 @@ export declare const BackupCreateSchema: z.ZodObject<Omit<{
         data: string;
     }>, "many">>;
 }, "$id" | "$createdAt" | "$updatedAt">, "strip", z.ZodTypeAny, {
-    database: string;
     collections: string[];
     documents: {
         collectionId: string;
         data: string;
     }[];
-}, {
     database: string;
+}, {
     collections: string[];
+    database: string;
     documents?: {
         collectionId: string;
         data: string;

package/dist/migrations/dataLoader.d.ts

@@ -1,5 +1,5 @@
 import type { ImportDataActions } from "./importDataActions.js";
-import { type AppwriteConfig, type AttributeMappings, type ConfigCollection, type ConfigDatabase, type IdMapping, type ImportDef } from "appwrite-utils";
+import { type AppwriteConfig, type AttributeMappings, type CollectionCreate, type ConfigDatabase, type IdMapping, type ImportDef } from "appwrite-utils";
 import { z } from "zod";
 import { type Databases } from "node-appwrite";
 export declare const CollectionImportDataSchema: z.ZodObject<{
@@ -1670,7 +1670,7 @@ export declare class DataLoader {
     loadData(importDef: ImportDef): any[];
     checkMapValuesForId(newId: string, collectionName: string): string | false;
     getTrueUniqueId(collectionName: string): string;
-    createContext(db: ConfigDatabase, collection: ConfigCollection, item: any, docId: string): any;
+    createContext(db: ConfigDatabase, collection: CollectionCreate, item: any, docId: string): any;
     /**
      * Transforms the given item based on the provided attribute mappings.
      * This method applies conversion rules to the item's attributes as defined in the attribute mappings.
@@ -1706,7 +1706,7 @@ export declare class DataLoader {
      * @param collection - The collection configuration.
      * @param importDef - The import definition containing the attribute mappings and other relevant info.
      */
-    prepareUserCollectionCreateData(db: ConfigDatabase, collection: ConfigCollection, importDef: ImportDef): Promise<void>;
+    prepareUserCollectionCreateData(db: ConfigDatabase, collection: CollectionCreate, importDef: ImportDef): Promise<void>;
     /**
      * Prepares the data for creating documents in a collection.
      * This involves loading the data, transforming it, and handling ID mappings.
@@ -1715,7 +1715,7 @@ export declare class DataLoader {
      * @param collection - The collection configuration.
      * @param importDef - The import definition containing the attribute mappings and other relevant info.
      */
-    prepareCreateData(db: ConfigDatabase, collection: ConfigCollection, importDef: ImportDef): Promise<void>;
+    prepareCreateData(db: ConfigDatabase, collection: CollectionCreate, importDef: ImportDef): Promise<void>;
     /**
      * Prepares the data for updating documents within a collection.
      * This method loads the raw data based on the import definition, transforms it according to the attribute mappings,
@@ -1726,7 +1726,7 @@ export declare class DataLoader {
      * @param collection - The collection configuration.
      * @param importDef - The import definition containing the attribute mappings and other relevant info.
      */
-    prepareUpdateData(db: ConfigDatabase, collection: ConfigCollection, importDef: ImportDef): Promise<void>;
+    prepareUpdateData(db: ConfigDatabase, collection: CollectionCreate, importDef: ImportDef): Promise<void>;
     private updateReferencesBasedOnAttributeMappings;
     private getMergedId;
     /**

package/dist/migrations/openapi.js

@@ -1,5 +1,5 @@
 import { OpenAPIRegistry, OpenApiGeneratorV3, OpenApiGeneratorV31, } from "@asteasolutions/zod-to-openapi";
-import { attributeSchema, collectionSchema, } from "appwrite-utils";
+import { attributeSchema, CollectionSchema, } from "appwrite-utils";
 import { z } from "zod";
 import { writeFileSync } from "fs";
 const registry = new OpenAPIRegistry();
@@ -13,12 +13,10 @@ export const generateOpenApi = async (config) => {
             return transformTypeToOpenApi(attributeSchema);
         });
         // Create and register the collection schema with descriptions
-        const updatedCollectionSchema = collectionSchema
-            .extend({
+        const updatedCollectionSchema = CollectionSchema.extend({
             // @ts-ignore
             attributes: z.array(z.union(attributeSchemas)),
-        })
-            .openapi(collection.description ?? "No description");
+        }).openapi(collection.description ?? "No description");
         // Register the updated collection schema under the collection name
         registry.register(collection.name, updatedCollectionSchema);
     }

package/dist/schemas/authUser.d.ts

@@ -12,17 +12,17 @@ export declare const AuthUserSchema: z.ZodObject<{
     $id: string;
     prefs: Record<string, string>;
     labels: string[];
+    email?: string | null | undefined;
+    name?: string | null | undefined;
     $createdAt?: string | undefined;
     $updatedAt?: string | undefined;
-    name?: string | null | undefined;
-    email?: string | null | undefined;
     phone?: string | null | undefined;
 }, {
     $id: string;
+    email?: string | null | undefined;
+    name?: string | null | undefined;
     $createdAt?: string | undefined;
     $updatedAt?: string | undefined;
-    name?: string | null | undefined;
-    email?: string | null | undefined;
     phone?: string | null | undefined;
     prefs?: Record<string, string> | undefined;
     labels?: string[] | undefined;
@@ -43,19 +43,19 @@ export declare const AuthUserCreateSchema: z.ZodObject<z.objectUtil.extendShape<
 }>, "strip", z.ZodTypeAny, {
     prefs: Record<string, string>;
     labels: string[];
+    email?: string | null | undefined;
+    password?: string | undefined;
+    name?: string | null | undefined;
     $createdAt?: string | undefined;
     $updatedAt?: string | undefined;
-    name?: string | null | undefined;
-    password?: string | undefined;
-    email?: string | null | undefined;
     phone?: string | null | undefined;
     userId?: string | undefined;
 }, {
+    email?: string | null | undefined;
+    password?: string | undefined;
+    name?: string | null | undefined;
     $createdAt?: string | undefined;
     $updatedAt?: string | undefined;
-    name?: string | null | undefined;
-    password?: string | undefined;
-    email?: string | null | undefined;
     phone?: string | null | undefined;
     prefs?: Record<string, string> | undefined;
     labels?: string[] | undefined;

package/dist/utils/helperFunctions.d.ts

@@ -1,5 +1,6 @@
 import type { Models } from "node-appwrite";
 import type { CollectionImportData } from "../migrations/dataLoader.js";
+import type { ConfigCollection } from "appwrite-utils";
 export declare const toPascalCase: (str: string) => string;
 export declare const toCamelCase: (str: string) => string;
 export declare const ensureDirectoryExistence: (filePath: string) => true | undefined;
@@ -33,4 +34,4 @@ export declare const getFileViewUrl: (endpoint: string, projectId: string, bucke
  * @return {string} The complete download URL for the file.
  */
 export declare const getFileDownloadUrl: (endpoint: string, projectId: string, bucketId: string, fileId: string, jwt?: Models.Jwt) => string;
-export declare const finalizeByAttributeMap: (appwriteFolderPath: string, collection: Collections, item: CollectionImportData["data"][number]) => Promise<any>;
+export declare const finalizeByAttributeMap: (appwriteFolderPath: string, collection: ConfigCollection, item: CollectionImportData["data"][number]) => Promise<any>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "appwrite-utils-cli",
   "description": "Appwrite Utility Functions to help with database management, data conversion, data import, migrations, and much more. Meant to be used as a CLI tool, I do not recommend installing this in frontend environments.",
-  "version": "0.0.279",
+  "version": "0.0.280",
   "main": "src/main.ts",
   "type": "module",
   "repository": {
@@ -34,7 +34,7 @@
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^7.0.0",
     "@types/inquirer": "^9.0.7",
-    "appwrite-utils": "latest",
+    "appwrite-utils": "^0.1.225",
     "commander": "^12.0.0",
     "inquirer": "^9.2.20",
     "js-yaml": "^4.1.0",

package/src/migrations/appwriteToX.ts

@@ -3,7 +3,7 @@ import { Databases, Query, type Models, type Permission } from "node-appwrite";
 import { fetchAllCollections } from "./collections.js";
 import { fetchAllDatabases } from "./databases.js";
 import {
-  collectionSchema,
+  CollectionSchema,
   attributeSchema,
   type AppwriteConfig,
   AppwriteConfigSchema,
@@ -130,7 +130,7 @@ export class AppwriteToX {
         const collIndexes = indexesSchema.parse(collection.indexes);
 
         // Prepare the collection object to be added or updated
-        const collToPush = collectionSchema.parse({
+        const collToPush = CollectionSchema.parse({
           $id: collection.$id,
           name: collection.name,
           enabled: collection.enabled,

package/src/migrations/attributes.ts

@@ -32,7 +32,7 @@ export const createOrUpdateAttribute = async (
     const collectionAttr = collection.attributes.find(
       // @ts-expect-error
       (attr) => attr.key === attribute.key
-    ) as unknown;
+    ) as unknown as any;
     foundAttribute = parseAttribute(collectionAttr);
   } catch (error) {
     foundAttribute = undefined;

package/src/migrations/dataLoader.ts

@@ -5,7 +5,7 @@ import {
   importDefSchema,
   type AppwriteConfig,
   type AttributeMappings,
-  type ConfigCollection,
+  type CollectionCreate,
   type ConfigDatabase,
   type IdMapping,
   type ImportDef,
@@ -171,7 +171,7 @@ export class DataLoader {
   // Method to create a context object for data transformation
   createContext(
     db: ConfigDatabase,
-    collection: ConfigCollection,
+    collection: CollectionCreate,
     item: any,
     docId: string
   ) {
@@ -739,7 +739,7 @@ export class DataLoader {
    */
   async prepareUserCollectionCreateData(
     db: ConfigDatabase,
-    collection: ConfigCollection,
+    collection: CollectionCreate,
     importDef: ImportDef
   ): Promise<void> {
     // Load the raw data based on the import definition
@@ -924,7 +924,7 @@ export class DataLoader {
    */
   async prepareCreateData(
     db: ConfigDatabase,
-    collection: ConfigCollection,
+    collection: CollectionCreate,
     importDef: ImportDef
   ): Promise<void> {
     // Load the raw data based on the import definition
@@ -1037,7 +1037,7 @@ export class DataLoader {
    */
   async prepareUpdateData(
     db: ConfigDatabase,
-    collection: ConfigCollection,
+    collection: CollectionCreate,
     importDef: ImportDef
   ) {
     // Retrieve the current collection data and old-to-new ID map from the import map

package/src/migrations/openapi.ts

@@ -5,7 +5,7 @@ import {
 } from "@asteasolutions/zod-to-openapi";
 import {
   attributeSchema,
-  collectionSchema,
+  CollectionSchema,
   type AppwriteConfig,
   type Attribute,
   type Collection,
@@ -27,12 +27,10 @@ export const generateOpenApi = async (config: AppwriteConfig) => {
     });
 
     // Create and register the collection schema with descriptions
-    const updatedCollectionSchema = collectionSchema
-      .extend({
-        // @ts-ignore
-        attributes: z.array(z.union(attributeSchemas)),
-      })
-      .openapi(collection.description ?? "No description");
+    const updatedCollectionSchema = CollectionSchema.extend({
+      // @ts-ignore
+      attributes: z.array(z.union(attributeSchemas)),
+    }).openapi(collection.description ?? "No description");
 
     // Register the updated collection schema under the collection name
     registry.register(collection.name, updatedCollectionSchema);

package/tsconfig.json

@@ -32,6 +32,6 @@
     "rootDir": "./src",
     "declaration": true
   },
-  "include": ["src/main.ts", "src/**/*"],
+  "include": ["src/**/*"],
   "exclude": ["node_modules", "dist", "src/appwrite", "example/*"]
 }