@trpc/server 9.23.5 → 9.25.0

package/src/adapters/lambda/utils.ts

@@ -0,0 +1,91 @@
+import type {
+  Context as APIGWContext,
+  APIGatewayProxyEvent,
+  APIGatewayProxyEventV2,
+  APIGatewayProxyResult,
+  APIGatewayProxyStructuredResultV2,
+} from 'aws-lambda';
+import type { ResponseMetaFn } from '../../http/internals/types';
+import type { AnyRouter, inferRouterContext } from '../../router';
+
+export type APIGatewayEvent = APIGatewayProxyEvent | APIGatewayProxyEventV2;
+export type APIGatewayResult =
+  | APIGatewayProxyResult
+  | APIGatewayProxyStructuredResultV2;
+
+export type CreateLambdaContextOptions<T extends APIGatewayEvent> = {
+  event: T;
+  context: APIGWContext;
+};
+export type LambdaCreateContextFn<
+  TRouter extends AnyRouter,
+  TEvent extends APIGatewayEvent,
+> = ({
+  event,
+  context,
+}: CreateLambdaContextOptions<TEvent>) =>
+  | inferRouterContext<TRouter>
+  | Promise<inferRouterContext<TRouter>>;
+
+export type AWSLambdaOptions<
+  TRouter extends AnyRouter,
+  TEvent extends APIGatewayEvent,
+> =
+  | {
+      router: TRouter;
+      batching?: {
+        enabled: boolean;
+      };
+      onError?: (options: Record<string, unknown>) => void;
+      responseMeta?: ResponseMetaFn<TRouter>;
+    } & (
+      | {
+          /**
+           * @link https://trpc.io/docs/context
+           **/
+          createContext: LambdaCreateContextFn<TRouter, TEvent>;
+        }
+      | {
+          /**
+           * @link https://trpc.io/docs/context
+           **/
+          createContext?: LambdaCreateContextFn<TRouter, TEvent>;
+        }
+    );
+
+export function isPayloadV1(
+  event: APIGatewayEvent,
+): event is APIGatewayProxyEvent {
+  return determinePayloadFormat(event) == '1.0';
+}
+export function isPayloadV2(
+  event: APIGatewayEvent,
+): event is APIGatewayProxyEventV2 {
+  return determinePayloadFormat(event) == '2.0';
+}
+
+function determinePayloadFormat(
+  event: APIGatewayEvent,
+): APIGatewayPayloadFormatVersion {
+  // https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html
+  // According to AWS support, version is is extracted from the version property in the event.
+  // If there is no version property, then the version is implied as 1.0
+  const unknownEvent = event as { version?: string };
+  if (typeof unknownEvent.version === 'undefined') {
+    return '1.0';
+  } else {
+    if (['1.0', '2.0'].includes(unknownEvent.version)) {
+      return unknownEvent.version as APIGatewayPayloadFormatVersion;
+    } else {
+      return 'custom';
+    }
+  }
+}
+export type DefinedAPIGatewayPayloadFormats = '1.0' | '2.0';
+export type APIGatewayPayloadFormatVersion =
+  | DefinedAPIGatewayPayloadFormats
+  | 'custom';
+
+export const UNKNOWN_PAYLOAD_FORMAT_VERSION_ERROR_MESSAGE =
+  'Custom payload format version not handled by this adapter. Please use either 1.0 or 2.0. More information here' +
+  'https://docs.aws.amazon.com/apigateway/latest/developerguide/http-api-develop-integrations-lambda.html';

package/src/adapters/ws.ts

@@ -1,7 +1,7 @@
 import http from 'http';
 import ws from 'ws';
 import { TRPCError } from '../TRPCError';
-import { BaseHandlerOptions } from '../internals/BaseHandlerOptions';
+import { BaseHandlerOptions } from '../internals/baseHandlerOptions';
 import { callProcedure } from '../internals/callProcedure';
 import { getErrorFromUnknown } from '../internals/errors';
 import { transformTRPCResponse } from '../internals/transformTRPCResponse';

package/src/http/index.ts

@@ -1,6 +1,6 @@
 import { assertNotBrowser } from '../assertNotBrowser';
 
 export * from './resolveHTTPResponse';
-export * from './ResponseMeta';
+export * from './responseMeta';
 
 assertNotBrowser();

package/src/http/internals/types.ts

@@ -8,7 +8,7 @@ import {
   inferRouterError,
 } from '@trpc/server';
 import { URLSearchParams } from 'url';
-import { BaseHandlerOptions } from '../../internals/BaseHandlerOptions';
+import { BaseHandlerOptions } from '../../internals/baseHandlerOptions';
 import { TRPCResponse } from '../../rpc';
 
 export type HTTPHeaders = Dict<string | string[]>;
@@ -26,7 +26,7 @@ export interface HTTPRequest {
   body: unknown;
 }
 
-type ResponseMetaFn<TRouter extends AnyRouter> = (opts: {
+export type ResponseMetaFn<TRouter extends AnyRouter> = (opts: {
   data: TRPCResponse<unknown, inferRouterError<TRouter>>[];
   ctx?: inferRouterContext<TRouter>;
   /**

package/src/index.ts

@@ -8,4 +8,4 @@ export * from './types';
 // deprecated
 export * from './deprecated/createHttpServer';
 export * from './deprecated/requestHandler';
-export * from './deprecated/LegacyRouter';
+export * from './deprecated/legacyRouter';

package/src/internals/{BaseHandlerOptions.ts → baseHandlerOptions.ts}

@@ -1,5 +1,5 @@
 import { AnyRouter } from '../router';
-import { OnErrorFunction } from './OnErrorFunction';
+import { OnErrorFunction } from './onErrorFunction';
 
 /**
  * Base interface for any response handler

package/src/internals/middlewares.ts

@@ -1,7 +1,10 @@
 import { TRPCError } from '../TRPCError';
 import { ProcedureType } from '../router';
 
-export const middlewareMarker = Symbol('middlewareMarker');
+export const middlewareMarker = 'middlewareMarker' as 'middlewareMarker' & {
+  __brand: 'middlewareMarker';
+};
+
 interface MiddlewareResultBase<TContext> {
   /**
    * All middlewares should pass through their `next()`'s output.

package/dist/declarations/src/deprecated/LegacyRouter.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"LegacyRouter.d.ts","sourceRoot":"../../../../src/deprecated","sources":["LegacyRouter.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC;AAE1B,OAAO,EAAE,YAAY,IAAI,MAAM,EAAE,MAAM,WAAW,CAAC"}

package/dist/declarations/src/http/ResponseMeta.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ResponseMeta.d.ts","sourceRoot":"../../../../src/http","sources":["ResponseMeta.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,YAAY;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC"}