@harborclient/sdk 1.0.44 → 1.0.46

package/dist/snippets.d.ts

@@ -4,8 +4,16 @@
  * Keep in sync with the runtime hc sandbox in harborclient
  * `src/main/scripting/scriptApi.ts` and editor completions in
  * `src/renderer/src/scripting/hcCompletions.ts`.
+ *
+ * `hc.expect` is Chai BDD expect — see https://www.chaijs.com/api/bdd/
+ * `hc.response.to` provides Postman-style response matchers.
  */
 
+/// <reference types="chai" />
+
+/** Chai BDD expect factory type for hc.expect. */
+type HcExpectStatic = typeof import('chai').expect;
+
 /**
  * Header helpers on hc.request.headers and hc.collection.headers.
  */
@@ -217,20 +225,6 @@ interface HcSendRequestResponse {
   json(): unknown;
 }
 
-/**
- * Chai-lite matcher returned by hc.expect(actual).
- */
-interface HcExpectMatcher {
-  to: {
-    equal(expected: unknown): void;
-    eql(expected: unknown): void;
-    include(substr: string): void;
-    be: {
-      ok(): void;
-    };
-  };
-}
-
 /**
  * Element surface exposed by hc.response.document() for HTML bodies.
  */
@@ -248,6 +242,48 @@ interface HcResponseDocument {
   querySelectorAll(selector: string): HcResponseElement[];
 }
 
+/**
+ * Response snapshot available in post-request scripts as hc.response.
+ */
+interface HcResponseAssertionHave {
+  status(codeOrText: number | string): void;
+  header(name: string): void;
+  header(name: string, value: string): void;
+  body(): void;
+  body(expected: string | RegExp): void;
+  jsonBody(): void;
+  jsonBody(expected: object): void;
+}
+
+/**
+ * Status-class and body shortcuts on hc.response.to.be.*.
+ */
+interface HcResponseAssertionBe {
+  readonly success: void;
+  readonly redirection: void;
+  readonly clientError: void;
+  readonly serverError: void;
+  readonly error: void;
+  readonly ok: void;
+  readonly accepted: void;
+  readonly badRequest: void;
+  readonly unauthorized: void;
+  readonly forbidden: void;
+  readonly notFound: void;
+  readonly rateLimited: void;
+  readonly json: void;
+  readonly withBody: void;
+}
+
+/**
+ * Chai assertion chain for Postman-style hc.response.to.* matchers.
+ */
+interface HcResponseAssertion {
+  readonly have: HcResponseAssertionHave;
+  readonly be: HcResponseAssertionBe;
+  readonly not: HcResponseAssertion;
+}
+
 /**
  * Response snapshot available in post-request scripts as hc.response.
  */
@@ -256,6 +292,8 @@ interface HcResponseApi {
   readonly status: string;
   readonly headers: Record<string, string>;
   readonly responseTime: number;
+  /** Postman-style response assertions (hc.response.to.have.status(200), etc.). */
+  readonly to: HcResponseAssertion;
   text(): string;
   json(): unknown;
   document(): HcResponseDocument;
@@ -297,7 +335,8 @@ interface HcScriptApi {
    */
   sendRequest(req: HcSendRequestInput): Promise<HcSendRequestResponse>;
   test(name: string, fn: () => void): void;
-  expect(actual: unknown): HcExpectMatcher;
+  /** Chai BDD expect; see https://www.chaijs.com/api/bdd/ */
+  expect: HcExpectStatic;
   /**
    * Available in post-request scripts after the primary request completes.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harborclient/sdk",
-  "version": "1.0.44",
+  "version": "1.0.46",
   "description": "TypeScript SDK for HarborClient development.",
   "keywords": [
     "harborclient",
@@ -200,6 +200,7 @@
     "@storybook/react-vite": "^10.4.6",
     "@tailwindcss/vite": "^4.3.1",
     "@trivago/prettier-plugin-sort-imports": "^6.0.2",
+    "@types/chai": "^4.3.20",
     "@types/node": "^26.0.1",
     "@types/react": "^19.1.2",
     "@types/react-dom": "^19.1.2",