feat: Export types (#19)

* feat: export types * fix: add missing types * fix: tidy up exported types
tursodatabase · May 16, 2024 · 88420d5 · 88420d5
1 parent f493b14
commit 88420d5
Show file tree

Hide file tree

Showing 6 changed files with 90 additions and 24 deletions.
diff --git a/src/api-token.ts b/src/api-token.ts
@@ -6,6 +6,19 @@ export interface ApiToken {
   name: string;
 }
 
+export interface ApiTokenWithJWT extends ApiToken {
+  token: string;
+}
+
+export interface RevokedApiToken {
+  token: string;
+}
+
+export interface ApiTokenValidation {
+  valid: boolean;
+  expiry: number;
+}
+
 export class ApiTokenClient {
   constructor(private config: TursoConfig) {}
 
@@ -18,8 +31,8 @@ export class ApiTokenClient {
     return response.tokens ?? [];
   }
 
-  async create(name: string) {
-    const response = await TursoClient.request<ApiToken & { token: string }>(
+  async create(name: string): Promise<ApiTokenWithJWT> {
+    const response = await TursoClient.request<ApiTokenWithJWT>(
       `auth/api-tokens/${name}`,
       this.config,
       {
@@ -33,8 +46,8 @@ export class ApiTokenClient {
     return response;
   }
 
-  async revoke(name: string) {
-    const response = await TursoClient.request<{ token: string }>(
+  async revoke(name: string): Promise<RevokedApiToken> {
+    const response = await TursoClient.request<RevokedApiToken>(
       `auth/api-tokens/${name}`,
       this.config,
       {
@@ -45,7 +58,7 @@ export class ApiTokenClient {
     return response;
   }
 
-  async validate(token: string): Promise<{ valid: boolean; expiry: number }> {
+  async validate(token: string): Promise<ApiTokenValidation> {
     const response = await TursoClient.request<{ exp: number }>(
       "auth/api-tokens/validate",
       this.config,

diff --git a/src/database.ts b/src/database.ts
@@ -29,19 +29,19 @@ export interface ApiCreateDatabaseResponse {
   Name: string;
 }
 
-export interface DatabaseCreateResponse {
+export interface CreatedDatabase {
   name: string;
   id: string;
   hostname: string;
 }
 
-export interface DatabaseInstanceUsageDetail {
+interface DatabaseInstanceUsageDetail {
   rows_read: number;
   rows_written: number;
   storage_bytes: number;
 }
 
-export interface DatabaseInstanceUsage {
+interface DatabaseInstanceUsage {
   uuid: string;
   usage: DatabaseInstanceUsageDetail;
 }
@@ -70,6 +70,14 @@ export interface DatabaseInstance {
   hostname: string;
 }
 
+export interface DeletedDatabase {
+  database: string;
+}
+
+export interface DatabaseToken {
+  jwt: string;
+}
+
 type MultiDBSchemaOptions =
   | { is_schema: boolean; schema?: never }
   | { is_schema?: never; schema: string }
@@ -118,7 +126,7 @@ export class DatabaseClient {
         timestamp?: string | Date;
       };
     } & MultiDBSchemaOptions
-  ): Promise<DatabaseCreateResponse> {
+  ): Promise<CreatedDatabase> {
     if (hasIsSchemaOption(options) && hasSchemaOption(options)) {
       throw new Error("'is_schema' and 'schema' cannot both be provided");
     }
@@ -163,7 +171,7 @@ export class DatabaseClient {
   }
 
   async delete(dbName: string) {
-    const response = await TursoClient.request<{ database: string }>(
+    const response = await TursoClient.request<DeletedDatabase>(
       `organizations/${this.config.org}/databases/${dbName}`,
       this.config,
       {
@@ -205,7 +213,7 @@ export class DatabaseClient {
       expiration: string;
       authorization: "read-only" | "full-access";
     }
-  ) {
+  ): Promise<DatabaseToken> {
     const queryParams = new URLSearchParams();
 
     if (options?.expiration) {
@@ -216,7 +224,7 @@ export class DatabaseClient {
       queryParams.set("authorization", options.authorization);
     }
 
-    const response = await TursoClient.request<{ jwt: string }>(
+    const response = await TursoClient.request<DatabaseToken>(
       `organizations/${this.config.org}/databases/${dbName}/auth/tokens?${queryParams}`,
       this.config,
       {
@@ -286,9 +294,7 @@ export class DatabaseClient {
     };
   }
 
-  private formatCreateResponse(
-    db: ApiCreateDatabaseResponse
-  ): DatabaseCreateResponse {
+  private formatCreateResponse(db: ApiCreateDatabaseResponse): CreatedDatabase {
     return {
       id: db.DbId,
       hostname: db.Hostname,

diff --git a/src/group.ts b/src/group.ts
@@ -20,6 +20,10 @@ export type ExtensionType =
   | "uuid"
   | "regexp";
 
+export interface GroupToken {
+  jwt: string;
+}
+
 export class GroupClient {
   constructor(private config: TursoConfig) {}
 
@@ -113,7 +117,7 @@ export class GroupClient {
       expiration: string;
       authorization: "read-only" | "full-access";
     }
-  ) {
+  ): Promise<GroupToken> {
     const queryParams = new URLSearchParams();
 
     if (options?.expiration) {
@@ -124,7 +128,7 @@ export class GroupClient {
       queryParams.set("authorization", options.authorization);
     }
 
-    const response = await TursoClient.request<{ jwt: string }>(
+    const response = await TursoClient.request<GroupToken>(
       `organizations/${this.config.org}/groups/${groupName}/auth/tokens?${queryParams}`,
       this.config,
       {

diff --git a/src/index.ts b/src/index.ts
@@ -1,3 +1,33 @@
 import "whatwg-fetch";
 
 export { createClient } from "./client";
+
+export type {
+  ApiToken,
+  ApiTokenWithJWT,
+  RevokedApiToken,
+  ApiTokenValidation,
+} from "./api-token";
+export type { TursoClientError } from "./client";
+export type { TursoConfig } from "./config";
+export type {
+  Database,
+  CreatedDatabase,
+  DatabaseUsage,
+  InstanceUsages,
+  TotalUsage,
+  DatabaseInstance,
+  DeletedDatabase,
+  DatabaseToken,
+} from "./database";
+export type { Group, ExtensionType, GroupToken } from "./group";
+export type { LocationKeys, Location, ClosestLocation } from "./location";
+export type {
+  Organization,
+  OrganizationMember,
+  OrganizationInvite,
+  Invoice,
+  OrganizationMemberRole,
+  OrganizationAddedMember,
+  OrganizationRemovedMember,
+} from "./organization";
diff --git a/src/location.ts b/src/location.ts
@@ -40,6 +40,11 @@ export type Location = {
   [K in keyof LocationKeys]: { code: K; description: LocationKeys[K] };
 }[keyof LocationKeys];
 
+export interface ClosestLocation {
+  server: keyof LocationKeys;
+  client: keyof LocationKeys;
+}
+
 export class LocationClient {
   constructor(private config: TursoConfig) {}
 
@@ -58,10 +63,7 @@ export class LocationClient {
     }));
   }
 
-  async closest(): Promise<{
-    server: keyof LocationKeys;
-    client: keyof LocationKeys;
-  }> {
+  async closest(): Promise<ClosestLocation> {
     return fetch("https://region.turso.io/").then((res) => res.json());
   }
 }
diff --git a/src/organization.ts b/src/organization.ts
@@ -37,6 +37,17 @@ export interface Invoice {
   invoice_pdf: string;
 }
 
+export type OrganizationMemberRole = "admin" | "member";
+
+export interface OrganizationAddedMember {
+  member: string;
+  role: OrganizationMemberRole;
+}
+
+export interface OrganizationRemovedMember {
+  member: string;
+}
+
 export class OrganizationClient {
   constructor(private config: TursoConfig) {}
 
@@ -80,7 +91,7 @@ export class OrganizationClient {
   async addMember(
     username: string,
     role?: "admin" | "member"
-  ): Promise<{ member: string; role: "admin" | "member" }> {
+  ): Promise<OrganizationAddedMember> {
     return TursoClient.request(
       `organizations/${this.config.org}/members/${username}`,
       this.config,
@@ -94,7 +105,7 @@ export class OrganizationClient {
     );
   }
 
-  async removeMember(username: string): Promise<{ member: string }> {
+  async removeMember(username: string): Promise<OrganizationRemovedMember> {
     return TursoClient.request(
       `organizations/${this.config.org}/members/${username}`,
       this.config,
@@ -106,7 +117,7 @@ export class OrganizationClient {
 
   async inviteUser(
     email: string,
-    role?: "admin" | "member"
+    role?: OrganizationMemberRole
   ): Promise<OrganizationInvite> {
     const response = await TursoClient.request<{ invited: OrganizationInvite }>(
       `organizations/${this.config.org}/invites`,