infrahub-sdk 0.0.1 → 0.0.4

package/.github/workflows/publish.yml

@@ -0,0 +1,22 @@
+name: Publish Package to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/dist/branch.d.ts

@@ -1,20 +1,5 @@
 import { InfrahubClient } from './index';
-interface Branch {
-    id: string;
-    name: string;
-    description: string;
-    origin_branch: string;
-    branched_from: string;
-    is_default: boolean;
-    sync_with_git: boolean;
-    has_schema_changes: boolean;
-}
-export interface BranchCreateInput {
-    name: string;
-    description?: string;
-    sync_with_git?: boolean;
-    wait_until_completion?: boolean;
-}
+import { BranchResponse, BranchCreateInput } from './graphql/branch';
 export declare class BranchNotFoundError extends Error {
     constructor(identifier: string);
 }
@@ -24,13 +9,12 @@ export declare class InfrahubBranchManager {
     /**
      * Fetches all branches using GraphQL and returns an object mapping branch names to branch data.
      */
-    all(): Promise<Record<string, Branch>>;
+    all(): Promise<Record<string, BranchResponse>>;
     /**
      * Fetches a specific branch by name.
      * @param branchName The name of the branch to fetch.
      */
-    get(branchName: string): Promise<Branch | null>;
-    create(input: BranchCreateInput): Promise<Branch>;
+    get(branchName: string): Promise<BranchResponse | null>;
+    create(input: BranchCreateInput): Promise<BranchResponse>;
     delete(branchName: string): Promise<boolean>;
 }
-export {};

package/dist/branch.js

@@ -1,8 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfrahubBranchManager = exports.BranchNotFoundError = void 0;
-const index_1 = require("./index");
 const graphql_1 = require("./graphql");
+const branch_1 = require("./graphql/branch");
 class BranchNotFoundError extends Error {
     constructor(identifier) {
         super(`Branch not found: ${identifier}`);
@@ -33,26 +33,12 @@ class InfrahubBranchManager {
      * Fetches all branches using GraphQL and returns an object mapping branch names to branch data.
      */
     async all() {
-        const query = (0, index_1.gql) `
-      query BranchQuery {
-        Branch {
-          id
-          name
-          description
-          origin_branch
-          branched_from
-          is_default
-          sync_with_git
-          has_schema_changes
-        }
-      }
-    `;
-        const response = await this.client.executeGraphQL(query);
+        const response = await this.client.executeGraphQL(branch_1.BranchAllQuery);
         const branches = response.Branch || [];
         const result = {};
-        for (const branch of branches) {
+        branches.forEach((branch) => {
             result[branch.name] = branch;
-        }
+        });
         return result;
     }
     /**
@@ -60,21 +46,7 @@ class InfrahubBranchManager {
      * @param branchName The name of the branch to fetch.
      */
     async get(branchName) {
-        const query = (0, index_1.gql) `
-      query BranchQuery($name: String!) {
-        Branch(name: $name) {
-          id
-          name
-          description
-          origin_branch
-          branched_from
-          is_default
-          sync_with_git
-          has_schema_changes
-        }
-      }
-    `;
-        const response = await this.client.executeGraphQL(query, {
+        const response = await this.client.executeGraphQL(branch_1.BranchGetQuery, {
             name: branchName
         });
         const branchArr = response.Branch || [];
@@ -102,11 +74,8 @@ class InfrahubBranchManager {
             query: mutationQuery,
             name: 'CreateBranch'
         });
-        // You may want to remove this log in production
         console.log(mutation.render());
-        const response = await this.client.executeGraphQL(mutation.render(), {
-            input: inputData
-        });
+        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) {

package/dist/graphql/branch.d.ts

@@ -0,0 +1,23 @@
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+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 declare const BranchAllQuery: TypedDocumentNode<{
+    Branch: BranchResponse[];
+}, Record<any, never>>;
+export declare const BranchGetQuery: TypedDocumentNode<{
+    Branch: BranchResponse[];
+}, Record<any, any>>;

package/dist/graphql/branch.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BranchGetQuery = exports.BranchAllQuery = void 0;
+const graphql_request_1 = require("graphql-request");
+const graphql_1 = require("graphql");
+const BranchAllQueryDocument = (0, graphql_1.parse)((0, graphql_request_1.gql) `
+  query BranchAllQuery {
+    Branch {
+      id
+      name
+      description
+      origin_branch
+      branched_from
+      is_default
+      sync_with_git
+      has_schema_changes
+    }
+  }
+`);
+const BranchGetQueryDocument = (0, graphql_1.parse)((0, graphql_request_1.gql) `
+  query BranchGetQuery($name: String!) {
+    Branch(name: $name) {
+      id
+      name
+      description
+      origin_branch
+      branched_from
+      is_default
+      sync_with_git
+      has_schema_changes
+    }
+  }
+`);
+exports.BranchAllQuery = BranchAllQueryDocument;
+exports.BranchGetQuery = BranchGetQueryDocument;

package/dist/graphql/client.d.ts

@@ -0,0 +1,71 @@
+import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
+export interface InfrahubInfoResponse {
+    InfrahubInfo: {
+        version: string;
+    };
+}
+export declare const InfrahubInfoQuery: TypedDocumentNode<InfrahubInfoResponse, Record<any, never>>;
+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;
+                    roles?: {
+                        count: number;
+                        edges: Array<{
+                            node: {
+                                permissions?: {
+                                    count: number;
+                                    edges: Array<{
+                                        node: {
+                                            display_label: string;
+                                            identifier?: {
+                                                value: string;
+                                            };
+                                        };
+                                    }>;
+                                };
+                            };
+                        }>;
+                    };
+                };
+            }>;
+            __typename?: string;
+        };
+        name: {
+            value: string;
+            updated_at: string;
+            __typename?: string;
+        };
+    };
+}
+export declare const InfrahubUserQuery: TypedDocumentNode<InfrahubUserResponse, Record<any, never>>;

package/dist/graphql/client.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfrahubUserQuery = exports.InfrahubInfoQuery = void 0;
+const graphql_1 = require("graphql");
+const graphql_request_1 = require("graphql-request");
+const InfrahubInfoDocument = (0, graphql_1.parse)((0, graphql_request_1.gql) `
+  query InfrahubInfo {
+    InfrahubInfo {
+      version
+    }
+  }
+`);
+exports.InfrahubInfoQuery = InfrahubInfoDocument;
+const InfrahubUserDocument = (0, graphql_1.parse)((0, graphql_request_1.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
+      }
+    }
+  }
+`);
+exports.InfrahubUserQuery = InfrahubUserDocument;

package/dist/index.d.ts

@@ -5,10 +5,12 @@ export type SafeResult<T> = {
     data: undefined;
     error: Error;
 };
+import type { TypedDocumentNode } from '@graphql-typed-document-node/core';
 import createClient from 'openapi-fetch';
 import { Variables } from 'graphql-request';
 import type { paths } from './types';
 import { InfrahubBranchManager } from './branch';
+import { InfrahubUserResponse } from './graphql/client';
 export * from 'graphql-request';
 export * from './types';
 export interface InfrahubClientOptions {
@@ -43,5 +45,8 @@ export declare class InfrahubClient {
      * @param variables Optional variables for the query.
      * @param branchName Optional branch name to target a specific branch.
      */
-    executeGraphQL<TData = any, TVariables extends Variables = Variables>(query: string, variables?: TVariables, branchName?: string): Promise<TData>;
+    executeGraphQL<TData = any, TVariables extends Variables = Variables>(query: string | TypedDocumentNode<TData, TVariables>, variables?: TVariables, branchName?: string): Promise<TData>;
+    getVersion(): Promise<string>;
+    getUser(): Promise<InfrahubUserResponse>;
+    getUserPermissions(): Promise<InfrahubUserResponse['AccountProfile']['member_of_groups']['edges']>;
 }

package/dist/index.js

@@ -21,6 +21,7 @@ exports.InfrahubClient = void 0;
 const openapi_fetch_1 = __importDefault(require("openapi-fetch"));
 const graphql_request_1 = require("graphql-request");
 const branch_1 = require("./branch");
+const client_1 = require("./graphql/client");
 // Re-export gql and all exports from graphql-request
 __exportStar(require("graphql-request"), exports);
 __exportStar(require("./types"), exports);
@@ -111,5 +112,17 @@ class InfrahubClient {
             throw error;
         }
     }
+    async getVersion() {
+        const data = await this.executeGraphQL(client_1.InfrahubInfoQuery);
+        return data.InfrahubInfo.version;
+    }
+    async getUser() {
+        const data = await this.executeGraphQL(client_1.InfrahubUserQuery);
+        return data;
+    }
+    async getUserPermissions() {
+        const user = await this.getUser();
+        return user.AccountProfile.member_of_groups.edges;
+    }
 }
 exports.InfrahubClient = InfrahubClient;

package/package.json

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

package/src/branch.ts

@@ -1,23 +1,11 @@
 import { InfrahubClient, gql } from './index';
 import { Mutation } from './graphql';
-
-interface Branch {
-  id: string;
-  name: string;
-  description: string;
-  origin_branch: string;
-  branched_from: string;
-  is_default: boolean;
-  sync_with_git: boolean;
-  has_schema_changes: boolean;
-}
-
-export interface BranchCreateInput {
-  name: string;
-  description?: string;
-  sync_with_git?: boolean;
-  wait_until_completion?: boolean;
-}
+import {
+  BranchAllQuery,
+  BranchResponse,
+  BranchGetQuery,
+  BranchCreateInput
+} from './graphql/branch';
 
 export class BranchNotFoundError extends Error {
   constructor(identifier: string) {
@@ -52,27 +40,18 @@ export class InfrahubBranchManager {
   /**
    * Fetches all branches using GraphQL and returns an object mapping branch names to branch data.
    */
-  async all(): Promise<Record<string, Branch>> {
-    const query = gql`
-      query BranchQuery {
-        Branch {
-          id
-          name
-          description
-          origin_branch
-          branched_from
-          is_default
-          sync_with_git
-          has_schema_changes
-        }
-      }
-    `;
-    const response = await this.client.executeGraphQL(query);
-    const branches: Branch[] = response.Branch || [];
-    const result: Record<string, Branch> = {};
-    for (const branch of branches) {
+  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;
   }
 
@@ -80,32 +59,23 @@ export class InfrahubBranchManager {
    * Fetches a specific branch by name.
    * @param branchName The name of the branch to fetch.
    */
-  async get(branchName: string): Promise<Branch | null> {
-    const query = gql`
-      query BranchQuery($name: String!) {
-        Branch(name: $name) {
-          id
-          name
-          description
-          origin_branch
-          branched_from
-          is_default
-          sync_with_git
-          has_schema_changes
-        }
-      }
-    `;
-    const response = await this.client.executeGraphQL(query, {
+  async get(branchName: string): Promise<BranchResponse | null> {
+    const response = await this.client.executeGraphQL<
+      {
+        Branch: BranchResponse[];
+      },
+      Record<string, any>
+    >(BranchGetQuery, {
       name: branchName
     });
-    const branchArr: Branch[] = response.Branch || [];
+    const branchArr: BranchResponse[] = response.Branch || [];
     if (!branchArr.length) {
       throw new BranchNotFoundError(branchName);
     }
     return branchArr[0];
   }
 
-  async create(input: BranchCreateInput): Promise<Branch> {
+  async create(input: BranchCreateInput): Promise<BranchResponse> {
     const inputData = {
       background_execution: input.wait_until_completion,
       data: {
@@ -126,18 +96,17 @@ export class InfrahubBranchManager {
       query: mutationQuery,
       name: 'CreateBranch'
     });
-    // You may want to remove this log in production
+
     console.log(mutation.render());
-    const response = await this.client.executeGraphQL(mutation.render(), {
-      input: inputData
-    });
+
+    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 Branch;
+    return branchData as BranchResponse;
   }
 
   async delete(branchName: string): Promise<boolean> {

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;