feat: add api key template api call for usage panel (#851)

* feat: add api key template api call for usage panel
J:ORG-659

* chore: fix build

* chore: fix build

* chore: replace url by fetch by id

* chore: fix test

* chore: fix build

* Update src/resources/ApiKeyTemplate/ApiKeyTemplateInterface.ts

Co-authored-by: Gaël Dostie <[email protected]>

* Update src/resources/ApiKeyTemplate/ApiKeyTemplate.ts

Co-authored-by: Gaël Dostie <[email protected]>

* Apply suggestions from code review

Co-authored-by: Gaël Dostie <[email protected]>

* chore: apply pr comments

* chore: fix build

* Update src/resources/ApiKeyTemplate/test/ApiKeyTemplate.spec.ts

Co-authored-by: Gaël Dostie <[email protected]>

---------

Co-authored-by: Gaël Dostie <[email protected]>

Author: schaoukicoveo

src/resources/ApiKeyTemplate/ApiKeyTemplate.ts

@@ -0,0 +1,10 @@
+import Resource from "../Resource.js";
+import { ApiKeyTemplateModel } from "./ApiKeyTemplateInterface.js";
+
+export default class ApiKeyTemplate extends Resource {
+    static baseUrl = '/rest/templates/apikeys'
+
+    get(apiKeyTemplateId:string) {
+        return this.api.get<ApiKeyTemplateModel[]>(`${ApiKeyTemplate.baseUrl}/${apiKeyTemplateId}`)
+    }
+}

src/resources/ApiKeyTemplate/ApiKeyTemplateInterface.ts

@@ -0,0 +1,28 @@
+import { PrivilegeModel } from "../BaseInterfaces.js";
+
+export interface ApiKeyTemplateModel {
+    /**
+     * The unique identifier of the API key template.
+     */
+    id?: string; 
+    /**
+     * The displaye name of the Api key template.
+     */
+    displayName?: string;
+    /**
+     * The descirption of the Api key template.
+     */
+    description?: string;
+    /**
+     * A set of IP addresses allowed to use the Api key template.
+     */
+    allowedIps?: string[];
+    /**
+     * A set of IP addresses that will be denied access when attempting to use the API key template.
+     */
+    deniedIps?: string[];
+    /**
+     * A set of privileges binded to an api key template.
+     */
+    privileges?: PrivilegeModel[];
+}

src/resources/ApiKeyTemplate/index.ts

@@ -0,0 +1,2 @@
+export * from './ApiKeyTemplate.js';
+export * from './ApiKeyTemplateInterface.js';

src/resources/ApiKeyTemplate/test/ApiKeyTemplate.spec.ts

@@ -0,0 +1,27 @@
+import API from '../../../APICore.js';
+
+import ApiKeyTemplate from '../ApiKeyTemplate.js';
+
+jest.mock('../../../APICore.js');
+
+const APIMock: jest.Mock<API> = API as any;
+
+describe('ApiKeyTemplateModel', () => {
+    let apiKeyTemplate: ApiKeyTemplate;
+    const api = new APIMock() as jest.Mocked<API>;
+    const serverlessApi = new APIMock() as jest.Mocked<API>;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        apiKeyTemplate = new ApiKeyTemplate(api, serverlessApi);
+    });
+
+    describe('get', () => {
+        it('should make a GET call to the ApiKeys at the keyPurpose', async () => {
+            const apiKeyTemplateToGetId = 'ApikeyTemplate-to-be-fetched';
+            await apiKeyTemplate.get(apiKeyTemplateToGetId);
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith(`${ApiKeyTemplate.baseUrl}/${apiKeyTemplateToGetId}`);
+        });
+    });
+});

src/resources/PlatformResources.ts

@@ -54,10 +54,12 @@ import Project from './Projects/Project.js';
 import Resources from './Resources/Resources.js';
 import CatalogContent from './Catalogs/CatalogContent.js';
 import Properties from './AnalyticsAdmin/Properties/Properties.js';
+import ApiKeyTemplate from './ApiKeyTemplate/ApiKeyTemplate.js';
 
 const resourcesMap: Array<{key: string; resource: typeof Resource}> = [
     {key: 'activity', resource: Activity},
     {key: 'apiKey', resource: ApiKey},
+    {key: 'apiKeyTemplate', resource: ApiKeyTemplate},
     {key: 'aws', resource: AWS},
     {key: 'caseAssistConfig', resource: CaseAssistConfig},
     {key: 'catalog', resource: Catalog},
@@ -120,6 +122,7 @@ class PlatformResources {
 
     activity: Activity;
     apiKey: ApiKey;
+    apiKeyTemplate: ApiKeyTemplate;
     aws: AWS;
     caseAssistConfig: CaseAssistConfig;
     catalog: Catalog;

src/resources/index.ts

@@ -2,6 +2,7 @@ export {default as Resource} from './Resource.js';
 
 export * from './Activities/index.js';
 export * from './ApiKeys/index.js';
+export * from './ApiKeyTemplate/index.js';
 export * from './AWS/index.js';
 export * from './BaseInterfaces.js';
 export * from './CaseAssistConfigs/index.js';