shoal-web-sdk 1.0.13 → 1.0.14

package/dist/sdk/@tanstack/react-query.gen.d.ts

@@ -455,6 +455,9 @@ export declare const previewBlueprintQueryKey: (options: Options<PreviewBlueprin
     _infinite?: boolean;
     tags?: ReadonlyArray<string>;
 }];
+/**
+ * Preview blueprints
+ */
 export declare const previewBlueprintOptions: (options: Options<PreviewBlueprintData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Nodes, Error, import("../types.gen").Nodes, [Pick<Options<PreviewBlueprintData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;
@@ -480,6 +483,9 @@ export declare const viewBlueprintsQueryKey: (options?: Options<ViewBlueprintsDa
     _infinite?: boolean;
     tags?: ReadonlyArray<string>;
 }];
+/**
+ * View all blueprints
+ */
 export declare const viewBlueprintsOptions: (options?: Options<ViewBlueprintsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedBlueprints, Error, import("../types.gen").PaginatedBlueprints, [Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;
@@ -501,6 +507,9 @@ export declare const viewBlueprintsOptions: (options?: Options<ViewBlueprintsDat
     };
 };
 export declare const viewBlueprintsInfiniteQueryKey: (options?: Options<ViewBlueprintsData>) => QueryKey<Options<ViewBlueprintsData>>;
+/**
+ * View all blueprints
+ */
 export declare const viewBlueprintsInfiniteOptions: (options?: Options<ViewBlueprintsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedBlueprints, import("../types.gen").ErrorResponse, InfiniteData<import("../types.gen").PaginatedBlueprints, unknown>, QueryKey<Options<ViewBlueprintsData>>, number | Pick<Pick<Options<ViewBlueprintsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

package/dist/sdk/@tanstack/react-query.gen.js

@@ -533,6 +533,9 @@ export const recordOnboardingAnalyticsMutation = (options) => {
     return mutationOptions;
 };
 export const previewBlueprintQueryKey = (options) => createQueryKey('previewBlueprint', options);
+/**
+ * Preview blueprints
+ */
 export const previewBlueprintOptions = (options) => {
     return queryOptions({
         queryFn: async ({ queryKey, signal }) => {
@@ -548,6 +551,9 @@ export const previewBlueprintOptions = (options) => {
     });
 };
 export const viewBlueprintsQueryKey = (options) => createQueryKey('viewBlueprints', options);
+/**
+ * View all blueprints
+ */
 export const viewBlueprintsOptions = (options) => {
     return queryOptions({
         queryFn: async ({ queryKey, signal }) => {
@@ -563,6 +569,9 @@ export const viewBlueprintsOptions = (options) => {
     });
 };
 export const viewBlueprintsInfiniteQueryKey = (options) => createQueryKey('viewBlueprints', options, true);
+/**
+ * View all blueprints
+ */
 export const viewBlueprintsInfiniteOptions = (options) => {
     return infiniteQueryOptions(
     // @ts-ignore

package/dist/sdk/sdk.gen.d.ts

@@ -95,7 +95,13 @@ export declare const createFeatureRequest: <ThrowOnError extends boolean = false
  * Record analytics data captured during the onboarding flow.
  */
 export declare const recordOnboardingAnalytics: <ThrowOnError extends boolean = false>(options: Options<RecordOnboardingAnalyticsData, ThrowOnError>) => import("./client").RequestResult<RecordOnboardingAnalyticsResponses, RecordOnboardingAnalyticsErrors, ThrowOnError, "fields">;
+/**
+ * Preview blueprints
+ */
 export declare const previewBlueprint: <ThrowOnError extends boolean = false>(options: Options<PreviewBlueprintData, ThrowOnError>) => import("./client").RequestResult<PreviewBlueprintResponses, PreviewBlueprintErrors, ThrowOnError, "fields">;
+/**
+ * View all blueprints
+ */
 export declare const viewBlueprints: <ThrowOnError extends boolean = false>(options?: Options<ViewBlueprintsData, ThrowOnError>) => import("./client").RequestResult<ViewBlueprintsResponses, ViewBlueprintsErrors, ThrowOnError, "fields">;
 /**
  * Retrieve a blueprint record.

package/dist/sdk/sdk.gen.js

@@ -356,6 +356,9 @@ export const recordOnboardingAnalytics = (options) => {
         }
     });
 };
+/**
+ * Preview blueprints
+ */
 export const previewBlueprint = (options) => {
     return (options.client ?? client).get({
         security: [
@@ -368,6 +371,9 @@ export const previewBlueprint = (options) => {
         ...options
     });
 };
+/**
+ * View all blueprints
+ */
 export const viewBlueprints = (options) => {
     return (options?.client ?? client).get({
         security: [

package/dist/tanstack-codegen/generated/generated.d.ts

@@ -1,6 +1,6 @@
 import { useMutation } from "@tanstack/react-query";
 import { GetSuccessResponse } from "../util";
-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, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, 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, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses } from "../../sdk/types.gen";
+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, CreateFeatureRequestData, CreateFeatureRequestResponses, RecordOnboardingAnalyticsData, RecordOnboardingAnalyticsResponses, PreviewBlueprintData, ViewBlueprintsData, GetBlueprintData, CreateSpaceData, CreateSpaceResponses, GetPublicInviteData, 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, DeleteBlueprintData, DeleteBlueprintResponses, UpdateBlueprintData, UpdateBlueprintResponses, CreateBlueprintData, CreateBlueprintResponses, GetVersionData, ImportBlueprintData, ImportBlueprintResponses, GetGraphOverviewData, UpdateGraphStateData, UpdateGraphStateResponses, DeployVersionData, DeployVersionResponses, RequestSignedDownloadUrlData, RequestSignedUploadUrlData, RequestSignedUploadUrlResponses, CheckSubdomainUniquenessData, RecordCloudUsageData, RecordCloudUsageResponses, GetBillingPlanData, UpdateBillingPlanData, UpdateBillingPlanResponses, CreateSetupIntentData, CreateSetupIntentResponses, ListPaymentMethodsData, RemovePaymentMethodData, RemovePaymentMethodResponses, SetDefaultPaymentMethodData, SetDefaultPaymentMethodResponses, GetBillingUsageData, FetchBillingPricesData, ListBillingInvoicesData, GetSpacePropertiesData, SetSpacePropertyData, SetSpacePropertyResponses } from "../../sdk/types.gen";
 export declare const useGetServiceHealth: (options?: Omit<GetServiceHealthData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").HealthResponse | undefined, Error>;
@@ -111,6 +111,12 @@ export declare const useRecordOnboardingAnalytics: (config?: {
     data: unknown;
     headers: Headers;
 }, unknown, Omit<RecordOnboardingAnalyticsData, "url">, unknown>;
+export declare const usePreviewBlueprint: (options: Omit<PreviewBlueprintData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").Nodes | undefined, Error>;
+export declare const useViewBlueprints: (options?: Omit<ViewBlueprintsData, "url"> & {
+    enabled?: boolean;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PaginatedBlueprints | undefined, Error>;
 export declare const useGetBlueprint: (options: Omit<GetBlueprintData, "url"> & {
     enabled?: boolean;
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").Blueprint | undefined, Error>;

package/dist/tanstack-codegen/generated/generated.js

@@ -2,7 +2,7 @@
 import { useMutation, useQuery, useQueryClient } from "@tanstack/react-query";
 import { isPromise } from "../util";
 import { useToken } from "../../provider/token-provider";
-import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createFeatureRequest, recordOnboardingAnalytics, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, requestSignedUploadUrl, checkSubdomainUniqueness, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices, getSpaceProperties, setSpaceProperty } from "../../sdk/sdk.gen";
+import { getServiceHealth, fetchGraphM2M, updateGraphM2M, fetchNodeM2M, updateNodeM2M, requestAccountPasswordReset, updateUsername, createUsername, getUserProfile, updateUserProfile, getUserIdentities, deleteAccountIdentity, getConnectedAppUrl, updateConnectedAppToken, listInstallationRepositories, listInstallationBranches, listUserInstallations, listUserSpaces, createFeatureRequest, recordOnboardingAnalytics, previewBlueprint, viewBlueprints, getBlueprint, createSpace, getPublicInvite, getUserInvites, joinSpace, rejectSpaceInvite, getSpaceOverview, getSpaceOrgCode, getSpaceStats, fetchKindeOrganisationBillingAgreements, getSpaceInvites, createSpaceInvite, revokeSpaceInvite, listSpaceMembers, listSpaceMemberRoles, leaveSpace, createProject, getProjectOverview, createEnvironment, getEnvironmentOverview, getEnvironmentVersions, deleteEnvironmentVariable, getEnvironmentVariables, updateEnvironmentVariable, createEnvironmentVariable, deleteBlueprint, updateBlueprint, createBlueprint, getVersion, importBlueprint, getGraphOverview, updateGraphState, deployVersion, requestSignedDownloadUrl, requestSignedUploadUrl, checkSubdomainUniqueness, recordCloudUsage, getBillingPlan, updateBillingPlan, createSetupIntent, listPaymentMethods, removePaymentMethod, setDefaultPaymentMethod, getBillingUsage, fetchBillingPrices, listBillingInvoices, getSpaceProperties, setSpaceProperty } from "../../sdk/sdk.gen";
 export const useGetServiceHealth = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };
@@ -403,6 +403,48 @@ export const useRecordOnboardingAnalytics = (config) => {
         retry: config?.retry
     });
 };
+export const usePreviewBlueprint = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/blueprints/preview/{blueprint}" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await previewBlueprint({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: ["blueprints", "preview", options?.path?.blueprint, options.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+};
+export const useViewBlueprints = (options) => {
+    const token = useToken();
+    let { enabled, ...rest } = options || { enabled: true };
+    const opts = { throwOnError: true, url: "/blueprints/view" };
+    const funcer = async () => {
+        const auth = isPromise(token) ? (await token) || "" : token || "";
+        if (isPromise(token) && !token)
+            return;
+        const res = await viewBlueprints({ ...opts, ...rest, auth });
+        return res.data;
+    };
+    if (!token)
+        enabled = false;
+    return useQuery({
+        queryKey: ["blueprints", "view", options?.query ?? {}],
+        queryFn: funcer,
+        enabled,
+        retry: false,
+        staleTime: 600000
+    });
+};
 export const useGetBlueprint = (options) => {
     const token = useToken();
     let { enabled, ...rest } = options || { enabled: true };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shoal-web-sdk",
-  "version": "1.0.13",
+  "version": "1.0.14",
   "main": "index.js",
   "scripts": {
     "build-hooks": "npx tsx tanstack-codegen/generator.ts",