@claudian-collab/protocol 3.2.0 → 3.3.0

package/dist/CollabProjectMembership.d.ts

@@ -0,0 +1,318 @@
+import type { CollabDecodeResult } from './CollabProtocol';
+import type { CollabGitOid, CollabIdempotencyKey, CollabIsoTimestamp, CollabMemberId, CollabProjectId, CollabRequestId, CollabRole } from './types';
+export declare const COLLAB_PROJECT_MEMBERSHIP_LIMITS: Readonly<{
+    readonly invitationSecretLength: 43;
+    readonly invitationTtlMs: 86400000;
+    readonly managerResponsibilityOfferRetentionMs: 2592000000;
+    readonly managerResponsibilityOfferTtlMs: 86400000;
+    readonly maxCurrentManagerOffers: 100;
+    readonly maxDisplayNameUtf8Bytes: 128;
+    readonly maxProjectInvitations: 100;
+    readonly maxProjectMembers: 100;
+    readonly maxProjectNameUtf8Bytes: 256;
+    readonly secretReplayTtlMs: 2592000000;
+    readonly transferredClaimLength: 43;
+    readonly transferredClaimTtlMs: 2592000000;
+}>;
+export type CollabProjectInvitationState = 'active' | 'redeeming' | 'redeemed' | 'revoked' | 'expired';
+export type CollabProjectMemberBindingState = 'bound' | 'unbound' | 'hidden';
+export type CollabImportedClaimState = 'not-applicable' | 'original-active' | 'override-active' | 'revoked' | 'expired' | 'redeemed' | 'hidden';
+export type CollabManagerResponsibilityPurpose = 'manager-promotion' | 'manager-leave';
+export type CollabManagerResponsibilityOfferState = 'offered' | 'acknowledged' | 'declined' | 'cancelled' | 'consumed' | 'expired';
+export interface CollabProjectRequest {
+    readonly projectId: CollabProjectId;
+}
+export interface CollabProjectMutationRequest extends CollabProjectRequest {
+    readonly idempotencyKey: CollabIdempotencyKey;
+}
+export interface CreateCloudProjectRequest extends CollabProjectMutationRequest {
+    readonly managerDisplayName: string;
+    readonly projectName: string;
+}
+export interface CreateCloudProjectResponse {
+    readonly createdAt: CollabIsoTimestamp;
+    readonly mainOid: CollabGitOid;
+    readonly managerSetGeneration: 1;
+    readonly memberId: CollabMemberId;
+    readonly membershipRevision: 2;
+    readonly personalRef: string;
+    readonly projectId: CollabProjectId;
+    readonly role: 'manager';
+}
+export interface CreateProjectInvitationRequest extends CollabProjectMutationRequest {
+    readonly expectedManagerSetGeneration: number;
+}
+export interface CreateProjectInvitationResponse {
+    readonly createdAt: CollabIsoTimestamp;
+    readonly expiresAt: CollabIsoTimestamp;
+    readonly invitationId: string;
+    readonly issuedState: 'active';
+    readonly projectId: CollabProjectId;
+    readonly secret: string;
+    readonly secretReplayExpiresAt: CollabIsoTimestamp;
+}
+export interface CollabProjectInvitationSummary {
+    readonly createdAt: CollabIsoTimestamp;
+    readonly expiresAt: CollabIsoTimestamp;
+    readonly invitationId: string;
+    readonly revision: number;
+    readonly state: CollabProjectInvitationState;
+    readonly terminalAt: CollabIsoTimestamp | null;
+}
+export type ListProjectInvitationsRequest = CollabProjectRequest;
+export interface ListProjectInvitationsResponse {
+    readonly invitations: readonly CollabProjectInvitationSummary[];
+    readonly managerSetGeneration: number;
+    readonly projectId: CollabProjectId;
+}
+export interface RevokeProjectInvitationRequest extends CollabProjectMutationRequest {
+    readonly expectedInvitationRevision: number;
+    readonly expectedManagerSetGeneration: number;
+    readonly invitationId: string;
+}
+export interface RevokeProjectInvitationResponse {
+    readonly invitationId: string;
+    readonly projectId: CollabProjectId;
+    readonly revision: number;
+    readonly revokedAt: CollabIsoTimestamp;
+    readonly state: 'revoked';
+}
+export interface JoinCloudProjectRequest extends CollabProjectMutationRequest {
+    readonly displayName: string;
+    readonly invitationId: string;
+    readonly secret: string;
+}
+export interface JoinCloudProjectResponse {
+    readonly joinedAt: CollabIsoTimestamp;
+    readonly mainOid: CollabGitOid;
+    readonly managerSetGeneration: number;
+    readonly memberId: CollabMemberId;
+    readonly membershipRevision: 2;
+    readonly personalRef: string;
+    readonly projectId: CollabProjectId;
+    readonly role: 'member';
+}
+export interface CollabProjectMemberSummary {
+    readonly bindingState: CollabProjectMemberBindingState;
+    readonly displayName: string;
+    readonly importedClaimState: CollabImportedClaimState;
+    readonly memberId: CollabMemberId;
+    readonly membershipRevision: number;
+    readonly role: CollabRole;
+}
+export type ListProjectMembersRequest = CollabProjectRequest;
+export interface ListProjectMembersResponse {
+    readonly managerSetGeneration: number;
+    readonly members: readonly CollabProjectMemberSummary[];
+    readonly projectId: CollabProjectId;
+}
+export interface ReissueTransferredMembershipClaimRequest extends CollabProjectMutationRequest {
+    readonly expectedClaimGeneration: number;
+    readonly expectedManagerSetGeneration: number;
+    readonly expectedMembershipRevision: number;
+    readonly memberId: CollabMemberId;
+}
+export interface ReissueTransferredMembershipClaimResponse {
+    readonly claim: string;
+    readonly claimGeneration: number;
+    readonly createdAt: CollabIsoTimestamp;
+    readonly expiresAt: CollabIsoTimestamp;
+    readonly memberId: CollabMemberId;
+    readonly projectId: CollabProjectId;
+    readonly secretReplayExpiresAt: CollabIsoTimestamp;
+}
+export type RevokeTransferredMembershipClaimRequest = ReissueTransferredMembershipClaimRequest;
+export interface RevokeTransferredMembershipClaimResponse {
+    readonly claimGeneration: number;
+    readonly memberId: CollabMemberId;
+    readonly projectId: CollabProjectId;
+    readonly revokedAt: CollabIsoTimestamp;
+    readonly state: 'revoked';
+}
+export interface CollabManagerResponsibilityOffer {
+    readonly acknowledgedAt: CollabIsoTimestamp | null;
+    readonly expiresAt: CollabIsoTimestamp;
+    readonly managerSetGenerationAtOffer: number;
+    readonly offeredAt: CollabIsoTimestamp;
+    readonly offerId: string;
+    readonly purpose: CollabManagerResponsibilityPurpose;
+    readonly revision: number;
+    readonly sourceManagerMemberId: CollabMemberId;
+    readonly state: CollabManagerResponsibilityOfferState;
+    readonly targetMemberId: CollabMemberId;
+    readonly targetMembershipRevisionAtOffer: number;
+    readonly terminalAt: CollabIsoTimestamp | null;
+}
+export interface CreateManagerResponsibilityOfferRequest extends CollabProjectMutationRequest {
+    readonly expectedManagerSetGeneration: number;
+    readonly expectedTargetMembershipRevision: number;
+    readonly purpose: CollabManagerResponsibilityPurpose;
+    readonly targetMemberId: CollabMemberId;
+}
+export interface CollabManagerResponsibilityOfferResponse {
+    readonly offer: CollabManagerResponsibilityOffer;
+}
+export type ListCurrentManagerResponsibilityOffersRequest = CollabProjectRequest;
+export interface ListCurrentManagerResponsibilityOffersResponse {
+    readonly offers: readonly CollabManagerResponsibilityOffer[];
+    readonly projectId: CollabProjectId;
+}
+export interface GetManagerResponsibilityOfferRequest extends CollabProjectRequest {
+    readonly offerId: string;
+}
+export interface TransitionManagerResponsibilityOfferRequest extends CollabProjectMutationRequest {
+    readonly expectedOfferRevision: number;
+    readonly offerId: string;
+}
+export interface PromoteManagerRequest extends CollabProjectMutationRequest {
+    readonly expectedManagerSetGeneration: number;
+    readonly expectedOfferRevision: number;
+    readonly expectedTargetMembershipRevision: number;
+    readonly managerResponsibilityOfferId: string;
+    readonly targetMemberId: CollabMemberId;
+}
+export interface PromoteManagerResponse {
+    readonly managerSetGeneration: number;
+    readonly membershipRevision: number;
+    readonly offerRevision: number;
+    readonly projectId: CollabProjectId;
+    readonly promotedMemberId: CollabMemberId;
+}
+export interface DemoteManagerRequest extends CollabProjectMutationRequest {
+    readonly expectedManagerSetGeneration: number;
+    readonly expectedTargetMembershipRevision: number;
+    readonly targetMemberId: CollabMemberId;
+}
+export interface DemoteManagerResponse {
+    readonly demotedMemberId: CollabMemberId;
+    readonly managerSetGeneration: number;
+    readonly membershipRevision: number;
+    readonly projectId: CollabProjectId;
+}
+export type RemoveMemberRequest = DemoteManagerRequest;
+export interface RemoveMemberResponse {
+    readonly discardedRequestId: CollabRequestId | null;
+    readonly managerSetGeneration: number;
+    readonly memberId: CollabMemberId;
+    readonly projectId: CollabProjectId;
+    readonly removedAt: CollabIsoTimestamp;
+    readonly status: 'revoked';
+}
+export interface LeaveProjectRequest extends CollabProjectMutationRequest {
+    readonly expectedManagerSetGeneration: number;
+    readonly expectedMembershipRevision: number;
+    readonly expectedOfferRevision: number | null;
+    readonly expectedPersonalRefOid: CollabGitOid;
+    readonly managerResponsibilityOfferId: string | null;
+}
+export interface LeaveProjectResponse {
+    readonly discardedRequestId: CollabRequestId | null;
+    readonly leftAt: CollabIsoTimestamp;
+    readonly managerSetGeneration: number;
+    readonly memberId: CollabMemberId;
+    readonly projectId: CollabProjectId;
+    readonly promotedSuccessorMemberId: CollabMemberId | null;
+    readonly status: 'left';
+}
+export declare const COLLAB_PROJECT_MEMBERSHIP_OPERATIONS: readonly ["createCloudProject", "createProjectInvitation", "listProjectInvitations", "revokeProjectInvitation", "joinCloudProject", "listProjectMembers", "reissueTransferredMembershipClaim", "revokeTransferredMembershipClaim", "createManagerResponsibilityOffer", "listCurrentManagerResponsibilityOffers", "getManagerResponsibilityOffer", "acknowledgeManagerResponsibility", "declineManagerResponsibility", "cancelManagerResponsibilityOffer", "promoteManager", "demoteManager", "removeMember", "leaveProject"];
+export type CollabProjectMembershipOperation = typeof COLLAB_PROJECT_MEMBERSHIP_OPERATIONS[number];
+export interface CollabProjectMembershipOperationMap {
+    readonly createCloudProject: {
+        readonly request: CreateCloudProjectRequest;
+        readonly response: CreateCloudProjectResponse;
+    };
+    readonly createProjectInvitation: {
+        readonly request: CreateProjectInvitationRequest;
+        readonly response: CreateProjectInvitationResponse;
+    };
+    readonly listProjectInvitations: {
+        readonly request: ListProjectInvitationsRequest;
+        readonly response: ListProjectInvitationsResponse;
+    };
+    readonly revokeProjectInvitation: {
+        readonly request: RevokeProjectInvitationRequest;
+        readonly response: RevokeProjectInvitationResponse;
+    };
+    readonly joinCloudProject: {
+        readonly request: JoinCloudProjectRequest;
+        readonly response: JoinCloudProjectResponse;
+    };
+    readonly listProjectMembers: {
+        readonly request: ListProjectMembersRequest;
+        readonly response: ListProjectMembersResponse;
+    };
+    readonly reissueTransferredMembershipClaim: {
+        readonly request: ReissueTransferredMembershipClaimRequest;
+        readonly response: ReissueTransferredMembershipClaimResponse;
+    };
+    readonly revokeTransferredMembershipClaim: {
+        readonly request: RevokeTransferredMembershipClaimRequest;
+        readonly response: RevokeTransferredMembershipClaimResponse;
+    };
+    readonly createManagerResponsibilityOffer: {
+        readonly request: CreateManagerResponsibilityOfferRequest;
+        readonly response: CollabManagerResponsibilityOfferResponse;
+    };
+    readonly listCurrentManagerResponsibilityOffers: {
+        readonly request: ListCurrentManagerResponsibilityOffersRequest;
+        readonly response: ListCurrentManagerResponsibilityOffersResponse;
+    };
+    readonly getManagerResponsibilityOffer: {
+        readonly request: GetManagerResponsibilityOfferRequest;
+        readonly response: CollabManagerResponsibilityOfferResponse;
+    };
+    readonly acknowledgeManagerResponsibility: {
+        readonly request: TransitionManagerResponsibilityOfferRequest;
+        readonly response: CollabManagerResponsibilityOfferResponse;
+    };
+    readonly declineManagerResponsibility: {
+        readonly request: TransitionManagerResponsibilityOfferRequest;
+        readonly response: CollabManagerResponsibilityOfferResponse;
+    };
+    readonly cancelManagerResponsibilityOffer: {
+        readonly request: TransitionManagerResponsibilityOfferRequest;
+        readonly response: CollabManagerResponsibilityOfferResponse;
+    };
+    readonly promoteManager: {
+        readonly request: PromoteManagerRequest;
+        readonly response: PromoteManagerResponse;
+    };
+    readonly demoteManager: {
+        readonly request: DemoteManagerRequest;
+        readonly response: DemoteManagerResponse;
+    };
+    readonly removeMember: {
+        readonly request: RemoveMemberRequest;
+        readonly response: RemoveMemberResponse;
+    };
+    readonly leaveProject: {
+        readonly request: LeaveProjectRequest;
+        readonly response: LeaveProjectResponse;
+    };
+}
+export interface CollabProjectMembershipOperationCodec<Request, Response> {
+    readonly decodeRequest: (input: unknown) => CollabDecodeResult<Request>;
+    readonly decodeResponse: (input: unknown) => Response;
+}
+export declare const COLLAB_PROJECT_MEMBERSHIP_OPERATION_CODECS: Readonly<{
+    readonly createCloudProject: CollabProjectMembershipOperationCodec<CreateCloudProjectRequest, CreateCloudProjectResponse>;
+    readonly createProjectInvitation: CollabProjectMembershipOperationCodec<CreateProjectInvitationRequest, CreateProjectInvitationResponse>;
+    readonly listProjectInvitations: CollabProjectMembershipOperationCodec<CollabProjectRequest, ListProjectInvitationsResponse>;
+    readonly revokeProjectInvitation: CollabProjectMembershipOperationCodec<RevokeProjectInvitationRequest, RevokeProjectInvitationResponse>;
+    readonly joinCloudProject: CollabProjectMembershipOperationCodec<JoinCloudProjectRequest, JoinCloudProjectResponse>;
+    readonly listProjectMembers: CollabProjectMembershipOperationCodec<CollabProjectRequest, ListProjectMembersResponse>;
+    readonly reissueTransferredMembershipClaim: CollabProjectMembershipOperationCodec<ReissueTransferredMembershipClaimRequest, ReissueTransferredMembershipClaimResponse>;
+    readonly revokeTransferredMembershipClaim: CollabProjectMembershipOperationCodec<ReissueTransferredMembershipClaimRequest, RevokeTransferredMembershipClaimResponse>;
+    readonly createManagerResponsibilityOffer: CollabProjectMembershipOperationCodec<CreateManagerResponsibilityOfferRequest, CollabManagerResponsibilityOfferResponse>;
+    readonly listCurrentManagerResponsibilityOffers: CollabProjectMembershipOperationCodec<CollabProjectRequest, ListCurrentManagerResponsibilityOffersResponse>;
+    readonly getManagerResponsibilityOffer: CollabProjectMembershipOperationCodec<GetManagerResponsibilityOfferRequest, CollabManagerResponsibilityOfferResponse>;
+    readonly acknowledgeManagerResponsibility: CollabProjectMembershipOperationCodec<TransitionManagerResponsibilityOfferRequest, CollabManagerResponsibilityOfferResponse>;
+    readonly declineManagerResponsibility: CollabProjectMembershipOperationCodec<TransitionManagerResponsibilityOfferRequest, CollabManagerResponsibilityOfferResponse>;
+    readonly cancelManagerResponsibilityOffer: CollabProjectMembershipOperationCodec<TransitionManagerResponsibilityOfferRequest, CollabManagerResponsibilityOfferResponse>;
+    readonly promoteManager: CollabProjectMembershipOperationCodec<PromoteManagerRequest, PromoteManagerResponse>;
+    readonly demoteManager: CollabProjectMembershipOperationCodec<DemoteManagerRequest, DemoteManagerResponse>;
+    readonly removeMember: CollabProjectMembershipOperationCodec<DemoteManagerRequest, RemoveMemberResponse>;
+    readonly leaveProject: CollabProjectMembershipOperationCodec<LeaveProjectRequest, LeaveProjectResponse>;
+}>;
+export declare function decodeCollabProjectMembershipOperationRequest<Operation extends CollabProjectMembershipOperation>(operation: Operation, value: unknown): CollabDecodeResult<CollabProjectMembershipOperationMap[Operation]['request']>;
+export declare function decodeCollabProjectMembershipOperationResponse<Operation extends CollabProjectMembershipOperation>(operation: Operation, value: unknown): CollabProjectMembershipOperationMap[Operation]['response'];