@equinor/fusion-framework-cli 11.0.0-next.8 → 11.0.0

package/dist/types/bin/helpers/resolve-app-config.d.ts

@@ -1,6 +1,6 @@
-import type { RuntimeEnv } from '../../lib';
-import type { ConsoleLogger } from '../utils';
-import { type ApiAppConfig } from '../../lib/app';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import { type ApiAppConfig } from '@equinor/fusion-framework-cli/app';
+import type { ConsoleLogger } from '../utils/ConsoleLogger.js';
 /**
  * Resolves the application configuration based on the provided runtime environment and options.
  * Handles logging, error reporting, and fallback to built-in config if no local config is found.

package/dist/types/bin/helpers/resolve-app-manifest.d.ts

@@ -1,5 +1,5 @@
-import type { RuntimeEnv, ResolvedPackage } from '../../lib';
-import type { ConsoleLogger } from '../utils';
+import type { RuntimeEnv, ResolvedPackage } from '@equinor/fusion-framework-cli/lib';
+import type { ConsoleLogger } from '../utils/index.js';
 /**
  * Resolves the application manifest for a given package and environment.
  * Attempts to load a manifest file if specified, otherwise falls back to generating a manifest from package.json.
@@ -14,4 +14,4 @@ import type { ConsoleLogger } from '../utils';
 export declare const resolveAppManifest: (env: RuntimeEnv, pkg: ResolvedPackage, options?: {
     log?: ConsoleLogger | null;
     manifestPath?: string;
-}) => Promise<import("@equinor/fusion-framework-module-app").AppManifest>;
+}) => Promise<import("@equinor/fusion-framework-cli/app").AppManifest>;

package/dist/types/bin/helpers/resolve-portal-config.d.ts

@@ -1,6 +1,6 @@
-import type { RuntimeEnv } from '../../lib';
-import type { ConsoleLogger } from '../utils';
-import { type PortalConfig } from '../../lib/portal';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import { type PortalConfig } from '@equinor/fusion-framework-cli/portal';
+import type { ConsoleLogger } from '../utils/index.js';
 /**
  * Resolves the portal configuration based on the provided runtime environment and options.
  * Handles logging, error reporting, and fallback to built-in config if no local config is found.

package/dist/types/bin/helpers/resolve-portal-manifest.d.ts

@@ -1,7 +1,6 @@
-import type { RuntimeEnv } from '../../lib';
-import type { ConsoleLogger } from '../utils';
-import type { ResolvedPackage } from '../../lib/utils/resolve-package.js';
-import { type PortalManifest } from '../../lib/portal';
+import type { ResolvedPackage, RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import { type PortalManifest } from '@equinor/fusion-framework-cli/portal';
+import type { ConsoleLogger } from '../utils/index.js';
 /**
  * Resolves the portal manifest for a given runtime environment and package.
  *

package/dist/types/bin/helpers/resolve-project-package.d.ts

@@ -1,4 +1,4 @@
-import type { ConsoleLogger } from '../utils';
+import type { ConsoleLogger } from '../utils/index.js';
 /**
  * Resolves the application package by fetching its metadata and logging relevant information.
  *
@@ -9,5 +9,5 @@ import type { ConsoleLogger } from '../utils';
  * @returns A promise that resolves to the package information, including its packageJson and root directory.
  * @throws Will throw an error if the package resolution fails.
  */
-export declare function resolveProjectPackage(log?: ConsoleLogger | null): Promise<import("../../lib").ResolvedPackage>;
+export declare function resolveProjectPackage(log?: ConsoleLogger | null): Promise<import("@equinor/fusion-framework-cli/lib").ResolvedPackage>;
 export default resolveProjectPackage;

package/dist/types/bin/index.d.ts

@@ -3,9 +3,18 @@ export { bundleApp } from './app-pack.js';
 export { generateApplicationConfig } from './app-config.js';
 export { publishAppConfig } from './app-config-publish.js';
 export { startAppDevServer } from './app-dev.js';
+export { checkApp } from './app-check.js';
+export { loadAppManifest } from './app-manifest.js';
+export { uploadApplication } from './app-upload.js';
+export { tagApplication, AllowedTags as AllowedAppTags } from './app-tag.js';
+export { startPortalDevServer } from './portal-dev.js';
 export { buildPortal } from './portal-build.js';
 export { bundlePortal } from './portal-pack.js';
 export { loadPortalManifest } from './portal-manifest.js';
 export { generatePortalConfig } from './portal-config.js';
 export { publishPortalConfig } from './portal-config-publish.js';
+export { uploadPortalBundle, type UploadPortalOptions } from './portal-upload.js';
+export { tagPortal, AllowedTags as AllowedPortalTags } from './portal-tag.js';
 export { pack } from './pack.js';
+export { ConsoleLogger } from './utils/ConsoleLogger.js';
+export { initializeFramework, resolveDefaultEnv, type FusionFramework, type FusionFrameworkSettings, FusionEnv, } from './framework.node.js';

package/dist/types/bin/pack.d.ts

@@ -1,6 +1,6 @@
 import AdmZip from 'adm-zip';
 import type { ReadResult as PackageInfo } from 'read-package-up';
-import { type ConsoleLogger } from './utils';
+import { type ConsoleLogger } from './utils/index.js';
 /**
  * Options for packaging an application bundle into a zip archive.
  *

package/dist/types/bin/portal-build.d.ts

@@ -1,5 +1,5 @@
-import type { RuntimeEnv } from '../lib';
-import { type ConsoleLogger } from './utils';
+import { type FusionEnv } from './framework.node.js';
+import { type ConsoleLogger } from './utils/index.js';
 /**
  * Options for building a portal application using Vite.
  *
@@ -13,7 +13,7 @@ import { type ConsoleLogger } from './utils';
  * @public
  */
 export type BuildApplicationOptions = {
-    env?: Partial<RuntimeEnv>;
+    env?: Partial<FusionEnv>;
     manifest?: string;
     log?: ConsoleLogger | null;
 };
@@ -29,7 +29,7 @@ export type BuildApplicationOptions = {
  * @public
  */
 export declare const buildPortal: (opt?: BuildApplicationOptions) => Promise<{
-    pkg: import("../lib").ResolvedPackage;
+    pkg: import("../lib/index.js").ResolvedPackage;
     manifest: {
         build: {
             version: string;
@@ -38,11 +38,11 @@ export declare const buildPortal: (opt?: BuildApplicationOptions) => Promise<{
             allowedExtensions: string[];
             templateEntry: string;
             schemaEntry: string;
-            config?: Record<string, unknown> | undefined;
             assetPath?: string | undefined;
             githubRepo?: string | undefined;
             projectPage?: string | undefined;
             annotations?: Record<string, string> | undefined;
+            config?: Record<string, unknown> | undefined;
             schema?: Record<string, unknown> | undefined;
         };
         name: string;

package/dist/types/bin/portal-config-publish.d.ts

@@ -1,5 +1,5 @@
-import { type FusionEnv, type FusionFrameworkSettings } from '../lib/framework.node.js';
-import { type ConsoleLogger } from './utils';
+import { type FusionEnv, type FusionFrameworkSettings } from './framework.node.js';
+import { type ConsoleLogger } from './utils/index.js';
 type PortalConfigPublishOptions = {
     config?: string;
     portal: {

package/dist/types/bin/portal-config.d.ts

@@ -1,5 +1,5 @@
-import type { RuntimeEnv } from '../lib';
-import { type ConsoleLogger } from './utils';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import { type ConsoleLogger } from './utils/index.js';
 /**
  * Options for generating the portal configuration.
  *
@@ -40,7 +40,7 @@ interface GeneratePortalConfigOptions {
  * @public
  */
 export declare const generatePortalConfig: (options?: GeneratePortalConfigOptions) => Promise<{
-    config: import("../lib/portal").PortalConfig;
-    pkg: import("../lib").ResolvedPackage;
+    config: import("../lib/portal/portal-config.js").PortalConfig;
+    pkg: import("@equinor/fusion-framework-cli/lib").ResolvedPackage;
 }>;
 export {};

package/dist/types/bin/portal-dev.d.ts

@@ -1,5 +1,5 @@
-import type { RuntimeEnv } from '../lib';
-import { type ConsoleLogger } from './utils';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import { type ConsoleLogger } from './utils/index.js';
 /**
  * Starts the portal development server for local development and testing.
  *

package/dist/types/bin/portal-manifest.d.ts

@@ -1,5 +1,5 @@
-import type { RuntimeEnv } from '../lib';
-import type { ConsoleLogger } from './utils';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import type { ConsoleLogger } from './utils/index.js';
 /**
  * Options for resolving the portal manifest.
  *
@@ -43,18 +43,18 @@ export declare const loadPortalManifest: (options: ResolvePortalManifestOptions)
             allowedExtensions: string[];
             templateEntry: string;
             schemaEntry: string;
-            config?: Record<string, unknown> | undefined;
             assetPath?: string | undefined;
             githubRepo?: string | undefined;
             projectPage?: string | undefined;
             annotations?: Record<string, string> | undefined;
+            config?: Record<string, unknown> | undefined;
             schema?: Record<string, unknown> | undefined;
         };
         name: string;
         displayName?: string | undefined;
         description?: string | undefined;
     };
-    pkg: import("../lib").ResolvedPackage;
+    pkg: import("@equinor/fusion-framework-cli/lib").ResolvedPackage;
     env: RuntimeEnv;
 }>;
 export default loadPortalManifest;

package/dist/types/bin/portal-pack.d.ts

@@ -1,4 +1,4 @@
-import type { ConsoleLogger } from './utils/ConsoleLogger';
+import type { ConsoleLogger } from './utils/ConsoleLogger.js';
 /**
  * Options for bundling a portal into an archive for distribution or deployment.
  *
@@ -39,16 +39,16 @@ export declare const bundlePortal: (options: BundlePortalOptions) => Promise<{
             allowedExtensions: string[];
             templateEntry: string;
             schemaEntry: string;
-            config?: Record<string, unknown> | undefined;
             assetPath?: string | undefined;
             githubRepo?: string | undefined;
             projectPage?: string | undefined;
             annotations?: Record<string, string> | undefined;
+            config?: Record<string, unknown> | undefined;
             schema?: Record<string, unknown> | undefined;
         };
         name: string;
         displayName?: string | undefined;
         description?: string | undefined;
     };
-    schema: import("../lib/portal").PortalSchema;
+    schema: import("@equinor/fusion-framework-cli/portal").PortalSchema;
 }>;

package/dist/types/bin/portal-tag.d.ts

@@ -1,5 +1,5 @@
-import { type ConsoleLogger } from './utils';
-import type { FusionFramework } from '../lib/framework.node.js';
+import type { FusionFramework } from './framework.node.js';
+import { type ConsoleLogger } from './utils/index.js';
 /**
  * Allowed tags for portal versions in the portal service.
  *

package/dist/types/bin/portal-upload.d.ts

@@ -1,6 +1,6 @@
 import AdmZip from 'adm-zip';
-import { type ConsoleLogger } from './utils';
-import type { FusionFramework } from '../lib/framework.node.js';
+import type { FusionFramework } from './framework.node.js';
+import type { ConsoleLogger } from './utils/ConsoleLogger.js';
 /**
  * Options for uploading a portal bundle to the portal service.
  *

package/dist/types/bin/utils/create-dev-server.d.ts

@@ -1,6 +1,6 @@
 import type { AppManifest } from '@equinor/fusion-framework-module-app';
 import type { ApiAppConfig } from '@equinor/fusion-framework-module-app/schemas.js';
-import type { RuntimeEnv } from '../../lib';
+import { type RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
 import { type UserConfig, type DevServerOptions, type FusionTemplateEnv } from '@equinor/fusion-framework-dev-server';
 /**
  * PortalManifest describes the minimal structure required for a portal manifest.
@@ -30,7 +30,7 @@ export type CreateDevServerOptions = {
     template?: Partial<FusionTemplateEnv>;
     portal?: {
         manifest: PortalManifest;
-        config: PortalConfig;
+        config?: PortalConfig;
     };
     app?: {
         manifest: AppManifest;

package/dist/types/cli/commands/disco/resolve.d.ts

@@ -7,7 +7,7 @@
  *
  * @command resolve
  * @description Resolve and display information about a service registered in Fusion service discovery.
- * @argument {string} service - Name of the service to resolve in Fusion service discovery.
+ * @param {string} service - Name of the service to resolve in Fusion service discovery.
  * @option {string} --env - Environment to use (e.g., prod, test).
  * @option {string} --token - Authentication token.
  * @option {string} --tenantId - Tenant ID for authentication.

package/dist/types/cli/main.d.ts

@@ -1,21 +1 @@
-/**
- * Entry point for the Fusion Framework CLI.
- *
- * This file sets up the CLI program, loads the package metadata, and registers all available commands.
- *
- * Key responsibilities:
- * - Locates the CLI's root directory and package.json using read-package-up.
- * - Sets the CLI_BIN environment variable for internal use.
- * - Initializes the Commander.js program with name, version, and description from package.json.
- * - Registers all CLI commands via the registerCommands function.
- * - Parses process arguments and starts the CLI.
- *
- * Maintenance notes:
- * - To add new commands, update the registerCommands module.
- * - To change CLI metadata (name, version, description), update package.json.
- * - This file should remain minimal and only handle top-level CLI setup logic.
- * - For troubleshooting, ensure the CLI_BIN path is set correctly and that package.json is accessible.
- *
- * For more details, see the Fusion Framework CLI documentation or contact the maintainers.
- */
 export {};

package/dist/types/cli/options/env.d.ts

@@ -1,5 +1,4 @@
-import { FusionEnv } from '../../lib/framework.node.js';
-export type { FusionEnv } from '../../lib/framework.node.js';
+import { FusionEnv } from '@equinor/fusion-framework-cli/bin';
 /**
  * Creates an environment option for Fusion Framework CLI commands.
  *

package/dist/types/lib/app/app-config.d.ts

@@ -1,6 +1,6 @@
 import type z from 'zod';
-import type { RuntimeEnv } from '../types';
-import type { ApiAppConfig, ApiAppConfigSchema } from './schemas';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
+import type { ApiAppConfig, ApiAppConfigSchema } from './schemas.js';
 export type { ApiAppConfig as AppConfig } from './schemas.js';
 export { mergeAppConfig } from './merge-app-config.js';
 /**

package/dist/types/lib/app/app-manifest.d.ts

@@ -1,5 +1,5 @@
 import type { AppManifest } from '@equinor/fusion-framework-module-app';
-import type { RuntimeEnv } from '../types';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
 /**
  * Type representing the application manifest structure used by the Fusion Framework.
  * Imported from the '@equinor/fusion-framework-module-app' package for consistency across modules.

package/dist/types/lib/app/merge-app-config.d.ts

@@ -1,4 +1,4 @@
-import type { AppConfig } from './app-config';
+import type { AppConfig } from '@equinor/fusion-framework-cli/app';
 /**
  * Merges a base application configuration object with an overrides object,
  * returning a new configuration object. If the `scopes` property is present

package/dist/types/lib/app/merge-app-manifest.d.ts

@@ -1,7 +1,7 @@
 import type { AppManifest } from '@equinor/fusion-framework-module-app';
 import type { RecursivePartial } from '../utils/types.js';
 /**
- * Deeply merges two application manifests using lodash's mergeWith.
+ * Deeply merges two application manifests using deepmerge.
  *
  * This utility is intended for combining a base manifest with an override manifest,
  * supporting recursive merging of nested properties. It is commonly used in scenarios

package/dist/types/lib/index.d.ts

@@ -1,4 +1,5 @@
 export type { RuntimeEnv } from './types.js';
-export type { ResolvedPackage } from './utils/resolve-package.js';
-export { initializeFramework, type FusionFramework } from './framework.node.js';
+export { resolvePackage, type ResolvedPackage } from './utils/resolve-package.js';
+export { resolveEntryPoint } from './utils/resolve-source-entry-point.js';
+export { loadDevServerConfig } from './load-dev-server-config.js';
 export { defineAppConfig, defineAppManifest } from './legacy.js';

package/dist/types/lib/legacy.d.ts

@@ -21,4 +21,4 @@ export declare const defineAppConfig: (...args: Parameters<typeof _defineConfig>
  *
  * @param args - Arguments passed to the new defineAppManifest function.
  */
-export declare const defineAppManifest: (...args: Parameters<typeof _defineManifest>) => import("./app/app-manifest.js").AppManifestFn<import("@equinor/fusion-framework-module-app").AppManifest>;
+export declare const defineAppManifest: (...args: Parameters<typeof _defineManifest>) => import("./app/app-manifest.js").AppManifestFn<import("node_modules/@equinor/fusion-framework-module-app/dist/types/types.js").AppManifest>;

package/dist/types/lib/load-dev-server-config.d.ts

@@ -1,5 +1,5 @@
 import { type ImportConfigResult } from '@equinor/fusion-imports';
-import type { RuntimeEnv } from './types.js';
+import type { RecursivePartial, RuntimeEnv } from './types.js';
 import type { DevServerOptions } from '@equinor/fusion-framework-dev-server';
 /**
  * Type definition for a function that generates or modifies DevServerOptions.
@@ -9,7 +9,7 @@ import type { DevServerOptions } from '@equinor/fusion-framework-dev-server';
  */
 export type DevServerConfigFn = (env: RuntimeEnv, args: {
     base: DevServerOptions;
-}) => Promise<DevServerOptions | undefined> | DevServerOptions | undefined;
+}) => Promise<RecursivePartial<DevServerOptions> | undefined> | RecursivePartial<DevServerOptions> | undefined;
 /**
  * Type definition for a dev server config export, which can be either a DevServerOptions object or a function.
  */

package/dist/types/lib/merge-dev-server-config.d.ts

@@ -1,5 +1,5 @@
 import type { DevServerOptions } from '@equinor/fusion-framework-dev-server';
-import type { RecursivePartial } from './utils/types';
+import type { RecursivePartial } from './utils/types.js';
 /**
  * Merges a base development server configuration with an overrides object.
  *

package/dist/types/lib/portal/create-portal-manifest.d.ts

@@ -1,5 +1,5 @@
 import type { PackageJson } from 'type-fest';
-import type { RuntimeEnv } from '../types';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
 import type { PortalManifest } from './portal-manifest.js';
 /**
  * Creates a `PortalManifest` object from the provided `package.json` data and runtime environment.

package/dist/types/lib/portal/load-portal-manifest.d.ts

@@ -1,4 +1,4 @@
-import type { RuntimeEnv } from '../types';
+import type { RecursivePartial, RuntimeEnv } from '../types.js';
 import type { PortalManifest } from './portal-manifest.js';
 /**
  * A function type for generating or modifying a portal manifest based on the runtime environment and provided arguments.
@@ -10,7 +10,7 @@ import type { PortalManifest } from './portal-manifest.js';
  */
 export type PortalManifestFn<T extends Partial<PortalManifest>> = (env: RuntimeEnv, args: {
     base: T;
-}) => T | Promise<T | void> | T | void;
+}) => Promise<RecursivePartial<T> | void> | RecursivePartial<T> | void;
 /**
  * Represents a value that can either be a partial portal manifest object or a function returning such an object.
  *

package/dist/types/lib/portal/load-portal-schema.d.ts

@@ -1,4 +1,4 @@
-import type { RuntimeEnv } from '../types';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
 /**
  * Represents a generic portal schema as a record of key-value pairs.
  */

package/dist/types/lib/portal/portal-config.d.ts

@@ -1,4 +1,4 @@
-import type { RuntimeEnv } from '../types';
+import type { RuntimeEnv } from '@equinor/fusion-framework-cli/lib';
 /**
  * Represents the configuration object for a portal.
  *
@@ -15,7 +15,7 @@ import type { RuntimeEnv } from '../types';
  * };
  * ```
  */
-export type PortalConfig = Record<any, any>;
+export type PortalConfig = Record<string, unknown>;
 /**
  * A function type for defining dynamic or static portal configuration.
  *

package/dist/types/lib/portal/portal-manifest.schema.d.ts

@@ -28,11 +28,11 @@ export declare const PortalManifestBuildSchema: z.ZodObject<{
     allowedExtensions: string[];
     templateEntry: string;
     schemaEntry: string;
-    config?: Record<string, unknown> | undefined;
     assetPath?: string | undefined;
     githubRepo?: string | undefined;
     projectPage?: string | undefined;
     annotations?: Record<string, string> | undefined;
+    config?: Record<string, unknown> | undefined;
     schema?: Record<string, unknown> | undefined;
 }, {
     version: string;
@@ -41,11 +41,11 @@ export declare const PortalManifestBuildSchema: z.ZodObject<{
     allowedExtensions: string[];
     templateEntry: string;
     schemaEntry: string;
-    config?: Record<string, unknown> | undefined;
     assetPath?: string | undefined;
     githubRepo?: string | undefined;
     projectPage?: string | undefined;
     annotations?: Record<string, string> | undefined;
+    config?: Record<string, unknown> | undefined;
     schema?: Record<string, unknown> | undefined;
 }>;
 /**
@@ -82,11 +82,11 @@ export declare const PortalManifestSchema: z.ZodObject<{
         allowedExtensions: string[];
         templateEntry: string;
         schemaEntry: string;
-        config?: Record<string, unknown> | undefined;
         assetPath?: string | undefined;
         githubRepo?: string | undefined;
         projectPage?: string | undefined;
         annotations?: Record<string, string> | undefined;
+        config?: Record<string, unknown> | undefined;
         schema?: Record<string, unknown> | undefined;
     }, {
         version: string;
@@ -95,11 +95,11 @@ export declare const PortalManifestSchema: z.ZodObject<{
         allowedExtensions: string[];
         templateEntry: string;
         schemaEntry: string;
-        config?: Record<string, unknown> | undefined;
         assetPath?: string | undefined;
         githubRepo?: string | undefined;
         projectPage?: string | undefined;
         annotations?: Record<string, string> | undefined;
+        config?: Record<string, unknown> | undefined;
         schema?: Record<string, unknown> | undefined;
     }>;
 }, "strip", z.ZodTypeAny, {
@@ -110,11 +110,11 @@ export declare const PortalManifestSchema: z.ZodObject<{
         allowedExtensions: string[];
         templateEntry: string;
         schemaEntry: string;
-        config?: Record<string, unknown> | undefined;
         assetPath?: string | undefined;
         githubRepo?: string | undefined;
         projectPage?: string | undefined;
         annotations?: Record<string, string> | undefined;
+        config?: Record<string, unknown> | undefined;
         schema?: Record<string, unknown> | undefined;
     };
     name: string;
@@ -128,11 +128,11 @@ export declare const PortalManifestSchema: z.ZodObject<{
         allowedExtensions: string[];
         templateEntry: string;
         schemaEntry: string;
-        config?: Record<string, unknown> | undefined;
         assetPath?: string | undefined;
         githubRepo?: string | undefined;
         projectPage?: string | undefined;
         annotations?: Record<string, string> | undefined;
+        config?: Record<string, unknown> | undefined;
         schema?: Record<string, unknown> | undefined;
     };
     name: string;

package/dist/types/lib/types.d.ts

@@ -32,3 +32,32 @@ export type RuntimeEnv = {
      */
     environment?: string | null;
 };
+/**
+ * Makes all properties of a type optional, recursively.
+ * For array properties, applies the transformation to the array's element type.
+ *
+ * @template T - The type to make recursively partial.
+ *
+ * @example
+ * type Example = {
+ *   a: number;
+ *   b: {
+ *     c: string;
+ *     d: number[];
+ *   };
+ * };
+ * // RecursivePartial<Example> will be:
+ * // {
+ * //   a?: number;
+ * //   b?: {
+ * //     c?: string;
+ * //     d?: number[];
+ * //   };
+ * // }
+ */
+export type RecursivePartial<T> = {
+    [P in keyof T]?: T[P] extends Array<infer U> ? Array<Value<U>> : Value<T[P]>;
+};
+type AllowedPrimitives = Function | boolean | string | number | Date;
+type Value<T> = T extends AllowedPrimitives ? T : RecursivePartial<T>;
+export {};

package/dist/types/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
+export { assert } from './assert.js';
 export { resolveEntryPoint } from './resolve-source-entry-point.js';
 export { resolvePackage, type ResolvedPackage } from './resolve-package.js';
 export { fileExists, fileExistsSync } from './file-exists.js';

package/dist/types/lib/utils/resolve-annotations.d.ts

@@ -1,3 +1,37 @@
+/**
+ * Represents metadata annotations related to a release process.
+ *
+ * @property source - The origin or system that triggered the release.
+ * @property reason - The reason or context for the release.
+ * @property [repository] - The repository associated with the release, if applicable.
+ * @property [actor] - The user or system that initiated the release.
+ * @property [workflow] - The workflow or pipeline responsible for the release.
+ * @property [runId] - The unique identifier for the workflow run.
+ * @property [branch] - The branch from which the release was made.
+ * @property [commitId] - The commit hash associated with the release.
+ * @property [runUrl] - The URL to the workflow run details.
+ * @property [htmlUrl] - The URL to the release or related resource in a web interface.
+ * @property [tag] - The tag name associated with the release.
+ */
+export type ReleaseAnnotations = {
+    source: string;
+    reason: string;
+    actor?: string;
+    workflow?: string;
+    runId?: string;
+    branch?: string;
+    commitId?: string;
+    runUrl?: string;
+    repository?: string;
+    repository_homepage?: string;
+    repository_license?: string;
+    repository_owner?: string;
+    repository_owner_avatar_url?: string;
+    htmlUrl?: string;
+    tag?: string;
+    sender_login?: string;
+    sender_avatar_url?: string;
+};
 /**
  * Resolves CI/CD environment-specific annotation variables.
  *
@@ -8,4 +42,4 @@
  * @returns {Record<string, string>} An object containing annotation variables for the detected environment.
  * If no known environment is detected, returns an empty object.
  */
-export declare const resolveAnnotations: () => Record<string, string>;
+export declare const resolveAnnotations: () => ReleaseAnnotations | undefined;

package/dist/types/lib/utils/resolve-devops-annotations.d.ts

@@ -1,10 +1,35 @@
+/**
+ * Represents metadata annotations related to a DevOps pipeline run.
+ *
+ * @property runId - The unique identifier for the pipeline run.
+ * @property pipelineName - The name of the pipeline.
+ * @property repository - The name or URL of the source code repository.
+ * @property project - The name of the project within the DevOps organization.
+ * @property orgUrl - The URL of the DevOps organization.
+ * @property actor - The user or service that triggered the pipeline run.
+ * @property branch - The branch name associated with the pipeline run.
+ * @property commitId - The commit SHA or identifier for the pipeline run.
+ * @property runUrl - The URL to view the pipeline run details.
+ */
+export interface DevopsAnnotations {
+    runId: string;
+    pipelineName: string;
+    repository: string;
+    project: string;
+    orgUrl: string;
+    actor: string;
+    branch: string;
+    commitId: string;
+    runUrl: string;
+    reason: string;
+}
 /**
  * Resolves Azure DevOps-specific annotation variables from environment variables.
  *
  * This function extracts relevant build and repository information from Azure DevOps 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 Azure DevOps annotation variables such as runId, repository,
+ * @returns {DevopsAnnotations} An object containing Azure DevOps annotation variables such as runId, repository,
  * project, orgUrl, actor, branch, commitId, and runUrl. If a variable is not found, its value defaults to 'unknown'.
  *
  * Environment variables used by this function (see: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-pipelines&tabs=yaml):
@@ -26,5 +51,5 @@
  *   - To add more annotations, extract additional environment variables as needed and include them in the returned object.
  *   - For custom pipelines or self-hosted agents, verify that all required environment variables are available.
  */
-export declare const resolveAnnotations: () => Record<string, string>;
-export default resolveAnnotations;
+export declare const resolveDevopsAnnotations: () => DevopsAnnotations;
+export default resolveDevopsAnnotations;

package/dist/types/lib/utils/resolve-git-commit-sha.d.ts

@@ -11,3 +11,4 @@
  * @throws Will throw an error if the `git` command fails or is not available.
  */
 export declare const resolveGitCommitSha: (ref?: string) => string | undefined;
+export default resolveGitCommitSha;