@tier0/sdk-v2 0.4.0 → 0.5.0

package/README.md

@@ -2,9 +2,11 @@
 
 Tier0 云端新架构的独立 TypeScript / JavaScript SDK。新仓库、新 npm 包，不覆盖 `@tier0/sdk`。
 
+`0.5.0` 将 Cloud HTTP Source 统一为 `protocol: http-api`，通过 `config.role: client | server` 区分主动请求与同步入站。升级时需迁移旧 `http` / 正向 `http_push` 配置；独立异步 `http_push` 的 202 accepted 合同继续保留。
+
 `0.4.0` 版本变更：相对 0.3.x 移除已退役的 Stream 就绪探针且不保留别名，改用服务端现有统一权限，不再配置逐 Key Control scopes/codes。0.3.0 起统一使用 OpenAPI v2 并退役重复及旧接口；与 0.2.x 存在不兼容变更，迁移方式见下方“本次接口退役”。对应 UNS v2 契约 5.0.0，与 0.1.0 不兼容（新错误模型 `execution` / `retry`、封顶计数、删除 `recordChangesPoll` 等）。Collection 支持 int、float、double 和 datetime 声明；格式注解不新增数值范围或日期格式校验，Sample 外层 time 保持不变。使用时需确认目标环境已部署对应后端。要求 Node.js 20.19+。浏览器 HTTP、MQTT、React、Vue 和服务端身份验签分别提供独立入口。
 
-本次合同固定到已部署 Backend `6cb53b80`，同步请求统一权限、移除旧探针，并保留该版本 Source discovery 的副作用分类及不自动重试语义。
+本版本合同快照固定到已提交 Backend `86bef2325253c2f4eaab8168f983ac4ec09c0d2f`；使用前需确认目标环境已部署相应合同。请求统一权限、旧探针退役门禁、Source discovery 的副作用分类及不自动重试语义保持不变。
 
 既有接口收敛：平台接口统一迁移到 `/openapi/v2`，Controls 使用 `/openapi/v2/uns/controls/*`；移除 21 个重复 UNS 入口和旧 Agent nodes/relations 方法。完善 Source 操作、Stream 发布回执及 UNS 创建快照的使用说明，保留精确发布编号和完整文档访问规则。
 
@@ -13,7 +15,7 @@ Tier0 云端新架构的独立 TypeScript / JavaScript SDK。新仓库、新 npm
 维护者发布前在本仓库运行 `npm ci`、`npm run check`，并验证生成的 `.tgz`。业务项目安装精确版本：
 
 ```sh
-npm install --save-exact @tier0/sdk-v2@0.4.0
+npm install --save-exact @tier0/sdk-v2@0.5.0
 ```
 
 ```ts
@@ -77,6 +79,8 @@ const sources = await tier0.source.documents.list({ page: 1, size: 20 });
 const programs = await tier0.stream.programs.list({ page: 1, size: 20 });
 ```
 
+HTTP Source 统一使用 `protocol: 'http-api'`，显式设置 `config.role: 'client'`（主动请求）或 `config.role: 'server'`（接收入站请求），与 Enterprise 一协议两角色保持一致；Cloud 管理文档的角色位于 config 内。旧 `http` 正向示例迁移为 `http-api` + `client`；Server 不能作为 Client 发起主动请求。独立异步 `http_push` 保留 202 accepted 合同，接受不代表处理完成。使用 `source.protocols.list({})` 核对目标环境支持，再通过现有 `source.documents.*` 管理配置。HTTP Client 单条 inline 创建支持 Basic、Bearer、APIKey、OAuth 四类认证，凭据默认绑定 Source 基址 REQUEST，显式方法继续保留限制；独立 credentialCreate 仍为 coreOnly。SDK 不新增猜测的 HTTP In API；npm 管理 SDK 与执行器中的 Goja Stream 脚本 API 分开使用。
+
 Source/Stream 仍保留 `{ code, msg, requestId, data }` 响应以及 `UnsV2Error` 错误类型。Source 配置统一使用 `source.documents`；Stream 草稿统一通过 `stream.documents` 创建、读取、校验和修改，输入 `program` 与 `document` 二选一。发布和回滚仍走 `stream.programs`。保存、部署、运行成功分别判断。
 
 旧 `stream.runtime.capabilities()` 及底层 `streamRuntimeCapabilitiesGet` 已退役，没有兼容别名；不要把该查询当作 Stream 前置检查，也不要为消除它的 403 增加 Control scope 或逐 Key 的控制码授权。Stream 管理、实际执行、发布、回滚及运行记录继续通过各自接口和统一权限校验；通用能力发现不代替实际操作结果。

package/dist/cjs/uns-v2/generated.d.ts

@@ -227,8 +227,9 @@ export type HTTPConnection = {
     "authentication"?: string;
     "caCertificate"?: string;
     "oauth"?: OAuthConfig;
-    "parameters"?: ({} & Record<string, UnsV2JSONValue>);
+    "parameters"?: Record<string, UnsV2JSONValue>;
     "port"?: UnsV2Integer;
+    "headers"?: ({} & Record<string, string>);
 };
 export type IndexSpec = ((({
     "kind"?: "btree" | "gin";
@@ -369,7 +370,7 @@ export type Schema = {
     "unit"?: string;
     "format"?: "int32" | "float" | "double" | "date-time";
 };
-export type SourceDefinition = {
+export type SourceDefinition = ({
     "credentialRef"?: string;
     "description"?: string;
     "endpoint": string;
@@ -383,7 +384,7 @@ export type SourceDefinition = {
     "role"?: "client" | "server";
     "runtimeLocation"?: "local";
     "sourceType"?: string;
-};
+});
 export type TransactionQueryResult = {
     "hasMore": boolean;
     "records": Array<RecordDocument>;
@@ -1233,24 +1234,183 @@ export type CloudSourceConfig = (({
         "caRef"?: string;
         "clientIdentityRef"?: string;
     });
+    "role"?: "client" | "server";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "serverName"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "pi-web-api";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "pcn"?: string;
+            "tenantId"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "plex-mes";
 }) | ({
     "auth": ({
         "credentialRef": string;
-        "kind": "vendorBasic";
+        "kind": "vendorNative";
     });
     "configVersion": 3;
     "endpoint": string;
     "options": ({
         "headers"?: ({} & Record<string, string>);
+        "parameters"?: {};
     });
+    "role"?: "client";
+    "sourceType": "wms-rest";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative" | "vendorBasic";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "client"?: string;
+        });
+    });
+    "role"?: "client";
     "sourceType": "sap-odata";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "orgId"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "yonyou-yonbip";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "domain"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "kingdee-jdy";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "redirectUri"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "ngp";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters": ({
+            "acctId": (string);
+            "appId"?: string;
+            "lcid": (string);
+            "user": (string);
+        });
+    });
+    "role"?: "client";
+    "sourceType": "kingdee-k3cloud";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters": ({
+            "apiVersion"?: string;
+            "clientId": (string);
+            "scopes"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "salesforce";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: ({
+            "group"?: string;
+            "locale"?: string;
+            "role"?: string;
+        });
+    });
+    "role"?: "client";
+    "sourceType": "teamcenter";
+}) | ({
+    "auth": ({
+        "credentialRef": string;
+        "kind": "vendorNative";
+    });
+    "configVersion": 3;
+    "endpoint": string;
+    "options": ({
+        "headers"?: ({} & Record<string, string>);
+        "parameters"?: {};
+    });
+    "role"?: "client";
+    "sourceType": "hikvision-isapi";
 }));
-export type CloudSourceDocument = {
+export type CloudSourceDocument = ({
     "name": string;
     "description"?: string;
-    "protocol": "http" | "modbus" | "mqtt" | "opcua" | "sap" | "teamcenter" | "mqtt_device" | "http_push" | "sql";
+    "protocol": "http-api" | "modbus" | "mqtt" | "opcua" | "sap" | "teamcenter" | "mqtt_device" | "http_push" | "sql";
     "config": CloudSourceConfig;
-};
+});
 export type CloudControlDefinition = {
     "code": string;
     "name": string;
@@ -1509,7 +1669,7 @@ export type CloudSourceDocumentListReq = {
     "page"?: UnsV2Integer;
     "size"?: UnsV2Integer;
     "search"?: string;
-    "protocol"?: "http" | "modbus" | "mqtt" | "opcua" | "sap" | "teamcenter" | "mqtt_device" | "http_push" | "sql";
+    "protocol"?: "http-api" | "modbus" | "mqtt" | "opcua" | "sap" | "teamcenter" | "mqtt_device" | "http_push" | "sql";
     "desiredState"?: "enabled" | "disabled";
     "health"?: string;
     "archived"?: boolean;
@@ -2151,7 +2311,7 @@ export type CloudSourceDiscoverResponse = {
     "data": ({
         "id": string;
         "revision": UnsV2Integer;
-        "sourceType": "sap-odata";
+        "sourceType": "pi-web-api" | "plex-mes" | "wms-rest" | "sap-odata" | "yonyou-yonbip" | "kingdee-jdy" | "ngp" | "kingdee-k3cloud" | "salesforce" | "teamcenter" | "hikvision-isapi";
         "resources": (Array<({
             "ref": string;
             "name": string;
@@ -2450,8 +2610,8 @@ export type CloudStreamProgramView = {
     } & Record<string, UnsV2JSONValue>);
 } & Record<string, UnsV2JSONValue>;
 export type CloudSourceCreateCredentials = ({
-    "method": string;
-    "kind": "basic" | "bearer" | "oauth2ClientCredentials";
+    "method"?: "GET" | "HEAD" | "POST" | "PUT" | "PATCH" | "DELETE" | "OPTIONS" | "REQUEST";
+    "kind": "basic" | "bearer" | "apiKey" | "oauth2ClientCredentials";
     "material": {};
 }) & (({
     "kind"?: "basic";
@@ -2464,14 +2624,22 @@ export type CloudSourceCreateCredentials = ({
     "material"?: ({
         "token": string;
     });
+}) | ({
+    "kind"?: "apiKey";
+    "method"?: "REQUEST";
+    "material"?: ({
+        "headerName": string;
+        "value": string;
+    });
 }) | ({
     "kind"?: "oauth2ClientCredentials";
-    "method"?: "GET";
+    "method"?: "GET" | "REQUEST";
     "material"?: ({
         "tokenUrl": string;
         "clientId": string;
         "clientSecret": string;
         "scope"?: string;
+        "clientAuthentication"?: "client_secret_post" | "client_secret_basic";
     });
 }));
 export type UnsV2MetadataFindReq = ((({
@@ -4654,6 +4822,9 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
             readonly port: {
                 readonly k: "j";
             };
+            readonly headers: {
+                readonly k: "o";
+            };
         };
     };
     readonly IndexSpec: {
@@ -4881,24 +5052,8 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
         };
     };
     readonly SourceDefinition: {
-        readonly k: "o";
-        readonly p: {
-            readonly extensions: {
-                readonly k: "o";
-            };
-            readonly http: {
-                readonly r: "HTTPConnection";
-            };
-            readonly modbus: {
-                readonly r: "ModbusOptions";
-            };
-            readonly mqtt: {
-                readonly r: "MQTTOptions";
-            };
-            readonly opcua: {
-                readonly r: "OPCUAOptions";
-            };
-        };
+        readonly k: "u";
+        readonly a: readonly [];
     };
     readonly TransactionQueryResult: {
         readonly k: "o";
@@ -6548,18 +6703,247 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
                         readonly headers: {
                             readonly k: "o";
                         };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                            readonly p: {
+                                readonly acctId: {
+                                    readonly k: "u";
+                                    readonly a: readonly [];
+                                };
+                                readonly lcid: {
+                                    readonly k: "u";
+                                    readonly a: readonly [];
+                                };
+                                readonly user: {
+                                    readonly k: "u";
+                                    readonly a: readonly [];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                            readonly p: {
+                                readonly clientId: {
+                                    readonly k: "u";
+                                    readonly a: readonly [];
+                                };
+                            };
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
+                    };
+                };
+            };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly auth: {
+                    readonly k: "o";
+                };
+                readonly configVersion: {
+                    readonly k: "j";
+                };
+                readonly options: {
+                    readonly k: "o";
+                    readonly p: {
+                        readonly headers: {
+                            readonly k: "o";
+                        };
+                        readonly parameters: {
+                            readonly k: "o";
+                        };
                     };
                 };
             };
         }];
     };
     readonly CloudSourceDocument: {
-        readonly k: "o";
-        readonly p: {
-            readonly config: {
-                readonly r: "CloudSourceConfig";
-            };
-        };
+        readonly k: "u";
+        readonly a: readonly [];
     };
     readonly CloudControlDefinition: {
         readonly k: "o";
@@ -6870,6 +7254,11 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
                 readonly p: {
                     readonly document: {
                         readonly k: "o";
+                        readonly p: {
+                            readonly config: {
+                                readonly k: "o";
+                            };
+                        };
                     };
                 };
             }];
@@ -8614,6 +9003,13 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
                     readonly k: "o";
                 };
             };
+        }, {
+            readonly k: "o";
+            readonly p: {
+                readonly material: {
+                    readonly k: "o";
+                };
+            };
         }];
     };
     readonly UnsV2MetadataFindReq: {
@@ -9495,11 +9891,11 @@ export declare const UNS_V2_CODEC_SCHEMAS: {
 };
 export declare const UNS_V2_CONTRACT_PROVENANCE: {
     readonly repository: "FREEZONEX/Tier0-Backend";
-    readonly revision: "6cb53b80eeffd707df0a8a7698bcc02022580617";
+    readonly revision: "86bef2325253c2f4eaab8168f983ac4ec09c0d2f";
     readonly version: "5.0.0";
     readonly source: "service/unssvr/internal/domain/unsv2/contract_generated.go#ContractJSON";
-    readonly cloudRevision: "6cb53b80eeffd707df0a8a7698bcc02022580617";
-    readonly cloudContractRevision: "cloud-source-impact/2+source-vendor/1+app-create-capability/1+data/3+record-reads/1+stream-receipt/1+collection-namespace/1+http-acquisition/2+app-collection/2+collection-ownership/1+metadata/1+app-context/2+collection-ttl/1+error-model/1+crud-consolidation/1+record-insert-return/1+lifecycle-consolidation/1+api-surface/2+app-data/2+hosted-control/1+source-bindings/1+record-notifications/1+record-delete-samples/1+stream-history/1+app-collections/1+http-in/1+app-resource-access/2+stream-control-probe-retirement/1";
+    readonly cloudRevision: "86bef2325253c2f4eaab8168f983ac4ec09c0d2f";
+    readonly cloudContractRevision: "cloud-source-impact/2+source-vendor/2+app-create-capability/1+data/3+record-reads/1+stream-receipt/1+collection-namespace/1+http-acquisition/2+http-source-role/1+http-source-request/1+app-collection/2+collection-ownership/1+metadata/1+app-context/2+collection-ttl/1+error-model/1+crud-consolidation/1+record-insert-return/1+lifecycle-consolidation/1+api-surface/2+app-data/2+hosted-control/1+source-bindings/1+record-notifications/1+record-delete-samples/1+stream-history/1+app-collections/1+http-in/1+app-resource-access/2+stream-control-probe-retirement/1";
     readonly resolvedCloudContract: true;
     readonly enterpriseBase: {
         readonly repository: "FREEZONEX/Tier0-Enterprise-New";
@@ -9508,12 +9904,12 @@ export declare const UNS_V2_CONTRACT_PROVENANCE: {
         readonly source: "backend/internal/domain/unsv2/contract_generated.go";
         readonly note: "Reviewed Enterprise wire contract imported as editable Cloud contract source; regenerate all adapters with scripts/generate-uns-v2.mjs.";
     };
-    readonly sourceDerivedContractSHA256: "cdf0fc7c8bb3849734919cc098e8df712d0e7c20bd0c29749b3c88cae5be9a90";
+    readonly sourceDerivedContractSHA256: "c93d1cd69d465fc56af2e1ff5d1896e61dc53a7ffb4ec1a43e7a654c5cf943af";
     readonly hashes: {
-        readonly contract: "cdf0fc7c8bb3849734919cc098e8df712d0e7c20bd0c29749b3c88cae5be9a90";
+        readonly contract: "c93d1cd69d465fc56af2e1ff5d1896e61dc53a7ffb4ec1a43e7a654c5cf943af";
         readonly cloudSupport: "23e5680ec2c4f645067789e366d783961817bbb7438a3aa98099fd5314e6a35f";
-        readonly manifest: "06b0f034ab4b25ed534501970df7599824dc5bf5828678f80f75bdaf8e47ddbd";
-        readonly provenance: "0feb11af91aa2dabfdc3b98790551ac81dbc26820d89f2aa36b829a3ca748f9d";
+        readonly manifest: "490ad0e26237b9d24ab6491a23ac0c663c0d532059e3bf9f5f140938fdbbb980";
+        readonly provenance: "4c9b8b13f4e13a3422284a7712b68024382f267a1166da22e25a783342e3f0b4";
         readonly registry: "62dd03cf1240dddf40dfb663c1f4e742d25d8b1d78f349927a2120656c7ed24d";
     };
     readonly publicOperationCount: 85;