@rindo/core 2.18.0 → 2.22.3

package/internal/rindo-private.d.ts

@@ -1,7 +1,6 @@
-import { BuildResultsComponentGraph } from '.';
-import type { BuildEvents, BuildLog, CompilerBuildResults, CompilerBuildStart, CompilerFsStats, CompilerRequestResponse, CompilerSystem, Config, CopyResults, DevServerConfig, DevServerEditor, Diagnostic, Logger, LoggerTimeSpan, OptimizeCssInput, OptimizeCssOutput, OutputTargetWww, PageReloadStrategy, PrerenderConfig, StyleDoc, LoggerLineUpdater, TaskCommand } from './rindo-public-compiler';
-import type { ComponentInterface, ListenOptions, ListenTargetOptions, VNode, VNodeData } from './rindo-public-runtime';
 import type { InMemoryFileSystem } from '../compiler/sys/in-memory-fs';
+import type { BuildEvents, BuildLog, BuildResultsComponentGraph, CompilerBuildResults, CompilerBuildStart, CompilerFsStats, CompilerRequestResponse, CompilerSystem, Config, CopyResults, DevServerConfig, DevServerEditor, Diagnostic, Logger, LoggerLineUpdater, LoggerTimeSpan, OptimizeCssInput, OptimizeCssOutput, OutputTargetWww, PageReloadStrategy, PrerenderConfig, StyleDoc, TaskCommand } from './rindo-public-compiler';
+import type { ComponentInterface, ListenOptions, ListenTargetOptions, VNode, VNodeData } from './rindo-public-runtime';
 export interface SourceMap {
     file: string;
     mappings: string;
@@ -133,7 +132,7 @@ export interface BuildConditionals extends Partial<BuildFeatures> {
     transformTagName?: boolean;
     attachStyles?: boolean;
 }
-export declare type ModuleFormat = 'amd' | 'cjs' | 'es' | 'iife' | 'system' | 'umd' | 'commonjs' | 'esm' | 'module' | 'systemjs';
+export type ModuleFormat = 'amd' | 'cjs' | 'es' | 'iife' | 'system' | 'umd' | 'commonjs' | 'esm' | 'module' | 'systemjs';
 export interface RollupResultModule {
     id: string;
 }
@@ -212,8 +211,8 @@ export interface BuildStyleUpdate {
     styleText: string;
     styleMode: string;
 }
-export declare type BuildTask = any;
-export declare type BuildStatus = 'pending' | 'error' | 'disabled' | 'default';
+export type BuildTask = any;
+export type BuildStatus = 'pending' | 'error' | 'disabled' | 'default';
 export interface CompilerBuildStats {
     timestamp: string;
     compiler: {
@@ -304,7 +303,7 @@ export interface BundleOutputChunk {
     };
     name: string;
 }
-export declare type SourceTarget = 'es5' | 'es2017' | 'latest';
+export type SourceTarget = 'es5' | 'es2017' | 'latest';
 export interface BundleEntryInputs {
     [entryKey: string]: string;
 }
@@ -314,7 +313,7 @@ export interface BundleEntryInputs {
  * Rindo source. As a result, some types are duplicated here for Rollup that will be used within the codebase.
  * Updates to rollup may require these typings to be updated.
  */
-export declare type RollupResult = RollupChunkResult | RollupAssetResult;
+export type RollupResult = RollupChunkResult | RollupAssetResult;
 export interface RollupAssetResult {
     type: 'asset';
     fileName: string;
@@ -347,7 +346,7 @@ export interface RollupSourceMap {
 /**
  * Result of Rindo compressing, mangling, and otherwise 'minifying' JavaScript
  */
-export declare type OptimizeJsResult = {
+export type OptimizeJsResult = {
     output: string;
     diagnostics: Diagnostic[];
     sourceMap?: SourceMap;
@@ -400,7 +399,7 @@ export interface CollectionManifest {
     compiler?: CollectionCompilerVersion;
     bundles?: CollectionBundleManifest[];
 }
-export declare type CollectionComponentEntryPath = string;
+export type CollectionComponentEntryPath = string;
 export interface CollectionBundleManifest {
     components: string[];
 }
@@ -550,8 +549,8 @@ export interface BuildOutputFile {
     name: string;
     content: string;
 }
-export declare type OnCallback = (buildStart: CompilerBuildStart) => void;
-export declare type RemoveCallback = () => boolean;
+export type OnCallback = (buildStart: CompilerBuildStart) => void;
+export type RemoveCallback = () => boolean;
 export interface CompilerCtx {
     version: number;
     activeBuildId: number;
@@ -585,7 +584,7 @@ export interface CompilerCtx {
     rollupCache: Map<string, any>;
     reset(): void;
 }
-export declare type NodeMap = WeakMap<any, ComponentCompilerMeta>;
+export type NodeMap = WeakMap<any, ComponentCompilerMeta>;
 /** Must be serializable to JSON!! */
 export interface ComponentCompilerFeatures {
     hasAttribute: boolean;
@@ -682,7 +681,7 @@ export interface ComponentCompilerLegacyContext {
     name: string;
     context: string;
 }
-export declare type Encapsulation = 'shadow' | 'scoped' | 'none';
+export type Encapsulation = 'shadow' | 'scoped' | 'none';
 /**
  * Intermediate Representation (IR) of a static property on a Rindo component
  */
@@ -709,7 +708,7 @@ export interface ComponentCompilerVirtualProperty {
     type: string;
     docs: string;
 }
-export declare type ComponentCompilerPropertyType = 'any' | 'string' | 'boolean' | 'number' | 'unknown';
+export type ComponentCompilerPropertyType = 'any' | 'string' | 'boolean' | 'number' | 'unknown';
 export interface ComponentCompilerPropertyComplexType {
     original: string;
     resolved: string;
@@ -723,7 +722,7 @@ export interface ComponentCompilerPropertyComplexType {
  *
  * Note any key can be a user defined type or a TypeScript standard type.
  */
-export declare type ComponentCompilerTypeReferences = Record<string, ComponentCompilerTypeReference>;
+export type ComponentCompilerTypeReferences = Record<string, ComponentCompilerTypeReference>;
 /**
  * Describes a reference to a type used by a component.
  */
@@ -785,12 +784,30 @@ export interface ComponentCompilerMethod extends ComponentCompilerStaticMethod {
 export interface ComponentCompilerState {
     name: string;
 }
+/**
+ * Representation of JSDoc that is pulled off a node in the AST
+ */
 export interface CompilerJsDoc {
+    /**
+     * The text associated with the JSDoc
+     */
     text: string;
+    /**
+     * Tags included in the JSDoc
+     */
     tags: CompilerJsDocTagInfo[];
 }
+/**
+ * Representation of a tag that exists in a JSDoc
+ */
 export interface CompilerJsDocTagInfo {
+    /**
+     * The name of the tag - e.g. `@deprecated`
+     */
     name: string;
+    /**
+     * Additional text that is associated with the tag - e.g. `@deprecated use v2 of this API`
+     */
     text?: string;
 }
 export interface CompilerStyleDoc {
@@ -824,6 +841,10 @@ export interface ComponentConstructor {
     isProxied?: boolean;
     isStyleRegistered?: boolean;
 }
+/**
+ * A mapping from class member names to a list of methods which are watching
+ * them.
+ */
 export interface ComponentConstructorWatchers {
     [propName: string]: string[];
 }
@@ -833,15 +854,15 @@ export interface ComponentTestingConstructor extends ComponentConstructor {
         componentWillLoad?: Function;
         componentWillUpdate?: Function;
         componentWillRender?: Function;
-        __componentWillLoad?: Function;
-        __componentWillUpdate?: Function;
-        __componentWillRender?: Function;
+        __componentWillLoad?: Function | null;
+        __componentWillUpdate?: Function | null;
+        __componentWillRender?: Function | null;
     };
 }
 export interface ComponentNativeConstructor extends ComponentConstructor {
     cmpMeta: ComponentRuntimeMeta;
 }
-export declare type ComponentConstructorEncapsulation = 'shadow' | 'scoped' | 'none';
+export type ComponentConstructorEncapsulation = 'shadow' | 'scoped' | 'none';
 export interface ComponentConstructorProperties {
     [propName: string]: ComponentConstructorProperty;
 }
@@ -855,7 +876,7 @@ export interface ComponentConstructorProperty {
     type?: ComponentConstructorPropertyType;
     watchCallbacks?: string[];
 }
-export declare type ComponentConstructorPropertyType = StringConstructor | BooleanConstructor | NumberConstructor | 'string' | 'boolean' | 'number';
+export type ComponentConstructorPropertyType = StringConstructor | BooleanConstructor | NumberConstructor | 'string' | 'boolean' | 'number';
 export interface ComponentConstructorEvent {
     name: string;
     method: string;
@@ -940,24 +961,21 @@ export interface DevServerMessage {
         status: number;
     };
 }
-export declare type DevServerSendMessage = (msg: DevServerMessage) => void;
+export type DevServerSendMessage = (msg: DevServerMessage) => void;
 export interface DevServerContext {
     connectorHtml: string;
     dirTemplate: string;
     getBuildResults: () => Promise<CompilerBuildResults>;
     getCompilerRequest: (path: string) => Promise<CompilerRequestResponse>;
     isServerListening: boolean;
-    logRequest: (req: {
-        method: string;
-        pathname?: string;
-    }, status: number) => void;
+    logRequest: (req: HttpRequest, status: number) => void;
     prerenderConfig: PrerenderConfig;
     serve302: (req: any, res: any, pathname?: string) => void;
     serve404: (req: any, res: any, xSource: string, content?: string) => void;
     serve500: (req: any, res: any, error: any, xSource: string) => void;
     sys: CompilerSystem;
 }
-export declare type InitServerProcess = (sendMsg: (msg: DevServerMessage) => void) => (msg: DevServerMessage) => void;
+export type InitServerProcess = (sendMsg: (msg: DevServerMessage) => void) => (msg: DevServerMessage) => void;
 export interface DevResponseHeaders {
     'cache-control'?: string;
     expires?: string;
@@ -1137,7 +1155,7 @@ export interface MinifyJsResult {
         pos: number;
     };
 }
-export declare type ModuleMap = Map<string, Module>;
+export type ModuleMap = Map<string, Module>;
 /**
  * Rindo's Intermediate Representation (IR) of a module, bundling together
  * various pieces of information like the classes declared within it, the path
@@ -1302,13 +1320,13 @@ export interface RenderNode extends HostElement {
      */
     ['s-en']?: '' | /*shadow*/ 'c';
 }
-export declare type LazyBundlesRuntimeData = LazyBundleRuntimeData[];
-export declare type LazyBundleRuntimeData = [
+export type LazyBundlesRuntimeData = LazyBundleRuntimeData[];
+export type LazyBundleRuntimeData = [
     /** bundleIds */
     string,
     ComponentRuntimeMetaCompact[]
 ];
-export declare type ComponentRuntimeMetaCompact = [
+export type ComponentRuntimeMetaCompact = [
     /** flags */
     number,
     /** tagname */
@@ -1320,47 +1338,87 @@ export declare type ComponentRuntimeMetaCompact = [
     /** listeners */
     ComponentRuntimeHostListener[]?
 ];
+/**
+ * Runtime metadata for a Rindo component
+ */
 export interface ComponentRuntimeMeta {
+    /**
+     * This number is used to hold a series of bitflags for various features we
+     * support on components. The flags which this value is intended to store are
+     * documented in the {@link CMP_FLAGS} enum.
+     */
     $flags$: number;
+    /**
+     * Just what it says on the tin - the tag name for the component, as set in
+     * the `@Component` decorator.
+     */
     $tagName$: string;
-    $members$?: ComponentRuntimeMembers;
-    $listeners$?: ComponentRuntimeHostListener[];
-    $attrsToReflect$?: [string, string][];
-    $watchers$?: ComponentConstructorWatchers;
-    $lazyBundleId$?: string;
-}
-export interface ComponentRuntimeMembers {
-    [memberName: string]: ComponentRuntimeMember;
-}
-export declare type ComponentRuntimeMember = [
     /**
-     * flags data
+     * A map of the component's members, which could include fields decorated
+     * with `@Prop`, `@State`, etc as well as methods.
      */
-    number,
+    $members$?: ComponentRuntimeMembers;
     /**
-     * attribute name to observe
+     * Information about listeners on the component.
      */
-    string?
-];
-export declare type ComponentRuntimeHostListener = [
+    $listeners$?: ComponentRuntimeHostListener[];
     /**
-     * event flags
+     * Tuples containing information about `@Prop` fields on the component which
+     * are set to be reflected (i.e. kept in sync) as HTML attributes when
+     * updated.
      */
-    number,
+    $attrsToReflect$?: ComponentRuntimeReflectingAttr[];
     /**
-     * event name,
+     * Information about which class members have watchers attached on the component.
      */
-    string,
+    $watchers$?: ComponentConstructorWatchers;
     /**
-     * event method,
+     * A bundle ID used for lazy loading.
      */
-    string
-];
-export declare type ModeBundleId = ModeBundleIds | string;
+    $lazyBundleId$?: string;
+}
+/**
+ * A mapping of the names of members on the component to some runtime-specific
+ * information about them.
+ */
+export interface ComponentRuntimeMembers {
+    [memberName: string]: ComponentRuntimeMember;
+}
+/**
+ * A tuple with information about a class member that's relevant at runtime.
+ * The fields are:
+ *
+ * 1. A number used to hold bitflags for component members. The bit flags which
+ * this is intended to store are documented in the {@link MEMBER_FLAGS} enum.
+ * 2. The attribute name to observe.
+ */
+export type ComponentRuntimeMember = [number, string?];
+/**
+ * A tuple holding information about a host listener which is relevant at
+ * runtime. The field are:
+ *
+ * 1. A number used to hold bitflags for listeners. The bit flags which this is
+ * intended to store are documented in the {@link LISTENER_FLAGS} enum.
+ * 2. The event name.
+ * 3. The method name.
+ */
+export type ComponentRuntimeHostListener = [number, string, string];
+/**
+ * A tuple containing information about props which are "reflected" at runtime,
+ * meaning that HTML attributes on the component instance are kept in sync with
+ * the prop value.
+ *
+ * The fields are:
+ *
+ * 1. the prop name
+ * 2. the prop attribute.
+ */
+export type ComponentRuntimeReflectingAttr = [string, string | undefined];
+export type ModeBundleId = ModeBundleIds | string;
 export interface ModeBundleIds {
     [modeName: string]: string;
 }
-export declare type RuntimeRef = HostElement | {};
+export type RuntimeRef = HostElement | {};
 /**
  * Interface used to track an Element, it's virtual Node (`VNode`), and other data
  */
@@ -1387,17 +1445,22 @@ export interface PlatformRuntime {
     $flags$: number;
     $orgLocNodes$?: Map<string, RenderNode>;
     $resourcesUrl$: string;
+    /**
+     * The nonce value to be applied to all script/style tags at runtime.
+     * If `null`, the nonce attribute will not be applied.
+     */
+    $nonce$?: string | null;
     jmp: (c: Function) => any;
     raf: (c: FrameRequestCallback) => number;
     ael: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
     rel: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
     ce: (eventName: string, opts?: any) => CustomEvent;
 }
-export declare type RefMap = WeakMap<any, HostRef>;
-export declare type StyleMap = Map<string, CSSStyleSheet | string>;
-export declare type RootAppliedStyleMap = WeakMap<Element, Set<string>>;
-export declare type AppliedStyleMap = Set<string>;
-export declare type ActivelyProcessingCmpMap = Set<Element>;
+export type RefMap = WeakMap<any, HostRef>;
+export type StyleMap = Map<string, CSSStyleSheet | string>;
+export type RootAppliedStyleMap = WeakMap<Element, Set<string>>;
+export type AppliedStyleMap = Set<string>;
+export type ActivelyProcessingCmpMap = Set<Element>;
 export interface ScreenshotConnector {
     initBuild(opts: ScreenshotConnectorOptions): Promise<void>;
     completeBuild(masterBuild: ScreenshotBuild): Promise<ScreenshotBuildResults>;
@@ -2013,6 +2076,11 @@ export interface NewSpecPageOptions {
      */
     attachStyles?: boolean;
     strictBuild?: boolean;
+    /**
+     * Default values to be set on the platform runtime object (@see PlatformRuntime) when creating
+     * the spec page.
+     */
+    platform?: Partial<PlatformRuntime>;
 }
 /**
  * A record of `TypesMemberNameData` entities.
@@ -2048,7 +2116,7 @@ export interface TypesModule {
     jsx: string;
     element: string;
 }
-export declare type TypeInfo = {
+export type TypeInfo = {
     name: string;
     type: string;
     optional: boolean;
@@ -2066,8 +2134,8 @@ export interface Hyperscript {
     (sel: any, data: VNodeData, children: Array<VNode | undefined | null>): VNode;
     (sel: any, data: VNodeData, children: VNode): VNode;
 }
-export declare type ChildType = VNode | number | string;
-export declare type PropsType = VNodeProdData | number | string | null;
+export type ChildType = VNode | number | string;
+export type PropsType = VNodeProdData | number | string | null;
 export interface VNodeProdData {
     key?: string | number;
     class?: {
@@ -2105,7 +2173,7 @@ export interface CompilerWorkerTask {
     reject: (msg: string) => any;
     retries?: number;
 }
-export declare type WorkerMsgHandler = (msgToWorker: MsgToWorker) => Promise<any>;
+export type WorkerMsgHandler = (msgToWorker: MsgToWorker) => Promise<any>;
 export interface WorkerTask {
     taskId: number;
     method: string;
@@ -2124,7 +2192,7 @@ export interface WorkerMessage {
     error?: string;
     exit?: boolean;
 }
-export declare type WorkerRunner = (methodName: string, args: any[]) => Promise<any>;
+export type WorkerRunner = (methodName: string, args: any[]) => Promise<any>;
 export interface WorkerRunnerOptions {
     isLongRunningTask?: boolean;
     workerKey?: string;
@@ -2158,30 +2226,31 @@ export interface TerminalInfo {
 /**
  * The task to run in order to collect the duration data point.
  */
-export declare type TelemetryCallback = (...args: any[]) => void | Promise<void>;
+export type TelemetryCallback = (...args: any[]) => void | Promise<void>;
 /**
  * The model for the data that's tracked.
  */
 export interface TrackableData {
-    yarn: boolean;
-    component_count?: number;
     arguments: string[];
-    targets: string[];
-    task: TaskCommand;
-    duration_ms: number;
+    build: string;
+    component_count?: number;
+    config: Config;
+    cpu_model: string | undefined;
+    duration_ms: number | undefined;
+    has_app_pwa_config: boolean;
+    is_browser_env: boolean;
+    os_name: string | undefined;
+    os_version: string | undefined;
     packages: string[];
     packages_no_versions?: string[];
-    os_name: string;
-    os_version: string;
-    cpu_model: string;
-    typescript: string;
     rollup: string;
+    rindo: string;
     system: string;
     system_major?: string;
-    build: string;
-    rindo: string;
-    has_app_pwa_config: boolean;
-    config: Config;
+    targets: string[];
+    task: TaskCommand | null;
+    typescript: string;
+    yarn: boolean;
 }
 /**
  * Used as the object sent to the server. Value is the data tracked.