@inblog/cli 0.2.0

package/dist/sdk/index.d.ts

@@ -0,0 +1,514 @@
+interface JsonApiResource {
+    type: string;
+    id: string;
+    attributes: Record<string, any>;
+    relationships?: Record<string, {
+        data: {
+            type: string;
+            id: string;
+        } | {
+            type: string;
+            id: string;
+        }[] | null;
+    }>;
+    links?: {
+        self: string;
+    };
+}
+interface JsonApiResponse<T = JsonApiResource | JsonApiResource[]> {
+    jsonapi: {
+        version: '1.0';
+    };
+    data: T;
+    included?: JsonApiResource[];
+    meta?: Record<string, any>;
+    links?: {
+        self: string;
+        next?: string;
+        prev?: string;
+        first?: string;
+        last?: string;
+    };
+}
+interface JsonApiError {
+    status: string;
+    code: string;
+    title: string;
+    detail?: string;
+    meta?: Record<string, any>;
+}
+interface JsonApiErrorResponse {
+    jsonapi: {
+        version: '1.0';
+    };
+    errors: JsonApiError[];
+}
+interface Post {
+    id: string;
+    title: string;
+    slug: string;
+    description: string | null;
+    content_html: string | null;
+    content_type: 'tiptap' | 'notion';
+    published: boolean;
+    published_at: string | null;
+    image: {
+        url: string;
+        blurhash?: string;
+        created_at?: string;
+    } | null;
+    canonical_url: string | null;
+    notion_url: string | null;
+    meta_title: string | null;
+    meta_description: string | null;
+    cta_text: string | null;
+    cta_link: string | null;
+    cta_color: string | null;
+    cta_text_color: string | null;
+    custom_scripts: {
+        head_start_script: string | null;
+        head_end_script: string | null;
+        body_start_script: string | null;
+        body_end_script: string | null;
+        json_ld_script: string | null;
+    } | null;
+    tags?: Tag[];
+    authors?: Author[];
+}
+interface Tag {
+    id: string;
+    name: string;
+    slug: string;
+    priority: number;
+}
+interface Author {
+    id: string;
+    author_name: string;
+    avatar_url: string | null;
+}
+interface Blog {
+    id: number;
+    title: string;
+    subdomain: string;
+    description: string | null;
+    custom_domain: string | null;
+    custom_domain_verified: boolean;
+    custom_subdirectory: string | null;
+    logo: string | null;
+    logo_url: string | null;
+    favicon: string | null;
+    og_image: string | null;
+    blog_language: string;
+    timezone_diff: number;
+    plan: string;
+    ga_measurement_id: string | null;
+    is_search_console_connected: boolean;
+    search_console_url: string | null;
+    created_at: string;
+    updated_at: string;
+}
+interface Redirect {
+    id: string;
+    from_path: string;
+    to_path: string;
+    redirect_type: 307 | 308;
+    created_at: string;
+    updated_at: string;
+}
+interface Form {
+    id: string;
+    title: string;
+    form_setting: any;
+    magnet_type: string | null;
+    magnet_url: string | null;
+    magnet_file_src: string | null;
+    submit_email_setting: any;
+    thx_msg_setting: any;
+    created_at: string;
+    response_count: number;
+}
+interface FormResponse {
+    id: string;
+    email: string;
+    response: any;
+    country: string | null;
+    city: string | null;
+    region: string | null;
+    timezone: string | null;
+    language: string | null;
+    created_at: string;
+}
+interface PostCreateInput {
+    title: string;
+    slug?: string;
+    description?: string;
+    content_html?: string;
+    published?: boolean;
+    published_at?: string;
+    image?: {
+        url: string;
+        blurhash?: string;
+        created_at?: string;
+    };
+    canonical_url?: string;
+    notion_url?: string;
+    meta_title?: string;
+    meta_description?: string;
+    cta_text?: string;
+    cta_link?: string;
+    cta_color?: string;
+    cta_text_color?: string;
+    tag_ids?: number[];
+    author_ids?: string[];
+}
+interface PostUpdateInput {
+    title?: string;
+    slug?: string;
+    description?: string;
+    content_html?: string;
+    published?: boolean;
+    published_at?: string;
+    image?: {
+        url: string;
+        blurhash?: string;
+        created_at?: string;
+    } | null;
+    canonical_url?: string | null;
+    notion_url?: string;
+    meta_title?: string | null;
+    meta_description?: string | null;
+    cta_text?: string | null;
+    cta_link?: string | null;
+    cta_color?: string | null;
+    cta_text_color?: string | null;
+}
+interface TagCreateInput {
+    name: string;
+    slug?: string;
+    priority?: number;
+}
+interface TagUpdateInput {
+    name?: string;
+    slug?: string;
+    priority?: number;
+}
+interface RedirectCreateInput {
+    from_path: string;
+    to_path: string;
+    redirect_type?: 307 | 308;
+}
+interface RedirectUpdateInput {
+    from_path?: string;
+    to_path?: string;
+    redirect_type?: 307 | 308;
+}
+interface BlogUpdateInput {
+    title?: string;
+    description?: string;
+    blog_language?: string;
+    timezone_diff?: number;
+    logo?: string;
+    favicon?: string;
+    og_image?: string;
+    ga_measurement_id?: string;
+}
+interface AuthorUpdateInput {
+    author_name?: string;
+    avatar_url?: string | null;
+}
+interface PaginationOptions {
+    page?: number;
+    limit?: number;
+}
+interface PostListOptions extends PaginationOptions {
+    sort?: string;
+    order?: 'asc' | 'desc';
+    filter?: {
+        slug?: string;
+        published?: boolean;
+        published_at_gte?: string;
+        published_at_lte?: string;
+        tag_id?: number;
+        author_id?: string;
+        content_type?: 'tiptap' | 'notion';
+    };
+    include?: string[];
+}
+interface TagListOptions {
+    include?: string[];
+}
+interface AuthorListOptions extends PaginationOptions {
+    include?: string[];
+}
+interface RedirectListOptions extends PaginationOptions {
+}
+interface FormListOptions extends PaginationOptions {
+}
+interface FormResponseListOptions extends PaginationOptions {
+    filter?: {
+        form_id?: string;
+    };
+}
+
+/**
+ * Flatten a JSON:API resource into a plain object.
+ * Merges id + attributes + resolved relationships.
+ */
+declare function flattenResource(resource: JsonApiResource, included?: JsonApiResource[]): Record<string, any>;
+/**
+ * Deserialize a JSON:API response into flat object(s).
+ */
+declare function deserialize<T = Record<string, any>>(response: JsonApiResponse<JsonApiResource>): T;
+declare function deserialize<T = Record<string, any>>(response: JsonApiResponse<JsonApiResource[]>): T[];
+/**
+ * Extract pagination meta from a JSON:API response.
+ */
+declare function extractMeta(response: JsonApiResponse): {
+    total?: number;
+    page?: number;
+    limit?: number;
+    hasNext: boolean;
+};
+
+declare class InblogApiError extends Error {
+    status: number;
+    code: string;
+    title: string;
+    detail?: string;
+    constructor(status: number, code: string, title: string, detail?: string);
+}
+interface ClientOptions {
+    apiKey?: string;
+    accessToken?: string;
+    baseUrl?: string;
+    blogId?: number;
+    blogSubdomain?: string;
+}
+declare class InblogClient {
+    private apiKey?;
+    private accessToken?;
+    private baseUrl;
+    private blogId?;
+    private blogSubdomain?;
+    private tokenRefresher?;
+    constructor(options: ClientOptions);
+    setTokenRefresher(fn: () => Promise<string | null>): void;
+    private readHeaders;
+    private writeHeaders;
+    private resolveToken;
+    private buildUrl;
+    private handleResponse;
+    get<T = Record<string, any>>(path: string, params?: Record<string, any>): Promise<{
+        data: T;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    list<T = Record<string, any>>(path: string, params?: Record<string, any>): Promise<{
+        data: T[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    create<T = Record<string, any>>(path: string, type: string, attributes: Record<string, any>, params?: Record<string, any>): Promise<{
+        data: T;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update<T = Record<string, any>>(path: string, type: string, id: string, attributes: Record<string, any>): Promise<{
+        data: T;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    delete(path: string): Promise<void>;
+    post<T = Record<string, any>>(path: string, body?: any): Promise<{
+        data: T;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    patch<T = Record<string, any>>(path: string, body?: any): Promise<{
+        data: T;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    /**
+     * Raw GET — for non-JSON:API endpoints that return plain JSON.
+     */
+    rawGet(path: string, params?: Record<string, any>): Promise<any>;
+    /**
+     * Raw POST — for non-JSON:API endpoints.
+     */
+    rawPost(path: string, body?: any): Promise<any>;
+    /**
+     * Raw PATCH — for non-JSON:API endpoints.
+     */
+    rawPatch(path: string, body?: any): Promise<any>;
+    /**
+     * Raw DELETE — for non-JSON:API endpoints.
+     */
+    rawDelete(path: string): Promise<any>;
+    private handleRawResponse;
+}
+
+declare class PostsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: PostListOptions): Promise<{
+        data: Post[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string, include?: string[]): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    create(input: PostCreateInput): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update(id: string, input: PostUpdateInput): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    delete(id: string): Promise<void>;
+    publish(id: string): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    unpublish(id: string): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    schedule(id: string, scheduledAt: string): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    listTags(postId: string): Promise<{
+        data: Tag[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    addTags(postId: string, tagIds: number[]): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    removeTag(postId: string, tagId: string): Promise<void>;
+    listAuthors(postId: string): Promise<{
+        data: Author[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    addAuthors(postId: string, authorIds: string[]): Promise<{
+        data: Post;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    removeAuthor(postId: string, authorId: string): Promise<void>;
+}
+
+declare class TagsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: TagListOptions): Promise<{
+        data: Tag[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string): Promise<{
+        data: Tag;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    create(input: TagCreateInput): Promise<{
+        data: Tag;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update(id: string, input: TagUpdateInput): Promise<{
+        data: Tag;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    delete(id: string): Promise<void>;
+}
+
+declare class AuthorsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: AuthorListOptions): Promise<{
+        data: Author[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string): Promise<{
+        data: Author;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update(id: string, input: AuthorUpdateInput): Promise<{
+        data: Author;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+}
+
+declare class BlogsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    me(): Promise<{
+        data: Blog;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update(subdomain: string, input: BlogUpdateInput): Promise<{
+        data: Blog;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    domainConnect(domain: string): Promise<any>;
+    domainStatus(): Promise<any>;
+    domainDisconnect(): Promise<any>;
+    getCustomUi(): Promise<any>;
+    updateCustomUi(input: Record<string, any>): Promise<any>;
+}
+
+declare class RedirectsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: RedirectListOptions): Promise<{
+        data: Redirect[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string): Promise<{
+        data: Redirect;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    create(input: RedirectCreateInput): Promise<{
+        data: Redirect;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    update(id: string, input: RedirectUpdateInput): Promise<{
+        data: Redirect;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    delete(id: string): Promise<void>;
+}
+
+declare class FormsEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: FormListOptions): Promise<{
+        data: Form[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string): Promise<{
+        data: Form;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+}
+declare class FormResponsesEndpoint {
+    private client;
+    constructor(client: InblogClient);
+    list(options?: FormResponseListOptions): Promise<{
+        data: FormResponse[];
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+    get(id: string): Promise<{
+        data: FormResponse;
+        meta: ReturnType<typeof extractMeta>;
+    }>;
+}
+
+/**
+ * Build a JSON:API request body (simplified format).
+ * The inblog API accepts both wrapped and unwrapped formats;
+ * we use the simplified format: { type, attributes }.
+ */
+declare function serialize(type: string, attributes: Record<string, any>, id?: string): {
+    data: {
+        type: string;
+        id?: string;
+        attributes: Record<string, any>;
+    };
+};
+
+export { type Author, type AuthorListOptions, type AuthorUpdateInput, AuthorsEndpoint, type Blog, type BlogUpdateInput, BlogsEndpoint, type ClientOptions, type Form, type FormListOptions, type FormResponse, type FormResponseListOptions, FormResponsesEndpoint, FormsEndpoint, InblogApiError, InblogClient, type JsonApiError, type JsonApiErrorResponse, type JsonApiResource, type JsonApiResponse, type PaginationOptions, type Post, type PostCreateInput, type PostListOptions, type PostUpdateInput, PostsEndpoint, type Redirect, type RedirectCreateInput, type RedirectListOptions, type RedirectUpdateInput, RedirectsEndpoint, type Tag, type TagCreateInput, type TagListOptions, type TagUpdateInput, TagsEndpoint, deserialize, extractMeta, flattenResource, serialize };