@conduit-client/pagination 5.67.0-dev1

package/LICENSE.txt

@@ -0,0 +1,27 @@
+*Attorney/Client Privileged + Confidential*
+
+Terms of Use for Public Code (Non-OSS)
+
+*NOTE:* Before publishing code under this license/these Terms of Use, please review https://salesforce.quip.com/WFfvAMKB18AL and confirm that you’ve completed all prerequisites described therein. *These Terms of Use may not be used or modified without input from IP and Product Legal.*
+
+*Terms of Use*
+
+Copyright 2022 Salesforce, Inc. All rights reserved. 
+
+These Terms of Use govern the download, installation, and/or use of this software provided by Salesforce, Inc. (“Salesforce”) (the “Software”), were last updated on April 15, 2022, ** and constitute a legally binding agreement between you and Salesforce. If you do not agree to these Terms of Use, do not install or use the Software. 
+ 
+Salesforce grants you a worldwide, non-exclusive, no-charge, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute the Software and derivative works subject to these Terms. These Terms shall be included in all copies or substantial portions of the Software. 
+
+Subject to the limited rights expressly granted hereunder, Salesforce reserves all rights, title, and interest in and to all intellectual property subsisting in the Software. No rights are granted to you hereunder other than as expressly set forth herein. Users residing in countries on the United States Office of Foreign Assets Control sanction list, or which are otherwise subject to a US export embargo, may not use the Software.
+ 
+Implementation of the Software may require development work, for which you are responsible. The Software may contain bugs, errors and incompatibilities and is made available on an AS IS basis without support, updates, or service level commitments. 
+ 
+Salesforce reserves the right at any time to modify, suspend, or discontinue, the Software (or any part thereof) with or without notice. You agree that Salesforce shall not be liable to you or to any third party for any modification, suspension, or discontinuance.
+
+You agree to defend Salesforce against any claim, demand, suit or proceeding made or brought against Salesforce by a third party arising out of or accruing from (a) your use of the Software, and (b) any application you develop with the Software that infringes any copyright, trademark, trade secret, trade dress, patent, or other intellectual property right of any person or defames any person or violates their rights of publicity or privacy (each a “Claim Against Salesforce”), and will indemnify Salesforce from any damages, attorney fees, and costs finally awarded against Salesforce as a result of, or for any amounts paid by Salesforce under a settlement approved by you in writing of, a Claim Against Salesforce, provided Salesforce (x) promptly gives you written notice of the Claim Against Salesforce, (y) gives you sole control of the defense and settlement of the Claim Against Salesforce (except that you may not settle any Claim Against Salesforce unless it unconditionally releases Salesforce of all liability), and (z) gives you all reasonable assistance, at your expense.
+
+WITHOUT LIMITING THE GENERALITY OF THE FOREGOING, THE SOFTWARE IS NOT SUPPORTED AND IS PROVIDED "AS IS," WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED. IN NO EVENT SHALL SALESFORCE HAVE ANY LIABILITY FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, OR DAMAGES BASED ON LOST PROFITS, DATA, OR USE, IN CONNECTION WITH THE SOFTWARE, HOWEVER CAUSED AND WHETHER IN CONTRACT, TORT, OR UNDER ANY OTHER THEORY OF LIABILITY, WHETHER OR NOT YOU HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+ 
+These Terms of Use shall be governed exclusively by the internal laws of the State of California, without regard to its conflicts of laws rules. Each party hereby consents to the exclusive jurisdiction of the state and federal courts located in San Francisco County, California to adjudicate any dispute arising out of or relating to these Terms of Use and the download, installation, and/or use of the Software. Except as expressly stated herein, these Terms of Use constitute the entire agreement between the parties, and supersede all prior and contemporaneous agreements, proposals, or representations, written or oral, concerning their subject matter. No modification, amendment, or waiver of any provision of these Terms of Use shall be effective unless it is by an update to these Terms of Use that Salesforce makes available, or is in writing and signed by the party against whom the modification, amendment, or waiver is to be asserted.
+
+_*Data Privacy*_: Salesforce may collect, process, and store device, system, and other information related to your use of the Software. This information includes, but is not limited to, IP address, user metrics, and other data (“Usage Data”). Salesforce may use Usage Data for analytics, product development, and marketing purposes. You acknowledge that files generated in conjunction with the Software may contain sensitive or confidential data, and you are solely responsible for anonymizing and protecting such data.  

package/README.md

@@ -0,0 +1 @@
+This software is provided as-is with no support provided.

package/dist/index.js

@@ -0,0 +1,157 @@
+/*!
+ * Copyright (c) 2022, Salesforce, Inc.,
+ * All rights reserved.
+ * For full license text, see the LICENSE.txt file
+ */
+class MissingPaginationMetadataError extends Error {
+  constructor(params) {
+    super();
+    this.params = params;
+  }
+}
+class UnknownCursorError extends Error {
+}
+class RelayPaginationStrategy {
+  constructor(getCursorFromEdge = (edge) => edge.cursor) {
+    this.getCursorFromEdge = getCursorFromEdge;
+  }
+  // NOTE: Right now, this class only supports one page of continuous data.
+  // The construct for multiple "pages" in the RelayPaginationManagedMetadata is to allow
+  // for multiple disconnected pages of data to be tracked independently
+  merge(params, incoming, maybeExisting) {
+    const existing = this.buildInitialMetadata(maybeExisting);
+    const existingPage = existing.pages[0];
+    const { startIndex, endIndex } = this.getInsertionIndices(params, existingPage, incoming);
+    const preIncomingEdges = existingPage.edges.slice(0, startIndex);
+    const postIncomingEdges = existingPage.edges.slice(endIndex);
+    const newEdges = [...preIncomingEdges, ...incoming.edges, ...postIncomingEdges];
+    return {
+      pages: [
+        {
+          edges: newEdges,
+          pageInfo: {
+            hasNextPage: this.calculateHasNextPageAfterInsertion(
+              startIndex + incoming.edges.length,
+              newEdges,
+              incoming.pageInfo.hasNextPage,
+              existingPage.pageInfo.hasNextPage
+            ),
+            hasPreviousPage: this.calculateHasPreviousPageAfterInsertion(
+              startIndex,
+              incoming.pageInfo.hasPreviousPage,
+              existingPage.pageInfo.hasPreviousPage
+            )
+          }
+        }
+      ]
+    };
+  }
+  read(params, existing) {
+    if (existing === void 0) {
+      return new MissingPaginationMetadataError(params);
+    }
+    const existingPage = existing.pages[0];
+    const { startIndex, endIndex } = this.getReadIndices(params, existingPage);
+    if (endIndex > existingPage.edges.length && existingPage.pageInfo.hasNextPage) {
+      return new MissingPaginationMetadataError({
+        first: endIndex - existingPage.edges.length,
+        after: this.getCursorFromEdge(existingPage.edges.at(-1))
+      });
+    }
+    const edges = existingPage.edges.slice(startIndex, endIndex);
+    const hasNextPage = endIndex < existingPage.edges.length || existingPage.pageInfo.hasNextPage;
+    const hasPreviousPage = startIndex !== 0;
+    const startCursor = edges.length > 0 ? this.getCursorFromEdge(edges[0]) : null;
+    const endCursor = edges.length > 0 ? this.getCursorFromEdge(edges[edges.length - 1]) : null;
+    return {
+      edges,
+      pageInfo: {
+        hasNextPage,
+        hasPreviousPage,
+        startCursor,
+        endCursor
+      }
+    };
+  }
+  buildInitialMetadata(maybeExisting) {
+    if (maybeExisting !== void 0) {
+      return maybeExisting;
+    }
+    return {
+      pages: [
+        {
+          edges: [],
+          pageInfo: {
+            hasPreviousPage: true,
+            hasNextPage: true
+          }
+        }
+      ]
+    };
+  }
+  getInsertionIndices(params, existing, incoming) {
+    if (!("first" in params)) {
+      throw new Error("last/before is currently unsupported for relay pagination");
+    }
+    let startIndex = 0;
+    let endIndex = 0;
+    if (incoming.pageInfo.hasPreviousPage) {
+      if (params.after === void 0) {
+        throw new Error(
+          "Got hasPreviousPage true on null after param. Incorrect server behavior."
+        );
+      }
+      startIndex = this.findStartIndex(params.after, existing.edges);
+    }
+    if (incoming.pageInfo.hasNextPage) {
+      const lastCursor = this.getCursorFromEdge(incoming.edges[incoming.edges.length - 1]);
+      const lastCursorIndex = existing.edges.findIndex(
+        (edge) => this.getCursorFromEdge(edge) === lastCursor
+      );
+      if (lastCursorIndex < 0) {
+        endIndex = startIndex + incoming.edges.length;
+      } else {
+        endIndex = lastCursorIndex + 1;
+      }
+    } else {
+      endIndex = existing.edges.length;
+    }
+    return { startIndex, endIndex };
+  }
+  calculateHasNextPageAfterInsertion(incomingEndIndex, edges, incomingHasNextPage, existingHasNextPage) {
+    const incomingAtEnd = incomingEndIndex === edges.length;
+    return incomingAtEnd ? incomingHasNextPage : existingHasNextPage;
+  }
+  calculateHasPreviousPageAfterInsertion(startIndex, incomingHasPreviousPage, existingHasPreviousPage) {
+    const incomingAtBeginning = startIndex === 0;
+    return incomingAtBeginning ? incomingHasPreviousPage : existingHasPreviousPage;
+  }
+  getReadIndices(params, existing) {
+    if (!("first" in params)) {
+      throw new Error("last/before is currently unsupported for relay pagination");
+    }
+    let startIndex = 0;
+    if (params.after !== void 0) {
+      startIndex = this.findStartIndex(params.after, existing.edges);
+    }
+    let endIndex = startIndex + existing.edges.length;
+    if (params.first !== void 0) {
+      endIndex = startIndex + params.first;
+    }
+    return { startIndex, endIndex };
+  }
+  findStartIndex(after, existingEdges) {
+    const afterIndex = existingEdges.findIndex(
+      (edge) => this.getCursorFromEdge(edge) === after
+    );
+    if (afterIndex < 0) {
+      throw new UnknownCursorError();
+    }
+    return afterIndex + 1;
+  }
+}
+export {
+  MissingPaginationMetadataError,
+  RelayPaginationStrategy
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../src/pagination-strategy.ts","../src/relay-pagination-strategy.ts"],"sourcesContent":["/*\n * An error that contains an optimized set of parameters that represent the missing data in a collection.\n * These parameters can be used to make a server request for the missing pagination metadata.\n */\nexport class MissingPaginationMetadataError<QueryParams> extends Error {\n    constructor(public params: QueryParams) {\n        super();\n    }\n}\n\n/* An error that is thrown when a cursor is trying to be merged or read that we have never seen */\nexport class UnknownCursorError extends Error {}\n\n/*\n * A pagination strategy is an algorithm for managing a client side representation of a paginated\n * collection of data. Pagination strategies have two methods: `merge` and `read`. `merge` is used\n * to update the client side representation of the collection with a new page of data. `read` is used\n * to determine if a request for a particular page of data can be satisfied by our local cache.\n *\n * QueryParams: A generic representing configuration for a client side request for a page of data\n * ManagedPaginationMetadata: A generic representing the client side representation of the collection\n * ResponsePaginationMetadata: A generic representing a specific page of data.\n */\nexport type PaginationStrategy<QueryParams, ManagedPaginationMetadata, ResponsePaginationMetadata> =\n    {\n        merge(\n            params: QueryParams,\n            incoming: ResponsePaginationMetadata,\n            existing: ManagedPaginationMetadata | undefined\n        ): ManagedPaginationMetadata;\n        read(\n            params: QueryParams,\n            existing: ManagedPaginationMetadata\n        ): ResponsePaginationMetadata | MissingPaginationMetadataError<QueryParams>;\n    };\n","import { MissingPaginationMetadataError, UnknownCursorError } from './pagination-strategy';\nimport type { PaginationStrategy } from './pagination-strategy';\n\nexport type Edge<Node> = {\n    cursor: string;\n    node: Node;\n};\nexport type QueryParams =\n    | {\n          first: number | undefined;\n          after: string | undefined;\n      }\n    | {\n          last: number | undefined;\n          before: string | undefined;\n      };\n\nexport type IncomingPageInfo = {\n    hasNextPage: boolean;\n    hasPreviousPage: boolean;\n    startCursor?: string | null;\n    endCursor?: string | null;\n};\n\nexport type CompletePageInfo = {\n    hasNextPage: boolean;\n    hasPreviousPage: boolean;\n    startCursor: string | null;\n    endCursor: string | null;\n};\n\nexport type IncomingResponsePaginationMetadata<Node> = {\n    pageInfo: IncomingPageInfo;\n    edges: Edge<Node>[];\n};\n\nexport type ResponsePaginationMetadata<Node> = {\n    pageInfo: CompletePageInfo;\n    edges: Edge<Node>[];\n};\n\nexport type ManagedPaginationMetadata<Node> = {\n    pages: {\n        pageInfo: {\n            hasNextPage: boolean;\n            hasPreviousPage: boolean;\n        };\n        edges: Edge<Node>[];\n    }[];\n};\n\nexport class RelayPaginationStrategy<Node>\n    implements\n        PaginationStrategy<\n            QueryParams,\n            ManagedPaginationMetadata<Node>,\n            ResponsePaginationMetadata<Node>\n        >\n{\n    constructor(private getCursorFromEdge: (edge: any) => string = (edge) => edge.cursor) {}\n    // NOTE: Right now, this class only supports one page of continuous data.\n    // The construct for multiple \"pages\" in the RelayPaginationManagedMetadata is to allow\n    // for multiple disconnected pages of data to be tracked independently\n    merge(\n        params: QueryParams,\n        incoming: IncomingResponsePaginationMetadata<Node>,\n        maybeExisting: ManagedPaginationMetadata<Node> | undefined\n    ): ManagedPaginationMetadata<Node> {\n        const existing = this.buildInitialMetadata(maybeExisting);\n        const existingPage = existing.pages[0];\n\n        const { startIndex, endIndex } = this.getInsertionIndices(params, existingPage, incoming);\n\n        const preIncomingEdges = existingPage.edges.slice(0, startIndex);\n        const postIncomingEdges = existingPage.edges.slice(endIndex);\n\n        const newEdges = [...preIncomingEdges, ...incoming.edges, ...postIncomingEdges];\n\n        return {\n            pages: [\n                {\n                    edges: newEdges,\n                    pageInfo: {\n                        hasNextPage: this.calculateHasNextPageAfterInsertion(\n                            startIndex + incoming.edges.length,\n                            newEdges,\n                            incoming.pageInfo.hasNextPage,\n                            existingPage.pageInfo.hasNextPage\n                        ),\n                        hasPreviousPage: this.calculateHasPreviousPageAfterInsertion(\n                            startIndex,\n                            incoming.pageInfo.hasPreviousPage,\n                            existingPage.pageInfo.hasPreviousPage\n                        ),\n                    },\n                },\n            ],\n        };\n    }\n\n    read(\n        params: QueryParams,\n        existing: ManagedPaginationMetadata<Node> | undefined\n    ): ResponsePaginationMetadata<Node> | MissingPaginationMetadataError<QueryParams> {\n        if (existing === undefined) {\n            return new MissingPaginationMetadataError(params);\n        }\n\n        const existingPage = existing.pages[0];\n        const { startIndex, endIndex } = this.getReadIndices(params, existingPage);\n\n        if (endIndex > existingPage.edges.length && existingPage.pageInfo.hasNextPage) {\n            return new MissingPaginationMetadataError({\n                first: endIndex - existingPage.edges.length,\n                after: this.getCursorFromEdge(existingPage.edges.at(-1)),\n            });\n        }\n\n        const edges = existingPage.edges.slice(startIndex, endIndex);\n\n        const hasNextPage =\n            endIndex < existingPage.edges.length || existingPage.pageInfo.hasNextPage;\n        const hasPreviousPage = startIndex !== 0;\n\n        // Calculate startCursor and endCursor based on the actual edges being returned\n        const startCursor = edges.length > 0 ? this.getCursorFromEdge(edges[0]) : null;\n        const endCursor = edges.length > 0 ? this.getCursorFromEdge(edges[edges.length - 1]) : null;\n\n        return {\n            edges,\n            pageInfo: {\n                hasNextPage,\n                hasPreviousPage,\n                startCursor,\n                endCursor,\n            },\n        };\n    }\n\n    buildInitialMetadata(\n        maybeExisting: ManagedPaginationMetadata<Node> | undefined\n    ): ManagedPaginationMetadata<Node> {\n        if (maybeExisting !== undefined) {\n            return maybeExisting;\n        }\n\n        return {\n            pages: [\n                {\n                    edges: [],\n                    pageInfo: {\n                        hasPreviousPage: true,\n                        hasNextPage: true,\n                    },\n                },\n            ],\n        };\n    }\n\n    getInsertionIndices(\n        params: QueryParams,\n        existing: ManagedPaginationMetadata<Node>['pages'][0],\n        incoming: IncomingResponsePaginationMetadata<Node>\n    ) {\n        if (!('first' in params)) {\n            // we don't support last before yet\n            throw new Error('last/before is currently unsupported for relay pagination');\n        }\n\n        let startIndex = 0;\n        let endIndex = 0;\n\n        if (incoming.pageInfo.hasPreviousPage) {\n            if (params.after === undefined) {\n                throw new Error(\n                    'Got hasPreviousPage true on null after param. Incorrect server behavior.'\n                );\n            }\n\n            startIndex = this.findStartIndex(params.after, existing.edges);\n        }\n\n        if (incoming.pageInfo.hasNextPage) {\n            const lastCursor = this.getCursorFromEdge(incoming.edges[incoming.edges.length - 1]);\n            const lastCursorIndex = existing.edges.findIndex(\n                (edge) => this.getCursorFromEdge(edge) === lastCursor\n            );\n\n            if (lastCursorIndex < 0) {\n                // Don't know about the last cursor, should calculate end index on length of incoming\n                endIndex = startIndex + incoming.edges.length;\n            } else {\n                endIndex = lastCursorIndex + 1;\n            }\n        } else {\n            endIndex = existing.edges.length;\n        }\n\n        return { startIndex, endIndex };\n    }\n\n    private calculateHasNextPageAfterInsertion(\n        incomingEndIndex: number,\n        edges: Edge<Node>[],\n        incomingHasNextPage: boolean,\n        existingHasNextPage: boolean\n    ): boolean {\n        const incomingAtEnd = incomingEndIndex === edges.length;\n\n        // If the incoming data is at the end of our known data, use it's hasNextPage as entire collections, otherwise keep old\n        return incomingAtEnd ? incomingHasNextPage : existingHasNextPage;\n    }\n\n    private calculateHasPreviousPageAfterInsertion(\n        startIndex: number,\n        incomingHasPreviousPage: boolean,\n        existingHasPreviousPage: boolean\n    ): boolean {\n        const incomingAtBeginning = startIndex === 0;\n        // If the incoming data is at the beginning of our known data, use it's hasPreviousPage as entire collections, otherwise keep old\n        return incomingAtBeginning ? incomingHasPreviousPage : existingHasPreviousPage;\n    }\n\n    private getReadIndices(\n        params: QueryParams,\n        existing: ManagedPaginationMetadata<Node>['pages'][0]\n    ) {\n        if (!('first' in params)) {\n            // we don't support last before yet\n            throw new Error('last/before is currently unsupported for relay pagination');\n        }\n\n        let startIndex = 0;\n\n        if (params.after !== undefined) {\n            startIndex = this.findStartIndex(params.after, existing.edges);\n        }\n\n        let endIndex = startIndex + existing.edges.length;\n        if (params.first !== undefined) {\n            endIndex = startIndex + params.first;\n        }\n\n        return { startIndex, endIndex };\n    }\n\n    private findStartIndex(after: string, existingEdges: Edge<Node>[]): number {\n        const afterIndex = existingEdges.findIndex(\n            (edge) => this.getCursorFromEdge(edge) === after\n        );\n\n        if (afterIndex < 0) {\n            throw new UnknownCursorError();\n        }\n\n        return afterIndex + 1;\n    }\n}\n"],"names":[],"mappings":";;;;;AAIO,MAAM,uCAAoD,MAAM;AAAA,EACnE,YAAmB,QAAqB;AACpC,UAAA;AADe,SAAA,SAAA;AAAA,EAEnB;AACJ;AAGO,MAAM,2BAA2B,MAAM;AAAC;ACwCxC,MAAM,wBAOb;AAAA,EACI,YAAoB,oBAA2C,CAAC,SAAS,KAAK,QAAQ;AAAlE,SAAA,oBAAA;AAAA,EAAmE;AAAA;AAAA;AAAA;AAAA,EAIvF,MACI,QACA,UACA,eAC+B;AAC/B,UAAM,WAAW,KAAK,qBAAqB,aAAa;AACxD,UAAM,eAAe,SAAS,MAAM,CAAC;AAErC,UAAM,EAAE,YAAY,aAAa,KAAK,oBAAoB,QAAQ,cAAc,QAAQ;AAExF,UAAM,mBAAmB,aAAa,MAAM,MAAM,GAAG,UAAU;AAC/D,UAAM,oBAAoB,aAAa,MAAM,MAAM,QAAQ;AAE3D,UAAM,WAAW,CAAC,GAAG,kBAAkB,GAAG,SAAS,OAAO,GAAG,iBAAiB;AAE9E,WAAO;AAAA,MACH,OAAO;AAAA,QACH;AAAA,UACI,OAAO;AAAA,UACP,UAAU;AAAA,YACN,aAAa,KAAK;AAAA,cACd,aAAa,SAAS,MAAM;AAAA,cAC5B;AAAA,cACA,SAAS,SAAS;AAAA,cAClB,aAAa,SAAS;AAAA,YAAA;AAAA,YAE1B,iBAAiB,KAAK;AAAA,cAClB;AAAA,cACA,SAAS,SAAS;AAAA,cAClB,aAAa,SAAS;AAAA,YAAA;AAAA,UAC1B;AAAA,QACJ;AAAA,MACJ;AAAA,IACJ;AAAA,EAER;AAAA,EAEA,KACI,QACA,UAC8E;AAC9E,QAAI,aAAa,QAAW;AACxB,aAAO,IAAI,+BAA+B,MAAM;AAAA,IACpD;AAEA,UAAM,eAAe,SAAS,MAAM,CAAC;AACrC,UAAM,EAAE,YAAY,SAAA,IAAa,KAAK,eAAe,QAAQ,YAAY;AAEzE,QAAI,WAAW,aAAa,MAAM,UAAU,aAAa,SAAS,aAAa;AAC3E,aAAO,IAAI,+BAA+B;AAAA,QACtC,OAAO,WAAW,aAAa,MAAM;AAAA,QACrC,OAAO,KAAK,kBAAkB,aAAa,MAAM,GAAG,EAAE,CAAC;AAAA,MAAA,CAC1D;AAAA,IACL;AAEA,UAAM,QAAQ,aAAa,MAAM,MAAM,YAAY,QAAQ;AAE3D,UAAM,cACF,WAAW,aAAa,MAAM,UAAU,aAAa,SAAS;AAClE,UAAM,kBAAkB,eAAe;AAGvC,UAAM,cAAc,MAAM,SAAS,IAAI,KAAK,kBAAkB,MAAM,CAAC,CAAC,IAAI;AAC1E,UAAM,YAAY,MAAM,SAAS,IAAI,KAAK,kBAAkB,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI;AAEvF,WAAO;AAAA,MACH;AAAA,MACA,UAAU;AAAA,QACN;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MAAA;AAAA,IACJ;AAAA,EAER;AAAA,EAEA,qBACI,eAC+B;AAC/B,QAAI,kBAAkB,QAAW;AAC7B,aAAO;AAAA,IACX;AAEA,WAAO;AAAA,MACH,OAAO;AAAA,QACH;AAAA,UACI,OAAO,CAAA;AAAA,UACP,UAAU;AAAA,YACN,iBAAiB;AAAA,YACjB,aAAa;AAAA,UAAA;AAAA,QACjB;AAAA,MACJ;AAAA,IACJ;AAAA,EAER;AAAA,EAEA,oBACI,QACA,UACA,UACF;AACE,QAAI,EAAE,WAAW,SAAS;AAEtB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC/E;AAEA,QAAI,aAAa;AACjB,QAAI,WAAW;AAEf,QAAI,SAAS,SAAS,iBAAiB;AACnC,UAAI,OAAO,UAAU,QAAW;AAC5B,cAAM,IAAI;AAAA,UACN;AAAA,QAAA;AAAA,MAER;AAEA,mBAAa,KAAK,eAAe,OAAO,OAAO,SAAS,KAAK;AAAA,IACjE;AAEA,QAAI,SAAS,SAAS,aAAa;AAC/B,YAAM,aAAa,KAAK,kBAAkB,SAAS,MAAM,SAAS,MAAM,SAAS,CAAC,CAAC;AACnF,YAAM,kBAAkB,SAAS,MAAM;AAAA,QACnC,CAAC,SAAS,KAAK,kBAAkB,IAAI,MAAM;AAAA,MAAA;AAG/C,UAAI,kBAAkB,GAAG;AAErB,mBAAW,aAAa,SAAS,MAAM;AAAA,MAC3C,OAAO;AACH,mBAAW,kBAAkB;AAAA,MACjC;AAAA,IACJ,OAAO;AACH,iBAAW,SAAS,MAAM;AAAA,IAC9B;AAEA,WAAO,EAAE,YAAY,SAAA;AAAA,EACzB;AAAA,EAEQ,mCACJ,kBACA,OACA,qBACA,qBACO;AACP,UAAM,gBAAgB,qBAAqB,MAAM;AAGjD,WAAO,gBAAgB,sBAAsB;AAAA,EACjD;AAAA,EAEQ,uCACJ,YACA,yBACA,yBACO;AACP,UAAM,sBAAsB,eAAe;AAE3C,WAAO,sBAAsB,0BAA0B;AAAA,EAC3D;AAAA,EAEQ,eACJ,QACA,UACF;AACE,QAAI,EAAE,WAAW,SAAS;AAEtB,YAAM,IAAI,MAAM,2DAA2D;AAAA,IAC/E;AAEA,QAAI,aAAa;AAEjB,QAAI,OAAO,UAAU,QAAW;AAC5B,mBAAa,KAAK,eAAe,OAAO,OAAO,SAAS,KAAK;AAAA,IACjE;AAEA,QAAI,WAAW,aAAa,SAAS,MAAM;AAC3C,QAAI,OAAO,UAAU,QAAW;AAC5B,iBAAW,aAAa,OAAO;AAAA,IACnC;AAEA,WAAO,EAAE,YAAY,SAAA;AAAA,EACzB;AAAA,EAEQ,eAAe,OAAe,eAAqC;AACvE,UAAM,aAAa,cAAc;AAAA,MAC7B,CAAC,SAAS,KAAK,kBAAkB,IAAI,MAAM;AAAA,IAAA;AAG/C,QAAI,aAAa,GAAG;AAChB,YAAM,IAAI,mBAAA;AAAA,IACd;AAEA,WAAO,aAAa;AAAA,EACxB;AACJ;"}

package/dist/types/__tests__/cursor-pagination-strategy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/__tests__/page-number-page-size-pagination-strategy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/__tests__/relay-pagination-strategy.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/cursor-pagination-strategy.d.ts

@@ -0,0 +1,51 @@
+import { MissingPaginationMetadataError } from './pagination-strategy';
+import type { PaginationStrategy } from './pagination-strategy';
+type Cursor = string | null;
+export type QueryParams = {
+    cursor: Cursor;
+    pageSize: number;
+};
+type PageInfo = {
+    nextCursor: Cursor;
+    prevCursor: Cursor | undefined;
+};
+type ManagedPageInfo = {
+    nextCursor: Cursor | undefined;
+    prevCursor: Cursor | undefined;
+};
+type ManagedEdge<Node> = {
+    cursor: Cursor | undefined;
+    node: Node;
+};
+type Page<Node> = {
+    pageInfo: ManagedPageInfo;
+    edges: ManagedEdge<Node>[];
+};
+export type ResponsePaginationMetadata<Node> = {
+    pageInfo: PageInfo;
+    edges: {
+        node: Node;
+    }[];
+};
+export type ManagedPaginationMetadata<Node> = {
+    pages: Page<Node>[];
+};
+export declare const SYNTHETIC_CURSOR_PREFIX = "client:";
+export declare class CursorPaginationStrategy<Node> implements PaginationStrategy<QueryParams, ManagedPaginationMetadata<Node>, ResponsePaginationMetadata<Node>> {
+    cursorStrategy: 'server' | 'synthetic';
+    constructor(cursorStrategy?: 'server' | 'synthetic');
+    merge(params: QueryParams, incoming: ResponsePaginationMetadata<Node>, maybeExisting: ManagedPaginationMetadata<Node> | undefined): ManagedPaginationMetadata<Node>;
+    getInsertionIndices(params: QueryParams, existing: Page<Node>, incoming: ResponsePaginationMetadata<Node>): {
+        startIndex: number;
+        endIndex: number;
+    };
+    read(params: QueryParams, existing: ManagedPaginationMetadata<Node> | undefined): ResponsePaginationMetadata<Node> | MissingPaginationMetadataError<QueryParams>;
+    private calculateReadPageInfo;
+    private getClientCursor;
+    private getReadIndices;
+    private findParamsCursorIndex;
+    private encodeClientCursor;
+    private decodeClientCursor;
+    private buildInitialMetadata;
+}
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+import { MissingPaginationMetadataError } from './pagination-strategy';
+export * from './relay-pagination-strategy';
+export { MissingPaginationMetadataError };
+export type { IncomingResponsePaginationMetadata, IncomingPageInfo, CompletePageInfo, } from './relay-pagination-strategy';

package/dist/types/page-number-page-size-pagination-strategy.d.ts

@@ -0,0 +1,34 @@
+import { MissingPaginationMetadataError } from './pagination-strategy';
+import type { PaginationStrategy } from './pagination-strategy';
+export type QueryParams = {
+    pageNumber: number;
+    pageSize: number;
+};
+export type Edge<Node> = {
+    node: Node;
+};
+export type ResponsePaginationMetadata<Node> = {
+    edges: Edge<Node>[];
+};
+export type ManagedPaginationMetadataPage<Node> = {
+    edges: (Edge<Node> | undefined)[];
+    completed: boolean;
+};
+export type ManagedPaginationMetadata<Node> = {
+    pages: ManagedPaginationMetadataPage<Node>[];
+};
+export declare class PageNumberPageSizePaginationStrategy<Node> implements PaginationStrategy<QueryParams, ManagedPaginationMetadata<Node>, ResponsePaginationMetadata<Node>> {
+    merge(params: QueryParams, incoming: ResponsePaginationMetadata<Node>, maybeExisting: ManagedPaginationMetadata<Node> | undefined): ManagedPaginationMetadata<Node>;
+    read(params: QueryParams, existing: ManagedPaginationMetadata<Node> | undefined): ResponsePaginationMetadata<Node> | MissingPaginationMetadataError<QueryParams>;
+    buildInitialMetadata(existing: ManagedPaginationMetadata<Node> | undefined): ManagedPaginationMetadata<Node>;
+    getInsertionIndices(params: QueryParams, incoming: ResponsePaginationMetadata<Node>): {
+        startIndex: number;
+        endIndex: number;
+    };
+    isLastPage(params: QueryParams, incoming: ResponsePaginationMetadata<Node>): boolean;
+    readIsMissingEdges(params: QueryParams, readEdges: (Edge<Node> | undefined)[], existingPage: ManagedPaginationMetadataPage<Node>): boolean;
+    getReadIndices(params: QueryParams): {
+        startIndex: number;
+        endIndex: number;
+    };
+}

package/dist/types/pagination-strategy.d.ts

@@ -0,0 +1,10 @@
+export declare class MissingPaginationMetadataError<QueryParams> extends Error {
+    params: QueryParams;
+    constructor(params: QueryParams);
+}
+export declare class UnknownCursorError extends Error {
+}
+export type PaginationStrategy<QueryParams, ManagedPaginationMetadata, ResponsePaginationMetadata> = {
+    merge(params: QueryParams, incoming: ResponsePaginationMetadata, existing: ManagedPaginationMetadata | undefined): ManagedPaginationMetadata;
+    read(params: QueryParams, existing: ManagedPaginationMetadata): ResponsePaginationMetadata | MissingPaginationMetadataError<QueryParams>;
+};

package/dist/types/relay-pagination-strategy.d.ts

@@ -0,0 +1,57 @@
+import { MissingPaginationMetadataError } from './pagination-strategy';
+import type { PaginationStrategy } from './pagination-strategy';
+export type Edge<Node> = {
+    cursor: string;
+    node: Node;
+};
+export type QueryParams = {
+    first: number | undefined;
+    after: string | undefined;
+} | {
+    last: number | undefined;
+    before: string | undefined;
+};
+export type IncomingPageInfo = {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor?: string | null;
+    endCursor?: string | null;
+};
+export type CompletePageInfo = {
+    hasNextPage: boolean;
+    hasPreviousPage: boolean;
+    startCursor: string | null;
+    endCursor: string | null;
+};
+export type IncomingResponsePaginationMetadata<Node> = {
+    pageInfo: IncomingPageInfo;
+    edges: Edge<Node>[];
+};
+export type ResponsePaginationMetadata<Node> = {
+    pageInfo: CompletePageInfo;
+    edges: Edge<Node>[];
+};
+export type ManagedPaginationMetadata<Node> = {
+    pages: {
+        pageInfo: {
+            hasNextPage: boolean;
+            hasPreviousPage: boolean;
+        };
+        edges: Edge<Node>[];
+    }[];
+};
+export declare class RelayPaginationStrategy<Node> implements PaginationStrategy<QueryParams, ManagedPaginationMetadata<Node>, ResponsePaginationMetadata<Node>> {
+    private getCursorFromEdge;
+    constructor(getCursorFromEdge?: (edge: any) => string);
+    merge(params: QueryParams, incoming: IncomingResponsePaginationMetadata<Node>, maybeExisting: ManagedPaginationMetadata<Node> | undefined): ManagedPaginationMetadata<Node>;
+    read(params: QueryParams, existing: ManagedPaginationMetadata<Node> | undefined): ResponsePaginationMetadata<Node> | MissingPaginationMetadataError<QueryParams>;
+    buildInitialMetadata(maybeExisting: ManagedPaginationMetadata<Node> | undefined): ManagedPaginationMetadata<Node>;
+    getInsertionIndices(params: QueryParams, existing: ManagedPaginationMetadata<Node>['pages'][0], incoming: IncomingResponsePaginationMetadata<Node>): {
+        startIndex: number;
+        endIndex: number;
+    };
+    private calculateHasNextPageAfterInsertion;
+    private calculateHasPreviousPageAfterInsertion;
+    private getReadIndices;
+    private findStartIndex;
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "@conduit-client/pagination",
+    "version": "5.67.0-dev1",
+    "description": "OneStore Pagination Utilities",
+    "type": "module",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/salesforce-experience-platform-emu/luvio-next.git",
+        "directory": "packages/@conduit-client/pagination"
+    },
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "main": "dist/index.js",
+    "types": "dist/types/index.d.ts",
+    "files": [
+        "dist/"
+    ],
+    "dependencies": {
+        "@conduit-client/utils": "5.67.0-dev1"
+    },
+    "scripts": {
+        "build": "vite build && tsc --build --emitDeclarationOnly",
+        "clean": "rm -rf dist",
+        "test": "vitest run",
+        "test:size": "size-limit",
+        "watch": "npm run build --watch"
+    },
+    "size-limit": [
+        {
+            "path": "./dist/index.js",
+            "limit": "2 kB"
+        }
+    ]
+}