@typespec/http 0.64.0-dev.0 → 0.64.0

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

@@ -0,0 +1,2 @@
+export { StreamMetadata, getStreamMetadata } from "./streams.js";
+//# sourceMappingURL=index.d.ts.map

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

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

package/dist/src/experimental/index.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/experimental/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,iBAAiB,EAAE,MAAM,cAAc,CAAC"}

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

@@ -0,0 +1,29 @@
+import { Program, Type } from "@typespec/compiler";
+import { HttpOperationParameters, HttpOperationResponseContent } from "../types.js";
+export interface StreamMetadata {
+    /**
+     * The `Type` of the property decorated with `@body`.
+     */
+    bodyType: Type;
+    /**
+     * The `Type` of the stream model.
+     * For example, an instance of `HttpStream`.
+     */
+    originalType: Type;
+    /**
+     * The `Type` of the streaming payload.
+     *
+     * For example, given `HttpStream<Foo, "application/jsonl">`,
+     * the `streamType` would be `Foo`.
+     */
+    streamType: Type;
+    /**
+     * The list of content-types that this stream supports.
+     */
+    contentTypes: string[];
+}
+/**
+ * Gets stream metadata for a given `HttpOperationParameters` or `HttpOperationResponseContent`.
+ */
+export declare function getStreamMetadata(program: Program, httpParametersOrResponse: HttpOperationParameters | HttpOperationResponseContent): StreamMetadata | undefined;
+//# sourceMappingURL=streams.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"streams.d.ts","sourceRoot":"","sources":["../../../src/experimental/streams.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,OAAO,EAAE,IAAI,EAAE,MAAM,oBAAoB,CAAC;AACzE,OAAO,EAAE,uBAAuB,EAAE,4BAA4B,EAAE,MAAM,aAAa,CAAC;AAYpF,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,QAAQ,EAAE,IAAI,CAAC;IACf;;;OAGG;IACH,YAAY,EAAE,IAAI,CAAC;IACnB;;;;;OAKG;IACH,UAAU,EAAE,IAAI,CAAC;IACjB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,OAAO,EAAE,OAAO,EAChB,wBAAwB,EAAE,uBAAuB,GAAG,4BAA4B,GAC/E,cAAc,GAAG,SAAS,CAoB5B"}

package/dist/src/experimental/streams.js

@@ -0,0 +1,48 @@
+let getStreamOf;
+try {
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore
+    getStreamOf = (await import("@typespec/streams")).getStreamOf;
+}
+catch {
+    getStreamOf = () => {
+        throw new Error("@typespec/streams was not found");
+    };
+}
+/**
+ * Gets stream metadata for a given `HttpOperationParameters` or `HttpOperationResponseContent`.
+ */
+export function getStreamMetadata(program, httpParametersOrResponse) {
+    const body = httpParametersOrResponse.body;
+    if (!body)
+        return;
+    const contentTypes = body.contentTypes;
+    if (!contentTypes.length)
+        return;
+    // @body is always explicitly set by HttpStream, so body.property will be defined.
+    const bodyProperty = body.property;
+    if (!bodyProperty)
+        return;
+    const streamData = getStreamFromBodyProperty(program, bodyProperty);
+    if (!streamData)
+        return;
+    return {
+        bodyType: body.type,
+        originalType: streamData.model,
+        streamType: streamData.streamOf,
+        contentTypes: contentTypes,
+    };
+}
+function getStreamFromBodyProperty(program, bodyProperty) {
+    // Check the model first, then if we can't find it, fallback to the sourceProperty model.
+    const streamOf = bodyProperty.model ? getStreamOf(program, bodyProperty.model) : undefined;
+    if (streamOf) {
+        // if `streamOf` is defined, then we know that `bodyProperty.model` is defined.
+        return { model: bodyProperty.model, streamOf };
+    }
+    if (bodyProperty.sourceProperty) {
+        return getStreamFromBodyProperty(program, bodyProperty.sourceProperty);
+    }
+    return;
+}
+//# sourceMappingURL=streams.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"streams.js","sourceRoot":"","sources":["../../../src/experimental/streams.ts"],"names":[],"mappings":"AAEA,IAAI,WAA2D,CAAC;AAChE,IAAI,CAAC;IACH,6DAA6D;IAC7D,aAAa;IACb,WAAW,GAAG,CAAC,MAAM,MAAM,CAAC,mBAAmB,CAAC,CAAC,CAAC,WAAW,CAAC;AAChE,CAAC;AAAC,MAAM,CAAC;IACP,WAAW,GAAG,GAAG,EAAE;QACjB,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC,CAAC;AACJ,CAAC;AAyBD;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,OAAgB,EAChB,wBAAgF;IAEhF,MAAM,IAAI,GAAG,wBAAwB,CAAC,IAAI,CAAC;IAC3C,IAAI,CAAC,IAAI;QAAE,OAAO;IAElB,MAAM,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;IACvC,IAAI,CAAC,YAAY,CAAC,MAAM;QAAE,OAAO;IAEjC,kFAAkF;IAClF,MAAM,YAAY,GAAG,IAAI,CAAC,QAAQ,CAAC;IACnC,IAAI,CAAC,YAAY;QAAE,OAAO;IAE1B,MAAM,UAAU,GAAG,yBAAyB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;IACpE,IAAI,CAAC,UAAU;QAAE,OAAO;IAExB,OAAO;QACL,QAAQ,EAAE,IAAI,CAAC,IAAI;QACnB,YAAY,EAAE,UAAU,CAAC,KAAK;QAC9B,UAAU,EAAE,UAAU,CAAC,QAAQ;QAC/B,YAAY,EAAE,YAAY;KAC3B,CAAC;AACJ,CAAC;AAED,SAAS,yBAAyB,CAChC,OAAgB,EAChB,YAA2B;IAE3B,yFAAyF;IACzF,MAAM,QAAQ,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE3F,IAAI,QAAQ,EAAE,CAAC;QACb,+EAA+E;QAC/E,OAAO,EAAE,KAAK,EAAE,YAAY,CAAC,KAAM,EAAE,QAAQ,EAAE,CAAC;IAClD,CAAC;IAED,IAAI,YAAY,CAAC,cAAc,EAAE,CAAC;QAChC,OAAO,yBAAyB,CAAC,OAAO,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC;IACzE,CAAC;IACD,OAAO;AACT,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typespec/http",
-  "version": "0.64.0-dev.0",
+  "version": "0.64.0",
   "author": "Microsoft Corporation",
   "description": "TypeSpec HTTP protocol binding",
   "homepage": "https://github.com/microsoft/typespec",
@@ -34,6 +34,10 @@
       "typespec": "./lib/streams/main.tsp",
       "types": "./dist/src/streams/index.d.ts",
       "default": "./dist/src/streams/index.js"
+    },
+    "./experimental": {
+      "types": "./dist/src/experimental/index.d.ts",
+      "default": "./dist/src/experimental/index.js"
     }
   },
   "engines": {
@@ -45,8 +49,8 @@
     "!dist/test/**"
   ],
   "peerDependencies": {
-    "@typespec/compiler": "~0.63.0 || >=0.64.0-dev <0.64.0",
-    "@typespec/streams": "~0.63.0 || >=0.64.0-dev <0.64.0"
+    "@typespec/compiler": "~0.64.0",
+    "@typespec/streams": "~0.64.0"
   },
   "peerDependenciesMeta": {
     "@typespec/streams": {
@@ -55,18 +59,17 @@
   },
   "devDependencies": {
     "@types/node": "~22.7.9",
-    "@typespec/compiler": "~0.63.0 || >=0.64.0-dev <0.64.0",
-    "@typespec/library-linter": "~0.63.0 || >=0.64.0-dev <0.64.0",
-    "@typespec/streams": "~0.63.0 || >=0.64.0-dev <0.64.0",
     "@vitest/coverage-v8": "^2.1.5",
     "@vitest/ui": "^2.1.2",
     "c8": "^10.1.2",
     "rimraf": "~6.0.1",
     "typescript": "~5.6.3",
     "vitest": "^2.1.5",
+    "@typespec/compiler": "~0.64.0",
+    "@typespec/library-linter": "~0.64.0",
+    "@typespec/streams": "~0.64.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",