@kmlckj/licos-platform-sdk 0.8.2 → 0.8.5

package/README.md

@@ -94,7 +94,7 @@ const file = await storage.uploadFile('/tmp/report.pdf');
 const link = await storage.shareUrl(file.id);
 ```
 
-`uploadFile` limits each file to 100 MiB. Payloads larger than 8 MiB automatically use the platform chunk-upload protocol.
+`uploadFile` limits each file to 100 MiB. Payloads larger than 8 MiB automatically use the platform chunk-upload protocol.
 
 The browser entry does not export object storage helpers because runtime tokens
 must not be bundled into public frontend code.
@@ -122,6 +122,54 @@ const results = await knowledge.search('How do I reset my password?', {
 The browser entry does not export knowledge helpers because runtime tokens must
 not be bundled into public frontend code.
 
+## Unified Namespace (UNS)
+
+UNS helpers expose the same Schema, resource discovery, validation, plan,
+apply, binding, data, point, video, and enterprise path APIs as the Python
+platform SDK. They are server-only and derive the trusted project scope from
+the injected runtime identity.
+
+```js
+import { uns } from '@kmlckj/licos-platform-sdk';
+
+const schema = await uns.schemaCurrent();
+const checked = await uns.validate(document);
+const reviewedPlan = await uns.plan(document);
+
+await uns.apply(document, {
+  expectedDocumentHash: reviewedPlan.documentHash,
+  expectedPlanHash: reviewedPlan.planHash,
+  confirmed: true,
+});
+```
+
+Use a `UNSChangeSet` for an isolated structural change. Review the dedicated
+plan and pass both hashes back unchanged. Destructive or replacement actions
+also require `impactConfirmed: true`.
+
+```js
+const changes = await uns.planChanges(changeSet);
+await uns.applyChanges(changeSet, {
+  expectedDocumentHash: changes.documentHash,
+  expectedPlanHash: changes.planHash,
+  confirmed: true,
+  impactConfirmed: true,
+});
+```
+
+Use `uns.openPath(path)` when business code targets an existing enterprise UNS
+path without creating or changing `UNS.json`:
+
+```js
+const temperature = uns.openPath('project:/production-line/temperature');
+const current = await temperature.pointCurrent();
+```
+
+Resource apply, data writes, point writes, and video controls require explicit
+confirmation. Data deletion accepts the exact rows returned by a prior query
+and also requires explicit confirmation. Point writes require a reason and ticket. The browser entry
+does not export UNS helpers.
+
 ## OAuth2 Application Management
 
 OAuth2 management is available only from trusted Node runtime code. It uses the

package/dist/index.d.ts

@@ -28,6 +28,8 @@ export interface RuntimeConfig {
 export function runtimeConfig(options?: { environmentOverrideEnv?: string }): Promise<RuntimeConfig>;
 export function authHeaders(config: RuntimeConfig, contentType?: string): Record<string, string>;
 
+export * from './uns.js';
+
 export type OAuthLoginAudience = 'ALL' | 'OWNER_TENANT';
 
 export interface OAuthRedirectUriConfig {

package/dist/index.js

@@ -1 +1 @@
-export{PlatformSdkError,ConfigurationError,ApiError}from"./shared.js";export{runtimeConfig,authHeaders}from"./runtime.js";export*from"./database.js";export*from"./knowledge.js";export*from"./oauth.js";export*from"./oauth-runtime.js";export*from"./storage.js";export{studioDatabase}from"./studio-database.js";
+export{PlatformSdkError,ConfigurationError,ApiError}from"./shared.js";export{runtimeConfig,authHeaders}from"./runtime.js";export*from"./database.js";export*from"./knowledge.js";export*from"./oauth.js";export*from"./oauth-runtime.js";export*from"./storage.js";export*from"./uns.js";export{studioDatabase}from"./studio-database.js";

package/dist/uns.d.ts

@@ -0,0 +1,152 @@
+export type UnsObject = Record<string, unknown>;
+
+export interface UnsDataQueryOptions {
+  pageNum?: number;
+  page_num?: number;
+  pageSize?: number;
+  page_size?: number;
+  paginationMode?: string;
+  pagination_mode?: string;
+  pageToken?: string;
+  page_token?: string;
+}
+
+export interface UnsPointHistoryOptions {
+  startTime?: string;
+  start_time?: string;
+  endTime?: string;
+  end_time?: string;
+  page?: number;
+  pageSize?: number;
+  page_size?: number;
+}
+
+export interface UnsPointWriteOptions {
+  reason: string;
+  ticket: string;
+  requestId?: string;
+  request_id?: string;
+  dryRun?: boolean;
+  dry_run?: boolean;
+  confirmed?: boolean;
+}
+
+export interface UnsVideoControlOptions {
+  parameters?: UnsObject;
+  confirmed: boolean;
+}
+
+export function getCurrentUnsSchema(): Promise<UnsObject>;
+export function getUnsSchema(version?: string): Promise<UnsObject>;
+export function listUnsSchemaBlocks(version?: string): Promise<UnsObject[]>;
+export function getUnsSchemaBlock(blockCode: string, options?: { version?: string; depth?: number }): Promise<UnsObject>;
+export function getUnsProtocolSchema(protocol: string, options?: { version?: string }): Promise<UnsObject>;
+export function discoverUnsResources(options?: { resourceTypes?: string[]; protocols?: string[] }): Promise<UnsObject>;
+export function searchUnsResources(
+  resourceType: string,
+  options?: { protocol?: string; keyword?: string; selector?: UnsObject; page?: number; pageSize?: number; page_size?: number },
+): Promise<UnsObject>;
+export function listUnsBindings(): Promise<UnsObject[]>;
+export function resolveUnsPath(path: string): Promise<UnsObject>;
+export function validateUnsDocument(document: UnsObject): Promise<UnsObject>;
+export function planUnsDocument(document: UnsObject): Promise<UnsObject>;
+export function applyUnsDocument(
+  document: UnsObject,
+  options: {
+    expectedDocumentHash?: string;
+    expected_document_hash?: string;
+    expectedPlanHash?: string;
+    expected_plan_hash?: string;
+    confirmed: boolean;
+  },
+): Promise<UnsObject>;
+export function validateUnsChanges(document: UnsObject): Promise<UnsObject>;
+export function planUnsChanges(document: UnsObject): Promise<UnsObject>;
+export function applyUnsChanges(
+  document: UnsObject,
+  options: {
+    expectedDocumentHash?: string;
+    expected_document_hash?: string;
+    expectedPlanHash?: string;
+    expected_plan_hash?: string;
+    confirmed: boolean;
+    impactConfirmed?: boolean;
+    impact_confirmed?: boolean;
+  },
+): Promise<UnsObject>;
+export function queryUnsNodeData(nodeCode: string, options?: UnsDataQueryOptions): Promise<UnsObject>;
+export function writeUnsNodeData(
+  nodeCode: string,
+  fieldValues: UnsObject,
+  options: { confirmed: boolean },
+): Promise<UnsObject>;
+export function deleteUnsNodeData(nodeCode: string, rows: UnsObject[], options: { confirmed: boolean }): Promise<UnsObject>;
+export function queryUnsPathData(path: string, options?: UnsDataQueryOptions): Promise<UnsObject>;
+export function writeUnsPathData(path: string, fieldValues: UnsObject, options: { confirmed: boolean }): Promise<UnsObject>;
+export function deleteUnsPathData(path: string, rows: UnsObject[], options: { confirmed: boolean }): Promise<UnsObject>;
+export function getUnsPointCurrent(nodeCode: string): Promise<UnsObject>;
+export function getUnsPathPointCurrent(path: string): Promise<UnsObject>;
+export function getUnsPointHistory(nodeCode: string, options: UnsPointHistoryOptions): Promise<UnsObject>;
+export function getUnsPathPointHistory(path: string, options: UnsPointHistoryOptions): Promise<UnsObject>;
+export function writeUnsPoint(nodeCode: string, value: unknown, options: UnsPointWriteOptions): Promise<UnsObject>;
+export function writeUnsPathPoint(path: string, value: unknown, options: UnsPointWriteOptions): Promise<UnsObject>;
+export function getUnsVideoStreamOptions(nodeCode: string): Promise<UnsObject>;
+export function getUnsPathVideoStreamOptions(path: string): Promise<UnsObject>;
+export function createUnsVideoSnapshot(nodeCode: string): Promise<UnsObject>;
+export function createUnsPathVideoSnapshot(path: string): Promise<UnsObject>;
+export function controlUnsVideo(nodeCode: string, action: string, options: UnsVideoControlOptions): Promise<UnsObject>;
+export function controlUnsPathVideo(path: string, action: string, options: UnsVideoControlOptions): Promise<UnsObject>;
+
+export class UnsPathNode {
+  readonly path: string;
+  constructor(path: string);
+  resolve(): Promise<UnsObject>;
+  queryData(options?: UnsDataQueryOptions): Promise<UnsObject>;
+  writeData(fieldValues: UnsObject, options: { confirmed: boolean }): Promise<UnsObject>;
+  deleteData(rows: UnsObject[], options: { confirmed: boolean }): Promise<UnsObject>;
+  pointCurrent(): Promise<UnsObject>;
+  pointHistory(options: UnsPointHistoryOptions): Promise<UnsObject>;
+  writePoint(value: unknown, options: UnsPointWriteOptions): Promise<UnsObject>;
+  videoStreamOptions(): Promise<UnsObject>;
+  videoSnapshot(): Promise<UnsObject>;
+  controlVideo(action: string, options: UnsVideoControlOptions): Promise<UnsObject>;
+}
+
+export function openUnsPath(path: string): UnsPathNode;
+
+export const uns: {
+  schemaCurrent: typeof getCurrentUnsSchema;
+  schema: typeof getUnsSchema;
+  schemaBlocks: typeof listUnsSchemaBlocks;
+  schemaBlock: typeof getUnsSchemaBlock;
+  protocolSchema: typeof getUnsProtocolSchema;
+  discover: typeof discoverUnsResources;
+  searchResources: typeof searchUnsResources;
+  bindings: typeof listUnsBindings;
+  resolvePath: typeof resolveUnsPath;
+  validate: typeof validateUnsDocument;
+  plan: typeof planUnsDocument;
+  apply: typeof applyUnsDocument;
+  validateChanges: typeof validateUnsChanges;
+  planChanges: typeof planUnsChanges;
+  applyChanges: typeof applyUnsChanges;
+  queryNodeData: typeof queryUnsNodeData;
+  writeNodeData: typeof writeUnsNodeData;
+  deleteNodeData: typeof deleteUnsNodeData;
+  queryPathData: typeof queryUnsPathData;
+  writePathData: typeof writeUnsPathData;
+  deletePathData: typeof deleteUnsPathData;
+  pointCurrent: typeof getUnsPointCurrent;
+  pathPointCurrent: typeof getUnsPathPointCurrent;
+  pointHistory: typeof getUnsPointHistory;
+  pathPointHistory: typeof getUnsPathPointHistory;
+  writePoint: typeof writeUnsPoint;
+  writePathPoint: typeof writeUnsPathPoint;
+  videoStreamOptions: typeof getUnsVideoStreamOptions;
+  pathVideoStreamOptions: typeof getUnsPathVideoStreamOptions;
+  videoSnapshot: typeof createUnsVideoSnapshot;
+  pathVideoSnapshot: typeof createUnsPathVideoSnapshot;
+  controlVideo: typeof controlUnsVideo;
+  controlPathVideo: typeof controlUnsPathVideo;
+  openPath: typeof openUnsPath;
+};

package/dist/uns.js

@@ -0,0 +1 @@
+import{ApiError as t}from"./shared.js";import{authHeaders as e,refreshRuntimeConfig as n,runtimeConfig as o,shouldRefreshUserToken as r}from"./runtime.js";function a(t){return Object.fromEntries(Object.entries(t).filter(([,t])=>null!=t))}function i(t,e){return`/projects/${encodeURIComponent(t.projectId)}${e}`}function s(t,e,n,o){return i(t,`/uns/runtime/${e}/${encodeURIComponent(n)}/${o}`)}function c(t,e,n){const o=String(n||"").trim();if(!o)throw new TypeError("UNS path cannot be empty");return`${i(t,`/uns/runtime/path/${e}`)}?${new URLSearchParams({path:o})}`}function p(t,e){return new URL(`${t.baseUrl}/api/v1${e}`)}async function u(e){const n=await e.text();let o=null;try{o=n?JSON.parse(n):null}catch{throw new t(n||`platform UNS API returned ${e.status}`,{status:e.status,details:n})}if(!e.ok)throw new t(o?.message||n||`platform UNS API returned ${e.status}`,{status:e.status,code:"number"==typeof o?.code?o.code:void 0,details:o});if(!o||"object"!=typeof o)return o;if(void 0!==o.code&&0!==o.code||!1===o.success)throw new t(o.message||"platform UNS API failed",{status:e.status,code:"number"==typeof o.code?o.code:void 0,details:o});return o.data}async function d(i,s,{body:c,config:d}={}){let h=d||await o();for(let t=0;t<2;t+=1)try{const t="function"==typeof s?s(h):s,n=await fetch(p(h,t),{method:i,headers:e(h,void 0===c?void 0:"application/json"),body:void 0===c?void 0:JSON.stringify(a(c))});return await u(n)}catch(e){if(0===t&&r(e)){h=await n(h);continue}throw e}throw new t("platform UNS API failed")}export function getCurrentUnsSchema(){return d("GET","/uns/schemas/current")}export function getUnsSchema(t="1.0"){return d("GET",`/uns/schemas/${encodeURIComponent(t)}`)}export function listUnsSchemaBlocks(t="1.0"){return d("GET",`/uns/schemas/${encodeURIComponent(t)}/blocks`)}export function getUnsSchemaBlock(t,{version:e="1.0",depth:n=1}={}){return d("GET",`/uns/schemas/${encodeURIComponent(e)}/blocks/${encodeURIComponent(t)}?depth=${encodeURIComponent(n)}`)}export function getUnsProtocolSchema(t,{version:e="1.0"}={}){return d("GET",`/uns/schemas/${encodeURIComponent(e)}/blocks/collection-point/protocols/${encodeURIComponent(t)}`)}export async function discoverUnsResources({resourceTypes:t=[],protocols:e=[]}={}){const n=await o();return d("POST",i(n,"/uns/discover"),{body:{resourceTypes:t,protocols:e},config:n})}export async function searchUnsResources(t,e={}){const n=await o();return d("POST",i(n,"/uns/resources/search"),{body:{resourceType:t,protocol:e.protocol,keyword:e.keyword,selector:e.selector||{},page:e.page??1,pageSize:e.pageSize??e.page_size??20},config:n})}export async function listUnsBindings(){const t=await o();return d("GET",i(t,"/uns/bindings"),{config:t})}export async function resolveUnsPath(t){const e=await o();return d("GET",c(e,"resolve",t),{config:e})}export async function validateUnsDocument(t){const e=await o();return d("POST",i(e,"/uns/validate"),{body:{document:t},config:e})}export async function planUnsDocument(t){const e=await o();return d("POST",i(e,"/uns/plan"),{body:{document:t},config:e})}export async function applyUnsDocument(t,e={}){const n=String(e.expectedDocumentHash??e.expected_document_hash??"").trim(),r=String(e.expectedPlanHash??e.expected_plan_hash??"").trim();if(!0!==e.confirmed)throw new TypeError("UNS apply requires explicit confirmation");if(!n||!r)throw new TypeError("UNS apply requires document and plan hashes");const a=await o();return d("POST",i(a,"/uns/apply"),{body:{document:t,expectedDocumentHash:n,expectedPlanHash:r,confirmed:!0},config:a})}export async function validateUnsChanges(t){const e=await o();return d("POST",i(e,"/uns/changes/validate"),{body:{document:t},config:e})}export async function planUnsChanges(t){const e=await o();return d("POST",i(e,"/uns/changes/plan"),{body:{document:t},config:e})}export async function applyUnsChanges(t,e={}){const n=String(e.expectedDocumentHash??e.expected_document_hash??"").trim(),r=String(e.expectedPlanHash??e.expected_plan_hash??"").trim();if(!0!==e.confirmed)throw new TypeError("UNS changes apply requires explicit confirmation");if(!n||!r)throw new TypeError("UNS changes apply requires document and plan hashes");const a=await o();return d("POST",i(a,"/uns/changes/apply"),{body:{document:t,expectedDocumentHash:n,expectedPlanHash:r,confirmed:!0,impactConfirmed:!0===e.impactConfirmed||!0===e.impact_confirmed},config:a})}function h(t={}){return a({pageNum:t.pageNum??t.page_num??1,pageSize:t.pageSize??t.page_size??50,paginationMode:t.paginationMode??t.pagination_mode??"OFFSET",pageToken:t.pageToken??t.page_token})}export async function queryUnsNodeData(t,e={}){const n=await o();return d("POST",s(n,"nodes",t,"query"),{body:h(e),config:n})}function f(t,e){if(!0!==e)throw new TypeError("UNS data write requires explicit confirmation");if(!t||"object"!=typeof t||0===Object.keys(t).length)throw new TypeError("UNS data write field values cannot be empty")}export async function writeUnsNodeData(t,e,{confirmed:n=!1}={}){f(e,n);const r=await o();return d("POST",s(r,"nodes",t,"write"),{body:{fieldValues:e,environment:r.environment,confirmed:!0},config:r})}function m(t,e){if(!0!==e)throw new TypeError("UNS data deletion requires explicit confirmation");if(!Array.isArray(t)||0===t.length||t.some(t=>!t||"object"!=typeof t||Array.isArray(t)||0===Object.keys(t).length))throw new TypeError("UNS data deletion rows cannot be empty")}export async function deleteUnsNodeData(t,e,{confirmed:n=!1}={}){m(e,n);const r=await o();return d("POST",s(r,"nodes",t,"delete"),{body:{rows:e,confirmed:!0},config:r})}export async function queryUnsPathData(t,e={}){const n=await o();return d("POST",c(n,"data/query",t),{body:h(e),config:n})}export async function writeUnsPathData(t,e,{confirmed:n=!1}={}){f(e,n);const r=await o();return d("POST",c(r,"data/write",t),{body:{fieldValues:e,environment:r.environment,confirmed:!0},config:r})}export async function deleteUnsPathData(t,e,{confirmed:n=!1}={}){m(e,n);const r=await o();return d("POST",c(r,"data/delete",t),{body:{rows:e,confirmed:!0},config:r})}export async function getUnsPointCurrent(t){const e=await o();return d("GET",s(e,"points",t,"current"),{config:e})}export async function getUnsPathPointCurrent(t){const e=await o();return d("GET",c(e,"point/current",t),{config:e})}function l(t={}){return{startTime:t.startTime??t.start_time,endTime:t.endTime??t.end_time,page:t.page??1,pageSize:t.pageSize??t.page_size??100}}export async function getUnsPointHistory(t,e){const n=await o();return d("POST",s(n,"points",t,"history"),{body:l(e),config:n})}export async function getUnsPathPointHistory(t,e){const n=await o();return d("POST",c(n,"point/history",t),{body:l(e),config:n})}function y(t,e={}){const n=String(e.reason||"").trim(),o=String(e.ticket||"").trim(),r=e.dryRun??e.dry_run??!1,i=e.confirmed??!1;if(!r&&!0!==i)throw new TypeError("UNS point write requires explicit confirmation");if(!n||!o)throw new TypeError("UNS point write requires reason and ticket");return a({value:t,reason:n,ticket:o,requestId:e.requestId??e.request_id,dryRun:r,confirmed:i})}export async function writeUnsPoint(t,e,n={}){const r=y(e,n),a=await o();return d("POST",s(a,"points",t,"write"),{body:r,config:a})}export async function writeUnsPathPoint(t,e,n={}){const r=y(e,n),a=await o();return d("POST",c(a,"point/write",t),{body:r,config:a})}export async function getUnsVideoStreamOptions(t){const e=await o();return d("GET",s(e,"videos",t,"stream-options"),{config:e})}export async function getUnsPathVideoStreamOptions(t){const e=await o();return d("GET",c(e,"video/stream-options",t),{config:e})}export async function createUnsVideoSnapshot(t){const e=await o();return d("POST",s(e,"videos",t,"snapshot"),{config:e})}export async function createUnsPathVideoSnapshot(t){const e=await o();return d("POST",c(e,"video/snapshot",t),{config:e})}function U(t,e={}){if(!0!==e.confirmed)throw new TypeError("UNS video control requires explicit confirmation");return{action:t,parameters:e.parameters||{},confirmed:!0}}export async function controlUnsVideo(t,e,n={}){const r=U(e,n),a=await o();return d("POST",s(a,"videos",t,"control"),{body:r,config:a})}export async function controlUnsPathVideo(t,e,n={}){const r=U(e,n),a=await o();return d("POST",c(a,"video/control",t),{body:r,config:a})}export class UnsPathNode{constructor(t){if(this.path=String(t||"").trim(),!this.path)throw new TypeError("UNS path cannot be empty")}resolve(){return resolveUnsPath(this.path)}queryData(t){return queryUnsPathData(this.path,t)}writeData(t,e){return writeUnsPathData(this.path,t,e)}deleteData(t,e){return deleteUnsPathData(this.path,t,e)}pointCurrent(){return getUnsPathPointCurrent(this.path)}pointHistory(t){return getUnsPathPointHistory(this.path,t)}writePoint(t,e){return writeUnsPathPoint(this.path,t,e)}videoStreamOptions(){return getUnsPathVideoStreamOptions(this.path)}videoSnapshot(){return createUnsPathVideoSnapshot(this.path)}controlVideo(t,e){return controlUnsPathVideo(this.path,t,e)}}export function openUnsPath(t){return new UnsPathNode(t)}export const uns={schemaCurrent:getCurrentUnsSchema,schema:getUnsSchema,schemaBlocks:listUnsSchemaBlocks,schemaBlock:getUnsSchemaBlock,protocolSchema:getUnsProtocolSchema,discover:discoverUnsResources,searchResources:searchUnsResources,bindings:listUnsBindings,resolvePath:resolveUnsPath,validate:validateUnsDocument,plan:planUnsDocument,apply:applyUnsDocument,validateChanges:validateUnsChanges,planChanges:planUnsChanges,applyChanges:applyUnsChanges,queryNodeData:queryUnsNodeData,writeNodeData:writeUnsNodeData,deleteNodeData:deleteUnsNodeData,queryPathData:queryUnsPathData,writePathData:writeUnsPathData,deletePathData:deleteUnsPathData,pointCurrent:getUnsPointCurrent,pathPointCurrent:getUnsPathPointCurrent,pointHistory:getUnsPointHistory,pathPointHistory:getUnsPathPointHistory,writePoint:writeUnsPoint,writePathPoint:writeUnsPathPoint,videoStreamOptions:getUnsVideoStreamOptions,pathVideoStreamOptions:getUnsPathVideoStreamOptions,videoSnapshot:createUnsVideoSnapshot,pathVideoSnapshot:createUnsPathVideoSnapshot,controlVideo:controlUnsVideo,controlPathVideo:controlUnsPathVideo,openPath:openUnsPath};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kmlckj/licos-platform-sdk",
-  "version": "0.8.2",
+  "version": "0.8.5",
   "description": "LICOS platform SDK package shell for browser and Node runtimes",
   "author": "kmlckj",
   "type": "module",