shoal-web-sdk 0.0.38 → 0.0.40

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, 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 { 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';
 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
@@ -57,3 +57,7 @@ export declare const createEnvironment: <ThrowOnError extends boolean = false>(o
  * Get the environment overview.
  */
 export declare const getEnvironmentOverview: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentOverviewData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentOverviewResponses, GetEnvironmentOverviewErrors, ThrowOnError, "fields">;
+/**
+ * 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">;

package/dist/sdk/sdk.gen.js

@@ -90,7 +90,7 @@ export const getSpaceOverview = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/overview',
+        url: '/auth/{spaceHandle}/overview',
         ...options
     });
 };
@@ -105,7 +105,7 @@ export const getSpaceBillingAgreements = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/billing-agreements',
+        url: '/auth/{spaceHandle}/billing-agreements',
         ...options
     });
 };
@@ -120,7 +120,7 @@ export const createProject = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/projects/create',
+        url: '/auth/{spaceHandle}/projects/create',
         ...options,
         headers: {
             'Content-Type': 'application/json',
@@ -139,7 +139,7 @@ export const getProjectOverview = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/overview',
+        url: '/auth/{spaceHandle}/{projectHandle}/overview',
         ...options
     });
 };
@@ -154,7 +154,7 @@ export const createEnvironment = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/create',
+        url: '/auth/{spaceHandle}/{projectHandle}/environments/create',
         ...options,
         headers: {
             'Content-Type': 'application/json',
@@ -173,7 +173,22 @@ export const getEnvironmentOverview = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/{environmentHandle}/overview',
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/overview',
+        ...options
+    });
+};
+/**
+ * Get a graph for a version inside an environment.
+ */
+export const getGraphOverview = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{versionNumber}/graph',
         ...options
     });
 };

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

@@ -126,14 +126,118 @@ export type BillingAgreements = {
         }>;
     }>;
 };
+export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'message_queue' | 'proxy' | 'vm';
+export type CommentNodeProps = {
+    [key: string]: unknown;
+};
+export type CacheNodeProps = {
+    [key: string]: unknown;
+};
+export type ContainerNodeProps = {
+    [key: string]: unknown;
+};
+export type CronJobNodeProps = {
+    [key: string]: unknown;
+};
+export type DatabaseNodeProps = {
+    [key: string]: unknown;
+};
+export type FunctionNodeProps = {
+    [key: string]: unknown;
+};
+export type MessageQueueNodeProps = {
+    [key: string]: unknown;
+};
+export type ProxyNodeProps = {
+    [key: string]: unknown;
+};
+export type VmNodeProps = {
+    [key: string]: unknown;
+};
+export type Edge = {
+    id: string;
+    src: string;
+    dst: string;
+};
+export type Graph = {
+    nodes?: Array<Node>;
+};
+export type BaseNode = {
+    id: string;
+    versionId: string;
+    name: string;
+    description: string;
+    x: unknown;
+    y: unknown;
+    edges: Array<Edge>;
+};
+export type CommentNode = BaseNode & {
+    typ: 'comment';
+    props: CommentNodeProps;
+};
+export type CacheNode = BaseNode & {
+    typ: 'cache';
+    props: CacheNodeProps;
+};
+export type ContainerNode = BaseNode & {
+    typ: 'container';
+    props: ContainerNodeProps;
+};
+export type CronJobNode = BaseNode & {
+    typ: 'cronjob';
+    props: CronJobNodeProps;
+};
+export type DatabaseNode = BaseNode & {
+    typ: 'database';
+    props: DatabaseNodeProps;
+};
+export type FunctionNode = BaseNode & {
+    typ: 'function';
+    props: FunctionNodeProps;
+};
+export type MessageQueueNode = BaseNode & {
+    typ: 'message_queue';
+    props: MessageQueueNodeProps;
+};
+export type ProxyNode = BaseNode & {
+    typ: 'proxy';
+    props: ProxyNodeProps;
+};
+export type VmNode = BaseNode & {
+    typ: 'vm';
+    props: VmNodeProps;
+};
+export type Node = ({
+    typ: 'CommentNode';
+} & CommentNode) | ({
+    typ: 'CacheNode';
+} & CacheNode) | ({
+    typ: 'ContainerNode';
+} & ContainerNode) | ({
+    typ: 'CronJobNode';
+} & CronJobNode) | ({
+    typ: 'DatabaseNode';
+} & DatabaseNode) | ({
+    typ: 'FunctionNode';
+} & FunctionNode) | ({
+    typ: 'MessageQueueNode';
+} & MessageQueueNode) | ({
+    typ: 'ProxyNode';
+} & ProxyNode) | ({
+    typ: 'VMNode';
+} & VmNode);
 /**
- * A project name. This must be unique to a space.
+ * A version number with in an environment.
  */
-export type ProjectHandle = string;
+export type VersionNumber = unknown;
 /**
  * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
  */
 export type EnvironmentHandle = string;
+/**
+ * A project name. This must be unique to a space.
+ */
+export type ProjectHandle = string;
 /**
  * The space handle. This must be globally unique.
  */
@@ -275,7 +379,7 @@ export type GetSpaceOverviewData = {
         spaceHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/overview';
+    url: '/auth/{spaceHandle}/overview';
 };
 export type GetSpaceOverviewErrors = {
     /**
@@ -300,8 +404,9 @@ export type GetSpaceOverviewResponses = {
     /**
      * A summary of the users space they are in.
      */
-    200: unknown;
+    200: SpaceOverview;
 };
+export type GetSpaceOverviewResponse = GetSpaceOverviewResponses[keyof GetSpaceOverviewResponses];
 export type GetSpaceBillingAgreementsData = {
     body?: never;
     path: {
@@ -311,7 +416,7 @@ export type GetSpaceBillingAgreementsData = {
         spaceHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/billing-agreements';
+    url: '/auth/{spaceHandle}/billing-agreements';
 };
 export type GetSpaceBillingAgreementsErrors = {
     /**
@@ -336,8 +441,9 @@ export type GetSpaceBillingAgreementsResponses = {
     /**
      * A list of the space's billing agreements.
      */
-    200: unknown;
+    200: BillingAgreements;
 };
+export type GetSpaceBillingAgreementsResponse = GetSpaceBillingAgreementsResponses[keyof GetSpaceBillingAgreementsResponses];
 export type CreateProjectData = {
     body: CreateProject;
     path: {
@@ -347,7 +453,7 @@ export type CreateProjectData = {
         spaceHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/projects/create';
+    url: '/auth/{spaceHandle}/projects/create';
 };
 export type CreateProjectErrors = {
     /**
@@ -388,7 +494,7 @@ export type GetProjectOverviewData = {
         projectHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/overview';
+    url: '/auth/{spaceHandle}/{projectHandle}/overview';
 };
 export type GetProjectOverviewErrors = {
     /**
@@ -429,7 +535,7 @@ export type CreateEnvironmentData = {
         projectHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/create';
+    url: '/auth/{spaceHandle}/{projectHandle}/environments/create';
 };
 export type CreateEnvironmentErrors = {
     /**
@@ -474,7 +580,7 @@ export type GetEnvironmentOverviewData = {
         environmentHandle: string;
     };
     query?: never;
-    url: '/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/{environmentHandle}/overview';
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/overview';
 };
 export type GetEnvironmentOverviewErrors = {
     /**
@@ -502,3 +608,33 @@ export type GetEnvironmentOverviewResponses = {
     200: EnvironmentOverview;
 };
 export type GetEnvironmentOverviewResponse = GetEnvironmentOverviewResponses[keyof GetEnvironmentOverviewResponses];
+export type GetGraphOverviewData = {
+    body?: never;
+    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.
+         */
+        versionNumber: unknown;
+    };
+    query?: never;
+    url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{versionNumber}/graph';
+};
+export type GetGraphOverviewResponses = {
+    /**
+     * A graph overview.
+     */
+    200: Graph;
+};
+export type GetGraphOverviewResponse = GetGraphOverviewResponses[keyof GetGraphOverviewResponses];

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 } from "../../sdk/types.gen";
+import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, GetSpaceBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData } 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>;
@@ -22,10 +22,10 @@ export declare const useCreateSpace: (config?: {
 }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").SpaceOverview | undefined, unknown, Omit<CreateSpaceData, "url">, unknown>;
 export declare const useGetSpaceOverview: (options: Omit<GetSpaceOverviewData, "url"> & {
     enabled?: boolean;
-}) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SpaceOverview | undefined, Error>;
 export declare const useGetSpaceBillingAgreements: (options: Omit<GetSpaceBillingAgreementsData, "url"> & {
     enabled?: boolean;
-}) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").BillingAgreements | undefined, Error>;
 export declare const useCreateProject: (config?: {
     onSuccess?: (data: GetSuccessResponse<CreateProjectResponses>) => void;
     onError?: Parameters<typeof useMutation>["0"]["onError"];
@@ -42,3 +42,6 @@ export declare const useCreateEnvironment: (config?: {
 export declare const useGetEnvironmentOverview: (options: Omit<GetEnvironmentOverviewData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentOverview | undefined, Error>;
+export declare const useGetGraphOverview: (options: Omit<GetGraphOverviewData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").Graph | undefined, Error>;

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 } from "../../sdk/sdk.gen";
+import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, createSpace, getSpaceOverview, getSpaceBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -107,7 +107,7 @@ export const useCreateSpace = (config) => {
 export const useGetSpaceOverview = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/overview" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/overview" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -118,7 +118,7 @@ export const useGetSpaceOverview = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: ["spaces", options?.path?.spaceHandle, "overview", options.query ?? {}],
+        queryKey: [options?.path?.spaceHandle, "overview", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false,
@@ -128,7 +128,7 @@ export const useGetSpaceOverview = (options) => {
 export const useGetSpaceBillingAgreements = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/billing-agreements" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/billing-agreements" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -139,7 +139,7 @@ export const useGetSpaceBillingAgreements = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: ["spaces", options?.path?.spaceHandle, "billing-agreements", options.query ?? {}],
+        queryKey: [options?.path?.spaceHandle, "billing-agreements", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false,
@@ -149,7 +149,7 @@ export const useGetSpaceBillingAgreements = (options) => {
 export const useCreateProject = (config) => {
     const token = useToken();
     const queryClient = useQueryClient();
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projects/create" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/projects/create" };
     const funcer = async (options) => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         const res = await createProject({ ...opts, ...options, auth });
@@ -158,7 +158,7 @@ export const useCreateProject = (config) => {
     return useMutation({
         mutationFn: funcer,
         onSuccess: (res, options, c, ctx) => {
-            queryClient.invalidateQueries({ queryKey: ["spaces", options?.path?.spaceHandle, "projects", "create"] });
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, "projects", "create"] });
             config?.onSuccess && config.onSuccess(res);
         },
         onError: config?.onError,
@@ -168,7 +168,7 @@ export const useCreateProject = (config) => {
 export const useGetProjectOverview = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projects/{projectHandle}/overview" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/overview" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -179,7 +179,7 @@ export const useGetProjectOverview = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: ["spaces", options?.path?.spaceHandle, "projects", options?.path?.projectHandle, "overview", options.query ?? {}],
+        queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, "overview", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false,
@@ -189,7 +189,7 @@ export const useGetProjectOverview = (options) => {
 export const useCreateEnvironment = (config) => {
     const token = useToken();
     const queryClient = useQueryClient();
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/create" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/environments/create" };
     const funcer = async (options) => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         const res = await createEnvironment({ ...opts, ...options, auth });
@@ -198,7 +198,7 @@ export const useCreateEnvironment = (config) => {
     return useMutation({
         mutationFn: funcer,
         onSuccess: (res, options, c, ctx) => {
-            queryClient.invalidateQueries({ queryKey: ["spaces", options?.path?.spaceHandle, "projects", options?.path?.projectHandle, "environments", "create"] });
+            queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, "environments", "create"] });
             config?.onSuccess && config.onSuccess(res);
         },
         onError: config?.onError,
@@ -208,7 +208,7 @@ export const useCreateEnvironment = (config) => {
 export const useGetEnvironmentOverview = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projects/{projectHandle}/environments/{environmentHandle}/overview" };
+    const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/overview" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -219,7 +219,28 @@ export const useGetEnvironmentOverview = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: ["spaces", options?.path?.spaceHandle, "projects", options?.path?.projectHandle, "environments", options?.path?.environmentHandle, "overview", options.query ?? {}],
+        queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, "overview", options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+};
+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 funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await getGraphOverview({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.versionNumber, "graph", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false,

package/package.json

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