From 5ff0a911c15a1719f057c0f8784c82fe5d7a5cb0 Mon Sep 17 00:00:00 2001 From: Ethan Jaffee Date: Wed, 24 Jan 2024 18:05:22 -0500 Subject: [PATCH] update package-lock --- docs/analytics.action.md | 2 +- docs/analytics.analyticseventservice.report.md | 4 ++-- docs/analytics.enumorstring.md | 2 +- docs/analytics.environment.md | 2 +- docs/analytics.eventpayload.action.md | 2 +- docs/analytics.eventpayload.md | 2 +- docs/analytics.md | 1 - docs/analytics.partialpayload.md | 15 --------------- docs/analytics.region.md | 2 +- docs/analytics.versionlabel.md | 2 +- etc/analytics.api.md | 7 ++----- package-lock.json | 10 +++++----- 12 files changed, 16 insertions(+), 35 deletions(-) delete mode 100644 docs/analytics.partialpayload.md diff --git a/docs/analytics.action.md b/docs/analytics.action.md index d00da52..4340c92 100644 --- a/docs/analytics.action.md +++ b/docs/analytics.action.md @@ -9,5 +9,5 @@ The action types accepted by the Analytics Events API. **Signature:** ```typescript -export declare type Action = `C_${string}` | `c_${string}` | 'ADD_TO_CART' | 'ALL_TAB_NAVIGATION' | 'APPLY' | 'AUTO_COMPLETE_SELECTION' | 'BACKWARD_PAGINATE' | 'BOOK' | 'BRAND_ICON' | 'CASE_START' | 'CASE_SUBMITTED' | 'CHAT_IMPRESSION' | 'CHAT_LINK_CLICK' | 'CHAT_RESPONSE' | 'COLLAPSE' | 'CTA_CLICK' | 'DRIVING_DIRECTIONS' | 'EVENT' | 'EXPAND' | 'FEATURED_MESSAGE' | 'FILTERING_WITHIN_SECTION' | 'FORWARD_PAGINATE' | 'HEADER_LINKS' | 'ITEM_IN_LIST' | 'MAP_CARD' | 'MAP_PIN' | 'MENU' | 'MESSAGE' | 'ORDER' | 'PAGE_VIEW' | 'PAGINATE' | 'POST' | 'PRESET_PROMPT' | 'PRODUCT' | 'PROFILE' | 'QUESTION_FOCUS' | 'QUESTION_SUBMIT' | 'REMOVED_FILTER' | 'REVIEW' | 'SCROLL_TO_BOTTOM_OF_PAGE' | 'SEARCH_BAR_IMPRESSION' | 'SEARCH_CLEAR_BUTTON' | 'TAP_TO_CALL' | 'THUMBS_DOWN' | 'THUMBS_UP' | 'TICKET_URL' | 'TITLE' | 'VERTICAL_TAB_NAVIGATION' | 'VERTICAL_VIEW_ALL' | 'VOICE_START' | 'VOICE_STOP' | 'WEBSITE'; +export type Action = `C_${string}` | `c_${string}` | 'ADD_TO_CART' | 'ALL_TAB_NAVIGATION' | 'APPLY' | 'AUTO_COMPLETE_SELECTION' | 'BACKWARD_PAGINATE' | 'BOOK' | 'BRAND_ICON' | 'CASE_START' | 'CASE_SUBMITTED' | 'CHAT_IMPRESSION' | 'CHAT_LINK_CLICK' | 'CHAT_RESPONSE' | 'COLLAPSE' | 'CTA_CLICK' | 'DRIVING_DIRECTIONS' | 'EVENT' | 'EXPAND' | 'FEATURED_MESSAGE' | 'FILTERING_WITHIN_SECTION' | 'FORWARD_PAGINATE' | 'HEADER_LINKS' | 'ITEM_IN_LIST' | 'MAP_CARD' | 'MAP_PIN' | 'MENU' | 'MESSAGE' | 'ORDER' | 'PAGE_VIEW' | 'PAGINATE' | 'POST' | 'PRESET_PROMPT' | 'PRODUCT' | 'PROFILE' | 'QUESTION_FOCUS' | 'QUESTION_SUBMIT' | 'REMOVED_FILTER' | 'REVIEW' | 'SCROLL_TO_BOTTOM_OF_PAGE' | 'SEARCH_BAR_IMPRESSION' | 'SEARCH_CLEAR_BUTTON' | 'TAP_TO_CALL' | 'THUMBS_DOWN' | 'THUMBS_UP' | 'TICKET_URL' | 'TITLE' | 'VERTICAL_TAB_NAVIGATION' | 'VERTICAL_VIEW_ALL' | 'VOICE_START' | 'VOICE_STOP' | 'WEBSITE'; ``` diff --git a/docs/analytics.analyticseventservice.report.md b/docs/analytics.analyticseventservice.report.md index 94c95b2..e006ee8 100644 --- a/docs/analytics.analyticseventservice.report.md +++ b/docs/analytics.analyticseventservice.report.md @@ -9,14 +9,14 @@ Reports an analytics event. Operand will throw an error if the request fails. Th **Signature:** ```typescript -report(payload?: PartialPayload): Promise; +report(payload?: EventPayload): Promise; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| payload | [PartialPayload](./analytics.partialpayload.md) | _(Optional)_ desired values to be applied. The new payload will override any overlapping values. | +| payload | [EventPayload](./analytics.eventpayload.md) | _(Optional)_ desired values to be applied. The new payload will override any overlapping values. | **Returns:** diff --git a/docs/analytics.enumorstring.md b/docs/analytics.enumorstring.md index 4672396..62cb3dd 100644 --- a/docs/analytics.enumorstring.md +++ b/docs/analytics.enumorstring.md @@ -9,7 +9,7 @@ A TypeScript utility type which creates a union of an enum member and its string **Signature:** ```typescript -export declare type EnumOrString = T | `${T}`; +export type EnumOrString = T | `${T}`; ``` ## Remarks diff --git a/docs/analytics.environment.md b/docs/analytics.environment.md index a20007e..f6c94ad 100644 --- a/docs/analytics.environment.md +++ b/docs/analytics.environment.md @@ -9,7 +9,7 @@ The Yext Environments **Signature:** ```typescript -export declare type Environment = EnumOrString; +export type Environment = EnumOrString; ``` **References:** [EnumOrString](./analytics.enumorstring.md), [EnvironmentEnum](./analytics.environmentenum.md) diff --git a/docs/analytics.eventpayload.action.md b/docs/analytics.eventpayload.action.md index 35541f2..b0312ca 100644 --- a/docs/analytics.eventpayload.action.md +++ b/docs/analytics.eventpayload.action.md @@ -9,5 +9,5 @@ The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTO **Signature:** ```typescript -action: Action; +action?: Action; ``` diff --git a/docs/analytics.eventpayload.md b/docs/analytics.eventpayload.md index 25f57ee..7b5bb3f 100644 --- a/docs/analytics.eventpayload.md +++ b/docs/analytics.eventpayload.md @@ -16,7 +16,7 @@ export interface EventPayload | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [action](./analytics.eventpayload.action.md) | | [Action](./analytics.action.md) | The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION | +| [action?](./analytics.eventpayload.action.md) | | [Action](./analytics.action.md) | _(Optional)_ The user action which caused the event, e.g. ADD\_TO\_CART, THUMBS\_UP, C\_CUSTOM\_ACTION | | [authorization?](./analytics.eventpayload.authorization.md) | | string | _(Optional)_ The authorization token for the request. This will be setup from the Key or Bearer in the config. | | [bot?](./analytics.eventpayload.bot.md) | | boolean | _(Optional)_ Whether the event is the result of bot activity. | | [browserAgent?](./analytics.eventpayload.browseragent.md) | | { browser?: string; browserVersion?: string; device?: string; deviceClass?: string; os?: string; osVersion?: string; userAgent?: string; } | _(Optional)_ Information about the visitors device and browser. | diff --git a/docs/analytics.md b/docs/analytics.md index 4190ff9..a5a290e 100644 --- a/docs/analytics.md +++ b/docs/analytics.md @@ -34,7 +34,6 @@ | [Action](./analytics.action.md) | The action types accepted by the Analytics Events API. | | [EnumOrString](./analytics.enumorstring.md) | A TypeScript utility type which creates a union of an enum member and its string representation. | | [Environment](./analytics.environment.md) | The Yext Environments | -| [PartialPayload](./analytics.partialpayload.md) | A Payload that is a subset of the EventPayload | | [Region](./analytics.region.md) | The physical region of the Yext account | | [VersionLabel](./analytics.versionlabel.md) | The Search Version Label | diff --git a/docs/analytics.partialpayload.md b/docs/analytics.partialpayload.md deleted file mode 100644 index 9e9b60b..0000000 --- a/docs/analytics.partialpayload.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@yext/analytics](./analytics.md) > [PartialPayload](./analytics.partialpayload.md) - -## PartialPayload type - -A Payload that is a subset of the EventPayload - -**Signature:** - -```typescript -export declare type PartialPayload = Partial>; -``` -**References:** [EventPayload](./analytics.eventpayload.md) - diff --git a/docs/analytics.region.md b/docs/analytics.region.md index f1eea7d..99d6f08 100644 --- a/docs/analytics.region.md +++ b/docs/analytics.region.md @@ -9,7 +9,7 @@ The physical region of the Yext account **Signature:** ```typescript -export declare type Region = EnumOrString; +export type Region = EnumOrString; ``` **References:** [EnumOrString](./analytics.enumorstring.md), [RegionEnum](./analytics.regionenum.md) diff --git a/docs/analytics.versionlabel.md b/docs/analytics.versionlabel.md index cc3562a..f4eb294 100644 --- a/docs/analytics.versionlabel.md +++ b/docs/analytics.versionlabel.md @@ -9,7 +9,7 @@ The Search Version Label **Signature:** ```typescript -export declare type VersionLabel = EnumOrString; +export type VersionLabel = EnumOrString; ``` **References:** [EnumOrString](./analytics.enumorstring.md), [VersionLabelEnum](./analytics.versionlabelenum.md) diff --git a/etc/analytics.api.md b/etc/analytics.api.md index 5bad008..26cb74f 100644 --- a/etc/analytics.api.md +++ b/etc/analytics.api.md @@ -22,7 +22,7 @@ export interface AnalyticsConfig { // @public export interface AnalyticsEventService { - report(payload?: PartialPayload): Promise; + report(payload?: EventPayload): Promise; with(payload: EventPayload): AnalyticsEventService; } @@ -41,7 +41,7 @@ export enum EnvironmentEnum { // @public export interface EventPayload { - action: Action; + action?: Action; authorization?: string; bot?: boolean; browserAgent?: { @@ -99,9 +99,6 @@ export interface EventPayload { visitor?: Record; } -// @public -export type PartialPayload = Partial>; - // @public export type Region = EnumOrString; diff --git a/package-lock.json b/package-lock.json index 81da16d..32b4988 100644 --- a/package-lock.json +++ b/package-lock.json @@ -27,7 +27,7 @@ "jest": "^27.0.6", "jest-fetch-mock": "^3.0.3", "prettier": "^3.0.3", - "typescript": "^5.0.3", + "typescript": "^4.1.5", "vite": "^4.4.9" } }, @@ -9505,16 +9505,16 @@ } }, "node_modules/typescript": { - "version": "5.3.3", - "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", - "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", + "version": "4.9.5", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.9.5.tgz", + "integrity": "sha512-1FXk9E2Hm+QzZQ7z+McJiHL4NW1F2EzMu9Nq9i3zAaGqibafqYwCVU6WyWAuyQRRzOlxou8xZSyXLEN8oKj24g==", "dev": true, "bin": { "tsc": "bin/tsc", "tsserver": "bin/tsserver" }, "engines": { - "node": ">=14.17" + "node": ">=4.2.0" } }, "node_modules/ulidx": {