@equinor/fusion-framework-cli/dist/esm/lib/portal/load-portal-schema.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 { importConfig } from '@equinor/fusion-imports';
/**
 * Helper to define a portal schema function with type inference.
 * @template T - The type of the portal schema.
 * @param fn - The schema function to define.
 * @returns The provided schema function.
 */
export const definePortalSchema = (fn) => fn;
/**
 * Loads a portal schema from configuration files or schema functions.
 *
 * @template T - The type of the portal schema.
 * @param env - The runtime environment used to resolve the schema.
 * @param options - Optional configuration for file names and extensions.
 * @returns An object containing the loaded schema, file path, and extension.
 *
 * This function attempts to import a schema configuration file or function based on the provided environment and options.
 * It supports both direct schema objects and schema factory functions. The schema is resolved and validated before returning.
 */
export const loadPortalSchema = async (env, options) => {
    // Determine possible schema file names based on environment and options
    const suggestions = options?.file ?? [`portal.schema.${env.environment}`, 'portal.schema'];
    // Attempt to import the schema configuration using the importConfig utility
    const importResult = await importConfig(suggestions, {
        baseDir: env.root,
        extensions: options?.extensions,
        script: {
            // Custom resolver to handle both schema objects and schema factory functions
            resolve: async (module) => {
                // If the default export is a function, call it with the environment; otherwise, use the object directly
                const result = typeof module.default === 'function'
                    ? await Promise.resolve(module.default(env))
                    : module.default;
                // Validate that a schema was returned
                if (!result) {
                    throw new Error('Schema function did not return a valid schema');
                }
                return result;
            },
        },
    });
    // Return the loaded schema, along with the file path and extension for reference
    return {
        schema: importResult.config,
        path: importResult.path,
        extension: importResult.extension,
    };
};
//# sourceMappingURL=load-portal-schema.js.map