@vtex/api 6.47.0 → 6.48.1-beta

package/lib/clients/external/Masterdata.js

@@ -1,224 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const __1 = require("../..");
-const HttpClient_1 = require("../../HttpClient");
-const ExternalClient_1 = require("./ExternalClient");
-const routes = {
-    document: (dataEntity, id) => `${dataEntity}/documents/${id}`,
-    documents: (dataEntity) => `${dataEntity}/documents`,
-    publicSchema: (dataEntity, schema) => `${dataEntity}/schemas/${schema}/public`,
-    schema: (dataEntity, schema) => `${dataEntity}/schemas/${schema}`,
-    scroll: (dataEntity) => `${dataEntity}/scroll`,
-    search: (dataEntity) => `${dataEntity}/search`,
-};
-class MasterData extends ExternalClient_1.ExternalClient {
-    constructor(ctx, options) {
-        super(`http://api.vtex.com/api/dataentities`, ctx, {
-            ...options,
-            headers: {
-                Accept: 'application/json',
-                VtexIdclientAutCookie: ctx.authToken,
-                'x-vtex-api-appService': ctx.userAgent,
-                ...options === null || options === void 0 ? void 0 : options.headers,
-            },
-            params: {
-                an: ctx.account,
-                ...options === null || options === void 0 ? void 0 : options.params,
-            },
-        });
-    }
-    getSchema({ dataEntity, schema }, tracingConfig) {
-        const metric = 'masterdata-getSchema';
-        return this.http.get(routes.schema(dataEntity, schema), {
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    createOrUpdateSchema({ dataEntity, schemaName, schemaBody }, tracingConfig) {
-        const metric = 'masterdata-createOrUpdateSchema';
-        return this.http.put(routes.schema(dataEntity, schemaName), schemaBody, {
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    getPublicSchema({ dataEntity, schema }, tracingConfig) {
-        const metric = 'masterdata-getPublicSchema';
-        return this.http.get(routes.publicSchema(dataEntity, schema), {
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    getDocument({ dataEntity, id, fields }, tracingConfig) {
-        const metric = 'masterdata-getDocument';
-        return this.http.get(routes.document(dataEntity, id), {
-            metric,
-            params: {
-                _fields: generateFieldsArg(fields),
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    createDocument({ dataEntity, fields, schema }, tracingConfig) {
-        const metric = 'masterdata-createDocument';
-        return this.http.post(routes.documents(dataEntity), fields, {
-            metric,
-            params: {
-                _schema: schema,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    createOrUpdateEntireDocument({ dataEntity, fields, id, schema }, tracingConfig) {
-        const metric = 'masterdata-createOrUpdateEntireDocument';
-        return this.http.put(routes.documents(dataEntity), { id, ...fields }, {
-            metric,
-            params: {
-                _schema: schema,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    createOrUpdatePartialDocument({ dataEntity, fields, id, schema }, tracingConfig) {
-        const metric = 'masterdata-createOrUpdatePartialDocument';
-        return this.http.patch(routes.documents(dataEntity), { id, ...fields }, {
-            metric,
-            params: {
-                _schema: schema,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    updateEntireDocument({ dataEntity, id, fields, schema }, tracingConfig) {
-        const metric = 'masterdata-updateEntireDocument';
-        return this.http.put(routes.document(dataEntity, id), fields, {
-            metric,
-            params: {
-                _schema: schema,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    updatePartialDocument({ dataEntity, id, fields, schema }, tracingConfig) {
-        const metric = 'masterdata-updatePartialDocument';
-        return this.http.patch(routes.document(dataEntity, id), fields, {
-            metric,
-            params: {
-                _schema: schema,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    searchDocuments({ dataEntity, fields, where, pagination, schema, sort }, tracingConfig) {
-        const metric = 'masterdata-searchDocuments';
-        return this.http.get(routes.search(dataEntity), {
-            cacheable: HttpClient_1.CacheType.None,
-            headers: paginationArgsToHeaders(pagination),
-            metric,
-            params: {
-                _fields: generateFieldsArg(fields),
-                _schema: schema,
-                _sort: sort,
-                _where: where,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-    async searchDocumentsWithPaginationInfo({ dataEntity, fields, where, pagination, schema, sort }, tracingConfig) {
-        const metric = 'masterdata-searchDocumentsWithPagination';
-        const result = await this.http.getRaw(routes.search(dataEntity), {
-            cacheable: HttpClient_1.CacheType.None,
-            headers: paginationArgsToHeaders(pagination),
-            metric,
-            params: {
-                _fields: generateFieldsArg(fields),
-                _schema: schema,
-                _sort: sort,
-                _where: where,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-        const headers = result.headers;
-        const restContentRange = headers['rest-content-range'];
-        const total = Number(restContentRange.split('/')[1]);
-        const paginationInfo = { ...pagination, total };
-        return { data: result.data, pagination: paginationInfo };
-    }
-    scrollDocuments({ dataEntity, fields, where, mdToken, schema, size, sort }, tracingConfig) {
-        const metric = 'masterdata-scrollDocuments';
-        return this.http
-            .getRaw(routes.scroll(dataEntity), {
-            cacheable: HttpClient_1.CacheType.None,
-            metric,
-            params: {
-                _fields: generateFieldsArg(fields),
-                _schema: schema,
-                _size: size,
-                _sort: sort,
-                _token: mdToken,
-                _where: where,
-            },
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        })
-            .then(({ headers: { 'x-vtex-md-token': resToken }, data }) => ({ mdToken: resToken, data }));
-    }
-    deleteDocument({ dataEntity, id }, tracingConfig) {
-        const metric = 'masterdata-deleteDocument';
-        return this.http.delete(routes.document(dataEntity, id), {
-            metric,
-            tracing: {
-                requestSpanNameSuffix: metric,
-                ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-            },
-        });
-    }
-}
-exports.MasterData = MasterData;
-function paginationArgsToHeaders({ page, pageSize }) {
-    if (page < 1) {
-        throw new __1.UserInputError('Smallest page value is 1');
-    }
-    const startIndex = (page - 1) * pageSize;
-    const endIndex = startIndex + pageSize;
-    return {
-        'REST-Range': `resources=${startIndex}-${endIndex}`,
-    };
-}
-function generateFieldsArg(fields) {
-    return fields.join(',');
-}

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

@@ -1,31 +0,0 @@
-import { InstanceOptions, IOContext, Maybe } from '../..';
-import { RequestTracingConfig } from '../../HttpClient';
-import { ExternalClient } from './ExternalClient';
-export declare class PaymentProvider extends ExternalClient {
-    protected context: IOContext;
-    constructor(context: IOContext, options?: InstanceOptions);
-    callback: (transactionId: string, paymentId: string, callback: AuthorizationCallback, tracingConfig?: RequestTracingConfig | undefined) => Promise<unknown>;
-    inbound: <TRequest, TResponse>(transactionId: string, paymentId: string, action: string, payload: TRequest, tracingConfig?: RequestTracingConfig | undefined) => Promise<TResponse>;
-}
-export interface AuthorizationCallback {
-    paymentId: string;
-    status: string;
-    tid: string;
-    authorizationId?: Maybe<string>;
-    nsu?: Maybe<string>;
-    acquirer: string;
-    paymentUrl?: Maybe<string>;
-    paymentAppData?: Maybe<{
-        appName: string;
-        payload: string;
-    }>;
-    identificationNumber?: Maybe<string>;
-    identificationNumberFormatted?: Maybe<string>;
-    barCodeImageType?: Maybe<string>;
-    barCodeImageNumber?: Maybe<string>;
-    code?: Maybe<string>;
-    message?: Maybe<string>;
-    delayToAutoSettle?: Maybe<number>;
-    delayToAutoSettleAfterAntifraud?: Maybe<number>;
-    delayToCancel?: Maybe<number>;
-}

package/lib/clients/external/PaymentProvider.js

@@ -1,42 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ExternalClient_1 = require("./ExternalClient");
-const routes = {
-    callback: (transactionId, paymentId) => `${routes.payment(transactionId, paymentId)}/notification`,
-    inbound: (transactionId, paymentId, action) => `${routes.payment(transactionId, paymentId)}/inbound-request/${action}`,
-    payment: (transactionId, paymentId) => `/transactions/${transactionId}/payments/${paymentId}`,
-};
-class PaymentProvider extends ExternalClient_1.ExternalClient {
-    constructor(context, options) {
-        var _a;
-        super(`http://${context.account}.vtexpayments.com.br/payment-provider`, context, {
-            ...(options !== null && options !== void 0 ? options : {}),
-            headers: {
-                ...((_a = options === null || options === void 0 ? void 0 : options.headers) !== null && _a !== void 0 ? _a : {}),
-                'X-Vtex-Use-Https': 'true',
-            },
-        });
-        this.context = context;
-        this.callback = (transactionId, paymentId, callback, tracingConfig) => {
-            const metric = 'gateway-callback';
-            return this.http.post(routes.callback(transactionId, paymentId), callback, {
-                metric,
-                tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                },
-            });
-        };
-        this.inbound = (transactionId, paymentId, action, payload, tracingConfig) => {
-            const metric = 'gateway-inbound-request';
-            return this.http.post(routes.inbound(transactionId, paymentId, action), payload, {
-                metric,
-                tracing: {
-                    requestSpanNameSuffix: metric,
-                    ...tracingConfig === null || tracingConfig === void 0 ? void 0 : tracingConfig.tracing,
-                },
-            });
-        };
-    }
-}
-exports.PaymentProvider = PaymentProvider;

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

@@ -1,4 +0,0 @@
-export * from './ExternalClient';
-export * from './ID';
-export * from './PaymentProvider';
-export * from './Masterdata';

package/lib/clients/external/index.js

@@ -1,9 +0,0 @@
-"use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
-Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./ExternalClient"));
-__export(require("./ID"));
-__export(require("./PaymentProvider"));
-__export(require("./Masterdata"));

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

@@ -1,88 +0,0 @@
-/// <reference types="node" />
-import { IncomingMessage } from 'http';
-import { Readable, Writable } from 'stream';
-import { ZlibOptions } from 'zlib';
-import { InstanceOptions, RequestTracingConfig } from '../../HttpClient';
-import { AppBundleLinked, AppFilesList, AppManifest } from '../../responses';
-import { IOContext } from '../../service/worker/runtime/typings';
-import { InfraClient } from './InfraClient';
-export declare class Apps extends InfraClient {
-    private _routes;
-    private diskCache;
-    private memoryCache;
-    private get routes();
-    constructor(context: IOContext, options?: InstanceOptions);
-    installApp: (descriptor: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<void> | Promise<AppInstallResponse>;
-    uninstallApp: (app: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<import("../..").IOResponse<void>>;
-    acknowledgeApp: (app: string, service: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    link: (app: string, files: Change[], { zlib }?: ZipOptions, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppBundleLinked>;
-    patch: (app: string, changes: Change[], { zlib }?: ZipOptions, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    unlink: (app: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<import("../..").IOResponse<void>>;
-    unlinkAll: (tracingConfig?: RequestTracingConfig | undefined) => Promise<import("../..").IOResponse<void>>;
-    saveAppSettings: (app: string, settings: any, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    listApps: ({ oldVersion, since, service }?: ListAppsOptions, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppsList>;
-    listAppFiles: (app: string, { prefix, nextMarker }?: ListFilesOptions, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppFilesList>;
-    listLinks: (tracingConfig?: RequestTracingConfig | undefined) => Promise<string[]>;
-    getAppFile: (app: string, path: string, staleIfError?: boolean | undefined, tracingConfig?: RequestTracingConfig | undefined) => Promise<{
-        data: Buffer;
-        headers: any;
-    }>;
-    getAppJSON: <T extends object | null>(app: string, path: string, nullIfNotFound?: boolean | undefined, tracingConfig?: RequestTracingConfig | undefined) => Promise<T>;
-    getFileFromApps: <T extends object | null>(app: string, path: string, nullIfNotFound?: boolean | undefined, tracingConfig?: RequestTracingConfig | undefined) => Promise<T>;
-    getAppFileStream: (app: string, path: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<IncomingMessage>;
-    getApp: (app: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppManifest>;
-    getAppSettings: (app: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<any>;
-    getAllAppsSettings: (listAppsOptions?: ListAppsOptions, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppsSettings>;
-    getAppBundle: (app: string, bundlePath: string, generatePackageJson: boolean, tracingConfig?: RequestTracingConfig | undefined) => Promise<Readable>;
-    unpackAppBundle: (app: string, bundlePath: string, unpackPath: string, generatePackageJson: boolean, tracingConfig?: RequestTracingConfig | undefined) => Promise<Writable>;
-    getAppsMetaInfos: (filter?: string | undefined, staleWhileRevalidate?: boolean, tracingConfig?: RequestTracingConfig | undefined) => Promise<AppMetaInfo[]>;
-    getDependencies: (filter?: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<Record<string, string[]>>;
-    updateDependencies: (tracingConfig?: RequestTracingConfig | undefined) => Promise<Record<string, string[]>>;
-    updateDependency: (name: string, version: string, registry: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<void>;
-    resolveDependencies: (apps: string[], registries: string[], filter?: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<any>;
-    resolveDependenciesWithManifest: (manifest: AppManifest, filter?: string, tracingConfig?: RequestTracingConfig | undefined) => Promise<Record<string, string[]>>;
-    private installRuntime;
-}
-interface ZipOptions {
-    zlib?: ZlibOptions;
-}
-export interface AppMetaInfo {
-    id: string;
-    settingsSchema?: Record<string, any>;
-    _resolvedDependencies: Record<string, string>;
-    _isRoot: boolean;
-    _buildFeatures: Record<string, string[]>;
-}
-export interface WorkspaceMetaInfo {
-    apps: AppMetaInfo[];
-}
-export interface AppsListItem {
-    app: string;
-    id: string;
-    location: string;
-}
-export interface AppsList {
-    data: AppsListItem[];
-}
-export interface Change {
-    path: string;
-    content: string | Readable | Buffer;
-}
-export interface ListAppsOptions {
-    oldVersion?: string;
-    context?: string[];
-    since?: string;
-    service?: string;
-}
-export interface ListFilesOptions {
-    prefix?: string;
-    context?: string[];
-    nextMarker?: string;
-}
-export interface AppsSettings {
-    [app: string]: any;
-}
-export interface AppInstallResponse {
-    message: string;
-}
-export {};