@originals/sdk 1.1.0 → 1.4.2

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 (247) hide show
  1. package/package.json +3 -2
  2. package/src/did/DIDManager.ts +1 -1
  3. package/src/did/WebVHManager.ts +11 -2
  4. package/src/examples/create-module-original.ts +435 -0
  5. package/src/examples/full-lifecycle-flow.ts +514 -0
  6. package/src/examples/run.ts +59 -4
  7. package/src/index.ts +69 -3
  8. package/src/kinds/KindRegistry.ts +290 -0
  9. package/src/kinds/index.ts +74 -0
  10. package/src/kinds/types.ts +470 -0
  11. package/src/kinds/validators/AgentValidator.ts +257 -0
  12. package/src/kinds/validators/AppValidator.ts +211 -0
  13. package/src/kinds/validators/DatasetValidator.ts +242 -0
  14. package/src/kinds/validators/DocumentValidator.ts +311 -0
  15. package/src/kinds/validators/MediaValidator.ts +269 -0
  16. package/src/kinds/validators/ModuleValidator.ts +225 -0
  17. package/src/kinds/validators/base.ts +276 -0
  18. package/src/kinds/validators/index.ts +12 -0
  19. package/src/lifecycle/LifecycleManager.ts +909 -1
  20. package/src/resources/ResourceManager.ts +655 -0
  21. package/src/resources/index.ts +21 -0
  22. package/src/resources/types.ts +202 -0
  23. package/src/types/common.ts +1 -1
  24. package/src/vc/CredentialManager.ts +647 -2
  25. package/tests/integration/createTypedOriginal.test.ts +379 -0
  26. package/tests/performance/BatchOperations.perf.test.ts +2 -2
  27. package/tests/unit/kinds/KindRegistry.test.ts +329 -0
  28. package/tests/unit/kinds/types.test.ts +409 -0
  29. package/tests/unit/kinds/validators.test.ts +651 -0
  30. package/tests/unit/lifecycle/LifecycleManager.cleanapi.test.ts +441 -0
  31. package/tests/unit/resources/ResourceManager.test.ts +740 -0
  32. package/tests/unit/vc/CredentialManager.helpers.test.ts +527 -0
  33. package/tsconfig.json +0 -1
  34. package/.turbo/turbo-build.log +0 -1
  35. package/.turbo/turbo-test.log +0 -68353
  36. package/dist/adapters/FeeOracleMock.d.ts +0 -6
  37. package/dist/adapters/FeeOracleMock.js +0 -8
  38. package/dist/adapters/index.d.ts +0 -4
  39. package/dist/adapters/index.js +0 -4
  40. package/dist/adapters/providers/OrdHttpProvider.d.ts +0 -56
  41. package/dist/adapters/providers/OrdHttpProvider.js +0 -110
  42. package/dist/adapters/providers/OrdMockProvider.d.ts +0 -70
  43. package/dist/adapters/providers/OrdMockProvider.js +0 -75
  44. package/dist/adapters/types.d.ts +0 -71
  45. package/dist/adapters/types.js +0 -1
  46. package/dist/bitcoin/BitcoinManager.d.ts +0 -15
  47. package/dist/bitcoin/BitcoinManager.js +0 -262
  48. package/dist/bitcoin/BroadcastClient.d.ts +0 -30
  49. package/dist/bitcoin/BroadcastClient.js +0 -35
  50. package/dist/bitcoin/OrdinalsClient.d.ts +0 -21
  51. package/dist/bitcoin/OrdinalsClient.js +0 -105
  52. package/dist/bitcoin/PSBTBuilder.d.ts +0 -24
  53. package/dist/bitcoin/PSBTBuilder.js +0 -80
  54. package/dist/bitcoin/fee-calculation.d.ts +0 -14
  55. package/dist/bitcoin/fee-calculation.js +0 -31
  56. package/dist/bitcoin/providers/OrdNodeProvider.d.ts +0 -38
  57. package/dist/bitcoin/providers/OrdNodeProvider.js +0 -67
  58. package/dist/bitcoin/providers/OrdinalsProvider.d.ts +0 -33
  59. package/dist/bitcoin/providers/OrdinalsProvider.js +0 -50
  60. package/dist/bitcoin/providers/types.d.ts +0 -63
  61. package/dist/bitcoin/providers/types.js +0 -1
  62. package/dist/bitcoin/transactions/commit.d.ts +0 -89
  63. package/dist/bitcoin/transactions/commit.js +0 -311
  64. package/dist/bitcoin/transactions/index.d.ts +0 -7
  65. package/dist/bitcoin/transactions/index.js +0 -8
  66. package/dist/bitcoin/transfer.d.ts +0 -9
  67. package/dist/bitcoin/transfer.js +0 -26
  68. package/dist/bitcoin/utxo-selection.d.ts +0 -78
  69. package/dist/bitcoin/utxo-selection.js +0 -237
  70. package/dist/bitcoin/utxo.d.ts +0 -26
  71. package/dist/bitcoin/utxo.js +0 -78
  72. package/dist/contexts/credentials-v1.json +0 -195
  73. package/dist/contexts/credentials-v2-examples.json +0 -5
  74. package/dist/contexts/credentials-v2.json +0 -301
  75. package/dist/contexts/credentials.json +0 -195
  76. package/dist/contexts/data-integrity-v2.json +0 -81
  77. package/dist/contexts/dids.json +0 -57
  78. package/dist/contexts/ed255192020.json +0 -93
  79. package/dist/contexts/ordinals-plus.json +0 -23
  80. package/dist/contexts/originals.json +0 -22
  81. package/dist/core/OriginalsSDK.d.ts +0 -158
  82. package/dist/core/OriginalsSDK.js +0 -274
  83. package/dist/crypto/Multikey.d.ts +0 -30
  84. package/dist/crypto/Multikey.js +0 -149
  85. package/dist/crypto/Signer.d.ts +0 -21
  86. package/dist/crypto/Signer.js +0 -196
  87. package/dist/crypto/noble-init.d.ts +0 -18
  88. package/dist/crypto/noble-init.js +0 -106
  89. package/dist/did/BtcoDidResolver.d.ts +0 -57
  90. package/dist/did/BtcoDidResolver.js +0 -166
  91. package/dist/did/DIDManager.d.ts +0 -101
  92. package/dist/did/DIDManager.js +0 -493
  93. package/dist/did/Ed25519Verifier.d.ts +0 -30
  94. package/dist/did/Ed25519Verifier.js +0 -59
  95. package/dist/did/KeyManager.d.ts +0 -17
  96. package/dist/did/KeyManager.js +0 -207
  97. package/dist/did/WebVHManager.d.ts +0 -100
  98. package/dist/did/WebVHManager.js +0 -304
  99. package/dist/did/createBtcoDidDocument.d.ts +0 -10
  100. package/dist/did/createBtcoDidDocument.js +0 -42
  101. package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +0 -23
  102. package/dist/did/providers/OrdinalsClientProviderAdapter.js +0 -51
  103. package/dist/events/EventEmitter.d.ts +0 -115
  104. package/dist/events/EventEmitter.js +0 -198
  105. package/dist/events/index.d.ts +0 -7
  106. package/dist/events/index.js +0 -6
  107. package/dist/events/types.d.ts +0 -286
  108. package/dist/events/types.js +0 -9
  109. package/dist/examples/basic-usage.d.ts +0 -3
  110. package/dist/examples/basic-usage.js +0 -62
  111. package/dist/examples/run.d.ts +0 -1
  112. package/dist/examples/run.js +0 -4
  113. package/dist/index.d.ts +0 -39
  114. package/dist/index.js +0 -47
  115. package/dist/lifecycle/BatchOperations.d.ts +0 -147
  116. package/dist/lifecycle/BatchOperations.js +0 -251
  117. package/dist/lifecycle/LifecycleManager.d.ts +0 -116
  118. package/dist/lifecycle/LifecycleManager.js +0 -971
  119. package/dist/lifecycle/OriginalsAsset.d.ts +0 -164
  120. package/dist/lifecycle/OriginalsAsset.js +0 -380
  121. package/dist/lifecycle/ProvenanceQuery.d.ts +0 -126
  122. package/dist/lifecycle/ProvenanceQuery.js +0 -220
  123. package/dist/lifecycle/ResourceVersioning.d.ts +0 -73
  124. package/dist/lifecycle/ResourceVersioning.js +0 -127
  125. package/dist/migration/MigrationManager.d.ts +0 -86
  126. package/dist/migration/MigrationManager.js +0 -412
  127. package/dist/migration/audit/AuditLogger.d.ts +0 -51
  128. package/dist/migration/audit/AuditLogger.js +0 -156
  129. package/dist/migration/checkpoint/CheckpointManager.d.ts +0 -31
  130. package/dist/migration/checkpoint/CheckpointManager.js +0 -96
  131. package/dist/migration/checkpoint/CheckpointStorage.d.ts +0 -26
  132. package/dist/migration/checkpoint/CheckpointStorage.js +0 -89
  133. package/dist/migration/index.d.ts +0 -22
  134. package/dist/migration/index.js +0 -27
  135. package/dist/migration/operations/BaseMigration.d.ts +0 -48
  136. package/dist/migration/operations/BaseMigration.js +0 -83
  137. package/dist/migration/operations/PeerToBtcoMigration.d.ts +0 -25
  138. package/dist/migration/operations/PeerToBtcoMigration.js +0 -67
  139. package/dist/migration/operations/PeerToWebvhMigration.d.ts +0 -19
  140. package/dist/migration/operations/PeerToWebvhMigration.js +0 -46
  141. package/dist/migration/operations/WebvhToBtcoMigration.d.ts +0 -25
  142. package/dist/migration/operations/WebvhToBtcoMigration.js +0 -67
  143. package/dist/migration/rollback/RollbackManager.d.ts +0 -29
  144. package/dist/migration/rollback/RollbackManager.js +0 -146
  145. package/dist/migration/state/StateMachine.d.ts +0 -25
  146. package/dist/migration/state/StateMachine.js +0 -76
  147. package/dist/migration/state/StateTracker.d.ts +0 -36
  148. package/dist/migration/state/StateTracker.js +0 -123
  149. package/dist/migration/types.d.ts +0 -306
  150. package/dist/migration/types.js +0 -33
  151. package/dist/migration/validation/BitcoinValidator.d.ts +0 -13
  152. package/dist/migration/validation/BitcoinValidator.js +0 -83
  153. package/dist/migration/validation/CredentialValidator.d.ts +0 -13
  154. package/dist/migration/validation/CredentialValidator.js +0 -46
  155. package/dist/migration/validation/DIDCompatibilityValidator.d.ts +0 -16
  156. package/dist/migration/validation/DIDCompatibilityValidator.js +0 -127
  157. package/dist/migration/validation/LifecycleValidator.d.ts +0 -10
  158. package/dist/migration/validation/LifecycleValidator.js +0 -52
  159. package/dist/migration/validation/StorageValidator.d.ts +0 -10
  160. package/dist/migration/validation/StorageValidator.js +0 -65
  161. package/dist/migration/validation/ValidationPipeline.d.ts +0 -29
  162. package/dist/migration/validation/ValidationPipeline.js +0 -180
  163. package/dist/storage/LocalStorageAdapter.d.ts +0 -11
  164. package/dist/storage/LocalStorageAdapter.js +0 -53
  165. package/dist/storage/MemoryStorageAdapter.d.ts +0 -6
  166. package/dist/storage/MemoryStorageAdapter.js +0 -21
  167. package/dist/storage/StorageAdapter.d.ts +0 -16
  168. package/dist/storage/StorageAdapter.js +0 -1
  169. package/dist/storage/index.d.ts +0 -2
  170. package/dist/storage/index.js +0 -2
  171. package/dist/types/bitcoin.d.ts +0 -84
  172. package/dist/types/bitcoin.js +0 -1
  173. package/dist/types/common.d.ts +0 -82
  174. package/dist/types/common.js +0 -1
  175. package/dist/types/credentials.d.ts +0 -75
  176. package/dist/types/credentials.js +0 -1
  177. package/dist/types/did.d.ts +0 -26
  178. package/dist/types/did.js +0 -1
  179. package/dist/types/index.d.ts +0 -5
  180. package/dist/types/index.js +0 -5
  181. package/dist/types/network.d.ts +0 -78
  182. package/dist/types/network.js +0 -145
  183. package/dist/utils/EventLogger.d.ts +0 -71
  184. package/dist/utils/EventLogger.js +0 -232
  185. package/dist/utils/Logger.d.ts +0 -106
  186. package/dist/utils/Logger.js +0 -257
  187. package/dist/utils/MetricsCollector.d.ts +0 -110
  188. package/dist/utils/MetricsCollector.js +0 -264
  189. package/dist/utils/bitcoin-address.d.ts +0 -38
  190. package/dist/utils/bitcoin-address.js +0 -113
  191. package/dist/utils/cbor.d.ts +0 -2
  192. package/dist/utils/cbor.js +0 -9
  193. package/dist/utils/encoding.d.ts +0 -37
  194. package/dist/utils/encoding.js +0 -120
  195. package/dist/utils/hash.d.ts +0 -1
  196. package/dist/utils/hash.js +0 -5
  197. package/dist/utils/retry.d.ts +0 -10
  198. package/dist/utils/retry.js +0 -35
  199. package/dist/utils/satoshi-validation.d.ts +0 -60
  200. package/dist/utils/satoshi-validation.js +0 -156
  201. package/dist/utils/serialization.d.ts +0 -14
  202. package/dist/utils/serialization.js +0 -76
  203. package/dist/utils/telemetry.d.ts +0 -17
  204. package/dist/utils/telemetry.js +0 -24
  205. package/dist/utils/validation.d.ts +0 -5
  206. package/dist/utils/validation.js +0 -98
  207. package/dist/vc/CredentialManager.d.ts +0 -22
  208. package/dist/vc/CredentialManager.js +0 -227
  209. package/dist/vc/Issuer.d.ts +0 -27
  210. package/dist/vc/Issuer.js +0 -70
  211. package/dist/vc/Verifier.d.ts +0 -16
  212. package/dist/vc/Verifier.js +0 -50
  213. package/dist/vc/cryptosuites/bbs.d.ts +0 -44
  214. package/dist/vc/cryptosuites/bbs.js +0 -213
  215. package/dist/vc/cryptosuites/bbsSimple.d.ts +0 -9
  216. package/dist/vc/cryptosuites/bbsSimple.js +0 -12
  217. package/dist/vc/cryptosuites/eddsa.d.ts +0 -30
  218. package/dist/vc/cryptosuites/eddsa.js +0 -81
  219. package/dist/vc/documentLoader.d.ts +0 -16
  220. package/dist/vc/documentLoader.js +0 -59
  221. package/dist/vc/proofs/data-integrity.d.ts +0 -21
  222. package/dist/vc/proofs/data-integrity.js +0 -15
  223. package/dist/vc/utils/jsonld.d.ts +0 -2
  224. package/dist/vc/utils/jsonld.js +0 -15
  225. package/test/logs/did_webvh_QmQsRNhXxPSCSeLjpbKYcNMZj8b1kBQAoC6cZmkFAgmpHt_example_com.jsonl +0 -1
  226. package/test/logs/did_webvh_QmSQkpD58qxcqMWHYcEmDUn3wk7hHvJwzYTrZmhh6zjPQ8_example_com_users_alice123_profile.jsonl +0 -1
  227. package/test/logs/did_webvh_QmTMda6VW3cUPdKk5Yc3onnv1vdgEumvWWdP2noAYFSjeG_example_com.jsonl +0 -1
  228. package/test/logs/did_webvh_QmTkb8KnCYcsnKKDCY4eUQuKQdKJLrCinvhw13v3zETxpE_example_com_users_etc_passwd.jsonl +0 -1
  229. package/test/logs/did_webvh_QmTn9FdCfpXFDrxHH52pwB4iNrDFVvNDjJ5FQTcDbmM3Fg_example_com.jsonl +0 -1
  230. package/test/logs/did_webvh_QmUCQUi1xjtJjnSQ1XJZgKqcWgErx1v7E2dz4DAPraAyJP_example_com_etc_passwd.jsonl +0 -1
  231. package/test/logs/did_webvh_QmUENQJCDKBJVRS5BkL6zjaUvcRjkb9xHmy7foCgRjmv3W_example_com.jsonl +0 -1
  232. package/test/logs/did_webvh_QmUPdGyjYBEnQ3aQUkmqyyBKTyjvCP5RZQGiaEDeTtf6dc_example_com.jsonl +0 -1
  233. package/test/logs/did_webvh_QmUoHTuHMWzQM29ZFrE9VLtMxkZ5u869yqee8LwcCLN39M_example_com.jsonl +0 -1
  234. package/test/logs/did_webvh_QmUrnms8G65ggVKsr9oQeWrLUBuGChwQPPb2LCFvaoNxaw_example_com_users_alice.jsonl +0 -1
  235. package/test/logs/did_webvh_QmUwiw3eSXdHG1hPvoAGu3cuK5jF4aXRYDLBAjPXfv1qzb_example_com_level1_level2.jsonl +0 -1
  236. package/test/logs/did_webvh_QmW7bzKh6yFEKNAtmVsrPGvvsMHTUQdzJSNsTZkbuGFpbj_example_com_secret.jsonl +0 -1
  237. package/test/logs/did_webvh_QmXbFTFBBJ8zpjdz9WE1DNN44A2wprFmdvAubjSffeyoAG_example_com.jsonl +0 -1
  238. package/test/logs/did_webvh_QmXyVXFPCTffGb2mTUFDeMCsScjnpLWkyUkVkB6q6QoeBf_example_com_C_Windows_System32.jsonl +0 -1
  239. package/test/logs/did_webvh_QmZK9B81gxZtvo5fYHYKDtKt8zZfZZPhmCMhbujBJuRRzE_example_com_etc_passwd.jsonl +0 -1
  240. package/test/logs/did_webvh_QmbNLCVSdXSVLrwFBvCBQPAabjtRb1SGHjkGVyw3QUbfBL_example_com_users_etc_passwd.jsonl +0 -1
  241. package/test/logs/did_webvh_QmbeaicmGW3Q7Yzbqmftc8a9jLBngokveb5A2KVKfVGZRb_example_com_my_org_user_name_test_123.jsonl +0 -1
  242. package/test/logs/did_webvh_Qmdv7c7AjUreUfoKyvkN2UpAWTozxKsv99srQetPJMJEnp_example_com_users_etc_passwd.jsonl +0 -1
  243. package/test/logs/did_webvh_QmeioWY3uypYLkYpCXe9eCYnn4xBVruP9C1d79azMrTEHG_example_com.jsonl +0 -1
  244. package/test/logs/did_webvh_Qmf4QH5dsA6Ecr5HJ6KaJL9uJRyY8RxrQdqoRCM25DzvPi_example_com_users_alice.jsonl +0 -1
  245. package/tests/e2e/README.md +0 -97
  246. package/tests/e2e/example.spec.ts +0 -78
  247. package/tsconfig.tsbuildinfo +0 -1
@@ -1,51 +0,0 @@
1
- export class OrdinalsClientProviderAdapter {
2
- constructor(client, configOrBaseUrl) {
3
- this.client = client;
4
- if (typeof configOrBaseUrl === 'string') {
5
- this.config = { baseUrl: configOrBaseUrl };
6
- }
7
- else {
8
- this.config = configOrBaseUrl;
9
- }
10
- }
11
- async getSatInfo(satNumber) {
12
- return this.client.getSatInfo(satNumber);
13
- }
14
- async resolveInscription(inscriptionId) {
15
- const base = (this.config.baseUrl || '').replace(/\/$/, '');
16
- if (!base) {
17
- throw new Error('OrdinalsClientProviderAdapter requires a baseUrl');
18
- }
19
- try {
20
- // Use configurable fetch function or default to global fetch
21
- const fetchFn = this.config.fetchFn || fetch;
22
- const timeout = this.config.timeout || 10000; // 10 second default timeout
23
- const fetchOptions = {
24
- headers: { 'Accept': 'application/json' },
25
- signal: AbortSignal.timeout(timeout)
26
- };
27
- const res = await fetchFn(`${base}/inscription/${inscriptionId}`, fetchOptions);
28
- if (!res.ok) {
29
- // Log warning but don't throw - allow graceful degradation
30
- console.warn(`Failed to resolve inscription ${inscriptionId}: HTTP ${res.status}`);
31
- throw new Error(`HTTP ${res.status}: ${res.statusText}`);
32
- }
33
- const info = await res.json();
34
- return {
35
- id: info.inscription_id || inscriptionId,
36
- sat: typeof info.sat === 'number' ? info.sat : Number(info.sat || 0),
37
- content_type: info.content_type || 'text/plain',
38
- content_url: info.content_url || `${base}/content/${inscriptionId}`
39
- };
40
- }
41
- catch (err) {
42
- // Log error for debugging but re-throw for caller to handle
43
- console.warn(`Failed to resolve inscription ${inscriptionId}:`, err.message || String(err));
44
- throw new Error(`Failed to resolve inscription: ${inscriptionId}`);
45
- }
46
- }
47
- async getMetadata(inscriptionId) {
48
- return this.client.getMetadata(inscriptionId);
49
- }
50
- }
51
- export default OrdinalsClientProviderAdapter;
@@ -1,115 +0,0 @@
1
- /**
2
- * Type-safe EventEmitter for Originals SDK
3
- *
4
- * Features:
5
- * - Type-safe event emission and subscription
6
- * - Support for both sync and async handlers
7
- * - Error isolation (one failing handler doesn't affect others)
8
- * - Event namespacing
9
- * - Performance optimized (<1ms overhead per event)
10
- */
11
- import type { EventHandler, EventTypeMap } from './types';
12
- /**
13
- * EventEmitter class for managing event subscriptions and emissions
14
- */
15
- export declare class EventEmitter {
16
- private handlers;
17
- private onceHandlers;
18
- /**
19
- * Subscribe to an event
20
- *
21
- * @param eventType - The type of event to listen for
22
- * @param handler - The handler function to call when the event is emitted
23
- * @returns A function to unsubscribe the handler
24
- *
25
- * @example
26
- * ```typescript
27
- * const unsubscribe = emitter.on('asset:created', (event) => {
28
- * console.log('Asset created:', event.asset.id);
29
- * });
30
- *
31
- * // Later, to unsubscribe:
32
- * unsubscribe();
33
- * ```
34
- */
35
- on<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): () => void;
36
- /**
37
- * Subscribe to an event for a single emission
38
- *
39
- * @param eventType - The type of event to listen for
40
- * @param handler - The handler function to call when the event is emitted (only once)
41
- * @returns A function to unsubscribe the handler
42
- *
43
- * @example
44
- * ```typescript
45
- * emitter.once('asset:migrated', (event) => {
46
- * console.log('Asset migrated once:', event.asset.id);
47
- * });
48
- * ```
49
- */
50
- once<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): () => void;
51
- /**
52
- * Unsubscribe from an event
53
- *
54
- * @param eventType - The type of event to stop listening for
55
- * @param handler - The handler function to remove
56
- *
57
- * @example
58
- * ```typescript
59
- * const handler = (event) => console.log(event);
60
- * emitter.on('asset:created', handler);
61
- * emitter.off('asset:created', handler);
62
- * ```
63
- */
64
- off<K extends keyof EventTypeMap>(eventType: K, handler: EventHandler<EventTypeMap[K]>): void;
65
- /**
66
- * Emit an event to all subscribed handlers
67
- *
68
- * @param event - The event to emit
69
- *
70
- * Features:
71
- * - Handlers are called in subscription order
72
- * - Async handlers are awaited
73
- * - Errors in handlers are isolated (logged but don't affect other handlers)
74
- * - Once handlers are automatically removed after execution
75
- *
76
- * @example
77
- * ```typescript
78
- * emitter.emit({
79
- * type: 'asset:created',
80
- * timestamp: new Date().toISOString(),
81
- * asset: { id: 'did:peer:123', layer: 'did:peer', resourceCount: 1 }
82
- * });
83
- * ```
84
- */
85
- emit<K extends keyof EventTypeMap>(event: EventTypeMap[K]): Promise<void>;
86
- /**
87
- * Remove all handlers for a specific event type, or all handlers if no type specified
88
- *
89
- * @param eventType - Optional event type to clear handlers for
90
- *
91
- * @example
92
- * ```typescript
93
- * // Remove all handlers for 'asset:created'
94
- * emitter.removeAllListeners('asset:created');
95
- *
96
- * // Remove all handlers for all events
97
- * emitter.removeAllListeners();
98
- * ```
99
- */
100
- removeAllListeners<K extends keyof EventTypeMap>(eventType?: K): void;
101
- /**
102
- * Get the number of handlers for a specific event type
103
- *
104
- * @param eventType - The event type to check
105
- * @returns The number of handlers subscribed to this event type
106
- */
107
- listenerCount<K extends keyof EventTypeMap>(eventType: K): number;
108
- /**
109
- * Check if there are any handlers for a specific event type
110
- *
111
- * @param eventType - The event type to check
112
- * @returns True if there are any handlers subscribed
113
- */
114
- hasListeners<K extends keyof EventTypeMap>(eventType: K): boolean;
115
- }
@@ -1,198 +0,0 @@
1
- /**
2
- * Type-safe EventEmitter for Originals SDK
3
- *
4
- * Features:
5
- * - Type-safe event emission and subscription
6
- * - Support for both sync and async handlers
7
- * - Error isolation (one failing handler doesn't affect others)
8
- * - Event namespacing
9
- * - Performance optimized (<1ms overhead per event)
10
- */
11
- /**
12
- * EventEmitter class for managing event subscriptions and emissions
13
- */
14
- export class EventEmitter {
15
- constructor() {
16
- this.handlers = new Map();
17
- this.onceHandlers = new Map();
18
- }
19
- /**
20
- * Subscribe to an event
21
- *
22
- * @param eventType - The type of event to listen for
23
- * @param handler - The handler function to call when the event is emitted
24
- * @returns A function to unsubscribe the handler
25
- *
26
- * @example
27
- * ```typescript
28
- * const unsubscribe = emitter.on('asset:created', (event) => {
29
- * console.log('Asset created:', event.asset.id);
30
- * });
31
- *
32
- * // Later, to unsubscribe:
33
- * unsubscribe();
34
- * ```
35
- */
36
- on(eventType, handler) {
37
- if (!this.handlers.has(eventType)) {
38
- this.handlers.set(eventType, new Set());
39
- }
40
- this.handlers.get(eventType).add(handler);
41
- // Return unsubscribe function
42
- return () => this.off(eventType, handler);
43
- }
44
- /**
45
- * Subscribe to an event for a single emission
46
- *
47
- * @param eventType - The type of event to listen for
48
- * @param handler - The handler function to call when the event is emitted (only once)
49
- * @returns A function to unsubscribe the handler
50
- *
51
- * @example
52
- * ```typescript
53
- * emitter.once('asset:migrated', (event) => {
54
- * console.log('Asset migrated once:', event.asset.id);
55
- * });
56
- * ```
57
- */
58
- once(eventType, handler) {
59
- if (!this.onceHandlers.has(eventType)) {
60
- this.onceHandlers.set(eventType, new Set());
61
- }
62
- this.onceHandlers.get(eventType).add(handler);
63
- // Return unsubscribe function
64
- return () => {
65
- const handlers = this.onceHandlers.get(eventType);
66
- if (handlers) {
67
- handlers.delete(handler);
68
- }
69
- };
70
- }
71
- /**
72
- * Unsubscribe from an event
73
- *
74
- * @param eventType - The type of event to stop listening for
75
- * @param handler - The handler function to remove
76
- *
77
- * @example
78
- * ```typescript
79
- * const handler = (event) => console.log(event);
80
- * emitter.on('asset:created', handler);
81
- * emitter.off('asset:created', handler);
82
- * ```
83
- */
84
- off(eventType, handler) {
85
- const handlers = this.handlers.get(eventType);
86
- if (handlers) {
87
- handlers.delete(handler);
88
- }
89
- const onceHandlers = this.onceHandlers.get(eventType);
90
- if (onceHandlers) {
91
- onceHandlers.delete(handler);
92
- }
93
- }
94
- /**
95
- * Emit an event to all subscribed handlers
96
- *
97
- * @param event - The event to emit
98
- *
99
- * Features:
100
- * - Handlers are called in subscription order
101
- * - Async handlers are awaited
102
- * - Errors in handlers are isolated (logged but don't affect other handlers)
103
- * - Once handlers are automatically removed after execution
104
- *
105
- * @example
106
- * ```typescript
107
- * emitter.emit({
108
- * type: 'asset:created',
109
- * timestamp: new Date().toISOString(),
110
- * asset: { id: 'did:peer:123', layer: 'did:peer', resourceCount: 1 }
111
- * });
112
- * ```
113
- */
114
- async emit(event) {
115
- const eventType = event.type;
116
- // Get regular handlers
117
- const handlers = this.handlers.get(eventType);
118
- if (handlers && handlers.size > 0) {
119
- // Create array to avoid modification during iteration
120
- const handlerArray = Array.from(handlers);
121
- for (const handler of handlerArray) {
122
- try {
123
- await handler(event);
124
- }
125
- catch (error) {
126
- // Error isolation: log but don't throw
127
- // This ensures one failing handler doesn't affect others
128
- if (typeof console !== 'undefined' && console.error) {
129
- console.error(`Event handler error for ${eventType}:`, error);
130
- }
131
- }
132
- }
133
- }
134
- // Get and execute once handlers
135
- const onceHandlers = this.onceHandlers.get(eventType);
136
- if (onceHandlers && onceHandlers.size > 0) {
137
- // Create array to avoid modification during iteration
138
- const onceHandlerArray = Array.from(onceHandlers);
139
- // Clear once handlers before execution
140
- this.onceHandlers.delete(eventType);
141
- for (const handler of onceHandlerArray) {
142
- try {
143
- await handler(event);
144
- }
145
- catch (error) {
146
- // Error isolation: log but don't throw
147
- if (typeof console !== 'undefined' && console.error) {
148
- console.error(`Event handler error (once) for ${eventType}:`, error);
149
- }
150
- }
151
- }
152
- }
153
- }
154
- /**
155
- * Remove all handlers for a specific event type, or all handlers if no type specified
156
- *
157
- * @param eventType - Optional event type to clear handlers for
158
- *
159
- * @example
160
- * ```typescript
161
- * // Remove all handlers for 'asset:created'
162
- * emitter.removeAllListeners('asset:created');
163
- *
164
- * // Remove all handlers for all events
165
- * emitter.removeAllListeners();
166
- * ```
167
- */
168
- removeAllListeners(eventType) {
169
- if (eventType) {
170
- this.handlers.delete(eventType);
171
- this.onceHandlers.delete(eventType);
172
- }
173
- else {
174
- this.handlers.clear();
175
- this.onceHandlers.clear();
176
- }
177
- }
178
- /**
179
- * Get the number of handlers for a specific event type
180
- *
181
- * @param eventType - The event type to check
182
- * @returns The number of handlers subscribed to this event type
183
- */
184
- listenerCount(eventType) {
185
- const handlers = this.handlers.get(eventType);
186
- const onceHandlers = this.onceHandlers.get(eventType);
187
- return (handlers?.size || 0) + (onceHandlers?.size || 0);
188
- }
189
- /**
190
- * Check if there are any handlers for a specific event type
191
- *
192
- * @param eventType - The event type to check
193
- * @returns True if there are any handlers subscribed
194
- */
195
- hasListeners(eventType) {
196
- return this.listenerCount(eventType) > 0;
197
- }
198
- }
@@ -1,7 +0,0 @@
1
- /**
2
- * Events module for the Originals SDK
3
- *
4
- * Provides a type-safe event system for tracking asset lifecycle operations
5
- */
6
- export { EventEmitter } from './EventEmitter';
7
- export type { BaseEvent, AssetCreatedEvent, AssetMigratedEvent, AssetTransferredEvent, ResourcePublishedEvent, CredentialIssuedEvent, VerificationCompletedEvent, OriginalsEvent, EventHandler, EventTypeMap } from './types';
@@ -1,6 +0,0 @@
1
- /**
2
- * Events module for the Originals SDK
3
- *
4
- * Provides a type-safe event system for tracking asset lifecycle operations
5
- */
6
- export { EventEmitter } from './EventEmitter';
@@ -1,286 +0,0 @@
1
- /**
2
- * Event types for the Originals SDK asset lifecycle operations
3
- *
4
- * All events follow a consistent structure:
5
- * - type: Namespaced event name (e.g., 'asset:created')
6
- * - timestamp: ISO 8601 timestamp of when the event occurred
7
- * - Specific payload data relevant to the event
8
- */
9
- import { LayerType } from '../types';
10
- /**
11
- * Base event interface that all events extend
12
- */
13
- export interface BaseEvent {
14
- type: string;
15
- timestamp: string;
16
- }
17
- /**
18
- * Emitted when a new asset is created
19
- */
20
- export interface AssetCreatedEvent extends BaseEvent {
21
- type: 'asset:created';
22
- asset: {
23
- id: string;
24
- layer: LayerType;
25
- resourceCount: number;
26
- createdAt: string;
27
- };
28
- }
29
- /**
30
- * Emitted when an asset migrates between layers
31
- *
32
- * Note: The `details` field is populated differently based on the target layer:
33
- * - For did:webvh migrations: `details` is undefined (web publishing has no transaction details)
34
- * - For did:btco migrations: `details` includes Bitcoin transaction information
35
- * (transactionId, inscriptionId, satoshi, commitTxId, revealTxId, feeRate)
36
- */
37
- export interface AssetMigratedEvent extends BaseEvent {
38
- type: 'asset:migrated';
39
- asset: {
40
- id: string;
41
- fromLayer: LayerType;
42
- toLayer: LayerType;
43
- };
44
- details?: {
45
- transactionId?: string;
46
- inscriptionId?: string;
47
- satoshi?: string;
48
- commitTxId?: string;
49
- revealTxId?: string;
50
- feeRate?: number;
51
- };
52
- }
53
- /**
54
- * Emitted when an asset's ownership is transferred
55
- */
56
- export interface AssetTransferredEvent extends BaseEvent {
57
- type: 'asset:transferred';
58
- asset: {
59
- id: string;
60
- layer: LayerType;
61
- };
62
- from: string;
63
- to: string;
64
- transactionId: string;
65
- }
66
- /**
67
- * Emitted when a resource is published to web storage
68
- */
69
- export interface ResourcePublishedEvent extends BaseEvent {
70
- type: 'resource:published';
71
- asset: {
72
- id: string;
73
- };
74
- resource: {
75
- id: string;
76
- url: string;
77
- contentType: string;
78
- hash: string;
79
- };
80
- publisherDid: string;
81
- }
82
- /**
83
- * Emitted when a verifiable credential is issued for an asset
84
- */
85
- export interface CredentialIssuedEvent extends BaseEvent {
86
- type: 'credential:issued';
87
- asset: {
88
- id: string;
89
- };
90
- credential: {
91
- type: string[];
92
- issuer: string;
93
- };
94
- }
95
- /**
96
- * Emitted when a new resource version is created
97
- */
98
- export interface ResourceVersionCreatedEvent extends BaseEvent {
99
- type: 'resource:version:created';
100
- asset: {
101
- id: string;
102
- };
103
- resource: {
104
- id: string;
105
- fromVersion: number;
106
- toVersion: number;
107
- fromHash: string;
108
- toHash: string;
109
- };
110
- changes?: string;
111
- }
112
- /**
113
- * Emitted when asset verification is completed
114
- */
115
- export interface VerificationCompletedEvent extends BaseEvent {
116
- type: 'verification:completed';
117
- asset: {
118
- id: string;
119
- };
120
- result: boolean;
121
- checks?: {
122
- didDocument: boolean;
123
- resources: boolean;
124
- credentials: boolean;
125
- };
126
- }
127
- /**
128
- * Emitted when a batch operation starts
129
- */
130
- export interface BatchStartedEvent extends BaseEvent {
131
- type: 'batch:started';
132
- operation: 'create' | 'publish' | 'inscribe' | 'transfer';
133
- batchId: string;
134
- itemCount: number;
135
- }
136
- /**
137
- * Emitted when a batch operation completes successfully
138
- */
139
- export interface BatchCompletedEvent extends BaseEvent {
140
- type: 'batch:completed';
141
- batchId: string;
142
- operation: string;
143
- results: {
144
- successful: number;
145
- failed: number;
146
- totalDuration: number;
147
- costSavings?: {
148
- amount: number;
149
- percentage: number;
150
- };
151
- };
152
- }
153
- /**
154
- * Emitted when a batch operation fails
155
- */
156
- export interface BatchFailedEvent extends BaseEvent {
157
- type: 'batch:failed';
158
- batchId: string;
159
- operation: string;
160
- error: string;
161
- partialResults?: {
162
- successful: number;
163
- failed: number;
164
- };
165
- }
166
- /**
167
- * Emitted when a migration starts
168
- */
169
- export interface MigrationStartedEvent extends BaseEvent {
170
- type: 'migration:started';
171
- migrationId: string;
172
- sourceDid: string;
173
- targetLayer: string;
174
- }
175
- /**
176
- * Emitted when migration validation completes
177
- */
178
- export interface MigrationValidatedEvent extends BaseEvent {
179
- type: 'migration:validated';
180
- migrationId: string;
181
- valid: boolean;
182
- }
183
- /**
184
- * Emitted when migration checkpoint is created
185
- */
186
- export interface MigrationCheckpointedEvent extends BaseEvent {
187
- type: 'migration:checkpointed';
188
- migrationId: string;
189
- checkpointId: string;
190
- }
191
- /**
192
- * Emitted when migration enters in-progress state
193
- */
194
- export interface MigrationInProgressEvent extends BaseEvent {
195
- type: 'migration:in_progress';
196
- migrationId: string;
197
- currentOperation: string;
198
- progress: number;
199
- }
200
- /**
201
- * Emitted when migration enters anchoring state (Bitcoin)
202
- */
203
- export interface MigrationAnchoringEvent extends BaseEvent {
204
- type: 'migration:anchoring';
205
- migrationId: string;
206
- transactionId?: string;
207
- }
208
- /**
209
- * Emitted when migration completes successfully
210
- */
211
- export interface MigrationCompletedEvent extends BaseEvent {
212
- type: 'migration:completed';
213
- migrationId: string;
214
- sourceDid: string;
215
- targetDid: string;
216
- }
217
- /**
218
- * Emitted when migration fails
219
- */
220
- export interface MigrationFailedEvent extends BaseEvent {
221
- type: 'migration:failed';
222
- migrationId: string;
223
- error: any;
224
- }
225
- /**
226
- * Emitted when migration is rolled back
227
- */
228
- export interface MigrationRolledbackEvent extends BaseEvent {
229
- type: 'migration:rolledback';
230
- migrationId: string;
231
- checkpointId: string;
232
- }
233
- /**
234
- * Emitted when migration enters quarantine state
235
- */
236
- export interface MigrationQuarantineEvent extends BaseEvent {
237
- type: 'migration:quarantine';
238
- migrationId: string;
239
- checkpointId: string;
240
- reason: string;
241
- }
242
- /**
243
- * Emitted during batch operations to report progress
244
- */
245
- export interface BatchProgressEvent extends BaseEvent {
246
- type: 'batch:progress';
247
- batchId: string;
248
- operation: string;
249
- progress: number;
250
- completed: number;
251
- failed: number;
252
- total: number;
253
- }
254
- /**
255
- * Union type of all possible events
256
- */
257
- export type OriginalsEvent = AssetCreatedEvent | AssetMigratedEvent | AssetTransferredEvent | ResourcePublishedEvent | CredentialIssuedEvent | VerificationCompletedEvent | BatchStartedEvent | BatchCompletedEvent | BatchFailedEvent | BatchProgressEvent | ResourceVersionCreatedEvent | MigrationStartedEvent | MigrationValidatedEvent | MigrationCheckpointedEvent | MigrationInProgressEvent | MigrationAnchoringEvent | MigrationCompletedEvent | MigrationFailedEvent | MigrationRolledbackEvent | MigrationQuarantineEvent;
258
- /**
259
- * Event handler function type
260
- */
261
- export type EventHandler<T extends OriginalsEvent = OriginalsEvent> = (event: T) => void | Promise<void>;
262
- /**
263
- * Map of event types to their specific event interfaces
264
- */
265
- export interface EventTypeMap {
266
- 'asset:created': AssetCreatedEvent;
267
- 'asset:migrated': AssetMigratedEvent;
268
- 'asset:transferred': AssetTransferredEvent;
269
- 'resource:published': ResourcePublishedEvent;
270
- 'credential:issued': CredentialIssuedEvent;
271
- 'verification:completed': VerificationCompletedEvent;
272
- 'batch:started': BatchStartedEvent;
273
- 'batch:completed': BatchCompletedEvent;
274
- 'batch:failed': BatchFailedEvent;
275
- 'batch:progress': BatchProgressEvent;
276
- 'resource:version:created': ResourceVersionCreatedEvent;
277
- 'migration:started': MigrationStartedEvent;
278
- 'migration:validated': MigrationValidatedEvent;
279
- 'migration:checkpointed': MigrationCheckpointedEvent;
280
- 'migration:in_progress': MigrationInProgressEvent;
281
- 'migration:anchoring': MigrationAnchoringEvent;
282
- 'migration:completed': MigrationCompletedEvent;
283
- 'migration:failed': MigrationFailedEvent;
284
- 'migration:rolledback': MigrationRolledbackEvent;
285
- 'migration:quarantine': MigrationQuarantineEvent;
286
- }
@@ -1,9 +0,0 @@
1
- /**
2
- * Event types for the Originals SDK asset lifecycle operations
3
- *
4
- * All events follow a consistent structure:
5
- * - type: Namespaced event name (e.g., 'asset:created')
6
- * - timestamp: ISO 8601 timestamp of when the event occurred
7
- * - Specific payload data relevant to the event
8
- */
9
- export {};
@@ -1,3 +0,0 @@
1
- declare function basicExample(): Promise<void>;
2
- declare function digitalArtExample(): Promise<void>;
3
- export { basicExample, digitalArtExample };