@ifunny/ifunny-api-types 1.0.1 → 1.0.3

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/CHANGELOG.md CHANGED
@@ -2,7 +2,27 @@
2
2
  > All notable changes to this project will be documented in this file.
3
3
  > This Changelog adheres to the [Semantic Versioning]("https://semver.org/")
4
4
 
5
- ## [v1.0.1](https://github.com/makeshiftartist/ifunny-api-types/compare/v1.0.0...v1.0.1) - 2023-01-16
5
+ ## [v1.0.3](https://github.com/makeshiftartist/ifunny-api-types/compare/v1.0.2...v1.0.3) - 2023-04-13
6
+
7
+
8
+
9
+
10
+ ### Documentation
11
+
12
+ * Improved docs for APINews @makeshiftartist ([`263f346`](https://github.com/makeshiftartist/ifunny-api-types/commit/263f3468b07758e5b7503465822b41463392768d))
13
+
14
+
15
+ ## [v1.0.2](https://github.com/makeshiftartist/ifunny-api-types/compare/v1.0.1...v1.0.2) - 2023-04-12
16
+
17
+
18
+ ### Fixes
19
+
20
+ * Export missing APINewsType @makeshiftartist ([`8529b95`](https://github.com/makeshiftartist/ifunny-api-types/commit/8529b95079f06350fd7d89eaa9ae66c74c9bfc09))
21
+
22
+
23
+
24
+
25
+ ## [v1.0.1](https://github.com/makeshiftartist/ifunny-api-types/compare/v1.0.0...v1.0.1) - 2023-01-15
6
26
 
7
27
 
8
28
  ### Fixes
@@ -1 +1 @@
1
- {"version":3,"file":"activity.js","sourceRoot":"","sources":["../../src/payloads/activity.ts"],"names":[],"mappings":";;;AAkDA;;GAEG;AACH,IAAY,UAyCX;AAzCD,WAAY,UAAU;IACrB,yBAAW,CAAA;IACX,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qDAAuC,CAAA;IACvC,+CAAiC,CAAA;IACjC,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;IACrB,qDAAuC,CAAA;IACvC,yDAA2C,CAAA;IAC3C,yDAA2C,CAAA;IAC3C,uDAAyC,CAAA;IACzC,iDAAmC,CAAA;IACnC,2CAA6B,CAAA;IAC7B,mDAAqC,CAAA;IACrC,6DAA+C,CAAA;IAC/C;;OAEG;IACH,yDAA2C,CAAA;IAC3C,qDAAuC,CAAA;IACvC,iEAAmD,CAAA;IACnD,iEAAmD,CAAA;IACnD,2DAA6C,CAAA;IAC7C,6BAAe,CAAA;IACf,+CAAiC,CAAA;IACjC,6BAAe,CAAA;IACf,qDAAuC,CAAA;IACvC,iDAAmC,CAAA;IACnC,iDAAmC,CAAA;IACnC,6CAA+B,CAAA;IAC/B;;OAEG;IACH,iCAAmB,CAAA;IACnB,sCAAwB,CAAA;IACxB,8CAAgC,CAAA;IAChC,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,yCAA2B,CAAA;AAC5B,CAAC,EAzCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAyCrB"}
1
+ {"version":3,"file":"activity.js","sourceRoot":"","sources":["../../src/payloads/activity.ts"],"names":[],"mappings":";;;AA2EA;;GAEG;AACH,IAAY,UAyCX;AAzCD,WAAY,UAAU;IACrB,yBAAW,CAAA;IACX,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,qDAAuC,CAAA;IACvC,+CAAiC,CAAA;IACjC,qCAAuB,CAAA;IACvB,mCAAqB,CAAA;IACrB,qDAAuC,CAAA;IACvC,yDAA2C,CAAA;IAC3C,yDAA2C,CAAA;IAC3C,uDAAyC,CAAA;IACzC,iDAAmC,CAAA;IACnC,2CAA6B,CAAA;IAC7B,mDAAqC,CAAA;IACrC,6DAA+C,CAAA;IAC/C;;OAEG;IACH,yDAA2C,CAAA;IAC3C,qDAAuC,CAAA;IACvC,iEAAmD,CAAA;IACnD,iEAAmD,CAAA;IACnD,2DAA6C,CAAA;IAC7C,6BAAe,CAAA;IACf,+CAAiC,CAAA;IACjC,6BAAe,CAAA;IACf,qDAAuC,CAAA;IACvC,iDAAmC,CAAA;IACnC,iDAAmC,CAAA;IACnC,6CAA+B,CAAA;IAC/B;;OAEG;IACH,iCAAmB,CAAA;IACnB,sCAAwB,CAAA;IACxB,8CAAgC,CAAA;IAChC,qCAAuB,CAAA;IACvB,6BAAe,CAAA;IACf,2CAA6B,CAAA;IAC7B,yCAA2B,CAAA;AAC5B,CAAC,EAzCW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAyCrB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ifunny/ifunny-api-types",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "iFunny API typings for use in bot library creaion.",
5
5
  "main": "dist/index.js",
6
6
  "types": "types",
@@ -3,31 +3,56 @@ import { APIBanType } from "./ban";
3
3
  import { APIContent } from "./content";
4
4
  import { APIUser } from "./user";
5
5
  import { EpochSec } from "../utils";
6
- interface Smiles {
6
+ export interface Smiles {
7
7
  smiles: string;
8
8
  }
9
+ /**
10
+ * An interface representing a news item from the iFunny API
11
+ */
9
12
  export interface APINews {
13
+ /** The ID of the ban associated with this news item */
10
14
  banId?: string;
15
+ /** The type of ban associated with this news item */
11
16
  banType?: APIBanType;
17
+ /** The message associated with the ban type of this news item */
12
18
  banTypeMessage?: string;
19
+ /** The comment associated with this news item */
13
20
  comment?: APIComment;
21
+ /** The content associated with this news item */
14
22
  content?: APIContent;
23
+ /** The number of active strikes */
15
24
  countActiveStrike?: number;
25
+ /** The timestamp of when the news item was posted */
16
26
  date: EpochSec;
27
+ /** The timestamp of when the news item will expire */
17
28
  date_until?: EpochSec;
29
+ /** The timestamp of when the news item expired */
18
30
  expiredAt?: EpochSec;
31
+ /** The URL of the image associated with this news item */
19
32
  imageUrl?: string;
33
+ /** The content mentioned in this news item */
20
34
  mention_content?: APIContent;
35
+ /** The users mentioned in this news item */
21
36
  mention_users?: APIMentionUser[];
37
+ /** The type of purchase associated with this news item */
22
38
  purchaseType?: string;
39
+ /** The reply associated with this news item */
23
40
  reply?: APIReply;
41
+ /** The number of smiles associated with this news item */
24
42
  smiles?: number;
43
+ /** The ID of the strike associated with this news item */
25
44
  strikeId?: string;
45
+ /** The text associated with this news item */
26
46
  text?: string;
47
+ /** The title of this news item */
27
48
  title?: string;
49
+ /** The type of this news item */
28
50
  type: APINewsType;
51
+ /** The URL associated with this news item */
29
52
  url?: string;
53
+ /** The user associated with this news item */
30
54
  user?: APINewsUser;
55
+ /** The username associated with this news item */
31
56
  username?: string;
32
57
  }
33
58
  export interface APINewsReply extends APINewsComment {
@@ -85,6 +110,5 @@ export declare enum NEWS_TYPES {
85
110
  /**
86
111
  * All possible activity types
87
112
  */
88
- declare type APINewsType = `${NEWS_TYPES}`;
89
- export {};
113
+ export declare type APINewsType = `${NEWS_TYPES}`;
90
114
  //# sourceMappingURL=activity.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/payloads/activity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,UAAU,MAAM;IACf,MAAM,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,OAAO;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,IAAI,EAAE,QAAQ,CAAC;IACf,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IACnD,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAChB,SAAQ,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,GAAG,UAAU,CAAC;IAC5D,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,oBAAY,WAAW,GAAG,IAAI,CAC7B,OAAO,EACP,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,aAAa,GAAG,YAAY,GAAG,OAAO,GAAG,YAAY,CACnF,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU;IACrB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,iBAAiB,sBAAsB;IACvC,eAAe,kBAAkB;IACjC,MAAM,iBAAiB;IACvB,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IACrC,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,uBAAuB,4BAA4B;IACnD,uBAAuB,4BAA4B;IACnD,oBAAoB,yBAAyB;IAC7C,KAAK,UAAU;IACf,cAAc,mBAAmB;IACjC,KAAK,UAAU;IACf,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B;;OAEG;IACH,OAAO,YAAY;IACnB,MAAM,kBAAkB;IACxB,cAAc,kBAAkB;IAChC,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,QAAQ,mBAAmB;CAC3B;AAED;;GAEG;AACH,aAAK,WAAW,GAAG,GAAG,UAAU,EAAE,CAAC"}
1
+ {"version":3,"file":"activity.d.ts","sourceRoot":"","sources":["../../src/payloads/activity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEjE,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,QAAQ,CAAC;AACjC,OAAO,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAEpC,MAAM,WAAW,MAAM;IACtB,MAAM,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB,uDAAuD;IACvD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qDAAqD;IACrD,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,iEAAiE;IACjE,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iDAAiD;IACjD,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,iDAAiD;IACjD,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,mCAAmC;IACnC,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qDAAqD;IACrD,IAAI,EAAE,QAAQ,CAAC;IACf,sDAAsD;IACtD,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,kDAAkD;IAClD,SAAS,CAAC,EAAE,QAAQ,CAAC;IACrB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,UAAU,CAAC;IAC7B,4CAA4C;IAC5C,aAAa,CAAC,EAAE,cAAc,EAAE,CAAC;IACjC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,+CAA+C;IAC/C,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8CAA8C;IAC9C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iCAAiC;IACjC,IAAI,EAAE,WAAW,CAAC;IAClB,6CAA6C;IAC7C,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAa,SAAQ,cAAc;IACnD,YAAY,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAChB,SAAQ,IAAI,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,KAAK,GAAG,UAAU,CAAC;IAC5D,GAAG,EAAE,MAAM,CAAC;CACZ;AAED,oBAAY,WAAW,GAAG,IAAI,CAC7B,OAAO,EACP,IAAI,GAAG,MAAM,GAAG,WAAW,GAAG,aAAa,GAAG,YAAY,GAAG,OAAO,GAAG,YAAY,CACnF,CAAC;AAEF;;GAEG;AACH,oBAAY,UAAU;IACrB,GAAG,QAAQ;IACX,UAAU,eAAe;IACzB,OAAO,YAAY;IACnB,iBAAiB,sBAAsB;IACvC,eAAe,kBAAkB;IACjC,MAAM,iBAAiB;IACvB,QAAQ,aAAa;IACrB,iBAAiB,sBAAsB;IACvC,mBAAmB,wBAAwB;IAC3C,mBAAmB,wBAAwB;IAC3C,kBAAkB,uBAAuB;IACzC,eAAe,oBAAoB;IACnC,YAAY,iBAAiB;IAC7B,gBAAgB,qBAAqB;IACrC,qBAAqB,0BAA0B;IAC/C;;OAEG;IACH,mBAAmB,wBAAwB;IAC3C,iBAAiB,sBAAsB;IACvC,uBAAuB,4BAA4B;IACnD,uBAAuB,4BAA4B;IACnD,oBAAoB,yBAAyB;IAC7C,KAAK,UAAU;IACf,cAAc,mBAAmB;IACjC,KAAK,UAAU;IACf,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,aAAa,kBAAkB;IAC/B;;OAEG;IACH,OAAO,YAAY;IACnB,MAAM,kBAAkB;IACxB,cAAc,kBAAkB;IAChC,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,YAAY,iBAAiB;IAC7B,QAAQ,mBAAmB;CAC3B;AAED;;GAEG;AACH,oBAAY,WAAW,GAAG,GAAG,UAAU,EAAE,CAAC"}