Class OpenFoodFacts

constructor

• new OpenFoodFacts(
      fetch: {
          (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
          (input: string | Request | URL, init?: RequestInit): Promise<Response>;
      },
      options?: OpenFoodFactsOptions,
  ): OpenFoodFacts

• Create OFF object

  Parameters

  • fetch: {
        (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
        (input: string | Request | URL, init?: RequestInit): Promise<Response>;
    }
    • • (input: RequestInfo | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>
      • (input: string | Request | URL, init?: RequestInit): Promise<Response>

      • MDN Reference

        Parameters

        • input: string | Request | URL
        • Optionalinit: RequestInit

        Returns Promise<Response>
  • options: OpenFoodFactsOptions = ...

    Options for the OFF Object

  Returns OpenFoodFacts

Readonlyrawv2

Readonlyrobotoff

getAdditives

• getAdditives(): Promise<Taxonomy<Additive>>

• Returns Promise<Taxonomy<Additive>>

getAllergens

• getAllergens(): Promise<Taxonomy<Allergen>>

• Returns Promise<Taxonomy<Allergen>>

getBrand

• getBrand(brandName: string): Promise<Brand>

• Parameters

  • brandName: string

  Returns Promise<Brand>

getBrands

• getBrands(): Promise<Taxonomy<Brand>>

• Returns Promise<Taxonomy<Brand>>

getCategories

• getCategories(): Promise<Taxonomy<Category>>

• Returns Promise<Taxonomy<Category>>

getCountries

• getCountries(): Promise<Taxonomy<Country>>

• Returns Promise<Taxonomy<Country>>

getIngredients

• getIngredients(): Promise<Taxonomy<Ingredient>>

• Returns Promise<Taxonomy<Ingredient>>

getLabels

• getLabels(): Promise<Taxonomy<Label>>

• Returns Promise<Taxonomy<Label>>

getLanguage

• getLanguage(languageName: string): Promise<Language>

• Parameters

  • languageName: string

  Returns Promise<Language>

getLanguages

• getLanguages(): Promise<Taxonomy<Language>>

• Returns Promise<Taxonomy<Language>>

getPackagings

• getPackagings(): Promise<Taxonomy<Ingredient>>

• Returns Promise<Taxonomy<Ingredient>>

getProduct

• getProduct(
      barcode: string,
  ): Promise<
      | undefined
      | {
          abbreviated_product_name?: string;
          code?: string;
          codes_tags?: string[];
          generic_name?: string;
          id?: string;
          lang?: string;
          lc?: string;
          nova_group?: number;
          nova_groups?: string;
          obsolete?: string;
          obsolete_since_date?: string;
          product_name?: string;
          product_name_en?: string;
          product_quantity?: string;
          product_quantity_unit?: string;
          quantity?: string;
      } & {
          additives_n?: number;
          checked?: string;
          complete?: number;
          completeness?: number;
          ecoscore_grade?: string;
          ecoscore_score?: number;
          food_groups?: string;
          food_groups_tags?: string[];
          nutrient_levels?: {
              fat?: "high"
              | "low"
              | "moderate";
              salt?: "high" | "low" | "moderate";
              "saturated-fat"?: "high" | "low" | "moderate";
              sugars?: "high" | "low" | "moderate";
          };
          packaging_text?: string;
          packagings?: readonly {
              material?: { id?: string; lc_name?: string };
              number_of_units?: number;
              quantity_per_unit?: string;
              quantity_per_unit_unit?: string;
              quantity_per_unit_value?: number;
              recycling?: { id?: string; lc_name?: string };
              shape?: { id?: string; lc_name?: string };
              weight?: number;
              weight_estimated?: number;
              weight_measured?: number;
              weight_source_id?: string;
              weight_specified?: number;
          }[];
          packagings_complete?: number;
          pnns_groups_1?: string;
          pnns_groups_1_tags?: string[];
          pnns_groups_2?: string;
          pnns_groups_2_tags?: string[];
          popularity_key?: number;
          popularity_tags?: string[];
          scans_n?: number;
          serving_quantity?: string;
          serving_quantity_unit?: string;
          serving_size?: string;
          unique_scans_n?: number;
      } & {
          brands?: string;
          brands_tags?: string[];
          categories?: string;
          categories_hierarchy?: string[];
          categories_lc?: string;
          categories_tags?: string[];
          checkers_tags?: string[];
          cities?: string;
          cities_tags?: Record<string, never>[];
          correctors_tags?: string[];
          countries?: string;
          countries_hierarchy?: string[];
          countries_lc?: string;
          countries_tags?: string[];
          ecoscore_tags?: string[];
          emb_codes?: string;
          emb_codes_orig?: string;
          emb_codes_tags?: Record<string, never>[];
          entry_dates_tags?: string[];
          labels?: string;
          labels_hierarchy?: string[];
          labels_lc?: string;
          labels_tags?: string[];
          manufacturing_places?: string;
          manufacturing_places_tags?: Record<string, never>[];
          nova_groups_tags?: string[];
          nutrient_levels_tags?: string[];
      } & {
          image_front_small_url?: string;
          image_front_thumb_url?: string;
          image_front_url?: string;
          image_nutrition_small_url?: string;
          image_nutrition_thumb_url?: string;
          image_nutrition_url?: string;
          image_small_url?: string;
          image_thumb_url?: string;
          image_url?: string;
          images?: {
              "1"?: {
                  sizes?: { full?: (...)
                  | (...) };
                  uploaded_t?: string;
                  uploader?: string;
              };
              front?: {
                  angle?: number;
                  coordinates_image_size?: string;
                  geometry?: string;
                  imgid?: string;
                  normalize?: null;
                  rev?: string;
                  sizes?: {
                      "100"?: (...)
                      | (...);
                      "200"?: (...) | (...);
                      "400"?: (...) | (...);
                      full?: (...) | (...);
                  };
                  white_magic?: null;
                  x1?: string;
                  x2?: string;
                  y1?: string;
                  y2?: string;
              };
          };
          last_image_dates_tags?: string[];
          last_image_t?: number;
          selected_images?: {
              front?: {
                  display?: Record<string, never>;
                  small?: Record<string, never>;
                  thumb?: Record<string, never>;
              };
          };
      } & {
          ecoscore_data?: {
              adjustments?: {
                  origins_of_ingredients?: {
                      aggregated_origins?: (...)
                      | (...);
                      epi_score?: (...) | (...);
                      epi_value?: (...) | (...);
                      origins_from_origins_field?: (...) | (...);
                      transportation_scores?: (...) | (...);
                      transportation_values?: (...) | (...);
                      values?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  packaging?: {
                      non_recyclable_and_non_biodegradable_materials?: (...)
                      | (...);
                      packagings?: (...) | (...);
                      score?: (...) | (...);
                      value?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  production_system?: {
                      labels?: (...)
                      | (...);
                      value?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  threatened_species?: {
                      ingredient?: (...)
                      | (...);
                      value?: (...) | (...);
                  };
              };
              agribalyse?: {
                  agribalyse_food_code?: string;
                  co2_agriculture?: number;
                  co2_consumption?: number;
                  co2_distribution?: number;
                  co2_packaging?: number;
                  co2_processing?: number;
                  co2_total?: number;
                  co2_transportation?: number;
                  code?: string;
                  dqr?: string;
                  ef_agriculture?: number;
                  ef_consumption?: number;
                  ef_distribution?: number;
                  ef_packaging?: number;
                  ef_processing?: number;
                  ef_total?: number;
                  ef_transportation?: number;
                  is_beverage?: number;
                  name_en?: string;
                  score?: number;
                  version?: string;
              };
              grade?: string;
              grades?: Record<string, never>;
              missing?: { labels?: number; origins?: number; packagings?: number };
              missing_data_warning?: number;
              previous_data?: {
                  agribalyse?: {
                      agribalyse_food_code?: (...) | (...);
                      co2_agriculture?: (...) | (...);
                      co2_consumption?: (...) | (...);
                      co2_distribution?: (...) | (...);
                      co2_packaging?: (...) | (...);
                      co2_processing?: (...) | (...);
                      co2_total?: (...) | (...);
                      co2_transportation?: (...) | (...);
                      code?: (...) | (...);
                      dqr?: (...) | (...);
                      ef_agriculture?: (...) | (...);
                      ef_consumption?: (...) | (...);
                      ef_distribution?: (...) | (...);
                      ef_packaging?: (...) | (...);
                      ef_processing?: (...) | (...);
                      ef_total?: (...) | (...);
                      ef_transportation?: (...) | (...);
                      is_beverage?: (...) | (...);
                      name_en?: (...) | (...);
                      score?: (...) | (...);
                      version?: (...) | (...);
                  };
                  grade?: string;
                  score?: number;
              };
              score?: number;
              scores?: Record<string, never>;
              status?: string;
          };
          ecoscore_extended_data_version?: string;
          environment_impact_level?: string;
          environment_impact_level_tags?: Record<string, never>[];
      } & {
          additives_tags?: string[];
          allergens?: string;
          allergens_hierarchy?: string[];
          allergens_lc?: string;
          allergens_tags?: string[];
          ingredients?: {
              id?: string;
              ingredients?: { id?: string | undefined; ingredients?: ...[] | undefined; percent?: number | undefined; percent_estimate?: number | undefined; percent_max?: number | undefined; percent_min?: number | undefined; text?: string | undefined; vegan?: string | undefined; vegetarian?: string | undefined; }[] | undefined;
              percent?: number;
              percent_estimate?: number;
              percent_max?: number;
              percent_min?: number;
              text?: string;
              vegan?: string;
              vegetarian?: string;
          }[];
          ingredients_analysis?: {
              "en:palm-oil"?: string[];
              "en:vegan-status-unknown"?: string[];
              "en:vegetarian-status-unknown"?: string[];
          };
          ingredients_analysis_tags?: string[];
          ingredients_from_or_that_may_be_from_palm_oil_n?: number;
          ingredients_from_palm_oil_n?: number;
          ingredients_from_palm_oil_tags?: Record<string, never>[];
          ingredients_hierarchy?: string[];
          ingredients_lc?: string;
          ingredients_n?: number;
          ingredients_n_tags?: string[];
          ingredients_original_tags?: string[];
          ingredients_percent_analysis?: number;
          ingredients_tags?: string[];
          ingredients_text?: string;
          ingredients_text_with_allergens?: string;
          ingredients_that_may_be_from_palm_oil_n?: number;
          ingredients_that_may_be_from_palm_oil_tags?: Record<string, never>[];
          ingredients_with_specified_percent_n?: number;
          ingredients_with_specified_percent_sum?: number;
          ingredients_with_unspecified_percent_n?: number;
          ingredients_with_unspecified_percent_sum?: number;
          known_ingredients_n?: number;
          origins?: string;
          origins_hierarchy?: Record<string, never>[];
          origins_lc?: string;
          origins_tags?: Record<string, never>[];
          traces?: string;
          traces_hierarchy?: Record<string, never>[];
          traces_lc?: string;
          traces_tags?: Record<string, never>[];
          unknown_ingredients_n?: number;
      } & {
          no_nutrition_data?: string;
          nutriments?: {
              alcohol?: number;
              carbohydrates?: number;
              "carbon-footprint-from-known-ingredients_product"?: number;
              "carbon-footprint-from-known-ingredients_serving"?: number;
              energy?: number;
              energy_unit?: "kcal"
              | "kj";
              energy_value?: number;
              "energy-kcal"?: number;
              "energy-kj"?: number;
              erythritol?: number;
              fat?: number;
              "fruits-vegetables-legumes-estimate-from-ingredients"?: number;
              "fruits-vegetables-nuts-estimate-from-ingredients"?: number;
              "nova-group"?: number;
              "nutrition-score-fr"?: unknown;
              proteins?: number;
              salt?: number;
              "saturated-fat"?: number;
              sodium?: number;
              sugars?: number;
          };
          nutriscore_data?: {
              energy?: number;
              energy_points?: number;
              energy_value?: number;
              fiber?: number;
              fiber_points?: number;
              fiber_value?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils_points?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils_value?: number;
              grade?: string;
              is_beverage?: number;
              is_cheese?: number;
              is_fat?: number;
              is_water?: number;
              negative_points?: number;
              positive_points?: number;
              proteins?: number;
              proteins_points?: number;
              proteins_value?: number;
              saturated_fat?: number;
              saturated_fat_points?: number;
              saturated_fat_ratio?: number;
              saturated_fat_ratio_points?: number;
              saturated_fat_ratio_value?: number;
              saturated_fat_value?: number;
              score?: number;
              sodium?: number;
              sodium_points?: number;
              sodium_value?: number;
              sugars?: number;
              sugars_points?: number;
              sugars_value?: number;
          };
          nutriscore_grade?: "d"
          | "a"
          | "b"
          | "c"
          | "e";
          nutriscore_score?: number;
          nutriscore_score_opposite?: number;
          nutrition_data_per?: "serving" | "100g";
          nutrition_data_prepared_per?: "serving" | "100g";
          nutrition_grade_fr?: string;
          nutrition_grades?: string;
          nutrition_grades_tags?: string[];
          nutrition_score_beverage?: number;
          nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients?: number;
          nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients_value?: number;
          nutrition_score_warning_no_fiber?: number;
          other_nutritional_substances_tags?: Record<string, never>[];
          unknown_nutrients_tags?: Record<string, never>[];
          vitamins_tags?: Record<string, never>[];
      } & {
          data_quality_bugs_tags?: Record<string, never>[];
          data_quality_errors_tags?: Record<string, never>[];
          data_quality_info_tags?: string[];
          data_quality_tags?: string[];
          data_quality_warnings_tags?: string[];
          data_sources?: string;
          data_sources_tags?: string[];
          last_check_dates_tags?: string[];
          last_checked_t?: number;
          last_checker?: string;
          misc_tags?: string[];
          states?: string;
          states_hierarchy?: string[];
          states_tags?: string[];
      } & {
          added_countries_tags?: Record<string, never>[];
          additives_original_tags?: string[];
          additives_prev_original_tags?: string[];
          allergens_from_ingredients?: string;
          allergens_from_user?: string;
          amino_acids_prev_tags?: Record<string, never>[];
          amino_acids_tags?: Record<string, never>[];
          carbon_footprint_percent_of_known_ingredients?: number;
          categories_properties?: {
              "agribalyse_food_code:en"?: string;
              "agribalyse_proxy_food_code:en"?: string;
              "ciqual_food_code:en"?: string;
          };
          categories_properties_tags?: string[];
          category_properties?: { [key: string]: string };
          ciqual_food_name_tags?: string[];
          compared_to_category?: string;
          conservation_conditions?: string;
          customer_service?: string;
          expiration_date?: string;
          link?: string;
          main_countries_tags?: Record<string, never>[];
          minerals_prev_tags?: Record<string, never>[];
          minerals_tags?: Record<string, never>[];
          nova_groups_markers?: { "3"?: string[][]; "4"?: any };
          nucleotides_tags?: Record<string, never>[];
          origin?: string;
          owner_fields?: {
              additionalProperties?: string | number | Record<string, never>;
          };
          purchase_places?: string;
          purchase_places_tags?: string[];
          stores?: string;
          stores_tags?: string[];
          traces_from_ingredients?: string;
          traces_from_user?: string;
      } & {
          created_t?: number;
          creator?: string;
          editors_tags?: string[];
          informers_tags?: string[];
          interface_version_created?: string;
          interface_version_modified?: string;
          languages?: Record<string, never>;
          languages_codes?: Record<string, never>;
          languages_hierarchy?: string[];
          languages_tags?: string[];
          last_edit_dates_tags?: string[];
          last_editor?: string;
          last_modified_by?: string;
          last_modified_t?: number;
          owner?: string;
          owners_tags?: string;
          photographers_tags?: string[];
          rev?: number;
          sources?: {
              fields?: string[];
              id?: string;
              images?: Record<string, never>[];
              import_t?: number;
              manufacturer?: string | number;
              name?: string;
              source_licence?: string;
              source_licence_url?: string;
              url?: null | string;
          }[];
          sources_fields?: {
              "org-gs1"?: {
                  gln?: string;
                  gpcCategoryCode?: string;
                  gpcCategoryName?: string;
                  isAllergenRelevantDataProvided?: string;
                  lastChangeDateTime?: string;
                  partyName?: string;
                  productionVariantDescription?: string;
                  publicationDateTime?: string;
              };
          };
          teams?: string;
          teams_tags?: string[];
          update_key?: string;
      } & {
          knowledge_panels?: {
              additionalProperties?: {
                  elements?: {
                      action_element?: ...;
                      image_element?: ...;
                      panel_element?: ...;
                      panel_group_element?: ...;
                      table_element?: ...;
                      text_element?: ...;
                      type: ...;
                  }[];
                  expand_for?: string;
                  expanded?: boolean;
                  level?: string;
                  size?: "small";
                  title_element?: {
                      grade?: (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                      icon_color_from_evaluation?: (...) | (...);
                      icon_size?: (...) | (...);
                      icon_url?: (...) | (...);
                      title?: (...) | (...);
                      type?: (...) | (...);
                  };
                  topics?: string[];
                  type?: string;
              };
          };
      },
  >

• It is used to get a specific product using barcode

  Parameters

  • barcode: string

    Barcode of the product you want to fetch details

  Returns Promise<
      | undefined
      | {
          abbreviated_product_name?: string;
          code?: string;
          codes_tags?: string[];
          generic_name?: string;
          id?: string;
          lang?: string;
          lc?: string;
          nova_group?: number;
          nova_groups?: string;
          obsolete?: string;
          obsolete_since_date?: string;
          product_name?: string;
          product_name_en?: string;
          product_quantity?: string;
          product_quantity_unit?: string;
          quantity?: string;
      } & {
          additives_n?: number;
          checked?: string;
          complete?: number;
          completeness?: number;
          ecoscore_grade?: string;
          ecoscore_score?: number;
          food_groups?: string;
          food_groups_tags?: string[];
          nutrient_levels?: {
              fat?: "high"
              | "low"
              | "moderate";
              salt?: "high" | "low" | "moderate";
              "saturated-fat"?: "high" | "low" | "moderate";
              sugars?: "high" | "low" | "moderate";
          };
          packaging_text?: string;
          packagings?: readonly {
              material?: { id?: string; lc_name?: string };
              number_of_units?: number;
              quantity_per_unit?: string;
              quantity_per_unit_unit?: string;
              quantity_per_unit_value?: number;
              recycling?: { id?: string; lc_name?: string };
              shape?: { id?: string; lc_name?: string };
              weight?: number;
              weight_estimated?: number;
              weight_measured?: number;
              weight_source_id?: string;
              weight_specified?: number;
          }[];
          packagings_complete?: number;
          pnns_groups_1?: string;
          pnns_groups_1_tags?: string[];
          pnns_groups_2?: string;
          pnns_groups_2_tags?: string[];
          popularity_key?: number;
          popularity_tags?: string[];
          scans_n?: number;
          serving_quantity?: string;
          serving_quantity_unit?: string;
          serving_size?: string;
          unique_scans_n?: number;
      } & {
          brands?: string;
          brands_tags?: string[];
          categories?: string;
          categories_hierarchy?: string[];
          categories_lc?: string;
          categories_tags?: string[];
          checkers_tags?: string[];
          cities?: string;
          cities_tags?: Record<string, never>[];
          correctors_tags?: string[];
          countries?: string;
          countries_hierarchy?: string[];
          countries_lc?: string;
          countries_tags?: string[];
          ecoscore_tags?: string[];
          emb_codes?: string;
          emb_codes_orig?: string;
          emb_codes_tags?: Record<string, never>[];
          entry_dates_tags?: string[];
          labels?: string;
          labels_hierarchy?: string[];
          labels_lc?: string;
          labels_tags?: string[];
          manufacturing_places?: string;
          manufacturing_places_tags?: Record<string, never>[];
          nova_groups_tags?: string[];
          nutrient_levels_tags?: string[];
      } & {
          image_front_small_url?: string;
          image_front_thumb_url?: string;
          image_front_url?: string;
          image_nutrition_small_url?: string;
          image_nutrition_thumb_url?: string;
          image_nutrition_url?: string;
          image_small_url?: string;
          image_thumb_url?: string;
          image_url?: string;
          images?: {
              "1"?: {
                  sizes?: { full?: (...)
                  | (...) };
                  uploaded_t?: string;
                  uploader?: string;
              };
              front?: {
                  angle?: number;
                  coordinates_image_size?: string;
                  geometry?: string;
                  imgid?: string;
                  normalize?: null;
                  rev?: string;
                  sizes?: {
                      "100"?: (...)
                      | (...);
                      "200"?: (...) | (...);
                      "400"?: (...) | (...);
                      full?: (...) | (...);
                  };
                  white_magic?: null;
                  x1?: string;
                  x2?: string;
                  y1?: string;
                  y2?: string;
              };
          };
          last_image_dates_tags?: string[];
          last_image_t?: number;
          selected_images?: {
              front?: {
                  display?: Record<string, never>;
                  small?: Record<string, never>;
                  thumb?: Record<string, never>;
              };
          };
      } & {
          ecoscore_data?: {
              adjustments?: {
                  origins_of_ingredients?: {
                      aggregated_origins?: (...)
                      | (...);
                      epi_score?: (...) | (...);
                      epi_value?: (...) | (...);
                      origins_from_origins_field?: (...) | (...);
                      transportation_scores?: (...) | (...);
                      transportation_values?: (...) | (...);
                      values?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  packaging?: {
                      non_recyclable_and_non_biodegradable_materials?: (...)
                      | (...);
                      packagings?: (...) | (...);
                      score?: (...) | (...);
                      value?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  production_system?: {
                      labels?: (...)
                      | (...);
                      value?: (...) | (...);
                      warning?: (...) | (...);
                  };
                  threatened_species?: {
                      ingredient?: (...)
                      | (...);
                      value?: (...) | (...);
                  };
              };
              agribalyse?: {
                  agribalyse_food_code?: string;
                  co2_agriculture?: number;
                  co2_consumption?: number;
                  co2_distribution?: number;
                  co2_packaging?: number;
                  co2_processing?: number;
                  co2_total?: number;
                  co2_transportation?: number;
                  code?: string;
                  dqr?: string;
                  ef_agriculture?: number;
                  ef_consumption?: number;
                  ef_distribution?: number;
                  ef_packaging?: number;
                  ef_processing?: number;
                  ef_total?: number;
                  ef_transportation?: number;
                  is_beverage?: number;
                  name_en?: string;
                  score?: number;
                  version?: string;
              };
              grade?: string;
              grades?: Record<string, never>;
              missing?: { labels?: number; origins?: number; packagings?: number };
              missing_data_warning?: number;
              previous_data?: {
                  agribalyse?: {
                      agribalyse_food_code?: (...) | (...);
                      co2_agriculture?: (...) | (...);
                      co2_consumption?: (...) | (...);
                      co2_distribution?: (...) | (...);
                      co2_packaging?: (...) | (...);
                      co2_processing?: (...) | (...);
                      co2_total?: (...) | (...);
                      co2_transportation?: (...) | (...);
                      code?: (...) | (...);
                      dqr?: (...) | (...);
                      ef_agriculture?: (...) | (...);
                      ef_consumption?: (...) | (...);
                      ef_distribution?: (...) | (...);
                      ef_packaging?: (...) | (...);
                      ef_processing?: (...) | (...);
                      ef_total?: (...) | (...);
                      ef_transportation?: (...) | (...);
                      is_beverage?: (...) | (...);
                      name_en?: (...) | (...);
                      score?: (...) | (...);
                      version?: (...) | (...);
                  };
                  grade?: string;
                  score?: number;
              };
              score?: number;
              scores?: Record<string, never>;
              status?: string;
          };
          ecoscore_extended_data_version?: string;
          environment_impact_level?: string;
          environment_impact_level_tags?: Record<string, never>[];
      } & {
          additives_tags?: string[];
          allergens?: string;
          allergens_hierarchy?: string[];
          allergens_lc?: string;
          allergens_tags?: string[];
          ingredients?: {
              id?: string;
              ingredients?: { id?: string | undefined; ingredients?: ...[] | undefined; percent?: number | undefined; percent_estimate?: number | undefined; percent_max?: number | undefined; percent_min?: number | undefined; text?: string | undefined; vegan?: string | undefined; vegetarian?: string | undefined; }[] | undefined;
              percent?: number;
              percent_estimate?: number;
              percent_max?: number;
              percent_min?: number;
              text?: string;
              vegan?: string;
              vegetarian?: string;
          }[];
          ingredients_analysis?: {
              "en:palm-oil"?: string[];
              "en:vegan-status-unknown"?: string[];
              "en:vegetarian-status-unknown"?: string[];
          };
          ingredients_analysis_tags?: string[];
          ingredients_from_or_that_may_be_from_palm_oil_n?: number;
          ingredients_from_palm_oil_n?: number;
          ingredients_from_palm_oil_tags?: Record<string, never>[];
          ingredients_hierarchy?: string[];
          ingredients_lc?: string;
          ingredients_n?: number;
          ingredients_n_tags?: string[];
          ingredients_original_tags?: string[];
          ingredients_percent_analysis?: number;
          ingredients_tags?: string[];
          ingredients_text?: string;
          ingredients_text_with_allergens?: string;
          ingredients_that_may_be_from_palm_oil_n?: number;
          ingredients_that_may_be_from_palm_oil_tags?: Record<string, never>[];
          ingredients_with_specified_percent_n?: number;
          ingredients_with_specified_percent_sum?: number;
          ingredients_with_unspecified_percent_n?: number;
          ingredients_with_unspecified_percent_sum?: number;
          known_ingredients_n?: number;
          origins?: string;
          origins_hierarchy?: Record<string, never>[];
          origins_lc?: string;
          origins_tags?: Record<string, never>[];
          traces?: string;
          traces_hierarchy?: Record<string, never>[];
          traces_lc?: string;
          traces_tags?: Record<string, never>[];
          unknown_ingredients_n?: number;
      } & {
          no_nutrition_data?: string;
          nutriments?: {
              alcohol?: number;
              carbohydrates?: number;
              "carbon-footprint-from-known-ingredients_product"?: number;
              "carbon-footprint-from-known-ingredients_serving"?: number;
              energy?: number;
              energy_unit?: "kcal"
              | "kj";
              energy_value?: number;
              "energy-kcal"?: number;
              "energy-kj"?: number;
              erythritol?: number;
              fat?: number;
              "fruits-vegetables-legumes-estimate-from-ingredients"?: number;
              "fruits-vegetables-nuts-estimate-from-ingredients"?: number;
              "nova-group"?: number;
              "nutrition-score-fr"?: unknown;
              proteins?: number;
              salt?: number;
              "saturated-fat"?: number;
              sodium?: number;
              sugars?: number;
          };
          nutriscore_data?: {
              energy?: number;
              energy_points?: number;
              energy_value?: number;
              fiber?: number;
              fiber_points?: number;
              fiber_value?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils_points?: number;
              fruits_vegetables_nuts_colza_walnut_olive_oils_value?: number;
              grade?: string;
              is_beverage?: number;
              is_cheese?: number;
              is_fat?: number;
              is_water?: number;
              negative_points?: number;
              positive_points?: number;
              proteins?: number;
              proteins_points?: number;
              proteins_value?: number;
              saturated_fat?: number;
              saturated_fat_points?: number;
              saturated_fat_ratio?: number;
              saturated_fat_ratio_points?: number;
              saturated_fat_ratio_value?: number;
              saturated_fat_value?: number;
              score?: number;
              sodium?: number;
              sodium_points?: number;
              sodium_value?: number;
              sugars?: number;
              sugars_points?: number;
              sugars_value?: number;
          };
          nutriscore_grade?: "d"
          | "a"
          | "b"
          | "c"
          | "e";
          nutriscore_score?: number;
          nutriscore_score_opposite?: number;
          nutrition_data_per?: "serving" | "100g";
          nutrition_data_prepared_per?: "serving" | "100g";
          nutrition_grade_fr?: string;
          nutrition_grades?: string;
          nutrition_grades_tags?: string[];
          nutrition_score_beverage?: number;
          nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients?: number;
          nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients_value?: number;
          nutrition_score_warning_no_fiber?: number;
          other_nutritional_substances_tags?: Record<string, never>[];
          unknown_nutrients_tags?: Record<string, never>[];
          vitamins_tags?: Record<string, never>[];
      } & {
          data_quality_bugs_tags?: Record<string, never>[];
          data_quality_errors_tags?: Record<string, never>[];
          data_quality_info_tags?: string[];
          data_quality_tags?: string[];
          data_quality_warnings_tags?: string[];
          data_sources?: string;
          data_sources_tags?: string[];
          last_check_dates_tags?: string[];
          last_checked_t?: number;
          last_checker?: string;
          misc_tags?: string[];
          states?: string;
          states_hierarchy?: string[];
          states_tags?: string[];
      } & {
          added_countries_tags?: Record<string, never>[];
          additives_original_tags?: string[];
          additives_prev_original_tags?: string[];
          allergens_from_ingredients?: string;
          allergens_from_user?: string;
          amino_acids_prev_tags?: Record<string, never>[];
          amino_acids_tags?: Record<string, never>[];
          carbon_footprint_percent_of_known_ingredients?: number;
          categories_properties?: {
              "agribalyse_food_code:en"?: string;
              "agribalyse_proxy_food_code:en"?: string;
              "ciqual_food_code:en"?: string;
          };
          categories_properties_tags?: string[];
          category_properties?: { [key: string]: string };
          ciqual_food_name_tags?: string[];
          compared_to_category?: string;
          conservation_conditions?: string;
          customer_service?: string;
          expiration_date?: string;
          link?: string;
          main_countries_tags?: Record<string, never>[];
          minerals_prev_tags?: Record<string, never>[];
          minerals_tags?: Record<string, never>[];
          nova_groups_markers?: { "3"?: string[][]; "4"?: any };
          nucleotides_tags?: Record<string, never>[];
          origin?: string;
          owner_fields?: {
              additionalProperties?: string | number | Record<string, never>;
          };
          purchase_places?: string;
          purchase_places_tags?: string[];
          stores?: string;
          stores_tags?: string[];
          traces_from_ingredients?: string;
          traces_from_user?: string;
      } & {
          created_t?: number;
          creator?: string;
          editors_tags?: string[];
          informers_tags?: string[];
          interface_version_created?: string;
          interface_version_modified?: string;
          languages?: Record<string, never>;
          languages_codes?: Record<string, never>;
          languages_hierarchy?: string[];
          languages_tags?: string[];
          last_edit_dates_tags?: string[];
          last_editor?: string;
          last_modified_by?: string;
          last_modified_t?: number;
          owner?: string;
          owners_tags?: string;
          photographers_tags?: string[];
          rev?: number;
          sources?: {
              fields?: string[];
              id?: string;
              images?: Record<string, never>[];
              import_t?: number;
              manufacturer?: string | number;
              name?: string;
              source_licence?: string;
              source_licence_url?: string;
              url?: null | string;
          }[];
          sources_fields?: {
              "org-gs1"?: {
                  gln?: string;
                  gpcCategoryCode?: string;
                  gpcCategoryName?: string;
                  isAllergenRelevantDataProvided?: string;
                  lastChangeDateTime?: string;
                  partyName?: string;
                  productionVariantDescription?: string;
                  publicationDateTime?: string;
              };
          };
          teams?: string;
          teams_tags?: string[];
          update_key?: string;
      } & {
          knowledge_panels?: {
              additionalProperties?: {
                  elements?: {
                      action_element?: ...;
                      image_element?: ...;
                      panel_element?: ...;
                      panel_group_element?: ...;
                      table_element?: ...;
                      text_element?: ...;
                      type: ...;
                  }[];
                  expand_for?: string;
                  expanded?: boolean;
                  level?: string;
                  size?: "small";
                  title_element?: {
                      grade?: (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...)
                      | (...);
                      icon_color_from_evaluation?: (...) | (...);
                      icon_size?: (...) | (...);
                      icon_url?: (...) | (...);
                      title?: (...) | (...);
                      type?: (...) | (...);
                  };
                  topics?: string[];
                  type?: string;
              };
          };
      },
  >

getProductImages

• getProductImages(barcode: string): Promise<null | string[]>

• Parameters

  • barcode: string

  Returns Promise<null | string[]>

getStates

• getStates(): Promise<Taxonomy<State>>

• Returns Promise<Taxonomy<State>>

getStores

• getStores(): Promise<Taxonomy<Store>>

• Returns Promise<Taxonomy<Store>>

getTaxo

• getTaxo<T extends TaxoNode>(taxo: string): Promise<Taxonomy<T>>

• Type Parameters

  • T extends TaxoNode

  Parameters

  • taxo: string

  Returns Promise<Taxonomy<T>>

performOCR

• performOCR(
      barcode: string,
      photoId: string,
      ocrEngine?: "google_cloud_vision",
  ): Promise<undefined | { status?: number }>

• Parameters

  • barcode: string
  • photoId: string
  • ocrEngine: "google_cloud_vision" = "google_cloud_vision"

  Returns Promise<undefined | { status?: number }>

search

• search(
      fields?: string,
      sortBy?:
          | "product_name"
          | "last_modified_t"
          | "scans_n"
          | "unique_scans_n"
          | "created_t"
          | "completeness"
          | "popularity_key"
          | "nutriscore_score"
          | "nova_score"
          | "nothing"
          | "ecoscore_score",
  ): Promise<
      | undefined
      | {
          count?: number;
          page?: number;
          page_count?: number;
          page_size?: number;
          products?: (
              {
                  abbreviated_product_name?: string;
                  code?: string;
                  codes_tags?: string[];
                  generic_name?: string;
                  id?: string;
                  lang?: string;
                  lc?: string;
                  nova_group?: number;
                  nova_groups?: string;
                  obsolete?: string;
                  obsolete_since_date?: string;
                  product_name?: string;
                  product_name_en?: string;
                  product_quantity?: string;
                  product_quantity_unit?: string;
                  quantity?: string;
              } & {
                  additives_n?: number;
                  checked?: string;
                  complete?: number;
                  completeness?: number;
                  ecoscore_grade?: string;
                  ecoscore_score?: number;
                  food_groups?: string;
                  food_groups_tags?: string[];
                  nutrient_levels?: {
                      fat?: "high"
                      | "low"
                      | "moderate";
                      salt?: "high" | "low" | "moderate";
                      "saturated-fat"?: "high" | "low" | "moderate";
                      sugars?: "high" | "low" | "moderate";
                  };
                  packaging_text?: string;
                  packagings?: readonly {
                      material?: (...)
                      | (...);
                      number_of_units?: (...) | (...);
                      quantity_per_unit?: (...) | (...);
                      quantity_per_unit_unit?: (...) | (...);
                      quantity_per_unit_value?: (...) | (...);
                      recycling?: (...) | (...);
                      shape?: (...) | (...);
                      weight?: (...) | (...);
                      weight_estimated?: (...) | (...);
                      weight_measured?: (...) | (...);
                      weight_source_id?: (...) | (...);
                      weight_specified?: (...) | (...);
                  }[];
                  packagings_complete?: number;
                  pnns_groups_1?: string;
                  pnns_groups_1_tags?: string[];
                  pnns_groups_2?: string;
                  pnns_groups_2_tags?: string[];
                  popularity_key?: number;
                  popularity_tags?: string[];
                  scans_n?: number;
                  serving_quantity?: string;
                  serving_quantity_unit?: string;
                  serving_size?: string;
                  unique_scans_n?: number;
              } & {
                  brands?: string;
                  brands_tags?: string[];
                  categories?: string;
                  categories_hierarchy?: string[];
                  categories_lc?: string;
                  categories_tags?: string[];
                  checkers_tags?: string[];
                  cities?: string;
                  cities_tags?: Record<string, never>[];
                  correctors_tags?: string[];
                  countries?: string;
                  countries_hierarchy?: string[];
                  countries_lc?: string;
                  countries_tags?: string[];
                  ecoscore_tags?: string[];
                  emb_codes?: string;
                  emb_codes_orig?: string;
                  emb_codes_tags?: Record<string, never>[];
                  entry_dates_tags?: string[];
                  labels?: string;
                  labels_hierarchy?: string[];
                  labels_lc?: string;
                  labels_tags?: string[];
                  manufacturing_places?: string;
                  manufacturing_places_tags?: Record<string, never>[];
                  nova_groups_tags?: string[];
                  nutrient_levels_tags?: string[];
              } & {
                  image_front_small_url?: string;
                  image_front_thumb_url?: string;
                  image_front_url?: string;
                  image_nutrition_small_url?: string;
                  image_nutrition_thumb_url?: string;
                  image_nutrition_url?: string;
                  image_small_url?: string;
                  image_thumb_url?: string;
                  image_url?: string;
                  images?: {
                      "1"?: { sizes?: ...; uploaded_t?: ...; uploader?: ... };
                      front?: {
                          angle?: ...;
                          coordinates_image_size?: ...;
                          geometry?: ...;
                          imgid?: ...;
                          normalize?: ...;
                          rev?: ...;
                          sizes?: ...;
                          white_magic?: ...;
                          x1?: ...;
                          x2?: ...;
                          y1?: ...;
                          y2?: ...;
                      };
                  };
                  last_image_dates_tags?: string[];
                  last_image_t?: number;
                  selected_images?: {
                      front?: { display?: ...; small?: ...; thumb?: ... };
                  };
              } & {
                  ecoscore_data?: {
                      adjustments?: {
                          origins_of_ingredients?: ...;
                          packaging?: ...;
                          production_system?: ...;
                          threatened_species?: ...;
                      };
                      agribalyse?: {
                          agribalyse_food_code?: ...;
                          co2_agriculture?: ...;
                          co2_consumption?: ...;
                          co2_distribution?: ...;
                          co2_packaging?: ...;
                          co2_processing?: ...;
                          co2_total?: ...;
                          co2_transportation?: ...;
                          code?: ...;
                          dqr?: ...;
                          ef_agriculture?: ...;
                          ef_consumption?: ...;
                          ef_distribution?: ...;
                          ef_packaging?: ...;
                          ef_processing?: ...;
                          ef_total?: ...;
                          ef_transportation?: ...;
                          is_beverage?: ...;
                          name_en?: ...;
                          score?: ...;
                          version?: ...;
                      };
                      grade?: string;
                      grades?: Record<(...), (...)>;
                      missing?: { labels?: ...; origins?: ...; packagings?: ... };
                      missing_data_warning?: number;
                      previous_data?: { agribalyse?: ...; grade?: ...; score?: ... };
                      score?: number;
                      scores?: Record<(...), (...)>;
                      status?: string;
                  };
                  ecoscore_extended_data_version?: string;
                  environment_impact_level?: string;
                  environment_impact_level_tags?: Record<string, never>[];
              } & {
                  additives_tags?: string[];
                  allergens?: string;
                  allergens_hierarchy?: string[];
                  allergens_lc?: string;
                  allergens_tags?: string[];
                  ingredients?: {
                      id?: (...)
                      | (...);
                      ingredients?: { id?: string | undefined; ingredients?: ...[] | undefined; percent?: number | undefined; percent_estimate?: number | undefined; percent_max?: number | undefined; percent_min?: number | undefined; text?: string | undefined; vegan?: string | undefined; vegetarian?: string | undefined; }[] | undefined;
                      percent?: (...) | (...);
                      percent_estimate?: (...) | (...);
                      percent_max?: (...) | (...);
                      percent_min?: (...) | (...);
                      text?: (...) | (...);
                      vegan?: (...) | (...);
                      vegetarian?: (...) | (...);
                  }[];
                  ingredients_analysis?: {
                      "en:palm-oil"?: (...)[];
                      "en:vegan-status-unknown"?: (...)[];
                      "en:vegetarian-status-unknown"?: (...)[];
                  };
                  ingredients_analysis_tags?: string[];
                  ingredients_from_or_that_may_be_from_palm_oil_n?: number;
                  ingredients_from_palm_oil_n?: number;
                  ingredients_from_palm_oil_tags?: Record<string, never>[];
                  ingredients_hierarchy?: string[];
                  ingredients_lc?: string;
                  ingredients_n?: number;
                  ingredients_n_tags?: string[];
                  ingredients_original_tags?: string[];
                  ingredients_percent_analysis?: number;
                  ingredients_tags?: string[];
                  ingredients_text?: string;
                  ingredients_text_with_allergens?: string;
                  ingredients_that_may_be_from_palm_oil_n?: number;
                  ingredients_that_may_be_from_palm_oil_tags?: Record<string, never>[];
                  ingredients_with_specified_percent_n?: number;
                  ingredients_with_specified_percent_sum?: number;
                  ingredients_with_unspecified_percent_n?: number;
                  ingredients_with_unspecified_percent_sum?: number;
                  known_ingredients_n?: number;
                  origins?: string;
                  origins_hierarchy?: Record<string, never>[];
                  origins_lc?: string;
                  origins_tags?: Record<string, never>[];
                  traces?: string;
                  traces_hierarchy?: Record<string, never>[];
                  traces_lc?: string;
                  traces_tags?: Record<string, never>[];
                  unknown_ingredients_n?: number;
              } & {
                  no_nutrition_data?: string;
                  nutriments?: {
                      alcohol?: number;
                      carbohydrates?: number;
                      "carbon-footprint-from-known-ingredients_product"?: number;
                      "carbon-footprint-from-known-ingredients_serving"?: number;
                      energy?: number;
                      energy_unit?: "kcal"
                      | "kj";
                      energy_value?: number;
                      "energy-kcal"?: number;
                      "energy-kj"?: number;
                      erythritol?: number;
                      fat?: number;
                      "fruits-vegetables-legumes-estimate-from-ingredients"?: number;
                      "fruits-vegetables-nuts-estimate-from-ingredients"?: number;
                      "nova-group"?: number;
                      "nutrition-score-fr"?: unknown;
                      proteins?: number;
                      salt?: number;
                      "saturated-fat"?: number;
                      sodium?: number;
                      sugars?: number;
                  };
                  nutriscore_data?: {
                      energy?: number;
                      energy_points?: number;
                      energy_value?: number;
                      fiber?: number;
                      fiber_points?: number;
                      fiber_value?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils_points?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils_value?: number;
                      grade?: string;
                      is_beverage?: number;
                      is_cheese?: number;
                      is_fat?: number;
                      is_water?: number;
                      negative_points?: number;
                      positive_points?: number;
                      proteins?: number;
                      proteins_points?: number;
                      proteins_value?: number;
                      saturated_fat?: number;
                      saturated_fat_points?: number;
                      saturated_fat_ratio?: number;
                      saturated_fat_ratio_points?: number;
                      saturated_fat_ratio_value?: number;
                      saturated_fat_value?: number;
                      score?: number;
                      sodium?: number;
                      sodium_points?: number;
                      sodium_value?: number;
                      sugars?: number;
                      sugars_points?: number;
                      sugars_value?: number;
                  };
                  nutriscore_grade?: "d"
                  | "a"
                  | "b"
                  | "c"
                  | "e";
                  nutriscore_score?: number;
                  nutriscore_score_opposite?: number;
                  nutrition_data_per?: "serving" | "100g";
                  nutrition_data_prepared_per?: "serving" | "100g";
                  nutrition_grade_fr?: string;
                  nutrition_grades?: string;
                  nutrition_grades_tags?: string[];
                  nutrition_score_beverage?: number;
                  nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients?: number;
                  nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients_value?: number;
                  nutrition_score_warning_no_fiber?: number;
                  other_nutritional_substances_tags?: Record<string, never>[];
                  unknown_nutrients_tags?: Record<string, never>[];
                  vitamins_tags?: Record<string, never>[];
              } & {
                  data_quality_bugs_tags?: Record<string, never>[];
                  data_quality_errors_tags?: Record<string, never>[];
                  data_quality_info_tags?: string[];
                  data_quality_tags?: string[];
                  data_quality_warnings_tags?: string[];
                  data_sources?: string;
                  data_sources_tags?: string[];
                  last_check_dates_tags?: string[];
                  last_checked_t?: number;
                  last_checker?: string;
                  misc_tags?: string[];
                  states?: string;
                  states_hierarchy?: string[];
                  states_tags?: string[];
              } & {
                  added_countries_tags?: Record<string, never>[];
                  additives_original_tags?: string[];
                  additives_prev_original_tags?: string[];
                  allergens_from_ingredients?: string;
                  allergens_from_user?: string;
                  amino_acids_prev_tags?: Record<string, never>[];
                  amino_acids_tags?: Record<string, never>[];
                  carbon_footprint_percent_of_known_ingredients?: number;
                  categories_properties?: {
                      "agribalyse_food_code:en"?: string;
                      "agribalyse_proxy_food_code:en"?: string;
                      "ciqual_food_code:en"?: string;
                  };
                  categories_properties_tags?: string[];
                  category_properties?: { [key: string]: string };
                  ciqual_food_name_tags?: string[];
                  compared_to_category?: string;
                  conservation_conditions?: string;
                  customer_service?: string;
                  expiration_date?: string;
                  link?: string;
                  main_countries_tags?: Record<string, never>[];
                  minerals_prev_tags?: Record<string, never>[];
                  minerals_tags?: Record<string, never>[];
                  nova_groups_markers?: { "3"?: (...)[]; "4"?: any };
                  nucleotides_tags?: Record<string, never>[];
                  origin?: string;
                  owner_fields?: {
                      additionalProperties?: string | number | Record<(...), (...)>;
                  };
                  purchase_places?: string;
                  purchase_places_tags?: string[];
                  stores?: string;
                  stores_tags?: string[];
                  traces_from_ingredients?: string;
                  traces_from_user?: string;
              } & {
                  created_t?: number;
                  creator?: string;
                  editors_tags?: string[];
                  informers_tags?: string[];
                  interface_version_created?: string;
                  interface_version_modified?: string;
                  languages?: Record<string, never>;
                  languages_codes?: Record<string, never>;
                  languages_hierarchy?: string[];
                  languages_tags?: string[];
                  last_edit_dates_tags?: string[];
                  last_editor?: string;
                  last_modified_by?: string;
                  last_modified_t?: number;
                  owner?: string;
                  owners_tags?: string;
                  photographers_tags?: string[];
                  rev?: number;
                  sources?: {
                      fields?: (...) | (...);
                      id?: (...) | (...);
                      images?: (...) | (...);
                      import_t?: (...) | (...);
                      manufacturer?: (...) | (...) | (...);
                      name?: (...) | (...);
                      source_licence?: (...) | (...);
                      source_licence_url?: (...) | (...);
                      url?: (...) | (...) | (...);
                  }[];
                  sources_fields?: {
                      "org-gs1"?: {
                          gln?: ...;
                          gpcCategoryCode?: ...;
                          gpcCategoryName?: ...;
                          isAllergenRelevantDataProvided?: ...;
                          lastChangeDateTime?: ...;
                          partyName?: ...;
                          productionVariantDescription?: ...;
                          publicationDateTime?: ...;
                      };
                  };
                  teams?: string;
                  teams_tags?: string[];
                  update_key?: string;
              } & {
                  knowledge_panels?: {
                      additionalProperties?: {
                          elements?: ...;
                          expand_for?: ...;
                          expanded?: ...;
                          level?: ...;
                          size?: ...;
                          title_element?: ...;
                          topics?: ...;
                          type?: ...;
                      };
                  };
              }
          )[];
          skip?: number;
      },
  >

• Parameters

  • Optionalfields: string
  • OptionalsortBy:
        | "product_name"
        | "last_modified_t"
        | "scans_n"
        | "unique_scans_n"
        | "created_t"
        | "completeness"
        | "popularity_key"
        | "nutriscore_score"
        | "nova_score"
        | "nothing"
        | "ecoscore_score"

  Returns Promise<
      | undefined
      | {
          count?: number;
          page?: number;
          page_count?: number;
          page_size?: number;
          products?: (
              {
                  abbreviated_product_name?: string;
                  code?: string;
                  codes_tags?: string[];
                  generic_name?: string;
                  id?: string;
                  lang?: string;
                  lc?: string;
                  nova_group?: number;
                  nova_groups?: string;
                  obsolete?: string;
                  obsolete_since_date?: string;
                  product_name?: string;
                  product_name_en?: string;
                  product_quantity?: string;
                  product_quantity_unit?: string;
                  quantity?: string;
              } & {
                  additives_n?: number;
                  checked?: string;
                  complete?: number;
                  completeness?: number;
                  ecoscore_grade?: string;
                  ecoscore_score?: number;
                  food_groups?: string;
                  food_groups_tags?: string[];
                  nutrient_levels?: {
                      fat?: "high"
                      | "low"
                      | "moderate";
                      salt?: "high" | "low" | "moderate";
                      "saturated-fat"?: "high" | "low" | "moderate";
                      sugars?: "high" | "low" | "moderate";
                  };
                  packaging_text?: string;
                  packagings?: readonly {
                      material?: (...)
                      | (...);
                      number_of_units?: (...) | (...);
                      quantity_per_unit?: (...) | (...);
                      quantity_per_unit_unit?: (...) | (...);
                      quantity_per_unit_value?: (...) | (...);
                      recycling?: (...) | (...);
                      shape?: (...) | (...);
                      weight?: (...) | (...);
                      weight_estimated?: (...) | (...);
                      weight_measured?: (...) | (...);
                      weight_source_id?: (...) | (...);
                      weight_specified?: (...) | (...);
                  }[];
                  packagings_complete?: number;
                  pnns_groups_1?: string;
                  pnns_groups_1_tags?: string[];
                  pnns_groups_2?: string;
                  pnns_groups_2_tags?: string[];
                  popularity_key?: number;
                  popularity_tags?: string[];
                  scans_n?: number;
                  serving_quantity?: string;
                  serving_quantity_unit?: string;
                  serving_size?: string;
                  unique_scans_n?: number;
              } & {
                  brands?: string;
                  brands_tags?: string[];
                  categories?: string;
                  categories_hierarchy?: string[];
                  categories_lc?: string;
                  categories_tags?: string[];
                  checkers_tags?: string[];
                  cities?: string;
                  cities_tags?: Record<string, never>[];
                  correctors_tags?: string[];
                  countries?: string;
                  countries_hierarchy?: string[];
                  countries_lc?: string;
                  countries_tags?: string[];
                  ecoscore_tags?: string[];
                  emb_codes?: string;
                  emb_codes_orig?: string;
                  emb_codes_tags?: Record<string, never>[];
                  entry_dates_tags?: string[];
                  labels?: string;
                  labels_hierarchy?: string[];
                  labels_lc?: string;
                  labels_tags?: string[];
                  manufacturing_places?: string;
                  manufacturing_places_tags?: Record<string, never>[];
                  nova_groups_tags?: string[];
                  nutrient_levels_tags?: string[];
              } & {
                  image_front_small_url?: string;
                  image_front_thumb_url?: string;
                  image_front_url?: string;
                  image_nutrition_small_url?: string;
                  image_nutrition_thumb_url?: string;
                  image_nutrition_url?: string;
                  image_small_url?: string;
                  image_thumb_url?: string;
                  image_url?: string;
                  images?: {
                      "1"?: { sizes?: ...; uploaded_t?: ...; uploader?: ... };
                      front?: {
                          angle?: ...;
                          coordinates_image_size?: ...;
                          geometry?: ...;
                          imgid?: ...;
                          normalize?: ...;
                          rev?: ...;
                          sizes?: ...;
                          white_magic?: ...;
                          x1?: ...;
                          x2?: ...;
                          y1?: ...;
                          y2?: ...;
                      };
                  };
                  last_image_dates_tags?: string[];
                  last_image_t?: number;
                  selected_images?: {
                      front?: { display?: ...; small?: ...; thumb?: ... };
                  };
              } & {
                  ecoscore_data?: {
                      adjustments?: {
                          origins_of_ingredients?: ...;
                          packaging?: ...;
                          production_system?: ...;
                          threatened_species?: ...;
                      };
                      agribalyse?: {
                          agribalyse_food_code?: ...;
                          co2_agriculture?: ...;
                          co2_consumption?: ...;
                          co2_distribution?: ...;
                          co2_packaging?: ...;
                          co2_processing?: ...;
                          co2_total?: ...;
                          co2_transportation?: ...;
                          code?: ...;
                          dqr?: ...;
                          ef_agriculture?: ...;
                          ef_consumption?: ...;
                          ef_distribution?: ...;
                          ef_packaging?: ...;
                          ef_processing?: ...;
                          ef_total?: ...;
                          ef_transportation?: ...;
                          is_beverage?: ...;
                          name_en?: ...;
                          score?: ...;
                          version?: ...;
                      };
                      grade?: string;
                      grades?: Record<(...), (...)>;
                      missing?: { labels?: ...; origins?: ...; packagings?: ... };
                      missing_data_warning?: number;
                      previous_data?: { agribalyse?: ...; grade?: ...; score?: ... };
                      score?: number;
                      scores?: Record<(...), (...)>;
                      status?: string;
                  };
                  ecoscore_extended_data_version?: string;
                  environment_impact_level?: string;
                  environment_impact_level_tags?: Record<string, never>[];
              } & {
                  additives_tags?: string[];
                  allergens?: string;
                  allergens_hierarchy?: string[];
                  allergens_lc?: string;
                  allergens_tags?: string[];
                  ingredients?: {
                      id?: (...)
                      | (...);
                      ingredients?: { id?: string | undefined; ingredients?: ...[] | undefined; percent?: number | undefined; percent_estimate?: number | undefined; percent_max?: number | undefined; percent_min?: number | undefined; text?: string | undefined; vegan?: string | undefined; vegetarian?: string | undefined; }[] | undefined;
                      percent?: (...) | (...);
                      percent_estimate?: (...) | (...);
                      percent_max?: (...) | (...);
                      percent_min?: (...) | (...);
                      text?: (...) | (...);
                      vegan?: (...) | (...);
                      vegetarian?: (...) | (...);
                  }[];
                  ingredients_analysis?: {
                      "en:palm-oil"?: (...)[];
                      "en:vegan-status-unknown"?: (...)[];
                      "en:vegetarian-status-unknown"?: (...)[];
                  };
                  ingredients_analysis_tags?: string[];
                  ingredients_from_or_that_may_be_from_palm_oil_n?: number;
                  ingredients_from_palm_oil_n?: number;
                  ingredients_from_palm_oil_tags?: Record<string, never>[];
                  ingredients_hierarchy?: string[];
                  ingredients_lc?: string;
                  ingredients_n?: number;
                  ingredients_n_tags?: string[];
                  ingredients_original_tags?: string[];
                  ingredients_percent_analysis?: number;
                  ingredients_tags?: string[];
                  ingredients_text?: string;
                  ingredients_text_with_allergens?: string;
                  ingredients_that_may_be_from_palm_oil_n?: number;
                  ingredients_that_may_be_from_palm_oil_tags?: Record<string, never>[];
                  ingredients_with_specified_percent_n?: number;
                  ingredients_with_specified_percent_sum?: number;
                  ingredients_with_unspecified_percent_n?: number;
                  ingredients_with_unspecified_percent_sum?: number;
                  known_ingredients_n?: number;
                  origins?: string;
                  origins_hierarchy?: Record<string, never>[];
                  origins_lc?: string;
                  origins_tags?: Record<string, never>[];
                  traces?: string;
                  traces_hierarchy?: Record<string, never>[];
                  traces_lc?: string;
                  traces_tags?: Record<string, never>[];
                  unknown_ingredients_n?: number;
              } & {
                  no_nutrition_data?: string;
                  nutriments?: {
                      alcohol?: number;
                      carbohydrates?: number;
                      "carbon-footprint-from-known-ingredients_product"?: number;
                      "carbon-footprint-from-known-ingredients_serving"?: number;
                      energy?: number;
                      energy_unit?: "kcal"
                      | "kj";
                      energy_value?: number;
                      "energy-kcal"?: number;
                      "energy-kj"?: number;
                      erythritol?: number;
                      fat?: number;
                      "fruits-vegetables-legumes-estimate-from-ingredients"?: number;
                      "fruits-vegetables-nuts-estimate-from-ingredients"?: number;
                      "nova-group"?: number;
                      "nutrition-score-fr"?: unknown;
                      proteins?: number;
                      salt?: number;
                      "saturated-fat"?: number;
                      sodium?: number;
                      sugars?: number;
                  };
                  nutriscore_data?: {
                      energy?: number;
                      energy_points?: number;
                      energy_value?: number;
                      fiber?: number;
                      fiber_points?: number;
                      fiber_value?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils_points?: number;
                      fruits_vegetables_nuts_colza_walnut_olive_oils_value?: number;
                      grade?: string;
                      is_beverage?: number;
                      is_cheese?: number;
                      is_fat?: number;
                      is_water?: number;
                      negative_points?: number;
                      positive_points?: number;
                      proteins?: number;
                      proteins_points?: number;
                      proteins_value?: number;
                      saturated_fat?: number;
                      saturated_fat_points?: number;
                      saturated_fat_ratio?: number;
                      saturated_fat_ratio_points?: number;
                      saturated_fat_ratio_value?: number;
                      saturated_fat_value?: number;
                      score?: number;
                      sodium?: number;
                      sodium_points?: number;
                      sodium_value?: number;
                      sugars?: number;
                      sugars_points?: number;
                      sugars_value?: number;
                  };
                  nutriscore_grade?: "d"
                  | "a"
                  | "b"
                  | "c"
                  | "e";
                  nutriscore_score?: number;
                  nutriscore_score_opposite?: number;
                  nutrition_data_per?: "serving" | "100g";
                  nutrition_data_prepared_per?: "serving" | "100g";
                  nutrition_grade_fr?: string;
                  nutrition_grades?: string;
                  nutrition_grades_tags?: string[];
                  nutrition_score_beverage?: number;
                  nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients?: number;
                  nutrition_score_warning_fruits_vegetables_nuts_estimate_from_ingredients_value?: number;
                  nutrition_score_warning_no_fiber?: number;
                  other_nutritional_substances_tags?: Record<string, never>[];
                  unknown_nutrients_tags?: Record<string, never>[];
                  vitamins_tags?: Record<string, never>[];
              } & {
                  data_quality_bugs_tags?: Record<string, never>[];
                  data_quality_errors_tags?: Record<string, never>[];
                  data_quality_info_tags?: string[];
                  data_quality_tags?: string[];
                  data_quality_warnings_tags?: string[];
                  data_sources?: string;
                  data_sources_tags?: string[];
                  last_check_dates_tags?: string[];
                  last_checked_t?: number;
                  last_checker?: string;
                  misc_tags?: string[];
                  states?: string;
                  states_hierarchy?: string[];
                  states_tags?: string[];
              } & {
                  added_countries_tags?: Record<string, never>[];
                  additives_original_tags?: string[];
                  additives_prev_original_tags?: string[];
                  allergens_from_ingredients?: string;
                  allergens_from_user?: string;
                  amino_acids_prev_tags?: Record<string, never>[];
                  amino_acids_tags?: Record<string, never>[];
                  carbon_footprint_percent_of_known_ingredients?: number;
                  categories_properties?: {
                      "agribalyse_food_code:en"?: string;
                      "agribalyse_proxy_food_code:en"?: string;
                      "ciqual_food_code:en"?: string;
                  };
                  categories_properties_tags?: string[];
                  category_properties?: { [key: string]: string };
                  ciqual_food_name_tags?: string[];
                  compared_to_category?: string;
                  conservation_conditions?: string;
                  customer_service?: string;
                  expiration_date?: string;
                  link?: string;
                  main_countries_tags?: Record<string, never>[];
                  minerals_prev_tags?: Record<string, never>[];
                  minerals_tags?: Record<string, never>[];
                  nova_groups_markers?: { "3"?: (...)[]; "4"?: any };
                  nucleotides_tags?: Record<string, never>[];
                  origin?: string;
                  owner_fields?: {
                      additionalProperties?: string | number | Record<(...), (...)>;
                  };
                  purchase_places?: string;
                  purchase_places_tags?: string[];
                  stores?: string;
                  stores_tags?: string[];
                  traces_from_ingredients?: string;
                  traces_from_user?: string;
              } & {
                  created_t?: number;
                  creator?: string;
                  editors_tags?: string[];
                  informers_tags?: string[];
                  interface_version_created?: string;
                  interface_version_modified?: string;
                  languages?: Record<string, never>;
                  languages_codes?: Record<string, never>;
                  languages_hierarchy?: string[];
                  languages_tags?: string[];
                  last_edit_dates_tags?: string[];
                  last_editor?: string;
                  last_modified_by?: string;
                  last_modified_t?: number;
                  owner?: string;
                  owners_tags?: string;
                  photographers_tags?: string[];
                  rev?: number;
                  sources?: {
                      fields?: (...) | (...);
                      id?: (...) | (...);
                      images?: (...) | (...);
                      import_t?: (...) | (...);
                      manufacturer?: (...) | (...) | (...);
                      name?: (...) | (...);
                      source_licence?: (...) | (...);
                      source_licence_url?: (...) | (...);
                      url?: (...) | (...) | (...);
                  }[];
                  sources_fields?: {
                      "org-gs1"?: {
                          gln?: ...;
                          gpcCategoryCode?: ...;
                          gpcCategoryName?: ...;
                          isAllergenRelevantDataProvided?: ...;
                          lastChangeDateTime?: ...;
                          partyName?: ...;
                          productionVariantDescription?: ...;
                          publicationDateTime?: ...;
                      };
                  };
                  teams?: string;
                  teams_tags?: string[];
                  update_key?: string;
              } & {
                  knowledge_panels?: {
                      additionalProperties?: {
                          elements?: ...;
                          expand_for?: ...;
                          expanded?: ...;
                          level?: ...;
                          size?: ...;
                          title_element?: ...;
                          topics?: ...;
                          type?: ...;
                      };
                  };
              }
          )[];
          skip?: number;
      },
  >