@serve.zone/interfaces 25.1.0 → 25.2.0

package/dist_ts/runtime.corestore.d.ts

@@ -0,0 +1,204 @@
+import * as plugins from './plugins.js';
+import type { IActiveSecretRecipientMetadata, IIdentityCredential, ISecretVersionReference } from './data/index.js';
+import type { ISecretEnvelopeAdmissionBindingV1 } from './runtime.js';
+import type { IObjectStorageRetentionEvidenceExpectationV1, IObjectStorageRetentionEvidenceV1 } from './platform/objectstorageretention.js';
+export type TCorestoreCredentialCapability = 'database' | 'objectstorage';
+export declare const corestoreProviderConfigIds: Readonly<{
+    readonly database: "cloudly-corestore-database";
+    readonly objectstorage: "cloudly-corestore-objectstorage";
+}>;
+export declare const corestoreControlUrl: "http://corestore:3000";
+export declare const corestoreCredentialManagementScope: "platform:cloudly-corestore";
+export declare const corestoreControlCredentialKey: "CORESTORE_API_TOKEN";
+export declare const corestoreCredentialEnvironment: "production";
+export declare const corestoreCredentialRuntimeLimits: Readonly<{
+    maximumIdentifierLength: 200;
+    maximumPublicationGrants: 256;
+    maximumGrantLifetimeMs: number;
+    maximumCredentialStringBytes: number;
+    maximumSealedMaterialBytes: number;
+    minimumControlTokenBytes: 32;
+    maximumControlTokenBytes: 4096;
+    maximumSealedControlCredentialBytes: number;
+}>;
+export declare const getCorestoreProviderConfigId: (capabilityArg: TCorestoreCredentialCapability) => (typeof corestoreProviderConfigIds)[TCorestoreCredentialCapability];
+export interface ICorestoreControlCredentialPlaintextV1 {
+    schemaVersion: 1;
+    key: typeof corestoreControlCredentialKey;
+    environment: typeof corestoreCredentialEnvironment;
+    value: string;
+}
+export interface ICorestoreControlCredentialMaterialV1 {
+    schemaVersion: 1;
+    requestId: string;
+    clusterId: string;
+    capability: TCorestoreCredentialCapability;
+    providerConfigId: typeof corestoreProviderConfigIds[TCorestoreCredentialCapability];
+    controlUrl: typeof corestoreControlUrl;
+    managementScope: typeof corestoreCredentialManagementScope;
+    key: typeof corestoreControlCredentialKey;
+    environment: typeof corestoreCredentialEnvironment;
+    recipientKeyId: string;
+    recipientGeneration: number;
+    envelope: plugins.smartcrypto.IX25519EnvelopeV1;
+}
+export interface IReq_GetCorestoreControlCredentialMaterial extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_GetCorestoreControlCredentialMaterial> {
+    method: 'getCorestoreControlCredentialMaterial';
+    request: {
+        identity: IIdentityCredential;
+        requestId: string;
+        capability: TCorestoreCredentialCapability;
+        expectedRecipientKeyId: string;
+        expectedRecipientGeneration: number;
+    };
+    response: {
+        material: ICorestoreControlCredentialMaterialV1;
+    };
+}
+export interface ICorestoreControlCredentialMaterialExpectationV1 {
+    requestId: string;
+    clusterId: string;
+    capability: TCorestoreCredentialCapability;
+    expectedRecipientKeyId: string;
+    expectedRecipientGeneration: number;
+}
+export interface ICorestoreControlCredentialMaterialContextInputV1 {
+    requestId: string;
+    clusterId: string;
+    capability: TCorestoreCredentialCapability;
+    recipientKeyId: string;
+    recipientGeneration: number;
+}
+export declare const validateGetCorestoreControlCredentialMaterialRequest: (requestArg: unknown, activeRecipientArg: IActiveSecretRecipientMetadata) => string[];
+export declare const createCorestoreControlCredentialMaterialEnvelopeContext: (materialArg: ICorestoreControlCredentialMaterialContextInputV1) => Uint8Array;
+export declare const validateCorestoreControlCredentialPlaintext: (plaintextArg: unknown) => string[];
+export declare const validateCorestoreControlCredentialMaterial: (materialArg: unknown, expectedArg: ICorestoreControlCredentialMaterialExpectationV1) => Promise<string[]>;
+export interface ICorestoreCredentialPublicationGrantV1 {
+    schemaVersion: 1;
+    operationId: string;
+    serviceId: string;
+    bindingId: string;
+    capability: TCorestoreCredentialCapability;
+    reconciliationGeneration: number;
+    expectedTargetSecretsRevision: number;
+    bindingRequestDigest: string;
+    issuedAt: number;
+    expiresAt: number;
+}
+export declare const validateCorestoreCredentialPublicationGrant: (grantArg: unknown, trustedNowArg?: number) => string[];
+export declare const corestoreCredentialPublicationGrantsEqual: (leftArg: unknown, rightArg: unknown) => boolean;
+export declare const validateCorestoreCredentialPublicationGrants: (grantsArg: unknown, trustedNowArg?: number) => string[];
+export declare const corestoreDatabaseCredentialKeys: readonly ["MONGODB_URI", "MONGODB_URL", "MONGO_URL", "MONGODB_HOST", "MONGODB_PORT", "MONGODB_DATABASE", "MONGO_DBNAME", "MONGODB_USERNAME", "MONGO_DBUSER", "MONGODB_PASSWORD", "MONGO_DBPASS"];
+export declare const corestoreObjectStorageCredentialKeys: readonly ["accessKeyId", "secretAccessKey"];
+export type TCorestoreDatabaseCredentialKey = typeof corestoreDatabaseCredentialKeys[number];
+export type TCorestoreObjectStorageCredentialKey = typeof corestoreObjectStorageCredentialKeys[number];
+export type TCorestoreCredentialKey = TCorestoreDatabaseCredentialKey | TCorestoreObjectStorageCredentialKey;
+export type TCorestoreDatabaseCredentialValuesV1 = {
+    [TKey in TCorestoreDatabaseCredentialKey]: string;
+};
+export interface ICorestoreDatabaseCredentialPlaintextMaterialV1 {
+    schemaVersion: 1;
+    capability: 'database';
+    values: TCorestoreDatabaseCredentialValuesV1;
+}
+export interface ICorestoreObjectStorageCredentialPlaintextMaterialV1 {
+    schemaVersion: 1;
+    capability: 'objectstorage';
+    values: {
+        accessKeyId: string;
+        secretAccessKey: string;
+    };
+    retention?: IObjectStorageRetentionEvidenceV1;
+}
+export type TCorestoreCredentialPlaintextMaterialV1 = ICorestoreDatabaseCredentialPlaintextMaterialV1 | ICorestoreObjectStorageCredentialPlaintextMaterialV1;
+export declare const validateCorestoreDatabaseCredentialMaterial: (materialArg: unknown) => string[];
+export declare const validateCorestoreObjectStorageCredentialMaterial: (materialArg: unknown, retentionExpectationArg?: IObjectStorageRetentionEvidenceExpectationV1) => Promise<string[]>;
+export declare const validateCorestoreCredentialPlaintextMaterial: (materialArg: unknown, retentionExpectationArg?: IObjectStorageRetentionEvidenceExpectationV1) => Promise<string[]>;
+export interface IPublishCorestoreCredentialMaterialRequestV1 {
+    identity: IIdentityCredential;
+    mutationId: string;
+    grant: ICorestoreCredentialPublicationGrantV1;
+    expectedIngressRecipientKeyId: string;
+    expectedIngressRecipientGeneration: number;
+    envelope: plugins.smartcrypto.IX25519EnvelopeV1;
+}
+export interface ICorestoreCredentialSecretVersionReferenceV1 extends ISecretVersionReference {
+    key: TCorestoreCredentialKey;
+}
+export interface ICorestoreCredentialPublicationCoverageV1 {
+    keys: TCorestoreCredentialKey[];
+    versionReferences: ICorestoreCredentialSecretVersionReferenceV1[];
+}
+export interface ICorestoreCredentialPublicationReceiptV1 {
+    schemaVersion: 1;
+    mutationId: string;
+    organizationId: string;
+    clusterId: string;
+    serviceId: string;
+    bindingId: string;
+    capability: TCorestoreCredentialCapability;
+    grant: ICorestoreCredentialPublicationGrantV1;
+    coverage: ICorestoreCredentialPublicationCoverageV1;
+    expectedTargetSecretsRevision: number;
+    targetSecretsRevision: number;
+    ingressAdmissionBinding: ISecretEnvelopeAdmissionBindingV1;
+    acceptedAt: number;
+    replayed: boolean;
+}
+export interface IReq_PublishCorestoreCredentialMaterial extends plugins.typedrequestInterfaces.implementsTR<plugins.typedrequestInterfaces.ITypedRequest, IReq_PublishCorestoreCredentialMaterial> {
+    method: 'publishCorestoreCredentialMaterial';
+    request: IPublishCorestoreCredentialMaterialRequestV1;
+    response: {
+        receipt: ICorestoreCredentialPublicationReceiptV1;
+    };
+}
+export declare const createPublishCorestoreCredentialMaterialEnvelopeContext: (requestArg: Omit<IPublishCorestoreCredentialMaterialRequestV1, "identity" | "envelope">) => Uint8Array;
+export declare const validatePublishCorestoreCredentialMaterialRequest: (requestArg: unknown, expectedGrantArg: ICorestoreCredentialPublicationGrantV1, activeRecipientArg: IActiveSecretRecipientMetadata, trustedNowArg: number) => Promise<string[]>;
+export interface ICorestoreCredentialPublicationReceiptExpectationV1 {
+    request: IPublishCorestoreCredentialMaterialRequestV1;
+    organizationId: string;
+    clusterId: string;
+}
+export declare const validateCorestoreCredentialPublicationReceipt: (receiptArg: unknown, expectedArg: ICorestoreCredentialPublicationReceiptExpectationV1) => Promise<string[]>;
+export declare const corestoreCredentialPublicationErrorMetadata: Readonly<{
+    readonly INVALID_IDENTITY: Readonly<{
+        retryable: false;
+    }>;
+    readonly INVALID_REQUEST: Readonly<{
+        retryable: false;
+    }>;
+    readonly GRANT_EXPIRED: Readonly<{
+        retryable: false;
+    }>;
+    readonly GRANT_SCOPE_MISMATCH: Readonly<{
+        retryable: false;
+    }>;
+    readonly GRANT_REVISION_MISMATCH: Readonly<{
+        retryable: true;
+    }>;
+    readonly INGRESS_RECIPIENT_MISMATCH: Readonly<{
+        retryable: true;
+    }>;
+    readonly ENVELOPE_INVALID: Readonly<{
+        retryable: false;
+    }>;
+    readonly MATERIAL_INVALID: Readonly<{
+        retryable: false;
+    }>;
+    readonly SECRETS_REVISION_CONFLICT: Readonly<{
+        retryable: true;
+    }>;
+    readonly REPLAY_CONFLICT: Readonly<{
+        retryable: false;
+    }>;
+    readonly INTERNAL_ERROR: Readonly<{
+        retryable: true;
+    }>;
+}>;
+export type TCorestoreCredentialPublicationErrorCode = keyof typeof corestoreCredentialPublicationErrorMetadata;
+export interface ICorestoreCredentialPublicationErrorMetadataV1 {
+    schemaVersion: 1;
+    code: TCorestoreCredentialPublicationErrorCode;
+    retryable: boolean;
+}
+export declare const getCorestoreCredentialPublicationErrorMetadata: (codeArg: TCorestoreCredentialPublicationErrorCode) => ICorestoreCredentialPublicationErrorMetadataV1;