TypeScript & PHP SDKs for the Chastify API

The package is published on npm:

npm add @ecosplay/chastify-sdk     # Node
bun add @ecosplay/chastify-sdk     # Bun

The package is published on Packagist:

composer require e-cosplay/chastify-sdk

ext-redis (phpredis) is optional, only for the Redis cache.

import { ChastifyClient } from "@ecosplay/chastify-sdk";

const chastify = new ChastifyClient({ devToken: process.env.CHASTIFY_DEV_TOKEN! });

const session = await chastify.session.get();
console.log(session.lockData?.remainingSeconds);

await chastify.lock.addTime(600);          // +10 min
await chastify.lock.freeze(1800);          // freeze 30 min
await chastify.lock.unfreeze();
await chastify.tasks.assign({ taskText: "10 min meditation", points: 10 });
await chastify.logs.custom({ title: "Check-in", role: "extension" });
await chastify.device.vibrate({ intensityPct: 40, durationSeconds: 5 });

use Ecosplay\Chastify\ChastifyClient;

$chastify = new ChastifyClient(['devToken' => getenv('CHASTIFY_DEV_TOKEN')]);

$session = $chastify->session()->get();
echo $session['lockData']['remainingSeconds'] ?? 0;

$chastify->lock()->addTime(600);           // +10 min
$chastify->lock()->freeze(1800);           // freeze 30 min
$chastify->lock()->unfreeze();
$chastify->tasks()->assign(['taskText' => '10 min meditation', 'points' => 10]);
$chastify->logs()->custom(['title' => 'Check-in', 'role' => 'extension']);
$chastify->device()->vibrate(['intensityPct' => 40, 'durationSeconds' => 5]);

import { ChastifyClient, RedisCache, ConsoleLogger } from "@ecosplay/chastify-sdk";
import Redis from "ioredis";

const chastify = new ChastifyClient({
  devToken: process.env.CHASTIFY_DEV_TOKEN!,
  timeoutMs: 30_000,                      // default
  maxRetries: 4,                          // 429 + 5xx + network
  cache: new RedisCache(new Redis(process.env.REDIS_URL!)),
  cacheTtlMs: 5000,                       // 0 = cache OFF (default)
  logger: new ConsoleLogger(),
  logLevel: "debug",                      // secrets redacted
});

await chastify.session.get({ cache: false }); // force refresh

use Ecosplay\Chastify\ChastifyClient;
use Ecosplay\Chastify\Cache\RedisCache;
use Ecosplay\Chastify\Logging\StderrLogger;

$redis = new \Redis();
$redis->connect('127.0.0.1', 6379);

$chastify = new ChastifyClient([
    'devToken'   => getenv('CHASTIFY_DEV_TOKEN'),
    'timeoutMs'  => 30000,                // default
    'maxRetries' => 4,                    // 429 + 5xx + network
    'cache'      => new RedisCache($redis), // or any PSR-16 cache
    'cacheTtlMs' => 5000,                 // 0 = cache OFF (default)
    'logger'     => new StderrLogger(),   // or any PSR-3 logger
]);

$chastify->session()->get(['cache' => false]); // force refresh

const chastify = new ChastifyClient({ appKey: process.env.CHASTIFY_APP_KEY! });
const s = chastify.extensions.session(sessionId, mainToken);

await s.patchState({ wins: 3 });                          // extension state
await s.patchMetadata({ unlockBlockers: ["Win 3 games"] });
await s.action("add_time", { deltaSeconds: 300 });        // reward or penalty
await s.recordProgress({ metric: "memory_win", amount: 1 });
await s.notify({ title: "Well done!", message: "Game won", target: "both" });
await s.files.upload({ data: bytes, filename: "proof.jpg" }, { purpose: "evidence" });

$chastify = new ChastifyClient(['appKey' => getenv('CHASTIFY_APP_KEY')]);
$s = $chastify->extensions()->session($sessionId, $mainToken);

$s->patchState(['wins' => 3]);                            // extension state
$s->patchMetadata(['unlockBlockers' => ['Win 3 games']]);
$s->action('add_time', ['deltaSeconds' => 300]);          // reward or penalty
$s->recordProgress(['metric' => 'memory_win', 'amount' => 1]);
$s->notify(['title' => 'Well done!', 'message' => 'Game won', 'target' => 'both']);
$s->files()->upload(['contents' => $bytes, 'filename' => 'proof.jpg'], 'evidence');

import { ChastifyWebhooks } from "@ecosplay/chastify-sdk";

app.post("/chastify/webhook", express.raw({ type: "*/*" }), (req, res) => {
  const event = ChastifyWebhooks.constructEvent(
    req.body, req.headers, process.env.CHASTIFY_WEBHOOK_TOKEN!,
  ); // throws WebhookVerificationError on hash mismatch

  if (event.event === "task.completed") { /* … */ }
  res.sendStatus(200);
});

use Ecosplay\Chastify\Webhooks;

$event = Webhooks::constructEvent(
    file_get_contents('php://input'),
    getallheaders(),
    getenv('CHASTIFY_WEBHOOK_TOKEN'),
); // throws WebhookVerificationException on hash mismatch

if ($event['event'] === 'task.completed') { /* … */ }
http_response_code(200);