import { ApiClient, fromCatalog } from '@opendatasoft/api-client';

// Initialize the Client by indicating the domain to request.
const client = new ApiClient({ domain: "documentation-resources" });

// Create the query to run.
const query = fromCatalog() // From the domain catalog
    .dataset("doc-geonames-cities-5000") // ... we'll use the dataset "doc-geonames-cities-5000"
    .aggregates() // ... in order to make an aggregation.
    .where("country_code:'FR'") // // Filter records where country_code === "FR".
    .groupBy("name as city, population") // Select the fields "name" and "population".
    .orderBy("-population") // Sort by population in descending order.
    .limit(10) // But we only want the first 10 most populated cities.
    .toString(); // Then finally, we convert our query into a string.

// Now, run the query.
client.get(query)
    .then(response => console.log(response))
    .catch(error => console.error(error));

import { ApiClient } from '@opendatasoft/api-client';

const client = new ApiClient({

      /* (Optional) authenticate through an api key */
      apiKey: 'secret',

      /* (Optional) The Opendatasoft domain identifier or url.
         If missing, in the browser, the client will use the current host. */
      domain: 'public' || 'https://public.opendatasoft.com',

      /* (Optional) A fetch-compatible API for making a request. */
      fetch: window.fetch,

      /* (Optional) Allow you to update the request before it is send. */
      interceptRequest: async (request) => {
            console.log(request);
            request.headers.append('x-custom', 'custom');
            return request;
      },

      /* (Optional) Allow you to intercept the response before it is returned */
      interceptResponse: async (response) => {
            const apiResponse = await response.json();
            delete apiResponse['links'];
            return apiResponse;
      }
});

import { ApiClient } from '@opendatasoft/api-client';

(async () => {
      const client = new ApiClient();
      const response = await client.get('catalog/datasets?limit=10');
      console.log(response);
      /*
       {
        total_count: 10,
        links: [...],
        datasets: [...]
      }
      */
})();

import { AuthenticationError, NotFoundError, ServerError, UserError } from '@opendatasoft/api-client/client/error';

import {
    ApiClient,
    fromCatalog,
    fromDataNetwork,
    fromMonitoring
} from '@opendatasoft/api-client';

const client = new ApiClient({
      interceptRequest: async (request) => {
            console.log(request.url); // Log the url
            return request;
      }
});

// ../monitoring/
client.get(fromMonitoring().itself());

// ../catalog/datasets/
client.get(fromCatalog().datasets());

// ../opendatasoft/datasets/sirene@data/facets/?lang=fr
client.get(fromDataNetwork().dataset('sirene@data').facets().lang('fr'));

// ../catalog/datasets/?select=dataset_id%2C+records_count
client.get(fromCatalog().datasets().select('dataset_id, records_count'));

import {
    ApiClient,
    fromCatalog,
    field,
    string,
    dateTime,
    date,
    all,
    one,
} from '@opendatasoft/api-client';

fromCatalog().aggregates()
   .select("count(*), avg(f)") // You can select fields
   .where("field2 > 2") // Add a where clause
   .where("field3 > 3") // This replace the previous clause
   .where(condition => condition + " AND field4: 4") // This combine both conditions
   .where(filter => all(filter, "field4:4", "field5: 5")) // condition1 AND condition2...
   .where(one("field4:4", "field5:5")) //condition1 OR condition2...
   .where(`${field("name")}:${string("paul")}`) // string and field escaping
   .where(`${field("day")} < ${date(new Date())}`) // format Date with date or dateTime
   .groupBy(`${field("day")} , ${field("a")}+${field("b")}`) // Add a group by clause
   .orderBy("count(*)") // Or and order by clause
   .limit(10) // Set a limit
   .offset(10) // Or an offset
   .limit(currentLimit => currentLimit + 10) // useful for pagination
   .refine("field:value") // Use facet refine for faceted navigation
   .exclude("field:value") // Same for excluding
   .lang("fr") // Force a language