DEV Community

/**
 * DEVCommunity - generated by OmniStream from DEV Community's OpenAPI spec.
 * One typed method per endpoint. A single Omni key reaches the API.
 */
const DEFAULT_BASE = "https://grid.skinvaults.online/v1/proxy/devto";

export class DEVCommunityError extends Error {
  status: number;
  code?: string;
  constructor(status: number, code: string | undefined, message?: string) {
    super(message || `DEVCommunity error ${status}`);
    this.name = "DEVCommunityError";
    this.status = status;
    this.code = code;
  }
}

export interface DEVCommunityOptions {
  baseUrl?: string;
  fetch?: typeof fetch;
  timeoutMs?: number;
}

export class DEVCommunity {
  /** @param token Your OmniStream key (one key for every API). */
  constructor(private token: string, private opts: DEVCommunityOptions = {}) {
    if (!token) throw new Error("DEVCommunity: token is required");
  }
  rateLimit: { remainingMinute?: number; remainingDay?: number } | null = null;

  private async _request(method: string, path: string, { params, body }: { params?: Record<string, unknown>; body?: unknown } = {}): Promise<any> {
    const f = this.opts.fetch ?? globalThis.fetch;
    const url = new URL((this.opts.baseUrl ?? DEFAULT_BASE).replace(/\/+$/, "") + path);
    if (params) for (const [k, v] of Object.entries(params)) if (v != null) url.searchParams.set(k, String(v));
    const headers: Record<string, string> = { "x-omni-key": this.token };
    if (body !== undefined) headers["content-type"] = "application/json";
    const res = await f(url, { method, headers, body: body !== undefined ? JSON.stringify(body) : undefined });
    this.rateLimit = {
      remainingMinute: Number(res.headers.get("x-ratelimit-remaining-minute")) || undefined,
      remainingDay: Number(res.headers.get("x-ratelimit-remaining-day")) || undefined,
    };
    const data = await res.json().catch(() => ({}));
    if (!res.ok) throw new DEVCommunityError(res.status, data?.error?.code, data?.error?.message);
    return data.data ?? data;
  }

  /** Published articles */
  getArticles(params: { "page"?: number; "per_page"?: number; "tag"?: string; "tags"?: string; "tags_exclude"?: string; "username"?: string; "state"?: string; "top"?: number; "collection_id"?: number }): Promise<any> {
    return this._request("GET", "/api/articles", { params });
  }

  /** Publish article */
  createArticle(body: unknown): Promise<any> {
    return this._request("POST", "/api/articles", { body });
  }

  /** Published articles sorted by published date */
  getLatestArticles(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/articles/latest", { params });
  }

  /** User's articles */
  getUserArticles(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/articles/me", { params });
  }

  /** User's all articles */
  getUserAllArticles(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/articles/me/all", { params });
  }

  /** User's published articles */
  getUserPublishedArticles(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/articles/me/published", { params });
  }

  /** User's unpublished articles */
  getUserUnpublishedArticles(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/articles/me/unpublished", { params });
  }

  /** Published article by id */
  getArticleById(params: { "id": number }): Promise<any> {
    return this._request("GET", "/api/articles/{id}", { params });
  }

  /** Update an article by id */
  updateArticle(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/articles/{id}", { body, params });
  }

  /** Unpublish an article */
  unpublishArticle(params: { "id": number; "note"?: string }): Promise<any> {
    return this._request("PUT", "/api/articles/{id}/unpublish", { params });
  }

  /** Published article by path */
  getArticleByPath(params: { "username": string; "slug": string }): Promise<any> {
    return this._request("GET", "/api/articles/{username}/{slug}", { params });
  }

  /** Comments */
  getCommentsByArticleId(params: { "a_id"?: string; "p_id"?: string }): Promise<any> {
    return this._request("GET", "/api/comments", { params });
  }

  /** Comment by id */
  getCommentById(params: { "id": number }): Promise<any> {
    return this._request("GET", "/api/comments/{id}", { params });
  }

  /** display ads */
  getapiDisplayAds(): Promise<any> {
    return this._request("GET", "/api/display_ads", {});
  }

  /** display ads */
  postapiDisplayAds(body: unknown): Promise<any> {
    return this._request("POST", "/api/display_ads", { body });
  }

  /** display ad */
  getapiDisplayAdsId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/api/display_ads/{id}", { params });
  }

  /** display ads */
  putapiDisplayAdsId(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/display_ads/{id}", { body, params });
  }

  /** unpublish */
  putapiDisplayAdsIdUnpublish(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/display_ads/{id}/unpublish", { params });
  }

  /** Followers */
  getFollowers(params: { "page"?: number; "per_page"?: number; "sort"?: string }): Promise<any> {
    return this._request("GET", "/api/followers/users", { params });
  }

  /** Followed Tags */
  getFollowedTags(): Promise<any> {
    return this._request("GET", "/api/follows/tags", {});
  }

  /** An organization */
  getOrganization(params: { "username": string }): Promise<any> {
    return this._request("GET", "/api/organizations/{username}", { params });
  }

  /** Organization's Articles */
  getOrgArticles(params: { "username": string; "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/organizations/{username}/articles", { params });
  }

  /** Organization's users */
  getOrgUsers(params: { "username": string; "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/organizations/{username}/users", { params });
  }

  /** show details for all pages */
  getapiPages(): Promise<any> {
    return this._request("GET", "/api/pages", {});
  }

  /** pages */
  postapiPages(body: unknown): Promise<any> {
    return this._request("POST", "/api/pages", { body });
  }

  /** show details for a page */
  getapiPagesId(params: { "id": number }): Promise<any> {
    return this._request("GET", "/api/pages/{id}", { params });
  }

  /** update details for a page */
  putapiPagesId(body: unknown, params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/pages/{id}", { body, params });
  }

  /** remove a page */
  deleteapiPagesId(params: { "id": number }): Promise<any> {
    return this._request("DELETE", "/api/pages/{id}", { params });
  }

  /** Podcast Episodes */
  getPodcastEpisodes(params: { "page"?: number; "per_page"?: number; "username"?: string }): Promise<any> {
    return this._request("GET", "/api/podcast_episodes", { params });
  }

  /** A Users or organizations profile image */
  getProfileImage(params: { "username": string }): Promise<any> {
    return this._request("GET", "/api/profile_images/{username}", { params });
  }

  /** create reaction */
  postapiReactions(params: { "category": string; "reactable_id": number; "reactable_type": string }): Promise<any> {
    return this._request("POST", "/api/reactions", { params });
  }

  /** toggle reaction */
  postapiReactionsToggle(params: { "category": string; "reactable_id": number; "reactable_type": string }): Promise<any> {
    return this._request("POST", "/api/reactions/toggle", { params });
  }

  /** Readinglist */
  getReadinglist(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/readinglist", { params });
  }

  /** Tags */
  getTags(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/tags", { params });
  }

  /** The authenticated user */
  getUserMe(): Promise<any> {
    return this._request("GET", "/api/users/me", {});
  }

  /** A User */
  getUser(params: { "id": string }): Promise<any> {
    return this._request("GET", "/api/users/{id}", { params });
  }

  /** Suspend a User */
  suspendUser(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/users/{id}/suspend", { params });
  }

  /** Unpublish a User's Articles and Comments */
  unpublishUser(params: { "id": number }): Promise<any> {
    return this._request("PUT", "/api/users/{id}/unpublish", { params });
  }

  /** Articles with a video */
  videos(params: { "page"?: number; "per_page"?: number }): Promise<any> {
    return this._request("GET", "/api/videos", { params });
  }
}

export default DEVCommunity;