From c211f7012f99c5ae5502b551294bd2ef9ab82f37 Mon Sep 17 00:00:00 2001 From: Akira Sudoh Date: Sat, 30 Jan 2021 11:13:09 +0900 Subject: [PATCH] docs(web-components): add notes on vendor directory (#5020) ### Related Ticket(s) Refs #4989. ### Description Adds implementation notes for vendor directory for `@carbon/ibmdotcom-services-store`, so that new developers can quickly understand the difference from regular NPM packages. ### Changelog **New** - Implementation notes for vendor directory for `@carbon/ibmdotcom-services-store`. --- .../web-components/IMPLEMENTATION_NOTES.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/packages/web-components/IMPLEMENTATION_NOTES.md b/packages/web-components/IMPLEMENTATION_NOTES.md index 5269b088129..5cb5809e6dd 100644 --- a/packages/web-components/IMPLEMENTATION_NOTES.md +++ b/packages/web-components/IMPLEMENTATION_NOTES.md @@ -15,7 +15,7 @@ - [Rendering target](#rendering-target) - [Composite components](#composite-components) - [Components rendering modal](#components-rendering-modal) -- [CTA components](#cta-components)<<<<<<< implnotes-video-player +- [CTA components](#cta-components) - [Video CTA](#video-cta) - [React integration](#react-integration) - [React wrapper generator](#react-wrapper-generator) @@ -25,6 +25,7 @@ - [Container components](#container-components) - [Triggering action dispatcher](#triggering-action-dispatcher) - [Masthead search](#masthead-search) +- [Vendor directory](#vendor-directory) @@ -201,6 +202,9 @@ The build procedure can be found at [here](https://github.com/carbon-design-syst Container components are inheritances of composite components that connects to `@carbon/ibmdotcom-service`. Connecting to `@carbon/ibmdotcom-service` is done via a Redux store, [`@carbon/ibmdotcom-services-store`](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/tree/v1.13.0/packages/services-store). Connecting to `@carbon/ibmdotcom-services-store` is done by [`ConnectMixin`](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.13.0/packages/web-components/src/globals/mixins/connect.ts) that has a similar feature set to [`react-redux`](https://react-redux.js.org). +> 💡 `import`s of `@carbon/ibmdotcom-services-store` is slightly different from one of regular NPM packages. +> See [vendor directory](#vendor-directory) section for more details. + Similar to `react-redux`, `ConnectMixin` uses two callbacks: | Callback | Description | @@ -252,3 +256,15 @@ The search box feature in masthead consists of two things: `` uses [`ThrottledInputMixin`](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.13.0/packages/web-components/src/globals/mixins/throttled-input.ts) to throttle `dds-masthead-search-input` event. `ThrottledInputMixin` calls `_handleThrottledInput()` method, throttled, as the event defined by `eventInput` static method is fired. `` [intersects the search query with the table of loaded search results](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.13.0/packages/web-components/src/components/masthead/masthead-search-container.ts#L64-L70) and [sets `currentSearchResults` property](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.13.0/packages/web-components/src/components/masthead/masthead-search-container.ts#L72), which is [rendered as ``](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.13.0/packages/web-components/src/components/masthead/masthead-search-composite.ts#L118-L123). + +## Vendor directory + +`@carbon/ibmdotcom-services-store` is a private package that is not published to NPM. Putting it to `package.json` will break application because it won't be found. + +To solve the problem, [build process](https://github.com/carbon-design-system/carbon-for-ibm-dotcom/blob/v1.15.0/packages/web-components/gulp-tasks/vendor.js) of `@carbon/ibmdotcom-web-components` copies the build artifact of `@carbon/ibmdotcom-services-store` to `packages/web-components/src/internal/vendor/@carbon/ibmdotcom-services-store` as well as to `packages/web-components/es/internal/vendor/@carbon/ibmdotcom-services-store`. The former is used for our development. The latter is for application, being as [part of `@carbon/ibmdotcom-web-components` package](https://unpkg.com/browse/@carbon/ibmdotcom-web-components@1.0.0/es/internal/vendor/@carbon/ibmdotcom-services-store/). + +The `import`s of `@carbon/ibmdotcom-services-store` code in `@carbon/ibmdotcom-web-components` codebase refer to those copies, instead of to `@carbon/ibmdotcom-services-store` package, like below: + +```javascript +import { loadLanguage, setLanguage } from '../../internal/vendor/@carbon/ibmdotcom-services-store/actions/localeAPI'; +```