@budibase/types 2.8.31-alpha.0 → 2.8.31

package/dist/cjs/api/web/global/scim/users.d.ts

@@ -0,0 +1,48 @@
+import { ScimResource, ScimMeta } from "scim-patch";
+import { ScimListResponse } from "./shared";
+declare type BooleanString = boolean | "True" | "true" | "False" | "false";
+declare type Emails = {
+    value: string;
+    type: "work";
+    primary: boolean;
+}[];
+export interface ScimUserResponse extends ScimResource {
+    schemas: ["urn:ietf:params:scim:schemas:core:2.0:User"];
+    id: string;
+    externalId: string;
+    meta: ScimMeta & {
+        resourceType: "User";
+    };
+    userName: string;
+    displayName?: string;
+    name?: {
+        formatted?: string;
+        familyName?: string;
+        givenName?: string;
+    };
+    active: BooleanString;
+    emails?: Emails;
+}
+export interface ScimCreateUserRequest {
+    schemas: [
+        "urn:ietf:params:scim:schemas:core:2.0:User",
+        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
+    ];
+    externalId: string;
+    userName: string;
+    active: BooleanString;
+    emails?: Emails;
+    meta: {
+        resourceType: "User";
+    };
+    displayName?: string;
+    name?: {
+        formatted: string;
+        familyName: string;
+        givenName: string;
+    };
+    roles: [];
+}
+export interface ScimUserListResponse extends ScimListResponse<ScimUserResponse> {
+}
+export {};

package/dist/cjs/api/web/global/scim/users.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=users.js.map

package/dist/cjs/api/web/global/scim/users.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"users.js","sourceRoot":"","sources":["../../../../../../src/api/web/global/scim/users.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,9 @@
+export * from "./analytics";
+export * from "./auth";
+export * from "./user";
+export * from "./errors";
+export * from "./schedule";
+export * from "./system";
+export * from "./app";
+export * from "./global";
+export * from "./pagination";

package/dist/cjs/api/web/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./analytics"), exports);
+__exportStar(require("./auth"), exports);
+__exportStar(require("./user"), exports);
+__exportStar(require("./errors"), exports);
+__exportStar(require("./schedule"), exports);
+__exportStar(require("./system"), exports);
+__exportStar(require("./app"), exports);
+__exportStar(require("./global"), exports);
+__exportStar(require("./pagination"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/api/web/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,8CAA2B;AAC3B,yCAAsB;AACtB,yCAAsB;AACtB,2CAAwB;AACxB,6CAA0B;AAC1B,2CAAwB;AACxB,wCAAqB;AACrB,2CAAwB;AACxB,+CAA4B"}

package/dist/cjs/api/web/pagination.d.ts

@@ -0,0 +1,23 @@
+export declare enum SortOrder {
+    ASCENDING = "ascending",
+    DESCENDING = "descending"
+}
+export declare enum SortType {
+    STRING = "string",
+    number = "number"
+}
+export interface BasicPaginationRequest {
+    bookmark?: string;
+}
+export interface PaginationRequest extends BasicPaginationRequest {
+    limit?: number;
+    sort?: {
+        order: SortOrder;
+        column: string;
+        type: SortType;
+    };
+}
+export interface PaginationResponse {
+    bookmark: string | undefined;
+    hasNextPage: boolean;
+}

package/dist/cjs/api/web/pagination.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortType = exports.SortOrder = void 0;
+var SortOrder;
+(function (SortOrder) {
+    SortOrder["ASCENDING"] = "ascending";
+    SortOrder["DESCENDING"] = "descending";
+})(SortOrder = exports.SortOrder || (exports.SortOrder = {}));
+var SortType;
+(function (SortType) {
+    SortType["STRING"] = "string";
+    SortType["number"] = "number";
+})(SortType = exports.SortType || (exports.SortType = {}));
+//# sourceMappingURL=pagination.js.map

package/dist/cjs/api/web/pagination.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../../../../src/api/web/pagination.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAGX;AAHD,WAAY,SAAS;IACnB,oCAAuB,CAAA;IACvB,sCAAyB,CAAA;AAC3B,CAAC,EAHW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAGpB;AAED,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,6BAAiB,CAAA;IACjB,6BAAiB,CAAA;AACnB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}

package/dist/cjs/api/web/schedule.d.ts

@@ -0,0 +1,10 @@
+import { ScheduleMetadata, ScheduleRepeatPeriod, ScheduleType } from "../../documents";
+export interface CreateScheduleRequest {
+    type: ScheduleType;
+    name: string;
+    startDate: string;
+    repeat: ScheduleRepeatPeriod;
+    metadata: ScheduleMetadata;
+}
+export interface UpdateScheduleRequest extends CreateScheduleRequest {
+}

package/dist/cjs/api/web/schedule.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=schedule.js.map

package/dist/cjs/api/web/schedule.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schedule.js","sourceRoot":"","sources":["../../../../src/api/web/schedule.ts"],"names":[],"mappings":""}

package/dist/cjs/api/web/system/environment.d.ts

@@ -0,0 +1,8 @@
+export interface GetEnvironmentResponse {
+    multiTenancy: boolean;
+    cloud: boolean;
+    accountPortalUrl: string;
+    baseUrl: string;
+    disableAccountPortal: boolean;
+    isDev: boolean;
+}

package/dist/cjs/api/web/system/environment.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=environment.js.map

package/dist/cjs/api/web/system/environment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environment.js","sourceRoot":"","sources":["../../../../../src/api/web/system/environment.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1 @@
+export * from "./environment";

package/dist/cjs/api/web/system/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./environment"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/api/web/system/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/api/web/system/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,gDAA6B"}

package/dist/cjs/api/web/user.d.ts

@@ -0,0 +1,84 @@
+import { User } from "../../documents";
+export interface SaveUserResponse {
+    _id: string;
+    _rev: string;
+    email: string;
+}
+export interface UserDetails {
+    _id: string;
+    email: string;
+}
+export interface BulkUserRequest {
+    delete?: {
+        userIds: string[];
+    };
+    create?: {
+        roles?: any[];
+        users: User[];
+        groups: any[];
+    };
+}
+export interface BulkUserCreated {
+    successful: UserDetails[];
+    unsuccessful: {
+        email: string;
+        reason: string;
+    }[];
+}
+export interface BulkUserDeleted {
+    successful: UserDetails[];
+    unsuccessful: {
+        _id: string;
+        email: string;
+        reason: string;
+    }[];
+}
+export interface BulkUserResponse {
+    created?: BulkUserCreated;
+    deleted?: BulkUserDeleted;
+    message?: string;
+}
+export interface InviteUserRequest {
+    email: string;
+    userInfo: any;
+}
+export declare type InviteUsersRequest = InviteUserRequest[];
+export interface InviteUsersResponse {
+    successful: {
+        email: string;
+    }[];
+    unsuccessful: {
+        email: string;
+        reason: string;
+    }[];
+}
+export interface SearchUsersRequest {
+    page?: string;
+    email?: string;
+    appId?: string;
+    paginated?: boolean;
+}
+export interface CreateAdminUserRequest {
+    email: string;
+    password: string;
+    tenantId: string;
+}
+export interface CreateAdminUserResponse {
+    _id: string;
+    _rev: string;
+    email: string;
+}
+export interface AcceptUserInviteRequest {
+    inviteCode: string;
+    password: string;
+    firstName: string;
+    lastName: string;
+}
+export interface AcceptUserInviteResponse {
+    _id: string;
+    _rev: string;
+    email: string;
+}
+export interface SyncUserRequest {
+    previousUser?: User;
+}

package/dist/cjs/api/web/user.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user.js.map

package/dist/cjs/api/web/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../../src/api/web/user.ts"],"names":[],"mappings":""}

package/dist/cjs/documents/account/account.d.ts

@@ -0,0 +1,78 @@
+import { Feature, Hosting, License, PlanType, Quotas } from "../../sdk";
+import { DeepPartial } from "../../shared";
+import { QuotaUsage } from "../global";
+export interface CreateAccount {
+    email: string;
+    tenantId: string;
+    hosting: Hosting;
+    authType: AuthType;
+    registrationStep?: string;
+    tenantName?: string;
+    name?: string;
+    size?: string;
+    profession?: string;
+}
+export interface CreatePassswordAccount extends CreateAccount {
+    password: string;
+}
+export declare const isCreatePasswordAccount: (account: CreateAccount) => account is CreatePassswordAccount;
+export interface LicenseOverrides {
+    features?: Feature[];
+    quotas?: DeepPartial<Quotas>;
+}
+export interface Account extends CreateAccount {
+    accountId: string;
+    createdAt: number;
+    verified: boolean;
+    verificationSent: boolean;
+    tier: string;
+    planType?: PlanType;
+    /** @deprecated */
+    planTier?: number;
+    license?: License;
+    installId?: string;
+    installTenantId?: string;
+    installVersion?: string;
+    stripeCustomerId?: string;
+    licenseKey?: string;
+    licenseKeyActivatedAt?: number;
+    licenseRequestedAt?: number;
+    licenseOverrides?: LicenseOverrides;
+    quotaUsage?: QuotaUsage;
+    offlineLicenseToken?: string;
+}
+export interface PasswordAccount extends Account {
+    password: string;
+}
+export declare const isPasswordAccount: (account: Account) => account is PasswordAccount;
+export interface CloudAccount extends Account {
+    password?: string;
+    budibaseUserId: string;
+}
+export declare const isCloudAccount: (account: Account) => account is CloudAccount;
+export declare const isSelfHostAccount: (account: Account) => boolean;
+export declare const isSSOAccount: (account: Account) => account is SSOAccount;
+export declare enum AccountSSOProviderType {
+    GOOGLE = "google",
+    MICROSOFT = "microsoft"
+}
+export declare enum AccountSSOProvider {
+    GOOGLE = "google",
+    MICROSOFT = "microsoft"
+}
+export interface AccountSSO {
+    provider: AccountSSOProvider;
+    providerType: AccountSSOProviderType;
+    oauth2?: OAuthTokens;
+    pictureUrl?: string;
+    thirdPartyProfile: any;
+}
+export declare type SSOAccount = (Account | CloudAccount) & AccountSSO;
+export declare enum AuthType {
+    SSO = "sso",
+    PASSWORD = "password"
+}
+export interface OAuthTokens {
+    accessToken: string;
+    refreshToken: string;
+}

package/dist/cjs/documents/account/account.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthType = exports.AccountSSOProvider = exports.AccountSSOProviderType = exports.isSSOAccount = exports.isSelfHostAccount = exports.isCloudAccount = exports.isPasswordAccount = exports.isCreatePasswordAccount = void 0;
+const sdk_1 = require("../../sdk");
+const isCreatePasswordAccount = (account) => account.authType === AuthType.PASSWORD;
+exports.isCreatePasswordAccount = isCreatePasswordAccount;
+const isPasswordAccount = (account) => account.authType === AuthType.PASSWORD && account.hosting === sdk_1.Hosting.SELF;
+exports.isPasswordAccount = isPasswordAccount;
+const isCloudAccount = (account) => account.hosting === sdk_1.Hosting.CLOUD;
+exports.isCloudAccount = isCloudAccount;
+const isSelfHostAccount = (account) => account.hosting === sdk_1.Hosting.SELF;
+exports.isSelfHostAccount = isSelfHostAccount;
+const isSSOAccount = (account) => account.authType === AuthType.SSO;
+exports.isSSOAccount = isSSOAccount;
+var AccountSSOProviderType;
+(function (AccountSSOProviderType) {
+    AccountSSOProviderType["GOOGLE"] = "google";
+    AccountSSOProviderType["MICROSOFT"] = "microsoft";
+})(AccountSSOProviderType = exports.AccountSSOProviderType || (exports.AccountSSOProviderType = {}));
+var AccountSSOProvider;
+(function (AccountSSOProvider) {
+    AccountSSOProvider["GOOGLE"] = "google";
+    AccountSSOProvider["MICROSOFT"] = "microsoft";
+})(AccountSSOProvider = exports.AccountSSOProvider || (exports.AccountSSOProvider = {}));
+var AuthType;
+(function (AuthType) {
+    AuthType["SSO"] = "sso";
+    AuthType["PASSWORD"] = "password";
+})(AuthType = exports.AuthType || (exports.AuthType = {}));
+//# sourceMappingURL=account.js.map

package/dist/cjs/documents/account/account.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.js","sourceRoot":"","sources":["../../../../src/documents/account/account.ts"],"names":[],"mappings":";;;AAAA,mCAAuE;AAsBhE,MAAM,uBAAuB,GAAG,CACrC,OAAsB,EACa,EAAE,CAAC,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,CAAA;AAFjE,QAAA,uBAAuB,2BAE0C;AAoCvE,MAAM,iBAAiB,GAAG,CAC/B,OAAgB,EACY,EAAE,CAC9B,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,QAAQ,IAAI,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AAH/D,QAAA,iBAAiB,qBAG8C;AAOrE,MAAM,cAAc,GAAG,CAAC,OAAgB,EAA2B,EAAE,CAC1E,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,KAAK,CAAA;AADtB,QAAA,cAAc,kBACQ;AAE5B,MAAM,iBAAiB,GAAG,CAAC,OAAgB,EAAE,EAAE,CACpD,OAAO,CAAC,OAAO,KAAK,aAAO,CAAC,IAAI,CAAA;AADrB,QAAA,iBAAiB,qBACI;AAE3B,MAAM,YAAY,GAAG,CAAC,OAAgB,EAAyB,EAAE,CACtE,OAAO,CAAC,QAAQ,KAAK,QAAQ,CAAC,GAAG,CAAA;AADtB,QAAA,YAAY,gBACU;AAEnC,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,iDAAuB,CAAA;AACzB,CAAC,EAHW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAGjC;AAED,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,uCAAiB,CAAA;IACjB,6CAAuB,CAAA;AACzB,CAAC,EAHW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAG7B;AAYD,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,uBAAW,CAAA;IACX,iCAAqB,CAAA;AACvB,CAAC,EAHW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAGnB"}

package/dist/cjs/documents/account/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./account";
+export * from "./user";

package/dist/cjs/documents/account/index.js

@@ -0,0 +1,19 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./account"), exports);
+__exportStar(require("./user"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/documents/account/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/documents/account/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB;AACzB,yCAAsB"}

package/dist/cjs/documents/account/user.d.ts

@@ -0,0 +1,9 @@
+export interface CreateAccountUserActivity {
+    accountId: string;
+    userId: string;
+    timestamp: number;
+}
+export interface AccountUserActivity extends CreateAccountUserActivity {
+    PK: string;
+    SK: string;
+}

package/dist/cjs/documents/account/user.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=user.js.map

package/dist/cjs/documents/account/user.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../../src/documents/account/user.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,59 @@
+import { User, Document } from "../";
+export declare type AppMetadataErrors = {
+    [key: string]: string[];
+};
+export interface App extends Document {
+    appId: string;
+    type: string;
+    version: string;
+    componentLibraries: string[];
+    name: string;
+    url: string | undefined;
+    template: string | undefined;
+    instance: AppInstance;
+    tenantId: string;
+    status: string;
+    theme?: string;
+    customTheme?: AppCustomTheme;
+    revertableVersion?: string;
+    lockedBy?: User;
+    navigation?: AppNavigation;
+    automationErrors?: AppMetadataErrors;
+    icon?: AppIcon;
+    features?: AppFeatures;
+}
+export interface AppInstance {
+    _id: string;
+}
+export interface AppNavigation {
+    navigation: string;
+    title: string;
+    navWidth: string;
+    sticky?: boolean;
+    hideLogo?: boolean;
+    logoUrl?: string;
+    hideTitle?: boolean;
+    navBackground?: string;
+    navTextColor?: string;
+    links?: AppNavigationLink[];
+}
+export interface AppNavigationLink {
+    text: string;
+    url: string;
+    id?: string;
+    roleId?: string;
+}
+export interface AppCustomTheme {
+    buttonBorderRadius?: string;
+    primaryColor?: string;
+    primaryColorHover?: string;
+    navTextColor?: string;
+    navBackground?: string;
+}
+export interface AppIcon {
+    name: string;
+    color: string;
+}
+export interface AppFeatures {
+    componentValidation?: boolean;
+}

package/dist/cjs/documents/app/app.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=app.js.map

package/dist/cjs/documents/app/app.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.js","sourceRoot":"","sources":["../../../../src/documents/app/app.ts"],"names":[],"mappings":""}