shoal-web-sdk 0.0.138 → 0.0.140

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

@@ -778,14 +778,14 @@ export declare const getEnvironmentVersionsQueryKey: (options: Options<GetEnviro
     tags?: ReadonlyArray<string>;
 }];
 /**
- * Get all the environment versions.
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
  */
-export declare const getEnvironmentVersionsOptions: (options: Options<GetEnvironmentVersionsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").EnvironmentVersion[], Error, import("../types.gen").EnvironmentVersion[], [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+export declare const getEnvironmentVersionsOptions: (options: Options<GetEnvironmentVersionsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen").PaginatedEnvironmentVersions, Error, import("../types.gen").PaginatedEnvironmentVersions, [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
     _id: string;
     _infinite?: boolean;
     tags?: ReadonlyArray<string>;
 }]>, "queryFn"> & {
-    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").EnvironmentVersion[], [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen").PaginatedEnvironmentVersions, [Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
         _id: string;
         _infinite?: boolean;
         tags?: ReadonlyArray<string>;
@@ -796,7 +796,31 @@ export declare const getEnvironmentVersionsOptions: (options: Options<GetEnviron
         _infinite?: boolean;
         tags?: ReadonlyArray<string>;
     }] & {
-        [dataTagSymbol]: import("../types.gen").EnvironmentVersion[];
+        [dataTagSymbol]: import("../types.gen").PaginatedEnvironmentVersions;
+        [dataTagErrorSymbol]: Error;
+    };
+};
+export declare const getEnvironmentVersionsInfiniteQueryKey: (options: Options<GetEnvironmentVersionsData>) => QueryKey<Options<GetEnvironmentVersionsData>>;
+/**
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
+ */
+export declare const getEnvironmentVersionsInfiniteOptions: (options: Options<GetEnvironmentVersionsData>) => import("@tanstack/react-query").UseInfiniteQueryOptions<import("../types.gen").PaginatedEnvironmentVersions, Error, InfiniteData<import("../types.gen").PaginatedEnvironmentVersions, unknown>, QueryKey<Options<GetEnvironmentVersionsData>>, number | Pick<Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+    _id: string;
+    _infinite?: boolean;
+    tags?: ReadonlyArray<string>;
+}, "query" | "body" | "headers" | "path">> & {
+    initialData: InfiniteData<import("../types.gen").PaginatedEnvironmentVersions, number | Pick<Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">> | (() => InfiniteData<import("../types.gen").PaginatedEnvironmentVersions, number | Pick<Pick<Options<GetEnvironmentVersionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
+        _id: string;
+        _infinite?: boolean;
+        tags?: ReadonlyArray<string>;
+    }, "query" | "body" | "headers" | "path">>) | undefined;
+} & {
+    queryKey: QueryKey<Options<GetEnvironmentVersionsData>> & {
+        [dataTagSymbol]: InfiniteData<import("../types.gen").PaginatedEnvironmentVersions, unknown>;
         [dataTagErrorSymbol]: Error;
     };
 };

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

@@ -845,7 +845,7 @@ export const getEnvironmentOverviewOptions = (options) => {
 };
 export const getEnvironmentVersionsQueryKey = (options) => createQueryKey('getEnvironmentVersions', options);
 /**
- * Get all the environment versions.
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
  */
 export const getEnvironmentVersionsOptions = (options) => {
     return queryOptions({
@@ -861,6 +861,33 @@ export const getEnvironmentVersionsOptions = (options) => {
         queryKey: getEnvironmentVersionsQueryKey(options)
     });
 };
+export const getEnvironmentVersionsInfiniteQueryKey = (options) => createQueryKey('getEnvironmentVersions', options, true);
+/**
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
+ */
+export const getEnvironmentVersionsInfiniteOptions = (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 getEnvironmentVersions({
+                ...options,
+                ...params,
+                signal,
+                throwOnError: true
+            });
+            return data;
+        },
+        queryKey: getEnvironmentVersionsInfiniteQueryKey(options)
+    });
+};
 /**
  * Delete an environment variable.
  */

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

@@ -154,7 +154,7 @@ export declare const createEnvironment: <ThrowOnError extends boolean = false>(o
  */
 export declare const getEnvironmentOverview: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentOverviewData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentOverviewResponses, GetEnvironmentOverviewErrors, ThrowOnError, "fields">;
 /**
- * Get all the environment versions.
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
  */
 export declare const getEnvironmentVersions: <ThrowOnError extends boolean = false>(options: Options<GetEnvironmentVersionsData, ThrowOnError>) => import("./client").RequestResult<GetEnvironmentVersionsResponses, unknown, ThrowOnError, "fields">;
 /**

package/dist/sdk/sdk.gen.js

@@ -562,7 +562,7 @@ export const getEnvironmentOverview = (options) => {
     });
 };
 /**
- * Get all the environment versions.
+ * Get paginated environment versions ordered by latest version first, optionally excluding a version UUID and filtering by status.
  */
 export const getEnvironmentVersions = (options) => {
     return (options.client ?? client).get({

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

@@ -40,12 +40,17 @@ export type ProjectOverview = {
     updatedAt: string;
     environments: Array<EnvironmentOverview>;
 };
-export type PaginatedInvites = {
-    invites: Array<Invite>;
+export type Pagination = {
     page: number;
     limit: number;
     total: number;
 };
+export type PaginatedInvites = Pagination & {
+    invites: Array<Invite>;
+};
+export type PaginatedEnvironmentVersions = Pagination & {
+    versions: Array<EnvironmentVersion>;
+};
 export type Invite = {
     id: string;
     spaceName: string;
@@ -548,6 +553,14 @@ export type NodeId = string;
  * A version UUID.
  */
 export type VersionUuid = string;
+/**
+ * Optional version UUID to exclude from the environment versions response.
+ */
+export type ExcludeVersionUuidQuery = string;
+/**
+ * Optional version status to filter the environment versions response.
+ */
+export type VersionStatusQuery = VersionStatus;
 /**
  * A version number with in an environment.
  */
@@ -1982,14 +1995,31 @@ export type GetEnvironmentVersionsData = {
          */
         environmentHandle: string;
     };
-    query?: never;
+    query?: {
+        /**
+         * Page number (1-based).
+         */
+        page?: number;
+        /**
+         * Page size (max 100).
+         */
+        limit?: number;
+        /**
+         * Optional version UUID to exclude from the environment versions response.
+         */
+        excludeVersionUUID?: string;
+        /**
+         * Optional version status to filter the environment versions response.
+         */
+        status?: VersionStatus;
+    };
     url: '/auth/{spaceHandle}/{projectHandle}/{environmentHandle}/versions';
 };
 export type GetEnvironmentVersionsResponses = {
     /**
      * Environment versions.
      */
-    200: Array<EnvironmentVersion>;
+    200: PaginatedEnvironmentVersions;
 };
 export type GetEnvironmentVersionsResponse = GetEnvironmentVersionsResponses[keyof GetEnvironmentVersionsResponses];
 export type DeleteEnvironmentVariableData = {

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

@@ -86,6 +86,11 @@ export declare const zCreateProject: z.ZodObject<{
     handle: z.ZodString;
     description: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
+export declare const zPagination: z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>;
 export declare const zInvite: z.ZodObject<{
     id: z.ZodUUID;
     spaceName: z.ZodString;
@@ -96,7 +101,11 @@ export declare const zInvite: z.ZodObject<{
     expiry: z.ZodISODateTime;
     expired: z.ZodBoolean;
 }, z.core.$strip>;
-export declare const zPaginatedInvites: z.ZodObject<{
+export declare const zPaginatedInvites: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>, z.ZodObject<{
     invites: z.ZodArray<z.ZodObject<{
         id: z.ZodUUID;
         spaceName: z.ZodString;
@@ -107,10 +116,7 @@ export declare const zPaginatedInvites: z.ZodObject<{
         expiry: z.ZodISODateTime;
         expired: z.ZodBoolean;
     }, z.core.$strip>>;
-    page: z.ZodInt;
-    limit: z.ZodInt;
-    total: z.ZodInt;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export declare const zCreateInvite: z.ZodObject<{
     to: z.ZodString;
     role: z.ZodString;
@@ -456,6 +462,25 @@ export declare const zEnvironmentVersion: z.ZodObject<{
     retries: z.ZodOptional<z.ZodInt>;
     version: z.ZodInt;
 }, z.core.$strip>;
+export declare const zPaginatedEnvironmentVersions: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>, z.ZodObject<{
+    versions: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        created_at: z.ZodOptional<z.ZodISODateTime>;
+        last_updated_at: z.ZodISODateTime;
+        deployment_id: z.ZodOptional<z.ZodUUID>;
+        deployment_name: z.ZodOptional<z.ZodString>;
+        status: z.ZodString;
+        deployment_started_at: z.ZodOptional<z.ZodISODateTime>;
+        deployment_completed_at: z.ZodOptional<z.ZodISODateTime>;
+        message: z.ZodOptional<z.ZodString>;
+        retries: z.ZodOptional<z.ZodInt>;
+        version: z.ZodInt;
+    }, z.core.$strip>>;
+}, z.core.$strip>>;
 export declare const zNetworkEdgeProps: z.ZodObject<{
     a: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>;
@@ -1233,6 +1258,23 @@ export declare const zNodeId: z.ZodUUID;
  * A version UUID.
  */
 export declare const zVersionUuid: z.ZodUUID;
+/**
+ * Optional version UUID to exclude from the environment versions response.
+ */
+export declare const zExcludeVersionUuidQuery: z.ZodUUID;
+/**
+ * Optional version status to filter the environment versions response.
+ */
+export declare const zVersionStatusQuery: z.ZodEnum<{
+    pending: "pending";
+    queued: "queued";
+    building: "building";
+    deploying: "deploying";
+    "post-deploy-steps": "post-deploy-steps";
+    succeeded: "succeeded";
+    failed: "failed";
+    cancelled: "cancelled";
+}>;
 /**
  * A version number with in an environment.
  */
@@ -2078,7 +2120,11 @@ export declare const zGetUserInvitesData: z.ZodObject<{
 /**
  * A paginated list of invites assigned to the user.
  */
-export declare const zGetUserInvitesResponse: z.ZodObject<{
+export declare const zGetUserInvitesResponse: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>, z.ZodObject<{
     invites: z.ZodArray<z.ZodObject<{
         id: z.ZodUUID;
         spaceName: z.ZodString;
@@ -2089,10 +2135,7 @@ export declare const zGetUserInvitesResponse: z.ZodObject<{
         expiry: z.ZodISODateTime;
         expired: z.ZodBoolean;
     }, z.core.$strip>>;
-    page: z.ZodInt;
-    limit: z.ZodInt;
-    total: z.ZodInt;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export declare const zJoinSpaceData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;
     path: z.ZodObject<{
@@ -2178,7 +2221,11 @@ export declare const zGetSpaceInvitesData: z.ZodObject<{
 /**
  * A paginated list of invites for a space.
  */
-export declare const zGetSpaceInvitesResponse: z.ZodObject<{
+export declare const zGetSpaceInvitesResponse: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>, z.ZodObject<{
     invites: z.ZodArray<z.ZodObject<{
         id: z.ZodUUID;
         spaceName: z.ZodString;
@@ -2189,10 +2236,7 @@ export declare const zGetSpaceInvitesResponse: z.ZodObject<{
         expiry: z.ZodISODateTime;
         expired: z.ZodBoolean;
     }, z.core.$strip>>;
-    page: z.ZodInt;
-    limit: z.ZodInt;
-    total: z.ZodInt;
-}, z.core.$strip>;
+}, z.core.$strip>>;
 export declare const zCreateSpaceInviteData: z.ZodObject<{
     body: z.ZodObject<{
         to: z.ZodString;
@@ -2394,23 +2438,43 @@ export declare const zGetEnvironmentVersionsData: z.ZodObject<{
         projectHandle: z.ZodString;
         environmentHandle: z.ZodString;
     }, z.core.$strip>;
-    query: z.ZodOptional<z.ZodNever>;
+    query: z.ZodOptional<z.ZodObject<{
+        page: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
+        limit: z.ZodDefault<z.ZodOptional<z.ZodInt>>;
+        excludeVersionUUID: z.ZodOptional<z.ZodUUID>;
+        status: z.ZodOptional<z.ZodEnum<{
+            pending: "pending";
+            queued: "queued";
+            building: "building";
+            deploying: "deploying";
+            "post-deploy-steps": "post-deploy-steps";
+            succeeded: "succeeded";
+            failed: "failed";
+            cancelled: "cancelled";
+        }>>;
+    }, z.core.$strip>>;
 }, z.core.$strip>;
 /**
  * Environment versions.
  */
-export declare const zGetEnvironmentVersionsResponse: z.ZodArray<z.ZodObject<{
-    id: z.ZodUUID;
-    created_at: z.ZodOptional<z.ZodISODateTime>;
-    last_updated_at: z.ZodISODateTime;
-    deployment_id: z.ZodOptional<z.ZodUUID>;
-    deployment_name: z.ZodOptional<z.ZodString>;
-    status: z.ZodString;
-    deployment_started_at: z.ZodOptional<z.ZodISODateTime>;
-    deployment_completed_at: z.ZodOptional<z.ZodISODateTime>;
-    message: z.ZodOptional<z.ZodString>;
-    retries: z.ZodOptional<z.ZodInt>;
-    version: z.ZodInt;
+export declare const zGetEnvironmentVersionsResponse: z.ZodIntersection<z.ZodObject<{
+    page: z.ZodInt;
+    limit: z.ZodInt;
+    total: z.ZodInt;
+}, z.core.$strip>, z.ZodObject<{
+    versions: z.ZodArray<z.ZodObject<{
+        id: z.ZodUUID;
+        created_at: z.ZodOptional<z.ZodISODateTime>;
+        last_updated_at: z.ZodISODateTime;
+        deployment_id: z.ZodOptional<z.ZodUUID>;
+        deployment_name: z.ZodOptional<z.ZodString>;
+        status: z.ZodString;
+        deployment_started_at: z.ZodOptional<z.ZodISODateTime>;
+        deployment_completed_at: z.ZodOptional<z.ZodISODateTime>;
+        message: z.ZodOptional<z.ZodString>;
+        retries: z.ZodOptional<z.ZodInt>;
+        version: z.ZodInt;
+    }, z.core.$strip>>;
 }, z.core.$strip>>;
 export declare const zDeleteEnvironmentVariableData: z.ZodObject<{
     body: z.ZodOptional<z.ZodNever>;

package/dist/sdk/zod.gen.js

@@ -62,6 +62,11 @@ export const zCreateProject = z.object({
     handle: z.string(),
     description: z.optional(z.string())
 });
+export const zPagination = z.object({
+    page: z.int(),
+    limit: z.int(),
+    total: z.int()
+});
 export const zInvite = z.object({
     id: z.uuid(),
     spaceName: z.string(),
@@ -72,12 +77,9 @@ export const zInvite = z.object({
     expiry: z.iso.datetime(),
     expired: z.boolean()
 });
-export const zPaginatedInvites = z.object({
-    invites: z.array(zInvite),
-    page: z.int(),
-    limit: z.int(),
-    total: z.int()
-});
+export const zPaginatedInvites = zPagination.and(z.object({
+    invites: z.array(zInvite)
+}));
 export const zCreateInvite = z.object({
     to: z.string(),
     role: z.string()
@@ -298,6 +300,9 @@ export const zEnvironmentVersion = z.object({
     retries: z.optional(z.int()),
     version: z.int()
 });
+export const zPaginatedEnvironmentVersions = zPagination.and(z.object({
+    versions: z.array(zEnvironmentVersion)
+}));
 export const zNetworkEdgeProps = z.object({
     a: z.optional(z.string())
 });
@@ -578,6 +583,14 @@ export const zNodeId = z.uuid();
  * A version UUID.
  */
 export const zVersionUuid = z.uuid();
+/**
+ * Optional version UUID to exclude from the environment versions response.
+ */
+export const zExcludeVersionUuidQuery = z.uuid();
+/**
+ * Optional version status to filter the environment versions response.
+ */
+export const zVersionStatusQuery = zVersionStatus;
 /**
  * A version number with in an environment.
  */
@@ -1009,12 +1022,17 @@ export const zGetEnvironmentVersionsData = z.object({
         projectHandle: z.string(),
         environmentHandle: z.string()
     }),
-    query: z.optional(z.never())
+    query: z.optional(z.object({
+        page: z.optional(z.int().gte(1)).default(1),
+        limit: z.optional(z.int().gte(1).lte(100)).default(10),
+        excludeVersionUUID: z.optional(z.uuid()),
+        status: z.optional(zVersionStatus)
+    }))
 });
 /**
  * Environment versions.
  */
-export const zGetEnvironmentVersionsResponse = z.array(zEnvironmentVersion);
+export const zGetEnvironmentVersionsResponse = zPaginatedEnvironmentVersions;
 export const zDeleteEnvironmentVariableData = z.object({
     body: z.optional(z.never()),
     path: z.object({

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

@@ -140,7 +140,7 @@ export declare const useGetEnvironmentOverview: (options: Omit<GetEnvironmentOve
 }) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentOverview | undefined, Error>;
 export declare const useGetEnvironmentVersions: (options: Omit<GetEnvironmentVersionsData, "url"> & {
     enabled?: boolean;
-}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").EnvironmentVersion[] | undefined, Error>;
+}) => import("@tanstack/react-query").UseQueryResult<import("../../sdk/types.gen").PaginatedEnvironmentVersions | undefined, Error>;
 export declare const useDeleteEnvironmentVariable: (config?: {
     onSuccess?: (data: GetSuccessResponse<DeleteEnvironmentVariableResponses>) => void;
     onError?: Parameters<typeof useMutation>["0"]["onError"];

package/package.json

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