@cdxgen/cdxgen 0.0.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,136 @@
+# `@cdxgen/cdxgen` name placeholder
+
+A minimal, deliberately inert package whose only job is to **create the
+`@cdxgen/cdxgen` name on npm and JSR** so trusted publishing can be configured
+against it.
+
+Both registries attach a trusted publisher to an *existing* package. The
+package therefore has to exist before the v13 release can publish via OIDC, and
+the first publish has to use a token. That first publish is what this directory
+is for.
+
+The `@cyclonedx` namespace already has this set up for v12; none of that
+configuration carries over to `@cdxgen`.
+
+## What it deliberately does not do
+
+- **No `bin`.** cdxgen's executable is called `cdxgen`. A placeholder shipping
+  an executable of that name would shadow the real tool for anyone who
+  installed it by accident.
+- **Not published as `latest`.** `publishConfig.tag` is `placeholder`, so
+  `npm install @cdxgen/cdxgen` does not resolve to it. Between this publish and
+  the v13 release the package has no `latest` tag at all, and an install fails
+  with "no matching version" — which is the correct outcome, because there is
+  nothing here worth installing.
+- **Version `0.0.1`**, so it sorts below `13.0.0` and never wins resolution.
+
+## Step 1 — publish the placeholder with a token
+
+Trusted publishing cannot be used for this first publish; that is the
+bootstrapping problem it exists to solve.
+
+```bash
+cd ~/cdxgen-publish-placeholder
+
+npm pack --dry-run          # expect exactly: mod.js, README.md, LICENSE, package.json
+
+npm login                   # or NODE_AUTH_TOKEN with publish rights on @cdxgen
+npm publish                 # access + placeholder tag come from publishConfig
+```
+
+Verify no `latest` tag was created:
+
+```bash
+npm view @cdxgen/cdxgen dist-tags
+# { placeholder: '0.0.1' }   ← latest must be absent
+```
+
+## Step 2 — publish to JSR
+
+JSR requires the `@cdxgen` scope to exist first — create it at
+<https://jsr.io/new> if it does not. Then:
+
+```bash
+npx jsr publish
+```
+
+JSR has no dist-tag concept, so `0.0.1` becomes the only version until v13
+publishes over it.
+
+## Step 3 — configure the trusted publisher on npm
+
+<https://www.npmjs.com/package/@cdxgen/cdxgen> → **Settings** → **Trusted
+publisher** → GitHub Actions:
+
+| Field | Value |
+| ----- | ----- |
+| Organization or user | `cdxgen` |
+| Repository | `cdxgen` |
+| Workflow filename | `npm-release.yml` |
+| Environment | *(leave empty unless the release job declares one)* |
+
+The workflow filename must match the file in `.github/workflows/` **exactly**,
+and it must exist on the repository's default branch. A mismatch surfaces as a
+403 at publish time with no explanation of which field is wrong.
+
+## Step 4 — configure the trusted publisher on JSR
+
+<https://jsr.io/@cdxgen/cdxgen/settings> → **GitHub repository** → link
+`cdxgen/cdxgen`. JSR verifies the OIDC token's repository claim, so any
+workflow in that repo with `id-token: write` can publish; there is no
+per-workflow field to match.
+
+## Step 5 — fix the real release workflow
+
+`.github/workflows/npm-release.yml` in `cdxgen/cdxgen` still carries the v12
+setup and will not authenticate against `@cdxgen`:
+
+```yaml
+      - name: Use Node.js
+        uses: actions/setup-node@...
+        with:
+          registry-url: https://registry.npmjs.org/
+          scope: '@cyclonedx'        # ← wrong namespace for v13
+```
+
+Two changes are needed, and the second is the one that silently breaks OIDC:
+
+1. `scope: '@cyclonedx'` → `'@cdxgen'`, or drop it.
+2. **Drop `registry-url` as well.** `setup-node` writes an `.npmrc` containing
+   `//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}` whenever
+   `registry-url` is set. npm prefers that token over the OIDC exchange, so the
+   publish either fails on an empty token or succeeds using a long-lived
+   secret — quietly defeating the point of trusted publishing.
+
+The job already has `id-token: write`, which is the other half of the
+requirement.
+
+Also confirm the npm CLI version: OIDC publishing needs **npm >= 11.5.1**, and
+the version bundled with a given Node release is often older. `npm install -g
+npm@latest` before publishing, or pin a known-good version.
+
+See `.github/workflows/publish.yml` here for the full shape.
+
+## Step 6 — after v13.0.0 is released
+
+Remove the placeholder tag so the package has no stray pointers:
+
+```bash
+npm dist-tag rm @cdxgen/cdxgen placeholder
+npm view @cdxgen/cdxgen dist-tags   # expect only: latest: 13.0.0
+```
+
+`0.0.1` stays published — npm unpublishing is restricted and the version is
+harmless once `latest` exists.
+
+## Verifying trusted publishing actually engaged
+
+A successful OIDC publish attaches a provenance attestation. After the first
+real release:
+
+```bash
+npm view @cdxgen/cdxgen dist.attestations
+```
+
+If that is empty, the publish used a token and the trusted-publisher path was
+never exercised, whatever the workflow logs suggest.

package/mod.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Name placeholder for cdxgen v13.
+ *
+ * @returns A message naming the package to install instead
+ */
+export declare function placeholderNotice(): string;
+export default placeholderNotice;

package/mod.js

@@ -0,0 +1,22 @@
+/**
+ * Name placeholder for cdxgen v13.
+ *
+ * This package exists so that the `@cdxgen/cdxgen` name is registered on npm
+ * and JSR, which is a precondition for configuring trusted publishing (OIDC)
+ * on either registry: a trusted publisher is attached to an existing package,
+ * so the package has to be created before the real release can use it.
+ *
+ * It deliberately ships no CLI. cdxgen's binary is called `cdxgen`, and a
+ * placeholder that installs an executable of that name would shadow the real
+ * tool for anyone who installed this by mistake.
+ *
+ * @returns {string} A message naming the package to install instead
+ */
+export function placeholderNotice() {
+  return (
+    "@cdxgen/cdxgen is a name placeholder. cdxgen v13 has not been released " +
+    "under this name yet — install @cyclonedx/cdxgen instead."
+  );
+}
+
+export default placeholderNotice;

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@cdxgen/cdxgen",
+  "version": "0.0.1",
+  "description": "Name placeholder for cdxgen v13. Install @cyclonedx/cdxgen until v13.0.0 is released.",
+  "license": "Apache-2.0",
+  "author": "Prabhu Subramanian <prabhu@appthreat.com>",
+  "homepage": "https://cdxgen.github.io/cdxgen/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/cdxgen/cdxgen.git"
+  },
+  "bugs": {
+    "url": "https://github.com/cdxgen/cdxgen/issues"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./mod.d.ts",
+      "default": "./mod.js"
+    }
+  },
+  "files": [
+    "mod.js",
+    "mod.d.ts",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "placeholder"
+  },
+  "keywords": [
+    "sbom",
+    "cyclonedx",
+    "cdxgen",
+    "placeholder"
+  ],
+  "types": "./mod.d.ts"
+}