@equinor/fusion-framework-cli 10.7.5-apploader-be21a6b60eb13eee8bf869e75002d8634e9c50a9 → 11.0.0-next.1

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

@@ -1,52 +0,0 @@
-import { type ResolvedAppPackage } from './app-package.js';
-import { type FindConfigOptions, type ResolvedConfig, type ConfigExecuterEnv } from './utils/config.js';
-import type { RecursivePartial } from './utils/types.js';
-import type { AppManifest } from '@equinor/fusion-framework-module-app';
-export type AppManifestFn = (env: ConfigExecuterEnv, args: {
-    base: AppManifest;
-}) => Partial<AppManifest> | Promise<Partial<AppManifest> | void> | void;
-type FindManifestOptions = FindConfigOptions & {
-    file?: string;
-};
-/** base filename for configuration files */
-export declare const manifestConfigFilename = "app.manifest.config";
-/**
- * Define a manifest for an application
- *
- * @example
- * ```ts
- * export default defineAppManifest(async() => {
- *    return {
- *        ...AppManifest_properties
- *    }
- * })
- * ```
- * @param fnOrObj - defines the manifest as an object or callback
- */
-export declare const defineAppManifest: (fn: AppManifestFn) => AppManifestFn;
-export declare function assertAppManifest(value: AppManifest): asserts value;
-/**
- * @example
- * ```ts
- * export default defineAppManifest(base) => mergeManifests(base, {prop: value});
- * ```
- * @param base base manifest to merge with
- * @param overrides target manifest to apply to base
- * @returns deep merged manifest
- */
-export declare const mergeManifests: (base: RecursivePartial<AppManifest>, overrides: RecursivePartial<AppManifest>) => AppManifest;
-/** loads manifestFn from file */
-export declare const loadManifest: (filename?: string) => Promise<import("./utils/config.js").ConfigExecuter<AppManifest, import("./utils/config.js").ConfigExecuterArgs>>;
-/**
- * tries to resolve manifest
- * @see {@link resolveConfig | resolving config}
- */
-export declare const resolveManifest: (options?: FindConfigOptions & {
-    file?: string;
-}) => Promise<ResolvedConfig<AppManifestFn> | void>;
-export declare const createManifestFromPackage: (pkg: ResolvedAppPackage) => AppManifest;
-export declare const createManifest: (env: ConfigExecuterEnv, base: AppManifest, options?: FindManifestOptions) => Promise<{
-    manifest: AppManifest;
-    path?: string;
-}>;
-export {};

package/dist/types/lib/plugins/app-assets/app-asset-plugin.d.ts

@@ -1,36 +0,0 @@
-import { type FilterPattern, type Plugin } from 'vite';
-/**
- * A Vite plugin to handle external resources in a library build.
- *
- * @param options - Configuration options for the plugin.
- * @param options.name - Optional name for the emitted assets.
- * @param options.include - Filter pattern to include specific files.
- * @param options.exclude - Filter pattern to exclude specific files.
- * @returns A Vite plugin object.
- *
- * @remarks
- * This plugin is intended to be used only during the Vite library build process.
- * It resolves asset IDs, emits assets, and exports them as URLs.
- *
- * @example
- * ```typescript
- * // vite.config.ts
- * import { ExternalAppAssetPlugin } from '@equinor/fusion-framework-cli/plugins/app-assets-plugin';
- *
- * export default {
- *   plugins: [
- *     ExternalAppAssetPlugin({
- *       name: 'my-asset',
- *       include:  ['svg', 'png'],
- *       exclude: 'node_modules/**',
- *     }),
- *   ],
- * };
- * ```
- */
-export declare const AppAssetExportPlugin: (options?: {
-    name?: string;
-    include?: FilterPattern;
-    exclude?: FilterPattern;
-}) => Plugin;
-export default AppAssetExportPlugin;

package/dist/types/lib/plugins/app-assets/emit-asset.d.ts

@@ -1,18 +0,0 @@
-import type { PluginContext } from 'rollup';
-/**
- * Synchronously emits an asset file based on the provided context and options.
- *
- * @param context - The plugin context used for emitting the file and logging warnings.
- * @param id - The identifier of the asset, which may include a resource query.
- * @param options - Optional parameters for customizing the emitted asset.
- * @param options.name - The name template for the emitted asset file. Defaults to '[name].[ext]'.
- * @param options.outDir - The output directory where the asset will be emitted. Defaults to 'dist'.
- * @param options.assetsDir - The directory within the output directory where assets will be stored. Defaults to 'assets'.
- * @returns The path of the emitted asset relative to the assets directory, or null if the asset content could not be read.
- */
-export declare const emitAssetSync: (context: PluginContext, id: string, options?: {
-    name?: string;
-    outDir?: string;
-    assetsDir?: string;
-}) => string | null;
-export default emitAssetSync;

package/dist/types/lib/plugins/app-assets/index.d.ts

@@ -1,3 +0,0 @@
-export { default, AppAssetExportPlugin } from './app-asset-plugin.js';
-export { createExtensionFilterPattern } from './extension-filter-pattern.js';
-export { ASSET_EXTENSIONS as StandardIncludeAssetExtensions } from './static.js';

package/dist/types/lib/plugins/app-assets/read-asset-content.d.ts

@@ -1,14 +0,0 @@
-/**
- * Reads the content of an asset synchronously.
- *
- * @param id - The identifier of the asset, which can include a query string.
- * @returns The content of the asset as a Buffer if it exists, otherwise null.
- *
- * @remarks
- * - If the asset content is already cached, it returns the cached content.
- * - The function extracts the filename from the identifier by removing any query string.
- * - If the file exists, it reads the content, caches it, and then returns it.
- * - If the file does not exist, it logs a warning and returns null.
- */
-export declare const readAssetContentSync: (id: string) => Buffer | null;
-export default readAssetContentSync;

package/dist/types/lib/plugins/app-assets/resolve-asset-id.d.ts

@@ -1,16 +0,0 @@
-import type { PluginContext, PartialResolvedId } from 'rollup';
-/**
- * Resolves the asset ID based on the provided context, ID, importer, and options.
- *
- * @param context - The plugin context used for resolving the ID.
- * @param id - The asset ID to resolve.
- * @param importer - The path of the module that is importing the asset.
- * @param options - Optional resolution options.
- * @returns A promise that resolves to a `PartialResolvedId` object or `null`.
- *
- * The function handles three cases:
- * 1. If the ID is an absolute path, it returns an object with the ID, marked as external and resolved by the plugin.
- * 2. If the ID is a relative path, it resolves the path relative to the importer and returns an object with the resolved ID, marked as external and resolved by the plugin.
- * 3. For all other cases, it delegates the resolution to the context's resolve method.
- */
-export declare const resolveAssetId: (context: PluginContext, id: string, importer: string, options?: Parameters<PluginContext["resolve"]>[2]) => Promise<PartialResolvedId | null>;

package/dist/types/lib/plugins/app-assets/static.d.ts

@@ -1,5 +0,0 @@
-export declare const PLUGIN_NAME = "vite:fusion:app-assets";
-/**
- * General asset extensions.
- */
-export declare const ASSET_EXTENSIONS: string[];

package/dist/types/lib/plugins/app-proxy/app-proxy-plugin.d.ts

@@ -1,89 +0,0 @@
-import type { Plugin } from 'vite';
-import type { AppManifest } from '@equinor/fusion-framework-app';
-import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
-import type { ApiAppConfig } from '../../../schemas.js';
-/**
- * Options for configuring the App Proxy Plugin.
- *
- * @remarks
- * When not providing an app configuration, the plugin will only proxy requests to the target.
- */
-export type AppProxyPluginOptions = {
-    /** Configuration for the proxy. */
-    proxy: {
-        /** The path to be proxied. */
-        path: string;
-        /** The target URL for the proxy. */
-        target: string;
-        /** Optional callback function to modify the proxy request. */
-        onProxyReq?: (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse) => void;
-    };
-    /** Optional configuration for the app. */
-    app?: {
-        /** application key */
-        key: string;
-        /** application version */
-        version: string;
-        /** callback function for generating configuration for the application */
-        generateConfig: () => Promise<ApiAppConfig>;
-        /**
-         * string path to the app config
-         * @example `persons/me/apps/${app.key}/builds/${app.version}/config`
-         * @default `apps/${app.key}/builds/${app.version}/config`
-         */
-        configPath?: string;
-        /** callback function for generating manifest for the application */
-        generateManifest: () => Promise<AppManifest>;
-        /**
-         * string path to the app manifest
-         * @example `persons/me/apps/${app.key}`
-         * @default `apps/${app.key}`
-         */
-        manifestPath?: string;
-        /**
-         * string path to the app bundle
-         * @default `bundles/apps/${app.key}/${app.version}`
-         * @example `bundles/apps/${app.key}/${app.version}`
-         */
-        bundlePath?: string;
-    };
-};
-/**
- * The `appProxyPlugin` function creates a Vite plugin that configures a proxy for API and bundle requests
- * to the Fusion apps backend. It also serves the app manifest, config, and local bundles if an app is provided.
- *
- * @param {AppProxyPluginOptions} options - The options for configuring the app proxy plugin.
- *
- * @returns {Plugin} - The configured Vite plugin.
- *
- * @example
- * ```typescript
- * const plugin = appProxyPlugin({
- *   proxy: {
- *     path: '/app-proxy',
- *     target: 'https://apps.ci.api.fusion-dev.net',
- *     onProxyReq: (proxyReq, req, res) => {
- *       proxyReq.on('response', (res) => { console.log(res.statusCode) });
- *     },
- *   },
- *   app: {
- *     key: 'my-app',
- *     version: '1.0.0',
- *     generateConfig: async () => ({}),
- *     generateManifest: async () => ({}),
- *   },
- * });
- *
- * // api calls
- * fetch('/app-proxy/apps/my-app/builds/1.0.0/config'); // will generate app config by provided function
- * fetch('/app-proxy/apps/my-app/builds/0.0.9/config'); // will proxy to the target, since version does not match
- * fetch('/app-proxy/apps/other-app/builds/1.0.0/config'); // will proxy to the target, since app key does not match
- *
- * // asset calls
- * fetch('/app-proxy/bundles/my-app/builds/1.0.0/index.js'); // will generate bundle by provided function
- * fetch('/app-proxy/bundles/my-app/builds/0.0.9/index.js'); // will proxy to the target, since version does not match
- * ```
- *
- */
-export declare const appProxyPlugin: (options: AppProxyPluginOptions) => Plugin;
-export default appProxyPlugin;

package/dist/types/lib/plugins/app-proxy/index.d.ts

@@ -1 +0,0 @@
-export { default, appProxyPlugin, type AppProxyPluginOptions } from './app-proxy-plugin.js';

package/dist/types/lib/plugins/app-settings/index.d.ts

@@ -1,32 +0,0 @@
-import type { Plugin } from 'vite';
-/**
- * Options for configuring the AppSettingsPlugin.
- */
-export interface AppSettingsPluginOptions {
-    /**
-     * A string or regular expression to match specific settings.
-     * If provided, only settings that match this pattern will be considered.
-     */
-    match?: string | RegExp;
-    /**
-     * A record of default settings to be used if no other settings are provided.
-     * The keys are setting names and the values are the default values for those settings.
-     */
-    defaultSettings?: Record<string, unknown>;
-}
-/**
- * This plugin provides a simple way to manage application settings in a local development environment.
- *
- * This plugin will cache the settings in memory and respond to `PUT` requests to update the settings.
- * Restarting the development server will reset the settings to the default values.
- *
- * @param options - The options for configuring the app settings plugin.
- * @returns A Vite Plugin object that can be used to configure a server.
- *
- * The plugin provides the following functionality:
- * - Matches requests based on a specified path pattern.
- * - Handles `PUT` requests to update application settings.
- * - Responds with the current application settings in JSON format.
- */
-export declare function appSettingsPlugin(options: AppSettingsPluginOptions): Plugin;
-export default appSettingsPlugin;

package/dist/types/lib/plugins/external-public/external-public-plugin.d.ts

@@ -1,30 +0,0 @@
-import { type FilterPattern, type Plugin } from 'vite';
-/**
- * Creates a plugin that serves an external public directory.
- *
- * This plugin is useful when you want to serve a static site from a different directory than the one where the Vite server is running.
- * Vite`s built in `mode: 'spa'` will only look for the `index.html` file in the configured `root` directory,
- * so this plugin is necessary to serve the `index.html` file from a different directory.
- *
- * @param path - The path to the external public directory.
- * @param options - Optional filter patterns to include or exclude specific assets.
- * @param options.include - A filter pattern to include specific assets.
- * @param options.exclude - A filter pattern to exclude specific assets.
- * @returns A Vite plugin object.
- *
- * The plugin:
- * - Sets the `path` configuration to the provided path.
- * - Adds a middleware to the server that serves static assets from the specified path.
- * - Adds a middleware to the server that serves the `index.html` file from the specified path.
- *
- * The middleware:
- * - Checks if the request is for a static asset and serves it from the specified path.
- * - Reads the `index.html` file from the specified path.
- * - Transforms the HTML using the server's `transformIndexHtml` method.
- * - Responds with the transformed HTML, setting appropriate headers.
- */
-export declare const externalPublicPlugin: (path: string, options?: {
-    include?: FilterPattern;
-    exclude?: FilterPattern;
-}) => Plugin;
-export default externalPublicPlugin;

package/dist/types/lib/plugins/external-public/index.d.ts

@@ -1 +0,0 @@
-export { default, externalPublicPlugin } from './external-public-plugin.js';

package/dist/types/lib/plugins/help-proxy/help-proxy-plugin.d.ts

@@ -1,42 +0,0 @@
-import type { ClientRequest, IncomingMessage, ServerResponse } from 'node:http';
-import type { Plugin } from 'vite';
-/**
- * Options for configuring the Help Proxy Plugin.
- */
-export type HelpProxyPluginOptions = {
-    /** Configuration for the proxy. */
-    proxy: {
-        /** The path to be proxyed. */
-        path: string;
-        /** The target URL for the proxy. */
-        target: string;
-        /** Optional callback function to modify the proxy request. */
-        onProxyReq?: (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse) => void;
-    };
-};
-/**
- * The `helpProxyPlugin` function creates a Vite plugin that configures a proxy
- * for assets API requests to the Fusion Help Service.
- *
- * @param {HelpProxyPluginOptions} options - The options for configuring the help proxy plugin.
- *
- * @returns {Plugin} - The configured Vite plugin.
- *
- * @example
- * ```typescript
- * const plugin = helpProxyPlugin({
- *   proxy: {
- *     path: '/help-proxy',
- *     target: 'https://help.ci.api.fusion-dev.net',
- *     onProxyReq: (proxyReq, req, res) => {
- *       proxyReq.on('response', (res) => { console.log(res.statusCode) });
- *     },
- *   },
- * });
- *
- * // Fetch a resource through the proxy
- * fetch('/help-proxy/assets/resources/images/image.jpg');
- * ```
- */
-export declare const helpProxyPlugin: (options: HelpProxyPluginOptions) => Plugin;
-export default helpProxyPlugin;

package/dist/types/lib/plugins/help-proxy/index.d.ts

@@ -1 +0,0 @@
-export { default, helpProxyPlugin, type HelpProxyPluginOptions } from './help-proxy-plugin.js';

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

@@ -1,32 +0,0 @@
-import { type Options } from 'find-up';
-export declare const supportedExt: readonly [".ts", ".mjs", ".js", ".json"];
-export type SupportedExt = (typeof supportedExt)[number];
-export type FindConfigOptions = Omit<Options, 'file'> & {
-    extensions?: Array<SupportedExt>;
-};
-export type ResolveConfigOptions = {
-    find?: FindConfigOptions;
-};
-export type ConfigExecuterEnv = {
-    /** cli command */
-    command: 'serve' | 'build';
-    /** cli mode */
-    mode: string;
-    /** root of the package */
-    root?: string;
-};
-export type ConfigExecuterArgs = [ConfigExecuterEnv, ...any[]];
-export type ConfigExecuter<TType = any, TArgs extends ConfigExecuterArgs = ConfigExecuterArgs> = (...args: TArgs) => TType | Promise<TType>;
-export type ConfigExecuterType<T> = T extends ConfigExecuter<infer TType> ? TType : never;
-export type ResolvedConfig<TType extends ConfigExecuter> = {
-    path: string;
-    config: TType;
-};
-/**
- * @param filename name if config file without extension
- */
-export declare const findConfigs: (filename: string, options?: FindConfigOptions) => Promise<string[]>;
-export declare const resolveConfig: <TType>(filename: string, options?: ResolveConfigOptions) => Promise<ResolvedConfig<ConfigExecuter<TType>> | void>;
-export declare const loadConfig: <TType>(file: string) => Promise<ConfigExecuter<TType>>;
-export declare function initiateConfig<TConfig extends ConfigExecuter>(config: TConfig, ...args: Parameters<TConfig>): Promise<ConfigExecuterType<TConfig> | void>;
-export default loadConfig;

package/dist/types/lib/utils/ts-transpile.d.ts

@@ -1,2 +0,0 @@
-export declare const transpile: (file: string) => Promise<string>;
-export default transpile;

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

@@ -1,17 +0,0 @@
-import { type UserConfig, type UserConfigFn } from 'vite';
-import { type FindConfigOptions, type ResolvedConfig, type ConfigExecuterEnv } from './utils/config.js';
-export declare function assertViteConfig(config: UserConfig): asserts config;
-export declare const loadViteConfig: (filename?: string) => Promise<import("./utils/config.js").ConfigExecuter<UserConfig, import("./utils/config.js").ConfigExecuterArgs>>;
-export declare const resolveViteConfig: (options?: FindConfigOptions & {
-    file?: string;
-}) => Promise<ResolvedConfig<UserConfigFn> | void>;
-export declare const createAppViteConfig: (env: ConfigExecuterEnv, options?: FindConfigOptions & {
-    file?: string;
-}) => Promise<{
-    config?: UserConfig;
-    path?: string;
-} | void>;
-export declare const resolveEntryPoint: (cwd?: string, dir?: string, opt?: {
-    files?: string[];
-}) => string | undefined;
-export declare const createViteConfig: (env: ConfigExecuterEnv, overrides?: UserConfig) => Promise<UserConfig>;

package/dist/types/lib/vite-logger.d.ts

@@ -1,2 +0,0 @@
-export declare const createViteLogger: () => import("vite").Logger;
-export default createViteLogger;

package/dist/version.js

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

package/dist/version.js.map

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