@strapi/review-workflows 5.0.0-beta.2 → 5.0.0-beta.4

package/dist/admin/src/routes/content-manager/[model]/constants.d.ts

@@ -0,0 +1,71 @@
+import type { Filters } from '@strapi/admin/strapi-admin';
+export declare const REVIEW_WORKFLOW_COLUMNS: ({
+    name: string;
+    attribute: {
+        type: "relation";
+        relation: "oneToMany";
+        target: "admin::review-workflow-stage";
+    };
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    searchable: false;
+    sortable: true;
+    mainField: {
+        name: string;
+        type: "string";
+    };
+    cellFormatter: (props: import("@strapi/types/dist/modules/documents").AnyDocument) => import("react/jsx-runtime").JSX.Element;
+} | {
+    name: string;
+    attribute: {
+        type: "relation";
+        target: "admin::user";
+        relation: "oneToMany";
+    };
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    searchable: false;
+    sortable: true;
+    mainField: {
+        name: string;
+        type: "string";
+    };
+    cellFormatter: (props: import("@strapi/types/dist/modules/documents").AnyDocument) => import("react/jsx-runtime").JSX.Element;
+})[];
+export declare const REVIEW_WORKFLOW_FILTERS: ({
+    mainField: {
+        name: string;
+        type: "string";
+    };
+    input: (props: Filters.ValueInputProps) => import("react/jsx-runtime").JSX.Element;
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    name: string;
+    type: "relation";
+    operators?: undefined;
+} | {
+    type: "relation";
+    mainField: {
+        name: string;
+        type: "integer";
+    };
+    input: ({ name }: Filters.ValueInputProps) => import("react/jsx-runtime").JSX.Element;
+    operators: {
+        label: {
+            id: string;
+            defaultMessage: string;
+        };
+        value: string;
+    }[];
+    label: {
+        id: string;
+        defaultMessage: string;
+    };
+    name: string;
+})[];

package/dist/admin/src/routes/purchase-review-workflows.d.ts

@@ -0,0 +1,2 @@
+declare const PurchaseReviewWorkflows: () => import("react/jsx-runtime").JSX.Element;
+export { PurchaseReviewWorkflows };

package/dist/admin/src/routes/settings/:id.d.ts

@@ -0,0 +1,2 @@
+declare const ProtectedEditPage: () => import("react/jsx-runtime").JSX.Element;
+export { ProtectedEditPage };

package/dist/admin/src/routes/settings/components/AddStage.d.ts

@@ -0,0 +1,2 @@
+import { ButtonProps } from '@strapi/design-system';
+export declare const AddStage: ({ children, ...props }: ButtonProps) => import("react/jsx-runtime").JSX.Element;

package/dist/admin/src/routes/settings/components/Layout.d.ts

@@ -0,0 +1,12 @@
+import * as React from 'react';
+declare const DragLayerRendered: () => import("react/jsx-runtime").JSX.Element | null;
+declare const Root: React.FC<React.PropsWithChildren>;
+interface HeaderProps {
+    title: string;
+    navigationAction?: React.ReactNode;
+    primaryAction?: React.ReactNode;
+    secondaryAction?: React.ReactNode;
+    subtitle?: React.ReactNode;
+}
+declare const Header: React.FC<HeaderProps>;
+export { DragLayerRendered, Header, Root };

package/dist/admin/src/routes/settings/components/StageDragPreview.d.ts

@@ -0,0 +1,6 @@
+interface StageDragPreviewType {
+    name: string | null;
+}
+declare const StageDragPreview: ({ name }: StageDragPreviewType) => import("react/jsx-runtime").JSX.Element;
+export { StageDragPreview };
+export type { StageDragPreviewType };

package/dist/admin/src/routes/settings/components/Stages.d.ts

@@ -0,0 +1,12 @@
+import { Stage as IStage } from '../../../../../shared/contracts/review-workflows';
+interface WorkflowStage extends Pick<IStage, 'id' | 'name' | 'permissions' | 'color'> {
+    __temp_key__: string;
+}
+interface StagesProps {
+    canDelete?: boolean;
+    canUpdate?: boolean;
+    isCreating?: boolean;
+}
+declare const Stages: ({ canDelete, canUpdate, isCreating }: StagesProps) => import("react/jsx-runtime").JSX.Element;
+export { Stages };
+export type { StagesProps, WorkflowStage };

package/dist/admin/src/routes/settings/components/WorkflowAttributes.d.ts

@@ -0,0 +1,6 @@
+interface WorkflowAttributesProps {
+    canUpdate?: boolean;
+}
+declare const WorkflowAttributes: ({ canUpdate }: WorkflowAttributesProps) => import("react/jsx-runtime").JSX.Element;
+export { WorkflowAttributes };
+export type { WorkflowAttributesProps };

package/dist/admin/src/routes/settings/constants.d.ts

@@ -0,0 +1,2 @@
+export type DragDropTypes = 'stage';
+export declare const DRAG_DROP_TYPES: Record<Uppercase<DragDropTypes>, DragDropTypes>;

package/dist/admin/src/routes/settings/hooks/useDragAndDrop.d.ts

@@ -0,0 +1,51 @@
+import * as React from 'react';
+import { type HandlerManager, type ConnectDragSource, type ConnectDropTarget, type ConnectDragPreview } from 'react-dnd';
+import { type UseKeyboardDragAndDropCallbacks } from './useKeyboardDragAndDrop';
+import type { Data } from '@strapi/types';
+declare const DIRECTIONS: {
+    readonly UPWARD: "upward";
+    readonly DOWNWARD: "downward";
+};
+declare const DROP_SENSITIVITY: {
+    readonly REGULAR: "regular";
+    readonly IMMEDIATE: "immediate";
+};
+interface UseDragAndDropOptions<TIndex extends number | Array<number> = number, TItem extends {
+    index: TIndex;
+} = {
+    index: TIndex;
+}> extends UseKeyboardDragAndDropCallbacks<TIndex> {
+    type?: string;
+    index: TIndex;
+    item?: TItem;
+    onStart?: () => void;
+    onEnd?: () => void;
+    dropSensitivity?: (typeof DROP_SENSITIVITY)[keyof typeof DROP_SENSITIVITY];
+}
+type Identifier = ReturnType<HandlerManager['getHandlerId']>;
+type UseDragAndDropReturn<Element extends HTMLElement = HTMLElement> = [
+    props: {
+        handlerId: Identifier;
+        isDragging: boolean;
+        handleKeyDown: (event: React.KeyboardEvent<HTMLButtonElement>) => void;
+        isOverDropTarget: boolean;
+        direction: (typeof DIRECTIONS)[keyof typeof DIRECTIONS] | null;
+    },
+    objectRef: React.RefObject<Element>,
+    dropRef: ConnectDropTarget,
+    dragRef: ConnectDragSource,
+    dragPreviewRef: ConnectDragPreview
+];
+/**
+ * A utility hook abstracting the general drag and drop hooks from react-dnd.
+ * Centralising the same behaviours and by default offering keyboard support.
+ */
+declare const useDragAndDrop: <TIndex extends number | number[], TItem extends {
+    [key: string]: unknown;
+    index: TIndex;
+    id?: Data.ID | undefined;
+} = {
+    [key: string]: unknown;
+    index: TIndex;
+}, Element extends HTMLElement = HTMLElement>(active: boolean, { type, index, item, onStart, onEnd, onGrabItem, onDropItem, onCancel, onMoveItem, dropSensitivity, }: UseDragAndDropOptions<TIndex, TItem>) => UseDragAndDropReturn<Element>;
+export { useDragAndDrop, UseDragAndDropReturn, UseDragAndDropOptions, DIRECTIONS, DROP_SENSITIVITY, };

package/dist/admin/src/routes/settings/hooks/useKeyboardDragAndDrop.d.ts

@@ -0,0 +1,14 @@
+import * as React from 'react';
+export type UseKeyboardDragAndDropCallbacks<TIndex extends number | Array<number> = number> = {
+    onCancel?: (index: TIndex) => void;
+    onDropItem?: (currentIndex: TIndex, newIndex?: TIndex) => void;
+    onGrabItem?: (index: TIndex) => void;
+    onMoveItem?: (newIndex: TIndex, currentIndex: TIndex) => void;
+};
+/**
+ * Utility hook designed to implement keyboard accessibile drag and drop by
+ * returning an onKeyDown handler to be passed to the drag icon button.
+ *
+ * @internal - You should use `useDragAndDrop` instead.
+ */
+export declare const useKeyboardDragAndDrop: <TIndex extends number | number[] = number>(active: boolean, index: TIndex, { onCancel, onDropItem, onGrabItem, onMoveItem }: UseKeyboardDragAndDropCallbacks<TIndex>) => React.KeyboardEventHandler<HTMLButtonElement>;

package/dist/admin/src/routes/settings/hooks/useReviewWorkflows.d.ts

@@ -0,0 +1,25 @@
+import { GetWorkflowsParams } from '../../../services/settings';
+import type { Create, Update } from '../../../../../shared/contracts/review-workflows';
+type UseReviewWorkflowsArgs = GetWorkflowsParams & {
+    skip?: boolean;
+};
+declare const useReviewWorkflows: (params?: UseReviewWorkflowsArgs) => {
+    meta: {
+        workflowCount: number;
+    } | undefined;
+    workflows: import("../../../../../shared/contracts/review-workflows").Workflow[];
+    isLoading: boolean;
+    error: import("../../../utils/api").BaseQueryError | import("@reduxjs/toolkit").SerializedError | undefined;
+    create: (data: Create.Request['body']['data']) => Promise<{
+        data: import("../../../../../shared/contracts/review-workflows").Workflow;
+    } | {
+        error: import("../../../utils/api").BaseQueryError | import("@reduxjs/toolkit").SerializedError;
+    }>;
+    delete: (id: string) => Promise<import("../../../../../shared/contracts/review-workflows").Workflow | undefined>;
+    update: (id: string, data: Update.Request['body']['data']) => Promise<{
+        data: import("../../../../../shared/contracts/review-workflows").Workflow;
+    } | {
+        error: import("../../../utils/api").BaseQueryError | import("@reduxjs/toolkit").SerializedError;
+    }>;
+};
+export { useReviewWorkflows };

package/dist/admin/src/routes/settings/index.d.ts

@@ -0,0 +1,3 @@
+export declare const ReviewWorkflowsListView: () => import("react/jsx-runtime").JSX.Element;
+declare const ProtectedListPage: () => import("react/jsx-runtime").JSX.Element;
+export { ProtectedListPage };

package/dist/admin/src/services/admin.d.ts

@@ -0,0 +1,5 @@
+import { SanitizedAdminUser } from '@strapi/admin/strapi-admin';
+type Roles = SanitizedAdminUser['roles'];
+declare const useGetRolesQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", import("@strapi/admin/strapi-admin").SanitizedAdminRole[], "reviewWorkflowsApi">>;
+export { useGetRolesQuery };
+export type { SanitizedAdminUser, Roles };

package/dist/admin/src/services/api.d.ts

@@ -0,0 +1,3 @@
+import { type UnknownApiError } from '../utils/api';
+declare const reviewWorkflowsApi: import("@reduxjs/toolkit/query/react").Api<import("@reduxjs/toolkit/query/react").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, {}, "reviewWorkflowsApi", "ReviewWorkflow" | "ReviewWorkflowStages", typeof import("@reduxjs/toolkit/query/react").coreModuleName | typeof import("@reduxjs/toolkit/query/react").reactHooksModuleName>;
+export { reviewWorkflowsApi, type UnknownApiError };

package/dist/admin/src/services/content-manager.d.ts

@@ -0,0 +1,38 @@
+import type { GetStages, UpdateStage, UpdateAssignee } from '../../../shared/contracts/review-workflows';
+import type { Contracts } from '@strapi/plugin-content-manager/_internal/shared';
+type ContentType = Contracts.ContentTypes.ContentType;
+interface ContentTypes {
+    collectionType: ContentType[];
+    singleType: ContentType[];
+}
+declare const useGetStagesQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<GetStages.Params & {
+    slug: string;
+    params?: object | undefined;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", {
+    stages: NonNullable<GetStages.Response['data']>;
+    meta: NonNullable<GetStages.Response['meta']>;
+}, "reviewWorkflowsApi">>, useUpdateStageMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<{
+    data: {
+        id: import("@strapi/types/dist/data").ID;
+    };
+} & UpdateStage.Params & {
+    slug: string;
+    params?: object | undefined;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", {
+    id: import("@strapi/types/dist/data").ID;
+} & {
+    [key: string]: any;
+}, "reviewWorkflowsApi">>, useUpdateAssigneeMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<{
+    data: {
+        id: import("@strapi/types/dist/data").ID | null;
+    };
+} & UpdateAssignee.Params & {
+    slug: string;
+    params?: object | undefined;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", {
+    id: import("@strapi/types/dist/data").ID;
+} & {
+    [key: string]: any;
+}, "reviewWorkflowsApi">>, useGetContentTypesQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<void, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", ContentTypes, "reviewWorkflowsApi">>;
+export { useGetStagesQuery, useUpdateStageMutation, useUpdateAssigneeMutation, useGetContentTypesQuery, };
+export type { ContentTypes, ContentType };

package/dist/admin/src/services/settings.d.ts

@@ -0,0 +1,13 @@
+import type { Update, Delete, GetAll, Get } from '../../../shared/contracts/review-workflows';
+type GetWorkflowsParams = Get.Params | (GetAll.Request['query'] & {
+    id?: never;
+});
+declare const useGetWorkflowsQuery: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseQuery<import("@reduxjs/toolkit/query").QueryDefinition<void | GetWorkflowsParams, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", {
+    workflows: GetAll.Response['data'];
+    meta?: GetAll.Response['meta'];
+}, "reviewWorkflowsApi">>, useCreateWorkflowMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<{
+    data: Omit<import("../../../shared/contracts/review-workflows").Workflow, "id" | "createdAt" | "updatedAt">;
+}, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", import("../../../shared/contracts/review-workflows").Workflow, "reviewWorkflowsApi">>, useDeleteWorkflowMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<Delete.Params, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", import("../../../shared/contracts/review-workflows").Workflow, "reviewWorkflowsApi">>, useUpdateWorkflowMutation: import("@reduxjs/toolkit/dist/query/react/buildHooks").UseMutation<import("@reduxjs/toolkit/query").MutationDefinition<{
+    data: Partial<import("../../../shared/contracts/review-workflows").Workflow>;
+} & Update.Params, import("@reduxjs/toolkit/query").BaseQueryFn<string | import("../utils/api").QueryArguments, unknown, import("../utils/api").BaseQueryError>, "ReviewWorkflow" | "ReviewWorkflowStages", import("../../../shared/contracts/review-workflows").Workflow, "reviewWorkflowsApi">>;
+export { useGetWorkflowsQuery, useCreateWorkflowMutation, useDeleteWorkflowMutation, useUpdateWorkflowMutation, type GetWorkflowsParams, };

package/dist/admin/src/utils/api.d.ts

@@ -0,0 +1,38 @@
+import { SerializedError } from '@reduxjs/toolkit';
+import { BaseQueryFn } from '@reduxjs/toolkit/query';
+import { ApiError } from '@strapi/admin/strapi-admin';
+import { type AxiosRequestConfig } from 'axios';
+export interface QueryArguments {
+    url: string;
+    method?: AxiosRequestConfig['method'];
+    data?: AxiosRequestConfig['data'];
+    config?: AxiosRequestConfig;
+}
+export interface UnknownApiError {
+    name: 'UnknownError';
+    message: string;
+    details?: unknown;
+    status?: number;
+}
+export type BaseQueryError = ApiError | UnknownApiError;
+declare const axiosBaseQuery: () => BaseQueryFn<string | QueryArguments, unknown, BaseQueryError>;
+declare const isBaseQueryError: (error: BaseQueryError | SerializedError) => error is BaseQueryError;
+interface Query {
+    plugins?: Record<string, unknown>;
+    _q?: string;
+    [key: string]: any;
+}
+/**
+ * This type extracts the plugin options from the query
+ * and appends them to the root of the query
+ */
+type TransformedQuery<TQuery extends Query> = Omit<TQuery, 'plugins'> & {
+    [key: string]: string;
+};
+/**
+ * @description
+ * Creates a valid query params object for get requests
+ * ie. plugins[18n][locale]=en becomes locale=en
+ */
+declare const buildValidParams: <TQuery extends Query>(query: TQuery) => TransformedQuery<TQuery>;
+export { axiosBaseQuery, isBaseQueryError, buildValidParams };

package/dist/admin/src/utils/cm-hooks.d.ts

@@ -0,0 +1,46 @@
+import type { ListFieldLayout, ListLayout } from '@strapi/plugin-content-manager/strapi-admin';
+interface AddColumnToTableHookArgs {
+    layout: ListLayout;
+    displayedHeaders: ListFieldLayout[];
+}
+declare const addColumnToTableHook: ({ displayedHeaders, layout }: AddColumnToTableHookArgs) => {
+    displayedHeaders: (ListFieldLayout | {
+        name: string;
+        attribute: {
+            type: "relation";
+            relation: "oneToMany";
+            target: "admin::review-workflow-stage";
+        };
+        label: {
+            id: string;
+            defaultMessage: string;
+        };
+        searchable: false;
+        sortable: true;
+        mainField: {
+            name: string;
+            type: "string";
+        };
+        cellFormatter: (props: import("@strapi/types/dist/modules/documents").AnyDocument) => import("react/jsx-runtime").JSX.Element;
+    } | {
+        name: string;
+        attribute: {
+            type: "relation";
+            target: "admin::user";
+            relation: "oneToMany";
+        };
+        label: {
+            id: string;
+            defaultMessage: string;
+        };
+        searchable: false;
+        sortable: true;
+        mainField: {
+            name: string;
+            type: "string";
+        };
+        cellFormatter: (props: import("@strapi/types/dist/modules/documents").AnyDocument) => import("react/jsx-runtime").JSX.Element;
+    })[];
+    layout: ListLayout;
+};
+export { addColumnToTableHook };

package/dist/admin/src/utils/colors.d.ts

@@ -0,0 +1,9 @@
+declare const getStageColorByHex: (hex?: string) => {
+    themeColorName: string;
+    name: string;
+} | null;
+declare const AVAILABLE_COLORS: {
+    hex: string;
+    name: string;
+}[];
+export { AVAILABLE_COLORS, getStageColorByHex };

package/dist/admin/src/utils/translations.d.ts

@@ -0,0 +1,3 @@
+type TradOptions = Record<string, string>;
+declare const prefixPluginTranslations: (trad: TradOptions, pluginId: string) => TradOptions;
+export { prefixPluginTranslations };

package/dist/admin/src/utils/users.d.ts

@@ -0,0 +1,6 @@
+import type { SanitizedAdminUser } from '@strapi/admin/strapi-admin';
+/**
+ * Retrieves the display name of an admin panel user
+ */
+declare const getDisplayName: ({ firstname, lastname, username, email, }?: Partial<Pick<SanitizedAdminUser, 'firstname' | 'lastname' | 'username' | 'email'>>) => string;
+export { getDisplayName };