chore(docs): update naming to match new branding initiative (#261)

* chore(docs): update naming to match new branding initiative - use Composable Commere in most places - use commercetools Composable Commere when it makes better sense * Update packages/history-sdk/package.json Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> * Update CONTRIBUTING.md Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> * chore(rebranding): more rebranding - change platform to system - rebrand unseen comments * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update LICENSE Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/platform-sdk/README.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update CONTRIBUTING.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/sdk-client/README.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/platform-sdk/package.json Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/ml-sdk/package.json Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/importapi-sdk/package.json Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update examples/me/server/src/app.ts Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update packages/history-sdk/package.json Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * chore(rebranding): uppercase "API" and "ME" endpoint * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> * Update GenerateSDK.md Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com> Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> Co-authored-by: Melinda Fekete <melinda.fekete@commercetools.com>
commercetools · May 18, 2022 · c605309 · c605309
1 parent 55bd23f
commit c605309
Show file tree

Hide file tree

Showing 17 changed files with 64 additions and 44 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -6,7 +6,7 @@ Please take a moment to review this document in order to make the contribution p
 
 ## Core ideas
 
-The repository primarily contains SDK packages in TypeScript generated from the commercetools platform API reference.
+The repository primarily contains SDK packages in TypeScript generated from the Composable Commerce API reference.
 
 ## Repository structure
 
@@ -68,7 +68,7 @@ Some useful commands to work with the repository:
 
 ## Adding changesets
 
-commercetools sdk-typescript uses [changesets](https://github.com/atlassian/changesets) to do versioning and creating changelogs.
+Composable Commerce Typescript SDK uses [changesets](https://github.com/atlassian/changesets) to do versioning and creating changelogs.
 
 As a contributor you need to add a changeset by running `yarn changeset`.
 The command will prompt to select the packages that should be bumped, their associated semver bump types and some markdown which will be inserted into the changelogs.
@@ -77,7 +77,7 @@ When opening a Pull Request, a `changeset-bot` checks that the Pull Request cont
 
 ## Releasing packages
 
-commercetools sdk-typescript uses [changesets](https://github.com/atlassian/changesets) to do versioning and publishing a release.
+Composable Commerce Typescript SDK uses [changesets](https://github.com/atlassian/changesets) to do versioning and publishing a release.
 
 A [Changesets release GitHub Action](https://github.com/changesets/action) opens a `Version Packages` Pull Request whenever there are some changesets that have not been released yet.
 

diff --git a/GenerateSDK.md b/GenerateSDK.md
@@ -1,6 +1,6 @@
-# commercetools-typescript-sdks Generation
+# Composable Commerce TypeScript SDKs Generation
 
-This repo contains commercetools SDKs and this is guide for how to generate the typescript SDK.
+This repo contains Composable Commerce SDKs and this is a guide on how to generate the Typescript SDK.
 
 ## Requirements
 
@@ -14,22 +14,22 @@ This repo contains commercetools SDKs and this is guide for how to generate the
 
 ## Generating the sdks
 
-run `yarn generate` to generate the sdks. (make sure the environement variables are set first)
+run `yarn generate` to generate the sdks. (make sure the environment variables are set first)
 
 ## Environment variables
 
-| Variable name |                                                    Description                                                    |
-| ------------- | :---------------------------------------------------------------------------------------------------------------: |
-| ML_API_REF    | The path to commercetools [machine learning RAML api](https://github.com/commercetools/ml-services-api-reference) |
-| API_RAML_FILE |        The path to commercetools [RAML api](https://github.com/commercetools/commercetools-api-reference)         |
+| Variable name |                                                         Description                                                          |
+| ------------- | :--------------------------------------------------------------------------------------------------------------------------: |
+| ML_API_REF    | The path to Composable Commerce [Machine Learning API reference](https://github.com/commercetools/ml-services-api-reference) |
+| API_RAML_FILE |           The path to Composable Commerce [HTTP API reference](https://github.com/commercetools/commercetools-api-reference)           |
 
 ## Test environnement variables
 
-| Variable name     |                                               Description                                                |
-| ----------------- | :------------------------------------------------------------------------------------------------------: |
-| CTP_PROJECT_KEY   |                                        commercetools project key                                         |
-| CTP_CLIENT_ID     |                                              the client id                                               |
-| CTP_CLIENT_SECRET |                                            the client secret                                             |
-| CTP_API_URL       |                              the api url (contains infos about the region)                               |
-| CTP_AUTH_URL      |                              the auth url (contains infos about the region)                              |
-| CTP_ML_API_URL    | the ml api uses a pattern a bit different from the platform, that needs to be used to access ml services |
+| Variable name     |                                                     Description                                                     |
+| ----------------- | :-----------------------------------------------------------------------------------------------------------------: |
+| CTP_PROJECT_KEY   |                                           Composable Commerce Project key                                           |
+| CTP_CLIENT_ID     |                                                    the client id                                                    |
+| CTP_CLIENT_SECRET |                                                  the client secret                                                  |
+| CTP_API_URL       |                                    the API url (contains infos about the region)                                    |
+| CTP_AUTH_URL      |                                   the auth url (contains infos about the region)                                    |
+| CTP_ML_API_URL    | the Machine Learning API uses a different pattern than the HTTP API, use this to access ML services |
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-<h2 align="center">commercetools TypeScript SDKs 💅</h2>
+<h2 align="center">Composable Commerce TypeScript SDKs 💅</h2>
 <p align="center">
-  <i>✨ Monorepository with generated TypeScript SDKs for the commercetools platform 🛠</i>
+  <i>✨ Monorepository with generated TypeScript SDKs for the Composable Commerce APIs 🛠</i>
 </p>
 <p align="center">
   <a href="https://circleci.com/gh/commercetools/commercetools-sdk-typescript">
@@ -17,7 +17,7 @@
 
 ## Introduction
 
-This repository contains several SDK packages generated from the commercetools platform API reference.
+This repository contains several SDK packages generated from the commercetools Composable Commerce API reference.
 
 ## Documentation
 

diff --git a/examples/me/README.md b/examples/me/README.md
@@ -4,9 +4,9 @@ Example to show how the ME endpoints can be used with the TypeScript SDK.
 
 ## Requirements
 
-- A commercetools Project with a configured [API Client](https://docs.commercetools.com/tutorials/getting-started#creating-an-api-client).
-- Your commercetools Project must have existing Products containing Variants, and at least one Customer.
-  - If your commercetools Project is currently empty, you can install the [SUNRISE sample data](https://docs.commercetools.com/sdk/sunrise-data).
+- A Composable Commerce Project with a configured [API Client](https://docs.commercetools.com/tutorials/getting-started#creating-an-api-client).
+- Your Project must have existing Products containing Variants, and at least one Customer.
+- If your Project is currently empty, you can install the [SUNRISE sample data](https://docs.commercetools.com/sdk/sunrise-data).
 
 ## Installation
 
@@ -29,7 +29,7 @@ CTP_CLIENT_SECRET={clientSecret}
 DEFAULT_CURRENCY=EUR
 ```
 
-6. Replace `{clientID}`, `{projectKey}`, and `{clientSecret}` with the respective values from your API Client. The `DEFAULT_CURRENCY` can be changed based on your commercetools Project settings.
+6. Replace `{clientID}`, `{projectKey}`, and `{clientSecret}` with the respective values from your API Client. The `DEFAULT_CURRENCY` can be changed based on your Composable Commerce Project settings.
 
 ## Using the ME Endpoint Checkout App
 
@@ -44,6 +44,7 @@ You should start the server before the client and keep both running in separate
 5. The server starts.
 
 ### Start the client
+
 1. Open a new Terminal
 2. Navigate to `examples/me/client`.
 3. Run `yarn install` (`npm` can also be used).

diff --git a/examples/me/server/src/app.ts b/examples/me/server/src/app.ts
@@ -38,7 +38,7 @@ app.use('/', routes)
 app.get('/home', async function (_, res) {
   res.status(200).json({
     status: 'success',
-    message: 'welocome to commercetools me endpoint demo app',
+    message: 'Welcome to Composable Commerce ME endpoint demo app',
   })
 })
 app.use('*', async (_, res: Response) => {

diff --git a/examples/me/server/src/repository/CartRepository.ts b/examples/me/server/src/repository/CartRepository.ts
@@ -73,7 +73,7 @@ class CartRepository implements ICart {
   private createCartUpdateDraft(
     cartUpdateDraft: CartUpdateDraft
   ): MyCartUpdate {
-    const action = 'addLineItem' // default value needed to tell the platform we are adding an item to cart
+    const action = 'addLineItem' // default value needed to tell the system we are adding an item to cart
     const { version, productId, variantId, quantity } = cartUpdateDraft
     return {
       version,
@@ -91,7 +91,7 @@ class CartRepository implements ICart {
   private createRemoveItemDraft(
     cartRemoveItemDraft: CartRemoveItemDraft
   ): MyCartRemoveItem {
-    const action = 'removeLineItem' // default value needed to tell the platform we are removing an item from the cart
+    const action = 'removeLineItem' // default value needed to tell the system we are removing an item from the cart
     const { version, lineItemId, quantity } = cartRemoveItemDraft
     return {
       version,

diff --git a/packages/history-sdk/README.md b/packages/history-sdk/README.md
@@ -1,4 +1,4 @@
-# Typescript SDK for commercetools Audit log (history) APIs.
+# Typescript SDK for Composable Commerce Audit log (history) APIs.
 
 ## Usage examples
 

diff --git a/packages/history-sdk/package.json b/packages/history-sdk/package.json
@@ -5,8 +5,14 @@
   },
   "name": "@commercetools/history-sdk",
   "version": "2.5.0",
-  "description": "Type script sdk for commercetools audit log features",
-  "keywords": ["commercetools", "typescript", "sdk", "history"],
+  "description": "Typescript SDK for Composable Commerce Audit Log features",
+  "keywords": [
+    "commercetools",
+    "composable commerce",
+    "typescript",
+    "sdk",
+    "history"
+  ],
   "homepage": "https://github.com/commercetools/commercetools-typescript-sdks/packages/history-sdk",
   "bugs": "https://github.com/commercetools/commercetools-typescript-sdks/issues",
   "repository": {

diff --git a/packages/importapi-sdk/README.md b/packages/importapi-sdk/README.md
@@ -1,4 +1,4 @@
-# Typescript SDK for commercetools import API
+# TypeScript SDK for commercetools Composable Commerce Import API
 
 ## Usage examples
 

diff --git a/packages/importapi-sdk/package.json b/packages/importapi-sdk/package.json
@@ -5,8 +5,14 @@
   },
   "name": "@commercetools/importapi-sdk",
   "version": "2.5.0",
-  "description": "Type script sdk for commercetools import features",
-  "keywords": ["commercetools", "typescript", "sdk", "import"],
+  "description": "TypeScript SDK for Composable Commerce Import API features",
+  "keywords": [
+    "commercetools",
+    "composable commerce",
+    "typescript",
+    "sdk",
+    "import"
+  ],
   "homepage": "https://github.com/commercetools/commercetools-sdk-typescript/packages/importapi-sdk",
   "bugs": "https://github.com/commercetools/commercetools-sdk-typescript/issues",
   "repository": {

diff --git a/packages/ml-sdk/README.md b/packages/ml-sdk/README.md
@@ -1,4 +1,4 @@
-# Typescript SDK for commercetools machine learning API
+# Typescript SDK for commercetools Composable Commerce Machine Learning API
 
 ## Usage examples
 

diff --git a/packages/ml-sdk/package.json b/packages/ml-sdk/package.json
@@ -5,8 +5,14 @@
   },
   "name": "@commercetools/ml-sdk",
   "version": "2.4.0",
-  "description": "Type script sdk for commercetools ML features",
-  "keywords": ["commercetools", "typescript", "sdk", "ml"],
+  "description": "TypeScript SDK for Composable Commerce Machine Learning features",
+  "keywords": [
+    "commercetools",
+    "composable commerce",
+    "typescript",
+    "sdk",
+    "ml"
+  ],
   "homepage": "https://github.com/commercetools/commercetools-typescript-sdks/packages/ml-sdk",
   "bugs": "https://github.com/commercetools/commercetools-typescript-sdks/issues",
   "repository": {

diff --git a/packages/platform-sdk/README.md b/packages/platform-sdk/README.md
@@ -1,4 +1,4 @@
-# Typescript SDK for commercetools platform API
+# TypeScript SDK for commercetools Composable Commerce HTTP API
 
 ## Usage examples
 

diff --git a/packages/platform-sdk/package.json b/packages/platform-sdk/package.json
@@ -5,8 +5,8 @@
   },
   "name": "@commercetools/platform-sdk",
   "version": "2.7.0",
-  "description": "Typescript definitions and sdk for commercetools platform",
-  "keywords": ["commercetools", "typescript", "sdk"],
+  "description": "TypeScript definitions and SDK for commercetools Composable Commerce",
+  "keywords": ["commercetools", "composable commerce", "typescript", "sdk"],
   "homepage": "https://github.com/commercetools/commercetools-typescript-sdks",
   "bugs": "https://github.com/commercetools/commercetools-typescript-sdks/issues",
   "repository": {

diff --git a/packages/sdk-client/README.md b/packages/sdk-client/README.md
@@ -1,4 +1,4 @@
-# Commercetools TypeScript SDK client.
+# Commercetools Composable Commerce TypeScript SDK client
 
 ## Usage examples
 
@@ -77,7 +77,7 @@ const client = new ClientBuilder()
 
 const apiRoot = createApiBuilderFromCtpClient(client)
 
-// calling the platform functions
+// calling the Composable Commerce functions
 // get project details
 apiRoot
   .withProjectKey({

diff --git a/packages/sdk-client/package.json b/packages/sdk-client/package.json
@@ -1,9 +1,10 @@
 {
   "name": "@commercetools/sdk-client-v2",
   "version": "1.4.0",
-  "description": "commercetools TypeScript SDK client.",
+  "description": "commercetools Composable Commerce TypeScript SDK client.",
   "keywords": [
     "commercetools",
+    "composable commerce",
     "sdk",
     "typescript",
     "client",

diff --git a/packages/sdk-client/src/sdk-middleware-auth/build-requests.ts b/packages/sdk-client/src/sdk-middleware-auth/build-requests.ts
@@ -77,7 +77,7 @@ export function buildRequestForPasswordFlow(
    */
   const oauthUri = options.oauthUri || `/oauth/${pKey}/customers/token`
   const url = options.host.replace(/\/$/, '') + oauthUri
-  // encode username and password as requested by platform
+  // encode username and password as requested by the system
   const body = `grant_type=password&username=${encodeURIComponent(
     username
   )}&password=${encodeURIComponent(password)}${scopeStr}`