@aicats/sdk 1.1.0 → 1.2.0

package/dist/index.d.mts

@@ -1,18 +1,32 @@
 /**
- * A search result containing a cat image ID and URL
+ * Available media types for AI cat media
+ */
+declare enum Type {
+    /** All media types */
+    All = "",
+    /** Image media type (Default) */
+    Image = "Image",
+    /** Video media type */
+    Video = "Video"
+}
+
+/**
+ * A search result containing a cat media ID and URL
  */
 interface SearchResult {
-    /** Unique identifier for the cat image */
+    /** Unique identifier for the cat media */
     id: string;
-    /** Direct URL to the cat image */
+    /** Direct URL to the cat media */
     url: string;
+    /** The type of media */
+    type: Type;
 }
 
 /**
- * Available themes for AI cat images
+ * Available themes for AI cat media
  */
 declare enum Theme {
-    /** Standard cat images */
+    /** Standard cat images/videos */
     Default = "Default",
     /** Spring-themed cats with flowers and nature */
     Spring = "Spring",
@@ -33,23 +47,25 @@ declare enum Theme {
 }
 
 /**
- * Detailed information about a cat image
+ * Detailed information about a cat media
  */
 interface CatInfo {
-    /** Unique identifier for the cat image */
+    /** Unique identifier for the cat media */
     id: string;
-    /** URL to access the cat image */
+    /** URL to access the cat media */
     url: string;
-    /** Unix timestamp when the image was created */
+    /** Unix timestamp when the media was created */
     dateCreated: number;
-    /** The AI prompt used to generate this cat image */
+    /** The AI prompt used to generate this cat media */
     prompt: string;
-    /** The theme of the cat image */
+    /** The theme of the cat media */
     theme: Theme;
+    /** The type of media */
+    type: Type;
 }
 
 /**
- * Available image sizes for AI cat images
+ * Available media sizes for AI cat media
  */
 declare enum Size {
     /** 1024x1024 pixels (default, highest quality) */
@@ -68,16 +84,18 @@ declare enum Size {
     Micro = "16"
 }
 
-/** Response type for image requests */
+/** Response type for media requests */
 type ResponseType = 'blob' | 'arrayBuffer' | 'base64' | 'dataUrl';
-/** Image response based on responseType */
-type ImageResponse<T extends ResponseType = 'blob'> = T extends 'blob' ? Blob : T extends 'arrayBuffer' ? ArrayBuffer : T extends 'base64' ? string : T extends 'dataUrl' ? string : Blob;
+/** Media response based on responseType */
+type MediaResponse<T extends ResponseType = 'blob'> = T extends 'blob' ? Blob : T extends 'arrayBuffer' ? ArrayBuffer : T extends 'base64' ? string : T extends 'dataUrl' ? string : Blob;
 /** Options for getting a random cat */
 interface RandomCatOptions<T extends ResponseType = 'blob'> {
-    /** Image size (default: Large) */
+    /** Media size (default: Large) */
     size?: Size;
-    /** Theme of the cat image */
+    /** Theme of the cat media */
     theme?: Theme;
+    /** Filter by media type */
+    type?: Type;
     /** Response format (default: blob) */
     responseType?: T;
 }
@@ -93,33 +111,43 @@ interface SearchOptions {
     descending?: boolean;
     /** Filter by theme */
     theme?: Theme;
-    /** Image size in results */
+    /** Media size in results */
     size?: Size;
+    /** Filter by media type */
+    type?: Type;
 }
 /** Options for similar cats */
 interface SimilarOptions {
     /** Maximum number of results (1-100, default: 10) */
     limit?: number;
-    /** Image size in results */
+    /** Media size in results */
     size?: Size;
 }
 /** Options for getting a cat by ID */
 interface GetByIdOptions<T extends ResponseType = 'blob'> {
-    /** Image size (default: Large) */
+    /** Media size (default: Large) */
     size?: Size;
+    /** media type */
+    type?: Type;
     /** Response format (default: blob) */
     responseType?: T;
 }
+interface CountOptions {
+    /** Filter by theme */
+    theme?: Theme;
+    /** Filter by media type */
+    type?: Type;
+}
 
 declare const AiCats: {
-    random: <T extends ResponseType = "blob">(options?: RandomCatOptions<T>) => Promise<ImageResponse<T>>;
-    getById: <T extends ResponseType = "blob">(id: string, options?: GetByIdOptions<T>) => Promise<ImageResponse<T>>;
+    random: <T extends ResponseType = "blob">(options?: RandomCatOptions<T>) => Promise<MediaResponse<T>>;
+    getById: <T extends ResponseType = "blob">(id: string, options?: GetByIdOptions<T>) => Promise<MediaResponse<T>>;
     getInfo: (id: string) => Promise<CatInfo>;
     search: (options?: SearchOptions) => Promise<SearchResult[]>;
     getSimilar: (id: string, options?: SimilarOptions) => Promise<SearchResult[]>;
     getSearchCompletion: (options?: SearchOptions) => Promise<string>;
     getThemes: () => Promise<Theme[]>;
-    getCount: (theme?: Theme) => Promise<number>;
+    getCount: (options?: CountOptions) => Promise<number>;
 };
 
 export { AiCats, type CatInfo, type RandomCatOptions, type SearchOptions, type SearchResult, type SimilarOptions, Size, Theme };

package/dist/index.d.ts

@@ -1,18 +1,32 @@
 /**
- * A search result containing a cat image ID and URL
+ * Available media types for AI cat media
+ */
+declare enum Type {
+    /** All media types */
+    All = "",
+    /** Image media type (Default) */
+    Image = "Image",
+    /** Video media type */
+    Video = "Video"
+}
+
+/**
+ * A search result containing a cat media ID and URL
  */
 interface SearchResult {
-    /** Unique identifier for the cat image */
+    /** Unique identifier for the cat media */
     id: string;
-    /** Direct URL to the cat image */
+    /** Direct URL to the cat media */
     url: string;
+    /** The type of media */
+    type: Type;
 }
 
 /**
- * Available themes for AI cat images
+ * Available themes for AI cat media
  */
 declare enum Theme {
-    /** Standard cat images */
+    /** Standard cat images/videos */
     Default = "Default",
     /** Spring-themed cats with flowers and nature */
     Spring = "Spring",
@@ -33,23 +47,25 @@ declare enum Theme {
 }
 
 /**
- * Detailed information about a cat image
+ * Detailed information about a cat media
  */
 interface CatInfo {
-    /** Unique identifier for the cat image */
+    /** Unique identifier for the cat media */
     id: string;
-    /** URL to access the cat image */
+    /** URL to access the cat media */
     url: string;
-    /** Unix timestamp when the image was created */
+    /** Unix timestamp when the media was created */
     dateCreated: number;
-    /** The AI prompt used to generate this cat image */
+    /** The AI prompt used to generate this cat media */
     prompt: string;
-    /** The theme of the cat image */
+    /** The theme of the cat media */
     theme: Theme;
+    /** The type of media */
+    type: Type;
 }
 
 /**
- * Available image sizes for AI cat images
+ * Available media sizes for AI cat media
  */
 declare enum Size {
     /** 1024x1024 pixels (default, highest quality) */
@@ -68,16 +84,18 @@ declare enum Size {
     Micro = "16"
 }
 
-/** Response type for image requests */
+/** Response type for media requests */
 type ResponseType = 'blob' | 'arrayBuffer' | 'base64' | 'dataUrl';
-/** Image response based on responseType */
-type ImageResponse<T extends ResponseType = 'blob'> = T extends 'blob' ? Blob : T extends 'arrayBuffer' ? ArrayBuffer : T extends 'base64' ? string : T extends 'dataUrl' ? string : Blob;
+/** Media response based on responseType */
+type MediaResponse<T extends ResponseType = 'blob'> = T extends 'blob' ? Blob : T extends 'arrayBuffer' ? ArrayBuffer : T extends 'base64' ? string : T extends 'dataUrl' ? string : Blob;
 /** Options for getting a random cat */
 interface RandomCatOptions<T extends ResponseType = 'blob'> {
-    /** Image size (default: Large) */
+    /** Media size (default: Large) */
     size?: Size;
-    /** Theme of the cat image */
+    /** Theme of the cat media */
     theme?: Theme;
+    /** Filter by media type */
+    type?: Type;
     /** Response format (default: blob) */
     responseType?: T;
 }
@@ -93,33 +111,43 @@ interface SearchOptions {
     descending?: boolean;
     /** Filter by theme */
     theme?: Theme;
-    /** Image size in results */
+    /** Media size in results */
     size?: Size;
+    /** Filter by media type */
+    type?: Type;
 }
 /** Options for similar cats */
 interface SimilarOptions {
     /** Maximum number of results (1-100, default: 10) */
     limit?: number;
-    /** Image size in results */
+    /** Media size in results */
     size?: Size;
 }
 /** Options for getting a cat by ID */
 interface GetByIdOptions<T extends ResponseType = 'blob'> {
-    /** Image size (default: Large) */
+    /** Media size (default: Large) */
     size?: Size;
+    /** media type */
+    type?: Type;
     /** Response format (default: blob) */
     responseType?: T;
 }
+interface CountOptions {
+    /** Filter by theme */
+    theme?: Theme;
+    /** Filter by media type */
+    type?: Type;
+}
 
 declare const AiCats: {
-    random: <T extends ResponseType = "blob">(options?: RandomCatOptions<T>) => Promise<ImageResponse<T>>;
-    getById: <T extends ResponseType = "blob">(id: string, options?: GetByIdOptions<T>) => Promise<ImageResponse<T>>;
+    random: <T extends ResponseType = "blob">(options?: RandomCatOptions<T>) => Promise<MediaResponse<T>>;
+    getById: <T extends ResponseType = "blob">(id: string, options?: GetByIdOptions<T>) => Promise<MediaResponse<T>>;
     getInfo: (id: string) => Promise<CatInfo>;
     search: (options?: SearchOptions) => Promise<SearchResult[]>;
     getSimilar: (id: string, options?: SimilarOptions) => Promise<SearchResult[]>;
     getSearchCompletion: (options?: SearchOptions) => Promise<string>;
     getThemes: () => Promise<Theme[]>;
-    getCount: (theme?: Theme) => Promise<number>;
+    getCount: (options?: CountOptions) => Promise<number>;
 };
 
 export { AiCats, type CatInfo, type RandomCatOptions, type SearchOptions, type SearchResult, type SimilarOptions, Size, Theme };

package/dist/index.js

@@ -54,7 +54,7 @@ var Theme = /* @__PURE__ */ ((Theme2) => {
 
 // src/api/ai-cats-api.ts
 var ApiUrl = "https://api.ai-cats.net/v1";
-async function toResponseType(buffer, type = "blob") {
+async function toResponseType(buffer, mediaType = "Image" /* Image */, type = "blob") {
   switch (type) {
     case "arrayBuffer":
       return buffer;
@@ -72,34 +72,38 @@ async function toResponseType(buffer, type = "blob") {
       for (let i = 0; i < bytes.length; i++) {
         binary += String.fromCharCode(bytes[i]);
       }
-      return `data:image/jpeg;base64,${btoa(binary)}`;
+      const mimeType2 = mediaType === "Video" /* Video */ ? "video/mp4" : "image/jpeg";
+      return `data:${mimeType2};base64,${btoa(binary)}`;
     }
     case "blob":
     default:
-      return new Blob([buffer], { type: "image/jpeg" });
+      const mimeType = mediaType === "Video" /* Video */ ? "video/mp4" : "image/jpeg";
+      return new Blob([buffer], { type: mimeType });
   }
 }
 async function random(options) {
   const params = new URLSearchParams();
   if (options?.size) params.set("size", options.size);
   if (options?.theme) params.set("theme", options.theme);
+  if (options?.type) params.set("type", options.type);
   params.set("rnd", Math.random().toString());
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat${query}`);
   if (!response.ok) {
-    throw new Error(`Error fetching cat image: ${response.statusText}`);
+    throw new Error(`Error fetching cat media: ${response.statusText}`);
   }
   const buffer = await response.arrayBuffer();
-  return toResponseType(buffer, options?.responseType ?? "blob");
+  return toResponseType(buffer, options?.type, options?.responseType ?? "blob");
 }
 async function getById(id, options) {
   const size = options?.size ?? "1024" /* Large */;
-  const response = await fetch(`${ApiUrl}/cat/${id}.jpg?size=${size}`);
+  const suffix = options?.type === "Video" /* Video */ ? ".mp4" : ".jpg";
+  const response = await fetch(`${ApiUrl}/cat/${id}${suffix}?size=${size}`);
   if (!response.ok) {
-    throw new Error(`Error fetching cat image: ${response.statusText}`);
+    throw new Error(`Error fetching cat media: ${response.statusText}`);
   }
   const buffer = await response.arrayBuffer();
-  return toResponseType(buffer, options?.responseType ?? "blob");
+  return toResponseType(buffer, options?.type, options?.responseType ?? "blob");
 }
 async function getInfo(id) {
   const response = await fetch(`${ApiUrl}/cat/info/${id}`);
@@ -116,6 +120,7 @@ async function search(options = {}) {
   if (options.descending) params.set("descending", "true");
   if (options.theme) params.set("theme", options.theme);
   if (options.size) params.set("size", options.size);
+  if (options.type) params.set("type", options.type);
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat/search${query}`);
   if (!response.ok) {
@@ -142,6 +147,7 @@ async function getSearchCompletion(options = {}) {
   if (options.descending) params.set("descending", "true");
   if (options.theme) params.set("theme", options.theme);
   if (options.size) params.set("size", options.size);
+  if (options.type) params.set("type", options.type);
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat/search-completion${query}`);
   if (!response.ok) {
@@ -158,8 +164,12 @@ async function getThemes() {
   const data = await response.json();
   return data.themes;
 }
-async function getCount(theme) {
-  const response = await fetch(`${ApiUrl}/cat/count${theme ? `?theme=${theme}` : ""}`);
+async function getCount(options = {}) {
+  const params = new URLSearchParams();
+  if (options.theme) params.set("theme", options.theme);
+  if (options.type) params.set("type", options.type);
+  const query = params.toString() ? `?${params}` : "";
+  const response = await fetch(`${ApiUrl}/cat/count${query}`);
   if (!response.ok) {
     throw new Error(`Error fetching count: ${response.statusText}`);
   }

package/dist/index.mjs

@@ -26,7 +26,7 @@ var Theme = /* @__PURE__ */ ((Theme2) => {
 
 // src/api/ai-cats-api.ts
 var ApiUrl = "https://api.ai-cats.net/v1";
-async function toResponseType(buffer, type = "blob") {
+async function toResponseType(buffer, mediaType = "Image" /* Image */, type = "blob") {
   switch (type) {
     case "arrayBuffer":
       return buffer;
@@ -44,34 +44,38 @@ async function toResponseType(buffer, type = "blob") {
       for (let i = 0; i < bytes.length; i++) {
         binary += String.fromCharCode(bytes[i]);
       }
-      return `data:image/jpeg;base64,${btoa(binary)}`;
+      const mimeType2 = mediaType === "Video" /* Video */ ? "video/mp4" : "image/jpeg";
+      return `data:${mimeType2};base64,${btoa(binary)}`;
     }
     case "blob":
     default:
-      return new Blob([buffer], { type: "image/jpeg" });
+      const mimeType = mediaType === "Video" /* Video */ ? "video/mp4" : "image/jpeg";
+      return new Blob([buffer], { type: mimeType });
   }
 }
 async function random(options) {
   const params = new URLSearchParams();
   if (options?.size) params.set("size", options.size);
   if (options?.theme) params.set("theme", options.theme);
+  if (options?.type) params.set("type", options.type);
   params.set("rnd", Math.random().toString());
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat${query}`);
   if (!response.ok) {
-    throw new Error(`Error fetching cat image: ${response.statusText}`);
+    throw new Error(`Error fetching cat media: ${response.statusText}`);
   }
   const buffer = await response.arrayBuffer();
-  return toResponseType(buffer, options?.responseType ?? "blob");
+  return toResponseType(buffer, options?.type, options?.responseType ?? "blob");
 }
 async function getById(id, options) {
   const size = options?.size ?? "1024" /* Large */;
-  const response = await fetch(`${ApiUrl}/cat/${id}.jpg?size=${size}`);
+  const suffix = options?.type === "Video" /* Video */ ? ".mp4" : ".jpg";
+  const response = await fetch(`${ApiUrl}/cat/${id}${suffix}?size=${size}`);
   if (!response.ok) {
-    throw new Error(`Error fetching cat image: ${response.statusText}`);
+    throw new Error(`Error fetching cat media: ${response.statusText}`);
   }
   const buffer = await response.arrayBuffer();
-  return toResponseType(buffer, options?.responseType ?? "blob");
+  return toResponseType(buffer, options?.type, options?.responseType ?? "blob");
 }
 async function getInfo(id) {
   const response = await fetch(`${ApiUrl}/cat/info/${id}`);
@@ -88,6 +92,7 @@ async function search(options = {}) {
   if (options.descending) params.set("descending", "true");
   if (options.theme) params.set("theme", options.theme);
   if (options.size) params.set("size", options.size);
+  if (options.type) params.set("type", options.type);
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat/search${query}`);
   if (!response.ok) {
@@ -114,6 +119,7 @@ async function getSearchCompletion(options = {}) {
   if (options.descending) params.set("descending", "true");
   if (options.theme) params.set("theme", options.theme);
   if (options.size) params.set("size", options.size);
+  if (options.type) params.set("type", options.type);
   const query = params.toString() ? `?${params}` : "";
   const response = await fetch(`${ApiUrl}/cat/search-completion${query}`);
   if (!response.ok) {
@@ -130,8 +136,12 @@ async function getThemes() {
   const data = await response.json();
   return data.themes;
 }
-async function getCount(theme) {
-  const response = await fetch(`${ApiUrl}/cat/count${theme ? `?theme=${theme}` : ""}`);
+async function getCount(options = {}) {
+  const params = new URLSearchParams();
+  if (options.theme) params.set("theme", options.theme);
+  if (options.type) params.set("type", options.type);
+  const query = params.toString() ? `?${params}` : "";
+  const response = await fetch(`${ApiUrl}/cat/count${query}`);
   if (!response.ok) {
     throw new Error(`Error fetching count: ${response.statusText}`);
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aicats/sdk",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "Official JavaScript SDK for the ai-cats.net API",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -33,7 +33,8 @@
     "api",
     "sdk",
     "ai-cats",
-    "images"
+    "images",
+    "videos"
   ],
   "author": {
     "name": "Mario Bertsch",