@edpear/sdk 1.0.0

package/README.md

@@ -0,0 +1,239 @@
+# EdPear SDK
+
+JavaScript/TypeScript SDK for EdPear - AI-powered educational components.
+
+## Installation
+
+```bash
+npm install @edpear/sdk
+```
+
+## Quick Start
+
+```javascript
+const { EdPearClient } = require('@edpear/sdk');
+
+const client = new EdPearClient({
+  apiKey: process.env.EDPEAR_API_KEY
+});
+
+// Analyze an image
+const result = await client.analyzeImage({
+  image: base64Image,
+  prompt: "Analyze this textbook page and explain the main concepts"
+});
+
+console.log(result.result);
+```
+
+## API Reference
+
+### EdPearClient
+
+#### Constructor
+
+```javascript
+const client = new EdPearClient({
+  apiKey: string,        // Required: Your EdPear API key
+  baseURL?: string       // Optional: API base URL (default: https://api.edpear.com)
+});
+```
+
+#### Methods
+
+##### analyzeImage(request)
+
+Analyze an image using EdPear's Vision AI.
+
+**Parameters:**
+- `request.image` (string): Base64 encoded image
+- `request.prompt` (string): Analysis prompt
+- `request.maxTokens` (number, optional): Maximum tokens in response (default: 1000)
+- `request.temperature` (number, optional): Response creativity (0-1, default: 0.7)
+
+**Returns:** Promise<VisionResponse>
+
+**Example:**
+```javascript
+const result = await client.analyzeImage({
+  image: 'data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ...',
+  prompt: 'Create a study guide from this textbook page',
+  maxTokens: 1200,
+  temperature: 0.7
+});
+
+console.log(result.result);
+console.log(`Credits used: ${result.creditsUsed}`);
+```
+
+##### getStatus()
+
+Get account status and remaining credits.
+
+**Returns:** Promise<{credits: number, user: any}>
+
+**Example:**
+```javascript
+const status = await client.getStatus();
+console.log(`Credits remaining: ${status.credits}`);
+```
+
+## Types
+
+### VisionRequest
+
+```typescript
+interface VisionRequest {
+  image: string;           // Base64 encoded image
+  prompt: string;          // Analysis prompt
+  maxTokens?: number;   // Maximum tokens (optional)
+  temperature?: number;   // Response creativity 0-1 (optional)
+}
+```
+
+### VisionResponse
+
+```typescript
+interface VisionResponse {
+  success: boolean;        // Request success status
+  result: string;         // Analysis result
+  creditsUsed: number;     // Credits consumed
+  remainingCredits: number; // Credits remaining
+  processingTime: number;  // Processing time in ms
+}
+```
+
+## Examples
+
+### Basic Image Analysis
+
+```javascript
+const fs = require('fs');
+const { EdPearClient } = require('@edpear/sdk');
+
+const client = new EdPearClient({
+  apiKey: process.env.EDPEAR_API_KEY
+});
+
+async function analyzeTextbook() {
+  // Read image file
+  const imageBuffer = fs.readFileSync('./textbook-page.jpg');
+  const base64Image = imageBuffer.toString('base64');
+
+  // Analyze image
+  const result = await client.analyzeImage({
+    image: base64Image,
+    prompt: "Analyze this textbook page and create a study guide with key concepts, formulas, and practice questions."
+  });
+
+  console.log('Study Guide:');
+  console.log(result.result);
+  console.log(`\nCredits used: ${result.creditsUsed}`);
+}
+```
+
+### Batch Processing
+
+```javascript
+async function analyzeMultiplePages(imagePaths, subject) {
+  const results = [];
+  
+  for (const imagePath of imagePaths) {
+    const imageBuffer = fs.readFileSync(imagePath);
+    const base64Image = imageBuffer.toString('base64');
+    
+    const result = await client.analyzeImage({
+      image: base64Image,
+      prompt: `Analyze this ${subject} page and extract key concepts, formulas, and examples.`
+    });
+    
+    results.push(result);
+    
+    // Add delay to avoid rate limiting
+    await new Promise(resolve => setTimeout(resolve, 1000));
+  }
+  
+  return results;
+}
+```
+
+### Error Handling
+
+```javascript
+async function safeAnalyze(image, prompt) {
+  try {
+    const result = await client.analyzeImage({ image, prompt });
+    return result;
+  } catch (error) {
+    if (error.message.includes('Invalid API key')) {
+      console.error('Please check your API key');
+    } else if (error.message.includes('Insufficient credits')) {
+      console.error('Please add more credits to your account');
+    } else {
+      console.error('Analysis failed:', error.message);
+    }
+    throw error;
+  }
+}
+```
+
+## Use Cases
+
+### Educational Content Analysis
+
+- **Textbook Pages**: Extract key concepts, formulas, and examples
+- **Handwritten Notes**: Convert to structured, searchable content
+- **Diagrams**: Analyze and explain complex diagrams
+- **Charts**: Extract data and insights from educational charts
+
+### Study Material Generation
+
+- **Study Guides**: Create comprehensive study materials
+- **Quiz Generation**: Generate questions from content
+- **Summaries**: Create concise summaries of long content
+- **Flashcards**: Generate flashcards from educational material
+
+### Learning Assessment
+
+- **Content Understanding**: Assess student understanding of material
+- **Progress Tracking**: Track learning progress over time
+- **Personalized Learning**: Adapt content to individual needs
+
+## Best Practices
+
+### Image Preparation
+
+- Use high-quality images (minimum 300x300 pixels)
+- Ensure good contrast and readability
+- Avoid heavily compressed images
+- Use standard formats (JPEG, PNG)
+
+### Prompt Engineering
+
+- Be specific about what you want analyzed
+- Include context about the subject matter
+- Ask for structured output when needed
+- Use clear, educational language
+
+### Rate Limiting
+
+- Add delays between requests (1-2 seconds)
+- Monitor your credit usage
+- Use batch processing for multiple images
+- Implement retry logic for failed requests
+
+## Error Codes
+
+| Error | Description | Solution |
+|-------|-------------|----------|
+| 401 | Invalid API key | Check your API key |
+| 402 | Insufficient credits | Add credits to your account |
+| 400 | Bad request | Check your request parameters |
+| 429 | Rate limited | Reduce request frequency |
+| 500 | Server error | Try again later |
+
+## Support
+
+- Documentation: [https://docs.edpear.com](https://docs.edpear.com)
+- Support: [support@edpear.com](mailto:support@edpear.com)
+- GitHub Issues: [https://github.com/edpear/sdk/issues](https://github.com/edpear/sdk/issues)

package/dist/index.d.ts

@@ -0,0 +1,39 @@
+export interface VisionRequest {
+    image: string;
+    prompt: string;
+    maxTokens?: number;
+    temperature?: number;
+}
+export interface VisionResponse {
+    success: boolean;
+    result: string;
+    creditsUsed: number;
+    remainingCredits: number;
+    processingTime: number;
+}
+export interface EdPearConfig {
+    apiKey: string;
+    baseURL?: string;
+}
+export declare class EdPearClient {
+    private apiKey;
+    private baseURL;
+    constructor(config: EdPearConfig);
+    /**
+     * Analyze an image using EdPear's Vision AI
+     * @param request - The vision request containing image and prompt
+     * @returns Promise<VisionResponse>
+     */
+    analyzeImage(request: VisionRequest): Promise<VisionResponse>;
+    /**
+     * Get account status and remaining credits
+     * @returns Promise<{credits: number, user: any}>
+     */
+    getStatus(): Promise<{
+        credits: number;
+        user: any;
+    }>;
+}
+export declare function createEdPearClient(apiKey: string, baseURL?: string): EdPearClient;
+export default EdPearClient;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,MAAM,CAAS;IACvB,OAAO,CAAC,OAAO,CAAS;gBAEZ,MAAM,EAAE,YAAY;IAKhC;;;;OAIG;IACG,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IA2BnE;;;OAGG;IACG,SAAS,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,GAAG,CAAA;KAAE,CAAC;CAa3D;AAGD,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,YAAY,CAEjF;AAGD,eAAe,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,69 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EdPearClient = void 0;
+exports.createEdPearClient = createEdPearClient;
+const axios_1 = __importDefault(require("axios"));
+class EdPearClient {
+    constructor(config) {
+        this.apiKey = config.apiKey;
+        this.baseURL = config.baseURL || 'https://api.edpear.com';
+    }
+    /**
+     * Analyze an image using EdPear's Vision AI
+     * @param request - The vision request containing image and prompt
+     * @returns Promise<VisionResponse>
+     */
+    async analyzeImage(request) {
+        try {
+            const response = await axios_1.default.post(`${this.baseURL}/api/vision`, request, {
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': this.apiKey,
+                },
+            });
+            return response.data;
+        }
+        catch (error) {
+            if (error.response?.status === 401) {
+                throw new Error('Invalid API key. Please check your EdPear API key.');
+            }
+            else if (error.response?.status === 402) {
+                throw new Error('Insufficient credits. Please add more credits to your account.');
+            }
+            else if (error.response?.status === 400) {
+                throw new Error(`Bad request: ${error.response.data.error}`);
+            }
+            else {
+                throw new Error(`API request failed: ${error.message}`);
+            }
+        }
+    }
+    /**
+     * Get account status and remaining credits
+     * @returns Promise<{credits: number, user: any}>
+     */
+    async getStatus() {
+        try {
+            const response = await axios_1.default.get(`${this.baseURL}/api/user/status`, {
+                headers: {
+                    'x-api-key': this.apiKey,
+                },
+            });
+            return response.data;
+        }
+        catch (error) {
+            throw new Error(`Failed to get account status: ${error.message}`);
+        }
+    }
+}
+exports.EdPearClient = EdPearClient;
+// Convenience function for quick setup
+function createEdPearClient(apiKey, baseURL) {
+    return new EdPearClient({ apiKey, baseURL });
+}
+// Default export
+exports.default = EdPearClient;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAmFA,gDAEC;AArFD,kDAA6C;AAsB7C,MAAa,YAAY;IAIvB,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,wBAAwB,CAAC;IAC5D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAsB;QACvC,IAAI,CAAC;YACH,MAAM,QAAQ,GAAkC,MAAM,eAAK,CAAC,IAAI,CAC9D,GAAG,IAAI,CAAC,OAAO,aAAa,EAC5B,OAAO,EACP;gBACE,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,WAAW,EAAE,IAAI,CAAC,MAAM;iBACzB;aACF,CACF,CAAC;YAEF,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBACnC,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;YACxE,CAAC;iBAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAC;YACpF,CAAC;iBAAM,IAAI,KAAK,CAAC,QAAQ,EAAE,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC1C,MAAM,IAAI,KAAK,CAAC,gBAAgB,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;YAC/D,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CAAC,uBAAuB,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC1D,CAAC;QACH,CAAC;IACH,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,SAAS;QACb,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,MAAM,eAAK,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,kBAAkB,EAAE;gBAClE,OAAO,EAAE;oBACP,WAAW,EAAE,IAAI,CAAC,MAAM;iBACzB;aACF,CAAC,CAAC;YAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;QACvB,CAAC;QAAC,OAAO,KAAU,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,iCAAiC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;CACF;AA1DD,oCA0DC;AAED,uCAAuC;AACvC,SAAgB,kBAAkB,CAAC,MAAc,EAAE,OAAgB;IACjE,OAAO,IAAI,YAAY,CAAC,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;AAC/C,CAAC;AAED,iBAAiB;AACjB,kBAAe,YAAY,CAAC"}

package/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@edpear/sdk",
+  "version": "1.0.0",
+  "description": "EdPear SDK - AI-powered educational components for JavaScript/TypeScript",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "edpear",
+    "ai",
+    "education",
+    "vision",
+    "sdk"
+  ],
+  "author": "EdPear",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/edpear/edpearofficial.git",
+    "directory": "edpear-sdk"
+  },
+  "homepage": "https://edpear.com",
+  "bugs": {
+    "url": "https://github.com/edpear/edpearofficial/issues"
+  },
+  "dependencies": {
+    "axios": "^1.6.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "files": [
+    "dist"
+  ]
+}