projects-plus-sdk 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Projects Plus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,228 @@
+# projects-plus-sdk
+
+Official SDK for Projects Plus API - Type-safe API client for AI-driven development workflows.
+
+## Installation
+
+```bash
+npm install projects-plus-sdk
+```
+
+## Quick Start
+
+```typescript
+import { ProjectsPlus } from 'projects-plus-sdk';
+
+const pp = new ProjectsPlus({
+  apiKey: process.env.PROJECTS_PLUS_API_KEY,
+});
+
+// Start session
+await pp.sessions.start({ ai: 'claude' });
+
+// Get context
+const context = await pp.context.get();
+console.log(context.theme.name);
+console.log(context.projects);
+
+// List active tasks
+const tasks = await pp.tasks.list({ status: 'active' });
+
+// Add comment
+await pp.comments.create({
+  projectId: 'proj-id',
+  taskId: 'task-id',
+  content: '## Done\n\nImplemented feature X',
+  aiName: 'Claude',
+});
+
+// Complete task
+await pp.tasks.complete('task-id', { projectId: 'proj-id' });
+
+// End session
+await pp.sessions.end({ handoffNote: 'Summary...' });
+```
+
+## Workflow Helper
+
+For common development patterns, use the workflow helper:
+
+```typescript
+const workflow = pp.workflow({ ai: 'claude' });
+
+// Start session and get context in one call
+const { session, context } = await workflow.start();
+
+// Report progress with auto-formatted markdown
+await workflow.reportProgress('task-id', {
+  projectId: 'proj-id',
+  changes: ['file1.ts', 'file2.ts'],
+  testResults: { passed: 10, failed: 0 },
+  note: 'Optional notes',
+});
+
+// Complete task and refresh context
+const newContext = await workflow.completeAndRefresh('task-id', {
+  projectId: 'proj-id',
+});
+
+// End session
+await workflow.end('Summary of completed work');
+```
+
+## API Reference
+
+### Context
+
+```typescript
+// Get theme context including all projects and tasks
+const context = await pp.context.get();
+```
+
+### Sessions
+
+```typescript
+// Start session
+const session = await pp.sessions.start({ ai: 'claude' });
+
+// End session
+const endedSession = await pp.sessions.end({
+  handoffNote: 'Completed tasks X, Y, Z',
+});
+
+// Get current session
+const current = await pp.sessions.current();
+```
+
+### Tasks
+
+```typescript
+// List tasks
+const tasks = await pp.tasks.list({ status: 'active' });
+const projectTasks = await pp.tasks.list({
+  projectId: 'proj-id',
+  status: 'active',
+});
+
+// Get task
+const task = await pp.tasks.get('task-id', { projectId: 'proj-id' });
+
+// Complete task
+await pp.tasks.complete('task-id', { projectId: 'proj-id' });
+
+// Update status
+await pp.tasks.updateStatus('task-id', {
+  projectId: 'proj-id',
+  status: 'paused',
+});
+```
+
+### Projects
+
+```typescript
+// List projects
+const projects = await pp.projects.list();
+const activeProjects = await pp.projects.list({ status: 'active' });
+
+// Get project
+const project = await pp.projects.get('proj-id');
+
+// Get project tasks
+const tasks = await pp.projects.getTasks('proj-id');
+```
+
+### Comments
+
+```typescript
+// List comments
+const comments = await pp.comments.list({
+  projectId: 'proj-id',
+  taskId: 'task-id',
+});
+
+// Create comment
+await pp.comments.create({
+  projectId: 'proj-id',
+  taskId: 'task-id',
+  content: 'Comment content',
+  aiName: 'Claude',
+});
+
+// Delete comment
+await pp.comments.delete('comment-id', {
+  projectId: 'proj-id',
+  taskId: 'task-id',
+});
+```
+
+## Error Handling
+
+```typescript
+import {
+  ProjectsPlus,
+  ApiError,
+  RateLimitError,
+  AuthenticationError,
+  NotFoundError,
+} from 'projects-plus-sdk';
+
+try {
+  await pp.tasks.complete('task-id', { projectId: 'proj-id' });
+} catch (error) {
+  if (error instanceof RateLimitError) {
+    console.log(`Rate limited. Retry after ${error.retryAfter} seconds`);
+  } else if (error instanceof AuthenticationError) {
+    console.log('Invalid API key');
+  } else if (error instanceof NotFoundError) {
+    console.log('Resource not found');
+  } else if (error instanceof ApiError) {
+    console.log(`API error: ${error.status} - ${error.message}`);
+  }
+}
+```
+
+## Configuration
+
+```typescript
+const pp = new ProjectsPlus({
+  apiKey: 'your-api-key',          // Required
+  baseUrl: 'https://...',          // Optional: Custom API endpoint
+  timeout: 30000,                  // Optional: Request timeout (ms)
+  retries: 3,                      // Optional: Max retry attempts
+  retryDelay: 1000,                // Optional: Initial retry delay (ms)
+});
+```
+
+## TypeScript Support
+
+The SDK is written in TypeScript and provides full type definitions:
+
+```typescript
+import type {
+  Task,
+  Project,
+  Comment,
+  Session,
+  ThemeContext,
+  TaskStatus,
+  ProjectStatus,
+} from 'projects-plus-sdk';
+```
+
+## Environment Variables
+
+Recommended: Store your API key in environment variables:
+
+```bash
+export PROJECTS_PLUS_API_KEY=pp_live_xxx_yyy
+```
+
+```typescript
+const pp = new ProjectsPlus({
+  apiKey: process.env.PROJECTS_PLUS_API_KEY!,
+});
+```
+
+## License
+
+MIT