@statoss/sdk 0.1.1 → 0.3.0

package/dist/esm/levels.d.ts

@@ -1,10 +1,13 @@
 import type { Logger } from "./logger.js";
 import type { SentryLevel } from "./types.js";
 export declare const SENTRY_LEVELS: readonly SentryLevel[];
+export declare const LEVEL_RULE = "use 1 to 32 lowercase letters, digits, dots, dashes or underscores";
+export declare const CATEGORY_RULE = "use 1 to 64 lowercase letters, digits, dots, dashes or underscores";
 export declare const LEVEL_TAG = "statoss.level";
 export declare const CATEGORY_TAG = "statoss.category";
 export declare function isSentryLevel(value: unknown): value is SentryLevel;
-export declare function isValidName(value: unknown): value is string;
+export declare function isLevelName(value: unknown): value is string;
+export declare function isCategoryName(value: unknown): value is string;
 /** Keeps the entries of init's `levels` that are usable, logging the rest in debug mode. */
 export declare function readLevels(input: unknown, logger: Logger): Record<string, SentryLevel>;
 export interface LevelChoice {

package/dist/esm/levels.js

@@ -6,16 +6,26 @@ export const SENTRY_LEVELS = [
     "info",
     "debug",
 ];
-/** Custom level and category names: what the server accepts as tag values to filter on. */
-const NAME_RE = /^[a-z0-9._-]{1,64}$/;
+/**
+ * Names of your own: lowercase letters, digits, dots, dashes and
+ * underscores. A level is at most 32 characters, as the server keeps it; a
+ * category at most 64.
+ */
+const LEVEL_RE = /^[a-z0-9._-]{1,32}$/;
+const CATEGORY_RE = /^[a-z0-9._-]{1,64}$/;
+export const LEVEL_RULE = "use 1 to 32 lowercase letters, digits, dots, dashes or underscores";
+export const CATEGORY_RULE = "use 1 to 64 lowercase letters, digits, dots, dashes or underscores";
 export const LEVEL_TAG = "statoss.level";
 export const CATEGORY_TAG = "statoss.category";
 export function isSentryLevel(value) {
     return (typeof value === "string" &&
         SENTRY_LEVELS.includes(value));
 }
-export function isValidName(value) {
-    return typeof value === "string" && NAME_RE.test(value);
+export function isLevelName(value) {
+    return typeof value === "string" && LEVEL_RE.test(value);
+}
+export function isCategoryName(value) {
+    return typeof value === "string" && CATEGORY_RE.test(value);
 }
 /** Keeps the entries of init's `levels` that are usable, logging the rest in debug mode. */
 export function readLevels(input, logger) {
@@ -30,8 +40,8 @@ export function readLevels(input, logger) {
         if (isSentryLevel(name)) {
             logger.warn(`Ignored level "${name}" in \`levels\`: it is already a Sentry level.`);
         }
-        else if (!isValidName(name)) {
-            logger.warn(`Ignored level "${name}" in \`levels\`: use 1 to 64 lowercase letters, digits, dots, dashes or underscores.`);
+        else if (!isLevelName(name)) {
+            logger.warn(`Ignored level "${name}" in \`levels\`: ${LEVEL_RULE}.`);
         }
         else if (!isSentryLevel(level)) {
             logger.warn(`Ignored level "${name}" in \`levels\`: map it to fatal, error, warning, info or debug.`);
@@ -52,18 +62,18 @@ export function chooseLevel(candidates, levels, fallback, logger) {
             continue;
         if (isSentryLevel(candidate))
             return { level: candidate };
-        if (isValidName(candidate)) {
+        if (isLevelName(candidate)) {
             return { level: levels[candidate] ?? "error", custom: candidate };
         }
-        logger.warn(`Ignored level "${safeString(candidate)}": use a Sentry level or 1 to 64 lowercase letters, digits, dots, dashes or underscores.`);
+        logger.warn(`Ignored level "${safeString(candidate)}": use a Sentry level or 1 to 32 lowercase letters, digits, dots, dashes or underscores.`);
     }
     return { level: fallback };
 }
 export function readCategory(value, logger) {
     if (value === undefined || value === null)
         return undefined;
-    if (isValidName(value))
+    if (isCategoryName(value))
         return value;
-    logger.warn(`Ignored category "${safeString(value)}": use 1 to 64 lowercase letters, digits, dots, dashes or underscores.`);
+    logger.warn(`Ignored category "${safeString(value)}": ${CATEGORY_RULE}.`);
     return undefined;
 }

package/dist/esm/schema.d.ts

@@ -0,0 +1,199 @@
+import type { Logger } from "./logger.js";
+import type { CaptureContext, Event, Level, SentryLevel } from "./types.js";
+/** The ranges a level ranks in: Sentry's five and OpenTelemetry's trace. */
+export declare const LIKES: readonly ["fatal", "error", "warning", "info", "debug", "trace"];
+export type Like = (typeof LIKES)[number];
+/** The colours a level or a category takes, by name. */
+export declare const SCHEMA_COLORS: readonly ["crimson", "red", "orange", "amber", "yellow", "green", "aqua", "teal", "blue", "violet", "indigo", "magenta", "plum", "grey"];
+export type SchemaColor = (typeof SCHEMA_COLORS)[number];
+/** What a rule tests: a tag by key, the logger, or one of the event's own fields. */
+export declare const RULE_SUBJECTS: readonly ["tag", "logger", "exception", "culprit", "title", "message"];
+export type RuleSubject = (typeof RULE_SUBJECTS)[number];
+export declare const RULE_MATCHES: readonly ["is", "starts", "contains"];
+export type RuleMatch = (typeof RULE_MATCHES)[number];
+export declare const FIELD_TYPES: readonly ["text", "number"];
+export type FieldType = (typeof FIELD_TYPES)[number];
+/** Each range's severities, as OpenTelemetry numbers them. */
+interface Severities {
+    fatal: 21 | 22 | 23 | 24;
+    error: 17 | 18 | 19 | 20;
+    warning: 13 | 14 | 15 | 16;
+    info: 9 | 10 | 11 | 12;
+    debug: 5 | 6 | 7 | 8;
+    trace: 1 | 2 | 3 | 4;
+}
+export type Severity = Severities[Like];
+/** A level of your own. Null clears a setting. */
+export interface LevelSettings {
+    /** The range it ranks in. Without it (and without severity) it ranks as error. */
+    like?: Like;
+    /** 1 to 24, inside the range of `like`. */
+    severity?: Severity;
+    label?: string | null;
+    color?: SchemaColor | null;
+}
+/** A category. Null clears a setting. */
+export interface CategorySettings {
+    label?: string | null;
+    color?: SchemaColor | null;
+    /** Left out of filters and lists; its events still carry it. */
+    hidden?: boolean;
+    /** A team member's email. */
+    owner?: string | null;
+}
+/** A field: a tag key. Null clears a setting. */
+export interface FieldSettings {
+    label?: string | null;
+    type?: FieldType;
+    unit?: string | null;
+    /** Gets a picker in Explore's filters. */
+    filterable?: boolean;
+}
+type RuleTests = {
+    subject: "tag";
+    tagKey: string;
+} | {
+    subject: Exclude<RuleSubject, "tag">;
+    tagKey?: undefined;
+};
+type RuleSets<L extends string, C extends string> = {
+    level: L;
+    category?: C;
+} | {
+    level?: L;
+    category: C;
+};
+/**
+ * Sets a level, a category or both for events that match: the first rule
+ * that matches wins. `match` defaults to "is".
+ */
+export type SchemaRule<L extends string = string, C extends string = string> = RuleTests & {
+    match?: RuleMatch;
+    value: string;
+} & RuleSets<L, C>;
+/** An app's levels, categories, fields and rules, as the server takes them. */
+export interface SchemaSpec {
+    /** Each name with the range it ranks in, or with its settings. */
+    levels?: {
+        readonly [name: string]: Like | LevelSettings;
+    };
+    categories?: readonly string[] | {
+        readonly [name: string]: CategorySettings;
+    };
+    fields?: readonly string[] | {
+        readonly [name: string]: FieldSettings;
+    };
+    rules?: readonly SchemaRule[];
+}
+type NamesIn<T> = T extends readonly (infer N)[] ? N & string : T extends object ? keyof T & string : never;
+type LevelNames<S> = S extends {
+    levels?: infer L;
+} ? NamesIn<NonNullable<L>> : never;
+type CategoryNames<S> = S extends {
+    categories?: infer C;
+} ? NamesIn<NonNullable<C>> : never;
+type FieldNames<S> = S extends {
+    fields?: infer F;
+} ? NamesIn<NonNullable<F>> : never;
+/** A Sentry level or a level of the schema. */
+export type LevelOf<S> = string extends LevelNames<S> ? Level : SentryLevel | LevelNames<S>;
+/** A category of the schema. */
+export type CategoryOf<S> = CategoryNames<S>;
+/** A field of the schema. */
+export type FieldOf<S> = FieldNames<S>;
+type NameChar = "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "." | "-" | "_";
+/** True for 1 to Max of NameChar. A name only known as string passes. */
+type IsName<S extends string, Max extends number, Seen extends 0[] = []> = string extends S ? true : S extends `${infer C}${infer Rest}` ? C extends NameChar ? Seen["length"] extends Max ? false : IsName<Rest, Max, [...Seen, 0]> : false : Seen extends [] ? false : true;
+type LevelRule = "Level names are 1 to 32 lowercase letters, digits, dots, dashes or underscores";
+type CategoryRule = "Category names are 1 to 64 lowercase letters, digits, dots, dashes or underscores";
+type FieldRule = "Field names are not empty and do not start statoss.";
+type Only<V, Keys extends PropertyKey, Message extends string> = {
+    [P in Exclude<keyof V, Keys>]: {
+        [M in Message]: true;
+    };
+};
+type LevelCheck<V> = V extends string ? Like : {
+    like?: Like;
+    severity?: V extends {
+        like: infer K extends Like;
+    } ? Severities[K] : Severity;
+    label?: string | null;
+    color?: SchemaColor | null;
+} & Only<V, keyof LevelSettings, "A level takes like, severity, label and color">;
+/** Sentry's own levels rank as themselves: a label and a colour only. */
+type BuiltinLevelCheck<K extends SentryLevel, V> = V extends string ? K : {
+    like?: K;
+    label?: string | null;
+    color?: SchemaColor | null;
+} & Only<V, "like" | "label" | "color", "A built-in level takes label and color, and ranks as itself">;
+type CheckLevels<T> = {
+    [K in keyof T]: K extends SentryLevel ? BuiltinLevelCheck<K, T[K]> : K extends string ? IsName<K, 32> extends true ? LevelCheck<T[K]> : {
+        [M in LevelRule]: true;
+    } : never;
+};
+type CheckCategories<T> = T extends readonly unknown[] ? {
+    [I in keyof T]: T[I] extends string ? IsName<T[I], 64> extends true ? T[I] : {
+        [M in CategoryRule]: true;
+    } : string;
+} : {
+    [K in keyof T]: K extends string ? IsName<K, 64> extends true ? CategorySettings & Only<T[K], keyof CategorySettings, "A category takes label, color, hidden and owner"> : {
+        [M in CategoryRule]: true;
+    } : never;
+};
+type IsField<K extends string> = K extends "" | `statoss.${string}` ? false : true;
+type CheckFields<T> = T extends readonly unknown[] ? {
+    [I in keyof T]: T[I] extends string ? IsField<T[I]> extends true ? T[I] : {
+        [M in FieldRule]: true;
+    } : string;
+} : {
+    [K in keyof T]: K extends string ? IsField<K> extends true ? FieldSettings & Only<T[K], keyof FieldSettings, "A field takes label, type, unit and filterable"> : {
+        [M in FieldRule]: true;
+    } : never;
+};
+type CheckRules<T, L extends string, C extends string> = {
+    [I in keyof T]: SchemaRule<L, C> & Only<T[I], "subject" | "tagKey" | "match" | "value" | "level" | "category", "A rule takes subject, tagKey, match, value, level and category">;
+};
+/** What defineSchema holds a schema to, read from the schema itself. */
+export type CheckSchema<S> = {
+    [K in keyof S]: K extends "levels" ? CheckLevels<S[K]> : K extends "categories" ? CheckCategories<S[K]> : K extends "fields" ? CheckFields<S[K]> : K extends "rules" ? CheckRules<S[K], SentryLevel | LevelNames<S>, CategoryNames<S>> : {
+        "A schema takes levels, categories, fields and rules": true;
+    };
+};
+/**
+ * Declares an app's levels, categories, fields and rules. Returns the schema
+ * as given: plain data in the shape the server takes, so it can be sent as
+ * it is. Its names become types: pass it to init as `schema` and the capture
+ * functions init returns take only these names.
+ */
+export declare function defineSchema<const S extends SchemaSpec & CheckSchema<S>>(schema: S): S;
+/** A field's value; sent as a tag. */
+export type FieldValue = string | number | boolean;
+/** What the capture functions of init's handle take, typed by the schema. */
+export interface SchemaContext<S = SchemaSpec> extends Omit<CaptureContext, "level" | "category"> {
+    /** A Sentry level or a level of the schema. */
+    level?: LevelOf<S>;
+    /** A category of the schema, sent as the `statoss.category` tag. */
+    category?: CategoryOf<S>;
+    /**
+     * Fields of the schema, sent as tags; a schema that declares none takes
+     * none here.
+     */
+    fields?: [FieldOf<S>] extends [never] ? never : {
+        [K in FieldOf<S>]?: FieldValue;
+    };
+}
+/** The capture functions, typed by the schema given to init. */
+export interface Handle<S = SchemaSpec> {
+    /** Sends an error (or anything thrown). Returns the event id. */
+    captureException(error: unknown, context?: SchemaContext<S>): string;
+    /** Sends a message, with a level or a context. Returns the event id. */
+    captureMessage(message: string, levelOrContext?: LevelOf<S> | SchemaContext<S>): string;
+    /** Sends an event you built in Sentry's schema. Returns the event id. */
+    captureEvent(event: Event, context?: SchemaContext<S>): string;
+}
+/**
+ * The Sentry level each level of init's `schema` is sent as. Built-in
+ * levels are left out; names the SDK cannot send are logged in debug mode.
+ */
+export declare function readSchema(schema: unknown, logger: Logger): Record<string, SentryLevel>;
+export {};

package/dist/esm/schema.js

@@ -0,0 +1,114 @@
+import { CATEGORY_RULE, isCategoryName, isLevelName, isSentryLevel, LEVEL_RULE, } from "./levels.js";
+import { isObject, safeString } from "./utils.js";
+// The server's own lists (src/lib/app-schema.ts, src/lib/schema-colors.ts,
+// src/db/schema.ts), kept equal by a test.
+/** The ranges a level ranks in: Sentry's five and OpenTelemetry's trace. */
+export const LIKES = [
+    "fatal",
+    "error",
+    "warning",
+    "info",
+    "debug",
+    "trace",
+];
+/** The colours a level or a category takes, by name. */
+export const SCHEMA_COLORS = [
+    "crimson",
+    "red",
+    "orange",
+    "amber",
+    "yellow",
+    "green",
+    "aqua",
+    "teal",
+    "blue",
+    "violet",
+    "indigo",
+    "magenta",
+    "plum",
+    "grey",
+];
+/** What a rule tests: a tag by key, the logger, or one of the event's own fields. */
+export const RULE_SUBJECTS = [
+    "tag",
+    "logger",
+    "exception",
+    "culprit",
+    "title",
+    "message",
+];
+export const RULE_MATCHES = ["is", "starts", "contains"];
+export const FIELD_TYPES = ["text", "number"];
+/**
+ * Declares an app's levels, categories, fields and rules. Returns the schema
+ * as given: plain data in the shape the server takes, so it can be sent as
+ * it is. Its names become types: pass it to init as `schema` and the capture
+ * functions init returns take only these names.
+ */
+export function defineSchema(schema) {
+    return schema;
+}
+// At runtime
+/** The Sentry level a level of the schema is sent as. */
+function sentAs(name, value, logger) {
+    const settings = isObject(value) ? value : {};
+    const like = typeof value === "string" ? value : settings.like;
+    if (isSentryLevel(like))
+        return like;
+    if (like === "trace")
+        return "debug";
+    if (like !== undefined || (typeof value !== "string" && !isObject(value))) {
+        logger.warn(`Level "${name}" in the schema: like should be ${LIKES.join(", ")}; sent as error.`);
+        return "error";
+    }
+    const severity = settings.severity;
+    if (typeof severity !== "number" || severity < 1 || severity > 24)
+        return "error";
+    if (severity >= 21)
+        return "fatal";
+    if (severity >= 17)
+        return "error";
+    if (severity >= 13)
+        return "warning";
+    if (severity >= 9)
+        return "info";
+    return "debug";
+}
+/**
+ * The Sentry level each level of init's `schema` is sent as. Built-in
+ * levels are left out; names the SDK cannot send are logged in debug mode.
+ */
+export function readSchema(schema, logger) {
+    const out = {};
+    if (schema === undefined || schema === null)
+        return out;
+    if (!isObject(schema) || Array.isArray(schema)) {
+        logger.warn("Ignored `schema`: pass what defineSchema returns.");
+        return out;
+    }
+    const { levels, categories } = schema;
+    if (isObject(levels) && !Array.isArray(levels)) {
+        for (const [name, value] of Object.entries(levels)) {
+            // A built-in level, given a label or a colour.
+            if (isSentryLevel(name))
+                continue;
+            if (isLevelName(name))
+                out[name] = sentAs(name, value, logger);
+            else
+                logger.warn(`Ignored level "${name}" in the schema: ${LEVEL_RULE}.`);
+        }
+    }
+    else if (levels !== undefined && levels !== null) {
+        logger.warn('Ignored the schema\'s levels: they should be an object such as { "payment-failed": "error" }.');
+    }
+    const names = Array.isArray(categories)
+        ? categories
+        : isObject(categories)
+            ? Object.keys(categories)
+            : [];
+    for (const name of names) {
+        if (!isCategoryName(name))
+            logger.warn(`Category "${safeString(name)}" in the schema cannot be sent: ${CATEGORY_RULE}.`);
+    }
+    return out;
+}

package/dist/esm/types.d.ts

@@ -64,6 +64,13 @@ export interface SdkInfo {
         version: string;
     }[];
 }
+/** A file the event's frames ran in; type "sourcemap" names its debug id. */
+export interface DebugImage {
+    type: string;
+    code_file?: string;
+    debug_id?: string;
+    [key: string]: unknown;
+}
 /** An event in Sentry's schema, as the SDK sends it. */
 export interface Event {
     event_id?: string;
@@ -91,6 +98,9 @@ export interface Event {
     request?: RequestInfo;
     fingerprint?: string[];
     sdk?: SdkInfo;
+    debug_meta?: {
+        images?: DebugImage[];
+    };
     [key: string]: unknown;
 }
 /** What `captureException`, `captureMessage` and `captureEvent` take as context. */

package/dist/esm/version.d.ts

@@ -1,3 +1,3 @@
 export declare const SDK_NAME = "statoss.javascript";
-export declare const SDK_VERSION = "0.1.1";
+export declare const SDK_VERSION = "0.3.0";
 export declare const SDK_PACKAGE = "npm:@statoss/sdk";

package/dist/esm/version.js

@@ -1,4 +1,4 @@
 export const SDK_NAME = "statoss.javascript";
 // Kept equal to package.json by a test.
-export const SDK_VERSION = "0.1.1";
+export const SDK_VERSION = "0.3.0";
 export const SDK_PACKAGE = "npm:@statoss/sdk";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@statoss/sdk",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Error tracking for StatOSS: browsers, Node, Bun, Deno, Cloudflare Workers and Vercel Edge. Speaks Sentry's protocol.",
   "license": "MIT",
   "author": "StatOSS",