@shipeasy/devtools-core 1.0.0

package/dist/public-report.d.mts

@@ -0,0 +1,56 @@
+/** The project has not opted into public ticket creation (or the client key
+ *  lacks the `tickets:public_create` scope). */
+declare class PublicTicketsDisabled extends Error {
+    readonly status = 403;
+    constructor(message: string);
+}
+interface PublicBugInput {
+    /** One-line summary (required, ≤200 chars). */
+    title: string;
+    /** What happened — the actual result / error text (≤8000 chars). */
+    error?: string;
+    /** Freeform description / steps (≤8000 chars). */
+    description?: string;
+    /** Optional contact email for follow-up. */
+    reporterEmail?: string;
+    /** Where in the app it happened — feeds the server-side dedupe key
+     *  (same title + step dedupes to the existing open ticket). */
+    step?: string;
+    /** System/env info (platform, os version, app version, …). */
+    context?: Record<string, unknown>;
+}
+interface PublicBugResult {
+    /** The filed (or deduped-to) ticket number. */
+    number: number;
+    /** True when an open ticket with the same title+step already existed. */
+    deduped: boolean;
+}
+interface PublicFeatureInput {
+    /** One-line summary (required, ≤200 chars). */
+    title: string;
+    /** What the feature should do (≤8000 chars). */
+    description?: string;
+    /** The workflow it would unblock (≤8000 chars). */
+    useCase?: string;
+    /** Optional contact email for follow-up. */
+    reporterEmail?: string;
+    /** Where in the app the request came from — feeds the server-side dedupe key. */
+    step?: string;
+    /** System/env info (platform, os version, app version, …). */
+    context?: Record<string, unknown>;
+}
+interface SubmitPublicBugOptions {
+    /** The app's public client key (`sdk_client_*`) — safe to embed. Must carry
+     *  the `tickets:public_create` scope. */
+    clientKey: string;
+    /** Edge worker origin. Defaults to production (`https://api.shipeasy.ai`). */
+    edgeBaseUrl?: string;
+    /** Injectable fetch for tests. Defaults to global fetch. */
+    fetch?: typeof fetch;
+}
+declare function submitPublicBug(input: PublicBugInput, opts: SubmitPublicBugOptions): Promise<PublicBugResult>;
+/** File a feature request through the same public intake (`type: "feature"`).
+ *  Same key/opt-in gates, same forced `pending_approval` state. */
+declare function submitPublicFeature(input: PublicFeatureInput, opts: SubmitPublicBugOptions): Promise<PublicBugResult>;
+
+export { type PublicBugInput, type PublicBugResult, type PublicFeatureInput, PublicTicketsDisabled, type SubmitPublicBugOptions, submitPublicBug, submitPublicFeature };

package/dist/public-report.d.ts

@@ -0,0 +1,56 @@
+/** The project has not opted into public ticket creation (or the client key
+ *  lacks the `tickets:public_create` scope). */
+declare class PublicTicketsDisabled extends Error {
+    readonly status = 403;
+    constructor(message: string);
+}
+interface PublicBugInput {
+    /** One-line summary (required, ≤200 chars). */
+    title: string;
+    /** What happened — the actual result / error text (≤8000 chars). */
+    error?: string;
+    /** Freeform description / steps (≤8000 chars). */
+    description?: string;
+    /** Optional contact email for follow-up. */
+    reporterEmail?: string;
+    /** Where in the app it happened — feeds the server-side dedupe key
+     *  (same title + step dedupes to the existing open ticket). */
+    step?: string;
+    /** System/env info (platform, os version, app version, …). */
+    context?: Record<string, unknown>;
+}
+interface PublicBugResult {
+    /** The filed (or deduped-to) ticket number. */
+    number: number;
+    /** True when an open ticket with the same title+step already existed. */
+    deduped: boolean;
+}
+interface PublicFeatureInput {
+    /** One-line summary (required, ≤200 chars). */
+    title: string;
+    /** What the feature should do (≤8000 chars). */
+    description?: string;
+    /** The workflow it would unblock (≤8000 chars). */
+    useCase?: string;
+    /** Optional contact email for follow-up. */
+    reporterEmail?: string;
+    /** Where in the app the request came from — feeds the server-side dedupe key. */
+    step?: string;
+    /** System/env info (platform, os version, app version, …). */
+    context?: Record<string, unknown>;
+}
+interface SubmitPublicBugOptions {
+    /** The app's public client key (`sdk_client_*`) — safe to embed. Must carry
+     *  the `tickets:public_create` scope. */
+    clientKey: string;
+    /** Edge worker origin. Defaults to production (`https://api.shipeasy.ai`). */
+    edgeBaseUrl?: string;
+    /** Injectable fetch for tests. Defaults to global fetch. */
+    fetch?: typeof fetch;
+}
+declare function submitPublicBug(input: PublicBugInput, opts: SubmitPublicBugOptions): Promise<PublicBugResult>;
+/** File a feature request through the same public intake (`type: "feature"`).
+ *  Same key/opt-in gates, same forced `pending_approval` state. */
+declare function submitPublicFeature(input: PublicFeatureInput, opts: SubmitPublicBugOptions): Promise<PublicBugResult>;
+
+export { type PublicBugInput, type PublicBugResult, type PublicFeatureInput, PublicTicketsDisabled, type SubmitPublicBugOptions, submitPublicBug, submitPublicFeature };

package/dist/public-report.js

@@ -0,0 +1,12 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
+
+
+
+var _chunkRANNOC72js = require('./chunk-RANNOC72.js');
+require('./chunk-KPO3R7ND.js');
+require('./chunk-I2KLQ2HA.js');
+
+
+
+
+exports.PublicTicketsDisabled = _chunkRANNOC72js.PublicTicketsDisabled; exports.submitPublicBug = _chunkRANNOC72js.submitPublicBug; exports.submitPublicFeature = _chunkRANNOC72js.submitPublicFeature;

package/dist/public-report.mjs

@@ -0,0 +1,12 @@
+import {
+  PublicTicketsDisabled,
+  submitPublicBug,
+  submitPublicFeature
+} from "./chunk-WP2TWHG3.mjs";
+import "./chunk-RH6X24HG.mjs";
+import "./chunk-U5DDQYSF.mjs";
+export {
+  PublicTicketsDisabled,
+  submitPublicBug,
+  submitPublicFeature
+};

package/dist/self-report.d.mts

@@ -0,0 +1,25 @@
+import { SeeChain, SeeViolationChain } from '@shipeasy/sdk/devtools-contract';
+
+/**
+ * Point the reporter at an edge origin + tag reports with the running project.
+ * Called once from the overlay mount. Safe to call again on session swap.
+ */
+declare function configureSelfReport(opts: {
+    edgeBaseUrl?: string;
+    affectedProjectId?: string;
+}): void;
+/**
+ * The overlay's own `see()` — same grammar as `@shipeasy/sdk`'s see():
+ *
+ *   see(err).causes_the("label draft").to("not be saved").extras({ profile_id });
+ *   see.Violation("no profile").causes_the("label edit").to("have no anchor");
+ *
+ * Reports into Shipeasy's monitoring project, NOT the customer's. Import it in
+ * overlay catch blocks that know the user-visible consequence of the fault.
+ */
+declare function see(problem: unknown): SeeChain;
+declare namespace see {
+    var Violation: (name: string) => SeeViolationChain;
+}
+
+export { configureSelfReport, see };

package/dist/self-report.d.ts

@@ -0,0 +1,25 @@
+import { SeeChain, SeeViolationChain } from '@shipeasy/sdk/devtools-contract';
+
+/**
+ * Point the reporter at an edge origin + tag reports with the running project.
+ * Called once from the overlay mount. Safe to call again on session swap.
+ */
+declare function configureSelfReport(opts: {
+    edgeBaseUrl?: string;
+    affectedProjectId?: string;
+}): void;
+/**
+ * The overlay's own `see()` — same grammar as `@shipeasy/sdk`'s see():
+ *
+ *   see(err).causes_the("label draft").to("not be saved").extras({ profile_id });
+ *   see.Violation("no profile").causes_the("label edit").to("have no anchor");
+ *
+ * Reports into Shipeasy's monitoring project, NOT the customer's. Import it in
+ * overlay catch blocks that know the user-visible consequence of the fault.
+ */
+declare function see(problem: unknown): SeeChain;
+declare namespace see {
+    var Violation: (name: string) => SeeViolationChain;
+}
+
+export { configureSelfReport, see };

package/dist/self-report.js

@@ -0,0 +1,73 @@
+"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } }
+
+
+var _chunkKPO3R7NDjs = require('./chunk-KPO3R7ND.js');
+require('./chunk-I2KLQ2HA.js');
+
+// src/self-report.ts
+
+
+
+
+
+var _devtoolscontract = require('@shipeasy/sdk/devtools-contract');
+var PLACEHOLDER_KEY = "sdk_client_REPLACE_WITH_SHIPEASY_DEVTOOLS_MONITOR_KEY";
+var MONITOR_CLIENT_KEY = PLACEHOLDER_KEY;
+var SELF_REPORT_SDK_VERSION = "devtools-overlay";
+var config = { edgeBaseUrl: _chunkKPO3R7NDjs.DEFAULT_EDGE_BASE_URL };
+var limiter = new (0, _devtoolscontract.SeeLimiter)();
+function configureSelfReport(opts) {
+  config = {
+    edgeBaseUrl: (_nullishCoalesce(opts.edgeBaseUrl, () => ( _chunkKPO3R7NDjs.DEFAULT_EDGE_BASE_URL))).replace(/\/$/, ""),
+    affectedProjectId: opts.affectedProjectId
+  };
+}
+function armed() {
+  return !!MONITOR_CLIENT_KEY && MONITOR_CLIENT_KEY !== PLACEHOLDER_KEY;
+}
+function post(events) {
+  const url = `${config.edgeBaseUrl}/collect`;
+  if (typeof navigator !== "undefined" && typeof navigator.sendBeacon === "function") {
+    try {
+      const body = JSON.stringify({ k: MONITOR_CLIENT_KEY, events });
+      if (navigator.sendBeacon(url, new Blob([body], { type: "text/plain" }))) return;
+    } catch (e) {
+    }
+  }
+  try {
+    void fetch(url, {
+      method: "POST",
+      headers: { "X-SDK-Key": MONITOR_CLIENT_KEY, "Content-Type": "application/json" },
+      body: JSON.stringify({ events }),
+      keepalive: true
+    }).catch(() => {
+    });
+  } catch (e2) {
+  }
+}
+function dispatch(problem, consequence, extras, kind) {
+  if (!armed()) return;
+  try {
+    const enriched = {
+      surface: "devtools",
+      ...config.affectedProjectId ? { affected_project: config.affectedProjectId } : {},
+      ...extras
+    };
+    const ev = _devtoolscontract.buildSeeEvent.call(void 0, problem, consequence, enriched, {
+      side: "client",
+      sdkVersion: SELF_REPORT_SDK_VERSION,
+      url: typeof window !== "undefined" && window.location ? window.location.href : void 0
+    }, kind);
+    if (!limiter.shouldSend(ev)) return;
+    post([ev]);
+  } catch (e3) {
+  }
+}
+function see(problem) {
+  return _devtoolscontract.startSeeChain.call(void 0, () => problem, dispatch);
+}
+see.Violation = (name) => _devtoolscontract.startSeeViolationChain.call(void 0, name, dispatch);
+
+
+
+exports.configureSelfReport = configureSelfReport; exports.see = see;

package/dist/self-report.mjs

@@ -0,0 +1,73 @@
+import {
+  DEFAULT_EDGE_BASE_URL,
+  types_exports
+} from "./chunk-RH6X24HG.mjs";
+import "./chunk-U5DDQYSF.mjs";
+
+// src/self-report.ts
+import {
+  buildSeeEvent,
+  SeeLimiter,
+  startSeeChain,
+  startSeeViolationChain
+} from "@shipeasy/sdk/devtools-contract";
+var PLACEHOLDER_KEY = "sdk_client_REPLACE_WITH_SHIPEASY_DEVTOOLS_MONITOR_KEY";
+var MONITOR_CLIENT_KEY = PLACEHOLDER_KEY;
+var SELF_REPORT_SDK_VERSION = "devtools-overlay";
+var config = { edgeBaseUrl: DEFAULT_EDGE_BASE_URL };
+var limiter = new SeeLimiter();
+function configureSelfReport(opts) {
+  config = {
+    edgeBaseUrl: (opts.edgeBaseUrl ?? DEFAULT_EDGE_BASE_URL).replace(/\/$/, ""),
+    affectedProjectId: opts.affectedProjectId
+  };
+}
+function armed() {
+  return !!MONITOR_CLIENT_KEY && MONITOR_CLIENT_KEY !== PLACEHOLDER_KEY;
+}
+function post(events) {
+  const url = `${config.edgeBaseUrl}/collect`;
+  if (typeof navigator !== "undefined" && typeof navigator.sendBeacon === "function") {
+    try {
+      const body = JSON.stringify({ k: MONITOR_CLIENT_KEY, events });
+      if (navigator.sendBeacon(url, new Blob([body], { type: "text/plain" }))) return;
+    } catch {
+    }
+  }
+  try {
+    void fetch(url, {
+      method: "POST",
+      headers: { "X-SDK-Key": MONITOR_CLIENT_KEY, "Content-Type": "application/json" },
+      body: JSON.stringify({ events }),
+      keepalive: true
+    }).catch(() => {
+    });
+  } catch {
+  }
+}
+function dispatch(problem, consequence, extras, kind) {
+  if (!armed()) return;
+  try {
+    const enriched = {
+      surface: "devtools",
+      ...config.affectedProjectId ? { affected_project: config.affectedProjectId } : {},
+      ...extras
+    };
+    const ev = buildSeeEvent(problem, consequence, enriched, {
+      side: "client",
+      sdkVersion: SELF_REPORT_SDK_VERSION,
+      url: typeof window !== "undefined" && window.location ? window.location.href : void 0
+    }, kind);
+    if (!limiter.shouldSend(ev)) return;
+    post([ev]);
+  } catch {
+  }
+}
+function see(problem) {
+  return startSeeChain(() => problem, dispatch);
+}
+see.Violation = (name) => startSeeViolationChain(name, dispatch);
+export {
+  configureSelfReport,
+  see
+};

package/dist/types-D0sroUDD.d.mts

@@ -0,0 +1,278 @@
+type UniverseParam = {
+    /**
+     * Param key, referenced by `groups[].params` on every experiment in the universe.
+     */
+    name: string;
+    /**
+     * Scalar type of the param's value.
+     */
+    type: 'bool' | 'string' | 'int' | 'number';
+    /**
+     * Universe-wide default. Returned when the assigned variant doesn't override this param (resolution: variant override → universe default).
+     */
+    default: unknown;
+};
+/**
+ * The universe's ordered config schema — the single source of truth for its params.
+ */
+type UniverseParamSchema = Array<UniverseParam>;
+type ListUniversesResponse = {
+    data: Array<{
+        /**
+         * Stable opaque universe id.
+         */
+        id: string;
+        /**
+         * Stable universe key. Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create.
+         */
+        name: string;
+        /**
+         * Human-readable blurb shown in the universe picker/hovercard.
+         */
+        description?: string | null;
+        /**
+         * Unit of randomisation. Snake-case in request (`unit_type`), camelCase in response.
+         */
+        unitType: string;
+        /**
+         * Reserved holdout bucket range, or `null` if none.
+         */
+        holdoutRange: [
+            number,
+            number
+        ] | null;
+        /**
+         * Basis points of headroom seeded into each new experiment's reserved tail (0 = none).
+         */
+        recommendedHeadroom?: number;
+        /**
+         * The universe-owned config schema, or `null` on pre-rework universes not yet seeded.
+         */
+        paramSchema?: UniverseParamSchema | null;
+        /**
+         * ISO-8601 timestamp of creation.
+         */
+        createdAt: string;
+    }>;
+    next_cursor: string | null;
+};
+
+/** Prod defaults; both overridable per client (local dev, staging). */
+declare const DEFAULT_ADMIN_BASE_URL = "https://shipeasy.ai";
+declare const DEFAULT_EDGE_BASE_URL = "https://api.shipeasy.ai";
+/** A completed device-auth login: the minted admin key + the project it binds. */
+interface DevtoolsSession {
+    /** Raw admin SDK key (`sdk_admin_*`). Store securely (Keychain/Keystore). */
+    token: string;
+    projectId: string;
+    userEmail: string | null;
+    projectName: string | null;
+}
+interface ProjectModules {
+    translations: boolean;
+    configs: boolean;
+    gates: boolean;
+    experiments: boolean;
+    feedback: boolean;
+    user: boolean;
+    events: boolean;
+}
+interface ProjectRecord {
+    id: string;
+    name: string;
+    domain: string | null;
+    modules: ProjectModules;
+}
+/** One attribute predicate inside a gate condition (e.g. `plan is one of
+ *  ["business"]`). Mirrors the admin `GateRule`. */
+interface GateRule {
+    attr: string;
+    op: string;
+    value: unknown;
+}
+/** One entry in a gate's ordered gatekeeper stack — evaluated top-to-bottom,
+ *  first match wins. A subset of the admin `StackedGateEntry` (the fields the
+ *  overlay renders). */
+interface GateStackEntry {
+    id?: string;
+    type?: "condition" | "rollout";
+    name?: string;
+    /** all rules must match ("all", default) vs any ("any"). */
+    pass?: "all" | "any";
+    rules?: GateRule[];
+    /** 0–10000 basis points. */
+    rolloutPct?: number;
+    bucketBy?: string;
+    locked?: boolean;
+    /** True when this condition is a whitelist (its rule's value is the list). */
+    whitelist?: boolean;
+}
+interface GateRecord {
+    id: string;
+    name: string;
+    enabled: boolean;
+    killswitch: boolean;
+    rolloutPct: number;
+    updatedAt: string;
+    /** Legacy flat targeting rules (pre-stack gates). */
+    rules?: GateRule[] | null;
+    /** The gatekeeper stack (modern gates). Present → drives the flow view. */
+    stack?: GateStackEntry[] | null;
+}
+/** Permissive default schema. Used when a config record arrives without one. */
+declare const PERMISSIVE_CONFIG_SCHEMA: Record<string, unknown>;
+interface ConfigRecord {
+    id: string;
+    name: string;
+    valueJson: unknown;
+    /** JSON Schema describing the value shape. Always type="object" post-migration. */
+    schema: Record<string, unknown>;
+    updatedAt: string;
+}
+/** One experiment variant (group): its label, split weight, and the per-variant
+ *  param overrides delivered when a caller is hashed into it (a subset of the
+ *  universe's param schema; unset keys inherit the universe default). */
+interface ExperimentVariant {
+    name: string;
+    /** Allocation weight in basis points (0–10000). */
+    weight: number;
+    params?: Record<string, unknown> | null;
+}
+interface ExperimentRecord {
+    id: string;
+    name: string;
+    /** Name of the universe this experiment runs in. */
+    universe: string;
+    status: "draft" | "running" | "stopped" | "archived";
+    groups: ExperimentVariant[];
+    updatedAt: string;
+    description?: string | null;
+    hypothesis?: string | null;
+    ownerEmail?: string | null;
+    audience?: string | null;
+    /** Unit of randomisation override, or null to inherit the universe's. */
+    bucketBy?: string | null;
+    /** Share of the gated audience allocated, in basis points (0–10000). */
+    allocationPct?: number;
+    /** ISO-8601 timestamp of the last transition to `running`, or null. */
+    startedAt?: string | null;
+    minSampleSize?: number;
+}
+interface ProfileRecord {
+    id: string;
+    name: string;
+    createdAt: string;
+    /** 1 when this is the project's default profile (D1 returns the int flag). */
+    isDefault?: number;
+}
+type UniverseRecord = ListUniversesResponse["data"][number];
+interface KeyRecord {
+    id: string;
+    key: string;
+    value: string;
+    profileId: string | null;
+    createdAt: string;
+}
+interface DraftRecord {
+    id: string;
+    name: string;
+    profileId: string;
+    status: string;
+    createdAt: string;
+}
+/** Subset of the server's `connector_data` the devtools read. The admin
+ *  endpoints return the full blob; we only type the fields the overlays render:
+ *  the linked GitHub issue/PR (with the PR's merged marker), and the agent
+ *  trace Jarvis records as it works an item. All fields are tolerated absent. */
+interface FeedbackConnectorData {
+    github?: {
+        issue?: {
+            number: number;
+            url: string;
+        };
+        pr?: {
+            number: number;
+            url: string;
+            /** Merged markers — any of these present means the PR landed. */
+            merged?: boolean;
+            mergedAt?: string | null;
+            state?: string;
+        };
+    };
+    /** Agent (Jarvis) trace — present once the AI has acted on the item.
+     *  `awaitingReply` / `state: "awaiting_reply"` means it posted a question
+     *  back and is waiting on a human. */
+    agent?: {
+        state?: string;
+        awaitingReply?: boolean;
+    };
+}
+type BugStatus = "open" | "pending_approval" | "triaged" | "in_progress" | "ready_for_qa" | "resolved" | "wont_fix";
+/** Lowest tier is `nice_to_have`; shared by bugs + feature requests. */
+type BugPriority = "nice_to_have" | "medium" | "high" | "critical";
+interface BugRecord {
+    id: string;
+    title: string;
+    status: BugStatus;
+    priority: BugPriority | null;
+    reporterEmail: string | null;
+    pageUrl: string | null;
+    createdAt: string;
+    connectorData?: FeedbackConnectorData | null;
+}
+interface AttachmentRecord {
+    id: string;
+    kind: "screenshot" | "recording" | "file";
+    filename: string;
+    mimeType: string;
+    sizeBytes: number;
+    createdAt: string;
+}
+interface BugDetail extends BugRecord {
+    stepsToReproduce: string;
+    actualResult: string;
+    expectedResult: string;
+    attachments: AttachmentRecord[];
+}
+/** The queue-item type. `bug`/`feature_request` are user-fileable; `error` and
+ *  `alert` are auto-filed system tickets the overlay now also lists. */
+type OpsItemType = "bug" | "feature_request" | "error" | "alert" | "measure_plan";
+/** Generic ops-item detail — the enriched GET response, permissive across all
+ *  types (bug/feature content fields present only for those types; empty for
+ *  auto-filed error/alert tickets). */
+interface OpsItemDetail extends BugRecord {
+    type?: OpsItemType;
+    /** Auto-filed tickets carry the originating record's key (error fingerprint,
+     *  alert dedupe key), or null for human-filed bugs/features. */
+    sourceRef?: string | null;
+    stepsToReproduce?: string;
+    actualResult?: string;
+    expectedResult?: string;
+    description?: string;
+    useCase?: string;
+    attachments: AttachmentRecord[];
+}
+interface FeatureRequestRecord {
+    id: string;
+    title: string;
+    status: BugStatus;
+    priority: BugPriority | null;
+    reporterEmail: string | null;
+    pageUrl: string | null;
+    createdAt: string;
+    connectorData?: FeedbackConnectorData | null;
+}
+interface FeatureRequestDetail extends FeatureRequestRecord {
+    description: string;
+    useCase: string;
+    attachments: AttachmentRecord[];
+}
+interface AttachmentUploadResult {
+    id: string;
+    filename: string;
+    kind: "screenshot" | "recording" | "file";
+    mimeType: string;
+    sizeBytes: number;
+}
+
+export { type AttachmentRecord as A, type BugDetail as B, type ConfigRecord as C, DEFAULT_ADMIN_BASE_URL as D, type ExperimentRecord as E, type FeatureRequestDetail as F, type GateRecord as G, type KeyRecord as K, type OpsItemDetail as O, PERMISSIVE_CONFIG_SCHEMA as P, type UniverseRecord as U, type AttachmentUploadResult as a, type BugPriority as b, type BugRecord as c, type BugStatus as d, DEFAULT_EDGE_BASE_URL as e, type DevtoolsSession as f, type DraftRecord as g, type FeatureRequestRecord as h, type FeedbackConnectorData as i, type GateRule as j, type GateStackEntry as k, type OpsItemType as l, type ProfileRecord as m, type ProjectModules as n, type ProjectRecord as o };