npmpackage.info

@commercetools/ts-client

The e-commerce SDK from commercetools for JavaScript written in TypeScript.

3.0.1

MIT

TypeScript

330.30 kB

1,737,168 5

Installations

npm install @commercetools/ts-client

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Min. Node Version

>=18

Node Version

20.18.1

NPM Version

10.8.2 Pull Requests

Open

13

Total

770

Closed

75

Merged

682

Issues

Open

3

Total

147

Closed

144

Releases

233

@commercetools/ts-client@3.0.3

Published on 29 Jan 2025

@commercetools/ts-client@3.0.2

Published on 24 Jan 2025

@commercetools/history-sdk@5.1.0

Published on 15 Jan 2025

@commercetools/platform-sdk@8.1.0

Published on 15 Jan 2025

@commercetools/ts-sdk-apm@3.1.0

Published on 15 Jan 2025

@commercetools/ts-client@3.0.1

Published on 15 Jan 2025

View all 233 releases

Contributors

340

View all 340 contributors

Languages

TypeScript

JavaScript

Makefile

Shell

TypeScript (99.83%)

JavaScript (0.13%)

Makefile (0.04%)

Shell (0.01%)

Developer

commercetools

Download Statistics

Total Downloads

1,737,168

Last Day

9,486

Last Week

46,944

Last Month

196,258

Last Year

1,699,839

GitHub Statistics

53 Stars

912 Commits

26 Forks

44 Watching

26 Branches

340 Contributors

Maintainers

Package Meta Information

Latest Version

3.0.1

Package Id

@commercetools/ts-client@3.0.1

Unpacked Size

330.30 kB

Size

74.62 kB

File Count

NPM Version

10.8.2

Node Version

20.18.1

Publised On

15 Jan 2025

Total Downloads

Cumulative downloads

Total Downloads

1,737,168

Last day

-21.7%

9,486

Compared to previous day

Last week

-15.6%

46,944

Compared to previous week

Last month

4.3%

196,258

Compared to previous month

Last year

4,522.8%

1,699,839

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

buffer

Dev Dependencies

common-tags dotenv jest nock organize-imports-cli

Versions

Commercetools Composable Commerce (Improved) TypeScript SDK client

This is the new and improved Typescript SDK client.

Usage examples

1npm install --save @commercetools/ts-client
2npm install --save @commercetools/platform-sdk
3
4or
5
6yarn add @commercetools/ts-client
7yarn add @commercetools/platform-sdk

1import {
2  type Next,
3  type HttpMiddlewareOptions,
4  type AuthMiddlewareBaseOptions,
5  type ClientRequest,
6  type MiddlewareRequest,
7  type MiddlewareResponse,
8  type Client,
9  createHttpMiddleware,
10  createConcurrentModificationMiddleware,
11  createAuthMiddlewareForClientCredentialsFlow,
12  ClientBuilder,
13} from '@commercetools/ts-client'
14import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
15
16const projectKey = 'mc-project-key'
17const authMiddlewareOptions = {
18  host: 'https://auth.europe-west1.gcp.commercetools.com',
19  projectKey,
20  credentials: {
21    clientId: 'mc-client-id',
22    clientSecret: 'mc-client-secrets',
23  },
24  oauthUri: '/oauth/token', // - optional: custom oauthUri
25  scopes: [`manage_project:${projectKey}`],
26  httpClient: fetch,
27}
28
29const httpMiddlewareOptions = {
30  host: 'https://api.europe-west1.gcp.commercetools.com',
31  httpClient: fetch,
32}
33
34const retryOptions = {
35  maxRetries: 3,
36  retryDelay: 200,
37  backoff: true,
38  retryCodes: [503],
39}
40
41const loggerFn = (response) => {
42  // log response object
43  console.log(response)
44}
45
46// custom middleware
47function middleware(options) {
48  return (next: Next) =>
49    async (request: MiddlewareRequest): Promise<MiddlewareResponse> => {
50      const { response, ...rest } = request
51
52      // other actions can also be carried out here e.g logging,
53      // error handling, injecting custom headers to http requests etc.
54      console.log({ response, rest })
55      return next({ ...request })
56    }
57}
58
59const client: Client = new ClientBuilder()
60  .withPasswordFlow(authMiddlewareOptions)
61  .withLoggerMiddleware({ loggerFn })
62  .withCorrelationIdMiddleware({
63    generate: () => 'fake-correlation-id' + Math.floor(Math.random() + 2),
64  })
65  .withHttpMiddleware(httpMiddlewareOptions)
66  .withMiddleware(middleware({})) // <<<------------------- add the custom middleware here
67  .build()
68
69const apiRoot = createApiBuilderFromCtpClient(client)
70
71// calling the Composable Commerce `api` functions
72// get project details
73apiRoot
74  .withProjectKey({ projectKey })
75  .get()
76  .execute()
77  .then((x) => {
78    /*...*/
79  })
80
81// create a productType
82apiRoot
83  .withProjectKey({ projectKey })
84  .productTypes()
85  .post({
86    body: { name: 'product-type-name', description: 'some description' },
87  })
88  .execute()
89  .then((x) => {
90    /*...*/
91  })
92
93// create a product
94apiRoot
95  .withProjectKey({ projectKey })
96  .products()
97  .post({
98    body: {
99      name: { en: 'our-great-product-name' },
100      productType: {
101        typeId: 'product-type',
102        id: 'some-product-type-id',
103      },
104      slug: { en: 'some-slug' },
105    },
106  })
107  .execute()
108  .then((x) => {
109    /*...*/
110  })

Create a client

To create a client, use the ClientBuilder class. The ClientBuilder class provides a fluent API to configure the client.

1const authMiddlewareOptions = {
2  credentials: {
3    clientId: 'xxx',
4    clientSecret: 'xxx',
5  },
6  host: 'https://auth.europe-west1.gcp.commercetools.com',
7  projectKey: 'xxx',
8}
9
10const httpMiddlewareOptions = {
11  host: 'https://api.europe-west1.gcp.commercetools.com',
12  httpClient: fetch,
13}
14
15const client = new ClientBuilder()
16  .withHttpMiddleware(httpMiddlewareOptions)
17  .withConcurrentModificationMiddleware()
18  .withClientCredentialsFlow(authMiddlewareOptions)
19  .build()

The withMiddleware method can be used to add middleware functions (both built-in and custom middleware) in an ordered fashion.

1// Example
2const authMiddlewareOptions = {
3  credentials: {
4    clientId: 'xxx',
5    clientSecret: 'xxx',
6  },
7  host: 'https://auth.europe-west1.gcp.commercetools.com',
8  projectKey: 'xxx',
9}
10
11const httpMiddlewareOptions = {
12  host: 'https://api.europe-west1.gcp.commercetools.com',
13  httpClient: fetch,
14}
15
16const logger = () => {
17  return (next) => async (request) => {
18    // log request object
19    console.log('Request:', request)
20    const response = await next(request)
21
22    // log response object
23    console.log('Response', response)
24    return response
25  }
26}
27
28const client = new ClientBuilder()
29  .withMiddleware(
30    createAuthMiddlewareForClientCredentialsFlow(authMiddlewareOptions)
31  )
32  .withMiddleware(createHttpMiddleware(httpMiddlewareOptions))
33  .withMiddleware(createConcurrentModificationMiddleware())
34  .withMiddleware(logger())
35  .build()

This will add the middleware in an ordered fashion starting with the:

createAuthMiddlewareForClientCredentialsFlow
createHttpMiddleware
createConcurrentModificationMiddleware
logger

Note that when using the withMiddleware function to add a custom middleware along side other in built middleware functions, it will add the custom middleware to the start of the execution chain.

1// Example
2const authMiddlewareOptions = {
3  credentials: {
4    clientId: 'xxx',
5    clientSecret: 'xxx',
6  },
7  host: 'https://auth.europe-west1.gcp.commercetools.com',
8  projectKey: 'xxx',
9}
10
11const httpMiddlewareOptions = {
12  host: 'https://api.europe-west1.gcp.commercetools.com',
13  httpClient: fetch,
14}
15
16const logger = () => {
17  return (next) => async (request) => {
18    // log request object
19    console.log('Request:', request)
20    const response = await next(request)
21
22    // log response object
23    console.log('Response', response)
24    return response
25  }
26}
27
28const client = new ClientBuilder()
29  .withClientCredentialsFlow(authMiddlewareOptions)
30  .withHttpMiddleware(httpMiddlewareOptions)
31  .withConcurrentModificationMiddleware()
32  .withMiddleware(logger())
33  .build()

The order of execution is as follows:

withMiddleware <------ the custom middleware
withClientCredentialsFlow
withHttpMiddleware
withConcurrentModificationMiddleware

No vulnerabilities found.

10

Maintained

Determines if the project is "actively maintained".

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

6

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

3

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

2

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

Reason

dependency not pinned by hash detected -- score normalized to 2

Details

Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/create-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/create-pr.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/create-pr.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:43: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/docs.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/docs.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:30: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:42: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:74: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:90: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:98: update your workflow using https://app.stepsecurity.io/secureworkflow/commercetools/commercetools-sdk-typescript/release.yml/master?enable=pin
Warn: containerImage not pinned by hash: examples/datadog-express-apm/container-agent/Dockerfile:1: pin your Docker image by updating node:18-alpine to node:18-alpine@sha256:974afb6cbc0314dc6502b14243b8a39fbb2d04d975e9059dd066be3e274fbb25
Info: 0 out of 11 GitHub-owned GitHubAction dependencies pinned
Info: 3 out of 7 third-party GitHubAction dependencies pinned
Info: 0 out of 1 containerImage dependencies pinned

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

5

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More