Exporter

Formal definition of an installation of exporter package within a specific workspace.

Available from: 2.0.0

Import


                                                        
                                                        
                                                            import { Exporter } from "@supernovaio/sdk"
                                                        
                                                            

Properties

  • id: The unique exporter installation identifier.
  • packageId: The original exporter package identifier as defined in exporter.json. Unique for all public exporters.
  • isPrivate: A boolean value indicating whether the exporter is private or public. Private exporters are only visible to your workspace, while public exporters are visible to everyone and can be installed by anyone.
  • isDefaultDocumentationExporter: A boolean value indicating whether this exporter is currently being used for documentation purposes.
  • usesBrands: A boolean value indicating whether this exporter uses branding functionality.
  • usesThemes: A boolean value indicating whether this exporter uses theming functionality.
  • name: The human-readable name of the exporter, providing a clear label to identify it.
  • description: A human-readable description of the exporter's purpose or functionality. This field may be null if no description is provided.
  • version: The semantic version of the exporter.
  • author: The name of the package author. This field may be null if no author name is specified.
  • organization: The name of the package author's organization. This field may be null if no organization name is specified.
  • homepage: A link to the package's marketing homepage. This field may be null if no homepage is defined.
  • readme: The package's ReadMe definition, defined as GitHub-style markdown. This field may be null if no ReadMe is provided.
  • iconURL: A URL pointing to the exporter package's icon.
  • tags: An array of feature tags associated with the exporter, indicating its capabilities and functionalities. Tags may include terms like "iOS," "React," "token," "styles," "components," etc.
  • exporterType: The type of exporter, which can be either "code" or "documentation."
  • origin: An object providing information about the original location of the package, typically a GitHub repository. It includes:
    • repositoryUrl: The URL of the repository containing the exporter package.
    • repositoryBranch: The branch of the repository containing the exporter package. If not provided, the exporter is located at the default branch.
    • repositoryDirectory: The root directory in the repository containing the exporter package. If not provided, the exporter is located at the root directory.
  • contributes: An object describing the contributions of this exporter to the Supernova system, including:
    • blockVariants: An array of exporter-customized block variants for documentation.
    • blocks: An array of exporter-customized blocks for documentation.
    • configuration: An array of exporter configuration properties.