@fanfare-io/fanfare-sdk-contracts 0.1.0

package/dist/routing.js

@@ -0,0 +1,141 @@
+import * as e from "valibot";
+import { BotMitigationStateSchema as u, RoutingChallengeSchema as g, ChallengeProvider as d, ChallengePurpose as h, ChallengeType as m } from "./challenges.js";
+import { ChallengeProviderSchema as M, ChallengeProviders as H, ChallengePurposeSchema as N, ChallengePurposes as x, ChallengeTypeSchema as Q, ChallengeTypes as W } from "./challenges.js";
+const O = d, j = h, U = m, n = {
+  LOW: "LOW",
+  MEDIUM: "MEDIUM",
+  HIGH: "HIGH"
+}, R = [n.LOW, n.MEDIUM, n.HIGH], C = e.picklist(R), a = e.object({
+  riskLevel: C,
+  requiresChallenge: e.boolean(),
+  blocked: e.boolean()
+}), p = [
+  "NO_SEQUENCES",
+  "NO_ACCESS",
+  "AUTH_REQUIRED",
+  "ACCESS_CODE_REQUIRED",
+  "ACCESS_CODE_INVALID",
+  "AUDIENCE_NOT_MEMBER",
+  "BOT_REQUIRED",
+  "BOT_BLOCKED"
+], c = e.picklist(p), G = c, t = e.object({
+  code: c,
+  detail: e.optional(e.string())
+}), T = t, o = e.object({
+  id: e.string(),
+  name: e.string(),
+  experienceId: e.string(),
+  priority: e.number(),
+  color: e.nullable(e.string())
+}), f = o, S = e.object({
+  type: e.literal("authentication"),
+  status: e.literal("required"),
+  reason: e.object({ code: e.literal("AUTH_REQUIRED"), detail: e.optional(e.string()) })
+}), E = e.object({
+  type: e.literal("access_code"),
+  status: e.picklist(["missing", "invalid"]),
+  reason: e.object({
+    code: e.picklist(["ACCESS_CODE_REQUIRED", "ACCESS_CODE_INVALID"]),
+    detail: e.optional(e.string())
+  })
+}), b = e.object({
+  type: e.literal("bot_check"),
+  status: e.picklist(["required", "blocked"]),
+  reason: e.object({
+    code: e.picklist(["BOT_REQUIRED", "BOT_BLOCKED"]),
+    detail: e.optional(e.string())
+  }),
+  challenge: e.optional(g),
+  mitigation: e.optional(u)
+}), l = e.union([
+  S,
+  E,
+  b
+]), v = l, s = {
+  gates: e.array(l),
+  reasons: e.array(t),
+  sequenceCapabilityGrant: e.optional(e.string()),
+  sequenceCapabilityGrantExpiresAt: e.optional(e.string())
+}, r = e.object({
+  sequence: o,
+  status: e.literal("admissible"),
+  ...s
+}), i = e.object({
+  sequence: o,
+  status: e.literal("gated"),
+  ...s
+}), D = e.object({
+  sequence: o,
+  status: e.literal("denied"),
+  ...s
+}), V = e.union([
+  r,
+  i,
+  D
+]), L = V, I = e.object({
+  schemaVersion: e.literal(1),
+  experienceId: e.string(),
+  outcome: e.literal("routed"),
+  selected: r,
+  offers: e.array(i),
+  outcomeReasons: e.array(t),
+  riskAssessment: e.optional(a)
+}), _ = e.object({
+  schemaVersion: e.literal(1),
+  experienceId: e.string(),
+  outcome: e.literal("gated"),
+  selected: i,
+  offers: e.tuple([]),
+  outcomeReasons: e.array(t),
+  riskAssessment: e.optional(a)
+}), A = e.object({
+  schemaVersion: e.literal(1),
+  experienceId: e.string(),
+  outcome: e.literal("no_access"),
+  offers: e.tuple([]),
+  outcomeReasons: e.array(t),
+  riskAssessment: e.optional(a)
+}), k = e.union([
+  I,
+  _,
+  A
+]), q = k;
+export {
+  E as AccessCodeRoutingGateV1Schema,
+  r as AdmissibleRoutingCandidateV1Schema,
+  S as AuthenticationRoutingGateV1Schema,
+  b as BotCheckRoutingGateV1Schema,
+  u as BotMitigationStateSchema,
+  O as ChallengeProvider,
+  M as ChallengeProviderSchema,
+  H as ChallengeProviders,
+  j as ChallengePurpose,
+  N as ChallengePurposeSchema,
+  x as ChallengePurposes,
+  U as ChallengeType,
+  Q as ChallengeTypeSchema,
+  W as ChallengeTypes,
+  D as DeniedRoutingCandidateV1Schema,
+  _ as GatedDecisionV1Schema,
+  i as GatedRoutingCandidateV1Schema,
+  A as NoAccessDecisionV1Schema,
+  a as RiskAssessmentSchema,
+  n as RiskLevel,
+  C as RiskLevelSchema,
+  R as RiskLevels,
+  I as RoutedDecisionV1Schema,
+  L as RoutingCandidateSchema,
+  V as RoutingCandidateV1Schema,
+  g as RoutingChallengeSchema,
+  q as RoutingDecisionSchema,
+  k as RoutingDecisionV1Schema,
+  v as RoutingGateSchema,
+  l as RoutingGateV1Schema,
+  G as RoutingReasonCodeSchema,
+  c as RoutingReasonCodeV1Schema,
+  p as RoutingReasonCodesV1,
+  T as RoutingReasonSchema,
+  t as RoutingReasonV1Schema,
+  f as RoutingSequenceRefSchema,
+  o as RoutingSequenceRefV1Schema
+};

package/dist/theme.d.ts

@@ -0,0 +1,25 @@
+import { InferOutput } from 'valibot';
+import * as v from "valibot";
+export declare const WidgetVariants: readonly ["default", "retro", "rounded", "clean"];
+export type WidgetVariant = (typeof WidgetVariants)[number];
+export declare const WidgetVariantSchema: v.PicklistSchema<readonly ["default", "retro", "rounded", "clean"], undefined>;
+export declare const BrandThemeSchema: v.ObjectSchema<{
+    readonly primary: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly secondary: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly background: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly surface: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly text: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly muted: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly success: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly warning: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly danger: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly fontFamily: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly fontHeading: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+    readonly logoUrl: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, "validation.url">]>, undefined>;
+    readonly headerImageUrl: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.UrlAction<string, "validation.url">]>, undefined>;
+    readonly variant: v.OptionalSchema<v.PicklistSchema<readonly ["default", "retro", "rounded", "clean"], undefined>, undefined>;
+}, undefined>;
+export type BrandTheme = InferOutput<typeof BrandThemeSchema>;
+export type ResolvedBrandTheme = Required<Omit<BrandTheme, "logoUrl" | "headerImageUrl">> & Pick<BrandTheme, "logoUrl" | "headerImageUrl">;
+export declare const DefaultBrandTheme: Required<Omit<BrandTheme, "logoUrl" | "headerImageUrl">>;
+export declare function mergeBrandTheme(theme: BrandTheme | null | undefined): ResolvedBrandTheme;

package/dist/theme.js

@@ -0,0 +1,43 @@
+import * as n from "valibot";
+const a = ["default", "retro", "rounded", "clean"], r = n.picklist(a), o = n.object({
+  primary: n.optional(n.string()),
+  secondary: n.optional(n.string()),
+  background: n.optional(n.string()),
+  surface: n.optional(n.string()),
+  text: n.optional(n.string()),
+  muted: n.optional(n.string()),
+  success: n.optional(n.string()),
+  warning: n.optional(n.string()),
+  danger: n.optional(n.string()),
+  fontFamily: n.optional(n.string()),
+  fontHeading: n.optional(n.string()),
+  logoUrl: n.optional(n.pipe(n.string(), n.url("validation.url"))),
+  headerImageUrl: n.optional(n.pipe(n.string(), n.url("validation.url"))),
+  variant: n.optional(r)
+}), i = {
+  primary: "#8C14FF",
+  secondary: "#F5F3FF",
+  background: "#FFFFFF",
+  surface: "transparent",
+  text: "#1D1F27",
+  muted: "#4B4E56CC",
+  success: "#22C55E",
+  warning: "#F59E0B",
+  danger: "#EF4444",
+  fontFamily: "Inter",
+  fontHeading: "Inter",
+  variant: "default"
+};
+function e(t) {
+  return {
+    ...i,
+    ...t ?? {}
+  };
+}
+export {
+  o as BrandThemeSchema,
+  i as DefaultBrandTheme,
+  r as WidgetVariantSchema,
+  a as WidgetVariants,
+  e as mergeBrandTheme
+};

package/package.json

@@ -0,0 +1,107 @@
+{
+  "name": "@fanfare-io/fanfare-sdk-contracts",
+  "version": "0.1.0",
+  "description": "Public Fanfare schemas, types, and contract helpers shared by SDKs and internal services",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fanfare-io/fanfare-sdk.git"
+  },
+  "homepage": "https://docs.fanfare.io/sdk/reference/types",
+  "bugs": {
+    "url": "https://github.com/fanfare-io/fanfare-sdk/issues"
+  },
+  "keywords": [
+    "fanfare",
+    "schemas",
+    "types",
+    "validation",
+    "sdk",
+    "contracts"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "files": [
+    "dist/"
+  ],
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./theme": {
+      "types": "./dist/theme.d.ts",
+      "import": "./dist/theme.js",
+      "default": "./dist/theme.js"
+    },
+    "./challenges": {
+      "types": "./dist/challenges.d.ts",
+      "import": "./dist/challenges.js",
+      "default": "./dist/challenges.js"
+    },
+    "./consumer-me": {
+      "types": "./dist/consumer-me.d.ts",
+      "import": "./dist/consumer-me.js",
+      "default": "./dist/consumer-me.js"
+    },
+    "./auction": {
+      "types": "./dist/auction.d.ts",
+      "import": "./dist/auction.js",
+      "default": "./dist/auction.js"
+    },
+    "./beacon": {
+      "types": "./dist/beacon.d.ts",
+      "import": "./dist/beacon.js",
+      "default": "./dist/beacon.js"
+    },
+    "./beacon/names": {
+      "types": "./dist/beacon-names.d.ts",
+      "import": "./dist/beacon-names.js",
+      "default": "./dist/beacon-names.js"
+    },
+    "./routing": {
+      "types": "./dist/routing.d.ts",
+      "import": "./dist/routing.js",
+      "default": "./dist/routing.js"
+    },
+    "./errors": {
+      "types": "./dist/errors.d.ts",
+      "import": "./dist/errors.js",
+      "default": "./dist/errors.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "peerDependencies": {
+    "valibot": "^1.1.0"
+  },
+  "devDependencies": {
+    "prettier": "^3.5.3",
+    "prettier-plugin-organize-imports": "^4.1.0",
+    "rimraf": "^6.0.1",
+    "typescript": "^5.9.2",
+    "vite": "^7.3.1",
+    "vite-plugin-dts": "^4.5.4",
+    "vite-tsconfig-paths": "^5.1.4",
+    "vitest": "^3.2.4"
+  },
+  "scripts": {
+    "build": "vite build",
+    "build:strict": "pnpm typecheck && pnpm build",
+    "build:incremental": "vite build",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:unit": "vitest run .unit.test.ts --passWithNoTests",
+    "fmt": "prettier src --write",
+    "lint": "oxlint src",
+    "lint:fix": "oxlint --fix src",
+    "prebuild": "rimraf dist"
+  }
+}