@effected/sbom 0.4.4 → 0.5.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.
Files changed (2) hide show
  1. package/index.d.ts +40 -40
  2. package/package.json +4 -4
package/index.d.ts CHANGED
@@ -18,7 +18,7 @@ declare const IdentityTokenError_base: Schema.Class<IdentityTokenError, Schema.T
18
18
  *
19
19
  * @public
20
20
  */
21
- declare class IdentityTokenError extends IdentityTokenError_base {
21
+ export declare class IdentityTokenError extends IdentityTokenError_base {
22
22
  get message(): string;
23
23
  }
24
24
  /**
@@ -50,7 +50,7 @@ declare const IdentityToken_base: Context.ServiceClass<IdentityToken, "@effected
50
50
  *
51
51
  * @public
52
52
  */
53
- declare class IdentityToken extends IdentityToken_base {
53
+ export declare class IdentityToken extends IdentityToken_base {
54
54
  /**
55
55
  * A layer answering with a token the caller already holds.
56
56
  *
@@ -84,13 +84,13 @@ declare class IdentityToken extends IdentityToken_base {
84
84
  *
85
85
  * @public
86
86
  */
87
- declare const IN_TOTO_STATEMENT_V1: "https://in-toto.io/Statement/v1";
87
+ export declare const IN_TOTO_STATEMENT_V1: "https://in-toto.io/Statement/v1";
88
88
  /**
89
89
  * The CycloneDX BOM predicate type, for attesting an SBOM.
90
90
  *
91
91
  * @public
92
92
  */
93
- declare const CYCLONEDX_BOM_PREDICATE: "https://cyclonedx.org/bom";
93
+ export declare const CYCLONEDX_BOM_PREDICATE: "https://cyclonedx.org/bom";
94
94
  /**
95
95
  * The URI naming what a statement asserts about its subjects.
96
96
  *
@@ -113,7 +113,7 @@ declare const InvalidSha256DigestError_base: Schema.Class<InvalidSha256DigestErr
113
113
  *
114
114
  * @public
115
115
  */
116
- declare class InvalidSha256DigestError extends InvalidSha256DigestError_base {
116
+ export declare class InvalidSha256DigestError extends InvalidSha256DigestError_base {
117
117
  get message(): string;
118
118
  }
119
119
  /**
@@ -128,7 +128,7 @@ declare class InvalidSha256DigestError extends InvalidSha256DigestError_base {
128
128
  *
129
129
  * @public
130
130
  */
131
- declare const Sha256Digest: Schema.brand<Schema.String, "Sha256Digest"> & {
131
+ export declare const Sha256Digest: Schema.brand<Schema.String, "Sha256Digest"> & {
132
132
  isValid: (value: string) => boolean;
133
133
  parseResult: (value: string) => Result.Result<Sha256Digest, InvalidSha256DigestError>;
134
134
  parse: (value: string) => Effect.Effect<Sha256Digest, InvalidSha256DigestError, never>;
@@ -138,7 +138,7 @@ declare const Sha256Digest: Schema.brand<Schema.String, "Sha256Digest"> & {
138
138
  *
139
139
  * @public
140
140
  */
141
- type Sha256Digest = string & Brand.Brand<"Sha256Digest">;
141
+ export type Sha256Digest = string & Brand.Brand<"Sha256Digest">;
142
142
  declare const InTotoSubject_base: Schema.Class<InTotoSubject, Schema.Struct<{
143
143
  /** How the subject is identified — a purl for an npm package. */
144
144
  readonly name: Schema.String;
@@ -156,7 +156,7 @@ declare const InTotoSubject_base: Schema.Class<InTotoSubject, Schema.Struct<{
156
156
  *
157
157
  * @public
158
158
  */
159
- declare class InTotoSubject extends InTotoSubject_base {
159
+ export declare class InTotoSubject extends InTotoSubject_base {
160
160
  /**
161
161
  * A subject identified by a SHA-256 digest.
162
162
  *
@@ -238,7 +238,7 @@ declare const InTotoStatement_base: Schema.Class<InTotoStatement, Schema.Struct<
238
238
  *
239
239
  * @public
240
240
  */
241
- declare class InTotoStatement extends InTotoStatement_base {
241
+ export declare class InTotoStatement extends InTotoStatement_base {
242
242
  /** A statement over any number of subjects. **Total.** */
243
243
  static of(input: InTotoStatementInput): InTotoStatement;
244
244
  /** A statement over a single artifact — the common case. **Total.** */
@@ -267,13 +267,13 @@ declare class InTotoStatement extends InTotoStatement_base {
267
267
  *
268
268
  * @public
269
269
  */
270
- declare const ComponentType: Schema.Literals<readonly ["library", "application", "framework"]>;
270
+ export declare const ComponentType: Schema.Literals<readonly ["library", "application", "framework"]>;
271
271
  /**
272
272
  * The decoded type of {@link (ComponentType:variable)}.
273
273
  *
274
274
  * @public
275
275
  */
276
- type ComponentType = typeof ComponentType.Type;
276
+ export type ComponentType = typeof ComponentType.Type;
277
277
  /**
278
278
  * An external reference's kind.
279
279
  *
@@ -284,13 +284,13 @@ type ComponentType = typeof ComponentType.Type;
284
284
  *
285
285
  * @public
286
286
  */
287
- declare const ExternalReferenceType: Schema.Literals<readonly ["vcs", "issue-tracker", "website", "documentation"]>;
287
+ export declare const ExternalReferenceType: Schema.Literals<readonly ["vcs", "issue-tracker", "website", "documentation"]>;
288
288
  /**
289
289
  * The decoded type of {@link (ExternalReferenceType:variable)}.
290
290
  *
291
291
  * @public
292
292
  */
293
- type ExternalReferenceType = typeof ExternalReferenceType.Type;
293
+ export type ExternalReferenceType = typeof ExternalReferenceType.Type;
294
294
  declare const ExternalReference_base: Schema.Class<ExternalReference, Schema.Struct<{
295
295
  /** The reference kind. */
296
296
  readonly type: Schema.Literals<readonly ["vcs", "issue-tracker", "website", "documentation"]>;
@@ -302,7 +302,7 @@ declare const ExternalReference_base: Schema.Class<ExternalReference, Schema.Str
302
302
  *
303
303
  * @public
304
304
  */
305
- declare class ExternalReference extends ExternalReference_base {}
305
+ export declare class ExternalReference extends ExternalReference_base {}
306
306
  declare const Contact_base: Schema.Class<Contact, Schema.Struct<{
307
307
  /** The contact's name. */
308
308
  readonly name: Schema.optionalKey<Schema.String>;
@@ -316,7 +316,7 @@ declare const Contact_base: Schema.Class<Contact, Schema.Struct<{
316
316
  *
317
317
  * @public
318
318
  */
319
- declare class Contact extends Contact_base {}
319
+ export declare class Contact extends Contact_base {}
320
320
  declare const Supplier_base: Schema.Class<Supplier, Schema.Struct<{
321
321
  /** The supplier organization's name. */
322
322
  readonly name: Schema.String;
@@ -334,7 +334,7 @@ declare const Supplier_base: Schema.Class<Supplier, Schema.Struct<{
334
334
  *
335
335
  * @public
336
336
  */
337
- declare class Supplier extends Supplier_base {}
337
+ export declare class Supplier extends Supplier_base {}
338
338
  declare const Component_base: Schema.Class<Component, Schema.Struct<{
339
339
  /** What kind of component this is. */
340
340
  readonly type: Schema.Literals<readonly ["library", "application", "framework"]>;
@@ -371,7 +371,7 @@ declare const Component_base: Schema.Class<Component, Schema.Struct<{
371
371
  *
372
372
  * @public
373
373
  */
374
- declare class Component extends Component_base {}
374
+ export declare class Component extends Component_base {}
375
375
  declare const SbomMetadata_base: Schema.Class<SbomMetadata, Schema.Struct<{
376
376
  /** When the BOM was assembled — NTIA minimum element 7. */
377
377
  readonly timestamp: Schema.optionalKey<Schema.String>;
@@ -387,7 +387,7 @@ declare const SbomMetadata_base: Schema.Class<SbomMetadata, Schema.Struct<{
387
387
  *
388
388
  * @public
389
389
  */
390
- declare class SbomMetadata extends SbomMetadata_base {}
390
+ export declare class SbomMetadata extends SbomMetadata_base {}
391
391
  declare const SbomDocument_base: Schema.Class<SbomDocument, Schema.Struct<{
392
392
  /** Always `"CycloneDX"`. */
393
393
  readonly bomFormat: Schema.Literal<"CycloneDX">;
@@ -410,7 +410,7 @@ declare const SbomDocument_base: Schema.Class<SbomDocument, Schema.Struct<{
410
410
  *
411
411
  * @public
412
412
  */
413
- declare class SbomDocument extends SbomDocument_base {}
413
+ export declare class SbomDocument extends SbomDocument_base {}
414
414
  //#endregion
415
415
  //#region src/NtiaReport.d.ts
416
416
  /**
@@ -422,13 +422,13 @@ declare class SbomDocument extends SbomDocument_base {}
422
422
  *
423
423
  * @public
424
424
  */
425
- declare const NtiaElementId: Schema.Literals<readonly ["supplierName", "componentName", "componentVersion", "uniqueIdentifier", "dependencyRelationship", "sbomAuthor", "timestamp"]>;
425
+ export declare const NtiaElementId: Schema.Literals<readonly ["supplierName", "componentName", "componentVersion", "uniqueIdentifier", "dependencyRelationship", "sbomAuthor", "timestamp"]>;
426
426
  /**
427
427
  * The decoded type of {@link (NtiaElementId:variable)}.
428
428
  *
429
429
  * @public
430
430
  */
431
- type NtiaElementId = typeof NtiaElementId.Type;
431
+ export type NtiaElementId = typeof NtiaElementId.Type;
432
432
  declare const NtiaElement_base: Schema.Class<NtiaElement, Schema.Struct<{
433
433
  /** Which element this is. */
434
434
  readonly id: Schema.Literals<readonly ["supplierName", "componentName", "componentVersion", "uniqueIdentifier", "dependencyRelationship", "sbomAuthor", "timestamp"]>;
@@ -442,7 +442,7 @@ declare const NtiaElement_base: Schema.Class<NtiaElement, Schema.Struct<{
442
442
  *
443
443
  * @public
444
444
  */
445
- declare class NtiaElement extends NtiaElement_base {}
445
+ export declare class NtiaElement extends NtiaElement_base {}
446
446
  declare const NtiaReport_base: Schema.Class<NtiaReport, Schema.Struct<{
447
447
  /** One verdict per element, in the published order. */
448
448
  readonly elements: Schema.$Array<typeof NtiaElement>;
@@ -460,7 +460,7 @@ declare const NtiaReport_base: Schema.Class<NtiaReport, Schema.Struct<{
460
460
  *
461
461
  * @public
462
462
  */
463
- declare class NtiaReport extends NtiaReport_base {
463
+ export declare class NtiaReport extends NtiaReport_base {
464
464
  /** Whether every element is satisfied. */
465
465
  get compliant(): boolean;
466
466
  /** The elements the document does not satisfy, by id. */
@@ -510,7 +510,7 @@ declare const SbomWriteError_base: Schema.Class<SbomWriteError, Schema.TaggedStr
510
510
  *
511
511
  * @public
512
512
  */
513
- declare class SbomWriteError extends SbomWriteError_base {
513
+ export declare class SbomWriteError extends SbomWriteError_base {
514
514
  get message(): string;
515
515
  }
516
516
  /**
@@ -526,7 +526,7 @@ declare class SbomWriteError extends SbomWriteError_base {
526
526
  *
527
527
  * @public
528
528
  */
529
- declare class Sbom {
529
+ export declare class Sbom {
530
530
  private constructor();
531
531
  /**
532
532
  * Assemble a CycloneDX 1.6 document.
@@ -627,7 +627,7 @@ interface CopyrightYears {
627
627
  *
628
628
  * @public
629
629
  */
630
- declare class SbomMetadataSource {
630
+ export declare class SbomMetadataSource {
631
631
  private constructor();
632
632
  /**
633
633
  * The canonical npm package URL for a name and optional version.
@@ -722,14 +722,14 @@ declare class SbomMetadataSource {
722
722
  *
723
723
  * @public
724
724
  */
725
- declare const SIGSTORE_BUNDLE_V0_3_MEDIA_TYPE: "application/vnd.dev.sigstore.bundle.v0.3+json";
725
+ export declare const SIGSTORE_BUNDLE_V0_3_MEDIA_TYPE: "application/vnd.dev.sigstore.bundle.v0.3+json";
726
726
  /**
727
727
  * The DSSE payload type for an in-toto statement, per the GitHub attestations
728
728
  * specification.
729
729
  *
730
730
  * @public
731
731
  */
732
- declare const IN_TOTO_PAYLOAD_TYPE: "application/vnd.in-toto+json";
732
+ export declare const IN_TOTO_PAYLOAD_TYPE: "application/vnd.in-toto+json";
733
733
  declare const SigstoreBundle_base: Schema.Class<SigstoreBundle, Schema.Struct<{
734
734
  /** The bundle's media type, usually {@link SIGSTORE_BUNDLE_V0_3_MEDIA_TYPE}. */
735
735
  readonly mediaType: Schema.String;
@@ -755,7 +755,7 @@ declare const SigstoreBundle_base: Schema.Class<SigstoreBundle, Schema.Struct<{
755
755
  *
756
756
  * @public
757
757
  */
758
- declare class SigstoreBundle extends SigstoreBundle_base {}
758
+ export declare class SigstoreBundle extends SigstoreBundle_base {}
759
759
  //#endregion
760
760
  //#region src/SigstoreSigner.d.ts
761
761
  /**
@@ -771,19 +771,19 @@ declare class SigstoreBundle extends SigstoreBundle_base {}
771
771
  *
772
772
  * @public
773
773
  */
774
- declare const SIGSTORE_OIDC_AUDIENCE: "sigstore";
774
+ export declare const SIGSTORE_OIDC_AUDIENCE: "sigstore";
775
775
  /**
776
776
  * Which step of signing failed.
777
777
  *
778
778
  * @public
779
779
  */
780
- declare const SigningErrorKind: Schema.Literals<readonly ["identity", "certificate", "transparencyLog", "bundle"]>;
780
+ export declare const SigningErrorKind: Schema.Literals<readonly ["identity", "certificate", "transparencyLog", "bundle"]>;
781
781
  /**
782
782
  * The decoded type of {@link (SigningErrorKind:variable)}.
783
783
  *
784
784
  * @public
785
785
  */
786
- type SigningErrorKind = typeof SigningErrorKind.Type;
786
+ export type SigningErrorKind = typeof SigningErrorKind.Type;
787
787
  declare const SigningError_base: Schema.Class<SigningError, Schema.TaggedStruct<"SigningError", {
788
788
  /** Which step failed. */
789
789
  readonly kind: Schema.Literals<readonly ["identity", "certificate", "transparencyLog", "bundle"]>;
@@ -801,7 +801,7 @@ declare const SigningError_base: Schema.Class<SigningError, Schema.TaggedStruct<
801
801
  *
802
802
  * @public
803
803
  */
804
- declare class SigningError extends SigningError_base {
804
+ export declare class SigningError extends SigningError_base {
805
805
  get message(): string;
806
806
  }
807
807
  /**
@@ -858,7 +858,7 @@ declare const SigstoreSigner_base: Context.ServiceClass<SigstoreSigner, "@effect
858
858
  *
859
859
  * @public
860
860
  */
861
- declare class SigstoreSigner extends SigstoreSigner_base {
861
+ export declare class SigstoreSigner extends SigstoreSigner_base {
862
862
  /** Signing against the public-good Fulcio and Rekor instances. */
863
863
  static readonly layer: Layer.Layer<SigstoreSigner, never, IdentityToken>;
864
864
  /** {@link (SigstoreSigner:class).layer} with the signing endpoints, or the signer and witnesses, replaced. */
@@ -884,7 +884,7 @@ declare class SigstoreSigner extends SigstoreSigner_base {
884
884
  *
885
885
  * @public
886
886
  */
887
- declare const SLSA_PROVENANCE_V1: "https://slsa.dev/provenance/v1";
887
+ export declare const SLSA_PROVENANCE_V1: "https://slsa.dev/provenance/v1";
888
888
  /**
889
889
  * The SLSA build type identifying a GitHub Actions workflow build.
890
890
  *
@@ -897,7 +897,7 @@ declare const SLSA_PROVENANCE_V1: "https://slsa.dev/provenance/v1";
897
897
  *
898
898
  * @public
899
899
  */
900
- declare const GITHUB_BUILD_TYPE: "https://actions.github.io/buildtypes/workflow/v1";
900
+ export declare const GITHUB_BUILD_TYPE: "https://actions.github.io/buildtypes/workflow/v1";
901
901
  declare const SlsaBuildDefinition_base: Schema.Class<SlsaBuildDefinition, Schema.Struct<{
902
902
  /** The build type URI — {@link GITHUB_BUILD_TYPE} for an Actions workflow. */
903
903
  readonly buildType: Schema.String;
@@ -940,7 +940,7 @@ declare const SlsaBuildDefinition_base: Schema.Class<SlsaBuildDefinition, Schema
940
940
  *
941
941
  * @public
942
942
  */
943
- declare class SlsaBuildDefinition extends SlsaBuildDefinition_base {}
943
+ export declare class SlsaBuildDefinition extends SlsaBuildDefinition_base {}
944
944
  declare const SlsaRunDetails_base: Schema.Class<SlsaRunDetails, Schema.Struct<{
945
945
  /** The build platform's identity. */
946
946
  readonly builder: Schema.Struct<{
@@ -958,7 +958,7 @@ declare const SlsaRunDetails_base: Schema.Class<SlsaRunDetails, Schema.Struct<{
958
958
  *
959
959
  * @public
960
960
  */
961
- declare class SlsaRunDetails extends SlsaRunDetails_base {}
961
+ export declare class SlsaRunDetails extends SlsaRunDetails_base {}
962
962
  /**
963
963
  * The claims and runner facts a GitHub Actions provenance predicate is built
964
964
  * from.
@@ -1018,7 +1018,7 @@ declare const SlsaProvenance_base: Schema.Class<SlsaProvenance, Schema.Struct<{
1018
1018
  *
1019
1019
  * @public
1020
1020
  */
1021
- declare class SlsaProvenance extends SlsaProvenance_base {
1021
+ export declare class SlsaProvenance extends SlsaProvenance_base {
1022
1022
  /** The predicate type URI a statement carrying this must declare. */
1023
1023
  static readonly predicateType: PredicateType;
1024
1024
  /** The build type this package's GitHub-workflow constructor stamps. */
@@ -1034,5 +1034,5 @@ declare class SlsaProvenance extends SlsaProvenance_base {
1034
1034
  static forGitHubWorkflow(input: GitHubWorkflowProvenance): SlsaProvenance;
1035
1035
  }
1036
1036
  //#endregion
1037
- export { CYCLONEDX_BOM_PREDICATE, Component, type ComponentInput, ComponentType, Contact, type CopyrightYears, ExternalReference, ExternalReferenceType, GITHUB_BUILD_TYPE, type GitHubWorkflowProvenance, IN_TOTO_PAYLOAD_TYPE, IN_TOTO_STATEMENT_V1, IdentityToken, IdentityTokenError, type IdentityTokenShape, InTotoStatement, type InTotoStatementInput, InTotoSubject, type InTotoSubjectInput, InvalidSha256DigestError, NtiaElement, NtiaElementId, NtiaReport, Package, Person, type PredicateType, Repository, SIGSTORE_BUNDLE_V0_3_MEDIA_TYPE, SIGSTORE_OIDC_AUDIENCE, SLSA_PROVENANCE_V1, Sbom, SbomDocument, type SbomInput, type SbomJsonOptions, SbomMetadata, type SbomMetadataOptions, SbomMetadataSource, SbomWriteError, Sha256Digest, SigningError, SigningErrorKind, SigstoreBundle, SigstoreSigner, type SigstoreSignerOptions, type SigstoreSignerShape, SlsaBuildDefinition, SlsaProvenance, SlsaRunDetails, Supplier };
1037
+ export { type ComponentInput, type CopyrightYears, type GitHubWorkflowProvenance, type IdentityTokenShape, type InTotoStatementInput, type InTotoSubjectInput, Package, Person, type PredicateType, Repository, type SbomInput, type SbomJsonOptions, type SbomMetadataOptions, type SigstoreSignerOptions, type SigstoreSignerShape };
1038
1038
  //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effected/sbom",
3
- "version": "0.4.4",
3
+ "version": "0.5.0",
4
4
  "private": false,
5
5
  "description": "CycloneDX 1.6 SBOM construction, SLSA provenance, NTIA validation and Sigstore signing as typed services.",
6
6
  "keywords": [
@@ -39,13 +39,13 @@
39
39
  "./package.json": "./package.json"
40
40
  },
41
41
  "dependencies": {
42
- "@effected/package-json": "^0.13.0",
43
- "@effected/spdx": "^0.5.0",
42
+ "@effected/package-json": "^0.14.0",
43
+ "@effected/spdx": "^0.6.0",
44
44
  "@sigstore/bundle": "^5.0.0",
45
45
  "@sigstore/sign": "^5.0.0"
46
46
  },
47
47
  "peerDependencies": {
48
- "effect": "4.0.0-rc.109"
48
+ "effect": "4.0.0-rc.112"
49
49
  },
50
50
  "engines": {
51
51
  "node": ">=24.11.0"