Merge branch 'main' into andrueastman/untypedNodes

Author: Andrew Omondi

package-lock.json

@@ -7,7 +7,6 @@
     "@types/chai": "^4.3.11",
     "@types/mocha": "^10.0.6",
     "@types/node": "^20.11.15",
-    "@types/node-fetch": "^2.6.11",
     "@types/sinon": "^17.0.3",
     "@typescript-eslint/eslint-plugin": "^7.0.1",
     "@typescript-eslint/parser": "^7.0.1",

package.json

@@ -35,7 +35,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "^1.7.0",
-    "@std-uritemplate/std-uritemplate": "^0.0.53",
+    "@std-uritemplate/std-uritemplate": "^0.0.54",
     "guid-typescript": "^1.0.9",
     "tinyduration": "^3.3.0",
     "tslib": "^2.6.2",

packages/abstractions/package.json

@@ -31,13 +31,12 @@ To achieve the isomorphism, the library is set up in the following ways:
 
 Often times the library will have code which is different for the browser and node environments. 
 Examples:
-- Browsers use a global `fetch` defined in the `DOM` while node relies on an external library such as `node-fetch` or `undici`.
 - `ReadableStream` are different interfaces in node and browser.
 
 To manage such differences, separate files are maintained when the code can be different for node or browser. 
 
 For example: 
-- The  `DefaultFetchHandler` uses `node-fetch` for node and the `dom` fetch for browser. 
+- Browser environment doesn't require a `RedirectHandler` middleware while the `Node.js` environment does.
 - Map this difference as follows: 
 
 ```json
@@ -129,7 +128,7 @@ export type FetchRequestInit = Omit<RequestInit, "body" | "headers" | "redirect"
 	/**
 	 * Request's body
 	 * Expected type in case of dom - ReadableStream | XMLHttpRequestBodyInit|null
-	 * Expected type in case of node-fetch - | Blob | Buffer | URLSearchParams | NodeJS.ReadableStream | string|null
+	 * Expected type in case of node.js - | Blob | Buffer | URLSearchParams | NodeJS.ReadableStream | string|null
 	 */
 	body?: unknown;
 }

packages/http/fetch/docs/design/isomorphic.md

@@ -6,7 +6,7 @@
 - Test formats:
     - script to test `CommonJS` modules: `npm run test:cjs`
     - script to test `ES` modules:  `npm run test:es`
-- Examples of node environment specific tests: Test `DefaultFetchHandler` using `node-fetch` library.
+- Examples of node environment specific tests: Test `middlewareFactory.ts`.
 
 
 ### Testing for browser

packages/http/fetch/docs/design/testing.md

@@ -41,7 +41,6 @@
 		"@microsoft/kiota-abstractions": "^1.0.0-preview.44",
 		"@opentelemetry/api": "^1.7.0",
 		"guid-typescript": "^1.0.9",
-		"node-fetch": "^2.7.0",
 		"tslib": "^2.6.2"
 	},
 	"publishConfig": {

packages/http/fetch/package.json

@@ -9,8 +9,34 @@ export class KiotaClientFactory {
 	/**
 	 * @public
 	 * @static
-	 * Returns an instance of HttpClient with the provided middlewares and custom fetch implementation
+	 * Returns an instance of HttpClient with the provided middlewares and custom fetch implementation both parameters are optional. 
+	 * if not provided, the default fetch implementation and middlewares will be used.
+	 * @param {(request: string, init?: RequestInit) => Promise < Response >} customFetch - a Fetch API implementation
+	 * @param {Middleware[]} middlewares - an aray of Middleware handlers
+	 * If middlewares param is undefined, the httpClient instance will use the default array of middlewares.
+	 * Set middlewares to `null` if you do not wish to use middlewares.
+	 * If custom fetch is undefined, the httpClient instance uses the `DefaultFetchHandler`
 	 * @returns a HttpClient instance
+	 * @example 
+	 * ```Typescript 
+	 * // Example usage of KiotaClientFactory.create method with both customFetch and middlewares parameters provided
+	 *  KiotaClientFactory.create(customFetch, [middleware1, middleware2]);
+	 * ```
+	 * @example
+	 * ```Typescript
+	 * // Example usage of KiotaClientFactory.create method with only customFetch parameter provided
+	 * KiotaClientFactory.create(customFetch);
+	 * ```
+	 * @example
+	 * ```Typescript
+	 * // Example usage of KiotaClientFactory.create method with only middlewares parameter provided
+	 * KiotaClientFactory.create(undefined, [middleware1, middleware2]);
+	 * ```
+	 * @example
+	 * ```Typescript
+	 * // Example usage of KiotaClientFactory.create method with no parameters provided
+	 * KiotaClientFactory.create();
+	 * ```
 	 */
 	public static create(customFetch: (request: string, init: RequestInit) => Promise<Response> = fetch as any, middlewares?: Middleware[]): HttpClient {
 		const middleware = middlewares || MiddlewareFactory.getDefaultMiddlewares(customFetch);

packages/http/fetch/src/kiotaClientFactory.ts

@@ -36,7 +36,7 @@ export type FetchHeaders = Headers & {
 	 */
 	values?(): IterableIterator<string>;
 
-	/** Node-fetch extension */
+	/** Node extension */
 	raw?(): Record<string, string[]>;
 };
 
@@ -48,7 +48,7 @@ export type FetchRequestInit = Omit<RequestInit, "body" | "headers" | "redirect"
 	/**
 	 * Request's body
 	 * Expected type in case of dom - ReadableStream | XMLHttpRequestBodyInit|null
-	 * Expected type in case of node-fetch - | Blob | Buffer | URLSearchParams | NodeJS.ReadableStream | string|null
+	 * Expected type in case of node.js - | Blob | Buffer | URLSearchParams | NodeJS.ReadableStream | string|null
 	 */
 	body?: unknown;
 	/**

packages/http/fetch/src/utils/fetchDefinitions.ts

@@ -7,7 +7,6 @@
 
 import { HttpMethod } from "@microsoft/kiota-abstractions";
 import { assert } from "chai";
-import { Response } from "node-fetch";
 
 import { ChaosHandler, ChaosStrategy, type FetchRequestInit } from "../../src";
 import { DummyFetchHandler } from "./middleware/dummyFetchHandler";

packages/http/fetch/test/common/ChaosHandler.ts

@@ -19,13 +19,14 @@ var Response = Response;
 if (typeof Response !== "object") {
 	Response = getResponse();
 }
+
 describe("FetchRequestAdapter.ts", () => {
 	describe("getClaimsFromResponse", () => {
 		it("should get claims from response header", async () => {
 			const mockHttpClient = new HttpClient();
 			let executeFetchCount = 0;
 			mockHttpClient.executeFetch = async (url: string, requestInit: RequestInit, requestOptions?: Record<string, RequestOption>) => {
-				let response = new Response("", {
+				let response = new Response(null, {
 					status: 204,
 				} as ResponseInit);
 				if (executeFetchCount === 0) {
@@ -103,7 +104,7 @@ describe("FetchRequestAdapter.ts", () => {
 		}
 	});
 	describe("send returns object on content", () => {
-		for (const statusCode of [200, 201, 202, 203, 205]) {
+		for (const statusCode of [200, 201, 202, 203]) {
 			it(`should return object for status code ${statusCode}`, async () => {
 				const mockHttpClient = new HttpClient();
 				mockHttpClient.executeFetch = async (url: string, requestInit: RequestInit, requestOptions?: Record<string, RequestOption>) => {

packages/http/fetch/test/common/fetchRequestAdapter.ts

@@ -6,7 +6,6 @@
  */
 
 import { assert } from "chai";
-import { Response } from "node-fetch";
 
 import { HeadersInspectionHandler, HeadersInspectionOptions } from "../../../src";
 import { DummyFetchHandler } from "./dummyFetchHandler";

packages/http/fetch/test/common/middleware/headersInspectionHandler.ts

@@ -6,7 +6,6 @@
  */
 
 import { assert } from "chai";
-import { Response } from "node-fetch";
 
 import { RedirectHandlerOptionKey, RedirectHandlerOptions } from "../../src/middlewares/options/redirectHandlerOptions";
 import { RedirectHandler } from "../../src/middlewares/redirectHandler";

packages/http/fetch/test/node/RedirectHandler.ts

@@ -1,5 +1,3 @@
-import { Response } from "node-fetch";
-
 export function getResponse() {
 	return Response;
 }