@equinor/fusion-framework-module-widget 2.0.10 → 3.0.0

package/src/types.ts

@@ -2,22 +2,51 @@ 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';
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 type Fusion = any;
 
-export type WidgetEnv = {
-    config?: WidgetManifest;
+/**
+ * WidgetEnv type represents the environment configuration for a widget.
+ */
+export type WidgetEnv<TProps = unknown> = {
+    basename?: string;
+    manifest?: WidgetManifest;
+    props?: TProps;
 };
 
-// TODO: change to module-services when new app service is created
+/**
+ * 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>;
+};
+
+/**
+ * ModuleDeps type represents a tuple of dependencies required for a module.
+ */
 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 };
 };
 
+/**
+ * WidgetEndpointBuilder type represents a function for building widget endpoints based on GetWidgetParameters.
+ */
+export type WidgetEndpointBuilder = (args: GetWidgetParameters) => string;
+
+/**
+ * WidgetManifest type represents the manifest information of a widget.
+ */
 export type WidgetManifest = {
     id: string;
     name: string;
@@ -26,26 +55,77 @@ export type WidgetManifest = {
     maintainers?: string[];
     entryPoint: string;
     assetPath: string;
-    // TODO move to @equinor/fusion-widget
-    importBundle: () => Promise<WidgetScriptModule>;
 };
 
+/**
+ * Endpoint type represents an endpoint with properties like name, uri, and optional scopes.
+ */
+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>;
+};
+
+/**
+ * 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]
 >;
 
-export type WidgetRenderArgs<TFusion extends Fusion = Fusion, TEnv = WidgetEnv> = {
+/**
+ * WidgetProps type represents widget properties as a record of PropertyKey to unknown.
+ */
+export type WidgetProps = Record<PropertyKey, unknown>;
+
+/**
+ * WidgetRenderArgs type represents arguments for rendering a widget, including fusion, environment, and optional properties.
+ */
+
+export type WidgetRenderArgs<
+    TFusion extends Fusion = Fusion,
+    TEnv = WidgetEnv,
+    TProps extends WidgetProps = WidgetProps,
+> = {
     fusion: TFusion;
     env: TEnv;
+    props?: TProps;
 };
 
-export type WidgetScriptModule<
-    TProps extends Record<PropertyKey, unknown> = Record<PropertyKey, unknown>,
-> = {
+/**
+ * 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;
 };
 
+/**
+ * WidgetModulesInstance type represents an instance of widget modules.
+ */
 export type WidgetModulesInstance<TModules extends Array<AnyModule> | unknown = unknown> =
     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>;
+};
+/**
+ * WidgetStateInitial type represents an initial state of a widget, omitting the status property.
+ */
+export type WidgetStateInitial = Omit<WidgetState, 'status'>;

package/src/utils.ts

@@ -0,0 +1,51 @@
+import { GetWidgetParameters, IClient, WidgetEndpointBuilder } from './types';
+import { 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}`;
+        }
+    };
+
+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}`;
+        }
+    };
+
+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),
+        },
+    };
+};

package/src/version.ts

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

package/tsconfig.json

@@ -4,6 +4,7 @@
     "outDir": "dist/esm",
     "rootDir": "src",
     "declarationDir": "./dist/types",
+    "removeComments": false
     
   },
   "references": [
@@ -13,9 +14,6 @@
     {
       "path": "../module"
     },
-    {
-      "path": "../http"
-    },
     {
       "path": "../event"
     },

package/dist/esm/WidgetModuleConfigBuilder.js

@@ -1,42 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _WidgetModuleConfigBuilder_init;
-export class WidgetModuleConfigBuilder {
-    constructor(init, config = {}) {
-        this.config = config;
-        _WidgetModuleConfigBuilder_init.set(this, void 0);
-        __classPrivateFieldSet(this, _WidgetModuleConfigBuilder_init, init, "f");
-    }
-    requireInstance(module) {
-        return __classPrivateFieldGet(this, _WidgetModuleConfigBuilder_init, "f").requireInstance(module);
-    }
-    setEndpointBuilder(fn) {
-        this.config.endpointBuilder = fn;
-    }
-    setWidgetClient(client, expire = 1 * 60 * 1000) {
-        client;
-        expire;
-        this.config.client = {
-            getWidget: typeof client.getWidget === 'function'
-                ? {
-                    key: (args) => JSON.stringify(args),
-                    client: {
-                        fn: client.getWidget,
-                    },
-                    expire,
-                }
-                : client.getWidget,
-        };
-    }
-}
-_WidgetModuleConfigBuilder_init = new WeakMap();
-//# sourceMappingURL=WidgetModuleConfigBuilder.js.map

package/dist/esm/WidgetModuleConfigBuilder.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"WidgetModuleConfigBuilder.js","sourceRoot":"","sources":["../../src/WidgetModuleConfigBuilder.ts"],"names":[],"mappings":";;;;;;;;;;;;AAcA,MAAM,OAAO,yBAAyB;IAQlC,YACI,IAAW,EACJ,SAAsC,EAAE;QAAxC,WAAM,GAAN,MAAM,CAAkC;QAHnD,kDAAa;QAKT,uBAAA,IAAI,mCAAS,IAAI,MAAA,CAAC;IACtB,CAAC;IASD,eAAe,CAAC,MAAc;QAC1B,OAAO,uBAAA,IAAI,uCAAM,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;IAC9C,CAAC;IAED,kBAAkB,CAAC,EAAyB;QACxC,IAAI,CAAC,MAAM,CAAC,eAAe,GAAG,EAAE,CAAC;IACrC,CAAC;IAED,eAAe,CACX,MAIC,EACD,MAAM,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI;QAEtB,MAAM,CAAC;QACP,MAAM,CAAC;QAEP,IAAI,CAAC,MAAM,CAAC,MAAM,GAAG;YACjB,SAAS,EACL,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;gBAClC,CAAC,CAAC;oBAEI,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;oBACnC,MAAM,EAAE;wBACJ,EAAE,EAAE,MAAM,CAAC,SAAS;qBACvB;oBACD,MAAM;iBACT;gBACH,CAAC,CAAC,MAAM,CAAC,SAAS;SAC7B,CAAC;IACN,CAAC;CACJ"}

package/dist/types/WidgetModuleConfigBuilder.d.ts

@@ -1,19 +0,0 @@
-import { ModuleInitializerArgs, Modules, ModuleType } from '@equinor/fusion-framework-module';
-import { QueryFn, QueryCtorOptions } from '@equinor/fusion-query';
-import { WidgetModuleConfig, IWidgetModuleConfigurator } from './WidgetModuleConfigurator';
-import type { WidgetManifest, ModuleDeps, GetWidgetParameters } from './types';
-export type WidgetModuleConfigBuilderCallback = (builder: WidgetModuleConfigBuilder<ModuleInitializerArgs<IWidgetModuleConfigurator, any>>) => void | Promise<void>;
-export type WidgetEndpointBuilder = (args: GetWidgetParameters) => string;
-export declare class WidgetModuleConfigBuilder<TInit extends ModuleInitializerArgs<IWidgetModuleConfigurator, any> = ModuleInitializerArgs<IWidgetModuleConfigurator, ModuleDeps>> {
-    #private;
-    config: Partial<WidgetModuleConfig>;
-    constructor(init: TInit, config?: Partial<WidgetModuleConfig>);
-    requireInstance<TKey extends string = Extract<keyof Modules, string>>(module: TKey): Promise<ModuleType<Modules[TKey]>>;
-    requireInstance<T>(module: string): Promise<T>;
-    setEndpointBuilder(fn: WidgetEndpointBuilder): void;
-    setWidgetClient(client: {
-        getWidget: QueryFn<WidgetManifest, {
-            widgetKey: string;
-        }> | QueryCtorOptions<WidgetManifest, GetWidgetParameters>;
-    }, expire?: number): void;
-}

package/src/WidgetModuleConfigBuilder.ts

@@ -1,70 +0,0 @@
-import { ModuleInitializerArgs, Modules, ModuleType } from '@equinor/fusion-framework-module';
-import { QueryFn, QueryCtorOptions } from '@equinor/fusion-query';
-
-import { WidgetModuleConfig, IWidgetModuleConfigurator } from './WidgetModuleConfigurator';
-
-import type { WidgetManifest, ModuleDeps, GetWidgetParameters } from './types';
-
-export type WidgetModuleConfigBuilderCallback = (
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    builder: WidgetModuleConfigBuilder<ModuleInitializerArgs<IWidgetModuleConfigurator, any>>,
-) => void | Promise<void>;
-
-export type WidgetEndpointBuilder = (args: GetWidgetParameters) => string;
-
-export class WidgetModuleConfigBuilder<
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    TInit extends ModuleInitializerArgs<IWidgetModuleConfigurator, any> = ModuleInitializerArgs<
-        IWidgetModuleConfigurator,
-        ModuleDeps
-    >,
-> {
-    #init: TInit;
-    constructor(
-        init: TInit,
-        public config: Partial<WidgetModuleConfig> = {},
-    ) {
-        this.#init = init;
-    }
-
-    requireInstance<TKey extends string = Extract<keyof Modules, string>>(
-        module: TKey,
-    ): Promise<ModuleType<Modules[TKey]>>;
-
-    requireInstance<T>(module: string): Promise<T>;
-
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    requireInstance(module: string): Promise<any> {
-        return this.#init.requireInstance(module);
-    }
-
-    setEndpointBuilder(fn: WidgetEndpointBuilder): void {
-        this.config.endpointBuilder = fn;
-    }
-
-    setWidgetClient(
-        client: {
-            getWidget:
-                | QueryFn<WidgetManifest, { widgetKey: string }>
-                | QueryCtorOptions<WidgetManifest, GetWidgetParameters>;
-        },
-        expire = 1 * 60 * 1000,
-    ) {
-        client;
-        expire;
-
-        this.config.client = {
-            getWidget:
-                typeof client.getWidget === 'function'
-                    ? {
-                          // TODO - might cast to checksum
-                          key: (args) => JSON.stringify(args),
-                          client: {
-                              fn: client.getWidget,
-                          },
-                          expire,
-                      }
-                    : client.getWidget,
-        };
-    }
-}