@ronaldphilipsen/local-action 0.0.0-stage → 7.0.1

package/src/stubs/github/github.ts

@@ -0,0 +1,29 @@
+/**
+ * Last Reviewed Commit: 94de2cf6d446e4afd3d7b66408e7c513633dddaa
+ * Last Reviewed Date: 2026-01-16
+ *
+ * @remarks
+ *
+ * - The `context` export is removed and defined in `commands/run.ts`. This is
+ *   so that the context can be defined after the environment file is loaded.
+ */
+
+import type { OctokitOptions, OctokitPlugin } from '@octokit/core/types'
+import { GitHub, getOctokitOptions } from './utils.js'
+
+/**
+ * Returns a hydrated octokit ready to use for GitHub Actions
+ *
+ * @param token Repo PAT or GITHUB_TOKEN
+ * @param options Options to set
+ * @returns An octokit instance
+ */
+export function getOctokit(
+  token: string,
+  options?: OctokitOptions,
+  ...additionalPlugins: OctokitPlugin[]
+): InstanceType<typeof GitHub> {
+  const GitHubWithPlugins = GitHub.plugin(...additionalPlugins)
+
+  return new GitHubWithPlugins(getOctokitOptions(token, options))
+}

package/src/stubs/github/interfaces.ts

@@ -0,0 +1,52 @@
+/**
+ * Last Reviewed Commit: d4340966b7e9262da886a97ce8e959522e55c576
+ * Last Reviewed Date: 2026-01-16
+ */
+
+/**
+ * Repository Payload
+ */
+export interface PayloadRepository {
+  [key: string]: any
+  full_name?: string
+  name: string
+  owner: {
+    [key: string]: any
+    login: string
+    name?: string
+  }
+  html_url?: string
+}
+
+/**
+ * Webhook Payload
+ */
+export interface WebhookPayload {
+  [key: string]: any
+  repository?: PayloadRepository
+  issue?: {
+    [key: string]: any
+    number: number
+    html_url?: string
+    body?: string
+  }
+  pull_request?: {
+    [key: string]: any
+    number: number
+    html_url?: string
+    body?: string
+  }
+  sender?: {
+    [key: string]: any
+    type: string
+  }
+  action?: string
+  installation?: {
+    id: number
+    [key: string]: any
+  }
+  comment?: {
+    id: number
+    [key: string]: any
+  }
+}

package/src/stubs/github/internal/utils.ts

@@ -0,0 +1,83 @@
+/**
+ * Last Reviewed Commit: 494f12bcd955ba9c6f508bd25b3fe7524eb71e57
+ * Last Reviewed Date: 2026-01-16
+ */
+
+import * as httpClient from '@actions/http-client'
+import { type OctokitOptions } from '@octokit/core/types'
+import * as http from 'http'
+import { type ProxyAgent, fetch } from 'undici'
+
+/**
+ * Returns the auth string to use for the request.
+ *
+ * @param token Token
+ * @param options Options
+ * @returns Authentication string or undefined if no auth is provided
+ */
+export function getAuthString(
+  token: string,
+  options: OctokitOptions
+): string | undefined {
+  if (!token && !options.auth)
+    throw new Error('Parameter token or opts.auth is required')
+  else if (token && options.auth)
+    throw new Error('Parameters token and opts.auth may not both be specified')
+
+  return typeof options.auth === 'string' ? options.auth : `token ${token}`
+}
+
+/**
+ * Returns the proxy agent to use for the request.
+ *
+ * @param destinationUrl Destination URL
+ * @returns Proxy Agent
+ */
+export function getProxyAgent(destinationUrl: string): http.Agent {
+  const hc = new httpClient.HttpClient()
+
+  return hc.getAgent(destinationUrl)
+}
+
+/**
+ * Returns the proxy agent dispatcher to use for the request.
+ *
+ * @param destinationUrl Destination URL
+ * @returns Proxy agent or undefined if no proxy is provided
+ */
+export function getProxyAgentDispatcher(
+  destinationUrl: string
+): ProxyAgent | undefined {
+  const hc = new httpClient.HttpClient()
+
+  return hc.getAgentDispatcher(destinationUrl) as ProxyAgent | undefined
+}
+
+/**
+ * Returns the fetch function to use for the request.
+ *
+ * @param destinationUrl Destination URL
+ * @returns Fetch function
+ */
+/* istanbul ignore next */
+export function getProxyFetch(destinationUrl: string): typeof fetch {
+  const httpDispatcher = getProxyAgentDispatcher(destinationUrl)
+
+  const proxyFetch: typeof fetch = async (url, opts) => {
+    return fetch(url, {
+      ...opts,
+      dispatcher: httpDispatcher
+    })
+  }
+
+  return proxyFetch
+}
+
+/**
+ * Returns the base URL to use for the request.
+ *
+ * @returns Base URL
+ */
+export function getApiBaseUrl(): string {
+  return process.env.GITHUB_API_URL || 'https://api.github.com'
+}

package/src/stubs/github/utils.ts

@@ -0,0 +1,52 @@
+/**
+ * Last Reviewed Commit: 494f12bcd955ba9c6f508bd25b3fe7524eb71e57
+ * Last Reviewed Date: 2026-01-16
+ *
+ * @remarks
+ *
+ * - The `context` export is removed and defined in `commands/run.ts`. This is
+ *   so that the context can be defined after the environment file is loaded.
+ */
+
+import { Octokit } from '@octokit/core'
+import type { OctokitOptions } from '@octokit/core/types'
+import { paginateRest } from '@octokit/plugin-paginate-rest'
+import { restEndpointMethods } from '@octokit/plugin-rest-endpoint-methods'
+import * as Utils from './internal/utils.js'
+
+const baseUrl = Utils.getApiBaseUrl()
+
+export const defaults: OctokitOptions = {
+  baseUrl,
+  request: {
+    agent: Utils.getProxyAgent(baseUrl),
+    fetch: Utils.getProxyFetch(baseUrl)
+  }
+}
+
+export const GitHub = Octokit.plugin(
+  restEndpointMethods,
+  paginateRest
+).defaults(defaults)
+
+/**
+ * Convenience function to correctly format Octokit Options to pass into the
+ * constructor.
+ *
+ * @param token Repo PAT or GITHUB_TOKEN
+ * @param options Options to set
+ * @returns Octokit Options
+ */
+export function getOctokitOptions(
+  token: string,
+  options?: OctokitOptions
+): OctokitOptions {
+  // Shallow clone - don't mutate the object provided by the caller
+  const opts = Object.assign({}, options || {})
+
+  const auth = Utils.getAuthString(token, opts)
+  /* istanbul ignore next */
+  if (auth) opts.auth = auth
+
+  return opts
+}

package/src/types/quibble.d.ts

@@ -0,0 +1,5 @@
+declare module 'quibble' {
+  const quibble: any
+  export default quibble
+  export const esm: any
+}

package/src/types.ts

@@ -0,0 +1,116 @@
+import type { Artifact } from './stubs/artifact/internal/shared/interfaces.js'
+
+/** Environment Metadata */
+export type EnvMetadata = {
+  /** Path to `action.yml` */
+  actionFile: string
+  /** Path to Action Directory */
+  actionPath: string
+  /** List of Action Artifacts */
+  artifacts: Artifact[]
+  /** Map of Cache IDs and Cache Names */
+  caches: { [key: number]: string }
+  /** Path to `.env` */
+  dotenvFile: string
+  /** Environment Variables */
+  env: {
+    [key: string]: string | undefined
+    TZ?: string | undefined
+  }
+  /** System Path */
+  path: string
+  /** Inputs in `action.yml` */
+  inputs: { [key: string]: Input }
+  /** Outputs in `action.yml` */
+  outputs: { [key: string]: Output }
+  /** Pre-Transpilation Action `main` Entrypoint (e.g. `src/main.ts`) */
+  entrypoint: string
+  /** Pre-Transpilation Action `pre` Entrypoint (e.g. `pre/main.ts`) */
+  preEntrypoint: string | undefined
+  /** Pre-Transpilation Action `post` Entrypoint (e.g. `post/main.ts`) */
+  postEntrypoint: string | undefined
+}
+
+/** Metadata for `@actions/core` */
+export type CoreMetadata = {
+  /** Command Echo Setting */
+  echo: boolean
+  /** Exit Code (0 = success, 1 = failure) */
+  exitCode: 0 | 1
+  /** Exit Message (success = empty) */
+  exitMessage: string
+  /** Action Outputs */
+  outputs: { [key: string]: string }
+  /** Registered Secrets */
+  secrets: string[]
+  /** Actions Step Debug Enabled */
+  stepDebug: boolean
+  /** Action State */
+  state: { [key: string]: string }
+  /**
+   * Output Colors
+   *
+   * This is not part of `@actions/core` but is included here for convenience
+   * when calling related functions.
+   */
+  colors: {
+    [key: string]: (message: string) => void
+  }
+  /**
+   * Step Summary Output File Path
+   *
+   * This is not part of `@actions/core` but is included here for convenience
+   * when calling related functions.
+   */
+  stepSummaryPath: string
+}
+
+/** Action Properties */
+export type Action = {
+  /** Name */
+  name: string
+  /** Author */
+  author?: string
+  /** Description */
+  description: string
+  /** Inputs */
+  inputs: Record<string, Input>
+  /** Outputs */
+  outputs: Record<string, Output>
+  /** Entrypoint Configuration */
+  runs: Runs
+}
+
+/** Input Properties */
+export type Input = {
+  /** Description */
+  description: string
+  /** Required */
+  required?: boolean
+  /** Default ValuE */
+  default?: string
+  /** Deprecation Message */
+  deprecationMessage?: string
+}
+
+/** Output Properties */
+export type Output = {
+  /** Description of the output */
+  description: string
+}
+
+/** Entrypoint Properties */
+export type Runs = {
+  /** Type of Entrypoint */
+  using: string
+  /** Entrypoint Script */
+  main: string
+  /** Pre Script */
+  pre?: string
+  /** Pre Script Conditions */
+  'pre-if'?: () => boolean
+  /** Post Script */
+  post?: string
+  /** Post Script Conditions */
+  'post-if'?: () => boolean
+}

package/src/utils/config.ts

@@ -0,0 +1,47 @@
+import path from 'path'
+import { EnvMeta } from '../stubs/env.js'
+
+/**
+ * Get OS Action Entrypoints
+ *
+ * The entrypoint is OS-specific. On Windows, it has to start with a leading
+ * slash, then the drive letter, followed by the rest of the path. In both
+ * cases, the path separators are converted to forward slashes.
+ *
+ * On Windows, the entrypoint requires a leading slash if the action is ESM.
+ * Otherwise, it can be omitted.
+ *
+ * @param actionType Action Type (esm | cjs)
+ * @returns Object with main, pre, and post entrypoints
+ */
+export function getOSEntrypoints(actionType: 'esm' | 'cjs'): {
+  main: string
+  pre: string | undefined
+  post: string | undefined
+} {
+  return {
+    main:
+      process.platform !== 'win32'
+        ? path.resolve(EnvMeta.entrypoint)
+        : /* istanbul ignore next */
+          actionType === 'esm'
+          ? '/' + path.resolve(EnvMeta.entrypoint)
+          : path.resolve(EnvMeta.entrypoint.replaceAll(path.sep, '/')),
+    pre: EnvMeta.preEntrypoint
+      ? process.platform !== 'win32'
+        ? path.resolve(EnvMeta.preEntrypoint)
+        : /* istanbul ignore next */
+          actionType === 'esm'
+          ? '/' + path.resolve(EnvMeta.preEntrypoint)
+          : path.resolve(EnvMeta.preEntrypoint.replaceAll(path.sep, '/'))
+      : undefined,
+    post: EnvMeta.postEntrypoint
+      ? process.platform !== 'win32'
+        ? path.resolve(EnvMeta.postEntrypoint)
+        : /* istanbul ignore next */
+          actionType === 'esm'
+          ? '/' + path.resolve(EnvMeta.postEntrypoint)
+          : path.resolve(EnvMeta.postEntrypoint.replaceAll(path.sep, '/'))
+      : undefined
+  }
+}

package/src/utils/output.ts

@@ -0,0 +1,20 @@
+/** Default print width for titles */
+export const printWidth: number = 80
+
+/**
+ * Prints a title with a specific color
+ *
+ * @param color The color function to use
+ * @param title The title text to print
+ * @returns void
+ */
+export function printTitle(
+  color: (message: string) => void,
+  title: string
+): void {
+  const spaces: string = ' '.repeat((80 - title.length) / 2)
+
+  color('='.repeat(printWidth))
+  color(`${spaces}${title}`)
+  color('='.repeat(printWidth))
+}

package/src/utils/package.ts

@@ -0,0 +1,38 @@
+import fs from 'fs'
+import * as path from 'path'
+import { EnvMeta } from '../stubs/env.js'
+
+/**
+ * Checks if the JavaScript/TypeScript project is an ESM module.
+ *
+ * @returns True if the project is an ESM module, false otherwise.
+ */
+export function isESM(): boolean {
+  // Starting at this directory, walk up the directory tree until we find a
+  // package.json file.
+  const dirs = path.dirname(EnvMeta.entrypoint).split(path.sep)
+
+  while (dirs.length > 0) {
+    // Check if the current directory has a package.json.
+    /* istanbul ignore next */
+    if (fs.existsSync(path.resolve(dirs.join(path.sep), 'package.json'))) {
+      const packageJson = JSON.parse(
+        fs.readFileSync(
+          path.resolve(dirs.join(path.sep), 'package.json'),
+          'utf8'
+        )
+      ) as { [key: string]: unknown }
+
+      return packageJson.type === 'module'
+    }
+
+    // Move up the directory tree.
+    /* istanbul ignore next */
+    dirs.pop()
+  }
+
+  // If we reach the root directory and still haven't found a package.json
+  // file, assume that the project is not an ESM module.
+  /* istanbul ignore next */
+  return false
+}

package/tsconfig.base.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "compilerOptions": {
+    "allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+    "declaration": true,
+    "declarationMap": false,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "lib": ["ES2022"],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "newLine": "lf",
+    "noEmit": true,
+    "noImplicitAny": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": false,
+    "paths": {},
+    "pretty": true,
+    "resolveJsonModule": true,
+    "rootDir": ".",
+    "sourceMap": true,
+    "strict": true,
+    "strictNullChecks": true,
+    "target": "ES2022"
+  }
+}

package/tsconfig.eslint.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true
+  },
+  "include": [
+    "__fixtures__/stream/",
+    "__fixtures__/@actions/",
+    "__fixtures__/@octokit/",
+    "__fixtures__/crypto.ts",
+    "__fixtures__/fs.ts",
+    "__fixtures__/path.ts",
+    "__fixtures__/tsconfig-paths.ts",
+    "__tests__",
+    "src",
+    "types",
+    "eslint.config.mjs",
+    "jest.config.ts"
+  ],
+  "exclude": ["node_modules", "coverage"]
+}

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "target": "ES2022"
+  },
+  "include": ["src", "types"],
+  "exclude": [
+    "__fixtures__/core.ts",
+    "__fixtures__/tsconfig-paths.ts",
+    "__tests__",
+    "coverage",
+    "node_modules"
+  ]
+}