Implement client for new API key endpoints: create, list, and delete by ID (#74)

* feat: implement create, list, delete api key client library

* feat: add openAPI generated classes for new SDK API key functions

* styles: remove 'Request' from SDK function names

* fix: incorrect casing in module import

* fix: incomplete types, undetailed errors, incorrect auth code

* models: add updated response model

* fix: remove redundant delete api key by id method

* feat: updata client sdk with delete api key by id method

* feat: add pagination links to get all api keys response

* fix: openAPI schema validation errors

* add pnpm lockfile

* fix: remove conflicting getAllApiKeysResponse.ts

* fix: add GetAllApiKeysResponse with correct casing

* Update src/lib/validators.ts

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

* fix: lint errors

* fix: merge conflicts

* add key validation and fix credentials auth for deleteapikey method

---------

Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
Co-authored-by: aakashg00 <aakashbb@gmail.com>

Author: 3 people

pnpm-lock.yaml

@@ -14,6 +14,7 @@
 
 import * as runtime from '../runtime';
 import type {
+  GetAllApiKeysResponse,
   IssueApiKeyRequest,
   IssueApiKeyResponse,
   IssueJWTResponse,
@@ -22,6 +23,8 @@ import type {
   RequestNewAccountModel,
 } from '../models/index';
 import {
+  GetAllApiKeysResponseFromJSON,
+  GetAllApiKeysResponseToJSON,
   IssueApiKeyRequestFromJSON,
   IssueApiKeyRequestToJSON,
   IssueApiKeyResponseFromJSON,
@@ -41,9 +44,9 @@ export interface AuthControllerCreateAccountRequestRequest {
 }
 
 export interface AuthControllerCreateApiKeyRequest {
-  xUserPassword: string;
-  xUserEmail: string;
   issueApiKeyRequest: IssueApiKeyRequest;
+  xUserPassword?: string;
+  xUserEmail?: string;
 }
 
 export interface AuthControllerDeleteAccountRequestRequest {
@@ -52,15 +55,25 @@ export interface AuthControllerDeleteAccountRequestRequest {
   xUserEmail: string;
 }
 
-export interface AuthControllerDeleteApiKeyRequest {
-  authorization: string;
+export interface AuthControllerDeleteApiKeyByIdRequest {
+  id: string;
+  xUserJwt?: string;
+  xUserPassword?: string;
+  xUserEmail?: string;
 }
 
 export interface AuthControllerGetAllAccountRequestsRequest {
   xUserPassword: string;
   xUserEmail: string;
 }
 
+export interface AuthControllerGetAllApiKeysRequest {
+  offset?: number;
+  limit?: number;
+  xUserPassword?: string;
+  xUserEmail?: string;
+}
+
 export interface AuthControllerGetApiKeyJWTRequest {
   authorization: string;
 }
@@ -139,20 +152,6 @@ export class AuthApi extends runtime.BaseAPI {
     requestParameters: AuthControllerCreateApiKeyRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction
   ): Promise<runtime.ApiResponse<IssueApiKeyResponse>> {
-    if (requestParameters['xUserPassword'] == null) {
-      throw new runtime.RequiredError(
-        'xUserPassword',
-        'Required parameter "xUserPassword" was null or undefined when calling authControllerCreateApiKey().'
-      );
-    }
-
-    if (requestParameters['xUserEmail'] == null) {
-      throw new runtime.RequiredError(
-        'xUserEmail',
-        'Required parameter "xUserEmail" was null or undefined when calling authControllerCreateApiKey().'
-      );
-    }
-
     if (requestParameters['issueApiKeyRequest'] == null) {
       throw new runtime.RequiredError(
         'issueApiKeyRequest',
@@ -295,26 +294,36 @@ export class AuthApi extends runtime.BaseAPI {
   }
 
   /**
-   * Deletes an API key, detaching it from its project.
+   * Revokes an API key, detaching it from its project.
    */
-  async authControllerDeleteApiKeyRaw(
-    requestParameters: AuthControllerDeleteApiKeyRequest,
+  async authControllerDeleteApiKeyByIdRaw(
+    requestParameters: AuthControllerDeleteApiKeyByIdRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction
   ): Promise<runtime.ApiResponse<void>> {
-    if (requestParameters['authorization'] == null) {
+    if (requestParameters['id'] == null) {
       throw new runtime.RequiredError(
-        'authorization',
-        'Required parameter "authorization" was null or undefined when calling authControllerDeleteApiKey().'
+        'id',
+        'Required parameter "id" was null or undefined when calling authControllerDeleteApiKeyById().'
       );
     }
 
     const queryParameters: any = {};
 
     const headerParameters: runtime.HTTPHeaders = {};
 
-    if (requestParameters['authorization'] != null) {
-      headerParameters['Authorization'] = String(
-        requestParameters['authorization']
+    if (requestParameters['xUserJwt'] != null) {
+      headerParameters['x-user-jwt'] = String(requestParameters['xUserJwt']);
+    }
+
+    if (requestParameters['xUserPassword'] != null) {
+      headerParameters['X-User-Password'] = String(
+        requestParameters['xUserPassword']
+      );
+    }
+
+    if (requestParameters['xUserEmail'] != null) {
+      headerParameters['X-User-Email'] = String(
+        requestParameters['xUserEmail']
       );
     }
 
@@ -328,7 +337,10 @@ export class AuthApi extends runtime.BaseAPI {
     }
     const response = await this.request(
       {
-        path: `/auth/key`,
+        path: `/auth/key/{id}`.replace(
+          `{${'id'}}`,
+          encodeURIComponent(String(requestParameters['id']))
+        ),
         method: 'DELETE',
         headers: headerParameters,
         query: queryParameters,
@@ -340,13 +352,16 @@ export class AuthApi extends runtime.BaseAPI {
   }
 
   /**
-   * Deletes an API key, detaching it from its project.
+   * Revokes an API key, detaching it from its project.
    */
-  async authControllerDeleteApiKey(
-    requestParameters: AuthControllerDeleteApiKeyRequest,
+  async authControllerDeleteApiKeyById(
+    requestParameters: AuthControllerDeleteApiKeyByIdRequest,
     initOverrides?: RequestInit | runtime.InitOverrideFunction
   ): Promise<void> {
-    await this.authControllerDeleteApiKeyRaw(requestParameters, initOverrides);
+    await this.authControllerDeleteApiKeyByIdRaw(
+      requestParameters,
+      initOverrides
+    );
   }
 
   /**
@@ -425,6 +440,66 @@ export class AuthApi extends runtime.BaseAPI {
     return await response.value();
   }
 
+  /**
+   * Lists all API keys
+   */
+  async authControllerGetAllApiKeysRaw(
+    requestParameters: AuthControllerGetAllApiKeysRequest,
+    initOverrides?: RequestInit | runtime.InitOverrideFunction
+  ): Promise<runtime.ApiResponse<GetAllApiKeysResponse>> {
+    const queryParameters: any = {};
+
+    if (requestParameters['offset'] != null) {
+      queryParameters['offset'] = requestParameters['offset'];
+    }
+
+    if (requestParameters['limit'] != null) {
+      queryParameters['limit'] = requestParameters['limit'];
+    }
+
+    const headerParameters: runtime.HTTPHeaders = {};
+
+    if (requestParameters['xUserPassword'] != null) {
+      headerParameters['X-User-Password'] = String(
+        requestParameters['xUserPassword']
+      );
+    }
+
+    if (requestParameters['xUserEmail'] != null) {
+      headerParameters['X-User-Email'] = String(
+        requestParameters['xUserEmail']
+      );
+    }
+
+    const response = await this.request(
+      {
+        path: `/auth/key/all`,
+        method: 'GET',
+        headers: headerParameters,
+        query: queryParameters,
+      },
+      initOverrides
+    );
+
+    return new runtime.JSONApiResponse(response, (jsonValue) =>
+      GetAllApiKeysResponseFromJSON(jsonValue)
+    );
+  }
+
+  /**
+   * Lists all API keys
+   */
+  async authControllerGetAllApiKeys(
+    requestParameters: AuthControllerGetAllApiKeysRequest = {},
+    initOverrides?: RequestInit | runtime.InitOverrideFunction
+  ): Promise<GetAllApiKeysResponse> {
+    const response = await this.authControllerGetAllApiKeysRaw(
+      requestParameters,
+      initOverrides
+    );
+    return await response.value();
+  }
+
   /**
    * JSON Web Tokens are used for the vast majority of API-gateway calls. The Juno SDK provides the means of automatically authenticating through this route given a valid API key.
    * Generates a temporary JWT for the project tied to a specified API key.
@@ -489,7 +564,7 @@ export class AuthApi extends runtime.BaseAPI {
   }
 
   /**
-   * JSON Web Tokens are used for the vast majority of API-gateway calls. The Juno SDK provides the means of automatically authenticating through this route given valid user credentials.
+   * Generates a user identity token that can be used to authenticate admin and management endpoints in place of email/password credentials.
    * Generates a temporary JWT tied to a specified user.
    */
   async authControllerGetUserJWTRaw(
@@ -550,7 +625,7 @@ export class AuthApi extends runtime.BaseAPI {
   }
 
   /**
-   * JSON Web Tokens are used for the vast majority of API-gateway calls. The Juno SDK provides the means of automatically authenticating through this route given valid user credentials.
+   * Generates a user identity token that can be used to authenticate admin and management endpoints in place of email/password credentials.
    * Generates a temporary JWT tied to a specified user.
    */
   async authControllerGetUserJWT(

src/internal/apis/AuthApi.ts

@@ -11,4 +11,5 @@ export * from './FileDownloadApi';
 export * from './FileProviderApi';
 export * from './FileUploadApi';
 export * from './ProjectApi';
+
 export * from './UserApi';

src/internal/apis/index.ts

@@ -0,0 +1,117 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Juno
+ * Juno Public API Docs
+ *
+ * The version of the OpenAPI document: 1.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ *
+ * @export
+ * @interface ApiKey
+ */
+export interface ApiKey {
+  /**
+   * The API key's ID in the databse
+   * @type {string}
+   * @memberof ApiKey
+   */
+  id: string;
+  /**
+   * The generated API key value (store immediately, not retrievable again)
+   * @type {string}
+   * @memberof ApiKey
+   */
+  hash: string;
+  /**
+   * Description provided at creation
+   * @type {string}
+   * @memberof ApiKey
+   */
+  description: string;
+  /**
+   * Scopes tied to this API key
+   * @type {Array<string>}
+   * @memberof ApiKey
+   */
+  scopes: Array<string>;
+  /**
+   * project identifier for the API key
+   * @type {string}
+   * @memberof ApiKey
+   */
+  project: string;
+  /**
+   * Environment this key was issued for
+   * @type {string}
+   * @memberof ApiKey
+   */
+  environment: string;
+  /**
+   * ISO timestamp of key creation
+   * @type {string}
+   * @memberof ApiKey
+   */
+  createdAt: string;
+}
+
+/**
+ * Check if a given object implements the ApiKey interface.
+ */
+export function instanceOfApiKey(value: object): value is ApiKey {
+  if (!('id' in value) || value['id'] === undefined) return false;
+  if (!('hash' in value) || value['hash'] === undefined) return false;
+  if (!('description' in value) || value['description'] === undefined)
+    return false;
+  if (!('scopes' in value) || value['scopes'] === undefined) return false;
+  if (!('project' in value) || value['project'] === undefined) return false;
+  if (!('environment' in value) || value['environment'] === undefined)
+    return false;
+  if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+  return true;
+}
+
+export function ApiKeyFromJSON(json: any): ApiKey {
+  return ApiKeyFromJSONTyped(json, false);
+}
+
+export function ApiKeyFromJSONTyped(
+  json: any,
+  ignoreDiscriminator: boolean
+): ApiKey {
+  if (json == null) {
+    return json;
+  }
+  return {
+    id: json['id'],
+    hash: json['hash'],
+    description: json['description'],
+    scopes: json['scopes'],
+    project: json['project'],
+    environment: json['environment'],
+    createdAt: json['createdAt'],
+  };
+}
+
+export function ApiKeyToJSON(value?: ApiKey | null): any {
+  if (value == null) {
+    return value;
+  }
+  return {
+    id: value['id'],
+    hash: value['hash'],
+    description: value['description'],
+    scopes: value['scopes'],
+    project: value['project'],
+    environment: value['environment'],
+    createdAt: value['createdAt'],
+  };
+}