@paragraphcms/client 1.1.0 → 1.3.0

package/README.md

@@ -199,12 +199,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()`:
@@ -220,6 +222,8 @@ Notes:
 - `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
 
@@ -291,8 +295,11 @@ await client.media.upload({
 
 ```ts
 client.members.list(query?, options?)
+client.members.get(memberId, options?)
 client.authors.list(query?, options?)
+client.authors.get(authorId, options?)
 client.reviewers.list(query?, options?)
+client.reviewers.get(reviewerId, options?)
 ```
 
 Supported `sort` fields:
@@ -301,7 +308,10 @@ Supported `sort` fields:
 - `email`
 - `created_at`
 
-`authors` and `reviewers` are aliases of the member listing endpoints exposed by the API.
+Notes:
+
+- `members.get()`, `authors.get()`, and `reviewers.get()` are SDK convenience lookups built on top of the paginated list endpoints because the HTTP API does not expose `/members/{id}`, `/authors/{id}`, or `/reviewers/{id}` endpoints.
+- `authors` and `reviewers` are aliases of the member listing endpoints exposed by the API.
 
 ### Statuses
 
@@ -358,10 +368,13 @@ Supported `sort` fields for `dataModels.list()`:
 
 ```ts
 client.locales.list(options?)
+client.locales.get(code, options?)
 client.locales.create(body, options?)
 client.locales.delete(code, options?)
 ```
 
+`locales.get()` is an SDK convenience lookup over `locales.list()` because the HTTP API exposes locale listing and deletion by code, but not a dedicated locale detail endpoint.
+
 ### AI
 
 ```ts

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>;
@@ -33,12 +37,15 @@ export declare class Client {
     };
     readonly members: {
         list: (query?: MemberListQuery, options?: RequestOptions) => Promise<ListResponse<Member>>;
+        get: (memberId: string, options?: RequestOptions) => Promise<Member>;
     };
     readonly authors: {
         list: (query?: MemberListQuery, options?: RequestOptions) => Promise<ListResponse<Member>>;
+        get: (authorId: string, options?: RequestOptions) => Promise<Member>;
     };
     readonly reviewers: {
         list: (query?: MemberListQuery, options?: RequestOptions) => Promise<ListResponse<Member>>;
+        get: (reviewerId: string, options?: RequestOptions) => Promise<Member>;
     };
     readonly statuses: {
         list: (query?: StatusListQuery, options?: RequestOptions) => Promise<ListResponse<Status>>;
@@ -65,6 +72,7 @@ export declare class Client {
     };
     readonly locales: {
         list: (options?: RequestOptions) => Promise<Locale[]>;
+        get: (code: string, options?: RequestOptions) => Promise<Locale>;
         create: (body: CreateLocaleRequest, options?: RequestOptions) => Promise<LocaleMutationResult>;
         delete: (code: string, options?: RequestOptions) => Promise<DeleteByCodeResult>;
     };
@@ -77,6 +85,10 @@ export declare class Client {
     getInfo(options?: RequestOptions): Promise<ApiInfo>;
     private requestData;
     private requestList;
+    private getPageBySlug;
+    private findListItem;
+    private findArrayItem;
+    private createLookupError;
     private requestJson;
 }
 //# sourceMappingURL=client.d.ts.map

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;AA4SpB,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;MAKxD;IAEF,QAAQ,CAAC,OAAO;uBACC,eAAe,YAAY,cAAc;MAKxD;IAEF,QAAQ,CAAC,SAAS;uBACD,eAAe,YAAY,cAAc;MAKxD;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;uBAKvB,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;IAWnB,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;wBAM9C,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;IAIhC,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

@@ -2,6 +2,7 @@ import { ParagraphApiError, ParagraphClientError, } from "./errors.js";
 import { RequestRateLimiter } from "./rate-limiter.js";
 const DEFAULT_BASE_URL = "https://api.paragraphcms.com/v1";
 const DEFAULT_REQUESTS_PER_SECOND = 5;
+const LOOKUP_PAGE_SIZE = 100;
 function resolveFetchImplementation(customFetch) {
     const fetchImpl = customFetch ?? globalThis.fetch;
     if (typeof fetchImpl !== "function") {
@@ -230,6 +231,7 @@ export class Client {
             query,
             options,
         }),
+        getBySlug: (slug, options) => this.getPageBySlug(slug, options),
         update: (pageId, body, options) => this.requestData("PATCH", `/pages/${pageId}`, {
             body,
             options,
@@ -251,6 +253,9 @@ export class Client {
             options,
         }),
     };
+    page = {
+        getBySlug: (slug, options) => this.pages.getBySlug(slug, options),
+    };
     collections = {
         list: (query, options) => this.requestList("GET", "/collections", {
             query,
@@ -296,18 +301,33 @@ export class Client {
             query,
             options,
         }),
+        get: (memberId, options) => this.findListItem("/members", (member) => member.id === memberId, options, {
+            code: "member_not_found",
+            message: "Member not found.",
+            details: { memberId },
+        }),
     };
     authors = {
         list: (query, options) => this.requestList("GET", "/authors", {
             query,
             options,
         }),
+        get: (authorId, options) => this.findListItem("/authors", (author) => author.id === authorId, options, {
+            code: "author_not_found",
+            message: "Author not found.",
+            details: { authorId },
+        }),
     };
     reviewers = {
         list: (query, options) => this.requestList("GET", "/reviewers", {
             query,
             options,
         }),
+        get: (reviewerId, options) => this.findListItem("/reviewers", (reviewer) => reviewer.id === reviewerId, options, {
+            code: "reviewer_not_found",
+            message: "Reviewer not found.",
+            details: { reviewerId },
+        }),
     };
     statuses = {
         list: (query, options) => this.requestList("GET", "/statuses", {
@@ -381,6 +401,11 @@ export class Client {
         list: (options) => this.requestData("GET", "/locales", {
             options,
         }),
+        get: (code, options) => this.findArrayItem("/locales", (locale) => locale.code === code, options, {
+            code: "locale_not_found",
+            message: "Locale not found.",
+            details: { code },
+        }),
         create: (body, options) => this.requestData("POST", "/locales", {
             body,
             options,
@@ -423,6 +448,70 @@ export class Client {
     requestList(method, path, config) {
         return this.requestJson(method, path, config);
     }
+    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,
+                },
+                options,
+            });
+            const match = response.data.find(predicate);
+            if (match) {
+                return match;
+            }
+            if (!response.meta.has_next_page) {
+                break;
+            }
+            page += 1;
+        }
+        throw this.createLookupError("GET", path, {
+            query: {
+                ...(query ?? {}),
+                page,
+                limit: LOOKUP_PAGE_SIZE,
+            },
+            code: error.code,
+            message: error.message,
+            details: error.details,
+        });
+    }
+    async findArrayItem(path, predicate, options, error) {
+        const items = await this.requestData("GET", path, {
+            options,
+        });
+        const match = items.find(predicate);
+        if (match) {
+            return match;
+        }
+        throw this.createLookupError("GET", path, {
+            code: error.code,
+            message: error.message,
+            details: error.details,
+        });
+    }
+    createLookupError(method, path, config) {
+        return new ParagraphApiError({
+            status: 404,
+            code: config.code,
+            message: config.message,
+            details: config.details,
+            request: createRequestDescriptor(method, buildUrl(this.baseUrl, path, config.query)),
+        });
+    }
     requestJson(method, path, config) {
         const url = buildUrl(this.baseUrl, path, config?.query);
         const request = createRequestDescriptor(method, url);

package/package.json

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