mailschema 0.2.0

data/schemas/type-contract-0.2.schema.json

@@ -0,0 +1,179 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://mailschema.org/schemas/type-contract-0.2.schema.json",
+  "title": "MailSchema type contract for MAP 0.2",
+  "description": "A versioned interaction contract: the details, inputs, results, authority, repeatability and consequences of each operation, with every schema it depends on pinned by digest.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "kind": {
+      "const": "MapTypeContract"
+    },
+    "id": {
+      "type": "string",
+      "pattern": "^https://mailschema\\.org/types/[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "maxLength": 2048
+    },
+    "version": {
+      "type": "string",
+      "pattern": "^[0-9]+\\.[0-9]+(?:\\.[0-9]+)?(?:-[a-zA-Z0-9.-]+)?$",
+      "maxLength": 80
+    },
+    "profile": {
+      "const": "https://mailschema.org/profiles/map/0.2"
+    },
+    "target": {
+      "$ref": "#/$defs/prose"
+    },
+    "dependencies": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 20,
+      "items": {
+        "$ref": "#/$defs/schemaReference"
+      }
+    },
+    "detailsSchema": {
+      "type": "object"
+    },
+    "requestSchema": {
+      "$ref": "#/$defs/schemaReference"
+    },
+    "operations": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 100,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "id": {
+            "$ref": "#/$defs/token"
+          },
+          "effect": {
+            "$ref": "#/$defs/prose"
+          },
+          "authority": {
+            "type": "array",
+            "items": {
+              "enum": ["credential", "possession"]
+            },
+            "minItems": 1,
+            "maxItems": 2,
+            "uniqueItems": true
+          },
+          "consequences": {
+            "type": "array",
+            "items": {
+              "enum": [
+                "refusal",
+                "protection",
+                "record",
+                "disclosure",
+                "commitment",
+                "authorization",
+                "assertion"
+              ]
+            },
+            "minItems": 1,
+            "maxItems": 7,
+            "uniqueItems": true
+          },
+          "repeatable": {
+            "type": "boolean"
+          },
+          "fieldBindings": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 10,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "input": {
+                  "$ref": "#/$defs/pointer"
+                },
+                "fields": {
+                  "$ref": "#/$defs/pointer"
+                }
+              },
+              "required": ["input", "fields"]
+            }
+          },
+          "results": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 5,
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "properties": {
+                "state": {
+                  "enum": ["accepted", "completed", "failed", "pending", "approval-required"]
+                },
+                "reasons": {
+                  "type": "array",
+                  "items": {
+                    "$ref": "#/$defs/token"
+                  },
+                  "minItems": 1,
+                  "maxItems": 20,
+                  "uniqueItems": true
+                },
+                "outputSchema": {
+                  "type": "object"
+                }
+              },
+              "required": ["state", "outputSchema"]
+            }
+          }
+        },
+        "required": ["id", "effect", "authority", "consequences", "results"]
+      }
+    }
+  },
+  "required": [
+    "kind",
+    "id",
+    "version",
+    "profile",
+    "target",
+    "dependencies",
+    "requestSchema",
+    "operations"
+  ],
+  "$defs": {
+    "prose": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 12000,
+      "pattern": "[^\\t\\n\\u000b\\f\\r \\u00a0\\u1680\\u2000-\\u200a\\u2028\\u2029\\u202f\\u205f\\u3000\\ufeff]"
+    },
+    "token": {
+      "type": "string",
+      "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$",
+      "maxLength": 100
+    },
+    "pointer": {
+      "type": "string",
+      "pattern": "^(?:/(?:[^~/]|~[01])*)+$",
+      "maxLength": 1000
+    },
+    "schemaReference": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "url": {
+          "type": "string",
+          "pattern": "^https://mailschema\\.org/schemas/[a-z0-9.-]+\\.json$",
+          "maxLength": 2048
+        },
+        "canonicalDigest": {
+          "type": "string",
+          "pattern": "^sha-256:[a-f0-9]{64}$"
+        }
+      },
+      "required": ["url", "canonicalDigest"]
+    }
+  }
+}

data/sig/mailschema.rbs

@@ -0,0 +1,92 @@
+# Mail Action Protocol 0.2 tooling.
+module Mailschema
+  type json = Hash[String, untyped] | Array[untyped] | String | Integer | Float | bool | nil
+  type document = Hash[String, untyped]
+  type input_error = Hash[String, String]
+
+  VERSION: String
+
+  PROFILE: String
+  CORE_SCHEMA: String
+  FORMS_SCHEMA: String
+  CONTRACT_FORMAT: String
+  CONTEXT: String
+  CONTRIBUTION_SCHEMA: String
+  ARTIFACTS: Hash[String, String]
+  APPROVAL_REASONS: Array[String]
+  PROBLEM_STATUS: Hash[String, Integer]
+  PROBLEM_TYPES: String
+  NON_TERMINAL_STATES: Array[String]
+  MAX_BYTES: Integer
+  MAX_DEPTH: Integer
+  EXACT_NUMBER: Integer
+
+  class Error < StandardError
+  end
+
+  class InvalidDocument < Error
+  end
+
+  class InvalidContract < Error
+  end
+
+  def self.parse: (String json) -> json
+  def self.canonicalize: (json value) -> String
+  def self.digest: (json value) -> String
+  def self.reached?: (Time now, untyped deadline, ?after: Numeric) -> bool
+
+  def self.artifact: (String url) -> String
+  def self.document: (String url) -> document
+
+  def self.map_errors: (untyped document) -> Array[String]
+  def self.description_errors: (untyped description) -> Array[String]
+  def self.request_errors: (untyped request) -> Array[String]
+  def self.result_errors: (untyped result) -> Array[String]
+  def self.problem_errors: (untyped problem) -> Array[String]
+  def self.request_id?: (untyped value) -> bool
+
+  def self.capability: (document description) -> String
+  def self.written_path: (String? url) -> String
+
+  def self.result: (document request, state: String, target: document, result_url: String, recorded_at: Time,
+                    ?output: document, ?reason: String?, ?approval_url: String?, ?actor: String?) -> document
+  def self.transition: (document result, state: String, recorded_at: Time, ?reason: String?, ?output: document) -> document
+  def self.problem: (String code, title: String, detail: String, ?request_id: String?, ?interaction_id: String?,
+                     ?result_url: String?, ?target: document?, ?errors: Array[input_error]?) -> document
+  def self.result_status: (document result) -> Integer
+  def self.json_request?: (String? content_type) -> bool
+  DESCRIPTION_MEDIA_TYPE: String
+  def self.description_part?: (String? media_type, String? profile_parameter) -> bool
+  def self.result_url: (document description, String request_id) -> String
+  def self.retain_until: (document description, Time recorded_at) -> Time
+  def self.settle: (document result, document description, Time now) -> document?
+
+  # A type contract an implementation vendors, verified by digest and compiled once.
+  class Contract
+    # A MAP problem a request earns before the service's own state is consulted.
+    class Problem < Data
+      attr_reader code: String
+      attr_reader title: String
+      attr_reader detail: String
+
+      def self.new: (String code, String title, String detail) -> instance
+                  | (code: String, title: String, detail: String) -> instance
+    end
+
+    attr_reader document: document
+    attr_reader digest: String
+    attr_reader request_schema: document
+
+    def initialize: (document contract, document request_schema, digest: String,
+                     ?dependencies: Hash[String, document]) -> void
+    def id: () -> String
+    def version: () -> String
+    def type_reference: () -> Hash[String, String]
+    def operation: (String? id) -> document?
+    def decision?: (String id) -> bool
+    def description_errors: (document description) -> Array[String]
+    def request_problem: (document description, document request, now: Time) -> Problem?
+    def input_errors: (document description, document request) -> Array[input_error]
+    def result_errors: (document result) -> Array[String]
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: mailschema
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- MailSchema contributors
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bigdecimal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.21'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: json_schemer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Parse, canonicalize, digest and validate Mail Action Protocol 0.2 documents,
+  verify the type contracts an implementation vendors, and build results and problems.
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- contexts/map-0.2.jsonld
+- lib/mailschema.rb
+- lib/mailschema/artifacts.rb
+- lib/mailschema/capability.rb
+- lib/mailschema/contract.rb
+- lib/mailschema/document.rb
+- lib/mailschema/documents.rb
+- lib/mailschema/forms.rb
+- lib/mailschema/http.rb
+- lib/mailschema/jcs.rb
+- lib/mailschema/limits.rb
+- lib/mailschema/message.rb
+- lib/mailschema/pointer.rb
+- lib/mailschema/references.rb
+- lib/mailschema/schema_walk.rb
+- lib/mailschema/version.rb
+- schemas/contribution.schema.json
+- schemas/forms-0.1.schema.json
+- schemas/map-0.2.schema.json
+- schemas/type-contract-0.2.schema.json
+- sig/mailschema.rbs
+homepage: https://mailschema.org/tools
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://mailschema.org/tools
+  source_code_uri: https://github.com/mailschema/ruby
+  changelog_uri: https://github.com/mailschema/ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/mailschema/ruby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: Mail Action Protocol 0.2 tooling
+test_files: []