@velocitycareerlabs/libapp 1.25.0-dev-build.19bf8182a → 1.25.0-dev-build.19f697124

package/schemas/assessment.schema.json

@@ -0,0 +1,154 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "title": "Assessment",
+  "$id": "assessment",
+  "type": "object",
+  "definitions": {
+    "DID": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "MultiLingualString": {
+      "type": "object",
+      "properties": {
+        "localized": {
+          "type": "object",
+          "propertyNames": {
+            "pattern": "^[a-z]{2}(_[A-Z]{2})?$"
+          },
+          "additionalProperties": {
+            "type": "string"
+          }
+        },
+        "preferredLocale": {
+          "type": "object",
+          "properties": {
+            "country": {
+              "type": "string",
+              "pattern": "^[A-Z]{2}$"
+            },
+            "language": {
+              "type": "string",
+              "pattern": "^[a-z]{2}$"
+            }
+          }
+        }
+      },
+      "additionalProperties": false,
+      "required": [
+        "localized"
+      ]
+    },
+    "Alignment": {
+      "type": "object",
+      "properties": {
+        "targetName": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "http://www.corestandards.org/ELA-Literacy/RST/11-12/3"
+        },
+        "targetDescription": {
+          "type": "string",
+          "description": "A description of the ELA ltieracy certification."
+        },
+        "targetCode": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetFramework": {
+          "type": "string",
+          "description": "Mozilla 21st Century Skills"
+        }
+      },
+      "required": [
+        "targetName",
+        "targetUrl"
+      ],
+      "additionalProperties": false
+    },
+    "Date": {
+      "type": "object",
+      "properties": {
+        "day": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 31
+        },
+        "month": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 12
+        },
+        "year": {
+          "type": "integer",
+          "minimum": 1950
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "type": {
+      "type": "string",
+      "default": "Assessment"
+    },
+    "name": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "description": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "authority": {
+      "$ref": "#/definitions/DID"
+    },
+    "authorityName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "normName": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "normDescription": {
+      "$ref": "#/definitions/MultiLingualString"
+    },
+    "normSize": {
+      "type": "integer"
+    },
+    "percentileScore": {
+      "type": "number"
+    },
+    "absoluteScore": {
+      "type": "number"
+    },
+    "passFail": {
+      "type": "string",
+      "enum": [
+        "PASS",
+        "FAIL"
+      ]
+    },
+    "scoreRange": {
+      "type": "string",
+      "description": "^[0-9]+-[1-9][0-9]*"
+    },
+    "alignment": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "$ref": "#/definitions/Alignment"
+      }
+    },
+    "assessmentDate": {
+      "$ref": "#/definitions/Date"
+    }
+  },
+  "required": [
+    "name",
+    "authority",
+    "authorityName",
+    "assessmentDate"
+  ]
+}

package/schemas/badge-v1.1.schema.json

@@ -0,0 +1,243 @@
+{
+  "title": "Badge",
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Badge",
+  "$id": "https://velocitynetwork.foundation/schemas/badge-v1.1",
+  "type": "object",
+  "definitions": {
+    "obiProfile": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri",
+          "description": "https://example.com/profiles/alice",
+          "maxLength": 2048
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "Profile",
+            "Issuer"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "description": "Example Issuer",
+          "maxLength": 128
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "http://example.com",
+          "maxLength": 2048
+        },
+        "email": {
+          "type": "string",
+          "format": "email",
+          "description": "test@example.com",
+          "maxLength": 256
+        },
+        "image": {
+          "type": "string",
+          "format": "uri",
+          "maxLength": 2048
+        }
+      },
+      "required": [
+        "id",
+        "type"
+      ],
+      "additionalProperties": false
+    },
+    "Json-ld-context_Schema": {
+      "title": "json-ld-context",
+      "oneOf": [
+        {
+          "type": "string",
+          "maxLength": 2048
+        },
+        {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 2048
+          }
+        }
+      ],
+      "description": "Simplified context for Velocity Publishers to Use"
+    },
+    "Alignment_Schema": {
+      "title": "Alignment",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "AlignmentObject"
+        },
+        "targetName": {
+          "type": "string",
+          "description": "Name of the target alignment.",
+          "maxLength": 256
+        },
+        "targetUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "URL of the target alignment. ",
+          "maxLength": 2048
+        },
+        "targetDescription": {
+          "type": "string",
+          "description": "Detailed description of the target alignment. ",
+          "maxLength": 2048
+        },
+        "targetCode": {
+          "type": "string",
+          "description": "Code of the target alignment. ",
+          "maxLength": 256
+        },
+        "targetFramework": {
+          "type": "string",
+          "description": "The framework to which the target belongs. ",
+          "maxLength": 256
+        }
+      },
+      "required": [
+        "targetName",
+        "targetUrl"
+      ]
+    },
+    "PersonName_Schema": {
+      "title": "Person name",
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "type": {
+          "type": "string",
+          "default": "PersonName"
+        },
+        "givenName": {
+          "type": "string",
+          "description": "The given name or first name of the person.",
+          "maxLength": 64
+        },
+        "familyName": {
+          "type": "string",
+          "description": "The family name or surname of the person.",
+          "maxLength": 64
+        },
+        "middleName": {
+          "type": "string",
+          "description": "The middle name of the person.",
+          "maxLength": 256
+        },
+        "namePrefix": {
+          "type": "string",
+          "description": "A prefix to the name such as Dr or Sir.",
+          "maxLength": 8
+        },
+        "nameSuffix": {
+          "type": "string",
+          "description": "A suffix to the name such as Jr. or Sr.",
+          "maxLength": 16
+        }
+      },
+      "required": [
+        "givenName",
+        "familyName"
+      ]
+    }
+  },
+  "additionalProperties": false,
+  "properties": {
+    "@context": {
+      "$ref": "#/definitions/Json-ld-context_Schema"
+    },
+    "type": {
+      "type": "string",
+      "default": "Badge"
+    },
+    "recipient": {
+      "$ref": "#/definitions/PersonName_Schema"
+    },
+    "hasCredential": {
+      "type": "object",
+      "required": [
+        "type",
+        "name",
+        "description",
+        "image",
+        "criteria",
+        "issuer"
+      ],
+      "properties": {
+        "@context": {
+          "$ref": "#/definitions/Json-ld-context_Schema"
+        },
+        "type": {
+          "type": "string",
+          "default": "BadgeClass",
+          "description": "valid JSON-LD representation of the BadgeClass type. In most cases, this will simply be the string BadgeClass. An array including BadgeClass and other string elements that are either URLs or compact IRIs within the current context are allowed.",
+          "maxLength": 64
+        },
+        "id": {
+          "type": "string",
+          "format": "uri",
+          "description": "Unique IRI for the BadgeClass. Most platforms to date can only handle HTTP-based IRIs. Issuers using signed assertions are encouraged to publish BadgeClasses using HTTP IRIs but may instead use ephemeral BadgeClasses that use an id in another scheme such as urn:uuid.",
+          "maxLength": 2048
+        },
+        "name": {
+          "type": "string",
+          "maxLength": 128,
+          "description": "The name of the achievement."
+        },
+        "description": {
+          "type": "string",
+          "maxLength": 2048,
+          "description": "A short description of the achievement."
+        },
+        "image": {
+          "type": "string",
+          "format": "uri",
+          "description": "IRI or document representing an image of the achievement. This must be a PNG or SVG image.",
+          "maxLength": 2048
+        },
+        "criteria": {
+          "type": "string",
+          "description": "https://example.org/robotics-badge.html",
+          "format": "uri",
+          "maxLength": 2048
+        },
+        "issuer": {
+          "type": "string",
+          "format": "uri",
+          "description": "The organization that issued the badge. On Velocity Network this must be DID",
+          "maxLength": 2048
+        },
+        "alignment": {
+          "type": "array",
+          "description": "An array of objects describing which objectives or educational standards this badge aligns to, if any.",
+          "minItems": 1,
+          "items": {
+            "$ref": "#/definitions/Alignment_Schema"
+          }
+        },
+        "tags": {
+          "type": "array",
+          "description": "Tags that describes the type of achievement.",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "maxLength": 64
+          }
+        }
+      }
+    }
+  },
+  "required": [
+    "hasCredential",
+    "recipient"
+  ]
+}

package/schemas/badge.schema.json

@@ -0,0 +1,152 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "description": "Badge",
+  "$id": "badge",
+  "type": "object",
+  "definitions": {
+    "DID": {
+      "type": "string",
+      "pattern": "^did:[a-z0-9]+:[A-Za-z0-9._:?=&%;-]+$"
+    },
+    "obiAlignment": {
+      "type": "object",
+      "properties": {
+        "targetName": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetUrl": {
+          "type": "string",
+          "format": "uri",
+          "description": "http://www.corestandards.org/ELA-Literacy/RST/11-12/3"
+        },
+        "targetDescription": {
+          "type": "string",
+          "description": "A description of the ELA ltieracy certification."
+        },
+        "targetCode": {
+          "type": "string",
+          "description": "CCSS.ELA-Literacy.RST.11-12.3"
+        },
+        "targetFramework": {
+          "type": "string",
+          "description": "Mozilla 21st Century Skills"
+        }
+      },
+      "required": [
+        "targetName",
+        "targetUrl"
+      ],
+      "additionalProperties": false
+    },
+    "obiProfile": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri",
+          "description": "https://example.com/profiles/alice"
+        },
+        "type": {
+          "type": "string",
+          "enum": [
+            "Profile",
+            "Issuer"
+          ]
+        },
+        "name": {
+          "type": "string",
+          "description": "Example Issuer"
+        },
+        "url": {
+          "type": "string",
+          "format": "uri",
+          "description": "http://example.com"
+        },
+        "email": {
+          "type": "string",
+          "format": "email",
+          "description": "test@example.com"
+        },
+        "image": {
+          "type": "string",
+          "format": "uri"
+        }
+      },
+      "required": [
+        "id",
+        "type"
+      ],
+      "additionalProperties": false
+    }
+  },
+  "properties": {
+    "holds": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string",
+          "format": "uri"
+        },
+        "type": {
+          "type": "string"
+        },
+        "name": {
+          "type": "string",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "description": {
+          "type": "string",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "image": {
+          "type": "string",
+          "format": "uri"
+        },
+        "criteria": {
+          "type": "string",
+          "description": "https://example.org/robotics-badge.html",
+          "pattern": "^[a-zA-Z0-9\\s]*$",
+          "maxLength": 64
+        },
+        "issuer": {
+          "oneOf": [
+            {
+              "type": "string",
+              "format": "uri"
+            },
+            {
+              "$ref": "#/definitions/obiProfile"
+            }
+          ]
+        },
+        "tags": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "alignment": {
+          "type": "array",
+          "items": {
+            "$ref": "#/definitions/obiAlignment"
+          }
+        }
+      },
+      "required": [
+        "type",
+        "name",
+        "description",
+        "image",
+        "criteria",
+        "issuer"
+      ]
+    }
+  },
+  "required": [
+    "holds"
+  ],
+  "additionalProperties": false
+}