@originals/sdk 1.4.2 → 1.4.5
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/dist/adapters/FeeOracleMock.d.ts +6 -0
- package/dist/adapters/FeeOracleMock.js +8 -0
- package/{src/adapters/index.ts → dist/adapters/index.d.ts} +0 -1
- package/dist/adapters/index.js +4 -0
- package/dist/adapters/providers/OrdHttpProvider.d.ts +56 -0
- package/dist/adapters/providers/OrdHttpProvider.js +110 -0
- package/dist/adapters/providers/OrdMockProvider.d.ts +70 -0
- package/dist/adapters/providers/OrdMockProvider.js +75 -0
- package/dist/adapters/types.d.ts +71 -0
- package/dist/adapters/types.js +1 -0
- package/dist/bitcoin/BitcoinManager.d.ts +15 -0
- package/dist/bitcoin/BitcoinManager.js +262 -0
- package/dist/bitcoin/BroadcastClient.d.ts +30 -0
- package/dist/bitcoin/BroadcastClient.js +35 -0
- package/dist/bitcoin/OrdinalsClient.d.ts +21 -0
- package/dist/bitcoin/OrdinalsClient.js +105 -0
- package/dist/bitcoin/PSBTBuilder.d.ts +24 -0
- package/dist/bitcoin/PSBTBuilder.js +80 -0
- package/dist/bitcoin/fee-calculation.d.ts +14 -0
- package/{src/bitcoin/fee-calculation.ts → dist/bitcoin/fee-calculation.js} +5 -12
- package/dist/bitcoin/providers/OrdNodeProvider.d.ts +38 -0
- package/dist/bitcoin/providers/OrdNodeProvider.js +67 -0
- package/dist/bitcoin/providers/OrdinalsProvider.d.ts +33 -0
- package/dist/bitcoin/providers/OrdinalsProvider.js +50 -0
- package/dist/bitcoin/providers/types.d.ts +63 -0
- package/dist/bitcoin/providers/types.js +1 -0
- package/dist/bitcoin/transactions/commit.d.ts +89 -0
- package/dist/bitcoin/transactions/commit.js +311 -0
- package/dist/bitcoin/transactions/index.d.ts +7 -0
- package/{src/bitcoin/transactions/index.ts → dist/bitcoin/transactions/index.js} +1 -6
- package/dist/bitcoin/transfer.d.ts +9 -0
- package/dist/bitcoin/transfer.js +26 -0
- package/dist/bitcoin/utxo-selection.d.ts +78 -0
- package/dist/bitcoin/utxo-selection.js +237 -0
- package/dist/bitcoin/utxo.d.ts +26 -0
- package/dist/bitcoin/utxo.js +78 -0
- package/dist/contexts/credentials-v1.json +195 -0
- package/dist/contexts/credentials-v2-examples.json +5 -0
- package/dist/contexts/credentials-v2.json +301 -0
- package/dist/contexts/credentials.json +195 -0
- package/dist/contexts/data-integrity-v2.json +81 -0
- package/dist/contexts/dids.json +57 -0
- package/dist/contexts/ed255192020.json +93 -0
- package/dist/contexts/ordinals-plus.json +23 -0
- package/dist/contexts/originals.json +22 -0
- package/dist/core/OriginalsSDK.d.ts +158 -0
- package/dist/core/OriginalsSDK.js +274 -0
- package/dist/crypto/Multikey.d.ts +30 -0
- package/dist/crypto/Multikey.js +149 -0
- package/dist/crypto/Signer.d.ts +21 -0
- package/dist/crypto/Signer.js +196 -0
- package/dist/crypto/noble-init.d.ts +18 -0
- package/dist/crypto/noble-init.js +106 -0
- package/dist/did/BtcoDidResolver.d.ts +57 -0
- package/dist/did/BtcoDidResolver.js +166 -0
- package/dist/did/DIDManager.d.ts +101 -0
- package/dist/did/DIDManager.js +493 -0
- package/dist/did/Ed25519Verifier.d.ts +30 -0
- package/dist/did/Ed25519Verifier.js +59 -0
- package/dist/did/KeyManager.d.ts +17 -0
- package/dist/did/KeyManager.js +207 -0
- package/dist/did/WebVHManager.d.ts +100 -0
- package/dist/did/WebVHManager.js +312 -0
- package/dist/did/createBtcoDidDocument.d.ts +10 -0
- package/dist/did/createBtcoDidDocument.js +42 -0
- package/dist/did/providers/OrdinalsClientProviderAdapter.d.ts +23 -0
- package/dist/did/providers/OrdinalsClientProviderAdapter.js +51 -0
- package/dist/events/EventEmitter.d.ts +115 -0
- package/dist/events/EventEmitter.js +198 -0
- package/dist/events/index.d.ts +7 -0
- package/dist/events/index.js +6 -0
- package/dist/events/types.d.ts +286 -0
- package/dist/events/types.js +9 -0
- package/dist/examples/basic-usage.d.ts +3 -0
- package/dist/examples/basic-usage.js +62 -0
- package/dist/examples/create-module-original.d.ts +32 -0
- package/dist/examples/create-module-original.js +376 -0
- package/dist/examples/full-lifecycle-flow.d.ts +56 -0
- package/dist/examples/full-lifecycle-flow.js +419 -0
- package/dist/examples/run.d.ts +12 -0
- package/dist/examples/run.js +51 -0
- package/dist/index.d.ts +43 -0
- package/dist/index.js +52 -0
- package/dist/kinds/KindRegistry.d.ts +76 -0
- package/dist/kinds/KindRegistry.js +216 -0
- package/dist/kinds/index.d.ts +33 -0
- package/{src/kinds/index.ts → dist/kinds/index.js} +6 -44
- package/dist/kinds/types.d.ts +363 -0
- package/dist/kinds/types.js +25 -0
- package/dist/kinds/validators/AgentValidator.d.ts +14 -0
- package/dist/kinds/validators/AgentValidator.js +155 -0
- package/dist/kinds/validators/AppValidator.d.ts +14 -0
- package/dist/kinds/validators/AppValidator.js +135 -0
- package/dist/kinds/validators/DatasetValidator.d.ts +14 -0
- package/dist/kinds/validators/DatasetValidator.js +148 -0
- package/dist/kinds/validators/DocumentValidator.d.ts +14 -0
- package/dist/kinds/validators/DocumentValidator.js +180 -0
- package/dist/kinds/validators/MediaValidator.d.ts +14 -0
- package/dist/kinds/validators/MediaValidator.js +172 -0
- package/dist/kinds/validators/ModuleValidator.d.ts +14 -0
- package/dist/kinds/validators/ModuleValidator.js +140 -0
- package/dist/kinds/validators/base.d.ts +96 -0
- package/dist/kinds/validators/base.js +218 -0
- package/{src/kinds/validators/index.ts → dist/kinds/validators/index.d.ts} +0 -2
- package/dist/kinds/validators/index.js +10 -0
- package/dist/lifecycle/BatchOperations.d.ts +147 -0
- package/dist/lifecycle/BatchOperations.js +251 -0
- package/dist/lifecycle/LifecycleManager.d.ts +362 -0
- package/dist/lifecycle/LifecycleManager.js +1692 -0
- package/dist/lifecycle/OriginalsAsset.d.ts +164 -0
- package/dist/lifecycle/OriginalsAsset.js +380 -0
- package/dist/lifecycle/ProvenanceQuery.d.ts +126 -0
- package/dist/lifecycle/ProvenanceQuery.js +220 -0
- package/dist/lifecycle/ResourceVersioning.d.ts +73 -0
- package/dist/lifecycle/ResourceVersioning.js +127 -0
- package/dist/migration/MigrationManager.d.ts +86 -0
- package/dist/migration/MigrationManager.js +412 -0
- package/dist/migration/audit/AuditLogger.d.ts +51 -0
- package/dist/migration/audit/AuditLogger.js +156 -0
- package/dist/migration/checkpoint/CheckpointManager.d.ts +31 -0
- package/dist/migration/checkpoint/CheckpointManager.js +96 -0
- package/dist/migration/checkpoint/CheckpointStorage.d.ts +26 -0
- package/dist/migration/checkpoint/CheckpointStorage.js +89 -0
- package/dist/migration/index.d.ts +22 -0
- package/{src/migration/index.ts → dist/migration/index.js} +0 -6
- package/dist/migration/operations/BaseMigration.d.ts +48 -0
- package/dist/migration/operations/BaseMigration.js +83 -0
- package/dist/migration/operations/PeerToBtcoMigration.d.ts +25 -0
- package/dist/migration/operations/PeerToBtcoMigration.js +67 -0
- package/dist/migration/operations/PeerToWebvhMigration.d.ts +19 -0
- package/dist/migration/operations/PeerToWebvhMigration.js +46 -0
- package/dist/migration/operations/WebvhToBtcoMigration.d.ts +25 -0
- package/dist/migration/operations/WebvhToBtcoMigration.js +67 -0
- package/dist/migration/rollback/RollbackManager.d.ts +29 -0
- package/dist/migration/rollback/RollbackManager.js +146 -0
- package/dist/migration/state/StateMachine.d.ts +25 -0
- package/dist/migration/state/StateMachine.js +76 -0
- package/dist/migration/state/StateTracker.d.ts +36 -0
- package/dist/migration/state/StateTracker.js +123 -0
- package/dist/migration/types.d.ts +306 -0
- package/dist/migration/types.js +33 -0
- package/dist/migration/validation/BitcoinValidator.d.ts +13 -0
- package/dist/migration/validation/BitcoinValidator.js +83 -0
- package/dist/migration/validation/CredentialValidator.d.ts +13 -0
- package/dist/migration/validation/CredentialValidator.js +46 -0
- package/dist/migration/validation/DIDCompatibilityValidator.d.ts +16 -0
- package/dist/migration/validation/DIDCompatibilityValidator.js +127 -0
- package/dist/migration/validation/LifecycleValidator.d.ts +10 -0
- package/dist/migration/validation/LifecycleValidator.js +52 -0
- package/dist/migration/validation/StorageValidator.d.ts +10 -0
- package/dist/migration/validation/StorageValidator.js +65 -0
- package/dist/migration/validation/ValidationPipeline.d.ts +29 -0
- package/dist/migration/validation/ValidationPipeline.js +180 -0
- package/dist/resources/ResourceManager.d.ts +231 -0
- package/dist/resources/ResourceManager.js +573 -0
- package/{src/resources/index.ts → dist/resources/index.d.ts} +3 -13
- package/dist/resources/index.js +10 -0
- package/dist/resources/types.d.ts +93 -0
- package/dist/resources/types.js +80 -0
- package/dist/storage/LocalStorageAdapter.d.ts +11 -0
- package/dist/storage/LocalStorageAdapter.js +53 -0
- package/dist/storage/MemoryStorageAdapter.d.ts +6 -0
- package/dist/storage/MemoryStorageAdapter.js +21 -0
- package/dist/storage/StorageAdapter.d.ts +16 -0
- package/dist/storage/StorageAdapter.js +1 -0
- package/{src/storage/index.ts → dist/storage/index.d.ts} +0 -1
- package/dist/storage/index.js +2 -0
- package/dist/types/bitcoin.d.ts +84 -0
- package/dist/types/bitcoin.js +1 -0
- package/dist/types/common.d.ts +82 -0
- package/dist/types/common.js +1 -0
- package/dist/types/credentials.d.ts +75 -0
- package/dist/types/credentials.js +1 -0
- package/dist/types/did.d.ts +26 -0
- package/dist/types/did.js +1 -0
- package/{src/types/index.ts → dist/types/index.d.ts} +0 -2
- package/dist/types/index.js +5 -0
- package/dist/types/network.d.ts +78 -0
- package/dist/types/network.js +145 -0
- package/dist/utils/EventLogger.d.ts +71 -0
- package/dist/utils/EventLogger.js +232 -0
- package/dist/utils/Logger.d.ts +106 -0
- package/dist/utils/Logger.js +257 -0
- package/dist/utils/MetricsCollector.d.ts +110 -0
- package/dist/utils/MetricsCollector.js +264 -0
- package/dist/utils/bitcoin-address.d.ts +38 -0
- package/dist/utils/bitcoin-address.js +113 -0
- package/dist/utils/cbor.d.ts +2 -0
- package/dist/utils/cbor.js +9 -0
- package/dist/utils/encoding.d.ts +37 -0
- package/dist/utils/encoding.js +120 -0
- package/dist/utils/hash.d.ts +1 -0
- package/dist/utils/hash.js +5 -0
- package/dist/utils/retry.d.ts +10 -0
- package/dist/utils/retry.js +35 -0
- package/dist/utils/satoshi-validation.d.ts +60 -0
- package/dist/utils/satoshi-validation.js +156 -0
- package/dist/utils/serialization.d.ts +14 -0
- package/dist/utils/serialization.js +76 -0
- package/dist/utils/telemetry.d.ts +17 -0
- package/dist/utils/telemetry.js +24 -0
- package/dist/utils/validation.d.ts +5 -0
- package/dist/utils/validation.js +98 -0
- package/dist/vc/CredentialManager.d.ts +329 -0
- package/dist/vc/CredentialManager.js +615 -0
- package/dist/vc/Issuer.d.ts +27 -0
- package/dist/vc/Issuer.js +70 -0
- package/dist/vc/Verifier.d.ts +16 -0
- package/dist/vc/Verifier.js +50 -0
- package/dist/vc/cryptosuites/bbs.d.ts +44 -0
- package/dist/vc/cryptosuites/bbs.js +213 -0
- package/dist/vc/cryptosuites/bbsSimple.d.ts +9 -0
- package/dist/vc/cryptosuites/bbsSimple.js +12 -0
- package/dist/vc/cryptosuites/eddsa.d.ts +30 -0
- package/dist/vc/cryptosuites/eddsa.js +81 -0
- package/dist/vc/documentLoader.d.ts +16 -0
- package/dist/vc/documentLoader.js +59 -0
- package/dist/vc/proofs/data-integrity.d.ts +21 -0
- package/dist/vc/proofs/data-integrity.js +15 -0
- package/dist/vc/utils/jsonld.d.ts +2 -0
- package/dist/vc/utils/jsonld.js +15 -0
- package/package.json +5 -1
- package/.eslintrc.json +0 -33
- package/src/adapters/FeeOracleMock.ts +0 -9
- package/src/adapters/providers/OrdHttpProvider.ts +0 -126
- package/src/adapters/providers/OrdMockProvider.ts +0 -101
- package/src/adapters/types.ts +0 -66
- package/src/bitcoin/BitcoinManager.ts +0 -330
- package/src/bitcoin/BroadcastClient.ts +0 -54
- package/src/bitcoin/OrdinalsClient.ts +0 -119
- package/src/bitcoin/PSBTBuilder.ts +0 -106
- package/src/bitcoin/providers/OrdNodeProvider.ts +0 -92
- package/src/bitcoin/providers/OrdinalsProvider.ts +0 -56
- package/src/bitcoin/providers/types.ts +0 -59
- package/src/bitcoin/transactions/commit.ts +0 -465
- package/src/bitcoin/transfer.ts +0 -43
- package/src/bitcoin/utxo-selection.ts +0 -322
- package/src/bitcoin/utxo.ts +0 -113
- package/src/contexts/credentials-v1.json +0 -237
- package/src/contexts/credentials-v2-examples.json +0 -5
- package/src/contexts/credentials-v2.json +0 -340
- package/src/contexts/credentials.json +0 -237
- package/src/contexts/data-integrity-v2.json +0 -81
- package/src/contexts/dids.json +0 -58
- package/src/contexts/ed255192020.json +0 -93
- package/src/contexts/ordinals-plus.json +0 -23
- package/src/contexts/originals.json +0 -22
- package/src/core/OriginalsSDK.ts +0 -416
- package/src/crypto/Multikey.ts +0 -194
- package/src/crypto/Signer.ts +0 -254
- package/src/crypto/noble-init.ts +0 -121
- package/src/did/BtcoDidResolver.ts +0 -227
- package/src/did/DIDManager.ts +0 -694
- package/src/did/Ed25519Verifier.ts +0 -68
- package/src/did/KeyManager.ts +0 -236
- package/src/did/WebVHManager.ts +0 -498
- package/src/did/createBtcoDidDocument.ts +0 -59
- package/src/did/providers/OrdinalsClientProviderAdapter.ts +0 -68
- package/src/events/EventEmitter.ts +0 -222
- package/src/events/index.ts +0 -19
- package/src/events/types.ts +0 -331
- package/src/examples/basic-usage.ts +0 -78
- package/src/examples/create-module-original.ts +0 -435
- package/src/examples/full-lifecycle-flow.ts +0 -514
- package/src/examples/run.ts +0 -60
- package/src/index.ts +0 -150
- package/src/kinds/KindRegistry.ts +0 -290
- package/src/kinds/types.ts +0 -470
- package/src/kinds/validators/AgentValidator.ts +0 -257
- package/src/kinds/validators/AppValidator.ts +0 -211
- package/src/kinds/validators/DatasetValidator.ts +0 -242
- package/src/kinds/validators/DocumentValidator.ts +0 -311
- package/src/kinds/validators/MediaValidator.ts +0 -269
- package/src/kinds/validators/ModuleValidator.ts +0 -225
- package/src/kinds/validators/base.ts +0 -276
- package/src/lifecycle/BatchOperations.ts +0 -373
- package/src/lifecycle/LifecycleManager.ts +0 -2126
- package/src/lifecycle/OriginalsAsset.ts +0 -524
- package/src/lifecycle/ProvenanceQuery.ts +0 -280
- package/src/lifecycle/ResourceVersioning.ts +0 -163
- package/src/migration/MigrationManager.ts +0 -527
- package/src/migration/audit/AuditLogger.ts +0 -176
- package/src/migration/checkpoint/CheckpointManager.ts +0 -112
- package/src/migration/checkpoint/CheckpointStorage.ts +0 -101
- package/src/migration/operations/BaseMigration.ts +0 -126
- package/src/migration/operations/PeerToBtcoMigration.ts +0 -105
- package/src/migration/operations/PeerToWebvhMigration.ts +0 -62
- package/src/migration/operations/WebvhToBtcoMigration.ts +0 -105
- package/src/migration/rollback/RollbackManager.ts +0 -170
- package/src/migration/state/StateMachine.ts +0 -92
- package/src/migration/state/StateTracker.ts +0 -156
- package/src/migration/types.ts +0 -344
- package/src/migration/validation/BitcoinValidator.ts +0 -107
- package/src/migration/validation/CredentialValidator.ts +0 -62
- package/src/migration/validation/DIDCompatibilityValidator.ts +0 -151
- package/src/migration/validation/LifecycleValidator.ts +0 -64
- package/src/migration/validation/StorageValidator.ts +0 -79
- package/src/migration/validation/ValidationPipeline.ts +0 -213
- package/src/resources/ResourceManager.ts +0 -655
- package/src/resources/types.ts +0 -202
- package/src/storage/LocalStorageAdapter.ts +0 -61
- package/src/storage/MemoryStorageAdapter.ts +0 -29
- package/src/storage/StorageAdapter.ts +0 -25
- package/src/types/bitcoin.ts +0 -98
- package/src/types/common.ts +0 -92
- package/src/types/credentials.ts +0 -88
- package/src/types/did.ts +0 -31
- package/src/types/external-shims.d.ts +0 -53
- package/src/types/network.ts +0 -175
- package/src/utils/EventLogger.ts +0 -298
- package/src/utils/Logger.ts +0 -322
- package/src/utils/MetricsCollector.ts +0 -358
- package/src/utils/bitcoin-address.ts +0 -130
- package/src/utils/cbor.ts +0 -12
- package/src/utils/encoding.ts +0 -127
- package/src/utils/hash.ts +0 -6
- package/src/utils/retry.ts +0 -46
- package/src/utils/satoshi-validation.ts +0 -196
- package/src/utils/serialization.ts +0 -96
- package/src/utils/telemetry.ts +0 -40
- package/src/utils/validation.ts +0 -119
- package/src/vc/CredentialManager.ts +0 -918
- package/src/vc/Issuer.ts +0 -100
- package/src/vc/Verifier.ts +0 -47
- package/src/vc/cryptosuites/bbs.ts +0 -253
- package/src/vc/cryptosuites/bbsSimple.ts +0 -21
- package/src/vc/cryptosuites/eddsa.ts +0 -99
- package/src/vc/documentLoader.ts +0 -67
- package/src/vc/proofs/data-integrity.ts +0 -33
- package/src/vc/utils/jsonld.ts +0 -18
- package/tests/__mocks__/bbs-signatures.js +0 -17
- package/tests/__mocks__/mf-base58.js +0 -24
- package/tests/fixtures/did-documents.ts +0 -247
- package/tests/index.test.ts +0 -21
- package/tests/integration/BatchOperations.test.ts +0 -531
- package/tests/integration/CompleteLifecycle.e2e.test.ts +0 -735
- package/tests/integration/CredentialManager.test.ts +0 -42
- package/tests/integration/DIDManager.test.ts +0 -41
- package/tests/integration/DidPeerToWebVhFlow.test.ts +0 -351
- package/tests/integration/Events.test.ts +0 -435
- package/tests/integration/Lifecycle.transfer.btco.integration.test.ts +0 -25
- package/tests/integration/LifecycleManager.test.ts +0 -21
- package/tests/integration/MultikeyFlow.test.ts +0 -52
- package/tests/integration/TelemetryIntegration.test.ts +0 -395
- package/tests/integration/WebVhPublish.test.ts +0 -48
- package/tests/integration/createTypedOriginal.test.ts +0 -379
- package/tests/integration/migration/peer-to-webvh.test.ts +0 -172
- package/tests/manual/test-commit-creation.ts +0 -323
- package/tests/mocks/MockKeyStore.ts +0 -38
- package/tests/mocks/adapters/MemoryStorageAdapter.ts +0 -24
- package/tests/mocks/adapters/MockFeeOracle.ts +0 -11
- package/tests/mocks/adapters/MockOrdinalsProvider.ts +0 -76
- package/tests/mocks/adapters/OrdMockProvider.test.ts +0 -176
- package/tests/mocks/adapters/index.ts +0 -6
- package/tests/performance/BatchOperations.perf.test.ts +0 -403
- package/tests/performance/logging.perf.test.ts +0 -336
- package/tests/sdk.test.ts +0 -43
- package/tests/security/bitcoin-penetration-tests.test.ts +0 -622
- package/tests/setup.bun.ts +0 -69
- package/tests/setup.jest.ts +0 -23
- package/tests/stress/batch-operations-stress.test.ts +0 -571
- package/tests/unit/adapters/FeeOracleMock.test.ts +0 -40
- package/tests/unit/bitcoin/BitcoinManager.test.ts +0 -293
- package/tests/unit/bitcoin/BroadcastClient.test.ts +0 -52
- package/tests/unit/bitcoin/OrdNodeProvider.test.ts +0 -53
- package/tests/unit/bitcoin/OrdinalsClient.test.ts +0 -381
- package/tests/unit/bitcoin/OrdinalsClientProvider.test.ts +0 -102
- package/tests/unit/bitcoin/PSBTBuilder.test.ts +0 -84
- package/tests/unit/bitcoin/fee-calculation.test.ts +0 -261
- package/tests/unit/bitcoin/transactions/commit.test.ts +0 -649
- package/tests/unit/bitcoin/transfer.test.ts +0 -31
- package/tests/unit/bitcoin/utxo-selection-new.test.ts +0 -502
- package/tests/unit/bitcoin/utxo.more.test.ts +0 -39
- package/tests/unit/bitcoin/utxo.selection.test.ts +0 -38
- package/tests/unit/core/OriginalsSDK.test.ts +0 -152
- package/tests/unit/crypto/Multikey.test.ts +0 -206
- package/tests/unit/crypto/Signer.test.ts +0 -408
- package/tests/unit/did/BtcoDidResolver.test.ts +0 -611
- package/tests/unit/did/DIDManager.more.test.ts +0 -43
- package/tests/unit/did/DIDManager.test.ts +0 -185
- package/tests/unit/did/Ed25519Verifier.test.ts +0 -160
- package/tests/unit/did/KeyManager.test.ts +0 -452
- package/tests/unit/did/OrdinalsClientProviderAdapter.test.ts +0 -45
- package/tests/unit/did/WebVHManager.test.ts +0 -435
- package/tests/unit/did/createBtcoDidDocument.test.ts +0 -67
- package/tests/unit/did/providers/OrdinalsClientProviderAdapter.test.ts +0 -159
- package/tests/unit/events/EventEmitter.test.ts +0 -407
- package/tests/unit/kinds/KindRegistry.test.ts +0 -329
- package/tests/unit/kinds/types.test.ts +0 -409
- package/tests/unit/kinds/validators.test.ts +0 -651
- package/tests/unit/lifecycle/BatchOperations.test.ts +0 -527
- package/tests/unit/lifecycle/LifecycleManager.cleanapi.test.ts +0 -441
- package/tests/unit/lifecycle/LifecycleManager.keymanagement.test.ts +0 -312
- package/tests/unit/lifecycle/LifecycleManager.prov.test.ts +0 -18
- package/tests/unit/lifecycle/LifecycleManager.test.ts +0 -213
- package/tests/unit/lifecycle/LifecycleManager.transfer.unit.test.ts +0 -30
- package/tests/unit/lifecycle/OriginalsAsset.test.ts +0 -176
- package/tests/unit/lifecycle/ProvenanceQuery.test.ts +0 -577
- package/tests/unit/lifecycle/ResourceVersioning.test.ts +0 -651
- package/tests/unit/resources/ResourceManager.test.ts +0 -740
- package/tests/unit/storage/MemoryStorageAdapter.test.ts +0 -93
- package/tests/unit/types/network.test.ts +0 -255
- package/tests/unit/utils/EventIntegration.test.ts +0 -384
- package/tests/unit/utils/Logger.test.ts +0 -473
- package/tests/unit/utils/MetricsCollector.test.ts +0 -358
- package/tests/unit/utils/bitcoin-address.test.ts +0 -250
- package/tests/unit/utils/cbor.test.ts +0 -35
- package/tests/unit/utils/encoding.test.ts +0 -318
- package/tests/unit/utils/hash.test.ts +0 -12
- package/tests/unit/utils/retry.test.ts +0 -100
- package/tests/unit/utils/satoshi-validation.test.ts +0 -354
- package/tests/unit/utils/serialization.test.ts +0 -124
- package/tests/unit/utils/telemetry.test.ts +0 -52
- package/tests/unit/utils/validation.test.ts +0 -141
- package/tests/unit/vc/CredentialManager.helpers.test.ts +0 -527
- package/tests/unit/vc/CredentialManager.test.ts +0 -487
- package/tests/unit/vc/Issuer.test.ts +0 -107
- package/tests/unit/vc/Verifier.test.ts +0 -525
- package/tests/unit/vc/bbs.test.ts +0 -282
- package/tests/unit/vc/cryptosuites/eddsa.test.ts +0 -398
- package/tests/unit/vc/documentLoader.test.ts +0 -121
- package/tests/unit/vc/proofs/data-integrity.test.ts +0 -24
- package/tsconfig.json +0 -31
- package/tsconfig.test.json +0 -15
|
@@ -0,0 +1,180 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Document Kind Validator
|
|
3
|
+
*
|
|
4
|
+
* Validates manifests for text documents with formatting and sections.
|
|
5
|
+
*/
|
|
6
|
+
import { OriginalKind } from '../types';
|
|
7
|
+
import { BaseKindValidator, ValidationUtils } from './base';
|
|
8
|
+
/**
|
|
9
|
+
* Valid document formats
|
|
10
|
+
*/
|
|
11
|
+
const VALID_FORMATS = ['markdown', 'html', 'pdf', 'docx', 'txt', 'asciidoc', 'rst', 'latex'];
|
|
12
|
+
/**
|
|
13
|
+
* Valid document statuses
|
|
14
|
+
*/
|
|
15
|
+
const VALID_STATUSES = ['draft', 'review', 'published', 'archived'];
|
|
16
|
+
/**
|
|
17
|
+
* Validator for Document Originals
|
|
18
|
+
*/
|
|
19
|
+
export class DocumentValidator extends BaseKindValidator {
|
|
20
|
+
constructor() {
|
|
21
|
+
super(...arguments);
|
|
22
|
+
this.kind = OriginalKind.Document;
|
|
23
|
+
}
|
|
24
|
+
validateKind(manifest) {
|
|
25
|
+
const errors = [];
|
|
26
|
+
const warnings = [];
|
|
27
|
+
const metadata = manifest.metadata;
|
|
28
|
+
// Validate metadata exists
|
|
29
|
+
if (!metadata || typeof metadata !== 'object') {
|
|
30
|
+
return ValidationUtils.failure([
|
|
31
|
+
ValidationUtils.error('MISSING_METADATA', 'Document manifest must have metadata', 'metadata'),
|
|
32
|
+
]);
|
|
33
|
+
}
|
|
34
|
+
// Validate format (required)
|
|
35
|
+
if (!metadata.format) {
|
|
36
|
+
errors.push(ValidationUtils.error('MISSING_FORMAT', 'Document must specify a format', 'metadata.format'));
|
|
37
|
+
}
|
|
38
|
+
else if (!VALID_FORMATS.includes(metadata.format)) {
|
|
39
|
+
errors.push(ValidationUtils.error('INVALID_FORMAT', `Invalid document format: "${metadata.format}". Must be one of: ${VALID_FORMATS.join(', ')}`, 'metadata.format', metadata.format));
|
|
40
|
+
}
|
|
41
|
+
// Validate content (required)
|
|
42
|
+
if (!metadata.content || typeof metadata.content !== 'string') {
|
|
43
|
+
errors.push(ValidationUtils.error('MISSING_CONTENT', 'Document must specify a content resource', 'metadata.content'));
|
|
44
|
+
}
|
|
45
|
+
else {
|
|
46
|
+
// Check if content references an existing resource
|
|
47
|
+
if (!ValidationUtils.resourceExists(metadata.content, manifest.resources)) {
|
|
48
|
+
warnings.push(ValidationUtils.warning('CONTENT_NOT_RESOURCE', `Content "${metadata.content}" does not match a resource ID`, 'metadata.content', 'Ensure the content field references a valid resource ID'));
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
// Validate language if specified
|
|
52
|
+
if (metadata.language) {
|
|
53
|
+
if (typeof metadata.language !== 'string') {
|
|
54
|
+
errors.push(ValidationUtils.error('INVALID_LANGUAGE', 'Language must be a string', 'metadata.language'));
|
|
55
|
+
}
|
|
56
|
+
else if (!ValidationUtils.isValidLanguageCode(metadata.language)) {
|
|
57
|
+
warnings.push(ValidationUtils.warning('INVALID_LANGUAGE_CODE', `Language "${metadata.language}" is not a valid ISO 639-1 code`, 'metadata.language', 'Use a 2-letter language code like "en", "es", "fr"'));
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
// Validate toc if specified
|
|
61
|
+
if (metadata.toc) {
|
|
62
|
+
if (!Array.isArray(metadata.toc)) {
|
|
63
|
+
errors.push(ValidationUtils.error('INVALID_TOC', 'Table of contents must be an array', 'metadata.toc'));
|
|
64
|
+
}
|
|
65
|
+
else {
|
|
66
|
+
for (let i = 0; i < metadata.toc.length; i++) {
|
|
67
|
+
const entry = metadata.toc[i];
|
|
68
|
+
const entryPath = `metadata.toc[${i}]`;
|
|
69
|
+
if (!entry || typeof entry !== 'object') {
|
|
70
|
+
errors.push(ValidationUtils.error('INVALID_TOC_ENTRY', `TOC entry at index ${i} must be an object`, entryPath));
|
|
71
|
+
continue;
|
|
72
|
+
}
|
|
73
|
+
if (!entry.title || typeof entry.title !== 'string') {
|
|
74
|
+
errors.push(ValidationUtils.error('MISSING_TOC_TITLE', `TOC entry at index ${i} must have a title`, `${entryPath}.title`));
|
|
75
|
+
}
|
|
76
|
+
if (typeof entry.level !== 'number' || entry.level < 1 || !Number.isInteger(entry.level)) {
|
|
77
|
+
errors.push(ValidationUtils.error('INVALID_TOC_LEVEL', `TOC entry at index ${i} must have a valid level (positive integer)`, `${entryPath}.level`));
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
// Validate pageCount if specified
|
|
83
|
+
if (metadata.pageCount !== undefined) {
|
|
84
|
+
if (typeof metadata.pageCount !== 'number' || metadata.pageCount <= 0 || !Number.isInteger(metadata.pageCount)) {
|
|
85
|
+
errors.push(ValidationUtils.error('INVALID_PAGE_COUNT', 'Page count must be a positive integer', 'metadata.pageCount'));
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
// Validate wordCount if specified
|
|
89
|
+
if (metadata.wordCount !== undefined) {
|
|
90
|
+
if (typeof metadata.wordCount !== 'number' || metadata.wordCount < 0 || !Number.isInteger(metadata.wordCount)) {
|
|
91
|
+
errors.push(ValidationUtils.error('INVALID_WORD_COUNT', 'Word count must be a non-negative integer', 'metadata.wordCount'));
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
// Validate readingTime if specified
|
|
95
|
+
if (metadata.readingTime !== undefined) {
|
|
96
|
+
if (typeof metadata.readingTime !== 'number' || metadata.readingTime <= 0) {
|
|
97
|
+
errors.push(ValidationUtils.error('INVALID_READING_TIME', 'Reading time must be a positive number (minutes)', 'metadata.readingTime'));
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
// Validate keywords if specified
|
|
101
|
+
if (metadata.keywords) {
|
|
102
|
+
if (!Array.isArray(metadata.keywords)) {
|
|
103
|
+
errors.push(ValidationUtils.error('INVALID_KEYWORDS', 'Keywords must be an array of strings', 'metadata.keywords'));
|
|
104
|
+
}
|
|
105
|
+
else {
|
|
106
|
+
for (let i = 0; i < metadata.keywords.length; i++) {
|
|
107
|
+
if (typeof metadata.keywords[i] !== 'string') {
|
|
108
|
+
errors.push(ValidationUtils.error('INVALID_KEYWORD', `Keyword at index ${i} must be a string`, `metadata.keywords[${i}]`));
|
|
109
|
+
}
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
// Validate references if specified
|
|
114
|
+
if (metadata.references) {
|
|
115
|
+
if (!Array.isArray(metadata.references)) {
|
|
116
|
+
errors.push(ValidationUtils.error('INVALID_REFERENCES', 'References must be an array', 'metadata.references'));
|
|
117
|
+
}
|
|
118
|
+
else {
|
|
119
|
+
const refIds = new Set();
|
|
120
|
+
for (let i = 0; i < metadata.references.length; i++) {
|
|
121
|
+
const ref = metadata.references[i];
|
|
122
|
+
const refPath = `metadata.references[${i}]`;
|
|
123
|
+
if (!ref || typeof ref !== 'object') {
|
|
124
|
+
errors.push(ValidationUtils.error('INVALID_REFERENCE', `Reference at index ${i} must be an object`, refPath));
|
|
125
|
+
continue;
|
|
126
|
+
}
|
|
127
|
+
if (!ref.id || typeof ref.id !== 'string') {
|
|
128
|
+
errors.push(ValidationUtils.error('MISSING_REFERENCE_ID', `Reference at index ${i} must have an id`, `${refPath}.id`));
|
|
129
|
+
}
|
|
130
|
+
else {
|
|
131
|
+
if (refIds.has(ref.id)) {
|
|
132
|
+
errors.push(ValidationUtils.error('DUPLICATE_REFERENCE_ID', `Duplicate reference id: "${ref.id}"`, `${refPath}.id`));
|
|
133
|
+
}
|
|
134
|
+
refIds.add(ref.id);
|
|
135
|
+
}
|
|
136
|
+
if (!ref.title || typeof ref.title !== 'string') {
|
|
137
|
+
errors.push(ValidationUtils.error('MISSING_REFERENCE_TITLE', `Reference at index ${i} must have a title`, `${refPath}.title`));
|
|
138
|
+
}
|
|
139
|
+
// Validate URL if present
|
|
140
|
+
if (ref.url && !ValidationUtils.isValidURL(ref.url)) {
|
|
141
|
+
warnings.push(ValidationUtils.warning('INVALID_REFERENCE_URL', `Reference "${ref.id}" has an invalid URL`, `${refPath}.url`));
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
}
|
|
145
|
+
}
|
|
146
|
+
// Validate status if specified
|
|
147
|
+
if (metadata.status) {
|
|
148
|
+
if (!VALID_STATUSES.includes(metadata.status)) {
|
|
149
|
+
errors.push(ValidationUtils.error('INVALID_STATUS', `Invalid document status: "${metadata.status}". Must be one of: ${VALID_STATUSES.join(', ')}`, 'metadata.status', metadata.status));
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
// Validate revision if specified
|
|
153
|
+
if (metadata.revision !== undefined) {
|
|
154
|
+
if (typeof metadata.revision !== 'number' || metadata.revision < 1 || !Number.isInteger(metadata.revision)) {
|
|
155
|
+
errors.push(ValidationUtils.error('INVALID_REVISION', 'Revision must be a positive integer', 'metadata.revision'));
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
// Suggest adding language
|
|
159
|
+
if (!metadata.language) {
|
|
160
|
+
warnings.push(ValidationUtils.warning('MISSING_LANGUAGE', 'Consider specifying the document language', 'metadata.language', 'Add a language code like "en" for English'));
|
|
161
|
+
}
|
|
162
|
+
// Suggest adding abstract
|
|
163
|
+
if (!metadata.abstract) {
|
|
164
|
+
warnings.push(ValidationUtils.warning('MISSING_ABSTRACT', 'Consider adding an abstract or summary', 'metadata.abstract'));
|
|
165
|
+
}
|
|
166
|
+
// Check that at least one document resource exists
|
|
167
|
+
const docResources = manifest.resources.filter(r => r.type === 'document' ||
|
|
168
|
+
r.type === 'text' ||
|
|
169
|
+
r.contentType.includes('text/') ||
|
|
170
|
+
r.contentType.includes('markdown') ||
|
|
171
|
+
r.contentType.includes('html') ||
|
|
172
|
+
r.contentType.includes('pdf'));
|
|
173
|
+
if (docResources.length === 0) {
|
|
174
|
+
warnings.push(ValidationUtils.warning('NO_DOCUMENT_RESOURCES', 'No document resources found. Ensure resources have appropriate types', 'resources'));
|
|
175
|
+
}
|
|
176
|
+
return errors.length > 0
|
|
177
|
+
? ValidationUtils.failure(errors, warnings)
|
|
178
|
+
: ValidationUtils.success(warnings);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Media Kind Validator
|
|
3
|
+
*
|
|
4
|
+
* Validates manifests for media content (image, audio, video) with format metadata.
|
|
5
|
+
*/
|
|
6
|
+
import { OriginalKind, type OriginalManifest, type ValidationResult } from '../types';
|
|
7
|
+
import { BaseKindValidator } from './base';
|
|
8
|
+
/**
|
|
9
|
+
* Validator for Media Originals
|
|
10
|
+
*/
|
|
11
|
+
export declare class MediaValidator extends BaseKindValidator<OriginalKind.Media> {
|
|
12
|
+
readonly kind = OriginalKind.Media;
|
|
13
|
+
protected validateKind(manifest: OriginalManifest<OriginalKind.Media>): ValidationResult;
|
|
14
|
+
}
|
|
@@ -0,0 +1,172 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Media Kind Validator
|
|
3
|
+
*
|
|
4
|
+
* Validates manifests for media content (image, audio, video) with format metadata.
|
|
5
|
+
*/
|
|
6
|
+
import { OriginalKind } from '../types';
|
|
7
|
+
import { BaseKindValidator, ValidationUtils } from './base';
|
|
8
|
+
/**
|
|
9
|
+
* Valid media types
|
|
10
|
+
*/
|
|
11
|
+
const VALID_MEDIA_TYPES = ['image', 'audio', 'video', '3d', 'animation'];
|
|
12
|
+
/**
|
|
13
|
+
* Common MIME types by media type
|
|
14
|
+
*/
|
|
15
|
+
const COMMON_MIME_TYPES = {
|
|
16
|
+
image: [
|
|
17
|
+
'image/jpeg', 'image/png', 'image/gif', 'image/webp', 'image/svg+xml',
|
|
18
|
+
'image/avif', 'image/bmp', 'image/tiff', 'image/heic', 'image/heif',
|
|
19
|
+
],
|
|
20
|
+
audio: [
|
|
21
|
+
'audio/mpeg', 'audio/mp3', 'audio/wav', 'audio/ogg', 'audio/flac',
|
|
22
|
+
'audio/aac', 'audio/webm', 'audio/midi', 'audio/x-wav',
|
|
23
|
+
],
|
|
24
|
+
video: [
|
|
25
|
+
'video/mp4', 'video/webm', 'video/ogg', 'video/quicktime', 'video/x-msvideo',
|
|
26
|
+
'video/x-matroska', 'video/mpeg',
|
|
27
|
+
],
|
|
28
|
+
'3d': [
|
|
29
|
+
'model/gltf+json', 'model/gltf-binary', 'model/obj', 'model/stl',
|
|
30
|
+
'application/octet-stream',
|
|
31
|
+
],
|
|
32
|
+
animation: [
|
|
33
|
+
'image/gif', 'video/mp4', 'video/webm', 'application/json', // Lottie
|
|
34
|
+
],
|
|
35
|
+
};
|
|
36
|
+
/**
|
|
37
|
+
* Validator for Media Originals
|
|
38
|
+
*/
|
|
39
|
+
export class MediaValidator extends BaseKindValidator {
|
|
40
|
+
constructor() {
|
|
41
|
+
super(...arguments);
|
|
42
|
+
this.kind = OriginalKind.Media;
|
|
43
|
+
}
|
|
44
|
+
validateKind(manifest) {
|
|
45
|
+
const errors = [];
|
|
46
|
+
const warnings = [];
|
|
47
|
+
const metadata = manifest.metadata;
|
|
48
|
+
// Validate metadata exists
|
|
49
|
+
if (!metadata || typeof metadata !== 'object') {
|
|
50
|
+
return ValidationUtils.failure([
|
|
51
|
+
ValidationUtils.error('MISSING_METADATA', 'Media manifest must have metadata', 'metadata'),
|
|
52
|
+
]);
|
|
53
|
+
}
|
|
54
|
+
// Validate mediaType (required)
|
|
55
|
+
if (!metadata.mediaType) {
|
|
56
|
+
errors.push(ValidationUtils.error('MISSING_MEDIA_TYPE', 'Media must specify a mediaType', 'metadata.mediaType'));
|
|
57
|
+
}
|
|
58
|
+
else if (!VALID_MEDIA_TYPES.includes(metadata.mediaType)) {
|
|
59
|
+
errors.push(ValidationUtils.error('INVALID_MEDIA_TYPE', `Invalid mediaType: "${metadata.mediaType}". Must be one of: ${VALID_MEDIA_TYPES.join(', ')}`, 'metadata.mediaType', metadata.mediaType));
|
|
60
|
+
}
|
|
61
|
+
// Validate mimeType (required)
|
|
62
|
+
if (!metadata.mimeType || typeof metadata.mimeType !== 'string') {
|
|
63
|
+
errors.push(ValidationUtils.error('MISSING_MIME_TYPE', 'Media must specify a mimeType', 'metadata.mimeType'));
|
|
64
|
+
}
|
|
65
|
+
else if (!ValidationUtils.isValidMimeType(metadata.mimeType)) {
|
|
66
|
+
errors.push(ValidationUtils.error('INVALID_MIME_TYPE', `Invalid mimeType format: "${metadata.mimeType}"`, 'metadata.mimeType', metadata.mimeType));
|
|
67
|
+
}
|
|
68
|
+
else if (metadata.mediaType) {
|
|
69
|
+
// Check if MIME type matches the declared media type
|
|
70
|
+
const expectedMimeTypes = COMMON_MIME_TYPES[metadata.mediaType];
|
|
71
|
+
if (expectedMimeTypes && !expectedMimeTypes.includes(metadata.mimeType)) {
|
|
72
|
+
warnings.push(ValidationUtils.warning('MIME_TYPE_MISMATCH', `mimeType "${metadata.mimeType}" is not typically associated with mediaType "${metadata.mediaType}"`, 'metadata.mimeType'));
|
|
73
|
+
}
|
|
74
|
+
}
|
|
75
|
+
// Validate dimensions for images and video
|
|
76
|
+
if (metadata.mediaType === 'image' || metadata.mediaType === 'video') {
|
|
77
|
+
if (metadata.dimensions) {
|
|
78
|
+
if (typeof metadata.dimensions !== 'object') {
|
|
79
|
+
errors.push(ValidationUtils.error('INVALID_DIMENSIONS', 'Dimensions must be an object', 'metadata.dimensions'));
|
|
80
|
+
}
|
|
81
|
+
else {
|
|
82
|
+
if (typeof metadata.dimensions.width !== 'number' || metadata.dimensions.width <= 0) {
|
|
83
|
+
errors.push(ValidationUtils.error('INVALID_WIDTH', 'Width must be a positive number', 'metadata.dimensions.width'));
|
|
84
|
+
}
|
|
85
|
+
if (typeof metadata.dimensions.height !== 'number' || metadata.dimensions.height <= 0) {
|
|
86
|
+
errors.push(ValidationUtils.error('INVALID_HEIGHT', 'Height must be a positive number', 'metadata.dimensions.height'));
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
}
|
|
90
|
+
else {
|
|
91
|
+
warnings.push(ValidationUtils.warning('MISSING_DIMENSIONS', `Consider specifying dimensions for ${metadata.mediaType} content`, 'metadata.dimensions'));
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
// Validate duration for audio and video
|
|
95
|
+
if (metadata.mediaType === 'audio' || metadata.mediaType === 'video') {
|
|
96
|
+
if (metadata.duration !== undefined) {
|
|
97
|
+
if (typeof metadata.duration !== 'number' || metadata.duration < 0) {
|
|
98
|
+
errors.push(ValidationUtils.error('INVALID_DURATION', 'Duration must be a non-negative number (seconds)', 'metadata.duration'));
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
else {
|
|
102
|
+
warnings.push(ValidationUtils.warning('MISSING_DURATION', `Consider specifying duration for ${metadata.mediaType} content`, 'metadata.duration'));
|
|
103
|
+
}
|
|
104
|
+
}
|
|
105
|
+
// Validate frameRate for video
|
|
106
|
+
if (metadata.mediaType === 'video' || metadata.mediaType === 'animation') {
|
|
107
|
+
if (metadata.frameRate !== undefined) {
|
|
108
|
+
if (typeof metadata.frameRate !== 'number' || metadata.frameRate <= 0) {
|
|
109
|
+
errors.push(ValidationUtils.error('INVALID_FRAME_RATE', 'Frame rate must be a positive number', 'metadata.frameRate'));
|
|
110
|
+
}
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
// Validate audio-specific fields
|
|
114
|
+
if (metadata.mediaType === 'audio' || metadata.mediaType === 'video') {
|
|
115
|
+
if (metadata.audioChannels !== undefined) {
|
|
116
|
+
if (typeof metadata.audioChannels !== 'number' ||
|
|
117
|
+
metadata.audioChannels <= 0 ||
|
|
118
|
+
!Number.isInteger(metadata.audioChannels)) {
|
|
119
|
+
errors.push(ValidationUtils.error('INVALID_AUDIO_CHANNELS', 'Audio channels must be a positive integer', 'metadata.audioChannels'));
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
if (metadata.sampleRate !== undefined) {
|
|
123
|
+
if (typeof metadata.sampleRate !== 'number' || metadata.sampleRate <= 0) {
|
|
124
|
+
errors.push(ValidationUtils.error('INVALID_SAMPLE_RATE', 'Sample rate must be a positive number', 'metadata.sampleRate'));
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
// Validate bitrate if specified
|
|
129
|
+
if (metadata.bitrate !== undefined) {
|
|
130
|
+
if (typeof metadata.bitrate !== 'number' || metadata.bitrate <= 0) {
|
|
131
|
+
errors.push(ValidationUtils.error('INVALID_BITRATE', 'Bitrate must be a positive number (kbps)', 'metadata.bitrate'));
|
|
132
|
+
}
|
|
133
|
+
}
|
|
134
|
+
// Validate thumbnail if specified
|
|
135
|
+
if (metadata.thumbnail) {
|
|
136
|
+
if (typeof metadata.thumbnail !== 'string') {
|
|
137
|
+
errors.push(ValidationUtils.error('INVALID_THUMBNAIL', 'Thumbnail must be a string (resource ID)', 'metadata.thumbnail'));
|
|
138
|
+
}
|
|
139
|
+
else if (!ValidationUtils.resourceExists(metadata.thumbnail, manifest.resources)) {
|
|
140
|
+
warnings.push(ValidationUtils.warning('THUMBNAIL_NOT_RESOURCE', `Thumbnail "${metadata.thumbnail}" does not match a resource ID`, 'metadata.thumbnail'));
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
// Validate preview if specified
|
|
144
|
+
if (metadata.preview) {
|
|
145
|
+
if (typeof metadata.preview !== 'string') {
|
|
146
|
+
errors.push(ValidationUtils.error('INVALID_PREVIEW', 'Preview must be a string (resource ID)', 'metadata.preview'));
|
|
147
|
+
}
|
|
148
|
+
else if (!ValidationUtils.resourceExists(metadata.preview, manifest.resources)) {
|
|
149
|
+
warnings.push(ValidationUtils.warning('PREVIEW_NOT_RESOURCE', `Preview "${metadata.preview}" does not match a resource ID`, 'metadata.preview'));
|
|
150
|
+
}
|
|
151
|
+
}
|
|
152
|
+
// Suggest adding alt text for accessibility
|
|
153
|
+
if (!metadata.altText && metadata.mediaType === 'image') {
|
|
154
|
+
warnings.push(ValidationUtils.warning('MISSING_ALT_TEXT', 'Consider adding altText for accessibility', 'metadata.altText'));
|
|
155
|
+
}
|
|
156
|
+
// Check that at least one media resource exists
|
|
157
|
+
const mediaResources = manifest.resources.filter(r => r.type === 'media' ||
|
|
158
|
+
r.type === 'image' ||
|
|
159
|
+
r.type === 'audio' ||
|
|
160
|
+
r.type === 'video' ||
|
|
161
|
+
r.contentType.startsWith('image/') ||
|
|
162
|
+
r.contentType.startsWith('audio/') ||
|
|
163
|
+
r.contentType.startsWith('video/') ||
|
|
164
|
+
r.contentType.startsWith('model/'));
|
|
165
|
+
if (mediaResources.length === 0) {
|
|
166
|
+
warnings.push(ValidationUtils.warning('NO_MEDIA_RESOURCES', 'No media resources found. Ensure resources have appropriate types', 'resources'));
|
|
167
|
+
}
|
|
168
|
+
return errors.length > 0
|
|
169
|
+
? ValidationUtils.failure(errors, warnings)
|
|
170
|
+
: ValidationUtils.success(warnings);
|
|
171
|
+
}
|
|
172
|
+
}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Module Kind Validator
|
|
3
|
+
*
|
|
4
|
+
* Validates manifests for reusable code modules with exports and dependencies.
|
|
5
|
+
*/
|
|
6
|
+
import { OriginalKind, type OriginalManifest, type ValidationResult } from '../types';
|
|
7
|
+
import { BaseKindValidator } from './base';
|
|
8
|
+
/**
|
|
9
|
+
* Validator for Module Originals
|
|
10
|
+
*/
|
|
11
|
+
export declare class ModuleValidator extends BaseKindValidator<OriginalKind.Module> {
|
|
12
|
+
readonly kind = OriginalKind.Module;
|
|
13
|
+
protected validateKind(manifest: OriginalManifest<OriginalKind.Module>): ValidationResult;
|
|
14
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Module Kind Validator
|
|
3
|
+
*
|
|
4
|
+
* Validates manifests for reusable code modules with exports and dependencies.
|
|
5
|
+
*/
|
|
6
|
+
import { OriginalKind } from '../types';
|
|
7
|
+
import { BaseKindValidator, ValidationUtils } from './base';
|
|
8
|
+
/**
|
|
9
|
+
* Valid module formats
|
|
10
|
+
*/
|
|
11
|
+
const VALID_FORMATS = ['esm', 'commonjs', 'umd', 'amd', 'iife'];
|
|
12
|
+
/**
|
|
13
|
+
* Validator for Module Originals
|
|
14
|
+
*/
|
|
15
|
+
export class ModuleValidator extends BaseKindValidator {
|
|
16
|
+
constructor() {
|
|
17
|
+
super(...arguments);
|
|
18
|
+
this.kind = OriginalKind.Module;
|
|
19
|
+
}
|
|
20
|
+
validateKind(manifest) {
|
|
21
|
+
const errors = [];
|
|
22
|
+
const warnings = [];
|
|
23
|
+
const metadata = manifest.metadata;
|
|
24
|
+
// Validate metadata exists
|
|
25
|
+
if (!metadata || typeof metadata !== 'object') {
|
|
26
|
+
return ValidationUtils.failure([
|
|
27
|
+
ValidationUtils.error('MISSING_METADATA', 'Module manifest must have metadata', 'metadata'),
|
|
28
|
+
]);
|
|
29
|
+
}
|
|
30
|
+
// Validate format (required)
|
|
31
|
+
if (!metadata.format) {
|
|
32
|
+
errors.push(ValidationUtils.error('MISSING_FORMAT', 'Module must specify a format', 'metadata.format'));
|
|
33
|
+
}
|
|
34
|
+
else if (!VALID_FORMATS.includes(metadata.format)) {
|
|
35
|
+
errors.push(ValidationUtils.error('INVALID_FORMAT', `Invalid module format: "${metadata.format}". Must be one of: ${VALID_FORMATS.join(', ')}`, 'metadata.format', metadata.format));
|
|
36
|
+
}
|
|
37
|
+
// Validate main (required)
|
|
38
|
+
if (!metadata.main || typeof metadata.main !== 'string') {
|
|
39
|
+
errors.push(ValidationUtils.error('MISSING_MAIN', 'Module must specify a main entrypoint', 'metadata.main'));
|
|
40
|
+
}
|
|
41
|
+
else {
|
|
42
|
+
// Check if main references an existing resource
|
|
43
|
+
if (!ValidationUtils.resourceExists(metadata.main, manifest.resources)) {
|
|
44
|
+
warnings.push(ValidationUtils.warning('MAIN_NOT_RESOURCE', `Main entrypoint "${metadata.main}" does not match a resource ID`, 'metadata.main', 'Ensure the main entrypoint is a valid resource ID'));
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
// Validate types if specified
|
|
48
|
+
if (metadata.types) {
|
|
49
|
+
if (typeof metadata.types !== 'string') {
|
|
50
|
+
errors.push(ValidationUtils.error('INVALID_TYPES', 'Types must be a string (resource ID)', 'metadata.types'));
|
|
51
|
+
}
|
|
52
|
+
else if (!ValidationUtils.resourceExists(metadata.types, manifest.resources)) {
|
|
53
|
+
warnings.push(ValidationUtils.warning('TYPES_NOT_RESOURCE', `Types file "${metadata.types}" does not match a resource ID`, 'metadata.types'));
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
else {
|
|
57
|
+
warnings.push(ValidationUtils.warning('MISSING_TYPES', 'Consider adding TypeScript type definitions', 'metadata.types', 'Add a .d.ts file for better TypeScript support'));
|
|
58
|
+
}
|
|
59
|
+
// Validate exports if specified
|
|
60
|
+
if (metadata.exports) {
|
|
61
|
+
if (typeof metadata.exports !== 'object' || Array.isArray(metadata.exports)) {
|
|
62
|
+
errors.push(ValidationUtils.error('INVALID_EXPORTS', 'Exports must be an object', 'metadata.exports'));
|
|
63
|
+
}
|
|
64
|
+
else {
|
|
65
|
+
for (const [key, value] of Object.entries(metadata.exports)) {
|
|
66
|
+
if (typeof value === 'string') {
|
|
67
|
+
// Simple string export is valid
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
else if (typeof value === 'object' && value !== null) {
|
|
71
|
+
// Conditional exports object
|
|
72
|
+
const exportObj = value;
|
|
73
|
+
if (!exportObj.import && !exportObj.require) {
|
|
74
|
+
warnings.push(ValidationUtils.warning('INCOMPLETE_EXPORT', `Export "${key}" should have at least 'import' or 'require' field`, `metadata.exports.${key}`));
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
else {
|
|
78
|
+
errors.push(ValidationUtils.error('INVALID_EXPORT', `Export "${key}" must be a string or object`, `metadata.exports.${key}`));
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
// Check for "." export (main export)
|
|
82
|
+
if (!('.' in metadata.exports)) {
|
|
83
|
+
warnings.push(ValidationUtils.warning('MISSING_MAIN_EXPORT', 'Consider adding a "." export for the main module entry', 'metadata.exports'));
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
// Validate peer dependencies if specified
|
|
88
|
+
if (metadata.peerDependencies) {
|
|
89
|
+
if (typeof metadata.peerDependencies !== 'object' || Array.isArray(metadata.peerDependencies)) {
|
|
90
|
+
errors.push(ValidationUtils.error('INVALID_PEER_DEPS', 'Peer dependencies must be an object', 'metadata.peerDependencies'));
|
|
91
|
+
}
|
|
92
|
+
else {
|
|
93
|
+
for (const [name, version] of Object.entries(metadata.peerDependencies)) {
|
|
94
|
+
if (typeof version !== 'string') {
|
|
95
|
+
errors.push(ValidationUtils.error('INVALID_PEER_DEP_VERSION', `Peer dependency "${name}" must have a string version`, `metadata.peerDependencies.${name}`));
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
}
|
|
100
|
+
// Validate browser field if specified
|
|
101
|
+
if (metadata.browser) {
|
|
102
|
+
if (typeof metadata.browser !== 'string') {
|
|
103
|
+
errors.push(ValidationUtils.error('INVALID_BROWSER', 'Browser field must be a string (resource ID)', 'metadata.browser'));
|
|
104
|
+
}
|
|
105
|
+
else if (!ValidationUtils.resourceExists(metadata.browser, manifest.resources)) {
|
|
106
|
+
warnings.push(ValidationUtils.warning('BROWSER_NOT_RESOURCE', `Browser entrypoint "${metadata.browser}" does not match a resource ID`, 'metadata.browser'));
|
|
107
|
+
}
|
|
108
|
+
}
|
|
109
|
+
// Validate sideEffects if specified
|
|
110
|
+
if (metadata.sideEffects !== undefined) {
|
|
111
|
+
if (typeof metadata.sideEffects !== 'boolean' && !Array.isArray(metadata.sideEffects)) {
|
|
112
|
+
errors.push(ValidationUtils.error('INVALID_SIDE_EFFECTS', 'sideEffects must be a boolean or array of strings', 'metadata.sideEffects'));
|
|
113
|
+
}
|
|
114
|
+
else if (Array.isArray(metadata.sideEffects)) {
|
|
115
|
+
for (let i = 0; i < metadata.sideEffects.length; i++) {
|
|
116
|
+
if (typeof metadata.sideEffects[i] !== 'string') {
|
|
117
|
+
errors.push(ValidationUtils.error('INVALID_SIDE_EFFECT_ENTRY', `sideEffects entry at index ${i} must be a string`, `metadata.sideEffects[${i}]`));
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
}
|
|
122
|
+
// Validate TypeScript config if specified
|
|
123
|
+
if (metadata.typescript) {
|
|
124
|
+
if (typeof metadata.typescript !== 'object') {
|
|
125
|
+
errors.push(ValidationUtils.error('INVALID_TYPESCRIPT', 'TypeScript config must be an object', 'metadata.typescript'));
|
|
126
|
+
}
|
|
127
|
+
}
|
|
128
|
+
// Check that at least one code resource exists
|
|
129
|
+
const codeResources = manifest.resources.filter(r => r.contentType.includes('javascript') ||
|
|
130
|
+
r.contentType.includes('typescript') ||
|
|
131
|
+
r.contentType.includes('json') ||
|
|
132
|
+
r.type === 'code');
|
|
133
|
+
if (codeResources.length === 0) {
|
|
134
|
+
warnings.push(ValidationUtils.warning('NO_CODE_RESOURCES', 'No code resources found. Ensure resources have appropriate content types', 'resources'));
|
|
135
|
+
}
|
|
136
|
+
return errors.length > 0
|
|
137
|
+
? ValidationUtils.failure(errors, warnings)
|
|
138
|
+
: ValidationUtils.success(warnings);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Base validator interface and common validation utilities
|
|
3
|
+
*/
|
|
4
|
+
import type { OriginalKind, OriginalManifest, ValidationResult, ValidationError, ValidationWarning, BaseManifest } from '../types';
|
|
5
|
+
import type { AssetResource } from '../../types/common';
|
|
6
|
+
/**
|
|
7
|
+
* Interface for kind-specific validators
|
|
8
|
+
*/
|
|
9
|
+
export interface KindValidator<K extends OriginalKind = OriginalKind> {
|
|
10
|
+
/** The kind this validator handles */
|
|
11
|
+
readonly kind: K;
|
|
12
|
+
/**
|
|
13
|
+
* Validate a manifest for this kind
|
|
14
|
+
* @param manifest - The manifest to validate
|
|
15
|
+
* @returns Validation result with errors and warnings
|
|
16
|
+
*/
|
|
17
|
+
validate(manifest: OriginalManifest<K>): ValidationResult;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Common validation utilities
|
|
21
|
+
*/
|
|
22
|
+
export declare class ValidationUtils {
|
|
23
|
+
/**
|
|
24
|
+
* Check if a string is a valid semantic version
|
|
25
|
+
*/
|
|
26
|
+
static isValidSemver(version: string): boolean;
|
|
27
|
+
/**
|
|
28
|
+
* Check if a string is a valid DID
|
|
29
|
+
*/
|
|
30
|
+
static isValidDID(did: string): boolean;
|
|
31
|
+
/**
|
|
32
|
+
* Check if a string is a valid SPDX license identifier
|
|
33
|
+
*/
|
|
34
|
+
static isValidSPDXLicense(license: string): boolean;
|
|
35
|
+
/**
|
|
36
|
+
* Check if a string is a valid MIME type
|
|
37
|
+
*/
|
|
38
|
+
static isValidMimeType(mimeType: string): boolean;
|
|
39
|
+
/**
|
|
40
|
+
* Check if a string is a valid URL
|
|
41
|
+
*/
|
|
42
|
+
static isValidURL(url: string): boolean;
|
|
43
|
+
/**
|
|
44
|
+
* Check if a string is a valid ISO 639-1 language code
|
|
45
|
+
*/
|
|
46
|
+
static isValidLanguageCode(code: string): boolean;
|
|
47
|
+
/**
|
|
48
|
+
* Check if a resource ID exists in the resources array
|
|
49
|
+
*/
|
|
50
|
+
static resourceExists(resourceId: string, resources: AssetResource[]): boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Get a resource by ID
|
|
53
|
+
*/
|
|
54
|
+
static getResource(resourceId: string, resources: AssetResource[]): AssetResource | undefined;
|
|
55
|
+
/**
|
|
56
|
+
* Create a validation error
|
|
57
|
+
*/
|
|
58
|
+
static error(code: string, message: string, path?: string, value?: unknown): ValidationError;
|
|
59
|
+
/**
|
|
60
|
+
* Create a validation warning
|
|
61
|
+
*/
|
|
62
|
+
static warning(code: string, message: string, path?: string, suggestion?: string): ValidationWarning;
|
|
63
|
+
/**
|
|
64
|
+
* Create a successful validation result
|
|
65
|
+
*/
|
|
66
|
+
static success(warnings?: ValidationWarning[]): ValidationResult;
|
|
67
|
+
/**
|
|
68
|
+
* Create a failed validation result
|
|
69
|
+
*/
|
|
70
|
+
static failure(errors: ValidationError[], warnings?: ValidationWarning[]): ValidationResult;
|
|
71
|
+
/**
|
|
72
|
+
* Merge multiple validation results
|
|
73
|
+
*/
|
|
74
|
+
static merge(...results: ValidationResult[]): ValidationResult;
|
|
75
|
+
}
|
|
76
|
+
/**
|
|
77
|
+
* Base validator class with common validation logic
|
|
78
|
+
*/
|
|
79
|
+
export declare abstract class BaseKindValidator<K extends OriginalKind> implements KindValidator<K> {
|
|
80
|
+
abstract readonly kind: K;
|
|
81
|
+
/**
|
|
82
|
+
* Validate a manifest
|
|
83
|
+
* Combines base validation with kind-specific validation
|
|
84
|
+
*/
|
|
85
|
+
validate(manifest: OriginalManifest<K>): ValidationResult;
|
|
86
|
+
/**
|
|
87
|
+
* Validate base manifest fields common to all kinds
|
|
88
|
+
*/
|
|
89
|
+
protected validateBase(manifest: BaseManifest & {
|
|
90
|
+
kind: K;
|
|
91
|
+
}): ValidationResult;
|
|
92
|
+
/**
|
|
93
|
+
* Kind-specific validation to be implemented by subclasses
|
|
94
|
+
*/
|
|
95
|
+
protected abstract validateKind(manifest: OriginalManifest<K>): ValidationResult;
|
|
96
|
+
}
|