@teleporthq/teleport-shared 0.43.67 → 0.43.69

package/dist/esm/utils/web-push.d.ts

@@ -0,0 +1,43 @@
+/**
+ * The names the published app's service worker, its push routes and the
+ * workflow nodes that use them have to agree on. The node handlers are
+ * serialized into the generated app as source text, so they interpolate these
+ * values at generation time rather than importing them.
+ */
+/** The browsers that agreed to receive the app's push notifications, in the project database. */
+export declare const SUBSCRIPTIONS_TABLE = "teleport_push_subscriptions";
+/** Public: a browser saves (POST) or forgets (DELETE) its own subscription here. */
+export declare const SUBSCRIPTIONS_ROUTE = "/api/push/subscriptions";
+/** Internal: only the app's own server code may send a notification through it. */
+export declare const SEND_ROUTE = "/api/push/send";
+/** What a visitor-facing push step reports when the project has no push keys or no worker. */
+export declare const NOT_CONFIGURED_MESSAGE = "Push notifications are not set up for this site.";
+export declare const PUBLIC_KEY_ENV = "WEB_PUSH_VAPID_PUBLIC_KEY";
+/** Filled at deploy from the project secret of the same name. */
+export declare const PRIVATE_KEY_ENV = "WEB_PUSH_VAPID_PRIVATE_KEY";
+/**
+ * The send route accepts a request only when this header carries an HMAC of
+ * `SEND_TOKEN_PURPOSE` keyed with the VAPID private key — a value only the
+ * app's own server holds, so no extra secret has to be provisioned.
+ */
+export declare const SEND_TOKEN_HEADER = "x-teleport-push-token";
+export declare const SEND_TOKEN_PURPOSE = "teleport-web-push-send";
+/**
+ * The page-side API the generated service-worker module publishes on `window`.
+ * A workflow node handler has no module scope, so a global is the only way it
+ * can reach the worker registration.
+ */
+export declare const SERVICE_WORKER_GLOBAL = "__teleportServiceWorker";
+export declare const SUBSCRIBE_NODE_TYPE = "browser-subscribe-to-push";
+export declare const UNSUBSCRIBE_NODE_TYPE = "browser-unsubscribe-from-push";
+export declare const GET_SUBSCRIPTION_NODE_TYPE = "browser-get-push-subscription";
+export declare const SHOW_NOTIFICATION_NODE_TYPE = "browser-show-notification";
+export declare const SEND_NODE_TYPE = "push-send-notification";
+/** Nodes that manage the visitor's push subscription and therefore need the push routes. */
+export declare const PUSH_NODE_TYPES: ReadonlyArray<string>;
+/**
+ * Nodes that need a service worker on the page: push itself, and on-page
+ * notifications, which Chrome on Android only shows through a worker.
+ */
+export declare const SERVICE_WORKER_NODE_TYPES: ReadonlyArray<string>;
+//# sourceMappingURL=web-push.d.ts.map

package/dist/esm/utils/web-push.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-push.d.ts","sourceRoot":"","sources":["../../../src/utils/web-push.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,iGAAiG;AACjG,eAAO,MAAM,mBAAmB,gCAAgC,CAAA;AAEhE,oFAAoF;AACpF,eAAO,MAAM,mBAAmB,4BAA4B,CAAA;AAE5D,mFAAmF;AACnF,eAAO,MAAM,UAAU,mBAAmB,CAAA;AAE1C,8FAA8F;AAC9F,eAAO,MAAM,sBAAsB,qDAAqD,CAAA;AAExF,eAAO,MAAM,cAAc,8BAA8B,CAAA;AAEzD,iEAAiE;AACjE,eAAO,MAAM,eAAe,+BAA+B,CAAA;AAE3D;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,0BAA0B,CAAA;AACxD,eAAO,MAAM,kBAAkB,2BAA2B,CAAA;AAE1D;;;;GAIG;AACH,eAAO,MAAM,qBAAqB,4BAA4B,CAAA;AAE9D,eAAO,MAAM,mBAAmB,8BAA8B,CAAA;AAC9D,eAAO,MAAM,qBAAqB,kCAAkC,CAAA;AACpE,eAAO,MAAM,0BAA0B,kCAAkC,CAAA;AACzE,eAAO,MAAM,2BAA2B,8BAA8B,CAAA;AACtE,eAAO,MAAM,cAAc,2BAA2B,CAAA;AAEtD,4FAA4F;AAC5F,eAAO,MAAM,eAAe,EAAE,aAAa,CAAC,MAAM,CAKjD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,yBAAyB,EAAE,aAAa,CAAC,MAAM,CAG3D,CAAA"}

package/dist/esm/utils/web-push.js

@@ -0,0 +1,59 @@
+/**
+ * The names the published app's service worker, its push routes and the
+ * workflow nodes that use them have to agree on. The node handlers are
+ * serialized into the generated app as source text, so they interpolate these
+ * values at generation time rather than importing them.
+ */
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+/** The browsers that agreed to receive the app's push notifications, in the project database. */
+export var SUBSCRIPTIONS_TABLE = 'teleport_push_subscriptions';
+/** Public: a browser saves (POST) or forgets (DELETE) its own subscription here. */
+export var SUBSCRIPTIONS_ROUTE = '/api/push/subscriptions';
+/** Internal: only the app's own server code may send a notification through it. */
+export var SEND_ROUTE = '/api/push/send';
+/** What a visitor-facing push step reports when the project has no push keys or no worker. */
+export var NOT_CONFIGURED_MESSAGE = 'Push notifications are not set up for this site.';
+export var PUBLIC_KEY_ENV = 'WEB_PUSH_VAPID_PUBLIC_KEY';
+/** Filled at deploy from the project secret of the same name. */
+export var PRIVATE_KEY_ENV = 'WEB_PUSH_VAPID_PRIVATE_KEY';
+/**
+ * The send route accepts a request only when this header carries an HMAC of
+ * `SEND_TOKEN_PURPOSE` keyed with the VAPID private key — a value only the
+ * app's own server holds, so no extra secret has to be provisioned.
+ */
+export var SEND_TOKEN_HEADER = 'x-teleport-push-token';
+export var SEND_TOKEN_PURPOSE = 'teleport-web-push-send';
+/**
+ * The page-side API the generated service-worker module publishes on `window`.
+ * A workflow node handler has no module scope, so a global is the only way it
+ * can reach the worker registration.
+ */
+export var SERVICE_WORKER_GLOBAL = '__teleportServiceWorker';
+export var SUBSCRIBE_NODE_TYPE = 'browser-subscribe-to-push';
+export var UNSUBSCRIBE_NODE_TYPE = 'browser-unsubscribe-from-push';
+export var GET_SUBSCRIPTION_NODE_TYPE = 'browser-get-push-subscription';
+export var SHOW_NOTIFICATION_NODE_TYPE = 'browser-show-notification';
+export var SEND_NODE_TYPE = 'push-send-notification';
+/** Nodes that manage the visitor's push subscription and therefore need the push routes. */
+export var PUSH_NODE_TYPES = [
+    SUBSCRIBE_NODE_TYPE,
+    UNSUBSCRIBE_NODE_TYPE,
+    GET_SUBSCRIPTION_NODE_TYPE,
+    SEND_NODE_TYPE,
+];
+/**
+ * Nodes that need a service worker on the page: push itself, and on-page
+ * notifications, which Chrome on Android only shows through a worker.
+ */
+export var SERVICE_WORKER_NODE_TYPES = __spreadArray(__spreadArray([], PUSH_NODE_TYPES, true), [
+    SHOW_NOTIFICATION_NODE_TYPE,
+], false);
+//# sourceMappingURL=web-push.js.map

package/dist/esm/utils/web-push.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web-push.js","sourceRoot":"","sources":["../../../src/utils/web-push.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;;;;;;;;;AAEH,iGAAiG;AACjG,MAAM,CAAC,IAAM,mBAAmB,GAAG,6BAA6B,CAAA;AAEhE,oFAAoF;AACpF,MAAM,CAAC,IAAM,mBAAmB,GAAG,yBAAyB,CAAA;AAE5D,mFAAmF;AACnF,MAAM,CAAC,IAAM,UAAU,GAAG,gBAAgB,CAAA;AAE1C,8FAA8F;AAC9F,MAAM,CAAC,IAAM,sBAAsB,GAAG,kDAAkD,CAAA;AAExF,MAAM,CAAC,IAAM,cAAc,GAAG,2BAA2B,CAAA;AAEzD,iEAAiE;AACjE,MAAM,CAAC,IAAM,eAAe,GAAG,4BAA4B,CAAA;AAE3D;;;;GAIG;AACH,MAAM,CAAC,IAAM,iBAAiB,GAAG,uBAAuB,CAAA;AACxD,MAAM,CAAC,IAAM,kBAAkB,GAAG,wBAAwB,CAAA;AAE1D;;;;GAIG;AACH,MAAM,CAAC,IAAM,qBAAqB,GAAG,yBAAyB,CAAA;AAE9D,MAAM,CAAC,IAAM,mBAAmB,GAAG,2BAA2B,CAAA;AAC9D,MAAM,CAAC,IAAM,qBAAqB,GAAG,+BAA+B,CAAA;AACpE,MAAM,CAAC,IAAM,0BAA0B,GAAG,+BAA+B,CAAA;AACzE,MAAM,CAAC,IAAM,2BAA2B,GAAG,2BAA2B,CAAA;AACtE,MAAM,CAAC,IAAM,cAAc,GAAG,wBAAwB,CAAA;AAEtD,4FAA4F;AAC5F,MAAM,CAAC,IAAM,eAAe,GAA0B;IACpD,mBAAmB;IACnB,qBAAqB;IACrB,0BAA0B;IAC1B,cAAc;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,IAAM,yBAAyB,mCACjC,eAAe;IAClB,2BAA2B;SAC5B,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teleporthq/teleport-shared",
-  "version": "0.43.67",
+  "version": "0.43.69",
   "description": "A utility belt for the entire teleportHQ ecosystem",
   "author": "teleportHQ",
   "license": "MIT",
@@ -25,9 +25,9 @@
   },
   "dependencies": {
     "@babel/types": "^7.5.5",
-    "@teleporthq/teleport-types": "^0.43.67",
+    "@teleporthq/teleport-types": "^0.43.68",
     "jss": "^10.0.0",
     "jss-preset-default": "^10.0.0"
   },
-  "gitHead": "692355951ec33ee4b89018177e7ec4d58a66c073"
+  "gitHead": "ff9293d65ac3dd46ac196c5575c65d59e2006a28"
 }

package/src/index.ts

@@ -15,12 +15,20 @@ import * as StorefrontTax from './utils/storefront-tax'
 import * as ProductDiscounts from './utils/product-discounts'
 import * as ProductRatings from './utils/product-ratings'
 import * as RegionalPricing from './utils/regional-pricing'
+import * as DiscountEngine from './utils/discount-engine'
+import * as ProductOptions from './utils/product-options'
+import * as CartLinePricing from './utils/cart-line-pricing'
+import * as CartCurrency from './utils/cart-currency'
+import * as TableAccess from './utils/table-access'
+import * as SessionCookieResolver from './utils/session-cookie-resolver'
+import * as SubscriptionAccess from './utils/subscription-access'
 import * as FontPreconnect from './utils/font-preconnect'
 import * as EmailDate from './utils/email-date'
 import * as RichTextEmbeds from './utils/rich-text-embeds'
 import * as RichTextEmbedsCodegen from './utils/rich-text-embeds-codegen'
 import * as DataCache from './cache'
 import * as PageRevalidate from './page-revalidate'
+import * as WebPush from './utils/web-push'
 
 export {
   Constants,
@@ -40,10 +48,18 @@ export {
   ProductDiscounts,
   ProductRatings,
   RegionalPricing,
+  DiscountEngine,
+  ProductOptions,
+  CartLinePricing,
+  CartCurrency,
+  TableAccess,
+  SessionCookieResolver,
+  SubscriptionAccess,
   FontPreconnect,
   EmailDate,
   RichTextEmbeds,
   RichTextEmbedsCodegen,
   DataCache,
   PageRevalidate,
+  WebPush,
 }

package/src/utils/cart-currency.ts

@@ -0,0 +1,76 @@
+/**
+ * The currency a cart is priced in, as ES5 source for generated runtime code
+ * (the add-to-cart node, the storefront cart provider, the cart total and the
+ * checkout's server pricing step) that cannot import from this package.
+ *
+ * Every product carries its own currency, and nothing converts between them:
+ * an order is recorded and charged in ONE currency, so a cart holds products
+ * of one currency only — the same way it holds one kind of line (see the kind
+ * rule beside it in `cart-add-item`). The cart's currency is the currency of
+ * its lines; a line that names none (a cart saved before lines carried it)
+ * takes no part in the rule.
+ *
+ * ⚠️ PAIRED with teleport-gui's cart simulator
+ * (`features/e-commerce/utils/cart-kinds.ts`): the refusal reason and message
+ * must stay byte-identical to what the published store toasts.
+ *
+ * ⛔ Every helper takes ONE parameter. The block is appended to a serialized
+ * handler whose entry point a minified build finds by arity (a 2-param
+ * declaration wins — see `resolveHandlerEntryName`), so a 2-param helper would
+ * be called in place of the handler. Everything is prefixed `__cc` so the block
+ * can be concatenated into any generated module without colliding with its
+ * locals.
+ */
+
+/** The reason an add-to-cart refusal answers for a line of another currency. */
+export const MIXED_CURRENCY_REASON = 'mixed-currency'
+
+export const generateCartCurrencyHelperCode = (): string => `
+// ── Cart currency ────────────────────────────────────────────────────────────
+// A three-letter ISO code, upper-cased, or '' for anything else.
+function __ccCode(value) {
+  var code = String(value == null ? '' : value).trim().toUpperCase();
+  return /^[A-Z]{3}$/.test(code) ? code : '';
+}
+
+// The currency of the cart: the first line that names one, or ''.
+function __ccCartCurrency(lines) {
+  if (!lines || typeof lines.length !== 'number') { return ''; }
+  for (var i = 0; i < lines.length; i++) {
+    var code = __ccCode(lines[i] ? lines[i].currency : '');
+    if (code) { return code; }
+  }
+  return '';
+}
+
+// Every currency the lines name, in the order they first appear.
+function __ccCurrencies(lines) {
+  var codes = [];
+  if (!lines || typeof lines.length !== 'number') { return codes; }
+  for (var i = 0; i < lines.length; i++) {
+    var code = __ccCode(lines[i] ? lines[i].currency : '');
+    if (code && codes.indexOf(code) === -1) { codes.push(code); }
+  }
+  return codes;
+}
+
+// Why a line priced in \`input.currency\` cannot join \`input.lines\` (the OTHER
+// lines of the cart), or null when it can.
+function __ccCurrencyRefusal(input) {
+  var lineCurrency = __ccCode(input ? input.currency : '');
+  var cartCurrency = __ccCartCurrency(input ? input.lines : null);
+  if (!lineCurrency || !cartCurrency || lineCurrency === cartCurrency) { return null; }
+  return {
+    added: false,
+    reason: '${MIXED_CURRENCY_REASON}',
+    message: 'Products priced in ' + lineCurrency + ' need a separate order. Complete your current order or remove the items priced in ' + cartCurrency + ' from your cart first.'
+  };
+}
+
+// What the checkout says when a cart still holds several currencies (a cart
+// merged at sign-in, or a product whose currency changed after it was added).
+function __ccMixedCartMessage(codes) {
+  var named = codes.length > 1 ? codes.slice(0, -1).join(', ') + ' and ' + codes[codes.length - 1] : codes.join('');
+  return 'Your cart holds products priced in ' + named + '. Each currency needs its own order: remove the products priced in one of them and try again.';
+}
+`

package/src/utils/cart-line-pricing.ts

@@ -0,0 +1,151 @@
+/**
+ * What one cart line costs, read off its product (and variant) row, as ES5
+ * source for generated runtime code that cannot import from this package.
+ *
+ * TWO READERS, ONE RULE. The storefront provider re-prices every line with it
+ * when it hydrates the cart (`enrichCartItems` in the e-commerce context), and
+ * the checkout's server step prices the order with it (`cart-price-order` in
+ * the workflows plugin) — so what the buyer is shown and what the order is
+ * charged come from the same arithmetic over the same row. A price the
+ * browser holds is never an input: the line keeps only what the buyer chose
+ * (product, variant, options, quantity).
+ *
+ * The rule: the variant's price overrides the product's; the per-product
+ * markdown live at `nowMs` comes off that NET price; the chosen options'
+ * surcharge is added on top of the charged base (options are never marked
+ * down). A subscription is one unit.
+ *
+ * Needs, in the same scope: the per-product discount helpers (`__pd*`,
+ * `ProductDiscounts.generateProductDiscountHelperCode`), the product-option
+ * helpers (`__po*`, `ProductOptions.generateProductOptionsHelperCode`) and the
+ * discount engine's row readers (`__deStringArray`, `__deBool`,
+ * `DiscountEngine.generateDiscountEngineHelperCode`).
+ */
+export const generateCartLinePricingHelperCode = (): string => `
+// ── Cart line pricing ────────────────────────────────────────────────────────
+var __CL_BILLING_INTERVALS = ['day', 'week', 'month', 'year'];
+
+function __clIsRecurring(product) {
+  return String((product && product.payment_type) || '').trim().toLowerCase() === 'recurring';
+}
+
+function __clBillingInterval(value) {
+  var normalized = String(value == null ? '' : value).trim().toLowerCase();
+  return __CL_BILLING_INTERVALS.indexOf(normalized) !== -1 ? normalized : 'month';
+}
+
+function __clBillingIntervalCount(value) {
+  var parsed = Math.floor(Number(value));
+  return isFinite(parsed) && parsed >= 1 ? parsed : 1;
+}
+
+function __clPositiveCount(value) {
+  if (value === null || value === undefined || value === '') { return null; }
+  var parsed = Math.floor(Number(value));
+  return isFinite(parsed) && parsed > 0 ? parsed : null;
+}
+
+// The chosen options re-priced from the product's CURRENT definitions on the
+// charged base, and whether the answers still fit (\`configurationStale\`, which
+// the checkout refuses). Null for a line with no answers of a product with no
+// options, which is priced exactly as before; cleared fields for a line that
+// carried options its product no longer has.
+function __clPriceLineOptions(item, product, basePrice) {
+  var entries = __poParseEntries(item.configuration);
+  if (entries.length === 0 && __poParseGroups(product.option_groups).length === 0) {
+    if (item.basePrice == null && item.configurationLabel == null && item.configurationPriceDelta == null && item.configurationStale == null) { return null; }
+    return { basePrice: null, configurationLabel: null, configurationPriceDelta: null, configurationStale: null };
+  }
+  var resolved = __poResolveForRow(product, basePrice, entries);
+  return {
+    basePrice: basePrice,
+    configurationLabel: resolved.label,
+    configurationPriceDelta: resolved.delta,
+    configurationStale: !resolved.valid
+  };
+}
+
+// "Red / XL" — the variant's value labels along the product's (language-
+// resolved) option axes.
+function __clVariantLabel(variantOptionsRaw, optionsMap) {
+  var axes = variantOptionsRaw;
+  if (typeof axes === 'string') { try { axes = JSON.parse(axes); } catch (e) { axes = []; } }
+  if (!Array.isArray(axes)) { return ''; }
+  var opts = optionsMap;
+  if (typeof opts === 'string') { try { opts = JSON.parse(opts); } catch (e) { opts = {}; } }
+  if (!opts) { opts = {}; }
+  var parts = [];
+  for (var a = 0; a < axes.length; a++) {
+    var axis = axes[a];
+    if (!axis || !axis.key) { continue; }
+    var valueKey = opts[axis.key];
+    if (valueKey == null) { continue; }
+    var label = valueKey;
+    var values = Array.isArray(axis.values) ? axis.values : [];
+    for (var v = 0; v < values.length; v++) { if (values[v] && values[v].value === valueKey) { label = values[v].label || valueKey; break; } }
+    parts.push(label);
+  }
+  return parts.join(' / ');
+}
+
+// The colour(s) of the variant's value on every COLOUR axis, for the swatch
+// shown beside the label.
+function __clVariantSwatches(variantOptionsRaw, optionsMap) {
+  var axes = variantOptionsRaw;
+  if (typeof axes === 'string') { try { axes = JSON.parse(axes); } catch (e) { axes = []; } }
+  if (!Array.isArray(axes)) { return []; }
+  var opts = optionsMap;
+  if (typeof opts === 'string') { try { opts = JSON.parse(opts); } catch (e) { opts = {}; } }
+  if (!opts) { opts = {}; }
+  var swatches = [];
+  for (var a = 0; a < axes.length; a++) {
+    var axis = axes[a];
+    if (!axis || !axis.key || axis.type !== 'color') { continue; }
+    var valueKey = opts[axis.key];
+    if (valueKey == null) { continue; }
+    var values = Array.isArray(axis.values) ? axis.values : [];
+    for (var v = 0; v < values.length; v++) { if (values[v] && values[v].value === valueKey && values[v].color) { swatches.push({ color: values[v].color }); break; } }
+  }
+  return swatches;
+}
+
+// The line's price and everything the totals read off its product, for the
+// row as it is at \`nowMs\`. \`withWeight\` adds the weight the regional
+// shipping rates price by.
+function __clPriceLine(item, product, variant, nowMs, withWeight) {
+  var price = product.price != null ? Number(product.price) : 0;
+  if (variant && variant.price != null) { price = Number(variant.price); }
+  var discount = __pdResolveActive(product.discounts, nowMs);
+  var listPrice = price;
+  price = __pdDiscountedPrice(listPrice, discount);
+  var options = __clPriceLineOptions(item, product, price);
+  var optionsDelta = options ? options.configurationPriceDelta : null;
+  var recurring = __clIsRecurring(product);
+  var priced = {
+    price: optionsDelta != null ? __poRound2(price + optionsDelta) : price,
+    originalPrice: discount ? (optionsDelta != null ? __poRound2(listPrice + optionsDelta) : listPrice) : null,
+    discountType: discount ? discount.type : null,
+    discountValue: discount ? discount.value : null,
+    discountAmount: discount ? __pdDiscountAmount(listPrice, discount) : 0,
+    categoryIds: __deStringArray(product.category_filter_ids || product.category_ids),
+    isGiftCard: __deBool(product.is_gift_card, false),
+    isRecurring: recurring,
+    recurringInterval: recurring ? __clBillingInterval(product.recurring_interval) : null,
+    recurringIntervalCount: recurring ? __clBillingIntervalCount(product.recurring_interval_count) : null,
+    trialDays: recurring ? __clPositiveCount(product.trial_days) : null,
+    isDigital: __deBool(product.is_digital, false),
+    quantity: recurring ? 1 : item.quantity
+  };
+  if (withWeight) {
+    priced.weight = product.weight != null ? Number(product.weight) : null;
+    priced.weightUnit = product.weight_unit || null;
+  }
+  if (options) {
+    priced.basePrice = options.basePrice;
+    priced.configurationLabel = options.configurationLabel;
+    priced.configurationPriceDelta = options.configurationPriceDelta;
+    priced.configurationStale = options.configurationStale;
+  }
+  return priced;
+}
+`