@optizio/merchant-identity 0.1.0 → 0.2.0

package/dist/index.d.ts

@@ -59,7 +59,12 @@ export interface StoredMerchant {
     shopDomain: string;
     shopGid: string | null;
     name: string | null;
+    /** Snapshot of the shop's Shopify email, refreshed by every identify capture. */
     email: string | null;
+    /** Merchant-set recipients for billing/account mail; empty means "use `email`". */
+    transactionalEmails: string[];
+    /** Merchant-set recipients for product news; empty means "use `email`". */
+    newsletterEmails: string[];
     planName: string | null;
     shopifyPlus: boolean | null;
     partnerDevelopment: boolean | null;
@@ -109,11 +114,22 @@ export interface StoreDetails {
     apps: StoredMerchantApp[];
     subscriptions: StoredMerchantSubscription[];
 }
+/**
+ * The two streams a merchant can address separately. This service only stores
+ * the split — it has no send path, so gating is the calling app's job:
+ * transactional mail (billing, security, account notices) always sends, while
+ * newsletter mail should be checked against
+ * `isSubscribed(shop, { topic: SUBSCRIPTION_TOPIC_NEWSLETTER })` first.
+ */
+export type ContactEmailType = 'transactional' | 'newsletter';
+export declare const CONTACT_EMAIL_TYPES: readonly ContactEmailType[];
 /** Sentinel stored for the `app_id` / `user_id` columns when a row applies to
  * every app / every user of a store. */
 export declare const SUBSCRIPTION_ALL_SCOPES = "*";
 /** Sentinel stored for the `topic` column when a row applies to all topics. */
 export declare const SUBSCRIPTION_ALL_TOPICS = "all";
+/** Topic for opt-out of product news. Transactional mail is never gated on it. */
+export declare const SUBSCRIPTION_TOPIC_NEWSLETTER = "newsletter";
 export interface SubscriptionScope {
     appId?: string;
     topic?: string;
@@ -137,6 +153,12 @@ export interface IdentityClient {
     captureMerchantUser(input: MerchantUserRecord): Promise<void>;
     touchMerchantApp(input: MerchantAppRecord): Promise<void>;
     markAppUninstalled(shopDomain: string, appId: string): Promise<void>;
+    /**
+     * Replace the merchant's recipients for one stream. Pass an empty array to
+     * clear the override so comms fall back to the captured Shopify shop email.
+     * Rejects a malformed address or an unknown type.
+     */
+    setContactEmails(shopDomain: string, type: ContactEmailType, emails: string[]): Promise<void>;
     setSubscription(input: MerchantSubscriptionRecord): Promise<void>;
     isSubscribed(shopDomain: string, scope?: SubscriptionScope): Promise<boolean>;
     getStoreDetails(shopDomain: string): Promise<StoreDetails>;

package/dist/index.js

@@ -10,6 +10,10 @@
  * This package holds only types + pure helpers, so it has no Cloudflare or
  * runtime dependencies and is safe to import anywhere.
  */
+export const CONTACT_EMAIL_TYPES = [
+    'transactional',
+    'newsletter',
+];
 /* -------------------------------------------------------------------------- */
 /* Subscriptions                                                              */
 /* -------------------------------------------------------------------------- */
@@ -18,6 +22,8 @@
 export const SUBSCRIPTION_ALL_SCOPES = '*';
 /** Sentinel stored for the `topic` column when a row applies to all topics. */
 export const SUBSCRIPTION_ALL_TOPICS = 'all';
+/** Topic for opt-out of product news. Transactional mail is never gated on it. */
+export const SUBSCRIPTION_TOPIC_NEWSLETTER = 'newsletter';
 /**
  * Resolve the effective subscribed state for a scope from a store's rows.
  * Most-specific match wins (user > app > topic); returns `null` when nothing
@@ -50,6 +56,7 @@ export const NOOP_IDENTITY = {
     async captureMerchantUser() { },
     async touchMerchantApp() { },
     async markAppUninstalled() { },
+    async setContactEmails() { },
     async setSubscription() { },
     async isSubscribed() {
         return true;

package/package.json

@@ -1,7 +1,12 @@
 {
   "name": "@optizio/merchant-identity",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Shared merchant/user identity types + RPC client contract for the merchant-hub portfolio.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/optizio/merchant-hub.git",
+    "directory": "packages/types"
+  },
   "type": "module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",