@spike-forms/sdk 0.2.0

package/README.md

@@ -0,0 +1,89 @@
+# @spike-forms/sdk
+
+TypeScript SDK for the Spike Forms API.
+
+## Installation
+
+```bash
+npm install @spike-forms/sdk
+# or
+pnpm add @spike-forms/sdk
+# or
+yarn add @spike-forms/sdk
+```
+
+## Quick Start
+
+```typescript
+import { SpikeClient } from '@spike-forms/sdk';
+
+// Initialize the client with your API key
+const client = new SpikeClient({
+  apiKey: 'sk_your_api_key_here',
+});
+
+// List all forms
+const forms = await client.forms.list();
+
+// Create a new form
+const form = await client.forms.create({
+  name: 'Contact Form',
+});
+
+// Get form submissions
+const submissions = await client.submissions.list(form.id);
+```
+
+## Configuration
+
+```typescript
+const client = new SpikeClient({
+  apiKey: 'sk_your_api_key_here',
+  baseUrl: 'https://spike.ac', // Optional, defaults to https://spike.ac
+  timeout: 30000, // Optional, defaults to 30000ms
+});
+```
+
+## Resources
+
+The SDK provides access to the following resources:
+
+- `client.forms` - Manage forms
+- `client.submissions` - Manage form submissions
+- `client.rules` - Manage form rules
+- `client.projects` - Manage projects
+- `client.teams` - Manage teams and members
+- `client.user` - Manage user profile and settings
+- `client.billing` - Manage billing and subscriptions
+- `client.files` - Manage uploaded files
+
+## Error Handling
+
+The SDK throws specific error types for different error conditions:
+
+```typescript
+import { 
+  SpikeError,
+  AuthenticationError,
+  NotFoundError,
+  RateLimitError,
+  ValidationError,
+  NetworkError,
+} from '@spike-forms/sdk';
+
+try {
+  await client.forms.get('non-existent-id');
+} catch (error) {
+  if (error instanceof NotFoundError) {
+    console.log('Form not found');
+  } else if (error instanceof AuthenticationError) {
+    console.log('Invalid API key');
+  } else if (error instanceof RateLimitError) {
+    console.log(`Rate limited. Retry after ${error.retryAfter} seconds`);
+  }
+}
+```
+
+## License
+
+MIT