@rvoh/psychic 2.2.1 → 2.3.1

package/dist/cjs/src/controller/index.js

@@ -557,14 +557,10 @@ export default class PsychicController {
             return data.map(d => this.singleObjectJson(d, opts));
             //
         }
-        else if (this.currentOpenapiRenderer?.['paginate'] && Array.isArray(paginatedResults)) {
-            return {
-                ...data,
-                results: paginatedResults.map(result => this.singleObjectJson(result, opts)),
-            };
-            //
-        }
-        else if (this.currentOpenapiRenderer?.['scrollPaginate'] && Array.isArray(paginatedResults)) {
+        else if ((this.currentOpenapiRenderer?.['paginate'] ||
+            this.currentOpenapiRenderer?.['cursorPaginate'] ||
+            this.currentOpenapiRenderer?.['scrollPaginate']) &&
+            Array.isArray(paginatedResults)) {
             return {
                 ...data,
                 results: paginatedResults.map(result => this.singleObjectJson(result, opts)),

package/dist/cjs/src/generate/helpers/generateControllerContent.js

@@ -57,14 +57,13 @@ export default function generateControllerContent({ ancestorName, ancestorImport
     status: 200,
     tags: openApiTags,
     description: 'Paginated index of ${pluralize(modelClassName)}',
-    scrollPaginate: true,
+    cursorPaginate: true,
     serializerKey: '${forAdmin ? 'adminSummary' : 'summary'}',
   })
   public async index() {
     // const ${pluralizedModelAttributeName} = await ${loadQueryBase}
     //   .preloadFor('${forAdmin ? 'adminSummary' : 'summary'}')
-    //   .order({ createdAt: 'desc' })
-    //   .scrollPaginate({ cursor: this.castParam('cursor', 'string', { allowNull: true }) })
+    //   .cursorPaginate({ cursor: this.castParam('cursor', 'string', { allowNull: true }) })
     // this.ok(${pluralizedModelAttributeName})
   }`;
                 else

package/dist/cjs/src/openapi-renderer/endpoint.js

@@ -9,13 +9,13 @@ import PsychicApp from '../psychic-app/index.js';
 import openapiParamNamesForDreamClass from '../server/helpers/openapiParamNamesForDreamClass.js';
 import OpenapiSegmentExpander from './body-segment.js';
 import { DEFAULT_OPENAPI_RESPONSES } from './defaults.js';
+import cursorPaginationParamOpenapiProperty from './helpers/cursorPaginationParamOpenapiProperty.js';
 import { dreamColumnOpenapiShape } from './helpers/dreamAttributeOpenapiShape.js';
 import openapiOpts from './helpers/openapiOpts.js';
 import openapiRoute from './helpers/openapiRoute.js';
 import paginationPageParamOpenapiProperty from './helpers/paginationPageParamOpenapiProperty.js';
+import safelyAttachCursorPaginationParamToRequestBodySegment from './helpers/safelyAttachCursorPaginationParamToRequestBodySegment.js';
 import safelyAttachPaginationParamToRequestBodySegment from './helpers/safelyAttachPaginationParamsToBodySegment.js';
-import safelyAttachScrollPaginationParamToRequestBodySegment from './helpers/safelyAttachScrollPaginationParamsToBodySegment.js';
-import scrollPaginationCursorParamOpenapiProperty from './helpers/scrollPaginationCursorParamOpenapiProperty.js';
 import SerializerOpenapiRenderer from './SerializerOpenapiRenderer.js';
 export default class OpenapiEndpointRenderer {
     dreamsOrSerializers;
@@ -23,6 +23,7 @@ export default class OpenapiEndpointRenderer {
     action;
     many;
     paginate;
+    cursorPaginate;
     scrollPaginate;
     responses;
     serializerKey;
@@ -53,7 +54,7 @@ export default class OpenapiEndpointRenderer {
      * const json = JSON.encode(openapiJsonContents, null, 2)
      * ```
      */
-    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, paginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, } = {}) {
+    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, paginate, cursorPaginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, } = {}) {
         this.dreamsOrSerializers = dreamsOrSerializers;
         this.controllerClass = controllerClass;
         this.action = action;
@@ -61,6 +62,7 @@ export default class OpenapiEndpointRenderer {
         this.headers = headers;
         this.many = many;
         this.paginate = paginate;
+        this.cursorPaginate = cursorPaginate;
         this.scrollPaginate = scrollPaginate;
         this.query = query;
         this.responses = responses;
@@ -404,13 +406,14 @@ export default class OpenapiEndpointRenderer {
                 },
             });
         }
+        const cursorPaginationName = this.cursorPaginate === true ? 'cursor' : this.cursorPaginate?.query;
         const scrollPaginationName = this.scrollPaginate === true ? 'cursor' : this.scrollPaginate?.query;
-        if (scrollPaginationName) {
+        if (cursorPaginationName || scrollPaginationName) {
             queryParams.push({
                 in: 'query',
                 required: false,
-                name: scrollPaginationName,
-                description: 'Scroll pagination cursor',
+                name: (cursorPaginationName || scrollPaginationName),
+                description: 'Pagination cursor',
                 allowReserved: true,
                 schema: {
                     type: ['string', 'null'],
@@ -442,9 +445,9 @@ export default class OpenapiEndpointRenderer {
         if (bodyPaginationPageParam) {
             schema = safelyAttachPaginationParamToRequestBodySegment(bodyPaginationPageParam, schema);
         }
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
-        if (bodyScrollPaginationCursorParam) {
-            schema = safelyAttachScrollPaginationParamToRequestBodySegment(bodyScrollPaginationCursorParam, schema);
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
+        if (bodyCursorPaginationParam) {
+            schema = safelyAttachCursorPaginationParamToRequestBodySegment(bodyCursorPaginationParam, schema);
         }
         if (!schema)
             return undefined;
@@ -458,7 +461,7 @@ export default class OpenapiEndpointRenderer {
     }
     defaultRequestBody() {
         const bodyPaginationPageParam = this.paginate?.body;
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
         if (bodyPaginationPageParam) {
             return {
                 content: {
@@ -473,7 +476,7 @@ export default class OpenapiEndpointRenderer {
                 },
             };
         }
-        else if (bodyScrollPaginationCursorParam) {
+        else if (bodyCursorPaginationParam) {
             return {
                 content: {
                     'application/json': {
@@ -481,7 +484,7 @@ export default class OpenapiEndpointRenderer {
                             type: 'object',
                             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                             properties: {
-                                [bodyScrollPaginationCursorParam]: scrollPaginationCursorParamOpenapiProperty(),
+                                [bodyCursorPaginationParam]: cursorPaginationParamOpenapiProperty(),
                                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                             },
                         },
@@ -559,9 +562,9 @@ export default class OpenapiEndpointRenderer {
         if (bodyPaginationPageParam) {
             processedSchema = safelyAttachPaginationParamToRequestBodySegment(bodyPaginationPageParam, processedSchema);
         }
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
-        if (bodyScrollPaginationCursorParam) {
-            processedSchema = safelyAttachScrollPaginationParamToRequestBodySegment(bodyScrollPaginationCursorParam, processedSchema);
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
+        if (bodyCursorPaginationParam) {
+            processedSchema = safelyAttachCursorPaginationParamToRequestBodySegment(bodyCursorPaginationParam, processedSchema);
         }
         return {
             content: {
@@ -759,7 +762,7 @@ export default class OpenapiEndpointRenderer {
                     },
                 },
             };
-        if (this.scrollPaginate)
+        if (this.cursorPaginate || this.scrollPaginate)
             return {
                 type: 'object',
                 required: ['cursor', 'results'],

package/dist/cjs/src/openapi-renderer/helpers/cursorPaginationParamOpenapiProperty.js

@@ -0,0 +1,6 @@
+export default function cursorPaginationParamOpenapiProperty() {
+    return {
+        type: ['string', 'null'],
+        description: 'Pagination cursor',
+    };
+}

package/dist/cjs/src/openapi-renderer/helpers/{safelyAttachScrollPaginationParamsToBodySegment.js → safelyAttachCursorPaginationParamToRequestBodySegment.js}

@@ -1,4 +1,4 @@
-import scrollPaginationCursorParamOpenapiProperty from './scrollPaginationCursorParamOpenapiProperty.js';
+import cursorPaginationParamOpenapiProperty from './cursorPaginationParamOpenapiProperty.js';
 /**
  * @internal
  *
@@ -13,7 +13,7 @@ import scrollPaginationCursorParamOpenapiProperty from './scrollPaginationCursor
  * If neither of these apply, it will simply return
  * what was given to it, without any modifications
  */
-export default function safelyAttachScrollPaginationParamToRequestBodySegment(paramName, bodySegment) {
+export default function safelyAttachCursorPaginationParamToRequestBodySegment(paramName, bodySegment) {
     bodySegment ||= {
         type: 'object',
         properties: {},
@@ -23,7 +23,7 @@ export default function safelyAttachScrollPaginationParamToRequestBodySegment(pa
         ;
         bodySegment.properties = {
             ...bodySegment.properties,
-            [paramName]: scrollPaginationCursorParamOpenapiProperty(),
+            [paramName]: cursorPaginationParamOpenapiProperty(),
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         };
     }

package/dist/cjs/src/psychic-app/index.js

@@ -1,10 +1,8 @@
 import { DreamApp } from '@rvoh/dream';
-import { DreamAppAllowedPackageManagersEnumValues, } from '@rvoh/dream/system';
 import { Encrypt } from '@rvoh/dream/utils';
 import PackageManager from '../cli/helpers/PackageManager.js';
 import PsychicAppInitMissingApiRoot from '../error/psychic-app/init-missing-api-root.js';
 import PsychicAppInitMissingCallToLoadControllers from '../error/psychic-app/init-missing-call-to-load-controllers.js';
-import PsychicAppInitMissingPackageManager from '../error/psychic-app/init-missing-package-manager.js';
 import PsychicAppInitMissingRoutesCallback from '../error/psychic-app/init-missing-routes-callback.js';
 import cookieMaxAgeFromCookieOpts from '../helpers/cookieMaxAgeFromCookieOpts.js';
 import EnvInternal from '../helpers/EnvInternal.js';
@@ -45,8 +43,6 @@ export default class PsychicApp {
                 throw new PsychicAppInitMissingApiRoot();
             if (!psychicApp.routesCb)
                 throw new PsychicAppInitMissingRoutesCallback();
-            if (!DreamAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
-                throw new PsychicAppInitMissingPackageManager();
             if (psychicApp.encryption?.cookies?.current)
                 this.checkEncryptionKey('cookies', psychicApp.encryption.cookies.current.key, psychicApp.encryption.cookies.current.algorithm);
             await psychicApp.inflections?.();

package/dist/esm/src/controller/index.js

@@ -557,14 +557,10 @@ export default class PsychicController {
             return data.map(d => this.singleObjectJson(d, opts));
             //
         }
-        else if (this.currentOpenapiRenderer?.['paginate'] && Array.isArray(paginatedResults)) {
-            return {
-                ...data,
-                results: paginatedResults.map(result => this.singleObjectJson(result, opts)),
-            };
-            //
-        }
-        else if (this.currentOpenapiRenderer?.['scrollPaginate'] && Array.isArray(paginatedResults)) {
+        else if ((this.currentOpenapiRenderer?.['paginate'] ||
+            this.currentOpenapiRenderer?.['cursorPaginate'] ||
+            this.currentOpenapiRenderer?.['scrollPaginate']) &&
+            Array.isArray(paginatedResults)) {
             return {
                 ...data,
                 results: paginatedResults.map(result => this.singleObjectJson(result, opts)),

package/dist/esm/src/generate/helpers/generateControllerContent.js

@@ -57,14 +57,13 @@ export default function generateControllerContent({ ancestorName, ancestorImport
     status: 200,
     tags: openApiTags,
     description: 'Paginated index of ${pluralize(modelClassName)}',
-    scrollPaginate: true,
+    cursorPaginate: true,
     serializerKey: '${forAdmin ? 'adminSummary' : 'summary'}',
   })
   public async index() {
     // const ${pluralizedModelAttributeName} = await ${loadQueryBase}
     //   .preloadFor('${forAdmin ? 'adminSummary' : 'summary'}')
-    //   .order({ createdAt: 'desc' })
-    //   .scrollPaginate({ cursor: this.castParam('cursor', 'string', { allowNull: true }) })
+    //   .cursorPaginate({ cursor: this.castParam('cursor', 'string', { allowNull: true }) })
     // this.ok(${pluralizedModelAttributeName})
   }`;
                 else

package/dist/esm/src/openapi-renderer/endpoint.js

@@ -9,13 +9,13 @@ import PsychicApp from '../psychic-app/index.js';
 import openapiParamNamesForDreamClass from '../server/helpers/openapiParamNamesForDreamClass.js';
 import OpenapiSegmentExpander from './body-segment.js';
 import { DEFAULT_OPENAPI_RESPONSES } from './defaults.js';
+import cursorPaginationParamOpenapiProperty from './helpers/cursorPaginationParamOpenapiProperty.js';
 import { dreamColumnOpenapiShape } from './helpers/dreamAttributeOpenapiShape.js';
 import openapiOpts from './helpers/openapiOpts.js';
 import openapiRoute from './helpers/openapiRoute.js';
 import paginationPageParamOpenapiProperty from './helpers/paginationPageParamOpenapiProperty.js';
+import safelyAttachCursorPaginationParamToRequestBodySegment from './helpers/safelyAttachCursorPaginationParamToRequestBodySegment.js';
 import safelyAttachPaginationParamToRequestBodySegment from './helpers/safelyAttachPaginationParamsToBodySegment.js';
-import safelyAttachScrollPaginationParamToRequestBodySegment from './helpers/safelyAttachScrollPaginationParamsToBodySegment.js';
-import scrollPaginationCursorParamOpenapiProperty from './helpers/scrollPaginationCursorParamOpenapiProperty.js';
 import SerializerOpenapiRenderer from './SerializerOpenapiRenderer.js';
 export default class OpenapiEndpointRenderer {
     dreamsOrSerializers;
@@ -23,6 +23,7 @@ export default class OpenapiEndpointRenderer {
     action;
     many;
     paginate;
+    cursorPaginate;
     scrollPaginate;
     responses;
     serializerKey;
@@ -53,7 +54,7 @@ export default class OpenapiEndpointRenderer {
      * const json = JSON.encode(openapiJsonContents, null, 2)
      * ```
      */
-    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, paginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, } = {}) {
+    constructor(dreamsOrSerializers, controllerClass, action, { requestBody, headers, many, paginate, cursorPaginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, } = {}) {
         this.dreamsOrSerializers = dreamsOrSerializers;
         this.controllerClass = controllerClass;
         this.action = action;
@@ -61,6 +62,7 @@ export default class OpenapiEndpointRenderer {
         this.headers = headers;
         this.many = many;
         this.paginate = paginate;
+        this.cursorPaginate = cursorPaginate;
         this.scrollPaginate = scrollPaginate;
         this.query = query;
         this.responses = responses;
@@ -404,13 +406,14 @@ export default class OpenapiEndpointRenderer {
                 },
             });
         }
+        const cursorPaginationName = this.cursorPaginate === true ? 'cursor' : this.cursorPaginate?.query;
         const scrollPaginationName = this.scrollPaginate === true ? 'cursor' : this.scrollPaginate?.query;
-        if (scrollPaginationName) {
+        if (cursorPaginationName || scrollPaginationName) {
             queryParams.push({
                 in: 'query',
                 required: false,
-                name: scrollPaginationName,
-                description: 'Scroll pagination cursor',
+                name: (cursorPaginationName || scrollPaginationName),
+                description: 'Pagination cursor',
                 allowReserved: true,
                 schema: {
                     type: ['string', 'null'],
@@ -442,9 +445,9 @@ export default class OpenapiEndpointRenderer {
         if (bodyPaginationPageParam) {
             schema = safelyAttachPaginationParamToRequestBodySegment(bodyPaginationPageParam, schema);
         }
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
-        if (bodyScrollPaginationCursorParam) {
-            schema = safelyAttachScrollPaginationParamToRequestBodySegment(bodyScrollPaginationCursorParam, schema);
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
+        if (bodyCursorPaginationParam) {
+            schema = safelyAttachCursorPaginationParamToRequestBodySegment(bodyCursorPaginationParam, schema);
         }
         if (!schema)
             return undefined;
@@ -458,7 +461,7 @@ export default class OpenapiEndpointRenderer {
     }
     defaultRequestBody() {
         const bodyPaginationPageParam = this.paginate?.body;
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
         if (bodyPaginationPageParam) {
             return {
                 content: {
@@ -473,7 +476,7 @@ export default class OpenapiEndpointRenderer {
                 },
             };
         }
-        else if (bodyScrollPaginationCursorParam) {
+        else if (bodyCursorPaginationParam) {
             return {
                 content: {
                     'application/json': {
@@ -481,7 +484,7 @@ export default class OpenapiEndpointRenderer {
                             type: 'object',
                             // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
                             properties: {
-                                [bodyScrollPaginationCursorParam]: scrollPaginationCursorParamOpenapiProperty(),
+                                [bodyCursorPaginationParam]: cursorPaginationParamOpenapiProperty(),
                                 // eslint-disable-next-line @typescript-eslint/no-explicit-any
                             },
                         },
@@ -559,9 +562,9 @@ export default class OpenapiEndpointRenderer {
         if (bodyPaginationPageParam) {
             processedSchema = safelyAttachPaginationParamToRequestBodySegment(bodyPaginationPageParam, processedSchema);
         }
-        const bodyScrollPaginationCursorParam = this.scrollPaginate?.body;
-        if (bodyScrollPaginationCursorParam) {
-            processedSchema = safelyAttachScrollPaginationParamToRequestBodySegment(bodyScrollPaginationCursorParam, processedSchema);
+        const bodyCursorPaginationParam = this.cursorPaginate?.body ?? this.scrollPaginate?.body;
+        if (bodyCursorPaginationParam) {
+            processedSchema = safelyAttachCursorPaginationParamToRequestBodySegment(bodyCursorPaginationParam, processedSchema);
         }
         return {
             content: {
@@ -759,7 +762,7 @@ export default class OpenapiEndpointRenderer {
                     },
                 },
             };
-        if (this.scrollPaginate)
+        if (this.cursorPaginate || this.scrollPaginate)
             return {
                 type: 'object',
                 required: ['cursor', 'results'],

package/dist/esm/src/openapi-renderer/helpers/cursorPaginationParamOpenapiProperty.js

@@ -0,0 +1,6 @@
+export default function cursorPaginationParamOpenapiProperty() {
+    return {
+        type: ['string', 'null'],
+        description: 'Pagination cursor',
+    };
+}

package/dist/esm/src/openapi-renderer/helpers/{safelyAttachScrollPaginationParamsToBodySegment.js → safelyAttachCursorPaginationParamToRequestBodySegment.js}

@@ -1,4 +1,4 @@
-import scrollPaginationCursorParamOpenapiProperty from './scrollPaginationCursorParamOpenapiProperty.js';
+import cursorPaginationParamOpenapiProperty from './cursorPaginationParamOpenapiProperty.js';
 /**
  * @internal
  *
@@ -13,7 +13,7 @@ import scrollPaginationCursorParamOpenapiProperty from './scrollPaginationCursor
  * If neither of these apply, it will simply return
  * what was given to it, without any modifications
  */
-export default function safelyAttachScrollPaginationParamToRequestBodySegment(paramName, bodySegment) {
+export default function safelyAttachCursorPaginationParamToRequestBodySegment(paramName, bodySegment) {
     bodySegment ||= {
         type: 'object',
         properties: {},
@@ -23,7 +23,7 @@ export default function safelyAttachScrollPaginationParamToRequestBodySegment(pa
         ;
         bodySegment.properties = {
             ...bodySegment.properties,
-            [paramName]: scrollPaginationCursorParamOpenapiProperty(),
+            [paramName]: cursorPaginationParamOpenapiProperty(),
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         };
     }

package/dist/esm/src/psychic-app/index.js

@@ -1,10 +1,8 @@
 import { DreamApp } from '@rvoh/dream';
-import { DreamAppAllowedPackageManagersEnumValues, } from '@rvoh/dream/system';
 import { Encrypt } from '@rvoh/dream/utils';
 import PackageManager from '../cli/helpers/PackageManager.js';
 import PsychicAppInitMissingApiRoot from '../error/psychic-app/init-missing-api-root.js';
 import PsychicAppInitMissingCallToLoadControllers from '../error/psychic-app/init-missing-call-to-load-controllers.js';
-import PsychicAppInitMissingPackageManager from '../error/psychic-app/init-missing-package-manager.js';
 import PsychicAppInitMissingRoutesCallback from '../error/psychic-app/init-missing-routes-callback.js';
 import cookieMaxAgeFromCookieOpts from '../helpers/cookieMaxAgeFromCookieOpts.js';
 import EnvInternal from '../helpers/EnvInternal.js';
@@ -45,8 +43,6 @@ export default class PsychicApp {
                 throw new PsychicAppInitMissingApiRoot();
             if (!psychicApp.routesCb)
                 throw new PsychicAppInitMissingRoutesCallback();
-            if (!DreamAppAllowedPackageManagersEnumValues.includes(psychicApp.packageManager))
-                throw new PsychicAppInitMissingPackageManager();
             if (psychicApp.encryption?.cookies?.current)
                 this.checkEncryptionKey('cookies', psychicApp.encryption.cookies.current.key, psychicApp.encryption.cookies.current.algorithm);
             await psychicApp.inflections?.();

package/dist/types/src/openapi-renderer/endpoint.d.ts

@@ -29,6 +29,7 @@ export default class OpenapiEndpointRenderer<DreamsOrSerializersOrViewModels ext
     private action;
     private many;
     private paginate;
+    private cursorPaginate;
     private scrollPaginate;
     private responses;
     private serializerKey;
@@ -59,7 +60,7 @@ export default class OpenapiEndpointRenderer<DreamsOrSerializersOrViewModels ext
      * const json = JSON.encode(openapiJsonContents, null, 2)
      * ```
      */
-    constructor(dreamsOrSerializers: DreamsOrSerializersOrViewModels | null, controllerClass: typeof PsychicController, action: string, { requestBody, headers, many, paginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, }?: OpenapiEndpointRendererOpts<DreamsOrSerializersOrViewModels, ForOption>);
+    constructor(dreamsOrSerializers: DreamsOrSerializersOrViewModels | null, controllerClass: typeof PsychicController, action: string, { requestBody, headers, many, paginate, cursorPaginate, scrollPaginate, query, responses, serializerKey, status, tags, security, pathParams, description, summary, omitDefaultHeaders, omitDefaultResponses, defaultResponse, validate, }?: OpenapiEndpointRendererOpts<DreamsOrSerializersOrViewModels, ForOption>);
     /**
      * @internal
      *
@@ -341,6 +342,28 @@ export interface OpenapiEndpointRendererOpts<I extends DreamSerializable | Dream
      */
     paginate?: boolean | CustomPaginationOpts;
     /**
+     * when true, it will render an openapi document which
+     * produces an object containing cursorPagination data. This
+     * output is formatted to match the format returned
+     * when calling the `cursorPaginate` method
+     * within Dream, i.e.
+     *
+     * ```ts
+     * \@OpenAPI(Post, {
+     *   cursorPaginate: true,
+     *   status: 200,
+     * })
+     * public async index() {
+     *   const cursor = this.castParam('cursor', 'string', { allowNull: true })
+     *   const posts = await Post.where(...).cursorPaginate({ pageSize: 100, cursor })
+     *   this.ok(posts)
+     * }
+     * ```
+     */
+    cursorPaginate?: boolean | CustomCursorPaginationOpts;
+    /**
+     * @deprecated Use `cursorPaginate` instead. This option is deprecated in favor of the `cursorPaginate` option.
+     *
      * when true, it will render an openapi document which
      * produces an object containing scrollPagination data. This
      * output is formatted to match the format returned
@@ -359,7 +382,7 @@ export interface OpenapiEndpointRendererOpts<I extends DreamSerializable | Dream
      * }
      * ```
      */
-    scrollPaginate?: boolean | CustomScrollPaginationOpts;
+    scrollPaginate?: boolean | CustomCursorPaginationOpts;
     /**
      * specify path params. This is usually not necessary, since path params
      * are automatically computed for your endpoint by matching against the
@@ -665,14 +688,14 @@ export type CustomPaginationOpts = {
      */
     body: string;
 };
-export type CustomScrollPaginationOpts = {
+export type CustomCursorPaginationOpts = {
     /**
      * if provided, a query param will be added to the
      * openapi spec with the name provided.
      *
      * ```ts
      * @OpenAPI(Post, {
-     *   scrollPaginate: {
+     *   cursorPaginate: {
      *     query: 'cursor'
      *   },
      * })
@@ -680,7 +703,7 @@ export type CustomScrollPaginationOpts = {
      *   this.ok(
      *     await this.currentUser
      *      .associationQuery('posts')
-     *      .scrollPaginate({
+     *      .cursorPaginate({
      *        cursor: this.castParam('page', 'string', { allowNull: true })
      *      })
      *   )
@@ -695,7 +718,7 @@ export type CustomScrollPaginationOpts = {
      *
      * ```ts
      * @OpenAPI(Post, {
-     *   scrollPaginate: {
+     *   cursorPaginate: {
      *     body: 'page'
      *   },
      * })
@@ -703,7 +726,7 @@ export type CustomScrollPaginationOpts = {
      *   this.ok(
      *     await this.currentUser
      *      .associationQuery('posts')
-     *      .scrollPaginate({
+     *      .cursorPaginate({
      *        cursor: this.castParam('page', 'string', { allowNull: true })
      *      })
      *   )

package/dist/types/src/openapi-renderer/helpers/cursorPaginationParamOpenapiProperty.d.ts

@@ -0,0 +1,4 @@
+export default function cursorPaginationParamOpenapiProperty(): {
+    readonly type: readonly ["string", "null"];
+    readonly description: "Pagination cursor";
+};

package/dist/types/src/openapi-renderer/helpers/{safelyAttachScrollPaginationParamsToBodySegment.d.ts → safelyAttachCursorPaginationParamToRequestBodySegment.d.ts}

@@ -12,4 +12,4 @@
  * If neither of these apply, it will simply return
  * what was given to it, without any modifications
  */
-export default function safelyAttachScrollPaginationParamToRequestBodySegment<T>(paramName: string, bodySegment: T): T;
+export default function safelyAttachCursorPaginationParamToRequestBodySegment<T>(paramName: string, bodySegment: T): T;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "author": "RVOHealth",
   "repository": {
     "type": "git",
@@ -79,7 +79,7 @@
     "yoctocolors": "^2.1.1"
   },
   "peerDependencies": {
-    "@rvoh/dream": "^2.1.4",
+    "@rvoh/dream": "^2.2.0",
     "@types/express": "^5.0.1",
     "commander": "^12.1.0",
     "express": "^5.2.1",
@@ -88,7 +88,7 @@
   "devDependencies": {
     "@eslint/js": "^9.39.1",
     "@jest-mock/express": "^3.0.0",
-    "@rvoh/dream": "^2.1.4",
+    "@rvoh/dream": "^2.2.0",
     "@rvoh/dream-spec-helpers": "^2.0.0",
     "@rvoh/psychic-spec-helpers": "^2.0.0",
     "@types/body-parser": "^1.19.6",

package/dist/cjs/src/openapi-renderer/helpers/scrollPaginationCursorParamOpenapiProperty.js

@@ -1,6 +0,0 @@
-export default function scrollPaginationCursorParamOpenapiProperty() {
-    return {
-        type: ['string', 'null'],
-        description: 'Scroll pagination cursor',
-    };
-}

package/dist/esm/src/openapi-renderer/helpers/scrollPaginationCursorParamOpenapiProperty.js

@@ -1,6 +0,0 @@
-export default function scrollPaginationCursorParamOpenapiProperty() {
-    return {
-        type: ['string', 'null'],
-        description: 'Scroll pagination cursor',
-    };
-}

package/dist/types/src/openapi-renderer/helpers/scrollPaginationCursorParamOpenapiProperty.d.ts

@@ -1,4 +0,0 @@
-export default function scrollPaginationCursorParamOpenapiProperty(): {
-    readonly type: readonly ["string", "null"];
-    readonly description: "Scroll pagination cursor";
-};