@paragraphcms/client 1.2.0 → 1.4.0

package/README.md

@@ -29,7 +29,6 @@ const client = new Client({
 });
 
 const pages = await client.pages.list({
-  limit: 20,
   include_content: false,
   sort: "-updated_at",
 });
@@ -199,12 +198,14 @@ Returns the public `/v1` info payload:
 client.pages.list(query?, options?)
 client.pages.create(body?, options?)
 client.pages.get(pageId, query?, options?)
+client.pages.getBySlug(slug, options?)
 client.pages.update(pageId, body, options?)
 client.pages.delete(pageId, options?)
 client.pages.restore(pageId, options?)
 client.pages.permanentlyDelete(pageId, options?)
 client.pages.duplicate(pageId, options?)
 client.pages.createTranslation(pageId, body, options?)
+client.page.getBySlug(slug, options?)
 ```
 
 Supported `sort` fields for `pages.list()`:
@@ -217,9 +218,12 @@ Supported `sort` fields for `pages.list()`:
 
 Notes:
 
+- If you omit both `limit` and `page`, `pages.list()` returns the full matching result set.
 - `label_id` is passed as `string[]` in the SDK and serialized to the API CSV format automatically.
 - `content` is present in page list results only when `include_content: true`.
 - Page responses should be treated as Tiptap JSON arrays. `content_format` is no longer required in the response shape.
+- `pages.getBySlug()` is an SDK convenience lookup built on top of `pages.list({ slug })`, and then fetches the full page details by ID.
+- `page.getBySlug()` is a short alias for the same lookup.
 
 ### Collections
 

package/dist/client.d.ts

@@ -10,6 +10,7 @@ export declare class Client {
         list: (query?: PageListQuery, options?: RequestOptions) => Promise<ListResponse<PageSummary>>;
         create: (body?: CreatePageRequest, options?: RequestOptions) => Promise<PageMutationResult>;
         get: (pageId: string, query?: GetPageQuery, options?: RequestOptions) => Promise<Page>;
+        getBySlug: (slug: string, options?: RequestOptions) => Promise<Page>;
         update: (pageId: string, body: UpdatePageRequest, options?: RequestOptions) => Promise<PageMutationResult>;
         delete: (pageId: string, options?: RequestOptions) => Promise<DeleteResult>;
         restore: (pageId: string, options?: RequestOptions) => Promise<PageRestoreResult>;
@@ -17,6 +18,9 @@ export declare class Client {
         duplicate: (pageId: string, options?: RequestOptions) => Promise<PageMutationResult>;
         createTranslation: (pageId: string, body: CreatePageTranslationRequest, options?: RequestOptions) => Promise<PageMutationResult>;
     };
+    readonly page: {
+        getBySlug: (slug: string, options?: RequestOptions) => Promise<Page>;
+    };
     readonly collections: {
         list: (query?: CollectionListQuery, options?: RequestOptions) => Promise<ListResponse<Collection>>;
         create: (body: CreateCollectionRequest, options?: RequestOptions) => Promise<CollectionMutationResult>;
@@ -79,8 +83,10 @@ export declare class Client {
     };
     constructor(options: ClientOptions);
     getInfo(options?: RequestOptions): Promise<ApiInfo>;
+    private listPages;
     private requestData;
     private requestList;
+    private getPageBySlug;
     private findListItem;
     private findArrayItem;
     private createLookupError;

package/dist/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACvB,gBAAgB,EAEhB,OAAO,EACP,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,4BAA4B,EAC5B,mBAAmB,EACnB,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACnB,YAAY,EACZ,KAAK,EACL,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,MAAM,EACN,oBAAoB,EACpB,KAAK,EACL,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,EACN,eAAe,EACf,IAAI,EACJ,aAAa,EACb,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACb,sBAAsB,EAEtB,cAAc,EACd,MAAM,EACN,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AA6SpB,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C,QAAQ,CAAC,KAAK;uBACG,aAAa,YAAY,cAAc;wBAM9C,iBAAiB,YACb,cAAc;sBAOhB,MAAM,UACN,YAAY,YACV,cAAc;yBAOhB,MAAM,QACR,iBAAiB,YACb,cAAc;yBAMT,MAAM,YAAY,cAAc;0BAI/B,MAAM,YAAY,cAAc;oCASxC,MAAM,YACJ,cAAc;4BASN,MAAM,YAAY,cAAc;oCAS1C,MAAM,QACR,4BAA4B,YACxB,cAAc;MAU1B;IAEF,QAAQ,CAAC,WAAW;uBACH,mBAAmB,YAAY,cAAc;uBAMpD,uBAAuB,YACnB,cAAc;4BAUN,MAAM,YAAY,cAAc;+BASpC,MAAM,QACd,uBAAuB,YACnB,cAAc;+BAUH,MAAM,YAAY,cAAc;MAQvD;IAEF,QAAQ,CAAC,KAAK;uBACG,cAAc,YAAY,cAAc;uBAKxC,kBAAkB,YAAY,cAAc;uBAK5C,MAAM,YAAY,cAAc;0BAKpC,MAAM,QACT,kBAAkB,YACd,cAAc;0BAUR,MAAM,YAAY,cAAc;MAQlD;IAEF,QAAQ,CAAC,OAAO;uBACC,eAAe,YAAY,cAAc;wBAKxC,MAAM,YAAY,cAAc;MAWhD;IAEF,QAAQ,CAAC,OAAO;uBACC,eAAe,YAAY,cAAc;wBAKxC,MAAM,YAAY,cAAc;MAWhD;IAEF,QAAQ,CAAC,SAAS;uBACD,eAAe,YAAY,cAAc;0BAKtC,MAAM,YAAY,cAAc;MAWlD;IAEF,QAAQ,CAAC,QAAQ;uBACA,eAAe,YAAY,cAAc;uBAMhD,mBAAmB,YACf,cAAc;wBAMV,MAAM,YAAY,cAAc;2BAKpC,MAAM,QACV,mBAAmB,YACf,cAAc;wBAWlB,sBAAsB,YAClB,cAAc;2BAUP,MAAM,YAAY,cAAc;MAQnD;IAEF,QAAQ,CAAC,MAAM;uBACE,cAAc,YAAY,cAAc;uBAM/C,kBAAkB,YACd,cAAc;uBAMX,MAAM,YAAY,cAAc;0BAKpC,MAAM,QACT,kBAAkB,YACd,cAAc;wBAWlB,oBAAoB,YAChB,cAAc;0BAMR,MAAM,YAAY,cAAc;MAIlD;IAEF,QAAQ,CAAC,UAAU;uBACF,kBAAkB,YAAY,cAAc;uBAMnD,sBAAsB,YAClB,cAAc;2BAUP,MAAM,YAAY,cAAc;8BASpC,MAAM,QACb,sBAAsB,YAClB,cAAc;8BAUJ,MAAM,YAAY,cAAc;MAQtD;IAEF,QAAQ,CAAC,OAAO;yBACG,cAAc;oBAInB,MAAM,YAAY,cAAc;uBAYpC,mBAAmB,YACf,cAAc;uBAMX,MAAM,YAAY,cAAc;MAQ/C;IAEF,QAAQ,CAAC,EAAE;iCAED,mBAAmB,YACf,cAAc;wCAWlB,mBAAmB,YACf,cAAc;gCAWlB,sBAAsB,YAClB,cAAc;MAM1B;gBAEU,OAAO,EAAE,aAAa;IAiBlC,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc;IAIhC,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,WAAW;YAWL,YAAY;YA4CZ,aAAa;IA0B3B,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,WAAW;CA2HpB"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,eAAe,EACf,uBAAuB,EACvB,gBAAgB,EAEhB,OAAO,EACP,aAAa,EACb,UAAU,EACV,mBAAmB,EACnB,wBAAwB,EACxB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,4BAA4B,EAC5B,mBAAmB,EACnB,SAAS,EACT,kBAAkB,EAClB,uBAAuB,EACvB,kBAAkB,EAClB,YAAY,EACZ,sBAAsB,EACtB,mBAAmB,EACnB,YAAY,EACZ,KAAK,EACL,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,MAAM,EACN,oBAAoB,EACpB,KAAK,EACL,iBAAiB,EACjB,WAAW,EACX,cAAc,EACd,mBAAmB,EACnB,iBAAiB,EACjB,MAAM,EACN,eAAe,EACf,IAAI,EACJ,aAAa,EACb,WAAW,EACX,kBAAkB,EAClB,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,aAAa,EACb,sBAAsB,EAEtB,cAAc,EACd,MAAM,EACN,eAAe,EACf,oBAAoB,EACpB,uBAAuB,EACvB,sBAAsB,EACtB,kBAAkB,EAClB,kBAAkB,EAClB,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,YAAY,CAAC;AA6SpB,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAY;IACtC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAU;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAS;IACpC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;IAE7C,QAAQ,CAAC,KAAK;uBACG,aAAa,YAAY,cAAc;wBAG9C,iBAAiB,YACb,cAAc;sBAOhB,MAAM,UACN,YAAY,YACV,cAAc;0BAMR,MAAM,YAAY,cAAc;yBAGxC,MAAM,QACR,iBAAiB,YACb,cAAc;yBAMT,MAAM,YAAY,cAAc;0BAI/B,MAAM,YAAY,cAAc;oCASxC,MAAM,YACJ,cAAc;4BASN,MAAM,YAAY,cAAc;oCAS1C,MAAM,QACR,4BAA4B,YACxB,cAAc;MAU1B;IAEF,QAAQ,CAAC,IAAI;0BACO,MAAM,YAAY,cAAc;MAElD;IAEF,QAAQ,CAAC,WAAW;uBACH,mBAAmB,YAAY,cAAc;uBAMpD,uBAAuB,YACnB,cAAc;4BAUN,MAAM,YAAY,cAAc;+BASpC,MAAM,QACd,uBAAuB,YACnB,cAAc;+BAUH,MAAM,YAAY,cAAc;MAQvD;IAEF,QAAQ,CAAC,KAAK;uBACG,cAAc,YAAY,cAAc;uBAKxC,kBAAkB,YAAY,cAAc;uBAK5C,MAAM,YAAY,cAAc;0BAKpC,MAAM,QACT,kBAAkB,YACd,cAAc;0BAUR,MAAM,YAAY,cAAc;MAQlD;IAEF,QAAQ,CAAC,OAAO;uBACC,eAAe,YAAY,cAAc;wBAKxC,MAAM,YAAY,cAAc;MAWhD;IAEF,QAAQ,CAAC,OAAO;uBACC,eAAe,YAAY,cAAc;wBAKxC,MAAM,YAAY,cAAc;MAWhD;IAEF,QAAQ,CAAC,SAAS;uBACD,eAAe,YAAY,cAAc;0BAKtC,MAAM,YAAY,cAAc;MAWlD;IAEF,QAAQ,CAAC,QAAQ;uBACA,eAAe,YAAY,cAAc;uBAMhD,mBAAmB,YACf,cAAc;wBAMV,MAAM,YAAY,cAAc;2BAKpC,MAAM,QACV,mBAAmB,YACf,cAAc;wBAWlB,sBAAsB,YAClB,cAAc;2BAUP,MAAM,YAAY,cAAc;MAQnD;IAEF,QAAQ,CAAC,MAAM;uBACE,cAAc,YAAY,cAAc;uBAM/C,kBAAkB,YACd,cAAc;uBAMX,MAAM,YAAY,cAAc;0BAKpC,MAAM,QACT,kBAAkB,YACd,cAAc;wBAWlB,oBAAoB,YAChB,cAAc;0BAMR,MAAM,YAAY,cAAc;MAIlD;IAEF,QAAQ,CAAC,UAAU;uBACF,kBAAkB,YAAY,cAAc;uBAMnD,sBAAsB,YAClB,cAAc;2BAUP,MAAM,YAAY,cAAc;8BASpC,MAAM,QACb,sBAAsB,YAClB,cAAc;8BAUJ,MAAM,YAAY,cAAc;MAQtD;IAEF,QAAQ,CAAC,OAAO;yBACG,cAAc;oBAInB,MAAM,YAAY,cAAc;uBAYpC,mBAAmB,YACf,cAAc;uBAMX,MAAM,YAAY,cAAc;MAQ/C;IAEF,QAAQ,CAAC,EAAE;iCAED,mBAAmB,YACf,cAAc;wCAWlB,mBAAmB,YACf,cAAc;gCAWlB,sBAAsB,YAClB,cAAc;MAM1B;gBAEU,OAAO,EAAE,aAAa;IAiBlC,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc;YAIlB,SAAS;IAiDvB,OAAO,CAAC,WAAW;IAenB,OAAO,CAAC,WAAW;YAWL,aAAa;YAqBb,YAAY;YA+CZ,aAAa;IA0B3B,OAAO,CAAC,iBAAiB;IAsBzB,OAAO,CAAC,WAAW;CA2HpB"}

package/dist/client.js

@@ -219,10 +219,7 @@ export class Client {
     timeoutMs;
     limiter;
     pages = {
-        list: (query, options) => this.requestList("GET", "/pages", {
-            query,
-            options,
-        }),
+        list: (query, options) => this.listPages(query, options),
         create: (body = {}, options) => this.requestData("POST", "/pages", {
             body,
             options,
@@ -231,6 +228,7 @@ export class Client {
             query,
             options,
         }),
+        getBySlug: (slug, options) => this.getPageBySlug(slug, options),
         update: (pageId, body, options) => this.requestData("PATCH", `/pages/${pageId}`, {
             body,
             options,
@@ -252,6 +250,9 @@ export class Client {
             options,
         }),
     };
+    page = {
+        getBySlug: (slug, options) => this.pages.getBySlug(slug, options),
+    };
     collections = {
         list: (query, options) => this.requestList("GET", "/collections", {
             query,
@@ -438,17 +439,66 @@ export class Client {
     getInfo(options) {
         return this.requestData("GET", "", { options });
     }
+    async listPages(query, options) {
+        const response = await this.requestList("GET", "/pages", {
+            query,
+            options,
+        });
+        if (query?.limit !== undefined ||
+            query?.page !== undefined ||
+            !response.meta.has_next_page) {
+            return response;
+        }
+        const items = [...response.data];
+        let nextPage = response.meta.page + 1;
+        let lastMeta = response.meta;
+        while (lastMeta.has_next_page) {
+            const nextResponse = await this.requestList("GET", "/pages", {
+                query: {
+                    ...(query ?? {}),
+                    page: nextPage,
+                    limit: lastMeta.limit,
+                },
+                options,
+            });
+            items.push(...nextResponse.data);
+            lastMeta = nextResponse.meta;
+            nextPage = lastMeta.page + 1;
+        }
+        return {
+            data: items,
+            meta: {
+                page: 1,
+                limit: items.length,
+                total_items: items.length,
+                total_pages: items.length > 0 ? 1 : 0,
+                has_next_page: false,
+                has_prev_page: false,
+            },
+        };
+    }
     requestData(method, path, config) {
         return this.requestJson(method, path, config).then((response) => response.data);
     }
     requestList(method, path, config) {
         return this.requestJson(method, path, config);
     }
-    async findListItem(path, predicate, options, error) {
+    async getPageBySlug(slug, options) {
+        const page = await this.findListItem("/pages", (item) => item.slug === slug, options, {
+            code: "page_not_found",
+            message: "Page not found.",
+            details: { slug },
+        }, {
+            slug,
+        });
+        return this.pages.get(page.id, undefined, options);
+    }
+    async findListItem(path, predicate, options, error, query) {
         let page = 1;
         while (true) {
             const response = await this.requestList("GET", path, {
                 query: {
+                    ...(query ?? {}),
                     page,
                     limit: LOOKUP_PAGE_SIZE,
                 },
@@ -465,6 +515,7 @@ export class Client {
         }
         throw this.createLookupError("GET", path, {
             query: {
+                ...(query ?? {}),
                 page,
                 limit: LOOKUP_PAGE_SIZE,
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@paragraphcms/client",
-  "version": "1.2.0",
+  "version": "1.4.0",
   "description": "Official Paragraph CMS TypeScript client for the Paragraph CMS v1 API.",
   "license": "ISC",
   "author": "Paragraph CMS",