sbom-cyclonedx 0.1.0 → 0.2.0

data/sig/sbom/cyclone_dx/record/metadata.rbs

@@ -0,0 +1,82 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Metadata < Base
+        class CustomPhase < Base
+          def initialize: (name: String, ?description: String?) -> void
+
+          def name: () -> String
+          def name=: (String) -> String
+          def name?: () -> bool
+          def name_valid?: () -> bool
+
+          def description: () -> String?
+          def description=: (String?) -> String?
+          def description?: () -> bool
+          def description_valid?: () -> bool
+        end
+
+        class PreDefinedPhase < Base
+          def initialize: (phase: String) -> void
+
+          def phase: () -> String
+          def phase=: (String) -> String
+          def phase?: () -> bool
+          def phase_valid?: () -> bool
+        end
+
+        def initialize: (?timestamp: dateTime?, ?lifecycles: Array[PreDefinedPhase | CustomPhase]?, ?tools: Tools?, ?manufacturer: OrganizationalEntity?, ?authors: Array[OrganizationalContact]?, ?component: Component?, ?manufacture: OrganizationalEntity?, ?supplier: OrganizationalEntity?, ?licenses: Array[LicenseChoice::licenseChoice]?, ?properties: Array[Property]?) -> void
+
+        def timestamp: () -> dateTime?
+        def timestamp=: (dateTime?) -> dateTime?
+        def timestamp?: () -> bool
+        def timestamp_valid?: () -> bool
+
+        def lifecycles: () -> (Array[PreDefinedPhase | CustomPhase])?
+        def lifecycles=: (Array[PreDefinedPhase | CustomPhase]?) -> (Array[PreDefinedPhase | CustomPhase])?
+        def lifecycles?: () -> bool
+        def lifecycles_valid?: () -> bool
+
+        def tools: () -> Tools?
+        def tools=: (Tools?) -> Tools?
+        def tools?: () -> bool
+        def tools_valid?: () -> bool
+
+        def manufacturer: () -> OrganizationalEntity?
+        def manufacturer=: (OrganizationalEntity?) -> OrganizationalEntity?
+        def manufacturer?: () -> bool
+        def manufacturer_valid?: () -> bool
+
+        def authors: () -> Array[OrganizationalContact]?
+        def authors=: (Array[OrganizationalContact]?) -> Array[OrganizationalContact]?
+        def authors?: () -> bool
+        def authors_valid?: () -> bool
+
+        def component: () -> Component?
+        def component=: (Component?) -> Component?
+        def component?: () -> bool
+        def component_valid?: () -> bool
+
+        def manufacture: () -> OrganizationalEntity?
+        def manufacture=: (OrganizationalEntity?) -> OrganizationalEntity?
+        def manufacture?: () -> bool
+        def manufacture_valid?: () -> bool
+
+        def supplier: () -> OrganizationalEntity?
+        def supplier=: (OrganizationalEntity?) -> OrganizationalEntity?
+        def supplier?: () -> bool
+        def supplier_valid?: () -> bool
+
+        def licenses: () -> Array[LicenseChoice::licenseChoice]?
+        def licenses=: (Array[LicenseChoice::licenseChoice]?) -> Array[LicenseChoice::licenseChoice]?
+        def licenses?: () -> bool
+        def licenses_valid?: () -> bool
+
+        def properties: () -> Array[Property]?
+        def properties=: (Array[Property]?) -> Array[Property]?
+        def properties?: () -> bool
+        def properties_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/model_card.rbs

@@ -0,0 +1,143 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class ModelCard < Base
+        class Considerations < Base
+          def initialize: (?users: Array[String]?, ?use_cases: Array[String]?, ?technical_limitations: Array[String]?, ?performance_tradeoffs: Array[String]?, ?ethical_considerations: Array[Risk]?, ?environmental_considerations: EnvironmentalConsideration?, ?fairness_assessments: Array[FairnessAssessment]?) -> void
+
+          def users: () -> Array[String]?
+          def users=: (Array[String]?) -> Array[String]?
+          def users?: () -> bool
+          def users_valid?: () -> bool
+
+          def use_cases: () -> Array[String]?
+          def use_cases=: (Array[String]?) -> Array[String]?
+          def use_cases?: () -> bool
+          def use_cases_valid?: () -> bool
+
+          def technical_limitations: () -> Array[String]?
+          def technical_limitations=: (Array[String]?) -> Array[String]?
+          def technical_limitations?: () -> bool
+          def technical_limitations_valid?: () -> bool
+
+          def performance_tradeoffs: () -> Array[String]?
+          def performance_tradeoffs=: (Array[String]?) -> Array[String]?
+          def performance_tradeoffs?: () -> bool
+          def performance_tradeoffs_valid?: () -> bool
+
+          def ethical_considerations: () -> Array[Risk]?
+          def ethical_considerations=: (Array[Risk]?) -> Array[Risk]?
+          def ethical_considerations?: () -> bool
+          def ethical_considerations_valid?: () -> bool
+
+          def environmental_considerations: () -> EnvironmentalConsideration?
+          def environmental_considerations=: (EnvironmentalConsideration?) -> EnvironmentalConsideration?
+          def environmental_considerations?: () -> bool
+          def environmental_considerations_valid?: () -> bool
+
+          def fairness_assessments: () -> Array[FairnessAssessment]?
+          def fairness_assessments=: (Array[FairnessAssessment]?) -> Array[FairnessAssessment]?
+          def fairness_assessments?: () -> bool
+          def fairness_assessments_valid?: () -> bool
+        end
+
+        class ModelParameters < Base
+          class Approach < Base
+            def initialize: (?type: String?) -> void
+
+            def type: () -> String?
+            def type=: (String?) -> String?
+            def type?: () -> bool
+            def type_valid?: () -> bool
+          end
+
+          class DataReference < Base
+            def initialize: (?ref: String?) -> void
+
+            def ref: () -> String?
+            def ref=: (String?) -> String?
+            def ref?: () -> bool
+            def ref_valid?: () -> bool
+          end
+          def initialize: (?approach: Approach?, ?task: String?, ?architecture_family: String?, ?model_architecture: String?, ?datasets: Array[ComponentData | DataReference]?, ?inputs: Array[InputOutputMLParameter]?, ?outputs: Array[InputOutputMLParameter]?) -> void
+
+          def approach: () -> Approach?
+          def approach=: (Approach?) -> Approach?
+          def approach?: () -> bool
+          def approach_valid?: () -> bool
+
+          def task: () -> String?
+          def task=: (String?) -> String?
+          def task?: () -> bool
+          def task_valid?: () -> bool
+
+          def architecture_family: () -> String?
+          def architecture_family=: (String?) -> String?
+          def architecture_family?: () -> bool
+          def architecture_family_valid?: () -> bool
+
+          def model_architecture: () -> String?
+          def model_architecture=: (String?) -> String?
+          def model_architecture?: () -> bool
+          def model_architecture_valid?: () -> bool
+
+          def datasets: () -> (Array[ComponentData | DataReference])?
+          def datasets=: (Array[ComponentData | DataReference]?) -> (Array[ComponentData | DataReference])?
+          def datasets?: () -> bool
+          def datasets_valid?: () -> bool
+
+          def inputs: () -> Array[InputOutputMLParameter]?
+          def inputs=: (Array[InputOutputMLParameter]?) -> Array[InputOutputMLParameter]?
+          def inputs?: () -> bool
+          def inputs_valid?: () -> bool
+
+          def outputs: () -> Array[InputOutputMLParameter]?
+          def outputs=: (Array[InputOutputMLParameter]?) -> Array[InputOutputMLParameter]?
+          def outputs?: () -> bool
+          def outputs_valid?: () -> bool
+        end
+
+        class QuantitativeAnalysis < Base
+          def initialize: (?performance_metrics: Array[PerformanceMetric]?, ?graphics: GraphicsCollection?) -> void
+
+          def performance_metrics: () -> Array[PerformanceMetric]?
+          def performance_metrics=: (Array[PerformanceMetric]?) -> Array[PerformanceMetric]?
+          def performance_metrics?: () -> bool
+          def performance_metrics_valid?: () -> bool
+
+          def graphics: () -> GraphicsCollection?
+          def graphics=: (GraphicsCollection?) -> GraphicsCollection?
+          def graphics?: () -> bool
+          def graphics_valid?: () -> bool
+        end
+
+        def initialize: (?bom_ref: String?, ?model_parameters: ModelParameters?, ?quantitative_analysis: QuantitativeAnalysis?, ?considerations: Considerations?, ?properties: Array[Property]?) -> void
+
+        def bom_ref: () -> String?
+        def bom_ref=: (String?) -> String?
+        def bom_ref?: () -> bool
+        def bom_ref_valid?: () -> bool
+
+        def model_parameters: () -> ModelParameters?
+        def model_parameters=: (ModelParameters?) -> ModelParameters?
+        def model_parameters?: () -> bool
+        def model_parameters_valid?: () -> bool
+
+        def quantitative_analysis: () -> QuantitativeAnalysis?
+        def quantitative_analysis=: (QuantitativeAnalysis?) -> QuantitativeAnalysis?
+        def quantitative_analysis?: () -> bool
+        def quantitative_analysis_valid?: () -> bool
+
+        def considerations: () -> Considerations?
+        def considerations=: (Considerations?) -> Considerations?
+        def considerations?: () -> bool
+        def considerations_valid?: () -> bool
+
+        def properties: () -> Array[Property]?
+        def properties=: (Array[Property]?) -> Array[Property]?
+        def properties?: () -> bool
+        def properties_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/note.rbs

@@ -0,0 +1,19 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Note < Base
+        def initialize: (?locale: String?, text: Attachment) -> void
+
+        def locale: () -> String?
+        def locale=: (String?) -> String?
+        def locale?: () -> bool
+        def locale_valid?: () -> bool
+
+        def text: () -> Attachment
+        def text=: (Attachment) -> Attachment
+        def text?: () -> bool
+        def text_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/organizational_contact.rbs

@@ -0,0 +1,29 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class OrganizationalContact < Base
+        def initialize: (?bom_ref: String?, ?name: String?, ?email: emailAddress?, ?phone: String?) -> void
+
+        def bom_ref: () -> String?
+        def bom_ref=: (String?) -> String?
+        def bom_ref?: () -> bool
+        def bom_ref_valid?: () -> bool
+
+        def name: () -> String?
+        def name=: (String?) -> String?
+        def name?: () -> bool
+        def name_valid?: () -> bool
+
+        def email: () -> emailAddress?
+        def email=: (emailAddress?) -> emailAddress?
+        def email?: () -> bool
+        def email_valid?: () -> bool
+
+        def phone: () -> String?
+        def phone=: (String?) -> String?
+        def phone?: () -> bool
+        def phone_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/organizational_entity.rbs

@@ -0,0 +1,34 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class OrganizationalEntity < Base
+        def initialize: (?bom_ref: String?, ?name: String?, ?address: PostalAddress?, ?url: Array[uri]?, ?contact: Array[OrganizationalContact]?) -> void
+
+        def bom_ref: () -> String?
+        def bom_ref=: (String?) -> String?
+        def bom_ref?: () -> bool
+        def bom_ref_valid?: () -> bool
+
+        def name: () -> String?
+        def name=: (String?) -> String?
+        def name?: () -> bool
+        def name_valid?: () -> bool
+
+        def address: () -> PostalAddress?
+        def address=: (PostalAddress?) -> PostalAddress?
+        def address?: () -> bool
+        def address_valid?: () -> bool
+
+        def url: () -> Array[uri]?
+        def url=: (Array[uri]?) -> Array[uri]?
+        def url?: () -> bool
+        def url_valid?: () -> bool
+
+        def contact: () -> Array[OrganizationalContact]?
+        def contact=: (Array[OrganizationalContact]?) -> Array[OrganizationalContact]?
+        def contact?: () -> bool
+        def contact_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/output.rbs

@@ -0,0 +1,44 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Output < Base
+        def initialize: (type: String, ?source: ResourceReferenceChoice?, ?target: ResourceReferenceChoice?, ?resource: ResourceReferenceChoice?, ?data: Attachment?, ?environment_vars: Array[Property | String]?, ?properties: Array[Property]?) -> void
+
+        def type: () -> String
+        def type=: (String) -> String
+        def type?: () -> bool
+        def type_valid?: () -> bool
+
+        def source: () -> ResourceReferenceChoice?
+        def source=: (ResourceReferenceChoice?) -> ResourceReferenceChoice?
+        def source?: () -> bool
+        def source_valid?: () -> bool
+
+        def target: () -> ResourceReferenceChoice?
+        def target=: (ResourceReferenceChoice?) -> ResourceReferenceChoice?
+        def target?: () -> bool
+        def target_valid?: () -> bool
+
+        def resource: () -> ResourceReferenceChoice?
+        def resource=: (ResourceReferenceChoice?) -> ResourceReferenceChoice?
+        def resource?: () -> bool
+        def resource_valid?: () -> bool
+
+        def data: () -> Attachment?
+        def data=: (Attachment?) -> Attachment?
+        def data?: () -> bool
+        def data_valid?: () -> bool
+
+        def environment_vars: () -> (Array[Property | String])?
+        def environment_vars=: (Array[Property | String]?) -> (Array[Property | String])?
+        def environment_vars?: () -> bool
+        def environment_vars_valid?: () -> bool
+
+        def properties: () -> Array[Property]?
+        def properties=: (Array[Property]?) -> Array[Property]?
+        def properties?: () -> bool
+        def properties_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/parameter.rbs

@@ -0,0 +1,24 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Parameter < Base
+        def initialize: (?name: String?, ?value: String?, ?data_type: String?) -> void
+
+        def name: () -> String?
+        def name=: (String?) -> String?
+        def name?: () -> bool
+        def name_valid?: () -> bool
+
+        def value: () -> String?
+        def value=: (String?) -> String?
+        def value?: () -> bool
+        def value_valid?: () -> bool
+
+        def data_type: () -> String?
+        def data_type=: (String?) -> String?
+        def data_type?: () -> bool
+        def data_type_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/patch.rbs

@@ -0,0 +1,24 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Patch < Base
+        def initialize: (type: String, ?diff: Diff?, ?resolves: Array[Issue]?) -> void
+
+        def type: () -> String
+        def type=: (String) -> String
+        def type?: () -> bool
+        def type_valid?: () -> bool
+
+        def diff: () -> Diff?
+        def diff=: (Diff?) -> Diff?
+        def diff?: () -> bool
+        def diff_valid?: () -> bool
+
+        def resolves: () -> Array[Issue]?
+        def resolves=: (Array[Issue]?) -> Array[Issue]?
+        def resolves?: () -> bool
+        def resolves_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/performance_metric.rbs

@@ -0,0 +1,43 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class PerformanceMetric < Base
+        class ConfidenceInterval < Base
+          def initialize: (?lower_bound: String?, ?upper_bound: String?) -> void
+
+          def lower_bound: () -> String?
+          def lower_bound=: (String?) -> String?
+          def lower_bound?: () -> bool
+          def lower_bound_valid?: () -> bool
+
+          def upper_bound: () -> String?
+          def upper_bound=: (String?) -> String?
+          def upper_bound?: () -> bool
+          def upper_bound_valid?: () -> bool
+        end
+
+        def initialize: (?type: String?, ?value: String?, ?slice: String?, ?confidence_interval: ConfidenceInterval?) -> void
+
+        def type: () -> String?
+        def type=: (String?) -> String?
+        def type?: () -> bool
+        def type_valid?: () -> bool
+
+        def value: () -> String?
+        def value=: (String?) -> String?
+        def value?: () -> bool
+        def value_valid?: () -> bool
+
+        def slice: () -> String?
+        def slice=: (String?) -> String?
+        def slice?: () -> bool
+        def slice_valid?: () -> bool
+
+        def confidence_interval: () -> ConfidenceInterval?
+        def confidence_interval=: (ConfidenceInterval?) -> ConfidenceInterval?
+        def confidence_interval?: () -> bool
+        def confidence_interval_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/postal_address.rbs

@@ -0,0 +1,44 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class PostalAddress < Base
+        def initialize: (?bom_ref: String?, ?country: String?, ?region: String?, ?locality: String?, ?post_office_box_number: String?, ?postal_code: String?, ?street_address: String?) -> void
+
+        def bom_ref: () -> String?
+        def bom_ref=: (String?) -> String?
+        def bom_ref?: () -> bool
+        def bom_ref_valid?: () -> bool
+
+        def country: () -> String?
+        def country=: (String?) -> String?
+        def country?: () -> bool
+        def country_valid?: () -> bool
+
+        def region: () -> String?
+        def region=: (String?) -> String?
+        def region?: () -> bool
+        def region_valid?: () -> bool
+
+        def locality: () -> String?
+        def locality=: (String?) -> String?
+        def locality?: () -> bool
+        def locality_valid?: () -> bool
+
+        def post_office_box_number: () -> String?
+        def post_office_box_number=: (String?) -> String?
+        def post_office_box_number?: () -> bool
+        def post_office_box_number_valid?: () -> bool
+
+        def postal_code: () -> String?
+        def postal_code=: (String?) -> String?
+        def postal_code?: () -> bool
+        def postal_code_valid?: () -> bool
+
+        def street_address: () -> String?
+        def street_address=: (String?) -> String?
+        def street_address?: () -> bool
+        def street_address_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/property.rbs

@@ -0,0 +1,19 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Property < Base
+        def initialize: (name: String, ?value: String?) -> void
+
+        def name: () -> String
+        def name=: (String) -> String
+        def name?: () -> bool
+        def name_valid?: () -> bool
+
+        def value: () -> String?
+        def value=: (String?) -> String?
+        def value?: () -> bool
+        def value_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/rating.rbs

@@ -0,0 +1,39 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Rating < Base
+        def initialize: (?source: VulnerabilitySource?, ?score: Float?, ?severity: String?, ?score_method: String?, ?vector: String?, ?justification: String?) -> void
+
+        def source: () -> VulnerabilitySource?
+        def source=: (VulnerabilitySource?) -> VulnerabilitySource?
+        def source?: () -> bool
+        def source_valid?: () -> bool
+
+        def score: () -> Float?
+        def score=: (Float?) -> Float?
+        def score?: () -> bool
+        def score_valid?: () -> bool
+
+        def severity: () -> String?
+        def severity=: (String?) -> String?
+        def severity?: () -> bool
+        def severity_valid?: () -> bool
+
+        def score_method: () -> String?
+        def score_method=: (String?) -> String?
+        def score_method?: () -> bool
+        def score_method_valid?: () -> bool
+
+        def vector: () -> String?
+        def vector=: (String?) -> String?
+        def vector?: () -> bool
+        def vector_valid?: () -> bool
+
+        def justification: () -> String?
+        def justification=: (String?) -> String?
+        def justification?: () -> bool
+        def justification_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/release_notes.rbs

@@ -0,0 +1,64 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class ReleaseNotes < Base
+        def initialize: (type: String, ?title: String?, ?featured_image: uri?, ?social_image: uri?, ?description: String?, ?timestamp: dateTime?, ?aliases: Array[String]?, ?tags: Array[String]?, ?resolves: Array[Issue]?, ?notes: Array[Note]?, ?properties: Array[Property]?) -> void
+
+        def type: () -> String
+        def type=: (String) -> String
+        def type?: () -> bool
+        def type_valid?: () -> bool
+
+        def title: () -> String?
+        def title=: (String?) -> String?
+        def title?: () -> bool
+        def title_valid?: () -> bool
+
+        def featured_image: () -> uri?
+        def featured_image=: (uri?) -> uri?
+        def featured_image?: () -> bool
+        def featured_image_valid?: () -> bool
+
+        def social_image: () -> uri?
+        def social_image=: (uri?) -> uri?
+        def social_image?: () -> bool
+        def social_image_valid?: () -> bool
+
+        def description: () -> String?
+        def description=: (String?) -> String?
+        def description?: () -> bool
+        def description_valid?: () -> bool
+
+        def timestamp: () -> dateTime?
+        def timestamp=: (dateTime?) -> dateTime?
+        def timestamp?: () -> bool
+        def timestamp_valid?: () -> bool
+
+        def aliases: () -> Array[String]?
+        def aliases=: (Array[String]?) -> Array[String]?
+        def aliases?: () -> bool
+        def aliases_valid?: () -> bool
+
+        def tags: () -> Array[String]?
+        def tags=: (Array[String]?) -> Array[String]?
+        def tags?: () -> bool
+        def tags_valid?: () -> bool
+
+        def resolves: () -> Array[Issue]?
+        def resolves=: (Array[Issue]?) -> Array[Issue]?
+        def resolves?: () -> bool
+        def resolves_valid?: () -> bool
+
+        def notes: () -> Array[Note]?
+        def notes=: (Array[Note]?) -> Array[Note]?
+        def notes?: () -> bool
+        def notes_valid?: () -> bool
+
+        def properties: () -> Array[Property]?
+        def properties=: (Array[Property]?) -> Array[Property]?
+        def properties?: () -> bool
+        def properties_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/resource_reference_choice.rbs

@@ -0,0 +1,19 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class ResourceReferenceChoice < Base
+        def initialize: (?ref: String?, ?external_reference: ExternalReference?) -> void
+
+        def ref: () -> String?
+        def ref=: (String?) -> String?
+        def ref?: () -> bool
+        def ref_valid?: () -> bool
+
+        def external_reference: () -> ExternalReference?
+        def external_reference=: (ExternalReference?) -> ExternalReference?
+        def external_reference?: () -> bool
+        def external_reference_valid?: () -> bool
+      end
+    end
+  end
+end

data/sig/sbom/cyclone_dx/record/risk.rbs

@@ -0,0 +1,19 @@
+module SBOM
+  module CycloneDX
+    module Record
+      class Risk < Base
+        def initialize: (?name: String?, ?mitigation_strategy: String?) -> void
+
+        def name: () -> String?
+        def name=: (String?) -> String?
+        def name?: () -> bool
+        def name_valid?: () -> bool
+
+        def mitigation_strategy: () -> String?
+        def mitigation_strategy=: (String?) -> String?
+        def mitigation_strategy?: () -> bool
+        def mitigation_strategy_valid?: () -> bool
+      end
+    end
+  end
+end