@universal-everything/sdk-core 1.2.0 → 1.3.0-dev.483b732

package/dist/index.d.ts

@@ -184,9 +184,10 @@ type ChainStatus = {
 type CoveredBy = {
     subscriptionId: string;
     /**
-     * `self` = owned by the caller's account. `other` (a foreign covering
-     * subscription) is reserved for R2's explicit membership — the server only
-     * emits `self` today.
+     * `self` = owned by the caller's account (its allowance pays for every
+     * profile it holds). `other` = a live subscription of another account that
+     * lists this profile as a member — it pays once the holder's own allowance
+     * is spent.
      */
     owner: "self" | "other";
     tier: string;
@@ -283,10 +284,20 @@ type Catalog = {
     store: BillingStore;
     plans: CatalogPlan[];
 };
-/** One entry of `GET /v1/subscriptions` — a subscription of the caller's account. */
+/** A profile a subscription pays for (its holder may be another account). */
+type SubscriptionMember = {
+    address: string;
+    /** Added by a client sync rather than by hand. */
+    auto: boolean;
+    attachedAt: string;
+};
+/**
+ * One entry of `GET /v1/subscriptions`: a subscription of the caller's account
+ * (`owner: "self"`), or a live subscription of another account that covers
+ * some of the caller's profiles (`owner: "other"`, listed after the own ones).
+ */
 type SubscriptionSummary = {
     subscriptionId: string;
-    /** Always `self` today; `other` (a subscription that only covers one of your profiles) arrives with explicit membership. */
     owner: "self" | "other";
     tier: string;
     status: string;
@@ -296,10 +307,28 @@ type SubscriptionSummary = {
     /** Bought in the store sandbox (TestFlight / App Review / sandbox tester) — no real money. */
     sandbox: boolean;
     currentPeriodEnd: string | null;
-    /** Where Manage goes: `stripe` ⇒ {@link RelayerClient.createPortalSession}; `apple` / `google` ⇒ the store; `admin` ⇒ nothing. */
+    /** Where Manage goes: `stripe` ⇒ {@link RelayerClient.createPortalSession}; `apple` / `google` ⇒ the store; `admin` ⇒ nothing; `none` ⇒ another account's subscription, read-only. */
     manage: {
-        kind: "stripe" | "apple" | "google" | "admin";
+        kind: "stripe" | "apple" | "google" | "admin" | "none";
     };
+    /** `owner: "self"` only — the profiles it pays for beyond the account's own. */
+    members?: SubscriptionMember[];
+    /** `owner: "other"` only — which of the caller's profiles it covers (lowercase). */
+    covers?: string[];
+};
+/** Result of {@link RelayerClient.addSubscriptionProfile}. */
+type AddSubscriptionProfileResult = {
+    subscriptionId: string;
+    address: string;
+    status: "attached";
+    auto: boolean;
+    attachedAt: string;
+}
+/** An `auto` add of a profile the owner removed — left removed. */
+ | {
+    subscriptionId: string;
+    address: string;
+    status: "detached";
 };
 /**
  * Result of {@link RelayerClient.submitAppleTransaction} /
@@ -703,6 +732,33 @@ declare class WalletKitClient {
     listSubscriptions(): Promise<{
         subscriptions: SubscriptionSummary[];
     }>;
+    /** The profiles one of the caller's subscriptions pays for. */
+    listSubscriptionProfiles(subscriptionId: string): Promise<{
+        profiles: SubscriptionMember[];
+    }>;
+    /**
+     * Have one of the caller's subscriptions pay for a profile — typically one
+     * held by the person's other account (a second email, or email + the mobile
+     * app). One shared pool: the subscription pays once the holder's own
+     * allowance is spent. No `proof` is needed for a profile the caller's
+     * account holds; otherwise pass a SIWE proof (the `POST /v1/profiles/attach` body: a SIWE message whose Address is the profile) signed
+     * by a key holding ADDCONTROLLER + EDITPERMISSIONS + SIGN +
+     * EXECUTE_RELAY_CALL on the profile (`403 insufficient_permissions` names
+     * what's missing). Set `auto` from a background sync: it never re-adds a
+     * profile the owner removed. `404 subscription_not_found` = not the
+     * caller's subscription.
+     */
+    addSubscriptionProfile(subscriptionId: string, input: {
+        address: string;
+        auto?: boolean;
+        proof?: {
+            message: string;
+            signature: string;
+            chainId?: number;
+        };
+    }): Promise<AddSubscriptionProfileResult>;
+    /** Stop paying for a profile. A later `auto` add leaves it removed. */
+    removeSubscriptionProfile(subscriptionId: string, address: string): Promise<void>;
     /**
      * Hand a StoreKit 2 purchase to the relayer (DEV-16570): pass the
      * transaction's `jwsRepresentation` after a purchase and for every
@@ -776,4 +832,4 @@ declare class IdentityError extends Error {
     constructor(code: IdentityErrorCode, message: string);
 }
 
-export { type BillingStore, type Catalog, type CatalogDefaultPrice, type CatalogPlan, type CatalogProduct, type ChainStatus, type CheckoutSession, type ControlProof, type ControllerSummary, type CoveredBy, type DeployProfileInput, type DeployProfileMultiChainResponse, type DeployProfileResponse, type DeployProfileSingleChainResponse, type DeployQueueStatus, type ExportCompleteResponse, type ExportRequestInput, type ExportRequestResponse, type ExportedKey, type ExtendVerdict, type ExtendVerdictReason, type FreeDefaultSnapshot, type Hex, IdentityError, type IdentityErrorCode, type IdentityProvider, type ImportBeginResponse, type ImportCompleteInput, type ImportCompleteResponse, type IpfsUploadTokenResponse, KeyCustodyError, type KeyCustodyErrorCode, type KeyCustodyOpContext, type KeyCustodyProvider, type Me, type NonceResponse, type OpContext, type OpenCheckoutInput, type Profile, type ProfileStatus, type ProfileWithChains, type QuotaSnapshot, type RelaySponsoredInput, type RelaySponsoredResponse, type SignLsp25Input, type SignLsp25Response, type SignMessageResponse, type SignTransactionInput, type SignTransactionResponse, type SignTxRequest, type StoreTransactionResult, type Subject, type SubscriptionResponse, type SubscriptionSnapshot, type SubscriptionSummary, TIER_ERROR_CODES, TierError, type VerifiedToken, type VerifyOptions, type Wallet, type WalletInfo, WalletKitClient, type WalletKitClientConfig, WalletKitError, createWalletKitClient };
+export { type AddSubscriptionProfileResult, type BillingStore, type Catalog, type CatalogDefaultPrice, type CatalogPlan, type CatalogProduct, type ChainStatus, type CheckoutSession, type ControlProof, type ControllerSummary, type CoveredBy, type DeployProfileInput, type DeployProfileMultiChainResponse, type DeployProfileResponse, type DeployProfileSingleChainResponse, type DeployQueueStatus, type ExportCompleteResponse, type ExportRequestInput, type ExportRequestResponse, type ExportedKey, type ExtendVerdict, type ExtendVerdictReason, type FreeDefaultSnapshot, type Hex, IdentityError, type IdentityErrorCode, type IdentityProvider, type ImportBeginResponse, type ImportCompleteInput, type ImportCompleteResponse, type IpfsUploadTokenResponse, KeyCustodyError, type KeyCustodyErrorCode, type KeyCustodyOpContext, type KeyCustodyProvider, type Me, type NonceResponse, type OpContext, type OpenCheckoutInput, type Profile, type ProfileStatus, type ProfileWithChains, type QuotaSnapshot, type RelaySponsoredInput, type RelaySponsoredResponse, type SignLsp25Input, type SignLsp25Response, type SignMessageResponse, type SignTransactionInput, type SignTransactionResponse, type SignTxRequest, type StoreTransactionResult, type Subject, type SubscriptionMember, type SubscriptionResponse, type SubscriptionSnapshot, type SubscriptionSummary, TIER_ERROR_CODES, TierError, type VerifiedToken, type VerifyOptions, type Wallet, type WalletInfo, WalletKitClient, type WalletKitClientConfig, WalletKitError, createWalletKitClient };

package/dist/index.js

@@ -191,6 +191,39 @@ var WalletKitClient = class {
   async listSubscriptions() {
     return this.#request("GET", "/v1/subscriptions");
   }
+  /** The profiles one of the caller's subscriptions pays for. */
+  async listSubscriptionProfiles(subscriptionId) {
+    return this.#request(
+      "GET",
+      `/v1/subscriptions/${encodeURIComponent(subscriptionId)}/profiles`
+    );
+  }
+  /**
+   * Have one of the caller's subscriptions pay for a profile — typically one
+   * held by the person's other account (a second email, or email + the mobile
+   * app). One shared pool: the subscription pays once the holder's own
+   * allowance is spent. No `proof` is needed for a profile the caller's
+   * account holds; otherwise pass a SIWE proof (the `POST /v1/profiles/attach` body: a SIWE message whose Address is the profile) signed
+   * by a key holding ADDCONTROLLER + EDITPERMISSIONS + SIGN +
+   * EXECUTE_RELAY_CALL on the profile (`403 insufficient_permissions` names
+   * what's missing). Set `auto` from a background sync: it never re-adds a
+   * profile the owner removed. `404 subscription_not_found` = not the
+   * caller's subscription.
+   */
+  async addSubscriptionProfile(subscriptionId, input) {
+    return this.#request(
+      "POST",
+      `/v1/subscriptions/${encodeURIComponent(subscriptionId)}/profiles`,
+      input
+    );
+  }
+  /** Stop paying for a profile. A later `auto` add leaves it removed. */
+  async removeSubscriptionProfile(subscriptionId, address) {
+    await this.#request(
+      "DELETE",
+      `/v1/subscriptions/${encodeURIComponent(subscriptionId)}/profiles/${encodeURIComponent(address)}`
+    );
+  }
   /**
    * Hand a StoreKit 2 purchase to the relayer (DEV-16570): pass the
    * transaction's `jwsRepresentation` after a purchase and for every

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@universal-everything/sdk-core",
-  "version": "1.2.0",
+  "version": "1.3.0-dev.483b732",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/universal-everything/universal-relayer.git",