@btps/sdk 0.0.0-stage → 1.1.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/CHANGELOG.md +149 -0
- package/LICENSE +190 -0
- package/NOTICE +25 -0
- package/README.md +261 -2
- package/dist/client/btpsAgent.d.ts +20 -0
- package/dist/client/btpsAgent.js +172 -0
- package/dist/client/btpsClient.d.ts +202 -0
- package/dist/client/btpsClient.js +602 -0
- package/dist/client/btpsTransporter.d.ts +52 -0
- package/dist/client/btpsTransporter.js +249 -0
- package/dist/client/constants.ts/index.d.ts +11 -0
- package/dist/client/constants.ts/index.js +20 -0
- package/dist/client/index.d.ts +12 -0
- package/dist/client/index.js +27 -0
- package/dist/client/libs/schema.d.ts +27604 -0
- package/dist/client/libs/schema.js +56 -0
- package/dist/client/libs/timeouts.d.ts +22 -0
- package/dist/client/libs/timeouts.js +19 -0
- package/dist/client/types/index.d.ts +155 -0
- package/dist/client/types/index.js +7 -0
- package/dist/core/authentication/BtpsAuthentication.d.ts +128 -0
- package/dist/core/authentication/BtpsAuthentication.js +293 -0
- package/dist/core/authentication/index.d.ts +11 -0
- package/dist/core/authentication/index.js +12 -0
- package/dist/core/authentication/keyProof.d.ts +18 -0
- package/dist/core/authentication/keyProof.js +16 -0
- package/dist/core/authentication/storage/InMemoryAuthSessionStore.d.ts +55 -0
- package/dist/core/authentication/storage/InMemoryAuthSessionStore.js +62 -0
- package/dist/core/authentication/storage/InMemoryTokenStore.d.ts +63 -0
- package/dist/core/authentication/storage/InMemoryTokenStore.js +63 -0
- package/dist/core/authentication/types.d.ts +135 -0
- package/dist/core/authentication/types.js +7 -0
- package/dist/core/crypto/decryptVerify.d.ts +9 -0
- package/dist/core/crypto/decryptVerify.js +45 -0
- package/dist/core/crypto/decrypter-interface.d.ts +25 -0
- package/dist/core/crypto/decrypter-interface.js +7 -0
- package/dist/core/crypto/index.d.ts +77 -0
- package/dist/core/crypto/index.js +210 -0
- package/dist/core/crypto/jcs.d.ts +28 -0
- package/dist/core/crypto/jcs.js +60 -0
- package/dist/core/crypto/keygen.d.ts +9 -0
- package/dist/core/crypto/keygen.js +35 -0
- package/dist/core/crypto/pem-decrypter.d.ts +26 -0
- package/dist/core/crypto/pem-decrypter.js +52 -0
- package/dist/core/crypto/pem-signer.d.ts +21 -0
- package/dist/core/crypto/pem-signer.js +34 -0
- package/dist/core/crypto/signEncrypt.d.ts +34 -0
- package/dist/core/crypto/signEncrypt.js +75 -0
- package/dist/core/crypto/signer-interface.d.ts +22 -0
- package/dist/core/crypto/signer-interface.js +7 -0
- package/dist/core/crypto/types.d.ts +79 -0
- package/dist/core/crypto/types.js +7 -0
- package/dist/core/delegation/BtpsDelegator.d.ts +102 -0
- package/dist/core/delegation/BtpsDelegator.js +118 -0
- package/dist/core/delegation/index.d.ts +7 -0
- package/dist/core/delegation/index.js +8 -0
- package/dist/core/error/constant.d.ts +66 -0
- package/dist/core/error/constant.js +194 -0
- package/dist/core/error/index.d.ts +35 -0
- package/dist/core/error/index.js +52 -0
- package/dist/core/error/types.d.ts +16 -0
- package/dist/core/error/types.js +7 -0
- package/dist/core/server/constants/btps-protocol.d.ts +17 -0
- package/dist/core/server/constants/btps-protocol.js +25 -0
- package/dist/core/server/constants/control.d.ts +7 -0
- package/dist/core/server/constants/control.js +11 -0
- package/dist/core/server/constants/currency.d.ts +7 -0
- package/dist/core/server/constants/currency.js +332 -0
- package/dist/core/server/constants/index.d.ts +26 -0
- package/dist/core/server/constants/index.js +61 -0
- package/dist/core/server/constants/limits.d.ts +50 -0
- package/dist/core/server/constants/limits.js +50 -0
- package/dist/core/server/helpers/BtpsMessageQueue.d.ts +13 -0
- package/dist/core/server/helpers/BtpsMessageQueue.js +12 -0
- package/dist/core/server/helpers/InMemoryQueue.d.ts +16 -0
- package/dist/core/server/helpers/InMemoryQueue.js +35 -0
- package/dist/core/server/helpers/index.d.ts +8 -0
- package/dist/core/server/helpers/index.js +9 -0
- package/dist/core/server/schemas/artifacts/agentSchema.d.ts +4565 -0
- package/dist/core/server/schemas/artifacts/agentSchema.js +51 -0
- package/dist/core/server/schemas/artifacts/artifacts.d.ts +4920 -0
- package/dist/core/server/schemas/artifacts/artifacts.js +21 -0
- package/dist/core/server/schemas/artifacts/controlSchema.d.ts +23 -0
- package/dist/core/server/schemas/artifacts/controlSchema.js +18 -0
- package/dist/core/server/schemas/artifacts/identityLookupSchema.d.ts +32 -0
- package/dist/core/server/schemas/artifacts/identityLookupSchema.js +21 -0
- package/dist/core/server/schemas/artifacts/transporterSchema.d.ts +553 -0
- package/dist/core/server/schemas/artifacts/transporterSchema.js +60 -0
- package/dist/core/server/schemas/btpsDocsSchema.d.ts +4519 -0
- package/dist/core/server/schemas/btpsDocsSchema.js +272 -0
- package/dist/core/server/schemas/helpers.d.ts +1612 -0
- package/dist/core/server/schemas/helpers.js +87 -0
- package/dist/core/server/schemas/responseSchema.d.ts +6918 -0
- package/dist/core/server/schemas/responseSchema.js +86 -0
- package/dist/core/server/schemas/schema.d.ts +4916 -0
- package/dist/core/server/schemas/schema.js +70 -0
- package/dist/core/server/schemas/shared.d.ts +21 -0
- package/dist/core/server/schemas/shared.js +18 -0
- package/dist/core/server/types.d.ts +172 -0
- package/dist/core/server/types.js +7 -0
- package/dist/core/storage/AbstractIdentityStore.d.ts +17 -0
- package/dist/core/storage/AbstractIdentityStore.js +13 -0
- package/dist/core/storage/AbstractStorageStore.d.ts +16 -0
- package/dist/core/storage/AbstractStorageStore.js +17 -0
- package/dist/core/storage/JsonIdentityStore.d.ts +29 -0
- package/dist/core/storage/JsonIdentityStore.js +39 -0
- package/dist/core/storage/JsonStorageStore.d.ts +59 -0
- package/dist/core/storage/JsonStorageStore.js +110 -0
- package/dist/core/storage/index.d.ts +11 -0
- package/dist/core/storage/index.js +18 -0
- package/dist/core/storage/types.d.ts +28 -0
- package/dist/core/storage/types.js +7 -0
- package/dist/core/trust/index.d.ts +10 -0
- package/dist/core/trust/index.js +15 -0
- package/dist/core/trust/storage/AbstractTrustStore.d.ts +23 -0
- package/dist/core/trust/storage/AbstractTrustStore.js +13 -0
- package/dist/core/trust/storage/JsonTrustStore.d.ts +33 -0
- package/dist/core/trust/storage/JsonTrustStore.js +42 -0
- package/dist/core/trust/trustUtils.d.ts +78 -0
- package/dist/core/trust/trustUtils.js +41 -0
- package/dist/core/trust/types.d.ts +53 -0
- package/dist/core/trust/types.js +7 -0
- package/dist/core/utils/identity.d.ts +20 -0
- package/dist/core/utils/identity.js +22 -0
- package/dist/core/utils/index.d.ts +70 -0
- package/dist/core/utils/index.js +124 -0
- package/dist/core/utils/types.d.ts +10 -0
- package/dist/core/utils/types.js +7 -0
- package/dist/core/utils/validation.d.ts +14 -0
- package/dist/core/utils/validation.js +13 -0
- package/dist/index.d.ts +7 -0
- package/dist/index.js +8 -0
- package/dist/server/btpsServer.d.ts +292 -0
- package/dist/server/btpsServer.js +827 -0
- package/dist/server/index.d.ts +11 -0
- package/dist/server/index.js +15 -0
- package/dist/server/libs/abstractRateLimiter.d.ts +10 -0
- package/dist/server/libs/abstractRateLimiter.js +15 -0
- package/dist/server/libs/artifactSizeGuard.d.ts +27 -0
- package/dist/server/libs/artifactSizeGuard.js +44 -0
- package/dist/server/libs/artifactTimeWindow.d.ts +24 -0
- package/dist/server/libs/artifactTimeWindow.js +30 -0
- package/dist/server/libs/btpsFactory.d.ts +29 -0
- package/dist/server/libs/btpsFactory.js +49 -0
- package/dist/server/libs/btpsLightweightFactory.d.ts +35 -0
- package/dist/server/libs/btpsLightweightFactory.js +37 -0
- package/dist/server/libs/btpsRegistry.d.ts +14 -0
- package/dist/server/libs/btpsRegistry.js +16 -0
- package/dist/server/libs/btpsSimpleMetricsTracker.d.ts +13 -0
- package/dist/server/libs/btpsSimpleMetricsTracker.js +21 -0
- package/dist/server/libs/btpsSimpleRateLimiter.d.ts +28 -0
- package/dist/server/libs/btpsSimpleRateLimiter.js +46 -0
- package/dist/server/libs/connectionTimeout.d.ts +16 -0
- package/dist/server/libs/connectionTimeout.js +14 -0
- package/dist/server/libs/defaultMiddleware.d.ts +8 -0
- package/dist/server/libs/defaultMiddleware.js +128 -0
- package/dist/server/libs/inFlightLimit.d.ts +18 -0
- package/dist/server/libs/inFlightLimit.js +17 -0
- package/dist/server/libs/index.d.ts +18 -0
- package/dist/server/libs/index.js +34 -0
- package/dist/server/libs/middlewareManager.d.ts +59 -0
- package/dist/server/libs/middlewareManager.js +126 -0
- package/dist/server/libs/type.d.ts +22 -0
- package/dist/server/libs/type.js +7 -0
- package/dist/server/types.d.ts +236 -0
- package/dist/server/types.js +7 -0
- package/package.json +126 -4
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
* Copyright (c) 2025 Bhupendra Tamang
|
|
4
|
+
* Licensed under the Apache License, Version 2.0
|
|
5
|
+
* https://www.apache.org/licenses/LICENSE-2.0
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import { AGENT_ACTIONS_REQUIRING_DOCUMENT } from "../constants/index.js";
|
|
9
|
+
import {
|
|
10
|
+
BtpAgentMutationSchema,
|
|
11
|
+
BtpIdsPayloadSchema,
|
|
12
|
+
BtpAgentQuerySchema,
|
|
13
|
+
BtpAgentCreateSchema
|
|
14
|
+
} from "./schema.js";
|
|
15
|
+
import {
|
|
16
|
+
BtpAuthReqDocSchema,
|
|
17
|
+
BtpDocumentSchema,
|
|
18
|
+
BtpLifecycleEventSchema,
|
|
19
|
+
BtpTrustReqDocSchema,
|
|
20
|
+
BtpTrustResDocSchema
|
|
21
|
+
} from "./btpsDocsSchema.js";
|
|
22
|
+
const processBtpDocSchema = (bptArtifactType) => {
|
|
23
|
+
switch (bptArtifactType) {
|
|
24
|
+
case "TRUST_RES":
|
|
25
|
+
return BtpTrustResDocSchema;
|
|
26
|
+
case "TRUST_REQ":
|
|
27
|
+
return BtpTrustReqDocSchema;
|
|
28
|
+
case "BTPS_DOC":
|
|
29
|
+
return BtpDocumentSchema;
|
|
30
|
+
case "BTPS_EVENT":
|
|
31
|
+
return BtpLifecycleEventSchema;
|
|
32
|
+
default:
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
}, lifecycleEventEnvelopeProblem = (event, envelope) => {
|
|
36
|
+
if (event.id !== envelope.id) return "an event's id must be the id of the artifact carrying it";
|
|
37
|
+
if (event.document.from !== envelope.from && event.document.from !== envelope.to)
|
|
38
|
+
return "an event may only be about an invoice between its own sender and receiver";
|
|
39
|
+
}, decryptedDocumentProblem = (document, envelope) => {
|
|
40
|
+
const schema = processBtpDocSchema(envelope.type);
|
|
41
|
+
if (!schema) return;
|
|
42
|
+
const parsed = schema.safeParse(document);
|
|
43
|
+
if (!parsed.success) return "Document type does not match the artifact type";
|
|
44
|
+
if (envelope.type !== "BTPS_EVENT") return;
|
|
45
|
+
const event = parsed.data, { id, from, to } = envelope;
|
|
46
|
+
return typeof id != "string" || typeof from != "string" || typeof to != "string" ? "an event must travel in an artifact with an id, from and to" : lifecycleEventEnvelopeProblem(event, { id, from, to });
|
|
47
|
+
}, processBtpDocSchemaForAgent = (actionType) => ({
|
|
48
|
+
"trust.request": BtpTrustReqDocSchema,
|
|
49
|
+
"trust.respond": BtpTrustResDocSchema,
|
|
50
|
+
"trust.update": BtpAgentMutationSchema,
|
|
51
|
+
"trust.delete": BtpIdsPayloadSchema,
|
|
52
|
+
"artifact.send": BtpDocumentSchema,
|
|
53
|
+
"event.send": BtpLifecycleEventSchema,
|
|
54
|
+
"auth.request": BtpAuthReqDocSchema,
|
|
55
|
+
"auth.refresh": BtpAuthReqDocSchema,
|
|
56
|
+
"inbox.fetch": BtpAgentQuerySchema,
|
|
57
|
+
"inbox.seen": BtpIdsPayloadSchema,
|
|
58
|
+
"inbox.delete": BtpIdsPayloadSchema,
|
|
59
|
+
"sentbox.fetch": BtpAgentQuerySchema,
|
|
60
|
+
"sentbox.delete": BtpIdsPayloadSchema,
|
|
61
|
+
"outbox.fetch": BtpAgentQuerySchema,
|
|
62
|
+
"outbox.cancel": BtpIdsPayloadSchema,
|
|
63
|
+
"draft.fetch": BtpAgentQuerySchema,
|
|
64
|
+
"draft.create": BtpAgentCreateSchema,
|
|
65
|
+
"draft.update": BtpAgentMutationSchema,
|
|
66
|
+
"draft.delete": BtpIdsPayloadSchema,
|
|
67
|
+
"trash.fetch": BtpAgentQuerySchema,
|
|
68
|
+
"trash.delete": BtpIdsPayloadSchema
|
|
69
|
+
})[actionType] || null, validateAgentDocument = (action, encryption, document) => {
|
|
70
|
+
if (AGENT_ACTIONS_REQUIRING_DOCUMENT.includes(
|
|
71
|
+
action
|
|
72
|
+
) && !document || encryption && typeof document != "string" || encryption && action === "auth.request")
|
|
73
|
+
return !1;
|
|
74
|
+
if (document) {
|
|
75
|
+
const expectedSchema = processBtpDocSchemaForAgent(action);
|
|
76
|
+
if (expectedSchema && !expectedSchema.safeParse(document).success)
|
|
77
|
+
return !1;
|
|
78
|
+
}
|
|
79
|
+
return !0;
|
|
80
|
+
};
|
|
81
|
+
export {
|
|
82
|
+
decryptedDocumentProblem,
|
|
83
|
+
lifecycleEventEnvelopeProblem,
|
|
84
|
+
processBtpDocSchema,
|
|
85
|
+
processBtpDocSchemaForAgent,
|
|
86
|
+
validateAgentDocument
|
|
87
|
+
};
|