Manifest reference

The community manifest is a JSON document, conventionally named symorva.config.json. One manifest describes one community: its identity, brand, modules, platforms, deployment and shared-service connections. This page mirrors schema version 1 as implemented in @symorva/sdk 0.1.0.

Fields with a default may be omitted; the validator applies defaults before checking composition rules. Fields without a default are required.

Top levelCopy Anchor Link

communityCopy Anchor Link

Locale tags must match a two- or three-letter lowercase language subtag followed by optional subtags of 2 to 8 letters or digits — en, zh-Hans, pt-BR. EN is rejected.

brandCopy Anchor Link

modulesCopy Anchor Link

Each key is optional. An omitted module takes its defaults: chat and meetings are always enabled; the four optional modules are disabled.

modules.chatCopy Anchor Link

Details: Chat & communities.

modules.meetingsCopy Anchor Link

Details: Meetings & live rooms.

modules.aiStudioCopy Anchor Link

Details: AI & creator studio.

modules.walletCopy Anchor Link

Details: Wallets & assets.

modules.dappsCopy Anchor Link

Details: DApps & ecosystem.

modules.creatorEconomyCopy Anchor Link

Details: Creator economy.

platformsCopy Anchor Link

An array of platform targets, at least one: ios, android-apk, macos, windows. Duplicates are allowed by the schema, reported as platforms.duplicate, and built once. See Multi-platform delivery.

deploymentCopy Anchor Link

sharedServicesCopy Anchor Link

A partial object is completed with defaults: { "ai": "none" } resolves to media: "symorva", ai: "none", metering: "symorva".

Validation behaviourCopy Anchor Link

Validation runs in two passes.

1. Schema. Types, required fields, ranges, formats and enumerations. If this pass fails, validation stops and reports only schema diagnostics.
2. Composition. Rules between modules, shared services and platforms. All rules run and all findings are reported together.

Every object in the manifest is strict: a key the schema does not define is an error (schema.unrecognized_keys) rather than being dropped, so a misspelt key such as e2e instead of e2ee is reported with its path. The $schema reference lets your editor flag it while you type.

DiagnosticsCopy Anchor Link

Schema diagnosticsCopy Anchor Link

Schema findings are always errors. Their code is schema. followed by the issue type; their path points at the offending field, with array indices as path segments.

Non-integers in integer fields are reported as schema.invalid_type with expected int.

Composition diagnosticsCopy Anchor Link

Messages are abbreviated in this table; codes and paths are stable and are what tooling should match on.

Complete exampleCopy Anchor Link

Every field, set explicitly:

{
  "$schema": "./node_modules/@symorva/sdk/schema/community.v1.json",
  "schemaVersion": 1,
  "community": {
    "id": "orbit-collective",
    "name": "Orbit Collective",
    "template": "dao",
    "description": "A collective building shared tools in the open.",
    "locales": ["en", "zh-Hans"]
  },
  "brand": {
    "primaryColor": "#6E5BFF",
    "accentColor": "#8C78FF",
    "appIcon": "assets/app-icon.png",
    "theme": "system"
  },
  "modules": {
    "chat": {
      "enabled": true,
      "e2ee": true,
      "tribes": true,
      "roles": ["owner", "admin", "moderator", "member"],
      "joinApproval": true,
      "maxGroupSize": 2000
    },
    "meetings": {
      "enabled": true,
      "video": true,
      "screenShare": true,
      "slides": true,
      "recording": false,
      "maxParticipants": 50,
      "broadcast": { "enabled": true, "maxAudience": 2000 }
    },
    "aiStudio": {
      "enabled": true,
      "assistant": true,
      "imageGeneration": true,
      "shortDrama": false,
      "productAds": false,
      "chatContentAccess": "member-grant"
    },
    "wallet": {
      "enabled": true,
      "keyProtection": "tee",
      "payments": true,
      "memberBenefits": true,
      "networks": ["network-a", "network-b"]
    },
    "dapps": {
      "enabled": true,
      "directory": true,
      "allowlist": ["https://app.partner.example"]
    },
    "creatorEconomy": {
      "enabled": false,
      "tips": true,
      "remixRevenueShare": { "enabled": false, "originalCreatorShareBps": 3000 }
    }
  },
  "platforms": ["ios", "android-apk", "macos", "windows"],
  "deployment": {
    "mode": "self-hosted",
    "region": "eu-central",
    "domain": "community.orbit.example"
  },
  "sharedServices": {
    "media": "symorva",
    "ai": "symorva",
    "metering": "symorva"
  }
}

TemplatesCopy Anchor Link

symorva init --template <id> and templateManifest(id) produce these starting points. All four target every platform, deploy in self-hosted mode and ship English.

Example names are illustrative; they do not refer to real communities.