twilio 5.10.7 → 5.11.0

package/lib/jwt/taskrouter/TaskRouterCapability.js

@@ -1,101 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Policy = void 0;
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-/**
- * Create a new Policy
- */
-class Policy {
-    /**
-     * Create a new Policy instance
-     *
-     * @param options - ...
-     * @param options.url - Policy URL
-     * @param options.method - HTTP Method
-     * @param options.queryFilter - Request query filter allowances
-     * @param options.postFilter - Request post filter allowances
-     * @param options.allowed - Allow the policy
-     */
-    constructor(options) {
-        options = options || {};
-        this.url = options.url || "";
-        this.method = options.method || "GET";
-        this.queryFilter = options.queryFilter || {};
-        this.postFilter = options.postFilter || {};
-        this.allow = options.allow || true;
-    }
-    payload() {
-        return {
-            url: this.url,
-            method: this.method,
-            query_filter: this.queryFilter,
-            post_filter: this.postFilter,
-            allow: this.allow,
-        };
-    }
-}
-exports.Policy = Policy;
-class TaskRouterCapability {
-    /**
-     * @param options - ...
-     * @param options.accountSid - account sid
-     * @param options.authToken - auth token
-     * @param options.workspaceSid - workspace sid
-     * @param options.channelId - taskrouter channel id
-     * @param options.friendlyName - friendly name for the jwt
-     * @param options.ttl - time to live
-     * @param options.version - taskrouter version
-     */
-    constructor(options) {
-        if (!options) {
-            throw new Error('Required parameter "options" missing.');
-        }
-        if (!options.accountSid) {
-            throw new Error('Required parameter "options.accountSid" missing.');
-        }
-        if (!options.authToken) {
-            throw new Error('Required parameter "options.authToken" missing.');
-        }
-        if (!options.workspaceSid) {
-            throw new Error('Required parameter "options.workspaceSid" missing.');
-        }
-        if (!options.channelId) {
-            throw new Error('Required parameter "options.channelId" missing.');
-        }
-        this.accountSid = options.accountSid;
-        this.authToken = options.authToken;
-        this.workspaceSid = options.workspaceSid;
-        this.channelId = options.channelId;
-        this.friendlyName = options.friendlyName;
-        this.ttl = options.ttl || 3600;
-        this.version = options.version || "v1";
-        this.policies = [];
-    }
-    addPolicy(policy) {
-        this.policies.push(policy);
-    }
-    toJwt() {
-        var payload = {
-            iss: this.accountSid,
-            exp: Math.floor(new Date().valueOf() / 1000) + this.ttl,
-            version: this.version,
-            friendly_name: this.friendlyName,
-            account_sid: this.accountSid,
-            channel: this.channelId,
-            workspace_sid: this.workspaceSid,
-            policies: this.policies.map((policy) => policy.payload()),
-        };
-        if (this.channelId.startsWith("WK")) {
-            payload.worker_sid = this.channelId;
-        }
-        else if (this.channelId.startsWith("WQ")) {
-            payload.taskqueue_sid = this.channelId;
-        }
-        return jsonwebtoken_1.default.sign(payload, this.authToken);
-    }
-}
-TaskRouterCapability.Policy = Policy;
-exports.default = TaskRouterCapability;

package/lib/jwt/taskrouter/util.d.ts

@@ -1,66 +0,0 @@
-import { Policy } from "./TaskRouterCapability";
-/**
- * Build the default Policies for a worker
- *
- * @param version - TaskRouter version
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @returns list of Policies
- */
-export declare function defaultWorkerPolicies(version: string, workspaceSid: string, workerSid: string): Policy[];
-/**
- * Build the default Event Bridge Policies
- *
- * @param accountSid - account sid
- * @param channelId - channel id
- * @returns list of Policies
- */
-export declare function defaultEventBridgePolicies(accountSid: string, channelId: string): Policy[];
-/**
- * Generate TaskRouter workspace url
- *
- * @param workspaceSid - workspace sid or '**' for all workspaces
- * @returns generated url
- */
-export declare function workspacesUrl(workspaceSid?: string): string;
-/**
- * Generate TaskRouter task queue url
- *
- * @param workspaceSid - workspace sid
- * @param taskQueueSid - task queue sid or '**' for all task queues
- * @returns generated url
- */
-export declare function taskQueuesUrl(workspaceSid: string, taskQueueSid?: string): string;
-/**
- * Generate TaskRouter task url
- *
- * @param workspaceSid - workspace sid
- * @param taskSid - task sid or '**' for all tasks
- * @returns generated url
- */
-export declare function tasksUrl(workspaceSid: string, taskSid?: string): string;
-/**
- * Generate TaskRouter activity url
- *
- * @param workspaceSid - workspace sid
- * @param activitySid - activity sid or '**' for all activities
- * @returns generated url
- */
-export declare function activitiesUrl(workspaceSid: string, activitySid?: string): string;
-/**
- * Generate TaskRouter worker url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid or '**' for all workers
- * @returns generated url
- */
-export declare function workersUrl(workspaceSid: string, workerSid?: string): string;
-/**
- * Generate TaskRouter worker reservation url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @param reservationSid - reservation sid or '**' for all reservations
- * @returns generated url
- */
-export declare function reservationsUrl(workspaceSid: string, workerSid: string, reservationSid?: string): string;

package/lib/jwt/taskrouter/util.js

@@ -1,168 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultWorkerPolicies = defaultWorkerPolicies;
-exports.defaultEventBridgePolicies = defaultEventBridgePolicies;
-exports.workspacesUrl = workspacesUrl;
-exports.taskQueuesUrl = taskQueuesUrl;
-exports.tasksUrl = tasksUrl;
-exports.activitiesUrl = activitiesUrl;
-exports.workersUrl = workersUrl;
-exports.reservationsUrl = reservationsUrl;
-const TaskRouterCapability_1 = require("./TaskRouterCapability");
-const EVENT_URL_BASE = "https://event-bridge.twilio.com/v1/wschannels";
-const TASKROUTER_BASE_URL = "https://taskrouter.twilio.com";
-const TASKROUTER_VERSION = "v1";
-/**
- * Build the default Policies for a worker
- *
- * @param version - TaskRouter version
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @returns list of Policies
- */
-function defaultWorkerPolicies(version, workspaceSid, workerSid) {
-    var activities = new TaskRouterCapability_1.Policy({
-        url: [
-            TASKROUTER_BASE_URL,
-            version,
-            "Workspaces",
-            workspaceSid,
-            "Activities",
-        ].join("/"),
-        method: "GET",
-        allow: true,
-    });
-    var tasks = new TaskRouterCapability_1.Policy({
-        url: [
-            TASKROUTER_BASE_URL,
-            version,
-            "Workspaces",
-            workspaceSid,
-            "Tasks",
-            "**",
-        ].join("/"),
-        method: "GET",
-        allow: true,
-    });
-    var reservations = new TaskRouterCapability_1.Policy({
-        url: [
-            TASKROUTER_BASE_URL,
-            version,
-            "Workspaces",
-            workspaceSid,
-            "Workers",
-            workerSid,
-            "Reservations",
-            "**",
-        ].join("/"),
-        method: "GET",
-        allow: true,
-    });
-    var workerFetch = new TaskRouterCapability_1.Policy({
-        url: [
-            TASKROUTER_BASE_URL,
-            version,
-            "Workspaces",
-            workspaceSid,
-            "Workers",
-            workerSid,
-        ].join("/"),
-        method: "GET",
-        allow: true,
-    });
-    return [activities, tasks, reservations, workerFetch];
-}
-/**
- * Build the default Event Bridge Policies
- *
- * @param accountSid - account sid
- * @param channelId - channel id
- * @returns list of Policies
- */
-function defaultEventBridgePolicies(accountSid, channelId) {
-    var url = [EVENT_URL_BASE, accountSid, channelId].join("/");
-    return [
-        new TaskRouterCapability_1.Policy({
-            url: url,
-            method: "GET",
-            allow: true,
-        }),
-        new TaskRouterCapability_1.Policy({
-            url: url,
-            method: "POST",
-            allow: true,
-        }),
-    ];
-}
-/**
- * Generate TaskRouter workspace url
- *
- * @param workspaceSid - workspace sid or '**' for all workspaces
- * @returns generated url
- */
-function workspacesUrl(workspaceSid) {
-    return [TASKROUTER_BASE_URL, TASKROUTER_VERSION, "Workspaces", workspaceSid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}
-/**
- * Generate TaskRouter task queue url
- *
- * @param workspaceSid - workspace sid
- * @param taskQueueSid - task queue sid or '**' for all task queues
- * @returns generated url
- */
-function taskQueuesUrl(workspaceSid, taskQueueSid) {
-    return [workspacesUrl(workspaceSid), "TaskQueues", taskQueueSid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}
-/**
- * Generate TaskRouter task url
- *
- * @param workspaceSid - workspace sid
- * @param taskSid - task sid or '**' for all tasks
- * @returns generated url
- */
-function tasksUrl(workspaceSid, taskSid) {
-    return [workspacesUrl(workspaceSid), "Tasks", taskSid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}
-/**
- * Generate TaskRouter activity url
- *
- * @param workspaceSid - workspace sid
- * @param activitySid - activity sid or '**' for all activities
- * @returns generated url
- */
-function activitiesUrl(workspaceSid, activitySid) {
-    return [workspacesUrl(workspaceSid), "Activities", activitySid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}
-/**
- * Generate TaskRouter worker url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid or '**' for all workers
- * @returns generated url
- */
-function workersUrl(workspaceSid, workerSid) {
-    return [workspacesUrl(workspaceSid), "Workers", workerSid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}
-/**
- * Generate TaskRouter worker reservation url
- *
- * @param workspaceSid - workspace sid
- * @param workerSid - worker sid
- * @param reservationSid - reservation sid or '**' for all reservations
- * @returns generated url
- */
-function reservationsUrl(workspaceSid, workerSid, reservationSid) {
-    return [workersUrl(workspaceSid, workerSid), "Reservations", reservationSid]
-        .filter((item) => typeof item === "string")
-        .join("/");
-}

package/lib/jwt/validation/RequestCanonicalizer.d.ts

@@ -1,20 +0,0 @@
-declare class RequestCanonicalizer {
-    method: string;
-    uri: string;
-    queryParams: Record<string, string>;
-    requestBody: any;
-    headers: Record<string, string>;
-    constructor(method: string, uri: string, queryParams: Record<string, string>, requestBody: any, headers: Record<string, string>);
-    getCanonicalizedMethod(): string;
-    customEncode(str: string): string;
-    ASCIICompare(a: string, b: string): number;
-    getCanonicalizedPath(): string;
-    getCanonicalizedQueryParams(): string;
-    getCanonicalizedHeaders(): string;
-    getCanonicalizedHashedHeaders(): string;
-    getCanonicalizedRequestBody(): string;
-    sha256Hex(body: string): string;
-    getCanonicalizedRequestString(): string;
-    create(): string;
-}
-export default RequestCanonicalizer;

package/lib/jwt/validation/RequestCanonicalizer.js

@@ -1,97 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const crypto_1 = __importDefault(require("crypto"));
-class RequestCanonicalizer {
-    constructor(method, uri, queryParams, requestBody, headers) {
-        this.method = method;
-        this.uri = uri;
-        this.queryParams = queryParams;
-        this.requestBody = requestBody;
-        this.headers = headers;
-    }
-    getCanonicalizedMethod() {
-        return this.method.toUpperCase();
-    }
-    customEncode(str) {
-        return encodeURIComponent(decodeURIComponent(str))
-            .replace(/\*/g, "%2A")
-            .replace(/%7E/g, "~");
-    }
-    ASCIICompare(a, b) {
-        if (a < b)
-            return -1;
-        return a > b ? 1 : 0;
-    }
-    getCanonicalizedPath() {
-        // Remove query string from path
-        const path = this.uri.split("?")[0];
-        // Normalize duplicate slashes (but preserve the leading one)
-        const normalizedPath = path.replace(/\/+/g, "/");
-        // We must preserve slashes (as path delimiters) but encode each segment
-        // Split and encode, but first decode each segment to avoid double-encoding
-        return normalizedPath
-            .split("/")
-            .map((segment) => this.customEncode(segment))
-            .join("/");
-    }
-    getCanonicalizedQueryParams() {
-        if (!this.queryParams) {
-            return "";
-        }
-        // sort query params on the basis of '{key}={value}'
-        const sortedQueryParams = Object.entries(this.queryParams)
-            .map(([key, value]) => {
-            return `${key}=${value}`;
-        })
-            .sort((a, b) => this.ASCIICompare(a, b)) // forces ASCII sorting using custom compare
-            .map((param) => {
-            const [key, value] = param.split("=");
-            return `${this.customEncode(key)}=${this.customEncode(value)}`; // encode and concatenate as `key=value`
-        });
-        return sortedQueryParams.join("&");
-    }
-    getCanonicalizedHeaders() {
-        // sort headers on the basis of '{key}:{value}'
-        const sortedHeaders = Object.keys(this.headers)
-            .map((key) => {
-            if (!this.headers[key]) {
-                return `${key.toLowerCase()}:`;
-            }
-            return `${key.toLowerCase()}:${this.headers[key].trim()}`;
-        })
-            .sort((a, b) => this.ASCIICompare(a, b)); // forces ASCII sorting using custom compare
-        return `${sortedHeaders.join("\n")}\n`;
-    }
-    getCanonicalizedHashedHeaders() {
-        const sortedHeaders = Object.keys(this.headers).sort((a, b) => this.ASCIICompare(a, b)); // forces ASCII sorting using custom compare
-        return sortedHeaders.join(";");
-    }
-    getCanonicalizedRequestBody() {
-        if (!this.requestBody) {
-            return "";
-        }
-        if (typeof this.requestBody === "string") {
-            return this.sha256Hex(this.requestBody);
-        }
-        else
-            return this.sha256Hex(JSON.stringify(this.requestBody));
-    }
-    sha256Hex(body) {
-        return crypto_1.default.createHash("sha256").update(body).digest("hex");
-    }
-    getCanonicalizedRequestString() {
-        return `${this.getCanonicalizedMethod()}
-${this.getCanonicalizedPath()}
-${this.getCanonicalizedQueryParams()}
-${this.getCanonicalizedHeaders()}
-${this.getCanonicalizedHashedHeaders()}
-${this.getCanonicalizedRequestBody()}`;
-    }
-    create() {
-        return this.sha256Hex(this.getCanonicalizedRequestString());
-    }
-}
-exports.default = RequestCanonicalizer;

package/lib/jwt/validation/ValidationToken.d.ts

@@ -1,45 +0,0 @@
-import { ValidationClientOptions } from "../../base/ValidationClient";
-import RequestCanonicalizer from "./RequestCanonicalizer";
-import jwt, { Algorithm } from "jsonwebtoken";
-declare class ValidationToken {
-    static readonly DEFAULT_ALGORITHM: "RS256";
-    static readonly ALGORITHMS: readonly [jwt.Algorithm, jwt.Algorithm];
-    private readonly _accountSid;
-    private readonly _credentialSid;
-    private readonly _signingKey;
-    private readonly _privateKey;
-    private readonly _algorithm;
-    ttl: number;
-    get accountSid(): string;
-    get credentialSid(): string;
-    get signingKey(): string;
-    get privateKey(): string;
-    get algorithm(): Algorithm;
-    /**
-     * @constructor
-     * @param opts - The Options used to configure the ValidationToken
-     * @param opts.accountSid - The account SID
-     * @param opts.credentialSid - The credential SID for public key submitted to Twilio
-     * @param opts.signingKey - The signing key
-     * @param opts.privateKey - The private key for signing the token
-     * @param opts.algorithm - The algorithm to use for signing the token
-     * @param opts.ttl - The time to live for the token in seconds
-     */
-    constructor(opts: ValidationClientOptions);
-    /**
-     * Generates a `RequestCanonicalizer` instance for the given HTTP request.
-     *
-     * @param request - The HTTP request object containing details such as headers, URL, method, query parameters, and body.
-     * @throws {Error} If the request URL or method is missing.
-     * @returns {RequestCanonicalizer} - An instance of `RequestCanonicalizer` initialized with the canonicalized request details.
-     */
-    getRequestCanonicalizer(request: any): RequestCanonicalizer;
-    /**
-     * Generate a JWT token to include in the request header for PKCV
-     * @param request - The request object
-     * @returns {string} - The JWT token
-     */
-    fromHttpRequest(request: any): string;
-}
-declare namespace ValidationToken { }
-export = ValidationToken;

package/lib/jwt/validation/ValidationToken.js

@@ -1,121 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const RequestCanonicalizer_1 = __importDefault(require("./RequestCanonicalizer"));
-const jsonwebtoken_1 = __importDefault(require("jsonwebtoken"));
-class ValidationToken {
-    get accountSid() {
-        return this._accountSid;
-    }
-    get credentialSid() {
-        return this._credentialSid;
-    }
-    get signingKey() {
-        return this._signingKey;
-    }
-    get privateKey() {
-        return this._privateKey;
-    }
-    get algorithm() {
-        return this._algorithm;
-    }
-    /**
-     * @constructor
-     * @param opts - The Options used to configure the ValidationToken
-     * @param opts.accountSid - The account SID
-     * @param opts.credentialSid - The credential SID for public key submitted to Twilio
-     * @param opts.signingKey - The signing key
-     * @param opts.privateKey - The private key for signing the token
-     * @param opts.algorithm - The algorithm to use for signing the token
-     * @param opts.ttl - The time to live for the token in seconds
-     */
-    constructor(opts) {
-        if (!opts.accountSid) {
-            throw new Error("accountSid is required");
-        }
-        if (!opts.credentialSid) {
-            throw new Error("credentialSid is required");
-        }
-        if (!opts.signingKey) {
-            throw new Error("signingKey is required");
-        }
-        if (!opts.privateKey) {
-            throw new Error("privateKey is required");
-        }
-        const algorithm = opts.algorithm ?? ValidationToken.DEFAULT_ALGORITHM; // default to RS256;
-        if (!ValidationToken.ALGORITHMS.includes(algorithm)) {
-            throw new Error("Algorithm not supported. Allowed values are " +
-                ValidationToken.ALGORITHMS.join(", "));
-        }
-        this._accountSid = opts.accountSid;
-        this._credentialSid = opts.credentialSid;
-        this._signingKey = opts.signingKey;
-        this._privateKey = opts.privateKey;
-        this._algorithm = algorithm;
-        this.ttl = 300;
-    }
-    /**
-     * Generates a `RequestCanonicalizer` instance for the given HTTP request.
-     *
-     * @param request - The HTTP request object containing details such as headers, URL, method, query parameters, and body.
-     * @throws {Error} If the request URL or method is missing.
-     * @returns {RequestCanonicalizer} - An instance of `RequestCanonicalizer` initialized with the canonicalized request details.
-     */
-    getRequestCanonicalizer(request) {
-        const headers = request.headers ?? {};
-        const requestUrl = request.url;
-        const method = request.method;
-        const queryParams = request.params;
-        const requestBody = request.data;
-        if (!requestUrl) {
-            throw new Error("Url is required");
-        }
-        if (!method) {
-            throw new Error("Method is required");
-        }
-        const url = new URL(requestUrl);
-        let signedHeaders = {
-            host: url.host,
-            authorization: headers["Authorization"],
-        };
-        return new RequestCanonicalizer_1.default(method, url.pathname, queryParams, requestBody, signedHeaders);
-    }
-    /**
-     * Generate a JWT token to include in the request header for PKCV
-     * @param request - The request object
-     * @returns {string} - The JWT token
-     */
-    fromHttpRequest(request) {
-        try {
-            const requestCanonicalizer = this.getRequestCanonicalizer(request);
-            const canonicalizedRequest = requestCanonicalizer.create();
-            const header = {
-                cty: "twilio-pkrv;v=1",
-                typ: "JWT",
-                alg: this._algorithm,
-                kid: this._credentialSid,
-            };
-            const payload = {
-                iss: this._signingKey,
-                sub: this._accountSid,
-                hrh: requestCanonicalizer.getCanonicalizedHashedHeaders(),
-                rqh: canonicalizedRequest,
-            };
-            return jsonwebtoken_1.default.sign(payload, this._privateKey, {
-                header: header,
-                algorithm: this._algorithm,
-                expiresIn: this.ttl,
-            });
-        }
-        catch (err) {
-            throw new Error("Error generating JWT token " + err);
-        }
-    }
-}
-ValidationToken.DEFAULT_ALGORITHM = "RS256";
-ValidationToken.ALGORITHMS = [
-    "RS256",
-    "PS256",
-];
-module.exports = ValidationToken;

package/lib/rest/Accounts.d.ts

@@ -1,19 +0,0 @@
-import { AuthTokenPromotionListInstance } from "./accounts/v1/authTokenPromotion";
-import { CredentialListInstance } from "./accounts/v1/credential";
-import { SecondaryAuthTokenListInstance } from "./accounts/v1/secondaryAuthToken";
-import AccountsBase from "./AccountsBase";
-declare class Accounts extends AccountsBase {
-    /**
-     * @deprecated - Use v1.authTokenPromotion; instead
-     */
-    get authTokenPromotion(): AuthTokenPromotionListInstance;
-    /**
-     * @deprecated - Use v1.credentials; instead
-     */
-    get credentials(): CredentialListInstance;
-    /**
-     * @deprecated - Use v1.secondaryAuthToken; instead
-     */
-    get secondaryAuthToken(): SecondaryAuthTokenListInstance;
-}
-export = Accounts;

package/lib/rest/Accounts.js

@@ -1,29 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-const AccountsBase_1 = __importDefault(require("./AccountsBase"));
-class Accounts extends AccountsBase_1.default {
-    /**
-     * @deprecated - Use v1.authTokenPromotion; instead
-     */
-    get authTokenPromotion() {
-        console.warn("authTokenPromotion is deprecated. Use v1.authTokenPromotion; instead.");
-        return this.v1.authTokenPromotion;
-    }
-    /**
-     * @deprecated - Use v1.credentials; instead
-     */
-    get credentials() {
-        console.warn("credentials is deprecated. Use v1.credentials; instead.");
-        return this.v1.credentials;
-    }
-    /**
-     * @deprecated - Use v1.secondaryAuthToken; instead
-     */
-    get secondaryAuthToken() {
-        console.warn("secondaryAuthToken is deprecated. Use v1.secondaryAuthToken; instead.");
-        return this.v1.secondaryAuthToken;
-    }
-}
-module.exports = Accounts;

package/lib/rest/AccountsBase.d.ts

@@ -1,13 +0,0 @@
-import Domain from "../base/Domain";
-import V1 from "./accounts/V1";
-declare class AccountsBase extends Domain {
-    _v1?: V1;
-    /**
-     * Initialize accounts domain
-     *
-     * @param twilio - The twilio client
-     */
-    constructor(twilio: any);
-    get v1(): V1;
-}
-export = AccountsBase;