@typespec/http 0.61.0-dev.3 → 0.61.0

package/dist/src/lib.d.ts

@@ -80,7 +80,7 @@ export declare const $lib: import("@typespec/compiler").TypeSpecLibrary<{
     "header-format-required": {
         readonly default: "A format must be specified for @header when type is an array. e.g. @header({format: \"csv\"})";
     };
-}, Record<string, any>, "path" | "file" | "query" | "authentication" | "header" | "body" | "bodyRoot" | "bodyIgnore" | "multipartBody" | "statusCode" | "verbs" | "servers" | "includeInapplicableMetadataInPayload" | "externalInterfaces" | "routeProducer" | "routes" | "sharedRoutes" | "routeOptions" | "httpPart">;
+}, Record<string, any>, "file" | "path" | "query" | "authentication" | "header" | "body" | "bodyRoot" | "bodyIgnore" | "multipartBody" | "statusCode" | "verbs" | "servers" | "includeInapplicableMetadataInPayload" | "externalInterfaces" | "routeProducer" | "routes" | "sharedRoutes" | "routeOptions" | "httpPart">;
 export declare const reportDiagnostic: <C extends "http-verb-duplicate" | "missing-uri-param" | "incompatible-uri-param" | "use-uri-template" | "optional-path-param" | "missing-server-param" | "duplicate-body" | "duplicate-route-decorator" | "operation-param-duplicate-type" | "duplicate-operation" | "multiple-status-codes" | "status-code-invalid" | "content-type-string" | "content-type-ignored" | "metadata-ignored" | "no-service-found" | "invalid-type-for-auth" | "shared-inconsistency" | "write-visibility-not-supported" | "multipart-invalid-content-type" | "multipart-model" | "multipart-part" | "multipart-nested" | "http-file-extra-property" | "formdata-no-part-name" | "header-format-required", M extends keyof {
     "http-verb-duplicate": {
         readonly default: import("@typespec/compiler").CallableMessage<["entityName"]>;
@@ -409,5 +409,5 @@ export declare const reportDiagnostic: <C extends "http-verb-duplicate" | "missi
     "header-format-required": {
         readonly default: "A format must be specified for @header when type is an array. e.g. @header({format: \"csv\"})";
     };
-}, C, M>) => import("@typespec/compiler").Diagnostic, HttpStateKeys: Record<"path" | "file" | "query" | "authentication" | "header" | "body" | "bodyRoot" | "bodyIgnore" | "multipartBody" | "statusCode" | "verbs" | "servers" | "includeInapplicableMetadataInPayload" | "externalInterfaces" | "routeProducer" | "routes" | "sharedRoutes" | "routeOptions" | "httpPart", symbol>;
+}, C, M>) => import("@typespec/compiler").Diagnostic, HttpStateKeys: Record<"file" | "path" | "query" | "authentication" | "header" | "body" | "bodyRoot" | "bodyIgnore" | "multipartBody" | "statusCode" | "verbs" | "servers" | "includeInapplicableMetadataInPayload" | "externalInterfaces" | "routeProducer" | "routes" | "sharedRoutes" | "routeOptions" | "httpPart", symbol>;
 //# sourceMappingURL=lib.d.ts.map

package/dist/src/streams/index.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/src/streams/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/streams/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC"}

package/dist/src/streams/index.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=index.js.map

package/dist/src/streams/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/streams/index.ts"],"names":[],"mappings":""}

package/lib/streams/main.tsp

@@ -0,0 +1,51 @@
+import "@typespec/streams";
+import "../http.tsp";
+
+using TypeSpec.Streams;
+
+namespace TypeSpec.Http.Streams;
+
+/**
+ * Defines a model that represents a stream protocol type whose data is described
+ * by `Type`.
+ *
+ * The `ContentType` and `BodyType` describe how the stream is encoded over the wire,
+ * while `Type` describes the data that the stream contains.
+ *
+ * @template Type The type of the stream's data.
+ * @template ContentType The content type of the stream.
+ * @template BodyType The underlying wire type of the stream.
+ */
+@doc("")
+model HttpStream<Type, ContentType extends valueof string, BodyType extends bytes | string = string>
+  is Stream<Type> {
+  @header contentType: typeof ContentType;
+  @body body: BodyType;
+}
+
+/**
+ * Describes a stream of JSON data with one JSON object per line and sets
+ * the content type to `application/jsonl`.
+ *
+ * The JSON data is described by `Type`.
+ *
+ * @template Type The set of models describing the JSON data in the stream.
+ *
+ * @example
+ *
+ * ```typespec
+ * model Message {
+ *   id: string;
+ *   text: string;
+ * }
+ *
+ * @TypeSpec.Events.events
+ * union Events {
+ *   Message,
+ * }
+ *
+ * op subscribe(): JsonlStream<Events>;
+ * ```
+ */
+@doc("")
+model JsonlStream<Type> is HttpStream<Type, "application/jsonl">;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http",
-  "version": "0.61.0-dev.3",
+  "version": "0.61.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",
@@ -28,32 +28,43 @@
     "./testing": {
       "types": "./dist/src/testing/index.d.ts",
       "default": "./dist/src/testing/index.js"
+    },
+    "./streams": {
+      "typespec": "./lib/streams/main.tsp",
+      "types": "./dist/src/streams/index.d.ts",
+      "default": "./dist/src/streams/index.js"
     }
   },
   "engines": {
     "node": ">=18.0.0"
   },
   "files": [
-    "lib/*.tsp",
+    "lib/**/*.tsp",
     "dist/**",
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "~0.60.1 || >=0.61.0-dev <0.61.0"
+    "@typespec/compiler": "~0.61.0",
+    "@typespec/streams": "~0.61.0"
+  },
+  "peerDependenciesMeta": {
+    "@typespec/streams": {
+      "optional": true
+    }
   },
   "devDependencies": {
     "@types/node": "~22.7.1",
-    "@typespec/compiler": "~0.60.1 || >=0.61.0-dev <0.61.0",
-    "@typespec/library-linter": "~0.60.0 || >=0.61.0-dev <0.61.0",
     "@vitest/coverage-v8": "^2.1.1",
     "@vitest/ui": "^2.1.1",
     "c8": "^10.1.2",
     "rimraf": "~6.0.1",
     "typescript": "~5.6.2",
     "vitest": "^2.1.1",
+    "@typespec/compiler": "~0.61.0",
+    "@typespec/streams": "~0.61.0",
+    "@typespec/library-linter": "~0.61.0",
     "@typespec/tspd": "~0.46.0"
   },
-  "dependencies": {},
   "scripts": {
     "clean": "rimraf ./dist ./temp",
     "build": "npm run gen-extern-signature && tsc -p . && npm run lint-typespec-library",