@prodigio-io/sdk 1.0.0 → 1.0.2

package/README.md

@@ -0,0 +1,153 @@
+# @prodigio-io/sdk
+
+Official JavaScript SDK for the [Prodigio](https://prodigio.io) hiring API. Embed live job listings, upload CVs, and accept applications directly from your own website.
+
+## Installation
+
+```bash
+npm install @prodigio-io/sdk
+```
+
+## Quick start
+
+```typescript
+import { Prodigio } from '@prodigio-io/sdk';
+
+const prodigio = new Prodigio('pk_live_your_key_here');
+
+// List active jobs
+const jobs = await prodigio.jobs.list();
+
+// Get a single job
+const job = await prodigio.jobs.get('job_id');
+
+// Upload a CV then submit an application
+const cv = await prodigio.upload.cv(fileInput.files[0]);
+
+const result = await prodigio.applications.submit({
+  jobId: 'job_id',
+  applicant: {
+    fullName: 'Jane Smith',
+    email: 'jane@example.com',
+    phone: '+1 555 000 0000',
+  },
+  cv,
+  coverLetter: 'I am excited to apply...',
+});
+
+console.log(result.id); // application ID
+```
+
+## API reference
+
+### `new Prodigio(apiKey)`
+
+Creates a new client. Get your API key from your Prodigio dashboard under **Settings → API Integration**.
+
+```typescript
+const prodigio = new Prodigio('pk_live_...');
+
+// Or with config object
+const prodigio = new Prodigio({
+  apiKey: 'pk_live_...',
+  baseUrl: 'https://hire.prodigio.io', // optional
+});
+```
+
+### `prodigio.jobs.list(params?)`
+
+Returns active job postings.
+
+```typescript
+const jobs = await prodigio.jobs.list();
+const jobs = await prodigio.jobs.list({ status: 'all', department: 'Engineering' });
+```
+
+### `prodigio.jobs.get(jobId)`
+
+Returns full details for a single job including HTML description and requirements.
+
+```typescript
+const job = await prodigio.jobs.get('abc123');
+```
+
+### `prodigio.upload.cv(file)`
+
+Uploads a CV file. Pass the returned object directly to `applications.submit`.
+
+```typescript
+const cv = await prodigio.upload.cv(file); // File or Blob
+```
+
+### `prodigio.upload.achievement(file)`
+
+Uploads an achievement image or video (max 5 MB).
+
+```typescript
+const attachment = await prodigio.upload.achievement(file);
+```
+
+### `prodigio.applications.submit(params)`
+
+Submits a candidate application. AI scoring runs automatically on the backend.
+
+```typescript
+const result = await prodigio.applications.submit({
+  jobId: 'abc123',
+  applicant: {
+    fullName: 'Jane Smith',
+    email: 'jane@example.com',
+    phone: '+1 555 000 0000',
+    location: 'Accra, Ghana',       // optional
+    linkedin: 'https://...',         // optional
+  },
+  cv: {
+    url: '...',
+    fileName: 'jane-cv.pdf',
+    fileSize: 245760,
+    mimeType: 'application/pdf',
+  },
+  coverLetter: '...',   // optional
+  achievements: [],     // optional
+});
+```
+
+## Error handling
+
+Failed requests throw a `ProdigioError` with `status` and `message`.
+
+```typescript
+import { Prodigio, ProdigioError } from '@prodigio-io/sdk';
+
+try {
+  const job = await prodigio.jobs.get('nonexistent');
+} catch (err) {
+  if (err instanceof ProdigioError) {
+    console.log(err.status);  // 404
+    console.log(err.message); // 'Job not found'
+  }
+}
+```
+
+## TypeScript
+
+Full TypeScript types are included. No `@types` package needed.
+
+```typescript
+import type { Job, Applicant, CVInfo, UploadResult } from '@prodigio-io/sdk';
+```
+
+## Attribution
+
+Free tier usage requires displaying a visible "Powered by Prodigio" link on any page that uses the API. Every job response includes a `poweredBy` object with the text and URL to render.
+
+```typescript
+const jobs = await prodigio.jobs.list();
+// jobs[0].poweredBy = { text: 'Hiring powered by Prodigio', url: 'https://prodigio.io' }
+```
+
+## Links
+
+- [Full API documentation](https://hire.prodigio.io/developers)
+- [Prodigio dashboard](https://hire.prodigio.io/dashboard)
+- [prodigio.io](https://prodigio.io)

package/dist/index.d.mts

@@ -25,7 +25,9 @@ interface Job {
     eligibilityCriteria?: string;
     salaryRange: SalaryRange | null;
     applicationDeadline: string | null;
+    /** ISO 8601 date string e.g. "2026-04-01T09:00:00.000Z" — use new Date(createdAt) to convert */
     createdAt: string;
+    /** ISO 8601 date string e.g. "2026-04-01T09:00:00.000Z" — use new Date(updatedAt) to convert */
     updatedAt: string;
     poweredBy: PoweredBy;
 }
@@ -43,12 +45,16 @@ interface CVInfo {
     mimeType: string;
     path?: string;
 }
+interface Achievement {
+    description: string;
+    attachment?: UploadResult | null;
+}
 interface SubmitApplicationParams {
     jobId: string;
     applicant: Applicant;
     cv: CVInfo;
     coverLetter?: string;
-    achievements?: string[];
+    achievements?: Achievement[];
 }
 interface ApplicationResult {
     id: string;
@@ -91,4 +97,4 @@ declare class Prodigio {
     };
 }
 
-export { type Applicant, type ApplicationResult, type CVInfo, type Job, type ListJobsParams, type PoweredBy, Prodigio, type ProdigioConfig, ProdigioError, type SalaryRange, type SubmitApplicationParams, type UploadResult, Prodigio as default };
+export { type Achievement, type Applicant, type ApplicationResult, type CVInfo, type Job, type ListJobsParams, type PoweredBy, Prodigio, type ProdigioConfig, ProdigioError, type SalaryRange, type SubmitApplicationParams, type UploadResult, Prodigio as default };

package/dist/index.d.ts

@@ -25,7 +25,9 @@ interface Job {
     eligibilityCriteria?: string;
     salaryRange: SalaryRange | null;
     applicationDeadline: string | null;
+    /** ISO 8601 date string e.g. "2026-04-01T09:00:00.000Z" — use new Date(createdAt) to convert */
     createdAt: string;
+    /** ISO 8601 date string e.g. "2026-04-01T09:00:00.000Z" — use new Date(updatedAt) to convert */
     updatedAt: string;
     poweredBy: PoweredBy;
 }
@@ -43,12 +45,16 @@ interface CVInfo {
     mimeType: string;
     path?: string;
 }
+interface Achievement {
+    description: string;
+    attachment?: UploadResult | null;
+}
 interface SubmitApplicationParams {
     jobId: string;
     applicant: Applicant;
     cv: CVInfo;
     coverLetter?: string;
-    achievements?: string[];
+    achievements?: Achievement[];
 }
 interface ApplicationResult {
     id: string;
@@ -91,4 +97,4 @@ declare class Prodigio {
     };
 }
 
-export { type Applicant, type ApplicationResult, type CVInfo, type Job, type ListJobsParams, type PoweredBy, Prodigio, type ProdigioConfig, ProdigioError, type SalaryRange, type SubmitApplicationParams, type UploadResult, Prodigio as default };
+export { type Achievement, type Applicant, type ApplicationResult, type CVInfo, type Job, type ListJobsParams, type PoweredBy, Prodigio, type ProdigioConfig, ProdigioError, type SalaryRange, type SubmitApplicationParams, type UploadResult, Prodigio as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prodigio-io/sdk",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "Official JavaScript SDK for the Prodigio hiring API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",