@effected/sbom 0.5.0 → 0.6.1

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/index.d.ts CHANGED
@@ -252,7 +252,7 @@ export declare class InTotoStatement extends InTotoStatement_base {
252
252
  * be read by a person.
253
253
  */
254
254
  toJson(options?: {
255
- readonly space?: number;
255
+ readonly space?: number | undefined;
256
256
  }): string;
257
257
  }
258
258
  //#endregion
@@ -484,7 +484,7 @@ interface SbomInput {
484
484
  /** Its dependencies, in any order — the document sorts them. */
485
485
  readonly components: ReadonlyArray<Component>;
486
486
  /** Document metadata. `root` is threaded onto it automatically. */
487
- readonly metadata?: SbomMetadata;
487
+ readonly metadata?: SbomMetadata | undefined;
488
488
  }
489
489
  /**
490
490
  * Options for {@link Sbom.toJson}.
@@ -493,7 +493,7 @@ interface SbomInput {
493
493
  */
494
494
  interface SbomJsonOptions {
495
495
  /** `JSON.stringify` indentation. Defaults to `2`; `0` emits one line. */
496
- readonly space?: number;
496
+ readonly space?: number | undefined;
497
497
  }
498
498
  declare const SbomWriteError_base: Schema.Class<SbomWriteError, Schema.TaggedStruct<"SbomWriteError", {
499
499
  /** The path that could not be written. */
@@ -571,19 +571,19 @@ export declare class Sbom {
571
571
  */
572
572
  interface SbomMetadataOptions {
573
573
  /** The supplying organization — NTIA minimum element 1. */
574
- readonly supplier?: Supplier;
574
+ readonly supplier?: Supplier | undefined;
575
575
  /** Who assembled the BOM — NTIA minimum element 6. */
576
- readonly authors?: ReadonlyArray<Contact>;
576
+ readonly authors?: ReadonlyArray<Contact> | undefined;
577
577
  /** When it was assembled — NTIA minimum element 7, as an ISO 8601 string. */
578
- readonly timestamp?: string;
578
+ readonly timestamp?: string | undefined;
579
579
  /** The publishing entity. Falls back to the supplier, then the manifest's author. */
580
- readonly publisher?: string;
580
+ readonly publisher?: string | undefined;
581
581
  /** A copyright statement; {@link SbomMetadataSource.formatCopyright} builds one. */
582
- readonly copyright?: string;
582
+ readonly copyright?: string | undefined;
583
583
  /** The documentation URL, winning over the manifest's `homepage`. */
584
- readonly documentationUrl?: string;
584
+ readonly documentationUrl?: string | undefined;
585
585
  /** The root component's type. Defaults to `library`. */
586
- readonly type?: ComponentType;
586
+ readonly type?: ComponentType | undefined;
587
587
  }
588
588
  /**
589
589
  * The fields a dependency contributes to its component entry.
@@ -593,14 +593,19 @@ interface SbomMetadataOptions {
593
593
  interface ComponentInput {
594
594
  /** The package name, scope included. */
595
595
  readonly name: string;
596
- /** Its resolved version. Absent produces a component with no version and no purl version segment. */
597
- readonly version?: string;
596
+ /**
597
+ * Its resolved version. Absent produces a component with no version and no
598
+ * purl version segment. Typed `string | undefined` so a caller forwarding a
599
+ * statically optional version (e.g. `WorkspacePackage.version` from
600
+ * `@effected/workspaces`) compiles under `exactOptionalPropertyTypes`.
601
+ */
602
+ readonly version?: string | undefined;
598
603
  /** An SPDX identifier or expression. */
599
- readonly license?: string;
604
+ readonly license?: string | undefined;
600
605
  /** A short description. */
601
- readonly description?: string;
606
+ readonly description?: string | undefined;
602
607
  /** The component type. Defaults to `library`. */
603
- readonly type?: ComponentType;
608
+ readonly type?: ComponentType | undefined;
604
609
  }
605
610
  /**
606
611
  * The years a copyright statement spans.
@@ -609,7 +614,7 @@ interface ComponentInput {
609
614
  */
610
615
  interface CopyrightYears {
611
616
  /** The first year of the range. Omit for a single-year statement. */
612
- readonly startYear?: number;
617
+ readonly startYear?: number | undefined;
613
618
  /** The year the statement is current through — the caller's clock read, never ours. */
614
619
  readonly year: number;
615
620
  }
@@ -817,13 +822,13 @@ export declare class SigningError extends SigningError_base {
817
822
  */
818
823
  interface SigstoreSignerOptions {
819
824
  /** Fulcio's base URL. Defaults to the public-good instance. */
820
- readonly fulcioBaseUrl?: string;
825
+ readonly fulcioBaseUrl?: string | undefined;
821
826
  /** Rekor's base URL. Defaults to the public-good instance. */
822
- readonly rekorBaseUrl?: string;
827
+ readonly rekorBaseUrl?: string | undefined;
823
828
  /** Replace the certificate signer. */
824
- readonly signer?: Signer;
829
+ readonly signer?: Signer | undefined;
825
830
  /** Replace the witnesses. An empty array signs without a transparency log. */
826
- readonly witnesses?: ReadonlyArray<Witness>;
831
+ readonly witnesses?: ReadonlyArray<Witness> | undefined;
827
832
  }
828
833
  /**
829
834
  * The signing surface.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@effected/sbom",
3
- "version": "0.5.0",
3
+ "version": "0.6.1",
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.14.0",
43
- "@effected/spdx": "^0.6.0",
42
+ "@effected/package-json": "^0.15.0",
43
+ "@effected/spdx": "^0.7.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.112"
48
+ "effect": "4.0.0-rc.115"
49
49
  },
50
50
  "engines": {
51
51
  "node": ">=24.11.0"
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.59.0"
8
+ "packageVersion": "7.59.1"
9
9
  }
10
10
  ]
11
11
  }