@haneinfo/assignment 0.0.0-stage → 0.1.0

package/schemas/assignment.spec.json

@@ -0,0 +1,104 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "title": "Assignment spec",
+  "description": "When an instance of the referenced StateMachine enters onEnter, the assignees get a task; their response takes the response's transition.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["stateMachine", "onEnter", "assignees", "policy", "responses"],
+  "properties": {
+    "stateMachine": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["kind", "code"],
+      "properties": {
+        "kind": { "const": "StateMachine" },
+        "code": { "type": "string", "pattern": "^[a-z][a-z0-9]*(?:-[a-z0-9]+)*$" }
+      }
+    },
+    "onEnter": {
+      "type": "string",
+      "minLength": 1,
+      "description": "State key; entering it opens the tasks."
+    },
+    "title": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200,
+      "description": "Task title shown to the assignees. Defaults to metadata.name."
+    },
+    "assignees": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 20,
+      "items": {
+        "oneOf": [
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type", "userIds"],
+            "properties": {
+              "type": { "const": "SPECIFIC_USER" },
+              "userIds": {
+                "type": "array",
+                "minItems": 1,
+                "items": { "type": "string", "minLength": 1 }
+              }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type", "role"],
+            "properties": {
+              "type": { "const": "ROLE" },
+              "role": { "type": "string", "pattern": "^[A-Z][A-Z0-9_]*$" }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type", "fieldId"],
+            "properties": {
+              "type": { "const": "FORM_FIELD_USER" },
+              "fieldId": { "type": "string", "minLength": 1 }
+            }
+          },
+          {
+            "type": "object",
+            "additionalProperties": false,
+            "required": ["type"],
+            "properties": { "type": { "const": "SUBMITTER" } }
+          }
+        ]
+      }
+    },
+    "policy": {
+      "enum": ["SINGLE", "ANY_ONE", "JOINT"],
+      "description": "SINGLE and ANY_ONE: the first response decides. JOINT: everyone must give the non-decisive response; one decisive response decides at once."
+    },
+    "responses": {
+      "type": "array",
+      "minItems": 1,
+      "maxItems": 10,
+      "items": {
+        "type": "object",
+        "additionalProperties": false,
+        "required": ["key", "label", "transition"],
+        "properties": {
+          "key": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_]*$" },
+          "label": { "type": "string", "minLength": 1, "maxLength": 200 },
+          "transition": { "type": "string", "minLength": 1 },
+          "decisive": {
+            "type": "boolean",
+            "description": "JOINT only: this response completes the assignment at once (e.g. reject)."
+          }
+        }
+      }
+    },
+    "dueIn": {
+      "type": "string",
+      "pattern": "^P(?:(\\d+)W)?(?:(\\d+)D)?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+)S)?)?$",
+      "description": "ISO 8601 duration from opening to the due time, e.g. P2D. What happens when it passes is a Timer's job."
+    }
+  }
+}

package/testing.d.ts

@@ -0,0 +1,2 @@
+// See plugin.js for why this file exists (classic/node10 moduleResolution compatibility shim).
+export * from './dist/testing';

package/testing.js

@@ -0,0 +1,2 @@
+// Compatibility shim for classic/node10 moduleResolution; see plugin.js.
+module.exports = require('./dist/testing');

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.