@harborclient/sdk 0.6.3 → 0.6.6

package/dist/variables/tokens.d.ts

@@ -22,6 +22,37 @@ export declare const VARIABLE_TOKEN_PATTERN: RegExp;
  * @returns Ordered tokens for rendering or further processing.
  */
 export declare function tokenizeVariables(text: string): VariableToken[];
+/**
+ * A {{variable}} token located at a character offset in source text.
+ */
+export interface VariableTokenMatch {
+    key: string;
+    start: number;
+    end: number;
+}
+/**
+ * Returns the variable token containing the given character offset, if any.
+ *
+ * @param text - Text containing variable placeholders.
+ * @param offset - Zero-based character offset from the start of `text`.
+ * @returns Matching token range and key, or null when offset is outside a token.
+ */
+export declare function getVariableTokenAtOffset(text: string, offset: number): VariableTokenMatch | null;
+/**
+ * Resolved tooltip text for a variable key.
+ */
+export interface VariableTooltipContent {
+    text: string;
+    muted: boolean;
+}
+/**
+ * Resolves display text for a variable tooltip.
+ *
+ * @param key - Variable name from a {{key}} placeholder.
+ * @param variables - Collection-scoped variables.
+ * @returns Tooltip body text and whether it should use muted styling.
+ */
+export declare function getVariableTooltipContent(key: string, variables: Variable[]): VariableTooltipContent;
 /**
  * Resolves a single variable key against collection variables.
  *

package/dist/variables/tokens.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/variables/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,sBAAsB,QAGlC,CAAC;AAgBF;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE,CAmB/D;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,SAAS,CAEtF;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAY/E"}
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["../../src/variables/tokens.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,WAAW,CAAC;AAE5C;;GAEG;AACH,eAAO,MAAM,sBAAsB,QAGlC,CAAC;AAgBF;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa,EAAE,CAmB/D;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;;;GAMG;AACH,wBAAgB,wBAAwB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,kBAAkB,GAAG,IAAI,CAahG;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;;;GAMG;AACH,wBAAgB,yBAAyB,CACvC,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,QAAQ,EAAE,GACpB,sBAAsB,CAYxB;AAED;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,GAAG,SAAS,CAEtF;AAED;;;;;;;;;GASG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,MAAM,CAY/E"}

package/dist/variables/tokens.js

@@ -1,4 +1,4 @@
-import { resolveDynamicVariable } from './dynamic.js';
+import { getDynamicVariableDescription, resolveDynamicVariable } from './dynamic.js';
 /**
  * Allowed characters inside a `{{variable}}` token name (excluding braces).
  * Includes `$` so Postman-style dynamic names such as `$randomUUID` are recognized.
@@ -42,6 +42,43 @@ export function tokenizeVariables(text) {
     }
     return tokens;
 }
+/**
+ * Returns the variable token containing the given character offset, if any.
+ *
+ * @param text - Text containing variable placeholders.
+ * @param offset - Zero-based character offset from the start of `text`.
+ * @returns Matching token range and key, or null when offset is outside a token.
+ */
+export function getVariableTokenAtOffset(text, offset) {
+    let position = 0;
+    for (const token of tokenizeVariables(text)) {
+        const start = position;
+        const end = position + token.text.length;
+        if (token.key && offset >= start && offset <= end) {
+            return { key: token.key, start, end };
+        }
+        position = end;
+    }
+    return null;
+}
+/**
+ * Resolves display text for a variable tooltip.
+ *
+ * @param key - Variable name from a {{key}} placeholder.
+ * @param variables - Collection-scoped variables.
+ * @returns Tooltip body text and whether it should use muted styling.
+ */
+export function getVariableTooltipContent(key, variables) {
+    const value = resolveVariable(key, variables);
+    if (value !== undefined) {
+        return { text: value, muted: false };
+    }
+    const dynamicDescription = getDynamicVariableDescription(key);
+    if (dynamicDescription) {
+        return { text: `Dynamic: ${dynamicDescription}`, muted: true };
+    }
+    return { text: 'Not defined', muted: true };
+}
 /**
  * Resolves a single variable key against collection variables.
  *

package/dist/variables/tokens.test.js

@@ -1,5 +1,5 @@
 import { describe, expect, it } from '@jest/globals';
-import { resolveVariable, substituteVariables, tokenizeVariables } from './tokens.js';
+import { getVariableTokenAtOffset, getVariableTooltipContent, resolveVariable, substituteVariables, tokenizeVariables } from './tokens.js';
 /**
  * Builds a test variable row.
  *
@@ -113,3 +113,48 @@ describe('resolveVariable', () => {
         expect(resolveVariable('missing', [variable('host', 'api.example.com')])).toBeUndefined();
     });
 });
+describe('getVariableTokenAtOffset', () => {
+    const text = 'https://{{host}}/api/{{version}}';
+    it('returns the token when offset is inside a variable placeholder', () => {
+        expect(getVariableTokenAtOffset(text, 10)).toEqual({
+            key: 'host',
+            start: 8,
+            end: 16
+        });
+    });
+    it('returns null when offset is outside any token', () => {
+        expect(getVariableTokenAtOffset(text, 0)).toBeNull();
+        expect(getVariableTokenAtOffset(text, 7)).toBeNull();
+    });
+    it('matches at token start and end boundaries', () => {
+        expect(getVariableTokenAtOffset('{{host}}', 0)?.key).toBe('host');
+        expect(getVariableTokenAtOffset('{{host}}', 8)?.key).toBe('host');
+    });
+    it('matches tokens with whitespace around the key', () => {
+        expect(getVariableTokenAtOffset('https://{{ host }}/users', 10)).toEqual({
+            key: 'host',
+            start: 8,
+            end: 18
+        });
+    });
+});
+describe('getVariableTooltipContent', () => {
+    it('returns resolved static value without muted styling', () => {
+        expect(getVariableTooltipContent('host', [variable('host', 'api.example.com')])).toEqual({
+            text: 'api.example.com',
+            muted: false
+        });
+    });
+    it('returns dynamic description for registered dynamic variables', () => {
+        expect(getVariableTooltipContent('$guid', [])).toEqual({
+            text: 'Dynamic: A uuid-v4 style guid',
+            muted: true
+        });
+    });
+    it('returns Not defined for unknown keys', () => {
+        expect(getVariableTooltipContent('missing', [variable('host', 'api.example.com')])).toEqual({
+            text: 'Not defined',
+            muted: true
+        });
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harborclient/sdk",
-  "version": "0.6.3",
+  "version": "0.6.6",
   "description": "TypeScript SDK for HarborClient plugin development.",
   "keywords": [
     "harborclient",

package/dist/components/OverlayPage/index.d.ts

@@ -1,40 +0,0 @@
-import type { JSX, ReactNode } from 'react';
-interface Props {
-    /**
-     * Page title shown in the overlay header.
-     */
-    title: ReactNode;
-    /**
-     * Called when the user closes the overlay.
-     */
-    onClose: () => void;
-    /**
-     * Scrollable page body content.
-     */
-    children: ReactNode;
-    /**
-     * Optional footer actions such as Save/Cancel rows.
-     */
-    footer?: ReactNode;
-    /**
-     * Accessible name for the header close button.
-     */
-    closeLabel?: string;
-    /**
-     * Additional Tailwind classes merged onto the outer scroll container.
-     */
-    className?: string;
-}
-/**
- * Full-page scrollable overlay shell shared by environment, collection, and plugin views.
- *
- * @param title - Header title text or element.
- * @param onClose - Close handler for the header button.
- * @param children - Main page content.
- * @param footer - Optional trailing action row below the body.
- * @param closeLabel - Accessible close button label.
- * @param className - Extra classes on the outer container.
- */
-export declare function OverlayPage({ title, onClose, children, footer, closeLabel, className }: Props): JSX.Element;
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/components/OverlayPage/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/components/OverlayPage/index.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AAG5C,UAAU,KAAK;IACb;;OAEG;IACH,KAAK,EAAE,SAAS,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,SAAS,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,wBAAgB,WAAW,CAAC,EAC1B,KAAK,EACL,OAAO,EACP,QAAQ,EACR,MAAM,EACN,UAAU,EACV,SAAS,EACV,EAAE,KAAK,GAAG,GAAG,CAAC,OAAO,CAiBrB"}

package/dist/components/OverlayPage/index.js

@@ -1,18 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs } from "@harborclient/sdk/jsx-runtime";
-import { OverlayCloseButton } from '../OverlayCloseButton/index.js';
-/**
- * Full-page scrollable overlay shell shared by environment, collection, and plugin views.
- *
- * @param title - Header title text or element.
- * @param onClose - Close handler for the header button.
- * @param children - Main page content.
- * @param footer - Optional trailing action row below the body.
- * @param closeLabel - Accessible close button label.
- * @param className - Extra classes on the outer container.
- */
-export function OverlayPage({ title, onClose, children, footer, closeLabel, className }) {
-    const outer = className
-        ? `flex min-h-0 flex-1 flex-col overflow-y-auto p-6 ${className}`
-        : 'flex min-h-0 flex-1 flex-col overflow-y-auto p-6';
-    return (_jsx("div", { className: outer, children: _jsxs("div", { className: "mx-auto w-full", children: [_jsxs("div", { className: "mb-6 flex items-center justify-between gap-4", children: [_jsx("h1", { className: "m-0 text-[15px] font-semibold text-text", children: title }), _jsx(OverlayCloseButton, { label: closeLabel, onClose: onClose })] }), children, footer] }) }));
-}