@swingalytica/sdk

The official Swingalytica™ SDK from RealGolf.Games UG.
Easily integrate logging and other modules into your applications, sending data to your own API.

Installation

npm install @swingalytica/sdk
# or
yarn add @swingalytica/sdk

Usage

import Swingalytica from '@swingalytica/sdk';

const sdk = new Swingalytica({
	logs: { endpoint_url: 'https://myapi.example.com' } // your API base URL
});

// Create a log
await sdk.logs.new({
	type: 'info', // "info" | "warn" | "error" | "debug"
	message: 'User started a new session',
	metadata: { userId: 123 },
	user_id: 123,
	session_id: 'abc-456'
});

Log Parameters

• type: "info" | "warn" | "error" | "debug" – log level
• message: string – main log message
• status: optional number – HTTP or custom status code
• metadata: optional object – extra key/value data
• user_id: optional string or number – user identifier
• session_id: optional string – session identifier
• timestamp: optional string or Date – defaults to now

Notes

• The endpoint_url you provide should point to your own API exposing a POST route at /v1/logs
• Logs are sent as JSON to <endpoint_url>/v1/logs
• This SDK currently only exposes logging, but more modules may be added in the future

License

RealGolf.Games Public License (RGGPL) 1.0
Copyright © 2025 RealGolf.Games UG (haftungsbeschränkt)

For more details, see the LICENSE file included in this package.