shoal-web-sdk 0.0.21 → 0.0.22

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

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { CreateProjectData, CreateProjectErrors, CreateProjectResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses } from './types.gen';
+import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, 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
@@ -26,10 +26,26 @@ export declare const requestAccountPasswordReset: <ThrowOnError extends boolean
  */
 export declare const getUserProfile: <ThrowOnError extends boolean = false>(options?: Options<GetUserProfileData, ThrowOnError>) => import("./client").RequestResult<GetUserProfileResponses, GetUserProfileErrors, ThrowOnError, "fields">;
 /**
- * Create a project inside a team.
+ * Create a space.
+ */
+export declare const createSpace: <ThrowOnError extends boolean = false>(options?: Options<CreateSpaceData, ThrowOnError>) => import("./client").RequestResult<CreateSpaceResponses, CreateSpaceErrors, ThrowOnError, "fields">;
+/**
+ * The space overview.
+ */
+export declare const getSpaceOverview: <ThrowOnError extends boolean = false>(options: Options<GetSpaceOverviewData, ThrowOnError>) => import("./client").RequestResult<GetSpaceOverviewResponses, GetSpaceOverviewErrors, ThrowOnError, "fields">;
+/**
+ * Create a project inside a space.
  */
 export declare const createProject: <ThrowOnError extends boolean = false>(options: Options<CreateProjectData, ThrowOnError>) => import("./client").RequestResult<CreateProjectResponses, CreateProjectErrors, ThrowOnError, "fields">;
 /**
  * Get the project overview.
  */
 export declare const getProjectOverview: <ThrowOnError extends boolean = false>(options: Options<GetProjectOverviewData, ThrowOnError>) => import("./client").RequestResult<GetProjectOverviewResponses, GetProjectOverviewErrors, ThrowOnError, "fields">;
+/**
+ * Create an environment inside a project.
+ */
+export declare const createEnvironment: <ThrowOnError extends boolean = false>(options: Options<CreateEnvironmentData, ThrowOnError>) => import("./client").RequestResult<CreateEnvironmentResponses, CreateEnvironmentErrors, ThrowOnError, "fields">;
+/**
+ * Get the environment overview.
+ */
+export declare const getEnvironmentOverview: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentOverviewData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentOverviewResponses, GetEnvironmentOverviewErrors, ThrowOnError, "fields">;

package/dist/sdk/sdk.gen.js

@@ -46,7 +46,41 @@ export const getUserProfile = (options) => {
     });
 };
 /**
- * Create a project inside a team.
+ * Create a space.
+ */
+export const createSpace = (options) => {
+    return (options?.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/spaces/create',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+/**
+ * The space overview.
+ */
+export const getSpaceOverview = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/spaces/{spaceHandle}/overview',
+        ...options
+    });
+};
+/**
+ * Create a project inside a space.
  */
 export const createProject = (options) => {
     return (options.client ?? client).post({
@@ -56,7 +90,7 @@ export const createProject = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/teams/{teamKindeOrgCode}/projets/create',
+        url: '/auth/spaces/{spaceHandle}/projets/create',
         ...options,
         headers: {
             'Content-Type': 'application/json',
@@ -75,7 +109,41 @@ export const getProjectOverview = (options) => {
                 type: 'http'
             }
         ],
-        url: '/auth/teams/{teamKindeOrgCode}/projets/{projectUUID}/overview',
+        url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/overview',
+        ...options
+    });
+};
+/**
+ * Create an environment inside a project.
+ */
+export const createEnvironment = (options) => {
+    return (options.client ?? client).post({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/create',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options.headers
+        }
+    });
+};
+/**
+ * Get the environment overview.
+ */
+export const getEnvironmentOverview = (options) => {
+    return (options.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/{environmentHandle}/overview',
         ...options
     });
 };

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

@@ -1,5 +1,5 @@
 export type ClientOptions = {
-    baseUrl: 'http://localhost:8080/core-service' | (string & {});
+    baseUrl: 'http://localhost:8080/core-service' | 'https://shoal-dev.platform48.com/core-service' | (string & {});
 };
 export type HealthResponse = {
     status: string;
@@ -10,17 +10,38 @@ export type ErrorResponse = {
 };
 export type CreateProject = {
     name: string;
+    handle: string;
     description?: string;
 };
 export type ProjectOverview = {
     id: string;
     orgCode: string;
     name: string;
+    handle: string;
     description?: string;
     createdAt: string;
     updatedAt: string;
     environments: Array<EnvironmentOverview>;
 };
+export type CreateSpace = {
+    name: string;
+    handle: string;
+    senderName: string;
+    senderEmail: string;
+    billingEmail: string;
+    billingPlanCode: string;
+};
+export type CreateEnvironment = {
+    name: string;
+    handle: string;
+    description?: string;
+};
+export type SpaceOverview = {
+    id: string;
+    name: string;
+    handle: string;
+    projects: Array<ProjectOverview>;
+};
 export type EnvironmentOverview = {
     id: string;
     name: string;
@@ -30,7 +51,6 @@ export type EnvironmentOverview = {
     versions: unknown;
 };
 export type AccountProfile = {
-    kindeId: string;
     preferredEmail: string;
     phone: string;
     username: string;
@@ -44,13 +64,17 @@ export type AccountProfile = {
     createdOn: string;
 };
 /**
- * A project UUID.
+ * A project name. This must be unique to a space.
  */
-export type ProjectUuid = string;
+export type ProjectHandle = string;
 /**
- * A kinde org_code that is referenced as a team.
+ * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
  */
-export type TeamKindeOrgCode = string;
+export type EnvironmentHandle = string;
+/**
+ * The space handle. This must be globally unique.
+ */
+export type SpaceHandle = string;
 export type GetServiceHealthData = {
     body?: never;
     path?: never;
@@ -99,7 +123,7 @@ export type GetUserProfileErrors = {
      */
     403: ErrorResponse;
     /**
-     * No internal/kinde account found.
+     * Related content not found.
      */
     404: ErrorResponse;
     /**
@@ -115,16 +139,84 @@ export type GetUserProfileResponses = {
     200: AccountProfile;
 };
 export type GetUserProfileResponse = GetUserProfileResponses[keyof GetUserProfileResponses];
+export type CreateSpaceData = {
+    body?: CreateSpace;
+    path?: never;
+    query?: never;
+    url: '/auth/spaces/create';
+};
+export type CreateSpaceErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type CreateSpaceError = CreateSpaceErrors[keyof CreateSpaceErrors];
+export type CreateSpaceResponses = {
+    /**
+     * Successfully created a space.
+     */
+    201: SpaceOverview;
+};
+export type CreateSpaceResponse = CreateSpaceResponses[keyof CreateSpaceResponses];
+export type GetSpaceOverviewData = {
+    body?: never;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+    };
+    query?: never;
+    url: '/auth/spaces/{spaceHandle}/overview';
+};
+export type GetSpaceOverviewErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type GetSpaceOverviewError = GetSpaceOverviewErrors[keyof GetSpaceOverviewErrors];
+export type GetSpaceOverviewResponses = {
+    /**
+     * A summary of the users space they are in.
+     */
+    200: unknown;
+};
 export type CreateProjectData = {
     body?: CreateProject;
     path: {
         /**
-         * A kinde org_code that is referenced as a team.
+         * The space handle. This must be globally unique.
          */
-        teamKindeOrgCode: string;
+        spaceHandle: string;
     };
     query?: never;
-    url: '/auth/teams/{teamKindeOrgCode}/projets/create';
+    url: '/auth/spaces/{spaceHandle}/projets/create';
 };
 export type CreateProjectErrors = {
     /**
@@ -136,7 +228,7 @@ export type CreateProjectErrors = {
      */
     403: ErrorResponse;
     /**
-     * Created project not found.
+     * Related content not found.
      */
     404: ErrorResponse;
     /**
@@ -147,7 +239,7 @@ export type CreateProjectErrors = {
 export type CreateProjectError = CreateProjectErrors[keyof CreateProjectErrors];
 export type CreateProjectResponses = {
     /**
-     * Successfully created project inside a team.
+     * Successfully created project inside a space.
      */
     201: ProjectOverview;
 };
@@ -156,16 +248,16 @@ export type GetProjectOverviewData = {
     body?: never;
     path: {
         /**
-         * A kinde org_code that is referenced as a team.
+         * The space handle. This must be globally unique.
          */
-        teamKindeOrgCode: string;
+        spaceHandle: string;
         /**
-         * A project UUID.
+         * A project name. This must be unique to a space.
          */
-        projectUUID: string;
+        projectHandle: string;
     };
     query?: never;
-    url: '/auth/teams/{teamKindeOrgCode}/projets/{projectUUID}/overview';
+    url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/overview';
 };
 export type GetProjectOverviewErrors = {
     /**
@@ -177,7 +269,7 @@ export type GetProjectOverviewErrors = {
      */
     403: ErrorResponse;
     /**
-     * Created project not found.
+     * Related content not found.
      */
     404: ErrorResponse;
     /**
@@ -193,3 +285,89 @@ export type GetProjectOverviewResponses = {
     200: ProjectOverview;
 };
 export type GetProjectOverviewResponse = GetProjectOverviewResponses[keyof GetProjectOverviewResponses];
+export type CreateEnvironmentData = {
+    body?: CreateEnvironment;
+    path: {
+        /**
+         * The space handle. This must be globally unique.
+         */
+        spaceHandle: string;
+        /**
+         * A project name. This must be unique to a space.
+         */
+        projectHandle: string;
+    };
+    query?: never;
+    url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/create';
+};
+export type CreateEnvironmentErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type CreateEnvironmentError = CreateEnvironmentErrors[keyof CreateEnvironmentErrors];
+export type CreateEnvironmentResponses = {
+    /**
+     * Successfully created an environment inside a project.
+     */
+    201: EnvironmentOverview;
+};
+export type CreateEnvironmentResponse = CreateEnvironmentResponses[keyof CreateEnvironmentResponses];
+export type GetEnvironmentOverviewData = {
+    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;
+    };
+    query?: never;
+    url: '/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/{environmentHandle}/overview';
+};
+export type GetEnvironmentOverviewErrors = {
+    /**
+     * Unauthorised user.
+     */
+    401: ErrorResponse;
+    /**
+     * Invalid credentials.
+     */
+    403: ErrorResponse;
+    /**
+     * Related content not found.
+     */
+    404: ErrorResponse;
+    /**
+     * Unexpected error.
+     */
+    500: ErrorResponse;
+};
+export type GetEnvironmentOverviewError = GetEnvironmentOverviewErrors[keyof GetEnvironmentOverviewErrors];
+export type GetEnvironmentOverviewResponses = {
+    /**
+     * Environment overview.
+     */
+    200: EnvironmentOverview;
+};
+export type GetEnvironmentOverviewResponse = GetEnvironmentOverviewResponses[keyof GetEnvironmentOverviewResponses];

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

@@ -1,5 +1,5 @@
 import { useMutation } from "@tanstack/react-query";
-import { GetServiceHealthData, RequestAccountPasswordResetData, GetUserProfileData, CreateProjectData, GetProjectOverviewData } from "../../sdk/types.gen";
+import { GetServiceHealthData, RequestAccountPasswordResetData, GetUserProfileData, CreateSpaceData, GetSpaceOverviewData, CreateProjectData, GetProjectOverviewData, CreateEnvironmentData, GetEnvironmentOverviewData } 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>;
@@ -11,6 +11,14 @@ export declare const useRequestAccountPasswordReset: (config?: {
 export declare const useGetUserProfile: (options?: Omit<GetUserProfileData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").AccountProfile | undefined, Error>;
+export declare const useCreateSpace: (config?: {
+    onSuccess?: Parameters<typeof useMutation>["0"]["onSuccess"];
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").SpaceOverview | undefined, unknown, Omit<CreateSpaceData, "url"> | undefined, unknown>;
+export declare const useGetSpaceOverview: (options: Omit<GetSpaceOverviewData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
 export declare const useCreateProject: (config?: {
     onSuccess?: Parameters<typeof useMutation>["0"]["onSuccess"];
     onError?: Parameters<typeof useMutation>["0"]["onError"];
@@ -19,3 +27,11 @@ export declare const useCreateProject: (config?: {
 export declare const useGetProjectOverview: (options: Omit<GetProjectOverviewData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").ProjectOverview | undefined, Error>;
+export declare const useCreateEnvironment: (config?: {
+    onSuccess?: Parameters<typeof useMutation>["0"]["onSuccess"];
+    onError?: Parameters<typeof useMutation>["0"]["onError"];
+    retry?: boolean;
+}) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").EnvironmentOverview | undefined, unknown, Omit<CreateEnvironmentData, "url">, unknown>;
+export declare const useGetEnvironmentOverview: (options: Omit<GetEnvironmentOverviewData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentOverview | 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, createProject, getProjectOverview } from "../../sdk/sdk.gen";
+import { getServiceHealth, requestAccountPasswordReset, getUserProfile, createSpace, getSpaceOverview, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -62,10 +62,49 @@ export const useGetUserProfile = (options) => {
         retry: false
     });
 };
+export const useCreateSpace = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/spaces/create" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await createSpace({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: ["spaces", "create"] });
+            config?.onSuccess && config.onSuccess(res, options, c, ctx);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
+export const useGetSpaceOverview = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/overview" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await getSpaceOverview({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: ["spaces", options?.path?.spaceHandle, "overview", options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false
+    });
+};
 export const useCreateProject = (config) => {
     const token = useToken();
     const queryClient = useQueryClient();
-    const opts = { throwOnError: true, url: "/auth/teams/{teamKindeOrgCode}/projets/create" };
+    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projets/create" };
     const funcer = async (options) => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         const res = await createProject({ ...opts, ...options, auth });
@@ -74,7 +113,7 @@ export const useCreateProject = (config) => {
     return useMutation({
         mutationFn: funcer,
         onSuccess: (res, options, c, ctx) => {
-            queryClient.invalidateQueries({ queryKey: ["teams", options?.path?.teamKindeOrgCode, "projets", "create"] });
+            queryClient.invalidateQueries({ queryKey: ["spaces", options?.path?.spaceHandle, "projets", "create"] });
             config?.onSuccess && config.onSuccess(res, options, c, ctx);
         },
         onError: config?.onError,
@@ -84,7 +123,7 @@ export const useCreateProject = (config) => {
 export const useGetProjectOverview = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
-    const opts = { throwOnError: true, url: "/auth/teams/{teamKindeOrgCode}/projets/{projectUUID}/overview" };
+    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projets/{projectHandle}/overview" };
     const funcer = async () => {
         const auth = isPromise(token) ? (await token) || "" : token || "";
         if (isPromise(token) && !token)
@@ -95,7 +134,46 @@ export const useGetProjectOverview = (options) => {
     if (!token)
         enabled = false;
     return useQuery({
-        queryKey: ["teams", options?.path?.teamKindeOrgCode, "projets", options?.path?.projectUUID, "overview", options.query ?? {}],
+        queryKey: ["spaces", options?.path?.spaceHandle, "projets", options?.path?.projectHandle, "overview", options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false
+    });
+};
+export const useCreateEnvironment = (config) => {
+    const token = useToken();
+    const queryClient = useQueryClient();
+    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/create" };
+    const funcer = async (options) => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        const res = await createEnvironment({ ...opts, ...options, auth });
+        return res?.data;
+    };
+    return useMutation({
+        mutationFn: funcer,
+        onSuccess: (res, options, c, ctx) => {
+            queryClient.invalidateQueries({ queryKey: ["spaces", options?.path?.spaceHandle, "projets", options?.path?.projectHandle, "environments", "create"] });
+            config?.onSuccess && config.onSuccess(res, options, c, ctx);
+        },
+        onError: config?.onError,
+        retry: config?.retry
+    });
+};
+export const useGetEnvironmentOverview = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/auth/spaces/{spaceHandle}/projets/{projectHandle}/environments/{environmentHandle}/overview" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await getEnvironmentOverview({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: ["spaces", options?.path?.spaceHandle, "projets", options?.path?.projectHandle, "environments", options?.path?.environmentHandle, "overview", options.query ?? {}],
         queryFn: funcer,
         enabled,
         retry: false

package/package.json

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