@learncard/react 2.10.3 → 2.10.5

package/src/types/index.ts

@@ -0,0 +1,390 @@
+import {
+    VerificationItem,
+    AchievementCredential,
+    Profile,
+    CredentialSubject,
+    VC,
+} from '@learncard/types';
+import React, { ReactNode } from 'react';
+import { DisplayTypeEnum } from '../helpers/display.helpers';
+
+export enum Icons {
+    coinsIcon,
+    userIcon,
+    trophyIcon,
+    briefcaseIcon,
+    graduationIcon,
+    lightbulbIcon,
+    gradcaplight,
+    trophylight,
+    puzzlelight,
+    award,
+    keyIcon,
+
+    // new icons
+    coursesIcon,
+    socialBagesIcon,
+    achievementsIcon,
+    accomplishmentsIcon,
+    skillsIcon,
+    experiencesIcon,
+    relationshipsIcon,
+    accommodationsIcon,
+    membershipsIcon,
+    goalsIcon,
+    eventsIcon,
+}
+
+export enum LCCategoryEnum {
+    socialBadge = 'Social Badge',
+    achievement = 'Achievement',
+    course = 'Course',
+    job = 'Job',
+    id = 'ID',
+    workHistory = 'Work History',
+    currency = 'Currency',
+    learningHistory = 'Learning History',
+    skill = 'Skill',
+    membership = 'Membership',
+    event = 'Event',
+
+    accommodations = 'Accommodation',
+    accomplishments = 'Accomplishment',
+
+    meritBadge = 'Merit Badge',
+}
+
+export enum LCSubtypes {
+    job = 'job',
+    achievement = 'achievement',
+    skill = 'skill',
+    course = 'course',
+    locked = 'locked',
+}
+
+// courses(learningHistory - ladder), social badges, achievements, accomplishments,
+// skills, experiences, relationships, accommodations
+// todo - memberships, goals
+// deprecated - ids, currency
+export enum WalletCategoryTypes {
+    achievements = 'achievements',
+    jobHistory = 'jobhistory',
+    learningHistory = 'learningHistory',
+    skills = 'skills',
+    socialBadge = 'socialBadge',
+
+    // new
+    relationships = 'relationships',
+    accommodations = 'accommodations',
+    accomplishments = 'accomplishments',
+    events = 'events',
+
+    // todo
+    membership = 'membership',
+    goals = 'goals',
+
+    // deprecated
+    ids = 'ids',
+    currency = 'currency',
+}
+
+export type CredentialInfo = {
+    title?: string;
+    imageUrl?: string;
+    createdAt?: string;
+    issuer?: Profile;
+    issuee?: Profile;
+    credentialSubject?: CredentialSubject;
+};
+
+export type VCDisplayCardProps = {
+    title?: string;
+    createdAt?: string;
+    issuer?: Profile;
+    issuee?: Profile;
+    subjectImageComponent?: React.ReactNode;
+    issuerImageComponent?: React.ReactNode;
+    hideProfileBubbles?: boolean;
+    userImage?: string;
+    className?: string;
+    credentialSubject?: CredentialSubject;
+    onClick?: () => void;
+    loading?: boolean;
+    verification?: VerificationItem[];
+    handleClick?: () => void;
+    overrideDetailsComponent?: React.ReactNode;
+    overrideCardTitle?: string;
+    overrideCardImageComponent?: React.ReactNode;
+    customHeaderComponent?: React.ReactNode;
+};
+
+export type RoundedSquareProps = {
+    title?: string;
+    description?: string;
+    iconSrc?: string;
+    count?: string | number;
+    onClick?: () => void;
+    bgColor?: string;
+};
+
+export type SmallAchievementCardProps = {
+    title?: string;
+    thumbImgSrc?: string;
+    showStatus?: boolean;
+    showSkills?: boolean;
+    date?: string;
+    onClick?: () => void;
+};
+
+export type AchievementCardProps = {
+    title?: string;
+    thumbImgSrc?: string;
+    showStatus?: boolean;
+    claimStatus?: boolean;
+    showSkills?: boolean;
+    skillCount?: number;
+    showChecked?: boolean;
+    checked?: boolean;
+    onCheckClick?: () => void;
+    onClick?: () => void;
+};
+
+export type CourseCardProps = {
+    status?: string;
+    title?: string;
+    semester?: string;
+    skillCount?: string | number;
+    thumbSrc?: string;
+    jobCount?: string | number;
+    className?: string;
+    hideHeader?: boolean;
+    check?: boolean;
+    achievementCount: string | number;
+    onClick?: () => void;
+};
+
+export type CourseCardVerticalProps = {
+    title?: string;
+    className?: string;
+    thumbImgSrc?: string;
+    showStatus?: boolean;
+    claimStatus?: boolean;
+    achievementCount?: number;
+    skillCount?: number;
+    date?: string;
+    checked?: boolean;
+    showChecked?: boolean;
+    showSubCount?: boolean;
+    onCheckClick?: () => void;
+    onClick?: () => void;
+};
+
+export type SkillsCardProps = {
+    count?: number;
+    title?: string;
+    level?: string;
+    category?: string;
+    levelCount?: number;
+    skillColor?: string;
+    onClick?: () => void;
+    className?: string;
+};
+
+export type SkillStat = {
+    name?: string;
+    percent: number | string;
+    className?: string;
+};
+
+export type SkillsStatsCardProps = {
+    totalCount?: string | number;
+    skills?: SkillStat[];
+    className?: string;
+    onClick?: () => void;
+};
+
+export type SkillVerticalCardProps = {
+    title: string;
+    completed?: number;
+    total?: number;
+    thumbImg?: string;
+    onClick?: () => void;
+    className?: string;
+};
+
+export type RoundedPillProps = {
+    statusText?: string;
+    type?: LCSubtypes.course | LCSubtypes.achievement | LCSubtypes.skill | 'locked';
+    onClick?: () => void;
+    showCheckmark?: boolean;
+};
+
+export type JobQualificationsCount = {
+    fulfilledCount: number;
+    totalRequiredCount: number;
+};
+
+export type JobQualificationDisplay = {
+    skills?: JobQualificationsCount;
+    achievements?: JobQualificationsCount;
+    courses?: JobQualificationsCount;
+};
+
+export type JobListCardProps = {
+    title?: string;
+    customButtonComponent?: React.ReactNode;
+    company?: string;
+    compensation?: string;
+    location?: string;
+    locationRequirement?: string;
+    timeRequirement?: string;
+    qualificationDisplay?: JobQualificationDisplay;
+    percentQualifiedDisplay?: string;
+    postDateDisplay?: string;
+    imgThumb?: string;
+    isBookmarked?: boolean;
+    className?: string;
+    onBookmark?: () => void;
+    onClick?: () => void;
+};
+
+export type LearnPillProps = {
+    count: number | string;
+    type: LCSubtypes.course | LCSubtypes.achievement | LCSubtypes.skill;
+    className?: string;
+};
+
+export type CircleCheckButtonProps = {
+    onClick?: () => void;
+    className?: string;
+    bgColor?: string;
+    checked?: boolean;
+};
+
+export type SkillTabCardProps = {
+    title?: string;
+    description?: string;
+    checked?: boolean;
+    showChecked?: boolean;
+    showStatus?: boolean;
+    className?: string;
+    onCheckClicked?: () => void;
+    onClick?: () => void;
+};
+
+export type JobHistoryCardProps = {
+    title?: string;
+    company?: string;
+    description?: string;
+    dateRange?: string;
+    jobType?: string;
+    className?: string;
+    showArrow?: boolean;
+    onClick?: () => void;
+};
+
+export type GenericCardProps = {
+    title?: string;
+    className?: string;
+    type?: WalletCategoryTypes;
+    thumbImgSrc?: string;
+    customThumbClass?: string;
+    customHeaderClass?: string;
+    showChecked?: boolean;
+    checkStatus?: boolean;
+    onClick?: () => void;
+    flipped?: boolean;
+};
+
+export type IssueHistory = {
+    id?: string | number;
+    name?: string;
+    thumb?: string;
+    date?: string;
+};
+
+export type BoostSmallCardProps = {
+    title?: string;
+    customTitle?: React.ReactNode | string | null;
+    className?: string;
+    type?: WalletCategoryTypes;
+    thumbImgSrc?: string;
+    customThumbClass?: string;
+    customHeaderClass?: string;
+    customBodyClass?: string;
+    showChecked?: boolean;
+    checkStatus?: boolean;
+    customButtonComponent?: React.ReactNode;
+    customThumbComponent?: React.ReactNode;
+    customBodyComponent?: React.ReactNode;
+    customDraftComponent?: React.ReactNode;
+    arrowOnClick?: () => void;
+    buttonOnClick?: () => void;
+    onCheckClick?: () => void;
+    innerOnClick?: () => void;
+    optionsTriggerOnClick?: () => void;
+    issueHistory?: IssueHistory[];
+    bgImgSrc?: string;
+};
+
+export type BoostGenericCardProps = {
+    title?: string;
+    customTitle?: React.ReactNode | string | null;
+    className?: string;
+    type?: WalletCategoryTypes;
+    thumbImgSrc?: string;
+    customThumbClass?: string;
+    customHeaderClass?: string;
+    showChecked?: boolean;
+    checkStatus?: boolean;
+    onCheckClick?: () => void;
+    customThumbComponent?: React.ReactNode;
+    innerOnClick?: () => void;
+    bgImgSrc?: string;
+    issuerName?: string;
+    customIssuerName?: React.ReactNode | string | null;
+    optionsTriggerOnClick?: () => void;
+    dateDisplay?: string;
+    customDateDisplay?: React.ReactNode | string | null;
+    verifierBadge?: React.ReactNode;
+    credential?: VC;
+    isInSkillsModal?: boolean;
+    displayType?: DisplayTypeEnum | string;
+    linkedCredentialsCount?: number;
+    linkedCredentialsClassName?: string;
+    checkBtnClass?: string;
+};
+
+export type Attachment = {
+    title: string;
+    url: string;
+    type: 'photo' | 'document' | 'video' | 'link';
+};
+
+export type BoostAchievementCredential = AchievementCredential & {
+    display?: { backgroundImage?: string; backgroundColor?: string };
+    image: string;
+    attachments: Attachment[];
+};
+
+export type MediaMetadata = {
+    fileExtension?: string;
+    sizeInBytes?: number;
+    numberOfPages?: number;
+};
+
+export type VideoMetadata = {
+    title?: string;
+    videoLength?: string;
+    imageUrl?: string;
+};
+
+export type KnownDIDRegistryType = {
+    source: string;
+    results:
+        | {
+              matchingIssuers: any[];
+              uncheckedRegistries: any[];
+          }
+        | {};
+};

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Learning Economy Foundation <sdk@learningeconomy.io>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.