@rebasepro/server-postgresql 0.0.1-canary.dbf160a → 0.0.1-canary.e17585f
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.
- package/dist/index.es.js +683 -1362
- package/dist/index.es.js.map +1 -1
- package/dist/index.umd.js +614 -1293
- package/dist/index.umd.js.map +1 -1
- package/dist/server-postgresql/src/PostgresAdapter.d.ts +6 -0
- package/dist/server-postgresql/src/PostgresBackendDriver.d.ts +8 -1
- package/dist/server-postgresql/src/PostgresBootstrapper.d.ts +0 -5
- package/dist/server-postgresql/src/index.d.ts +1 -0
- package/dist/server-postgresql/src/schema/introspect-db-inference.d.ts +5 -0
- package/dist/server-postgresql/src/schema/introspect-db-logic.d.ts +44 -9
- package/dist/server-postgresql/src/services/EntityPersistService.d.ts +9 -0
- package/dist/server-postgresql/src/services/realtimeService.d.ts +12 -0
- package/dist/server-postgresql/src/websocket.d.ts +2 -1
- package/dist/types/src/controllers/auth.d.ts +8 -2
- package/dist/types/src/controllers/client.d.ts +13 -0
- package/dist/types/src/controllers/collection_registry.d.ts +2 -1
- package/dist/types/src/controllers/data_driver.d.ts +36 -1
- package/dist/types/src/controllers/navigation.d.ts +18 -6
- package/dist/types/src/controllers/registry.d.ts +9 -1
- package/dist/types/src/controllers/side_entity_controller.d.ts +7 -0
- package/dist/types/src/rebase_context.d.ts +17 -0
- package/dist/types/src/types/auth_adapter.d.ts +354 -0
- package/dist/types/src/types/backend_hooks.d.ts +187 -0
- package/dist/types/src/types/collections.d.ts +75 -11
- package/dist/types/src/types/component_ref.d.ts +47 -0
- package/dist/types/src/types/cron.d.ts +1 -1
- package/dist/types/src/types/database_adapter.d.ts +90 -0
- package/dist/types/src/types/entity_views.d.ts +6 -7
- package/dist/types/src/types/formex.d.ts +40 -0
- package/dist/types/src/types/index.d.ts +5 -0
- package/dist/types/src/types/plugins.d.ts +6 -3
- package/dist/types/src/types/properties.d.ts +72 -88
- package/dist/types/src/types/slots.d.ts +20 -10
- package/dist/types/src/types/translations.d.ts +12 -0
- package/package.json +5 -5
- package/src/PostgresAdapter.ts +52 -0
- package/src/PostgresBackendDriver.ts +49 -7
- package/src/PostgresBootstrapper.ts +4 -7
- package/src/auth/ensure-tables.ts +3 -121
- package/src/cli.ts +10 -2
- package/src/data-transformer.ts +84 -1
- package/src/index.ts +1 -0
- package/src/schema/doctor.ts +14 -2
- package/src/schema/generate-drizzle-schema-logic.ts +59 -30
- package/src/schema/introspect-db-inference.ts +238 -0
- package/src/schema/introspect-db-logic.ts +365 -61
- package/src/schema/introspect-db.ts +66 -23
- package/src/services/EntityFetchService.ts +16 -0
- package/src/services/EntityPersistService.ts +95 -13
- package/src/services/realtimeService.ts +35 -0
- package/src/utils/drizzle-conditions.ts +6 -0
- package/src/websocket.ts +60 -11
- package/test/generate-drizzle-schema.test.ts +342 -0
- package/test/introspect-db-generation.test.ts +32 -10
- package/test/property-ordering.test.ts +395 -0
- package/test/relations.test.ts +4 -4
- package/jest-all.log +0 -3128
- package/jest.log +0 -49
- package/scratch.ts +0 -41
- package/test-drizzle-bug.ts +0 -18
- package/test-drizzle-out/0000_cultured_freak.sql +0 -7
- package/test-drizzle-out/0001_tiresome_professor_monster.sql +0 -1
- package/test-drizzle-out/meta/0000_snapshot.json +0 -55
- package/test-drizzle-out/meta/0001_snapshot.json +0 -63
- package/test-drizzle-out/meta/_journal.json +0 -20
- package/test-drizzle-prompt.sh +0 -2
- package/test-policy-prompt.sh +0 -3
- package/test-programmatic.ts +0 -30
- package/test-programmatic2.ts +0 -59
- package/test-schema-no-policies.ts +0 -12
- package/test_drizzle_mock.js +0 -3
- package/test_find_changed.mjs +0 -32
- package/test_hash.js +0 -14
- package/test_output.txt +0 -3145
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
import type React from "react";
|
|
2
|
+
/**
|
|
3
|
+
* Internal marker for a lazily-loaded component reference.
|
|
4
|
+
* Created by the Vite transform plugin when converting string paths
|
|
5
|
+
* to deferred `import()` calls. Users should NOT create these manually.
|
|
6
|
+
*
|
|
7
|
+
* @internal
|
|
8
|
+
*/
|
|
9
|
+
export interface LazyComponentRef<P = unknown> {
|
|
10
|
+
readonly __rebaseLazy: true;
|
|
11
|
+
readonly load: () => Promise<{
|
|
12
|
+
default: React.ComponentType<P>;
|
|
13
|
+
}>;
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* A reference to a React component that can be provided in three forms:
|
|
17
|
+
*
|
|
18
|
+
* 1. **String path** (recommended for collection configs):
|
|
19
|
+
* ```ts
|
|
20
|
+
* Field: "../../frontend/src/components/MyField"
|
|
21
|
+
* ```
|
|
22
|
+
* The Vite plugin transforms this into a `LazyComponentRef` at build time.
|
|
23
|
+
* On the backend, the string stays inert and is never evaluated.
|
|
24
|
+
*
|
|
25
|
+
* 2. **Lazy import function**:
|
|
26
|
+
* ```ts
|
|
27
|
+
* Field: () => import("../../frontend/src/components/MyField")
|
|
28
|
+
* ```
|
|
29
|
+
* Standard ES dynamic import. Backend never calls the function.
|
|
30
|
+
*
|
|
31
|
+
* 3. **Direct component reference** (use only in frontend-only code):
|
|
32
|
+
* ```ts
|
|
33
|
+
* Field: MyFieldComponent
|
|
34
|
+
* ```
|
|
35
|
+
* Importing a component at the top level will pull React into the
|
|
36
|
+
* backend runtime — only safe in code that the backend never imports.
|
|
37
|
+
*
|
|
38
|
+
* @group Types
|
|
39
|
+
*/
|
|
40
|
+
export type ComponentRef<P = unknown> = React.ComponentType<P> | LazyComponentRef<P> | (() => Promise<{
|
|
41
|
+
default: React.ComponentType<P>;
|
|
42
|
+
}>) | string;
|
|
43
|
+
/**
|
|
44
|
+
* Type guard: checks if a value is a `LazyComponentRef` produced by the
|
|
45
|
+
* Vite transform plugin.
|
|
46
|
+
*/
|
|
47
|
+
export declare function isLazyComponentRef<P = unknown>(ref: unknown): ref is LazyComponentRef<P>;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { RebaseClient } from "../controllers/client";
|
|
1
2
|
/**
|
|
2
3
|
* Cron Job type definitions for Rebase.
|
|
3
4
|
*
|
|
@@ -32,7 +33,6 @@ export interface CronJobDefinition {
|
|
|
32
33
|
*/
|
|
33
34
|
handler: (ctx: CronJobContext) => Promise<unknown> | unknown;
|
|
34
35
|
}
|
|
35
|
-
import type { RebaseClient } from "../controllers/client";
|
|
36
36
|
/**
|
|
37
37
|
* Context passed to each cron handler invocation.
|
|
38
38
|
*/
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @module DatabaseAdapter
|
|
3
|
+
*
|
|
4
|
+
* Pluggable database abstraction for Rebase.
|
|
5
|
+
*
|
|
6
|
+
*
|
|
7
|
+
* A `DatabaseAdapter` focuses purely on data persistence and related concerns (realtime, history).
|
|
8
|
+
* It does NOT handle authentication — auth is managed separately by an `AuthAdapter`.
|
|
9
|
+
*
|
|
10
|
+
* @example
|
|
11
|
+
* ```ts
|
|
12
|
+
* import { createPostgresAdapter } from "@rebasepro/server-postgresql";
|
|
13
|
+
*
|
|
14
|
+
* initializeRebaseBackend({
|
|
15
|
+
* database: createPostgresAdapter({ connection: db, schema }),
|
|
16
|
+
* auth: { jwtSecret: "..." },
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
19
|
+
*
|
|
20
|
+
* @group Backend
|
|
21
|
+
*/
|
|
22
|
+
import type { DataDriver } from "../controllers/data_driver";
|
|
23
|
+
import type { EntityCollection } from "./collections";
|
|
24
|
+
import type { CollectionRegistryInterface, DatabaseAdmin, InitializedDriver, RealtimeProvider } from "./backend";
|
|
25
|
+
/**
|
|
26
|
+
* A `DatabaseAdapter` provides data persistence for Rebase.
|
|
27
|
+
*
|
|
28
|
+
* @group Backend
|
|
29
|
+
*/
|
|
30
|
+
export interface DatabaseAdapter {
|
|
31
|
+
/**
|
|
32
|
+
* Which database engine this adapter handles.
|
|
33
|
+
*
|
|
34
|
+
* @example "postgres", "mysql", "mongodb", "sqlite"
|
|
35
|
+
*/
|
|
36
|
+
readonly type: string;
|
|
37
|
+
/**
|
|
38
|
+
* Create the DataDriver for CRUD operations.
|
|
39
|
+
*
|
|
40
|
+
* This is the only **required** method.
|
|
41
|
+
*
|
|
42
|
+
* @param config - Coordinator-provided config containing registered
|
|
43
|
+
* collections and the collection registry.
|
|
44
|
+
*/
|
|
45
|
+
initializeDriver(config: DatabaseAdapterInitConfig): Promise<InitializedDriver>;
|
|
46
|
+
/**
|
|
47
|
+
* Create a realtime provider for this database.
|
|
48
|
+
*
|
|
49
|
+
* Return `undefined` if the database does not support realtime
|
|
50
|
+
* change notifications.
|
|
51
|
+
*/
|
|
52
|
+
initializeRealtime?(driverResult: InitializedDriver): Promise<RealtimeProvider | undefined>;
|
|
53
|
+
/**
|
|
54
|
+
* Initialize entity history tracking.
|
|
55
|
+
*
|
|
56
|
+
* Return `undefined` if the database does not support history.
|
|
57
|
+
*/
|
|
58
|
+
initializeHistory?(config: unknown, driverResult: InitializedDriver): Promise<{
|
|
59
|
+
historyService: unknown;
|
|
60
|
+
} | undefined>;
|
|
61
|
+
/**
|
|
62
|
+
* Initialize WebSocket server for realtime operations.
|
|
63
|
+
*/
|
|
64
|
+
initializeWebsockets?(server: unknown, realtimeService: RealtimeProvider, driver: DataDriver, config?: unknown): Promise<void> | void;
|
|
65
|
+
/**
|
|
66
|
+
* Return admin capabilities for this database (SQL editor, schema browser, branching).
|
|
67
|
+
*/
|
|
68
|
+
getAdmin?(driverResult: InitializedDriver): DatabaseAdmin | undefined;
|
|
69
|
+
/**
|
|
70
|
+
* Mount any database-specific HTTP routes (e.g., custom admin endpoints).
|
|
71
|
+
*
|
|
72
|
+
* Called after all adapters are initialized.
|
|
73
|
+
*/
|
|
74
|
+
mountRoutes?(app: unknown, basePath: string, driverResult: InitializedDriver): void;
|
|
75
|
+
/**
|
|
76
|
+
* Graceful shutdown: close connections, release resources.
|
|
77
|
+
*/
|
|
78
|
+
destroy?(): Promise<void>;
|
|
79
|
+
}
|
|
80
|
+
/**
|
|
81
|
+
* Configuration passed by the coordinator to `DatabaseAdapter.initializeDriver()`.
|
|
82
|
+
*
|
|
83
|
+
* @group Backend
|
|
84
|
+
*/
|
|
85
|
+
export interface DatabaseAdapterInitConfig {
|
|
86
|
+
/** Registered collection definitions. */
|
|
87
|
+
collections: EntityCollection[];
|
|
88
|
+
/** The shared collection registry to register into. */
|
|
89
|
+
collectionRegistry: CollectionRegistryInterface;
|
|
90
|
+
}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import type { Entity, EntityValues } from "./entities";
|
|
3
3
|
import type { EntityCollection } from "./collections";
|
|
4
|
+
import type { FormexController } from "./formex";
|
|
5
|
+
import type { ComponentRef } from "./component_ref";
|
|
4
6
|
/**
|
|
5
7
|
* Context passed to custom fields and entity views.
|
|
6
|
-
* This is the base definition — `@rebasepro/admin` re-exports a
|
|
7
|
-
* fully-typed version that narrows the `formex` field.
|
|
8
8
|
* @group Form custom fields
|
|
9
9
|
*/
|
|
10
10
|
export interface FormContext<M extends Record<string, unknown> = Record<string, unknown>> {
|
|
@@ -38,10 +38,8 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
|
|
|
38
38
|
openEntityMode: "side_panel" | "full_screen" | "split";
|
|
39
39
|
/**
|
|
40
40
|
* The underlying formex controller that powers the form.
|
|
41
|
-
* Prefer importing `FormContext` from `@rebasepro/admin` for the
|
|
42
|
-
* fully-typed `FormexController<M>` version.
|
|
43
41
|
*/
|
|
44
|
-
formex:
|
|
42
|
+
formex: FormexController<M>;
|
|
45
43
|
disabled: boolean;
|
|
46
44
|
}
|
|
47
45
|
export type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
|
|
@@ -49,7 +47,7 @@ export type EntityCustomView<M extends Record<string, unknown> = Record<string,
|
|
|
49
47
|
name: string;
|
|
50
48
|
tabComponent?: React.ReactNode;
|
|
51
49
|
includeActions?: boolean | "bottom";
|
|
52
|
-
Builder?:
|
|
50
|
+
Builder?: ComponentRef<EntityCustomViewParams<M>>;
|
|
53
51
|
position?: "start" | "end";
|
|
54
52
|
};
|
|
55
53
|
export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
|
|
@@ -57,5 +55,6 @@ export interface EntityCustomViewParams<M extends Record<string, unknown> = Reco
|
|
|
57
55
|
entity?: Entity<M>;
|
|
58
56
|
modifiedValues?: EntityValues<M>;
|
|
59
57
|
formContext: FormContext<M>;
|
|
60
|
-
|
|
58
|
+
parentCollectionSlugs?: string[];
|
|
59
|
+
parentEntityIds?: string[];
|
|
61
60
|
}
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
import React, { FormEvent } from "react";
|
|
2
|
+
export type FormexController<T = any> = {
|
|
3
|
+
values: T;
|
|
4
|
+
initialValues: T;
|
|
5
|
+
setValues: (values: T) => void;
|
|
6
|
+
setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
|
|
7
|
+
touched: Record<string, boolean>;
|
|
8
|
+
setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
|
|
9
|
+
setTouched: (touched: Record<string, boolean>) => void;
|
|
10
|
+
dirty: boolean;
|
|
11
|
+
setDirty: (dirty: boolean) => void;
|
|
12
|
+
setSubmitCount: (submitCount: number) => void;
|
|
13
|
+
errors: Record<string, string>;
|
|
14
|
+
setFieldError: (key: string, error?: string) => void;
|
|
15
|
+
handleChange: (event: React.SyntheticEvent) => void;
|
|
16
|
+
handleBlur: (event: React.FocusEvent) => void;
|
|
17
|
+
handleSubmit: (event?: FormEvent<HTMLFormElement>) => void;
|
|
18
|
+
validate: () => void;
|
|
19
|
+
resetForm: (props?: FormexResetProps<T>) => void;
|
|
20
|
+
submitCount: number;
|
|
21
|
+
isSubmitting: boolean;
|
|
22
|
+
setSubmitting: (isSubmitting: boolean) => void;
|
|
23
|
+
isValidating: boolean;
|
|
24
|
+
/**
|
|
25
|
+
* The version of the form. This is incremented every time the form is reset
|
|
26
|
+
* or the form is submitted.
|
|
27
|
+
*/
|
|
28
|
+
version: number;
|
|
29
|
+
debugId?: string;
|
|
30
|
+
undo: () => void;
|
|
31
|
+
redo: () => void;
|
|
32
|
+
canUndo: boolean;
|
|
33
|
+
canRedo: boolean;
|
|
34
|
+
};
|
|
35
|
+
export type FormexResetProps<T = any> = {
|
|
36
|
+
values?: T;
|
|
37
|
+
submitCount?: number;
|
|
38
|
+
errors?: Record<string, string>;
|
|
39
|
+
touched?: Record<string, boolean>;
|
|
40
|
+
};
|
|
@@ -10,6 +10,7 @@ export * from "./entity_callbacks";
|
|
|
10
10
|
export * from "./entity_overrides";
|
|
11
11
|
export * from "./export_import";
|
|
12
12
|
export * from "./modify_collections";
|
|
13
|
+
export * from "./formex";
|
|
13
14
|
export * from "./websockets";
|
|
14
15
|
export * from "./backend";
|
|
15
16
|
export * from "./translations";
|
|
@@ -21,3 +22,7 @@ export * from "./property_config";
|
|
|
21
22
|
export * from "./entity_views";
|
|
22
23
|
export * from "./data_source";
|
|
23
24
|
export * from "./cron";
|
|
25
|
+
export * from "./backend_hooks";
|
|
26
|
+
export * from "./component_ref";
|
|
27
|
+
export * from "./auth_adapter";
|
|
28
|
+
export * from "./database_adapter";
|
|
@@ -157,7 +157,8 @@ export interface PluginHooks {
|
|
|
157
157
|
*/
|
|
158
158
|
onColumnsReorder?: (props: {
|
|
159
159
|
fullPath: string;
|
|
160
|
-
|
|
160
|
+
parentCollectionSlugs: string[];
|
|
161
|
+
parentEntityIds: string[];
|
|
161
162
|
collection: EntityCollection;
|
|
162
163
|
newPropertiesOrder: string[];
|
|
163
164
|
}) => void;
|
|
@@ -166,7 +167,8 @@ export interface PluginHooks {
|
|
|
166
167
|
*/
|
|
167
168
|
onKanbanColumnsReorder?: (props: {
|
|
168
169
|
fullPath: string;
|
|
169
|
-
|
|
170
|
+
parentCollectionSlugs: string[];
|
|
171
|
+
parentEntityIds: string[];
|
|
170
172
|
collection: EntityCollection;
|
|
171
173
|
kanbanColumnProperty: string;
|
|
172
174
|
newColumnsOrder: string[];
|
|
@@ -241,7 +243,8 @@ export interface PluginHomePageActionsProps<EP extends object = object, M extend
|
|
|
241
243
|
export interface PluginFormActionProps<USER extends User = User, EC extends EntityCollection = EntityCollection> {
|
|
242
244
|
entityId?: string | number;
|
|
243
245
|
path: string;
|
|
244
|
-
|
|
246
|
+
parentCollectionSlugs: string[];
|
|
247
|
+
parentEntityIds: string[];
|
|
245
248
|
status: EntityStatus;
|
|
246
249
|
collection: EC;
|
|
247
250
|
disabled: boolean;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import
|
|
1
|
+
import type { ComponentRef } from "./component_ref";
|
|
2
2
|
import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity } from "./entities";
|
|
3
3
|
import type { Relation, JoinStep, OnAction } from "./relations";
|
|
4
4
|
import type { EntityCollection, FilterValues } from "./collections";
|
|
@@ -36,6 +36,14 @@ export type Property = StringProperty | NumberProperty | BooleanProperty | DateP
|
|
|
36
36
|
export type Properties = {
|
|
37
37
|
[key: string]: Property;
|
|
38
38
|
};
|
|
39
|
+
export type PostgresProperty = Exclude<Property, ReferenceProperty>;
|
|
40
|
+
export type PostgresProperties = {
|
|
41
|
+
[key: string]: PostgresProperty;
|
|
42
|
+
};
|
|
43
|
+
export type FirebaseProperty = Exclude<Property, RelationProperty>;
|
|
44
|
+
export type FirebaseProperties = {
|
|
45
|
+
[key: string]: FirebaseProperty;
|
|
46
|
+
};
|
|
39
47
|
/**
|
|
40
48
|
* A helper type to infer the underlying data type from a Property definition.
|
|
41
49
|
* This is the core of the type inference system.
|
|
@@ -89,7 +97,18 @@ export type InferEntityType<P extends Properties> = {
|
|
|
89
97
|
* Interface including all common properties of a CMS property.
|
|
90
98
|
* @group Entity properties
|
|
91
99
|
*/
|
|
100
|
+
export interface BaseUIConfig<CustomProps = unknown> {
|
|
101
|
+
columnWidth?: number;
|
|
102
|
+
hideFromCollection?: boolean;
|
|
103
|
+
readOnly?: boolean;
|
|
104
|
+
disabled?: boolean | PropertyDisabledConfig;
|
|
105
|
+
widthPercentage?: number;
|
|
106
|
+
customProps?: CustomProps;
|
|
107
|
+
Field?: ComponentRef<any>;
|
|
108
|
+
Preview?: ComponentRef<any>;
|
|
109
|
+
}
|
|
92
110
|
export interface BaseProperty<CustomProps = unknown> {
|
|
111
|
+
ui?: BaseUIConfig<CustomProps>;
|
|
93
112
|
/**
|
|
94
113
|
* Property name (e.g. Product)
|
|
95
114
|
*/
|
|
@@ -106,27 +125,17 @@ export interface BaseProperty<CustomProps = unknown> {
|
|
|
106
125
|
*/
|
|
107
126
|
propertyConfig?: string;
|
|
108
127
|
/**
|
|
109
|
-
*
|
|
110
|
-
* the
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
*
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
* Is this a read only property. When set to true, it gets rendered as a
|
|
119
|
-
* preview.
|
|
120
|
-
*/
|
|
121
|
-
readOnly?: boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Is this field disabled.
|
|
124
|
-
* When set to true, it gets rendered as a
|
|
125
|
-
* disabled field. You can also specify a configuration for defining the
|
|
126
|
-
* behaviour of disabled properties (including custom messages, clear value on
|
|
127
|
-
* disabled or hide the field completely)
|
|
128
|
+
* Explicit database column name. When set, this value is used as-is
|
|
129
|
+
* for the SQL column name, bypassing any snake_case conversion of
|
|
130
|
+
* the property key.
|
|
131
|
+
*
|
|
132
|
+
* This is automatically populated by `rebase schema introspect`
|
|
133
|
+
* to guarantee an exact match with the live database schema.
|
|
134
|
+
*
|
|
135
|
+
* For manually-authored collections you can omit this — the framework
|
|
136
|
+
* will derive the column name from the property key via `toSnakeCase()`.
|
|
128
137
|
*/
|
|
129
|
-
|
|
138
|
+
columnName?: string;
|
|
130
139
|
/**
|
|
131
140
|
* Rules for validating this property
|
|
132
141
|
*/
|
|
@@ -135,16 +144,6 @@ export interface BaseProperty<CustomProps = unknown> {
|
|
|
135
144
|
* This value will be set by default for new entities.
|
|
136
145
|
*/
|
|
137
146
|
defaultValue?: unknown;
|
|
138
|
-
/**
|
|
139
|
-
* A number between 0 and 100 that indicates the width of the field in the form view.
|
|
140
|
-
* It defaults to 100, but you can set it to 50 to have two fields in the same row.
|
|
141
|
-
*/
|
|
142
|
-
widthPercentage?: number;
|
|
143
|
-
/**
|
|
144
|
-
* Additional props that are passed to the components defined in `field`
|
|
145
|
-
* or in `preview`.
|
|
146
|
-
*/
|
|
147
|
-
customProps?: CustomProps;
|
|
148
147
|
/**
|
|
149
148
|
* Use this to define dynamic properties that change based on certain conditions
|
|
150
149
|
* or on the entity's values. For example, you can make a field read-only if
|
|
@@ -168,21 +167,19 @@ export interface BaseProperty<CustomProps = unknown> {
|
|
|
168
167
|
* Callbacks/Hooks for this property field to transform and sanitize data during its lifecycle.
|
|
169
168
|
*/
|
|
170
169
|
callbacks?: PropertyCallbacks;
|
|
171
|
-
/**
|
|
172
|
-
* Custom field component to render this property in forms.
|
|
173
|
-
* Used by the CMS layer.
|
|
174
|
-
*/
|
|
175
|
-
Field?: React.ComponentType<any>;
|
|
176
|
-
/**
|
|
177
|
-
* Custom preview component to render this property in previews/tables.
|
|
178
|
-
* Used by the CMS layer.
|
|
179
|
-
*/
|
|
180
|
-
Preview?: React.ComponentType<any>;
|
|
181
170
|
}
|
|
182
171
|
/**
|
|
183
172
|
* @group Entity properties
|
|
184
173
|
*/
|
|
174
|
+
export interface StringUIConfig extends BaseUIConfig {
|
|
175
|
+
multiline?: boolean;
|
|
176
|
+
markdown?: boolean;
|
|
177
|
+
previewAsTag?: boolean;
|
|
178
|
+
clearable?: boolean;
|
|
179
|
+
url?: boolean | PreviewType;
|
|
180
|
+
}
|
|
185
181
|
export interface StringProperty extends BaseProperty {
|
|
182
|
+
ui?: StringUIConfig;
|
|
186
183
|
type: "string";
|
|
187
184
|
/**
|
|
188
185
|
* Optional database column type. If not set, it defaults to `varchar` or `uuid` depending on `isId` configuration.
|
|
@@ -257,10 +254,6 @@ export interface StringProperty extends BaseProperty {
|
|
|
257
254
|
* Should this string be rendered as a tag instead of just text.
|
|
258
255
|
*/
|
|
259
256
|
previewAsTag?: boolean;
|
|
260
|
-
/**
|
|
261
|
-
* Add an icon to clear the value and set it to `null`. Defaults to `false`
|
|
262
|
-
*/
|
|
263
|
-
clearable?: boolean;
|
|
264
257
|
/**
|
|
265
258
|
* You can use this property (a string) to behave as a reference to another
|
|
266
259
|
* collection. The stored value is the ID of the entity in the
|
|
@@ -272,7 +265,11 @@ export interface StringProperty extends BaseProperty {
|
|
|
272
265
|
/**
|
|
273
266
|
* @group Entity properties
|
|
274
267
|
*/
|
|
268
|
+
export interface NumberUIConfig extends BaseUIConfig {
|
|
269
|
+
clearable?: boolean;
|
|
270
|
+
}
|
|
275
271
|
export interface NumberProperty extends BaseProperty {
|
|
272
|
+
ui?: NumberUIConfig;
|
|
276
273
|
type: "number";
|
|
277
274
|
/**
|
|
278
275
|
* Optional database column type. Allows specifying exact database numeric types.
|
|
@@ -300,15 +297,12 @@ export interface NumberProperty extends BaseProperty {
|
|
|
300
297
|
* displayed in the dropdown.
|
|
301
298
|
*/
|
|
302
299
|
enum?: EnumValues;
|
|
303
|
-
/**
|
|
304
|
-
* Add an icon to clear the value and set it to `null`. Defaults to `false`
|
|
305
|
-
*/
|
|
306
|
-
clearable?: boolean;
|
|
307
300
|
}
|
|
308
301
|
/**
|
|
309
302
|
* @group Entity properties
|
|
310
303
|
*/
|
|
311
304
|
export interface BooleanProperty extends BaseProperty {
|
|
305
|
+
ui?: BaseUIConfig;
|
|
312
306
|
type: "boolean";
|
|
313
307
|
/**
|
|
314
308
|
* Rules for validating this property
|
|
@@ -318,7 +312,11 @@ export interface BooleanProperty extends BaseProperty {
|
|
|
318
312
|
/**
|
|
319
313
|
* @group Entity properties
|
|
320
314
|
*/
|
|
315
|
+
export interface DateUIConfig extends BaseUIConfig {
|
|
316
|
+
clearable?: boolean;
|
|
317
|
+
}
|
|
321
318
|
export interface DateProperty extends BaseProperty {
|
|
319
|
+
ui?: DateUIConfig;
|
|
322
320
|
type: "date";
|
|
323
321
|
/**
|
|
324
322
|
* Optional database column type. If not set, defaults to `timestamp` with timezone.
|
|
@@ -354,6 +352,7 @@ export interface DateProperty extends BaseProperty {
|
|
|
354
352
|
* @group Entity properties
|
|
355
353
|
*/
|
|
356
354
|
export interface GeopointProperty extends BaseProperty {
|
|
355
|
+
ui?: BaseUIConfig;
|
|
357
356
|
type: "geopoint";
|
|
358
357
|
/**
|
|
359
358
|
* Rules for validating this property
|
|
@@ -363,7 +362,11 @@ export interface GeopointProperty extends BaseProperty {
|
|
|
363
362
|
/**
|
|
364
363
|
* @group Entity properties
|
|
365
364
|
*/
|
|
365
|
+
export interface ReferenceUIConfig extends BaseUIConfig {
|
|
366
|
+
previewProperties?: string[];
|
|
367
|
+
}
|
|
366
368
|
export interface ReferenceProperty extends BaseProperty {
|
|
369
|
+
ui?: ReferenceUIConfig;
|
|
367
370
|
type: "reference";
|
|
368
371
|
/**
|
|
369
372
|
* Marks this field as a Primary Key / Unique Identifier.
|
|
@@ -384,15 +387,9 @@ export interface ReferenceProperty extends BaseProperty {
|
|
|
384
387
|
path?: string;
|
|
385
388
|
/**
|
|
386
389
|
* Allow selection of entities that pass the given filter only.
|
|
387
|
-
* e.g. `
|
|
390
|
+
* e.g. `fixedFilter: { age: [">=", 18] }`
|
|
388
391
|
*/
|
|
389
|
-
|
|
390
|
-
/**
|
|
391
|
-
* Properties that need to be rendered when displaying a preview of this
|
|
392
|
-
* reference. If not specified the first 3 are used. Only the first 3
|
|
393
|
-
* specified values are considered.
|
|
394
|
-
*/
|
|
395
|
-
previewProperties?: string[];
|
|
392
|
+
fixedFilter?: FilterValues<string>;
|
|
396
393
|
/**
|
|
397
394
|
* Should the reference include the ID of the entity. Defaults to `true`
|
|
398
395
|
*/
|
|
@@ -405,7 +402,12 @@ export interface ReferenceProperty extends BaseProperty {
|
|
|
405
402
|
/**
|
|
406
403
|
* @group Entity properties
|
|
407
404
|
*/
|
|
405
|
+
export interface RelationUIConfig extends BaseUIConfig {
|
|
406
|
+
previewProperties?: string[];
|
|
407
|
+
widget?: "select" | "dialog";
|
|
408
|
+
}
|
|
408
409
|
export interface RelationProperty extends BaseProperty {
|
|
410
|
+
ui?: RelationUIConfig;
|
|
409
411
|
type: "relation";
|
|
410
412
|
/**
|
|
411
413
|
* Marks this field as a Primary Key / Unique Identifier.
|
|
@@ -492,15 +494,9 @@ export interface RelationProperty extends BaseProperty {
|
|
|
492
494
|
relation?: Relation;
|
|
493
495
|
/**
|
|
494
496
|
* Allow selection of entities that pass the given filter only.
|
|
495
|
-
* e.g. `
|
|
497
|
+
* e.g. `fixedFilter: { age: [">=", 18] }`
|
|
496
498
|
*/
|
|
497
|
-
|
|
498
|
-
/**
|
|
499
|
-
* Properties that need to be rendered when displaying a preview of this
|
|
500
|
-
* reference. If not specified the first 3 are used. Only the first 3
|
|
501
|
-
* specified values are considered.
|
|
502
|
-
*/
|
|
503
|
-
previewProperties?: string[];
|
|
499
|
+
fixedFilter?: FilterValues<string>;
|
|
504
500
|
/**
|
|
505
501
|
* Should the reference include the ID of the entity. Defaults to `true`
|
|
506
502
|
*/
|
|
@@ -518,7 +514,12 @@ export interface RelationProperty extends BaseProperty {
|
|
|
518
514
|
/**
|
|
519
515
|
* @group Entity properties
|
|
520
516
|
*/
|
|
517
|
+
export interface ArrayUIConfig extends BaseUIConfig {
|
|
518
|
+
expanded?: boolean;
|
|
519
|
+
minimalistView?: boolean;
|
|
520
|
+
}
|
|
521
521
|
export interface ArrayProperty extends BaseProperty {
|
|
522
|
+
ui?: ArrayUIConfig;
|
|
522
523
|
type: "array";
|
|
523
524
|
/**
|
|
524
525
|
* Optional database column type. Defaults to `jsonb`.
|
|
@@ -573,15 +574,6 @@ export interface ArrayProperty extends BaseProperty {
|
|
|
573
574
|
* Rules for validating this property
|
|
574
575
|
*/
|
|
575
576
|
validation?: ArrayPropertyValidationSchema;
|
|
576
|
-
/**
|
|
577
|
-
* Should the field be initially expanded. Defaults to `true`
|
|
578
|
-
*/
|
|
579
|
-
expanded?: boolean;
|
|
580
|
-
/**
|
|
581
|
-
* Display the child properties directly, without being wrapped in an
|
|
582
|
-
* extendable panel.
|
|
583
|
-
*/
|
|
584
|
-
minimalistView?: boolean;
|
|
585
577
|
/**
|
|
586
578
|
* Can the elements in this array be reordered. Defaults to `true`.
|
|
587
579
|
* This prop has no effect if `disabled` is set to true.
|
|
@@ -596,7 +588,13 @@ export interface ArrayProperty extends BaseProperty {
|
|
|
596
588
|
/**
|
|
597
589
|
* @group Entity properties
|
|
598
590
|
*/
|
|
591
|
+
export interface MapUIConfig extends BaseUIConfig {
|
|
592
|
+
expanded?: boolean;
|
|
593
|
+
minimalistView?: boolean;
|
|
594
|
+
spreadChildren?: boolean;
|
|
595
|
+
}
|
|
599
596
|
export interface MapProperty extends BaseProperty {
|
|
597
|
+
ui?: MapUIConfig;
|
|
600
598
|
type: "map";
|
|
601
599
|
/**
|
|
602
600
|
* Optional database column type. Defaults to `jsonb`.
|
|
@@ -630,20 +628,6 @@ export interface MapProperty extends BaseProperty {
|
|
|
630
628
|
* needed
|
|
631
629
|
*/
|
|
632
630
|
pickOnlySomeKeys?: boolean;
|
|
633
|
-
/**
|
|
634
|
-
* Display the child properties as independent columns in the collection
|
|
635
|
-
* view
|
|
636
|
-
*/
|
|
637
|
-
spreadChildren?: boolean;
|
|
638
|
-
/**
|
|
639
|
-
* Display the child properties directly, without being wrapped in an
|
|
640
|
-
* extendable panel. Note that this will also hide the title of this property.
|
|
641
|
-
*/
|
|
642
|
-
minimalistView?: boolean;
|
|
643
|
-
/**
|
|
644
|
-
* Should the field be initially expanded. Defaults to `true`
|
|
645
|
-
*/
|
|
646
|
-
expanded?: boolean;
|
|
647
631
|
/**
|
|
648
632
|
* Render this map as a key-value table that allows to use
|
|
649
633
|
* arbitrary keys. You don't need to define the properties in this case.
|
|
@@ -100,7 +100,8 @@ export interface NavigationSlotProps {
|
|
|
100
100
|
export interface CollectionToolbarProps {
|
|
101
101
|
path: string;
|
|
102
102
|
collection: EntityCollection;
|
|
103
|
-
|
|
103
|
+
parentCollectionSlugs: string[];
|
|
104
|
+
parentEntityIds: string[];
|
|
104
105
|
tableController: EntityTableController;
|
|
105
106
|
selectionController: SelectionController;
|
|
106
107
|
}
|
|
@@ -111,7 +112,8 @@ export interface CollectionToolbarProps {
|
|
|
111
112
|
export interface CollectionEmptyStateProps {
|
|
112
113
|
path: string;
|
|
113
114
|
collection: EntityCollection;
|
|
114
|
-
|
|
115
|
+
parentCollectionSlugs: string[];
|
|
116
|
+
parentEntityIds: string[];
|
|
115
117
|
canCreate: boolean;
|
|
116
118
|
onNewClick?: () => void;
|
|
117
119
|
}
|
|
@@ -123,7 +125,8 @@ export interface CollectionHeaderActionProps {
|
|
|
123
125
|
property: Property;
|
|
124
126
|
propertyKey: string;
|
|
125
127
|
path: string;
|
|
126
|
-
|
|
128
|
+
parentCollectionSlugs: string[];
|
|
129
|
+
parentEntityIds: string[];
|
|
127
130
|
onHover: boolean;
|
|
128
131
|
collection: EntityCollection;
|
|
129
132
|
tableController: EntityTableController;
|
|
@@ -134,7 +137,8 @@ export interface CollectionHeaderActionProps {
|
|
|
134
137
|
*/
|
|
135
138
|
export interface CollectionAddColumnProps {
|
|
136
139
|
path: string;
|
|
137
|
-
|
|
140
|
+
parentCollectionSlugs: string[];
|
|
141
|
+
parentEntityIds: string[];
|
|
138
142
|
collection: EntityCollection;
|
|
139
143
|
tableController: EntityTableController;
|
|
140
144
|
}
|
|
@@ -145,7 +149,8 @@ export interface CollectionAddColumnProps {
|
|
|
145
149
|
export interface CollectionErrorProps {
|
|
146
150
|
path: string;
|
|
147
151
|
collection: EntityCollection;
|
|
148
|
-
|
|
152
|
+
parentCollectionSlugs?: string[];
|
|
153
|
+
parentEntityIds?: string[];
|
|
149
154
|
error: Error;
|
|
150
155
|
}
|
|
151
156
|
/**
|
|
@@ -155,7 +160,8 @@ export interface CollectionErrorProps {
|
|
|
155
160
|
export interface KanbanSetupProps {
|
|
156
161
|
collection: EntityCollection;
|
|
157
162
|
fullPath: string;
|
|
158
|
-
|
|
163
|
+
parentCollectionSlugs: string[];
|
|
164
|
+
parentEntityIds: string[];
|
|
159
165
|
}
|
|
160
166
|
/**
|
|
161
167
|
* Props for the `kanban.add-column` slot.
|
|
@@ -164,7 +170,8 @@ export interface KanbanSetupProps {
|
|
|
164
170
|
export interface KanbanAddColumnProps {
|
|
165
171
|
collection: EntityCollection;
|
|
166
172
|
fullPath: string;
|
|
167
|
-
|
|
173
|
+
parentCollectionSlugs: string[];
|
|
174
|
+
parentEntityIds: string[];
|
|
168
175
|
columnProperty: string;
|
|
169
176
|
}
|
|
170
177
|
/**
|
|
@@ -177,7 +184,8 @@ export interface EntityRowActionsProps {
|
|
|
177
184
|
entityId: string;
|
|
178
185
|
path: string;
|
|
179
186
|
collection: EntityCollection;
|
|
180
|
-
|
|
187
|
+
parentCollectionSlugs: string[];
|
|
188
|
+
parentEntityIds: string[];
|
|
181
189
|
selectionController: SelectionController;
|
|
182
190
|
context: RebaseContext;
|
|
183
191
|
}
|
|
@@ -202,7 +210,8 @@ export interface EntityFieldSlotProps {
|
|
|
202
210
|
export interface CollectionFilterPanelProps {
|
|
203
211
|
path: string;
|
|
204
212
|
collection: EntityCollection;
|
|
205
|
-
|
|
213
|
+
parentCollectionSlugs: string[];
|
|
214
|
+
parentEntityIds: string[];
|
|
206
215
|
tableController: EntityTableController;
|
|
207
216
|
context: RebaseContext;
|
|
208
217
|
}
|
|
@@ -238,7 +247,8 @@ export interface ShellToolbarProps {
|
|
|
238
247
|
export interface CollectionInsightsSlotProps {
|
|
239
248
|
path: string;
|
|
240
249
|
collection: EntityCollection;
|
|
241
|
-
|
|
250
|
+
parentCollectionSlugs: string[];
|
|
251
|
+
parentEntityIds: string[];
|
|
242
252
|
}
|
|
243
253
|
/**
|
|
244
254
|
* Props for `home.card.insight` slot.
|