shoal-web-sdk 0.0.40 → 0.0.43

package/dist/sdk/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetGraphOverviewData, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceBillingAgreementsData, GetSpaceBillingAgreementsErrors, GetSpaceBillingAgreementsResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses } from './types.gen';
+import type { AddEdgesData, AddEdgesErrors, AddEdgesResponses, AddNodesData, AddNodesErrors, AddNodesResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceBillingAgreementsData, GetSpaceBillingAgreementsErrors, GetSpaceBillingAgreementsResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, RemoveEdgesData, RemoveEdgesErrors, RemoveEdgesResponses, RemoveNodesData, RemoveNodesErrors, RemoveNodesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -60,4 +60,20 @@ export declare const getEnvironmentOverview: <ThrowOnError extends boolean = fal
 /**
  * Get a graph for a version inside an environment.
  */
-export declare const getGraphOverview: <ThrowOnError extends boolean = false>(options: Options<GetGraphOverviewData, ThrowOnError>) => import("./client").RequestResult<GetGraphOverviewResponses, unknown, ThrowOnError, "fields">;
+export declare const getGraphOverview: <ThrowOnError extends boolean = false>(options: Options<GetGraphOverviewData, ThrowOnError>) => import("./client").RequestResult<GetGraphOverviewResponses, GetGraphOverviewErrors, ThrowOnError, "fields">;
+/**
+ * Remove nodes from a graph.
+ */
+export declare const removeNodes: <ThrowOnError extends boolean = false>(options: Options<RemoveNodesData, ThrowOnError>) => import("./client").RequestResult<RemoveNodesResponses, RemoveNodesErrors, ThrowOnError, "fields">;
+/**
+ * Add nodes to a graph for a version. This creates initialised node rows that must later be updated.
+ */
+export declare const addNodes: <ThrowOnError extends boolean = false>(options: Options<AddNodesData, ThrowOnError>) => import("./client").RequestResult<AddNodesResponses, AddNodesErrors, ThrowOnError, "fields">;
+/**
+ * Remove edges from a graph.
+ */
+export declare const removeEdges: <ThrowOnError extends boolean = false>(options: Options<RemoveEdgesData, ThrowOnError>) => import("./client").RequestResult<RemoveEdgesResponses, RemoveEdgesErrors, ThrowOnError, "fields">;
+/**
+ * Add edges to a graph for a version. This creates initialised edge rows that must later be updated.
+ */
+export declare const addEdges: <ThrowOnError extends boolean = false>(options: Options<AddEdgesData, ThrowOnError>) => import("./client").RequestResult<AddEdgesResponses, AddEdgesErrors, ThrowOnError, "fields">;

package/dist/sdk/sdk.gen.js

@@ -188,7 +188,83 @@ export const getGraphOverview = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{versionNumber}/graph',
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph',
         ...options
     });
 };
+/**
+ * Remove nodes from a graph.
+ */
+export const removeNodes = (options) => {
+    return (options.client ?? client).delete({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Add nodes to a graph for a version. This creates initialised node rows that must later be updated.
+ */
+export const addNodes = (options) => {
+    return (options.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Remove edges from a graph.
+ */
+export const removeEdges = (options) => {
+    return (options.client ?? client).delete({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Add edges to a graph for a version. This creates initialised edge rows that must later be updated.
+ */
+export const addEdges = (options) => {
+    return (options.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};

package/dist/sdk/types.gen.d.ts

@@ -1,5 +1,5 @@
 export type ClientOptions = {
-    baseUrl: 'http://localhost:8080/core-service' | 'https://shoal-dev.platform48.com/core-service' | (string & {});
+    baseUrl: 'http://localhost:8080/core-service' | 'https://api-dev.shoalstack.com/core-service' | (string & {});
 };
 export type HealthResponse = {
     status: string;
@@ -126,6 +126,27 @@ export type BillingAgreements = {
         }>;
     }>;
 };
+export type EdgeVertices = {
+    src: string;
+    dst: string;
+};
+export type AddEdges = {
+    edges: Array<EdgeVertices>;
+};
+export type RemoveEdges = {
+    edges: Array<EdgeVertices>;
+};
+export type AddNodes = {
+    nodes: Array<CreateNode>;
+};
+export type RemoveNodes = {
+    ids: Array<string>;
+};
+export type CreateNode = {
+    x: unknown;
+    y: unknown;
+    typ: NodeType;
+};
 export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'message_queue' | 'proxy' | 'vm';
 export type CommentNodeProps = {
     [key: string]: unknown;
@@ -160,7 +181,7 @@ export type Edge = {
     dst: string;
 };
 export type Graph = {
-    nodes?: Array<Node>;
+    nodes: Array<Node>;
 };
 export type BaseNode = {
     id: string;
@@ -229,7 +250,7 @@ export type Node = ({
 /**
  * A version number with in an environment.
  */
-export type VersionNumber = unknown;
+export type Version = string;
 /**
  * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
  */
@@ -626,11 +647,30 @@ export type GetGraphOverviewData = {
         /**
          * A version number with in an environment.
          */
-        versionNumber: unknown;
+        version: string;
     };
     query?: never;
-    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{versionNumber}/graph';
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph';
+};
+export type GetGraphOverviewErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
 };
+export type GetGraphOverviewError = GetGraphOverviewErrors[keyof GetGraphOverviewErrors];
 export type GetGraphOverviewResponses = {
     /**
      * A graph overview.
@@ -638,3 +678,199 @@ export type GetGraphOverviewResponses = {
     200: Graph;
 };
 export type GetGraphOverviewResponse = GetGraphOverviewResponses[keyof GetGraphOverviewResponses];
+export type RemoveNodesData = {
+    body: RemoveNodes;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+        /**
+         * A version number with in an environment.
+         */
+        version: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes';
+};
+export type RemoveNodesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type RemoveNodesError = RemoveNodesErrors[keyof RemoveNodesErrors];
+export type RemoveNodesResponses = {
+    /**
+     * A graph overview.
+     */
+    200: Graph;
+};
+export type RemoveNodesResponse = RemoveNodesResponses[keyof RemoveNodesResponses];
+export type AddNodesData = {
+    body: AddNodes;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+        /**
+         * A version number with in an environment.
+         */
+        version: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes';
+};
+export type AddNodesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type AddNodesError = AddNodesErrors[keyof AddNodesErrors];
+export type AddNodesResponses = {
+    /**
+     * A graph overview.
+     */
+    200: Graph;
+};
+export type AddNodesResponse = AddNodesResponses[keyof AddNodesResponses];
+export type RemoveEdgesData = {
+    body: RemoveEdges;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+        /**
+         * A version number with in an environment.
+         */
+        version: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges';
+};
+export type RemoveEdgesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type RemoveEdgesError = RemoveEdgesErrors[keyof RemoveEdgesErrors];
+export type RemoveEdgesResponses = {
+    /**
+     * A graph overview.
+     */
+    200: Graph;
+};
+export type RemoveEdgesResponse = RemoveEdgesResponses[keyof RemoveEdgesResponses];
+export type AddEdgesData = {
+    body: AddEdges;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+        /**
+         * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
+         */
+        environmentHandle: string;
+        /**
+         * A version number with in an environment.
+         */
+        version: string;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges';
+};
+export type AddEdgesErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type AddEdgesError = AddEdgesErrors[keyof AddEdgesErrors];
+export type AddEdgesResponses = {
+    /**
+     * A graph overview.
+     */
+    200: Graph;
+};
+export type AddEdgesResponse = AddEdgesResponses[keyof AddEdgesResponses];

package/dist/tanstack-codegen/generated/generated.d.ts

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { GetSuccessResponse } from "../util";
-import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, GetSpaceBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData } from "../../sdk/types.gen";
+import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, GetSpaceBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, RemoveNodesData, RemoveNodesResponses, AddNodesData, AddNodesResponses, RemoveEdgesData, RemoveEdgesResponses, AddEdgesData, AddEdgesResponses } from "../../sdk/types.gen";
 export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").HealthResponse | undefined, Error>;
@@ -45,3 +45,23 @@ export declare const useGetEnvironmentOverview: (options: Omit<GetEnvironmentOve
 export declare const useGetGraphOverview: (options: Omit<GetGraphOverviewData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").Graph | undefined, Error>;
+export declare const useRemoveNodes: (config?: {
+    onSuccess?: (data: GetSuccessResponse<RemoveNodesResponses>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<RemoveNodesData, "url">, unknown>;
+export declare const useAddNodes: (config?: {
+    onSuccess?: (data: GetSuccessResponse<AddNodesResponses>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<AddNodesData, "url">, unknown>;
+export declare const useRemoveEdges: (config?: {
+    onSuccess?: (data: GetSuccessResponse<RemoveEdgesResponses>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<RemoveEdgesData, "url">, unknown>;
+export declare const useAddEdges: (config?: {
+    onSuccess?: (data: GetSuccessResponse<AddEdgesResponses>) => void;
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<AddEdgesData, "url">, unknown>;

package/dist/tanstack-codegen/generated/generated.js

@@ -2,7 +2,7 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { isPromise } from "../util";
 import { useToken } from "../../provider/token-provider";
-import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, createSpace, getSpaceOverview, getSpaceBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview } from "../../sdk/sdk.gen";
+import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, createSpace, getSpaceOverview, getSpaceBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, removeNodes, addNodes, removeEdges, addEdges } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -229,7 +229,7 @@ export const useGetEnvironmentOverview = (options) => {
 export const useGetGraphOverview = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{versionNumber}/graph" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -240,10 +240,86 @@ export const useGetGraphOverview = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.versionNumber, "graph", options.query ?? {}],
+        queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false,
         staleTime: 600000
     });
 };
+export const useRemoveNodes = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await removeNodes({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "nodes"] });
+            config?.onSuccess && config.onSuccess(res);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
+export const useAddNodes = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await addNodes({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "nodes"] });
+            config?.onSuccess && config.onSuccess(res);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
+export const useRemoveEdges = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await removeEdges({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "edges"] });
+            config?.onSuccess && config.onSuccess(res);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
+export const useAddEdges = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/edges" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await addEdges({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "edges"] });
+            config?.onSuccess && config.onSuccess(res);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "shoal-web-sdk",
-    "version": "0.0.40",
+    "version": "0.0.43",
     "main": "index.js",
     "scripts": {
         "build-hooks": "npx tsx tanstack-codegen/generator.ts",