@kookee/sdk 0.0.1 → 0.0.3

package/README.md

@@ -1,6 +1,6 @@
 # @kookee/sdk
 
-Official SDK for Kookee - Access your blog, changelog, help center, forms, and announcements.
+Official SDK for Kookee - Access your blog content via a simple API.
 
 ## Installation
 
@@ -18,7 +18,7 @@ yarn add @kookee/sdk
 import { Kookee } from '@kookee/sdk';
 
 const kookee = new Kookee({
-  projectId: 'your-project-id',
+  apiKey: 'your-api-key',
 });
 
 // Fetch blog posts
@@ -28,79 +28,70 @@ const posts = await kookee.blog.list({ limit: 10 });
 const post = await kookee.blog.getBySlug('hello-world');
 ```
 
-## Features
-
-### Blog
+## Blog
 
 ```typescript
 // List posts with pagination
-const posts = await kookee.blog.list({ limit: 10, offset: 0 });
+const posts = await kookee.blog.list({ page: 1, limit: 10 });
 
-// Filter by tag
+// Filter by tag slug
 const taggedPosts = await kookee.blog.list({ tag: 'news' });
 
-// Get single post
+// Search posts
+const searchResults = await kookee.blog.list({ search: 'tutorial' });
+
+// Get single post by slug
 const post = await kookee.blog.getBySlug('my-post');
 
-// Get all tags
+// Get single post by ID
+const postById = await kookee.blog.getById('post-uuid');
+
+// Get all tags with post counts
 const tags = await kookee.blog.getTags();
 ```
 
-### Changelog
+## Response Types
 
-```typescript
-// List changelog entries
-const entries = await kookee.changelog.list();
-
-// Filter by type
-const features = await kookee.changelog.list({ type: 'feature' });
-
-// Get single entry
-const entry = await kookee.changelog.getBySlug('v1.0.0');
-```
-
-### Help Center
+### BlogPostListItem (returned by `list()`)
 
 ```typescript
-// List categories
-const categories = await kookee.helpCenter.listCategories();
-
-// List articles
-const articles = await kookee.helpCenter.listArticles();
-
-// Filter by category
-const gettingStarted = await kookee.helpCenter.listArticles({
-  categorySlug: 'getting-started',
-});
-
-// Search articles
-const results = await kookee.helpCenter.search('how to');
-
-// Get single article
-const article = await kookee.helpCenter.getArticleBySlug('installation');
+interface BlogPostListItem {
+  id: string;
+  slug: string;
+  title: string;
+  excerptHtml: string | null;
+  coverImageUrl: string | null;
+  status: string;
+  publishedAt: string | null;
+  metadata: Record<string, unknown> | null;
+  createdAt: string;
+  author: { name: string };
+  tags: Array<{ name: string; slug: string }>;
+}
 ```
 
-### Forms
+### BlogPost (returned by `getBySlug()` and `getById()`)
 
 ```typescript
-// Get form structure
-const form = await kookee.forms.get('contact');
-
-// Submit form
-const result = await kookee.forms.submit('contact', {
-  email: 'user@example.com',
-  message: 'Hello!',
-});
+interface BlogPost extends BlogPostListItem {
+  contentHtml: string;
+  metaTitle: string | null;
+  metaDescription: string | null;
+  updatedAt: string;
+}
 ```
 
-### Announcements
+### Paginated Response
 
 ```typescript
-// Get active announcements
-const announcements = await kookee.announcements.getActive();
-
-// Filter by type
-const banners = await kookee.announcements.getActive({ type: 'banner' });
+interface PaginatedResponse<T> {
+  data: T[];
+  total: number;
+  limit: number;
+  offset: number;
+  page: number;
+  totalPages: number;
+}
 ```
 
 ## Error Handling
@@ -118,12 +109,21 @@ try {
 }
 ```
 
+## Configuration
+
+```typescript
+const kookee = new Kookee({
+  apiKey: 'your-api-key',
+  baseUrl: 'https://api.kookee.dev', // optional, defaults to production API
+});
+```
+
 ## TypeScript
 
 The SDK is written in TypeScript and provides full type definitions:
 
 ```typescript
-import type { BlogPost, ChangelogEntry, HelpArticle } from '@kookee/sdk';
+import type { BlogPost, BlogPostListItem, BlogTag, PaginatedResponse } from '@kookee/sdk';
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kookee/sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Official Kookee SDK - Access your blog, changelog, help center, and more",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -29,12 +29,15 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "https://github.com/kookee/sdk"
+    "url": "https://github.com/kookee-dot-dev/kookee-ts-sdk"
   },
   "homepage": "https://kookee.dev",
   "devDependencies": {
-    "@repo/typescript-config": "0.0.0",
-    "@repo/eslint-config": "0.0.0"
+    "@types/node": "^22.10.2",
+    "eslint": "^9.17.0",
+    "tsup": "^8.3.5",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.2"
   },
   "publishConfig": {
     "access": "public"
@@ -43,6 +46,6 @@
   "scripts": {
     "build": "tsup",
     "dev": "tsup --watch",
-    "lint": "tsc --project tsconfig.json --noEmit && eslint . --max-warnings 0"
+    "lint": "tsc --noEmit && eslint ."
   }
 }