shoal-web-sdk 0.0.152 → 0.0.154

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, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
3
+ import type { CheckSubdomainUniquenessData, CreateEnvironmentData, CreateEnvironmentError, CreateEnvironmentResponse, CreateEnvironmentVariableData, CreateEnvironmentVariableError, CreateProjectData, CreateProjectError, CreateProjectResponse, CreateSetupIntentData, CreateSetupIntentError, CreateSetupIntentResponse, CreateSpaceData, CreateSpaceError, CreateSpaceInviteData, CreateSpaceInviteError, CreateSpaceInviteResponse, CreateSpaceResponse, CreateUsernameData, CreateUsernameError, DeleteAccountIdentityData, DeleteAccountIdentityError, DeleteAccountIdentityResponse, DeleteEnvironmentVariableData, DeleteEnvironmentVariableError, DeleteEnvironmentVariableResponse, DeployVersionData, DeployVersionError, FetchBillingPricesData, FetchGraphM2mData, FetchKindeOrganisationBillingAgreementsData, FetchNodeM2mData, GetBillingPlanData, GetBillingUsageData, GetConnectedAppUrlData, GetEnvironmentOverviewData, GetEnvironmentVariablesData, GetEnvironmentVersionsData, GetGraphOverviewData, GetProjectOverviewData, GetServiceHealthData, GetSpaceInvitesData, GetSpaceOrgCodeData, GetSpaceOverviewData, GetSpaceStatsData, GetUserIdentitiesData, GetUserInvitesData, GetUserProfileData, JoinSpaceData, JoinSpaceError, LeaveSpaceData, LeaveSpaceError, ListBillingInvoicesData, ListInstallationBranchesData, ListInstallationRepositoriesData, ListPaymentMethodsData, ListSpaceMemberRolesData, ListSpaceMembersData, ListUserInstallationsData, ListUserSpacesData, RecordCloudUsageData, RecordCloudUsageError, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsError, RejectSpaceInviteData, RejectSpaceInviteError, RejectSpaceInviteResponse, RemovePaymentMethodData, RemovePaymentMethodError, RemovePaymentMethodResponse, RequestAccountPasswordResetData, RequestAccountPasswordResetError, RequestSignedUploadUrlData, RequestSignedUploadUrlError, RequestSignedUploadUrlResponse, RevokeSpaceInviteData, RevokeSpaceInviteError, RevokeSpaceInviteResponse, SetDefaultPaymentMethodData, SetDefaultPaymentMethodError, SetDefaultPaymentMethodResponse, UpdateBillingPlanData, UpdateBillingPlanError, UpdateConnectedAppTokenData, UpdateConnectedAppTokenError, UpdateEnvironmentVariableData, UpdateEnvironmentVariableError, UpdateGraphM2mData, UpdateGraphM2mError, UpdateGraphStateData, UpdateGraphStateError, UpdateNodeM2mData, UpdateNodeM2mError, UpdateUsernameData, UpdateUsernameError, UpdateUserProfileData, UpdateUserProfileError, VersionStatusData } from '../types.gen';
4
4
  export type QueryKey<TOptions extends Options> = [
5
5
  Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
6
6
  _id: string;
@@ -964,6 +964,34 @@ export declare const versionStatusOptions: (options: Options<VersionStatusData>)
964
964
  * Request a signed upload URL to upload source code zip files.
965
965
  */
966
966
  export declare const requestSignedUploadUrlMutation: (options?: Partial<Options<RequestSignedUploadUrlData>>) => UseMutationOptions<RequestSignedUploadUrlResponse, RequestSignedUploadUrlError, Options<RequestSignedUploadUrlData>>;
967
+ export declare const checkSubdomainUniquenessQueryKey: (options: Options<CheckSubdomainUniquenessData>) => [Pick<Options<CheckSubdomainUniquenessData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
968
+ _id: string;
969
+ _infinite?: boolean;
970
+ tags?: ReadonlyArray<string>;
971
+ }];
972
+ /**
973
+ * Check if a proxy subdomain is unique within the current version and environment.
974
+ */
975
+ export declare const checkSubdomainUniquenessOptions: (options: Options<CheckSubdomainUniquenessData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<void, Error, void, [Pick<Options<CheckSubdomainUniquenessData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
976
+ _id: string;
977
+ _infinite?: boolean;
978
+ tags?: ReadonlyArray<string>;
979
+ }]>, "queryFn"> & {
980
+ queryFn?: import("@tanstack/react-query").QueryFunction<void, [Pick<Options<CheckSubdomainUniquenessData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
981
+ _id: string;
982
+ _infinite?: boolean;
983
+ tags?: ReadonlyArray<string>;
984
+ }], never> | undefined;
985
+ } & {
986
+ queryKey: [Pick<Options<CheckSubdomainUniquenessData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
987
+ _id: string;
988
+ _infinite?: boolean;
989
+ tags?: ReadonlyArray<string>;
990
+ }] & {
991
+ [dataTagSymbol]: void;
992
+ [dataTagErrorSymbol]: Error;
993
+ };
994
+ };
967
995
  /**
968
996
  * Record a cloud usage event for a space (M2M only).
969
997
  */
@@ -1,7 +1,7 @@
1
1
  // This file is auto-generated by @hey-api/openapi-ts
2
2
  import { infiniteQueryOptions, queryOptions } from '@tanstack/react-query';
3
3
  import { client } from '../client.gen';
4
- import { createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
4
+ import { checkSubdomainUniqueness, createEnvironment, createEnvironmentVariable, createProject, createSetupIntent, createSpace, createSpaceInvite, createUsername, deleteAccountIdentity, deleteEnvironmentVariable, deployVersion, fetchBillingPrices, fetchGraphM2M, fetchKindeOrganisationBillingAgreements, fetchNodeM2M, getBillingPlan, getBillingUsage, getConnectedAppUrl, getEnvironmentOverview, getEnvironmentVariables, getEnvironmentVersions, getGraphOverview, getProjectOverview, getServiceHealth, getSpaceInvites, getSpaceOrgCode, getSpaceOverview, getSpaceStats, getUserIdentities, getUserInvites, getUserProfile, joinSpace, leaveSpace, listBillingInvoices, listInstallationBranches, listInstallationRepositories, listPaymentMethods, listSpaceMemberRoles, listSpaceMembers, listUserInstallations, listUserSpaces, recordCloudUsage, recordOnboardingAnalytics, rejectSpaceInvite, removePaymentMethod, requestAccountPasswordReset, requestSignedUploadUrl, revokeSpaceInvite, setDefaultPaymentMethod, updateBillingPlan, updateConnectedAppToken, updateEnvironmentVariable, updateGraphM2M, updateGraphState, updateNodeM2M, updateUsername, updateUserProfile, versionStatus } from '../sdk.gen';
5
5
  const createQueryKey = (id, options, infinite, tags) => {
6
6
  const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
7
7
  if (infinite) {
@@ -1072,6 +1072,24 @@ export const requestSignedUploadUrlMutation = (options) => {
1072
1072
  };
1073
1073
  return mutationOptions;
1074
1074
  };
1075
+ export const checkSubdomainUniquenessQueryKey = (options) => createQueryKey('checkSubdomainUniqueness', options);
1076
+ /**
1077
+ * Check if a proxy subdomain is unique within the current version and environment.
1078
+ */
1079
+ export const checkSubdomainUniquenessOptions = (options) => {
1080
+ return queryOptions({
1081
+ queryFn: async ({ queryKey, signal }) => {
1082
+ const { data } = await checkSubdomainUniqueness({
1083
+ ...options,
1084
+ ...queryKey[0],
1085
+ signal,
1086
+ throwOnError: true
1087
+ });
1088
+ return data;
1089
+ },
1090
+ queryKey: checkSubdomainUniquenessQueryKey(options)
1091
+ });
1092
+ };
1075
1093
  /**
1076
1094
  * Record a cloud usage event for a space (M2M only).
1077
1095
  */
@@ -1,5 +1,5 @@
1
1
  import type { Client, Options as Options2, TDataShape } from './client';
2
- import type { CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } from './types.gen';
2
+ import type { CheckSubdomainUniquenessData, CheckSubdomainUniquenessErrors, CheckSubdomainUniquenessResponses, CreateEnvironmentData, CreateEnvironmentErrors, CreateEnvironmentResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableErrors, CreateEnvironmentVariableResponses, CreateProjectData, CreateProjectErrors, CreateProjectResponses, CreateSetupIntentData, CreateSetupIntentErrors, CreateSetupIntentResponses, CreateSpaceData, CreateSpaceErrors, CreateSpaceInviteData, CreateSpaceInviteErrors, CreateSpaceInviteResponses, CreateSpaceResponses, CreateUsernameData, CreateUsernameErrors, CreateUsernameResponses, DeleteAccountIdentityData, DeleteAccountIdentityErrors, DeleteAccountIdentityResponses, DeleteEnvironmentVariableData, DeleteEnvironmentVariableErrors, DeleteEnvironmentVariableResponses, DeployVersionData, DeployVersionErrors, DeployVersionResponses, FetchBillingPricesData, FetchBillingPricesErrors, FetchBillingPricesResponses, FetchGraphM2mData, FetchGraphM2mErrors, FetchGraphM2mResponses, FetchKindeOrganisationBillingAgreementsData, FetchKindeOrganisationBillingAgreementsErrors, FetchKindeOrganisationBillingAgreementsResponses, FetchNodeM2mData, FetchNodeM2mErrors, FetchNodeM2mResponses, GetBillingPlanData, GetBillingPlanErrors, GetBillingPlanResponses, GetBillingUsageData, GetBillingUsageErrors, GetBillingUsageResponses, GetConnectedAppUrlData, GetConnectedAppUrlErrors, GetConnectedAppUrlResponses, GetEnvironmentOverviewData, GetEnvironmentOverviewErrors, GetEnvironmentOverviewResponses, GetEnvironmentVariablesData, GetEnvironmentVariablesErrors, GetEnvironmentVariablesResponses, GetEnvironmentVersionsData, GetEnvironmentVersionsResponses, GetGraphOverviewData, GetGraphOverviewErrors, GetGraphOverviewResponses, GetProjectOverviewData, GetProjectOverviewErrors, GetProjectOverviewResponses, GetServiceHealthData, GetServiceHealthResponses, GetSpaceInvitesData, GetSpaceInvitesErrors, GetSpaceInvitesResponses, GetSpaceOrgCodeData, GetSpaceOrgCodeErrors, GetSpaceOrgCodeResponses, GetSpaceOverviewData, GetSpaceOverviewErrors, GetSpaceOverviewResponses, GetSpaceStatsData, GetSpaceStatsErrors, GetSpaceStatsResponses, GetUserIdentitiesData, GetUserIdentitiesErrors, GetUserIdentitiesResponses, GetUserInvitesData, GetUserInvitesErrors, GetUserInvitesResponses, GetUserProfileData, GetUserProfileErrors, GetUserProfileResponses, JoinSpaceData, JoinSpaceErrors, JoinSpaceResponses, LeaveSpaceData, LeaveSpaceErrors, LeaveSpaceResponses, ListBillingInvoicesData, ListBillingInvoicesErrors, ListBillingInvoicesResponses, ListInstallationBranchesData, ListInstallationBranchesErrors, ListInstallationBranchesResponses, ListInstallationRepositoriesData, ListInstallationRepositoriesErrors, ListInstallationRepositoriesResponses, ListPaymentMethodsData, ListPaymentMethodsErrors, ListPaymentMethodsResponses, ListSpaceMemberRolesData, ListSpaceMemberRolesErrors, ListSpaceMemberRolesResponses, ListSpaceMembersData, ListSpaceMembersErrors, ListSpaceMembersResponses, ListUserInstallationsData, ListUserInstallationsErrors, ListUserInstallationsResponses, ListUserSpacesData, ListUserSpacesErrors, ListUserSpacesResponses, RecordCloudUsageData, RecordCloudUsageErrors, RecordCloudUsageResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsErrors, RecordOnboardingAnalyticsResponses, RejectSpaceInviteData, RejectSpaceInviteErrors, RejectSpaceInviteResponses, RemovePaymentMethodData, RemovePaymentMethodErrors, RemovePaymentMethodResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetErrors, RequestAccountPasswordResetResponses, RequestSignedUploadUrlData, RequestSignedUploadUrlErrors, RequestSignedUploadUrlResponses, RevokeSpaceInviteData, RevokeSpaceInviteErrors, RevokeSpaceInviteResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodErrors, SetDefaultPaymentMethodResponses, UpdateBillingPlanData, UpdateBillingPlanErrors, UpdateBillingPlanResponses, UpdateConnectedAppTokenData, UpdateConnectedAppTokenErrors, UpdateConnectedAppTokenResponses, UpdateEnvironmentVariableData, UpdateEnvironmentVariableErrors, UpdateEnvironmentVariableResponses, UpdateGraphM2mData, UpdateGraphM2mErrors, UpdateGraphM2mResponses, UpdateGraphStateData, UpdateGraphStateErrors, UpdateGraphStateResponses, UpdateNodeM2mData, UpdateNodeM2mErrors, UpdateNodeM2mResponses, UpdateUsernameData, UpdateUsernameErrors, UpdateUsernameResponses, UpdateUserProfileData, UpdateUserProfileErrors, UpdateUserProfileResponses, VersionStatusData, VersionStatusErrors, VersionStatusResponses } 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
@@ -201,6 +201,10 @@ export declare const versionStatus: <ThrowOnError extends boolean = false>(optio
201
201
  * Request a signed upload URL to upload source code zip files.
202
202
  */
203
203
  export declare const requestSignedUploadUrl: <ThrowOnError extends boolean = false>(options: Options<RequestSignedUploadUrlData, ThrowOnError>) => import("./client").RequestResult<RequestSignedUploadUrlResponses, RequestSignedUploadUrlErrors, ThrowOnError, "fields">;
204
+ /**
205
+ * Check if a proxy subdomain is unique within the current version and environment.
206
+ */
207
+ export declare const checkSubdomainUniqueness: <ThrowOnError extends boolean = false>(options: Options<CheckSubdomainUniquenessData, ThrowOnError>) => import("./client").RequestResult<CheckSubdomainUniquenessResponses, CheckSubdomainUniquenessErrors, ThrowOnError, "fields">;
204
208
  /**
205
209
  * Record a cloud usage event for a space (M2M only).
206
210
  */
@@ -753,7 +753,22 @@ export const requestSignedUploadUrl = (options) => {
753
753
  type: 'http'
754
754
  }
755
755
  ],
756
- url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/nodes/{nodeUUID}/signed-upload-url',
756
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/signed-upload-url',
757
+ ...options
758
+ });
759
+ };
760
+ /**
761
+ * Check if a proxy subdomain is unique within the current version and environment.
762
+ */
763
+ export const checkSubdomainUniqueness = (options) => {
764
+ return (options.client ?? client).get({
765
+ security: [
766
+ {
767
+ scheme: 'bearer',
768
+ type: 'http'
769
+ }
770
+ ],
771
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/check-subdomain/{subdomain}',
757
772
  ...options
758
773
  });
759
774
  };
@@ -630,6 +630,10 @@ export type IdentityId = string;
630
630
  * Connected app session ID returned by Kinde.
631
631
  */
632
632
  export type SessionId = string;
633
+ /**
634
+ * The proxy subdomain to check for uniqueness.
635
+ */
636
+ export type Subdomain = string;
633
637
  /**
634
638
  * Connected app key reference code.
635
639
  */
@@ -2532,13 +2536,9 @@ export type RequestSignedUploadUrlData = {
2532
2536
  * A version number with in an environment.
2533
2537
  */
2534
2538
  version: string;
2535
- /**
2536
- * The node ID this source ZIP is associated with.
2537
- */
2538
- nodeUUID: string;
2539
2539
  };
2540
2540
  query?: never;
2541
- url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/nodes/{nodeUUID}/signed-upload-url';
2541
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/signed-upload-url';
2542
2542
  };
2543
2543
  export type RequestSignedUploadUrlErrors = {
2544
2544
  /**
@@ -2566,6 +2566,63 @@ export type RequestSignedUploadUrlResponses = {
2566
2566
  200: SignedUrlUploadResponse;
2567
2567
  };
2568
2568
  export type RequestSignedUploadUrlResponse = RequestSignedUploadUrlResponses[keyof RequestSignedUploadUrlResponses];
2569
+ export type CheckSubdomainUniquenessData = {
2570
+ body?: never;
2571
+ path: {
2572
+ /**
2573
+ * The space handle. This must be globally unique.
2574
+ */
2575
+ spaceHandle: string;
2576
+ /**
2577
+ * A project name. This must be unique to a space.
2578
+ */
2579
+ projectHandle: string;
2580
+ /**
2581
+ * An environment name (e.g., dev, prod, foo-bar). This must be unique to a project.
2582
+ */
2583
+ environmentHandle: string;
2584
+ /**
2585
+ * A version number with in an environment.
2586
+ */
2587
+ version: string;
2588
+ /**
2589
+ * The proxy subdomain to check for uniqueness.
2590
+ */
2591
+ subdomain: string;
2592
+ };
2593
+ query?: never;
2594
+ url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/check-subdomain/{subdomain}';
2595
+ };
2596
+ export type CheckSubdomainUniquenessErrors = {
2597
+ /**
2598
+ * Invalid request parameters.
2599
+ */
2600
+ 400: ErrorResponse;
2601
+ /**
2602
+ * Unauthorised user.
2603
+ */
2604
+ 401: ErrorResponse;
2605
+ /**
2606
+ * Invalid credentials.
2607
+ */
2608
+ 403: ErrorResponse;
2609
+ /**
2610
+ * Subdomain is already taken.
2611
+ */
2612
+ 409: ErrorResponse;
2613
+ /**
2614
+ * Unexpected error.
2615
+ */
2616
+ 500: ErrorResponse;
2617
+ };
2618
+ export type CheckSubdomainUniquenessError = CheckSubdomainUniquenessErrors[keyof CheckSubdomainUniquenessErrors];
2619
+ export type CheckSubdomainUniquenessResponses = {
2620
+ /**
2621
+ * Subdomain is unique and available.
2622
+ */
2623
+ 204: void;
2624
+ };
2625
+ export type CheckSubdomainUniquenessResponse = CheckSubdomainUniquenessResponses[keyof CheckSubdomainUniquenessResponses];
2569
2626
  export type RecordCloudUsageData = {
2570
2627
  body: RecordUsageRequest;
2571
2628
  path?: never;
@@ -1159,6 +1159,10 @@ export declare const zIdentityId: z.ZodString;
1159
1159
  * Connected app session ID returned by Kinde.
1160
1160
  */
1161
1161
  export declare const zSessionId: z.ZodString;
1162
+ /**
1163
+ * The proxy subdomain to check for uniqueness.
1164
+ */
1165
+ export declare const zSubdomain: z.ZodString;
1162
1166
  /**
1163
1167
  * Connected app key reference code.
1164
1168
  */
@@ -2710,7 +2714,6 @@ export declare const zRequestSignedUploadUrlData: z.ZodObject<{
2710
2714
  projectHandle: z.ZodString;
2711
2715
  environmentHandle: z.ZodString;
2712
2716
  version: z.ZodString;
2713
- nodeUUID: z.ZodUUID;
2714
2717
  }, z.core.$strip>;
2715
2718
  query: z.ZodOptional<z.ZodNever>;
2716
2719
  }, z.core.$strip>;
@@ -2722,6 +2725,21 @@ export declare const zRequestSignedUploadUrlResponse: z.ZodObject<{
2722
2725
  expiration: z.ZodISODateTime;
2723
2726
  fields: z.ZodRecord<z.ZodString, z.ZodString>;
2724
2727
  }, z.core.$strip>;
2728
+ export declare const zCheckSubdomainUniquenessData: z.ZodObject<{
2729
+ body: z.ZodOptional<z.ZodNever>;
2730
+ path: z.ZodObject<{
2731
+ spaceHandle: z.ZodString;
2732
+ projectHandle: z.ZodString;
2733
+ environmentHandle: z.ZodString;
2734
+ version: z.ZodString;
2735
+ subdomain: z.ZodString;
2736
+ }, z.core.$strip>;
2737
+ query: z.ZodOptional<z.ZodNever>;
2738
+ }, z.core.$strip>;
2739
+ /**
2740
+ * Subdomain is unique and available.
2741
+ */
2742
+ export declare const zCheckSubdomainUniquenessResponse: z.ZodVoid;
2725
2743
  export declare const zRecordCloudUsageData: z.ZodObject<{
2726
2744
  body: z.ZodObject<{
2727
2745
  orgCode: z.ZodString;
@@ -616,6 +616,10 @@ export const zIdentityId = z.string();
616
616
  * Connected app session ID returned by Kinde.
617
617
  */
618
618
  export const zSessionId = z.string();
619
+ /**
620
+ * The proxy subdomain to check for uniqueness.
621
+ */
622
+ export const zSubdomain = z.string();
619
623
  /**
620
624
  * Connected app key reference code.
621
625
  */
@@ -1124,8 +1128,7 @@ export const zRequestSignedUploadUrlData = z.object({
1124
1128
  spaceHandle: z.string(),
1125
1129
  projectHandle: z.string(),
1126
1130
  environmentHandle: z.string(),
1127
- version: z.string(),
1128
- nodeUUID: z.uuid()
1131
+ version: z.string()
1129
1132
  }),
1130
1133
  query: z.optional(z.never())
1131
1134
  });
@@ -1133,6 +1136,21 @@ export const zRequestSignedUploadUrlData = z.object({
1133
1136
  * A successfully generated signed url.
1134
1137
  */
1135
1138
  export const zRequestSignedUploadUrlResponse = zSignedUrlUploadResponse;
1139
+ export const zCheckSubdomainUniquenessData = z.object({
1140
+ body: z.optional(z.never()),
1141
+ path: z.object({
1142
+ spaceHandle: z.string(),
1143
+ projectHandle: z.string(),
1144
+ environmentHandle: z.string(),
1145
+ version: z.string(),
1146
+ subdomain: z.string()
1147
+ }),
1148
+ query: z.optional(z.never())
1149
+ });
1150
+ /**
1151
+ * Subdomain is unique and available.
1152
+ */
1153
+ export const zCheckSubdomainUniquenessResponse = z.void();
1136
1154
  export const zRecordCloudUsageData = z.object({
1137
1155
  body: zRecordUsageRequest,
1138
1156
  path: z.optional(z.never()),
@@ -1,6 +1,6 @@
1
1
  import { useMutation } from "@tanstack/react-query";
2
2
  import { GetSuccessResponse } from "../util";
3
- import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, UpdateNodeM2mData, UpdateNodeM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } from "../../sdk/types.gen";
3
+ import { GetServiceHealthData, FetchGraphM2mData, UpdateGraphM2mData, UpdateGraphM2mResponses, FetchNodeM2mData, UpdateNodeM2mData, UpdateNodeM2mResponses, RequestAccountPasswordResetData, RequestAccountPasswordResetResponses, UpdateUsernameData, UpdateUsernameResponses, CreateUsernameData, CreateUsernameResponses, GetUserProfileData, UpdateUserProfileData, UpdateUserProfileResponses, GetUserIdentitiesData, DeleteAccountIdentityData, DeleteAccountIdentityResponses, GetConnectedAppUrlData, UpdateConnectedAppTokenData, UpdateConnectedAppTokenResponses, ListInstallationRepositoriesData, ListInstallationBranchesData, ListUserInstallationsData, ListUserSpacesData, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, CreateSpaceData, CreateSpaceResponses, GetUserInvitesData, JoinSpaceData, JoinSpaceResponses, RejectSpaceInviteData, RejectSpaceInviteResponses, GetSpaceOverviewData, GetSpaceOrgCodeData, GetSpaceStatsData, FetchKindeOrganisationBillingAgreementsData, GetSpaceInvitesData, CreateSpaceInviteData, CreateSpaceInviteResponses, RevokeSpaceInviteData, RevokeSpaceInviteResponses, ListSpaceMembersData, ListSpaceMemberRolesData, LeaveSpaceData, LeaveSpaceResponses, CreateProjectData, CreateProjectResponses, GetProjectOverviewData, CreateEnvironmentData, CreateEnvironmentResponses, GetEnvironmentOverviewData, GetEnvironmentVersionsData, DeleteEnvironmentVariableData, DeleteEnvironmentVariableResponses, GetEnvironmentVariablesData, UpdateEnvironmentVariableData, UpdateEnvironmentVariableResponses, CreateEnvironmentVariableData, CreateEnvironmentVariableResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, VersionStatusData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData } 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>;
@@ -188,6 +188,9 @@ export declare const useRequestSignedUploadUrl: (config?: {
188
188
  onError?: Parameters<typeof useMutation>["0"]["onError"];
189
189
  retry?: boolean;
190
190
  }) => import("@tanstack/react-query").UseMutationResult<import("../../sdk/types.gen").SignedUrlUploadResponse | undefined, unknown, Omit<RequestSignedUploadUrlData, "url">, unknown>;
191
+ export declare const useCheckSubdomainUniqueness: (options: Omit<CheckSubdomainUniquenessData, "url"> & {
192
+ enabled?: boolean;
193
+ }) => import("@tanstack/react-query").UseQueryResult<void, Error>;
191
194
  export declare const useRecordCloudUsage: (config?: {
192
195
  onSuccess?: (data: GetSuccessResponse<RecordCloudUsageResponses>) => void;
193
196
  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, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
5
+ import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, recordOnboardingAnalytics, createSpace, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, getGraphOverview, updateGraphState, deployVersion, versionStatus, requestSignedUploadUrl, checkSubdomainUniqueness, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices } from "../../sdk/sdk.gen";
6
6
  export const useGetServiceHealth = (options) => {
7
7
  const token = useToken();
8
8
  let { enabled, ...rest } = options || { enabled: true };
@@ -928,7 +928,7 @@ export const useVersionStatus = (options) => {
928
928
  export const useRequestSignedUploadUrl = (config) => {
929
929
  const token = useToken();
930
930
  const queryClient = useQueryClient();
931
- const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/nodes/{nodeUUID}/signed-upload-url" };
931
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/signed-upload-url" };
932
932
  const funcer = async (options) => {
933
933
  const auth = isPromise(token) ? (await token) || "" : token || "";
934
934
  const res = await requestSignedUploadUrl({ ...opts, ...options, auth });
@@ -937,13 +937,34 @@ export const useRequestSignedUploadUrl = (config) => {
937
937
  return useMutation({
938
938
  mutationFn: funcer,
939
939
  onSuccess: (res, options, c, ctx) => {
940
- queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", "nodes", options?.path?.nodeUUID, "signed-upload-url"] });
940
+ queryClient.invalidateQueries({ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", "signed-upload-url"] });
941
941
  config?.onSuccess && config.onSuccess(res);
942
942
  },
943
943
  onError: config?.onError,
944
944
  retry: config?.retry
945
945
  });
946
946
  };
947
+ export const useCheckSubdomainUniqueness = (options) => {
948
+ const token = useToken();
949
+ let { enabled, ...rest } = options || { enabled: true };
950
+ const opts = { throwOnError: true, url: "/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/{version}/graph/check-subdomain/{subdomain}" };
951
+ const funcer = async () => {
952
+ const auth = isPromise(token) ? (await token) || "" : token || "";
953
+ if (isPromise(token) && !token)
954
+ return;
955
+ const res = await checkSubdomainUniqueness({ ...opts, ...rest, auth });
956
+ return res.data;
957
+ };
958
+ if (!token)
959
+ enabled = false;
960
+ return useQuery({
961
+ queryKey: [options?.path?.spaceHandle, options?.path?.projectHandle, options?.path?.environmentHandle, options?.path?.version, "graph", "check-subdomain", options?.path?.subdomain, options.query ?? {}],
962
+ queryFn: funcer,
963
+ enabled,
964
+ retry: false,
965
+ staleTime: 600000
966
+ });
967
+ };
947
968
  export const useRecordCloudUsage = (config) => {
948
969
  const token = useToken();
949
970
  const queryClient = useQueryClient();
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "shoal-web-sdk",
3
- "version": "0.0.152",
3
+ "version": "0.0.154",
4
4
  "main": "index.js",
5
5
  "scripts": {
6
6
  "build-hooks": "npx tsx tanstack-codegen/generator.ts",