@rebasepro/server-postgresql 0.0.1-canary.f81da60 → 0.1.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.
- package/dist/index.es.js +287 -21
- package/dist/index.es.js.map +1 -1
- package/dist/index.umd.js +287 -21
- package/dist/index.umd.js.map +1 -1
- package/dist/server-postgresql/src/PostgresBackendDriver.d.ts +2 -1
- 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/types/src/controllers/auth.d.ts +8 -2
- package/dist/types/src/controllers/client.d.ts +13 -0
- 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/collections.d.ts +20 -1
- package/dist/types/src/types/component_ref.d.ts +47 -0
- package/dist/types/src/types/entity_views.d.ts +2 -1
- package/dist/types/src/types/index.d.ts +1 -0
- package/dist/types/src/types/properties.d.ts +15 -3
- package/dist/types/src/types/translations.d.ts +2 -0
- package/examples/sdk-demo/node_modules/esbuild/LICENSE.md +21 -0
- package/examples/sdk-demo/node_modules/esbuild/README.md +3 -0
- package/examples/sdk-demo/node_modules/esbuild/bin/esbuild +223 -0
- package/examples/sdk-demo/node_modules/esbuild/install.js +289 -0
- package/examples/sdk-demo/node_modules/esbuild/lib/main.d.ts +716 -0
- package/examples/sdk-demo/node_modules/esbuild/lib/main.js +2242 -0
- package/examples/sdk-demo/node_modules/esbuild/package.json +49 -0
- package/package.json +5 -5
- package/src/PostgresBackendDriver.ts +23 -6
- package/src/cli.ts +10 -2
- package/src/data-transformer.ts +84 -1
- package/src/schema/doctor.ts +14 -2
- package/src/schema/generate-drizzle-schema-logic.ts +52 -5
- 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 +88 -12
- package/test/generate-drizzle-schema.test.ts +295 -0
- package/test/introspect-db-generation.test.ts +32 -10
- package/test/property-ordering.test.ts +395 -0
- 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
|
@@ -3,7 +3,7 @@ import { BranchService } from "./services/BranchService";
|
|
|
3
3
|
import { RealtimeService } from "./services/realtimeService";
|
|
4
4
|
import { DatabasePoolManager } from "./databasePoolManager";
|
|
5
5
|
import { DrizzleClient } from "./interfaces";
|
|
6
|
-
import { User } from "@rebasepro/types";
|
|
6
|
+
import { User, RebaseClient } from "@rebasepro/types";
|
|
7
7
|
import { PostgresCollectionRegistry } from "./collections/PostgresCollectionRegistry";
|
|
8
8
|
import { DataDriver, DeleteEntityProps, Entity, EntityCollection, FetchCollectionProps, FetchEntityProps, ListenCollectionProps, ListenEntityProps, SaveEntityProps, RebaseData, TableMetadata, DatabaseAdmin } from "@rebasepro/types";
|
|
9
9
|
import { HistoryService } from "./history/HistoryService";
|
|
@@ -19,6 +19,7 @@ export declare class PostgresBackendDriver implements DataDriver {
|
|
|
19
19
|
branchService?: BranchService;
|
|
20
20
|
user?: User;
|
|
21
21
|
data: RebaseData;
|
|
22
|
+
client?: RebaseClient;
|
|
22
23
|
/**
|
|
23
24
|
* When true, realtime notifications are deferred until after the
|
|
24
25
|
* wrapping transaction commits. Set by `withAuth` → `withTransaction`.
|
|
@@ -1,11 +1,3 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Introspection logic — pure functions and the pipeline that transforms
|
|
3
|
-
* raw PostgreSQL metadata into Rebase collection definition files.
|
|
4
|
-
*
|
|
5
|
-
* This module contains NO side-effects: no fs writes, no pg.Client creation,
|
|
6
|
-
* no process.exit. It is imported by introspect-db.ts (the CLI entry-point)
|
|
7
|
-
* and consumed directly by tests.
|
|
8
|
-
*/
|
|
9
1
|
export interface TableRow {
|
|
10
2
|
table_name: string;
|
|
11
3
|
}
|
|
@@ -57,6 +49,49 @@ export declare function mapPgType(dataType: string): string;
|
|
|
57
49
|
export declare function buildEnumMap(enumValues: EnumValue[]): Map<string, string[]>;
|
|
58
50
|
export declare function buildTablesMap(tables: TableRow[], columns: TableColumn[], pks: PrimaryKeyRow[], fks: ForeignKeyRow[]): Map<string, TableMeta>;
|
|
59
51
|
export declare function identifyJoinTables(tablesMap: Map<string, TableMeta>): Set<string>;
|
|
52
|
+
/**
|
|
53
|
+
* Property metadata used to compute display priority.
|
|
54
|
+
* Keeps computePropertyPriority free of any TableMeta coupling.
|
|
55
|
+
*/
|
|
56
|
+
export interface PropertyOrderingContext {
|
|
57
|
+
/** The resolved Rebase property type (e.g. "string", "number", "date", "relation"). */
|
|
58
|
+
propType: string;
|
|
59
|
+
/** Whether this column is a primary key. */
|
|
60
|
+
isPk: boolean;
|
|
61
|
+
/** Whether this column is an enum (USER-DEFINED with matching values). */
|
|
62
|
+
isEnum: boolean;
|
|
63
|
+
/** Whether this is a storage/file-upload field (detected from column name). */
|
|
64
|
+
isStorage: boolean;
|
|
65
|
+
/** The PostgreSQL data_type (e.g. "text", "character varying", "jsonb"). */
|
|
66
|
+
pgDataType: string;
|
|
67
|
+
/** The original column index in PostgreSQL (for stable tiebreaking). */
|
|
68
|
+
originalIndex: number;
|
|
69
|
+
}
|
|
70
|
+
/**
|
|
71
|
+
* Compute a numeric priority score for a property.
|
|
72
|
+
* Lower scores appear first in the generated `propertiesOrder` array.
|
|
73
|
+
*
|
|
74
|
+
* The system uses 14 tiers (0–139), with the original column index
|
|
75
|
+
* added as a fractional tiebreaker (originalIndex / 10000) to
|
|
76
|
+
* guarantee stable ordering within the same tier.
|
|
77
|
+
*
|
|
78
|
+
* Pure function — no side effects.
|
|
79
|
+
*/
|
|
80
|
+
export declare function computePropertyPriority(columnName: string, ctx: PropertyOrderingContext): number;
|
|
81
|
+
/**
|
|
82
|
+
* Sort a `propertiesOrder` array using the priority heuristic.
|
|
83
|
+
* Returns a new sorted array; does not mutate the input.
|
|
84
|
+
*
|
|
85
|
+
* @param entries - Array of { key, columnName, propType, ... } objects
|
|
86
|
+
* carrying the information needed to compute priority.
|
|
87
|
+
*/
|
|
88
|
+
export interface PropertyOrderEntry {
|
|
89
|
+
/** The property key in the generated collection (may differ from columnName for relations). */
|
|
90
|
+
key: string;
|
|
91
|
+
/** The ordering context for this property. */
|
|
92
|
+
ctx: PropertyOrderingContext;
|
|
93
|
+
}
|
|
94
|
+
export declare function sortPropertiesOrder(entries: PropertyOrderEntry[]): string[];
|
|
60
95
|
export interface GeneratedFile {
|
|
61
96
|
tableName: string;
|
|
62
97
|
fileName: string;
|
|
@@ -66,7 +101,7 @@ export interface GeneratedFile {
|
|
|
66
101
|
* Generate the full TypeScript file content for a single collection.
|
|
67
102
|
* Pure function — no I/O.
|
|
68
103
|
*/
|
|
69
|
-
export declare function generateCollectionFile(tableName: string, meta: TableMeta, allFks: ForeignKeyRow[], joinTables: Set<string>, tablesMap: Map<string, TableMeta>, enumMap: Map<string, string[]>): string;
|
|
104
|
+
export declare function generateCollectionFile(tableName: string, meta: TableMeta, allFks: ForeignKeyRow[], joinTables: Set<string>, tablesMap: Map<string, TableMeta>, enumMap: Map<string, string[]>, sampleData?: Record<string, unknown>[]): string;
|
|
70
105
|
/**
|
|
71
106
|
* Generate the content for an index.ts file that re-exports all collections.
|
|
72
107
|
*/
|
|
@@ -33,6 +33,15 @@ export declare class EntityPersistService {
|
|
|
33
33
|
* Translate raw PostgreSQL / Drizzle errors into user-friendly messages.
|
|
34
34
|
*/
|
|
35
35
|
private toUserFriendlyError;
|
|
36
|
+
/**
|
|
37
|
+
* Walk the error cause chain and return the deepest meaningful message.
|
|
38
|
+
*/
|
|
39
|
+
private extractCauseMessage;
|
|
40
|
+
/**
|
|
41
|
+
* Strip the raw SQL query from a Drizzle "Failed query: ..." message,
|
|
42
|
+
* keeping only the error description.
|
|
43
|
+
*/
|
|
44
|
+
private stripSqlFromMessage;
|
|
36
45
|
/**
|
|
37
46
|
* Extract the underlying PostgreSQL error from a Drizzle wrapper.
|
|
38
47
|
* Drizzle wraps PG errors in a `cause` property.
|
|
@@ -80,8 +80,14 @@ export type AuthController<USER extends User = User, ExtraData = unknown> = {
|
|
|
80
80
|
export interface AuthControllerExtended<USER extends User = User, ExtraData = unknown> extends AuthController<USER, ExtraData> {
|
|
81
81
|
/** Login with email and password */
|
|
82
82
|
emailPasswordLogin?(email: string, password: string): Promise<void>;
|
|
83
|
-
/** Login with a Google token
|
|
84
|
-
googleLogin
|
|
83
|
+
/** Login with a Google token or authorization code */
|
|
84
|
+
googleLogin?: {
|
|
85
|
+
(token: string, tokenType?: "idToken" | "accessToken"): Promise<void>;
|
|
86
|
+
(payload: {
|
|
87
|
+
code: string;
|
|
88
|
+
redirectUri: string;
|
|
89
|
+
}): Promise<void>;
|
|
90
|
+
};
|
|
85
91
|
/** Register a new user */
|
|
86
92
|
register?(email: string, password: string, displayName?: string): Promise<void>;
|
|
87
93
|
/** Skip login (for anonymous access if enabled) */
|
|
@@ -167,4 +167,17 @@ export interface RebaseClient<DB = unknown> {
|
|
|
167
167
|
email?: EmailService;
|
|
168
168
|
/** Admin API for user and role management */
|
|
169
169
|
admin?: AdminAPI;
|
|
170
|
+
/**
|
|
171
|
+
* The base HTTP URL of the backend server.
|
|
172
|
+
* Exposed by the SDK client (`@rebasepro/client`) and used to auto-derive
|
|
173
|
+
* the `ApiConfigProvider` URL.
|
|
174
|
+
*/
|
|
175
|
+
baseUrl?: string;
|
|
176
|
+
/**
|
|
177
|
+
* WebSocket client for realtime subscriptions and admin capabilities.
|
|
178
|
+
* Exposed by the SDK client (`@rebasepro/client`). The shape is intentionally
|
|
179
|
+
* left as `unknown` in the base interface — callers should narrow via feature
|
|
180
|
+
* detection (e.g. `typeof ws.executeSql === "function"`).
|
|
181
|
+
*/
|
|
182
|
+
ws?: unknown;
|
|
170
183
|
}
|
|
@@ -144,17 +144,18 @@ export interface AppView {
|
|
|
144
144
|
* It will still be accessible if you reach the specified path
|
|
145
145
|
*/
|
|
146
146
|
hideFromNavigation?: boolean;
|
|
147
|
+
/**
|
|
148
|
+
* Navigation group for this view.
|
|
149
|
+
* Views sharing the same group name will be visually grouped
|
|
150
|
+
* together in the drawer and home page. If not set, the view
|
|
151
|
+
* falls into the default "Views" group.
|
|
152
|
+
*/
|
|
153
|
+
group?: string;
|
|
147
154
|
/**
|
|
148
155
|
* Component to be rendered. This can be any React component, and can use
|
|
149
156
|
* any of the provided hooks
|
|
150
157
|
*/
|
|
151
158
|
view: React.ReactNode;
|
|
152
|
-
/**
|
|
153
|
-
* Optional field used to group top level navigation entries under a
|
|
154
|
-
* navigation view.
|
|
155
|
-
* This prop is ignored for admin views.
|
|
156
|
-
*/
|
|
157
|
-
group?: string;
|
|
158
159
|
/**
|
|
159
160
|
* If true, a wildcard route (slug/*) is automatically registered
|
|
160
161
|
* alongside the base route, enabling nested navigation within this view.
|
|
@@ -193,6 +194,17 @@ export interface NavigationGroupMapping {
|
|
|
193
194
|
* List of collection ids or view paths that belong to this group.
|
|
194
195
|
*/
|
|
195
196
|
entries: string[];
|
|
197
|
+
/**
|
|
198
|
+
* Configure which groups start collapsed.
|
|
199
|
+
* Set to `true` to collapse in both drawer and home page,
|
|
200
|
+
* or use an object to control each independently.
|
|
201
|
+
*
|
|
202
|
+
* @defaultValue false (expanded)
|
|
203
|
+
*/
|
|
204
|
+
collapsedByDefault?: boolean | {
|
|
205
|
+
drawer?: boolean;
|
|
206
|
+
home?: boolean;
|
|
207
|
+
};
|
|
196
208
|
}
|
|
197
209
|
export interface NavigationEntry {
|
|
198
210
|
id: string;
|
|
@@ -3,7 +3,7 @@ import type { EntityCollection } from "../types/collections";
|
|
|
3
3
|
import type { EntityCollectionsBuilder } from "../types/builders";
|
|
4
4
|
import type { EntityCustomView } from "../types/entity_views";
|
|
5
5
|
import type { EntityAction } from "../types/entity_actions";
|
|
6
|
-
import type { AppView } from "./navigation";
|
|
6
|
+
import type { AppView, NavigationGroupMapping } from "./navigation";
|
|
7
7
|
/**
|
|
8
8
|
* Options to enable the built-in collection editor.
|
|
9
9
|
* When provided to `<RebaseCMS>`, the editor is auto-wired as a native feature.
|
|
@@ -25,6 +25,14 @@ export interface RebaseCMSConfig<EC extends EntityCollection = any> {
|
|
|
25
25
|
entityViews?: EntityCustomView<any>[];
|
|
26
26
|
entityActions?: EntityAction[];
|
|
27
27
|
plugins?: any[];
|
|
28
|
+
/**
|
|
29
|
+
* Centralized configuration for how collections and views are grouped
|
|
30
|
+
* in the navigation sidebar and home page.
|
|
31
|
+
* Each mapping defines a named group and the collection/view slugs
|
|
32
|
+
* that belong to it. The array order determines group display order.
|
|
33
|
+
* Entry order within each group determines card order.
|
|
34
|
+
*/
|
|
35
|
+
navigationGroupMappings?: NavigationGroupMapping[];
|
|
28
36
|
/**
|
|
29
37
|
* Enable the built-in visual collection/schema editor.
|
|
30
38
|
* Pass `true` for zero-config, or an options object for fine-grained control.
|
|
@@ -62,6 +62,13 @@ export interface EntitySidePanelProps<M extends Record<string, unknown> = Record
|
|
|
62
62
|
* Allow the user to open the entity fullscreen
|
|
63
63
|
*/
|
|
64
64
|
allowFullScreen?: boolean;
|
|
65
|
+
/**
|
|
66
|
+
* Pre-populate the form with these values when creating a new entity.
|
|
67
|
+
* Only applied when `entityId` is not set (i.e. the form is in "new" mode).
|
|
68
|
+
* Useful for actions that fetch data from an external source (e.g. a URL)
|
|
69
|
+
* and want to pre-fill the document before the user saves.
|
|
70
|
+
*/
|
|
71
|
+
defaultValues?: Partial<M>;
|
|
65
72
|
}
|
|
66
73
|
/**
|
|
67
74
|
* Controller to open the side dialog displaying entity forms
|
|
@@ -3,6 +3,7 @@ import type { AuthController } from "./controllers/auth";
|
|
|
3
3
|
import type { StorageSource } from "./controllers/storage";
|
|
4
4
|
import type { UserConfigurationPersistence } from "./controllers/local_config_persistence";
|
|
5
5
|
import type { DatabaseAdmin } from "./types/backend";
|
|
6
|
+
import type { RebaseClient } from "./controllers/client";
|
|
6
7
|
import type { RebaseData } from "./controllers/data";
|
|
7
8
|
import type { User } from "./users";
|
|
8
9
|
import type { UserManagementDelegate } from "./types/user_management_delegate";
|
|
@@ -12,6 +13,22 @@ import type { UserManagementDelegate } from "./types/user_management_delegate";
|
|
|
12
13
|
* @group Hooks and utilities
|
|
13
14
|
*/
|
|
14
15
|
export type RebaseCallContext<USER extends User = User> = {
|
|
16
|
+
/**
|
|
17
|
+
* The Rebase client instance.
|
|
18
|
+
* Available in all entity callbacks (beforeSave, afterSave, afterRead,
|
|
19
|
+
* beforeDelete, afterDelete) and in CollectionActionsProps via context.
|
|
20
|
+
* Use it to call backend functions, access data, storage, etc.
|
|
21
|
+
*
|
|
22
|
+
* @example
|
|
23
|
+
* // In a beforeSave callback:
|
|
24
|
+
* const result = await context.client.functions.invoke('my-function', { ... });
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* // In a CollectionAction component:
|
|
28
|
+
* const { client } = props.context;
|
|
29
|
+
* const result = await client.functions.invoke('extract-job', { url });
|
|
30
|
+
*/
|
|
31
|
+
client: RebaseClient<any>;
|
|
15
32
|
/**
|
|
16
33
|
* Unified data access — `context.data.products.create(...)`.
|
|
17
34
|
* Access any collection as a dynamic property.
|
|
@@ -9,6 +9,7 @@ import type { RebaseContext } from "../rebase_context";
|
|
|
9
9
|
import type { Relation } from "./relations";
|
|
10
10
|
import type { EntityCustomView } from "./entity_views";
|
|
11
11
|
import type { EntityAction } from "./entity_actions";
|
|
12
|
+
import type { ComponentRef } from "./component_ref";
|
|
12
13
|
/**
|
|
13
14
|
* Base interface containing all driver-agnostic collection properties.
|
|
14
15
|
* Use {@link PostgresCollection} or {@link FirebaseCollection} for
|
|
@@ -86,6 +87,9 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
|
|
|
86
87
|
icon?: string | React.ReactNode;
|
|
87
88
|
/**
|
|
88
89
|
* Navigation group for this collection.
|
|
90
|
+
* Collections sharing the same group name will be visually grouped
|
|
91
|
+
* together in the drawer and home page. If not set, the collection
|
|
92
|
+
* falls into the default "Views" group.
|
|
89
93
|
*/
|
|
90
94
|
group?: string;
|
|
91
95
|
/**
|
|
@@ -301,7 +305,7 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
|
|
|
301
305
|
/**
|
|
302
306
|
* Builder for the collection actions rendered in the toolbar
|
|
303
307
|
*/
|
|
304
|
-
Actions?:
|
|
308
|
+
Actions?: ComponentRef<CollectionActionsProps>[];
|
|
305
309
|
}
|
|
306
310
|
/**
|
|
307
311
|
* A collection backed by PostgreSQL (or any SQL database).
|
|
@@ -482,6 +486,21 @@ export interface CollectionActionsProps<M extends Record<string, unknown> = Reco
|
|
|
482
486
|
* undefined means the count is still loading.
|
|
483
487
|
*/
|
|
484
488
|
collectionEntitiesCount?: number;
|
|
489
|
+
/**
|
|
490
|
+
* Programmatically open the new-document form for this collection,
|
|
491
|
+
* optionally pre-populating it with initial field values.
|
|
492
|
+
* The form opens in the same mode configured for the collection
|
|
493
|
+
* (side panel, full screen, or split).
|
|
494
|
+
*
|
|
495
|
+
* This is the primary hook for workflows that need to create a document
|
|
496
|
+
* from external data — e.g. fetching content from a URL, importing from
|
|
497
|
+
* a third-party API, or duplicating from another system.
|
|
498
|
+
*
|
|
499
|
+
* @example
|
|
500
|
+
* // Inside a custom CollectionAction component:
|
|
501
|
+
* openNewDocument({ title: "Fetched title", body: "..." });
|
|
502
|
+
*/
|
|
503
|
+
openNewDocument: (defaultValues?: Record<string, unknown>) => void;
|
|
485
504
|
}
|
|
486
505
|
/**
|
|
487
506
|
* Use this controller to retrieve the selected entities or modify them in
|
|
@@ -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>;
|
|
@@ -2,6 +2,7 @@ import React from "react";
|
|
|
2
2
|
import type { Entity, EntityValues } from "./entities";
|
|
3
3
|
import type { EntityCollection } from "./collections";
|
|
4
4
|
import type { FormexController } from "./formex";
|
|
5
|
+
import type { ComponentRef } from "./component_ref";
|
|
5
6
|
/**
|
|
6
7
|
* Context passed to custom fields and entity views.
|
|
7
8
|
* @group Form custom fields
|
|
@@ -46,7 +47,7 @@ export type EntityCustomView<M extends Record<string, unknown> = Record<string,
|
|
|
46
47
|
name: string;
|
|
47
48
|
tabComponent?: React.ReactNode;
|
|
48
49
|
includeActions?: boolean | "bottom";
|
|
49
|
-
Builder?:
|
|
50
|
+
Builder?: ComponentRef<EntityCustomViewParams<M>>;
|
|
50
51
|
position?: "start" | "end";
|
|
51
52
|
};
|
|
52
53
|
export interface EntityCustomViewParams<M extends Record<string, unknown> = Record<string, unknown>> {
|
|
@@ -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";
|
|
@@ -104,8 +104,8 @@ export interface BaseUIConfig<CustomProps = unknown> {
|
|
|
104
104
|
disabled?: boolean | PropertyDisabledConfig;
|
|
105
105
|
widthPercentage?: number;
|
|
106
106
|
customProps?: CustomProps;
|
|
107
|
-
Field?:
|
|
108
|
-
Preview?:
|
|
107
|
+
Field?: ComponentRef<any>;
|
|
108
|
+
Preview?: ComponentRef<any>;
|
|
109
109
|
}
|
|
110
110
|
export interface BaseProperty<CustomProps = unknown> {
|
|
111
111
|
ui?: BaseUIConfig<CustomProps>;
|
|
@@ -124,6 +124,18 @@ export interface BaseProperty<CustomProps = unknown> {
|
|
|
124
124
|
* overwritten by the current property config.
|
|
125
125
|
*/
|
|
126
126
|
propertyConfig?: string;
|
|
127
|
+
/**
|
|
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()`.
|
|
137
|
+
*/
|
|
138
|
+
columnName?: string;
|
|
127
139
|
/**
|
|
128
140
|
* Rules for validating this property
|
|
129
141
|
*/
|
|
@@ -51,6 +51,8 @@ export interface RebaseTranslations {
|
|
|
51
51
|
all_entries_loaded: string;
|
|
52
52
|
create_your_first_entry: string;
|
|
53
53
|
no_results_filter_sort: string;
|
|
54
|
+
/** Shown when a text search yields no results. Supports `{{search}}` interpolation. */
|
|
55
|
+
no_results_search?: string;
|
|
54
56
|
add: string;
|
|
55
57
|
remove: string;
|
|
56
58
|
copy_id: string;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Evan Wallace
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|