webiny-api-cms-catalog

# API — Headless CMS Entry, model, and group event handlers and use cases. ## How to Use 1. Find the abstraction you need below 2. You MUST read the source file to get the exact interface and types! 3. Import: `import { Name } from "<importPath>";` 4. See `webiny-use-case-pattern` or `webiny-event-handler-pattern` skills for implementation patterns ## Abstractions --- **Name:** `CmsEntry` **Kind:** type **Import:** `import type { CmsEntry } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/types/types.ts` **Description:** A content entry definition for and from the database. --- **Name:** `CmsEntryOpenSearchBodyModifier` **Import:** `import { CmsEntryOpenSearchBodyModifier } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchBodyModifier/index.ts` --- **Name:** `CmsEntryOpenSearchFieldIndex` **Import:** `import { CmsEntryOpenSearchFieldIndex } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFieldIndex/index.ts` --- **Name:** `CmsEntryOpenSearchFieldIndexRegistry` **Import:** `import { CmsEntryOpenSearchFieldIndexRegistry } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFieldIndex/index.ts` --- **Name:** `CmsEntryOpenSearchFilter` **Import:** `import { CmsEntryOpenSearchFilter } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFilter/index.ts` --- **Name:** `CmsEntryOpenSearchFilterRegistry` **Import:** `import { CmsEntryOpenSearchFilterRegistry } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFilter/index.ts` --- **Name:** `CmsEntryOpenSearchFullTextSearch` **Import:** `import { CmsEntryOpenSearchFullTextSearch } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchFullTextSearch/index.ts` --- **Name:** `CmsEntryOpenSearchQueryModifier` **Import:** `import { CmsEntryOpenSearchQueryModifier } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchQueryModifier/index.ts` --- **Name:** `CmsEntryOpenSearchSortModifier` **Import:** `import { CmsEntryOpenSearchSortModifier } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchSortModifier/index.ts` --- **Name:** `CmsEntryOpenSearchValueSearch` **Import:** `import { CmsEntryOpenSearchValueSearch } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValueSearch/index.ts` --- **Name:** `CmsEntryOpenSearchValueSearchRegistry` **Import:** `import { CmsEntryOpenSearchValueSearchRegistry } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValueSearch/index.ts` --- **Name:** `CmsEntryOpenSearchValuesModifier` **Import:** `import { CmsEntryOpenSearchValuesModifier } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsEntryOpenSearchValuesModifier/index.ts` --- **Name:** `CmsEntryValues` **Kind:** type **Import:** `import type { CmsEntryValues } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/types/types.ts` **Description:** A content entry values definition for and from the database. --- **Name:** `CmsGraphQLSchemaSorter` **Import:** `import { CmsGraphQLSchemaSorter } from "webiny/api/cms/graphql"` **Source:** `@webiny/api-headless-cms/features/graphql/index.ts` --- **Name:** `CmsGroup` **Kind:** type **Import:** `import type { CmsGroup } from "webiny/api/cms/group"` **Source:** `@webiny/api-headless-cms/types/modelGroup.ts` **Description:** A representation of content model group in the database. --- **Name:** `CmsModel` **Kind:** type **Import:** `import type { CmsModel } from "webiny/api/cms/model"` **Source:** `@webiny/api-headless-cms/types/model.ts` **Description:** Base CMS Model. Should not be exported and used outside of this package. --- **Name:** `CmsModelField` **Kind:** type **Import:** `import type { CmsModelField } from "webiny/api/cms/model"` **Source:** `@webiny/api-headless-cms/types/modelField.ts` **Description:** A definition for content model field. This type exists on the app side as well. --- **Name:** `CmsModelFieldPatternValidator` **Import:** `import { CmsModelFieldPatternValidator } from "webiny/api/cms/validation"` **Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldPatternValidator.ts` --- **Name:** `CmsModelFieldPatternValidatorRegistry` **Import:** `import { CmsModelFieldPatternValidatorRegistry } from "webiny/api/cms/validation"` **Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldPatternValidatorRegistry.ts` --- **Name:** `CmsModelFieldToGraphQL` **Import:** `import { CmsModelFieldToGraphQL } from "webiny/api/cms/graphql"` **Source:** `@webiny/api-headless-cms/features/graphql/index.ts` --- **Name:** `CmsModelFieldToGraphQLRegistry` **Import:** `import { CmsModelFieldToGraphQLRegistry } from "webiny/api/cms/graphql"` **Source:** `@webiny/api-headless-cms/features/graphql/index.ts` --- **Name:** `CmsModelFieldValidator` **Import:** `import { CmsModelFieldValidator } from "webiny/api/cms/validation"` **Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldValidator.ts` --- **Name:** `CmsModelFieldValidatorRegistry` **Import:** `import { CmsModelFieldValidatorRegistry } from "webiny/api/cms/validation"` **Source:** `@webiny/api-headless-cms/features/validation/abstractions/CmsModelFieldValidatorRegistry.ts` --- **Name:** `CmsModelGroup` **Kind:** type **Import:** `import type { CmsModelGroup } from "webiny/api/cms/group"` **Source:** `@webiny/api-headless-cms/types/modelGroup.ts` --- **Name:** `CmsModelOpenSearchIndex` **Import:** `import { CmsModelOpenSearchIndex } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsModelOpenSearchIndex/index.ts` --- **Name:** `CmsModelOpenSearchIndexProvider` **Import:** `import { CmsModelOpenSearchIndexProvider } from "webiny/api/cms/opensearch"` **Source:** `@webiny/api-headless-cms-ddb-es/features/CmsModelOpenSearchIndex/index.ts` --- **Name:** `CmsSortMapper` **Import:** `import { CmsSortMapper } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/sortMapper/abstractions.ts` **Description:** Map CMS sort parameters to storage queries. --- **Name:** `CmsWhereMapper` **Import:** `import { CmsWhereMapper } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/whereMapper/abstractions.ts` **Description:** Map CMS filter conditions to storage queries. --- **Name:** `ContentEntryTraverserProvider` **Import:** `import { ContentEntryTraverserProvider } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/ContentEntryTraverser/index.ts` **Description:** Traverse the given content entry data using the model's AST. --- **Name:** `CreateEntryDataFactory` **Import:** `import { CreateEntryDataFactory } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/entryDataFactories/CreateEntryDataFactory/abstractions.ts` --- **Name:** `CreateEntryRevisionFromDataFactory` **Import:** `import { CreateEntryRevisionFromDataFactory } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/entryDataFactories/CreateEntryRevisionFromDataFactory/abstractions.ts` --- **Name:** `CreateEntryRevisionFromUseCase` **Import:** `import { CreateEntryRevisionFromUseCase } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/CreateEntryRevisionFrom/abstractions.ts` **Description:** Create a new entry revision from an existing one. --- **Name:** `CreateEntryUseCase` **Import:** `import { CreateEntryUseCase } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/CreateEntry/abstractions.ts` **Description:** Create a new content entry. --- **Name:** `CreateGroupUseCase` **Import:** `import { CreateGroupUseCase } from "webiny/api/cms/group"` **Source:** `@webiny/api-headless-cms/features/contentModelGroup/CreateGroup/abstractions.ts` **Description:** Create a new content model group. --- **Name:** `CreateModelFromUseCase` **Import:** `import { CreateModelFromUseCase } from "webiny/api/cms/model"` **Source:** `@webiny/api-headless-cms/features/contentModel/CreateModelFrom/abstractions.ts` **Description:** Create a content model by cloning an existing one. --- **Name:** `CreateModelUseCase` **Import:** `import { CreateModelUseCase } from "webiny/api/cms/model"` **Source:** `@webiny/api-headless-cms/features/contentModel/CreateModel/abstractions.ts` **Description:** Create a new content model. --- **Name:** `CreatePublishEntryDataFactory` **Import:** `import { CreatePublishEntryDataFactory } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/entryDataFactories/CreatePublishEntryDataFactory/abstractions.ts` --- **Name:** `CreateRepublishEntryDataFactory` **Import:** `import { CreateRepublishEntryDataFactory } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/entryDataFactories/CreateRepublishEntryDataFactory/abstractions.ts` --- **Name:** `CreateUnpublishEntryDataFactory` **Import:** `import { CreateUnpublishEntryDataFactory } from "webiny/api/cms/entry"` **Source:** `@webiny/api-headless-cms/features/contentEntry/entryDataFactories/CreateUnpublishEntryDataFactory/abstractions.ts` --- **Name:** `DataFieldBuilder` **Import:** `import { DataFieldBuilder } from "webiny/api/cms/model"`