@eduware/oneroster 1.0.0 → 1.0.1

package/README.md

@@ -3,17 +3,29 @@
 Type-safe TypeScript SDK for the OneRoster API with LMS-specific client profiles.
 
 <div align="left">
+    <a href="https://www.npmjs.com/package/@eduware/oneroster">
+        <img src="https://img.shields.io/npm/v/@eduware/oneroster.svg" alt="npm version" />
+    </a>
+    <a href="https://www.npmjs.com/package/@eduware/oneroster">
+        <img src="https://img.shields.io/npm/dm/@eduware/oneroster.svg" alt="npm downloads" />
+    </a>
     <a href="https://opensource.org/licenses/MIT">
-        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" />
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/badge/OneRoster-v1.1%20%7C%20v1.2-green.svg" alt="OneRoster v1.1 | v1.2" />
+    </a>
+    <a href="#">
+        <img src="https://img.shields.io/badge/TypeScript-5.0+-blue.svg" alt="TypeScript 5.0+" />
     </a>
 </div>
 
 ## Features
 
-- **Full OneRoster v1.2 API support** - Complete implementation of the 1EdTech OneRoster specification
+- **OneRoster v1.1 & v1.2 support** - Complete implementation of both 1EdTech OneRoster specifications
 - **LMS-specific profiles** - Pre-built profiles for ClassLink with type-safe method restrictions
 - **Custom profiles** - Create your own profiles using TypeScript's `Pick<>` types
-- **OAuth 2.0 & OAuth 1.0a authentication** - Support for both authentication methods
+- **OAuth 2.0 & OAuth 1.0a authentication** - OAuth 2.0 for v1.2 (default), OAuth 1.0a for v1.1
 - **Automatic pagination** - Async iterables for seamless data fetching
 - **TypeScript-first** - Full type safety with comprehensive type definitions
 - **Tree-shakeable** - Standalone functions for optimal bundle sizes
@@ -153,9 +165,51 @@ const users = await client.usersManagement.getAllUsers({});
 // client.usersManagement.createUser({});  // TypeScript error!
 ```
 
+## OneRoster Versions
+
+The SDK supports both OneRoster v1.1 and v1.2 specifications. The default is v1.2.
+
+### Version 1.2 (Default)
+
+OneRoster v1.2 uses OAuth 2.0 authentication and the `/ims/oneroster/rostering/v1p2/` path format:
+
+```typescript
+import { OneRoster } from '@eduware/oneroster';
+
+const client = new OneRoster({
+    serverURL: 'https://your-server.com',
+    // oneRosterVersion defaults to '1.2'
+    security: {
+        clientID: process.env.ONEROSTER_CLIENT_ID!,
+        clientSecret: process.env.ONEROSTER_CLIENT_SECRET!,
+        tokenURL: 'https://your-server.com/oauth/token',
+    },
+});
+```
+
+### Version 1.1
+
+OneRoster v1.1 uses OAuth 1.0a authentication and the `/ims/oneroster/v1p1/` path format:
+
+```typescript
+import { OneRoster } from '@eduware/oneroster';
+
+const client = new OneRoster({
+    serverURL: 'https://your-server.com',
+    oneRosterVersion: '1.1',
+    security: {
+        authType: 'oauth1',
+        clientID: process.env.ONEROSTER_CLIENT_ID!,
+        clientSecret: process.env.ONEROSTER_CLIENT_SECRET!,
+    },
+});
+```
+
+> **Note:** OAuth 1.0a is only supported in OneRoster v1.1. Per the 1EdTech specification, v1.2 requires OAuth 2.0.
+
 ## Authentication
 
-### OAuth 2.0 (Default)
+### OAuth 2.0 (Default for v1.2)
 
 ```typescript
 import { OneRoster } from '@eduware/oneroster';
@@ -176,6 +230,22 @@ You can also use environment variables:
 - `ONEROSTER_CLIENT_SECRET`
 - `ONEROSTER_TOKEN_URL`
 
+### OAuth 1.0a (v1.1 only)
+
+```typescript
+import { OneRoster } from '@eduware/oneroster';
+
+const client = new OneRoster({
+    serverURL: 'https://your-server.com',
+    oneRosterVersion: '1.1',
+    security: {
+        authType: 'oauth1',
+        clientID: process.env.ONEROSTER_CLIENT_ID!,
+        clientSecret: process.env.ONEROSTER_CLIENT_SECRET!,
+    },
+});
+```
+
 ### Bearer Token
 
 If you already have a token:
@@ -186,7 +256,8 @@ import { OneRoster } from '@eduware/oneroster';
 const client = new OneRoster({
     serverURL: 'https://your-server.com',
     security: {
-        bearer: 'your-access-token',
+        authType: 'bearer',
+        bearerToken: 'your-access-token',
     },
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@eduware/oneroster",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "author": "Eduware",
     "type": "module",
     "tshy": {