@anitrack/patreon-wrapper 1.0.2 → 1.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,2 +1,107 @@
1
- # patreon-wrapper
2
- Discord Patreon Wrapper for AniTrack
1
+ # Patreon Wrapper 🍊
2
+ Discord Patreon Wrapper for [AniTrack](https://anitrack.co) on node.js
3
+
4
+ ## Table of Contents
5
+ - [Installing](#installing)
6
+ - [Example](#example)
7
+ - [License](#license)
8
+
9
+ ## Installing
10
+ Using NPM
11
+ ```
12
+ $ npm install @anitrack/patreon-wrapper
13
+ ```
14
+ Using YARN
15
+ ```
16
+ $ yarn add @anitrack/patreon-wrapper
17
+ ```
18
+
19
+ ## Example
20
+
21
+ ### Importing
22
+
23
+ CommonJS
24
+ ```js
25
+ const { Patreon } = require('@AniTrack/patreon-wrapper')
26
+ ```
27
+ Typescript ES6
28
+ ```js
29
+ import { Patreon } from '@AniTrack/patreon-wrapper'
30
+ ```
31
+
32
+ Authorization
33
+ ```js
34
+ Patreon.Authorization({
35
+ AccessToken: 'YOUR_API_V2_ACCESS_TOKEN',
36
+ CampaignID: 'YOUR_CAPAIGN_ID',
37
+ })
38
+ ```
39
+
40
+ ### Fetching every Patrons on the Campaign
41
+
42
+ Promies then catch
43
+ ```js
44
+ Patreon.FetchPatrons()
45
+ .then((Patrons) => {
46
+ // Handle Patrons List
47
+ console.log(Patrons)
48
+ })
49
+ .catch((err) => {
50
+ // Handle Error
51
+ console.log(err)
52
+ })
53
+ ```
54
+ Async/Await
55
+ ```js
56
+ var Patrons = await Patreon.FetchPatrons()
57
+
58
+ console.log(Patrons)
59
+ ```
60
+
61
+ Clean Response Example
62
+ ```js
63
+ // Example response from fetching Patron list
64
+ [
65
+ {
66
+ displayId: '12345678',
67
+ displayName: 'Username',
68
+ emailAddress: 'email@address.com',
69
+ isFollower: false,
70
+ subscription: {
71
+ note: '',
72
+ currentEntitled: {
73
+ status: 'active_patron',
74
+ cents: 500, // 5 USD
75
+ willPayCents: 500,
76
+ lifetimeCents: 0,
77
+ firstCharge: 'DATE',
78
+ nextCharge: 'DATE',
79
+ lastCharge: 'DATE'
80
+ }
81
+ },
82
+ mediaConnection: {
83
+ patreon: {
84
+ id: '12345678',
85
+ url: 'https://www.patreon.com/api/oauth2/v2/user/12345678'
86
+ },
87
+ discord: {
88
+ id: 'DISCORD_USER_ID',
89
+ url: 'https://discordapp.com/users/DISCORD_USER_ID'
90
+ }
91
+ }
92
+ },
93
+ {
94
+ ...
95
+ },
96
+ {
97
+ ...
98
+ },
99
+ {
100
+ ...
101
+ }
102
+ ]
103
+ ```
104
+
105
+ ## License
106
+
107
+ [MIT](LICENSE)
package/lib/index.d.ts CHANGED
@@ -2,7 +2,7 @@ declare type Auth = {
2
2
  AccessToken: string;
3
3
  CampaignID: string;
4
4
  };
5
- export default class {
5
+ export declare class Patreon {
6
6
  private static _URL;
7
7
  private static _AccessToken;
8
8
  private static _CampaignID;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,aAAK,IAAI,GAAG;IACR,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,CAAC,OAAO;IACV,OAAO,CAAC,MAAM,CAAC,IAAI,CAAmD;IAEtE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAQ;IACnC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ;WAEpB,aAAa,CAAC,eAAe,EAAE,IAAI;mBAc5B,QAAQ;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;WAOR,YAAY,CAAC,MAAM,GAAE,MAAM,EAAO;CAyDzD"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,aAAK,IAAI,GAAG;IACR,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,qBAAa,OAAO;IAChB,OAAO,CAAC,MAAM,CAAC,IAAI,CAAmD;IAEtE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAQ;IACnC,OAAO,CAAC,MAAM,CAAC,WAAW,CAAQ;WAEpB,aAAa,CAAC,eAAe,EAAE,IAAI;mBAc5B,QAAQ;IAS7B,OAAO,CAAC,MAAM,CAAC,aAAa;WAOR,YAAY,CAAC,MAAM,GAAE,MAAM,EAAO;CAyDzD"}
package/lib/index.js CHANGED
@@ -3,8 +3,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
3
3
  return (mod && mod.__esModule) ? mod : { "default": mod };
4
4
  };
5
5
  Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.Patreon = void 0;
6
7
  const axios_1 = __importDefault(require("axios"));
7
- class default_1 {
8
+ class Patreon {
8
9
  static Authorization(AuthInformation) {
9
10
  if (!AuthInformation.AccessToken || !AuthInformation.CampaignID) {
10
11
  throw new Error('Either Missing AccessToken or CampaignID');
@@ -71,6 +72,6 @@ class default_1 {
71
72
  return Patrons;
72
73
  }
73
74
  }
74
- exports.default = default_1;
75
- default_1._URL = 'https://www.patreon.com/api/oauth2/v2/';
75
+ exports.Patreon = Patreon;
76
+ Patreon._URL = 'https://www.patreon.com/api/oauth2/v2/';
76
77
  //# sourceMappingURL=index.js.map
package/lib/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAA,kDAAyB;AAOzB;IAMW,MAAM,CAAC,aAAa,CAAC,eAAqB;QAC7C,IAAI,CAAC,eAAe,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YAC7D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;SAC9D;aAAM,IACH,OAAO,eAAe,CAAC,WAAW,IAAI,QAAQ;YAC9C,OAAO,eAAe,CAAC,UAAU,IAAI,QAAQ,EAC/C;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;SACzD;QAED,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAA;IACjD,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAW;QACrC,OAAO,MAAM,IAAA,eAAK,EAAC,IAAI,CAAC,IAAI,GAAG,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE;SAC5D,CAAC,CAAC,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,GAAG,CAAC,CAAA;QAChD,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,KAAa;QACtC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC3D,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QAEjC,OAAO,KAAK,CAAA;IAChB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAmB,EAAE;QAClD,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,QAAQ,CAChC,IAAI,CAAC,aAAa,CACd,aAAa,IAAI,CAAC,WAAW,GAAG;YAC5B,kXAAkX,CACzX,CACJ,CAAA;QAED,MAAM,OAAO,GAAU,EAAE,CAAA;QAEzB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAW,EAAE,EAAE;YAClC,IAAI,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChC,CAAC,aAAkB,EAAE,EAAE,CACnB,aAAa,CAAC,EAAE,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5D,CAAA;YAED,OAAO,CAAC,IAAI,CAAC;gBACT,SAAS,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC5C,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,SAAS;gBACxC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK;gBACrC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW;gBACzC,YAAY,EAAE;oBACV,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;oBAC5B,eAAe,EAAE;wBACb,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,aAAa;wBACvC,KAAK,EAAE,MAAM,CAAC,UAAU;6BACnB,+BAA+B;wBACpC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,qBAAqB;wBACrD,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,sBAAsB;wBACvD,WAAW,EACP,MAAM,CAAC,UAAU,CAAC,yBAAyB;wBAC/C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,gBAAgB;wBAC9C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,gBAAgB;qBACjD;iBACJ;gBACD,eAAe,EAAE;oBACb,OAAO,EAAE;wBACL,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBACrC,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;qBAC/C;oBACD,OAAO,EAAE;wBACL,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO;6BAC5C,OAAO;wBACZ,GAAG,EACC,+BAA+B;4BAC/B,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO;iCACxC,OAAO;qBACnB;iBACJ;aACJ,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAClB,CAAC;;AAxFL,4BA6FC;AA5FkB,cAAI,GAAW,wCAAwC,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAAA,kDAAyB;AAOzB,MAAa,OAAO;IAMT,MAAM,CAAC,aAAa,CAAC,eAAqB;QAC7C,IAAI,CAAC,eAAe,CAAC,WAAW,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE;YAC7D,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAA;SAC9D;aAAM,IACH,OAAO,eAAe,CAAC,WAAW,IAAI,QAAQ;YAC9C,OAAO,eAAe,CAAC,UAAU,IAAI,QAAQ,EAC/C;YACE,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;SACzD;QAED,IAAI,CAAC,YAAY,GAAG,eAAe,CAAC,WAAW,CAAA;QAC/C,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC,UAAU,CAAA;IACjD,CAAC;IAEO,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAW;QACrC,OAAO,MAAM,IAAA,eAAK,EAAC,IAAI,CAAC,IAAI,GAAG,GAAG,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,EAAE,aAAa,EAAE,SAAS,GAAG,IAAI,CAAC,YAAY,EAAE;SAC5D,CAAC,CAAC,KAAK,CAAC,CAAC,GAAU,EAAE,EAAE;YACpB,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,GAAG,CAAC,CAAA;QAChD,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,MAAM,CAAC,aAAa,CAAC,KAAa;QACtC,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;QAC3D,KAAK,GAAG,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QAEjC,OAAO,KAAK,CAAA;IAChB,CAAC;IAEM,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,SAAmB,EAAE;QAClD,MAAM,GAAG,GAAQ,MAAM,IAAI,CAAC,QAAQ,CAChC,IAAI,CAAC,aAAa,CACd,aAAa,IAAI,CAAC,WAAW,GAAG;YAC5B,kXAAkX,CACzX,CACJ,CAAA;QAED,MAAM,OAAO,GAAU,EAAE,CAAA;QAEzB,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAW,EAAE,EAAE;YAClC,IAAI,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAChC,CAAC,aAAkB,EAAE,EAAE,CACnB,aAAa,CAAC,EAAE,IAAI,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5D,CAAA;YAED,OAAO,CAAC,IAAI,CAAC;gBACT,SAAS,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;gBAC5C,WAAW,EAAE,MAAM,CAAC,UAAU,CAAC,SAAS;gBACxC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK;gBACrC,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW;gBACzC,YAAY,EAAE;oBACV,IAAI,EAAE,MAAM,CAAC,UAAU,CAAC,IAAI;oBAC5B,eAAe,EAAE;wBACb,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,aAAa;wBACvC,KAAK,EAAE,MAAM,CAAC,UAAU;6BACnB,+BAA+B;wBACpC,YAAY,EAAE,MAAM,CAAC,UAAU,CAAC,qBAAqB;wBACrD,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,sBAAsB;wBACvD,WAAW,EACP,MAAM,CAAC,UAAU,CAAC,yBAAyB;wBAC/C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,gBAAgB;wBAC9C,UAAU,EAAE,MAAM,CAAC,UAAU,CAAC,gBAAgB;qBACjD;iBACJ;gBACD,eAAe,EAAE;oBACb,OAAO,EAAE;wBACL,EAAE,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;wBACrC,GAAG,EAAE,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO;qBAC/C;oBACD,OAAO,EAAE;wBACL,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO;6BAC5C,OAAO;wBACZ,GAAG,EACC,+BAA+B;4BAC/B,OAAO,CAAC,UAAU,CAAC,kBAAkB,CAAC,OAAO;iCACxC,OAAO;qBACnB;iBACJ;aACJ,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAClB,CAAC;;AAxFL,0BA6FC;AA5FkB,YAAI,GAAW,wCAAwC,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@anitrack/patreon-wrapper",
3
- "version": "1.0.2",
3
+ "version": "1.1.5",
4
4
  "description": "Discord Patreon wrapper for AniTrack",
5
5
  "main": "lib/index.js",
6
6
  "types": "lib",
@@ -9,7 +9,7 @@
9
9
  },
10
10
  "repository": {
11
11
  "type": "git",
12
- "url": "git+https://github.com/AniTrack/patreon-wrapper.git"
12
+ "url": "git://github.com/AniTrack/patreon-wrapper.git"
13
13
  },
14
14
  "author": "AniTrack",
15
15
  "license": "MIT",
package/src/index.ts CHANGED
@@ -5,7 +5,7 @@ type Auth = {
5
5
  CampaignID: string
6
6
  }
7
7
 
8
- export default class {
8
+ export class Patreon {
9
9
  private static _URL: string = 'https://www.patreon.com/api/oauth2/v2/'
10
10
 
11
11
  private static _AccessToken: string