piral-blazor 1.0.0-pre.2217 → 1.0.0

package/src/types.ts

@@ -1,4 +1,76 @@
-import type { ForeignComponent } from 'piral-core';
+import type { ForeignComponent, PiletApi } from 'piral-core';
+
+export type BlazorRootConfig = [
+  root: HTMLDivElement,
+  capabilities: Array<string>,
+  applyChanges: (pilet: PiletApi) => void,
+];
+
+export interface BlazorDependencyLoader {
+  (config: BlazorRootConfig): Promise<void>;
+}
+
+export type WebAssemblyBootResourceType = 'assembly' | 'pdb' | 'dotnetjs' | 'dotnetwasm' | 'globalization' | 'manifest';
+
+export interface WebAssemblyStartOptions {
+  /**
+   * Overrides the built-in boot resource loading mechanism so that boot resources can be fetched
+   * from a custom source, such as an external CDN.
+   * @param type The type of the resource to be loaded.
+   * @param name The name of the resource to be loaded.
+   * @param defaultUri The URI from which the framework would fetch the resource by default. The URI may be relative or absolute.
+   * @param integrity The integrity string representing the expected content in the response.
+   * @returns A URI string or a Response promise to override the loading process, or null/undefined to allow the default loading behavior.
+   */
+  loadBootResource?(
+    type: WebAssemblyBootResourceType,
+    name: string,
+    defaultUri: string,
+    integrity: string,
+  ): string | Promise<Response> | null | undefined;
+  /**
+   * Override built-in environment setting on start.
+   */
+  environment?: string;
+  /**
+   * Gets the application culture. This is a name specified in the BCP 47 format. See https://tools.ietf.org/html/bcp47
+   */
+  applicationCulture?: string;
+}
+
+declare global {
+  interface Window {
+    Blazor: {
+      start(options?: Partial<WebAssemblyStartOptions>): Promise<void>;
+      emitPiralEvent(type: string, args: any): void;
+      emitRenderEvent(
+        source: HTMLElement,
+        name: string,
+        params: any,
+        sourceRef: any,
+        fallbackComponent: string | null,
+      ): void;
+      emitNavigateEvent(target: Element, path: string, replace?: boolean, state?: any): void;
+      _internal: {
+        navigationManager: any;
+        applyHotReload: any;
+        NavigationLock: any;
+      };
+    };
+    DotNet: any;
+    $blazorLoader: Promise<BlazorRootConfig>;
+    $blazorDependencyPrios: Array<{
+      prio: number;
+      load(): Promise<void>;
+    }>;
+    $blazorDependencies: Array<{
+      name: string;
+      url: string;
+      count: number;
+      promise: Promise<void>;
+    }>;
+  }
+}
 
 declare module 'piral-core/lib/types/custom' {
   interface PiletCustomApi extends PiletBlazorApi {}
@@ -8,6 +80,26 @@ declare module 'piral-core/lib/types/custom' {
   }
 }
 
+export const enum BlazorLogLevel {
+  trace = 0,
+  debug = 1,
+  info = 2,
+  warn = 3,
+  error = 4,
+  critical = 5,
+  none = 6,
+}
+
+/**
+ * Additional options for the Blazor component
+ */
+export interface BlazorOptions {
+  /**
+   * The root path where resources are located.
+   */
+  resourcePathRoot?: string;
+}
+
 export interface BlazorComponent {
   /**
    * The name of the Blazor module to render.
@@ -21,11 +113,15 @@ export interface BlazorComponent {
    * An optional dependency that needs to load before
    * the component can be properly displayed.
    */
-  dependency?: () => Promise<void>;
+  dependency?: BlazorDependencyLoader;
   /**
    * The type of the Blazor component.
    */
   type: 'blazor';
+  /**
+   * Additional options for the Blazor component.
+   */
+  options?: BlazorOptions;
 }
 
 /**
@@ -33,15 +129,30 @@ export interface BlazorComponent {
  */
 export interface PiletBlazorApi {
   /**
-   * Defines the additional libraries to Blazor via their URLs.
+   * Defines the additional libraries (and their symbols) to Blazor via
+   * their URLs.
+   *
    * @param referenceUrls The URLs pointing to the different DLLs to include.
+   * @param satellites The URLs of the potential satellite DLLs to include.
+   * @param prio The loading priority of the DLLs. Higher numbers will always be loaded before lower numbers.
    */
-  defineBlazorReferences(referenceUrls: Array<string>): void;
+  defineBlazorReferences(referenceUrls: Array<string>, satellites?: Record<string, Array<string>>, prio?: number): void;
   /**
    * Wraps a Blazor module for use in Piral.
+   *
    * @param moduleName The name of the exposed Blazor component.
    * @param args The optional props to use as arguments for the Blazor component.
    * @returns The Piral Blazor component.
    */
   fromBlazor(moduleName: string, args?: Record<string, any>): BlazorComponent;
+  /**
+   * Defines the additional options to be shared by all Blazor components.
+   *
+   * @param options The options for the Blazor components.
+   */
+  defineBlazorOptions(options: BlazorOptions): void;
+  /**
+   * Releases all defined blazor references from the current pilet.
+   */
+  releaseBlazorReferences(): void;
 }

package/convert.ts

@@ -1,17 +0,0 @@
-import type { HtmlComponent } from 'piral-core';
-import { createConverter } from './lib/converter';
-import { createDependencyLoader } from './lib/dependencies';
-
-const convert = createConverter();
-const loader = createDependencyLoader(convert);
-
-export interface BlazorConverter {
-  (...params: Parameters<typeof convert>): HtmlComponent<any>;
-}
-
-export const fromBlazor: BlazorConverter = (moduleName, dependency, args) => ({
-  type: 'html',
-  component: convert(moduleName, dependency, args),
-});
-
-export const defineBlazorReferences = loader.defineBlazorReferences;

package/esm/internal/Environment.d.ts

@@ -1,3 +0,0 @@
-import { Platform } from './Platform/Platform';
-export declare let platform: Platform;
-export declare function setPlatform(platformInstance: Platform): Platform;

package/esm/internal/Environment.js

@@ -1,6 +0,0 @@
-export var platform;
-export function setPlatform(platformInstance) {
-    platform = platformInstance;
-    return platform;
-}
-//# sourceMappingURL=Environment.js.map

package/esm/internal/Environment.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Environment.js","sourceRoot":"","sources":["../../src/internal/Environment.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,IAAI,QAAkB,CAAC;AAE9B,MAAM,UAAU,WAAW,CAAC,gBAA0B;IACpD,QAAQ,GAAG,gBAAgB,CAAC;IAC5B,OAAO,QAAQ,CAAC;AAClB,CAAC"}

package/esm/internal/Platform/BootConfig.d.ts

@@ -1,20 +0,0 @@
-export interface BootJsonData {
-    entryAssembly: string;
-    resources: ResourceGroups;
-    debugBuild: boolean;
-    linkerEnabled: boolean;
-    cacheBootResources: boolean;
-    config: Array<string>;
-}
-export interface ResourceGroups {
-    assembly: ResourceList;
-    pdb?: ResourceList;
-    runtime: ResourceList;
-    satelliteResources?: Record<string, ResourceList>;
-}
-export declare type ResourceList = Record<string, string>;
-export declare class BootConfigResult {
-    bootConfig: BootJsonData;
-    applicationEnvironment: string;
-    constructor(bootConfig: BootJsonData, applicationEnvironment?: string);
-}

package/esm/internal/Platform/BootConfig.js

@@ -1,10 +0,0 @@
-var BootConfigResult = /** @class */ (function () {
-    function BootConfigResult(bootConfig, applicationEnvironment) {
-        if (applicationEnvironment === void 0) { applicationEnvironment = 'Production'; }
-        this.bootConfig = bootConfig;
-        this.applicationEnvironment = applicationEnvironment;
-    }
-    return BootConfigResult;
-}());
-export { BootConfigResult };
-//# sourceMappingURL=BootConfig.js.map

package/esm/internal/Platform/BootConfig.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BootConfig.js","sourceRoot":"","sources":["../../../src/internal/Platform/BootConfig.ts"],"names":[],"mappings":"AAkBA;IACE,0BAAmB,UAAwB,EAAS,sBAAqC;QAArC,uCAAA,EAAA,qCAAqC;QAAtE,eAAU,GAAV,UAAU,CAAc;QAAS,2BAAsB,GAAtB,sBAAsB,CAAe;IAAG,CAAC;IAC/F,uBAAC;AAAD,CAAC,AAFD,IAEC"}

package/esm/internal/Platform/Mono/MonoDebugger.d.ts

@@ -1,3 +0,0 @@
-import { WebAssemblyResourceLoader } from '../WebAssemblyResourceLoader';
-export declare function hasDebuggingEnabled(): boolean;
-export declare function attachDebuggerHotkey(resourceLoader: WebAssemblyResourceLoader): void;

package/esm/internal/Platform/Mono/MonoDebugger.js

@@ -1,43 +0,0 @@
-var currentBrowserIsChrome = window.chrome && navigator.userAgent.indexOf('Edge') < 0; // Edge pretends to be Chrome
-var hasReferencedPdbs = false;
-export function hasDebuggingEnabled() {
-    return hasReferencedPdbs && currentBrowserIsChrome;
-}
-export function attachDebuggerHotkey(resourceLoader) {
-    hasReferencedPdbs = !!resourceLoader.bootConfig.resources.pdb;
-    // Use the combination shift+alt+D because it isn't used by the major browsers
-    // for anything else by default
-    var altKeyName = navigator.platform.match(/^Mac/i) ? 'Cmd' : 'Alt';
-    if (hasDebuggingEnabled()) {
-        console.info("Debugging hotkey: Shift+" + altKeyName + "+D (when application has focus)");
-    }
-    // Even if debugging isn't enabled, we register the hotkey so we can report why it's not enabled
-    document.addEventListener('keydown', function (evt) {
-        if (evt.shiftKey && (evt.metaKey || evt.altKey) && evt.code === 'KeyD') {
-            if (!hasReferencedPdbs) {
-                console.error('Cannot start debugging, because the application was not compiled with debugging enabled.');
-            }
-            else if (!currentBrowserIsChrome) {
-                console.error('Currently, only Microsoft Edge (80+), or Google Chrome, are supported for debugging.');
-            }
-            else {
-                launchDebugger();
-            }
-        }
-    });
-}
-function launchDebugger() {
-    // The noopener flag is essential, because otherwise Chrome tracks the association with the
-    // parent tab, and then when the parent tab pauses in the debugger, the child tab does so
-    // too (even if it's since navigated to a different page). This means that the debugger
-    // itself freezes, and not just the page being debugged.
-    //
-    // We have to construct a link element and simulate a click on it, because the more obvious
-    // window.open(..., 'noopener') always opens a new window instead of a new tab.
-    var link = document.createElement('a');
-    link.href = "_framework/debug?url=" + encodeURIComponent(location.href);
-    link.target = '_blank';
-    link.rel = 'noopener noreferrer';
-    link.click();
-}
-//# sourceMappingURL=MonoDebugger.js.map

package/esm/internal/Platform/Mono/MonoDebugger.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"MonoDebugger.js","sourceRoot":"","sources":["../../../../src/internal/Platform/Mono/MonoDebugger.ts"],"names":[],"mappings":"AAEA,IAAM,sBAAsB,GAAI,MAAc,CAAC,MAAM,IAAI,SAAS,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,6BAA6B;AAE/H,IAAI,iBAAiB,GAAG,KAAK,CAAC;AAE9B,MAAM,UAAU,mBAAmB;IACjC,OAAO,iBAAiB,IAAI,sBAAsB,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,cAAyC;IAC5E,iBAAiB,GAAG,CAAC,CAAC,cAAc,CAAC,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC;IAE9D,8EAA8E;IAC9E,+BAA+B;IAC/B,IAAM,UAAU,GAAG,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;IACrE,IAAI,mBAAmB,EAAE,EAAE;QACzB,OAAO,CAAC,IAAI,CAAC,6BAA2B,UAAU,oCAAiC,CAAC,CAAC;KACtF;IAED,gGAAgG;IAChG,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,UAAC,GAAG;QACvC,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM,EAAE;YACtE,IAAI,CAAC,iBAAiB,EAAE;gBACtB,OAAO,CAAC,KAAK,CAAC,0FAA0F,CAAC,CAAC;aAC3G;iBAAM,IAAI,CAAC,sBAAsB,EAAE;gBAClC,OAAO,CAAC,KAAK,CAAC,sFAAsF,CAAC,CAAC;aACvG;iBAAM;gBACL,cAAc,EAAE,CAAC;aAClB;SACF;IACH,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,cAAc;IACrB,2FAA2F;IAC3F,yFAAyF;IACzF,uFAAuF;IACvF,wDAAwD;IACxD,EAAE;IACF,2FAA2F;IAC3F,+EAA+E;IAC/E,IAAM,IAAI,GAAG,QAAQ,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,GAAG,0BAAwB,kBAAkB,CAAC,QAAQ,CAAC,IAAI,CAAG,CAAC;IACxE,IAAI,CAAC,MAAM,GAAG,QAAQ,CAAC;IACvB,IAAI,CAAC,GAAG,GAAG,qBAAqB,CAAC;IACjC,IAAI,CAAC,KAAK,EAAE,CAAC;AACf,CAAC"}

package/esm/internal/Platform/Mono/MonoPlatform.d.ts

@@ -1,2 +0,0 @@
-import { Platform } from '../Platform';
-export declare const monoPlatform: Platform;