Skip to content

Codebase

Jump to bottom
Artem Ivanec edited this page Oct 19, 2021 · 2 revisions

Data flow

In order to access both native and custom Aidbox endpoints, the front-end client makes requests to the AIDBOX_URL directly. In case you want to customize Aidbox behaviour, for example add custom operations, you can do it by registering your custom back-end as a service in Aidbox. You are free to use your preferred programming language for your custom back-end. This project has a custom NodeJS back-end and uses the Aidbox NodeJS Server SDK for an easier integration.

A custom back-end contains a manifest. Aidbox uses the manifest to create a service with your back-end, which becomes available on a specified URL, and all requests to your endpoints will be redirected to this URL. For example, in order to call your custom endpoint named do-something-and-send-email you will need to make the following request to Aidbox: http://AIDBOX_URL/do-something-and-send-email. Aidbox will redirect the request to your back-end app.

NodeJS SDK uses the following env variables to register your back-end application in Aidbox:

APP_ID
APP_SECRET
APP_URL
APP_PORT

Manifest

To create data at start, add custom operations, resources, etc., you need to create a manifest. A manifest example:

export const manifest = {
  resources: {
    Client: {
      'some-client-id': {
        'some-field': 'some-data',
      },
    },
    User: {
      'some-user-id': {
        'some-field': 'some-data',
      },
    },
  },
  operations: {
    'any name of operation': {
      method: 'GET',
      path: ['url-to-make-request'],
      handlerFn: async (request, { ctx }) => {
        return 'hello world';
      },
    },
  },
  entities: {
    Patient: {
      attrs: {
        some-attr: {
          type: 'boolean',
        },
      },
    },
  },
};

When the application will start, the manifest will be uploaded to the Aidbox server.

Discover our sample manifest.

Add custom operations

You can add as much custom operations as you want, for example:

// in operations file
export const op = {
  method: 'POST',
  path: ['do-somehting-and-send-email'],
  handlerFn: async (request, { ctx }) => {
    // do somehting
    sendMail({
      from: 'test@test.our',
      to: 'test@test.your',
      subject: 'Hello World',
      html: `<html><p>Hello world</p></html>`,
    });
  },
};

// in manifest file
import * as operations from './operations-file'
const manifest = { ..., operations }

Also, check out our docker-compose file.

Remote Data

We would like to show different approaches with typed http requests and not typed. Currently it's shown in the folders:

  • src/pages/practitioner
  • src/pages/patient

As you may see there are files with not only *.ts/*.tsx extensions but also with *.js/*.jsx extensions. It's up to you which one to choose.

Files with *.tsx/*.ts extension are using Aidbox React library

In case your store will contain data given by http request initial store data should be declared like this:

 $store = createStore<RemoteData<StoreType>>(loading);

In case you need a collection, for exapmle Patients, your response has to be typed like the following:

  RemoteData<Bundle<Patient>>;

In case you need to map success data just use the following:

  mapSuccess(result, f),

where result is given by http client and f is high-order function which will take mapped data.

More detailed info you may read here

Clone this wiki locally