@dolittle/sdk.projections/Store/IProjectionStore.ts

Dolittle is a decentralized, distributed, event-driven microservice platform built to harness the power of events.

// Copyright (c) Dolittle. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.

import { Guid } from '@dolittle/rudiments';
import { Constructor } from '@dolittle/types';

import { ScopeId } from '@dolittle/sdk.events';
import { Cancellation } from '@dolittle/sdk.resilience';

import { Key } from '../Key';
import { ProjectionId } from '../ProjectionId';
import { CurrentState } from './CurrentState';
import { IProjectionOf } from './IProjectionOf';

/**
 * Defines the API surface for getting projections.
 */
export abstract class IProjectionStore {

    /**
     * Gets the {@link IProjectionOf} the projection read model type.
     * @param {Constructor<TProjection>} type - The type of the projection.
     * @returns {IProjectionOf<TProjection>} The {@link IProjectionOf} for the {@link TProjection} projection read model type.
     * @template TProjection The type of the projection read model.
     */
    abstract of<TProjection>(type: Constructor<TProjection>): IProjectionOf<TProjection>;
    /**
     * Gets the {@link IProjectionOf} the projection read model type.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @returns {IProjectionOf<TReadModel>} The {@link IProjectionOf} for the {@link TReadModel} projection read model type.
     * @template TReadModel The type of the projection read model.
     */
    abstract of<TReadModel>(type: Constructor<TReadModel>, projection: ProjectionId | Guid | string): IProjectionOf<TReadModel>;
    /**
     * Gets the {@link IProjectionOf} the projection read model type.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @returns {IProjectionOf<TReadModel>} The {@link IProjectionOf} for the {@link TReadModel} projection read model type.
     * @template TReadModel The type of the projection read model.
     */
    abstract of<TReadModel>(type: Constructor<TReadModel>, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string): IProjectionOf<TReadModel>;

    /**
     * Gets a projection read model by key for a projection associated with a type.
     * @param {Constructor<TProjection>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TProjection>} A {@link Promise} that when resolved returns the read model of the projection.
     * @template TProjection The type of the projection.
     */
    abstract get<TProjection>(type: Constructor<TProjection>, key: Key | any, cancellation?: Cancellation): Promise<TProjection>;

    /**
     * Gets a projection read model by key for a projection specified by projection identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TReadModel>} A {@link Promise} that when resolved returns the read model of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract get<TReadModel>(type: Constructor<TReadModel>, key: Key | any, projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<TReadModel>;

    /**
     * Gets a projection read model by key for a projection specified by projection and scope identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TReadModel>} A {@link Promise} that when resolved returns the read model of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract get<TReadModel>(type: Constructor<TReadModel>, key: Key | any, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<TReadModel>;

    /**
     * Gets a projection read model by key for a projection specified by projection identifier.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<any>} A {@link Promise} that when resolved returns the read model of the projection.
     */
    abstract get(key: Key | any, projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<any>;

    /**
     * Gets a projection read model by key for a projection specified by projection and scope identifier.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<any>} A {@link Promise} that when resolved returns the read model of the projection.
     */
    abstract get(key: Key | any, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<any>;

    /**
     * Gets all projection read models for a projection associated with a type.
     * @template T
     * @param {Constructor<T>} type - The type of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TProjection[]>} A {@link Promise} that when resolved returns the all the read models of the projection.
     * @template TProjection The type of the projection.
     */
    abstract getAll<TProjection>(type: Constructor<TProjection>, cancellation?: Cancellation): Promise<TProjection[]>;

    /**
     * Gets all projection read models for a projection specified by projection identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TReadModel[]>} A {@link Promise} that when resolved returns the all the read models of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract getAll<TReadModel>(type: Constructor<TReadModel>, projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<TReadModel[]>;

    /**
     * Gets all projection read models for a projection specified by projection and scope identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<TReadModel[]>} A {@link Promise} that when resolved returns the all the read models of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract getAll<TReadModel>(type: Constructor<TReadModel>, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<TReadModel[]>;

    /**
     * Gets all projection read models for a projection specified by projection identifier.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<any[]>} A {@link Promise} that when resolved returns the all the read models of the projection.
     */
    abstract getAll(projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<any[]>;

    /**
     * Gets all projection read models for a projection specified by projection and scope identifier.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<any[]>} A {@link Promise} that when resolved returns the all the read models of the projection.
     */
    abstract getAll(projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<any[]>;

    /**
     * Gets a projection state by key for a projection associated with a type.
     * @param {Constructor<TProjection>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<CurrentState<TProjection>>} A {@link Promise} that when resolved returns the current state of the projection.
     * @template TProjection The type of the projection.
     */
    abstract getState<TProjection>(type: Constructor<TProjection>, key: Key | any, cancellation?: Cancellation): Promise<CurrentState<TProjection>>;

    /**
     * Gets a projection state by key for a projection specified by projection identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<CurrentState<TReadModel>>} A {@link Promise} that when resolved returns the current state of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract getState<TReadModel>(type: Constructor<TReadModel>, key: Key | any, projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<CurrentState<TReadModel>>;

    /**
     * Gets a projection state by key for a projection specified by projection and scope identifier.
     * @param {Constructor<TReadModel>} type - The type of the projection.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scope - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<CurrentState<TReadModel>>} A {@link Promise} that when resolved returns the current state of the projection.
     * @template TReadModel The type of the projection.
     */
    abstract getState<TReadModel>(type: Constructor<TReadModel>, key: Key | any, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<CurrentState<TReadModel>>;

    /**
     * Gets a projection state by key for a projection specified by projection identifier.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<CurrentState<any>>} A {@link Promise} that when resolved returns the current state of the projection.
     */
    abstract getState(key: Key | any, projection: ProjectionId | Guid | string, cancellation?: Cancellation): Promise<CurrentState<any>>;

    /**
     * Gets a projection state by key for a projection specified by projection and scope identifier.
     * @param {Key | any} key - The key of the projection.
     * @param {ProjectionId | Guid | string} projection - The id of the projection.
     * @param {ScopeId | Guid | string} scpåe - The scope the projection in.
     * @param {Cancellation} [cancellation] - The cancellation token.
     * @returns {Promise<CurrentState<any>>} A {@link Promise} that when resolved returns the current state of the projection.
     */
    abstract getState(key: Key | any, projection: ProjectionId | Guid | string, scope: ScopeId | Guid | string, cancellation?: Cancellation): Promise<CurrentState<any>>;
}