infrahub-sdk 0.0.1

package/src/index.ts

@@ -0,0 +1,144 @@
+// Utility type for safe result pattern
+export type SafeResult<T> =
+  | { data: T; error: undefined }
+  | { data: undefined; error: Error };
+
+import createClient from 'openapi-fetch';
+import { GraphQLClient, Variables } from 'graphql-request';
+import type { paths } from './types';
+import { InfrahubBranchManager } from './branch';
+
+// Re-export gql and all exports from graphql-request
+export * from 'graphql-request';
+
+export * from './types';
+
+export interface InfrahubClientOptions {
+  address: string;
+  token?: string;
+  branch?: string;
+}
+
+const DEFAULT_BRANCH_NAME = 'main';
+
+export class InfrahubClient {
+  public rest: ReturnType<typeof createClient<paths>>;
+  private graphqlClient: GraphQLClient;
+  private baseUrl: string;
+  private token?: string;
+  public defaultBranch: string;
+  public branch: InfrahubBranchManager;
+
+  constructor(options: InfrahubClientOptions) {
+    this.baseUrl = options.address;
+    this.token = options.token;
+    this.defaultBranch = options.branch || DEFAULT_BRANCH_NAME;
+    this.branch = new InfrahubBranchManager(this);
+
+    // Initialize the openapi-fetch client
+
+    this.rest = createClient<paths>({
+      baseUrl: this.baseUrl
+    });
+
+    // Use middleware to dynamically add the auth token to every REST request.
+    this.rest.use({
+      onRequest: (req) => {
+        req.headers.set('content-type', 'application/json');
+        if (this.token) {
+          req.headers.set('X-INFRAHUB-KEY', this.token);
+        }
+        return req;
+      }
+    });
+
+    // Initialize the GraphQL client with the default branch endpoint
+    this.graphqlClient = new GraphQLClient(
+      this._graphqlUrl(this.defaultBranch)
+    );
+    this.graphqlClient.setHeaders({
+      'Content-Type': 'application/json'
+    });
+
+    if (this.token) {
+      this.setAuthToken(this.token);
+    }
+  }
+
+  /**
+   * Executes a GraphQL query or mutation and returns a discriminated union for ergonomic error handling.
+   * @param query The GraphQL query string.
+   * @param variables Optional variables for the query.
+   * @param branchName Optional branch name to target a specific branch.
+   */
+  public async safeExecuteGraphQL<
+    TData = any,
+    TVariables extends Variables = Variables
+  >(
+    query: string,
+    variables?: TVariables,
+    branchName?: string
+  ): Promise<SafeResult<TData>> {
+    try {
+      const data = await this.executeGraphQL<TData, TVariables>(
+        query,
+        variables,
+        branchName
+      );
+      return { data, error: undefined };
+    } catch (error) {
+      if (error instanceof Error) {
+        return { data: undefined, error };
+      }
+      return { data: undefined, error: new Error('Unknown error') };
+    }
+  }
+
+  /**
+   * Returns the GraphQL endpoint URL, optionally for a specific branch.
+   * @param branchName Optional branch name. Defaults to this.defaultBranch if not provided.
+   */
+  private _graphqlUrl(branchName?: string): string {
+    let url = `${this.baseUrl}/graphql`;
+    const branch = branchName || this.defaultBranch;
+    if (branch) {
+      url += `/${branch}`;
+    }
+    return url;
+  }
+
+  public setAuthToken(token: string) {
+    this.token = token;
+    this.graphqlClient.setHeaders({
+      'X-INFRAHUB-KEY': token,
+      'Content-Type': 'application/json'
+    });
+  }
+
+  /**
+   * Executes a GraphQL query or mutation against the Infrahub API.
+   * @param query The GraphQL query string.
+   * @param variables Optional variables for the query.
+   * @param branchName Optional branch name to target a specific branch.
+   */
+  public async executeGraphQL<
+    TData = any,
+    TVariables extends Variables = Variables
+  >(
+    query: string,
+    variables?: TVariables,
+    branchName?: string
+  ): Promise<TData> {
+    try {
+      this.graphqlClient.setEndpoint(this._graphqlUrl(branchName));
+      this.graphqlClient.setHeaders({
+        'X-INFRAHUB-KEY': this.token || '',
+        'Content-Type': 'application/json'
+      });
+      return await (this.graphqlClient.request as any)(query, variables);
+    } catch (error) {
+      console.error('Error executing GraphQL query:', error);
+      throw error;
+    }
+  }
+}