@typespec/http-server-csharp 0.58.0-alpha.2 → 0.58.0-alpha.20-dev.0

package/dist/src/lib/lib.js

@@ -0,0 +1,146 @@
+import { createTypeSpecLibrary, paramMessage } from "@typespec/compiler";
+import { CollectionType, resolveCollectionType } from "./interfaces.js";
+const EmitterOptionsSchema = {
+    type: "object",
+    additionalProperties: false,
+    properties: {
+        "skip-format": {
+            type: "boolean",
+            nullable: true,
+            description: "Skips formatting of generated C# Types.  By default, C# files are formatted using 'dotnet format'.",
+        },
+        "output-type": {
+            type: "string",
+            enum: ["models", "all"],
+            nullable: true,
+            default: "all",
+            description: "Chooses which service artifacts to emit. choices include 'models' or 'all' artifacts.",
+        },
+        "emit-mocks": {
+            type: "string",
+            enum: ["mocks-and-project-files", "mocks-only", "none"],
+            nullable: true,
+            default: "none",
+            description: "Emits mock implementations of business logic, setup code, and project files, enabling the service to respond to requests before a real implementation is provided",
+        },
+        "use-swaggerui": {
+            type: "boolean",
+            nullable: true,
+            default: false,
+            description: "Configure a Swagger UI endpoint in the development configuration",
+        },
+        "openapi-path": {
+            type: "string",
+            nullable: true,
+            default: null,
+            description: "Use openapi at the given path for generating SwaggerUI endpoints. By default, this will be 'openapi/openapi.yaml' if the 'use-swaggerui' option is enabled. ",
+        },
+        overwrite: {
+            type: "boolean",
+            nullable: true,
+            default: false,
+            description: "When generating mock and project files, overwrite any existing files with the same name.",
+        },
+        "project-name": {
+            type: "string",
+            nullable: true,
+            default: "ServiceProject",
+            description: "The name of the generated project.",
+        },
+        "http-port": {
+            type: "number",
+            nullable: true,
+            description: "The service http port when hosting the project locally.",
+        },
+        "https-port": {
+            type: "number",
+            nullable: true,
+            description: "The service https port when hosting the project locally.",
+        },
+        "collection-type": {
+            type: "string",
+            enum: ["array", "enumerable"],
+            nullable: true,
+            default: "array",
+            description: "Specifies the collection type to use: 'array' or 'enumerable'. The default is 'array'.",
+        },
+    },
+    required: [],
+};
+export const $lib = createTypeSpecLibrary({
+    name: "@typespec/http-server-csharp",
+    capabilities: {
+        dryRun: true,
+    },
+    diagnostics: {
+        "invalid-identifier": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Invalid identifier '${"identifier"}' in ${"location"}`,
+            },
+        },
+        "anonymous-model": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Inline models use generated names in emitted code. Consider defining each model with an explicit name.  This model will be named '${"emittedName"}' in emitted code`,
+            },
+        },
+        "missing-type-parent": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `No parent found for ${"type"} ${"name"} `,
+            },
+        },
+        "no-numeric": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Type '${"sourceType"}' is an imprecise type that does not map directly to a single numeric type, using '${"targetType"}' as the safest c# numeric type.  Please specify a more precise numeric type, like 'int32' or 'float64'`,
+            },
+        },
+        "unrecognized-scalar": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Scalar type ${"typeName"} is not a recognized scalar type.  Please use or extend a built-in scalar type.`,
+            },
+        },
+        "invalid-intrinsic": {
+            severity: "error",
+            messages: {
+                default: paramMessage `Intrinsic type ${"typeName"} is not valid in this context.  Please use a model, enum, union, scalar, or the unknown type`,
+            },
+        },
+        "invalid-interpolation": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `StringTemplate types should only reference literal-valued constants, enum members, or literal-valued model properties.  The interpolated value will not contain one or more referenced elements in generated code.`,
+            },
+        },
+        "get-request-body": {
+            severity: "warning",
+            messages: {
+                default: paramMessage `Get operations should not have request bodies. Generating an operation and interface without parameters, your business logic will use HttpContext to interpret Request properties.`,
+            },
+        },
+    },
+    emitter: {
+        options: EmitterOptionsSchema,
+    },
+});
+export const { reportDiagnostic, createStateSymbol, getTracer } = $lib;
+export class CSharpServiceOptions {
+    static instance;
+    collectionType;
+    constructor() {
+        this.collectionType = CollectionType.Array;
+    }
+    static getInstance() {
+        if (!CSharpServiceOptions.instance) {
+            CSharpServiceOptions.instance = new CSharpServiceOptions();
+        }
+        return CSharpServiceOptions.instance;
+    }
+    initialize(options) {
+        this.collectionType = resolveCollectionType(options["collection-type"]);
+    }
+}
+//# sourceMappingURL=lib.js.map

package/dist/src/lib/lib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lib.js","sourceRoot":"","sources":["../../../src/lib/lib.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAkB,YAAY,EAAE,MAAM,oBAAoB,CAAC;AACzF,OAAO,EAAE,cAAc,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAyBxE,MAAM,oBAAoB,GAAgD;IACxE,IAAI,EAAE,QAAQ;IACd,oBAAoB,EAAE,KAAK;IAC3B,UAAU,EAAE;QACV,aAAa,EAAE;YACb,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,WAAW,EACT,oGAAoG;SACvG;QACD,aAAa,EAAE;YACb,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,EAAE,KAAK,CAAC;YACvB,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;YACd,WAAW,EACT,uFAAuF;SAC1F;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,yBAAyB,EAAE,YAAY,EAAE,MAAM,CAAC;YACvD,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,MAAM;YACf,WAAW,EACT,mKAAmK;SACtK;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;YACd,WAAW,EAAE,kEAAkE;SAChF;QACD,cAAc,EAAE;YACd,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,IAAI;YACb,WAAW,EACT,8JAA8J;SACjK;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,KAAK;YACd,WAAW,EACT,0FAA0F;SAC7F;QACD,cAAc,EAAE;YACd,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,gBAAgB;YACzB,WAAW,EAAE,oCAAoC;SAClD;QACD,WAAW,EAAE;YACX,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,yDAAyD;SACvE;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,IAAI;YACd,WAAW,EAAE,0DAA0D;SACxE;QACD,iBAAiB,EAAE;YACjB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC;YAC7B,QAAQ,EAAE,IAAI;YACd,OAAO,EAAE,OAAO;YAChB,WAAW,EACT,wFAAwF;SAC3F;KACF;IACD,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,qBAAqB,CAAC;IACxC,IAAI,EAAE,8BAA8B;IACpC,YAAY,EAAE;QACZ,MAAM,EAAE,IAAI;KACb;IACD,WAAW,EAAE;QACX,oBAAoB,EAAE;YACpB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,uBAAuB,YAAY,QAAQ,UAAU,EAAE;aAC7E;SACF;QACD,iBAAiB,EAAE;YACjB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,qIAAqI,aAAa,mBAAmB;aAC3L;SACF;QACD,qBAAqB,EAAE;YACrB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,uBAAuB,MAAM,IAAI,MAAM,GAAG;aAChE;SACF;QACD,YAAY,EAAE;YACZ,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,SAAS,YAAY,sFAAsF,YAAY,yGAAyG;aACtP;SACF;QACD,qBAAqB,EAAE;YACrB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,eAAe,UAAU,iFAAiF;aAChI;SACF;QACD,mBAAmB,EAAE;YACnB,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,kBAAkB,UAAU,8FAA8F;aAChJ;SACF;QACD,uBAAuB,EAAE;YACvB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,oNAAoN;aAC1O;SACF;QACD,kBAAkB,EAAE;YAClB,QAAQ,EAAE,SAAS;YACnB,QAAQ,EAAE;gBACR,OAAO,EAAE,YAAY,CAAA,oLAAoL;aAC1M;SACF;KACF;IACD,OAAO,EAAE;QACP,OAAO,EAAE,oBAAmE;KAC7E;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,SAAS,EAAE,GAAG,IAAI,CAAC;AAIvE,MAAM,OAAO,oBAAoB;IACvB,MAAM,CAAC,QAAQ,CAAuB;IACvC,cAAc,CAAiB;IAEtC;QACE,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC,KAAK,CAAC;IAC7C,CAAC;IAEM,MAAM,CAAC,WAAW;QACvB,IAAI,CAAC,oBAAoB,CAAC,QAAQ,EAAE,CAAC;YACnC,oBAAoB,CAAC,QAAQ,GAAG,IAAI,oBAAoB,EAAE,CAAC;QAC7D,CAAC;QACD,OAAO,oBAAoB,CAAC,QAAQ,CAAC;IACvC,CAAC;IAEM,UAAU,CAAC,OAAuC;QACvD,IAAI,CAAC,cAAc,GAAG,qBAAqB,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAC1E,CAAC;CACF"}

package/dist/src/lib/project.d.ts

@@ -0,0 +1,5 @@
+import { AssetEmitter } from "@typespec/asset-emitter";
+import { LibrarySourceFile } from "./interfaces.js";
+import { CSharpServiceEmitterOptions } from "./lib.js";
+export declare function getProjectHelpers(emitter: AssetEmitter<string, CSharpServiceEmitterOptions>, projectName: string, useSwaggerUI: boolean, httpPort: number, httpsPort: number): LibrarySourceFile[];
+//# sourceMappingURL=project.d.ts.map

package/dist/src/lib/project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.d.ts","sourceRoot":"","sources":["../../../src/lib/project.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAEvD,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,2BAA2B,CAAC,EAC1D,WAAW,EAAE,MAAM,EACnB,YAAY,EAAE,OAAO,EACrB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,GAChB,iBAAiB,EAAE,CAgCrB"}

package/dist/src/lib/project.js

@@ -0,0 +1,101 @@
+import { LibrarySourceFile } from "./interfaces.js";
+export function getProjectHelpers(emitter, projectName, useSwaggerUI, httpPort, httpsPort) {
+    const result = [
+        new LibrarySourceFile({
+            filename: `${projectName}.csproj`,
+            emitter: emitter,
+            getContents: () => getProjectFile(useSwaggerUI),
+            path: ".",
+            conditional: true,
+        }),
+        new LibrarySourceFile({
+            filename: "appsettings.json",
+            emitter: emitter,
+            getContents: getAppSettings,
+            path: ".",
+            conditional: true,
+        }),
+        new LibrarySourceFile({
+            filename: "appsettings.Development.json",
+            emitter: emitter,
+            getContents: getDeveloperAppSettings,
+            path: ".",
+            conditional: true,
+        }),
+        new LibrarySourceFile({
+            filename: "launchSettings.json",
+            emitter: emitter,
+            getContents: () => getLaunchSettings(httpPort, httpsPort),
+            path: "Properties",
+            conditional: true,
+        }),
+    ];
+    return result;
+}
+function getProjectFile(useSwaggerUI) {
+    return `<Project Sdk="Microsoft.NET.Sdk.Web">
+
+  <PropertyGroup>
+    <TargetFramework>net9.0</TargetFramework>
+    <Nullable>enable</Nullable>
+    <ImplicitUsings>enable</ImplicitUsings>
+  </PropertyGroup>
+
+${useSwaggerUI
+        ? `  <ItemGroup>
+    <PackageReference Include="SwashBuckle.AspNetCore" Version="7.3.1" />
+  </ItemGroup>`
+        : ""}
+
+</Project>
+`;
+}
+function getAppSettings() {
+    return `{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  },
+  "AllowedHosts": "*"
+}
+`;
+}
+function getDeveloperAppSettings() {
+    return `{
+  "Logging": {
+    "LogLevel": {
+      "Default": "Information",
+      "Microsoft.AspNetCore": "Warning"
+    }
+  }
+}
+`;
+}
+function getLaunchSettings(httpPort, httpsPort) {
+    return `{
+    "$schema": "https://json.schemastore.org/launchsettings.json",
+    "profiles": {
+      "https": {
+        "commandName": "Project",
+        "dotnetRunMessages": true,
+        "launchBrowser": true,
+        "applicationUrl": "https://localhost:${httpsPort};http://localhost:${httpPort}",
+        "environmentVariables": {
+          "ASPNETCORE_ENVIRONMENT": "Development"
+        }
+      },
+      "http": {
+        "commandName": "Project",
+        "dotnetRunMessages": true,
+        "launchBrowser": true,
+        "applicationUrl": "http://localhost:${httpPort}",
+        "environmentVariables": {
+          "ASPNETCORE_ENVIRONMENT": "Development"
+        }
+      }
+    }
+  }`;
+}
+//# sourceMappingURL=project.js.map

package/dist/src/lib/project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../../../src/lib/project.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAGpD,MAAM,UAAU,iBAAiB,CAC/B,OAA0D,EAC1D,WAAmB,EACnB,YAAqB,EACrB,QAAgB,EAChB,SAAiB;IAEjB,MAAM,MAAM,GAAwB;QAClC,IAAI,iBAAiB,CAAC;YACpB,QAAQ,EAAE,GAAG,WAAW,SAAS;YACjC,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,GAAG,EAAE,CAAC,cAAc,CAAC,YAAY,CAAC;YAC/C,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,IAAI;SAClB,CAAC;QACF,IAAI,iBAAiB,CAAC;YACpB,QAAQ,EAAE,kBAAkB;YAC5B,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,cAAc;YAC3B,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,IAAI;SAClB,CAAC;QACF,IAAI,iBAAiB,CAAC;YACpB,QAAQ,EAAE,8BAA8B;YACxC,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,uBAAuB;YACpC,IAAI,EAAE,GAAG;YACT,WAAW,EAAE,IAAI;SAClB,CAAC;QACF,IAAI,iBAAiB,CAAC;YACpB,QAAQ,EAAE,qBAAqB;YAC/B,OAAO,EAAE,OAAO;YAChB,WAAW,EAAE,GAAG,EAAE,CAAC,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC;YACzD,IAAI,EAAE,YAAY;YAClB,WAAW,EAAE,IAAI;SAClB,CAAC;KACH,CAAC;IACF,OAAO,MAAM,CAAC;AAChB,CAAC;AACD,SAAS,cAAc,CAAC,YAAqB;IAC3C,OAAO;;;;;;;;EASP,YAAY;QACV,CAAC,CAAC;;eAES;QACX,CAAC,CAAC,EACN;;;CAGC,CAAC;AACF,CAAC;AACD,SAAS,cAAc;IACrB,OAAO;;;;;;;;;CASR,CAAC;AACF,CAAC;AAED,SAAS,uBAAuB;IAC9B,OAAO;;;;;;;;CAQR,CAAC;AACF,CAAC;AAED,SAAS,iBAAiB,CAAC,QAAgB,EAAE,SAAiB;IAC5D,OAAO;;;;;;;+CAOsC,SAAS,qBAAqB,QAAQ;;;;;;;;;8CASvC,QAAQ;;;;;;IAMlD,CAAC;AACL,CAAC"}

package/dist/src/lib/scaffolding.d.ts

@@ -0,0 +1,22 @@
+import { AssetEmitter } from "@typespec/asset-emitter";
+import { CSharpCollectionType, CSharpType, LibrarySourceFile } from "./interfaces.js";
+import { CSharpServiceEmitterOptions } from "./lib.js";
+export interface BusinessLogicImplementation {
+    namespace: string;
+    interfaceName: string;
+    usings: string[];
+    className: string;
+    methods: BusinessLogicMethod[];
+}
+export interface BusinessLogicMethod {
+    methodName: string;
+    methodParams: string;
+    returnTypeName: string;
+    returnType: CSharpType | CSharpCollectionType;
+    instantiatedReturnType?: string;
+}
+export type BusinessLogicRegistrations = Map<string, BusinessLogicImplementation>;
+export type BusinessLogicRegistration = [string, BusinessLogicImplementation];
+export declare function getScaffoldingHelpers(emitter: AssetEmitter<string, CSharpServiceEmitterOptions>, useSwagger: boolean, openApiPath: string, hasMockRegistration: boolean): LibrarySourceFile[];
+export declare function getBusinessLogicImplementations(emitter: AssetEmitter<string, Record<string, never>>, registrations: BusinessLogicRegistrations, useSwagger: boolean, openApiPath: string): LibrarySourceFile[];
+//# sourceMappingURL=scaffolding.d.ts.map

package/dist/src/lib/scaffolding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scaffolding.d.ts","sourceRoot":"","sources":["../../../src/lib/scaffolding.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAQ,MAAM,yBAAyB,CAAC;AAE7D,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,2BAA2B,EAAE,MAAM,UAAU,CAAC;AAEvD,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,mBAAmB,EAAE,CAAC;CAChC;AAED,MAAM,WAAW,mBAAmB;IAClC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,UAAU,GAAG,oBAAoB,CAAC;IAC9C,sBAAsB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED,MAAM,MAAM,0BAA0B,GAAG,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;AAClF,MAAM,MAAM,yBAAyB,GAAG,CAAC,MAAM,EAAE,2BAA2B,CAAC,CAAC;AAE9E,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,2BAA2B,CAAC,EAC1D,UAAU,EAAE,OAAO,EACnB,WAAW,EAAE,MAAM,EACnB,mBAAmB,EAAE,OAAO,GAC3B,iBAAiB,EAAE,CA8BrB;AAED,wBAAgB,+BAA+B,CAC7C,OAAO,EAAE,YAAY,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EACpD,aAAa,EAAE,0BAA0B,EACzC,UAAU,EAAE,OAAO,EACnB,WAAW,EAAE,MAAM,GAClB,iBAAiB,EAAE,CA4BrB"}