@timeback/sdk 0.1.5 → 0.1.6

package/README.md

@@ -40,7 +40,7 @@ bun add timeback
 
 ## Server Adapters
 
-All server adapters use the same core configuration:
+All server adapters use the same core configuration and require a `timeback.config.json` file:
 
 ```typescript
 // lib/timeback.ts
@@ -420,7 +420,7 @@ The SDK resolves the Timeback user by email. You only need to provide the authen
 If you only need Timeback SSO authentication without activity tracking or Timeback API integration, use `createTimebackIdentity()`. This is a lightweight alternative that:
 
 - Does not require Timeback API credentials
-- Does not require `timeback.config.ts`
+- Does not require `timeback.config.json`
 - Only exposes identity routes (sign-in, callback, sign-out)
 - Returns raw OIDC user info (no Timeback profile enrichment)
 
@@ -429,8 +429,8 @@ If you only need Timeback SSO authentication without activity tracking or Timeba
 ### Cloudflare Workers / workerd compatibility
 
 `createTimebackIdentity()` is runtime-agnostic, but the main `timeback` entrypoint also includes
-Node-oriented functionality (notably config loading via `jiti`). Some edge runtimes
-(Cloudflare Workers / workerd) do not support the Node modules that `jiti` depends on.
+Node-oriented functionality (notably config loading via `c12`). Some edge runtimes
+(Cloudflare Workers / workerd) do not support the Node modules that `c12` depends on.
 
 If you're deploying identity-only SSO on Workers/workerd, import from the worker-safe entrypoint:
 
@@ -542,7 +542,7 @@ await activity.end({
 
 The SDK automatically sends activity data to your server, which forwards it to the Timeback API.
 
-**Note:** Activity ingestion requires an **effective Caliper sensor URL per course** in `timeback.config.ts`.
+**Note:** Activity ingestion requires an **effective Caliper sensor URL per course** in `timeback.config.json`.
 
 Sensor precedence (highest → lowest):
 
@@ -550,24 +550,23 @@ Sensor precedence (highest → lowest):
 - per-course base override: `course.sensor`
 - top-level default: `config.sensor`
 
-```typescript
-export default {
-	name: 'My App',
-	sensor: 'https://my-app.example.com/sensors/default',
-	courses: [
+```json
+{
+	"$schema": "https://timeback.dev/schema.json",
+	"name": "My App",
+	"sensor": "https://my-app.example.com/sensors/default",
+	"courses": [
 		{
-			subject: 'Math',
-			grade: 3,
-			courseCode: 'MATH-3',
-			// Base override (all envs)
-			sensor: 'https://my-app.example.com/sensors/math',
-			// Env-specific overrides (applied when syncing/editing in that env)
-			overrides: {
-				staging: { sensor: 'https://staging.my-app.example.com/sensors/math' },
-				production: { sensor: 'https://my-app.example.com/sensors/math' },
-			},
-		},
-	],
+			"subject": "Math",
+			"grade": 3,
+			"courseCode": "MATH-3",
+			"sensor": "https://my-app.example.com/sensors/math",
+			"overrides": {
+				"staging": { "sensor": "https://staging.my-app.example.com/sensors/math" },
+				"production": { "sensor": "https://my-app.example.com/sensors/math" }
+			}
+		}
+	]
 }
 ```
 

package/dist/edge.d.ts

@@ -2,7 +2,7 @@
  * Timeback (edge/worker friendly entrypoint)
  *
  * This entrypoint is intended for runtimes like Cloudflare Workers / workerd.
- * It avoids importing Node-only dependencies (notably config loading via `jiti`).
+ * It avoids importing Node-only dependencies (notably config loading via `c12`).
  *
  * It includes identity-only SSO plus a small set of edge-safe helpers.
  */