fix: prettier formatting, removed query params, stronger typing for f…

…unc. params.
contentful · Jan 16, 2025 · 8d1e35e · 8d1e35e
1 parent c8582f4
commit 8d1e35e
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 16 deletions.
diff --git a/lib/adapters/REST/endpoints/function.ts b/lib/adapters/REST/endpoints/function.ts
@@ -1,18 +1,19 @@
 import type { AxiosInstance } from 'contentful-sdk-core'
 import * as raw from './raw'
-import { normalizeSelect } from './utils'
 import type {
   CollectionProp,
   GetFunctionForEnvParams,
   GetFunctionParams,
+  GetManyFunctionParams,
 } from '../../../common-types'
 import type { RestEndpoint } from '../types'
 import type { FunctionProps } from '../../../entities/function'
 
-const getBaseUrl = (params: GetFunctionParams) =>
+// Base URL
+const getManyUrl = (params: GetManyFunctionParams) =>
   `/organizations/${params.organizationId}/app_definitions/${params.appDefinitionId}/functions`
 
-const getFunctionUrl = (params: GetFunctionParams) => `${getBaseUrl(params)}/${params.functionId}`
+const getFunctionUrl = (params: GetFunctionParams) => `${getManyUrl(params)}/${params.functionId}`
 
 const getFunctionsEnvURL = (params: GetFunctionForEnvParams) => {
   return `/spaces/${params.spaceId}/environments/${params.environmentId}/app_installations/${params.appInstallationId}/functions`
@@ -27,9 +28,9 @@ export const get: RestEndpoint<'Function', 'get'> = (
 
 export const getMany: RestEndpoint<'Function', 'getMany'> = (
   http: AxiosInstance,
-  params: GetFunctionParams
+  params: GetManyFunctionParams
 ) => {
-  return raw.get<CollectionProp<FunctionProps>>(http, getBaseUrl(params))
+  return raw.get<CollectionProp<FunctionProps>>(http, getManyUrl(params))
 }
 
 export const getManyForEnvironment: RestEndpoint<'Function', 'getManyForEnvironment'> = (

diff --git a/lib/common-types.ts b/lib/common-types.ts
@@ -1549,7 +1549,7 @@ export type MRActions = {
   }
   Function: {
     get: { params: GetFunctionParams; return: FunctionProps }
-    getMany: { params: GetFunctionParams; return: CollectionProp<FunctionProps> }
+    getMany: { params: GetManyFunctionParams; return: CollectionProp<FunctionProps> }
     getManyForEnvironment: {
       params: GetFunctionForEnvParams
       return: CollectionProp<FunctionProps>
@@ -2148,7 +2148,8 @@ export type GetEditorInterfaceParams = GetSpaceEnvironmentParams & { contentType
 export type GetEntryParams = GetSpaceEnvironmentParams & { entryId: string }
 export type GetExtensionParams = GetSpaceEnvironmentParams & { extensionId: string }
 export type GetEnvironmentTemplateParams = GetOrganizationParams & { environmentTemplateId: string }
-export type GetFunctionParams = GetAppDefinitionParams & { functionId?: string }
+export type GetFunctionParams = GetAppDefinitionParams & { functionId: string }
+export type GetManyFunctionParams = GetAppDefinitionParams
 export type GetFunctionForEnvParams = GetSpaceParams & { environmentId: string } & {
   appInstallationId: string
 }

diff --git a/lib/entities/bulk-action.ts b/lib/entities/bulk-action.ts
@@ -33,7 +33,7 @@ export enum BulkActionStatus {
 }
 
 const STATUSES = Object.values(BulkActionStatus)
-type BulkActionStatuses = typeof STATUSES[number]
+type BulkActionStatuses = (typeof STATUSES)[number]
 
 interface BulkActionFailedError {
   sys: { type: 'Error'; id: 'BulkActionFailed' }

diff --git a/lib/entities/resource-type.ts b/lib/entities/resource-type.ts
@@ -54,7 +54,7 @@ type OptionalSysFields =
 
 export type SpaceEnvResourceTypeProps = Pick<
   ResourceTypeProps,
-  typeof publicResourceTypeFields[number]
+  (typeof publicResourceTypeFields)[number]
 > & {
   // we mark timestamps and users as optional to include system types like `Contentful:Entry` into the public response
   sys: Partial<Pick<ResourceTypeProps['sys'], OptionalSysFields>> &

diff --git a/lib/plain/common-types.ts b/lib/plain/common-types.ts
@@ -49,7 +49,6 @@ import type {
   EnvironmentTemplateValidationProps,
   ValidateEnvironmentTemplateInstallationProps,
 } from '../entities/environment-template-installation'
-import type { FunctionProps } from '../entities/function'
 import type {
   CreateOrganizationInvitationProps,
   OrganizationInvitationProps,

diff --git a/lib/plain/entities/function.ts b/lib/plain/entities/function.ts
@@ -2,7 +2,7 @@ import type {
   CollectionProp,
   GetFunctionParams,
   GetFunctionForEnvParams,
-  QueryParams,
+  GetManyFunctionParams,
 } from '../../common-types'
 import type { FunctionProps } from '../../entities/function'
 import type { OptionalDefaults } from '../wrappers/wrap'
@@ -37,9 +37,7 @@ export type FunctionPlainClientAPI = {
    * });
    * ```
    */
-  getMany(
-    params: OptionalDefaults<GetFunctionParams & QueryParams>
-  ): Promise<CollectionProp<FunctionProps>>
+  getMany(params: OptionalDefaults<GetManyFunctionParams>): Promise<CollectionProp<FunctionProps>>
 
   /**
    * Fetches all functions for the given environment
@@ -56,6 +54,6 @@ export type FunctionPlainClientAPI = {
    * ```
    */
   getManyForEnvironment(
-    params: OptionalDefaults<GetFunctionForEnvParams & QueryParams>
+    params: OptionalDefaults<GetFunctionForEnvParams>
   ): Promise<CollectionProp<FunctionProps>>
 }
diff --git a/test/unit/mocks/entities.ts b/test/unit/mocks/entities.ts
@@ -1255,7 +1255,7 @@ const mocks = {
   workflowsChangelogEntry: workflowsChangelogEntryMock,
 }
 
-function cloneMock<T extends keyof typeof mocks>(name: T): typeof mocks[T] {
+function cloneMock<T extends keyof typeof mocks>(name: T): (typeof mocks)[T] {
   return cloneDeep(mocks[name])
 }