@vtex/api 6.45.4

package/lib/utils/status.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statusLabel = (status) => {
+    if (status >= 500) {
+        return 'error';
+    }
+    if (status >= 200 && status < 300) {
+        return 'success';
+    }
+    return `${Math.floor(status / 100)}xx`;
+};

package/lib/utils/tenant.d.ts

@@ -0,0 +1,5 @@
+export interface TenantHeader {
+    locale: string;
+}
+export declare const formatTenantHeaderValue: (tenant: TenantHeader) => string;
+export declare const parseTenantHeaderValue: (value: string) => TenantHeader;

package/lib/utils/tenant.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatTenantHeaderValue = (tenant) => tenant.locale;
+exports.parseTenantHeaderValue = (value) => ({
+    locale: value,
+});

package/lib/utils/throwOnGraphQLErrors.d.ts

@@ -0,0 +1,2 @@
+import { GraphQLResponse } from '../HttpClient/GraphQLClient';
+export declare function throwOnGraphQLErrors(message: string): (response: GraphQLResponse<any>) => GraphQLResponse<any>;

package/lib/utils/throwOnGraphQLErrors.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const customGraphQLError_1 = __importDefault(require("../errors/customGraphQLError"));
+function throwOnGraphQLErrors(message) {
+    return function maybeGraphQLResponse(response) {
+        if (response && response.errors && response.errors.length > 0) {
+            throw new customGraphQLError_1.default(message, response.errors);
+        }
+        return response;
+    };
+}
+exports.throwOnGraphQLErrors = throwOnGraphQLErrors;

package/lib/utils/time.d.ts

@@ -0,0 +1,31 @@
+import { IOClients } from '../clients/IOClients';
+import { MetricsAccumulator } from '../metrics/MetricsAccumulator';
+import { EventHandler, ParamsContext, RecorderState, RouteHandler } from '../service/worker/runtime/typings';
+export declare const hrToMillis: ([seconds, nanoseconds]: [number, number]) => number;
+export declare const hrToMillisFloat: ([seconds, nanoseconds]: [number, number]) => number;
+export declare const nanosecondsToSeconds: (nanoseconds: number) => number;
+export declare const hrToNano: ([seconds, nanoseconds]: [number, number]) => number;
+export declare const formatNano: (nanoseconds: number) => string;
+export declare const reduceHrToNano: (values: import("ramda").List<[number, number]>) => number;
+export declare const shrinkTimings: (name: string) => string;
+export declare const formatTimingName: ({ hopNumber, target, source }: {
+    hopNumber: number | null;
+    source: string | null;
+    target: string | null;
+}) => string;
+export declare const parseTimingName: (timing: string | undefined) => {
+    hopNumber: number | null;
+    source: string | null;
+    target: string | null;
+};
+export declare const reduceTimings: (timingsObj: Record<string, string>) => string;
+export declare function timer<T extends IOClients, U extends RecorderState, V extends ParamsContext>(middleware: RouteHandler<T, U, V>): RouteHandler<T, U, V>;
+export declare function timerForEvents<T extends IOClients, U>(middleware: EventHandler<T, U>): EventHandler<T, U>;
+declare global {
+    const metrics: MetricsAccumulator;
+    namespace NodeJS {
+        interface Global {
+            metrics: MetricsAccumulator;
+        }
+    }
+}

package/lib/utils/time.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ramda_1 = require("ramda");
+const logger_1 = require("../service/logger");
+exports.hrToMillis = ([seconds, nanoseconds]) => Math.round((seconds * 1e3) + (nanoseconds / 1e6));
+exports.hrToMillisFloat = ([seconds, nanoseconds]) => {
+    return (seconds * 1e3) + (nanoseconds / 1e6);
+};
+exports.nanosecondsToSeconds = (nanoseconds) => {
+    return nanoseconds / 1e9;
+};
+exports.hrToNano = ([seconds, nanoseconds]) => seconds * 1e9 + nanoseconds;
+exports.formatNano = (nanoseconds) => `${(nanoseconds / 1e9).toFixed(0)}s ${((nanoseconds / 1e6) % 1e3).toFixed(0)}ms`;
+exports.reduceHrToNano = ramda_1.reduce((acc, hr) => acc + exports.hrToNano(hr), 0);
+exports.shrinkTimings = (name) => name.replace(/graphql/g, 'gql').replace(/server/g, 'srv');
+exports.formatTimingName = ({ hopNumber, target, source }) => `${Number.isNaN(hopNumber) ? '' : hopNumber}.${source || ''}#${target || ''}`;
+exports.parseTimingName = (timing) => {
+    const [hopNumber, sourceAndTarget] = timing ? timing.split('.') : [null, null];
+    const [source, target] = sourceAndTarget ? sourceAndTarget.split('#') : [null, null];
+    return {
+        hopNumber: Number.isNaN(hopNumber) ? null : Number(hopNumber),
+        source,
+        target,
+    };
+};
+exports.reduceTimings = (timingsObj) => ramda_1.compose(ramda_1.reduce((acc, [key, dur]) => `${key};dur=${dur}, ${acc}`, ''), ramda_1.toPairs)(timingsObj);
+function recordTimings(start, name, timings, middlewareMetrics, success) {
+    // Capture the total amount of time spent in this middleware, which includes following middlewares
+    const end = process.hrtime(start);
+    // Elapsed for this middleware must disconsider total so far
+    const elapsed = [
+        end[0] - timings.total[0],
+        end[1] - timings.total[1],
+    ];
+    // Only record successful executions
+    if (success) {
+        timings[name] = elapsed;
+    }
+    // This middlewares end is now the total
+    timings.total = end;
+    // Batch metric
+    const label = `middleware-${name}`;
+    metrics.batch(label, success ? elapsed : undefined, { success: success ? 1 : 0 });
+    // This middleware has added it's own metrics
+    // Just add them to `timings` scoped by the middleware's name and batch them
+    const middlewareMetricsKeys = ramda_1.keys(middlewareMetrics);
+    if (success && middlewareMetricsKeys.length > 0) {
+        ramda_1.forEach((k) => {
+            const metricEnd = middlewareMetrics[k];
+            // Delete own metrics so next middleware can have empty state but still accumulate metrics batched after `await`
+            delete middlewareMetrics[k];
+            const metricName = `${label}-${k}`;
+            timings[metricName] = metricEnd;
+            metrics.batch(metricName, metricEnd);
+        }, middlewareMetricsKeys);
+    }
+}
+function timer(middleware) {
+    if (middleware.skipTimer) {
+        return middleware;
+    }
+    if (!middleware.name) {
+        logger_1.logOnceToDevConsole(`Please use a named function as handler for better metrics. ${middleware.toString()}`, logger_1.LogLevel.Warn);
+    }
+    return async (ctx, next) => {
+        if (!ctx.serverTiming) {
+            ctx.serverTiming = {};
+        }
+        if (!ctx.timings) {
+            ctx.timings = {
+                total: [0, 0],
+            };
+        }
+        if (!ctx.metrics) {
+            ctx.metrics = {};
+        }
+        const start = process.hrtime();
+        try {
+            await middleware(ctx, next);
+            // At this point, this middleware *and all following ones* have executed
+            recordTimings(start, middleware.name, ctx.timings, ctx.metrics, true);
+        }
+        catch (e) {
+            recordTimings(start, middleware.name, ctx.timings, ctx.metrics, false);
+            throw e;
+        }
+    };
+}
+exports.timer = timer;
+function timerForEvents(middleware) {
+    if (middleware.skipTimer) {
+        return middleware;
+    }
+    if (!middleware.name) {
+        logger_1.logOnceToDevConsole(`Please use a named function as handler for better metrics. ${middleware.toString()}`, logger_1.LogLevel.Warn);
+    }
+    return async (ctx, next) => {
+        if (!ctx.timings) {
+            ctx.timings = {
+                total: [0, 0],
+            };
+        }
+        if (!ctx.metrics) {
+            ctx.metrics = {};
+        }
+        const start = process.hrtime();
+        try {
+            await middleware(ctx, next);
+            // At this point, this middleware *and all following ones* have executed
+            recordTimings(start, middleware.name, ctx.timings, ctx.metrics, true);
+        }
+        catch (e) {
+            recordTimings(start, middleware.name, ctx.timings, ctx.metrics, false);
+            throw e;
+        }
+    };
+}
+exports.timerForEvents = timerForEvents;

package/package.json

@@ -0,0 +1,127 @@
+{
+  "name": "@vtex/api",
+  "version": "6.45.4",
+  "description": "VTEX I/O API client",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib/",
+    "gen/"
+  ],
+  "scripts": {
+    "clean": "rimraf lib/",
+    "watch": "yarn clean && tsc --watch",
+    "build": "yarn clean && tsc",
+    "gen": "typescript-json-schema tsconfig.json PublicAppManifest > gen/manifest.schema",
+    "test": "jest",
+    "lint": "tslint -c tslint.json './src/**/*.ts'",
+    "format": "prettier --config ./.prettierrc --write \"src/**/*.ts\" \"src/**/*.js\"",
+    "format-lint": "yarn format && yarn lint",
+    "prepublishOnly": "bash ./scripts/publishLock.sh",
+    "ci:build": "yarn build && yarn gen",
+    "ci:test": "yarn test --ci",
+    "ci:prettier-check": "prettier --check --config ./.prettierrc \"src/**/*.ts\" \"src/**/*.js\""
+  },
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
+    },
+    "testMatch": [
+      "**/__tests__/**/*.(js|ts)?(x)",
+      "**/?(*.)+(spec|test).(js|ts)?(x)"
+    ],
+    "moduleFileExtensions": [
+      "ts",
+      "js"
+    ]
+  },
+  "engines": {
+    "node": ">=8"
+  },
+  "keywords": [
+    "vtex"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:vtex/node-vtex-api.git"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@types/koa": "^2.11.0",
+    "@types/koa-compose": "^3.2.3",
+    "@vtex/node-error-report": "^0.0.3",
+    "@wry/equality": "^0.1.9",
+    "agentkeepalive": "^4.0.2",
+    "apollo-server-errors": "^2.2.1",
+    "archiver": "^3.0.0",
+    "axios": "^0.21.1",
+    "axios-retry": "^3.1.2",
+    "bluebird": "^3.5.4",
+    "chalk": "^2.4.2",
+    "co-body": "^6.0.0",
+    "cookie": "^0.3.1",
+    "dataloader": "^1.4.0",
+    "fast-json-stable-stringify": "^2.0.0",
+    "fs-extra": "^7.0.0",
+    "graphql": "^14.5.8",
+    "graphql-tools": "^4.0.6",
+    "graphql-upload": "^8.1.0",
+    "jaeger-client": "^3.18.0",
+    "js-base64": "^2.5.1",
+    "koa": "^2.11.0",
+    "koa-compose": "^4.1.0",
+    "koa-compress": "^3.0.0",
+    "koa-router": "^7.4.0",
+    "lru-cache": "^5.1.1",
+    "mime-types": "^2.1.12",
+    "opentracing": "^0.14.4",
+    "p-limit": "^2.2.0",
+    "prom-client": "^12.0.0",
+    "qs": "^6.5.1",
+    "querystring": "^0.2.0",
+    "ramda": "^0.26.0",
+    "rwlock": "^5.0.0",
+    "semver": "^5.5.1",
+    "stats-lite": "vtex/node-stats-lite#dist",
+    "tar-fs": "^2.0.0",
+    "tokenbucket": "^0.3.2",
+    "uuid": "^3.3.3",
+    "xss": "^1.0.6"
+  },
+  "devDependencies": {
+    "@tiagonapoli/opentracing-alternate-mock": "^0.0.3",
+    "@types/archiver": "^2.0.1",
+    "@types/bluebird": "^3.5.27",
+    "@types/co-body": "^0.0.3",
+    "@types/cookie": "^0.3.2",
+    "@types/fast-json-stable-stringify": "^2.0.0",
+    "@types/fs-extra": "^5.0.0",
+    "@types/graphql": "^14.5.0",
+    "@types/graphql-upload": "^8.0.3",
+    "@types/jaeger-client": "^3.15.3",
+    "@types/jest": "^25.1.4",
+    "@types/js-base64": "^2.3.1",
+    "@types/koa-compress": "^2.0.9",
+    "@types/koa-router": "^7.0.42",
+    "@types/lru-cache": "^5.1.0",
+    "@types/mime-types": "^2.1.0",
+    "@types/node": "12.x",
+    "@types/qs": "^6.5.1",
+    "@types/ramda": "types/npm-ramda#dist",
+    "@types/rwlock": "^5.0.2",
+    "@types/semver": "^5.5.0",
+    "@types/uuid": "^3.4.6",
+    "get-port": "^5.1.1",
+    "jest": "^25.1.0",
+    "npm-run-all": "^4.1.3",
+    "rimraf": "^2.5.2",
+    "semaphore-async-await": "^1.5.1",
+    "ts-jest": "^25.2.1",
+    "tslint": "^5.14.0",
+    "tslint-config-vtex": "^2.1.0",
+    "tslint-eslint-rules": "^5.4.0",
+    "typemoq": "^2.1.0",
+    "typescript": "^3.8.3",
+    "typescript-json-schema": "^0.40.0"
+  }
+}