@basictech/schema 0.1.0-beta.0 → 0.1.0

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../index.ts"],"sourcesContent":["function hello() : string { \n    return 'hello'\n}\n\nexport default hello"],"mappings":";AAAA,SAAS,QAAiB;AACtB,SAAO;AACX;AAEA,IAAO,iBAAQ;","names":[]}
+{"version":3,"sources":["../index.ts"],"sourcesContent":["// Basic Schema Library\n// utils for validating and interacting with Basic schemas\nimport Ajv, { ErrorObject } from 'ajv'\n\nconst basicJsonSchema = {\n    \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n        \"project_id\": {\n            \"type\": \"string\"\n        },\n        \"namespace\": {\n            \"type\": \"string\",\n        },\n        \"version\": {\n            \"type\": \"integer\",\n            \"minimum\": 0\n        },\n        \"tables\": {\n            \"type\": \"object\",\n            \"patternProperties\": {\n                \"^[a-zA-Z0-9_]+$\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": {\n                            \"type\": \"string\"\n                        },\n                        \"type\": {\n                            \"type\": \"string\",\n                            \"enum\": [\"collection\"]\n                        },\n                        \"fields\": {\n                            \"type\": \"object\",\n                            \"patternProperties\": {\n                                \"^[a-zA-Z0-9_]+$\": {\n                                    \"type\": \"object\",\n                                    \"properties\": {\n                                        \"type\": {\n                                            \"type\": \"string\",\n                                            \"enum\": [\"string\", \"boolean\", \"number\", \"json\"]\n                                        },\n                                        \"indexed\": {\n                                            \"type\": \"boolean\"\n                                        }, \n                                        \"required\": {\n                                            \"type\": \"boolean\"\n                                        }\n                                    },\n                                    \"required\": [\"type\"]\n                                }\n                            },\n                            \"additionalProperties\": true\n                        }\n                    },\n                    \"required\": [\"fields\"]\n                }\n            },\n            \"additionalProperties\": true\n        }\n    },\n    \"required\": [\"project_id\", \"version\", \"tables\"]\n  }\n\nconst ajv = new Ajv()\nconst validator = ajv.compile(basicJsonSchema)\n\n\nfunction generateEmptySchema(project_id: string = \"\", version: number = 0)  {\n    return {\n        project_id: project_id,\n        version: version,\n        tables: {\n            fields: {\n                example: { \n                    type: \"string\",\n                }\n            }\n        }\n    }\n}\n\ntype Schema = { \n    project_id : string,\n    version : number,\n    tables : any\n}\n\n\n/**\n * Validate a schema\n * only checks if the schema is formatted correctly, not if can be published\n * @param schema - The schema to validate\n * @returns {valid: boolean, errors: any[]} - The validation result\n */\nfunction validateSchema(schema: any) : {valid: boolean, errors: ErrorObject[]} {\n    const v = validator(schema)\n    return { \n        valid: v,\n        errors: validator.errors || []\n    }\n}\n\n// type ErrorObject = {\n//     keyword: string;\n//     instancePath: string; \n//     schemaPath: string;\n//     params: Record<string, any>;\n//     propertyName?: string;\n//     message?: string;\n//     schema?: any;\n//     parentSchema?: any;\n//     data?: any;\n// }\n\n\n/**\n * Validate data against a schema's table definition. Only checks against provided schema.\n * @param schema - The schema to validate against\n * @param table - The table name in the schema to validate against\n * @param data - The data object to validate\n * @param checkRequired - Whether to check if required fields are present (default: true)\n * @returns {Object} Validation result containing:\n *   - valid: boolean indicating if validation passed\n *   - errors: Array of validation error objects\n *   - message: Error message if validation failed\n */\n\nfunction validateData(schema: any, table: string, data: Record<string, any>, checkRequired: boolean = true) {\n    const valid = validateSchema(schema)\n    if (!valid.valid) {\n        return { valid: false, errors: valid.errors, message: \"Schema is invalid\" }\n    }\n\n    const tableSchema = schema.tables[table]\n\n    if (!tableSchema) {\n        return { valid: false, errors: [{ message: `Table ${table} not found in schema` }], message: \"Table not found\" }\n    }\n\n    for (const [fieldName, fieldValue] of Object.entries(data)) {\n        const fieldSchema = tableSchema.fields[fieldName]\n        \n        if (!fieldSchema) {\n            return { \n                valid: false, \n                errors: [{ message: `Field ${fieldName} not found in schema` }],\n                message: \"Invalid field\"\n            }\n        }\n\n        const schemaType = fieldSchema.type\n        const valueType = typeof fieldValue\n\n        if (  \n            (schemaType === 'string' && valueType !== 'string') ||\n            (schemaType === 'number' && valueType !== 'number') ||\n            (schemaType === 'boolean' && valueType !== 'boolean') ||\n            (schemaType === 'json' && valueType !== 'object')\n        ) {\n            return {\n                valid: false,\n                errors: [{ \n                    message: `Field ${fieldName} should be type ${schemaType}, got ${valueType}` \n                }],\n                message: \"invalid type\"\n            }\n        }\n    }\n\n    if (checkRequired) {\n        for (const [fieldName, fieldSchema] of Object.entries(tableSchema.fields)) {\n            if ((fieldSchema as { required?: boolean }).required && !data[fieldName]) {\n                return { valid: false, errors: [{ message: `Field ${fieldName} is required` }], message: \"Required field missing\" }\n            }\n        }\n    }\n\n    return { valid: true, errors: [] }\n}\n\ntype SchemaChangeType = \"property_changed\" | \"property_removed\" | \"table_added\" | \"table_removed\" | \"field_added\" | \"field_removed\" | \"field_type_changed\" | \"field_required_changed\" | \"field_property_added\" | \"field_property_changed\" | \"field_property_removed\"\n\n\ntype SchemaChange = {\n    type: SchemaChangeType,\n    property?: string,\n    table?: string,\n    field?: string,\n    old?: any,\n    new?: any\n}\n\nfunction _getSchemaChanges(oldSchema: any, newSchema: any) : SchemaChange[] {\n    // Compare tables between schemas\n    const changes : SchemaChange[] = []\n\n    // Check for top level property changes\n    for (const key in newSchema) {\n        if (key !== 'tables' && newSchema[key] !== oldSchema[key]) {\n            changes.push({\n                type: 'property_changed',\n                property: key,\n                old: oldSchema[key],\n                new: newSchema[key]\n            })\n        }\n    }\n\n    for (const key in oldSchema) {\n        if (key !== 'tables' && !newSchema.hasOwnProperty(key)) {\n            changes.push({\n                type: 'property_removed',\n                property: key,\n                old: oldSchema[key]\n            })\n        }\n    }\n\n    // Check for removed tables\n    for (const tableName in oldSchema.tables) {\n        if (!newSchema.tables[tableName]) {\n            changes.push({\n                type: 'table_removed',\n                table: tableName\n            })\n        }\n    }\n\n    // Check for added tables and field changes\n    for (const tableName in newSchema.tables) {\n        const newTable = newSchema.tables[tableName]\n        const oldTable = oldSchema.tables[tableName]\n\n        if (!oldTable) {\n            changes.push({\n                type: 'table_added', \n                table: tableName\n            })\n            continue\n        }\n\n        // Compare fields\n        for (const fieldName in newTable.fields) {\n            const newField = newTable.fields[fieldName]\n            const oldField = oldTable.fields[fieldName]\n\n            if (!oldField) {\n                changes.push({\n                    type: 'field_added',\n                    table: tableName,\n                    field: fieldName\n                })\n                continue\n            }\n\n            // Check for field type changes\n            if (newField.type !== oldField.type) {\n                changes.push({\n                    type: 'field_type_changed',\n                    table: tableName,\n                    field: fieldName,\n                    old: oldField.type,\n                    new: newField.type\n                })\n            }\n\n            // Check for required flag changes\n            if (newField.required !== oldField.required) {\n                changes.push({\n                    type: 'field_required_changed',\n                    table: tableName,\n                    field: fieldName,\n                    old: oldField.required,\n                    new: newField.required\n                })\n            }\n        }\n\n        // Check for removed fields\n        for (const fieldName in oldTable.fields) {\n            if (!newTable.fields[fieldName]) {\n                changes.push({\n                    type: 'field_removed',\n                    table: tableName,\n                    field: fieldName\n                })\n            }\n        }\n    }\n\n    // Check for field property changes (excluding type which is already checked)\n    for (const tableName in newSchema.tables) {\n        const newTable = newSchema.tables[tableName]\n        const oldTable = oldSchema.tables[tableName]\n\n        if (!oldTable) continue\n\n        for (const fieldName in newTable.fields) {\n            const newField = newTable.fields[fieldName]\n            const oldField = oldTable.fields[fieldName]\n\n            if (!oldField) continue\n\n            // Compare all properties except type\n            for (const prop in newField) {\n                if (prop === 'type') continue\n                \n                if (!(prop in oldField)) {\n                    changes.push({\n                        type: 'field_property_added',\n                        table: tableName,\n                        field: fieldName,\n                        property: prop,\n                        new: newField[prop]\n                    })\n                } else if (JSON.stringify(newField[prop]) !== JSON.stringify(oldField[prop])) {\n                    changes.push({\n                        type: 'field_property_changed',\n                        table: tableName,\n                        field: fieldName,\n                        property: prop,\n                        old: oldField[prop],\n                        new: newField[prop]\n                    })\n                }\n            }\n\n            // Check for removed properties\n            for (const prop in oldField) {\n                if (prop === 'type') continue\n                if (!(prop in newField)) {\n                    changes.push({\n                        type: 'field_property_removed',\n                        table: tableName,\n                        field: fieldName,\n                        property: prop,\n                        old: oldField[prop]\n                    })\n                }\n            }\n        }\n    }\n\n    return changes\n}\n\n\n// function verifyScehma(schema : any ) { \n//     const valid = validateSchema(schema)\n//     if (!valid.valid) {\n//         return { valid: false, errors: valid.errors, message: \"Schema is invalid\" }\n//     }\n\n\n\n\n//     return { valid: true, errors: [] }\n// }\n\n\nfunction validateUpdateSchema(oldSchema: any, newSchema: any)  {\n    const oldValid = validateSchema(oldSchema)\n    const newValid = validateSchema(newSchema)\n\n    if (!oldValid.valid || !newValid.valid) {\n        return { valid: false, errors: oldValid.errors.concat(newValid.errors), message: \"schemas are is invalid\" }\n    }\n\n    \n    const changes = _getSchemaChanges(oldSchema, newSchema)\n\n    const changeErrors = []\n    for (const change of changes) {\n        if (change.type === 'property_changed' && change.property === 'project_id') {\n            changeErrors.push({ \n                change: change,\n                message: \"Cannot modify project_id property\"\n            })\n        }\n\n        if (change.type === 'property_changed' && change.property === 'version') {\n            if (change.new !== change.old + 1) {\n                changeErrors.push({\n                    change: change,\n                    message: `Version must be incremented by 1. Expected version:${change.old + 1}, got version:${change.new}`\n                })\n            }\n        }\n\n        if (change.type === 'field_type_changed') {\n            changeErrors.push({\n                change: change,\n                message: `Cannot change type of field \"${change.field}\" from \"${change.old}\" to \"${change.new}\"`\n            })\n        }\n    }\n\n    if (changeErrors.length > 0) {\n        return {\n            valid: false,\n            errors: changeErrors,\n            message: \"Invalid schema changes detected\"\n        }\n    }\n\n    return { valid: true, changes: changes }\n}\n\nexport {\n    validateSchema,\n    validateData,\n    generateEmptySchema,\n    validateUpdateSchema\n}\n\nconst schema = {\n    validateSchema,\n    validateData,\n    generateEmptySchema,\n    validateUpdateSchema\n}\n\nexport default schema"],"mappings":";AAEA,OAAO,SAA0B;AAEjC,IAAM,kBAAkB;AAAA,EACpB,WAAW;AAAA,EACX,QAAQ;AAAA,EACR,cAAc;AAAA,IACV,cAAc;AAAA,MACV,QAAQ;AAAA,IACZ;AAAA,IACA,aAAa;AAAA,MACT,QAAQ;AAAA,IACZ;AAAA,IACA,WAAW;AAAA,MACP,QAAQ;AAAA,MACR,WAAW;AAAA,IACf;AAAA,IACA,UAAU;AAAA,MACN,QAAQ;AAAA,MACR,qBAAqB;AAAA,QACjB,mBAAmB;AAAA,UACf,QAAQ;AAAA,UACR,cAAc;AAAA,YACV,QAAQ;AAAA,cACJ,QAAQ;AAAA,YACZ;AAAA,YACA,QAAQ;AAAA,cACJ,QAAQ;AAAA,cACR,QAAQ,CAAC,YAAY;AAAA,YACzB;AAAA,YACA,UAAU;AAAA,cACN,QAAQ;AAAA,cACR,qBAAqB;AAAA,gBACjB,mBAAmB;AAAA,kBACf,QAAQ;AAAA,kBACR,cAAc;AAAA,oBACV,QAAQ;AAAA,sBACJ,QAAQ;AAAA,sBACR,QAAQ,CAAC,UAAU,WAAW,UAAU,MAAM;AAAA,oBAClD;AAAA,oBACA,WAAW;AAAA,sBACP,QAAQ;AAAA,oBACZ;AAAA,oBACA,YAAY;AAAA,sBACR,QAAQ;AAAA,oBACZ;AAAA,kBACJ;AAAA,kBACA,YAAY,CAAC,MAAM;AAAA,gBACvB;AAAA,cACJ;AAAA,cACA,wBAAwB;AAAA,YAC5B;AAAA,UACJ;AAAA,UACA,YAAY,CAAC,QAAQ;AAAA,QACzB;AAAA,MACJ;AAAA,MACA,wBAAwB;AAAA,IAC5B;AAAA,EACJ;AAAA,EACA,YAAY,CAAC,cAAc,WAAW,QAAQ;AAChD;AAEF,IAAM,MAAM,IAAI,IAAI;AACpB,IAAM,YAAY,IAAI,QAAQ,eAAe;AAG7C,SAAS,oBAAoB,aAAqB,IAAI,UAAkB,GAAI;AACxE,SAAO;AAAA,IACH;AAAA,IACA;AAAA,IACA,QAAQ;AAAA,MACJ,QAAQ;AAAA,QACJ,SAAS;AAAA,UACL,MAAM;AAAA,QACV;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AACJ;AAeA,SAAS,eAAeA,SAAuD;AAC3E,QAAM,IAAI,UAAUA,OAAM;AAC1B,SAAO;AAAA,IACH,OAAO;AAAA,IACP,QAAQ,UAAU,UAAU,CAAC;AAAA,EACjC;AACJ;AA2BA,SAAS,aAAaA,SAAa,OAAe,MAA2B,gBAAyB,MAAM;AACxG,QAAM,QAAQ,eAAeA,OAAM;AACnC,MAAI,CAAC,MAAM,OAAO;AACd,WAAO,EAAE,OAAO,OAAO,QAAQ,MAAM,QAAQ,SAAS,oBAAoB;AAAA,EAC9E;AAEA,QAAM,cAAcA,QAAO,OAAO,KAAK;AAEvC,MAAI,CAAC,aAAa;AACd,WAAO,EAAE,OAAO,OAAO,QAAQ,CAAC,EAAE,SAAS,SAAS,KAAK,uBAAuB,CAAC,GAAG,SAAS,kBAAkB;AAAA,EACnH;AAEA,aAAW,CAAC,WAAW,UAAU,KAAK,OAAO,QAAQ,IAAI,GAAG;AACxD,UAAM,cAAc,YAAY,OAAO,SAAS;AAEhD,QAAI,CAAC,aAAa;AACd,aAAO;AAAA,QACH,OAAO;AAAA,QACP,QAAQ,CAAC,EAAE,SAAS,SAAS,SAAS,uBAAuB,CAAC;AAAA,QAC9D,SAAS;AAAA,MACb;AAAA,IACJ;AAEA,UAAM,aAAa,YAAY;AAC/B,UAAM,YAAY,OAAO;AAEzB,QACK,eAAe,YAAY,cAAc,YACzC,eAAe,YAAY,cAAc,YACzC,eAAe,aAAa,cAAc,aAC1C,eAAe,UAAU,cAAc,UAC1C;AACE,aAAO;AAAA,QACH,OAAO;AAAA,QACP,QAAQ,CAAC;AAAA,UACL,SAAS,SAAS,SAAS,mBAAmB,UAAU,SAAS,SAAS;AAAA,QAC9E,CAAC;AAAA,QACD,SAAS;AAAA,MACb;AAAA,IACJ;AAAA,EACJ;AAEA,MAAI,eAAe;AACf,eAAW,CAAC,WAAW,WAAW,KAAK,OAAO,QAAQ,YAAY,MAAM,GAAG;AACvE,UAAK,YAAuC,YAAY,CAAC,KAAK,SAAS,GAAG;AACtE,eAAO,EAAE,OAAO,OAAO,QAAQ,CAAC,EAAE,SAAS,SAAS,SAAS,eAAe,CAAC,GAAG,SAAS,yBAAyB;AAAA,MACtH;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO,EAAE,OAAO,MAAM,QAAQ,CAAC,EAAE;AACrC;AAcA,SAAS,kBAAkB,WAAgB,WAAiC;AAExE,QAAM,UAA2B,CAAC;AAGlC,aAAW,OAAO,WAAW;AACzB,QAAI,QAAQ,YAAY,UAAU,GAAG,MAAM,UAAU,GAAG,GAAG;AACvD,cAAQ,KAAK;AAAA,QACT,MAAM;AAAA,QACN,UAAU;AAAA,QACV,KAAK,UAAU,GAAG;AAAA,QAClB,KAAK,UAAU,GAAG;AAAA,MACtB,CAAC;AAAA,IACL;AAAA,EACJ;AAEA,aAAW,OAAO,WAAW;AACzB,QAAI,QAAQ,YAAY,CAAC,UAAU,eAAe,GAAG,GAAG;AACpD,cAAQ,KAAK;AAAA,QACT,MAAM;AAAA,QACN,UAAU;AAAA,QACV,KAAK,UAAU,GAAG;AAAA,MACtB,CAAC;AAAA,IACL;AAAA,EACJ;AAGA,aAAW,aAAa,UAAU,QAAQ;AACtC,QAAI,CAAC,UAAU,OAAO,SAAS,GAAG;AAC9B,cAAQ,KAAK;AAAA,QACT,MAAM;AAAA,QACN,OAAO;AAAA,MACX,CAAC;AAAA,IACL;AAAA,EACJ;AAGA,aAAW,aAAa,UAAU,QAAQ;AACtC,UAAM,WAAW,UAAU,OAAO,SAAS;AAC3C,UAAM,WAAW,UAAU,OAAO,SAAS;AAE3C,QAAI,CAAC,UAAU;AACX,cAAQ,KAAK;AAAA,QACT,MAAM;AAAA,QACN,OAAO;AAAA,MACX,CAAC;AACD;AAAA,IACJ;AAGA,eAAW,aAAa,SAAS,QAAQ;AACrC,YAAM,WAAW,SAAS,OAAO,SAAS;AAC1C,YAAM,WAAW,SAAS,OAAO,SAAS;AAE1C,UAAI,CAAC,UAAU;AACX,gBAAQ,KAAK;AAAA,UACT,MAAM;AAAA,UACN,OAAO;AAAA,UACP,OAAO;AAAA,QACX,CAAC;AACD;AAAA,MACJ;AAGA,UAAI,SAAS,SAAS,SAAS,MAAM;AACjC,gBAAQ,KAAK;AAAA,UACT,MAAM;AAAA,UACN,OAAO;AAAA,UACP,OAAO;AAAA,UACP,KAAK,SAAS;AAAA,UACd,KAAK,SAAS;AAAA,QAClB,CAAC;AAAA,MACL;AAGA,UAAI,SAAS,aAAa,SAAS,UAAU;AACzC,gBAAQ,KAAK;AAAA,UACT,MAAM;AAAA,UACN,OAAO;AAAA,UACP,OAAO;AAAA,UACP,KAAK,SAAS;AAAA,UACd,KAAK,SAAS;AAAA,QAClB,CAAC;AAAA,MACL;AAAA,IACJ;AAGA,eAAW,aAAa,SAAS,QAAQ;AACrC,UAAI,CAAC,SAAS,OAAO,SAAS,GAAG;AAC7B,gBAAQ,KAAK;AAAA,UACT,MAAM;AAAA,UACN,OAAO;AAAA,UACP,OAAO;AAAA,QACX,CAAC;AAAA,MACL;AAAA,IACJ;AAAA,EACJ;AAGA,aAAW,aAAa,UAAU,QAAQ;AACtC,UAAM,WAAW,UAAU,OAAO,SAAS;AAC3C,UAAM,WAAW,UAAU,OAAO,SAAS;AAE3C,QAAI,CAAC;AAAU;AAEf,eAAW,aAAa,SAAS,QAAQ;AACrC,YAAM,WAAW,SAAS,OAAO,SAAS;AAC1C,YAAM,WAAW,SAAS,OAAO,SAAS;AAE1C,UAAI,CAAC;AAAU;AAGf,iBAAW,QAAQ,UAAU;AACzB,YAAI,SAAS;AAAQ;AAErB,YAAI,EAAE,QAAQ,WAAW;AACrB,kBAAQ,KAAK;AAAA,YACT,MAAM;AAAA,YACN,OAAO;AAAA,YACP,OAAO;AAAA,YACP,UAAU;AAAA,YACV,KAAK,SAAS,IAAI;AAAA,UACtB,CAAC;AAAA,QACL,WAAW,KAAK,UAAU,SAAS,IAAI,CAAC,MAAM,KAAK,UAAU,SAAS,IAAI,CAAC,GAAG;AAC1E,kBAAQ,KAAK;AAAA,YACT,MAAM;AAAA,YACN,OAAO;AAAA,YACP,OAAO;AAAA,YACP,UAAU;AAAA,YACV,KAAK,SAAS,IAAI;AAAA,YAClB,KAAK,SAAS,IAAI;AAAA,UACtB,CAAC;AAAA,QACL;AAAA,MACJ;AAGA,iBAAW,QAAQ,UAAU;AACzB,YAAI,SAAS;AAAQ;AACrB,YAAI,EAAE,QAAQ,WAAW;AACrB,kBAAQ,KAAK;AAAA,YACT,MAAM;AAAA,YACN,OAAO;AAAA,YACP,OAAO;AAAA,YACP,UAAU;AAAA,YACV,KAAK,SAAS,IAAI;AAAA,UACtB,CAAC;AAAA,QACL;AAAA,MACJ;AAAA,IACJ;AAAA,EACJ;AAEA,SAAO;AACX;AAgBA,SAAS,qBAAqB,WAAgB,WAAiB;AAC3D,QAAM,WAAW,eAAe,SAAS;AACzC,QAAM,WAAW,eAAe,SAAS;AAEzC,MAAI,CAAC,SAAS,SAAS,CAAC,SAAS,OAAO;AACpC,WAAO,EAAE,OAAO,OAAO,QAAQ,SAAS,OAAO,OAAO,SAAS,MAAM,GAAG,SAAS,yBAAyB;AAAA,EAC9G;AAGA,QAAM,UAAU,kBAAkB,WAAW,SAAS;AAEtD,QAAM,eAAe,CAAC;AACtB,aAAW,UAAU,SAAS;AAC1B,QAAI,OAAO,SAAS,sBAAsB,OAAO,aAAa,cAAc;AACxE,mBAAa,KAAK;AAAA,QACd;AAAA,QACA,SAAS;AAAA,MACb,CAAC;AAAA,IACL;AAEA,QAAI,OAAO,SAAS,sBAAsB,OAAO,aAAa,WAAW;AACrE,UAAI,OAAO,QAAQ,OAAO,MAAM,GAAG;AAC/B,qBAAa,KAAK;AAAA,UACd;AAAA,UACA,SAAS,sDAAsD,OAAO,MAAM,CAAC,iBAAiB,OAAO,GAAG;AAAA,QAC5G,CAAC;AAAA,MACL;AAAA,IACJ;AAEA,QAAI,OAAO,SAAS,sBAAsB;AACtC,mBAAa,KAAK;AAAA,QACd;AAAA,QACA,SAAS,gCAAgC,OAAO,KAAK,WAAW,OAAO,GAAG,SAAS,OAAO,GAAG;AAAA,MACjG,CAAC;AAAA,IACL;AAAA,EACJ;AAEA,MAAI,aAAa,SAAS,GAAG;AACzB,WAAO;AAAA,MACH,OAAO;AAAA,MACP,QAAQ;AAAA,MACR,SAAS;AAAA,IACb;AAAA,EACJ;AAEA,SAAO,EAAE,OAAO,MAAM,QAAiB;AAC3C;AASA,IAAM,SAAS;AAAA,EACX;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;AAEA,IAAO,iBAAQ;","names":["schema"]}

package/index.ts

@@ -1,5 +1,423 @@
-function hello() : string { 
-    return 'hello'
+// Basic Schema Library
+// utils for validating and interacting with Basic schemas
+import Ajv, { ErrorObject } from 'ajv'
+
+const basicJsonSchema = {
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "type": "object",
+    "properties": {
+        "project_id": {
+            "type": "string"
+        },
+        "namespace": {
+            "type": "string",
+        },
+        "version": {
+            "type": "integer",
+            "minimum": 0
+        },
+        "tables": {
+            "type": "object",
+            "patternProperties": {
+                "^[a-zA-Z0-9_]+$": {
+                    "type": "object",
+                    "properties": {
+                        "name": {
+                            "type": "string"
+                        },
+                        "type": {
+                            "type": "string",
+                            "enum": ["collection"]
+                        },
+                        "fields": {
+                            "type": "object",
+                            "patternProperties": {
+                                "^[a-zA-Z0-9_]+$": {
+                                    "type": "object",
+                                    "properties": {
+                                        "type": {
+                                            "type": "string",
+                                            "enum": ["string", "boolean", "number", "json"]
+                                        },
+                                        "indexed": {
+                                            "type": "boolean"
+                                        }, 
+                                        "required": {
+                                            "type": "boolean"
+                                        }
+                                    },
+                                    "required": ["type"]
+                                }
+                            },
+                            "additionalProperties": true
+                        }
+                    },
+                    "required": ["fields"]
+                }
+            },
+            "additionalProperties": true
+        }
+    },
+    "required": ["project_id", "version", "tables"]
+  }
+
+const ajv = new Ajv()
+const validator = ajv.compile(basicJsonSchema)
+
+
+function generateEmptySchema(project_id: string = "", version: number = 0)  {
+    return {
+        project_id: project_id,
+        version: version,
+        tables: {
+            fields: {
+                example: { 
+                    type: "string",
+                }
+            }
+        }
+    }
+}
+
+type Schema = { 
+    project_id : string,
+    version : number,
+    tables : any
+}
+
+
+/**
+ * Validate a schema
+ * only checks if the schema is formatted correctly, not if can be published
+ * @param schema - The schema to validate
+ * @returns {valid: boolean, errors: any[]} - The validation result
+ */
+function validateSchema(schema: any) : {valid: boolean, errors: ErrorObject[]} {
+    const v = validator(schema)
+    return { 
+        valid: v,
+        errors: validator.errors || []
+    }
+}
+
+// type ErrorObject = {
+//     keyword: string;
+//     instancePath: string; 
+//     schemaPath: string;
+//     params: Record<string, any>;
+//     propertyName?: string;
+//     message?: string;
+//     schema?: any;
+//     parentSchema?: any;
+//     data?: any;
+// }
+
+
+/**
+ * Validate data against a schema's table definition. Only checks against provided schema.
+ * @param schema - The schema to validate against
+ * @param table - The table name in the schema to validate against
+ * @param data - The data object to validate
+ * @param checkRequired - Whether to check if required fields are present (default: true)
+ * @returns {Object} Validation result containing:
+ *   - valid: boolean indicating if validation passed
+ *   - errors: Array of validation error objects
+ *   - message: Error message if validation failed
+ */
+
+function validateData(schema: any, table: string, data: Record<string, any>, checkRequired: boolean = true) {
+    const valid = validateSchema(schema)
+    if (!valid.valid) {
+        return { valid: false, errors: valid.errors, message: "Schema is invalid" }
+    }
+
+    const tableSchema = schema.tables[table]
+
+    if (!tableSchema) {
+        return { valid: false, errors: [{ message: `Table ${table} not found in schema` }], message: "Table not found" }
+    }
+
+    for (const [fieldName, fieldValue] of Object.entries(data)) {
+        const fieldSchema = tableSchema.fields[fieldName]
+        
+        if (!fieldSchema) {
+            return { 
+                valid: false, 
+                errors: [{ message: `Field ${fieldName} not found in schema` }],
+                message: "Invalid field"
+            }
+        }
+
+        const schemaType = fieldSchema.type
+        const valueType = typeof fieldValue
+
+        if (  
+            (schemaType === 'string' && valueType !== 'string') ||
+            (schemaType === 'number' && valueType !== 'number') ||
+            (schemaType === 'boolean' && valueType !== 'boolean') ||
+            (schemaType === 'json' && valueType !== 'object')
+        ) {
+            return {
+                valid: false,
+                errors: [{ 
+                    message: `Field ${fieldName} should be type ${schemaType}, got ${valueType}` 
+                }],
+                message: "invalid type"
+            }
+        }
+    }
+
+    if (checkRequired) {
+        for (const [fieldName, fieldSchema] of Object.entries(tableSchema.fields)) {
+            if ((fieldSchema as { required?: boolean }).required && !data[fieldName]) {
+                return { valid: false, errors: [{ message: `Field ${fieldName} is required` }], message: "Required field missing" }
+            }
+        }
+    }
+
+    return { valid: true, errors: [] }
+}
+
+type SchemaChangeType = "property_changed" | "property_removed" | "table_added" | "table_removed" | "field_added" | "field_removed" | "field_type_changed" | "field_required_changed" | "field_property_added" | "field_property_changed" | "field_property_removed"
+
+
+type SchemaChange = {
+    type: SchemaChangeType,
+    property?: string,
+    table?: string,
+    field?: string,
+    old?: any,
+    new?: any
+}
+
+function _getSchemaChanges(oldSchema: any, newSchema: any) : SchemaChange[] {
+    // Compare tables between schemas
+    const changes : SchemaChange[] = []
+
+    // Check for top level property changes
+    for (const key in newSchema) {
+        if (key !== 'tables' && newSchema[key] !== oldSchema[key]) {
+            changes.push({
+                type: 'property_changed',
+                property: key,
+                old: oldSchema[key],
+                new: newSchema[key]
+            })
+        }
+    }
+
+    for (const key in oldSchema) {
+        if (key !== 'tables' && !newSchema.hasOwnProperty(key)) {
+            changes.push({
+                type: 'property_removed',
+                property: key,
+                old: oldSchema[key]
+            })
+        }
+    }
+
+    // Check for removed tables
+    for (const tableName in oldSchema.tables) {
+        if (!newSchema.tables[tableName]) {
+            changes.push({
+                type: 'table_removed',
+                table: tableName
+            })
+        }
+    }
+
+    // Check for added tables and field changes
+    for (const tableName in newSchema.tables) {
+        const newTable = newSchema.tables[tableName]
+        const oldTable = oldSchema.tables[tableName]
+
+        if (!oldTable) {
+            changes.push({
+                type: 'table_added', 
+                table: tableName
+            })
+            continue
+        }
+
+        // Compare fields
+        for (const fieldName in newTable.fields) {
+            const newField = newTable.fields[fieldName]
+            const oldField = oldTable.fields[fieldName]
+
+            if (!oldField) {
+                changes.push({
+                    type: 'field_added',
+                    table: tableName,
+                    field: fieldName
+                })
+                continue
+            }
+
+            // Check for field type changes
+            if (newField.type !== oldField.type) {
+                changes.push({
+                    type: 'field_type_changed',
+                    table: tableName,
+                    field: fieldName,
+                    old: oldField.type,
+                    new: newField.type
+                })
+            }
+
+            // Check for required flag changes
+            if (newField.required !== oldField.required) {
+                changes.push({
+                    type: 'field_required_changed',
+                    table: tableName,
+                    field: fieldName,
+                    old: oldField.required,
+                    new: newField.required
+                })
+            }
+        }
+
+        // Check for removed fields
+        for (const fieldName in oldTable.fields) {
+            if (!newTable.fields[fieldName]) {
+                changes.push({
+                    type: 'field_removed',
+                    table: tableName,
+                    field: fieldName
+                })
+            }
+        }
+    }
+
+    // Check for field property changes (excluding type which is already checked)
+    for (const tableName in newSchema.tables) {
+        const newTable = newSchema.tables[tableName]
+        const oldTable = oldSchema.tables[tableName]
+
+        if (!oldTable) continue
+
+        for (const fieldName in newTable.fields) {
+            const newField = newTable.fields[fieldName]
+            const oldField = oldTable.fields[fieldName]
+
+            if (!oldField) continue
+
+            // Compare all properties except type
+            for (const prop in newField) {
+                if (prop === 'type') continue
+                
+                if (!(prop in oldField)) {
+                    changes.push({
+                        type: 'field_property_added',
+                        table: tableName,
+                        field: fieldName,
+                        property: prop,
+                        new: newField[prop]
+                    })
+                } else if (JSON.stringify(newField[prop]) !== JSON.stringify(oldField[prop])) {
+                    changes.push({
+                        type: 'field_property_changed',
+                        table: tableName,
+                        field: fieldName,
+                        property: prop,
+                        old: oldField[prop],
+                        new: newField[prop]
+                    })
+                }
+            }
+
+            // Check for removed properties
+            for (const prop in oldField) {
+                if (prop === 'type') continue
+                if (!(prop in newField)) {
+                    changes.push({
+                        type: 'field_property_removed',
+                        table: tableName,
+                        field: fieldName,
+                        property: prop,
+                        old: oldField[prop]
+                    })
+                }
+            }
+        }
+    }
+
+    return changes
+}
+
+
+// function verifyScehma(schema : any ) { 
+//     const valid = validateSchema(schema)
+//     if (!valid.valid) {
+//         return { valid: false, errors: valid.errors, message: "Schema is invalid" }
+//     }
+
+
+
+
+//     return { valid: true, errors: [] }
+// }
+
+
+function validateUpdateSchema(oldSchema: any, newSchema: any)  {
+    const oldValid = validateSchema(oldSchema)
+    const newValid = validateSchema(newSchema)
+
+    if (!oldValid.valid || !newValid.valid) {
+        return { valid: false, errors: oldValid.errors.concat(newValid.errors), message: "schemas are is invalid" }
+    }
+
+    
+    const changes = _getSchemaChanges(oldSchema, newSchema)
+
+    const changeErrors = []
+    for (const change of changes) {
+        if (change.type === 'property_changed' && change.property === 'project_id') {
+            changeErrors.push({ 
+                change: change,
+                message: "Cannot modify project_id property"
+            })
+        }
+
+        if (change.type === 'property_changed' && change.property === 'version') {
+            if (change.new !== change.old + 1) {
+                changeErrors.push({
+                    change: change,
+                    message: `Version must be incremented by 1. Expected version:${change.old + 1}, got version:${change.new}`
+                })
+            }
+        }
+
+        if (change.type === 'field_type_changed') {
+            changeErrors.push({
+                change: change,
+                message: `Cannot change type of field "${change.field}" from "${change.old}" to "${change.new}"`
+            })
+        }
+    }
+
+    if (changeErrors.length > 0) {
+        return {
+            valid: false,
+            errors: changeErrors,
+            message: "Invalid schema changes detected"
+        }
+    }
+
+    return { valid: true, changes: changes }
+}
+
+export {
+    validateSchema,
+    validateData,
+    generateEmptySchema,
+    validateUpdateSchema
+}
+
+const schema = {
+    validateSchema,
+    validateData,
+    generateEmptySchema,
+    validateUpdateSchema
 }
 
-export default hello
+export default schema

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@basictech/schema",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0",
   "description": "utils for Basic Schema",
   "main": "dist/index.js",
   "module": "dist/index.mjs",

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "@repo/typescript-config/base.json",
+    "compilerOptions": {
+      "outDir": "dist"
+    },
+    "include": ["index.ts"],
+    "exclude": ["node_modules", "dist"]
+}
+