@deliverd/sdk 0.7.1 → 0.8.0
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.
- package/README.md +48 -1
- package/dist/dev.d.ts +12 -1
- package/dist/dev.d.ts.map +1 -1
- package/dist/dev.js +100 -0
- package/dist/gates.d.ts +94 -0
- package/dist/gates.d.ts.map +1 -0
- package/dist/gates.js +188 -0
- package/dist/index.d.ts +37 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +56 -0
- package/dist/released.d.ts +37 -0
- package/dist/released.d.ts.map +1 -1
- package/dist/released.js +465 -0
- package/dist/types.d.ts +78 -1
- package/dist/types.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/dev.ts +125 -1
- package/src/gates.ts +230 -0
- package/src/index.ts +59 -0
- package/src/released.ts +468 -1
- package/src/types.ts +90 -1
package/src/released.ts
CHANGED
|
@@ -26,6 +26,60 @@
|
|
|
26
26
|
* kind of entry that reads like a fact and is a guess.
|
|
27
27
|
*/
|
|
28
28
|
|
|
29
|
+
/**
|
|
30
|
+
* Every version of this package npm has served.
|
|
31
|
+
*
|
|
32
|
+
* Written down because a test cannot reach the registry, and kept *here*
|
|
33
|
+
* rather than in a test because it was in two tests and went stale in both.
|
|
34
|
+
* `version.test.ts` used it to refuse a republish and had stopped at 0.6.2
|
|
35
|
+
* after 0.7.0 shipped, so a behaviour change sat under a published number.
|
|
36
|
+
* `release.test.ts` used the newest entry as a floor and said "0.6.1" — three
|
|
37
|
+
* releases low, which is not false but had stopped refusing 0.6.5, the exact
|
|
38
|
+
* 403 it was written to prevent.
|
|
39
|
+
*
|
|
40
|
+
* Two copies of one fact, drifting apart at different speeds. This is the
|
|
41
|
+
* fact; both read it, and `version.test.ts` holds it against CHANGELOG.md so
|
|
42
|
+
* a release that updates one and not the other fails rather than rots.
|
|
43
|
+
*
|
|
44
|
+
* **Add the version here when you publish it, not before.** An entry is a
|
|
45
|
+
* claim that `npm install @deliverd/sdk@x` works today.
|
|
46
|
+
*/
|
|
47
|
+
export const PUBLISHED_TO_NPM = [
|
|
48
|
+
"0.1.0",
|
|
49
|
+
"0.2.0",
|
|
50
|
+
"0.3.0",
|
|
51
|
+
"0.4.0",
|
|
52
|
+
"0.5.0",
|
|
53
|
+
"0.6.0",
|
|
54
|
+
"0.6.1",
|
|
55
|
+
"0.6.2",
|
|
56
|
+
"0.7.0",
|
|
57
|
+
"0.7.1",
|
|
58
|
+
] as const;
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* A fingerprint of what each *published* version recorded.
|
|
62
|
+
*
|
|
63
|
+
* The entry beside this one is a claim about a tarball that exists on a
|
|
64
|
+
* registry and can never change, and the guard that was supposed to hold it
|
|
65
|
+
* still said so in a comment — "a change to an old entry fails here" — while
|
|
66
|
+
* asserting only that the list has no duplicates and more than fifty items.
|
|
67
|
+
* Removing a name from 0.7.0 passed. The comment described a guard nobody had
|
|
68
|
+
* written, which is the most expensive kind of comment.
|
|
69
|
+
*
|
|
70
|
+
* So: sha256 over the entry's items joined by newlines. Editing a published
|
|
71
|
+
* list now means editing this too, which is not something done by accident.
|
|
72
|
+
*
|
|
73
|
+
* Only published versions appear. The working version's surface is *supposed*
|
|
74
|
+
* to move — freezing it would fail on the first honest addition, and a guard
|
|
75
|
+
* that fires on correct work is one somebody deletes.
|
|
76
|
+
*/
|
|
77
|
+
export const FROZEN: Record<string, string> = {
|
|
78
|
+
"0.7.0": "da25740012f88b6a29cc963d8b354ab6b123c5e2e599c200dc546df351d84d25",
|
|
79
|
+
// Identical to 0.7.0's on purpose: 0.7.1 changed behaviour, not surface.
|
|
80
|
+
"0.7.1": "da25740012f88b6a29cc963d8b354ab6b123c5e2e599c200dc546df351d84d25",
|
|
81
|
+
};
|
|
82
|
+
|
|
29
83
|
export const RELEASED: Record<string, readonly string[]> = {
|
|
30
84
|
/*
|
|
31
85
|
* The first recorded surface, and a minor rather than a patch.
|
|
@@ -773,4 +827,417 @@ export const RELEASED: Record<string, readonly string[]> = {
|
|
|
773
827
|
"event:schedule.due",
|
|
774
828
|
"verifySignature",
|
|
775
829
|
],
|
|
776
|
-
|
|
830
|
+
/*
|
|
831
|
+
* The working version, and nothing is published under it yet.
|
|
832
|
+
*
|
|
833
|
+
* 0.7.1 went to npm, which makes `package.json` at 0.7.1 the exact state the
|
|
834
|
+
* guard below refuses: new code cannot land under a number the registry has
|
|
835
|
+
* already served, because it succeeds everywhere except `npm install`. So
|
|
836
|
+
* the working version steps forward the moment a release lands, and this
|
|
837
|
+
* entry starts as a copy of what shipped.
|
|
838
|
+
*
|
|
839
|
+
* It carries no CHANGELOG.md heading on purpose. There is nothing to say
|
|
840
|
+
* about 0.7.2 yet; the heading arrives with the first change that needs
|
|
841
|
+
* describing, which is also when this list stops matching 0.7.1's. If that
|
|
842
|
+
* first change *adds* to the surface, the number is wrong — additions are a
|
|
843
|
+
* minor, and `version.test.ts` says so rather than leaving it to whoever
|
|
844
|
+
* remembers.
|
|
845
|
+
*/
|
|
846
|
+
"0.8.0": [
|
|
847
|
+
"Approval",
|
|
848
|
+
"ApprovalData.approvalsSoFar",
|
|
849
|
+
"ApprovalData.approvers",
|
|
850
|
+
"ApprovalData.createdAt",
|
|
851
|
+
"ApprovalData.decidedAt",
|
|
852
|
+
"ApprovalData.decidedBy",
|
|
853
|
+
"ApprovalData.decidedById",
|
|
854
|
+
"ApprovalData.description",
|
|
855
|
+
"ApprovalData.expiresAt",
|
|
856
|
+
"ApprovalData.externalId",
|
|
857
|
+
"ApprovalData.factors",
|
|
858
|
+
"ApprovalData.id",
|
|
859
|
+
"ApprovalData.links",
|
|
860
|
+
"ApprovalData.metadata",
|
|
861
|
+
"ApprovalData.note",
|
|
862
|
+
"ApprovalData.questions",
|
|
863
|
+
"ApprovalData.reportId",
|
|
864
|
+
"ApprovalData.requestedBy",
|
|
865
|
+
"ApprovalData.requiredApprovals",
|
|
866
|
+
"ApprovalData.risk",
|
|
867
|
+
"ApprovalData.status",
|
|
868
|
+
"ApprovalData.title",
|
|
869
|
+
"ApprovalData.url",
|
|
870
|
+
"ApprovalFactor.detail",
|
|
871
|
+
"ApprovalFactor.label",
|
|
872
|
+
"ApprovalFactor.status",
|
|
873
|
+
"ApprovalLink.label",
|
|
874
|
+
"ApprovalLink.url",
|
|
875
|
+
"ApprovalQuestion.answer",
|
|
876
|
+
"ApprovalQuestion.answeredAt",
|
|
877
|
+
"ApprovalQuestion.askedAt",
|
|
878
|
+
"ApprovalQuestion.id",
|
|
879
|
+
"ApprovalQuestion.question",
|
|
880
|
+
"Approvals",
|
|
881
|
+
"ApproveOptions",
|
|
882
|
+
"ClientOptions",
|
|
883
|
+
"CollectOptions",
|
|
884
|
+
"CollectWaitOptions",
|
|
885
|
+
"CollectedAnswers.answers",
|
|
886
|
+
"CollectedAnswers.collection",
|
|
887
|
+
"CollectedAnswers.complete",
|
|
888
|
+
"CollectedAnswers.id",
|
|
889
|
+
"CollectedAnswers.responses",
|
|
890
|
+
"CollectedAnswers.status",
|
|
891
|
+
"CollectedAnswers.url",
|
|
892
|
+
"Collection",
|
|
893
|
+
"CollectionData.askedCount",
|
|
894
|
+
"CollectionData.createdAt",
|
|
895
|
+
"CollectionData.dueAt",
|
|
896
|
+
"CollectionData.expiresAt",
|
|
897
|
+
"CollectionData.externalId",
|
|
898
|
+
"CollectionData.id",
|
|
899
|
+
"CollectionData.instructions",
|
|
900
|
+
"CollectionData.metadata",
|
|
901
|
+
"CollectionData.questions",
|
|
902
|
+
"CollectionData.reportId",
|
|
903
|
+
"CollectionData.requestedBy",
|
|
904
|
+
"CollectionData.requiredResponses",
|
|
905
|
+
"CollectionData.responses",
|
|
906
|
+
"CollectionData.settledAt",
|
|
907
|
+
"CollectionData.status",
|
|
908
|
+
"CollectionData.submittedCount",
|
|
909
|
+
"CollectionData.title",
|
|
910
|
+
"CollectionData.url",
|
|
911
|
+
"CollectionQuestion.help",
|
|
912
|
+
"CollectionQuestion.id",
|
|
913
|
+
"CollectionQuestion.kind",
|
|
914
|
+
"CollectionQuestion.options",
|
|
915
|
+
"CollectionQuestion.prompt",
|
|
916
|
+
"CollectionQuestion.required",
|
|
917
|
+
"CollectionReply.answers",
|
|
918
|
+
"CollectionReply.respondent",
|
|
919
|
+
"CollectionReply.status",
|
|
920
|
+
"CollectionReply.submittedAt",
|
|
921
|
+
"Collections",
|
|
922
|
+
"CommentThread.messages",
|
|
923
|
+
"CommentThread.quote",
|
|
924
|
+
"CommentThread.status",
|
|
925
|
+
"CommentThread.threadId",
|
|
926
|
+
"Comments",
|
|
927
|
+
"CreateApprovalInput.approvers",
|
|
928
|
+
"CreateApprovalInput.description",
|
|
929
|
+
"CreateApprovalInput.expiresAt",
|
|
930
|
+
"CreateApprovalInput.externalId",
|
|
931
|
+
"CreateApprovalInput.factors",
|
|
932
|
+
"CreateApprovalInput.flowId",
|
|
933
|
+
"CreateApprovalInput.links",
|
|
934
|
+
"CreateApprovalInput.metadata",
|
|
935
|
+
"CreateApprovalInput.reportId",
|
|
936
|
+
"CreateApprovalInput.risk",
|
|
937
|
+
"CreateApprovalInput.title",
|
|
938
|
+
"CreateCollectionInput.dueAt",
|
|
939
|
+
"CreateCollectionInput.expiresAt",
|
|
940
|
+
"CreateCollectionInput.externalId",
|
|
941
|
+
"CreateCollectionInput.flowId",
|
|
942
|
+
"CreateCollectionInput.instructions",
|
|
943
|
+
"CreateCollectionInput.metadata",
|
|
944
|
+
"CreateCollectionInput.questions",
|
|
945
|
+
"CreateCollectionInput.reportId",
|
|
946
|
+
"CreateCollectionInput.requiredResponses",
|
|
947
|
+
"CreateCollectionInput.respondents",
|
|
948
|
+
"CreateCollectionInput.title",
|
|
949
|
+
"CreateFlowInput.description",
|
|
950
|
+
"CreateFlowInput.externalId",
|
|
951
|
+
"CreateFlowInput.metadata",
|
|
952
|
+
"CreateFlowInput.title",
|
|
953
|
+
"CreateFlowInput.workspaceId",
|
|
954
|
+
"CreateGateInput.actionId",
|
|
955
|
+
"CreateGateInput.environment",
|
|
956
|
+
"CreateGateInput.externalId",
|
|
957
|
+
"CreateGateInput.flowId",
|
|
958
|
+
"CreateGateInput.input",
|
|
959
|
+
"CreateGateInput.reason",
|
|
960
|
+
"CreateReviewInput.expiresAt",
|
|
961
|
+
"CreateReviewInput.externalId",
|
|
962
|
+
"CreateReviewInput.flowId",
|
|
963
|
+
"CreateReviewInput.instructions",
|
|
964
|
+
"CreateReviewInput.metadata",
|
|
965
|
+
"CreateReviewInput.reportId",
|
|
966
|
+
"CreateReviewInput.requiredApprovals",
|
|
967
|
+
"CreateReviewInput.reviewers",
|
|
968
|
+
"CreateReviewInput.title",
|
|
969
|
+
"CreateReviewInput.versionId",
|
|
970
|
+
"DEFAULT_BASE_URL",
|
|
971
|
+
"DEFAULT_EXPIRY",
|
|
972
|
+
"DELIVERY_HEADER",
|
|
973
|
+
"Decision.approval",
|
|
974
|
+
"Decision.approved",
|
|
975
|
+
"Decision.decidedAt",
|
|
976
|
+
"Decision.decidedBy",
|
|
977
|
+
"Decision.decidedById",
|
|
978
|
+
"Decision.id",
|
|
979
|
+
"Decision.note",
|
|
980
|
+
"Decision.status",
|
|
981
|
+
"Decision.url",
|
|
982
|
+
"Deliverd",
|
|
983
|
+
"DeliverdError",
|
|
984
|
+
"DeliverdOptions",
|
|
985
|
+
"DeliverdTimeoutError",
|
|
986
|
+
"Duration",
|
|
987
|
+
"EVENT_HEADER",
|
|
988
|
+
"EvidenceEvent.actor",
|
|
989
|
+
"EvidenceEvent.actorType",
|
|
990
|
+
"EvidenceEvent.at",
|
|
991
|
+
"EvidenceEvent.event",
|
|
992
|
+
"EvidenceEvent.metadata",
|
|
993
|
+
"EvidenceEvent.step",
|
|
994
|
+
"EvidenceOutcome.at",
|
|
995
|
+
"EvidenceOutcome.note",
|
|
996
|
+
"EvidenceOutcome.said",
|
|
997
|
+
"EvidenceOutcome.who",
|
|
998
|
+
"EvidencePack.generatedAt",
|
|
999
|
+
"EvidencePack.generatedBy",
|
|
1000
|
+
"EvidencePack.integrity",
|
|
1001
|
+
"EvidencePack.organisation",
|
|
1002
|
+
"EvidencePack.packVersion",
|
|
1003
|
+
"EvidencePack.steps",
|
|
1004
|
+
"EvidencePack.subject",
|
|
1005
|
+
"EvidencePack.summary",
|
|
1006
|
+
"EvidencePack.timeline",
|
|
1007
|
+
"EvidenceStep.asked",
|
|
1008
|
+
"EvidenceStep.createdAt",
|
|
1009
|
+
"EvidenceStep.detail",
|
|
1010
|
+
"EvidenceStep.id",
|
|
1011
|
+
"EvidenceStep.kind",
|
|
1012
|
+
"EvidenceStep.outcomes",
|
|
1013
|
+
"EvidenceStep.requestedBy",
|
|
1014
|
+
"EvidenceStep.requestedByAgent",
|
|
1015
|
+
"EvidenceStep.settledAt",
|
|
1016
|
+
"EvidenceStep.status",
|
|
1017
|
+
"EvidenceStep.title",
|
|
1018
|
+
"EvidenceStep.url",
|
|
1019
|
+
"Flow",
|
|
1020
|
+
"FlowData.allSettled",
|
|
1021
|
+
"FlowData.createdAt",
|
|
1022
|
+
"FlowData.description",
|
|
1023
|
+
"FlowData.externalId",
|
|
1024
|
+
"FlowData.id",
|
|
1025
|
+
"FlowData.memberCount",
|
|
1026
|
+
"FlowData.members",
|
|
1027
|
+
"FlowData.metadata",
|
|
1028
|
+
"FlowData.openCount",
|
|
1029
|
+
"FlowData.settledAt",
|
|
1030
|
+
"FlowData.startedBy",
|
|
1031
|
+
"FlowData.status",
|
|
1032
|
+
"FlowData.timeline",
|
|
1033
|
+
"FlowData.title",
|
|
1034
|
+
"FlowData.url",
|
|
1035
|
+
"FlowEvent.actor",
|
|
1036
|
+
"FlowEvent.actorType",
|
|
1037
|
+
"FlowEvent.at",
|
|
1038
|
+
"FlowEvent.event",
|
|
1039
|
+
"FlowEvent.resourceId",
|
|
1040
|
+
"FlowEvent.resourceType",
|
|
1041
|
+
"FlowMember.createdAt",
|
|
1042
|
+
"FlowMember.id",
|
|
1043
|
+
"FlowMember.kind",
|
|
1044
|
+
"FlowMember.open",
|
|
1045
|
+
"FlowMember.status",
|
|
1046
|
+
"FlowMember.title",
|
|
1047
|
+
"FlowPrimitives",
|
|
1048
|
+
"Flows",
|
|
1049
|
+
"Gate",
|
|
1050
|
+
"GateData.allowed",
|
|
1051
|
+
"GateData.approvalId",
|
|
1052
|
+
"GateData.approvalUrl",
|
|
1053
|
+
"GateData.basis",
|
|
1054
|
+
"GateData.id",
|
|
1055
|
+
"GateData.input",
|
|
1056
|
+
"GateData.outcome",
|
|
1057
|
+
"GateData.policyVersionId",
|
|
1058
|
+
"GateData.reason",
|
|
1059
|
+
"GateData.reused",
|
|
1060
|
+
"GateData.rule",
|
|
1061
|
+
"GateData.settledAt",
|
|
1062
|
+
"GateData.status",
|
|
1063
|
+
"GateDecision.allowed",
|
|
1064
|
+
"GateDecision.approvalUrl",
|
|
1065
|
+
"GateDecision.gate",
|
|
1066
|
+
"GateDecision.id",
|
|
1067
|
+
"GateDecision.input",
|
|
1068
|
+
"GateDecision.reason",
|
|
1069
|
+
"GateDecision.rule",
|
|
1070
|
+
"GateDecision.status",
|
|
1071
|
+
"GateOptions",
|
|
1072
|
+
"GateWaitOptions",
|
|
1073
|
+
"Gates",
|
|
1074
|
+
"InlineFile.content",
|
|
1075
|
+
"InlineFile.encoding",
|
|
1076
|
+
"InlineFile.path",
|
|
1077
|
+
"ListApprovalsInput.cursor",
|
|
1078
|
+
"ListApprovalsInput.externalId",
|
|
1079
|
+
"ListApprovalsInput.limit",
|
|
1080
|
+
"ListApprovalsInput.status",
|
|
1081
|
+
"ListCollectionsInput.cursor",
|
|
1082
|
+
"ListCollectionsInput.externalId",
|
|
1083
|
+
"ListCollectionsInput.limit",
|
|
1084
|
+
"ListCollectionsInput.status",
|
|
1085
|
+
"ListFlowsInput.cursor",
|
|
1086
|
+
"ListFlowsInput.externalId",
|
|
1087
|
+
"ListFlowsInput.limit",
|
|
1088
|
+
"ListFlowsInput.status",
|
|
1089
|
+
"ListReviewsInput.cursor",
|
|
1090
|
+
"ListReviewsInput.externalId",
|
|
1091
|
+
"ListReviewsInput.limit",
|
|
1092
|
+
"ListReviewsInput.reportId",
|
|
1093
|
+
"ListReviewsInput.status",
|
|
1094
|
+
"OpenThread.author",
|
|
1095
|
+
"OpenThread.authorType",
|
|
1096
|
+
"OpenThread.lastActivityAt",
|
|
1097
|
+
"OpenThread.messages",
|
|
1098
|
+
"OpenThread.quote",
|
|
1099
|
+
"OpenThread.reportId",
|
|
1100
|
+
"OpenThread.reportOwnerId",
|
|
1101
|
+
"OpenThread.reportSlug",
|
|
1102
|
+
"OpenThread.reportTitle",
|
|
1103
|
+
"OpenThread.threadId",
|
|
1104
|
+
"OrgAnalytics.activeReports",
|
|
1105
|
+
"OrgAnalytics.days",
|
|
1106
|
+
"OrgAnalytics.externallySharedReports",
|
|
1107
|
+
"OrgAnalytics.inactiveReports",
|
|
1108
|
+
"OrgAnalytics.publicReports",
|
|
1109
|
+
"OrgAnalytics.publishesInPeriod",
|
|
1110
|
+
"OrgAnalytics.topReports",
|
|
1111
|
+
"OrgAnalytics.totalViews",
|
|
1112
|
+
"OrgAnalytics.uniqueViewers",
|
|
1113
|
+
"POLL_SCHEDULE",
|
|
1114
|
+
"PublishReportInput.audience",
|
|
1115
|
+
"PublishReportInput.changeSummary",
|
|
1116
|
+
"PublishReportInput.classification",
|
|
1117
|
+
"PublishReportInput.content",
|
|
1118
|
+
"PublishReportInput.description",
|
|
1119
|
+
"PublishReportInput.expectedVersion",
|
|
1120
|
+
"PublishReportInput.files",
|
|
1121
|
+
"PublishReportInput.living",
|
|
1122
|
+
"PublishReportInput.slug",
|
|
1123
|
+
"PublishReportInput.sourceModel",
|
|
1124
|
+
"PublishReportInput.sourceTool",
|
|
1125
|
+
"PublishReportInput.title",
|
|
1126
|
+
"PublishReportInput.uploadId",
|
|
1127
|
+
"PublishReportInput.workspaceId",
|
|
1128
|
+
"PublishResult.approval",
|
|
1129
|
+
"PublishResult.report",
|
|
1130
|
+
"PublishResult.status",
|
|
1131
|
+
"PublishResult.version",
|
|
1132
|
+
"PublishResult.warnings",
|
|
1133
|
+
"QuestionInput.help",
|
|
1134
|
+
"QuestionInput.kind",
|
|
1135
|
+
"QuestionInput.options",
|
|
1136
|
+
"QuestionInput.prompt",
|
|
1137
|
+
"QuestionInput.required",
|
|
1138
|
+
"ReportAnalytics.byDay",
|
|
1139
|
+
"ReportAnalytics.byVersion",
|
|
1140
|
+
"ReportAnalytics.externalViewers",
|
|
1141
|
+
"ReportAnalytics.firstViewedAt",
|
|
1142
|
+
"ReportAnalytics.internalViewers",
|
|
1143
|
+
"ReportAnalytics.lastViewedAt",
|
|
1144
|
+
"ReportAnalytics.recentViewers",
|
|
1145
|
+
"ReportAnalytics.reportId",
|
|
1146
|
+
"ReportAnalytics.title",
|
|
1147
|
+
"ReportAnalytics.totalViews",
|
|
1148
|
+
"ReportAnalytics.uniqueViewers",
|
|
1149
|
+
"ReportData.currentVersion",
|
|
1150
|
+
"ReportData.id",
|
|
1151
|
+
"ReportData.slug",
|
|
1152
|
+
"ReportData.status",
|
|
1153
|
+
"ReportData.title",
|
|
1154
|
+
"ReportData.url",
|
|
1155
|
+
"Reports",
|
|
1156
|
+
"Review",
|
|
1157
|
+
"ReviewData.createdAt",
|
|
1158
|
+
"ReviewData.expiresAt",
|
|
1159
|
+
"ReviewData.externalId",
|
|
1160
|
+
"ReviewData.id",
|
|
1161
|
+
"ReviewData.instructions",
|
|
1162
|
+
"ReviewData.metadata",
|
|
1163
|
+
"ReviewData.reportId",
|
|
1164
|
+
"ReviewData.requestedBy",
|
|
1165
|
+
"ReviewData.requiredApprovals",
|
|
1166
|
+
"ReviewData.reviewers",
|
|
1167
|
+
"ReviewData.settledAt",
|
|
1168
|
+
"ReviewData.status",
|
|
1169
|
+
"ReviewData.threadCount",
|
|
1170
|
+
"ReviewData.title",
|
|
1171
|
+
"ReviewData.url",
|
|
1172
|
+
"ReviewData.verdicts",
|
|
1173
|
+
"ReviewData.versionId",
|
|
1174
|
+
"ReviewOptions",
|
|
1175
|
+
"ReviewOutcome.approved",
|
|
1176
|
+
"ReviewOutcome.id",
|
|
1177
|
+
"ReviewOutcome.review",
|
|
1178
|
+
"ReviewOutcome.status",
|
|
1179
|
+
"ReviewOutcome.threadCount",
|
|
1180
|
+
"ReviewOutcome.url",
|
|
1181
|
+
"ReviewOutcome.verdicts",
|
|
1182
|
+
"ReviewVerdict.at",
|
|
1183
|
+
"ReviewVerdict.by",
|
|
1184
|
+
"ReviewVerdict.note",
|
|
1185
|
+
"ReviewVerdict.verdict",
|
|
1186
|
+
"ReviewWaitOptions",
|
|
1187
|
+
"ReviewerRef.id",
|
|
1188
|
+
"ReviewerRef.kind",
|
|
1189
|
+
"ReviewerRef.label",
|
|
1190
|
+
"Reviews",
|
|
1191
|
+
"SIGNATURE_HEADER",
|
|
1192
|
+
"ScheduleSummary.agentId",
|
|
1193
|
+
"ScheduleSummary.agentName",
|
|
1194
|
+
"ScheduleSummary.currentVersion",
|
|
1195
|
+
"ScheduleSummary.due",
|
|
1196
|
+
"ScheduleSummary.dueSince",
|
|
1197
|
+
"ScheduleSummary.enabled",
|
|
1198
|
+
"ScheduleSummary.id",
|
|
1199
|
+
"ScheduleSummary.lastRunAt",
|
|
1200
|
+
"ScheduleSummary.nextRunAt",
|
|
1201
|
+
"ScheduleSummary.recurrence",
|
|
1202
|
+
"ScheduleSummary.reportId",
|
|
1203
|
+
"ScheduleSummary.reportSlug",
|
|
1204
|
+
"ScheduleSummary.reportTitle",
|
|
1205
|
+
"ScheduleSummary.reportUrl",
|
|
1206
|
+
"Schedules",
|
|
1207
|
+
"SendResult.alreadyHadAccess",
|
|
1208
|
+
"SendResult.sent",
|
|
1209
|
+
"TOLERANCE_SECONDS",
|
|
1210
|
+
"WaitOptions",
|
|
1211
|
+
"WebhookEvent.data",
|
|
1212
|
+
"WebhookEvent.event",
|
|
1213
|
+
"WebhookEvent.sentAt",
|
|
1214
|
+
"WebhookEvent.test",
|
|
1215
|
+
"Webhooks",
|
|
1216
|
+
"constructEvent",
|
|
1217
|
+
"deliverd",
|
|
1218
|
+
"durationMs",
|
|
1219
|
+
"event:access.requested",
|
|
1220
|
+
"event:approval.answered",
|
|
1221
|
+
"event:approval.approved",
|
|
1222
|
+
"event:approval.escalated",
|
|
1223
|
+
"event:approval.expired",
|
|
1224
|
+
"event:approval.question",
|
|
1225
|
+
"event:approval.rejected",
|
|
1226
|
+
"event:approval.requested",
|
|
1227
|
+
"event:collection.completed",
|
|
1228
|
+
"event:collection.requested",
|
|
1229
|
+
"event:comment.created",
|
|
1230
|
+
"event:flow.completed",
|
|
1231
|
+
"event:gate.denied",
|
|
1232
|
+
"event:publish.held",
|
|
1233
|
+
"event:report.published",
|
|
1234
|
+
"event:report.shared",
|
|
1235
|
+
"event:report.updated",
|
|
1236
|
+
"event:report.viewed",
|
|
1237
|
+
"event:review.approved",
|
|
1238
|
+
"event:review.changes_requested",
|
|
1239
|
+
"event:review.requested",
|
|
1240
|
+
"event:schedule.due",
|
|
1241
|
+
"verifySignature",
|
|
1242
|
+
],
|
|
1243
|
+
};
|
package/src/types.ts
CHANGED
|
@@ -12,6 +12,91 @@
|
|
|
12
12
|
export type ApprovalStatus = "pending" | "approved" | "rejected" | "expired" | "cancelled";
|
|
13
13
|
export type ApprovalRisk = "low" | "medium" | "high" | "critical";
|
|
14
14
|
|
|
15
|
+
/**
|
|
16
|
+
* What a gate decision can be.
|
|
17
|
+
*
|
|
18
|
+
* Seven, and the extra four over `allowed | denied | pending` are worth the
|
|
19
|
+
* width. `allowed` and `denied` are what a *rule* said; the rest are what a
|
|
20
|
+
* *person* did about a request no rule settled. An action that went through
|
|
21
|
+
* because policy permitted it and one that went through because somebody
|
|
22
|
+
* agreed to it are not the same fact — the ratio between them is the number
|
|
23
|
+
* this whole layer exists to make computable — so collapsing them would throw
|
|
24
|
+
* away the distinction at the one place a caller can see it.
|
|
25
|
+
*/
|
|
26
|
+
export type GateStatus =
|
|
27
|
+
| "allowed"
|
|
28
|
+
| "denied"
|
|
29
|
+
| "pending"
|
|
30
|
+
| "approved"
|
|
31
|
+
| "rejected"
|
|
32
|
+
| "expired"
|
|
33
|
+
| "cancelled";
|
|
34
|
+
|
|
35
|
+
/** What a person decided about a gate, once one has. */
|
|
36
|
+
export type GateOutcomeName = "approved" | "rejected" | "cancelled" | "expired";
|
|
37
|
+
|
|
38
|
+
export interface CreateGateInput {
|
|
39
|
+
/** The registered action you are about to perform: `finance.refund`. */
|
|
40
|
+
actionId: string;
|
|
41
|
+
/** The arguments you will actually execute with. Validated against the action's schema. */
|
|
42
|
+
input: Record<string, unknown>;
|
|
43
|
+
/**
|
|
44
|
+
* Your id for this unit of work — `refund:ord_8812`. **Required**, which no
|
|
45
|
+
* other create in this SDK is.
|
|
46
|
+
*
|
|
47
|
+
* Every other POST mints a random idempotency key per attempt, which guards a
|
|
48
|
+
* retried *request*. This guards a retried *decision*: a crashed agent that
|
|
49
|
+
* re-runs its refund step must re-read the answer it already got, not ask a
|
|
50
|
+
* second person about the same money. No id the SDK invented could know which
|
|
51
|
+
* two calls are the same attempt, so you name it.
|
|
52
|
+
*/
|
|
53
|
+
externalId: string;
|
|
54
|
+
/** Where this is running, for rules that tell staging from production. */
|
|
55
|
+
environment?: string;
|
|
56
|
+
/** Why, shown to whoever is asked to decide. */
|
|
57
|
+
reason?: string;
|
|
58
|
+
flowId?: string;
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
export interface GateData {
|
|
62
|
+
id: string;
|
|
63
|
+
status: GateStatus;
|
|
64
|
+
/** The one to branch on: a rule permitted it, or a person agreed to it. */
|
|
65
|
+
allowed: boolean;
|
|
66
|
+
/** The input as the action's schema validated it — what to execute with. */
|
|
67
|
+
input: Record<string, unknown>;
|
|
68
|
+
/** Whether a rule decided this or a person did. */
|
|
69
|
+
basis: "policy" | "human";
|
|
70
|
+
reason: string | null;
|
|
71
|
+
/** The rule that decided, by name. Null when nothing matched. */
|
|
72
|
+
rule: string | null;
|
|
73
|
+
policyVersionId: string | null;
|
|
74
|
+
approvalId: string | null;
|
|
75
|
+
approvalUrl: string | null;
|
|
76
|
+
outcome: GateOutcomeName | null;
|
|
77
|
+
settledAt: string | null;
|
|
78
|
+
/** True when this call found a decision already made under your `externalId`. */
|
|
79
|
+
reused: boolean;
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
/**
|
|
83
|
+
* The answer, flattened — what `gate()` hands back.
|
|
84
|
+
*
|
|
85
|
+
* `allowed` is a boolean so `if (decision.allowed)` reads as the sentence it
|
|
86
|
+
* is; `status` is the narrowing union for a switch. The same pairing, for the
|
|
87
|
+
* same reason, as `Decision` on an approval.
|
|
88
|
+
*/
|
|
89
|
+
export interface GateDecision {
|
|
90
|
+
allowed: boolean;
|
|
91
|
+
status: GateStatus;
|
|
92
|
+
reason: string | null;
|
|
93
|
+
rule: string | null;
|
|
94
|
+
input: Record<string, unknown>;
|
|
95
|
+
id: string;
|
|
96
|
+
approvalUrl: string | null;
|
|
97
|
+
gate: unknown;
|
|
98
|
+
}
|
|
99
|
+
|
|
15
100
|
/** One line of evidence, as the approval page shows it. */
|
|
16
101
|
export interface ApprovalFactor {
|
|
17
102
|
label: string;
|
|
@@ -365,7 +450,11 @@ export type WebhookEventName =
|
|
|
365
450
|
| "review.changes_requested"
|
|
366
451
|
| "collection.requested"
|
|
367
452
|
| "collection.completed"
|
|
368
|
-
| "flow.completed"
|
|
453
|
+
| "flow.completed"
|
|
454
|
+
/** A gate refused. The only gate event that relays: an allow fires on every
|
|
455
|
+
* auto-allowed action, and an escalation already arrives as
|
|
456
|
+
* `approval.requested`. */
|
|
457
|
+
| "gate.denied";
|
|
369
458
|
|
|
370
459
|
export interface WebhookEvent {
|
|
371
460
|
event: WebhookEventName;
|