# shas-app-controller > This npm module is the SH Authentication System, designed for managing applications and retrieving data registered on the official website. The module supports fetching application data from the official website, as well as remotely activating, deactivati Latest version **1.2.3** (published 2024-03-17) · ISC license · 0 weekly downloads > **Deprecated.** This package is deprecated. ## Install ```sh npm install shas-app-controller pnpm add shas-app-controller yarn add shas-app-controller bun add shas-app-controller ``` ## Health **Score 10/100 (F)** — status: deprecated. Negative: deprecated. ## Facts | | | |---|---| | Version | 1.2.3 | | Published | 2024-03-17 | | First published | 2024-03-09 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | ESM + CommonJS | | Dependencies | 1 | | Unpacked size | 28.5 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Shawkat Hossain Maruf | | Maintainers | shawkath646 | | Keywords | Nextjs 14, OAuth 2.0, authentication, sign in, sign up, create new account, delete account, register application, client ID, client secret, app information, app controller, remote control, web application, remote access, Cloudburst Lab, sh authentication system | ## Links - npm: https://www.npmjs.com/package/shas-app-controller - Repository: https://github.com/shawkath646/NPM-shas-app-controller - Homepage: https://github.com/shawkath646/NPM-shas-app-controller#readme - Issues: https://github.com/shawkath646/NPM-shas-app-controller.git/issues - npm.io page: https://npm.io/package/shas-app-controller ## Dependencies (1) - [react-toastify](https://npm.io/package/react-toastify.md) >=10.0.4 ## Alternatives - [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads - [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads - [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads - [@oxyhq/services](https://npm.io/package/@oxyhq/services.md) — 2.3K weekly downloads - [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads ## Recent versions - 1.2.3 (latest) — 2024-03-17 - 1.2.2 — 2024-03-11 - 1.2.1 — 2024-03-11 - 1.2.0 — 2024-03-11 - 1.1.0 — 2024-03-10 - 1.0.0 — 2024-03-09 ## README # SH Authentication System App Controller This npm module is the nextjs app controller, designed for managing applications and retrieving data registered on the official website. The module supports fetching application data from the official website, as well as remotely activating, deactivating, and displaying alert toast messages without the need for rebuilding or modifying the source code. ## Installation ``` npm i --save-dev shas-app-controller ``` ## Usage ### 1. Register application to SH Authentication System [application page](https://sh-authentication-system.vercel.app/auth/profile/applications). Copy the **app id** and **app secret** that is provided into application details page. ### 2. Creating a Configuration File Create a **shas.config.ts** file in the root directory: ``` import SHAS from "shas-app-controller"; // pass app id and secret provided from our website const { ContentWrapper, appData, brandData } = await SHAS({ appId: process.env.SHAS_APP_ID as string, appSecret: process.env.SHAS_APP_SECRET as string, // ---------- Optional ---------- // 1. If you wish to modify the Node Fetch caching properties, the default value is set to 'default'. cache: "no-cache", // Suggested for quickly updating data from the SH Authentication System server. // 2. Toast reminder: By default, it will reappear every 24 hours. toastReminder: 86400, // In seconds /* 3. Image Optimization: If you wishes to use NextJS image optimization in your error, disabled pages. By default it will use HTML img. Note: If you use image optimization you have to include this object in your next config image section. { protocol: 'https', hostname: 'storage.googleapis.com', port: '', pathname: '/**', }, */ imageOptimaization: false, // Boolean }); export { ContentWrapper, appData, brandData }; ``` **Note: If you have saved environment variables in this format you don't need to manually pass it.** ``` SHAS_APP_ID= SHAS_APP_SECRET= ``` ### 3. Using the ContentWrapper in Layout In your **layout.tsx**, wrap the children with **ContentWrapper**: ``` "use server"; //...other imports import { ContentWrapper } from "@/shas.config"; ... export default async function RootLayout({ children }: Readonly<{ children: React.ReactNode; }>) { return ( {children} ); }; ``` ### 4. Accessing appData and brandData You can now access **appData** and **brandData** in any of your project files: ``` import { appData, brandData } from "@/shas.config"; // Do something with the data console.log(appData); ``` ### 5. Accessing from client side Make sure you have initialized SHAS in the shas.config file. ``` import { getAppData, getBrandData } from "shas-app-controller/client"; const { appData, status } = getAppData(); const { brandData, status } = getBrandData(); // Status can be "loading", "success", "error" ``` ## Features * Remotely activate and deactivate your application with an eye-catching status page * Remotely show alert toasts with actions in your application * If you want to use **CloudBurst Lab** id as a OAuth 2.0 provider into your application. Use [next-auth-provider-cloudburst-lab](https://www.npmjs.com/search?q=next-auth-provider-cloudburst-lab) ## Requirements * Minimum version of Nextjs 13 to use server actions. ## Author **[Shawkat Hossain Maruf](https://sh-portfolio-maker.vercel.app/p/shawkath646)**
Contact: shawkath646@gmail.com ## Version Current version: 1.0.0 ##### Please use latest version to prevent bugs and errors! CloudBurst Logo *A product of [CloudBurst Lab](https://cloudburstlab.vercel.app)* --- _Source: https://npm.io/package/shas-app-controller · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._