@fastpix/fastpix-node 2.0.6 → 2.0.8

package/src/funcs/signingKeysList.ts

@@ -43,21 +43,23 @@ import { Result } from "../types/fp.js";
  *
  * **Detailed example:**  You manage a multi-region video platform where teams in different regions use their own signing keys. To comply with your organization’s security policies, you regularly review the list of signing keys to verify which ones are still active. You notice that some keys haven’t been used for several months. Based on their creation dates, you decide to rotate those keys.
  */
-export function signingKeysList(
-  client: FastpixCore,
-  request?: operations.ListSigningKeysRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListSigningKeysResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function signingKeysList(
+  client: FastpixCore,
+  request?: operations.ListSigningKeysRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListSigningKeysResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -74,15 +76,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListSigningKeysResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListSigningKeysResponse,MyError
     >,
     APICall,
   ]
@@ -170,15 +164,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListSigningKeysResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListSigningKeysResponse,MyError
   >(
     M.json(200, operations.ListSigningKeysResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/simulcastStreamsDelete.ts

@@ -38,21 +38,22 @@ import { Result } from "../types/fp.js";
  * #### Example
  * A broadcaster may need to stop simulcasting to one platform while keeping the stream active on others. For example, a tech company is simulcasting a product launch across multiple platforms. Midway through the event, they decide to stop the simulcast on Facebook due to performance issues but continue streaming on YouTube. They use this API to delete the Facebook simulcast target.
  */
-export function simulcastStreamsDelete(
-  client: FastpixCore,
-  request: operations.DeleteSimulcastOfStreamRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.DeleteSimulcastOfStreamResponse,
-    | FastpixError
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function simulcastStreamsDelete(
+  client: FastpixCore,
+  request: operations.DeleteSimulcastOfStreamRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.DeleteSimulcastOfStreamResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -69,15 +70,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.DeleteSimulcastOfStreamResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.DeleteSimulcastOfStreamResponse,MyError
     >,
     APICall,
   ]
@@ -169,15 +162,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.DeleteSimulcastOfStreamResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.DeleteSimulcastOfStreamResponse,MyError
   >(
     M.json(200, operations.DeleteSimulcastOfStreamResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/simulcastsCreate.ts

@@ -43,21 +43,23 @@ import { Result } from "../types/fp.js";
  *
  * Related guide: <a href="https://docs.fastpix.com/docs/simulcast-to-3rd-party-platforms">Simulcast to 3rd party platforms</a>
  */
-export function simulcastsCreate(
-  client: FastpixCore,
-  request: operations.CreateSimulcastOfStreamRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.CreateSimulcastOfStreamResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function simulcastsCreate(
+  client: FastpixCore,
+  request: operations.CreateSimulcastOfStreamRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.CreateSimulcastOfStreamResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -74,15 +76,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.CreateSimulcastOfStreamResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.CreateSimulcastOfStreamResponse,MyError
     >,
     APICall,
   ]
@@ -169,15 +163,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.CreateSimulcastOfStreamResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.CreateSimulcastOfStreamResponse,MyError
   >(
     M.json(201, operations.CreateSimulcastOfStreamResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/simulcastsGet.ts

@@ -36,21 +36,23 @@ import { Result } from "../types/fp.js";
  * #### Example
  * This endpoint can be used to verify the status of the simulcast on external platforms before the live stream begins. For example, before starting a live gaming event, the organizer wants to ensure that the simulcast to Twitch is set up correctly. They retrieve the simulcast information to confirm that everything is properly configured.
  */
-export function simulcastsGet(
-  client: FastpixCore,
-  request: operations.GetSpecificSimulcastOfStreamRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.GetSpecificSimulcastOfStreamResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function simulcastsGet(
+  client: FastpixCore,
+  request: operations.GetSpecificSimulcastOfStreamRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetSpecificSimulcastOfStreamResponse,MyError
   >
 > {
   return new APIPromise($do(

package/src/funcs/simulcastsUpdate.ts

@@ -38,21 +38,23 @@ import { Result } from "../types/fp.js";
  * #### Example
  * When a `PATCH` request is made to this endpoint, the API updates the status of the simulcast. This can be useful for pausing or resuming a simulcast on a particular platform without stopping the parent live stream.
  */
-export function simulcastsUpdate(
-  client: FastpixCore,
-  request: operations.UpdateSpecificSimulcastOfStreamRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.UpdateSpecificSimulcastOfStreamResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function simulcastsUpdate(
+  client: FastpixCore,
+  request: operations.UpdateSpecificSimulcastOfStreamRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.UpdateSpecificSimulcastOfStreamResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -69,15 +71,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.UpdateSpecificSimulcastOfStreamResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.UpdateSpecificSimulcastOfStreamResponse,MyError
     >,
     APICall,
   ]
@@ -173,15 +167,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.UpdateSpecificSimulcastOfStreamResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.UpdateSpecificSimulcastOfStreamResponse,MyError
   >(
     M.json(
       200,

package/src/funcs/viewsGetDetails.ts

@@ -41,21 +41,22 @@ import { Result } from "../types/fp.js";
  *
  * Related guide: <a href="https://docs.fastpix.com/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
  */
-export function viewsGetDetails(
-  client: FastpixCore,
-  request: operations.GetVideoViewDetailsRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.GetVideoViewDetailsResponse,
-    | FastpixError
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function viewsGetDetails(
+  client: FastpixCore,
+  request: operations.GetVideoViewDetailsRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.GetVideoViewDetailsResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -72,15 +73,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.GetVideoViewDetailsResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.GetVideoViewDetailsResponse,MyError
     >,
     APICall,
   ]
@@ -166,15 +159,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.GetVideoViewDetailsResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.GetVideoViewDetailsResponse,MyError
   >(
     M.json(200, operations.GetVideoViewDetailsResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/viewsList.ts

@@ -55,21 +55,22 @@ import { Result } from "../types/fp.js";
  *
  *   Related guide: <a href="https://docs.fastpix.com/docs/audience-metrics">Audience metrics</a>, <a href="https://docs.fastpix.com/docs/understand-dashboard-ui#1-views-dashboard">Views dashboard</a>
  */
-export function viewsList(
-  client: FastpixCore,
-  request?: operations.ListVideoViewsRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListVideoViewsResponse,
-    | FastpixError
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function viewsList(
+  client: FastpixCore,
+  request?: operations.ListVideoViewsRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListVideoViewsResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -86,15 +87,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListVideoViewsResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListVideoViewsResponse,MyError
     >,
     APICall,
   ]
@@ -188,15 +181,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListVideoViewsResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListVideoViewsResponse,MyError
   >(
     M.json(200, operations.ListVideoViewsResponse$inboundSchema),
     M.fail("4XX"),

package/src/funcs/viewsListTopContent.ts

@@ -47,21 +47,23 @@ import { Result } from "../types/fp.js";
  *
  *   Related guide: <a href="https://docs.fastpix.com/page/how-to-get-top-performing-content">Get top-performing content</a>
  */
-export function viewsListTopContent(
-  client: FastpixCore,
-  request?: operations.ListByTopContentRequest | undefined,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    operations.ListByTopContentResponse,
-    | FastpixError
+
+type MyError=| FastpixError
     | ResponseValidationError
     | ConnectionError
     | RequestAbortedError
     | RequestTimeoutError
     | InvalidRequestError
     | UnexpectedClientError
-    | SDKValidationError
+    | SDKValidationError;
+
+export function viewsListTopContent(
+  client: FastpixCore,
+  request?: operations.ListByTopContentRequest | undefined,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    operations.ListByTopContentResponse,MyError
   >
 > {
   return new APIPromise($do(
@@ -78,15 +80,7 @@ async function $do(
 ): Promise<
   [
     Result<
-      operations.ListByTopContentResponse,
-      | FastpixError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
+      operations.ListByTopContentResponse,MyError
     >,
     APICall,
   ]
@@ -175,15 +169,7 @@ async function $do(
   const response = doResult.value;
 
   const [result] = await M.match<
-    operations.ListByTopContentResponse,
-    | FastpixError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
+    operations.ListByTopContentResponse,MyError
   >(
     M.json(200, operations.ListByTopContentResponse$inboundSchema),
     M.fail("4XX"),

package/src/hooks/hooks.ts

@@ -15,7 +15,6 @@ import {
   BeforeCreateRequestHook,
   BeforeRequestContext,
   BeforeRequestHook,
-  Hook,
   Hooks,
   SDKInitHook,
 } from "./types.js";
@@ -30,25 +29,6 @@ export class SDKHooks implements Hooks {
   afterErrorHooks: AfterErrorHook[] = [];
 
   constructor() {
-    const presetHooks: Array<Hook> = [];
-
-    for (const hook of presetHooks) {
-      if ("sdkInit" in hook) {
-        this.registerSDKInitHook(hook);
-      }
-      if ("beforeCreateRequest" in hook) {
-        this.registerBeforeCreateRequestHook(hook);
-      }
-      if ("beforeRequest" in hook) {
-        this.registerBeforeRequestHook(hook);
-      }
-      if ("afterSuccess" in hook) {
-        this.registerAfterSuccessHook(hook);
-      }
-      if ("afterError" in hook) {
-        this.registerAfterErrorHook(hook);
-      }
-    }
     initHooks(this);
   }
 

package/src/hooks/types.ts

@@ -13,7 +13,7 @@ export type HookContext = {
   baseURL: string | URL;
   operationID: string;
   oAuth2Scopes: string[] | null;
-  securitySource?: any | (() => Promise<any>);
+  securitySource?: any;
   retryConfig: RetryConfig;
   resolvedSecurity: SecurityState | null;
   options: SDKOptions;
@@ -21,10 +21,10 @@ export type HookContext = {
 
 export type Awaitable<T> = T | Promise<T>;
 
-export type BeforeCreateRequestContext = HookContext & {};
-export type BeforeRequestContext = HookContext & {};
-export type AfterSuccessContext = HookContext & {};
-export type AfterErrorContext = HookContext & {};
+export interface BeforeCreateRequestContext extends HookContext {}
+export interface BeforeRequestContext extends HookContext {}
+export interface AfterSuccessContext extends HookContext {}
+export interface AfterErrorContext extends HookContext {}
 
 /**
  * SDKInitHook is called when the SDK is initializing. The

package/src/index.ts

@@ -9,3 +9,4 @@ export * as files from "./lib/files.js";
 export { HTTPClient } from "./lib/http.js";
 export type { Fetcher, HTTPClientOptions } from "./lib/http.js";
 export * from "./sdk/sdk.js";
+export * from "./sdk/webhooks.js";

package/src/lib/base64.ts

@@ -11,7 +11,7 @@ export function bytesToBase64(u8arr: Uint8Array): string {
 }
 
 export function bytesFromBase64(encoded: string): Uint8Array {
-  return Uint8Array.from(atob(encoded), (c) => c.charCodeAt(0));
+  return Uint8Array.from(atob(encoded), (c) => c.codePointAt(0) ?? 0);
 }
 
 export function stringToBytes(str: string): Uint8Array {

package/src/lib/config.ts

@@ -26,6 +26,18 @@ export type SDKOptions = {
    */
   security?: models.Security | (() => Promise<models.Security>) | undefined;
 
+  /**
+   * The secret used to verify FastPix webhook signatures.
+   *
+   * This is the webhook signing secret shown in the FastPix dashboard, NOT the
+   * API password supplied via `security`. Keep the two separate: `security`
+   * authenticates outbound API requests, while `webhookSecret` verifies inbound
+   * webhook deliveries.
+   *
+   * Defaults to `process.env.FASTPIX_WEBHOOK_SECRET` when not provided.
+   */
+  webhookSecret?: string | null | undefined;
+
   httpClient?: HTTPClient;
   /**
    * Allows overriding the default server used by the SDK
@@ -67,8 +79,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "1.0.0",
-  sdkVersion: "2.0.5",
+  sdkVersion: "2.0.8",
   genVersion: "2.781.2",
   userAgent:
-    "fastpix-sdk/typescript 2.0.5 2.781.2 1.0.0 @fastpix/fastpix-node",
+    "fastpix-sdk/typescript 2.0.8 2.781.2 1.0.0 @fastpix/fastpix-node",
 } as const;

package/src/lib/dlv.ts

@@ -43,12 +43,10 @@ export function dlv<T = any>(
   obj: any,
   key: string | string[],
   def?: T,
-  p?: number,
   undef?: never,
 ): T | undefined {
   key = Array.isArray(key) ? key : key.split(".");
-  for (p = 0; p < key.length; p++) {
-    const k = key[p];
+  for (const k of key) {
     obj = k != null && obj ? obj[k] : undef;
   }
   return obj === undef ? def : obj;

package/src/lib/encodings.ts

@@ -294,7 +294,7 @@ export function encodeJSON(
   value: unknown,
   options?: { explode?: boolean; charEncoding?: "percent" | "none" },
 ): string | undefined {
-  if (typeof value === "undefined") {
+  if (value === undefined) {
     return;
   }
 
@@ -367,11 +367,24 @@ function serializeValue(value: unknown): string {
     return value.toISOString();
   } else if (value instanceof Uint8Array) {
     return bytesToBase64(value);
-  } else if (typeof value === "object") {
-    return JSON.stringify(value, jsonReplacer);
   }
 
-  return `${value}`;
+  switch (typeof value) {
+    case "object":
+      return JSON.stringify(value, jsonReplacer);
+    case "string":
+      return value;
+    case "symbol":
+      return value.toString();
+    case "function":
+      return value.name;
+    case "number":
+    case "bigint":
+    case "boolean":
+      return value.toString();
+    default:
+      return "";
+  }
 }
 
 function jsonReplacer(_: string, value: unknown): unknown {
@@ -498,6 +511,6 @@ export function appendForm(
       appendForm(fd, key, v);
     });
   } else {
-    fd.append(key, String(value));
+    fd.append(key, serializeValue(value));
   }
 }

package/src/lib/env.ts

@@ -10,14 +10,14 @@ import { dlv } from "./dlv.js";
 export interface Env {
   FASTPIX_USERNAME?: string | undefined;
   FASTPIX_PASSWORD?: string | undefined;
-
+  FASTPIX_WEBHOOK_SECRET?: string | undefined;
   FASTPIX_DEBUG?: boolean | undefined;
 }
 
 export const envSchema: z.ZodMiniType<Env, unknown> = z.object({
   FASTPIX_USERNAME: z.optional(z.string()),
   FASTPIX_PASSWORD: z.optional(z.string()),
-
+  FASTPIX_WEBHOOK_SECRET: z.optional(z.string()),
   FASTPIX_DEBUG: z.optional(z.coerce.boolean()),
 });
 

package/src/lib/files.ts

@@ -38,7 +38,7 @@ export async function readableStreamToArrayBuffer(
     offset += chunk.length;
   }
 
-  return concatenatedChunks.buffer as ArrayBuffer;
+  return concatenatedChunks.buffer;
 }
 
 /**