@harborclient/sdk 1.0.36 → 1.0.39

package/dist/signing/manifest.d.ts

@@ -6,11 +6,13 @@ export interface PluginManifestIdentity {
     version: string;
 }
 /**
- * Reads and validates plugin id and version from manifest.json.
+ * Reads and validates plugin id and version from manifest.json or snippets.json.
  *
- * @param pluginDir - Plugin root directory containing manifest.json.
+ * Prefers manifest.json when both files are present.
+ *
+ * @param pluginDir - Plugin or snippet bundle root directory.
  * @returns Parsed manifest identity fields.
- * @throws When manifest.json is missing, invalid JSON, or fails validation.
+ * @throws When neither manifest file exists or validation fails.
  */
 export declare function readPluginManifestIdentity(pluginDir: string): PluginManifestIdentity;
 //# sourceMappingURL=manifest.d.ts.map

package/dist/signing/manifest.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/signing/manifest.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAyBpF"}
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../../src/signing/manifest.ts"],"names":[],"mappings":"AAOA;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;CACjB;AAmCD;;;;;;;;GAQG;AACH,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,sBAAsB,CAcpF"}

package/dist/signing/manifest.js

@@ -1,15 +1,16 @@
-import { readFileSync } from 'node:fs';
+import { existsSync, readFileSync } from 'node:fs';
 import { join } from 'node:path';
 const PLUGIN_ID_PATTERN = /^[a-zA-Z][a-zA-Z0-9.-]*\.[a-zA-Z][a-zA-Z0-9.-]+$/;
+const PLUGIN_MANIFEST_FILENAME = 'manifest.json';
+const SNIPPET_MANIFEST_FILENAME = 'snippets.json';
 /**
- * Reads and validates plugin id and version from manifest.json.
+ * Parses and validates id and version from a manifest.json or snippets.json file.
  *
- * @param pluginDir - Plugin root directory containing manifest.json.
+ * @param manifestPath - Absolute path to the manifest file on disk.
  * @returns Parsed manifest identity fields.
- * @throws When manifest.json is missing, invalid JSON, or fails validation.
+ * @throws When the file is invalid JSON or fails validation.
  */
-export function readPluginManifestIdentity(pluginDir) {
-    const manifestPath = join(pluginDir, 'manifest.json');
+function parseManifestIdentityFile(manifestPath) {
     let raw;
     try {
         raw = JSON.parse(readFileSync(manifestPath, 'utf8'));
@@ -31,3 +32,23 @@ export function readPluginManifestIdentity(pluginDir) {
     }
     return { id, version };
 }
+/**
+ * Reads and validates plugin id and version from manifest.json or snippets.json.
+ *
+ * Prefers manifest.json when both files are present.
+ *
+ * @param pluginDir - Plugin or snippet bundle root directory.
+ * @returns Parsed manifest identity fields.
+ * @throws When neither manifest file exists or validation fails.
+ */
+export function readPluginManifestIdentity(pluginDir) {
+    const manifestPath = join(pluginDir, PLUGIN_MANIFEST_FILENAME);
+    if (existsSync(manifestPath)) {
+        return parseManifestIdentityFile(manifestPath);
+    }
+    const snippetsPath = join(pluginDir, SNIPPET_MANIFEST_FILENAME);
+    if (existsSync(snippetsPath)) {
+        return parseManifestIdentityFile(snippetsPath);
+    }
+    throw new Error(`Plugin or snippet manifest not found: expected ${PLUGIN_MANIFEST_FILENAME} or ${SNIPPET_MANIFEST_FILENAME} in ${pluginDir}`);
+}

package/dist/signing/testFixtures.d.ts

@@ -18,4 +18,13 @@ export declare function createTestPluginDir(pluginId?: string): {
     pluginDir: string;
     cleanup: () => void;
 };
+/**
+ * Creates a minimal snippet bundle directory suitable for signing tests.
+ *
+ * @param catalogId - Snippet bundle id from snippets.json.
+ */
+export declare function createTestSnippetDir(catalogId?: string): {
+    pluginDir: string;
+    cleanup: () => void;
+};
 //# sourceMappingURL=testFixtures.d.ts.map

package/dist/signing/testFixtures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"testFixtures.d.ts","sourceRoot":"","sources":["../../src/signing/testFixtures.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,eAAe,CASvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,SAA4B,GAAG;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CA0BA"}
+{"version":3,"file":"testFixtures.d.ts","sourceRoot":"","sources":["../../src/signing/testFixtures.ts"],"names":[],"mappings":"AAKA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,wBAAgB,qBAAqB,IAAI,eAAe,CASvD;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,QAAQ,SAA4B,GAAG;IACzE,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CA0BA;AAED;;;;GAIG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,SAA8B,GAAG;IAC7E,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB,CA4BA"}

package/dist/signing/testFixtures.js

@@ -39,3 +39,29 @@ export function createTestPluginDir(pluginId = 'com.example.test-plugin') {
         }
     };
 }
+/**
+ * Creates a minimal snippet bundle directory suitable for signing tests.
+ *
+ * @param catalogId - Snippet bundle id from snippets.json.
+ */
+export function createTestSnippetDir(catalogId = 'com.example.test-snippets') {
+    const pluginDir = mkdtempSync(join(tmpdir(), 'hc-snippet-sign-'));
+    mkdirSync(join(pluginDir, 'dist'), { recursive: true });
+    writeFileSync(join(pluginDir, 'snippets.json'), JSON.stringify({
+        id: catalogId,
+        name: 'Test Snippets',
+        version: '1.0.0',
+        summary: 'Test snippet bundle for signing.',
+        author: 'Example Inc.',
+        categories: ['testing'],
+        engines: { harborclient: '>=2.0.0' },
+        snippets: [{ name: 'Tester', where: 'post-request', file: 'dist/tester.js' }]
+    }, null, 2));
+    writeFileSync(join(pluginDir, 'dist', 'tester.js'), 'hc.test("ok", () => true);');
+    return {
+        pluginDir,
+        cleanup: () => {
+            rmSync(pluginDir, { recursive: true, force: true });
+        }
+    };
+}

package/dist/snippets.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Ambient globals for HarborClient request/post-request script snippets.
+ *
+ * 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`.
+ */
+
+/**
+ * Header helpers on hc.request.headers and hc.collection.headers.
+ */
+interface HcHeaderApi {
+  /**
+   * Returns the first enabled header value for key (case-insensitive), or undefined.
+   */
+  get(key: string): string | undefined;
+
+  /**
+   * Sets an existing header or appends a new enabled row.
+   */
+  upsert(key: string, value: string): void;
+
+  /**
+   * Returns enabled headers as a flat key/value map.
+   */
+  toObject(): Record<string, string>;
+}
+
+/**
+ * Variable helpers on hc.variables, hc.collection.variables, hc.environment.variables, and hc.globals.
+ */
+interface HcVariablesApi {
+  /**
+   * Returns a variable value, preferring values set in the current script run.
+   */
+  get(key: string): string | undefined;
+
+  /**
+   * Sets a variable for the remainder of the script run.
+   */
+  set(key: string, value: unknown): void;
+
+  /**
+   * Replaces {{variable}} tokens and dynamic $ tokens in a template string.
+   */
+  replaceIn(template: unknown): string;
+}
+
+/**
+ * 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.
+ */
+interface HcResponseElement {
+  textContent: string;
+  getAttribute(name: string): string | null;
+  innerHTML: string;
+}
+
+/**
+ * Document surface backed by Cheerio for querying HTML response bodies.
+ */
+interface HcResponseDocument {
+  querySelector(selector: string): HcResponseElement | null;
+  querySelectorAll(selector: string): HcResponseElement[];
+}
+
+/**
+ * Response snapshot available in post-request scripts as hc.response.
+ */
+interface HcResponseApi {
+  readonly code: number;
+  readonly status: string;
+  readonly headers: Record<string, string>;
+  readonly responseTime: number;
+  text(): string;
+  json(): unknown;
+  document(): HcResponseDocument;
+}
+
+/**
+ * HarborClient script sandbox API exposed as the global hc object.
+ */
+interface HcScriptApi {
+  request: {
+    method: string;
+    url: string;
+    body: string;
+    headers: HcHeaderApi;
+  };
+  variables: HcVariablesApi;
+  collection: {
+    readonly id: number | null;
+    readonly name: string;
+    variables: HcVariablesApi;
+    headers: HcHeaderApi;
+  };
+  environment: {
+    readonly name: string;
+    variables: HcVariablesApi;
+  };
+  globals: HcVariablesApi;
+  test(name: string, fn: () => void): void;
+  expect(actual: unknown): HcExpectMatcher;
+  response: HcResponseApi;
+}
+
+/**
+ * HarborClient script sandbox API for pre/post request scripts and snippet files.
+ */
+declare const hc: HcScriptApi;
+
+/**
+ * Capturing console available inside request/post-request script sandboxes.
+ */
+declare const console: {
+  log(...args: unknown[]): void;
+  error(...args: unknown[]): void;
+};

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "@harborclient/sdk",
-  "version": "1.0.36",
+  "version": "1.0.39",
   "description": "TypeScript SDK for HarborClient development.",
   "keywords": [
     "harborclient",
-    "plugin",
+    "plugins",
+    "themes",
+    "snippets",
     "typescript",
     "types"
   ],
@@ -66,6 +68,9 @@
     "./main": {
       "types": "./dist/main.d.ts"
     },
+    "./snippets": {
+      "types": "./dist/snippets.d.ts"
+    },
     "./http": {
       "types": "./dist/http/index.d.ts",
       "import": "./dist/http/index.js",
@@ -144,6 +149,13 @@
       "default": "./dist/styles.css"
     }
   },
+  "typesVersions": {
+    "*": {
+      "snippets": [
+        "./dist/snippets.d.ts"
+      ]
+    }
+  },
   "bin": {
     "hc-plugin-sign": "./dist/signing/cli-sign.js",
     "hc-plugin-verify": "./dist/signing/cli-verify.js"