shoal-web-sdk 0.0.116 → 0.0.118

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,6 +1,6 @@
1
1
  import { type InfiniteData, type UseMutationOptions } from '@tanstack/react-query';
2
2
  import { type Options } from '../sdk.gen';
3
- import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError } from '../types.gen';
3
+ import type { CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError } from '../types.gen';
4
4
  export type QueryKey<TOptions extends Options> = [
5
5
  Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
6
6
  _id: string;
@@ -776,34 +776,10 @@ export declare const updateGraphStateMutation: (options?: Partial<Options<Update
776
776
  * Trigger a deployment for a version inside an environment.
777
777
  */
778
778
  export declare const deployVersionMutation: (options?: Partial<Options<DeployVersionData>>) => UseMutationOptions<unknown, DeployVersionError, Options<DeployVersionData>>;
779
- export declare const requestSignedUploadUrlQueryKey: (options: Options<RequestSignedUploadUrlData>) => [Pick<Options<RequestSignedUploadUrlData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
780
- _id: string;
781
- _infinite?: boolean;
782
- tags?: ReadonlyArray<string>;
783
- }];
784
779
  /**
785
780
  * Request a signed upload URL to upload source code zip files.
786
781
  */
787
- export declare const requestSignedUploadUrlOptions: (options: Options<RequestSignedUploadUrlData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").SignedUrlUploadResponse, Error, import("../types.gen").SignedUrlUploadResponse, [Pick<Options<RequestSignedUploadUrlData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
788
- _id: string;
789
- _infinite?: boolean;
790
- tags?: ReadonlyArray<string>;
791
- }]>, "queryFn"> & {
792
- queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").SignedUrlUploadResponse, [Pick<Options<RequestSignedUploadUrlData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
793
- _id: string;
794
- _infinite?: boolean;
795
- tags?: ReadonlyArray<string>;
796
- }], never> | undefined;
797
- } & {
798
- queryKey: [Pick<Options<RequestSignedUploadUrlData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
799
- _id: string;
800
- _infinite?: boolean;
801
- tags?: ReadonlyArray<string>;
802
- }] & {
803
- [dataTagSymbol]: import("../types.gen").SignedUrlUploadResponse;
804
- [dataTagErrorSymbol]: Error;
805
- };
806
- };
782
+ export declare const requestSignedUploadUrlMutation: (options?: Partial<Options<RequestSignedUploadUrlData>>) => UseMutationOptions<RequestSignedUploadUrlResponse, RequestSignedUploadUrlError, Options<RequestSignedUploadUrlData>>;
807
783
  /**
808
784
  * Record a cloud usage event for a space (M2M only).
809
785
  */
@@ -859,23 +859,21 @@ export const deployVersionMutation = (options) => {
859
859
  };
860
860
  return mutationOptions;
861
861
  };
862
- export const requestSignedUploadUrlQueryKey = (options) => createQueryKey('requestSignedUploadUrl', options);
863
862
  /**
864
863
  * Request a signed upload URL to upload source code zip files.
865
864
  */
866
- export const requestSignedUploadUrlOptions = (options) => {
867
- return queryOptions({
868
- queryFn: async ({ queryKey, signal }) => {
865
+ export const requestSignedUploadUrlMutation = (options) => {
866
+ const mutationOptions = {
867
+ mutationFn: async (fnOptions) => {
869
868
  const { data } = await requestSignedUploadUrl({
870
869
  ...options,
871
- ...queryKey[0],
872
- signal,
870
+ ...fnOptions,
873
871
  throwOnError: true
874
872
  });
875
873
  return data;
876
- },
877
- queryKey: requestSignedUploadUrlQueryKey(options)
878
- });
874
+ }
875
+ };
876
+ return mutationOptions;
879
877
  };
880
878
  /**
881
879
  * Record a cloud usage event for a space (M2M only).
@@ -580,7 +580,7 @@ export const deployVersion = (options) => {
580
580
  * Request a signed upload URL to upload source code zip files.
581
581
  */
582
582
  export const requestSignedUploadUrl = (options) => {
583
- return (options.client ?? client).get({
583
+ return (options.client ?? client).post({
584
584
  security: [
585
585
  {
586
586
  scheme: 'bearer',
@@ -323,6 +323,7 @@ export type ContainerNodeProps = {
323
323
  concurrency?: number;
324
324
  allowUnauthenticated?: boolean;
325
325
  uri: string;
326
+ installationId?: string;
326
327
  env?: {
327
328
  [key: string]: string;
328
329
  };
@@ -572,6 +572,7 @@ export declare const zContainerNodeProps: z.ZodObject<{
572
572
  concurrency: z.ZodOptional<z.ZodInt>;
573
573
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
574
574
  uri: z.ZodString;
575
+ installationId: z.ZodOptional<z.ZodString>;
575
576
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
576
577
  }, z.core.$strip>;
577
578
  export declare const zCronJobNodeProps: z.ZodObject<{
@@ -702,6 +703,7 @@ export declare const zNode: z.ZodObject<{
702
703
  concurrency: z.ZodOptional<z.ZodInt>;
703
704
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
704
705
  uri: z.ZodString;
706
+ installationId: z.ZodOptional<z.ZodString>;
705
707
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
706
708
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
707
709
  typ: z.ZodLiteral<"cronjob">;
@@ -845,6 +847,7 @@ export declare const zNodes: z.ZodObject<{
845
847
  concurrency: z.ZodOptional<z.ZodInt>;
846
848
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
847
849
  uri: z.ZodString;
850
+ installationId: z.ZodOptional<z.ZodString>;
848
851
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
849
852
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
850
853
  typ: z.ZodLiteral<"cronjob">;
@@ -990,6 +993,7 @@ export declare const zGraph: z.ZodObject<{
990
993
  concurrency: z.ZodOptional<z.ZodInt>;
991
994
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
992
995
  uri: z.ZodString;
996
+ installationId: z.ZodOptional<z.ZodString>;
993
997
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
994
998
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
995
999
  typ: z.ZodLiteral<"cronjob">;
@@ -1286,6 +1290,7 @@ export declare const zFetchGraphM2mResponse: z.ZodObject<{
1286
1290
  concurrency: z.ZodOptional<z.ZodInt>;
1287
1291
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
1288
1292
  uri: z.ZodString;
1293
+ installationId: z.ZodOptional<z.ZodString>;
1289
1294
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
1290
1295
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1291
1296
  typ: z.ZodLiteral<"cronjob">;
@@ -1431,6 +1436,7 @@ export declare const zUpdateGraphM2mData: z.ZodObject<{
1431
1436
  concurrency: z.ZodOptional<z.ZodInt>;
1432
1437
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
1433
1438
  uri: z.ZodString;
1439
+ installationId: z.ZodOptional<z.ZodString>;
1434
1440
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
1435
1441
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
1436
1442
  typ: z.ZodLiteral<"cronjob">;
@@ -2170,6 +2176,7 @@ export declare const zGetGraphOverviewResponse: z.ZodObject<{
2170
2176
  concurrency: z.ZodOptional<z.ZodInt>;
2171
2177
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
2172
2178
  uri: z.ZodString;
2179
+ installationId: z.ZodOptional<z.ZodString>;
2173
2180
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
2174
2181
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2175
2182
  typ: z.ZodLiteral<"cronjob">;
@@ -2315,6 +2322,7 @@ export declare const zUpdateGraphStateData: z.ZodObject<{
2315
2322
  concurrency: z.ZodOptional<z.ZodInt>;
2316
2323
  allowUnauthenticated: z.ZodOptional<z.ZodBoolean>;
2317
2324
  uri: z.ZodString;
2325
+ installationId: z.ZodOptional<z.ZodString>;
2318
2326
  env: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
2319
2327
  }, z.core.$strip>>, z.ZodIntersection<z.ZodObject<{
2320
2328
  typ: z.ZodLiteral<"cronjob">;
@@ -372,6 +372,7 @@ export const zContainerNodeProps = z.object({
372
372
  concurrency: z.optional(z.int()),
373
373
  allowUnauthenticated: z.optional(z.boolean()),
374
374
  uri: z.string(),
375
+ installationId: z.optional(z.string()),
375
376
  env: z.optional(z.record(z.string(), z.string()))
376
377
  });
377
378
  export const zCronJobNodeProps = z.object({
@@ -1,6 +1,6 @@
1
1
  import { useMutation } from "@tanstack/react-query";
2
2
  import { GetSuccessResponse } from "../util";
3
- import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedUploadUrlData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData } 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>;
@@ -143,9 +143,11 @@ export declare const useDeployVersion: (config?: {
143
143
  onError?: Parameters<typeof useMutation>["0"]["onError"];
144
144
  retry?: boolean;
145
145
  }) => import("@tanstack/react-query").UseMutationResult<unknown, unknown, Omit<DeployVersionData, "url">, unknown>;
146
- export declare const useRequestSignedUploadUrl: (options: Omit<RequestSignedUploadUrlData, "url"> & {
147
- enabled?: boolean;
148
- }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").SignedUrlUploadResponse | undefined, Error>;
146
+ export declare const useRequestSignedUploadUrl: (config?: {
147
+ onSuccess?: (data: GetSuccessResponse<RequestSignedUploadUrlResponses>) => void;
148
+ onError?: Parameters<typeof useMutation>["0"]["onError"];
149
+ retry?: boolean;
150
+ }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").SignedUrlUploadResponse | undefined, unknown, Omit<RequestSignedUploadUrlData, "url">, unknown>;
149
151
  export declare const useRecordCloudUsage: (config?: {
150
152
  onSuccess?: (data: GetSuccessResponse<RecordCloudUsageResponses>) => void;
151
153
  onError?: Parameters<typeof useMutation>["0"]["onError"];
@@ -725,25 +725,23 @@ export const useDeployVersion = (config) => {
725
725
  retry: config?.retry
726
726
  });
727
727
  };
728
- export const useRequestSignedUploadUrl = (options) => {
728
+ export const useRequestSignedUploadUrl = (config) => {
729
729
  const token = useToken();
730
- let { enabled, ...rest } = options || { enabled: true };
730
+ const queryClient = useQueryClient();
731
731
  const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/nodes/{nodeUUID}/signed-upload-url" };
732
- const funcer = async () => {
732
+ const funcer = async (options) => {
733
733
  const auth = isPromise(token) ? (await token) || "" : token || "";
734
- if (isPromise(token) && !token)
735
- return;
736
- const res = await requestSignedUploadUrl({ ...opts, ...rest, auth });
737
- return res.data;
734
+ const res = await requestSignedUploadUrl({ ...opts, ...options, auth });
735
+ return res?.data;
738
736
  };
739
- if (!token)
740
- enabled = false;
741
- return useQuery({
742
- queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", "nodes", options?.path?.nodeUUID, "signed-upload-url", options.query ?? {}],
743
- queryFn: funcer,
744
- enabled,
745
- retry: false,
746
- staleTime: 600000
737
+ return useMutation({
738
+ mutationFn: funcer,
739
+ onSuccess: (res, options, c, ctx) => {
740
+ queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", "nodes", options?.path?.nodeUUID, "signed-upload-url"] });
741
+ config?.onSuccess && config.onSuccess(res);
742
+ },
743
+ onError: config?.onError,
744
+ retry: config?.retry
747
745
  });
748
746
  };
749
747
  export const useRecordCloudUsage = (config) => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.116",
3
+ "version": "0.0.118",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",