@gooddata/sdk-model 11.26.0-alpha.0 → 11.26.0-alpha.2

package/esm/pluggableApplication/index.d.ts

@@ -0,0 +1,423 @@
+import { type ILocale } from "../base/localization.js";
+import { type IEntitlementsName } from "../entitlements/index.js";
+import { type OrganizationPermissionAssignment } from "../organization/index.js";
+import { type IWorkspacePermissions } from "../permissions/index.js";
+import { type IFeatureFlags, type IPermanentSettings } from "../settings/settings.js";
+/**
+ * Defines in which scope the application should be registered.
+ *
+ * The default UI uses this information to determine if the application is visible in
+ * the organization or workspace portal.
+ *
+ * @alpha
+ */
+export type ApplicationScope = "organization" | "workspace";
+/**
+ * Localized titles of pluggable application.
+ *
+ * @alpha
+ */
+export type LocalizedTitle = {
+    [locale in ILocale]: string;
+};
+/**
+ * Logical condition for evaluating requirement properties.
+ *
+ * Supports composable AND/OR logic for determining whether an application should be accessible.
+ * Conditions can be nested arbitrarily to express complex boolean expressions.
+ *
+ * There are three forms:
+ *
+ * 1. **Plain object (implicit AND)** — all specified properties must match their expected values.
+ *    This is the simplest form and is backwards compatible with the original flat object types.
+ *    Example:
+ *      \{ canInitData: true, canRefreshData: true \} // both must be true
+ *
+ * 2. **$or condition** — at least one of the nested conditions must be satisfied.
+ *    Example:
+ *      \{ \$or: [\{ canInitData: true \}, \{ canRefreshData: true \}] \} // either one suffices
+ *
+ * 3. **$and condition** — all nested conditions must be satisfied. Useful when composing
+ *    with $or at deeper levels to express grouped AND clauses.
+ *    Example:
+ *      \{
+ *          \$or: [
+ *              \{ \$and: [\{ canInitData: true \}, \{ canManageProject: true \}] \},
+ *              \{ canRefreshData: true \},
+ *          ]
+ *      \}
+ *
+ * @alpha
+ */
+export type Condition<T> = T | IConditionOr<T> | IConditionAnd<T>;
+/**
+ * OR condition — at least one of the nested conditions must be satisfied.
+ *
+ * @alpha
+ */
+export interface IConditionOr<T> {
+    $or: Array<Condition<T>>;
+}
+/**
+ * AND condition — all nested conditions must be satisfied.
+ *
+ * @alpha
+ */
+export interface IConditionAnd<T> {
+    $and: Array<Condition<T>>;
+}
+/**
+ * Settings and their values that must be set for the pluggable application to be accessible for the currently
+ * logged user.
+ *
+ * @alpha
+ */
+export type RequiredSettings = Condition<Partial<IPermanentSettings | IFeatureFlags>>;
+/**
+ * Entitlements and their values that must be set for the pluggable application to be accessible for
+ * the currently logged user.
+ *
+ * @alpha
+ */
+export type RequiredEntitlements = Condition<Partial<{
+    [entitlement in IEntitlementsName]: string | boolean;
+}>>;
+/**
+ * Workspace permissions and their values that must be set for the pluggable application to be accessible for
+ * the currently logged user.
+ *
+ * @alpha
+ */
+export type RequiredWorkspacePermissions = Condition<Partial<IWorkspacePermissions>>;
+/**
+ * Organization permissions that must be set for the pluggable application to be accessible for
+ * the currently logged user.
+ *
+ * @alpha
+ */
+export type RequiredOrganizationPermissions = Condition<Partial<{
+    [permission in OrganizationPermissionAssignment]: boolean;
+}>>;
+/**
+ * Pluggable application meta-information, v1.
+ *
+ * @alpha
+ */
+export interface IPluggableApplicationMetaV1 {
+    /**
+     * The version of the application API.
+     *
+     * Explicit version is specified here as the applications list will be passed down the contract,
+     * for example, to shell application UI rendered, that can use 3rd party module for rendering.
+     * The local and remote registry manifest is versioned, but these types will not be passed down once
+     * the resulting list of the application is constructed from both of these manifests.
+     */
+    apiVersion: "1.0";
+    /**
+     * Unique ID of the application.
+     *
+     * Used when the application is referenced by the remote registry override and in any other case
+     * when the application needs to be referenced.
+     */
+    id: string;
+    /**
+     * States if the application is enabled and should be allowed to load by the shell application.
+     *
+     * Used mainly by the remote registry override to disable the standard application.
+     */
+    isEnabled?: boolean;
+    /**
+     * Title of the application.
+     *
+     * Used, for example, in Application Header, when the localized title variant is not provided.
+     */
+    title: string;
+    /**
+     * Optional localized titles map keyed by supported locale.
+     *
+     * It is used in the Application Header to display a localized name of the application. Each application
+     * has its own locale bundle, but it can't be used to store the localized name of the application.
+     * The application bundle is loaded and parsed only after the user clicks on the application link.
+     */
+    localizedTitle?: LocalizedTitle;
+    /**
+     * Defines in which scope the application should be registered.
+     *
+     * The default UI uses this information to determine if the application is visible in
+     * the organization or workspace portal.
+     */
+    applicationScope: ApplicationScope;
+    /**
+     * Order of the application in the menu.
+     *
+     * Applications are sorted and rendered in the default UI according to this value, from smallest
+     * to the highest.
+     */
+    menuOrder: number;
+    /**
+     * Settings (and feature flags) and their values that must be set for the pluggable application to be
+     * accessible for the currently
+     * logged user.
+     */
+    requiredSettings?: RequiredSettings;
+    /**
+     * Entitlements and their values that must be set for the pluggable application to be accessible for
+     * the currently logged user.
+     */
+    requiredEntitlements?: RequiredEntitlements;
+    /**
+     * Workspace permissions and their values that must be set for the pluggable application to be
+     * accessible for the currently logged user.
+     */
+    requiredWorkspacePermissions?: RequiredWorkspacePermissions;
+    /**
+     * Organization permissions that must be set for the pluggable application to be accessible for
+     * the currently logged user.
+     */
+    requiredOrganizationPermissions?: RequiredOrganizationPermissions;
+}
+/**
+ * Pluggable application meta-information.
+ *
+ * @alpha
+ */
+export type PluggableApplicationMeta = IPluggableApplicationMetaV1;
+/**
+ * Definition of the remote pluggable application.
+ * The application is loaded via Module Federation.
+ *
+ * @alpha
+ */
+export interface IRemotePluggableApplicationModule {
+    /**
+     * Full URL of the remote federated module with the application bundle.
+     *
+     * @example
+     * https://my-remote-federated-module.com/remoteEntry.js
+     */
+    url: string;
+    /**
+     * Unique module federation scope value (must match the remote module definition during build)
+     * Must be unique within the same remote federation to not share dependencies and scope with another
+     * application.
+     *
+     * @example
+     * "my-remote-federated-module"
+     */
+    scope: string;
+    /**
+     * Exposed module name. Must match the remote module definition.
+     * Maps to internal application module (e.g. "./src/remote-entry.tsx")
+     *
+     * @example
+     * "./AppModule"
+     */
+    module: string;
+    /**
+     * Base route of the application.
+     * It is relative to the shell application route.
+     *
+     * @example
+     * "/my-application"
+     *
+     * When the application is registered to "organization" scope, the application will be hosted at
+     * /organization/my-application.
+     * When the application is registered to the "workspace" scope, the application will be hosted at
+     * /workspace/\{workspaceId\}/my-application.
+     */
+    routeBase: string;
+}
+/**
+ * Remote pluggable application registry item, v1.
+ * Loaded via Module Federation.
+ *
+ * @alpha
+ */
+export interface IRemotePluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
+    /**
+     * Defines how the remote-federated module should be loaded.
+     */
+    remote: IRemotePluggableApplicationModule;
+}
+/**
+ * Remote pluggable application registry item.
+ * Loaded via Module Federation.
+ *
+ * @alpha
+ */
+export type RemotePluggableApplicationRegistryItem = IRemotePluggableApplicationRegistryItemV1;
+/**
+ * Definition of the pluggable application deployed locally with the shell application.
+ * The application is loaded from the host bundle asynchronously via lazy-loaded import.
+ *
+ * @alpha
+ */
+export interface ILocalPluggableApplicationModule {
+    /**
+     * Local module path.
+     * Imported from the host bundle asynchronously.
+     *
+     * @example
+     * "/src/localApps/organization.tsx"
+     */
+    localModule: string;
+    /**
+     * Base route of the application.
+     * It is relative to the shell application route.
+     *
+     * @example
+     * "/my-application
+     *
+     * When the application is registered to "organization" scope, the application will be hosted at
+     * /organization/my-application.
+     * When the application is registered to "workspace" scope, the application will be hosted at
+     * /workspace/\{workspaceId\}/my-application.
+     */
+    routeBase: string;
+}
+/**
+ * Local pluggable application registry item, v1.
+ * Loaded from the host bundle asynchronously.
+ *
+ * @alpha
+ */
+export interface ILocalPluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
+    /**
+     * Defines how the local module should be loaded.
+     */
+    local: ILocalPluggableApplicationModule;
+}
+/**
+ * Local pluggable application registry item.
+ * Loaded from the host bundle asynchronously.
+ *
+ * @alpha
+ */
+export type LocalPluggableApplicationRegistryItem = ILocalPluggableApplicationRegistryItemV1;
+/**
+ * Definition of the pluggable application that is just a URL link.
+ * The default UI will replace the application window with the URL link.
+ *
+ * @alpha
+ */
+export interface IExternalUrlPluggableApplicationModule {
+    /**
+     * URL of the external application.
+     *
+     * @example
+     * https://google.com
+     */
+    url: string;
+}
+/**
+ * External pluggable application registry item, v1.
+ *
+ * Loaded from an external application hosted module outside the shell, i.e., external link that will
+ * replace the application window.
+ *
+ * @alpha
+ */
+export interface IExternalPluggableApplicationRegistryItemV1 extends IPluggableApplicationMetaV1 {
+    /**
+     * Defines where the web application should be redirected.
+     */
+    external: IExternalUrlPluggableApplicationModule;
+}
+/**
+ * External pluggable application registry item.
+ *
+ * Loaded from an external application hosted module outside the shell, i.e., external link that will
+ * replace the application window.
+ *
+ * @alpha
+ */
+export type ExternalPluggableApplicationRegistryItem = IExternalPluggableApplicationRegistryItemV1;
+/**
+ * Pluggable application registry item
+ *
+ * @alpha
+ */
+export type PluggableApplicationRegistryItem = RemotePluggableApplicationRegistryItem | LocalPluggableApplicationRegistryItem | ExternalPluggableApplicationRegistryItem;
+/**
+ * Pluggable application registry, v1.
+ *
+ * @alpha
+ */
+export interface ILocalPluggableApplicationsRegistryV1 {
+    /**
+     * The version of the API used by the application manifest
+     */
+    apiVersion: "1.0";
+    /**
+     * The list of pluggable applications deployed in the shell application by default.
+     */
+    applications: PluggableApplicationRegistryItem[];
+}
+/**
+ * Pluggable application registry
+ *
+ * @alpha
+ */
+export type LocalPluggableApplicationsRegistry = ILocalPluggableApplicationsRegistryV1;
+/**
+ * Pluggable application remote registry, v1.
+ *
+ * @alpha
+ */
+export interface IRemotePluggableApplicationsRegistryV1 {
+    /**
+     * The version of the API used by the application manifest
+     */
+    apiVersion: "1.0";
+    /**
+     * The overrides of the pluggable applications deployed in the shell application by default.
+     *
+     * Each override is mapped to a key that is the well-documented ID of the default pluggable application,
+     * e.g., gdc-analytical-designer, gdc-dashboards, etc. The property can be used, for example, to disable
+     * one of these applications or changing the order under which it is added to the Application Header menu.
+     */
+    overrides?: {
+        [applicationId: string]: Partial<PluggableApplicationRegistryItem>;
+    };
+    /**
+     * The optional list of allowed standard applications.
+     *
+     * The array of well-documented IDs of the standard applications that are deployed in the shell
+     * application by default. The property can be used to stabilize which of the standard applications
+     * will be available in the Application Header menu. When a new standard application is deployed in
+     * the shell application, it will not appear in the menu until it is added to the list of allowed
+     * standard applications.
+     */
+    allowedStandardApplications?: string[];
+    /**
+     * The list of additional pluggable applications registered to the shell application.
+     *
+     * Mainly used to register 3rd party hosted remote module federated applications.
+     */
+    applications?: PluggableApplicationRegistryItem[];
+}
+/**
+ * Pluggable application remote registry
+ *
+ * @alpha
+ */
+export type RemotePluggableApplicationsRegistry = IRemotePluggableApplicationsRegistryV1;
+/**
+ * Type guard for ExternalPluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export declare function isExternalPluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is ExternalPluggableApplicationRegistryItem;
+/**
+ * Type guard for LocalPluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export declare function isLocalPluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is LocalPluggableApplicationRegistryItem;
+/**
+ * Type guard for RemotePluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export declare function isRemotePluggableApplicationRegistryItem(app: PluggableApplicationRegistryItem): app is RemotePluggableApplicationRegistryItem;
+//# sourceMappingURL=index.d.ts.map

package/esm/pluggableApplication/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/pluggableApplication/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EAAE,KAAK,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE,OAAO,EAAE,KAAK,gCAAgC,EAAE,MAAM,0BAA0B,CAAC;AACjF,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AACrE,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAEtF;;;;;;;GAOG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,GAAG,WAAW,CAAC;AAE5D;;;;GAIG;AACH,MAAM,MAAM,cAAc,GAAG;KACxB,MAAM,IAAI,OAAO,GAAG,MAAM;CAC9B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAM,MAAM,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;AAElE;;;;GAIG;AACH,MAAM,WAAW,YAAY,CAAC,CAAC;IAC3B,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC;IAC5B,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;CAC7B;AAED;;;;;GAKG;AACH,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,CAAC,kBAAkB,GAAG,aAAa,CAAC,CAAC,CAAC;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,SAAS,CACxC,OAAO,CAAC;KACH,WAAW,IAAI,iBAAiB,GAAG,MAAM,GAAG,OAAO;CACvD,CAAC,CACL,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG,SAAS,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC,CAAC;AAErF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG,SAAS,CACnD,OAAO,CAAC;KACH,UAAU,IAAI,gCAAgC,GAAG,OAAO;CAC5D,CAAC,CACL,CAAC;AAEF;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IACxC;;;;;;;OAOG;IACH,UAAU,EAAE,KAAK,CAAC;IAClB;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;;OAKG;IACH,gBAAgB,EAAE,gBAAgB,CAAC;IAEnC;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;IAE5C;;;OAGG;IACH,4BAA4B,CAAC,EAAE,4BAA4B,CAAC;IAE5D;;;OAGG;IACH,+BAA+B,CAAC,EAAE,+BAA+B,CAAC;CACrE;AAED;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,2BAA2B,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,WAAW,iCAAiC;IAC9C;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;;;;OAOG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;OAMG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;OAWG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,yCAA0C,SAAQ,2BAA2B;IAC1F;;OAEG;IACH,MAAM,EAAE,iCAAiC,CAAC;CAC7C;AAED;;;;;GAKG;AACH,MAAM,MAAM,sCAAsC,GAAG,yCAAyC,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,WAAW,gCAAgC;IAC7C;;;;;;OAMG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;;;OAWG;IACH,SAAS,EAAE,MAAM,CAAC;CACrB;AAED;;;;;GAKG;AACH,MAAM,WAAW,wCAAyC,SAAQ,2BAA2B;IACzF;;OAEG;IACH,KAAK,EAAE,gCAAgC,CAAC;CAC3C;AAED;;;;;GAKG;AACH,MAAM,MAAM,qCAAqC,GAAG,wCAAwC,CAAC;AAE7F;;;;;GAKG;AACH,MAAM,WAAW,sCAAsC;IACnD;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,2CAA4C,SAAQ,2BAA2B;IAC5F;;OAEG;IACH,QAAQ,EAAE,sCAAsC,CAAC;CACpD;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,wCAAwC,GAAG,2CAA2C,CAAC;AAEnG;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GACtC,sCAAsC,GACtC,qCAAqC,GACrC,wCAAwC,CAAC;AAE/C;;;;GAIG;AACH,MAAM,WAAW,qCAAqC;IAClD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,gCAAgC,EAAE,CAAC;CACpD;AAED;;;;GAIG;AACH,MAAM,MAAM,kCAAkC,GAAG,qCAAqC,CAAC;AAEvF;;;;GAIG;AACH,MAAM,WAAW,sCAAsC;IACnD;;OAEG;IACH,UAAU,EAAE,KAAK,CAAC;IAClB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,aAAa,EAAE,MAAM,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAAA;KAAE,CAAC;IACnF;;;;;;;;OAQG;IACH,2BAA2B,CAAC,EAAE,MAAM,EAAE,CAAC;IACvC;;;;OAIG;IACH,YAAY,CAAC,EAAE,gCAAgC,EAAE,CAAC;CACrD;AAED;;;;GAIG;AACH,MAAM,MAAM,mCAAmC,GAAG,sCAAsC,CAAC;AAEzF;;;;GAIG;AACH,wBAAgB,0CAA0C,CACtD,GAAG,EAAE,gCAAgC,GACtC,GAAG,IAAI,wCAAwC,CAEjD;AAED;;;;GAIG;AACH,wBAAgB,uCAAuC,CACnD,GAAG,EAAE,gCAAgC,GACtC,GAAG,IAAI,qCAAqC,CAE9C;AAED;;;;GAIG;AACH,wBAAgB,wCAAwC,CACpD,GAAG,EAAE,gCAAgC,GACtC,GAAG,IAAI,sCAAsC,CAE/C"}

package/esm/pluggableApplication/index.js

@@ -0,0 +1,27 @@
+// (C) 2026 GoodData Corporation
+import { isEmpty } from "lodash-es";
+/**
+ * Type guard for ExternalPluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export function isExternalPluggableApplicationRegistryItem(app) {
+    return !isEmpty(app) && app.external !== undefined;
+}
+/**
+ * Type guard for LocalPluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export function isLocalPluggableApplicationRegistryItem(app) {
+    return !isEmpty(app) && app.local !== undefined;
+}
+/**
+ * Type guard for RemotePluggableApplicationRegistryItem
+ *
+ * @alpha
+ */
+export function isRemotePluggableApplicationRegistryItem(app) {
+    return !isEmpty(app) && app.remote !== undefined;
+}
+//# sourceMappingURL=index.js.map

package/esm/pluggableApplication/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/pluggableApplication/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAkcpC;;;;GAIG;AACH,MAAM,UAAU,0CAA0C,CACtD,GAAqC,EACU;IAC/C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAK,GAAgD,CAAC,QAAQ,KAAK,SAAS,CAAC;AAAA,CACpG;AAED;;;;GAIG;AACH,MAAM,UAAU,uCAAuC,CACnD,GAAqC,EACO;IAC5C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAK,GAA6C,CAAC,KAAK,KAAK,SAAS,CAAC;AAAA,CAC9F;AAED;;;;GAIG;AACH,MAAM,UAAU,wCAAwC,CACpD,GAAqC,EACQ;IAC7C,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAK,GAA8C,CAAC,MAAM,KAAK,SAAS,CAAC;AAAA,CAChG"}