feat: experimental plugin release

dhis2 · Dec 20, 2023 · f5cca86 · f5cca86
2 parents d61be79 + be215b2
commit f5cca86
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 6 deletions.
diff --git a/docs/components/Plugin.md b/docs/components/Plugin.md
@@ -1,13 +1,15 @@
 # Plugin Component
 
+_NOTE:_ This component is experimental and is available for import from `@dhis2/app-runtime/experimental`. The api for this component is not guaranteed to be stable.
+
 A wrapper that creates an iframe for a specified plugin and establishes a two-way communication channel with said plugin, allowing you to pass props (including callbacks between an app and a plugin). Note that the plugin must be built using the app-platform with entryPoints.plugin specified in the d2.config.js file.
 
 ## Basic Usage (Defining a plugin within an app)
 
-Within an app you can specify a plugin (either by providing its short name `pluginShortName`, or by specifying a URL directly (`pluginSource`). If you have provided `pluginSource`, this will take precedence (Note: lookup logic is TBD? Should we allow a URL only in development mode, for example?).
+Within an app you can specify a plugin (either by providing its short name `pluginShortName`, or by specifying a URL directly (`pluginSource`). If you have provided `pluginSource`, this will take precedence.
 
 ```jsx
-import { Plugin } from '@dhis2/app-runtime'
+import { Plugin } from '@dhis2/app-runtime/experimental'
 
 // within the app
 const MyApp = () => (

diff --git a/runtime/package.json b/runtime/package.json
@@ -6,8 +6,14 @@
     "module": "./build/es/index.js",
     "types": "./build/types/index.d.ts",
     "exports": {
-        "import": "./build/es/index.js",
-        "require": "./build/cjs/index.js"
+        ".": {
+            "import": "./build/es/index.js",
+            "require": "./build/cjs/index.js"
+        },
+        "./experimental": {
+            "import": "./build/es/experimental.js",
+            "require": "./build/cjs/experimental.js"
+        }
     },
     "repository": {
         "type": "git",

diff --git a/runtime/src/experimental.ts b/runtime/src/experimental.ts
@@ -0,0 +1,4 @@
+/**
+ * this is experimental and the API is unstable
+ */
+export { Plugin } from '@dhis2/app-service-plugin'
diff --git a/runtime/src/index.ts b/runtime/src/index.ts
@@ -23,6 +23,4 @@ export {
     clearSensitiveCaches,
 } from '@dhis2/app-service-offline'
 
-export { Plugin } from '@dhis2/app-service-plugin'
-
 export { Provider } from './Provider'