@osdk/react 0.10.0-beta.1 → 0.10.0-beta.11

package/build/cjs/public/experimental/admin.d.cts

@@ -0,0 +1,275 @@
+import { User, ListUsersResponse, MarkingCategory, Marking } from '@osdk/foundry.admin';
+import { UserStatus } from '@osdk/foundry.core';
+
+interface CbacBannerData {
+    classificationString: string;
+    textColor: string;
+    backgroundColors: string[];
+    markingIds: string[];
+}
+interface UseCbacBannerOptions {
+    markingIds: string[];
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseCbacBannerResult {
+    banner: CbacBannerData | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the CBAC banner data for the given marking IDs.
+ * @param options Options to control the query.
+ */
+declare function useCbacBanner({ markingIds, enabled: externalEnabled }: UseCbacBannerOptions): UseCbacBannerResult;
+
+interface CbacMarkingRestrictionsData {
+    disallowedMarkings: string[];
+    impliedMarkings: string[];
+    requiredMarkings: string[][];
+    userSatisfiesMarkings: boolean;
+    isValid: boolean;
+}
+interface UseCbacMarkingRestrictionsOptions {
+    markingIds: string[];
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseCbacMarkingRestrictionsResult {
+    restrictions: CbacMarkingRestrictionsData | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get CBAC marking restrictions (implied, disallowed, required) for the given marking IDs.
+ * @param options Options to control the query.
+ */
+declare function useCbacMarkingRestrictions({ markingIds, enabled: externalEnabled }: UseCbacMarkingRestrictionsOptions): UseCbacMarkingRestrictionsResult;
+
+interface UseCurrentFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+}
+interface UseCurrentFoundryUserResult {
+    currentUser: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the currently signed in User.
+ * @param options Options to control the query.
+ */
+declare function useCurrentFoundryUser({ enabled }?: UseCurrentFoundryUserOptions): UseCurrentFoundryUserResult;
+
+interface UseFoundryUserOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    status?: UserStatus;
+}
+interface UseFoundryUserResult {
+    user: User | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get the User with the specified id.
+ * @param userId A Foundry User ID.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUser(userId: string, { enabled, status }?: UseFoundryUserOptions): UseFoundryUserResult;
+
+interface UseFoundryUsersListOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     * });
+     */
+    enabled?: boolean;
+    /**
+     * The default status of the users returned in the list.
+     *
+     * @default "ACTIVE"
+     */
+    include?: UserStatus;
+    /**
+     * The preferred page size for the list.
+     *
+     * @default 1000
+     */
+    pageSize?: number;
+    /**
+     * The page token indicates where to start paging. This should be omitted from the first page's request.
+     * To fetch the next page, clients should take the value from the nextPageToken field of the previous
+     * response and use it to populate the pageToken field of the next request.
+     */
+    pageToken?: string;
+}
+interface UseFoundryUsersListResult {
+    users: ListUsersResponse["data"] | undefined;
+    /**
+     * The page token to be used for the next page of users. If this is undefined, there are no more
+     * pages of users to load.
+     */
+    nextPageToken: string | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Lists all Users. This is a paged endpoint. Each page may be smaller or larger than the requested page size.
+ * @param options Options to control the query.
+ */
+declare function useFoundryUsersList({ enabled, include, pageSize, pageToken }?: UseFoundryUsersListOptions): UseFoundryUsersListResult;
+
+interface UseMarkingCategoriesOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseMarkingCategoriesResult {
+    categories: MarkingCategory[] | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * List all marking categories.
+ * @param options Options to control the query.
+ */
+declare function useMarkingCategories({ enabled }?: UseMarkingCategoriesOptions): UseMarkingCategoriesResult;
+
+interface UseMarkingsOptions {
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseMarkingsResult {
+    markings: Marking[] | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * List all markings.
+ * @param options Options to control the query.
+ */
+declare function useMarkings({ enabled }?: UseMarkingsOptions): UseMarkingsResult;
+
+interface UseUserViewMarkingsOptions {
+    /**
+     * The user ID to fetch view markings for.
+     * When omitted, fetches markings for the current user.
+     */
+    userId?: string;
+    /**
+     * Enable or disable the query.
+     *
+     * When `false`, the query will not automatically execute.
+     *
+     * This is useful for:
+     * - Lazy/on-demand queries that should wait for user interaction
+     * - Dependent queries that need data from another query first
+     * - Conditional queries based on component state
+     *
+     * @default true
+     */
+    enabled?: boolean;
+}
+interface UseUserViewMarkingsResult {
+    markingIds: string[] | undefined;
+    isLoading: boolean;
+    error: Error | undefined;
+    refetch: () => void;
+}
+/**
+ * Get view-accessible markings for a user.
+ * When `userId` is provided, fetches markings for that user.
+ * When omitted, fetches markings for the current user.
+ * @param options Options to control the query.
+ */
+declare function useUserViewMarkings({ userId, enabled }?: UseUserViewMarkingsOptions): UseUserViewMarkingsResult;
+
+export { type CbacBannerData, type CbacMarkingRestrictionsData, type UseCbacBannerOptions, type UseCbacBannerResult, type UseCbacMarkingRestrictionsOptions, type UseCbacMarkingRestrictionsResult, type UseUserViewMarkingsOptions, type UseUserViewMarkingsResult, useCbacBanner, useCbacMarkingRestrictions, useCurrentFoundryUser, useFoundryUser, useFoundryUsersList, useMarkingCategories, useMarkings, useUserViewMarkings };