shoal-web-sdk 1.0.142 → 1.0.144

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

@@ -1,6 +1,6 @@
 import { type InfiniteData } from '@tanstack/react-query';
 import { type Options } from '../sdk.gen';
-import type { GetTenantSummaryData, ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListCostOrganisationsData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
+import type { GetOverviewData, GetTenantSummaryData, ListActorActivityData, ListAuditBreakdownData, ListAuditsData, ListCostBreakdownData, ListCostOrganisationsData, ListDeploymentBreakdownData, ListDeploymentOrganisationsData, ListDeploymentsData, ListLiveRoutesData, ListSignUpBreakdownData, ListTenantsData, ListUsersData } from '../types.gen';
 export type QueryKey<TOptions extends Options> = [
     Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
         _id: string;
@@ -70,6 +70,103 @@ export declare const listTenantsInfiniteOptions: (options?: Options<ListTenantsD
         [dataTagErrorSymbol]: import("../types.gen")._Error;
     };
 };
+export declare const getOverviewQueryKey: (options?: Options<GetOverviewData>) => [Pick<Options<GetOverviewData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * Get the dashboard overview
+ *
+ * Returns sign-ups, deployments, audit events and spend for the window, the same totals
+ * for the window of equal length just before it (omitted when `from` is not set), daily
+ * totals within the window, and the tenant summary. Replaces one request per series.
+ *
+ */
+export declare const getOverviewOptions: (options?: Options<GetOverviewData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").Overview, Error, import("../types.gen").Overview, [Pick<Options<GetOverviewData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").Overview, [Pick<Options<GetOverviewData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<GetOverviewData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").Overview;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare const listLiveRoutesQueryKey: (options?: Options<ListLiveRoutesData>) => [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}];
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutesOptions: (options?: Options<ListLiveRoutesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedLiveEnvironments, Error, import("../types.gen").PaginatedLiveEnvironments, [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}]>, "queryFn"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedLiveEnvironments, [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }], never> | undefined;
+} & {
+    queryKey: [Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }] & {
+        [dataTagSymbol]: import("../types.gen").PaginatedLiveEnvironments;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare const listLiveRoutesInfiniteQueryKey: (options?: Options<ListLiveRoutesData>) => QueryKey<Options<ListLiveRoutesData>>;
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutesInfiniteOptions: (options?: Options<ListLiveRoutesData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedLiveEnvironments, import("../types.gen")._Error, InfiniteData<import("../types.gen").PaginatedLiveEnvironments, unknown>, QueryKey<Options<ListLiveRoutesData>>, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}, "query" | "body" | "headers" | "path">> & {
+    initialData: InfiniteData<import("../types.gen").PaginatedLiveEnvironments, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedLiveEnvironments, number | Pick<Pick<Options<ListLiveRoutesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">>) | undefined;
+} & {
+    queryKey: QueryKey<Options<ListLiveRoutesData>> & {
+        [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedLiveEnvironments, unknown>;
+        [dataTagErrorSymbol]: import("../types.gen")._Error;
+    };
+};
 export declare const getTenantSummaryQueryKey: (options?: Options<GetTenantSummaryData>) => [Pick<Options<GetTenantSummaryData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;

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

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { infiniteQueryOptions, queryOptions } from '@tanstack/react-query';
 import { client } from '../client.gen';
-import { getTenantSummary, listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listCostOrganisations, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, listSignUpBreakdown, listTenants, listUsers } from '../sdk.gen';
+import { getOverview, getTenantSummary, listActorActivity, listAuditBreakdown, listAudits, listCostBreakdown, listCostOrganisations, listDeploymentBreakdown, listDeploymentOrganisations, listDeployments, listLiveRoutes, listSignUpBreakdown, listTenants, listUsers } from '../sdk.gen';
 const createQueryKey = (id, options, infinite, tags) => {
     const params = { _id: id, baseUrl: options?.baseUrl || (options?.client ?? client).getConfig().baseUrl };
     if (infinite) {
@@ -111,6 +111,86 @@ export const listTenantsInfiniteOptions = (options) => {
         queryKey: listTenantsInfiniteQueryKey(options)
     });
 };
+export const getOverviewQueryKey = (options) => createQueryKey('getOverview', options);
+/**
+ * Get the dashboard overview
+ *
+ * Returns sign-ups, deployments, audit events and spend for the window, the same totals
+ * for the window of equal length just before it (omitted when `from` is not set), daily
+ * totals within the window, and the tenant summary. Replaces one request per series.
+ *
+ */
+export const getOverviewOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await getOverview({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: getOverviewQueryKey(options)
+    });
+};
+export const listLiveRoutesQueryKey = (options) => createQueryKey('listLiveRoutes', options);
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutesOptions = (options) => {
+    return queryOptions({
+        queryFn: async ({ queryKey, signal }) => {
+            const { data } = await listLiveRoutes({
+                ...options,
+                ...queryKey[0],
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listLiveRoutesQueryKey(options)
+    });
+};
+export const listLiveRoutesInfiniteQueryKey = (options) => createQueryKey('listLiveRoutes', options, true);
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutesInfiniteOptions = (options) => {
+    return infiniteQueryOptions(
+    // @ts-ignore
+    {
+        queryFn: async ({ pageParam, queryKey, signal }) => {
+            // @ts-ignore
+            const page = typeof pageParam === 'object' ? pageParam : {
+                query: {
+                    page: pageParam
+                }
+            };
+            const params = createInfiniteParams(queryKey, page);
+            const { data } = await listLiveRoutes({
+                ...options,
+                ...params,
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: listLiveRoutesInfiniteQueryKey(options)
+    });
+};
 export const getTenantSummaryQueryKey = (options) => createQueryKey('getTenantSummary', options);
 /**
  * Summarise tenants

package/dist/sdk/insights-engine/sdk.gen.d.ts

@@ -1,5 +1,5 @@
 import type { Client, Options as Options2, TDataShape } from './client';
-import type { GetTenantSummaryData, GetTenantSummaryErrors, GetTenantSummaryResponses, ListActorActivityData, ListActorActivityErrors, ListActorActivityResponses, ListAuditBreakdownData, ListAuditBreakdownErrors, ListAuditBreakdownResponses, ListAuditsData, ListAuditsErrors, ListAuditsResponses, ListCostBreakdownData, ListCostBreakdownErrors, ListCostBreakdownResponses, ListCostOrganisationsData, ListCostOrganisationsErrors, ListCostOrganisationsResponses, ListDeploymentBreakdownData, ListDeploymentBreakdownErrors, ListDeploymentBreakdownResponses, ListDeploymentOrganisationsData, ListDeploymentOrganisationsErrors, ListDeploymentOrganisationsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListSignUpBreakdownData, ListSignUpBreakdownErrors, ListSignUpBreakdownResponses, ListTenantsData, ListTenantsErrors, ListTenantsResponses, ListUsersData, ListUsersErrors, ListUsersResponses } from './types.gen';
+import type { GetOverviewData, GetOverviewErrors, GetOverviewResponses, GetTenantSummaryData, GetTenantSummaryErrors, GetTenantSummaryResponses, ListActorActivityData, ListActorActivityErrors, ListActorActivityResponses, ListAuditBreakdownData, ListAuditBreakdownErrors, ListAuditBreakdownResponses, ListAuditsData, ListAuditsErrors, ListAuditsResponses, ListCostBreakdownData, ListCostBreakdownErrors, ListCostBreakdownResponses, ListCostOrganisationsData, ListCostOrganisationsErrors, ListCostOrganisationsResponses, ListDeploymentBreakdownData, ListDeploymentBreakdownErrors, ListDeploymentBreakdownResponses, ListDeploymentOrganisationsData, ListDeploymentOrganisationsErrors, ListDeploymentOrganisationsResponses, ListDeploymentsData, ListDeploymentsErrors, ListDeploymentsResponses, ListLiveRoutesData, ListLiveRoutesErrors, ListLiveRoutesResponses, ListSignUpBreakdownData, ListSignUpBreakdownErrors, ListSignUpBreakdownResponses, ListTenantsData, ListTenantsErrors, ListTenantsResponses, ListUsersData, ListUsersErrors, ListUsersResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -22,6 +22,25 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  *
  */
 export declare const listTenants: <ThrowOnError extends boolean = false>(options?: Options<ListTenantsData, ThrowOnError>) => import("./client").RequestResult<ListTenantsResponses, ListTenantsErrors, ThrowOnError, "fields">;
+/**
+ * Get the dashboard overview
+ *
+ * Returns sign-ups, deployments, audit events and spend for the window, the same totals
+ * for the window of equal length just before it (omitted when `from` is not set), daily
+ * totals within the window, and the tenant summary. Replaces one request per series.
+ *
+ */
+export declare const getOverview: <ThrowOnError extends boolean = false>(options?: Options<GetOverviewData, ThrowOnError>) => import("./client").RequestResult<GetOverviewResponses, GetOverviewErrors, ThrowOnError, "fields">;
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export declare const listLiveRoutes: <ThrowOnError extends boolean = false>(options?: Options<ListLiveRoutesData, ThrowOnError>) => import("./client").RequestResult<ListLiveRoutesResponses, ListLiveRoutesErrors, ThrowOnError, "fields">;
 /**
  * Summarise tenants
  *

package/dist/sdk/insights-engine/sdk.gen.js

@@ -20,6 +20,47 @@ export const listTenants = (options) => {
         ...options
     });
 };
+/**
+ * Get the dashboard overview
+ *
+ * Returns sign-ups, deployments, audit events and spend for the window, the same totals
+ * for the window of equal length just before it (omitted when `from` is not set), daily
+ * totals within the window, and the tenant summary. Replaces one request per series.
+ *
+ */
+export const getOverview = (options) => {
+    return (options?.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/insights-engine/overview',
+        ...options
+    });
+};
+/**
+ * List live subdomains and paths
+ *
+ * Returns a page of environments, most recently deployed first, each with the proxy and VM
+ * subdomains and the route paths of its latest succeeded deployment. Environments that never
+ * deployed successfully, or whose live version has no proxy or VM, are omitted. Pass `org`
+ * to limit the list to one space.
+ *
+ */
+export const listLiveRoutes = (options) => {
+    return (options?.client ?? client).get({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/insights-engine/routes',
+        ...options
+    });
+};
 /**
  * Summarise tenants
  *

package/dist/sdk/insights-engine/types.gen.d.ts

@@ -492,6 +492,73 @@ export type TenantSummary = {
     transitions: Array<PlanTransition>;
     cohort: TenantCohort;
 };
+export type OverviewTotals = {
+    signUps: number;
+    deployments: number;
+    succeededDeployments: number;
+    nodes: number;
+    audits: number;
+    cost: Cost;
+};
+export type OverviewDay = OverviewTotals & {
+    timestamp: string;
+};
+/**
+ * Totals for the window and for the window of the same length just before it, daily totals within the window, and the tenant summary. Each source is read once across both windows.
+ */
+export type Overview = {
+    current: OverviewTotals;
+    previous?: OverviewTotals;
+    /**
+     * Oldest day first. Days with no activity are omitted.
+     */
+    daily: Array<OverviewDay>;
+    tenants: TenantSummary;
+};
+export type LivePath = {
+    path: string;
+    /**
+     * The path the target receives instead, empty when not rewritten.
+     */
+    rewrite: string;
+    targetName: string;
+    targetType: string;
+};
+/**
+ * A proxy or VM node in the live version and the subdomain it serves. The frontend builds the hostname from the label and the proxy or VM domain of the environment it runs in.
+ */
+export type LiveSubdomain = {
+    nodeName: string;
+    nodeType: 'proxy' | 'vm';
+    /**
+     * The subdomain label, empty when none is claimed.
+     */
+    label: string;
+    /**
+     * The active customer domain fronting the subdomain, empty when there is none.
+     */
+    customDomain: string;
+    paths: Array<LivePath>;
+};
+/**
+ * The subdomains and paths served by an environment's latest succeeded deployment.
+ */
+export type LiveEnvironment = {
+    orgId: string;
+    spaceName: string;
+    environmentId: string;
+    environmentHandle: string;
+    projectHandle: string;
+    /**
+     * The environment's latest succeeded deployment.
+     */
+    deploymentId: string;
+    deployedAt: string;
+    subdomains: Array<LiveSubdomain>;
+};
+export type PaginatedLiveEnvironments = PaginatedResponse & {
+    data: Array<LiveEnvironment>;
+};
 export type CostEnvironment = {
     id: string;
     handle: string;
@@ -689,6 +756,76 @@ export type ListTenantsResponses = {
     200: PaginatedTenants;
 };
 export type ListTenantsResponse = ListTenantsResponses[keyof ListTenantsResponses];
+export type GetOverviewData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Start of the reporting window. Unbounded when omitted.
+         */
+        from?: string;
+        /**
+         * End of the reporting window. Unbounded when omitted.
+         */
+        to?: string;
+    };
+    url: '/insights-engine/overview';
+};
+export type GetOverviewErrors = {
+    /**
+     * The request was rejected as invalid.
+     */
+    400: _Error;
+    /**
+     * The service is not healthy.
+     */
+    500: _Error;
+};
+export type GetOverviewError = GetOverviewErrors[keyof GetOverviewErrors];
+export type GetOverviewResponses = {
+    /**
+     * The overview.
+     */
+    200: Overview;
+};
+export type GetOverviewResponse = GetOverviewResponses[keyof GetOverviewResponses];
+export type ListLiveRoutesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * An organisation id.
+         */
+        org?: string;
+        /**
+         * 1-based page index.
+         */
+        page?: number;
+        /**
+         * Items per page, clamped server side to at most 5000.
+         */
+        limit?: number;
+    };
+    url: '/insights-engine/routes';
+};
+export type ListLiveRoutesErrors = {
+    /**
+     * The request was rejected as invalid.
+     */
+    400: _Error;
+    /**
+     * The service is not healthy.
+     */
+    500: _Error;
+};
+export type ListLiveRoutesError = ListLiveRoutesErrors[keyof ListLiveRoutesErrors];
+export type ListLiveRoutesResponses = {
+    /**
+     * A page of environments and their live routes.
+     */
+    200: PaginatedLiveEnvironments;
+};
+export type ListLiveRoutesResponse = ListLiveRoutesResponses[keyof ListLiveRoutesResponses];
 export type GetTenantSummaryData = {
     body?: never;
     path?: never;