display name for fetching and creating api keys

packages/frontend-apis-react/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@propelauth/frontend-apis-react",
-    "version": "0.0.16",
+    "version": "0.0.17",
     "description": "",
     "exports": {
         ".": {
@@ -56,7 +56,7 @@
         "react-dom": "^17.0.0 || ^18.0.0 || ^19.0.0"
     },
     "dependencies": {
-        "@propelauth/frontend-apis": "^0.0.16",
+        "@propelauth/frontend-apis": "^0.0.17",
         "@propelauth/react": "^2.0.30"
     }
 }

packages/frontend-apis/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@propelauth/frontend-apis",
-    "version": "0.0.16",
+    "version": "0.0.17",
     "description": "",
     "exports": {
         ".": {

packages/frontend-apis/src/apis/apiKeys/createOrgApiKey.ts

@@ -6,10 +6,24 @@ import {
     InvalidExpirationOptionResponse,
     UnauthorizedResponse,
     UnexpectedErrorResponse,
+    ApiErrorForSpecificFields,
 } from '../../helpers/errors'
 import { makeRequest, LoggedInVisitor } from '../../helpers/request'
 import { ApiKeyExpirationOption } from './types'
 
+/////////////////
+///////////////// Errors specific to this request
+/////////////////
+export interface CreateOrgApiKeyBadRequestResponse extends ApiErrorForSpecificFields {
+    error_code: ErrorCode.InvalidRequestFields
+    user_facing_errors: {
+        display_name: string
+    }
+    field_errors: {
+        display_name: string
+    }
+}
+
 /////////////////
 ///////////////// Success and Error Responses
 /////////////////
@@ -19,6 +33,7 @@ export type CreateOrgApiKeySuccessResponse = {
 }
 
 export type CreateOrgApiKeyErrorResponse =
+    | CreateOrgApiKeyBadRequestResponse
     | InvalidExpirationOptionResponse
     | UnauthorizedResponse
     | UnexpectedErrorResponse
@@ -30,6 +45,7 @@ export type CreateOrgApiKeyErrorResponse =
 /////////////////
 export type CreateOrgApiKeyVisitor = LoggedInVisitor & {
     success: (data: CreateOrgApiKeySuccessResponse) => void
+    badRequest?: (error: CreateOrgApiKeyBadRequestResponse) => void
     invalidExpirationOption?: (error: InvalidExpirationOptionResponse) => void
     noOrgApiKeyPermission?: (error: ForbiddenErrorResponse) => void
 }
@@ -40,7 +56,7 @@ export type CreateOrgApiKeyVisitor = LoggedInVisitor & {
 export type CreateOrgApiKeyFn = ReturnType<typeof createOrgApiKey>
 
 export const createOrgApiKey =
-    (authUrl: string) => async (orgId: string, expirationOption?: ApiKeyExpirationOption) => {
+    (authUrl: string) => async (orgId: string, expirationOption?: ApiKeyExpirationOption, displayName?: string) => {
         return makeRequest<CreateOrgApiKeyVisitor, CreateOrgApiKeyErrorResponse, CreateOrgApiKeySuccessResponse>({
             authUrl,
             path: '/api_keys',
@@ -49,13 +65,16 @@ export const createOrgApiKey =
             body: {
                 org_id: orgId,
                 expiration_option: expirationOption,
+                display_name: displayName,
             },
             responseToSuccessHandler: (response, visitor) => {
                 return () => visitor.success(response)
             },
             responseToErrorHandler: (error, visitor) => {
                 const { error_code: errorCode } = error
                 switch (errorCode) {
+                    case ErrorCode.InvalidRequestFields:
+                        return getVisitorOrUndefined(visitor.badRequest, error)
                     case ErrorCode.Forbidden:
                         return getVisitorOrUndefined(visitor.noOrgApiKeyPermission, error)
                     case ErrorCode.BadRequest:

packages/frontend-apis/src/apis/apiKeys/createPersonalApiKey.ts

@@ -6,10 +6,24 @@ import {
     InvalidExpirationOptionResponse,
     UnauthorizedResponse,
     UnexpectedErrorResponse,
+    ApiErrorForSpecificFields,
 } from '../../helpers/errors'
 import { makeRequest, LoggedInVisitor } from '../../helpers/request'
 import { ApiKeyExpirationOption } from './types'
 
+/////////////////
+///////////////// Errors specific to this request
+/////////////////
+export interface CreatePersonalApiKeyBadRequestResponse extends ApiErrorForSpecificFields {
+    error_code: ErrorCode.InvalidRequestFields
+    user_facing_errors: {
+        display_name: string
+    }
+    field_errors: {
+        display_name: string
+    }
+}
+
 /////////////////
 ///////////////// Success and Error Responses
 /////////////////
@@ -19,6 +33,7 @@ export type CreatePersonalApiKeySuccessResponse = {
 }
 
 export type CreatePersonalApiKeyErrorResponse =
+    | CreatePersonalApiKeyBadRequestResponse
     | InvalidExpirationOptionResponse
     | UnauthorizedResponse
     | UnexpectedErrorResponse
@@ -30,6 +45,7 @@ export type CreatePersonalApiKeyErrorResponse =
 /////////////////
 export type CreatePersonalApiKeyVisitor = LoggedInVisitor & {
     success: (data: CreatePersonalApiKeySuccessResponse) => void
+    badRequest?: (error: CreatePersonalApiKeyBadRequestResponse) => void
     invalidExpirationOption?: (error: InvalidExpirationOptionResponse) => void
     noPersonalApiKeyPermission?: (error: ForbiddenErrorResponse) => void
 }
@@ -39,39 +55,43 @@ export type CreatePersonalApiKeyVisitor = LoggedInVisitor & {
 /////////////////
 export type CreatePersonalApiKeyFn = ReturnType<typeof createPersonalApiKey>
 
-export const createPersonalApiKey = (authUrl: string) => async (expirationOption?: ApiKeyExpirationOption) => {
-    return makeRequest<
-        CreatePersonalApiKeyVisitor,
-        CreatePersonalApiKeyErrorResponse,
-        CreatePersonalApiKeySuccessResponse
-    >({
-        authUrl,
-        path: '/api_keys',
-        method: 'POST',
-        parseResponseAsJson: true,
-        body: {
-            expiration_option: expirationOption,
-        },
-        responseToSuccessHandler: (response, visitor) => {
-            return () => visitor.success(response)
-        },
-        responseToErrorHandler: (error, visitor) => {
-            const { error_code: errorCode } = error
-            switch (errorCode) {
-                case ErrorCode.Forbidden:
-                    return getVisitorOrUndefined(visitor.noPersonalApiKeyPermission, error)
-                case ErrorCode.BadRequest:
-                    return getVisitorOrUndefined(visitor.invalidExpirationOption, error)
-                case ErrorCode.Unauthorized:
-                    return getVisitorOrUndefined(visitor.unauthorized, error)
-                case ErrorCode.EmailNotConfirmed:
-                    return getVisitorOrUndefined(visitor.emailNotConfirmed, error)
-                case ErrorCode.UnexpectedError:
-                    return getVisitorOrUndefined(visitor.unexpectedOrUnhandled, error)
-                default:
-                    unmatchedCase(errorCode)
-                    return undefined
-            }
-        },
-    })
-}
+export const createPersonalApiKey =
+    (authUrl: string) => async (expirationOption?: ApiKeyExpirationOption, displayName?: string) => {
+        return makeRequest<
+            CreatePersonalApiKeyVisitor,
+            CreatePersonalApiKeyErrorResponse,
+            CreatePersonalApiKeySuccessResponse
+        >({
+            authUrl,
+            path: '/api_keys',
+            method: 'POST',
+            parseResponseAsJson: true,
+            body: {
+                expiration_option: expirationOption,
+                display_name: displayName,
+            },
+            responseToSuccessHandler: (response, visitor) => {
+                return () => visitor.success(response)
+            },
+            responseToErrorHandler: (error, visitor) => {
+                const { error_code: errorCode } = error
+                switch (errorCode) {
+                    case ErrorCode.InvalidRequestFields:
+                        return getVisitorOrUndefined(visitor.badRequest, error)
+                    case ErrorCode.Forbidden:
+                        return getVisitorOrUndefined(visitor.noPersonalApiKeyPermission, error)
+                    case ErrorCode.BadRequest:
+                        return getVisitorOrUndefined(visitor.invalidExpirationOption, error)
+                    case ErrorCode.Unauthorized:
+                        return getVisitorOrUndefined(visitor.unauthorized, error)
+                    case ErrorCode.EmailNotConfirmed:
+                        return getVisitorOrUndefined(visitor.emailNotConfirmed, error)
+                    case ErrorCode.UnexpectedError:
+                        return getVisitorOrUndefined(visitor.unexpectedOrUnhandled, error)
+                    default:
+                        unmatchedCase(errorCode)
+                        return undefined
+                }
+            },
+        })
+    }

packages/frontend-apis/src/apis/apiKeys/fetchOrgApiKeys.ts

@@ -29,6 +29,7 @@ export type OrgApiKey = {
     created_at: number
     expires_at_seconds: number | null
     metadata: Record<string, unknown> | null
+    display_name?: string
 }
 
 export type FetchOrgApiKeysSuccessResponse = {

packages/frontend-apis/src/apis/apiKeys/fetchPersonalApiKeys.ts

@@ -26,6 +26,7 @@ export type PersonalApiKey = {
     created_at: number
     expires_at_seconds: number | null
     metadata: Record<string, unknown> | null
+    display_name?: string
 }
 
 export type FetchPersonalApiKeysSuccessResponse = {

packages/frontend-apis/src/index.ts

@@ -1,6 +1,7 @@
 export type {
     CreatePersonalApiKeySuccessResponse,
     CreatePersonalApiKeyVisitor,
+    CreatePersonalApiKeyBadRequestResponse,
     CreatePersonalApiKeyErrorResponse,
     CreatePersonalApiKeyFn,
 } from './apis/apiKeys/createPersonalApiKey'
@@ -248,6 +249,7 @@ export type {
 export type {
     CreateOrgApiKeyErrorResponse,
     CreateOrgApiKeySuccessResponse,
+    CreateOrgApiKeyBadRequestResponse,
     CreateOrgApiKeyVisitor,
     CreateOrgApiKeyFn,
 } from './apis/apiKeys/createOrgApiKey'