@usemogul/connect-common 0.2.0 → 0.4.0

package/README.md

@@ -14,7 +14,8 @@ Zero runtime dependencies. Ships ESM + CJS + TypeScript types.
 - `ConnectedIdentity` — identity payload carried on `mogul:success`
 - `FRAME_EVENT` / `PARENT_EVENT` — event-name constants
 - `CONNECT_ERROR_CODE` / `ConnectErrorCode` — the `mogul:error` codes
-  (`token_error`, `invalid_target`, `client_mismatch`, `identity_unavailable`).
+  (`token_error`, `invalid_target`, `client_mismatch`, `identity_unavailable`,
+  `origin_not_allowed`, `verification_failed`).
   `mogul:error.code` stays typed as `string` on the wire, so handle unknown codes.
 - `parseFrameMessage(data)` — for the loader: validates untrusted `postMessage`
   data into a known `FrameMessage`, or `null`.

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i={ready:"mogul:ready",requestToken:"mogul:request-token",resize:"mogul:resize",success:"mogul:success",exit:"mogul:exit",error:"mogul:error"},s={init:"mogul:init",logout:"mogul:logout"},u={tokenError:"token_error",invalidTarget:"invalid_target",clientMismatch:"client_mismatch",identityUnavailable:"identity_unavailable"},l=t=>{if(typeof t!="object"||t===null)return;const e=t;if(typeof e.id!="string"||typeof e.name!="string"||!Array.isArray(e.accounts))return;const n=[];for(const o of e.accounts){if(typeof o!="object"||o===null)return;const r=o;if(typeof r.id!="string"||typeof r.name!="string")return;n.push({id:r.id,name:r.name})}return{id:e.id,name:e.name,accounts:n}},c=t=>{if(typeof t!="object"||t===null)return null;const e=t;switch(e.type){case"mogul:ready":case"mogul:request-token":case"mogul:exit":return{type:e.type};case"mogul:resize":return typeof e.height=="number"?{type:"mogul:resize",height:e.height}:null;case"mogul:success":{const n=l(e.connectedIdentity);return typeof e.integrationId=="number"&&typeof e.accountId=="string"&&n?{type:"mogul:success",integrationId:e.integrationId,accountId:e.accountId,connectedIdentity:n}:null}case"mogul:error":return typeof e.code=="string"?{type:"mogul:error",code:e.code}:null;default:return null}},g=t=>{if(typeof t!="object"||t===null)return null;const e=t;switch(e.type){case"mogul:init":{const{token:n,clientId:o,locale:r}=e;return typeof n!="string"||n.length===0||typeof o!="string"||o.length===0?null:typeof r=="string"?{type:"mogul:init",token:n,clientId:o,locale:r}:{type:"mogul:init",token:n,clientId:o}}case"mogul:logout":return{type:"mogul:logout"};default:return null}};exports.CONNECT_ERROR_CODE=u;exports.FRAME_EVENT=i;exports.PARENT_EVENT=s;exports.parseFrameMessage=c;exports.parseParentMessage=g;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const i={ready:"mogul:ready",requestToken:"mogul:request-token",success:"mogul:success",exit:"mogul:exit",error:"mogul:error"},s={init:"mogul:init",logout:"mogul:logout"},u={tokenError:"token_error",invalidTarget:"invalid_target",clientMismatch:"client_mismatch",identityUnavailable:"identity_unavailable",originNotAllowed:"origin_not_allowed",verificationFailed:"verification_failed"},c=t=>{if(typeof t!="object"||t===null)return;const e=t;if(typeof e.id!="string"||typeof e.name!="string"||!Array.isArray(e.accounts))return;const n=[];for(const o of e.accounts){if(typeof o!="object"||o===null)return;const r=o;if(typeof r.id!="string"||typeof r.name!="string")return;n.push({id:r.id,name:r.name})}return{id:e.id,name:e.name,accounts:n}},l=t=>{if(typeof t!="object"||t===null)return null;const e=t;switch(e.type){case"mogul:ready":case"mogul:request-token":case"mogul:exit":return{type:e.type};case"mogul:success":{const n=c(e.connectedIdentity);return typeof e.sourceId=="number"&&typeof e.accountId=="string"&&n?{type:"mogul:success",sourceId:e.sourceId,accountId:e.accountId,connectedIdentity:n}:null}case"mogul:error":return typeof e.code=="string"?{type:"mogul:error",code:e.code}:null;default:return null}},a=t=>{if(typeof t!="object"||t===null)return null;const e=t;switch(e.type){case"mogul:init":{const{token:n,clientId:o,locale:r}=e;return typeof n!="string"||n.length===0||typeof o!="string"||o.length===0?null:typeof r=="string"?{type:"mogul:init",token:n,clientId:o,locale:r}:{type:"mogul:init",token:n,clientId:o}}case"mogul:logout":return{type:"mogul:logout"};default:return null}};exports.CONNECT_ERROR_CODE=u;exports.FRAME_EVENT=i;exports.PARENT_EVENT=s;exports.parseFrameMessage=l;exports.parseParentMessage=a;

package/dist/index.d.cts

@@ -10,10 +10,21 @@ export declare const CONNECT_ERROR_CODE: {
      */
     readonly clientMismatch: "client_mismatch";
     /**
-     * Frame: the connection succeeded, but the integration ID or a complete
+     * Frame: the connection succeeded, but the source ID or a complete
      * identity couldn't be resolved, so no `mogul:success` is sent.
      */
     readonly identityUnavailable: "identity_unavailable";
+    /**
+     * Frame: the embedding page's origin isn't registered for the partner the
+     * session token belongs to (or the token's partner doesn't match `clientId`),
+     * so the token is refused and the flow never loads.
+     */
+    readonly originNotAllowed: "origin_not_allowed";
+    /**
+     * Frame: the frame couldn't reach Mogul to verify the embedding origin, so
+     * the token is refused. Transient: remount (or the next `mogul:init`) retries.
+     */
+    readonly verificationFailed: "verification_failed";
 };
 
 /** Identity the connected source resolved to, parsed from the integration. */
@@ -38,7 +49,6 @@ export declare type ConnectErrorCode = (typeof CONNECT_ERROR_CODE)[keyof typeof
 export declare const FRAME_EVENT: {
     readonly ready: "mogul:ready";
     readonly requestToken: "mogul:request-token";
-    readonly resize: "mogul:resize";
     readonly success: "mogul:success";
     readonly exit: "mogul:exit";
     readonly error: "mogul:error";
@@ -49,9 +59,6 @@ export declare type FrameMessage = {
     type: 'mogul:ready';
 } | {
     type: 'mogul:request-token';
-} | {
-    type: 'mogul:resize';
-    height: number;
 } | {
     /**
      * Sent when the user dismisses the success screen (Done), and only when
@@ -59,8 +66,8 @@ export declare type FrameMessage = {
      * Otherwise the frame sends `mogul:error` `identity_unavailable` instead.
      */
     type: 'mogul:success';
-    /** The created integration — the handle for later royalty-report API calls. */
-    integrationId: number;
+    /** The connected source. Used for royalty-report API calls. */
+    sourceId: number;
     /** Mogul account the integration belongs to (from the session token). */
     accountId: string;
     /** Identity parsed from the connected integration. */

package/dist/index.d.ts

@@ -10,10 +10,21 @@ export declare const CONNECT_ERROR_CODE: {
      */
     readonly clientMismatch: "client_mismatch";
     /**
-     * Frame: the connection succeeded, but the integration ID or a complete
+     * Frame: the connection succeeded, but the source ID or a complete
      * identity couldn't be resolved, so no `mogul:success` is sent.
      */
     readonly identityUnavailable: "identity_unavailable";
+    /**
+     * Frame: the embedding page's origin isn't registered for the partner the
+     * session token belongs to (or the token's partner doesn't match `clientId`),
+     * so the token is refused and the flow never loads.
+     */
+    readonly originNotAllowed: "origin_not_allowed";
+    /**
+     * Frame: the frame couldn't reach Mogul to verify the embedding origin, so
+     * the token is refused. Transient: remount (or the next `mogul:init`) retries.
+     */
+    readonly verificationFailed: "verification_failed";
 };
 
 /** Identity the connected source resolved to, parsed from the integration. */
@@ -38,7 +49,6 @@ export declare type ConnectErrorCode = (typeof CONNECT_ERROR_CODE)[keyof typeof
 export declare const FRAME_EVENT: {
     readonly ready: "mogul:ready";
     readonly requestToken: "mogul:request-token";
-    readonly resize: "mogul:resize";
     readonly success: "mogul:success";
     readonly exit: "mogul:exit";
     readonly error: "mogul:error";
@@ -49,9 +59,6 @@ export declare type FrameMessage = {
     type: 'mogul:ready';
 } | {
     type: 'mogul:request-token';
-} | {
-    type: 'mogul:resize';
-    height: number;
 } | {
     /**
      * Sent when the user dismisses the success screen (Done), and only when
@@ -59,8 +66,8 @@ export declare type FrameMessage = {
      * Otherwise the frame sends `mogul:error` `identity_unavailable` instead.
      */
     type: 'mogul:success';
-    /** The created integration — the handle for later royalty-report API calls. */
-    integrationId: number;
+    /** The connected source. Used for royalty-report API calls. */
+    sourceId: number;
     /** Mogul account the integration belongs to (from the session token). */
     accountId: string;
     /** Identity parsed from the connected integration. */

package/dist/index.js

@@ -1,14 +1,13 @@
 const u = {
   ready: "mogul:ready",
   requestToken: "mogul:request-token",
-  resize: "mogul:resize",
   success: "mogul:success",
   exit: "mogul:exit",
   error: "mogul:error"
-}, s = {
+}, c = {
   init: "mogul:init",
   logout: "mogul:logout"
-}, l = {
+}, s = {
   /** Loader: the partner's `getToken()` threw. */
   tokenError: "token_error",
   /** Frame: the preselected `/embed/connect/<target>` isn't a known source. */
@@ -19,10 +18,21 @@ const u = {
    */
   clientMismatch: "client_mismatch",
   /**
-   * Frame: the connection succeeded, but the integration ID or a complete
+   * Frame: the connection succeeded, but the source ID or a complete
    * identity couldn't be resolved, so no `mogul:success` is sent.
    */
-  identityUnavailable: "identity_unavailable"
+  identityUnavailable: "identity_unavailable",
+  /**
+   * Frame: the embedding page's origin isn't registered for the partner the
+   * session token belongs to (or the token's partner doesn't match `clientId`),
+   * so the token is refused and the flow never loads.
+   */
+  originNotAllowed: "origin_not_allowed",
+  /**
+   * Frame: the frame couldn't reach Mogul to verify the embedding origin, so
+   * the token is refused. Transient: remount (or the next `mogul:init`) retries.
+   */
+  verificationFailed: "verification_failed"
 }, i = (t) => {
   if (typeof t != "object" || t === null) return;
   const e = t;
@@ -36,7 +46,7 @@ const u = {
     n.push({ id: r.id, name: r.name });
   }
   return { id: e.id, name: e.name, accounts: n };
-}, c = (t) => {
+}, l = (t) => {
   if (typeof t != "object" || t === null) return null;
   const e = t;
   switch (e.type) {
@@ -44,15 +54,13 @@ const u = {
     case "mogul:request-token":
     case "mogul:exit":
       return { type: e.type };
-    case "mogul:resize":
-      return typeof e.height == "number" ? { type: "mogul:resize", height: e.height } : null;
     case "mogul:success": {
       const n = i(
         e.connectedIdentity
       );
-      return typeof e.integrationId == "number" && typeof e.accountId == "string" && n ? {
+      return typeof e.sourceId == "number" && typeof e.accountId == "string" && n ? {
         type: "mogul:success",
-        integrationId: e.integrationId,
+        sourceId: e.sourceId,
         accountId: e.accountId,
         connectedIdentity: n
       } : null;
@@ -62,7 +70,7 @@ const u = {
     default:
       return null;
   }
-}, g = (t) => {
+}, a = (t) => {
   if (typeof t != "object" || t === null) return null;
   const e = t;
   switch (e.type) {
@@ -77,9 +85,9 @@ const u = {
   }
 };
 export {
-  l as CONNECT_ERROR_CODE,
+  s as CONNECT_ERROR_CODE,
   u as FRAME_EVENT,
-  s as PARENT_EVENT,
-  c as parseFrameMessage,
-  g as parseParentMessage
+  c as PARENT_EVENT,
+  l as parseFrameMessage,
+  a as parseParentMessage
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@usemogul/connect-common",
-  "version": "0.2.0",
+  "version": "0.4.0",
   "description": "Shared schemas for the Mogul Connect embedded component: message types, event-name constants, and validators shared by the connect-js loader and the Mogul application.",
   "license": "Apache-2.0",
   "author": "shawn@usemogul.com",