@eduware/oneroster 1.0.0 → 1.1.0

package/src/funcs/schoolsManagementGetLineItemsForSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/schoolsManagementGetStudentsForClassInSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -178,6 +179,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -277,7 +281,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/schoolsManagementGetStudentsForSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/schoolsManagementGetTeachersForClassInSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -178,6 +179,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -277,7 +281,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/schoolsManagementGetTeachersForSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/schoolsManagementGetTermsForSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/scoreScalesManagementGetAllScoreScales.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -165,6 +166,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -264,7 +268,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/scoreScalesManagementGetScoreScalesForSchool.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/studentsManagementGetAllStudents.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -165,6 +166,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -264,7 +268,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/teachersManagementGetAllTeachers.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -165,6 +166,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -264,7 +268,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/termsManagementGetAllTerms.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -165,6 +166,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -264,7 +268,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/termsManagementGetGradingPeriodsForTerm.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery, encodeSimple } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -174,6 +175,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -273,7 +277,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/funcs/usersManagementGetAllUsers.ts

@@ -2,6 +2,7 @@ import { OneRosterCore } from '../core.js';
 import { dlv } from '../lib/dlv.js';
 import { encodeFormQuery } from '../lib/encodings.js';
 import * as M from '../lib/matchers.js';
+import { extractPaginationMeta } from '../lib/pagination.js';
 import { compactMap } from '../lib/primitives.js';
 import { safeParse } from '../lib/schemas.js';
 import { RequestOptions } from '../lib/sdks.js';
@@ -165,6 +166,9 @@ async function $do(
     }
     const response = doResult.value;
 
+    // Extract pagination metadata from headers
+    const paginationMeta = extractPaginationMeta(response);
+
     const responseFields = {
         HttpMeta: { Response: response, Request: req },
     };
@@ -264,7 +268,7 @@ async function $do(
         return { next: nextVal, '~next': { offset: nextOffset } };
     };
 
-    const page = { ...result, ...nextFunc(raw) };
+    const page = { ...result, ...nextFunc(raw), ...paginationMeta };
     return [
         { ...page, ...createPageIterator(page, (v) => !v.ok) },
         {

package/src/lib/pagination.ts

@@ -0,0 +1,26 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+/**
+ * Pagination metadata extracted from HTTP response headers.
+ */
+export type PaginationMeta = {
+    totalCount?: number | undefined;
+};
+
+/**
+ * Extracts pagination metadata from HTTP response headers.
+ *
+ * The OneRoster API returns the total count of records in the X-Total-Count header.
+ * This function extracts that value for use in paginated responses.
+ *
+ * @param response - The HTTP Response object containing headers
+ * @returns An object containing the totalCount if present, undefined otherwise
+ */
+export function extractPaginationMeta(response: Response): PaginationMeta {
+    const totalCountHeader = response.headers.get('X-Total-Count');
+    return {
+        totalCount: totalCountHeader ? parseInt(totalCountHeader, 10) : undefined,
+    };
+}

package/src/types/operations.ts

@@ -1,18 +1,20 @@
+import { PaginationMeta } from '../lib/pagination.js';
 import { Result } from './fp.js';
 
-export type Paginator<V> = () => Promise<V & { next: Paginator<V> }> | null;
+export type Paginator<V> = () => Promise<V & PaginationMeta & { next: Paginator<V> }> | null;
 
-export type PageIterator<V, PageState = unknown> = V & {
-    next: Paginator<V>;
-    [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
-    '~next'?: PageState | undefined;
-};
+export type PageIterator<V, PageState = unknown> = V &
+    PaginationMeta & {
+        next: Paginator<V>;
+        [Symbol.asyncIterator]: () => AsyncIterableIterator<V & PaginationMeta>;
+        '~next'?: PageState | undefined;
+    };
 
 export function createPageIterator<V>(
-    page: V & { next: Paginator<V> },
+    page: V & PaginationMeta & { next: Paginator<V> },
     halt: (v: V) => boolean
 ): {
-    [Symbol.asyncIterator]: () => AsyncIterableIterator<V>;
+    [Symbol.asyncIterator]: () => AsyncIterableIterator<V & PaginationMeta>;
 } {
     return {
         [Symbol.asyncIterator]: async function* paginator() {
@@ -42,9 +44,9 @@ export function haltIterator<V extends object>(v: V): PageIterator<V, undefined>
         ...v,
         next: () => null,
         [Symbol.asyncIterator]: async function* paginator() {
-            yield v;
+            yield v as V & PaginationMeta;
         },
-    };
+    } as PageIterator<V, undefined>;
 }
 
 /**
@@ -60,22 +62,32 @@ export async function unwrapResultIterator<V, PageState>(
         throw resultIter.error;
     }
 
+    // Preserve pagination metadata from the result iterator
+    const paginationMeta: PaginationMeta = {
+        totalCount: resultIter.totalCount,
+    };
+
     return {
         ...resultIter.value,
-        next: unwrapPaginator(resultIter.next),
+        ...paginationMeta,
+        next: unwrapPaginator(resultIter.next, paginationMeta),
         '~next': resultIter['~next'],
         [Symbol.asyncIterator]: async function* paginator() {
             for await (const page of resultIter) {
                 if (!page.ok) {
                     throw page.error;
                 }
-                yield page.value;
+                // Include pagination metadata in yielded values
+                yield { ...page.value, totalCount: page.totalCount } as V & PaginationMeta;
             }
         },
-    };
+    } as PageIterator<V, PageState>;
 }
 
-function unwrapPaginator<V>(paginator: Paginator<Result<V, unknown>>): Paginator<V> {
+function unwrapPaginator<V>(
+    paginator: Paginator<Result<V, unknown>>,
+    inheritedMeta?: PaginationMeta
+): Paginator<V> {
     return () => {
         const nextResult = paginator();
         if (nextResult == null) {
@@ -85,11 +97,16 @@ function unwrapPaginator<V>(paginator: Paginator<Result<V, unknown>>): Paginator
             if (!res.ok) {
                 throw res.error;
             }
+            // Preserve pagination metadata from each page
+            const pageMeta: PaginationMeta = {
+                totalCount: res.totalCount ?? inheritedMeta?.totalCount,
+            };
             const out = {
                 ...res.value,
-                next: unwrapPaginator(res.next),
+                ...pageMeta,
+                next: unwrapPaginator(res.next, pageMeta),
             };
-            return out;
+            return out as V & PaginationMeta & { next: Paginator<V> };
         });
     };
 }