shoal-web-sdk 0.0.52 → 0.0.54

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, 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';
2
+ import type { AddEdgesData, AddEdgesErrors, AddEdgesResponses, AddNodesData, AddNodesErrors, AddNodesResponses, 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, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, RemoveEdgesData, RemoveEdgesErrors, RemoveEdgesResponses, RemoveNodesData, RemoveNodesErrors, RemoveNodesResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateNodesData, UpdateNodesErrors, UpdateNodesResponses } 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
@@ -32,7 +32,7 @@ export declare const getUserIdentities: <ThrowOnError extends boolean = false>(o
32
32
  /**
33
33
  * Delete one of the authenticated user's identities.
34
34
  */
35
- export declare const deleteUserIdentity: <ThrowOnError extends boolean = false>(options: Options<DeleteUserIdentityData, ThrowOnError>) => import("./client").RequestResult<DeleteUserIdentityResponses, DeleteUserIdentityErrors, ThrowOnError, "fields">;
35
+ export declare const deleteAccountIdentity: <ThrowOnError extends boolean = false>(options: Options<DeleteAccountIdentityData, ThrowOnError>) => import("./client").RequestResult<DeleteAccountIdentityResponses, DeleteAccountIdentityErrors, ThrowOnError, "fields">;
36
36
  /**
37
37
  * Fetch a connected app authorization URL for the authenticated user.
38
38
  */
@@ -93,6 +93,10 @@ export declare const removeNodes: <ThrowOnError extends boolean = false>(options
93
93
  * Add nodes to a graph for a version. This creates initialised node rows that must later be updated.
94
94
  */
95
95
  export declare const addNodes: <ThrowOnError extends boolean = false>(options: Options<AddNodesData, ThrowOnError>) => import("./client").RequestResult<AddNodesResponses, AddNodesErrors, ThrowOnError, "fields">;
96
+ /**
97
+ * Updates nodes to a graph for a version. This operates like a put, so all fields are required when updating to persist data.
98
+ */
99
+ export declare const updateNodes: <ThrowOnError extends boolean = false>(options: Options<UpdateNodesData, ThrowOnError>) => import("./client").RequestResult<UpdateNodesResponses, UpdateNodesErrors, ThrowOnError, "fields">;
96
100
  /**
97
101
  * Remove edges from a graph.
98
102
  */
@@ -63,7 +63,7 @@ export const getUserIdentities = (options) => {
63
63
  /**
64
64
  * Delete one of the authenticated user's identities.
65
65
  */
66
- export const deleteUserIdentity = (options) => {
66
+ export const deleteAccountIdentity = (options) => {
67
67
  return (options.client ?? client).delete({
68
68
  security: [
69
69
  {
@@ -320,6 +320,25 @@ export const addNodes = (options) => {
320
320
  }
321
321
  });
322
322
  };
323
+ /**
324
+ * Updates nodes to a graph for a version. This operates like a put, so all fields are required when updating to persist data.
325
+ */
326
+ export const updateNodes = (options) => {
327
+ return (options.client ?? client).put({
328
+ security: [
329
+ {
330
+ scheme: 'bearer',
331
+ type: 'http'
332
+ }
333
+ ],
334
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes',
335
+ ...options,
336
+ headers: {
337
+ 'Content-Type': 'application/json',
338
+ ...options.headers
339
+ }
340
+ });
341
+ };
323
342
  /**
324
343
  * Remove edges from a graph.
325
344
  */
@@ -205,7 +205,7 @@ export type AddEdges = {
205
205
  export type RemoveEdges = {
206
206
  edges: Array<EdgeVertices>;
207
207
  };
208
- export type AddNodes = {
208
+ export type Nodes = {
209
209
  nodes: Array<Node>;
210
210
  };
211
211
  export type RemoveNodes = {
@@ -463,7 +463,7 @@ export type GetUserIdentitiesResponses = {
463
463
  200: AccountIdentities;
464
464
  };
465
465
  export type GetUserIdentitiesResponse = GetUserIdentitiesResponses[keyof GetUserIdentitiesResponses];
466
- export type DeleteUserIdentityData = {
466
+ export type DeleteAccountIdentityData = {
467
467
  body?: never;
468
468
  path: {
469
469
  /**
@@ -474,7 +474,7 @@ export type DeleteUserIdentityData = {
474
474
  query?: never;
475
475
  url: '/auth/account/identities/{identityId}';
476
476
  };
477
- export type DeleteUserIdentityErrors = {
477
+ export type DeleteAccountIdentityErrors = {
478
478
  /**
479
479
  * Invalid request parameters.
480
480
  */
@@ -492,14 +492,14 @@ export type DeleteUserIdentityErrors = {
492
492
  */
493
493
  500: ErrorResponse;
494
494
  };
495
- export type DeleteUserIdentityError = DeleteUserIdentityErrors[keyof DeleteUserIdentityErrors];
496
- export type DeleteUserIdentityResponses = {
495
+ export type DeleteAccountIdentityError = DeleteAccountIdentityErrors[keyof DeleteAccountIdentityErrors];
496
+ export type DeleteAccountIdentityResponses = {
497
497
  /**
498
498
  * Identity deleted successfully.
499
499
  */
500
500
  204: void;
501
501
  };
502
- export type DeleteUserIdentityResponse = DeleteUserIdentityResponses[keyof DeleteUserIdentityResponses];
502
+ export type DeleteAccountIdentityResponse = DeleteAccountIdentityResponses[keyof DeleteAccountIdentityResponses];
503
503
  export type GetConnectedAppUrlData = {
504
504
  body?: never;
505
505
  path?: never;
@@ -1092,7 +1092,7 @@ export type RemoveNodesResponses = {
1092
1092
  };
1093
1093
  export type RemoveNodesResponse = RemoveNodesResponses[keyof RemoveNodesResponses];
1094
1094
  export type AddNodesData = {
1095
- body: AddNodes;
1095
+ body: Nodes;
1096
1096
  path: {
1097
1097
  /**
1098
1098
  * The space handle. This must be globally unique.
@@ -1139,6 +1139,54 @@ export type AddNodesResponses = {
1139
1139
  */
1140
1140
  201: unknown;
1141
1141
  };
1142
+ export type UpdateNodesData = {
1143
+ body: Nodes;
1144
+ path: {
1145
+ /**
1146
+ * The space handle. This must be globally unique.
1147
+ */
1148
+ spaceHandle: string;
1149
+ /**
1150
+ * A project name. This must be unique to a space.
1151
+ */
1152
+ projectHandle: string;
1153
+ /**
1154
+ * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
1155
+ */
1156
+ environmentHandle: string;
1157
+ /**
1158
+ * A version number with in an environment.
1159
+ */
1160
+ version: string;
1161
+ };
1162
+ query?: never;
1163
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes';
1164
+ };
1165
+ export type UpdateNodesErrors = {
1166
+ /**
1167
+ * Unauthorised user.
1168
+ */
1169
+ 401: ErrorResponse;
1170
+ /**
1171
+ * Invalid credentials.
1172
+ */
1173
+ 403: ErrorResponse;
1174
+ /**
1175
+ * Related content not found.
1176
+ */
1177
+ 404: ErrorResponse;
1178
+ /**
1179
+ * Unexpected error.
1180
+ */
1181
+ 500: ErrorResponse;
1182
+ };
1183
+ export type UpdateNodesError = UpdateNodesErrors[keyof UpdateNodesErrors];
1184
+ export type UpdateNodesResponses = {
1185
+ /**
1186
+ * A node is successfully update in the graph.
1187
+ */
1188
+ 202: unknown;
1189
+ };
1142
1190
  export type RemoveEdgesData = {
1143
1191
  body: RemoveEdges;
1144
1192
  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, 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";
3
+ import { GetServiceHealthData, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, GetUserProfileData, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, CreateSpaceData, CreateSpaceResponses, GetSpaceOverviewData, FetchKindeOrganisationBillingAgreementsData, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, RemoveNodesData, RemoveNodesResponses, AddNodesData, AddNodesResponses, UpdateNodesData, UpdateNodesResponses, 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,11 +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;
18
+ export declare const useDeleteAccountIdentity: (config?: {
19
+ onSuccess?: (data: GetSuccessResponse<DeleteAccountIdentityResponses>) => void;
20
20
  onError?: Parameters<typeof useMutation>["0"]["onError"];
21
21
  retry?: boolean;
22
- }) => import("@tanstack/react-query").UseMutationResult<void | undefined, unknown, Omit<DeleteUserIdentityData, "url">, unknown>;
22
+ }) => import("@tanstack/react-query").UseMutationResult<void | undefined, unknown, Omit<DeleteAccountIdentityData, "url">, unknown>;
23
23
  export declare const useGetConnectedAppUrl: (options: Omit<GetConnectedAppUrlData, "url"> & {
24
24
  enabled?: boolean;
25
25
  }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").ConnectedAppUrlResponse | undefined, Error>;
@@ -77,6 +77,11 @@ export declare const useAddNodes: (config?: {
77
77
  onError?: Parameters<typeof useMutation>["0"]["onError"];
78
78
  retry?: boolean;
79
79
  }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<AddNodesData, "url">, unknown>;
80
+ export declare const useUpdateNodes: (config?: {
81
+ onSuccess?: (data: GetSuccessResponse<UpdateNodesResponses>) => void;
82
+ onError?: Parameters<typeof useMutation>["0"]["onError"];
83
+ retry?: boolean;
84
+ }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<UpdateNodesData, "url">, unknown>;
80
85
  export declare const useRemoveEdges: (config?: {
81
86
  onSuccess?: (data: GetSuccessResponse<RemoveEdgesResponses>) => void;
82
87
  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, deleteUserIdentity, 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, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, createSpace, getSpaceOverview, fetchKindeOrganisationBillingAgreements, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getGraphOverview, removeNodes, addNodes, updateNodes, 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,13 +85,13 @@ export const useGetUserIdentities = (options) => {
85
85
  staleTime: 600000
86
86
  });
87
87
  };
88
- export const useDeleteUserIdentity = (config) => {
88
+ export const useDeleteAccountIdentity = (config) => {
89
89
  const token = useToken();
90
90
  const queryClient = useQueryClient();
91
91
  const opts = { throwOnError: true, url: "/auth/account/identities/{identityId}" };
92
92
  const funcer = async (options) => {
93
93
  const auth = isPromise(token) ? (await token) || "" : token || "";
94
- const res = await deleteUserIdentity({ ...opts, ...options, auth });
94
+ const res = await deleteAccountIdentity({ ...opts, ...options, auth });
95
95
  return res?.data;
96
96
  };
97
97
  return useMutation({
@@ -407,6 +407,25 @@ export const useAddNodes = (config) => {
407
407
  retry: config?.retry
408
408
  });
409
409
  };
410
+ export const useUpdateNodes = (config) => {
411
+ const token = useToken();
412
+ const queryClient = useQueryClient();
413
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/nodes" };
414
+ const funcer = async (options) => {
415
+ const auth = isPromise(token) ? (await token) || "" : token || "";
416
+ const res = await updateNodes({ ...opts, ...options, auth });
417
+ return res?.data;
418
+ };
419
+ return useMutation({
420
+ mutationFn: funcer,
421
+ onSuccess: (res, options, c, ctx) => {
422
+ queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "nodes"] });
423
+ config?.onSuccess && config.onSuccess(res);
424
+ },
425
+ onError: config?.onError,
426
+ retry: config?.retry
427
+ });
428
+ };
410
429
  export const useRemoveEdges = (config) => {
411
430
  const token = useToken();
412
431
  const queryClient = useQueryClient();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.52",
3
+ "version": "0.0.54",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",