@vonage/vetch - npm Package Compare versions

Comparing version 1.6.0 to 1.7.0

dist/enums/HTTPMethods.d.ts

@@ -0,11 +1,15 @@
+/**
+ * Enum representing the HTTP methods that can be used for Vonage API requests.
+ */
 export declare enum HTTPMethods {
+    /** Represents an HTTP GET request. */
     GET = "GET",
-    HEAD = "HEAD",
+    /** Represents an HTTP POST request. */
     POST = "POST",
+    /** Represents an HTTP DELETE request. */
     DELETE = "DELETE",
+    /** Represents an HTTP PUT request. */
     PUT = "PUT",
-    CONNECT = "CONNECT",
-    OPTIONS = "OPTIONS",
-    TRACE = "TRACE",
+    /** Represents an HTTP PATCH request. */
     PATCH = "PATCH"
 }

dist/enums/HTTPMethods.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HTTPMethods = void 0;
+/**
+ * Enum representing the HTTP methods that can be used for Vonage API requests.
+ */
 var HTTPMethods;
 (function (HTTPMethods) {
+    /** Represents an HTTP GET request. */
     HTTPMethods["GET"] = "GET";
-    HTTPMethods["HEAD"] = "HEAD";
+    /** Represents an HTTP POST request. */
     HTTPMethods["POST"] = "POST";
+    /** Represents an HTTP DELETE request. */
     HTTPMethods["DELETE"] = "DELETE";
+    /** Represents an HTTP PUT request. */
     HTTPMethods["PUT"] = "PUT";
-    HTTPMethods["CONNECT"] = "CONNECT";
-    HTTPMethods["OPTIONS"] = "OPTIONS";
-    HTTPMethods["TRACE"] = "TRACE";
+    /** Represents an HTTP PATCH request. */
     HTTPMethods["PATCH"] = "PATCH";
 })(HTTPMethods || (exports.HTTPMethods = HTTPMethods = {}));
-//# sourceMappingURL=HTTPMethods.js.map

dist/enums/responseTypes.d.ts

@@ -0,5 +1,20 @@
+/**
+ * @deprecated
+ * Enum representing the expected response types for API requests. This was
+ * originaly used to set what the expected response type will be. It is better
+ * to use the content-type header from the response to decode properly.
+ */
 export declare enum ResponseTypes {
+    /**
+     * Represents a JSON-formatted response.
+     */
     json = "json",
+    /**
+     * Represents a stream response, typically for handling large data or files.
+     */
     stream = "stream",
+    /**
+     * Represents a plain text response.
+     */
     text = "text"
 }

dist/enums/responseTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ResponseTypes = void 0;
+/**
+ * @deprecated
+ * Enum representing the expected response types for API requests. This was
+ * originaly used to set what the expected response type will be. It is better
+ * to use the content-type header from the response to decode properly.
+ */
 var ResponseTypes;
 (function (ResponseTypes) {
+    /**
+     * Represents a JSON-formatted response.
+     */
     ResponseTypes["json"] = "json";
+    /**
+     * Represents a stream response, typically for handling large data or files.
+     */
     ResponseTypes["stream"] = "stream";
+    /**
+     * Represents a plain text response.
+     */
     ResponseTypes["text"] = "text";
 })(ResponseTypes || (exports.ResponseTypes = ResponseTypes = {}));
-//# sourceMappingURL=responseTypes.js.map

dist/index.d.ts

@@ -1,11 +0,3 @@
-import { Vetch } from './vetch';
-import { VetchOptions } from './interfaces/vetchOptions';
-export { Vetch, VetchOptions };
-export declare const instance: Vetch;
-export declare function request<T>(opts: VetchOptions): Promise<import("./interfaces/vetchResponse").VetchResponse<T>>;
-export { VetchError } from './types/vetchError';
-export { Headers } from './interfaces/headers';
-export { VetchPromise } from './types/vetchPromise';
-export { VetchResponse } from './interfaces/vetchResponse';
-export { ResponseTypes } from './enums/responseTypes';
-export * from './enums/HTTPMethods';
+export * from './types';
+export * from './enums';
+export * from './errors/vetchError';

dist/index.js

@@ -17,15 +17,4 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseTypes = exports.VetchError = exports.request = exports.instance = exports.Vetch = void 0;
-const vetch_1 = require("./vetch");
-Object.defineProperty(exports, "Vetch", { enumerable: true, get: function () { return vetch_1.Vetch; } });
-exports.instance = new vetch_1.Vetch();
-async function request(opts) {
-    return exports.instance.request(opts);
-}
-exports.request = request;
-var vetchError_1 = require("./types/vetchError");
-Object.defineProperty(exports, "VetchError", { enumerable: true, get: function () { return vetchError_1.VetchError; } });
-var responseTypes_1 = require("./enums/responseTypes");
-Object.defineProperty(exports, "ResponseTypes", { enumerable: true, get: function () { return responseTypes_1.ResponseTypes; } });
-__exportStar(require("./enums/HTTPMethods"), exports);
-//# sourceMappingURL=index.js.map
+__exportStar(require("./types"), exports);
+__exportStar(require("./enums"), exports);
+__exportStar(require("./errors/vetchError"), exports);

dist/types/vetchPromise.d.ts

@@ -1,2 +0,11 @@
-import { VetchResponse } from '../interfaces/vetchResponse';
+import { VetchResponse } from './vetchResponse';
+/**
+ * Type representing a promise that resolves with a standardized Vetch API
+ * response. Vetch ("Vonage Fetch") ensures a consistent API response
+ * structure, irrespective of the HTTP adapter utilized by the developer.
+ *
+ * @deprecated
+ *
+ * @template T - The type of the data payload in the VetchResponse, expected to be an object that has been decoded from JSON or WebForm.
+ */
 export type VetchPromise<T> = Promise<VetchResponse<T>>;

dist/types/vetchPromise.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=vetchPromise.js.map

package.json

 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "@vonage/vetch",
-  "version": "1.6.0",
-  "description": "Vonage package for server side fetch.",
+  "version": "1.7.0",
+  "description": "Vonage's type and enum definitions module for server-side HTTP interactions.",
   "homepage": "https://github.com/vonage/vonage-node-sdk/tree/master/packages/vetch#readme",
@@ -14,3 +15,16 @@ "bugs": {
   "license": "Apache-2.0",
-  "author": "Kelly J Andrews <[e-mail]>",
+  "contributors": [
+    {
+      "name": "Kelly J Andrews",
+      "url": "https://github.com/kellyjandrews"
+    },
+    {
+      "name": "Chris Tankersley",
+      "url": "https://github.com/dragonmantank"
+    },
+    {
+      "name": "Chuck \"MANCHUCK\" Reeves",
+      "url": "https://github.com/manchuck"
+    }
+  ],
   "main": "dist/index.js",
@@ -24,12 +38,8 @@ "types": "dist/index.d.ts",
     "clean": "npx shx rm -rf dist tsconfig.tsbuildinfo",
-    "compile": "npx tsc --build --verbose"
+    "compile": "npx tsc --build --verbose",
+    "prepublishOnly": "npm run build"
   },
   "dependencies": {
-    "debug": "^4.3.4",
-    "lodash.merge": "^4.6.2",
-    "node-fetch": "^2.2"
+    "node-fetch": "^2.7"
   },
-  "devDependencies": {
-    "nock": "^13.3.4"
-  },
   "publishConfig": {
@@ -36,0 +46,0 @@ "directory": "dist"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Network access

Supply chain risk

This module accesses the network.

Found 2 instances in 1 package

Improved metrics

Dependency count

1

decreased by-66.67%

Dev dependency count

0

decreased by-100%

Lines of code

352

increased by11.39%

Number of medium supply chain risk alerts

1

decreased by-50%

Worsened metrics

Total package byte prevSize

16010

decreased by-24.08%

Number of package files

24

decreased by-25%

Dependency changes

• - Removeddebug@^4.3.4

• - Removedlodash.merge@^4.6.2

• - Removeddebug@4.3.7(transitive)

• - Removedlodash.merge@4.6.2(transitive)

• - Removedms@2.1.3(transitive)

• Updatednode-fetch@^2.7