@eduware/oneroster 1.2.4 → 1.2.5

package/README.md

@@ -66,7 +66,7 @@ const client = new OneRoster({
 const result = await client.usersManagement.getAllUsers({});
 
 for await (const page of result) {
-    console.log(page.users);
+    console.log(page.result.users);
 }
 ```
 
@@ -391,7 +391,7 @@ const result = await client.usersManagement.getAllUsers({
 
 // Iterate through all pages automatically
 for await (const page of result) {
-    for (const user of page.users ?? []) {
+    for (const user of page.result.users ?? []) {
         console.log(user.givenName, user.familyName);
     }
 }
@@ -404,17 +404,10 @@ The OneRoster API returns the total number of records in the `X-Total-Count` HTT
 ```typescript
 const result = await client.usersManagement.getAllUsers({});
 
-// Access total count from the first page
-if (result.ok) {
-    console.log(`Total users: ${result.value.totalCount}`);
-}
-
 // Or during iteration
 for await (const page of result) {
-    if (page.ok) {
-        console.log(`Page has ${page.value.users?.length ?? 0} users`);
-        console.log(`Total: ${page.totalCount}`);
-    }
+    console.log(`Page has ${page.result.users?.length ?? 0} users`);
+    console.log(`Total: ${page.totalCount}`);
 }
 ```
 
@@ -447,9 +440,15 @@ const partialUsers = await client.usersManagement.getAllUsers({
 
 ## Error Handling
 
+Error classes are exported directly from the main package for convenience:
+
 ```typescript
-import { OneRoster } from '@eduware/oneroster';
-import * as errors from '@eduware/oneroster/models/errors';
+import {
+    OneRoster,
+    OneRosterError,
+    NotFoundResponseError,
+    UnauthorizedRequestResponseError,
+} from '@eduware/oneroster';
 
 const client = new OneRoster({
     /* ... */
@@ -460,17 +459,29 @@ try {
         sourcedId: 'non-existent-id',
     });
 } catch (error) {
-    if (error instanceof errors.NotFoundResponseError) {
+    if (error instanceof NotFoundResponseError) {
         console.log('User not found');
-    } else if (error instanceof errors.UnauthorizedRequestResponseError) {
+    } else if (error instanceof UnauthorizedRequestResponseError) {
         console.log('Authentication failed');
-    } else if (error instanceof errors.OneRosterError) {
+    } else if (error instanceof OneRosterError) {
         // Base class for all HTTP errors
         console.log('HTTP Error:', error.statusCode, error.message);
     }
 }
 ```
 
+You can also import all errors as a namespace:
+
+```typescript
+import { OneRoster, errors } from '@eduware/oneroster';
+// Or from the dedicated subpath
+import * as errors from '@eduware/oneroster/models/errors';
+
+if (error instanceof errors.NotFoundResponseError) {
+    // ...
+}
+```
+
 ### Error Classes
 
 | Error                              | Status Code | Description                |
@@ -502,7 +513,7 @@ const result = await usersManagementGetAllUsers(client, {});
 
 if (result.ok) {
     for await (const page of result.value) {
-        console.log(page.users);
+        console.log(page.result.users);
     }
 } else {
     console.error('Error:', result.error);