@reactionary/core 0.12.3 → 0.12.5

package/analytics/index.js

@@ -2,5 +2,6 @@ export * from "./context.js";
 export * from "./dispatcher.js";
 export * from "./legacy-adapter.js";
 export * from "./origins.js";
+export * from "./placed-order.js";
 export * from "./recording-subscriber.js";
 export * from "./refs.js";

package/analytics/placed-order.js

@@ -0,0 +1,15 @@
+function summarizePlacedOrder(payload) {
+  const { checkout, order } = payload;
+  const source = checkout ?? order;
+  if (!source) {
+    return void 0;
+  }
+  return {
+    transactionId: order?.identifier.key ?? checkout?.resultingOrder?.key ?? source.identifier.key,
+    items: source.items,
+    price: source.price
+  };
+}
+export {
+  summarizePlacedOrder
+};

package/capabilities/analytics.capability.js

@@ -50,6 +50,7 @@ import {
   AnalyticsMutationProductSharedSchema,
   AnalyticsMutationCustomSchema
 } from "../schemas/index.js";
+import { error } from "../schemas/result.js";
 import { BaseCapability } from "./base.capability.js";
 class AnalyticsCapability extends BaseCapability {
   dispatcher;
@@ -126,6 +127,9 @@ class AnalyticsCapability extends BaseCapability {
     return this.dispatcher.emit("payment-info-added", payload);
   }
   async orderPlaced(payload) {
+    if (!payload.checkout && !payload.order) {
+      return error({ type: "Generic", message: "orderPlaced needs a checkout (or the deprecated order)" });
+    }
     return this.dispatcher.emit("order-placed", payload);
   }
   async quoteRequested(payload) {

package/capabilities/identity.capability.js

@@ -1,4 +1,5 @@
 import { BaseCapability } from "./base.capability.js";
+const PENDING_EXTERNAL_LOGIN_TTL_MS = 10 * 60 * 1e3;
 class IdentityCapability extends BaseCapability {
   getResourceName() {
     return "identity";
@@ -7,6 +8,19 @@ class IdentityCapability extends BaseCapability {
     this.context.session.identityContext.lastUpdated = /* @__PURE__ */ new Date();
     this.context.session.identityContext.identity = identity;
   }
+  setPendingExternalLogin(provider, state) {
+    this.context.session.identityContext.pendingExternalLogin = { provider, state, createdAt: /* @__PURE__ */ new Date() };
+  }
+  /** Returns true, and clears the pending login, when provider and state match a login started in this session within the last 10 minutes. */
+  consumePendingExternalLogin(provider, state) {
+    const pending = this.context.session.identityContext.pendingExternalLogin;
+    delete this.context.session.identityContext.pendingExternalLogin;
+    if (!pending || !state) {
+      return false;
+    }
+    const fresh = Date.now() - new Date(pending.createdAt).getTime() <= PENDING_EXTERNAL_LOGIN_TTL_MS;
+    return fresh && pending.provider === provider && pending.state === state;
+  }
 }
 export {
   IdentityCapability

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.12.3",
+  "version": "0.12.5",
   "type": "module",
   "main": "./index.js",
   "types": "./src/index.d.ts",

package/schemas/errors/identity-conflict.error.js

@@ -0,0 +1,8 @@
+import * as z from "zod";
+const IdentityConflictErrorSchema = z.looseObject({
+  type: z.literal("IdentityConflict"),
+  message: z.string().nonempty()
+});
+export {
+  IdentityConflictErrorSchema
+};

package/schemas/errors/index.js

@@ -1,4 +1,5 @@
 export * from "./generic.error.js";
+export * from "./identity-conflict.error.js";
 export * from "./invalid-input.error.js";
 export * from "./invalid-output.error.js";
 export * from "./not-found.error.js";

package/schemas/models/identity-provider.model.js

@@ -0,0 +1,26 @@
+import * as z from "zod";
+import { BaseModelSchema } from "./base.model.js";
+const IdentityProviderIdentifierSchema = z.looseObject({
+  key: z.string()
+});
+const IdentityProviderSchema = BaseModelSchema.extend({
+  identifier: IdentityProviderIdentifierSchema,
+  displayName: z.string(),
+  brand: z.string().optional().meta({ description: "A neutral slug for the identity provider's brand, such as google, apple, amazon, facebook, microsoft or email, so a storefront can choose its own icon. Absent when the brand is not known." }),
+  flow: z.enum(["credentials", "redirect"]).meta({ description: "credentials: the shopper types a username and password into the storefront. redirect: the shopper is sent to an external identity provider and returns with a code." })
+});
+const ExternalLoginRedirectSchema = z.looseObject({
+  location: z.url().meta({ description: "Where to send the shopper to authenticate with the external identity provider." })
+});
+const PASSWORD_IDENTITY_PROVIDER = IdentityProviderSchema.parse({
+  identifier: { key: "password" },
+  displayName: "Email and password",
+  brand: "email",
+  flow: "credentials"
+});
+export {
+  ExternalLoginRedirectSchema,
+  IdentityProviderIdentifierSchema,
+  IdentityProviderSchema,
+  PASSWORD_IDENTITY_PROVIDER
+};

package/schemas/models/index.js

@@ -6,6 +6,7 @@ export * from "./category.model.js";
 export * from "./currency.model.js";
 export * from "./identifiers.model.js";
 export * from "./identity.model.js";
+export * from "./identity-provider.model.js";
 export * from "./inventory.model.js";
 export * from "./payment.model.js";
 export * from "./price.model.js";

package/schemas/mutations/analytics/events/commerce.mutation.js

@@ -1,6 +1,7 @@
 import * as z from "zod";
 import { AnalyticsCouponRejectionReasonSchema, AnalyticsStoreRefSchema } from "../../../models/analytics/event-parts.model.js";
 import { CartItemSchema, CartSchema } from "../../../models/cart.model.js";
+import { CheckoutSchema } from "../../../models/checkout.model.js";
 import { CompanySchema } from "../../../models/company.model.js";
 import { ProductVariantIdentifierSchema } from "../../../models/identifiers.model.js";
 import { OrderSchema } from "../../../models/order.model.js";
@@ -50,7 +51,8 @@ const AnalyticsMutationPaymentInfoAddedSchema = AnalyticsEventMutationBaseSchema
   paymentMethod: PaymentMethodSchema
 });
 const AnalyticsMutationOrderPlacedSchema = AnalyticsEventMutationBaseSchema.extend({
-  order: OrderSchema
+  checkout: CheckoutSchema.optional().meta({ description: "The finalized checkout: what the customer placed. Preferred over order, as the order may not exist yet when the OMS is the order source. Either checkout or order is required." }),
+  order: OrderSchema.optional().meta({ description: "Deprecated: pass the checkout instead. Either checkout or order is required.", deprecated: true })
 });
 const AnalyticsMutationQuoteRequestedSchema = AnalyticsEventMutationBaseSchema.extend({
   cart: CartSchema

package/schemas/mutations/identity.mutation.js

@@ -1,5 +1,6 @@
 import * as z from "zod";
 import { BaseMutationSchema } from "./base.mutation.js";
+import { IdentityProviderIdentifierSchema } from "../models/identity-provider.model.js";
 const IdentityMutationLoginSchema = BaseMutationSchema.extend({
   username: z.string(),
   password: z.string()
@@ -9,8 +10,19 @@ const IdentityMutationRegisterSchema = BaseMutationSchema.extend({
   username: z.string(),
   password: z.string()
 });
+const IdentityMutationStartExternalLoginSchema = BaseMutationSchema.extend({
+  provider: IdentityProviderIdentifierSchema,
+  callbackUrl: z.url().meta({ description: "The storefront URL the identity provider returns the shopper to. Must be registered with the identity provider." })
+});
+const IdentityMutationCompleteExternalLoginSchema = BaseMutationSchema.extend({
+  provider: IdentityProviderIdentifierSchema,
+  callbackUrl: z.url().meta({ description: "The same callbackUrl that was passed to startExternalLogin." }),
+  callbackParameters: z.record(z.string(), z.string()).meta({ description: "The query parameters the identity provider appended to the callback URL, passed through unchanged." })
+});
 export {
+  IdentityMutationCompleteExternalLoginSchema,
   IdentityMutationLoginSchema,
   IdentityMutationLogoutSchema,
-  IdentityMutationRegisterSchema
+  IdentityMutationRegisterSchema,
+  IdentityMutationStartExternalLoginSchema
 };

package/schemas/queries/identity.query.js

@@ -1,5 +1,7 @@
 import { BaseQuerySchema } from "./base.query.js";
 const IdentityQuerySelfSchema = BaseQuerySchema.extend({});
+const IdentityQueryProvidersSchema = BaseQuerySchema.extend({});
 export {
+  IdentityQueryProvidersSchema,
   IdentityQuerySelfSchema
 };

package/schemas/session.schema.js

@@ -11,7 +11,12 @@ const LanguageContextSchema = z.looseObject({
 });
 const IdentityContextSchema = z.looseObject({
   identity: IdentitySchema,
-  lastUpdated: z.coerce.date()
+  lastUpdated: z.coerce.date(),
+  pendingExternalLogin: z.looseObject({
+    provider: z.string(),
+    state: z.string(),
+    createdAt: z.coerce.date()
+  }).optional().meta({ description: "An external login that has been started but not completed. Binds the callback to the browser that started it." })
 });
 const SessionSchema = z.looseObject({
   id: z.string().optional().meta({ description: "The id of the visitor's current session, set by the storefront. A long-lived visitor id belongs in marketingContext.identifier, not here." }),

package/src/analytics/index.d.ts

@@ -2,5 +2,6 @@ export * from './context.js';
 export * from './dispatcher.js';
 export * from './legacy-adapter.js';
 export * from './origins.js';
+export * from './placed-order.js';
 export * from './recording-subscriber.js';
 export * from './refs.js';

package/src/analytics/placed-order.d.ts

@@ -0,0 +1,24 @@
+import type { Checkout } from '../schemas/models/checkout.model.js';
+import type { CostBreakDown, ItemCostBreakdown } from '../schemas/models/cost.model.js';
+import type { ProductVariantIdentifier } from '../schemas/models/identifiers.model.js';
+import type { Order } from '../schemas/models/order.model.js';
+export interface PlacedOrderLine {
+    variant: ProductVariantIdentifier;
+    quantity: number;
+    price: ItemCostBreakdown;
+}
+/** What an analytics subscriber needs to report a purchase, whether it was given a checkout or an order. */
+export interface PlacedOrderSummary {
+    /** The order key when it is known, otherwise the key of the checkout that created it. */
+    transactionId: string;
+    items: PlacedOrderLine[];
+    price: CostBreakDown;
+}
+/**
+ * Normalizes an order-placed payload. The checkout is preferred, as it is what the customer placed; the order is
+ * the deprecated alternative. Returns undefined when the payload carries neither.
+ */
+export declare function summarizePlacedOrder(payload: {
+    checkout?: Checkout;
+    order?: Order;
+}): PlacedOrderSummary | undefined;

package/src/capabilities/identity.capability.d.ts

@@ -1,6 +1,8 @@
+import type { ExternalLoginRedirect, IdentityProvider } from "../schemas/models/identity-provider.model.js";
 import type { Identity } from "../schemas/models/identity.model.js";
-import type { IdentityMutationLogin, IdentityMutationLogout, IdentityMutationRegister } from "../schemas/mutations/identity.mutation.js";
-import type { IdentityQuerySelf } from "../schemas/queries/identity.query.js";
+import type { IdentityConflictError } from "../schemas/errors/identity-conflict.error.js";
+import type { IdentityMutationCompleteExternalLogin, IdentityMutationLogin, IdentityMutationLogout, IdentityMutationRegister, IdentityMutationStartExternalLogin } from "../schemas/mutations/identity.mutation.js";
+import type { IdentityQueryProviders, IdentityQuerySelf } from "../schemas/queries/identity.query.js";
 import type { Result } from "../schemas/result.js";
 import { BaseCapability } from "./base.capability.js";
 export declare abstract class IdentityCapability<TIdentity extends Identity = Identity> extends BaseCapability {
@@ -8,6 +10,15 @@ export declare abstract class IdentityCapability<TIdentity extends Identity = Id
     abstract login(payload: IdentityMutationLogin): Promise<Result<TIdentity>>;
     abstract logout(payload: IdentityMutationLogout): Promise<Result<TIdentity>>;
     abstract register(payload: IdentityMutationRegister): Promise<Result<TIdentity>>;
+    /** The ways a shopper can sign in with this backend. */
+    abstract listProviders(payload: IdentityQueryProviders): Promise<Result<IdentityProvider[]>>;
+    /** Begins a redirect flow. The caller sends the shopper to the returned location. */
+    abstract startExternalLogin(payload: IdentityMutationStartExternalLogin): Promise<Result<ExternalLoginRedirect>>;
+    /** Completes a redirect flow from the parameters the identity provider appended to the callback URL. */
+    abstract completeExternalLogin(payload: IdentityMutationCompleteExternalLogin): Promise<Result<TIdentity, IdentityConflictError>>;
     protected getResourceName(): string;
     protected updateIdentityContext(identity: TIdentity): void;
+    protected setPendingExternalLogin(provider: string, state: string): void;
+    /** Returns true, and clears the pending login, when provider and state match a login started in this session within the last 10 minutes. */
+    protected consumePendingExternalLogin(provider: string, state: string | undefined): boolean;
 }

package/src/schemas/errors/identity-conflict.error.d.ts

@@ -0,0 +1,7 @@
+import * as z from 'zod';
+import type { InferType } from '../../zod-utils.js';
+export declare const IdentityConflictErrorSchema: z.ZodObject<{
+    type: z.ZodLiteral<"IdentityConflict">;
+    message: z.ZodString;
+}, z.core.$loose>;
+export type IdentityConflictError = InferType<typeof IdentityConflictErrorSchema>;

package/src/schemas/errors/index.d.ts

@@ -1,4 +1,5 @@
 export * from './generic.error.js';
+export * from './identity-conflict.error.js';
 export * from './invalid-input.error.js';
 export * from './invalid-output.error.js';
 export * from './not-found.error.js';