Class Folksonomy

constructor

• new Folksonomy(fetch, authToken): Folksonomy

• Parameters

  • fetch: ((input, init?) => Promise<Response>)

    • • (input, init?): Promise<Response>

      • MDN Reference

        Parameters

        • input: RequestInfo | URL

        • Optional init: RequestInit

        Returns Promise<Response>

  • authToken: string

  Returns Folksonomy

Readonly raw

addTag

• addTag(tag): Promise<boolean>

• Update a product tag (or add it if it does not exist)

  Parameters

  • tag: {
        comment?: string;
        editor?: string;
        k: string;
        last_edit?: string;
        owner?: string;
        product: string;
        v: string;
        version?: number;
    }

    Tag to add or update with the following fields:

    • k: key
    • v: value
    • product: barcode
    • version: version of the tag (must be equal to previous version + 1)
    • owner: user_id of the owner of the tag (empty for public tags)

    • Optional comment?: string

      Comment

      Default

      
      Copy

    • Optional editor?: string

      Editor

    • k: string

      K

    • Optional last_edit?: string

      Last Edit Format: date-time

    • Optional owner?: string

      Owner

      Default

      
      Copy

    • product: string

      Product

    • v: string

      V

    • Optional version?: number

      Version

      Default

      1
      Copy

  Returns Promise<boolean>

  if the tag was added or updated

getKeys

• getKeys(): Promise<FolksonomyKey[]>

• Get the list of keys with statistics

  The keys list can be restricted to private tags from some owner.

  Returns Promise<FolksonomyKey[]>

getProduct

• getProduct(barcode): Promise<FetchResponse<{
      parameters: {
          path: {
              product: string;
          };
          query?: {
              owner?: unknown;
          };
      };
      responses: {
          200: {
              content: {
                  application/json: {
                      comment?: string;
                      editor?: string;
                      k: string;
                      last_edit?: string;
                      owner?: string;
                      product: string;
                      v: string;
                      version?: number;
                  }[];
              };
          };
          422: {
              content: {
                  application/json: {
                      detail?: {
                          loc: string[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
          };
      };
  }>>

• Get a list of existing tags for a product

  Parameters

  • barcode: string

  Returns Promise<FetchResponse<{
      parameters: {
          path: {
              product: string;
          };
          query?: {
              owner?: unknown;
          };
      };
      responses: {
          200: {
              content: {
                  application/json: {
                      comment?: string;
                      editor?: string;
                      k: string;
                      last_edit?: string;
                      owner?: string;
                      product: string;
                      v: string;
                      version?: number;
                  }[];
              };
          };
          422: {
              content: {
                  application/json: {
                      detail?: {
                          loc: string[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
          };
      };
  }>>

getProducts

• getProducts(key, value?): Promise<{
      comment?: string;
      editor?: string;
      k: string;
      last_edit?: string;
      owner?: string;
      product: string;
      v: string;
      version?: number;
  }[]>

• Get the list of products that have a key or key=value if value is provided

  Parameters

  • key: string

  • Optional value: string

  Returns Promise<{
      comment?: string;
      editor?: string;
      k: string;
      last_edit?: string;
      owner?: string;
      product: string;
      v: string;
      version?: number;
  }[]>

login

• login(username, password): Promise<{
      token: {
          access_token: string;
          token_type: string;
      };
  } | {
      error: ApiError;
  }>

• Authentication: provide user/password and get a bearer token in return

  Parameters

  • username: string

    Open Food Facts user_id (not email)

  • password: string

    user password

  Returns Promise<{
      token: {
          access_token: string;
          token_type: string;
      };
  } | {
      error: ApiError;
  }>

  the bearer token, to be used in later requests with usual "Authorization: bearer token" headers

putTag

• putTag(tag): Promise<boolean>

• Parameters

  • tag: {
        comment?: string;
        editor?: string;
        k: string;
        last_edit?: string;
        owner?: string;
        product: string;
        v: string;
        version?: number;
    }

    • Optional comment?: string

      Comment

      Default

      
      Copy

    • Optional editor?: string

      Editor

    • k: string

      K

    • Optional last_edit?: string

      Last Edit Format: date-time

    • Optional owner?: string

      Owner

      Default

      
      Copy

    • product: string

      Product

    • v: string

      V

    • Optional version?: number

      Version

      Default

      1
      Copy

  Returns Promise<boolean>

removeTag

• removeTag(tag): Promise<FetchResponse<{
      parameters: {
          path: {
              k: string;
              product: string;
          };
          query: {
              owner?: unknown;
              version: number;
          };
      };
      responses: {
          200: {
              content: {
                  application/json: unknown;
              };
          };
          422: {
              content: {
                  application/json: {
                      detail?: {
                          loc: string[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
          };
      };
  }>>

• Delete a product tag

  Parameters

  • tag: {
        comment?: string;
        editor?: string;
        k: string;
        last_edit?: string;
        owner?: string;
        product: string;
        v: string;
        version?: number;
    } & {
        version: number;
    }

  Returns Promise<FetchResponse<{
      parameters: {
          path: {
              k: string;
              product: string;
          };
          query: {
              owner?: unknown;
              version: number;
          };
      };
      responses: {
          200: {
              content: {
                  application/json: unknown;
              };
          };
          422: {
              content: {
                  application/json: {
                      detail?: {
                          loc: string[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
          };
      };
  }>>

  if the tag was deleted