@microsoft/dev-tunnels-management 1.0.8 → 1.0.7303

package/tunnelManagementClient.d.ts

@@ -1,133 +1,133 @@
-/// <reference types="node" />
-import { ClusterDetails, Tunnel, TunnelConnectionMode, TunnelEndpoint, TunnelPort } from '@microsoft/dev-tunnels-contracts';
-import { TunnelRequestOptions } from './tunnelRequestOptions';
-import * as https from 'https';
-/**
- * Interface for a client that manages tunnels and tunnel ports
- * via the tunnel service management API.
- */
-export interface TunnelManagementClient {
-    /**
-     * Override https agent for axios requests.
-     */
-    httpsAgent?: https.Agent;
-    /**
-     * Lists tunnels that are owned by the caller.
-     *
-     * The list can be filtered by setting `TunnelRequestOptions.tags`. Ports will not be
-     * included in the returned tunnels unless `TunnelRequestOptions.includePorts` is set to true.
-     *
-     * @param clusterId A tunnel cluster ID, or null to list tunnels globally.
-     * @param domain Tunnel domain, or null for the default domain.
-     * @param options Request options.
-     */
-    listTunnels(clusterId?: string, domain?: string, options?: TunnelRequestOptions): Promise<Tunnel[]>;
-    /**
-     * Gets one tunnel by ID or name.
-     *
-     * Ports will not be included in the returned tunnel unless `TunnelRequestOptions.includePorts`
-     * is set to true.
-     *
-     * @param tunnel Tunnel object including at least either a tunnel name (globally unique,
-     * if configured) or tunnel ID and cluster ID.
-     * @param options Request options.
-     */
-    getTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel | null>;
-    /**
-     * Creates a tunnel.
-     * @param tunnel
-     * @param options
-     */
-    createTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
-    /**
-     * Updates properties of a tunnel.
-     * @param tunnel
-     * @param options
-     */
-    updateTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
-    /**
-     * Deletes a tunnel.
-     * @param tunnel
-     * @param options
-     */
-    deleteTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<boolean>;
-    /**
-     * Creates or updates an endpoint for the tunnel.
-     * @param tunnel
-     * @param endpoint
-     * @param options
-     */
-    updateTunnelEndpoint(tunnel: Tunnel, endpoint: TunnelEndpoint, options?: TunnelRequestOptions): Promise<TunnelEndpoint>;
-    /**
-     * Deletes a tunnel endpoint.
-     * @param tunnel
-     * @param hostId
-     * @param connectionMode
-     * @param options
-     */
-    deleteTunnelEndpoints(tunnel: Tunnel, hostId: string, connectionMode?: TunnelConnectionMode, options?: TunnelRequestOptions): Promise<boolean>;
-    /**
-     * Lists ports on a tunnel.
-     *
-     * The list can be filtered by setting `TunnelRequestOptions.tags`.
-     *
-     * @param tunnel Tunnel object including at least either a tunnel name (globally unique,
-     * if configured) or tunnel ID and cluster ID.
-     * @param options Request options.
-     */
-    listTunnelPorts(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<TunnelPort[]>;
-    /**
-     * Gets one port on a tunnel by port number.
-     * @param tunnel
-     * @param portNumber
-     * @param options
-     */
-    getTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<TunnelPort | null>;
-    /**
-     * Creates a tunnel port.
-     * @param tunnel
-     * @param tunnelPort
-     * @param options
-     */
-    createTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
-    /**
-     * Updates properties of a tunnel port.
-     * @param tunnel
-     * @param tunnelPort
-     * @param options
-     */
-    updateTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
-    /**
-     * Deletes a tunnel port.
-     * @param tunnel
-     * @param portNumber
-     * @param options
-     */
-    deleteTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<boolean>;
-    /**
-     * Lists details of tunneling service clusters in all supported Azure regions.
-     */
-    listClusters(): Promise<ClusterDetails[]>;
-}
-/**
- * Interface for the user agent product information for TunnelManagementClient
- */
-export interface ProductHeaderValue {
-    /**
-     * Product name.
-     */
-    name: string;
-    /**
-     * Product version. If not supplied, 'unknown' version is used.
-     */
-    version?: string;
-}
-export declare abstract class TunnelAuthenticationSchemes {
-    /** Authentication scheme for AAD (or Microsoft account) access tokens. */
-    static readonly aad = "aad";
-    /** Authentication scheme for GitHub access tokens. */
-    static readonly github = "github";
-    /** Authentication scheme for tunnel access tokens. */
-    static readonly tunnel = "tunnel";
-}
+/// <reference types="node" />
+import { ClusterDetails, Tunnel, TunnelConnectionMode, TunnelEndpoint, TunnelPort } from '@microsoft/dev-tunnels-contracts';
+import { TunnelRequestOptions } from './tunnelRequestOptions';
+import * as https from 'https';
+/**
+ * Interface for a client that manages tunnels and tunnel ports
+ * via the tunnel service management API.
+ */
+export interface TunnelManagementClient {
+    /**
+     * Override https agent for axios requests.
+     */
+    httpsAgent?: https.Agent;
+    /**
+     * Lists tunnels that are owned by the caller.
+     *
+     * The list can be filtered by setting `TunnelRequestOptions.tags`. Ports will not be
+     * included in the returned tunnels unless `TunnelRequestOptions.includePorts` is set to true.
+     *
+     * @param clusterId A tunnel cluster ID, or null to list tunnels globally.
+     * @param domain Tunnel domain, or null for the default domain.
+     * @param options Request options.
+     */
+    listTunnels(clusterId?: string, domain?: string, options?: TunnelRequestOptions): Promise<Tunnel[]>;
+    /**
+     * Gets one tunnel by ID or name.
+     *
+     * Ports will not be included in the returned tunnel unless `TunnelRequestOptions.includePorts`
+     * is set to true.
+     *
+     * @param tunnel Tunnel object including at least either a tunnel name (globally unique,
+     * if configured) or tunnel ID and cluster ID.
+     * @param options Request options.
+     */
+    getTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel | null>;
+    /**
+     * Creates a tunnel.
+     * @param tunnel
+     * @param options
+     */
+    createTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
+    /**
+     * Updates properties of a tunnel.
+     * @param tunnel
+     * @param options
+     */
+    updateTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
+    /**
+     * Deletes a tunnel.
+     * @param tunnel
+     * @param options
+     */
+    deleteTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<boolean>;
+    /**
+     * Creates or updates an endpoint for the tunnel.
+     * @param tunnel
+     * @param endpoint
+     * @param options
+     */
+    updateTunnelEndpoint(tunnel: Tunnel, endpoint: TunnelEndpoint, options?: TunnelRequestOptions): Promise<TunnelEndpoint>;
+    /**
+     * Deletes a tunnel endpoint.
+     * @param tunnel
+     * @param hostId
+     * @param connectionMode
+     * @param options
+     */
+    deleteTunnelEndpoints(tunnel: Tunnel, hostId: string, connectionMode?: TunnelConnectionMode, options?: TunnelRequestOptions): Promise<boolean>;
+    /**
+     * Lists ports on a tunnel.
+     *
+     * The list can be filtered by setting `TunnelRequestOptions.tags`.
+     *
+     * @param tunnel Tunnel object including at least either a tunnel name (globally unique,
+     * if configured) or tunnel ID and cluster ID.
+     * @param options Request options.
+     */
+    listTunnelPorts(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<TunnelPort[]>;
+    /**
+     * Gets one port on a tunnel by port number.
+     * @param tunnel
+     * @param portNumber
+     * @param options
+     */
+    getTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<TunnelPort | null>;
+    /**
+     * Creates a tunnel port.
+     * @param tunnel
+     * @param tunnelPort
+     * @param options
+     */
+    createTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
+    /**
+     * Updates properties of a tunnel port.
+     * @param tunnel
+     * @param tunnelPort
+     * @param options
+     */
+    updateTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
+    /**
+     * Deletes a tunnel port.
+     * @param tunnel
+     * @param portNumber
+     * @param options
+     */
+    deleteTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<boolean>;
+    /**
+     * Lists details of tunneling service clusters in all supported Azure regions.
+     */
+    listClusters(): Promise<ClusterDetails[]>;
+}
+/**
+ * Interface for the user agent product information for TunnelManagementClient
+ */
+export interface ProductHeaderValue {
+    /**
+     * Product name.
+     */
+    name: string;
+    /**
+     * Product version. If not supplied, 'unknown' version is used.
+     */
+    version?: string;
+}
+export declare abstract class TunnelAuthenticationSchemes {
+    /** Authentication scheme for AAD (or Microsoft account) access tokens. */
+    static readonly aad = "aad";
+    /** Authentication scheme for GitHub access tokens. */
+    static readonly github = "github";
+    /** Authentication scheme for tunnel access tokens. */
+    static readonly tunnel = "tunnel";
+}
 //# sourceMappingURL=tunnelManagementClient.d.ts.map

package/tunnelManagementClient.js

@@ -1,15 +1,15 @@
-"use strict";
-// Copyright (c) Microsoft Corporation.
-// Licensed under the MIT license.
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TunnelAuthenticationSchemes = void 0;
-class TunnelAuthenticationSchemes {
-}
-exports.TunnelAuthenticationSchemes = TunnelAuthenticationSchemes;
-/** Authentication scheme for AAD (or Microsoft account) access tokens. */
-TunnelAuthenticationSchemes.aad = 'aad';
-/** Authentication scheme for GitHub access tokens. */
-TunnelAuthenticationSchemes.github = 'github';
-/** Authentication scheme for tunnel access tokens. */
-TunnelAuthenticationSchemes.tunnel = 'tunnel';
+"use strict";
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TunnelAuthenticationSchemes = void 0;
+class TunnelAuthenticationSchemes {
+}
+exports.TunnelAuthenticationSchemes = TunnelAuthenticationSchemes;
+/** Authentication scheme for AAD (or Microsoft account) access tokens. */
+TunnelAuthenticationSchemes.aad = 'aad';
+/** Authentication scheme for GitHub access tokens. */
+TunnelAuthenticationSchemes.github = 'github';
+/** Authentication scheme for tunnel access tokens. */
+TunnelAuthenticationSchemes.tunnel = 'tunnel';
 //# sourceMappingURL=tunnelManagementClient.js.map

package/tunnelManagementHttpClient.d.ts

@@ -1,93 +1,93 @@
-/// <reference types="node" />
-import { Tunnel, TunnelConnectionMode, TunnelEndpoint, TunnelPort, ClusterDetails } from '@microsoft/dev-tunnels-contracts';
-import { ProductHeaderValue, TunnelManagementClient } from './tunnelManagementClient';
-import { TunnelRequestOptions } from './tunnelRequestOptions';
-import { Method } from 'axios';
-import * as https from 'https';
-declare type NullableIfNotBoolean<T> = T extends boolean ? T : T | null;
-export declare class TunnelManagementHttpClient implements TunnelManagementClient {
-    readonly httpsAgent?: https.Agent | undefined;
-    additionalRequestHeaders?: {
-        [header: string]: string;
-    };
-    private readonly baseAddress;
-    private readonly userTokenCallback;
-    private readonly userAgents;
-    trace: (msg: string) => void;
-    /**
-     * Initializes a new instance of the `TunnelManagementHttpClient` class
-     * with a client authentication callback, service URI, and HTTP handler.
-     *
-     * @param userAgent { name, version } object or a comment string to use as the User-Agent header.
-     * @param userTokenCallback Optional async callback for retrieving a client authentication
-     * header value with access token, for AAD or GitHub user authentication. This may be omitted
-     * for anonymous tunnel clients, or if tunnel access tokens will be specified via
-     * `TunnelRequestOptions.accessToken`.
-     * @param tunnelServiceUri Optional tunnel service URI (not including any path). Defaults to
-     * the global tunnel service URI.
-     * @param httpsAgent Optional agent that will be invoked for HTTPS requests to the tunnel
-     * service.
-     */
-    constructor(userAgents: (ProductHeaderValue | string)[] | ProductHeaderValue | string, userTokenCallback?: () => Promise<string | null>, tunnelServiceUri?: string, httpsAgent?: https.Agent | undefined);
-    listTunnels(clusterId?: string, domain?: string, options?: TunnelRequestOptions): Promise<Tunnel[]>;
-    getTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel | null>;
-    createTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
-    updateTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
-    deleteTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<boolean>;
-    updateTunnelEndpoint(tunnel: Tunnel, endpoint: TunnelEndpoint, options?: TunnelRequestOptions): Promise<TunnelEndpoint>;
-    deleteTunnelEndpoints(tunnel: Tunnel, hostId: string, connectionMode?: TunnelConnectionMode, options?: TunnelRequestOptions): Promise<boolean>;
-    listTunnelPorts(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<TunnelPort[]>;
-    getTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<TunnelPort | null>;
-    createTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
-    updateTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
-    deleteTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<boolean>;
-    listClusters(): Promise<ClusterDetails[]>;
-    /**
-     * Sends an HTTP request to the tunnel management API, targeting a specific tunnel.
-     * This protected method enables subclasses to support additional tunnel management APIs.
-     * @param method HTTP request method.
-     * @param tunnel Tunnel that the request is targeting.
-     * @param accessTokenScopes Required array of access scopes for tokens in `tunnel.accessTokens`
-     * that could be used to authorize the request.
-     * @param path Optional request sub-path relative to the tunnel.
-     * @param query Optional query string to append to the request.
-     * @param options Request options.
-     * @param body Optional request body object.
-     * @param allowNotFound If true, a 404 response is returned as a null or false result
-     * instead of an error.
-     * @returns Result of the request.
-     */
-    protected sendTunnelRequest<TResult>(method: Method, tunnel: Tunnel, accessTokenScopes: string[], path?: string, query?: string, options?: TunnelRequestOptions, body?: object, allowNotFound?: boolean): Promise<NullableIfNotBoolean<TResult>>;
-    /**
-     * Sends an HTTP request to the tunnel management API.
-     * This protected method enables subclasses to support additional tunnel management APIs.
-     * @param method HTTP request method.
-     * @param clusterId Optional tunnel service cluster ID to direct the request to. If unspecified,
-     * the request will use the global traffic-manager to find the nearest cluster.
-     * @param path Required request path.
-     * @param query Optional query string to append to the request.
-     * @param options Request options.
-     * @param body Optional request body object.
-     * @param allowNotFound If true, a 404 response is returned as a null or false result
-     * instead of an error.
-     * @returns Result of the request.
-     */
-    protected sendRequest<TResult>(method: Method, clusterId: string | undefined, path: string, query?: string, options?: TunnelRequestOptions, body?: object, allowNotFound?: boolean): Promise<NullableIfNotBoolean<TResult>>;
-    private getResponseErrorMessage;
-    private buildUri;
-    private buildUriForTunnel;
-    private getAxiosRequestConfig;
-    private convertTunnelForRequest;
-    private convertTunnelPortForRequest;
-    private tunnelRequestOptionsToQueryString;
-    /**
-     * Makes an HTTP request using Axios, while tracing request and response details.
-     */
-    private request;
-    private traceHeaders;
-    private traceAuthorizationHeader;
-    private traceContent;
-    private static replaceTokensInContent;
-}
-export {};
+/// <reference types="node" />
+import { Tunnel, TunnelConnectionMode, TunnelEndpoint, TunnelPort, ClusterDetails } from '@microsoft/dev-tunnels-contracts';
+import { ProductHeaderValue, TunnelManagementClient } from './tunnelManagementClient';
+import { TunnelRequestOptions } from './tunnelRequestOptions';
+import { Method } from 'axios';
+import * as https from 'https';
+declare type NullableIfNotBoolean<T> = T extends boolean ? T : T | null;
+export declare class TunnelManagementHttpClient implements TunnelManagementClient {
+    readonly httpsAgent?: https.Agent | undefined;
+    additionalRequestHeaders?: {
+        [header: string]: string;
+    };
+    private readonly baseAddress;
+    private readonly userTokenCallback;
+    private readonly userAgents;
+    trace: (msg: string) => void;
+    /**
+     * Initializes a new instance of the `TunnelManagementHttpClient` class
+     * with a client authentication callback, service URI, and HTTP handler.
+     *
+     * @param userAgent { name, version } object or a comment string to use as the User-Agent header.
+     * @param userTokenCallback Optional async callback for retrieving a client authentication
+     * header value with access token, for AAD or GitHub user authentication. This may be omitted
+     * for anonymous tunnel clients, or if tunnel access tokens will be specified via
+     * `TunnelRequestOptions.accessToken`.
+     * @param tunnelServiceUri Optional tunnel service URI (not including any path). Defaults to
+     * the global tunnel service URI.
+     * @param httpsAgent Optional agent that will be invoked for HTTPS requests to the tunnel
+     * service.
+     */
+    constructor(userAgents: (ProductHeaderValue | string)[] | ProductHeaderValue | string, userTokenCallback?: () => Promise<string | null>, tunnelServiceUri?: string, httpsAgent?: https.Agent | undefined);
+    listTunnels(clusterId?: string, domain?: string, options?: TunnelRequestOptions): Promise<Tunnel[]>;
+    getTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel | null>;
+    createTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
+    updateTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<Tunnel>;
+    deleteTunnel(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<boolean>;
+    updateTunnelEndpoint(tunnel: Tunnel, endpoint: TunnelEndpoint, options?: TunnelRequestOptions): Promise<TunnelEndpoint>;
+    deleteTunnelEndpoints(tunnel: Tunnel, hostId: string, connectionMode?: TunnelConnectionMode, options?: TunnelRequestOptions): Promise<boolean>;
+    listTunnelPorts(tunnel: Tunnel, options?: TunnelRequestOptions): Promise<TunnelPort[]>;
+    getTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<TunnelPort | null>;
+    createTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
+    updateTunnelPort(tunnel: Tunnel, tunnelPort: TunnelPort, options?: TunnelRequestOptions): Promise<TunnelPort>;
+    deleteTunnelPort(tunnel: Tunnel, portNumber: number, options?: TunnelRequestOptions): Promise<boolean>;
+    listClusters(): Promise<ClusterDetails[]>;
+    /**
+     * Sends an HTTP request to the tunnel management API, targeting a specific tunnel.
+     * This protected method enables subclasses to support additional tunnel management APIs.
+     * @param method HTTP request method.
+     * @param tunnel Tunnel that the request is targeting.
+     * @param accessTokenScopes Required array of access scopes for tokens in `tunnel.accessTokens`
+     * that could be used to authorize the request.
+     * @param path Optional request sub-path relative to the tunnel.
+     * @param query Optional query string to append to the request.
+     * @param options Request options.
+     * @param body Optional request body object.
+     * @param allowNotFound If true, a 404 response is returned as a null or false result
+     * instead of an error.
+     * @returns Result of the request.
+     */
+    protected sendTunnelRequest<TResult>(method: Method, tunnel: Tunnel, accessTokenScopes: string[], path?: string, query?: string, options?: TunnelRequestOptions, body?: object, allowNotFound?: boolean): Promise<NullableIfNotBoolean<TResult>>;
+    /**
+     * Sends an HTTP request to the tunnel management API.
+     * This protected method enables subclasses to support additional tunnel management APIs.
+     * @param method HTTP request method.
+     * @param clusterId Optional tunnel service cluster ID to direct the request to. If unspecified,
+     * the request will use the global traffic-manager to find the nearest cluster.
+     * @param path Required request path.
+     * @param query Optional query string to append to the request.
+     * @param options Request options.
+     * @param body Optional request body object.
+     * @param allowNotFound If true, a 404 response is returned as a null or false result
+     * instead of an error.
+     * @returns Result of the request.
+     */
+    protected sendRequest<TResult>(method: Method, clusterId: string | undefined, path: string, query?: string, options?: TunnelRequestOptions, body?: object, allowNotFound?: boolean): Promise<NullableIfNotBoolean<TResult>>;
+    private getResponseErrorMessage;
+    private buildUri;
+    private buildUriForTunnel;
+    private getAxiosRequestConfig;
+    private convertTunnelForRequest;
+    private convertTunnelPortForRequest;
+    private tunnelRequestOptionsToQueryString;
+    /**
+     * Makes an HTTP request using Axios, while tracing request and response details.
+     */
+    private request;
+    private traceHeaders;
+    private traceAuthorizationHeader;
+    private traceContent;
+    private static replaceTokensInContent;
+}
+export {};
 //# sourceMappingURL=tunnelManagementHttpClient.d.ts.map