@toa.io/extensions.chronicles 0.0.0-stage → 1.0.0-alpha.332

package/transpiled/clickhouse/Client.d.ts

@@ -0,0 +1,38 @@
+/**
+ * ClickHouse over its HTTP interface, as one user: `fetch` and nothing else, because what the log
+ * needs of it is a statement and its answer.
+ */
+export declare class ClickHouse {
+    readonly database: string;
+    private readonly endpoint;
+    private readonly headers;
+    constructor(address: string, user: string, key: string);
+    /**
+     * A statement that answers nothing worth reading. `database` is the one it runs in, where that
+     * is not this client's: `''` for a statement that must run before the database exists.
+     */
+    run(sql: string, settings?: Record<string, string>, database?: string): Promise<void>;
+    /**
+     * A query, answered as `JSONCompact`: the columns, and the rows as arrays. The format is the
+     * default rather than a clause, which a statement like `EXPLAIN` would take as its own.
+     */
+    select(sql: string, settings?: Record<string, string>): Promise<Answer>;
+    /** Each row as an object, for what this extension reads of the database itself. */
+    rows<T = Record<string, unknown>>(sql: string): Promise<T[]>;
+    private request;
+}
+export interface Answer {
+    meta: Array<{
+        name: string;
+        type: string;
+    }>;
+    data: unknown[][];
+    rows: number;
+}
+/** What ClickHouse refused a statement with, as it said it. */
+export declare class ClickHouseError extends Error {
+    readonly status: number;
+    /** ClickHouse's own code, where its message carries one */
+    readonly code: number | undefined;
+    constructor(status: number, message: string);
+}

package/transpiled/clickhouse/Client.js

@@ -0,0 +1,73 @@
+/**
+ * ClickHouse over its HTTP interface, as one user: `fetch` and nothing else, because what the log
+ * needs of it is a statement and its answer.
+ */
+export class ClickHouse {
+    database;
+    endpoint;
+    headers;
+    constructor(address, user, key) {
+        const url = new URL(address);
+        this.database = decodeURIComponent(url.pathname.replace(/^\/+|\/+$/g, ''));
+        this.endpoint = `${url.protocol}//${url.host}/`;
+        this.headers = { 'x-clickhouse-user': user, 'x-clickhouse-key': key };
+    }
+    /**
+     * A statement that answers nothing worth reading. `database` is the one it runs in, where that
+     * is not this client's: `''` for a statement that must run before the database exists.
+     */
+    async run(sql, settings = {}, database = this.database) {
+        await this.request(sql, settings, database);
+    }
+    /**
+     * A query, answered as `JSONCompact`: the columns, and the rows as arrays. The format is the
+     * default rather than a clause, which a statement like `EXPLAIN` would take as its own.
+     */
+    async select(sql, settings = {}) {
+        const text = await this.request(sql, { ...settings, default_format: 'JSONCompact' });
+        return parse(text);
+    }
+    /** Each row as an object, for what this extension reads of the database itself. */
+    async rows(sql) {
+        const text = await this.request(sql, { ...NUMBERS, default_format: 'JSON' });
+        return parse(text).data;
+    }
+    async request(sql, settings, database = this.database) {
+        const search = new URLSearchParams(settings);
+        if (database !== '')
+            search.set('database', database);
+        const response = await fetch(`${this.endpoint}?${search.toString()}`, {
+            method: 'POST',
+            headers: this.headers,
+            body: sql
+        });
+        const text = await response.text();
+        if (!response.ok)
+            throw new ClickHouseError(response.status, text.trim());
+        return text;
+    }
+}
+/** What ClickHouse refused a statement with, as it said it. */
+export class ClickHouseError extends Error {
+    status;
+    /** ClickHouse's own code, where its message carries one */
+    code;
+    constructor(status, message) {
+        super(message);
+        this.status = status;
+        const code = /^Code: (\d+)\./.exec(message)?.[1];
+        this.code = code === undefined ? undefined : Number(code);
+    }
+}
+/** An answer in another format is one the statement asked for itself, with a `FORMAT`. */
+function parse(text) {
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        throw new ClickHouseError(200, 'The answer is not JSON: a statement leaves `FORMAT` out');
+    }
+}
+/** UInt64 as numbers rather than strings: what this extension reads of them is counts. */
+const NUMBERS = { output_format_json_quote_64bit_integers: '0' };
+//# sourceMappingURL=Client.js.map

package/transpiled/clickhouse/Client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Client.js","sourceRoot":"","sources":["../../source/clickhouse/Client.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,OAAO,UAAU;IACL,QAAQ,CAAQ;IAEf,QAAQ,CAAQ;IAChB,OAAO,CAAwB;IAEhD,YAAmB,OAAe,EAAE,IAAY,EAAE,GAAW;QAC3D,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAA;QAE5B,IAAI,CAAC,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,CAAA;QAC1E,IAAI,CAAC,QAAQ,GAAG,GAAG,GAAG,CAAC,QAAQ,KAAK,GAAG,CAAC,IAAI,GAAG,CAAA;QAC/C,IAAI,CAAC,OAAO,GAAG,EAAE,mBAAmB,EAAE,IAAI,EAAE,kBAAkB,EAAE,GAAG,EAAE,CAAA;IACvE,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,GAAG,CACd,GAAW,EACX,QAAQ,GAA2B,EAAE,EACrC,QAAQ,GAAG,IAAI,CAAC,QAAQ;QAExB,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAA;IAC7C,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CACjB,GAAW,EACX,QAAQ,GAA2B,EAAE;QAErC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,CAAC,CAAA;QAEpF,OAAO,KAAK,CAAC,IAAI,CAAW,CAAA;IAC9B,CAAC;IAED,mFAAmF;IAC5E,KAAK,CAAC,IAAI,CAA8B,GAAW;QACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,CAAC,CAAA;QAE5E,OAAQ,KAAK,CAAC,IAAI,CAAmB,CAAC,IAAI,CAAA;IAC5C,CAAC;IAEO,KAAK,CAAC,OAAO,CACnB,GAAW,EACX,QAAgC,EAChC,QAAQ,GAAG,IAAI,CAAC,QAAQ;QAExB,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,QAAQ,CAAC,CAAA;QAE5C,IAAI,QAAQ,KAAK,EAAE;YAAE,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;QAErD,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EAAE;YACpE,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,IAAI,EAAE,GAAG;SACV,CAAC,CAAA;QAEF,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAA;QAElC,IAAI,CAAC,QAAQ,CAAC,EAAE;YAAE,MAAM,IAAI,eAAe,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAA;QAEzE,OAAO,IAAI,CAAA;IACb,CAAC;CACF;AAQD,+DAA+D;AAC/D,MAAM,OAAO,eAAgB,SAAQ,KAAK;IACxB,MAAM,CAAQ;IAE9B,2DAA2D;IAC3C,IAAI,CAAoB;IAExC,YAAmB,MAAc,EAAE,OAAe;QAChD,KAAK,CAAC,OAAO,CAAC,CAAA;QAEd,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QAEpB,MAAM,IAAI,GAAG,gBAAgB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QAEhD,IAAI,CAAC,IAAI,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;IAC3D,CAAC;CACF;AAED,0FAA0F;AAC1F,SAAS,KAAK,CAAC,IAAY;IACzB,IAAI,CAAC;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;IACzB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,eAAe,CACvB,GAAG,EACH,yDAAyD,CAC1D,CAAA;IACH,CAAC;AACH,CAAC;AAED,0FAA0F;AAC1F,MAAM,OAAO,GAAG,EAAE,uCAAuC,EAAE,GAAG,EAAE,CAAA"}

package/transpiled/clickhouse/Provider.d.ts

@@ -0,0 +1,33 @@
+import type { Label, Provider, Result, Row, State, Summary, View } from '../Provider.ts';
+import type { Credentials } from '../settings.ts';
+/**
+ * The log in ClickHouse: `events`, replaced by `id`, and `states`, by the `version` of an entity, both
+ * read with `FINAL`. Queries run as `<database>_reader`, which provisioning creates with limits it
+ * cannot lift; views are made by the writer from what the reader was let plan.
+ */
+export declare class ClickHouseProvider implements Provider {
+    readonly dialect = "ClickHouse SQL; read `events` and `states` with FINAL";
+    readonly tables: string[];
+    private readonly writer;
+    private readonly reader;
+    private readonly password;
+    private readonly retention;
+    constructor(url: string, credentials: Credentials, retention?: number);
+    provision(): Promise<void>;
+    write(rows: Row[], states: State[]): Promise<void>;
+    states(): Promise<Summary[]>;
+    labels(): Promise<Label[]>;
+    /**
+     * One row more than is answered, cut by the `limit` setting — the result's own, outside whatever
+     * the statement says — so a result of the limit exactly reads as whole, and one past it as cut.
+     */
+    query(sql: string): Promise<Result>;
+    validate(sql: string): Promise<void>;
+    views(): Promise<View[]>;
+    define(name: string, sql: string, refresh?: number): Promise<void>;
+    drop(name: string): Promise<void>;
+    private insert;
+    /** In order, each awaited: a view is made after the table it reads. */
+    private run;
+    private engine;
+}

package/transpiled/clickhouse/Provider.js

@@ -0,0 +1,144 @@
+import { console } from 'openspan';
+import { ClickHouse, ClickHouseError } from './Client.js';
+import * as ddl from './ddl.js';
+import { Refusal } from '../Provider.js';
+/**
+ * The log in ClickHouse: `events`, replaced by `id`, and `states`, by the `version` of an entity, both
+ * read with `FINAL`. Queries run as `<database>_reader`, which provisioning creates with limits it
+ * cannot lift; views are made by the writer from what the reader was let plan.
+ */
+export class ClickHouseProvider {
+    dialect = 'ClickHouse SQL; read `events` and `states` with FINAL';
+    tables = ddl.TABLES;
+    writer;
+    reader;
+    password;
+    retention;
+    constructor(url, credentials, retention) {
+        this.writer = new ClickHouse(url, credentials.username, credentials.password);
+        this.reader = new ClickHouse(url, `${this.writer.database}_reader`, credentials.reader);
+        this.password = credentials.reader;
+        this.retention = retention;
+    }
+    async provision() {
+        const { database } = this.writer;
+        for (const statement of ddl.database(database))
+            await this.writer.run(statement, {}, '');
+        await this.run(ddl.tables(this.retention));
+        await this.run(ddl.retention(this.retention, await this.engine()));
+        await this.run(ddl.reader(database, this.password));
+        console.info('Chronicles provisioned', { database });
+    }
+    async write(rows, states) {
+        if (rows.length > 0)
+            await this.insert('events', EVENTS, rows);
+        if (states.length > 0)
+            await this.insert('states', STATES, states);
+    }
+    async states() {
+        return await this.writer.rows(`SELECT component, uniqExact(entity) AS entities,
+        arraySort(groupUniqArrayArray(JSONAllPaths(payload))) AS paths
+      FROM states GROUP BY component ORDER BY component`);
+    }
+    async labels() {
+        const labels = await this.writer.rows(`SELECT label, count() AS rows, toString(min(time)) AS first, toString(max(time)) AS last
+      FROM events GROUP BY label ORDER BY label`);
+        // the fields of the latest payloads of each label, which is what a query is written against
+        const paths = await this.writer.rows(`SELECT label, arraySort(groupUniqArrayArray(JSONAllPaths(payload))) AS paths
+      FROM (SELECT label, payload FROM events ORDER BY time DESC LIMIT ${SAMPLE} BY label)
+      GROUP BY label`);
+        const byLabel = new Map(paths.map(({ label, paths }) => [label, paths]));
+        return labels.map((label) => ({ ...label, paths: byLabel.get(label.label) ?? [] }));
+    }
+    /**
+     * One row more than is answered, cut by the `limit` setting — the result's own, outside whatever
+     * the statement says — so a result of the limit exactly reads as whole, and one past it as cut.
+     */
+    async query(sql) {
+        const settings = { ...NUMBERS, limit: String(ddl.LIMITS.rows + 1) };
+        const answer = await refusing(async () => await this.reader.select(sql, settings));
+        return {
+            columns: answer.meta,
+            rows: answer.data.slice(0, ddl.LIMITS.rows),
+            truncated: answer.data.length > ddl.LIMITS.rows
+        };
+    }
+    // parsed and planned as the reader, which is what refuses a view that reads what a query
+    // could not
+    async validate(sql) {
+        await refusing(async () => {
+            const [ast] = await this.reader.rows(`EXPLAIN AST ${sql}`);
+            if (!ast.explain.startsWith('SelectWithUnionQuery'))
+                throw new Refusal('A view is one SELECT');
+            await this.reader.run(`EXPLAIN PLAN ${sql}`);
+        });
+    }
+    async views() {
+        const tables = await this.writer.rows(`SELECT name, as_select, create_table_query FROM system.tables
+      WHERE database = currentDatabase()
+        AND name NOT IN (${this.tables.map(ddl.literal).join(', ')})
+        AND NOT startsWith(name, '.inner')
+      ORDER BY name`);
+        return tables.map((table) => {
+            const view = { name: table.name, sql: table.as_select };
+            // stated in seconds, and kept in the largest unit that divides them
+            const every = /REFRESH EVERY (\d+) (SECOND|MINUTE|HOUR|DAY|WEEK)/.exec(table.create_table_query);
+            if (every !== null)
+                view.refresh = Number(every[1]) * UNITS[every[2]];
+            return view;
+        });
+    }
+    async define(name, sql, refresh) {
+        await this.writer.run(`DROP TABLE IF EXISTS ${ddl.id(name)} SYNC`);
+        await refusing(async () => {
+            if (refresh === undefined)
+                await this.writer.run(`CREATE VIEW ${ddl.id(name)} SQL SECURITY INVOKER AS ${sql}`);
+            else
+                await this.writer.run(`CREATE MATERIALIZED VIEW ${ddl.id(name)} REFRESH EVERY ${refresh} SECOND
+          ENGINE = MergeTree ORDER BY tuple() AS ${sql}`);
+        });
+    }
+    async drop(name) {
+        await this.writer.run(`DROP TABLE IF EXISTS ${ddl.id(name)} SYNC`);
+    }
+    async insert(table, columns, rows) {
+        const lines = rows.map((row) => JSON.stringify({ ...row, time: timestamp(row.time) }));
+        await this.writer.run(`INSERT INTO ${table} (${columns}) FORMAT JSONEachRow\n${lines.join('\n')}`);
+    }
+    /** In order, each awaited: a view is made after the table it reads. */
+    async run(statements) {
+        for (const statement of statements)
+            await this.writer.run(statement);
+    }
+    async engine() {
+        const [table] = await this.writer.rows("SELECT engine_full FROM system.tables WHERE database = currentDatabase() AND name = 'events'");
+        return table?.engine_full ?? '';
+    }
+}
+/** What ClickHouse refused is the provider's refusal, in ClickHouse's words. */
+async function refusing(fn) {
+    try {
+        return await fn();
+    }
+    catch (exception) {
+        if (exception instanceof ClickHouseError)
+            throw new Refusal(exception.message);
+        throw exception;
+    }
+}
+/** A `DateTime64(3)` as ClickHouse reads one without guessing: UTC, to the millisecond. */
+function timestamp(ms) {
+    return new Date(ms).toISOString().replace('T', ' ').replace('Z', '');
+}
+const EVENTS = 'id, label, component, time, entity, version, identity, ip, country, trace, payload';
+const STATES = 'component, entity, version, identity, time, payload';
+const UNITS = {
+    SECOND: 1,
+    MINUTE: 60,
+    HOUR: 3600,
+    DAY: 86400,
+    WEEK: 604800
+};
+const SAMPLE = 1000;
+const NUMBERS = { output_format_json_quote_64bit_integers: '0' };
+//# sourceMappingURL=Provider.js.map

package/transpiled/clickhouse/Provider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Provider.js","sourceRoot":"","sources":["../../source/clickhouse/Provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA;AAClC,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAA;AACzD,OAAO,KAAK,GAAG,MAAM,UAAU,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAIxC;;;;GAIG;AACH,MAAM,OAAO,kBAAkB;IACb,OAAO,GAAG,uDAAuD,CAAA;IACjE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAA;IAElB,MAAM,CAAY;IAClB,MAAM,CAAY;IAClB,QAAQ,CAAQ;IAChB,SAAS,CAAoB;IAE9C,YAAmB,GAAW,EAAE,WAAwB,EAAE,SAAkB;QAC1E,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAC,GAAG,EAAE,WAAW,CAAC,QAAQ,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAA;QAC7E,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAC1B,GAAG,EACH,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,SAAS,EAChC,WAAW,CAAC,MAAM,CACnB,CAAA;QACD,IAAI,CAAC,QAAQ,GAAG,WAAW,CAAC,MAAM,CAAA;QAClC,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;IAC5B,CAAC;IAEM,KAAK,CAAC,SAAS;QACpB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,MAAM,CAAA;QAEhC,KAAK,MAAM,SAAS,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC;YAC5C,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;QAE1C,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QAC1C,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;QAClE,MAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;QAEnD,OAAO,CAAC,IAAI,CAAC,wBAAwB,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAA;IACtD,CAAC;IAEM,KAAK,CAAC,KAAK,CAAC,IAAW,EAAE,MAAe;QAC7C,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,CAAC,CAAA;QAC9D,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;IACpE,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAC3B;;wDAEkD,CACnD,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,MAAM;QACjB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACnC;gDAC0C,CAC3C,CAAA;QAED,4FAA4F;QAC5F,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAClC;yEACmE,MAAM;qBAC1D,CAChB,CAAA;QAED,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;QAExE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,EAAE,KAAK,EAAE,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAA;IACrF,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,KAAK,CAAC,GAAW;QAC5B,MAAM,QAAQ,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,EAAE,CAAA;QACnE,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAA;QAElF,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,IAAI;YACpB,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YAC3C,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,IAAI;SAChD,CAAA;IACH,CAAC;IAED,yFAAyF;IACzF,YAAY;IACL,KAAK,CAAC,QAAQ,CAAC,GAAW;QAC/B,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE;YACxB,MAAM,CAAC,GAAG,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAsB,eAAe,GAAG,EAAE,CAAC,CAAA;YAE/E,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,sBAAsB,CAAC;gBACjD,MAAM,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAA;YAE3C,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,GAAG,EAAE,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK;QAChB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACnC;;2BAEqB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC;;oBAE9C,CACf,CAAA;QAED,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,MAAM,IAAI,GAAS,EAAE,IAAI,EAAE,KAAK,CAAC,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,SAAS,EAAE,CAAA;YAE7D,oEAAoE;YACpE,MAAM,KAAK,GAAG,mDAAmD,CAAC,IAAI,CACpE,KAAK,CAAC,kBAAkB,CACzB,CAAA;YAED,IAAI,KAAK,KAAK,IAAI;gBAAE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAErE,OAAO,IAAI,CAAA;QACb,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,IAAY,EAAE,GAAW,EAAE,OAAgB;QAC7D,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAElE,MAAM,QAAQ,CAAC,KAAK,IAAI,EAAE;YACxB,IAAI,OAAO,KAAK,SAAS;gBACvB,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACnB,eAAe,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,4BAA4B,GAAG,EAAE,CAC7D,CAAA;;gBAED,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACnB,4BAA4B,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,kBAAkB,OAAO;mDACxB,GAAG,EAAE,CAC/C,CAAA;QACL,CAAC,CAAC,CAAA;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,IAAY;QAC5B,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IACpE,CAAC;IAEO,KAAK,CAAC,MAAM,CAClB,KAAa,EACb,OAAe,EACf,IAAwB;QAExB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,GAAG,GAAG,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAA;QAEtF,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CACnB,eAAe,KAAK,KAAK,OAAO,yBAAyB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAC5E,CAAA;IACH,CAAC;IAED,uEAAuE;IAC/D,KAAK,CAAC,GAAG,CAAC,UAAoB;QACpC,KAAK,MAAM,SAAS,IAAI,UAAU;YAAE,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;IACtE,CAAC;IAEO,KAAK,CAAC,MAAM;QAClB,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CACpC,8FAA8F,CAC/F,CAAA;QAED,OAAO,KAAK,EAAE,WAAW,IAAI,EAAE,CAAA;IACjC,CAAC;CACF;AAED,gFAAgF;AAChF,KAAK,UAAU,QAAQ,CAAI,EAAoB;IAC7C,IAAI,CAAC;QACH,OAAO,MAAM,EAAE,EAAE,CAAA;IACnB,CAAC;IAAC,OAAO,SAAS,EAAE,CAAC;QACnB,IAAI,SAAS,YAAY,eAAe;YAAE,MAAM,IAAI,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;QAE9E,MAAM,SAAS,CAAA;IACjB,CAAC;AACH,CAAC;AAED,2FAA2F;AAC3F,SAAS,SAAS,CAAC,EAAU;IAC3B,OAAO,IAAI,IAAI,CAAC,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;AACtE,CAAC;AAQD,MAAM,MAAM,GACV,oFAAoF,CAAA;AACtF,MAAM,MAAM,GAAG,qDAAqD,CAAA;AAEpE,MAAM,KAAK,GAA2B;IACpC,MAAM,EAAE,CAAC;IACT,MAAM,EAAE,EAAE;IACV,IAAI,EAAE,IAAI;IACV,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;CACb,CAAA;AAED,MAAM,MAAM,GAAG,IAAI,CAAA;AACnB,MAAM,OAAO,GAAG,EAAE,uCAAuC,EAAE,GAAG,EAAE,CAAA"}

package/transpiled/clickhouse/ddl.d.ts

@@ -0,0 +1,26 @@
+/**
+ * The log in ClickHouse. Every statement is one a second start changes nothing with, so two
+ * replicas starting together collide on nothing; the retention, which would change, is compared
+ * with what is there and changed only where it differs.
+ */
+export declare const TABLES: string[];
+export declare function database(name: string): string[];
+/** What is kept: a row for everything that happened, and each entity as it stands. */
+export declare function tables(retention: number | undefined): string[];
+/** `ALTER TABLE` for the retention declared, given what the table states now; none if it agrees. */
+export declare function retention(declared: number | undefined, engine: string): string[];
+/**
+ * The user queries run as: it reads the database and nothing else, under limits a query cannot
+ * lift, because they are constraints of its profile rather than settings a request passes. Past
+ * the rows a query is refused, which is the overflow a client's query cache allows; a query of
+ * the provider's own asks for one row more than it answers, to tell a full answer from a cut one.
+ */
+export declare function reader(database: string, password: string): string[];
+export declare const LIMITS: {
+    seconds: number;
+    rows: number;
+    memory: number;
+};
+/** An identifier, which the annotation and the schema have already held to this. */
+export declare function id(name: string): string;
+export declare function literal(value: string): string;

package/transpiled/clickhouse/ddl.js

@@ -0,0 +1,88 @@
+/**
+ * The log in ClickHouse. Every statement is one a second start changes nothing with, so two
+ * replicas starting together collide on nothing; the retention, which would change, is compared
+ * with what is there and changed only where it differs.
+ */
+export const TABLES = ['events', 'states'];
+export function database(name) {
+    return [`CREATE DATABASE IF NOT EXISTS ${id(name)}`];
+}
+/** What is kept: a row for everything that happened, and each entity as it stands. */
+export function tables(retention) {
+    return [
+        `CREATE TABLE IF NOT EXISTS events (
+      id String,
+      label LowCardinality(String),
+      component LowCardinality(String),
+      time DateTime64(3, 'UTC'),
+      received DateTime64(3, 'UTC') DEFAULT now64(3),
+      entity Nullable(String),
+      version Nullable(UInt64),
+      identity Nullable(String),
+      ip Nullable(String),
+      country LowCardinality(Nullable(String)),
+      trace Nullable(String),
+      payload JSON
+    ) ENGINE = ReplacingMergeTree
+    PARTITION BY toYYYYMM(time)
+    ORDER BY (label, toDate(time), id)
+    ${retention === undefined ? '' : ttl(retention)}`,
+        `CREATE TABLE IF NOT EXISTS states (
+      component LowCardinality(String),
+      entity String,
+      version UInt64,
+      identity Nullable(String),
+      time DateTime64(3, 'UTC'),
+      received DateTime64(3, 'UTC') DEFAULT now64(3),
+      payload JSON
+    ) ENGINE = ReplacingMergeTree(version)
+    ORDER BY (component, entity)`
+    ];
+}
+/** `ALTER TABLE` for the retention declared, given what the table states now; none if it agrees. */
+export function retention(declared, engine) {
+    const stated = /TTL toDateTime\(time\) \+ toIntervalDay\((\d+)\)/.exec(engine)?.[1];
+    if (declared === undefined)
+        return stated === undefined && !engine.includes(' TTL ')
+            ? []
+            : ['ALTER TABLE events REMOVE TTL'];
+    if (stated === String(declared))
+        return [];
+    return [`ALTER TABLE events MODIFY ${ttl(declared)}`];
+}
+/**
+ * The user queries run as: it reads the database and nothing else, under limits a query cannot
+ * lift, because they are constraints of its profile rather than settings a request passes. Past
+ * the rows a query is refused, which is the overflow a client's query cache allows; a query of
+ * the provider's own asks for one row more than it answers, to tell a full answer from a cut one.
+ */
+export function reader(database, password) {
+    const name = id(`${database}_reader`);
+    return [
+        `CREATE SETTINGS PROFILE IF NOT EXISTS ${name}`,
+        `ALTER SETTINGS PROFILE ${name} SETTINGS
+      readonly = 2 CONST,
+      max_execution_time = ${LIMITS.seconds} CONST,
+      max_result_rows = ${LIMITS.rows + 1} CONST,
+      max_memory_usage = ${LIMITS.memory} CONST`,
+        `CREATE USER IF NOT EXISTS ${name} IDENTIFIED WITH sha256_password BY ${literal(password)}`,
+        `ALTER USER ${name} IDENTIFIED WITH sha256_password BY ${literal(password)}
+      SETTINGS PROFILE ${literal(`${database}_reader`)}`,
+        `GRANT SELECT ON ${id(database)}.* TO ${name}`
+    ];
+}
+export const LIMITS = { seconds: 30, rows: 10_000, memory: 4_000_000_000 };
+/** An identifier, which the annotation and the schema have already held to this. */
+export function id(name) {
+    if (!IDENTIFIER.test(name))
+        throw new Error(`'${name}' is not a ClickHouse identifier chronicles accept`);
+    return '`' + name + '`';
+}
+export function literal(value) {
+    return "'" + value.replace(/\\/g, '\\\\').replace(/'/g, "\\'") + "'";
+}
+function ttl(days) {
+    return `TTL toDateTime(time) + INTERVAL ${days} DAY`;
+}
+const IDENTIFIER = /^[a-zA-Z_][a-zA-Z0-9_]*$/;
+//# sourceMappingURL=ddl.js.map

package/transpiled/clickhouse/ddl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ddl.js","sourceRoot":"","sources":["../../source/clickhouse/ddl.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAA;AAE1C,MAAM,UAAU,QAAQ,CAAC,IAAY;IACnC,OAAO,CAAC,iCAAiC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;AACtD,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,MAAM,CAAC,SAA6B;IAClD,OAAO;QACL;;;;;;;;;;;;;;;;MAgBE,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;QAEjD;;;;;;;;;iCAS6B;KAC9B,CAAA;AACH,CAAC;AAED,oGAAoG;AACpG,MAAM,UAAU,SAAS,CAAC,QAA4B,EAAE,MAAc;IACpE,MAAM,MAAM,GAAG,kDAAkD,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnF,IAAI,QAAQ,KAAK,SAAS;QACxB,OAAO,MAAM,KAAK,SAAS,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC;YACtD,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,CAAC,+BAA+B,CAAC,CAAA;IAEvC,IAAI,MAAM,KAAK,MAAM,CAAC,QAAQ,CAAC;QAAE,OAAO,EAAE,CAAA;IAE1C,OAAO,CAAC,6BAA6B,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;AACvD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,QAAgB,EAAE,QAAgB;IACvD,MAAM,IAAI,GAAG,EAAE,CAAC,GAAG,QAAQ,SAAS,CAAC,CAAA;IAErC,OAAO;QACL,yCAAyC,IAAI,EAAE;QAC/C,0BAA0B,IAAI;;6BAEL,MAAM,CAAC,OAAO;0BACjB,MAAM,CAAC,IAAI,GAAG,CAAC;2BACd,MAAM,CAAC,MAAM,QAAQ;QAC5C,6BAA6B,IAAI,uCAAuC,OAAO,CAAC,QAAQ,CAAC,EAAE;QAC3F,cAAc,IAAI,uCAAuC,OAAO,CAAC,QAAQ,CAAC;yBACrD,OAAO,CAAC,GAAG,QAAQ,SAAS,CAAC,EAAE;QACpD,mBAAmB,EAAE,CAAC,QAAQ,CAAC,SAAS,IAAI,EAAE;KAC/C,CAAA;AACH,CAAC;AAED,MAAM,CAAC,MAAM,MAAM,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,EAAE,CAAA;AAE1E,oFAAoF;AACpF,MAAM,UAAU,EAAE,CAAC,IAAY;IAC7B,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;QACxB,MAAM,IAAI,KAAK,CAAC,IAAI,IAAI,oDAAoD,CAAC,CAAA;IAE/E,OAAO,GAAG,GAAG,IAAI,GAAG,GAAG,CAAA;AACzB,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,KAAa;IACnC,OAAO,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,GAAG,GAAG,CAAA;AACtE,CAAC;AAED,SAAS,GAAG,CAAC,IAAY;IACvB,OAAO,mCAAmC,IAAI,MAAM,CAAA;AACtD,CAAC;AAED,MAAM,UAAU,GAAG,0BAA0B,CAAA"}

package/transpiled/index.d.ts

@@ -0,0 +1,9 @@
+export { Factory } from './Factory.ts';
+/** `context.chronicles` of a component that declares `chronicles`. */
+export interface Chronicles {
+    /**
+     * Writes a fact that changes no state to the log, under `<component>.<name>`. Resolves once the
+     * broker has it; nothing retries it.
+     */
+    send(name: string, payload?: object): Promise<void>;
+}

package/transpiled/index.js

@@ -0,0 +1,2 @@
+export { Factory } from './Factory.js';
+//# sourceMappingURL=index.js.map

package/transpiled/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAA"}

package/transpiled/settings.d.ts

@@ -0,0 +1,11 @@
+import type { Settings } from '@toa.io/definitions/extensions.chronicles';
+/** Where the log is kept and what it is kept of, as the service is deployed with them. */
+export declare function settings(): Settings;
+/** The user the store is provisioned as, and the password of the reader it creates. */
+export declare function credentials(): Credentials;
+export interface Credentials {
+    username: string;
+    password: string;
+    /** the password of the reader */
+    reader: string;
+}

package/transpiled/settings.js

@@ -0,0 +1,35 @@
+import { environment } from '@toa.io/generic';
+import { SETTINGS } from '@toa.io/definitions/extensions.chronicles';
+/** Where the log is kept and what it is kept of, as the service is deployed with them. */
+export function settings() {
+    const value = environment.get(SETTINGS);
+    if (value !== undefined)
+        return JSON.parse(value);
+    if (dev())
+        return DEV;
+    throw new Error(`${SETTINGS} is not set, so nothing says where the log is kept.`);
+}
+/** The user the store is provisioned as, and the password of the reader it creates. */
+export function credentials() {
+    const [username, password, reader] = KEYS.map((key) => environment.get(`${SETTINGS}_STORE_${key}`));
+    if (username !== undefined && password !== undefined && reader !== undefined)
+        return { username, password, reader };
+    if (dev())
+        return { username: 'developer', password: 'secret', reader: 'secret' };
+    throw new Error(`${SETTINGS}_STORE_{USERNAME,PASSWORD,READER} are not all set.`);
+}
+function dev() {
+    return environment.get('TOA_DEV') === '1';
+}
+const KEYS = ['USERNAME', 'PASSWORD', 'READER'];
+// Toa's own development stack is not on the conventional ports, which the applications built on
+// Toa are on. See CONTRIBUTING.md.
+const DEV = {
+    store: { provider: 'clickhouse', url: 'http://localhost:31030/chronicles' },
+    ingest: true,
+    ip: 'truncated',
+    events: [],
+    states: [],
+    identities: {}
+};
+//# sourceMappingURL=settings.js.map

package/transpiled/settings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"settings.js","sourceRoot":"","sources":["../source/settings.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAA;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,2CAA2C,CAAA;AAGpE,0FAA0F;AAC1F,MAAM,UAAU,QAAQ;IACtB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAEvC,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAa,CAAA;IAE7D,IAAI,GAAG,EAAE;QAAE,OAAO,GAAG,CAAA;IAErB,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,qDAAqD,CAAC,CAAA;AACnF,CAAC;AAED,uFAAuF;AACvF,MAAM,UAAU,WAAW;IACzB,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CACpD,WAAW,CAAC,GAAG,CAAC,GAAG,QAAQ,UAAU,GAAG,EAAE,CAAC,CAC5C,CAAA;IAED,IAAI,QAAQ,KAAK,SAAS,IAAI,QAAQ,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS;QAC1E,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;IAEvC,IAAI,GAAG,EAAE;QAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;IAEjF,MAAM,IAAI,KAAK,CAAC,GAAG,QAAQ,oDAAoD,CAAC,CAAA;AAClF,CAAC;AAUD,SAAS,GAAG;IACV,OAAO,WAAW,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,GAAG,CAAA;AAC3C,CAAC;AAED,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,UAAU,EAAE,QAAQ,CAAC,CAAA;AAE/C,gGAAgG;AAChG,mCAAmC;AACnC,MAAM,GAAG,GAAa;IACpB,KAAK,EAAE,EAAE,QAAQ,EAAE,YAAY,EAAE,GAAG,EAAE,mCAAmC,EAAE;IAC3E,MAAM,EAAE,IAAI;IACZ,EAAE,EAAE,WAAW;IACf,MAAM,EAAE,EAAE;IACV,MAAM,EAAE,EAAE;IACV,UAAU,EAAE,EAAE;CACf,CAAA"}

package/transpiled/store.d.ts

@@ -0,0 +1,5 @@
+import type { Provider } from './Provider.ts';
+import type { Credentials } from './settings.ts';
+import type { Settings } from '@toa.io/definitions/extensions.chronicles';
+/** The provider the annotation names. */
+export declare function provider(settings: Settings, credentials: Credentials): Provider;

package/transpiled/store.js

@@ -0,0 +1,11 @@
+import { ClickHouseProvider } from './clickhouse/Provider.js';
+/** The provider the annotation names. */
+export function provider(settings, credentials) {
+    switch (settings.store.provider) {
+        case 'clickhouse':
+            return new ClickHouseProvider(settings.store.url, credentials, settings.retention);
+        default:
+            throw new Error(`Chronicles have no store '${String(settings.store.provider)}'`);
+    }
+}
+//# sourceMappingURL=store.js.map

package/transpiled/store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"store.js","sourceRoot":"","sources":["../source/store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAA;AAK7D,yCAAyC;AACzC,MAAM,UAAU,QAAQ,CAAC,QAAkB,EAAE,WAAwB;IACnE,QAAQ,QAAQ,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC;QAChC,KAAK,YAAY;YACf,OAAO,IAAI,kBAAkB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,EAAE,WAAW,EAAE,QAAQ,CAAC,SAAS,CAAC,CAAA;QACpF;YACE,MAAM,IAAI,KAAK,CAAC,6BAA6B,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;IACpF,CAAC;AACH,CAAC"}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.