@budibase/types 2.8.31 → 2.8.32-alpha.0

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

@@ -1,67 +0,0 @@
-import { Document } from "../document";
-export interface SSOProfileJson {
-    email?: string;
-    picture?: string;
-}
-export interface OAuth2 {
-    accessToken: string;
-    refreshToken?: string;
-}
-export declare enum SSOProviderType {
-    OIDC = "oidc",
-    GOOGLE = "google"
-}
-export interface UserSSO {
-    provider: string;
-    providerType: SSOProviderType;
-    oauth2?: OAuth2;
-    thirdPartyProfile?: SSOProfileJson;
-}
-export declare type SSOUser = User & UserSSO;
-export declare function isSSOUser(user: User): user is SSOUser;
-export interface User extends Document {
-    tenantId: string;
-    email: string;
-    userId?: string;
-    firstName?: string;
-    lastName?: string;
-    pictureUrl?: string;
-    forceResetPassword?: boolean;
-    roles: UserRoles;
-    builder?: {
-        global: boolean;
-    };
-    admin?: {
-        global: boolean;
-    };
-    password?: string;
-    status?: UserStatus;
-    createdAt?: number;
-    dayPassRecordedAt?: string;
-    userGroups?: string[];
-    onboardedAt?: string;
-    scimInfo?: {
-        isSync: true;
-    } & Record<string, any>;
-}
-export declare enum UserStatus {
-    ACTIVE = "active",
-    INACTIVE = "inactive"
-}
-export interface UserRoles {
-    [key: string]: string;
-}
-export interface BuilderUser extends User {
-    builder: {
-        global: boolean;
-    };
-}
-export interface AdminUser extends User {
-    admin: {
-        global: boolean;
-    };
-    builder: {
-        global: boolean;
-    };
-}
-export declare function isUser(user: object): user is User;

package/dist/mjs/documents/global/user.js

@@ -1,17 +0,0 @@
-export var SSOProviderType;
-(function (SSOProviderType) {
-    SSOProviderType["OIDC"] = "oidc";
-    SSOProviderType["GOOGLE"] = "google";
-})(SSOProviderType || (SSOProviderType = {}));
-export function isSSOUser(user) {
-    return !!user.providerType;
-}
-export var UserStatus;
-(function (UserStatus) {
-    UserStatus["ACTIVE"] = "active";
-    UserStatus["INACTIVE"] = "inactive";
-})(UserStatus || (UserStatus = {}));
-export function isUser(user) {
-    return !!user.roles;
-}
-//# sourceMappingURL=user.js.map

package/dist/mjs/documents/global/user.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"user.js","sourceRoot":"","sources":["../../../../src/documents/global/user.ts"],"names":[],"mappings":"AAcA,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,oCAAiB,CAAA;AACnB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAWD,MAAM,UAAU,SAAS,CAAC,IAAU;IAClC,OAAO,CAAC,CAAE,IAAgB,CAAC,YAAY,CAAA;AACzC,CAAC;AA4BD,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;AACvB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AAuBD,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,CAAE,IAAa,CAAC,KAAK,CAAA;AAC/B,CAAC"}

package/dist/mjs/documents/global/userGroup.d.ts

@@ -1,32 +0,0 @@
-import { PaginationResponse } from "../../api";
-import { Document } from "../document";
-export interface UserGroup extends Document {
-    name: string;
-    icon: string;
-    color: string;
-    users?: GroupUser[];
-    roles?: UserGroupRoles;
-    createdAt?: number;
-    scimInfo?: {
-        externalId: string;
-        isSync: boolean;
-    };
-}
-export interface GroupUser {
-    _id: string;
-    email: string;
-}
-export interface UserGroupRoles {
-    [key: string]: string;
-}
-export interface SearchGroupRequest {
-}
-export interface SearchGroupResponse {
-    data: UserGroup[];
-}
-export interface SearchUserGroupResponse extends PaginationResponse {
-    users: {
-        _id: any;
-        email: any;
-    }[];
-}

package/dist/mjs/documents/global/userGroup.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=userGroup.js.map

package/dist/mjs/documents/global/userGroup.js.map

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

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

@@ -1,6 +0,0 @@
-export * from "./account";
-export * from "./app";
-export * from "./global";
-export * from "./platform";
-export * from "./document";
-export * from "./pouch";

package/dist/mjs/documents/index.js

@@ -1,7 +0,0 @@
-export * from "./account";
-export * from "./app";
-export * from "./global";
-export * from "./platform";
-export * from "./document";
-export * from "./pouch";
-//# sourceMappingURL=index.js.map

package/dist/mjs/documents/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA;AACzB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,SAAS,CAAA"}

package/dist/mjs/documents/platform/accounts.d.ts

@@ -1,4 +0,0 @@
-import { Document } from "../document";
-export interface AccountMetadata extends Document {
-    email: string;
-}

package/dist/mjs/documents/platform/accounts.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=accounts.js.map

package/dist/mjs/documents/platform/accounts.js.map

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

package/dist/mjs/documents/platform/index.d.ts

@@ -1,4 +0,0 @@
-export * from "./info";
-export * from "./users";
-export * from "./accounts";
-export * from "./tenants";

package/dist/mjs/documents/platform/index.js

@@ -1,5 +0,0 @@
-export * from "./info";
-export * from "./users";
-export * from "./accounts";
-export * from "./tenants";
-//# sourceMappingURL=index.js.map

package/dist/mjs/documents/platform/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/documents/platform/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,WAAW,CAAA"}

package/dist/mjs/documents/platform/info.d.ts

@@ -1,8 +0,0 @@
-import { Document } from "../document";
-export interface GlobalInfo {
-}
-export interface Installation extends Document {
-    _id: string;
-    installId: string;
-    version: string;
-}

package/dist/mjs/documents/platform/info.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=info.js.map

package/dist/mjs/documents/platform/info.js.map

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

package/dist/mjs/documents/platform/tenants.d.ts

@@ -1,4 +0,0 @@
-import { Document } from "../document";
-export interface Tenants extends Document {
-    tenantIds: string[];
-}

package/dist/mjs/documents/platform/tenants.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=tenants.js.map

package/dist/mjs/documents/platform/tenants.js.map

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

package/dist/mjs/documents/platform/users.d.ts

@@ -1,15 +0,0 @@
-import { Document } from "../document";
-/**
- * doc id is user email
- */
-export interface PlatformUserByEmail extends Document {
-    tenantId: string;
-    userId: string;
-}
-/**
- * doc id is userId
- */
-export interface PlatformUserById extends Document {
-    tenantId: string;
-}
-export declare type PlatformUser = PlatformUserByEmail | PlatformUserById;

package/dist/mjs/documents/platform/users.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=users.js.map

package/dist/mjs/documents/platform/users.js.map

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

package/dist/mjs/documents/pouch.d.ts

@@ -1,28 +0,0 @@
-export interface RowValue {
-    rev: string;
-    deleted: boolean;
-}
-export interface RowResponse<T> {
-    id: string;
-    key: string;
-    error: string;
-    value: T | RowValue;
-    doc?: T | any;
-}
-export interface AllDocsResponse<T> {
-    offset: number;
-    total_rows: number;
-    rows: RowResponse<T>[];
-}
-export declare type BulkDocsResponse = BulkDocResponse[];
-interface BulkDocResponse {
-    ok: boolean;
-    id: string;
-    rev: string;
-}
-export interface PutResponse {
-    ok: boolean;
-    id: string;
-    rev: string;
-}
-export {};

package/dist/mjs/documents/pouch.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=pouch.js.map

package/dist/mjs/documents/pouch.js.map

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

package/dist/mjs/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./documents";
-export * from "./sdk";
-export * from "./api";

package/dist/mjs/index.js

@@ -1,4 +0,0 @@
-export * from "./documents";
-export * from "./sdk";
-export * from "./api";
-//# sourceMappingURL=index.js.map

package/dist/mjs/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,OAAO,CAAA;AACrB,cAAc,OAAO,CAAA"}

package/dist/mjs/sdk/auditLogs.d.ts

@@ -1,15 +0,0 @@
-import { Event, HostInfo } from "./events";
-import { AuditLogDoc } from "../documents";
-export declare type AuditWriteOpts = {
-    appId?: string;
-    timestamp?: string | number;
-    userId?: string;
-    hostInfo?: HostInfo;
-};
-export declare type AuditLogFn = (event: Event, metadata: any, opts: AuditWriteOpts) => Promise<AuditLogDoc | undefined>;
-export declare type AuditLogQueueEvent = {
-    event: Event;
-    properties: any;
-    opts: AuditWriteOpts;
-    tenantId: string;
-};

package/dist/mjs/sdk/auditLogs.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=auditLogs.js.map

package/dist/mjs/sdk/auditLogs.js.map

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

package/dist/mjs/sdk/auth.d.ts

@@ -1,30 +0,0 @@
-import { BBContext } from "./koa";
-import { Hosting } from "./hosting";
-export interface AuthToken {
-    userId: string;
-    tenantId: string;
-    sessionId: string;
-}
-export interface CreateSession {
-    sessionId: string;
-    tenantId: string;
-    csrfToken?: string;
-    hosting?: Hosting;
-}
-export interface Session extends CreateSession {
-    userId: string;
-    lastAccessedAt: string;
-    createdAt: string;
-    csrfToken: string;
-}
-export interface SessionKey {
-    key: string;
-}
-export interface ScannedSession {
-    value: Session;
-}
-export interface PlatformLogoutOpts {
-    ctx: BBContext;
-    userId: string;
-    keepActiveSession?: boolean;
-}

package/dist/mjs/sdk/auth.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=auth.js.map

package/dist/mjs/sdk/auth.js.map

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

package/dist/mjs/sdk/automations/index.d.ts

@@ -1,13 +0,0 @@
-import { Automation, AutomationMetadata } from "../../documents";
-import { Job } from "bull";
-export interface AutomationDataEvent {
-    appId?: string;
-    metadata?: AutomationMetadata;
-    automation?: Automation;
-    timeout?: number;
-}
-export interface AutomationData {
-    event: AutomationDataEvent;
-    automation: Automation;
-}
-export declare type AutomationJob = Job<AutomationData>;

package/dist/mjs/sdk/automations/index.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=index.js.map

package/dist/mjs/sdk/automations/index.js.map

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

package/dist/mjs/sdk/cli/constants.d.ts

@@ -1,18 +0,0 @@
-import { Event } from "../events";
-export declare enum CommandWord {
-    BACKUPS = "backups",
-    HOSTING = "hosting",
-    ANALYTICS = "analytics",
-    HELP = "help",
-    PLUGIN = "plugins"
-}
-export declare enum InitType {
-    QUICK = "quick",
-    DIGITAL_OCEAN = "do"
-}
-export declare const AnalyticsEvent: {
-    OptOut: string;
-    OptIn: string;
-    SelfHostInit: string;
-    PluginInit: Event;
-};

package/dist/mjs/sdk/cli/constants.js

@@ -1,21 +0,0 @@
-import { Event } from "../events";
-export var CommandWord;
-(function (CommandWord) {
-    CommandWord["BACKUPS"] = "backups";
-    CommandWord["HOSTING"] = "hosting";
-    CommandWord["ANALYTICS"] = "analytics";
-    CommandWord["HELP"] = "help";
-    CommandWord["PLUGIN"] = "plugins";
-})(CommandWord || (CommandWord = {}));
-export var InitType;
-(function (InitType) {
-    InitType["QUICK"] = "quick";
-    InitType["DIGITAL_OCEAN"] = "do";
-})(InitType || (InitType = {}));
-export const AnalyticsEvent = {
-    OptOut: "analytics:opt:out",
-    OptIn: "analytics:opt:in",
-    SelfHostInit: "hosting:init",
-    PluginInit: Event.PLUGIN_INIT,
-};
-//# sourceMappingURL=constants.js.map

package/dist/mjs/sdk/cli/constants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../src/sdk/cli/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,WAAW,CAAA;AAEjC,MAAM,CAAN,IAAY,WAMX;AAND,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,kCAAmB,CAAA;IACnB,sCAAuB,CAAA;IACvB,4BAAa,CAAA;IACb,iCAAkB,CAAA;AACpB,CAAC,EANW,WAAW,KAAX,WAAW,QAMtB;AAED,MAAM,CAAN,IAAY,QAGX;AAHD,WAAY,QAAQ;IAClB,2BAAe,CAAA;IACf,gCAAoB,CAAA;AACtB,CAAC,EAHW,QAAQ,KAAR,QAAQ,QAGnB;AAED,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,MAAM,EAAE,mBAAmB;IAC3B,KAAK,EAAE,kBAAkB;IACzB,YAAY,EAAE,cAAc;IAC5B,UAAU,EAAE,KAAK,CAAC,WAAW;CAC9B,CAAA"}

package/dist/mjs/sdk/cli/index.d.ts

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

package/dist/mjs/sdk/cli/index.js

@@ -1,2 +0,0 @@
-export * from "./constants";
-//# sourceMappingURL=index.js.map

package/dist/mjs/sdk/cli/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/sdk/cli/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA"}

package/dist/mjs/sdk/context.d.ts

@@ -1,18 +0,0 @@
-import { User, Account } from "../documents";
-import { IdentityType, HostInfo } from "./events";
-export interface BaseContext {
-    _id: string;
-    type: IdentityType;
-    tenantId?: string;
-}
-export interface AccountUserContext extends BaseContext {
-    tenantId: string;
-    account: Account;
-}
-export interface UserContext extends BaseContext, User {
-    _id: string;
-    tenantId: string;
-    account?: Account;
-    hostInfo: HostInfo;
-}
-export declare type IdentityContext = BaseContext | AccountUserContext | UserContext;

package/dist/mjs/sdk/context.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=context.js.map

package/dist/mjs/sdk/context.js.map

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

package/dist/mjs/sdk/datasources.d.ts

@@ -1,159 +0,0 @@
-import { Table } from "../documents";
-export declare const PASSWORD_REPLACEMENT = "--secret-value--";
-export declare enum Operation {
-    CREATE = "CREATE",
-    READ = "READ",
-    UPDATE = "UPDATE",
-    DELETE = "DELETE",
-    BULK_CREATE = "BULK_CREATE",
-    CREATE_TABLE = "CREATE_TABLE",
-    UPDATE_TABLE = "UPDATE_TABLE",
-    DELETE_TABLE = "DELETE_TABLE"
-}
-export declare enum SortDirection {
-    ASCENDING = "ASCENDING",
-    DESCENDING = "DESCENDING"
-}
-export declare enum QueryType {
-    SQL = "sql",
-    JSON = "json",
-    FIELDS = "fields"
-}
-export declare enum DatasourceFieldType {
-    STRING = "string",
-    CODE = "code",
-    LONGFORM = "longForm",
-    BOOLEAN = "boolean",
-    NUMBER = "number",
-    PASSWORD = "password",
-    LIST = "list",
-    OBJECT = "object",
-    JSON = "json",
-    FILE = "file",
-    FIELD_GROUP = "fieldGroup",
-    SELECT = "select"
-}
-export declare enum SourceName {
-    POSTGRES = "POSTGRES",
-    DYNAMODB = "DYNAMODB",
-    MONGODB = "MONGODB",
-    ELASTICSEARCH = "ELASTICSEARCH",
-    COUCHDB = "COUCHDB",
-    SQL_SERVER = "SQL_SERVER",
-    S3 = "S3",
-    AIRTABLE = "AIRTABLE",
-    MYSQL = "MYSQL",
-    ARANGODB = "ARANGODB",
-    REST = "REST",
-    ORACLE = "ORACLE",
-    GOOGLE_SHEETS = "GOOGLE_SHEETS",
-    FIRESTORE = "FIRESTORE",
-    REDIS = "REDIS",
-    SNOWFLAKE = "SNOWFLAKE"
-}
-export declare enum IncludeRelationship {
-    INCLUDE = 1,
-    EXCLUDE = 0
-}
-export declare enum FilterType {
-    STRING = "string",
-    FUZZY = "fuzzy",
-    RANGE = "range",
-    EQUAL = "equal",
-    NOT_EQUAL = "notEqual",
-    EMPTY = "empty",
-    NOT_EMPTY = "notEmpty",
-    ONE_OF = "oneOf"
-}
-export declare enum DatasourceFeature {
-    CONNECTION_CHECKING = "connection",
-    FETCH_TABLE_NAMES = "fetch_table_names",
-    EXPORT_SCHEMA = "export_schema"
-}
-export interface StepDefinition {
-    key: string;
-    template: string;
-}
-export interface QueryDefinition {
-    type: QueryType;
-    displayName?: string;
-    readable?: boolean;
-    customisable?: boolean;
-    fields?: object;
-    urlDisplay?: boolean;
-    steps?: Array<StepDefinition>;
-}
-export interface ExtraQueryConfig {
-    [key: string]: {
-        displayName: string;
-        type: string;
-        required: boolean;
-        data?: object;
-    };
-}
-interface DatasourceBasicFieldConfig {
-    type: DatasourceFieldType;
-    display?: string;
-    required?: boolean;
-    default?: any;
-    deprecated?: boolean;
-    hidden?: string;
-}
-interface DatasourceSelectFieldConfig extends DatasourceBasicFieldConfig {
-    type: DatasourceFieldType.SELECT;
-    config: {
-        options: string[];
-    };
-}
-interface DatasourceFieldGroupConfig extends DatasourceBasicFieldConfig {
-    type: DatasourceFieldType.FIELD_GROUP;
-    config: {
-        openByDefault?: boolean;
-        nestedFields?: boolean;
-    };
-}
-declare type DatasourceFieldConfig = DatasourceSelectFieldConfig | DatasourceFieldGroupConfig | DatasourceBasicFieldConfig;
-export interface DatasourceConfig {
-    [key: string]: DatasourceFieldConfig & {
-        fields?: DatasourceConfig;
-    };
-}
-export interface Integration {
-    docs: string;
-    plus?: boolean;
-    auth?: {
-        type: string;
-    };
-    features?: Partial<Record<DatasourceFeature, boolean>>;
-    relationships?: boolean;
-    description: string;
-    friendlyName: string;
-    type?: string;
-    iconUrl?: string;
-    datasource: DatasourceConfig;
-    query: {
-        [key: string]: QueryDefinition;
-    };
-    extra?: ExtraQueryConfig;
-}
-export declare type ConnectionInfo = {
-    connected: boolean;
-    error?: string;
-};
-export interface IntegrationBase {
-    create?(query: any): Promise<any[] | any>;
-    read?(query: any): Promise<any[] | any>;
-    update?(query: any): Promise<any[] | any>;
-    delete?(query: any): Promise<any[] | any>;
-    testConnection?(): Promise<ConnectionInfo>;
-    getExternalSchema?(): Promise<string>;
-}
-export interface DatasourcePlus extends IntegrationBase {
-    tables: Record<string, Table>;
-    schemaErrors: Record<string, string>;
-    getBindingIdentifier(): string;
-    getStringConcat(parts: string[]): string;
-    buildSchema(datasourceId: string, entities: Record<string, Table>): any;
-    getTableNames(): Promise<string[]>;
-}
-export {};