proto.io 0.0.173 → 0.0.174

package/dist/internals/{index-lX-M76Tn.d.ts → index-CE5tdYK8.d.ts}

@@ -44,33 +44,100 @@ declare class TUser extends TObject {
     constructor(attributes?: Record<string, TValue> | ((self: TObject) => Record<string, TValue>));
 }
 
+/**
+ * Class representing a Role.
+ * @extends TObject
+ */
 declare class TRole extends TObject {
     constructor(attributes?: Record<string, TValue> | ((self: TObject) => Record<string, TValue>));
+    /**
+     * Get the name of the role.
+     * @return {string | undefined} The name of the role.
+     */
     get name(): string | undefined;
+    /**
+     * Get the users associated with the role.
+     * @return {TUser[]} The users associated with the role.
+     */
     get users(): TUser[];
+    /**
+     * Set the users associated with the role.
+     * @param {TUser[]} value - The users to associate with the role.
+     */
     set users(value: TUser[]);
+    /**
+     * Get the roles associated with the role.
+     * @return {TRole[]} The roles associated with the role.
+     */
     get roles(): TRole[];
+    /**
+     * Set the roles associated with the role.
+     * @param {TRole[]} value - The roles to associate with the role.
+     */
     set roles(value: TRole[]);
 }
 
+/**
+ * Represents a stream of data that can be read.
+ * It can be either a ReadableStream or a Readable.
+ */
 type FileStream = ReadableStream | Readable;
+/**
+ * Represents the data of a file.
+ * It can be a string, Blob, BinaryData, FileStream, or an object containing a base64 string.
+ */
 type FileData = string | Blob | BinaryData | FileStream | {
     base64: string;
 };
 
+/**
+ * Interface representing a file.
+ */
 interface TFile {
+    /**
+     * URL of the file.
+     */
     url: string | undefined;
+    /**
+     * Retrieves the file data.
+     * @param options - Optional extra options.
+     * @returns A FileStream containing the file data.
+     */
     fileData(options?: ExtraOptions<boolean>): FileStream;
+    /**
+     * Saves the file.
+     * @param options - Optional extra options including cascadeSave and uploadToken.
+     * @returns A promise that resolves to the current instance.
+     */
     save(options?: ExtraOptions<boolean> & {
         cascadeSave?: boolean;
         uploadToken?: string;
     }): PromiseLike<this>;
 }
+/**
+ * Class representing a file.
+ */
 declare class TFile extends TObject {
     constructor(attributes?: Record<string, TValue> | ((self: TObject) => Record<string, TValue>));
+    /**
+     * Gets the filename of the file.
+     * @returns The filename.
+     */
     get filename(): string | undefined;
+    /**
+     * Gets the size of the file.
+     * @returns The size of the file.
+     */
     get size(): number | undefined;
+    /**
+     * Gets the type of the file.
+     * @returns The type of the file.
+     */
     get type(): string | undefined;
+    /**
+     * Gets the token of the file.
+     * @returns The token of the file.
+     */
     get token(): string | undefined;
 }
 
@@ -170,105 +237,465 @@ type TQuerySelector = (TCoditionalQuerySelector & {
     [x: string]: TFieldQuerySelector;
 };
 
+/**
+ * Options for a query filter.
+ */
 interface TQueryFilterBaseOptions {
+    /**
+     * The filter(s) to apply to the query.
+     */
     filter?: TQuerySelector | TQuerySelector[];
 }
+/**
+ * Sort option for a query.
+ */
 type TSortOption = {
+    /**
+     * The expression to sort by.
+     */
     expr: TExpression;
+    /**
+     * The order of sorting, 1 for ascending and -1 for descending.
+     */
     order: 1 | -1;
 };
+/**
+ * Base options for a query.
+ */
 interface TQueryBaseOptions extends TQueryFilterBaseOptions {
+    /**
+     * The sorting options for the query.
+     */
     sort?: Record<string, 1 | -1> | TSortOption[];
+    /**
+     * The number of results to skip.
+     */
     skip?: number;
+    /**
+     * The limit on the number of results.
+     */
     limit?: number;
+    /**
+     * Nested query options for matching specific fields.
+     */
     matches?: Record<string, TQueryBaseOptions>;
 }
+/**
+ * Base class for query filters.
+ */
 declare class TQueryFilterBase {
+    /**
+     * Applies a filter to the query.
+     * @param filter - The filter to apply.
+     * @returns The current instance for chaining.
+     */
     filter(filter: TQuerySelector): this;
+    /**
+     * Applies an equality filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     equalTo<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a not equal filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     notEqualTo<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a less than filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     lessThan<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a greater than filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     greaterThan<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a less than or equal to filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     lessThanOrEqualTo<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a greater than or equal to filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     greaterThanOrEqualTo<T extends string>(key: PathName<T>, value: TValue | undefined): this;
+    /**
+     * Applies a pattern filter to the query.
+     * @param key - The key to filter.
+     * @param value - The pattern to filter.
+     * @returns The current instance for chaining.
+     */
     pattern<T extends string>(key: PathName<T>, value: RegExp | string): this;
+    /**
+     * Applies a starts with filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     startsWith<T extends string>(key: PathName<T>, value: string): this;
+    /**
+     * Applies an ends with filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     endsWith<T extends string>(key: PathName<T>, value: string): this;
+    /**
+     * Applies a size filter to the query.
+     * @param key - The key to filter.
+     * @param value - The value to filter.
+     * @returns The current instance for chaining.
+     */
     size<T extends string>(key: PathName<T>, value: number): this;
+    /**
+     * Applies an empty filter to the query.
+     * @param key - The key to filter.
+     * @returns The current instance for chaining.
+     */
     empty<T extends string>(key: PathName<T>): this;
+    /**
+     * Applies a not empty filter to the query.
+     * @param key - The key to filter.
+     * @returns The current instance for chaining.
+     */
     notEmpty<T extends string>(key: PathName<T>): this;
+    /**
+     * Filters the query to include only documents where the specified key contains any of the specified values.
+     * @param key - The key to check for values.
+     * @param value - The array of values to check for.
+     * @returns The current instance for chaining.
+     */
     containsIn<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to exclude documents where the specified key contains any of the specified values.
+     * @param key - The key to check for values.
+     * @param value - The array of values to exclude.
+     * @returns The current instance for chaining.
+     */
     notContainsIn<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to include only documents where the specified key is a subset of the specified values.
+     * @param key - The key to check for subset.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isSubset<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to include only documents where the specified key is a superset of the specified values.
+     * @param key - The key to check for superset.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isSuperset<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to include only documents where the specified key is disjoint from the specified values.
+     * @param key - The key to check for disjoint.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isDisjoint<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to include only documents where the specified key intersects with the specified values.
+     * @param key - The key to check for intersection.
+     * @param value - The array of values to check against.
+     * @returns The current instance for chaining.
+     */
     isIntersect<T extends string>(key: PathName<T>, value: TValue[]): this;
+    /**
+     * Filters the query to include only documents where every element of the specified key matches the provided callback query.
+     * @param key - The key to check for every element.
+     * @param callback - The callback query to apply to each element.
+     * @returns The current instance for chaining.
+     */
     every<T extends string>(key: PathName<T>, callback: (query: TQueryFilterBase) => void): this;
+    /**
+     * Filters the query to include only documents where some elements of the specified key match the provided callback query.
+     * @param key - The key to check for some elements.
+     * @param callback - The callback query to apply to each element.
+     * @returns The current instance for chaining.
+     */
     some<T extends string>(key: PathName<T>, callback: (query: TQueryFilterBase) => void): this;
+    /**
+     * Filters the query to include only documents that match all of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     and(...callbacks: _.Many<(query: TQueryFilterBase) => void>[]): this;
+    /**
+     * Filters the query to include only documents that match any of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     or(...callbacks: _.Many<(query: TQueryFilterBase) => void>[]): this;
+    /**
+     * Filters the query to include only documents that do not match any of the provided callback queries.
+     * @param callbacks - The callback queries to apply.
+     * @returns The current instance for chaining.
+     */
     nor(...callbacks: _.Many<(query: TQueryFilterBase) => void>[]): this;
 }
 declare class TQueryBase extends TQueryFilterBase {
+    /**
+     * Sorts the query results.
+     * @param sort - The sorting criteria.
+     * @returns The current instance for chaining.
+     */
     sort<T extends Record<string, 1 | -1>>(sort: PathNameMap<T> | TSortOption[]): this;
+    /**
+     * Skips the specified number of results.
+     * @param skip - The number of results to skip.
+     * @returns The current instance for chaining.
+     */
     skip(skip: number): this;
+    /**
+     * Limits the number of results.
+     * @param limit - The maximum number of results to return.
+     * @returns The current instance for chaining.
+     */
     limit(limit: number): this;
+    /**
+     * Performs a nested query on a specific key.
+     * @param key - The key to match.
+     * @param callback - The callback function to execute.
+     * @returns The current instance for chaining.
+     */
     match<T extends string>(key: PathName<T>, callback: (query: TQueryBase) => void): this;
 }
 
+/**
+ * Options for a query.
+ */
 interface TQueryOptions extends TQueryBaseOptions {
+    /**
+     * Fields to include in the query.
+     */
     includes?: string[];
 }
+/**
+ * Options for a random query.
+ */
 interface TQueryRandomOptions {
+    /**
+     * Field to use for weighting the random selection.
+     */
     weight?: string;
 }
+/**
+ * Abstract base class for queries.
+ */
 declare abstract class TQuery<T extends string, Ext, M extends boolean> extends TQueryBase {
+    /**
+     * Clones the query with optional new options.
+     * @param options - The new options for the query.
+     * @returns A new query instance.
+     */
     abstract clone(options?: TQueryOptions): TQuery<T, Ext, M>;
+    /**
+     * Explains the query execution plan.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the explanation.
+     */
     abstract explain(options?: ExtraOptions<M>): PromiseLike<any>;
+    /**
+     * Counts the number of results for the query.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the count.
+     */
     abstract count(options?: ExtraOptions<M>): PromiseLike<number>;
+    /**
+     * Finds the results for the query.
+     * @param options - Extra options for the query.
+     * @returns A stream of the results.
+     */
     abstract find(options?: ExtraOptions<M>): ReturnType<typeof asyncStream<TObjectType<T, Ext>>>;
+    /**
+     * Selects a random result for the query.
+     * @param opts - Options for the random selection.
+     * @param options - Extra options for the query.
+     * @returns A stream of the random result.
+     */
     abstract random(opts?: TQueryRandomOptions, options?: ExtraOptions<M>): ReturnType<typeof asyncStream<TObjectType<T, Ext>>>;
+    /**
+     * Finds non-reference results for the query.
+     * @param options - Extra options for the query.
+     * @returns A stream of the non-reference results.
+     */
     abstract nonrefs(options?: ExtraOptions<M>): ReturnType<typeof asyncStream<TObjectType<T, Ext>>>;
+    /**
+     * Inserts a new record.
+     * @param attrs - The attributes of the new record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the inserted record.
+     */
     abstract insert(attrs: Record<string, TValue>, options?: ExtraOptions<M>): PromiseLike<TObjectType<T, Ext>>;
+    /**
+     * Inserts multiple new records.
+     * @param values - The attributes of the new records.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the number of inserted records.
+     */
     abstract insertMany(values: Record<string, TValue>[], options?: ExtraOptions<M>): PromiseLike<number>;
+    /**
+     * Updates a single record.
+     * @param update - The update operations.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the updated record or undefined.
+     */
     abstract updateOne(update: Record<string, TUpdateOp>, options?: ExtraOptions<M>): PromiseLike<TObjectType<T, Ext> | undefined>;
+    /**
+     * Updates multiple records.
+     * @param update - The update operations.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the number of updated records.
+     */
     abstract updateMany(update: Record<string, TUpdateOp>, options?: ExtraOptions<M>): PromiseLike<number>;
+    /**
+     * Upserts a single record.
+     * @param update - The update operations.
+     * @param setOnInsert - The attributes to set on insert.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the upserted record.
+     */
     abstract upsertOne(update: Record<string, TUpdateOp>, setOnInsert: Record<string, TValue>, options?: ExtraOptions<M>): PromiseLike<TObjectType<T, Ext>>;
+    /**
+     * Upserts multiple records.
+     * @param update - The update operations.
+     * @param setOnInsert - The attributes to set on insert.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the number of upserted records.
+     */
     abstract upsertMany(update: Record<string, TUpdateOp>, setOnInsert: Record<string, TValue>, options?: ExtraOptions<M>): PromiseLike<{
         updated: number;
         inserted: number;
     }>;
+    /**
+     * Deletes a single record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the deleted record or undefined.
+     */
     abstract deleteOne(options?: ExtraOptions<M>): PromiseLike<TObjectType<T, Ext> | undefined>;
+    /**
+     * Deletes multiple records.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the number of deleted records.
+     */
     abstract deleteMany(options?: ExtraOptions<M>): PromiseLike<number>;
+    /**
+     * Adds fields to include in the query.
+     * @param includes - The fields to include.
+     * @returns The query instance.
+     */
     includes<T extends string[]>(...includes: IncludePaths<T>): this;
+    /**
+     * Gets a record by its ID.
+     * @param id - The ID of the record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the record or undefined.
+     */
     get(id: string, options?: ExtraOptions<M>): Promise<TObjectType<T, Ext> | undefined>;
+    /**
+     * Gets the first record.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the first record or undefined.
+     */
     first(options?: ExtraOptions<M>): Promise<TObjectType<T, Ext> | undefined>;
+    /**
+     * Gets a random record.
+     * @param opts - Options for the random selection.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to the random record or undefined.
+     */
     randomOne(opts?: TQueryRandomOptions, options?: ExtraOptions<M>): Promise<TObjectType<T, Ext> | undefined>;
+    /**
+     * Checks if any records exist.
+     * @param options - Extra options for the query.
+     * @returns A promise that resolves to a boolean indicating if any records exist.
+     */
     exists(options?: ExtraOptions<M>): Promise<boolean>;
+    /**
+     * Iterates over each batch of records.
+     * @param callback - The callback to execute for each batch.
+     * @param options - Extra options for the query.
+     */
     eachBatch(callback: (batch: TObjectType<T, Ext>[]) => Awaitable<void>, options?: ExtraOptions<M> & {
         batchSize?: number;
     }): Promise<void>;
+    /**
+     * Iterates over each record.
+     * @param callback - The callback to execute for each record.
+     * @param options - Extra options for the query.
+     */
     each(callback: (object: TObjectType<T, Ext>) => Awaitable<void>, options?: ExtraOptions<M> & {
         batchSize?: number;
     }): Promise<void>;
 }
 
+/**
+ * A callback function type.
+ * @param request - The request object.
+ * @returns An awaitable response.
+ */
 type Callback<T, R, E> = (request: ProtoService<E> & T) => Awaitable<R>;
+/**
+ * A callback function type.
+ * @param request - The request object.
+ * @returns An awaitable response.
+ */
 type ProtoFunction<E> = Callback<{
     params: TSerializable;
 }, void | TSerializable, E>;
+/**
+ * A trigger type for proto services.
+ */
 type ProtoTrigger<T, E> = Callback<{
     object: TObjectType<T, E>;
     context: TSerializable;
 }, void, E>;
+/**
+ * Validator options for proto functions.
+ */
 type Validator = {
+    /**
+     * Indicates if a user is required.
+     */
     requireUser?: boolean;
+    /**
+     * Indicates if a master user is required.
+     */
     requireMaster?: boolean;
+    /**
+     * Indicates if any user roles are required.
+     */
     requireAnyUserRoles?: string[];
+    /**
+     * Indicates if all user roles are required.
+     */
     requireAllUserRoles?: string[];
 };
+/**
+ * Options for configuring a proto function.
+ */
 type ProtoFunctionOptions<E> = {
+    /**
+     * The callback function for the proto function.
+     */
     callback: ProtoFunction<E>;
+    /**
+     * Optional validator for the proto function.
+     */
     validator?: Validator;
 };
 
@@ -278,135 +705,529 @@ type Session = jwt.JwtPayload & {
     loginedAt: Date;
 };
 
+/**
+ * The mode of the transaction.
+ */
 type TransactionMode = 'default' | 'committed' | 'repeatable' | 'serializable';
+/**
+ * Options for configuring a transaction.
+ */
 type TransactionOptions = {
+    /**
+     * The mode of the transaction.
+     */
     mode?: TransactionMode;
+    /**
+     * The number of retries or a boolean indicating whether to retry.
+     */
     retry?: number | boolean;
 };
+/**
+ * Represents event data with additional metadata.
+ */
 type EventData = Record<string, _TValue> & {
+    /**
+     * The unique identifier for the event.
+     */
     _id: string;
+    /**
+     * The creation date of the event.
+     */
     _created_at: Date;
+    /**
+     * The read permissions for the event.
+     */
     _rperm: string[];
 };
 declare abstract class ProtoType<Ext> {
+    /**
+     * Retrieves the configuration.
+     * @param options - Optional settings for retrieving the configuration.
+     * @returns A promise that resolves to the configuration.
+     */
     abstract config(options?: {
         master?: boolean;
     }): Promise<Record<string, _TValue>>;
+    /**
+     * Retrieves the ACL of configuration.
+     * @param options - Settings for retrieving the ACL of configuration.
+     * @returns A promise that resolves to the ACL of configuration.
+     */
     abstract configAcl(options: {
         master: true;
     }): PromiseLike<Record<string, string[]>>;
+    /**
+     * Sets the configuration.
+     * @param values - The configuration values to set.
+     * @param options - Settings for setting the configuration.
+     * @returns A promise that resolves when the configuration is set.
+     */
     abstract setConfig(values: Record<string, _TValue>, options: {
         master: true;
         acl?: string[];
     }): Promise<void>;
+    /**
+     * Runs a function.
+     * @param name - The name of the function to run.
+     * @param data - The data to pass to the function.
+     * @param options - Additional options for running the function.
+     * @returns A promise that resolves to the result of the function.
+     */
     abstract run(name: string, data?: TSerializable, options?: ExtraOptions<boolean>): Promise<void | TSerializable>;
+    /**
+     * Creates a query.
+     * @param className - The name of the class to query.
+     * @returns A query instance.
+     */
     abstract Query<T extends string>(className: T): TQuery<T, Ext, boolean>;
+    /**
+     * Creates a relation query.
+     * @param object - The object to create the relation for.
+     * @param key - The key of the relation.
+     * @returns A relation query instance.
+     */
     abstract Relation<T extends string>(object: TObject, key: PathName<T>): TQuery<string, Ext, boolean>;
+    /**
+     * Get all references to an object.
+     * @param object - The object to get references for.
+     * @param options - Additional options for getting references.
+     * @returns A stream of references.
+     */
     abstract refs(object: TObject, options?: ExtraOptions<boolean>): ReturnType<typeof asyncStream<TObjectType<string, Ext>>>;
+    /**
+     * Checks if the server is online.
+     * @returns A promise that resolves to a boolean indicating if the server is online.
+     */
     online(): Promise<boolean>;
+    /**
+     * Rebinds an object to the proto instance.
+     * @param object - The object to rebind.
+     * @returns The rebinded object.
+     */
     rebind<T extends TSerializable | undefined>(object: T): T;
+    /**
+     * Creates a new object.
+     * @param className - The name of the class to create.
+     * @param objectId - The ID of the object to create.
+     * @returns The created object.
+     */
     Object<T extends string>(className: T, objectId?: string): TObjectType<T, Ext>;
+    /**
+     * Creates a new file object.
+     * @param filename - The name of the file.
+     * @param data - The file data.
+     * @param type - The type of the file.
+     * @returns The created file object.
+     */
     File(filename: string, data: FileData, type?: string): TObjectType<"File", Ext>;
+    /**
+     * Notifies an event.
+     * @param data - The data to notify.
+     * @param options - Additional options for notifying the event.
+     */
     abstract notify(data: Record<string, _TValue> & {
         _rperm?: string[];
     }, options?: ExtraOptions<boolean>): Promise<void>;
+    /**
+     * Listens for events.
+     * @param callback - The callback to call when an event occurs.
+     * @returns An object with a remove function to stop listening.
+     */
     abstract listen(callback: (data: EventData) => void): {
         remove: VoidFunction;
         socket?: Socket;
     };
 }
 interface ProtoType<Ext> {
+    /**
+     * Connects a request with optional attributes.
+     * @param req - The request to connect.
+     * @param attrs - Optional attributes or a function returning attributes.
+     * @returns The instance with the request and attributes.
+     */
     connect<R extends Request, T extends object>(req: R, attrs?: T | ((x: this & {
         req: R;
     }) => T)): this & {
         req: R;
     } & T;
+    /**
+     * Connects using a session token with optional attributes.
+     * @param token - The session token.
+     * @param attrs - Optional attributes or a function returning attributes.
+     * @returns A promise resolving to the instance with the session and attributes.
+     */
     connectWithSessionToken<T extends object>(token: string, attrs?: T | ((x: this & {
         session?: Session;
     }) => T)): Promise<this & {
         session?: Session;
     } & T>;
+    /**
+     * Sets the session token.
+     * @param token - The session token.
+     */
     setSessionToken(token?: string): void;
+    /**
+     * Retrieves the roles of a user.
+     * @param user - The user whose roles are to be retrieved.
+     * @returns A promise resolving to an array of roles.
+     */
     userRoles(user: TUser): Promise<TRole[]>;
+    /**
+     * Becomes a specified user.
+     * @param req - The request.
+     * @param user - The user to become.
+     * @param options - Optional cookie and JWT sign options.
+     * @returns A promise resolving to void.
+     */
     becomeUser(req: Request, user: TUser, options?: {
         cookieOptions?: CookieOptions | undefined;
         jwtSignOptions?: SignOptions | undefined;
     }): Promise<void>;
+    /**
+     * Logs out a user.
+     * @param req - The request.
+     * @param options - Optional cookie and JWT sign options.
+     * @returns A promise resolving to void.
+     */
     logoutUser(req: Request, options?: {
         cookieOptions?: CookieOptions | undefined;
         jwtSignOptions?: SignOptions | undefined;
     }): Promise<void>;
+    /**
+     * Verifies a user's password.
+     * @param user - The user whose password is to be verified.
+     * @param password - The password to verify.
+     * @param options - Extra options.
+     * @returns A promise resolving to a boolean indicating if the password is correct.
+     */
     varifyPassword(user: TUser, password: string, options: ExtraOptions<true>): Promise<boolean>;
+    /**
+     * Sets a user's password.
+     * @param user - The user whose password is to be set.
+     * @param password - The new password.
+     * @param options - Extra options.
+     * @returns A promise resolving to void.
+     */
     setPassword(user: TUser, password: string, options: ExtraOptions<true>): Promise<void>;
+    /**
+     * Unsets a user's password.
+     * @param user - The user whose password is to be unset.
+     * @param options - Extra options.
+     * @returns A promise resolving to void.
+     */
     unsetPassword(user: TUser, options: ExtraOptions<true>): Promise<void>;
+    /**
+     * Defines a new function.
+     * @param name - The name of the function.
+     * @param callback - The function callback.
+     * @param options - Optional function options excluding the callback.
+     */
     define(name: string, callback: ProtoFunction<Ext>, options?: Omit<ProtoFunctionOptions<Ext>, 'callback'>): void;
+    /**
+     * Registers a before-save trigger.
+     * @param name - The name of the trigger.
+     * @param callback - The trigger callback.
+     */
     beforeSave<T extends string>(name: T, callback: ProtoTrigger<T, Ext>): void;
+    /**
+     * Registers an after-save trigger.
+     * @param name - The name of the trigger.
+     * @param callback - The trigger callback.
+     */
     afterSave<T extends string>(name: T, callback: ProtoTrigger<T, Ext>): void;
+    /**
+     * Registers a before-delete trigger.
+     * @param name - The name of the trigger.
+     * @param callback - The trigger callback.
+     */
     beforeDelete<T extends string>(name: T, callback: ProtoTrigger<T, Ext>): void;
+    /**
+     * Registers a after-delete trigger.
+     * @param name - The name of the trigger.
+     * @param callback - The trigger callback.
+     */
     afterDelete<T extends string>(name: T, callback: ProtoTrigger<T, Ext>): void;
+    /**
+     * Locks a table for updates.
+     * @param className - The name of the class or an array of class names.
+     * @param update - Whether to lock for update.
+     */
     lockTable(className: string | string[], update: boolean): void;
+    /**
+     * Executes a callback within a transaction.
+     * @param callback - The callback to execute.
+     * @param options - Optional transaction options.
+     */
     withTransaction<T>(callback: (connection: ProtoType<Ext>) => PromiseLike<T>, options?: TransactionOptions): void;
+    /**
+     * Generates an upload token.
+     * @param options - Optional settings for the upload token.
+     * @returns The generated upload token.
+     */
     generateUploadToken(options?: {
         maxUploadSize?: number;
     }): string;
+    /**
+     * Signs a JWT.
+     * @param payload - The payload to sign.
+     * @param options - Options for signing the JWT.
+     * @returns The signed JWT.
+     */
     jwtSign(payload: any, options: jwt.SignOptions): string;
+    /**
+     * Verifies a JWT.
+     * @param token - The token to verify.
+     * @param options - Options for verifying the JWT.
+     * @returns The decoded JWT payload or undefined if verification fails.
+     */
     jwtVarify(token: string, options?: jwt.VerifyOptions): jwt.JwtPayload | undefined;
 }
 
+/**
+ * Represents the types of triggers that can be used.
+ * - 'beforeSave': Triggered before saving.
+ * - 'afterSave': Triggered after saving.
+ * - 'beforeDelete': Triggered before deleting.
+ * - 'afterDelete': Triggered after deleting.
+ */
 type TriggerType = 'beforeSave' | 'afterSave' | 'beforeDelete' | 'afterDelete';
+/**
+ * Represents additional options that can be passed to certain methods.
+ */
 type ExtraOptions<M extends boolean> = {
+    /**
+     * Indicates whether the master option is enabled.
+     */
     master?: M;
+    /**
+     * The context object to be used.
+     */
     context?: TSerializable;
+    /**
+     * Specifies the trigger type(s) to be silenced.
+     */
     silent?: TriggerType | TriggerType[];
+    /**
+     * The session associated with the operation.
+     */
     session?: ProtoType<any>;
+    /**
+     * An AbortSignal object that can be used to abort the operation.
+     */
     abortSignal?: AbortSignal;
 };
 
+/**
+ * Interface representing a object.
+ */
 interface TObject {
+    /**
+     * Clones the object.
+     * @returns A clone of the object.
+     */
     clone(): TObject;
+    /**
+     * Gets a relation query for the specified key.
+     * @param key - The key of the relation.
+     * @returns A query object for the relation.
+     */
     relation<T extends string>(key: PathName<T>): TQuery<string, any, boolean>;
+    /**
+     * Fetches the object with the specified keys included.
+     * @param keys - The keys to include.
+     * @param options - Additional options for the fetch operation.
+     * @returns A promise that resolves to the fetched object.
+     */
     fetchWithInclude(keys: string[], options?: ExtraOptions<boolean>): PromiseLike<this>;
+    /**
+     * Saves the object.
+     * @param options - Additional options for the save operation.
+     * @returns A promise that resolves to the saved object.
+     */
     save(options?: ExtraOptions<boolean> & {
         cascadeSave?: boolean;
     }): PromiseLike<this>;
+    /**
+     * Destroys the object.
+     * @param options - Additional options for the destroy operation.
+     * @returns A promise that resolves to the destroyed object.
+     */
     destroy(options?: ExtraOptions<boolean>): PromiseLike<this>;
 }
+/**
+ * Class representing a object.
+ */
 declare class TObject {
     static defaultReadonlyKeys: string[];
     static defaultKeys: string[];
     constructor(className: string, attributes?: Record<string, TValue> | ((self: TObject) => Record<string, TValue>));
+    /**
+     * Gets the class name of the object.
+     */
     get className(): string;
+    /**
+     * Gets the attributes of the object.
+     */
     get attributes(): Record<string, TValue>;
+    /**
+     * Gets the object ID.
+     */
     get objectId(): string | undefined;
+    /**
+     * Gets the creation date of the object.
+     */
     get createdAt(): Date | undefined;
+    /**
+     * Gets the last updated date of the object.
+     */
     get updatedAt(): Date | undefined;
+    /**
+     * Gets the version number of the object.
+     */
     get __v(): number;
+    /**
+     * Gets the sequence number of the object.
+     */
     get __i(): number;
+    /**
+     * Gets the expiration date of the object.
+     */
     get expiredAt(): Date | undefined;
+    /**
+     * Sets the expiration date of the object.
+     * @param value - The expiration date.
+     */
     set expiredAt(value: Date | undefined);
+    /**
+     * Gets the access control list (ACL) of the object.
+     * @returns The ACL of the object.
+     */
     acl(): TSchema.ACLs;
+    /**
+     * Sets the access control list (ACL) of the object.
+     * @param value - The ACL to set.
+     */
     setAcl(value: Partial<TSchema.ACLs>): void;
+    /**
+     * Sets the read access control list (ACL) of the object.
+     * @param value - The read ACL to set.
+     */
     setReadAcl(value: TSchema.ACL): void;
+    /**
+     * Sets the write access control list (ACL) of the object.
+     * @param value - The write ACL to set.
+     */
     setWriteAcl(value: TSchema.ACL): void;
+    /**
+     * Gets the keys of the object's attributes and mutated attributes.
+     * @returns An array of keys.
+     */
     keys(): string[];
+    /**
+     * Gets an iterator for the entries of the object's attributes.
+     * @returns An iterator for the entries.
+     */
     entries(): Generator<[string, any], void, unknown>;
+    /**
+     * Converts the object to a plain object.
+     * @returns The plain object representation of the object.
+     */
     toObject(): _.Dictionary<_TValue>;
     private _value;
+    /**
+     * Get the value of the attribute.
+     * @param key - The key of the attribute.
+     * @returns The value of the attribute.
+     */
     get<T extends string>(key: PathName<T>): any;
+    /**
+     * Set the value of the attribute.
+     * @param key - The key of the attribute.
+     * @param value - The value to set.
+     */
     set<T extends string>(key: PathName<T>, value: TValue | undefined): void;
+    /**
+     * Is the object dirty.
+     */
     get isDirty(): boolean;
+    /**
+     * Increment the value of the attribute.
+     * @param key - The key to increment.
+     * @param value - The value to increment by.
+     */
     increment<T extends string>(key: PathName<T>, value: number): void;
+    /**
+     * Decrement the value of the attribute.
+     * @param key - The key to decrement.
+     * @param value - The value to decrement by.
+     */
     decrement<T extends string>(key: PathName<T>, value: number): void;
+    /**
+     * Multiplies the value of the specified attribute.
+     * @param key - The key of the attribute to multiply.
+     * @param value - The multiplier value.
+     */
     multiply<T extends string>(key: PathName<T>, value: number): void;
+    /**
+     * Divides the value of the specified attribute.
+     * @param key - The key of the attribute to divide.
+     * @param value - The divisor value.
+     */
     divide<T extends string>(key: PathName<T>, value: number): void;
+    /**
+     * Sets the value of the specified attribute to the maximum of the current value and the provided value.
+     * @param key - The key of the attribute to compare.
+     * @param value - The value to compare against.
+     */
     max<T extends string>(key: PathName<T>, value: TValue): void;
+    /**
+     * Sets the value of the specified attribute to the minimum of the current value and the provided value.
+     * @param key - The key of the attribute to compare.
+     * @param value - The value to compare against.
+     */
     min<T extends string>(key: PathName<T>, value: TValue): void;
+    /**
+     * Adds the specified values to the set of the specified attribute.
+     * @param key - The key of the attribute.
+     * @param values - The values to add to the set.
+     */
     addToSet<T extends string>(key: PathName<T>, values: TValue[]): void;
+    /**
+     * Adds the values to the array of the attribute.
+     * @param key - The key of the attribute.
+     * @param values - The values to add.
+     */
     push<T extends string>(key: PathName<T>, values: TValue[]): void;
+    /**
+     * Removes the values from the array of the attribute.
+     * @param key - The key of the attribute.
+     * @param values - The values to remove.
+     */
     removeAll<T extends string>(key: PathName<T>, values: TValue[]): void;
+    /**
+     * Removes the first elements from the array of the attribute.
+     * @param key - The key of the attribute.
+     * @param count - The number of elements to remove. Defaults to 1.
+     */
     popFirst<T extends string>(key: PathName<T>, count?: number): void;
+    /**
+     * Removes the last elements from the array of the attribute.
+     * @param key - The key of the attribute.
+     * @param count - The number of elements to remove. Defaults to 1.
+     */
     popLast<T extends string>(key: PathName<T>, count?: number): void;
+    /**
+     * Fetches the object data.
+     * @param options - Additional options for the fetch operation.
+     * @returns A promise that resolves to the fetched object.
+     */
     fetch(options?: ExtraOptions<boolean>): Promise<this>;
+    /**
+     * Fetches the object data if needed.
+     * @param keys - The keys of the attributes to fetch.
+     * @param options - Additional options for the fetch operation.
+     * @returns A promise that resolves to the fetched object.
+     */
     fetchIfNeeded(keys: string[], options?: ExtraOptions<boolean>): Promise<this>;
 }
 
@@ -425,79 +1246,256 @@ type ExactOneProp<T> = {
 }[keyof T];
 
 declare namespace TSchema {
+    /**
+     * Access Control List represented as an array of strings.
+     */
     type ACL = string[];
+    /**
+     * Access Control Lists for read and update operations.
+     */
     type ACLs = {
+        /**
+         * ACL for read operation.
+         */
         read: TSchema.ACL;
+        /**
+         * ACL for update operation.
+         */
         update: TSchema.ACL;
     };
+    /**
+     * Primitive data types.
+     */
     type Primitive = 'boolean' | 'number' | 'decimal' | 'string' | 'date' | 'object' | 'array';
+    /**
+     * Primitive type with an optional default value.
+     */
     type PrimitiveType = Primitive | {
+        /**
+         * The type of the primitive.
+         */
         type: Primitive;
+        /**
+         * Optional default value.
+         */
         default?: _TValue;
     };
+    /**
+     * Vector type with a specified dimension and an optional default value.
+     */
     type VectorType = {
+        /**
+         * The type of the vector.
+         */
         type: 'vector';
+        /**
+         * The dimension of the vector.
+         */
         dimension: number;
+        /**
+         * Optional default value.
+         */
         default?: number[];
     };
+    /**
+     * Shape type with a specified shape.
+     */
     type ShapeType = {
+        /**
+         * The type of the shape.
+         */
         type: 'shape';
+        /**
+         * The shape definition.
+         */
         shape: Record<string, DataType>;
     };
-    type Relation = 'pointer' | 'relation';
+    /**
+       * Pointer type with a target.
+       */
     type PointerType = {
+        /**
+         * The type of the pointer.
+         */
         type: 'pointer';
+        /**
+         * The target class of the pointer.
+         */
         target: string;
     };
+    /**
+     * Relation type with a target and an optional foreign field.
+     */
     type RelationType = {
+        /**
+         * The type of the relation.
+         */
         type: 'relation';
+        /**
+         * The target class of the relation.
+         */
         target: string;
+        /**
+         * Optional foreign field.
+         */
         foreignField?: string;
     };
+    /**
+     * Data type which can be a primitive, vector, shape, pointer, or relation type.
+     */
     type DataType = PrimitiveType | VectorType | ShapeType | PointerType | RelationType;
+    /**
+     * Class Level Permissions.
+     */
     type CLPs = {
+        /**
+         * ACL for get operation.
+         */
         get?: TSchema.ACL;
+        /**
+         * ACL for find operation.
+         */
         find?: TSchema.ACL;
+        /**
+         * ACL for count operation.
+         */
         count?: TSchema.ACL;
+        /**
+         * ACL for create operation.
+         */
         create?: TSchema.ACL;
+        /**
+         * ACL for update operation.
+         */
         update?: TSchema.ACL;
+        /**
+         * ACL for delete operation.
+         */
         delete?: TSchema.ACL;
     };
+    /**
+     * Field Level Permissions.
+     */
     type FLPs = {
+        /**
+         * ACL for read operation.
+         */
         read?: TSchema.ACL;
+        /**
+         * ACL for create operation.
+         */
         create?: TSchema.ACL;
+        /**
+         * ACL for update operation.
+         */
         update?: TSchema.ACL;
     };
+    /**
+     * Indexes for the schema.
+     */
     type Indexes = {
+        /**
+         * Type of the index, default is 'basic'.
+         */
         type?: 'basic';
+        /**
+         * Keys for the index.
+         */
         keys: Record<string, 1 | -1>;
+        /**
+         * Whether the index is unique.
+         */
         unique?: boolean;
     } | {
+        /**
+         * Type of the index, must be 'vector'.
+         */
         type: 'vector';
+        /**
+         * Keys for the vector index.
+         */
         keys: string | string[];
+        /**
+         * Method for the vector index.
+         */
         method?: 'hnsw' | 'ivfflat';
     };
 }
 interface TSchema {
+    /**
+     * Fields of the schema, where each field is a data type.
+     */
     fields: Record<string, TSchema.DataType>;
+    /**
+     * Class level permissions for the schema.
+     */
     classLevelPermissions?: TSchema.CLPs;
+    /**
+     * Additional object permissions for the schema.
+     */
     additionalObjectPermissions?: TSchema.ACLs;
+    /**
+     * Field level permissions for the schema, where each field can have its own permissions.
+     */
     fieldLevelPermissions?: Record<string, TSchema.FLPs>;
+    /**
+     * Secure fields in the schema.
+     */
     secureFields?: string[];
+    /**
+     * Indexes for the schema.
+     */
     indexes?: TSchema.Indexes[];
 }
 
+/**
+ * Represents file information.
+ */
 type TFileInfo = {
+    /**
+     * The MIME type of the file.
+     */
     mimeType?: string;
+    /**
+     * The filename.
+     */
     filename?: string;
 };
+/**
+ * Interface for file storage operations.
+ */
 interface TFileStorage {
+    /**
+     * The schema definition for the file storage.
+     */
     schema: Record<string, TSchema>;
+    /**
+     * Creates a new file in the storage.
+     * @param proto - The ProtoService instance.
+     * @param stream - The binary data stream or async iterable of binary data.
+     * @param info - The file information.
+     * @param maxUploadSize - The maximum upload size.
+     * @returns A promise that resolves to an object containing the file ID and size.
+     */
     create<E>(proto: ProtoService<E>, stream: BinaryData | AsyncIterable<BinaryData>, info: TFileInfo, maxUploadSize: number): PromiseLike<{
         _id: string;
         size: number;
     }>;
+    /**
+     * Destroys a file in the storage.
+     * @param proto - The ProtoService instance.
+     * @param id - The ID of the file to destroy.
+     * @returns A promise that resolves when the file is destroyed.
+     */
     destroy<E>(proto: ProtoService<E>, id: string): PromiseLike<void>;
+    /**
+     * Retrieves file data from the storage.
+     * @param proto - The ProtoService instance.
+     * @param id - The ID of the file.
+     * @param start - The optional start byte position.
+     * @param end - The optional end byte position.
+     * @returns An async iterable of binary data.
+     */
     fileData<E>(proto: ProtoService<E>, id: string, start?: number, end?: number): AsyncIterable<BinaryData>;
 }
 
@@ -608,36 +1606,118 @@ type PasswordHashOptions = {
     } & _PasswordHashOptions[K];
 }[keyof _PasswordHashOptions];
 
+/**
+ * Interface for publish-subscribe operations.
+ */
 interface TPubSub {
+    /**
+     * Subscribes to events.
+     * @param callback - The callback function to handle the event data.
+     * @returns A function to unsubscribe from the events.
+     */
     subscribe(callback: (payload: EventData) => void): VoidFunction;
+    /**
+     * Publishes an event.
+     * @param payload - The event data to publish.
+     * @returns A promise that resolves when the event is published.
+     */
     publish(payload: EventData): Awaitable<void>;
 }
 
 type ProtoServiceOptions<Ext> = {
+    /**
+     * The endpoint for the service.
+     */
     endpoint: string;
+    /**
+     * The schema definitions for the service.
+     */
     schema: Record<string, TSchema>;
+    /**
+     * Role resolver configuration.
+     */
     roleResolver?: {
+        /**
+         * Keys to inherit roles.
+         */
         inheritKeys?: string[];
+        /**
+         * Custom resolver function for roles.
+         * @param user The user object.
+         * @param defaultResolver The default resolver function.
+         * @returns A promise that resolves to an array of roles.
+         */
         resolver?: (user: TUser, defaultResolver: () => PromiseLike<TRole[]>) => PromiseLike<TRole[]>;
     };
+    /**
+     * Storage configuration.
+     */
     storage: TStorage;
+    /**
+     * File storage configuration.
+     */
     fileStorage: TFileStorage;
+    /**
+     * Pub/Sub configuration.
+     */
     pubsub?: TPubSub;
+    /**
+     * Class extensions configuration.
+     */
     classExtends?: TExtensions<Ext>;
+    /**
+     * Size of the object ID.
+     */
     objectIdSize?: number;
+    /**
+     * Maximum fetch limit.
+     */
     maxFetchLimit?: number;
+    /**
+     * Maximum upload size.
+     */
     maxUploadSize?: number;
+    /**
+     * Cookie options.
+     */
     cookieOptions?: CookieOptions;
+    /**
+     * JWT sign options.
+     */
     jwtSignOptions?: SignOptions;
+    /**
+     * JWT verify options.
+     */
     jwtVerifyOptions?: VerifyOptions;
+    /**
+     * JWT upload sign options.
+     */
     jwtUploadSignOptions?: SignOptions;
+    /**
+     * JWT upload verify options.
+     */
     jwtUploadVerifyOptions?: VerifyOptions;
+    /**
+     * Password hash options.
+     */
     passwordHashOptions?: PasswordHashOptions;
 };
 type ProtoServiceKeyOptions = {
+    /**
+     * JWT token for the service.
+     */
     jwtToken: string;
+    /**
+     * Master users configuration.
+     */
     masterUsers?: {
+        /**
+         * Username of the master user.
+         */
         user: string;
+        /**
+         * Password of the master user.
+         */
         pass: string;
     }[];
 };
@@ -733,4 +1813,4 @@ declare class ProtoService<Ext = any> extends ProtoType<Ext> {
 }
 
 export { type TPubSub as A, type TFileInfo as B, type DeserializeOptions as D, type ExtraOptions as E, type FindOptions as F, type InsertOptions as I, ProtoService as P, QuerySelector as Q, type RelationOptions as R, type SerializeOptions as S, TSchema as T, type _TValue as _, type ProtoServiceOptions as a, type ProtoServiceKeyOptions as b, type TFileStorage as c, type TSerializable as d, deserialize as e, type TExtensions as f, TQuery as g, TObject as h, TUser as i, TRole as j, TFile as k, ProtoType as l, type PathName as m, type TObjectType as n, type EventData as o, type DecodedQuery as p, type DecodedSortOption as q, type TValue as r, serialize as s, type FindOneOptions as t, type TUpdateOp as u, FieldSelectorExpression as v, QueryExpression as w, type TStorage as x, type TransactionOptions as y, type TQueryRandomOptions as z };
-//# sourceMappingURL=index-lX-M76Tn.d.ts.map
+//# sourceMappingURL=index-CE5tdYK8.d.ts.map