proto.io 0.0.222 → 0.0.224

package/dist/internals/{base-C1uAg1dD.d.ts → base-NZIvB1zK.d.ts}

@@ -1,4 +1,4 @@
-import { d as TFileStorage, T as TSchema, P as ProtoService, G as TFileInfo } from './index-82GLvDiN.js';
+import { d as TFileStorage, T as TSchema, P as ProtoService, G as TFileInfo } from './index-BOboD1oK.js';
 import { BinaryData } from '@o2ter/utils-js';
 
 type FileStorageOptions = {
@@ -23,4 +23,4 @@ declare abstract class FileStorageBase implements TFileStorage {
 }
 
 export { FileStorageBase as F, type FileStorageOptions as a };
-//# sourceMappingURL=base-C1uAg1dD.d.ts.map
+//# sourceMappingURL=base-NZIvB1zK.d.ts.map

package/dist/internals/base-NZIvB1zK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-NZIvB1zK.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/internals/{chunk-CpgqvFNO.d.ts → chunk-B9i8NMB_.d.ts}

@@ -1,5 +1,5 @@
-import { F as FileStorageBase } from './base-C1uAg1dD.js';
-import { P as ProtoService } from './index-82GLvDiN.js';
+import { F as FileStorageBase } from './base-NZIvB1zK.js';
+import { P as ProtoService } from './index-BOboD1oK.js';
 
 declare abstract class FileChunkStorageBase<File> extends FileStorageBase {
     abstract listChunks<E>(proto: ProtoService<E>, token: string, start?: number, end?: number): AsyncGenerator<{
@@ -14,4 +14,4 @@ declare abstract class FileChunkStorageBase<File> extends FileStorageBase {
 }
 
 export { FileChunkStorageBase as F };
-//# sourceMappingURL=chunk-CpgqvFNO.d.ts.map
+//# sourceMappingURL=chunk-B9i8NMB_.d.ts.map

package/dist/internals/chunk-B9i8NMB_.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chunk-B9i8NMB_.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/internals/{index-82GLvDiN.d.ts → index-BOboD1oK.d.ts}

@@ -164,11 +164,27 @@ declare class TJob extends TObject {
     get completedAt(): Date | undefined;
 }
 
+declare class TSession extends TObject {
+    constructor(attributes?: Record<string, TValue> | ((self: TObject) => Record<string, TValue>));
+    /**
+     * Get the session ID.
+     * @return {string} The session ID.
+     */
+    get sessionId(): string;
+    /**
+     * Get the user associated with the session.
+     * @return {TObject | undefined} The user associated with the session.
+     */
+    get user(): TObject | undefined;
+    get loginedAt(): Date | undefined;
+}
+
 declare const TObjectTypes: {
     User: typeof TUser;
     Role: typeof TRole;
     File: typeof TFile;
     _Job: typeof TJob;
+    _Session: typeof TSession;
 };
 type _TObjectType<K> = K extends keyof typeof TObjectTypes ? InstanceType<(typeof TObjectTypes)[K]> : TObject;
 type PickBy<T, C> = {
@@ -844,11 +860,16 @@ type ProtoJobFunctionOptions<E> = {
     validator?: Validator;
 };
 
-type Session = jwt.JwtPayload & {
-    sessionId: string;
-    createdAt: Date;
-    loginedAt: Date;
-};
+type _Session = Awaited<ReturnType<typeof session>>;
+declare const session: <E>(proto: ProtoService<E>, request: Request) => Promise<{
+    user?: TObject | undefined;
+    _roles?: TRole[] | undefined;
+    sessionId?: string | undefined;
+    createdAt?: Date | undefined;
+    updatedAt?: Date | undefined;
+    loginedAt?: Date | undefined;
+    cookieOptions?: any;
+}>;
 
 declare const _logLevels: readonly ["error", "warn", "info", "debug", "trace"];
 type _Logger = {
@@ -1029,10 +1050,19 @@ interface ProtoType<Ext> {
      * @returns A promise resolving to the instance with the session and attributes.
      */
     connectWithSessionToken<T extends object>(token: string, attrs?: T | ((x: this & {
-        session?: Session;
+        session?: _Session;
     }) => T)): Promise<this & {
-        session?: Session;
+        session?: _Session;
     } & T>;
+    /**
+     * Refreshes the authentication/session status for the socket connection.
+     *
+     * This method should be called when the session token or authentication state changes,
+     * ensuring that any active socket connections are updated to reflect the new session.
+     * Useful for maintaining real-time features (such as LiveQuery) after login, logout,
+     * or session renewal.
+     */
+    refreshSocketSession(): void;
     /**
      * Sets the session token.
      * @param token - The session token.
@@ -1174,6 +1204,8 @@ type ExtraOptions<M extends boolean> = {
     abortSignal?: AbortSignal;
     /**
      * Disable the triggers.
+     *
+     * Only effective when `master` is `true`.
      */
     silent?: boolean;
 };
@@ -1186,7 +1218,7 @@ interface TObject {
      * Clones the object.
      * @returns A clone of the object.
      */
-    clone(): TObject;
+    clone(): this;
     /**
      * Gets a relation query for the specified key.
      * @param key - The key of the relation.
@@ -1409,113 +1441,147 @@ type ExactOneProp<T> = {
 
 declare namespace TSchema {
     /**
-     * Access Control List represented as an array of strings.
+     * Access Control List (ACL).
+     *
+     * An array of strings representing users or roles that have access to a resource.
      */
     type ACL = string[];
     /**
      * Access Control Lists for read and update operations.
+     *
+     * Defines separate ACLs for reading and updating an object.
      */
     type ACLs = {
         /**
          * ACL for read operation.
+         * Users or roles allowed to read the object.
          */
         read: TSchema.ACL;
         /**
          * ACL for update operation.
+         * Users or roles allowed to update the object.
          */
         update: TSchema.ACL;
     };
     /**
-     * Primitive data types.
+     * Supported primitive data types.
      */
     type Primitive = 'boolean' | 'number' | 'decimal' | 'string' | 'string[]' | 'date' | 'object' | 'array';
     /**
-     * Primitive type with an optional default value.
+     * Primitive type with optional default value.
+     *
+     * Can be a string literal (e.g., 'string') or an object specifying the type and a default value.
      */
     type PrimitiveType = Primitive | {
         /**
-         * The type of the primitive.
+         * The primitive type.
          */
         type: Primitive;
         /**
-         * Optional default value.
+         * Optional default value for the field.
          */
         default?: TValueWithoutObject;
     };
     /**
-     * Vector type with a specified dimension and an optional default value.
+     * Vector type with a specified dimension and optional default value.
+     *
+     * Used for fields storing fixed-length numeric arrays (vectors).
      */
     type VectorType = {
         /**
-         * The type of the vector.
+         * The type of the field. Always 'vector'.
          */
         type: 'vector';
         /**
-         * The dimension of the vector.
+         * The dimension (length) of the vector.
          */
         dimension: number;
         /**
-         * Optional default value.
+         * Optional default value for the vector.
          */
         default?: number[];
     };
     /**
-     * Shape type with a specified shape.
+     * Shape type for nested objects.
+     *
+     * Allows defining complex, nested object structures with their own field types.
      */
     type ShapeType = {
         /**
-         * The type of the shape.
+         * The type of the field. Always 'shape'.
          */
         type: 'shape';
         /**
-         * The shape definition.
+         * The shape definition, mapping field names to their data types.
          */
         shape: Record<string, DataType>;
     };
     /**
-       * Pointer type with a target.
-       */
+     * Pointer type for referencing another class.
+     *
+     * Represents a one-to-one relationship to another object.
+     */
     type PointerType = {
         /**
-         * The type of the pointer.
+         * The type of the field. Always 'pointer'.
          */
         type: 'pointer';
         /**
-         * The target class of the pointer.
+         * The name of the target class being referenced.
          */
         target: string;
     };
     /**
-     * Relation type with a target and an optional foreign field.
+     * Relation type for referencing multiple objects in another class.
+     *
+     * Represents a one-to-many or many-to-many relationship.
+     * - `target`: The related class name.
+     * - `foreignField`: (Optional) The field in the target class that refers back to this class.
+     * - `match`: (Optional) Default match query options (filter, sort, etc.) applied when querying this relation.
+     *   Only used if `foreignField` is set.
      */
     type RelationType = {
         /**
-         * The type of the relation.
+         * The type of the field. Always 'relation'.
          */
         type: 'relation';
         /**
-         * The target class of the relation.
+         * The name of the target class for this relation.
          */
         target: string;
         /**
-         * Optional foreign field.
+         * (Optional) The field in the target class that refers back to this class.
+         * If provided, the relation is managed via this foreign key.
          */
         foreignField?: string;
+        /**
+         * (Optional) Default match query options for this relation.
+         *
+         * These options define default query behaviors—such as filtering, sorting, limiting results, and other query parameters—
+         * that will be automatically applied when querying this relation via the specified `foreignField`.
+         *
+         * Note: `match` is only applicable if `foreignField` is set. If `foreignField` is not provided, `match` will be ignored.
+         */
+        match?: TQueryBaseOptions;
     };
     /**
-     * Data type which can be a primitive, vector, shape, pointer, or relation type.
+     * Data type for schema fields.
+     *
+     * Can be a primitive, vector, shape, pointer, or relation type.
      */
     type DataType = PrimitiveType | VectorType | ShapeType | PointerType | RelationType;
     /**
-     * Class Level Permissions.
+     * Class Level Permissions (CLPs).
+     *
+     * Defines access control for various operations at the class level.
      */
     type CLPs = {
         /**
-         * ACL for get operation.
+         * ACL for get (read single object) operation.
          */
         get?: TSchema.ACL;
         /**
-         * ACL for find operation.
+         * ACL for find (query multiple objects) operation.
          */
         find?: TSchema.ACL;
         /**
@@ -1536,32 +1602,36 @@ declare namespace TSchema {
         delete?: TSchema.ACL;
     };
     /**
-     * Field Level Permissions.
+     * Field Level Permissions (FLPs).
+     *
+     * Defines access control for individual fields.
      */
     type FLPs = {
         /**
-         * ACL for read operation.
+         * ACL for reading the field.
          */
         read?: TSchema.ACL;
         /**
-         * ACL for create operation.
+         * ACL for creating the field.
          */
         create?: TSchema.ACL;
         /**
-         * ACL for update operation.
+         * ACL for updating the field.
          */
         update?: TSchema.ACL;
     };
     /**
-     * Indexes for the schema.
+     * Index definitions for the schema.
+     *
+     * Supports both basic and vector indexes.
      */
     type Indexes = {
         /**
-         * Type of the index, default is 'basic'.
+         * Type of the index. Default is 'basic'.
          */
         type?: 'basic';
         /**
-         * Keys for the index.
+         * Keys for the index, mapping field names to sort order (1 for ascending, -1 for descending).
          */
         keys: Record<string, 1 | -1>;
         /**
@@ -1570,15 +1640,15 @@ declare namespace TSchema {
         unique?: boolean;
     } | {
         /**
-         * Type of the index, must be 'vector'.
+         * Type of the index. Must be 'vector' for vector indexes.
          */
         type: 'vector';
         /**
-         * Keys for the vector index.
+         * Keys for the vector index. Can be a single field or an array of fields.
          */
         keys: string | string[];
         /**
-         * Method for the vector index.
+         * Method for the vector index. Supported: 'hnsw', 'ivfflat'.
          */
         method?: 'hnsw' | 'ivfflat';
     };
@@ -1810,10 +1880,6 @@ type ProtoServiceOptions<Ext> = {
      * The schema definitions for the service.
      */
     schema: Record<string, TSchema>;
-    /**
-     * User resolver configuration.
-     */
-    userResolver?: (proto: ProtoService<Ext>, user?: TUser) => Awaitable<TUser | undefined>;
     /**
      * Role resolver configuration.
      */
@@ -1911,7 +1977,7 @@ declare class ProtoService<Ext = any> extends ProtoType<Ext> {
     private _storage?;
     private _schedule;
     req?: Request;
-    session?: Session;
+    session?: _Session;
     constructor(options: ProtoServiceOptions<Ext> & ProtoServiceKeyOptions);
     shutdown(): Promise<void>;
     get logger(): Logger;
@@ -1919,20 +1985,14 @@ declare class ProtoService<Ext = any> extends ProtoType<Ext> {
     Query<T extends string>(className: T): TQuery<T, Ext, boolean>;
     Relation<T extends string>(object: TObject, key: PathName<T>): TQuery<string, Ext, boolean>;
     InsecureQuery<T extends string>(className: T): TQuery<T, Ext, true>;
-    get sessionId(): string | undefined;
-    sessionInfo(): Promise<Session | {
-        loginedAt: Date | undefined;
+    sessionInfo(): Promise<{
         user?: TObject | undefined;
-        _roles?: TObject[] | undefined;
-        iss?: string | undefined;
-        sub?: string | undefined;
-        aud?: string | string[] | undefined;
-        exp?: number | undefined;
-        nbf?: number | undefined;
-        iat?: number | undefined;
-        jti?: string | undefined;
+        _roles?: TRole[] | undefined;
         sessionId?: string | undefined;
         createdAt?: Date | undefined;
+        updatedAt?: Date | undefined;
+        loginedAt?: Date | undefined;
+        cookieOptions?: any;
     } | undefined>;
     currentUser(): Promise<TUser | undefined>;
     _currentRoles(): Promise<TRole[]>;
@@ -1945,9 +2005,9 @@ declare class ProtoService<Ext = any> extends ProtoType<Ext> {
         req: R;
     } & T;
     connectWithSessionToken<T extends object>(token: string, attrs?: T | ((x: this & {
-        session?: Session;
+        session?: _Session;
     }) => T)): Promise<this & {
-        session?: Session;
+        session?: _Session;
     } & T>;
     userRoles(user: TUser): Promise<TRole[]>;
     becomeUser(req: Request, user: TUser, options?: {
@@ -2001,4 +2061,4 @@ declare class ProtoService<Ext = any> extends ProtoType<Ext> {
 }
 
 export { type TransactionOptions as A, type QueryRandomOptions as B, type TPubSub as C, type DeserializeOptions as D, type ExtraOptions as E, FieldSelectorExpression as F, type TFileInfo as G, type InsertOptions as I, ProtoService as P, QueryExpression as Q, type RelationOptions as R, type SerializeOptions as S, TSchema as T, type TValueWithoutObject as a, type ProtoServiceOptions as b, type ProtoServiceKeyOptions as c, type TFileStorage as d, type TNumber as e, type TSerializable as f, deserialize as g, type TExtensions as h, ProtoType as i, TQuery as j, TObject as k, type PathName as l, type TObjectType as m, TUser as n, type EventData as o, type TQuerySelector as p, type TValueWithUndefined as q, type TValue as r, serialize as s, type TUpdateOp as t, QueryAccumulator as u, QuerySelector as v, type DecodedSortOption as w, type DecodedQuery as x, type FindOptions as y, type TStorage as z };
-//# sourceMappingURL=index-82GLvDiN.d.ts.map
+//# sourceMappingURL=index-BOboD1oK.d.ts.map

package/dist/internals/index-BOboD1oK.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index-BOboD1oK.d.ts","sources":[],"sourcesContent":[],"names":[],"mappings":""}

package/dist/internals/{index-CsclRNTO.mjs → index-BZ79Ljis.mjs}

@@ -853,6 +853,53 @@ class TJob extends TObject {
     }
 }
 
+//
+//  session.ts
+//
+//  The MIT License
+//  Copyright (c) 2021 - 2025 O2ter Limited. All rights reserved.
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in
+//  all copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+//  THE SOFTWARE.
+//
+class TSession extends TObject {
+    constructor(attributes) {
+        super('_Session', attributes);
+    }
+    /**
+     * Get the session ID.
+     * @return {string} The session ID.
+     */
+    get sessionId() {
+        return this.get('token');
+    }
+    /**
+     * Get the user associated with the session.
+     * @return {TObject | undefined} The user associated with the session.
+     */
+    get user() {
+        return this.get('user');
+    }
+    get loginedAt() {
+        return this.get('loginedAt');
+    }
+}
+
 //
 //  types.ts
 //
@@ -882,6 +929,7 @@ const TObjectTypes = {
     'Role': TRole,
     'File': TFile,
     '_Job': TJob,
+    '_Session': TSession,
 };
 
 //
@@ -1479,6 +1527,11 @@ class Service {
         this.retryLimit = retryLimit;
         this.cookieKey = cookieKey || AUTH_COOKIE_KEY;
     }
+    refreshSocketSession() {
+        for (const socket of this.sockets) {
+            socket.emit('auth', this.token);
+        }
+    }
     setSessionToken(token) {
         this.token = token;
         if (typeof window === 'undefined') {
@@ -1650,6 +1703,9 @@ class ProtoClientInternal {
         });
         return proto.rebind(deserialize(res.data));
     }
+    refreshSocketSession() {
+        this.service.refreshSocketSession();
+    }
     setSessionToken(proto, token) {
         this.service.setSessionToken(token);
     }
@@ -1991,6 +2047,9 @@ class ProtoClient extends ProtoType {
             ...(options ?? {})
         });
     }
+    refreshSocketSession() {
+        this[PVK].refreshSocketSession();
+    }
     setSessionToken(token) {
         this[PVK].setSessionToken(this, token);
     }
@@ -2024,4 +2083,4 @@ class ProtoClient extends ProtoType {
 }
 
 export { LiveQuerySubscription as L, ProtoType as P, TQuery as T, _logLevels as _, TUser as a, ProtoClient as b, classExtends as c, deserialize as d, serialize as s };
-//# sourceMappingURL=index-CsclRNTO.mjs.map
+//# sourceMappingURL=index-BZ79Ljis.mjs.map