Catalogues

Purpose

The Catalogues collection stores configuration and metadata for virtual catalogues in ARShades Ecosystem. Each document represents a catalogue with its visual styling, app configuration, content settings, and access permissions. This collection is central to managing how catalogues are displayed and accessed across different platforms (web and mobile).

Document schema

{
  "allowedDomain": "string",
  "appIdIos": "string",
  "appPackage": "string",
  "appPackageIos": "string",
  "catalogues_page_style": {
    "actionButtonColor": "string",
    "backgroundColor": "string",
    "bannerBackgroundColor": "string",
    "bannerCornerBottomLeft": "number",
    "bannerCornerBottomRight": "number",
    "bannerCornerTopLeft": "number",
    "bannerCornerTopRight": "number",
    "buttonCornerBottomLeft": "number",
    "buttonCornerBottomRight": "number",
    "buttonCornerTopLeft": "number",
    "buttonCornerTopRight": "number",
    "cardCornerBottomLeft": "number",
    "cardCornerBottomRight": "number",
    "cardCornerTopLeft": "number",
    "cardCornerTopRight": "number",
    "catalogueLogo": "string",
    "catalogueLogoPosition": "string",
    "coverColor": "string",
    "coverHeightDesktop": "number",
    "coverHeightMobile": "number",
    "coverImg": "string",
    "coverImgMobile": "string",
    "coverTemplate": "string",
    "heightMobileOption": "string",
    "heightOption": "string",
    "isLogoVisible": "boolean",
    "isTitleVisible": "boolean",
    "primaryColor": "string",
    "secondaryColor": "string"
  },
  "codePath": "string",
  "coverImage": "string",
  "dataConsumption": "string",
  "descriptionDe": "string",
  "descriptionEn": "string",
  "descriptionEs": "string",
  "descriptionFr": "string",
  "descriptionIt": "string",
  "featuredImage": "string",
  "glassesNumber": "number",
  "hdrEnvironment": "string",
  "isExpired": "boolean",
  "isIframeOnlyAcces": "boolean",
  "isLoginRequired": "boolean",
  "isPublic": "boolean",
  "isSegmentationOn": "boolean",
  "layout": "string",
  "lightIntensityExponent": "number",
  "list_keywords": [],
  "list_service": ["string"],
  "loginPassword": "string",
  "metaDescription": "string",
  "nameCatalog": "string",
  "noBackgroundLogo": "string",
  "showSingleDotList": "boolean",
  "skin": "string",
  "status": "string",
  "storageConsumption": "number",
  "storage_consumption": {
    "consumption": "number",
    "modelsNumber": "number"
  },
  "takePicTemplate": "string",
  "titleSeo": "string",
  "urlLogo": "string",
  "webDomain": "string",
  "webUrl": "string"
}

Indexes

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

Query examples

// Fetch the Catalogue Reference Doc from Firebase
const catalogRefDoc = doc(db, "Catalogues", docCatalog);

// Get the Document Snapshot from the Catalogue Reference Doc
const catalogRefSnap = await getDoc(catalogRefDoc);