@spinque/query-api

@spinque/query-api

Library to use the Spinque Query API in your JavaScript/TypeScript project.

The Spinque Query API is an HTTP API to retrieve search results for queries. Also check out the documentation of the Spinque Query API.

Installing

Using npm:

$ npm install @spinque/query-api

Documentation

Documentation for this library can be found here.

This documents the code exported by this library. For documentation on the Spinque Query API itself, please see this.

Usage

Defining queries

Defining a single query:

import { Query } from '@spinque/query-api';

const query: Query = {
  endpoint: 'movie_search',
  parameters: { terms: 'call me' }
};

Fetching results

Fetching results for a single query using an instance of the Api class:

import { Api, Query } from '@spinque/query-api';

const api = new Api({
  workspace: 'my-workspace',
  config: 'default',
  api: 'movies'
});

const query: Query = {
  endpoint: 'movie_search',
  parameters: { terms: 'call me' }
};

try {
  const response = await api.fetch(query, { count: 10 });
} catch (error: any) {
  console.error(error);
}

Fetching using custom HTTP-library

Getting the URL for a request to fetch it using your own HTTP-library of preference:

import { urlFromQueries } from '@spinque/query-api/utils';

const apiConfig = {
  workspace: 'my-workspace',
  config: 'default',
  api: 'movies'
};

const query: Query = {
  endpoint: 'movie_search',
  parameters: { terms: 'call me' }
};

const url = urlFromQueries(apiConfig, query, { count: 10, offset: 0 });

Authentication

Some Spinque APIs require authentication using OAuth 2.0. The Client Credentials flow (for server applications) and PKCE flow (for browser applications) are provided by @spinque/query-api:

Client Credentials flow (for server applications)

import { Api } from '@spinque/query-api';

const api = new Api({
  workspace: 'my-workspace',
  config: 'default',
  api: 'movies',
  authentication: {
    type: 'client-credentials',
    clientId: 'abcdefghijklmnopqrstuvwxyz',
    clientSecret: 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ',
  }
});

const query: Query = {
  endpoint: 'movie_search',
  parameters: { terms: 'call me' }
};

const response = await api.fetch(queries);

Note: the Client ID and Client Secret can be generated by creating a new System-to-System account in the Settings > Team Members section of Spinque Desk.

PKCE flow (for browser applications)

import { Api } from '@spinque/query-api';

const api = new Api({
  workspace: 'my-workspace',
  config: 'default',
  api: 'movies',
  authentication: {
    type: 'pkce',
    clientId: 'abcdefghijklmnopqrstuvwxyz',
    callback: 'https://my-domain.com/callback'
  }
});

const query = {
  endpoint: 'movie',
  parameters: { id: 'https://imdb.com/data/movie/tt0209144' }
};

const response = await api.fetch(queries, { count: 10, offset: 0 });

Note: the Client ID and Callback URL cannot yet be configured from Spinque Desk. Ask your system administrator to help you out.

Faceted search

Faceted search is a common use-case for application built on Spinque. This library provides a FacetedSearch to ease the interaction between queries in a faceted search setup.

The following example shows how a search endpoint 'movie_search' can be used in combination with a facet endpoint 'genre'.

import { Api, FacetedSearch } from '@spinque/query-api';

const query: Query = {
  endpoint: 'movie_search',
  parameters: { query: 'call me' }
};

const fs = new FacetedSearch(query);

fs.addFacet('genre', 'multiple');
fs.addFacet('director', 'single');

// Get results and facet options
let results = await api.fetch(fs.getResultsQuery());
let genreOptions = await api.fetch(fs.getFacetQuery('genre'));
let directorOptions = await api.fetch(fs.getFacetQuery('director'));

// Set the search query parameter (e.g. after the user has typed something)
fs.setParameter('query', 'dia');

// Get updated results and options
results = await api.fetch(fs.getResultsQuery());
genreOptions = await api.fetch(fs.getFacetQuery('genre'));
directorOptions = await api.fetch(fs.getFacetQuery('director'));

// Select a facet option
fs.setFacetSelection('genre', ['https://imdb.com/data/Drama', 'https://imdb.com/data/Biography']);
fs.setFacetSelection('director', 'https://imdb.com/data/PabloLarrain');

// Get results again
results = await api.fetch(fs.getResultsQuery());

Optionally, you can provide a Query for when the search parameters are empty.

...

const listQuery: Query = { endpoint: 'movies' };

const fs = new FacetedSearch(query, listQuery);

Note that the exact same behavior can also be achieved without the FacetedSearch class (though it's more involved). The following two sections produce equal results:

With FacetedSearch:

const query: Query = {
  endpoint: 'movie_search',
  parameters: { query: 'call me' }
};

const fs = new FacetedSearch(query);

fs.addFacet('genre', 'multiple');
fs.addFacet('director', 'single');

let results = await api.fetch(fs.getResultsQuery());
let genreOptions = await api.fetch(fs.getFacetQuery('genre'));
let directorOptions = await api.fetch(fs.getFacetQuery('director'));

fs.setParameter('query', 'dia');

results = await api.fetch(fs.getResultsQuery());
genreOptions = await api.fetch(fs.getFacetQuery('genre'));
directorOptions = await api.fetch(fs.getFacetQuery('director'));

fs.setFacetSelection('genre', ['https://imdb.com/data/Drama', 'https://imdb.com/data/Biography']);

results = await api.fetch(fs.getResultsQuery());

Without FacetedSearch:

const query: Query = {
  endpoint: 'movie_search',
  parameters: { query: 'call me' }
};

const genreOptionsQuery: Query = { endpoint: 'genre' };
const genreFilterQuery: Query = {
  endpoint: 'genre:FILTER',
  parameters: { value: undefined }
};

const directorOptionsQuery: Query = { endpoint: 'director' };
const directorFilterQuery: Query = {
  endpoint: 'director:FILTER',
  parameters: { value: undefined }
};

let resultsQuery = [query];
if (genreFilterQuery.parameters.value) {
  resultsQuery.push(genreFilterQuery);
}
if (directorFilterQuery.parameters.value) {
  resultsQuery.push(directorFilterQuery);
}

let results = await api.fetch(resultsQuery);
let genreOptions = await api.fetch([...resultsQuery, genreOptionsQuery]);
let directorOptions = await api.fetch([...resultsQuery, directorOptionsQuery]);

query.parameters.query = 'dia';

let resultsQuery = [query];
if (genreFilterQuery.parameters.value) {
  resultsQuery.push(genreFilterQuery);
}
if (directorFilterQuery.parameters.value) {
  resultsQuery.push(directorFilterQuery);
}

results = await api.fetch(resultsQuery);
let genreOptions = await api.fetch([...resultsQuery, genreOptionsQuery]);
let directorOptions = await api.fetch([...resultsQuery, directorOptionsQuery]);

genreFilterQuery.parameters.value = tupleListToString(['https://imdb.com/data/Drama', 'https://imdb.com/data/Biography']);

let resultsQuery = [query];
if (genreFilterQuery.parameters.value) {
  resultsQuery.push(genreFilterQuery);
}
if (directorFilterQuery.parameters.value) {
  resultsQuery.push(directorFilterQuery);
}

results = await api.fetch(resultsQuery);

Vanilla JavaScript

This library can also be used without using TypeScript:

const sqa = require("@spinque/query-api");

const api = new sqa.Api({
  workspace: 'my-workspace',
  api: 'movies'
});

const query = {
  endpoint: 'search',
  parameters: { term: 'utrecht' }
};

try {
  const results = await api.fetch(query);
  console.log(results);
} catch (error) {
  console.log(error);
}