@bizappframework/angular-build/schemas/lib-builder-options-schema.json

{
  "definitions": {
    "AfterEmitCleanOptions": {
      "additionalProperties": false,
      "properties": {
        "excludes": {
          "description": "Path array to exclude from deleting.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "paths": {
          "description": "Paths to be deleted.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "AssetEntry": {
      "additionalProperties": false,
      "properties": {
        "exclude": {
          "description": "The ignore list.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "from": {
          "description": "The source file, it can be absolute or relative path or glob pattern.",
          "type": "string"
        },
        "to": {
          "description": "The output file name.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "AssetPatternObjectCompat": {
      "additionalProperties": false,
      "properties": {
        "glob": {
          "type": "string"
        },
        "ignore": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "input": {
          "type": "string"
        },
        "output": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "BeforeBuildCleanOptions": {
      "additionalProperties": false,
      "properties": {
        "cleanCache": {
          "description": "If true, delete cache directories before build.",
          "type": "boolean"
        },
        "cleanOutDir": {
          "description": "If true, delete output directory before build.",
          "type": "boolean"
        },
        "excludes": {
          "description": "Path array to exclude from deleting.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "paths": {
          "description": "Paths to be deleted.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "CleanOptions": {
      "additionalProperties": false,
      "properties": {
        "afterEmit": {
          "$ref": "#/definitions/AfterEmitCleanOptions",
          "description": "After emit clean option."
        },
        "allowOutsideOutDir": {
          "description": "Allows cleaning outside of output directory.",
          "type": "boolean"
        },
        "allowOutsideWorkspaceRoot": {
          "description": "Allows cleaning outside of workspace root.",
          "type": "boolean"
        },
        "beforeBuild": {
          "$ref": "#/definitions/BeforeBuildCleanOptions",
          "description": "Before build clean option."
        }
      },
      "type": "object"
    },
    "ExternalsObjectElement": {
      "additionalProperties": {
        "anyOf": [
          {
            "additionalProperties": {
              "type": [
                "string",
                "boolean"
              ]
            },
            "properties": {
              "amd": {
                "type": "string"
              },
              "commonjs": {
                "type": "string"
              },
              "root": {
                "type": "string"
              }
            },
            "type": "object"
          },
          {
            "type": [
              "string",
              "boolean"
            ]
          }
        ]
      },
      "type": "object"
    },
    "GlobalEntry": {
      "additionalProperties": false,
      "properties": {
        "bundleName": {
          "description": "The bundle name for this extra entry point.",
          "type": "string"
        },
        "input": {
          "anyOf": [
            {
              "items": {
                "type": "string"
              },
              "type": "array"
            },
            {
              "type": "string"
            }
          ],
          "description": "The file to include."
        },
        "lazy": {
          "description": "If the bundle will be lazy loaded.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "LibBundleOptions": {
      "additionalProperties": false,
      "properties": {
        "entry": {
          "description": "The entry file to be bundled.",
          "type": "string"
        },
        "entryRoot": {
          "description": "Entry root directory resolution.",
          "enum": [
            "outputPath",
            "prevBundleOutDir",
            "root",
            "tsTranspilationOutDir"
          ],
          "type": "string"
        },
        "externals": {
          "anyOf": [
            {
              "$ref": "#/definitions/ExternalsObjectElement"
            },
            {
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/definitions/ExternalsObjectElement"
                  },
                  {
                    "type": "string"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "string"
            }
          ],
          "description": "The externals configuration option provides a way of excluding dependencies from the output bundle."
        },
        "includeDefaultAngularAndRxJsGlobals": {
          "description": "If true, predefined Angular and rxjs globals are added.",
          "type": "boolean"
        },
        "libraryTarget": {
          "description": "Bundle module format.",
          "enum": [
            "cjs",
            "esm",
            "umd"
          ],
          "type": "string"
        },
        "minify": {
          "description": "If true, minify file will be generated.",
          "type": "boolean"
        },
        "nodeModulesAsExternals": {
          "description": "If true, node_modules packages are not included in bundle.",
          "type": "boolean"
        },
        "outputFilePath": {
          "description": "Custom bundle output file path.",
          "type": "string"
        },
        "tsConfig": {
          "description": "The typescript configuration file to be used.",
          "type": "string"
        },
        "tsTranspilationIndex": {
          "description": "Array index for entry root tsTranspilationResult.",
          "type": "number"
        }
      },
      "type": "object"
    },
    "LibEnvOverridesOptions": {
      "additionalProperties": {
        "$ref": "#/definitions/LibProjectConfigBase"
      },
      "type": "object"
    },
    "LibProjectConfigBase": {
      "additionalProperties": false,
      "properties": {
        "banner": {
          "description": "Banner text to add at the top of each generated files. It can be text file name or raw text.",
          "type": "string"
        },
        "bundles": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/definitions/LibBundleOptions"
              },
              "type": "array"
            },
            {
              "type": "boolean"
            }
          ],
          "description": "Bundle target options."
        },
        "clean": {
          "anyOf": [
            {
              "$ref": "#/definitions/CleanOptions"
            },
            {
              "type": "boolean"
            }
          ],
          "description": "Clean options."
        },
        "copy": {
          "description": "Copy options.",
          "items": {
            "anyOf": [
              {
                "$ref": "#/definitions/AssetEntry"
              },
              {
                "type": "string"
              }
            ]
          },
          "type": "array"
        },
        "externals": {
          "anyOf": [
            {
              "$ref": "#/definitions/ExternalsObjectElement"
            },
            {
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/definitions/ExternalsObjectElement"
                  },
                  {
                    "type": "string"
                  }
                ]
              },
              "type": "array"
            },
            {
              "type": "string"
            }
          ],
          "description": "The externals configuration option provides a way of excluding dependencies from the output bundle."
        },
        "includeDefaultAngularAndRxJsGlobals": {
          "description": "If true, predefined Angular and rxjs globals are added.",
          "type": "boolean"
        },
        "libraryName": {
          "description": "Represents your umd bundle name, by which other scripts on the same page can access it.",
          "type": "string"
        },
        "nodeModulesAsExternals": {
          "description": "If true, node_modules packages are not included in bundle.",
          "type": "boolean"
        },
        "outputPath": {
          "description": "The output directory for build results.",
          "type": "string"
        },
        "packageEntryFileForTsTranspilation": {
          "description": "The main entry point file for package.json.",
          "type": "string"
        },
        "packageJsonCopy": {
          "description": "Copy package.json file to output path.",
          "type": "boolean"
        },
        "packageJsonOutDir": {
          "description": "The output root directory for package.json file.",
          "type": "string"
        },
        "platformTarget": {
          "description": "Tell the build system which platform environment the application is targeting.",
          "enum": [
            "node",
            "web"
          ],
          "type": "string"
        },
        "skip": {
          "description": "If true, this project config will be skipped by the build process.",
          "type": "boolean"
        },
        "sourceMap": {
          "description": "If true, sourcemaps will be generated.",
          "type": "boolean"
        },
        "stylePreprocessorOptions": {
          "$ref": "#/definitions/StylePreprocessorOptions",
          "description": "Options to pass to style preprocessors."
        },
        "styles": {
          "description": "List of global style entries.",
          "items": {
            "anyOf": [
              {
                "$ref": "#/definitions/GlobalEntry"
              },
              {
                "type": "string"
              }
            ]
          },
          "type": "array"
        },
        "tsConfig": {
          "description": "The typescript configuration file to be used.",
          "type": "string"
        },
        "tsTranspilations": {
          "anyOf": [
            {
              "items": {
                "$ref": "#/definitions/TsTranspilationOptions"
              },
              "type": "array"
            },
            {
              "type": "boolean"
            }
          ],
          "description": "Typescript transpilation options."
        }
      },
      "type": "object"
    },
    "StylePreprocessorOptions": {
      "additionalProperties": false,
      "properties": {
        "includePaths": {
          "description": "An array of paths that LibSass can look in to attempt to resolve your @import declarations.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "TsTranspilationOptions": {
      "additionalProperties": false,
      "properties": {
        "declaration": {
          "description": "Override declaration option for this transpilation.",
          "type": "boolean"
        },
        "inlineAssets": {
          "description": "If true, templateUrl and styleUrls resources are inlined.",
          "type": "boolean"
        },
        "moveTypingFilesToPackageRoot": {
          "description": "Move typing and metadata files to package.json output directory root.",
          "type": "boolean"
        },
        "outDir": {
          "description": "Custom output directory for this transpilation.",
          "type": "string"
        },
        "reExportTypingEntryToOutputRoot": {
          "description": "If true, re-export secondary entry point typing and metadata file at output root.",
          "type": "boolean"
        },
        "replaceVersionPlaceholder": {
          "description": "If true, replaces version placeholder with package version.",
          "type": "boolean"
        },
        "target": {
          "description": "Override script target for this transpilation.",
          "enum": [
            "es2015",
            "es2016",
            "es2017",
            "es2018",
            "es5",
            "esnext"
          ],
          "type": "string"
        },
        "tsConfig": {
          "description": "Typescript configuration file for this transpilation.",
          "type": "string"
        },
        "useTsc": {
          "description": "If true, use tsc instead of ngc.",
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "WebpackWatchOptions": {
      "additionalProperties": true,
      "properties": {
        "aggregateTimeout": {
          "description": "Add a delay in milliseconds before rebuilding once the first file changed.",
          "type": "number"
        },
        "ignored": {
          "description": "Ignore pattern to exclude a huge folder like node_modules.",
          "type": "string"
        },
        "poll": {
          "description": "Turn on polling by passing true, or specifying a poll interval in milliseconds.",
          "type": [
            "number",
            "boolean"
          ]
        }
      },
      "type": "object"
    }
  },
  "properties": {
    "$schema": {
      "description": "Link to schema.",
      "type": "string"
    },
    "assets": {
      "anyOf": [
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/definitions/AssetPatternObjectCompat"
              },
              {
                "type": "string"
              }
            ]
          },
          "type": "array"
        },
        {
          "type": "boolean"
        }
      ]
    },
    "banner": {
      "description": "Banner text to add at the top of each generated files. It can be text file name or raw text.",
      "type": "string"
    },
    "beep": {
      "description": "Beep when build completed.",
      "type": "boolean"
    },
    "bundleDependencies": {
      "enum": [
        "all",
        "none"
      ],
      "type": "string"
    },
    "bundles": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/definitions/LibBundleOptions"
          },
          "type": "array"
        },
        {
          "type": "boolean"
        }
      ],
      "description": "Bundle target options."
    },
    "clean": {
      "anyOf": [
        {
          "$ref": "#/definitions/CleanOptions"
        },
        {
          "type": "boolean"
        }
      ],
      "description": "Clean options."
    },
    "cleanOutDir": {
      "description": "Clean output directory before build.",
      "type": "boolean"
    },
    "copy": {
      "description": "Copy options.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/definitions/AssetEntry"
          },
          {
            "type": "string"
          }
        ]
      },
      "type": "array"
    },
    "deleteOutputPath": {
      "type": "boolean"
    },
    "envOverrides": {
      "$ref": "#/definitions/LibEnvOverridesOptions",
      "description": "To override properties based on build environment."
    },
    "environment": {
      "anyOf": [
        {
          "additionalProperties": {
            "type": [
              "string",
              "boolean"
            ]
          },
          "type": "object"
        },
        {
          "type": "string"
        }
      ],
      "description": "Define the build environment."
    },
    "extends": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ],
      "description": "The name of build-in configuration preset, or path(s) to other configuration files which are extended by this configuration."
    },
    "externals": {
      "anyOf": [
        {
          "$ref": "#/definitions/ExternalsObjectElement"
        },
        {
          "items": {
            "anyOf": [
              {
                "$ref": "#/definitions/ExternalsObjectElement"
              },
              {
                "type": "string"
              }
            ]
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ],
      "description": "The externals configuration option provides a way of excluding dependencies from the output bundle."
    },
    "filter": {
      "anyOf": [
        {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        {
          "type": "string"
        }
      ],
      "description": "Filter config by name(s)."
    },
    "includeDefaultAngularAndRxJsGlobals": {
      "description": "If true, predefined Angular and rxjs globals are added.",
      "type": "boolean"
    },
    "libraryName": {
      "description": "Represents your umd bundle name, by which other scripts on the same page can access it.",
      "type": "string"
    },
    "logLevel": {
      "description": "Logging level for output logging.",
      "enum": [
        "debug",
        "info",
        "none",
        "warn"
      ],
      "type": "string"
    },
    "name": {
      "description": "The name of this configuration.",
      "type": "string"
    },
    "nodeModulesAsExternals": {
      "description": "If true, node_modules packages are not included in bundle.",
      "type": "boolean"
    },
    "outDir": {
      "description": "Compatibility only, use 'outputPath' instead.",
      "type": "string"
    },
    "outputPath": {
      "description": "The output directory for build results.",
      "type": "string"
    },
    "packageEntryFileForTsTranspilation": {
      "description": "The main entry point file for package.json.",
      "type": "string"
    },
    "packageJsonCopy": {
      "description": "Copy package.json file to output path.",
      "type": "boolean"
    },
    "packageJsonOutDir": {
      "description": "The output root directory for package.json file.",
      "type": "string"
    },
    "platform": {
      "enum": [
        "browser",
        "server"
      ],
      "type": "string"
    },
    "platformTarget": {
      "description": "Tell the build system which platform environment the application is targeting.",
      "enum": [
        "node",
        "web"
      ],
      "type": "string"
    },
    "poll": {
      "type": "number"
    },
    "preserveSymlinks": {
      "type": "boolean"
    },
    "progress": {
      "description": "Display compilation progress in percentage.",
      "type": "boolean"
    },
    "root": {
      "description": "The project root folder.",
      "type": "string"
    },
    "skip": {
      "description": "If true, this project config will be skipped by the build process.",
      "type": "boolean"
    },
    "sourceMap": {
      "description": "If true, sourcemaps will be generated.",
      "type": "boolean"
    },
    "stylePreprocessorOptions": {
      "$ref": "#/definitions/StylePreprocessorOptions",
      "description": "Options to pass to style preprocessors."
    },
    "styles": {
      "description": "List of global style entries.",
      "items": {
        "anyOf": [
          {
            "$ref": "#/definitions/GlobalEntry"
          },
          {
            "type": "string"
          }
        ]
      },
      "type": "array"
    },
    "target": {
      "description": "webpack-cli compatibility, use 'platformTarget' instead.",
      "enum": [
        "async-node",
        "atom",
        "electron",
        "electron-main",
        "electron-renderer",
        "node",
        "node-webkit",
        "web",
        "webworker"
      ],
      "type": "string"
    },
    "tsConfig": {
      "description": "The typescript configuration file to be used.",
      "type": "string"
    },
    "tsTranspilations": {
      "anyOf": [
        {
          "items": {
            "$ref": "#/definitions/TsTranspilationOptions"
          },
          "type": "array"
        },
        {
          "type": "boolean"
        }
      ],
      "description": "Typescript transpilation options."
    },
    "verbose": {
      "type": "boolean"
    },
    "watch": {
      "description": "Build with watch mode.",
      "type": "boolean"
    },
    "watchOptions": {
      "$ref": "#/definitions/WebpackWatchOptions",
      "description": "Watch options."
    }
  },
  "type": "object"
}