@gooddata/sdk-ui-pluggable-application 11.28.0-alpha.1 → 11.28.0-alpha.11

package/esm/context.d.ts

@@ -1,5 +1,28 @@
 import { type PropsWithChildren } from "react";
+import { type IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
 import { type IPlatformContext } from "@gooddata/sdk-pluggable-application-model";
+/**
+ * Platform context extended with a client-created backend instance.
+ *
+ * @remarks
+ * Client applications receive `IPlatformContext` from the shell (which
+ * contains auth credentials but no backend). They create their own backend
+ * using those credentials and produce an `IClientPlatformContext` which
+ * includes the backend instance.
+ *
+ * The backend's `internal_backendSpecificFunctions` field carries any
+ * backend-specific escape hatches (e.g., tiger-specific functions)
+ * automatically.
+ *
+ * @public
+ */
+export interface IClientPlatformContext extends IPlatformContext {
+    /**
+     * Backend instance created by the client application from the
+     * auth credentials in the platform context.
+     */
+    backend: IAnalyticalBackend;
+}
 /**
  * Props for {@link PlatformContextProvider}.
  *
@@ -7,9 +30,9 @@ import { type IPlatformContext } from "@gooddata/sdk-pluggable-application-model
  */
 export interface IPlatformContextProviderProps extends PropsWithChildren {
     /**
-     * Platform context snapshot.
+     * Client platform context snapshot (includes the client-created backend).
      */
-    value: IPlatformContext;
+    value: IClientPlatformContext;
 }
 /**
  * React provider that binds platform context into React context.
@@ -18,15 +41,15 @@ export interface IPlatformContextProviderProps extends PropsWithChildren {
  */
 export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): import("react/jsx-runtime").JSX.Element;
 /**
- * Returns platform context snapshot (or undefined if not available yet).
+ * Returns client platform context snapshot (or undefined if not available yet).
  *
  * @public
  */
-export declare function usePlatformContext(): IPlatformContext | undefined;
+export declare function usePlatformContext(): IClientPlatformContext | undefined;
 /**
- * Returns platform context snapshot and throws if it's not available.
+ * Returns client platform context snapshot and throws if it's not available.
  *
  * @public
  */
-export declare function usePlatformContextStrict(context?: string): IPlatformContext;
+export declare function usePlatformContextStrict(context?: string): IClientPlatformContext;
 //# sourceMappingURL=context.d.ts.map

package/esm/context.d.ts.map

@@ -1 +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"}
+{"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,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,EAAE,KAAK,gBAAgB,EAAE,MAAM,2CAA2C,CAAC;AAElF;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,sBAAuB,SAAQ,gBAAgB;IAC5D;;;OAGG;IACH,OAAO,EAAE,kBAAkB,CAAC;CAC/B;AAKD;;;;GAIG;AACH,MAAM,WAAW,6BAA8B,SAAQ,iBAAiB;IACpE;;OAEG;IACH,KAAK,EAAE,sBAAsB,CAAC;CACjC;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,EAAE,6BAA6B,2CAEzF;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,IAAI,sBAAsB,GAAG,SAAS,CAEvE;AAED;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,OAAO,SAA6B,GAAG,sBAAsB,CAOrG"}

package/esm/context.js

@@ -13,7 +13,7 @@ export function PlatformContextProvider({ value, children }) {
     return _jsx(PlatformContext.Provider, { value: value, children: children });
 }
 /**
- * Returns platform context snapshot (or undefined if not available yet).
+ * Returns client platform context snapshot (or undefined if not available yet).
  *
  * @public
  */
@@ -21,7 +21,7 @@ export function usePlatformContext() {
     return useContext(PlatformContext);
 }
 /**
- * Returns platform context snapshot and throws if it's not available.
+ * Returns client platform context snapshot and throws if it's not available.
  *
  * @public
  */

package/esm/context.js.map

@@ -1 +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"}
+{"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;AA4BzC,MAAM,eAAe,GAAG,aAAa,CAAqC,SAAS,CAAC,CAAC;AACrF,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,GAAuC;IACrE,OAAO,UAAU,CAAC,eAAe,CAAC,CAAC;AAAA,CACtC;AAED;;;;GAIG;AACH,MAAM,UAAU,wBAAwB,CAAC,OAAO,GAAG,0BAA0B,EAA0B;IACnG,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

@@ -3,5 +3,5 @@
  *
  * @packageDocumentation
  */
-export { PlatformContextProvider, type IPlatformContextProviderProps, usePlatformContext, usePlatformContextStrict, } from "./context.js";
+export { type IClientPlatformContext, PlatformContextProvider, type IPlatformContextProviderProps, usePlatformContext, usePlatformContextStrict, } from "./context.js";
 //# sourceMappingURL=index.d.ts.map

package/esm/index.d.ts.map

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

package/esm/index.js.map

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

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

@@ -4,10 +4,34 @@
  * @packageDocumentation
  */
 
+import { IAnalyticalBackend } from '@gooddata/sdk-backend-spi';
 import { IPlatformContext } from '@gooddata/sdk-pluggable-application-model';
 import { JSX } from 'react/jsx-runtime';
 import { PropsWithChildren } from 'react';
 
+/**
+ * Platform context extended with a client-created backend instance.
+ *
+ * @remarks
+ * Client applications receive `IPlatformContext` from the shell (which
+ * contains auth credentials but no backend). They create their own backend
+ * using those credentials and produce an `IClientPlatformContext` which
+ * includes the backend instance.
+ *
+ * The backend's `internal_backendSpecificFunctions` field carries any
+ * backend-specific escape hatches (e.g., tiger-specific functions)
+ * automatically.
+ *
+ * @public
+ */
+export declare interface IClientPlatformContext extends IPlatformContext {
+    /**
+     * Backend instance created by the client application from the
+     * auth credentials in the platform context.
+     */
+    backend: IAnalyticalBackend;
+}
+
 /**
  * Props for {@link PlatformContextProvider}.
  *
@@ -15,9 +39,9 @@ import { PropsWithChildren } from 'react';
  */
 export declare interface IPlatformContextProviderProps extends PropsWithChildren {
     /**
-     * Platform context snapshot.
+     * Client platform context snapshot (includes the client-created backend).
      */
-    value: IPlatformContext;
+    value: IClientPlatformContext;
 }
 
 /**
@@ -28,17 +52,17 @@ export declare interface IPlatformContextProviderProps extends PropsWithChildren
 export declare function PlatformContextProvider({ value, children }: IPlatformContextProviderProps): JSX.Element;
 
 /**
- * Returns platform context snapshot (or undefined if not available yet).
+ * Returns client platform context snapshot (or undefined if not available yet).
  *
  * @public
  */
-export declare function usePlatformContext(): IPlatformContext | undefined;
+export declare function usePlatformContext(): IClientPlatformContext | undefined;
 
 /**
- * Returns platform context snapshot and throws if it's not available.
+ * Returns client platform context snapshot and throws if it's not available.
  *
  * @public
  */
-export declare function usePlatformContextStrict(context?: string): IPlatformContext;
+export declare function usePlatformContextStrict(context?: string): IClientPlatformContext;
 
 export { }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-pluggable-application",
-  "version": "11.28.0-alpha.1",
+  "version": "11.28.0-alpha.11",
   "description": "GoodData SDK React helpers for pluggable applications",
   "license": "MIT",
   "author": "GoodData Corporation",
@@ -23,7 +23,8 @@
   "dependencies": {
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
-    "@gooddata/sdk-pluggable-application-model": "11.28.0-alpha.1"
+    "@gooddata/sdk-backend-spi": "11.28.0-alpha.11",
+    "@gooddata/sdk-pluggable-application-model": "11.28.0-alpha.11"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -55,8 +56,8 @@
     "react-dom": "19.1.1",
     "typescript": "5.9.3",
     "vitest": "4.1.0",
-    "@gooddata/eslint-config": "11.28.0-alpha.1",
-    "@gooddata/oxlint-config": "11.28.0-alpha.1"
+    "@gooddata/eslint-config": "11.28.0-alpha.11",
+    "@gooddata/oxlint-config": "11.28.0-alpha.11"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",