@marinoscar/platform-contract 0.0.0-stage → 0.1.0-next.3

package/dist/cjs/telemetry/connection.d.ts

@@ -0,0 +1,355 @@
+import { z } from 'zod';
+/**
+ * `4` for an IPv4 literal, `6` for an IPv6 literal (zone id allowed), `0`
+ * otherwise: the same answers as Node's `net.isIP`, without Node.
+ *
+ * @stability stable
+ */
+export declare function telemetryIpVersion(value: string): 0 | 4 | 6;
+/**
+ * A GreptimeDB host: a hostname ({@link TELEMETRY_HOSTNAME_PATTERN}) or a bare
+ * IPv4/IPv6 address, trimmed, 1..253 characters. No scheme, port or path.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryHostSchema: z.ZodString;
+/**
+ * A host as SUBMITTED on the admin form: absent, `null` or blank means
+ * AUTOMATIC (output `null`: the deployment host, resolved at use); anything
+ * else is a custom host validated by {@link telemetryHostSchema}.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryOptionalHostSchema: z.ZodPipe<z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>, z.ZodNullable<z.ZodString>>;
+/**
+ * GreptimeDB's Postgres-wire port: an integer 1..65535.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryPgPortSchema: z.ZodNumber;
+/**
+ * A connection's database: trimmed, 1..128 characters, a plain identifier
+ * ({@link TELEMETRY_DATABASE_PATTERN}).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDatabaseSchema: z.ZodString;
+/**
+ * A GreptimeDB login name: trimmed, 1..128 characters.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryUserSchema: z.ZodString;
+/**
+ * A stored CUSTOM connection: `host`, `pgPort`, `database`, `readerUser` and
+ * `adminUser` (`null`: no admin login, so retention cannot be applied). The
+ * two passwords live in the encrypted credential store, never here.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryCustomConnectionValueSchema: z.ZodObject<{
+    host: z.ZodString;
+    pgPort: z.ZodNumber;
+    database: z.ZodString;
+    readerUser: z.ZodString;
+    adminUser: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * A stored AUTOMATIC connection: `{ host: null }`, a marker only. The
+ * deployment supplies the host, port, database, logins and passwords at every
+ * refresh; extra keys of older rows are stripped on parse.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryAutomaticConnectionValueSchema: z.ZodObject<{
+    host: z.ZodNull;
+}, z.core.$strip>;
+/**
+ * The stored connection row's `value`: custom or automatic. Non-secret by
+ * construction ({@link TelemetryConnectionCarriesNoSecret}).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryConnectionValueSchema: z.ZodUnion<readonly [z.ZodObject<{
+    host: z.ZodString;
+    pgPort: z.ZodNumber;
+    database: z.ZodString;
+    readerUser: z.ZodString;
+    adminUser: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>, z.ZodObject<{
+    host: z.ZodNull;
+}, z.core.$strip>]>;
+/**
+ * A stored custom connection.
+ *
+ * @stability stable
+ */
+export type TelemetryCustomConnectionValue = z.infer<typeof telemetryCustomConnectionValueSchema>;
+/**
+ * A stored automatic connection.
+ *
+ * @stability stable
+ */
+export type TelemetryAutomaticConnectionValue = z.infer<typeof telemetryAutomaticConnectionValueSchema>;
+/**
+ * The stored connection row's `value`.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionValue = z.infer<typeof telemetryConnectionValueSchema>;
+/**
+ * Field names that would mean a secret had been added to the stored
+ * connection; {@link TelemetryConnectionCarriesNoSecret} refuses each.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionSecretFieldNames = 'password' | 'readerPassword' | 'adminPassword' | 'writerPassword' | 'secret' | 'secretKey' | 'apiKey' | 'key' | 'token' | 'connectionString' | 'url';
+/**
+ * Compile-time proof that the stored connection carries no secret: `true`,
+ * or `never` (and this package stops compiling) once a field such as
+ * `readerPassword` is added to either value schema.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionCarriesNoSecret = Extract<keyof TelemetryCustomConnectionValue | keyof TelemetryAutomaticConnectionValue, TelemetryConnectionSecretFieldNames> extends never ? true : never;
+/**
+ * The value of {@link TelemetryConnectionCarriesNoSecret}; it only compiles
+ * while the proof holds.
+ *
+ * @stability stable
+ */
+export declare const TELEMETRY_CONNECTION_CARRIES_NO_SECRET: TelemetryConnectionCarriesNoSecret;
+/**
+ * `PUT /api/admin/telemetry/connection` body. A blank or absent `host` is
+ * AUTOMATIC and every other field is ignored; a custom host needs
+ * `readerUser` and `adminUser` (or `null`). An omitted or empty password
+ * keeps the stored one. Output: `host` is `null` for automatic, `pgPort`
+ * defaults to 4003 and `database` to `public`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const updateTelemetryConnectionSchema: z.ZodObject<{
+    host: z.ZodPipe<z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>, z.ZodNullable<z.ZodString>>;
+    pgPort: z.ZodDefault<z.ZodNumber>;
+    database: z.ZodDefault<z.ZodString>;
+    readerUser: z.ZodPipe<z.ZodOptional<z.ZodString>, z.ZodTransform<string | undefined, string | undefined>>;
+    readerPassword: z.ZodOptional<z.ZodString>;
+    adminUser: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null | undefined, string | null | undefined>>;
+    adminPassword: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The `PUT /api/admin/telemetry/connection` body as a client sends it.
+ *
+ * @stability stable
+ */
+export type UpdateTelemetryConnectionRequest = z.input<typeof updateTelemetryConnectionSchema>;
+/**
+ * The `PUT /api/admin/telemetry/connection` body after parsing (defaults
+ * applied, blanks normalized).
+ *
+ * @stability stable
+ */
+export type UpdateTelemetryConnectionInput = z.output<typeof updateTelemetryConnectionSchema>;
+/**
+ * `POST /api/admin/telemetry/connection/test` body: a CANDIDATE connection,
+ * not necessarily saved, in the shape of {@link updateTelemetryConnectionSchema}.
+ * A blank host probes the deployment's own GreptimeDB with its own logins;
+ * for a custom host, a blank password means "the password the connection in
+ * force uses for that login".
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const testTelemetryConnectionSchema: z.ZodObject<{
+    host: z.ZodPipe<z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null, string | null | undefined>>, z.ZodNullable<z.ZodString>>;
+    pgPort: z.ZodDefault<z.ZodNumber>;
+    database: z.ZodDefault<z.ZodString>;
+    readerUser: z.ZodPipe<z.ZodOptional<z.ZodString>, z.ZodTransform<string | undefined, string | undefined>>;
+    readerPassword: z.ZodOptional<z.ZodString>;
+    adminUser: z.ZodPipe<z.ZodOptional<z.ZodNullable<z.ZodString>>, z.ZodTransform<string | null | undefined, string | null | undefined>>;
+    adminPassword: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * The `POST /api/admin/telemetry/connection/test` body after parsing.
+ *
+ * @stability stable
+ */
+export type TestTelemetryConnectionInput = z.output<typeof testTelemetryConnectionSchema>;
+/**
+ * Masked, non-secret facts about one stored password: `configured`, `hint`
+ * (the credential store's mask, never the password), `updatedAt` and
+ * `updatedByUserId`.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryCredentialStatusSchema: z.ZodObject<{
+    configured: z.ZodBoolean;
+    hint: z.ZodNullable<z.ZodString>;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedByUserId: z.ZodNullable<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * Masked facts about one stored password.
+ *
+ * @stability stable
+ */
+export type TelemetryCredentialStatus = z.infer<typeof telemetryCredentialStatusSchema>;
+/**
+ * The GreptimeDB deployed with this application, as the deployment describes
+ * it: `host`, `pgPort`, `database`, `readerUser`, `adminUser`,
+ * `readerConfigured` and `adminConfigured`. Non-secret: never a password.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryDeploymentConnectionSchema: z.ZodObject<{
+    host: z.ZodString;
+    pgPort: z.ZodNumber;
+    database: z.ZodString;
+    readerUser: z.ZodString;
+    adminUser: z.ZodNullable<z.ZodString>;
+    readerConfigured: z.ZodBoolean;
+    adminConfigured: z.ZodBoolean;
+}, z.core.$strip>;
+/**
+ * The GreptimeDB deployed with this application.
+ *
+ * @stability stable
+ */
+export type TelemetryDeploymentConnection = z.infer<typeof telemetryDeploymentConnectionSchema>;
+/**
+ * `GET /api/admin/telemetry/connection` (and the `PUT` / `DELETE`
+ * responses): where the connection comes from, its host as configured and as
+ * used, the deployment's own connection, the logins, masked password
+ * statuses and the row `version` (send it back as `If-Match`).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryConnectionResponseSchema: z.ZodObject<{
+    source: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"stored" | "environment" | "none">>;
+    host: z.ZodNullable<z.ZodString>;
+    effectiveHost: z.ZodString;
+    hostMode: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"custom" | "auto">>;
+    deploymentManaged: z.ZodBoolean;
+    deployment: z.ZodObject<{
+        host: z.ZodString;
+        pgPort: z.ZodNumber;
+        database: z.ZodString;
+        readerUser: z.ZodString;
+        adminUser: z.ZodNullable<z.ZodString>;
+        readerConfigured: z.ZodBoolean;
+        adminConfigured: z.ZodBoolean;
+    }, z.core.$strip>;
+    problem: z.ZodNullable<z.ZodString>;
+    pgPort: z.ZodNumber;
+    database: z.ZodString;
+    readerUser: z.ZodString;
+    adminUser: z.ZodNullable<z.ZodString>;
+    configured: z.ZodBoolean;
+    adminConfigured: z.ZodBoolean;
+    credentials: z.ZodObject<{
+        reader: z.ZodObject<{
+            configured: z.ZodBoolean;
+            hint: z.ZodNullable<z.ZodString>;
+            updatedAt: z.ZodNullable<z.ZodISODateTime>;
+            updatedByUserId: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+        admin: z.ZodObject<{
+            configured: z.ZodBoolean;
+            hint: z.ZodNullable<z.ZodString>;
+            updatedAt: z.ZodNullable<z.ZodISODateTime>;
+            updatedByUserId: z.ZodNullable<z.ZodString>;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+    version: z.ZodNumber;
+    updatedAt: z.ZodNullable<z.ZodISODateTime>;
+    updatedBy: z.ZodNullable<z.ZodObject<{
+        id: z.ZodString;
+        email: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * `GET /api/admin/telemetry/connection`.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionResponse = z.infer<typeof telemetryConnectionResponseSchema>;
+/**
+ * One login's probe in a connection test: `success`, `latencyMs`, `version`
+ * (reader only) and `error` (never a password or connection string).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryConnectionProbeSchema: z.ZodObject<{
+    success: z.ZodBoolean;
+    latencyMs: z.ZodNumber;
+    version: z.ZodOptional<z.ZodString>;
+    error: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+/**
+ * One login's probe in a connection test.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionProbe = z.infer<typeof telemetryConnectionProbeSchema>;
+/**
+ * `{ skipped: true }`: the candidate had no admin user, so the admin login
+ * was not checked.
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryConnectionSkippedSchema: z.ZodObject<{
+    skipped: z.ZodLiteral<true>;
+}, z.core.$strip>;
+/**
+ * A skipped admin probe.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionSkipped = z.infer<typeof telemetryConnectionSkippedSchema>;
+/**
+ * `POST /api/admin/telemetry/connection/test` response, always a 200: the
+ * `host` probed, `hostMode`, the `reader` probe and the `admin` probe (or
+ * skipped).
+ *
+ * @extensionPoint schema
+ * @stability stable
+ */
+export declare const telemetryConnectionTestResultSchema: z.ZodObject<{
+    host: z.ZodString;
+    hostMode: z.ZodEnum<import("./constants.js").TelemetryEnumEntries<"custom" | "auto">>;
+    reader: z.ZodObject<{
+        success: z.ZodBoolean;
+        latencyMs: z.ZodNumber;
+        version: z.ZodOptional<z.ZodString>;
+        error: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>;
+    admin: z.ZodUnion<readonly [z.ZodObject<{
+        success: z.ZodBoolean;
+        latencyMs: z.ZodNumber;
+        version: z.ZodOptional<z.ZodString>;
+        error: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>, z.ZodObject<{
+        skipped: z.ZodLiteral<true>;
+    }, z.core.$strip>]>;
+}, z.core.$strip>;
+/**
+ * The `POST /api/admin/telemetry/connection/test` response.
+ *
+ * @stability stable
+ */
+export type TelemetryConnectionTestResult = z.infer<typeof telemetryConnectionTestResultSchema>;
+//# sourceMappingURL=connection.d.ts.map

package/dist/cjs/telemetry/connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../../src/telemetry/connection.ts"],"names":[],"mappings":"AAgBA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAkCxB;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAI3D;AAID;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,aAO5B,CAAC;AAEL;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,uJAID,CAAC;AAExC;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,aAAqC,CAAC;AAExE;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,aAOhC,CAAC;AAEL;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,aAAoC,CAAC;AAIrE;;;;;;;GAOG;AACH,eAAO,MAAM,oCAAoC;;;;;;iBAW/C,CAAC;AAEH;;;;;;;GAOG;AACH,eAAO,MAAM,uCAAuC;;iBAGlD,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;;;;;;;mBAGzC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oCAAoC,CAAC,CAAC;AAElG;;;;GAIG;AACH,MAAM,MAAM,iCAAiC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uCAAuC,CAAC,CAAC;AAExG;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF;;;;;GAKG;AACH,MAAM,MAAM,mCAAmC,GAC3C,UAAU,GACV,gBAAgB,GAChB,eAAe,GACf,gBAAgB,GAChB,QAAQ,GACR,WAAW,GACX,QAAQ,GACR,KAAK,GACL,OAAO,GACP,kBAAkB,GAClB,KAAK,CAAC;AAEV;;;;;;GAMG;AACH,MAAM,MAAM,kCAAkC,GAC5C,OAAO,CACL,MAAM,8BAA8B,GAAG,MAAM,iCAAiC,EAC9E,mCAAmC,CACpC,SAAS,KAAK,GACX,IAAI,GACJ,KAAK,CAAC;AAEZ;;;;;GAKG;AACH,eAAO,MAAM,sCAAsC,EAAE,kCAAyC,CAAC;AAwD/F;;;;;;;;;GASG;AACH,eAAO,MAAM,+BAA+B;;;;;;;;iBAoCF,CAAC;AAE3C;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAE/F;;;;;GAKG;AACH,MAAM,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAE9F;;;;;;;;;GASG;AACH,eAAO,MAAM,6BAA6B;;;;;;;;iBAAkC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,6BAA6B,CAAC,CAAC;AAI1F;;;;;;;GAOG;AACH,eAAO,MAAM,+BAA+B;;;;;iBAiB1C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,+BAA+B,CAAC,CAAC;AAExF;;;;;;;GAOG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;iBAe9C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC;AAEhG;;;;;;;;GAQG;AACH,eAAO,MAAM,iCAAiC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAyE5C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F;;;;;;GAMG;AACH,eAAO,MAAM,8BAA8B;;;;;iBASzC,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF;;;;;;GAMG;AACH,eAAO,MAAM,gCAAgC;;iBAG3C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,gCAAgC,CAAC,CAAC;AAE1F;;;;;;;GAOG;AACH,eAAO,MAAM,mCAAmC;;;;;;;;;;;;;;;;;iBAa9C,CAAC;AAEH;;;;GAIG;AACH,MAAM,MAAM,6BAA6B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,mCAAmC,CAAC,CAAC"}