@webiny/api-headless-cms-ddb-es/definitions/types.d.ts

DynamoDB and Elasticsearch storage operations plugin for Headless CMS API.

import type { IEntity, IStandardEntityAttributes } from "@webiny/db-dynamodb";
import type { GenericRecord } from "@webiny/api/types.js";
import type { CmsEntryStatus, CmsGroup, CmsIdentity, ICmsEntryLive, ICmsEntryLocation, ICmsEntrySystem, StorageCmsModel } from "@webiny/api-headless-cms/types/index.js";
export interface IEntryEntityAttributesData {
    tenant: string;
    entryId: string;
    id: string;
    modelId: string;
    /**
     * Revision-level meta fields. 👇
     */
    revisionCreatedOn: string;
    revisionModifiedOn: string | null;
    revisionSavedOn: string;
    revisionDeletedOn: string | null;
    revisionRestoredOn: string | null;
    revisionFirstPublishedOn: string | null;
    revisionLastPublishedOn: string | null;
    revisionCreatedBy: CmsIdentity;
    revisionModifiedBy: CmsIdentity | null;
    revisionSavedBy: CmsIdentity;
    revisionDeletedBy: CmsIdentity | null;
    revisionRestoredBy: CmsIdentity | null;
    revisionFirstPublishedBy: CmsIdentity | null;
    revisionLastPublishedBy: CmsIdentity | null;
    /**
     * Entry-level meta fields. 👇
     */
    createdOn: string;
    modifiedOn: string | null;
    savedOn: string;
    deletedOn: string | null;
    restoredOn: string | null;
    firstPublishedOn: string | null;
    lastPublishedOn: string | null;
    createdBy: CmsIdentity;
    modifiedBy: CmsIdentity | null;
    savedBy: CmsIdentity;
    deletedBy: CmsIdentity | null;
    restoredBy: CmsIdentity | null;
    firstPublishedBy: CmsIdentity | null;
    lastPublishedBy: CmsIdentity | null;
    /**
     * The rest. 👇
     */
    version: number;
    locked: boolean;
    status: CmsEntryStatus;
    location?: ICmsEntryLocation;
    wbyDeleted?: boolean | null;
    binOriginalFolderId?: string;
    values: GenericRecord;
    meta?: GenericRecord;
    system?: ICmsEntrySystem;
    live: ICmsEntryLive | null;
}
export type IEntryEntityAttributes = IStandardEntityAttributes<IEntryEntityAttributesData>;
export type IModelEntity = IEntity<IStandardEntityAttributes<StorageCmsModel>>;
export type IGroupEntity = IEntity<IStandardEntityAttributes<CmsGroup>>;
export type IEntryEntity = IEntity<IEntryEntityAttributes>;