swell-js 5.9.3 → 5.9.4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swell-js",
-  "version": "5.9.3",
+  "version": "5.9.4",
   "description": "Swell JS library for client-side stores",
   "engines": {
     "node": ">=16"

package/types/consent/camel.ts

@@ -0,0 +1,17 @@
+import type { ConvertSnakeToCamelCase } from '../index.js';
+import type { Replace } from '../utils.js';
+
+import type { Consent, ConsentEffective, ConsentInput } from './snake.js';
+
+export type ConsentInputCamel = ConvertSnakeToCamelCase<ConsentInput>;
+
+export type ConsentEffectiveCamel = ConvertSnakeToCamelCase<ConsentEffective>;
+
+export type ConsentCamel = ConvertSnakeToCamelCase<
+  Replace<
+    Consent,
+    {
+      effective: ConsentEffectiveCamel;
+    }
+  >
+>;

package/types/consent/index.ts

@@ -0,0 +1,21 @@
+import type { MakeCase } from '../utils.js';
+
+import type { Consent, ConsentEffective, ConsentInput } from './snake.js';
+import type {
+  ConsentCamel,
+  ConsentEffectiveCamel,
+  ConsentInputCamel,
+} from './camel.js';
+
+export type ConsentCase = MakeCase<Consent, ConsentCamel>;
+
+export type ConsentInputCase = MakeCase<ConsentInput, ConsentInputCamel>;
+
+export type {
+  Consent,
+  ConsentEffective,
+  ConsentInput,
+  ConsentCamel,
+  ConsentEffectiveCamel,
+  ConsentInputCamel,
+};

package/types/consent/snake.ts

@@ -0,0 +1,22 @@
+/** The shopper's answers; purposes left out stay as they are */
+export interface ConsentInput {
+  analytics?: boolean;
+  marketing?: boolean;
+  sale_of_data?: boolean;
+}
+
+/** What the answers allow, after the region's rule and GPC */
+export interface ConsentEffective {
+  analytics: boolean;
+  marketing: boolean;
+  sale_of_data: boolean;
+}
+
+export interface Consent {
+  analytics: boolean | null;
+  marketing: boolean | null;
+  sale_of_data: boolean | null;
+  gpc: boolean;
+  rule: 'opt_in' | 'opt_out' | null;
+  effective: ConsentEffective;
+}

package/types/index.d.cts

@@ -82,6 +82,14 @@ declare namespace swell {
   export type CategoryCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).CategoryCase;
   export type Category = import('./index.js', { with: { 'resolution-mode': 'import' } }).Category;
   export type CategoryCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).CategoryCamel;
+  export type ConsentCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentCase;
+  export type ConsentInputCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInputCase;
+  export type Consent = import('./index.js', { with: { 'resolution-mode': 'import' } }).Consent;
+  export type ConsentEffective = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentEffective;
+  export type ConsentInput = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInput;
+  export type ConsentCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentCamel;
+  export type ConsentEffectiveCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentEffectiveCamel;
+  export type ConsentInputCamel = import('./index.js', { with: { 'resolution-mode': 'import' } }).ConsentInputCamel;
   export type ContentCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentCase;
   export type ContentSectionCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentSectionCase;
   export type ContentPageCase = import('./index.js', { with: { 'resolution-mode': 'import' } }).ContentPageCase;

package/types/index.d.ts

@@ -17,6 +17,7 @@ import type {
 } from './card/index.js';
 import type { CartCase, CartItemCase } from './cart/index.js';
 import type { CategoryCase } from './category/index.js';
+import type { ConsentCase, ConsentInputCase } from './consent/index.js';
 import type { ContentCase } from './content/index.js';
 import type {
   SelectCurrencyReturnCase,
@@ -53,6 +54,7 @@ export type * from './billing/index.js';
 export type * from './card/index.js';
 export type * from './cart/index.js';
 export type * from './category/index.js';
+export type * from './consent/index.js';
 export type * from './content/index.js';
 export type * from './coupon/index.js';
 export type * from './currency/index.js';
@@ -499,6 +501,15 @@ export interface SwellClient<C extends 'snake' | 'camel' = 'snake'> {
     setCookie(value: string): void;
   };
 
+  consent: {
+    /**
+     * Records the shopper's consent for attribution. Call it from the
+     * storefront's consent banner; purposes left out stay as they are.
+     * Browser only: it calls the storefront's own origin.
+     */
+    set(consent?: ConsentInputCase[C]): Promise<ConsentCase[C]>;
+  };
+
   functions: {
     request<T>(
       method: string,