Files
coze-studio/frontend/packages/workflow/adapter/playground/src/hooks/use-page-params.ts
2025-07-31 23:15:48 +08:00

117 lines
3.4 KiB
TypeScript

/*
* Copyright 2025 coze-dev Authors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { useMemo } from 'react';
import { useMount } from 'ahooks';
import { type WorkflowPlaygroundProps } from '@coze-workflow/playground';
import { OperateType } from '@coze-workflow/base/api';
import { I18n } from '@coze-arch/i18n';
import { Toast } from '@coze-arch/coze-design';
/** Process details page parameters */
interface SearchParams {
workflow_id: string;
space_id: string;
/** Process version, when multiple people cooperate, there is a version concept, and the corresponding version process can be previewed when set separately */
version?: string;
/** Whether to restore to the target version, if set, the process draft will be automatically set to the corresponding version */
set_version?: string;
/** Corresponding version of the operation type */
opt_type?: string;
/** Process page open source */
from?: WorkflowPlaygroundProps['from'];
/** The node id configuration will automatically locate to the corresponding node. */
node_id?: string;
/** The execution id configuration will display the corresponding execution result. */
execute_id?: string;
/** subprocess execution id */
sub_execute_id?: string;
}
export function usePageParams() {
const searchParams = useMemo(() => {
const target: SearchParams = {
workflow_id: '',
space_id: '',
};
const params = new URLSearchParams(window.location.search);
params.forEach((value, key) => {
target[key] = value;
});
return target;
}, []);
const {
space_id: spaceId,
workflow_id: workflowId,
version,
set_version: setVersion,
opt_type,
from,
node_id: nodeId,
execute_id: executeId,
sub_execute_id: subExecuteId,
} = searchParams;
const optType = opt_type
? (Number(opt_type) as OperateType)
: OperateType.SubmitOperate;
useMount(() => {
const newSearchParams = new URLSearchParams(window.location.search);
let needUpdateSearch = false;
if (from === 'createSuccess') {
Toast.success(I18n.t('Create_success'));
newSearchParams.delete('from');
needUpdateSearch = true;
} else if (from === 'dupSuccess') {
Toast.success(I18n.t('Duplicate_success'));
newSearchParams.delete('from');
needUpdateSearch = true;
}
// Force setting of historical version
if (setVersion) {
newSearchParams.delete('set_version');
newSearchParams.delete('version');
newSearchParams.delete('opt_type');
needUpdateSearch = true;
}
if (needUpdateSearch) {
history.replaceState(
{},
'',
`${location.origin + location.pathname}?${newSearchParams.toString()}`,
);
}
});
return {
spaceId,
workflowId,
version,
setVersion: Boolean(searchParams.set_version),
optType,
from,
nodeId,
executeId,
subExecuteId,
};
}