Skip to content

Commit

Permalink
export internal function/type (#44)
Browse files Browse the repository at this point in the history
Export `provideChatHeadlessInternal` and `InternalConfig` in ChatHeadless to be accessible in Storm. This matches with the internal exports we already do for ChatHeadlessReact.

J=CLIP-977
TEST=none
  • Loading branch information
yen-tt authored Feb 6, 2024
1 parent 9e5cf7f commit f396fa6
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 9 deletions.
10 changes: 5 additions & 5 deletions packages/chat-headless-react/THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ https://www.npmjs.com/package/generate-license-file

The following npm package may be included in this product:

- @babel/[email protected].6
- @babel/[email protected].9

This package contains the following license and notice below:

Expand Down Expand Up @@ -67,7 +67,7 @@ The following npm packages may be included in this product:
- @types/[email protected]
- @types/[email protected]
- @types/[email protected]
- @types/[email protected].45
- @types/[email protected].55
- @types/[email protected]
- @types/[email protected]

Expand Down Expand Up @@ -140,8 +140,8 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The following npm packages may be included in this product:

- @yext/[email protected].5
- @yext/[email protected].2
- @yext/[email protected].6
- @yext/[email protected].3

These packages each contain the following license and notice below:

Expand Down Expand Up @@ -595,7 +595,7 @@ This package contains the following license and notice below:

The following npm package may be included in this product:

- ulidx@2.2.1
- ulidx@2.3.0

This package contains the following license and notice below:

Expand Down
4 changes: 2 additions & 2 deletions packages/chat-headless/THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ https://www.npmjs.com/package/generate-license-file

The following npm package may be included in this product:

- @babel/[email protected].6
- @babel/[email protected].9

This package contains the following license and notice below:

Expand Down Expand Up @@ -397,7 +397,7 @@ This package contains the following license and notice below:

The following npm package may be included in this product:

- ulidx@2.2.1
- ulidx@2.3.0

This package contains the following license and notice below:

Expand Down
11 changes: 11 additions & 0 deletions packages/chat-headless/etc/chat-headless.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,13 @@

import { ChatAnalyticsConfig } from '@yext/analytics';
import { ChatConfig } from '@yext/chat-core';
import { ChatCore } from '@yext/chat-core';
import { ChatEventPayLoad } from '@yext/analytics';
import { DeepPartial } from '@reduxjs/toolkit';
import { EndEvent } from '@yext/chat-core';
import { Endpoints } from '@yext/chat-core';
import { Environment } from '@yext/chat-core';
import { InternalConfig } from '@yext/chat-core';
import { Message } from '@yext/chat-core';
import { MessageNotes } from '@yext/chat-core';
import { MessageRequest } from '@yext/chat-core';
Expand All @@ -35,6 +37,8 @@ export interface ChatClient {

export { ChatConfig }

export { ChatCore }

// @public
export interface ChatHeadless {
// @internal
Expand Down Expand Up @@ -80,6 +84,8 @@ export interface HeadlessConfig extends ChatConfig {
saveToSessionStorage?: boolean;
}

export { InternalConfig }

export { Message }

export { MessageNotes }
Expand All @@ -98,6 +104,11 @@ export interface MetaState {
// @public
export function provideChatHeadless(config: HeadlessConfig): ChatHeadless;

// Warning: (ae-internal-missing-underscore) The name "provideChatHeadlessInternal" should be prefixed with an underscore because the declaration is marked as @internal
//
// @internal
export function provideChatHeadlessInternal(config: HeadlessConfig, internalConfig: InternalConfig): ChatHeadless;

export { RawResponse }

export { Region }
Expand Down
2 changes: 1 addition & 1 deletion packages/chat-headless/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@yext/chat-headless",
"version": "0.7.3",
"version": "0.7.4",
"description": "A state manager library powered by Redux for Yext Chat integrations",
"main": "./dist/commonjs/src/index.js",
"module": "./dist/esm/src/index.mjs",
Expand Down
2 changes: 2 additions & 0 deletions packages/chat-headless/src/corereexports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,4 +16,6 @@ export {
Environment,
Region,
Endpoints,
InternalConfig,
ChatCore
} from "@yext/chat-core";
2 changes: 1 addition & 1 deletion packages/chat-headless/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { provideChatHeadless } from "./HeadlessProvider";
export { provideChatHeadless, provideChatHeadlessInternal } from "./HeadlessProvider";
export * from "./models";
export * from "./corereexports";

0 comments on commit f396fa6

Please sign in to comment.