@taskforcehq/taskforce 0.3.170 → 0.3.301

package/dist/core/types.d.ts

@@ -0,0 +1,614 @@
+/**
+ * Taskforce Core Type Definitions
+ *
+ * Centralises all shared interfaces, type aliases, and enums used across
+ * the Taskforce domain modules and public API surface.
+ *
+ * Key exports:
+ *   - TaskItem, TaskStatus, TaskAssignee — core task shape
+ *   - TaskforceRuleError — structured error class thrown by business logic
+ *   - Entitlement/Plan types — billing and plan enforcement shapes
+ *   - MCP token and OAuth types — API access credentials
+ *   - Workspace/User record types — multi-tenancy shapes
+ *   - Config/Settings types — workspace and global configuration shapes
+ */
+import type { DatabaseProvider } from '../storage/databaseAdapter.js';
+export type { TaskforceTheme } from '../utils/theme.js';
+import type { TaskforceTheme } from '../utils/theme.js';
+export interface Comment {
+    id: string;
+    author: string;
+    submittedAuthor?: string;
+    text: string;
+    timestamp: string;
+}
+export type TaskStatus = 'task' | 'on-hold' | 'in-progress' | 'review' | 'done' | 'cancelled';
+export type TaskAssignee = string;
+export interface TaskItem {
+    id: string;
+    referenceNumber?: number | null;
+    referenceLabel?: string;
+    title: string;
+    description: string | null;
+    category: string;
+    type: string;
+    priority: number;
+    complexity: number;
+    status: TaskStatus;
+    approach?: string;
+    createdAt: string;
+    updatedAt?: string;
+    completedAt?: string | null;
+    /** @deprecated */
+    inProgress?: boolean;
+    /** @deprecated */
+    readyForReview?: boolean;
+    comments?: Comment[];
+    attachments?: Array<string | {
+        path: string;
+        fsPath?: string;
+        caption?: string;
+        displayName?: string;
+        originalFilename?: string;
+        assetId?: string;
+        referenceNumber?: number | null;
+        referenceLabel?: string;
+        taskId?: string | null;
+        timestamp?: string;
+    }>;
+    /** @deprecated */
+    completed?: boolean;
+    /** @deprecated */
+    cancelled?: boolean;
+    taxonomies?: Record<string, string | string[]>;
+    createdBy?: string;
+    assignee?: TaskAssignee;
+    canceledReason?: string;
+    isArchived?: boolean;
+    isDeleted?: boolean;
+    deletedRecordId?: string | null;
+    scheduledDate?: string | null;
+    dueDate?: string | null;
+    scheduledWeekKey?: string | null;
+    orderInDay?: number | null;
+}
+export interface TaskWarning {
+    code: string;
+    severity: 'warning';
+    title: string;
+    message: string;
+    requiresConfirmation: boolean;
+}
+export interface ScheduleBoardColumns {
+    backlog: TaskItem[];
+    expired: TaskItem[];
+    mon: TaskItem[];
+    tue: TaskItem[];
+    wed: TaskItem[];
+    thu: TaskItem[];
+    fri: TaskItem[];
+    sat?: TaskItem[];
+    sun?: TaskItem[];
+}
+export interface ScheduleBoardResult {
+    week: string;
+    columns: ScheduleBoardColumns;
+    meta: {
+        showWeekends: boolean;
+        capacityWarnings: Array<{
+            date: string;
+            level: 'soft';
+        }>;
+    };
+}
+export type RealtimeMutationEntityType = 'task' | 'taxonomy' | 'document-metadata';
+export interface RealtimeMutationEvent {
+    eventId: string;
+    workspaceId: string;
+    cursor: string;
+    serverEpoch: string;
+    seq: number;
+    entityType: RealtimeMutationEntityType;
+    changeType: string;
+    entityIds: string[];
+    dataVersion: number;
+    serverTs: string;
+}
+export declare class TaskforceRuleError extends Error {
+    statusCode: number;
+    code: string;
+    details?: unknown;
+    constructor(message: string, statusCode?: number, code?: string, details?: unknown);
+}
+export interface CategoryConfig {
+    value: string;
+    label: string;
+    aliases?: string[];
+    path?: string;
+    paths?: string[];
+    specialistFile?: string;
+    icon?: string;
+    color?: string;
+    disabled?: boolean;
+}
+export interface TaskforceConfig {
+    projectRoot: string;
+    storagePath?: string;
+    tenantId?: string;
+    runtimeMode?: RuntimeMode;
+    database?: {
+        provider?: DatabaseProvider;
+        connectionString?: string;
+    };
+}
+export interface TaskFile {
+    tasks: TaskItem[];
+    config?: {
+        categories?: Array<string | CategoryConfig>;
+        types?: Array<{
+            value: string;
+            label: string;
+            color?: string;
+            icon?: string;
+            aliases?: string[];
+            status?: 'active' | 'retired';
+        }>;
+        priorities?: Array<{
+            value: number;
+            label: string;
+            color?: string;
+            icon?: string;
+        }>;
+        complexities?: Array<{
+            value: number;
+            label: string;
+            color?: string;
+            icon?: string;
+        }>;
+        approaches?: Array<{
+            value: string;
+            label: string;
+            color?: string;
+            icon?: string;
+        }>;
+        theme?: TaskforceTheme;
+        shortcut?: string;
+        jsonBackupEnabled?: boolean;
+        manualComplexityEnabled?: boolean;
+        checklistDropdownEnabled?: boolean;
+        taxonomies?: any[];
+    };
+}
+export interface ArchiveFile {
+    archived: TaskItem[];
+}
+export interface BulkCreateTaskError {
+    index: number;
+    message: string;
+    statusCode?: number;
+    code?: string;
+    details?: unknown;
+}
+export interface BulkCreateTaskResult {
+    created: TaskItem[];
+    errors: BulkCreateTaskError[];
+    total: number;
+    atomic: boolean;
+    validateOnly: boolean;
+}
+export interface BulkUpdateFieldsPreviewItem {
+    id: string;
+    index: number;
+    fields: Record<string, any>;
+    changedFields: string[];
+}
+export interface BulkUpdateFieldsPreviewSkipped {
+    index: number;
+    id?: string;
+    message: string;
+    statusCode: number;
+    code: string;
+}
+export interface BulkUpdateFieldsPreview {
+    total: number;
+    deduped: number;
+    toApply: BulkUpdateFieldsPreviewItem[];
+    skipped: BulkUpdateFieldsPreviewSkipped[];
+    byField: Record<string, number>;
+    priorityBefore?: Record<number, number>;
+    priorityAfter?: Record<number, number>;
+}
+export interface InitiativeTemplateMilestone {
+    title: string;
+    description: string;
+    priority?: number;
+    approach?: string;
+    category?: string;
+}
+export interface InitiativeTemplate {
+    id: string;
+    name: string;
+    description: string;
+    checklistBlocks: {
+        definitionOfDone: string[];
+        rollbackPlan: string[];
+    };
+    milestones: InitiativeTemplateMilestone[];
+}
+export interface GlobalTaskforceSettings {
+    theme?: TaskforceTheme;
+    shortcut?: string;
+    jsonBackupEnabled?: boolean;
+    realtimeSyncEnabled?: boolean;
+    schedulePreferences?: {
+        showWeekends?: boolean;
+        isCalendarSidebarOpen?: boolean;
+        weekStartsOn?: 'sunday' | 'monday';
+        dailyCapacity?: {
+            monday?: number;
+            tuesday?: number;
+            wednesday?: number;
+            thursday?: number;
+            friday?: number;
+            saturday?: number;
+            sunday?: number;
+        };
+    };
+    email?: {
+        provider?: 'console' | 'resend' | 'google-workspace';
+        from?: string;
+        replyTo?: string;
+        providerApiKey?: string;
+    };
+    auth?: {
+        allowSelfRegistration?: boolean;
+        requireVerifiedEmail?: boolean;
+        defaultNewUserBetaAccess?: boolean;
+        authRateLimitEnabled?: boolean;
+        authRateLimitMaxRequests?: number;
+        authRateLimitWindowMs?: number;
+        signupMonetizationStrategy?: 'auto_assign_default' | 'plan_selection_required';
+        defaultSignupPlanVersionId?: string | null;
+    };
+    site?: {
+        showRunTaskforceLocally?: boolean;
+        pricingPageEnabled?: boolean;
+    };
+    setup?: {
+        mode?: 'core' | 'operations';
+        forceSetup?: boolean;
+        forceGlobalSetup?: boolean;
+        forceWorkspaceSetup?: boolean;
+    };
+    objectStorage?: {
+        keyPrefix?: string;
+        signedUploadTtlSeconds?: number;
+        signedDownloadTtlSeconds?: number;
+    };
+}
+export interface SettingsSplitPayload {
+    system: GlobalTaskforceSettings;
+    userPreferences: GlobalTaskforceSettings;
+}
+export interface UserGlobalSyncSettings {
+    theme?: TaskforceTheme;
+    operatingMode?: 'core' | 'operations';
+    localization?: {
+        locale?: string;
+        weekStartsOn?: 'sunday' | 'monday';
+    };
+}
+export type SignupMonetizationStrategy = 'auto_assign_default' | 'plan_selection_required';
+export interface SignupMonetizationSettings {
+    strategy: SignupMonetizationStrategy;
+    defaultSignupPlanVersionId: string | null;
+}
+export interface SignupMonetizationValidationResult {
+    valid: boolean;
+    code?: 'SIGNUP_PLAN_VERSION_REQUIRED' | 'SIGNUP_PLAN_VERSION_NOT_FOUND' | 'SIGNUP_PLAN_NOT_ENABLED';
+    message?: string;
+    details?: Record<string, unknown>;
+}
+export type AccessRole = 'owner' | 'admin' | 'member' | 'read-only';
+export type SystemRole = 'system_admin' | 'user';
+export type PermissionMode = 'read-only' | 'read-write';
+export type AuthTokenPurpose = 'email_verification' | 'password_reset' | 'invite_accept';
+export type McpAccessTokenScope = 'tasks:read' | 'tasks:write' | 'workspace:read';
+export type McpAccessTokenStatus = 'active' | 'revoked' | 'expired';
+export type McpOAuthProvider = 'chatgpt' | 'claude';
+export type McpOAuthClientStatus = 'active' | 'revoked';
+export type McpOAuthGrantStatus = 'active' | 'revoked';
+export interface UserAccessRecord {
+    userId: string;
+    workspaceId: string;
+    role: AccessRole;
+    permissionMode: PermissionMode;
+    disabled: boolean;
+    betaAccess: boolean;
+}
+export interface UserIdentityRecord {
+    userId: string;
+    email: string;
+    displayName?: string | null;
+    systemRole?: SystemRole;
+    betaAccess?: boolean;
+}
+export interface WorkspaceUserRecord {
+    userId: string;
+    email: string;
+    displayName?: string | null;
+    role: AccessRole;
+    permissionMode: PermissionMode;
+    betaAccess: boolean;
+    status: string;
+    disabled: boolean;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    emailVerifiedAt?: string | null;
+}
+export interface SystemUserRecord {
+    userId: string;
+    email: string;
+    displayName?: string | null;
+    systemRole: SystemRole;
+    betaAccess: boolean;
+    disabled: boolean;
+    planId?: string | null;
+    planName?: string | null;
+    planVersionId?: string | null;
+    entitlementState?: EntitlementState | null;
+    createdAt?: string | null;
+    updatedAt?: string | null;
+    emailVerifiedAt?: string | null;
+}
+export type SetupState = 'present' | 'missing' | 'unreadable';
+export type RuntimeMode = 'local' | 'cloud';
+export type WorkspaceMode = 'core' | 'operations';
+export interface WorkspaceProfileRecord {
+    id: string;
+    slug?: string | null;
+    name: string;
+    description?: string | null;
+}
+export interface UserWorkspaceRecord {
+    id: string;
+    slug?: string | null;
+    name: string;
+    description?: string | null;
+    role: AccessRole;
+    status: string;
+    betaAccess: boolean;
+}
+export interface WorkspaceDeletedAssetRecord {
+    path: string;
+    provider: 'local' | 'r2';
+    workspaceId: string;
+}
+export interface WorkspaceDeleteSummary {
+    deletedWorkspaceId: string;
+    deletedTaskIds: string[];
+    deletedDocumentPaths: string[];
+    deletedAssets: WorkspaceDeletedAssetRecord[];
+    counts: Record<string, number>;
+}
+export interface SetupStateSnapshot {
+    globalSetupState: SetupState;
+    workspaceSetupState: SetupState;
+    runtimeMode: RuntimeMode;
+    workspaceId: string;
+    mode: WorkspaceMode;
+    forceSetup: boolean;
+    forceGlobalSetup: boolean;
+    forceWorkspaceSetup: boolean;
+    workspace?: WorkspaceProfileRecord | null;
+    suggestedWorkspaceName?: string;
+}
+export interface WorkspaceProfileUpdateInput {
+    name: string;
+    description?: string | null;
+    slug?: string | null;
+}
+export interface CreateTaskOptions {
+    persistBackup?: boolean;
+    workspaceId?: string;
+    allowClientProvidedId?: boolean;
+    skipRecompute?: boolean;
+    syncUpdatedAt?: string;
+}
+export interface AdminAuditLogRecord {
+    id: string;
+    ts: string;
+    action: string;
+    actorUserId: string;
+    actorRole: string;
+    workspaceId: string;
+    details: Record<string, unknown>;
+}
+export interface McpAuditLogRecord {
+    id: string;
+    ts: string;
+    workspaceId: string;
+    actorType: 'local' | 'user' | 'token' | 'oauth';
+    actorUserId: string;
+    tokenId: string | null;
+    toolName: string;
+    requestId: string | null;
+    ip: string | null;
+    userAgent: string | null;
+    outcome: 'allow' | 'deny' | null;
+    reasonCode: string | null;
+    details: Record<string, unknown>;
+}
+export type EntitlementState = 'active' | 'trialing' | 'grace' | 'suspended' | 'canceled';
+export type PlanFeatureAccess = 'enabled' | 'disabled' | 'limited';
+export interface PlanFeatureSnapshot {
+    featureKey: string;
+    access: PlanFeatureAccess;
+    config: Record<string, unknown>;
+}
+export interface PlanFeatureCatalogItem {
+    featureKey: string;
+    label: string;
+    description: string;
+    allowedAccessModes: PlanFeatureAccess[];
+    configTemplate: Record<string, unknown>;
+    dependsOn?: string[];
+}
+export interface PlanVersionSnapshot {
+    planVersionId: string;
+    planId: string;
+    versionNumber: number;
+    isDefault: boolean;
+    seatLimit: number | null;
+    trialDays: number;
+    metadata: Record<string, unknown>;
+    features: Record<string, PlanFeatureSnapshot>;
+}
+export interface PlanCatalogSnapshot {
+    planId: string;
+    displayName: string;
+    status: 'active' | 'archived';
+    createdAt: string;
+    updatedAt: string;
+}
+export interface AccountEntitlementSnapshot {
+    accountId: string;
+    planVersionId: string;
+    planId: string;
+    state: EntitlementState;
+    effectiveAt: string | null;
+    effectiveUntil: string | null;
+    version: PlanVersionSnapshot;
+}
+export interface SeatUsageSnapshot {
+    used: number;
+    limit: number | null;
+    remaining: number | null;
+}
+export interface FeatureEvaluationResult {
+    allowed: boolean;
+    reasonCode: string;
+    state: EntitlementState;
+    seatUsage?: SeatUsageSnapshot;
+    feature?: PlanFeatureSnapshot;
+}
+export interface AccountAccessStatus_Ok {
+    gate: 'ok';
+    hasEntitlement: true;
+    canAccessApp: true;
+    canAccessPlans: true;
+    signupMonetizationStrategy: SignupMonetizationStrategy;
+    planSelectionRequired: false;
+    message: null;
+    entitlement: AccountEntitlementSnapshot;
+}
+export interface AccountAccessStatus_Blocked {
+    gate: 'plan_selection_required' | 'misconfigured' | 'missing_entitlement';
+    hasEntitlement: boolean;
+    canAccessApp: false;
+    canAccessPlans: true;
+    signupMonetizationStrategy: SignupMonetizationStrategy;
+    planSelectionRequired: boolean;
+    message: string;
+    entitlement: AccountEntitlementSnapshot | null;
+}
+export type AccountAccessStatus = AccountAccessStatus_Ok | AccountAccessStatus_Blocked;
+export interface PasswordAuthResult {
+    ok: boolean;
+    access?: {
+        userId: string;
+        workspaceId: string;
+        role: AccessRole;
+    };
+    code?: 'INVALID_CREDENTIALS' | 'EMAIL_NOT_VERIFIED';
+}
+export interface AuthTokenInspection {
+    state: 'valid' | 'expired' | 'used' | 'missing' | 'revoked';
+    userId?: string;
+    workspaceId?: string;
+}
+export interface McpAccessTokenRecord {
+    id: string;
+    workspaceId: string;
+    userId: string;
+    userEmail?: string | null;
+    name: string;
+    scopes: McpAccessTokenScope[];
+    tokenPrefix: string;
+    status: McpAccessTokenStatus;
+    lastUsedAt?: string | null;
+    lastUsedIp?: string | null;
+    lastUsedUserAgent?: string | null;
+    createdByIp?: string | null;
+    expiresAt?: string | null;
+    revokedAt?: string | null;
+    revokedByUserId?: string | null;
+    createdAt: string;
+    updatedAt?: string | null;
+}
+export interface McpAccessTokenListResult {
+    items: McpAccessTokenRecord[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+export interface McpAccessTokenIssueResult {
+    token: string;
+    record: McpAccessTokenRecord;
+}
+export interface McpAccessTokenAuthResult {
+    tokenId: string;
+    workspaceId: string;
+    userId: string;
+    scopes: McpAccessTokenScope[];
+    status: McpAccessTokenStatus;
+}
+export interface McpAccessTokenInspectionResult {
+    tokenId: string;
+    tokenPrefix: string;
+    workspaceId: string;
+    userId: string;
+    name: string;
+    scopes: McpAccessTokenScope[];
+    status: McpAccessTokenStatus;
+}
+export interface McpOAuthClientRecord {
+    id: string;
+    provider: McpOAuthProvider;
+    clientName: string;
+    redirectUris: string[];
+    status: McpOAuthClientStatus;
+    createdAt: string;
+    updatedAt?: string | null;
+}
+export interface McpOAuthConnectorGrantRecord {
+    id: string;
+    provider: McpOAuthProvider;
+    clientId: string;
+    clientName: string;
+    workspaceId: string;
+    userId: string;
+    scopes: McpAccessTokenScope[];
+    tokenPrefix: string;
+    status: McpOAuthGrantStatus;
+    lastUsedAt?: string | null;
+    revokedAt?: string | null;
+    revokedByUserId?: string | null;
+    createdAt: string;
+    updatedAt?: string | null;
+}
+export interface McpOAuthTokenExchangeResult {
+    accessToken: string;
+    tokenType: 'Bearer';
+    scopes: McpAccessTokenScope[];
+    grant: McpOAuthConnectorGrantRecord;
+}
+export interface McpOAuthAccessTokenAuthResult {
+    grantId: string;
+    workspaceId: string;
+    userId: string;
+    clientId: string;
+    provider: McpOAuthProvider;
+    scopes: McpAccessTokenScope[];
+    status: McpOAuthGrantStatus;
+}

package/dist/core/types.js

@@ -0,0 +1,27 @@
+/**
+ * Taskforce Core Type Definitions
+ *
+ * Centralises all shared interfaces, type aliases, and enums used across
+ * the Taskforce domain modules and public API surface.
+ *
+ * Key exports:
+ *   - TaskItem, TaskStatus, TaskAssignee — core task shape
+ *   - TaskforceRuleError — structured error class thrown by business logic
+ *   - Entitlement/Plan types — billing and plan enforcement shapes
+ *   - MCP token and OAuth types — API access credentials
+ *   - Workspace/User record types — multi-tenancy shapes
+ *   - Config/Settings types — workspace and global configuration shapes
+ */
+// === SECTION: Error types ===
+export class TaskforceRuleError extends Error {
+    statusCode;
+    code;
+    details;
+    constructor(message, statusCode = 400, code = 'TASK_RULE_VIOLATION', details) {
+        super(message);
+        this.name = 'TaskforceRuleError';
+        this.statusCode = statusCode;
+        this.code = code;
+        this.details = details;
+    }
+}

package/dist/documentReviews/DocumentReviewCommentStore.d.ts

@@ -0,0 +1,56 @@
+import type { DatabaseAdapter } from '../storage/databaseAdapter.js';
+import type { DocumentReviewAnchor, DocumentReviewCommentRecord, DocumentReviewCommentSyncRecord } from './types.js';
+export declare class DocumentReviewCommentStore {
+    private readonly db;
+    private readonly tenantId;
+    constructor(db: DatabaseAdapter, tenantId: string);
+    listForSession(sessionIdRaw: string, workspaceIdRaw: string, options?: {
+        includeDeleted?: boolean;
+    }): DocumentReviewCommentSyncRecord[];
+    listByWorkspace(workspaceIdRaw: string, options?: {
+        includeDeleted?: boolean;
+    }): DocumentReviewCommentSyncRecord[];
+    create(input: {
+        id: string;
+        sessionId: string;
+        workspaceId: string;
+        body: string;
+        anchor?: DocumentReviewAnchor | null;
+        order: number;
+        authorActorId?: string | null;
+        createdAt?: string;
+        updatedAt?: string;
+        deletedAt?: string | null;
+    }): DocumentReviewCommentSyncRecord;
+    get(commentIdRaw: string, workspaceIdRaw: string, options?: {
+        includeDeleted?: boolean;
+    }): DocumentReviewCommentSyncRecord | null;
+    update(input: {
+        id: string;
+        workspaceId: string;
+        body?: string;
+        anchor?: DocumentReviewAnchor | null;
+        order?: number;
+        authorActorId?: string | null;
+        updatedAt?: string;
+        deletedAt?: string | null;
+    }): DocumentReviewCommentSyncRecord | null;
+    upsertForSync(input: {
+        id: string;
+        sessionId: string;
+        workspaceId: string;
+        body: string;
+        anchor?: DocumentReviewAnchor | null;
+        order: number;
+        authorActorId?: string | null;
+        createdAt?: string;
+        updatedAt?: string;
+        deletedAt?: string | null;
+    }): DocumentReviewCommentSyncRecord;
+    softDelete(commentIdRaw: string, workspaceIdRaw: string, deletedAtRaw?: string): boolean;
+    replaceForSession(input: {
+        sessionId: string;
+        workspaceId: string;
+        comments: DocumentReviewCommentRecord[];
+    }): void;
+}