@vtex/api 6.48.1-beta → 6.48.1-beta.2

package/lib/clients/apps/MessagesGraphQL.d.ts

@@ -0,0 +1,61 @@
+import { InstanceOptions, RequestTracingConfig } from '../../HttpClient';
+import { IOContext } from '../../service/worker/runtime/typings';
+import { AppGraphQLClient } from './AppGraphQLClient';
+export interface IndexedByFrom {
+    messages: Array<Omit<Message, 'from'>>;
+    from: string;
+}
+export type Behavior = 'FULL' | 'USER_ONLY' | 'USER_AND_APP';
+export interface Message {
+    content: string;
+    context?: string;
+    behavior?: Behavior;
+    from: string;
+}
+export interface MessageSaveInput {
+    srcLang: string;
+    srcMessage: string;
+    context?: string;
+    targetMessage: string;
+    groupContext?: string;
+}
+export interface TranslateInput {
+    indexedByFrom: IndexedByFrom[];
+    to: string;
+    depTree?: string;
+    encoding?: 'ICU' | 'HANDLEBARS';
+}
+export interface TranslateWithDependenciesInput {
+    indexedByFrom: IndexedByFrom[];
+    to: string;
+    depTree: string;
+    encoding?: 'ICU' | 'HANDLEBARS';
+}
+export interface SaveInput {
+    fireEvent?: boolean;
+    to: string;
+    messages: MessageSaveInput[];
+}
+export interface MessageInputV2 {
+    content: string;
+    context?: string;
+    behavior?: Behavior;
+}
+export interface MessageListV2 {
+    srcLang: string;
+    groupContext?: string;
+    context?: string;
+    translations: Translation[];
+}
+export interface Translation {
+    lang: string;
+    translation: string;
+}
+export declare class MessagesGraphQL extends AppGraphQLClient {
+    constructor(vtex: IOContext, options?: InstanceOptions);
+    translateV2(args: TranslateInput, tracingConfig?: RequestTracingConfig): Promise<string[]>;
+    translate(args: TranslateInput, tracingConfig?: RequestTracingConfig): Promise<string[]>;
+    translateWithDependencies(args: TranslateWithDependenciesInput, tracingConfig?: RequestTracingConfig): Promise<string[]>;
+    saveV2(args: SaveInput, tracingConfig?: RequestTracingConfig): Promise<boolean>;
+    userTranslations(args: IndexedByFrom, tracingConfig?: RequestTracingConfig): Promise<MessageListV2[]>;
+}

package/lib/clients/apps/MessagesGraphQL.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MessagesGraphQL = void 0;
+const ramda_1 = require("ramda");
+const AppGraphQLClient_1 = require("./AppGraphQLClient");
+const MAX_BATCH_SIZE = 500;
+class MessagesGraphQL extends AppGraphQLClient_1.AppGraphQLClient {
+    constructor(vtex, options) {
+        super('vtex.messages@1.x', vtex, options);
+    }
+    translateV2(args, tracingConfig) {
+        const { indexedByFrom, ...rest } = args;
+        const allMessages = indexedByFrom.reduce((acc, { from, messages }) => {
+            return acc.concat(messages.map(message => ({ from, message })));
+        }, []);
+        const batchedMessages = (0, ramda_1.splitEvery)(MAX_BATCH_SIZE, allMessages);
+        const metric = 'messages-translate-v2';
+        return Promise.all(batchedMessages.map(batch => {
+            const indexedBatch = batch.reduce((acc, { from, message }) => {
+                if (!acc[from]) {
+                    acc[from] = {
+                        from,
+                        messages: [],
+                    };
+                }
+                acc[from].messages.push(message);
+                return acc;
+            }, {});
+            const batchArgs = {
+                ...rest,
+                indexedByFrom: (0, ramda_1.values)(indexedBatch),
+            };
+            return this.graphql.query({
+                query: `
+      query Translate($args: TranslateArgs!) {
+        translate(args: $args)
+      }
+      `,
+                variables: { args: batchArgs },
+            }, {
+                metric,
+                tracing: {
+                    requestSpanNameSuffix: metric,
+                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+                },
+            }).then((0, ramda_1.path)(['data', 'translate']));
+        })).then(ramda_1.flatten);
+    }
+    async translate(args, tracingConfig) {
+        const metric = 'messages-translate-v2';
+        const response = await this.graphql.query({
+            query: `query Translate($args: TranslateArgs!) {
+          translate(args: $args)
+        }`,
+            variables: { args },
+        }, {
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+        return response.data.translate;
+    }
+    async translateWithDependencies(args, tracingConfig) {
+        const metric = 'messages-translate-with-deps-v2';
+        const response = await this.graphql.query({
+            query: `query TranslateWithDeps($args: TranslateWithDependenciesArgs!) {
+          translateWithDependencies(args: $args)
+        }`,
+            variables: { args },
+        }, {
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+        return response.data.translateWithDependencies;
+    }
+    async saveV2(args, tracingConfig) {
+        const metric = 'messages-saveV2-translation';
+        const response = await this.graphql.mutate({
+            mutate: `mutation SaveV2($args: SaveArgsV2!) {
+          saveV2(args: $args)
+        }`,
+            variables: { args },
+        }, {
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+        return response.data.saveV2;
+    }
+    async userTranslations(args, tracingConfig) {
+        const metric = 'messages-user-translations';
+        const response = await this.graphql.query({
+            query: `query UserTranslations($args: IndexedMessages!){
+          userTranslations(args: $args) {
+            srcLang
+            groupContext
+            context
+            translations {
+              lang
+              translation
+            }
+          }
+        }`,
+            variables: { args },
+        }, {
+            metric,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+        return response.data.userTranslations;
+    }
+}
+exports.MessagesGraphQL = MessagesGraphQL;

package/lib/clients/{Settings.d.ts → apps/Settings.d.ts}

@@ -1,6 +1,7 @@
-import { AppClient, InstanceOptions } from '../HttpClient';
-import { IOContext } from '../service/typings';
-import { AppMetaInfo } from './Apps';
+import { InstanceOptions, RequestTracingConfig } from '../../HttpClient';
+import { IOContext } from '../../service/worker/runtime/typings';
+import { AppMetaInfo } from '../infra/Apps';
+import { AppClient } from './AppClient';
 export interface SettingsParams {
     merge?: boolean;
     files?: string[];
@@ -9,5 +10,5 @@ export declare class Settings extends AppClient {
     constructor(context: IOContext, options?: InstanceOptions);
     getFilteredDependencies(appAtMajor: string, dependencies: AppMetaInfo[]): AppMetaInfo[];
     getDependenciesHash(dependencies: AppMetaInfo[]): string;
-    getSettings(dependencies: AppMetaInfo[], appAtMajor: string, params?: SettingsParams): Promise<any>;
+    getSettings(dependencies: AppMetaInfo[], appAtMajor: string, params?: SettingsParams, tracingConfig?: RequestTracingConfig): Promise<any>;
 }

package/lib/clients/apps/Settings.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Settings = void 0;
+const ramda_1 = require("ramda");
+const HttpClient_1 = require("../../HttpClient");
+const settings_1 = require("../../service/worker/runtime/http/middlewares/settings");
+const app_1 = require("../../utils/app");
+const AppClient_1 = require("./AppClient");
+const LINKED_ROUTE = 'linked';
+const containsLinks = (0, ramda_1.any)(app_1.isLinkedApp);
+class Settings extends AppClient_1.AppClient {
+    constructor(context, options) {
+        super('vtex.settings-server@0.x', context, options);
+    }
+    getFilteredDependencies(appAtMajor, dependencies) {
+        return (0, settings_1.getFilteredDependencies)(appAtMajor, dependencies);
+    }
+    getDependenciesHash(dependencies) {
+        return (0, settings_1.getDependenciesHash)(dependencies);
+    }
+    async getSettings(dependencies, appAtMajor, params, tracingConfig) {
+        const filtered = this.getFilteredDependencies(appAtMajor, dependencies);
+        // Settings server exposes a smartCache-enabled route for when the workspace contains links.
+        const lastSegment = containsLinks(filtered)
+            ? LINKED_ROUTE
+            : this.getDependenciesHash(filtered);
+        const metric = 'settings-get';
+        return this.http.get(`/settings/${appAtMajor}/${lastSegment}`, {
+            inflightKey: HttpClient_1.inflightUrlWithQuery,
+            metric,
+            params,
+            tracing: {
+                requestSpanNameSuffix: metric,
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        });
+    }
+}
+exports.Settings = Settings;

package/lib/clients/apps/catalogGraphQL/brand.d.ts

@@ -0,0 +1,13 @@
+export declare const query = "\nquery GetBrand($id: ID!) {\n  brand (id: $id) {\n    id\n    name\n    text\n    keywords\n    siteTitle\n    active\n    menuHome\n    adWordsRemarketingCode\n    lomadeeCampaignCode\n    score\n  }\n}\n";
+export interface Brand {
+    id: string;
+    name: string;
+    text?: string;
+    keywords?: string[];
+    siteTitle?: string;
+    active: boolean;
+    menuHome: boolean;
+    adWordsRemarketingCode?: string;
+    lomadeeCampaignCode?: string;
+    score?: number;
+}

package/lib/clients/apps/catalogGraphQL/brand.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.query = void 0;
+exports.query = `
+query GetBrand($id: ID!) {
+  brand (id: $id) {
+    id
+    name
+    text
+    keywords
+    siteTitle
+    active
+    menuHome
+    adWordsRemarketingCode
+    lomadeeCampaignCode
+    score
+  }
+}
+`;

package/lib/clients/apps/catalogGraphQL/category.d.ts

@@ -0,0 +1,11 @@
+export declare const query = "\nquery GetCategory($id: ID!) {\n  category (id: $id) {\n    id\n    name\n    title\n    parentCategoryId\n    description\n    isActive\n    globalCategoryId\n    score\n  }\n}\n";
+export interface Category {
+    id: string;
+    name: string;
+    title?: string;
+    parentCategoryId?: string;
+    description?: string;
+    isActive: boolean;
+    globalCategoryId: number;
+    score?: number;
+}

package/lib/clients/apps/catalogGraphQL/category.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.query = void 0;
+exports.query = `
+query GetCategory($id: ID!) {
+  category (id: $id) {
+    id
+    name
+    title
+    parentCategoryId
+    description
+    isActive
+    globalCategoryId
+    score
+  }
+}
+`;

package/lib/clients/apps/catalogGraphQL/index.d.ts

@@ -0,0 +1,22 @@
+import { AppGraphQLClient } from '..';
+import { InstanceOptions, IOContext } from '../../..';
+import { RequestTracingConfig } from '../../../HttpClient';
+import { Brand } from './brand';
+import { Category } from './category';
+import { Product } from './product';
+import { SKU } from './sku';
+export declare class CatalogGraphQL extends AppGraphQLClient {
+    constructor(ctx: IOContext, opts?: InstanceOptions);
+    sku: (id: string, tracingConfig?: RequestTracingConfig) => Promise<{
+        sku: SKU;
+    } | undefined>;
+    product: (id: string, tracingConfig?: RequestTracingConfig) => Promise<{
+        product: Product;
+    } | undefined>;
+    category: (id: string, tracingConfig?: RequestTracingConfig) => Promise<{
+        category: Category;
+    } | undefined>;
+    brand: (id: string, tracingConfig?: RequestTracingConfig) => Promise<{
+        brand: Brand;
+    } | undefined>;
+}

package/lib/clients/apps/catalogGraphQL/index.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CatalogGraphQL = void 0;
+const ramda_1 = require("ramda");
+const __1 = require("..");
+const brand_1 = require("./brand");
+const category_1 = require("./category");
+const product_1 = require("./product");
+const sku_1 = require("./sku");
+class CatalogGraphQL extends __1.AppGraphQLClient {
+    constructor(ctx, opts) {
+        super('vtex.catalog-graphql@1.x', ctx, {
+            ...opts,
+            headers: {
+                ...opts && opts.headers,
+                cookie: `VtexIdclientAutCookie=${ctx.authToken}`,
+            }
+        });
+        this.sku = (id, tracingConfig) => {
+            const variables = {
+                identifier: {
+                    field: 'id',
+                    value: id,
+                },
+            };
+            return this.graphql
+                .query({
+                inflight: true,
+                query: sku_1.query,
+                variables,
+            }, {
+                forceMaxAge: 5,
+                tracing: {
+                    requestSpanNameSuffix: 'catalog-sku',
+                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+                },
+            })
+                .then((0, ramda_1.prop)('data'));
+        };
+        this.product = (id, tracingConfig) => {
+            const variables = {
+                identifier: {
+                    field: 'id',
+                    value: id,
+                },
+            };
+            return this.graphql
+                .query({
+                inflight: true,
+                query: product_1.query,
+                variables,
+            }, {
+                forceMaxAge: 5,
+                tracing: {
+                    requestSpanNameSuffix: 'catalog-product',
+                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+                },
+            })
+                .then((0, ramda_1.prop)('data'));
+        };
+        this.category = (id, tracingConfig) => this.graphql
+            .query({
+            inflight: true,
+            query: category_1.query,
+            variables: { id },
+        }, {
+            forceMaxAge: 5,
+            tracing: {
+                requestSpanNameSuffix: 'catalog-category',
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        })
+            .then((0, ramda_1.prop)('data'));
+        this.brand = (id, tracingConfig) => this.graphql
+            .query({
+            inflight: true,
+            query: brand_1.query,
+            variables: { id },
+        }, {
+            forceMaxAge: 5,
+            tracing: {
+                requestSpanNameSuffix: 'catalog-brand',
+                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
+            },
+        })
+            .then((0, ramda_1.prop)('data'));
+    }
+}
+exports.CatalogGraphQL = CatalogGraphQL;

package/lib/clients/apps/catalogGraphQL/product.d.ts

@@ -0,0 +1,25 @@
+export declare const query = "\nquery GetProduct ($identifier: ProductUniqueIdentifier!) {\n  product (identifier: $identifier) {\n    id\n    brandId\n    categoryId\n    departmentId\n    name\n    linkId\n    refId\n    isVisible\n    description\n    shortDescription\n    releaseDate\n    keywords\n    title\n    isActive\n    taxCode\n    metaTagDescription\n    supplierId\n    showWithoutStock\n    score\n    salesChannel {\n      id\n    }\n  }\n}\n";
+export interface Product {
+    id: string;
+    brandId: string;
+    categoryId: string;
+    departmentId: string;
+    name: string;
+    linkId: string;
+    refId?: string;
+    isVisible: boolean;
+    description?: string;
+    shortDescription?: string;
+    releaseDate?: string;
+    keywords: string[];
+    title?: string;
+    isActive: boolean;
+    taxCode?: string;
+    metaTagDescription?: string;
+    supplierId?: string;
+    showWithoutStock: boolean;
+    score?: number;
+    salesChannel?: Array<{
+        id: string;
+    }>;
+}

package/lib/clients/apps/catalogGraphQL/product.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.query = void 0;
+exports.query = `
+query GetProduct ($identifier: ProductUniqueIdentifier!) {
+  product (identifier: $identifier) {
+    id
+    brandId
+    categoryId
+    departmentId
+    name
+    linkId
+    refId
+    isVisible
+    description
+    shortDescription
+    releaseDate
+    keywords
+    title
+    isActive
+    taxCode
+    metaTagDescription
+    supplierId
+    showWithoutStock
+    score
+    salesChannel {
+      id
+    }
+  }
+}
+`;

package/lib/clients/apps/catalogGraphQL/sku.d.ts

@@ -0,0 +1,26 @@
+export declare const query = "\nquery GetSKU ($identifier: SKUUniqueIdentifier!) {\n  sku (identifier: $identifier) {\n    id\n    productId\n    isActive\n    name\n    height\n    length\n    width\n    weightKg\n    packagedHeight\n    packagedWidth\n    packagedLength\n    packagedWeightKg\n    cubicWeight\n    isKit\n    creationDate\n    rewardValue\n    manufacturerCode\n    commercialConditionId\n    measurementUnit\n    unitMultiplier\n    modalType\n    kitItensSellApart\n  }\n}\n";
+export interface SKU {
+    id: string;
+    productId: string;
+    isActive: boolean;
+    name: string;
+    height?: number;
+    length?: number;
+    width?: number;
+    weightKg?: number;
+    packagedHeight?: number;
+    packagedWidth?: number;
+    packagedLength?: number;
+    packagedWeightKg?: number;
+    cubicWeight: number;
+    isKit: boolean;
+    creationDate: string;
+    rewardValue?: number;
+    estimatedDateArrival?: string;
+    manufacturerCode: string;
+    commercialConditionId: string;
+    measurementUnit: string;
+    unitMultiplier: number;
+    modalType?: string;
+    kitItensSellApart: boolean;
+}

package/lib/clients/apps/catalogGraphQL/sku.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.query = void 0;
+exports.query = `
+query GetSKU ($identifier: SKUUniqueIdentifier!) {
+  sku (identifier: $identifier) {
+    id
+    productId
+    isActive
+    name
+    height
+    length
+    width
+    weightKg
+    packagedHeight
+    packagedWidth
+    packagedLength
+    packagedWeightKg
+    cubicWeight
+    isKit
+    creationDate
+    rewardValue
+    manufacturerCode
+    commercialConditionId
+    measurementUnit
+    unitMultiplier
+    modalType
+    kitItensSellApart
+  }
+}
+`;

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

@@ -0,0 +1,7 @@
+export * from './AppClient';
+export * from './AppGraphQLClient';
+export * from './Billing';
+export * from './Builder';
+export * from './MessagesGraphQL';
+export * from './Settings';
+export * from './catalogGraphQL';

package/lib/clients/apps/index.js

@@ -0,0 +1,23 @@
+"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 });
+__exportStar(require("./AppClient"), exports);
+__exportStar(require("./AppGraphQLClient"), exports);
+__exportStar(require("./Billing"), exports);
+__exportStar(require("./Builder"), exports);
+__exportStar(require("./MessagesGraphQL"), exports);
+__exportStar(require("./Settings"), exports);
+__exportStar(require("./catalogGraphQL"), exports);

package/lib/{HttpClient → clients/external}/ExternalClient.d.ts

@@ -1,6 +1,6 @@
-import { IOContext } from '../service/typings';
-import { IOClient } from './IOClient';
-import { InstanceOptions } from './typings';
+import { InstanceOptions } from '../../HttpClient/typings';
+import { IOContext } from '../../service/worker/runtime/typings';
+import { IOClient } from '../IOClient';
 /**
  * Used to perform calls to external endpoints for which you have declared outbound access policies in your manifest.
  */

package/lib/{HttpClient → clients/external}/ExternalClient.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const IOClient_1 = require("./IOClient");
+exports.ExternalClient = void 0;
+const IOClient_1 = require("../IOClient");
 /**
  * Used to perform calls to external endpoints for which you have declared outbound access policies in your manifest.
  */
@@ -8,7 +9,14 @@ class ExternalClient extends IOClient_1.IOClient {
     constructor(baseURL, context, options) {
         const { authToken } = context;
         const headers = options && options.headers || {};
-        super(context, Object.assign({}, options, { baseURL, headers: Object.assign({}, headers, { 'Proxy-Authorization': authToken }) }));
+        super(context, {
+            ...options,
+            baseURL,
+            headers: {
+                ...headers,
+                'Proxy-Authorization': authToken,
+            },
+        });
     }
 }
 exports.ExternalClient = ExternalClient;

package/lib/clients/external/ID.d.ts

@@ -0,0 +1,23 @@
+import { InstanceOptions, RequestTracingConfig } from '../../HttpClient';
+import { IOContext } from '../../service/worker/runtime/typings';
+import { ExternalClient } from './ExternalClient';
+export declare class ID extends ExternalClient {
+    constructor(context: IOContext, opts?: InstanceOptions);
+    getTemporaryToken: (tracingConfig?: RequestTracingConfig) => Promise<string>;
+    sendCodeToEmail: (token: string, email: string, tracingConfig?: RequestTracingConfig) => Promise<any>;
+    getEmailCodeAuthenticationToken: (token: string, email: string, code: string, tracingConfig?: RequestTracingConfig) => Promise<AuthenticationResponse>;
+    getPasswordAuthenticationToken: (token: string, email: string, password: string, tracingConfig?: RequestTracingConfig) => Promise<AuthenticationResponse>;
+}
+export interface AuthenticationResponse {
+    promptMFA: boolean;
+    clientToken: any;
+    authCookie: {
+        Name: string;
+        Value: string;
+    };
+    accountAuthCookie: any;
+    expiresIn: number;
+    userId: string;
+    phoneNumber: string;
+    scope: any;
+}