@tahminator/pipeline 1.0.8 → 1.0.10

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./gh";
 export * from "./docker";
+export * from "./npm";
 export * from "./types";
 export * from "./utils";

package/dist/index.js

@@ -1,4 +1,5 @@
 export * from "./gh";
 export * from "./docker";
+export * from "./npm";
 export * from "./types";
 export * from "./utils";

package/dist/internal/create-tag/index.js

@@ -1,7 +1,7 @@
 import { GitHubClient } from "../../gh";
-import { getEnvVariables } from "../../utils/env";
+import { Utils } from "../../utils";
 async function main() {
-    const { githubPat } = parseCiEnv(await getEnvVariables(["ci"]));
+    const { githubPat } = parseCiEnv(await Utils.getEnvVariables(["ci"]));
     const ghClient = new GitHubClient(githubPat);
     await ghClient.createTag({
         onPreTagCreate: async (tag) => {

package/dist/internal/upload-npm/index.js

@@ -1,20 +1,16 @@
-import { $ } from "bun";
-import { getEnvVariables } from "../../utils/env";
+import yargs from "yargs";
+import { hideBin } from "yargs/helpers";
+import { NPMClient } from "../../npm";
+const { dryRun } = await yargs(hideBin(process.argv))
+    .option("dryRun", {
+    type: "boolean",
+    default: false,
+})
+    .strict()
+    .parse();
 async function main() {
-    const { npmToken } = parseCiEnv(await getEnvVariables(["ci"]));
-    await $ `npm config set //registry.npmjs.org/:_authToken=${npmToken}`;
-    await $ `npm publish --access public`;
-    console.log("Package has been successfully published");
-}
-function parseCiEnv(ciEnv) {
-    const npmToken = (() => {
-        const v = ciEnv["NPM_TOKEN"];
-        if (!v) {
-            throw new Error("Missing NPM_TOKEN from .env.ci");
-        }
-        return v;
-    })();
-    return { npmToken };
+    await using npmClient = await NPMClient.create();
+    await npmClient.publish(dryRun);
 }
 main()
     .then(() => {

package/dist/npm/client.d.ts

@@ -0,0 +1,24 @@
+export declare class NPMClient {
+    private constructor();
+    /**
+     * __You must use [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) now.__ Using tokens
+     * now are extremely flaky and should be avoided.
+     *
+     * __NOTE: Base yaml must have this property__
+     *
+     * @example
+     * ```yaml
+     *  permissions:
+     *    id-token: write  # Required for OIDC
+     * ```
+     */
+    static create(): Promise<NPMClient>;
+    /**
+     * @note You must ensure that the current root directory `package.json`
+     * is filled out with the name of the package and the version you would like to
+     * deploy.
+     */
+    publish(dryRun?: boolean): Promise<void>;
+    [Symbol.asyncDispose](): Promise<void>;
+    cleanup(): Promise<void>;
+}

package/dist/npm/client.js

@@ -0,0 +1,43 @@
+import { $ } from "bun";
+import { Utils } from "../utils";
+export class NPMClient {
+    constructor() { }
+    /**
+     * __You must use [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) now.__ Using tokens
+     * now are extremely flaky and should be avoided.
+     *
+     * __NOTE: Base yaml must have this property__
+     *
+     * @example
+     * ```yaml
+     *  permissions:
+     *    id-token: write  # Required for OIDC
+     * ```
+     */
+    static async create() {
+        // await $`npm config set //registry.npmjs.org/:_authToken=${npmToken}`;
+        return new this();
+    }
+    /**
+     * @note You must ensure that the current root directory `package.json`
+     * is filled out with the name of the package and the version you would like to
+     * deploy.
+     */
+    async publish(dryRun) {
+        const dryRunFlag = dryRun ? ["--dry-run"] : [];
+        if (Utils.Log.isDebug) {
+            console.log(await $ `ls .`.text());
+            console.log(await $ `ls ./dist/`.text());
+            console.log(await $ `pwd`.text());
+            console.log(await $ `cat ./package.json`.text());
+        }
+        await $ `npm publish --access public --provenance ${dryRunFlag} ./`;
+        console.log("Package has been successfully published");
+    }
+    async [Symbol.asyncDispose]() {
+        await this.cleanup();
+    }
+    async cleanup() {
+        await $ `npm logout`;
+    }
+}

package/dist/npm/index.d.ts

@@ -0,0 +1 @@
+export * from "./client";

package/dist/npm/index.js

@@ -0,0 +1 @@
+export * from "./client";

package/dist/utils/client.d.ts

@@ -1,8 +1,10 @@
 import { Colors } from "./colors";
 import { getEnvVariables } from "./env";
+import { Log } from "./log";
 import { generateShortId } from "./short";
 export declare class Utils {
     static Colors: typeof Colors;
+    static Log: typeof Log;
     static getEnvVariables(...args: Parameters<typeof getEnvVariables>): Promise<Record<string, string>>;
     static generateShortId(...args: Parameters<typeof generateShortId>): string;
     static updateAllPackageJsonsWithVersion(version: string): Promise<void>;

package/dist/utils/client.js

@@ -1,10 +1,12 @@
 import { $ } from "bun";
 import { Colors } from "./colors";
 import { getEnvVariables } from "./env";
+import { Log } from "./log";
 import { generateShortId } from "./short";
 export class Utils {
     // hoist
     static Colors = Colors;
+    static Log = Log;
     static getEnvVariables(...args) {
         return getEnvVariables(...args);
     }

package/dist/utils/log.d.ts

@@ -0,0 +1,3 @@
+export declare class Log {
+    static get isDebug(): boolean;
+}

package/dist/utils/log.js

@@ -0,0 +1,6 @@
+export class Log {
+    // automatically injected from setup action in CI
+    static get isDebug() {
+        return process.env.DEBUG === "true";
+    }
+}

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@tahminator/pipeline",
   "type": "module",
-  "version": "1.0.8",
+  "author": "Tahmid Ahmed",
+  "description": "A collection of Bun shell scripts that can be re-used in various CICD pipelines.",
+  "version": "1.0.10",
+  "repository": {
+    "url": "https://github.com/tahminator/pipeline"
+  },
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -24,8 +29,7 @@
     "prettier": "prettier --check .",
     "prettier:fix": "prettier --write .",
     "vt": "vitest run",
-    "build": "tsc -p tsconfig.build.json",
-    "prepublishOnly": "bun run build"
+    "build": "tsc -p tsconfig.build.json"
   },
   "devDependencies": {
     "@eslint/js": "^10.0.1",
@@ -44,8 +48,10 @@
   "dependencies": {
     "@octokit/rest": "^22.0.1",
     "@types/semver": "^7.7.1",
+    "@types/yargs": "^17.0.35",
     "semver": "^7.7.4",
     "yaml": "^2.8.2",
+    "yargs": "^18.0.0",
     "zod": "^4.3.6"
   }
 }