@tridion-sites/extensions 2.0.2 → 2.0.3

package/dist/dts/api/general/queries/queryOptions.d.ts

@@ -1,67 +0,0 @@
-/**
- * @public
- */
-export type NonFunctionGuard<T> = T extends Function ? never : T;
-/**
- * @public
- */
-export interface QueryOptions<TQueryFnData = unknown, TError = unknown, TData = TQueryFnData> {
-    retry?: boolean | number | ((failureCount: number, error: TError) => boolean);
-    retryDelay?: number | ((failureCount: number, error: TError) => number);
-    initialData?: TData | (() => TData | undefined);
-    initialDataUpdatedAt?: number | (() => number | undefined);
-    meta?: Record<string, unknown>;
-    /**
-     * Set this to `false` to disable automatic refetching when the query mounts or changes query keys.
-     * To refetch the query, use the `refetch` method returned from the `useQuery` instance.
-     * Defaults to `true`.
-     */
-    enabled?: boolean;
-    /**
-     * The time in milliseconds after data is considered stale.
-     * If set to `Infinity`, the data will never be considered stale.
-     */
-    staleTime?: number;
-    /**
-     * If set to a number, the query will continuously refetch at this frequency in milliseconds.
-     * If set to a function, the function will be executed with the latest data and query to compute a frequency.
-     * Defaults to `false`.
-     */
-    refetchInterval?: number | false;
-    /**
-     * If set to `true`, the query will continue to refetch while their tab/window is in the background.
-     * Defaults to `false`.
-     */
-    refetchIntervalInBackground?: boolean;
-    /**
-     * If set to `true`, the query will refetch on window focus if the data is stale.
-     * If set to `false`, the query will not refetch on window focus.
-     * If set to `'always'`, the query will always refetch on window focus.
-     * Defaults to `true`.
-     */
-    refetchOnWindowFocus?: boolean | 'always';
-    /**
-     * If set to `true`, the query will refetch on reconnect if the data is stale.
-     * If set to `false`, the query will not refetch on reconnect.
-     * If set to `'always'`, the query will always refetch on reconnect.
-     * If set to a function, the function will be executed with the latest data and query to compute the value.
-     * Defaults to the value of `networkOnline` (`true`)
-     */
-    refetchOnReconnect?: boolean | 'always';
-    /**
-     * If set to `true`, the query will refetch on mount if the data is stale.
-     * If set to `false`, will disable additional instances of a query to trigger background refetches.
-     * If set to `'always'`, the query will always refetch on mount.
-     * Defaults to `true`.
-     */
-    refetchOnMount?: boolean | 'always';
-    /**
-     * If set to `false`, the query will not be retried on mount if it contains an error.
-     * Defaults to `true`.
-     */
-    retryOnMount?: boolean;
-    /**
-     * If set, this value will be used as the placeholder data for this particular query observer while the query is still in the `loading` data and no initialData has been provided.
-     */
-    placeholderData?: NonFunctionGuard<TQueryFnData> | ((previousData: TData | undefined) => NonFunctionGuard<TQueryFnData> | undefined);
-}

package/dist/dts/api/general/queries/queryResult.d.ts

@@ -1,93 +0,0 @@
-/**
- * @public
- */
-export type QueryStatus = 'pending' | 'error' | 'success';
-/**
- * @public
- */
-export type QueryFetchStatus = 'fetching' | 'paused' | 'idle';
-/**
- * @public
- */
-export interface RefetchOptions {
-    cancelRefetch?: boolean;
-    throwOnError?: boolean;
-}
-/**
- * @public
- */
-export interface QueryResult<TData = unknown, TError = unknown> {
-    /**
-     * The last successfully resolved data for the query.
-     */
-    data: TData | undefined;
-    /**
-     * The timestamp for when the query most recently returned the `status` as `success`.
-     */
-    dataUpdatedAt: number;
-    /**
-     * The error object for the query, if an error was thrown.
-     */
-    error: TError | null;
-    /**
-     * The timestamp for when the query most recently returned the `status` as `error`.
-     */
-    errorUpdatedAt: number;
-    failureCount: number;
-    /**
-     * The failure reason for the query retry.
-     * Reset to null when the query succeeds.
-     */
-    failureReason: TError | null;
-    /**
-     * The sum of all errors.
-     */
-    errorUpdateCount: number;
-    isError: boolean;
-    /**
-     * Will be true if the query has been fetched.
-     */
-    isFetched: boolean;
-    /**
-     * Will be true if the query has been fetched after the component mounted.
-     * This property can be used to not show any previously cached data.
-     */
-    isFetchedAfterMount: boolean;
-    isFetching: boolean;
-    isPending: boolean;
-    isLoading: boolean;
-    isLoadingError: boolean;
-    isPaused: boolean;
-    /**
-     * Will be `true` if the data shown is the placeholder data.
-     */
-    isPlaceholderData: boolean;
-    /**
-     * Will be `true` if the query failed while fetching for the first time.
-     */
-    isRefetchError: boolean;
-    /**
-     * Is `true` whenever a background refetch is in-flight, which does not include initial loading.
-     */
-    isRefetching: boolean;
-    /**
-     * Will be `true` if the data in the cache is invalidated or if the data is older than the given `staleTime`.
-     */
-    isStale: boolean;
-    isSuccess: boolean;
-    refetch: (options?: RefetchOptions) => Promise<QueryResult<TData, TError>>;
-    /**
-     * - `loading` - if there's no cached data and no query attempt was finished yet.
-     * - `error` - if the query attempt resulted in an error. The corresponding error property has the error received from the attempted fetch.
-     * - `success` - if the query has received a response with no errors and is ready to display its data.
-     * The corresponding `data` property on the query is the data received from the successful fetch or if the query's `enabled` property is set to `false`
-     * and has not been fetched yet `data` is the first `initialData` supplied to the query on initialization.
-     */
-    status: QueryStatus;
-    /**
-     * - `fetching` - Is true whenever the queryFn is executing, which includes initial loading as well as background refetches.
-     * - `paused` - The query wanted to fetch, but has been paused.
-     * - `idle` - The query is not fetching.
-     */
-    fetchStatus: QueryFetchStatus;
-}

package/dist/dts/api/general/queries/search/index.d.ts

@@ -1,2 +0,0 @@
-export * from './useSearchInContainerQuery';
-export * from './useSystemSearchQuery';

package/dist/dts/api/general/queries/search/useSearchInContainerQuery.d.ts

@@ -1,27 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri, RloItemType } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface SearchInContainerQueryProps {
-    /**
-     * URI of the container to search in.
-     */
-    containerId: ItemUri;
-    /**
-     * Input for the full-text query.
-     * The following characters have special meaning in the query syntax: + - && || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
-     * To use any of these characters without their syntactical meaning, to escape them by preceding  the character with a \\\\.
-     */
-    fullTextQuery: string;
-    itemTypes?: ReadonlyArray<RloItemType>;
-    /**
-     * The maximum number of search results.
-     */
-    resultLimit?: number;
-}
-/**
- * @public
- */
-export type SearchInContainerQueryHook = (props: SearchInContainerQueryProps | undefined, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/search/useSystemSearchQuery.d.ts

@@ -1,26 +0,0 @@
-import type { ApiError, IdentifiableObject, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface SystemSearchQueryProps {
-    /**
-     * Input for the full-text query.
-     * The following characters have special meaning in the query syntax: + - && || ! ( ) \{ \} [ ] ^ " ~ * ? : \\\\
-     * To use any of these characters without their syntactical meaning, to escape them by preceding  the character with a \\\\.
-     */
-    fullTextQuery?: string;
-    /**
-     * The maximum number of search results.
-     */
-    resultLimit?: number;
-    /**
-     * Limits the search results to only items that are classified with the specified keyword IDs.
-     */
-    usedKeywordsIds?: ReadonlyArray<ItemUri>;
-}
-/**
- * @public
- */
-export type SystemSearchQueryHook = (props?: SystemSearchQueryProps, options?: QueryOptions<ReadonlyArray<IdentifiableObject> | undefined, ApiError>) => QueryResult<ReadonlyArray<IdentifiableObject> | undefined, ApiError>;

package/dist/dts/api/general/queries/translation/index.d.ts

@@ -1 +0,0 @@
-export * from './useDefaultTranslationJobQuery';

package/dist/dts/api/general/queries/translation/useDefaultTranslationJobQuery.d.ts

@@ -1,17 +0,0 @@
-import type { ApiError, ItemUri, TranslationJob, TranslationJobType } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface DefaultTranslationJobQueryProps {
-    /**
-     * IDs to get default Translation Job for.
-     */
-    itemIds: ReadonlyArray<ItemUri>;
-    type: TranslationJobType;
-}
-/**
- * @public
- */
-export type DefaultTranslationJobQueryHook = (props: DefaultTranslationJobQueryProps | undefined, options?: QueryOptions<TranslationJob | undefined, ApiError>) => QueryResult<TranslationJob | undefined, ApiError>;

package/dist/dts/api/general/queries/useUserProfileQuery.d.ts

@@ -1,7 +0,0 @@
-import type { ApiError, UserProfile } from '@tridion-sites/models';
-import type { QueryOptions } from './queryOptions';
-import type { QueryResult } from './queryResult';
-/**
- * @public
- */
-export type UserProfileQueryHook = (options?: QueryOptions<UserProfile | undefined, ApiError>) => QueryResult<UserProfile | undefined, ApiError>;

package/dist/dts/api/general/queries/workflow/index.d.ts

@@ -1 +0,0 @@
-export * from './useActivityInstancesQuery';

package/dist/dts/api/general/queries/workflow/useActivityInstancesQuery.d.ts

@@ -1,37 +0,0 @@
-import type { ActivityInstance, ActivityState, ApiError, ItemUri } from '@tridion-sites/models';
-import type { QueryOptions } from '../queryOptions';
-import type { QueryResult } from '../queryResult';
-/**
- * @public
- */
-export interface ActivityInstancesQueryProps {
-    /**
-     * When set to `false`, the results will be filtered on Assignee or Owner depending on the activity instance state:
-     * - Activity Instances in Assigned State are returned if they are assigned to the Current User or any groups of the Current User.
-     * - Activity Instances in other Activity States are returned if they are owned by the Current User
-     *
-     * When set to `true`, the results are filtered by security instead.
-     * Only the Activity Instances on which the current user has Workflow Management rights (or system administration privileges) are returned.
-     */
-    forAllUsers?: boolean;
-    /**
-     * If specified, only Activity Instances which have one of the given Activity States will be returned.
-     */
-    activityStates?: ReadonlyArray<ActivityState>;
-    /**
-     * If specified, only Activity Instances based on the given Process Definition will be returned.
-     */
-    processDefinitionId?: ItemUri;
-    /**
-     * If specified, inly Activity Instances created by given User will be returned.
-     */
-    ownerId?: ItemUri;
-    /**
-     * If specified, inly Activity Instances assigned to a given User will be returned.
-     */
-    assigneeId?: ItemUri;
-}
-/**
- * @public
- */
-export type ActivityInstancesQueryHook = (props?: ActivityInstancesQueryProps, options?: QueryOptions<ReadonlyArray<ActivityInstance> | undefined, ApiError>) => QueryResult<ReadonlyArray<ActivityInstance> | undefined, ApiError>;

package/dist/dts/api/index.d.ts

@@ -1,5 +0,0 @@
-export * from './activitiesExplorer';
-export * from './contentExplorer';
-export * from './publishingQueueExplorer';
-export * from './editors';
-export * from './general';

package/dist/dts/api/publishingQueueExplorer/hooks/index.d.ts

@@ -1,2 +0,0 @@
-export * from './usePublishingQueueExplorer';
-export * from './usePublishingQueueExplorerTable';

package/dist/dts/api/publishingQueueExplorer/hooks/usePublishingQueueExplorer.d.ts

@@ -1,62 +0,0 @@
-import type { LoadingState } from "../..";
-import type { ValuesOfArray } from '@tridion/graphene';
-import type { PublishTransaction } from '@tridion-sites/models';
-/**
- * List of all built-in panel IDs of the Publishing Queue Explorer.
- *
- * @public
- */
-export declare const publishingQueueExplorerPanelIds: readonly ["information", "resolvedItems"];
-/**
- * Type represents ID of a built-in panel of the Publishing Queue Explorer.
- *
- * @public
- */
-export type PublishingQueueExplorerPanelId = ValuesOfArray<typeof publishingQueueExplorerPanelIds>;
-/**
- * All available built-in Publishing Queue Explorer panel IDs.
- *
- * @public
- */
-export declare const publishingQueueExplorerPanelId: {
-    information: "information";
-    resolvedItems: "resolvedItems";
-};
-/**
- * Data of the PublishingQueue Explorer.
- *
- * @public
- */
-export interface PublishingQueueExplorerHookResult {
-    /**
-     * List of Publish Transactions.
-     */
-    items: ReadonlyArray<PublishTransaction>;
-    /**
-     * The loading state of the Publish Transactions list.
-     */
-    itemsLoadingState: LoadingState;
-    /**
-     * Currently active PublishTransaction.
-     */
-    currentItem: PublishTransaction | undefined;
-}
-/**
- * Hook for accessing PublishingQueue Explorer data.
- *
- * @remarks
- * Should be used only inside PublishingQueue Explorer, otherwise throws an error.
- *
- * @public
- */
-export type PublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult;
-/**
- * Hook for accessing PublishingQueue Explorer data when available.
- *
- * @remarks
- * Safe to be used within or outside of the PublishingQueue Explorer.
- * `undefined` is returned when used outside of PublishingQueue Explorer.
- *
- * @public
- */
-export type OptionalPublishingQueueExplorerHook = () => PublishingQueueExplorerHookResult | undefined;

package/dist/dts/api/publishingQueueExplorer/hooks/usePublishingQueueExplorerTable.d.ts

@@ -1,41 +0,0 @@
-import type { ItemUri, PublishTransaction, PublishTransactionListInfo } from '@tridion-sites/models';
-/**
- * @public
- */
-export interface PublishingQueueExplorerTableSelection {
-    ids: ReadonlySet<ItemUri>;
-    selectedItems: ReadonlyArray<PublishTransaction<PublishTransactionListInfo>>;
-}
-/**
- * Methods of the PublishingQueue Explorer Table.
- * @public
- */
-export interface PublishingQueueExplorerTableHookResult {
-    /**
-     * Refetch list of Publish Transactions.
-     */
-    refresh: () => void;
-    /**
-     * Current state of selected Publish Transactions in the Table.
-     */
-    selection: PublishingQueueExplorerTableSelection;
-}
-/**
- * Hook for accessing PublishingQueue Explorer Table data and methods.
- *
- * @remarks
- * Should be used only inside PublishingQueue Explorer Table, otherwise throws an error.
- *
- * @public
- */
-export type PublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult;
-/**
- * Hook for accessing PublishingQueue Explorer Table data and methods when available.
- *
- * @remarks
- * Safe to be used within or outside of the PublishingQueue Explorer Table.
- * `undefined` is returned when used outside of the PublishingQueue Explorer Table.
- *
- * @public
- */
-export type OptionalPublishingQueueExplorerTableHook = () => PublishingQueueExplorerTableHookResult | undefined;

package/dist/dts/api/publishingQueueExplorer/index.d.ts

@@ -1 +0,0 @@
-export * from './hooks';

package/dist/dts/apiBridge/activitiesExplorerApiStorage.d.ts

@@ -1,16 +0,0 @@
-import type { ActivitiesExplorerHook, ActivitiesExplorerTableHook, OptionalActivitiesExplorerHook, OptionalActivitiesExplorerTableHook } from "../api";
-/**
- * @internal
- */
-export interface ActivitiesExplorerHooksApiStorage {
-    useActivitiesExplorer: ActivitiesExplorerHook;
-    useActivitiesExplorerTable: ActivitiesExplorerTableHook;
-    useOptionalActivitiesExplorer: OptionalActivitiesExplorerHook;
-    useOptionalActivitiesExplorerTable: OptionalActivitiesExplorerTableHook;
-}
-/**
- * @internal
- */
-export interface ActivitiesExplorerApiStorage {
-    hooks: ActivitiesExplorerHooksApiStorage;
-}

package/dist/dts/apiBridge/contentExplorerApiStorage.d.ts

@@ -1,32 +0,0 @@
-import type { ContentExplorerHierarchyUtilsExtensionApi, ContentExplorerHook, ContentExplorerTableHook, ContentExplorerTreeHook, OptionalContentExplorerHook, OptionalContentExplorerTableHook, OptionalContentExplorerTreeHook, PropertiesListComponent } from "../api";
-/**
- * @internal
- */
-export interface ContentExplorerUtilsApiStorage {
-    hierarchy: ContentExplorerHierarchyUtilsExtensionApi;
-}
-/**
- * @internal
- */
-export interface ContentExplorerHooksApiStorage {
-    useContentExplorer: ContentExplorerHook;
-    useContentExplorerTable: ContentExplorerTableHook;
-    useContentExplorerTree: ContentExplorerTreeHook;
-    useOptionalContentExplorer: OptionalContentExplorerHook;
-    useOptionalContentExplorerTable: OptionalContentExplorerTableHook;
-    useOptionalContentExplorerTree: OptionalContentExplorerTreeHook;
-}
-/**
- * @internal
- */
-export interface ContentExplorerComponentsApiStorage {
-    PropertiesList: PropertiesListComponent;
-}
-/**
- * @internal
- */
-export interface ContentExplorerApiStorage {
-    hooks: ContentExplorerHooksApiStorage;
-    utils: ContentExplorerUtilsApiStorage;
-    components: ContentExplorerComponentsApiStorage;
-}

package/dist/dts/apiBridge/editors/bundleEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalBundleEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface BundleEditorHooksApiStorage {
-    useOptionalBundleEditor: OptionalBundleEditorHook;
-}
-/**
- * @internal
- */
-export interface BundleEditorApiStorage {
-    hooks: BundleEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/categoryEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalCategoryEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface CategoryEditorHooksApiStorage {
-    useOptionalCategoryEditor: OptionalCategoryEditorHook;
-}
-/**
- * @internal
- */
-export interface CategoryEditorApiStorage {
-    hooks: CategoryEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/componentEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalComponentEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface ComponentEditorHooksApiStorage {
-    useOptionalComponentEditor: OptionalComponentEditorHook;
-}
-/**
- * @internal
- */
-export interface ComponentEditorApiStorage {
-    hooks: ComponentEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/editorsApiStorage.d.ts

@@ -1,28 +0,0 @@
-import type { EditorHook, OptionalEditorHook } from "../../api";
-import type { BundleEditorApiStorage } from './bundleEditorApiStorage';
-import type { CategoryEditorApiStorage } from './categoryEditorApiStorage';
-import type { ComponentEditorApiStorage } from './componentEditorApiStorage';
-import type { FolderEditorApiStorage } from './folderEditorApiStorage';
-import type { KeywordEditorApiStorage } from './keywordEditorApiStorage';
-import type { PageEditorApiStorage } from './pageEditorApiStorage';
-import type { StructureGroupEditorApiStorage } from './structureGroupEditorApiStorage';
-/**
- * @internal
- */
-export interface EditorHooksApiStorage {
-    useEditor: EditorHook;
-    useOptionalEditor: OptionalEditorHook;
-}
-/**
- * @internal
- */
-export interface EditorsApiStorage {
-    hooks: EditorHooksApiStorage;
-    componentEditor: ComponentEditorApiStorage;
-    bundleEditor: BundleEditorApiStorage;
-    categoryEditor: CategoryEditorApiStorage;
-    folderEditor: FolderEditorApiStorage;
-    keywordEditor: KeywordEditorApiStorage;
-    pageEditor: PageEditorApiStorage;
-    structureGroupEditor: StructureGroupEditorApiStorage;
-}

package/dist/dts/apiBridge/editors/folderEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalFolderEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface FolderEditorHooksApiStorage {
-    useOptionalFolderEditor: OptionalFolderEditorHook;
-}
-/**
- * @internal
- */
-export interface FolderEditorApiStorage {
-    hooks: FolderEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/index.d.ts

@@ -1,8 +0,0 @@
-export * from './bundleEditorApiStorage';
-export * from './categoryEditorApiStorage';
-export * from './componentEditorApiStorage';
-export * from './folderEditorApiStorage';
-export * from './keywordEditorApiStorage';
-export * from './pageEditorApiStorage';
-export * from './structureGroupEditorApiStorage';
-export * from './editorsApiStorage';

package/dist/dts/apiBridge/editors/keywordEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalKeywordEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface KeywordEditorHooksApiStorage {
-    useOptionalKeywordEditor: OptionalKeywordEditorHook;
-}
-/**
- * @internal
- */
-export interface KeywordEditorApiStorage {
-    hooks: KeywordEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/pageEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalPageEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface PageEditorHooksApiStorage {
-    useOptionalPageEditor: OptionalPageEditorHook;
-}
-/**
- * @internal
- */
-export interface PageEditorApiStorage {
-    hooks: PageEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/editors/structureGroupEditorApiStorage.d.ts

@@ -1,13 +0,0 @@
-import type { OptionalStructureGroupEditorHook } from "../../api";
-/**
- * @internal
- */
-export interface StructureGroupEditorHooksApiStorage {
-    useOptionalStructureGroupEditor: OptionalStructureGroupEditorHook;
-}
-/**
- * @internal
- */
-export interface StructureGroupEditorApiStorage {
-    hooks: StructureGroupEditorHooksApiStorage;
-}

package/dist/dts/apiBridge/extensionApiBridge.d.ts

@@ -1,22 +0,0 @@
-import type { ActivitiesExplorerApiStorage } from './activitiesExplorerApiStorage';
-import type { ContentExplorerApiStorage } from './contentExplorerApiStorage';
-import type { EditorsApiStorage } from './editors';
-import type { GeneralApiStorage } from './generalApiStorage';
-import type { PublishingQueueExplorerApiStorage } from './publishingQueueExplorerApiStorage';
-/**
- * @internal
- */
-export interface ExtensionApiImplementationStorage {
-    activitiesExplorer: ActivitiesExplorerApiStorage;
-    contentExplorer: ContentExplorerApiStorage;
-    publishingQueueExplorer: PublishingQueueExplorerApiStorage;
-    editors: EditorsApiStorage;
-    general: GeneralApiStorage;
-}
-/**
- * @internal
- */
-export declare const extensionApiBridge: {
-    initialize: (implementation: ExtensionApiImplementationStorage) => void;
-    get: () => ExtensionApiImplementationStorage;
-};