@midas-aem/client 0.0.0-stage → 1.0.0

package/README.md

@@ -1,3 +1,55 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# @midas/client
+
+Universal developer SDK and first-party React components for **MIDAS Autonomous Outbound & Town Crier Newsletters**.
+
+---
+
+## 1. Installation
+
+```bash
+npm install @midas/client
+# or
+yarn add @midas/client
+# or
+pnpm add @midas/client
+2. React / Next.js 1-Line Drop-In Modal
+Tsx
+import { MidasModal } from '@midas/client/react';
+
+export default function HeroSection() {
+  return (
+    <MidasModal
+      gongId="weekly-alpha"
+      developerToggle
+      accent="#7C3AED"
+      className="px-6 py-3 bg-purple-600 text-white font-bold rounded-xl"
+    >
+      Join 15,000+ Founders
+    </MidasModal>
+  );
+}
+3. Isomorphic Backend / Node.js Usage
+Automatically reads process.env.MIDAS_API_KEY:
+TypeScript
+import { MidasClient } from '@midas/client';
+
+// Zero arguments needed in environments with MIDAS_API_KEY defined
+const midas = new MidasClient();
+
+await midas.subscribe({
+  email: 'subscriber@acme.com',
+  name: 'Alex Mercer',
+  gongId: 'weekly-alpha',
+  cadence: 'weekly',
+  metadata: { isTechnicalFounder: true }
+});
+4. Props Reference (<MidasModal />)
+Prop	Type	Default	Description
+gongId	string	undefined	Target Gong publication channel ID or slug.
+developerToggle	boolean	false	Enables progressive profiling toggle that reveals GitHub URL input.
+cadenceToggle	boolean	true	Enables interactive frequency pills (Daily, Weekly, Monthly).
+accent	string	#2563EB	Hex color code for submit button & active focus rings.
+fields	string[]	['name', 'email']	Array of field tokens to collect dynamically.
+headline	string	'Join our Newsletter'	Main heading in modal dialog.
+subheadline	string	'Get updates...'	Supporting lead magnet or discount copy.
+buttonText	string	'Subscribe'	Label on submit button.

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var s=Object.defineProperty;var c=Object.getOwnPropertyDescriptor;var d=Object.getOwnPropertyNames;var p=Object.prototype.hasOwnProperty;var l=(n,e)=>{for(var t in e)s(n,t,{get:e[t],enumerable:!0})},g=(n,e,t,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of d(e))!p.call(n,r)&&r!==t&&s(n,r,{get:()=>e[r],enumerable:!(i=c(e,r))||i.enumerable});return n};var h=n=>g(s({},"__esModule",{value:!0}),n);var w={};l(w,{MidasClient:()=>a,TownCrierClient:()=>u});module.exports=h(w);var a=class{apiKey;baseUrl;constructor(e){let t=e?.apiKey?.trim();if(!t&&typeof process<"u"&&process.env&&(t=(process.env.MIDAS_API_KEY||process.env.TOWN_CRIER_API_KEY||process.env.NEXT_PUBLIC_MIDAS_API_KEY||process.env.VITE_MIDAS_API_KEY)?.trim()),!t&&typeof window<"u")try{let r=new Function("try { return import.meta.env; } catch (e) { return null; }")();r&&r.VITE_MIDAS_API_KEY&&(t=String(r.VITE_MIDAS_API_KEY).trim())}catch{}if(!t||!t.startsWith("midas_live_")&&!t.startsWith("tc_live_"))throw new Error('MidasClient: A valid API key starting with "midas_live_" or "tc_live_" is required. Pass apiKey to the constructor or define MIDAS_API_KEY in your environment variables.');this.apiKey=t,this.baseUrl=(e?.baseUrl||typeof process<"u"&&process.env?.MIDAS_BASE_URL||(typeof window<"u"?window.location.origin:"https://midas-aem.vercel.app")).replace(/\/$/,"")}async subscribe(e){if(!e.email||!e.email.includes("@"))throw new Error("MidasClient: A valid email address is required.");let t=`${this.baseUrl}/api/public/town-crier/subscribe`,i=await fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`},body:JSON.stringify({email:e.email.trim().toLowerCase(),name:e.name?.trim()||void 0,cadence:e.cadence||"weekly",tags:e.tags||["sdk_signup"],gongId:e.gongId?.trim()||void 0,campaignId:e.campaignId?.trim()||void 0,metadata:e.metadata||void 0})}),r=await i.json().catch(()=>({}));if(!i.ok)throw new Error(r.error||`Subscription failed (HTTP ${i.status})`);return r}async listGongs(){let e=`${this.baseUrl}/api/public/town-crier/gongs`,t=await fetch(e,{headers:{Authorization:`Bearer ${this.apiKey}`}}),i=await t.json().catch(()=>({}));if(!t.ok)throw new Error(i.error||"Failed to list Gongs");return i.gongs||[]}async publishBroadcast(e,t){let i=`${this.baseUrl}/api/public/town-crier/gongs/${e}/broadcast`,r=await fetch(i,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`},body:JSON.stringify(t)}),o=await r.json().catch(()=>({}));if(!r.ok)throw new Error(o.error||"Failed to publish broadcast");return o}async getStats(){let e=`${this.baseUrl}/api/public/town-crier/stats`,t=await fetch(e,{headers:{Authorization:`Bearer ${this.apiKey}`}}),i=await t.json().catch(()=>({}));if(!t.ok)throw new Error(i.error||"Failed to fetch telemetry");return i}},u=a;0&&(module.exports={MidasClient,TownCrierClient});

package/dist/index.d.mts

@@ -0,0 +1,43 @@
+interface MidasSubscribeOptions {
+    email: string;
+    name?: string;
+    cadence?: 'daily' | 'weekly' | 'biweekly' | 'monthly' | string;
+    tags?: string[];
+    gongId?: string;
+    campaignId?: string;
+    metadata?: Record<string, any>;
+}
+interface MidasClientConfig {
+    apiKey?: string;
+    baseUrl?: string;
+}
+declare class MidasClient {
+    private apiKey;
+    private baseUrl;
+    constructor(config?: MidasClientConfig);
+    /**
+     * Ingest a subscriber.
+     * If gongId is specified and the channel has welcome autoresponders enabled,
+     * Midas dispatches the welcome lead-magnet email automatically in <60 seconds.
+     */
+    subscribe(options: MidasSubscribeOptions): Promise<any>;
+    /**
+     * Programmatically query all active Gong publication channels
+     */
+    listGongs(): Promise<any>;
+    /**
+     * Headlessly publish a broadcast newsletter issue to a Gong channel
+     */
+    publishBroadcast(gongId: string, issue: {
+        subject: string;
+        body: string;
+        templateStyle?: string;
+    }): Promise<any>;
+    /**
+     * Probe real-time audience and delivery telemetry
+     */
+    getStats(): Promise<any>;
+}
+declare const TownCrierClient: typeof MidasClient;
+
+export { MidasClient, type MidasClientConfig, type MidasSubscribeOptions, TownCrierClient };

package/dist/index.d.ts

@@ -0,0 +1,43 @@
+interface MidasSubscribeOptions {
+    email: string;
+    name?: string;
+    cadence?: 'daily' | 'weekly' | 'biweekly' | 'monthly' | string;
+    tags?: string[];
+    gongId?: string;
+    campaignId?: string;
+    metadata?: Record<string, any>;
+}
+interface MidasClientConfig {
+    apiKey?: string;
+    baseUrl?: string;
+}
+declare class MidasClient {
+    private apiKey;
+    private baseUrl;
+    constructor(config?: MidasClientConfig);
+    /**
+     * Ingest a subscriber.
+     * If gongId is specified and the channel has welcome autoresponders enabled,
+     * Midas dispatches the welcome lead-magnet email automatically in <60 seconds.
+     */
+    subscribe(options: MidasSubscribeOptions): Promise<any>;
+    /**
+     * Programmatically query all active Gong publication channels
+     */
+    listGongs(): Promise<any>;
+    /**
+     * Headlessly publish a broadcast newsletter issue to a Gong channel
+     */
+    publishBroadcast(gongId: string, issue: {
+        subject: string;
+        body: string;
+        templateStyle?: string;
+    }): Promise<any>;
+    /**
+     * Probe real-time audience and delivery telemetry
+     */
+    getStats(): Promise<any>;
+}
+declare const TownCrierClient: typeof MidasClient;
+
+export { MidasClient, type MidasClientConfig, type MidasSubscribeOptions, TownCrierClient };

package/dist/index.mjs

@@ -0,0 +1 @@
+var n=class{apiKey;baseUrl;constructor(e){let t=e?.apiKey?.trim();if(!t&&typeof process<"u"&&process.env&&(t=(process.env.MIDAS_API_KEY||process.env.TOWN_CRIER_API_KEY||process.env.NEXT_PUBLIC_MIDAS_API_KEY||process.env.VITE_MIDAS_API_KEY)?.trim()),!t&&typeof window<"u")try{let r=new Function("try { return import.meta.env; } catch (e) { return null; }")();r&&r.VITE_MIDAS_API_KEY&&(t=String(r.VITE_MIDAS_API_KEY).trim())}catch{}if(!t||!t.startsWith("midas_live_")&&!t.startsWith("tc_live_"))throw new Error('MidasClient: A valid API key starting with "midas_live_" or "tc_live_" is required. Pass apiKey to the constructor or define MIDAS_API_KEY in your environment variables.');this.apiKey=t,this.baseUrl=(e?.baseUrl||typeof process<"u"&&process.env?.MIDAS_BASE_URL||(typeof window<"u"?window.location.origin:"https://midas-aem.vercel.app")).replace(/\/$/,"")}async subscribe(e){if(!e.email||!e.email.includes("@"))throw new Error("MidasClient: A valid email address is required.");let t=`${this.baseUrl}/api/public/town-crier/subscribe`,i=await fetch(t,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`},body:JSON.stringify({email:e.email.trim().toLowerCase(),name:e.name?.trim()||void 0,cadence:e.cadence||"weekly",tags:e.tags||["sdk_signup"],gongId:e.gongId?.trim()||void 0,campaignId:e.campaignId?.trim()||void 0,metadata:e.metadata||void 0})}),r=await i.json().catch(()=>({}));if(!i.ok)throw new Error(r.error||`Subscription failed (HTTP ${i.status})`);return r}async listGongs(){let e=`${this.baseUrl}/api/public/town-crier/gongs`,t=await fetch(e,{headers:{Authorization:`Bearer ${this.apiKey}`}}),i=await t.json().catch(()=>({}));if(!t.ok)throw new Error(i.error||"Failed to list Gongs");return i.gongs||[]}async publishBroadcast(e,t){let i=`${this.baseUrl}/api/public/town-crier/gongs/${e}/broadcast`,r=await fetch(i,{method:"POST",headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`},body:JSON.stringify(t)}),a=await r.json().catch(()=>({}));if(!r.ok)throw new Error(a.error||"Failed to publish broadcast");return a}async getStats(){let e=`${this.baseUrl}/api/public/town-crier/stats`,t=await fetch(e,{headers:{Authorization:`Bearer ${this.apiKey}`}}),i=await t.json().catch(()=>({}));if(!t.ok)throw new Error(i.error||"Failed to fetch telemetry");return i}},o=n;export{n as MidasClient,o as TownCrierClient};

package/dist/react.cjs

@@ -0,0 +1,2 @@
+'use client';
+"use strict";var u=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var F=Object.getOwnPropertyNames;var C=Object.prototype.hasOwnProperty;var T=(n,t)=>{for(var a in t)u(n,a,{get:t[a],enumerable:!0})},I=(n,t,a,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of F(t))!C.call(n,i)&&i!==a&&u(n,i,{get:()=>t[i],enumerable:!(s=x(t,i))||s.enumerable});return n};var E=n=>I(u({},"__esModule",{value:!0}),n);var k={};T(k,{MidasEmbed:()=>S,MidasModal:()=>f,TownCrierModal:()=>N,useMidasModal:()=>w,useTownCrierModal:()=>K});module.exports=E(k);var d=require("react"),b=require("react/jsx-runtime");function w(n){let[t,a]=(0,d.useState)(!1);return(0,d.useEffect)(()=>{if(typeof window<"u"&&!window.TownCrier&&!document.querySelector('script[src*="widget.js"]')){let e=document.createElement("script");e.src="https://midas-aem.vercel.app/api/public/town-crier/widget.js",e.async=!0,document.head.appendChild(e)}},[]),{open:(0,d.useCallback)(i=>{let e={...n,...i},o=[...e.fields||["name","email","cadence"]];if(e.developerToggle&&!o.includes("developer")&&o.push("developer"),typeof window<"u"&&window.TownCrier?.openModal)window.TownCrier.openModal({apiKey:e.apiKey,gongId:e.gongId,headline:e.headline,accent:e.accent,fields:o}),a(!0);else{let r=0,c=setInterval(()=>{r++,window.TownCrier?.openModal?(clearInterval(c),window.TownCrier.openModal({apiKey:e.apiKey,gongId:e.gongId,headline:e.headline,accent:e.accent,fields:o}),a(!0)):r>10&&(clearInterval(c),console.error("Midas: widget.js failed to load. Check network connection."))},150)}},[n]),isOpen:t}}var K=w,f=({apiKey:n,gongId:t,fields:a,developerToggle:s=!1,cadenceToggle:i=!0,accent:e="#2563EB",bg:o="#FFFFFF",text:r="#18181B",radius:c="20px",headline:p="Join our Newsletter",subheadline:g="Get high-signal insights delivered to your inbox.",buttonText:y="Subscribe",className:m="",style:h,children:v="Subscribe to Newsletter"})=>{let l=a?[...a]:["name","email"];i&&!l.includes("cadence")&&l.push("cadence"),s&&!l.includes("developer")&&l.push("developer");let{open:M}=w({apiKey:n,gongId:t,headline:p,accent:e,fields:l});return(0,b.jsx)("button",{type:"button",onClick:()=>M(),"data-town-crier-modal":!0,"data-key":n,"data-gong":t,"data-fields":l.join(","),"data-headline":p,"data-subheadline":g,"data-accent":e,"data-bg":o,"data-text":r,"data-radius":c,"data-button":y,className:m,style:h,children:v})},N=f,S=({apiKey:n,gongId:t,layout:a="card",accent:s="#2563EB",bg:i="#FFFFFF",radius:e="16px",headline:o="Join our newsletter",subheadline:r="Get updates in your inbox.",buttonText:c="Subscribe",className:p=""})=>((0,d.useEffect)(()=>{if(typeof window<"u"&&!window.TownCrier){let g=document.createElement("script");g.src="https://midas-aem.vercel.app/api/public/town-crier/widget.js",g.async=!0,document.head.appendChild(g)}},[]),(0,b.jsx)("div",{"data-town-crier-embed":!0,"data-key":n,"data-gong":t,"data-layout":a,"data-accent":s,"data-bg":i,"data-radius":e,"data-headline":o,"data-subheadline":r,"data-button":c,className:p}));0&&(module.exports={MidasEmbed,MidasModal,TownCrierModal,useMidasModal,useTownCrierModal});

package/dist/react.d.mts

@@ -0,0 +1,68 @@
+import React from 'react';
+
+interface MidasModalProps {
+    apiKey?: string;
+    gongId?: string;
+    fields?: Array<'email' | 'name' | 'company' | 'cadence' | 'developer' | string>;
+    developerToggle?: boolean;
+    cadenceToggle?: boolean;
+    accent?: string;
+    bg?: string;
+    text?: string;
+    radius?: string;
+    headline?: string;
+    subheadline?: string;
+    buttonText?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    children?: React.ReactNode;
+}
+interface MidasEmbedProps {
+    apiKey?: string;
+    gongId?: string;
+    layout?: 'card' | 'horizontal';
+    accent?: string;
+    bg?: string;
+    radius?: string;
+    headline?: string;
+    subheadline?: string;
+    buttonText?: string;
+    className?: string;
+}
+/**
+ * Native React Hook for triggering the Midas modal imperatively
+ */
+declare function useMidasModal(defaultConfig?: {
+    apiKey?: string;
+    gongId?: string;
+    headline?: string;
+    accent?: string;
+    fields?: string[];
+    developerToggle?: boolean;
+}): {
+    open: (overrideConfig?: {
+        apiKey?: string;
+        gongId?: string;
+        headline?: string;
+        accent?: string;
+        fields?: string[];
+        developerToggle?: boolean;
+    }) => void;
+    isOpen: boolean;
+};
+declare const useTownCrierModal: typeof useMidasModal;
+/**
+ * 1-Line Clerk-Parity React Component Wrapper
+ * Usage:
+ *   <MidasModal gongId="saas-weekly" developerToggle accent="#7C3AED">
+ *     Join the Newsletter
+ *   </MidasModal>
+ */
+declare const MidasModal: React.FC<MidasModalProps>;
+declare const TownCrierModal: React.FC<MidasModalProps>;
+/**
+ * In-Page Responsive Inline Card Component
+ */
+declare const MidasEmbed: React.FC<MidasEmbedProps>;
+
+export { MidasEmbed, type MidasEmbedProps, MidasModal, type MidasModalProps, TownCrierModal, useMidasModal, useTownCrierModal };

package/dist/react.d.ts

@@ -0,0 +1,68 @@
+import React from 'react';
+
+interface MidasModalProps {
+    apiKey?: string;
+    gongId?: string;
+    fields?: Array<'email' | 'name' | 'company' | 'cadence' | 'developer' | string>;
+    developerToggle?: boolean;
+    cadenceToggle?: boolean;
+    accent?: string;
+    bg?: string;
+    text?: string;
+    radius?: string;
+    headline?: string;
+    subheadline?: string;
+    buttonText?: string;
+    className?: string;
+    style?: React.CSSProperties;
+    children?: React.ReactNode;
+}
+interface MidasEmbedProps {
+    apiKey?: string;
+    gongId?: string;
+    layout?: 'card' | 'horizontal';
+    accent?: string;
+    bg?: string;
+    radius?: string;
+    headline?: string;
+    subheadline?: string;
+    buttonText?: string;
+    className?: string;
+}
+/**
+ * Native React Hook for triggering the Midas modal imperatively
+ */
+declare function useMidasModal(defaultConfig?: {
+    apiKey?: string;
+    gongId?: string;
+    headline?: string;
+    accent?: string;
+    fields?: string[];
+    developerToggle?: boolean;
+}): {
+    open: (overrideConfig?: {
+        apiKey?: string;
+        gongId?: string;
+        headline?: string;
+        accent?: string;
+        fields?: string[];
+        developerToggle?: boolean;
+    }) => void;
+    isOpen: boolean;
+};
+declare const useTownCrierModal: typeof useMidasModal;
+/**
+ * 1-Line Clerk-Parity React Component Wrapper
+ * Usage:
+ *   <MidasModal gongId="saas-weekly" developerToggle accent="#7C3AED">
+ *     Join the Newsletter
+ *   </MidasModal>
+ */
+declare const MidasModal: React.FC<MidasModalProps>;
+declare const TownCrierModal: React.FC<MidasModalProps>;
+/**
+ * In-Page Responsive Inline Card Component
+ */
+declare const MidasEmbed: React.FC<MidasEmbedProps>;
+
+export { MidasEmbed, type MidasEmbedProps, MidasModal, type MidasModalProps, TownCrierModal, useMidasModal, useTownCrierModal };

package/dist/react.mjs

@@ -0,0 +1,2 @@
+'use client';
+import{useCallback as v,useState as M,useEffect as p}from"react";import{jsx as w}from"react/jsx-runtime";function u(n){let[i,a]=M(!1);return p(()=>{if(typeof window<"u"&&!window.TownCrier&&!document.querySelector('script[src*="widget.js"]')){let e=document.createElement("script");e.src="https://midas-aem.vercel.app/api/public/town-crier/widget.js",e.async=!0,document.head.appendChild(e)}},[]),{open:v(o=>{let e={...n,...o},t=[...e.fields||["name","email","cadence"]];if(e.developerToggle&&!t.includes("developer")&&t.push("developer"),typeof window<"u"&&window.TownCrier?.openModal)window.TownCrier.openModal({apiKey:e.apiKey,gongId:e.gongId,headline:e.headline,accent:e.accent,fields:t}),a(!0);else{let s=0,d=setInterval(()=>{s++,window.TownCrier?.openModal?(clearInterval(d),window.TownCrier.openModal({apiKey:e.apiKey,gongId:e.gongId,headline:e.headline,accent:e.accent,fields:t}),a(!0)):s>10&&(clearInterval(d),console.error("Midas: widget.js failed to load. Check network connection."))},150)}},[n]),isOpen:i}}var T=u,x=({apiKey:n,gongId:i,fields:a,developerToggle:l=!1,cadenceToggle:o=!0,accent:e="#2563EB",bg:t="#FFFFFF",text:s="#18181B",radius:d="20px",headline:g="Join our Newsletter",subheadline:c="Get high-signal insights delivered to your inbox.",buttonText:b="Subscribe",className:f="",style:y,children:m="Subscribe to Newsletter"})=>{let r=a?[...a]:["name","email"];o&&!r.includes("cadence")&&r.push("cadence"),l&&!r.includes("developer")&&r.push("developer");let{open:h}=u({apiKey:n,gongId:i,headline:g,accent:e,fields:r});return w("button",{type:"button",onClick:()=>h(),"data-town-crier-modal":!0,"data-key":n,"data-gong":i,"data-fields":r.join(","),"data-headline":g,"data-subheadline":c,"data-accent":e,"data-bg":t,"data-text":s,"data-radius":d,"data-button":b,className:f,style:y,children:m})},I=x,E=({apiKey:n,gongId:i,layout:a="card",accent:l="#2563EB",bg:o="#FFFFFF",radius:e="16px",headline:t="Join our newsletter",subheadline:s="Get updates in your inbox.",buttonText:d="Subscribe",className:g=""})=>(p(()=>{if(typeof window<"u"&&!window.TownCrier){let c=document.createElement("script");c.src="https://midas-aem.vercel.app/api/public/town-crier/widget.js",c.async=!0,document.head.appendChild(c)}},[]),w("div",{"data-town-crier-embed":!0,"data-key":n,"data-gong":i,"data-layout":a,"data-accent":l,"data-bg":o,"data-radius":e,"data-headline":t,"data-subheadline":s,"data-button":d,className:g}));export{E as MidasEmbed,x as MidasModal,I as TownCrierModal,u as useMidasModal,T as useTownCrierModal};

package/package.json

@@ -1,6 +1,43 @@
-{
-  "name": "@midas-aem/client",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+{
+  "name": "@midas-aem/client",
+  "version": "1.0.0",
+  "description": "Universal SDK and first-party React/Next.js components for Midas Autonomous Outbound & Town Crier Newsletters",
+  "author": "Pyrexx AI",
+  "license": "Apache-2.0",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./react": {
+      "types": "./dist/react.d.ts",
+      "import": "./dist/react.mjs",
+      "require": "./dist/react.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "prepublishOnly": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18.0.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.45",
+    "react": "^18.2.0",
+    "tsup": "^8.5.1",
+    "typescript": "^5.3.3"
+  }
 }