@magicx-eng/ai-autocomplete-vanilla 0.47.0 → 0.48.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +61 -2
- package/dist/index.d.ts +61 -2
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +6 -3
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -55,6 +55,11 @@ interface SuggestionOption {
|
|
|
55
55
|
* suggestion's.
|
|
56
56
|
*/
|
|
57
57
|
parameter?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Set by the SDK, never the server, on the options that complete the word
|
|
60
|
+
* being typed: the text typed since the last answer, whose match is drawn in bold.
|
|
61
|
+
*/
|
|
62
|
+
matchedText?: string;
|
|
58
63
|
}
|
|
59
64
|
/**
|
|
60
65
|
* The value type of a parameter — which picker it needs. The server sends it
|
|
@@ -62,7 +67,8 @@ interface SuggestionOption {
|
|
|
62
67
|
* from its options.
|
|
63
68
|
*/
|
|
64
69
|
interface SuggestionType {
|
|
65
|
-
|
|
70
|
+
/** `traditional_autocomplete` marks a suggestion whose options complete the word being typed; it is never a pill. */
|
|
71
|
+
kind: "string" | "numeric" | "date" | "date_range" | "boolean" | "traditional_autocomplete";
|
|
66
72
|
/** How a date is written, e.g. "DD/MM/YYYY". */
|
|
67
73
|
date_format?: string;
|
|
68
74
|
/** What joins the two dates of a range, e.g. " to ". */
|
|
@@ -109,6 +115,8 @@ interface AutocompleteRequest {
|
|
|
109
115
|
recently_suggested?: RecentlySuggested[];
|
|
110
116
|
contact_account_count?: number;
|
|
111
117
|
additional_context?: Record<string, unknown>;
|
|
118
|
+
/** Tells the server this client can show option-value completions of the word being typed. */
|
|
119
|
+
accepts_traditional_autocomplete?: boolean;
|
|
112
120
|
};
|
|
113
121
|
meta: {
|
|
114
122
|
request_id: string;
|
|
@@ -144,6 +152,12 @@ interface AutocompleteResponse {
|
|
|
144
152
|
* exactly. Absent means off.
|
|
145
153
|
*/
|
|
146
154
|
phrase_exact_match?: boolean;
|
|
155
|
+
/**
|
|
156
|
+
* Set when the server completes the word being typed. Typed text that
|
|
157
|
+
* only reaches an option mid-word ("a" in "Medium Heat") then asks the
|
|
158
|
+
* server rather than waiting on the local filter. Absent means off.
|
|
159
|
+
*/
|
|
160
|
+
traditional_autocomplete?: boolean;
|
|
147
161
|
/** The request's `schema_version`, echoed back. */
|
|
148
162
|
schema_version?: string;
|
|
149
163
|
};
|
|
@@ -674,6 +688,13 @@ interface CoreInputState {
|
|
|
674
688
|
* while `opts.showProducts` is false.
|
|
675
689
|
*/
|
|
676
690
|
products: Product[];
|
|
691
|
+
/**
|
|
692
|
+
* Whether the latest applied response said the server completes the word
|
|
693
|
+
* being typed (`meta.traditional_autocomplete`). While true the typed text
|
|
694
|
+
* filters the active question's options by word start, the way the server
|
|
695
|
+
* matches, so a fragment inside a word does not hold the request back.
|
|
696
|
+
*/
|
|
697
|
+
traditionalAutocomplete: boolean;
|
|
677
698
|
/**
|
|
678
699
|
* The catalog grounding report the latest applied response carried, or null
|
|
679
700
|
* when it carried none. Replaced wholesale per response, so it always
|
|
@@ -2151,6 +2172,7 @@ declare const en: {
|
|
|
2151
2172
|
soldOut: string;
|
|
2152
2173
|
submit: string;
|
|
2153
2174
|
scrollArrow: string;
|
|
2175
|
+
keepTyping: string;
|
|
2154
2176
|
};
|
|
2155
2177
|
type UIStrings = typeof en;
|
|
2156
2178
|
declare function uiStringsFor(language?: string): UIStrings;
|
|
@@ -2447,6 +2469,34 @@ declare function productFromMatchedItem(item: MatchedItem, language?: string): P
|
|
|
2447
2469
|
*/
|
|
2448
2470
|
declare function productsFromCustomFields(report: CustomFieldsReport | null | undefined, language?: string): Product[];
|
|
2449
2471
|
|
|
2472
|
+
interface TextPart {
|
|
2473
|
+
text: string;
|
|
2474
|
+
bold: boolean;
|
|
2475
|
+
}
|
|
2476
|
+
/** The word being typed: the text after the last whitespace. */
|
|
2477
|
+
declare function typedFragment(text: string): string;
|
|
2478
|
+
interface PhraseMatch {
|
|
2479
|
+
/** How many of the typed words (counted from the end) the option text covers. */
|
|
2480
|
+
typedWords: number;
|
|
2481
|
+
/** The covered span of the option text. */
|
|
2482
|
+
start: number;
|
|
2483
|
+
end: number;
|
|
2484
|
+
}
|
|
2485
|
+
/**
|
|
2486
|
+
* The longest run of the typed words, ending at the last one, that reads as a
|
|
2487
|
+
* phrase inside `optionText`: every typed word but the last equals a whole
|
|
2488
|
+
* option word and the last starts one. Case- and accent-insensitive; the phrase
|
|
2489
|
+
* may begin at any option word. Null when not even the last word starts one.
|
|
2490
|
+
*/
|
|
2491
|
+
declare function matchTypedPhrase(optionText: string, typedText: string): PhraseMatch | null;
|
|
2492
|
+
/**
|
|
2493
|
+
* Splits an option's text so what the typed text matches can be drawn in bold:
|
|
2494
|
+
* the phrase `matchTypedPhrase` finds when it spans several words, else the
|
|
2495
|
+
* start of every word that begins with the last typed word. Case- and
|
|
2496
|
+
* accent-insensitive. The parts always join back into `text`.
|
|
2497
|
+
*/
|
|
2498
|
+
declare function highlightParts(text: string, typedText: string | undefined): TextPart[];
|
|
2499
|
+
|
|
2450
2500
|
declare class ModeController {
|
|
2451
2501
|
private container;
|
|
2452
2502
|
private mode;
|
|
@@ -2552,4 +2602,13 @@ interface SubmitResultExtras {
|
|
|
2552
2602
|
*/
|
|
2553
2603
|
declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
|
|
2554
2604
|
|
|
2555
|
-
|
|
2605
|
+
/** True for the suggestion whose options complete the word being typed. */
|
|
2606
|
+
declare function isTraditionalAutocompleteSuggestion(suggestion: Suggestion | undefined | null): boolean;
|
|
2607
|
+
/** Drops the traditional autocomplete suggestion where only real pills make sense. */
|
|
2608
|
+
declare function withoutTraditionalAutocomplete(suggestions: Suggestion[]): Suggestion[];
|
|
2609
|
+
/** Gives the traditional autocomplete suggestion its header when the server left the text empty. */
|
|
2610
|
+
declare function labelTraditionalAutocomplete(suggestions: Suggestion[], header: string): Suggestion[];
|
|
2611
|
+
/** True when some pill is a question the shopper can decline. */
|
|
2612
|
+
declare function hasSkippablePill(suggestions: Suggestion[]): boolean;
|
|
2613
|
+
|
|
2614
|
+
export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, DEFAULT_OPTION_COUNT_UNIT, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, OPTION_IMAGE_WIDTH, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_IMAGE_WIDTH, PRODUCT_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, type PhraseMatch, type Product, type ProductImageFallback, type ProductRowMetrics, type ProductRowWheel, type ProductsConfig, type ProductsLayout, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCHEMA_VERSION, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type SuggestionType, type TaskKind, type TextPart, type UIStrings, VIEWPORT_FIT_ATTR, VIEWPORT_FIT_HEIGHT_VAR, type ViewportFitArgs, type ViewportFitController, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, attachViewportFit, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, hasSkippablePill, highlightParts, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isTraditionalAutocompleteSuggestion, isoDate, keepCaretOnChip, labelTraditionalAutocomplete, matchTypedPhrase, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionCountLabel, optionEnterDelayMs, optionHasImage, optionImageSources, optionImageSrc, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productImageSources, productImageSrc, productInitial, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sameOptionRows, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, shopifyImageSrc, toWireIdentifiedParams, typedFragment, uiStringsFor, visibleDateRange, withSkippedParams, withoutTraditionalAutocomplete };
|
package/dist/index.d.ts
CHANGED
|
@@ -55,6 +55,11 @@ interface SuggestionOption {
|
|
|
55
55
|
* suggestion's.
|
|
56
56
|
*/
|
|
57
57
|
parameter?: string;
|
|
58
|
+
/**
|
|
59
|
+
* Set by the SDK, never the server, on the options that complete the word
|
|
60
|
+
* being typed: the text typed since the last answer, whose match is drawn in bold.
|
|
61
|
+
*/
|
|
62
|
+
matchedText?: string;
|
|
58
63
|
}
|
|
59
64
|
/**
|
|
60
65
|
* The value type of a parameter — which picker it needs. The server sends it
|
|
@@ -62,7 +67,8 @@ interface SuggestionOption {
|
|
|
62
67
|
* from its options.
|
|
63
68
|
*/
|
|
64
69
|
interface SuggestionType {
|
|
65
|
-
|
|
70
|
+
/** `traditional_autocomplete` marks a suggestion whose options complete the word being typed; it is never a pill. */
|
|
71
|
+
kind: "string" | "numeric" | "date" | "date_range" | "boolean" | "traditional_autocomplete";
|
|
66
72
|
/** How a date is written, e.g. "DD/MM/YYYY". */
|
|
67
73
|
date_format?: string;
|
|
68
74
|
/** What joins the two dates of a range, e.g. " to ". */
|
|
@@ -109,6 +115,8 @@ interface AutocompleteRequest {
|
|
|
109
115
|
recently_suggested?: RecentlySuggested[];
|
|
110
116
|
contact_account_count?: number;
|
|
111
117
|
additional_context?: Record<string, unknown>;
|
|
118
|
+
/** Tells the server this client can show option-value completions of the word being typed. */
|
|
119
|
+
accepts_traditional_autocomplete?: boolean;
|
|
112
120
|
};
|
|
113
121
|
meta: {
|
|
114
122
|
request_id: string;
|
|
@@ -144,6 +152,12 @@ interface AutocompleteResponse {
|
|
|
144
152
|
* exactly. Absent means off.
|
|
145
153
|
*/
|
|
146
154
|
phrase_exact_match?: boolean;
|
|
155
|
+
/**
|
|
156
|
+
* Set when the server completes the word being typed. Typed text that
|
|
157
|
+
* only reaches an option mid-word ("a" in "Medium Heat") then asks the
|
|
158
|
+
* server rather than waiting on the local filter. Absent means off.
|
|
159
|
+
*/
|
|
160
|
+
traditional_autocomplete?: boolean;
|
|
147
161
|
/** The request's `schema_version`, echoed back. */
|
|
148
162
|
schema_version?: string;
|
|
149
163
|
};
|
|
@@ -674,6 +688,13 @@ interface CoreInputState {
|
|
|
674
688
|
* while `opts.showProducts` is false.
|
|
675
689
|
*/
|
|
676
690
|
products: Product[];
|
|
691
|
+
/**
|
|
692
|
+
* Whether the latest applied response said the server completes the word
|
|
693
|
+
* being typed (`meta.traditional_autocomplete`). While true the typed text
|
|
694
|
+
* filters the active question's options by word start, the way the server
|
|
695
|
+
* matches, so a fragment inside a word does not hold the request back.
|
|
696
|
+
*/
|
|
697
|
+
traditionalAutocomplete: boolean;
|
|
677
698
|
/**
|
|
678
699
|
* The catalog grounding report the latest applied response carried, or null
|
|
679
700
|
* when it carried none. Replaced wholesale per response, so it always
|
|
@@ -2151,6 +2172,7 @@ declare const en: {
|
|
|
2151
2172
|
soldOut: string;
|
|
2152
2173
|
submit: string;
|
|
2153
2174
|
scrollArrow: string;
|
|
2175
|
+
keepTyping: string;
|
|
2154
2176
|
};
|
|
2155
2177
|
type UIStrings = typeof en;
|
|
2156
2178
|
declare function uiStringsFor(language?: string): UIStrings;
|
|
@@ -2447,6 +2469,34 @@ declare function productFromMatchedItem(item: MatchedItem, language?: string): P
|
|
|
2447
2469
|
*/
|
|
2448
2470
|
declare function productsFromCustomFields(report: CustomFieldsReport | null | undefined, language?: string): Product[];
|
|
2449
2471
|
|
|
2472
|
+
interface TextPart {
|
|
2473
|
+
text: string;
|
|
2474
|
+
bold: boolean;
|
|
2475
|
+
}
|
|
2476
|
+
/** The word being typed: the text after the last whitespace. */
|
|
2477
|
+
declare function typedFragment(text: string): string;
|
|
2478
|
+
interface PhraseMatch {
|
|
2479
|
+
/** How many of the typed words (counted from the end) the option text covers. */
|
|
2480
|
+
typedWords: number;
|
|
2481
|
+
/** The covered span of the option text. */
|
|
2482
|
+
start: number;
|
|
2483
|
+
end: number;
|
|
2484
|
+
}
|
|
2485
|
+
/**
|
|
2486
|
+
* The longest run of the typed words, ending at the last one, that reads as a
|
|
2487
|
+
* phrase inside `optionText`: every typed word but the last equals a whole
|
|
2488
|
+
* option word and the last starts one. Case- and accent-insensitive; the phrase
|
|
2489
|
+
* may begin at any option word. Null when not even the last word starts one.
|
|
2490
|
+
*/
|
|
2491
|
+
declare function matchTypedPhrase(optionText: string, typedText: string): PhraseMatch | null;
|
|
2492
|
+
/**
|
|
2493
|
+
* Splits an option's text so what the typed text matches can be drawn in bold:
|
|
2494
|
+
* the phrase `matchTypedPhrase` finds when it spans several words, else the
|
|
2495
|
+
* start of every word that begins with the last typed word. Case- and
|
|
2496
|
+
* accent-insensitive. The parts always join back into `text`.
|
|
2497
|
+
*/
|
|
2498
|
+
declare function highlightParts(text: string, typedText: string | undefined): TextPart[];
|
|
2499
|
+
|
|
2450
2500
|
declare class ModeController {
|
|
2451
2501
|
private container;
|
|
2452
2502
|
private mode;
|
|
@@ -2552,4 +2602,13 @@ interface SubmitResultExtras {
|
|
|
2552
2602
|
*/
|
|
2553
2603
|
declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
|
|
2554
2604
|
|
|
2555
|
-
|
|
2605
|
+
/** True for the suggestion whose options complete the word being typed. */
|
|
2606
|
+
declare function isTraditionalAutocompleteSuggestion(suggestion: Suggestion | undefined | null): boolean;
|
|
2607
|
+
/** Drops the traditional autocomplete suggestion where only real pills make sense. */
|
|
2608
|
+
declare function withoutTraditionalAutocomplete(suggestions: Suggestion[]): Suggestion[];
|
|
2609
|
+
/** Gives the traditional autocomplete suggestion its header when the server left the text empty. */
|
|
2610
|
+
declare function labelTraditionalAutocomplete(suggestions: Suggestion[], header: string): Suggestion[];
|
|
2611
|
+
/** True when some pill is a question the shopper can decline. */
|
|
2612
|
+
declare function hasSkippablePill(suggestions: Suggestion[]): boolean;
|
|
2613
|
+
|
|
2614
|
+
export { AIAutocomplete, type APIConfig, type APIKeyConfig, ATTRIBUTION_URL, type AccessTokenConfig, type AccessTokenResult, type AppearanceMode, type AutocompleteRequest, type AutocompleteResponse, type AutocompleteResult, type CompletedParam, type CompletedParamState, type CoreOptions, type CoreState, type CustomFieldsReport, DATE_RANGE_META_END, DATE_RANGE_META_START, DEFAULT_OPTION_COUNT_UNIT, type DateMonthView, type DateRange, type DateSelection, type ExpressedFilter, type FilterOp, type FormatType, type IdentifiedParam, type IdentifiedParamState, type InputItem, type LooseDateOptions, type MatchedItem, type MatchedItems, ModeController, OPTIONS_GRID_MOBILE_QUERY, OPTION_ENTER_DELAY_VAR, OPTION_ENTER_FADE_MS, OPTION_ENTER_RISE_MS, OPTION_ENTER_RISE_PX, OPTION_ENTER_STAGGER_MS, OPTION_IMAGE_WIDTH, type OptionOverride, type OptionOverrides, type OptionsGridLayout, type OptionsGridPlan, PLACEHOLDER_FADE_OUT_MS, PLACEHOLDER_LEAVING_ATTR, PLACEHOLDER_SWAP_GAP_MS, PLACEHOLDER_TYPE_MS, PLACEHOLDER_WORD_PAUSE_MS, PRODUCT_IMAGE_WIDTH, PRODUCT_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, type PhraseMatch, type Product, type ProductImageFallback, type ProductRowMetrics, type ProductRowWheel, type ProductsConfig, type ProductsLayout, RANGE_SEPARATOR, type RecentlySuggested, type RenderMode, SCHEMA_VERSION, SCROLL_ARROW_ATTR, SCROLL_ARROW_BOTTOM_VAR, SCROLL_ARROW_CLASS, SCROLL_ARROW_FADE_MS, SCROLL_ARROW_LABEL, SCROLL_ARROW_SCROLL_IDLE_MS, SCROLL_ARROW_VISIBLE_ATTR, SKIPPED_PARAM_TEXT, type ScrollArrowArgs, type ScrollArrowController, type Segment, type SkippedParamState, type Store, type SubmitResultExtras, type Suggestion, type SuggestionOption, type SuggestionType, type TaskKind, type TextPart, type UIStrings, VIEWPORT_FIT_ATTR, VIEWPORT_FIT_HEIGHT_VAR, type ViewportFitArgs, type ViewportFitController, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, attachViewportFit, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, hasSkippablePill, highlightParts, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isTraditionalAutocompleteSuggestion, isoDate, keepCaretOnChip, labelTraditionalAutocomplete, matchTypedPhrase, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionCountLabel, optionEnterDelayMs, optionHasImage, optionImageSources, optionImageSrc, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productImageSources, productImageSrc, productInitial, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sameOptionRows, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, shopifyImageSrc, toWireIdentifiedParams, typedFragment, uiStringsFor, visibleDateRange, withSkippedParams, withoutTraditionalAutocomplete };
|