coze-studio/frontend/packages/workflow/sdk
tecvan 6995cec404
chore: format all frontend files (#430)
2025-07-31 23:15:48 +08:00
..
__tests__ chore: format all frontend files (#430) 2025-07-31 23:15:48 +08:00
config feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
src chore: format all frontend files (#430) 2025-07-31 23:15:48 +08:00
.stylelintrc.js feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
README.md feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
eslint.config.js feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
package.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.build.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
tsconfig.misc.json feat: manually mirror opencoze's code from bytedance 2025-07-20 17:36:12 +08:00
vitest.config.ts chore: format all frontend files (#430) 2025-07-31 23:15:48 +08:00

README.md

@coze-workflow/sdk

workflow对外sdk

Overview

This package is part of the Coze Studio monorepo and provides architecture functionality. It includes component, editor.

Getting Started

Installation

Add this package to your package.json:

{
  "dependencies": {
    "@coze-workflow/sdk": "workspace:*"
  }
}

Then run:

rush update

Usage

import { /* exported functions/components */ } from '@coze-workflow/sdk';

// Example usage
// TODO: Add specific usage examples

Features

  • Component
  • Editor

API Reference

Exports

  • schemaExtractor, nodeResultExtractor
  • ExpressionEditorEvent, ExpressionEditorToken, ExpressionEditorSegmentType, ExpressionEditorSignal, ExpressionEditorLeaf, ExpressionEditorSuggestion, ExpressionEditorCounter, ExpressionEditorRender, ExpressionEditorModel, ExpressionEditorParser, ExpressionEditorTreeHelper, ExpressionEditorValidator, useListeners, useSelectNode, useKeyboardSelect, useRenderEffect, useSuggestionReducer,

For detailed API documentation, please refer to the TypeScript definitions.

Development

This package is built with:

  • TypeScript
  • Modern JavaScript
  • Vitest for testing
  • ESLint for code quality

Contributing

This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.

License

Apache-2.0