@gooddata/sdk-ui-ext 11.51.0-alpha.1 → 11.51.0-alpha.2

package/esm/share/useObjectShareDialog.d.ts

@@ -0,0 +1,90 @@
+import type { IObjectPermissionsObject } from "@gooddata/sdk-backend-spi";
+import { type IObjectShareControllerActions, type IObjectShareControllerState, type IObjectShareGrantee, type ObjectSharePermissionLevel } from "./objectShareController.types.js";
+import type { IObjectAccessSummary, IObjectShareLabel } from "./types.js";
+/**
+ * The presentational state {@link ObjectShareDialog} renders from. All logic —
+ * controller ownership, the self-restriction confirm flow, open/close and the
+ * mutation gating — lives here; the component maps this to JSX and holds no logic
+ * of its own.
+ *
+ * @internal
+ */
+export interface IObjectShareDialogViewModel {
+    /** The controller's current state, read by the component to build its rows and props. */
+    state: IObjectShareControllerState;
+    /** The controller's mutation actions, wired to the rendered controls. */
+    actions: IObjectShareControllerActions;
+    /** Whether the main share view (grantee list + general access) is visible. */
+    isShareViewOpen: boolean;
+    /** Whether the add-grantee sub-dialog is visible. */
+    isAddGranteeOpen: boolean;
+    /** Whether the general-access RESTRICTED↔WORKSPACE confirm is visible. */
+    isGeneralAccessConfirmOpen: boolean;
+    /** Whether the "Restrict your access?" self-restriction confirm is visible. */
+    isSelfRestrictConfirmOpen: boolean;
+    /**
+     * Whether access-changing controls may be used. False until the list has loaded
+     * AND per-label scope resolved: before then the controller reports a placeholder
+     * (empty grantees + RESTRICTED, scope assumed-all), so a write would diff against
+     * a false state — skipping grants or revoking the wrong labels.
+     */
+    isMutable: boolean;
+    /**
+     * Whether the dialog is still in its initial load — the access list or the
+     * session's first label-scope resolution in flight. The component shows
+     * skeletons in place of the grantee list and general access, so the reveal
+     * happens once, with controls already actionable (or legitimately disabled
+     * after a failed resolution). Mid-session re-probes don't turn it back on.
+     */
+    isLoading: boolean;
+    /** The controller's workspace-rule menu policy, forwarded (see `IObjectShareControllerState`). */
+    workspaceDisabledLevels: ObjectSharePermissionLevel[] | undefined;
+    /**
+     * The controller's self-managed-row policy resolved per row: its disabled levels
+     * for the signed-in user's own sole grant, undefined for every other row.
+     */
+    rowDisabledLevels: (grantee: IObjectShareGrantee) => ObjectSharePermissionLevel[] | undefined;
+    /** Close the whole dialog, discarding any staged self-restriction. */
+    onClose: () => void;
+    /**
+     * Handle a grantee row's permission change. The signed-in user's own sole grant is
+     * staged for the self-restriction confirm; every other row commits immediately.
+     */
+    onRowPermissionChange: (grantee: IObjectShareGrantee, level: ObjectSharePermissionLevel) => void;
+    /** Handle a grantee row's remove. Same self-restriction routing as {@link onRowPermissionChange}. */
+    onRowRemove: (grantee: IObjectShareGrantee) => void;
+    /** Dismiss the self-restriction confirm, leaving the user's own access unchanged. */
+    onSelfRestrictCancel: () => void;
+    /** Apply the staged self-restriction — lower the user's own level, or remove their grant. */
+    onSelfRestrictConfirm: () => void;
+}
+/**
+ * Inputs to {@link useObjectShareDialog} — the subset of {@link ObjectShareDialog}'s
+ * props the presentation logic needs. The component owns the public prop interface
+ * and forwards these through.
+ */
+interface IUseObjectShareDialogParams {
+    /** Object whose access is managed. Fixed for the mount — remount for a new target. */
+    target: IObjectPermissionsObject | undefined;
+    /** Called when the dialog requests to close; closing unmounts the session, discarding its state. */
+    onClose: () => void;
+    /** Fires with the current access summary whenever the displayed access changes. */
+    onSummaryChange?: (summary: IObjectAccessSummary) => void;
+    /** Attribute labels enabling the per-grantee scope picker; forwarded to the controller. */
+    labels?: IObjectShareLabel[];
+    /** Whether the object's labels are still loading (gates mutations); forwarded to the controller. */
+    labelsLoading?: boolean;
+    /** Whether the object's labels failed to load (gates mutations); forwarded to the controller. */
+    labelsError?: boolean;
+}
+/**
+ * Owns everything {@link ObjectShareDialog} needs to render for one dialog session:
+ * the controller, the self-restriction confirm flow, the mutation-gating flags, and
+ * the outward summary synchronization. Returns a flat view model the component
+ * renders — no JSX and no rendering logic here.
+ *
+ * @internal
+ */
+export declare function useObjectShareDialog({ target, onClose, onSummaryChange, labels, labelsLoading, labelsError }: IUseObjectShareDialogParams): IObjectShareDialogViewModel;
+export {};
+//# sourceMappingURL=useObjectShareDialog.d.ts.map

package/esm/share/useObjectShareDialog.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useObjectShareDialog.d.ts","sourceRoot":"","sources":["../../src/share/useObjectShareDialog.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,2BAA2B,CAAC;AAE1E,OAAO,EACH,KAAK,6BAA6B,EAClC,KAAK,2BAA2B,EAChC,KAAK,mBAAmB,EACxB,KAAK,0BAA0B,EAClC,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAY1E;;;;;;;GAOG;AACH,MAAM,WAAW,2BAA2B;IACxC,yFAAyF;IACzF,KAAK,EAAE,2BAA2B,CAAC;IACnC,yEAAyE;IACzE,OAAO,EAAE,6BAA6B,CAAC;IAEvC,8EAA8E;IAC9E,eAAe,EAAE,OAAO,CAAC;IACzB,qDAAqD;IACrD,gBAAgB,EAAE,OAAO,CAAC;IAC1B,4EAA0E;IAC1E,0BAA0B,EAAE,OAAO,CAAC;IACpC,+EAA+E;IAC/E,yBAAyB,EAAE,OAAO,CAAC;IAEnC;;;;;OAKG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;;;;;OAMG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB,kGAAkG;IAClG,uBAAuB,EAAE,0BAA0B,EAAE,GAAG,SAAS,CAAC;IAClE;;;OAGG;IACH,iBAAiB,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,0BAA0B,EAAE,GAAG,SAAS,CAAC;IAE9F,sEAAsE;IACtE,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB;;;OAGG;IACH,qBAAqB,EAAE,CAAC,OAAO,EAAE,mBAAmB,EAAE,KAAK,EAAE,0BAA0B,KAAK,IAAI,CAAC;IACjG,qGAAqG;IACrG,WAAW,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACpD,qFAAqF;IACrF,oBAAoB,EAAE,MAAM,IAAI,CAAC;IACjC,+FAA6F;IAC7F,qBAAqB,EAAE,MAAM,IAAI,CAAC;CACrC;AAED;;;;GAIG;AACH,UAAU,2BAA2B;IACjC,wFAAsF;IACtF,MAAM,EAAE,wBAAwB,GAAG,SAAS,CAAC;IAC7C,oGAAoG;IACpG,OAAO,EAAE,MAAM,IAAI,CAAC;IACpB,mFAAmF;IACnF,eAAe,CAAC,EAAE,CAAC,OAAO,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC1D,2FAA2F;IAC3F,MAAM,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAC7B,oGAAoG;IACpG,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,iGAAiG;IACjG,WAAW,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;;;;;GAOG;AACH,wBAAgB,oBAAoB,CAAC,EACjC,MAAM,EACN,OAAO,EACP,eAAe,EACf,MAAM,EACN,aAAa,EACb,WAAW,EACd,EAAE,2BAA2B,GAAG,2BAA2B,CAwF3D"}

package/esm/share/useObjectShareDialog.js

@@ -0,0 +1,82 @@
+// (C) 2026 GoodData Corporation
+import { useCallback, useEffect, useState } from "react";
+import { useObjectShareController } from "./useObjectShareController.js";
+/**
+ * Owns everything {@link ObjectShareDialog} needs to render for one dialog session:
+ * the controller, the self-restriction confirm flow, the mutation-gating flags, and
+ * the outward summary synchronization. Returns a flat view model the component
+ * renders — no JSX and no rendering logic here.
+ *
+ * @internal
+ */
+export function useObjectShareDialog({ target, onClose, onSummaryChange, labels, labelsLoading, labelsError, }) {
+    const { state, actions } = useObjectShareController(target, { labels, labelsError, labelsLoading });
+    const [pendingSelfChange, setPendingSelfChange] = useState(undefined);
+    // Synchronize the displayed access summary out to the consumer — the legitimate
+    // effect kind (notifying an external system of a change). `state.summary` is
+    // content-stable, so this fires exactly when the displayed access changes: on
+    // load, and after each summary-affecting mutation.
+    //
+    // Deliberately OPTIMISTIC: the summary is emitted as soon as an edit applies,
+    // not when it settles. A failure while the dialog is open self-corrects (the
+    // overlay reverts and the corrected summary re-emits); a failure landing after
+    // the dialog closed leaves the consumer with the optimistic value — an accepted
+    // edge case, decided over settled-only emission and refetch-on-close.
+    useEffect(() => {
+        if (state.summary) {
+            onSummaryChange?.(state.summary);
+        }
+    }, [state.summary, onSummaryChange]);
+    // A row belongs to the signed-in user's own sole grant when the controller has
+    // classified it as self-managed — those changes route through the confirm.
+    const onRowPermissionChange = useCallback((grantee, level) => {
+        if (state.selfManagedGranteeId === grantee.id) {
+            if (level !== grantee.level) {
+                setPendingSelfChange({ granteeId: grantee.id, level });
+            }
+            return;
+        }
+        void actions.changePermissionLevel(grantee.id, level);
+    }, [state.selfManagedGranteeId, actions]);
+    const onRowRemove = useCallback((grantee) => {
+        if (state.selfManagedGranteeId === grantee.id) {
+            setPendingSelfChange({ granteeId: grantee.id, level: "none" });
+            return;
+        }
+        void actions.removeGrantee(grantee.id);
+    }, [state.selfManagedGranteeId, actions]);
+    const onSelfRestrictConfirm = useCallback(() => {
+        if (!pendingSelfChange) {
+            return;
+        }
+        const { granteeId, level } = pendingSelfChange;
+        setPendingSelfChange(undefined);
+        if (level === "none") {
+            void actions.removeGrantee(granteeId);
+        }
+        else {
+            void actions.changePermissionLevel(granteeId, level);
+        }
+    }, [pendingSelfChange, actions]);
+    const onSelfRestrictCancel = useCallback(() => setPendingSelfChange(undefined), []);
+    const rowDisabledLevels = useCallback((grantee) => state.selfManagedGranteeId === grantee.id ? state.selfManagedDisabledLevels : undefined, [state.selfManagedGranteeId, state.selfManagedDisabledLevels]);
+    const isMutable = state.status === "success" && state.labelsResolved;
+    const isLoading = state.status === "loading" || state.labelsInitializing;
+    return {
+        state,
+        actions,
+        isShareViewOpen: state.subview === "main",
+        isAddGranteeOpen: state.subview === "addGrantee",
+        isGeneralAccessConfirmOpen: !!state.pendingGeneralAccess,
+        isSelfRestrictConfirmOpen: pendingSelfChange !== undefined,
+        isMutable,
+        isLoading,
+        workspaceDisabledLevels: state.workspaceDisabledLevels,
+        rowDisabledLevels,
+        onClose,
+        onRowPermissionChange,
+        onRowRemove,
+        onSelfRestrictCancel,
+        onSelfRestrictConfirm,
+    };
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gooddata/sdk-ui-ext",
-  "version": "11.51.0-alpha.1",
+  "version": "11.51.0-alpha.2",
   "description": "GoodData.UI SDK - Extensions",
   "license": "LicenseRef-LICENSE",
   "author": "GoodData Corporation",
@@ -63,20 +63,20 @@
     "ts-invariant": "0.10.3",
     "tslib": "2.8.1",
     "uuid": "11.1.1",
-    "@gooddata/sdk-backend-base": "11.51.0-alpha.1",
-    "@gooddata/sdk-backend-spi": "11.51.0-alpha.1",
-    "@gooddata/sdk-embedding": "11.51.0-alpha.1",
-    "@gooddata/sdk-model": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-charts": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-filters": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-geo": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-kit": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-pivot": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-semantic-search": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-theme-provider": "11.51.0-alpha.1",
-    "@gooddata/sdk-ui-vis-commons": "11.51.0-alpha.1",
-    "@gooddata/util": "11.51.0-alpha.1"
+    "@gooddata/sdk-backend-base": "11.51.0-alpha.2",
+    "@gooddata/sdk-backend-spi": "11.51.0-alpha.2",
+    "@gooddata/sdk-embedding": "11.51.0-alpha.2",
+    "@gooddata/sdk-model": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-charts": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-geo": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-filters": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-kit": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-pivot": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-theme-provider": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-semantic-search": "11.51.0-alpha.2",
+    "@gooddata/sdk-ui-vis-commons": "11.51.0-alpha.2",
+    "@gooddata/util": "11.51.0-alpha.2"
   },
   "devDependencies": {
     "@microsoft/api-documenter": "^7.17.0",
@@ -124,12 +124,12 @@
     "typescript": "5.9.3",
     "vitest": "4.1.8",
     "vitest-dom": "0.1.1",
-    "@gooddata/i18n-toolkit": "11.51.0-alpha.1",
-    "@gooddata/eslint-config": "11.51.0-alpha.1",
-    "@gooddata/reference-workspace": "11.51.0-alpha.1",
-    "@gooddata/oxlint-config": "11.51.0-alpha.1",
-    "@gooddata/sdk-backend-mockingbird": "11.51.0-alpha.1",
-    "@gooddata/stylelint-config": "11.51.0-alpha.1"
+    "@gooddata/eslint-config": "11.51.0-alpha.2",
+    "@gooddata/i18n-toolkit": "11.51.0-alpha.2",
+    "@gooddata/oxlint-config": "11.51.0-alpha.2",
+    "@gooddata/reference-workspace": "11.51.0-alpha.2",
+    "@gooddata/stylelint-config": "11.51.0-alpha.2",
+    "@gooddata/sdk-backend-mockingbird": "11.51.0-alpha.2"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",