shoal-web-sdk 0.0.50 → 0.0.52

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 { AddEdgesData, AddEdgesErrors, AddEdgesResponses, AddNodesData, AddNodesErrors, AddNodesResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, 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, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, RemoveEdgesData, RemoveEdgesErrors, RemoveEdgesResponses, RemoveNodesData, RemoveNodesErrors, RemoveNodesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses } from './types.gen';
2
+ import type { AddEdgesData, AddEdgesErrors, AddEdgesResponses, AddNodesData, AddNodesErrors, AddNodesResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceResponses, DeleteUserIdentityData, DeleteUserIdentityErrors, DeleteUserIdentityResponses, 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, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, RemoveEdgesData, RemoveEdgesErrors, RemoveEdgesResponses, RemoveNodesData, RemoveNodesErrors, RemoveNodesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses } 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
@@ -29,6 +29,10 @@ export declare const getUserProfile: <ThrowOnError extends boolean = false>(opti
29
29
  * Fetch the users identities.
30
30
  */
31
31
  export declare const getUserIdentities: <ThrowOnError extends boolean = false>(options?: Options<GetUserIdentitiesData, ThrowOnError>) => import("./client").RequestResult<GetUserIdentitiesResponses, GetUserIdentitiesErrors, ThrowOnError, "fields">;
32
+ /**
33
+ * Delete one of the authenticated user's identities.
34
+ */
35
+ export declare const deleteUserIdentity: <ThrowOnError extends boolean = false>(options: Options<DeleteUserIdentityData, ThrowOnError>) => import("./client").RequestResult<DeleteUserIdentityResponses, DeleteUserIdentityErrors, ThrowOnError, "fields">;
32
36
  /**
33
37
  * Fetch a connected app authorization URL for the authenticated user.
34
38
  */
@@ -60,6 +60,21 @@ export const getUserIdentities = (options) => {
60
60
  ...options
61
61
  });
62
62
  };
63
+ /**
64
+ * Delete one of the authenticated user's identities.
65
+ */
66
+ export const deleteUserIdentity = (options) => {
67
+ return (options.client ?? client).delete({
68
+ security: [
69
+ {
70
+ scheme: 'bearer',
71
+ type: 'http'
72
+ }
73
+ ],
74
+ url: '/auth/account/identities/{identityId}',
75
+ ...options
76
+ });
77
+ };
63
78
  /**
64
79
  * Fetch a connected app authorization URL for the authenticated user.
65
80
  */
@@ -18,7 +18,7 @@ export type ProjectOverview = {
18
18
  orgCode: string;
19
19
  name: string;
20
20
  handle: string;
21
- description?: string;
21
+ description: string;
22
22
  createdAt: string;
23
23
  updatedAt: string;
24
24
  environments: Array<EnvironmentOverview>;
@@ -46,7 +46,7 @@ export type EnvironmentOverview = {
46
46
  id: string;
47
47
  name: string;
48
48
  handle: string;
49
- description?: string;
49
+ description: string;
50
50
  createdAt: string;
51
51
  updatedAt: string;
52
52
  versions: number;
@@ -206,43 +206,38 @@ export type RemoveEdges = {
206
206
  edges: Array<EdgeVertices>;
207
207
  };
208
208
  export type AddNodes = {
209
- nodes: Array<CreateNode>;
209
+ nodes: Array<Node>;
210
210
  };
211
211
  export type RemoveNodes = {
212
212
  ids: Array<string>;
213
213
  };
214
- export type CreateNode = {
215
- x: number;
216
- y: number;
217
- typ: NodeType;
218
- };
219
214
  export type NodeType = 'cache' | 'comment' | 'container' | 'cronjob' | 'database' | 'function' | 'message_queue' | 'proxy' | 'vm';
220
215
  export type CommentNodeProps = {
221
- [key: string]: unknown;
216
+ comment?: string;
222
217
  };
223
218
  export type CacheNodeProps = {
224
- [key: string]: unknown;
219
+ a?: string;
225
220
  };
226
221
  export type ContainerNodeProps = {
227
- [key: string]: unknown;
222
+ b?: string;
228
223
  };
229
224
  export type CronJobNodeProps = {
230
- [key: string]: unknown;
225
+ c?: string;
231
226
  };
232
227
  export type DatabaseNodeProps = {
233
- [key: string]: unknown;
228
+ d?: string;
234
229
  };
235
230
  export type FunctionNodeProps = {
236
- [key: string]: unknown;
231
+ e?: string;
237
232
  };
238
233
  export type MessageQueueNodeProps = {
239
- [key: string]: unknown;
234
+ f?: string;
240
235
  };
241
236
  export type ProxyNodeProps = {
242
- [key: string]: unknown;
237
+ g?: string;
243
238
  };
244
239
  export type VmNodeProps = {
245
- [key: string]: unknown;
240
+ h?: string;
246
241
  };
247
242
  export type Edge = {
248
243
  id: string;
@@ -254,12 +249,12 @@ export type Graph = {
254
249
  };
255
250
  export type BaseNode = {
256
251
  id: string;
257
- versionId: string;
258
- name: string;
259
- description: string;
260
- x: number;
261
- y: number;
262
- edges: Array<Edge>;
252
+ versionId?: string;
253
+ name?: string;
254
+ description?: string;
255
+ x?: number;
256
+ y?: number;
257
+ edges?: Array<Edge>;
263
258
  };
264
259
  export type CommentNode = BaseNode & {
265
260
  typ: 'comment';
@@ -356,6 +351,10 @@ export type Limit = number;
356
351
  * Connected app key code reference from Kinde.
357
352
  */
358
353
  export type KeyCodeRef = string;
354
+ /**
355
+ * Identity ID to delete.
356
+ */
357
+ export type IdentityId = string;
359
358
  /**
360
359
  * Connected app session ID returned by Kinde.
361
360
  */
@@ -464,6 +463,43 @@ export type GetUserIdentitiesResponses = {
464
463
  200: AccountIdentities;
465
464
  };
466
465
  export type GetUserIdentitiesResponse = GetUserIdentitiesResponses[keyof GetUserIdentitiesResponses];
466
+ export type DeleteUserIdentityData = {
467
+ body?: never;
468
+ path: {
469
+ /**
470
+ * Identity ID to delete.
471
+ */
472
+ identityId: string;
473
+ };
474
+ query?: never;
475
+ url: '/auth/account/identities/{identityId}';
476
+ };
477
+ export type DeleteUserIdentityErrors = {
478
+ /**
479
+ * Invalid request parameters.
480
+ */
481
+ 400: ErrorResponse;
482
+ /**
483
+ * Unauthorised user.
484
+ */
485
+ 401: ErrorResponse;
486
+ /**
487
+ * Invalid credentials.
488
+ */
489
+ 403: ErrorResponse;
490
+ /**
491
+ * Unexpected error.
492
+ */
493
+ 500: ErrorResponse;
494
+ };
495
+ export type DeleteUserIdentityError = DeleteUserIdentityErrors[keyof DeleteUserIdentityErrors];
496
+ export type DeleteUserIdentityResponses = {
497
+ /**
498
+ * Identity deleted successfully.
499
+ */
500
+ 204: void;
501
+ };
502
+ export type DeleteUserIdentityResponse = DeleteUserIdentityResponses[keyof DeleteUserIdentityResponses];
467
503
  export type GetConnectedAppUrlData = {
468
504
  body?: never;
469
505
  path?: never;
@@ -1050,9 +1086,9 @@ export type RemoveNodesErrors = {
1050
1086
  export type RemoveNodesError = RemoveNodesErrors[keyof RemoveNodesErrors];
1051
1087
  export type RemoveNodesResponses = {
1052
1088
  /**
1053
- * A graph overview.
1089
+ * A node is successfully removed from the graph.
1054
1090
  */
1055
- 200: Graph;
1091
+ 204: void;
1056
1092
  };
1057
1093
  export type RemoveNodesResponse = RemoveNodesResponses[keyof RemoveNodesResponses];
1058
1094
  export type AddNodesData = {
@@ -1099,11 +1135,10 @@ export type AddNodesErrors = {
1099
1135
  export type AddNodesError = AddNodesErrors[keyof AddNodesErrors];
1100
1136
  export type AddNodesResponses = {
1101
1137
  /**
1102
- * A graph overview.
1138
+ * A node is successfully added to the graph.
1103
1139
  */
1104
- 200: Graph;
1140
+ 201: unknown;
1105
1141
  };
1106
- export type AddNodesResponse = AddNodesResponses[keyof AddNodesResponses];
1107
1142
  export type RemoveEdgesData = {
1108
1143
  body: RemoveEdges;
1109
1144
  path: {
@@ -1148,9 +1183,9 @@ export type RemoveEdgesErrors = {
1148
1183
  export type RemoveEdgesError = RemoveEdgesErrors[keyof RemoveEdgesErrors];
1149
1184
  export type RemoveEdgesResponses = {
1150
1185
  /**
1151
- * A graph overview.
1186
+ * An edge is successfully removed.
1152
1187
  */
1153
- 200: Graph;
1188
+ 204: void;
1154
1189
  };
1155
1190
  export type RemoveEdgesResponse = RemoveEdgesResponses[keyof RemoveEdgesResponses];
1156
1191
  export type AddEdgesData = {
@@ -1197,8 +1232,7 @@ export type AddEdgesErrors = {
1197
1232
  export type AddEdgesError = AddEdgesErrors[keyof AddEdgesErrors];
1198
1233
  export type AddEdgesResponses = {
1199
1234
  /**
1200
- * A graph overview.
1235
+ * An edge is successfully added.
1201
1236
  */
1202
- 200: Graph;
1237
+ 201: unknown;
1203
1238
  };
1204
- export type AddEdgesResponse = AddEdgesResponses[keyof AddEdgesResponses];
@@ -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, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, FetchKindeOrganisationBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, RemoveNodesData, RemoveNodesResponses, AddNodesData, AddNodesResponses, RemoveEdgesData, RemoveEdgesResponses, AddEdgesData, AddEdgesResponses } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, DeleteUserIdentityData, DeleteUserIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, FetchKindeOrganisationBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, RemoveNodesData, RemoveNodesResponses, AddNodesData, AddNodesResponses, RemoveEdgesData, RemoveEdgesResponses, AddEdgesData, AddEdgesResponses } 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>;
@@ -15,6 +15,11 @@ export declare const useGetUserProfile: (options?: Omit<GetUserProfileData, "url
15
15
  export declare const useGetUserIdentities: (options?: Omit<GetUserIdentitiesData, "url"> & {
16
16
  enabled?: boolean;
17
17
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").AccountIdentities | undefined, Error>;
18
+ export declare const useDeleteUserIdentity: (config?: {
19
+ onSuccess?: (data: GetSuccessResponse<DeleteUserIdentityResponses>) => void;
20
+ onError?: Parameters<typeof useMutation>["0"]["onError"];
21
+ retry?: boolean;
22
+ }) => import("@tanstack/react-query").UseMutationResult<void | undefined, unknown, Omit<DeleteUserIdentityData, "url">, unknown>;
18
23
  export declare const useGetConnectedAppUrl: (options: Omit<GetConnectedAppUrlData, "url"> & {
19
24
  enabled?: boolean;
20
25
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").ConnectedAppUrlResponse | undefined, Error>;
@@ -66,19 +71,19 @@ export declare const useRemoveNodes: (config?: {
66
71
  onSuccess?: (data: GetSuccessResponse<RemoveNodesResponses>) => void;
67
72
  onError?: Parameters<typeof useMutation>["0"]["onError"];
68
73
  retry?: boolean;
69
- }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<RemoveNodesData, "url">, unknown>;
74
+ }) => import("@tanstack/react-query").UseMutationResult<void | undefined, unknown, Omit<RemoveNodesData, "url">, unknown>;
70
75
  export declare const useAddNodes: (config?: {
71
76
  onSuccess?: (data: GetSuccessResponse<AddNodesResponses>) => void;
72
77
  onError?: Parameters<typeof useMutation>["0"]["onError"];
73
78
  retry?: boolean;
74
- }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<AddNodesData, "url">, unknown>;
79
+ }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<AddNodesData, "url">, unknown>;
75
80
  export declare const useRemoveEdges: (config?: {
76
81
  onSuccess?: (data: GetSuccessResponse<RemoveEdgesResponses>) => void;
77
82
  onError?: Parameters<typeof useMutation>["0"]["onError"];
78
83
  retry?: boolean;
79
- }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<RemoveEdgesData, "url">, unknown>;
84
+ }) => import("@tanstack/react-query").UseMutationResult<void | undefined, unknown, Omit<RemoveEdgesData, "url">, unknown>;
80
85
  export declare const useAddEdges: (config?: {
81
86
  onSuccess?: (data: GetSuccessResponse<AddEdgesResponses>) => void;
82
87
  onError?: Parameters<typeof useMutation>["0"]["onError"];
83
88
  retry?: boolean;
84
- }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").Graph | undefined, unknown, Omit<AddEdgesData, "url">, unknown>;
89
+ }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<AddEdgesData, "url">, unknown>;
@@ -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, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, createSpace, getSpaceOverview, fetchKindeOrganisationBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, removeNodes, addNodes, removeEdges, addEdges } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, requestAccountPasswordReset, getUserProfile, getUserIdentities, deleteUserIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, createSpace, getSpaceOverview, fetchKindeOrganisationBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, removeNodes, addNodes, removeEdges, addEdges } from "../../sdk/sdk.gen";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -85,6 +85,25 @@ export const useGetUserIdentities = (options) => {
85
85
  staleTime: 600000
86
86
  });
87
87
  };
88
+ export const useDeleteUserIdentity = (config) => {
89
+ const token = useToken();
90
+ const queryClient = useQueryClient();
91
+ const opts = { throwOnError: true, url: "/auth/account/identities/{identityId}" };
92
+ const funcer = async (options) => {
93
+ const auth = isPromise(token) ? (await token) || "" : token || "";
94
+ const res = await deleteUserIdentity({ ...opts, ...options, auth });
95
+ return res?.data;
96
+ };
97
+ return useMutation({
98
+ mutationFn: funcer,
99
+ onSuccess: (res, options, c, ctx) => {
100
+ queryClient.invalidateQueries({ queryKey: ["account", "identities", options?.path?.identityId] });
101
+ config?.onSuccess && config.onSuccess(res);
102
+ },
103
+ onError: config?.onError,
104
+ retry: config?.retry
105
+ });
106
+ };
88
107
  export const useGetConnectedAppUrl = (options) => {
89
108
  const token = useToken();
90
109
  let { enabled, ...rest } = options || { enabled: true };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.50",
3
+ "version": "0.0.52",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",