@gooddata/sdk-ui-pluggable-application 11.25.0-alpha.2

package/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2026 GoodData Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,10 @@
+# GoodData.UI SDK - UI Pluggable Application
+
+This package is a part of the [GoodData.UI SDK](https://sdk.gooddata.com/gooddata-ui/docs/about_gooddataui.html).
+It provides React helpers for consuming platform context in pluggable applications.
+
+## License
+
+(C) 2026 GoodData Corporation
+
+This project is under MIT License. See `LICENSE`.

package/esm/context.d.ts

@@ -0,0 +1,32 @@
+import { type PropsWithChildren } from "react";
+import { type IPlatformContext } from "@gooddata/sdk-pluggable-application-model";
+/**
+ * Props for {@link PlatformContextProvider}.
+ *
+ * @public
+ */
+export interface IPlatformContextProviderProps extends PropsWithChildren {
+    /**
+     * Platform context snapshot.
+     */
+    value: IPlatformContext;
+}
+/**
+ * React provider that binds platform context into React context.
+ *
+ * @public
+ */
+export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): import("react/jsx-runtime").JSX.Element;
+/**
+ * Returns platform context snapshot (or undefined if not available yet).
+ *
+ * @public
+ */
+export declare function usePlatformContext(): IPlatformContext | undefined;
+/**
+ * Returns platform context snapshot and throws if it's not available.
+ *
+ * @public
+ */
+export declare function usePlatformContextStrict(context?: string): IPlatformContext;
+//# sourceMappingURL=context.d.ts.map

package/esm/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../src/context.tsx"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,iBAAiB,EAA6B,MAAM,OAAO,CAAC;AAI1E,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAKlF;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACpE;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,6BAA6B,2CAEzF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,gBAAgB,GAAG,SAAS,CAEjE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,SAA6B,GAAG,gBAAgB,CAO/F"}

package/esm/context.js

@@ -0,0 +1,33 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+// (C) 2026 GoodData Corporation
+import { createContext, useContext } from "react";
+import { invariant } from "ts-invariant";
+const PlatformContext = createContext(undefined);
+PlatformContext.displayName = "PlatformContext";
+/**
+ * React provider that binds platform context into React context.
+ *
+ * @public
+ */
+export function PlatformContextProvider({ value, children }) {
+    return _jsx(PlatformContext.Provider, { value: value, children: children });
+}
+/**
+ * Returns platform context snapshot (or undefined if not available yet).
+ *
+ * @public
+ */
+export function usePlatformContext() {
+    return useContext(PlatformContext);
+}
+/**
+ * Returns platform context snapshot and throws if it's not available.
+ *
+ * @public
+ */
+export function usePlatformContextStrict(context = "usePlatformContextStrict") {
+    const value = usePlatformContext();
+    invariant(value, `${context}: platform context is not available. Make sure PlatformContextProvider is mounted and the host provided a context snapshot.`);
+    return value;
+}
+//# sourceMappingURL=context.js.map

package/esm/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../src/context.tsx"],"names":[],"mappings":";AAAA,gCAAgC;AAEhC,OAAO,EAA0B,aAAa,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAE1E,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAIzC,MAAM,eAAe,GAAG,aAAa,CAA+B,SAAS,CAAC,CAAC;AAC/E,eAAe,CAAC,WAAW,GAAG,iBAAiB,CAAC;AAchD;;;;GAIG;AACH,MAAM,UAAU,uBAAuB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAiC,EAAE;IACxF,OAAO,KAAC,eAAe,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YAAG,QAAQ,GAA4B,CAAC;AAAA,CACxF;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,GAAiC;IAC/D,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AAAA,CACtC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAO,GAAG,0BAA0B,EAAoB;IAC7F,MAAM,KAAK,GAAG,kBAAkB,EAAE,CAAC;IACnC,SAAS,CACL,KAAK,EACL,GAAG,OAAO,6HAA6H,CAC1I,CAAC;IACF,OAAO,KAAK,CAAC;AAAA,CAChB"}

package/esm/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * React helpers for pluggable application integration.
+ *
+ * @packageDocumentation
+ */
+export { PlatformContextProvider, type IPlatformContextProviderProps, usePlatformContext, usePlatformContextStrict, } from "./context.js";
+//# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AAEH,OAAO,EACH,uBAAuB,EACvB,KAAK,6BAA6B,EAClC,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC"}

package/esm/index.js

@@ -0,0 +1,9 @@
+// (C) 2026 GoodData Corporation
+/* oxlint-disable no-barrel-files/no-barrel-files */
+/**
+ * React helpers for pluggable application integration.
+ *
+ * @packageDocumentation
+ */
+export { PlatformContextProvider, usePlatformContext, usePlatformContextStrict, } from "./context.js";
+//# sourceMappingURL=index.js.map

package/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,oDAAoD;AAEpD;;;;GAIG;AAEH,OAAO,EACH,uBAAuB,EAEvB,kBAAkB,EAClB,wBAAwB,GAC3B,MAAM,cAAc,CAAC"}

package/esm/sdk-ui-pluggable-application.d.ts

@@ -0,0 +1,44 @@
+/**
+ * React helpers for pluggable application integration.
+ *
+ * @packageDocumentation
+ */
+
+import { IPlatformContext } from '@gooddata/sdk-pluggable-application-model';
+import { JSX } from 'react/jsx-runtime';
+import { PropsWithChildren } from 'react';
+
+/**
+ * Props for {@link PlatformContextProvider}.
+ *
+ * @public
+ */
+export declare interface IPlatformContextProviderProps extends PropsWithChildren {
+    /**
+     * Platform context snapshot.
+     */
+    value: IPlatformContext;
+}
+
+/**
+ * React provider that binds platform context into React context.
+ *
+ * @public
+ */
+export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): JSX.Element;
+
+/**
+ * Returns platform context snapshot (or undefined if not available yet).
+ *
+ * @public
+ */
+export declare function usePlatformContext(): IPlatformContext | undefined;
+
+/**
+ * Returns platform context snapshot and throws if it's not available.
+ *
+ * @public
+ */
+export declare function usePlatformContextStrict(context?: string): IPlatformContext;
+
+export { }

package/esm/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.55.2"
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@gooddata/sdk-ui-pluggable-application",
+  "version": "11.25.0-alpha.2",
+  "description": "GoodData SDK React helpers for pluggable applications",
+  "license": "MIT",
+  "author": "GoodData Corporation",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/gooddata/gooddata-ui-sdk.git",
+    "directory": "libs/sdk-ui-pluggable-application"
+  },
+  "files": [
+    "esm/**/*.js",
+    "esm/**/*.json",
+    "esm/**/*.d.ts",
+    "esm/**/*.map"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "browser": "./esm/index.js",
+  "types": "./esm/index.d.ts",
+  "exports": "./esm/index.js",
+  "dependencies": {
+    "ts-invariant": "0.10.3",
+    "tslib": "2.8.1",
+    "@gooddata/sdk-pluggable-application-model": "11.25.0-alpha.2"
+  },
+  "devDependencies": {
+    "@microsoft/api-documenter": "^7.17.0",
+    "@microsoft/api-extractor": "^7.55.2",
+    "@types/node": "22.13.0",
+    "@types/react": "19.1.11",
+    "@types/react-dom": "19.1.7",
+    "@typescript-eslint/eslint-plugin": "8.52.0",
+    "@typescript-eslint/parser": "8.52.0",
+    "@typescript/native-preview": "7.0.0-dev.20260202.1",
+    "dependency-cruiser": "^14.1.2",
+    "eslint": "^9.39.2",
+    "eslint-import-resolver-typescript": "4.4.4",
+    "eslint-plugin-headers": "1.3.3",
+    "eslint-plugin-import-esm": "1.2.1",
+    "eslint-plugin-import-x": "4.16.1",
+    "eslint-plugin-jsdoc": "62.1.0",
+    "eslint-plugin-no-barrel-files": "1.2.2",
+    "eslint-plugin-no-only-tests": "3.3.0",
+    "eslint-plugin-react": "7.37.5",
+    "eslint-plugin-react-hooks": "5.2.0",
+    "eslint-plugin-sonarjs": "3.0.6",
+    "happy-dom": "18.0.1",
+    "npm-run-all": "^4.1.5",
+    "oxfmt": "0.27.0",
+    "oxlint": "^1.43.0",
+    "oxlint-tsgolint": "0.11.4",
+    "react": "19.1.1",
+    "react-dom": "19.1.1",
+    "typescript": "5.9.3",
+    "vitest": "4.0.8",
+    "@gooddata/oxlint-config": "11.25.0-alpha.2",
+    "@gooddata/eslint-config": "11.25.0-alpha.2"
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "scripts": {
+    "_phase:build": "npm run build",
+    "_phase:test": "echo \"No tests for @gooddata/sdk-ui-pluggable-application\"",
+    "_phase:validate": "npm run validate",
+    "api-extractor": "mkdir -p api && [ -z \"${CI}\" ] && (api-extractor run -l) || (api-extractor run)",
+    "build": "npm-run-all -p build-check build-ts && npm run api-extractor",
+    "build-check": "tsgo",
+    "build-ts": "tsgo -p tsconfig.build.json",
+    "clean": "../../common/scripts/clean-command-state.sh && rm -rf ci dist esm coverage *.log tsconfig.tsbuildinfo",
+    "dep-cruiser": "depcruise --validate .dependency-cruiser.cjs --output-type err-long src/",
+    "format-check": "oxfmt --check .",
+    "format-write": "oxfmt .",
+    "lint": "oxlint . --type-aware --quiet && eslint .",
+    "lint-fix": "oxlint . --type-aware --quiet --fix && eslint . --fix",
+    "test": "vitest watch",
+    "test-once": "vitest run --passWithNoTests",
+    "validate": "npm run lint && npm run dep-cruiser && npm run format-check",
+    "validate-esm": "node --input-type=module --eval 'import \"@gooddata/sdk-ui-pluggable-application\"'"
+  }
+}