cap-module

Manage Storage, Login and Register Users and API Caller in CAPModule package manager:

• IndexedDB : Using Browser IndexedDB For Store FrontEnd Data .
• OAuth : Using OAuth2 Methods For Login / Register Users And Get Tokens.
• SSO : Using Single Sign On Services From CAPco.
• RefreshToken : Using Refresh Token to Renew Access Token Automatically.
• API With Credentials. Axios Combine With SSO Login And Set Token Automatically.

Last Testing With Nuxt Version : 3.11.2

Sponsors

Background

In the past, for the development of each project and each version in the front, we needed to write a large amount of code to perform the process of entering, registering, maintaining tokens, as well as calling APIs with the token. This process was time-consuming and also caused problems for developers with different experiences. It was decided to prepare a complete package of all the company's requirements and provide it to the company's developers.

Getting Started

• Installation
• Usage Auth
• Usage Api
• Usage DB
• Usage Direct Extra Param
• ExternalConfigFile
• Setting

Installation

Installing Package To Your Project With :

• pnpm Package Manager :

 pnpm install cap-module latest

• OR npm Package Manager :

 npm install cap-module latest

• OR yarn Package Manager :

 yarn add cap-module latest

Then, add cap-module to the modules section of your Nuxt configuration:

export default defineNuxtConfig({
  modules: ['cap-module']
})

Finally, add CapModule Json Object Property to the Nuxt Config section of your Nuxt configuration:

export default defineNuxtConfig({
  CapModule: {
    client_id:'',
    app_code:'',
    is_multi_token: true,
    environment: "Development",
    extra: [ { refreshTime: 10 } , ... ],
    database : {
      version: 1,
      db_name: "DataBaseName",
      tables_name : ["config"]
    },
    api_methods : {
      user_info: "",
      authorization_by_app_code: "",
      refresh_token: ""
    },
    production : {
      base_url : "",
      redirect_uri: "",
      sso_site_url: ""
    },
    development : {
      base_url : "",
      redirect_uri: "",
      sso_site_url: ""
    }
  }
})

UsageAuth

To use the services related to login, exit from the user account and check and receive the token, use the following methods:

    <script setup lang="ts">
        const { login , logout , checkLogin , userInfo , refreshToken , getLoggedInUser } = useCapAuth();
    </script>

• login

By calling this method, the user is transferred to the SSO page in the HUB according to the project settings, and after performing the login or register operation, she is redirected to the page specified in the settings with the name CallBackURL.

Trick : To add the title or address of a specific page to the Redirect value during login, use the following method :

    <script setup lang="ts">
        const { login } = useCapAuth();
        await login('users');
    </script>

• logout

By calling this method, all the information related to the logged in user will be removed from the database created in the browser, and after that the developer can issue the transfer command to the guest page.

Trick : To delete all tables created in the database," await capAuth.logout(true) " should be called, and if you want only the table related to user login information and authentication to be deleted, " await capAuth.logout(false) " call:

    <script setup lang="ts">
        const { logout } = useCapAuth();
        await capAuth.logout(true)   OR   await capAuth.logout(false)
    </script>

• checkLogin

The time to call this method is after the user returns from the SSO page and it requires sending the state and code parameters that are in the Query. The answer of this method is True or False, which will indicate the completion of the login process or an error in performing the operation. Send the information similar to the example below:

await checkLogin(route.query.state , route.query.code)

• userInfo

You can call this method to retrieve user information from the backend according to the received and active token.

• getLoggedInUser

You can call this method to get loggedInUser information from Local IndexedDB.

• refreshToken

You can call this method to renew AccessToken from the backend And Then Call UserInfo Method Automatically for Refresh User Info In local DB.

UsageApi

To call different methods from the project's backend, you can use the completed AXIOS method, which sends the Token value along with the request in the Header when the user is logged in, as follows:

    <script setup lang="ts">
        const capAPI = useCapApi();
        const getReport = async () => {
            const {data} = await (await capAPI.useAPI())({ method: 'get', url : 'user/getAll' })
        }
    </script>

capAPI.useAPI( withAccessToken : boolean);

• withAccessToken
  • TRUE : if leave fill This Parameter, Set True by Default and Add AccessToken ( if User Logged in ) in the Header of Request .
  • FALSE : if set False call API without Credentials .

Trick : Methods related to 403 and 401 error management, which announce the RefreshToken process and the user's lack of access to the desired method or page, have also been added. If a 403 error is given, the user will be directed to the error page, and if the user encounters a 401 error, a request to update the token will be given first, and if the error is still encountered, the user will be logged out.

UsageDB

In this module, it is possible to create a database on the user's browser, which will be created automatically when logging in OR registering. The value of the title of this database is obtained from the settings, where you can specify a desired name. 4 actions Insert, Get, Clear, Remove are currently active. To use each one, pay attention to the following examples. Also, you don't need to create an Instance in the project and NUXT itself will import the class related to the database.

    <script setup lang="ts">
        const insert = async () => {
            await IndexDBInsert('{{ TableName }}', '{{ Key Name }}', '{{ Value }}')
        }
        const get = async () => {
            await IndexDBGet('{{ TableName }}', '{{ Key Name }}')
        }
        const remove = async () => {
            await IndexDBRemove('{{ TableName }}', '{{ Key Name }}')
        }
        const clear = async () => {
            await IndexDBClear('{{ TableName }}')
        }
        const getAllKeys = async () => {
          await IndexDBGetAllKeys('{{ TableName }}')
        }  
        const getAllValues = async () => {
          await IndexDBGetAll('{{ TableName }}')
        }
    </script>

UsageDirectExtraParam

You can store additional project parameters in the form of an array. This allows you to define dynamic parameters that you want to change in the project without changing the version. For example, defining when to update an API on a page. To do this, follow these steps :

In the configuration file, set the extra parameter as follows:

{
    "extra" : [ { "refreshTime": 10 }],
}

Then use it in the scripting section of your project as follows :

<script setup lang="ts">
  import CapModule from '#capModule';
  
  onMounted(async () => {
    console.log('CapModule.extra : ' , CapModule.extra)
  })
</script>

ExternalConfigFile

You can save the settings related to the project in a separate file outside Nuxt.Config.ts file. For this, create a file called cap_module_config.json in the public folder and enter the following values :

{
  "client_id": "...",
  "app_code": "...",
  "is_multi_token": true,
  "environment": "Development", 
  "extra": [ { "refreshTime" : 10 } ],
  "database": {
    "version": 1,
    "db_name": "DatabaseName", 
    "tables_name" : ["config"]
  },
  "api_methods" : {
    "user_info": "Auth/UserInfo",
    "authorization_by_app_code": "Auth/AuthorizationByAppCode",
    "refresh_token": "Auth/RefreshToken"
  },
  "production" : {
    "base_url" : "https://b.abc.com",
    "redirect_uri": "https://abc.com/landing",
    "sso_site_url": "https://sso.abc.com"
  },
  "development" : {
    "base_url" : "https://b.abc.com",
    "redirect_uri": "http://localhost:3000",
    "sso_site_url": "https://sso.abc.com"
  }
}

The advantage of this work is that when the output from the project is prepared and placed on the server, you can change the settings related to the connection to the BackEnd without the need to prepare a new output.

Setting

Thank You

Thanks to all colleagues of CAP Company

Author : Ahmad Ghanavati