@frigade/js 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Frigade
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,83 @@
+[![npm version](https://img.shields.io/npm/v/@frigade/js)](https://www.npmjs.com/package/@frigade/js)
+[![npm version](https://github.com/FrigadeHQ/frigade-js/actions/workflows/tests.yml/badge.svg)](https://github.com/FrigadeHQ/frigade-js/actions/workflows/tests.yml)
+[![typescript](https://camo.githubusercontent.com/0f9fcc0ac1b8617ad4989364f60f78b2d6b32985ad6a508f215f14d8f897b8d3/68747470733a2f2f62616467656e2e6e65742f62616467652f547970655363726970742f7374726963742532302546302539462539322541412f626c7565)](https://www.npmjs.com/package/@frigade/js)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+
+<H3 align="center"><strong>Frigade Javascript SDK</strong></H3>
+<div align="center">The easiest way for developers to build high-quality product onboarding and education.</div>
+<br />
+<div align="center">
+<a href="https://frigade.com">Website</a> 
+<span> · </span>
+<a href="https://demo.frigade.com">Demo</a> 
+<span> · </span>
+<a href="https://github.com/FrigadeHQ">GitHub</a> 
+<span> · </span>
+<a href="https://docs.frigade.com">Docs</a></div>
+
+<br />
+
+![Frigade iamge](https://frigade.com/img/frigademetaimage-v2.png)
+
+## Install
+
+Install the package from your command line.
+
+#### With yarn
+
+```bash
+yarn add @frigade/js
+```
+
+#### With npm
+
+```bash
+npm install @frigade/js
+```
+
+### About Frigade
+
+[Frigade](<https://frigade.com>) is a developer-first platform for building quality product onboarding. A powerful,
+flexible API and native SDKs allow you to build onboarding 10x faster, experiment more easily, and drive customer
+success.
+
+Frigade supports a series of use cases such as:
+
+- **Registration**: Maximize the number of users getting through your sign up flows with beautiful explainers, progress
+  bars, and forms.
+- **Activation**: Convert more customers by taking them through a series of key onboarding items specific to their role,
+  permissions, or goals.
+- **Adoption**: Introduce audiences to specific features that deliver value with native hotspots, tooltips, tours, and
+  interactive product guides.
+- **Engagement**: Keep active customers engaged, announce new product features, and create lifecycle specific
+  re-onboarding flows for dormant or churned customers.
+- **Retention**: Increase retention by delivering the right content at the right time, and by asking your users for
+  feedback on the product.
+
+# Features
+
+**Component Library**
+
+Unstyled, ready-made components for building high‑quality user onboarding, faster. Onboarding checklists, tooltips,
+product walkthroughs, and much more. [See components](https://frigade.com/components)
+
+**Integrations**
+
+Integrations with Segment, Mixpanel, Posthog, and more to power targeting, analytics, and communications.
+
+**Content Management**
+
+Lightweight CMS built-in to update and test onboarding copy and content.
+
+**Versioning**
+
+Frigade makes it easy to manage multiple versions of onboarding across staging and production. Revisit previous versions
+of onboarding to see how they performed and make improvements.
+
+**Customer Journeys**
+
+Frigade automatically tracks state management and onboarding progress. Give your team full observability into the
+customer journey, and use Frigade to kick off automated workflows.
+
+To learn more, visit [frigade.com](<https://frigade.com>)
+

package/lib/index.d.ts

@@ -0,0 +1,188 @@
+interface FlowStepData {
+    /**
+     * Unique identifier for the step.
+     */
+    id: string;
+    /**
+     * Name of the step when shown in a list view
+     */
+    stepName?: string;
+    /**
+     * Title of the step
+     */
+    title?: string;
+    /**
+     * Subtitle of the step
+     */
+    subtitle?: string;
+    /**
+     * Primary button title. If omitted, the primary button will not be shown.
+     */
+    primaryButtonTitle?: string;
+    /**
+     * Primary button URI.
+     */
+    primaryButtonUri?: string;
+    /**
+     * Primary button URI target (either _blank or _self)
+     */
+    primaryButtonUriTarget?: string;
+    /**
+     * Secondary button title. If omitted, the secondary button will not be shown.
+     */
+    secondaryButtonTitle?: string;
+    /**
+     * Secondary button URI.
+     */
+    secondaryButtonUri?: string;
+    /**
+     * Secondary button URI target (either _blank or _self)
+     */
+    secondaryButtonUriTarget?: string;
+    /**
+     * Text on button if a back button is present
+     */
+    backButtonTitle?: string;
+    /**
+     * If true, the step will be marked as completed when the secondary button is clicked.
+     */
+    skippable?: boolean;
+    /**
+     * Video url to be shown for components supporting video.
+     */
+    videoUri?: string;
+    /**
+     * Image url to be shown for components supporting image.
+     */
+    imageUri?: string | null;
+    /**
+     * Automatically mark the step as completed when the primary button is clicked. Default is false.
+     */
+    autoMarkCompleted?: boolean;
+    /**
+     * Whether the step has been completed (equivalent to step status === COMPLETED_STEP)
+     */
+    complete: boolean;
+    /**
+     * Whether the step is blocked (can't be accessed yet) based on `startCriteria`
+     */
+    blocked?: boolean;
+    /**
+     * Whether the step is hidden (not shown in the list view) based on `visibilityCriteria`
+     */
+    hidden?: boolean;
+    /**
+     * Handler for when the primary button is clicked.
+     */
+    handlePrimaryButtonClick?: () => void;
+    /**
+     * Handler for when the secondary button is clicked.
+     */
+    handleSecondaryButtonClick?: () => void;
+    props?: any;
+    /**
+     * Criteria that needs to be met for the step to complete
+     */
+    completionCriteria?: string;
+    /**
+     * Criteria that needs to be met for the step to start
+     */
+    startCriteria?: string;
+    /**
+     * Progress if the step is tied to another Frigade Flow through completionCriteria
+     */
+    progress?: number;
+    /**
+     * Whether the step is dismissible (for instance, tooltips or other non-essential steps)
+     */
+    dismissible?: boolean;
+}
+interface FrigadeConfig {
+    /**
+     * API url to use for all requests. Defaults to https://api.frigade.com
+     */
+    apiUrl?: string;
+}
+
+interface FlowMetadata {
+    id: number;
+    name: string;
+    description: string;
+    data: string;
+    createdAt: string;
+    modifiedAt: string;
+    slug: string;
+    targetingLogic: string;
+    type: FlowType;
+    triggerType: TriggerType;
+    status: FlowStatus;
+    version: number;
+    active: boolean;
+}
+declare enum FlowType {
+    CHECKLIST = "CHECKLIST",
+    FORM = "FORM",
+    TOUR = "TOUR",
+    SUPPORT = "SUPPORT",
+    CUSTOM = "CUSTOM",
+    BANNER = "BANNER",
+    EMBEDDED_TIP = "EMBEDDED_TIP",
+    NPS_SURVEY = "NPS_SURVEY"
+}
+declare enum TriggerType {
+    MANUAL = "MANUAL",
+    AUTOMATIC = "AUTOMATIC"
+}
+declare enum FlowStatus {
+    DRAFT = "DRAFT",
+    ACTIVE = "ACTIVE",
+    ARCHIVED = "ARCHIVED"
+}
+
+declare class Flow {
+    /**
+     * THe Flow ID / slug of the flow
+     */
+    readonly id: string;
+    /**
+     * The status of the flow
+     */
+    readonly status: FlowStatus;
+    /**
+     * The raw data defined in `flow-data.yml` as a JSON decoded object
+     */
+    readonly flowData: Record<any, any>;
+    /**
+     * The steps contained in the `data` array in `flow-data.yml`
+     */
+    readonly steps: FlowStepData[];
+    /**
+     * The user-facing title of the flow, if defined at the top level of `flow-data.yml`
+     */
+    readonly title?: string;
+    /**
+     * The user-facing description of the flow, if defined at the top level of `flow-data.yml`
+     */
+    readonly subtitle?: string;
+    /**
+     * The metadata of the flow.
+     */
+    readonly metadata: FlowMetadata;
+    constructor(id: string, status: FlowStatus, rawData: Record<any, any>, steps: FlowStepData[], title?: string, subtitle?: string);
+}
+
+declare class Frigade {
+    readonly apiKey?: string;
+    readonly userId?: string;
+    readonly organizationId?: string;
+    readonly config?: FrigadeConfig;
+    hasInitialized: boolean;
+    private flows;
+    constructor(apiKey: string, userId?: string, organizationId?: string, config?: FrigadeConfig);
+    init(): Promise<void>;
+    getFlow(flowId: string): Promise<Flow>;
+    private errorOnUninitialized;
+    private refreshFlows;
+}
+
+export { Flow, Frigade as default };

package/lib/index.js

@@ -0,0 +1,3 @@
+"use client";
+var d=Object.defineProperty;var S=Object.getOwnPropertyDescriptor;var w=Object.getOwnPropertyNames;var E=Object.prototype.hasOwnProperty;var y=(e,t)=>{for(var o in t)d(e,o,{get:t[o],enumerable:!0})},h=(e,t,o,r)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of w(t))!E.call(e,i)&&i!==o&&d(e,i,{get:()=>t[i],enumerable:!(r=S(t,i))||r.enumerable});return e};var F=e=>h(d({},"__esModule",{value:!0}),e);var R={};y(R,{Flow:()=>a,default:()=>A});module.exports=F(R);var f="1.32.18";var O="frigade-last-call-at-",_="frigade-last-call-data-";function D(e){return{config:{headers:{Authorization:`Bearer ${e}`,"Content-Type":"application/json","X-Frigade-SDK-Version":f,"X-Frigade-SDK-Platform":"Javascript"}}}}function g(e){return window&&window.localStorage?window.localStorage.getItem(e):null}function T(e,t){window&&window.localStorage&&window.localStorage.setItem(e,t)}async function m(e,t){let o=O+e,r=_+e;if(window&&window.localStorage&&t&&t.body&&t.method==="POST"){let n=g(o),l=g(r);if(n&&l&&l==t.body){let p=new Date(n);if(new Date().getTime()-p.getTime()<1e3)return c()}T(o,new Date().toISOString()),T(r,t.body)}let i;try{i=await fetch(e,t)}catch(n){return c(n)}return i?i.ok?i:c(i.statusText):c()}function c(e){return e&&console.log("Call to Frigade failed",e),{json:()=>({})}}function u(e,t,o){return m(L(e,t),{...o??{},...D(e)})}function L(e,t){return`${e}/public/v1${t}`}var a=class{constructor(t,o,r,i,n,l){this.id=t,this.status=o,this.flowData=r,this.steps=i,this.title=n,this.subtitle=l}};var s=class{constructor(t,o,r,i){this.hasInitialized=!1;this.flows=[];this.apiKey=t,this.userId=o,this.organizationId=r,this.config=i}async init(){return await this.refreshFlows(),this.hasInitialized=!0,Promise.any(null)}async getFlow(t){return this.errorOnUninitialized(),this.flows.find(o=>o.id==t)}errorOnUninitialized(){if(!this.hasInitialized)throw new Error("Frigade has not been initialized yet. Please call Frigade.init() before using any other methods.")}async refreshFlows(){this.flows=[];let t=await u(this.apiKey,"/flows");t&&t.data&&t.data.forEach(r=>{let i=JSON.parse(r.data);this.flows.push(new a(r.slug,r.status,i,(i==null?void 0:i.data)??[],i==null?void 0:i.title,i==null?void 0:i.subtitle))})}};var A=s;0&&(module.exports={Flow});
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/core/version.ts","../src/shared/utils.ts","../src/core/flow.ts","../src/core/frigade.ts"],"sourcesContent":["import Frigade from './core/frigade'\nimport Flow from './core/flow'\n\nexport { Flow }\nexport default Frigade\n","export const VERSION_NUMBER = '1.32.18'\n","import { VERSION_NUMBER } from '../core/version'\n\nexport const NOT_STARTED_STEP = 'NOT_STARTED_STEP'\nexport const COMPLETED_FLOW = 'COMPLETED_FLOW'\nexport const ABORTED_FLOW = 'ABORTED_FLOW'\nexport const STARTED_FLOW = 'STARTED_FLOW'\nexport const NOT_STARTED_FLOW = 'NOT_STARTED_FLOW'\nexport const COMPLETED_STEP = 'COMPLETED_STEP'\nexport const STARTED_STEP = 'STARTED_STEP'\nexport type StepActionType = 'STARTED_STEP' | 'COMPLETED_STEP' | 'NOT_STARTED_STEP'\nexport type UserFlowStatus = 'NOT_STARTED_FLOW' | 'STARTED_FLOW' | 'COMPLETED_FLOW' | 'ABORTED_FLOW'\nconst LAST_POST_CALL_AT = 'frigade-last-call-at-'\nconst LAST_POST_CALL_DATA = 'frigade-last-call-data-'\n\nfunction getConfig(apiKey: string) {\n  return {\n    config: {\n      headers: {\n        Authorization: `Bearer ${apiKey}`,\n        'Content-Type': 'application/json',\n        'X-Frigade-SDK-Version': VERSION_NUMBER,\n        'X-Frigade-SDK-Platform': 'Javascript',\n      },\n    },\n  }\n}\n\nfunction getLocalStorage(key: string) {\n  if (window && window.localStorage) {\n    return window.localStorage.getItem(key)\n  }\n  return null\n}\n\nfunction setLocalStorage(key: string, value: string) {\n  if (window && window.localStorage) {\n    window.localStorage.setItem(key, value)\n  }\n}\n\nexport async function gracefulFetch(url: string, options: any) {\n  const lastCallAtKey = LAST_POST_CALL_AT + url\n  const lastCallDataKey = LAST_POST_CALL_DATA + url\n  if (window && window.localStorage && options && options.body && options.method === 'POST') {\n    const lastCall = getLocalStorage(lastCallAtKey)\n    const lastCallData = getLocalStorage(lastCallDataKey)\n    if (lastCall && lastCallData && lastCallData == options.body) {\n      const lastCallDate = new Date(lastCall)\n      const now = new Date()\n      const diff = now.getTime() - lastCallDate.getTime()\n      // Throttle consecutive POST calls to 1 second\n      if (diff < 1000) {\n        return getEmptyResponse()\n      }\n    }\n    setLocalStorage(lastCallAtKey, new Date().toISOString())\n    setLocalStorage(lastCallDataKey, options.body)\n  }\n\n  let response\n  try {\n    response = await fetch(url, options)\n  } catch (error) {\n    return getEmptyResponse(error)\n  }\n\n  if (!response) {\n    return getEmptyResponse()\n  }\n\n  if (!response.ok) {\n    return getEmptyResponse(response.statusText)\n  }\n\n  return response\n}\n\nfunction getEmptyResponse(error?: any) {\n  if (error) {\n    console.log('Call to Frigade failed', error)\n  }\n\n  // Create empty response that contains the .json method and returns an empty object\n  return {\n    json: () => ({}),\n  }\n}\n\nexport function fetcher(apiKey: string, url: string, options?: Record<any, any>) {\n  return gracefulFetch(getUrl(apiKey, url), {\n    ...(options ?? {}),\n    ...getConfig(apiKey),\n  })\n}\n\nfunction getUrl(apiUrl: string, postfix: string) {\n  return `${apiUrl}/public/v1${postfix}`\n}\n","import { FlowStepData } from '../types'\nimport { FlowMetadata, FlowStatus } from './types'\n\nexport default class Flow {\n  /**\n   * THe Flow ID / slug of the flow\n   */\n  public readonly id: string\n  /**\n   * The status of the flow\n   */\n  public readonly status: FlowStatus\n  /**\n   * The raw data defined in `flow-data.yml` as a JSON decoded object\n   */\n  public readonly flowData: Record<any, any>\n  /**\n   * The steps contained in the `data` array in `flow-data.yml`\n   */\n  public readonly steps: FlowStepData[]\n  /**\n   * The user-facing title of the flow, if defined at the top level of `flow-data.yml`\n   */\n  public readonly title?: string\n  /**\n   * The user-facing description of the flow, if defined at the top level of `flow-data.yml`\n   */\n  public readonly subtitle?: string\n  /**\n   * The metadata of the flow.\n   */\n  public readonly metadata: FlowMetadata\n\n  constructor(\n    id: string,\n    status: FlowStatus,\n    rawData: Record<any, any>,\n    steps: FlowStepData[],\n    title?: string,\n    subtitle?: string\n  ) {\n    this.id = id\n    this.status = status\n    this.flowData = rawData\n    this.steps = steps\n    this.title = title\n    this.subtitle = subtitle\n  }\n}\n","import { FrigadeConfig } from '../types'\nimport { fetcher } from '../shared/utils'\nimport Flow from './flow'\nimport { FlowMetadata } from './types'\n\nexport default class Frigade {\n  public readonly apiKey?: string\n  public readonly userId?: string\n  public readonly organizationId?: string\n  public readonly config?: FrigadeConfig\n  public hasInitialized = false\n\n  private flows: Flow[] = []\n\n  constructor(apiKey: string, userId?: string, organizationId?: string, config?: FrigadeConfig) {\n    this.apiKey = apiKey\n    this.userId = userId\n    this.organizationId = organizationId\n    this.config = config\n  }\n\n  public async init(): Promise<void> {\n    await this.refreshFlows()\n    this.hasInitialized = true\n    return Promise.any(null)\n  }\n\n  public async getFlow(flowId: string) {\n    this.errorOnUninitialized()\n    return this.flows.find((flow) => flow.id == flowId)\n  }\n\n  private errorOnUninitialized() {\n    if (!this.hasInitialized) {\n      throw new Error(\n        'Frigade has not been initialized yet. Please call Frigade.init() before using any other methods.'\n      )\n    }\n  }\n\n  private async refreshFlows() {\n    this.flows = []\n    const flowDataRaw = await fetcher(this.apiKey, '/flows')\n    if (flowDataRaw && flowDataRaw.data) {\n      let flowMetadatas = flowDataRaw.data as FlowMetadata[]\n      flowMetadatas.forEach((flowMetadata) => {\n        const rawData = JSON.parse(flowMetadata.data)\n        this.flows.push(\n          new Flow(\n            flowMetadata.slug,\n            flowMetadata.status,\n            rawData,\n            rawData?.data ?? [],\n            rawData?.title,\n            rawData?.subtitle\n          )\n        )\n      })\n    }\n  }\n}\n"],"mappings":";4ZAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,UAAAE,EAAA,YAAAC,IAAA,eAAAC,EAAAJ,GCAO,IAAMK,EAAiB,UCW9B,IAAMC,EAAoB,wBACpBC,EAAsB,0BAE5B,SAASC,EAAUC,EAAgB,CACjC,MAAO,CACL,OAAQ,CACN,QAAS,CACP,cAAe,UAAUA,IACzB,eAAgB,mBAChB,wBAAyBC,EACzB,yBAA0B,YAC5B,CACF,CACF,CACF,CAEA,SAASC,EAAgBC,EAAa,CACpC,OAAI,QAAU,OAAO,aACZ,OAAO,aAAa,QAAQA,CAAG,EAEjC,IACT,CAEA,SAASC,EAAgBD,EAAaE,EAAe,CAC/C,QAAU,OAAO,cACnB,OAAO,aAAa,QAAQF,EAAKE,CAAK,CAE1C,CAEA,eAAsBC,EAAcC,EAAaC,EAAc,CAC7D,IAAMC,EAAgBZ,EAAoBU,EACpCG,EAAkBZ,EAAsBS,EAC9C,GAAI,QAAU,OAAO,cAAgBC,GAAWA,EAAQ,MAAQA,EAAQ,SAAW,OAAQ,CACzF,IAAMG,EAAWT,EAAgBO,CAAa,EACxCG,EAAeV,EAAgBQ,CAAe,EACpD,GAAIC,GAAYC,GAAgBA,GAAgBJ,EAAQ,KAAM,CAC5D,IAAMK,EAAe,IAAI,KAAKF,CAAQ,EAItC,GAHY,IAAI,KAAK,EACJ,QAAQ,EAAIE,EAAa,QAAQ,EAEvC,IACT,OAAOC,EAAiB,EAG5BV,EAAgBK,EAAe,IAAI,KAAK,EAAE,YAAY,CAAC,EACvDL,EAAgBM,EAAiBF,EAAQ,IAAI,EAG/C,IAAIO,EACJ,GAAI,CACFA,EAAW,MAAM,MAAMR,EAAKC,CAAO,CACrC,OAASQ,EAAP,CACA,OAAOF,EAAiBE,CAAK,CAC/B,CAEA,OAAKD,EAIAA,EAAS,GAIPA,EAHED,EAAiBC,EAAS,UAAU,EAJpCD,EAAiB,CAQ5B,CAEA,SAASA,EAAiBE,EAAa,CACrC,OAAIA,GACF,QAAQ,IAAI,yBAA0BA,CAAK,EAItC,CACL,KAAM,KAAO,CAAC,EAChB,CACF,CAEO,SAASC,EAAQjB,EAAgBO,EAAaC,EAA4B,CAC/E,OAAOF,EAAcY,EAAOlB,EAAQO,CAAG,EAAG,CACxC,GAAIC,GAAW,CAAC,EAChB,GAAGT,EAAUC,CAAM,CACrB,CAAC,CACH,CAEA,SAASkB,EAAOC,EAAgBC,EAAiB,CAC/C,MAAO,GAAGD,cAAmBC,GAC/B,CC9FA,IAAqBC,EAArB,KAA0B,CA8BxB,YACEC,EACAC,EACAC,EACAC,EACAC,EACAC,EACA,CACA,KAAK,GAAKL,EACV,KAAK,OAASC,EACd,KAAK,SAAWC,EAChB,KAAK,MAAQC,EACb,KAAK,MAAQC,EACb,KAAK,SAAWC,CAClB,CACF,EC3CA,IAAqBC,EAArB,KAA6B,CAS3B,YAAYC,EAAgBC,EAAiBC,EAAyBC,EAAwB,CAJ9F,KAAO,eAAiB,GAExB,KAAQ,MAAgB,CAAC,EAGvB,KAAK,OAASH,EACd,KAAK,OAASC,EACd,KAAK,eAAiBC,EACtB,KAAK,OAASC,CAChB,CAEA,MAAa,MAAsB,CACjC,aAAM,KAAK,aAAa,EACxB,KAAK,eAAiB,GACf,QAAQ,IAAI,IAAI,CACzB,CAEA,MAAa,QAAQC,EAAgB,CACnC,YAAK,qBAAqB,EACnB,KAAK,MAAM,KAAMC,GAASA,EAAK,IAAMD,CAAM,CACpD,CAEQ,sBAAuB,CAC7B,GAAI,CAAC,KAAK,eACR,MAAM,IAAI,MACR,kGACF,CAEJ,CAEA,MAAc,cAAe,CAC3B,KAAK,MAAQ,CAAC,EACd,IAAME,EAAc,MAAMC,EAAQ,KAAK,OAAQ,QAAQ,EACnDD,GAAeA,EAAY,MACTA,EAAY,KAClB,QAASE,GAAiB,CACtC,IAAMC,EAAU,KAAK,MAAMD,EAAa,IAAI,EAC5C,KAAK,MAAM,KACT,IAAIE,EACFF,EAAa,KACbA,EAAa,OACbC,GACAA,GAAA,YAAAA,EAAS,OAAQ,CAAC,EAClBA,GAAA,YAAAA,EAAS,MACTA,GAAA,YAAAA,EAAS,QACX,CACF,CACF,CAAC,CAEL,CACF,EJxDA,IAAOE,EAAQC","names":["src_exports","__export","Flow","src_default","__toCommonJS","VERSION_NUMBER","LAST_POST_CALL_AT","LAST_POST_CALL_DATA","getConfig","apiKey","VERSION_NUMBER","getLocalStorage","key","setLocalStorage","value","gracefulFetch","url","options","lastCallAtKey","lastCallDataKey","lastCall","lastCallData","lastCallDate","getEmptyResponse","response","error","fetcher","getUrl","apiUrl","postfix","Flow","id","status","rawData","steps","title","subtitle","Frigade","apiKey","userId","organizationId","config","flowId","flow","flowDataRaw","fetcher","flowMetadata","rawData","Flow","src_default","Frigade"]}

package/lib/index.mjs

@@ -0,0 +1,3 @@
+"use client";
+var d="1.32.18";var p="frigade-last-call-at-",S="frigade-last-call-data-";function w(i){return{config:{headers:{Authorization:`Bearer ${i}`,"Content-Type":"application/json","X-Frigade-SDK-Version":d,"X-Frigade-SDK-Platform":"Javascript"}}}}function f(i){return window&&window.localStorage?window.localStorage.getItem(i):null}function g(i,t){window&&window.localStorage&&window.localStorage.setItem(i,t)}async function E(i,t){let o=p+i,r=S+i;if(window&&window.localStorage&&t&&t.body&&t.method==="POST"){let a=f(o),l=f(r);if(a&&l&&l==t.body){let u=new Date(a);if(new Date().getTime()-u.getTime()<1e3)return c()}g(o,new Date().toISOString()),g(r,t.body)}let e;try{e=await fetch(i,t)}catch(a){return c(a)}return e?e.ok?e:c(e.statusText):c()}function c(i){return i&&console.log("Call to Frigade failed",i),{json:()=>({})}}function T(i,t,o){return E(y(i,t),{...o??{},...w(i)})}function y(i,t){return`${i}/public/v1${t}`}var n=class{constructor(t,o,r,e,a,l){this.id=t,this.status=o,this.flowData=r,this.steps=e,this.title=a,this.subtitle=l}};var s=class{constructor(t,o,r,e){this.hasInitialized=!1;this.flows=[];this.apiKey=t,this.userId=o,this.organizationId=r,this.config=e}async init(){return await this.refreshFlows(),this.hasInitialized=!0,Promise.any(null)}async getFlow(t){return this.errorOnUninitialized(),this.flows.find(o=>o.id==t)}errorOnUninitialized(){if(!this.hasInitialized)throw new Error("Frigade has not been initialized yet. Please call Frigade.init() before using any other methods.")}async refreshFlows(){this.flows=[];let t=await T(this.apiKey,"/flows");t&&t.data&&t.data.forEach(r=>{let e=JSON.parse(r.data);this.flows.push(new n(r.slug,r.status,e,(e==null?void 0:e.data)??[],e==null?void 0:e.title,e==null?void 0:e.subtitle))})}};var C=s;export{n as Flow,C as default};
+//# sourceMappingURL=index.mjs.map

package/lib/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/core/version.ts","../src/shared/utils.ts","../src/core/flow.ts","../src/core/frigade.ts","../src/index.ts"],"sourcesContent":["export const VERSION_NUMBER = '1.32.18'\n","import { VERSION_NUMBER } from '../core/version'\n\nexport const NOT_STARTED_STEP = 'NOT_STARTED_STEP'\nexport const COMPLETED_FLOW = 'COMPLETED_FLOW'\nexport const ABORTED_FLOW = 'ABORTED_FLOW'\nexport const STARTED_FLOW = 'STARTED_FLOW'\nexport const NOT_STARTED_FLOW = 'NOT_STARTED_FLOW'\nexport const COMPLETED_STEP = 'COMPLETED_STEP'\nexport const STARTED_STEP = 'STARTED_STEP'\nexport type StepActionType = 'STARTED_STEP' | 'COMPLETED_STEP' | 'NOT_STARTED_STEP'\nexport type UserFlowStatus = 'NOT_STARTED_FLOW' | 'STARTED_FLOW' | 'COMPLETED_FLOW' | 'ABORTED_FLOW'\nconst LAST_POST_CALL_AT = 'frigade-last-call-at-'\nconst LAST_POST_CALL_DATA = 'frigade-last-call-data-'\n\nfunction getConfig(apiKey: string) {\n  return {\n    config: {\n      headers: {\n        Authorization: `Bearer ${apiKey}`,\n        'Content-Type': 'application/json',\n        'X-Frigade-SDK-Version': VERSION_NUMBER,\n        'X-Frigade-SDK-Platform': 'Javascript',\n      },\n    },\n  }\n}\n\nfunction getLocalStorage(key: string) {\n  if (window && window.localStorage) {\n    return window.localStorage.getItem(key)\n  }\n  return null\n}\n\nfunction setLocalStorage(key: string, value: string) {\n  if (window && window.localStorage) {\n    window.localStorage.setItem(key, value)\n  }\n}\n\nexport async function gracefulFetch(url: string, options: any) {\n  const lastCallAtKey = LAST_POST_CALL_AT + url\n  const lastCallDataKey = LAST_POST_CALL_DATA + url\n  if (window && window.localStorage && options && options.body && options.method === 'POST') {\n    const lastCall = getLocalStorage(lastCallAtKey)\n    const lastCallData = getLocalStorage(lastCallDataKey)\n    if (lastCall && lastCallData && lastCallData == options.body) {\n      const lastCallDate = new Date(lastCall)\n      const now = new Date()\n      const diff = now.getTime() - lastCallDate.getTime()\n      // Throttle consecutive POST calls to 1 second\n      if (diff < 1000) {\n        return getEmptyResponse()\n      }\n    }\n    setLocalStorage(lastCallAtKey, new Date().toISOString())\n    setLocalStorage(lastCallDataKey, options.body)\n  }\n\n  let response\n  try {\n    response = await fetch(url, options)\n  } catch (error) {\n    return getEmptyResponse(error)\n  }\n\n  if (!response) {\n    return getEmptyResponse()\n  }\n\n  if (!response.ok) {\n    return getEmptyResponse(response.statusText)\n  }\n\n  return response\n}\n\nfunction getEmptyResponse(error?: any) {\n  if (error) {\n    console.log('Call to Frigade failed', error)\n  }\n\n  // Create empty response that contains the .json method and returns an empty object\n  return {\n    json: () => ({}),\n  }\n}\n\nexport function fetcher(apiKey: string, url: string, options?: Record<any, any>) {\n  return gracefulFetch(getUrl(apiKey, url), {\n    ...(options ?? {}),\n    ...getConfig(apiKey),\n  })\n}\n\nfunction getUrl(apiUrl: string, postfix: string) {\n  return `${apiUrl}/public/v1${postfix}`\n}\n","import { FlowStepData } from '../types'\nimport { FlowMetadata, FlowStatus } from './types'\n\nexport default class Flow {\n  /**\n   * THe Flow ID / slug of the flow\n   */\n  public readonly id: string\n  /**\n   * The status of the flow\n   */\n  public readonly status: FlowStatus\n  /**\n   * The raw data defined in `flow-data.yml` as a JSON decoded object\n   */\n  public readonly flowData: Record<any, any>\n  /**\n   * The steps contained in the `data` array in `flow-data.yml`\n   */\n  public readonly steps: FlowStepData[]\n  /**\n   * The user-facing title of the flow, if defined at the top level of `flow-data.yml`\n   */\n  public readonly title?: string\n  /**\n   * The user-facing description of the flow, if defined at the top level of `flow-data.yml`\n   */\n  public readonly subtitle?: string\n  /**\n   * The metadata of the flow.\n   */\n  public readonly metadata: FlowMetadata\n\n  constructor(\n    id: string,\n    status: FlowStatus,\n    rawData: Record<any, any>,\n    steps: FlowStepData[],\n    title?: string,\n    subtitle?: string\n  ) {\n    this.id = id\n    this.status = status\n    this.flowData = rawData\n    this.steps = steps\n    this.title = title\n    this.subtitle = subtitle\n  }\n}\n","import { FrigadeConfig } from '../types'\nimport { fetcher } from '../shared/utils'\nimport Flow from './flow'\nimport { FlowMetadata } from './types'\n\nexport default class Frigade {\n  public readonly apiKey?: string\n  public readonly userId?: string\n  public readonly organizationId?: string\n  public readonly config?: FrigadeConfig\n  public hasInitialized = false\n\n  private flows: Flow[] = []\n\n  constructor(apiKey: string, userId?: string, organizationId?: string, config?: FrigadeConfig) {\n    this.apiKey = apiKey\n    this.userId = userId\n    this.organizationId = organizationId\n    this.config = config\n  }\n\n  public async init(): Promise<void> {\n    await this.refreshFlows()\n    this.hasInitialized = true\n    return Promise.any(null)\n  }\n\n  public async getFlow(flowId: string) {\n    this.errorOnUninitialized()\n    return this.flows.find((flow) => flow.id == flowId)\n  }\n\n  private errorOnUninitialized() {\n    if (!this.hasInitialized) {\n      throw new Error(\n        'Frigade has not been initialized yet. Please call Frigade.init() before using any other methods.'\n      )\n    }\n  }\n\n  private async refreshFlows() {\n    this.flows = []\n    const flowDataRaw = await fetcher(this.apiKey, '/flows')\n    if (flowDataRaw && flowDataRaw.data) {\n      let flowMetadatas = flowDataRaw.data as FlowMetadata[]\n      flowMetadatas.forEach((flowMetadata) => {\n        const rawData = JSON.parse(flowMetadata.data)\n        this.flows.push(\n          new Flow(\n            flowMetadata.slug,\n            flowMetadata.status,\n            rawData,\n            rawData?.data ?? [],\n            rawData?.title,\n            rawData?.subtitle\n          )\n        )\n      })\n    }\n  }\n}\n","import Frigade from './core/frigade'\nimport Flow from './core/flow'\n\nexport { Flow }\nexport default Frigade\n"],"mappings":";AAAO,IAAMA,EAAiB,UCW9B,IAAMC,EAAoB,wBACpBC,EAAsB,0BAE5B,SAASC,EAAUC,EAAgB,CACjC,MAAO,CACL,OAAQ,CACN,QAAS,CACP,cAAe,UAAUA,IACzB,eAAgB,mBAChB,wBAAyBC,EACzB,yBAA0B,YAC5B,CACF,CACF,CACF,CAEA,SAASC,EAAgBC,EAAa,CACpC,OAAI,QAAU,OAAO,aACZ,OAAO,aAAa,QAAQA,CAAG,EAEjC,IACT,CAEA,SAASC,EAAgBD,EAAaE,EAAe,CAC/C,QAAU,OAAO,cACnB,OAAO,aAAa,QAAQF,EAAKE,CAAK,CAE1C,CAEA,eAAsBC,EAAcC,EAAaC,EAAc,CAC7D,IAAMC,EAAgBZ,EAAoBU,EACpCG,EAAkBZ,EAAsBS,EAC9C,GAAI,QAAU,OAAO,cAAgBC,GAAWA,EAAQ,MAAQA,EAAQ,SAAW,OAAQ,CACzF,IAAMG,EAAWT,EAAgBO,CAAa,EACxCG,EAAeV,EAAgBQ,CAAe,EACpD,GAAIC,GAAYC,GAAgBA,GAAgBJ,EAAQ,KAAM,CAC5D,IAAMK,EAAe,IAAI,KAAKF,CAAQ,EAItC,GAHY,IAAI,KAAK,EACJ,QAAQ,EAAIE,EAAa,QAAQ,EAEvC,IACT,OAAOC,EAAiB,EAG5BV,EAAgBK,EAAe,IAAI,KAAK,EAAE,YAAY,CAAC,EACvDL,EAAgBM,EAAiBF,EAAQ,IAAI,EAG/C,IAAIO,EACJ,GAAI,CACFA,EAAW,MAAM,MAAMR,EAAKC,CAAO,CACrC,OAASQ,EAAP,CACA,OAAOF,EAAiBE,CAAK,CAC/B,CAEA,OAAKD,EAIAA,EAAS,GAIPA,EAHED,EAAiBC,EAAS,UAAU,EAJpCD,EAAiB,CAQ5B,CAEA,SAASA,EAAiBE,EAAa,CACrC,OAAIA,GACF,QAAQ,IAAI,yBAA0BA,CAAK,EAItC,CACL,KAAM,KAAO,CAAC,EAChB,CACF,CAEO,SAASC,EAAQjB,EAAgBO,EAAaC,EAA4B,CAC/E,OAAOF,EAAcY,EAAOlB,EAAQO,CAAG,EAAG,CACxC,GAAIC,GAAW,CAAC,EAChB,GAAGT,EAAUC,CAAM,CACrB,CAAC,CACH,CAEA,SAASkB,EAAOC,EAAgBC,EAAiB,CAC/C,MAAO,GAAGD,cAAmBC,GAC/B,CC9FA,IAAqBC,EAArB,KAA0B,CA8BxB,YACEC,EACAC,EACAC,EACAC,EACAC,EACAC,EACA,CACA,KAAK,GAAKL,EACV,KAAK,OAASC,EACd,KAAK,SAAWC,EAChB,KAAK,MAAQC,EACb,KAAK,MAAQC,EACb,KAAK,SAAWC,CAClB,CACF,EC3CA,IAAqBC,EAArB,KAA6B,CAS3B,YAAYC,EAAgBC,EAAiBC,EAAyBC,EAAwB,CAJ9F,KAAO,eAAiB,GAExB,KAAQ,MAAgB,CAAC,EAGvB,KAAK,OAASH,EACd,KAAK,OAASC,EACd,KAAK,eAAiBC,EACtB,KAAK,OAASC,CAChB,CAEA,MAAa,MAAsB,CACjC,aAAM,KAAK,aAAa,EACxB,KAAK,eAAiB,GACf,QAAQ,IAAI,IAAI,CACzB,CAEA,MAAa,QAAQC,EAAgB,CACnC,YAAK,qBAAqB,EACnB,KAAK,MAAM,KAAMC,GAASA,EAAK,IAAMD,CAAM,CACpD,CAEQ,sBAAuB,CAC7B,GAAI,CAAC,KAAK,eACR,MAAM,IAAI,MACR,kGACF,CAEJ,CAEA,MAAc,cAAe,CAC3B,KAAK,MAAQ,CAAC,EACd,IAAME,EAAc,MAAMC,EAAQ,KAAK,OAAQ,QAAQ,EACnDD,GAAeA,EAAY,MACTA,EAAY,KAClB,QAASE,GAAiB,CACtC,IAAMC,EAAU,KAAK,MAAMD,EAAa,IAAI,EAC5C,KAAK,MAAM,KACT,IAAIE,EACFF,EAAa,KACbA,EAAa,OACbC,GACAA,GAAA,YAAAA,EAAS,OAAQ,CAAC,EAClBA,GAAA,YAAAA,EAAS,MACTA,GAAA,YAAAA,EAAS,QACX,CACF,CACF,CAAC,CAEL,CACF,ECxDA,IAAOE,EAAQC","names":["VERSION_NUMBER","LAST_POST_CALL_AT","LAST_POST_CALL_DATA","getConfig","apiKey","VERSION_NUMBER","getLocalStorage","key","setLocalStorage","value","gracefulFetch","url","options","lastCallAtKey","lastCallDataKey","lastCall","lastCallData","lastCallDate","getEmptyResponse","response","error","fetcher","getUrl","apiUrl","postfix","Flow","id","status","rawData","steps","title","subtitle","Frigade","apiKey","userId","organizationId","config","flowId","flow","flowDataRaw","fetcher","flowMetadata","rawData","Flow","src_default","Frigade"]}

package/package.json

@@ -0,0 +1,99 @@
+{
+  "name": "@frigade/js",
+  "version": "0.0.1",
+  "description": "The official Javascript SDK for Frigade.",
+  "main": "./lib/index.js",
+  "types": "./lib/index.d.ts",
+  "files": [
+    "./lib"
+  ],
+  "scripts": {
+    "clean": "rimraf ./lib",
+    "test": "build",
+    "semantic-release": "semantic-release",
+    "lint": "eslint --fix --ext .ts,.tsx .",
+    "copy-files": "copyfiles -u 1 src/**/*.html src/**/*.css ./lib",
+    "build": "yarn clean && tsup && yarn copy-files",
+    "local-release": "tsup",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/FrigadeHQ/frigade-js.git"
+  },
+  "keywords": [
+    "Onboarding",
+    "Tutorial",
+    "Intro",
+    "Checklist",
+    "Welcome",
+    "Tooltips",
+    "Tour",
+    "Walkthrough",
+    "Javascript"
+  ],
+  "devDependencies": {
+    "@babel/core": "^7.15.8",
+    "@babel/plugin-transform-runtime": "^7.19.6",
+    "@babel/preset-env": "^7.21.5",
+    "@babel/preset-typescript": "^7.21.5",
+    "@storybook/addon-essentials": "^7.0.9",
+    "@storybook/addon-interactions": "^7.0.9",
+    "@storybook/addon-links": "^7.0.9",
+    "@storybook/blocks": "^7.0.9",
+    "@storybook/testing-library": "^0.0.14-next.2",
+    "@types/jest": "^23.3.1",
+    "babel-jest": "^29.4.1",
+    "copyfiles": "^2.4.1",
+    "jest": "^29.4.1",
+    "jest-config": "^29.3.1",
+    "jest-environment-jsdom": "^29.4.1",
+    "lint-staged": "^13.0.0",
+    "prettier": "^2.4.1",
+    "prop-types": "^15.8.1",
+    "rimraf": "^4.1.2",
+    "semantic-release": "^19.0.3",
+    "storybook": "^7.0.9",
+    "ts-jest": "^29.1.0",
+    "tsup": "^6.7.0",
+    "typedoc": "^0.24.8",
+    "typedoc-plugin-markdown": "^3.15.3",
+    "typescript": "^4.9.4"
+  },
+  "release": {
+    "branches": [
+      "main"
+    ]
+  },
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/changelog",
+    [
+      "@semantic-release/npm",
+      {
+        "npmPublish": true
+      }
+    ],
+    [
+      "@semantic-release/git",
+      {
+        "assets": [
+          "src/api/version.ts",
+          "package.json"
+        ],
+        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+      }
+    ],
+    "@semantic-release/github"
+  ],
+  "author": "Frigade Inc.",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/FrigadeHQ/frigade-js/issues"
+  },
+  "homepage": "https://github.com/FrigadeHQ/frigade-js#readme",
+  "dependencies": {
+    "uuid": "^9.0.0"
+  }
+}