@microsoft/agents-copilotstudio-client 1.4.0-beta.6.g725ba9fc33 → 1.4.1

package/src/startRequest.ts

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Represents a request to start a new conversation with a Copilot Studio agent.
+ * This request encapsulates all parameters needed to initiate a conversation.
+ */
+export interface StartRequest {
+  /**
+   * Optional locale code (e.g., 'en-US', 'fr-FR') for the conversation.
+   * If not specified, the agent's default locale will be used.
+   */
+  locale?: string
+
+  /**
+   * Whether to emit a start conversation event.
+   * When true, the agent will be notified that this is the beginning of a new conversation.
+   * Default is true.
+   */
+  emitStartConversationEvent?: boolean
+
+  /**
+   * Optional conversation ID to use for this conversation.
+   * If not specified, a new conversation ID will be generated by the service.
+   */
+  conversationId?: string
+}
+
+/**
+ * Creates a StartRequest with default values.
+ * @param emitStartConversationEvent Whether to emit a start conversation event. Defaults to true.
+ * @param locale Optional locale for the conversation.
+ * @param conversationId Optional conversation ID.
+ * @returns A new StartRequest object.
+ */
+export function createStartRequest (
+  emitStartConversationEvent: boolean = true,
+  locale?: string,
+  conversationId?: string
+): StartRequest {
+  return {
+    emitStartConversationEvent,
+    locale,
+    conversationId
+  }
+}

package/src/strategies/prebuiltBotStrategy.ts

@@ -6,7 +6,7 @@
 import type { Strategy, StrategySettings } from './strategy'
 
 /** @deprecated This interface will not be supported in future versions. Use StrategySettings instead. */
-export interface PrebuiltBotStrategySettings {
+interface PrebuiltBotStrategySettings {
   readonly host: URL;
   readonly identifier: string;
 }

package/src/strategies/publishedBotStrategy.ts

@@ -6,7 +6,7 @@
 import type { Strategy, StrategySettings } from './strategy'
 
 /** @deprecated This interface will not be supported in future versions. Use StrategySettings instead. */
-export interface PublishedBotStrategySettings {
+interface PublishedBotStrategySettings {
   readonly host: URL;
   readonly schema: string;
 }

package/src/subscribeEvent.ts

@@ -0,0 +1,38 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { Activity } from '@microsoft/agents-activity'
+
+/**
+ * Represents an event received from a subscription to a Copilot Studio conversation.
+ */
+export interface SubscribeEvent {
+  /**
+   * The activity from the copilot.
+   */
+  activity: Activity
+
+  /**
+   * The SSE event ID for resumption.
+   * Can be used to resume subscription from a specific point.
+   */
+  eventId?: string
+}
+
+/**
+ * Represents a request to subscribe to a conversation.
+ */
+export interface SubscribeRequest {
+  /**
+   * The conversation ID to subscribe to.
+   */
+  conversationId: string
+
+  /**
+   * The last received event ID for resumption.
+   * If provided, subscription will resume from this point.
+   */
+  lastReceivedEventId?: string
+}

package/src/userAgentHelper.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { version } from '../package.json'
+import os from 'os'
+
+/**
+ * Utility class for generating user agent strings for Copilot Studio client requests.
+ */
+export class UserAgentHelper {
+  /**
+   * Generates a user agent string appropriate for the current environment.
+   * - For browser environments, includes the browser's user agent.
+   * - For Node.js environments, includes Node version, platform, architecture, and release.
+   * @returns A user agent string for HTTP headers.
+   */
+  static getProductInfo (): string {
+    const versionString = `CopilotStudioClient.agents-sdk-js/${version}`
+    let userAgent: string
+
+    if (typeof window !== 'undefined' && window.navigator) {
+      // Browser environment
+      userAgent = `${versionString} ${navigator.userAgent}`
+    } else {
+      // Node.js environment
+      userAgent = `${versionString} nodejs/${process.version} ${os.platform()}-${os.arch()}/${os.release()}`
+    }
+
+    return userAgent
+  }
+
+  /**
+   * Gets just the version string without environment details.
+   * @returns The version string (e.g., "CopilotStudioClient.agents-sdk-js/0.1.0")
+   */
+  static getVersionString (): string {
+    return `CopilotStudioClient.agents-sdk-js/${version}`
+  }
+
+  /**
+   * Gets the SDK version number.
+   * @returns The version number (e.g., "0.1.0")
+   */
+  static getVersion (): string {
+    return version
+  }
+}