@harborclient/core 0.1.1

package/dist/scriptStage.js

@@ -0,0 +1,204 @@
+/**
+ * Default stage for script rows and snippets without an explicit stage.
+ */
+export const DEFAULT_SCRIPT_STAGE = 'main';
+/**
+ * Select options for script stage fields in editors and modals.
+ */
+export const SCRIPT_STAGE_OPTIONS = [
+    { value: 'before-all', label: 'Before all' },
+    { value: 'before-each', label: 'Before each' },
+    { value: 'main', label: 'Main' },
+    { value: 'after-each', label: 'After each' },
+    { value: 'after-all', label: 'After all' }
+];
+const SCRIPT_STAGES = new Set(SCRIPT_STAGE_OPTIONS.map((option) => option.value));
+/**
+ * Visible section headings for each editor script group.
+ */
+export const SCRIPT_EDITOR_GROUP_HEADINGS = {
+    before: 'Before',
+    main: 'Main',
+    after: 'After'
+};
+/**
+ * Returns whether the script list editor should show Before/Main/After section headings.
+ *
+ * Headings appear only when scripts span two or more non-empty groups.
+ *
+ * @param groups - Before, main, and after script groups from the editor.
+ * @returns True when multiple non-empty groups should show section labels.
+ */
+export function shouldShowScriptSectionHeadings(groups) {
+    const nonEmptyCount = (groups.before.length > 0 ? 1 : 0) +
+        (groups.main.length > 0 ? 1 : 0) +
+        (groups.after.length > 0 ? 1 : 0);
+    return nonEmptyCount > 1;
+}
+/**
+ * Maps a script stage to its editor list group.
+ *
+ * @param stage - Script execution stage.
+ * @returns Group used for the three-list script editor layout.
+ */
+export function scriptStageGroup(stage) {
+    if (stage === 'before-all' || stage === 'before-each') {
+        return 'before';
+    }
+    if (stage === 'after-each' || stage === 'after-all') {
+        return 'after';
+    }
+    return 'main';
+}
+/**
+ * Coerces an unknown value to a valid script stage.
+ *
+ * @param value - Raw stage from storage or IPC.
+ * @returns Valid stage, defaulting to {@link DEFAULT_SCRIPT_STAGE} for legacy rows.
+ */
+export function normalizeScriptStage(value) {
+    if (typeof value === 'string' && SCRIPT_STAGES.has(value)) {
+        return value;
+    }
+    return DEFAULT_SCRIPT_STAGE;
+}
+/**
+ * Returns the display label for a script stage.
+ *
+ * @param stage - Script execution stage.
+ * @returns Human-readable label for selects and listings.
+ */
+export function scriptStageLabel(stage) {
+    return SCRIPT_STAGE_OPTIONS.find((option) => option.value === stage)?.label ?? 'Main';
+}
+/**
+ * Returns the display-only suffix appended to script row titles in the list editor.
+ *
+ * Not persisted on {@link ScriptRef} names — only clarifies timing for before/after stages.
+ *
+ * @param stage - Script execution stage.
+ * @returns Title-case suffix such as ` (Before Each)`, or an empty string for `main`.
+ */
+export function scriptRowStageSuffix(stage) {
+    switch (stage) {
+        case 'before-all':
+            return ' (Before All)';
+        case 'before-each':
+            return ' (Before Each)';
+        case 'after-all':
+            return ' (After All)';
+        case 'after-each':
+            return ' (After Each)';
+        default:
+            return '';
+    }
+}
+/**
+ * Returns the theme CSS variable for a script row's stage-colored left border.
+ *
+ * @param stage - Script execution stage.
+ * @returns `var(--mac-script-stage-*)` token for inline border styling.
+ */
+export function scriptStageBorderColor(stage) {
+    switch (stage) {
+        case 'before-all':
+            return 'var(--mac-script-stage-before-all)';
+        case 'before-each':
+            return 'var(--mac-script-stage-before-each)';
+        case 'after-all':
+            return 'var(--mac-script-stage-after-all)';
+        case 'after-each':
+            return 'var(--mac-script-stage-after-each)';
+        default:
+            return 'var(--mac-script-stage-main)';
+    }
+}
+/**
+ * Reorders script references into execution order for one phase list.
+ *
+ * Order: all `before-all`, then for each `main` script all `before-each`, the main
+ * script, and all `after-each`, then all `after-all`. Relative order within each
+ * stage is preserved from the stored list.
+ *
+ * @param refs - Normalized script references for one phase.
+ * @returns References ordered for send-time execution.
+ */
+export function orderScriptRefsByStage(refs) {
+    const beforeAll = [];
+    const beforeEach = [];
+    const mainScripts = [];
+    const afterEach = [];
+    const afterAll = [];
+    for (const ref of refs) {
+        const stage = readScriptRefStage(ref);
+        switch (stage) {
+            case 'before-all':
+                beforeAll.push(ref);
+                break;
+            case 'before-each':
+                beforeEach.push(ref);
+                break;
+            case 'after-each':
+                afterEach.push(ref);
+                break;
+            case 'after-all':
+                afterAll.push(ref);
+                break;
+            default:
+                mainScripts.push(ref);
+                break;
+        }
+    }
+    const ordered = [...beforeAll];
+    if (mainScripts.length === 0) {
+        return [...ordered, ...afterAll];
+    }
+    for (const mainScript of mainScripts) {
+        ordered.push(...beforeEach, mainScript, ...afterEach);
+    }
+    ordered.push(...afterAll);
+    return ordered;
+}
+/**
+ * Splits script references into the three editor groups while preserving list order.
+ *
+ * @param refs - Normalized script references for one phase.
+ * @returns Before, main, and after groups for the script list editor.
+ */
+export function splitScriptRefsByGroup(refs) {
+    const before = [];
+    const main = [];
+    const after = [];
+    for (const ref of refs) {
+        const group = scriptStageGroup(readScriptRefStage(ref));
+        if (group === 'before') {
+            before.push(ref);
+        }
+        else if (group === 'after') {
+            after.push(ref);
+        }
+        else {
+            main.push(ref);
+        }
+    }
+    return { before, main, after };
+}
+/**
+ * Concatenates editor groups back into canonical stored order.
+ *
+ * @param groups - Before, main, and after script groups from the editor.
+ * @returns Combined script reference list for persistence.
+ */
+export function mergeScriptRefGroups(groups) {
+    return [...groups.before, ...groups.main, ...groups.after];
+}
+/**
+ * Reads a script reference stage, accepting legacy `role` JSON keys.
+ *
+ * @param ref - Script reference or legacy-shaped object from storage.
+ * @returns Normalized script stage.
+ */
+export function readScriptRefStage(ref) {
+    return normalizeScriptStage(ref.stage ?? ref.role);
+}
+//# sourceMappingURL=scriptStage.js.map

package/dist/scriptStage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"scriptStage.js","sourceRoot":"","sources":["../src/scriptStage.ts"],"names":[],"mappings":"AAEA;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAgB,MAAM,CAAC;AAExD;;GAEG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA4C;IAC3E,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;IAC5C,EAAE,KAAK,EAAE,aAAa,EAAE,KAAK,EAAE,aAAa,EAAE;IAC9C,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE;IAChC,EAAE,KAAK,EAAE,YAAY,EAAE,KAAK,EAAE,YAAY,EAAE;IAC5C,EAAE,KAAK,EAAE,WAAW,EAAE,KAAK,EAAE,WAAW,EAAE;CAC3C,CAAC;AAEF,MAAM,aAAa,GAAG,IAAI,GAAG,CAAc,oBAAoB,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAO/F;;GAEG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAsC;IAC7E,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;CACf,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,+BAA+B,CAAC,MAI/C;IACC,MAAM,aAAa,GACjB,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAClC,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAChC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACpC,OAAO,aAAa,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAkB;IACjD,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK,KAAK,aAAa,EAAE,CAAC;QACtD,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,IAAI,KAAK,KAAK,YAAY,IAAI,KAAK,KAAK,WAAW,EAAE,CAAC;QACpD,OAAO,OAAO,CAAC;IACjB,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAc;IACjD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,GAAG,CAAC,KAAoB,CAAC,EAAE,CAAC;QACzE,OAAO,KAAoB,CAAC;IAC9B,CAAC;IACD,OAAO,oBAAoB,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAkB;IACjD,OAAO,oBAAoB,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,KAAK,KAAK,CAAC,EAAE,KAAK,IAAI,MAAM,CAAC;AACxF,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAkB;IACrD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY;YACf,OAAO,eAAe,CAAC;QACzB,KAAK,aAAa;YAChB,OAAO,gBAAgB,CAAC;QAC1B,KAAK,WAAW;YACd,OAAO,cAAc,CAAC;QACxB,KAAK,YAAY;YACf,OAAO,eAAe,CAAC;QACzB;YACE,OAAO,EAAE,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CAAC,KAAkB;IACvD,QAAQ,KAAK,EAAE,CAAC;QACd,KAAK,YAAY;YACf,OAAO,oCAAoC,CAAC;QAC9C,KAAK,aAAa;YAChB,OAAO,qCAAqC,CAAC;QAC/C,KAAK,WAAW;YACd,OAAO,mCAAmC,CAAC;QAC7C,KAAK,YAAY;YACf,OAAO,oCAAoC,CAAC;QAC9C;YACE,OAAO,8BAA8B,CAAC;IAC1C,CAAC;AACH,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,sBAAsB,CAAoC,IAAS;IACjF,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,MAAM,UAAU,GAAQ,EAAE,CAAC;IAC3B,MAAM,WAAW,GAAQ,EAAE,CAAC;IAC5B,MAAM,SAAS,GAAQ,EAAE,CAAC;IAC1B,MAAM,QAAQ,GAAQ,EAAE,CAAC;IAEzB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;QACtC,QAAQ,KAAK,EAAE,CAAC;YACd,KAAK,YAAY;gBACf,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpB,MAAM;YACR,KAAK,aAAa;gBAChB,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACrB,MAAM;YACR,KAAK,YAAY;gBACf,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACpB,MAAM;YACR,KAAK,WAAW;gBACd,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACnB,MAAM;YACR;gBACE,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBACtB,MAAM;QACV,CAAC;IACH,CAAC;IAED,MAAM,OAAO,GAAQ,CAAC,GAAG,SAAS,CAAC,CAAC;IAEpC,IAAI,WAAW,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,GAAG,OAAO,EAAE,GAAG,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE,CAAC;QACrC,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,EAAE,UAAU,EAAE,GAAG,SAAS,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,CAAC,IAAI,CAAC,GAAG,QAAQ,CAAC,CAAC;IAC1B,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAS;IAET,MAAM,MAAM,GAAQ,EAAE,CAAC;IACvB,MAAM,IAAI,GAAQ,EAAE,CAAC;IACrB,MAAM,KAAK,GAAQ,EAAE,CAAC;IAEtB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,gBAAgB,CAAC,kBAAkB,CAAC,GAAG,CAAC,CAAC,CAAC;QACxD,IAAI,KAAK,KAAK,QAAQ,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAAM,IAAI,KAAK,KAAK,OAAO,EAAE,CAAC;YAC7B,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAAI,MAA8C;IACpF,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;AAC7D,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,GAA4C;IAC7E,OAAO,oBAAoB,CAAC,GAAG,CAAC,KAAK,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC;AACrD,CAAC"}

package/dist/scripting/scriptApi.d.ts

@@ -0,0 +1,59 @@
+import type { ScriptRunInput, ScriptRunResult, SendRequestInput, SendResult } from '../types';
+import type { ScriptFileRequest } from './scriptFileOperations';
+/**
+ * Context fields passed into the hc sandbox without user script source.
+ */
+export type ScriptRunContextInput = Omit<ScriptRunInput, 'script'>;
+/**
+ * Optional runtime hooks injected when building the hc API.
+ */
+export interface ScriptApiOptions {
+    /**
+     * When provided, enables hc.sendRequest for outbound HTTP from the script sandbox.
+     */
+    sendRequest?: (req: SendRequestInput) => Promise<SendResult>;
+    /**
+     * When provided, enables hc.fs / hc.parse / hc.stringify via the main-process bridge.
+     */
+    fileBridge?: (req: ScriptFileRequest) => Promise<unknown>;
+}
+/**
+ * hc API surface and capturing console built for one script run or plugin context.
+ */
+export interface ScriptApi {
+    /**
+     * HarborClient script API exposed inside the SES compartment.
+     */
+    hc: Record<string, unknown>;
+    /**
+     * Capturing console that appends formatted lines to sandbox logs.
+     */
+    console: {
+        log: (...args: unknown[]) => void;
+        error: (...args: unknown[]) => void;
+    };
+    /**
+     * Snapshots the current mutable state into a {@link ScriptRunResult}.
+     *
+     * @returns Request mutations, variable sets, tests, and logs accumulated so far.
+     */
+    readResult(): ScriptRunResult;
+}
+/**
+ * Builds the hc API and capturing console over a fresh mutable state.
+ *
+ * Shared by pre/post request scripts and main-process plugin script contexts so
+ * the hc surface never drifts between runners.
+ *
+ * @param input - Phase, request, response, variables, and optional collection/environment context.
+ * @param options - Optional runtime hooks such as hc.sendRequest transport.
+ * @returns hc object, console, and a reader for accumulated sandbox mutations.
+ */
+export declare function createScriptApi(input: ScriptRunContextInput, options?: ScriptApiOptions): ScriptApi;
+/**
+ * Default request/collection/environment context for plugin script sandboxes.
+ *
+ * @returns Minimal pre-phase context with an empty GET request and no variables.
+ */
+export declare function defaultScriptContextInput(): ScriptRunContextInput;
+//# sourceMappingURL=scriptApi.d.ts.map

package/dist/scripting/scriptApi.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scriptApi.d.ts","sourceRoot":"","sources":["../../src/scripting/scriptApi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAQV,cAAc,EACd,eAAe,EAEf,gBAAgB,EAChB,UAAU,EACX,MAAM,UAAU,CAAC;AAiBlB,OAAO,KAAK,EAEV,iBAAiB,EAElB,MAAM,wBAAwB,CAAC;AAEhC;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,WAAW,CAAC,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC;IAE7D;;OAEG;IACH,UAAU,CAAC,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3D;AAkCD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE5B;;OAEG;IACH,OAAO,EAAE;QACP,GAAG,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;QAClC,KAAK,EAAE,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,IAAI,CAAC;KACrC,CAAC;IAEF;;;;OAIG;IACH,UAAU,IAAI,eAAe,CAAC;CAC/B;AAuZD;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,qBAAqB,EAC5B,OAAO,CAAC,EAAE,gBAAgB,GACzB,SAAS,CAuYX;AAED;;;;GAIG;AACH,wBAAgB,yBAAyB,IAAI,qBAAqB,CAkBjE"}