@equinor/fusion-framework-module-app 8.0.3 → 8.0.5

package/dist/types/AppConfigurator.d.ts

@@ -43,6 +43,7 @@ export interface IAppConfigurator {
  * via service discovery. The default `assetUri` is `'/apps-proxy'`.
  */
 export declare class AppConfigurator extends BaseConfigBuilder<AppModuleConfig> implements IAppConfigurator {
+    /** Default cache expiration time, in milliseconds, for the app service client. */
     defaultExpireTime: number;
     /**
      * Creates the default HTTP client for the app service, preferring a pre-configured

package/dist/types/app/App.d.ts

@@ -289,6 +289,7 @@ export declare class App<TEnv extends ConfigEnvironment = ConfigEnvironment, TMo
     getAppModule(force_refresh?: boolean): Observable<AppScriptModule>;
     /** @inheritdoc */
     getAppModuleAsync(allow_cache?: boolean): Promise<AppScriptModule>;
+    /** Releases resources held by this app instance. */
     dispose: VoidFunction;
 }
 export default App;

package/dist/types/schemas.d.ts

@@ -18,6 +18,22 @@ export declare const ApiAppConfigSchema: z.ZodObject<{
     }, z.core.$strip>>>;
 }, z.core.$strip>;
 export type ApiAppConfig = z.infer<typeof ApiAppConfigSchema>;
+/**
+ * Schema for validating the options object on application builds.
+ *
+ * Known properties:
+ * - `contextRouting` (optional): Routing strategy for context — `'path'` or `'query'`.
+ *
+ * The schema uses `.catchall(z.unknown())` to permit additional properties
+ * at runtime without requiring them to be declared here. Add known properties
+ * to this schema as they are introduced.
+ */
+export declare const FrameworkOptionsSchema: z.ZodObject<{
+    contextRouting: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        path: "path";
+        query: "query";
+    }>>>;
+}, z.core.$catchall<z.ZodUnknown>>;
 /**
  * Schema for validating the structure of an API application build.
  *
@@ -33,6 +49,7 @@ export type ApiAppConfig = z.infer<typeof ApiAppConfigSchema>;
  * - `githubRepo`: An optional GitHub repository associated with the build.
  * - `projectPage`: An optional project page URL.
  * - `allowedExtensions`: An optional array of allowed extensions for the build.
+ * - `options`: An optional record of additional build options, where the key is a string and the value can be of any type.
  * - `uploadedBy`: An optional schema for the person who uploaded the build.
  */
 export declare const ApiApplicationBuildSchema: z.ZodObject<{
@@ -46,6 +63,12 @@ export declare const ApiApplicationBuildSchema: z.ZodObject<{
     commitSha: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     githubRepo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     projectPage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    options: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+        contextRouting: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            path: "path";
+            query: "query";
+        }>>>;
+    }, z.core.$catchall<z.ZodUnknown>>>>>;
     allowedExtensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
     uploadedBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         azureUniqueId: z.ZodString;
@@ -133,6 +156,12 @@ export declare const ApiApplicationSchema: z.ZodObject<{
         commitSha: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         githubRepo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         projectPage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        options: z.ZodDefault<z.ZodOptional<z.ZodNullable<z.ZodObject<{
+            contextRouting: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                path: "path";
+                query: "query";
+            }>>>;
+        }, z.core.$catchall<z.ZodUnknown>>>>>;
         allowedExtensions: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         uploadedBy: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             azureUniqueId: z.ZodString;

package/dist/types/types.d.ts

@@ -93,6 +93,36 @@ export type RouteSchemaEntry = [
         search?: Record<string, string>;
     }
 ];
+/**
+ * Typed representation of the options object.
+ *
+ * Only known keys are declared in the type — additional properties are
+ * handled by the Zod schema at runtime. Keeping the type narrow avoids
+ * structural incompatibilities with `RecursivePartial<AppManifest>`.
+ */
+export type FrameworkOptions = {
+    /**
+     * Declares how the portal should encode this app's active context into the URL.
+     *
+     * Read by the `@equinor/fusion-framework-plugin-context-navigation` plugin
+     * to select the correct adapter at runtime.
+     *
+     * - `'path'`  — context id as a path segment: `/apps/{appKey}/{contextId}/...`
+     * - `'query'` — context id as a query parameter: `/apps/{appKey}/...?$contextId={id}`
+     * - `null`    — explicitly opt out of automatic context-to-URL encoding
+     * - `undefined` (omitted) — falls back to `'path'` (the default adapter)
+     *
+     * Apps with custom URL shapes should omit this field and register
+     * `setContextPathExtractor` / `setContextPathGenerator` hooks instead —
+     * the custom adapter picks those up automatically.
+     *
+     * Set this in the app manifest's `build.options.contextRouting` field,
+     * either in `app.manifest.config.ts` or via the app service manifest.
+     *
+     * @default undefined (falls back to path adapter)
+     */
+    contextRouting?: 'path' | 'query' | null;
+};
 /**
  * Build metadata returned by the app service for a specific application version.
  * Contains the script entry point, asset path, tags, and optional CI metadata.
@@ -109,6 +139,7 @@ export type AppBuildManifest = {
     githubRepo?: Nullable<string>;
     projectPage?: Nullable<string>;
     annotations?: Nullable<Record<string, string>>;
+    options?: Nullable<FrameworkOptions>;
     allowedExtensions?: Nullable<string[]>;
     uploadedBy?: Nullable<AppOwner>;
 };

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const version = "8.0.3";
+export declare const version = "8.0.5";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@equinor/fusion-framework-module-app",
-  "version": "8.0.3",
+  "version": "8.0.5",
   "description": "",
   "main": "dist/esm/index.js",
   "exports": {
@@ -62,13 +62,13 @@
     "uuid": "^14.0.0",
     "zod": "^4.4.3",
     "@equinor/fusion-observable": "^9.1.1",
-    "@equinor/fusion-query": "^7.0.2"
+    "@equinor/fusion-query": "^7.0.3"
   },
   "devDependencies": {
     "typescript": "^7.0.2",
-    "@equinor/fusion-framework-module": "^6.1.1",
+    "@equinor/fusion-framework-module": "^6.1.2",
     "@equinor/fusion-framework-module-event": "^6.0.1",
-    "@equinor/fusion-framework-module-http": "^8.0.4",
+    "@equinor/fusion-framework-module-http": "^8.0.5",
     "@equinor/fusion-framework-module-msal": "^10.0.2",
     "@equinor/fusion-framework-module-service-discovery": "^10.0.2"
   },

package/src/AppConfigurator.ts

@@ -59,6 +59,7 @@ export class AppConfigurator
   extends BaseConfigBuilder<AppModuleConfig>
   implements IAppConfigurator
 {
+  /** Default cache expiration time, in milliseconds, for the app service client. */
   defaultExpireTime = 1 * 60 * 1000;
 
   /**

package/src/app/App.ts

@@ -977,6 +977,7 @@ export class App<
     return operator(this.getAppModule(!allow_cache));
   }
 
+  /** Releases resources held by this app instance. */
   public dispose: VoidFunction;
 }
 

package/src/schemas.ts

@@ -60,6 +60,28 @@ const ApiApplicationPersonSchema = z.object({
     .nullish(),
 });
 
+/**
+ * Schema for validating the options object on application builds.
+ *
+ * Known properties:
+ * - `contextRouting` (optional): Routing strategy for context — `'path'` or `'query'`.
+ *
+ * The schema uses `.catchall(z.unknown())` to permit additional properties
+ * at runtime without requiring them to be declared here. Add known properties
+ * to this schema as they are introduced.
+ */
+// Deliberately co-located with ApiApplicationBuildSchema, which depends on it
+// fusion-lint-disable-next-line single-export-per-file
+export const FrameworkOptionsSchema = z
+  .object({
+    contextRouting: z
+      .enum(['path', 'query'], {
+        message: "The routing strategy for context, which can be either 'path' or 'query'.",
+      })
+      .nullish(),
+  })
+  .catchall(z.unknown());
+
 /**
  * Schema for validating the structure of an API application build.
  *
@@ -75,6 +97,7 @@ const ApiApplicationPersonSchema = z.object({
  * - `githubRepo`: An optional GitHub repository associated with the build.
  * - `projectPage`: An optional project page URL.
  * - `allowedExtensions`: An optional array of allowed extensions for the build.
+ * - `options`: An optional record of additional build options, where the key is a string and the value can be of any type.
  * - `uploadedBy`: An optional schema for the person who uploaded the build.
  */
 // Deliberately co-located with ApiApplicationPersonSchema, which it depends on
@@ -90,6 +113,9 @@ export const ApiApplicationBuildSchema = z.object({
   commitSha: z.string().nullish(),
   githubRepo: z.string().nullish(),
   projectPage: z.string().nullish(),
+  options: FrameworkOptionsSchema.nullish().default({
+    contextRouting: 'path',
+  }),
   allowedExtensions: z.array(z.string()).nullish(),
   uploadedBy: ApiApplicationPersonSchema.nullish(),
 });

package/src/types.ts

@@ -117,6 +117,37 @@ export type RouteSchemaEntry = [
   },
 ];
 
+/**
+ * Typed representation of the options object.
+ *
+ * Only known keys are declared in the type — additional properties are
+ * handled by the Zod schema at runtime. Keeping the type narrow avoids
+ * structural incompatibilities with `RecursivePartial<AppManifest>`.
+ */
+export type FrameworkOptions = {
+  /**
+   * Declares how the portal should encode this app's active context into the URL.
+   *
+   * Read by the `@equinor/fusion-framework-plugin-context-navigation` plugin
+   * to select the correct adapter at runtime.
+   *
+   * - `'path'`  — context id as a path segment: `/apps/{appKey}/{contextId}/...`
+   * - `'query'` — context id as a query parameter: `/apps/{appKey}/...?$contextId={id}`
+   * - `null`    — explicitly opt out of automatic context-to-URL encoding
+   * - `undefined` (omitted) — falls back to `'path'` (the default adapter)
+   *
+   * Apps with custom URL shapes should omit this field and register
+   * `setContextPathExtractor` / `setContextPathGenerator` hooks instead —
+   * the custom adapter picks those up automatically.
+   *
+   * Set this in the app manifest's `build.options.contextRouting` field,
+   * either in `app.manifest.config.ts` or via the app service manifest.
+   *
+   * @default undefined (falls back to path adapter)
+   */
+  contextRouting?: 'path' | 'query' | null;
+};
+
 /**
  * Build metadata returned by the app service for a specific application version.
  * Contains the script entry point, asset path, tags, and optional CI metadata.
@@ -133,6 +164,7 @@ export type AppBuildManifest = {
   githubRepo?: Nullable<string>;
   projectPage?: Nullable<string>;
   annotations?: Nullable<Record<string, string>>;
+  options?: Nullable<FrameworkOptions>;
   allowedExtensions?: Nullable<string[]>;
   uploadedBy?: Nullable<AppOwner>;
 };

package/src/version.ts

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