npmpackage.info

@commercetools/sdk-client-v2

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

3.0.0

MIT

TypeScript

320.85 kB

8,694,325 5

Installations

npm install @commercetools/sdk-client-v2

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS, UMD

Min. Node Version

>=18

Node Version

20.18.0

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

8,694,325

Last Day

18,830

Last Week

79,371

Last Month

322,112

Last Year

4,086,708

GitHub Statistics

53 Stars

912 Commits

26 Forks

44 Watching

26 Branches

340 Contributors

Maintainers

Package Meta Information

Latest Version

3.0.0

Package Id

@commercetools/sdk-client-v2@3.0.0

Unpacked Size

320.85 kB

Size

78.47 kB

File Count

NPM Version

10.8.2

Node Version

20.18.0

Publised On

08 Jan 2025

Total Downloads

Cumulative downloads

Total Downloads

8,694,325

Last day

7.3%

18,830

Compared to previous day

Last week

-6.8%

79,371

Compared to previous week

Last month

8.6%

322,112

Compared to previous month

Last year

21.7%

4,086,708

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 TypeScript SDK client

Usage examples

Browser environment

1<script src="https://unpkg.com/@commercetools/sdk-client-v2@latest/dist/commercetools-sdk-client-v2.umd.js"></script>
2<script src="https://unpkg.com/@commercetools/platform-sdk@latest/dist/commercetools-platform-sdk.umd.js"></script>

1<script>
2  // global: @commercetools/sdk-client-v2
3  // global: @commercetools/platform-sdk
4  ;(function () {
5    //  We can now access the sdk-client-v2 and platform-sdk object as:
6    //  const { ClientBuilder } = this['@commercetools/sdk-client-v2']
7    //  const { createApiBuilderFromCtpClient } = this['@commercetools/platform-sdk']
8    //  or
9    //  const { ClientBuilder } = window['@commercetools/sdk-client-v2']
10    //  const { createApiBuilderFromCtpClient } = window['@commercetools/platform-sdk']
11  })()
12</script>

See full usage example here

Node environment

1npm install --save @commercetools/sdk-client-v2
2npm install --save @commercetools/platform-sdk

1const {
2  ClientBuilder,
3  createAuthForClientCredentialsFlow,
4  createHttpClient,
5} = require('@commercetools/sdk-client-v2')
6const { createApiBuilderFromCtpClient } = require('@commercetools/platform-sdk')
7
8const projectKey = 'mc-project-key'
9const authMiddlewareOptions = {
10  host: 'https://auth.europe-west1.gcp.commercetools.com',
11  projectKey,
12  credentials: {
13    clientId: 'mc-client-id',
14    clientSecret: 'mc-client-secrets',
15  },
16  oauthUri: '/oauth/token', // - optional: custom oauthUri
17  scopes: [`manage_project:${projectKey}`],
18  fetch,
19}
20
21const httpMiddlewareOptions = {
22  host: 'https://api.europe-west1.gcp.commercetools.com',
23  fetch,
24}
25
26const client = new ClientBuilder()
27  .withProjectKey(projectKey)
28  .withMiddleware(createAuthForClientCredentialsFlow(authMiddlewareOptions))
29  .withMiddleware(createHttpClient(httpMiddlewareOptions))
30  .withUserAgentMiddleware()
31  .build()
32
33// or
34const client = new ClientBuilder()
35  .withProjectKey(projectKey)
36  .withClientCredentialsFlow(authMiddlewareOptions)
37  .withHttpMiddleware(httpMiddlewareOptions)
38  .withUserAgentMiddleware()
39  .build()
40
41const apiRoot = createApiBuilderFromCtpClient(client)
42
43// calling the Composable Commerce functions
44// get project details
45apiRoot
46  .withProjectKey({
47    projectKey,
48  })
49  .get()
50  .execute()
51  .then((x) => {
52    /*...*/
53  })
54
55// create a productType
56apiRoot
57  .withProjectKey({ projectKey })
58  .productTypes()
59  .post({
60    body: { name: 'product-type-name', description: 'some description' },
61  })
62  .execute()
63  .then((x) => {
64    /*...*/
65  })
66
67// create a product
68apiRoot
69  .withProjectKey({ projectKey })
70  .products()
71  .post({
72    body: {
73      name: { en: 'our-great-product-name' },
74      productType: {
75        typeId: 'product-type',
76        id: 'some-product-type-id',
77      },
78      slug: { en: 'some-slug' },
79    },
80  })
81  .execute()
82  .then((x) => {
83    /*...*/
84  })
85
86// -----------------------------------------------------------------------
87// The sdk-client-v2 also has support for the old syntax
88import {
89  createClient,
90  createHttpClient,
91  createAuthForClientCredentialsFlow,
92} from '@commercetools/sdk-client-v2'
93import { createApiBuilderFromCtpClient } from '@commercetools/platform-sdk'
94
95const projectKey = 'some_project_key'
96
97const authMiddleware = createAuthForClientCredentialsFlow({
98  host: 'https://auth.europe-west1.gcp.commercetools.com',
99  projectKey,
100  credentials: {
101    clientId: 'some_id',
102    clientSecret: 'some_secret',
103  },
104  fetch,
105})
106
107const httpMiddleware = createHttpClient({
108  host: 'https://api.europe-west1.gcp.commercetools.com',
109  fetch,
110})
111
112const ctpClient = createClient({
113  middlewares: [authMiddleware, httpMiddleware],
114})
115
116const apiRoot = createApiBuilderFromCtpClient(ctpClient)
117
118apiRoot
119  .withProjectKey({
120    projectKey,
121  })
122  .get()
123  .execute()
124  .then((x) => {
125    /*...*/
126  })
127
128apiRoot
129  .withProjectKey({ projectKey })
130  .productTypes()
131  .post({
132    body: { name: 'product-type-name', description: 'some description' },
133  })
134  .execute()
135  .then((x) => {
136    /*...*/
137  })
138
139apiRoot
140  .withProjectKey({ projectKey })
141  .products()
142  .post({
143    body: {
144      name: { en: 'our-great-product-name' },
145      productType: {
146        typeId: 'product-type',
147        id: 'some-product-type-id',
148      },
149      slug: { en: 'some-slug' },
150    },
151  })
152  .execute()
153  .then((x) => {
154    /*...*/
155  })

See full usage example here

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