npm - @multiagency/sdk - Versions diffs - 0.3.1 - Mend

@multiagency/sdk 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (78) hide show

package/CHANGES.md +21 -0
package/LICENSE +21 -0
package/README.md +142 -0
package/THIRD-PARTY-NOTICES +127 -0
package/bin/release-server.d.mts +29 -0
package/bin/release-server.mjs +143 -0
package/dist/compensation-contract.d.ts +370 -0
package/dist/compensation-contract.js +51 -0
package/dist/contract/agent-connection.d.ts +86 -0
package/dist/contract/agent-connection.js +36 -0
package/dist/contract/app-access.d.ts +141 -0
package/dist/contract/app-access.js +57 -0
package/dist/contract/app-client.d.ts +140 -0
package/dist/contract/app-client.js +61 -0
package/dist/contract/app-consent.d.ts +68 -0
package/dist/contract/app-consent.js +91 -0
package/dist/contract/assets.d.ts +6 -0
package/dist/contract/assets.js +6 -0
package/dist/contract/client.d.ts +347 -0
package/dist/contract/client.js +81 -0
package/dist/contract/gateway.d.ts +74 -0
package/dist/contract/gateway.js +47 -0
package/dist/contract/index.d.ts +26 -0
package/dist/contract/index.js +25 -0
package/dist/contract/inputs.d.ts +230 -0
package/dist/contract/inputs.js +99 -0
package/dist/contract/intents-account.d.ts +5 -0
package/dist/contract/intents-account.js +8 -0
package/dist/contract/orpc-client.js +2037 -0
package/dist/contract/owner-capabilities.d.ts +81 -0
package/dist/contract/owner-capabilities.js +33 -0
package/dist/contract/owner-client.d.ts +99 -0
package/dist/contract/owner-client.js +146 -0
package/dist/contract/owner-contract.d.ts +1156 -0
package/dist/contract/owner-contract.js +37 -0
package/dist/contract/owner-inputs.d.ts +166 -0
package/dist/contract/owner-inputs.js +1 -0
package/dist/contract/owner-outputs.d.ts +5749 -0
package/dist/contract/owner-outputs.js +751 -0
package/dist/contract/package-version.d.ts +5 -0
package/dist/contract/package-version.js +2 -0
package/dist/contract/payee-entry.d.ts +10 -0
package/dist/contract/payee-entry.js +10 -0
package/dist/contract/payee.d.ts +326 -0
package/dist/contract/payee.js +32 -0
package/dist/contract/permissions.d.ts +20 -0
package/dist/contract/permissions.js +64 -0
package/dist/contract/proposals.d.ts +178 -0
package/dist/contract/proposals.js +27 -0
package/dist/contract/run-log-schema.d.ts +888 -0
package/dist/contract/run-log-schema.js +150 -0
package/dist/contract/run-progress-schema.d.ts +104 -0
package/dist/contract/run-progress-schema.js +20 -0
package/dist/payee-contract.d.ts +9 -0
package/dist/payee-contract.js +15 -0
package/package.json +58 -0
package/provenance.json +61 -0
package/schemas/agentConnection.json +76 -0
package/schemas/agentConnectionIssue.json +22 -0
package/schemas/agentConnectionList.json +88 -0
package/schemas/agentConnectionStarted.json +90 -0
package/schemas/compensationSend.json +40 -0
package/schemas/errorBody.json +16 -0
package/schemas/fileResult.json +67 -0
package/schemas/invoicesView.json +130 -0
package/schemas/ownerCompensationView.json +556 -0
package/schemas/payeeCompensationView.json +546 -0
package/schemas/payeeWorkOrderRequest.json +31 -0
package/schemas/publicWorkOrder.json +94 -0
package/schemas/reportCommand.json +82 -0
package/schemas/requestRecord.json +149 -0
package/schemas/session.json +20 -0
package/schemas/workOrderList.json +43 -0
package/schemas/workOrderRequestResult.json +20 -0
package/skills/app-server/SKILL.md +190 -0
package/skills/getting-started/SKILL.md +90 -0
package/skills/owner-workflows/SKILL.md +157 -0
package/skills/payee-workflows/SKILL.md +200 -0

package/schemas/payeeCompensationView.json ADDED Viewed

@@ -0,0 +1,546 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "account": {
+      "type": "string"
+    },
+    "agreements": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+          },
+          "version": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "terms": {
+            "type": "object",
+            "properties": {
+              "payee": {
+                "type": "string",
+                "pattern": "^(?=.{2,64}$)([a-z\\d]+[-_])*[a-z\\d]+(\\.([a-z\\d]+[-_])*[a-z\\d]+)*$"
+              },
+              "title": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 160
+              },
+              "document": {
+                "type": "string",
+                "maxLength": 1000,
+                "format": "uri"
+              },
+              "signedOn": {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+              },
+              "start": {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+              },
+              "end": {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+              },
+              "ceiling": {
+                "type": "string",
+                "pattern": "^[1-9][0-9]{0,17}$"
+              },
+              "openingApproved": {
+                "type": "string",
+                "pattern": "^(0|[1-9][0-9]{0,17})$"
+              },
+              "scope": {
+                "type": "string",
+                "maxLength": 2000
+              }
+            },
+            "required": [
+              "payee",
+              "title",
+              "document",
+              "signedOn",
+              "start",
+              "end",
+              "ceiling",
+              "openingApproved",
+              "scope"
+            ],
+            "additionalProperties": false
+          },
+          "recordedBy": {
+            "type": "string"
+          },
+          "at": {
+            "type": "string"
+          },
+          "approved": {
+            "type": "string",
+            "pattern": "^\\d+$"
+          },
+          "remaining": {
+            "type": "string",
+            "pattern": "^\\d+$"
+          }
+        },
+        "required": [
+          "id",
+          "version",
+          "terms",
+          "recordedBy",
+          "at",
+          "approved",
+          "remaining"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "requests": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string",
+            "format": "uuid",
+            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+          },
+          "version": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "payee": {
+            "type": "string",
+            "pattern": "^(?=.{2,64}$)([a-z\\d]+[-_])*[a-z\\d]+(\\.([a-z\\d]+[-_])*[a-z\\d]+)*$"
+          },
+          "agreementVersion": {
+            "type": "integer",
+            "exclusiveMinimum": 0,
+            "maximum": 9007199254740991
+          },
+          "report": {
+            "type": "object",
+            "properties": {
+              "agreementId": {
+                "type": "string",
+                "format": "uuid",
+                "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+              },
+              "amount": {
+                "type": "string",
+                "pattern": "^[1-9][0-9]{0,17}$"
+              },
+              "start": {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+              },
+              "end": {
+                "type": "string",
+                "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+              },
+              "contributions": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 4000
+              },
+              "assessment": {
+                "type": "string",
+                "minLength": 1,
+                "maxLength": 2000
+              },
+              "evidence": {
+                "maxItems": 12,
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "maxLength": 1000,
+                  "format": "uri"
+                }
+              }
+            },
+            "required": [
+              "agreementId",
+              "start",
+              "end",
+              "contributions",
+              "assessment",
+              "evidence"
+            ],
+            "additionalProperties": false
+          },
+          "state": {
+            "type": "string",
+            "enum": [
+              "draft",
+              "submitted",
+              "changes_requested",
+              "approved",
+              "declined"
+            ]
+          },
+          "approvedAmount": {
+            "type": "string",
+            "pattern": "^[1-9][0-9]{0,17}$"
+          },
+          "feedback": {
+            "type": "string"
+          },
+          "reviewedBy": {
+            "type": [
+              "string",
+              "null"
+            ]
+          },
+          "at": {
+            "type": "string"
+          },
+          "payment": {
+            "default": null,
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "mode": {
+                    "type": "string",
+                    "enum": [
+                      "shared",
+                      "isolated"
+                    ]
+                  },
+                  "id": {
+                    "type": "string",
+                    "format": "uuid",
+                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                  },
+                  "until": {
+                    "type": "string",
+                    "format": "date-time",
+                    "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
+                  }
+                },
+                "required": [
+                  "mode",
+                  "id"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "null"
+              }
+            ]
+          }
+        },
+        "required": [
+          "id",
+          "version",
+          "payee",
+          "agreementVersion",
+          "report",
+          "state",
+          "feedback",
+          "reviewedBy",
+          "at",
+          "payment"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "history": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "sequence": {
+            "type": "number"
+          },
+          "actor": {
+            "type": "string"
+          },
+          "record": {
+            "anyOf": [
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "format": "uuid",
+                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                  },
+                  "version": {
+                    "type": "integer",
+                    "exclusiveMinimum": 0,
+                    "maximum": 9007199254740991
+                  },
+                  "payee": {
+                    "type": "string",
+                    "pattern": "^(?=.{2,64}$)([a-z\\d]+[-_])*[a-z\\d]+(\\.([a-z\\d]+[-_])*[a-z\\d]+)*$"
+                  },
+                  "agreementVersion": {
+                    "type": "integer",
+                    "exclusiveMinimum": 0,
+                    "maximum": 9007199254740991
+                  },
+                  "report": {
+                    "type": "object",
+                    "properties": {
+                      "agreementId": {
+                        "type": "string",
+                        "format": "uuid",
+                        "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                      },
+                      "amount": {
+                        "type": "string",
+                        "pattern": "^[1-9][0-9]{0,17}$"
+                      },
+                      "start": {
+                        "type": "string",
+                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+                      },
+                      "end": {
+                        "type": "string",
+                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+                      },
+                      "contributions": {
+                        "type": "string",
+                        "minLength": 1,
+                        "maxLength": 4000
+                      },
+                      "assessment": {
+                        "type": "string",
+                        "minLength": 1,
+                        "maxLength": 2000
+                      },
+                      "evidence": {
+                        "maxItems": 12,
+                        "type": "array",
+                        "items": {
+                          "type": "string",
+                          "maxLength": 1000,
+                          "format": "uri"
+                        }
+                      }
+                    },
+                    "required": [
+                      "agreementId",
+                      "start",
+                      "end",
+                      "contributions",
+                      "assessment",
+                      "evidence"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "state": {
+                    "type": "string",
+                    "enum": [
+                      "draft",
+                      "submitted",
+                      "changes_requested",
+                      "approved",
+                      "declined"
+                    ]
+                  },
+                  "approvedAmount": {
+                    "type": "string",
+                    "pattern": "^[1-9][0-9]{0,17}$"
+                  },
+                  "feedback": {
+                    "type": "string"
+                  },
+                  "reviewedBy": {
+                    "type": [
+                      "string",
+                      "null"
+                    ]
+                  },
+                  "at": {
+                    "type": "string"
+                  },
+                  "payment": {
+                    "default": null,
+                    "anyOf": [
+                      {
+                        "type": "object",
+                        "properties": {
+                          "mode": {
+                            "type": "string",
+                            "enum": [
+                              "shared",
+                              "isolated"
+                            ]
+                          },
+                          "id": {
+                            "type": "string",
+                            "format": "uuid",
+                            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                          },
+                          "until": {
+                            "type": "string",
+                            "format": "date-time",
+                            "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
+                          }
+                        },
+                        "required": [
+                          "mode",
+                          "id"
+                        ],
+                        "additionalProperties": false
+                      },
+                      {
+                        "type": "null"
+                      }
+                    ]
+                  }
+                },
+                "required": [
+                  "id",
+                  "version",
+                  "payee",
+                  "agreementVersion",
+                  "report",
+                  "state",
+                  "feedback",
+                  "reviewedBy",
+                  "at",
+                  "payment"
+                ],
+                "additionalProperties": false
+              },
+              {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "format": "uuid",
+                    "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+                  },
+                  "version": {
+                    "type": "integer",
+                    "exclusiveMinimum": 0,
+                    "maximum": 9007199254740991
+                  },
+                  "terms": {
+                    "type": "object",
+                    "properties": {
+                      "payee": {
+                        "type": "string",
+                        "pattern": "^(?=.{2,64}$)([a-z\\d]+[-_])*[a-z\\d]+(\\.([a-z\\d]+[-_])*[a-z\\d]+)*$"
+                      },
+                      "title": {
+                        "type": "string",
+                        "minLength": 1,
+                        "maxLength": 160
+                      },
+                      "document": {
+                        "type": "string",
+                        "maxLength": 1000,
+                        "format": "uri"
+                      },
+                      "signedOn": {
+                        "type": "string",
+                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+                      },
+                      "start": {
+                        "type": "string",
+                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+                      },
+                      "end": {
+                        "type": "string",
+                        "pattern": "^\\d{4}-\\d{2}-\\d{2}$"
+                      },
+                      "ceiling": {
+                        "type": "string",
+                        "pattern": "^[1-9][0-9]{0,17}$"
+                      },
+                      "openingApproved": {
+                        "type": "string",
+                        "pattern": "^(0|[1-9][0-9]{0,17})$"
+                      },
+                      "scope": {
+                        "type": "string",
+                        "maxLength": 2000
+                      }
+                    },
+                    "required": [
+                      "payee",
+                      "title",
+                      "document",
+                      "signedOn",
+                      "start",
+                      "end",
+                      "ceiling",
+                      "openingApproved",
+                      "scope"
+                    ],
+                    "additionalProperties": false
+                  },
+                  "recordedBy": {
+                    "type": "string"
+                  },
+                  "at": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "version",
+                  "terms",
+                  "recordedBy",
+                  "at"
+                ],
+                "additionalProperties": false
+              }
+            ]
+          }
+        },
+        "required": [
+          "sequence",
+          "actor",
+          "record"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "payments": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "requestId": {
+            "type": "string",
+            "format": "uuid",
+            "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+          },
+          "id": {
+            "type": "string"
+          },
+          "status": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "requestId",
+          "id",
+          "status"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "account",
+    "agreements",
+    "requests",
+    "history",
+    "payments"
+  ],
+  "additionalProperties": false
+}

package/schemas/payeeWorkOrderRequest.json ADDED Viewed

@@ -0,0 +1,31 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "submission": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+    },
+    "amount": {
+      "type": "string"
+    },
+    "note": {
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 200
+    },
+    "until": {
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
+    }
+  },
+  "required": [
+    "submission",
+    "amount",
+    "note",
+    "until"
+  ],
+  "additionalProperties": false
+}

package/schemas/publicWorkOrder.json ADDED Viewed

@@ -0,0 +1,94 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
+    },
+    "amount": {
+      "type": "string"
+    },
+    "note": {
+      "type": "string"
+    },
+    "until": {
+      "type": "string"
+    },
+    "createdAt": {
+      "type": "string"
+    },
+    "invoice": {
+      "anyOf": [
+        {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "amount": {
+              "type": [
+                "string",
+                "null"
+              ]
+            },
+            "note": {
+              "type": "string"
+            },
+            "filedAt": {
+              "type": "string"
+            },
+            "status": {
+              "type": "string",
+              "enum": [
+                "needs_agreement",
+                "refused",
+                "busy",
+                "prepared",
+                "waiting",
+                "paying",
+                "paid",
+                "failed",
+                "unknown",
+                "needs_review"
+              ]
+            },
+            "revisionConflict": {
+              "type": "boolean"
+            }
+          },
+          "required": [
+            "id",
+            "amount",
+            "note",
+            "filedAt",
+            "status",
+            "revisionConflict"
+          ],
+          "additionalProperties": false
+        },
+        {
+          "type": "null"
+        }
+      ]
+    },
+    "ready": {
+      "type": "boolean"
+    },
+    "unavailable": {
+      "type": "boolean"
+    }
+  },
+  "required": [
+    "id",
+    "amount",
+    "note",
+    "until",
+    "createdAt",
+    "invoice",
+    "ready",
+    "unavailable"
+  ],
+  "additionalProperties": false
+}