@microsoft/typespec-msgraph 0.0.1-Preview.2 → 0.0.1-Preview.20

package/lib/decorators.tsp

@@ -1,14 +1,73 @@
 using TypeSpec.Reflection;
 
 /**
- * TODO: Enable this once Model type is supported. https://github.com/microsoft/typespec/issues/1655
- * 
  * `@abstract` - mark a model type as abstract
  *
  * `@abstract` can only be applied to models.
-
+ */
 extern dec abstract(target: Model);
-*/
+
+/**
+ * `@action` - mark an operation as an action
+ *
+ * `@action` can only be applied to operations.
+ */
+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
+);
+
+/**
+ * `@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,
+  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[]);
 
 /**
  * `@alternateKey` - mark a model property as an alternateKey
@@ -18,14 +77,11 @@ extern dec abstract(target: Model);
 extern dec alternateKey(target: ModelProperty);
 
 /**
- * TODO: Enable this once Model type is supported. https://github.com/microsoft/typespec/issues/1655
- *
  * `@complex` - mark a model as an entity type
  *
  * `@complex` can only be applied to models.
-
-extern dec complex(target: Model);
  */
+extern dec complex(target: Model);
 
 /**
  * `@computed` - mark a model property as a computed property
@@ -48,28 +104,57 @@ 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.
+ *
+ * `@deltaCollection` can only be applied to models.
+ */
+extern dec deltaCollection(target: Model);
+
+/**
+ * `@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
+);
+
 /**
  * `@deprecatedDefinition` - Allow us create a reusable deprecation definition.
  * `@deprecatedDefinition` - Applies only to namespaces.
  */
 extern dec deprecatedDefinition(
   target: Namespace,
-  name: string,
-  category: string,
-  announcementDate: string,
-  removalDate: string,
-  description: string
+  name: valueof string,
+  category: valueof string,
+  announcementDate: valueof string,
+  removalDate: valueof string,
+  description: valueof string
 );
 
 /**
- * TODO: Enable this once Model type is supported. https://github.com/microsoft/typespec/issues/1655
- *
  * `@entity` - mark a model as an entity type
  *
  * `@entity` can only be applied to models.
-
-extern dec entity(target: Model);
  */
+extern dec entity(target: Model);
 
 /**
  * `@expand` - Applies to: get operations that return collections or individual instances of models that contain @contains or @references properties.
@@ -78,18 +163,118 @@ 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: string, ...otherProperties: 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.
+ * Indicates that the get operation supports OData $filter query parameter.
+ *
+ * `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[]
+);
+
+/**
+ * `@flags` - mark an enumeration type as a flag.
+ *
+ * `@flags` can only be applied to enums.
+ */
+extern dec flags(target: Enum);
+
+/**
+ * `@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);
+
+/**
+ * `@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
+);
+
+/**
+ * `@immutable` - mark a model property as immutable.
+ *
+ * `@immutable` can only be applied to model properties.
+ */
+extern dec immutable(target: ModelProperty);
+
+/**
+ * `@limitedCharset` - indicates that the full unicode character set is not supported by the underlying back-end service that implements the API.
+ *
+ * `@limitedCharset` can only be applied to string models properties, string parameters or their collections.
+ */
+extern dec limitedCharset(target: ModelProperty);
 
 /**
- * TODO: Enable this once Model type is supported. https://github.com/microsoft/typespec/issues/1655
+ * `@media` - indicates that an `@entity` model is a media entity.
  *
- * `@hasStream` - indicates that an `@entity` model has a stream.
+ * `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
  *
- * `mediaTypes` - list of media types supported by the stream.
- * If not specified, the stream supports any media type.
- 
- extern dec hasStream(target: Model, ...mediaTypes: string[]);
+ * `@open` can only be applied to models.
+ */
+extern dec open(target: Model);
+
+/**
+ * `@operationParameters` - A model with this decorator will not be generated in the CSDL
+ * and can't be reused by other models through inheritance,
+ * or any other way except through being a parameter for an action operation.
+ * The purpose of this model is only to define model parameters that would be too verbose.
+ * This decorator will be the equivalent of inlining the properties of the model into parameters of the operation.
  */
+extern dec operationParameters(target: Model);
 
 /**
  * `@orderBy` - Applies to: get operations that return collections of @entity or @complex models.
@@ -98,19 +283,56 @@ extern dec expand(target: Operation, property: string, ...otherProperties: strin
  * `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: string, ...otherProperties: string[]);
+extern dec orderBy(
+  target: Operation,
+  property: valueof string,
+  ...otherProperties: valueof string[]
+);
 
 /**
- * TODO: Enable this once Model type is supported. https://github.com/microsoft/typespec/issues/1655
+ * `@pagedCollection` - mark a model as representing a paged collection.
  *
+ * `@pagedCollection` can only be applied to models.
+ */
+extern dec pagedCollection(target: Model);
+
+/**
+ * `@partial` - Mark a model as partial.
+ *
+ * `@partial` can only be applied to models.
+ */
+extern dec partial(target: Model, value: 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
+);
+
+/**
  * `@privatePreview` - Allow us define a privatePreview element.
  * `@privatePreview` - Applies to models, model properties, enums, enum members, namespaces and operations.
-
+ */
 extern dec privatePreview(
   target: Model | ModelProperty | EnumMember | Enum | Operation | Namespace,
-  name: string
-)
- */
+  name: valueof string
+);
 
 /**
  * `@privatePreviewDefinition` - Allow us create a reusable private preview definition.
@@ -118,23 +340,27 @@ extern dec privatePreview(
  */
 extern dec privatePreviewDefinition(
   target: Namespace,
-  name: string,
-  announcementDate: string,
-  removalDate: string,
-  owner: string
+  name: valueof string,
+  announcementDate: valueof string,
+  removalDate: valueof string,
+  owner?: valueof string
 );
 
 /**
- * `@search` - Applies to: get operations that return collections.
- * Indicates that the get operation supports the OData $search query parameter.
+ * `@privileged` - mark the entity as privileged
+ *
+ * `@privileged` can be applied to Model, ModelProperty, Enum, EnumMember, Operation, Namespace.
  */
-extern dec search(target: Operation);
+extern dec privileged(
+  target: Model | ModelProperty | Enum | EnumMember | Operation | Namespace
+);
 
 /**
- * `@skip` - Applies to: get operations that return collections.
- * Indicates that the get operation supports the OData $skip query parameter.
+ * `@publicNamespace` - defines the namespace to be used in generating CSDL output for all elements contained within the namespace
+ *
+ * `@publicNamespace` can only be applied to namespaces.
  */
-extern dec skip(target: Operation);
+extern dec publicNamespace(target: Namespace, name: valueof string);
 
 /**
  * `@readOnly` - mark a model property as readOnly property
@@ -150,15 +376,99 @@ 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.
+ *
+ * `@requiredForCreate` can only be applied to model properties.
+ */
+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);
+
+/**
+ * `@skip` - Applies to: get operations that return collections.
+ * Indicates that the get operation supports the OData $skip query parameter.
+ */
+extern dec skip(target: Operation);
+
+/**
+ * `@select` - Applies to operations
+ *  Indicates that the operation supports the OData $select query parameter
+ */
+ extern dec select(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
  *
  * `@writeOnly` can only be applied to model properties.
  */
 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, value?: valueof boolean);
+
+/**
+ * `@workloadName` - specifies the name used by the underlying workload
+ *
+ * `@workloadName` can be applied to Model, ModelProperty, Enum, EnumMember.
+ */
+extern dec workloadName(
+  target: Model | ModelProperty | Enum | EnumMember,
+  workloadName: valueof string
+);
+
+/**
+ * `@workloadNameMsa` - specifies the name used by the underlying workload for consumer use cases
+ *
+ * `@workloadNameMsa` can be applied to Model, ModelProperty, Enum, EnumMember.
+ */
+extern dec workloadNameMsa(
+  target: Model | ModelProperty | Enum | EnumMember,
+  workloadNameMsa: valueof string
+);

package/lib/deployment.tsp

@@ -0,0 +1,18 @@
+namespace MsGraph.Deployment;
+
+enum deploymentTargets {
+  prodBeta,
+  prodV1_0,
+  prodEdu,
+  ppeBeta,
+  ppeV1_0,
+  ppeEdu,
+  mooncakeBeta,
+  mooncakeV1_0,
+  fairfaxBeta,
+  fairfaxV1_0,
+  usNatBeta,
+  usNatV1_0,
+  usSecBeta,
+  usSecV1_0
+}

package/lib/lib.tsp

@@ -1,35 +1,21 @@
 import "../dist/src/index.js";
-import "@typespec/rest";
+import "@typespec/http";
 
 using TypeSpec.Http;
-namespace TypeSpec.MsGraph;
+namespace MsGraph;
 
-scalar date;
+alias date=plainDate;
+alias dateTimeOffset=offsetDateTime;
+alias timeOfDay=plainTime;
 
 scalar stream;
 
-model ResourceResponse {}
+scalar guid extends string;
 
 model EmptyParameters {}
 
-model PagedListResponse {}
+// --- Base interfaces for all interfaces that contain operations returning entities.
 
-interface Item<T> {
-  @head _isOperation(@path id: string): T;
-}
+interface Resource<T> {}
 
-interface List<T> {
-  @head _isOperation(): T[];
-}
-
-interface Singleton<T> {
-  @head _isNavigationSource(@path id: string): T;
-}
-
-interface EntitySet<T> {
-  @head _isNavigationSource(): T[];
-}
-
-interface EntitySetResource<T> {
-  @head _isNavigationSource(@path id: string): T[];
-}
+interface Collection<T> {}

package/lib/msgraph.tsp

@@ -1,2 +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";