@mx-space/byline-api-client 0.1.0 → 0.1.2

package/README.md

@@ -23,8 +23,12 @@ const byline = createClient({
 
 const { data: posts, meta } = await byline.posts.list({ size: 20 })
 const { data: post } = await byline.posts.getBySlug('product', 'hello-world')
+const { data: same } = await byline.posts.getBySlugOnly('hello-world')
 ```
 
+`getBySlugOnly` reads a post by its slug alone (`GET /posts/slug/:slug`, one request);
+old slugs resolve to the current post.
+
 `endpoint` is the server's API prefix (`/api/v{version}` in production). Every method
 resolves to `{ data, meta? }`, mirroring the server envelope. Responses are converted
 from the snake_case wire format to camelCase, except free-form subtrees (post `meta`,
@@ -134,7 +138,7 @@ invite to that user too (`invite.userId`).
 
 | Resource            | Methods                                                                                                                                                       |
 | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `posts`             | `list`, `get`, `getBySlug`, `getPath`, `findBySlug`, `latest`, `create`, `revise`, `update`, `setPublished`, `delete`                                         |
+| `posts`             | `list`, `get`, `getBySlug`, `getBySlugOnly`, `getPath`, `findBySlug`, `latest`, `create`, `revise`, `update`, `setPublished`, `delete`                        |
 | `authors`           | `list`, `listAll`, `get`                                                                                                                                      |
 | `drafts`            | `list`, `get`, `context`, `create`, `update`, `delete`                                                                                                        |
 | `publishJobs`       | `create`, `run` (create and wait)                                                                                                                             |
@@ -167,13 +171,9 @@ export const loadBlogIndex = async (locale: string, page = 1) => {
   return { posts, pagination: meta?.pagination }
 }
 
-export const loadBlogPost = async (
-  locale: string,
-  category: string,
-  slug: string,
-) => {
+export const loadBlogPost = async (locale: string, slug: string) => {
   try {
-    const { data: post, meta } = await byline.posts.getBySlug(category, slug, {
+    const { data: post, meta } = await byline.posts.getBySlugOnly(slug, {
       lang: locale,
     })
     return { post, seo: post.seo, translation: meta?.translation }

package/dist/index.cjs

@@ -219,6 +219,15 @@ var DynamicComponentsResource = class {
 			preserve: CATALOG_PRESERVE
 		});
 	}
+	update(id, input) {
+		return this.http.request("PATCH", `/dynamic-components/${encodeURIComponent(id)}`, {
+			body: input,
+			preserve: CATALOG_PRESERVE
+		});
+	}
+	remove(id) {
+		return this.http.request("DELETE", `/dynamic-components/${encodeURIComponent(id)}`, { preserve: CATALOG_PRESERVE });
+	}
 };
 var FilesResource = class {
 	http;
@@ -331,6 +340,12 @@ var PostsResource = class {
 			preserve: POST_PRESERVE
 		});
 	}
+	getBySlugOnly(slug, options = {}) {
+		return this.http.request("GET", `/posts/slug/${encodeURIComponent(slug)}`, {
+			query: { lang: options.lang ?? this.http.lang },
+			preserve: POST_PRESERVE
+		});
+	}
 	getPath(slug) {
 		return this.http.request("GET", `/posts/get-url/${encodeURIComponent(slug)}`);
 	}

package/dist/index.d.cts

@@ -383,12 +383,14 @@ interface TranslationTaskResult {
   skippedLocked: string[];
 }
 interface DynamicComponent {
+  id: string;
   name: string;
   description: string;
   url: string;
   initialHeight: number;
   propsSchema: Record<string, unknown>;
   parentUrl?: string;
+  previousUrls: string[];
 }
 interface DynamicComponentCatalog {
   version: 1;
@@ -402,6 +404,9 @@ interface RegisterDynamicComponentInput {
   propsSchema?: Record<string, unknown>;
   parentUrl?: string;
 }
+type UpdateDynamicComponentInput = Partial<Omit<RegisterDynamicComponentInput, 'parentUrl'>> & {
+  parentUrl?: string | null;
+};
 type FileType = 'image' | 'file' | 'avatar' | 'icon' | 'video' | 'audio';
 interface UploadedFile {
   url: string;
@@ -492,6 +497,8 @@ declare class DynamicComponentsResource {
   constructor(http: HttpCore);
   list(): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
   register(input: RegisterDynamicComponentInput): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+  update(id: string, input: UpdateDynamicComponentInput): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+  remove(id: string): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
 }
 declare class FilesResource {
   private readonly http;
@@ -571,6 +578,9 @@ declare class PostsResource {
   getBySlug(categorySlug: string, slug: string, options?: {
     lang?: string;
   }): Promise<ApiResponse<Post, PostResponseMeta>>;
+  getBySlugOnly(slug: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta>>;
   getPath(slug: string): Promise<ApiResponse<{
     path: string;
   }, Record<string, unknown>>>;
@@ -650,4 +660,4 @@ declare class BylineApiError extends Error {
 }
 declare const isBylineApiError: (error: unknown, code?: string) => error is BylineApiError;
 //#endregion
-export { type AcceptInviteInput, type AllowLoginResult, type ApiResponse, type ArticleTranslationMeta, type Author, type AuthorListQuery, type AuthorsResource, BylineApiError, BylineClient, type CategoriesResource, type Category, type CategorySummary, type ClientOptions, type ContentDocument, type ContentRevision, type CreateDraftInput, type CreateInviteInput, type CreatePublishJobInput, type CreatedInvite, type DraftBranch, type DraftRefType, type DraftWriteData, type DraftsResource, type DynamicComponent, type DynamicComponentCatalog, type DynamicComponentsResource, type EntryTranslationMeta, type FileType, type FilesResource, HttpCore, type HttpMethod, type InitUserInput, type Invite, type InviteUserInput, type InvitesResource, type LexicalEditorState, type ManualTranslationInput, type PaginatedMeta, type Pagination, type Post, type PostImage, type PostListQuery, type PostPatch, type PostResponseMeta, type PostSaveOptions, type PostSaveResult, type PostSeo, type PostSortKey, type PostWriteInput, type PostsResource, type ProfileOnlyUserInput, type PublicAuthor, type PublicInvite, type PublishAiResource, type PublishAiResourceRequest, type PublishJobsResource, type PublishTaskResult, type QueryValue, type RegisterDynamicComponentInput, type RequestOptions, type RevisionRelation, type RevisionSnapshot, type Task, type TaskRef, type TaskStatus, type TasksResource, type Translation, type TranslationPatch, type TranslationTaskInput, type TranslationTaskResult, type TranslationsResource, type UploadedFile, type UserDetail, type UserListQuery, type UserListStatus, type UserProfileInput, type UsersResource, type VersionContext, type WaitForTaskOptions, camelcaseKeys, createClient, isBylineApiError, toDraftData };
+export { type AcceptInviteInput, type AllowLoginResult, type ApiResponse, type ArticleTranslationMeta, type Author, type AuthorListQuery, type AuthorsResource, BylineApiError, BylineClient, type CategoriesResource, type Category, type CategorySummary, type ClientOptions, type ContentDocument, type ContentRevision, type CreateDraftInput, type CreateInviteInput, type CreatePublishJobInput, type CreatedInvite, type DraftBranch, type DraftRefType, type DraftWriteData, type DraftsResource, type DynamicComponent, type DynamicComponentCatalog, type DynamicComponentsResource, type EntryTranslationMeta, type FileType, type FilesResource, HttpCore, type HttpMethod, type InitUserInput, type Invite, type InviteUserInput, type InvitesResource, type LexicalEditorState, type ManualTranslationInput, type PaginatedMeta, type Pagination, type Post, type PostImage, type PostListQuery, type PostPatch, type PostResponseMeta, type PostSaveOptions, type PostSaveResult, type PostSeo, type PostSortKey, type PostWriteInput, type PostsResource, type ProfileOnlyUserInput, type PublicAuthor, type PublicInvite, type PublishAiResource, type PublishAiResourceRequest, type PublishJobsResource, type PublishTaskResult, type QueryValue, type RegisterDynamicComponentInput, type RequestOptions, type RevisionRelation, type RevisionSnapshot, type Task, type TaskRef, type TaskStatus, type TasksResource, type Translation, type TranslationPatch, type TranslationTaskInput, type TranslationTaskResult, type TranslationsResource, type UpdateDynamicComponentInput, type UploadedFile, type UserDetail, type UserListQuery, type UserListStatus, type UserProfileInput, type UsersResource, type VersionContext, type WaitForTaskOptions, camelcaseKeys, createClient, isBylineApiError, toDraftData };

package/dist/index.d.ts

@@ -383,12 +383,14 @@ interface TranslationTaskResult {
   skippedLocked: string[];
 }
 interface DynamicComponent {
+  id: string;
   name: string;
   description: string;
   url: string;
   initialHeight: number;
   propsSchema: Record<string, unknown>;
   parentUrl?: string;
+  previousUrls: string[];
 }
 interface DynamicComponentCatalog {
   version: 1;
@@ -402,6 +404,9 @@ interface RegisterDynamicComponentInput {
   propsSchema?: Record<string, unknown>;
   parentUrl?: string;
 }
+type UpdateDynamicComponentInput = Partial<Omit<RegisterDynamicComponentInput, 'parentUrl'>> & {
+  parentUrl?: string | null;
+};
 type FileType = 'image' | 'file' | 'avatar' | 'icon' | 'video' | 'audio';
 interface UploadedFile {
   url: string;
@@ -492,6 +497,8 @@ declare class DynamicComponentsResource {
   constructor(http: HttpCore);
   list(): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
   register(input: RegisterDynamicComponentInput): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+  update(id: string, input: UpdateDynamicComponentInput): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+  remove(id: string): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
 }
 declare class FilesResource {
   private readonly http;
@@ -571,6 +578,9 @@ declare class PostsResource {
   getBySlug(categorySlug: string, slug: string, options?: {
     lang?: string;
   }): Promise<ApiResponse<Post, PostResponseMeta>>;
+  getBySlugOnly(slug: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta>>;
   getPath(slug: string): Promise<ApiResponse<{
     path: string;
   }, Record<string, unknown>>>;
@@ -650,4 +660,4 @@ declare class BylineApiError extends Error {
 }
 declare const isBylineApiError: (error: unknown, code?: string) => error is BylineApiError;
 //#endregion
-export { type AcceptInviteInput, type AllowLoginResult, type ApiResponse, type ArticleTranslationMeta, type Author, type AuthorListQuery, type AuthorsResource, BylineApiError, BylineClient, type CategoriesResource, type Category, type CategorySummary, type ClientOptions, type ContentDocument, type ContentRevision, type CreateDraftInput, type CreateInviteInput, type CreatePublishJobInput, type CreatedInvite, type DraftBranch, type DraftRefType, type DraftWriteData, type DraftsResource, type DynamicComponent, type DynamicComponentCatalog, type DynamicComponentsResource, type EntryTranslationMeta, type FileType, type FilesResource, HttpCore, type HttpMethod, type InitUserInput, type Invite, type InviteUserInput, type InvitesResource, type LexicalEditorState, type ManualTranslationInput, type PaginatedMeta, type Pagination, type Post, type PostImage, type PostListQuery, type PostPatch, type PostResponseMeta, type PostSaveOptions, type PostSaveResult, type PostSeo, type PostSortKey, type PostWriteInput, type PostsResource, type ProfileOnlyUserInput, type PublicAuthor, type PublicInvite, type PublishAiResource, type PublishAiResourceRequest, type PublishJobsResource, type PublishTaskResult, type QueryValue, type RegisterDynamicComponentInput, type RequestOptions, type RevisionRelation, type RevisionSnapshot, type Task, type TaskRef, type TaskStatus, type TasksResource, type Translation, type TranslationPatch, type TranslationTaskInput, type TranslationTaskResult, type TranslationsResource, type UploadedFile, type UserDetail, type UserListQuery, type UserListStatus, type UserProfileInput, type UsersResource, type VersionContext, type WaitForTaskOptions, camelcaseKeys, createClient, isBylineApiError, toDraftData };
+export { type AcceptInviteInput, type AllowLoginResult, type ApiResponse, type ArticleTranslationMeta, type Author, type AuthorListQuery, type AuthorsResource, BylineApiError, BylineClient, type CategoriesResource, type Category, type CategorySummary, type ClientOptions, type ContentDocument, type ContentRevision, type CreateDraftInput, type CreateInviteInput, type CreatePublishJobInput, type CreatedInvite, type DraftBranch, type DraftRefType, type DraftWriteData, type DraftsResource, type DynamicComponent, type DynamicComponentCatalog, type DynamicComponentsResource, type EntryTranslationMeta, type FileType, type FilesResource, HttpCore, type HttpMethod, type InitUserInput, type Invite, type InviteUserInput, type InvitesResource, type LexicalEditorState, type ManualTranslationInput, type PaginatedMeta, type Pagination, type Post, type PostImage, type PostListQuery, type PostPatch, type PostResponseMeta, type PostSaveOptions, type PostSaveResult, type PostSeo, type PostSortKey, type PostWriteInput, type PostsResource, type ProfileOnlyUserInput, type PublicAuthor, type PublicInvite, type PublishAiResource, type PublishAiResourceRequest, type PublishJobsResource, type PublishTaskResult, type QueryValue, type RegisterDynamicComponentInput, type RequestOptions, type RevisionRelation, type RevisionSnapshot, type Task, type TaskRef, type TaskStatus, type TasksResource, type Translation, type TranslationPatch, type TranslationTaskInput, type TranslationTaskResult, type TranslationsResource, type UpdateDynamicComponentInput, type UploadedFile, type UserDetail, type UserListQuery, type UserListStatus, type UserProfileInput, type UsersResource, type VersionContext, type WaitForTaskOptions, camelcaseKeys, createClient, isBylineApiError, toDraftData };

package/dist/index.js

@@ -218,6 +218,15 @@ var DynamicComponentsResource = class {
 			preserve: CATALOG_PRESERVE
 		});
 	}
+	update(id, input) {
+		return this.http.request("PATCH", `/dynamic-components/${encodeURIComponent(id)}`, {
+			body: input,
+			preserve: CATALOG_PRESERVE
+		});
+	}
+	remove(id) {
+		return this.http.request("DELETE", `/dynamic-components/${encodeURIComponent(id)}`, { preserve: CATALOG_PRESERVE });
+	}
 };
 var FilesResource = class {
 	http;
@@ -330,6 +339,12 @@ var PostsResource = class {
 			preserve: POST_PRESERVE
 		});
 	}
+	getBySlugOnly(slug, options = {}) {
+		return this.http.request("GET", `/posts/slug/${encodeURIComponent(slug)}`, {
+			query: { lang: options.lang ?? this.http.lang },
+			preserve: POST_PRESERVE
+		});
+	}
 	getPath(slug) {
 		return this.http.request("GET", `/posts/get-url/${encodeURIComponent(slug)}`);
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/byline-api-client",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Typed fetch client for the Byline headless CMS API",
   "keywords": [
     "byline",