@microsoft/typespec-msgraph 1.0.0-Preview.2 → 1.0.0-Preview.4

package/lib/schema-Prod-v1.0.tsp

@@ -0,0 +1,312 @@
+// Generated to target TypeSpec 0.64.0
+import "@microsoft/typespec-msgraph";
+
+using TypeSpec.Http;
+using MsGraph;
+using MsGraph.Responses;
+using MsGraph.SharedModels;
+using microsoft.graph;
+
+// Define a local utility interface to make workload-wide choices
+namespace MsGraph {
+  interface LocalOps {
+    // All collection operations support select, skip, and top and are paged collections
+    @select @top @skip GetCollection is GraphOps.GetPagedCollection;
+    @select GetResource is GraphOps.GetResource;
+    PatchResource is GraphOps.PatchNoResponse;
+    DeleteResource is GraphOps.Delete;
+    // Require POSTs to specify their errors.{
+    Post<TErrorCodes extends int16> is GraphOps.Post<TErrorResponse = ErrorResponse<TErrorCodes>>;
+  }
+}
+
+// First, shared elements that are owned by other teams which have already shipped so cannot be hidden as part of our private preview tag
+#suppress "@microsoft/typespec-msgraph/require-documentation-for-core-elements" "TBD finish documentation"
+@publicNamespace("microsoft.graph")
+namespace microsoft.graphnothidden {
+  @ownerless
+  @addressUrl("https://substrate.office.com/m365Copilot/api/beta/copilot", true)
+  @graphRoute("copilot")
+  interface copilotSingleton extends Resource<copilotRoot> {} // Empty interface denotes no HTTP operations possible.
+
+  /** Standard way to represent a Json blob on Graph.*/
+  @complex model Json {} // Note capital J for JSON is correct in this instance.
+
+  /** Root singleton for all Copilot APIs on Microsoft Graph. 
+   * @prop conversations The users conversations with Copilot Chat.
+   */
+  @entity model copilotRoot {
+    @contains conversations: copilotConversation[];
+  }
+
+  /** Represents a sensitivityLabel.
+   * This model is shared with the CCS retrieval API and search where it is already unhidden.
+   */
+  @complex model searchSensitivityLabelInfo {
+    @computed @readOnly sensitivityLabelId: string|null;
+    @computed @readOnly displayName: string|null;
+    @computed @readOnly tooltip: string | null;
+    @computed @readOnly priority: int32|null;
+    @computed @readOnly color: string|null;
+    @privileged @computed @readOnly isEncrypted: boolean|null;
+  }
+}
+
+// Teams has already taken the OData Action name microsoft.graph.chat, so we have to put our actions in a subnamespace.
+// This won't affect customers much, but we will need to adjust odata routes in our controllers to match.
+#suppress "@microsoft/typespec-msgraph/require-documentation-for-core-elements" "TBD finish documentation"
+#suppress "@microsoft/typespec-msgraph/use-evolvable-enum"
+@publicNamespace("microsoft.graph.copilot")
+@privatePreview("copilotChatPrivatePreview1")
+namespace microsoft.graph.copilot {
+
+  #suppress "@microsoft/typespec-msgraph/use-evolvable-enum"
+  enum TestType {
+    TestOne,
+    TestTwo,
+    TestThree
+  }
+
+/** This extra interface is temporary until we resolve a bug in Hidi that operations using RequiresExplicitBinding
+  * don't appear in the output YAML.
+  * Once that is fixed, move the operations back under copilotConversationsById and remove the
+  * @globalOperation decorator.
+  */
+  interface globalOperations extends Resource<copilotConversation> {
+    /** Chat with Copilot in this conversation. This synchronous endpoint may be quite slow. */
+    @globalOperation
+    chat is GraphOps.Action<TActionParams=copilotChatRequestParameters,
+                            TReturnType=copilotConversation,
+                            TErrorResponse=ErrorResponse<400|402|403|429|500>>;
+
+    /** Chat with Copilot in this conversation. This endpoint streams its results over Server-Sent Events (SSE). */
+    @globalOperation
+    chatOverStream is GraphOps.Action<TActionParams=copilotChatRequestParameters,
+                                      TReturnType=stream,
+                                      TErrorResponse=ErrorResponse<400|402|403|429|500>>;
+
+  }
+
+  // We need at least one model in the namespace otherwise it does not get generated.
+
+  /** Represents the request body content of the chat action.
+  This allows the CSDL to carry a complex representation of the body of the Chat Action to make C# code gen easier.
+  NOTE: Ensure this type ALWAYS stays @hidden even when the rest of the API is public as it for internal consumption. */ 
+  @complex model copilotConversationRequest {
+    ...copilotChatRequestParameters; // Use the spread operator to make its content the same as the request parameters.
+  }
+}
+
+#suppress "@microsoft/typespec-msgraph/require-documentation-for-core-elements" "TBD finish documentation"
+@privatePreviewDefinition("copilotChatPrivatePreview1", "2025-03-27", "2025-08-28", "compliantsydney")
+@publicNamespace("microsoft.graph")
+@privatePreview("copilotChatPrivatePreview1")
+@additionalQueryParameters("variants", "feature.EnableCopilotChatControllerEndpoint")
+namespace microsoft.graph {
+
+  // -------------------------- Routes -------------------------
+  // Full list of the URLs supported by the 'crawl' version of the CCS Chat API
+  // This is the set to implement controllers for.
+  
+  @graphRoute("copilot/conversations")
+  interface copilotConversations extends Collection<copilotConversation> {
+    #suppress "@microsoft/typespec-msgraph/get-put-post-patch-operations-should-have-select-decorator" "Really no reason to expect to need $select on this create op."
+    post is LocalOps.Post<400|402|403|429|500>;
+  }
+
+  @graphRoute("copilot/conversations/{conversationId}")
+  interface copilotConversationsById extends Resource<copilotConversation> {
+  }
+
+  // Because there is an @contains relationship between two entities in the model, we need to
+  // be explicit that no calls to that URL are yet supported
+  @graphRoute("copilot/conversations/{conversationId}/messages")
+  interface copilotConversationsByIdHasMessages extends Collection<copilotConversationMessage> {
+  }
+
+  @graphRoute("copilot/conversations/{conversationId}/messages/{messageId}")
+  interface copilotConversationsByIdHasMessagesById extends Resource<copilotConversationMessage> {
+  }
+  
+  // -------------------------- Standard Headers -------------------------
+  /** Standard headers for request/response. Currently just documentation. */
+  namespace headers {
+    /**
+     * Standard headers for all requests to the Copilot Chat API.
+     * Note: camelCase properties are converted to snake-case headers
+     * @prop xAnchormailbox CAFE header to route to correct shard passed as userId@TenantId from Microsoft Graph.
+     * @prop xRoutingparameterSessionkey CAFE header to route to stable pod passed as oid of user from Microsoft Graph.
+     * @prop authorization Standard Graph bearer token authorization.
+     * @prop requestId Unique identifier for the request passed from Microsoft Graph.
+     * @prop clientRequestId Unique identifier passed optionally from the client application.
+     * @prop acceptLanguage The natural language (e.g. en-gb) to use for the response per RFC 3282.
+     * @prop accept The type of response to accept. Currently must be "text/event-stream" for _chatOverStream_ and "application/json" for all other calls.
+     * @prop xScenario The scenario for the request.
+     */
+    #suppress "@microsoft/typespec-msgraph/model-should-be-entity-or-complex-type" "Infrastructure"
+    @operationParameters 
+    model standardRequestHeaders {
+      @header xAnchormailbox: string;
+      @header xRoutingparameterSessionkey: string;
+      @header authorization: string;
+      @header requestId: string;
+      @header clientRequestId: string;
+      @header acceptLanguage: string;
+      @header accept: string;
+      @header xScenario: string;
+    }
+
+    /**
+     * Standard headers for all responses from the Copilot Chat API.
+     * Note: camelCase properties are converted to snake-case headers
+     * @prop retryAfter The time to wait before retrying the request after a 429.
+     * @prop contentType The type of content returned. Either application/json or text/event-stream as appropriate.
+     * @prop cacheControl The cache control header. Set with a value of 'no-cache' for streams.
+     */
+    #suppress "@microsoft/typespec-msgraph/model-should-be-entity-or-complex-type" "Infrastructure"
+    @operationParameters
+    model standardResponseHeaders {
+      @header retryAfter: string;
+      @header contentType: string;
+      @header cacheControl: string;
+    }
+  }
+
+  // -------------------------- Models -------------------------
+
+   /** Conversation is a first class object in the system, and consists of persistent metadata plus a stream of messages,
+   * typically alternating request/response, implicitly forming a turn.
+   */
+
+  /** Represents a conversation with Copilot Chat.
+   * @prop id The unique identifier of the conversation.
+   * @prop createdDateTime The date and time when the conversation was created.
+   * @prop capabilityParameters Parameters to modify the behavior of the well-known capabilities of Copilot Chat.
+   * @prop displayName The display name of the conversation.
+   * @prop state The state of the conversation.
+   * @prop turnCount The number of turns in the conversation.
+   * @prop messages The ordered list of messages in the conversation.
+  */
+  @entity model copilotConversation {
+    @readOnly @computed @key id: string;
+    @readOnly @computed createdDateTime: dateTimeOffset;
+    @computed displayName: string;
+    @readOnly @computed state: copilotConversationState;
+    @readOnly @computed turnCount: int32;
+    @readOnly @contains messages: copilotConversationMessage[];
+  }
+
+  /** The state of a Copilot conversation. */
+  enum copilotConversationState {
+    /** The conversation is active and can accept requests to chat. */
+    active,
+    /** Copilot has disengaged from the conversation due to a RAI issue and will reject further requests to chat. */
+    disengagedForRai,
+    unknownFutureValue
+  }
+
+  // ---------------------- Request Models ----------------------
+
+  /** Represents the parameters in the body of the chat action. 
+   * @prop message The message of the chat call.
+   * @prop additionalContext Extra context data for a chat call.
+   * @prop locationHint Location hint for a chat call.
+  */
+  @operationParameters model copilotChatRequestParameters {
+    message: copilotConversationRequestMessageParameter; 
+    locationHint: copilotConversationLocation;
+    additionalContext?: copilotContextMessage[];
+  }
+
+  /** Abstract entity representing a chat message in a request or response.
+   * @prop id The unique identifier of the message.
+   * @prop text The text of the message.
+   */
+  @abstract @entity model copilotConversationMessage {
+    @readOnly @computed @key id: string;
+    ... copilotConversationMessageNonIdProperties;
+  }
+
+  /** Entity representing a chat message in a request. */
+  @entity model copilotConversationRequestMessage extends copilotConversationMessage {
+    ... copilotConversationRequestMessageNonIdProperties;
+  }
+
+  // Out of the box, the OData libraries appear not to support using an ephemeral entity as a parameter to an OData Action.
+  // So we will create an extra complex type that has all of the RequuestMessage's properties except 'id' just for the Action.
+  // Then we will spread that complex type back into the original RequestMessageEntity to stay DRY and ensure each property is only defined once.
+  @complex model copilotConversationMessageParameter {
+     ... copilotConversationMessageNonIdProperties;
+  }
+
+  @complex model copilotConversationRequestMessageParameter extends copilotConversationMessageParameter {
+   ...copilotConversationRequestMessageNonIdProperties;
+  }
+
+  @operationParameters model copilotConversationMessageNonIdProperties {
+    @requiredForCreate @immutable text: string;
+  }
+
+  @operationParameters model copilotConversationRequestMessageNonIdProperties {
+  }
+
+
+  /** Extra context data for a request supplied in the form of a message.
+   * @prop text The text of the message.
+   * @prop description The description of the message.
+  */
+  @complex model copilotContextMessage{
+    @requiredForCreate @immutable text: string;
+    @requiredForCreate @immutable description: string;
+  }
+
+  /** Represents a location. 
+   * @prop latitude The latitude of the location.
+   * @prop longitude The longitude of the location.
+   * @prop countryOrRegion The country or region of the location.
+   * @prop countryOrRegionConfidence The confidence level of the country or region.
+   * @prop timeZone The IANA timezone of the location.
+  */
+  @complex model copilotConversationLocation {
+    @immutable latitude: float64 | null = null;
+    @immutable longitude: float64 | null = null;
+    @immutable countryOrRegion: string | null = null;
+    @immutable countryOrRegionConfidence: float64 | null = null;
+    @requiredForCreate @immutable timeZone: string;
+  }
+  
+  // ---------------------- Response Models ----------------------
+
+  /** Represents a response message in a chat. */
+  @entity model copilotConversationResponseMessage extends copilotConversationMessage {
+    @computed @readOnly createdDateTime: dateTimeOffset;
+    @computed @readOnly adaptiveCards: microsoft.graphnothidden.Json[];
+    @computed @readOnly attributions: copilotConversationAttribution[];
+    @computed @readOnly sensitivityLabel: microsoft.graphnothidden.searchSensitivityLabelInfo | null; 
+  }
+
+  @complex model copilotConversationAttribution {
+    @computed @readOnly attributionType: copilotConversationAttributionType;
+    @computed @readOnly providerDisplayName: string;
+    @computed @readOnly attributionSource: copilotConversationAttributionSource;
+    @computed @readOnly seeMoreWebUrl: webUrl;
+    @computed @readOnly imageWebUrl: webUrl;
+    @computed @readOnly imageFavIcon: string;
+    @computed @readOnly imageWidth: int32;
+    @computed @readOnly imageHeight: int32;
+  }
+
+  /** The type of attribution. */
+  enum copilotConversationAttributionType {
+    citation,
+    annotation,
+    unknownFutureValue
+  }
+
+  /** The source of the attribution. */
+  enum copilotConversationAttributionSource {
+    grounding,
+    `model`,
+    unknownFutureValue
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/typespec-msgraph",
-  "version": "1.0.0-Preview.2",
+  "version": "1.0.0-Preview.4",
   "author": "Microsoft Corporation",
   "description": "TypeSpec for Microsoft Graph provides a description of the Microsoft Graph APIs. It is used for generating API description languages, client and service code, documentation, and other assets.",
   "homepage": "https://github.com/microsoftgraph/typespec-msgraph",
@@ -34,17 +34,7 @@
     }
   },
   "engines": {
-    "node": ">=14.0.0"
-  },
-  "scripts": {
-    "clean": "rimraf ./dist ./temp",
-    "build": "tsc -p . && tsp compile --noEmit lib/msgraph.tsp",
-    "watch": "tsc -p . --watch",
-    "test": "mocha --parallel",
-    "buildntest": "tsc -p . && mocha --parallel",
-    "test-official": "c8 mocha --forbid-only --parallel",
-    "lint": "eslint . --ext .ts,.tsx --max-warnings=0",
-    "lint:fix": "eslint . --fix --ext .ts,.tsx"
+    "node": ">=18.0.0"
   },
   "files": [
     "lib/*.tsp",
@@ -52,17 +42,22 @@
     "!dist/test/**"
   ],
   "dependencies": {
-    "@typespec/compiler": "~0.66.0",
-    "@typespec/http": "~0.66.0",
+    "@typespec/compiler": "~1.4.0",
+    "@typespec/http": "~1.4.0",
     "@xmldom/xmldom": "~0.8.10",
     "prettier": "~3.2.5",
     "react": "~18.3.1",
     "react-dom": "~18.3.1",
-    "react-reconciler": "~0.29.2"
+    "react-reconciler": "~0.29.2",
+    "@alloy-js/core": "^0.20.0",
+    "@alloy-js/json": "^0.20.0",
+    "@alloy-js/typescript": "^0.20.0",
+    "@alloy-js/csharp": "^0.20.0",
+    "@typespec/emitter-framework": "^0.11.0"
   },
   "devDependencies": {
     "@types/mocha": "~10.0.10",
-    "@types/node": "~20.12.14",
+    "@types/node": "~22.0.0",
     "@types/react": "~18.3.18",
     "@types/react-reconciler": "~0.28.9",
     "c8": "~9.1.0",
@@ -71,7 +66,17 @@
     "rimraf": "~5.0.10",
     "source-map-support": "~0.5.21",
     "tsx": "~4.19.3",
-    "typescript": "~5.7.3",
+    "typescript": "~5.9.2",
     "xpath": "~0.0.34"
+  },
+  "scripts": {
+    "clean": "rimraf ./dist ./temp",
+    "build": "tsc -p . && tsp compile --noEmit lib/msgraph.tsp",
+    "watch": "tsc -p . --watch",
+    "test": "mocha --parallel",
+    "buildntest": "tsc -p . && mocha --parallel",
+    "test-official": "c8 mocha --forbid-only --parallel",
+    "lint": "eslint . --ext .ts,.tsx --max-warnings=0",
+    "lint:fix": "eslint . --fix --ext .ts,.tsx"
   }
-}
+}