[P-830] fix: remove trailing comma in package.json for valid JSON

[HtetShwe]

No description provided.

[linear]

P-830 SDK: Server-side events Node.js SDK

Ask yos to explain before starting

Request from xena

What

Most analytics platforms have 2 types of SDKs:

• client-side (web) -> we have this https://github.com/getformo/sdk
• server-side -> we don't have this yet, will be on https://docs.formo.so/sdks/server

Create a Node.js SDK to enable builders to send custom events from the server.

Server-side SDK API

• The server-side SDK should allow builders to send to the events.formo.so API:
• • track() https://docs.formo.so/data/events/track
  • identify() https://docs.formo.so/data/events/identify
  • other events are out of scope
• See how the Web SDK generates the common properties (anonymous_id, user_id, message_id,…) the server-side SDK should match it
  • version must be string
  • anonymousId should be anonymous_id and a uuid
  • user_id must be present or be empty string ""
  • address must be a valid ethereum address or empty string ""
  • original_timestamp must be present
  • message_id must be 64 chars length

Testing

To test, send a relevant event with the SDK to tinybird. Use the SDK Write Key found in the workspace settings page of the Formo / formo.so project. You can test on the local backend.

Review the raw_events in Tinybird for correctness (select by message_id)

Note if validation fails (e.g. if channel, version is missing) it will go to raw_events_quarantine

References:

• https://github.com/segmentio/analytics-next/tree/master/packages/node#usage

import { Analytics } from '@segment/analytics-node'
// or, if you use require:
const { Analytics } = require('@segment/analytics-node')

// instantiation
const analytics = new Analytics({ writeKey: '<MY_WRITE_KEY>' })

app.post('/login', (req, res) => {
   analytics.identify({
      userId: req.body.userId,
      previousId: req.body.previousId
  })

app.post('/cart', (req, res) => {
  analytics.track({
    userId: req.body.userId,
    event: 'Add to cart',
    properties: { productId: '123456' }
  })
   res.sendStatus(201)
});

• Push the SDK to http://github.com/getformo/sdk-node
• yos will publish to https://www.npmjs.com/package/formo/analytics-node
• Nice-to-have: reuse the EventQueue from the web SDK (to batch requests)

How

Consider using https://www.stainless.com/ (need an open api spec for the POST /raw_events endpoint)

• https://www.stainless.com/blog/announcing-the-stainless-sdk-generator
• https://app.stainless.com/formo/projects

Stainless lets you generate SDKs for other languages

Choose typescript target

Examples

• Web SDK: https://github.com/getformo/sdk
• https://www.npmjs.com/package/segment/analytics-node
• https://dub.co/docs/conversions/quickstart#step-2-install-the-dub-server-side-sdk