@timeback/core 0.2.1 → 0.2.2-beta.20260320221119

package/dist/types/index.d.ts

@@ -1,246 +0,0 @@
-/**
- * Timeback Core Types
- *
- * Configuration types for the unified Timeback client,
- * plus re-exports of entity types from all services.
- *
- * @example
- * ```typescript
- * import type { User, School, Organization } from '@timeback/core/types'
- * ```
- */
-import type { TimebackProvider } from '@timeback/internal-client-infra';
-import type { PLATFORMS } from '@timeback/internal-constants';
-export * as OneRoster from '@timeback/oneroster/types';
-export * as Caliper from '@timeback/caliper/types';
-export * as Webhooks from '@timeback/webhooks/types';
-export * as Edubridge from '@timeback/edubridge/types';
-export * as Qti from '@timeback/qti/types';
-export * as PowerPath from '@timeback/powerpath/types';
-/**
- * Supported Timeback platform implementations.
- * Derived from PLATFORMS constant in {@link @timeback/internal-constants.PLATFORMS}.
- */
-export type Platform = (typeof PLATFORMS)[number];
-/**
- * Timeback deployment environment.
- */
-export type Environment = 'staging' | 'production';
-/**
- * Resolved service URLs for environment mode.
- * @internal
- */
-export interface EnvServiceUrls {
-    oneroster: string;
-    caliper: string;
-    webhooks: string;
-    edubridge: string;
-    qti: string;
-    powerpath?: string;
-    authUrl: string;
-}
-/**
- * OAuth2 client credentials for environment mode.
- * Token URL is derived from the environment.
- */
-export interface EnvAuthCredentials {
-    clientId: string;
-    clientSecret: string;
-}
-/**
- * OAuth2 client credentials with explicit token URL.
- * Required when using baseUrl or services mode.
- */
-export interface ExplicitAuthCredentials {
-    clientId: string;
-    clientSecret: string;
-    authUrl: string;
-}
-/**
- * Service endpoint configuration.
- * Can be a simple URL string or an object with baseUrl and optional authUrl override.
- */
-export type ServiceEndpoint = string | {
-    baseUrl: string;
-    authUrl?: string;
-};
-/**
- * Explicit URLs for each service.
- * All fields optional — only configure services you need.
- */
-export interface ServiceUrls {
-    /** OneRoster API endpoint */
-    oneroster?: ServiceEndpoint;
-    /** Caliper API endpoint */
-    caliper?: ServiceEndpoint;
-    /** Webhooks API endpoint */
-    webhooks?: ServiceEndpoint;
-    /** Edubridge API endpoint */
-    edubridge?: ServiceEndpoint;
-    /** QTI API endpoint */
-    qti?: ServiceEndpoint;
-    /** PowerPath API endpoint */
-    powerpath?: ServiceEndpoint;
-}
-/**
- * Environment mode: URLs derived from platform and environment.
- *
- * @example
- * ```typescript
- * // BeyondAI platform (default)
- * const client = new TimebackClient({
- *   env: 'staging',
- *   auth: { clientId: '...', clientSecret: '...' },
- * })
- *
- * // LearnWith.AI platform
- * const client = new TimebackClient({
- *   platform: 'LEARNWITH_AI',
- *   env: 'production',
- *   auth: { clientId: '...', clientSecret: '...' },
- * })
- * ```
- */
-export interface EnvConfig {
-    platform?: Platform;
-    env: Environment;
-    auth?: Partial<EnvAuthCredentials>;
-    timeout?: number;
-}
-/**
- * Base URL mode: Single base URL, service paths derived automatically.
- *
- * @example
- * ```typescript
- * const client = new TimebackClient({
- *   baseUrl: 'https://timeback.myschool.edu',
- *   auth: {
- *     clientId: '...',
- *     clientSecret: '...',
- *     authUrl: 'https://timeback.myschool.edu/oauth/token',
- *   },
- * })
- * ```
- */
-export interface BaseUrlConfig {
-    baseUrl: string;
-    auth: ExplicitAuthCredentials;
-    timeout?: number;
-}
-/**
- * Explicit services mode: Full control over each service URL.
- *
- * @example
- * ```typescript
- * const client = new TimebackClient({
- *   services: {
- *     oneroster: 'https://roster.example.com/v1p2',
- *     caliper: 'https://analytics.example.com/caliper',
- *     edubridge: 'https://api.example.com/edubridge',
- *     qti: 'https://qti.example.com/api',
- *   },
- *   auth: {
- *     clientId: '...',
- *     clientSecret: '...',
- *     authUrl: 'https://auth.example.com/oauth/token',
- *   },
- * })
- * ```
- */
-export interface ServicesConfig {
-    services: ServiceUrls;
-    auth: ExplicitAuthCredentials;
-    timeout?: number;
-}
-/**
- * Provider mode: use a pre-built TimebackProvider.
- *
- * @example
- * ```typescript
- * import { TimebackProvider } from '@timeback/internal-client-infra'
- *
- * const provider = new TimebackProvider({
- *   platform: 'BEYOND_AI',
- *   env: 'staging',
- *   auth: { clientId: '...', clientSecret: '...' },
- * })
- *
- * const client = new TimebackClient({ provider })
- * ```
- */
-export interface ProviderConfig {
-    provider: TimebackProvider;
-}
-/**
- * Configuration for the unified Timeback client.
- *
- * Supports four modes:
- * - **Provider**: `{ provider: TimebackProvider }` — pre-built provider
- * - **Environment**: `{ env: 'staging' | 'production', auth: {...} }`
- * - **Base URL**: `{ baseUrl: '...', auth: {..., authUrl: '...' } }`
- * - **Explicit services**: `{ services: {...}, auth: {..., authUrl: '...' } }`
- */
-export type TimebackClientConfig = ProviderConfig | EnvConfig | BaseUrlConfig | ServicesConfig;
-/**
- * Result of a broadcast operation for a single client.
- * Similar to PromiseSettledResult but with simpler `ok` boolean.
- */
-export type BroadcastResult<T> = {
-    ok: true;
-    value: T;
-} | {
-    ok: false;
-    error: Error;
-};
-/**
- * Convenience methods available on broadcast results.
- *
- * @typeParam T - The value type returned by successful operations
- * @typeParam TNames - Union of client names (for typed tuples)
- */
-export interface BroadcastResultMethods<T, TNames extends string = string> {
-    /** Get all successful results as [name, value] tuples */
-    readonly succeeded: Array<[TNames, T]>;
-    /** Get all failed results as [name, error] tuples */
-    readonly failed: Array<[TNames, Error]>;
-    /** True if all operations succeeded */
-    readonly allSucceeded: boolean;
-    /** True if any operation failed */
-    readonly anyFailed: boolean;
-    /** Get all successful values (throws if any failed) */
-    values(): T[];
-}
-/**
- * Broadcast results with both direct property access and convenience methods.
- *
- * Access results directly by name or use helper methods:
- *
- * @typeParam T - The value type returned by successful operations
- * @typeParam TNames - Union of client names (enables autocomplete)
- *
- * @example
- * ```typescript
- * const results = await manager.broadcast(c => c.oneroster.users.create(user))
- *
- * // Direct access (like a plain object):
- * results.alpha.ok
- * results['beta'].error
- *
- * // Convenience methods:
- * if (results.allSucceeded) {
- *   console.log('All platforms synced!')
- * }
- *
- * results.succeeded.forEach(([name, user]) => {
- *   console.log(`Created on ${name}:`, user.id)
- * })
- *
- * results.failed.forEach(([name, error]) => {
- *   console.error(`Failed on ${name}:`, error.message)
- * })
- * ```
- */
-export type BroadcastResults<T, TNames extends string = string> = {
-    [K in TNames]: BroadcastResult<T>;
-} & BroadcastResultMethods<T, TNames>;
-//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AACvE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAM7D,OAAO,KAAK,SAAS,MAAM,2BAA2B,CAAA;AACtD,OAAO,KAAK,OAAO,MAAM,yBAAyB,CAAA;AAClD,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,SAAS,MAAM,2BAA2B,CAAA;AACtD,OAAO,KAAK,GAAG,MAAM,qBAAqB,CAAA;AAC1C,OAAO,KAAK,SAAS,MAAM,2BAA2B,CAAA;AAMtD;;;GAGG;AACH,MAAM,MAAM,QAAQ,GAAG,CAAC,OAAO,SAAS,CAAC,CAAC,MAAM,CAAC,CAAA;AAEjD;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,YAAY,CAAA;AAElD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE,MAAM,CAAA;CACf;AAMD;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACvC,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,EAAE,MAAM,CAAA;IACpB,OAAO,EAAE,MAAM,CAAA;CACf;AAMD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG;IAAE,OAAO,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAA;CAAE,CAAA;AAE5E;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,6BAA6B;IAC7B,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,2BAA2B;IAC3B,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,4BAA4B;IAC5B,QAAQ,CAAC,EAAE,eAAe,CAAA;IAC1B,6BAA6B;IAC7B,SAAS,CAAC,EAAE,eAAe,CAAA;IAC3B,uBAAuB;IACvB,GAAG,CAAC,EAAE,eAAe,CAAA;IACrB,6BAA6B;IAC7B,SAAS,CAAC,EAAE,eAAe,CAAA;CAC3B;AAMD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,SAAS;IACzB,QAAQ,CAAC,EAAE,QAAQ,CAAA;IACnB,GAAG,EAAE,WAAW,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAClC,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,aAAa;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,uBAAuB,CAAA;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,EAAE,WAAW,CAAA;IACrB,IAAI,EAAE,uBAAuB,CAAA;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,cAAc;IAC9B,QAAQ,EAAE,gBAAgB,CAAA;CAC1B;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAAG,cAAc,GAAG,SAAS,GAAG,aAAa,GAAG,cAAc,CAAA;AAU9F;;;GAGG;AACH,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,CAAC,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,CAAA;AAErF;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM;IACxE,yDAAyD;IACzD,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAA;IACtC,qDAAqD;IACrD,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;IACvC,uCAAuC;IACvC,QAAQ,CAAC,YAAY,EAAE,OAAO,CAAA;IAC9B,mCAAmC;IACnC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;IAC3B,uDAAuD;IACvD,MAAM,IAAI,CAAC,EAAE,CAAA;CACb;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,EAAE,MAAM,SAAS,MAAM,GAAG,MAAM,IAAI;KAChE,CAAC,IAAI,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC;CACjC,GAAG,sBAAsB,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA"}

package/dist/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AAEH,cAAc,eAAe,CAAA"}

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AAE9D,YAAY,EACX,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,cAAc,GACd,MAAM,qBAAqB,CAAA"}