getCatalogFromSiteModel

Function

Gets new catalog from site model

Catalog migration is performed from legacy catalog in data.catalog if new catalog in data.catalogV2 is not present in site's model. Otherwise, new catalog in data.catalogV2 is returned as is.

getCatalogFromSiteModel(model: IModel) : IHubCatalog

Parameters

Parameter	Type	Default	Notes
model Required	IModel

Returns

IHubCatalog

Property	Type	Notes
schemaVersion	number	Schema Version
collections Optional	IHubCollection[]	Collections within the Catalog
displayConfig Optional	IGalleryDisplayConfig	Optional display configuration to control a catalog's appearance in the UI
emojii Optional	string	Optional Emoji to show in the UI
integrity Optional	{ collections: string scopes: string }	Hashes to verify the integrity of the catalog Only verified when the catalog is loaded into the editor If the hashes do not match, the catalog will not be loaded and the user will simply have the option to reset the catalog
scopes Optional	ICatalogScope	Filter defines the "scopes" of the Catalog, on a per entity type basis
title Optional	string	Title for the Gallery
type Optional	CatalogType

Function defined in common/src/sites/get-catalog-from-site-model.ts:17