hischool.js 0.0.1

package/lib/esm/permissions/definitions.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Permission against User
+ */
+export declare const UserPermission: {
+    Access: number;
+    ViewProfile: number;
+    SendMessage: number;
+    Invite: number;
+};
+/**
+ * Permission against Server / Channel
+ */
+export declare const Permission: {
+    ManageChannel: number;
+    ManageServer: number;
+    ManagePermissions: number;
+    ManageRole: number;
+    ManageCustomisation: number;
+    KickMembers: number;
+    BanMembers: number;
+    TimeoutMembers: number;
+    AssignRoles: number;
+    ChangeNickname: number;
+    ManageNicknames: number;
+    ChangeAvatar: number;
+    RemoveAvatars: number;
+    ViewChannel: number;
+    ReadMessageHistory: number;
+    SendMessage: number;
+    ManageMessages: number;
+    ManageWebhooks: number;
+    InviteOthers: number;
+    SendEmbeds: number;
+    UploadFiles: number;
+    Masquerade: number;
+    React: number;
+    Connect: number;
+    Speak: number;
+    Video: number;
+    MuteMembers: number;
+    DeafenMembers: number;
+    MoveMembers: number;
+    GrantAllSafe: number;
+};
+/**
+ * Maximum safe value
+ */
+export declare const U32_MAX: number;
+/**
+ * Permissions allowed for a user while in timeout
+ */
+export declare const ALLOW_IN_TIMEOUT: number;
+/**
+ * Default permissions if we can only view
+ */
+export declare const DEFAULT_PERMISSION_VIEW_ONLY: number;
+/**
+ * Default base permissions for channels
+ */
+export declare const DEFAULT_PERMISSION: number;
+/**
+ * Permissions in saved messages channel
+ */
+export declare const DEFAULT_PERMISSION_SAVED_MESSAGES: number;
+/**
+ * Permissions in direct message channels / default permissions for group DMs
+ */
+export declare const DEFAULT_PERMISSION_DIRECT_MESSAGE: number;
+/**
+ * Permissions in server text / voice channel
+ */
+export declare const DEFAULT_PERMISSION_SERVER: number;
+//# sourceMappingURL=definitions.d.ts.map

package/lib/esm/permissions/definitions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"definitions.d.ts","sourceRoot":"","sources":["../../../src/permissions/definitions.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,cAAc;;;;;CAK1B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA8EtB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,OAAO,QAAc,CAAC;AAEnC;;GAEG;AACH,eAAO,MAAM,gBAAgB,QAC2B,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,4BAA4B,QACe,CAAC;AAEzD;;GAEG;AACH,eAAO,MAAM,kBAAkB,QAOb,CAAC;AAEnB;;GAEG;AACH,eAAO,MAAM,iCAAiC,QAA0B,CAAC;AAEzE;;GAEG;AACH,eAAO,MAAM,iCAAiC,QACoB,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,yBAAyB,QAIb,CAAC"}

package/lib/esm/permissions/definitions.js

@@ -0,0 +1,121 @@
+/**
+ * Permission against User
+ */
+export const UserPermission = {
+    Access: 1 << 0,
+    ViewProfile: 1 << 1,
+    SendMessage: 1 << 2,
+    Invite: 1 << 3,
+};
+/**
+ * Permission against Server / Channel
+ */
+export const Permission = {
+    // * Generic permissions
+    /// Manage the channel or channels on the server
+    ManageChannel: 2 ** 0,
+    /// Manage the server
+    ManageServer: 2 ** 1,
+    /// Manage permissions on servers or channels
+    ManagePermissions: 2 ** 2,
+    /// Manage roles on server
+    ManageRole: 2 ** 3,
+    /// Manage server customisation (includes emoji)
+    ManageCustomisation: 2 ** 4,
+    // % 1 bits reserved
+    // * Member permissions
+    /// Kick other members below their ranking
+    KickMembers: 2 ** 6,
+    /// Ban other members below their ranking
+    BanMembers: 2 ** 7,
+    /// Timeout other members below their ranking
+    TimeoutMembers: 2 ** 8,
+    /// Assign roles to members below their ranking
+    AssignRoles: 2 ** 9,
+    /// Change own nickname
+    ChangeNickname: 2 ** 10,
+    /// Change or remove other's nicknames below their ranking
+    ManageNicknames: 2 ** 11,
+    /// Change own avatar
+    ChangeAvatar: 2 ** 12,
+    /// Remove other's avatars below their ranking
+    RemoveAvatars: 2 ** 13,
+    // % 7 bits reserved
+    // * Channel permissions
+    /// View a channel
+    ViewChannel: 2 ** 20,
+    /// Read a channel's past message history
+    ReadMessageHistory: 2 ** 21,
+    /// Send a message in a channel
+    SendMessage: 2 ** 22,
+    /// Delete messages in a channel
+    ManageMessages: 2 ** 23,
+    /// Manage webhook entries on a channel
+    ManageWebhooks: 2 ** 24,
+    /// Create invites to this channel
+    InviteOthers: 2 ** 25,
+    /// Send embedded content in this channel
+    SendEmbeds: 2 ** 26,
+    /// Send attachments and media in this channel
+    UploadFiles: 2 ** 27,
+    /// Masquerade messages using custom nickname and avatar
+    Masquerade: 2 ** 28,
+    /// React to messages with emoji
+    React: 2 ** 29,
+    // * Voice permissions
+    /// Connect to a voice channel
+    Connect: 2 ** 30,
+    /// Speak in a voice call
+    Speak: 2 ** 31,
+    /// Share video in a voice call
+    Video: 2 ** 32,
+    /// Mute other members with lower ranking in a voice call
+    MuteMembers: 2 ** 33,
+    /// Deafen other members with lower ranking in a voice call
+    DeafenMembers: 2 ** 34,
+    /// Move members between voice channels
+    MoveMembers: 2 ** 35,
+    // * Misc. permissions
+    // % Bits 36 to 52: free area
+    // % Bits 53 to 64: do not use
+    // * Grant all permissions
+    /// Safely grant all permissions
+    GrantAllSafe: 0x000f_ffff_ffff_ffff,
+};
+/**
+ * Maximum safe value
+ */
+export const U32_MAX = 2 ** 32 - 1; // 4294967295
+/**
+ * Permissions allowed for a user while in timeout
+ */
+export const ALLOW_IN_TIMEOUT = Permission.ViewChannel + Permission.ReadMessageHistory;
+/**
+ * Default permissions if we can only view
+ */
+export const DEFAULT_PERMISSION_VIEW_ONLY = Permission.ViewChannel + Permission.ReadMessageHistory;
+/**
+ * Default base permissions for channels
+ */
+export const DEFAULT_PERMISSION = DEFAULT_PERMISSION_VIEW_ONLY +
+    Permission.SendMessage +
+    Permission.InviteOthers +
+    Permission.SendEmbeds +
+    Permission.UploadFiles +
+    Permission.Connect +
+    Permission.Speak;
+/**
+ * Permissions in saved messages channel
+ */
+export const DEFAULT_PERMISSION_SAVED_MESSAGES = Permission.GrantAllSafe;
+/**
+ * Permissions in direct message channels / default permissions for group DMs
+ */
+export const DEFAULT_PERMISSION_DIRECT_MESSAGE = DEFAULT_PERMISSION + Permission.React + Permission.ManageChannel;
+/**
+ * Permissions in server text / voice channel
+ */
+export const DEFAULT_PERMISSION_SERVER = DEFAULT_PERMISSION +
+    Permission.React +
+    Permission.ChangeNickname +
+    Permission.ChangeAvatar;

package/lib/esm/storage/ObjectStorage.d.ts

@@ -0,0 +1,28 @@
+import { Hydrators } from "../hydration";
+import { SetStoreFunction } from "solid-js/store";
+/**
+ * Wrapper around Solid.js store
+ */
+export declare class ObjectStorage<T> {
+    private store;
+    readonly set: SetStoreFunction<Record<string, T>>;
+    /**
+     * Create new object storage
+     */
+    constructor();
+    /**
+     * Get object by ID
+     * @param id ID
+     * @returns Object
+     */
+    get(id: string): T;
+    /**
+     * Hydrate some data into storage
+     * @param id ID
+     * @param type Hydration type
+     * @param context Context
+     * @param data Input Data
+     */
+    hydrate(id: string, type: keyof Hydrators, context: unknown, data?: unknown): void;
+}
+//# sourceMappingURL=ObjectStorage.d.ts.map

package/lib/esm/storage/ObjectStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ObjectStorage.d.ts","sourceRoot":"","sources":["../../../src/storage/ObjectStorage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAW,MAAM,cAAc,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAe,MAAM,gBAAgB,CAAC;AAE/D;;GAEG;AACH,qBAAa,aAAa,CAAC,CAAC;IAC1B,OAAO,CAAC,KAAK,CAAoB;IACjC,QAAQ,CAAC,GAAG,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IAElD;;OAEG;;IAQH;;;;OAIG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM;IAId;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,EAAE,OAAO;CAM5E"}

package/lib/esm/storage/ObjectStorage.js

@@ -0,0 +1,39 @@
+import { hydrate } from "../hydration";
+import { createStore } from "solid-js/store";
+/**
+ * Wrapper around Solid.js store
+ */
+export class ObjectStorage {
+    store;
+    set;
+    /**
+     * Create new object storage
+     */
+    constructor() {
+        const [store, setStore] = createStore({});
+        this.store = store;
+        this.set = setStore;
+        this.get = this.get.bind(this);
+    }
+    /**
+     * Get object by ID
+     * @param id ID
+     * @returns Object
+     */
+    get(id) {
+        return this.store[id];
+    }
+    /**
+     * Hydrate some data into storage
+     * @param id ID
+     * @param type Hydration type
+     * @param context Context
+     * @param data Input Data
+     */
+    hydrate(id, type, context, data) {
+        if (data) {
+            data = { partial: false, ...data };
+            this.set(id, hydrate(type, data, context, true));
+        }
+    }
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "hischool.js",
+  "version": "0.0.1",
+  "description": "JavaScript (TypeScript) SDK for interacting with Hischool.",
+  "main": "lib/cjs/index.js",
+  "module": "lib/esm/index.js",
+  "types": "lib/esm/index.d.ts",
+  "author": "Bayaraa Basan <bayaraa@hischool.mn>",
+  "homepage": "https://developer.hischool.mn/sdk",
+  "repository": "https://github.com/hischoolmn/hischool.js",
+  "scripts": {
+    "build": "yarn build:esm && yarn build:cjs",
+    "build:esm": "tsc && cp package-esm.json lib/esm/package.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:watch": "tsc-watch --onSuccess \"node .\"",
+    "lint": "eslint --ext .ts,.tsx src/",
+    "lint:fix": "eslint --fix --ext .ts,.tsx src/",
+    "typecheck": "tsc --noEmit",
+    "docs": "typedoc --plugin @mxssfd/typedoc-theme --theme my-theme --readme README.md src/",
+    "fmt": "prettier --write 'src/**/*.{js,jsx,ts,tsx}'",
+    "fmt:check": "prettier --check 'src/**/*.{js,jsx,ts,tsx}'"
+  },
+  "files": [
+    "README.md",
+    "lib"
+  ],
+  "dependencies": {
+    "@solid-primitives/map": "^0.4.11",
+    "@solid-primitives/set": "^0.4.11",
+    "axios": "^0.26.1",
+    "eventemitter3": "^5.0.1",
+    "isomorphic-ws": "^5.0.0",
+    "lodash.defaultsdeep": "^4.6.1",
+    "long": "^5.2.3",
+    "solid-js": "^1.8.15",
+    "ulid": "^2.3.0",
+    "ws": "^8.16.0"
+  },
+  "devDependencies": {
+    "@mxssfd/typedoc-theme": "^1.1.3",
+    "@trivago/prettier-plugin-sort-imports": "^4.3.0",
+    "@types/lodash.defaultsdeep": "^4.6.6",
+    "@types/node": "^18.19.24",
+    "@types/ws": "^8.5.10",
+    "@typescript-eslint/eslint-plugin": "^5.62.0",
+    "@typescript-eslint/parser": "^5.62.0",
+    "dotenv": "^16.4.5",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^8.10.0",
+    "eslint-plugin-solid": "^0.12.1",
+    "eslint-plugin-spellcheck": "^0.0.20",
+    "in-publish": "^2.0.1",
+    "prettier": "^2.8.8",
+    "tsc-watch": "^6.0.4",
+    "typed-emitter": "^2.1.0",
+    "typedoc": "^0.25.1",
+    "typescript": "5.4.2"
+  }
+}