infrahub-sdk 0.0.2 → 0.0.5

package/dist/types.js

@@ -0,0 +1,6 @@
+"use strict";
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/auth.js

@@ -0,0 +1 @@
+"use strict";

package/dist/utils/error-handling.js

@@ -0,0 +1 @@
+"use strict";

package/dist/utils/index.js

@@ -0,0 +1 @@
+"use strict";

package/dist/utils/validation.js

@@ -0,0 +1 @@
+"use strict";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "infrahub-sdk",
-  "version": "0.0.2",
+  "version": "0.0.5",
   "description": "A client SDK for the Infrahub API.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -17,8 +17,10 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
+    "@graphql-codegen/typed-document-node": "^5.1.2",
     "graphql-request": "^6.1.0",
-    "openapi-fetch": "^0.9.4"
+    "openapi-fetch": "^0.9.4",
+    "openapi-typescript-fetch": "^2.2.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.31.0",

package/src/branch.ts

@@ -0,0 +1,130 @@
+import { InfrahubClient, gql } from './index';
+import { Mutation } from './graphql';
+import {
+  BranchAllQuery,
+  BranchResponse,
+  BranchGetQuery,
+  BranchCreateInput
+} from './graphql/branch';
+
+export class BranchNotFoundError extends Error {
+  constructor(identifier: string) {
+    super(`Branch not found: ${identifier}`);
+    this.name = 'BranchNotFoundError';
+  }
+}
+
+const MUTATION_QUERY_TASK = { ok: null, task: { id: null } };
+const MUTATION_QUERY_DATA = {
+  ok: null,
+  object: {
+    id: null,
+    name: null,
+    description: null,
+    origin_branch: null,
+    branched_from: null,
+    is_default: null,
+    sync_with_git: null,
+    has_schema_changes: null
+  }
+};
+
+// InfrahubBranchManager class to manage branches via GraphQL
+export class InfrahubBranchManager {
+  private client: InfrahubClient;
+
+  constructor(client: InfrahubClient) {
+    this.client = client;
+  }
+
+  /**
+   * Fetches all branches using GraphQL and returns an object mapping branch names to branch data.
+   */
+  async all(): Promise<Record<string, BranchResponse>> {
+    const response = await this.client.executeGraphQL<
+      {
+        Branch: BranchResponse[];
+      },
+      Record<string, never>
+    >(BranchAllQuery);
+    const branches: BranchResponse[] = response.Branch || [];
+    const result: Record<string, BranchResponse> = {};
+    branches.forEach((branch) => {
+      result[branch.name] = branch;
+    });
+    return result;
+  }
+
+  /**
+   * Fetches a specific branch by name.
+   * @param branchName The name of the branch to fetch.
+   */
+  async get(branchName: string): Promise<BranchResponse | null> {
+    const response = await this.client.executeGraphQL<
+      {
+        Branch: BranchResponse[];
+      },
+      Record<string, any>
+    >(BranchGetQuery, {
+      name: branchName
+    });
+    const branchArr: BranchResponse[] = response.Branch || [];
+    if (!branchArr.length) {
+      throw new BranchNotFoundError(branchName);
+    }
+    return branchArr[0];
+  }
+
+  async create(input: BranchCreateInput): Promise<BranchResponse> {
+    const inputData = {
+      background_execution: input.wait_until_completion,
+      data: {
+        name: input.name,
+        description: input.description,
+        sync_with_git: input.sync_with_git
+      }
+    };
+
+    // set mutation query to MUTATION_QUERY_TASK if brackground_execution is true
+    const mutationQuery = input.wait_until_completion
+      ? MUTATION_QUERY_TASK
+      : MUTATION_QUERY_DATA;
+
+    const mutation = new Mutation({
+      mutation: 'BranchCreate',
+      inputData: inputData,
+      query: mutationQuery,
+      name: 'CreateBranch'
+    });
+
+    console.log(mutation.render());
+
+    const response = await this.client.executeGraphQL(mutation.render());
+    // Adjust the response path as needed based on your API
+    const branchData =
+      response.BranchCreate?.object || response.BranchCreate?.task || null;
+    if (!branchData) {
+      throw new Error('Branch creation failed');
+    }
+    return branchData as BranchResponse;
+  }
+
+  async delete(branchName: string): Promise<boolean> {
+    const inputData = {
+      data: {
+        name: branchName
+      }
+    };
+    const mutation = new Mutation({
+      mutation: 'BranchDelete',
+      inputData: inputData,
+      query: { ok: null },
+      name: 'DeleteBranch'
+    });
+    const response = await this.client.executeGraphQL(mutation.render(), {
+      input: inputData
+    });
+    console.log(response);
+    return !!(response.BranchDelete && response.BranchDelete.ok);
+  }
+}

package/src/graphql/branch.ts

@@ -0,0 +1,61 @@
+import { gql } from 'graphql-request';
+import { parse } from 'graphql';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+
+const BranchAllQueryDocument = parse(gql`
+  query BranchAllQuery {
+    Branch {
+      id
+      name
+      description
+      origin_branch
+      branched_from
+      is_default
+      sync_with_git
+      has_schema_changes
+    }
+  }
+`);
+
+const BranchGetQueryDocument = parse(gql`
+  query BranchGetQuery($name: String!) {
+    Branch(name: $name) {
+      id
+      name
+      description
+      origin_branch
+      branched_from
+      is_default
+      sync_with_git
+      has_schema_changes
+    }
+  }
+`);
+
+export interface BranchCreateInput {
+  name: string;
+  description?: string;
+  sync_with_git?: boolean;
+  wait_until_completion?: boolean;
+}
+
+export interface BranchResponse {
+  id: string;
+  name: string;
+  description: string;
+  origin_branch: string;
+  branched_from: string;
+  is_default: boolean;
+  sync_with_git: boolean;
+  has_schema_changes: boolean;
+}
+
+export const BranchAllQuery: TypedDocumentNode<
+  { Branch: BranchResponse[] },
+  Record<any, never>
+> = BranchAllQueryDocument;
+
+export const BranchGetQuery: TypedDocumentNode<
+  { Branch: BranchResponse[] },
+  Record<any, any>
+> = BranchGetQueryDocument;

package/src/graphql/client.ts

@@ -0,0 +1,158 @@
+import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { parse } from 'graphql';
+import { gql } from 'graphql-request';
+import { InfrahubClient } from '..';
+
+const InfrahubInfoDocument = parse(gql`
+  query InfrahubInfo {
+    InfrahubInfo {
+      version
+    }
+  }
+`);
+
+export interface InfrahubInfoResponse {
+  InfrahubInfo: {
+    version: string;
+  };
+}
+
+export const InfrahubInfoQuery: TypedDocumentNode<
+  InfrahubInfoResponse,
+  Record<any, never>
+> = InfrahubInfoDocument;
+
+const InfrahubUserDocument = parse(gql`
+  query GET_PROFILE_DETAILS {
+    AccountProfile {
+      id
+      display_label
+      account_type {
+        value
+        __typename
+        updated_at
+      }
+      status {
+        label
+        value
+        updated_at
+        __typename
+      }
+      description {
+        value
+        updated_at
+        __typename
+      }
+      label {
+        value
+        updated_at
+        __typename
+      }
+      member_of_groups {
+        count
+        edges {
+          node {
+            display_label
+            group_type {
+              value
+            }
+            ... on CoreAccountGroup {
+              id
+              roles {
+                count
+                edges {
+                  node {
+                    permissions {
+                      count
+                      edges {
+                        node {
+                          display_label
+                          identifier {
+                            value
+                          }
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+              display_label
+            }
+          }
+        }
+      }
+      __typename
+      name {
+        value
+        updated_at
+        __typename
+      }
+    }
+  }
+`);
+
+export interface InfrahubUserResponse {
+  AccountProfile: {
+    id: string;
+    display_label: string;
+    account_type: {
+      value: string;
+      __typename: string;
+      updated_at: string;
+    };
+    status: {
+      label: string;
+      value: string;
+      updated_at: string;
+      __typename: string;
+    };
+    description: {
+      value: string;
+      updated_at: string;
+      __typename: string;
+    };
+    label: {
+      value: string;
+      updated_at: string;
+      __typename: string;
+    };
+    member_of_groups: {
+      count: number;
+      edges: Array<{
+        node: {
+          display_label: string;
+          group_type: { value: string };
+          id?: string; // Optional for CoreAccountGroup
+          roles?: {
+            count: number;
+            edges: Array<{
+              node: {
+                permissions?: {
+                  count: number;
+                  edges: Array<{
+                    node: {
+                      display_label: string;
+                      identifier?: { value: string };
+                    };
+                  }>;
+                };
+              };
+            }>;
+          };
+        };
+      }>;
+      __typename?: string; // Optional, depending on the API response
+    };
+    name: {
+      value: string;
+      updated_at: string;
+      __typename?: string; // Optional, depending on the API response
+    };
+  };
+}
+
+export const InfrahubUserQuery: TypedDocumentNode<
+  InfrahubUserResponse,
+  Record<any, never>
+> = InfrahubUserDocument;
+

package/src/graphql.ts

@@ -0,0 +1,266 @@
+export type VariableType =
+  | string
+  | number
+  | boolean
+  | null
+  | undefined
+  | VariableType[]
+  | Record<string, any>;
+
+export function convertToGraphqlAsString(
+  value: VariableType,
+  convertEnum: boolean = false
+): string {
+  if (typeof value === 'string' && value.startsWith('$')) {
+    return value;
+  }
+  if (
+    typeof value === 'object' &&
+    value &&
+    'constructor' in value &&
+    value.constructor.name === 'Enum'
+  ) {
+    // TypeScript enums are not runtime objects, so you may need to handle this differently
+    return convertEnum
+      ? convertToGraphqlAsString((value as any).value, true)
+      : (value as any).name;
+  }
+  if (typeof value === 'string') {
+    return `"${value}"`;
+  }
+  if (typeof value === 'boolean') {
+    return value ? 'true' : 'false';
+  }
+  if (Array.isArray(value)) {
+    const valuesAsString = value.map((item) =>
+      convertToGraphqlAsString(item, convertEnum)
+    );
+    return `[${valuesAsString.join(', ')}]`;
+  }
+  if (typeof value === 'object' && value !== null) {
+    const entries = Object.entries(value).map(
+      ([key, val]) => `${key}: ${convertToGraphqlAsString(val, convertEnum)}`
+    );
+    return `{ ${entries.join(', ')} }`;
+  }
+  return String(value);
+}
+
+const VARIABLE_TYPE_MAPPING: [any, string][] = [
+  [String, 'String!'],
+  [Number, 'Int!'],
+  [Boolean, 'Boolean!']
+];
+
+export function renderVariablesToString(data: Record<string, any>): string {
+  const varsDict: Record<string, string> = {};
+  for (const [key, value] of Object.entries(data)) {
+    for (const [classType, varString] of VARIABLE_TYPE_MAPPING) {
+      if (value === classType) {
+        varsDict[`$${key}`] = varString;
+      }
+    }
+  }
+  return Object.entries(varsDict)
+    .map(([key, value]) => `${key}: ${value}`)
+    .join(', ');
+}
+
+export function renderQueryBlock(
+  data: Record<string, any>,
+  offset: number = 4,
+  indentation: number = 4,
+  convertEnum: boolean = false
+): string[] {
+  const FILTERS_KEY = '@filters';
+  const ALIAS_KEY = '@alias';
+  const KEYWORDS_TO_SKIP = [FILTERS_KEY, ALIAS_KEY];
+
+  const offsetStr = ' '.repeat(offset);
+  const lines: string[] = [];
+  for (const [key, value] of Object.entries(data)) {
+    if (KEYWORDS_TO_SKIP.includes(key)) continue;
+    if (value === null || value === undefined) {
+      lines.push(`${offsetStr}${key}`);
+    } else if (
+      typeof value === 'object' &&
+      value !== null &&
+      Object.keys(value).length === 1 &&
+      value[ALIAS_KEY]
+    ) {
+      lines.push(`${offsetStr}${value[ALIAS_KEY]}: ${key}`);
+    } else if (typeof value === 'object' && value !== null) {
+      const keyStr = value[ALIAS_KEY] ? `${value[ALIAS_KEY]}: ${key}` : key;
+      if (value[FILTERS_KEY]) {
+        const filtersStr = Object.entries(value[FILTERS_KEY])
+          .map(
+            ([k2, v2]) =>
+              `${k2}: ${convertToGraphqlAsString(v2 as VariableType, convertEnum)}`
+          )
+          .join(', ');
+        lines.push(`${offsetStr}${keyStr}(${filtersStr}) {`);
+      } else {
+        lines.push(`${offsetStr}${keyStr} {`);
+      }
+      lines.push(
+        ...renderQueryBlock(
+          value,
+          offset + indentation,
+          indentation,
+          convertEnum
+        )
+      );
+      lines.push(offsetStr + '}');
+    } else {
+      lines.push(`${offsetStr}${key}`);
+    }
+  }
+  return lines;
+}
+
+export function renderInputBlock(
+  data: Record<string, any>,
+  offset: number = 4,
+  indentation: number = 4,
+  convertEnum: boolean = false
+): string[] {
+  const offsetStr = ' '.repeat(offset);
+  const lines: string[] = [];
+  for (const [key, value] of Object.entries(data)) {
+    if (typeof value === 'object' && value !== null && !Array.isArray(value)) {
+      lines.push(`${offsetStr}${key}: {`);
+      lines.push(
+        ...renderInputBlock(
+          value,
+          offset + indentation,
+          indentation,
+          convertEnum
+        )
+      );
+      lines.push(offsetStr + '}');
+    } else if (Array.isArray(value)) {
+      lines.push(`${offsetStr}${key}: [`);
+      for (const item of value) {
+        if (typeof item === 'object' && item !== null) {
+          lines.push(`${offsetStr}${' '.repeat(indentation)}{`);
+          lines.push(
+            ...renderInputBlock(
+              item,
+              offset + indentation * 2,
+              indentation,
+              convertEnum
+            )
+          );
+          lines.push(`${offsetStr}${' '.repeat(indentation)}},`);
+        } else {
+          lines.push(
+            `${offsetStr}${' '.repeat(indentation)}${convertToGraphqlAsString(item, convertEnum)},`
+          );
+        }
+      }
+      lines.push(offsetStr + ']');
+    } else {
+      lines.push(
+        `${offsetStr}${key}: ${convertToGraphqlAsString(value, convertEnum)}`
+      );
+    }
+  }
+  return lines;
+}
+
+export class BaseGraphQLQuery {
+  queryType: string = 'not-defined';
+  indentation: number = 4;
+  query: Record<string, any>;
+  variables?: Record<string, any>;
+  name: string;
+
+  constructor(
+    query: Record<string, any>,
+    variables?: Record<string, any>,
+    name?: string
+  ) {
+    this.query = query;
+    this.variables = variables;
+    this.name = name || '';
+  }
+
+  renderFirstLine(): string {
+    let firstLine = this.queryType;
+    if (this.name) {
+      firstLine += ' ' + this.name;
+    }
+    if (this.variables) {
+      firstLine += ` (${renderVariablesToString(this.variables)})`;
+    }
+    firstLine += ' {';
+    return firstLine;
+  }
+}
+
+export class Query extends BaseGraphQLQuery {
+  queryType = 'query';
+
+  render(convertEnum: boolean = false): string {
+    const lines: string[] = [this.renderFirstLine()];
+    lines.push(
+      ...renderQueryBlock(
+        this.query,
+        this.indentation,
+        this.indentation,
+        convertEnum
+      )
+    );
+    lines.push('}');
+    return '\n' + lines.join('\n') + '\n';
+  }
+}
+
+export class Mutation extends BaseGraphQLQuery {
+  queryType = 'mutation';
+  inputData: Record<string, any>;
+  mutation: string;
+
+  constructor({
+    mutation,
+    inputData,
+    query,
+    variables,
+    name
+  }: {
+    mutation: string;
+    inputData: Record<string, any>;
+    query: Record<string, any>;
+    variables?: Record<string, any>;
+    name?: string;
+  }) {
+    super(query, variables, name);
+    this.inputData = inputData;
+    this.mutation = mutation;
+  }
+
+  render(convertEnum: boolean = false): string {
+    const lines: string[] = [this.renderFirstLine()];
+    lines.push(' '.repeat(this.indentation) + `${this.mutation}(`);
+    lines.push(
+      ...renderInputBlock(
+        this.inputData,
+        this.indentation,
+        this.indentation * 2,
+        convertEnum
+      )
+    );
+    lines.push(' '.repeat(this.indentation) + '){');
+    lines.push(
+      ...renderQueryBlock(
+        this.query,
+        this.indentation,
+        this.indentation * 2,
+        convertEnum
+      )
+    );
+    lines.push(' '.repeat(this.indentation) + '}');
+    lines.push('}');
+    return '\n' + lines.join('\n') + '\n';
+  }
+}