@mx-space/byline-api-client 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,653 @@
+//#region src/case.d.ts
+declare const camelcaseKeys: <T>(value: unknown, preservePaths?: readonly string[]) => T;
+//#endregion
+//#region src/types.d.ts
+interface ApiResponse<T, M = Record<string, unknown>> {
+  data: T;
+  meta?: M;
+}
+interface Pagination {
+  page: number;
+  size: number;
+  total: number;
+  totalPages: number;
+}
+interface PaginatedMeta {
+  pagination: Pagination;
+  [key: string]: unknown;
+}
+interface ArticleTranslationMeta {
+  isTranslated: boolean;
+  sourceLang?: string | null;
+  targetLang?: string | null;
+  translatedAt?: string;
+  model?: string;
+  availableTranslations?: string[];
+}
+interface EntryTranslationMeta {
+  article?: ArticleTranslationMeta;
+}
+interface PostResponseMeta {
+  view?: string;
+  pagination?: Pagination;
+  translation?: EntryTranslationMeta | Record<string, EntryTranslationMeta>;
+  glossary?: {
+    tags?: Array<{
+      source: string;
+      translated: string;
+    }>;
+  };
+  insights?: {
+    hasInLocale: boolean;
+  };
+  summary?: {
+    id: string;
+    text: string;
+    lang: string;
+    createdAt: string;
+  };
+  tts?: {
+    available: boolean;
+    lang?: string;
+    blockCount?: number;
+    stale?: boolean;
+    updatedAt?: string | null;
+  };
+}
+interface LexicalEditorState {
+  root: {
+    type: 'root';
+    children: unknown[];
+    [key: string]: unknown;
+  };
+}
+interface PublicAuthor {
+  id: string;
+  displayName: string;
+  avatar: string | null;
+  bio: string | null;
+  url: string | null;
+}
+interface Author extends PublicAuthor {
+  username: string | null;
+}
+interface AuthorListQuery {
+  page?: number;
+  size?: number;
+}
+interface UserDetail extends PublicAuthor {
+  email: string | null;
+  username: string | null;
+  permissions: number;
+  isProfileOnly: boolean;
+  deactivatedAt: string | null;
+  createdAt: string;
+  updatedAt: string | null;
+  lastLoginAt?: string | null;
+}
+interface UserProfileInput {
+  displayName?: string;
+  avatar?: string | null;
+  bio?: string | null;
+  url?: string | null;
+  email?: string | null;
+  username?: string;
+}
+interface ProfileOnlyUserInput extends UserProfileInput {
+  displayName: string;
+}
+type UserListStatus = 'all' | 'active' | 'deactivated' | 'profile_only';
+interface UserListQuery {
+  page?: number;
+  size?: number;
+  search?: string;
+  status?: UserListStatus;
+}
+interface Invite {
+  id: string;
+  email: string;
+  displayName: string | null;
+  invitedBy: string | null;
+  userId: string | null;
+  expiresAt: string;
+  acceptedAt: string | null;
+  createdAt: string;
+}
+interface CreatedInvite extends Invite {
+  token: string;
+  acceptUrl: string;
+  emailQueued: boolean;
+}
+interface CreateInviteInput {
+  email: string;
+  displayName?: string;
+}
+interface InviteUserInput {
+  email?: string;
+  displayName?: string;
+}
+interface PublicInvite {
+  email: string;
+  displayName: string | null;
+  expiresAt: string;
+}
+interface AcceptInviteInput {
+  username: string;
+  password: string;
+  displayName?: string;
+}
+interface InitUserInput {
+  username: string;
+  password: string;
+  mail: string;
+  name?: string;
+  url?: string;
+  avatar?: string;
+  bio?: string;
+}
+interface AllowLoginResult {
+  password: boolean;
+  passkey: boolean;
+  [provider: string]: boolean;
+}
+interface CategorySummary {
+  id: string;
+  name: string;
+  slug: string;
+  type: number;
+}
+interface Category extends CategorySummary {
+  createdAt?: string;
+  count?: number;
+  [key: string]: unknown;
+}
+interface PostSeo {
+  title?: string | null;
+  description?: string | null;
+  image?: string | null;
+}
+interface PostImage {
+  src: string;
+  alt?: string;
+  [key: string]: unknown;
+}
+interface Post {
+  id: string;
+  title: string;
+  slug: string;
+  text: string;
+  content: string | null;
+  contentFormat: string;
+  summary: string | null;
+  images: PostImage[] | null;
+  meta: Record<string, unknown> | null;
+  tags: string[];
+  categoryId: string;
+  category?: CategorySummary;
+  isPublished: boolean;
+  pinAt: string | null;
+  pinOrder: number | null;
+  createdAt: string;
+  modifiedAt: string | null;
+  authors: PublicAuthor[];
+  sourceLang: string | null;
+  image: string | null;
+  seo: PostSeo | null;
+  [key: string]: unknown;
+}
+type PostSortKey = 'createdAt' | 'modifiedAt' | 'pinAt';
+interface PostListQuery {
+  page?: number;
+  size?: number;
+  sortBy?: PostSortKey;
+  sortOrder?: 'asc' | 'desc';
+  categoryIds?: string[];
+  authorId?: string;
+  year?: number;
+  truncate?: number;
+  lang?: string;
+}
+interface PostPatch {
+  categoryId?: string;
+  pinAt?: string | null;
+  authors?: string[];
+  sourceLang?: string | null;
+  image?: string | null;
+  seo?: PostSeo | null;
+}
+interface PostWriteInput {
+  title: string;
+  content: string | LexicalEditorState;
+  text?: string;
+  slug?: string;
+  categoryId?: string;
+  summary?: string | null;
+  tags?: string[];
+  authors?: string[];
+  sourceLang?: string | null;
+  image?: string | null;
+  seo?: PostSeo | null;
+  images?: PostImage[] | null;
+  meta?: Record<string, unknown> | null;
+  pin?: boolean;
+  pinOrder?: number | null;
+  createdAt?: string;
+}
+type DraftRefType = 'post';
+type RevisionRelation = 'same' | 'ancestor' | 'descendant' | 'diverged';
+interface RevisionSnapshot {
+  content: string | null;
+  contentFormat: string;
+  images: unknown[] | null;
+  meta: Record<string, unknown> | null;
+  text: string;
+  title: string;
+  typeSpecificData: Record<string, unknown> | null;
+}
+interface ContentRevision extends RevisionSnapshot {
+  id: string;
+  documentId: string;
+  parentRevisionId: string | null;
+  createdAt: string;
+}
+interface ContentDocument {
+  id: string;
+  refId: string | null;
+  refType: DraftRefType;
+  publishedRevisionId: string | null;
+  publishAiResources: PublishAiResourceRequest[] | null;
+  createdAt: string;
+  updatedAt: string | null;
+}
+interface DraftBranch {
+  id: string;
+  documentId: string;
+  baseRevisionId: string;
+  headRevisionId: string;
+  status: 'active' | 'archived';
+  document: ContentDocument;
+  headRevision: ContentRevision;
+  baseRevision: ContentRevision;
+  publishedRevision: ContentRevision | null;
+  relationToPublished: RevisionRelation | null;
+  createdAt: string;
+  updatedAt: string | null;
+}
+interface VersionContext {
+  document: ContentDocument;
+  branches: DraftBranch[];
+  publishedRevision: ContentRevision | null;
+  [key: string]: unknown;
+}
+interface DraftWriteData {
+  title?: string;
+  text?: string;
+  content?: string;
+  contentFormat?: 'lexical';
+  images?: PostImage[] | null;
+  meta?: Record<string, unknown> | null;
+  typeSpecificData?: Record<string, unknown> | null;
+}
+interface CreateDraftInput {
+  refType: DraftRefType;
+  refId?: string;
+  baseRevisionId?: string | null;
+  data: DraftWriteData;
+}
+type PublishAiResource = 'insights' | 'summary' | 'translation' | 'tts';
+interface PublishAiResourceRequest {
+  resource: PublishAiResource;
+  mode: 'sync' | 'async';
+}
+interface CreatePublishJobInput {
+  branchId: string;
+  revisionId: string;
+  expectedPublishedRevisionId?: string | null;
+  confirmDiverged?: boolean;
+  aiResources?: Array<PublishAiResource | PublishAiResourceRequest>;
+  regenerateLockedTranslations?: boolean;
+}
+interface TaskRef {
+  taskId: string;
+  created: boolean;
+}
+type TaskStatus = 'pending' | 'running' | 'completed' | 'partial_failed' | 'failed' | 'cancelled';
+interface Task<TResult = unknown> {
+  id: string;
+  type: string;
+  status: TaskStatus;
+  progress?: number;
+  progressMessage?: string;
+  result?: TResult;
+  error?: string;
+  createdAt: number;
+  completedAt?: number;
+  [key: string]: unknown;
+}
+interface PublishTaskResult {
+  articleCommitted: boolean;
+  articleId: string;
+  newerDraftChanges: boolean;
+  publishedRevisionId: string;
+  resources: Partial<Record<PublishAiResource, string>>;
+}
+interface Translation {
+  id: string;
+  refId: string;
+  refType: string;
+  lang: string;
+  sourceLang: string;
+  title: string;
+  text: string;
+  subtitle: string | null;
+  summary: string | null;
+  tags: string[];
+  content: string | null;
+  contentFormat: string | null;
+  isLocked: boolean;
+  aiModel: string | null;
+  aiProvider: string | null;
+  seo: PostSeo | null;
+  createdAt: string;
+  updatedAt: string | null;
+  [key: string]: unknown;
+}
+interface ManualTranslationInput {
+  title: string;
+  content: string | LexicalEditorState;
+  text?: string;
+  subtitle?: string | null;
+  summary?: string | null;
+  tags?: string[];
+  sourceLang?: string;
+  seo?: PostSeo | null;
+}
+interface TranslationPatch {
+  title?: string;
+  text?: string;
+  subtitle?: string | null;
+  summary?: string;
+  tags?: string[];
+  content?: string | null;
+  isLocked?: boolean;
+  seo?: PostSeo | null;
+}
+interface TranslationTaskInput {
+  refId: string;
+  targetLanguages?: string[];
+  force?: boolean;
+  regenerateLocked?: boolean;
+}
+interface TranslationTaskResult {
+  translations: unknown[];
+  skippedLocked: string[];
+}
+interface DynamicComponent {
+  name: string;
+  description: string;
+  url: string;
+  initialHeight: number;
+  propsSchema: Record<string, unknown>;
+  parentUrl?: string;
+}
+interface DynamicComponentCatalog {
+  version: 1;
+  components: DynamicComponent[];
+}
+interface RegisterDynamicComponentInput {
+  name: string;
+  url: string;
+  description?: string;
+  initialHeight: number;
+  propsSchema?: Record<string, unknown>;
+  parentUrl?: string;
+}
+type FileType = 'image' | 'file' | 'avatar' | 'icon' | 'video' | 'audio';
+interface UploadedFile {
+  url: string;
+  name: string;
+  storageBackend?: string;
+  storageKey?: string;
+}
+//#endregion
+//#region src/http.d.ts
+type HttpMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+type QueryValue = string | number | boolean | null | undefined | ReadonlyArray<string | number>;
+interface ClientOptions {
+  endpoint: string;
+  apiKey?: string;
+  token?: string;
+  lang?: string;
+  headers?: Record<string, string>;
+  fetch?: typeof globalThis.fetch;
+  camelCase?: boolean;
+}
+interface RequestOptions {
+  query?: Record<string, QueryValue>;
+  body?: unknown;
+  headers?: Record<string, string>;
+  preserve?: readonly string[];
+  signal?: AbortSignal;
+}
+declare class HttpCore {
+  private readonly options;
+  readonly endpoint: string;
+  private readonly fetchImpl;
+  constructor(options: ClientOptions);
+  get lang(): string | undefined;
+  buildUrl(path: string, query?: Record<string, QueryValue>): string;
+  request<T, M = Record<string, unknown>>(method: HttpMethod, path: string, options?: RequestOptions): Promise<ApiResponse<T, M>>;
+  private transform;
+  private toError;
+}
+//#endregion
+//#region src/resources/authors.d.ts
+declare class AuthorsResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  list(query?: AuthorListQuery): Promise<ApiResponse<Author[], PaginatedMeta>>;
+  listAll(): Promise<Author[]>;
+  get(idOrUsername: string): Promise<ApiResponse<Author, Record<string, unknown>>>;
+}
+//#endregion
+//#region src/resources/content.d.ts
+declare class CategoriesResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  list(options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Category[], Record<string, unknown>>>;
+  get(slugOrId: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Category, Record<string, unknown>>>;
+  create(input: {
+    name: string;
+    slug?: string;
+  }): Promise<ApiResponse<Category, Record<string, unknown>>>;
+  update(id: string, input: {
+    name?: string;
+    slug?: string;
+  }): Promise<ApiResponse<Category, Record<string, unknown>>>;
+  delete(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+}
+declare class TranslationsResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  getForArticle(articleId: string, lang: string): Promise<ApiResponse<Translation, Record<string, unknown>>>;
+  languages(articleId: string): Promise<ApiResponse<string[], Record<string, unknown>>>;
+  listByRef(articleId: string): Promise<ApiResponse<{
+    translations: Translation[];
+    article: {
+      type: string;
+      document: Record<string, unknown>;
+    };
+  }, Record<string, unknown>>>;
+  writeManual(articleId: string, lang: string, input: ManualTranslationInput): Promise<ApiResponse<Translation, Record<string, unknown>>>;
+  update(id: string, patch: TranslationPatch): Promise<ApiResponse<Translation, Record<string, unknown>>>;
+  delete(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+  createTask(input: TranslationTaskInput): Promise<ApiResponse<TaskRef, Record<string, unknown>>>;
+}
+declare class DynamicComponentsResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  list(): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+  register(input: RegisterDynamicComponentInput): Promise<ApiResponse<DynamicComponentCatalog, Record<string, unknown>>>;
+}
+declare class FilesResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  upload(file: Blob, options?: {
+    type?: FileType;
+    filename?: string;
+    immutable?: boolean;
+  }): Promise<ApiResponse<UploadedFile, Record<string, unknown>>>;
+}
+//#endregion
+//#region src/resources/drafts.d.ts
+declare class DraftsResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  list(query?: {
+    page?: number;
+    size?: number;
+    refType?: DraftRefType;
+    hasRef?: boolean;
+    search?: string;
+  }): Promise<ApiResponse<DraftBranch[], PaginatedMeta>>;
+  get(id: string): Promise<ApiResponse<DraftBranch, Record<string, unknown>>>;
+  context(refType: DraftRefType, refId: string): Promise<ApiResponse<VersionContext, Record<string, unknown>>>;
+  create(input: CreateDraftInput): Promise<ApiResponse<DraftBranch, Record<string, unknown>>>;
+  update(id: string, input: {
+    data: DraftWriteData;
+    expectedHeadRevisionId: string;
+  }): Promise<ApiResponse<DraftBranch, Record<string, unknown>>>;
+  delete(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+}
+//#endregion
+//#region src/resources/tasks.d.ts
+interface WaitForTaskOptions {
+  intervalMs?: number;
+  timeoutMs?: number;
+  signal?: AbortSignal;
+}
+declare class TasksResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  get<TResult = unknown>(id: string): Promise<ApiResponse<Task<TResult>, Record<string, unknown>>>;
+  cancel(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+  wait<TResult = unknown>(id: string, options?: WaitForTaskOptions): Promise<Task<TResult>>;
+}
+declare class PublishJobsResource {
+  private readonly http;
+  private readonly tasks;
+  constructor(http: HttpCore, tasks: TasksResource);
+  create(input: CreatePublishJobInput): Promise<ApiResponse<TaskRef, Record<string, unknown>>>;
+  run(input: CreatePublishJobInput, options?: WaitForTaskOptions): Promise<Task<PublishTaskResult> & {
+    result: PublishTaskResult;
+  }>;
+}
+//#endregion
+//#region src/resources/posts.d.ts
+interface PostSaveOptions extends WaitForTaskOptions {
+  publish?: boolean;
+  aiResources?: Array<PublishAiResource | PublishAiResourceRequest>;
+  regenerateLockedTranslations?: boolean;
+}
+interface PostSaveResult {
+  draft: DraftBranch;
+  postId: string | null;
+  taskId: string | null;
+}
+declare const toDraftData: (input: Partial<PostWriteInput>) => DraftWriteData;
+declare class PostsResource {
+  private readonly http;
+  private readonly drafts;
+  private readonly publishJobs;
+  constructor(http: HttpCore, drafts: DraftsResource, publishJobs: PublishJobsResource);
+  list(query?: PostListQuery): Promise<ApiResponse<Post[], PostResponseMeta>>;
+  get(id: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta>>;
+  getBySlug(categorySlug: string, slug: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta>>;
+  getPath(slug: string): Promise<ApiResponse<{
+    path: string;
+  }, Record<string, unknown>>>;
+  findBySlug(slug: string, options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta> | null>;
+  latest(options?: {
+    lang?: string;
+  }): Promise<ApiResponse<Post, PostResponseMeta>>;
+  update(id: string, patch: PostPatch): Promise<ApiResponse<void, Record<string, unknown>>>;
+  setPublished(id: string, isPublished: boolean): Promise<ApiResponse<{
+    success: boolean;
+  }, Record<string, unknown>>>;
+  delete(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+  create(input: PostWriteInput, options?: PostSaveOptions): Promise<PostSaveResult>;
+  revise(id: string, input: Partial<PostWriteInput>, options?: PostSaveOptions): Promise<PostSaveResult>;
+  private finish;
+}
+//#endregion
+//#region src/resources/users.d.ts
+declare class UsersResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  allowLogin(): Promise<ApiResponse<AllowLoginResult, Record<string, unknown>>>;
+  checkLogged(): Promise<ApiResponse<{
+    ok: 0 | 1;
+    isGuest: boolean;
+  }, Record<string, unknown>>>;
+  me(): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  updateMe(input: UserProfileInput): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  list(query?: UserListQuery): Promise<ApiResponse<UserDetail[], PaginatedMeta>>;
+  listAll(query?: Omit<UserListQuery, 'page' | 'size'>): Promise<UserDetail[]>;
+  get(id: string): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  update(id: string, input: UserProfileInput): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  createProfileOnly(input: ProfileOnlyUserInput): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  deactivate(id: string): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  reactivate(id: string): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+  invite(id: string, input?: InviteUserInput): Promise<ApiResponse<CreatedInvite, Record<string, unknown>>>;
+  initFirstUser(input: InitUserInput): Promise<ApiResponse<unknown, Record<string, unknown>>>;
+}
+declare class InvitesResource {
+  private readonly http;
+  constructor(http: HttpCore);
+  list(): Promise<ApiResponse<Invite[], Record<string, unknown>>>;
+  create(input: CreateInviteInput): Promise<ApiResponse<CreatedInvite, Record<string, unknown>>>;
+  revoke(id: string): Promise<ApiResponse<void, Record<string, unknown>>>;
+  get(token: string): Promise<ApiResponse<PublicInvite, Record<string, unknown>>>;
+  accept(token: string, input: AcceptInviteInput): Promise<ApiResponse<UserDetail, Record<string, unknown>>>;
+}
+//#endregion
+//#region src/client.d.ts
+declare class BylineClient {
+  readonly http: HttpCore;
+  readonly posts: PostsResource;
+  readonly drafts: DraftsResource;
+  readonly publishJobs: PublishJobsResource;
+  readonly tasks: TasksResource;
+  readonly categories: CategoriesResource;
+  readonly translations: TranslationsResource;
+  readonly users: UsersResource;
+  readonly authors: AuthorsResource;
+  readonly invites: InvitesResource;
+  readonly dynamicComponents: DynamicComponentsResource;
+  readonly files: FilesResource;
+  constructor(options: ClientOptions);
+}
+declare const createClient: (options: ClientOptions) => BylineClient;
+//#endregion
+//#region src/error.d.ts
+declare class BylineApiError extends Error {
+  readonly status: number;
+  readonly code: string;
+  readonly path: string;
+  readonly details?: unknown | undefined;
+  readonly name = "BylineApiError";
+  constructor(status: number, code: string, message: string, path: string, details?: unknown | undefined);
+}
+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 };