@mindful-web/marko-web-omeda-identity-x 1.0.1 → 1.8.0

package/components/identify.marko.js

@@ -2,7 +2,7 @@
 "use strict";
 
 var marko_template = module.exports = require("marko/dist/html").t(__filename),
-    marko_componentType = "/@mindful-web/marko-web-omeda-identity-x$1.0.1/components/identify.marko",
+    marko_componentType = "/@mindful-web/marko-web-omeda-identity-x$1.8.0/components/identify.marko",
     marko_component = require("./identify.marko"),
     marko_renderer = require("marko/dist/runtime/components/renderer"),
     module_getCookieId = require("@mindful-web/marko-web-omeda-identity-x/utils/get-cookie-id"),
@@ -51,7 +51,7 @@ marko_template._ = marko_renderer(render, {
   }, marko_component);
 
 marko_template.meta = {
-    id: "/@mindful-web/marko-web-omeda-identity-x$1.0.1/components/identify.marko",
+    id: "/@mindful-web/marko-web-omeda-identity-x$1.8.0/components/identify.marko",
     component: "./identify.marko",
     tags: [
       "@mindful-web/marko-web-identity-x/components/identify.marko",

package/index.js

@@ -259,3 +259,178 @@ module.exports = (app, params = {}) => {
     omedaPromoCodeDefault,
   }));
 };
+
+/**
+ * @typedef {import('@mindful-web/marko-web-identity-x/service')} IdentityX
+ * @typedef {import('@mindful-web/marko-web-identity-x/service').User} IdentityXUser
+ * @typedef {import('@mindful-web/marko-web-omeda-identity-x/rapid-identify')} OIDXRapidIdentify
+ *
+ * @typedef {(
+ *   "onAuthenticationSuccess"|
+ *   "onChangeEmailLinkSent"|
+ *   "onChangeEmailSuccess"|
+ *   "onLoadActiveContext"|
+ *   "onLoginLinkSent"|
+ *   "onLogout"|
+ *   "onUserProfileUpdate"
+ * )} IDXHookTypeEnum
+ *
+ * @typedef {(
+ *   "default"|
+ *   "newsletterSignup"|
+ *   "comments"|
+ *   "contentGate"
+ * )} OIDXLoginSource
+ *
+ * @typedef {(
+ *   "default"|
+ *   "pushdown"|
+ *   "inlineContent"|
+ *   "inlineSection"|
+ *   "footer"
+ * )} OIDXNewsletterSource
+ *
+ * @typedef {(
+ *   "default"|
+ *   "metered"|
+ *   "printPreview"
+ * )} OIDXContentGateSource
+ */
+
+/**
+ * Arguments included directly with the hook execution
+ *
+ * @typedef IdentityXHookArgs
+ * see [callHooksFor]({@link ../marko-web-identity-x/utils/call-hooks-for.js}) for
+ * @prop {object} additionalEventData
+ * @prop {IdentityX} service
+ *
+ * @typedef {IdentityXHookArgs & OnAuthenticationSuccessHookArgs} OnAuthenticationSuccessHook
+ * @typedef {IdentityXHookArgs & OnLoginLinkSentHookArgs} OnLoginLinkSentHook
+ * @typedef {IdentityXHookArgs & OnUserProfileUpdateHookArgs} OnUserProfileUpdateHook
+ *
+ * @typedef OnAuthenticationSuccessHookArgs
+ * see [authenticate route]({@link ../marko-web-identity-x/routes/authenticate.js}) for
+ * @prop {string} authToken
+ * @prop {OIDXLoginSource} [loginSource]
+ * @prop {import('express').Request} req
+ * @prop {import('express').Response} res
+ * @prop {IdentityXUser} user
+ *
+ * @typedef OnLoginLinkSentHookArgs
+ * see [service.sendLoginLink]({@link ../marko-web-identity-x/service.js}) for
+ * @prop {object} [additionalEventData]
+ * @prop {import('express').Request} req
+ * @prop {OIDXLoginSource} [source]
+ * @prop {IdentityX} service
+ * @prop {IdentityXUser} user
+ *
+ * @typedef OnUserProfileUpdateHookArgs
+ * see [profile route]({@link ../marko-web-identity-x/routes/profile.js}) for
+ * @prop {object} [additionalEventData]
+ * @prop {import('express').Request} req
+ * @prop {IdentityX} service
+ * @prop {IdentityXUser} user
+ */
+
+/**
+ * Arguments injected by [hook registration]({@link ./add-integration-hooks.js})
+ *
+ * @typedef OmedaHookFunctionArgs
+ * @prop {object[]} appendBehaviors @todo document data factory results
+ * @prop {object[]} appendDemographics
+ * @prop {object[]} appendPromoCodes If present, the last value will be used as the promoCode
+ * @prop {any} behavior @todo document behavior factory results
+ * @prop {string} brandKey
+ * @prop {OIDXRapidIdentify} idxOmedaRapidIdentify
+ * @prop {string} omedaPromoCodeCookieName
+ * @prop {string} omedaPromoCodeDefault
+ *
+ * @typedef {OmedaHookFunctionArgs & OnAuthenticationSuccessFnParams} OnAuthenticationSuccessFnArgs
+ * @typedef OnAuthenticationSuccessFnParams
+ * @prop {OnAuthenticationSuccessFormatterFn} formatter
+ *
+ * @typedef {OmedaHookFunctionArgs & OnLoginLinkSentFnParams} OnLoginLinkSentFnArgs
+ * @typedef OnLoginLinkSentFnParams
+ * @prop {OnLoginLinkSentFormatterFn} formatter
+ *
+ * @typedef {OmedaHookFunctionArgs & OnUserProfileUpdateFnParams} OnUserProfileUpdateFnArgs
+ * @typedef OnUserProfileUpdateFnParams
+ * @prop {OnUserProfileUpdateFormatterFn} formatter
+ */
+
+/**
+ * Arguments injected to hook formatter function
+ *
+ * @typedef OnAuthenticationSuccessFormatterArgs
+ * see [hook]({@link ./integration-hooks/on-authentication-success.js}) for
+ * @prop {OmedaRapidIdentificationPayload} payload
+ * @prop {string} promoCode the extracted promocode to be applied
+ *
+ * @typedef OnLoginLinkSentFormatterArgs
+ * see [hook]({@link ./integration-hooks/on-login-link-sent.js}) for
+ * @prop {OmedaRapidIdentificationPayload} payload
+ * @prop {OIDXLoginSource} source
+ *
+ * @typedef OnUserProfileUpdateFormatterArgs
+ * see [hook]({@link ./integration-hooks/on-user-profile-update.js}) for
+ * @prop {OmedaRapidIdentificationPayload} payload
+ */
+
+/**
+ * Payload formatter functions
+ *
+ * @callback OnAuthenticationSuccessFormatterFn
+ * @param {OnAuthenticationSuccessFormatterFnArgs} args
+ * @returns {Promise<OmedaRapidIdentificationPayload>}
+ *
+ * @callback OnLoginLinkSentFormatterFn
+ * @param {OnLoginLinkSentFormatterFnArgs} args
+ * @returns {Promise<OmedaRapidIdentificationPayload>}
+ *
+ * @callback OnUserProfileUpdateFormatterFn
+ * @param {OnUserProfileUpdateFormatterFnArgs} args
+ * @returns {Promise<OmedaRapidIdentificationPayload>}
+ */
+
+/**
+ * The payload to be modified by the formatter
+ *
+ * @typedef OmedaRapidIdentificationPayload
+ * @prop {IdentityXUser | UnverifiedUser} user
+ * @prop {object} behavior
+ * @prop {object} promoCode
+ * @prop {object[]} appendBehaviors
+ * @prop {object[]} appendDemographics
+ * @prop {object[]} appendPromoCodes
+ */
+
+/**
+ * @typedef UnverifiedUser
+ * @prop {string} id
+ * @prop {string} email
+ */
+
+/**
+ * Arguments passed to handler
+ *
+ * @typedef {OnAuthenticationSuccessHook &
+ *   OnAuthenticationSuccessFnArgs} OnAuthenticationSuccessHandlerArgs
+ *
+ * @typedef {OnLoginLinkSentHook &
+ *   OnLoginLinkSentFnArgs} OnLoginLinkSentHandlerArgs
+ *
+ * @typedef {OnUserProfileUpdateHook &
+ *   OnUserProfileUpdateFnArgs} OnUserProfileUpdateHandlerArgs
+ */
+
+/**
+ * Arguments passed to formatter function to modify payload
+ *
+ * @typedef {OnAuthenticationSuccessHandlerArgs &
+ *   OnAuthenticationSuccessFormatterArgs} OnAuthenticationSuccessFormatterFnArgs
+ * @typedef {OnLoginLinkSentHandlerArgs &
+ *   OnLoginLinkSentFormatterArgs} OnLoginLinkSentFormatterFnArgs
+ * @typedef {OnUserProfileUpdateHandlerArgs &
+ *   OnUserProfileUpdateFormatterArgs} OnUserProfileUpdateFormatterFnArgs
+ */

package/integration-hooks/on-authentication-success.js

@@ -6,7 +6,12 @@ const findEncryptedId = require('../external-id/find-encrypted-customer-id');
 const props = require('../validation/props');
 const schemas = require('../validation/schemas');
 
+/**
+ * @param {import('..').OnAuthenticationSuccessHandlerArgs} params
+ * @returns {Promise<void>}
+ */
 module.exports = async (params = {}) => {
+  /** @type {import('..').OnAuthenticationSuccessHandlerArgs} */
   const {
     appendBehaviors,
     appendDemographics,

package/integration-hooks/on-login-link-sent.js

@@ -10,7 +10,12 @@ const {
 } = require('../omeda-data');
 const props = require('../validation/props');
 
+/**
+ * @param {import('..').OnLoginLinkSentHandlerArgs} params
+ * @returns {Promise<void>}
+ */
 module.exports = async (params = {}) => {
+  /** @type {import('..').OnLoginLinkSentHandlerArgs} */
   const {
     appendBehaviors,
     appendDemographics,

package/integration-hooks/on-user-profile-update.js

@@ -3,7 +3,12 @@ const { validate } = require('@parameter1/joi/utils');
 const extractPromoCode = require('../utils/extract-promo-code');
 const schemas = require('../validation/schemas');
 
+/**
+ * @param {import('..').OnUserProfileUpdateHandlerArgs} params
+ * @returns {Promise<void>}
+ */
 module.exports = async (params = {}) => {
+  /** @type {import('..').OnUserProfileUpdateHandlerArgs} */
   const {
     appendBehaviors,
     appendDemographics,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mindful-web/marko-web-omeda-identity-x",
-  "version": "1.0.1",
+  "version": "1.8.0",
   "description": "Marko Omeda+IdentityX integration tools",
   "repository": "https://github.com/parameter1/mindful-web/tree/main/packages/marko-web-omeda-identity-x",
   "author": "Josh Worden <josh@parameter1.com>",
@@ -13,7 +13,7 @@
     "test": "yarn compile --no-clean && yarn lint"
   },
   "dependencies": {
-    "@mindful-web/marko-web-identity-x": "^1.0.1",
+    "@mindful-web/marko-web-identity-x": "^1.8.0",
     "@mindful-web/marko-web-omeda": "^1.0.1",
     "@mindful-web/object-path": "^1.0.0",
     "@mindful-web/utils": "^1.0.0",
@@ -29,5 +29,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "32a118ae20fc89f93c2c8c345a73cc2a65de18ae"
+  "gitHead": "b55245a64f03737d1e4fce9be0921bc10282750b"
 }