@serenity-js/core/src/events/ActivityRelatedArtifactArchived.ts

The core Serenity/JS framework, providing the Screenplay Pattern interfaces, as well as the test reporting and integration infrastructure

import type { JSONObject } from 'tiny-types';
import { ensure, isDefined } from 'tiny-types';

import { Path } from '../io';
import type { ArtifactType} from '../model';
import { Artifact, CorrelationId, Name } from '../model';
import { Timestamp } from '../screenplay';
import { ArtifactArchived } from './ArtifactArchived';

// todo: there should be two types of events here:
//  - ActivityArtifactGenerated
//  - SceneArtifactGenerated

/**
 * @group Events
 */
export class ActivityRelatedArtifactArchived extends ArtifactArchived {
    static fromJSON(o: JSONObject): ActivityRelatedArtifactArchived {
        return new ActivityRelatedArtifactArchived(
            CorrelationId.fromJSON(o.sceneId as string),
            CorrelationId.fromJSON(o.activityId as string),
            Name.fromJSON(o.name as string),
            Artifact.ofType(o.type as string),
            Path.fromJSON(o.path as string),
            Timestamp.fromJSON(o.artifactTimestamp as string),
            Timestamp.fromJSON(o.timestamp as string),
        );
    }

    constructor(
        sceneId: CorrelationId,
        public readonly activityId: CorrelationId,
        name: Name,
        type: ArtifactType,
        path: Path,
        artifactTimestamp: Timestamp,
        timestamp?: Timestamp,
    ) {
        super(sceneId, name, type, path, artifactTimestamp, timestamp);
        ensure('activityId', activityId, isDefined());
    }

    toJSON(): JSONObject {
        return {
            sceneId: this.sceneId.toJSON(),
            activityId: this.activityId.toJSON(),
            name: this.name.toJSON(),
            type: this.type.name,
            path: this.path.toJSON(),
            artifactTimestamp: this.artifactTimestamp.toJSON(),
            timestamp: this.timestamp.toJSON(),
        };
    }
}