Configuration reference

export interface Config {
  previews: PreviewConfiguration[];
  behaviorPresets: string[];
  defaultPreview: string | null;
 
  editorConfig: {
    All?: EditorConfig;
    Manifest?: EditorConfig;
    Canvas?: EditorConfig;
    Annotation?: EditorConfig;
    AnnotationPage?: EditorConfig;
    AnnotationCollection?: EditorConfig;
    Range?: EditorConfig;
    Collection?: EditorConfig;
    ContentResource?: EditorConfig;
  };
 
  editorFeatureFlags: {
    enableMultiImageCanvases?: boolean;
    enableMultiMediaCanvases?: boolean;
  };
 
  // Internationalisation options
  i18n: {
    defaultLanguage: string;
    availableLanguages: string[];
    advancedLanguageMode: boolean;
  };
 
  // Options when exporting from Vault.
  export: {
    baseIdentifier: string | null;
    version: 3 | 2;
  };
 
  plugins?: {
    apps?: Record<
      string,
      {
        enabled?: string[];
        disabled?: string[];
        settings?: Record<string, Record<string, unknown>>;
      }
    >;
  };
}
 
export interface EditorConfig {
  singleTab?: string;
  fields?: string[];
  hideTabs?: string[];
  onlyTabs?: string[];
}

const DEFAULT_CONFIG: Config = {
  previews: [],
  behaviorPresets: [
    "auto-advance",
    "no-auto-advance",
    "repeat",
    "no-repeat",
    "unordered",
    "individuals",
    "continuous",
    "paged",
    "non-paged",
    "facing-pages",
    "multi-part",
    "together",
    "sequence",
    "thumbnail-nav",
    "no-nav",
    "hidden",
  ],
  defaultPreview: null,
  editorConfig: {},
  newTemplates: null,
  i18n: {
    advancedLanguageMode: false,
    availableLanguages: ["en", "cy", "nl", "fr"],
    defaultLanguage: "en",
  },
  editorFeatureFlags: {
    enableMultiImageCanvases: true,
    enableMultiMediaCanvases: true,
  },
  uploadBackends: [],
  plugins: {
    apps: {},
  },
  export: {
    baseIdentifier: null,
    version: 3,
  },
};

const compatConfig: Partial<Config> = {
  editorConfig: {
    Manifest: {
      // singleTab: "@manifest-editor/overview",
      onlyTabs: [
        //
        "@manifest-editor/overview",
        "@manifest-editor/metadata",
      ],
      fields: ["label", "summary", "metadata", "rights", "requiredStatement", "rendering"],
    },
    Canvas: {
      singleTab: "@manifest-editor/overview",
      fields: ["items", "label", "metadata", "annotations"],
    },
  },
};

const config: Partial<Config> = {
  plugins: {
    apps: {
      "manifest-editor": {
        enabled: ["@example/plugin"],
        settings: {
          "@example/plugin": {
            mode: "automatic",
          },
        },
      },
    },
  },
};