@smarthome.exchange/api 0.1.0 → 1.0.1

package/changelog.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 2026-10-12 - 1.0.1
+
+### Fixes
+
+- Consume interfaces 2.1.0 so authenticated inventory and snapshot return types include native TCP devices.
+
+### Maintenance
+
+- release tooling: pnpm 12.9.1
+
+## 2026-10-06 - 1.0.0
+
+### Features
+
+- Expose cancellable snapshot watcher lifetimes and deadlines, abort and drain active polls on stop, and suppress late credentials after request cancellation.
+
+- Authenticate each HTTP request and physical Node socket connection, preserve cancellation and stop ownership, and reject unsupported browser socket headers explicitly.
+
+### Maintenance
+
+- Update the release test runner to tstest 7.2.0 and strengthen generated integrity records while retaining eligible pnpm and Node type pins.
+
+### Breaking Changes
+
+- Require an explicit home and asynchronous authorization provider; consume the matching TypedRequest 9 and TypedSocket 9 graph.
+
+### Fixes
+
+- Track a root-only pnpm workspace policy that approves esbuild and denies unused Puppeteer and sharp dependency builds.
+
+- update development tooling and release preflight configuration (tooling)
+  - Upgrade GitZone development tools, TypeScript test/build tooling, and Node typings
+  - Update package manager to pnpm 12.8.1
+  - Remove clean tree requirement from release preflight checks
+
 ## 2026-08-10 - 0.1.0
 
 ### Features

package/dist_ts/00_commitinfo_data.js

@@ -3,7 +3,7 @@
  */
 export const commitinfo = {
     name: '@smarthome.exchange/api',
-    version: '0.1.0',
+    version: '1.0.1',
     description: 'Typed API client for smarthome.exchange hubs.'
 };
 //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiMDBfY29tbWl0aW5mb19kYXRhLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vdHMvMDBfY29tbWl0aW5mb19kYXRhLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBOztHQUVHO0FBQ0gsTUFBTSxDQUFDLE1BQU0sVUFBVSxHQUFHO0lBQ3hCLElBQUksRUFBRSx5QkFBeUI7SUFDL0IsT0FBTyxFQUFFLE9BQU87SUFDaEIsV0FBVyxFQUFFLCtDQUErQztDQUM3RCxDQUFBIn0=

package/dist_ts/classes.smarthomeexchangeapiclient.d.ts

@@ -1,8 +1,38 @@
 import * as plugins from './plugins.js';
 export interface IShxApiClientOptions {
     hubUrl?: string;
+    homeId: string;
+    authorizationHeaderProvider: TShxAuthorizationHeaderProvider;
+    socketConnectionPreparationTimeoutMs?: number;
 }
+export interface IShxAuthorizationContext {
+    readonly homeId: string;
+    readonly endpoint: string;
+    readonly transport: 'http';
+    readonly method: plugins.shxInterfaces.request.IReq_ListDevices['method'] | plugins.shxInterfaces.request.IReq_ListAgents['method'] | plugins.shxInterfaces.request.IReq_ListTools['method'] | plugins.shxInterfaces.request.IReq_GetHomeSnapshot['method'] | plugins.shxInterfaces.request.IReq_ExecuteToolPlan['method'] | plugins.shxInterfaces.request.IReq_ListApprovals['method'] | plugins.shxInterfaces.request.IReq_SubmitApproval['method'];
+    readonly abortSignal?: AbortSignal;
+}
+export interface IShxSocketAuthorizationContext extends Omit<IShxAuthorizationContext, 'method' | 'transport' | 'abortSignal'> {
+    readonly method: 'connect';
+    readonly transport: 'websocket';
+    readonly abortSignal: AbortSignal;
+    readonly attempt: number;
+    readonly deadline: number;
+}
+export type TShxAuthorizationContext = IShxAuthorizationContext | IShxSocketAuthorizationContext;
+export type TShxAuthorizationHeaderProvider = (contextArg: TShxAuthorizationContext) => Promise<string>;
+export interface IShxApiRequestOptions {
+    abortSignal?: AbortSignal;
+    timeoutMs?: number;
+    useCache?: boolean;
+}
+export type TListDevicesRequest = Omit<plugins.shxInterfaces.request.IReq_ListDevices['request'], 'context'>;
+export type TListToolsRequest = Omit<plugins.shxInterfaces.request.IReq_ListTools['request'], 'context'>;
+export type TListApprovalsRequest = Omit<plugins.shxInterfaces.request.IReq_ListApprovals['request'], 'context'>;
+export type TSubmitApprovalRequest = Omit<plugins.shxInterfaces.request.IReq_SubmitApproval['request'], 'context'>;
 export interface IHomeSnapshotWatchOptions {
+    abortSignal?: AbortSignal;
+    timeoutMs?: number;
     intervalMs?: number;
     immediate?: boolean;
     onError?: (errorArg: unknown) => void | Promise<void>;
@@ -10,36 +40,49 @@ export interface IHomeSnapshotWatchOptions {
 export type THomeSnapshotWatchCallback = (snapshotResponseArg: plugins.shxInterfaces.request.IReq_GetHomeSnapshot['response']) => void | Promise<void>;
 export type THomeSnapshotWatchStop = () => Promise<void>;
 export declare class SmarthomeExchangeApiClient {
-    private hubUrl;
-    typedrouter: plugins.typedrequest.TypedRouter<plugins.typedRequestInterfaces.ITypedRequest>;
-    typedsocketClient?: plugins.typedsocket.TypedSocket;
-    constructor(optionsArg?: IShxApiClientOptions);
-    private get httpEndpoint();
-    private createWsRequest;
+    #private;
+    private lifecycleTail;
+    private lifecycleOperationCount;
+    private queuedLifecycleOperation?;
+    private stopIntentGeneration;
+    private pendingStartAbortController?;
+    private socketPendingStop?;
+    private socketNeedsCleanup;
+    readonly typedrouter: plugins.typedrequest.TypedRouter<plugins.typedRequestInterfaces.ITypedRequest>;
+    constructor(optionsArg: IShxApiClientOptions);
+    get homeId(): string;
+    get typedsocketClient(): plugins.typedsocket.TypedSocket | undefined;
     private createHttpRequest;
+    private captureRequestOptions;
     private fire;
+    private getAuthorization;
+    private prepareSocketConnection;
+    private prepareRequest;
+    private assertJsonData;
+    private assertKnownProperties;
+    private queueLifecycleOperation;
     start(): Promise<void>;
     stop(): Promise<void>;
-    listDevices(requestArg?: plugins.shxInterfaces.request.IReq_ListDevices['request']): Promise<{
+    listDevices(requestArg?: TListDevicesRequest, optionsArg?: IShxApiRequestOptions): Promise<{
         devices: plugins.shxInterfaces.data.IDeviceDefinition[];
     }>;
-    listAgents(): Promise<{
+    listAgents(optionsArg?: IShxApiRequestOptions): Promise<{
         agents: plugins.shxInterfaces.data.IAgentDefinition[];
         statuses: plugins.shxInterfaces.data.IAgentStatus[];
     }>;
-    listTools(requestArg?: plugins.shxInterfaces.request.IReq_ListTools['request']): Promise<{
+    listTools(requestArg?: TListToolsRequest, optionsArg?: IShxApiRequestOptions): Promise<{
         tools: plugins.shxInterfaces.data.IToolDefinition[];
     }>;
-    getHomeSnapshot(): Promise<{
+    getHomeSnapshot(optionsArg?: IShxApiRequestOptions): Promise<{
         availability: plugins.shxInterfaces.data.THomeSnapshotAvailability;
         snapshot: plugins.shxInterfaces.data.IHomeSnapshot;
     }>;
     watchHomeSnapshot(callbackArg: THomeSnapshotWatchCallback, optionsArg?: IHomeSnapshotWatchOptions): THomeSnapshotWatchStop;
-    executeToolPlan(planArg: plugins.shxInterfaces.data.IToolPlan): Promise<plugins.shxInterfaces.data.IToolPlanResult>;
-    listApprovals(requestArg?: plugins.shxInterfaces.request.IReq_ListApprovals['request']): Promise<{
+    executeToolPlan(planArg: plugins.shxInterfaces.data.IToolPlan, optionsArg?: IShxApiRequestOptions): Promise<plugins.shxInterfaces.data.IToolPlanResult>;
+    listApprovals(requestArg?: TListApprovalsRequest, optionsArg?: IShxApiRequestOptions): Promise<{
         approvals: plugins.shxInterfaces.data.IApprovalRequest[];
     }>;
-    submitApproval(requestArg: plugins.shxInterfaces.request.IReq_SubmitApproval['request']): Promise<{
+    submitApproval(requestArg: TSubmitApprovalRequest, optionsArg?: IShxApiRequestOptions): Promise<{
         approval: plugins.shxInterfaces.data.IApprovalRequest;
         receipt: plugins.shxInterfaces.data.IAuditReceipt;
     }>;