@timeback/edubridge 0.1.0

package/dist/factory.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Edubridge Client Factory
+ *
+ * Creates EdubridgeClient classes bound to specific provider registries.
+ */
+import { AnalyticsResource, ApplicationsResource, EnrollmentsResource, LearningReportsResource, SubjectTrackResource, UsersResource } from './resources';
+import type { AuthCheckResult, ProviderRegistry, TimebackProvider } from '@timeback/internal-client-infra';
+import type { EdubridgeClientConfig, EdubridgeTransportLike } from './types';
+/**
+ * Create an EdubridgeClient class bound to a specific provider registry.
+ *
+ * @param registry - Provider registry to use (defaults to all Timeback platforms)
+ * @returns EdubridgeClient class bound to the registry
+ */
+export declare function createEdubridgeClient(registry?: ProviderRegistry): {
+    new (config?: EdubridgeClientConfig): {
+        /** @internal */
+        readonly transport: EdubridgeTransportLike;
+        /** @internal */
+        readonly _provider?: TimebackProvider | undefined;
+        /** Query and manage student enrollments in courses, programs, and learning paths */
+        readonly enrollments: EnrollmentsResource;
+        /** Query and manage user accounts and profiles in the learning platform */
+        readonly users: UsersResource;
+        /** Access learning analytics including engagement metrics and progress tracking */
+        readonly analytics: AnalyticsResource;
+        /** Query and manage student applications and admission workflows */
+        readonly applications: ApplicationsResource;
+        /** Query and manage subject tracks defining structured learning paths and curricula */
+        readonly subjectTracks: SubjectTrackResource;
+        /** Access detailed learning progress reports and completion status */
+        readonly learningReports: LearningReportsResource;
+        /**
+         * Get the underlying transport for advanced use cases.
+         * @returns The transport instance used by this client
+         */
+        getTransport(): EdubridgeTransportLike;
+        /**
+         * Verify that OAuth authentication is working.
+         * @returns Auth check result
+         * @throws {Error} If client was initialized with custom transport (no provider)
+         */
+        checkAuth(): Promise<AuthCheckResult>;
+    };
+};
+//# sourceMappingURL=factory.d.ts.map

package/dist/factory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../src/factory.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAMH,OAAO,EACN,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,uBAAuB,EACvB,oBAAoB,EACpB,aAAa,EACb,MAAM,aAAa,CAAA;AAGpB,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAC1G,OAAO,KAAK,EAAE,qBAAqB,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAA;AAE5E;;;;;GAKG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,GAAE,gBAA4C;;QAQ1F,gBAAgB;;QAGhB,gBAAgB;;QAGhB,oFAAoF;;QAEpF,2EAA2E;;QAE3E,mFAAmF;;QAEnF,oEAAoE;;QAEpE,uFAAuF;;QAEvF,sEAAsE;;QA8CtE;;;WAGG;;QAKH;;;;WAIG;;;EASJ"}

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Edubridge API client SDK for Timeback.
+ *
+ * @example Environment mode (Timeback APIs)
+ * ```typescript
+ * import { EdubridgeClient } from '@timeback/edubridge'
+ *
+ * const client = new EdubridgeClient({
+ *   env: 'staging',
+ *   auth: {
+ *     clientId: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *   },
+ * })
+ *
+ * // Enroll a user in a course
+ * const enrollment = await client.enrollments.enroll(userId, courseId)
+ *
+ * // Get user's enrollments
+ * const enrollments = await client.enrollments.list({ userId })
+ * ```
+ *
+ * @example Explicit mode (custom API)
+ * ```typescript
+ * const client = new EdubridgeClient({
+ *   baseUrl: 'https://api.example.com',
+ *   auth: {
+ *     clientId: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *     authUrl: 'https://auth.example.com/oauth2/token',
+ *   },
+ * })
+ * ```
+ */
+export { EdubridgeClient, type EdubridgeClientInstance } from './client';
+export { createEdubridgeClient } from './factory';
+export type { EdubridgeClientConfig } from './types/client';
+export type { Environment, EnvAuth, ExplicitAuth } from './types/client';
+export type { AuthCheckResult, ListParams, PageResult } from '@timeback/internal-client-infra';
+export type { ActivityMetricsData, ActivityParams, AggregatedMetrics, DailyActivityMap, EnrollmentFacts, EnrollmentFactsParams, GradeMasteryData, HighestGradeMastered, SubjectMetrics, TimeSpentMetricsData, WeeklyFactRecord, WeeklyFacts, WeeklyFactsParams, } from './types/analytics';
+export { aggregateActivityMetrics } from './utils';
+export { Transport } from './lib';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AAMH,OAAO,EAAE,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,UAAU,CAAA;AACxE,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAA;AAM3D,YAAY,EAAE,WAAW,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAExE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAE9F,YAAY,EACX,mBAAmB,EACnB,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,qBAAqB,EACrB,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,oBAAoB,EACpB,gBAAgB,EAChB,WAAW,EACX,iBAAiB,GACjB,MAAM,mBAAmB,CAAA;AAM1B,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAMlD,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA"}