@irpclib/irpc 1.0.0-beta.24 → 1.0.0

package/dist/transport.d.ts

@@ -1,7 +1,7 @@
-import { IRPCPackage } from "./module.js";
+import { IRPCCall } from "./call.js";
 import { IRPCCallConfig, IRPCCredentials, IRPCCredentialsFactory, IRPCData, IRPCInputs, IRPCOutput, IRPCSpec, TransportConfig } from "./types.js";
 import { IRPCReader } from "./reader.js";
-import { IRPCCall } from "./call.js";
+import { IRPCPackage } from "./module.js";
 
 //#region src/transport.d.ts
 
@@ -12,7 +12,7 @@ import { IRPCCall } from "./call.js";
 declare class IRPCTransport {
   #private;
   config?: TransportConfig | undefined;
-  modules: Set<IRPCPackage>;
+  modules: Set<IRPCPackage<"id">>;
   /**
    * A set of pending RPC calls that are queued for execution.
    */

package/dist/transport.js

@@ -1,5 +1,5 @@
+import { TransportError } from "./error.js";
 import { IRPC_PACKET_TYPE, IRPC_STATUS } from "./enum.js";
-import { ERROR_CODE, ERROR_MESSAGE } from "./error.js";
 import { IRPCReader } from "./reader.js";
 import { IRPC_STORE } from "./store.js";
 import { IRPCCall } from "./call.js";
@@ -119,10 +119,7 @@ var IRPCTransport = class {
 				name: call.payload.name,
 				type: IRPC_PACKET_TYPE.CLOSE,
 				status: IRPC_STATUS.ERROR,
-				error: {
-					code: ERROR_CODE.TRANSPORT_NOT_IMPLEMENTED,
-					message: ERROR_MESSAGE[ERROR_CODE.TRANSPORT_NOT_IMPLEMENTED]
-				},
+				error: TransportError.notImplemented().json(),
 				createdAt: Date.now()
 			});
 		});

package/dist/types.d.ts

@@ -1,5 +1,4 @@
-import { IRPC_BASE_CONTEXT, IRPC_DATA_TYPE, IRPC_PACKET_TYPE, IRPC_STATUS } from "./enum.js";
-import { ErrorCode } from "./error.js";
+import { IRPC_PACKET_TYPE, IRPC_STATUS } from "./enum.js";
 import { IRPCFile } from "./file.js";
 import { IRPCFilePointer } from "./packet.js";
 import { IRPCTransport } from "./transport.js";
@@ -21,9 +20,7 @@ type IRPCStubStore = WeakMap<IRPCHandler, IRPCSpec<IRPCInputs, IRPCOutput>>;
  */
 type IRPCSpecStore = Map<string, IRPCSpec<IRPCInputs, IRPCOutput>>;
 type IRPCStatus = (typeof IRPC_STATUS)[keyof typeof IRPC_STATUS];
-type IRPCDataType = (typeof IRPC_DATA_TYPE)[keyof typeof IRPC_DATA_TYPE];
 type IRPCPacketType = (typeof IRPC_PACKET_TYPE)[keyof typeof IRPC_PACKET_TYPE];
-type IRPCBaseContext = (typeof IRPC_BASE_CONTEXT)[keyof typeof IRPC_BASE_CONTEXT];
 type IRPCPacketBase = {
   id: string;
   name: string;
@@ -37,13 +34,13 @@ type IRPCPacketCall = IRPCPacketBase & {
 };
 type IRPCPacketAnswer<T extends IRPCData> = IRPCPacketBase & {
   data?: T;
-  error?: IRPCError;
+  error?: IRPCPacketError;
 };
 type IRPCPacketEvent = IRPCPacketBase & {
   data: StateChange;
 };
 type IRPCPacketClose = IRPCPacketBase & {
-  error?: IRPCError;
+  error?: IRPCPacketError;
 };
 type IRPCPacketStream<T extends IRPCData> = IRPCPacketAnswer<T> | IRPCPacketEvent | IRPCPacketClose;
 interface IRPCReadable<T> {
@@ -118,6 +115,11 @@ type IRPCObject = {
  * This is a recursive type that allows nested structures.
  */
 type IRPCData = IRPCPrimitive | IRPCObject | IRPCFile | IRPCData[];
+/**
+ * Represents all possible defined data types in IRPC, including primitives, objects, and arrays.
+ * This is a recursive type that allows nested structures.
+ */
+type IRPCDefined = string | number | boolean | IRPCObject | IRPCFile | IRPCDefined[];
 /**
  * Union type of all primitive Zod schema types used for validation.
  */
@@ -158,6 +160,8 @@ type IRPCPackageInfo = {
   description?: string;
 };
 type IRPCPackageConfig = IRPCPackageInfo & IRPCCallConfig & {
+  /** Primary key field name for CRUD operations. Defaults to 'id'. */
+  key?: string;
   transport?: IRPCTransport;
 };
 /**
@@ -206,8 +210,33 @@ type IRPCInit<R$1, I extends IRPCInputs, O$1 extends IRPCOutput> = {
    * This can help reduce the number of actual function executions.
    */
   coalesce?: boolean;
-  /** Optional initialization function to seed the data */
-  init?: () => R$1;
+} & IRPCCallConfig & IRPCInferInit<R$1>;
+type IRPCInferInit<R$1> = R$1 extends IRPCDefined ? {
+  seed: () => R$1;
+} : {
+  seed?: () => R$1;
+};
+/**
+ * Extracts the data type from a function's return type by unwrapping
+ * RemoteState and Promise wrappers.
+ *
+ * @template F - The function type to extract from.
+ */
+type IRPCReturnOf<F> = F extends ((...args: infer _A) => infer R) ? R extends RemoteState<infer S> ? S : R extends Promise<infer D> ? D : R : IRPCData;
+/**
+ * Configuration options for the shorthand `declare(name, seed, config?)` overload.
+ * Contains all IRPCInit fields except `name` and `seed`.
+ *
+ * @template I - Tuple of input validation schemas
+ * @template O - Output validation schema
+ */
+type IRPCDeclareConfig<I extends IRPCInputs = IRPCInputs, O$1 extends IRPCOutput = IRPCOutput> = {
+  description?: string;
+  schema?: IRPCSchema<I, O$1>;
+  maxAge?: number;
+  coalesce?: boolean;
+  stream?: true;
+  ttl?: number;
 } & IRPCCallConfig;
 /**
  * Configuration options for initializing an RPC stream function.
@@ -228,7 +257,65 @@ type IRPCStreamInit<I extends IRPCInputs, O$1 extends IRPCOutput, R$1> = IRPCIni
  * @template I - Tuple of input validation schemas
  * @template O - Output validation schema
  */
-type IRPCDeclareInit<F, I extends IRPCInputs, O$1 extends IRPCOutput> = F extends ((...args: IRPCData[]) => infer R) ? R extends RemoteState<infer S> ? S extends IRPCData ? IRPCStreamInit<I, O$1, S> : IRPCInit<IRPCData, IRPCInputs, IRPCOutput> : R extends Promise<infer D> ? D extends IRPCData ? IRPCInit<D, I, O$1> : IRPCInit<IRPCData, IRPCInputs, IRPCOutput> : R extends IRPCData ? IRPCInit<R, I, O$1> : IRPCInit<IRPCData, IRPCInputs, IRPCOutput> : IRPCInit<IRPCData, IRPCInputs, IRPCOutput>;
+type IRPCDeclareInit<F, I extends IRPCInputs, O$1 extends IRPCOutput> = F extends ((...args: infer _A) => infer R) ? R extends RemoteState<infer S> ? S extends IRPCData ? IRPCStreamInit<I, O$1, S> : IRPCInit<S, IRPCInputs, IRPCOutput> : R extends Promise<infer D> ? D extends IRPCData ? IRPCInit<D, I, O$1> : IRPCInit<D, IRPCInputs, IRPCOutput> : R extends IRPCData ? IRPCInit<R, I, O$1> : IRPCInit<R, IRPCInputs, IRPCOutput> : IRPCInit<IRPCData, IRPCInputs, IRPCOutput>;
+type IRPCCrudMethod = 'get' | 'create' | 'update' | 'delete';
+/**
+ * Discriminated field — shared value or per-operation values.
+ */
+type IRPCCrudField<T> = T | {
+  get?: T;
+  create?: T;
+  update?: T;
+  delete?: T;
+};
+type IRPCCrudOptions = {
+  description?: IRPCCrudField<string>;
+  schema?: {
+    get?: IRPCSchema<IRPCInputs, IRPCOutput>;
+    create?: IRPCSchema<IRPCInputs, IRPCOutput>;
+    update?: IRPCSchema<IRPCInputs, IRPCOutput>;
+    delete?: IRPCSchema<IRPCInputs, IRPCOutput>;
+  };
+  /** Cache max age — only applied to get. */
+  maxAge?: number;
+  coalesce?: boolean;
+} & IRPCCallConfig;
+/**
+ * ID type extracted from entity using the key field.
+ * Falls back to string if the key doesn't exist on the entity.
+ */
+type IRPCEntityId<T, K$1 extends string> = K$1 extends keyof T ? T[K$1] : string;
+type IRPCCrudStubs<T extends IRPCObject, K$1 extends string, I extends IRPCObject = T, U extends IRPCObject = T> = {
+  get: IRPCFunction<(id: IRPCEntityId<T, K$1>) => Promise<T> | RemoteState<T>>;
+  create: IRPCFunction<(data: I) => Promise<T> | RemoteState<T>>;
+  update: IRPCFunction<(id: IRPCEntityId<T, K$1>, data: U) => Promise<T> | RemoteState<T>>;
+  delete: IRPCFunction<(id: IRPCEntityId<T, K$1>) => Promise<T> | RemoteState<T>>;
+};
+/**
+ * Per-method resolved metadata — discriminated fields flattened,
+ * method-specific options applied. Passed to driver on every call.
+ */
+type IRPCCrudMeta = {
+  /** Entity/table name. */
+  name: string;
+  /** Primary key field name. */
+  key: string;
+  /** Resolved description for this method. */
+  description?: string;
+  /** Resolved schema for this method. */
+  schema?: IRPCSchema<IRPCInputs, IRPCOutput>;
+  maxAge?: number;
+  coalesce?: boolean;
+} & IRPCCallConfig;
+/**
+ * Base class for CRUD drivers that receive per-method resolved metadata on every call
+ */
+declare abstract class IRPCDriver {
+  get?(meta: IRPCCrudMeta, id: IRPCData): Promise<IRPCData> | IRPCData;
+  create?(meta: IRPCCrudMeta, data: IRPCData): Promise<IRPCData> | IRPCData;
+  update?(meta: IRPCCrudMeta, id: IRPCData, data: IRPCData): Promise<IRPCData> | IRPCData;
+  delete?(meta: IRPCCrudMeta, id: IRPCData): Promise<IRPCData> | IRPCData;
+}
 /**
  * Complete specification for an RPC function including its implementation.
  * Extends IRPCInit with the actual handler function.
@@ -243,8 +330,6 @@ type IRPCSpec<I extends IRPCInputs, O$1 extends IRPCOutput> = IRPCInit<IRPCData,
   stream?: boolean;
   /** The actual handler function that implements the RPC */
   handler: IRPCHandler;
-  /** Optional initialization function for a stream RPC */
-  init?: () => unknown;
 };
 /**
  * Represents an incoming RPC request.
@@ -264,8 +349,9 @@ type IRPCRequests = {
   calls: IRPCRequest[];
   credentials?: IRPCCredentials;
 };
-type IRPCError = {
-  code: ErrorCode;
+type IRPCPacketError = {
+  type: string;
+  code: string;
   message: string;
 };
 /**
@@ -277,7 +363,7 @@ type IRPCResponse = {
   /** Name of the RPC function that was called */
   name: string;
   /** Error message if the call failed */
-  error?: IRPCError;
+  error?: IRPCPacketError;
   /** Result of the RPC call if successful */
   result?: unknown;
 };
@@ -310,8 +396,6 @@ type IRPCCallConfig = {
   retryMode?: 'linear' | 'exponential';
   /** Base delay between retries in milliseconds */
   retryDelay?: number;
-  /** Optional initialization function for a stream RPC */
-  init?: () => unknown;
 };
 /**
  * Configuration for transport layer, extending call configuration with debounce settings.
@@ -333,4 +417,4 @@ type StreamCleanup = () => void;
  */
 type StreamConstructor<T> = (state: IRPCReadable<T>, resolve: (value?: T) => void, reject: (error: Error) => void) => StreamCleanup | void | Promise<StreamCleanup | void>;
 //#endregion
-export { IRPCArraySchema, IRPCBaseContext, IRPCCallConfig, IRPCContext, IRPCContextProvider, IRPCCredentials, IRPCCredentialsFactory, IRPCData, IRPCDataSchema, IRPCDataType, IRPCDeclareInit, IRPCError, IRPCFunction, IRPCHandler, IRPCInit, IRPCInputs, IRPCObject, IRPCObjectSchema, IRPCOutput, IRPCPackageConfig, IRPCPackageInfo, IRPCPacketAnswer, IRPCPacketBase, IRPCPacketCall, IRPCPacketClose, IRPCPacketEvent, IRPCPacketStream, IRPCPacketType, IRPCParseResult, IRPCPayload, IRPCPrimitive, IRPCPrimitiveSchema, IRPCReadable, IRPCRequest, IRPCRequests, IRPCResponse, IRPCSchema, IRPCSpec, IRPCSpecStore, IRPCStatus, IRPCStreamInit, IRPCStub, IRPCStubStore, StreamCleanup, StreamConstructor, TransportConfig };
+export { IRPCArraySchema, IRPCCallConfig, IRPCContext, IRPCContextProvider, IRPCCredentials, IRPCCredentialsFactory, IRPCCrudField, IRPCCrudMeta, IRPCCrudMethod, IRPCCrudOptions, IRPCCrudStubs, IRPCData, IRPCDataSchema, IRPCDeclareConfig, IRPCDeclareInit, IRPCDefined, IRPCDriver, IRPCEntityId, IRPCFunction, IRPCHandler, IRPCInferInit, IRPCInit, IRPCInputs, IRPCObject, IRPCObjectSchema, IRPCOutput, IRPCPackageConfig, IRPCPackageInfo, IRPCPacketAnswer, IRPCPacketBase, IRPCPacketCall, IRPCPacketClose, IRPCPacketError, IRPCPacketEvent, IRPCPacketStream, IRPCPacketType, IRPCParseResult, IRPCPayload, IRPCPrimitive, IRPCPrimitiveSchema, IRPCReadable, IRPCRequest, IRPCRequests, IRPCResponse, IRPCReturnOf, IRPCSchema, IRPCSpec, IRPCSpecStore, IRPCStatus, IRPCStreamInit, IRPCStub, IRPCStubStore, StreamCleanup, StreamConstructor, TransportConfig };

package/dist/types.js

@@ -1 +1,8 @@
-export {  };
+//#region src/types.ts
+/**
+* Base class for CRUD drivers that receive per-method resolved metadata on every call
+*/
+var IRPCDriver = class {};
+
+//#endregion
+export { IRPCDriver };

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@irpclib/irpc",
-  "version": "1.0.0-beta.24",
+  "version": "1.0.0",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
   "exports": {
@@ -14,7 +14,9 @@
       "import": "./dist/server/index.js"
     }
   },
-  "files": ["dist"],
+  "files": [
+    "dist"
+  ],
   "directories": {
     "dist": "./dist"
   },
@@ -50,6 +52,6 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@anchorlib/core": "^1.0.0-beta.24"
+    "@anchorlib/core": "^1.0.0"
   }
-}
+}