@twilio/mcs-client 1.0.0-rc.5 → 1.0.0

package/builds/lib.d.ts

@@ -1,7 +1,46 @@
 /// <reference types="node" />
 import * as log from "loglevel";
 import * as loglevel from "loglevel";
-import { CancellablePromise } from "@twilio/shared";
+/**
+ * Cancellable promise. Extends the functionality of the native Promise to include the cancel method.
+ *
+ * Example:
+ *
+ * ```ts
+ *
+ * const cancellableFetchPromise = new CancellablePromise(async (resolve, reject, onCancel) => {
+ *     const request = fetch("https://example.com/");
+ *
+ *     onCancel(() => request.cancel());
+ *
+ *     try {
+ *         const response = await request;
+ *         resolve(response);
+ *     } catch (err) {
+ *         reject(err);
+ *     }
+ * });
+ *
+ * cancellableFetchPromise.cancel();
+ * ```
+ */
+declare class CancellablePromise<T> extends Promise<T> {
+    private readonly id;
+    private rejectPromise?;
+    private static readonly cancellationMap;
+    /**
+     * Creates a new CancellablePromise.
+     * @param executor A callback used to initialize the promise. This callback is passed three arguments:
+     * a resolve callback used to resolve the promise with a value or the result of another promise,
+     * a reject callback used to reject the promise with a provided reason or error,
+     * and an onCancel callback used to define behavior of cancellation.
+     */
+    constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: string | Error) => void, onCancel: (cancellationFunction: () => void) => void) => void);
+    /**
+     * Cancels the promise and invokes the cancellation callback if it was defined during instantiation. Cancellation will result in the promise being rejected.
+     */
+    cancel(): this;
+}
 type Headers = {
     [id: string]: string;
 };
@@ -65,6 +104,17 @@ declare class Network {
     post(url: string, category: MediaCategory | null, media: string | Buffer | Blob | FormData | Record<string, unknown>, contentType?: string, filename?: string): CancellablePromise<any>;
 }
 type MediaCategory = "media" | "body" | "history";
+/**
+ * @internal
+ * A subset of MediaRecord for Conversation-specific purposes.
+ */
+interface MediaState {
+    sid: string;
+    category: MediaCategory;
+    filename: string | null;
+    contentType: string;
+    size: number;
+}
 interface Links {
     content: string;
     content_direct_temporary?: string;
@@ -122,6 +172,11 @@ declare class Media {
      */
     getContentUrl(): CancellablePromise<string | null>;
     private _update;
+    /**
+     * @internal
+     * This payload is compatible with Conversations' media object _state().
+     */
+    _state(): MediaState;
 }
 interface Options$0 {
     region?: string;
@@ -191,5 +246,4 @@ declare class Client {
      */
     mediaSetGetContentUrls(mediaSids: string[]): CancellablePromise<Map<string, string>>;
 }
-export { CancellablePromise } from "@twilio/shared";
-export { Client, Client as McsClient, Client as default, Media, Media as McsMedia, MediaCategory, MediaCategory as McsMediaCategory };
+export { CancellablePromise, Client, Client as McsClient, Client as default, Media, Media as McsMedia, MediaCategory, MediaCategory as McsMediaCategory, MediaState, MediaState as McsMediaState };