@hiofu/apply-sdk 0.1.0

package/dist/client-BD0-Mbnq.d.cts

@@ -0,0 +1,279 @@
+type HiofuScope = "profile.basic" | "profile.full" | "evidence.read" | "applications.write" | "passport.snapshot";
+interface HiofuConfig {
+    /** Public client identifier (pk_live_… / pk_test_…). */
+    clientId: string;
+    /** Where the Hiofu candidate app lives. Defaults to https://hiofu.com */
+    hiofuOrigin?: string;
+    /** Where the backend API lives. Defaults to https://api.hiofu.com */
+    apiBase?: string;
+    /** Optional default scopes for `authorize()`. */
+    scopes?: HiofuScope[];
+    /** Optional default scopes for `apply()`. */
+    applyScopes?: HiofuScope[];
+    /** Where the popup will redirect on success. Must be one of the partner's
+     *  registered URIs. If omitted in the browser, the SDK falls back to a
+     *  same-origin `/oauth/callback.html` page when possible. */
+    redirectUri?: string;
+    /** Where to store the access token client-side. */
+    storage?: "session" | "memory";
+    /** How long to wait for the consent popup before failing. Defaults to 5 minutes. */
+    authorizeTimeoutMs?: number;
+    /** Optional lifecycle listener for popup/auth/apply events. */
+    onEvent?: (event: HiofuEvent) => void;
+}
+interface HiofuTokenSet {
+    expiresAt: number;
+    scopes: HiofuScope[];
+}
+interface HiofuApplyRole {
+    /** Partner-owned stable role/job identifier. */
+    externalRoleId: string;
+    /** Partner-owned stable employer/company identifier. */
+    externalEmployerId: string;
+    title: string;
+    description?: string;
+    department?: string;
+    locations?: string[];
+    jobTypes?: string[];
+    salaryMin?: number;
+    salaryMax?: number;
+    salaryCurrency?: string;
+    experienceMin?: number;
+    experienceMax?: number;
+    metadata?: Record<string, unknown>;
+}
+interface HiofuApplyOptions {
+    jobId: string;
+    jobTitle: string;
+    employerId: string;
+    employerName: string;
+    scopes?: HiofuScope[];
+    variationId?: string;
+    /** Optional richer partner role payload used by Apply Rail role mapping. */
+    role?: HiofuApplyRole;
+    /** Stable partner-generated key for safe retries and duplicate-submit protection.
+     *  If omitted, the SDK generates a per-attempt key automatically. */
+    idempotencyKey?: string;
+}
+interface HiofuBasicProfile {
+    id?: string | null;
+    name?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    location?: string | null;
+    professionalTitle: string | null;
+    avatarUrl?: string | null;
+    professionalLinks?: unknown;
+}
+interface HiofuSkill {
+    id?: string | null;
+    name: string;
+    category: string | null;
+    proficiencyLevel: string | null;
+    yearsExperience: number | null;
+    verificationType: string;
+    verifiedAt: string | Date | null;
+    trustScore: number | null;
+    confidenceScore: number | null;
+}
+interface HiofuExperience {
+    id?: string | null;
+    title: string;
+    company?: string | null;
+    yearStart: number | null;
+    yearEnd: number | null;
+    monthStart: number | null;
+    monthEnd: number | null;
+    isCurrent: boolean;
+    employmentType: string | null;
+    description?: string | null;
+    highlights?: string[];
+    skillIds: string[];
+}
+interface HiofuEducation {
+    id?: string | null;
+    degree: string;
+    institution?: string | null;
+    fieldOfStudy: string | null;
+    year: number | null;
+    gpa: number | null;
+    honors: string | null;
+}
+interface HiofuAchievement {
+    id?: string | null;
+    title: string;
+    description?: string | null;
+    metric: string | null;
+}
+interface HiofuFullProfile extends HiofuBasicProfile {
+    bio: string | null;
+    skills: HiofuSkill[];
+    experiences: HiofuExperience[];
+    education: HiofuEducation[];
+    achievements: HiofuAchievement[];
+}
+interface HiofuEvidenceItem {
+    id?: string | null;
+    title: string;
+    evidenceType: string;
+    normalisedProficiency: string | null;
+    trustScore: number | null;
+    proctoringLevel: string | null;
+    completedAt: string | Date | null;
+    expiresAt: string | Date | null;
+}
+interface HiofuEvidenceBundle {
+    trustScore: number;
+    evidence: HiofuEvidenceItem[];
+}
+interface HiofuSnapshotFocus {
+    targetRole: string | null;
+    industry: string | null;
+    headline: string | null;
+    summary: string | null;
+}
+interface HiofuSnapshotSkillPreview {
+    name: string;
+    category: string | null;
+    verificationType: string | null;
+    yearsExperience: number | null;
+    trustScore: number | null;
+}
+interface HiofuSnapshotExperiencePreview {
+    title: string;
+    yearStart: number | null;
+    yearEnd: number | null;
+    isCurrent: boolean;
+    employmentType: string | null;
+}
+interface HiofuSnapshotEducationPreview {
+    degree: string;
+    fieldOfStudy: string | null;
+    year: number | null;
+    honors: string | null;
+}
+interface HiofuSnapshotAchievementPreview {
+    title: string;
+    metric: string | null;
+}
+interface HiofuSnapshotEvidencePreview {
+    title: string;
+    evidenceType: string;
+    trustScore: number | null;
+    verificationStatus: string | null;
+}
+interface HiofuPassportSnapshot {
+    versionNumber: number;
+    variationName: string | null;
+    label: string | null;
+    createdAt: string | Date;
+    trustScore: number;
+    trustBand: "low" | "moderate" | "high";
+    professionalTitle: string | null;
+    focus: HiofuSnapshotFocus;
+    counts: {
+        skills: number;
+        experiences: number;
+        education: number;
+        achievements: number;
+        evidence: number;
+    };
+    preview: {
+        skills: HiofuSnapshotSkillPreview[];
+        experiences: HiofuSnapshotExperiencePreview[];
+        education: HiofuSnapshotEducationPreview[];
+        achievements: HiofuSnapshotAchievementPreview[];
+        evidence: HiofuSnapshotEvidencePreview[];
+    };
+}
+interface HiofuApplicationRecord {
+    id: string;
+    status: string;
+    jobId?: string;
+    jobTitle?: string;
+    employerId?: string;
+    employerName?: string;
+    submittedAt?: string | Date;
+    statusUpdatedAt?: string | Date;
+}
+interface HiofuPartnerDelivery {
+    mode: "webhook_and_response" | "response_only";
+    event: string;
+    queued: boolean;
+    endpointCount?: number;
+}
+interface HiofuSharedView {
+    type: "full_passport" | "variation";
+    label: string | null;
+}
+interface HiofuApplyResult {
+    application: HiofuApplicationRecord;
+    authorization: HiofuTokenSet;
+    idempotencyKey: string;
+    sharedView?: HiofuSharedView | null;
+    versionNumber?: number | null;
+    profile?: HiofuBasicProfile | HiofuFullProfile | null;
+    evidence?: HiofuEvidenceBundle | null;
+    snapshot?: HiofuPassportSnapshot | null;
+    delivery?: HiofuPartnerDelivery | null;
+}
+interface HiofuPartner {
+    id: string;
+    name: string;
+    logoUrl: string | null;
+    websiteUrl: string | null;
+    privacyPolicyUrl: string | null;
+}
+type HiofuEvent = {
+    type: "popup_opened";
+    redirectUri: string;
+} | {
+    type: "popup_closed";
+    reason: "completed" | "denied" | "user_closed" | "timed_out";
+} | {
+    type: "popup_result_received";
+    channel: "message" | "storage" | "broadcast" | "poll_url" | "poll_storage" | "focus_storage" | "close_check";
+    hasCode: boolean;
+    hasError: boolean;
+    stateMatches: boolean;
+    error?: string | null;
+    variationId?: string | null;
+} | {
+    type: "token_issued";
+    token: HiofuTokenSet;
+} | {
+    type: "apply_started";
+    input: Pick<HiofuApplyOptions, "jobId" | "jobTitle" | "employerId" | "employerName" | "variationId">;
+} | {
+    type: "apply_submitting";
+    idempotencyKey: string;
+    variationId: string | null;
+} | {
+    type: "apply_success";
+    result: HiofuApplyResult;
+} | {
+    type: "apply_error";
+    error: Error;
+};
+
+declare const DEFAULT_AUTHORIZE_SCOPES: HiofuScope[];
+declare const DEFAULT_APPLY_SCOPES: HiofuScope[];
+declare class HiofuClient {
+    private readonly listeners;
+    readonly config: Required<Pick<HiofuConfig, "clientId" | "hiofuOrigin" | "apiBase" | "storage" | "authorizeTimeoutMs">> & HiofuConfig;
+    constructor(config: HiofuConfig);
+    subscribe(listener: (event: HiofuEvent) => void): () => void;
+    private emit;
+    /** Returns a usable access token, refreshing if needed. */
+    getAccessToken(): Promise<string | null>;
+    /** Open the popup, get a token. */
+    authorize(scopes?: HiofuScope[], context?: Pick<HiofuApplyOptions, "jobId" | "jobTitle" | "employerId" | "employerName">): Promise<HiofuTokenSet>;
+    /** End-to-end apply: authorize if needed, then POST application. */
+    apply(opts: HiofuApplyOptions): Promise<HiofuApplyResult>;
+    getProfile(scope?: "basic" | "full"): Promise<unknown>;
+    logout(): Promise<void>;
+}
+
+export { DEFAULT_APPLY_SCOPES as D, HiofuClient as H, type HiofuScope as a, type HiofuApplyResult as b, type HiofuConfig as c, type HiofuEvent as d, type HiofuApplyOptions as e, type HiofuTokenSet as f, DEFAULT_AUTHORIZE_SCOPES as g, type HiofuApplyRole as h, type HiofuPartner as i };

package/dist/client-BD0-Mbnq.d.ts

@@ -0,0 +1,279 @@
+type HiofuScope = "profile.basic" | "profile.full" | "evidence.read" | "applications.write" | "passport.snapshot";
+interface HiofuConfig {
+    /** Public client identifier (pk_live_… / pk_test_…). */
+    clientId: string;
+    /** Where the Hiofu candidate app lives. Defaults to https://hiofu.com */
+    hiofuOrigin?: string;
+    /** Where the backend API lives. Defaults to https://api.hiofu.com */
+    apiBase?: string;
+    /** Optional default scopes for `authorize()`. */
+    scopes?: HiofuScope[];
+    /** Optional default scopes for `apply()`. */
+    applyScopes?: HiofuScope[];
+    /** Where the popup will redirect on success. Must be one of the partner's
+     *  registered URIs. If omitted in the browser, the SDK falls back to a
+     *  same-origin `/oauth/callback.html` page when possible. */
+    redirectUri?: string;
+    /** Where to store the access token client-side. */
+    storage?: "session" | "memory";
+    /** How long to wait for the consent popup before failing. Defaults to 5 minutes. */
+    authorizeTimeoutMs?: number;
+    /** Optional lifecycle listener for popup/auth/apply events. */
+    onEvent?: (event: HiofuEvent) => void;
+}
+interface HiofuTokenSet {
+    expiresAt: number;
+    scopes: HiofuScope[];
+}
+interface HiofuApplyRole {
+    /** Partner-owned stable role/job identifier. */
+    externalRoleId: string;
+    /** Partner-owned stable employer/company identifier. */
+    externalEmployerId: string;
+    title: string;
+    description?: string;
+    department?: string;
+    locations?: string[];
+    jobTypes?: string[];
+    salaryMin?: number;
+    salaryMax?: number;
+    salaryCurrency?: string;
+    experienceMin?: number;
+    experienceMax?: number;
+    metadata?: Record<string, unknown>;
+}
+interface HiofuApplyOptions {
+    jobId: string;
+    jobTitle: string;
+    employerId: string;
+    employerName: string;
+    scopes?: HiofuScope[];
+    variationId?: string;
+    /** Optional richer partner role payload used by Apply Rail role mapping. */
+    role?: HiofuApplyRole;
+    /** Stable partner-generated key for safe retries and duplicate-submit protection.
+     *  If omitted, the SDK generates a per-attempt key automatically. */
+    idempotencyKey?: string;
+}
+interface HiofuBasicProfile {
+    id?: string | null;
+    name?: string | null;
+    firstName?: string | null;
+    lastName?: string | null;
+    email?: string | null;
+    phone?: string | null;
+    location?: string | null;
+    professionalTitle: string | null;
+    avatarUrl?: string | null;
+    professionalLinks?: unknown;
+}
+interface HiofuSkill {
+    id?: string | null;
+    name: string;
+    category: string | null;
+    proficiencyLevel: string | null;
+    yearsExperience: number | null;
+    verificationType: string;
+    verifiedAt: string | Date | null;
+    trustScore: number | null;
+    confidenceScore: number | null;
+}
+interface HiofuExperience {
+    id?: string | null;
+    title: string;
+    company?: string | null;
+    yearStart: number | null;
+    yearEnd: number | null;
+    monthStart: number | null;
+    monthEnd: number | null;
+    isCurrent: boolean;
+    employmentType: string | null;
+    description?: string | null;
+    highlights?: string[];
+    skillIds: string[];
+}
+interface HiofuEducation {
+    id?: string | null;
+    degree: string;
+    institution?: string | null;
+    fieldOfStudy: string | null;
+    year: number | null;
+    gpa: number | null;
+    honors: string | null;
+}
+interface HiofuAchievement {
+    id?: string | null;
+    title: string;
+    description?: string | null;
+    metric: string | null;
+}
+interface HiofuFullProfile extends HiofuBasicProfile {
+    bio: string | null;
+    skills: HiofuSkill[];
+    experiences: HiofuExperience[];
+    education: HiofuEducation[];
+    achievements: HiofuAchievement[];
+}
+interface HiofuEvidenceItem {
+    id?: string | null;
+    title: string;
+    evidenceType: string;
+    normalisedProficiency: string | null;
+    trustScore: number | null;
+    proctoringLevel: string | null;
+    completedAt: string | Date | null;
+    expiresAt: string | Date | null;
+}
+interface HiofuEvidenceBundle {
+    trustScore: number;
+    evidence: HiofuEvidenceItem[];
+}
+interface HiofuSnapshotFocus {
+    targetRole: string | null;
+    industry: string | null;
+    headline: string | null;
+    summary: string | null;
+}
+interface HiofuSnapshotSkillPreview {
+    name: string;
+    category: string | null;
+    verificationType: string | null;
+    yearsExperience: number | null;
+    trustScore: number | null;
+}
+interface HiofuSnapshotExperiencePreview {
+    title: string;
+    yearStart: number | null;
+    yearEnd: number | null;
+    isCurrent: boolean;
+    employmentType: string | null;
+}
+interface HiofuSnapshotEducationPreview {
+    degree: string;
+    fieldOfStudy: string | null;
+    year: number | null;
+    honors: string | null;
+}
+interface HiofuSnapshotAchievementPreview {
+    title: string;
+    metric: string | null;
+}
+interface HiofuSnapshotEvidencePreview {
+    title: string;
+    evidenceType: string;
+    trustScore: number | null;
+    verificationStatus: string | null;
+}
+interface HiofuPassportSnapshot {
+    versionNumber: number;
+    variationName: string | null;
+    label: string | null;
+    createdAt: string | Date;
+    trustScore: number;
+    trustBand: "low" | "moderate" | "high";
+    professionalTitle: string | null;
+    focus: HiofuSnapshotFocus;
+    counts: {
+        skills: number;
+        experiences: number;
+        education: number;
+        achievements: number;
+        evidence: number;
+    };
+    preview: {
+        skills: HiofuSnapshotSkillPreview[];
+        experiences: HiofuSnapshotExperiencePreview[];
+        education: HiofuSnapshotEducationPreview[];
+        achievements: HiofuSnapshotAchievementPreview[];
+        evidence: HiofuSnapshotEvidencePreview[];
+    };
+}
+interface HiofuApplicationRecord {
+    id: string;
+    status: string;
+    jobId?: string;
+    jobTitle?: string;
+    employerId?: string;
+    employerName?: string;
+    submittedAt?: string | Date;
+    statusUpdatedAt?: string | Date;
+}
+interface HiofuPartnerDelivery {
+    mode: "webhook_and_response" | "response_only";
+    event: string;
+    queued: boolean;
+    endpointCount?: number;
+}
+interface HiofuSharedView {
+    type: "full_passport" | "variation";
+    label: string | null;
+}
+interface HiofuApplyResult {
+    application: HiofuApplicationRecord;
+    authorization: HiofuTokenSet;
+    idempotencyKey: string;
+    sharedView?: HiofuSharedView | null;
+    versionNumber?: number | null;
+    profile?: HiofuBasicProfile | HiofuFullProfile | null;
+    evidence?: HiofuEvidenceBundle | null;
+    snapshot?: HiofuPassportSnapshot | null;
+    delivery?: HiofuPartnerDelivery | null;
+}
+interface HiofuPartner {
+    id: string;
+    name: string;
+    logoUrl: string | null;
+    websiteUrl: string | null;
+    privacyPolicyUrl: string | null;
+}
+type HiofuEvent = {
+    type: "popup_opened";
+    redirectUri: string;
+} | {
+    type: "popup_closed";
+    reason: "completed" | "denied" | "user_closed" | "timed_out";
+} | {
+    type: "popup_result_received";
+    channel: "message" | "storage" | "broadcast" | "poll_url" | "poll_storage" | "focus_storage" | "close_check";
+    hasCode: boolean;
+    hasError: boolean;
+    stateMatches: boolean;
+    error?: string | null;
+    variationId?: string | null;
+} | {
+    type: "token_issued";
+    token: HiofuTokenSet;
+} | {
+    type: "apply_started";
+    input: Pick<HiofuApplyOptions, "jobId" | "jobTitle" | "employerId" | "employerName" | "variationId">;
+} | {
+    type: "apply_submitting";
+    idempotencyKey: string;
+    variationId: string | null;
+} | {
+    type: "apply_success";
+    result: HiofuApplyResult;
+} | {
+    type: "apply_error";
+    error: Error;
+};
+
+declare const DEFAULT_AUTHORIZE_SCOPES: HiofuScope[];
+declare const DEFAULT_APPLY_SCOPES: HiofuScope[];
+declare class HiofuClient {
+    private readonly listeners;
+    readonly config: Required<Pick<HiofuConfig, "clientId" | "hiofuOrigin" | "apiBase" | "storage" | "authorizeTimeoutMs">> & HiofuConfig;
+    constructor(config: HiofuConfig);
+    subscribe(listener: (event: HiofuEvent) => void): () => void;
+    private emit;
+    /** Returns a usable access token, refreshing if needed. */
+    getAccessToken(): Promise<string | null>;
+    /** Open the popup, get a token. */
+    authorize(scopes?: HiofuScope[], context?: Pick<HiofuApplyOptions, "jobId" | "jobTitle" | "employerId" | "employerName">): Promise<HiofuTokenSet>;
+    /** End-to-end apply: authorize if needed, then POST application. */
+    apply(opts: HiofuApplyOptions): Promise<HiofuApplyResult>;
+    getProfile(scope?: "basic" | "full"): Promise<unknown>;
+    logout(): Promise<void>;
+}
+
+export { DEFAULT_APPLY_SCOPES as D, HiofuClient as H, type HiofuScope as a, type HiofuApplyResult as b, type HiofuConfig as c, type HiofuEvent as d, type HiofuApplyOptions as e, type HiofuTokenSet as f, DEFAULT_AUTHORIZE_SCOPES as g, type HiofuApplyRole as h, type HiofuPartner as i };