From 366a697b3a85a135dcea15a5f9dce6918812790a Mon Sep 17 00:00:00 2001
From: Damien Elmes <gpg@ankiweb.net>
Date: Sun, 3 Apr 2022 23:37:35 +1000
Subject: [PATCH] Add a runtime proof of concept

The API extractor integration isn't set up properly yet, so I had
to manually generate the d.ts bundle and copy it into the add-on:

cd ts/runtime
bazel run extract_api
cp ../../.bazel/bin/ts/runtime/extract_api.sh.runfiles/ankidesktop/ts/runtime/dist/anki.d.ts \
  $c/anki_new_format_pack/ts/anki-dts/runtime.d.ts
---
 ts/editor/BUILD.bazel         |   4 +
 ts/editor/NoteEditor.svelte   |  15 +-
 ts/editor/index_browser.ts    |   5 +
 ts/editor/index_creator.ts    |   5 +
 ts/editor/index_reviewer.ts   |   5 +
 ts/lib/runtime-require.ts     |   1 +
 ts/runtime/BUILD.bazel        |  42 ++++
 ts/runtime/api-extractor.json | 364 ++++++++++++++++++++++++++++++++++
 ts/runtime/index.ts           |  31 +++
 ts/runtime/tsconfig.json      |   5 +
 10 files changed, 473 insertions(+), 4 deletions(-)
 create mode 100644 ts/runtime/BUILD.bazel
 create mode 100644 ts/runtime/api-extractor.json
 create mode 100644 ts/runtime/index.ts
 create mode 100644 ts/runtime/tsconfig.json

diff --git a/ts/editor/BUILD.bazel b/ts/editor/BUILD.bazel
index ca17ca28c..833996e2b 100644
--- a/ts/editor/BUILD.bazel
+++ b/ts/editor/BUILD.bazel
@@ -49,12 +49,14 @@ _esbuild_deps = [
     "@npm//bootstrap-icons",
     "//ts/icons",
     "@npm//protobufjs",
+    "//ts/runtime",
 ]
 
 esbuild(
     name = "browser_editor",
     args = {
         "loader": {".svg": "text"},
+        "external": ["anki"],
     },
     entry_point = "index_browser.ts",
     output_css = "browser_editor.css",
@@ -66,6 +68,7 @@ esbuild(
     name = "reviewer_editor",
     args = {
         "loader": {".svg": "text"},
+        "external": ["anki"],
     },
     entry_point = "index_reviewer.ts",
     output_css = "reviewer_editor.css",
@@ -77,6 +80,7 @@ esbuild(
     name = "note_creator",
     args = {
         "loader": {".svg": "text"},
+        "external": ["anki"],
     },
     entry_point = "index_creator.ts",
     output_css = "note_creator.css",
diff --git a/ts/editor/NoteEditor.svelte b/ts/editor/NoteEditor.svelte
index 957b07616..9f5672910 100644
--- a/ts/editor/NoteEditor.svelte
+++ b/ts/editor/NoteEditor.svelte
@@ -17,8 +17,8 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
     }
 
     import { registerPackage } from "../lib/runtime-require";
-    import contextProperty from "../sveltelib/context-property";
-    import lifecycleHooks from "../sveltelib/lifecycle-hooks";
+    import contextProperty, { ContextProperty } from "../sveltelib/context-property";
+    import lifecycleHooks, { LifecycleHooks } from "../sveltelib/lifecycle-hooks";
 
     const key = Symbol("noteEditor");
     const [context, setContextProperty] = contextProperty<NoteEditorAPI>(key);
@@ -26,11 +26,18 @@ License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
 
     export { context };
 
-    registerPackage("anki/NoteEditor", {
+    /** anki/NoteEditor */
+    export interface NoteEditorPackage {
+        context: ContextProperty<NoteEditorAPI>;
+        lifecycle: LifecycleHooks<NoteEditorAPI>;
+        instances: NoteEditorAPI[];
+    }
+    export const noteEditorPackage: NoteEditorPackage = {
         context,
         lifecycle,
         instances,
-    });
+    };
+    registerPackage("anki/NoteEditor", noteEditorPackage as any);
 </script>
 
 <script lang="ts">
diff --git a/ts/editor/index_browser.ts b/ts/editor/index_browser.ts
index be79aadf7..f4025cf75 100644
--- a/ts/editor/index_browser.ts
+++ b/ts/editor/index_browser.ts
@@ -1,5 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
+
 import { globalExport } from "../lib/globals";
 import { setupI18n } from "../lib/i18n";
 import { uiResolve } from "../lib/ui";
@@ -20,3 +21,7 @@ setupBrowserEditor();
 import * as base from "./base";
 
 globalExport(base);
+
+// We could put this into a shared file like runtime-require.ts
+// in the future.
+import "../runtime";
diff --git a/ts/editor/index_creator.ts b/ts/editor/index_creator.ts
index 301d71461..1bb624347 100644
--- a/ts/editor/index_creator.ts
+++ b/ts/editor/index_creator.ts
@@ -1,5 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
+
 import { globalExport } from "../lib/globals";
 import { setupI18n } from "../lib/i18n";
 import { uiResolve } from "../lib/ui";
@@ -20,3 +21,7 @@ setupNoteCreator();
 import * as base from "./base";
 
 globalExport(base);
+
+// We could put this into a shared file like runtime-require.ts
+// in the future.
+import "../runtime";
diff --git a/ts/editor/index_reviewer.ts b/ts/editor/index_reviewer.ts
index 1bbb72644..9b2b0dd04 100644
--- a/ts/editor/index_reviewer.ts
+++ b/ts/editor/index_reviewer.ts
@@ -1,5 +1,6 @@
 // Copyright: Ankitects Pty Ltd and contributors
 // License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
+
 import { globalExport } from "../lib/globals";
 import { setupI18n } from "../lib/i18n";
 import { uiResolve } from "../lib/ui";
@@ -20,3 +21,7 @@ setupReviewerEditor();
 import * as base from "./base";
 
 globalExport(base);
+
+// We could put this into a shared file like runtime-require.ts
+// in the future.
+import "../runtime";
diff --git a/ts/lib/runtime-require.ts b/ts/lib/runtime-require.ts
index 1925a1434..41e61b0f5 100644
--- a/ts/lib/runtime-require.ts
+++ b/ts/lib/runtime-require.ts
@@ -24,6 +24,7 @@ type AnkiPackages =
     | "anki/theme"
     | "anki/location"
     | "anki/surround"
+    | "anki/runtime"
     | "anki/ui";
 type PackageDeprecation<T extends Record<string, unknown>> = {
     [key in keyof T]?: string;
diff --git a/ts/runtime/BUILD.bazel b/ts/runtime/BUILD.bazel
new file mode 100644
index 000000000..d365a7989
--- /dev/null
+++ b/ts/runtime/BUILD.bazel
@@ -0,0 +1,42 @@
+load("//ts:prettier.bzl", "prettier_test")
+load("//ts:eslint.bzl", "eslint_test")
+load("//ts:typescript.bzl", "typescript")
+load("@npm//@microsoft/api-extractor:index.bzl", "api_extractor")
+
+typescript(
+    name = "runtime",
+    deps = [
+        "//ts/editor",
+    ],
+)
+
+filegroup(
+    name = "runtime_dts",
+    srcs = [":runtime"],
+    output_group = "types",
+)
+
+api_extractor(
+    name = "extract_api",
+    args = [
+        "run",
+        "-c",
+        "$(location api-extractor.json)",
+    ],
+    data = [
+        "api-extractor.json",
+        "tsconfig.json",
+        ":runtime_dts",
+        "//:package.json",
+        "//ts:tsconfig.json",
+        "//ts/components",
+        "//ts/editor",
+    ],
+)
+
+# Tests
+################
+
+prettier_test()
+
+eslint_test()
diff --git a/ts/runtime/api-extractor.json b/ts/runtime/api-extractor.json
new file mode 100644
index 000000000..44e0f55fb
--- /dev/null
+++ b/ts/runtime/api-extractor.json
@@ -0,0 +1,364 @@
+/**
+ * Config file for API Extractor.  For more info, please visit: https://api-extractor.com
+ */
+{
+    "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
+
+    /**
+     * Optionally specifies another JSON config file that this file extends from.  This provides a way for
+     * standard settings to be shared across multiple projects.
+     *
+     * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains
+     * the "extends" field.  Otherwise, the first path segment is interpreted as an NPM package name, and will be
+     * resolved using NodeJS require().
+     *
+     * SUPPORTED TOKENS: none
+     * DEFAULT VALUE: ""
+     */
+    // "extends": "./shared/api-extractor-base.json"
+    // "extends": "my-package/include/api-extractor-base.json"
+
+    /**
+     * Determines the "<projectFolder>" token that can be used with other config file settings.  The project folder
+     * typically contains the tsconfig.json and package.json config files, but the path is user-defined.
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting.
+     *
+     * The default value for "projectFolder" is the token "<lookup>", which means the folder is determined by traversing
+     * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder
+     * that contains a tsconfig.json file.  If a tsconfig.json file cannot be found in this way, then an error
+     * will be reported.
+     *
+     * SUPPORTED TOKENS: <lookup>
+     * DEFAULT VALUE: "<lookup>"
+     */
+    "projectFolder": ".",
+
+    /**
+     * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis.  API Extractor
+     * analyzes the symbols exported by this module.
+     *
+     * The file extension must be ".d.ts" and not ".ts".
+     *
+     * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+     * prepend a folder token such as "<projectFolder>".
+     *
+     * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+     */
+    "mainEntryPointFilePath": "index.d.ts",
+
+    /**
+     * A list of NPM package names whose exports should be treated as part of this package.
+     *
+     * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1",
+     * and another NPM package "library2" is embedded in this bundle.  Some types from library2 may become part
+     * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly
+     * imports library2.  To avoid this, we can specify:
+     *
+     *   "bundledPackages": [ "library2" ],
+     *
+     * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been
+     * local files for library1.
+     */
+    "bundledPackages": [],
+
+    /**
+     * Determines how the TypeScript compiler engine will be invoked by API Extractor.
+     */
+    "compiler": {
+        /**
+         * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * Note: This setting will be ignored if "overrideTsconfig" is used.
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<projectFolder>/tsconfig.json"
+         */
+        // "tsconfigFilePath": "<projectFolder>/tsconfig.json",
+        /**
+         * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk.
+         * The object must conform to the TypeScript tsconfig schema:
+         *
+         * http://json.schemastore.org/tsconfig
+         *
+         * If omitted, then the tsconfig.json file will be read from the "projectFolder".
+         *
+         * DEFAULT VALUE: no overrideTsconfig section
+         */
+        // "overrideTsconfig": {
+        //   . . .
+        // }
+        /**
+         * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended
+         * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when
+         * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses
+         * for its analysis.  Where possible, the underlying issue should be fixed rather than relying on skipLibCheck.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "skipLibCheck": true,
+    },
+
+    /**
+     * Configures how the API report file (*.api.md) will be generated.
+     */
+    "apiReport": {
+        /**
+         * (REQUIRED) Whether to generate an API report.
+         */
+        "enabled": true
+
+        /**
+         * The filename for the API report files.  It will be combined with "reportFolder" or "reportTempFolder" to produce
+         * a full file path.
+         *
+         * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/".
+         *
+         * SUPPORTED TOKENS: <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<unscopedPackageName>.api.md"
+         */
+        // "reportFileName": "<unscopedPackageName>.api.md",
+
+        /**
+         * Specifies the folder where the API report file is written.  The file name portion is determined by
+         * the "reportFileName" setting.
+         *
+         * The API report file is normally tracked by Git.  Changes to it can be used to trigger a branch policy,
+         * e.g. for an API review.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<projectFolder>/etc/"
+         */
+        // "reportFolder": "<projectFolder>/etc/",
+
+        /**
+         * Specifies the folder where the temporary report file is written.  The file name portion is determined by
+         * the "reportFileName" setting.
+         *
+         * After the temporary file is written to disk, it is compared with the file in the "reportFolder".
+         * If they are different, a production build will fail.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<projectFolder>/temp/"
+         */
+        // "reportTempFolder": "<projectFolder>/temp/"
+    },
+
+    /**
+     * Configures how the doc model file (*.api.json) will be generated.
+     */
+    "docModel": {
+        /**
+         * (REQUIRED) Whether to generate a doc model file.
+         */
+        "enabled": true
+
+        /**
+         * The output path for the doc model file.  The file extension should be ".api.json".
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<projectFolder>/temp/<unscopedPackageName>.api.json"
+         */
+        // "apiJsonFilePath": "<projectFolder>/temp/<unscopedPackageName>.api.json"
+    },
+
+    /**
+     * Configures how the .d.ts rollup file will be generated.
+     */
+    "dtsRollup": {
+        /**
+         * (REQUIRED) Whether to generate the .d.ts rollup file.
+         */
+        "enabled": true
+
+        /**
+         * Specifies the output path for a .d.ts rollup file to be generated without any trimming.
+         * This file will include all declarations that are exported by the main entry point.
+         *
+         * If the path is an empty string, then this file will not be written.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<projectFolder>/dist/<unscopedPackageName>.d.ts"
+         */
+        // "untrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>.d.ts",
+
+        /**
+         * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release.
+         * This file will include only declarations that are marked as "@public" or "@beta".
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: ""
+         */
+        // "betaTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-beta.d.ts",
+
+        /**
+         * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release.
+         * This file will include only declarations that are marked as "@public".
+         *
+         * If the path is an empty string, then this file will not be written.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: ""
+         */
+        // "publicTrimmedFilePath": "<projectFolder>/dist/<unscopedPackageName>-public.d.ts",
+
+        /**
+         * When a declaration is trimmed, by default it will be replaced by a code comment such as
+         * "Excluded from this release type: exampleMember".  Set "omitTrimmingComments" to true to remove the
+         * declaration completely.
+         *
+         * DEFAULT VALUE: false
+         */
+        // "omitTrimmingComments": true
+    },
+
+    /**
+     * Configures how the tsdoc-metadata.json file will be generated.
+     */
+    "tsdocMetadata": {
+        /**
+         * Whether to generate the tsdoc-metadata.json file.
+         *
+         * DEFAULT VALUE: true
+         */
+        "enabled": false
+        /**
+         * Specifies where the TSDoc metadata file should be written.
+         *
+         * The path is resolved relative to the folder of the config file that contains the setting; to change this,
+         * prepend a folder token such as "<projectFolder>".
+         *
+         * The default value is "<lookup>", which causes the path to be automatically inferred from the "tsdocMetadata",
+         * "typings" or "main" fields of the project's package.json.  If none of these fields are set, the lookup
+         * falls back to "tsdoc-metadata.json" in the package folder.
+         *
+         * SUPPORTED TOKENS: <projectFolder>, <packageName>, <unscopedPackageName>
+         * DEFAULT VALUE: "<lookup>"
+         */
+        // "tsdocMetadataFilePath": "<projectFolder>/dist/tsdoc-metadata.json"
+    },
+
+    /**
+     * Specifies what type of newlines API Extractor should use when writing output files.  By default, the output files
+     * will be written with Windows-style newlines.  To use POSIX-style newlines, specify "lf" instead.
+     * To use the OS's default newline kind, specify "os".
+     *
+     * DEFAULT VALUE: "crlf"
+     */
+    // "newlineKind": "crlf",
+
+    /**
+     * Configures how API Extractor reports error and warning messages produced during analysis.
+     *
+     * There are three sources of messages:  compiler messages, API Extractor messages, and TSDoc messages.
+     */
+    "messages": {
+        /**
+         * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing
+         * the input .d.ts files.
+         *
+         * TypeScript message identifiers start with "TS" followed by an integer.  For example: "TS2551"
+         *
+         * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+         */
+        "compilerMessageReporting": {
+            /**
+             * Configures the default routing for messages that don't match an explicit rule in this table.
+             */
+            "default": {
+                /**
+                 * Specifies whether the message should be written to the the tool's output log.  Note that
+                 * the "addToApiReportFile" property may supersede this option.
+                 *
+                 * Possible values: "error", "warning", "none"
+                 *
+                 * Errors cause the build to fail and return a nonzero exit code.  Warnings cause a production build fail
+                 * and return a nonzero exit code.  For a non-production build (e.g. when "api-extractor run" includes
+                 * the "--local" option), the warning is displayed but the build will not fail.
+                 *
+                 * DEFAULT VALUE: "warning"
+                 */
+                "logLevel": "warning"
+
+                /**
+                 * When addToApiReportFile is true:  If API Extractor is configured to write an API report file (.api.md),
+                 * then the message will be written inside that file; otherwise, the message is instead logged according to
+                 * the "logLevel" option.
+                 *
+                 * DEFAULT VALUE: false
+                 */
+                // "addToApiReportFile": false
+            }
+
+            // "TS2551": {
+            //   "logLevel": "warning",
+            //   "addToApiReportFile": true
+            // },
+            //
+            // . . .
+        },
+
+        /**
+         * Configures handling of messages reported by API Extractor during its analysis.
+         *
+         * API Extractor message identifiers start with "ae-".  For example: "ae-extra-release-tag"
+         *
+         * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings
+         */
+        "extractorMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+                // "addToApiReportFile": false
+            }
+
+            // "ae-extra-release-tag": {
+            //   "logLevel": "warning",
+            //   "addToApiReportFile": true
+            // },
+            //
+            // . . .
+        },
+
+        /**
+         * Configures handling of messages reported by the TSDoc parser when analyzing code comments.
+         *
+         * TSDoc message identifiers start with "tsdoc-".  For example: "tsdoc-link-tag-unescaped-text"
+         *
+         * DEFAULT VALUE:  A single "default" entry with logLevel=warning.
+         */
+        "tsdocMessageReporting": {
+            "default": {
+                "logLevel": "warning"
+                // "addToApiReportFile": false
+            }
+
+            // "tsdoc-link-tag-unescaped-text": {
+            //   "logLevel": "warning",
+            //   "addToApiReportFile": true
+            // },
+            //
+            // . . .
+        }
+    }
+}
diff --git a/ts/runtime/index.ts b/ts/runtime/index.ts
new file mode 100644
index 000000000..936cb234d
--- /dev/null
+++ b/ts/runtime/index.ts
@@ -0,0 +1,31 @@
+// Copyright: Ankitects Pty Ltd and contributors
+// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
+
+/* eslint-disable @typescript-eslint/no-var-requires */
+
+import IconButton from "../components/IconButton.svelte";
+import WithState from "../components/WithState.svelte";
+import type { NoteEditorPackage } from "../editor/NoteEditor.svelte";
+import { registerPackage } from "../lib/runtime-require";
+
+// The typed version from runtime-require will need adjusting if we go
+// down this route; for now just use an untyped version.
+declare function require(text: string): unknown;
+
+/**
+ * Exports from the editing screen. Only available on pages that show an editor.
+ */
+export const editor = require("anki/NoteEditor") as NoteEditorPackage;
+
+/**
+ * Basic Svelte UI components. Available on all pages.
+ */
+export const components = {
+    IconButton,
+    WithState,
+};
+
+registerPackage("anki/runtime", {
+    editor,
+    components,
+});
diff --git a/ts/runtime/tsconfig.json b/ts/runtime/tsconfig.json
new file mode 100644
index 000000000..dfe685f2b
--- /dev/null
+++ b/ts/runtime/tsconfig.json
@@ -0,0 +1,5 @@
+{
+    "extends": "../tsconfig.json",
+    "include": ["*"],
+    "references": [{ "path": "../editor" }]
+}