shoal-web-sdk 0.0.72 → 0.0.74

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses } from './types.gen';
2
+ import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses } from './types.gen';
3
3
  export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
4
4
  /**
5
5
  * You can provide a client instance returned by `createClient()` instead of
@@ -73,6 +73,10 @@ export declare const fetchKindeOrganisationBillingAgreements: <ThrowOnError exte
73
73
  * List members for a space.
74
74
  */
75
75
  export declare const listSpaceMembers: <ThrowOnError extends boolean = false>(options: Options<ListSpaceMembersData, ThrowOnError>) => import("./client").RequestResult<ListSpaceMembersResponses, ListSpaceMembersErrors, ThrowOnError, "fields">;
76
+ /**
77
+ * Remove the authenticated user from a space.
78
+ */
79
+ export declare const leaveSpace: <ThrowOnError extends boolean = false>(options: Options<LeaveSpaceData, ThrowOnError>) => import("./client").RequestResult<LeaveSpaceResponses, LeaveSpaceErrors, ThrowOnError, "fields">;
76
80
  /**
77
81
  * Create a project inside a space.
78
82
  */
@@ -229,6 +229,21 @@ export const listSpaceMembers = (options) => {
229
229
  ...options
230
230
  });
231
231
  };
232
+ /**
233
+ * Remove the authenticated user from a space.
234
+ */
235
+ export const leaveSpace = (options) => {
236
+ return (options.client ?? client).delete({
237
+ security: [
238
+ {
239
+ scheme: 'bearer',
240
+ type: 'http'
241
+ }
242
+ ],
243
+ url: '/auth/{spaceHandle}/members/leave',
244
+ ...options
245
+ });
246
+ };
232
247
  /**
233
248
  * Create a project inside a space.
234
249
  */
@@ -178,12 +178,12 @@ export type UserSpacesResponse = {
178
178
  };
179
179
  export type SpaceMember = {
180
180
  id: string;
181
- email?: string;
182
- first_name?: string;
183
- last_name?: string;
184
- full_name?: string;
185
- roles?: Array<string>;
186
- permissions?: Array<string>;
181
+ email: string;
182
+ first_name: string;
183
+ last_name: string;
184
+ full_name: string;
185
+ roles: Array<string>;
186
+ permissions: Array<string>;
187
187
  };
188
188
  export type SpaceMembersResponse = {
189
189
  members: Array<SpaceMember>;
@@ -889,6 +889,42 @@ export type ListSpaceMembersResponses = {
889
889
  200: SpaceMembersResponse;
890
890
  };
891
891
  export type ListSpaceMembersResponse = ListSpaceMembersResponses[keyof ListSpaceMembersResponses];
892
+ export type LeaveSpaceData = {
893
+ body?: never;
894
+ path: {
895
+ /**
896
+ * The space handle. This must be globally unique.
897
+ */
898
+ spaceHandle: string;
899
+ };
900
+ query?: never;
901
+ url: '/auth/{spaceHandle}/members/leave';
902
+ };
903
+ export type LeaveSpaceErrors = {
904
+ /**
905
+ * Unauthorised user.
906
+ */
907
+ 401: ErrorResponse;
908
+ /**
909
+ * Invalid credentials.
910
+ */
911
+ 403: ErrorResponse;
912
+ /**
913
+ * Related content not found.
914
+ */
915
+ 404: ErrorResponse;
916
+ /**
917
+ * Unexpected error.
918
+ */
919
+ 500: ErrorResponse;
920
+ };
921
+ export type LeaveSpaceError = LeaveSpaceErrors[keyof LeaveSpaceErrors];
922
+ export type LeaveSpaceResponses = {
923
+ /**
924
+ * Leave request accepted.
925
+ */
926
+ 202: unknown;
927
+ };
892
928
  export type CreateProjectData = {
893
929
  body: CreateProject;
894
930
  path: {
@@ -1,6 +1,6 @@
1
1
  import { useMutation } from "@tanstack/react-query";
2
2
  import { GetSuccessResponse } from "../util";
3
- import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, FetchKindeOrganisationBillingAgreementsData, ListSpaceMembersData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, FetchKindeOrganisationBillingAgreementsData, ListSpaceMembersData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses } from "../../sdk/types.gen";
4
4
  export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
5
5
  enabled?: boolean;
6
6
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").HealthResponse | undefined, Error>;
@@ -54,6 +54,11 @@ export declare const useFetchKindeOrganisationBillingAgreements: (options: Omit<
54
54
  export declare const useListSpaceMembers: (options: Omit<ListSpaceMembersData, "url"> & {
55
55
  enabled?: boolean;
56
56
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SpaceMembersResponse | undefined, Error>;
57
+ export declare const useLeaveSpace: (config?: {
58
+ onSuccess?: (data: GetSuccessResponse<LeaveSpaceResponses>) => void;
59
+ onError?: Parameters<typeof useMutation>["0"]["onError"];
60
+ retry?: boolean;
61
+ }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<LeaveSpaceData, "url">, unknown>;
57
62
  export declare const useCreateProject: (config?: {
58
63
  onSuccess?: (data: GetSuccessResponse<CreateProjectResponses>) => void;
59
64
  onError?: Parameters<typeof useMutation>["0"]["onError"];
@@ -2,7 +2,7 @@
2
2
  import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
3
3
  import { isPromise } from "../util";
4
4
  import { useToken } from "../../provider/token-provider";
5
- import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createSpace, getSpaceOverview, fetchKindeOrganisationBillingAgreements, listSpaceMembers, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, updateGraphState } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createSpace, getSpaceOverview, fetchKindeOrganisationBillingAgreements, listSpaceMembers, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, updateGraphState } from "../../sdk/sdk.gen";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -310,6 +310,25 @@ export const useListSpaceMembers = (options) => {
310
310
  staleTime: 600000
311
311
  });
312
312
  };
313
+ export const useLeaveSpace = (config) => {
314
+ const token = useToken();
315
+ const queryClient = useQueryClient();
316
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/members/leave" };
317
+ const funcer = async (options) => {
318
+ const auth = isPromise(token) ? (await token) || "" : token || "";
319
+ const res = await leaveSpace({ ...opts, ...options, auth });
320
+ return res?.data;
321
+ };
322
+ return useMutation({
323
+ mutationFn: funcer,
324
+ onSuccess: (res, options, c, ctx) => {
325
+ queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, "members", "leave"] });
326
+ config?.onSuccess && config.onSuccess(res);
327
+ },
328
+ onError: config?.onError,
329
+ retry: config?.retry
330
+ });
331
+ };
313
332
  export const useCreateProject = (config) => {
314
333
  const token = useToken();
315
334
  const queryClient = useQueryClient();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.72",
3
+ "version": "0.0.74",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",