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

package/lib/porcelain.tsp

@@ -0,0 +1,190 @@
+// -------------------------------------------------
+// porcelain.tsp
+// Operation templates to provide a much-simplified syntax for defining standard Graph operations.
+// -------------------------------------------------
+import "@typespec/http";
+import "./lib.tsp";
+import "./shared-models.tsp";
+import "./responses.tsp";
+
+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.")
+    interface GraphFoundations {
+      op Operation<TParams, TResponse, TErrorResponse>(
+        ...TParams
+      ): TResponse | TErrorResponse;
+
+      op ResourceOperation<
+        TResource,
+        TParams,
+        TResponse,
+        TErrorResponse = ResourceErrorResponse
+      > is GraphFoundations.Operation<TParams, TResponse, TErrorResponse>;
+
+      op CollectionOperation<
+        TResource,
+        TParams,
+        TResponse,
+        TErrorResponse = CollectionErrorResponse
+      > is GraphFoundations.Operation<TParams, TResponse, TErrorResponse>;
+    }
+  }
+
+  @doc("Primary operation shapes for Microsoft Graph")
+  interface GraphOps {
+
+    @get op GetCollection<
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams},
+    TResponse = CollectionResponse<TResource>,
+    TErrorResponse = CollectionErrorResponse
+    > is Foundations.GraphFoundations.CollectionOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+    @get op GetPagedCollection<
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams},
+    TResponse = PagedCollectionResponse<TResource>,
+    TErrorResponse = CollectionErrorResponse
+    > is Foundations.GraphFoundations.CollectionOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+// TODO: GetDelta?  FUnction etc.?
+
+    @post op Post<
+      TResource = Automatic.CalculatedResourceType,
+      TParams = { ... Automatic.GraphRouteParams, @body body: TResource },
+      TResponse = ResourceCreatedResponse<TResource>,
+      TErrorResponse = CollectionErrorResponse
+    > is Foundations.GraphFoundations.CollectionOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+        
+    @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 = 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 = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams},
+    TResponse = EmptyResponse,
+    TErrorResponse = ResourceErrorResponse
+    > is Foundations.GraphFoundations.ResourceOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+    @patch op PatchNoResponse<
+    TResource = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
+    TResponse = EmptyResponse,
+    TErrorResponse = ResourceErrorResponse
+    > is Foundations.GraphFoundations.ResourceOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+    @patch op PatchWithResponse<
+    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 = Automatic.CalculatedResourceType,
+    TParams =  {... Automatic.GraphRouteParams, @body body: TResource},
+    TResponse = EmptyResponse,
+    TErrorResponse = ResourceErrorResponse
+    > is Foundations.GraphFoundations.ResourceOperation<
+      TResource, TParams, TResponse, TErrorResponse>;
+
+    @put op PutWithResponse<
+    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 { @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.")
+    model CalculatedResourceType {}
+  }
+

package/lib/responses.tsp

@@ -0,0 +1,59 @@
+// -------------------------------------------------
+// responses.tsp
+// Standard responses that Graph will return.
+// -------------------------------------------------
+import "@typespec/http";
+import "@microsoft/typespec-msgraph";
+import "./shared-models.tsp";
+import "./bodies.tsp";
+
+using TypeSpec.Http;
+using MsGraph;
+using MsGraph.SharedModels;
+using MsGraph.Bodies;
+
+// Response models represent the response as a whole, including the status code, headers, and body.
+namespace MsGraph.Responses {
+  /** Response to represent a Microsoft Graph collection response payload. */
+  model CollectionResponse<TResource, TStatus = 200, TBody = Bodies.CollectionBody<TResource>> 
+    is Http.Response<TStatus> {
+    ...Http.Body<TBody>;
+  }
+
+  /** Response to represent a Microsoft Graph paged collection response payload. */ 
+  model PagedCollectionResponse<TResource, TStatus = 200, TBody = Bodies.PagedCollectionBody<TResource>>
+    is CollectionResponse<TResource, TStatus, TBody>;
+
+  /** Response to represent a Microsoft Graph individual resource response payload. */
+  model ResourceResponse<TResource, TStatus = 200, TBody = TResource>
+    is Http.Response<TStatus> {
+    ...Http.Body<TBody>;
+  }
+
+  /** Response to represent a Microsoft Graph individual resource response payload. */
+  model ScalarResponse<TScalar, TStatus = 200, TBody = TScalar>
+    is Http.Response<TStatus> {
+    ...Http.Body<TBody>;
+  }
+
+  /** Response to represent a Microsoft Graph resource creation response payload. */
+  model ResourceCreatedResponse<TResource, TStatus = 201, TBody = TResource>
+    is ResourceResponse<TResource, TStatus, TBody> {
+    ...Http.LocationHeader
+  }
+
+  /** Response to represent a Microsoft Graph empty response payload. */
+  model EmptyResponse
+    is Http.Response<204>;
+  
+  /** Response to represent a Microsoft Graph error response payload. */
+  model ErrorResponse<TStatus>
+   is Http.Response<TStatus> {
+    ...Http.Body<Bodies.ErrorBody>;
+  }
+
+  alias ResourceErrorResponse = ErrorResponse<400 | 404 | 429>;
+  alias CollectionErrorResponse = ErrorResponse<400 | 429>;
+  alias OperationErrorResponse = ErrorResponse<400 | 429>;
+  
+}

package/lib/shared-models.tsp

@@ -0,0 +1,30 @@
+// -------------------------------------------------
+// shared-models.tsp
+// Common types shared among many workloads on Microsoft Graph
+// -------------------------------------------------
+import "@microsoft/typespec-msgraph";
+
+using MsGraph;
+
+@publicNamespace("microsoft.graph")
+namespace MsGraph.SharedModels;
+
+  // TODO: Spec how to deal with specified and unspecified ultimate base entities w.r.t. AGS runtime replacement policies. See #140
+  @doc("The primary entity base model for Microsoft Graph.")
+  @entity
+  model entity {
+    @key id: string;
+  }
+
+
+  @doc("Scalar type for URLs that would be expected to work in the browser address bar.")
+  scalar webUrl extends url;
+
+  @doc("Scalar type for URLs that represent Graph APIs.")
+  scalar graphUrl extends url;
+
+  @doc("A dictionary of name-value pairs. Names must be valid property names, values may be restricted to a list of types via an annotation with term `Validation.OpenPropertyTypeConstraint")
+  @open
+  @complex
+  model Dictionary {}
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/typespec-msgraph",
-  "version": "0.0.1-Preview.2",
+  "version": "0.0.1-Preview.21",
   "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",
@@ -10,8 +10,12 @@
     "type": "git",
     "url": "git+https://github.com/microsoftgraph/typespec-msgraph.git"
   },
-  "bugs": { "url": "https://github.com/microsoftgraph/typespec-msgraph/issues" },
-  "keywords": ["typespec"],
+  "bugs": {
+    "url": "https://github.com/microsoftgraph/typespec-msgraph/issues"
+  },
+  "keywords": [
+    "typespec"
+  ],
   "type": "module",
   "main": "dist/src/index.js",
   "tspMain": "lib/msgraph.tsp",
@@ -21,48 +25,53 @@
   },
   "typesVersions": {
     "*": {
-      "*": ["./dist/src/index.d.ts"],
-      "testing": ["./dist/src/testing/index.d.ts"]
+      "*": [
+        "./dist/src/index.d.ts"
+      ],
+      "testing": [
+        "./dist/src/testing/index.d.ts"
+      ]
     }
   },
-  "engines": { "node": ">=14.0.0" },
+  "engines": {
+    "node": ">=14.0.0"
+  },
   "scripts": {
     "clean": "rimraf ./dist ./temp",
-    "prebuild": "tsx src/decorators/attribute-builder.ts",
     "build": "tsc -p .",
     "watch": "tsc -p . --watch",
-    "test": "mocha",
-    "buildntest": "tsc -p . && mocha",
-    "test-official": "c8 mocha --forbid-only",
+    "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"
   },
-  "files": ["lib/*.tsp", "dist/**", "!dist/test/**"],
-  "peerDependencies": { "@typespec/compiler": "~0.43.0" },
+  "files": [
+    "lib/*.tsp",
+    "dist/**",
+    "!dist/test/**"
+  ],
   "dependencies": {
-    "prettier": "~2.8.7",
-    "react-dom": "~18.2.0",
-    "react": "~18.2.0",
-    "react-reconciler": "~0.27.0"
+    "@xmldom/xmldom": "~0.8.4",
+    "@typespec/compiler": "~0.56.0",
+    "@typespec/http": "~0.56.0",
+    "prettier": "~3.2.5",
+    "react-dom": "~18.3.1",
+    "react": "~18.3.1",
+    "react-reconciler": "~0.29.0"
   },
   "devDependencies": {
-    "@types/mocha": "~10.0.0",
-    "@types/node": "~18.11.9",
-    "@types/prettier": "2.6.0",
-    "@types/react": "~18.0.5",
+    "@types/mocha": "~10.0.1",
+    "@types/node": "~20.12.7",
+    "@types/react": "~18.3.1",
     "@types/react-reconciler": "~0.28.0",
-    "@typespec/compiler": "~0.43.0",
-    "@typespec/eslint-config-typespec": "~0.6.0",
-    "@typespec/http": "~0.43.1",
-    "@typespec/lint": "~0.43.0",
-    "@typespec/rest": "~0.43.0",
-    "@xmldom/xmldom": "~0.8.2",
-    "c8": "~7.13.0",
-    "eslint": "^8.36.0",
-    "mocha": "~10.2.0",
-    "rimraf": "~5.0.0",
-    "typescript": "~5.0.2",
+    "c8": "~9.1.0",
+    "eslint": "^9.1.1",
+    "mocha": "~10.4.0",
+    "rimraf": "~5.0.1",
+    "typescript": "~5.4.5",
     "xpath": "~0.0.32",
-    "tsx": "~3.12.3"
+    "tsx": "~4.8.1",
+    "source-map-support": "latest"
   }
 }

package/dist/src/components/program-context.d.ts

@@ -1,4 +0,0 @@
-import { Program } from "@typespec/compiler";
-import React from "react";
-export declare const ProgramContext: React.Context<Program>;
-//# sourceMappingURL=program-context.d.ts.map

package/dist/src/components/program-context.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"program-context.d.ts","sourceRoot":"","sources":["../../../src/components/program-context.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAC7C,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,eAAO,MAAM,cAAc,wBAA0C,CAAC"}

package/dist/src/components/program-context.js

@@ -1,3 +0,0 @@
-import React from "react";
-export const ProgramContext = React.createContext({});
-//# sourceMappingURL=program-context.js.map

package/dist/src/components/program-context.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"program-context.js","sourceRoot":"","sources":["../../../src/components/program-context.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,CAAC,aAAa,CAAU,EAAS,CAAC,CAAC"}

package/dist/src/csdl.d.ts

@@ -1,8 +0,0 @@
-import { Program } from "@typespec/compiler";
-import { FunctionComponent } from "react";
-export declare function renderCsdl(program: Program): string;
-export interface TypeSpecProgramViewerProps {
-    program: Program;
-}
-export declare const TypeSpecProgramViewer: FunctionComponent<TypeSpecProgramViewerProps>;
-//# sourceMappingURL=csdl.d.ts.map

package/dist/src/csdl.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"csdl.d.ts","sourceRoot":"","sources":["../../src/csdl.tsx"],"names":[],"mappings":"AAAA,OAAO,EASL,OAAO,EAER,MAAM,oBAAoB,CAAC;AAK5B,OAAc,EAAE,iBAAiB,EAAc,MAAM,OAAO,CAAC;AA6C7D,wBAAgB,UAAU,CAAC,OAAO,EAAE,OAAO,UAK1C;AAED,MAAM,WAAW,0BAA0B;IACzC,OAAO,EAAE,OAAO,CAAC;CAClB;AAWD,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,0BAA0B,CAkB/E,CAAC"}