sec_id 6.1.0 → 7.1.0

data/lib/sec_id/suggestion.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module SecID
+  # Immutable value object representing one repair candidate returned by `suggest`.
+  #
+  # Carries the corrected, re-validated identifier plus the what-changed diff (edit
+  # kind, position, from/to characters) and a confidence tier — the honest surface
+  # that keeps a candidate from reading as an authoritative correction.
+  #
+  # Coordinate system by edit kind:
+  # - `:substitution` — `position` is the 0-based index of the changed character;
+  #   `from`/`to` are the single characters before/after.
+  # - `:transposition` — `position` is the left index of the swapped pair;
+  #   `from`/`to` are the two-character adjacent substring before/after the swap.
+  # - `:checksum` — `position` is `nil`; `from`/`to` are the old/new check-character
+  #   string. `confidence` is `nil` (it is the fallback hypothesis, ranked last).
+  #
+  # @!attribute [r] type
+  #   @return [Symbol] the identifier type key (e.g. :isin)
+  # @!attribute [r] identifier
+  #   @return [SecID::Base] the valid, parsed corrected identifier
+  # @!attribute [r] edit
+  #   @return [Symbol] :substitution, :transposition, or :checksum
+  # @!attribute [r] position
+  #   @return [Integer, nil] the edit position (nil for :checksum)
+  # @!attribute [r] from
+  #   @return [String] the original character(s)
+  # @!attribute [r] to
+  #   @return [String] the replacement character(s)
+  # @!attribute [r] confidence
+  #   @return [Symbol, nil] :high (homoglyph), :medium (transposition), or nil (:checksum)
+  #
+  # @example
+  #   suggestion = SecID::ISIN.suggest('US5949181O45').first
+  #   suggestion.to_s          #=> 'US5949181045'
+  #   suggestion.edit          #=> :substitution
+  #   suggestion.confidence    #=> :high
+  Suggestion = Data.define(:type, :identifier, :edit, :position, :from, :to, :confidence)
+
+  # Reopened to add the domain enumerations and serialization helpers per the repo
+  # convention (see {Base#as_json}).
+  class Suggestion
+    # The edit kinds `edit` can take, in rank order (see {Suggestable::RANK}).
+    EDIT_KINDS = %i[substitution transposition checksum].freeze
+
+    # The non-nil confidence tiers `confidence` can take; `:checksum` candidates carry `nil`.
+    CONFIDENCE_LEVELS = %i[high medium].freeze
+
+    # @return [Hash] the symbol-keyed field hash (JSON-compatible)
+    def as_json(*)
+      to_h
+    end
+
+    # @return [String] the corrected identifier string
+    def to_s
+      identifier.to_s
+    end
+  end
+end

data/lib/sec_id/upi.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module SecID
+  # Unique Product Identifier (UPI, ISO 4914) - a 12-character code that identifies
+  # OTC derivative products for regulatory reporting, issued by the ANNA Derivatives
+  # Service Bureau.
+  #
+  # Format: fixed 'QZ' prefix + 9-character body + 1 check character, drawn from a
+  # 30-symbol alphabet (digits 0-9 plus consonants; vowels and 'Y' never appear).
+  # Validated fully offline via ISO 7064 hybrid MOD 31,30 over the 11 preceding characters.
+  #
+  # @see https://www.anna-dsb.com
+  #
+  # @example Validate a UPI
+  #   SecID::UPI.valid?('QZRBG6ZTKS42')  #=> true
+  #
+  # @example Restore check character
+  #   SecID::UPI.restore('QZRBG6ZTKS4')  #=> 'QZRBG6ZTKS42'
+  class UPI < Base
+    include Checkable
+    include Suggestable
+
+    # Human-readable name of the standard.
+    FULL_NAME = 'Unique Product Identifier'
+    # Valid length of a normalized identifier.
+    ID_LENGTH = 12
+    # A representative valid identifier.
+    EXAMPLE = 'QZRBG6ZTKS42'
+    # Pattern matching the identifier's permitted character set (digits + consonants, no vowels/Y).
+    VALID_CHARS_REGEX = /\A[0-9B-DF-HJ-NP-TV-XZ]+\z/
+
+    # Regular expression for parsing UPI components: fixed 'QZ' prefix, 9-character body,
+    # optional check character.
+    ID_REGEX = /\A
+      (?<identifier>QZ[0-9B-DF-HJ-NP-TV-XZ]{9})
+      (?<checksum>[0-9B-DF-HJ-NP-TV-XZ])?
+    \z/x
+
+    # The 30-symbol UPI alphabet, ordered by check-character value (0-29).
+    ALPHABET = '0123456789BCDFGHJKLMNPQRSTVWXZ'.chars.freeze
+
+    # Maps each alphabet character to its check-character value (0-29).
+    ALPHABET_VALUE = ALPHABET.each_with_index.to_h.freeze
+
+    # Characters valid in a UPI body (same alphabet as VALID_CHARS_REGEX).
+    GENERATE_CHARSET = ALPHANUMERIC.grep(VALID_CHARS_REGEX).freeze
+
+    # @param upi [String] the UPI string to parse
+    def initialize(upi)
+      upi_parts = parse upi
+      @identifier = upi_parts[:identifier]
+      @checksum = upi_parts[:checksum]
+    end
+
+    # @return [String] the calculated check character
+    # @raise [InvalidFormatError] if the UPI format is invalid
+    def calculate_checksum
+      validate_format_for_calculation!
+      mod31_30_check_char(identifier, ALPHABET, ALPHABET_VALUE)
+    end
+
+    # Generates a random UPI body: the fixed 'QZ' prefix plus 9 characters drawn
+    # from the UPI alphabet.
+    #
+    # @param random [Random] source of randomness
+    # @return [String] an 11-character UPI body without check character
+    def self.generate_body(random)
+      "QZ#{random_string(GENERATE_CHARSET, 9, random: random)}"
+    end
+    private_class_method :generate_body
+
+    private
+
+    # @return [Hash]
+    def components = { checksum: }
+  end
+end

data/lib/sec_id/valoren.rb

@@ -6,7 +6,7 @@ module SecID
   #
   # Format: 5-9 numeric digits
   #
-  # @note Valoren identifiers have no check digit and validation is based solely on format.
+  # @note Valoren identifiers have no checksum and validation is based solely on format.
   #
   # @see https://en.wikipedia.org/wiki/Valoren_number
   #
@@ -52,7 +52,7 @@ module SecID
     end
 
     # @param country_code [String] the ISO 3166-1 alpha-2 country code (default: 'CH')
-    # @return [ISIN] a new ISIN instance with calculated check digit
+    # @return [ISIN] a new ISIN instance with calculated checksum
     # @raise [InvalidFormatError] if the country code is not CH or LI
     def to_isin(country_code = 'CH')
       unless ISIN_COUNTRY_CODES.include?(country_code)

data/lib/sec_id/version.rb

@@ -2,5 +2,5 @@
 
 module SecID
   # Current gem version.
-  VERSION = '6.1.0'
+  VERSION = '7.1.0'
 end

data/lib/sec_id/wkn.rb

@@ -38,7 +38,7 @@ module SecID
     end
 
     # @param country_code [String] the ISO 3166-1 alpha-2 country code (default: 'DE')
-    # @return [ISIN] a new ISIN instance with calculated check digit
+    # @return [ISIN] a new ISIN instance with calculated checksum
     # @raise [InvalidFormatError] if the country code is not DE
     # @raise [InvalidFormatError] if the WKN format is invalid
     def to_isin(country_code = 'DE')

data/lib/sec_id.rb

@@ -4,7 +4,7 @@ require 'sec_id/version'
 
 # Toolkit for securities identifiers — validate, normalize, parse, detect, convert,
 # generate, and classify ISIN, CUSIP, CEI, SEDOL, FIGI, LEI, IBAN, CIK, OCC, WKN,
-# Valoren, CFI, FISN, BIC, and DTI.
+# Valoren, CFI, FISN, BIC, DTI, and UPI.
 #
 # @see https://github.com/svyatov/sec_id
 module SecID
@@ -14,8 +14,12 @@ module SecID
   # Raised for invalid format, length, or characters.
   class InvalidFormatError < Error; end
 
-  # Raised when the check digit does not match the calculated value.
-  class InvalidCheckDigitError < Error; end
+  # Raised when the checksum does not match the calculated value.
+  class InvalidChecksumError < Error; end
+
+  # @deprecated Use {InvalidChecksumError}. Kept as a v7 bridge (same class object,
+  #   so `rescue` under either name keeps working); removed in v8.
+  InvalidCheckDigitError = InvalidChecksumError
 
   # Raised for type-specific structural errors (invalid prefix, category, group, BBAN, or date).
   class InvalidStructureError < Error; end
@@ -139,8 +143,40 @@ module SecID
       self[key].generate(random: random)
     end
 
+    # Returns confidence-ranked repair candidates for a checksum-failing identifier,
+    # inferred across all format-compatible checksum types (or the given `types:`).
+    #
+    # @note Repair is only defined for checksum types; non-checksum types have no
+    #   oracle and are silently skipped.
+    #
+    # @param str [String, nil] the identifier string to repair
+    # @param types [Array<Symbol>, nil] restrict to specific types (non-checksum types are ignored)
+    # @return [Array<Suggestion>] cross-type ranked candidates, each carrying its `type`;
+    #   empty when no format-compatible checksum type matches
+    # @raise [ArgumentError] if any key in types is unknown
+    def suggest(str, types: nil)
+      input = str.to_s.strip.upcase
+      suggestable_types(input, types)
+        .flat_map { |klass| klass.suggest(input) }
+        .sort_by { |suggestion| [Suggestable::RANK.fetch(suggestion.edit), self[suggestion.type].detection_priority.last] }
+    end
+
     private
 
+    # Resolves the checksum types eligible to repair `input` (KTD4): the given `types:`
+    # narrowed to checksum types, or every checksum type whose length and charset admit it.
+    #
+    # @param input [String] the normalized (stripped, upcased) input
+    # @param types [Array<Symbol>, nil]
+    # @return [Array<Class>]
+    def suggestable_types(input, types)
+      return types.map { |key| self[key] }.select(&:has_checksum?) if types
+
+      identifier_list.select do |klass|
+        klass.has_checksum? && klass.length_values.include?(input.length) && input.match?(klass::VALID_CHARS_REGEX)
+      end
+    end
+
     # @return [void]
     def register_identifier(klass)
       identifier_map[klass.type_key] = klass
@@ -195,13 +231,16 @@ module SecID
   end
 end
 
+require 'sec_id/deprecation'
 require 'sec_id/deep_freeze'
 require 'sec_id/errors'
 require 'sec_id/concerns/normalizable'
 require 'sec_id/concerns/validatable'
 require 'sec_id/concerns/checkable'
 require 'sec_id/concerns/generatable'
+require 'sec_id/concerns/suggestable'
 require 'sec_id/base'
+require 'sec_id/suggestion'
 require 'sec_id/detector'
 require 'sec_id/scanner'
 require 'sec_id/isin'
@@ -219,6 +258,7 @@ require 'sec_id/cfi'
 require 'sec_id/fisn'
 require 'sec_id/bic'
 require 'sec_id/dti'
+require 'sec_id/upi'
 
 # Auto-activate the ActiveModel validator inside Rails; a no-op everywhere else (keeps the
 # default require zero-dependency). See SecID::Railtie and lib/sec_id/active_model.rb.

data/sec_id.gemspec

@@ -11,13 +11,14 @@ Gem::Specification.new do |spec|
   spec.email         = ['leonid@svyatov.ru']
 
   spec.summary       = 'A Ruby toolkit for securities identifiers — validate, parse, normalize, detect, convert, ' \
-                       'generate, and classify.'
-  spec.description   = 'Validate, normalize, parse, convert, generate, and classify securities identifiers. ' \
-                       'Auto-detect identifier type from any string. Calculate and restore check digits. Generate ' \
+                       'generate, classify, and repair.'
+  spec.description   = 'Validate, normalize, parse, convert, generate, classify, and repair securities identifiers. ' \
+                       'Auto-detect identifier type from any string. Calculate and restore checksums. Suggest ' \
+                       'confidence-ranked corrections for fat-fingered or OCR-mangled identifiers. Generate ' \
                        'format-valid identifiers as test fixtures. Decode CFI codes to full ISO 10962:2021 ' \
                        'classifications. Includes an opt-in ActiveModel/Rails validator that adds no runtime ' \
                        'dependency. Supports ISIN, CUSIP, CEI, SEDOL, FIGI, LEI, IBAN, CIK, OCC, WKN, Valoren, ' \
-                       'CFI, FISN, BIC, and DTI.'
+                       'CFI, FISN, BIC, DTI, and UPI.'
   spec.homepage      = 'https://github.com/svyatov/sec_id'
   spec.license       = 'MIT'
 

data/sig/sec_id/base.rbs

@@ -42,7 +42,14 @@ module SecID
     def self.length_values: () -> (::Array[Integer] | ::Range[Integer])
     def self.length_specificity: () -> (Integer | Float | nil)
     def self.example: () -> String
+    def self.has_checksum?: () -> bool
+    # Only Suggestable (checksum) types implement `.suggest`; declared here so the
+    # module-level `SecID.suggest` can call it on any registered class object.
+    def self.suggest: (SecID::input str) -> Array[Suggestion]
+
+    # @deprecated v7 bridge alias for `has_checksum?`; removed in v8.
     def self.has_check_digit?: () -> bool
+
     def self.inherited: (singleton(Base) subclass) -> void
 
     def initialize: (SecID::input _sec_id_number) -> void
@@ -54,24 +61,28 @@ module SecID
     def as_json: (*untyped) -> Hash[Symbol, untyped]
     def deconstruct_keys: (::Array[Symbol]? _keys) -> Hash[Symbol, untyped]
 
-    # Check-digit surface. Only the types that `include Checkable` implement these
-    # (they raise/NoMethodError otherwise); declared on Base so `Generatable#generate`
-    # and `Checkable::ClassMethods` type-check without narrowing on `has_check_digit?`.
+    # Checksum / repair surface. Only the types that `include Checkable` /
+    # `include Suggestable` implement these (they raise/NoMethodError otherwise);
+    # declared on Base so `Generatable#generate`, `Checkable::ClassMethods`, and the
+    # Base-self-typed `Suggestable` body type-check without narrowing on `has_checksum?`.
     def restore: () -> String
     def restore!: () -> self
-    def calculate_check_digit: () -> (Integer | String)
+    def calculate_checksum: () -> (Integer | String)
+    attr_reader checksum: (Integer | String)?
+    def suggest: () -> Array[Suggestion]
 
     def comparison_id: () -> String
 
     private
 
+    def components_with_deprecation_bridge: () -> Hash[Symbol, untyped]
     def components: () -> Hash[Symbol, untyped]
     def parse: (SecID::input sec_id_number) -> (::MatchData | ::Hash[Symbol, untyped])
 
     @full_id: String
     @identifier: untyped
     self.@short_name: String
-    self.@has_check_digit: bool
+    self.@has_checksum: bool
     self.@type_key: Symbol
     self.@detection_priority: Array[Integer | Float | nil]
   end

data/sig/sec_id/cei.rbs

@@ -15,7 +15,11 @@ module SecID
     attr_reader entity_id: String?
 
     def initialize: (SecID::input cei) -> void
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 

data/sig/sec_id/concerns/checkable.rbs

@@ -1,26 +1,36 @@
 module SecID
-  # Provides check-digit validation and calculation for identifiers with a check digit.
+  # Provides checksum validation and calculation for identifiers with a checksum.
   module Checkable : SecID::Base
     CHAR_TO_DIGITS: Hash[String, Integer | Array[Integer]]
     CHAR_TO_DIGIT: Hash[String, Integer]
 
     def self.included: (Module base) -> void
 
-    attr_reader check_digit: (Integer | String)?
+    # `attr_reader checksum` is declared on Base (the repair surface) to keep the
+    # Base-self-typed Suggestable body type-checking; not redeclared here.
 
     # Class methods added when Checkable is included.
     module ClassMethods : SecID::_IdentifierClass
-      def restore: (SecID::input id_without_check_digit) -> String
-      def restore!: (SecID::input id_without_check_digit) -> Base
+      def restore: (SecID::input id_without_checksum) -> String
+      def restore!: (SecID::input id_without_checksum) -> Base
+      def checksum: (SecID::input id) -> (Integer | String)
+
+      # @deprecated v7 bridge alias for `checksum`; removed in v8.
       def check_digit: (SecID::input id) -> (Integer | String)
     end
 
     def valid?: () -> bool
     def restore: () -> String
     def restore!: () -> self
-    def calculate_check_digit: () -> (Integer | String)
+    def calculate_checksum: () -> (Integer | String)
     def to_s: () -> String
 
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
+    def check_digit: () -> (Integer | String)?
+
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
+    def calculate_check_digit: () -> (Integer | String)
+
     private
 
     def luhn_sum_double_add_double: (Array[Integer] digits) -> Integer
@@ -29,13 +39,14 @@ module SecID
     def reversed_digits_single: (untyped id) -> Array[Integer]
     def reversed_digits_multi: (untyped id) -> Array[Integer]
     def error_codes: () -> Array[Symbol]
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def validation_message: (Symbol code) -> String?
     def validate_format_for_calculation!: () -> void
     def mod10: (Integer sum) -> Integer
     def div10mod10: (Integer number) -> Integer
     def mod97: (String numeric_string) -> Integer
+    def mod31_30_check_char: (untyped base, Array[String] alphabet, Hash[String, Integer] alphabet_value) -> String
 
-    @check_digit: (Integer | String)?
+    @checksum: (Integer | String)?
   end
 end

data/sig/sec_id/concerns/generatable.rbs

@@ -10,7 +10,7 @@ module SecID
     # The class-object surface Generatable's methods call once extended.
     interface _GeneratableClass
       def new: (SecID::input) -> Base
-      def has_check_digit?: () -> bool
+      def has_checksum?: () -> bool
     end
 
     # Class methods added when Generatable is included.

data/sig/sec_id/concerns/suggestable.rbs

@@ -0,0 +1,32 @@
+module SecID
+  # Repair engine for checksum-failing identifiers: enumerates plausible edits and
+  # returns the re-validating ones as confidence-ranked Suggestion objects.
+  module Suggestable : SecID::Base
+    HOMOGLYPHS: Hash[String, Array[String]]
+    RANK: Hash[Symbol, Integer]
+
+    def self.included: (Module base) -> void
+
+    # Class methods added when Suggestable is included.
+    module ClassMethods : SecID::_IdentifierClass
+      def suggest: (SecID::input str) -> Array[Suggestion]
+    end
+
+    def suggest: () -> Array[Suggestion]
+
+    private
+
+    def candidate_strings: () -> Array[String]
+    def homoglyph_candidates: () -> Array[String]
+    def transposition_candidates: () -> Array[String]
+    def replace_at: (String str, Integer index, String char) -> String
+    def swap_at: (String str, Integer index) -> String
+    def classify: (Base candidate) -> Suggestion?
+    def changed_indices: (Base candidate) -> Array[Integer]
+    def substitution_suggestion: (Base candidate, Integer index) -> Suggestion
+    def transposition_suggestion: (Base candidate, Array[Integer] indices) -> Suggestion?
+    def swap?: (Base candidate, Integer left, Integer right) -> bool
+    def checksum_suggestion: (Base candidate) -> Suggestion
+    def rendered_checksum: ((Integer | String)? value) -> String
+  end
+end

data/sig/sec_id/concerns/validatable.rbs

@@ -33,7 +33,7 @@ module SecID
     def detect_errors: () -> Array[Symbol]
     def valid_length?: () -> bool
     def valid_characters?: () -> bool
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def validation_message: (Symbol code) -> String?
     def build_error: (Symbol code, String? message) -> Errors::detail
 

data/sig/sec_id/cusip.rbs

@@ -16,7 +16,11 @@ module SecID
 
     def initialize: (SecID::input cusip) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
     def to_isin: (String country_code) -> ISIN

data/sig/sec_id/deprecation.rbs

@@ -0,0 +1,6 @@
+module SecID
+  # Emits standardized, silenceable deprecation warnings for the v7 → v8 rename bridge.
+  module Deprecation
+    def self.warn: (old: String, new: String, ?removed_in: String) -> void
+  end
+end

data/sig/sec_id/dti.rbs

@@ -15,13 +15,18 @@ module SecID
     GRANDFATHERED_CODES: Hash[String, String]
 
     def initialize: (SecID::input dti) -> void
+    def calculate_checksum: () -> String
+    def self.checksum: (SecID::input id) -> String
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> String
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
+    def self.check_digit: (SecID::input id) -> String
     private def self.generate_body: (Random random) -> String
 
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def grandfathered_check_digit: (untyped base) -> String?
+    def grandfathered_checksum: (untyped base) -> String?
     def iso7064_mod31_30_check_char: (untyped base) -> String
   end
 end

data/sig/sec_id/figi.rbs

@@ -17,7 +17,11 @@ module SecID
 
     def initialize: (SecID::input figi) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 

data/sig/sec_id/iban.rbs

@@ -26,7 +26,11 @@ module SecID
 
     def initialize: (SecID::input iban) -> void
     def restore: () -> String
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
     def valid_bban_format?: () -> bool
@@ -38,13 +42,13 @@ module SecID
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def valid_format?: () -> bool
     def detect_errors: () -> Array[Symbol]
     def validation_message: (Symbol code) -> String?
-    def extract_check_digit_and_bban: (String rest) -> void
+    def extract_checksum_and_bban: (String rest) -> void
     def expected_bban_length_for_country: () -> Integer?
-    def check_digits?: (untyped rest, Integer? expected_bban_length) -> bool
+    def checksum?: (untyped rest, Integer? expected_bban_length) -> bool
     def extract_bban_components: () -> void
     def valid_bban_length_only?: () -> bool
     def numeric_string_for_check: () -> String

data/sig/sec_id/isin.rbs

@@ -19,7 +19,11 @@ module SecID
 
     def initialize: (SecID::input isin) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
     def to_cusip: () -> CUSIP

data/sig/sec_id/lei.rbs

@@ -20,14 +20,18 @@ module SecID
 
     def initialize: (SecID::input lei) -> void
     def to_pretty_s: () -> String?
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 
     private
 
     def components: () -> Hash[Symbol, untyped]
-    def check_digit_width: () -> Integer
+    def checksum_width: () -> Integer
     def numeric_identifier: () -> String
   end
 end

data/sig/sec_id/sedol.rbs

@@ -19,7 +19,11 @@ module SecID
 
     def initialize: (SecID::input sedol) -> void
     def to_isin: (?String country_code) -> ISIN
+    def calculate_checksum: () -> Integer
+    def self.checksum: (SecID::input id) -> Integer
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
     def calculate_check_digit: () -> Integer
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
     def self.check_digit: (SecID::input id) -> Integer
     private def self.generate_body: (Random random) -> String
 

data/sig/sec_id/suggestion.rbs

@@ -0,0 +1,23 @@
+module SecID
+  # Immutable value object representing one repair candidate returned by `suggest`.
+  class Suggestion < Data
+    EDIT_KINDS: Array[Symbol]
+    CONFIDENCE_LEVELS: Array[Symbol]
+
+    attr_reader type: Symbol
+    attr_reader identifier: Base
+    attr_reader edit: Symbol
+    attr_reader position: Integer?
+    attr_reader from: String
+    attr_reader to: String
+    attr_reader confidence: Symbol?
+
+    def self.new: (type: Symbol, identifier: Base, edit: Symbol, position: Integer?, from: String, to: String, confidence: Symbol?) -> instance
+                | (Symbol type, Base identifier, Symbol edit, Integer? position, String from, String to, Symbol? confidence) -> instance
+    def self.[]: (type: Symbol, identifier: Base, edit: Symbol, position: Integer?, from: String, to: String, confidence: Symbol?) -> instance
+               | (Symbol type, Base identifier, Symbol edit, Integer? position, String from, String to, Symbol? confidence) -> instance
+
+    def as_json: (*untyped) -> Hash[Symbol, untyped]
+    def to_s: () -> String
+  end
+end

data/sig/sec_id/upi.rbs

@@ -0,0 +1,29 @@
+module SecID
+  # Unique Product Identifier (UPI, ISO 4914).
+  class UPI < Base
+    include Checkable
+    extend Checkable::ClassMethods
+
+    FULL_NAME: String
+    ID_LENGTH: Integer
+    EXAMPLE: String
+    VALID_CHARS_REGEX: ::Regexp
+    ID_REGEX: ::Regexp
+    ALPHABET: Array[String]
+    ALPHABET_VALUE: Hash[String, Integer]
+    GENERATE_CHARSET: Array[String]
+
+    def initialize: (SecID::input upi) -> void
+    def calculate_checksum: () -> String
+    def self.checksum: (SecID::input id) -> String
+    # @deprecated v7 bridge alias for `calculate_checksum`; removed in v8.
+    def calculate_check_digit: () -> String
+    # @deprecated v7 bridge alias for `checksum`; removed in v8.
+    def self.check_digit: (SecID::input id) -> String
+    private def self.generate_body: (Random random) -> String
+
+    private
+
+    def components: () -> Hash[Symbol, untyped]
+  end
+end