@timeback/oneroster 0.1.0

package/dist/factory.d.ts

@@ -0,0 +1,100 @@
+/**
+ * OneRoster Client Factory
+ *
+ * Creates OneRosterClient classes bound to specific provider registries.
+ * Enables platform-specific packages and custom deployments.
+ */
+import { AssessmentResultsResource } from './resources/assessment';
+import { CategoriesResource, ResultsResource, ScoreScalesResource } from './resources/gradebook';
+import { AcademicSessionsResource, DemographicsResource, EnrollmentsResource, GradingPeriodsResource, OrgsResource } from './resources/rostering';
+import type { AuthCheckResult, ProviderRegistry, TimebackProvider } from '@timeback/internal-client-infra';
+import type { AssessmentLineItemsCallable, ClassesCallable, CoursesCallable, LineItemsCallable, OneRosterClientConfig, OneRosterTransportLike, ResourcesCallable, SchoolsCallable, StudentsCallable, TeachersCallable, TermsCallable, UsersCallable } from './types';
+/**
+ * Create a OneRosterClient class bound to a specific provider registry.
+ *
+ * This factory enables:
+ * - Platform-specific packages (different default registries)
+ * - Custom registries for enterprise deployments
+ * - Easier testing with mock registries
+ *
+ * @param registry - Provider registry to use (defaults to all Timeback platforms)
+ * @returns OneRosterClient class bound to the registry
+ *
+ * @example Default usage (all platforms)
+ * ```typescript
+ * const OneRosterClient = createOneRosterClient()
+ * const client = new OneRosterClient({ env: 'staging', auth: { ... } })
+ * ```
+ *
+ * @example BeyondAI-only package
+ * ```typescript
+ * const BEYONDAI_REGISTRY = {
+ *   defaultPlatform: 'BEYOND_AI',
+ *   templates: {
+ *     BEYOND_AI: {
+ *       staging: { platform: 'BEYOND_AI', env: 'staging' },
+ *       production: { platform: 'BEYOND_AI', env: 'production' },
+ *     },
+ *   },
+ * }
+ * export const OneRosterClient = createOneRosterClient(BEYONDAI_REGISTRY)
+ * ```
+ */
+export declare function createOneRosterClient(registry?: ProviderRegistry): {
+    new (config?: OneRosterClientConfig): {
+        /** @internal */
+        readonly transport: OneRosterTransportLike;
+        /** @internal */
+        readonly _provider?: TimebackProvider | undefined;
+        /** Query and manage user accounts across the district, including students, teachers, and staff */
+        readonly users: UsersCallable;
+        /** Query and manage student records, including their classes, enrollments, and demographics */
+        readonly students: StudentsCallable;
+        /** Query and manage teacher records, including their class assignments and org affiliations */
+        readonly teachers: TeachersCallable;
+        /** Query and manage organizational hierarchy including districts, schools, and departments */
+        readonly orgs: OrgsResource;
+        /** Query and manage school records within the district hierarchy */
+        readonly schools: SchoolsCallable;
+        /** Query and manage class sections, including their teachers, students, and schedules */
+        readonly classes: ClassesCallable;
+        /** Query and manage course catalog definitions and subject metadata */
+        readonly courses: CoursesCallable;
+        /** Query and manage student and teacher enrollments in classes */
+        readonly enrollments: EnrollmentsResource;
+        /** Query and manage academic sessions like school years and semesters */
+        readonly academicSessions: AcademicSessionsResource;
+        /** Query and manage academic terms within sessions */
+        readonly terms: TermsCallable;
+        /** Query and manage grading periods for progress reporting */
+        readonly gradingPeriods: GradingPeriodsResource;
+        /** Query demographic information including race, ethnicity, and other protected data */
+        readonly demographics: DemographicsResource;
+        /** Query and manage gradebook line items like assignments, quizzes, and assessments */
+        readonly lineItems: LineItemsCallable;
+        /** Query and manage student grades and scores for line items */
+        readonly results: ResultsResource;
+        /** Query and manage grading categories for organizing line items (e.g., Homework, Tests) */
+        readonly categories: CategoriesResource;
+        /** Query and manage score scales that define grading rubrics and point values */
+        readonly scoreScales: ScoreScalesResource;
+        /** Query and manage formal assessment line items for standardized testing */
+        readonly assessmentLineItems: AssessmentLineItemsCallable;
+        /** Query and manage student results from formal assessments */
+        readonly assessmentResults: AssessmentResultsResource;
+        /** Query and manage digital learning resources (content, activities, materials) */
+        readonly resources: ResourcesCallable;
+        /**
+         * Get the underlying transport for advanced use cases.
+         * @returns The transport instance used by this client
+         */
+        getTransport(): OneRosterTransportLike;
+        /**
+         * 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;;;;;GAKG;AAMH,OAAO,EACN,yBAAyB,EAEzB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,EACN,kBAAkB,EAElB,eAAe,EACf,mBAAmB,EACnB,MAAM,uBAAuB,CAAA;AAE9B,OAAO,EACN,wBAAwB,EAQxB,oBAAoB,EACpB,mBAAmB,EACnB,sBAAsB,EACtB,YAAY,EACZ,MAAM,uBAAuB,CAAA;AAG9B,OAAO,KAAK,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,iCAAiC,CAAA;AAC1G,OAAO,KAAK,EACX,2BAA2B,EAC3B,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,gBAAgB,EAChB,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,MAAM,SAAS,CAAA;AAEhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,wBAAgB,qBAAqB,CAAC,QAAQ,GAAE,gBAA4C;;QAQ1F,gBAAgB;;QAGhB,gBAAgB;;QAIhB,kGAAkG;;QAElG,+FAA+F;;QAE/F,+FAA+F;;QAE/F,8FAA8F;;QAE9F,oEAAoE;;QAEpE,yFAAyF;;QAEzF,uEAAuE;;QAEvE,kEAAkE;;QAElE,yEAAyE;;QAEzE,sDAAsD;;QAEtD,8DAA8D;;QAE9D,wFAAwF;;QAIxF,uFAAuF;;QAEvF,gEAAgE;;QAEhE,4FAA4F;;QAE5F,iFAAiF;;QAIjF,6EAA6E;;QAE7E,+DAA+D;;QAI/D,mFAAmF;;QA+DnF;;;WAGG;;QAKH;;;;WAIG;;;EASJ"}

package/dist/index.d.ts

@@ -0,0 +1,42 @@
+/**
+ * OneRoster v1.2 client SDK for Timeback.
+ *
+ * @example Environment mode (Timeback APIs)
+ * ```typescript
+ * import { OneRosterClient } from '@timeback/oneroster'
+ *
+ * const client = new OneRosterClient({
+ *   env: 'staging',
+ *   auth: {
+ *     clientId: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *   },
+ * })
+ *
+ * for await (const school of client.schools.list()) {
+ *   console.log(school.name)
+ * }
+ * ```
+ *
+ * @example Explicit mode (custom OneRoster API)
+ * ```typescript
+ * const client = new OneRosterClient({
+ *   baseUrl: 'https://api.example.com',
+ *   auth: {
+ *     clientId: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *     authUrl: 'https://auth.example.com/oauth2/token',
+ *   },
+ * })
+ * ```
+ */
+export { OneRosterClient, type OneRosterClientInstance } from './client';
+export { createOneRosterClient } from './factory';
+export type { OneRosterClientConfig } from './types/client';
+export type { Environment, EnvAuth, ExplicitAuth } from './types/client';
+export type { StreamableResource } from './types/base';
+export type { AuthCheckResult, ListParams, PageResult } from '@timeback/internal-client-infra';
+export { whereToFilter } from '@timeback/internal-client-infra';
+export type { FieldCondition, FieldOperators, FilterFields, FilterValue, OrCondition, WhereClause, } from '@timeback/internal-client-infra';
+export { Paginator, 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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAMH,OAAO,EAAE,eAAe,EAAE,KAAK,uBAAuB,EAAE,MAAM,UAAU,CAAA;AAExE,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,kBAAkB,EAAE,MAAM,cAAc,CAAA;AAEtD,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAA;AAM9F,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAA;AAE/D,YAAY,EACX,cAAc,EACd,cAAc,EACd,YAAY,EACZ,WAAW,EACX,WAAW,EACX,WAAW,GACX,MAAM,iCAAiC,CAAA;AAMxC,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA"}