@mine-your-business/lofty-api v1.0.23

myb-lofty-api

An unofficial API client for the unofficial Lofty API

Lofti AI: https://lofty.ai/

API: https://api.lofty.ai/prod

Installation

The package is availble via NPM and can be installed with the following command:

npm install @mine-your-business/lofty-api

Examples

A script using this library would look something like this:

import { LoftyApi } from '@mine-your-business/lofty-api';

await LoftyApi.authenticate('myloftyemail@gmail.com', 'greatPassword');

var userInfo = await LoftyApi.Endpoints.User.getUserInfo();

console.log(userInfo);

Testing

This project has no tests yet - feel free to open a PR!

Releases

Releases should follow a Semantic Versioning scheme.

When changes have been made that warrant a new release that should be published, modify the version in package.json

After the change is merged to the main branch, go to releases and Draft a new release. The Tag version should follow the pattern v1.0.0 and should Target the main branch.

The Release title should not include the v from the tag and should have a reasonably detailed description of the new release's changes.

Once the release has been published, the .github/workflows/node-publish.yml GitHub Actions Workflow should trigger and automatically upload the new version to PyPi using GitHub secrets credentials.

Not-so-secret Keys

Certain values found in loftyApi.ts are copied from the Lofty AI Website where they conveniently left their source maps. Those values are in fact not tied to a personal account with Lofty AI, but are instead specific to their deployments.