@ffflorian/icanhazdadjoke 2.4.7 → 2.6.0

package/README.md

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

package/dist/ICanHazDadJokeAPI.d.ts

@@ -1,12 +1,11 @@
 import type { APIClient } from '@ffflorian/api-client';
-import type { ClientOptions, JokeResult, JokeResultWithImage, JokeSearchResult, RequestOptions, SearchOptions } from './Interfaces';
+import type { ClientOptions, GraphQLResponse, JokeResult, JokeResultWithImage, JokeSearchResult, RequestOptions, SearchOptions, SlackJokeResult } 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;
@@ -14,7 +13,6 @@ export declare class ICanHazDadJokeAPI {
     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;
@@ -22,16 +20,22 @@ export declare class ICanHazDadJokeAPI {
     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>;
+    /**
+     * Fetch a random dad joke as a Slack message.
+     */
+    getSlack(): Promise<SlackJokeResult>;
+    /**
+     * Execute a GraphQL query.
+     */
+    graphql(query: string): Promise<GraphQLResponse>;
     /**
      * Search for dad jokes.
      * @param options Search options (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>;

package/dist/ICanHazDadJokeAPI.js

@@ -10,6 +10,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ICanHazDadJokeAPI = void 0;
+const MIN_SEARCH_LIMIT = 1;
+const MAX_SEARCH_LIMIT = 30;
 class ICanHazDadJokeAPI {
     constructor(apiClient, options) {
         this.apiClient = apiClient;
@@ -38,11 +40,32 @@ class ICanHazDadJokeAPI {
             return metaData;
         });
     }
+    /**
+     * Fetch a random dad joke as a Slack message.
+     */
+    getSlack() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.apiClient.get('/slack');
+            return data;
+        });
+    }
+    /**
+     * Execute a GraphQL query.
+     */
+    graphql(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const { data } = yield this.apiClient.post('/graphql', { query });
+            return data;
+        });
+    }
     search(query_1) {
         return __awaiter(this, arguments, void 0, function* (query, options = {}) {
             if (typeof query === 'string') {
                 options.term = query;
             }
+            if (options.limit !== undefined && (options.limit < MIN_SEARCH_LIMIT || options.limit > MAX_SEARCH_LIMIT)) {
+                throw new Error(`The search limit must be between ${MIN_SEARCH_LIMIT} and ${MAX_SEARCH_LIMIT}, got ${options.limit}.`);
+            }
             const { data } = yield this.apiClient.get('/search', {
                 params: options,
             });

package/dist/Interfaces.d.ts

@@ -1,6 +1,17 @@
 export interface ClientOptions {
     apiUrl?: string;
 }
+export interface GraphQLData {
+    joke: GraphQLJokeResult;
+}
+export interface GraphQLJokeResult {
+    id: string;
+    joke: string;
+    permalink: string;
+}
+export interface GraphQLResponse {
+    data: GraphQLData;
+}
 export interface JokeResult {
     id: string;
     joke: string;
@@ -31,3 +42,13 @@ export interface SearchOptions {
     /** search term to use (default: list all jokes) */
     term?: string;
 }
+export interface SlackAttachment {
+    fallback: string;
+    footer: string;
+    text: string;
+}
+export interface SlackJokeResult {
+    attachments: SlackAttachment[];
+    response_type: string;
+    username: string;
+}

package/package.json

@@ -8,10 +8,12 @@
   "description": "An icanhazdadjoke.com API client with a CLI.",
   "devDependencies": {
     "@types/node": "~24",
+    "nock": "14.0.12",
     "rimraf": "6.1.3",
     "tsx": "4.21.0",
-    "typedoc": "0.28.18",
-    "typescript": "6.0.2"
+    "typedoc": "0.28.19",
+    "typescript": "6.0.3",
+    "vitest": "4.1.5"
   },
   "engines": {
     "node": ">= 21"
@@ -37,7 +39,7 @@
     "clean": "rimraf dist",
     "dist": "yarn clean && yarn build",
     "start": "tsx src/cli.ts",
-    "test": "exit 0"
+    "test": "vitest"
   },
-  "version": "2.4.7"
+  "version": "2.6.0"
 }