@eduware/oneroster 1.0.0

package/dist/commonjs/types/operations.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.URL_OVERRIDE = void 0;
+exports.createPageIterator = createPageIterator;
+exports.haltIterator = haltIterator;
+exports.unwrapResultIterator = unwrapResultIterator;
+function createPageIterator(page, halt) {
+    return {
+        [Symbol.asyncIterator]: async function* paginator() {
+            yield page;
+            if (halt(page)) {
+                return;
+            }
+            let p = page;
+            for (p = await p.next(); p != null; p = await p.next()) {
+                yield p;
+                if (halt(p)) {
+                    return;
+                }
+            }
+        },
+    };
+}
+/**
+ * This utility create a special iterator that yields a single value and
+ * terminates. It is useful in paginated SDK functions that have early return
+ * paths when things go wrong.
+ */
+function haltIterator(v) {
+    return {
+        ...v,
+        next: () => null,
+        [Symbol.asyncIterator]: async function* paginator() {
+            yield v;
+        },
+    };
+}
+/**
+ * Converts an async iterator of `Result<V, E>` into an async iterator of `V`.
+ * When error results occur, the underlying error value is thrown.
+ */
+async function unwrapResultIterator(iteratorPromise) {
+    const resultIter = await iteratorPromise;
+    if (!resultIter.ok) {
+        throw resultIter.error;
+    }
+    return {
+        ...resultIter.value,
+        next: unwrapPaginator(resultIter.next),
+        '~next': resultIter['~next'],
+        [Symbol.asyncIterator]: async function* paginator() {
+            for await (const page of resultIter) {
+                if (!page.ok) {
+                    throw page.error;
+                }
+                yield page.value;
+            }
+        },
+    };
+}
+function unwrapPaginator(paginator) {
+    return () => {
+        const nextResult = paginator();
+        if (nextResult == null) {
+            return null;
+        }
+        return nextResult.then((res) => {
+            if (!res.ok) {
+                throw res.error;
+            }
+            const out = {
+                ...res.value,
+                next: unwrapPaginator(res.next),
+            };
+            return out;
+        });
+    };
+}
+exports.URL_OVERRIDE = Symbol('URL_OVERRIDE');
+//# sourceMappingURL=operations.js.map

package/dist/commonjs/types/operations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operations.js","sourceRoot":"","sources":["../../../src/types/operations.ts"],"names":[],"mappings":";;;AAUA,gDAsBC;AAOD,oCAQC;AAMD,oDAsBC;AAjED,SAAgB,kBAAkB,CAC9B,IAAgC,EAChC,IAAuB;IAIvB,OAAO;QACH,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,SAAS;YAC7C,MAAM,IAAI,CAAC;YACX,IAAI,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;gBACb,OAAO;YACX,CAAC;YAED,IAAI,CAAC,GAAuB,IAAI,CAAC;YACjC,KAAK,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC;gBACrD,MAAM,CAAC,CAAC;gBACR,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;oBACV,OAAO;gBACX,CAAC;YACL,CAAC;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAmB,CAAI;IAC/C,OAAO;QACH,GAAG,CAAC;QACJ,IAAI,EAAE,GAAG,EAAE,CAAC,IAAI;QAChB,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,SAAS;YAC7C,MAAM,CAAC,CAAC;QACZ,CAAC;KACJ,CAAC;AACN,CAAC;AAED;;;GAGG;AACI,KAAK,UAAU,oBAAoB,CACtC,eAAqE;IAErE,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC;IAEzC,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACjB,MAAM,UAAU,CAAC,KAAK,CAAC;IAC3B,CAAC;IAED,OAAO;QACH,GAAG,UAAU,CAAC,KAAK;QACnB,IAAI,EAAE,eAAe,CAAC,UAAU,CAAC,IAAI,CAAC;QACtC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAC;QAC5B,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC,SAAS;YAC7C,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,UAAU,EAAE,CAAC;gBAClC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC;oBACX,MAAM,IAAI,CAAC,KAAK,CAAC;gBACrB,CAAC;gBACD,MAAM,IAAI,CAAC,KAAK,CAAC;YACrB,CAAC;QACL,CAAC;KACJ,CAAC;AACN,CAAC;AAED,SAAS,eAAe,CAAI,SAAwC;IAChE,OAAO,GAAG,EAAE;QACR,MAAM,UAAU,GAAG,SAAS,EAAE,CAAC;QAC/B,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC;QAChB,CAAC;QACD,OAAO,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;YAC3B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;gBACV,MAAM,GAAG,CAAC,KAAK,CAAC;YACpB,CAAC;YACD,MAAM,GAAG,GAAG;gBACR,GAAG,GAAG,CAAC,KAAK;gBACZ,IAAI,EAAE,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;aAClC,CAAC;YACF,OAAO,GAAG,CAAC;QACf,CAAC,CAAC,CAAC;IACP,CAAC,CAAC;AACN,CAAC;AAEY,QAAA,YAAY,GAAG,MAAM,CAAC,cAAc,CAAC,CAAC"}

package/dist/commonjs/types/rfcdate.d.ts

@@ -0,0 +1,21 @@
+export declare class RFCDate {
+    private serialized;
+    /**
+     * Creates a new RFCDate instance using today's date.
+     */
+    static today(): RFCDate;
+    /**
+     * Creates a new RFCDate instance using the provided input.
+     * If a string is used then in must be in the format YYYY-MM-DD.
+     *
+     * @param date A Date object or a date string in YYYY-MM-DD format
+     * @example
+     * new RFCDate("2022-01-01")
+     * @example
+     * new RFCDate(new Date())
+     */
+    constructor(date: Date | string);
+    toJSON(): string;
+    toString(): string;
+}
+//# sourceMappingURL=rfcdate.d.ts.map

package/dist/commonjs/types/rfcdate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfcdate.d.ts","sourceRoot":"","sources":["../../../src/types/rfcdate.ts"],"names":[],"mappings":"AAEA,qBAAa,OAAO;IAChB,OAAO,CAAC,UAAU,CAAS;IAE3B;;OAEG;IACH,MAAM,CAAC,KAAK,IAAI,OAAO;IAIvB;;;;;;;;;OASG;gBACS,IAAI,EAAE,IAAI,GAAG,MAAM;IAkB/B,MAAM,IAAI,MAAM;IAIhB,QAAQ,IAAI,MAAM;CAGrB"}

package/dist/commonjs/types/rfcdate.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RFCDate = void 0;
+const dateRE = /^\d{4}-\d{2}-\d{2}$/;
+class RFCDate {
+    /**
+     * Creates a new RFCDate instance using today's date.
+     */
+    static today() {
+        return new RFCDate(new Date());
+    }
+    /**
+     * Creates a new RFCDate instance using the provided input.
+     * If a string is used then in must be in the format YYYY-MM-DD.
+     *
+     * @param date A Date object or a date string in YYYY-MM-DD format
+     * @example
+     * new RFCDate("2022-01-01")
+     * @example
+     * new RFCDate(new Date())
+     */
+    constructor(date) {
+        if (typeof date === 'string' && !dateRE.test(date)) {
+            throw new RangeError('RFCDate: date strings must be in the format YYYY-MM-DD: ' + date);
+        }
+        const value = new Date(date);
+        if (isNaN(+value)) {
+            throw new RangeError('RFCDate: invalid date provided: ' + date);
+        }
+        this.serialized = value.toISOString().slice(0, 'YYYY-MM-DD'.length);
+        if (!dateRE.test(this.serialized)) {
+            throw new TypeError(`RFCDate: failed to build valid date with given value: ${date} serialized to ${this.serialized}`);
+        }
+    }
+    toJSON() {
+        return this.toString();
+    }
+    toString() {
+        return this.serialized;
+    }
+}
+exports.RFCDate = RFCDate;
+//# sourceMappingURL=rfcdate.js.map

package/dist/commonjs/types/rfcdate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rfcdate.js","sourceRoot":"","sources":["../../../src/types/rfcdate.ts"],"names":[],"mappings":";;;AAAA,MAAM,MAAM,GAAG,qBAAqB,CAAC;AAErC,MAAa,OAAO;IAGhB;;OAEG;IACH,MAAM,CAAC,KAAK;QACR,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;IACnC,CAAC;IAED;;;;;;;;;OASG;IACH,YAAY,IAAmB;QAC3B,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,MAAM,IAAI,UAAU,CAAC,0DAA0D,GAAG,IAAI,CAAC,CAAC;QAC5F,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,CAAC;QAC7B,IAAI,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;YAChB,MAAM,IAAI,UAAU,CAAC,kCAAkC,GAAG,IAAI,CAAC,CAAC;QACpE,CAAC;QAED,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC,EAAE,YAAY,CAAC,MAAM,CAAC,CAAC;QACpE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,SAAS,CACf,yDAAyD,IAAI,kBAAkB,IAAI,CAAC,UAAU,EAAE,CACnG,CAAC;QACN,CAAC;IACL,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,QAAQ,EAAE,CAAC;IAC3B,CAAC;IAED,QAAQ;QACJ,OAAO,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;CACJ;AA7CD,0BA6CC"}

package/dist/commonjs/types/streams.d.ts

@@ -0,0 +1,2 @@
+export declare function isReadableStream<T = Uint8Array>(val: unknown): val is ReadableStream<T>;
+//# sourceMappingURL=streams.d.ts.map

package/dist/commonjs/types/streams.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.d.ts","sourceRoot":"","sources":["../../../src/types/streams.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,CAAC,GAAG,UAAU,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,cAAc,CAAC,CAAC,CAAC,CAcvF"}

package/dist/commonjs/types/streams.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isReadableStream = isReadableStream;
+function isReadableStream(val) {
+    if (typeof val !== 'object' || val === null) {
+        return false;
+    }
+    // Check for the presence of methods specific to ReadableStream
+    const stream = val;
+    // ReadableStream has methods like getReader, cancel, and tee
+    return (typeof stream.getReader === 'function' &&
+        typeof stream.cancel === 'function' &&
+        typeof stream.tee === 'function');
+}
+//# sourceMappingURL=streams.js.map

package/dist/commonjs/types/streams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"streams.js","sourceRoot":"","sources":["../../../src/types/streams.ts"],"names":[],"mappings":";;AAAA,4CAcC;AAdD,SAAgB,gBAAgB,CAAiB,GAAY;IACzD,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,IAAI,EAAE,CAAC;QAC1C,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,+DAA+D;IAC/D,MAAM,MAAM,GAAG,GAAiC,CAAC;IAEjD,6DAA6D;IAC7D,OAAO,CACH,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;QACtC,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU;QACnC,OAAO,MAAM,CAAC,GAAG,KAAK,UAAU,CACnC,CAAC;AACN,CAAC"}

package/dist/esm/clients/classlink.d.ts

@@ -0,0 +1,39 @@
+/**
+ * ClassLink OneRoster Client
+ *
+ * A pre-configured OneRoster client for ClassLink integration.
+ * This client is typed with IClassLinkProfile, which restricts
+ * available methods to read-only operations that ClassLink supports.
+ */
+import type { SDKOptions } from '../lib/config.js';
+import { OneRoster } from '../sdk/sdk.js';
+import type { IClassLinkProfile } from './profiles.js';
+/**
+ * ClassLink OneRoster client - read-only access.
+ *
+ * ClassLink provides rostering data but does not support write operations.
+ * This class is typed to only expose the methods that ClassLink supports.
+ *
+ * @example
+ * ```typescript
+ * import { ClassLink } from '@eduware/oneroster/clients';
+ *
+ * const client = new ClassLink({
+ *   serverURL: 'https://example.classlink.com',
+ *   security: {
+ *     authType: 'oauth2',
+ *     clientID: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *     tokenURL: 'https://example.classlink.com/oauth/token'
+ *   }
+ * });
+ *
+ * // Read operations work
+ * const users = await client.usersManagement.getAllUsers({});
+ *
+ * // Write operations are not available (TypeScript error)
+ * // client.usersManagement.createUser({});  // Error!
+ * ```
+ */
+export declare const ClassLink: new (options: SDKOptions) => OneRoster & IClassLinkProfile;
+//# sourceMappingURL=classlink.d.ts.map

package/dist/esm/clients/classlink.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"classlink.d.ts","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AACnD,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,SAAS,EAAE,KAAK,OAAO,EAAE,UAAU,KAAK,SAAS,GAAG,iBAC7C,CAAC"}

package/dist/esm/clients/classlink.js

@@ -0,0 +1,37 @@
+/**
+ * ClassLink OneRoster Client
+ *
+ * A pre-configured OneRoster client for ClassLink integration.
+ * This client is typed with IClassLinkProfile, which restricts
+ * available methods to read-only operations that ClassLink supports.
+ */
+import { OneRoster } from '../sdk/sdk.js';
+/**
+ * ClassLink OneRoster client - read-only access.
+ *
+ * ClassLink provides rostering data but does not support write operations.
+ * This class is typed to only expose the methods that ClassLink supports.
+ *
+ * @example
+ * ```typescript
+ * import { ClassLink } from '@eduware/oneroster/clients';
+ *
+ * const client = new ClassLink({
+ *   serverURL: 'https://example.classlink.com',
+ *   security: {
+ *     authType: 'oauth2',
+ *     clientID: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *     tokenURL: 'https://example.classlink.com/oauth/token'
+ *   }
+ * });
+ *
+ * // Read operations work
+ * const users = await client.usersManagement.getAllUsers({});
+ *
+ * // Write operations are not available (TypeScript error)
+ * // client.usersManagement.createUser({});  // Error!
+ * ```
+ */
+export const ClassLink = OneRoster;
+//# sourceMappingURL=classlink.js.map

package/dist/esm/clients/classlink.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"classlink.js","sourceRoot":"","sources":["../../../src/clients/classlink.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAG1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,SAAS,GAClB,SAAgB,CAAC"}

package/dist/esm/clients/index.d.ts

@@ -0,0 +1,45 @@
+/**
+ * OneRoster Client Profiles and Type Aliases
+ *
+ * This module provides LMS-specific profile interfaces, typed client aliases,
+ * and pre-configured client classes for different OneRoster providers.
+ *
+ * ## Pre-built Profiles
+ *
+ * - `IFullProfile` - All methods available (default)
+ * - `IClassLinkProfile` - Read-only access for ClassLink
+ *
+ * ## Client Classes
+ *
+ * - `ClassLink` - Pre-configured client class for ClassLink (read-only)
+ *
+ * ## Client Type Aliases
+ *
+ * - `FullClient` - Client with all capabilities
+ * - `ClassLinkClient` - OneRoster client typed for ClassLink
+ *
+ * ## Custom Profiles
+ *
+ * You can create your own custom profiles by defining an interface that
+ * uses `Pick<>` to select specific methods from each management class:
+ *
+ * ```typescript
+ * import type { UsersManagement, ClassesManagement } from '@eduware/oneroster/sdk';
+ * import type { OneRosterClient } from '@eduware/oneroster/clients';
+ *
+ * interface IMyCustomProfile {
+ *   usersManagement: Pick<UsersManagement, 'getAllUsers' | 'getUser'>;
+ *   classesManagement: Pick<ClassesManagement, 'getAllClasses' | 'getClass'>;
+ * }
+ *
+ * type MyCustomClient = OneRosterClient<IMyCustomProfile>;
+ *
+ * const client: MyCustomClient = new OneRoster({...});
+ * ```
+ *
+ * @module clients
+ */
+export { ClassLink } from './classlink.js';
+export type { IClassLinkProfile, IFullProfile } from './profiles.js';
+export type { ClassLinkClient, FullClient, OneRosterClient } from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/esm/clients/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAGH,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAG3C,YAAY,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAGrE,YAAY,EAAE,eAAe,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC"}

package/dist/esm/clients/index.js

@@ -0,0 +1,44 @@
+/**
+ * OneRoster Client Profiles and Type Aliases
+ *
+ * This module provides LMS-specific profile interfaces, typed client aliases,
+ * and pre-configured client classes for different OneRoster providers.
+ *
+ * ## Pre-built Profiles
+ *
+ * - `IFullProfile` - All methods available (default)
+ * - `IClassLinkProfile` - Read-only access for ClassLink
+ *
+ * ## Client Classes
+ *
+ * - `ClassLink` - Pre-configured client class for ClassLink (read-only)
+ *
+ * ## Client Type Aliases
+ *
+ * - `FullClient` - Client with all capabilities
+ * - `ClassLinkClient` - OneRoster client typed for ClassLink
+ *
+ * ## Custom Profiles
+ *
+ * You can create your own custom profiles by defining an interface that
+ * uses `Pick<>` to select specific methods from each management class:
+ *
+ * ```typescript
+ * import type { UsersManagement, ClassesManagement } from '@eduware/oneroster/sdk';
+ * import type { OneRosterClient } from '@eduware/oneroster/clients';
+ *
+ * interface IMyCustomProfile {
+ *   usersManagement: Pick<UsersManagement, 'getAllUsers' | 'getUser'>;
+ *   classesManagement: Pick<ClassesManagement, 'getAllClasses' | 'getClass'>;
+ * }
+ *
+ * type MyCustomClient = OneRosterClient<IMyCustomProfile>;
+ *
+ * const client: MyCustomClient = new OneRoster({...});
+ * ```
+ *
+ * @module clients
+ */
+// Client classes
+export { ClassLink } from './classlink.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/clients/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/clients/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,iBAAiB;AACjB,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC"}

package/dist/esm/clients/profiles.d.ts

@@ -0,0 +1,101 @@
+/**
+ * OneRoster LMS Profile Interfaces
+ *
+ * These interfaces define which methods are available for different LMS providers.
+ * Use Pick<> at the method level to constrain which operations are available.
+ *
+ * Available Profiles:
+ * - `IFullProfile` - Full access to all OneRoster methods (default)
+ * - `IClassLinkProfile` - Read-only access for ClassLink integration
+ *
+ * Users can also define their own custom profiles by creating interfaces that
+ * follow the same pattern.
+ */
+import type { AcademicSessionsManagement } from '../sdk/academicsessionsmanagement.js';
+import type { AssessmentLineItemsManagement } from '../sdk/assessmentlineitemsmanagement.js';
+import type { AssessmentResultsManagement } from '../sdk/assessmentresultsmanagement.js';
+import type { CategoriesManagement } from '../sdk/categoriesmanagement.js';
+import type { ClassesManagement } from '../sdk/classesmanagement.js';
+import type { CourseComponentResourcesManagement } from '../sdk/coursecomponentresourcesmanagement.js';
+import type { CourseComponentsManagement } from '../sdk/coursecomponentsmanagement.js';
+import type { CoursesManagement } from '../sdk/coursesmanagement.js';
+import type { DemographicsManagement } from '../sdk/demographicsmanagement.js';
+import type { EnrollmentsManagement } from '../sdk/enrollmentsmanagement.js';
+import type { GradingPeriodsManagement } from '../sdk/gradingperiodsmanagement.js';
+import type { LineItemsManagement } from '../sdk/lineitemsmanagement.js';
+import type { OrganizationsManagement } from '../sdk/organizationsmanagement.js';
+import type { ResourcesManagement } from '../sdk/resourcesmanagement.js';
+import type { ResultsManagement } from '../sdk/resultsmanagement.js';
+import type { SchoolsManagement } from '../sdk/schoolsmanagement.js';
+import type { ScoreScalesManagement } from '../sdk/scorescalesmanagement.js';
+import type { StudentsManagement } from '../sdk/studentsmanagement.js';
+import type { TeachersManagement } from '../sdk/teachersmanagement.js';
+import type { TermsManagement } from '../sdk/termsmanagement.js';
+import type { UsersManagement } from '../sdk/usersmanagement.js';
+/**
+ * Full OneRoster profile with all methods available.
+ * This is the default when using OneRoster without a profile constraint.
+ */
+export interface IFullProfile {
+    academicSessionsManagement: AcademicSessionsManagement;
+    assessmentLineItemsManagement: AssessmentLineItemsManagement;
+    assessmentResultsManagement: AssessmentResultsManagement;
+    categoriesManagement: CategoriesManagement;
+    classesManagement: ClassesManagement;
+    courseComponentResourcesManagement: CourseComponentResourcesManagement;
+    courseComponentsManagement: CourseComponentsManagement;
+    coursesManagement: CoursesManagement;
+    demographicsManagement: DemographicsManagement;
+    enrollmentsManagement: EnrollmentsManagement;
+    gradingPeriodsManagement: GradingPeriodsManagement;
+    lineItemsManagement: LineItemsManagement;
+    organizationsManagement: OrganizationsManagement;
+    resourcesManagement: ResourcesManagement;
+    resultsManagement: ResultsManagement;
+    schoolsManagement: SchoolsManagement;
+    scoreScalesManagement: ScoreScalesManagement;
+    studentsManagement: StudentsManagement;
+    teachersManagement: TeachersManagement;
+    termsManagement: TermsManagement;
+    usersManagement: UsersManagement;
+}
+/**
+ * ClassLink OneRoster profile - read-only rostering access.
+ *
+ * ClassLink provides rostering data but does not support write operations.
+ * This profile matches exactly what ClassLink's OneRoster v1.1 API provides.
+ *
+ * ClassLink does NOT support:
+ * - Demographics
+ * - Line Items / Results / Categories / Score Scales (gradebook)
+ * - Course Components / Component Resources
+ * - Any create/update/delete operations
+ *
+ * Supported endpoints:
+ * - Academic Sessions: getAll, get
+ * - Classes: getAll, get, getStudentsForClass, getTeachersForClass
+ * - Courses: getAll, get, getClassesForCourse
+ * - Enrollments: getAll, get
+ * - Grading Periods: getAll, get
+ * - Orgs: getAll, get
+ * - Schools: getAll, get, getClasses, getCourses, getEnrollments, getStudents, getTeachers, getTerms,
+ *            getEnrollmentsForClass, getStudentsForClass, getTeachersForClass
+ * - Students: getAll, get, getClassesForStudent
+ * - Teachers: getAll, get, getClassesForTeacher
+ * - Terms: getAll, get, getClassesForTerm, getGradingPeriodsForTerm
+ * - Users: getAll, get, getClassesForUser
+ */
+export interface IClassLinkProfile {
+    academicSessionsManagement: Pick<AcademicSessionsManagement, 'getAllAcademicSessions' | 'getAcademicSession'>;
+    classesManagement: Pick<ClassesManagement, 'getAllClasses' | 'getClass' | 'getStudentsForClass' | 'getTeachersForClass' | 'getClassesForSchool' | 'getClassesForUser' | 'getClassesForTerm' | 'getClassesForTeacher' | 'getClassesForStudent'>;
+    coursesManagement: Pick<CoursesManagement, 'getAllCourses' | 'getCourse' | 'getClassesForCourse' | 'getCoursesForSchool'>;
+    enrollmentsManagement: Pick<EnrollmentsManagement, 'getAllEnrollments' | 'getEnrollment' | 'getEnrollmentsForClassInSchool' | 'getEnrollmentsForSchool'>;
+    gradingPeriodsManagement: Pick<GradingPeriodsManagement, 'getAllGradingPeriods' | 'getGradingPeriod'>;
+    organizationsManagement: Pick<OrganizationsManagement, 'getAllOrgs' | 'getOrg'>;
+    schoolsManagement: Pick<SchoolsManagement, 'getAllSchools' | 'getSchool' | 'getClassesForSchool' | 'getCoursesForSchool' | 'getEnrollmentsForSchool' | 'getEnrollmentsForClassInSchool' | 'getStudentsForSchool' | 'getStudentsForClassInSchool' | 'getTeachersForSchool' | 'getTeachersForClassInSchool' | 'getTermsForSchool'>;
+    studentsManagement: Pick<StudentsManagement, 'getAllStudents' | 'getStudent' | 'getStudentsForClass' | 'getStudentsForSchool' | 'getStudentsForClassInSchool' | 'getClassesForStudent'>;
+    teachersManagement: Pick<TeachersManagement, 'getAllTeachers' | 'getTeacher' | 'getTeachersForClass' | 'getTeachersForSchool' | 'getTeachersForClassInSchool' | 'getClassesForTeacher'>;
+    termsManagement: Pick<TermsManagement, 'getAllTerms' | 'getTerm' | 'getTermsForSchool' | 'getClassesForTerm' | 'getGradingPeriodsForTerm'>;
+    usersManagement: Pick<UsersManagement, 'getAllUsers' | 'getUser' | 'getClassesForUser'>;
+}
+//# sourceMappingURL=profiles.d.ts.map

package/dist/esm/clients/profiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.d.ts","sourceRoot":"","sources":["../../../src/clients/profiles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,yCAAyC,CAAC;AAC7F,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,uCAAuC,CAAC;AACzF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAC;AAC3E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,8CAA8C,CAAC;AACvG,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,sCAAsC,CAAC;AACvF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAC;AAC/E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AACnF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,mCAAmC,CAAC;AACjF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,6BAA6B,CAAC;AACrE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAC7E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AACvE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AACjE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAMjE;;;GAGG;AACH,MAAM,WAAW,YAAY;IACzB,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,6BAA6B,EAAE,6BAA6B,CAAC;IAC7D,2BAA2B,EAAE,2BAA2B,CAAC;IACzD,oBAAoB,EAAE,oBAAoB,CAAC;IAC3C,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,kCAAkC,EAAE,kCAAkC,CAAC;IACvE,0BAA0B,EAAE,0BAA0B,CAAC;IACvD,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,sBAAsB,EAAE,sBAAsB,CAAC;IAC/C,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,wBAAwB,EAAE,wBAAwB,CAAC;IACnD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,uBAAuB,EAAE,uBAAuB,CAAC;IACjD,mBAAmB,EAAE,mBAAmB,CAAC;IACzC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,iBAAiB,EAAE,iBAAiB,CAAC;IACrC,qBAAqB,EAAE,qBAAqB,CAAC;IAC7C,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,kBAAkB,EAAE,kBAAkB,CAAC;IACvC,eAAe,EAAE,eAAe,CAAC;IACjC,eAAe,EAAE,eAAe,CAAC;CACpC;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,iBAAiB;IAE9B,0BAA0B,EAAE,IAAI,CAC5B,0BAA0B,EAC1B,wBAAwB,GAAG,oBAAoB,CAClD,CAAC;IAGF,iBAAiB,EAAE,IAAI,CACnB,iBAAiB,EACf,eAAe,GACf,UAAU,GACV,qBAAqB,GACrB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,sBAAsB,CAC3B,CAAC;IAGF,iBAAiB,EAAE,IAAI,CACnB,iBAAiB,EACjB,eAAe,GAAG,WAAW,GAAG,qBAAqB,GAAG,qBAAqB,CAChF,CAAC;IAGF,qBAAqB,EAAE,IAAI,CACvB,qBAAqB,EACnB,mBAAmB,GACnB,eAAe,GACf,gCAAgC,GAChC,yBAAyB,CAC9B,CAAC;IAGF,wBAAwB,EAAE,IAAI,CAC1B,wBAAwB,EACxB,sBAAsB,GAAG,kBAAkB,CAC9C,CAAC;IAGF,uBAAuB,EAAE,IAAI,CAAC,uBAAuB,EAAE,YAAY,GAAG,QAAQ,CAAC,CAAC;IAGhF,iBAAiB,EAAE,IAAI,CACnB,iBAAiB,EACf,eAAe,GACf,WAAW,GACX,qBAAqB,GACrB,qBAAqB,GACrB,yBAAyB,GACzB,gCAAgC,GAChC,sBAAsB,GACtB,6BAA6B,GAC7B,sBAAsB,GACtB,6BAA6B,GAC7B,mBAAmB,CACxB,CAAC;IAGF,kBAAkB,EAAE,IAAI,CACpB,kBAAkB,EAChB,gBAAgB,GAChB,YAAY,GACZ,qBAAqB,GACrB,sBAAsB,GACtB,6BAA6B,GAC7B,sBAAsB,CAC3B,CAAC;IAGF,kBAAkB,EAAE,IAAI,CACpB,kBAAkB,EAChB,gBAAgB,GAChB,YAAY,GACZ,qBAAqB,GACrB,sBAAsB,GACtB,6BAA6B,GAC7B,sBAAsB,CAC3B,CAAC;IAGF,eAAe,EAAE,IAAI,CACjB,eAAe,EACb,aAAa,GACb,SAAS,GACT,mBAAmB,GACnB,mBAAmB,GACnB,0BAA0B,CAC/B,CAAC;IAGF,eAAe,EAAE,IAAI,CAAC,eAAe,EAAE,aAAa,GAAG,SAAS,GAAG,mBAAmB,CAAC,CAAC;CAC3F"}

package/dist/esm/clients/profiles.js

@@ -0,0 +1,15 @@
+/**
+ * OneRoster LMS Profile Interfaces
+ *
+ * These interfaces define which methods are available for different LMS providers.
+ * Use Pick<> at the method level to constrain which operations are available.
+ *
+ * Available Profiles:
+ * - `IFullProfile` - Full access to all OneRoster methods (default)
+ * - `IClassLinkProfile` - Read-only access for ClassLink integration
+ *
+ * Users can also define their own custom profiles by creating interfaces that
+ * follow the same pattern.
+ */
+export {};
+//# sourceMappingURL=profiles.js.map

package/dist/esm/clients/profiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.js","sourceRoot":"","sources":["../../../src/clients/profiles.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG"}

package/dist/esm/clients/types.d.ts

@@ -0,0 +1,79 @@
+/**
+ * OneRoster Client Type Aliases
+ *
+ * These type aliases provide typed OneRoster clients for specific LMS providers.
+ * They use TypeScript's type system to constrain which methods are available
+ * based on the provider's capabilities.
+ *
+ * Usage:
+ * ```typescript
+ * import { OneRoster } from '@eduware/oneroster';
+ * import type { ClassLinkClient, IClassLinkProfile } from '@eduware/oneroster/clients';
+ *
+ * // Option 1: Use the type alias directly
+ * const client: ClassLinkClient = new OneRoster({
+ *   serverURL: 'https://example.classlink.com',
+ *   security: { ... }
+ * });
+ *
+ * // Option 2: Use the generic with the profile interface
+ * const client = new OneRoster({...}) as OneRoster & IClassLinkProfile;
+ *
+ * // Now TypeScript will only allow read methods
+ * await client.usersManagement.getAllUsers({}); // ✓ OK
+ * await client.usersManagement.createUser({});  // ✗ Type error - not available
+ * ```
+ */
+import type { OneRoster } from '../sdk/sdk.js';
+import type { IClassLinkProfile, IFullProfile } from './profiles.js';
+/**
+ * Full OneRoster client with all capabilities.
+ * This is equivalent to using OneRoster directly without any profile constraint.
+ */
+export type FullClient = OneRoster & IFullProfile;
+/**
+ * ClassLink OneRoster client - read-only access.
+ *
+ * ClassLink provides rostering data but does not support write operations.
+ * Use this type when connecting to ClassLink's OneRoster API.
+ *
+ * @example
+ * ```typescript
+ * const client: ClassLinkClient = new OneRoster({
+ *   serverURL: 'https://example.classlink.com',
+ *   security: {
+ *     authType: 'oauth2',
+ *     clientID: 'your-client-id',
+ *     clientSecret: 'your-client-secret',
+ *     tokenURL: 'https://example.classlink.com/oauth/token'
+ *   }
+ * });
+ *
+ * // Read operations work
+ * const users = await client.usersManagement.getAllUsers({});
+ * const schools = await client.schoolsManagement.getAllSchools({});
+ *
+ * // Write operations are not available (TypeScript error)
+ * // client.usersManagement.createUser({});  // Error!
+ * ```
+ */
+export type ClassLinkClient = OneRoster & IClassLinkProfile;
+/**
+ * Helper type to create a custom OneRoster client with a specific profile.
+ *
+ * @example
+ * ```typescript
+ * // Define your custom profile
+ * interface IMyCustomProfile {
+ *   usersManagement: Pick<UsersManagement, 'getAllUsers' | 'getUser'>;
+ *   classesManagement: Pick<ClassesManagement, 'getAllClasses'>;
+ * }
+ *
+ * // Create a typed client
+ * type MyCustomClient = OneRosterClient<IMyCustomProfile>;
+ *
+ * const client: MyCustomClient = new OneRoster({...});
+ * ```
+ */
+export type OneRosterClient<TProfile> = OneRoster & TProfile;
+//# sourceMappingURL=types.d.ts.map

package/dist/esm/clients/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAMrE;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,SAAS,GAAG,YAAY,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,MAAM,eAAe,GAAG,SAAS,GAAG,iBAAiB,CAAC;AAM5D;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,eAAe,CAAC,QAAQ,IAAI,SAAS,GAAG,QAAQ,CAAC"}

package/dist/esm/clients/types.js

@@ -0,0 +1,28 @@
+/**
+ * OneRoster Client Type Aliases
+ *
+ * These type aliases provide typed OneRoster clients for specific LMS providers.
+ * They use TypeScript's type system to constrain which methods are available
+ * based on the provider's capabilities.
+ *
+ * Usage:
+ * ```typescript
+ * import { OneRoster } from '@eduware/oneroster';
+ * import type { ClassLinkClient, IClassLinkProfile } from '@eduware/oneroster/clients';
+ *
+ * // Option 1: Use the type alias directly
+ * const client: ClassLinkClient = new OneRoster({
+ *   serverURL: 'https://example.classlink.com',
+ *   security: { ... }
+ * });
+ *
+ * // Option 2: Use the generic with the profile interface
+ * const client = new OneRoster({...}) as OneRoster & IClassLinkProfile;
+ *
+ * // Now TypeScript will only allow read methods
+ * await client.usersManagement.getAllUsers({}); // ✓ OK
+ * await client.usersManagement.createUser({});  // ✗ Type error - not available
+ * ```
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/esm/clients/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/clients/types.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG"}

package/dist/esm/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from './lib/sdks.js';
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class OneRosterCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/dist/esm/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,SAAS;CAAG"}

package/dist/esm/core.js

@@ -0,0 +1,10 @@
+import { ClientSDK } from './lib/sdks.js';
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export class OneRosterCore extends ClientSDK {
+}
+//# sourceMappingURL=core.js.map

package/dist/esm/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,MAAM,OAAO,aAAc,SAAQ,SAAS;CAAG"}