@ifunny/ifunny-api-types 1.0.4 → 1.2.2

package/types/payloads/comment.d.ts

@@ -1,124 +1,124 @@
-import { EpochMs } from "../utils";
-import { APIContent, APIContentCreator, APIContentGif, APIContentThumbnail } from "./content";
-import { APIUser, APIUserRating } from "./user";
-/**
- * Represents a Comment from iFunny
- */
-export interface APICommentBase {
-    id: string;
-    /**
-     * Content ID
-     */
-    cid: string;
-    /**
-     * The state of the Comment
-     */
-    state?: APICommentState;
-    /**
-     * Unix timestamp of when it was uploaded in MS
-     */
-    date: EpochMs;
-    /**
-     * Text of the comment
-     * ? Can be empty string
-     */
-    text: string;
-    is_reply: boolean;
-    num: APICommentNum;
-    is_smiled: boolean;
-    is_unsmiled: boolean;
-    is_edited: boolean;
-    user?: APICommentAuthor;
-    deletion_reason?: string;
-    /**
-     * Only observed when viewing own comments
-     */
-    content?: APIContent;
-    attachments: APICommentAttachments;
-    content_thumbs?: APIContentThumbnail;
-    /**
-     * Most recent reply to the comment
-     */
-    last_reply?: APIReply;
-}
-/**
- * Represents a Reply to a Comment from iFunny
- */
-export interface APIReply extends APICommentBase {
-    root_comm_id: string;
-    parent_comm_id: string;
-    depth: number;
-}
-/**
- * Represents a Comment from iFunny
- */
-export declare type APIComment = APICommentBase | APIReply;
-export interface APICommentNum {
-    smiles: number;
-    unsmiles: number;
-    replies: number;
-}
-/**
- * All states of the comment
- */
-export declare enum COMMENT_STATE {
-    NORMAL = "normal",
-    TOP_COMMENT = "top",
-    ABUSED = "abused",
-    DELETED = "deleted",
-    AUTHOR_DELETED = "deleted_self"
-}
-/**
- * All possible states of the comment
- */
-export declare type APICommentState = `${COMMENT_STATE}`;
-export interface APICommentAuthor extends APIContentCreator {
-    rating: APIUserRating;
-}
-export interface APICommentAttachments {
-    content: APIContent[];
-    content_from_links: APIContent[];
-    mention_user: APIMentionUser[];
-    giphy: APIContentGif[];
-}
-export declare type APICommentContent = Pick<APIContent, "id" | "type" | "is_abused" | "bg_color" | "shot_status" | "state" | "size" | "thumb" | "source" | "creator">;
-export interface APIMentionUser {
-    /**
-     * ID of the Mention\
-     * ? Increments last digit of the comment id
-     */
-    id: string;
-    creator: APIContentCreator;
-    nick: APIUser["nick"];
-    start_index: number;
-    stop_index: number;
-    user_id: APIUser["id"];
-    original_nick: APIUser["original_nick"];
-}
-export declare enum APICommentDeletedReaons {
-    /**
-     * Unobserved
-     */
-    SPAM_FILTER = "del_by_spam_filter",
-    /**
-     * Post itself was deleted
-     */
-    CONTENT = "del_content",
-    /**
-     * Content author deleted the comment
-     */
-    CREATOR = "del_content_creator",
-    /**
-     * Removed for slurs usually, state observed to be "deleted" however
-     */
-    ABUSES = "del_for_abuses",
-    /**
-     * Comment was a reply and the root comment was removed
-     */
-    ROOT_COMMENT = "del_root_comment",
-    /**
-     * Unobserved
-     */
-    VIA_PORTAL = "del_via_portal"
-}
+import { EpochMs } from "../utils";
+import { APIContent, APIContentCreator, APIContentGif, APIContentThumbnail } from "./content";
+import { APIUser, APIUserRating } from "./user";
+/**
+ * Represents a Comment from iFunny
+ */
+export interface APICommentBase {
+    id: string;
+    /**
+     * Content ID
+     */
+    cid: string;
+    /**
+     * The state of the Comment
+     */
+    state?: APICommentState;
+    /**
+     * Unix timestamp of when it was uploaded in MS
+     */
+    date: EpochMs;
+    /**
+     * Text of the comment
+     * ? Can be empty string
+     */
+    text: string;
+    is_reply: boolean;
+    num: APICommentNum;
+    is_smiled: boolean;
+    is_unsmiled: boolean;
+    is_edited: boolean;
+    user?: APICommentAuthor;
+    deletion_reason?: string;
+    /**
+     * Only observed when viewing own comments
+     */
+    content?: APIContent;
+    attachments: APICommentAttachments;
+    content_thumbs?: APIContentThumbnail;
+    /**
+     * Most recent reply to the comment
+     */
+    last_reply?: APIReply;
+}
+/**
+ * Represents a Reply to a Comment from iFunny
+ */
+export interface APIReply extends APICommentBase {
+    root_comm_id: string;
+    parent_comm_id: string;
+    depth: number;
+}
+/**
+ * Represents a Comment from iFunny
+ */
+export type APIComment = APICommentBase | APIReply;
+export interface APICommentNum {
+    smiles: number;
+    unsmiles: number;
+    replies: number;
+}
+/**
+ * All states of the comment
+ */
+export declare enum COMMENT_STATE {
+    NORMAL = "normal",
+    TOP_COMMENT = "top",
+    ABUSED = "abused",
+    DELETED = "deleted",
+    AUTHOR_DELETED = "deleted_self"
+}
+/**
+ * All possible states of the comment
+ */
+export type APICommentState = `${COMMENT_STATE}`;
+export interface APICommentAuthor extends APIContentCreator {
+    rating: APIUserRating;
+}
+export interface APICommentAttachments {
+    content: APIContent[];
+    content_from_links: APIContent[];
+    mention_user: APIMentionUser[];
+    giphy: APIContentGif[];
+}
+export type APICommentContent = Pick<APIContent, "id" | "type" | "is_abused" | "bg_color" | "shot_status" | "state" | "size" | "thumb" | "source" | "creator">;
+export interface APIMentionUser {
+    /**
+     * ID of the Mention\
+     * ? Increments last digit of the comment id
+     */
+    id: string;
+    creator: APIContentCreator;
+    nick: APIUser["nick"];
+    start_index: number;
+    stop_index: number;
+    user_id: APIUser["id"];
+    original_nick: APIUser["original_nick"];
+}
+export declare enum APICommentDeletedReaons {
+    /**
+     * Unobserved
+     */
+    SPAM_FILTER = "del_by_spam_filter",
+    /**
+     * Post itself was deleted
+     */
+    CONTENT = "del_content",
+    /**
+     * Content author deleted the comment
+     */
+    CREATOR = "del_content_creator",
+    /**
+     * Removed for slurs usually, state observed to be "deleted" however
+     */
+    ABUSES = "del_for_abuses",
+    /**
+     * Comment was a reply and the root comment was removed
+     */
+    ROOT_COMMENT = "del_root_comment",
+    /**
+     * Unobserved
+     */
+    VIA_PORTAL = "del_via_portal"
+}
 //# sourceMappingURL=comment.d.ts.map

package/types/payloads/comment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../src/payloads/comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,WAAW,EAAE,qBAAqB,CAAC;IACnC,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,oBAAY,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,oBAAY,aAAa;IACxB,MAAM,WAAW;IACjB,WAAW,QAAQ;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,cAAc,iBAAiB;CAC/B;AAED;;GAEG;AACH,oBAAY,eAAe,GAAG,GAAG,aAAa,EAAE,CAAC;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IAC1D,MAAM,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,KAAK,EAAE,aAAa,EAAE,CAAC;CACvB;AAED,oBAAY,iBAAiB,GAAG,IAAI,CACnC,UAAU,EACR,IAAI,GACJ,MAAM,GACN,WAAW,GACX,UAAU,GACV,aAAa,GACb,OAAO,GACP,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,CACX,CAAC;AAEF,MAAM,WAAW,cAAc;IAC9B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACxC;AAED,oBAAY,uBAAuB;IAClC;;OAEG;IACH,WAAW,uBAAuB;IAClC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,OAAO,wBAAwB;IAC/B;;OAEG;IACH,MAAM,mBAAmB;IACzB;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,UAAU,mBAAmB;CAC7B"}
+{"version":3,"file":"comment.d.ts","sourceRoot":"","sources":["../../src/payloads/comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EACN,UAAU,EACV,iBAAiB,EACjB,aAAa,EACb,mBAAmB,EACnB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAEhD;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,CAAC,EAAE,eAAe,CAAC;IACxB;;OAEG;IACH,IAAI,EAAE,OAAO,CAAC;IACd;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,OAAO,CAAC;IAClB,GAAG,EAAE,aAAa,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;IACrB,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,CAAC;IACrB,WAAW,EAAE,qBAAqB,CAAC;IACnC,cAAc,CAAC,EAAE,mBAAmB,CAAC;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,QAAS,SAAQ,cAAc;IAC/C,YAAY,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,MAAM,CAAC;IACvB,KAAK,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG,QAAQ,CAAC;AAEnD,MAAM,WAAW,aAAa;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,oBAAY,aAAa;IACxB,MAAM,WAAW;IACjB,WAAW,QAAQ;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,cAAc,iBAAiB;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG,GAAG,aAAa,EAAE,CAAC;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,iBAAiB;IAC1D,MAAM,EAAE,aAAa,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACrC,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,kBAAkB,EAAE,UAAU,EAAE,CAAC;IACjC,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,KAAK,EAAE,aAAa,EAAE,CAAC;CACvB;AAED,MAAM,MAAM,iBAAiB,GAAG,IAAI,CACnC,UAAU,EACR,IAAI,GACJ,MAAM,GACN,WAAW,GACX,UAAU,GACV,aAAa,GACb,OAAO,GACP,MAAM,GACN,OAAO,GACP,QAAQ,GACR,SAAS,CACX,CAAC;AAEF,MAAM,WAAW,cAAc;IAC9B;;;OAGG;IACH,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,iBAAiB,CAAC;IAC3B,IAAI,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,aAAa,EAAE,OAAO,CAAC,eAAe,CAAC,CAAC;CACxC;AAED,oBAAY,uBAAuB;IAClC;;OAEG;IACH,WAAW,uBAAuB;IAClC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,OAAO,wBAAwB;IAC/B;;OAEG;IACH,MAAM,mBAAmB;IACzB;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,UAAU,mBAAmB;CAC7B"}