From 577b35c20e57eeec1d6c45dcbcf157f1d30490d9 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo Date: Thu, 12 May 2022 16:36:33 +0200 Subject: [PATCH 01/21] chore(docs): update naming to match new branding initiative - use Composable Commere in most places - use commercetools Composable Commere when it makes better sense --- CONTRIBUTING.md | 6 +++--- GenerateSDK.md | 14 +++++++------- LICENSE | 2 +- README.md | 6 +++--- examples/me/README.md | 9 +++++---- examples/me/server/src/app.ts | 2 +- packages/history-sdk/README.md | 2 +- packages/history-sdk/package.json | 10 ++++++++-- packages/importapi-sdk/README.md | 2 +- packages/importapi-sdk/package.json | 10 ++++++++-- packages/ml-sdk/README.md | 2 +- packages/ml-sdk/package.json | 10 ++++++++-- packages/sdk-client/README.md | 2 +- packages/sdk-client/package.json | 3 ++- 14 files changed, 50 insertions(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d5a73e2be..aaf323641 100644 --- 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 sdk-typescript 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 sdk-typescript 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 index 64db7c1e4..ff1ea1721 100644 --- 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 for how to generate the typescript SDK. ## Requirements @@ -18,16 +18,16 @@ run `yarn generate` to generate the sdks. (make sure the environement variables ## 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 RAML api](https://github.com/commercetools/ml-services-api-reference) | +| API_RAML_FILE | The path to Composable Commerce [RAML api](https://github.com/commercetools/commercetools-api-reference) | ## Test environnement variables | Variable name | Description | | ----------------- | :------------------------------------------------------------------------------------------------------: | -| CTP_PROJECT_KEY | commercetools project key | +| 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) | diff --git a/LICENSE b/LICENSE index 1e67edf57..6770efec5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 commercetools +Copyright (c) 2022 commercetools Composable Commerce Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c67db72a9..251e844f8 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -

commercetools TypeScript SDKs 💅

+

Composable Commerce TypeScript SDKs 💅

- ✨ Monorepository with generated TypeScript SDKs for the commercetools platform 🛠 + ✨ Monorepository with generated TypeScript SDKs for the Composable Commerce APIs 🛠

@@ -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 index a1b9ab455..1f33ce4ac 100644 --- 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 index 981b447f6..83e93e86d 100644 --- 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/packages/history-sdk/README.md b/packages/history-sdk/README.md index 303d4c848..118a84cf0 100644 --- 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 index 85524efac..ce875aa1e 100644 --- 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": "Type script 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 index 700153c6d..5f1c254a0 100644 --- 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 index 533e3edec..bf0bbe7ad 100644 --- 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": "Type script sdk for commercetools composable commerce import 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 index 4ff7bc64f..650b2b161 100644 --- 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 index 67b97faa4..470a58085 100644 --- 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": "Type script sdk for commercetools Composable Commerce ML 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/sdk-client/README.md b/packages/sdk-client/README.md index 5c5344114..4178adac0 100644 --- 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 diff --git a/packages/sdk-client/package.json b/packages/sdk-client/package.json index d1bb4a11b..1abf2a71c 100644 --- 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", From 09d0b33e4d588aa135dbec11052aea332e805421 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Fri, 13 May 2022 14:05:20 +0200 Subject: [PATCH 02/21] Update packages/history-sdk/package.json Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> --- packages/history-sdk/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/history-sdk/package.json b/packages/history-sdk/package.json index ce875aa1e..2046e8ea1 100644 --- a/packages/history-sdk/package.json +++ b/packages/history-sdk/package.json @@ -5,7 +5,7 @@ }, "name": "@commercetools/history-sdk", "version": "2.5.0", - "description": "Type script sdk for composable commerce audit log features", + "description": "Typescript SDK for composable commerce audit log features", "keywords": [ "commercetools", "composable commerce", From 7e1450fc572b1706a596d16c2f04c8354eaea3b8 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Fri, 13 May 2022 14:05:42 +0200 Subject: [PATCH 03/21] Update CONTRIBUTING.md Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aaf323641..2081d7c6c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -68,7 +68,7 @@ Some useful commands to work with the repository: ## Adding changesets -Composable Commerce 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. From 251e2616fce765850e1ec84b4e8679f28b2d86ac Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Fri, 13 May 2022 14:05:58 +0200 Subject: [PATCH 04/21] Update CONTRIBUTING.md Co-authored-by: Ajima Chukwuemeka <32770340+ajimae@users.noreply.github.com> --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2081d7c6c..3cb888fbf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ When opening a Pull Request, a `changeset-bot` checks that the Pull Request cont ## Releasing packages -Composable Commerce sdk-typescript uses [changesets](https://github.com/atlassian/changesets) to do versioning and publishing a release. +Composable Commerce Ttypescript 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. From e45bf41a7949b68e4dea421d1e108e955e6e7f93 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo Date: Mon, 16 May 2022 13:09:13 +0200 Subject: [PATCH 05/21] chore(rebranding): more rebranding - change platform to system - rebrand unseen comments --- GenerateSDK.md | 16 ++++++++-------- .../me/server/src/repository/CartRepository.ts | 4 ++-- packages/importapi-sdk/README.md | 2 +- packages/platform-sdk/README.md | 2 +- packages/platform-sdk/package.json | 4 ++-- packages/sdk-client/README.md | 2 +- .../src/sdk-middleware-auth/build-requests.ts | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index ff1ea1721..e42516c2f 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -25,11 +25,11 @@ run `yarn generate` to generate the sdks. (make sure the environement variables ## Test environnement variables -| 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 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 ml api uses a pattern a bit different from the composable commerce, that needs to be used to access ml services | diff --git a/examples/me/server/src/repository/CartRepository.ts b/examples/me/server/src/repository/CartRepository.ts index 4670b13a0..a7a0dfed5 100644 --- 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/importapi-sdk/README.md b/packages/importapi-sdk/README.md index 5f1c254a0..78a536a48 100644 --- a/packages/importapi-sdk/README.md +++ b/packages/importapi-sdk/README.md @@ -1,4 +1,4 @@ -# Typescript SDK for commercetools Composable Commerce Import API +# TypeScript SDK for commercetools Composable Commerce Import API ## Usage examples diff --git a/packages/platform-sdk/README.md b/packages/platform-sdk/README.md index 17f920003..2ceab7cc7 100644 --- 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 API ## Usage examples diff --git a/packages/platform-sdk/package.json b/packages/platform-sdk/package.json index 9777e40dd..da7e54419 100644 --- 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 index 4178adac0..64955d058 100644 --- a/packages/sdk-client/README.md +++ b/packages/sdk-client/README.md @@ -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/src/sdk-middleware-auth/build-requests.ts b/packages/sdk-client/src/sdk-middleware-auth/build-requests.ts index 048659b63..7dce7576c 100644 --- 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}` From cbd41aaa712a2c95d39138a9ed7e7ff988d1a6f1 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:35:49 +0200 Subject: [PATCH 06/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index e42516c2f..86001fc39 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -1,6 +1,6 @@ # Composable Commerce TypeScript SDKs Generation -This repo contains Composable Commerce SDKs and this is a 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 From 399c2594a2ff14d77e5b384c3afaf4001ff6d9da Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:36:08 +0200 Subject: [PATCH 07/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index 86001fc39..d2de3c917 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -27,7 +27,7 @@ run `yarn generate` to generate the sdks. (make sure the environement variables | Variable name | Description | | ----------------- | :-----------------------------------------------------------------------------------------------------------------: | -| CTP_PROJECT_KEY | composable commerce project key | +| 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) | From 3a1a9f2c897b8db47e034f2c595464a402b274a1 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:36:25 +0200 Subject: [PATCH 08/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index d2de3c917..7b2d6c8b9 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -30,6 +30,6 @@ run `yarn generate` to generate the sdks. (make sure the environement variables | 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_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 composable commerce, that needs to be used to access ml services | From f3b001f5827c87da5ea0133c163555316a10896b Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:40:35 +0200 Subject: [PATCH 09/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index 7b2d6c8b9..831de3156 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -20,7 +20,7 @@ run `yarn generate` to generate the sdks. (make sure the environement variables | Variable name | Description | | ------------- | :---------------------------------------------------------------------------------------------------------------------: | -| ML_API_REF | The path to Composable Commerce [machine learning RAML api](https://github.com/commercetools/ml-services-api-reference) | +| 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 [RAML api](https://github.com/commercetools/commercetools-api-reference) | ## Test environnement variables From 02864242a6a10c42d674a4ad110d3d54fb425732 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:47:04 +0200 Subject: [PATCH 10/21] Update LICENSE Co-authored-by: Melinda Fekete --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 6770efec5..1e67edf57 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 commercetools Composable Commerce +Copyright (c) 2022 commercetools Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 5b21cc46a1c9c55d1df74cb6129b94d138646865 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:47:19 +0200 Subject: [PATCH 11/21] Update packages/platform-sdk/README.md Co-authored-by: Melinda Fekete --- packages/platform-sdk/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/platform-sdk/README.md b/packages/platform-sdk/README.md index 2ceab7cc7..42bf3c002 100644 --- a/packages/platform-sdk/README.md +++ b/packages/platform-sdk/README.md @@ -1,4 +1,4 @@ -# TypeScript SDK for commercetools Composable Commerce API +# TypeScript SDK for commercetools Composable Commerce HTTP API ## Usage examples From de495c5d662715fbc418df0f44712ed18352bde5 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:48:37 +0200 Subject: [PATCH 12/21] Update CONTRIBUTING.md Co-authored-by: Melinda Fekete --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3cb888fbf..2de103ef4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ When opening a Pull Request, a `changeset-bot` checks that the Pull Request cont ## Releasing packages -Composable Commerce Ttypescript SDK 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. From 9b5781386704959e54708aeaebf1ecc09d5b475f Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:49:10 +0200 Subject: [PATCH 13/21] Update packages/sdk-client/README.md Co-authored-by: Melinda Fekete --- packages/sdk-client/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/sdk-client/README.md b/packages/sdk-client/README.md index 64955d058..8c305be69 100644 --- a/packages/sdk-client/README.md +++ b/packages/sdk-client/README.md @@ -1,4 +1,4 @@ -# Commercetools Composable Commerce TypeScript SDK client. +# Commercetools Composable Commerce TypeScript SDK client ## Usage examples From ee5a3151d2478c11a4c7ab4420219f686822519d Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:49:27 +0200 Subject: [PATCH 14/21] Update packages/platform-sdk/package.json Co-authored-by: Melinda Fekete --- packages/platform-sdk/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/platform-sdk/package.json b/packages/platform-sdk/package.json index da7e54419..2244d3606 100644 --- a/packages/platform-sdk/package.json +++ b/packages/platform-sdk/package.json @@ -5,7 +5,7 @@ }, "name": "@commercetools/platform-sdk", "version": "2.7.0", - "description": "Typescript definitions and sdk for commercetools composable commerce", + "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", From 80fa1afbf6b200284611e78de0f2079866402156 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:49:42 +0200 Subject: [PATCH 15/21] Update packages/ml-sdk/package.json Co-authored-by: Melinda Fekete --- packages/ml-sdk/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/ml-sdk/package.json b/packages/ml-sdk/package.json index 470a58085..233ea8eab 100644 --- a/packages/ml-sdk/package.json +++ b/packages/ml-sdk/package.json @@ -5,7 +5,7 @@ }, "name": "@commercetools/ml-sdk", "version": "2.4.0", - "description": "Type script sdk for commercetools Composable Commerce ML features", + "description": "TypeScript SDK for Composable Commerce Machine Learning features", "keywords": [ "commercetools", "composable commerce", From 76fc59cf3e7c9dfefd9401ff6c64987a106fc33f Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:50:07 +0200 Subject: [PATCH 16/21] Update packages/importapi-sdk/package.json Co-authored-by: Melinda Fekete --- packages/importapi-sdk/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/importapi-sdk/package.json b/packages/importapi-sdk/package.json index bf0bbe7ad..5732a4eb2 100644 --- a/packages/importapi-sdk/package.json +++ b/packages/importapi-sdk/package.json @@ -5,7 +5,7 @@ }, "name": "@commercetools/importapi-sdk", "version": "2.5.0", - "description": "Type script sdk for commercetools composable commerce import features", + "description": "TypeScript SDK for Composable Commerce Import API features", "keywords": [ "commercetools", "composable commerce", From 388669e0c3685a96c4a7dd5d0a7f067af7644fbd Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:51:33 +0200 Subject: [PATCH 17/21] Update examples/me/server/src/app.ts Co-authored-by: Melinda Fekete --- examples/me/server/src/app.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/examples/me/server/src/app.ts b/examples/me/server/src/app.ts index 83e93e86d..6c7d7a0a6 100644 --- 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: 'welcome to composable commerce me endpoint demo app', + message: 'Welcome to Composable Commerce me endpoint demo app', }) }) app.use('*', async (_, res: Response) => { From 6d432158d8edf39853b7a4af6b1fe246392b2e16 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 14:52:31 +0200 Subject: [PATCH 18/21] Update packages/history-sdk/package.json Co-authored-by: Melinda Fekete --- packages/history-sdk/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/history-sdk/package.json b/packages/history-sdk/package.json index 2046e8ea1..80fc2d680 100644 --- a/packages/history-sdk/package.json +++ b/packages/history-sdk/package.json @@ -5,7 +5,7 @@ }, "name": "@commercetools/history-sdk", "version": "2.5.0", - "description": "Typescript SDK for composable commerce audit log features", + "description": "Typescript SDK for Composable Commerce Audit Log features", "keywords": [ "commercetools", "composable commerce", From c8c881a2b81a5e8d7cef382b0ff871165c3da4d7 Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo Date: Tue, 17 May 2022 14:55:23 +0200 Subject: [PATCH 19/21] chore(rebranding): uppercase "API" and "ME" endpoint --- GenerateSDK.md | 8 ++++---- examples/me/server/src/app.ts | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index 831de3156..ec8f536bd 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -14,14 +14,14 @@ This repo contains Composable Commerce SDKs and this is a guide on how to genera ## 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 | -| ------------- | :---------------------------------------------------------------------------------------------------------------------: | +| 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 [RAML api](https://github.com/commercetools/commercetools-api-reference) | +| API_RAML_FILE | The path to Composable Commerce [RAML API](https://github.com/commercetools/commercetools-api-reference) | ## Test environnement variables diff --git a/examples/me/server/src/app.ts b/examples/me/server/src/app.ts index 6c7d7a0a6..86edfd368 100644 --- 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: 'Welcome to Composable Commerce me endpoint demo app', + message: 'Welcome to Composable Commerce ME endpoint demo app', }) }) app.use('*', async (_, res: Response) => { From 0c86e83257c5d190c9289a45798add225935dc2e Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Tue, 17 May 2022 15:21:29 +0200 Subject: [PATCH 20/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index ec8f536bd..43765e620 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -32,4 +32,4 @@ run `yarn generate` to generate the sdks. (make sure the environment variables a | 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 composable commerce, that needs to be used to access ml services | +| CTP_ML_API_URL | the Machine Learning API uses a different pattern than the HTTP API, use this to access ML services | From a10edaf1340a415bdc716528612386e1db755b8b Mon Sep 17 00:00:00 2001 From: Jeremiah Olufayo <32069279+jherey@users.noreply.github.com> Date: Wed, 18 May 2022 09:34:13 +0200 Subject: [PATCH 21/21] Update GenerateSDK.md Co-authored-by: Melinda Fekete --- GenerateSDK.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/GenerateSDK.md b/GenerateSDK.md index 43765e620..78a41f026 100644 --- a/GenerateSDK.md +++ b/GenerateSDK.md @@ -21,7 +21,7 @@ run `yarn generate` to generate the sdks. (make sure the environment variables a | 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 [RAML API](https://github.com/commercetools/commercetools-api-reference) | +| API_RAML_FILE | The path to Composable Commerce [HTTP API reference](https://github.com/commercetools/commercetools-api-reference) | ## Test environnement variables