![\"Logo\"](\"https://user-images.githubusercontent.com/4941205/221607740-28ce02cb-da96-4e34-a40d-8163bb7c668f.png\")
\n \n\n @ts-ghost/admin-api
\n\n \n @ts-ghost/admin-api is a strongly-typed TypeScript client to interract with the Ghost Admin API.\n
\n
\n
\n Documentation – Twitter\n
\n\n \n\n @ts-ghost/admin-api\n @ts-ghost/admin-api is a strongly-typed TypeScript client to interract with the Ghost Admin API.\n
\n
\n
\n Documentation – Twitter\n
\n![\"GitHub](\"https://img.shields.io/github/package-json/v/PhilDL/ts-ghost?filename=packages%2Fts-ghost-admin-api%2Fpackage.json\")
\n\n# Introduction\n\n`@ts-ghost/admin-api` provides a strongly-typed TypeScript client to interract with the Ghost Admin API based on [Zod](https://github.com/colinhacks/zod) schemas passed through all operations on composed API endpoints, `read`, `browse`, `add`, `edit` and `delete`.\n\nThis client gives you Type-Safety in the **inputs and outputs** of your Ghost API calls, usable in the browser (not recommended since you will probably expose your Admin API Key) or in Node.js.\n\nIt is made to interract with the Ghost Admin API with authentication by key. File uploads are not supported yet.\n\n\n\n## Requirements\n\nThis client is only compatible with Ghost versions 5.x and 6x.\n\n- Ghost 5.^ (Any Ghost version after 5.0)\n- Ghost 6.^ (Any Ghost version after 6.0)\n- Node.js 16+\n - We rely on global `fetch` being available, so you can bring your own\n polyfill and if you run Node 16, you'll need to run with the\n `--experimental-fetch` flag enabled.\n- TypeScript 5+, the lib make usage of const in generics and other TS5+ features.\n\nHello from ts-ghost
\",\n tags: [{ name: \"ts-ghost\" }],\n tiers: [{ name: \"ts-ghost\" }],\n custom_excerpt: \"This is custom excerpt from ts-ghost\",\n meta_title: \"Meta Title from ts-ghost\",\n meta_description: \"Description from ts-ghost\",\n featured: true,\n og_title: \"OG Title from ts-ghost\",\n og_description: \"OG Description from ts-ghost\",\n twitter_title: \"Twitter Title from ts-ghost\",\n twitter_description: \"Twitter Description from ts-ghost\",\n visibility: \"public\",\n slug: \"foobarbaz\",\n});\n\nif (!adding.success) {\n console.error(adding.errors);\n throw new Error(\"Failed to create post\");\n}\n\nconst newPost = adding.data;\n// ^? type Post\n\n// Update\nconst postEdit = await api.posts.edit(newPost.id, {\n custom_excerpt: \"Modified excerpt from ghost\",\n // This is required by Ghost to send the updated_at field with the updated_at\n // of the post you want to edit.\n updated_at: new Date(newPost.updated_at || \"\"),\n});\n\nif (!postEdit.success) {\n console.error(postEdit.errors);\n throw new Error(\"Failed to edit post\");\n}\n\nconst editedPost = postEdit.data;\n// ^? type Post\n\n// Delete\nconst postDelete = await api.posts.delete(editedPost.id);\nif (!postDelete.success) {\n console.error(postDelete.errors);\n throw new Error(\"Failed to delete post\");\n}\n```\n\n