@ikas/storefront-api 4.0.0-alpha.78 → 4.0.0-alpha.8

package/src/__api/queries/searchProducts.ts

@@ -0,0 +1,171 @@
+import {
+  fetchQuery,
+  ConfigType,
+  APIResponse,
+  handleAPIError,
+} from "@ikas/fe-api-client";
+import { SearchInput, ProductSearchResponse } from "../types";
+
+const searchProducts = async (
+  variables: QueryParams,
+  fields?: string[],
+  config?: ConfigType
+) => {
+  try {
+    const { data, errors } = await fetchQuery({
+      operationName: "searchProducts",
+      config,
+      variables,
+      allReturnFields,
+      fields,
+      query: (returnFields: string) => `
+				query searchProducts (
+					$input: SearchInput!,
+				) {
+					searchProducts (
+						input: $input,
+					) ${returnFields}
+				}
+			`,
+    });
+
+    return new APIResponse<ProductSearchResponse>(data?.searchProducts, errors);
+  } catch (err) {
+    return handleAPIError(err);
+  }
+};
+
+export default searchProducts;
+
+export type QueryParams = {
+  input: SearchInput;
+};
+
+const allReturnFields =
+  "{count data facets {id values {count id } } limit page results {attributes {imageIds productAttribute {id name tableTemplate {columns {id name } rows {id name } } translations {description locale name options {id name } } type } productAttributeOption {id name } value } brand {id name slug translations {description locale name } } categories {id name path {id name slug translations {description locale name } } slug translations {description locale name } } deleted description groupVariantsByVariantTypeId id metaData {canonicals description disableIndex metadataOverrides {description language pageTitle storefrontId storefrontRegionId } pageTitle redirectTo slug translations {description locale pageTitle } } name productOptionSetId productVariantTypes {order variantType {id name selectionType translations {locale name values {id name } } values {colorCode id name thumbnailImageId } } variantValueIds } salesChannelIds shortDescription tags {id name translations {description locale name } } translations {description locale name } type variants {attributes {imageIds productAttribute {id name tableTemplate {columns {id name } rows {id name } } translations {description locale name options {id name } } type } productAttributeOption {id name } value } barcodeList deleted id images {id isMain isVideo order } isActive prices {buyPrice currency discountPrice priceListId sellPrice } sellIfOutOfStock sku stocks {stockCount stockLocationId } variantValues {variantTypeId variantValueId } weight } weight } totalCount }";
+
+export enum ResponseField {
+  COUNT = "count",
+  DATA = "data",
+  FACETS__ID = "facets.id",
+  FACETS__VALUES__COUNT = "facets.values.count",
+  FACETS__VALUES__ID = "facets.values.id",
+  LIMIT = "limit",
+  PAGE = "page",
+  RESULTS__ATTRIBUTES__IMAGE_IDS = "results.attributes.imageIds",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__ID = "results.attributes.productAttribute.id",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__NAME = "results.attributes.productAttribute.name",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__COLUMNS__ID = "results.attributes.productAttribute.tableTemplate.columns.id",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__COLUMNS__NAME = "results.attributes.productAttribute.tableTemplate.columns.name",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__ROWS__ID = "results.attributes.productAttribute.tableTemplate.rows.id",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__ROWS__NAME = "results.attributes.productAttribute.tableTemplate.rows.name",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__DESCRIPTION = "results.attributes.productAttribute.translations.description",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__LOCALE = "results.attributes.productAttribute.translations.locale",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__NAME = "results.attributes.productAttribute.translations.name",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__OPTIONS__ID = "results.attributes.productAttribute.translations.options.id",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__OPTIONS__NAME = "results.attributes.productAttribute.translations.options.name",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TYPE = "results.attributes.productAttribute.type",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE_OPTION__ID = "results.attributes.productAttributeOption.id",
+  RESULTS__ATTRIBUTES__PRODUCT_ATTRIBUTE_OPTION__NAME = "results.attributes.productAttributeOption.name",
+  RESULTS__ATTRIBUTES__VALUE = "results.attributes.value",
+  RESULTS__BRAND__ID = "results.brand.id",
+  RESULTS__BRAND__NAME = "results.brand.name",
+  RESULTS__BRAND__SLUG = "results.brand.slug",
+  RESULTS__BRAND__TRANSLATIONS__DESCRIPTION = "results.brand.translations.description",
+  RESULTS__BRAND__TRANSLATIONS__LOCALE = "results.brand.translations.locale",
+  RESULTS__BRAND__TRANSLATIONS__NAME = "results.brand.translations.name",
+  RESULTS__CATEGORIES__ID = "results.categories.id",
+  RESULTS__CATEGORIES__NAME = "results.categories.name",
+  RESULTS__CATEGORIES__PATH__ID = "results.categories.path.id",
+  RESULTS__CATEGORIES__PATH__NAME = "results.categories.path.name",
+  RESULTS__CATEGORIES__PATH__SLUG = "results.categories.path.slug",
+  RESULTS__CATEGORIES__PATH__TRANSLATIONS__DESCRIPTION = "results.categories.path.translations.description",
+  RESULTS__CATEGORIES__PATH__TRANSLATIONS__LOCALE = "results.categories.path.translations.locale",
+  RESULTS__CATEGORIES__PATH__TRANSLATIONS__NAME = "results.categories.path.translations.name",
+  RESULTS__CATEGORIES__SLUG = "results.categories.slug",
+  RESULTS__CATEGORIES__TRANSLATIONS__DESCRIPTION = "results.categories.translations.description",
+  RESULTS__CATEGORIES__TRANSLATIONS__LOCALE = "results.categories.translations.locale",
+  RESULTS__CATEGORIES__TRANSLATIONS__NAME = "results.categories.translations.name",
+  RESULTS__DELETED = "results.deleted",
+  RESULTS__DESCRIPTION = "results.description",
+  RESULTS__GROUP_VARIANTS_BY_VARIANT_TYPE_ID = "results.groupVariantsByVariantTypeId",
+  RESULTS__ID = "results.id",
+  RESULTS__META_DATA__CANONICALS = "results.metaData.canonicals",
+  RESULTS__META_DATA__DESCRIPTION = "results.metaData.description",
+  RESULTS__META_DATA__DISABLE_INDEX = "results.metaData.disableIndex",
+  RESULTS__META_DATA__METADATA_OVERRIDES__DESCRIPTION = "results.metaData.metadataOverrides.description",
+  RESULTS__META_DATA__METADATA_OVERRIDES__LANGUAGE = "results.metaData.metadataOverrides.language",
+  RESULTS__META_DATA__METADATA_OVERRIDES__PAGE_TITLE = "results.metaData.metadataOverrides.pageTitle",
+  RESULTS__META_DATA__METADATA_OVERRIDES__STOREFRONT_ID = "results.metaData.metadataOverrides.storefrontId",
+  RESULTS__META_DATA__METADATA_OVERRIDES__STOREFRONT_REGION_ID = "results.metaData.metadataOverrides.storefrontRegionId",
+  RESULTS__META_DATA__PAGE_TITLE = "results.metaData.pageTitle",
+  RESULTS__META_DATA__REDIRECT_TO = "results.metaData.redirectTo",
+  RESULTS__META_DATA__SLUG = "results.metaData.slug",
+  RESULTS__META_DATA__TRANSLATIONS__DESCRIPTION = "results.metaData.translations.description",
+  RESULTS__META_DATA__TRANSLATIONS__LOCALE = "results.metaData.translations.locale",
+  RESULTS__META_DATA__TRANSLATIONS__PAGE_TITLE = "results.metaData.translations.pageTitle",
+  RESULTS__NAME = "results.name",
+  RESULTS__PRODUCT_OPTION_SET_ID = "results.productOptionSetId",
+  RESULTS__PRODUCT_VARIANT_TYPES__ORDER = "results.productVariantTypes.order",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__ID = "results.productVariantTypes.variantType.id",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__NAME = "results.productVariantTypes.variantType.name",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__SELECTION_TYPE = "results.productVariantTypes.variantType.selectionType",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__TRANSLATIONS__LOCALE = "results.productVariantTypes.variantType.translations.locale",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__TRANSLATIONS__NAME = "results.productVariantTypes.variantType.translations.name",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__TRANSLATIONS__VALUES__ID = "results.productVariantTypes.variantType.translations.values.id",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__TRANSLATIONS__VALUES__NAME = "results.productVariantTypes.variantType.translations.values.name",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__VALUES__COLOR_CODE = "results.productVariantTypes.variantType.values.colorCode",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__VALUES__ID = "results.productVariantTypes.variantType.values.id",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__VALUES__NAME = "results.productVariantTypes.variantType.values.name",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_TYPE__VALUES__THUMBNAIL_IMAGE_ID = "results.productVariantTypes.variantType.values.thumbnailImageId",
+  RESULTS__PRODUCT_VARIANT_TYPES__VARIANT_VALUE_IDS = "results.productVariantTypes.variantValueIds",
+  RESULTS__SALES_CHANNEL_IDS = "results.salesChannelIds",
+  RESULTS__SHORT_DESCRIPTION = "results.shortDescription",
+  RESULTS__TAGS__ID = "results.tags.id",
+  RESULTS__TAGS__NAME = "results.tags.name",
+  RESULTS__TAGS__TRANSLATIONS__DESCRIPTION = "results.tags.translations.description",
+  RESULTS__TAGS__TRANSLATIONS__LOCALE = "results.tags.translations.locale",
+  RESULTS__TAGS__TRANSLATIONS__NAME = "results.tags.translations.name",
+  RESULTS__TRANSLATIONS__DESCRIPTION = "results.translations.description",
+  RESULTS__TRANSLATIONS__LOCALE = "results.translations.locale",
+  RESULTS__TRANSLATIONS__NAME = "results.translations.name",
+  RESULTS__TYPE = "results.type",
+  RESULTS__VARIANTS__ATTRIBUTES__IMAGE_IDS = "results.variants.attributes.imageIds",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__ID = "results.variants.attributes.productAttribute.id",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__NAME = "results.variants.attributes.productAttribute.name",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__COLUMNS__ID = "results.variants.attributes.productAttribute.tableTemplate.columns.id",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__COLUMNS__NAME = "results.variants.attributes.productAttribute.tableTemplate.columns.name",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__ROWS__ID = "results.variants.attributes.productAttribute.tableTemplate.rows.id",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TABLE_TEMPLATE__ROWS__NAME = "results.variants.attributes.productAttribute.tableTemplate.rows.name",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__DESCRIPTION = "results.variants.attributes.productAttribute.translations.description",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__LOCALE = "results.variants.attributes.productAttribute.translations.locale",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__NAME = "results.variants.attributes.productAttribute.translations.name",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__OPTIONS__ID = "results.variants.attributes.productAttribute.translations.options.id",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TRANSLATIONS__OPTIONS__NAME = "results.variants.attributes.productAttribute.translations.options.name",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE__TYPE = "results.variants.attributes.productAttribute.type",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE_OPTION__ID = "results.variants.attributes.productAttributeOption.id",
+  RESULTS__VARIANTS__ATTRIBUTES__PRODUCT_ATTRIBUTE_OPTION__NAME = "results.variants.attributes.productAttributeOption.name",
+  RESULTS__VARIANTS__ATTRIBUTES__VALUE = "results.variants.attributes.value",
+  RESULTS__VARIANTS__BARCODE_LIST = "results.variants.barcodeList",
+  RESULTS__VARIANTS__DELETED = "results.variants.deleted",
+  RESULTS__VARIANTS__ID = "results.variants.id",
+  RESULTS__VARIANTS__IMAGES__ID = "results.variants.images.id",
+  RESULTS__VARIANTS__IMAGES__IS_MAIN = "results.variants.images.isMain",
+  RESULTS__VARIANTS__IMAGES__IS_VIDEO = "results.variants.images.isVideo",
+  RESULTS__VARIANTS__IMAGES__ORDER = "results.variants.images.order",
+  RESULTS__VARIANTS__IS_ACTIVE = "results.variants.isActive",
+  RESULTS__VARIANTS__PRICES__BUY_PRICE = "results.variants.prices.buyPrice",
+  RESULTS__VARIANTS__PRICES__CURRENCY = "results.variants.prices.currency",
+  RESULTS__VARIANTS__PRICES__DISCOUNT_PRICE = "results.variants.prices.discountPrice",
+  RESULTS__VARIANTS__PRICES__PRICE_LIST_ID = "results.variants.prices.priceListId",
+  RESULTS__VARIANTS__PRICES__SELL_PRICE = "results.variants.prices.sellPrice",
+  RESULTS__VARIANTS__SELL_IF_OUT_OF_STOCK = "results.variants.sellIfOutOfStock",
+  RESULTS__VARIANTS__SKU = "results.variants.sku",
+  RESULTS__VARIANTS__STOCKS__STOCK_COUNT = "results.variants.stocks.stockCount",
+  RESULTS__VARIANTS__STOCKS__STOCK_LOCATION_ID = "results.variants.stocks.stockLocationId",
+  RESULTS__VARIANTS__VARIANT_VALUES__VARIANT_TYPE_ID = "results.variants.variantValues.variantTypeId",
+  RESULTS__VARIANTS__VARIANT_VALUES__VARIANT_VALUE_ID = "results.variants.variantValues.variantValueId",
+  RESULTS__VARIANTS__WEIGHT = "results.variants.weight",
+  RESULTS__WEIGHT = "results.weight",
+  TOTAL_COUNT = "totalCount",
+}