sesamy-cli/sesamy.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/foomo/sesamy-cli/pkg/config/github.com.foomo.sesamy-cli.pkg.config.-config",
  "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Config",
  "$defs": {
    "[]*contemplate.PackageConfig": {
      "items": {
        "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.PackageConfig"
      },
      "type": "array"
    },
    "[]string": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "github.com.foomo.gocontemplate.pkg.contemplate.Config": {
      "properties": {
        "packages": {
          "$ref": "#/$defs/[]*contemplate.PackageConfig"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.gocontemplate.pkg.contemplate.PackageConfig": {
      "properties": {
        "path": {
          "type": "string"
        },
        "types": {
          "$ref": "#/$defs/[]string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Config": {
      "properties": {
        "version": {
          "type": "string",
          "description": "Config version"
        },
        "redactVisitorIp": {
          "type": "boolean",
          "description": "Globally redact visitor ip"
        },
        "googleTag": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleTag",
          "description": "Google Tag settings"
        },
        "googleApi": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleAPI",
          "description": "Google API settings"
        },
        "googleTagManager": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleTagManager",
          "description": "Google Tag Manager settings"
        },
        "googleAds": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleAds",
          "description": "Google Ads provider settings"
        },
        "cookiebot": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Cookiebot",
          "description": "CookieBot provider settings"
        },
        "googleAnalytics": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleAnalytics",
          "description": "Google Analytics provider settings"
        },
        "conversionLinker": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.ConversionLinker",
          "description": "Conversion Linker provider settings"
        },
        "facebook": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Facebook",
          "description": "Facebook provider settings"
        },
        "emarsys": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Emarsys",
          "description": "Emarsys provider settings"
        },
        "hotjar": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Hotjar",
          "description": "Hotjar provider settings"
        },
        "tracify": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Tracify",
          "description": "Tracify provider settings"
        },
        "umami": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.Umami",
          "description": "Umami provider settings"
        }
      },
      "additionalProperties": false,
      "type": "object",
      "required": [
        "version"
      ]
    },
    "github.com.foomo.sesamy-cli.pkg.config.ConversionLinker": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Cookiebot": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "templateName": {
          "type": "string"
        },
        "cookiebotId": {
          "type": "string"
        },
        "cdnRegion": {
          "type": "string"
        },
        "urlPassthrough": {
          "type": "boolean"
        },
        "advertiserConsentModeEnabled": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Emarsys": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Enable provider"
        },
        "merchantId": {
          "type": "string",
          "description": "Emarsys merchant id"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent",
          "description": "Google Consent settings"
        },
        "webContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config",
          "description": "Google Tag Manager web container settings"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config",
          "description": "Google Tag Manager server container settings"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Facebook": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "pixelId": {
          "type": "string"
        },
        "apiAccessToken": {
          "type": "string"
        },
        "testEventToken": {
          "type": "string"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleAPI": {
      "properties": {
        "credentials": {
          "type": "string"
        },
        "credentialsFile": {
          "type": "string"
        },
        "requestQuota": {
          "type": "integer"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleAds": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent"
        },
        "conversionId": {
          "type": "string"
        },
        "conversion": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleAdsConversion"
        },
        "remarketing": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleAdsRemarketing"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleAdsConversion": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "conversionLabel": {
          "type": "string"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleAdsRemarketing": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "enableConversionLinker": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleAnalytics": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "googleGTag": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleGTag"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent"
        },
        "webContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleConsent": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "mode": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleGTag": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "priority": {
          "type": "integer"
        },
        "ecommerceItems": {
          "type": "boolean"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleTag": {
      "properties": {
        "tagId": {
          "type": "string",
          "description": "A tag ID is an identifier that you put on your page to load a given Google tag"
        },
        "debugMode": {
          "type": "boolean",
          "description": "Enable debug mode for all user devices"
        },
        "sendPageView": {
          "type": "boolean",
          "description": "Whether a page_view should be sent on initial load"
        },
        "typeScript": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.TypeScript",
          "description": "TypeScript settings"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleTagManager": {
      "properties": {
        "accountId": {
          "type": "string"
        },
        "webContainer": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleTagManagerContainer"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleTagManagerContainer"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.GoogleTagManagerContainer": {
      "properties": {
        "tagId": {
          "type": "string"
        },
        "containerId": {
          "type": "string"
        },
        "workspaceId": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Hotjar": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "siteId": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Tracify": {
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Enable provider"
        },
        "token": {
          "type": "string",
          "description": "Tracify token"
        },
        "customerSiteId": {
          "type": "string",
          "description": "Tracify customer site id"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent",
          "description": "Google Consent settings"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config",
          "description": "Google Tag Manager server container settings"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.TypeScript": {
      "properties": {
        "packages": {
          "$ref": "#/$defs/[]*contemplate.PackageConfig"
        },
        "outputPath": {
          "type": "string"
        }
      },
      "additionalProperties": false,
      "type": "object"
    },
    "github.com.foomo.sesamy-cli.pkg.config.Umami": {
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "domain": {
          "type": "string"
        },
        "websiteId": {
          "type": "string"
        },
        "endpointUrl": {
          "type": "string"
        },
        "googleConsent": {
          "$ref": "#/$defs/github.com.foomo.sesamy-cli.pkg.config.GoogleConsent"
        },
        "serverContainer": {
          "$ref": "#/$defs/github.com.foomo.gocontemplate.pkg.contemplate.Config"
        }
      },
      "additionalProperties": false,
      "type": "object"
    }
  }
}