Release v2.0.0 (#17)

* Remove non-project files from <.gitignore> * Remove the "official" word because it's useless * Fix docs * Migrate to Omni Chat Backend 0.23.0 * Add enums * Prep for release
neelkamath · Jul 5, 2021 · 435999e · 435999e
1 parent 2465e88
commit 435999e
Show file tree

Hide file tree

Showing 13 changed files with 65 additions and 30 deletions.
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -30,7 +30,7 @@ jobs:
         with:
           node-version: 14
       - run: npm i
-      - run: npm run doc
+      - run: npm run doc:build
       - uses: actions/upload-artifact@v2
         with:
           name: docs

diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,3 @@
-.idea/
 dist/
 docs/
 node_modules/
-.DS_Store
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres
 to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0](https://github.com/neelkamath/omni-chat-js/releases/tag/v2.0.0) - 2021-07-05
+
+### Added
+
+- `type GroupChatPublicity`
+- `class MustBeAdminError`
+
+### Changed
+
+- Throw `class InvalidPicError`, `class InvalidAudioError`, `class InvalidVideoError`, and `class InvalidDocError` when the media is 3 MiB instead of 5 MiB.
+- Limit `type Pic`, `type Audio`, `type Video`, and `type Doc` to 3 MiB instead of 5 MiB.
+- Throw a `class MustBeAdminError` instead of a `class UnauthorizedError` when `postPicMessage()`, `postAudioMessage()`, `postVideoMessage()`, and `postDocMessage()` fail because the user attempted to send a message in a broadcast chat they're not an admin of.
+
 ## [1.0.0](https://github.com/neelkamath/omni-chat-js/releases/tag/v1.0.0) - 2021-06-03
 
 ### Changed

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -21,7 +21,9 @@ If you're forking the repo to develop the project as your own instead of just to
 - Test: `npm t`
 - Check for lint issues: `npm run lint`
 - Check for, and fix lint issues: `npm run fix`
-- Generate docs to `docs/`: `npm run doc`
+- Generate docs to `docs/`:
+  - Production: `npm run doc:build`
+  - Development (watches for changes): `npm run doc:watch`
 
 ### Conventions
 

diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 [![npm (scoped)](https://img.shields.io/npm/v/@neelkamath/omni-chat)](https://www.npmjs.com/package/@neelkamath/omni-chat)
 
-Official [Omni Chat API](https://github.com/neelkamath/omni-chat-backend) JavaScript wrapper library.
+[Omni Chat API](https://github.com/neelkamath/omni-chat-backend) JavaScript wrapper library.
 
 - Platforms: Browsers supporting ES6 or higher
 - Module systems: ECMAScript Modules
@@ -13,13 +13,14 @@ Official [Omni Chat API](https://github.com/neelkamath/omni-chat-backend) JavaSc
 
 This table shows which versions of Omni Chat JS support which versions of Omni Chat Backend:
 
-|   Omni Chat JS   | Omni Chat Backend |
-| :--------------: | :---------------: |
-| 0.12.0 or higher | 0.19.0 or higher  |
-|      0.11.0      |      0.18.0       |
-|  0.8.0 - 0.10.0  |      0.17.0       |
-|  0.5.0 - 0.7.0   |      0.16.0       |
-|  0.1.0 - 0.4.0   |      0.15.0       |
+|  Omni Chat JS   | Omni Chat Backend |
+| :-------------: | :---------------: |
+| 2.0.0 or higher | 0.23.0 or higher  |
+| 0.12.0 - 1.0.0  |  0.19.0 - 0.22.0  |
+|     0.11.0      |      0.18.0       |
+| 0.8.0 - 0.10.0  |      0.17.0       |
+|  0.5.0 - 0.7.0  |      0.16.0       |
+|  0.1.0 - 0.4.0  |      0.15.0       |
 
 ```
 npm i @neelkamath/omni-chat

diff --git a/package.json b/package.json
@@ -1,10 +1,12 @@
 {
   "name": "@neelkamath/omni-chat",
-  "version": "1.0.0",
-  "description": "Official Omni Chat API wrapper library",
+  "version": "2.0.0",
+  "description": "Omni Chat API wrapper library",
   "scripts": {
     "test": "jest",
     "doc": "typedoc src/index.ts --includeVersion --readme none",
+    "doc:build": "npm run doc",
+    "doc:watch": "npm run doc -- --watch",
     "prepare": "tsc",
     "lint": "eslint . && prettier -c . && tsc --noEmit",
     "fix": "eslint --fix . && prettier -w . && tsc --noEmit"

diff --git a/src/graphql-api/enums.ts b/src/graphql-api/enums.ts
@@ -0,0 +1,9 @@
+/**
+ * - `'NOT_INVITABLE'`: Users cannot join the chat via an invite code.
+ * - `'INVITABLE'`: Users can join the chat via an invite code.
+ * - `'PUBLIC'`: People can search for, and view public chats without an account. Invite codes are permanently turned on.
+ * Anyone with an account can join a public chat. A frontend UI may allow for a search engine to index the chat should
+ * the administrator allow for it. A chat must be made public when it's being created because chats can't switch between
+ * being public after they've been created.
+ */
+export type GroupChatPublicity = 'NOT_INVITABLE' | 'INVITABLE' | 'PUBLIC';
diff --git a/src/graphql-api/index.ts b/src/graphql-api/index.ts
@@ -1,2 +1,3 @@
 export * from './operator';
 export * from './scalars';
+export * from './enums';
diff --git a/src/index.ts b/src/index.ts
@@ -1,5 +1,5 @@
 /**
- * Official [Omni Chat API](https://github.com/neelkamath/omni-chat-backend) JavaScript wrapper library.
+ * [Omni Chat API](https://github.com/neelkamath/omni-chat-backend) JavaScript wrapper library.
  *
  * The Omni Chat API consists of a REST API, and a GraphQL API.
  *

diff --git a/src/rest-api/errors.ts b/src/rest-api/errors.ts
@@ -1,13 +1,13 @@
-/** Pic wasn't a PNG or JPEG not exceeding 5 MiB. */
+/** Pic wasn't a PNG or JPEG not exceeding 3 MiB. */
 export class InvalidPicError extends Error {}
 
-/** Audio wasn't an MP3/MP4 not exceeding 5 MiB. */
+/** Audio wasn't an MP3/MP4 not exceeding 3 MiB. */
 export class InvalidAudioError extends Error {}
 
-/** Video wasn't an MP4 not exceeding 5 MiB. */
+/** Video wasn't an MP4 not exceeding 3 MiB. */
 export class InvalidVideoError extends Error {}
 
-/** Doc exceeded 5 MiB. */
+/** Doc exceeded 3 MiB. */
 export class InvalidDocError extends Error {}
 
 export class NonexistentUserIdError extends Error {}
@@ -19,3 +19,6 @@ export class UserNotInChatError extends Error {}
 export class InvalidContextMessageError extends Error {}
 
 export class MessageTextScalarError extends Error {}
+
+/** The user attempted to create a message in a broadcast chat but was disallowed because they're not an admin. */
+export class MustBeAdminError extends Error {}
diff --git a/src/rest-api/models.ts b/src/rest-api/models.ts
@@ -1,6 +1,6 @@
 export type PicType = 'ORIGINAL' | 'THUMBNAIL';
 
-/** A PNG or JPEG image not exceeding 5 MiB. */
+/** A PNG or JPEG image not exceeding 3 MiB. */
 export type Pic = Blob;
 
 /**
@@ -9,11 +9,11 @@ export type Pic = Blob;
  */
 export type ContextMessageId = number;
 
-/** An MP3/MP4 audio not exceeding 5 MiB. */
+/** An MP3/MP4 audio not exceeding 3 MiB. */
 export type Audio = Blob;
 
-/** An MP4 video not exceeding 5 MiB. */
+/** An MP4 video not exceeding 3 MiB. */
 export type Video = Blob;
 
-/** A doc not exceeding 5 MiB. */
+/** A doc not exceeding 3 MiB. */
 export type Doc = Blob;
diff --git a/src/rest-api/operations.ts b/src/rest-api/operations.ts
@@ -3,6 +3,7 @@ import {
   InvalidContextMessageError,
   InvalidPicError,
   MessageTextScalarError,
+  MustBeAdminError,
   NonexistentChatError,
   NonexistentUserIdError,
   UserNotInChatError,
@@ -13,7 +14,7 @@ import { HttpApiConfig } from '../config';
 import { MessageText } from '../graphql-api';
 
 /**
- * @return `Blob` if the user has a profile pic, and `null` if they don't.
+ * @return {Pic | null} if the user has a profile pic, and `null` if they don't.
  * @throws {@link NonexistentUserIdError}
  * @throws {@link ConnectionError}
  * @throws {@link InternalServerError}
@@ -76,7 +77,7 @@ export async function patchProfilePic(
 /**
  * Retrieves the group chat's pic. An access token needn't be sent if the chat is public. Otherwise, the user must be
  * a participant to view the pic.
- * @return `Pic` if the chat has a pic, and `null` otherwise.
+ * @return {Pic | null} if the chat has a pic, and `null` otherwise.
  * @throws {@link NonexistentChatError}
  * @throws {@link ConnectionError}
  * @throws {@link InternalServerError}
@@ -161,7 +162,7 @@ export async function getPicMessage(
 
 /**
  *
- * Creates a pic message. If the chat is a broadcast group, the user must be an admin.
+ * Creates a pic message.
  * @throws {@link UserNotInChatError}
  * @throws {@link InvalidPicError}
  * @throws {@link InvalidContextMessageError}
@@ -203,6 +204,8 @@ export async function postPicMessage(
           throw new InvalidContextMessageError();
         case 'INVALID_CAPTION':
           throw new MessageTextScalarError();
+        case 'MUST_BE_ADMIN':
+          throw new MustBeAdminError();
       }
       break;
     }
@@ -228,7 +231,7 @@ export async function getAudioMessage(
 }
 
 /**
- * Creates an audio message. If the chat is a broadcast group, the user must be an admin.
+ * Creates an audio message.
  * @throws {@link InternalServerError}
  * @throws {@link UserNotInChatError}
  * @throws {@link InvalidAudioError}
@@ -261,7 +264,7 @@ export async function getVideoMessage(
 }
 
 /**
- * Creates a video message. If the chat is a broadcast group, the user must be an admin.
+ * Creates a video message.
  * @throws {@link InternalServerError}
  * @throws {@link UserNotInChatError}
  * @throws {@link InvalidVideoError}
@@ -294,7 +297,7 @@ export async function getDocMessage(
 }
 
 /**
- * Creates a doc message. If the chat is a broadcast group, the user must be an admin.
+ * Creates a doc message.
  * @throws {@link InternalServerError}
  * @throws {@link UserNotInChatError}
  * @throws {@link InvalidDocError}

diff --git a/src/rest-api/operator.ts b/src/rest-api/operator.ts
@@ -5,6 +5,7 @@ import {
   InvalidContextMessageError,
   InvalidDocError,
   InvalidVideoError,
+  MustBeAdminError,
   UserNotInChatError,
 } from './errors';
 import { HttpApiConfig } from '../config';
@@ -86,7 +87,7 @@ export async function postMediaMessage(
 }
 
 interface InvalidMessage {
-  readonly reason: 'USER_NOT_IN_CHAT' | 'INVALID_FILE' | 'INVALID_CONTEXT_MESSAGE';
+  readonly reason: 'USER_NOT_IN_CHAT' | 'INVALID_FILE' | 'INVALID_CONTEXT_MESSAGE' | 'MUST_BE_ADMIN';
 }
 
 function readInvalidMessageError(message: InvalidMessage, type: MediaType): Error {
@@ -95,6 +96,8 @@ function readInvalidMessageError(message: InvalidMessage, type: MediaType): Erro
       return new UserNotInChatError();
     case 'INVALID_CONTEXT_MESSAGE':
       return new InvalidContextMessageError();
+    case 'MUST_BE_ADMIN':
+      return new MustBeAdminError();
     case 'INVALID_FILE':
       switch (type) {
         case 'audio':