/morph-client-js

Client for Morph's data API

Primary LanguageTypeScriptMIT LicenseMIT

Morph Client

Introduction

Morph is a no-code tool that can handle huge data with the feel of a spreadsheet.

@morphdb/morph-client is a Javascript library that provides easy access to Morph's Admin API and Data API.

Getting started

Installation

To install morph-client in a node project:

npm install @morphdb/morph-client

yarn add @morphdb/morph-client

API types

There are two types of APIs in Morph. See below for more information on the role and use of eachThere are two types in Morph API, Admin API and Data API.

Admin API The Admin API is mainly used by administrators, and API keys for the Admin API can be issued in dev mode. This Admin API Key allows access to all endpoints of the Admin API. The IP address of the caller can also be restricted.

Data API The Data API allows for more restricted APIs than the Admin API, and API keys for the Data API can be created from the database on the dashboard. Each API key corresponds to a specific endpoint, so you can generate and use only the API key for the endpoint you need.

For more detail

Admin API

Initialize client for Admin API

import { MorphAdminAPIClient } from "@morphdb/morph-client";

const adminClient = new MorphAdminAPIClient({
    teamSlug: YOUR_TEAM_SLUG,
    apiKey: YOUR_API_KEY
});

For more information, please check the following pages

Create Record(Admin API)

adminClient.createRecord(
    databaseId: string,
    tableSlug: string,
    options: CreateRecordOptions
);

Query Records(Admin API)

adminClient.queryRecords(
    databaseId: string,
    tableSlug: string,
    options: QueryRecordsOptions
);

example

Only male clients under 20 years old are extracted and sorted by name.

adminClient.queryRecords(
    YOUR_DATABASE_ID,
    YOUR_TABLE_SLUG,
    {
        select: ["*"],
        filter: {
            and: [
                {
                    key: "age",
                    operator: "lessThan",
                    value: 20,
                },
                {
                    key: "sex",
                    operator: "equal",
                    value: "male",
                },
            ],
        },
        sort: [
            {
                key: "name",
                direction: "ascending",
            },
        ],
    }
);

Update Records(Admin API)

adminClient.updateRecords(
    databaseId: string,
    tableSlug: string,
    options: UpdateRecordsOptions
);

Delete Records(Admin API)

adminClient.deleteRecords(
    databaseId: string,
    tableSlug: string,
    options: DeleteRecordsOptions
);

example

Delete records with id 9.

adminClient.deleteRecords("", "", {
    filter: {
        and: [
        {
            key: "id",
            operator: "equal",
            value: 9,
        },
        ],
    },
});

Data API

The interface and specifications of options are the same for the Data API and the Admin API.

Initialize client for Data API

import { MorphDataAPIClient } from "@morphdb/morph-client";

const adminClient = new MorphDataAPIClient();

The Data API requires the respective endpoints and API keys to be issued from the Morph dashboard.

For more detail

Create Record(Data API)

dataClient.createRecord(
    url: string,
    apiKey: string,
    options: CreateRecordsOptions
);

Query Records(Data API)

dataClient.queryRecords(
    url: string,
    apiKey: string,
    options: QueryRecordsOptions
);

Update Records(Data API)

dataClient.updateRecords(
    url: string,
    apiKey: string,
    options: UpdateRecordsOptions
);

Delete Records(Data API)

dataClient.deleteRecords(
    url: string,
    apiKey: string,
    options: DeleteRecordsOptions
);

Aggregate Records(Data API)

dataClient.aggregateRecords(
    url: string,
    apiKey: string,
    options: AggregateRecordsOptions
);

Download Records As CSV(Data API)

dataClient.downloadRecordsAsCsv(
    url: string,
    apiKey: string,
    options: DownloadRecordsAsCsvOptions
);

Type-safe development(Highly recommended!)

By defining a type for the return value, you can handle Record-related methods more safely.

1. Define record type

morph-client provides a utility type named F. Define the record types to match the schema of your table.

For example, if you are using a table for task management, it might look like this.

import { F } from "@morphdb/morph-client";

export type TaskRecord = {
    id: F.AutoNumber.Required;
    title: F.ShortText.Required;
    description: F.LongText.Nullable;
    due_date: F.Date.Nullable;
    is_done: F.Boolean.Required;
};

2. Pass it to the client method as a generics

When that type is passed to each method as a generic, the return value is inferred as that type. The argument values are also inferred appropriately.

List of methods that accept record types as generics

  • MorphAdminAPIClient.createRecord()
  • MorphAdminAPIClient.queryRecords()
  • MorphAdminAPIClient.updateRecords()
  • MorphAdminAPIClient.deleteRecords()
  • MorphDataAPIClient.createRecord()
  • MorphDataAPIClient.queryRecords()
  • MorphDataAPIClient.updateRecords()
  • MorphDataAPIClient.deleteRecords()

Documentation & References

API Document Service Page

Others

  • At this time, some of the Morph Admin APIs are provided as methods. We plan to support all APIs soon, but if you want to use other APIs, please refer to the API documentation.