@magicx-eng/ai-autocomplete-vanilla 0.38.1 → 0.38.3

package/dist/index.d.mts

@@ -1963,9 +1963,17 @@ declare function scrollCaretIntoView(root: HTMLElement): void;
  * not be loaded. Only an `http(s)` URL is accepted — resolved against the
  * page, so a root-relative path from a same-origin catalog still works —
  * which keeps `javascript:`, `data:` and `blob:` sources out of an `<img>`
- * the server populates.
+ * the server populates. A Shopify-hosted picture is asked for at a thumbnail
+ * width (`shopifyImageSrc`) rather than as the full-size original.
  */
 declare function optionImageSrc(url: string | undefined): string | null;
+/**
+ * The URLs an option row tries for `image_url`, in order: what
+ * `optionImageSrc` returns, then the original when that was a Shopify
+ * thumbnail, for an `<img>` whose first load fails. Empty when the URL must
+ * not be loaded.
+ */
+declare function optionImageSources(url: string | undefined): string[];
 /**
  * An option's `item_count` as the built-in rows print it: the number alone,
  * grouped the way the page's locale groups numbers (`"1,200"`). The unit word
@@ -2162,6 +2170,59 @@ interface ScrollArrowArgs {
 }
 declare function attachScrollArrow({ dropdown, grid, button, }: ScrollArrowArgs): ScrollArrowController;
 
+/**
+ * Small pictures from Shopify's image CDN, for PNG and WebP uploads.
+ *
+ * A Shopify catalog's `image_url` is the original upload, drawn here in a
+ * 40px option square or a 116px product card. PNG product photos are the
+ * heavy ones: an 830×1080 PNG is 1–2 MB, and picking "Lehengas" on
+ * gayathrisarees.com loaded 16.5 MB of them. WebP uploads are lighter but
+ * still far more than a tile needs: opening the search on solene.shop loaded
+ * 992 KB of them for six category tiles, 48 KB at `width=120`. Shopify
+ * resizes on request (`?width=`) and caches every resize at its edge. JPEG
+ * uploads are left as they are (tens to a few hundred KB).
+ *
+ * `format=pjpg` is set too, because some PNG uploads carry megabytes of Adobe
+ * XMP metadata that Shopify copies into every resize: one Gayathri Sarees
+ * photo came back 1.6 MB at `width=200` as PNG and 4.1 MB as AVIF, while
+ * `width=200&format=pjpg` (a progressive JPEG, metadata dropped) was 28 KB.
+ * Shopify keeps a PNG that has an alpha channel as WebP/AVIF instead, so a
+ * transparent cut-out is never flattened. A WebP upload gets `width` alone:
+ * it has no such bloat, and Shopify's own pick (AVIF or WebP) is smaller than
+ * a JPEG (48 KB against 68 KB for Solene's twelve).
+ *
+ * Only Shopify-hosted PNG and WebP files are touched —
+ * `cdn.shopify.com/s/files/…` and a store's own `/cdn/shop/…`. Any other URL
+ * comes back unchanged. The widths are fixed
+ * (three times the default drawn size, for 3× phone screens) rather than
+ * measured, so every visitor asks for the same URL and hits the same cached
+ * resize.
+ */
+/** Option thumbnails (40px) and completed-chip pictures (20px). */
+declare const OPTION_IMAGE_WIDTH = 120;
+/** Product-strip cards (116px). */
+declare const PRODUCT_IMAGE_WIDTH = 360;
+/**
+ * `url` asked for at `width` when it is a Shopify-hosted PNG (with
+ * `format=pjpg`) or WebP; otherwise `url` unchanged. Any `width` already on
+ * the URL is replaced, and a PNG's `format` too; other parameters (`v=`, the
+ * cache-busting version) are kept. A
+ * root-relative URL (a store's own `/cdn/shop/…`) is read against the page and
+ * stays relative.
+ */
+declare function shopifyImageSrc(url: string, width: number): string;
+/**
+ * The URLs a product card tries for `imageUrl`, in order (`imageSources` at
+ * the card width): trimmed, sized down when it is a Shopify-hosted PNG or WebP, with
+ * the original as the fallback. Empty for an absent or blank URL.
+ */
+declare function productImageSources(url: string | null | undefined): string[];
+/**
+ * The `src` a product card draws `imageUrl` with first: trimmed, and sized
+ * down when it is a Shopify-hosted PNG or WebP. `undefined` for an absent or blank URL.
+ */
+declare function productImageSrc(url: string | null | undefined): string | undefined;
+
 type Listener<S> = (next: S, prev: S) => void;
 interface Store<S> {
     get: () => S;
@@ -2367,4 +2428,4 @@ interface SubmitResultExtras {
  */
 declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
 
-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, 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_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, 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, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, keepCaretOnChip, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionCountLabel, optionEnterDelayMs, optionHasImage, optionImageSrc, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productInitial, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sameOptionRows, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };
+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 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, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, keepCaretOnChip, 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, visibleDateRange, withSkippedParams };

package/dist/index.d.ts

@@ -1963,9 +1963,17 @@ declare function scrollCaretIntoView(root: HTMLElement): void;
  * not be loaded. Only an `http(s)` URL is accepted — resolved against the
  * page, so a root-relative path from a same-origin catalog still works —
  * which keeps `javascript:`, `data:` and `blob:` sources out of an `<img>`
- * the server populates.
+ * the server populates. A Shopify-hosted picture is asked for at a thumbnail
+ * width (`shopifyImageSrc`) rather than as the full-size original.
  */
 declare function optionImageSrc(url: string | undefined): string | null;
+/**
+ * The URLs an option row tries for `image_url`, in order: what
+ * `optionImageSrc` returns, then the original when that was a Shopify
+ * thumbnail, for an `<img>` whose first load fails. Empty when the URL must
+ * not be loaded.
+ */
+declare function optionImageSources(url: string | undefined): string[];
 /**
  * An option's `item_count` as the built-in rows print it: the number alone,
  * grouped the way the page's locale groups numbers (`"1,200"`). The unit word
@@ -2162,6 +2170,59 @@ interface ScrollArrowArgs {
 }
 declare function attachScrollArrow({ dropdown, grid, button, }: ScrollArrowArgs): ScrollArrowController;
 
+/**
+ * Small pictures from Shopify's image CDN, for PNG and WebP uploads.
+ *
+ * A Shopify catalog's `image_url` is the original upload, drawn here in a
+ * 40px option square or a 116px product card. PNG product photos are the
+ * heavy ones: an 830×1080 PNG is 1–2 MB, and picking "Lehengas" on
+ * gayathrisarees.com loaded 16.5 MB of them. WebP uploads are lighter but
+ * still far more than a tile needs: opening the search on solene.shop loaded
+ * 992 KB of them for six category tiles, 48 KB at `width=120`. Shopify
+ * resizes on request (`?width=`) and caches every resize at its edge. JPEG
+ * uploads are left as they are (tens to a few hundred KB).
+ *
+ * `format=pjpg` is set too, because some PNG uploads carry megabytes of Adobe
+ * XMP metadata that Shopify copies into every resize: one Gayathri Sarees
+ * photo came back 1.6 MB at `width=200` as PNG and 4.1 MB as AVIF, while
+ * `width=200&format=pjpg` (a progressive JPEG, metadata dropped) was 28 KB.
+ * Shopify keeps a PNG that has an alpha channel as WebP/AVIF instead, so a
+ * transparent cut-out is never flattened. A WebP upload gets `width` alone:
+ * it has no such bloat, and Shopify's own pick (AVIF or WebP) is smaller than
+ * a JPEG (48 KB against 68 KB for Solene's twelve).
+ *
+ * Only Shopify-hosted PNG and WebP files are touched —
+ * `cdn.shopify.com/s/files/…` and a store's own `/cdn/shop/…`. Any other URL
+ * comes back unchanged. The widths are fixed
+ * (three times the default drawn size, for 3× phone screens) rather than
+ * measured, so every visitor asks for the same URL and hits the same cached
+ * resize.
+ */
+/** Option thumbnails (40px) and completed-chip pictures (20px). */
+declare const OPTION_IMAGE_WIDTH = 120;
+/** Product-strip cards (116px). */
+declare const PRODUCT_IMAGE_WIDTH = 360;
+/**
+ * `url` asked for at `width` when it is a Shopify-hosted PNG (with
+ * `format=pjpg`) or WebP; otherwise `url` unchanged. Any `width` already on
+ * the URL is replaced, and a PNG's `format` too; other parameters (`v=`, the
+ * cache-busting version) are kept. A
+ * root-relative URL (a store's own `/cdn/shop/…`) is read against the page and
+ * stays relative.
+ */
+declare function shopifyImageSrc(url: string, width: number): string;
+/**
+ * The URLs a product card tries for `imageUrl`, in order (`imageSources` at
+ * the card width): trimmed, sized down when it is a Shopify-hosted PNG or WebP, with
+ * the original as the fallback. Empty for an absent or blank URL.
+ */
+declare function productImageSources(url: string | null | undefined): string[];
+/**
+ * The `src` a product card draws `imageUrl` with first: trimmed, and sized
+ * down when it is a Shopify-hosted PNG or WebP. `undefined` for an absent or blank URL.
+ */
+declare function productImageSrc(url: string | null | undefined): string | undefined;
+
 type Listener<S> = (next: S, prev: S) => void;
 interface Store<S> {
     get: () => S;
@@ -2367,4 +2428,4 @@ interface SubmitResultExtras {
  */
 declare function buildSubmitResult(text: string, completedParams: CompletedParamState[], skippedParams?: SkippedParamState[], extras?: SubmitResultExtras): AutocompleteResult;
 
-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, 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_PATH_PREFIX, PRODUCT_ROW_PX_PER_LINE, 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, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, keepCaretOnChip, measureOptionsGrid, monthLabel, needsOptionsGridMeasurement, optionCountLabel, optionEnterDelayMs, optionHasImage, optionImageSrc, optionLabel, optionsEntranceDurationMs, optionsGridTemplateColumns, parseDate, parseLooseDate, parseLooseDateRange, plainTextLength, planOptionsGrid, previousGraphemeBoundary, productFromMatchedItem, productInitial, productRowWheelTarget, productsFromCustomFields, renderEditableContent, resolveFormatType, resolveIdentifiedDate, sameOptionRows, sanitizeOptionIconSvg, scrollCaretIntoView, selectedIsoFromText, selectedRangeFor, setCursorOffset, toWireIdentifiedParams, visibleDateRange, withSkippedParams };
+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 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, WEEKDAY_LABELS, addMonths, attachProductRowWheel, attachScrollArrow, buildAttributionUrl, buildDateOptions, buildQuery, buildSubmitResult, cellDay, cellIso, chipIdFromTap, computeOptionsGridLayout, containScroll, createStore, cursorIsAtEnd, dateCellMarks, dateSelectionFor, extractPlainText, formatAbsoluteDate, formatDate, formatDateRange, formatOptionCount, getCursorOffset, getFooterHint, identifiedParamLabel, isCalendarFormat, isOptionsGridMobileViewport, isoDate, keepCaretOnChip, 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, visibleDateRange, withSkippedParams };