@budibase/types 2.8.26 → 2.8.27-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (104) hide show
  1. package/dist/cjs/api/account/accounts.d.ts +6 -0
  2. package/dist/cjs/api/web/app/index.d.ts +4 -0
  3. package/dist/cjs/api/web/app/index.js +4 -0
  4. package/dist/cjs/api/web/app/index.js.map +1 -1
  5. package/dist/cjs/api/web/app/row.d.ts +8 -0
  6. package/dist/cjs/api/web/app/row.js +3 -0
  7. package/dist/cjs/api/web/app/row.js.map +1 -0
  8. package/dist/cjs/api/web/app/rows.d.ts +3 -0
  9. package/dist/cjs/api/web/app/rows.js +3 -0
  10. package/dist/cjs/api/web/app/rows.js.map +1 -0
  11. package/dist/cjs/api/web/app/table.d.ts +12 -0
  12. package/dist/cjs/api/web/app/table.js +3 -0
  13. package/dist/cjs/api/web/app/table.js.map +1 -0
  14. package/dist/cjs/api/web/app/view.d.ts +6 -0
  15. package/dist/cjs/api/web/app/view.js +3 -0
  16. package/dist/cjs/api/web/app/view.js.map +1 -0
  17. package/dist/cjs/api/web/debug.d.ts +11 -0
  18. package/dist/cjs/api/web/debug.js +3 -0
  19. package/dist/cjs/api/web/debug.js.map +1 -0
  20. package/dist/cjs/api/web/index.d.ts +1 -0
  21. package/dist/cjs/api/web/index.js +1 -0
  22. package/dist/cjs/api/web/index.js.map +1 -1
  23. package/dist/cjs/documents/app/app.d.ts +2 -0
  24. package/dist/cjs/documents/app/table/constants.d.ts +8 -0
  25. package/dist/cjs/documents/app/table/constants.js +14 -0
  26. package/dist/cjs/documents/app/table/constants.js.map +1 -0
  27. package/dist/cjs/documents/app/table/index.d.ts +3 -0
  28. package/dist/cjs/documents/app/table/index.js +20 -0
  29. package/dist/cjs/documents/app/table/index.js.map +1 -0
  30. package/dist/cjs/documents/app/table/schema.d.ts +71 -0
  31. package/dist/cjs/documents/app/table/schema.js +3 -0
  32. package/dist/cjs/documents/app/table/schema.js.map +1 -0
  33. package/dist/cjs/documents/app/table/table.d.ts +33 -0
  34. package/dist/cjs/documents/app/table/table.js +3 -0
  35. package/dist/cjs/documents/app/table/table.js.map +1 -0
  36. package/dist/cjs/documents/app/view.d.ts +16 -0
  37. package/dist/cjs/documents/app/view.js.map +1 -1
  38. package/dist/cjs/sdk/db.d.ts +1 -1
  39. package/dist/cjs/sdk/search.d.ts +1 -1
  40. package/dist/cjs/tsconfig-cjs.build.tsbuildinfo +1 -1
  41. package/dist/mjs/api/account/accounts.d.ts +6 -0
  42. package/dist/mjs/api/web/app/index.d.ts +4 -0
  43. package/dist/mjs/api/web/app/index.js +4 -0
  44. package/dist/mjs/api/web/app/index.js.map +1 -1
  45. package/dist/mjs/api/web/app/row.d.ts +8 -0
  46. package/dist/mjs/api/web/app/row.js +2 -0
  47. package/dist/mjs/api/web/app/row.js.map +1 -0
  48. package/dist/mjs/api/web/app/rows.d.ts +3 -0
  49. package/dist/mjs/api/web/app/rows.js +2 -0
  50. package/dist/mjs/api/web/app/rows.js.map +1 -0
  51. package/dist/mjs/api/web/app/table.d.ts +12 -0
  52. package/dist/mjs/api/web/app/table.js +2 -0
  53. package/dist/mjs/api/web/app/table.js.map +1 -0
  54. package/dist/mjs/api/web/app/view.d.ts +6 -0
  55. package/dist/mjs/api/web/app/view.js +2 -0
  56. package/dist/mjs/api/web/app/view.js.map +1 -0
  57. package/dist/mjs/api/web/debug.d.ts +11 -0
  58. package/dist/mjs/api/web/debug.js +2 -0
  59. package/dist/mjs/api/web/debug.js.map +1 -0
  60. package/dist/mjs/api/web/index.d.ts +1 -0
  61. package/dist/mjs/api/web/index.js +1 -0
  62. package/dist/mjs/api/web/index.js.map +1 -1
  63. package/dist/mjs/documents/app/app.d.ts +2 -0
  64. package/dist/mjs/documents/app/table/constants.d.ts +8 -0
  65. package/dist/mjs/documents/app/table/constants.js +11 -0
  66. package/dist/mjs/documents/app/table/constants.js.map +1 -0
  67. package/dist/mjs/documents/app/table/index.d.ts +3 -0
  68. package/dist/mjs/documents/app/table/index.js +4 -0
  69. package/dist/mjs/documents/app/table/index.js.map +1 -0
  70. package/dist/mjs/documents/app/table/schema.d.ts +71 -0
  71. package/dist/mjs/documents/app/table/schema.js +2 -0
  72. package/dist/mjs/documents/app/table/schema.js.map +1 -0
  73. package/dist/mjs/documents/app/table/table.d.ts +33 -0
  74. package/dist/mjs/documents/app/table/table.js +2 -0
  75. package/dist/mjs/documents/app/table/table.js.map +1 -0
  76. package/dist/mjs/documents/app/view.d.ts +16 -0
  77. package/dist/mjs/documents/app/view.js.map +1 -1
  78. package/dist/mjs/sdk/db.d.ts +1 -1
  79. package/dist/mjs/sdk/search.d.ts +1 -1
  80. package/dist/mjs/tsconfig.build.tsbuildinfo +1 -1
  81. package/package.json +2 -2
  82. package/src/api/account/accounts.ts +9 -0
  83. package/src/api/web/app/index.ts +4 -0
  84. package/src/api/web/app/row.ts +11 -0
  85. package/src/api/web/app/rows.ts +3 -0
  86. package/src/api/web/app/table.ts +13 -0
  87. package/src/api/web/app/view.ts +9 -0
  88. package/src/api/web/debug.ts +11 -0
  89. package/src/api/web/index.ts +1 -0
  90. package/src/documents/app/app.ts +2 -0
  91. package/src/documents/app/table/constants.ts +9 -0
  92. package/src/documents/app/table/index.ts +3 -0
  93. package/src/documents/app/table/schema.ts +98 -0
  94. package/src/documents/app/table/table.ts +30 -0
  95. package/src/documents/app/view.ts +18 -0
  96. package/src/sdk/db.ts +1 -1
  97. package/src/sdk/search.ts +1 -1
  98. package/dist/cjs/documents/app/table.d.ts +0 -94
  99. package/dist/cjs/documents/app/table.js +0 -14
  100. package/dist/cjs/documents/app/table.js.map +0 -1
  101. package/dist/mjs/documents/app/table.d.ts +0 -94
  102. package/dist/mjs/documents/app/table.js +0 -11
  103. package/dist/mjs/documents/app/table.js.map +0 -1
  104. package/src/documents/app/table.ts +0 -97
@@ -0,0 +1,11 @@
1
+ export interface GetDiagnosticsResponse {
2
+ budibaseVersion: string;
3
+ hosting: string;
4
+ nodeVersion: string;
5
+ platform: string;
6
+ cpuArch: string;
7
+ cpuCores: number;
8
+ cpuInfo: string;
9
+ totalMemory: string;
10
+ uptime: string;
11
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=debug.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"debug.js","sourceRoot":"","sources":["../../../../src/api/web/debug.ts"],"names":[],"mappings":""}
@@ -2,6 +2,7 @@ export * from "./analytics";
2
2
  export * from "./auth";
3
3
  export * from "./user";
4
4
  export * from "./errors";
5
+ export * from "./debug";
5
6
  export * from "./schedule";
6
7
  export * from "./system";
7
8
  export * from "./app";
@@ -2,6 +2,7 @@ export * from "./analytics";
2
2
  export * from "./auth";
3
3
  export * from "./user";
4
4
  export * from "./errors";
5
+ export * from "./debug";
5
6
  export * from "./schedule";
6
7
  export * from "./system";
7
8
  export * from "./app";
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/web/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,QAAQ,CAAA;AACtB,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,OAAO,CAAA;AACrB,cAAc,UAAU,CAAA;AACxB,cAAc,cAAc,CAAA"}
@@ -1,4 +1,5 @@
1
1
  import { User, Document } from "../";
2
+ import { SocketSession } from "../../sdk";
2
3
  export declare type AppMetadataErrors = {
3
4
  [key: string]: string[];
4
5
  };
@@ -17,6 +18,7 @@ export interface App extends Document {
17
18
  customTheme?: AppCustomTheme;
18
19
  revertableVersion?: string;
19
20
  lockedBy?: User;
21
+ sessions?: SocketSession[];
20
22
  navigation?: AppNavigation;
21
23
  automationErrors?: AppMetadataErrors;
22
24
  icon?: AppIcon;
@@ -0,0 +1,8 @@
1
+ export declare enum RelationshipType {
2
+ ONE_TO_MANY = "one-to-many",
3
+ MANY_TO_ONE = "many-to-one",
4
+ MANY_TO_MANY = "many-to-many"
5
+ }
6
+ export declare enum AutoReason {
7
+ FOREIGN_KEY = "foreign_key"
8
+ }
@@ -0,0 +1,11 @@
1
+ export var RelationshipType;
2
+ (function (RelationshipType) {
3
+ RelationshipType["ONE_TO_MANY"] = "one-to-many";
4
+ RelationshipType["MANY_TO_ONE"] = "many-to-one";
5
+ RelationshipType["MANY_TO_MANY"] = "many-to-many";
6
+ })(RelationshipType || (RelationshipType = {}));
7
+ export var AutoReason;
8
+ (function (AutoReason) {
9
+ AutoReason["FOREIGN_KEY"] = "foreign_key";
10
+ })(AutoReason || (AutoReason = {}));
11
+ //# sourceMappingURL=constants.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,gBAIX;AAJD,WAAY,gBAAgB;IAC1B,+CAA2B,CAAA;IAC3B,+CAA2B,CAAA;IAC3B,iDAA6B,CAAA;AAC/B,CAAC,EAJW,gBAAgB,KAAhB,gBAAgB,QAI3B;AAED,MAAM,CAAN,IAAY,UAEX;AAFD,WAAY,UAAU;IACpB,yCAA2B,CAAA;AAC7B,CAAC,EAFW,UAAU,KAAV,UAAU,QAErB"}
@@ -0,0 +1,3 @@
1
+ export * from "./table";
2
+ export * from "./schema";
3
+ export * from "./constants";
@@ -0,0 +1,4 @@
1
+ export * from "./table";
2
+ export * from "./schema";
3
+ export * from "./constants";
4
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA"}
@@ -0,0 +1,71 @@
1
+ import { FieldType } from "../row";
2
+ import { AutoReason, RelationshipType } from "./constants";
3
+ export interface UIFieldMetadata {
4
+ order?: number;
5
+ width?: number;
6
+ visible?: boolean;
7
+ icon?: string;
8
+ }
9
+ export interface RelationshipFieldMetadata {
10
+ main?: boolean;
11
+ fieldName?: string;
12
+ tableId?: string;
13
+ relationshipType?: RelationshipType;
14
+ through?: string;
15
+ foreignKey?: string;
16
+ throughFrom?: string;
17
+ throughTo?: string;
18
+ }
19
+ export interface AutoColumnFieldMetadata {
20
+ autocolumn?: boolean;
21
+ subtype?: string;
22
+ lastID?: number;
23
+ autoReason?: AutoReason;
24
+ }
25
+ export interface NumberFieldMetadata {
26
+ meta?: {
27
+ toTable: string;
28
+ toKey: string;
29
+ };
30
+ }
31
+ export interface DateFieldMetadata {
32
+ ignoreTimezones?: boolean;
33
+ timeOnly?: boolean;
34
+ }
35
+ export interface StringFieldMetadata {
36
+ useRichText?: boolean | null;
37
+ }
38
+ export interface FormulaFieldMetadata {
39
+ formula?: string;
40
+ formulaType?: string;
41
+ }
42
+ export interface FieldConstraints {
43
+ type?: string;
44
+ email?: boolean;
45
+ inclusion?: string[];
46
+ length?: {
47
+ minimum?: string | number | null;
48
+ maximum?: string | number | null;
49
+ };
50
+ numericality?: {
51
+ greaterThanOrEqualTo: string | null;
52
+ lessThanOrEqualTo: string | null;
53
+ };
54
+ presence?: boolean | {
55
+ allowEmpty?: boolean;
56
+ };
57
+ datetime?: {
58
+ latest: string;
59
+ earliest: string;
60
+ };
61
+ }
62
+ export interface FieldSchema extends UIFieldMetadata, DateFieldMetadata, RelationshipFieldMetadata, AutoColumnFieldMetadata, StringFieldMetadata, FormulaFieldMetadata, NumberFieldMetadata {
63
+ type: FieldType;
64
+ name: string;
65
+ sortable?: boolean;
66
+ externalType?: string;
67
+ constraints?: FieldConstraints;
68
+ }
69
+ export interface TableSchema {
70
+ [key: string]: FieldSchema;
71
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=schema.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/schema.ts"],"names":[],"mappings":""}
@@ -0,0 +1,33 @@
1
+ import { Document } from "../../document";
2
+ import { View, ViewV2 } from "../view";
3
+ import { RenameColumn } from "../../../sdk";
4
+ import { TableSchema } from "./schema";
5
+ export interface Table extends Document {
6
+ type?: string;
7
+ views?: {
8
+ [key: string]: View | ViewV2;
9
+ };
10
+ name: string;
11
+ primary?: string[];
12
+ schema: TableSchema;
13
+ primaryDisplay?: string;
14
+ sourceId?: string;
15
+ relatedFormula?: string[];
16
+ constrained?: string[];
17
+ sql?: boolean;
18
+ indexes?: {
19
+ [key: string]: any;
20
+ };
21
+ rows?: {
22
+ [key: string]: any;
23
+ };
24
+ created?: boolean;
25
+ rowHeight?: number;
26
+ }
27
+ export interface ExternalTable extends Table {
28
+ sourceId: string;
29
+ }
30
+ export interface TableRequest extends Table {
31
+ _rename?: RenameColumn;
32
+ created?: boolean;
33
+ }
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=table.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"table.js","sourceRoot":"","sources":["../../../../../src/documents/app/table/table.ts"],"names":[],"mappings":""}
@@ -1,3 +1,6 @@
1
+ import { SortOrder, SortType } from "../../api";
2
+ import { SearchFilters } from "../../sdk";
3
+ import { UIFieldMetadata } from "./table";
1
4
  export interface View {
2
5
  name: string;
3
6
  tableId: string;
@@ -9,6 +12,19 @@ export interface View {
9
12
  reduce?: any;
10
13
  meta?: Record<string, any>;
11
14
  }
15
+ export interface ViewV2 {
16
+ version: 2;
17
+ id: string;
18
+ name: string;
19
+ tableId: string;
20
+ query?: SearchFilters;
21
+ sort?: {
22
+ field: string;
23
+ order?: SortOrder;
24
+ type?: SortType;
25
+ };
26
+ columns?: Record<string, UIFieldMetadata>;
27
+ }
12
28
  export declare type ViewSchema = ViewCountOrSumSchema | ViewStatisticsSchema;
13
29
  export interface ViewCountOrSumSchema {
14
30
  field: string;
@@ -1 +1 @@
1
- {"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/documents/app/view.ts"],"names":[],"mappings":"AAyCA,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B"}
1
+ {"version":3,"file":"view.js","sourceRoot":"","sources":["../../../../src/documents/app/view.ts"],"names":[],"mappings":"AA2DA,MAAM,CAAN,IAAY,eAIX;AAJD,WAAY,eAAe;IACzB,8BAAW,CAAA;IACX,kCAAe,CAAA;IACf,uCAAoB,CAAA;AACtB,CAAC,EAJW,eAAe,KAAf,eAAe,QAI1B"}
@@ -75,7 +75,7 @@ export interface Database {
75
75
  name: string;
76
76
  exists(): Promise<boolean>;
77
77
  checkSetup(): Promise<Nano.DocumentScope<any>>;
78
- get<T>(id?: string): Promise<T | any>;
78
+ get<T>(id?: string): Promise<T>;
79
79
  remove(id: string | Document, rev?: string): Promise<Nano.DocumentDestroyResponse>;
80
80
  put(document: AnyDocument, opts?: DatabasePutOpts): Promise<Nano.DocumentInsertResponse>;
81
81
  bulkDocs(documents: AnyDocument[]): Promise<Nano.DocumentBulkResponse[]>;
@@ -31,7 +31,7 @@ export interface SearchFilters {
31
31
  [key: string]: any[];
32
32
  };
33
33
  contains?: {
34
- [key: string]: any[];
34
+ [key: string]: any[] | any;
35
35
  };
36
36
  notContains?: {
37
37
  [key: string]: any[];