@microsoft/typespec-msgraph 0.0.1-Preview.9 → 1.0.0-Preview.3

package/lib/decorators.tsp

@@ -16,28 +16,58 @@ extern dec action(target: Operation, name?: valueof string);
 
 /**
  * `@additionalQueryParameters` - Appends a key=value pair to the query string of the mapped internal URL for all models defined within the namespace.
- * 
+ *
  * `@additionalQueryParameters` can only be applied to namespaces
  */
-extern dec additionalQueryParameters(target: Namespace, name: valueof string, value: valueof string);
+extern dec additionalQueryParameters(
+  target: Namespace,
+  name: valueof string,
+  value: valueof string
+);
+
+/**
+ * `@addressUrl` - Specifies the URL to which the operation request is forwarded when the request
+ * is authenticated with an AAD account.
+ *
+ * `@addressUrl` can only be applied to routed interfaces (entity sets, singletons and navigation properties) or action operations.
+ */
+extern dec addressUrl(
+  target: Interface | Operation,
+  url: valueof string,
+  omitRootNavigationSegment?: valueof boolean,
+  appendSegmentNameToAddress?: valueof boolean
+);
+
+/**
+ * `@addressUrlMsa` - Specifies the URL to which the operation request is forwarded when the request
+ * is authenticated with a Microsoft Account.
+ *
+ * `@addressUrlMsa` can only be applied to routed interfaces (entity sets, singletons and navigation properties) or action operations.
+ */
+extern dec addressUrlMsa(
+  target: Interface | Operation,
+  url: valueof string,
+  omitRootNavigationSegment?: valueof boolean,
+  appendSegmentNameToAddress?: valueof boolean
+);
 
 /**
  * `@agsAttribute` - Allows all AGS CSDL extensions that are not yet modelled explicitly in TypeSpec to be maintained
- * 
+ *
  * `@agsAttribute` - Applies to models.
  */
 extern dec agsAttribute(
-  target: Model | ModelProperty | Enum | EnumMember | Operation | Interface,
+  target: Model | ModelProperty | Enum | EnumMember | Operation | Interface | Namespace,
   name: valueof string,
   value: valueof string
 );
 
 /**
  * `@allowedValues` - mark model property with allowedValues.
- * 
+ *
  * `@allowedValues` - can only be applied to model properties.
  */
- extern dec allowedValues(target: ModelProperty, ...values: valueof unknown[]);
+extern dec allowedValues(target: ModelProperty, ...values: valueof unknown[]);
 
 /**
  * `@alternateKey` - mark a model property as an alternateKey
@@ -60,6 +90,16 @@ extern dec complex(target: Model);
  */
 extern dec computed(target: ModelProperty);
 
+
+/**
+  * `@container` - specifies the name to use the container in the CSDL output.
+  *
+  * `@container` can only be applied to namespaces.
+  *
+  * `name` - The name of the container. If not specified, defaults to "container".
+  */
+extern dec container(target: Namespace, name: valueof string);
+
 /**
  * `@contains` - mark a model property as a contained navigation property
  *
@@ -74,6 +114,14 @@ extern dec contains(target: ModelProperty);
  */
 extern dec count(target: Operation);
 
+/**
+ * `@delta` - mark an operation as a delta operation
+ *
+ * `@delta` can only be applied to operations.
+ */
+
+extern dec delta(target: Operation);
+
 /**
  * `@deltaCollection` - mark a model as representing a delta paged collection.
  *
@@ -108,7 +156,27 @@ extern dec entity(target: Model);
  * `properties` - Property names in the model returned from the get that can be used in a $expand query parameter.
  * At least one property must be specified.
  */
-extern dec expand(target: Operation, property: valueof string, ...otherProperties: valueof string[]);
+extern dec expand(
+  target: Operation,
+  property: valueof string,
+  ...otherProperties: valueof string[]
+);
+
+/**
+ * `@experimental` - mark the entity as experimental
+ *
+ * `@experimental` can be applied to Model, ModelProperty, Enum, EnumMember, Operation, Namespace, Interface.
+ */
+extern dec experimental(
+  target:
+    | Model
+    | ModelProperty
+    | Enum
+    | EnumMember
+    | Operation
+    | Namespace
+    | Interface
+);
 
 /**
  * `@filter` - Applies to: get operations that return collections of @entity or @complex models.
@@ -117,46 +185,98 @@ extern dec expand(target: Operation, property: valueof string, ...otherPropertie
  * `properties` - array of property names in the model returned
  * from the get operation that can be used in $filter query parameter.
  */
-extern dec filter(target: Operation, property: valueof string, ...properties: valueof string[]);
+extern dec filter(
+  target: Operation,
+  property: valueof string,
+  ...properties: valueof string[]
+);
+
+
+/**
+ * `@function` - mark an operation as a function
+*
+* `@function` can only be applied to operations.
+*/
+extern dec function(target: Operation, name?: valueof string | null, isComposable?: valueof boolean);
+
+/**
+ * `@globalOperation` - mark an operation as a globalOperation
+*
+* `@globalOperation` can only be applied to operations.
+*/
+extern dec globalOperation(target: Operation);
 
+/**
+ * `@graphDeprecated` - mark an entity as graphDeprecated.
+ *
+ * `@graphDeprecated` can be applied to Model, ModelProperty, Enum, EnumMember, Operation, Namespace, Interface.
+ */
+extern dec graphDeprecated(
+  target:
+    | Model
+    | ModelProperty
+    | Enum
+    | EnumMember
+    | Operation
+    | Namespace
+    | Interface,
+  name: valueof string
+);
 
 /**
- * `@flags` - mark an enumeration type as a flag.
+ * `@graphFlags` - mark an enumeration type as a flag.
  *
- * `@flags` can only be applied to enums.
+ * `@graphFlags` can only be applied to enums.
  */
-extern dec flags(target: Enum);
+extern dec graphFlags(target: Enum);
 
 /**
- * `@function` - mark an operation as a function
+ * `@graphPartial` - Mark a model as partial.
  *
- * `@function` can only be applied to operations.
+ * `@graphPartial` can only be applied to models.
  */
-extern dec function(target: Operation, name?: valueof string);
+extern dec graphPartial(target: Model, value: Model);
 
 /**
  * `@graphRoute` - mark an interface or operation with an HTTP route.
- * 
+ *
  * `@graphRoute` - can only be applied to interfaces or operations.
  */
 // TODO: Using @graphRoute on an operation currently does not work due to the following TypeSpec core issue
 // https://github.com/microsoft/typespec/issues/2106
 // Disabling all related features while we await the outcome.
-extern dec graphRoute(target: Interface /* | Operation */, path: valueof string);
+extern dec graphRoute(
+  target: Interface,  /* | Operation */
+  path: valueof string
+);
 
 /**
- * `@hasStream` - indicates that an `@entity` model has a stream.
+ * `@immutable` - mark a model property as immutable.
  *
- * `mediaTypes` - list of media types supported by the stream. If not specified, the stream supports any media type.
+ * `@immutable` can only be applied to model properties.
  */
-extern dec hasStream(target: Model, ...mediaTypes: valueof string[]);
+extern dec immutable(target: ModelProperty);
 
 /**
- * `@immutable` - mark a model property as immutable.
+ * `@limitedCharset` - indicates that the full unicode character set is not supported by the underlying back-end service that implements the API.
  *
- * `@immutable` can only be applied to model properties.
+ * `@limitedCharset` can only be applied to string models properties, string parameters or their collections.
  */
-extern dec immutable(target: ModelProperty);
+extern dec limitedCharset(target: ModelProperty);
+
+/**
+ * `@media` - indicates that an `@entity` model is a media entity.
+ *
+ * `mediaTypes` - list of media types supported by the entity. If not specified, the entity supports any media type.
+ */
+extern dec media(target: Model, ...mediaTypes: valueof string[]);
+
+/**
+ * `@ownerless` - mark an interface as ownerless.
+ *
+ * `@ownerless` can only be applied to interfaces.
+ */
+extern dec ownerless(target: Interface);
 
 /**
  * `@open` - mark a model type as open
@@ -181,7 +301,11 @@ extern dec operationParameters(target: Model);
  * `properties` - List of property names in the model returned from the get operation that can be used in a $orderBy query parameter.
  * At least one property must be specified.
  */
-extern dec orderBy(target: Operation, property: valueof string, ...otherProperties: valueof string[]);
+extern dec orderBy(
+  target: Operation,
+  property: valueof string,
+  ...otherProperties: valueof string[]
+);
 
 /**
  * `@pagedCollection` - mark a model as representing a paged collection.
@@ -190,6 +314,39 @@ extern dec orderBy(target: Operation, property: valueof string, ...otherProperti
  */
 extern dec pagedCollection(target: Model);
 
+/**
+ * `@passthroughAddressUrl` - Specifies the URL to which the operation request is forwarded when the request
+ * is authenticated with an AAD account and the request is eligible for response passthrough.
+ *
+ * `@passthroughAddressUrl` can only be applied to routed interfaces (entity sets, singletons and navigation properties) or action operations.
+ */
+extern dec passthroughAddressUrl(
+  target: Interface | Operation,
+  url: valueof string
+);
+
+/**
+ * `@passthroughAddressUrlMsa` - Specifies the URL to which the operation request is forwarded when the request
+ * is authenticated with a Microsoft account and the request is eligible for response passthrough.
+ *
+ * `@passthroughAddressUrlMsa` can only be applied to routed interfaces (entity sets, singletons and navigation properties) or action operations.
+ */
+extern dec passthroughAddressUrlMsa(
+  target: Interface | Operation,
+  url: valueof string
+);
+
+/**
+ * `@prefixedGraphRoutes` - mark an interface or operation with multiple HTTP routes based on catenating a set of prefixes to a path.
+ *
+ * `@prefixedGraphRoutes` - can only be applied to interfaces.
+ */
+extern dec prefixedGraphRoutes(
+  target: Interface,
+  prefixes: string[],
+  path?: valueof string
+);
+
 /**
  * `@privatePreview` - Allow us define a privatePreview element.
  * `@privatePreview` - Applies to models, model properties, enums, enum members, namespaces and operations.
@@ -216,7 +373,9 @@ extern dec privatePreviewDefinition(
  *
  * `@privileged` can be applied to Model, ModelProperty, Enum, EnumMember, Operation, Namespace.
  */
-extern dec privileged(target: Model | ModelProperty | Enum | EnumMember | Operation | Namespace);
+extern dec privileged(
+  target: Model | ModelProperty | Enum | EnumMember | Operation | Namespace
+);
 
 /**
  * `@publicNamespace` - defines the namespace to be used in generating CSDL output for all elements contained within the namespace
@@ -239,6 +398,13 @@ extern dec readOnly(target: ModelProperty);
  */
 extern dec references(target: ModelProperty);
 
+/**
+ * `@referenceTarget` - mark an interface with referenceTarget
+ *
+ * `@references` can only be applied to interfaces.
+ */
+ extern dec referenceTarget(target: Interface, value: valueof string);
+
 /**
  * `@requiredForCreate` - mark a model property as required when a request is made to
  * Graph to create or update a resource.
@@ -247,24 +413,61 @@ extern dec references(target: ModelProperty);
  */
 extern dec requiredForCreate(target: ModelProperty);
 
+/**
+ * '@returnSource' - mark an action or a function as having an entitysetpath.
+ * '@returnSource' - can only be applied to action and function operations.
+ */
+extern dec returnSource(target: Operation, path : valueof string | null);
+
 /**
  * `@search` - Applies to: get operations that return collections.
  * Indicates that the get operation supports the OData $search query parameter.
  */
 extern dec search(target: Operation);
 
+/**
+ * `@select` - Applies to operations
+ *  Indicates that the operation supports the OData $select query parameter
+ */
+ extern dec select(target: Operation);
+
+/**
+ * `@sharedEntity` - mark a model as a shared entity type
+ *
+ * `@sharedEntity` can only be applied to models.
+ */
+extern dec sharedEntity(target: Model);
+
 /**
  * `@skip` - Applies to: get operations that return collections.
  * Indicates that the get operation supports the OData $skip query parameter.
  */
 extern dec skip(target: Operation);
 
+/**
+ * `@term` - Applies to: namespaces.
+ * Indicates that a workload wishes to require or return instance annotations in their request / response packets at runtime.
+ */
+extern dec term(
+  target: Namespace,
+  name: valueof string,
+  type: Scalar,
+  description: valueof string
+);
+
 /**
  * `@top` - Applies to: get operations that return collections.
  * Indicates that the get operation supports the OData $top query parameter.
  */
 extern dec top(target: Operation);
 
+/**
+ * `@workloadNamespace` - overrideds the namespace to be used in generating CSDL output for all elements contained within the namespace
+ * 
+ * `@workloadNamespace` can only be applied to namespaces.
+ */
+extern dec workloadNamespace(target: Namespace, name: valueof string);
+
 /**
  * `@writeOnly` - mark a model property as writeOnly property
  *
@@ -273,11 +476,11 @@ extern dec top(target: Operation);
 extern dec writeOnly(target: ModelProperty);
 
 /**
-* `@isOwner` - specify that this workload is the primary owner of this entity model
-*
-* `@isOwner` can be applied to Model where the model also has an @entity decorator or a ModelProperty where it has either an @contains or @references decorator.
-*/
-extern dec isOwner(target: Model | ModelProperty);
+ * `@isOwner` - specify that this workload is the primary owner of this entity model
+ *
+ * `@isOwner` can be applied to Model where the model also has an @entity decorator or a ModelProperty where it has either an @contains or @references decorator.
+ */
+extern dec isOwner(target: Model | ModelProperty, value?: valueof boolean);
 
 /**
  * `@workloadName` - specifies the name used by the underlying workload

package/lib/lib.tsp

@@ -4,7 +4,9 @@ import "@typespec/http";
 using TypeSpec.Http;
 namespace MsGraph;
 
-scalar date;
+alias date=plainDate;
+alias dateTimeOffset=offsetDateTime;
+alias timeOfDay=plainTime;
 
 scalar stream;
 

package/lib/msgraph.tsp

@@ -1,6 +1,7 @@
 import "./lib.tsp";
 import "./shared-models.tsp";
 // TODO: import "./deployment.tsp";
+import "./bodies.tsp";
 import "./responses.tsp";
 import "./decorators.tsp";
 import "./porcelain.tsp";

package/lib/porcelain.tsp

@@ -11,9 +11,14 @@ using TypeSpec.Http;
 using MsGraph;
 using MsGraph.SharedModels;
 using MsGraph.Responses;
+using MsGraph.Bodies;
 
 namespace MsGraph;
 
+  model EntityRef<T extends MsGraph.SharedModels.entity> {
+      @requiredForCreate "@odata.id": SharedModels.graphUrl;
+  }
+
   namespace Foundations {
 
     @doc("Foundational operations for individual resources and collections.")
@@ -23,14 +28,14 @@ namespace MsGraph;
       ): TResponse | TErrorResponse;
 
       op ResourceOperation<
-        TResource extends {},
+        TResource,
         TParams,
         TResponse,
         TErrorResponse = ResourceErrorResponse
       > is GraphFoundations.Operation<TParams, TResponse, TErrorResponse>;
 
       op CollectionOperation<
-        TResource extends {},
+        TResource,
         TParams,
         TResponse,
         TErrorResponse = CollectionErrorResponse
@@ -41,19 +46,16 @@ namespace MsGraph;
   @doc("Primary operation shapes for Microsoft Graph")
   interface GraphOps {
 
-    // TODO: This is how we should make $select standard for Graph.  Define a select decorator and use it here.
-    // @select("*") 
     @get op GetCollection<
-    TResource extends {} = Automatic.CalculatedResourceType,
+    TResource = Automatic.CalculatedResourceType,
     TParams =  {... Automatic.GraphRouteParams},
     TResponse = CollectionResponse<TResource>,
     TErrorResponse = CollectionErrorResponse
     > is Foundations.GraphFoundations.CollectionOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
-    // @select("*")
     @get op GetPagedCollection<
-    TResource extends {} = Automatic.CalculatedResourceType,
+    TResource = Automatic.CalculatedResourceType,
     TParams =  {... Automatic.GraphRouteParams},
     TResponse = PagedCollectionResponse<TResource>,
     TErrorResponse = CollectionErrorResponse
@@ -62,26 +64,40 @@ namespace MsGraph;
 
 // TODO: GetDelta?  FUnction etc.?
 
-    // @select("*")
     @post op Post<
-      TResource extends {} = Automatic.CalculatedResourceType,
+      TResource = Automatic.CalculatedResourceType,
       TParams = { ... Automatic.GraphRouteParams, @body body: TResource },
       TResponse = ResourceCreatedResponse<TResource>,
       TErrorResponse = CollectionErrorResponse
     > is Foundations.GraphFoundations.CollectionOperation<
       TResource, TParams, TResponse, TErrorResponse>;
         
-    // @select("*")
+    @post op PostMediaValue<
+      TResource,
+      TParams = { ... Automatic.GraphRouteParams, ...TResource },
+      TResponse = ResourceCreatedResponse<TResource>,
+      TErrorResponse = CollectionErrorResponse
+    > is Foundations.GraphFoundations.CollectionOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+        
     @get op GetResource<
-    TResource extends {} = Automatic.CalculatedResourceType,
+    TResource = Automatic.CalculatedResourceType,
     TParams =  {... Automatic.GraphRouteParams},
     TResponse = ResourceResponse<TResource>,
     TErrorResponse = ResourceErrorResponse
     > is Foundations.GraphFoundations.ResourceOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
+    @get op GetMediaValue<
+    TResource,
+    TParams =  {... Automatic.GraphRouteParams, @path value:"$value"},
+    TResponse = ResourceResponse<TResource>,
+    TErrorResponse = ResourceErrorResponse
+    > is Foundations.GraphFoundations.ResourceOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
     @delete op Delete<
-    TResource extends {} = Automatic.CalculatedResourceType,
+    TResource = Automatic.CalculatedResourceType,
     TParams =  {... Automatic.GraphRouteParams},
     TResponse = EmptyResponse,
     TErrorResponse = ResourceErrorResponse
@@ -89,44 +105,83 @@ namespace MsGraph;
       TResource, TParams, TResponse, TErrorResponse>;
 
     @patch op PatchNoResponse<
-    TResource extends {} = Automatic.CalculatedResourceType,
-    TParams =  {... Automatic.GraphRouteParams},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
     TResponse = EmptyResponse,
     TErrorResponse = ResourceErrorResponse
     > is Foundations.GraphFoundations.ResourceOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
-    // @select("*")
     @patch op PatchWithResponse<
-    TResource extends {} = Automatic.CalculatedResourceType,
-    TParams =  {... Automatic.GraphRouteParams},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
     TResponse = ResourceResponse<TResource>,
     TErrorResponse = ResourceErrorResponse
     > is Foundations.GraphFoundations.ResourceOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
     @put op PutNoResponse<
-    TResource extends {} = Automatic.CalculatedResourceType,
-    TParams =  {... Automatic.GraphRouteParams},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
     TResponse = EmptyResponse,
     TErrorResponse = ResourceErrorResponse
     > is Foundations.GraphFoundations.ResourceOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
-    // @select("*")
     @put op PutWithResponse<
-    TResource extends {} = Automatic.CalculatedResourceType,
-    TParams =  {... Automatic.GraphRouteParams},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
     TResponse = ResourceResponse<TResource>,
     TErrorResponse = ResourceErrorResponse
     > is Foundations.GraphFoundations.ResourceOperation<
       TResource, TParams, TResponse, TErrorResponse>;
 
+    @put op PutMediaValueNoResponse<
+    TResource,
+    TParams =  {... Automatic.GraphRouteParams, @path value:"$value", ...TResource},
+    TResponse = EmptyResponse,
+    TErrorResponse = ResourceErrorResponse
+    > is Foundations.GraphFoundations.ResourceOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+
+    @action @returnSource(TSourceRoute) op Action<
+    TReturnType = void,
+    TActionParams extends {} = {},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, ... TActionParams},
+    TResponse = TReturnType,
+    TErrorResponse = MsGraph.Responses.OperationErrorResponse,
+    TSourceRoute extends valueof string | null = null
+    >(...TParams): TResponse | TErrorResponse;
+
+    @function(TNameOverride, TComposable) @returnSource(TSourceRoute) op Function<
+    TReturnType,
+    TFunctionParams extends {} = {},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, ... TFunctionParams},
+    TResponse = TReturnType,
+    TErrorResponse = MsGraph.Responses.OperationErrorResponse,
+    TComposable extends valueof boolean = false,
+    TNameOverride extends valueof string | null = null,
+    TSourceRoute extends valueof string | null = null
+    >(...TParams): TResponse | TErrorResponse;
+
+    @delta @function @returnSource(TSourceRoute) op Delta<
+    TReturnType=DeltaCollectionBody<Automatic.CalculatedResourceType>,
+    TFunctionParams extends {} = {},
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, ... TFunctionParams},
+    TResponse = TReturnType,
+    TErrorResponse = MsGraph.Responses.OperationErrorResponse,
+    TSourceRoute extends valueof string | null = null
+    >(...TParams): TResponse | TErrorResponse;
+
   }
 
   namespace Automatic {
     @doc("Marker type to allow injection of parameters from @route decorator.")
-    model GraphRouteParams { graphRouteParams: string }
+    model GraphRouteParams { @path graphRouteParams: string }
 
   // TODO: Needs direct support in the graphRoute decorator code to be able to make use of this.
     @doc("Marker type to indicate to emitter that it should calculate resource from the Resource type of the containing interface's extended interface.")