twk-ts (allow typescript / javascript developers Interacting with Tawakkalna’s Endpoint)

Features

• Simplicity
• Chained method
• Zero dependencies
• Parallel Execution
• Tiny size

Installation

npm install tawakkalna-api

Quickstart

import twk from "tawakkalna-api";
twk
  .requestUserId() //Fetch the user's ID.
  .requestUserFullName() //Fetch the user's full name.
  .requestUserMobileNumber() //Fetch the user's mobile number.
  .requestGenerateToken() //Fetch a token for authentication purposes.
  .sendAll() //execute all queued requests concurrently.
  .then((user) => user) //handles the successful response after extracted the user information from the returned data.
  .catch((e) => {
    throw new Error(e);
  });

Here's a breakdown

TawakkalnaApi

The TawakkalnaApi is a wrapper around an HTTP client, providing a chainable methods to make API calls (requests) and handle responses.

It provides methods to

• Fetch user information ( full name, mobile number, health status, etc.)
• Manage gallery operations (request file, request image or mulitple images,etc.)
• Perform actions: Trigger actions like opening screens, sharing screens, and posting cards.
• Request permissions: Obtain user permissions for location, camera, gallery, and notifications.

Request Chaining

requestUserFullName() and requestUserMobileNumber() are chained methods for adding Tawakkalna’s endpoints (user_data/full_name and user_data/mobile_number) to queue requests to requests and process them in parallel.

Sending Requests

sendAll() execute all queued requests concurrently.

Handling Responses

• The then block is executed after all requests are completed and all the response are parsed and resolved to tawakkalna entity.

Examples

const gallery = await twa
  .requestGallerySingle()
  .requestCameraPhoto()
  .requestGallerySingleVideo()
  .requestFileId()
  .sendAll();

console.log(gallery.images.length);

const rawData = await twa
  .requestRawData(gallery.images)
  .requestRawData(gallery.videos)
  .sendAll();

console.log(rawData.files.length);