@depup/octokit__plugin-paginate-rest 14.0.0-depup.0

package/dist-types/index.d.ts

@@ -0,0 +1,15 @@
+import type { Octokit } from "@octokit/core";
+import type { PaginateInterface } from "./types.js";
+export type { PaginateInterface, PaginatingEndpoints } from "./types.js";
+export { composePaginateRest } from "./compose-paginate.js";
+export { isPaginatingEndpoint, paginatingEndpoints, } from "./paginating-endpoints.js";
+/**
+ * @param octokit Octokit instance
+ * @param options Options passed to Octokit constructor
+ */
+export declare function paginateRest(octokit: Octokit): {
+    paginate: PaginateInterface;
+};
+export declare namespace paginateRest {
+    var VERSION: string;
+}

package/dist-types/iterator.d.ts

@@ -0,0 +1,3 @@
+import type { Octokit } from "@octokit/core";
+import type { RequestInterface, RequestParameters, Route } from "./types.js";
+export declare function iterator(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters): AsyncIterable<any>;

package/dist-types/normalize-paginated-list-response.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Some “list” response that can be paginated have a different response structure
+ *
+ * They have a `total_count` key in the response (search also has `incomplete_results`,
+ * /installation/repositories also has `repository_selection`), as well as a key with
+ * the list of the items which name varies from endpoint to endpoint.
+ *
+ * Octokit normalizes these responses so that paginated results are always returned following
+ * the same structure. One challenge is that if the list response has only one page, no Link
+ * header is provided, so this header alone is not sufficient to check wether a response is
+ * paginated or not.
+ *
+ * We check if a "total_count" key is present in the response data, but also make sure that
+ * a "url" property is not, as the "Get the combined status for a specific ref" endpoint would
+ * otherwise match: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref
+ */
+import type { OctokitResponse } from "./types.js";
+export declare function normalizePaginatedListResponse(response: OctokitResponse<any>): OctokitResponse<any>;

package/dist-types/paginate.d.ts

@@ -0,0 +1,3 @@
+import type { Octokit } from "@octokit/core";
+import type { MapFunction, PaginationResults, RequestParameters, Route, RequestInterface } from "./types.js";
+export declare function paginate(octokit: Octokit, route: Route | RequestInterface, parameters?: RequestParameters, mapFn?: MapFunction): Promise<PaginationResults>;

package/dist-types/paginating-endpoints.d.ts

@@ -0,0 +1,3 @@
+import { type PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+export { paginatingEndpoints } from "./generated/paginating-endpoints.js";
+export declare function isPaginatingEndpoint(arg: unknown): arg is keyof PaginatingEndpoints;

package/dist-types/types.d.ts

@@ -0,0 +1,248 @@
+import type { Octokit } from "@octokit/core";
+import type * as OctokitTypes from "@octokit/types";
+export type { EndpointOptions, RequestInterface, OctokitResponse, RequestParameters, Route, } from "@octokit/types";
+export type { PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+import type { PaginatingEndpoints } from "./generated/paginating-endpoints.js";
+type PaginationMetadataKeys = "repository_selection" | "total_count" | "total_commits" | "incomplete_results";
+type KnownKeys<T> = Extract<{
+    [K in keyof T]: string extends K ? never : number extends K ? never : K;
+} extends {
+    [_ in keyof T]: infer U;
+} ? U : never, Exclude<keyof T, PaginationMetadataKeys>>;
+type KeysMatching<T, V> = {
+    [K in keyof T]: T[K] extends V ? K : never;
+}[keyof T];
+type KnownKeysMatching<T, V> = KeysMatching<Pick<T, KnownKeys<T>>, V>;
+type GetResultsType<T> = T extends {
+    data: any[];
+} ? T["data"] : T extends {
+    data: object;
+} ? T["data"][KnownKeysMatching<T["data"], any[]>] : never;
+type GetPaginationKeys<T> = T extends {
+    data: any[];
+} ? {} : T extends {
+    data: object;
+} ? Pick<T["data"], Extract<keyof T["data"], PaginationMetadataKeys>> : never;
+type NormalizeResponse<T> = Omit<T, "data"> & {
+    data: GetResultsType<T> & GetPaginationKeys<T>;
+};
+type DataType<T> = "data" extends keyof T ? T["data"] : unknown;
+export interface MapFunction<T = OctokitTypes.OctokitResponse<PaginationResults<unknown>>, M = unknown[]> {
+    (response: T, done: () => void): M;
+}
+export type PaginationResults<T = unknown> = T[];
+export interface PaginateInterface {
+    /**
+     * Paginate a request using endpoint options and map each response to a custom array
+     *
+     * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <T, M>(options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, M[]>): Promise<PaginationResults<M>>;
+    /**
+     * Paginate a request using endpoint options
+     *
+     * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <T>(options: OctokitTypes.EndpointOptions): Promise<PaginationResults<T>>;
+    /**
+     * Paginate a request using a known endpoint route string and map each response to a custom array
+     *
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <R extends keyof PaginatingEndpoints, M extends unknown[]>(route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
+    /**
+     * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array
+     *
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <R extends keyof PaginatingEndpoints, M extends unknown[]>(route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
+    /**
+     * Paginate a request using an known endpoint route string
+     *
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <R extends keyof PaginatingEndpoints>(route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise<DataType<PaginatingEndpoints[R]["response"]>>;
+    /**
+     * Paginate a request using an unknown endpoint route string
+     *
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <T, R extends OctokitTypes.Route = OctokitTypes.Route>(route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise<T[]>;
+    /**
+     * Paginate a request using an endpoint method and a map function
+     *
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {function} mapFn? Optional method to map each response to a custom array
+     */
+    <R extends OctokitTypes.RequestInterface, M extends unknown[]>(request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
+    /**
+     * Paginate a request using an endpoint method, parameters, and a map function
+     *
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn? Optional method to map each response to a custom array
+     */
+    <R extends OctokitTypes.RequestInterface, M extends unknown[]>(request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
+    /**
+     * Paginate a request using an endpoint method and parameters
+     *
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <R extends OctokitTypes.RequestInterface>(request: R, parameters?: Parameters<R>[0]): Promise<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>["data"]>;
+    iterator: {
+        /**
+         * Get an async iterator to paginate a request using endpoint options
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <T>(options: OctokitTypes.EndpointOptions): AsyncIterable<OctokitTypes.OctokitResponse<PaginationResults<T>>>;
+        /**
+         * Get an async iterator to paginate a request using a known endpoint route string and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <R extends keyof PaginatingEndpoints>(route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterable<OctokitTypes.OctokitResponse<DataType<PaginatingEndpoints[R]["response"]>>>;
+        /**
+         * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <T, R extends OctokitTypes.Route = OctokitTypes.Route>(route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterable<OctokitTypes.OctokitResponse<PaginationResults<T>>>;
+        /**
+         * Get an async iterator to paginate a request using a request method and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         * @param {string} request `@octokit/request` or `octokit.request` method
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <R extends OctokitTypes.RequestInterface>(request: R, parameters?: Parameters<R>[0]): AsyncIterable<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>>;
+    };
+}
+export interface ComposePaginateInterface {
+    /**
+     * Paginate a request using endpoint options and map each response to a custom array
+     *
+     * @param {object} octokit Octokit instance
+     * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <T, M>(octokit: Octokit, options: OctokitTypes.EndpointOptions, mapFn: MapFunction<OctokitTypes.OctokitResponse<PaginationResults<T>>, M[]>): Promise<PaginationResults<M>>;
+    /**
+     * Paginate a request using endpoint options
+     *
+     * @param {object} octokit Octokit instance
+     * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <T>(octokit: Octokit, options: OctokitTypes.EndpointOptions): Promise<PaginationResults<T>>;
+    /**
+     * Paginate a request using a known endpoint route string and map each response to a custom array
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <R extends keyof PaginatingEndpoints, M extends unknown[]>(octokit: Octokit, route: R, mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
+    /**
+     * Paginate a request using a known endpoint route string and parameters, and map each response to a custom array
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn Optional method to map each response to a custom array
+     */
+    <R extends keyof PaginatingEndpoints, M extends unknown[]>(octokit: Octokit, route: R, parameters: PaginatingEndpoints[R]["parameters"], mapFn: MapFunction<PaginatingEndpoints[R]["response"], M>): Promise<M>;
+    /**
+     * Paginate a request using an known endpoint route string
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <R extends keyof PaginatingEndpoints>(octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): Promise<DataType<PaginatingEndpoints[R]["response"]>>;
+    /**
+     * Paginate a request using an unknown endpoint route string
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <T, R extends OctokitTypes.Route = OctokitTypes.Route>(octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): Promise<T[]>;
+    /**
+     * Paginate a request using an endpoint method and a map function
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {function} mapFn? Optional method to map each response to a custom array
+     */
+    <R extends OctokitTypes.RequestInterface, M extends unknown[]>(octokit: Octokit, request: R, mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
+    /**
+     * Paginate a request using an endpoint method, parameters, and a map function
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {object} parameters URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     * @param {function} mapFn? Optional method to map each response to a custom array
+     */
+    <R extends OctokitTypes.RequestInterface, M extends unknown[]>(octokit: Octokit, request: R, parameters: Parameters<R>[0], mapFn: MapFunction<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>, M>): Promise<M>;
+    /**
+     * Paginate a request using an endpoint method and parameters
+     *
+     * @param {object} octokit Octokit instance
+     * @param {string} request Request method (`octokit.request` or `@octokit/request`)
+     * @param {object} parameters? URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+     */
+    <R extends OctokitTypes.RequestInterface>(octokit: Octokit, request: R, parameters?: Parameters<R>[0]): Promise<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>["data"]>;
+    iterator: {
+        /**
+         * Get an async iterator to paginate a request using endpoint options
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         *
+         * @param {object} octokit Octokit instance
+         * @param {object} options Must set `method` and `url`. Plus URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <T>(octokit: Octokit, options: OctokitTypes.EndpointOptions): AsyncIterable<OctokitTypes.OctokitResponse<PaginationResults<T>>>;
+        /**
+         * Get an async iterator to paginate a request using a known endpoint route string and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         *
+         * @param {object} octokit Octokit instance
+         * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <R extends keyof PaginatingEndpoints>(octokit: Octokit, route: R, parameters?: PaginatingEndpoints[R]["parameters"]): AsyncIterable<OctokitTypes.OctokitResponse<DataType<PaginatingEndpoints[R]["response"]>>>;
+        /**
+         * Get an async iterator to paginate a request using an unknown endpoint route string and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         *
+         * @param {object} octokit Octokit instance
+         * @param {string} route Request method + URL. Example: `'GET /orgs/{org}'`
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <T, R extends OctokitTypes.Route = OctokitTypes.Route>(octokit: Octokit, route: R, parameters?: R extends keyof PaginatingEndpoints ? PaginatingEndpoints[R]["parameters"] : OctokitTypes.RequestParameters): AsyncIterable<OctokitTypes.OctokitResponse<PaginationResults<T>>>;
+        /**
+         * Get an async iterator to paginate a request using a request method and optional parameters
+         *
+         * @see {link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of} for await...of
+         *
+         * @param {object} octokit Octokit instance
+         * @param {string} request `@octokit/request` or `octokit.request` method
+         * @param {object} [parameters] URL, query or body parameters, as well as `headers`, `mediaType.format`, `request`, or `baseUrl`.
+         */
+        <R extends OctokitTypes.RequestInterface>(octokit: Octokit, request: R, parameters?: Parameters<R>[0]): AsyncIterable<NormalizeResponse<OctokitTypes.GetResponseTypeFromEndpointMethod<R>>>;
+    };
+}

package/dist-types/version.d.ts

@@ -0,0 +1 @@
+export declare const VERSION = "14.0.0";

package/package.json

@@ -0,0 +1,69 @@
+{
+  "name": "@depup/octokit__plugin-paginate-rest",
+  "type": "module",
+  "version": "14.0.0-depup.0",
+  "description": "[DepUp] Octokit plugin to paginate REST API endpoint responses",
+  "repository": "github:octokit/plugin-paginate-rest.js",
+  "keywords": [
+    "depup",
+    "dependency-bumped",
+    "updated-deps",
+    "@octokit/plugin-paginate-rest",
+    "github",
+    "api",
+    "sdk",
+    "toolkit"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "@octokit/types": "^16.0.0"
+  },
+  "peerDependencies": {
+    "@octokit/core": ">=6"
+  },
+  "devDependencies": {
+    "@octokit/core": "^7.0.6",
+    "@octokit/plugin-rest-endpoint-methods": "^17.0.0",
+    "@octokit/tsconfig": "^4.0.0",
+    "@types/node": "^24.0.0",
+    "@vitest/coverage-v8": "^3.0.0",
+    "esbuild": "^0.25.0",
+    "fetch-mock": "^12.0.0",
+    "github-openapi-graphql-query": "^5.0.0",
+    "glob": "^11.0.0",
+    "npm-run-all2": "^8.0.0",
+    "prettier": "3.6.2",
+    "semantic-release-plugin-update-version-in-files": "^2.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  },
+  "engines": {
+    "node": ">= 20"
+  },
+  "files": [
+    "dist-*/**",
+    "bin/**",
+    "changes.json",
+    "README.md"
+  ],
+  "types": "dist-types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist-types/index.d.ts",
+      "import": "./dist-bundle/index.js",
+      "default": "./dist-bundle/index.js"
+    },
+    "./types": {
+      "types": "./dist-types/.d.ts"
+    }
+  },
+  "sideEffects": false,
+  "depup": {
+    "changes": {},
+    "depsUpdated": 0,
+    "originalPackage": "@octokit/plugin-paginate-rest",
+    "originalVersion": "14.0.0",
+    "processedAt": "2026-03-17T16:32:28.954Z",
+    "smokeTest": "passed"
+  }
+}