@empire-builder-kit/runtime 1.0.0-beta.9 → 1.0.0-rc.1

package/src/data-lifecycle/rights.d.ts

@@ -0,0 +1,171 @@
+import { type DataLifecycleRuntimeHoldV1 } from './holds.js';
+export declare const DATA_LIFECYCLE_RIGHTS_STATE_VERSION: 1;
+export declare const DATA_LIFECYCLE_MAX_EXPORT_LIFETIME_MS: number;
+export type DataLifecycleApprovalRequirement = 'required' | 'not-required';
+export interface DataLifecycleTrackedCopyV1 {
+    attempts: number;
+    copyId: string;
+    outcomeCode?: string;
+    status: 'pending' | 'in-progress' | 'completed' | 'failed';
+}
+export type DataLifecycleDeletionStatus = 'requested' | 'verified' | 'held' | 'rejected' | 'primary-deletion-in-progress' | 'downstream-deletion-in-progress' | 'completed' | 'failed';
+export interface DataLifecycleDeletionRequestV1 {
+    approvalRef?: string;
+    approvalRequirement: DataLifecycleApprovalRequirement;
+    authorityRef?: string;
+    categoryId: string;
+    createdAt: string;
+    downstreamCopies: readonly DataLifecycleTrackedCopyV1[];
+    holdIds: readonly string[];
+    kind: 'data-deletion';
+    outcomeCode?: string;
+    policyVersion: string;
+    primaryLocationId: string;
+    primaryStatus: 'pending' | 'in-progress' | 'completed' | 'failed';
+    requestRef: string;
+    scopeRef: string;
+    status: DataLifecycleDeletionStatus;
+    updatedAt: string;
+    version: typeof DATA_LIFECYCLE_RIGHTS_STATE_VERSION;
+}
+export type DataLifecycleDeletionCommand = {
+    approvalRef?: string;
+    at: string;
+    authorityRef: string;
+    holds: readonly DataLifecycleRuntimeHoldV1[];
+    type: 'verify';
+} | {
+    at: string;
+    reasonCode: string;
+    type: 'reject';
+} | {
+    at: string;
+    type: 'start-primary';
+} | {
+    at: string;
+    outcomeCode: 'deleted' | 'not-found';
+    type: 'complete-primary';
+} | {
+    at: string;
+    errorCode: string;
+    type: 'fail-primary';
+} | {
+    at: string;
+    copyId: string;
+    type: 'start-copy';
+} | {
+    at: string;
+    copyId: string;
+    outcomeCode: 'acknowledged' | 'deleted' | 'not-found';
+    type: 'complete-copy';
+} | {
+    at: string;
+    copyId: string;
+    errorCode: string;
+    type: 'fail-copy';
+} | {
+    at: string;
+    type: 'retry';
+};
+export type DataLifecycleExportStatus = 'requested' | 'verified' | 'held' | 'rejected' | 'gathering' | 'ready' | 'expired' | 'artifact-deletion-in-progress' | 'unpublished-artifact-deletion-in-progress' | 'completed' | 'failed';
+export interface DataLifecycleExportArtifactV1 {
+    artifactRef: string;
+    createdAt: string;
+    encryption: 'approved-profile';
+    expiresAt: string;
+    status: 'available' | 'deletion-in-progress' | 'deleted';
+}
+export interface DataLifecycleExportRequestV1 {
+    approvalRef?: string;
+    approvalRequirement: DataLifecycleApprovalRequirement;
+    artifact?: DataLifecycleExportArtifactV1;
+    authorityRef?: string;
+    categoryId: string;
+    createdAt: string;
+    failurePhase?: 'gathering' | 'artifact-deletion' | 'unpublished-artifact-deletion';
+    holdIds: readonly string[];
+    kind: 'data-export';
+    outcomeCode?: string;
+    policyVersion: string;
+    requestRef: string;
+    scopeRef: string;
+    sourceCopies: readonly DataLifecycleTrackedCopyV1[];
+    status: DataLifecycleExportStatus;
+    updatedAt: string;
+    version: typeof DATA_LIFECYCLE_RIGHTS_STATE_VERSION;
+}
+export type DataLifecycleExportCommand = {
+    approvalRef?: string;
+    at: string;
+    authorityRef: string;
+    holds: readonly DataLifecycleRuntimeHoldV1[];
+    type: 'verify';
+} | {
+    at: string;
+    reasonCode: string;
+    type: 'reject';
+} | {
+    at: string;
+    type: 'start-gathering';
+} | {
+    at: string;
+    copyId: string;
+    type: 'start-copy';
+} | {
+    at: string;
+    copyId: string;
+    outcomeCode: 'gathered' | 'not-found';
+    type: 'complete-copy';
+} | {
+    at: string;
+    copyId: string;
+    errorCode: string;
+    type: 'fail-copy';
+} | {
+    artifactRef: string;
+    at: string;
+    encryption: 'approved-profile';
+    expiresAt: string;
+    type: 'publish';
+} | {
+    at: string;
+    type: 'expire';
+} | {
+    at: string;
+    type: 'start-artifact-deletion';
+} | {
+    at: string;
+    type: 'start-unpublished-artifact-deletion';
+} | {
+    at: string;
+    outcomeCode: 'deleted' | 'not-found';
+    type: 'complete-artifact-deletion';
+} | {
+    at: string;
+    errorCode: string;
+    type: 'fail-artifact-deletion';
+} | {
+    at: string;
+    type: 'retry';
+};
+export declare function createDataLifecycleDeletionRequest(options: {
+    approvalRequirement: DataLifecycleApprovalRequirement;
+    categoryId: string;
+    createdAt: string;
+    downstreamCopyIds: readonly string[];
+    policyVersion: string;
+    primaryLocationId: string;
+    requestRef: string;
+    scopeRef: string;
+}): DataLifecycleDeletionRequestV1;
+export declare function transitionDataLifecycleDeletion(current: DataLifecycleDeletionRequestV1, command: DataLifecycleDeletionCommand): DataLifecycleDeletionRequestV1;
+export declare function createDataLifecycleExportRequest(options: {
+    approvalRequirement: DataLifecycleApprovalRequirement;
+    categoryId: string;
+    createdAt: string;
+    policyVersion: string;
+    requestRef: string;
+    scopeRef: string;
+    sourceCopyIds: readonly string[];
+}): DataLifecycleExportRequestV1;
+export declare function transitionDataLifecycleExport(current: DataLifecycleExportRequestV1, command: DataLifecycleExportCommand): DataLifecycleExportRequestV1;