Space settings

The Space Settings module manages the configuration and visibility settings for spaces within the application. It includes settings for handler visibility, model visibility, and associations with doc

Description

The Space Settings module is designed to handle various settings related to spaces. It allows for the configuration of visibility options for handlers and models, as well as the management of associated documents, media, and components. This module includes entities, DTOs, services, and controllers to facilitate the creation, updating, and retrieval of space settings.

Data Fields

SpaceSettingsEntity

• spaceSettingsIndex: Unique index for the space settings.

• isHandlerVisible: Boolean indicating if the handler is visible.

• isModelVisible: Boolean indicating if the model is visible.

• components: Array of associated components.

• selectedComponent: The selected component.

• documents: Array of associated documents.

• media: Array of associated media.

• space: The associated space.

CreateSpaceSettingsDto

• isHandlerVisible: Optional boolean indicating if the handler is visible.

• spaceIndex: Unique index for the space.

UpdateSpaceSettingsDto

• spaceIndex: Unique index for the space.

• isHandlerVisible: Optional boolean indicating if the handler is visible.

• isModelVisible: Optional boolean indicating if the model is visible.

• isModelListVisible: Optional boolean indicating if the model list is visible.

• selectedComponentIndex: Optional index of the selected component.

• documentIndexes: Optional array of document indexes.

• componentIndexes: Optional array of component indexes.

• mediaIndexes: Optional array of media indexes.

SpaceSettingsDto

• isHandlerVisible: Boolean indicating if the handler is visible.

• spaceIndex: Unique index for the space.

• documentIndexes: Array of document indexes.

• mediaIndexes: Array of media indexes.

• isModelVisible: Boolean indicating if the model is visible.

• componentIndexes: Array of component indexes.

• selectedComponentIndex: Index of the selected component or null.

API Functions

SpaceSettingsService

• getSpaceSettings(spaceIndex: string): Retrieves the space settings for a given space index.

• createSpaceSettings(createSpaceSettingsDto: CreateSpaceSettingsDto): Creates new space settings.

• updateSpaceSettings(updateSpaceSettingsDto: UpdateSpaceSettingsDto): Updates existing space settings.

• updateLists(spaceSettingsEntity: SpaceSettingsEntity, listName: 'documents' | 'media' | 'components', indexes: string[]): Updates the lists of documents, media, or components.

SpaceSettingsController

• getSpaceSettings(spaceIndex: string): Handles GET requests to retrieve space settings.

• createSpaceSettings(createSpaceSettingsDto: CreateSpaceSettingsDto): Handles POST requests to create new space settings.

• updateSpaceSettings(updateSpaceSettingsDto: UpdateSpaceSettingsDto): Handles PATCH requests to update existing space settings.