@typespec/http-client-csharp 0.1.9 → 1.0.0-alpha.20250314.6

package/dist/generator/Microsoft.TypeSpec.Generator.runtimeconfig.json

@@ -0,0 +1,12 @@
+{
+  "runtimeOptions": {
+    "tfm": "net8.0",
+    "framework": {
+      "name": "Microsoft.NETCore.App",
+      "version": "8.0.0"
+    },
+    "configProperties": {
+      "System.Runtime.Serialization.EnableUnsafeBinaryFormatterSerialization": false
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http-client-csharp",
-  "version": "0.1.9",
+  "version": "1.0.0-alpha.20250314.6",
   "author": "Microsoft Corporation",
   "description": "The typespec library that can be used to generate C# models from a TypeSpec REST protocol binding",
   "homepage": "https://github.com/Microsoft/typespec",
@@ -17,47 +17,9 @@
     "typespec"
   ],
   "type": "module",
-  "main": "dist/emitter/index.js",
+  "main": "dist/emitter/src/index.js",
   "exports": {
-    ".": "./dist/emitter/index.js"
-  },
-  "files": [
-    "dist/**"
-  ],
-  "dependencies": {
-    "@typespec/http-client-csharp": "file:",
-    "json-serialize-refs": "0.1.0-0"
-  },
-  "peerDependencies": {
-    "@azure-tools/typespec-azure-core": ">=0.50.0 <1.0.0 || ~0.51.0-0",
-    "@azure-tools/typespec-client-generator-core": ">=0.50.0 <1.0.0 || ~0.51.0-0",
-    "@typespec/compiler": ">=0.64.0 <1.0.0 || ~0.65.0-0",
-    "@typespec/http": ">=0.64.0 <1.0.0 || ~0.65.0-0",
-    "@typespec/openapi": ">=0.64.0 <1.0.0 || ~0.65.0-0",
-    "@typespec/rest": ">=0.64.0 <1.0.0 || ~0.65.0-0",
-    "@typespec/versioning": ">=0.64.0 <1.0.0 || ~0.65.0-0"
-  },
-  "devDependencies": {
-    "@azure-tools/azure-http-specs": "0.1.0-alpha.5",
-    "@azure-tools/typespec-azure-core": "0.50.0",
-    "@azure-tools/typespec-client-generator-core": "0.50.2",
-    "@microsoft/api-extractor": "^7.47.11",
-    "@types/node": "~22.7.5",
-    "@typespec/compiler": "0.64.0",
-    "@typespec/http": "0.64.0",
-    "@typespec/http-specs": "0.1.0-alpha.7",
-    "@typespec/json-schema": "0.64.0",
-    "@typespec/library-linter": "0.64.0",
-    "@typespec/openapi": "0.64.0",
-    "@typespec/rest": "0.64.1",
-    "@typespec/versioning": "0.64.0",
-    "@typespec/xml": "^0.64.0",
-    "@vitest/coverage-v8": "^3.0.5",
-    "@vitest/ui": "^3.0.5",
-    "c8": "^10.1.2",
-    "rimraf": "~6.0.1",
-    "typescript": "~5.6.3",
-    "vitest": "^3.0.5"
+    ".": "./dist/emitter/src/index.js"
   },
   "scripts": {
     "clean": "rimraf ./dist ./emitter/temp && dotnet clean ./generator",
@@ -76,5 +38,43 @@
     "lint:fix": "eslint . --fix",
     "format": "pnpm -w format:dir packages/http-client-csharp",
     "extract-api": "npx api-extractor run --local --verbose"
+  },
+  "files": [
+    "dist/emitter/src/**",
+    "dist/generator/**"
+  ],
+  "dependencies": {
+    "json-serialize-refs": "0.1.0-0"
+  },
+  "peerDependencies": {
+    "@azure-tools/typespec-azure-core": ">=0.52.0 <1.0.0 || ~0.53.0-0",
+    "@azure-tools/typespec-client-generator-core": ">=0.52.0 <1.0.0 || ~0.53.0-0",
+    "@typespec/compiler": ">=0.66.0 <1.0.0 || ~0.67.0-0",
+    "@typespec/http": ">=0.66.0 <1.0.0 || ~0.67.0-0",
+    "@typespec/openapi": ">=0.66.0 <1.0.0 || ~0.67.0-0",
+    "@typespec/rest": ">=0.66.0 <1.0.0 || ~0.67.0-0",
+    "@typespec/versioning": ">=0.66.0 <1.0.0 || ~0.67.0-0"
+  },
+  "devDependencies": {
+    "@azure-tools/azure-http-specs": "0.1.0-alpha.7",
+    "@azure-tools/typespec-azure-core": "0.52.0",
+    "@azure-tools/typespec-client-generator-core": "0.52.0",
+    "@microsoft/api-extractor": "^7.47.11",
+    "@types/node": "~22.7.5",
+    "@typespec/compiler": "0.66.0",
+    "@typespec/http": "0.66.0",
+    "@typespec/http-specs": "0.1.0-alpha.12",
+    "@typespec/json-schema": "0.66.0",
+    "@typespec/library-linter": "0.66.0",
+    "@typespec/openapi": "0.66.0",
+    "@typespec/rest": "0.66.0",
+    "@typespec/versioning": "0.66.0",
+    "@typespec/xml": "^0.66.0",
+    "@vitest/coverage-v8": "^3.0.5",
+    "@vitest/ui": "^3.0.5",
+    "c8": "^10.1.2",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.6.3",
+    "vitest": "^3.0.5"
   }
 }

package/readme.md

@@ -33,7 +33,7 @@ npx tsp compile main.tsp --emit @typespec/http-client-csharp
 
 You can further configure the SDK generated, using the emitter options on @typespec/http-client-csharp.
 
-You can set options in the command line directly via `--option @typespec/http-client-csharp.<optionName>=XXX`, e.g. `--option @typespec/http-client-csharp.namespace=MyService.Namespace`
+You can set options in the command line directly via `--option @typespec/http-client-csharp.<optionName>=XXX`, e.g. `--option @typespec/http-client-csharp.package-name=MyService`
 
 or
 
@@ -44,28 +44,32 @@ emit:
   - "@typespec/http-client-csharp"
 options:
   "@typespec/http-client-csharp":
-+    namespace: MyService.Namespace
++    package-name: MyService
 ```
 
 **Supported Emitter options**:
 
-- `namespace` define the client library namespace. e.g. MyService.Namespace.
-- `emitter-output-dir` define the output dire path which will store the generated code.
-- `generate-protocol-methods` indicate if you want to generate **protocol method** for every operation or not. The default value is true.
-- `generate-convenience-methods` indicate if you want to generate **convenience method** for every operation or not. The default value is true.
-- `unreferenced-types-handling` define the strategy how to handle the unreferenced types. It can be `removeOrInternalize`, `internalize` or `keepAll`
-- `model-namespace` indicate if we want to put the models in their own namespace which is a sub namespace of the client library namespace plus ".Models". if it is set `false`, the models will be put in the same namespace of the client. The default value is `true`.
-- `clear-output-folder` indicate if you want to clear up the output folder.
-- `package-name` define the package name.
+- `package-name` define the package name. If not specified, the first namespace defined in the TypeSpec is used as the package name.
+- `emitter-output-dir` define the output directory path which will store the generated code. If not specified, the `tsp-output` directory is used.
+- `generate-protocol-methods` indicate if you want to generate a **protocol method** for every operation or not. The default value is `true`.
+- `generate-convenience-methods` indicate if you want to generate a **convenience method** for every operation or not. The default value is `true`.
+- `disable-xml-docs` set to `true` to not generate XML docs in the generated library. The default value is `false`.
+- `api-version` for TypeSpec files using the [`@versioned`](https://typespec.io/docs/libraries/versioning/reference/decorators/#@TypeSpec.Versioning.versioned) decorator, set to the version that should be used to generate against.
+- `unreferenced-types-handling` define the strategy how to handle unreferenced types. It can be `removeOrInternalize`, `internalize` or `keepAll`. The default value is `removeOrInternalize`.
+- `clear-output-folder` indicate if you want to clear up the output folder before generating. The default value is `true`.
+- `new-project` set to `true` to overwrite the csproj if it already exists. The default value is `false`.
+- `save-inputs` set to `true` to save the `tspCodeModel.json` and `Configuration.json` files that are emitted and used as inputs to the C# generator. The default value is `false`.
+- `debug` set to `true` to automatically attempt to attach to a debugger when executing the C# generator. The default value is `false`.
+- `plugin-name` by default this is set to `ScmCodeModelPlugin`. Plugin authors can set this to the name of a plugin that inherits from `ScmCodeModelPlugin`.
 
 ## Convenience API
 
 By default, TypeSpec csharp generates all protocol APIs and convenience APIs.
 A few exceptions are API of JSON Merge Patch, and API of long-running operation with ambiguous response type.
 
-You can configure whether generate convenience API or not via `convenienceAPI` decorator.
+You can configure whether to generate a convenience method for a specific operation via the `convenienceAPI` decorator.
 
 ## Spector Tests
 
 We run the generator against the common set of test defined in https://github.com/microsoft/typespec/tree/main/packages/http-specs.
-For details on how to run and debug these tests see [Spector Testing](generator/docs/spector.md)
+For details on how to run and debug these tests see [Spector Testing](generator/docs/spector.md).

package/LICENSE

@@ -1,21 +0,0 @@
-    MIT License
-
-    Copyright (c) Microsoft Corporation. All rights reserved.
-
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be included in all
-    copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-    SOFTWARE