imgflip.com 3.5.7 → 3.6.1

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/Imgflip.js

@@ -60,9 +60,12 @@ class Imgflip {
             const response = yield this.apiClient.request(endpoint, config);
             return response.json();
         });
-        this.getMemes = () => __awaiter(this, void 0, void 0, function* () {
+        this.getMemes = (options) => __awaiter(this, void 0, void 0, function* () {
             const endpoint = Endpoints_1.Endpoint.getMemes();
-            const { data } = yield this.apiClient.get(endpoint);
+            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);

package/dist/interfaces.d.ts

@@ -14,7 +14,7 @@ export interface API {
      * 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(): Promise<Response<Memes>>;
+    getMemes(options?: GetMemesOptions): Promise<Response<Memes>>;
 }
 /**
  * `x`, `y`, `width`, and `height` are for the bounding box of the text box. `x` and
@@ -34,6 +34,13 @@ export interface Box {
     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;
@@ -44,7 +51,7 @@ 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 5
+     * 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.
      */
@@ -67,6 +74,7 @@ export interface Meme {
 export interface Memes {
     memes: Meme[];
 }
+export type MemeType = 'gif' | 'image';
 export type Response<T> = {
     data: T;
     success: true;
@@ -76,9 +84,11 @@ export type Response<T> = {
 };
 interface ImageCaptionBase {
     /** The font family to use for the text. Defaults to `impact`. */
-    font?: 'arial' | 'impact';
+    font?: string;
     /** Maximum font size in pixels. Defaults to `50px`. */
-    max_font_size?: string;
+    max_font_size?: number | string;
+    /** Remove the imgflip.com watermark (premium feature). */
+    no_watermark?: 0 | 1 | boolean;
     /** password for the imgflip account */
     password: string;
     /**

package/package.json

@@ -1,16 +1,18 @@
 {
   "author": "Florian Imdahl <git@ffflorian.de>",
   "dependencies": {
-    "@ffflorian/api-client": "2.5.1",
-    "qs": "6.15.0"
+    "@ffflorian/api-client": "2.5.2",
+    "qs": "6.15.2"
   },
   "description": "A imgflip.com API client",
   "devDependencies": {
-    "@types/node": "~24",
-    "@types/qs": "6.15.0",
+    "@types/node": "~25",
+    "@types/qs": "6.15.1",
+    "nock": "14.0.15",
     "rimraf": "6.1.3",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.6"
   },
   "engines": {
     "node": ">= 21"
@@ -29,14 +31,17 @@
   "license": "GPL-3.0",
   "name": "imgflip.com",
   "readme": "https://github.com/ffflorian/api-clients#readme",
-  "repository": "https://github.com/ffflorian/api-clients.git",
+  "repository": {
+    "type": "git",
+    "url": "git+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",
-    "test": "exit 0"
+    "test": "vitest run"
   },
-  "version": "3.5.7"
+  "version": "3.6.1"
 }