@marinoscar/platform-api 0.0.0-stage → 0.1.0-next.10

package/dist/telemetry/ports.d.ts

@@ -0,0 +1,575 @@
+import type { Logger } from '@nestjs/common';
+import type { TelemetrySettings } from '@marinoscar/platform-contract/telemetry';
+import type { z } from 'zod';
+/**
+ * Injection token of the app's {@link TelemetryAuditSink}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_AUDIT_SINK: unique symbol;
+/**
+ * One telemetry audit event. `meta` never carries secret material: SQL text,
+ * field names, counts and request parameters only.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAuditEvent {
+    /** Who did it; `null` for the system itself. */
+    actorUserId: string | null;
+    /** What happened (`telemetry:query`, `telemetry:config_update`, ...). */
+    action: string;
+    /** The kind of thing it happened to (`telemetry_store`, `telemetry_config`, `job`, ...). */
+    targetType: string;
+    /** Which one. */
+    targetId: string;
+    /** JSON-serialisable facts about the event. Never secret material. */
+    meta?: Record<string, unknown>;
+}
+/**
+ * Where telemetry records its audit events. The reference app writes them to
+ * `audit_events`, with the same columns as before the move.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAuditSink {
+    /**
+     * Persists one audit event. Called after the triggering write committed.
+     *
+     * @param event - the event; its `meta` is stored as JSON.
+     */
+    record(event: TelemetryAuditEvent): Promise<void>;
+}
+/**
+ * Injection token of the app's {@link TelemetrySettingsStore}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_SETTINGS_STORE: unique symbol;
+/**
+ * Who saved a settings row last, and when.
+ *
+ * @stability experimental
+ */
+export interface TelemetrySettingsProvenance {
+    /** The row version, for `If-Match` optimistic concurrency. */
+    version: number;
+    /** When the row was last written. */
+    updatedAt: Date;
+    /** Who wrote it last, or `null` (seeded, or the user was deleted). */
+    updatedBy: {
+        /** The user's id. */
+        id: string;
+        /** The user's email. */
+        email: string;
+    } | null;
+}
+/**
+ * One keyed system-settings row telemetry owns (`telemetry_connection`): its
+ * raw stored value plus its provenance.
+ *
+ * @stability experimental
+ */
+export interface TelemetrySettingsRow extends TelemetrySettingsProvenance {
+    /** The stored JSON, unvalidated; telemetry validates it itself. */
+    value: unknown;
+}
+/**
+ * The platform features `get_app_context` reports to the assistant, as
+ * booleans. An explicit allowlist: the settings are never serialised wholesale.
+ *
+ * @stability experimental
+ */
+export type TelemetryFeatureFlag = 'ai' | 'maintenanceMode' | 'databaseBackup' | 'browserNotifications' | 'nodeJobSecretBroker';
+/**
+ * The app's system settings, as telemetry uses them: the `telemetry`
+ * namespace, its provenance, telemetry's own keyed row and an allowlist of
+ * feature flags.
+ *
+ * @stability experimental
+ */
+export interface TelemetrySettingsStore {
+    /** The validated `telemetry` namespace (defaults applied). Uncached: telemetry caches it itself. */
+    getTelemetryPolicy(): Promise<TelemetrySettings>;
+    /**
+     * Replaces the `telemetry` namespace through the app's own settings write
+     * (its validation, its `If-Match` re-check and its settings audit row).
+     *
+     * @param next - the full namespace value.
+     * @param actorUserId - who saves it.
+     * @param expectedVersion - the `If-Match` version, re-checked by the write; `undefined` skips the check.
+     */
+    replaceTelemetryPolicy(next: TelemetrySettings, actorUserId: string, expectedVersion?: number): Promise<void>;
+    /** The provenance of the row the `telemetry` namespace lives in, WITHOUT creating it; `null` when absent. */
+    readPolicyProvenance(): Promise<TelemetrySettingsProvenance | null>;
+    /**
+     * One keyed row telemetry owns, or `null` when absent.
+     *
+     * @param key - the row key (`telemetry_connection`).
+     */
+    readRow(key: string): Promise<TelemetrySettingsRow | null>;
+    /**
+     * Creates or replaces one keyed row, incrementing its version.
+     *
+     * @param key - the row key.
+     * @param value - the JSON to store; never secret material.
+     * @param actorUserId - who saves it.
+     */
+    writeRow(key: string, value: unknown, actorUserId: string): Promise<void>;
+    /**
+     * Deletes one keyed row; a no-op when it is absent.
+     *
+     * @param key - the row key.
+     */
+    deleteRow(key: string): Promise<void>;
+    /**
+     * One allowlisted platform feature switch.
+     *
+     * @param flag - which switch.
+     */
+    readFeatureFlag(flag: TelemetryFeatureFlag): Promise<boolean>;
+}
+/**
+ * Injection token of the app's {@link TelemetryCredentialStore}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_CREDENTIAL_STORE: unique symbol;
+/**
+ * A stored credential's metadata. Never the secret.
+ *
+ * @stability experimental
+ */
+export interface TelemetryCredentialInfo {
+    /** The credential's purpose (`telemetry_greptime`). */
+    readonly purpose: string;
+    /** Its name within the purpose (`reader`, `admin`). */
+    readonly name: string;
+    /** A short non-secret hint (the last characters), or `null`. */
+    readonly hint: string | null;
+    /** A human label, or `null`. */
+    readonly label: string | null;
+    /** Who stored it last, or `null`. */
+    readonly updatedByUserId: string | null;
+    /** When it was first stored. */
+    readonly createdAt: Date;
+    /** When it was last stored. */
+    readonly updatedAt: Date;
+}
+/**
+ * The app's encrypted credential store, addressed by `(purpose, name)`.
+ * Telemetry uses one purpose: `telemetry_greptime` (`reader`, `admin`).
+ *
+ * @stability experimental
+ */
+export interface TelemetryCredentialStore {
+    /**
+     * The decrypted secret, or `null` when none is stored. Held only for the call that needs it.
+     *
+     * @param purpose - the purpose.
+     * @param name - the name.
+     */
+    getSecret(purpose: string, name: string): Promise<string | null>;
+    /**
+     * Stores (encrypts) a secret; a blank one deletes it.
+     *
+     * @param purpose - the purpose.
+     * @param name - the name.
+     * @param secret - the plaintext.
+     * @param meta - non-secret metadata.
+     */
+    setSecret(purpose: string, name: string, secret: string | null | undefined, meta?: {
+        readonly label?: string | null;
+        readonly updatedByUserId?: string | null;
+    }): Promise<void>;
+    /**
+     * Deletes a secret; a no-op when none is stored.
+     *
+     * @param purpose - the purpose.
+     * @param name - the name.
+     */
+    deleteSecret(purpose: string, name: string): Promise<void>;
+    /**
+     * A secret's metadata, or `null` when none is stored.
+     *
+     * @param purpose - the purpose.
+     * @param name - the name.
+     */
+    describe(purpose: string, name: string): Promise<TelemetryCredentialInfo | null>;
+}
+/**
+ * Injection token of the app's {@link TelemetryJobsPort}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_JOBS: unique symbol;
+/**
+ * The columns of one queue job telemetry reads.
+ *
+ * @stability experimental
+ */
+export interface TelemetryJobRecord {
+    /** The job id. */
+    id: string;
+    /** Its handler type (`telemetry.stack.deploy`). */
+    type: string;
+    /** `pending`, `running`, `succeeded`, `failed`, ... */
+    status: string;
+    /** The handler-defined payload (JSON). */
+    payload: unknown;
+    /** When it was queued. */
+    createdAt: Date;
+    /** When it settled, or `null`. */
+    finishedAt: Date | null;
+    /** The last attempt's error, or `null`. */
+    lastError: string | null;
+}
+/**
+ * A job type's execution profile: the lease and the reaper's patience are
+ * derived from `maxRuntimeMs`.
+ *
+ * @stability experimental
+ */
+export interface TelemetryJobExecutionProfile {
+    /** The longest one attempt may run. */
+    maxRuntimeMs: number;
+    /** Attempts before the job fails for good. */
+    maxAttempts: number;
+}
+/**
+ * A telemetry job type's handler, structurally the app's `JobHandler`. Both
+ * telemetry job types are SERVER-ONLY: they declare no `nodeResultSchema` and
+ * no `persistNodeResult`, because they hold the GreptimeDB admin login and the
+ * stack-agent token, privileges a worker node must never hold.
+ *
+ * @stability experimental
+ */
+export interface TelemetryJobHandler {
+    /** The job type. Permanent once jobs of it exist. */
+    readonly type: string;
+    /** The execution profile (`maxRuntimeMs`, `maxAttempts`). */
+    readonly profile?: TelemetryJobExecutionProfile;
+    /**
+     * Runs one job; throws to fail it.
+     *
+     * @param job - the claimed job.
+     */
+    process(job: TelemetryJobRecord): Promise<void>;
+}
+/**
+ * The app's job queue, as telemetry uses it.
+ *
+ * @stability experimental
+ */
+export interface TelemetryJobsPort {
+    /**
+     * Queues a job (or returns the active one with the same dedup key).
+     *
+     * @param input - the type, why it exists, and its payload.
+     */
+    enqueue(input: {
+        type: string;
+        reason: 'upload' | 'rerun' | 'backfill';
+        payload?: Record<string, unknown>;
+    }): Promise<{
+        /** The job's id. */
+        id: string;
+        /** Its status (`pending`, or the active job's). */
+        status: string;
+    }>;
+    /**
+     * Queues one global housekeeping job of `type` unless one is pending or
+     * running. Never throws: a failure is logged on `logger`.
+     *
+     * @param options - the type, a lower-case phrase for the log line, and the caller's logger.
+     */
+    enqueueHousekeepingJob(options: {
+        type: string;
+        what: string;
+        logger: Logger;
+    }): Promise<void>;
+    /**
+     * Registers a handler with the queue's dispatcher. Call it from `onModuleInit`.
+     *
+     * @param handler - the handler.
+     */
+    registerHandler(handler: TelemetryJobHandler): void;
+    /**
+     * The most recently queued job of `type`, or `null`.
+     *
+     * @param type - the job type.
+     */
+    findLatest(type: string): Promise<TelemetryJobRecord | null>;
+    /**
+     * Replaces one job's payload.
+     *
+     * @param jobId - the job.
+     * @param payload - the new payload (JSON).
+     */
+    updatePayload(jobId: string, payload: Record<string, unknown>): Promise<void>;
+}
+/**
+ * Injection token of the app's {@link TelemetryAiPort}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_AI: unique symbol;
+/**
+ * A failure of the AI platform (key missing, model not reachable, AI off, ...).
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiError {
+    /** The platform's `AI_*` code. */
+    readonly code: string;
+    /** A message safe to show. Never key material. */
+    readonly message: string;
+    /** For `AI_RATE_LIMITED`: how long to wait, when the provider said. */
+    readonly retryAfterMs?: number | null;
+}
+/**
+ * One input message of the conversation.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiInputMessage {
+    /** Always `message`. */
+    type: 'message';
+    /** Who said it. */
+    role: 'user' | 'assistant';
+    /** Its text parts. */
+    content: {
+        /** Always `text`. */
+        type: 'text';
+        /** The text. */
+        text: string;
+    }[];
+}
+/**
+ * What a tool's `execute` receives besides its arguments.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolContext {
+    /** Aborted when the turn is cancelled or the tool times out. */
+    signal?: AbortSignal;
+}
+/**
+ * A tool, as the assistant declares it.
+ *
+ * @typeParam P - the arguments schema (an object schema).
+ * @typeParam R - what `execute` returns (serialised to JSON for the model).
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolDefinition<P extends z.ZodType, R> {
+    /** `[a-zA-Z0-9_-]{1,64}`. */
+    name: string;
+    /** What the tool does, for the model. */
+    description: string;
+    /** The arguments schema. */
+    parameters: P;
+    /**
+     * Runs the tool.
+     *
+     * @param args - the validated arguments.
+     * @param ctx - the abort signal.
+     */
+    execute(args: z.output<P>, ctx: TelemetryAiToolContext): Promise<R> | R;
+}
+/**
+ * A tool as the AI platform defined it. Opaque to telemetry: handed back to
+ * {@link TelemetryAiSession.runTools} unchanged.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiTool {
+    /** Brand; the value belongs to the AI platform. */
+    readonly __telemetryAiTool?: never;
+}
+/**
+ * One function call the model made, and what came of it.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolCallRecord {
+    /** The provider's call id. */
+    callId: string;
+    /** The tool name the model asked for. */
+    name: string;
+    /** The raw arguments string the model produced. */
+    arguments: string;
+    /** `ok`, `invalid_arguments`, `unknown_tool`, `error` or `timeout`. */
+    status: 'ok' | 'invalid_arguments' | 'unknown_tool' | 'error' | 'timeout';
+    /** What was fed back to the model. */
+    output: string;
+    /** The tool's error message on `error` or `timeout`. */
+    error?: string;
+    /** How long the call took. */
+    durationMs: number;
+}
+/**
+ * The part of a model response telemetry reads.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiResponse {
+    /** The response's text, if any. */
+    outputText?: string | null;
+}
+/**
+ * One provider round-trip of the tool loop.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolStep {
+    /** 1-based round-trip index. */
+    step: number;
+    /** The provider's response. */
+    response: TelemetryAiResponse;
+    /** The calls it produced; empty on the final step. */
+    calls: TelemetryAiToolCallRecord[];
+}
+/**
+ * What a tool loop returns.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolLoopResult {
+    /** The last provider response. */
+    final: TelemetryAiResponse;
+    /** Every round-trip. */
+    steps: TelemetryAiToolStep[];
+    /** Whether the model finished or the step budget ran out. */
+    stopReason: 'completed' | 'steps_exhausted';
+}
+/**
+ * One tool loop, as the assistant asks for it.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiToolLoopRequest {
+    /** The provider id. */
+    provider: string;
+    /** The model id. */
+    model: string;
+    /** The system prompt. */
+    instructions: string;
+    /** The conversation. */
+    input: TelemetryAiInputMessage[];
+    /** Tools from {@link TelemetryAiPort.defineTool}. */
+    tools: TelemetryAiTool[];
+    /** Round-trips allowed. */
+    maxSteps: number;
+    /** Per-tool timeout. */
+    toolTimeoutMs: number;
+    /**
+     * Called after every round-trip, in order.
+     *
+     * @param step - the round-trip.
+     */
+    onStep(step: TelemetryAiToolStep): void;
+}
+/**
+ * The AI platform on behalf of one user: their key policy, their usage rows.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiSession {
+    /**
+     * Runs a tool loop.
+     *
+     * @param request - the loop.
+     * @param options - an abort signal.
+     */
+    runTools(request: TelemetryAiToolLoopRequest, options: {
+        signal?: AbortSignal;
+    }): Promise<TelemetryAiToolLoopResult>;
+}
+/**
+ * The app's AI platform, as the telemetry assistant uses it. Every model call
+ * goes through `forUser(userId)` (the platform's gate, key resolution and usage
+ * accounting); no provider SDK and no key ever reaches telemetry.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAiPort {
+    /**
+     * The facade for one user.
+     *
+     * @param userId - the caller.
+     */
+    forUser(userId: string): TelemetryAiSession;
+    /**
+     * Declares a tool.
+     *
+     * @param definition - the tool.
+     */
+    defineTool<P extends z.ZodType, R>(definition: TelemetryAiToolDefinition<P, R>): TelemetryAiTool;
+    /**
+     * Whether `error` is the AI platform's own failure.
+     *
+     * @param error - anything thrown.
+     */
+    isAiError(error: unknown): error is TelemetryAiError;
+    /** Throws the app's "AI is off" error (403 `AI_DISABLED`) while the AI platform is switched off. */
+    assertEnabled(): Promise<void>;
+}
+/**
+ * Injection token of the app's {@link TelemetryAppInfo}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+export declare const TELEMETRY_APP_INFO: unique symbol;
+/**
+ * The deploy document's fields the assistant reports (`get_app_context`).
+ *
+ * @stability experimental
+ */
+export interface TelemetryDeployInfo {
+    /** `ok`, `absent` or `invalid`. */
+    status: string;
+    /** Present exactly when `status` is `ok`. */
+    document: {
+        /** The deployed version and commit. */
+        app: {
+            /** The deployed version. */
+            version: string | null;
+            /** The deployed commit. */
+            commitSha: string | null;
+        };
+        /** When the deployment was first installed. */
+        installedAt: string | null;
+        /** When it was last updated. */
+        updatedAt: string | null;
+        /** The last deploy command. */
+        lastCommand: string | null;
+        /** The last deploy run. */
+        run: {
+            /** `success` or `failure`. */
+            outcome: string | null;
+        } | null;
+    } | null;
+}
+/**
+ * Who the application is: its slug (the default telemetry instance id), its
+ * OpenTelemetry service name, its version and its deploy document.
+ *
+ * @stability experimental
+ */
+export interface TelemetryAppInfo {
+    /** The app's slug: the instance id when `telemetry.instanceId` is unset. */
+    readonly slug: string;
+    /** The service name this process reports to OpenTelemetry. */
+    serviceName(): string;
+    /** The API's version. */
+    apiVersion(): string;
+    /** The deploy document (read from disk on every call). */
+    readDeployInfo(): Promise<TelemetryDeployInfo>;
+}
+//# sourceMappingURL=ports.d.ts.map

package/dist/telemetry/ports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ports.d.ts","sourceRoot":"","sources":["../../src/telemetry/ports.ts"],"names":[],"mappings":"AA2BA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yCAAyC,CAAC;AACjF,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAI7B;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,EAAE,OAAO,MAAgE,CAAC;AAE3G;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,gDAAgD;IAChD,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,yEAAyE;IACzE,MAAM,EAAE,MAAM,CAAC;IACf,4FAA4F;IAC5F,UAAU,EAAE,MAAM,CAAC;IACnB,iBAAiB;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,sEAAsE;IACtE,IAAI,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;OAIG;IACH,MAAM,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACnD;AAID;;;;;GAKG;AACH,eAAO,MAAM,wBAAwB,EAAE,OAAO,MAAoE,CAAC;AAEnH;;;;GAIG;AACH,MAAM,WAAW,2BAA2B;IAC1C,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,qCAAqC;IACrC,SAAS,EAAE,IAAI,CAAC;IAChB,sEAAsE;IACtE,SAAS,EAAE;QACT,qBAAqB;QACrB,EAAE,EAAE,MAAM,CAAC;QACX,wBAAwB;QACxB,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,IAAI,CAAC;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,oBAAqB,SAAQ,2BAA2B;IACvE,mEAAmE;IACnE,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,IAAI,GAAG,iBAAiB,GAAG,gBAAgB,GAAG,sBAAsB,GAAG,qBAAqB,CAAC;AAEhI;;;;;;GAMG;AACH,MAAM,WAAW,sBAAsB;IACrC,oGAAoG;IACpG,kBAAkB,IAAI,OAAO,CAAC,iBAAiB,CAAC,CAAC;IACjD;;;;;;;OAOG;IACH,sBAAsB,CAAC,IAAI,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,EAAE,eAAe,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9G,6GAA6G;IAC7G,oBAAoB,IAAI,OAAO,CAAC,2BAA2B,GAAG,IAAI,CAAC,CAAC;IACpE;;;;OAIG;IACH,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,GAAG,IAAI,CAAC,CAAC;IAC3D;;;;;;OAMG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E;;;;OAIG;IACH,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtC;;;;OAIG;IACH,eAAe,CAAC,IAAI,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;CAC/D;AAID;;;;;GAKG;AACH,eAAO,MAAM,0BAA0B,EAAE,OAAO,MAAsE,CAAC;AAEvH;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,uDAAuD;IACvD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gEAAgE;IAChE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAC7B,gCAAgC;IAChC,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,qCAAqC;IACrC,QAAQ,CAAC,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IACxC,gCAAgC;IAChC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;IACzB,+BAA+B;IAC/B,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IACjE;;;;;;;OAOG;IACH,SAAS,CACP,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EACjC,IAAI,CAAC,EAAE;QAAE,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAClF,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB;;;;;OAKG;IACH,YAAY,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3D;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,uBAAuB,GAAG,IAAI,CAAC,CAAC;CAClF;AAID;;;;;GAKG;AACH,eAAO,MAAM,cAAc,EAAE,OAAO,MAA0D,CAAC;AAE/F;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,kBAAkB;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,mDAAmD;IACnD,IAAI,EAAE,MAAM,CAAC;IACb,uDAAuD;IACvD,MAAM,EAAE,MAAM,CAAC;IACf,0CAA0C;IAC1C,OAAO,EAAE,OAAO,CAAC;IACjB,0BAA0B;IAC1B,SAAS,EAAE,IAAI,CAAC;IAChB,kCAAkC;IAClC,UAAU,EAAE,IAAI,GAAG,IAAI,CAAC;IACxB,2CAA2C;IAC3C,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,uCAAuC;IACvC,YAAY,EAAE,MAAM,CAAC;IACrB,8CAA8C;IAC9C,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAClC,qDAAqD;IACrD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,6DAA6D;IAC7D,QAAQ,CAAC,OAAO,CAAC,EAAE,4BAA4B,CAAC;IAChD;;;;OAIG;IACH,OAAO,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACjD;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE;QACb,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,EAAE,QAAQ,GAAG,OAAO,GAAG,UAAU,CAAC;QACxC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACnC,GAAG,OAAO,CAAC;QACV,oBAAoB;QACpB,EAAE,EAAE,MAAM,CAAC;QACX,mDAAmD;QACnD,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC,CAAC;IACH;;;;;OAKG;IACH,sBAAsB,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/F;;;;OAIG;IACH,eAAe,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACpD;;;;OAIG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC,CAAC;IAC7D;;;;;OAKG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC/E;AAID;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,OAAO,MAAwD,CAAC;AAE3F;;;;GAIG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uEAAuE;IACvE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACtC,wBAAwB;IACxB,IAAI,EAAE,SAAS,CAAC;IAChB,mBAAmB;IACnB,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,sBAAsB;IACtB,OAAO,EAAE;QACP,qBAAqB;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,gBAAgB;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,EAAE,CAAC;CACL;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,gEAAgE;IAChE,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/D,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,yCAAyC;IACzC,WAAW,EAAE,MAAM,CAAC;IACpB,4BAA4B;IAC5B,UAAU,EAAE,CAAC,CAAC;IACd;;;;;OAKG;IACH,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;CACzE;AAED;;;;;GAKG;AACH,MAAM,WAAW,eAAe;IAC9B,mDAAmD;IACnD,QAAQ,CAAC,iBAAiB,CAAC,EAAE,KAAK,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,8BAA8B;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,MAAM,EAAE,IAAI,GAAG,mBAAmB,GAAG,cAAc,GAAG,OAAO,GAAG,SAAS,CAAC;IAC1E,sCAAsC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,wDAAwD;IACxD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,8BAA8B;IAC9B,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,+BAA+B;IAC/B,QAAQ,EAAE,mBAAmB,CAAC;IAC9B,sDAAsD;IACtD,KAAK,EAAE,yBAAyB,EAAE,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,yBAAyB;IACxC,kCAAkC;IAClC,KAAK,EAAE,mBAAmB,CAAC;IAC3B,wBAAwB;IACxB,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B,6DAA6D;IAC7D,UAAU,EAAE,WAAW,GAAG,iBAAiB,CAAC;CAC7C;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACzC,uBAAuB;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,yBAAyB;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,wBAAwB;IACxB,KAAK,EAAE,uBAAuB,EAAE,CAAC;IACjC,qDAAqD;IACrD,KAAK,EAAE,eAAe,EAAE,CAAC;IACzB,2BAA2B;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,wBAAwB;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,GAAG,IAAI,CAAC;CACzC;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,EAAE,0BAA0B,EAAE,OAAO,EAAE;QAAE,MAAM,CAAC,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACtH;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;OAIG;IACH,OAAO,CAAC,MAAM,EAAE,MAAM,GAAG,kBAAkB,CAAC;IAC5C;;;;OAIG;IACH,UAAU,CAAC,CAAC,SAAS,CAAC,CAAC,OAAO,EAAE,CAAC,EAAE,UAAU,EAAE,yBAAyB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,eAAe,CAAC;IACjG;;;;OAIG;IACH,SAAS,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,gBAAgB,CAAC;IACrD,oGAAoG;IACpG,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;CAChC;AAID;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAO,MAA8D,CAAC;AAEvG;;;;GAIG;AACH,MAAM,WAAW,mBAAmB;IAClC,mCAAmC;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,6CAA6C;IAC7C,QAAQ,EAAE;QACR,uCAAuC;QACvC,GAAG,EAAE;YACH,4BAA4B;YAC5B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;YACvB,2BAA2B;YAC3B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;SAC1B,CAAC;QACF,+CAA+C;QAC/C,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,gCAAgC;QAChC,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,+BAA+B;QAC/B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;QAC3B,2BAA2B;QAC3B,GAAG,EAAE;YACH,8BAA8B;YAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;SACxB,GAAG,IAAI,CAAC;KACV,GAAG,IAAI,CAAC;CACV;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC/B,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8DAA8D;IAC9D,WAAW,IAAI,MAAM,CAAC;IACtB,yBAAyB;IACzB,UAAU,IAAI,MAAM,CAAC;IACrB,0DAA0D;IAC1D,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC,CAAC;CAChD"}

package/dist/telemetry/ports.js

@@ -0,0 +1,78 @@
+"use strict";
+// =============================================================================
+// The telemetry slice's host ports (issue #703, PP-4.2)
+// =============================================================================
+//
+// Every capability telemetry needs from the application, as ONE injection
+// token per capability. The slice injects these and never imports an app
+// service; the app binds each token to an adapter of its own
+// (`apps/api/src/platform/telemetry/`). Each interface is derived from the
+// exact calls telemetry makes; nothing wider.
+//
+// The core host ports (`AUDIT_SINK`, `SYSTEM_SETTINGS_STORE`, issue #696) are
+// NOT reused for audit and settings, on purpose:
+//
+//   - `AuditSink` takes scalar `meta` only; telemetry's audit rows carry the
+//     changed field NAMES (arrays) and the dashboard's request parameters (an
+//     object), exactly as they did before the move.
+//   - `SystemSettingsStore` reads one namespace; telemetry also needs the
+//     row's provenance (who saved it, when) and its own keyed row
+//     (`telemetry_connection`), which is not a namespace.
+//
+// Logging, metrics and spans need no port: `new Logger(Context)` and
+// `@opentelemetry/api`, as the core README says.
+//
+// The tokens are `Symbol.for(...)` keys, so two copies of this file (two
+// bundles, a test that loads the source next to the built package) agree.
+// =============================================================================
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TELEMETRY_APP_INFO = exports.TELEMETRY_AI = exports.TELEMETRY_JOBS = exports.TELEMETRY_CREDENTIAL_STORE = exports.TELEMETRY_SETTINGS_STORE = exports.TELEMETRY_AUDIT_SINK = void 0;
+// ---- audit ------------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetryAuditSink}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_AUDIT_SINK = Symbol.for('@marinoscar/platform/telemetry/AUDIT_SINK');
+// ---- settings -----------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetrySettingsStore}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_SETTINGS_STORE = Symbol.for('@marinoscar/platform/telemetry/SETTINGS_STORE');
+// ---- credentials --------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetryCredentialStore}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_CREDENTIAL_STORE = Symbol.for('@marinoscar/platform/telemetry/CREDENTIAL_STORE');
+// ---- jobs ---------------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetryJobsPort}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_JOBS = Symbol.for('@marinoscar/platform/telemetry/JOBS');
+// ---- AI -----------------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetryAiPort}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_AI = Symbol.for('@marinoscar/platform/telemetry/AI');
+// ---- app identity -------------------------------------------------------------------
+/**
+ * Injection token of the app's {@link TelemetryAppInfo}.
+ *
+ * @extensionPoint token
+ * @stability experimental
+ */
+exports.TELEMETRY_APP_INFO = Symbol.for('@marinoscar/platform/telemetry/APP_INFO');
+//# sourceMappingURL=ports.js.map

package/dist/telemetry/ports.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ports.js","sourceRoot":"","sources":["../../src/telemetry/ports.ts"],"names":[],"mappings":";AAAA,gFAAgF;AAChF,wDAAwD;AACxD,gFAAgF;AAChF,EAAE;AACF,0EAA0E;AAC1E,yEAAyE;AACzE,6DAA6D;AAC7D,2EAA2E;AAC3E,8CAA8C;AAC9C,EAAE;AACF,8EAA8E;AAC9E,iDAAiD;AACjD,EAAE;AACF,6EAA6E;AAC7E,8EAA8E;AAC9E,oDAAoD;AACpD,0EAA0E;AAC1E,kEAAkE;AAClE,0DAA0D;AAC1D,EAAE;AACF,qEAAqE;AACrE,iDAAiD;AACjD,EAAE;AACF,yEAAyE;AACzE,0EAA0E;AAC1E,gFAAgF;;;AAMhF,sFAAsF;AAEtF;;;;;GAKG;AACU,QAAA,oBAAoB,GAAkB,MAAM,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;AAoC3G,wFAAwF;AAExF;;;;;GAKG;AACU,QAAA,wBAAwB,GAAkB,MAAM,CAAC,GAAG,CAAC,+CAA+C,CAAC,CAAC;AAyFnH,wFAAwF;AAExF;;;;;GAKG;AACU,QAAA,0BAA0B,GAAkB,MAAM,CAAC,GAAG,CAAC,iDAAiD,CAAC,CAAC;AAoEvH,wFAAwF;AAExF;;;;;GAKG;AACU,QAAA,cAAc,GAAkB,MAAM,CAAC,GAAG,CAAC,qCAAqC,CAAC,CAAC;AA2G/F,wFAAwF;AAExF;;;;;GAKG;AACU,QAAA,YAAY,GAAkB,MAAM,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAC;AAqN3F,wFAAwF;AAExF;;;;;GAKG;AACU,QAAA,kBAAkB,GAAkB,MAAM,CAAC,GAAG,CAAC,yCAAyC,CAAC,CAAC"}