@ynput/ayon-frontend-shared 0.8.0 → 0.8.1

package/dist/types/ProjectTreeTable.d.ts

@@ -3856,6 +3856,27 @@ declare interface SlotMap {
         context: TableShortcutContext
         pieces: TableShortcutPieces
     }
+    /**
+     * A section in the user details panel (Settings → Users), below AYON's own forms, for the
+     * selected users. The section shows from the description, titled like AYON's; `component`
+     * loads when it is first shown. Saving is the section's own: AYON's Save button doesn't see it.
+     */
+    'userDetails.section': {
+        version: 1
+        meta: UserDetailsSectionMeta
+        context: UserDetailsContext
+        pieces: { component: Loader<ComponentType<SlotProps<'userDetails.section'>>> }
+    }
+    /**
+     * An item in the user details panel's "more" menu (Settings → Users), for the selected users.
+     * It shows from the description; `run` loads when the menu opens and is called on click.
+     */
+    'userDetails.menuItem': {
+        version: 1
+        meta: UserDetailsMenuItemMeta
+        context: UserDetailsContext
+        pieces: { run: Loader<RunPiece<'userDetails.menuItem'>> }
+    }
     /**
      * Code with no UI that runs while AYON is open, whatever the page: keeping a state, listening to
      * websocket events, registering a store listener. `component` loads at startup and is mounted
@@ -4677,6 +4698,35 @@ declare type User = {
     hidden?: boolean;
 };
 
+/** Context of a user details section or menu item. */
+declare interface UserDetailsContext extends UsersScope {
+    /**
+     * the signed-in user can't change these users (a manager and an admin among them): show,
+     * don't edit
+     */
+    readOnly: boolean
+}
+
+/** Description of a `userDetails.menuItem` contribution. */
+declare interface UserDetailsMenuItemMeta extends MenuItemMeta {
+    /** `single`: only when one user is selected; `multi` (default): for one or more */
+    selection?: UserSelection
+}
+
+/** Description of a `userDetails.section` contribution. */
+declare interface UserDetailsSectionMeta {
+    /** unique among the addon's sections */
+    id: string
+    /** the section's title, above its content */
+    title: string
+    /** order among addon sections, lowest first */
+    order?: number
+    /** `single`: only when one user is selected; `multi` (default): for one or more */
+    selection?: UserSelection
+    /** also shown for service users, whose panel has no forms; `false` by default */
+    serviceUsers?: boolean
+}
+
 declare type UserModel = {
     /** Unique name of the user */
     name: string;
@@ -4698,11 +4748,38 @@ declare type UserModel = {
     updatedAt?: string;
 };
 
+/**
+ * A user a slot is about, e.g. one selected in Settings → Users. Not the signed-in user: that is
+ * `user` in every slot.
+ */
+declare interface UserRef {
+    name: string
+    fullName?: string
+    email?: string
+    /** the account is active (not disabled) */
+    active: boolean
+    isAdmin: boolean
+    /** managers and admins */
+    isManager: boolean
+    isGuest: boolean
+    /** a service user (API key) */
+    isService: boolean
+}
+
 /** Every slot: the signed-in user. The host adds it; AYON renders addons only once signed in. */
 declare interface UserScope {
     user: AddonUser
 }
 
+/** Which selections a user details contribution shows for. */
+declare type UserSelection = 'single' | 'multi'
+
+/** Slots about one or more users. */
+declare interface UsersScope {
+    /** the users the slot is about, e.g. the ones selected in Settings → Users */
+    users: UserRef[]
+}
+
 export declare const useScopedAttributeFields: <T extends AttributeField>({ attribFields, allowedScopes, }: UseScopedAttributeFieldsProps<T>) => T[];
 
 declare interface UseScopedAttributeFieldsProps<T extends AttributeField> {

package/dist/types/api.d.ts

@@ -14540,6 +14540,7 @@ declare type ImportDataApiArg = {
     entityType?: ('folder' | 'task') | null;
     newListLabel?: string | null;
     newListEntityType?: ('folder' | 'product' | 'version' | 'representation' | 'task' | 'workfile') | null;
+    newListFolderId?: string | null;
     updateListedEntities?: boolean;
     projectName?: string | null;
     folderId?: string | null;

package/dist/types/components.d.ts

@@ -280,6 +280,22 @@ declare interface AddonUser {
     isDeveloper: boolean
 }
 
+/** The addons' sections, each in a panel titled like AYON's own. */
+export declare const AddonUserDetailsSections: ({ context }: AddonUserDetailsSectionsProps) => JSX_2.Element;
+
+declare interface AddonUserDetailsSectionsProps {
+    context: UserDetailsContext;
+}
+
+export declare interface AddonUserMenuItems {
+    /** first in the menu (`position: 'top'`) */
+    topItems: MenuItemType[];
+    /** after the menu's own items, above Delete */
+    items: MenuItemType[];
+    /** loads the items' code: call it when the menu opens */
+    prefetch: () => void;
+}
+
 declare type AlignType = 'left' | 'right';
 
 declare type Anatomy = {
@@ -3664,6 +3680,9 @@ declare type ShortcutKeyEvent = Pick<KeyboardEvent, 'key' | 'code' | 'ctrlKey' |
  */
 declare type ShortcutTable = ProjectTablePage | 'slicer' | 'projects' | 'listsPanel' | 'versionsPanel'
 
+/** A contribution with this `selection` shows for `count` selected users. */
+export declare const showsForSelection: (selection: UserSelection | undefined, count: number) => boolean;
+
 declare interface SidebarConfig {
     width?: string;
     minWidth?: string;
@@ -3948,6 +3967,27 @@ declare interface SlotMap {
         context: TableShortcutContext
         pieces: TableShortcutPieces
     }
+    /**
+     * A section in the user details panel (Settings → Users), below AYON's own forms, for the
+     * selected users. The section shows from the description, titled like AYON's; `component`
+     * loads when it is first shown. Saving is the section's own: AYON's Save button doesn't see it.
+     */
+    'userDetails.section': {
+        version: 1
+        meta: UserDetailsSectionMeta
+        context: UserDetailsContext
+        pieces: { component: Loader<ComponentType<SlotProps<'userDetails.section'>>> }
+    }
+    /**
+     * An item in the user details panel's "more" menu (Settings → Users), for the selected users.
+     * It shows from the description; `run` loads when the menu opens and is called on click.
+     */
+    'userDetails.menuItem': {
+        version: 1
+        meta: UserDetailsMenuItemMeta
+        context: UserDetailsContext
+        pieces: { run: Loader<RunPiece<'userDetails.menuItem'>> }
+    }
     /**
      * Code with no UI that runs while AYON is open, whatever the page: keeping a state, listening to
      * websocket events, registering a store listener. `component` loads at startup and is mounted
@@ -4474,6 +4514,8 @@ export declare type ToolbarLayout = (ToolbarItem | '|')[];
 
 declare type TopicUpdateType = 'created' | 'label_changed' | 'renamed' | 'type_changed' | 'status_changed' | 'tags_changed' | 'attrib_changed' | 'deleted';
 
+export declare const toUserRef: (user: UserDetailsSource) => UserRef;
+
 declare type UpdateEntitiesArgs = {
     operations: UpdateEntityOperation[];
     entityType: EntityType_2;
@@ -4546,6 +4588,9 @@ export declare const useAddonTableShortcuts: (table: ShortcutTable | undefined)
     dialog: OpenAddonShortcutDialog | null;
 };
 
+/** The addons' items for the user details "more" menu. */
+export declare const useAddonUserMenuItems: (context: UserDetailsContext) => AddonUserMenuItems;
+
 export declare const useBuildFilterOptions: ({ filterTypes: globalFilterTypes, projectNames, scope, scopes: customScopes, data, config, power, }: BuildFilterOptions) => {
     options: Option_2[];
     groupOptions: SearchFilterGroupOption[];
@@ -4615,6 +4660,49 @@ export declare const useProjectPageSlotContext: (projectName: string) => SlotMap
 
 export declare const USER_KEY_PREFIX = "user:";
 
+/** Context of a user details section or menu item. */
+declare interface UserDetailsContext extends UsersScope {
+    /**
+     * the signed-in user can't change these users (a manager and an admin among them): show,
+     * don't edit
+     */
+    readOnly: boolean
+}
+
+/** Description of a `userDetails.menuItem` contribution. */
+declare interface UserDetailsMenuItemMeta extends MenuItemMeta {
+    /** `single`: only when one user is selected; `multi` (default): for one or more */
+    selection?: UserSelection
+}
+
+/** Description of a `userDetails.section` contribution. */
+declare interface UserDetailsSectionMeta {
+    /** unique among the addon's sections */
+    id: string
+    /** the section's title, above its content */
+    title: string
+    /** order among addon sections, lowest first */
+    order?: number
+    /** `single`: only when one user is selected; `multi` (default): for one or more */
+    selection?: UserSelection
+    /** also shown for service users, whose panel has no forms; `false` by default */
+    serviceUsers?: boolean
+}
+
+/** A user as AYON's users queries have it. */
+export declare interface UserDetailsSource {
+    name: string;
+    active?: boolean;
+    isAdmin?: boolean;
+    isManager?: boolean;
+    isGuest?: boolean;
+    isService?: boolean;
+    attrib?: {
+        fullName?: string | null;
+        email?: string | null;
+    } | null;
+}
+
 export declare const useReviewablesUpload: ({ projectName, versionId, taskId, folderId, productId, dispatch, onUpload, onProgress, }: UseReviewablesUploadProps) => UploadHandlers;
 
 export declare interface UseReviewablesUploadProps {
@@ -4660,11 +4748,38 @@ declare type UserModel = {
     updatedAt?: string;
 };
 
+/**
+ * A user a slot is about, e.g. one selected in Settings → Users. Not the signed-in user: that is
+ * `user` in every slot.
+ */
+declare interface UserRef {
+    name: string
+    fullName?: string
+    email?: string
+    /** the account is active (not disabled) */
+    active: boolean
+    isAdmin: boolean
+    /** managers and admins */
+    isManager: boolean
+    isGuest: boolean
+    /** a service user (API key) */
+    isService: boolean
+}
+
 /** Every slot: the signed-in user. The host adds it; AYON renders addons only once signed in. */
 declare interface UserScope {
     user: AddonUser
 }
 
+/** Which selections a user details contribution shows for. */
+declare type UserSelection = 'single' | 'multi'
+
+/** Slots about one or more users. */
+declare interface UsersScope {
+    /** the users the slot is about, e.g. the ones selected in Settings → Users */
+    users: UserRef[]
+}
+
 declare type UserSuggestionItem = {
     /** The date and time when the suggested entity was created */
     createdAt?: string | null;
@@ -4859,6 +4974,9 @@ declare const useUpdateSubtasksMutation: <R extends Record<string, any> = ({
     reset: () => void;
 }];
 
+/** The context of the user details slots for the selected users. */
+export declare const useUserDetailsSlotContext: (users: UserDetailsSource[], readOnly: boolean) => UserDetailsContext;
+
 export declare const useVersionUploadContext: () => VersionUploadContextType;
 
 declare type UseViewMutations = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ynput/ayon-frontend-shared",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Shared React components for AYON frontend",
   "repository": {
     "type": "git",
@@ -104,7 +104,7 @@
     "@reduxjs/toolkit": "2.11.2",
     "@rtk-query/graphql-request-base-query": "2.3.2",
     "@tanstack/react-table": "8.21.3",
-    "@ynput/ayon-addon": "0.3.0",
+    "@ynput/ayon-addon": "0.4.0",
     "@ynput/ayon-react-components": "^1.25.1",
     "graphql-request": "7.4.0",
     "react": "18.3.1",