@kinevolution/appwrite-functions-shared-utils 0.1.5 → 0.1.7

package/dist/appwrite.d.ts

@@ -0,0 +1,79 @@
+import type { Models } from 'appwrite';
+
+// This file is auto-generated by the Appwrite CLI.
+// You can regenerate it by running `appwrite types -l ts types`.
+
+export enum Role {
+  REQUESTER = 'requester',
+  COMPANION = 'companion',
+}
+
+export enum Activities {
+  CHAT = 'chat',
+  WALK = 'walk',
+  GAMES = 'games',
+  HOME_HELP = 'home_help',
+  READING = 'reading',
+  SHOPPING = 'shopping',
+}
+
+export enum Sex {
+  FEMALE = 'female',
+  MALE = 'male',
+  PREFER_NOT_SAY = 'prefer_not_say',
+  OTHER = 'other',
+}
+
+export type ProfilesRequester = Models.Row & {
+  phone: string;
+  contactByPhone: boolean;
+  approxLocationLabel: string;
+  homeLocation: string;
+  notesForCompanions: string | null;
+  emergencyContactName: string | null;
+  emergencyContactPhone: string | null;
+  user: Roles;
+};
+
+export type ProfilesCompanion = Models.Row & {
+  hasVehicle: boolean;
+  ratingCount: number;
+  ratingAvg: number;
+  user: Roles;
+};
+
+export type CompanionZones = Models.Row & {
+  label: string;
+  priority: number;
+  active: boolean;
+  notes: string | null;
+  zone: string | null;
+  profilesCompanion: ProfilesCompanion;
+  center: string | null;
+  radius: number | null;
+};
+
+export type Roles = Models.Row & {
+  userId: string;
+  role: Role;
+};
+
+export type ProfilesExtras = Models.Row & {
+  user: Roles;
+  bio: string | null;
+  photoIds: string[] | null;
+  activities: Activities[] | null;
+  locale: string | null;
+  timezone: string | null;
+  marketingOptIn: boolean;
+};
+
+export type ProfilesCore = Models.Row & {
+  pushTokens: string[] | null;
+  termsAcceptedAt: string;
+  birthDate: string;
+  firstName: string;
+  lastName: string;
+  sex: Sex;
+  user: Roles;
+};

package/dist/utils.d.ts

@@ -8,16 +8,41 @@ export interface Config {
  * @param req - The Appwrite function request object
  * @returns An object containing the validation result
  */
-export declare function validateInput(config: Config, req: any): ValidationResult;
+export declare function validateInput<T>(config: Config, req: any): ValidationResult<T>;
 type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
-interface FieldDefinition {
+type FieldDefinition = {
     key: string;
     type: 'string' | 'number' | 'boolean' | 'object' | 'array';
-    required: boolean;
-}
-interface ValidationResult {
+    required: true;
+} | {
+    key: string;
+    type: 'string';
+    required: false;
+    default: string;
+} | {
+    key: string;
+    type: 'number';
+    required: false;
+    default: number;
+} | {
+    key: string;
+    type: 'boolean';
+    required: false;
+    default: boolean;
+} | {
+    key: string;
+    type: 'object';
+    required: false;
+    default: Record<string, any>;
+} | {
+    key: string;
+    type: 'array';
+    required: false;
+    default: any[];
+};
+interface ValidationResult<T> {
     valid: boolean;
-    data?: any;
+    data?: T;
     error?: string;
 }
 export interface AppwriteContext {
@@ -26,4 +51,12 @@ export interface AppwriteContext {
     log: (message: string) => void;
     error: (message: string) => void;
 }
+type TsFromFieldType<T extends FieldDefinition['type']> = T extends 'string' ? string : T extends 'number' ? number : T extends 'boolean' ? boolean : T extends 'object' ? Record<string, unknown> : T extends 'array' ? unknown[] : unknown;
+export type FieldsToType<Fs extends readonly FieldDefinition[]> = {
+    [K in Fs[number] as K extends {
+        key: string;
+    } ? K['key'] : never]: TsFromFieldType<K extends {
+        type: FieldDefinition['type'];
+    } ? K['type'] : never>;
+};
 export {};

package/dist/utils.js

@@ -13,9 +13,7 @@ export function validateInput(config, req) {
         };
     }
     // 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 (config.method === 'POST' || config.method === 'PUT' || config.method === 'PATCH') {
         if (!req.bodyJson) {
             return {
                 valid: false,
@@ -73,8 +71,9 @@ function validateRequestBody(bodyJson, fields) {
             errors.push(`Field "${field.key}" is required`);
             continue;
         }
-        // If field is optional and absent, skip to next
+        // If field is optional and absent, use default value
         if (!field.required && (value === undefined || value === null)) {
+            validatedData[field.key] = field.default;
             continue;
         }
         // Check field type
@@ -90,8 +89,7 @@ function validateRequestBody(bodyJson, fields) {
                 isValidType = typeof value === 'boolean';
                 break;
             case 'object':
-                isValidType =
-                    typeof value === 'object' && !Array.isArray(value) && value !== null;
+                isValidType = typeof value === 'object' && !Array.isArray(value) && value !== null;
                 break;
             case 'array':
                 isValidType = Array.isArray(value);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "0.1.5",
+  "version": "0.1.7",
   "license": "ISC",
   "author": "Nicolas Forêt <nicolas4@gmail.com>",
   "description": "Shared utilities for Appwrite functions",
@@ -20,13 +20,13 @@
   ],
   "scripts": {
     "bat-update": "cd .. && shared-update.bat",
-    "build": "rmdir /S /Q dist && tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json && powershell -Command \"Copy-Item appwrite.d.ts dist/appwrite.d.ts\"",
     "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 && npm run bump-version && npm publish --access public && npm run bat-update",
-    "npm-update": "rmdir /S /Q node_modules && del package-lock.json && ncu -u && npm i"
+    "npm-update": "npx npkill && del package-lock.json && ncu -u && npm i"
   },
   "devDependencies": {
     "@types/node": "24.10.0",