@vtex/api 6.50.2-beta.0 → 6.51.0

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [6.51.0] - 2026-06-23
+### Added
+- Base `IOClients` getter `janusCatalogSystem` (Janus Catalog) and
+  `licenseManager.listBindings`, plus binding-mapping helpers
+  (getCanonicalAndAlternateAddresses, inferTargetProduct) used by the
+  Tenant API migration. Backport of #617 to the 6.x line.
+
 ## [6.50.1] - 2025-09-10
 ### Fixed
 - Axios vuln GHSA-jr5f-v2jv-69x6 by using axios@^0.30.1

package/lib/clients/IOClients.d.ts

@@ -5,7 +5,7 @@ import { CatalogGraphQL } from './apps/catalogGraphQL/index';
 import { ID, MasterData, PaymentProvider } from './external';
 import { Apps, Assets, BillingMetrics, Events, Registry, Router, VBase, Workspaces } from './infra';
 import { IOClientConstructor } from './IOClient';
-import { LicenseManager, Segment, Session, TenantClient } from './janus';
+import { Catalog, LicenseManager, Segment, Session, TenantClient } from './janus';
 export type ClientsImplementation<T extends IOClients> = new (clientOptions: Record<string, InstanceOptions>, ctx: IOContext) => T;
 export declare class IOClients {
     private clientOptions;
@@ -31,6 +31,7 @@ export declare class IOClients {
     get vbase(): VBase;
     get workspaces(): Workspaces;
     get catalogGraphQL(): CatalogGraphQL;
+    get janusCatalogSystem(): Catalog;
     get paymentProvider(): PaymentProvider;
     protected getOrSet<TClient extends IOClientConstructor>(key: string, Implementation: TClient): InstanceType<TClient>;
 }

package/lib/clients/IOClients.js

@@ -69,6 +69,9 @@ class IOClients {
     get catalogGraphQL() {
         return this.getOrSet('catalogGraphQL', index_1.CatalogGraphQL);
     }
+    get janusCatalogSystem() {
+        return this.getOrSet('janusCatalogSystem', janus_1.Catalog);
+    }
     get paymentProvider() {
         return this.getOrSet('paymentProvider', external_1.PaymentProvider);
     }

package/lib/clients/janus/Catalog/index.d.ts

@@ -0,0 +1,7 @@
+import { RequestConfig } from '../../../HttpClient';
+import { JanusClient } from '../JanusClient';
+import { SalesChannel } from './types';
+export declare class Catalog extends JanusClient {
+    getSalesChannel(id: number, config?: RequestConfig): Promise<SalesChannel>;
+    getDefaultSalesChannel(config?: RequestConfig): Promise<SalesChannel>;
+}

package/lib/clients/janus/Catalog/index.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Catalog = void 0;
+const HttpClient_1 = require("../../../HttpClient");
+const JanusClient_1 = require("../JanusClient");
+const BASE_URL = '/api/catalog_system';
+const routes = {
+    defaultSalesChannel: () => `${BASE_URL}/pub/saleschannel/default`,
+    salesChannel: (salesChannelId) => `${BASE_URL}/pub/saleschannel/${salesChannelId}`,
+};
+class Catalog extends JanusClient_1.JanusClient {
+    getSalesChannel(id, config) {
+        const metric = 'catalog-saleschannel';
+        return this.http.get(routes.salesChannel(id), {
+            inflightKey: HttpClient_1.inflightUrlWithQuery,
+            metric,
+            ...config,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...config === null || config === void 0 ? void 0 : config.tracing,
+            },
+        });
+    }
+    getDefaultSalesChannel(config) {
+        const metric = 'catalog-saleschannel-default';
+        return this.http.get(routes.defaultSalesChannel(), {
+            inflightKey: HttpClient_1.inflightUrlWithQuery,
+            metric,
+            ...config,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...config === null || config === void 0 ? void 0 : config.tracing,
+            },
+        });
+    }
+}
+exports.Catalog = Catalog;

package/lib/clients/janus/Catalog/types.d.ts

@@ -0,0 +1,5 @@
+export interface SalesChannel {
+    Id: number;
+    CultureInfo: string;
+    CurrencyCode: string;
+}

package/lib/clients/janus/Catalog/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/clients/janus/{LicenseManager.d.ts → LicenseManager/index.d.ts}

@@ -1,7 +1,11 @@
-import { RequestTracingConfig } from '../../HttpClient';
-import { JanusClient } from './JanusClient';
+import { RequestConfig, RequestTracingConfig } from '../../../HttpClient';
+import { JanusClient } from '../JanusClient';
+import { APIBindingRes } from './types';
+export * from './types';
+export * from './utils';
 export declare class LicenseManager extends JanusClient {
     getAccountData(VtexIdclientAutCookie: string, tracingConfig?: RequestTracingConfig): Promise<any>;
     getTopbarData(VtexIdclientAutCookie: string, tracingConfig?: RequestTracingConfig): Promise<any>;
     canAccessResource(VtexIdclientAutCookie: string, resourceKey: string, tracingConfig?: RequestTracingConfig): Promise<boolean>;
+    listBindings(tenant: string, config?: RequestConfig): Promise<APIBindingRes[]>;
 }

package/lib/clients/janus/LicenseManager/index.js

@@ -0,0 +1,91 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LicenseManager = void 0;
+const HttpClient_1 = require("../../../HttpClient");
+const JanusClient_1 = require("../JanusClient");
+__exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);
+const TWO_MINUTES_S = 2 * 60;
+const BASE_URL = '/api/license-manager';
+const routes = {
+    accountData: () => `${BASE_URL}/account`,
+    listBindings: (tenant) => `${BASE_URL}/binding/site/${encodeURIComponent(tenant)}`,
+    resourceAccess: (resourceKey) => `${BASE_URL}/resources/${encodeURIComponent(resourceKey)}/access`,
+    topbarData: () => `${BASE_URL}/site/pvt/newtopbar`,
+};
+class LicenseManager extends JanusClient_1.JanusClient {
+    getAccountData(VtexIdclientAutCookie, tracingConfig) {
+        const metric = 'lm-account-data';
+        return this.http.get(routes.accountData(), {
+            forceMaxAge: TWO_MINUTES_S,
+            headers: {
+                VtexIdclientAutCookie,
+            },
+            inflightKey: HttpClient_1.inflightUrlWithQuery,
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+    }
+    getTopbarData(VtexIdclientAutCookie, tracingConfig) {
+        const metric = 'lm-topbar-data';
+        return this.http.get(routes.topbarData(), {
+            headers: {
+                VtexIdclientAutCookie,
+            },
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+    }
+    canAccessResource(VtexIdclientAutCookie, resourceKey, tracingConfig) {
+        const metric = 'lm-resource-access';
+        return this.http
+            .get(routes.resourceAccess(resourceKey), {
+            headers: {
+                VtexIdclientAutCookie,
+            },
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        })
+            .then(() => true, () => false);
+    }
+    listBindings(tenant, config) {
+        const metric = 'lm-list-bindings';
+        return this.http.get(routes.listBindings(tenant), {
+            headers: {
+                VtexIdclientAutCookie: this.context.authToken,
+            },
+            inflightKey: HttpClient_1.inflightUrlWithQuery,
+            memoizeable: true,
+            metric,
+            ...config,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...config === null || config === void 0 ? void 0 : config.tracing,
+            },
+        });
+    }
+}
+exports.LicenseManager = LicenseManager;

package/lib/clients/janus/LicenseManager/types.d.ts

@@ -0,0 +1,16 @@
+export interface APIAddress {
+    Host: string;
+    IsCanonical: boolean;
+    BasePath: string;
+    Localization: {
+        [k: string]: string;
+    };
+}
+export interface APIBindingRes {
+    Id: string;
+    Addresses: APIAddress[];
+    SiteName: string;
+    DefaultSalesChannelId: number | null;
+    DefaultLocale: string;
+    SupportedLocales: string[];
+}

package/lib/clients/janus/LicenseManager/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/clients/janus/LicenseManager/utils.d.ts

@@ -0,0 +1,6 @@
+import { APIBindingRes } from './types';
+export declare const getCanonicalAndAlternateAddresses: (lmBinding: APIBindingRes) => {
+    canonicalBaseAddress: string;
+    alternateBaseAddresses: string[];
+};
+export declare const inferTargetProduct: (canonicalBaseAddress: string, alternateBaseAddresses: string[]) => 'vtex-admin' | 'vtex-storefront';

package/lib/clients/janus/LicenseManager/utils.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.inferTargetProduct = exports.getCanonicalAndAlternateAddresses = void 0;
+const buildAddressPath = (basePath, localizationKey) => {
+    if (basePath === '') {
+        return `/${localizationKey}`;
+    }
+    if (localizationKey === '') {
+        return `/${basePath}`;
+    }
+    return `/${basePath}/${localizationKey}`;
+};
+const getCanonicalAndAlternateAddresses = (lmBinding) => {
+    let canonicalBaseAddress = '';
+    const alternateBaseAddresses = [];
+    for (const addressEntry of lmBinding.Addresses) {
+        const localizationKeys = Object.keys(addressEntry.Localization);
+        for (const localizationKey of localizationKeys) {
+            alternateBaseAddresses.push(addressEntry.Host + buildAddressPath(addressEntry.BasePath, localizationKey));
+        }
+        if (addressEntry.IsCanonical) {
+            // The canonical address is built from the shortest localization key.
+            const [shortestLocalizationKey = ''] = [...localizationKeys].sort((a, b) => a.length - b.length);
+            canonicalBaseAddress = addressEntry.Host + buildAddressPath(addressEntry.BasePath, shortestLocalizationKey);
+        }
+    }
+    // The canonical address must not also appear in the alternates list.
+    const canonicalIndexInAlternates = alternateBaseAddresses.indexOf(canonicalBaseAddress);
+    if (canonicalIndexInAlternates !== -1) {
+        alternateBaseAddresses.splice(canonicalIndexInAlternates, 1);
+    }
+    return { canonicalBaseAddress, alternateBaseAddresses };
+};
+exports.getCanonicalAndAlternateAddresses = getCanonicalAndAlternateAddresses;
+const inferTargetProduct = (canonicalBaseAddress, alternateBaseAddresses) => {
+    const isAdmin = canonicalBaseAddress.endsWith('myvtex.com/admin') ||
+        alternateBaseAddresses.some((address) => address.endsWith('myvtex.com/admin'));
+    return isAdmin ? 'vtex-admin' : 'vtex-storefront';
+};
+exports.inferTargetProduct = inferTargetProduct;

package/lib/clients/janus/index.d.ts

@@ -3,3 +3,4 @@ export * from './LicenseManager';
 export * from './Segment';
 export * from './Session';
 export * from './Tenant';
+export * from './Catalog';

package/lib/clients/janus/index.js

@@ -19,3 +19,4 @@ __exportStar(require("./LicenseManager"), exports);
 __exportStar(require("./Segment"), exports);
 __exportStar(require("./Session"), exports);
 __exportStar(require("./Tenant"), exports);
+__exportStar(require("./Catalog"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vtex/api",
-  "version": "6.50.2-beta.0",
+  "version": "6.51.0",
   "description": "VTEX I/O API client",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/lib/clients/janus/LicenseManager.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.LicenseManager = void 0;
-const qs_1 = require("qs");
-const JanusClient_1 = require("./JanusClient");
-const TWO_MINUTES_S = 2 * 60;
-const BASE_URL = '/api/license-manager';
-const routes = {
-    accountData: `${BASE_URL}/account`,
-    resourceAccess: `${BASE_URL}/resources`,
-    topbarData: `${BASE_URL}/site/pvt/newtopbar`,
-};
-const inflightKey = ({ baseURL, url, params }) => {
-    return baseURL + url + (0, qs_1.stringify)(params, { arrayFormat: 'repeat', addQueryPrefix: true });
-};
-class LicenseManager extends JanusClient_1.JanusClient {
-    getAccountData(VtexIdclientAutCookie, tracingConfig) {
-        const metric = 'lm-account-data';
-        return this.http.get(routes.accountData, {
-            forceMaxAge: TWO_MINUTES_S,
-            headers: {
-                VtexIdclientAutCookie,
-            },
-            inflightKey,
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    getTopbarData(VtexIdclientAutCookie, tracingConfig) {
-        const metric = 'lm-topbar-data';
-        return this.http.get(routes.topbarData, {
-            headers: {
-                VtexIdclientAutCookie,
-            },
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    canAccessResource(VtexIdclientAutCookie, resourceKey, tracingConfig) {
-        const metric = 'lm-resource-access';
-        return this.http.get(`${routes.resourceAccess}/${resourceKey}/access`, {
-            headers: {
-                VtexIdclientAutCookie,
-            },
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        }).then(() => true, () => false);
-    }
-}
-exports.LicenseManager = LicenseManager;