@stream-io/node-sdk 0.3.0 → 0.4.0

package/src/types.ts

@@ -1,5 +1,40 @@
 export type OmitTypeId<T> = Omit<T, 'type' | 'id' | 'connection_id'>;
 
+export interface ApiConfig {
+  apiKey: string;
+  token: string;
+  baseUrl: string;
+  timeout: number;
+}
+
+export interface RequestMetadata {
+  responseHeaders: Headers;
+  rateLimit: RateLimit;
+  responseCode: number;
+  clientRequestId: string;
+}
+
+export type StreamResponse<T> = T & {
+  metadata: RequestMetadata;
+};
+
+export class StreamError extends Error {
+  constructor(
+    message: string,
+    public metadata: Partial<RequestMetadata>,
+    public code?: number,
+    errorOptions?: ErrorOptions,
+  ) {
+    super(message, errorOptions);
+  }
+}
+
+export interface RateLimit {
+  rateLimit?: number;
+  rateLimitRemaining?: number;
+  rateLimitReset?: Date;
+}
+
 interface BaseTokenPayload {
   user_id: string;
   exp: number;

package/src/utils/create-token.ts

@@ -2,7 +2,12 @@ import jwt, { Secret, SignOptions } from 'jsonwebtoken';
 
 export function JWTUserToken(
   apiSecret: Secret,
-  payload: { user_id: string; exp: number; iat: number; call_cids?: string[] },
+  payload: {
+    user_id: string;
+    exp: number;
+    iat: number;
+    call_cids?: string[];
+  } & { [key: string]: any },
 ) {
   // make sure we return a clear error when jwt is shimmed (ie. browser build)
   if (jwt == null || jwt.sign == null) {

package/src/utils/rate-limit.ts

@@ -0,0 +1,21 @@
+import { RateLimit } from '../types';
+
+export const getRateLimitFromResponseHeader = (responseHeaders: Headers) => {
+  const rateLimit = responseHeaders.has('x-ratelimit-limit')
+    ? +responseHeaders.get('x-ratelimit-limit')!
+    : undefined;
+  const rateLimitRemaining = responseHeaders.has('x-ratelimit-remaining')
+    ? +responseHeaders.get('x-ratelimit-remaining')!
+    : undefined;
+  const rateLimitReset = responseHeaders.has('x-ratelimit-reset')
+    ? new Date(+responseHeaders.get('x-ratelimit-reset')! * 1000)
+    : undefined;
+
+  const result: RateLimit = {
+    rateLimit,
+    rateLimitRemaining,
+    rateLimitReset,
+  };
+
+  return result;
+};