@fastpix/fastpix-node 2.0.5 → 2.0.7

package/src/funcs/viewsGetDetails.ts

@@ -39,23 +39,24 @@ import { Result } from "../types/fp.js";
  *
  * If a developer receives a report of a poor viewing experience for a specific user. By using this endpoint with the users `viewId`, the developer can retrieve metrics like buffering duration, playback errors, and session length. This data allows the developer to pinpoint issues (such as poor connectivity or a browser-specific problem) and take steps to improve the user experience.
  *
- * Related guide: <a href="https://docs.fastpix.io/page/what-video-data-do-we-capture#/">What Video Data do we capture?</a>
+ * 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

@@ -39,7 +39,7 @@ import { Result } from "../types/fp.js";
  *
  *   2. Specify the timespan for which you want to retrieve the video views using the `timespan[]` parameter.
  *
- *   3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the `filterby[]` parameter. Get the dimensions by calling <a href="https://docs.fastpix.io/reference/list_dimensions">list the dimensions</a> endpoint.
+ *   3. Filter the views based on dimensions such as browser, device, video title, viewer ID, etc., using the `filterby[]` parameter. Get the dimensions by calling <a href="https://docs.fastpix.com/reference/list_dimensions">list the dimensions</a> endpoint.
  *
  *   4. Paginate the results using the `limit` and `offset` parameters.
  *
@@ -47,29 +47,30 @@ import { Result } from "../types/fp.js";
  *
  *   6. You receive a response containing the list of video views matching the specified criteria.
  *
- * Each view in the response includes a unique `viewId`. You can use this `viewId` with the  <a href="https://docs.fastpix.io/reference/get_video_view_details">Get Video View Details</a> endpoint to retrieve more detailed information about that specific view.
+ * Each view in the response includes a unique `viewId`. You can use this `viewId` with the  <a href="https://docs.fastpix.com/reference/get_video_view_details">Get Video View Details</a> endpoint to retrieve more detailed information about that specific view.
  *
  * #### Example
  *
  * If you manage a video streaming service and want to analyze content performance across devices and browsers. By calling the List Video Views endpoint with filters such as `browser_name` and `device_type`, you can identify which platforms are most popular with your audience. This information helps optimize content for widely used platforms and troubleshoot playback issues on less common devices.
  *
- *   Related guide: <a href="https://docs.fastpix.io/docs/audience-metrics">Audience metrics</a>, <a href="https://docs.fastpix.io/docs/understand-dashboard-ui#1-views-dashboard">Views dashboard</a>
+ *   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

@@ -45,23 +45,25 @@ import { Result } from "../types/fp.js";
  *
  *   5. You receive a response containing the list of top video views matching the specified criteria.
  *
- *   Related guide: <a href="https://docs.fastpix.io/page/how-to-get-top-performing-content">Get top-performing content</a>
+ *   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/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

@@ -17,7 +17,7 @@ export const ServerList = [
   /**
    * FastPix Video APIs
    */
-  "https://api.fastpix.io/v1/",
+  "https://api.fastpix.com/v1/",
 ] as const;
 
 export type SDKOptions = {
@@ -67,8 +67,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.7",
   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.7 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/files.ts

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

package/src/lib/http.ts

@@ -43,13 +43,13 @@ export type RequestErrorHook = (err: unknown, req: Request) => Awaitable<void>;
 export type ResponseHook = (res: Response, req: Request) => Awaitable<void>;
 
 export class HTTPClient {
-  private fetcher: Fetcher;
+  private readonly fetcher: Fetcher;
   private requestHooks: BeforeRequestHook[] = [];
   private requestErrorHooks: RequestErrorHook[] = [];
   private responseHooks: ResponseHook[] = [];
 
-  constructor(private options: HTTPClientOptions = {}) {
-    this.fetcher = options.fetcher || DEFAULT_FETCHER;
+  constructor(private readonly options: HTTPClientOptions = {}) {
+    this.fetcher = options.fetcher ?? DEFAULT_FETCHER;
   }
 
   async request(request: Request): Promise<Response> {
@@ -135,7 +135,7 @@ export class HTTPClient {
       throw new Error(`Invalid hook type: ${args[0]}`);
     }
 
-    const index = target.findIndex((v) => v === args[1]);
+    const index = target.indexOf(args[1]);
     if (index >= 0) {
       target.splice(index, 1);
     }
@@ -156,8 +156,12 @@ export class HTTPClient {
 export type StatusCodePredicate = number | string | (number | string)[];
 
 // A semicolon surrounded by optional whitespace characters is used to separate
-// segments in a media type string.
-const mediaParamSeparator = /\s*;\s*/g;
+// segments in a media type string. Splitting on the literal `;` and trimming
+// each segment avoids the super-linear backtracking of a `/\s*;\s*/` regex while
+// producing identical results for the (already trimmed) inputs used below.
+function splitMediaTypeSegments(value: string): string[] {
+  return value.split(";").map((segment) => segment.trim());
+}
 
 export function matchContentType(response: Response, pattern: string): boolean {
   // `*` is a special case which means anything is acceptable.
@@ -169,14 +173,14 @@ export function matchContentType(response: Response, pattern: string): boolean {
     response.headers.get("content-type")?.trim() || "application/octet-stream";
   contentType = contentType.toLowerCase();
 
-  const wantParts = pattern.toLowerCase().trim().split(mediaParamSeparator);
+  const wantParts = splitMediaTypeSegments(pattern.toLowerCase().trim());
   const [wantType = "", ...wantParams] = wantParts;
 
   if (wantType.split("/").length !== 2) {
     return false;
   }
 
-  const gotParts = contentType.split(mediaParamSeparator);
+  const gotParts = splitMediaTypeSegments(contentType);
   const [gotType = "", ...gotParams] = gotParts;
 
   const [type = "", subtype = ""] = gotType.split("/");
@@ -207,7 +211,7 @@ export function matchContentType(response: Response, pattern: string): boolean {
   return true;
 }
 
-const codeRangeRE = new RegExp("^[0-9]xx$", "i");
+const codeRangeRE = /^\dxx$/i;
 
 export function matchStatusCode(
   response: Response,

package/src/lib/matchers.ts

@@ -181,6 +181,95 @@ export type MatchFunc<T, E> = (
   options?: { resultKey?: string; extraFields?: Record<string, unknown> },
 ) => Promise<[result: Result<T, E>, raw: unknown]>;
 
+function selectMatcher<T, E>(
+  response: Response,
+  matchers: Array<Matcher<T, E>>,
+): Matcher<T, E> | undefined {
+  for (const match of matchers) {
+    const { codes } = match;
+    const ctpattern = "ctype" in match
+      ? match.ctype
+      : DEFAULT_CONTENT_TYPES[match.enc];
+    const matched = ctpattern
+      ? matchResponse(response, codes, ctpattern)
+      : matchStatusCode(response, codes);
+    if (matched) {
+      return match;
+    }
+  }
+  return undefined;
+}
+
+async function decodeResponseBody(
+  encoding: Encoding,
+  response: Response,
+): Promise<{ body: string; raw: unknown }> {
+  let body = "";
+  let raw: unknown;
+  switch (encoding) {
+    case "json":
+      body = await response.text();
+      raw = JSON.parse(body);
+      break;
+    case "jsonl":
+    case "stream":
+    case "sse":
+      raw = response.body;
+      break;
+    case "bytes":
+      raw = new Uint8Array(await response.arrayBuffer());
+      break;
+    case "text":
+    case "fail":
+      body = await response.text();
+      raw = body;
+      break;
+    case "nil":
+      body = await response.text();
+      raw = undefined;
+      break;
+    default:
+      encoding satisfies never;
+      throw new Error(`Unsupported response type: ${encoding}`);
+  }
+  return { body, raw };
+}
+
+function buildResponseData<T, E>(
+  matcher: ValueMatcher<T> | ErrorMatcher<E>,
+  raw: unknown,
+  context: {
+    request: Request;
+    response: Response;
+    body: string;
+    resultKey?: string | undefined;
+    extraFields?: Record<string, unknown> | undefined;
+  },
+): unknown {
+  const { request, response, body, resultKey, extraFields } = context;
+  const headers = matcher.hdrs
+    ? { Headers: unpackHeaders(response.headers) }
+    : null;
+
+  if ("err" in matcher) {
+    return {
+      ...extraFields,
+      ...headers,
+      ...(isPlainObject(raw) ? raw : null),
+      request$: request,
+      response$: response,
+      body$: body,
+    };
+  }
+  if (resultKey) {
+    return { ...extraFields, ...headers, [resultKey]: raw };
+  }
+  if (matcher.hdrs) {
+    return { ...extraFields, ...headers, ...(isPlainObject(raw) ? raw : null) };
+  }
+  return raw;
+}
+
 export function match<T, E>(
   ...matchers: Array<Matcher<T, E>>
 ): MatchFunc<T, E | FastpixDefaultError | ResponseValidationError> {
@@ -194,21 +283,7 @@ export function match<T, E>(
       raw: unknown,
     ]
   > {
-    let raw: unknown;
-    let matcher: Matcher<T, E> | undefined;
-    for (const match of matchers) {
-      const { codes } = match;
-      const ctpattern = "ctype" in match
-        ? match.ctype
-        : DEFAULT_CONTENT_TYPES[match.enc];
-      if (ctpattern && matchResponse(response, codes, ctpattern)) {
-        matcher = match;
-        break;
-      } else if (!ctpattern && matchStatusCode(response, codes)) {
-        matcher = match;
-        break;
-      }
-    }
+    const matcher = selectMatcher(response, matchers);
 
     if (!matcher) {
       return [{
@@ -218,44 +293,10 @@ export function match<T, E>(
           request,
           body: await response.text().catch(() => ""),
         }),
-      }, raw];
+      }, undefined];
     }
 
-    const encoding = matcher.enc;
-    let body = "";
-    switch (encoding) {
-      case "json":
-        body = await response.text();
-        raw = JSON.parse(body);
-        break;
-      case "jsonl":
-        raw = response.body;
-        break;
-      case "bytes":
-        raw = new Uint8Array(await response.arrayBuffer());
-        break;
-      case "stream":
-        raw = response.body;
-        break;
-      case "text":
-        body = await response.text();
-        raw = body;
-        break;
-      case "sse":
-        raw = response.body;
-        break;
-      case "nil":
-        body = await response.text();
-        raw = undefined;
-        break;
-      case "fail":
-        body = await response.text();
-        raw = body;
-        break;
-      default:
-        encoding satisfies never;
-        throw new Error(`Unsupported response type: ${encoding}`);
-    }
+    const { body, raw } = await decodeResponseBody(matcher.enc, response);
 
     if (matcher.enc === "fail") {
       return [{
@@ -268,33 +309,13 @@ export function match<T, E>(
       }, raw];
     }
 
-    const resultKey = matcher.key || options?.resultKey;
-    let data: unknown;
-
-    if ("err" in matcher) {
-      data = {
-        ...options?.extraFields,
-        ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
-        ...(isPlainObject(raw) ? raw : null),
-        request$: request,
-        response$: response,
-        body$: body,
-      };
-    } else if (resultKey) {
-      data = {
-        ...options?.extraFields,
-        ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
-        [resultKey]: raw,
-      };
-    } else if (matcher.hdrs) {
-      data = {
-        ...options?.extraFields,
-        ...(matcher.hdrs ? { Headers: unpackHeaders(response.headers) } : null),
-        ...(isPlainObject(raw) ? raw : null),
-      };
-    } else {
-      data = raw;
-    }
+    const data = buildResponseData(matcher, raw, {
+      request,
+      response,
+      body,
+      resultKey: matcher.key || options?.resultKey,
+      extraFields: options?.extraFields,
+    });
 
     if ("err" in matcher) {
       const result = safeParseResponse(

package/src/lib/primitives.ts

@@ -129,7 +129,7 @@ export function compactMap<T>(
   const out: Record<string, T> = {};
 
   for (const [k, v] of Object.entries(values)) {
-    if (typeof v !== "undefined") {
+    if (v !== undefined) {
       out[k] = v;
     }
   }