feat: making schema's possible from request types (#180)

* feat: any typing of request options renamed to schema for schema type generation

* feat: rename request options types to schema

* feat: remove json from this repo

Author: lukeocodes

package-lock.json

@@ -4,9 +4,16 @@ import type { DeepgramClientOptions } from "./lib/types";
 /**
  * Creates a new Deepgram Client.
  */
-export const createClient = (apiKey: string, options?: DeepgramClientOptions): DeepgramClient => {
+const createClient = (apiKey: string, options?: DeepgramClientOptions): DeepgramClient => {
   return new DeepgramClient(apiKey, options);
 };
 
+export { createClient, DeepgramClient };
+
+/**
+ * Helpful exports.
+ */
 export * from "./lib/types";
 export * from "./lib/enums";
+export * from "./lib/constants";
+export * from "./lib/errors";

src/index.ts

@@ -0,0 +1,5 @@
+export interface CreateOnPremCredentialsSchema extends Record<string, unknown> {
+  comment?: string;
+  scopes?: string[];
+  provider?: string;
+}

src/lib/types/CreateOnPremCredentialsOptions.ts

@@ -1,4 +1,4 @@
-export type CreateProjectKeyOptions = ExpirationOptions | TtlOptions;
+export type CreateProjectKeySchema = ExpirationOptions | TtlOptions;
 
 interface ExpirationOptions extends CommonOptions {
   expiration_date?: string;

src/lib/types/CreateOnPremCredentialsSchema.ts

@@ -0,0 +1,4 @@
+export interface GetProjectUsageFieldsSchema extends Record<string, unknown> {
+  start?: string;
+  end: string;
+}

src/lib/types/CreateProjectKeyOptions.ts renamed to src/lib/types/CreateProjectKeySchema.ts

@@ -0,0 +1,6 @@
+export interface GetProjectUsageRequestsSchema extends Record<string, unknown> {
+  start?: string;
+  end?: string;
+  limit?: number;
+  status?: string;
+}

src/lib/types/GetProjectUsageFieldsOptions.ts

@@ -1,4 +1,4 @@
-export interface GetProjectUsageSummaryOptions extends Record<string, unknown> {
+export interface GetProjectUsageSummarySchema extends Record<string, unknown> {
   start?: string;
   end: string;
   accessor?: string;

src/lib/types/GetProjectUsageFieldsSchema.ts

@@ -0,0 +1,4 @@
+export interface SendProjectInviteSchema extends Record<string, unknown> {
+  email: string;
+  scope: string;
+}

src/lib/types/GetProjectUsageRequestsOptions.ts

@@ -1,7 +1,7 @@
 /**
  * Options for transcription
  */
-interface TranscriptionOptions extends Record<string, unknown> {
+interface TranscriptionSchema extends Record<string, unknown> {
   /**
    * @see https://developers.deepgram.com/docs/model
    */
@@ -86,7 +86,7 @@ interface TranscriptionOptions extends Record<string, unknown> {
   [key: string]: unknown;
 }
 
-interface PrerecordedOptions extends TranscriptionOptions {
+interface PrerecordedSchema extends TranscriptionSchema {
   /**
    * @see https://developers.deepgram.com/docs/detect-entities
    */
@@ -128,7 +128,7 @@ interface PrerecordedOptions extends TranscriptionOptions {
   utt_split?: number;
 }
 
-interface LiveOptions extends TranscriptionOptions {
+interface LiveSchema extends TranscriptionSchema {
   /**
    * @see https://developers.deepgram.com/docs/channels
    */
@@ -155,4 +155,4 @@ interface LiveOptions extends TranscriptionOptions {
   interim_results?: boolean;
 }
 
-export type { TranscriptionOptions, PrerecordedOptions, LiveOptions };
+export type { TranscriptionSchema, PrerecordedSchema, LiveSchema };

src/lib/types/GetProjectUsageRequestsSchema.ts

@@ -0,0 +1,3 @@
+export interface UpdateProjectMemberScopeSchema {
+  scope: string;
+}

src/lib/types/GetProjectUsageSummaryOptions.ts renamed to src/lib/types/GetProjectUsageSummarySchema.ts

@@ -0,0 +1,5 @@
+export interface UpdateProjectSchema extends Record<string, unknown> {
+  name?: string;
+  company?: string;
+  [key: string]: unknown;
+}

src/lib/types/SendProjectInviteOptions.ts

@@ -1,6 +1,6 @@
 export type { AsyncPrerecordedResponse } from "./AsyncPrerecordedResponse";
-export type { CreateOnPremCredentialsOptions } from "./CreateOnPremCredentialsOptions";
-export type { CreateProjectKeyOptions } from "./CreateProjectKeyOptions";
+export type { CreateOnPremCredentialsSchema } from "./CreateOnPremCredentialsSchema";
+export type { CreateProjectKeySchema } from "./CreateProjectKeySchema";
 export type { CreateProjectKeyResponse } from "./CreateProjectKeyResponse";
 export type { DeepgramClientOptions } from "./DeepgramClientOptions";
 export type { DeepgramResponse } from "./DeepgramResponse";
@@ -15,14 +15,14 @@ export type { GetProjectMemberScopesResponse } from "./GetProjectMemberScopesRes
 export type { GetProjectMembersResponse } from "./GetProjectMembersResponse";
 export type { GetProjectResponse } from "./GetProjectResponse";
 export type { GetProjectsResponse } from "./GetProjectsResponse";
-export type { GetProjectUsageFieldsOptions } from "./GetProjectUsageFieldsOptions";
+export type { GetProjectUsageFieldsSchema } from "./GetProjectUsageFieldsSchema";
 export type { GetProjectUsageFieldsResponse } from "./GetProjectUsageFieldsResponse";
 export type {
   GetProjectUsageRequestResponse,
   GetProjectUsageRequestsResponse,
 } from "./GetProjectUsageRequestsResponse";
-export type { GetProjectUsageRequestsOptions } from "./GetProjectUsageRequestsOptions";
-export type { GetProjectUsageSummaryOptions } from "./GetProjectUsageSummaryOptions";
+export type { GetProjectUsageRequestsSchema } from "./GetProjectUsageRequestsSchema";
+export type { GetProjectUsageSummarySchema } from "./GetProjectUsageSummarySchema";
 export type { GetProjectUsageSummaryResponse } from "./GetProjectUsageSummaryResponse";
 export type {
   ListOnPremCredentialsResponse,
@@ -33,9 +33,9 @@ export type { LiveMetadataEvent } from "./LiveMetadataEvent";
 export type { LiveTranscriptionEvent } from "./LiveTranscriptionEvent";
 export type { MessageResponse } from "./MessageResponse";
 export type { FileSource, PrerecordedSource, UrlSource } from "./PrerecordedSource";
-export type { SendProjectInviteOptions } from "./SendProjectInviteOptions";
+export type { SendProjectInviteSchema } from "./SendProjectInviteSchema";
 export type { SyncPrerecordedResponse } from "./SyncPrerecordedResponse";
-export type { TranscriptionOptions, PrerecordedOptions, LiveOptions } from "./TranscriptionOptions";
-export type { UpdateProjectMemberScopeOptions } from "./UpdateProjectMemberScopeOptions";
-export type { UpdateProjectOptions } from "./UpdateProjectOptions";
+export type { TranscriptionSchema, PrerecordedSchema, LiveSchema } from "./TranscriptionSchema";
+export type { UpdateProjectMemberScopeSchema } from "./UpdateProjectMemberScopeSchema";
+export type { UpdateProjectSchema } from "./UpdateProjectSchema";
 export type { VoidResponse } from "./VoidResponse";

src/lib/types/SendProjectInviteSchema.ts

@@ -1,6 +1,6 @@
 import { PrerecordedClient } from "./PrerecordedClient";
 import { LiveClient } from "./LiveClient";
-import { LiveOptions } from "../lib/types";
+import { LiveSchema } from "../lib/types";
 
 export class ListenClient {
   protected baseUrl: URL;
@@ -17,7 +17,7 @@ export class ListenClient {
     return new PrerecordedClient(this.baseUrl, this.headers, this.key);
   }
 
-  public live(options: LiveOptions, endpoint = "v1/listen") {
+  public live(options: LiveSchema, endpoint = "v1/listen") {
     return new LiveClient(this.baseUrl, this.key, options, endpoint);
   }
 }

src/lib/types/TranscriptionOptions.ts renamed to src/lib/types/TranscriptionSchema.ts

@@ -3,7 +3,7 @@ import { appendSearchParams, isBrowser } from "../lib/helpers";
 import WebSocket from "modern-isomorphic-ws";
 import { LiveConnectionState, LiveTranscriptionEvents } from "../lib/enums";
 import type {
-  LiveOptions,
+  LiveSchema,
   LiveConfigOptions,
   LiveMetadataEvent,
   LiveTranscriptionEvent,
@@ -13,10 +13,10 @@ import { DEFAULT_HEADERS } from "../lib/constants";
 export class LiveClient extends EventEmitter {
   private _socket: WebSocket;
 
-  constructor(baseUrl: URL, apiKey: string, options: LiveOptions, endpoint = "v1/listen") {
+  constructor(baseUrl: URL, apiKey: string, options: LiveSchema, endpoint = "v1/listen") {
     super();
 
-    const transcriptionOptions: LiveOptions = { ...{}, ...options };
+    const transcriptionOptions: LiveSchema = { ...{}, ...options };
     const url = new URL(endpoint, baseUrl);
     url.protocol = url.protocol.toLowerCase().replace(/(http)(s)?/gi, "ws$2");
     appendSearchParams(url.searchParams, transcriptionOptions);