mailgun.js - npm Package Compare versions

Comparing version 8.2.2 to 9.0.0

CHANGELOG.md

@@ -5,2 +5,54 @@ # Changelog
 
+## [9.0.0](https://github.com/mailgun/mailgun.js/compare/v8.2.2...v9.0.0) (2023-05-29)
+
+
+### ⚠ BREAKING CHANGES
+
+* Types available as a named import from the package
+* Add missing types and interfaces
+* Move StatsClient and StatsContainer classes to different files
+* Move rest of the types to appropriate folders
+* Move common types to another folder
+* Move Validations types to another folder
+* Move Suppressions types to another folder
+* Move MailingLists types to another folder
+* Move domains types to another folder
+* WebhookClient class renamed to WebhooksClient
+* Client class renamed to MailgunClient
+* Options interfase renamed to MailgunClientOptions
+
+### Features
+
+* Add missing types and interfaces ([ea4f289](https://github.com/mailgun/mailgun.js/commits/ea4f2898c93504354c57eb26bf6264dbfdec80e2))
+* Add types,enums, and interfaces to default export from SDK ([6ccc043](https://github.com/mailgun/mailgun.js/commits/6ccc0433569cb55de48125a527cf6d527f329c6f))
+* TS version update ([8523c11](https://github.com/mailgun/mailgun.js/commits/8523c118e2320e13a2d4ce430bbef1d9756dc082))
+* Types available as a named import from the package ([adf93c8](https://github.com/mailgun/mailgun.js/commits/adf93c81391f2224a11432739c0caa75c6c7079b))
+
+
+### Breaking changes
+
+* Group enums to own folder ([306e19a](https://github.com/mailgun/mailgun.js/commits/306e19a56c97ce03c9b8af5fc6363a0726864c61))
+* Group related Classes and Interfaces to folders ([8d785fa](https://github.com/mailgun/mailgun.js/commits/8d785fa1fd6232dca4651b8f38666192369961c3))
+* Move common types to another folder ([d31b802](https://github.com/mailgun/mailgun.js/commits/d31b8026799d5d2d66a940cccb9973e6e78e6681))
+* Move domains types to another folder ([6f5b479](https://github.com/mailgun/mailgun.js/commits/6f5b479d8e03c3e2ba3b40dc6f31982e20f87a47))
+* Move MailingLists types to another folder ([416e7be](https://github.com/mailgun/mailgun.js/commits/416e7be1860e2ce7883fadcbf7d124be23b3bf5b))
+* Move rest of the types to appropriate folders ([4c0c81a](https://github.com/mailgun/mailgun.js/commits/4c0c81a8da036f438cb549d741b6322e8653367a))
+* Move StatsClient and StatsContainer classes to different files ([bfc25cf](https://github.com/mailgun/mailgun.js/commits/bfc25cf9ff926657b73e8dc7c7593f67ec9e2dc7))
+* Move Suppressions types to another folder ([efd2e92](https://github.com/mailgun/mailgun.js/commits/efd2e929b82200bfca7407e424069462a543b7da))
+* Move Validations types to another folder ([a64112a](https://github.com/mailgun/mailgun.js/commits/a64112aa32c8f03b8dd8e467f5a87e9e1a2d4b49))
+
+
+### Other changes
+
+* Add typedock generation step to release ([d7afc0e](https://github.com/mailgun/mailgun.js/commits/d7afc0ea06db5b38f228f1beb32aeeee1b925dd5))
+* Decrease number of eslint warnings ([c372344](https://github.com/mailgun/mailgun.js/commits/c37234443a4a853ac5a668a32ddd140d8bc3d6a9))
+* Merge branch 'master' into expose-types ([53f6435](https://github.com/mailgun/mailgun.js/commits/53f643512686619506cebf8fe59bb546306d6263))
+* Move suppressions classes to different files ([2b692de](https://github.com/mailgun/mailgun.js/commits/2b692deb2b7acb11cb3ce189342d751844d441b5))
+* Rename suppressions.ts file to SuppressionClient.ts ([b3ba0ac](https://github.com/mailgun/mailgun.js/commits/b3ba0acc90111d953f2278b4c0d49729cd649c8b))
+* Update interfaces folder name to be Interfaces in dist ([0b22bcd](https://github.com/mailgun/mailgun.js/commits/0b22bcd6be02b111a1030df2b0d3c0ae6d491e3c))
+* Update readme one more time ([0f5a98b](https://github.com/mailgun/mailgun.js/commits/0f5a98b507d2dca3668d2efda05c0aa7d42a1043))
+* Update registry for npm ([3175093](https://github.com/mailgun/mailgun.js/commits/3175093de9501eb5976387a31c237fdd349da1fd))
+* Update ts-loader and ts-node ([d6b0ba0](https://github.com/mailgun/mailgun.js/commits/d6b0ba0b96a9346a7f7347c0b2ddb40bee16a608))
+* Update Typedoc documentation ([6ae20c2](https://github.com/mailgun/mailgun.js/commits/6ae20c2b82968ac89c4bd01e1a8c45c122c5445e))
+
 ### [8.2.2](https://github.com/mailgun/mailgun.js/compare/v8.2.1...v8.2.2) (2023-05-26)
@@ -7,0 +59,0 @@

index.d.ts

@@ -1,4 +0,7 @@
-import Client from './client';
-import { InputFormData } from './interfaces/IFormData';
-import Options from './interfaces/Options';
+import { IMailgunClient } from './Interfaces';
+import { InputFormData } from './Types/Common';
+import { MailgunClientOptions } from './Types/MailgunClient';
+export * as Enums from './Enums';
+export * from './Types';
+export * as Interfaces from './Interfaces';
 export default class Mailgun {
@@ -8,3 +11,3 @@ static get default(): typeof Mailgun;
     constructor(FormData: InputFormData);
-    client(options: Options): Client;
+    client(options: MailgunClientOptions): IMailgunClient;
 }

mailgun.node.js.LICENSE.txt

@@ -17,2 +17,2 @@ /*!
 
-/*! mailgun.js v8.2.1 */
+/*! mailgun.js v8.2.2 */

mailgun.web.js.LICENSE.txt

 /*! https://mths.be/base64 v1.0.0 by @mathias | MIT license */
 
-/*! mailgun.js v8.2.1 */
+/*! mailgun.js v8.2.2 */

package.json

 {
   "name": "mailgun.js",
-  "version": "8.2.2",
+  "version": "9.0.0",
   "main": "./mailgun.node.js",
@@ -5,0 +5,0 @@ "browser": "./mailgun.web.js",

README.md

@@ -1,2 +0,2 @@
-# Mailgun.js [![Build Status](https://travis-ci.org/mailgun/mailgun-js.svg)](https://travis-ci.org/mailgun/mailgun-js)
+# Mailgun.js
 
@@ -12,2 +12,6 @@ A javascript sdk for Mailgun built with webpack, babel & es6. This can be used in node or in the browser*.
   - [Setup Client](#setup-client)
+    - [Available Imports](#imports)
+    - [Types imports](#types-imports)
+    - [Interfaces and Enums imports](#interfaces-and-enums-imports)
+  - [Generated docs](#generated-docs)
   - [Methods](#methods)
@@ -23,2 +27,3 @@ - [Browser Demo](#browser-demo)
 # Documentation
+[Mailgun API Documentation](https://documentation.mailgun.com/en/latest/api_reference.html):
 
@@ -41,16 +46,36 @@ ## Install
 
+### Imports
+Once the package is installed, you can import the library using `import` or `require` approach:
+
 ```js
-const formData = require('form-data');
-const Mailgun = require('mailgun.js');
-const mailgun = new Mailgun(formData);
-const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});
+  const formData = require('form-data');
+  const Mailgun = require('mailgun.js');
+  const mailgun = new Mailgun(formData);
+  const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});
 ```
-
-In the case your mailgun account is eu hosted you would need to define eu's subdomain as `url` in mailgun's Client constructor:
-
 ```js
-const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere', url: 'https://api.eu.mailgun.net'});
+  import * as FormData from 'form-data';
+  import Mailgun from 'mailgun.js';
+  const mailgun = new Mailgun(formData);
+  const mg = mailgun.client({username: 'api', key: process.env.MAILGUN_API_KEY || 'key-yourkeyhere'});
 ```
+### Types imports
+Starting from version **9.0.0.** Types can be includes as named import:
+```TS
+ import Mailgun, { MailgunClientOptions, MessagesSendResult } from 'mailgun.js';
+```
 
+### Interfaces and Enums imports
+Starting from version **9.0.0.** Interfaces and Enums can be imported in the next way:
+```TS
+  import Mailgun, { Interfaces, Enums } from 'mailgun.js';
+  ...
+  const mailgunClient: Interfaces.IMailgunClient = mailgun.client(clientOptions);
+  const yes = Enums.YesNo.YES;
+  ...
+```
 
+### Generated docs
+The list of all available Types, Interfaces and Enums is auto-generated and located in the docs/ folder.
+
 ## Methods
@@ -274,5 +299,3 @@
         })
-        .then(response => {
-            console.log(response);
-        })
+        .then(response => console.log(response))
       ```
@@ -324,3 +347,9 @@
 
-  Make sure that this property is a JSON string like {"title":"A title", "body":"The body"}.
+  Make sure that this property is a JSON string like:
+  ```js
+  JSON.stringify({
+    "title": "A title",
+    "body": "The body"
+  })
+  ```
 
@@ -327,0 +356,0 @@ You can find few examples of how to use templates below.

version.md

@@ -1,1 +0,1 @@
-8.2.2
+9.0.0

New alerts

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Fixed alerts

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1539891

increased by6.41%

Number of package files

117

increased by98.31%

Lines of code

3891

increased by9.67%

Number of lines in readme file

2130

increased by1.38%

Worsened metrics

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes