@sparkletree/core 0.1.0

package/dist/wire.js

@@ -0,0 +1,133 @@
+/* eslint-disable */
+/**
+ * Code generated from shared/sparkletree/wire/contract.ts. DO NOT EDIT.
+ *
+ * Regenerate with `pnpm wire:generate` from the repo root.
+ * Editing this file by hand puts the Go edge and the Next twin back on
+ * separate contracts, which is the exact failure the SDK plan's decision (a)
+ * spends a workstream preventing.
+ */
+// --- protocol ---------------------------------------------------------------
+export const PROTOCOL_VERSIONS = [1, 2];
+export const PROTOCOL_DEFAULT = 1;
+export const PROTOCOL_CURRENT = 2;
+export const PROTOCOL_PARAM = "st-protocol";
+export const PROTOCOL_HEADER = "st-protocol";
+export const PROTOCOL_RESPONSE_HEADER = "st-protocol";
+/**
+ * Is this a version we implement? Absent/blank resolves to PROTOCOL_DEFAULT
+ * before it gets here.
+ */
+export function isSupportedProtocol(version) {
+    return PROTOCOL_VERSIONS.includes(version);
+}
+/**
+ * Resolve the negotiated version from a header value and a query param.
+ * Header wins. Absent, blank, or unparseable resolves to PROTOCOL_DEFAULT —
+ * never an error, because every shell stamped into a customer page before
+ * negotiation existed sends nothing at all.
+ */
+export function resolveProtocol(header, param) {
+    const raw = (header ?? param ?? '').trim();
+    if (!raw)
+        return PROTOCOL_DEFAULT;
+    const parsed = Number.parseInt(raw, 10);
+    if (!Number.isFinite(parsed) || parsed <= 0)
+        return PROTOCOL_DEFAULT;
+    return parsed;
+}
+// --- vocabularies -----------------------------------------------------------
+export const COPY_MODES = ["generate", "replay"];
+export const CONTENT_SOURCES = ["generated", "cached", "static"];
+export const DEGRADE_REASONS = ["quota", "spend-cap", "upstream", "timeout"];
+export const INTENTS = ["signup", "signin", "retain", "upsell", "reassure", "explain", "browse", "convert"];
+export const FRAGMENT_KINDS = ["headline", "body", "cta", "label", "empty-state"];
+export const FRAGMENT_WARMTHS = ["cold", "warming", "warm"];
+export const SDK_PARAM = "sdk";
+export const SDK_PARAM_VALUE = "1";
+export const VARIANT_PARAM = "variant";
+// --- catalog ----------------------------------------------------------------
+export const EVENT_THEME_READY = "theme-ready";
+export const EVENT_CTA_STYLE_READY = "cta-style-ready";
+export const EVENT_EXPERIENCE_READY = "experience-ready";
+export const EVENT_LAYOUT_READY = "layout-ready";
+export const EVENT_BACKGROUND_READY = "background-ready";
+export const EVENT_SEQUENCE_READY = "sequence-ready";
+export const EVENT_VIDEO_READY = "video-ready";
+export const EVENT_GREETING_START = "greeting-start";
+export const EVENT_GREETING_CHUNK = "greeting-chunk";
+export const EVENT_GREETING_DONE = "greeting-done";
+export const EVENT_HEADLINE_START = "headline-start";
+export const EVENT_HEADLINE_CHUNK = "headline-chunk";
+export const EVENT_HEADLINE_DONE = "headline-done";
+export const EVENT_BODY_START = "body-start";
+export const EVENT_BODY_CHUNK = "body-chunk";
+export const EVENT_BODY_DONE = "body-done";
+export const EVENT_CTA_START = "cta-start";
+export const EVENT_CTA_CHUNK = "cta-chunk";
+export const EVENT_CTA_DONE = "cta-done";
+export const EVENT_CTA_READY = "cta-ready";
+export const EVENT_DONE = "done";
+export const EVENT_ERROR = "error";
+export const EVENT_PROTOCOL_UNSUPPORTED = "protocol-unsupported";
+/** Every event name in the contract, in declaration order. */
+export const WIRE_EVENTS = [
+    "theme-ready",
+    "cta-style-ready",
+    "experience-ready",
+    "layout-ready",
+    "background-ready",
+    "sequence-ready",
+    "video-ready",
+    "greeting-start",
+    "greeting-chunk",
+    "greeting-done",
+    "headline-start",
+    "headline-chunk",
+    "headline-done",
+    "body-start",
+    "body-chunk",
+    "body-done",
+    "cta-start",
+    "cta-chunk",
+    "cta-done",
+    "cta-ready",
+    "done",
+    "error",
+    "protocol-unsupported",
+];
+/** Minimum protocol version each event may appear on. */
+export const EVENT_SINCE = {
+    "theme-ready": 1,
+    "cta-style-ready": 1,
+    "experience-ready": 1,
+    "layout-ready": 1,
+    "background-ready": 1,
+    "sequence-ready": 1,
+    "video-ready": 1,
+    "greeting-start": 1,
+    "greeting-chunk": 1,
+    "greeting-done": 1,
+    "headline-start": 1,
+    "headline-chunk": 1,
+    "headline-done": 1,
+    "body-start": 1,
+    "body-chunk": 1,
+    "body-done": 1,
+    "cta-start": 1,
+    "cta-chunk": 1,
+    "cta-done": 1,
+    "cta-ready": 1,
+    "done": 1,
+    "error": 1,
+    "protocol-unsupported": 2,
+};
+/**
+ * Is this an event name the contract knows? An unknown event on the wire is
+ * not an error — a newer server may emit events this client predates — but
+ * it must be ignored, not guessed at.
+ */
+export function isWireEvent(name) {
+    return WIRE_EVENTS.includes(name);
+}
+//# sourceMappingURL=wire.js.map

package/dist/wire.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"wire.js","sourceRoot":"","sources":["../src/wire.ts"],"names":[],"mappings":"AAAA,oBAAoB;AACpB;;;;;;;GAOG;AAEH,+EAA+E;AAE/E,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,CAAC,EAAE,CAAC,CAAU,CAAC;AAEjD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAClC,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAClC,MAAM,CAAC,MAAM,cAAc,GAAG,aAAa,CAAC;AAC5C,MAAM,CAAC,MAAM,eAAe,GAAG,aAAa,CAAC;AAC7C,MAAM,CAAC,MAAM,wBAAwB,GAAG,aAAa,CAAC;AAEtD;;;GAGG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAe;IACjD,OAAQ,iBAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;AACpE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAiC,EAAE,KAAgC;IACjG,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,KAAK,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAC3C,IAAI,CAAC,GAAG;QAAE,OAAO,gBAAgB,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;IACxC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,MAAM,IAAI,CAAC;QAAE,OAAO,gBAAgB,CAAC;IACrE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,+EAA+E;AAE/E,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAU,CAAC;AAE1D,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAU,CAAC;AAE1E,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,SAAS,CAAU,CAAC;AAEtF,MAAM,CAAC,MAAM,OAAO,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAU,CAAC;AAErH,MAAM,CAAC,MAAM,cAAc,GAAG,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,aAAa,CAAU,CAAC;AAE3F,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,MAAM,EAAE,SAAS,EAAE,MAAM,CAAU,CAAC;AAGrE,MAAM,CAAC,MAAM,SAAS,GAAG,KAAK,CAAC;AAC/B,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,CAAC;AACnC,MAAM,CAAC,MAAM,aAAa,GAAG,SAAS,CAAC;AAmfvC,+EAA+E;AAE/E,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAC/C,MAAM,CAAC,MAAM,qBAAqB,GAAG,iBAAiB,CAAC;AACvD,MAAM,CAAC,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AACzD,MAAM,CAAC,MAAM,kBAAkB,GAAG,cAAc,CAAC;AACjD,MAAM,CAAC,MAAM,sBAAsB,GAAG,kBAAkB,CAAC;AACzD,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,MAAM,CAAC,MAAM,iBAAiB,GAAG,aAAa,CAAC;AAC/C,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC;AACnD,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,MAAM,CAAC,MAAM,oBAAoB,GAAG,gBAAgB,CAAC;AACrD,MAAM,CAAC,MAAM,mBAAmB,GAAG,eAAe,CAAC;AACnD,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAC7C,MAAM,CAAC,MAAM,gBAAgB,GAAG,YAAY,CAAC;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAC3C,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAC3C,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAC3C,MAAM,CAAC,MAAM,cAAc,GAAG,UAAU,CAAC;AACzC,MAAM,CAAC,MAAM,eAAe,GAAG,WAAW,CAAC;AAC3C,MAAM,CAAC,MAAM,UAAU,GAAG,MAAM,CAAC;AACjC,MAAM,CAAC,MAAM,WAAW,GAAG,OAAO,CAAC;AACnC,MAAM,CAAC,MAAM,0BAA0B,GAAG,sBAAsB,CAAC;AAEjE,8DAA8D;AAC9D,MAAM,CAAC,MAAM,WAAW,GAAG;IACzB,aAAa;IACb,iBAAiB;IACjB,kBAAkB;IAClB,cAAc;IACd,kBAAkB;IAClB,gBAAgB;IAChB,aAAa;IACb,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,gBAAgB;IAChB,gBAAgB;IAChB,eAAe;IACf,YAAY;IACZ,YAAY;IACZ,WAAW;IACX,WAAW;IACX,WAAW;IACX,UAAU;IACV,WAAW;IACX,MAAM;IACN,OAAO;IACP,sBAAsB;CACd,CAAC;AAGX,yDAAyD;AACzD,MAAM,CAAC,MAAM,WAAW,GAAkC;IACxD,aAAa,EAAE,CAAC;IAChB,iBAAiB,EAAE,CAAC;IACpB,kBAAkB,EAAE,CAAC;IACrB,cAAc,EAAE,CAAC;IACjB,kBAAkB,EAAE,CAAC;IACrB,gBAAgB,EAAE,CAAC;IACnB,aAAa,EAAE,CAAC;IAChB,gBAAgB,EAAE,CAAC;IACnB,gBAAgB,EAAE,CAAC;IACnB,eAAe,EAAE,CAAC;IAClB,gBAAgB,EAAE,CAAC;IACnB,gBAAgB,EAAE,CAAC;IACnB,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC;IACf,YAAY,EAAE,CAAC;IACf,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;IACd,WAAW,EAAE,CAAC;IACd,UAAU,EAAE,CAAC;IACb,WAAW,EAAE,CAAC;IACd,MAAM,EAAE,CAAC;IACT,OAAO,EAAE,CAAC;IACV,sBAAsB,EAAE,CAAC;CAC1B,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAQ,WAAiC,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC"}

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "@sparkletree/core",
+  "version": "0.1.0",
+  "description": "Framework-agnostic core for the SparkleTree SDK: wire protocol, copy choreography, theme, analytics, audio.",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md"
+  ],
+  "devDependencies": {
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/sparkletree/sparkletree-sdk.git",
+    "directory": "core"
+  },
+  "author": "SparkleTree",
+  "homepage": "https://gitlab.com/sparkletree/sparkletree-sdk/-/blob/main/README.md",
+  "bugs": {
+    "url": "https://gitlab.com/sparkletree/sparkletree-sdk/-/issues"
+  },
+  "keywords": [
+    "sparkletree",
+    "adaptive",
+    "personalization",
+    "sse",
+    "streaming",
+    "creative"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "scripts": {
+    "build": "tsc --project tsconfig.json",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "typecheck": "tsc --project tsconfig.json --noEmit"
+  }
+}