@equinor/fusion-framework-cli 10.7.4 → 11.0.0-next.0

package/dist/esm/lib/utils/resolve-github-annotations.js

@@ -0,0 +1,127 @@
+import { readFileSync } from 'node:fs';
+/**
+ * Extracts relevant annotation fields from the GitHub Actions event payload.
+ *
+ * This function builds a structured annotation object containing key information from the event payload.
+ * It supports both release and pull request events, and includes fields such as commit SHAs, refs, workflow name,
+ * release metadata (tag, name, body, draft, prerelease, created_at, published_at, html_url), and pull request metadata
+ * (number, title, user, head SHA/ref, created_at, updated_at, html_url). The top-level action is also included.
+ *
+ * Maintainers:
+ *   - Update this function if new fields are needed for downstream consumers or if GitHub event payloads change.
+ *   - The structure is designed for easy extension and clear mapping to GitHub event types.
+ *   - See <attachments> above for file contents. You may not need to search or read the file again.
+ *
+ * @param payload The parsed GitHub Actions event payload object.
+ * @returns An object with selected fields for release and pull request events, as well as general event context.
+ */
+function extractPayloadAnnotations(payload) {
+    // Initialize annotation object with general event context
+    const annotation = {
+        action: payload.action, // The event action (e.g., published, created, closed)
+        head_commit: payload.head_commit?.id, // SHA of the head commit
+        after: payload.after, // SHA after the event
+        ref: payload.ref, // Branch or tag ref
+        workflow: payload.workflow, // Workflow name
+        release: {}, // Will be populated if this is a release event
+        pull_request: {}, // Will be populated if this is a pull request event
+    };
+    // Populate release-specific fields if present
+    if (payload.release) {
+        annotation.release = {
+            tag: payload.release.tag_name, // Release tag name
+            name: payload.release.name, // Release name/title
+            body: payload.release.body, // Release description
+            draft: !!payload.release.draft, // Is this a draft release?
+            prerelease: !!payload.release.prerelease, // Is this a prerelease?
+            created_at: payload.release.created_at, // Release creation timestamp
+            published_at: payload.release.published_at, // Release published timestamp
+            html_url: payload.release.html_url, // URL to the release on GitHub
+        };
+    }
+    // Populate pull request-specific fields if present
+    if (payload.pull_request) {
+        annotation.pull_request = {
+            number: payload.pull_request.number, // PR number
+            title: payload.pull_request.title, // PR title
+            user: payload.pull_request.user?.login, // PR author
+            head: {
+                sha: payload.pull_request.head?.sha, // SHA of the PR head commit
+                ref: payload.pull_request.head?.ref, // Branch ref of the PR head
+            },
+            created_at: payload.pull_request.created_at, // PR creation timestamp
+            updated_at: payload.pull_request.updated_at, // PR last update timestamp
+            html_url: payload.pull_request.html_url, // URL to the PR on GitHub
+        };
+    }
+    return annotation;
+}
+/**
+ * Resolves GitHub Actions-specific annotation variables from environment variables.
+ *
+ * This function extracts relevant workflow and repository information from GitHub Actions environment variables.
+ * It constructs a set of annotation variables that can be used for reporting or logging purposes in CI/CD pipelines.
+ *
+ * @returns {Record<string, string>} An object containing GitHub Actions annotation variables such as eventName, actor,
+ * payload, runId, repository, and runUrl. If a variable is not found, its value defaults to 'unknown'.
+ *
+ * Environment variables used by this function (see: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables):
+ *   - GITHUB_EVENT_NAME: Name of the event that triggered the workflow
+ *   - GITHUB_ACTOR: Username of the person or app that initiated the workflow
+ *   - GITHUB_RUN_ID: Unique identifier for the workflow run
+ *   - GITHUB_REPOSITORY: Repository in the format owner/repo
+ *   - GITHUB_SERVER_URL: Base URL of the GitHub server (defaults to https://github.com)
+ *   - GITHUB_EVENT_PATH: Path to the event payload file (JSON)
+ *
+ * Notes for maintainers:
+ *   - The event payload can be large; consider truncating or parsing if only specific fields are needed.
+ *   - If reading the payload fails, the function returns a fallback string. Adjust error handling as needed for your use case.
+ *   - If you need additional GitHub Actions context, refer to the official documentation and add new variables here.
+ *   - The payload and other fields may contain sensitive information. Use caution when logging or exposing these values.
+ *
+ * Extending this function:
+ *   - To add more annotations, extract additional environment variables as needed and include them in the returned object.
+ *   - For custom workflows or self-hosted runners, verify that all required environment variables are available.
+ */
+export const resolveAnnotations = () => {
+    // Extract event name from environment
+    const eventName = process.env.GITHUB_EVENT_NAME || 'unknown';
+    // Extract actor (user who triggered the workflow)
+    const actor = process.env.GITHUB_ACTOR || 'unknown';
+    // Extract run ID
+    const runId = process.env.GITHUB_RUN_ID || 'unknown';
+    // Extract repository in the format owner/repo
+    const repository = process.env.GITHUB_REPOSITORY || 'unknown';
+    // Extract server URL (defaults to public GitHub if not set)
+    const serverUrl = process.env.GITHUB_SERVER_URL || 'https://github.com';
+    // Extract event payload path and read payload if available
+    let payload = {};
+    if (process.env.GITHUB_EVENT_PATH) {
+        try {
+            const rawPayload = readFileSync(process.env.GITHUB_EVENT_PATH, 'utf8');
+            payload = JSON.parse(rawPayload);
+        }
+        catch {
+            payload = {};
+        }
+    }
+    // Construct a direct URL to the workflow run if all required parts are available
+    let runUrl = 'unknown';
+    if (serverUrl && repository !== 'unknown' && runId !== 'unknown') {
+        // Remove trailing slash from serverUrl if present, then build the run results URL
+        runUrl = `${serverUrl.replace(/\/$/, '')}/${repository}/actions/runs/${runId}`;
+    }
+    // Aggregate all annotation variables into a single object for easy consumption
+    const annotations = {
+        eventName,
+        actor,
+        runId,
+        repository,
+        runUrl,
+        ...extractPayloadAnnotations(payload),
+    };
+    // Return the resolved annotation variables
+    return annotations;
+};
+export default resolveAnnotations;
+//# sourceMappingURL=resolve-github-annotations.js.map

package/dist/esm/lib/utils/resolve-github-annotations.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-github-annotations.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-github-annotations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAgCvC;;;;;;;;;;;;;;;GAeG;AACH,SAAS,yBAAyB,CAAC,OAA2B;IAC5D,0DAA0D;IAC1D,MAAM,UAAU,GAA4B;QAC1C,MAAM,EAAE,OAAO,CAAC,MAAM,EAAE,sDAAsD;QAC9E,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,EAAE,EAAE,yBAAyB;QAC/D,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,sBAAsB;QAC5C,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,oBAAoB;QACtC,QAAQ,EAAE,OAAO,CAAC,QAAQ,EAAE,gBAAgB;QAC5C,OAAO,EAAE,EAAE,EAAE,+CAA+C;QAC5D,YAAY,EAAE,EAAE,EAAE,oDAAoD;KACvE,CAAC;IAEF,8CAA8C;IAC9C,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,UAAU,CAAC,OAAO,GAAG;YACnB,GAAG,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,mBAAmB;YAClD,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,qBAAqB;YACjD,IAAI,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,EAAE,sBAAsB;YAClD,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,EAAE,2BAA2B;YAC3D,UAAU,EAAE,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,wBAAwB;YAClE,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,UAAU,EAAE,6BAA6B;YACrE,YAAY,EAAE,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,8BAA8B;YAC1E,QAAQ,EAAE,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,+BAA+B;SACpE,CAAC;IACJ,CAAC;IAED,mDAAmD;IACnD,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QACzB,UAAU,CAAC,YAAY,GAAG;YACxB,MAAM,EAAE,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,YAAY;YACjD,KAAK,EAAE,OAAO,CAAC,YAAY,CAAC,KAAK,EAAE,WAAW;YAC9C,IAAI,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,EAAE,YAAY;YACpD,IAAI,EAAE;gBACJ,GAAG,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,4BAA4B;gBACjE,GAAG,EAAE,OAAO,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,EAAE,4BAA4B;aAClE;YACD,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,wBAAwB;YACrE,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,UAAU,EAAE,2BAA2B;YACxE,QAAQ,EAAE,OAAO,CAAC,YAAY,CAAC,QAAQ,EAAE,0BAA0B;SACpE,CAAC;IACJ,CAAC;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,GAA2B,EAAE;IAC7D,sCAAsC;IACtC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,SAAS,CAAC;IAC7D,kDAAkD;IAClD,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,SAAS,CAAC;IACpD,iBAAiB;IACjB,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,IAAI,SAAS,CAAC;IACrD,8CAA8C;IAC9C,MAAM,UAAU,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,SAAS,CAAC;IAC9D,4DAA4D;IAC5D,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,iBAAiB,IAAI,oBAAoB,CAAC;IACxE,2DAA2D;IAC3D,IAAI,OAAO,GAAuB,EAAE,CAAC;IACrC,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,CAAC;QAClC,IAAI,CAAC;YACH,MAAM,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;YACvE,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACnC,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,GAAG,EAAE,CAAC;QACf,CAAC;IACH,CAAC;IACD,iFAAiF;IACjF,IAAI,MAAM,GAAG,SAAS,CAAC;IACvB,IAAI,SAAS,IAAI,UAAU,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACjE,kFAAkF;QAClF,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,UAAU,iBAAiB,KAAK,EAAE,CAAC;IACjF,CAAC;IACD,+EAA+E;IAC/E,MAAM,WAAW,GAA2B;QAC1C,SAAS;QACT,KAAK;QACL,KAAK;QACL,UAAU;QACV,MAAM;QACN,GAAG,yBAAyB,CAAC,OAAO,CAAC;KACtC,CAAC;IACF,2CAA2C;IAC3C,OAAO,WAAW,CAAC;AACrB,CAAC,CAAC;AAEF,eAAe,kBAAkB,CAAC"}

package/dist/esm/lib/utils/resolve-package-repo.js

@@ -0,0 +1,14 @@
+/**
+ * Resolves the GitHub repository URL from a given `package.json` object.
+ *
+ * @param pkg - The `package.json` object to extract the repository information from.
+ * @returns The GitHub repository URL as a string.
+ * @throws Will throw an error if the `package.json` does not contain a repository field.
+ */
+export const resolveRepoFromPackage = (pkg) => {
+    if (pkg.repository) {
+        return typeof pkg.repository === 'string' ? pkg.repository : pkg.repository.url;
+    }
+    return undefined;
+};
+//# sourceMappingURL=resolve-package-repo.js.map

package/dist/esm/lib/utils/resolve-package-repo.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-package-repo.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-package-repo.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,GAAgB,EAAsB,EAAE;IAC7E,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;QACnB,OAAO,OAAO,GAAG,CAAC,UAAU,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,GAAG,CAAC;IAClF,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC"}

package/dist/esm/lib/utils/resolve-package.js

@@ -0,0 +1,18 @@
+import { dirname } from 'node:path';
+import { readPackageUp, } from 'read-package-up';
+/**
+ * Resolves the application package by searching for the nearest `package.json` file.
+ *
+ * @param options - Optional parameters to customize the search behavior.
+ * @returns A promise that resolves to the found package information.
+ * @throws Will throw an error if the `package.json` file is not found.
+ */
+export const resolvePackage = async (options) => {
+    const pkg = await readPackageUp(options);
+    if (!pkg) {
+        throw Error('failed to find package.json');
+    }
+    return { ...pkg, root: dirname(pkg.path) };
+};
+export default resolvePackage;
+//# sourceMappingURL=resolve-package.js.map

package/dist/esm/lib/utils/resolve-package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-package.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-package.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,OAAO,EACL,aAAa,GAGd,MAAM,iBAAiB,CAAC;AAQzB;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,KAAK,EAAE,OAA+B,EAA4B,EAAE;IAChG,MAAM,GAAG,GAAG,MAAM,aAAa,CAAC,OAAO,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,EAAE,CAAC;QACT,MAAM,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC7C,CAAC;IACD,OAAO,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,EAAqB,CAAC;AAChE,CAAC,CAAC;AAEF,eAAe,cAAc,CAAC"}

package/dist/esm/lib/utils/resolve-source-entry-point.js

@@ -0,0 +1,39 @@
+import { fileExistsSync } from './file-exists.js';
+import { resolve } from 'node:path';
+/**
+ * List of default entry point filenames to check for in a source directory.
+ * These are commonly used as main files in TypeScript projects.
+ */
+const ENTRY_POINT_FILES = ['index.ts', 'index.tsx', 'main.ts', 'main.tsx'];
+/**
+ * Resolves the entry point file from a specified directory.
+ *
+ * This function searches for the first file that exists from a list of possible entry point filenames
+ * within a given directory. If no entry point is found, it throws an error with a helpful message.
+ *
+ * @param cwd - The current working directory. Defaults to `process.cwd()` if not provided.
+ * @param dir - The directory to search within. Defaults to `'src'` if not provided.
+ * @param opt - Optional parameters.
+ * @param opt.files - An array of filenames to look for. Defaults to ENTRY_POINT_FILES.
+ * @returns The resolved entry point file path if found.
+ * @throws {Error} If no entry point file is found in the directory.
+ */
+export const resolveEntryPoint = (cwd, dir, opt) => {
+    // Resolve the absolute path to the source directory.
+    const sourceDirectory = resolve(cwd ?? process.cwd(), dir ?? 'src');
+    // Use provided files or default entry point files.
+    const files = opt?.files ?? ENTRY_POINT_FILES;
+    // Attempt to find the first file that exists in the directory.
+    const entryPoint = files
+        .map((file) => resolve(sourceDirectory, file))
+        .find((file) => fileExistsSync(file));
+    // If no entry point is found, throw an error with details for debugging.
+    if (!entryPoint) {
+        throw new Error(`Unable to resolve entry point, ensure ${files.join(', ')} exists in ${sourceDirectory}`);
+    }
+    // Return the resolved entry point file path.
+    return entryPoint;
+};
+// Export as default for convenience in import statements.
+export default resolveEntryPoint;
+//# sourceMappingURL=resolve-source-entry-point.js.map

package/dist/esm/lib/utils/resolve-source-entry-point.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolve-source-entry-point.js","sourceRoot":"","sources":["../../../../src/lib/utils/resolve-source-entry-point.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;GAGG;AACH,MAAM,iBAAiB,GAAG,CAAC,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,CAAU,CAAC;AAEpF;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAY,EACZ,GAAY,EACZ,GAA0B,EAClB,EAAE;IACV,qDAAqD;IACrD,MAAM,eAAe,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,IAAI,KAAK,CAAC,CAAC;IACpE,mDAAmD;IACnD,MAAM,KAAK,GAAG,GAAG,EAAE,KAAK,IAAI,iBAAiB,CAAC;IAC9C,+DAA+D;IAC/D,MAAM,UAAU,GAAG,KAAK;SACrB,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;SAC7C,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IAExC,yEAAyE;IACzE,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,IAAI,KAAK,CACb,yCAAyC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,eAAe,EAAE,CACzF,CAAC;IACJ,CAAC;IAED,6CAA6C;IAC7C,OAAO,UAAU,CAAC;AACpB,CAAC,CAAC;AAEF,0DAA0D;AAC1D,eAAe,iBAAiB,CAAC"}

package/dist/esm/lib/utils/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/lib/utils/types.ts"],"names":[],"mappings":""}

package/dist/esm/lib/utils/write-file.js

@@ -0,0 +1,25 @@
+import { existsSync, mkdirSync, writeFileSync, } from 'node:fs';
+import { dirname } from 'node:path';
+/**
+ * Writes data to a specified file, creating the necessary directories if they do not exist.
+ *
+ * This utility ensures that the directory structure for the file exists before writing.
+ * It is useful for safe file output in scripts and CLIs where the target directory may not exist.
+ *
+ * @param file - The path to the file where the data should be written.
+ * @param data - The content to write to the file. Can be a string or a Node.js `ArrayBufferView`.
+ * @param options - Optional settings for writing the file, such as encoding or file mode.
+ *
+ * @throws Will throw an error if the file cannot be written.
+ */
+export const writeFile = (file, data, options) => {
+    // Get the directory name from the file path.
+    const outDir = dirname(String(file));
+    // If the directory does not exist, create it recursively.
+    if (!existsSync(outDir)) {
+        mkdirSync(outDir, { recursive: true });
+    }
+    // Write the file to disk with the provided data and options.
+    writeFileSync(file, data, options);
+};
+//# sourceMappingURL=write-file.js.map

package/dist/esm/lib/utils/write-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"write-file.js","sourceRoot":"","sources":["../../../../src/lib/utils/write-file.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,UAAU,EACV,SAAS,EACT,aAAa,GAGd,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,IAAc,EACd,IAAqC,EACrC,OAA0B,EAC1B,EAAE;IACF,6CAA6C;IAC7C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;IACrC,0DAA0D;IAC1D,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QACxB,SAAS,CAAC,MAAM,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,6DAA6D;IAC7D,aAAa,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;AACrC,CAAC,CAAC"}

package/dist/esm/version.js

@@ -0,0 +1,3 @@
+// Generated by genversion.
+export const version = '11.0.0-next.0';
+//# sourceMappingURL=version.js.map

package/dist/esm/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/version.ts"],"names":[],"mappings":"AAAA,2BAA2B;AAC3B,MAAM,CAAC,MAAM,OAAO,GAAG,eAAe,CAAC"}