imgflip.com 3.5.6 → 3.6.0

package/README.md

@@ -1,6 +1,6 @@
 # imgflip.com [![npm version](https://img.shields.io/npm/v/imgflip.com.svg)](https://www.npmjs.com/package/imgflip.com)
 
-An [imgflip.com](https://imgflip.com) API client. For a documentation on the API see https://api.imgflip.com/.
+An [imgflip.com](https://imgflip.com) API client. For a documentation on the API see [the imgflip API reference](https://imgflip.com/api).
 
 ### Installation
 

package/dist/Endpoints.d.ts

@@ -0,0 +1,6 @@
+export declare const Endpoint: {
+    CAPTION_IMAGE: string;
+    captionImage(): string;
+    GET_MEMES: string;
+    getMemes(): string;
+};

package/dist/Endpoints.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+exports.Endpoint = {
+    CAPTION_IMAGE: 'caption_image',
+    captionImage() {
+        return `/${exports.Endpoint.CAPTION_IMAGE}`;
+    },
+    GET_MEMES: 'get_memes',
+    getMemes() {
+        return `/${exports.Endpoint.GET_MEMES}`;
+    },
+};

package/dist/Imgflip.d.ts

@@ -0,0 +1,14 @@
+import type { API } from './interfaces';
+export declare class Imgflip {
+    private static readonly BASE_URL;
+    readonly api: API;
+    private readonly apiClient;
+    constructor(apiUrl?: string);
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+    private readonly captionImage;
+    private readonly getMemes;
+}

package/dist/Imgflip.js

@@ -0,0 +1,86 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Imgflip = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const qs = __importStar(require("qs"));
+const Endpoints_1 = require("./Endpoints");
+class Imgflip {
+    constructor(apiUrl) {
+        this.captionImage = (params) => __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.captionImage();
+            const config = {
+                data: qs.stringify(params, { arrayFormat: 'indices' }),
+                headers: {
+                    'Content-Type': 'application/x-www-form-urlencoded',
+                },
+                method: 'POST',
+            };
+            const response = yield this.apiClient.request(endpoint, config);
+            return response.json();
+        });
+        this.getMemes = (options) => __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.getMemes();
+            const { data } = yield this.apiClient.get(endpoint, {
+                params: options
+                    ? Object.assign(Object.assign({}, options), { type: Array.isArray(options.type) ? options.type.join(',') : options.type }) : undefined,
+            });
+            return data;
+        });
+        this.apiClient = new api_client_1.APIClient(apiUrl || Imgflip.BASE_URL);
+        this.api = {
+            captionImage: this.captionImage,
+            getMemes: this.getMemes,
+        };
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.Imgflip = Imgflip;
+Imgflip.BASE_URL = 'https://api.imgflip.com';

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Imgflip';
+export * from './interfaces';

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./Imgflip"), exports);
+__exportStar(require("./interfaces"), exports);

package/dist/interfaces.d.ts

@@ -0,0 +1,105 @@
+export interface API {
+    /**
+     * Add a caption to an Imgflip meme template.
+     * Images created with this API will be publicly accessible by anyone
+     * through the url in the response - there is no "private" option.
+     * This does not mean these memes will be posted publicly though,
+     * one still needs to know the exact URL to find the image.
+     * If the image hangs around on Imgflip servers for a while and
+     * gets very few views (direct image views and image page views both
+     * count), it will be auto-deleted to save space.
+     */
+    captionImage(options: ImageCaptionOptions): Promise<Response<Image>>;
+    /**
+     * Gets an array of popular memes that may be captioned with this API.
+     * The size of this array and the order of memes may change at any time.
+     */
+    getMemes(options?: GetMemesOptions): Promise<Response<Memes>>;
+}
+/**
+ * `x`, `y`, `width`, and `height` are for the bounding box of the text box. `x` and
+ * `y` are the coordinates of the top left corner. If you specify bounding
+ * coordinates, be sure to specify all four (`x`, `y`, `width`, `height`), otherwise
+ * your text may not show up correctly. If you do not specify bounding box
+ * coordinates, the same automatic default coordinates from
+ * https://imgflip.com/memegenerator will be used, which is very useful for memes
+ * with special text box positioning other than the simple top/bottom.
+ */
+export interface Box {
+    color?: string;
+    height?: number;
+    outline_color?: string;
+    text: string;
+    width?: number;
+    x?: number;
+    y?: number;
+}
+export type GetMemesOptions = {
+    /**
+     * The type of meme templates to return.
+     * Valid values are `gif` or `image`.
+     */
+    type?: MemeType | MemeType[];
+};
+export interface Image {
+    page_url: string;
+    url: string;
+}
+export type ImageCaptionOptions = ImageCaptionWithBoxes | ImageCaptionWithTexts;
+export interface ImageCaptionWithBoxes extends ImageCaptionBase {
+    /**
+     * For creating memes with more than two text boxes, or for further
+     * customization. If boxes is specified, text will not be automatically
+     * converted to uppercase, so you'll have to handle capitalization yourself
+     * if you want the standard uppercase meme text. You may specify up to 20
+     * text boxes. You may leave the first box completely empty, so that the
+     * second box will automatically be used for the bottom text.
+     */
+    boxes: Box[];
+}
+export interface ImageCaptionWithTexts extends ImageCaptionBase {
+    /** Top text for the meme */
+    text0: string;
+    /** Bottom text for the meme */
+    text1: string;
+}
+export interface Meme {
+    box_count: number;
+    height: number;
+    id: string;
+    name: string;
+    url: string;
+    width: number;
+}
+export interface Memes {
+    memes: Meme[];
+}
+export type MemeType = 'gif' | 'image';
+export type Response<T> = {
+    data: T;
+    success: true;
+} | {
+    error_message: string;
+    success: false;
+};
+interface ImageCaptionBase {
+    /** The font family to use for the text. Defaults to `impact`. */
+    font?: string;
+    /** Maximum font size in pixels. Defaults to `50px`. */
+    max_font_size?: number | string;
+    /** Remove the imgflip.com watermark (premium feature). */
+    no_watermark?: 0 | 1 | boolean;
+    /** password for the imgflip account */
+    password: string;
+    /**
+     * A template ID as returned by the `get_memes` response. Any ID that was
+     * ever returned from the `get_memes` response should work for this parameter.
+     * For custom template uploads, the template ID can be found in the
+     * memegenerator URL, e.g.
+     * https://imgflip.com/memegenerator/14859329/Charlie-Sheen-DERP.
+     */
+    template_id: number | string;
+    /** username of a valid imgflip account. This is used to track where API requests are coming from. */
+    username: string;
+}
+export {};

package/dist/interfaces.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,16 +1,18 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.0",
-    "qs": "6.15.0"
+    "@ffflorian/api-client": "2.5.1",
+    "qs": "6.15.1"
   },
   "description": "A imgflip.com API client",
   "devDependencies": {
     "@types/node": "~24",
     "@types/qs": "6.15.0",
+    "nock": "14.0.12",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.2",
+    "vitest": "4.1.4"
   },
   "engines": {
     "node": ">= 21"
@@ -31,11 +33,12 @@
   "readme": "https://github.com/ffflorian/api-clients#readme",
   "repository": "https://github.com/ffflorian/api-clients.git",
   "scripts": {
+    "build": "yarn build:ts",
     "build:ts": "tsc -p tsconfig.build.json",
     "build:docs": "typedoc --tsconfig tsconfig.build.json --options ../../typedoc.json --out ../../docs/packages/imgflip.com src/index.ts",
     "clean": "rimraf dist",
-    "dist": "yarn clean && yarn build:ts",
-    "test": "exit 0"
+    "dist": "yarn clean && yarn build",
+    "test": "vitest run"
   },
-  "version": "3.5.6"
+  "version": "3.6.0"
 }