proto.io 0.0.173 → 0.0.175

package/dist/client.d.ts

@@ -1,7 +1,7 @@
-import { P as ProtoClient } from './internals/index-Cpv1DoEI.js';
-export { c as classExtends, e as isFile, a as isObject, i as isQuery, d as isRole, b as isUser } from './internals/index-Cpv1DoEI.js';
+import { P as ProtoClient } from './internals/index-B9CWU0y7.js';
+export { c as classExtends, e as isFile, a as isObject, i as isQuery, d as isRole, b as isUser } from './internals/index-B9CWU0y7.js';
 export { Decimal } from 'decimal.js';
-export { D as DeserializeOptions, S as SerializeOptions, d as TSerializable, e as deserialize, s as serialize } from './internals/index-lX-M76Tn.js';
+export { D as DeserializeOptions, S as SerializeOptions, d as TSerializable, e as deserialize, s as serialize } from './internals/index-BYZpj31o.js';
 import '@o2ter/utils-js';
 import 'socket.io-client';
 import '@socket.io/component-emitter';

package/dist/client.js

@@ -2,9 +2,9 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var index = require('./internals/index-CIecB6mS.js');
+var index = require('./internals/index-CvA0tbwx.js');
 var Decimal = require('decimal.js');
-require('./internals/index-CVutVPmd.js');
+require('./internals/index-DXuW8UiB.js');
 require('lodash');
 require('./internals/private-CSB1Ep4g.js');
 require('@o2ter/utils-js');

package/dist/client.mjs

@@ -1,7 +1,7 @@
-import { c as ProtoClient } from './internals/index-BZNPlw1L.mjs';
-export { e as classExtends, d as deserialize, j as isFile, f as isObject, i as isQuery, h as isRole, g as isUser, s as serialize } from './internals/index-BZNPlw1L.mjs';
+import { c as ProtoClient } from './internals/index-BPbXumUi.mjs';
+export { e as classExtends, d as deserialize, j as isFile, f as isObject, i as isQuery, h as isRole, g as isUser, s as serialize } from './internals/index-BPbXumUi.mjs';
 export { Decimal } from 'decimal.js';
-import './internals/index-BYbMU-Ao.mjs';
+import './internals/index-CTsc042s.mjs';
 import 'lodash';
 import './internals/private-BUpLAMZi.mjs';
 import '@o2ter/utils-js';

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import * as socket_io from 'socket.io';
 import { Router } from 'express';
 import { Server } from '@o2ter/server-js';
-import { T as TSchema, _ as _TValue, P as ProtoService, a as ProtoServiceOptions, b as ProtoServiceKeyOptions } from './internals/index-lX-M76Tn.js';
-export { D as DeserializeOptions, S as SerializeOptions, c as TFileStorage, d as TSerializable, e as deserialize, s as serialize } from './internals/index-lX-M76Tn.js';
+import { T as TSchema, _ as _TValue, P as ProtoService, a as ProtoServiceOptions, b as ProtoServiceKeyOptions } from './internals/index-BYZpj31o.js';
+export { D as DeserializeOptions, S as SerializeOptions, c as TFileStorage, d as TSerializable, e as deserialize, s as serialize } from './internals/index-BYZpj31o.js';
 import Decimal from 'decimal.js';
 export { Decimal } from 'decimal.js';
-export { P as ProtoClient, c as classExtends, e as isFile, a as isObject, i as isQuery, d as isRole, b as isUser } from './internals/index-Cpv1DoEI.js';
+export { P as ProtoClient, c as classExtends, e as isFile, a as isObject, i as isQuery, d as isRole, b as isUser } from './internals/index-B9CWU0y7.js';
 import '@o2ter/utils-js';
 import 'jsonwebtoken';
 import 'lodash';
@@ -13,57 +13,129 @@ import 'node:stream';
 import 'socket.io-client';
 import '@socket.io/component-emitter';
 
+/**
+ * Schema definition utility functions.
+ */
 declare const schema: ((x: Record<string, TSchema>) => Record<string, TSchema>) & {
+    /**
+     * Defines a boolean schema.
+     * @param defaultValue - The default value for the boolean.
+     * @returns The boolean schema.
+     */
     boolean: (defaultValue?: boolean) => {
         readonly type: "boolean";
         readonly default: boolean | undefined;
     };
+    /**
+     * Defines a number schema.
+     * @param defaultValue - The default value for the number.
+     * @returns The number schema.
+     */
     number: (defaultValue?: number) => {
         readonly type: "number";
         readonly default: number | undefined;
     };
+    /**
+     * Defines a decimal schema.
+     * @param defaultValue - The default value for the decimal.
+     * @returns The decimal schema.
+     */
     decimal: (defaultValue?: Decimal) => {
         readonly type: "decimal";
         readonly default: Decimal | undefined;
     };
+    /**
+     * Defines a string schema.
+     * @param defaultValue - The default value for the string.
+     * @returns The string schema.
+     */
     string: (defaultValue?: string) => {
         readonly type: "string";
         readonly default: string | undefined;
     };
+    /**
+     * Defines a date schema.
+     * @param defaultValue - The default value for the date.
+     * @returns The date schema.
+     */
     date: (defaultValue?: Date) => {
         readonly type: "date";
         readonly default: Date | undefined;
     };
+    /**
+     * Defines an object schema.
+     * @param defaultValue - The default value for the object.
+     * @returns The object schema.
+     */
     object: <T extends Record<string, _TValue>>(defaultValue?: T) => {
         readonly type: "object";
         readonly default: T | undefined;
     };
+    /**
+     * Defines an array schema.
+     * @param defaultValue - The default value for the array.
+     * @returns The array schema.
+     */
     array: <T extends _TValue[]>(defaultValue?: T) => {
         readonly type: "array";
         readonly default: T | undefined;
     };
+    /**
+     * Defines a vector schema.
+     * @param dimension - The dimension of the vector.
+     * @param defaultValue - The default value for the vector.
+     * @returns The vector schema.
+     */
     vector: (dimension: number, defaultValue?: number[]) => {
         readonly type: "vector";
         readonly dimension: number;
         readonly default: number[] | undefined;
     };
+    /**
+     * Defines a shape schema.
+     * @param shape - The shape definition.
+     * @returns The shape schema.
+     */
     shape: (shape: Record<string, TSchema.DataType>) => {
         readonly type: "shape";
         readonly shape: Record<string, TSchema.DataType>;
     };
+    /**
+     * Defines a pointer schema.
+     * @param target - The target of the pointer.
+     * @returns The pointer schema.
+     */
     pointer: (target: string) => {
         readonly type: "pointer";
         readonly target: string;
     };
+    /**
+     * Defines a relation schema.
+     * @param target - The target of the relation.
+     * @param foreignField - The foreign field of the relation.
+     * @returns The relation schema.
+     */
     relation: (target: string, foreignField?: string) => {
         readonly type: "relation";
         readonly target: string;
         readonly foreignField: string | undefined;
     };
 };
+/**
+ * Creates a ProtoRoute.
+ * @param options - The options for the ProtoRoute.
+ * @returns A promise that resolves to a Router.
+ */
 declare const ProtoRoute: <E>(options: {
     proto: ProtoService<E> | (ProtoServiceOptions<E> & ProtoServiceKeyOptions);
 }) => Promise<Router>;
+/**
+ * Registers a ProtoSocket.
+ * @param proto - The ProtoService instance.
+ * @param server - The server instance.
+ * @param endpoint - The optional endpoint.
+ * @returns The socket.io instance.
+ */
 declare const registerProtoSocket: <E>(proto: ProtoService<E>, server: Server, endpoint?: string) => socket_io.Server<socket_io.DefaultEventsMap, socket_io.DefaultEventsMap, socket_io.DefaultEventsMap, any> | socket_io.Namespace<socket_io.DefaultEventsMap, socket_io.DefaultEventsMap, socket_io.DefaultEventsMap, any>;
 
 export { ProtoRoute, ProtoService, ProtoRoute as default, registerProtoSocket, schema };