feat(api-keys): adds ApiKeyACL type

packages/algoliasearch/src/builds/browser.ts

@@ -31,6 +31,7 @@ import {
   addApiKey,
   AddApiKeyOptions,
   AddApiKeyResponse,
+  ApiKeyACLType,
   assignUserID,
   AssignUserIDResponse,
   assignUserIDs,
@@ -539,7 +540,7 @@ export type SearchClient = BaseSearchClient & {
     requestOptions?: RequestOptions
   ) => Readonly<Promise<GetApiKeyResponse>>;
   readonly addApiKey: (
-    acl: readonly string[],
+    acl: readonly ApiKeyACLType[],
     requestOptions?: AddApiKeyOptions &
       Pick<RequestOptions, Exclude<keyof RequestOptions, 'queryParameters'>>
   ) => Readonly<WaitablePromise<AddApiKeyResponse>>;

packages/algoliasearch/src/builds/node.ts

@@ -30,6 +30,7 @@ import {
   addApiKey,
   AddApiKeyOptions,
   AddApiKeyResponse,
+  ApiKeyACLType,
   assignUserID,
   AssignUserIDResponse,
   assignUserIDs,
@@ -542,7 +543,7 @@ export type SearchClient = BaseSearchClient & {
     requestOptions?: RequestOptions
   ) => Readonly<Promise<GetApiKeyResponse>>;
   readonly addApiKey: (
-    acl: readonly string[],
+    acl: readonly ApiKeyACLType[],
     requestOptions?: AddApiKeyOptions &
       Pick<RequestOptions, Exclude<keyof RequestOptions, 'queryParameters'>>
   ) => Readonly<WaitablePromise<AddApiKeyResponse>>;

packages/client-search/src/methods/client/addApiKey.ts

@@ -10,14 +10,15 @@ import { ApiError, RequestOptions } from '@algolia/transporter';
 import {
   AddApiKeyOptions,
   AddApiKeyResponse,
+  ApiKeyACLType,
   getApiKey,
   GetApiKeyResponse,
   SearchClient,
 } from '../..';
 
 export const addApiKey = (base: SearchClient) => {
   return (
-    acl: readonly string[],
+    acl: readonly ApiKeyACLType[],
     requestOptions?: AddApiKeyOptions &
       Pick<RequestOptions, Exclude<keyof RequestOptions, 'queryParameters'>>
   ): Readonly<WaitablePromise<AddApiKeyResponse>> => {

packages/client-search/src/types/ApiKeyType.ts

@@ -0,0 +1,30 @@
+export const ApiKeyACLEnum: Readonly<Record<string, ApiKeyACLType>> = {
+  AddObject: 'addObject',
+  Analytics: 'analytics',
+  Browser: 'browse',
+  DeleteIndex: 'deleteIndex',
+  DeleteObject: 'deleteObject',
+  EditSettings: 'editSettings',
+  ListIndexes: 'listIndexes',
+  Logs: 'logs',
+  Recommendation: 'recommendation',
+  Search: 'search',
+  SeeUnretrievableAttributes: 'seeUnretrievableAttributes',
+  Settings: 'settings',
+  Usage: 'usage',
+};
+
+export type ApiKeyACLType =
+  | 'addObject'
+  | 'analytics'
+  | 'browse'
+  | 'deleteIndex'
+  | 'deleteObject'
+  | 'editSettings'
+  | 'listIndexes'
+  | 'logs'
+  | 'recommendation'
+  | 'search'
+  | 'seeUnretrievableAttributes'
+  | 'settings'
+  | 'usage';

packages/client-search/src/types/GetApiKeyResponse.ts

@@ -1,3 +1,5 @@
+import { ApiKeyACLType } from '.';
+
 export type GetApiKeyResponse = {
   /**
    * A Unix timestamp used to define the expiration date of the API key.
@@ -12,7 +14,7 @@ export type GetApiKeyResponse = {
   /**
    * List of permissions the key contains.
    */
-  acl: string[];
+  acl: ApiKeyACLType[];
 
   /**
    * A Unix timestamp used to define the expiration date of the API key.

packages/client-search/src/types/index.ts

@@ -4,6 +4,7 @@
 
 export * from './AddApiKeyOptions';
 export * from './AddApiKeyResponse';
+export * from './ApiKeyType';
 export * from './AssignUserIDResponse';
 export * from './AssignUserIDsResponse';
 export * from './BatchActionType';