appwrite-utils-cli 0.0.274 → 0.0.276

package/src/migrations/converters.ts

@@ -1,544 +1,8 @@
-import { DateTime } from "luxon";
 import _ from "lodash";
-import type { AppwriteConfig, ConfigCollection } from "./schema.js";
+import { converterFunctions, type AttributeMappings } from "appwrite-utils";
 
 const { cloneDeep, isObject } = _;
 
-export interface ConverterFunctions {
-  [key: string]: (value: any) => any;
-}
-
-export const converterFunctions = {
-  /**
-   * Converts any value to a string. Handles null and undefined explicitly.
-   * @param {any} value The value to convert.
-   * @return {string | null} The converted string or null if the value is null or undefined.
-   */
-  anyToString(value: any): string | null {
-    if (value == null) return null;
-    return typeof value === "string" ? value : `${value}`;
-  },
-
-  /**
-   * Converts any value to a number. Returns null for non-numeric values, null, or undefined.
-   * @param {any} value The value to convert.
-   * @return {number | null} The converted number or null.
-   */
-  anyToNumber(value: any): number | null {
-    if (value == null) return null;
-    const number = Number(value);
-    return isNaN(number) ? null : number;
-  },
-
-  /**
-   * Converts any value to a boolean. Specifically handles string representations.
-   * @param {any} value The value to convert.
-   * @return {boolean | null} The converted boolean or null if conversion is not possible.
-   */
-  anyToBoolean(value: any): boolean | null {
-    if (value == null) return null;
-    if (typeof value === "string") {
-      const trimmedValue = value.trim().toLowerCase();
-      if (["true", "yes", "1"].includes(trimmedValue)) return true;
-      if (["false", "no", "0"].includes(trimmedValue)) return false;
-      return null; // Return null for strings that don't explicitly match
-    }
-    return Boolean(value);
-  },
-
-  /**
-   * Converts any value to an array, attempting to split strings by a specified separator.
-   * @param {any} value The value to convert.
-   * @param {string | undefined} separator The separator to use when splitting strings.
-   * @return {any[]} The resulting array after conversion.
-   */
-  anyToAnyArray(value: any): any[] {
-    if (Array.isArray(value)) {
-      return value;
-    } else if (typeof value === "string") {
-      // Let's try a few
-      return converterFunctions.trySplitByDifferentSeparators(value);
-    }
-    return [value];
-  },
-
-  /**
-   * Converts any value to an array of strings. If the input is already an array, returns it as is.
-   * Otherwise, if the input is a string, returns an array with the string as the only element.
-   * Otherwise, returns an empty array.
-   * @param {any} value The value to convert.
-   * @return {string[]} The resulting array after conversion.
-   */
-  anyToStringArray(value: any): string[] {
-    if (Array.isArray(value)) {
-      return value.map((item) => String(item));
-    } else if (typeof value === "string" && value.length > 0) {
-      return [value];
-    }
-    return [];
-  },
-
-  /**
-   * A function that converts any type of value to an array of numbers.
-   *
-   * @param {any} value - the value to be converted
-   * @return {number[]} an array of numbers
-   */
-  anyToNumberArray(value: any): number[] {
-    if (Array.isArray(value)) {
-      return value.map((item) => Number(item));
-    } else if (typeof value === "string") {
-      return [Number(value)];
-    }
-    return [];
-  },
-
-  trim(value: string): string {
-    try {
-      return value.trim();
-    } catch (error) {
-      return value;
-    }
-  },
-
-  /**
-   * Removes the start and end quotes from a string.
-   * @param value The string to remove quotes from.
-   * @return The string with quotes removed.
-   **/
-  removeStartEndQuotes(value: string): string {
-    return value.replace(/^["']|["']$/g, "");
-  },
-
-  /**
-   * Tries to split a string by different separators and returns the split that has the most uniform segment lengths.
-   * This can be particularly useful for structured data like phone numbers.
-   * @param value The string to split.
-   * @return The split string array that has the most uniform segment lengths.
-   */
-  trySplitByDifferentSeparators(value: string): string[] {
-    const separators = [",", ";", "|", ":", "/", "\\"];
-    let bestSplit: string[] = [];
-    let bestScore = -Infinity;
-
-    for (const separator of separators) {
-      const split = value.split(separator).map((s) => s.trim()); // Ensure we trim spaces
-      if (split.length <= 1) continue; // Skip if no actual splitting occurred
-
-      // Calculate uniformity in segment length
-      const lengths = split.map((segment) => segment.length);
-      const averageLength = lengths.reduce((a, b) => a + b, 0) / lengths.length;
-      const lengthVariance =
-        lengths.reduce(
-          (total, length) => total + Math.pow(length - averageLength, 2),
-          0
-        ) / lengths.length;
-
-      // Adjust scoring to prioritize splits with lower variance and/or specific segment count if needed
-      const score = split.length / (1 + lengthVariance); // Adjusted to prioritize lower variance
-
-      // Update bestSplit if this split has a better score
-      if (score > bestScore) {
-        bestSplit = split;
-        bestScore = score;
-      }
-    }
-
-    // If no suitable split was found, return the original value as a single-element array
-    if (bestSplit.length === 0) {
-      return [value];
-    }
-
-    return bestSplit;
-  },
-
-  joinValues(values: any[]): any {
-    try {
-      return values.join("");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinBySpace(values: any[]): any {
-    try {
-      return values.join(" ");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinByComma(values: any[]): any {
-    try {
-      return values.join(",");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinByPipe(values: any[]): any {
-    try {
-      return values.join("|");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinBySemicolon(values: any[]): any {
-    try {
-      return values.join(";");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinByColon(values: any[]): any {
-    try {
-      return values.join(":");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinBySlash(values: any[]): any {
-    try {
-      return values.join("/");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  joinByHyphen(values: any[]): any {
-    try {
-      return values.join("-");
-    } catch (error) {
-      return values;
-    }
-  },
-
-  splitByComma(value: string): any {
-    try {
-      return value.split(",");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByPipe(value: string): any {
-    try {
-      return value.split("|");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitBySemicolon(value: string): any {
-    try {
-      return value.split(";");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByColon(value: string): any {
-    try {
-      return value.split(":");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitBySlash(value: string): any {
-    try {
-      return value.split("/");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByBackslash(value: string): any {
-    try {
-      return value.split("\\");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitBySpace(value: string): any {
-    try {
-      return value.split(" ");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByDot(value: string): any {
-    try {
-      return value.split(".");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByUnderscore(value: string): any {
-    try {
-      return value.split("_");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  splitByHyphen(value: string): any {
-    try {
-      return value.split("-");
-    } catch (error) {
-      return value;
-    }
-  },
-
-  /**
-   * Takes the first element of an array and returns it.
-   * @param {any[]} value The array to take the first element from.
-   * @return {any} The first element of the array.
-   */
-  pickFirstElement(value: any[]): any {
-    try {
-      return value[0];
-    } catch (error) {
-      return value;
-    }
-  },
-
-  /**
-   * Takes the last element of an array and returns it.
-   * @param {any[]} value The array to take the last element from.
-   * @return {any} The last element of the array.
-   */
-  pickLastElement(value: any[]): any {
-    try {
-      return value[value.length - 1];
-    } catch (error) {
-      return value;
-    }
-  },
-
-  /**
-   * Converts an object to a JSON string.
-   * @param {any} object The object to convert.
-   * @return {string} The JSON string representation of the object.
-   */
-  stringifyObject(object: any): string {
-    return JSON.stringify(object);
-  },
-
-  /**
-   * Converts a JSON string to an object.
-   * @param {string} jsonString The JSON string to convert.
-   * @return {any} The object representation of the JSON string.
-   */
-  parseObject(jsonString: string): any {
-    return JSON.parse(jsonString);
-  },
-
-  convertPhoneStringToUSInternational(value: string): string {
-    // Normalize input: Remove all non-digit characters except the leading +
-    const normalizedValue = value.startsWith("+")
-      ? "+" + value.slice(1).replace(/\D/g, "")
-      : value.replace(/\D/g, "");
-
-    // Check if the value is not a string or doesn't contain digits, return as is
-    if (typeof normalizedValue !== "string" || !/\d/.test(normalizedValue))
-      return value;
-
-    // Handle numbers with a leading + (indicating an international format)
-    if (normalizedValue.startsWith("+")) {
-      // If the number is already in a valid international format, return as is
-      if (normalizedValue.length > 11 && normalizedValue.length <= 15) {
-        return normalizedValue;
-      }
-    } else {
-      // For numbers without a leading +, check the length and format
-      if (normalizedValue.length === 10) {
-        // US numbers without country code, prepend +1
-        return `+1${normalizedValue}`;
-      } else if (
-        normalizedValue.length === 11 &&
-        normalizedValue.startsWith("1")
-      ) {
-        // US numbers with country code but missing +, prepend +
-        return `+${normalizedValue}`;
-      }
-    }
-
-    // For numbers that don't fit expected formats, return the original value
-    return value;
-  },
-
-  convertEmptyToNull(value: any): any {
-    if (Array.isArray(value)) {
-      return value.map((item) => this.convertEmptyToNull(item));
-    }
-    if (_.isEmpty(value)) return null;
-    return value;
-  },
-
-  /**
-   * A function that removes invalid elements from an array
-   *
-   * @param {any[]} array - the input array
-   * @return {any[]} the filtered array without invalid elements
-   */
-  removeInvalidElements(array: any[]): any[] {
-    if (!Array.isArray(array)) return array;
-    return _.filter(
-      array,
-      (element) =>
-        element !== null &&
-        element !== undefined &&
-        element !== "" &&
-        element !== "undefined" &&
-        element !== "null" &&
-        !_.isEmpty(element)
-    );
-  },
-
-  validateOrNullEmail(email: string): string | null {
-    if (!email) return null;
-    const emailRegex = /^[\w\-\.]+@([\w-]+\.)+[\w-]{2,}$/;
-    return emailRegex.test(email) ? email : null;
-  },
-
-  /**
-   * Tries to parse a date from various formats using Luxon with enhanced error reporting.
-   * @param {string | number} input The input date as a string or timestamp.
-   * @return {string | null} The parsed date in ISO 8601 format or null if parsing failed.
-   */
-  safeParseDate(input: string | number): number | null {
-    const formats = [
-      "M/d/yyyy HH:mm:ss", // U.S. style with time
-      "d/M/yyyy HH:mm:ss", // Rest of the world style with time
-      "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", // ISO 8601 format
-      "yyyy-MM-dd'T'HH:mm:ss", // ISO 8601 without milliseconds
-      "yyyy-MM-dd HH:mm:ss", // SQL datetime format (common log format)
-      "M/d/yyyy", // U.S. style without time
-      "d/M/yyyy", // Rest of the world style without time
-      "yyyy-MM-dd", // ISO date format
-      "dd-MM-yyyy",
-      "MM-dd-yyyy",
-      "dd/MM/yyyy",
-      "MM/dd/yyyy",
-      "dd.MM.yyyy",
-      "MM.dd.yyyy",
-      "yyyy.MM.dd",
-      "yyyy/MM/dd",
-      "yyyy/MM/dd HH:mm",
-      "yyyy-MM-dd HH:mm",
-      "M/d/yyyy h:mm:ss tt", // U.S. style with 12-hour clock
-      "d/M/yyyy h:mm:ss tt", // Rest of the world style with 12-hour clock
-      "h:mm tt", // Time only with 12-hour clock
-      "HH:mm:ss", // Time only with 24-hour clock
-      "HH:mm", // Time only without seconds, 24-hour clock
-      "h:mm tt M/d/yyyy", // 12-hour clock time followed by U.S. style date
-      "h:mm tt d/M/yyyy", // 12-hour clock time followed by Rest of the world style date
-      "yyyy-MM-dd'T'HH:mm:ss.SSSZ", // ISO 8601 with timezone offset
-      "yyyy-MM-dd'T'HH:mm:ssZ", // ISO 8601 without milliseconds but with timezone offset
-      "E, dd MMM yyyy HH:mm:ss z", // RFC 2822 format
-      "EEEE, MMMM d, yyyy", // Full textual date
-      "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", // ISO 8601 with extended timezone offset
-      "yyyy-MM-dd'T'HH:mm:ssXXX", // ISO 8601 without milliseconds but with extended timezone offset
-      "dd-MMM-yyyy", // Textual month with day and year
-    ];
-
-    // Attempt to parse as a timestamp first if input is a number
-    if (typeof input === "number") {
-      const dateFromMillis = DateTime.fromMillis(input);
-      if (dateFromMillis.isValid) {
-        return dateFromMillis.toMillis();
-      }
-    }
-
-    // Attempt to parse as an ISO string or SQL string
-    let date = DateTime.fromISO(String(input));
-    if (!date.isValid) date = DateTime.fromSQL(String(input));
-
-    // Try each custom format if still not valid
-    for (const format of formats) {
-      if (!date.isValid) {
-        date = DateTime.fromFormat(String(input), format);
-      }
-    }
-
-    // Return null if no valid date could be parsed
-    if (!date.isValid) {
-      return null;
-    }
-
-    return date.toMillis();
-  },
-  safeParseDateToYYYYMMDD(input: string | number): string | null {
-    const formats = [
-      "M/d/yyyy HH:mm:ss", // U.S. style with time
-      "d/M/yyyy HH:mm:ss", // Rest of the world style with time
-      "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'", // ISO 8601 format
-      "yyyy-MM-dd'T'HH:mm:ss", // ISO 8601 without milliseconds
-      "yyyy-MM-dd HH:mm:ss", // SQL datetime format (common log format)
-      "M/d/yyyy", // U.S. style without time
-      "d/M/yyyy", // Rest of the world style without time
-      "yyyy-MM-dd", // ISO date format
-      "dd-MM-yyyy",
-      "MM-dd-yyyy",
-      "dd/MM/yyyy",
-      "MM/dd/yyyy",
-      "dd.MM.yyyy",
-      "MM.dd.yyyy",
-      "yyyy.MM.dd",
-      "yyyy/MM/dd",
-      "yyyy/MM/dd HH:mm",
-      "yyyy-MM-dd HH:mm",
-      "M/d/yyyy h:mm:ss tt", // U.S. style with 12-hour clock
-      "d/M/yyyy h:mm:ss tt", // Rest of the world style with 12-hour clock
-      "h:mm tt", // Time only with 12-hour clock
-      "HH:mm:ss", // Time only with 24-hour clock
-      "HH:mm", // Time only without seconds, 24-hour clock
-      "h:mm tt M/d/yyyy", // 12-hour clock time followed by U.S. style date
-      "h:mm tt d/M/yyyy", // 12-hour clock time followed by Rest of the world style date
-      "yyyy-MM-dd'T'HH:mm:ss.SSSZ", // ISO 8601 with timezone offset
-      "yyyy-MM-dd'T'HH:mm:ssZ", // ISO 8601 without milliseconds but with timezone offset
-      "E, dd MMM yyyy HH:mm:ss z", // RFC 2822 format
-      "EEEE, MMMM d, yyyy", // Full textual date
-      "yyyy-MM-dd'T'HH:mm:ss.SSSXXX", // ISO 8601 with extended timezone offset
-      "yyyy-MM-dd'T'HH:mm:ssXXX", // ISO 8601 without milliseconds but with extended timezone offset
-      "dd-MMM-yyyy", // Textual month with day and year
-    ];
-
-    // Attempt to parse as a timestamp first if input is a number
-    if (typeof input === "number") {
-      const dateFromMillis = DateTime.fromMillis(input);
-      if (dateFromMillis.isValid) {
-        return dateFromMillis.toISODate();
-      }
-    }
-
-    // Attempt to parse as an ISO string or SQL string
-    let date = DateTime.fromISO(String(input));
-    if (!date.isValid) date = DateTime.fromSQL(String(input));
-
-    // Try each custom format if still not valid
-    for (const format of formats) {
-      if (!date.isValid) {
-        date = DateTime.fromFormat(String(input), format);
-      }
-    }
-
-    // Return null if no valid date could be parsed
-    if (!date.isValid) {
-      return null;
-    }
-
-    return date.toISODate(); // Corrected to return the date in YYYY-MM-DD format
-  },
-};
-
 /**
  * Deeply converts all properties of an object (or array) to strings.
  * @param data The input data to convert.
@@ -597,9 +61,6 @@ export const convertObjectBySchema = (
   }, {});
 };
 
-type AttributeMappings =
-  AppwriteConfig["collections"][number]["importDefs"][number]["attributeMappings"];
-
 /**
  * Converts the keys of an object based on a provided attributeMappings.
  * Each key in the object is checked against attributeMappings; if a matching entry is found,

package/src/migrations/dataLoader.ts

@@ -11,7 +11,7 @@ import {
   type ImportDef,
   type ImportDefs,
   type RelationshipAttribute,
-} from "./schema.js";
+} from "appwrite-utils";
 import path from "path";
 import fs from "fs";
 import { convertObjectByAttributeMappings } from "./converters.js";
@@ -216,6 +216,9 @@ export class DataLoader {
       if (db.$id !== dbId) {
         continue;
       }
+      if (!this.config.collections) {
+        continue;
+      }
       for (let index = 0; index < this.config.collections.length; index++) {
         const collectionConfig = this.config.collections[index];
         let collection = CollectionCreateSchema.parse(collectionConfig);
@@ -285,6 +288,9 @@ export class DataLoader {
       if (db.$id !== dbId) {
         continue;
       }
+      if (!this.config.collections) {
+        continue;
+      }
       // Iterate over the configured collections to process each
       for (const collectionConfig of this.config.collections) {
         const collection = collectionConfig;
@@ -345,7 +351,9 @@ export class DataLoader {
       this.config.usersCollectionName
     );
     const usersCollectionPrimaryKeyFields = new Set();
-
+    if (!this.config.collections) {
+      return;
+    }
     // Collect primary key fields from the users collection definitions
     this.config.collections.forEach((collection) => {
       if (this.getCollectionKey(collection.name) === usersCollectionKey) {
@@ -390,6 +398,9 @@ export class DataLoader {
   }
 
   async updateOldReferencesForNew() {
+    if (!this.config.collections) {
+      return;
+    }
     for (const collectionConfig of this.config.collections) {
       const collectionKey = this.getCollectionKey(collectionConfig.name);
       const collectionData = this.importMap.get(collectionKey);
@@ -472,6 +483,9 @@ export class DataLoader {
   }
 
   async updateReferencesInRelatedCollections() {
+    if (!this.config.collections) {
+      return;
+    }
     // Iterate over each collection configuration
     for (const collectionConfig of this.config.collections) {
       const collectionKey = this.getCollectionKey(collectionConfig.name);
@@ -1174,6 +1188,9 @@ export class DataLoader {
   }
 
   private updateReferencesBasedOnAttributeMappings() {
+    if (!this.config.collections) {
+      return;
+    }
     this.config.collections.forEach((collectionConfig) => {
       const collectionName = collectionConfig.name;
       const collectionData = this.importMap.get(

package/src/migrations/dbHelpers.ts

@@ -2,7 +2,7 @@ import type {
   AppwriteConfig,
   Attribute,
   RelationshipAttribute,
-} from "./schema.js";
+} from "appwrite-utils";
 
 // Helper function to categorize collections based on relationship sides
 export const categorizeCollectionByRelationshipSide = (
@@ -40,6 +40,9 @@ export const getDependencies = (attributes: Attribute[]): string[] => {
 export const sortCollections = (
   configCollections: AppwriteConfig["collections"]
 ): AppwriteConfig["collections"] => {
+  if (!configCollections) {
+    return [];
+  }
   // Categorize collections based on their relationship sides
   const parentCollections = configCollections.filter(
     ({ attributes }) =>

package/src/migrations/importController.ts

@@ -9,29 +9,16 @@ import type {
   AppwriteConfig,
   ConfigCollection,
   ConfigDatabase,
-  ImportDef,
   AttributeMappings,
-} from "./schema.js";
+} from "appwrite-utils";
 import type { ImportDataActions } from "./importDataActions.js";
-import { checkForCollection } from "./collections.js";
-import path from "path";
-import fs from "fs";
-import { convertObjectByAttributeMappings } from "./converters.js";
 import _ from "lodash";
-import { documentExists } from "./collections.js";
 import { areCollectionNamesSame } from "../utils/index.js";
 import type { SetupOptions } from "../utilsController.js";
 import { resolveAndUpdateRelationships } from "./relationships.js";
-import { AuthUserCreateSchema, type AuthUserCreate } from "../types.js";
 import { UsersController } from "./users.js";
 import { logger } from "./logging.js";
-import {
-  ContextObject,
-  createOrFindAfterImportOperation,
-  getAfterImportOperations,
-  splitIntoBatches,
-  updateOperation,
-} from "./migrationHelper.js";
+import { updateOperation } from "./migrationHelper.js";
 import {
   BatchSchema,
   OperationCreateSchema,
@@ -121,6 +108,9 @@ export class ImportController {
   }
 
   async importCollections(db: ConfigDatabase, dataLoader: DataLoader) {
+    if (!this.config.collections) {
+      return;
+    }
     for (const collection of this.config.collections) {
       let isUsersCollection =
         dataLoader.getCollectionKey(this.config.usersCollectionName) ===