@tearleads/client-sdk 0.1.14 → 0.1.16

package/internal/api-client/principalPolicyRequests.d.ts

@@ -0,0 +1,799 @@
+import type { CommitOrganizationGroupPolicyRequest, OrganizationPrincipalPolicyRequest } from "../validators/request/index.js";
+import type { PrincipalPolicyBundleResponse } from "../validators/response/index.js";
+import type { BoundedCache } from "./ApiCache.js";
+import type { ApiRequestRuntime } from "./apiRequestRuntime.js";
+import { type PrincipalPolicyPageReadOptions } from "./principalPolicyPages.js";
+import { readProjectionPolicyHistoryPages } from "./projectionPolicyHistoryPages.js";
+import type { RequestResultOptions } from "./types.js";
+export declare class PrincipalPolicyRequests {
+    private readonly runtime;
+    private readonly cache;
+    private readonly clearWriterProjectionCaches;
+    constructor(runtime: ApiRequestRuntime, cache: BoundedCache<Promise<PrincipalPolicyBundleResponse | null>>, clearWriterProjectionCaches: () => void);
+    publicPages(source: Parameters<typeof readProjectionPolicyHistoryPages>[1], options?: Parameters<typeof readProjectionPolicyHistoryPages>[2]): AsyncGenerator<import("./types.js").RequestResult<{
+        currentGrants: {
+            accessLevel: "admin" | "read" | "write";
+            containerId: string;
+        }[];
+        currentProjection: {
+            role: "member" | "admin";
+            userId: string;
+        }[];
+        currentState: {
+            createdAt: string;
+            encapsulationPublicKey: string;
+            externalAuthority: {
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                principalType: "group";
+                stateHash: string;
+                version: number;
+            } | null;
+            grantCount: number;
+            grantRoot: string;
+            keyEpoch: number;
+            keyFingerprint: string;
+            memberCount: number;
+            memberEnvelopesRoot: string;
+            membershipMode: "projection";
+            membershipRoot: string;
+            payloadCiphertextHash: string;
+            prevStateHash: string | null;
+            principalId: string;
+            principalType: "group" | "organization";
+            projectionRoot: string;
+            signature: string;
+            signedAt: string;
+            signerUserId: string;
+            signerUserKeyFingerprint: string;
+            stateHash: string;
+            version: number;
+        };
+        previousStates: {
+            grants: {
+                accessLevel: "admin" | "read" | "write";
+                containerId: string;
+            }[];
+            projection: {
+                role: "member" | "admin";
+                userId: string;
+            }[];
+            state: {
+                createdAt: string;
+                encapsulationPublicKey: string;
+                externalAuthority: {
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    principalType: "group";
+                    stateHash: string;
+                    version: number;
+                } | null;
+                grantCount: number;
+                grantRoot: string;
+                keyEpoch: number;
+                keyFingerprint: string;
+                memberCount: number;
+                memberEnvelopesRoot: string;
+                membershipMode: "projection";
+                membershipRoot: string;
+                payloadCiphertextHash: string;
+                prevStateHash: string | null;
+                principalId: string;
+                principalType: "group" | "organization";
+                projectionRoot: string;
+                signature: string;
+                signedAt: string;
+                signerUserId: string;
+                signerUserKeyFingerprint: string;
+                stateHash: string;
+                version: number;
+            };
+        }[];
+        historyPage: {
+            afterVersion: number;
+            nextAfterVersion: number | null;
+        };
+    }>, void, any>;
+    pages(principalType: "group" | "organization", principalId: string, options?: PrincipalPolicyPageReadOptions): AsyncGenerator<import("./types.js").RequestResult<{
+        previousStates: {
+            grants: {
+                accessLevel: "admin" | "read" | "write";
+                containerId: string;
+            }[];
+            projection: {
+                role: "member" | "admin";
+                userId: string;
+            }[];
+            state: {
+                createdAt: string;
+                encapsulationPublicKey: string;
+                externalAuthority: {
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    principalType: "group";
+                    stateHash: string;
+                    version: number;
+                } | null;
+                grantCount: number;
+                grantRoot: string;
+                keyEpoch: number;
+                keyFingerprint: string;
+                memberCount: number;
+                memberEnvelopesRoot: string;
+                membershipMode: "projection";
+                membershipRoot: string;
+                payloadCiphertextHash: string;
+                prevStateHash: string | null;
+                principalId: string;
+                principalType: "group" | "organization";
+                projectionRoot: string;
+                signature: string;
+                signedAt: string;
+                signerUserId: string;
+                signerUserKeyFingerprint: string;
+                stateHash: string;
+                version: number;
+            };
+        }[];
+        historyPage: {
+            afterVersion: number;
+            nextAfterVersion: number | null;
+        };
+        currentGrants: {
+            accessLevel: "admin" | "read" | "write";
+            containerId: string;
+        }[];
+        currentMemberEnvelopes: {
+            envelopes: {
+                kemCipherText: string;
+                memberKeyFingerprint: string;
+                userId: string;
+                wrappedKey: string;
+            }[];
+            epoch: number;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentPayload: {
+            cipherSuite: "aes-256-gcm";
+            ciphertext: string;
+            ciphertextHash: string;
+            createdAt: string;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentProjection: {
+            role: "member" | "admin";
+            userId: string;
+        }[];
+        currentState: {
+            createdAt: string;
+            encapsulationPublicKey: string;
+            externalAuthority: {
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                principalType: "group";
+                stateHash: string;
+                version: number;
+            } | null;
+            grantCount: number;
+            grantRoot: string;
+            keyEpoch: number;
+            keyFingerprint: string;
+            memberCount: number;
+            memberEnvelopesRoot: string;
+            membershipMode: "projection";
+            membershipRoot: string;
+            payloadCiphertextHash: string;
+            prevStateHash: string | null;
+            principalId: string;
+            principalType: "group" | "organization";
+            projectionRoot: string;
+            signature: string;
+            signedAt: string;
+            signerUserId: string;
+            signerUserKeyFingerprint: string;
+            stateHash: string;
+            version: number;
+        };
+    }>, void, any>;
+    get(principalType: "group" | "organization", principalId: string, options?: RequestResultOptions): Promise<{
+        previousStates: {
+            grants: {
+                accessLevel: "admin" | "read" | "write";
+                containerId: string;
+            }[];
+            projection: {
+                role: "member" | "admin";
+                userId: string;
+            }[];
+            state: {
+                createdAt: string;
+                encapsulationPublicKey: string;
+                externalAuthority: {
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    principalType: "group";
+                    stateHash: string;
+                    version: number;
+                } | null;
+                grantCount: number;
+                grantRoot: string;
+                keyEpoch: number;
+                keyFingerprint: string;
+                memberCount: number;
+                memberEnvelopesRoot: string;
+                membershipMode: "projection";
+                membershipRoot: string;
+                payloadCiphertextHash: string;
+                prevStateHash: string | null;
+                principalId: string;
+                principalType: "group" | "organization";
+                projectionRoot: string;
+                signature: string;
+                signedAt: string;
+                signerUserId: string;
+                signerUserKeyFingerprint: string;
+                stateHash: string;
+                version: number;
+            };
+        }[];
+        currentGrants: {
+            accessLevel: "admin" | "read" | "write";
+            containerId: string;
+        }[];
+        currentMemberEnvelopes: {
+            envelopes: {
+                kemCipherText: string;
+                memberKeyFingerprint: string;
+                userId: string;
+                wrappedKey: string;
+            }[];
+            epoch: number;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentPayload: {
+            cipherSuite: "aes-256-gcm";
+            ciphertext: string;
+            ciphertextHash: string;
+            createdAt: string;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentProjection: {
+            role: "member" | "admin";
+            userId: string;
+        }[];
+        currentState: {
+            createdAt: string;
+            encapsulationPublicKey: string;
+            externalAuthority: {
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                principalType: "group";
+                stateHash: string;
+                version: number;
+            } | null;
+            grantCount: number;
+            grantRoot: string;
+            keyEpoch: number;
+            keyFingerprint: string;
+            memberCount: number;
+            memberEnvelopesRoot: string;
+            membershipMode: "projection";
+            membershipRoot: string;
+            payloadCiphertextHash: string;
+            prevStateHash: string | null;
+            principalId: string;
+            principalType: "group" | "organization";
+            projectionRoot: string;
+            signature: string;
+            signedAt: string;
+            signerUserId: string;
+            signerUserKeyFingerprint: string;
+            stateHash: string;
+            version: number;
+        };
+    } | null>;
+    put(...args: Parameters<PrincipalPolicyRequests["putResult"]>): Promise<{
+        containerMutations: {
+            createdAt: string;
+            manifestHead: {
+                epoch: number;
+                manifestHash: string;
+            };
+            organizationId: string;
+            parentId: string | null;
+            referencedPrincipalHeads: {
+                principalType: "group";
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                stateHash: string;
+                version: number;
+            }[];
+            updatedAt: string;
+            accessManifest: {
+                event: {
+                    body: unknown;
+                    event: Record<string, unknown>;
+                    eventHash: string;
+                };
+                manifest: Record<string, unknown>;
+                manifestHash: string;
+                state: Record<string, unknown>;
+            };
+            containerId: string;
+            containerKek: {
+                accessManifestHash: string;
+                containerId: string;
+                containerKeyEpoch: number;
+                containerKeyEpochId: string;
+                containerManifestHistory: {
+                    event: {
+                        body: unknown;
+                        event: Record<string, unknown>;
+                        eventHash: string;
+                    };
+                    manifest: Record<string, unknown>;
+                    manifestHash: string;
+                    state: Record<string, unknown>;
+                }[];
+                keyEpoch: Record<string, unknown>;
+                keyEpochHash: string;
+                keyring: {
+                    containerId: string;
+                    containerKeyEpochId: string;
+                    iv: string;
+                    sealed: string;
+                    sealingSuite: string;
+                    version: number;
+                } | null;
+                keyTargetHash: string;
+                parentContainerKeyEpochId: string | null;
+                recipientTargets: Record<string, unknown>[];
+                wraps: Record<string, unknown>[];
+            };
+            systemSlot?: string | null | undefined;
+        }[];
+        currentGrants: {
+            accessLevel: "admin" | "read" | "write";
+            containerId: string;
+        }[];
+        currentMemberEnvelopes: {
+            envelopes: {
+                kemCipherText: string;
+                memberKeyFingerprint: string;
+                userId: string;
+                wrappedKey: string;
+            }[];
+            epoch: number;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentPayload: {
+            cipherSuite: "aes-256-gcm";
+            ciphertext: string;
+            ciphertextHash: string;
+            createdAt: string;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentProjection: {
+            role: "member" | "admin";
+            userId: string;
+        }[];
+        currentState: {
+            createdAt: string;
+            encapsulationPublicKey: string;
+            externalAuthority: {
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                principalType: "group";
+                stateHash: string;
+                version: number;
+            } | null;
+            grantCount: number;
+            grantRoot: string;
+            keyEpoch: number;
+            keyFingerprint: string;
+            memberCount: number;
+            memberEnvelopesRoot: string;
+            membershipMode: "projection";
+            membershipRoot: string;
+            payloadCiphertextHash: string;
+            prevStateHash: string | null;
+            principalId: string;
+            principalType: "group" | "organization";
+            projectionRoot: string;
+            signature: string;
+            signedAt: string;
+            signerUserId: string;
+            signerUserKeyFingerprint: string;
+            stateHash: string;
+            version: number;
+        };
+    } | null>;
+    putResult(principalType: "organization", principalId: string, input: OrganizationPrincipalPolicyRequest, options?: RequestResultOptions): Promise<import("./types.js").RequestResult<{
+        containerMutations: {
+            createdAt: string;
+            manifestHead: {
+                epoch: number;
+                manifestHash: string;
+            };
+            organizationId: string;
+            parentId: string | null;
+            referencedPrincipalHeads: {
+                principalType: "group";
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                stateHash: string;
+                version: number;
+            }[];
+            updatedAt: string;
+            accessManifest: {
+                event: {
+                    body: unknown;
+                    event: Record<string, unknown>;
+                    eventHash: string;
+                };
+                manifest: Record<string, unknown>;
+                manifestHash: string;
+                state: Record<string, unknown>;
+            };
+            containerId: string;
+            containerKek: {
+                accessManifestHash: string;
+                containerId: string;
+                containerKeyEpoch: number;
+                containerKeyEpochId: string;
+                containerManifestHistory: {
+                    event: {
+                        body: unknown;
+                        event: Record<string, unknown>;
+                        eventHash: string;
+                    };
+                    manifest: Record<string, unknown>;
+                    manifestHash: string;
+                    state: Record<string, unknown>;
+                }[];
+                keyEpoch: Record<string, unknown>;
+                keyEpochHash: string;
+                keyring: {
+                    containerId: string;
+                    containerKeyEpochId: string;
+                    iv: string;
+                    sealed: string;
+                    sealingSuite: string;
+                    version: number;
+                } | null;
+                keyTargetHash: string;
+                parentContainerKeyEpochId: string | null;
+                recipientTargets: Record<string, unknown>[];
+                wraps: Record<string, unknown>[];
+            };
+            systemSlot?: string | null | undefined;
+        }[];
+        currentGrants: {
+            accessLevel: "admin" | "read" | "write";
+            containerId: string;
+        }[];
+        currentMemberEnvelopes: {
+            envelopes: {
+                kemCipherText: string;
+                memberKeyFingerprint: string;
+                userId: string;
+                wrappedKey: string;
+            }[];
+            epoch: number;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentPayload: {
+            cipherSuite: "aes-256-gcm";
+            ciphertext: string;
+            ciphertextHash: string;
+            createdAt: string;
+            principalId: string;
+            principalType: "group" | "organization";
+            stateHash: string;
+        };
+        currentProjection: {
+            role: "member" | "admin";
+            userId: string;
+        }[];
+        currentState: {
+            createdAt: string;
+            encapsulationPublicKey: string;
+            externalAuthority: {
+                keyEpoch: number;
+                keyFingerprint: string;
+                principalId: string;
+                principalType: "group";
+                stateHash: string;
+                version: number;
+            } | null;
+            grantCount: number;
+            grantRoot: string;
+            keyEpoch: number;
+            keyFingerprint: string;
+            memberCount: number;
+            memberEnvelopesRoot: string;
+            membershipMode: "projection";
+            membershipRoot: string;
+            payloadCiphertextHash: string;
+            prevStateHash: string | null;
+            principalId: string;
+            principalType: "group" | "organization";
+            projectionRoot: string;
+            signature: string;
+            signedAt: string;
+            signerUserId: string;
+            signerUserKeyFingerprint: string;
+            stateHash: string;
+            version: number;
+        };
+    }>>;
+    commitResult(organizationId: string, groupId: string, input: CommitOrganizationGroupPolicyRequest, options?: RequestResultOptions): Promise<import("./types.js").RequestResult<{
+        groupPolicy: {
+            containerMutations: {
+                createdAt: string;
+                manifestHead: {
+                    epoch: number;
+                    manifestHash: string;
+                };
+                organizationId: string;
+                parentId: string | null;
+                referencedPrincipalHeads: {
+                    principalType: "group";
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    stateHash: string;
+                    version: number;
+                }[];
+                updatedAt: string;
+                accessManifest: {
+                    event: {
+                        body: unknown;
+                        event: Record<string, unknown>;
+                        eventHash: string;
+                    };
+                    manifest: Record<string, unknown>;
+                    manifestHash: string;
+                    state: Record<string, unknown>;
+                };
+                containerId: string;
+                containerKek: {
+                    accessManifestHash: string;
+                    containerId: string;
+                    containerKeyEpoch: number;
+                    containerKeyEpochId: string;
+                    containerManifestHistory: {
+                        event: {
+                            body: unknown;
+                            event: Record<string, unknown>;
+                            eventHash: string;
+                        };
+                        manifest: Record<string, unknown>;
+                        manifestHash: string;
+                        state: Record<string, unknown>;
+                    }[];
+                    keyEpoch: Record<string, unknown>;
+                    keyEpochHash: string;
+                    keyring: {
+                        containerId: string;
+                        containerKeyEpochId: string;
+                        iv: string;
+                        sealed: string;
+                        sealingSuite: string;
+                        version: number;
+                    } | null;
+                    keyTargetHash: string;
+                    parentContainerKeyEpochId: string | null;
+                    recipientTargets: Record<string, unknown>[];
+                    wraps: Record<string, unknown>[];
+                };
+                systemSlot?: string | null | undefined;
+            }[];
+            currentGrants: {
+                accessLevel: "admin" | "read" | "write";
+                containerId: string;
+            }[];
+            currentMemberEnvelopes: {
+                envelopes: {
+                    kemCipherText: string;
+                    memberKeyFingerprint: string;
+                    userId: string;
+                    wrappedKey: string;
+                }[];
+                epoch: number;
+                principalId: string;
+                principalType: "group" | "organization";
+                stateHash: string;
+            };
+            currentPayload: {
+                cipherSuite: "aes-256-gcm";
+                ciphertext: string;
+                ciphertextHash: string;
+                createdAt: string;
+                principalId: string;
+                principalType: "group" | "organization";
+                stateHash: string;
+            };
+            currentProjection: {
+                role: "member" | "admin";
+                userId: string;
+            }[];
+            currentState: {
+                createdAt: string;
+                encapsulationPublicKey: string;
+                externalAuthority: {
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    principalType: "group";
+                    stateHash: string;
+                    version: number;
+                } | null;
+                grantCount: number;
+                grantRoot: string;
+                keyEpoch: number;
+                keyFingerprint: string;
+                memberCount: number;
+                memberEnvelopesRoot: string;
+                membershipMode: "projection";
+                membershipRoot: string;
+                payloadCiphertextHash: string;
+                prevStateHash: string | null;
+                principalId: string;
+                principalType: "group" | "organization";
+                projectionRoot: string;
+                signature: string;
+                signedAt: string;
+                signerUserId: string;
+                signerUserKeyFingerprint: string;
+                stateHash: string;
+                version: number;
+            };
+        };
+        organizationPolicy: {
+            containerMutations: {
+                createdAt: string;
+                manifestHead: {
+                    epoch: number;
+                    manifestHash: string;
+                };
+                organizationId: string;
+                parentId: string | null;
+                referencedPrincipalHeads: {
+                    principalType: "group";
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    stateHash: string;
+                    version: number;
+                }[];
+                updatedAt: string;
+                accessManifest: {
+                    event: {
+                        body: unknown;
+                        event: Record<string, unknown>;
+                        eventHash: string;
+                    };
+                    manifest: Record<string, unknown>;
+                    manifestHash: string;
+                    state: Record<string, unknown>;
+                };
+                containerId: string;
+                containerKek: {
+                    accessManifestHash: string;
+                    containerId: string;
+                    containerKeyEpoch: number;
+                    containerKeyEpochId: string;
+                    containerManifestHistory: {
+                        event: {
+                            body: unknown;
+                            event: Record<string, unknown>;
+                            eventHash: string;
+                        };
+                        manifest: Record<string, unknown>;
+                        manifestHash: string;
+                        state: Record<string, unknown>;
+                    }[];
+                    keyEpoch: Record<string, unknown>;
+                    keyEpochHash: string;
+                    keyring: {
+                        containerId: string;
+                        containerKeyEpochId: string;
+                        iv: string;
+                        sealed: string;
+                        sealingSuite: string;
+                        version: number;
+                    } | null;
+                    keyTargetHash: string;
+                    parentContainerKeyEpochId: string | null;
+                    recipientTargets: Record<string, unknown>[];
+                    wraps: Record<string, unknown>[];
+                };
+                systemSlot?: string | null | undefined;
+            }[];
+            currentGrants: {
+                accessLevel: "admin" | "read" | "write";
+                containerId: string;
+            }[];
+            currentMemberEnvelopes: {
+                envelopes: {
+                    kemCipherText: string;
+                    memberKeyFingerprint: string;
+                    userId: string;
+                    wrappedKey: string;
+                }[];
+                epoch: number;
+                principalId: string;
+                principalType: "group" | "organization";
+                stateHash: string;
+            };
+            currentPayload: {
+                cipherSuite: "aes-256-gcm";
+                ciphertext: string;
+                ciphertextHash: string;
+                createdAt: string;
+                principalId: string;
+                principalType: "group" | "organization";
+                stateHash: string;
+            };
+            currentProjection: {
+                role: "member" | "admin";
+                userId: string;
+            }[];
+            currentState: {
+                createdAt: string;
+                encapsulationPublicKey: string;
+                externalAuthority: {
+                    keyEpoch: number;
+                    keyFingerprint: string;
+                    principalId: string;
+                    principalType: "group";
+                    stateHash: string;
+                    version: number;
+                } | null;
+                grantCount: number;
+                grantRoot: string;
+                keyEpoch: number;
+                keyFingerprint: string;
+                memberCount: number;
+                memberEnvelopesRoot: string;
+                membershipMode: "projection";
+                membershipRoot: string;
+                payloadCiphertextHash: string;
+                prevStateHash: string | null;
+                principalId: string;
+                principalType: "group" | "organization";
+                projectionRoot: string;
+                signature: string;
+                signedAt: string;
+                signerUserId: string;
+                signerUserKeyFingerprint: string;
+                stateHash: string;
+                version: number;
+            };
+        };
+    }>>;
+}