appwrite-utils-cli/dist/utils/yamlConverter.js

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.

import yaml from "js-yaml";
/**
 * Converts a Collection object to YAML format with proper schema reference
 */
export function collectionToYaml(collection, schemaPath = "../.yaml_schemas/collection.schema.json") {
    // Convert Collection to YamlCollectionData format
    const yamlData = {
        name: collection.name,
        id: collection.$id,
        documentSecurity: collection.documentSecurity,
        enabled: collection.enabled,
    };
    // Convert permissions
    if (collection.$permissions && collection.$permissions.length > 0) {
        yamlData.permissions = collection.$permissions.map(p => ({
            permission: p.permission,
            target: p.target
        }));
    }
    // Convert attributes
    if (collection.attributes && collection.attributes.length > 0) {
        yamlData.attributes = collection.attributes.map(attr => {
            const yamlAttr = {
                key: attr.key,
                type: attr.type,
            };
            // Add optional properties only if they exist (safely access with 'in' operator)
            if ('size' in attr && attr.size !== undefined)
                yamlAttr.size = attr.size;
            if (attr.required !== undefined)
                yamlAttr.required = attr.required;
            if (attr.array !== undefined)
                yamlAttr.array = attr.array;
            if ('xdefault' in attr && attr.xdefault !== undefined)
                yamlAttr.default = attr.xdefault;
            if (attr.description !== undefined)
                yamlAttr.description = attr.description;
            if ('min' in attr && attr.min !== undefined)
                yamlAttr.min = attr.min;
            if ('max' in attr && attr.max !== undefined)
                yamlAttr.max = attr.max;
            if ('elements' in attr && attr.elements !== undefined)
                yamlAttr.elements = attr.elements;
            if ('relatedCollection' in attr && attr.relatedCollection !== undefined)
                yamlAttr.relatedCollection = attr.relatedCollection;
            if ('relationType' in attr && attr.relationType !== undefined)
                yamlAttr.relationType = attr.relationType;
            if ('twoWay' in attr && attr.twoWay !== undefined)
                yamlAttr.twoWay = attr.twoWay;
            if ('twoWayKey' in attr && attr.twoWayKey !== undefined)
                yamlAttr.twoWayKey = attr.twoWayKey;
            if ('onDelete' in attr && attr.onDelete !== undefined)
                yamlAttr.onDelete = attr.onDelete;
            if ('side' in attr && attr.side !== undefined)
                yamlAttr.side = attr.side;
            return yamlAttr;
        });
    }
    // Convert indexes
    if (collection.indexes && collection.indexes.length > 0) {
        yamlData.indexes = collection.indexes.map(idx => ({
            key: idx.key,
            type: idx.type,
            attributes: idx.attributes,
            ...(idx.orders && idx.orders.length > 0 ? { orders: idx.orders } : {})
        }));
    }
    // Add import definitions if they exist
    if (collection.importDefs && collection.importDefs.length > 0) {
        yamlData.importDefs = collection.importDefs;
    }
    else {
        yamlData.importDefs = [];
    }
    // Generate YAML with schema reference
    const yamlContent = yaml.dump(yamlData, {
        indent: 2,
        lineWidth: 120,
        sortKeys: false,
        quotingType: '"',
        forceQuotes: false,
    });
    return `# yaml-language-server: $schema=${schemaPath}
# Collection Definition: ${collection.name}
${yamlContent}`;
}
/**
 * Sanitizes a collection name for use as a filename
 */
export function sanitizeFilename(name) {
    return name.replace(/[^a-zA-Z0-9_-]/g, '_');
}
/**
 * Generates the filename for a collection YAML file
 */
export function getCollectionYamlFilename(collection) {
    return `${sanitizeFilename(collection.name)}.yaml`;
}