1.0.0 • Published 3 years ago

coeli-client v1.0.0

Weekly downloads
3
License
ISC
Repository
-
Last release
3 years ago

Coeli public api client

Typescript/JavaScript client to access Coeli public api easily.

Install:

npm install -S coeli-client or yarn add coeli-client

Import

import { CoeliApi } from 'coeli-client';
 
const api = new CoeliApi(
    'TENANT',
    'auth_token'
);

or

var coeliPublicApiClient = require('coeli-client')

var api = new coeliPublicApiClient.CoeliApi('TENANT', 'auth_token')

GET entity

api.getEntityById('en', 'HeritageObject', '877708', x => x);
api.getEntityBySlug('en', 'HeritageObject', 'friendly-url', x => x);

GET entities

api.getEntities('es', 'HeritageObject', x => x)

SEARCH

const search = {
  "conditions": [{
    "property": "creation.date",
    "operator": "between_dates",
    "value": {
      "$type": 'DatingInterval',
      "since": { "value": '1832' },
      "until": { "value": '2020' },
    },
    "$type": "SimpleEntitySearchCondition"
  }, {
    "property": "repository.collection",
    "operator": "=",
    "value": "/coeli/TENANT/Collection/collection_id",
    "$type": "SimpleEntitySearchCondition"
  }], "sortCondition": {"sort": [{"name": "$metadata.updatedAt", "order": "DESC"}], "group": []}
}
api.createAndGetControlledSearch('es', 'HeritageObject', search, x => x)