codequiry 2.0.1 → 2.1.0

package/README.md

@@ -1,123 +1,158 @@
-# Codequiry - Node.js SDK
-
-Official Node.js SDK for [Codequiry's](https://codequiry.com) Code Plagiarism & Similarity Detection API.
-
-Check source code files against billions of web sources, public repositories, and peer submissions. Supports 65+ programming languages.
-
-## Installation
-
-```bash
-npm install codequiry
-```
-
-## Quick Start
-
-```javascript
-const Codequiry = require('codequiry');
-
-const cq = new Codequiry('YOUR_API_KEY');
-
-// Create a check, upload files, start, and get results
-async function run() {
-  // Create a check (language 14 = Python)
-  const check = await cq.createCheck('Assignment 1', 14);
-  console.log('Created:', check);
-
-  // Upload a zip file
-  await cq.uploadFile(check.check.id, './submissions.zip');
-
-  // Start the check
-  await cq.startCheck(check.check.id, { dbcheck: true });
-
-  // Poll until complete
-  const status = await cq.pollUntilComplete(check.check.id, {
-    onProgress: (s) => console.log('Progress:', s),
-  });
-
-  // Get results
-  const overview = await cq.getOverview(check.check.id);
-  console.log('Results:', overview);
-}
-
-run().catch(console.error);
-```
-
-## API Reference
-
-### Constructor
-
-```javascript
-const cq = new Codequiry('YOUR_API_KEY');
-```
-
-### Account
-
-| Method | Description |
-|--------|-------------|
-| `cq.account()` | Get account info and usage quota |
-
-### Checks
-
-| Method | Description |
-|--------|-------------|
-| `cq.checks()` | List all checks |
-| `cq.createCheck(name, languageId, testType?)` | Create a new check |
-| `cq.getCheck(checkId)` | Get check info and status |
-| `cq.deleteCheck(checkId)` | Delete a check |
-
-### Upload
-
-| Method | Description |
-|--------|-------------|
-| `cq.uploadFile(checkId, filePath)` | Upload a ZIP file |
-| `cq.uploadBatch(checkId, filePaths)` | Upload multiple ZIP files |
-
-### Start & Status
-
-| Method | Description |
-|--------|-------------|
-| `cq.startCheck(checkId, options?)` | Start a check. Options: `{ dbcheck, webcheck, testType }` |
-| `cq.getStatus(checkId)` | Get current check status |
-| `cq.pollUntilComplete(checkId, options?)` | Poll until done. Options: `{ interval, timeout, onProgress }` |
-
-### Results
-
-| Method | Description |
-|--------|-------------|
-| `cq.getOverview(checkId)` | Results overview with similarity scores |
-| `cq.getResults(checkId, submissionId)` | Detailed results for a submission |
-| `cq.getSummary(checkId)` | Summary statistics |
-
-### Reference Data
-
-| Method | Description |
-|--------|-------------|
-| `cq.getLanguages()` | List supported programming languages |
-| `cq.getTestTypes()` | List available check engine types |
-
-## Supported Languages
-
-Java, Python, C, C++, C#, Perl, PHP, SQL, VB, XML, Haskell, Pascal, Go, Matlab, Lisp, Ruby, Assembly, HTML, JavaScript/TypeScript, Swift, Kotlin, Dart, Elixir, Jupyter Notebooks, and many more.
-
-## Migration from v1
-
-v2 uses modern async/await instead of callbacks:
-
-```javascript
-// v1 (old)
-Codequiry.setAPIKey('key');
-Codequiry.checks(function(data, err) {
-  console.log(data);
-});
-
-// v2 (new)
-const cq = new Codequiry('key');
-const checks = await cq.checks();
-console.log(checks);
-```
-
-## Links
-
-- [Codequiry](https://codequiry.com)
-- [API Documentation](https://codequiry.com/usage/docs)
-- [CLI Tool](https://www.npmjs.com/package/codequiry-cli)
+# Codequiry Node.js SDK — Code Plagiarism Checker API
+
+[![npm version](https://img.shields.io/npm/v/codequiry.svg)](https://www.npmjs.com/package/codequiry)
+[![license](https://img.shields.io/npm/l/codequiry.svg)](https://github.com/cqchecker/codequiry-sdk/blob/main/LICENSE)
+[![node](https://img.shields.io/node/v/codequiry.svg)](https://www.npmjs.com/package/codequiry)
+
+Official Node.js SDK for [Codequiry](https://codequiry.com), the code plagiarism checker. Run source code plagiarism detection, peer-to-peer code similarity analysis, and AI-generated code detection from Node.js, with TypeScript definitions included.
+
+Codequiry checks submissions against billions of web sources, public repositories, and each other, across 65+ programming languages. It is used by universities, coding bootcamps, hiring teams, and competition organizers to verify code originality.
+
+- **Web plagiarism check**: match code against online sources and repositories
+- **Peer similarity check**: compare submissions against each other (group similarity)
+- **AI code detection**: flag AI-generated code (ChatGPT, Copilot, and other LLMs)
+- **Base code detection**: exclude shared starter/boilerplate code from scoring
+
+More integrations: [Codequiry CLI](https://www.npmjs.com/package/codequiry-cli) · [Codequiry MCP server for AI agents](https://codequiry.com/mcp) · [REST API docs](https://codequiry.com/usage/api)
+
+## Installation
+
+```bash
+npm install codequiry
+```
+
+Requires Node.js 14+. Get an API key from your [Codequiry dashboard](https://codequiry.com/dashboard).
+
+## Quick start
+
+The fastest way to check code for plagiarism is `checkFiles`, which creates a check, uploads your ZIPs, starts the analysis, waits for completion, and returns the results:
+
+```javascript
+const Codequiry = require('codequiry');
+
+const cq = new Codequiry(process.env.CODEQUIRY_API_KEY);
+
+const { overview, aiResults } = await cq.checkFiles('Assignment 1', ['./submissions.zip'], {
+  language: 999,   // Auto Detect (or an id from getLanguages())
+  webcheck: true,  // check against web sources
+  dbcheck: true,   // check against Codequiry's database
+  aiRun: true,     // also run AI-generated code detection
+  onProgress: (s) => console.log('status:', s.status),
+});
+
+console.log(overview);
+console.log(aiResults);
+```
+
+TypeScript works out of the box:
+
+```typescript
+import Codequiry = require('codequiry');
+const cq = new Codequiry(process.env.CODEQUIRY_API_KEY!);
+```
+
+## Step-by-step workflow
+
+If you want control over each stage:
+
+```javascript
+// 1. Create a check (999 = Auto Detect language)
+const created = await cq.createCheck('Assignment 1', 999, { aiRun: true });
+const checkId = created.check.id;
+
+// 2. Upload one or more ZIP archives (max 10 MB each)
+await cq.uploadFile(checkId, './submissions.zip');
+
+// 3. Start the analysis
+await cq.startCheck(checkId, { webcheck: true, dbcheck: true });
+
+// 4. Wait for completion
+await cq.pollUntilComplete(checkId, { onProgress: (s) => console.log(s.status) });
+
+// 5. Read results
+const overview = await cq.getOverview(checkId);          // per-submission scores
+const details = await cq.getResults(checkId, overview.submissions[0].id);
+const ai = await cq.getAIResults(checkId);               // AI detection results
+const csv = await cq.getOverviewCSV(checkId);            // overview as CSV
+```
+
+## API reference
+
+### Account
+
+| Method | Description |
+|--------|-------------|
+| `cq.validateKey()` | Validate the API key |
+| `cq.account()` | Account info and usage quota |
+| `cq.serviceStatus()` | Codequiry service status |
+
+### Checks
+
+| Method | Description |
+|--------|-------------|
+| `cq.checks()` | List all checks |
+| `cq.createCheck(name, language?, options?)` | Create a check. Options: `{ testType, aiRun, baseCodeDetection, callbackUrl }` |
+| `cq.getCheck(checkId)` | Check info and status |
+| `cq.updateCheck(checkId, { name?, language? })` | Rename or change language |
+| `cq.deleteCheck(checkId)` | Delete a check |
+| `cq.deleteSubmission(checkId, submissionId)` | Delete one submission |
+
+### Upload & start
+
+| Method | Description |
+|--------|-------------|
+| `cq.uploadFile(checkId, filePath)` | Upload a ZIP (max 10 MB) |
+| `cq.uploadBatch(checkId, filePaths)` | Upload multiple ZIPs |
+| `cq.quickCheck(name, filePaths, options?)` | Create + upload + start in one call |
+| `cq.startCheck(checkId, options?)` | Start. Options: `{ webcheck, dbcheck, testType, aiRun, baseCodeDetection }` |
+| `cq.getStatus(checkId)` | Current status (for polling) |
+
+### Results
+
+| Method | Description |
+|--------|-------------|
+| `cq.getOverview(checkId)` | Results overview (per-submission similarity scores) |
+| `cq.getOverviewCSV(checkId)` | Overview as CSV text |
+| `cq.getResults(checkId, submissionId)` | Detailed matches for one submission |
+| `cq.getSummary(checkId)` | Summary stats |
+| `cq.getAIResults(checkId)` | AI-generated code detection results |
+| `cq.exportResults(checkId, format?)` | Export results |
+| `cq.getRemoteFile(location, source)` | Content of a matched web file |
+| `cq.getViewer(checkId, submissionId?)` | Results-viewer payload |
+| `cq.getViewerFile(checkId, submissionId, filePath)` | One submission file for the viewer |
+| `cq.getViewerCounterpart(checkId, submissionId, matchId, legacy?)` | The other side of a match |
+
+### Reference data & helpers
+
+| Method | Description |
+|--------|-------------|
+| `cq.getLanguages()` | Supported languages (999 = Auto Detect) |
+| `cq.getTestTypes()` | Available engines (test types) |
+| `cq.pollUntilComplete(checkId, options?)` | Poll until done. Options: `{ interval, timeout, onProgress }` |
+| `cq.checkFiles(name, filePaths, options?)` | Full workflow in one call |
+
+## Webhooks
+
+Pass `callbackUrl` when creating a check and Codequiry POSTs a signed JSON payload to your URL when the analysis completes, so you can skip polling:
+
+```javascript
+await cq.createCheck('Assignment 1', 999, {
+  callbackUrl: 'https://your-app.example/codequiry-webhook',
+});
+```
+
+## Errors and rate limits
+
+All methods reject with an axios error on non-2xx responses; `err.response.data` carries the API's message. The API rate limits at 60 requests per minute per IP. Uploads must be ZIP archives of at most 10 MB; strip build output and dependencies before zipping.
+
+## Links
+
+- [Codequiry: code plagiarism checker](https://codequiry.com)
+- [API documentation](https://codequiry.com/usage/api)
+- [Codequiry CLI](https://www.npmjs.com/package/codequiry-cli) — run checks from the terminal
+- [MCP server](https://codequiry.com/mcp) — plagiarism checks from Claude, Cursor, and other AI agents
+- [AI code detection](https://codequiry.com/detect-ai-written-code)
+
+## License
+
+MIT © [Codequiry](https://codequiry.com)

package/index.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Type definitions for the Codequiry Node.js SDK.
+ * Codequiry: code plagiarism checker, source code similarity detection,
+ * and AI-generated-code detection. https://codequiry.com
+ */
+
+export interface CreateCheckOptions {
+  /** Engine id from getTestTypes(). */
+  testType?: number;
+  /** Run AI-generated-code detection on this check. */
+  aiRun?: boolean;
+  /** Detect shared starter/boilerplate code. */
+  baseCodeDetection?: boolean;
+  /** Webhook URL called when the check completes. */
+  callbackUrl?: string;
+}
+
+export interface StartCheckOptions {
+  /** Enable Codequiry database matching. */
+  dbcheck?: boolean;
+  /** Enable internet/web matching. */
+  webcheck?: boolean;
+  /** Engine id override. */
+  testType?: number;
+  /** Run AI-generated-code detection on this check. */
+  aiRun?: boolean;
+  /** Detect shared starter/boilerplate code. */
+  baseCodeDetection?: boolean;
+}
+
+export interface QuickCheckOptions extends StartCheckOptions {
+  /** Language id from getLanguages(); 999 = Auto Detect. */
+  language?: number;
+}
+
+export interface PollOptions {
+  /** Poll interval in ms (default 3000). */
+  interval?: number;
+  /** Max wait in ms (default 600000). */
+  timeout?: number;
+  /** Called with each status payload while polling. */
+  onProgress?: (status: any) => void;
+}
+
+export interface CheckFilesOptions extends QuickCheckOptions, PollOptions {}
+
+export interface CheckFilesResult {
+  check: any;
+  status: any;
+  overview: any;
+  aiResults?: any;
+}
+
+declare class Codequiry {
+  /** @param apiKey Your Codequiry API key (https://codequiry.com/dashboard). */
+  constructor(apiKey: string);
+
+  /** Validate the API key. */
+  validateKey(): Promise<any>;
+  /** Get account info and usage quota. */
+  account(): Promise<any>;
+
+  /** List all checks. */
+  checks(): Promise<any>;
+  /** Create a new plagiarism check. */
+  createCheck(name: string, language?: number, options?: number | CreateCheckOptions): Promise<any>;
+  /** Get check info and status. */
+  getCheck(checkId: number): Promise<any>;
+  /** Update a check's name or language. */
+  updateCheck(checkId: number, fields: { name?: string; language?: number }): Promise<any>;
+  /** Delete a check. */
+  deleteCheck(checkId: number): Promise<any>;
+  /** Delete a single submission from a check. */
+  deleteSubmission(checkId: number, submissionId: number): Promise<any>;
+
+  /** Upload a ZIP file to a check (max 10 MB). */
+  uploadFile(checkId: number, filePath: string): Promise<any>;
+  /** Upload multiple ZIP files to a check. */
+  uploadBatch(checkId: number, filePaths: string[]): Promise<any>;
+  /** Create + upload + start in one call. */
+  quickCheck(name: string, filePaths: string | string[], options?: QuickCheckOptions): Promise<any>;
+
+  /** Start a check. */
+  startCheck(checkId: number, options?: StartCheckOptions): Promise<any>;
+  /** Get current check status. */
+  getStatus(checkId: number): Promise<any>;
+
+  /** Get results overview for a check. */
+  getOverview(checkId: number): Promise<any>;
+  /** Get the results overview as CSV text. */
+  getOverviewCSV(checkId: number): Promise<string>;
+  /** Get detailed results for one submission. */
+  getResults(checkId: number, submissionId: number): Promise<any>;
+  /** Get summary stats for a check. */
+  getSummary(checkId: number): Promise<any>;
+  /** Get AI-generated-code detection results. */
+  getAIResults(checkId: number): Promise<any>;
+  /** Export a check's results. */
+  exportResults(checkId: number, format?: string): Promise<any>;
+  /** Fetch the content of a matched web/remote file. */
+  getRemoteFile(location: string, source: string): Promise<any>;
+
+  /** Get the results-viewer payload for a check. */
+  getViewer(checkId: number, submissionId?: number): Promise<any>;
+  /** Get one submission file for the results viewer. */
+  getViewerFile(checkId: number, submissionId: number, filePath: string): Promise<any>;
+  /** Get the other side of a match in the results viewer. */
+  getViewerCounterpart(checkId: number, submissionId: number, matchId: number, legacy?: boolean): Promise<any>;
+
+  /** Get supported programming languages. */
+  getLanguages(): Promise<any>;
+  /** Get available engines (test types). */
+  getTestTypes(): Promise<any>;
+  /** Get Codequiry service status. */
+  serviceStatus(): Promise<any>;
+
+  /** Poll a check until completion. */
+  pollUntilComplete(checkId: number, options?: PollOptions): Promise<any>;
+  /** Quick-check ZIPs, wait for completion, return overview (and AI results). */
+  checkFiles(name: string, filePaths: string | string[], options?: CheckFilesOptions): Promise<CheckFilesResult>;
+}
+
+export = Codequiry;

package/index.js

@@ -48,16 +48,34 @@ class Codequiry {
     return res.data;
   }
 
+  /**
+   * Validate the API key.
+   * @returns {Promise<Object>}
+   */
+  async validateKey() {
+    const res = await this.client.get('/auth/validate');
+    return res.data;
+  }
+
   /**
    * Create a new check.
    * @param {string} name - Check name
-   * @param {number} language - Language ID (get from getLanguages())
-   * @param {number} [testType] - Test type ID (get from getTestTypes())
+   * @param {number} [language] - Language ID (get from getLanguages(), 999 = Auto Detect)
+   * @param {number|Object} [options] - Test type ID (legacy), or options object
+   * @param {number} [options.testType] - Engine ID (get from getTestTypes())
+   * @param {boolean} [options.aiRun] - Run AI-generated-code detection
+   * @param {boolean} [options.baseCodeDetection] - Detect shared starter/boilerplate code
+   * @param {string} [options.callbackUrl] - Webhook URL called when the check completes
    * @returns {Promise<Object>}
    */
-  async createCheck(name, language, testType) {
-    const body = { name, language };
-    if (testType) body.test_type = testType;
+  async createCheck(name, language, options) {
+    const opts = typeof options === 'number' ? { testType: options } : options || {};
+    const body = { name };
+    if (language) body.language = language;
+    if (opts.testType) body.test_type = opts.testType;
+    if (opts.aiRun !== undefined) body.ai_run = opts.aiRun ? 1 : 0;
+    if (opts.baseCodeDetection !== undefined) body.base_code_detection = opts.baseCodeDetection ? 1 : 0;
+    if (opts.callbackUrl) body.callback_url = opts.callbackUrl;
     const res = await this.client.post('/check/create', body);
     return res.data;
   }
@@ -72,6 +90,22 @@ class Codequiry {
     return res.data;
   }
 
+  /**
+   * Update a check's name or language.
+   * @param {number} checkId
+   * @param {Object} fields
+   * @param {string} [fields.name] - New check name
+   * @param {number} [fields.language] - New language ID (999 = Auto Detect)
+   * @returns {Promise<Object>}
+   */
+  async updateCheck(checkId, fields = {}) {
+    const body = { check_id: checkId };
+    if (fields.name !== undefined) body.name = fields.name;
+    if (fields.language !== undefined) body.language = fields.language;
+    const res = await this.client.post('/check/update', body);
+    return res.data;
+  }
+
   /**
    * Delete a check.
    * @param {number} checkId
@@ -82,6 +116,20 @@ class Codequiry {
     return res.data;
   }
 
+  /**
+   * Delete a single submission from a check.
+   * @param {number} checkId
+   * @param {number} submissionId
+   * @returns {Promise<Object>}
+   */
+  async deleteSubmission(checkId, submissionId) {
+    const res = await this.client.post('/check/deleteSubmission', {
+      check_id: checkId,
+      submission_id: submissionId,
+    });
+    return res.data;
+  }
+
   // ─── Upload ───────────────────────────────────────────
 
   /**
@@ -122,6 +170,40 @@ class Codequiry {
     return res.data;
   }
 
+  /**
+   * Quick check: create a check, upload ZIPs, and start it in one call.
+   * @param {string} name - Check name
+   * @param {string[]} filePaths - Paths to one or more .zip files (max 10 MB each)
+   * @param {Object} [options]
+   * @param {number} [options.language] - Language ID (999 = Auto Detect)
+   * @param {boolean} [options.webcheck] - Enable internet/web matching
+   * @param {boolean} [options.dbcheck] - Enable Codequiry database matching
+   * @param {number} [options.testType] - Engine ID (overrides webcheck/dbcheck)
+   * @param {boolean} [options.aiRun] - Run AI-generated-code detection
+   * @param {boolean} [options.baseCodeDetection] - Detect shared starter/boilerplate code
+   * @returns {Promise<Object>}
+   */
+  async quickCheck(name, filePaths, options = {}) {
+    const paths = Array.isArray(filePaths) ? filePaths : [filePaths];
+    const form = new FormData();
+    form.append('name', name);
+    if (options.language) form.append('language', String(options.language));
+    if (options.webcheck !== undefined) form.append('webcheck', options.webcheck ? '1' : '0');
+    if (options.dbcheck !== undefined) form.append('dbcheck', options.dbcheck ? '1' : '0');
+    if (options.testType) form.append('test_type', String(options.testType));
+    if (options.aiRun !== undefined) form.append('ai_run', options.aiRun ? '1' : '0');
+    if (options.baseCodeDetection !== undefined) {
+      form.append('base_code_detection', options.baseCodeDetection ? '1' : '0');
+    }
+    paths.forEach((fp) => form.append('files[]', fs.createReadStream(fp)));
+    const res = await this.client.post('/check/quick', form, {
+      headers: form.getHeaders(),
+      maxContentLength: Infinity,
+      maxBodyLength: Infinity,
+    });
+    return res.data;
+  }
+
   // ─── Start & Status ───────────────────────────────────
 
   /**
@@ -131,6 +213,8 @@ class Codequiry {
    * @param {boolean} [options.dbcheck=false] - Enable database check
    * @param {boolean} [options.webcheck=false] - Enable web check
    * @param {number} [options.testType] - Test type override
+   * @param {boolean} [options.aiRun] - Run AI-generated-code detection
+   * @param {boolean} [options.baseCodeDetection] - Detect shared starter/boilerplate code
    * @returns {Promise<Object>}
    */
   async startCheck(checkId, options = {}) {
@@ -140,6 +224,10 @@ class Codequiry {
       webcheck: options.webcheck ? 1 : 0,
     };
     if (options.testType) body.test_type = options.testType;
+    if (options.aiRun !== undefined) body.ai_run = options.aiRun ? 1 : 0;
+    if (options.baseCodeDetection !== undefined) {
+      body.base_code_detection = options.baseCodeDetection ? 1 : 0;
+    }
     const res = await this.client.post('/check/start', body);
     return res.data;
   }
@@ -190,6 +278,113 @@ class Codequiry {
     return res.data;
   }
 
+  /**
+   * Get the results overview as CSV.
+   * @param {number} checkId
+   * @returns {Promise<string>} CSV text
+   */
+  async getOverviewCSV(checkId) {
+    const res = await this.client.post(
+      '/check/overviewCSV',
+      { check_id: checkId },
+      { responseType: 'text', transformResponse: [(d) => d] }
+    );
+    return res.data;
+  }
+
+  /**
+   * Get AI-generated-code detection results for a check.
+   * @param {number} checkId
+   * @returns {Promise<Object>}
+   */
+  async getAIResults(checkId) {
+    const res = await this.client.get('/ai-results', {
+      params: { assignment_id: checkId },
+    });
+    return res.data;
+  }
+
+  /**
+   * Export a check's results.
+   * @param {number} checkId
+   * @param {string} [format] - Export format (e.g. 'json')
+   * @returns {Promise<Object>}
+   */
+  async exportResults(checkId, format) {
+    const body = { check_id: checkId };
+    if (format) body.format = format;
+    const res = await this.client.post('/check/export', body);
+    return res.data;
+  }
+
+  /**
+   * Fetch the content of a matched web/remote file.
+   * @param {string} location - Match location from results
+   * @param {string} source - Match source from results
+   * @returns {Promise<Object>}
+   */
+  async getRemoteFile(location, source) {
+    const res = await this.client.post('/check/getRemoteFile', { location, source });
+    return res.data;
+  }
+
+  // ─── Results Viewer ───────────────────────────────────
+
+  /**
+   * Get the results-viewer payload for a check.
+   * @param {number} checkId
+   * @param {number} [submissionId] - Omit for the highest-scoring submission
+   * @returns {Promise<Object>}
+   */
+  async getViewer(checkId, submissionId) {
+    const body = { check_id: checkId };
+    if (submissionId) body.submission_id = submissionId;
+    const res = await this.client.post('/check/viewer', body);
+    return res.data;
+  }
+
+  /**
+   * Get one submission file for the results viewer.
+   * @param {number} checkId
+   * @param {number} submissionId
+   * @param {string} filePath - The file's `filedir` from the viewer payload
+   * @returns {Promise<Object>}
+   */
+  async getViewerFile(checkId, submissionId, filePath) {
+    const res = await this.client.post('/check/viewer/file', {
+      check_id: checkId,
+      submission_id: submissionId,
+      file_path: filePath,
+    });
+    return res.data;
+  }
+
+  /**
+   * Get the other side of a match in the results viewer.
+   * @param {number} checkId
+   * @param {number} submissionId
+   * @param {number} matchId - The `id` of an entry in `matches` or `web_files`
+   * @param {boolean} [legacy] - true when the entry's `is_legacy_web` is true
+   * @returns {Promise<Object>}
+   */
+  async getViewerCounterpart(checkId, submissionId, matchId, legacy) {
+    const body = { check_id: checkId, submission_id: submissionId, match_id: matchId };
+    if (legacy !== undefined) body.legacy = legacy;
+    const res = await this.client.post('/check/viewer/counterpart', body);
+    return res.data;
+  }
+
+  // ─── Service ──────────────────────────────────────────
+
+  /**
+   * Get Codequiry service status.
+   * @returns {Promise<Object>}
+   */
+  async serviceStatus() {
+    const res = await this.client.get('/status');
+    return res.data;
+  }
+
   // ─── Reference Data ───────────────────────────────────
 
   /**
@@ -248,6 +443,33 @@ class Codequiry {
 
     throw new Error('Polling timed out after ' + timeout + 'ms');
   }
+
+  /**
+   * One-call workflow: quick-check the given ZIPs, wait for completion,
+   * and return the results overview (plus AI results when aiRun is set).
+   * @param {string} name - Check name
+   * @param {string|string[]} filePaths - Path(s) to .zip files
+   * @param {Object} [options] - quickCheck options plus poll interval/timeout/onProgress
+   * @returns {Promise<{check: Object, status: Object, overview: Object, aiResults?: Object}>}
+   */
+  async checkFiles(name, filePaths, options = {}) {
+    const created = await this.quickCheck(name, filePaths, options);
+    const checkId = created?.check?.id || created?.id || created?.check_id;
+    if (!checkId) {
+      throw new Error('Quick check did not return a check id: ' + JSON.stringify(created));
+    }
+    const status = await this.pollUntilComplete(checkId, options);
+    const overview = await this.getOverview(checkId);
+    const result = { check: created, status, overview };
+    if (options.aiRun) {
+      try {
+        result.aiResults = await this.getAIResults(checkId);
+      } catch (err) {
+        result.aiResults = { error: err.message };
+      }
+    }
+    return result;
+  }
 }
 
 module.exports = Codequiry;

package/package.json

@@ -1,36 +1,50 @@
-{
-  "name": "codequiry",
-  "version": "2.0.1",
-  "description": "Node.js SDK for Codequiry's Code Plagiarism & Similarity Detection API",
-  "main": "index.js",
-  "scripts": {
-    "test": "echo \"No tests yet\""
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/cqchecker/codequiry-sdk.git"
-  },
-  "keywords": [
-    "codequiry",
-    "plagiarism",
-    "code-similarity",
-    "code-plagiarism",
-    "similarity-detection",
-    "moss",
-    "api",
-    "sdk"
-  ],
-  "author": "Codequiry",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/cqchecker/codequiry-sdk/issues"
-  },
-  "homepage": "https://codequiry.com",
-  "dependencies": {
-    "axios": "^1.6.0",
-    "form-data": "^4.0.0"
-  },
-  "engines": {
-    "node": ">=14.0.0"
-  }
-}
+{
+  "name": "codequiry",
+  "version": "2.1.0",
+  "description": "Official Node.js SDK for Codequiry, the code plagiarism checker: source code plagiarism detection, peer code similarity, and AI-generated code detection API",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "test": "node test/smoke.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cqchecker/codequiry-sdk.git"
+  },
+  "keywords": [
+    "codequiry",
+    "plagiarism",
+    "plagiarism-checker",
+    "code-plagiarism",
+    "code-plagiarism-checker",
+    "code-similarity",
+    "similarity-detection",
+    "source-code-plagiarism",
+    "ai-code-detection",
+    "ai-detection",
+    "academic-integrity",
+    "moss",
+    "moss-alternative",
+    "api",
+    "sdk"
+  ],
+  "author": "Codequiry <contact@codequiry.com> (https://codequiry.com)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/cqchecker/codequiry-sdk/issues"
+  },
+  "homepage": "https://codequiry.com/sdks",
+  "dependencies": {
+    "axios": "^1.6.0",
+    "form-data": "^4.0.0"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  }
+}