pocketbase-zod-schema 0.1.2

package/dist/mutator.d.cts

@@ -0,0 +1,190 @@
+import * as PocketBase from 'pocketbase';
+import { RecordModel, RecordService, ListResult, RecordSubscription, UnsubscribeFunc } from 'pocketbase';
+import { TypedPocketBase, UserType, UserInputType } from './types.cjs';
+import 'zod';
+import './user-jS1aYoeD.cjs';
+
+interface MutatorOptions {
+    expand: string[];
+    filter: string[];
+    sort: string[];
+}
+declare abstract class BaseMutator<T extends RecordModel, InputType> {
+    protected pb: TypedPocketBase;
+    protected options: MutatorOptions;
+    constructor(pb: TypedPocketBase, options?: Partial<MutatorOptions>);
+    private initializeOptions;
+    /**
+     * Initialize options with class-specific defaults
+     * Subclasses should override this instead of directly setting options
+     */
+    protected setDefaults(): MutatorOptions;
+    /**
+     * Merge provided options with current options
+     */
+    protected overrideOptions(newOptions: Partial<MutatorOptions>): void;
+    /**
+     * Get the collection instance
+     */
+    protected abstract getCollection(): RecordService<T>;
+    toSnakeCase(str: string): string;
+    /**
+     * Create a new entity
+     */
+    create(input: InputType): Promise<T>;
+    /**
+     * Update an existing entity
+     */
+    update(id: string, input: Partial<T>): Promise<T>;
+    /**
+     * Create or update entity (upsert)
+     */
+    upsert(input: InputType & {
+        id?: string;
+    }): Promise<T>;
+    /**
+     * Get entity by ID
+     */
+    getById(id: string, expand?: string | string[]): Promise<T | null>;
+    /**
+     * Get first entity by filter
+     */
+    getFirstByFilter(filter: string | string[], expand?: string | string[], sort?: string): Promise<T | null>;
+    /**
+     * Get list of entities
+     */
+    getList(page?: number, perPage?: number, filter?: string | string[], sort?: string, expand?: string | string[]): Promise<ListResult<T>>;
+    /**
+     * Delete entity by ID
+     */
+    delete(id: string): Promise<boolean>;
+    /**
+     * Process a single record before returning it
+     * Can be overridden to handle special cases like mapped entities
+     */
+    protected processRecord(record: T): Promise<T>;
+    /**
+     * Process a list result before returning it
+     * Can be overridden to handle special cases like mapped entities
+     */
+    protected processListResult(result: ListResult<T>): Promise<ListResult<T>>;
+    /**
+     * Prepare expand parameter
+     * Combines default expands with provided expands
+     */
+    protected prepareExpand(expand?: string | string[]): string | undefined;
+    /**
+     * Prepare filter parameter
+     * Combines default filters with provided filters
+     */
+    protected prepareFilter(filter?: string | string[]): string | undefined;
+    /**
+     * Prepare sort parameter
+     * Uses provided sort or falls back to default sort
+     */
+    protected prepareSort(sort?: string): string | undefined;
+    /**
+     * Perform the actual create operation
+     */
+    protected entityCreate(data: InputType): Promise<T>;
+    /**
+     * Perform the actual update operation
+     */
+    protected entityUpdate(id: string, data: Partial<T>): Promise<T>;
+    /**
+     * Perform the actual getById operation
+     */
+    protected entityGetById(id: string, expand?: string | string[]): Promise<T>;
+    /**
+     * Perform the actual getFirstByFilter operation
+     */
+    protected entityGetFirstByFilter(filter: string | string[], expand?: string | string[], sort?: string): Promise<T>;
+    /**
+     * Perform the actual getList operation
+     * Returns a list result with items of type T
+     */
+    protected entityGetList(page: number, perPage: number, filter?: string | string[], sort?: string, expand?: string | string[]): Promise<ListResult<T>>;
+    /**
+     * Perform the actual delete operation
+     */
+    protected entityDelete(id: string): Promise<boolean>;
+    /**
+     * Error handler for common errors
+     * @param error The error to handle
+     * @param options Handler options
+     * @returns The value to return if the error is handled, or throws if not handled
+     */
+    protected handleError<R>(error: any, options?: {
+        allowNotFound?: boolean;
+        returnValue?: R;
+        logError?: boolean;
+    }): R;
+    /**
+     * Check if an error is a "not found" error
+     */
+    protected isNotFoundError(error: any): boolean;
+    /**
+     * Standard error handling wrapper (legacy method, consider using handleError instead)
+     */
+    protected errorWrapper(error: any): never;
+    /**
+     * Validate input data before creating/updating
+     * Should be implemented by child classes
+     */
+    protected abstract validateInput(input: InputType): Promise<InputType>;
+    /**
+     * Subscribe to changes on a specific record
+     * @param id The ID of the record to subscribe to
+     * @param callback Function to call when changes occur
+     * @param expand Optional expand parameters
+     * @returns Promise that resolves to an unsubscribe function
+     */
+    subscribeToRecord(id: string, callback: (data: RecordSubscription<T>) => void, expand?: string | string[]): Promise<UnsubscribeFunc>;
+    /**
+     * Subscribe to changes on the entire collection
+     * @param callback Function to call when changes occur
+     * @param expand Optional expand parameters
+     * @returns Promise that resolves to an unsubscribe function
+     */
+    subscribeToCollection(callback: (data: RecordSubscription<T>) => void, expand?: string | string[]): Promise<UnsubscribeFunc>;
+    /**
+     * Unsubscribe from a specific record's changes
+     * @param id The ID of the record to unsubscribe from
+     */
+    unsubscribeFromRecord(id: string): void;
+    /**
+     * Unsubscribe from collection-wide changes
+     */
+    unsubscribeFromCollection(): void;
+    /**
+     * Unsubscribe from all subscriptions in this collection
+     */
+    unsubscribeAll(): void;
+}
+
+declare class UserMutator extends BaseMutator<UserType, UserInputType> {
+    protected setDefaults(): MutatorOptions;
+    protected getCollection(): PocketBase.RecordService<{
+        status: "draft" | "active" | "complete" | "fail";
+        User: string;
+        title: string;
+        content: string;
+        SubscriberUsers: string[];
+        imageFiles: string[];
+        id: string;
+        collectionId: string;
+        collectionName: string;
+        expand: Record<string, any>;
+        summary?: string | undefined;
+        thumbnailURL?: string | undefined;
+    }>;
+    protected validateInput(input: UserInputType): Promise<{
+        email: string;
+        password: string;
+        passwordConfirm: string;
+        name?: string | undefined;
+        avatar?: File | undefined;
+    }>;
+}
+
+export { UserMutator };

package/dist/mutator.d.ts

@@ -0,0 +1,190 @@
+import * as PocketBase from 'pocketbase';
+import { RecordModel, RecordService, ListResult, RecordSubscription, UnsubscribeFunc } from 'pocketbase';
+import { TypedPocketBase, UserType, UserInputType } from './types.js';
+import 'zod';
+import './user-jS1aYoeD.js';
+
+interface MutatorOptions {
+    expand: string[];
+    filter: string[];
+    sort: string[];
+}
+declare abstract class BaseMutator<T extends RecordModel, InputType> {
+    protected pb: TypedPocketBase;
+    protected options: MutatorOptions;
+    constructor(pb: TypedPocketBase, options?: Partial<MutatorOptions>);
+    private initializeOptions;
+    /**
+     * Initialize options with class-specific defaults
+     * Subclasses should override this instead of directly setting options
+     */
+    protected setDefaults(): MutatorOptions;
+    /**
+     * Merge provided options with current options
+     */
+    protected overrideOptions(newOptions: Partial<MutatorOptions>): void;
+    /**
+     * Get the collection instance
+     */
+    protected abstract getCollection(): RecordService<T>;
+    toSnakeCase(str: string): string;
+    /**
+     * Create a new entity
+     */
+    create(input: InputType): Promise<T>;
+    /**
+     * Update an existing entity
+     */
+    update(id: string, input: Partial<T>): Promise<T>;
+    /**
+     * Create or update entity (upsert)
+     */
+    upsert(input: InputType & {
+        id?: string;
+    }): Promise<T>;
+    /**
+     * Get entity by ID
+     */
+    getById(id: string, expand?: string | string[]): Promise<T | null>;
+    /**
+     * Get first entity by filter
+     */
+    getFirstByFilter(filter: string | string[], expand?: string | string[], sort?: string): Promise<T | null>;
+    /**
+     * Get list of entities
+     */
+    getList(page?: number, perPage?: number, filter?: string | string[], sort?: string, expand?: string | string[]): Promise<ListResult<T>>;
+    /**
+     * Delete entity by ID
+     */
+    delete(id: string): Promise<boolean>;
+    /**
+     * Process a single record before returning it
+     * Can be overridden to handle special cases like mapped entities
+     */
+    protected processRecord(record: T): Promise<T>;
+    /**
+     * Process a list result before returning it
+     * Can be overridden to handle special cases like mapped entities
+     */
+    protected processListResult(result: ListResult<T>): Promise<ListResult<T>>;
+    /**
+     * Prepare expand parameter
+     * Combines default expands with provided expands
+     */
+    protected prepareExpand(expand?: string | string[]): string | undefined;
+    /**
+     * Prepare filter parameter
+     * Combines default filters with provided filters
+     */
+    protected prepareFilter(filter?: string | string[]): string | undefined;
+    /**
+     * Prepare sort parameter
+     * Uses provided sort or falls back to default sort
+     */
+    protected prepareSort(sort?: string): string | undefined;
+    /**
+     * Perform the actual create operation
+     */
+    protected entityCreate(data: InputType): Promise<T>;
+    /**
+     * Perform the actual update operation
+     */
+    protected entityUpdate(id: string, data: Partial<T>): Promise<T>;
+    /**
+     * Perform the actual getById operation
+     */
+    protected entityGetById(id: string, expand?: string | string[]): Promise<T>;
+    /**
+     * Perform the actual getFirstByFilter operation
+     */
+    protected entityGetFirstByFilter(filter: string | string[], expand?: string | string[], sort?: string): Promise<T>;
+    /**
+     * Perform the actual getList operation
+     * Returns a list result with items of type T
+     */
+    protected entityGetList(page: number, perPage: number, filter?: string | string[], sort?: string, expand?: string | string[]): Promise<ListResult<T>>;
+    /**
+     * Perform the actual delete operation
+     */
+    protected entityDelete(id: string): Promise<boolean>;
+    /**
+     * Error handler for common errors
+     * @param error The error to handle
+     * @param options Handler options
+     * @returns The value to return if the error is handled, or throws if not handled
+     */
+    protected handleError<R>(error: any, options?: {
+        allowNotFound?: boolean;
+        returnValue?: R;
+        logError?: boolean;
+    }): R;
+    /**
+     * Check if an error is a "not found" error
+     */
+    protected isNotFoundError(error: any): boolean;
+    /**
+     * Standard error handling wrapper (legacy method, consider using handleError instead)
+     */
+    protected errorWrapper(error: any): never;
+    /**
+     * Validate input data before creating/updating
+     * Should be implemented by child classes
+     */
+    protected abstract validateInput(input: InputType): Promise<InputType>;
+    /**
+     * Subscribe to changes on a specific record
+     * @param id The ID of the record to subscribe to
+     * @param callback Function to call when changes occur
+     * @param expand Optional expand parameters
+     * @returns Promise that resolves to an unsubscribe function
+     */
+    subscribeToRecord(id: string, callback: (data: RecordSubscription<T>) => void, expand?: string | string[]): Promise<UnsubscribeFunc>;
+    /**
+     * Subscribe to changes on the entire collection
+     * @param callback Function to call when changes occur
+     * @param expand Optional expand parameters
+     * @returns Promise that resolves to an unsubscribe function
+     */
+    subscribeToCollection(callback: (data: RecordSubscription<T>) => void, expand?: string | string[]): Promise<UnsubscribeFunc>;
+    /**
+     * Unsubscribe from a specific record's changes
+     * @param id The ID of the record to unsubscribe from
+     */
+    unsubscribeFromRecord(id: string): void;
+    /**
+     * Unsubscribe from collection-wide changes
+     */
+    unsubscribeFromCollection(): void;
+    /**
+     * Unsubscribe from all subscriptions in this collection
+     */
+    unsubscribeAll(): void;
+}
+
+declare class UserMutator extends BaseMutator<UserType, UserInputType> {
+    protected setDefaults(): MutatorOptions;
+    protected getCollection(): PocketBase.RecordService<{
+        status: "draft" | "active" | "complete" | "fail";
+        User: string;
+        title: string;
+        content: string;
+        SubscriberUsers: string[];
+        imageFiles: string[];
+        id: string;
+        collectionId: string;
+        collectionName: string;
+        expand: Record<string, any>;
+        summary?: string | undefined;
+        thumbnailURL?: string | undefined;
+    }>;
+    protected validateInput(input: UserInputType): Promise<{
+        email: string;
+        password: string;
+        passwordConfirm: string;
+        name?: string | undefined;
+        avatar?: File | undefined;
+    }>;
+}
+
+export { UserMutator };