Add new extension api (#2743)

* Added extensions project

* Added extension changes to core-frontend

* Added extension test placeholder

* Added extension ui-test-app

* Set new extension exports to alpha

* Change logs

* Added extension package documentation

* Updated code owners and removed unused test

* Extract-api

* Reverted changes to appui-react api

* Removed some common types from extension access

* Removed some frontend types from extensions

* Added real frontend functions

* Added more frontend exports

* Removed real ToolSettings

* Updated extensions to beta

* Removed broken link to extension docs

* Removed commented-out code

* Simplified extension test tool

* Merge fixes

* clean up API

* add kevin as codeowner for extensions

* cleanup core-extension

* core-frontend

* react to PR comments

* update lock file

* update lock

* update api docs

* pr comment + dont lint

* extract-api

* move enum to Extension.ts

* use proper types, cleanup tags

* fix gnarly comment

Co-authored-by: Caleb Shafer <[email protected]>
Co-authored-by: Arun George <[email protected]>
Co-authored-by: kckst8 <[email protected]>

Author: 4 people

.github/CODEOWNERS

@@ -105,8 +105,9 @@ rush.json       @iTwin/itwinjs-core-admins
 /core/ecschema-*                @calebmshafer @ColinKerr @wgoehrig
 /core/electron                  @wgoehrig @ramanujam-raman
 /core/express-server            @calebmshafer @wgoehrig @ramanujam-raman
+/core/extension                 @calebmshafer @wgoehrig @aruniverse @kckst8
 /core/frontend                  @kabentley @bbastings @iTwin/itwinjs-core-display
-/core/frontend/src/extension    @calebmshafer @wgoehrig
+/core/frontend/src/extension    @calebmshafer @wgoehrig @aruniverse @kckst8
 /core/frontend-devtools         @iTwin/itwinjs-core-display @Ellord207
 /core/geometry                  @bbastings @mgooding @dassaf4
 /core/hypermodeling             @bbastings @iTwin/itwinjs-core-display
@@ -134,6 +135,7 @@ rush.json       @iTwin/itwinjs-core-admins
 /example-code                         @iTwin/itwinjs-core-admins
 
 /extensions                           @bsteinbk @calebmshafer
+/extensions/test-extension            @calebmshafer @wgoehrig @aruniverse @kckst8
 /extensions/map-layers                @bsteinbk @mdastous-bentley
 
 /full-stack-tests/core                @iTwin/itwinjs-core-admins
@@ -163,7 +165,7 @@ rush.json       @iTwin/itwinjs-core-admins
 /tools/backend-webpack @calebmshafer @wgoehrig
 /tools/build @calebmshafer @wgoehrig
 /tools/certa @calebmshafer @wgoehrig
-/tools/webpack-core @calebmshafer @wgoehrig
+/tools/webpack-core @calebmshafer @wgoehrig @aruniverse
 /tools/ecschema2ts @calebmshafer @ColinKerr @wgoehrig
 /tools/eslint-plugin @calebmshafer @paulius-valiunas
 /tools/internal @calebmshafer @wgoehrig

common/api/core-frontend.api.md

@@ -54,6 +54,7 @@ import { CodeSpec } from '@itwin/core-common';
 import { ColorDef } from '@itwin/core-common';
 import { ColorDefProps } from '@itwin/core-common';
 import { ColorIndex } from '@itwin/core-common';
+import { CommonToolbarItem } from '@itwin/appui-abstract';
 import { CompressedId64Set } from '@itwin/core-bentley';
 import { Constructor } from '@itwin/core-bentley';
 import { ContentIdProvider } from '@itwin/core-common';
@@ -292,12 +293,15 @@ import { TileHeader } from '@itwin/core-common';
 import { TileProps } from '@itwin/core-common';
 import { TileReadStatus } from '@itwin/core-common';
 import { TileVersionInfo } from '@itwin/core-common';
+import { ToolbarOrientation } from '@itwin/appui-abstract';
+import { ToolbarUsage } from '@itwin/appui-abstract';
 import { Transform } from '@itwin/core-geometry';
 import { TransformProps } from '@itwin/core-geometry';
 import { TransientIdSequence } from '@itwin/core-bentley';
 import { Tweens } from '@itwin/core-common';
 import { TxnNotifications } from '@itwin/core-common';
 import { UiAdmin } from '@itwin/appui-abstract';
+import { UiItemsProvider } from '@itwin/appui-abstract';
 import { UnitConversion } from '@itwin/core-quantity';
 import { UnitProps } from '@itwin/core-quantity';
 import { UnitsProvider } from '@itwin/core-quantity';
@@ -1022,6 +1026,12 @@ export enum ACSType {
     Spherical = 3
 }
 
+// @beta (undocumented)
+export enum ActivationEvent {
+    // (undocumented)
+    onStartup = "onStartup"
+}
+
 // @public
 export class ActivityMessageDetails {
     constructor(showProgressBar: boolean, showPercentInMessage: boolean, supportsCancellation: boolean, showDialogInitially?: boolean);
@@ -1755,6 +1765,19 @@ export class BriefcaseTxns extends BriefcaseNotificationHandler implements TxnNo
     reverseTxns(numOperations: number): Promise<IModelStatus>;
 }
 
+// @beta (undocumented)
+export interface BuildExtensionManifest extends ExtensionManifest {
+    readonly module: string;
+}
+
+// @beta (undocumented)
+export interface BuiltInExtensionLoaderProps {
+    // (undocumented)
+    loader: ResolveFunc;
+    // (undocumented)
+    manifest: Promise<any>;
+}
+
 // @internal (undocumented)
 export type CachedDecoration = {
     type: "graphic";
@@ -3065,6 +3088,64 @@ export enum EventHandled {
     Yes = 1
 }
 
+// @beta
+export class ExtensionAdmin {
+    constructor();
+    addBuildExtension(manifestPromise: Promise<BuildExtensionManifest>, mainFunc?: ResolveFunc): Promise<void>;
+    addExtensionLoader(extensionLoader: ExtensionLoader): void;
+    addExtensionLoaderFront(extensionLoader: ExtensionLoader): void;
+    // @internal
+    onStartup: () => Promise<void>;
+}
+
+// @beta
+export class ExtensionHost {
+    protected constructor();
+    // (undocumented)
+    static get accuSnap(): AccuSnap;
+    // (undocumented)
+    static get locateManager(): ElementLocateManager;
+    // (undocumented)
+    static get notifications(): NotificationManager;
+    // (undocumented)
+    static get renderSystem(): RenderSystem;
+    // (undocumented)
+    static get toolAdmin(): ToolAdmin;
+    // (undocumented)
+    static get viewManager(): ViewManager;
+}
+
+// @beta (undocumented)
+export class ExtensionImpl {
+    constructor(_id: string);
+    // (undocumented)
+    registerTool(tool: ToolType, onRegistered?: () => any): Promise<void>;
+}
+
+// @beta
+export interface ExtensionLoader {
+    downloadExtension(arg: ExtensionLoaderProps): Promise<LocalExtensionProps>;
+    getManifest(arg: ExtensionLoaderProps): Promise<ExtensionManifest>;
+}
+
+// @beta
+export interface ExtensionLoaderProps {
+    // (undocumented)
+    name: string;
+    // (undocumented)
+    version: string;
+}
+
+// @beta
+export interface ExtensionManifest {
+    readonly activationEvents: ActivationEvent[];
+    readonly description?: string;
+    readonly displayName?: string;
+    readonly main: string;
+    readonly name: string;
+    readonly version: string;
+}
+
 // @public
 export interface ExtentLimits {
     max: number;
@@ -4640,6 +4721,8 @@ export class IModelApp {
     static authorizationClient?: AuthorizationClient;
     // @internal (undocumented)
     static createRenderSys(opts?: RenderSystem.Options): RenderSystem;
+    // @beta (undocumented)
+    static readonly extensionAdmin: ExtensionAdmin;
     // @alpha
     static formatElementToolTip(msg: string[]): HTMLElement;
     static getAccessToken(): Promise<AccessToken>;
@@ -4650,7 +4733,7 @@ export class IModelApp {
     // @internal (undocumented)
     static get initialized(): boolean;
     static get localization(): Localization;
-    // @internal (undocumented)
+    // (undocumented)
     static get locateManager(): ElementLocateManager;
     // @internal (undocumented)
     static lookupEntityClass(classFullName: string): typeof EntityState | undefined;
@@ -4676,6 +4759,8 @@ export class IModelApp {
     // @internal
     static get mapLayerFormatRegistry(): MapLayerFormatRegistry;
     static get notifications(): NotificationManager;
+    // @internal
+    static readonly onAfterStartup: BeEvent<() => void>;
     static readonly onBeforeShutdown: BeEvent<() => void>;
     // @beta
     static get publicPath(): string;
@@ -5280,6 +5365,14 @@ export class LengthDescription extends FormattedQuantityDescription {
 // @internal (undocumented)
 export function linePlaneIntersect(outP: Point3d, linePt: Point3d, lineNormal: Vector3d | undefined, planePt: Point3d, planeNormal: Vector3d, perpendicular: boolean): void;
 
+// @beta
+export interface LocalExtensionProps {
+    // (undocumented)
+    readonly mainFunc?: ResolveFunc;
+    // (undocumented)
+    readonly manifest: ExtensionManifest;
+}
+
 // @internal
 export class LocalhostIpcApp {
     // (undocumented)
@@ -9013,6 +9106,9 @@ export abstract class RenderTextureDrape implements IDisposable {
 // @internal (undocumented)
 export type RequestTileTreePropsFunc = (iModel: IModelConnection, treeId: string) => Promise<IModelTileTreeProps>;
 
+// @beta (undocumented)
+export type ResolveFunc = () => Promise<any>;
+
 // @internal
 export type RootIModelTile = Tile & {
     tileScreenSize: number;
@@ -11651,6 +11747,15 @@ export interface ToolAssistanceSection {
 // @public (undocumented)
 export type ToolList = ToolType[];
 
+// @beta (undocumented)
+export class ToolProvider implements UiItemsProvider {
+    constructor(tool: ToolType);
+    // (undocumented)
+    readonly id: string;
+    // (undocumented)
+    provideToolbarButtonItems(_stageId: string, stageUsage: string, toolbarUsage: ToolbarUsage, toolbarOrientation: ToolbarOrientation): CommonToolbarItem[];
+    }
+
 // @public
 export class ToolRegistry {
     create(toolId: string, ...args: any[]): Tool | undefined;

common/api/summary/core-frontend.exports.csv

@@ -24,6 +24,7 @@ public;AccuSnap
 public;AccuSnap
 public;ACSDisplayOptions
 public;ACSType
+beta;ActivationEvent
 public;ActivityMessageDetails
 public;ActivityMessageEndReason
 internal;addRangeGraphic(builder: GraphicBuilder, range: Range3d, is2d: boolean): void
@@ -73,6 +74,8 @@ public;BlankConnectionProps
 public;BriefcaseConnection 
 public;class BriefcaseNotificationHandler 
 public;BriefcaseTxns 
+beta;BuildExtensionManifest 
+beta;BuiltInExtensionLoaderProps
 internal;CachedDecoration =
 internal;CachedIModelCoordinatesResponseProps
 public;calculateEcefToDbTransformAtLocation(originIn: Point3d, iModel: IModelConnection): Promise
@@ -156,6 +159,12 @@ public;EntityState
 internal;EnvironmentDecorations
 public;EventController
 public;EventHandled
+beta;ExtensionAdmin
+beta;ExtensionHost
+beta;ExtensionImpl
+beta;ExtensionLoader
+beta;ExtensionLoaderProps
+beta;ExtensionManifest
 public;ExtentLimits
 internal;ExternalTileStatistics
 public;extractImageSourceDimensions(source: ImageSource): Promise
@@ -316,6 +325,7 @@ public;KeyinParseError
 internal;KeyinStatus
 beta;LengthDescription 
 internal;linePlaneIntersect(outP: Point3d, linePt: Point3d, lineNormal: Vector3d | undefined, planePt: Point3d, planeNormal: Vector3d, perpendicular: boolean): void
+beta;LocalExtensionProps
 internal;LocalhostIpcApp
 internal;LocalHostIpcAppOpts
 beta;LocalUnitFormatProvider 
@@ -511,6 +521,7 @@ internal;RenderTargetDebugControl
 internal;class RenderTerrainGeometry 
 internal;class RenderTextureDrape 
 internal;RequestTileTreePropsFunc = (iModel: IModelConnection, treeId: string) => Promise
+beta;ResolveFunc = () => Promise
 internal;RootIModelTile = Tile &
 public;RotateViewTool 
 alpha;RotationMode
@@ -640,6 +651,7 @@ public;ToolAssistanceInstructions
 public;ToolAssistanceKeyboardInfo
 public;ToolAssistanceSection
 public;ToolList = ToolType[]
+beta;ToolProvider 
 public;ToolRegistry
 public;ToolSettings
 internal;ToolSettingsState

common/changes/@itwin/core-extension/spencer-new-extension-api_2021-11-19-16-27.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-extension",
+      "comment": "Switched to more flexible extension api",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-extension"
+}

common/changes/@itwin/core-frontend/spencer-new-extension-api_2021-11-19-16-27.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/core-frontend",
+      "comment": "Switched to more flexible extension api",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/core-frontend"
+}