@budibase/types 2.8.29-alpha.0 → 2.8.29-alpha.10

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

@@ -1,3 +1,41 @@
+export declare const SEPARATOR = "_";
+export declare const UNICODE_MAX = "\uFFF0";
+export declare const prefixed: (type: DocumentType) => string;
+export declare enum DocumentType {
+    USER = "us",
+    GROUP = "gr",
+    WORKSPACE = "workspace",
+    CONFIG = "config",
+    TEMPLATE = "template",
+    APP = "app",
+    DEV = "dev",
+    APP_DEV = "app_dev",
+    APP_METADATA = "app_metadata",
+    ROLE = "role",
+    MIGRATIONS = "migrations",
+    DEV_INFO = "devinfo",
+    AUTOMATION_LOG = "log_au",
+    ACCOUNT_METADATA = "acc_metadata",
+    PLUGIN = "plg",
+    DATASOURCE = "datasource",
+    DATASOURCE_PLUS = "datasource_plus",
+    APP_BACKUP = "backup",
+    TABLE = "ta",
+    ROW = "ro",
+    AUTOMATION = "au",
+    LINK = "li",
+    WEBHOOK = "wh",
+    INSTANCE = "inst",
+    LAYOUT = "layout",
+    SCREEN = "screen",
+    QUERY = "query",
+    DEPLOYMENTS = "deployments",
+    METADATA = "metadata",
+    MEM_VIEW = "view",
+    USER_FLAG = "flag",
+    AUTOMATION_METADATA = "meta_au",
+    AUDIT_LOG = "al"
+}
 export interface Document {
     _id?: string;
     _rev?: string;

package/dist/mjs/documents/document.js

@@ -1,2 +1,40 @@
-export {};
+export const SEPARATOR = "_";
+export const UNICODE_MAX = "\ufff0";
+export const prefixed = (type) => `${type}${SEPARATOR}`;
+export var DocumentType;
+(function (DocumentType) {
+    DocumentType["USER"] = "us";
+    DocumentType["GROUP"] = "gr";
+    DocumentType["WORKSPACE"] = "workspace";
+    DocumentType["CONFIG"] = "config";
+    DocumentType["TEMPLATE"] = "template";
+    DocumentType["APP"] = "app";
+    DocumentType["DEV"] = "dev";
+    DocumentType["APP_DEV"] = "app_dev";
+    DocumentType["APP_METADATA"] = "app_metadata";
+    DocumentType["ROLE"] = "role";
+    DocumentType["MIGRATIONS"] = "migrations";
+    DocumentType["DEV_INFO"] = "devinfo";
+    DocumentType["AUTOMATION_LOG"] = "log_au";
+    DocumentType["ACCOUNT_METADATA"] = "acc_metadata";
+    DocumentType["PLUGIN"] = "plg";
+    DocumentType["DATASOURCE"] = "datasource";
+    DocumentType["DATASOURCE_PLUS"] = "datasource_plus";
+    DocumentType["APP_BACKUP"] = "backup";
+    DocumentType["TABLE"] = "ta";
+    DocumentType["ROW"] = "ro";
+    DocumentType["AUTOMATION"] = "au";
+    DocumentType["LINK"] = "li";
+    DocumentType["WEBHOOK"] = "wh";
+    DocumentType["INSTANCE"] = "inst";
+    DocumentType["LAYOUT"] = "layout";
+    DocumentType["SCREEN"] = "screen";
+    DocumentType["QUERY"] = "query";
+    DocumentType["DEPLOYMENTS"] = "deployments";
+    DocumentType["METADATA"] = "metadata";
+    DocumentType["MEM_VIEW"] = "view";
+    DocumentType["USER_FLAG"] = "flag";
+    DocumentType["AUTOMATION_METADATA"] = "meta_au";
+    DocumentType["AUDIT_LOG"] = "al";
+})(DocumentType || (DocumentType = {}));
 //# sourceMappingURL=document.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/documents/document.ts"],"names":[],"mappings":""}
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../src/documents/document.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,SAAS,GAAG,GAAG,CAAA;AAC5B,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAA;AAEnC,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,IAAkB,EAAE,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,EAAE,CAAA;AAErE,MAAM,CAAN,IAAY,YAkCX;AAlCD,WAAY,YAAY;IACtB,2BAAW,CAAA;IACX,4BAAY,CAAA;IACZ,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;IACjB,qCAAqB,CAAA;IACrB,2BAAW,CAAA;IACX,2BAAW,CAAA;IACX,mCAAmB,CAAA;IACnB,6CAA6B,CAAA;IAC7B,6BAAa,CAAA;IACb,yCAAyB,CAAA;IACzB,oCAAoB,CAAA;IACpB,yCAAyB,CAAA;IACzB,iDAAiC,CAAA;IACjC,8BAAc,CAAA;IACd,yCAAyB,CAAA;IACzB,mDAAmC,CAAA;IACnC,qCAAqB,CAAA;IACrB,4BAAY,CAAA;IACZ,0BAAU,CAAA;IACV,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,8BAAc,CAAA;IACd,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,iCAAiB,CAAA;IACjB,+BAAe,CAAA;IACf,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;IACrB,iCAAiB,CAAA;IACjB,kCAAkB,CAAA;IAClB,+CAA+B,CAAA;IAC/B,gCAAgB,CAAA;AAClB,CAAC,EAlCW,YAAY,KAAZ,YAAY,QAkCvB"}

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

@@ -29,7 +29,8 @@ export interface User extends Document {
     forceResetPassword?: boolean;
     roles: UserRoles;
     builder?: {
-        global: boolean;
+        global?: boolean;
+        apps?: string[];
     };
     admin?: {
         global: boolean;
@@ -53,7 +54,8 @@ export interface UserRoles {
 }
 export interface BuilderUser extends User {
     builder: {
-        global: boolean;
+        global?: boolean;
+        apps?: string[];
     };
 }
 export interface AdminUser extends User {
@@ -64,4 +66,9 @@ export interface AdminUser extends User {
         global: boolean;
     };
 }
+export interface AdminOnlyUser extends User {
+    admin: {
+        global: boolean;
+    };
+}
 export declare function isUser(user: object): user is User;

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

@@ -1 +1 @@
-{"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"}
+{"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;AA6BD,MAAM,CAAN,IAAY,UAGX;AAHD,WAAY,UAAU;IACpB,+BAAiB,CAAA;IACjB,mCAAqB,CAAA;AACvB,CAAC,EAHW,UAAU,KAAV,UAAU,QAGrB;AA8BD,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,OAAO,CAAC,CAAE,IAAa,CAAC,KAAK,CAAA;AAC/B,CAAC"}

package/dist/mjs/index.d.ts

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

package/dist/mjs/index.js

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

package/dist/mjs/index.js.map

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

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

@@ -18,3 +18,4 @@ export * from "./sso";
 export * from "./user";
 export * from "./cli";
 export * from "./websocket";
+export * from "./permissions";

package/dist/mjs/sdk/index.js

@@ -18,4 +18,5 @@ export * from "./sso";
 export * from "./user";
 export * from "./cli";
 export * from "./websocket";
+export * from "./permissions";
 //# sourceMappingURL=index.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,MAAM,CAAA;AACpB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,OAAO,CAAA;AACrB,cAAc,aAAa,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/sdk/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,WAAW,CAAA;AACzB,cAAc,WAAW,CAAA;AACzB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,SAAS,CAAA;AACvB,cAAc,MAAM,CAAA;AACpB,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,cAAc,aAAa,CAAA;AAC3B,cAAc,OAAO,CAAA;AACrB,cAAc,QAAQ,CAAA;AACtB,cAAc,OAAO,CAAA;AACrB,cAAc,aAAa,CAAA;AAC3B,cAAc,eAAe,CAAA"}

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

@@ -33,6 +33,7 @@ export interface Ctx<RequestBody = any, ResponseBody = any> extends Context {
  */
 export interface UserCtx<RequestBody = any, ResponseBody = any> extends Ctx<RequestBody, ResponseBody> {
     user: ContextUser;
+    roleId?: string;
 }
 /**
  * @deprecated: Use UserCtx / Ctx appropriately

package/dist/mjs/sdk/licensing/feature.d.ts

@@ -8,6 +8,7 @@ export declare enum Feature {
     BRANDING = "branding",
     SCIM = "scim",
     SYNC_AUTOMATIONS = "syncAutomations",
+    APP_BUILDERS = "appBuilders",
     OFFLINE = "offline"
 }
 export declare type PlanFeatures = {

package/dist/mjs/sdk/licensing/feature.js

@@ -8,6 +8,7 @@ export var Feature;
     Feature["BRANDING"] = "branding";
     Feature["SCIM"] = "scim";
     Feature["SYNC_AUTOMATIONS"] = "syncAutomations";
+    Feature["APP_BUILDERS"] = "appBuilders";
     Feature["OFFLINE"] = "offline";
 })(Feature || (Feature = {}));
 //# sourceMappingURL=feature.js.map

package/dist/mjs/sdk/licensing/feature.js.map

@@ -1 +1 @@
-{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/feature.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,OAUX;AAVD,WAAY,OAAO;IACjB,qCAA0B,CAAA;IAC1B,qCAA0B,CAAA;IAC1B,yDAA8C,CAAA;IAC9C,mCAAwB,CAAA;IACxB,6CAAkC,CAAA;IAClC,gCAAqB,CAAA;IACrB,wBAAa,CAAA;IACb,+CAAoC,CAAA;IACpC,8BAAmB,CAAA;AACrB,CAAC,EAVW,OAAO,KAAP,OAAO,QAUlB"}
+{"version":3,"file":"feature.js","sourceRoot":"","sources":["../../../../src/sdk/licensing/feature.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,OAWX;AAXD,WAAY,OAAO;IACjB,qCAA0B,CAAA;IAC1B,qCAA0B,CAAA;IAC1B,yDAA8C,CAAA;IAC9C,mCAAwB,CAAA;IACxB,6CAAkC,CAAA;IAClC,gCAAqB,CAAA;IACrB,wBAAa,CAAA;IACb,+CAAoC,CAAA;IACpC,uCAA4B,CAAA;IAC5B,8BAAmB,CAAA;AACrB,CAAC,EAXW,OAAO,KAAP,OAAO,QAWlB"}

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

@@ -0,0 +1,17 @@
+export declare enum PermissionLevel {
+    READ = "read",
+    WRITE = "write",
+    EXECUTE = "execute",
+    ADMIN = "admin"
+}
+export declare enum PermissionType {
+    APP = "app",
+    TABLE = "table",
+    USER = "user",
+    AUTOMATION = "automation",
+    WEBHOOK = "webhook",
+    BUILDER = "builder",
+    GLOBAL_BUILDER = "globalBuilder",
+    VIEW = "view",
+    QUERY = "query"
+}

package/dist/mjs/sdk/permissions.js

@@ -0,0 +1,21 @@
+export var PermissionLevel;
+(function (PermissionLevel) {
+    PermissionLevel["READ"] = "read";
+    PermissionLevel["WRITE"] = "write";
+    PermissionLevel["EXECUTE"] = "execute";
+    PermissionLevel["ADMIN"] = "admin";
+})(PermissionLevel || (PermissionLevel = {}));
+// these are the global types, that govern the underlying default behaviour
+export var PermissionType;
+(function (PermissionType) {
+    PermissionType["APP"] = "app";
+    PermissionType["TABLE"] = "table";
+    PermissionType["USER"] = "user";
+    PermissionType["AUTOMATION"] = "automation";
+    PermissionType["WEBHOOK"] = "webhook";
+    PermissionType["BUILDER"] = "builder";
+    PermissionType["GLOBAL_BUILDER"] = "globalBuilder";
+    PermissionType["VIEW"] = "view";
+    PermissionType["QUERY"] = "query";
+})(PermissionType || (PermissionType = {}));
+//# sourceMappingURL=permissions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../../src/sdk/permissions.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,eAKX;AALD,WAAY,eAAe;IACzB,gCAAa,CAAA;IACb,kCAAe,CAAA;IACf,sCAAmB,CAAA;IACnB,kCAAe,CAAA;AACjB,CAAC,EALW,eAAe,KAAf,eAAe,QAK1B;AAED,2EAA2E;AAC3E,MAAM,CAAN,IAAY,cAUX;AAVD,WAAY,cAAc;IACxB,6BAAW,CAAA;IACX,iCAAe,CAAA;IACf,+BAAa,CAAA;IACb,2CAAyB,CAAA;IACzB,qCAAmB,CAAA;IACnB,qCAAmB,CAAA;IACnB,kDAAgC,CAAA;IAChC,+BAAa,CAAA;IACb,iCAAe,CAAA;AACjB,CAAC,EAVW,cAAc,KAAd,cAAc,QAUzB"}

package/dist/mjs/shared/typeUtils.d.ts

@@ -2,3 +2,6 @@ export declare type DeepPartial<T> = {
     [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 export declare type ISO8601 = string;
+export declare type RequiredKeys<T> = {
+    [K in keyof Required<T>]: T[K];
+};