@vscode/chat-lib 0.0.1

package/dist/src/_internal/platform/chat/common/chatQuotaServiceImpl.js

@@ -0,0 +1,99 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __param = (this && this.__param) || function (paramIndex, decorator) {
+    return function (target, key) { decorator(target, key, paramIndex); }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatQuotaService = void 0;
+const lifecycle_1 = require("../../../util/vs/base/common/lifecycle");
+const authentication_1 = require("../../authentication/common/authentication");
+let ChatQuotaService = class ChatQuotaService extends lifecycle_1.Disposable {
+    constructor(_authService) {
+        super();
+        this._authService = _authService;
+        this._register(this._authService.onDidAuthenticationChange(() => {
+            this.processUserInfoQuotaSnapshot(this._authService.copilotToken?.quotaInfo);
+        }));
+    }
+    get quotaExhausted() {
+        if (!this._quotaInfo) {
+            return false;
+        }
+        return this._quotaInfo.used >= this._quotaInfo.quota && !this._quotaInfo.overageEnabled && !this._quotaInfo.unlimited;
+    }
+    get overagesEnabled() {
+        if (!this._quotaInfo) {
+            return false;
+        }
+        return this._quotaInfo.overageEnabled;
+    }
+    clearQuota() {
+        this._quotaInfo = undefined;
+    }
+    processQuotaHeaders(headers) {
+        const quotaHeader = this._authService.copilotToken?.isFreeUser ? headers.get('x-quota-snapshot-chat') : headers.get('x-quota-snapshot-premium_models') || headers.get('x-quota-snapshot-premium_interactions');
+        if (!quotaHeader) {
+            return;
+        }
+        try {
+            // Parse URL encoded string into key-value pairs
+            const params = new URLSearchParams(quotaHeader);
+            // Extract values with fallbacks to ensure type safety
+            const entitlement = parseInt(params.get('ent') || '0', 10);
+            const overageUsed = parseFloat(params.get('ov') || '0.0');
+            const overageEnabled = params.get('ovPerm') === 'true';
+            const percentRemaining = parseFloat(params.get('rem') || '0.0');
+            const resetDateString = params.get('rst');
+            let resetDate;
+            if (resetDateString) {
+                resetDate = new Date(resetDateString);
+            }
+            else {
+                // Default to one month from now if not provided
+                resetDate = new Date();
+                resetDate.setMonth(resetDate.getMonth() + 1);
+            }
+            // Calculate used based on entitlement and remaining
+            const used = Math.max(0, entitlement * (1 - percentRemaining / 100));
+            // Update quota info
+            this._quotaInfo = {
+                quota: entitlement,
+                unlimited: entitlement === -1,
+                used,
+                overageUsed,
+                overageEnabled,
+                resetDate
+            };
+        }
+        catch (error) {
+            console.error('Failed to parse quota header', error);
+        }
+    }
+    processUserInfoQuotaSnapshot(quotaInfo) {
+        if (!quotaInfo || !quotaInfo.quota_snapshots || !quotaInfo.quota_reset_date) {
+            return;
+        }
+        this._quotaInfo = {
+            unlimited: quotaInfo.quota_snapshots.premium_interactions.unlimited,
+            overageEnabled: quotaInfo.quota_snapshots.premium_interactions.overage_permitted,
+            overageUsed: quotaInfo.quota_snapshots.premium_interactions.overage_count,
+            quota: quotaInfo.quota_snapshots.premium_interactions.entitlement,
+            resetDate: new Date(quotaInfo.quota_reset_date),
+            used: Math.max(0, quotaInfo.quota_snapshots.premium_interactions.entitlement * (1 - quotaInfo.quota_snapshots.premium_interactions.percent_remaining / 100)),
+        };
+    }
+};
+exports.ChatQuotaService = ChatQuotaService;
+exports.ChatQuotaService = ChatQuotaService = __decorate([
+    __param(0, authentication_1.IAuthenticationService)
+], ChatQuotaService);
+//# sourceMappingURL=chatQuotaServiceImpl.js.map

package/dist/src/_internal/platform/chat/common/chatQuotaServiceImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chatQuotaServiceImpl.js","sourceRoot":"","sources":["../../../../../../src/_internal/platform/chat/common/chatQuotaServiceImpl.ts"],"names":[],"mappings":";AAAA;;;gGAGgG;;;;;;;;;;;;AAEhG,sEAAoE;AACpE,+EAAoF;AAI7E,IAAM,gBAAgB,GAAtB,MAAM,gBAAiB,SAAQ,sBAAU;IAI/C,YAAqD,YAAoC;QACxF,KAAK,EAAE,CAAC;QAD4C,iBAAY,GAAZ,YAAY,CAAwB;QAExF,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,yBAAyB,CAAC,GAAG,EAAE;YAC/D,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QAC9E,CAAC,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,cAAc;QACjB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;IACvH,CAAC;IAED,IAAI,eAAe;QAClB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC;IACvC,CAAC;IAED,UAAU;QACT,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,mBAAmB,CAAC,OAAiB;QACpC,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,iCAAiC,CAAC,IAAI,OAAO,CAAC,GAAG,CAAC,uCAAuC,CAAC,CAAC;QAC/M,IAAI,CAAC,WAAW,EAAE,CAAC;YAClB,OAAO;QACR,CAAC;QAED,IAAI,CAAC;YACJ,gDAAgD;YAChD,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,WAAW,CAAC,CAAC;YAEhD,sDAAsD;YACtD,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;YAC3D,MAAM,WAAW,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,CAAC;YAC1D,MAAM,cAAc,GAAG,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,KAAK,MAAM,CAAC;YACvD,MAAM,gBAAgB,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,CAAC;YAChE,MAAM,eAAe,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;YAE1C,IAAI,SAAe,CAAC;YACpB,IAAI,eAAe,EAAE,CAAC;gBACrB,SAAS,GAAG,IAAI,IAAI,CAAC,eAAe,CAAC,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACP,gDAAgD;gBAChD,SAAS,GAAG,IAAI,IAAI,EAAE,CAAC;gBACvB,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,CAAC;YAC9C,CAAC;YAED,oDAAoD;YACpD,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,WAAW,GAAG,CAAC,CAAC,GAAG,gBAAgB,GAAG,GAAG,CAAC,CAAC,CAAC;YAErE,oBAAoB;YACpB,IAAI,CAAC,UAAU,GAAG;gBACjB,KAAK,EAAE,WAAW;gBAClB,SAAS,EAAE,WAAW,KAAK,CAAC,CAAC;gBAC7B,IAAI;gBACJ,WAAW;gBACX,cAAc;gBACd,SAAS;aACT,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YAChB,OAAO,CAAC,KAAK,CAAC,8BAA8B,EAAE,KAAK,CAAC,CAAC;QACtD,CAAC;IACF,CAAC;IAEO,4BAA4B,CAAC,SAA2C;QAC/E,IAAI,CAAC,SAAS,IAAI,CAAC,SAAS,CAAC,eAAe,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC;YAC7E,OAAO;QACR,CAAC;QACD,IAAI,CAAC,UAAU,GAAG;YACjB,SAAS,EAAE,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,SAAS;YACnE,cAAc,EAAE,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,iBAAiB;YAChF,WAAW,EAAE,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,aAAa;YACzE,KAAK,EAAE,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,WAAW;YACjE,SAAS,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,gBAAgB,CAAC;YAC/C,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,WAAW,GAAG,CAAC,CAAC,GAAG,SAAS,CAAC,eAAe,CAAC,oBAAoB,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC;SAC5J,CAAC;IACH,CAAC;CACD,CAAA;AArFY,4CAAgB;2BAAhB,gBAAgB;IAIf,WAAA,uCAAsB,CAAA;GAJvB,gBAAgB,CAqF5B"}

package/dist/src/_internal/platform/chat/common/commonTypes.d.ts

@@ -0,0 +1,264 @@
+import type { ChatErrorDetails, ChatResult } from 'vscode';
+import { APIErrorResponse, APIUsage, FilterReason } from '../../networking/common/openai';
+/**
+ * The location of a chat request.
+ */
+export declare enum ChatLocation {
+    /**
+     * The chat panel
+     */
+    Panel = 1,
+    /**
+     * Terminal inline chat
+     */
+    Terminal = 2,
+    /**
+     * Notebook inline chat
+     */
+    Notebook = 3,
+    /**
+     * Code editor inline chat
+     */
+    Editor = 4,
+    /**
+     * Chat is happening in an editing session.
+     * This location doesn't exist in vscode API, but is still used to compute the location sent for some intents.
+     */
+    EditingSession = 5,
+    /**
+     * The chat request does not correspond directly to a user chat request.
+     */
+    Other = 6,
+    /**
+     * The chat is an agent mode edit session.
+     */
+    Agent = 7
+}
+export declare namespace ChatLocation {
+    /**
+     * Use this for passing uiKind to github telemetry, which we don't want to impact.
+     * Also known as UIKind in the telemetry data.
+     */
+    function toString(chatLocation: ChatLocation): string;
+    /**
+     * This goes to logs and msft telemetry and is ok to change
+     */
+    function toStringShorter(chatLocation: ChatLocation): string;
+}
+export declare enum ChatFetchResponseType {
+    OffTopic = "offTopic",
+    Canceled = "canceled",
+    Filtered = "filtered",
+    FilteredRetry = "filteredRetry",
+    PromptFiltered = "promptFiltered",
+    Length = "length",
+    RateLimited = "rateLimited",
+    QuotaExceeded = "quotaExceeded",
+    ExtensionBlocked = "extensionBlocked",
+    BadRequest = "badRequest",
+    NotFound = "notFound",
+    Failed = "failed",
+    Unknown = "unknown",
+    NetworkError = "networkError",
+    AgentUnauthorized = "agent_unauthorized",
+    AgentFailedDependency = "agent_failed_dependency",
+    InvalidStatefulMarker = "invalid_stateful_marker",
+    Success = "success"
+}
+export type ChatFetchError = 
+/**
+ * We requested conversation, but the message was deemed off topic by the intent classifier.
+ */
+{
+    type: ChatFetchResponseType.OffTopic;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * Communication with a third party agent failed.
+ * The error message provides further details, usually indicating either an invocation timeout or an improper response.
+ */
+ | {
+    type: ChatFetchResponseType.AgentFailedDependency;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * User authorization is required to proceed.
+ */
+ | {
+    type: ChatFetchResponseType.AgentUnauthorized;
+    reason: string;
+    authorizationUrl: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * We requested conversation, but we decided to cancel mid-way, for example because the
+ * user requested cancelation.
+ */
+ | {
+    type: ChatFetchResponseType.Canceled;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * We requested conversation, but the response was filtered by RAI.
+ */
+ | {
+    type: ChatFetchResponseType.Filtered;
+    reason: string;
+    category: FilterReason;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * We requested conversation, but the prompt was filtered by RAI.
+ */
+ | {
+    type: ChatFetchResponseType.PromptFiltered;
+    reason: string;
+    category: FilterReason;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * We requested conversation, but the response was too long.
+ */
+ | {
+    type: ChatFetchResponseType.Length;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    truncatedValue: string;
+}
+/**
+ * We requested conversation, but didn't come up with any results because the rate limit was exceeded.
+ */
+ | {
+    type: ChatFetchResponseType.RateLimited;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    retryAfter: number | undefined;
+    rateLimitKey: string;
+    capiError?: {
+        code?: string;
+        message?: string;
+    };
+}
+/**
+ * We requested conversation, but didn't come up with any results because the free tier quota was exceeded.
+ */
+ | {
+    type: ChatFetchResponseType.QuotaExceeded;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    retryAfter: Date;
+    capiError?: {
+        code?: string;
+        message?: string;
+    };
+}
+/**
+ * We requested conversation, but the extension is blocked
+ */
+ | {
+    type: ChatFetchResponseType.ExtensionBlocked;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    retryAfter: number;
+    learnMoreLink: string;
+}
+/**
+ * We requested conversation, but didn't come up with any results because of a bad request
+ */
+ | {
+    type: ChatFetchResponseType.BadRequest;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+} | {
+    type: ChatFetchResponseType.NotFound;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * We requested conversation, but didn't come up with any results because something
+ * unexpected went wrong.
+ */
+ | {
+    type: ChatFetchResponseType.Failed;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    streamError?: APIErrorResponse;
+}
+/**
+ * We requested conversation, but didn't come up with any results because of a network error
+ */
+ | {
+    type: ChatFetchResponseType.NetworkError;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+    streamError?: APIErrorResponse;
+}
+/**
+ * We requested conversation, but didn't come up with any results for some "unknown"
+ * reason, such as slur redaction or snippy.
+ */
+ | {
+    type: ChatFetchResponseType.Unknown;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+}
+/**
+ * The `statefulMarker` present in the request was invalid or expired. The
+ * request may be retried without that marker to resubmit it anew.
+ */
+ | {
+    type: ChatFetchResponseType.InvalidStatefulMarker;
+    reason: string;
+    requestId: string;
+    serverRequestId: string | undefined;
+};
+export type ChatFetchRetriableError<T> = 
+/**
+ * We requested conversation, the response was filtered by RAI, but we want to retry.
+ */
+{
+    type: ChatFetchResponseType.FilteredRetry;
+    reason: string;
+    category: FilterReason;
+    value: T;
+    requestId: string;
+    serverRequestId: string | undefined;
+};
+export type FetchSuccess<T> = {
+    type: ChatFetchResponseType.Success;
+    value: T;
+    requestId: string;
+    serverRequestId: string | undefined;
+    usage: APIUsage | undefined;
+};
+export type FetchResponse<T> = FetchSuccess<T> | ChatFetchError;
+export type ChatResponse = FetchResponse<string>;
+export type ChatResponses = FetchResponse<string[]>;
+export declare function getErrorDetailsFromChatFetchError(fetchResult: ChatFetchError, copilotPlan: string, hideRateLimitTimeEstimate?: boolean): ChatErrorDetails;
+export declare function getFilteredMessage(category: FilterReason, supportsMarkdown?: boolean): string;
+/**
+ * Not localized because it's used in the same way that the CancellationError name is used.
+ */
+export declare const CanceledMessage: {
+    message: string;
+};
+export declare const CanceledResult: ChatResult;
+//# sourceMappingURL=commonTypes.d.ts.map

package/dist/src/_internal/platform/chat/common/commonTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commonTypes.d.ts","sourceRoot":"","sources":["../../../../../../src/_internal/platform/chat/common/commonTypes.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAG3D,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,gCAAgC,CAAC;AAE1F;;GAEG;AACH,oBAAY,YAAY;IACvB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,QAAQ,IAAI;IACZ;;OAEG;IACH,MAAM,IAAI;IACV;;;OAGG;IACH,cAAc,IAAI;IAClB;;OAEG;IACH,KAAK,IAAI;IACT;;OAEG;IACH,KAAK,IAAI;CACT;AAED,yBAAiB,YAAY,CAAC;IAE7B;;;OAGG;IACH,SAAgB,QAAQ,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAa3D;IAED;;OAEG;IACH,SAAgB,eAAe,CAAC,YAAY,EAAE,YAAY,GAAG,MAAM,CAYlE;CACD;AAED,oBAAY,qBAAqB;IAChC,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,aAAa,kBAAkB;IAC/B,cAAc,mBAAmB;IACjC,MAAM,WAAW;IACjB,WAAW,gBAAgB;IAC3B,aAAa,kBAAkB;IAC/B,gBAAgB,qBAAqB;IACrC,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,YAAY,iBAAiB;IAC7B,iBAAiB,uBAAuB;IACxC,qBAAqB,4BAA4B;IACjD,qBAAqB,4BAA4B;IACjD,OAAO,YAAY;CACnB;AAED,MAAM,MAAM,cAAc;AACzB;;GAEG;AACH;IAAE,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAChH;;;GAGG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,qBAAqB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAC/H;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,iBAAiB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AACrJ;;;GAGG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAClH;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAC1I;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,cAAc,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAChJ;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,cAAc,EAAE,MAAM,CAAA;CAAE;AACxI;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,WAAW,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,YAAY,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE;AAC5N;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,IAAI,CAAC;IAAC,SAAS,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE;AAC1L;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,gBAAgB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,aAAa,EAAE,MAAM,CAAA;CAAE;AACrK;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,UAAU,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAClH;IAAE,IAAI,EAAE,qBAAqB,CAAC,QAAQ,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AAClH;;;GAGG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAAE;AAChJ;;GAEG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,WAAW,CAAC,EAAE,gBAAgB,CAAA;CAAE;AACtJ;;;GAGG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE;AACjH;;;GAGG;GACD;IAAE,IAAI,EAAE,qBAAqB,CAAC,qBAAqB,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAC;AAEjI,MAAM,MAAM,uBAAuB,CAAC,CAAC;AACpC;;GAEG;AACH;IAAE,IAAI,EAAE,qBAAqB,CAAC,aAAa,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,YAAY,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,CAAA;AAExJ,MAAM,MAAM,YAAY,CAAC,CAAC,IACzB;IAAE,IAAI,EAAE,qBAAqB,CAAC,OAAO,CAAC;IAAC,KAAK,EAAE,CAAC,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAA;CAAE,CAAC;AAExI,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,YAAY,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC;AAEhE,MAAM,MAAM,YAAY,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;AAEjD,MAAM,MAAM,aAAa,GAAG,aAAa,CAAC,MAAM,EAAE,CAAC,CAAC;AA2EpD,wBAAgB,iCAAiC,CAAC,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,EAAE,yBAAyB,CAAC,EAAE,OAAO,GAAG,gBAAgB,CAEzJ;AAgDD,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,YAAY,EAAE,gBAAgB,GAAE,OAAc,GAAG,MAAM,CAiCnG;AAED;;GAEG;AACH,eAAO,MAAM,eAAe;;CAA0B,CAAC;AAEvD,eAAO,MAAM,cAAc,EAAE,UAA+C,CAAC"}

package/dist/src/_internal/platform/chat/common/commonTypes.js

@@ -0,0 +1,299 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CanceledResult = exports.CanceledMessage = exports.ChatFetchResponseType = exports.ChatLocation = void 0;
+exports.getErrorDetailsFromChatFetchError = getErrorDetailsFromChatFetchError;
+exports.getFilteredMessage = getFilteredMessage;
+const l10n = __importStar(require("@vscode/l10n"));
+const time_1 = require("../../../util/common/time");
+const vscodeTypesShim_1 = require("../../../util/common/test/shims/vscodeTypesShim");
+const openai_1 = require("../../networking/common/openai");
+/**
+ * The location of a chat request.
+ */
+var ChatLocation;
+(function (ChatLocation) {
+    /**
+     * The chat panel
+     */
+    ChatLocation[ChatLocation["Panel"] = 1] = "Panel";
+    /**
+     * Terminal inline chat
+     */
+    ChatLocation[ChatLocation["Terminal"] = 2] = "Terminal";
+    /**
+     * Notebook inline chat
+     */
+    ChatLocation[ChatLocation["Notebook"] = 3] = "Notebook";
+    /**
+     * Code editor inline chat
+     */
+    ChatLocation[ChatLocation["Editor"] = 4] = "Editor";
+    /**
+     * Chat is happening in an editing session.
+     * This location doesn't exist in vscode API, but is still used to compute the location sent for some intents.
+     */
+    ChatLocation[ChatLocation["EditingSession"] = 5] = "EditingSession";
+    /**
+     * The chat request does not correspond directly to a user chat request.
+     */
+    ChatLocation[ChatLocation["Other"] = 6] = "Other";
+    /**
+     * The chat is an agent mode edit session.
+     */
+    ChatLocation[ChatLocation["Agent"] = 7] = "Agent";
+})(ChatLocation || (exports.ChatLocation = ChatLocation = {}));
+(function (ChatLocation) {
+    /**
+     * Use this for passing uiKind to github telemetry, which we don't want to impact.
+     * Also known as UIKind in the telemetry data.
+     */
+    function toString(chatLocation) {
+        switch (chatLocation) {
+            case ChatLocation.Editor:
+                return 'conversationInline';
+            case ChatLocation.Panel:
+                return 'conversationPanel';
+            case ChatLocation.EditingSession:
+                return 'editingSession';
+            case ChatLocation.Agent:
+                return 'editingSessionAgent';
+            default:
+                return 'none';
+        }
+    }
+    ChatLocation.toString = toString;
+    /**
+     * This goes to logs and msft telemetry and is ok to change
+     */
+    function toStringShorter(chatLocation) {
+        switch (chatLocation) {
+            case ChatLocation.Editor:
+            case ChatLocation.Notebook:
+                return 'inline';
+            case ChatLocation.Panel:
+                return 'panel';
+            case ChatLocation.EditingSession:
+                return 'editingSession';
+            default:
+                return 'none';
+        }
+    }
+    ChatLocation.toStringShorter = toStringShorter;
+})(ChatLocation || (exports.ChatLocation = ChatLocation = {}));
+var ChatFetchResponseType;
+(function (ChatFetchResponseType) {
+    ChatFetchResponseType["OffTopic"] = "offTopic";
+    ChatFetchResponseType["Canceled"] = "canceled";
+    ChatFetchResponseType["Filtered"] = "filtered";
+    ChatFetchResponseType["FilteredRetry"] = "filteredRetry";
+    ChatFetchResponseType["PromptFiltered"] = "promptFiltered";
+    ChatFetchResponseType["Length"] = "length";
+    ChatFetchResponseType["RateLimited"] = "rateLimited";
+    ChatFetchResponseType["QuotaExceeded"] = "quotaExceeded";
+    ChatFetchResponseType["ExtensionBlocked"] = "extensionBlocked";
+    ChatFetchResponseType["BadRequest"] = "badRequest";
+    ChatFetchResponseType["NotFound"] = "notFound";
+    ChatFetchResponseType["Failed"] = "failed";
+    ChatFetchResponseType["Unknown"] = "unknown";
+    ChatFetchResponseType["NetworkError"] = "networkError";
+    ChatFetchResponseType["AgentUnauthorized"] = "agent_unauthorized";
+    ChatFetchResponseType["AgentFailedDependency"] = "agent_failed_dependency";
+    ChatFetchResponseType["InvalidStatefulMarker"] = "invalid_stateful_marker";
+    ChatFetchResponseType["Success"] = "success";
+})(ChatFetchResponseType || (exports.ChatFetchResponseType = ChatFetchResponseType = {}));
+function getRateLimitMessage(fetchResult, hideRateLimitTimeEstimate) {
+    if (fetchResult.type !== ChatFetchResponseType.RateLimited) {
+        throw new Error('Expected RateLimited error');
+    }
+    if (fetchResult.capiError?.code === 'agent_mode_limit_exceeded') { // Rate limited in agent mode
+        return l10n.t('Sorry, you have exceeded the agent mode rate limit. Please switch to ask mode and try again later.');
+    }
+    if (fetchResult.capiError?.code === 'upstream_provider_rate_limit') {
+        return l10n.t('Sorry, the upstream model provider is currently experiencing high demand. Please try again later or consider switching models.');
+    }
+    // Split rate limit key on comma as multiple headers can come in at once
+    const rateLimitKeyParts = fetchResult.rateLimitKey.split(',').map(part => part.trim());
+    const globalTPSRateLimit = rateLimitKeyParts.some(part => /^global-user(-[^-]+)?-tps-\d{4}-\d{2}-\d{2}$/.test(part));
+    const retryAfterString = (!hideRateLimitTimeEstimate && fetchResult.retryAfter) ? (0, time_1.secondsToHumanReadableTime)(fetchResult.retryAfter) : 'a moment';
+    if (fetchResult?.capiError?.code && fetchResult?.capiError?.message) {
+        return l10n.t({
+            message: 'Sorry, you have been rate-limited. Please wait {0} before trying again. [Learn More]({1})\n\nServer Error: {2}\nError Code: {3}',
+            args: [retryAfterString, 'https://aka.ms/github-copilot-rate-limit-error', fetchResult.capiError.message, fetchResult.capiError.code],
+            comment: ["{Locked=']({'}"]
+        });
+    }
+    if (!globalTPSRateLimit) {
+        return l10n.t({
+            message: 'Sorry, you have exhausted this model\'s rate limit. Please wait {0} before trying again, or switch to a different model. [Learn More]({1})',
+            args: [retryAfterString, 'https://aka.ms/github-copilot-rate-limit-error'],
+            comment: ["{Locked=']({'}"]
+        });
+    }
+    return l10n.t({
+        message: 'Sorry, your request was rate-limited. Please wait {0} before trying again. [Learn More]({1})',
+        args: [retryAfterString, 'https://aka.ms/github-copilot-rate-limit-error'],
+        comment: ["{Locked=']({'}"]
+    });
+}
+function getQuotaHitMessage(fetchResult, copilotPlan) {
+    if (fetchResult.type !== ChatFetchResponseType.QuotaExceeded) {
+        throw new Error('Expected QuotaExceeded error');
+    }
+    if (fetchResult.capiError?.code === 'free_quota_exceeded') {
+        fetchResult.capiError.code = 'quota_exceeded'; // Remap this to the generic quota code so we get per plan handling
+    }
+    if (fetchResult.capiError?.code === 'quota_exceeded') {
+        switch (copilotPlan) {
+            case 'free':
+                return l10n.t(`You've reached your monthly chat messages quota. Upgrade to Copilot Pro (30-day free trial) or wait for your allowance to renew.`);
+            case 'individual':
+                return l10n.t(`You've exhausted your premium model quota. Please enable additional paid premium requests, upgrade to Copilot Pro+, or wait for your allowance to renew.`);
+            case 'individual_pro':
+                return l10n.t(`You've exhausted your premium model quota. Please enable additional paid premium requests or wait for your allowance to renew.`);
+            default:
+                return l10n.t(`You've exhausted your premium model quota. Please reach out to your organization's Copilot admin to enable additional paid premium requests or wait for your allowance to renew.`);
+        }
+    }
+    else if (fetchResult.capiError?.code === 'overage_limit_reached') {
+        return l10n.t({
+            message: 'You cannot accrue additional premium requests at this time. Please contact [GitHub Support]({0}) to continue using Copilot.',
+            args: ['https://support.github.com/contact'],
+            comment: ["{Locked=']({'}"]
+        });
+    }
+    else if (fetchResult.capiError?.code && fetchResult.capiError?.message) {
+        return l10n.t({
+            message: 'Quota Exceeded\n\nServer Error: {0}\nError Code: {1}',
+            args: [fetchResult.capiError.message, fetchResult.capiError.code],
+            comment: ''
+        });
+    }
+    else {
+        return l10n.t('Quota Exceeded');
+    }
+}
+function getErrorDetailsFromChatFetchError(fetchResult, copilotPlan, hideRateLimitTimeEstimate) {
+    return { code: fetchResult.type, ...getErrorDetailsFromChatFetchErrorInner(fetchResult, copilotPlan, hideRateLimitTimeEstimate) };
+}
+function getErrorDetailsFromChatFetchErrorInner(fetchResult, copilotPlan, hideRateLimitTimeEstimate) {
+    switch (fetchResult.type) {
+        case ChatFetchResponseType.OffTopic:
+            return { message: l10n.t('Sorry, but I can only assist with programming related questions.') };
+        case ChatFetchResponseType.Canceled:
+            return exports.CanceledMessage;
+        case ChatFetchResponseType.RateLimited:
+            return {
+                message: getRateLimitMessage(fetchResult, hideRateLimitTimeEstimate),
+                level: vscodeTypesShim_1.ChatErrorLevel.Info
+            };
+        case ChatFetchResponseType.QuotaExceeded:
+            return {
+                message: getQuotaHitMessage(fetchResult, copilotPlan),
+                isQuotaExceeded: true
+            };
+        case ChatFetchResponseType.BadRequest:
+        case ChatFetchResponseType.Failed:
+            return { message: l10n.t(`Sorry, your request failed. Please try again. Request id: {0}\n\nReason: {1}`, fetchResult.requestId, fetchResult.reason) };
+        case ChatFetchResponseType.NetworkError:
+            return { message: l10n.t(`Sorry, there was a network error. Please try again later. Request id: {0}\n\nReason: {1}`, fetchResult.requestId, fetchResult.reason) };
+        case ChatFetchResponseType.Filtered:
+        case ChatFetchResponseType.PromptFiltered:
+            return {
+                message: getFilteredMessage(fetchResult.category),
+                responseIsFiltered: true,
+                level: vscodeTypesShim_1.ChatErrorLevel.Info,
+            };
+        case ChatFetchResponseType.AgentUnauthorized:
+            return { message: l10n.t(`Sorry, something went wrong.`) };
+        case ChatFetchResponseType.AgentFailedDependency:
+            return { message: fetchResult.reason };
+        case ChatFetchResponseType.Length:
+            return { message: l10n.t(`Sorry, the response hit the length limit. Please rephrase your prompt.`) };
+        case ChatFetchResponseType.NotFound:
+            return { message: l10n.t('Sorry, the resource was not found.') };
+        case ChatFetchResponseType.Unknown:
+            return { message: l10n.t(`Sorry, no response was returned.`) };
+        case ChatFetchResponseType.ExtensionBlocked:
+            return { message: l10n.t(`Sorry, something went wrong.`) };
+        case ChatFetchResponseType.InvalidStatefulMarker:
+            // should be unreachable, retried within the endpoint
+            return { message: l10n.t(`Your chat session state is invalid, please start a new chat.`) };
+    }
+}
+function getFilteredMessage(category, supportsMarkdown = true) {
+    switch (category) {
+        case openai_1.FilterReason.Copyright:
+            if (supportsMarkdown) {
+                return l10n.t({
+                    message: `Sorry, the response matched public code so it was blocked. Please rephrase your prompt. [Learn more](https://aka.ms/copilot-chat-filtered-docs).`,
+                    comment: ["{Locked='](https://aka.ms/copilot-chat-filtered-docs)'}"]
+                });
+            }
+            else {
+                return l10n.t(`Sorry, the response matched public code so it was blocked. Please rephrase your prompt.`);
+            }
+        case openai_1.FilterReason.Prompt:
+            if (supportsMarkdown) {
+                return l10n.t({
+                    message: `Sorry, your prompt was filtered by the Responsible AI Service. Please rephrase your prompt and try again. [Learn more](https://aka.ms/copilot-chat-filtered-docs).`,
+                    comment: ["{Locked='](https://aka.ms/copilot-chat-filtered-docs)'}"]
+                });
+            }
+            else {
+                return l10n.t(`Sorry, your prompt was filtered by the Responsible AI Service. Please rephrase your prompt and try again.`);
+            }
+        default:
+            if (supportsMarkdown) {
+                return l10n.t({
+                    message: `Sorry, the response was filtered by the Responsible AI Service. Please rephrase your prompt and try again. [Learn more](https://aka.ms/copilot-chat-filtered-docs).`,
+                    comment: ["{Locked='](https://aka.ms/copilot-chat-filtered-docs)'}"]
+                });
+            }
+            else {
+                return l10n.t(`Sorry, the response was filtered by the Responsible AI Service. Please rephrase your prompt and try again.`);
+            }
+    }
+}
+/**
+ * Not localized because it's used in the same way that the CancellationError name is used.
+ */
+exports.CanceledMessage = { message: 'Canceled' };
+exports.CanceledResult = { errorDetails: exports.CanceledMessage, };
+//# sourceMappingURL=commonTypes.js.map