@ngageoint/mage.service 6.3.0-beta.0

package/lib/entities/observations/entities.observations.d.ts

@@ -0,0 +1,580 @@
+/// <reference types="node" />
+import { UserId } from '../users/entities.users';
+import { BBox, Feature, Geometry } from 'geojson';
+import { MageEvent, MageEventAttrs, MageEventId } from '../events/entities.events';
+import { PageOf, PagingParameters, PendingEntityId } from '../entities.global';
+import { Form, FormField, FormId } from '../events/entities.events.forms';
+import { JsonPrimitive } from '../entities.json_types';
+export type ObservationId = string;
+export interface ObservationAttrs extends Feature<Geometry, ObservationFeatureProperties> {
+    id: ObservationId;
+    eventId: MageEventId;
+    userId?: UserId;
+    deviceId?: string;
+    createdAt: Date;
+    lastModified: Date;
+    attachments: readonly Attachment[];
+    important?: Readonly<ObservationImportantFlag> | undefined;
+    /**
+     * TODO: scalability - potential problem if thousands of users favorite;
+     * this should not be returned to the client
+     */
+    favoriteUserIds: readonly UserId[];
+    /**
+     * * TODO: scalability - likely not a problem in practice most of the time
+     * * TODO: we do not actually have a reason to maintain an array of states -
+     *   state should just be a single value object, and should not need
+     *   a unique id
+     */
+    states: readonly ObservationState[];
+}
+export interface ObservationFeatureProperties {
+    /**
+     * This timestamp is a user-supplied timestamp that indicates the actual time
+     * the observation occurred.
+     */
+    timestamp: Date;
+    forms: FormEntry[];
+}
+export interface ObservationImportantFlag {
+    userId?: UserId;
+    timestamp?: Date;
+    description?: string;
+}
+export interface ObservationState {
+    id: string | PendingEntityId;
+    name: 'active' | 'archived';
+    userId?: UserId | undefined;
+}
+export type FormEntryId = string;
+/**
+ * TODO: create strong types and union for form field values, basically json
+ * primitives along with attachment array and geojson geometry object
+ */
+export interface FormEntry {
+    id: FormEntryId;
+    formId: FormId;
+    [formFieldName: string]: FormFieldEntry;
+}
+export type FormFieldEntryItem = Exclude<JsonPrimitive, null> | Geometry | Date;
+export type FormFieldEntry = FormFieldEntryItem | FormFieldEntryItem[] | null;
+export type AttachmentId = string;
+/**
+ * TODO: Currently the web app uses the `name` and `contentType` keys in the
+ * attachment object to correlate pending file uploads to newly saved
+ * attachments.  While this works most of the time, especially for the web
+ * when uplaods are nearly immediate, maybe something like a `pendingUploadId`
+ * key would be more reliable for correlating a saved attachment record to
+ * the file that the client intends to upload for that attachment.
+ */
+export interface Attachment {
+    /**
+     * Attachment IDs are globally unique, not unique only in the context of an
+     * observation or form entry.
+     */
+    id: AttachmentId;
+    observationFormId: FormEntryId;
+    fieldName: string;
+    /**
+     * TODO: Nothing seems to use this property.  Should we remove it, or
+     * actually use it to inform browser caching?
+     */
+    lastModified?: Date;
+    /**
+     * The content type is an IANA standard media type string, e.g., `image/jpeg`.
+     */
+    contentType?: string;
+    size?: number;
+    name?: string;
+    width?: number;
+    height?: number;
+    /**
+     * The attachment's content locator is an abstract term that mostly exists
+     * to reconcile with the legacy design of storing the relative file system
+     * path of an attachment's file on the attachment document itself.  However,
+     * as MAGE transitions to cloud-native infrastructure, one can more easily
+     * envision swapping some sort of cloud-based BLOB storage service for the
+     * legacy local file system storage.  Renaming the old `relativePath`
+     * property to `contentLocator` is an attempt to allow for saving a lookup key
+     * that does not necessarily imply an underlying file system as the storage
+     * layer.  Implementations of the abstract {@link AttachmentStore} interface
+     * would assign their own lookup key to this property, although the intention
+     * of that interface's design is to be completely opaque with respect to how
+     * an implementation stores and indexes attachment content.  An attachment
+     * store implementation may not use `contentLocator` at all.
+     */
+    contentLocator?: string;
+    /**
+     * TODO: this needs to allow a more robust value, such as
+     * `undefined | boolean` or maybe even allow `{ error: string }` so the
+     * image plugin's unprocessed attachment query can easily find attachments
+     * that have not yet been touched vs. attachments whose content could not be
+     * oriented.  admins should also be able to easily query for the faulty
+     * attachments to take corrective action if possible.
+     *
+     * also, because this and the `thumbnails` field are specific to the image
+     * plugin, they should both be moved out of the core domain type.
+     */
+    oriented: boolean;
+    thumbnails: Thumbnail[];
+}
+export interface Thumbnail {
+    minDimension: number;
+    /**
+     * See {@link Attachment.contentLocator} for an explanation.
+     */
+    contentLocator?: string;
+    contentType?: string;
+    size?: number;
+    name?: string;
+    width?: number;
+    height?: number;
+}
+export declare function copyObservationAttrs(from: ObservationAttrs): ObservationAttrs;
+export declare function copyAttachmentAttrs(from: Attachment): Attachment;
+export declare function copyThumbnailAttrs(from: Thumbnail): Thumbnail;
+export declare function copyObservationStateAttrs(from: ObservationState): ObservationState;
+export declare function copyImportantFlagAttrs(from: ObservationImportantFlag): ObservationImportantFlag;
+/**
+ * The intention of this class is to provide a mutation model for observation
+ * updates.  While `ObservationAttrs` is more just raw the keys and values of
+ * observations, this class retains some extra context for validation so
+ * the client can make changes to the observation data while receiving
+ * validation feedback for every operation performed on the observation.
+ * TODO: add domain event tracking to this class
+ */
+export declare class Observation implements Readonly<ObservationAttrs> {
+    #private;
+    /**
+     * Validate the given observation attributes against the given MAGE event's
+     * constraints and forms, and create the corresponding `Observation` instance
+     * with the validation result.
+     * @param attrs
+     * @param mageEvent
+     */
+    static evaluate(attrs: ObservationAttrs, mageEvent: MageEvent): Observation;
+    /**
+     * TODO: This does not currently do anything besides assigning the
+     * `lastModified` timestamp on the updated observation and calling
+     * {@link Observation.evaluate()} with the given update attributes.
+     * Eventually this should perform the logic to find the differences and
+     * produce the domain events resulting from updating the target observation
+     * to the update attributes.
+     *
+     * Return an {@link ObservationUpdateError} if the event IDs on the target
+     * and udpate do not match.
+     *
+     * @param target
+     * @param update
+     * @returns
+     */
+    static assignTo(target: Observation, update: ObservationAttrs): Observation | ObservationUpdateError;
+    readonly id: string;
+    readonly eventId: number;
+    readonly mageEvent: MageEvent;
+    /**
+     * If an observation has no user ID, the user that created the observation
+     * was removed from the system.
+     */
+    readonly userId?: UserId | undefined;
+    /**
+     * If an observation has no device ID, the device that submitted the
+     * observation was removed from the system.
+     */
+    readonly deviceId?: string | undefined;
+    readonly createdAt: Date;
+    readonly lastModified: Date;
+    readonly important?: Readonly<ObservationImportantFlag> | undefined;
+    readonly states: readonly ObservationState[];
+    readonly favoriteUserIds: readonly UserId[];
+    readonly type = "Feature";
+    readonly bbox?: BBox | undefined;
+    readonly geometry: Readonly<Geometry>;
+    readonly properties: Readonly<ObservationFeatureProperties>;
+    readonly attachments: readonly Attachment[];
+    readonly pendingEvents: readonly PendingObservationDomainEvent[];
+    constructor(...args: unknown[]);
+    get validation(): ObservationValidationResult;
+    /**
+     * This is a convenience accessor for {@link ObservationFeatureProperties.timestamp}.
+     */
+    get timestamp(): Date;
+    /**
+     * This is a convenience accessor for {@link ObservationFeatureProperties.forms}.
+     */
+    get formEntries(): FormEntry[];
+    formEntryForId(id: FormEntryId): FormEntry | null;
+    attachmentFor(id: AttachmentId): Attachment | null;
+    attachmentsForField(fieldName: string, formEntryId: FormEntryId): Attachment[];
+}
+export declare enum ObservationDomainEventType {
+    AttachmentsRemoved = "Observation.AttachmentsRemoved"
+}
+/**
+ * A pending domain event waits for dispatch in the {@link Observation.pendingEvents | pending events}
+ * on the observation instance that generated the event.  To avoid a circular
+ * reference, pending events do not have a member for the observation instance
+ * that generated them.
+ */
+export type PendingObservationDomainEvent = {
+    readonly type: ObservationDomainEventType;
+} & ({
+    type: ObservationDomainEventType.AttachmentsRemoved;
+    readonly removedAttachments: readonly Readonly<Attachment>[];
+});
+/**
+ * This type simply adds the subject observation instance to the {@link PendingObservationDomainEvent}
+ * so listeners of the event will have the observation that generated the
+ * event when received.
+ */
+export type ObservationEmitted<Pending extends PendingObservationDomainEvent> = Pending & {
+    /**
+     * For now, this value is the snapshot of the observation just after the save
+     * operation that initiated domain event dispatch.  Hence, this observation
+     * will have no pending events and reflects the state of the observation
+     * after the mutations that created the domain events.  That understanding
+     * could change if more domain event requirements present themselves, but
+     * this is sufficient for the, at this time, singular domain event that
+     * supports attachment removal.
+     */
+    readonly observation: Observation;
+};
+export type AttachmentsRemovedDomainEvent = Extract<PendingObservationDomainEvent, {
+    type: ObservationDomainEventType.AttachmentsRemoved;
+}>;
+export interface ObservationValidationResult {
+    readonly hasErrors: boolean;
+    readonly coreAttrsErrors: {
+        readonly [attr in ObservationValidationCoreAttrKey]?: string;
+    };
+    readonly formCountErrors: readonly [FormId, FormCountError][];
+    readonly formEntryErrors: readonly [number, FormEntryValidationError][];
+    /**
+     * This list contains attachment error map entries where the key is the
+     * position of the attachment in the `attachments` array on the observation,
+     * and the value is the `AttachmentValidationError`.
+     */
+    readonly attachmentErrors: readonly [number, AttachmentValidationError][];
+    readonly totalFormCountError: TotalFormCountError | null;
+}
+export declare function validateObservation(observationAttrs: ObservationAttrs, mageEvent: MageEvent): ObservationValidationResult;
+export type ObservationValidationCoreAttrKey = 'eventId' | 'type' | 'geometry' | 'timestamp' | 'forms';
+export declare const MinFormsConstraint: unique symbol;
+export declare const MaxFormsConstraint: unique symbol;
+export declare class TotalFormCountError {
+    readonly constraint: typeof MinFormsConstraint | typeof MaxFormsConstraint;
+    readonly constraintCount: number;
+    static tooFewFormEntries(mageEvent: MageEventAttrs): TotalFormCountError;
+    static tooManyFormEntries(mageEvent: MageEventAttrs): TotalFormCountError;
+    private constructor();
+    message(): string;
+}
+export declare class FormCountError {
+    readonly constraint: typeof MinFormsConstraint | typeof MaxFormsConstraint;
+    readonly constraintCount: number;
+    readonly formId: FormId;
+    readonly formName: string;
+    static tooFewEntriesForForm(form: Form): FormCountError;
+    static tooManyEntriesForForm(form: Form): FormCountError;
+    private constructor();
+    message(): string;
+}
+export declare class FormEntryValidationError {
+    #private;
+    readonly formEntryId: FormEntryId;
+    readonly formEntryPosition: number;
+    /**
+     * If there is no form reference error, set the form name for convenience
+     * when building the validation error message text.
+     */
+    formName: string | null;
+    constructor(formEntryId: FormEntryId, formEntryPosition: number);
+    addEntryLevelError(x: FormEntryValidationErrorReason): this;
+    addFieldError(x: FormFieldValidationError): this;
+    get entryLevelErrors(): Set<FormEntryValidationErrorReason>;
+    /**
+     * This is a map of field names to form field validation errors.
+     */
+    get fieldErrors(): Map<string, FormFieldValidationError>;
+}
+export declare enum FormEntryValidationErrorReason {
+    FormRef = "FormEntryValidationErrorReason.FormRef",
+    DuplicateId = "FormEntryValidationErrorReason.DuplicateId"
+}
+export type FormFieldValidationErrorAttrs = {
+    [Prop in keyof Omit<FormFieldValidationError, 'error'>]: FormFieldValidationError[Prop];
+};
+export declare enum FieldConstraintKey {
+    Value = "value",
+    Min = "min",
+    Max = "max",
+    Required = "required"
+}
+export declare class FormFieldValidationError {
+    readonly fieldName: string;
+    readonly constraint: FieldConstraintKey;
+    readonly message: string;
+    constructor(attrs: FormFieldValidationErrorAttrs);
+    /**
+     * `error` is a readonly accessor alias for `validationRuleKey` for backward
+     * compatibility.
+     * TODO: verify this is still necessary (NECESSARY?!)
+     */
+    get error(): string;
+}
+export declare enum AttachmentValidationErrorReason {
+    FieldRef = "AttachmentValidationErrorReason.FieldRef",
+    FormEntryRef = "AttachmentValidationErrorReason.FormEntryRef",
+    DuplicateId = "AttachmentValidationErrorReason.DuplicateId"
+}
+export declare class AttachmentValidationError {
+    readonly reason: AttachmentValidationErrorReason;
+    readonly message: string;
+    constructor(reason: AttachmentValidationErrorReason, message: string);
+}
+export declare function validationResultMessage(result: ObservationValidationResult): string;
+export declare class ObservationUpdateError extends Error {
+    readonly reason: ObservationUpdateErrorReason;
+    static eventIdMismatch(expected: MageEventId, actual: MageEventId | undefined): ObservationUpdateError;
+    constructor(reason: ObservationUpdateErrorReason, message: string);
+}
+export declare enum ObservationUpdateErrorReason {
+    EventId = "event_id"
+}
+export declare function formEntryForId(formEntryId: FormEntryId, observation: ObservationAttrs): FormEntry | null;
+export declare function attachmentsForField(field: FormField | string, formEntry: FormEntry | FormEntryId, observationAttrs: ObservationAttrs): Attachment[];
+/**
+ * Remove the form entry with the given ID and return the resulting
+ * (potentially invalid) observation.
+ *
+ * TODO: add a `FormEntryNotFound` error similar to `removeAttachment()`
+ */
+export declare function removeFormEntry(observation: Observation, formEntryId: FormEntryId): Observation;
+export type AttachmentCreateAttrs = Omit<Attachment, 'id' | 'observationFormId' | 'fieldName' | 'lastModified'>;
+export type AttachmentPatchAttrs = Partial<AttachmentCreateAttrs>;
+export type AttachmentContentPatchAttrs = Required<Pick<Attachment, 'contentLocator' | 'size'>>;
+export type ThumbnailContentPatchAttrs = Required<Pick<Thumbnail, 'contentLocator' | 'size'>> & Thumbnail;
+/**
+ * Add the given attachment to the given observation.  Return a new observation
+ * instance with the added attachment, or return an {@link AttachmentAddError}
+ * if the given attachment does not reference a valid form entry and field.
+ * Note that the returned observation may still have validation errors resulting
+ * from the added attachment if the attachment violates the associated form
+ * constraints, such as min/max or allowed attachment types.
+ * @param observation
+ * @param fieldName
+ * @param formEntryId
+ * @param attrs
+ * @returns
+ */
+export declare function addAttachment(observation: Observation, attachmentId: AttachmentId, fieldName: string, formEntryId: FormEntryId, attrs: AttachmentCreateAttrs): Observation | AttachmentAddError;
+/**
+ * Update the attachment for the given ID with the given patch object.  Keys
+ * that are present in the patch whose values are `undefined` will assign
+ * `undefined` to the resulting updated attachment.  Keys not present in the
+ * patch will have no affect on the resulting updated attachment.
+ * @param observation
+ * @param attachmentId
+ * @param patch
+ * @returns
+ */
+export declare function patchAttachment(observation: Observation, attachmentId: AttachmentId, patch: AttachmentPatchAttrs): Observation | AttachmentNotFoundError;
+export declare function removeAttachment(observation: Observation, attachmentId: AttachmentId): Observation | AttachmentNotFoundError;
+/**
+ * Add the given thumbnail to the given attachment.  If the attachment already
+ * has a thumbnail at the same minimum dimension as the given thumbnail,
+ * replace the existing thumbnail with the given thumbnail at the same position
+ * in the thumbnails array.
+ * @param observation
+ * @param attachmentId
+ * @param thumbnail
+ * @returns
+ */
+export declare function putAttachmentThumbnailForMinDimension(observation: Observation, attachmentId: AttachmentId, thumbnail: Thumbnail): Observation | AttachmentNotFoundError;
+/**
+ * Return the index of the thumbnail on the given attachment that best satisfies
+ * the given target dimension.  That will be the thumbnail with the smallest
+ * {@link Attachment.minDimension} greater than the target dimension.
+ */
+export declare function thumbnailIndexForTargetDimension(targetDimension: number, attachment: Attachment): number | undefined;
+export declare class AttachmentAddError extends Error {
+    readonly validationErr: AttachmentValidationError;
+    static invalidNewAttachment(invalidErr: AttachmentValidationError): AttachmentAddError;
+    constructor(validationErr: AttachmentValidationError);
+}
+export declare class AttachmentNotFoundError extends Error {
+    readonly attachmentId: AttachmentId;
+    constructor(attachmentId: AttachmentId);
+}
+/**
+ * This repository provides persistence operations for `Observation` entities
+ * within the scope of one MAGE event.
+ */
+export interface EventScopedObservationRepository {
+    readonly eventScope: MageEventId;
+    allocateObservationId(): Promise<ObservationId>;
+    /**
+     * Save the given observation.  This operation uses PUT semantics, so
+     * essentially overwrites an existing observation with the given attributes.
+     * Therefore, the risk of conflicting udpates exists, when two or more
+     * clients fetch the same version of an observation, and each client makes
+     * different changes to the observation, the client that saves its changes
+     * last will win, overwriting the changes the other clients saved.
+     * @param observation
+     */
+    save(observation: Observation): Promise<Observation | ObservationRepositoryError>;
+    findById(id: ObservationId): Promise<Observation | null>;
+    /**
+     * Return the most recent observation in the event as determined by
+     * the observation's `lastModified` timestamp.  Return null if there are no
+     * observations in the event.
+     * @returns an `Observation` object or `null`
+     */
+    findLatest(): Promise<ObservationAttrs | null>;
+    findLastModifiedAfter(timestamp: number, paging: PagingParameters): Promise<PageOf<ObservationAttrs>>;
+    /**
+     * Update the specified attachment with the given attributes.  This
+     * persistence function exists alongside the {@link save} method to prevent
+     * concurrent updates from colliding and overwriting each other.  That
+     * situation is common when storing attachment content because a single
+     * client will intiate several parallel content uploads for multiple
+     * attachments.  Each separate content upload could fetch the same version of
+     * the observation from the database, store the content, then update that
+     * version of the observation record.  If using the whole observation `save()`
+     * method to apply the update just for a single attachment, each save
+     * operation would overwrite the changes for the save operations that came
+     * before.  Return the updated `Observation` entity instance on a successful
+     * update.  Return an `AttachmentNotFoundError` if the given observation did
+     * not have an attachment with the given attachment ID.  Return null if the
+     * given observation does not exist in the database.
+     *
+     * Note that this is a shallow patch, so if the patch has the `thumbnails`
+     * key, the method will persist the value of that key to the database, as
+     * opposed to deeply patching any thumbnails present in the array.  This
+     * method should essentially use {@link patchAttachment} to perform the
+     * patch for the resulting attachment.
+     *
+     * TODO: Account for patch invalidating the attachment media type.
+     */
+    patchAttachment(observation: Observation, attachmentId: AttachmentId, contentInfo: AttachmentPatchAttrs): Promise<Observation | AttachmentNotFoundError | null>;
+    /**
+     * Because attachments reference a form entry by its ID, an API to generate
+     * form entry IDs is necessary.
+     */
+    nextFormEntryIds(count?: number): Promise<FormEntryId[]>;
+    nextAttachmentIds(count?: number): Promise<AttachmentId[]>;
+}
+export declare class ObservationRepositoryError extends Error {
+    readonly code: ObservationRepositoryErrorCode;
+    constructor(code: ObservationRepositoryErrorCode, message?: string);
+}
+export declare enum ObservationRepositoryErrorCode {
+    InvalidObservationId = "ObservationRepositoryError.InvalidObservationId",
+    InvalidObservation = "ObservationRepositoryError.InvalidObservation"
+}
+export interface ObservationRepositoryForEvent {
+    (event: MageEventId): Promise<EventScopedObservationRepository>;
+}
+export type StagedAttachmentContentId = unknown;
+export declare class StagedAttachmentContentRef {
+    readonly id: StagedAttachmentContentId;
+    constructor(id: StagedAttachmentContentId);
+}
+export declare class StagedAttachmentContent extends StagedAttachmentContentRef {
+    readonly tempLocation: NodeJS.WritableStream;
+    constructor(id: StagedAttachmentContentId, tempLocation: NodeJS.WritableStream);
+}
+/**
+ * TODO: Maybe instead of the `null | Observation | AttachmentStoreError`
+ * pattern many of these method signatures use, a single `AttachmentStoreResult`
+ * class with a `success` flag and `observation` and `error` properties would
+ * be eaiser for clients to consume.
+ */
+export interface AttachmentStore {
+    /**
+     * Create a temporary staging area to hold attachment content pending
+     * persistence of the associated attachment record to the observation in the
+     * database.  After saving the attachment record to the parent observation,
+     * the client must move the temporary content to the proper permanent
+     * location for the  saved attachment using the {@link saveContent()} function.
+     * This mechanism is useful in cases when a content stream exists, but the
+     * provider of the content stream needs to examine the bytes while streaming
+     * to the temporary location in order to determine the attachment meta-data.
+     * This mechanism also facilitates periodic cleanup of orphaned temporary
+     * content.
+     */
+    stagePendingContent(): Promise<StagedAttachmentContent>;
+    /**
+     * Save the given content to the store for the specified attachment.  If the
+     * `content` argument is an ID for {@link StagedAttachmentContent staged content},
+     * the store will move the content at the temporary location to the permanent
+     * location for the specified attachment.  If the store assigns a new
+     * {@link Attachment.contentLocator | content locator} to the attachment after
+     * a successful save, and/or changes the size of the attachment to the actual
+     * number of bytes written, return a {@link AttachmentContentPatchAttrs patch}
+     * to {@link EventScopedObservationRepository.patchAttachment update}
+     * the attachment  new observation instance with the {@link patchAttachment | patched}
+     * attachment.  Return `null` if the save succeeded and no change to the
+     * attachment was necessary.  Return an {@link AttachmentStoreError} if the
+     * save failed.
+     */
+    saveContent(content: NodeJS.ReadableStream | StagedAttachmentContentRef, attachmentId: AttachmentId, observation: Observation): Promise<null | AttachmentContentPatchAttrs | AttachmentStoreError>;
+    /**
+     * Similar to {@link saveContent()}, but for thumbnails of attachments.
+     * The store distinguishes thumbnails by their standard minimum dimension.
+     * If the `contentLocator` or the `size` of the stored thumbnail content is
+     * different than what is on the input thumbnail meta-data, return thumbnail
+     * attributes suitable to pass to {@link putAttachmentThumbnailForMinDimension}
+     * to update the observation with the new attachment thumbnail.
+     */
+    saveThumbnailContent(content: NodeJS.ReadableStream | StagedAttachmentContentId, minDimension: number, attachmentId: AttachmentId, observation: Observation): Promise<null | ThumbnailContentPatchAttrs | AttachmentStoreError>;
+    /**
+     * Return a read stream of the content for the given attachment.  The client
+     * can specify an optional zero-based range of bytes to read from the
+     * content, which will return a read stream limited the specified range.
+     * Note that the end index of the range is inclusive, as is the case with
+     * Node's streams API, as opposed to array and string operations, for
+     * which the end index is usually exclusive.  Return `null` if not content
+     * exists for the given attachment.  Return an `AttachmentStoreError` if
+     * an error occurred reading from the underlying storage.
+     */
+    readContent(attachmentId: AttachmentId, observation: Observation, range?: {
+        start: number;
+        end?: number;
+    }): Promise<NodeJS.ReadableStream | null | AttachmentStoreError>;
+    readThumbnailContent(minDimension: number, attachmentId: AttachmentId, observation: Observation): Promise<NodeJS.ReadableStream | null | AttachmentStoreError>;
+    /**
+     * Delete the given attachment's content, including thumbnail content.  If
+     * the attachment no longer exists on the given observation, return null upon
+     * success.  If the attachment still exists on the observation, return
+     * {@link AttachmentContentPatchAttrs patch} attributes that reflect the
+     * missing content to {@link EventScopedObservationRepository.patchAttachment update}
+     * the attachment.
+     */
+    deleteContent(attachment: Attachment, observation: Observation): Promise<null | AttachmentPatchAttrs | AttachmentStoreError>;
+}
+export declare class AttachmentStoreError extends Error {
+    readonly errorCode: AttachmentStoreErrorCode;
+    static invalidAttachmentId(attachmentId: AttachmentId, observation: Observation): AttachmentStoreError;
+    static invalidThumbnailDimension(minDimension: number, attachmentId: AttachmentId, observation: Observation): AttachmentStoreError;
+    constructor(errorCode: AttachmentStoreErrorCode, message?: string);
+}
+export declare enum AttachmentStoreErrorCode {
+    /**
+     * The given attachment ID was not found in the given observation's
+     * attachment list.
+     */
+    InvalidAttachmentId = "AttachmentStoreError.InvalidAttachmentId",
+    InvalidThumbnailDimension = "AttachmentStoreError.InvalidThumbnailDimension",
+    /**
+     * The content for the given attachment ID was not found in the attachment
+     * store.
+     */
+    ContentNotFound = "AttachmentStoreError.ContentNotFound",
+    /**
+     * The underlying storage system, e.g. file system, raised an error during
+     * some I/O operation.
+     */
+    StorageError = "AttachmentStoreError.StorageError"
+}
+//# sourceMappingURL=entities.observations.d.ts.map

package/lib/entities/observations/entities.observations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.observations.d.ts","sourceRoot":"","sources":["../../../src/entities/observations/entities.observations.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,yBAAyB,CAAA;AAChD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAA;AACjD,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAA;AAClF,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAC9E,OAAO,EAAE,IAAI,EAAE,SAAS,EAAiB,MAAM,EAAE,MAAM,iCAAiC,CAAA;AAExF,OAAO,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAA;AAGtD,MAAM,MAAM,aAAa,GAAG,MAAM,CAAA;AAElC,MAAM,WAAW,gBAAiB,SAAQ,OAAO,CAAC,QAAQ,EAAE,4BAA4B,CAAC;IACvF,EAAE,EAAE,aAAa,CAAA;IACjB,OAAO,EAAE,WAAW,CAAA;IACpB,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,IAAI,CAAA;IACf,YAAY,EAAE,IAAI,CAAA;IAClB,WAAW,EAAE,SAAS,UAAU,EAAE,CAAA;IAClC,SAAS,CAAC,EAAE,QAAQ,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAA;IAC1D;;;OAGG;IACH,eAAe,EAAE,SAAS,MAAM,EAAE,CAAA;IAClC;;;;;OAKG;IACH,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAA;CACpC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,SAAS,EAAE,IAAI,CAAA;IACf,KAAK,EAAE,SAAS,EAAE,CAAA;CACnB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,IAAI,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,GAAG,eAAe,CAAA;IAC5B,IAAI,EAAE,QAAQ,GAAG,UAAU,CAAA;IAC3B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,CAAA;AAEhC;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,EAAE,EAAE,WAAW,CAAA;IACf,MAAM,EAAE,MAAM,CAAA;IACd,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAA;CACxC;AAED,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,QAAQ,GAAG,IAAI,CAAA;AAC/E,MAAM,MAAM,cAAc,GAAG,kBAAkB,GAAG,kBAAkB,EAAE,GAAG,IAAI,CAAA;AAE7E,MAAM,MAAM,YAAY,GAAG,MAAM,CAAA;AACjC;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IACzB;;;OAGG;IACH,EAAE,EAAE,YAAY,CAAA;IAChB,iBAAiB,EAAE,WAAW,CAAA;IAC9B,SAAS,EAAE,MAAM,CAAA;IACjB;;;OAGG;IACH,YAAY,CAAC,EAAE,IAAI,CAAA;IACnB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;;;;;;;;;;;;;OAcG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB;;;;;;;;;;OAUG;IACH,QAAQ,EAAE,OAAO,CAAA;IACjB,UAAU,EAAE,SAAS,EAAE,CAAA;CACxB;AAED,MAAM,WAAW,SAAS;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IACvB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,CAiB7E;AAED,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,UAAU,GAAG,UAAU,CAehE;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS,CAU7D;AAED,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,gBAAgB,GAAG,gBAAgB,CAMlF;AAED,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,wBAAwB,GAAG,wBAAwB,CAM/F;AAED;;;;;;;GAOG;AACH,qBAAa,WAAY,YAAW,QAAQ,CAAC,gBAAgB,CAAC;;IAE5D;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,GAAG,WAAW;IAI3E;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,gBAAgB,GAAG,WAAW,GAAG,sBAAsB;IAuBpG,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAA;IAC7B;;;OAGG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAA;IACxB,QAAQ,CAAC,YAAY,EAAE,IAAI,CAAA;IAC3B,QAAQ,CAAC,SAAS,CAAC,EAAE,QAAQ,CAAC,wBAAwB,CAAC,GAAG,SAAS,CAAA;IACnE,QAAQ,CAAC,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAA;IAC5C,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAA;IAC3C,QAAQ,CAAC,IAAI,aAAY;IACzB,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,GAAG,SAAS,CAAA;IAChC,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAA;IACrC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,4BAA4B,CAAC,CAAA;IAC3D,QAAQ,CAAC,WAAW,EAAE,SAAS,UAAU,EAAE,CAAA;IAC3C,QAAQ,CAAC,aAAa,EAAE,SAAS,6BAA6B,EAAE,CAAA;gBAEpD,GAAG,IAAI,EAAE,OAAO,EAAE;IAiC9B,IAAI,UAAU,IAAI,2BAA2B,CAE5C;IAED;;OAEG;IACH,IAAI,SAAS,IAAI,IAAI,CAEpB;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,SAAS,EAAE,CAE7B;IAED,cAAc,CAAC,EAAE,EAAE,WAAW,GAAG,SAAS,GAAG,IAAI;IAIjD,aAAa,CAAC,EAAE,EAAE,YAAY,GAAG,UAAU,GAAG,IAAI;IAIlD,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,GAAG,UAAU,EAAE;CAG/E;AAED,oBAAY,0BAA0B;IACpC,kBAAkB,mCAAmC;CACtD;AAED;;;;;GAKG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,QAAQ,CAAC,IAAI,EAAE,0BAA0B,CAAA;CAC1C,GAAG,CACA;IACA,IAAI,EAAE,0BAA0B,CAAC,kBAAkB,CAAA;IACnD,QAAQ,CAAC,kBAAkB,EAAE,SAAS,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAA;CAC7D,CACF,CAAA;AAOD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,6BAA6B,IAAI,OAAO,GAAG;IACxF;;;;;;;;OAQG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,6BAA6B,GAAG,OAAO,CAAC,6BAA6B,EAAE;IAAE,IAAI,EAAE,0BAA0B,CAAC,kBAAkB,CAAA;CAAE,CAAC,CAAA;AAE3I,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAA;IAC3B,QAAQ,CAAC,eAAe,EAAE;QAAE,QAAQ,EAAE,IAAI,IAAI,gCAAgC,CAAC,CAAC,EAAE,MAAM;KAAE,CAAA;IAC1F,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAE,MAAM,EAAE,cAAc,CAAE,EAAE,CAAA;IAC/D,QAAQ,CAAC,eAAe,EAAE,SAAS,CAAE,MAAM,EAAE,wBAAwB,CAAE,EAAE,CAAA;IACzE;;;;OAIG;IACH,QAAQ,CAAC,gBAAgB,EAAE,SAAS,CAAE,MAAM,EAAE,yBAAyB,CAAE,EAAE,CAAA;IAC3E,QAAQ,CAAC,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAA;CACzD;AAED,wBAAgB,mBAAmB,CAAC,gBAAgB,EAAE,gBAAgB,EAAE,SAAS,EAAE,SAAS,GAAG,2BAA2B,CAOzH;AAED,MAAM,MAAM,gCAAgC,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,OAAO,CAAA;AAEtG,eAAO,MAAM,kBAAkB,eAA2C,CAAA;AAC1E,eAAO,MAAM,kBAAkB,eAA2C,CAAA;AAE1E,qBAAa,mBAAmB;IAW5B,QAAQ,CAAC,UAAU,EAAE,OAAO,kBAAkB,GAAG,OAAO,kBAAkB;IAC1E,QAAQ,CAAC,eAAe,EAAE,MAAM;IAVlC,MAAM,CAAC,iBAAiB,CAAC,SAAS,EAAE,cAAc,GAAG,mBAAmB;IAIxE,MAAM,CAAC,kBAAkB,CAAC,SAAS,EAAE,cAAc,GAAG,mBAAmB;IAIzE,OAAO;IAIP,OAAO,IAAI,MAAM;CAMlB;AACD,qBAAa,cAAc;IAWvB,QAAQ,CAAC,UAAU,EAAE,OAAO,kBAAkB,GAAG,OAAO,kBAAkB;IAC1E,QAAQ,CAAC,eAAe,EAAE,MAAM;IAChC,QAAQ,CAAC,MAAM,EAAE,MAAM;IACvB,QAAQ,CAAC,QAAQ,EAAE,MAAM;IAZ3B,MAAM,CAAC,oBAAoB,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc;IAIvD,MAAM,CAAC,qBAAqB,CAAC,IAAI,EAAE,IAAI,GAAG,cAAc;IAIxD,OAAO;IAOP,OAAO,IAAI,MAAM;CAMlB;AAED,qBAAa,wBAAwB;;IAWvB,QAAQ,CAAC,WAAW,EAAE,WAAW;IAAE,QAAQ,CAAC,iBAAiB,EAAE,MAAM;IANjF;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAO;gBAET,WAAW,EAAE,WAAW,EAAW,iBAAiB,EAAE,MAAM;IAEjF,kBAAkB,CAAC,CAAC,EAAE,8BAA8B,GAAG,IAAI;IAK3D,aAAa,CAAC,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAKhD,IAAI,gBAAgB,IAAI,GAAG,CAAC,8BAA8B,CAAC,CAE1D;IAED;;OAEG;IACH,IAAI,WAAW,IAAI,GAAG,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAEvD;CACF;AAED,oBAAY,8BAA8B;IACxC,OAAO,2CAA2C;IAClD,WAAW,+CAA+C;CAC3D;AAED,MAAM,MAAM,6BAA6B,GAAG;KACzC,IAAI,IAAI,MAAM,IAAI,CAAC,wBAAwB,EAAE,OAAO,CAAC,GAAG,wBAAwB,CAAC,IAAI,CAAC;CACxF,CAAA;AAED,oBAAY,kBAAkB;IAC5B,KAAK,UAAU;IACf,GAAG,QAAQ;IACX,GAAG,QAAQ;IACX,QAAQ,aAAa;CACtB;AAED,qBAAa,wBAAwB;IAEnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,UAAU,EAAE,kBAAkB,CAAA;IACvC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;gBAEZ,KAAK,EAAE,6BAA6B;IAMhD;;;;OAIG;IACH,IAAI,KAAK,IAAI,MAAM,CAElB;CACF;AAED,oBAAY,+BAA+B;IACzC,QAAQ,6CAA6C;IACrD,YAAY,iDAAiD;IAC7D,WAAW,gDAAgD;CAC5D;AAED,qBAAa,yBAAyB;IAElC,QAAQ,CAAC,MAAM,EAAE,+BAA+B;IAChD,QAAQ,CAAC,OAAO,EAAE,MAAM;gBADf,MAAM,EAAE,+BAA+B,EACvC,OAAO,EAAE,MAAM;CAE3B;AAED,wBAAgB,uBAAuB,CAAC,MAAM,EAAE,2BAA2B,GAAG,MAAM,CA6BnF;AAED,qBAAa,sBAAuB,SAAQ,KAAK;IAOnC,QAAQ,CAAC,MAAM,EAAE,4BAA4B;IALzD,MAAM,CAAC,eAAe,CAAC,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,WAAW,GAAG,SAAS,GAAG,sBAAsB;gBAKjF,MAAM,EAAE,4BAA4B,EAAE,OAAO,EAAE,MAAM;CAG3E;AAED,oBAAY,4BAA4B;IACtC,OAAO,aAAa;CACrB;AAED,wBAAgB,cAAc,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAExG;AAED,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,SAAS,GAAG,MAAM,EAAE,SAAS,EAAE,SAAS,GAAG,WAAW,EAAE,gBAAgB,EAAE,gBAAgB,GAAG,UAAU,EAAE,CAInJ;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,GAAG,WAAW,CAM/F;AAED,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,GAAG,mBAAmB,GAAG,WAAW,GAAG,cAAc,CAAC,CAAA;AAC/G,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AACjE,MAAM,MAAM,2BAA2B,GAAG,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,gBAAgB,GAAG,MAAM,CAAC,CAAC,CAAA;AAC/F,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAAC,IAAI,CAAC,SAAS,EAAE,gBAAgB,GAAG,MAAM,CAAC,CAAC,GAAG,SAAS,CAAA;AAEzG;;;;;;;;;;;;GAYG;AACH,wBAAgB,aAAa,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,EAAE,qBAAqB,GAAG,WAAW,GAAG,kBAAkB,CAgB/L;AAED;;;;;;;;;GASG;AACF,wBAAgB,eAAe,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,KAAK,EAAE,oBAAoB,GAAG,WAAW,GAAG,uBAAuB,CAuBzJ;AAED,wBAAgB,gBAAgB,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,GAAG,WAAW,GAAG,uBAAuB,CAW5H;AAED;;;;;;;;;GASG;AACH,wBAAgB,qCAAqC,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,GAAG,WAAW,GAAG,uBAAuB,CAevK;AAED;;;;GAIG;AACH,wBAAgB,gCAAgC,CAAC,eAAe,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,MAAM,GAAG,SAAS,CAWpH;AAED,qBAAa,kBAAmB,SAAQ,KAAK;IAM/B,QAAQ,CAAC,aAAa,EAAE,yBAAyB;IAJ7D,MAAM,CAAC,oBAAoB,CAAC,UAAU,EAAE,yBAAyB,GAAG,kBAAkB;gBAIjE,aAAa,EAAE,yBAAyB;CAG9D;AAED,qBAAa,uBAAwB,SAAQ,KAAK;IACpC,QAAQ,CAAC,YAAY,EAAE,YAAY;gBAA1B,YAAY,EAAE,YAAY;CAGhD;AAED;;;GAGG;AACH,MAAM,WAAW,gCAAgC;IAC/C,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAA;IAChC,qBAAqB,IAAI,OAAO,CAAC,aAAa,CAAC,CAAA;IAC/C;;;;;;;;OAQG;IACH,IAAI,CAAC,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,WAAW,GAAG,0BAA0B,CAAC,CAAA;IACjF,QAAQ,CAAC,EAAE,EAAE,aAAa,GAAG,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAA;IACxD;;;;;OAKG;IACH,UAAU,IAAI,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAAA;IAC9C,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAA;IACrG;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,eAAe,CAAC,WAAW,EAAE,WAAW,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,oBAAoB,GAAG,OAAO,CAAC,WAAW,GAAG,uBAAuB,GAAG,IAAI,CAAC,CAAA;IAC/J;;;OAGG;IACH,gBAAgB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAA;IACxD,iBAAiB,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAA;CAC3D;AAED,qBAAa,0BAA2B,SAAQ,KAAK;IAEvC,QAAQ,CAAC,IAAI,EAAE,8BAA8B;gBAApC,IAAI,EAAE,8BAA8B,EAAE,OAAO,CAAC,EAAE,MAAM;CAG5E;AAED,oBAAY,8BAA8B;IACxC,oBAAoB,oDAAoD;IACxE,kBAAkB,kDAAkD;CACrE;AAED,MAAM,WAAW,6BAA6B;IAC5C,CAAC,KAAK,EAAE,WAAW,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAAA;CAChE;AAED,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAAA;AAE/C,qBAAa,0BAA0B;IACzB,QAAQ,CAAC,EAAE,EAAE,yBAAyB;gBAA7B,EAAE,EAAE,yBAAyB;CACnD;AAED,qBAAa,uBAAwB,SAAQ,0BAA0B;IAGnE,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC,cAAc;gBAD5C,EAAE,EAAE,yBAAyB,EACpB,YAAY,EAAE,MAAM,CAAC,cAAc;CAI/C;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;;;;;;;OAWG;IACH,mBAAmB,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAA;IACvD;;;;;;;;;;;;;OAaG;IACH,WAAW,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,GAAG,0BAA0B,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,GAAG,2BAA2B,GAAG,oBAAoB,CAAC,CAAA;IAClM;;;;;;;OAOG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,GAAG,yBAAyB,EAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,GAAG,0BAA0B,GAAG,oBAAoB,CAAC,CAAA;IAC/N;;;;;;;;;OASG;IACH,WAAW,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,CAAC,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,GAAG,oBAAoB,CAAC,CAAA;IACxK,oBAAoB,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,MAAM,CAAC,cAAc,GAAG,IAAI,GAAG,oBAAoB,CAAC,CAAA;IAC9J;;;;;;;OAOG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,GAAG,oBAAoB,GAAG,oBAAoB,CAAC,CAAA;CAC7H;AAED,qBAAa,oBAAqB,SAAQ,KAAK;IAUjC,QAAQ,CAAC,SAAS,EAAE,wBAAwB;IARxD,MAAM,CAAC,mBAAmB,CAAC,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,GAAG,oBAAoB;IAItG,MAAM,CAAC,yBAAyB,CAAC,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,GAAG,oBAAoB;gBAI7G,SAAS,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,MAAM;CAI3E;AAED,oBAAY,wBAAwB;IAClC;;;OAGG;IACH,mBAAmB,6CAA6C;IAChE,yBAAyB,mDAAmD;IAC5E;;;OAGG;IACH,eAAe,yCAAyC;IACxD;;;OAGG;IACH,YAAY,sCAAsC;CACnD"}

package/lib/entities/observations/entities.observations.fields.attachment.d.ts

@@ -0,0 +1,5 @@
+import { FormField } from '../events/entities.events.forms';
+import { FormEntryId, ObservationAttrs } from './entities.observations';
+import { SimpleFieldValidationResult } from './entities.observations.fields';
+export declare const AttachmentFieldValidation: <Failed, Succeeded>(field: FormField, formEntryId: FormEntryId, observationAttrs: ObservationAttrs, result: SimpleFieldValidationResult<Failed, Succeeded>) => Failed | Succeeded;
+//# sourceMappingURL=entities.observations.fields.attachment.d.ts.map

package/lib/entities/observations/entities.observations.fields.attachment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.observations.fields.attachment.d.ts","sourceRoot":"","sources":["../../../src/entities/observations/entities.observations.fields.attachment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAiC,SAAS,EAAE,MAAM,iCAAiC,CAAA;AAC1F,OAAO,EAA2C,WAAW,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAA;AAChH,OAAO,EAAE,2BAA2B,EAAE,MAAM,gCAAgC,CAAA;AAG5E,eAAO,MAAM,yBAAyB,6BAAgE,SAAS,eAAe,WAAW,oBAAoB,gBAAgB,+EAiB5K,CAAA"}

package/lib/entities/observations/entities.observations.fields.attachment.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AttachmentFieldValidation = void 0;
+const entities_events_forms_1 = require("../events/entities.events.forms");
+const entities_observations_1 = require("./entities.observations");
+const AttachmentFieldValidation = function AttachmentFieldValidation(field, formEntryId, observationAttrs, result) {
+    var _a;
+    const attachments = (0, entities_observations_1.attachmentsForField)(field, formEntryId, observationAttrs);
+    if (typeof field.min === 'number' && attachments.length < field.min) {
+        return result.failedBecauseTheEntry(`requires at least ${field.min} ${field.min > 1 ? 'attachments' : 'attachment'}`, entities_observations_1.FieldConstraintKey.Min);
+    }
+    if (typeof field.max === 'number' && attachments.length > field.max) {
+        return result.failedBecauseTheEntry(`allows at most ${field.max} ${field.max > 1 ? 'attachments' : 'attachment'}`, entities_observations_1.FieldConstraintKey.Max);
+    }
+    // TODO: ensure new attachment content types
+    // TODO: attachmentTypeIsValidForField() should probably just move here
+    // TODO: invalidate if form entry has a value?
+    if (attachments.some(x => !(0, entities_events_forms_1.attachmentTypeIsValidForField)(field, x.contentType))) {
+        return result.failedBecauseTheEntry(`allows only content of type ${(_a = field.allowedAttachmentTypes) === null || _a === void 0 ? void 0 : _a.join(', ')}`);
+    }
+    return result.succeeded();
+};
+exports.AttachmentFieldValidation = AttachmentFieldValidation;
+//# sourceMappingURL=entities.observations.fields.attachment.js.map

package/lib/entities/observations/entities.observations.fields.attachment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.observations.fields.attachment.js","sourceRoot":"","sources":["../../../src/entities/observations/entities.observations.fields.attachment.ts"],"names":[],"mappings":";;;AAAA,2EAA0F;AAC1F,mEAAgH;AAIzG,MAAM,yBAAyB,GAAG,SAAS,yBAAyB,CAAoB,KAAgB,EAAE,WAAwB,EAAE,gBAAkC,EAAE,MAAsD;;IACnO,MAAM,WAAW,GAAG,IAAA,2CAAmB,EAAC,KAAK,EAAE,WAAW,EAAE,gBAAgB,CAAC,CAAA;IAC7E,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE;QACnE,OAAO,MAAM,CAAC,qBAAqB,CAAC,qBAAqB,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,0CAAkB,CAAC,GAAG,CAAC,CAAA;KAC9I;IACD,IAAI,OAAO,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,WAAW,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,EAAE;QACnE,OAAO,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,KAAK,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,YAAY,EAAE,EAAE,0CAAkB,CAAC,GAAG,CAAC,CAAA;KAC3I;IAED,4CAA4C;IAC5C,uEAAuE;IACvE,8CAA8C;IAE9C,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAA,qDAA6B,EAAC,KAAK,EAAE,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE;QAC/E,OAAO,MAAM,CAAC,qBAAqB,CAAC,+BAA+B,MAAA,KAAK,CAAC,sBAAsB,0CAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;KAC/G;IACD,OAAO,MAAM,CAAC,SAAS,EAAE,CAAA;AAC3B,CAAC,CAAA;AAjBY,QAAA,yBAAyB,6BAiBrC"}

package/lib/entities/observations/entities.observations.fields.checkbox.d.ts

@@ -0,0 +1,3 @@
+import { SimpleFieldValidation } from './entities.observations.fields';
+export declare const CheckboxFieldValidation: SimpleFieldValidation;
+//# sourceMappingURL=entities.observations.fields.checkbox.d.ts.map

package/lib/entities/observations/entities.observations.fields.checkbox.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entities.observations.fields.checkbox.d.ts","sourceRoot":"","sources":["../../../src/entities/observations/entities.observations.fields.checkbox.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,gCAAgC,CAAA;AAMtE,eAAO,MAAM,uBAAuB,EAAE,qBAQrC,CAAA"}