ExpressKit JS SDK

ExpressKit JS is a client SDK for interacting with my express-kit backend starter kit

Installation

To install ExpressKit JS, you can use npm or yarn:

1npm install express-kit-js

or

1yarn add express-kit-js

Usage

First, import the ExpressKit class and create an instance with your backend's base URL:

1import ExpressKit from 'express-kit-js';
2
3const kit = new ExpressKit('https://your-backend-url.com');

Orrr, you can even create an expendable class to add new functions to it:

1import ExpressKit from 'express-kit-js;
2
3class ExpendableKit extends ExpressKit {
4  async requestSomthingFromFiles() {
5    try {
6      return await this.request("GET", "/files?id=asdfarwe32");
7    } catch (err){
8      throw err;
9    }
10  }
11}
12
13const kit = new ExpendableKit("https://your-backend-url.com");
14

Authentication Functions

signInUser(userCredentials: UserCredentionals): Promise<string>

Signs in a user with the given credentials.

1await kit.signInUser({ email: 'user@example.com', password: 'password' });

signOut(): Promise<string>

Signs out the current user.

1await kit.signOut();

requestEmailVerfication(email: string): Promise<string>

Requests email verification for the given email.

1const message = await kit.requestEmailVerfication('user@example.com');

requestPasswordReset(email: string): Promise<string>

Requests a password reset for the given email.

1const message = await kit.requestPasswordReset('user@example.com');

resetPassword(info: PasswordResetCreds): Promise<string>

Resets the password with the given credentials.

1const message = await kit.resetPassword({ currentPassword: 'oldPassword', newPassword: 'newPassword' });

File System Functions

getUploadedFiles(): Promise<KitFile[]>

Gets a list of uploaded files.

1const files = await kit.getUploadedFiles();

getUploadedFile(id: string): Promise<Buffer>

Gets an uploaded file by its ID.

1const file = await kit.getUploadedFile('fileId');

uploadFile(file: File): Promise<string>

Uploads a file.

1const message = await kit.uploadFile(file);

updateFileUsingFile(id: string, file: File): Promise<string>

Updates an existing file with a new file.

1const message = await kit.updateFileUsingFile('fileId', file);

deleteFile(id: string): Promise<string>

Deletes a file by its ID.

1const message = await kit.deleteFile('fileId');

User Functions

getAllUsers(): Promise<User[]>

Gets a list of all users.

1const users = await kit.getAllUsers();

getCurrentUser(): Promise<User>

Gets the current user.

1const user = await kit.getCurrentUser();

updateCurrentUser(data: any): Promise<User>

Updates the current user with the given data.

1const updatedUser = await kit.updateCurrentUser({ displayName: 'New Name' });

createNewUser(user: User): Promise<User>

Creates a new user with the given data.

1const newUser = await kit.createNewUser({ email: 'newuser@example.com', passwordHash: 'hashedPassword' });

getUser(id: string): Promise<User>

Gets a user by their ID.

1const user = await kit.getUser('userId');

updateUser(id: string, data: any): Promise<User>

Updates a user with the given ID and data.

1const updatedUser = await kit.updateUser('userId', { displayName: 'Updated Name' });

deleteUser(id: string): Promise<string>

Deletes a user by their ID.

1const message = await kit.deleteUser('userId');

General Request Function

request(method: string, url: string, options?: AxiosRequestConfig): Promise<AxiosResponse>

Makes a general request with the given method, URL, and options.

1const response = await kit.request('GET', '/custom-endpoint');

Types

User

1export interface User {
2  email: string;
3  displayName?: string;
4  passwordHash?: string;
5  isVerified?: boolean;
6  id?: string;
7}

UserCredentionals

1export interface UserCredentionals {
2  email: string;
3  password: string;
4}

PasswordResetCreds

1export interface PasswordResetCreds {
2  currentPassword: string;
3  newPassword: string;
4}

KitFile

1export interface KitFile {
2  filename: string;
3  ContentType: string;
4  size: number;
5  id: string;
6}

Conclusion

This documentation covers the basic usage and functionality of the ExpressKit JS SDK. For more detailed information, refer to the backend source coude