apaas-oapi-client 1.0.0 → 1.0.1

package/dist/field-schema-rules.d.ts

@@ -47,7 +47,8 @@ export declare const OPTION_COLOR_RULES: {
         readonly colorPath: "type.settings.options[].color";
         readonly colorInput: "SDK accepts metadata color names and normalizes them to OpenAPI color codes before writing.";
         readonly colorCodeByName: Record<"blue" | "cyan" | "green" | "yellow" | "orange" | "red" | "magenta" | "purple" | "blueMagenta" | "grey", string>;
-        readonly sourcePath: "type.settings.option_source";
+        readonly sourcePath: "type.settings.option_type";
+        readonly customSourceValue: "local";
         readonly globalOptionPath: "type.settings.global_option_api_name";
     };
 };

package/dist/index.js

@@ -828,7 +828,8 @@ const OPTION_COLOR_RULES = {
         colorPath: 'type.settings.options[].color',
         colorInput: 'SDK accepts metadata color names and normalizes them to OpenAPI color codes before writing.',
         colorCodeByName: OPTION_COLOR_CODE_BY_NAME,
-        sourcePath: 'type.settings.option_source',
+        sourcePath: 'type.settings.option_type',
+        customSourceValue: 'local',
         globalOptionPath: 'type.settings.global_option_api_name'
     }
 };
@@ -894,7 +895,7 @@ const FIELD_SCHEMA_RULES = [
         settingsExample: {
             required: false,
             multiple: false,
-            option_source: 'custom',
+            option_type: 'local',
             global_option_api_name: '',
             options: [
                 {
@@ -913,7 +914,7 @@ const FIELD_SCHEMA_RULES = [
                 }
             ]
         },
-        notes: `Do not send create type as \`option\`. Metadata returns optionList/optionSource/globalOptionAPIName; create/update expects options/option_source/global_option_api_name. The SDK accepts metadata color names and sends OpenAPI color codes (${Object.entries(OPTION_COLOR_CODE_BY_NAME).map(([name, code]) => `${name}=${code}`).join(', ')}).`
+        notes: `Do not send create type as \`option\`. Metadata returns optionList/optionSource/globalOptionAPIName; create/update expects options and UI-editable custom options require option_type=local. The SDK also accepts legacy option_source=custom or option_type=custom and sends option_type=local. The SDK accepts metadata color names and sends OpenAPI color codes (${Object.entries(OPTION_COLOR_CODE_BY_NAME).map(([name, code]) => `${name}=${code}`).join(', ')}).`
     },
     {
         metadataType: 'boolean',
@@ -1118,13 +1119,18 @@ function normalizeSchemaFieldForWrite(field) {
     if (((_b = field.type) === null || _b === void 0 ? void 0 : _b.name) !== 'enum' || !Array.isArray(settings === null || settings === void 0 ? void 0 : settings.options)) {
         return { ...field };
     }
+    const normalizedSettings = { ...settings };
+    if (normalizedSettings.option_type === 'custom' || normalizedSettings.option_source === 'custom') {
+        normalizedSettings.option_type = 'local';
+        delete normalizedSettings.option_source;
+    }
     return {
         ...field,
         type: {
             ...field.type,
             settings: {
-                ...settings,
-                options: settings.options.map((option) => {
+                ...normalizedSettings,
+                options: normalizedSettings.options.map((option) => {
                     if (!option || typeof option !== 'object' || !('color' in option)) {
                         return option;
                     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "apaas-oapi-client",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "main": "dist/index.js",
     "bin": {
         "apaas-oapi-client": "bin/apaas-oapi-client.js"

package/skills/apaas-schema/references/field-schema-rules.md

@@ -94,7 +94,7 @@ blue, cyan, green, yellow, orange, red, magenta, purple, blueMagenta, grey, blue
   type: {
     name: "enum",
     settings: {
-      option_source: "custom",
+      option_type: "local",
       global_option_api_name: "",
       options: [
         { api_name: "option_x", color: "blue", active: true, label: { zh_cn: "1", en_us: "1" } }
@@ -104,6 +104,8 @@ blue, cyan, green, yellow, orange, red, magenta, purple, blueMagenta, grey, blue
 }
 ```
 
+For UI-editable custom options, use `option_type: "local"`. The SDK accepts legacy `option_source: "custom"` or `option_type: "custom"` and normalizes them to `option_type: "local"` before writing.
+
 OpenAPI write payloads require color short codes, while metadata returns color names. The SDK normalizes these names before writing, so SDK callers can keep using `blue`, `cyan`, etc.
 
 | Metadata color | OpenAPI write code |

package/src/FIELD_SCHEMA_RULES.md

@@ -76,13 +76,15 @@ Live metadata for option fields returns camelCase keys:
 - Option source: `type.settings.optionSource`
 - Global option API name: `type.settings.globalOptionAPIName`
 
-Create/update schema payloads use snake_case keys:
+Create/update schema payloads use write keys:
 
 - Type name: `enum`
 - Options path: `type.settings.options`
-- Option source: `type.settings.option_source`
+- Custom option source: `type.settings.option_type = "local"`
 - Global option API name: `type.settings.global_option_api_name`
 
+For UI-editable custom options, send `option_type: "local"`. The SDK also accepts legacy `option_source: "custom"` or `option_type: "custom"` and normalizes them to `option_type: "local"` before writing.
+
 OpenAPI write payloads require color short codes, while metadata returns color names. The SDK normalizes these metadata names before writing:
 
 | Metadata color | OpenAPI write code |

package/src/field-schema-rules.ts

@@ -157,7 +157,8 @@ export const OPTION_COLOR_RULES = {
         colorPath: 'type.settings.options[].color',
         colorInput: 'SDK accepts metadata color names and normalizes them to OpenAPI color codes before writing.',
         colorCodeByName: OPTION_COLOR_CODE_BY_NAME,
-        sourcePath: 'type.settings.option_source',
+        sourcePath: 'type.settings.option_type',
+        customSourceValue: 'local',
         globalOptionPath: 'type.settings.global_option_api_name'
     }
 } as const;
@@ -224,7 +225,7 @@ export const FIELD_SCHEMA_RULES: FieldCreateRule[] = [
         settingsExample: {
             required: false,
             multiple: false,
-            option_source: 'custom',
+            option_type: 'local',
             global_option_api_name: '',
             options: [
                 {
@@ -243,7 +244,7 @@ export const FIELD_SCHEMA_RULES: FieldCreateRule[] = [
                 }
             ]
         },
-        notes: `Do not send create type as \`option\`. Metadata returns optionList/optionSource/globalOptionAPIName; create/update expects options/option_source/global_option_api_name. The SDK accepts metadata color names and sends OpenAPI color codes (${Object.entries(OPTION_COLOR_CODE_BY_NAME).map(([name, code]) => `${name}=${code}`).join(', ')}).`
+        notes: `Do not send create type as \`option\`. Metadata returns optionList/optionSource/globalOptionAPIName; create/update expects options and UI-editable custom options require option_type=local. The SDK also accepts legacy option_source=custom or option_type=custom and sends option_type=local. The SDK accepts metadata color names and sends OpenAPI color codes (${Object.entries(OPTION_COLOR_CODE_BY_NAME).map(([name, code]) => `${name}=${code}`).join(', ')}).`
     },
     {
         metadataType: 'boolean',

package/src/schema-utils.ts

@@ -205,13 +205,19 @@ function normalizeSchemaFieldForWrite<T extends { type?: any }>(field: T): T {
         return { ...field };
     }
 
+    const normalizedSettings = { ...settings };
+    if (normalizedSettings.option_type === 'custom' || normalizedSettings.option_source === 'custom') {
+        normalizedSettings.option_type = 'local';
+        delete normalizedSettings.option_source;
+    }
+
     return {
         ...field,
         type: {
             ...field.type,
             settings: {
-                ...settings,
-                options: settings.options.map((option: any) => {
+                ...normalizedSettings,
+                options: normalizedSettings.options.map((option: any) => {
                     if (!option || typeof option !== 'object' || !('color' in option)) {
                         return option;
                     }