@equinor/fusion-framework-cli/dist/esm/lib/portal/portal-manifest.js

Command-line toolkit for developing, building, and publishing Fusion Framework applications and portal templates. Provides a unified developer experience from local development to production deployment.

import { PortalManifestSchema } from './portal-manifest.schema.js';
// Re-export relevant manifest utilities and types for external use
export { loadPortalManifest, } from './load-portal-manifest.js';
export { createPortalManifestFromPackage } from './create-portal-manifest.js';
/**
 * Utility to define a portal manifest function with proper typing.
 *
 * This is a no-op at runtime — it returns the provided function unchanged.
 * It exists to provide type safety and editor support when authoring portal manifest files.
 *
 * @template T - The portal manifest type, extending `PortalManifestSchemaType`.
 * @param fn - A function that receives the runtime environment and base manifest, and returns manifest overrides.
 * @returns The provided function, unchanged.
 *
 * @example
 * ```ts
 * import { definePortalManifest } from '@equinor/fusion-framework-cli/portal';
 *
 * export default definePortalManifest((env, { base }) => ({
 *   ...base,
 *   name: 'my-portal',
 * }));
 * ```
 */
export const definePortalManifest = (fn) => fn;
export { PortalManifestSchema, PortalManifestBuildSchema, } from './portal-manifest.schema.js';
/**
 * Validates a portal manifest object against the PortalManifestSchema.
 *
 * @param manifest - The manifest object to validate.
 * @returns The validated manifest object (typed) if valid.
 * @throws ZodError if validation fails.
 *
 * Use this utility to ensure a manifest conforms to the expected schema before further processing.
 */
export function validatePortalManifest(manifest) {
    // Throws if validation fails; returns typed manifest if valid
    return PortalManifestSchema.parse(manifest);
}
//# sourceMappingURL=portal-manifest.js.map