platform-bible-utils
    Preparing search index...

    Variable projectSettingsDocumentSchemaConst

    projectSettingsDocumentSchema: {
        $defs: {
            extensionControlledProjectSetting: {
                allOf: { $ref: string }[];
                description: string;
            };
            extensionControlledSetting: {
                allOf: { $ref: string }[];
                description: string;
            };
            extensionControlledState: {
                allOf: { $ref: string }[];
                description: string;
            };
            id: { description: string; pattern: string; tsType: string; type: string };
            localizeKey: {
                description: string;
                pattern: string;
                tsType: string;
                type: string;
            };
            modifierExtensionControlled: {
                description: string;
                not: { anyOf: { required: string[]; type: string }[] };
            };
            modifierProject: {
                description: string;
                properties: {
                    excludePdpFactoryIds: {
                        anyOf: (
                            | { items?: undefined; type: string }
                            | { items: { type: string }; type: string }
                        )[];
                        description: string;
                    };
                    excludeProjectInterfaces: {
                        anyOf: (
                            | { items?: undefined; type: string }
                            | { items: { anyOf: ((...) | (...))[] }; type: string }
                        )[];
                        description: string;
                    };
                    includePdpFactoryIds: {
                        anyOf: (
                            | { items?: undefined; type: string }
                            | { items: { type: string }; type: string }
                        )[];
                        description: string;
                    };
                    includeProjectInterfaces: {
                        anyOf: (
                            | { items?: undefined; type: string }
                            | { items: { anyOf: ((...) | (...))[] }; type: string }
                        )[];
                        description: string;
                    };
                };
                type: string;
            };
            projectSetting: { anyOf: { $ref: string }[]; description: string };
            projectSettingBase: { allOf: { $ref: string }[]; description: string };
            projectSettingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: { "^[\\w\\-]+\\.[\\w\\-]+$": { $ref: string } };
                type: string;
            };
            projectSettingsContribution: {
                anyOf: (
                    | { $ref: string; items?: undefined; type?: undefined }
                    | { $ref?: undefined; items: { $ref: string }; type: string }
                )[];
                description: string;
            };
            projectSettingsGroup: {
                description: string;
                properties: {
                    description: { $ref: string; description: string };
                    label: { $ref: string; description: string };
                    properties: { $ref: string };
                };
                required: string[];
                type: string;
            };
            projectStateContribution: { $ref: string; description: string };
            setting: { anyOf: { $ref: string }[]; description: string };
            settingBase: {
                allOf: (
                    | {
                        $ref: string;
                        properties?: undefined;
                        required?: undefined;
                        type?: undefined;
                    }
                    | {
                        $ref?: undefined;
                        properties: {
                            description: { $ref: string; description: string };
                            isHidden: { description: string; type: string };
                            label: { $ref: string; description: string };
                        };
                        required: string[];
                        type: string;
                    }
                )[];
                description: string;
            };
            settingProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: { "^[\\w-]+\\.[\\w-]+$": { $ref: string } };
                type: string;
            };
            settingsContribution: {
                anyOf: (
                    | { $ref: string; items?: undefined; type?: undefined }
                    | { $ref?: undefined; items: { $ref: string }; type: string }
                )[];
                description: string;
            };
            settingsGroup: {
                description: string;
                properties: {
                    description: { $ref: string; description: string };
                    label: { $ref: string; description: string };
                    properties: { $ref: string };
                };
                required: string[];
                type: string;
            };
            stateBase: {
                description: string;
                properties: {
                    default: { description: string; type: string };
                    derivesFrom: { $ref: string; description: string };
                };
                required: string[];
                type: string;
            };
            userState: { anyOf: { $ref: string }[]; description: string };
            userStateContribution: { $ref: string; description: string };
            userStateProperties: {
                additionalProperties: boolean;
                description: string;
                patternProperties: { "^[\\w\\-]+\\.[\\w\\-]+$": { $ref: string } };
                type: string;
            };
        };
        $schema: string;
        anyOf: (
            | { $ref: string; items?: undefined; type?: undefined }
            | { $ref?: undefined; items: { $ref: string }; type: string }
        )[];
        description: string;
        title: string;
    } = ...

    JSON schema object that aligns with the ProjectSettingsContribution type

    Type declaration

    • $defs: {
          extensionControlledProjectSetting: {
              allOf: { $ref: string }[];
              description: string;
          };
          extensionControlledSetting: {
              allOf: { $ref: string }[];
              description: string;
          };
          extensionControlledState: {
              allOf: { $ref: string }[];
              description: string;
          };
          id: { description: string; pattern: string; tsType: string; type: string };
          localizeKey: {
              description: string;
              pattern: string;
              tsType: string;
              type: string;
          };
          modifierExtensionControlled: {
              description: string;
              not: { anyOf: { required: string[]; type: string }[] };
          };
          modifierProject: {
              description: string;
              properties: {
                  excludePdpFactoryIds: {
                      anyOf: (
                          | { items?: undefined; type: string }
                          | { items: { type: string }; type: string }
                      )[];
                      description: string;
                  };
                  excludeProjectInterfaces: {
                      anyOf: (
                          | { items?: undefined; type: string }
                          | { items: { anyOf: ((...) | (...))[] }; type: string }
                      )[];
                      description: string;
                  };
                  includePdpFactoryIds: {
                      anyOf: (
                          | { items?: undefined; type: string }
                          | { items: { type: string }; type: string }
                      )[];
                      description: string;
                  };
                  includeProjectInterfaces: {
                      anyOf: (
                          | { items?: undefined; type: string }
                          | { items: { anyOf: ((...) | (...))[] }; type: string }
                      )[];
                      description: string;
                  };
              };
              type: string;
          };
          projectSetting: { anyOf: { $ref: string }[]; description: string };
          projectSettingBase: { allOf: { $ref: string }[]; description: string };
          projectSettingProperties: {
              additionalProperties: boolean;
              description: string;
              patternProperties: { "^[\\w\\-]+\\.[\\w\\-]+$": { $ref: string } };
              type: string;
          };
          projectSettingsContribution: {
              anyOf: (
                  | { $ref: string; items?: undefined; type?: undefined }
                  | { $ref?: undefined; items: { $ref: string }; type: string }
              )[];
              description: string;
          };
          projectSettingsGroup: {
              description: string;
              properties: {
                  description: { $ref: string; description: string };
                  label: { $ref: string; description: string };
                  properties: { $ref: string };
              };
              required: string[];
              type: string;
          };
          projectStateContribution: { $ref: string; description: string };
          setting: { anyOf: { $ref: string }[]; description: string };
          settingBase: {
              allOf: (
                  | {
                      $ref: string;
                      properties?: undefined;
                      required?: undefined;
                      type?: undefined;
                  }
                  | {
                      $ref?: undefined;
                      properties: {
                          description: { $ref: string; description: string };
                          isHidden: { description: string; type: string };
                          label: { $ref: string; description: string };
                      };
                      required: string[];
                      type: string;
                  }
              )[];
              description: string;
          };
          settingProperties: {
              additionalProperties: boolean;
              description: string;
              patternProperties: { "^[\\w-]+\\.[\\w-]+$": { $ref: string } };
              type: string;
          };
          settingsContribution: {
              anyOf: (
                  | { $ref: string; items?: undefined; type?: undefined }
                  | { $ref?: undefined; items: { $ref: string }; type: string }
              )[];
              description: string;
          };
          settingsGroup: {
              description: string;
              properties: {
                  description: { $ref: string; description: string };
                  label: { $ref: string; description: string };
                  properties: { $ref: string };
              };
              required: string[];
              type: string;
          };
          stateBase: {
              description: string;
              properties: {
                  default: { description: string; type: string };
                  derivesFrom: { $ref: string; description: string };
              };
              required: string[];
              type: string;
          };
          userState: { anyOf: { $ref: string }[]; description: string };
          userStateContribution: { $ref: string; description: string };
          userStateProperties: {
              additionalProperties: boolean;
              description: string;
              patternProperties: { "^[\\w\\-]+\\.[\\w\\-]+$": { $ref: string } };
              type: string;
          };
      }
    • $schema: string
    • anyOf: (
          | { $ref: string; items?: undefined; type?: undefined }
          | { $ref?: undefined; items: { $ref: string }; type: string }
      )[]
    • description: string
    • title: string