@vtex/api 1.9.2 → 1.9.3

package/lib/caches/LRUDiskCache.d.ts

@@ -1,21 +0,0 @@
-import { CacheLayer } from './CacheLayer';
-import { LRUDiskCacheOptions, LRUStats } from './typings';
-import { outputJSON, readJSON } from 'fs-extra';
-export declare class LRUDiskCache<V> implements CacheLayer<string, V> {
-    private cachePath;
-    private readFile;
-    private writeFile;
-    private lock;
-    private disposed;
-    private hits;
-    private total;
-    private lruStorage;
-    private keyToBeDeleted;
-    constructor(cachePath: string, options: LRUDiskCacheOptions, readFile?: typeof readJSON, writeFile?: typeof outputJSON);
-    has: (key: string) => boolean;
-    getStats: (name?: string) => LRUStats;
-    get: (key: string) => Promise<void | V>;
-    set: (key: string, value: V, maxAge?: number | undefined) => Promise<boolean>;
-    private getPathKey;
-    private deleteFile;
-}

package/lib/caches/LRUDiskCache.js

@@ -1,132 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs_extra_1 = require("fs-extra");
-const LRU = require("lru-cache");
-const path_1 = require("path");
-const ReadWriteLock = require("rwlock");
-class LRUDiskCache {
-    constructor(cachePath, options, readFile = fs_extra_1.readJSON, writeFile = fs_extra_1.outputJSON) {
-        this.cachePath = cachePath;
-        this.readFile = readFile;
-        this.writeFile = writeFile;
-        this.hits = 0;
-        this.total = 0;
-        this.has = (key) => this.lruStorage.has(key);
-        this.getStats = (name = 'disk-lru-cache') => {
-            const stats = {
-                disposedItems: this.disposed,
-                hitRate: this.total > 0 ? this.hits / this.total : undefined,
-                hits: this.hits,
-                itemCount: this.lruStorage.itemCount,
-                length: this.lruStorage.length,
-                max: this.lruStorage.max,
-                name,
-                total: this.total,
-            };
-            this.hits = 0;
-            this.total = 0;
-            this.disposed = 0;
-            return stats;
-        };
-        this.get = (key) => __awaiter(this, void 0, void 0, function* () {
-            const timeOfDeath = this.lruStorage.get(key);
-            this.total += 1;
-            if (timeOfDeath === undefined) {
-                // if it is an outdated file when stale=false
-                if (this.keyToBeDeleted) {
-                    yield this.deleteFile(key);
-                }
-                return undefined;
-            }
-            const pathKey = this.getPathKey(key);
-            const data = yield new Promise(resolve => {
-                this.lock.readLock(key, (release) => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const fileData = yield this.readFile(pathKey);
-                        release();
-                        this.hits += 1;
-                        resolve(fileData);
-                    }
-                    catch (e) {
-                        release();
-                        resolve(undefined);
-                    }
-                }));
-            });
-            // if it is an outdated file when stale=true
-            if (timeOfDeath < Date.now()) {
-                this.lruStorage.del(key);
-                yield this.deleteFile(key);
-            }
-            return data;
-        });
-        this.set = (key, value, maxAge) => __awaiter(this, void 0, void 0, function* () {
-            let timeOfDeath = NaN;
-            if (maxAge) {
-                timeOfDeath = maxAge + Date.now();
-                this.lruStorage.set(key, timeOfDeath, maxAge);
-            }
-            else {
-                this.lruStorage.set(key, NaN);
-            }
-            if (this.keyToBeDeleted && this.keyToBeDeleted !== key) {
-                yield this.deleteFile(this.keyToBeDeleted);
-            }
-            const pathKey = this.getPathKey(key);
-            const failure = yield new Promise(resolve => {
-                this.lock.writeLock(key, (release) => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const writePromise = yield this.writeFile(pathKey, value);
-                        release();
-                        resolve(writePromise);
-                    }
-                    catch (e) {
-                        release();
-                        resolve(true);
-                    }
-                }));
-            });
-            return !failure;
-        });
-        this.getPathKey = (key) => {
-            return path_1.join(this.cachePath, key);
-        };
-        this.deleteFile = (key) => __awaiter(this, void 0, void 0, function* () {
-            const pathKey = this.getPathKey(key);
-            this.keyToBeDeleted = '';
-            const failure = new Promise(resolve => {
-                this.lock.writeLock(key, (release) => __awaiter(this, void 0, void 0, function* () {
-                    try {
-                        const removePromise = yield fs_extra_1.remove(pathKey);
-                        release();
-                        resolve(removePromise);
-                    }
-                    catch (e) {
-                        release();
-                        resolve(true);
-                    }
-                }));
-            });
-            return !failure;
-        });
-        this.hits = 0;
-        this.total = 0;
-        this.disposed = 0;
-        this.keyToBeDeleted = '';
-        this.lock = new ReadWriteLock();
-        const dispose = (key) => {
-            this.keyToBeDeleted = key;
-            this.disposed += 1;
-        };
-        this.lruStorage = new LRU(Object.assign({}, options, { dispose }));
-    }
-}
-exports.LRUDiskCache = LRUDiskCache;

package/lib/caches/MultilayeredCache.d.ts

@@ -1,14 +0,0 @@
-import { CacheLayer } from './CacheLayer';
-import { FetchResult, MultilayerStats } from './typings';
-export declare class MultilayeredCache<K, V> implements CacheLayer<K, V> {
-    private caches;
-    private hits;
-    private total;
-    constructor(caches: Array<CacheLayer<K, V>>);
-    get: (key: K, fetcher?: (() => Promise<FetchResult<V>>) | undefined) => Promise<void | V>;
-    set: (key: K, value: V, maxAge?: number | undefined) => Promise<boolean>;
-    has: (key: K) => Promise<boolean>;
-    getStats: (name?: string) => MultilayerStats;
-    private findIndex;
-    private resetCounters;
-}

package/lib/caches/MultilayeredCache.js

@@ -1,76 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const ramda_1 = require("ramda");
-class MultilayeredCache {
-    constructor(caches) {
-        this.caches = caches;
-        this.hits = 0;
-        this.total = 0;
-        this.get = (key, fetcher) => __awaiter(this, void 0, void 0, function* () {
-            let value;
-            let maxAge;
-            let successIndex = yield this.findIndex((cache) => __awaiter(this, void 0, void 0, function* () {
-                const [getValue, hasKey] = yield Promise.all([cache.get(key), cache.has(key)]);
-                value = getValue;
-                return hasKey;
-            }), this.caches);
-            if (successIndex === -1) {
-                if (fetcher) {
-                    const fetched = yield fetcher();
-                    value = fetched.value;
-                    maxAge = fetched.maxAge;
-                }
-                else {
-                    return undefined;
-                }
-                successIndex = Infinity;
-            }
-            const failedCaches = ramda_1.slice(0, successIndex, this.caches);
-            const [firstPromise] = ramda_1.map(cache => cache.set(key, value, maxAge), failedCaches);
-            yield firstPromise;
-            return value;
-        });
-        this.set = (key, value, maxAge) => __awaiter(this, void 0, void 0, function* () {
-            const isSet = yield Promise.all(ramda_1.map(cache => cache.set(key, value, maxAge), this.caches));
-            return ramda_1.any(item => item, isSet);
-        });
-        this.has = (key) => __awaiter(this, void 0, void 0, function* () {
-            const hasList = yield Promise.all(ramda_1.map(cache => cache.has(key), this.caches));
-            return ramda_1.any(item => item, hasList);
-        });
-        this.getStats = (name = 'multilayred-cache') => {
-            const multilayerStats = {
-                hitRate: this.total > 0 ? this.hits / this.total : undefined,
-                hits: this.hits,
-                name,
-                total: this.total,
-            };
-            this.resetCounters();
-            return multilayerStats;
-        };
-        this.findIndex = (func, array) => __awaiter(this, void 0, void 0, function* () {
-            this.total += 1;
-            for (let index = 0; index < array.length; index++) {
-                const hasKey = yield func(array[index]);
-                if (hasKey) {
-                    this.hits += 1;
-                    return index;
-                }
-            }
-            return -1;
-        });
-    }
-    resetCounters() {
-        this.hits = 0;
-        this.total = 0;
-    }
-}
-exports.MultilayeredCache = MultilayeredCache;

package/lib/caches/index.d.ts

@@ -1,6 +0,0 @@
-export * from './CacheLayer';
-export * from './DiskCache';
-export * from './LRUCache';
-export * from './LRUDiskCache';
-export * from './MultilayeredCache';
-export * from './typings';

package/lib/caches/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("./DiskCache"));
-__export(require("./LRUCache"));
-__export(require("./LRUDiskCache"));
-__export(require("./MultilayeredCache"));

package/lib/caches/typings.d.ts

@@ -1,48 +0,0 @@
-export declare type FetchResult<V> = {
-    value: V;
-    maxAge?: number;
-};
-export declare type DiskStats = {
-    hits: number;
-    total: number;
-    name: string;
-};
-export declare type LRUStats = {
-    itemCount: number;
-    length: number;
-    disposedItems: number;
-    hitRate: number | undefined;
-    hits: number;
-    max: number;
-    name: string;
-    total: number;
-};
-export declare type MultilayerStats = {
-    hitRate: number | undefined;
-    hits: number;
-    total: number;
-    name: string;
-};
-export declare type LRUDiskCacheOptions = {
-    /**
-     * The maximum size of the cache, checked by applying the length
-     * function to all values in the cache. Not setting this is kind of silly,
-     * since that's the whole purpose of this lib, but it defaults to `Infinity`.
-     */
-    max?: number;
-    /**
-     * Maximum age in ms. Items are not pro-actively pruned out as they age,
-     * but if you try to get an item that is too old, it'll drop it and return
-     * undefined instead of giving it to you.
-     */
-    maxAge?: number;
-    /**
-     * By default, if you set a `maxAge`, it'll only actually pull stale items
-     * out of the cache when you `get(key)`. (That is, it's not pre-emptively
-     * doing a `setTimeout` or anything.) If you set `stale:true`, it'll return
-     * the stale value before deleting it. If you don't set this, then it'll
-     * return `undefined` when you try to get a stale entry,
-     * as if it had already been deleted.
-     */
-    stale?: boolean;
-};

package/lib/caches/typings.js

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

package/lib/constants.d.ts

@@ -1 +0,0 @@
-export declare const DEFAULT_WORKSPACE = "master";

package/lib/constants.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DEFAULT_WORKSPACE = 'master';

package/lib/index.d.ts

@@ -1,19 +0,0 @@
-export * from './Apps';
-export * from './Builder';
-export * from './HttpClient';
-export * from './Registry';
-export * from './Router';
-export * from './VBase';
-export * from './ID';
-export * from './Workspaces';
-export * from './Logger';
-export * from './Events';
-export * from './Metadata';
-export * from './responses';
-export * from './Billing';
-export * from './caches';
-export * from './metrics/metricsAccumulator';
-export * from './metrics/metricsLogger';
-export * from './utils';
-export * from './IODataSource';
-export * from './runtime';

package/lib/index.js

@@ -1,21 +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("./Apps"));
-__export(require("./Builder"));
-__export(require("./HttpClient"));
-__export(require("./Registry"));
-__export(require("./Router"));
-__export(require("./VBase"));
-__export(require("./ID"));
-__export(require("./Workspaces"));
-__export(require("./Logger"));
-__export(require("./Events"));
-__export(require("./Metadata"));
-__export(require("./Billing"));
-__export(require("./caches"));
-__export(require("./metrics/metricsAccumulator"));
-__export(require("./utils"));
-__export(require("./IODataSource"));

package/lib/metrics/metricsAccumulator.d.ts

@@ -1,27 +0,0 @@
-export interface Metric {
-    name: string;
-    [key: string]: any;
-}
-interface GetStats {
-    getStats(): {
-        [key: string]: number | boolean | string | undefined;
-    };
-}
-export declare class MetricsAccumulator {
-    private metricsMillis;
-    private devMetricsMillis;
-    private cacheMap;
-    private onFlushMetrics;
-    private metricToAggregate;
-    private devMetricToAggregate;
-    constructor();
-    batchHrTimeMetricFromEnd: (name: string, end: [number, number], production: boolean) => void;
-    batchHrTimeMetric: (name: string, start: [number, number], production: boolean) => void;
-    batchMetric: (name: string, timeMillis: number, production: boolean) => void;
-    addOnFlushMetric: (metricFn: () => Metric | Metric[]) => void;
-    trackCache: (name: string, cacheInstance: GetStats) => void;
-    statusTrack: () => Metric[];
-    private cacheToMetric;
-    private flushMetrics;
-}
-export {};

package/lib/metrics/metricsAccumulator.js

@@ -1,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const ramda_1 = require("ramda");
-const stats_lite_1 = require("stats-lite");
-const Time_1 = require("../utils/Time");
-let lastCpu = process.cpuUsage();
-function cpuUsage() {
-    const diff = process.cpuUsage(lastCpu);
-    lastCpu = {
-        system: lastCpu.system + diff.system,
-        user: lastCpu.user + diff.user,
-    };
-    return diff;
-}
-const createMetricToAggregateReducer = (production) => (value, key, obj) => {
-    const aggregate = {
-        name: key,
-        count: value.length,
-        max: Math.max(...value),
-        mean: stats_lite_1.mean(value),
-        median: stats_lite_1.median(value),
-        percentile95: stats_lite_1.percentile(value, 0.95),
-        percentile99: stats_lite_1.percentile(value, 0.99),
-        production,
-    };
-    delete obj[key];
-    return aggregate;
-};
-class MetricsAccumulator {
-    constructor() {
-        this.metricToAggregate = createMetricToAggregateReducer(true);
-        this.devMetricToAggregate = createMetricToAggregateReducer(false);
-        this.batchHrTimeMetricFromEnd = (name, end, production) => {
-            this.batchMetric(name, Time_1.hrToMillis(end), production);
-        };
-        this.batchHrTimeMetric = (name, start, production) => {
-            this.batchMetric(name, Time_1.hrToMillis(process.hrtime(start)), production);
-        };
-        this.batchMetric = (name, timeMillis, production) => {
-            if (production) {
-                if (!this.metricsMillis[name]) {
-                    this.metricsMillis[name] = [];
-                }
-                this.metricsMillis[name].push(timeMillis);
-            }
-            else {
-                if (!this.devMetricsMillis[name]) {
-                    this.devMetricsMillis[name] = [];
-                }
-                this.devMetricsMillis[name].push(timeMillis);
-            }
-        };
-        this.addOnFlushMetric = (metricFn) => {
-            this.onFlushMetrics.push(metricFn);
-        };
-        this.trackCache = (name, cacheInstance) => {
-            this.cacheMap[name] = cacheInstance;
-        };
-        this.statusTrack = () => {
-            return this.flushMetrics();
-        };
-        this.cacheToMetric = (value, key) => (Object.assign({ name: `${key}-cache` }, value.getStats()));
-        this.flushMetrics = () => {
-            const aggregateMetrics = ramda_1.values(ramda_1.mapObjIndexed(this.metricToAggregate, this.metricsMillis));
-            const aggregateDevMetrics = ramda_1.values(ramda_1.mapObjIndexed(this.devMetricToAggregate, this.devMetricsMillis));
-            const systemMetrics = [
-                Object.assign({ name: 'cpu' }, cpuUsage()),
-                Object.assign({ name: 'memory' }, process.memoryUsage()),
-            ];
-            const onFlushMetrics = ramda_1.flatten(ramda_1.map(getMetric => getMetric(), this.onFlushMetrics));
-            const cacheMetrics = ramda_1.values(ramda_1.mapObjIndexed(this.cacheToMetric, this.cacheMap));
-            return [...systemMetrics, ...aggregateMetrics, ...aggregateDevMetrics, ...onFlushMetrics, ...cacheMetrics];
-        };
-        this.metricsMillis = {};
-        this.devMetricsMillis = {};
-        this.onFlushMetrics = [];
-        this.cacheMap = {};
-    }
-}
-exports.MetricsAccumulator = MetricsAccumulator;

package/lib/metrics/metricsLogger.d.ts

@@ -1,6 +0,0 @@
-export interface Key {
-    name: string;
-}
-export interface MetricsLogger {
-    add: (key: Key, value: any) => void;
-}

package/lib/metrics/metricsLogger.js

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

package/lib/responses.d.ts

@@ -1,95 +0,0 @@
-export interface Policy {
-    name: string;
-    attrs?: {
-        [name: string]: string;
-    };
-}
-export interface AppManifest {
-    [internal: string]: any;
-    vendor: string;
-    name: string;
-    version: string;
-    title?: string;
-    description?: string;
-    mustUpdateAt?: string;
-    builders: {
-        [name: string]: string;
-    };
-    categories?: string[];
-    dependencies?: {
-        [name: string]: string;
-    };
-    peerDependencies?: {
-        [name: string]: string;
-    };
-    settingsSchema?: any;
-    registries?: string[];
-    credentialType?: string;
-    policies?: Policy[];
-    billingOptions?: BillingOptions;
-    _resolvedDependencies?: {
-        [name: string]: string[];
-    };
-}
-export interface FileListItem {
-    path: string;
-    hash: string;
-}
-export interface AppFilesList {
-    data: FileListItem[];
-}
-export interface BucketMetadata {
-    state: string;
-    lastModified: string;
-    hash: string;
-}
-interface RootBillingOptions {
-    termsURL: string;
-    support: Support;
-}
-export interface Support {
-    url: string;
-    email: string;
-}
-export declare type BillingOptions = RootBillingOptions & ({
-    free: boolean;
-} | {
-    policies: BillingPolicy[];
-});
-export interface BillingPolicy {
-    currency: string;
-    billing: BillingChargeElements;
-}
-export interface BillingChargeElements {
-    taxClassification: string;
-    items: CalculationItem[];
-}
-export declare type CalculationItem = {
-    itemCurrency: string;
-} & ({
-    fixed: number;
-} | {
-    calculatedByMetricUnit: CalculatedByMetricUnit;
-});
-export interface CalculatedByMetricUnit {
-    metricId: string;
-    metricName: string;
-    ranges: Range[];
-    route?: string;
-}
-export interface Range {
-    exclusiveFrom: number;
-    inclusiveTo?: number;
-    multiplier: number;
-}
-export interface AppBundleResponse {
-    message: string;
-    id: string;
-}
-export declare type AppBundlePublished = AppBundleResponse & {
-    bundleSize?: number;
-};
-export declare type AppBundleLinked = AppBundleResponse & {
-    bundleSize?: number;
-};
-export {};

package/lib/responses.js

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

package/lib/runtime.d.ts

@@ -1,27 +0,0 @@
-import { DataSource } from 'apollo-datasource';
-import { KeyValueCache } from 'apollo-server-caching';
-import { IDirectiveResolvers } from 'graphql-tools';
-import { ServiceContext } from './HttpClient';
-import { Metric } from './metrics/metricsAccumulator';
-export declare type StatusTrack = () => Metric[];
-export declare type DataSourcesGenerator = () => {
-    [name: string]: DataSource<ServiceContext>;
-};
-export interface GraphQLOptions {
-    resolvers: any;
-    dataSources?: DataSourcesGenerator;
-    schemaDirectives?: IDirectiveResolvers<any, ServiceContext>;
-    cache?: () => KeyValueCache;
-}
-export declare type Route = (ctx: ServiceContext) => Promise<void>;
-export interface Routes {
-    [route: string]: Route;
-}
-export interface RuntimeOptions {
-    events?: any;
-    statusTrack?: StatusTrack;
-    routes?: Routes;
-    graphql?: GraphQLOptions;
-    dataSources?: DataSourcesGenerator;
-    cache?: KeyValueCache;
-}

package/lib/runtime.js

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

package/lib/utils/AppId.d.ts

@@ -1,19 +0,0 @@
-export declare const removeBuild: (id: string) => string;
-export declare const removeVersionFromAppId: (appId: string) => string;
-export declare const extractVersionFromAppId: (appId: string) => string;
-export declare const transformToLinkedLocator: (appId: string) => string;
-export declare const formatLocator: (name: string, versionAndBuild: string) => string;
-export declare const parseAppId: (appId: string) => ParsedLocator;
-export declare const formatAppId: ({ locator, build }: ParsedLocator) => string;
-export declare const satisfies: (appId: string, version: string) => boolean;
-export declare const versionToMajor: (version: string) => string;
-export declare const versionToMajorRange: (version: string) => string;
-export declare const formatMajorLocator: (name: string, version: string) => string;
-export declare const appIdToAppAtMajor: (appId: string) => string;
-export declare const isValidAppIdOrLocator: (appId: string) => boolean;
-export interface ParsedLocator {
-    name: string;
-    version: string;
-    locator: string;
-    build?: string;
-}