@claudian-collab/protocol 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,138 @@
+export type CollabProjectId = string;
+export type CollabMemberId = string;
+export type CollabRequestId = string;
+export type CollabCommentId = string;
+export type CollabTicketId = string;
+export type CollabTicketCommentId = string;
+export type CollabTicketRelationId = string;
+export type CollabOperationId = string;
+export type CollabIdempotencyKey = string;
+export type CollabGitOid = string;
+export type CollabIsoTimestamp = string;
+export type CollabRelativePath = string;
+export type CollabRole = 'manager' | 'member';
+export type CollabMemberStatus = 'pending' | 'active' | 'revoked' | 'left';
+export type CollabRequestStatus = 'open' | 'merged' | 'discarded';
+export type CollabTicketStatus = 'open' | 'closed';
+export type CollabTicketCommitRelationKind = 'references' | 'resolves';
+export declare function collabMemberRef(memberId: CollabMemberId): string;
+export interface CollabMember {
+    id: CollabMemberId;
+    displayName: string;
+    personalRef: string;
+    role: CollabRole;
+    status: CollabMemberStatus;
+    createdAt: CollabIsoTimestamp;
+    activatedAt?: CollabIsoTimestamp;
+    revokedAt?: CollabIsoTimestamp;
+}
+export interface CollabTicketSummary {
+    id: CollabTicketId;
+    number: number;
+    title: string;
+    status: CollabTicketStatus;
+    authorMemberId: CollabMemberId;
+    revision: number;
+    acceptedRelationCount: number;
+    commentCount: number;
+    createdAt: CollabIsoTimestamp;
+    updatedAt: CollabIsoTimestamp;
+    closedAt?: CollabIsoTimestamp;
+    closedByMemberId?: CollabMemberId;
+}
+export interface CollabTicketComment {
+    id: CollabTicketCommentId;
+    ticketId: CollabTicketId;
+    authorMemberId: CollabMemberId;
+    body: string;
+    createdAt: CollabIsoTimestamp;
+}
+export interface CollabTicketAcceptedRelation {
+    id: CollabTicketRelationId;
+    requestId: CollabRequestId;
+    kind: CollabTicketCommitRelationKind;
+    commitOid: CollabGitOid;
+    acceptedMergeOid: CollabGitOid;
+    acceptedAt: CollabIsoTimestamp;
+}
+export interface CollabTicketDetail {
+    ticket: CollabTicketSummary;
+    body: string;
+    comments: CollabTicketCommentPage;
+    acceptedRelations: CollabTicketAcceptedRelationPage;
+}
+export interface CollabTicketCommentPage {
+    comments: readonly CollabTicketComment[];
+    nextCursor?: string;
+}
+export interface CollabTicketAcceptedRelationPage {
+    acceptedRelations: readonly CollabTicketAcceptedRelation[];
+    nextCursor?: string;
+}
+export interface CollabTicketPage {
+    tickets: readonly CollabTicketSummary[];
+    nextCursor?: string;
+}
+export interface CollabRequestTicketRelation {
+    id: CollabTicketRelationId;
+    ticketId: CollabTicketId;
+    ticketNumber: number;
+    ticketTitle: string;
+    ticketRevision: number;
+    commitOid: CollabGitOid;
+    kind: CollabTicketCommitRelationKind;
+    state: 'pending' | 'accepted';
+}
+export interface CollabParsedTicketReference {
+    ticketNumber: number;
+    kind: CollabTicketCommitRelationKind;
+}
+export interface CollabChangeRequest {
+    id: CollabRequestId;
+    memberId: CollabMemberId;
+    status: CollabRequestStatus;
+    firstBaseOid: CollabGitOid;
+    latestHeadOid: CollabGitOid;
+    mergedOid?: CollabGitOid;
+    description: string;
+    revision: number;
+    ticketRelations: readonly CollabRequestTicketRelation[];
+    commentCount: number;
+    createdAt: CollabIsoTimestamp;
+    updatedAt: CollabIsoTimestamp;
+}
+export interface CollabComment {
+    id: CollabCommentId;
+    requestId: CollabRequestId;
+    authorMemberId: CollabMemberId;
+    body: string;
+    createdAt: CollabIsoTimestamp;
+}
+export interface CollabCommentPage {
+    comments: readonly CollabComment[];
+    nextCursor?: string;
+}
+export type CollabFileChangeKind = 'added' | 'modified' | 'deleted' | 'renamed' | 'copied' | 'type-changed';
+export interface CollabChangedFile {
+    path: CollabRelativePath;
+    previousPath?: CollabRelativePath;
+    kind: CollabFileChangeKind;
+    binary: boolean;
+    oldBytes?: number;
+    newBytes?: number;
+    additions?: number;
+    deletions?: number;
+    largeForReview: boolean;
+}
+export type CollabReviewCondition = 'clean' | 'conflicting' | 'stale';
+export interface CollabRequestDetail {
+    request: CollabChangeRequest;
+    currentMainOid: CollabGitOid;
+    reviewedHeadOid: CollabGitOid;
+    reviewCondition: CollabReviewCondition;
+    comments: CollabCommentPage;
+}
+export interface CollabResolvingTicketExpectation {
+    ticketId: CollabTicketId;
+    revision: number;
+}

package/dist/types.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.collabMemberRef = collabMemberRef;
+const CollabConstants_1 = require("./CollabConstants");
+const CollabValidation_1 = require("./CollabValidation");
+function collabMemberRef(memberId) {
+    if (!(0, CollabValidation_1.isCollabMemberId)(memberId)) {
+        throw new RangeError('Invalid Collab member ID');
+    }
+    return `${CollabConstants_1.COLLAB_MEMBER_REF_PREFIX}${memberId}`;
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@claudian-collab/protocol",
+  "version": "1.0.0",
+  "description": "Canonical Collab wire and Cloud binding contract for Claudian clients and servers.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/YishenTu/claudian-collab-protocol.git"
+  },
+  "homepage": "https://github.com/YishenTu/claudian-collab-protocol#readme",
+  "bugs": {
+    "url": "https://github.com/YishenTu/claudian-collab-protocol/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "engines": {
+    "node": ">=24 <25"
+  },
+  "packageManager": "npm@11.13.0",
+  "type": "commonjs",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "npm run clean && tsc -p tsconfig.json",
+    "check:compatibility": "node scripts/check-compatibility.mjs",
+    "check:migration-provenance": "node scripts/check-migration-provenance.mjs --verify-standalone",
+    "clean": "node scripts/clean.mjs",
+    "lint": "eslint src tests scripts",
+    "prepack": "npm run build",
+    "release:candidate": "node scripts/release-candidate.mjs --output .context/release",
+    "test": "jest && node --test tests/*.test.mjs",
+    "typecheck": "tsc --noEmit -p tsconfig.jest.json",
+    "verify": "npm run lint && npm run typecheck && npm run build && npm run test && npm run check:compatibility && npm run check:migration-provenance && npm run verify:pack && npm run release:candidate",
+    "verify:pack": "node scripts/verify-pack.mjs"
+  },
+  "dependencies": {
+    "@lezer/markdown": "1.7.2"
+  },
+  "devDependencies": {
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.7.2",
+    "@eslint/js": "^10.0.1",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^25.5.2",
+    "@typescript-eslint/eslint-plugin": "^8.58.0",
+    "@typescript-eslint/parser": "^8.58.0",
+    "eslint": "^10.2.0",
+    "eslint-plugin-jest": "^29.15.1",
+    "eslint-plugin-simple-import-sort": "^12.1.1",
+    "jest": "^30.3.0",
+    "ts-jest": "^29.4.9",
+    "typescript": "^6.0.2"
+  }
+}