@budibase/types 2.1.40-alpha.0 → 2.1.40

package/src/sdk/context.ts

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

package/src/sdk/db.ts

@@ -1,12 +1,10 @@
 import PouchDB from "pouchdb"
-import Nano from "nano"
-import { AllDocsResponse, AnyDocument, Document } from "../"
 
 export type PouchOptions = {
-  inMemory?: boolean
-  replication?: boolean
-  onDisk?: boolean
-  find?: boolean
+  inMemory: boolean
+  replication: boolean
+  onDisk: boolean
+  find: boolean
 }
 
 export enum SortOption {
@@ -24,73 +22,3 @@ export type CouchFindOptions = {
   skip?: number
   bookmark?: string
 }
-
-export type DatabaseOpts = {
-  skip_setup?: boolean
-}
-
-export type DatabasePutOpts = {
-  force?: boolean
-}
-
-export type DatabaseCreateIndexOpts = {
-  index: {
-    fields: string[]
-    name?: string | undefined
-    ddoc?: string | undefined
-    type?: string | undefined
-  }
-}
-
-export type DatabaseDeleteIndexOpts = {
-  name: string
-  ddoc: string
-  type?: string | undefined
-}
-
-export type DatabaseQueryOpts = {
-  include_docs?: boolean
-  startkey?: string
-  endkey?: string
-  limit?: number
-  skip?: number
-  descending?: boolean
-  key?: string
-  keys?: string[]
-  group?: boolean
-}
-
-export const isDocument = (doc: any): doc is Document => {
-  return typeof doc === "object" && doc._id && doc._rev
-}
-
-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>
-  // these are all PouchDB related functions that are rarely used - in future
-  // should be replaced by better typed/non-pouch implemented methods
-  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/src/sdk/events/role.ts

@@ -3,19 +3,19 @@ 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 {

package/src/sdk/index.ts

@@ -9,5 +9,3 @@ export * from "./koa"
 export * from "./auth"
 export * from "./locks"
 export * from "./db"
-export * from "./middleware"
-export * from "./featureFlag"

package/src/sdk/koa.ts

@@ -1,23 +1,14 @@
 import { Context, Request } from "koa"
-import { User, Role, UserRoles, Account } from "../documents"
-import { FeatureFlag, License } from "../sdk"
+import { User } from "../documents"
+import { License } from "../sdk"
 
-export interface ContextUser extends Omit<User, "roles"> {
+export interface ContextUser extends User {
   globalId?: string
-  license?: License
-  userId?: string
-  roleId?: string | null
-  role?: Role
-  roles?: UserRoles
-  csrfToken?: string
-  featureFlags?: FeatureFlag[]
-  accountPortalAccess?: boolean
-  account?: Account
+  license: License
 }
 
 export interface BBRequest extends Request {
   body: any
-  files?: any
 }
 
 export interface BBContext extends Context {

package/src/sdk/search.ts

@@ -72,7 +72,7 @@ export interface QueryJson {
     operation: Operation
     schema?: string
   }
-  resource?: {
+  resource: {
     fields: string[]
   }
   filters?: SearchFilters
@@ -83,7 +83,7 @@ export interface QueryJson {
   meta?: {
     table?: Table
     tables?: Record<string, Table>
-    renamed?: RenameColumn
+    renamed: RenameColumn
   }
   extra?: {
     idFilter?: SearchFilters

package/tsconfig.build.json

@@ -3,6 +3,7 @@
     "target": "es6",
     "module": "commonjs",
     "lib": ["es2020"],
+    "allowJs": true,
     "strict": true,
     "noImplicitAny": true,
     "esModuleInterop": true,

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

@@ -1,19 +0,0 @@
-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

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

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

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

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

@@ -1,8 +0,0 @@
-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

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

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

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

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

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

package/dist/documents/platform/tenants.js

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

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

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

package/dist/sdk/featureFlag.d.ts

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

package/dist/sdk/featureFlag.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.FeatureFlag = void 0;
-var FeatureFlag;
-(function (FeatureFlag) {
-    FeatureFlag["LICENSING"] = "LICENSING";
-})(FeatureFlag = exports.FeatureFlag || (exports.FeatureFlag = {}));
-//# sourceMappingURL=featureFlag.js.map

package/dist/sdk/featureFlag.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"featureFlag.js","sourceRoot":"","sources":["../../src/sdk/featureFlag.ts"],"names":[],"mappings":";;;AAAA,IAAY,WAEX;AAFD,WAAY,WAAW;IACrB,sCAAuB,CAAA;AACzB,CAAC,EAFW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAEtB"}

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

@@ -1,2 +0,0 @@
-export * from "./matchers";
-export * from "./tenancy";

package/dist/sdk/middleware/index.js

@@ -1,19 +0,0 @@
-"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("./matchers"), exports);
-__exportStar(require("./tenancy"), exports);
-//# sourceMappingURL=index.js.map

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

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

package/dist/sdk/middleware/matchers.d.ts

@@ -1,21 +0,0 @@
-export interface EndpointMatcher {
-    /**
-     * The HTTP Path. e.g. /api/things/:thingId
-     */
-    route: string;
-    /**
-     * The HTTP Verb. e.g. GET, POST, etc.
-     * ALL is also accepted to cover all verbs.
-     */
-    method: string;
-    /**
-     * The route must match exactly - not just begins with
-     */
-    strict?: boolean;
-}
-export interface RegexMatcher {
-    regex: RegExp;
-    method: string;
-    strict: boolean;
-    route: string;
-}

package/dist/sdk/middleware/matchers.js

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

package/dist/sdk/middleware/matchers.js.map

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

package/dist/sdk/middleware/tenancy.d.ts

@@ -1,12 +0,0 @@
-export interface GetTenantIdOptions {
-    allowNoTenant?: boolean;
-    excludeStrategies?: TenantResolutionStrategy[];
-    includeStrategies?: TenantResolutionStrategy[];
-}
-export declare enum TenantResolutionStrategy {
-    USER = "user",
-    HEADER = "header",
-    QUERY = "query",
-    SUBDOMAIN = "subdomain",
-    PATH = "path"
-}

package/dist/sdk/middleware/tenancy.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TenantResolutionStrategy = void 0;
-var TenantResolutionStrategy;
-(function (TenantResolutionStrategy) {
-    TenantResolutionStrategy["USER"] = "user";
-    TenantResolutionStrategy["HEADER"] = "header";
-    TenantResolutionStrategy["QUERY"] = "query";
-    TenantResolutionStrategy["SUBDOMAIN"] = "subdomain";
-    TenantResolutionStrategy["PATH"] = "path";
-})(TenantResolutionStrategy = exports.TenantResolutionStrategy || (exports.TenantResolutionStrategy = {}));
-//# sourceMappingURL=tenancy.js.map

package/dist/sdk/middleware/tenancy.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"tenancy.js","sourceRoot":"","sources":["../../../src/sdk/middleware/tenancy.ts"],"names":[],"mappings":";;;AAMA,IAAY,wBAMX;AAND,WAAY,wBAAwB;IAClC,yCAAa,CAAA;IACb,6CAAiB,CAAA;IACjB,2CAAe,CAAA;IACf,mDAAuB,CAAA;IACvB,yCAAa,CAAA;AACf,CAAC,EANW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAMnC"}

package/src/documents/app/links.ts

@@ -1,21 +0,0 @@
-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/src/documents/global/templates.ts

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

package/src/documents/platform/tenants.ts

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

package/src/sdk/featureFlag.ts

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

package/src/sdk/middleware/index.ts

@@ -1,2 +0,0 @@
-export * from "./matchers"
-export * from "./tenancy"

package/src/sdk/middleware/matchers.ts

@@ -1,22 +0,0 @@
-export interface EndpointMatcher {
-  /**
-   * The HTTP Path. e.g. /api/things/:thingId
-   */
-  route: string
-  /**
-   * The HTTP Verb. e.g. GET, POST, etc.
-   * ALL is also accepted to cover all verbs.
-   */
-  method: string
-  /**
-   * The route must match exactly - not just begins with
-   */
-  strict?: boolean
-}
-
-export interface RegexMatcher {
-  regex: RegExp
-  method: string
-  strict: boolean
-  route: string
-}

package/src/sdk/middleware/tenancy.ts

@@ -1,13 +0,0 @@
-export interface GetTenantIdOptions {
-  allowNoTenant?: boolean
-  excludeStrategies?: TenantResolutionStrategy[]
-  includeStrategies?: TenantResolutionStrategy[]
-}
-
-export enum TenantResolutionStrategy {
-  USER = "user",
-  HEADER = "header",
-  QUERY = "query",
-  SUBDOMAIN = "subdomain",
-  PATH = "path",
-}