@cripty2001/utils 0.0.58 → 0.0.59

package/dist/Appserver/server.d.ts

@@ -16,6 +16,21 @@ export declare class AppserverAuthError extends AppserverError {
 export declare class AppserverHandledError extends AppserverError {
     constructor(code: string, message: string, payload?: AppserverData);
 }
+/**
+ * Lightweight typed RPC runner that exposes POST `/exec/:action` endpoints using msgpack payloads
+ * and a GET `/metrics` endpoint for Prometheus gauges.
+ *
+ * Usage:
+ * const app = new Appserver(8080, parseToken, collectMetrics);
+ * app.register('sum', SumSchema, true, async (input, user) => ({ total: input.a + input.b }));
+ *
+ * Request requirements:
+ * - `Content-Type: application/vnd.msgpack`
+ * - Body is msgpack-encoded object matching the provided schema.
+ * - Optional `Authorization: Bearer <token>` header is decoded via the provided parseUser function.
+ *
+ * Responses are msgpack encoded objects with either handler data or `{ error, code, payload }` for handled errors.
+ */
 export declare class Appserver<U extends AppserverData> {
     private app;
     private parseUser;
@@ -24,5 +39,12 @@ export declare class Appserver<U extends AppserverData> {
     constructor(port: number, parseUser: AppserverUsergetter<U>, getMetrics: () => Record<string, number>);
     private handleMetricsRequest;
     private parseInput;
+    /**
+     * Registers a msgpack RPC endpoint under `/exec/${action}`.
+     * @param action unique action name (duplicates throw)
+     * @param inputSchema typebox schema used for runtime validation
+     * @param auth when true rejects requests without a valid user
+     * @param handler business logic returning serializable data
+     */
     register<ISchema extends TSchema, O extends AppserverData, I extends Static<ISchema> & AppserverData = Static<ISchema> & AppserverData>(action: string, inputSchema: ISchema, auth: boolean, handler: AppserverHandler<I, U, O>): void;
 }

package/dist/Appserver/server.js

@@ -36,6 +36,21 @@ class AppserverHandledError extends AppserverError {
     }
 }
 exports.AppserverHandledError = AppserverHandledError;
+/**
+ * Lightweight typed RPC runner that exposes POST `/exec/:action` endpoints using msgpack payloads
+ * and a GET `/metrics` endpoint for Prometheus gauges.
+ *
+ * Usage:
+ * const app = new Appserver(8080, parseToken, collectMetrics);
+ * app.register('sum', SumSchema, true, async (input, user) => ({ total: input.a + input.b }));
+ *
+ * Request requirements:
+ * - `Content-Type: application/vnd.msgpack`
+ * - Body is msgpack-encoded object matching the provided schema.
+ * - Optional `Authorization: Bearer <token>` header is decoded via the provided parseUser function.
+ *
+ * Responses are msgpack encoded objects with either handler data or `{ error, code, payload }` for handled errors.
+ */
 class Appserver {
     app;
     parseUser;
@@ -96,6 +111,13 @@ class Appserver {
             user: token ? await this.parseUser(token) : null
         };
     }
+    /**
+     * Registers a msgpack RPC endpoint under `/exec/${action}`.
+     * @param action unique action name (duplicates throw)
+     * @param inputSchema typebox schema used for runtime validation
+     * @param auth when true rejects requests without a valid user
+     * @param handler business logic returning serializable data
+     */
     register(action, inputSchema, auth, handler) {
         if (this.registered.has(action))
             throw new Error(`Action ${action} is already registered`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cripty2001/utils",
-  "version": "0.0.58",
+  "version": "0.0.59",
   "description": "Internal Set of utils. If you need them use them, otherwise go to the next package ;)",
   "homepage": "https://github.com/cripty2001/utils#readme",
   "bugs": {