@managesome/knotr-toolkit 0.1.1 → 0.8.1

package/dist/types/marketplace.d.ts

@@ -1,7 +1,8 @@
-import type { Location, TimestampFields } from './common';
+import type { ILocation, ITimestampFields } from './common.js';
 export type ServiceCategory = 'full_service' | 'profile_management' | 'search_only' | 'verification' | 'consultation' | 'event_based';
 export type PricingModel = 'fixed' | 'monthly' | 'success_based' | 'hybrid';
-export interface ServicePackage {
+export type VerificationLevel = 'basic' | 'verified' | 'trusted' | 'premium' | 'elite';
+export interface IServicePackage {
     id: string;
     name: string;
     description: string;
@@ -13,18 +14,18 @@ export interface ServicePackage {
     guaranteedMatches?: number;
     refundPolicy?: string;
 }
-export interface ServiceListing extends TimestampFields {
+export interface IServiceListing extends ITimestampFields {
     id: string;
     companyId: string;
     title: string;
     description: string;
     category: ServiceCategory;
     specializations: string[];
-    packages: ServicePackage[];
+    packages: IServicePackage[];
     pricingModel: PricingModel;
     successFeePercentage?: number;
     targetSects: string[];
-    targetRegions: Location[];
+    targetRegions: ILocation[];
     targetProfessions: string[];
     termsAndConditions: string;
     privacyPolicy: string;
@@ -38,18 +39,18 @@ export interface ServiceListing extends TimestampFields {
     isActive: boolean;
     isFeatured: boolean;
     featuredUntil?: Date;
-    verificationLevel: 'basic' | 'verified' | 'trusted' | 'premium' | 'elite';
+    verificationLevel: VerificationLevel;
 }
-export interface ServiceListingCreateInput {
+export interface IServiceListingCreateInput {
     title: string;
     description: string;
     category: ServiceCategory;
     specializations: string[];
-    packages: Omit<ServicePackage, 'id'>[];
+    packages: Omit<IServicePackage, 'id'>[];
     pricingModel: PricingModel;
     successFeePercentage?: number;
     targetSects?: string[];
-    targetRegions?: Location[];
+    targetRegions?: ILocation[];
     targetProfessions?: string[];
     termsAndConditions: string;
     privacyPolicy?: string;
@@ -58,8 +59,10 @@ export interface ServiceListingCreateInput {
 }
 export type RequirementStatus = 'draft' | 'active' | 'paused' | 'in_contract' | 'completed' | 'cancelled' | 'filled' | 'closed';
 export type RequirementVisibility = 'public' | 'invited' | 'private';
-export interface RequirementPreferences {
-    gender: 'male' | 'female';
+export type RequirementUrgency = 'flexible' | 'moderate' | 'urgent';
+export type CandidateGender = 'male' | 'female';
+export interface IRequirementPreferences {
+    gender: CandidateGender;
     ageRange: {
         min: number;
         max: number;
@@ -67,31 +70,31 @@ export interface RequirementPreferences {
     sects: string[];
     educationLevels: string[];
     professions: string[];
-    locations: Location[];
+    locations: ILocation[];
     maritalStatuses: string[];
     additionalRequirements?: string;
 }
-export interface RequirementPost extends TimestampFields {
+export interface IRequirementPost extends ITimestampFields {
     id: string;
     accountId: string;
     profileId?: string;
     title: string;
     description: string;
     candidateOverview: string;
-    candidateGender: 'male' | 'female';
+    candidateGender: CandidateGender;
     candidateAge: number;
     candidateProfession: string;
     candidateEducation: string;
-    candidateLocation: Location;
+    candidateLocation: ILocation;
     candidateSect: string;
-    preferences: RequirementPreferences;
+    preferences: IRequirementPreferences;
     budgetMin: number;
     budgetMax: number;
     currency: string;
     timeline: number;
-    urgency: 'flexible' | 'moderate' | 'urgent';
+    urgency: RequirementUrgency;
     preferredCompanyTypes?: string[];
-    preferredRegions?: Location[];
+    preferredRegions?: ILocation[];
     requireVerifiedCompany: boolean;
     minimumRating?: number;
     status: RequirementStatus;
@@ -107,24 +110,24 @@ export interface RequirementPost extends TimestampFields {
     selectedContractId?: string;
     filledAt?: Date;
 }
-export interface RequirementPostCreateInput {
+export interface IRequirementPostCreateInput {
     title: string;
     description: string;
     candidateOverview: string;
-    candidateGender: 'male' | 'female';
+    candidateGender: CandidateGender;
     candidateAge: number;
     candidateProfession: string;
     candidateEducation: string;
-    candidateLocation: Location;
+    candidateLocation: ILocation;
     candidateSect: string;
-    preferences: RequirementPreferences;
+    preferences: IRequirementPreferences;
     budgetMin: number;
     budgetMax: number;
     currency?: string;
     timeline: number;
-    urgency?: 'flexible' | 'moderate' | 'urgent';
+    urgency?: RequirementUrgency;
     preferredCompanyTypes?: string[];
-    preferredRegions?: Location[];
+    preferredRegions?: ILocation[];
     requireVerifiedCompany?: boolean;
     minimumRating?: number;
     visibility?: RequirementVisibility;
@@ -132,7 +135,7 @@ export interface RequirementPostCreateInput {
     profileId?: string;
 }
 export type ProposalStatus = 'pending' | 'shortlisted' | 'accepted' | 'rejected' | 'withdrawn' | 'expired';
-export interface ProposalMilestone {
+export interface IProposalMilestone {
     id: string;
     title: string;
     description: string;
@@ -140,17 +143,17 @@ export interface ProposalMilestone {
     dueDate?: Date;
     deliverables: string[];
 }
-export interface Proposal extends TimestampFields {
+export interface IProposal extends ITimestampFields {
     id: string;
     requirementId: string;
     companyId: string;
     listingId?: string;
     coverLetter: string;
-    proposedPackage?: ServicePackage;
+    proposedPackage?: IServicePackage;
     customPrice: number;
     currency: string;
     proposedDuration: number;
-    proposedMilestones: ProposalMilestone[];
+    proposedMilestones: IProposalMilestone[];
     relevantExperience: string;
     potentialMatches?: number;
     guarantees: string[];
@@ -168,15 +171,15 @@ export interface Proposal extends TimestampFields {
     viewedByClient: boolean;
     viewedAt?: Date;
 }
-export interface ProposalCreateInput {
+export interface IProposalCreateInput {
     requirementId: string;
     listingId?: string;
     coverLetter: string;
-    proposedPackage?: ServicePackage;
+    proposedPackage?: IServicePackage;
     customPrice: number;
     currency?: string;
     proposedDuration: number;
-    proposedMilestones: Omit<ProposalMilestone, 'id'>[];
+    proposedMilestones: Omit<IProposalMilestone, 'id'>[];
     relevantExperience: string;
     potentialMatches?: number;
     guarantees?: string[];
@@ -185,7 +188,8 @@ export interface ProposalCreateInput {
     customTerms?: string;
 }
 export type ContractStatus = 'pending_payment' | 'active' | 'paused' | 'completed' | 'disputed' | 'cancelled' | 'terminated';
-export interface Contract extends TimestampFields {
+export type ContractCancelledBy = 'family' | 'company' | 'admin';
+export interface IContract extends ITimestampFields {
     id: string;
     proposalId: string;
     requirementId: string;
@@ -209,7 +213,7 @@ export interface Contract extends TimestampFields {
     completedAt?: Date;
     cancelledAt?: Date;
     cancellationReason?: string;
-    cancelledBy?: 'family' | 'company' | 'admin';
+    cancelledBy?: ContractCancelledBy;
     currentMilestoneId?: string;
     completedMilestones: string[];
     progressPercentage: number;
@@ -225,7 +229,7 @@ export interface Contract extends TimestampFields {
     startedAt?: Date;
 }
 export type MilestoneStatus = 'upcoming' | 'in_progress' | 'pending_approval' | 'approved' | 'disputed' | 'paid' | 'refunded';
-export interface Milestone extends TimestampFields {
+export interface IMilestone extends ITimestampFields {
     id: string;
     contractId: string;
     proposalMilestoneId?: string;
@@ -251,13 +255,13 @@ export interface Milestone extends TimestampFields {
 }
 export type CollaborationType = 'match_request' | 'referral' | 'partnership' | 'pool_join' | 'event_collab';
 export type CollaborationStatus = 'pending' | 'accepted' | 'rejected' | 'active' | 'completed' | 'cancelled';
-export interface CollaborationTerms {
+export interface ICollaborationTerms {
     revenueShare: number;
     leadCompany: string;
     communicationRules: string;
     exclusivityPeriod?: number;
 }
-export interface CollaborationRequest extends TimestampFields {
+export interface ICollaborationRequest extends ITimestampFields {
     id: string;
     fromCompanyId: string;
     toCompanyId: string;
@@ -266,28 +270,29 @@ export interface CollaborationRequest extends TimestampFields {
     description: string;
     profileId?: string;
     requirementId?: string;
-    terms: CollaborationTerms;
+    terms: ICollaborationTerms;
     status: CollaborationStatus;
     respondedAt?: Date;
     responseMessage?: string;
     matchId?: string;
     revenueGenerated?: number;
 }
-export interface CollaborationRequestCreateInput {
+export interface ICollaborationRequestCreateInput {
     toCompanyId: string;
     type: CollaborationType;
     title: string;
     description: string;
     profileId?: string;
     requirementId?: string;
-    terms: CollaborationTerms;
+    terms: ICollaborationTerms;
 }
 export type ReviewType = 'contract_review' | 'collaboration_review' | 'success_story';
-export interface Review extends TimestampFields {
+export type ReviewerType = 'family' | 'company';
+export interface IReview extends ITimestampFields {
     id: string;
     type: ReviewType;
     reviewerId: string;
-    reviewerType: 'family' | 'company';
+    reviewerType: ReviewerType;
     reviewerName: string;
     reviewedId: string;
     contractId?: string;
@@ -310,7 +315,7 @@ export interface Review extends TimestampFields {
     moderatedAt?: Date;
     moderatedBy?: string;
 }
-export interface ReviewCreateInput {
+export interface IReviewCreateInput {
     type: ReviewType;
     reviewedId: string;
     contractId?: string;
@@ -330,16 +335,17 @@ export interface ReviewCreateInput {
     photos?: string[];
 }
 export type EscrowStatus = 'pending' | 'funded' | 'partially_released' | 'released' | 'refunded' | 'disputed';
-export interface EscrowTransaction {
+export type EscrowTransactionType = 'deposit' | 'release' | 'refund';
+export interface IEscrowTransaction {
     id: string;
-    type: 'deposit' | 'release' | 'refund';
+    type: EscrowTransactionType;
     amount: number;
     milestoneId?: string;
     description: string;
     createdAt: Date;
     processedAt?: Date;
 }
-export interface Escrow extends TimestampFields {
+export interface IEscrow extends ITimestampFields {
     id: string;
     contractId: string;
     accountId: string;
@@ -351,7 +357,7 @@ export interface Escrow extends TimestampFields {
     availableBalance: number;
     currency: string;
     status: EscrowStatus;
-    transactions: EscrowTransaction[];
+    transactions: IEscrowTransaction[];
     platformFeePercentage: number;
     platformFeeAmount: number;
     disputeId?: string;
@@ -362,7 +368,7 @@ export interface Escrow extends TimestampFields {
 export type TMCStatus = 'none' | 'pending' | 'approved' | 'suspended';
 export type TMCTier = 'standard' | 'gold' | 'platinum';
 export type TMCApprovalMethod = 'manual' | 'criteria';
-export interface TMCFields {
+export interface ITMCFields {
     isTrustManagementCompany: boolean;
     tmcStatus: TMCStatus;
     tmcTier?: TMCTier;
@@ -376,7 +382,21 @@ export interface TMCFields {
     maxManagedCompanies: number;
 }
 export type TMCApplicationStatus = 'pending' | 'under_review' | 'approved' | 'rejected';
-export interface TMCApplication extends TimestampFields {
+export type TMCDocumentType = 'business_license' | 'track_record' | 'reference_letter' | 'other';
+export interface ITMCApplicationDocument {
+    type: TMCDocumentType;
+    url: string;
+    name: string;
+    uploadedAt: Date;
+}
+export interface ITMCApplicationReference {
+    name: string;
+    company: string;
+    email: string;
+    phone?: string;
+    relationship: string;
+}
+export interface ITMCApplication extends ITimestampFields {
     id: string;
     companyId: string;
     companyName: string;
@@ -386,19 +406,8 @@ export interface TMCApplication extends TimestampFields {
     currentTrustLevel: string;
     specializations: string[];
     geographicCoverage: string[];
-    documents: {
-        type: 'business_license' | 'track_record' | 'reference_letter' | 'other';
-        url: string;
-        name: string;
-        uploadedAt: Date;
-    }[];
-    references: {
-        name: string;
-        company: string;
-        email: string;
-        phone?: string;
-        relationship: string;
-    }[];
+    documents: ITMCApplicationDocument[];
+    references: ITMCApplicationReference[];
     status: TMCApplicationStatus;
     reviewedAt?: Date;
     reviewedBy?: string;
@@ -406,28 +415,18 @@ export interface TMCApplication extends TimestampFields {
     rejectionReason?: string;
     approvedTier?: TMCTier;
 }
-export interface TMCApplicationCreateInput {
+export interface ITMCApplicationCreateInput {
     applicationLetter: string;
     yearsInBusiness: number;
     totalMatchesFacilitated: number;
     specializations: string[];
     geographicCoverage: string[];
-    documents: {
-        type: 'business_license' | 'track_record' | 'reference_letter' | 'other';
-        url: string;
-        name: string;
-    }[];
-    references: {
-        name: string;
-        company: string;
-        email: string;
-        phone?: string;
-        relationship: string;
-    }[];
+    documents: Omit<ITMCApplicationDocument, 'uploadedAt'>[];
+    references: ITMCApplicationReference[];
 }
 export type TMCMembershipStatus = 'pending' | 'active' | 'suspended' | 'revoked';
 export type VouchLevel = 'basic' | 'standard' | 'full';
-export interface TMCMembership extends TimestampFields {
+export interface ITMCMembership extends ITimestampFields {
     id: string;
     companyId: string;
     tmcCompanyId: string;
@@ -446,14 +445,14 @@ export interface TMCMembership extends TimestampFields {
     totalProfitShared: number;
     lastProfitShareDate?: Date;
 }
-export interface TMCMembershipInviteInput {
+export interface ITMCMembershipInviteInput {
     companyId: string;
     vouchLevel: VouchLevel;
     profitSharePercentage: number;
     contractTerms?: string;
 }
 export type BadgeType = 'verified' | 'endorsed' | 'premium_partner' | 'top_performer' | 'founding_partner';
-export interface TrustBadge extends TimestampFields {
+export interface ITrustBadge extends ITimestampFields {
     id: string;
     companyId: string;
     tmcCompanyId?: string;
@@ -471,13 +470,14 @@ export interface TrustBadge extends TimestampFields {
     showOnListing: boolean;
     showOnSearch: boolean;
 }
-export interface ProfitShareAgreement extends TimestampFields {
+export type ProfitShareAppliesTo = 'contracts' | 'subscriptions' | 'profile_packs';
+export interface IProfitShareAgreement extends ITimestampFields {
     id: string;
     companyId: string;
     tmcCompanyId: string;
     membershipId: string;
     sharePercentage: number;
-    appliesTo: ('contracts' | 'subscriptions' | 'profile_packs')[];
+    appliesTo: ProfitShareAppliesTo[];
     minimumEarningThreshold?: number;
     monthlyCapAmount?: number;
     startDate: Date;
@@ -488,12 +488,14 @@ export interface ProfitShareAgreement extends TimestampFields {
     transactionCount: number;
 }
 export type ProfitShareStatus = 'pending' | 'processing' | 'completed' | 'failed';
-export interface ProfitShare extends TimestampFields {
+export type ProfitShareTriggerType = 'contract_payment' | 'milestone_release' | 'subscription';
+export type ProfitSharePayoutMethod = 'stripe_connect' | 'manual';
+export interface IProfitShare extends ITimestampFields {
     id: string;
     agreementId: string;
     companyId: string;
     tmcCompanyId: string;
-    triggerType: 'contract_payment' | 'milestone_release' | 'subscription';
+    triggerType: ProfitShareTriggerType;
     triggerId: string;
     originalAmount: number;
     sharePercentage: number;
@@ -505,18 +507,22 @@ export interface ProfitShare extends TimestampFields {
     processedAt?: Date;
     paidAt?: Date;
     failureReason?: string;
-    payoutMethod: 'stripe_connect' | 'manual';
+    payoutMethod: ProfitSharePayoutMethod;
     stripeTransferId?: string;
 }
 export type DisputePhase = 'discussion' | 'mediation' | 'admin_review' | 'resolved';
 export type DisputeStatus = 'open' | 'awaiting_response' | 'in_mediation' | 'escalated' | 'resolved' | 'closed';
 export type DisputeResolution = 'full_refund' | 'partial_refund' | 'release_to_company' | 'split' | 'withdrawn' | 'mutual_agreement';
 export type EvidenceType = 'text' | 'file' | 'image' | 'video' | 'chat_log' | 'contract_doc';
-export interface DisputeEvidence extends TimestampFields {
+export type DisputeCategory = 'service_not_delivered' | 'quality_issue' | 'communication_problem' | 'misrepresentation' | 'timeline_breach' | 'refund_request' | 'other';
+export type DisputeInitiatedBy = 'family' | 'company';
+export type EscalatedBy = 'auto' | 'family' | 'company' | 'admin';
+export type SubmitterType = 'family' | 'company';
+export interface IDisputeEvidence extends ITimestampFields {
     id: string;
     disputeId: string;
     submittedBy: string;
-    submitterType: 'family' | 'company';
+    submitterType: SubmitterType;
     type: EvidenceType;
     title: string;
     description: string;
@@ -528,29 +534,30 @@ export interface DisputeEvidence extends TimestampFields {
     isVisible: boolean;
     adminOnly: boolean;
 }
-export interface Dispute extends TimestampFields {
+export interface IDisputePhaseHistoryEntry {
+    phase: DisputePhase;
+    startedAt: Date;
+    endedAt?: Date;
+    escalatedBy: EscalatedBy;
+    notes?: string;
+}
+export interface IDispute extends ITimestampFields {
     id: string;
     contractId: string;
     escrowId: string;
     accountId: string;
     companyId: string;
-    initiatedBy: 'family' | 'company';
+    initiatedBy: DisputeInitiatedBy;
     initiatedAt: Date;
     title: string;
     description: string;
-    category: 'service_not_delivered' | 'quality_issue' | 'communication_problem' | 'misrepresentation' | 'timeline_breach' | 'refund_request' | 'other';
+    category: DisputeCategory;
     amountInDispute: number;
     currency: string;
     currentPhase: DisputePhase;
     phaseStartedAt: Date;
     autoEscalateAt: Date;
-    phaseHistory: {
-        phase: DisputePhase;
-        startedAt: Date;
-        endedAt?: Date;
-        escalatedBy: 'auto' | 'family' | 'company' | 'admin';
-        notes?: string;
-    }[];
+    phaseHistory: IDisputePhaseHistoryEntry[];
     familyEvidenceSubmitted: boolean;
     companyEvidenceSubmitted: boolean;
     evidenceDeadline?: Date;
@@ -565,19 +572,82 @@ export interface Dispute extends TimestampFields {
     assignedAt?: Date;
     adminNotes?: string;
 }
-export interface DisputeCreateInput {
+export interface IDisputeEvidenceCreateInput {
+    type: EvidenceType;
+    title: string;
+    description: string;
+    content?: string;
+    fileUrl?: string;
+    fileName?: string;
+}
+export interface IDisputeCreateInput {
     contractId: string;
     title: string;
     description: string;
-    category: Dispute['category'];
+    category: DisputeCategory;
     amountInDispute?: number;
-    initialEvidence?: {
-        type: EvidenceType;
-        title: string;
-        description: string;
-        content?: string;
-        fileUrl?: string;
-        fileName?: string;
-    }[];
+    initialEvidence?: IDisputeEvidenceCreateInput[];
 }
+/** @deprecated Use IServicePackage instead */
+export type ServicePackage = IServicePackage;
+/** @deprecated Use IServiceListing instead */
+export type ServiceListing = IServiceListing;
+/** @deprecated Use IServiceListingCreateInput instead */
+export type ServiceListingCreateInput = IServiceListingCreateInput;
+/** @deprecated Use IRequirementPreferences instead */
+export type RequirementPreferences = IRequirementPreferences;
+/** @deprecated Use IRequirementPost instead */
+export type RequirementPost = IRequirementPost;
+/** @deprecated Use IRequirementPostCreateInput instead */
+export type RequirementPostCreateInput = IRequirementPostCreateInput;
+/** @deprecated Use IProposalMilestone instead */
+export type ProposalMilestone = IProposalMilestone;
+/** @deprecated Use IProposal instead */
+export type Proposal = IProposal;
+/** @deprecated Use IProposalCreateInput instead */
+export type ProposalCreateInput = IProposalCreateInput;
+/** @deprecated Use IContract instead */
+export type Contract = IContract;
+/** @deprecated Use IMilestone instead */
+export type Milestone = IMilestone;
+/** @deprecated Use ICollaborationTerms instead */
+export type CollaborationTerms = ICollaborationTerms;
+/** @deprecated Use ICollaborationRequest instead */
+export type CollaborationRequest = ICollaborationRequest;
+/** @deprecated Use ICollaborationRequestCreateInput instead */
+export type CollaborationRequestCreateInput = ICollaborationRequestCreateInput;
+/** @deprecated Use IReview instead */
+export type Review = IReview;
+/** @deprecated Use IReviewCreateInput instead */
+export type ReviewCreateInput = IReviewCreateInput;
+/** @deprecated Use IEscrowTransaction instead */
+export type EscrowTransaction = IEscrowTransaction;
+/** @deprecated Use IEscrow instead */
+export type Escrow = IEscrow;
+/** @deprecated Use ITMCFields instead */
+export type TMCFields = ITMCFields;
+/** @deprecated Use ITMCApplicationDocument instead */
+export type TMCApplicationDocument = ITMCApplicationDocument;
+/** @deprecated Use ITMCApplicationReference instead */
+export type TMCApplicationReference = ITMCApplicationReference;
+/** @deprecated Use ITMCApplication instead */
+export type TMCApplication = ITMCApplication;
+/** @deprecated Use ITMCApplicationCreateInput instead */
+export type TMCApplicationCreateInput = ITMCApplicationCreateInput;
+/** @deprecated Use ITMCMembership instead */
+export type TMCMembership = ITMCMembership;
+/** @deprecated Use ITMCMembershipInviteInput instead */
+export type TMCMembershipInviteInput = ITMCMembershipInviteInput;
+/** @deprecated Use ITrustBadge instead */
+export type TrustBadge = ITrustBadge;
+/** @deprecated Use IProfitShareAgreement instead */
+export type ProfitShareAgreement = IProfitShareAgreement;
+/** @deprecated Use IProfitShare instead */
+export type ProfitShare = IProfitShare;
+/** @deprecated Use IDisputeEvidence instead */
+export type DisputeEvidence = IDisputeEvidence;
+/** @deprecated Use IDispute instead */
+export type Dispute = IDispute;
+/** @deprecated Use IDisputeCreateInput instead */
+export type DisputeCreateInput = IDisputeCreateInput;
 //# sourceMappingURL=marketplace.d.ts.map