feat: add upload credentials api to client [] (#2465)

* feat: add upload cred to client []

* chore: add upload cred entity

* chore: update base url

* chore: fix test

* chore: add e2e test

* chore: update endpoint

Author: 2wce

lib/adapters/REST/endpoints/index.ts

@@ -1,15 +1,16 @@
+import * as AccessToken from './access-token'
 import * as ApiKey from './api-key'
+import * as AppAccessToken from './app-access-token'
 import * as AppAction from './app-action'
 import * as AppActionCall from './app-action-call'
 import * as AppBundle from './app-bundle'
 import * as AppDefinition from './app-definition'
 import * as AppDetails from './app-details'
+import * as AppEventSubscription from './app-event-subscription'
 import * as AppInstallation from './app-installation'
+import * as AppKey from './app-key'
 import * as AppSignedRequest from './app-signed-request'
 import * as AppSigningSecret from './app-signing-secret'
-import * as AppEventSubscription from './app-event-subscription'
-import * as AppKey from './app-key'
-import * as AppAccessToken from './app-access-token'
 import * as AppUpload from './app-upload'
 import * as Asset from './asset'
 import * as AssetKey from './asset-key'
@@ -31,7 +32,6 @@ import * as Organization from './organization'
 import * as OrganizationInvitation from './organization-invitation'
 import * as OrganizationMembership from './organization-membership'
 import * as PersonalAccessToken from './personal-access-token'
-import * as AccessToken from './access-token'
 import * as PreviewApiKey from './preview-api-key'
 import * as Release from './release'
 import * as ReleaseAction from './release-action'
@@ -51,6 +51,7 @@ import * as TeamMembership from './team-membership'
 import * as TeamSpaceMembership from './team-space-membership'
 import * as UIConfig from './ui-config'
 import * as Upload from './upload'
+import * as UploadCredential from './upload-credentials'
 import * as Usage from './usage'
 import * as User from './user'
 import * as UserUIConfig from './user-ui-config'
@@ -113,6 +114,7 @@ export default {
   TeamSpaceMembership,
   UIConfig,
   Upload,
+  UploadCredential,
   Usage,
   User,
   UserUIConfig,

lib/adapters/REST/endpoints/upload-credentials.ts

@@ -0,0 +1,21 @@
+import type { AxiosInstance } from 'contentful-sdk-core'
+import type { GetSpaceEnvironmentParams } from '../../../common-types'
+import { getUploadHttpClient } from '../../../upload-http-client'
+import type { RestEndpoint } from '../types'
+import * as raw from './raw'
+
+const getBaseUrl = (params: GetSpaceEnvironmentParams) => {
+  return `/spaces/${params.spaceId}/environments/${
+    params.environmentId ?? 'master'
+  }/upload_credentials`
+}
+
+export const create: RestEndpoint<'UploadCredential', 'create'> = (
+  http: AxiosInstance,
+  params: GetSpaceEnvironmentParams
+) => {
+  const httpUpload = getUploadHttpClient(http)
+
+  const path = getBaseUrl(params)
+  return raw.post(httpUpload, path)
+}

lib/common-types.ts

@@ -1,23 +1,47 @@
 import type { RawAxiosRequestConfig, RawAxiosRequestHeaders } from 'axios'
 import type { OpPatch } from 'json-patch'
 import type { Stream } from 'stream'
+import type {
+  AccessTokenProps,
+  CreatePersonalAccessTokenProps as CreatePATProps,
+} from './entities/access-token'
+import type { ApiKeyProps, CreateApiKeyProps } from './entities/api-key'
 import type { AppActionProps, CreateAppActionProps } from './entities/app-action'
 import type {
   AppActionCallProps,
   AppActionCallResponse,
   CreateAppActionCallProps,
 } from './entities/app-action-call'
 import type { AppBundleProps, CreateAppBundleProps } from './entities/app-bundle'
-import type { ApiKeyProps, CreateApiKeyProps } from './entities/api-key'
-import type { AppDefinitionProps, CreateAppDefinitionProps } from './entities/app-definition'
+import type {
+  AppDefinitionProps,
+  AppInstallationsForOrganizationProps,
+  CreateAppDefinitionProps,
+} from './entities/app-definition'
+import type { AppDetailsProps, CreateAppDetailsProps } from './entities/app-details'
 import type { AppInstallationProps, CreateAppInstallationProps } from './entities/app-installation'
+import type {
+  AppSignedRequestProps,
+  CreateAppSignedRequestProps,
+} from './entities/app-signed-request'
+import type {
+  AppSigningSecretProps,
+  CreateAppSigningSecretProps,
+} from './entities/app-signing-secret'
+import type { AppUploadProps } from './entities/app-upload'
 import type {
   AssetFileProp,
   AssetProcessingForLocale,
   AssetProps,
   CreateAssetProps,
 } from './entities/asset'
-import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type'
+import type { AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key'
+import type {
+  BulkActionProps,
+  BulkActionPublishPayload,
+  BulkActionUnpublishPayload,
+  BulkActionValidatePayload,
+} from './entities/bulk-action'
 import type {
   CommentProps,
   CreateCommentParams,
@@ -32,15 +56,16 @@ import type {
   UpdateCommentParams,
   UpdateCommentProps,
 } from './entities/comment'
+import type { ContentTypeProps, CreateContentTypeProps } from './entities/content-type'
 import type { EditorInterfaceProps } from './entities/editor-interface'
 import type { CreateEntryProps, EntryProps, EntryReferenceProps } from './entities/entry'
 import type { CreateEnvironmentProps, EnvironmentProps } from './entities/environment'
 import type {
   CreateEnvironmentAliasProps,
   EnvironmentAliasProps,
 } from './entities/environment-alias'
+import type { CreateExtensionProps, ExtensionProps } from './entities/extension'
 import type { CreateLocaleProps, LocaleProps } from './entities/locale'
-import type { AppInstallationsForOrganizationProps } from './entities/app-definition'
 import type { OrganizationProps } from './entities/organization'
 import type {
   CreateOrganizationInvitationProps,
@@ -51,11 +76,18 @@ import type {
   CreatePersonalAccessTokenProps,
   PersonalAccessTokenProps,
 } from './entities/personal-access-token'
-import type {
-  AccessTokenProps,
-  CreatePersonalAccessTokenProps as CreatePATProps,
-} from './entities/access-token'
 import type { PreviewApiKeyProps } from './entities/preview-api-key'
+import type {
+  ReleasePayload,
+  ReleaseProps,
+  ReleaseQueryOptions,
+  ReleaseValidatePayload,
+} from './entities/release'
+import type {
+  ReleaseAction,
+  ReleaseActionProps,
+  ReleaseActionQueryOptions,
+} from './entities/release-action'
 import type { CreateRoleProps, RoleProps } from './entities/role'
 import type { ScheduledActionProps } from './entities/scheduled-action'
 import type { SnapshotProps } from './entities/snapshot'
@@ -69,7 +101,6 @@ import type {
   CreateTeamSpaceMembershipProps,
   TeamSpaceMembershipProps,
 } from './entities/team-space-membership'
-import type { CreateExtensionProps, ExtensionProps } from './entities/extension'
 import type { UsageProps } from './entities/usage'
 import type { UserProps } from './entities/user'
 import type {
@@ -83,34 +114,6 @@ import type {
   WebhookRetryPolicyProps,
   WebhookSigningSecretProps,
 } from './entities/webhook'
-import type { AssetKeyProps, CreateAssetKeyProps } from './entities/asset-key'
-import type { AppUploadProps } from './entities/app-upload'
-import type { AppDetailsProps, CreateAppDetailsProps } from './entities/app-details'
-import type {
-  AppSignedRequestProps,
-  CreateAppSignedRequestProps,
-} from './entities/app-signed-request'
-import type {
-  AppSigningSecretProps,
-  CreateAppSigningSecretProps,
-} from './entities/app-signing-secret'
-import type {
-  BulkActionProps,
-  BulkActionPublishPayload,
-  BulkActionUnpublishPayload,
-  BulkActionValidatePayload,
-} from './entities/bulk-action'
-import type {
-  ReleasePayload,
-  ReleaseProps,
-  ReleaseQueryOptions,
-  ReleaseValidatePayload,
-} from './entities/release'
-import type {
-  ReleaseAction,
-  ReleaseActionProps,
-  ReleaseActionQueryOptions,
-} from './entities/release-action'
 
 import type {
   CreateTaskParams,
@@ -121,27 +124,14 @@ import type {
   UpdateTaskProps,
 } from './entities/task'
 
+import type { AppAccessTokenProps, CreateAppAccessTokenProps } from './entities/app-access-token'
 import type {
-  CreateWorkflowDefinitionParams,
-  CreateWorkflowDefinitionProps,
-  DeleteWorkflowDefinitionParams,
-  WorkflowDefinitionProps,
-  WorkflowDefinitionQueryOptions,
-} from './entities/workflow-definition'
-import type {
-  CompleteWorkflowParams,
-  CreateWorkflowParams,
-  CreateWorkflowProps,
-  DeleteWorkflowParams,
-  WorkflowProps,
-  WorkflowQueryOptions,
-} from './entities/workflow'
-import type {
-  WorkflowsChangelogEntryProps,
-  WorkflowsChangelogQueryOptions,
-} from './entities/workflows-changelog-entry'
-import type { UIConfigProps } from './entities/ui-config'
-import type { UserUIConfigProps } from './entities/user-ui-config'
+  AppEventSubscriptionProps,
+  CreateAppEventSubscriptionProps,
+} from './entities/app-event-subscription'
+import type { AppKeyProps, CreateAppKeyProps } from './entities/app-key'
+import type { ConceptProps, CreateConceptProps } from './entities/concept'
+import type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme'
 import type {
   CreateEnvironmentTemplateProps,
   EnvironmentTemplateProps,
@@ -153,14 +143,7 @@ import type {
   ValidateEnvironmentTemplateInstallationProps,
 } from './entities/environment-template-installation'
 import type { FunctionProps } from './entities/function'
-import type {
-  AppEventSubscriptionProps,
-  CreateAppEventSubscriptionProps,
-} from './entities/app-event-subscription'
-import type { AppKeyProps, CreateAppKeyProps } from './entities/app-key'
-import type { AppAccessTokenProps, CreateAppAccessTokenProps } from './entities/app-access-token'
-import type { ConceptProps, CreateConceptProps } from './entities/concept'
-import type { ConceptSchemeProps, CreateConceptSchemeProps } from './entities/concept-scheme'
+import type { ResourceProps, ResourceQueryOptions } from './entities/resource'
 import type {
   ResourceProviderProps,
   UpsertResourceProviderProps,
@@ -170,7 +153,27 @@ import type {
   SpaceEnvResourceTypeProps,
   UpsertResourceTypeProps,
 } from './entities/resource-type'
-import type { ResourceProps, ResourceQueryOptions } from './entities/resource'
+import type { UIConfigProps } from './entities/ui-config'
+import type { UserUIConfigProps } from './entities/user-ui-config'
+import type {
+  CompleteWorkflowParams,
+  CreateWorkflowParams,
+  CreateWorkflowProps,
+  DeleteWorkflowParams,
+  WorkflowProps,
+  WorkflowQueryOptions,
+} from './entities/workflow'
+import type {
+  CreateWorkflowDefinitionParams,
+  CreateWorkflowDefinitionProps,
+  DeleteWorkflowDefinitionParams,
+  WorkflowDefinitionProps,
+  WorkflowDefinitionQueryOptions,
+} from './entities/workflow-definition'
+import type {
+  WorkflowsChangelogEntryProps,
+  WorkflowsChangelogQueryOptions,
+} from './entities/workflows-changelog-entry'
 
 export interface DefaultElements<TPlainObject extends object = object> {
   toPlainObject(): TPlainObject
@@ -724,6 +727,8 @@ type MRInternal<UA extends boolean> = {
   (opts: MROpts<'Upload', 'create', UA>): MRReturn<'Entry', 'create'>
   (opts: MROpts<'Upload', 'delete', UA>): MRReturn<'Entry', 'delete'>
 
+  (opts: MROpts<'UploadCredential', 'create', UA>): MRReturn<'UploadCredential', 'create'>
+
   (opts: MROpts<'Usage', 'getManyForSpace', UA>): MRReturn<'Usage', 'getManyForSpace'>
   (opts: MROpts<'Usage', 'getManyForOrganization', UA>): MRReturn<'Usage', 'getManyForOrganization'>
 
@@ -1877,6 +1882,12 @@ export type MRActions = {
     }
     delete: { params: GetSpaceEnvironmentUploadParams; return: any }
   }
+  UploadCredential: {
+    create: {
+      params: GetSpaceEnvironmentParams
+      return: any
+    }
+  }
   Usage: {
     getManyForSpace: {
       params: { organizationId: string } & QueryParams

lib/enhance-with-methods.ts

@@ -13,7 +13,6 @@ export default function enhanceWithMethods<
   B extends Record<string, unknown>,
   M extends Record<string, Function>
 >(baseObject: B, methodsObject: M): M & B {
-  // @ts-expect-error
   return Object.keys(methodsObject).reduce((enhancedObject, methodName) => {
     Object.defineProperty(enhancedObject, methodName, {
       enumerable: false,
@@ -22,5 +21,5 @@ export default function enhanceWithMethods<
       value: methodsObject[methodName],
     })
     return enhancedObject
-  }, baseObject)
+  }, baseObject as M & B)
 }

lib/entities/upload-credential.ts

@@ -0,0 +1,71 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core'
+import copy from 'fast-copy'
+import type { DefaultElements, MakeRequest, MetaSysProps, SysLink } from '../common-types'
+import enhanceWithMethods from '../enhance-with-methods'
+
+export type UploadCredentialProps = {
+  /**
+   * System metadata
+   */
+  sys: MetaSysProps & { space: SysLink; environment?: SysLink }
+}
+
+export interface UploadCredential
+  extends UploadCredentialProps,
+    DefaultElements<UploadCredentialProps> {
+  /**
+   * Deletes this object on the server.
+   * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
+   * @example
+   * const contentful = require('contentful-management')
+   *
+   * const client = contentful.createClient({
+   *   accessToken: '<content_management_api_key>'
+   * })
+   *
+   * client.getSpace('<space_id>')
+   * .then((space) => space.getEnvironment('<environment_id>'))
+   * .then((environment) => environment.getUpload('<upload_id>'))
+   * .then((upload) => upload.delete())
+   * .then((upload) => console.log(`upload ${upload.sys.id} updated.`))
+   * .catch(console.error)
+   */
+  create(): Promise<UploadCredentialProps>
+}
+
+/**
+ * @private
+ */
+function createUploadCredentialsApi(makeRequest: MakeRequest) {
+  return {
+    create: async function create() {
+      const raw = this.toPlainObject() as UploadCredentialProps
+      return makeRequest({
+        entityType: 'UploadCredential',
+        action: 'create',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+        },
+      })
+    },
+  }
+}
+
+/**
+ * @private
+ * @param {function} makeRequest - function to make requests via an adapter
+ * @param {object} data - Raw upload credential data
+ * @return {UploadCredential} Wrapped upload credential data
+ */
+export function wrapUploadCredential(
+  makeRequest: MakeRequest,
+  data: UploadCredentialProps
+): UploadCredential {
+  const uploadCredential = toPlainObject(copy(data))
+  const uploadCredentialWithMethods = enhanceWithMethods(
+    uploadCredential,
+    createUploadCredentialsApi(makeRequest)
+  )
+  return freezeSys(uploadCredentialWithMethods)
+}