@trpc/server 10.0.0-alpha.21 → 10.0.0-alpha.22

package/src/rpc/envelopes.ts

@@ -1,31 +1,10 @@
+/* eslint-disable @typescript-eslint/no-namespace */
 import { ProcedureType } from '../router';
 import { TRPC_ERROR_CODE_NUMBER } from './codes';
 
-type JSONRPC2RequestId = number | string | null;
-
 /**
- * All requests/responses extends this shape
+ * Error response
  */
-interface JSONRPC2BaseEnvelope {
-  id: JSONRPC2RequestId;
-  jsonrpc?: '2.0';
-}
-
-interface JSONRPC2BaseRequest<TMethod extends string = string>
-  extends JSONRPC2BaseEnvelope {
-  method: TMethod;
-}
-interface JSONRPC2Request<TMethod extends string = string, TParams = unknown>
-  extends JSONRPC2BaseRequest<TMethod> {
-  params: TParams;
-}
-
-interface JSONRPC2ResultResponse<TResult = unknown>
-  extends JSONRPC2BaseEnvelope {
-  result: TResult;
-}
-
-// inner types
 export interface TRPCErrorShape<
   TCode extends number = TRPC_ERROR_CODE_NUMBER,
   TData extends Record<string, unknown> = Record<string, unknown>,
@@ -36,74 +15,114 @@ export interface TRPCErrorShape<
 }
 
 /**
- * The result data wrapped
+ * JSON-RPC 2.0 Specification
  */
-export type TRPCResult<TData = unknown> =
-  | {
-      type: 'data';
-      data: TData;
-    }
-  | {
-      type: 'started';
-    }
-  | {
-      type: 'stopped';
-    };
+export namespace JSONRPC2 {
+  export type RequestId = number | string | null;
+
+  /**
+   * All requests/responses extends this shape
+   */
+  export interface BaseEnvelope {
+    id?: RequestId;
+    jsonrpc?: '2.0';
+  }
+
+  export interface BaseRequest<TMethod extends string = string>
+    extends BaseEnvelope {
+    method: TMethod;
+  }
+
+  export interface Request<TMethod extends string = string, TParams = unknown>
+    extends BaseRequest<TMethod> {
+    params: TParams;
+  }
+
+  export interface ResultResponse<TResult = unknown> extends BaseEnvelope {
+    result: TResult;
+  }
+
+  export interface ErrorResponse<TError extends TRPCErrorShape = TRPCErrorShape>
+    extends BaseEnvelope {
+    error: TError;
+  }
+}
 
 /**
- * Request envelope
+ * TRPC HTTP Envelopes
  */
-export type TRPCRequest =
-  | JSONRPC2Request<'subscription.stop'>
-  | JSONRPC2Request<
-      ProcedureType,
-      {
-        path: string;
-        input: unknown;
-      }
-    >;
+
+export type TRPCRequest = JSONRPC2.Request<
+  ProcedureType,
+  { path: string; input: unknown }
+>;
+
+export type TRPCResult<TData = unknown> = { data: TData };
+
+export type TRPCErrorResponse<TError extends TRPCErrorShape = TRPCErrorShape> =
+  JSONRPC2.ErrorResponse<TError>;
+
+export type TRPCResponse<
+  TResult = unknown,
+  TError extends TRPCErrorShape = TRPCErrorShape,
+> = JSONRPC2.ResultResponse<TRPCResult<TResult>> | TRPCErrorResponse<TError>;
 
 /**
- * OK response
+ * HTTP WS Envelopes
  */
-export type TRPCResultResponse<TData = unknown> = JSONRPC2ResultResponse<
-  TRPCResult<TData>
->;
+
+export type TRPCRequestMessage = {
+  id: JSONRPC2.RequestId;
+} & TRPCRequest;
 
 /**
- * Generic response wrapper that is either a result or error
+ * The client asked the server to unsubscribe
  */
-export type TRPCResponse<
-  TData = unknown,
-  TError extends TRPCErrorShape = TRPCErrorShape,
-> = TRPCResultResponse<TData> | TRPCErrorResponse<TError>;
+export type TRPCSubscriptionStopNotification = {
+  id: null;
+} & JSONRPC2.BaseRequest<'subscription.stop'>;
 
 /**
- * Error response
+ * The client's outgoing request types
  */
-export interface TRPCErrorResponse<
+export type TRPCClientOutgoingRequest = TRPCSubscriptionStopNotification;
+
+/**
+ * The client's sent messages shape
+ */
+export type TRPCClientOutgoingMessage =
+  | TRPCRequestMessage
+  | ({ id: JSONRPC2.RequestId } & JSONRPC2.BaseRequest<'subscription.stop'>);
+
+export type TRPCResultMessage<TData = unknown> =
+  | ({ type: 'data' } & TRPCResult<TData>)
+  | { type: 'started' }
+  | { type: 'stopped' };
+
+export type TRPCResponseMessage<
+  TResult = unknown,
   TError extends TRPCErrorShape = TRPCErrorShape,
-> extends JSONRPC2BaseEnvelope {
-  error: TError;
-}
+> = { id: JSONRPC2.RequestId } & (
+  | JSONRPC2.ResultResponse<TRPCResultMessage<TResult>>
+  | TRPCErrorResponse<TError>
+);
 
 /**
  * The server asked the client to reconnect - useful when restarting/redeploying service
  */
-export interface TRPCReconnectNotification
-  extends JSONRPC2BaseRequest<'reconnect'> {
-  id: null;
-}
+export type TRPCReconnectNotification = {
+  id: JSONRPC2.RequestId;
+} & JSONRPC2.BaseRequest<'reconnect'>;
 
 /**
  * The client's incoming request types
  */
-export type TRPCClientIncomingRequest =
-  TRPCReconnectNotification /* could be extended in future */;
+export type TRPCClientIncomingRequest = TRPCReconnectNotification;
 
 /**
  * The client's received messages shape
  */
-export type TRPCClientIncomingMessage =
-  | TRPCResponse
-  | TRPCClientIncomingRequest;
+export type TRPCClientIncomingMessage<
+  TResult = unknown,
+  TError extends TRPCErrorShape = TRPCErrorShape,
+> = TRPCResponseMessage<TResult, TError> | TRPCClientIncomingRequest;

package/src/subscription.ts

@@ -1,135 +1,17 @@
-import { EventEmitter } from 'events';
 import { getErrorFromUnknown } from './internals/errors';
+import { Observable, Observer, observable } from './observable';
 
-interface SubscriptionEvents<TOutput> {
-  data: (data: TOutput) => void;
-  destroy: () => void;
-  error: (error: Error) => void;
-}
-declare interface SubscriptionEventEmitter<TOutput> {
-  on<U extends keyof SubscriptionEvents<TOutput>>(
-    event: U,
-    listener: SubscriptionEvents<TOutput>[U],
-  ): this;
-
-  once<U extends keyof SubscriptionEvents<TOutput>>(
-    event: U,
-    listener: SubscriptionEvents<TOutput>[U],
-  ): this;
-
-  emit<U extends keyof SubscriptionEvents<TOutput>>(
-    event: U,
-    ...args: Parameters<SubscriptionEvents<TOutput>[U]>
-  ): boolean;
-}
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-class SubscriptionEventEmitter<TOutput> extends EventEmitter {}
-
-type UnsubscribeFn = () => void;
-type EmitFn<TOutput> = (data: TOutput) => void;
-
-export type SubscriptionEmit<TOutput> = {
-  data: EmitFn<TOutput>;
-  error: EmitFn<Error>;
-};
-export type SubscriptionCallback<TOutput> = (
-  emit: SubscriptionEmit<TOutput>,
-) => UnsubscribeFn | Promise<UnsubscribeFn>;
-
-/**
- * @beta
- */
-export class Subscription<TOutput = unknown> {
-  private readonly events: SubscriptionEventEmitter<TOutput>;
-  private callback;
-  private isDestroyed: boolean;
-
-  constructor(callback: SubscriptionCallback<TOutput>) {
-    this.isDestroyed = false;
-    this.events = new SubscriptionEventEmitter<TOutput>();
-    this.callback = callback;
-  }
-
-  public destroy() {
-    if (this.isDestroyed) {
-      return;
-    }
-    // debug('Subscription.destroy()', reason);
-    this.isDestroyed = true;
-    this.events.emit('destroy');
-    this.events.removeAllListeners();
-  }
-
-  public async start() {
-    /* istanbul ignore next */
-    if (this.isDestroyed) {
-      throw new Error('Called start() on a destroyed subscription');
-    }
-    try {
-      const emit: SubscriptionEmit<TOutput> = {
-        error: (err) => this.emitError(err),
-        data: (data) => this.emitOutput(data),
-      };
-      const cancel = await this.callback(emit);
-      if (
-        this.isDestroyed
-        /* istanbul ignore next */
-      ) {
-        cancel();
-      } else {
-        this.events.on('destroy', cancel);
-      }
-    } catch (
-      cause
-      /* istanbul ignore next */
-    ) {
-      this.emitError(getErrorFromUnknown(cause));
-    }
-  }
-
-  /* istanbul ignore next */
-  /**
-   * @deprecated This method is just here to help with `inferSubscriptionOutput` which I can't get working without it
-   */
-  public output(): TOutput {
-    throw new Error('Not in use');
-  }
-
-  /**
-   * Emit data
-   */
-  emitOutput(data: TOutput) {
-    this.events.emit('data', data);
-  }
-  /**
-   * Emit error
-   */
-  emitError(err: Error) {
-    this.events.emit('error', err);
-  }
-
-  on(...args: Parameters<SubscriptionEventEmitter<TOutput>['on']>) {
-    return this.events.on(...args);
-  }
-  off(...args: Parameters<SubscriptionEventEmitter<TOutput>['off']>) {
-    return this.events.off(...args);
-  }
-}
-
-/**
- * @alpha Might be removed
- */
 export function subscriptionPullFactory<TOutput>(opts: {
   /**
    * The interval of how often the function should run
    */
   intervalMs: number;
-  pull(emit: SubscriptionEmit<TOutput>): void | Promise<void>;
-}): Subscription<TOutput> {
+  pull(emit: Observer<TOutput, unknown>): void | Promise<void>;
+}): Observable<TOutput, unknown> {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   let timer: any;
   let stopped = false;
-  async function _pull(emit: SubscriptionEmit<TOutput>) {
+  async function _pull(emit: Observer<TOutput, unknown>) {
     /* istanbul ignore next */
     if (stopped) {
       return;
@@ -146,7 +28,7 @@ export function subscriptionPullFactory<TOutput>(opts: {
     }
   }
 
-  return new Subscription<TOutput>((emit) => {
+  return observable<TOutput>((emit) => {
     _pull(emit).catch((err) => emit.error(getErrorFromUnknown(err)));
     return () => {
       clearTimeout(timer);

package/src/types.ts

@@ -46,3 +46,10 @@ export type ThenArg<T> = T extends PromiseLike<infer U> ? ThenArg<U> : T;
  * @public
  */
 export type Dict<T> = Record<string, T | undefined>;
+
+/**
+ * @internal
+ * Creates a "lower-priority" type inference.
+ * https://github.com/microsoft/TypeScript/issues/14829#issuecomment-322267089
+ */
+export type InferLast<T> = T & { [K in keyof T]: T[K] };

package/dist/internals/wrapCallSafe.d.ts

@@ -1,16 +0,0 @@
-declare type AsyncFn<T> = () => Promise<T> | T;
-/**
- * Wrap a function in a safe wrapper that never throws
- * Returns a discriminated union
- */
-export declare function wrapCallSafe<T>(fn: AsyncFn<T>): Promise<{
-    ok: true;
-    data: T;
-    error?: undefined;
-} | {
-    ok: false;
-    error: unknown;
-    data?: undefined;
-}>;
-export {};
-//# sourceMappingURL=wrapCallSafe.d.ts.map

package/dist/internals/wrapCallSafe.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"wrapCallSafe.d.ts","sourceRoot":"","sources":["../../src/internals/wrapCallSafe.ts"],"names":[],"mappings":"AAAA,aAAK,OAAO,CAAC,CAAC,IAAI,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;AACvC;;;GAGG;AACH,wBAAsB,YAAY,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC,CAAC;;;;;;;;GAanD"}

package/dist/subscription-4b936ba3.js

@@ -1,136 +0,0 @@
-'use strict';
-
-var events = require('events');
-var transformTRPCResponse = require('./transformTRPCResponse-a57d3226.js');
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-class SubscriptionEventEmitter extends events.EventEmitter {}
-
-/**
- * @beta
- */
-class Subscription {
-  constructor(callback) {
-    this.events = void 0;
-    this.callback = void 0;
-    this.isDestroyed = void 0;
-    this.isDestroyed = false;
-    this.events = new SubscriptionEventEmitter();
-    this.callback = callback;
-  }
-
-  destroy() {
-    if (this.isDestroyed) {
-      return;
-    } // debug('Subscription.destroy()', reason);
-
-
-    this.isDestroyed = true;
-    this.events.emit('destroy');
-    this.events.removeAllListeners();
-  }
-
-  async start() {
-    /* istanbul ignore next */
-    if (this.isDestroyed) {
-      throw new Error('Called start() on a destroyed subscription');
-    }
-
-    try {
-      const emit = {
-        error: err => this.emitError(err),
-        data: data => this.emitOutput(data)
-      };
-      const cancel = await this.callback(emit);
-
-      if (this.isDestroyed
-      /* istanbul ignore next */
-      ) {
-        cancel();
-      } else {
-        this.events.on('destroy', cancel);
-      }
-    } catch (cause
-    /* istanbul ignore next */
-    ) {
-      this.emitError(transformTRPCResponse.getErrorFromUnknown(cause));
-    }
-  }
-  /* istanbul ignore next */
-
-  /**
-   * @deprecated This method is just here to help with `inferSubscriptionOutput` which I can't get working without it
-   */
-
-
-  output() {
-    throw new Error('Not in use');
-  }
-  /**
-   * Emit data
-   */
-
-
-  emitOutput(data) {
-    this.events.emit('data', data);
-  }
-  /**
-   * Emit error
-   */
-
-
-  emitError(err) {
-    this.events.emit('error', err);
-  }
-
-  on(...args) {
-    return this.events.on(...args);
-  }
-
-  off(...args) {
-    return this.events.off(...args);
-  }
-
-}
-/**
- * @alpha Might be removed
- */
-
-function subscriptionPullFactory(opts) {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  let timer;
-  let stopped = false;
-
-  async function _pull(emit) {
-    /* istanbul ignore next */
-    if (stopped) {
-      return;
-    }
-
-    try {
-      await opts.pull(emit);
-    } catch (err
-    /* istanbul ignore next */
-    ) {
-      emit.error(transformTRPCResponse.getErrorFromUnknown(err));
-    }
-    /* istanbul ignore else */
-
-
-    if (!stopped) {
-      timer = setTimeout(() => _pull(emit), opts.intervalMs);
-    }
-  }
-
-  return new Subscription(emit => {
-    _pull(emit).catch(err => emit.error(transformTRPCResponse.getErrorFromUnknown(err)));
-
-    return () => {
-      clearTimeout(timer);
-      stopped = true;
-    };
-  });
-}
-
-exports.Subscription = Subscription;
-exports.subscriptionPullFactory = subscriptionPullFactory;

package/dist/subscription-8a85f253.mjs

@@ -1,133 +0,0 @@
-import { EventEmitter } from 'events';
-import { a as getErrorFromUnknown } from './transformTRPCResponse-9fdeecca.mjs';
-
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-class SubscriptionEventEmitter extends EventEmitter {}
-
-/**
- * @beta
- */
-class Subscription {
-  constructor(callback) {
-    this.events = void 0;
-    this.callback = void 0;
-    this.isDestroyed = void 0;
-    this.isDestroyed = false;
-    this.events = new SubscriptionEventEmitter();
-    this.callback = callback;
-  }
-
-  destroy() {
-    if (this.isDestroyed) {
-      return;
-    } // debug('Subscription.destroy()', reason);
-
-
-    this.isDestroyed = true;
-    this.events.emit('destroy');
-    this.events.removeAllListeners();
-  }
-
-  async start() {
-    /* istanbul ignore next */
-    if (this.isDestroyed) {
-      throw new Error('Called start() on a destroyed subscription');
-    }
-
-    try {
-      const emit = {
-        error: err => this.emitError(err),
-        data: data => this.emitOutput(data)
-      };
-      const cancel = await this.callback(emit);
-
-      if (this.isDestroyed
-      /* istanbul ignore next */
-      ) {
-        cancel();
-      } else {
-        this.events.on('destroy', cancel);
-      }
-    } catch (cause
-    /* istanbul ignore next */
-    ) {
-      this.emitError(getErrorFromUnknown(cause));
-    }
-  }
-  /* istanbul ignore next */
-
-  /**
-   * @deprecated This method is just here to help with `inferSubscriptionOutput` which I can't get working without it
-   */
-
-
-  output() {
-    throw new Error('Not in use');
-  }
-  /**
-   * Emit data
-   */
-
-
-  emitOutput(data) {
-    this.events.emit('data', data);
-  }
-  /**
-   * Emit error
-   */
-
-
-  emitError(err) {
-    this.events.emit('error', err);
-  }
-
-  on(...args) {
-    return this.events.on(...args);
-  }
-
-  off(...args) {
-    return this.events.off(...args);
-  }
-
-}
-/**
- * @alpha Might be removed
- */
-
-function subscriptionPullFactory(opts) {
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  let timer;
-  let stopped = false;
-
-  async function _pull(emit) {
-    /* istanbul ignore next */
-    if (stopped) {
-      return;
-    }
-
-    try {
-      await opts.pull(emit);
-    } catch (err
-    /* istanbul ignore next */
-    ) {
-      emit.error(getErrorFromUnknown(err));
-    }
-    /* istanbul ignore else */
-
-
-    if (!stopped) {
-      timer = setTimeout(() => _pull(emit), opts.intervalMs);
-    }
-  }
-
-  return new Subscription(emit => {
-    _pull(emit).catch(err => emit.error(getErrorFromUnknown(err)));
-
-    return () => {
-      clearTimeout(timer);
-      stopped = true;
-    };
-  });
-}
-
-export { Subscription as S, subscriptionPullFactory as s };

package/src/internals/wrapCallSafe.ts

@@ -1,19 +0,0 @@
-type AsyncFn<T> = () => Promise<T> | T;
-/**
- * Wrap a function in a safe wrapper that never throws
- * Returns a discriminated union
- */
-export async function wrapCallSafe<T>(fn: AsyncFn<T>) {
-  try {
-    const data = await fn();
-    return {
-      ok: true as const,
-      data,
-    };
-  } catch (cause) {
-    return {
-      ok: false as const,
-      error: cause,
-    };
-  }
-}

package/ws/dist/trpc-server-ws.cjs.d.ts

@@ -1 +0,0 @@
-export * from "../../dist/declarations/src/ws/index";

package/ws/dist/trpc-server-ws.cjs.dev.js

@@ -1,15 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var adapters_ws_dist_trpcServerAdaptersWs = require('../../adapters/ws/dist/trpc-server-adapters-ws.cjs.dev.js');
-require('../../dist/transformTRPCResponse-c654ea92.cjs.dev.js');
-require('../../dist/subscription-7de48383.cjs.dev.js');
-require('events');
-
-/**
- * @deprecated replace your import with `@trpc/server/adapters/ws`
- */
-const applyWSSHandler = adapters_ws_dist_trpcServerAdaptersWs.applyWSSHandler;
-
-exports.applyWSSHandler = applyWSSHandler;

package/ws/dist/trpc-server-ws.cjs.js

@@ -1,7 +0,0 @@
-'use strict';
-
-if (process.env.NODE_ENV === "production") {
-  module.exports = require("./trpc-server-ws.cjs.prod.js");
-} else {
-  module.exports = require("./trpc-server-ws.cjs.dev.js");
-}