@edpear/sdk 1.1.6 → 1.3.0

package/dist/index.js

@@ -1,4 +1,18 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -6,6 +20,17 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.EdPearClient = void 0;
 exports.createEdPearClient = createEdPearClient;
 const axios_1 = __importDefault(require("axios"));
+const debugMathSolution_1 = require("./features/debugMathSolution");
+const verifyRealWorldConcept_1 = require("./features/verifyRealWorldConcept");
+const checkLabSetup_1 = require("./features/checkLabSetup");
+const generateSpatialFlashcards_1 = require("./features/generateSpatialFlashcards");
+const whiteboardToCode_1 = require("./features/whiteboardToCode");
+const gradeVisualRubric_1 = require("./features/gradeVisualRubric");
+const reduceCognitiveLoad_1 = require("./features/reduceCognitiveLoad");
+const translateManipulatives_1 = require("./features/translateManipulatives");
+const analyzeHistoricalArtifact_1 = require("./features/analyzeHistoricalArtifact");
+const storyboardToOutline_1 = require("./features/storyboardToOutline");
+__exportStar(require("./features/types"), exports);
 class EdPearClient {
     constructor(config) {
         this.apiKey = config.apiKey;
@@ -73,6 +98,92 @@ class EdPearClient {
             throw new Error(`Failed to get account status: ${error.message}`);
         }
     }
+    // ─── Helper ──────────────────────────────────────────────────────────────────
+    parseJsonResult(raw) {
+        // Strip markdown code fences if present
+        const cleaned = raw.replace(/^```(?:json)?\s*/i, '').replace(/\s*```\s*$/, '').trim();
+        return JSON.parse(cleaned);
+    }
+    // ─── Feature 1: debugMathSolution ────────────────────────────────────────────
+    /**
+     * Analyzes a photo of multi-step handwritten math and pinpoints the exact line
+     * containing an error, returning the correct formula and an explanation.
+     */
+    async debugMathSolution(image) {
+        return (0, debugMathSolution_1.debugMathSolution)(this.analyzeImage.bind(this), image);
+    }
+    // ─── Feature 2: verifyRealWorldConcept ───────────────────────────────────────
+    /**
+     * Validates whether a user's photograph visually demonstrates a specific
+     * physics or geometry concept (e.g. "acute angle", "tension", "buoyancy").
+     */
+    async verifyRealWorldConcept(image, concept) {
+        return (0, verifyRealWorldConcept_1.verifyRealWorldConcept)(this.analyzeImage.bind(this), image, concept);
+    }
+    // ─── Feature 3: checkLabSetup ─────────────────────────────────────────────────
+    /**
+     * Verifies physical lab equipment or circuit wiring against an expected
+     * experiment type, reporting safety issues and correctness problems.
+     */
+    async checkLabSetup(image, experimentType) {
+        return (0, checkLabSetup_1.checkLabSetup)(this.analyzeImage.bind(this), image, experimentType);
+    }
+    // ─── Feature 4: generateSpatialFlashcards ────────────────────────────────────
+    /**
+     * Takes a complex educational diagram and returns an array of image-occlusion
+     * style flashcard prompts keyed to specific regions of the diagram.
+     */
+    async generateSpatialFlashcards(image) {
+        return (0, generateSpatialFlashcards_1.generateSpatialFlashcards)(this.analyzeImage.bind(this), image);
+    }
+    // ─── Feature 5: whiteboardToCode ─────────────────────────────────────────────
+    /**
+     * Translates whiteboard content: equations → LaTeX, flowcharts → Python
+     * pseudocode, or other formats as specified by `targetFormat`.
+     */
+    async whiteboardToCode(image, targetFormat = 'latex') {
+        return (0, whiteboardToCode_1.whiteboardToCode)(this.analyzeImage.bind(this), image, targetFormat);
+    }
+    // ─── Feature 6: gradeVisualRubric ────────────────────────────────────────────
+    /**
+     * Evaluates a creative or technical drawing against an array of rubric
+     * constraint strings (e.g. ["has vanishing point", "uses hatching for shade"]).
+     */
+    async gradeVisualRubric(image, rubricConstraints) {
+        return (0, gradeVisualRubric_1.gradeVisualRubric)(this.analyzeImage.bind(this), image, rubricConstraints);
+    }
+    // ─── Feature 7: reduceCognitiveLoad ──────────────────────────────────────────
+    /**
+     * Extracts dense textbook or whiteboard text from an image and reformats it
+     * into high-contrast, bulleted, dyslexia-friendly markdown.
+     */
+    async reduceCognitiveLoad(image) {
+        return (0, reduceCognitiveLoad_1.reduceCognitiveLoad)(this.analyzeImage.bind(this), image);
+    }
+    // ─── Feature 8: translateManipulatives ───────────────────────────────────────
+    /**
+     * Analyzes physical educational manipulative blocks or arrangements on a desk
+     * (e.g. base-10 blocks, fraction tiles) and returns a digital state object.
+     */
+    async translateManipulatives(image) {
+        return (0, translateManipulatives_1.translateManipulatives)(this.analyzeImage.bind(this), image);
+    }
+    // ─── Feature 9: analyzeHistoricalArtifact ────────────────────────────────────
+    /**
+     * Acts as an AR museum docent: identifies a historical artifact, artwork, or
+     * primary source document and returns rich contextual information.
+     */
+    async analyzeHistoricalArtifact(image) {
+        return (0, analyzeHistoricalArtifact_1.analyzeHistoricalArtifact)(this.analyzeImage.bind(this), image);
+    }
+    // ─── Feature 10: storyboardToOutline ─────────────────────────────────────────
+    /**
+     * Converts a photo of sticky-note storyboards or hand-drawn mind maps into a
+     * structured, hierarchical JSON outline.
+     */
+    async storyboardToOutline(image) {
+        return (0, storyboardToOutline_1.storyboardToOutline)(this.analyzeImage.bind(this), image);
+    }
 }
 exports.EdPearClient = EdPearClient;
 // Convenience function for quick setup

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;AAoGA,gDAEC;AAtGD,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,mCAAmC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAsB;QACvC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,OAAsD;QAC/E,OAAO,IAAI,CAAC,cAAc,CAAC;YACzB,MAAM;YACN,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAsB;QACjD,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;AA3ED,oCA2EC;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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAwOA,gDAEC;AA1OD,kDAA6C;AAa7C,oEAAuF;AACvF,8EAAsG;AACtG,4DAA2E;AAC3E,oFAA+G;AAC/G,kEAAoF;AACpF,oEAAuF;AACvF,wEAA6F;AAC7F,8EAAsG;AACtG,oFAA+G;AAC/G,wEAA6F;AAE7F,mDAAiC;AAsBjC,MAAa,YAAY;IAIvB,YAAY,MAAoB;QAC9B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC5B,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,mCAAmC,CAAC;IACvE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAAC,OAAsB;QACvC,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAAc,EAAE,OAAsD;QAC/E,OAAO,IAAI,CAAC,cAAc,CAAC;YACzB,MAAM;YACN,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;IAEO,KAAK,CAAC,cAAc,CAAC,OAAsB;QACjD,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;IAED,gFAAgF;IAExE,eAAe,CAAI,GAAW;QACpC,wCAAwC;QACxC,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,mBAAmB,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAM,CAAC;IAClC,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAa;QACnC,OAAO,IAAA,qCAAkB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACjE,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,KAAa,EAAE,OAAe;QACzD,OAAO,IAAA,+CAAuB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,OAAO,CAAC,CAAC;IAC/E,CAAC;IAED,iFAAiF;IAEjF;;;OAGG;IACH,KAAK,CAAC,aAAa,CAAC,KAAa,EAAE,cAAsB;QACvD,OAAO,IAAA,6BAAc,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;IAC7E,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,KAAa;QAC3C,OAAO,IAAA,qDAA0B,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,KAAa,EAAE,eAAuB,OAAO;QAClE,OAAO,IAAA,mCAAiB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,YAAY,CAAC,CAAC;IAC9E,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,iBAAiB,CAAC,KAAa,EAAE,iBAA2B;QAChE,OAAO,IAAA,qCAAkB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,iBAAiB,CAAC,CAAC;IACpF,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,KAAa;QACrC,OAAO,IAAA,yCAAoB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,sBAAsB,CAAC,KAAa;QACxC,OAAO,IAAA,+CAAuB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACtE,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,yBAAyB,CAAC,KAAa;QAC3C,OAAO,IAAA,qDAA0B,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACzE,CAAC;IAED,gFAAgF;IAEhF;;;OAGG;IACH,KAAK,CAAC,mBAAmB,CAAC,KAAa;QACrC,OAAO,IAAA,yCAAoB,EAAC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;IACnE,CAAC;CACF;AAvLD,oCAuLC;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

@@ -1,53 +1,53 @@
-{
-  "name": "@edpear/sdk",
-  "version": "1.1.6",
-  "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": {
-    "@edpear/sdk": "^1.1.5",
-    "axios": "^1.6.2",
-    "chalk": "^4.1.2",
-    "commander": "^11.1.0",
-    "dotenv": "^16.6.1",
-    "fs-extra": "^11.3.3",
-    "inquirer": "^9.3.8",
-    "open": "^8.4.2",
-    "ora": "^5.4.1"
-  },
-  "devDependencies": {
-    "@types/fs-extra": "^11.0.4",
-    "@types/inquirer": "^9.0.9",
-    "@types/node": "^20.0.0",
-    "typescript": "^5.0.0"
-  },
-  "bin": {
-    "edpear": "dist/cli.js"
-  },
-  "files": [
-    "dist"
-  ]
-}
+{
+  "name": "@edpear/sdk",
+  "version": "1.3.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": {
+    "@edpear/sdk": "^1.1.6",
+    "axios": "^1.6.2",
+    "chalk": "^4.1.2",
+    "commander": "^11.1.0",
+    "dotenv": "^16.6.1",
+    "fs-extra": "^11.3.3",
+    "inquirer": "^9.3.8",
+    "open": "^8.4.2",
+    "ora": "^5.4.1"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/inquirer": "^9.0.9",
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  },
+  "bin": {
+    "edpear": "dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ]
+}