@choiceopen/atomemo-plugin-schema 0.1.8 → 0.2.0

package/README.md

@@ -2,7 +2,7 @@
 
 [English](./README.md) | [中文](./README.zh-CN.md)
 
-A comprehensive TypeScript type definitions and Zod schema validation library for developing Choiceform Atomemo plugins. This library ensures type safety at compile time and runtime validation for plugin definitions. Plugins must declare the implementation language via the `lang` field (currently `elixir` or `typescript`).
+A comprehensive TypeScript type definitions and Zod schema validation library for developing Choiceform Atomemo plugins. This library ensures type safety at compile time and runtime validation for plugin definitions.
 
 ## Features
 
@@ -78,7 +78,6 @@ const pluginDefinition: PluginDefinition = {
   icon: 'https://example.com/icon.png',
   version: '1.0.0',
   locales: ['en', 'zh_CN'],
-  lang: 'typescript',
 };
 
 // Validate at runtime
@@ -142,7 +141,7 @@ Each property type can be configured with different UI components:
 - `number-input`, `slider`
 
 **Boolean type components:**
-- `switch`
+- `switch`, `checkbox`
 
 **Array type components:**
 - `multi-select`, `tag-input`, `key-value-editor`, `slider`, `array-section`

package/README.zh-CN.md

@@ -2,7 +2,7 @@
 
 [English](./README.md) | [中文](./README.zh-CN.md)
 
-一个全面的 TypeScript 类型定义和 Zod Schema 验证库，用于开发 Choiceform Atomemo 插件。该库确保插件定义在编译时和运行时的类型安全与验证。插件需要通过 `lang` 字段声明实现语言（目前支持 `elixir` 与 `typescript`）。
+一个全面的 TypeScript 类型定义和 Zod Schema 验证库，用于开发 Choiceform Atomemo 插件。该库确保插件定义在编译时和运行时的类型安全与验证。
 
 ## 特性
 
@@ -78,7 +78,6 @@ const pluginDefinition: PluginDefinition = {
   icon: 'https://example.com/icon.png',
   version: '1.0.0',
   locales: ['en', 'zh_CN'],
-  lang: 'typescript',
 };
 
 // 运行时验证
@@ -142,7 +141,7 @@ if (!result.success) {
 - `number-input`、`slider`
 
 **布尔类型可用组件：**
-- `switch`
+- `switch`、`checkbox`
 
 **数组类型可用组件：**
 - `multi-select`、`tag-input`、`key-value-editor`、`slider`、`array-section`

package/dist/{types-B3nkHte0.d.ts → definition-DEEuUiSF.d.mts}

@@ -108,24 +108,10 @@ interface PropertyUINumberInputProps extends PropertyUICommonProps {
 /** 代码编辑器 UI 属性 */
 interface PropertyUICodeEditorProps extends PropertyUICommonProps {
   component: "code-editor";
-  language?: "json" | "javascript" | "python3";
-  /**
-   * Show line numbers in the code editor.
-   * @default false
-   */
+  language?: "json" | "javascript" | "python3" | "html";
   line_numbers?: boolean;
-  /**
-   * Enable line wrapping in the code editor.
-   * @default false
-   */
-  line_wrapping?: boolean;
   max_height?: number;
   min_height?: number;
-  /**
-   * Number of rows to show in the code editor.
-   * @default 4
-   */
-  rows?: number;
 }
 interface PropertyUISelectPropsBase {
   clearable?: boolean;
@@ -151,6 +137,9 @@ interface PropertyUIMultiSelectProps extends PropertyUICommonProps, PropertyUISe
 interface PropertyUISwitchProps extends PropertyUICommonProps {
   component: "switch";
 }
+interface PropertyUICheckboxProps extends PropertyUICommonProps {
+  component: "checkbox";
+}
 interface PropertyUISliderProps extends PropertyUICommonProps {
   component: "slider";
   marks?: Record<number, string>;
@@ -200,16 +189,13 @@ interface PropertyUICollapsiblePanelProps extends PropertyUICommonProps {
   remove_tooltip?: I18nText;
   sortable?: boolean;
 }
-interface PropertyUISectionProps extends PropertyUICommonProps {
-  component: "section";
-}
-type PropertyUIProps = PropertyUIInputProps | PropertyUITextareaProps | PropertyUINumberInputProps | PropertyUICodeEditorProps | PropertyUISingleSelectProps | PropertyUIRadioGroupProps | PropertyUIEmojiPickerProps | PropertyUIColorPickerProps | PropertyUIMultiSelectProps | PropertyUISwitchProps | PropertyUISliderProps | PropertyUIKeyValueEditorProps | PropertyUITagInputProps | PropertyUICredentialSelectProps | PropertyUIJsonSchemaEditorProps | PropertyUIConditionsEditorProps | PropertyUIArraySectionProps | PropertyUICollapsiblePanelProps | PropertyUISectionProps | PropertyUIEncryptedInputProps;
+type PropertyUIProps = PropertyUIInputProps | PropertyUITextareaProps | PropertyUINumberInputProps | PropertyUICodeEditorProps | PropertyUISingleSelectProps | PropertyUIRadioGroupProps | PropertyUIEmojiPickerProps | PropertyUIColorPickerProps | PropertyUIMultiSelectProps | PropertyUISwitchProps | PropertyUICheckboxProps | PropertyUISliderProps | PropertyUIKeyValueEditorProps | PropertyUITagInputProps | PropertyUICredentialSelectProps | PropertyUIJsonSchemaEditorProps | PropertyUIConditionsEditorProps | PropertyUIArraySectionProps | PropertyUICollapsiblePanelProps | PropertyUIEncryptedInputProps;
 type PropertyUIComponentType = PropertyUIProps["component"];
-type PropertyUIBoolean = PropertyUISwitchProps;
+type PropertyUIBoolean = PropertyUISwitchProps | PropertyUICheckboxProps;
 type PropertyUINumber = PropertyUINumberInputProps | PropertyUISliderProps;
 type PropertyUIString = PropertyUIInputProps | PropertyUITextareaProps | PropertyUICodeEditorProps | PropertyUISingleSelectProps | PropertyUICredentialSelectProps | PropertyUIRadioGroupProps | PropertyUIEmojiPickerProps | PropertyUIColorPickerProps;
 type PropertyUIArray = PropertyUIMultiSelectProps | PropertyUITagInputProps | PropertyUIKeyValueEditorProps | PropertyUISliderProps | PropertyUIArraySectionProps;
-type PropertyUIContainer = PropertyUICollapsiblePanelProps | PropertyUISectionProps;
+type PropertyUIContainer = PropertyUICollapsiblePanelProps;
 type PropertyUIMisc = PropertyUIJsonSchemaEditorProps | PropertyUIConditionsEditorProps;
 type PropertyUIObject = PropertyUIContainer | PropertyUIMisc | PropertyUICodeEditorProps;
 type PropertyUICredentialId = PropertyUICredentialSelectProps;
@@ -226,7 +212,8 @@ type DisplayCondition<TSchema extends JsonObject = JsonObject> =
 { [P in keyof TSchema]?: Condition<TSchema[P]> }
 /**
  * Logical operators for combining multiple conditions
- */ | RootFilter<TSchema>;
+ */
+| RootFilter<TSchema>;
 /**
  * Root Filter Operators for group conditions
  */
@@ -234,15 +221,15 @@ interface RootFilter<TSchema extends JsonObject = JsonObject> {
   /**
    * Joins conditions with logical AND; all conditions must be true
    */
-  $and?: Array<DisplayCondition<TSchema>> | null;
+  $and?: Array<DisplayCondition<TSchema>>;
   /**
    * Joins conditions with logical NOR; none of the conditions must be true
    */
-  $nor?: Array<DisplayCondition<TSchema>> | null;
+  $nor?: Array<DisplayCondition<TSchema>>;
   /**
    * Joins conditions with logical OR; at least one condition must be true
    */
-  $or?: Array<DisplayCondition<TSchema>> | null;
+  $or?: Array<DisplayCondition<TSchema>>;
 }
 type Condition<T extends JsonValue = JsonValue> = T | FilterOperators<T>;
 /**
@@ -253,55 +240,55 @@ interface FilterOperators<TValue extends JsonValue = JsonValue> {
   /**
    * Matches values equal to a specified value
    */
-  $eq?: TValue | null;
+  $eq?: TValue;
   /**
    * Checks if a field exists
    */
-  $exists?: boolean | null;
+  $exists?: boolean;
   /**
    * Matches values greater than a specified value
    */
-  $gt?: TValue | null;
+  $gt?: TValue;
   /**
    * Matches values greater than or equal to a specified value
    */
-  $gte?: TValue | null;
+  $gte?: TValue;
   /**
    * Matches any value specified in an array
    */
-  $in?: Array<TValue> | null;
+  $in?: Array<TValue>;
   /**
    * Matches values less than a specified value
    */
-  $lt?: TValue | null;
+  $lt?: TValue;
   /**
    * Matches values less than or equal to a specified value
    */
-  $lte?: TValue | null;
+  $lte?: TValue;
   /**
    * Matches values based on a modulo operation; value: [divisor, remainder]
    */
-  $mod?: TValue extends number ? [number, number] | null : never;
+  $mod?: TValue extends number ? [number, number] : never;
   /**
    * Matches values not equal to a specified value
    */
-  $ne?: TValue | null;
+  $ne?: TValue;
   /**
    * Matches values not in a specified array
    */
-  $nin?: Array<TValue> | null;
+  $nin?: Array<TValue>;
   /**
    * Regex options: i=case-insensitive, m=multiline, x=ignore whitespace, s=dotAll, u=unicode
    */
-  $options?: TValue extends string ? string | null : never;
+  $options?: TValue extends string ? string : never;
   /**
    * Matches values against a regular expression pattern
    */
-  $regex?: TValue extends string ? RegExp | string | null : never;
+  $regex?: TValue extends string ? RegExp | string : never;
   /**
    * Matches arrays with a specified number of elements
    */
-  $size?: TValue extends Array<unknown> ? number | null : never;
+  $size?: TValue extends Array<unknown> ? number : never;
 }
 interface PropertyBase<TName extends string = string> {
   /**
@@ -311,92 +298,92 @@ interface PropertyBase<TName extends string = string> {
   /**
    * Display name (supports i18n)
    */
-  display_name?: I18nText | null;
+  display_name?: I18nText;
   /**
    * Whether this property is required
    */
-  required?: boolean | null;
+  required?: boolean;
   /**
    * Display condition; if not set, property is always visible
    */
   display?: {
-    hide?: DisplayCondition | null;
-    show?: DisplayCondition | null;
-  } | null;
+    hide?: DisplayCondition;
+    show?: DisplayCondition;
+  };
   /**
    * AI-related configuration
    */
   ai?: {
-    llm_description?: I18nText | null;
-  } | null;
+    llm_description?: I18nText;
+  };
   /**
    * UI configuration for how the property is displayed
    */
-  ui?: PropertyUICommonProps | null;
+  ui?: PropertyUICommonProps;
 }
 interface PropertyString<TName extends string = string> extends PropertyBase<TName> {
   type: "string";
   /**
    * Restrict value to a single constant
    */
-  constant?: string | null;
+  constant?: string;
   /**
    * Default value when not specified
    */
-  default?: string | null;
+  default?: string;
   /**
    * Restrict value to a set of allowed values
    */
-  enum?: Array<string> | null;
+  enum?: Array<string>;
   /**
    * Maximum string length
    */
-  max_length?: number | null;
+  max_length?: number;
   /**
    * Minimum string length
    */
-  min_length?: number | null;
-  ui?: PropertyUIString | null;
+  min_length?: number;
+  ui?: PropertyUIString;
 }
 interface PropertyNumber<TName extends string = string> extends PropertyBase<TName> {
   type: "number" | "integer";
   /**
    * Restrict value to a single constant
    */
-  constant?: number | null;
+  constant?: number;
   /**
    * Default value when not specified
    */
-  default?: number | null;
+  default?: number;
   /**
    * Restrict value to a set of allowed values
    */
-  enum?: Array<number> | null;
+  enum?: Array<number>;
   /**
    * Maximum value (inclusive)
    */
-  maximum?: number | null;
+  maximum?: number;
   /**
    * Minimum value (inclusive)
    */
-  minimum?: number | null;
-  ui?: PropertyUINumber | null;
+  minimum?: number;
+  ui?: PropertyUINumber;
 }
 interface PropertyBoolean<TName extends string = string> extends PropertyBase<TName> {
   type: "boolean";
   /**
    * Restrict value to a single constant
    */
-  constant?: boolean | null;
+  constant?: boolean;
   /**
    * Default value when not specified
    */
-  default?: boolean | null;
+  default?: boolean;
   /**
    * Restrict value to a set of allowed values
    */
-  enum?: Array<boolean> | null;
-  ui?: PropertyUIBoolean | null;
+  enum?: Array<boolean>;
+  ui?: PropertyUIBoolean;
 }
 /**
  * Object Property Type
@@ -415,22 +402,22 @@ interface PropertyObject<TName extends string = string, TDiscriminator extends s
   /**
    * Restrict value to a single constant
    */
-  constant?: TValue | null;
+  constant?: TValue;
   /**
    * Default value when not specified
    */
-  default?: TValue | null;
+  default?: TValue;
   /**
    * Restrict value to a set of allowed values
    */
-  enum?: Array<TValue> | null;
+  enum?: Array<TValue>;
   /**
    * Schema for additional properties beyond those defined in `properties`.
    * Supports dynamic keys with values conforming to the specified property schema.
    * Semantics similar to JSON Schema's additionalProperties: https://json-schema.org/draft/2019-09/draft-handrews-json-schema-02#additionalProperties
    */
-  additional_properties?: Property | null;
-  ui?: PropertyUIObject | null;
+  additional_properties?: Property;
+  ui?: PropertyUIObject;
 }
 interface PropertyDiscriminatedUnion<TName extends string = string, TDiscriminator extends string = string> extends PropertyBase<TName> {
   type: "discriminated_union";
@@ -445,13 +432,13 @@ interface PropertyDiscriminatedUnion<TName extends string = string, TDiscriminat
   /**
    * UI component for displaying the discriminator field
    */
-  discriminator_ui?: PropertyUISwitchProps | PropertyUISingleSelectProps | PropertyUIRadioGroupProps | null;
+  discriminator_ui?: PropertyUISwitchProps | PropertyUISingleSelectProps | PropertyUIRadioGroupProps;
 }
 interface PropertyArray<TName extends string = string> extends PropertyBase<TName> {
   type: "array";
-  constant?: Array<JsonValue> | null;
-  default?: Array<JsonValue> | null;
-  enum?: Array<Array<JsonValue>> | null;
+  constant?: Array<JsonValue>;
+  default?: Array<JsonValue>;
+  enum?: Array<Array<JsonValue>>;
   /**
    * Item schema for array elements
    */
@@ -459,12 +446,12 @@ interface PropertyArray<TName extends string = string> extends PropertyBase<TNam
   /**
    * Maximum array size (inclusive)
    */
-  max_items?: number | null;
+  max_items?: number;
   /**
    * Minimum array size (inclusive)
    */
-  min_items?: number | null;
-  ui?: PropertyUIArray | null;
+  min_items?: number;
+  ui?: PropertyUIArray;
 }
 interface PropertyCredentialId<TName extends string = string> extends PropertyBase<TName> {
   type: "credential_id";
@@ -474,11 +461,11 @@ interface PropertyCredentialId<TName extends string = string> extends PropertyBa
    * **Note:** The name must match exactly, otherwise the system will be unable to find the corresponding credential.
    */
   credential_name: string;
-  ui?: PropertyUICredentialId | null;
+  ui?: PropertyUICredentialId;
 }
 interface PropertyEncryptedString<TName extends string = string> extends PropertyBase<TName> {
   type: "encrypted_string";
-  ui?: PropertyUIEncryptedString | null;
+  ui?: PropertyUIEncryptedString;
 }
 type PropertyScalar<TName extends string = string> = PropertyString<TName> | PropertyBoolean<TName> | PropertyNumber<TName> | PropertyEncryptedString<TName>;
 type Property<TName extends string = string, TValue extends JsonValue = JsonValue> = PropertyScalar<TName> | PropertyCredentialId<TName> | PropertyArray<TName> | PropertyObject<TName, string, TValue extends JsonObject ? TValue : JsonObject> | PropertyDiscriminatedUnion<TName, string>;
@@ -513,15 +500,15 @@ interface PluginDefinition<Locales extends string[], TransporterOptions> extends
   /**
    * The author's name of the plugin.
    */
-  author?: string | null;
+  author?: string;
   /**
    * The author's email address.
    */
-  email?: string | null;
+  email?: string;
   /**
    * The source URL of the plugin.
    */
-  repo?: string | null;
+  repo?: string;
   /**
    * The version of the plugin.
    *
@@ -529,21 +516,37 @@ interface PluginDefinition<Locales extends string[], TransporterOptions> extends
    *
    * We recommend doing it this way, but if you do provide this value, please ensure that it remains consistent with the version field in package.json.
    */
-  version?: string | null;
+  version?: string;
   /**
    * The options for the transporter.
    */
   transporterOptions?: TransporterOptions;
-  /**
-   * The programming language the plugin is implemented in.
-   */
-  lang: "elixir" | "typescript";
 }
 type Feature = CredentialDefinition | DataSourceDefinition | ModelDefinition | ToolDefinition;
 /**
  * Credential definition
  */
 interface CredentialDefinition extends BaseDefinition {
+  authenticate: (input: {
+    args: {
+      parameters: {
+        /**
+         * If it is called for the LLM authentication, then this property is the model name.
+         */
+        model?: string;
+        [key: string]: unknown;
+      };
+      credentials: Record<string, string>;
+    };
+  }) => Promise<{
+    /**
+     * What kind of
+     */
+    adapter: "anthropic" | "openai" | "google" | "deepseek";
+    endpoint?: string;
+    model: string;
+    headers?: Record<string, string>;
+  }>;
   parameters: Array<PropertyScalar>;
 }
 /**
@@ -701,8 +704,11 @@ interface ToolDefinition extends BaseDefinition {
    *
    * **Caution for developers**: You must ensure that the return value is JSON serializable.
    */
-  invoke: (context: {
-    args: any;
+  invoke: (input: {
+    args: {
+      parameters: Record<string, any>;
+      credentials?: Record<string, string>;
+    };
   }) => Promise<JsonValue$1>;
   /**
    * Parameters
@@ -710,5 +716,5 @@ interface ToolDefinition extends BaseDefinition {
   parameters: Array<Property>;
 }
 //#endregion
-export { PropertyUIEmojiPickerProps as A, PropertyUIRadioGroupProps as B, PropertyUIBoolean as C, PropertyUIComponentType as D, PropertyUICommonProps as E, PropertyUIMisc as F, JsonValue$1 as G, PropertyUISingleSelectProps as H, PropertyUINumber as I, JsonValueSchema as K, PropertyUIObject as L, PropertyUIEncryptedString as M, PropertyUIInputProps as N, PropertyUIContainer as O, PropertyUIKeyValueEditorProps as P, PropertyUIOption as R, PropertyUIArraySectionProps as S, PropertyUIColorPickerProps as T, PropertyUIString as U, PropertyUISectionProps as V, PropertyUISwitchProps as W, PropertyNumber as _, ModelDefinition as a, PropertyString as b, DisplayCondition as c, PropertyArray as d, PropertyBase as f, PropertyEncryptedString as g, PropertyDiscriminatedUnion as h, Feature as i, PropertyUIEncryptedInputProps as j, PropertyUICredentialId as k, FilterOperators as l, PropertyCredentialId as m, CredentialDefinition as n, PluginDefinition as o, PropertyBoolean as p, I18nText as q, DataSourceDefinition as r, ToolDefinition as s, BaseDefinition as t, Property as u, PropertyObject as v, PropertyUICollapsiblePanelProps as w, PropertyUIArray as x, PropertyScalar as y, PropertyUIProps as z };
-//# sourceMappingURL=types-B3nkHte0.d.ts.map
+export { PropertyUIEmojiPickerProps as A, PropertyUIRadioGroupProps as B, PropertyUIBoolean as C, PropertyUIComponentType as D, PropertyUICommonProps as E, PropertyUIMisc as F, JsonValueSchema as G, PropertyUIString as H, PropertyUINumber as I, I18nText as K, PropertyUIObject as L, PropertyUIEncryptedString as M, PropertyUIInputProps as N, PropertyUIContainer as O, PropertyUIKeyValueEditorProps as P, PropertyUIOption as R, PropertyUIArraySectionProps as S, PropertyUIColorPickerProps as T, PropertyUISwitchProps as U, PropertyUISingleSelectProps as V, JsonValue$1 as W, PropertyNumber as _, ModelDefinition as a, PropertyString as b, DisplayCondition as c, PropertyArray as d, PropertyBase as f, PropertyEncryptedString as g, PropertyDiscriminatedUnion as h, Feature as i, PropertyUIEncryptedInputProps as j, PropertyUICredentialId as k, FilterOperators as l, PropertyCredentialId as m, CredentialDefinition as n, PluginDefinition as o, PropertyBoolean as p, DataSourceDefinition as r, ToolDefinition as s, BaseDefinition as t, Property as u, PropertyObject as v, PropertyUICollapsiblePanelProps as w, PropertyUIArray as x, PropertyScalar as y, PropertyUIProps as z };
+//# sourceMappingURL=definition-DEEuUiSF.d.mts.map