@vtex/api 6.47.0-beta.1 → 6.48.0

package/CHANGELOG.md

@@ -7,7 +7,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
-## Fixed
+## [6.48.0] - 2024-10-23
+### Added
+- resolveAll to `MineWinsConflictsResolver` to handle an array of conflicts.
+
+### Fixed
+- Avoid using async/await with then callbacks
+- Bump semver from 5.7.1 to 5.7.2
+
+### Changed
+- @auth: Validate token's `account` scope
+- Delete Metadata client
+
+## [6.47.0] - 2024-06-11
+### Added
+- Add option to save asynchronous cache
+
+### Fixed
 - Add handler name for runtime http handlers
 
 ## [6.46.1] - 2024-01-31

package/lib/HttpClient/HttpClient.js

@@ -101,7 +101,7 @@ class HttpClient {
             ...config,
             url,
         });
-        const { baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, asyncSetCache = true, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
+        const { baseURL, authToken, authType, memoryCache, diskCache, memoizable = true, asyncSetCache, locale, name, metrics, product, serverTiming, recorder, userAgent, timeout = DEFAULT_TIMEOUT_MS, segmentToken, sessionToken, retries, concurrency, headers: defaultHeaders, host, params, operationId, tenant, binding, verbose, cancellation, exponentialTimeoutCoefficient, initialBackoffDelay, exponentialBackoffCoefficient, httpsAgent, tracer, logger, cacheableType = cache_1.CacheType.Memory, } = opts;
         this.name = name || baseURL || 'unknown';
         this.logger = logger;
         this.cacheableType = cacheableType;

package/lib/clients/IOClients.d.ts

@@ -3,7 +3,7 @@ import { IOContext } from '../service/worker/runtime/typings';
 import { Billing, Builder, MessagesGraphQL, Settings } from './apps';
 import { CatalogGraphQL } from './apps/catalogGraphQL/index';
 import { ID, MasterData, PaymentProvider } from './external';
-import { Apps, Assets, BillingMetrics, Events, Metadata, Registry, Router, VBase, Workspaces } from './infra';
+import { Apps, Assets, BillingMetrics, Events, Registry, Router, VBase, Workspaces } from './infra';
 import { IOClientConstructor } from './IOClient';
 import { LicenseManager, Segment, Session, TenantClient } from './janus';
 export declare type ClientsImplementation<T extends IOClients> = new (clientOptions: Record<string, InstanceOptions>, ctx: IOContext) => T;
@@ -22,7 +22,6 @@ export declare class IOClients {
     get licenseManager(): LicenseManager;
     get masterdata(): MasterData;
     get messagesGraphQL(): MessagesGraphQL;
-    get metadata(): Metadata;
     get registry(): Registry;
     get router(): Router;
     get segment(): Segment;

package/lib/clients/IOClients.js

@@ -41,9 +41,6 @@ class IOClients {
     get messagesGraphQL() {
         return this.getOrSet('messagesGraphQL', apps_1.MessagesGraphQL);
     }
-    get metadata() {
-        return this.getOrSet('metadata', infra_1.Metadata);
-    }
     get registry() {
         return this.getOrSet('registry', infra_1.Registry);
     }

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

@@ -4,7 +4,6 @@ export * from './BillingMetrics';
 export * from './Events';
 export * from './Housekeeper';
 export * from './InfraClient';
-export * from './Metadata';
 export * from './Registry';
 export * from './Router';
 export * from './VBase';

package/lib/clients/infra/index.js

@@ -9,7 +9,6 @@ __export(require("./BillingMetrics"));
 __export(require("./Events"));
 __export(require("./Housekeeper"));
 __export(require("./InfraClient"));
-__export(require("./Metadata"));
 __export(require("./Registry"));
 __export(require("./Router"));
 __export(require("./VBase"));

package/lib/service/worker/runtime/graphql/schema/schemaDirectives/Auth.js

@@ -7,7 +7,7 @@ const apollo_server_errors_1 = require("apollo-server-errors");
 const axios_1 = __importDefault(require("axios"));
 const graphql_1 = require("graphql");
 const graphql_tools_1 = require("graphql-tools");
-async function getUserEmail(authToken, vtexIdToken) {
+async function parseIdToken(authToken, vtexIdToken) {
     const url = `vtexid.vtex.com.br/api/vtexid/pub/authenticated/user?authToken=${vtexIdToken}`;
     const req = await axios_1.default.request({
         headers: {
@@ -21,7 +21,7 @@ async function getUserEmail(authToken, vtexIdToken) {
     if (!req.data) {
         return undefined;
     }
-    return req.data.user;
+    return { ...req.data };
 }
 async function getUserCanAccessResource(authToken, account, userEmail, productCode, resourceCode) {
     const url = `http://${account}.vtexcommercestable.com.br/api/license-manager/pvt/accounts/${account}/products/${productCode}/logins/${userEmail}/resources/${resourceCode}/granted`;
@@ -37,13 +37,13 @@ async function getUserCanAccessResource(authToken, account, userEmail, productCo
 async function auth(ctx, authArgs) {
     const vtexIdToken = ctx.cookies.get('VtexIdclientAutCookie') || ctx.get('VtexIdclientAutCookie');
     if (!vtexIdToken) {
-        throw new apollo_server_errors_1.ForbiddenError('VtexIdclientAutCookie not found.');
+        throw new apollo_server_errors_1.AuthenticationError('VtexIdclientAutCookie not found.');
     }
-    const userEmail = await getUserEmail(ctx.vtex.authToken, vtexIdToken);
-    if (!userEmail) {
-        throw new apollo_server_errors_1.ForbiddenError('Could not find user specified by VtexIdclientAutCookie.');
+    const parsedToken = await parseIdToken(ctx.vtex.authToken, vtexIdToken);
+    if (!parsedToken || parsedToken.account != ctx.vtex.account) {
+        throw new apollo_server_errors_1.AuthenticationError('Could not find user specified by VtexIdclientAutCookie.');
     }
-    const userCanAccessResource = await getUserCanAccessResource(ctx.vtex.authToken, ctx.vtex.account, userEmail, authArgs.productCode, authArgs.resourceCode);
+    const userCanAccessResource = await getUserCanAccessResource(ctx.vtex.authToken, ctx.vtex.account, parsedToken.user, authArgs.productCode, authArgs.resourceCode);
     if (!userCanAccessResource) {
         throw new apollo_server_errors_1.ForbiddenError('User indicated by VtexIdclientAutCookie is not authorized to access the indicated resource.');
     }

package/lib/utils/MineWinsConflictsResolver.d.ts

@@ -13,6 +13,7 @@ export declare class MineWinsConflictsResolver<T> implements ConflictsResolver<T
     private comparableKeys;
     constructor(client: VBase, bucket: string, filePath: string, comparableKeys?: string[]);
     resolve(logger?: Logger): Promise<any>;
+    resolveAll(): Promise<(Record<string, object | Record<string, object> | Record<string, object>[]> | Record<string, object>[])[]>;
     protected mergeMineWins(base: Configuration, master: Configuration, mine: Configuration): Record<string, object | Record<string, object> | Record<string, object>[]> | Record<string, object>[];
     private parseConflict;
     private serializeContentByMimetype;

package/lib/utils/MineWinsConflictsResolver.js

@@ -27,6 +27,17 @@ class MineWinsConflictsResolver {
             return resolved;
         });
     }
+    async resolveAll() {
+        const conflictsResponse = await this.client.getConflicts(this.bucket);
+        const { data: conflicts } = conflictsResponse;
+        const resolvedConflicts = conflicts.map((conflict) => {
+            conflict.base.parsedContent = this.parseConflict(conflict.base);
+            conflict.master.parsedContent = this.parseConflict(conflict.master);
+            conflict.mine.parsedContent = this.parseConflict(conflict.mine);
+            return this.resolveConflictMineWins(conflict);
+        });
+        return resolvedConflicts;
+    }
     mergeMineWins(base, master, mine) {
         if (util_1.isArray(master)) {
             return this.mergeMineWinsArray((base || []), master, (mine || []));

package/package.json

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

package/lib/clients/infra/Metadata.d.ts

@@ -1,26 +0,0 @@
-import { InstanceOptions, RequestTracingConfig } from '../../HttpClient';
-import { BucketMetadata } from '../../responses';
-import { IOContext } from '../../service/worker/runtime/typings';
-import { InfraClient } from './InfraClient';
-export interface MetadataEntry {
-    Key: string;
-    Hash: string;
-    Value: any;
-}
-export interface MetadataEntryList {
-    Data: MetadataEntry[];
-    Next: string;
-}
-export declare class Metadata extends InfraClient {
-    constructor(context: IOContext, options?: InstanceOptions);
-    getBuckets: (bucket: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<BucketMetadata>;
-    list: (bucket: string, includeValue: boolean, limit?: number | undefined, nextMarker?: string | undefined, tracingConfig?: RequestTracingConfig | undefined) => Promise<MetadataEntryList>;
-    listAll: (bucket: string, includeValue: boolean, tracingConfig?: RequestTracingConfig | undefined) => Promise<MetadataEntryList>;
-    get: (bucket: string, key: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<any>;
-    save: (bucket: string, key: string, data: any, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    saveAll: (bucket: string, data: {
-        [key: string]: any;
-    }, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    delete: (bucket: string, key: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<import("../../HttpClient").IOResponse<void>>;
-    deleteAll: (bucket: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<import("../../HttpClient").IOResponse<void>>;
-}

package/lib/clients/infra/Metadata.js

@@ -1,83 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const InfraClient_1 = require("./InfraClient");
-const appId = process.env.VTEX_APP_ID;
-const [runningAppName] = appId ? appId.split('@') : [''];
-const routes = {
-    Bucket: (bucket) => `/buckets/${runningAppName}/${bucket}`,
-    Metadata: (bucket) => `${routes.Bucket(bucket)}/metadata`,
-    MetadataKey: (bucket, key) => `${routes.Metadata(bucket)}/${key}`,
-};
-class Metadata extends InfraClient_1.InfraClient {
-    constructor(context, options) {
-        super('router', context, options);
-        this.getBuckets = (bucket, tracingConfig) => {
-            const metric = 'meta-get-buckets';
-            return this.http.get(routes.Bucket(bucket), { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.list = (bucket, includeValue, limit, nextMarker, tracingConfig) => {
-            const query = { value: includeValue, _limit: 10 };
-            if (limit && limit > 0) {
-                query._limit = limit;
-            }
-            if (nextMarker) {
-                query._marker = nextMarker;
-            }
-            const metric = 'meta-list';
-            return this.http.get(routes.Metadata(bucket), { metric, params: query, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.listAll = (bucket, includeValue, tracingConfig) => {
-            const query = { value: includeValue, _limit: 1000 };
-            const metric = 'meta-list-all';
-            return this.http.get(routes.Metadata(bucket), { metric, params: query, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.get = (bucket, key, tracingConfig) => {
-            const metric = 'meta-get';
-            return this.http.get(routes.MetadataKey(bucket, key), { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.save = (bucket, key, data, tracingConfig) => {
-            const metric = 'meta-save';
-            return this.http.put(routes.MetadataKey(bucket, key), data, { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.saveAll = (bucket, data, tracingConfig) => {
-            const metric = 'meta-save-all';
-            return this.http.put(routes.Metadata(bucket), data, { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.delete = (bucket, key, tracingConfig) => {
-            const metric = 'meta-delete';
-            return this.http.delete(routes.MetadataKey(bucket, key), { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        this.deleteAll = (bucket, tracingConfig) => {
-            const metric = 'meta-delete-all';
-            return this.http.delete(routes.Metadata(bucket), { metric, tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                } });
-        };
-        if (runningAppName === '') {
-            throw new Error(`Invalid path to access Metadata. Variable VTEX_APP_ID is not available.`);
-        }
-    }
-}
-exports.Metadata = Metadata;