Merge pull request #295 from bakaphp/feat-admin-app-setting

feat: add get app setting

.github/workflows/main.yml

@@ -25,6 +25,7 @@ jobs:
           echo "KANVAS_APP_KEY=${{ secrets.KANVAS_APP_KEY }}" >> $GITHUB_ENV
           echo "KANVAS_TEST_USER=${{ secrets.KANVAS_TEST_USER }}" >> $GITHUB_ENV
           echo "KANVAS_TEST_PASSWORD=${{ secrets.KANVAS_TEST_PASSWORD }}" >> $GITHUB_ENV
+          echo "KANVAS_APP_SECRET=${{ secrets.KANVAS_APP_SECRET }}" >> $GITHUB_ENV
 
       - name: Run install
         uses: borales/actions-yarn@v4

.github/workflows/npm-publish.yml

@@ -30,6 +30,7 @@ jobs:
           echo "KANVAS_APP_KEY=${{ secrets.KANVAS_APP_KEY }}" >> $GITHUB_ENV
           echo "KANVAS_TEST_USER=${{ secrets.KANVAS_TEST_USER }}" >> $GITHUB_ENV
           echo "KANVAS_TEST_PASSWORD=${{ secrets.KANVAS_TEST_PASSWORD }}" >> $GITHUB_ENV
+          echo "KANVAS_APP_SECRET=${{ secrets.KANVAS_APP_SECRET }}" >> $GITHUB_ENV
 
       - run: yarn install --frozen-lockfile
 

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "0.8.6",
+  "version": "0.8.7",
   "license": "MIT",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

src/modules/settings/index.tsx

@@ -1,12 +1,13 @@
 import {
+  APP_SETTING_QUERY,
   APP_SETTINGS_QUERY,
   AppSettingsQuery,
   COMPANY_SETTING_QUERY,
   ConfigInput,
   USERS_SETTINGS_QUERY,
 } from '../../queries';
 import {
-  AppSettingsQueryResponse,
+  AdminAppSettingsQueryResponse,
   AppSettingsResponse,
   ClientType,
   CompanySettingsResponse,
@@ -24,9 +25,9 @@ import {
 } from '../../mutations';
 
 export default class Settings {
-  constructor(protected client: ClientType, protected key: string) {}
+  constructor(protected client: ClientType, protected key: string) { }
 
-  async fetchAppSettings(): Promise<AppSettingsQueryResponse | undefined> {
+  async appSettings(): Promise<AdminAppSettingsQueryResponse | undefined> {
     try {
       const { data } = await this.client.query({
         query: APP_SETTINGS_QUERY,
@@ -38,6 +39,31 @@ export default class Settings {
       return undefined;
     }
   }
+
+  async appSetting(name: string): Promise<any | undefined> {
+    try {
+      const { data } = await this.client.query({
+        query: APP_SETTING_QUERY,
+        variables: {
+          key: name,
+        },
+        fetchPolicy: 'network-only',
+        partialRefetch: true,
+      });
+
+      return data.adminAppSetting;
+    } catch {
+      return undefined;
+    }
+  }
+
+  async fetchAppSettings(): Promise<AdminAppSettingsQueryResponse | undefined> {
+    return this.appSettings();
+  }
+
+  /**
+   * @deprecated
+   */
   async getAppSettings(): Promise<SettingsResponse | undefined> {
     try {
       const {
@@ -167,7 +193,7 @@ export default class Settings {
         },
       });
       return response.data.deleteUserSetting;
-    } catch (err){
+    } catch (err) {
       return undefined;
     }
   }

src/queries/settings.query.ts

@@ -46,3 +46,9 @@ export const APP_SETTINGS_QUERY = gql`
   }
 `;
 
+export const APP_SETTING_QUERY = gql`
+  query adminAppSetting($key: String!) {
+    adminAppSetting(key: $key)
+  }
+`;
+

src/types/settings.ts

@@ -18,3 +18,12 @@ export interface UserSettingsResponse {
 export interface AppSettingsQueryResponse {
   appSettings: Array<{ key: string; value: any; public?: boolean }>;
 }
+export interface AdminAppSetting {
+  key: string;
+  value: any;
+  public?: boolean;
+}
+
+export interface AdminAppSettingsQueryResponse {
+  adminAppSettings: AdminAppSetting[];
+}

test/customFields.test.ts

@@ -0,0 +1,51 @@
+import { initializeClient, getClient } from './setupClient';
+import dotenv from 'dotenv';
+
+dotenv.config();
+
+beforeAll(async () => {
+    await initializeClient(process.env.KANVAS_APP_SECRET!);
+});
+
+/**
+ * @todo add profile photo upload test
+ */
+describe('Test the Kanvas Custom Fields', () => {
+
+    it('gets app settings - deprecated', async () => {
+        const client = getClient();
+
+        const appSettings = await client.settings.getAppSettings();
+        expect(appSettings).toBeDefined();
+        expect(appSettings?.name).toBeDefined();
+        expect(appSettings?.settings).toBeDefined();
+    });
+
+    it('gets admin app settings', async () => {
+        const client = getClient();
+
+        const appSettings = await client.settings.fetchAppSettings();
+        expect(appSettings?.adminAppSettings).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].key).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].value).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].public).toBeDefined();
+    });
+
+    it('gets admin app settings v2', async () => {
+        const client = getClient();
+
+        const appSettings = await client.settings.appSettings();
+        expect(appSettings?.adminAppSettings).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].key).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].value).toBeDefined();
+        expect(appSettings?.adminAppSettings[0].public).toBeDefined();
+    });
+
+    it('gets admin one app setting', async () => {
+        const client = getClient();
+
+        const appSettings = await client.settings.appSettings();
+        const appSetting = await client.settings.appSetting(appSettings?.adminAppSettings[0].key ?? '');
+        expect(appSetting).toBeDefined();
+    });
+});

test/setupClient.ts

@@ -5,7 +5,7 @@ dotenv.config();
 
 let client: KanvasCore;
 
-export const initializeClient = async () => {
+export const initializeClient = async (adminKey?: string) => {
     const getKey = async (): Promise<string | null> => {
         return localStorage.getItem("token") || null; // wherever you have saved the user token
     };
@@ -35,6 +35,7 @@ export const initializeClient = async () => {
     client = new KanvasCore({
         url: process.env.KANVAS_URL!,
         key: process.env.KANVAS_APP_KEY!,
+        ...(adminKey && { adminKey }), // Add adminKey only if it is provided
         middlewares: [genericAuthMiddleware(getKey)],
     });