https://github.com/linusbolls/splid-js

a reverse-engineered typescript client for the Splid API.
https://github.com/linusbolls/splid-js

api api-client splid splid-js splidjs

Last synced: 13 days ago
JSON representation

a reverse-engineered typescript client for the Splid API.

• Host: GitHub
• URL: https://github.com/linusbolls/splid-js
• Owner: LinusBolls
• Created: 2023-08-23T15:04:46.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-11-01T14:00:51.000Z (17 days ago)
• Last Synced: 2024-11-01T15:17:06.816Z (17 days ago)
• Topics: api, api-client, splid, splid-js, splidjs
• Language: TypeScript
• Homepage:
• Size: 565 KB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Splid.Js

a reverse-engineered typescript client for the Splid (https://splid.app) API.

at the moment, only read operations are supported.

## Install

install the package:

```bash

npm install splid-js

```

## Examples

```typescript

// basic usage

import { SplidClient } from 'splid-js';

async function main() {

  const client = new SplidClient();

  const inviteCode = 'PWJ E2B P7A';

  const groupRes = await client.group.getByInviteCode(inviteCode);

  const groupInfoRes = await client.groupInfo.getByGroup(

    groupRes.result.objectId

  );

  const entriesRes = await client.entry.getByGroup(groupRes.result.objectId);

  const membersRes = await client.person.getByGroup(groupRes.result.objectId);

  const expensesAndPayments = await client.entry.getByGroup(

    groupRes.result.objectId

  );

}

main();

```

```typescript

// using the returned data

import { SplidClient } from 'splid-js';

const formatCurrency = (amount: number, currencyCode: string) => {

  return (

    amount.toLocaleString(undefined, {

      minimumFractionDigits: 2,

      maximumFractionDigits: 2,

    }) + currencyCode

  );

};

const getEntryDescription = (

  entry: SplidJs.Entry,

  members: SplidJs.Person[]

) => {

  const primaryPayer = members.find((j) => j.GlobalId === entry.primaryPayer);

  for (const item of entry.items) {

    const totalAmount = item.AM;

    const profiteers = Object.entries(item.P.P).map(([userId, share]) => {

      const user = members.find((j) => j.GlobalId === userId);

      const shareText = formatCurrency(totalAmount * share, entry.currencyCode);

      return user.name + ' (' + shareText + ')';

    });

    const profiteersText = profiteers.join(', ');

    const totalText = formatCurrency(totalAmount, entry.currencyCode);

    if (entry.isPayment) {

      const description =

        primaryPayer.name + ' sent ' + totalText + ' to ' + profiteersText;

      return description;

    } else {

      const description =

        primaryPayer.name + ' payed ' + totalText + ' for ' + profiteersText;

      return description;

    }

  }

};

async function main() {

  const client = new SplidClient();

  const inviteCode = 'PWJ E2B P7A';

  const groupRes = await client.group.getByInviteCode(inviteCode);

  const groupInfoRes = await client.groupInfo.getByGroup(

    groupRes.result.objectId

  );

  const entriesRes = await client.entry.getByGroup(groupRes.result.objectId);

  const membersRes = await client.person.getByGroup(groupRes.result.objectId);

  for (const entry of entriesRes.result.results) {

    console.log(getEntryDescription(entry, membersRes.result.results));

  }

}

main();

```