@alwith/module-drive 0.0.0-stage → 0.1.0-rc.22

package/dist/contract.d.ts

@@ -0,0 +1,780 @@
+export type AccessRequestOutcome = "submitted" | "alreadyPending";
+export type AccessRequestType = "FILE_ACCESS" | "PROJECT_JOIN";
+export type ArchiveStatus = {
+    enabled: boolean;
+    syncing: boolean;
+    lastRunAt: string | null;
+    lastUploadAt: string | null;
+    synced: number;
+    lastUploaded: number;
+    lastError: string | null;
+    mode: string | null;
+};
+export type CleanupEntry = {
+    projectId: RemoteId;
+    name: string;
+    drivePath: string;
+    localPath: string;
+    files: number;
+};
+export type CleanupReport = {
+    stagingDir: string;
+    candidates: CleanupEntry[];
+    skipped: CleanupSkipped[];
+    moved: CleanupEntry[];
+    failed: string[];
+};
+export type CleanupSkipReason = "pinned" | "pendingChanges";
+export type CleanupSkipped = {
+    name: string;
+    drivePath: string;
+    localPath: string;
+    reason: CleanupSkipReason;
+};
+export type ClientConfig = {
+    collabRelayUrl?: string | null;
+    webBaseUrl?: string | null;
+    serverVersion?: string | null;
+    largeFileThresholdBytes?: number | null;
+    maxUploadBytes?: number | null;
+    features?: {
+        [key in string]: boolean;
+    };
+};
+export type CloudFolder = {
+    path: string;
+    folderId: RemoteId;
+};
+export type CollabSession = {
+    fileId: RemoteId;
+    serverUrl: string;
+    room: string;
+    token: string;
+    canWrite: boolean;
+};
+export type CommentContext = {
+    fileId: RemoteId;
+    currentUserId: RemoteId;
+    isOwner: boolean;
+};
+export type CommentEvent = {
+    fileId: RemoteId;
+    commentId: RemoteId;
+    action: string;
+    actorId: RemoteId | null;
+    at: string | null;
+};
+export type CondenseResult = {
+    knowledgeFileId: RemoteId;
+    knowledgeTitle?: string | null;
+    sourcesLinked?: number | null;
+    humanUrl?: string | null;
+};
+export type Configuration = {
+    deviceId: string | null;
+    userName: string | null;
+    userId: string | null;
+    clientConfig: ClientConfig | null;
+};
+export type ConflictRecord = {
+    projectId: RemoteId;
+    path: string;
+    localPath: string;
+    conflictCopyPath: string | null;
+    remoteUpdatedBy: string | null;
+    at: string;
+};
+export type CreateCommentRequest = {
+    body: string;
+    mentionedUserIds: RemoteId[] | null;
+    parentId: RemoteId | null;
+    quote: string | null;
+    quoteOffset: number | null;
+    suggestedReplacement: string | null;
+};
+export type CreateProjectFromTemplateRequest = {
+    templateId: RemoteId;
+    name: string;
+    scope: ProjectScope;
+    departmentId?: RemoteId | null;
+    topicId?: RemoteId | null;
+};
+export type Department = {
+    id: RemoteId;
+    code?: string | null;
+    name: string;
+    parentId?: RemoteId | null;
+    type?: string | null;
+    path?: string | null;
+};
+export type DiskUsage = {
+    totalBytes: number;
+    totalFiles: number;
+    projects: DiskUsageProject[];
+    files: DiskUsageFile[];
+};
+export type DiskUsageFile = {
+    projectId: RemoteId;
+    projectName: string;
+    path: string;
+    localPath: string;
+    bytes: number;
+};
+export type DiskUsageProject = {
+    projectId: RemoteId;
+    name: string;
+    drivePath: string;
+    localPath: string;
+    bytes: number;
+    files: number;
+};
+export type DriveEvent = {
+    version: number;
+    generation: number;
+    sequence: number;
+    payload: Payload;
+};
+export type DriveRequest = {
+    type: "preferences";
+} | {
+    type: "archivePrivateSessions";
+} | {
+    type: "setArchivePrivate";
+    sessionId: string;
+    private: boolean;
+} | {
+    type: "setPreferences";
+    sessionArchive: boolean;
+    knowledgeInject: boolean;
+} | {
+    type: "archiveSession";
+    expectedGeneration: number;
+    sessionId: string;
+    cwd: string;
+    title: string;
+    updatedAt: string;
+    content: string;
+} | {
+    type: "configuration";
+} | {
+    type: "reconfigure";
+    localRoot: string;
+    userName: string;
+} | {
+    type: "refreshClientConfig";
+} | {
+    type: "mcpSessionConfig";
+} | {
+    type: "retryUpload";
+    projectId: RemoteId;
+    path: string;
+} | {
+    type: "cloudFolders";
+    projectId: RemoteId;
+} | {
+    type: "fileRemoteId";
+    path: string;
+} | {
+    type: "commentContext";
+    path: string;
+} | {
+    type: "comments";
+    fileId: RemoteId;
+} | {
+    type: "commentCreate";
+    fileId: RemoteId;
+    request: CreateCommentRequest;
+} | {
+    type: "commentUpdate";
+    commentId: RemoteId;
+    body: string;
+} | {
+    type: "commentDelete";
+    commentId: RemoteId;
+} | {
+    type: "commentApply";
+    commentId: RemoteId;
+} | {
+    type: "commentWatch";
+    ownerId: string;
+    fileIds: RemoteId[];
+} | {
+    type: "collabSession";
+    path: string;
+    ownerId: string;
+} | {
+    type: "collabEnd";
+    path: string;
+    ownerId: string;
+} | {
+    type: "condensePreflight";
+    projectId: RemoteId;
+    scopePath: string | null;
+} | {
+    type: "condenseStart";
+    projectId: RemoteId;
+    scopePath: string | null;
+} | {
+    type: "job";
+    jobId: RemoteId;
+} | {
+    type: "proposedCondense";
+    projectId: RemoteId;
+} | {
+    type: "approveJob";
+    jobId: RemoteId;
+} | {
+    type: "cancelJob";
+    jobId: RemoteId;
+} | {
+    type: "knowledgeContext";
+    cwd: string;
+} | {
+    type: "skillMirrors";
+} | {
+    type: "archiveStatus";
+} | {
+    type: "syncProject";
+    projectId: RemoteId;
+} | {
+    type: "snapshot";
+} | {
+    type: "moveBetweenProjects";
+    source: string;
+    destination: string;
+} | {
+    type: "login";
+    baseUrl: string;
+    token: string;
+    localRoot: string;
+} | {
+    type: "ssoConfig";
+    baseUrl: string;
+} | {
+    type: "ssoLogin";
+    baseUrl: string;
+    localRoot: string;
+} | {
+    type: "resolveRootOwnership";
+    generation: number;
+    accept: boolean;
+} | {
+    type: "logout";
+} | {
+    type: "start";
+} | {
+    type: "stop";
+} | {
+    type: "maxAutoDownloadMb";
+} | {
+    type: "setMaxAutoDownloadMb";
+    megabytes: number;
+} | {
+    type: "pause";
+    paused: boolean;
+} | {
+    type: "sync";
+} | {
+    type: "roots";
+} | {
+    type: "pin";
+    projectId: RemoteId;
+    pinned: boolean;
+} | {
+    type: "land";
+    projectId: RemoteId;
+} | {
+    type: "file";
+    path: string;
+} | {
+    type: "download";
+    projectId: RemoteId;
+    path: string;
+} | {
+    type: "confirmDeletes";
+    projectId: RemoteId;
+} | {
+    type: "cancelDeletes";
+    projectId: RemoteId;
+} | {
+    type: "templates";
+} | {
+    type: "departments";
+} | {
+    type: "createProject";
+    request: CreateProjectFromTemplateRequest;
+} | {
+    type: "shared";
+} | {
+    type: "failedUploads";
+} | {
+    type: "retryUploads";
+} | {
+    type: "reconcile";
+    projectId: RemoteId | null;
+} | {
+    type: "recheckCloudOnly";
+} | {
+    type: "diskUsage";
+    limit: number;
+} | {
+    type: "cleanupScan";
+} | {
+    type: "cleanup";
+    paths: string[];
+} | {
+    type: "ownershipGuard";
+} | {
+    type: "syncAllPersonal";
+    enabled: boolean;
+} | {
+    type: "grantTarget";
+    path: string;
+} | {
+    type: "grants";
+    target: GrantTarget;
+} | {
+    type: "setGrant";
+    target: GrantTarget;
+    request: SetGrantRequest;
+} | {
+    type: "removeGrant";
+    target: GrantTarget;
+    subjectType: string;
+    subjectId: RemoteId;
+} | {
+    type: "searchUsers";
+    query: string;
+} | {
+    type: "searchDepartments";
+    query: string;
+} | {
+    type: "requestAccess";
+    requestType: AccessRequestType;
+    targetId: RemoteId;
+    message: string | null;
+} | {
+    type: "saveVersion";
+    path: string;
+} | {
+    type: "localPath";
+    fileId: RemoteId;
+};
+export type DriveResponse = {
+    type: "rootOwnershipConfirmation";
+    data: {
+        generation: number;
+        localRoot: string;
+    };
+} | {
+    type: "archivePrivateSessions";
+    data: string[];
+} | {
+    type: "preferences";
+    data: Preferences;
+} | {
+    type: "configuration";
+    data: Configuration;
+} | {
+    type: "clientConfig";
+    data: ClientConfig;
+} | {
+    type: "mcpSessionConfig";
+    data: McpSessionConfig | null;
+} | {
+    type: "cloudFolders";
+    data: CloudFolder[];
+} | {
+    type: "commentContext";
+    data: CommentContext | null;
+} | {
+    type: "comments";
+    data: FileComment[];
+} | {
+    type: "comment";
+    data: FileComment;
+} | {
+    type: "collabSession";
+    data: CollabSession | null;
+} | {
+    type: "unsynced";
+    data: UnsyncedSummary;
+} | {
+    type: "job";
+    data: Job;
+} | {
+    type: "jobs";
+    data: Job[];
+} | {
+    type: "text";
+    data: string | null;
+} | {
+    type: "skillMirrors";
+    data: SkillMirror[];
+} | {
+    type: "archiveStatus";
+    data: ArchiveStatus;
+} | {
+    type: "count";
+    data: number;
+} | {
+    type: "maxAutoDownloadMb";
+    data: number;
+} | {
+    type: "snapshot";
+    data: Snapshot;
+} | {
+    type: "ssoConfig";
+    data: SsoConfig;
+} | {
+    type: "roots";
+    data: RootInfo[];
+} | {
+    type: "root";
+    data: RootInfo;
+} | {
+    type: "file";
+    data: FileStateEvent | null;
+} | {
+    type: "templates";
+    data: ProjectTemplate[];
+} | {
+    type: "departments";
+    data: Department[];
+} | {
+    type: "shared";
+    data: SharedItem[];
+} | {
+    type: "failedUploads";
+    data: FailedUpload[];
+} | {
+    type: "diskUsage";
+    data: DiskUsage;
+} | {
+    type: "cleanup";
+    data: CleanupReport;
+} | {
+    type: "ownershipGuard";
+    data: OwnershipGuard;
+} | {
+    type: "grantTarget";
+    data: GrantTarget | null;
+} | {
+    type: "grants";
+    data: GrantList;
+} | {
+    type: "grantWrite";
+    data: GrantWriteOutcome;
+} | {
+    type: "users";
+    data: UserBrief[];
+} | {
+    type: "accessRequest";
+    data: AccessRequestOutcome;
+} | {
+    type: "id";
+    data: RemoteId | null;
+} | {
+    type: "path";
+    data: string | null;
+} | {
+    type: "done";
+};
+export type EngineState = {
+    kind: "idle";
+} | {
+    kind: "scanning";
+} | {
+    kind: "syncing";
+} | {
+    kind: "paused";
+} | {
+    kind: "error";
+    message: string;
+};
+export type FailedUpload = {
+    projectId: RemoteId;
+    path: string;
+    localPath: string;
+    name: string;
+    state: FileState;
+    message: string;
+    attempts: number;
+    direction: SyncDirection;
+    firstAt: string;
+    lastAt: string;
+    nextAttemptAt: string;
+    retryable: boolean;
+};
+export type FileComment = {
+    id: RemoteId;
+    fileId: RemoteId;
+    parentId?: RemoteId | null;
+    authorId: RemoteId;
+    authorName?: string | null;
+    authorEmployeeNo?: string | null;
+    body?: string | null;
+    quote?: string | null;
+    quoteOffset?: number | null;
+    isAi?: boolean;
+    mentions?: UserBrief[] | null;
+    deleted?: boolean;
+    createdAt: string;
+    updatedAt?: string | null;
+    replies?: FileComment[];
+    suggestedReplacement?: string | null;
+    appliedAt?: string | null;
+    appliedBy?: UserBrief | null;
+    appliedVersionId?: RemoteId | null;
+};
+export type FileState = "synced" | "pending" | "uploading" | "conflict" | "cloudOnly" | "ignored" | "skippedTooLarge" | "notDownloaded" | "downloading" | "forbidden" | "readOnly" | "error" | "collab";
+export type FileStateEvent = {
+    projectId: RemoteId;
+    path: string;
+    localPath: string;
+    state: FileState;
+    size?: number;
+};
+export type Grant = {
+    subjectType: string;
+    subjectId: RemoteId;
+    subjectDisplay?: string | null;
+    level: GrantLevel;
+    actions?: string[];
+    source?: GrantSource | null;
+    sourceResourceId?: RemoteId | null;
+    sourceDisplay?: string | null;
+    inherited?: boolean;
+    editable?: boolean;
+};
+export type GrantLevel = "VIEW" | "EDIT" | "MANAGE" | "CUSTOM";
+export type GrantList = {
+    grants?: Grant[];
+    implicit?: ImplicitGrant[];
+    callerLevel?: GrantLevel | null;
+};
+export type GrantResourceKind = "FILE" | "FOLDER";
+export type GrantSource = "FILE" | "FOLDER" | "SPACE";
+export type GrantSubjectType = "USER" | "DEPT" | "ALL";
+export type GrantTarget = {
+    kind: GrantResourceKind;
+    id: RemoteId;
+};
+export type GrantWriteOutcome = {
+    kind: "applied";
+    list: GrantList;
+} | {
+    kind: "inherited";
+    inheritedFrom: InheritedFrom;
+} | {
+    kind: "custom";
+};
+export type ImplicitGrant = {
+    subjectDisplay?: string | null;
+    level: GrantLevel;
+    reason?: string | null;
+};
+export type InheritedFrom = {
+    source?: GrantSource | null;
+    resourceId?: RemoteId | null;
+    projectKey?: string | null;
+    display?: string | null;
+};
+export type Job = {
+    id: RemoteId;
+    type?: string | null;
+    status: JobStatus;
+    projectId?: RemoteId | null;
+    progress?: number | null;
+    message?: string | null;
+    error?: string | null;
+    result?: CondenseResult | null;
+};
+export type JobStatus = "PENDING" | "CLAIMED" | "RUNNING" | "SUCCEEDED" | "FAILED" | "CANCELLED" | "PROPOSED";
+export type McpHeader = {
+    name: string;
+    value: string;
+};
+export type McpSessionConfig = {
+    url: string;
+    headers: McpHeader[];
+};
+export type OwnershipGuard = {
+    unknownPersonalRoots: number;
+    threshold: number;
+    syncAllPersonal: boolean;
+    active: boolean;
+};
+export type Payload = {
+    type: "snapshot";
+    data: Snapshot;
+} | {
+    type: "status";
+    data: StatusSnapshot;
+} | {
+    type: "file";
+    data: FileStateEvent;
+} | {
+    type: "project";
+    data: ProjectProgress;
+} | {
+    type: "conflict";
+    data: ConflictRecord;
+} | {
+    type: "readOnly";
+    data: ReadOnlyChange;
+} | {
+    type: "changed";
+    data: string[];
+} | {
+    type: "reconcile";
+} | {
+    type: "comment";
+    data: CommentEvent;
+} | {
+    type: "error";
+    data: string;
+};
+export type PendingDeletes = {
+    projectId: RemoteId;
+    drivePath: string;
+    count: number;
+};
+export type Preferences = {
+    sessionArchive: boolean;
+    knowledgeInject: boolean;
+};
+export type ProjectKind = "MATERIAL" | "KNOWLEDGE" | "SKILL";
+export type ProjectPhase = "queued" | "syncing" | "done" | "failed";
+export type ProjectProgress = {
+    projectId: RemoteId;
+    phase: ProjectPhase;
+    done: number;
+    total: number;
+    failed: number;
+    message: string | null;
+    at: string;
+};
+export type ProjectScope = "PERSONAL" | "DEPT" | "TEAM" | "COMPANY";
+export type ProjectTemplate = {
+    id: RemoteId;
+    code?: string | null;
+    name: string;
+    description?: string | null;
+    kind?: string | null;
+    icon?: string | null;
+    builtin?: boolean;
+};
+export type ReadOnlyChange = {
+    projectId: RemoteId;
+    path: string;
+    localPath: string;
+    name: string;
+    fileId: RemoteId | null;
+};
+export type RemoteId = number | string;
+export type RootInfo = {
+    projectId: RemoteId;
+    projectKey: string;
+    name: string;
+    kind: ProjectKind;
+    scope: ProjectScope;
+    deptName: string | null;
+    drivePath: string;
+    node: string | null;
+    container: string | null;
+    nodePath: string | null;
+    skillsPath: string | null;
+    syncEnabled: boolean;
+    canWrite: boolean;
+    cloudOnly: boolean;
+    cursor: string | null;
+    pinned: boolean;
+    departmentId: RemoteId | null;
+    ownerId: RemoteId | null;
+    isMine: boolean | null;
+    localPath: string;
+    selected: boolean;
+};
+export type SetGrantRequest = {
+    subjectType: GrantSubjectType;
+    subjectId: RemoteId;
+    level: GrantLevel;
+};
+export type SharedItem = {
+    resourceType: GrantResourceKind;
+    resourceId: RemoteId;
+    name: string;
+    projectId?: RemoteId | null;
+    projectName?: string | null;
+    level: GrantLevel;
+    grantedByName?: string | null;
+    grantedAt?: string | null;
+    folderPath?: string | null;
+    localPath?: string | null;
+};
+export type SkillMirror = {
+    projectId: RemoteId;
+    projectKey: string;
+    name: string;
+    autoInstalled: boolean;
+    pinned: boolean;
+    deptName: string | null;
+    localPath: string;
+    skillsPath: string | null;
+    installed: boolean;
+};
+export type Snapshot = {
+    version: number;
+    generation: number;
+    sequence: number;
+    configured: boolean;
+    running: boolean;
+    baseUrl: string;
+    localRoot: string;
+    webBaseUrl: string | null;
+    status: StatusSnapshot | null;
+    roots: RootInfo[];
+    pendingDeletes: PendingDeletes[];
+    files: FileStateEvent[];
+    projects: ProjectProgress[];
+    error: string | null;
+};
+export type SsoConfig = {
+    enabled: boolean;
+    issuer?: string | null;
+    clientId?: string | null;
+    authorizationEndpoint?: string | null;
+    tokenEndpoint?: string | null;
+    redirectUris?: string[];
+    scopes?: string[];
+};
+export type StatusSnapshot = {
+    state: EngineState;
+    pending: number;
+    uploading: number;
+    downloading: number;
+    synced: number;
+    failed: number;
+    conflicts: ConflictRecord[];
+    errors: SyncError[];
+    lastSyncAt: string | null;
+    pushConnected: boolean;
+};
+export type SyncDirection = "upload" | "download";
+export type SyncError = {
+    projectId: RemoteId | null;
+    path: string | null;
+    message: string;
+    at: string;
+};
+export type UnsyncedSummary = {
+    pending: number;
+    failed: number;
+    paths: string[];
+};
+export type UserBrief = {
+    id: RemoteId;
+    employeeNo?: string | null;
+    name?: string | null;
+};