@ffflorian/icanhazdadjoke 2.4.4 → 2.4.6

package/package.json

@@ -2,16 +2,16 @@
   "author": "Florian Imdahl <git@ffflorian.de>",
   "bin": "dist/cli.js",
   "dependencies": {
-    "@ffflorian/api-client": "2.2.0",
-    "commander": "14.0.2"
+    "@ffflorian/api-client": "2.5.0",
+    "commander": "14.0.3"
   },
   "description": "An icanhazdadjoke.com API client with a CLI.",
   "devDependencies": {
     "@types/node": "~24",
-    "rimraf": "6.1.2",
+    "rimraf": "6.1.3",
     "tsx": "4.21.0",
-    "typedoc": "0.28.15",
-    "typescript": "5.9.3"
+    "typedoc": "0.28.18",
+    "typescript": "6.0.2"
   },
   "engines": {
     "node": ">= 21"
@@ -38,6 +38,5 @@
     "start": "tsx src/cli.ts",
     "test": "exit 0"
   },
-  "version": "2.4.4",
-  "gitHead": "12bebfb90528bb894bccb99670373af33c6a5159"
+  "version": "2.4.6"
 }

package/dist/ICanHazDadJoke.d.ts

@@ -1,13 +0,0 @@
-import { ICanHazDadJokeAPI } from './ICanHazDadJokeAPI';
-import type { ClientOptions } from './Interfaces';
-export declare class ICanHazDadJoke {
-    readonly api: ICanHazDadJokeAPI;
-    private readonly apiClient;
-    private readonly options;
-    constructor(options?: ClientOptions);
-    /**
-     * Set a new API URL.
-     * @param url The new API URL.
-     */
-    setApiUrl(newURL: string): void;
-}

package/dist/ICanHazDadJoke.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ICanHazDadJoke = void 0;
-const api_client_1 = require("@ffflorian/api-client");
-const ICanHazDadJokeAPI_1 = require("./ICanHazDadJokeAPI");
-class ICanHazDadJoke {
-    constructor(options) {
-        this.options = Object.assign({ apiUrl: 'https://icanhazdadjoke.com' }, options);
-        this.apiClient = new api_client_1.APIClient(this.options.apiUrl, {
-            headers: {
-                Accept: 'application/json',
-                'User-Agent': 'icanhazdadjoke.com API Client (https://github.com/ffflorian/api-clients/tree/main/packages/icanhazdadjoke)',
-            },
-        });
-        this.api = new ICanHazDadJokeAPI_1.ICanHazDadJokeAPI(this.apiClient, this.options);
-    }
-    /**
-     * Set a new API URL.
-     * @param url The new API URL.
-     */
-    setApiUrl(newURL) {
-        this.apiClient.setBaseURL(newURL);
-    }
-}
-exports.ICanHazDadJoke = ICanHazDadJoke;

package/dist/ICanHazDadJokeAPI.d.ts

@@ -1,39 +0,0 @@
-import type { APIClient } from '@ffflorian/api-client';
-import type { ClientOptions, JokeResult, JokeResultWithImage, JokeSearchResult, RequestOptions, SearchOptions } from './Interfaces';
-export declare class ICanHazDadJokeAPI {
-    protected readonly apiClient: APIClient;
-    protected readonly options: ClientOptions;
-    constructor(apiClient: APIClient, options: ClientOptions);
-    /**
-     * Fetch a dad joke by ID.
-     * @see https://icanhazdadjoke.com/api#fetch-a-dad-joke
-     */
-    getById(id: string, options: {
-        withImage: true;
-    }): Promise<JokeResultWithImage>;
-    getById(id: string, options?: RequestOptions): Promise<JokeResult>;
-    /**
-     * Fetch a dad joke by ID.
-     * @see https://icanhazdadjoke.com/api#fetch-a-dad-joke
-     */
-    getByID(id: string, options: {
-        withImage: true;
-    }): Promise<JokeResultWithImage>;
-    getByID(id: string, options?: RequestOptions): Promise<JokeResult>;
-    /**
-     * Fetch a random dad joke.
-     * @see https://icanhazdadjoke.com/api#fetch-a-random-dad-joke
-     */
-    getRandom(options: {
-        withImage: true;
-    }): Promise<JokeResultWithImage>;
-    getRandom(options?: RequestOptions): Promise<JokeResult>;
-    /**
-     * Search for dad jokes.
-     * @param term search term to use (default: list all jokes)
-     * @see https://icanhazdadjoke.com/api#search-for-dad-jokes
-     */
-    search(options: SearchOptions): Promise<JokeSearchResult>;
-    search(query: string, options?: Omit<SearchOptions, 'term'>): Promise<JokeSearchResult>;
-    private getImage;
-}

package/dist/ICanHazDadJokeAPI.js

@@ -1,64 +0,0 @@
-"use strict";
-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.ICanHazDadJokeAPI = void 0;
-class ICanHazDadJokeAPI {
-    constructor(apiClient, options) {
-        this.apiClient = apiClient;
-        this.options = options;
-    }
-    getById(id, options = {}) {
-        return this.getByID(id, options);
-    }
-    getByID(id_1) {
-        return __awaiter(this, arguments, void 0, function* (id, options = {}) {
-            const { data: metaData } = yield this.apiClient.get(`/j/${id}`);
-            if (options.withImage) {
-                const imageData = yield this.getImage(`/j/${id}.png`);
-                return Object.assign(Object.assign({}, metaData), { image: imageData });
-            }
-            return metaData;
-        });
-    }
-    getRandom() {
-        return __awaiter(this, arguments, void 0, function* (options = {}) {
-            const { data: metaData } = yield this.apiClient.get('/');
-            if (options.withImage) {
-                const imageData = yield this.getImage(`/j/${metaData.id}.png`);
-                return Object.assign(Object.assign({}, metaData), { image: imageData });
-            }
-            return metaData;
-        });
-    }
-    search(query_1) {
-        return __awaiter(this, arguments, void 0, function* (query, options = {}) {
-            if (typeof query === 'string') {
-                options.term = query;
-            }
-            const { data } = yield this.apiClient.get('/search', {
-                params: options,
-            });
-            return data;
-        });
-    }
-    getImage(imageUrl) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const { data } = yield this.apiClient.get(imageUrl, {
-                headers: {
-                    Accept: 'image/png',
-                },
-                responseType: 'arraybuffer',
-            });
-            return data;
-        });
-    }
-}
-exports.ICanHazDadJokeAPI = ICanHazDadJokeAPI;

package/dist/Interfaces.d.ts

@@ -1,33 +0,0 @@
-export interface RequestOptions {
-    withImage?: boolean;
-}
-export interface ClientOptions {
-    apiUrl?: string;
-}
-export interface JokeResult {
-    id: string;
-    joke: string;
-    status: number;
-}
-export interface JokeSearchResult {
-    current_page: number;
-    limit: number;
-    next_page: number;
-    previous_page: number;
-    results: JokeResult[];
-    search_term: string;
-    status: number;
-    total_jokes: number;
-    total_pages: number;
-}
-export interface JokeResultWithImage extends JokeResult {
-    image: Buffer;
-}
-export interface SearchOptions {
-    /** number of results to return per page (default: 20) (max: 30) */
-    limit?: number;
-    /** which page of results to fetch (default: 1) */
-    page?: number;
-    /** search term to use (default: list all jokes) */
-    term?: string;
-}

package/dist/Interfaces.js

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

package/dist/cli.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/cli.js

@@ -1,123 +0,0 @@
-#!/usr/bin/env node
-"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 });
-const commander_1 = require("commander");
-const fs_1 = require("fs");
-const path = __importStar(require("path"));
-const _1 = require("./");
-function init() {
-    return __awaiter(this, arguments, void 0, function* (dir = '.') {
-        const resolvedPath = path.resolve(dir);
-        try {
-            yield fs_1.promises.access(resolvedPath, fs_1.constants.F_OK | fs_1.constants.R_OK);
-            const iCanHazDadJoke = new _1.ICanHazDadJoke();
-            return [resolvedPath, iCanHazDadJoke];
-        }
-        catch (_a) {
-            throw new Error('The specified path does not exist or is not writable.');
-        }
-    });
-}
-function save(filePath_1, imageResult_1) {
-    return __awaiter(this, arguments, void 0, function* (filePath, imageResult, silent = false) {
-        const { id, image } = imageResult;
-        const resolvedFilePath = path.resolve(filePath, `dad_joke_${id}.png`);
-        yield fs_1.promises.writeFile(resolvedFilePath, image);
-        if (!silent) {
-            console.info(`Saved image to "${resolvedFilePath}".`);
-        }
-    });
-}
-const { description, name, version } = require('../package.json');
-commander_1.program.on('command:*', () => commander_1.program.help());
-commander_1.program
-    .name(name.replace(/^@[^/]+\//, ''))
-    .version(version, '-v, --version')
-    .description(description)
-    .option('-i, --image', 'Save the joke as image')
-    .option('-o, --output <dir>', 'Specify the output directory', path.resolve('.'))
-    .option('-s, --silent', `Don't output save messages`);
-commander_1.program
-    .command('random')
-    .description('Fetch a random joke')
-    .action(() => __awaiter(void 0, void 0, void 0, function* () {
-    const options = commander_1.program.opts();
-    try {
-        const [resolvedPath, iCanHazDadJoke] = yield init(options.output);
-        const result = yield iCanHazDadJoke.api.getRandom({ withImage: !!options.image });
-        console.info(result.joke);
-        if (options.image) {
-            yield save(resolvedPath, result, !!options.silent);
-        }
-    }
-    catch (error) {
-        console.error(`Error: ${error.message}`);
-        process.exit(1);
-    }
-}));
-commander_1.program
-    .command('id')
-    .argument('<id>', 'The joke ID')
-    .description('Fetch joke by ID')
-    .action((id) => __awaiter(void 0, void 0, void 0, function* () {
-    const options = commander_1.program.opts();
-    try {
-        const [resolvedPath, iCanHazDadJoke] = yield init(options.output);
-        const result = yield iCanHazDadJoke.api.getById(id, { withImage: !!options.image });
-        console.info(result.joke);
-        if (options.image) {
-            yield save(resolvedPath, result, !!options.silent);
-        }
-    }
-    catch (error) {
-        console.error(`Error: ${error.message}`);
-        process.exit(1);
-    }
-}));
-commander_1.program.parse(process.argv);
-if (!process.argv.slice(2).length) {
-    commander_1.program.outputHelp();
-    process.exit(1);
-}

package/dist/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ICanHazDadJoke';
-export * from './Interfaces';

package/dist/index.js

@@ -1,18 +0,0 @@
-"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("./ICanHazDadJoke"), exports);
-__exportStar(require("./Interfaces"), exports);