@perspective-ai/sdk 1.0.0-alpha.2

package/dist/constants.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Shared constants for Perspective Embed SDK
+ * This file is SSR-safe - no DOM access at import time
+ * Used by both SDK bundle and the main Perspective app
+ */
+/** SDK version for handshake protocol */
+declare const SDK_VERSION = "1.0.0";
+/** Feature flags as bitset for version negotiation */
+declare const FEATURES: {
+    readonly RESIZE: number;
+    readonly THEME_SYNC: number;
+    readonly ANON_ID: number;
+    readonly SCROLLBAR_STYLES: number;
+};
+/** Current SDK feature set */
+declare const CURRENT_FEATURES: number;
+declare const PARAM_KEYS: {
+    readonly email: "email";
+    readonly name: "name";
+    readonly returnUrl: "returnUrl";
+    readonly voice: "voice";
+    readonly scroll: "scroll";
+    readonly hideProgress: "hideProgress";
+    readonly hideGreeting: "hideGreeting";
+    readonly hideBranding: "hideBranding";
+    readonly mode: "mode";
+    readonly invite: "invite";
+    readonly embed: "embed";
+    readonly embedType: "embed_type";
+    readonly theme: "theme";
+};
+type ParamKey = (typeof PARAM_KEYS)[keyof typeof PARAM_KEYS];
+declare const BRAND_KEYS: {
+    readonly primary: "brand.primary";
+    readonly secondary: "brand.secondary";
+    readonly bg: "brand.bg";
+    readonly text: "brand.text";
+    readonly darkPrimary: "brand.dark.primary";
+    readonly darkSecondary: "brand.dark.secondary";
+    readonly darkBg: "brand.dark.bg";
+    readonly darkText: "brand.dark.text";
+};
+type BrandKey = (typeof BRAND_KEYS)[keyof typeof BRAND_KEYS];
+declare const UTM_PARAMS: readonly ["utm_source", "utm_medium", "utm_campaign", "utm_term", "utm_content"];
+type UtmParam = (typeof UTM_PARAMS)[number];
+declare const RESERVED_PARAMS: Set<string>;
+declare const DATA_ATTRS: {
+    readonly widget: "data-perspective-widget";
+    readonly popup: "data-perspective-popup";
+    readonly slider: "data-perspective-slider";
+    readonly float: "data-perspective-float";
+    readonly chat: "data-perspective-chat";
+    readonly fullpage: "data-perspective-fullpage";
+    readonly params: "data-perspective-params";
+    readonly brand: "data-perspective-brand";
+    readonly brandDark: "data-perspective-brand-dark";
+    readonly theme: "data-perspective-theme";
+    readonly noStyle: "data-perspective-no-style";
+};
+type DataAttr = (typeof DATA_ATTRS)[keyof typeof DATA_ATTRS];
+declare const MESSAGE_TYPES: {
+    readonly init: "perspective:init";
+    readonly ready: "perspective:ready";
+    readonly resize: "perspective:resize";
+    readonly submit: "perspective:submit";
+    readonly close: "perspective:close";
+    readonly error: "perspective:error";
+    readonly redirect: "perspective:redirect";
+    readonly anonId: "perspective:anon-id";
+    readonly injectStyles: "perspective:inject-styles";
+    readonly themeChange: "perspective:theme-change";
+    readonly requestScrollbarStyles: "perspective:request-scrollbar-styles";
+};
+type MessageType = (typeof MESSAGE_TYPES)[keyof typeof MESSAGE_TYPES];
+declare const ERROR_CODES: {
+    readonly SDK_OUTDATED: "SDK_OUTDATED";
+    readonly INVALID_RESEARCH: "INVALID_RESEARCH";
+    readonly UNKNOWN: "UNKNOWN";
+};
+type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];
+declare const PARAM_VALUES: {
+    readonly disabled: "0";
+    readonly enabled: "1";
+    readonly true: "true";
+    readonly false: "false";
+};
+declare const THEME_VALUES: {
+    readonly dark: "dark";
+    readonly light: "light";
+    readonly system: "system";
+};
+type ThemeValue = (typeof THEME_VALUES)[keyof typeof THEME_VALUES];
+declare const MODE_VALUES: {
+    readonly preview: "preview";
+    readonly restart: "restart";
+    readonly normal: "normal";
+    readonly simulated: "simulated";
+};
+type ModeValue = (typeof MODE_VALUES)[keyof typeof MODE_VALUES];
+declare const STORAGE_KEYS: {
+    readonly anonId: "perspective-anon-id";
+};
+
+export { BRAND_KEYS, type BrandKey, CURRENT_FEATURES, DATA_ATTRS, type DataAttr, ERROR_CODES, type ErrorCode, FEATURES, MESSAGE_TYPES, MODE_VALUES, type MessageType, type ModeValue, PARAM_KEYS, PARAM_VALUES, type ParamKey, RESERVED_PARAMS, SDK_VERSION, STORAGE_KEYS, THEME_VALUES, type ThemeValue, UTM_PARAMS, type UtmParam };

package/dist/constants.js

@@ -0,0 +1,127 @@
+// src/constants.ts
+var SDK_VERSION = "1.0.0";
+var FEATURES = {
+  RESIZE: 1 << 0,
+  // 0b0001
+  THEME_SYNC: 1 << 1,
+  // 0b0010
+  ANON_ID: 1 << 2,
+  // 0b0100
+  SCROLLBAR_STYLES: 1 << 3
+  // 0b1000
+};
+var CURRENT_FEATURES = FEATURES.RESIZE | FEATURES.THEME_SYNC | FEATURES.ANON_ID | FEATURES.SCROLLBAR_STYLES;
+var PARAM_KEYS = {
+  // User identification
+  email: "email",
+  name: "name",
+  // Navigation
+  returnUrl: "returnUrl",
+  // Interview behavior
+  voice: "voice",
+  scroll: "scroll",
+  hideProgress: "hideProgress",
+  hideGreeting: "hideGreeting",
+  hideBranding: "hideBranding",
+  // Interview mode & auth
+  mode: "mode",
+  invite: "invite",
+  // System (internal)
+  embed: "embed",
+  embedType: "embed_type",
+  theme: "theme"
+};
+var BRAND_KEYS = {
+  // Light mode
+  primary: "brand.primary",
+  secondary: "brand.secondary",
+  bg: "brand.bg",
+  text: "brand.text",
+  // Dark mode
+  darkPrimary: "brand.dark.primary",
+  darkSecondary: "brand.dark.secondary",
+  darkBg: "brand.dark.bg",
+  darkText: "brand.dark.text"
+};
+var UTM_PARAMS = [
+  "utm_source",
+  "utm_medium",
+  "utm_campaign",
+  "utm_term",
+  "utm_content"
+];
+var RESERVED_PARAMS = /* @__PURE__ */ new Set([
+  PARAM_KEYS.embed,
+  PARAM_KEYS.embedType,
+  PARAM_KEYS.theme,
+  BRAND_KEYS.primary,
+  BRAND_KEYS.secondary,
+  BRAND_KEYS.bg,
+  BRAND_KEYS.text,
+  BRAND_KEYS.darkPrimary,
+  BRAND_KEYS.darkSecondary,
+  BRAND_KEYS.darkBg,
+  BRAND_KEYS.darkText,
+  ...UTM_PARAMS
+]);
+var DATA_ATTRS = {
+  widget: "data-perspective-widget",
+  popup: "data-perspective-popup",
+  slider: "data-perspective-slider",
+  float: "data-perspective-float",
+  // Primary name
+  chat: "data-perspective-chat",
+  // Legacy alias
+  fullpage: "data-perspective-fullpage",
+  params: "data-perspective-params",
+  brand: "data-perspective-brand",
+  brandDark: "data-perspective-brand-dark",
+  theme: "data-perspective-theme",
+  noStyle: "data-perspective-no-style"
+};
+var MESSAGE_TYPES = {
+  // SDK -> Iframe (initialization)
+  init: "perspective:init",
+  // Iframe -> SDK
+  ready: "perspective:ready",
+  resize: "perspective:resize",
+  submit: "perspective:submit",
+  close: "perspective:close",
+  error: "perspective:error",
+  redirect: "perspective:redirect",
+  // SDK -> Iframe (internal)
+  anonId: "perspective:anon-id",
+  injectStyles: "perspective:inject-styles",
+  themeChange: "perspective:theme-change",
+  // Iframe -> SDK (internal)
+  requestScrollbarStyles: "perspective:request-scrollbar-styles"
+};
+var ERROR_CODES = {
+  SDK_OUTDATED: "SDK_OUTDATED",
+  INVALID_RESEARCH: "INVALID_RESEARCH",
+  UNKNOWN: "UNKNOWN"
+};
+var PARAM_VALUES = {
+  disabled: "0",
+  enabled: "1",
+  true: "true",
+  false: "false"
+};
+var THEME_VALUES = {
+  dark: "dark",
+  light: "light",
+  system: "system"
+};
+var MODE_VALUES = {
+  preview: "preview",
+  restart: "restart",
+  normal: "normal",
+  simulated: "simulated"
+};
+var STORAGE_KEYS = {
+  anonId: "perspective-anon-id"
+};
+
+export { BRAND_KEYS, CURRENT_FEATURES, DATA_ATTRS, ERROR_CODES, FEATURES, MESSAGE_TYPES, MODE_VALUES, PARAM_KEYS, PARAM_VALUES, RESERVED_PARAMS, SDK_VERSION, STORAGE_KEYS, THEME_VALUES, UTM_PARAMS };
+//# sourceMappingURL=constants.js.map
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/constants.ts"],"names":[],"mappings":";AAWO,IAAM,WAAA,GAAc;AAGpB,IAAM,QAAA,GAAW;AAAA,EACtB,QAAQ,CAAA,IAAK,CAAA;AAAA;AAAA,EACb,YAAY,CAAA,IAAK,CAAA;AAAA;AAAA,EACjB,SAAS,CAAA,IAAK,CAAA;AAAA;AAAA,EACd,kBAAkB,CAAA,IAAK;AAAA;AACzB;AAGO,IAAM,mBACX,QAAA,CAAS,MAAA,GACT,SAAS,UAAA,GACT,QAAA,CAAS,UACT,QAAA,CAAS;AAMJ,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,KAAA,EAAO,OAAA;AAAA,EACP,IAAA,EAAM,MAAA;AAAA;AAAA,EAGN,SAAA,EAAW,WAAA;AAAA;AAAA,EAGX,KAAA,EAAO,OAAA;AAAA,EACP,MAAA,EAAQ,QAAA;AAAA,EACR,YAAA,EAAc,cAAA;AAAA,EACd,YAAA,EAAc,cAAA;AAAA,EACd,YAAA,EAAc,cAAA;AAAA;AAAA,EAGd,IAAA,EAAM,MAAA;AAAA,EACN,MAAA,EAAQ,QAAA;AAAA;AAAA,EAGR,KAAA,EAAO,OAAA;AAAA,EACP,SAAA,EAAW,YAAA;AAAA,EACX,KAAA,EAAO;AACT;AAQO,IAAM,UAAA,GAAa;AAAA;AAAA,EAExB,OAAA,EAAS,eAAA;AAAA,EACT,SAAA,EAAW,iBAAA;AAAA,EACX,EAAA,EAAI,UAAA;AAAA,EACJ,IAAA,EAAM,YAAA;AAAA;AAAA,EAGN,WAAA,EAAa,oBAAA;AAAA,EACb,aAAA,EAAe,sBAAA;AAAA,EACf,MAAA,EAAQ,eAAA;AAAA,EACR,QAAA,EAAU;AACZ;AAQO,IAAM,UAAA,GAAa;AAAA,EACxB,YAAA;AAAA,EACA,YAAA;AAAA,EACA,cAAA;AAAA,EACA,UAAA;AAAA,EACA;AACF;AAQO,IAAM,eAAA,uBAAmC,GAAA,CAAI;AAAA,EAClD,UAAA,CAAW,KAAA;AAAA,EACX,UAAA,CAAW,SAAA;AAAA,EACX,UAAA,CAAW,KAAA;AAAA,EACX,UAAA,CAAW,OAAA;AAAA,EACX,UAAA,CAAW,SAAA;AAAA,EACX,UAAA,CAAW,EAAA;AAAA,EACX,UAAA,CAAW,IAAA;AAAA,EACX,UAAA,CAAW,WAAA;AAAA,EACX,UAAA,CAAW,aAAA;AAAA,EACX,UAAA,CAAW,MAAA;AAAA,EACX,UAAA,CAAW,QAAA;AAAA,EACX,GAAG;AACL,CAAC;AAMM,IAAM,UAAA,GAAa;AAAA,EACxB,MAAA,EAAQ,yBAAA;AAAA,EACR,KAAA,EAAO,wBAAA;AAAA,EACP,MAAA,EAAQ,yBAAA;AAAA,EACR,KAAA,EAAO,wBAAA;AAAA;AAAA,EACP,IAAA,EAAM,uBAAA;AAAA;AAAA,EACN,QAAA,EAAU,2BAAA;AAAA,EACV,MAAA,EAAQ,yBAAA;AAAA,EACR,KAAA,EAAO,wBAAA;AAAA,EACP,SAAA,EAAW,6BAAA;AAAA,EACX,KAAA,EAAO,wBAAA;AAAA,EACP,OAAA,EAAS;AACX;AAQO,IAAM,aAAA,GAAgB;AAAA;AAAA,EAE3B,IAAA,EAAM,kBAAA;AAAA;AAAA,EAGN,KAAA,EAAO,mBAAA;AAAA,EACP,MAAA,EAAQ,oBAAA;AAAA,EACR,MAAA,EAAQ,oBAAA;AAAA,EACR,KAAA,EAAO,mBAAA;AAAA,EACP,KAAA,EAAO,mBAAA;AAAA,EACP,QAAA,EAAU,sBAAA;AAAA;AAAA,EAGV,MAAA,EAAQ,qBAAA;AAAA,EACR,YAAA,EAAc,2BAAA;AAAA,EACd,WAAA,EAAa,0BAAA;AAAA;AAAA,EAGb,sBAAA,EAAwB;AAC1B;AAQO,IAAM,WAAA,GAAc;AAAA,EACzB,YAAA,EAAc,cAAA;AAAA,EACd,gBAAA,EAAkB,kBAAA;AAAA,EAClB,OAAA,EAAS;AACX;AAQO,IAAM,YAAA,GAAe;AAAA,EAC1B,QAAA,EAAU,GAAA;AAAA,EACV,OAAA,EAAS,GAAA;AAAA,EACT,IAAA,EAAM,MAAA;AAAA,EACN,KAAA,EAAO;AACT;AAMO,IAAM,YAAA,GAAe;AAAA,EAC1B,IAAA,EAAM,MAAA;AAAA,EACN,KAAA,EAAO,OAAA;AAAA,EACP,MAAA,EAAQ;AACV;AAQO,IAAM,WAAA,GAAc;AAAA,EACzB,OAAA,EAAS,SAAA;AAAA,EACT,OAAA,EAAS,SAAA;AAAA,EACT,MAAA,EAAQ,QAAA;AAAA,EACR,SAAA,EAAW;AACb;AAQO,IAAM,YAAA,GAAe;AAAA,EAC1B,MAAA,EAAQ;AACV","file":"constants.js","sourcesContent":["/**\n * Shared constants for Perspective Embed SDK\n * This file is SSR-safe - no DOM access at import time\n * Used by both SDK bundle and the main Perspective app\n */\n\n// ============================================================================\n// SDK Version & Features\n// ============================================================================\n\n/** SDK version for handshake protocol */\nexport const SDK_VERSION = \"1.0.0\";\n\n/** Feature flags as bitset for version negotiation */\nexport const FEATURES = {\n  RESIZE: 1 << 0, // 0b0001\n  THEME_SYNC: 1 << 1, // 0b0010\n  ANON_ID: 1 << 2, // 0b0100\n  SCROLLBAR_STYLES: 1 << 3, // 0b1000\n} as const;\n\n/** Current SDK feature set */\nexport const CURRENT_FEATURES =\n  FEATURES.RESIZE |\n  FEATURES.THEME_SYNC |\n  FEATURES.ANON_ID |\n  FEATURES.SCROLLBAR_STYLES;\n\n// ============================================================================\n// URL Parameter Keys\n// ============================================================================\n\nexport const PARAM_KEYS = {\n  // User identification\n  email: \"email\",\n  name: \"name\",\n\n  // Navigation\n  returnUrl: \"returnUrl\",\n\n  // Interview behavior\n  voice: \"voice\",\n  scroll: \"scroll\",\n  hideProgress: \"hideProgress\",\n  hideGreeting: \"hideGreeting\",\n  hideBranding: \"hideBranding\",\n\n  // Interview mode & auth\n  mode: \"mode\",\n  invite: \"invite\",\n\n  // System (internal)\n  embed: \"embed\",\n  embedType: \"embed_type\",\n  theme: \"theme\",\n} as const;\n\nexport type ParamKey = (typeof PARAM_KEYS)[keyof typeof PARAM_KEYS];\n\n// ============================================================================\n// Brand Color Keys\n// ============================================================================\n\nexport const BRAND_KEYS = {\n  // Light mode\n  primary: \"brand.primary\",\n  secondary: \"brand.secondary\",\n  bg: \"brand.bg\",\n  text: \"brand.text\",\n\n  // Dark mode\n  darkPrimary: \"brand.dark.primary\",\n  darkSecondary: \"brand.dark.secondary\",\n  darkBg: \"brand.dark.bg\",\n  darkText: \"brand.dark.text\",\n} as const;\n\nexport type BrandKey = (typeof BRAND_KEYS)[keyof typeof BRAND_KEYS];\n\n// ============================================================================\n// UTM Parameters (auto-forwarded from parent URL)\n// ============================================================================\n\nexport const UTM_PARAMS = [\n  \"utm_source\",\n  \"utm_medium\",\n  \"utm_campaign\",\n  \"utm_term\",\n  \"utm_content\",\n] as const;\n\nexport type UtmParam = (typeof UTM_PARAMS)[number];\n\n// ============================================================================\n// Reserved Parameters (cannot be overridden via custom params)\n// ============================================================================\n\nexport const RESERVED_PARAMS: Set<string> = new Set([\n  PARAM_KEYS.embed,\n  PARAM_KEYS.embedType,\n  PARAM_KEYS.theme,\n  BRAND_KEYS.primary,\n  BRAND_KEYS.secondary,\n  BRAND_KEYS.bg,\n  BRAND_KEYS.text,\n  BRAND_KEYS.darkPrimary,\n  BRAND_KEYS.darkSecondary,\n  BRAND_KEYS.darkBg,\n  BRAND_KEYS.darkText,\n  ...UTM_PARAMS,\n]);\n\n// ============================================================================\n// Data Attributes (HTML declarative initialization)\n// ============================================================================\n\nexport const DATA_ATTRS = {\n  widget: \"data-perspective-widget\",\n  popup: \"data-perspective-popup\",\n  slider: \"data-perspective-slider\",\n  float: \"data-perspective-float\", // Primary name\n  chat: \"data-perspective-chat\", // Legacy alias\n  fullpage: \"data-perspective-fullpage\",\n  params: \"data-perspective-params\",\n  brand: \"data-perspective-brand\",\n  brandDark: \"data-perspective-brand-dark\",\n  theme: \"data-perspective-theme\",\n  noStyle: \"data-perspective-no-style\",\n} as const;\n\nexport type DataAttr = (typeof DATA_ATTRS)[keyof typeof DATA_ATTRS];\n\n// ============================================================================\n// PostMessage Event Types\n// ============================================================================\n\nexport const MESSAGE_TYPES = {\n  // SDK -> Iframe (initialization)\n  init: \"perspective:init\",\n\n  // Iframe -> SDK\n  ready: \"perspective:ready\",\n  resize: \"perspective:resize\",\n  submit: \"perspective:submit\",\n  close: \"perspective:close\",\n  error: \"perspective:error\",\n  redirect: \"perspective:redirect\",\n\n  // SDK -> Iframe (internal)\n  anonId: \"perspective:anon-id\",\n  injectStyles: \"perspective:inject-styles\",\n  themeChange: \"perspective:theme-change\",\n\n  // Iframe -> SDK (internal)\n  requestScrollbarStyles: \"perspective:request-scrollbar-styles\",\n} as const;\n\nexport type MessageType = (typeof MESSAGE_TYPES)[keyof typeof MESSAGE_TYPES];\n\n// ============================================================================\n// Error Codes\n// ============================================================================\n\nexport const ERROR_CODES = {\n  SDK_OUTDATED: \"SDK_OUTDATED\",\n  INVALID_RESEARCH: \"INVALID_RESEARCH\",\n  UNKNOWN: \"UNKNOWN\",\n} as const;\n\nexport type ErrorCode = (typeof ERROR_CODES)[keyof typeof ERROR_CODES];\n\n// ============================================================================\n// Param Values (for boolean-like string params)\n// ============================================================================\n\nexport const PARAM_VALUES = {\n  disabled: \"0\",\n  enabled: \"1\",\n  true: \"true\",\n  false: \"false\",\n} as const;\n\n// ============================================================================\n// Theme Values\n// ============================================================================\n\nexport const THEME_VALUES = {\n  dark: \"dark\",\n  light: \"light\",\n  system: \"system\",\n} as const;\n\nexport type ThemeValue = (typeof THEME_VALUES)[keyof typeof THEME_VALUES];\n\n// ============================================================================\n// Interview Mode Values (for mode param)\n// ============================================================================\n\nexport const MODE_VALUES = {\n  preview: \"preview\",\n  restart: \"restart\",\n  normal: \"normal\",\n  simulated: \"simulated\",\n} as const;\n\nexport type ModeValue = (typeof MODE_VALUES)[keyof typeof MODE_VALUES];\n\n// ============================================================================\n// localStorage Keys\n// ============================================================================\n\nexport const STORAGE_KEYS = {\n  anonId: \"perspective-anon-id\",\n} as const;\n"]}