@komikhq/komikhq-typescript

v1.1.0

Published

11 days ago

The KomikHQ platform API. Request and response contracts are defined alongside their route handlers.

0High
0Medium
0Low

dyzulk

@komikhq/[email protected]

A TypeScript SDK client for the api.komikhq.com API.

Usage

First, install the SDK from npm.

npm install @komikhq/komikhq-typescript --save

Next, try it out.

import {
  Configuration,
  AdministrationApi,
} from '@komikhq/komikhq-typescript';
import type { AdminCreateChapterRequest } from '@komikhq/komikhq-typescript';

async function example() {
  console.log("🚀 Testing @komikhq/komikhq-typescript SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: SessionCookie
    apiKey: "YOUR API KEY",
    // Configure HTTP bearer authorization: BearerToken
    accessToken: "YOUR BEARER TOKEN",
  });
  const api = new AdministrationApi(config);

  const body = {
    // string
    comicId: 'comicId_example',
    // string
    chapterNumber: 'chapterNumber_example',
    // Array<Blob>
    pages: [new Blob(['example file content'], { type: 'application/octet-stream' })],
    // string (optional)
    title: 'title_example',
    // string (optional)
    accessTier: 'accessTier_example',
    // boolean (optional)
    isEarlyAccess: true,
  } satisfies AdminCreateChapterRequest;

  try {
    const data = await api.adminCreateChapter(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.komikhq.com

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- AdministrationApi | adminCreateChapter | POST /v1/admin/comics/{comicId}/chapters | Create a chapter with pages AdministrationApi | adminCreateComic | POST /v1/admin/comics | Create a comic AdministrationApi | adminCreateGenre | POST /v1/admin/genres | Create a genre AdministrationApi | adminCreateUser | POST /v1/admin/users | Create a user AdministrationApi | adminDeleteChapter | DELETE /v1/admin/comics/{comicId}/chapters/{id} | Delete a chapter AdministrationApi | adminDeleteComic | DELETE /v1/admin/comics/{id} | Delete a comic AdministrationApi | adminDeleteGenre | DELETE /v1/admin/genres/{id} | Delete a genre AdministrationApi | adminDeleteUser | DELETE /v1/admin/users/{id} | Delete a user AdministrationApi | adminFinalizeChapter | POST /v1/admin/comics/{comicId}/chapters/{id}/finalize | Finalize a chapter AdministrationApi | adminGetChapter | GET /v1/admin/comics/{comicId}/chapters/{id} | Get chapter details AdministrationApi | adminGetComic | GET /v1/admin/comics/{id} | Get comic details AdministrationApi | adminGetPlatformStats | GET /v1/admin/stats | Get platform statistics AdministrationApi | adminInitializeChapter | POST /v1/admin/comics/{comicId}/chapters/init | Initialize a chapter upload AdministrationApi | adminListChapters | GET /v1/admin/comics/{comicId}/chapters | List comic chapters AdministrationApi | adminListComics | GET /v1/admin/comics | List comics AdministrationApi | adminListGenres | GET /v1/admin/genres | List all genres AdministrationApi | adminListUsers | GET /v1/admin/users | List users AdministrationApi | adminUpdateChapter | PUT /v1/admin/comics/{comicId}/chapters/{id} | Update chapter metadata AdministrationApi | adminUpdateComic | PUT /v1/admin/comics/{id} | Update a comic AdministrationApi | adminUpdateGenre | PUT /v1/admin/genres/{id} | Update a genre AdministrationApi | adminUpdateUser | PUT /v1/admin/users/{id} | Update a user AdministrationApi | adminUploadChapterPage | POST /v1/admin/comics/{comicId}/chapters/{id}/pages/upload | Upload a chapter page AdministrationApi | clearSearchSuggestionCache | POST /v1/admin/system/clear-search-cache | Clear the search suggestion cache AdministrationApi | getSystemMaintenanceStatus | GET /v1/admin/system/maintenance-status | Get system maintenance status AdministrationApi | purgeOrphanedStorageFiles | POST /v1/admin/storage/purge-orphans | Purge orphaned storage files AdministrationApi | synchronizeViewCounts | POST /v1/admin/system/sync-views | Synchronize view counts AuthenticationApi | getAuthSession | GET /v1/auth/get-session | Get the current authentication session AuthenticationApi | requestPasswordReset | POST /v1/auth/forget-password | Request a password reset AuthenticationApi | resetPassword | POST /v1/auth/reset-password | Reset a password AuthenticationApi | signInWithEmail | POST /v1/auth/sign-in/email | Sign in with email and password AuthenticationApi | signInWithSocialProvider | POST /v1/auth/sign-in/social | Start social sign-in AuthenticationApi | signOut | POST /v1/auth/sign-out | Sign out AuthenticationApi | signUpWithEmail | POST /v1/auth/sign-up/email | Create an account with email and password AuthenticationApi | verifyEmail | GET /v1/auth/verify-email | Verify an email address BookmarksApi | listBookmarks | GET /v1/bookmarks | List the current user's bookmarks BookmarksApi | removeBookmark | DELETE /v1/bookmarks/{comicId} | Remove a bookmark BookmarksApi | saveBookmark | POST /v1/bookmarks | Create or update a bookmark ChaptersApi | getPublicChapter | GET /v1/comics/{slug}/chapters/{chapterSlug} | Get a public comic chapter ComicsApi | browseComics | GET /v1/comics/browse | Browse and search comics ComicsApi | getComicBySlug | GET /v1/comics/{slug} | Get a comic by slug ComicsApi | listComics | GET /v1/comics | List comics ComicsApi | listTrendingComics | GET /v1/comics/trending | List trending comics CommentsApi | createComment | POST /v1/comments | Post a comment CommentsApi | deleteComment | DELETE /v1/comments/{commentId} | Delete a comment CommentsApi | listComments | GET /v1/comments | List comments CommentsApi | reportComment | POST /v1/comments/{commentId}/report | Report a comment CommentsApi | toggleCommentLike | POST /v1/comments/{commentId}/like | Toggle a comment like GenresApi | listGenres | GET /v1/genres | List comic genres HealthApi | getHealth | GET /health | Check API health ModerationApi | adminListModerationReports | GET /v1/admin/reports | List moderation reports ModerationApi | adminResolveModerationReport | POST /v1/admin/reports/{id}/action | Resolve a moderation report RatingsApi | submitComicRating | POST /v1/ratings | Submit a comic rating ReadingHistoryApi | listReadingHistory | GET /v1/history | List the current user's reading history ReadingHistoryApi | recordReadingProgress | POST /v1/history | Record reading progress RealtimeApi | authorizeRealtimeChannel | POST /v1/realtime/auth | Authorize a realtime channel RealtimeApi | connectRealtimeWebSocket | GET /v1/realtime/ws | Connect to a realtime WebSocket SearchApi | getComicSearchSuggestions | GET /v1/search/suggestions | Get comic search suggestions SitemapsApi | getChaptersXmlSitemap | GET /sitemap-chapters.xml | Get the chapters XML sitemap SitemapsApi | getComicsXmlSitemap | GET /sitemap-comics.xml | Get the comics XML sitemap SitemapsApi | getSitemapSummary | GET /v1/sitemaps/summary | Get sitemap update summary SitemapsApi | listSitemapChapters | GET /v1/sitemaps/chapters | List chapters for sitemap generation SitemapsApi | listSitemapComics | GET /v1/sitemaps/comics | List comics for sitemap generation UsersApi | deleteUserAccount | DELETE /v1/user/profile | Delete the current user's account UsersApi | getUserProfile | GET /v1/user/profile | Get the current user's profile UsersApi | uploadUserAvatar | POST /v1/user/avatar | Upload a profile avatar ViewsApi | recordComicView | POST /v1/view | Record a comic or chapter view

Models

Authorization

Authentication schemes defined for the API:

SessionCookie

Type: API key
API key parameter name: komikhq.session_token
Location:

BearerToken

Type: HTTP Bearer Token authentication

About

This TypeScript SDK client supports the Fetch API.

Maintained by the KomikHQ Platform Team.

API version: 1.0.0
Package version: 1.1.0

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme