@budibase/types 3.5.2 → 3.6.0

package/dist/api/web/ai.d.ts

@@ -0,0 +1,8 @@
+import { EnrichedBinding } from "../../ui";
+export interface GenerateJsRequest {
+    prompt: string;
+    bindings?: EnrichedBinding[];
+}
+export interface GenerateJsResponse {
+    code: string;
+}

package/dist/api/web/app/index.d.ts

@@ -1,21 +1,22 @@
-export * from "./backup";
-export * from "./datasource";
-export * from "./view";
-export * from "./rows";
-export * from "./table";
-export * from "./permission";
+export * from "./application";
 export * from "./attachment";
-export * from "./user";
-export * from "./rowAction";
 export * from "./automation";
+export * from "./backup";
 export * from "./component";
+export * from "./datasource";
+export * from "./deployment";
 export * from "./integration";
+export * from "./layout";
 export * from "./metadata";
+export * from "./oauth2";
+export * from "./permission";
 export * from "./query";
-export * from "./screen";
-export * from "./application";
-export * from "./layout";
-export * from "./deployment";
 export * from "./role";
-export * from "./webhook";
+export * from "./rowAction";
+export * from "./rows";
+export * from "./screen";
 export * from "./static";
+export * from "./table";
+export * from "./user";
+export * from "./view";
+export * from "./webhook";

package/dist/api/web/app/oauth2.d.ts

@@ -0,0 +1,46 @@
+import { OAuth2CredentialsMethod } from "@budibase/types";
+export interface OAuth2ConfigResponse {
+    _id: string;
+    _rev: string;
+    name: string;
+    url: string;
+    clientId: string;
+    clientSecret: string;
+    method: OAuth2CredentialsMethod;
+}
+export interface FetchOAuth2ConfigsResponse {
+    configs: OAuth2ConfigResponse[];
+}
+export interface InsertOAuth2ConfigRequest {
+    name: string;
+    url: string;
+    clientId: string;
+    clientSecret: string;
+    method: OAuth2CredentialsMethod;
+}
+export interface InsertOAuth2ConfigResponse {
+    config: OAuth2ConfigResponse;
+}
+export interface UpdateOAuth2ConfigRequest {
+    _id: string;
+    _rev: string;
+    name: string;
+    url: string;
+    clientId: string;
+    clientSecret: string;
+    method: OAuth2CredentialsMethod;
+}
+export interface UpdateOAuth2ConfigResponse {
+    config: OAuth2ConfigResponse;
+}
+export interface ValidateConfigRequest {
+    _id?: string;
+    url: string;
+    clientId: string;
+    clientSecret: string;
+    method: OAuth2CredentialsMethod;
+}
+export interface ValidateConfigResponse {
+    valid: boolean;
+    message?: string;
+}

package/dist/api/web/app/rows/search.d.ts

@@ -1,6 +1,6 @@
 import { EmptyFilterOption } from "../../../../sdk";
 import { Row } from "../../../../documents";
-import { PaginationResponse, SortOrder } from "../../../../api/web/pagination";
+import { PaginationResponse, SortOrder, SortType } from "../../../../api/web/pagination";
 import { z } from "zod";
 declare const searchRowRequest: z.ZodObject<{
     query: z.ZodOptional<z.ZodObject<{
@@ -20,8 +20,6 @@ declare const searchRowRequest: z.ZodObject<{
         allOr: z.ZodOptional<z.ZodBoolean>;
         onEmptyFilter: z.ZodOptional<z.ZodNativeEnum<typeof EmptyFilterOption>>;
     }, "strip", z.ZodTypeAny, {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -33,11 +31,11 @@ declare const searchRowRequest: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     }, {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -49,6 +47,8 @@ declare const searchRowRequest: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     }>>;
@@ -57,14 +57,13 @@ declare const searchRowRequest: z.ZodObject<{
     limit: z.ZodOptional<z.ZodNumber>;
     sort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     sortOrder: z.ZodOptional<z.ZodNativeEnum<typeof SortOrder>>;
+    sortType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof SortType>>>;
     version: z.ZodOptional<z.ZodString>;
     disableEscaping: z.ZodOptional<z.ZodBoolean>;
     countRows: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     version?: string | undefined;
     query?: {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -76,6 +75,8 @@ declare const searchRowRequest: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     } | undefined;
@@ -84,13 +85,12 @@ declare const searchRowRequest: z.ZodObject<{
     paginate?: boolean | undefined;
     bookmark?: string | number | null | undefined;
     sortOrder?: SortOrder | undefined;
+    sortType?: SortType | null | undefined;
     disableEscaping?: boolean | undefined;
     countRows?: boolean | undefined;
 }, {
     version?: string | undefined;
     query?: {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -102,6 +102,8 @@ declare const searchRowRequest: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     } | undefined;
@@ -110,6 +112,7 @@ declare const searchRowRequest: z.ZodObject<{
     paginate?: boolean | undefined;
     bookmark?: string | number | null | undefined;
     sortOrder?: SortOrder | undefined;
+    sortType?: SortType | null | undefined;
     disableEscaping?: boolean | undefined;
     countRows?: boolean | undefined;
 }>;
@@ -131,8 +134,6 @@ export declare const searchRowRequestValidator: z.ZodObject<{
         allOr: z.ZodOptional<z.ZodBoolean>;
         onEmptyFilter: z.ZodOptional<z.ZodNativeEnum<typeof EmptyFilterOption>>;
     }, "strip", z.ZodTypeAny, {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -144,11 +145,11 @@ export declare const searchRowRequestValidator: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     }, {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -160,6 +161,8 @@ export declare const searchRowRequestValidator: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     }>>;
@@ -168,14 +171,13 @@ export declare const searchRowRequestValidator: z.ZodObject<{
     limit: z.ZodOptional<z.ZodNumber>;
     sort: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     sortOrder: z.ZodOptional<z.ZodNativeEnum<typeof SortOrder>>;
+    sortType: z.ZodOptional<z.ZodNullable<z.ZodNativeEnum<typeof SortType>>>;
     version: z.ZodOptional<z.ZodString>;
     disableEscaping: z.ZodOptional<z.ZodBoolean>;
     countRows: z.ZodOptional<z.ZodBoolean>;
 }, "strip", z.ZodTypeAny, {
     version?: string | undefined;
     query?: {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -187,6 +189,8 @@ export declare const searchRowRequestValidator: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     } | undefined;
@@ -195,13 +199,12 @@ export declare const searchRowRequestValidator: z.ZodObject<{
     paginate?: boolean | undefined;
     bookmark?: string | number | null | undefined;
     sortOrder?: SortOrder | undefined;
+    sortType?: SortType | null | undefined;
     disableEscaping?: boolean | undefined;
     countRows?: boolean | undefined;
 }, {
     version?: string | undefined;
     query?: {
-        allOr?: boolean | undefined;
-        onEmptyFilter?: EmptyFilterOption | undefined;
         equal?: any;
         notEqual?: any;
         empty?: any;
@@ -213,6 +216,8 @@ export declare const searchRowRequestValidator: z.ZodObject<{
         notContains?: any;
         containsAny?: any;
         oneOf?: any;
+        allOr?: boolean | undefined;
+        onEmptyFilter?: EmptyFilterOption | undefined;
         $and?: any;
         $or?: any;
     } | undefined;
@@ -221,11 +226,12 @@ export declare const searchRowRequestValidator: z.ZodObject<{
     paginate?: boolean | undefined;
     bookmark?: string | number | null | undefined;
     sortOrder?: SortOrder | undefined;
+    sortType?: SortType | null | undefined;
     disableEscaping?: boolean | undefined;
     countRows?: boolean | undefined;
 }>;
 export type SearchRowRequest = z.infer<typeof searchRowRequest>;
-export type SearchViewRowRequest = Pick<SearchRowRequest, "sort" | "sortOrder" | "limit" | "bookmark" | "paginate" | "query" | "countRows">;
+export type SearchViewRowRequest = Pick<SearchRowRequest, "sort" | "sortOrder" | "sortType" | "limit" | "bookmark" | "paginate" | "query" | "countRows">;
 export interface SearchRowResponse {
     rows: Row[];
 }

package/dist/api/web/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./ai";
 export * from "./analytics";
 export * from "./auth";
 export * from "./user";

package/dist/api/web/searchFilter.d.ts

@@ -19,9 +19,13 @@ export type SearchFilter = {
 export type LegacyFilter = AllOr | OnEmptyFilter | SearchFilter;
 export type SearchFilterGroup = {
     logicalOperator?: UILogicalOperator;
-    groups?: SearchFilterGroup[];
+} & ({
+    groups?: (SearchFilterGroup | UISearchFilter)[];
+    filters?: never;
+} | {
     filters?: LegacyFilter[];
-};
+    groups?: never;
+});
 export type UISearchFilter = {
     logicalOperator?: UILogicalOperator;
     onEmptyFilter?: EmptyFilterOption;

package/dist/documents/app/datasource.d.ts

@@ -15,7 +15,8 @@ export interface Datasource extends Document {
 }
 export declare enum RestAuthType {
     BASIC = "basic",
-    BEARER = "bearer"
+    BEARER = "bearer",
+    OAUTH2 = "oauth2"
 }
 export interface RestBasicAuthConfig {
     username: string;
@@ -24,12 +25,19 @@ export interface RestBasicAuthConfig {
 export interface RestBearerAuthConfig {
     token: string;
 }
-export interface RestAuthConfig {
+export interface BasicRestAuthConfig {
     _id: string;
     name: string;
-    type: RestAuthType;
-    config: RestBasicAuthConfig | RestBearerAuthConfig;
+    type: RestAuthType.BASIC;
+    config: RestBasicAuthConfig;
 }
+export interface BearerRestAuthConfig {
+    _id: string;
+    name: string;
+    type: RestAuthType.BEARER;
+    config: RestBearerAuthConfig;
+}
+export type RestAuthConfig = BasicRestAuthConfig | BearerRestAuthConfig;
 export interface DynamicVariable {
     name: string;
     queryId: string;

package/dist/documents/app/index.d.ts

@@ -1,22 +1,23 @@
+export * from "../document";
 export * from "./app";
 export * from "./automation";
+export * from "./backup";
+export * from "./component";
 export * from "./datasource";
+export * from "./deployment";
 export * from "./layout";
+export * from "./links";
+export * from "./metadata";
+export * from "./oauth2";
 export * from "./query";
 export * from "./role";
-export * from "./table";
-export * from "./screen";
-export * from "./view";
-export * from "../document";
 export * from "./row";
-export * from "./user";
-export * from "./backup";
-export * from "./webhook";
-export * from "./links";
-export * from "./component";
-export * from "./sqlite";
-export * from "./snippet";
 export * from "./rowAction";
+export * from "./screen";
+export * from "./snippet";
+export * from "./sqlite";
+export * from "./table";
 export * from "./theme";
-export * from "./deployment";
-export * from "./metadata";
+export * from "./user";
+export * from "./view";
+export * from "./webhook";

package/dist/documents/app/oauth2.d.ts

@@ -0,0 +1,12 @@
+import { Document } from "../document";
+export declare enum OAuth2CredentialsMethod {
+    HEADER = "HEADER",
+    BODY = "BODY"
+}
+export interface OAuth2Config extends Document {
+    name: string;
+    url: string;
+    clientId: string;
+    clientSecret: string;
+    method: OAuth2CredentialsMethod;
+}

package/dist/documents/app/query.d.ts

@@ -1,4 +1,5 @@
 import { Document } from "../document";
+import { RestAuthType } from "./datasource";
 import { Row } from "./row";
 export interface QuerySchema {
     name?: string;
@@ -52,6 +53,7 @@ export interface RestQueryFields {
     bodyType?: BodyType;
     method?: string;
     authConfigId?: string;
+    authConfigType?: RestAuthType;
     pagination?: PaginationConfig;
     paginationValues?: PaginationValues;
 }

package/dist/documents/app/table/schema.d.ts

@@ -115,15 +115,15 @@ export interface FieldConstraints {
         message?: string;
     };
     numericality?: {
-        greaterThanOrEqualTo: string | null;
-        lessThanOrEqualTo: string | null;
+        greaterThanOrEqualTo?: string | null;
+        lessThanOrEqualTo?: string | null;
     };
     presence?: boolean | {
         allowEmpty?: boolean;
     };
     datetime?: {
-        latest: string;
-        earliest: string;
+        latest?: string;
+        earliest?: string;
     };
 }
 export interface OptionsFieldMetadata extends BaseFieldSchema {
@@ -149,7 +149,7 @@ export interface BigIntFieldMetadata extends BaseFieldSchema {
     type: FieldType.BIGINT;
     default?: string;
 }
-interface BaseFieldSchema extends UIFieldMetadata {
+export interface BaseFieldSchema extends UIFieldMetadata {
     type: FieldType;
     name: string;
     sortable?: boolean;

package/dist/documents/document.d.ts

@@ -37,7 +37,8 @@ export declare enum DocumentType {
     AUDIT_LOG = "al",
     APP_MIGRATION_METADATA = "_design/migrations",
     SCIM_LOG = "scimlog",
-    ROW_ACTIONS = "ra"
+    ROW_ACTIONS = "ra",
+    OAUTH2_CONFIG = "oauth2"
 }
 export declare function getDocumentType(id: string): DocumentType | undefined;
 export declare const DocumentTypesToImport: DocumentType[];

package/dist/documents/global/user.d.ts

@@ -1,4 +1,5 @@
 import { Document } from "../document";
+import { ContextUser } from "../../sdk";
 export interface SSOProfileJson {
     email?: string;
     picture?: string;
@@ -24,7 +25,7 @@ export interface UserSSO {
     };
 }
 export type SSOUser = User & UserSSO;
-export declare function isSSOUser(user: User): user is SSOUser;
+export declare function isSSOUser(user: User | ContextUser): user is SSOUser;
 export interface UserIdentifier {
     userId: string;
     email: string;