Skip to main content
Version: 1.0.0

DraftedCatalogues

Purpose​

The DraftedCatalogues collection defines the structure of draft catalogues before publication.
Its purpose is to store catalog metadata, branding, layout, consumption statistics, and publishing status.

Document schema​

{
"appIdIos": "string",
"appPackage": "string",
"appPackageIos": "string",
"catalogues_page_style": {
"actionButtonColor": "string",
"backgroundColor": "string",
"bannerBackgroundColor": "string",
"bannerCornerBottomLeft": "number",
"bannerCornerBottomRight": "number",
"bannerCornerTopLeft": "number",
"bannerCornerTopRight": "number",
"bannerBackgroundColor": "string",
"buttonCornerBottomLeft": "number",
"buttonCornerBottomRight": "number",
"buttonCornerTopLeft": "number",
"buttonCornerTopRight": "number",
"cardCornerBottomLeft": "number",
"cardCornerBottomRight": "number",
"cardCornerTopLeft": "number",
"cardCornerTopRight": "number",
"catalogueLogo": "string",
"catalogueLogoPosition": "string",
"coverHeightDesktop": "number",
"coverHeightMobile": "number",
"heightMobileOption": "string",
"heightOption": "string",
"isLogoVisible": "boolean",
"isTitleVisible": "boolean",
"primaryColor": "string",
"secondaryColor": "string"
},
"codePath": "string",
"dataConsumption": "string",
"descriptionEn": "string",
"descriptionIt": "string",
"draftCreatedAt": "timestamp",
"hdrEnvironment": "string",
"isDraft": "boolean",
"isExpired": "boolean",
"isIframeOnlyAccess": "boolean",
"isLoginRequired": "boolean",
"isPublic": "boolean",
"isSegmentationOn": "boolean",
"layout": "string",
"list_keywords": ["string"],
"list_service": ["string"],
"metaDescription": "string",
"nameCatalog": "string",
"noBackgroundLogo": "string",
"originalCatalogueId": "string",
"showSingleDotList": "boolean",
"status": "string",
"storage_consumption": {
"consumption": "number",
"modelsNumber": "number"
},
"takePicTemplate": "string",
"titleSeo": "string",
"urlLogo": "string",
"webDomain": "string",
"webUrl": "string"
}

Indexes​

  • originalCatalogueId is a string that refers to the ID of Catalogues collection to - dataConsumptions is a string that refers to the ID of Contatori_Brand collection;
  • list_service is a [] of strings that refer to the IDs of Service_ARShades collection;
  • skin is a string that refers to the ID of ARshades_skins collection;
  • takePicTemplate is a string that refers to the ID of TakeFotoTemplate collection.

Query examples​

// Fetch the Reference Doc from Firebase
const draftedCatalogueRefDoc = doc(db, "DraftedCatalogues", draftedCatalogueId);

// Get the Document Snapshot from the Reference Doc
const draftedCatalogueRefSnap = await getDoc(draftedCatalogueRefDoc);