@ifunny/ifunny-api-types 0.4.3 → 0.6.1

package/types/payloads/post.d.ts

@@ -1,200 +1,162 @@
 import { APIUser, APIUserNums } from "./user";
 import { HexCode, Size, Timestamp } from "../utils/util";
-import { APIBasePayload } from "./base";
 /**
- * JSON data of an iFunny Post
+ * Post visibility types
  */
-export interface APIPostBase<Type extends APIPostType = APIPostType> extends APIBasePayload {
-    /**
-     * Unique id of the post.\
-     * Typically 9 characters long
-     */
-    id: string;
-    /**
-     * The type of the post.
-     */
-    type: Type;
-    /**
-     * Content url of the post.
-     */
-    url: string;
-    /**
-     * If the post uses the old watermark or the new one
-     */
-    old_watermark: boolean;
-    /**
-     * In-app share url.
-     * @example
-     * `https://ifunny.co/picture/${post.id}`
-     * `https://ifunny.co/video/${post.id}`
-     */
-    link: string;
-    /**
-     * The title of the post
-     */
-    title: string;
-    /**
-     * Fixed title of the post
-     * @example
-     * `Gif memes ${post.id} by ${post.creator.nick}`
-     * `Picture memes ${post.id} by ${post.creator.nick}: ${post.num.comments} comments`
-     */
-    fixed_title: string;
+export declare enum POST_VISIBILITIES {
     /**
-     * Array of tags on the post
+     * Anyone can see the post
      */
-    tags: string[];
+    PUBLIC = "public",
     /**
-     * The publish state of the post
+     * Post is hidden from collective and explore
      */
-    state: APIPostState;
+    SUBSCRIBERS = "subscribers",
     /**
-     * {@link Timestamp} of when the post was created
+     * Only the creator can see the post
      */
-    date_create: Timestamp;
+    CLOSED = "closed"
+}
+export declare type APIContentVisibility = `${POST_VISIBILITIES}`;
+/**
+ * Post shot status types
+ */
+export declare enum SHOT_STATUSES {
     /**
-     * {@link Timestamp} of when the Post was published
+     * The post was approved for upload
      */
-    publish_at: Timestamp;
+    APPROVED = "approved",
     /**
-     * Is the post smiled by the Client
+     * The post was uploaded but immediately deleted by the auto moderation system
      */
-    is_smiled: boolean;
+    HARD_SHOT = "hardShot",
     /**
-     * Is the post unsmiled by the Client
+     * TODO: Find a post with shot status and document difference.
      */
-    is_unsmiled: boolean;
+    SHOT = "shot"
+}
+/**
+ * Possible shot statuses
+ */
+export declare type APIContentShotStatus = `${SHOT_STATUSES}`;
+/**
+ * All currently known post types
+ */
+export declare enum POST_TYPES {
     /**
-     * Is the post removed by iFunny
+     * Most common video post type\
+     * Data key: `video_clip`
      */
-    is_abused: boolean;
+    VIDEO_CLIP = "video_clip",
     /**
-     * Is the post featured by iFunny
+     * A video uploaded from a url like YouTube\
+     * Data key: `video`
      */
-    is_featured: boolean;
+    VIDEO = "video",
     /**
-     * Is the post republished by the Client
+     * A video uploaded from vine\
+     * Data key: `vine`
      */
-    is_republished: boolean;
+    VINE = "vine",
     /**
-     * Is the post pinned by the creator
+     * Video meme from {@link https://coub.com Coub}\
+     * Data key: `coub`
      */
-    is_pinned: boolean;
+    COUB = "coub",
     /**
-     * Background color of the post.
+     * Gif uploaded to ifunny\
+     * Data key: `gif`
      */
-    bg_color: HexCode;
+    GIF = "gif",
     /**
-     * The {@link APIPostThumbnail thumbnail} of the post
+     * Gif with a caption\
+     * Data key: `gif`
      */
-    thumb: APIPostThumbnail;
+    GIF_CAPTION = "gif_caption",
     /**
-     * A post's {@link APIPostCopyright copyright} data
+     * An image post with a custom caption\
+     * Data key: `caption`
      */
-    copyright: APIPostCopyright;
+    CAPTION = "caption",
     /**
-     * The {@link APIPostNums numbers} on the post.
+     * Image upload\
+     * Data key: `pic`
      */
-    num: APIPostNums;
+    PIC = "pic",
     /**
-     * The author of the post
+     * Image uploaded from iFunny's old "Meme" upload system.\
+     * This is no longer in iFunny
      */
-    creator: APIPostCreator;
+    MEME = "mem",
     /**
-     * Size of the post
+     * An image uploaded from ifunny's comic creator
      */
-    size: Size;
+    COMICS = "comics",
     /**
-     * The post's visibility
+     * An interactive post from iFunny
+     * @deprecated These posts have been removed from the database and will not be available
      */
-    visibility: APIPostVisibility;
+    APP = "app",
     /**
-     * ? Don't know what this is
+     * Unknown post type\
+     * TODO: Document what POST_TYPES.OLD is
      */
-    shot_status: APIPostShotStatus;
+    OLD = "old",
     /**
-     * ? Don't know what this does
+     * Unknown post type\
+     * TODO: Document what POST_TYPES.DEM is
      */
-    fast_start: boolean;
+    DEM = "dem"
+}
+/**
+ * Possible post types
+ */
+export declare type APIContentType = `${Exclude<POST_TYPES, POST_TYPES.APP>}`;
+export declare enum POST_STATES {
     /**
-     * @example
-     * `https://ifunny.co/picture/${post.id}`
+     * The post is published
      */
-    canonical_url: string;
+    PUBLISHED = "published",
     /**
-     * Can the post be boosted still
+     * A post that was scheduled to be published later
      */
-    can_be_boosted: boolean;
-}
-export declare enum POST_VISIBILITIES {
-    PUBLIC = "public",
-    subscribers = "subscribers",
-    closed = "closed"
-}
-export declare type APIPostVisibility = `${POST_VISIBILITIES}`;
-export declare enum SHOT_STATUSES {
-    APPROVED = "approved",
-    HARD_SHOT = "hardShot",
-    SHOT = "shot"
+    DELAYED = "delayed"
 }
-export declare type APIPostShotStatus = `${SHOT_STATUSES}`;
 /**
- * All currently known post types
+ * Possible post states
  */
-export declare enum POST_TYPES {
-    CAPTION = "caption",
-    VIDEO = "video",
-    VINE = "vine",
-    COUB = "coub",
-    PIC = "pic",
-    OLD = "old",
-    MEM = "mem",
-    GIF = "gif",
-    APP = "app",
-    DEM = "dem",
-    GIF_CAPTION = "gif_caption",
-    COMICS = "comics",
-    VIDEO_CLIP = "video_clip"
-}
-/**
- * Possible post types
- */
-export declare type APIPostType = `${POST_TYPES}`;
-export declare enum POST_STATES {
-    PUBLISHED = "published"
-}
-export declare type APIPostState = `${POST_STATES}`;
+export declare type APIContentState = `${POST_STATES}`;
 /**
  * Author of a Post\
  * Only includes info also in the user object
  */
-export declare type APIPostCreatorBase = Pick<APIUser, "id" | "nick" | "photo" | "is_verified" | "is_banned" | "is_deleted" | "is_in_subscriptions" | "is_in_subscribers" | "is_blocked" | "nick_color" | "original_nick">;
+export declare type APIContentCreatorBase = Pick<APIUser, "id" | "nick" | "photo" | "is_verified" | "is_banned" | "is_deleted" | "is_in_subscriptions" | "is_in_subscribers" | "is_blocked" | "nick_color" | "original_nick">;
 /**
  * The creator object for a post
  */
-export interface APIPostCreator extends APIPostCreatorBase {
+export interface APIContentCreator extends APIContentCreatorBase {
     /**
      * Only includes subscription and subscriber count
      */
-    num: APIPostCreatorNum;
+    num: APIContentCreatorNum;
     /**
      * Total amount of posts the creator has. For some reason this is not in the nums object for creators
      */
     total_posts: number;
 }
 /**
- * Alias for {@link APIPostCreator}
+ * Alias for {@link APIContentCreator}
  */
-export declare type APIPostAuthor = APIPostCreator;
+export declare type APIContentAuthor = APIContentCreator;
 /**
  * Num object for Post Creator.\
  * total_posts is in the creator object for some reason
  */
-export declare type APIPostCreatorNum = Pick<APIUserNums, "subscribers" | "subscriptions">;
+export declare type APIContentCreatorNum = Pick<APIUserNums, "subscribers" | "subscriptions">;
 /**
  * Numbers attatched to a post
  */
-export interface APIPostNums {
+export interface APIContentNums {
     /**
      * The amount of smiles the post has
      */
@@ -220,15 +182,14 @@ export interface APIPostNums {
      */
     republished: number;
     /**
-     * How many shares the post has.\
-     * ? Increases from the share url if the share url is different from the web_url
+     * How many shares the post has
      */
     shares: number;
 }
 /**
  * Copyright data for a post.
  */
-export interface APIPostCopyright {
+export interface APIContentCopyright {
     /**
      * Note about the copyright
      */
@@ -242,21 +203,21 @@ export interface APIPostCopyright {
  * The Thumbnail object returned from the API\
  * @example
  * ```ts
- * APIPostThumbnail.url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.jpg`
- * APIPostThumbnail.webp_url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.webp
+ * APIContentThumbnail.url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.jpg`
+ * APIContentThumbnail.webp_url = `https://imageproxy.ifunny.co/${params}/images/${content_id}.webp
  * ```
  * Content URL params:\
  * `crop:x-{number}` crops `number` pixels from bottom of the image\
  * `crop:x+{number}` leaves `number` pixels at the top, and crops the rest\
  * `crop:square` makes the image a square aspect ratio\
  * `resize:{number}` changes the size of the image\
- * `quality:{number}` changes the image quality\
+ * `quality:{number}` changes the image quality
  *
  *
  * ? Bottom iFunny watermarks are 20 pixels tall\
- * ? `crop:x-20` crops the watermakr from an image
+ * ? `crop:x-20` crops the watermark from an image
  */
-export interface APIPostThumbnail {
+export interface APIContentThumbnail {
     /**
      * crop:x-20,crop:square,resize:65x,quality:90x75\
      * `jpg`
@@ -302,62 +263,72 @@ export interface APIPostThumbnail {
      */
     proportional_size: Size;
 }
-export interface APIPicturePost extends APIPostBase<"pic"> {
-    pic: {
-        /**
-         * webp format url of the post
-         */
-        webp_url: string;
-    };
-}
-/**
- * A video post object
- */
-export interface APIVideoPost extends APIPostBase<"video_clip"> {
-    video_clip: APIPostVideoData;
-}
-/**
- * A gif post
- */
-export interface APIGifPost extends APIPostBase<"gif"> {
-    gif: APIPostGifData;
-}
-/**
- * A gif caption post
- */
-export interface APIGifCaptionPost extends APIPostBase<"gif_caption"> {
-    gif: APIPostGifCaptionData;
-}
-/**
- * A caption post
- */
-export interface APICaptionPost extends APIPostBase<"caption"> {
-    caption: APIPostCaptionData;
+interface WebP {
+    /**
+     * webp format url of the post
+     */
+    webp_url: string;
 }
-export interface APIVinePost extends APIPostBase<"vine"> {
+export declare enum VIDEO_SOURCE_TYPES {
+    USER = "user",
+    INSTAGRAM = "instagram"
 }
-export interface APIComicsPost extends APIPostBase<"comics"> {
+export declare type APIVideoSourceType = `${VIDEO_SOURCE_TYPES}`;
+export interface APICoubContentData {
+    /**
+     * WebP thumbnail of the Coub
+     */
+    screen_url: string;
+    bytes: number;
+    /**
+     * Original Coub source
+     */
+    traceback_url: string;
+    /**
+     * Length in seconds
+     */
+    duration: number;
 }
-export interface APIMemePost extends APIPostBase<"mem"> {
+export interface APIVideoContentData {
+    /**
+     * Url of original video
+     */
+    url: string;
+    /**
+     * Length in seconds
+     */
+    duration: number;
+    /**
+     * Length in seconds
+     */
+    length: number;
 }
-export interface APIPostVideoData {
+export interface APIVideoClipContentData {
+    /**
+     * JPEG image of the video clip
+     */
     screen_url: string;
     bytes: number;
-    source_type: "user";
-    duration: 0;
+    source_type: APIVideoSourceType;
+    /**
+     * In seconds
+     */
+    duration: Timestamp;
 }
-export declare enum VIDEO_SOURCE_TYPES {
-    USER = "user"
+export interface APIVineContentData {
+    screen_url: string;
+    bytes: number;
 }
-export declare type APIVideoPostSourceType = `${VIDEO_SOURCE_TYPES}`;
-export declare type APIPostGifCaptionData = APIPostGifData & APIPostCaptionData;
-export interface APIPostCaptionData {
+export interface APICaptionContentData {
     /**
      * The caption of the post
      */
-    caption: string;
+    caption_text: string;
 }
-export interface APIPostGifData {
+export declare type APIComicsContentData = WebP;
+export declare type APIMemeContentData = WebP;
+export declare type APIPicContentData = WebP;
+export interface APIGifContentData {
     /**
      * JPEG url of the post
      */
@@ -375,8 +346,197 @@ export interface APIPostGifData {
      */
     mp4_bytes: number;
 }
+export declare type APIGifCaptionContentData = APIGifContentData & APICaptionContentData;
+export interface UnknownContentData extends JSON {
+}
+/**
+ * JSON data of an iFunny Post
+ */
+export interface APIContentBase {
+    /**
+     * Unique id of the post.\
+     * Typically 9 characters long
+     */
+    id: string;
+    /**
+     * The type of the post.
+     */
+    type: APIContentType;
+    /**
+     * Content url of the post.
+     */
+    url: string;
+    /**
+     * If the post uses the old watermark or the new one
+     */
+    old_watermark: boolean;
+    /**
+     * In-app share url.
+     * @example
+     * `https://ifunny.co/picture/${post.id}`
+     * `https://ifunny.co/video/${post.id}`
+     */
+    link: string;
+    /**
+     * The title of the post
+     */
+    title: string;
+    /**
+     * Fixed title of the post
+     * @example
+     * `Gif memes ${post.id} by ${post.creator.nick}`
+     * `Picture memes ${post.id} by ${post.creator.nick}: ${post.num.comments} comments`
+     */
+    fixed_title: string;
+    /**
+     * Array of tags on the post
+     */
+    tags: string[];
+    /**
+     * The publish state of the post
+     */
+    state: APIContentState;
+    /**
+     * {@link Timestamp} of when the post was created
+     */
+    date_create: Timestamp;
+    /**
+     * {@link Timestamp} of when the Post was published
+     */
+    publish_at: Timestamp;
+    /**
+     * Is the post smiled by the Client
+     */
+    is_smiled: boolean;
+    /**
+     * Is the post unsmiled by the Client
+     */
+    is_unsmiled: boolean;
+    /**
+     * Is the post removed by iFunny
+     */
+    is_abused: boolean;
+    /**
+     * Is the post featured by iFunny
+     */
+    is_featured: boolean;
+    /**
+     * Is the post republished by the Client
+     */
+    is_republished: boolean;
+    /**
+     * Is the post pinned by the creator
+     */
+    is_pinned: boolean;
+    /**
+     * Background color of the post.
+     */
+    bg_color: HexCode;
+    /**
+     * The {@link APIContentThumbnail thumbnail} of the post
+     */
+    thumb: APIContentThumbnail;
+    /**
+     * A post's {@link APIContentCopyright copyright} data
+     */
+    copyright: APIContentCopyright;
+    /**
+     * The {@link APIContentNums numbers} on the post.
+     */
+    num: APIContentNums;
+    /**
+     * The author of the post
+     */
+    creator?: APIContentCreator;
+    /**
+     * Size of the post
+     */
+    size: Size;
+    /**
+     * Url of the original source
+     */
+    traceback_url?: string;
+    /**
+     * The post's visibility
+     */
+    visibility: APIContentVisibility;
+    /**
+     * TODO: shot_status description
+     */
+    shot_status: APIContentShotStatus;
+    /**
+     * TODO: fast_start description
+     */
+    fast_start: boolean;
+    /**
+     * The risk level of the post
+     */
+    risk: number;
+    /**
+     * @example
+     * `https://ifunny.co/picture/${post.id}`
+     */
+    canonical_url: string;
+    /**
+     * Text generated from iFunny's OCR
+     */
+    ocr_text?: string;
+    /**
+     * Can the post be boosted still
+     */
+    can_be_boosted: boolean;
+    /**
+     * The source of the post if it's a republish
+     */
+    source?: APIContentSource;
+}
+export interface APICoubContent extends APIContentBase {
+    type: POST_TYPES.COUB;
+    coub: APICoubContentData;
+}
+export interface APIVideoClipContent extends APIContentBase {
+    type: POST_TYPES.VIDEO_CLIP;
+    video_clip: APIVideoClipContentData;
+}
+export interface APIVideoContent extends APIContentBase {
+    type: POST_TYPES.VIDEO;
+    video: APIVideoContentData;
+}
+export interface APIVineContent extends APIContentBase {
+    type: POST_TYPES.VINE;
+    vine: APIVineContentData;
+}
+export interface APICaptionContent extends APIContentBase {
+    type: POST_TYPES.CAPTION;
+    caption: APICaptionContentData;
+}
+export interface APIComicsContent extends APIContentBase {
+    type: POST_TYPES.COMICS;
+    comics: APIComicsContentData;
+}
+export interface APIMemeContent extends APIContentBase {
+    type: POST_TYPES.MEME;
+    meme: APIMemeContentData;
+}
+export interface APIPicContent extends APIContentBase {
+    type: POST_TYPES.PIC;
+    pic: APIPicContentData;
+}
+export interface APIGifContent extends APIContentBase {
+    type: POST_TYPES.GIF;
+    gif: APIGifContentData;
+}
+export interface APIGifCaptionContent extends APIContentBase {
+    type: POST_TYPES.GIF_CAPTION;
+    gif: APIGifCaptionContentData;
+}
 /**
- * All possible Post Objects
+ * The original source of the content
  */
-export declare type APIPost = APIPicturePost | APIVideoPost | APIGifPost | APIGifCaptionPost | APICaptionPost | APIVinePost | APIComicsPost | APIMemePost;
+export declare type APIContentSource = Partial<APIContent> & Pick<APIContent, "id" | "date_create">;
+export declare type APIContent = APIContentVideo | APIContentPic | APIContentGif;
+export declare type APIContentVideo = APICoubContent | APIVideoClipContent | APIVideoContent | APIVineContent;
+export declare type APIContentPic = APICaptionContent | APIPicContent | APIComicsContent | APIMemeContent;
+export declare type APIContentGif = APIGifContent | APIGifCaptionContent;
+export {};
 //# sourceMappingURL=post.d.ts.map