unleash-server/dist/lib/features/metrics/shared/schema.js

Unleash is an enterprise ready feature flag service. It provides different strategies for handling feature flags.

import joi from 'joi';
const countSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    yes: joi.number().min(0).empty('').default(0),
    no: joi.number().min(0).empty('').default(0),
    variants: joi.object().pattern(joi.string(), joi.number().min(0)),
});
export const clientMetricsSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    environment: joi.string().optional(),
    appName: joi.string().required(),
    instanceId: joi.string().empty(['', null]).default('default'),
    bucket: joi
        .object()
        .required()
        .keys({
        start: joi.date().required(),
        stop: joi.date().required(),
        toggles: joi.object().pattern(/.*/, countSchema),
    }),
});
export const clientMetricsEnvSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    featureName: joi.string().required().allow(''),
    environment: joi.string().required(),
    appName: joi.string().required(),
    yes: joi.number().default(0),
    no: joi.number().default(0),
    timestamp: joi.date(),
    variants: joi.object().pattern(joi.string(), joi.number().min(0)),
});
export const clientMetricsEnvBulkSchema = joi
    .array()
    .items(clientMetricsEnvSchema)
    .empty();
export const applicationSchema = joi
    .object()
    .options({ stripUnknown: false })
    .keys({
    appName: joi.string().required(),
    sdkVersion: joi.string().optional(),
    strategies: joi
        .array()
        .optional()
        .items(joi.string(), joi.any().strip()),
    description: joi.string().allow('').optional(),
    url: joi.string().allow('').optional(),
    color: joi.string().allow('').optional(),
    icon: joi.string().allow('').optional(),
    announced: joi.boolean().optional().default(false),
});
export const customMetricSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    name: joi.string().required(),
    value: joi.number().required(),
    labels: joi.object().pattern(joi.string(), joi.string()).optional(),
});
export const customMetricsSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    metrics: joi.array().items(customMetricSchema).required(),
});
export const metricSampleSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    value: joi.number().required(),
    labels: joi
        .object()
        .pattern(joi.string(), joi.alternatives().try(joi.string(), joi.number()))
        .optional(),
});
export const histogramSampleSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    count: joi.number().required(),
    sum: joi.number().required(),
    buckets: joi
        .array()
        .items(joi.object({
        le: joi
            .alternatives()
            .try(joi.number(), joi.string().valid('+Inf'))
            .required(),
        count: joi.number().required(),
    }))
        .required(),
    labels: joi
        .object()
        .pattern(joi.string(), joi.alternatives().try(joi.string(), joi.number()))
        .optional(),
});
export const impactMetricSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    name: joi.string().required(),
    help: joi.string().required(),
    type: joi.string().required(),
    buckets: joi.array().items(joi.number()).optional(),
    samples: joi.when('type', {
        is: 'histogram',
        then: joi.array().items(histogramSampleSchema).required(),
        otherwise: joi.array().items(metricSampleSchema).required(),
    }),
});
export const impactMetricsSchema = joi
    .array()
    .items(impactMetricSchema)
    .empty();
export const batchMetricsSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    applications: joi.array().items(applicationSchema),
    metrics: joi.array().items(clientMetricsEnvSchema),
});
export const clientRegisterSchema = joi
    .object()
    .options({ stripUnknown: true })
    .keys({
    appName: joi.string().required(),
    instanceId: joi.string().empty(['', null]).default('default'),
    sdkVersion: joi.string().optional(),
    strategies: joi.array().items(joi.string(), joi.any().strip()),
    started: joi.date().required(),
    interval: joi.number().required(),
    environment: joi.string().optional(),
    project: joi.string().optional(),
    projects: joi.array().optional().items(joi.string()),
});
//# sourceMappingURL=schema.js.map