@equinor/fusion-framework-module-widget 9.0.2 → 9.0.4

package/src/types.ts

@@ -2,7 +2,7 @@ import type { AnyModule, CombinedModules, ModulesInstance } from '@equinor/fusio
 import type { EventModule } from '@equinor/fusion-framework-module-event';
 import type { HttpModule } from '@equinor/fusion-framework-module-http';
 import type { ServiceDiscoveryModule } from '@equinor/fusion-framework-module-service-discovery';
-import { QueryCtorOptions } from '@equinor/fusion-query';
+import type { QueryCtorOptions } from '@equinor/fusion-query';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type Fusion = any;
@@ -11,19 +11,19 @@ type Fusion = any;
  * WidgetEnv type represents the environment configuration for a widget.
  */
 export type WidgetEnv<TProps = unknown> = {
-    basename?: string;
-    manifest?: WidgetManifest;
-    props?: TProps;
+  basename?: string;
+  manifest?: WidgetManifest;
+  props?: TProps;
 };
 
 /**
  * IClient interface represents a client with properties and methods for widget-related operations.
  */
 export type IClient = {
-    apiVersion: string;
-    baseImportUrl: string;
-    getWidgetManifest: QueryCtorOptions<WidgetManifest, GetWidgetParameters>;
-    getWidgetConfig: QueryCtorOptions<WidgetConfig, GetWidgetParameters>;
+  apiVersion: string;
+  baseImportUrl: string;
+  getWidgetManifest: QueryCtorOptions<WidgetManifest, GetWidgetParameters>;
+  getWidgetConfig: QueryCtorOptions<WidgetConfig, GetWidgetParameters>;
 };
 
 /**
@@ -35,8 +35,8 @@ export type ModuleDeps = [HttpModule, ServiceDiscoveryModule, EventModule];
  * GetWidgetParameters type represents parameters for retrieving widget information.
  */
 export type GetWidgetParameters = {
-    widgetKey: string;
-    args?: { type: 'version' | 'tag'; value: string };
+  widgetKey: string;
+  args?: { type: 'version' | 'tag'; value: string };
 };
 
 /**
@@ -48,13 +48,13 @@ export type WidgetEndpointBuilder = (args: GetWidgetParameters) => string;
  * WidgetManifest type represents the manifest information of a widget.
  */
 export type WidgetManifest = {
-    id: string;
-    name: string;
-    version: string;
-    description: string;
-    maintainers?: string[];
-    entryPoint: string;
-    assetPath: string;
+  id: string;
+  name: string;
+  version: string;
+  description: string;
+  maintainers?: string[];
+  entryPoint: string;
+  assetPath: string;
 };
 
 /**
@@ -66,16 +66,16 @@ export type Endpoint = { name: string; uri: string; scopes?: string[] };
  * WidgetConfig type represents the configuration for a widget, including environment and endpoints.
  */
 export type WidgetConfig<TEnvironment = unknown> = {
-    environment: TEnvironment;
-    endpoints: Record<string, string | Endpoint>;
+  environment: TEnvironment;
+  endpoints: Record<string, string | Endpoint>;
 };
 
 /**
  * WidgetModules type represents a combination of modules related to events and service discovery.
  */
 export type WidgetModules<TModules extends Array<AnyModule> | unknown = unknown> = CombinedModules<
-    TModules,
-    [EventModule, ServiceDiscoveryModule]
+  TModules,
+  [EventModule, ServiceDiscoveryModule]
 >;
 
 /**
@@ -88,42 +88,42 @@ export type WidgetProps = Record<PropertyKey, unknown>;
  */
 
 export type WidgetRenderArgs<
-    TFusion extends Fusion = Fusion,
-    TEnv = WidgetEnv,
-    TProps extends WidgetProps = WidgetProps,
+  TFusion extends Fusion = Fusion,
+  TEnv = WidgetEnv,
+  TProps extends WidgetProps = WidgetProps,
 > = {
-    fusion: TFusion;
-    env: TEnv;
-    props?: TProps;
+  fusion: TFusion;
+  env: TEnv;
+  props?: TProps;
 };
 
 /**
  * WidgetScriptModule type represents a script module for a widget with functions for rendering, rendering icons, etc.
  */
 export type WidgetScriptModule<TProps extends WidgetProps = WidgetProps> = {
-    default: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-    renderWidget: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-    renderIcon: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
-    render: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
+  default: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
+  renderWidget: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
+  renderIcon: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
+  render: (el: HTMLElement, args: WidgetRenderArgs, props?: TProps) => VoidFunction;
 };
 
 /**
  * WidgetModulesInstance type represents an instance of widget modules.
  */
 export type WidgetModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> =
-    ModulesInstance<WidgetModules<TModules>>;
+  ModulesInstance<WidgetModules<TModules>>;
 
 /**
  * WidgetState type represents the state of a widget, including properties like name, status, config, manifest, modules, and instance.
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type WidgetState<TModules = any> = {
-    name: string;
-    status: Set<string>;
-    config?: WidgetConfig;
-    manifest?: WidgetManifest;
-    modules?: WidgetScriptModule;
-    instance?: WidgetModulesInstance<TModules>;
+  name: string;
+  status: Set<string>;
+  config?: WidgetConfig;
+  manifest?: WidgetManifest;
+  modules?: WidgetScriptModule;
+  instance?: WidgetModulesInstance<TModules>;
 };
 /**
  * WidgetStateInitial type represents an initial state of a widget, omitting the status property.

package/src/utils.ts

@@ -1,51 +1,51 @@
-import { GetWidgetParameters, IClient, WidgetEndpointBuilder } from './types';
-import { IHttpClient } from '@equinor/fusion-framework-module-http';
+import type { GetWidgetParameters, IClient, WidgetEndpointBuilder } from './types';
+import type { IHttpClient } from '@equinor/fusion-framework-module-http';
 
 export const defaultManifestEndpointBuilder =
-    (apiVersion: string): WidgetEndpointBuilder =>
-    (params: GetWidgetParameters) => {
-        const { widgetKey, args } = params;
-        const { type, value } = args ?? {};
-        switch (type) {
-            case 'tag':
-            case 'version':
-                return `/widgets/${widgetKey}/versions/${value}?api-version=${apiVersion}`;
-            default:
-                return `/widgets/${widgetKey}?api-version=${apiVersion}`;
-        }
-    };
+  (apiVersion: string): WidgetEndpointBuilder =>
+  (params: GetWidgetParameters) => {
+    const { widgetKey, args } = params;
+    const { type, value } = args ?? {};
+    switch (type) {
+      case 'tag':
+      case 'version':
+        return `/widgets/${widgetKey}/versions/${value}?api-version=${apiVersion}`;
+      default:
+        return `/widgets/${widgetKey}?api-version=${apiVersion}`;
+    }
+  };
 
 export const defaultConfigEndpointBuilder =
-    (apiVersion: string): WidgetEndpointBuilder =>
-    (params: GetWidgetParameters) => {
-        const { widgetKey, args } = params;
-        const { type, value } = args ?? {};
-        // Todo Align endpoints with backend when its done!
-        switch (type) {
-            case 'tag':
-            case 'version':
-                return `/widgets/${widgetKey}/versions/${value}/config?api-version=${apiVersion}`;
-            default:
-                return `/widgets/${widgetKey}/config?api-version=${apiVersion}`;
-        }
-    };
+  (apiVersion: string): WidgetEndpointBuilder =>
+  (params: GetWidgetParameters) => {
+    const { widgetKey, args } = params;
+    const { type, value } = args ?? {};
+    // Todo Align endpoints with backend when its done!
+    switch (type) {
+      case 'tag':
+      case 'version':
+        return `/widgets/${widgetKey}/versions/${value}/config?api-version=${apiVersion}`;
+      default:
+        return `/widgets/${widgetKey}/config?api-version=${apiVersion}`;
+    }
+  };
 
 export const createDefaultClient = (httpClient: IHttpClient): IClient => {
-    const apiVersion = '1.0-preview';
-    return {
-        apiVersion,
-        baseImportUrl: httpClient.uri,
-        getWidgetManifest: {
-            client: {
-                fn: (args) => httpClient.json$(defaultManifestEndpointBuilder(apiVersion)(args)),
-            },
-            key: (args) => JSON.stringify(args),
-        },
-        getWidgetConfig: {
-            client: {
-                fn: (args) => httpClient.json$(defaultConfigEndpointBuilder(apiVersion)(args)),
-            },
-            key: (args) => JSON.stringify(args),
-        },
-    };
+  const apiVersion = '1.0-preview';
+  return {
+    apiVersion,
+    baseImportUrl: httpClient.uri,
+    getWidgetManifest: {
+      client: {
+        fn: (args) => httpClient.json$(defaultManifestEndpointBuilder(apiVersion)(args)),
+      },
+      key: (args) => JSON.stringify(args),
+    },
+    getWidgetConfig: {
+      client: {
+        fn: (args) => httpClient.json$(defaultConfigEndpointBuilder(apiVersion)(args)),
+      },
+      key: (args) => JSON.stringify(args),
+    },
+  };
 };

package/src/version.ts

@@ -1,2 +1,2 @@
 // Generated by genversion.
-export const version = '9.0.2';
+export const version = '9.0.4';