@knocklabs/client 0.16.5 → 0.17.0

package/dist/types/clients/guide/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAM/C,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAE1B,OAAO,EAAE,GAAG,CAAC;CACd;AAED,UAAU,+BAA+B;IACvC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,yBAAyB,EAAE,+BAA+B,EAAE,CAAC;IAC7D,yBAAyB,EAAE,OAAO,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,YAAY,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,4BAA4B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;CACjE,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,8BAA8B,GAAG;IAE9D,OAAO,EAAE,WAAW,CAAC;IAErB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,8BAA8B,GAAG;IAClE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAMF,KAAK,eAAe,GAChB,aAAa,GACb,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,qBAAqB,CAAC;AAE1B,KAAK,kBAAkB,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAC9C,aAAa,EACb;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;CAAE,CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CACnD,mBAAmB,EACnB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CACrD,qBAAqB,EACrB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,sBAAsB,CAAC;AAM3B,MAAM,WAAW,cAAe,SAAQ,aAAa;IACnD,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,UAAU,gCACR,SAAQ,+BAA+B;IACvC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAW,SAAQ,SAAS;IAC3C,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,yBAAyB,EAAE,gCAAgC,EAAE,CAAC;IAC9D,OAAO,EAAE,MAAM,cAAc,GAAG,SAAS,CAAC;CAC3C;AAED,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IAC9C,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/clients/guide/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAO/C,MAAM,MAAM,GAAG,GAAG,GAAG,CAAC;AAEtB,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;CAChC;AAED,MAAM,WAAW,aAAa,CAAC,QAAQ,GAAG,GAAG;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,OAAO,EAAE,gBAAgB,CAAC;IAC1B,OAAO,EAAE,QAAQ,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,UAAU,CAAC;IACrB,QAAQ,EAAE,UAAU,GAAG,UAAU,CAAC;IAClC,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,6BAA6B;IACrC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC;IAC7B,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,SAAS,CAAC,QAAQ,GAAG,GAAG;IACvC,UAAU,EAAE,OAAO,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;IACjC,oBAAoB,EAAE,0BAA0B,EAAE,CAAC;IACnD,uBAAuB,EAAE,6BAA6B,EAAE,CAAC;IACzD,yBAAyB,EAAE,OAAO,CAAC;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,UAAU,EAAE,YAAY,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,gBAAgB,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;IAC1C,4BAA4B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,0BAA0B,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3D,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG;IACjC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,SAAS,EAAE,CAAC;IACrB,YAAY,EAAE,cAAc,EAAE,CAAC;IAC/B,wBAAwB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;CACjE,CAAC;AAMF,MAAM,MAAM,8BAA8B,GAAG;IAE3C,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,8BAA8B,GAAG;IAE9D,OAAO,EAAE,WAAW,CAAC;IAErB,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AACF,MAAM,MAAM,sBAAsB,GAAG,8BAA8B,CAAC;AACpE,MAAM,MAAM,oBAAoB,GAAG,8BAA8B,GAAG;IAClE,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,EAAE,IAAI,CAAC;CACd,CAAC;AAMF,KAAK,eAAe,GAChB,aAAa,GACb,eAAe,GACf,eAAe,GACf,mBAAmB,GACnB,qBAAqB,GACrB,4BAA4B,CAAC;AAEjC,KAAK,kBAAkB,CAAC,CAAC,SAAS,eAAe,EAAE,CAAC,IAAI;IACtD,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;IACT,IAAI,EAAE,CAAC,CAAC;CACT,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG,kBAAkB,CAC9C,aAAa,EACb;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,IAAI,CAAA;CAAE,CACrC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,kBAAkB,CAChD,eAAe,EACf;IAAE,KAAK,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;CAAE,CAClC,CAAC;AAEF,MAAM,MAAM,oBAAoB,GAAG,kBAAkB,CACnD,mBAAmB,EACnB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,kBAAkB,CACrD,qBAAqB,EACrB;IAAE,WAAW,EAAE,cAAc,CAAA;CAAE,CAChC,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,kBAAkB,CAC3D,4BAA4B,EAC5B;IAAE,KAAK,EAAE,SAAS,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CACxC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GACxB,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,oBAAoB,GACpB,sBAAsB,GACtB,4BAA4B,CAAC;AAMjC,MAAM,WAAW,cAAc,CAAC,QAAQ,GAAG,GAAG,CAC5C,SAAQ,aAAa,CAAC,QAAQ,CAAC;IAC/B,UAAU,EAAE,MAAM,IAAI,CAAC;IACvB,gBAAgB,EAAE,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,WAAW,CAAA;KAAE,KAAK,IAAI,CAAC;IAChE,cAAc,EAAE,MAAM,IAAI,CAAC;CAC5B;AAED,MAAM,WAAW,8BACf,SAAQ,6BAA6B;IACrC,OAAO,EAAE,UAAU,CAAC;CACrB;AAED,MAAM,WAAW,UAAU,CAAC,QAAQ,GAAG,GAAG,CAAE,SAAQ,SAAS,CAAC,QAAQ,CAAC;IACrE,KAAK,EAAE,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC;IAClC,uBAAuB,EAAE,8BAA8B,EAAE,CAAC;IAC1D,OAAO,EAAE,MAAM,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC;CACrD;AAED,KAAK,QAAQ,GAAG,MAAM,CAAC;AAEvB,MAAM,MAAM,WAAW,GAAG;IACxB,MAAM,EAAE,SAAS,GAAG,IAAI,GAAG,OAAO,CAAC;IACnC,KAAK,CAAC,EAAE,KAAK,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,WAAW,EAAE,cAAc,EAAE,CAAC;IAC9B,qBAAqB,EAAE,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IAC9C,aAAa,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC,CAAC;IACrD,OAAO,EAAE,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACvC,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,UAAU,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,IAAI,CAAC,oBAAoB,EAAE,MAAM,CAAC,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,WAAW,GAAG,SAAS,CAAC;IAC/B,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CAC7B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,qBAAqB,CAAC,EAAE,MAAM,CAAC;CAChC,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,MAAM,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAC;IACpC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAClC,QAAQ,CAAC,EAAE,UAAU,CAAC,KAAK,CAAC,CAAC;IAC7B,SAAS,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knocklabs/client",
-  "version": "0.16.5",
+  "version": "0.17.0",
   "description": "The clientside library for interacting with Knock",
   "homepage": "https://github.com/knocklabs/javascript/tree/main/packages/client",
   "author": "@knocklabs",
@@ -62,7 +62,7 @@
     "jsonwebtoken": "^9.0.2",
     "prettier": "^3.5.3",
     "rimraf": "^6.0.1",
-    "rollup": "^4.41.1",
+    "rollup": "^4.46.2",
     "typescript": "^5.8.3",
     "vite": "^5.4.19",
     "vitest": "^3.1.1"

package/src/clients/guide/client.ts

@@ -13,9 +13,14 @@ import {
   findDefaultGroup,
   formatFilters,
   mockDefaultGroup,
+  newUrl,
+  predicateUrlPatterns,
+  predicateUrlRules,
 } from "./helpers";
 import {
+  Any,
   ConstructorOpts,
+  DebugState,
   GetGuidesQueryParams,
   GetGuidesResponse,
   GroupStage,
@@ -23,6 +28,7 @@ import {
   GuideData,
   GuideGroupAddedEvent,
   GuideGroupUpdatedEvent,
+  GuideLivePreviewUpdatedEvent,
   GuideRemovedEvent,
   GuideSocketEvent,
   GuideStepData,
@@ -52,6 +58,12 @@ const DEFAULT_COUNTER_INCREMENT_INTERVAL = 30 * 1000; // in milliseconds
 // Maximum number of retry attempts for channel subscription
 const SUBSCRIBE_RETRY_LIMIT = 3;
 
+// Debug query param keys
+export const DEBUG_QUERY_PARAMS = {
+  GUIDE_KEY: "knock_guide_key",
+  PREVIEW_SESSION_ID: "knock_preview_session_id",
+};
+
 // Return the global window object if defined, so to safely guard against SSR.
 const checkForWindow = () => {
   if (typeof window !== "undefined") {
@@ -62,6 +74,20 @@ const checkForWindow = () => {
 export const guidesApiRootPath = (userId: string | undefined | null) =>
   `/v1/users/${userId}/guides`;
 
+// Detect debug params like "knock_guide_key" from URL.
+const detectDebugParams = (): DebugState => {
+  const win = checkForWindow();
+  if (!win) {
+    return { forcedGuideKey: null, previewSessionId: null };
+  }
+
+  const urlParams = new URLSearchParams(win.location.search);
+  const forcedGuideKey = urlParams.get(DEBUG_QUERY_PARAMS.GUIDE_KEY);
+  const previewSessionId = urlParams.get(DEBUG_QUERY_PARAMS.PREVIEW_SESSION_ID);
+
+  return { forcedGuideKey, previewSessionId };
+};
+
 const select = (state: StoreState, filters: SelectFilterParams = {}) => {
   // A map of selected guides as values, with its order index as keys.
   const result = new SelectionResult();
@@ -69,16 +95,37 @@ const select = (state: StoreState, filters: SelectFilterParams = {}) => {
   const defaultGroup = findDefaultGroup(state.guideGroups);
   if (!defaultGroup) return result;
 
-  const displaySequence = defaultGroup.display_sequence;
+  const displaySequence = [...defaultGroup.display_sequence];
   const location = state.location;
 
+  // If in debug mode, put the forced guide at the beginning of the display sequence.
+  if (state.debug.forcedGuideKey) {
+    const forcedKeyIndex = displaySequence.indexOf(state.debug.forcedGuideKey);
+    if (forcedKeyIndex > -1) {
+      displaySequence.splice(forcedKeyIndex, 1);
+    }
+    displaySequence.unshift(state.debug.forcedGuideKey);
+  }
+
   for (const [index, guideKey] of displaySequence.entries()) {
-    const guide = state.guides[guideKey];
+    let guide = state.guides[guideKey];
     if (!guide) continue;
 
-    const affirmed = predicate(guide, { location, filters });
+    const affirmed = predicate(guide, {
+      location,
+      filters,
+      debug: state.debug,
+    });
     if (!affirmed) continue;
 
+    // Use preview guide if it exists and matches the forced guide key
+    if (
+      state.debug.forcedGuideKey === guideKey &&
+      state.previewGuides[guideKey]
+    ) {
+      guide = state.previewGuides[guideKey];
+    }
+
     result.set(index, guide);
   }
 
@@ -89,12 +136,18 @@ const select = (state: StoreState, filters: SelectFilterParams = {}) => {
 type PredicateOpts = {
   location?: string | undefined;
   filters?: SelectFilterParams | undefined;
+  debug: DebugState;
 };
 
 const predicate = (
   guide: KnockGuide,
-  { location, filters = {} }: PredicateOpts,
+  { location, filters = {}, debug = {} }: PredicateOpts,
 ) => {
+  // Bypass filtering if debugging the current guide.
+  if (debug.forcedGuideKey === guide.key) {
+    return true;
+  }
+
   if (filters.type && filters.type !== guide.type) {
     return false;
   }
@@ -107,36 +160,17 @@ const predicate = (
     return false;
   }
 
-  const locationRules = guide.activation_location_rules || [];
-
-  if (locationRules.length > 0 && location) {
-    const allowed = locationRules.reduce<boolean | undefined>((acc, rule) => {
-      // Any matched block rule prevails so no need to evaluate further
-      // as soon as there is one.
-      if (acc === false) return false;
-
-      // At this point we either have a matched allow rule (acc is true),
-      // or no matched rule found yet (acc is undefined).
+  const url = location ? newUrl(location) : undefined;
 
-      switch (rule.directive) {
-        case "allow": {
-          // No need to evaluate more allow rules once we matched one
-          // since any matched allowed rule means allow.
-          if (acc === true) return true;
-
-          const matched = rule.pattern.test(location);
-          return matched ? true : undefined;
-        }
-
-        case "block": {
-          // Always test block rules (unless already matched to block)
-          // because they'd prevail over matched allow rules.
-          const matched = rule.pattern.test(location);
-          return matched ? false : acc;
-        }
-      }
-    }, undefined);
+  const urlRules = guide.activation_url_rules || [];
+  const urlPatterns = guide.activation_url_patterns || [];
 
+  // A guide can have either activation url rules XOR url patterns, but not both.
+  if (url && urlRules.length > 0) {
+    const allowed = predicateUrlRules(url, urlRules);
+    if (!allowed) return false;
+  } else if (url && urlPatterns.length > 0) {
+    const allowed = predicateUrlPatterns(url, urlPatterns);
     if (!allowed) return false;
   }
 
@@ -156,6 +190,7 @@ export class KnockGuideClient {
     "guide.removed",
     "guide_group.added",
     "guide_group.updated",
+    "guide.live_preview_updated",
   ];
   private subscribeRetryCount = 0;
 
@@ -181,14 +216,18 @@ export class KnockGuideClient {
 
     const location = trackLocationFromWindow ? win?.location.href : undefined;
 
+    const debug = detectDebugParams();
+
     this.store = new Store<StoreState>({
       guideGroups: [],
       guideGroupDisplayLogs: {},
       guides: {},
+      previewGuides: {},
       queries: {},
       location,
       // Increment to update the state store and trigger re-selection.
       counter: 0,
+      debug,
     });
 
     // In server environments we might not have a socket connection.
@@ -302,7 +341,14 @@ export class KnockGuideClient {
     }
 
     // Join the channel topic and subscribe to supported events.
-    const params = { ...this.targetParams, user_id: this.knock.userId };
+    const debugState = this.store.state.debug;
+    const params = {
+      ...this.targetParams,
+      user_id: this.knock.userId,
+      force_all_guides: debugState.forcedGuideKey ? true : undefined,
+      preview_session_id: debugState.previewSessionId || undefined,
+    };
+
     const newChannel = this.socket.channel(this.socketChannelTopic, params);
 
     for (const eventType of this.socketEventTypes) {
@@ -381,23 +427,41 @@ export class KnockGuideClient {
       case "guide_group.updated":
         return this.addOrReplaceGuideGroup(payload);
 
+      case "guide.live_preview_updated":
+        return this.updatePreviewGuide(payload);
+
       default:
         return;
     }
   }
 
-  setLocation(href: string) {
+  setLocation(href: string, additionalParams: Partial<StoreState> = {}) {
     // Make sure to clear out the stage.
     this.clearGroupStage();
 
-    this.store.setState((state) => ({ ...state, location: href }));
+    this.store.setState((state) => {
+      // Clear preview guides if no longer in preview mode
+      const previewGuides = additionalParams?.debug?.previewSessionId
+        ? state.previewGuides
+        : {};
+
+      return {
+        ...state,
+        ...additionalParams,
+        previewGuides,
+        location: href,
+      };
+    });
   }
 
   //
   // Store selector
   //
 
-  selectGuides(state: StoreState, filters: SelectFilterParams = {}) {
+  selectGuides<C = Any>(
+    state: StoreState,
+    filters: SelectFilterParams = {},
+  ): KnockGuide<C>[] {
     if (Object.keys(state.guides).length === 0) {
       return [];
     }
@@ -416,7 +480,10 @@ export class KnockGuideClient {
     return [...result.values()];
   }
 
-  selectGuide(state: StoreState, filters: SelectFilterParams = {}) {
+  selectGuide<C = Any>(
+    state: StoreState,
+    filters: SelectFilterParams = {},
+  ): KnockGuide<C> | undefined {
     if (Object.keys(state.guides).length === 0) {
       return undefined;
     }
@@ -539,10 +606,22 @@ export class KnockGuideClient {
     // callback to a setTimeout, but just to be safe.
     this.ensureClearTimeout();
 
+    // If in debug mode, try to resolve the forced guide, otherwise return the first non-undefined guide.
+    let resolved = undefined;
+    if (this.store.state.debug.forcedGuideKey) {
+      resolved = this.stage.ordered.find(
+        (x) => x === this.store.state.debug.forcedGuideKey,
+      );
+    }
+
+    if (!resolved) {
+      resolved = this.stage.ordered.find((x) => x !== undefined);
+    }
+
     this.stage = {
       ...this.stage,
       status: "closed",
-      resolved: this.stage.ordered.find((x) => x !== undefined),
+      resolved,
       timeoutId: null,
     };
 
@@ -706,6 +785,11 @@ export class KnockGuideClient {
       ...remoteGuide,
       // Get the next unarchived step.
       getStep() {
+        // If debugging this guide, return the first step regardless of archive status
+        if (self.store.state.debug.forcedGuideKey === this.key) {
+          return this.steps[0];
+        }
+
         return this.steps.find((s) => !s.message.archived_at);
       },
     } as KnockGuide;
@@ -741,8 +825,8 @@ export class KnockGuideClient {
       return localStep;
     });
 
-    localGuide.activation_location_rules =
-      remoteGuide.activation_location_rules.map((rule) => {
+    localGuide.activation_url_patterns =
+      remoteGuide.activation_url_patterns.map((rule) => {
         return {
           ...rule,
           pattern: new URLPattern({ pathname: rule.pathname }),
@@ -754,7 +838,16 @@ export class KnockGuideClient {
 
   private buildQueryParams(filterParams: QueryFilterParams = {}) {
     // Combine the target params with the given filter params.
-    const combinedParams = { ...this.targetParams, ...filterParams };
+    const combinedParams: GenericData = {
+      ...this.targetParams,
+      ...filterParams,
+    };
+
+    // Append debug params
+    const debugState = this.store.state.debug;
+    if (debugState.forcedGuideKey) {
+      combinedParams.force_all_guides = true;
+    }
 
     // Prune out any keys that have an undefined or null value.
     let params = Object.fromEntries(
@@ -899,6 +992,15 @@ export class KnockGuideClient {
     });
   }
 
+  private updatePreviewGuide({ data }: GuideLivePreviewUpdatedEvent) {
+    const guide = this.localCopy(data.guide);
+
+    this.store.setState((state) => {
+      const previewGuides = { ...state.previewGuides, [guide.key]: guide };
+      return { ...state, previewGuides };
+    });
+  }
+
   // Define as an arrow func property to always bind this to the class instance.
   private handleLocationChange = () => {
     const win = checkForWindow();
@@ -908,9 +1010,36 @@ export class KnockGuideClient {
     if (this.store.state.location === href) return;
 
     this.knock.log(`[Guide] Handle Location change: ${href}`);
-    this.setLocation(href);
+
+    // If entering debug mode, fetch all guides.
+    const currentDebugParams = this.store.state.debug;
+    const newDebugParams = detectDebugParams();
+    this.setLocation(href, { debug: newDebugParams });
+
+    // If debug state has changed, refetch guides and resubscribe to the websocket channel
+    const debugStateChanged = this.checkDebugStateChanged(
+      currentDebugParams,
+      newDebugParams,
+    );
+
+    if (debugStateChanged) {
+      this.knock.log(
+        `[Guide] Debug state changed, refetching guides and resubscribing to the websocket channel`,
+      );
+      this.fetch();
+      this.subscribe();
+    }
   };
 
+  // Returns whether debug params have changed. For guide key, we only check
+  // presence since the exact value has no impact on fetch/subscribe
+  private checkDebugStateChanged(a: DebugState, b: DebugState): boolean {
+    return (
+      Boolean(a.forcedGuideKey) !== Boolean(b.forcedGuideKey) ||
+      a.previewSessionId !== b.previewSessionId
+    );
+  }
+
   private listenForLocationChangesFromWindow() {
     const win = checkForWindow();
     if (win?.history) {

package/src/clients/guide/helpers.ts

@@ -1,7 +1,9 @@
 import {
+  GuideActivationUrlRuleData,
   GuideData,
   GuideGroupData,
   KnockGuide,
+  KnockGuideActivationUrlPattern,
   SelectFilterParams,
 } from "./types";
 
@@ -96,3 +98,100 @@ export const checkIfThrottled = (
   // accurate regardless of local timezones.
   return currentTimeInMilliseconds <= throttleWindowEndInMilliseconds;
 };
+
+// Safely parse and build a new URL object.
+export const newUrl = (location: string) => {
+  try {
+    return new URL(location);
+  } catch {
+    return undefined;
+  }
+};
+
+// Evaluates whether the given location url satisfies the url rule.
+export const evaluateUrlRule = (
+  url: URL,
+  urlRule: GuideActivationUrlRuleData,
+) => {
+  if (urlRule.variable === "pathname") {
+    if (urlRule.operator === "equal_to") {
+      const argument = urlRule.argument.startsWith("/")
+        ? urlRule.argument
+        : `/${urlRule.argument}`;
+
+      return argument === url.pathname;
+    }
+
+    if (urlRule.operator === "contains") {
+      return url.pathname.includes(urlRule.argument);
+    }
+
+    return false;
+  }
+
+  return false;
+};
+
+export const predicateUrlRules = (
+  url: URL,
+  urlRules: GuideActivationUrlRuleData[],
+) => {
+  return urlRules.reduce<boolean | undefined>((acc, urlRule) => {
+    // Any matched block rule prevails so no need to evaluate further
+    // as soon as there is one.
+    if (acc === false) return false;
+
+    // At this point we either have a matched allow rule (acc is true),
+    // or no matched rule found yet (acc is undefined).
+
+    switch (urlRule.directive) {
+      case "allow": {
+        // No need to evaluate more allow rules once we matched one
+        // since any matched allowed rule means allow.
+        if (acc === true) return true;
+
+        const matched = evaluateUrlRule(url, urlRule);
+        return matched ? true : undefined;
+      }
+
+      case "block": {
+        // Always test block rules (unless already matched to block)
+        // because they'd prevail over matched allow rules.
+        const matched = evaluateUrlRule(url, urlRule);
+        return matched ? false : acc;
+      }
+    }
+  }, undefined);
+};
+
+export const predicateUrlPatterns = (
+  url: URL,
+  urlPatterns: KnockGuideActivationUrlPattern[],
+) => {
+  return urlPatterns.reduce<boolean | undefined>((acc, urlPattern) => {
+    // Any matched block rule prevails so no need to evaluate further
+    // as soon as there is one.
+    if (acc === false) return false;
+
+    // At this point we either have a matched allow rule (acc is true),
+    // or no matched rule found yet (acc is undefined).
+
+    switch (urlPattern.directive) {
+      case "allow": {
+        // No need to evaluate more allow rules once we matched one
+        // since any matched allowed rule means allow.
+        if (acc === true) return true;
+
+        const matched = urlPattern.pattern.test(url);
+        return matched ? true : undefined;
+      }
+
+      case "block": {
+        // Always test block rules (unless already matched to block)
+        // because they'd prevail over matched allow rules.
+        const matched = urlPattern.pattern.test(url);
+        return matched ? false : acc;
+      }
+    }
+  }, undefined);
+};

package/src/clients/guide/index.ts

@@ -1,4 +1,4 @@
-export { KnockGuideClient } from "./client";
+export { KnockGuideClient, DEBUG_QUERY_PARAMS } from "./client";
 export type {
   KnockGuide,
   KnockGuideStep,

package/src/clients/guide/types.ts

@@ -4,6 +4,9 @@ import { GenericData } from "@knocklabs/types";
 // Fetch guides API
 //
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type Any = any;
+
 export interface StepMessageState {
   id: string;
   seen_at: string | null;
@@ -13,30 +16,37 @@ export interface StepMessageState {
   link_clicked_at: string | null;
 }
 
-export interface GuideStepData {
+export interface GuideStepData<TContent = Any> {
   ref: string;
   schema_key: string;
   schema_semver: string;
   schema_variant_key: string;
   message: StepMessageState;
-  // eslint-disable-next-line
-  content: any;
+  content: TContent;
 }
 
-interface GuideActivationLocationRuleData {
+export interface GuideActivationUrlRuleData {
+  directive: "allow" | "block";
+  variable: "pathname";
+  operator: "equal_to" | "contains";
+  argument: string;
+}
+
+interface GuideActivationUrlPatternData {
   directive: "allow" | "block";
   pathname: string;
 }
 
-export interface GuideData {
+export interface GuideData<TContent = Any> {
   __typename: "Guide";
   channel_id: string;
   id: string;
   key: string;
   type: string;
   semver: string;
-  steps: GuideStepData[];
-  activation_location_rules: GuideActivationLocationRuleData[];
+  steps: GuideStepData<TContent>[];
+  activation_url_rules: GuideActivationUrlRuleData[];
+  activation_url_patterns: GuideActivationUrlPatternData[];
   bypass_global_group_limit: boolean;
   inserted_at: string;
   updated_at: string;
@@ -57,6 +67,7 @@ export type GetGuidesQueryParams = {
   data?: string;
   tenant?: string;
   type?: string;
+  force_all_guides?: boolean;
 };
 
 export type GetGuidesResponse = {
@@ -103,7 +114,8 @@ type SocketEventType =
   | "guide.updated"
   | "guide.removed"
   | "guide_group.added"
-  | "guide_group.updated";
+  | "guide_group.updated"
+  | "guide.live_preview_updated";
 
 type SocketEventPayload<E extends SocketEventType, D> = {
   topic: string;
@@ -136,32 +148,39 @@ export type GuideGroupUpdatedEvent = SocketEventPayload<
   { guide_group: GuideGroupData }
 >;
 
+export type GuideLivePreviewUpdatedEvent = SocketEventPayload<
+  "guide.live_preview_updated",
+  { guide: GuideData; eligible: boolean }
+>;
+
 export type GuideSocketEvent =
   | GuideAddedEvent
   | GuideUpdatedEvent
   | GuideRemovedEvent
   | GuideGroupAddedEvent
-  | GuideGroupUpdatedEvent;
+  | GuideGroupUpdatedEvent
+  | GuideLivePreviewUpdatedEvent;
 
 //
 // Guide client
 //
 
-export interface KnockGuideStep extends GuideStepData {
+export interface KnockGuideStep<TContent = Any>
+  extends GuideStepData<TContent> {
   markAsSeen: () => void;
   markAsInteracted: (params?: { metadata?: GenericData }) => void;
   markAsArchived: () => void;
 }
 
-interface KnockGuideActivationLocationRule
-  extends GuideActivationLocationRuleData {
+export interface KnockGuideActivationUrlPattern
+  extends GuideActivationUrlPatternData {
   pattern: URLPattern;
 }
 
-export interface KnockGuide extends GuideData {
-  steps: KnockGuideStep[];
-  activation_location_rules: KnockGuideActivationLocationRule[];
-  getStep: () => KnockGuideStep | undefined;
+export interface KnockGuide<TContent = Any> extends GuideData<TContent> {
+  steps: KnockGuideStep<TContent>[];
+  activation_url_patterns: KnockGuideActivationUrlPattern[];
+  getStep: () => KnockGuideStep<TContent> | undefined;
 }
 
 type QueryKey = string;
@@ -171,13 +190,20 @@ export type QueryStatus = {
   error?: Error;
 };
 
+export type DebugState = {
+  forcedGuideKey?: string | null;
+  previewSessionId?: string | null;
+};
+
 export type StoreState = {
   guideGroups: GuideGroupData[];
   guideGroupDisplayLogs: Record<GuideGroupData["key"], string>;
   guides: Record<KnockGuide["key"], KnockGuide>;
+  previewGuides: Record<KnockGuide["key"], KnockGuide>;
   queries: Record<QueryKey, QueryStatus>;
   location: string | undefined;
   counter: number;
+  debug: DebugState;
 };
 
 export type QueryFilterParams = Pick<GetGuidesQueryParams, "type">;