@vertracloud/api-types 0.1.1 → 0.2.0

package/payloads/v1/database-data.d.ts

@@ -0,0 +1,329 @@
+/**
+ * Payloads of the database **Data** tab (content management: SQL, Mongo, Redis).
+ *
+ * The resource here is the **content** of the user's database, not the database instance itself
+ * (see `database.ts`). No field carries credentials: password, connection string and certificate
+ * are never returned by these routes.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview
+ */
+/**
+ * Tab header: which engine this is and how much it currently stores.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview
+ */
+interface APIDatabaseDataOverview {
+    engine_version: string;
+    size_bytes: number;
+    /** Tables (SQL), collections (Mongo) or keys (Redis). */
+    objects_count: number;
+    connections_active: number;
+    connections_max: number;
+    uptime_seconds: number;
+    /** Engine-specific fields (e.g. `wal_size_bytes`, `replica_set`). Optional per engine. */
+    extra?: Record<string, string | number | boolean | null>;
+}
+/**
+ * Sort direction for any listing in the tab.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview
+ */
+type DatabaseSortDirection = "asc" | "desc";
+declare const DatabaseSortDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};
+/**
+ * Operators accepted by the structured row filter (`APIDatabaseRowFilter.op`). Closed list —
+ * anything else is rejected.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
+ */
+type DatabaseFilterOperator = "=" | "!=" | "<" | "<=" | ">" | ">=" | "LIKE" | "IS NULL" | "IS NOT NULL";
+declare const DatabaseFilterOperator: {
+    readonly Eq: "=";
+    readonly Ne: "!=";
+    readonly Lt: "<";
+    readonly Lte: "<=";
+    readonly Gt: ">";
+    readonly Gte: ">=";
+    readonly Like: "LIKE";
+    readonly IsNull: "IS NULL";
+    readonly IsNotNull: "IS NOT NULL";
+};
+/**
+ * One item of the structured row filter. `value` is omitted for `IS NULL`/`IS NOT NULL`.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
+ */
+interface APIDatabaseRowFilter {
+    column: string;
+    op: DatabaseFilterOperator;
+    value?: unknown;
+}
+/**
+ * Query-string parameters for paginated **row** listing. `per_page` is capped at 200.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
+ */
+interface APIDatabaseListParams {
+    page?: number;
+    per_page?: number;
+    /** Simple "contains" filter applied to the column/field given by `filter_field`. */
+    filter?: string;
+    filter_field?: string;
+    sort?: string;
+    direction?: DatabaseSortDirection;
+    /**
+     * Structured filter: `APIDatabaseRowFilter[]` serialized as JSON. Up to 20 items and 4096
+     * bytes — anything larger is rejected.
+     */
+    filters?: string;
+}
+/**
+ * Query-string parameters for paginated **document** listing. `filter` is a serialized Mongo
+ * query JSON; `sort` is a serialized `{ field: 1 | -1 }`. No `direction`/`filter_field` — the
+ * Mongo filter already carries the operator.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
+ */
+interface APIDatabaseDocumentListParams {
+    page?: number;
+    per_page?: number;
+    filter?: string;
+    sort?: string;
+}
+/**
+ * Data operation error. Same error envelope as the rest of the API — `code` is a stable English
+ * sentinel (`DB_NOT_RUNNING`, `QUERY_TIMEOUT`, …) meant to be translated by the client.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/errors
+ */
+interface APIDatabaseDataError {
+    code: string;
+    message?: string;
+    details?: unknown;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/schemas
+ */
+interface APIDatabaseSchema {
+    name: string;
+    tables_count: number;
+    size_bytes: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
+ */
+type DatabaseTableKind = "table" | "view";
+declare const DatabaseTableKind: {
+    readonly Table: "table";
+    readonly View: "view";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
+ */
+interface APIDatabaseTable {
+    schema: string;
+    name: string;
+    kind: DatabaseTableKind;
+    /** Engine estimate — an exact count would require a full scan. */
+    rows_estimate: number;
+    size_bytes: number;
+    columns_count: number;
+    indexes_count: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
+ */
+interface APIDatabaseColumnReference {
+    schema: string;
+    table: string;
+    column: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
+ */
+interface APIDatabaseColumn {
+    name: string;
+    /** Raw engine type (`text`, `bigint`, `timestamptz`, `varchar(255)`…). */
+    data_type: string;
+    nullable: boolean;
+    default_value: string | null;
+    is_primary_key: boolean;
+    is_unique: boolean;
+    is_foreign_key: boolean;
+    references?: APIDatabaseColumnReference;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables
+ */
+interface APIDatabaseIndex {
+    name: string;
+    columns: string[];
+    unique: boolean;
+    primary: boolean;
+    size_bytes: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows
+ */
+interface APIDatabaseRowsPage {
+    columns: APIDatabaseColumn[];
+    rows: Record<string, unknown>[];
+    total: number;
+    page: number;
+    per_page: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query
+ */
+interface APIDatabaseQueryResult {
+    columns: string[];
+    /** Positional matrix — order matches `columns`. */
+    rows: unknown[][];
+    row_count: number;
+    duration_ms: number;
+    /** `true` when the result was cut at the row limit. */
+    truncated: boolean;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections
+ */
+interface APIDatabaseCollection {
+    name: string;
+    documents_count: number;
+    size_bytes: number;
+    avg_document_size: number;
+    indexes_count: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents
+ */
+interface APIDatabaseDocumentsPage {
+    documents: Record<string, unknown>[];
+    total: number;
+    page: number;
+    per_page: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections
+ */
+interface APIDatabaseMongoIndex {
+    name: string;
+    /** `{ created_at: -1 }` — same shape as `createIndex`. */
+    keys: Record<string, 1 | -1>;
+    unique: boolean;
+    sparse: boolean;
+}
+/**
+ * `SCAN` query-string parameters. `cursor` absent = start of the scan.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+interface APIDatabaseRedisScanParams {
+    pattern?: string;
+    cursor?: string;
+    count?: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+type DatabaseRedisKeyType = "string" | "hash" | "list" | "set" | "zset" | "stream";
+declare const DatabaseRedisKeyType: {
+    readonly String: "string";
+    readonly Hash: "hash";
+    readonly List: "list";
+    readonly Set: "set";
+    readonly ZSet: "zset";
+    readonly Stream: "stream";
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+interface APIDatabaseRedisKey {
+    key: string;
+    type: DatabaseRedisKeyType;
+    /** `null` = no expiration. */
+    ttl_seconds: number | null;
+    size_bytes: number;
+    /** Cardinality (items in the hash/list/set/zset/stream). Absent for `string`. */
+    length?: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+interface APIDatabaseRedisKeysPage {
+    keys: APIDatabaseRedisKey[];
+    /** `SCAN` cursor. `null` = the scan is complete. */
+    cursor: string | null;
+    scanned: number;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+interface APIDatabaseRedisZSetMember {
+    member: string;
+    score: number;
+}
+/**
+ * Value of a key, discriminated by `type`. Collections are truncated at 1000 items **or** at the
+ * read byte limit — `truncated: true` when the value was cut for either reason. Absent/`false` =
+ * the full value was returned.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys
+ */
+type APIDatabaseRedisKeyValue = {
+    key: string;
+    type: "string";
+    ttl_seconds: number | null;
+    value: string;
+    truncated?: boolean;
+} | {
+    key: string;
+    type: "hash";
+    ttl_seconds: number | null;
+    value: Record<string, string>;
+    truncated?: boolean;
+} | {
+    key: string;
+    type: "list";
+    ttl_seconds: number | null;
+    value: string[];
+    truncated?: boolean;
+} | {
+    key: string;
+    type: "set";
+    ttl_seconds: number | null;
+    value: string[];
+    truncated?: boolean;
+} | {
+    key: string;
+    type: "zset";
+    ttl_seconds: number | null;
+    value: APIDatabaseRedisZSetMember[];
+    truncated?: boolean;
+} | {
+    key: string;
+    type: "stream";
+    ttl_seconds: number | null;
+    value: string[];
+    truncated?: boolean;
+};
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/info
+ */
+interface APIDatabaseRedisInfo {
+    version: string;
+    used_memory_bytes: number;
+    /** `null` = no `maxmemory` configured. */
+    max_memory_bytes: number | null;
+    keys_total: number;
+    expires_total: number;
+    hits: number;
+    misses: number;
+    connected_clients: number;
+    ops_per_second: number;
+}
+
+export { type APIDatabaseCollection, type APIDatabaseColumn, type APIDatabaseColumnReference, type APIDatabaseDataError, type APIDatabaseDataOverview, type APIDatabaseDocumentListParams, type APIDatabaseDocumentsPage, type APIDatabaseIndex, type APIDatabaseListParams, type APIDatabaseMongoIndex, type APIDatabaseQueryResult, type APIDatabaseRedisInfo, type APIDatabaseRedisKey, type APIDatabaseRedisKeyValue, type APIDatabaseRedisKeysPage, type APIDatabaseRedisScanParams, type APIDatabaseRedisZSetMember, type APIDatabaseRowFilter, type APIDatabaseRowsPage, type APIDatabaseSchema, type APIDatabaseTable, DatabaseFilterOperator, DatabaseRedisKeyType, DatabaseSortDirection, DatabaseTableKind };

package/payloads/v1/database-data.js

@@ -0,0 +1,63 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// payloads/v1/database-data.ts
+var database_data_exports = {};
+__export(database_data_exports, {
+  DatabaseFilterOperator: () => DatabaseFilterOperator,
+  DatabaseRedisKeyType: () => DatabaseRedisKeyType,
+  DatabaseSortDirection: () => DatabaseSortDirection,
+  DatabaseTableKind: () => DatabaseTableKind
+});
+module.exports = __toCommonJS(database_data_exports);
+var DatabaseSortDirection = {
+  Asc: "asc",
+  Desc: "desc"
+};
+var DatabaseFilterOperator = {
+  Eq: "=",
+  Ne: "!=",
+  Lt: "<",
+  Lte: "<=",
+  Gt: ">",
+  Gte: ">=",
+  Like: "LIKE",
+  IsNull: "IS NULL",
+  IsNotNull: "IS NOT NULL"
+};
+var DatabaseTableKind = {
+  Table: "table",
+  View: "view"
+};
+var DatabaseRedisKeyType = {
+  String: "string",
+  Hash: "hash",
+  List: "list",
+  Set: "set",
+  ZSet: "zset",
+  Stream: "stream"
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DatabaseFilterOperator,
+  DatabaseRedisKeyType,
+  DatabaseSortDirection,
+  DatabaseTableKind
+});
+//# sourceMappingURL=database-data.js.map

package/payloads/v1/database-data.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["database-data.ts"],"sourcesContent":["/**\n * Payloads of the database **Data** tab (content management: SQL, Mongo, Redis).\n *\n * The resource here is the **content** of the user's database, not the database instance itself\n * (see `database.ts`). No field carries credentials: password, connection string and certificate\n * are never returned by these routes.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview\n */\n\n// ---------------------------------------------------------------------------\n// Common to every engine\n// ---------------------------------------------------------------------------\n\n/**\n * Tab header: which engine this is and how much it currently stores.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview\n */\nexport interface APIDatabaseDataOverview {\n\tengine_version: string;\n\tsize_bytes: number;\n\t/** Tables (SQL), collections (Mongo) or keys (Redis). */\n\tobjects_count: number;\n\tconnections_active: number;\n\tconnections_max: number;\n\tuptime_seconds: number;\n\t/** Engine-specific fields (e.g. `wal_size_bytes`, `replica_set`). Optional per engine. */\n\textra?: Record<string, string | number | boolean | null>;\n}\n\n/**\n * Sort direction for any listing in the tab.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/overview\n */\nexport type DatabaseSortDirection = \"asc\" | \"desc\";\nexport const DatabaseSortDirection = {\n\tAsc: \"asc\",\n\tDesc: \"desc\",\n} as const satisfies Record<string, DatabaseSortDirection>;\n\n/**\n * Operators accepted by the structured row filter (`APIDatabaseRowFilter.op`). Closed list —\n * anything else is rejected.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport type DatabaseFilterOperator = \"=\" | \"!=\" | \"<\" | \"<=\" | \">\" | \">=\" | \"LIKE\" | \"IS NULL\" | \"IS NOT NULL\";\nexport const DatabaseFilterOperator = {\n\tEq: \"=\",\n\tNe: \"!=\",\n\tLt: \"<\",\n\tLte: \"<=\",\n\tGt: \">\",\n\tGte: \">=\",\n\tLike: \"LIKE\",\n\tIsNull: \"IS NULL\",\n\tIsNotNull: \"IS NOT NULL\",\n} as const satisfies Record<string, DatabaseFilterOperator>;\n\n/**\n * One item of the structured row filter. `value` is omitted for `IS NULL`/`IS NOT NULL`.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface APIDatabaseRowFilter {\n\tcolumn: string;\n\top: DatabaseFilterOperator;\n\tvalue?: unknown;\n}\n\n/**\n * Query-string parameters for paginated **row** listing. `per_page` is capped at 200.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface APIDatabaseListParams {\n\tpage?: number;\n\tper_page?: number;\n\t/** Simple \"contains\" filter applied to the column/field given by `filter_field`. */\n\tfilter?: string;\n\tfilter_field?: string;\n\tsort?: string;\n\tdirection?: DatabaseSortDirection;\n\t/**\n\t * Structured filter: `APIDatabaseRowFilter[]` serialized as JSON. Up to 20 items and 4096\n\t * bytes — anything larger is rejected.\n\t */\n\tfilters?: string;\n}\n\n/**\n * Query-string parameters for paginated **document** listing. `filter` is a serialized Mongo\n * query JSON; `sort` is a serialized `{ field: 1 | -1 }`. No `direction`/`filter_field` — the\n * Mongo filter already carries the operator.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface APIDatabaseDocumentListParams {\n\tpage?: number;\n\tper_page?: number;\n\tfilter?: string;\n\tsort?: string;\n}\n\n/**\n * Data operation error. Same error envelope as the rest of the API — `code` is a stable English\n * sentinel (`DB_NOT_RUNNING`, `QUERY_TIMEOUT`, …) meant to be translated by the client.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/errors\n */\nexport interface APIDatabaseDataError {\n\tcode: string;\n\tmessage?: string;\n\tdetails?: unknown;\n}\n\n// ---------------------------------------------------------------------------\n// SQL (PostgreSQL / MySQL)\n// ---------------------------------------------------------------------------\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/schemas\n */\nexport interface APIDatabaseSchema {\n\tname: string;\n\ttables_count: number;\n\tsize_bytes: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport type DatabaseTableKind = \"table\" | \"view\";\nexport const DatabaseTableKind = {\n\tTable: \"table\",\n\tView: \"view\",\n} as const satisfies Record<string, DatabaseTableKind>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface APIDatabaseTable {\n\tschema: string;\n\tname: string;\n\tkind: DatabaseTableKind;\n\t/** Engine estimate — an exact count would require a full scan. */\n\trows_estimate: number;\n\tsize_bytes: number;\n\tcolumns_count: number;\n\tindexes_count: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface APIDatabaseColumnReference {\n\tschema: string;\n\ttable: string;\n\tcolumn: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface APIDatabaseColumn {\n\tname: string;\n\t/** Raw engine type (`text`, `bigint`, `timestamptz`, `varchar(255)`…). */\n\tdata_type: string;\n\tnullable: boolean;\n\tdefault_value: string | null;\n\tis_primary_key: boolean;\n\tis_unique: boolean;\n\tis_foreign_key: boolean;\n\treferences?: APIDatabaseColumnReference;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/tables\n */\nexport interface APIDatabaseIndex {\n\tname: string;\n\tcolumns: string[];\n\tunique: boolean;\n\tprimary: boolean;\n\tsize_bytes: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/rows\n */\nexport interface APIDatabaseRowsPage {\n\tcolumns: APIDatabaseColumn[];\n\trows: Record<string, unknown>[];\n\ttotal: number;\n\tpage: number;\n\tper_page: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/query\n */\nexport interface APIDatabaseQueryResult {\n\tcolumns: string[];\n\t/** Positional matrix — order matches `columns`. */\n\trows: unknown[][];\n\trow_count: number;\n\tduration_ms: number;\n\t/** `true` when the result was cut at the row limit. */\n\ttruncated: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// MongoDB\n// ---------------------------------------------------------------------------\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections\n */\nexport interface APIDatabaseCollection {\n\tname: string;\n\tdocuments_count: number;\n\tsize_bytes: number;\n\tavg_document_size: number;\n\tindexes_count: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/documents\n */\nexport interface APIDatabaseDocumentsPage {\n\tdocuments: Record<string, unknown>[];\n\ttotal: number;\n\tpage: number;\n\tper_page: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/collections\n */\nexport interface APIDatabaseMongoIndex {\n\tname: string;\n\t/** `{ created_at: -1 }` — same shape as `createIndex`. */\n\tkeys: Record<string, 1 | -1>;\n\tunique: boolean;\n\tsparse: boolean;\n}\n\n// ---------------------------------------------------------------------------\n// Redis\n// ---------------------------------------------------------------------------\n\n/**\n * `SCAN` query-string parameters. `cursor` absent = start of the scan.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface APIDatabaseRedisScanParams {\n\tpattern?: string;\n\tcursor?: string;\n\tcount?: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport type DatabaseRedisKeyType = \"string\" | \"hash\" | \"list\" | \"set\" | \"zset\" | \"stream\";\nexport const DatabaseRedisKeyType = {\n\tString: \"string\",\n\tHash: \"hash\",\n\tList: \"list\",\n\tSet: \"set\",\n\tZSet: \"zset\",\n\tStream: \"stream\",\n} as const satisfies Record<string, DatabaseRedisKeyType>;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface APIDatabaseRedisKey {\n\tkey: string;\n\ttype: DatabaseRedisKeyType;\n\t/** `null` = no expiration. */\n\tttl_seconds: number | null;\n\tsize_bytes: number;\n\t/** Cardinality (items in the hash/list/set/zset/stream). Absent for `string`. */\n\tlength?: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface APIDatabaseRedisKeysPage {\n\tkeys: APIDatabaseRedisKey[];\n\t/** `SCAN` cursor. `null` = the scan is complete. */\n\tcursor: string | null;\n\tscanned: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport interface APIDatabaseRedisZSetMember {\n\tmember: string;\n\tscore: number;\n}\n\n/**\n * Value of a key, discriminated by `type`. Collections are truncated at 1000 items **or** at the\n * read byte limit — `truncated: true` when the value was cut for either reason. Absent/`false` =\n * the full value was returned.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/keys\n */\nexport type APIDatabaseRedisKeyValue =\n\t| { key: string; type: \"string\"; ttl_seconds: number | null; value: string; truncated?: boolean }\n\t| { key: string; type: \"hash\"; ttl_seconds: number | null; value: Record<string, string>; truncated?: boolean }\n\t| { key: string; type: \"list\"; ttl_seconds: number | null; value: string[]; truncated?: boolean }\n\t| { key: string; type: \"set\"; ttl_seconds: number | null; value: string[]; truncated?: boolean }\n\t| { key: string; type: \"zset\"; ttl_seconds: number | null; value: APIDatabaseRedisZSetMember[]; truncated?: boolean }\n\t| { key: string; type: \"stream\"; ttl_seconds: number | null; value: string[]; truncated?: boolean };\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/data/info\n */\nexport interface APIDatabaseRedisInfo {\n\tversion: string;\n\tused_memory_bytes: number;\n\t/** `null` = no `maxmemory` configured. */\n\tmax_memory_bytes: number | null;\n\tkeys_total: number;\n\texpires_total: number;\n\thits: number;\n\tmisses: number;\n\tconnected_clients: number;\n\tops_per_second: number;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAqCO,IAAM,wBAAwB;AAAA,EACpC,KAAK;AAAA,EACL,MAAM;AACP;AASO,IAAM,yBAAyB;AAAA,EACrC,IAAI;AAAA,EACJ,IAAI;AAAA,EACJ,IAAI;AAAA,EACJ,KAAK;AAAA,EACL,IAAI;AAAA,EACJ,KAAK;AAAA,EACL,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,WAAW;AACZ;AA4EO,IAAM,oBAAoB;AAAA,EAChC,OAAO;AAAA,EACP,MAAM;AACP;AAkIO,IAAM,uBAAuB;AAAA,EACnC,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,MAAM;AAAA,EACN,KAAK;AAAA,EACL,MAAM;AAAA,EACN,QAAQ;AACT;","names":[]}

package/payloads/v1/database-data.mjs

@@ -0,0 +1,35 @@
+// payloads/v1/database-data.ts
+var DatabaseSortDirection = {
+  Asc: "asc",
+  Desc: "desc"
+};
+var DatabaseFilterOperator = {
+  Eq: "=",
+  Ne: "!=",
+  Lt: "<",
+  Lte: "<=",
+  Gt: ">",
+  Gte: ">=",
+  Like: "LIKE",
+  IsNull: "IS NULL",
+  IsNotNull: "IS NOT NULL"
+};
+var DatabaseTableKind = {
+  Table: "table",
+  View: "view"
+};
+var DatabaseRedisKeyType = {
+  String: "string",
+  Hash: "hash",
+  List: "list",
+  Set: "set",
+  ZSet: "zset",
+  Stream: "stream"
+};
+export {
+  DatabaseFilterOperator,
+  DatabaseRedisKeyType,
+  DatabaseSortDirection,
+  DatabaseTableKind
+};
+//# sourceMappingURL=database-data.mjs.map

package/payloads/v1/database.d.ts

@@ -1,7 +1,8 @@
-import { ISODateString, SnowFlake, UserPlan } from '../../common/v1.js';
+import { SnowFlake, UserPlan, ISODateString } from '../../common/v1.js';
+import './api-error.js';
 
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
  */
 type DatabaseType = 1 | 2 | 3 | 4;
 declare const DatabaseType: {
@@ -11,7 +12,7 @@ declare const DatabaseType: {
     readonly MYSQL: 4;
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
  */
 type DatabaseStatus = "up" | "down";
 declare const DatabaseStatus: {
@@ -19,7 +20,7 @@ declare const DatabaseStatus: {
     readonly DOWN: "down";
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/status
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
  */
 type DatabaseCluster = number;
 declare const DatabaseCluster: {
@@ -28,14 +29,7 @@ declare const DatabaseCluster: {
     readonly USA_3: 3;
 };
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
- */
-interface APIDatabaseActivity {
-    message: string;
-    timestamp: ISODateString;
-}
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
  */
 interface APIDatabase {
     id: SnowFlake;
@@ -52,29 +46,17 @@ interface APIDatabase {
     created_at: ISODateString;
     updated_at: ISODateString;
     last_snapshot: ISODateString | null;
-    use_credits: boolean;
-    credits_used?: number;
     offline_since: ISODateString | null;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
  */
 interface APIDatabaseNetwork {
     total: string;
     now: string;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
- */
-interface APIDatabaseSnapshot {
-    id: SnowFlake;
-    resource_id: SnowFlake;
-    author_id: SnowFlake | null;
-    size: string;
-    date: ISODateString;
-}
-/**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/status
  */
 interface APIDatabaseStatus {
     id: SnowFlake;
@@ -83,11 +65,12 @@ interface APIDatabaseStatus {
     status: DatabaseStatus;
     running: boolean;
     storage: string;
-    network: APIDatabaseNetwork;
+    /** `null` when network usage is unavailable. */
+    network: APIDatabaseNetwork | null;
     uptime: number;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/allstatus
  */
 interface APIDatabaseStatusShort {
     id: SnowFlake;
@@ -97,7 +80,22 @@ interface APIDatabaseStatusShort {
     running: boolean;
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get
+ */
+interface APIDatabaseOperationResponse {
+    status: "success";
+}
+/**
+ * Client certificate for TLS connections to the database.
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/get
+ */
+interface APIDatabaseCertificate {
+    crt: string;
+    key: string;
+    pem: string;
+}
+/**
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/metrics
  */
 interface APIDatabaseMetrics {
     cpu: number;
@@ -107,10 +105,10 @@ interface APIDatabaseMetrics {
     network: number[];
 }
 /**
- * @see https://docs.vertracloud.app/api-reference/endpoint/databases
+ * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/resetpassword
  */
 interface APIDatabasePasswordReset {
     password: string;
 }
 
-export { type APIDatabase, type APIDatabaseActivity, type APIDatabaseMetrics, type APIDatabaseNetwork, type APIDatabasePasswordReset, type APIDatabaseSnapshot, type APIDatabaseStatus, type APIDatabaseStatusShort, DatabaseCluster, DatabaseStatus, DatabaseType };
+export { type APIDatabase, type APIDatabaseCertificate, type APIDatabaseMetrics, type APIDatabaseNetwork, type APIDatabaseOperationResponse, type APIDatabasePasswordReset, type APIDatabaseStatus, type APIDatabaseStatusShort, DatabaseCluster, DatabaseStatus, DatabaseType };

package/payloads/v1/database.js.map

@@ -1 +1 @@
-{"version":3,"sources":["database.ts"],"sourcesContent":["import type { ISODateString, SnowFlake, UserPlan } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport type DatabaseType = 1 | 2 | 3 | 4;\nexport const DatabaseType = {\n\tPOSTGRESQL: 1,\n\tMONGODB: 2,\n\tREDIS: 3,\n\tMYSQL: 4,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport type DatabaseStatus = \"up\" | \"down\";\nexport const DatabaseStatus = {\n\tUP: \"up\",\n\tDOWN: \"down\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/status\n */\nexport type DatabaseCluster = number;\nexport const DatabaseCluster = {\n\tUSA_1: 1,\n\tUSA_2: 2,\n\tUSA_3: 3,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseActivity {\n\tmessage: string;\n\ttimestamp: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\n\nexport interface APIDatabase {\n\tid: SnowFlake;\n\tcluster: DatabaseCluster;\n\ttype: DatabaseType;\n\tname: string;\n\tdescription: string;\n\towner_id: SnowFlake;\n\towner_plan_id: UserPlan; // Owner App Plan\n\tstatus: DatabaseStatus;\n\tram: number;\n\thost: string; // example: \"vertra-cloud-<type>-<dbId>.vertraweb.app\"\n\tport: number;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tlast_snapshot: ISODateString | null;\n\tuse_credits: boolean;\n\tcredits_used?: number;\n\toffline_since: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseNetwork {\n\ttotal: string;\n\tnow: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseSnapshot {\n\tid: SnowFlake;\n\tresource_id: SnowFlake;\n\tauthor_id: SnowFlake | null;\n\tsize: string;\n\tdate: ISODateString;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseStatus {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\tstatus: DatabaseStatus;\n\trunning: boolean;\n\tstorage: string;\n\tnetwork: APIDatabaseNetwork;\n\tuptime: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseStatusShort {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\tstorage: string;\n\trunning: boolean;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabaseMetrics {\n\tcpu: number;\n\tram: number;\n\tstorage: number;\n\tdate: ISODateString;\n\tnetwork: number[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases\n */\nexport interface APIDatabasePasswordReset {\n\tpassword: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,eAAe;AAAA,EAC3B,YAAY;AAAA,EACZ,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AACR;AAMO,IAAM,iBAAiB;AAAA,EAC7B,IAAI;AAAA,EACJ,MAAM;AACP;AAMO,IAAM,kBAAkB;AAAA,EAC9B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;","names":[]}
+{"version":3,"sources":["database.ts"],"sourcesContent":["import type { ISODateString, SnowFlake, UserPlan } from \"../../v1\";\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport type DatabaseType = 1 | 2 | 3 | 4;\nexport const DatabaseType = {\n\tPOSTGRESQL: 1,\n\tMONGODB: 2,\n\tREDIS: 3,\n\tMYSQL: 4,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport type DatabaseStatus = \"up\" | \"down\";\nexport const DatabaseStatus = {\n\tUP: \"up\",\n\tDOWN: \"down\",\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport type DatabaseCluster = number;\nexport const DatabaseCluster = {\n\tUSA_1: 1,\n\tUSA_2: 2,\n\tUSA_3: 3,\n} as const;\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\n\nexport interface APIDatabase {\n\tid: SnowFlake;\n\tcluster: DatabaseCluster;\n\ttype: DatabaseType;\n\tname: string;\n\tdescription: string;\n\towner_id: SnowFlake;\n\towner_plan_id: UserPlan; // Owner's plan\n\tstatus: DatabaseStatus;\n\tram: number;\n\thost: string; // example: \"vertra-cloud-<type>-<dbId>.vertraweb.app\"\n\tport: number;\n\tcreated_at: ISODateString;\n\tupdated_at: ISODateString;\n\tlast_snapshot: ISODateString | null;\n\toffline_since: ISODateString | null;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport interface APIDatabaseNetwork {\n\ttotal: string;\n\tnow: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/status\n */\nexport interface APIDatabaseStatus {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\tstatus: DatabaseStatus;\n\trunning: boolean;\n\tstorage: string;\n\t/** `null` when network usage is unavailable. */\n\tnetwork: APIDatabaseNetwork | null;\n\tuptime: number;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/allstatus\n */\nexport interface APIDatabaseStatusShort {\n\tid: SnowFlake;\n\tcpu: string;\n\tram: string;\n\tstorage: string;\n\trunning: boolean;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/get\n */\nexport interface APIDatabaseOperationResponse {\n\tstatus: \"success\";\n}\n\n/**\n * Client certificate for TLS connections to the database.\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/get\n */\nexport interface APIDatabaseCertificate {\n\tcrt: string;\n\tkey: string;\n\tpem: string;\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/metrics\n */\nexport interface APIDatabaseMetrics {\n\tcpu: number;\n\tram: number;\n\tstorage: number;\n\tdate: ISODateString;\n\tnetwork: number[];\n}\n\n/**\n * @see https://docs.vertracloud.app/api-reference/endpoint/databases/credentials/resetpassword\n */\nexport interface APIDatabasePasswordReset {\n\tpassword: string;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMO,IAAM,eAAe;AAAA,EAC3B,YAAY;AAAA,EACZ,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AACR;AAMO,IAAM,iBAAiB;AAAA,EAC7B,IAAI;AAAA,EACJ,MAAM;AACP;AAMO,IAAM,kBAAkB;AAAA,EAC9B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;","names":[]}

package/payloads/v1/github.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A file read from a GitHub repository, with secrets redacted.
+ *
+ * Secret values found in the file are redacted before the content is returned.
+ *
+ * @see https://docs.vertracloud.app/api-reference/endpoint/github/file
+ */
+interface APIGitHubFile {
+    path: string;
+    content: string;
+    /** Size in bytes of the original file in the repository, before redaction. */
+    size: number;
+    /**
+     * Always `false` today: files above the size limit are rejected with `FILE_TOO_LARGE` instead
+     * of being truncated. Reserved so truncation can be added later without a breaking change.
+     */
+    truncated: boolean;
+}
+
+export type { APIGitHubFile };

package/{rest/v1/credits.js → payloads/v1/github.js}

@@ -13,7 +13,7 @@ var __copyProps = (to, from, except, desc) => {
 };
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
-// rest/v1/credits.ts
-var credits_exports = {};
-module.exports = __toCommonJS(credits_exports);
-//# sourceMappingURL=credits.js.map
+// payloads/v1/github.ts
+var github_exports = {};
+module.exports = __toCommonJS(github_exports);
+//# sourceMappingURL=github.js.map

package/payloads/v1/github.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["github.ts"],"sourcesContent":["/**\n * A file read from a GitHub repository, with secrets redacted.\n *\n * Secret values found in the file are redacted before the content is returned.\n *\n * @see https://docs.vertracloud.app/api-reference/endpoint/github/file\n */\nexport interface APIGitHubFile {\n\tpath: string;\n\tcontent: string;\n\t/** Size in bytes of the original file in the repository, before redaction. */\n\tsize: number;\n\t/**\n\t * Always `false` today: files above the size limit are rejected with `FILE_TOO_LARGE` instead\n\t * of being truncated. Reserved so truncation can be added later without a breaking change.\n\t */\n\ttruncated: boolean;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/payloads/v1/github.mjs

@@ -0,0 +1 @@
+//# sourceMappingURL=github.mjs.map