@budibase/types 2.1.39 → 2.1.40-alpha.0

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

@@ -55,3 +55,8 @@ export interface SearchUsersRequest {
     appId?: string;
     userIds?: string[];
 }
+export interface CreateAdminUserRequest {
+    email: string;
+    password: string;
+    tenantId: string;
+}

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

@@ -1,4 +1,4 @@
-import { Document } from "../document";
+import { User, Document } from "../";
 export declare type AppMetadataErrors = {
     [key: string]: string[];
 };
@@ -16,6 +16,7 @@ export interface App extends Document {
     theme?: string;
     customTheme?: AppCustomTheme;
     revertableVersion?: string;
+    lockedBy?: User;
     navigation?: AppNavigation;
     automationErrors?: AppMetadataErrors;
     icon?: AppIcon;

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

@@ -1,4 +1,6 @@
+/// <reference types="node" />
 import { Document } from "../document";
+import { EventEmitter } from "events";
 export declare enum AutomationTriggerStepId {
     ROW_SAVED = "ROW_SAVED",
     ROW_UPDATED = "ROW_UPDATED",
@@ -12,6 +14,7 @@ export declare enum AutomationActionStepId {
     CREATE_ROW = "CREATE_ROW",
     UPDATE_ROW = "UPDATE_ROW",
     DELETE_ROW = "DELETE_ROW",
+    EXECUTE_BASH = "EXECUTE_BASH",
     OUTGOING_WEBHOOK = "OUTGOING_WEBHOOK",
     EXECUTE_SCRIPT = "EXECUTE_SCRIPT",
     EXECUTE_QUERY = "EXECUTE_QUERY",
@@ -31,10 +34,17 @@ export interface Automation extends Document {
         trigger: AutomationTrigger;
     };
     appId: string;
+    live?: boolean;
     name: string;
 }
-export interface AutomationStep {
-    id: string;
+export interface AutomationStepSchema {
+    name: string;
+    tagline: string;
+    icon: string;
+    description: string;
+    type: string;
+    internal?: boolean;
+    deprecated?: boolean;
     stepId: AutomationTriggerStepId | AutomationActionStepId;
     inputs: {
         [key: string]: any;
@@ -46,11 +56,19 @@ export interface AutomationStep {
         outputs: {
             [key: string]: any;
         };
+        required?: string[];
     };
 }
-export interface AutomationTrigger extends AutomationStep {
+export interface AutomationStep extends AutomationStepSchema {
+    id: string;
+}
+export interface AutomationTriggerSchema extends AutomationStepSchema {
+    event?: string;
     cronJobId?: string;
 }
+export interface AutomationTrigger extends AutomationTriggerSchema {
+    id: string;
+}
 export declare enum AutomationStatus {
     SUCCESS = "success",
     ERROR = "error",
@@ -80,3 +98,10 @@ export interface AutomationLogPage {
     hasNextPage: boolean;
     nextPage?: string;
 }
+export declare type AutomationStepInput = {
+    inputs: Record<string, any>;
+    context: Record<string, any>;
+    emitter: EventEmitter;
+    appId: string;
+    apiKey?: string;
+};

package/dist/documents/app/automation.js

@@ -16,6 +16,7 @@ var AutomationActionStepId;
     AutomationActionStepId["CREATE_ROW"] = "CREATE_ROW";
     AutomationActionStepId["UPDATE_ROW"] = "UPDATE_ROW";
     AutomationActionStepId["DELETE_ROW"] = "DELETE_ROW";
+    AutomationActionStepId["EXECUTE_BASH"] = "EXECUTE_BASH";
     AutomationActionStepId["OUTGOING_WEBHOOK"] = "OUTGOING_WEBHOOK";
     AutomationActionStepId["EXECUTE_SCRIPT"] = "EXECUTE_SCRIPT";
     AutomationActionStepId["EXECUTE_QUERY"] = "EXECUTE_QUERY";

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

@@ -1 +1 @@
-{"version":3,"file":"automation.js","sourceRoot":"","sources":["../../../src/documents/app/automation.ts"],"names":[],"mappings":";;;AAEA,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sDAA2B,CAAA;IAC3B,sDAA2B,CAAA;IAC3B,8CAAmB,CAAA;IACnB,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED,IAAY,sBAkBX;AAlBD,WAAY,sBAAsB;IAChC,6DAAmC,CAAA;IACnC,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,+DAAqC,CAAA;IACrC,2DAAiC,CAAA;IACjC,yDAA+B,CAAA;IAC/B,mDAAyB,CAAA;IACzB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;IACzB,uCAAa,CAAA;IACb,qEAAqE;IACrE,6CAAmB,CAAA;IACnB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;AAC3B,CAAC,EAlBW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAkBjC;AA+BD,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,mDAA+B,CAAA;AACjC,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B"}
+{"version":3,"file":"automation.js","sourceRoot":"","sources":["../../../src/documents/app/automation.ts"],"names":[],"mappings":";;;AAGA,IAAY,uBAOX;AAPD,WAAY,uBAAuB;IACjC,kDAAuB,CAAA;IACvB,sDAA2B,CAAA;IAC3B,sDAA2B,CAAA;IAC3B,8CAAmB,CAAA;IACnB,sCAAW,CAAA;IACX,wCAAa,CAAA;AACf,CAAC,EAPW,uBAAuB,GAAvB,+BAAuB,KAAvB,+BAAuB,QAOlC;AAED,IAAY,sBAmBX;AAnBD,WAAY,sBAAsB;IAChC,6DAAmC,CAAA;IACnC,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,mDAAyB,CAAA;IACzB,uDAA6B,CAAA;IAC7B,+DAAqC,CAAA;IACrC,2DAAiC,CAAA;IACjC,yDAA+B,CAAA;IAC/B,mDAAyB,CAAA;IACzB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;IACzB,uCAAa,CAAA;IACb,qEAAqE;IACrE,6CAAmB,CAAA;IACnB,yCAAe,CAAA;IACf,2CAAiB,CAAA;IACjB,mDAAyB,CAAA;AAC3B,CAAC,EAnBW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAmBjC;AAgDD,IAAY,gBAKX;AALD,WAAY,gBAAgB;IAC1B,uCAAmB,CAAA;IACnB,mCAAe,CAAA;IACf,uCAAmB,CAAA;IACnB,mDAA+B,CAAA;AACjC,CAAC,EALW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAK3B"}

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

@@ -34,6 +34,7 @@ export interface AppBackupMetadata {
     contents?: AppBackupContents;
 }
 export interface AppBackup extends Document, AppBackupMetadata {
+    _id: string;
     filename?: string;
 }
 export declare type AppBackupFetchOpts = {

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

@@ -12,3 +12,4 @@ export * from "./row";
 export * from "./user";
 export * from "./backup";
 export * from "./webhook";
+export * from "./links";

package/dist/documents/app/index.js

@@ -28,4 +28,5 @@ __exportStar(require("./row"), exports);
 __exportStar(require("./user"), exports);
 __exportStar(require("./backup"), exports);
 __exportStar(require("./webhook"), exports);
+__exportStar(require("./links"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,+CAA4B;AAC5B,+CAA4B;AAC5B,2CAAwB;AACxB,0CAAuB;AACvB,yCAAsB;AACtB,0CAAuB;AACvB,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,wCAAqB;AACrB,yCAAsB;AACtB,2CAAwB;AACxB,4CAAyB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/app/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wCAAqB;AACrB,+CAA4B;AAC5B,+CAA4B;AAC5B,2CAAwB;AACxB,0CAAuB;AACvB,yCAAsB;AACtB,0CAAuB;AACvB,2CAAwB;AACxB,yCAAsB;AACtB,8CAA2B;AAC3B,wCAAqB;AACrB,yCAAsB;AACtB,2CAAwB;AACxB,4CAAyB;AACzB,0CAAuB"}

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

@@ -0,0 +1,19 @@
+import { Document } from "../document";
+export interface LinkDocument extends Document {
+    type: string;
+    doc1: {
+        rowId: string;
+        fieldName: string;
+        tableId: string;
+    };
+    doc2: {
+        rowId: string;
+        fieldName: string;
+        tableId: string;
+    };
+}
+export interface LinkDocumentValue {
+    id: string;
+    thisId: string;
+    fieldName: string;
+}

package/dist/documents/app/links.js

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

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

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

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

@@ -1,7 +1,7 @@
 import { Document } from "../document";
 export interface Role extends Document {
     permissionId: string;
-    inherits: string;
+    inherits?: string;
     permissions: {
         [key: string]: string[];
     };

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

@@ -12,14 +12,15 @@ export interface ScreenProps extends Document {
     vAlign?: string;
     hAlign?: string;
 }
+export interface ScreenRouting {
+    route: string;
+    roleId: string;
+    homeScreen?: boolean;
+}
 export interface Screen extends Document {
     layoutId?: string;
     showNavigation?: boolean;
     width?: string;
-    routing: {
-        route: string;
-        roleId: string;
-        homeScreen?: boolean;
-    };
+    routing: ScreenRouting;
     props: ScreenProps;
 }

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

@@ -1,14 +1,17 @@
 import { Document } from "../document";
 import { View } from "./view";
+import { RenameColumn } from "../../sdk";
 export interface FieldSchema {
     type: string;
     externalType?: string;
     fieldName?: string;
     name: string;
+    sortable?: boolean;
     tableId?: string;
     relationshipType?: string;
     through?: string;
     foreignKey?: string;
+    icon?: string;
     autocolumn?: boolean;
     subtype?: string;
     throughFrom?: string;
@@ -17,6 +20,9 @@ export interface FieldSchema {
     formulaType?: string;
     main?: boolean;
     ignoreTimezones?: boolean;
+    timeOnly?: boolean;
+    lastID?: number;
+    useRichText?: boolean | null;
     meta?: {
         toTable: string;
         toKey: string;
@@ -26,10 +32,20 @@ export interface FieldSchema {
         email?: boolean;
         inclusion?: string[];
         length?: {
-            minimum?: string | number;
-            maximum?: string | number;
+            minimum?: string | number | null;
+            maximum?: string | number | null;
+        };
+        numericality?: {
+            greaterThanOrEqualTo: string | null;
+            lessThanOrEqualTo: string | null;
+        };
+        presence?: boolean | {
+            allowEmpty?: boolean;
+        };
+        datetime?: {
+            latest: string;
+            earliest: string;
         };
-        presence?: boolean;
     };
 }
 export interface TableSchema {
@@ -55,3 +71,7 @@ export interface Table extends Document {
         [key: string]: any;
     };
 }
+export interface TableRequest extends Table {
+    _rename?: RenameColumn;
+    created?: boolean;
+}

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

@@ -5,6 +5,9 @@ export interface View {
     filters: ViewFilter[];
     schema: ViewSchema;
     calculation?: ViewCalculation;
+    map?: string;
+    reduce?: any;
+    meta?: Record<string, any>;
 }
 export declare type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema;
 export interface ViewCountOrSumSchema {
@@ -26,7 +29,7 @@ export interface ViewStatisticsSchema {
     };
 }
 export interface ViewFilter {
-    value: any;
+    value?: any;
     condition: string;
     key: string;
     conjunction?: string;

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

@@ -1 +1 @@
-{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/documents/app/view.ts"],"names":[],"mappings":";;;AAsCA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/documents/app/view.ts"],"names":[],"mappings":";;;AAyCA,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAI1B"}

package/dist/documents/document.d.ts

@@ -4,3 +4,6 @@ export interface Document {
     createdAt?: string | number;
     updatedAt?: string;
 }
+export interface AnyDocument extends Document {
+    [key: string]: any;
+}

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

@@ -26,17 +26,27 @@ export interface GoogleConfig extends Config {
         activated: boolean;
     };
 }
+export interface OIDCConfiguration {
+    issuer: string;
+    authorizationURL: string;
+    tokenURL: string;
+    userInfoURL: string;
+    clientID: string;
+    clientSecret: string;
+    callbackURL: string;
+}
+export interface OIDCInnerCfg {
+    configUrl: string;
+    clientID: string;
+    clientSecret: string;
+    logo: string;
+    name: string;
+    uuid: string;
+    activated: boolean;
+}
 export interface OIDCConfig extends Config {
     config: {
-        configs: {
-            configUrl: string;
-            clientID: string;
-            clientSecret: string;
-            logo: string;
-            name: string;
-            uuid: string;
-            activated: boolean;
-        }[];
+        configs: OIDCInnerCfg[];
     };
 }
 export declare type NestedConfig = SMTPConfig | SettingsConfig | GoogleConfig | OIDCConfig;
@@ -46,7 +56,9 @@ export declare const isGoogleConfig: (config: Config) => config is GoogleConfig;
 export declare const isOIDCConfig: (config: Config) => config is OIDCConfig;
 export declare enum ConfigType {
     SETTINGS = "settings",
+    ACCOUNT = "account",
     SMTP = "smtp",
     GOOGLE = "google",
-    OIDC = "oidc"
+    OIDC = "oidc",
+    OIDC_LOGOS = "logos_oidc"
 }

package/dist/documents/global/config.js

@@ -12,8 +12,10 @@ exports.isOIDCConfig = isOIDCConfig;
 var ConfigType;
 (function (ConfigType) {
     ConfigType["SETTINGS"] = "settings";
+    ConfigType["ACCOUNT"] = "account";
     ConfigType["SMTP"] = "smtp";
     ConfigType["GOOGLE"] = "google";
     ConfigType["OIDC"] = "oidc";
+    ConfigType["OIDC_LOGOS"] = "logos_oidc";
 })(ConfigType = exports.ConfigType || (exports.ConfigType = {}));
 //# sourceMappingURL=config.js.map

package/dist/documents/global/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/documents/global/config.ts"],"names":[],"mappings":";;;AAqDO,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE,CAC3E,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAA;AADxB,QAAA,gBAAgB,oBACQ;AAC9B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAC1B,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE,CACvE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAA;AADtB,QAAA,cAAc,kBACQ;AAC5B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAEjC,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2BAAa,CAAA;AACf,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../src/documents/global/config.ts"],"names":[],"mappings":";;;AAiEO,MAAM,gBAAgB,GAAG,CAAC,MAAc,EAA4B,EAAE,CAC3E,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,QAAQ,CAAA;AADxB,QAAA,gBAAgB,oBACQ;AAC9B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAC1B,MAAM,cAAc,GAAG,CAAC,MAAc,EAA0B,EAAE,CACvE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,MAAM,CAAA;AADtB,QAAA,cAAc,kBACQ;AAC5B,MAAM,YAAY,GAAG,CAAC,MAAc,EAAwB,EAAE,CACnE,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,IAAI,CAAA;AADpB,QAAA,YAAY,gBACQ;AAEjC,IAAY,UAOX;AAPD,WAAY,UAAU;IACpB,mCAAqB,CAAA;IACrB,iCAAmB,CAAA;IACnB,2BAAa,CAAA;IACb,+BAAiB,CAAA;IACjB,2BAAa,CAAA;IACb,uCAAyB,CAAA;AAC3B,CAAC,EAPW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAOrB"}

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

@@ -4,3 +4,4 @@ export * from "./userGroup";
 export * from "./plugin";
 export * from "./quotas";
 export * from "./schedule";
+export * from "./templates";

package/dist/documents/global/index.js

@@ -20,4 +20,5 @@ __exportStar(require("./userGroup"), exports);
 __exportStar(require("./plugin"), exports);
 __exportStar(require("./quotas"), exports);
 __exportStar(require("./schedule"), exports);
+__exportStar(require("./templates"), exports);
 //# sourceMappingURL=index.js.map

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

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

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

@@ -0,0 +1,8 @@
+import { Document } from "../document";
+export interface Template extends Document {
+    ownerId?: string;
+    name?: string;
+    contents: string;
+    purpose: string;
+    type?: string;
+}

package/dist/documents/global/templates.js

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

package/dist/documents/global/templates.js.map

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

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

@@ -1,7 +1,34 @@
 import { Document } from "../document";
-export interface User extends Document {
+export interface SSOProfile {
+    id: string;
+    name?: {
+        givenName?: string;
+        familyName?: string;
+    };
+    _json: {
+        email: string;
+        picture: string;
+    };
+    provider?: string;
+}
+export interface ThirdPartyUser extends Document {
+    thirdPartyProfile?: SSOProfile["_json"];
+    firstName?: string;
+    lastName?: string;
+    pictureUrl?: string;
+    profile?: SSOProfile;
+    oauth2?: any;
+    provider?: string;
+    providerType?: string;
+    email: string;
+    userId?: string;
+    forceResetPassword?: boolean;
+}
+export interface User extends ThirdPartyUser {
     tenantId: string;
     email: string;
+    userId?: string;
+    forceResetPassword?: boolean;
     roles: UserRoles;
     builder?: {
         global: boolean;
@@ -9,13 +36,14 @@ export interface User extends Document {
     admin?: {
         global: boolean;
     };
-    providerType?: string;
     password?: string;
     status?: string;
     createdAt?: number;
     userGroups?: string[];
-    forceResetPassword?: boolean;
     dayPassRecordedAt?: string;
+    account?: {
+        authType: string;
+    };
 }
 export interface UserRoles {
     [key: string]: string;

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

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

package/dist/documents/platform/index.js

@@ -17,4 +17,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./info"), exports);
 __exportStar(require("./users"), exports);
 __exportStar(require("./accounts"), exports);
+__exportStar(require("./tenants"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,0CAAuB;AACvB,6CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/documents/platform/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,yCAAsB;AACtB,0CAAuB;AACvB,6CAA0B;AAC1B,4CAAyB"}

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

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

package/dist/documents/platform/tenants.js

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

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

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

package/dist/documents/pouch.d.ts

@@ -6,8 +6,8 @@ export interface RowResponse<T> {
     id: string;
     key: string;
     error: string;
-    value: RowValue;
-    doc: T;
+    value: T | RowValue;
+    doc?: T | any;
 }
 export interface AllDocsResponse<T> {
     offset: number;
@@ -20,4 +20,9 @@ interface BulkDocResponse {
     id: string;
     rev: string;
 }
+export interface PutResponse {
+    ok: boolean;
+    id: string;
+    rev: string;
+}
 export {};

package/dist/sdk/auth.d.ts

@@ -1,3 +1,5 @@
+import { BBContext } from "./koa";
+import { Hosting } from "./hosting";
 export interface AuthToken {
     userId: string;
     tenantId: string;
@@ -7,6 +9,7 @@ export interface CreateSession {
     sessionId: string;
     tenantId: string;
     csrfToken?: string;
+    hosting?: Hosting;
 }
 export interface Session extends CreateSession {
     userId: string;
@@ -20,3 +23,8 @@ export interface SessionKey {
 export interface ScannedSession {
     value: Session;
 }
+export interface PlatformLogoutOpts {
+    ctx: BBContext;
+    userId: string;
+    keepActiveSession?: boolean;
+}

package/dist/sdk/context.d.ts

@@ -1,5 +1,5 @@
 import { User, Account } from "../documents";
-import { IdentityType } from "./events/identification";
+import { IdentityType } from "./events";
 export interface BaseContext {
     _id: string;
     type: IdentityType;

package/dist/sdk/db.d.ts

@@ -1,9 +1,11 @@
 /// <reference types="pouchdb-find" />
+import Nano from "nano";
+import { AllDocsResponse, AnyDocument, Document } from "../";
 export declare type PouchOptions = {
-    inMemory: boolean;
-    replication: boolean;
-    onDisk: boolean;
-    find: boolean;
+    inMemory?: boolean;
+    replication?: boolean;
+    onDisk?: boolean;
+    find?: boolean;
 };
 export declare enum SortOption {
     ASCENDING = "asc",
@@ -19,3 +21,52 @@ export declare type CouchFindOptions = {
     skip?: number;
     bookmark?: string;
 };
+export declare type DatabaseOpts = {
+    skip_setup?: boolean;
+};
+export declare type DatabasePutOpts = {
+    force?: boolean;
+};
+export declare type DatabaseCreateIndexOpts = {
+    index: {
+        fields: string[];
+        name?: string | undefined;
+        ddoc?: string | undefined;
+        type?: string | undefined;
+    };
+};
+export declare type DatabaseDeleteIndexOpts = {
+    name: string;
+    ddoc: string;
+    type?: string | undefined;
+};
+export declare type DatabaseQueryOpts = {
+    include_docs?: boolean;
+    startkey?: string;
+    endkey?: string;
+    limit?: number;
+    skip?: number;
+    descending?: boolean;
+    key?: string;
+    keys?: string[];
+    group?: boolean;
+};
+export declare const isDocument: (doc: any) => doc is Document;
+export interface Database {
+    name: string;
+    exists(): Promise<boolean>;
+    checkSetup(): Promise<Nano.DocumentScope<any>>;
+    get<T>(id?: string): Promise<T | any>;
+    remove(id: string | Document, rev?: string): Promise<Nano.DocumentDestroyResponse>;
+    put(document: AnyDocument, opts?: DatabasePutOpts): Promise<Nano.DocumentInsertResponse>;
+    bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>;
+    allDocs<T>(params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>;
+    query<T>(viewName: string, params: DatabaseQueryOpts): Promise<AllDocsResponse<T>>;
+    destroy(): Promise<Nano.OkResponse | void>;
+    compact(): Promise<Nano.OkResponse | void>;
+    dump(...args: any[]): Promise<any>;
+    load(...args: any[]): Promise<any>;
+    createIndex(...args: any[]): Promise<any>;
+    deleteIndex(...args: any[]): Promise<any>;
+    getIndexes(...args: any[]): Promise<any>;
+}

package/dist/sdk/db.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SortOption = void 0;
+exports.isDocument = exports.SortOption = void 0;
 var SortOption;
 (function (SortOption) {
     SortOption["ASCENDING"] = "asc";
     SortOption["DESCENDING"] = "desc";
 })(SortOption = exports.SortOption || (exports.SortOption = {}));
+const isDocument = (doc) => {
+    return typeof doc === "object" && doc._id && doc._rev;
+};
+exports.isDocument = isDocument;
 //# sourceMappingURL=db.js.map

package/dist/sdk/db.js.map

@@ -1 +1 @@
-{"version":3,"file":"db.js","sourceRoot":"","sources":["../../src/sdk/db.ts"],"names":[],"mappings":";;;AASA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB"}
+{"version":3,"file":"db.js","sourceRoot":"","sources":["../../src/sdk/db.ts"],"names":[],"mappings":";;;AAWA,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,iCAAmB,CAAA;AACrB,CAAC,EAHW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAGrB;AAgDM,MAAM,UAAU,GAAG,CAAC,GAAQ,EAAmB,EAAE;IACtD,OAAO,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,CAAA;AACvD,CAAC,CAAA;AAFY,QAAA,UAAU,cAEtB"}

package/dist/sdk/events/role.d.ts

@@ -2,17 +2,17 @@ import { BaseEvent } from "./event";
 export interface RoleCreatedEvent extends BaseEvent {
     roleId: string;
     permissionId: string;
-    inherits: string;
+    inherits?: string;
 }
 export interface RoleUpdatedEvent extends BaseEvent {
     roleId: string;
     permissionId: string;
-    inherits: string;
+    inherits?: string;
 }
 export interface RoleDeletedEvent extends BaseEvent {
     roleId: string;
     permissionId: string;
-    inherits: string;
+    inherits?: string;
 }
 export interface RoleAssignedEvent extends BaseEvent {
     userId: string;

package/dist/sdk/featureFlag.d.ts

@@ -0,0 +1,6 @@
+export declare enum FeatureFlag {
+    LICENSING = "LICENSING"
+}
+export interface TenantFeatureFlags {
+    [key: string]: FeatureFlag[];
+}