@kinevolution/appwrite-functions-shared-utils 0.1.2

package/dist/utils.d.ts

@@ -0,0 +1,29 @@
+export interface Config {
+    method: Method;
+    fields: Array<FieldDefinition>;
+}
+/**
+ * Validates the input of an Appwrite function based on the provided configuration
+ * @param config - The configuration defining expected method and fields
+ * @param req - The Appwrite function request object
+ * @returns An object containing the validation result
+ */
+export declare function validateInput(config: Config, req: any): ValidationResult;
+type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+interface FieldDefinition {
+    key: string;
+    type: 'string' | 'number' | 'boolean' | 'object' | 'array';
+    required: boolean;
+}
+interface ValidationResult {
+    valid: boolean;
+    data?: any;
+    error?: string;
+}
+export interface AppwriteContext {
+    req: any;
+    res: any;
+    log: (message: string) => void;
+    error: (message: string) => void;
+}
+export {};

package/dist/utils.js

@@ -0,0 +1,117 @@
+/**
+ * Validates the input of an Appwrite function based on the provided configuration
+ * @param config - The configuration defining expected method and fields
+ * @param req - The Appwrite function request object
+ * @returns An object containing the validation result
+ */
+export function validateInput(config, req) {
+    // Check that the request method matches
+    if (req.method !== config.method) {
+        return {
+            valid: false,
+            error: `Invalid request method: expected ${config.method}, received ${req.method}`,
+        };
+    }
+    // Check that the body exists (if this is a POST, PATCH or PUT request)
+    if (config.method === 'POST' ||
+        config.method === 'PUT' ||
+        config.method === 'PATCH') {
+        if (!req.bodyJson) {
+            return {
+                valid: false,
+                error: 'No body provided in the request',
+            };
+        }
+        // Validate the request body
+        const validation = validateRequestBody(req.bodyJson, config.fields);
+        if (validation.valid) {
+            return {
+                valid: true,
+                data: validation.data,
+            };
+        }
+        else {
+            return {
+                valid: false,
+                error: `Validation error: ${validation.error}`,
+            };
+        }
+    }
+    return {
+        valid: true,
+    };
+}
+/**
+ * Validates and parses the JSON body of the request
+ * @param bodyJson - The already parsed JSON from req.bodyJson
+ * @param fields - The definitions of expected fields
+ * @returns An object containing the validation result
+ */
+function validateRequestBody(bodyJson, fields) {
+    // Check that bodyJson is an object
+    if (!bodyJson || typeof bodyJson !== 'object' || Array.isArray(bodyJson)) {
+        return {
+            valid: false,
+            error: 'Body must be a valid JSON object',
+        };
+    }
+    const validatedData = {};
+    const errors = [];
+    // Create a Set of allowed keys for fast lookup
+    const allowedKeys = new Set(fields.map((f) => f.key));
+    // Check for unauthorized fields
+    const bodyKeys = Object.keys(bodyJson);
+    const unexpectedKeys = bodyKeys.filter((key) => !allowedKeys.has(key));
+    if (unexpectedKeys.length > 0) {
+        errors.push(`Unauthorized fields detected: ${unexpectedKeys.join(', ')}`);
+    }
+    // Check each defined field
+    for (const field of fields) {
+        const value = bodyJson[field.key];
+        // Check if required field is present
+        if (field.required && (value === undefined || value === null)) {
+            errors.push(`Field "${field.key}" is required`);
+            continue;
+        }
+        // If field is optional and absent, skip to next
+        if (!field.required && (value === undefined || value === null)) {
+            continue;
+        }
+        // Check field type
+        let isValidType = false;
+        switch (field.type) {
+            case 'string':
+                isValidType = typeof value === 'string';
+                break;
+            case 'number':
+                isValidType = typeof value === 'number' && !isNaN(value);
+                break;
+            case 'boolean':
+                isValidType = typeof value === 'boolean';
+                break;
+            case 'object':
+                isValidType =
+                    typeof value === 'object' && !Array.isArray(value) && value !== null;
+                break;
+            case 'array':
+                isValidType = Array.isArray(value);
+                break;
+        }
+        if (!isValidType) {
+            errors.push(`Field "${field.key}" must be of type ${field.type}, received: ${typeof value}`);
+            continue;
+        }
+        validatedData[field.key] = value;
+    }
+    // If errors were found
+    if (errors.length > 0) {
+        return {
+            valid: false,
+            error: errors.join(', '),
+        };
+    }
+    return {
+        valid: true,
+        data: validatedData,
+    };
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@kinevolution/appwrite-functions-shared-utils",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.1.2",
+  "license": "ISC",
+  "author": "Nicolas Forêt <nicolas4@gmail.com>",
+  "description": "Shared utilities for Appwrite functions",
+  "type": "module",
+  "main": "dist/utils.js",
+  "module": "dist/utils.js",
+  "types": "dist/utils.d.ts",
+  "exports": {
+    ".": "./dist/utils.js",
+    "./utils": "./dist/utils.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "build-remove": "shx rm -rf dist/",
+    "bump-version": "npm run bump-version:patch",
+    "bump-version:major": "gulp bump-version --type=major",
+    "bump-version:minor": "gulp bump-version --type=minor",
+    "bump-version:patch": "gulp bump-version --type=patch",
+    "deploy": "npm run build-remove && npm run build && npm run bump-version && npm publish --access public"
+  },
+  "devDependencies": {
+    "@types/node": "^20.12.12",
+    "gulp": "4.0.2",
+    "gulp-replace": "1.1.4",
+    "minimist": "1.2.8",
+    "shx": "0.3.4",
+    "typescript": "^5.4.5"
+  }
+}