@rivi-software/workers-bundle-check 0.1.0 → 0.1.1

package/dist/check.d.ts

@@ -27,45 +27,58 @@ export type WorkerBundleCheckOptions = {
 export type WorkerBundleProblem = ({
     /** A Worker file holds modules a rule forbids, largest first. */
     kind: "forbidden-module";
+    /** The rule the modules break. */
     rule: ForbiddenRule;
+    /** The Worker file that holds them. */
     file: string;
+    /** The modules the rule's pattern matches, and the bytes each renders in the file. */
     modules: BundledModule[];
 } | {
     /** A Worker file contains a forbidden marker. */
     kind: "forbidden-marker";
+    /** The rule whose marker the file contains. */
     rule: ForbiddenRule;
+    /** The Worker file that contains it. */
     file: string;
 } | {
     /** A rule's module pattern or marker matches nothing the project has. */
     kind: "stale-rule";
+    /** The rule that guards nothing. */
     rule: ForbiddenRule;
+    /** The part of it that matches nothing. */
     part: "module" | "marker";
 } | {
     /** A Worker file has no source map, so the rules cannot see its modules. */
     kind: "missing-source-map";
+    /** The Worker file without a map. */
     file: string;
 } | {
     /** A `.map` file the assets would serve. */
     kind: "served-source-map";
+    /** The map, in the assets directory. */
     file: string;
 } | {
     /** A script or style the assets would serve with its source map inline. */
     kind: "inline-source-map";
+    /** The script or style, in the assets directory. */
     file: string;
 } | {
     /** A value shaped like a secret, in a Worker file or a served asset. */
     kind: "secret";
+    /** The Worker file or served asset that holds the value. */
     file: string;
     /** The pattern's name. */
     name: string;
     /** The first 16 hexadecimal digits of the value's SHA-256; the value is never reported. */
     fingerprint: string;
+    /** The line the value is on, from 1. */
     line: number;
     /** The module the value comes from, when the file has a source map. */
     module?: string;
 } | {
     /** An allowed secret that matches no finding. */
     kind: "stale-allowed-secret";
+    /** The entry of `allowedSecrets` that matches nothing. */
     allowed: AllowedSecret;
 }) & {
     /** The problem in one line, for a report. */
@@ -87,6 +100,7 @@ export type WorkerBundleReport = {
     ignoredAssets: number;
     /** How many findings of secrets the allow-list let through. */
     allowedSecrets: number;
+    /** What the check found. {@link checkWorkerBundle} throws when it finds any. */
     problems: WorkerBundleProblem[];
 };
 /** Thrown by {@link checkWorkerBundle} when it finds problems: they are in `report.problems`. */

package/dist/forbidden.d.ts

@@ -24,7 +24,9 @@ export type WorkerFile = {
 };
 /** A module the Worker holds, and the bytes of code it renders there. */
 export type BundledModule = {
+    /** Its path relative to `cwd`, symlinks resolved, with `/` between segments. */
     path: string;
+    /** The bytes of generated code it renders in the file. */
     bytes: number;
 };
 /** A forbidden rule the Worker breaks, in one of its files. */

package/dist/secrets.d.ts

@@ -1,7 +1,9 @@
 import { type ModulePattern } from "./modules.js";
 /** The shape of a kind of secret, by the name reports give it. */
 export type SecretPattern = {
+    /** What reports call a value it matches: `Stripe secret key`. */
     name: string;
+    /** What the value looks like. It must not match an empty string. */
     pattern: RegExp;
 };
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivi-software/workers-bundle-check",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Fails CI on what a Cloudflare Worker's build should not contain: a forbidden module or marker in the Worker, a source map its static assets would serve, or a value shaped like a secret",
   "keywords": [
     "cloudflare",