remult 3.0.6-next.1 → 3.0.6

package/esm/graphql.js

@@ -479,7 +479,7 @@ export function remultGraphql(options) {
                             currentType.fields.push({
                                 key: f.key,
                                 value: `${getMetaType(ref)}${f.allowNull ? '' : '!'}`,
-                                comment: f.caption,
+                                comment: f.label,
                             });
                             currentType.query.resultProcessors.push((r, orig) => {
                                 r[f.key] = async (args, req, gqlInfo) => {
@@ -524,7 +524,7 @@ export function remultGraphql(options) {
                     currentType.fields.push({
                         key: f.key,
                         value: `${getMetaType(ref)}${f.allowNull ? '' : '!'}`,
-                        comment: f.caption,
+                        comment: f.label,
                     });
                     const refKey = ref.key;
                     currentType.query.resultProcessors.push((r) => {
@@ -566,7 +566,7 @@ export function remultGraphql(options) {
                     currentType.fields.push({
                         key: f.key,
                         value: `${type}${f.allowNull ? '' : '!'}`,
-                        comment: f.caption,
+                        comment: f.label,
                     });
                 }
                 // sorting

package/esm/index.js

@@ -1,5 +1,11 @@
 export { ArrayEntityDataProvider } from './src/data-providers/array-entity-data-provider.js';
-export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListInfo, CaptionTransformer, } from './src/remult3/RepositoryImplementation.js';
+export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListInfo, } from './src/remult3/RepositoryImplementation.js';
+import { LabelTransformer } from './src/remult3/RepositoryImplementation.js';
+export { LabelTransformer } from './src/remult3/RepositoryImplementation.js';
+/**
+ * @deprecated use `LabelTransformer` instead
+ */
+export const CaptionTransformer = LabelTransformer;
 export { Entity } from './src/remult3/entity.js';
 export { getEntityRef } from './src/remult3/getEntityRef.js';
 export { Field, Fields, Relations, } from './src/remult3/Fields.js';

package/esm/remult-d1-http.js

@@ -0,0 +1,32 @@
+import Cloudflare from 'cloudflare';
+import { SqlDatabase } from './index.js';
+import { D1DataProvider } from './remult-d1.js';
+export { D1DataProvider };
+export function createD1HttpDataProvider(creds) {
+    return new SqlDatabase(new D1DataProvider(new D1HttpClient(creds)));
+}
+export class D1HttpClient {
+    d1;
+    accountId;
+    databaseId;
+    constructor({ accountId, databaseId, apiToken }) {
+        this.d1 = new Cloudflare({ apiToken }).d1.database;
+        this.accountId = accountId;
+        this.databaseId = databaseId;
+    }
+    async execute(sql, params = []) {
+        return this.d1
+            .query(this.databaseId, {
+            sql,
+            params: params,
+            account_id: this.accountId,
+        })
+            .then(({ result: pages }) => pages.flatMap((page) => page.results));
+        // NOTE: d1 query endpoint returns the result as array of object with keys as column names.
+        // We're returning that now because the rest of remult seems to expect that.
+        // D1 also has a more efficient raw() endpoint that returns {columns: string[], rows: any[][]} that we may want
+        // to use eventually, and write code like fromRowToSql()
+        // at https://github.com/tursodatabase/libsql-client-ts/blob/main/packages/libsql-client/src/sqlite3.ts#L398
+        // to adapt the data
+    }
+}

package/esm/remult-d1.js

@@ -0,0 +1,90 @@
+/// <reference types="@cloudflare/workers-types" />
+import { SqlDatabase, } from './index.js';
+import { SqliteCoreDataProvider } from './remult-sqlite-core.js';
+export function createD1DataProvider(d1) {
+    return new SqlDatabase(new D1DataProvider(new D1BindingClient(d1)));
+}
+export class D1DataProvider extends SqliteCoreDataProvider {
+    d1;
+    /**
+     * For production or local d1 using binding
+     *
+     * const dataProvider = new SqlDatabase(new D1DataProvider(new D1BindingClient(d1)))
+     */
+    constructor(d1) {
+        super(() => new D1Command(this.d1), async () => {
+            // afaik: d1 connection doesn't need closing,
+            // so this is just a noop
+        });
+        this.d1 = d1;
+    }
+    async transaction(action) {
+        // As of June 2025, D1 doesn't support transactions
+        // Here we simply run the action without wrapping it in a transaction
+        // It means queries in action() will be run individually (this is the same decision prisma made)
+        await action(this);
+    }
+}
+export class D1BindingClient {
+    d1;
+    /**
+     * Simple d1 client that wraps the d1 binding directly
+     *
+     * const d1 = new D1BindingClient(env.DB)
+     */
+    constructor(d1) {
+        this.d1 = d1;
+    }
+    async execute(sql, params = []) {
+        // https://developers.cloudflare.com/d1/worker-api/d1-database/
+        // https://developers.cloudflare.com/d1/worker-api/prepared-statements/
+        //
+        // Note: see if we should eventually take advantage of the raw() end point too.
+        const { results } = await this.d1
+            .prepare(sql)
+            .bind(...params)
+            .run();
+        return results;
+    }
+}
+class D1Command {
+    d1;
+    params = [];
+    constructor(d1) {
+        this.d1 = d1;
+    }
+    async execute(sql) {
+        const results = await this.d1.execute(sql, this.params);
+        return new D1SqlResult(results);
+    }
+    /** @deprecated use `param` instead*/
+    addParameterAndReturnSqlToken(val) {
+        return this.param(val);
+    }
+    param(val) {
+        let p;
+        if (val instanceof Date)
+            p = val.valueOf();
+        else if (typeof val === 'boolean')
+            p = val ? 1 : 0;
+        else
+            p = val;
+        this.params.push(p);
+        // According to https://developers.cloudflare.com/d1/worker-api/prepared-statements/
+        // only the ordered "?NNN" and anonymous "?" param types are supported (although :AAAA seems to work too)
+        const key = `?${this.params.length}`;
+        return key;
+    }
+}
+class D1SqlResult {
+    rows;
+    columns;
+    constructor(rows = []) {
+        this.rows = rows;
+        // NOTE: are we guaranteed that when this is reached, rows is not empty?
+        this.columns = rows.length === 0 ? [] : Object.keys(rows[0]);
+    }
+    getColumnKeyInResultForIndexInSelect(index) {
+        return this.columns[index];
+    }
+}

package/esm/server/remult-admin.js

@@ -8,7 +8,11 @@ export default function remultAdminHtml(options) {
     return getHtml()
         .replace('<!--PLACE_HERE_HEAD-->', head)
         .replace('<!--PLACE_HERE_BODY-->', `<script>
-  window.optionsFromServer = ${JSON.stringify({ rootPath, requireAuthToken, disableLiveQuery })}
+  window.optionsFromServer = ${JSON.stringify({
+        rootPath,
+        requireAuthToken,
+        disableLiveQuery,
+    })}
 </script>`);
 }
 export function buildEntityInfo(options) {
@@ -63,7 +67,7 @@ export function buildEntityInfo(options) {
                                 where,
                                 entityKey: relRepo.metadata.key,
                                 key: x.key,
-                                caption: x.caption,
+                                caption: x.label,
                             });
                         }
                         continue;
@@ -74,7 +78,7 @@ export function buildEntityInfo(options) {
                     readOnly: !x.apiUpdateAllowed(),
                     values: getValueList(x),
                     valFieldKey,
-                    caption: x.caption,
+                    caption: x.label,
                     relationToOne: relation,
                     inputType: x.inputType,
                     type: x.inputType === InputTypes.json
@@ -95,11 +99,11 @@ export function buildEntityInfo(options) {
         }
         if (metadata.apiReadAllowed) {
             let superKey = metadata.key;
-            let caption = metadata.caption;
+            let caption = metadata.label;
             const nbOfEntities = entities.filter((e) => e.key === metadata.key).length;
             if (nbOfEntities > 0) {
                 superKey = metadata.key + '_ext_' + nbOfEntities;
-                caption = metadata.caption + '*'.repeat(nbOfEntities);
+                caption = metadata.label + '*'.repeat(nbOfEntities);
             }
             entities.push({
                 superKey,

package/esm/src/CompoundIdField.js

@@ -46,6 +46,7 @@ export class CompoundIdField {
     dbReadOnly = false;
     isServerExpression = false;
     key = '';
+    label = '';
     caption = '';
     inputType = '';
     dbName = '';

package/esm/src/remult-static.js

@@ -19,7 +19,7 @@ let x = {
         }),
     },
     fieldOptionsEnricher: undefined,
-    captionTransformer: undefined,
+    labelTransformer: undefined,
     defaultDataProvider: () => undefined,
 };
 if ((typeof process !== 'undefined' &&

package/esm/src/remult3/RepositoryImplementation.js

@@ -1191,7 +1191,7 @@ class rowHelperBase {
             for (const col of this.fieldsMetadata) {
                 if (this.errors?.[col.key]) {
                     error.message =
-                        this.fields[col.key].metadata.caption +
+                        this.fields[col.key].metadata.label +
                             ': ' +
                             this.errors[col.key];
                     this.error = error.message;
@@ -1950,23 +1950,26 @@ export class FieldRefImplementation {
         return !!!this.error;
     }
 }
-let tempCaptionTransformer = {
-    transformCaption: (remult, key, caption, entityMetaData) => caption,
+let tempLabelTransformer = {
+    transformLabel: (remult, key, label, entityMetaData) => label,
+    set transformCaption(val) {
+        this.transformLabel = val;
+    },
 };
 export const fieldOptionsEnricher = remultStatic.fieldOptionsEnricher || {
     enrichFieldOptions: (options) => options,
 };
-export const CaptionTransformer = remultStatic.captionTransformer ||
-    (remultStatic.captionTransformer = tempCaptionTransformer);
-export function buildCaption(caption, key, remult, metaData) {
+export const LabelTransformer = remultStatic.labelTransformer ||
+    (remultStatic.labelTransformer = tempLabelTransformer);
+export function buildLabel(label, key, remult, metaData) {
     let result = undefined;
-    if (typeof caption === 'function') {
+    if (typeof label === 'function') {
         if (remult)
-            result = caption(remult);
+            result = label(remult);
     }
-    else if (caption)
-        result = caption;
-    result = CaptionTransformer.transformCaption(remult, key, result ?? '', metaData);
+    else if (label)
+        result = label;
+    result = LabelTransformer.transformLabel(remult, key, result ?? '', metaData);
     if (result)
         return result;
     if (key)
@@ -1994,7 +1997,7 @@ export class columnDefsImpl {
                         catch (err) {
                             const error = `${String(prop)} failed for value ${args?.[0]}. Error: ${typeof err === 'string' ? err : err.message}`;
                             throw new EntityError({
-                                message: this.caption + ': ' + error,
+                                message: this.label + ': ' + error,
                                 modelState: {
                                     [this.key]: error,
                                 },
@@ -2018,7 +2021,7 @@ export class columnDefsImpl {
         this.dbName = settings.dbName;
         if (this.dbName == undefined)
             this.dbName = settings.key;
-        this.caption = buildCaption(settings.caption, settings.key, remult, entityDefs);
+        this.label = buildLabel(settings.label ?? settings.caption, settings.key, remult, entityDefs);
     }
     apiUpdateAllowed(item) {
         if (this.options.allowApiUpdate === undefined)
@@ -2049,7 +2052,10 @@ export class columnDefsImpl {
     readonly = false;
     valueConverter;
     allowNull;
-    caption;
+    label;
+    get caption() {
+        return this.label;
+    }
     dbName;
     inputType;
     key;
@@ -2103,7 +2109,7 @@ class EntityFullInfo {
             this.fieldsMetadata.push((r[x.key] = new columnDefsImpl(x, this, remult)));
         }
         this.fields = r;
-        this.caption = buildCaption(entityInfo.caption, this.key, remult, this);
+        this.label = buildLabel(entityInfo.label ?? entityInfo.caption, this.key, remult, this);
         if (entityInfo.id) {
             let r = typeof entityInfo.id === 'string'
                 ? this.fields.find(entityInfo.id)
@@ -2218,7 +2224,10 @@ class EntityFullInfo {
     };
     fields;
     dbName;
-    caption;
+    label;
+    get caption() {
+        return this.label;
+    }
 }
 export function FieldType(...options) {
     return (target, context) => {
@@ -2238,7 +2247,7 @@ export function ValueListFieldType(...options) {
         FieldType((o) => {
             ;
             (o.valueConverter = ValueListInfo.get(type)),
-                (o.displayValue = (item, val) => val?.caption);
+                (o.displayValue = (item, val) => val?.label ?? val?.caption);
             o.validate = (entity, ref) => {
                 const values = ValueListInfo.get(type).getValues();
                 if (ref.value && !values.find((v) => v === ref.value)) {
@@ -2271,8 +2280,7 @@ export class ValueListInfo {
                     s.id = member;
                 if (typeof s.id === 'number')
                     this.isNumeric = true;
-                if (s.caption === undefined)
-                    s.caption = makeTitle(s.id !== undefined ? s.id.toString() : member);
+                setLabelAndCaption(s, member);
                 this.byIdMap.set(s.id, s);
                 this.values.push(s);
             }
@@ -2287,8 +2295,7 @@ export class ValueListInfo {
                     this.values.splice(0, this.values.length, ...op.getValues());
                     this.byIdMap.clear();
                     this.values.forEach((s) => {
-                        if (s.caption === undefined && s.id !== undefined)
-                            s.caption = makeTitle(s.id);
+                        setLabelAndCaption(s, '');
                         this.byIdMap.set(s.id, s);
                     });
                 }
@@ -2337,6 +2344,15 @@ export class ValueListInfo {
     inputType;
 }
 const typeCache = new Map();
+function setLabelAndCaption(s, member) {
+    let label = s.label ?? s.caption;
+    if (label === undefined)
+        label = makeTitle(s.id !== undefined ? s.id.toString() : member);
+    if (s.label === undefined)
+        s.label = label;
+    if (s.caption === undefined)
+        s.caption = label;
+}
 export function getValueList(type) {
     let meta = type?.metadata;
     if (!meta && isOfType(type, 'options'))

package/graphql.js

@@ -586,7 +586,7 @@ function remultGraphql(options) {
                             currentType.fields.push({
                                 key: f.key,
                                 value: "".concat(getMetaType(ref)).concat(f.allowNull ? '' : '!'),
-                                comment: f.caption,
+                                comment: f.label,
                             });
                             currentType.query.resultProcessors.push(function (r, orig) {
                                 r[f.key] = function (args, req, gqlInfo) { return tslib_1.__awaiter(_this, void 0, void 0, function () {
@@ -661,7 +661,7 @@ function remultGraphql(options) {
                     currentType.fields.push({
                         key: f.key,
                         value: "".concat(getMetaType(ref)).concat(f.allowNull ? '' : '!'),
-                        comment: f.caption,
+                        comment: f.label,
                     });
                     var refKey_1 = ref.key;
                     currentType.query.resultProcessors.push(function (r) {
@@ -713,7 +713,7 @@ function remultGraphql(options) {
                     currentType.fields.push({
                         key: f.key,
                         value: "".concat(type).concat(f.allowNull ? '' : '!'),
-                        comment: f.caption,
+                        comment: f.label,
                     });
                 }
                 // sorting

package/index.d.ts

@@ -4,7 +4,15 @@ export { ArrayEntityDataProvider } from './src/data-providers/array-entity-data-
 export type { ClassType } from './classType.js';
 export { ValidateFieldEvent, MembersOnly, NumericKeys, FieldsMetadata, FieldRef, IdFieldRef, FieldsRef, EntityMetadata, EntityOrderBy, EntityFilter, FindOptions, FindOptionsBase, QueryResult, QueryOptions, UpsertOptions, Repository, GroupByOptions, GroupByResult, FindFirstOptions, ComparisonValueFilter, ValueFilter, IdFilter, ContainsStringValueFilter, EntityRef, SortSegments, Paginator, LiveQuery, LiveQueryChangeInfo, Subscribable, RefSubscriber, RefSubscriberBase, RelationOptions, ObjectMembersOnly, MembersToInclude, RepositoryRelations, EntityIdFields, ClassFieldDecorator, ClassFieldDecoratorContextStub, //n1 consider removing in ts5
 LifecycleEvent, FieldsRefBase, FieldsRefForEntityBase, RepositoryRelationsForEntityBase, ControllerRefForControllerBase, ControllerRefBase, ControllerRef, EntityRefForEntityBase, IdMetadata, FindFirstOptionsBase, } from './src/remult3/remult3.js';
-export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListFieldOptions, ValueListInfo, CaptionTransformer, } from './src/remult3/RepositoryImplementation.js';
+export { EntityBase, ControllerBase, FieldType, getFields, ValueListFieldType, getValueList, ValueListFieldOptions, ValueListInfo, } from './src/remult3/RepositoryImplementation.js';
+export { LabelTransformer } from './src/remult3/RepositoryImplementation.js';
+/**
+ * @deprecated use `LabelTransformer` instead
+ */
+export declare const CaptionTransformer: {
+    transformLabel: (remult: import("./src/context.js").Remult, key: string, label: string, entityMetaData: import("./src/remult3/remult3.js").EntityMetadata<any>) => string;
+    transformCaption: (remult: import("./src/context.js").Remult, key: string, label: string, entityMetaData: import("./src/remult3/remult3.js").EntityMetadata<any>) => string;
+};
 export { Entity } from './src/remult3/entity.js';
 export { getEntityRef } from './src/remult3/getEntityRef.js';
 export { Field, Fields, StringFieldOptions, Relations, } from './src/remult3/Fields.js';

package/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscriptionChannel = exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.EntityError = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
+exports.InMemoryLiveQueryStorage = exports.remult = exports.ValueConverters = exports.createValueValidator = exports.createValueValidatorWithArgs = exports.createValidatorWithArgs = exports.createValidator = exports.valueValidator = exports.Validators = exports.UrlBuilder = exports.Filter = exports.CompoundIdField = exports.Sort = exports.EventSource = exports.isBackend = exports.withRemult = exports.Remult = exports.Allow = exports.ForbiddenError = exports.ProgressListener = exports.BackendMethod = exports.Controller = exports.JsonEntityIndexedDbStorage = exports.JsonEntityOpfsStorage = exports.JsonDataProvider = exports.dbNamesOf = exports.CustomSqlFilterBuilder = exports.SqlDatabase = exports.InMemoryDataProvider = exports.RestDataProvider = exports.EntityError = exports.describeEntity = exports.describeBackendMethods = exports.describeClass = exports.IdEntity = exports.Relations = exports.Fields = exports.Field = exports.getEntityRef = exports.Entity = exports.CaptionTransformer = exports.LabelTransformer = exports.ValueListInfo = exports.getValueList = exports.ValueListFieldType = exports.getFields = exports.FieldType = exports.ControllerBase = exports.EntityBase = exports.ArrayEntityDataProvider = void 0;
+exports.SubscriptionChannel = void 0;
 exports.repo = repo;
 var array_entity_data_provider_js_1 = require("./src/data-providers/array-entity-data-provider.js");
 Object.defineProperty(exports, "ArrayEntityDataProvider", { enumerable: true, get: function () { return array_entity_data_provider_js_1.ArrayEntityDataProvider; } });
@@ -12,7 +13,13 @@ Object.defineProperty(exports, "getFields", { enumerable: true, get: function ()
 Object.defineProperty(exports, "ValueListFieldType", { enumerable: true, get: function () { return RepositoryImplementation_js_1.ValueListFieldType; } });
 Object.defineProperty(exports, "getValueList", { enumerable: true, get: function () { return RepositoryImplementation_js_1.getValueList; } });
 Object.defineProperty(exports, "ValueListInfo", { enumerable: true, get: function () { return RepositoryImplementation_js_1.ValueListInfo; } });
-Object.defineProperty(exports, "CaptionTransformer", { enumerable: true, get: function () { return RepositoryImplementation_js_1.CaptionTransformer; } });
+var RepositoryImplementation_js_2 = require("./src/remult3/RepositoryImplementation.js");
+var RepositoryImplementation_js_3 = require("./src/remult3/RepositoryImplementation.js");
+Object.defineProperty(exports, "LabelTransformer", { enumerable: true, get: function () { return RepositoryImplementation_js_3.LabelTransformer; } });
+/**
+ * @deprecated use `LabelTransformer` instead
+ */
+exports.CaptionTransformer = RepositoryImplementation_js_2.LabelTransformer;
 var entity_js_1 = require("./src/remult3/entity.js");
 Object.defineProperty(exports, "Entity", { enumerable: true, get: function () { return entity_js_1.Entity; } });
 var getEntityRef_js_1 = require("./src/remult3/getEntityRef.js");

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "remult",
-    "version": "3.0.6-next.1",
+    "version": "3.0.6",
     "description": "A CRUD framework for full-stack TypeScript",
     "homepage": "https://remult.dev",
     "repository": {
@@ -131,6 +131,16 @@
             "import": "./esm/remult-duckdb.js",
             "types": "./remult-duckdb.d.ts"
         },
+        "./remult-d1": {
+            "require": "./remult-d1.js",
+            "import": "./esm/remult-d1.js",
+            "types": "./remult-d1.d.ts"
+        },
+        "./remult-d1-http": {
+            "require": "./remult-d1-http.js",
+            "import": "./esm/remult-d1-http.js",
+            "types": "./remult-d1-http.d.ts"
+        },
         "./remult-bun-sqlite": {
             "require": "./remult-bun-sqlite.js",
             "import": "./esm/remult-bun-sqlite.js",

package/remult-d1-http.d.ts

@@ -0,0 +1,16 @@
+import { SqlDatabase } from './index.js';
+import { type D1Client, D1DataProvider, type D1RowObject } from './remult-d1.js';
+export { D1DataProvider };
+type D1Credentials = {
+    accountId: string;
+    apiToken: string;
+    databaseId: string;
+};
+export declare function createD1HttpDataProvider(creds: D1Credentials): SqlDatabase;
+export declare class D1HttpClient implements D1Client {
+    private d1;
+    private accountId;
+    private databaseId;
+    constructor({ accountId, databaseId, apiToken }: D1Credentials);
+    execute(sql: string, params?: unknown[]): Promise<D1RowObject[]>;
+}

package/remult-d1-http.js

@@ -0,0 +1,46 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.D1HttpClient = exports.D1DataProvider = void 0;
+exports.createD1HttpDataProvider = createD1HttpDataProvider;
+var tslib_1 = require("tslib");
+var cloudflare_1 = tslib_1.__importDefault(require("cloudflare"));
+var index_js_1 = require("./index.js");
+var remult_d1_js_1 = require("./remult-d1.js");
+Object.defineProperty(exports, "D1DataProvider", { enumerable: true, get: function () { return remult_d1_js_1.D1DataProvider; } });
+function createD1HttpDataProvider(creds) {
+    return new index_js_1.SqlDatabase(new remult_d1_js_1.D1DataProvider(new D1HttpClient(creds)));
+}
+var D1HttpClient = /** @class */ (function () {
+    function D1HttpClient(_a) {
+        var accountId = _a.accountId, databaseId = _a.databaseId, apiToken = _a.apiToken;
+        this.d1 = new cloudflare_1.default({ apiToken: apiToken }).d1.database;
+        this.accountId = accountId;
+        this.databaseId = databaseId;
+    }
+    D1HttpClient.prototype.execute = function (sql_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (sql, params) {
+            if (params === void 0) { params = []; }
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/, this.d1
+                        .query(this.databaseId, {
+                        sql: sql,
+                        params: params,
+                        account_id: this.accountId,
+                    })
+                        .then(function (_a) {
+                        var pages = _a.result;
+                        return pages.flatMap(function (page) { return page.results; });
+                    })
+                    // NOTE: d1 query endpoint returns the result as array of object with keys as column names.
+                    // We're returning that now because the rest of remult seems to expect that.
+                    // D1 also has a more efficient raw() endpoint that returns {columns: string[], rows: any[][]} that we may want
+                    // to use eventually, and write code like fromRowToSql()
+                    // at https://github.com/tursodatabase/libsql-client-ts/blob/main/packages/libsql-client/src/sqlite3.ts#L398
+                    // to adapt the data
+                ];
+            });
+        });
+    };
+    return D1HttpClient;
+}());
+exports.D1HttpClient = D1HttpClient;

package/remult-d1.d.ts

@@ -0,0 +1,27 @@
+import { SqlDatabase, type SqlImplementation } from './index.js';
+import { SqliteCoreDataProvider } from './remult-sqlite-core.js';
+export declare function createD1DataProvider(d1: D1Database): SqlDatabase;
+export declare class D1DataProvider extends SqliteCoreDataProvider {
+    private d1;
+    /**
+     * For production or local d1 using binding
+     *
+     * const dataProvider = new SqlDatabase(new D1DataProvider(new D1BindingClient(d1)))
+     */
+    constructor(d1: D1Client);
+    transaction(action: (sql: SqlImplementation) => Promise<void>): Promise<void>;
+}
+export type D1RowObject = Record<string, unknown>;
+export interface D1Client {
+    execute(sql: string, params?: unknown[]): Promise<D1RowObject[]>;
+}
+export declare class D1BindingClient implements D1Client {
+    private d1;
+    /**
+     * Simple d1 client that wraps the d1 binding directly
+     *
+     * const d1 = new D1BindingClient(env.DB)
+     */
+    constructor(d1: D1Database);
+    execute(sql: string, params?: unknown[]): Promise<D1RowObject[]>;
+}

package/remult-d1.js

@@ -0,0 +1,128 @@
+"use strict";
+/// <reference types="@cloudflare/workers-types" />
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.D1BindingClient = exports.D1DataProvider = void 0;
+exports.createD1DataProvider = createD1DataProvider;
+var tslib_1 = require("tslib");
+var index_js_1 = require("./index.js");
+var remult_sqlite_core_js_1 = require("./remult-sqlite-core.js");
+function createD1DataProvider(d1) {
+    return new index_js_1.SqlDatabase(new D1DataProvider(new D1BindingClient(d1)));
+}
+var D1DataProvider = /** @class */ (function (_super) {
+    tslib_1.__extends(D1DataProvider, _super);
+    /**
+     * For production or local d1 using binding
+     *
+     * const dataProvider = new SqlDatabase(new D1DataProvider(new D1BindingClient(d1)))
+     */
+    function D1DataProvider(d1) {
+        var _this = _super.call(this, function () { return new D1Command(_this.d1); }, function () { return tslib_1.__awaiter(_this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                return [2 /*return*/];
+            });
+        }); }) || this;
+        _this.d1 = d1;
+        return _this;
+    }
+    D1DataProvider.prototype.transaction = function (action) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: 
+                    // As of June 2025, D1 doesn't support transactions
+                    // Here we simply run the action without wrapping it in a transaction
+                    // It means queries in action() will be run individually (this is the same decision prisma made)
+                    return [4 /*yield*/, action(this)];
+                    case 1:
+                        // As of June 2025, D1 doesn't support transactions
+                        // Here we simply run the action without wrapping it in a transaction
+                        // It means queries in action() will be run individually (this is the same decision prisma made)
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return D1DataProvider;
+}(remult_sqlite_core_js_1.SqliteCoreDataProvider));
+exports.D1DataProvider = D1DataProvider;
+var D1BindingClient = /** @class */ (function () {
+    /**
+     * Simple d1 client that wraps the d1 binding directly
+     *
+     * const d1 = new D1BindingClient(env.DB)
+     */
+    function D1BindingClient(d1) {
+        this.d1 = d1;
+    }
+    D1BindingClient.prototype.execute = function (sql_1) {
+        return tslib_1.__awaiter(this, arguments, void 0, function (sql, params) {
+            var results;
+            var _a;
+            if (params === void 0) { params = []; }
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0: return [4 /*yield*/, (_a = this.d1
+                            .prepare(sql))
+                            .bind.apply(_a, tslib_1.__spreadArray([], tslib_1.__read(params), false)).run()];
+                    case 1:
+                        results = (_b.sent()).results;
+                        return [2 /*return*/, results];
+                }
+            });
+        });
+    };
+    return D1BindingClient;
+}());
+exports.D1BindingClient = D1BindingClient;
+var D1Command = /** @class */ (function () {
+    function D1Command(d1) {
+        this.params = [];
+        this.d1 = d1;
+    }
+    D1Command.prototype.execute = function (sql) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var results;
+            return tslib_1.__generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.d1.execute(sql, this.params)];
+                    case 1:
+                        results = _a.sent();
+                        return [2 /*return*/, new D1SqlResult(results)];
+                }
+            });
+        });
+    };
+    /** @deprecated use `param` instead*/
+    D1Command.prototype.addParameterAndReturnSqlToken = function (val) {
+        return this.param(val);
+    };
+    D1Command.prototype.param = function (val) {
+        var p;
+        if (val instanceof Date)
+            p = val.valueOf();
+        else if (typeof val === 'boolean')
+            p = val ? 1 : 0;
+        else
+            p = val;
+        this.params.push(p);
+        // According to https://developers.cloudflare.com/d1/worker-api/prepared-statements/
+        // only the ordered "?NNN" and anonymous "?" param types are supported (although :AAAA seems to work too)
+        var key = "?".concat(this.params.length);
+        return key;
+    };
+    return D1Command;
+}());
+var D1SqlResult = /** @class */ (function () {
+    function D1SqlResult(rows) {
+        if (rows === void 0) { rows = []; }
+        this.rows = rows;
+        // NOTE: are we guaranteed that when this is reached, rows is not empty?
+        this.columns = rows.length === 0 ? [] : Object.keys(rows[0]);
+    }
+    D1SqlResult.prototype.getColumnKeyInResultForIndexInSelect = function (index) {
+        return this.columns[index];
+    };
+    return D1SqlResult;
+}());

package/server/remult-admin.js

@@ -12,7 +12,11 @@ function remultAdminHtml(options) {
     var head = options.head, rootPath = options.rootPath, requireAuthToken = options.requireAuthToken, disableLiveQuery = options.disableLiveQuery;
     return (0, get_remult_admin_html_js_1.getHtml)()
         .replace('<!--PLACE_HERE_HEAD-->', head)
-        .replace('<!--PLACE_HERE_BODY-->', "<script>\n  window.optionsFromServer = ".concat(JSON.stringify({ rootPath: rootPath, requireAuthToken: requireAuthToken, disableLiveQuery: disableLiveQuery }), "\n</script>"));
+        .replace('<!--PLACE_HERE_BODY-->', "<script>\n  window.optionsFromServer = ".concat(JSON.stringify({
+        rootPath: rootPath,
+        requireAuthToken: requireAuthToken,
+        disableLiveQuery: disableLiveQuery,
+    }), "\n</script>"));
 }
 function buildEntityInfo(options) {
     var e_1, _a;
@@ -68,7 +72,7 @@ function buildEntityInfo(options) {
                     }
                     else if (info.type === 'toMany') {
                         if (relRepo.metadata.apiReadAllowed) {
-                            relations.push(tslib_1.__assign(tslib_1.__assign({}, relInfo), { where: where, entityKey: relRepo.metadata.key, key: x.key, caption: x.caption }));
+                            relations.push(tslib_1.__assign(tslib_1.__assign({}, relInfo), { where: where, entityKey: relRepo.metadata.key, key: x.key, caption: x.label }));
                         }
                         return "continue";
                     }
@@ -78,7 +82,7 @@ function buildEntityInfo(options) {
                     readOnly: !x.apiUpdateAllowed(),
                     values: (0, RepositoryImplementation_js_1.getValueList)(x),
                     valFieldKey: valFieldKey,
-                    caption: x.caption,
+                    caption: x.label,
                     relationToOne: relation,
                     inputType: x.inputType,
                     type: x.inputType === inputTypes_js_1.InputTypes.json
@@ -112,11 +116,11 @@ function buildEntityInfo(options) {
         }
         if (metadata.apiReadAllowed) {
             var superKey = metadata.key;
-            var caption = metadata.caption;
+            var caption = metadata.label;
             var nbOfEntities = entities.filter(function (e) { return e.key === metadata.key; }).length;
             if (nbOfEntities > 0) {
                 superKey = metadata.key + '_ext_' + nbOfEntities;
-                caption = metadata.caption + '*'.repeat(nbOfEntities);
+                caption = metadata.label + '*'.repeat(nbOfEntities);
             }
             entities.push({
                 superKey: superKey,

package/src/CompoundIdField.d.ts

@@ -19,6 +19,7 @@ export declare class CompoundIdField implements FieldMetadata<string> {
     dbReadOnly: boolean;
     isServerExpression: boolean;
     key: string;
+    label: string;
     caption: string;
     inputType: string;
     dbName: string;

package/src/CompoundIdField.js

@@ -13,6 +13,7 @@ var CompoundIdField = /** @class */ (function () {
         this.dbReadOnly = false;
         this.isServerExpression = false;
         this.key = '';
+        this.label = '';
         this.caption = '';
         this.inputType = '';
         this.dbName = '';

package/src/column-interfaces.d.ts

@@ -7,6 +7,11 @@ export interface FieldOptions<entityType = unknown, valueType = unknown> {
      * <input placeholder={taskRepo.metadata.fields.title.caption}/>
      */
     caption?: string;
+    /** A human readable name for the field. Can be used to achieve a consistent label for a field throughout the app
+     * @example
+     * <input placeholder={taskRepo.metadata.fields.title.label}/>
+     */
+    label?: string;
     /** If it can store null in the database */
     allowNull?: boolean;
     /** If a value is required. Short-cut to say `validate: Validators.required`.
@@ -141,6 +146,12 @@ export interface FieldMetadata<valueType = unknown, entityType = unknown> {
      * @see {@link FieldOptions#caption} for configuration details
      */
     readonly caption: string;
+    /** A human readable label for the field. Can be used to achieve a consistent label for a field throughout the app
+     * @example
+     * <input placeholder={taskRepo.metadata.fields.title.label}/>
+     * @see {@link FieldOptions.label} for configuration details
+     */
+    readonly label: string;
     /** The name of the column in the database that holds the data for this field. If no name is set, the key will be used instead.
      * @example
      *
@@ -336,4 +347,5 @@ export declare function valueOrExpressionToValue<valueType>(f: ValueOrExpression
 export interface ValueListItem {
     id?: any;
     caption?: any;
+    label?: any;
 }

package/src/entity.d.ts

@@ -6,6 +6,11 @@ import type { DataProvider } from './data-interfaces.js';
 export interface EntityOptions<entityType = unknown> {
     /**A human readable name for the entity */
     caption?: string;
+    /** A human readable label for the entity. Can be used to achieve a consistent label for a field throughout the app
+     * @example
+     * <h1>Create a new item in {taskRepo.metadata.label}</h1>
+     */
+    label?: string;
     /**
      * Determines if this Entity is available for get requests using Rest Api
      * @description

package/src/remult-static.d.ts

@@ -20,7 +20,7 @@ export declare const remultStatic: {
         };
     };
     fieldOptionsEnricher: any;
-    captionTransformer: any;
+    labelTransformer: any;
     defaultDataProvider: () => Promise<DataProvider | undefined>;
 };
 export declare function defaultFactory(): Remult;

package/src/remult-static.js

@@ -24,7 +24,7 @@ var x = {
         }); },
     },
     fieldOptionsEnricher: undefined,
-    captionTransformer: undefined,
+    labelTransformer: undefined,
     defaultDataProvider: function () {
         return undefined;
     },

package/src/remult3/RepositoryImplementation.d.ts

@@ -211,39 +211,43 @@ export declare class FieldRefImplementation<entityType, valueType> implements Fi
 export declare const fieldOptionsEnricher: {
     enrichFieldOptions: (options: FieldOptions) => void;
 };
-export declare const CaptionTransformer: {
+export declare const LabelTransformer: {
     /**
-     * Transforms the caption of a column based on custom rules or criteria.
+     * Transforms the label of a column based on custom rules or criteria.
      *
      * This method can be assigned an arrow function that dynamically alters the
-     * caption of a column. It is particularly useful for internationalization,
-     * applying specific labeling conventions, or any other custom caption transformation
+     * label of a column. It is particularly useful for internationalization,
+     * applying specific labeling conventions, or any other custom label transformation
      * logic that your application requires.
      *
      * @param {Remult} remult - The Remult context, providing access to various framework features.
-     * @param {string} key - The key (name) of the field whose caption is being transformed.
-     * @param {string} caption - The original caption of the field.
+     * @param {string} key - The key (name) of the field whose label is being transformed.
+     * @param {string} label - The original label of the field.
      * @param {EntityMetadata<any>} entityMetaData - Metadata of the entity that the field belongs to.
-     * @returns {string} The transformed caption for the field. If no transformation is applied,
-     *                   the original caption is returned.
+     * @returns {string} The transformed label for the field. If no transformation is applied,
+     *                   the original label is returned.
      *
      * @example
-     * // Example of translating a field caption to French
-     * CaptionTransformer.transformCaption = (
-     *   remult, key, caption, entityMetaData
+     * // Example of translating a field label to French
+     * LabelTransformer.transformLabel = (
+     *   remult, key, label, entityMetaData
      * ) => {
      *   if (key === 'firstName') {
      *     return 'Prénom'; // French translation for 'firstName'
      *   }
-     *   return caption;
+     *   return label;
      * };
      *
      * // Usage
-     * const firstNameCaption = repo(Person).fields.firstName.caption; // Returns 'Prénom'
+     * const firstNameLabel = repo(Person).fields.firstName.label; // Returns 'Prénom'
      */
-    transformCaption: (remult: Remult, key: string, caption: string, entityMetaData: EntityMetadata<any>) => string;
+    transformLabel: (remult: Remult, key: string, label: string, entityMetaData: EntityMetadata<any>) => string;
+    /**
+     * @obsolete use LabelTransformer.transformLabel instead
+     */
+    transformCaption: (remult: Remult, key: string, label: string, entityMetaData: EntityMetadata<any>) => string;
 };
-export declare function buildCaption(caption: string | ((remult: Remult) => string) | undefined, key: string, remult: Remult, metaData: EntityMetadata<any>): string;
+export declare function buildLabel(label: string | ((remult: Remult) => string) | undefined, key: string, remult: Remult, metaData: EntityMetadata<any>): string;
 export declare class columnDefsImpl implements FieldMetadata {
     private settings;
     private entityDefs;
@@ -260,7 +264,8 @@ export declare class columnDefsImpl implements FieldMetadata {
     readonly: boolean;
     valueConverter: Required<ValueConverter<any>>;
     allowNull: boolean;
-    caption: string;
+    label: string;
+    get caption(): string;
     dbName: string;
     inputType: string;
     key: string;
@@ -285,7 +290,8 @@ declare class EntityFullInfo<T> implements EntityMetadata<T> {
     idMetadata: IdMetadata<T>;
     fields: FieldsMetadata<T>;
     dbName: string;
-    caption: string;
+    label: string;
+    get caption(): string;
 }
 export declare function FieldType<valueType = unknown>(...options: (FieldOptions<any, valueType> | ((options: FieldOptions<any, valueType>, remult: Remult) => void))[]): (target: any, context?: any) => any;
 export declare function isAutoIncrement(f: FieldMetadata): boolean;

package/src/remult3/RepositoryImplementation.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ControllerBase = exports.EntityBase = exports.fieldOptionalValuesFunctionKey = exports.storableMember = exports.ValueListInfo = exports.columnDefsImpl = exports.CaptionTransformer = exports.fieldOptionsEnricher = exports.FieldRefImplementation = exports.controllerRefImpl = exports.rowHelperImplementation = exports.RepositoryImplementation = void 0;
+exports.ControllerBase = exports.EntityBase = exports.fieldOptionalValuesFunctionKey = exports.storableMember = exports.ValueListInfo = exports.columnDefsImpl = exports.LabelTransformer = exports.fieldOptionsEnricher = exports.FieldRefImplementation = exports.controllerRefImpl = exports.rowHelperImplementation = exports.RepositoryImplementation = void 0;
 exports.createOldEntity = createOldEntity;
 exports.getFields = getFields;
 exports.getControllerRef = getControllerRef;
-exports.buildCaption = buildCaption;
+exports.buildLabel = buildLabel;
 exports.FieldType = FieldType;
 exports.isAutoIncrement = isAutoIncrement;
 exports.ValueListFieldType = ValueListFieldType;
@@ -1955,7 +1955,7 @@ var rowHelperBase = /** @class */ (function () {
                     var col = _d.value;
                     if ((_b = this.errors) === null || _b === void 0 ? void 0 : _b[col.key]) {
                         error.message =
-                            this.fields[col.key].metadata.caption +
+                            this.fields[col.key].metadata.label +
                                 ': ' +
                                 this.errors[col.key];
                         this.error = error.message;
@@ -3334,23 +3334,26 @@ var FieldRefImplementation = /** @class */ (function () {
     return FieldRefImplementation;
 }());
 exports.FieldRefImplementation = FieldRefImplementation;
-var tempCaptionTransformer = {
-    transformCaption: function (remult, key, caption, entityMetaData) { return caption; },
+var tempLabelTransformer = {
+    transformLabel: function (remult, key, label, entityMetaData) { return label; },
+    set transformCaption(val) {
+        this.transformLabel = val;
+    },
 };
 exports.fieldOptionsEnricher = remult_static_js_1.remultStatic.fieldOptionsEnricher || {
     enrichFieldOptions: function (options) { return options; },
 };
-exports.CaptionTransformer = remult_static_js_1.remultStatic.captionTransformer ||
-    (remult_static_js_1.remultStatic.captionTransformer = tempCaptionTransformer);
-function buildCaption(caption, key, remult, metaData) {
+exports.LabelTransformer = remult_static_js_1.remultStatic.labelTransformer ||
+    (remult_static_js_1.remultStatic.labelTransformer = tempLabelTransformer);
+function buildLabel(label, key, remult, metaData) {
     var result = undefined;
-    if (typeof caption === 'function') {
+    if (typeof label === 'function') {
         if (remult)
-            result = caption(remult);
+            result = label(remult);
     }
-    else if (caption)
-        result = caption;
-    result = exports.CaptionTransformer.transformCaption(remult, key, result !== null && result !== void 0 ? result : '', metaData);
+    else if (label)
+        result = label;
+    result = exports.LabelTransformer.transformLabel(remult, key, result !== null && result !== void 0 ? result : '', metaData);
     if (result)
         return result;
     if (key)
@@ -3360,7 +3363,7 @@ function buildCaption(caption, key, remult, metaData) {
 var columnDefsImpl = /** @class */ (function () {
     function columnDefsImpl(settings, entityDefs, remult) {
         var _this = this;
-        var _a;
+        var _a, _b;
         this.settings = settings;
         this.entityDefs = entityDefs;
         this.remult = remult;
@@ -3384,7 +3387,7 @@ var columnDefsImpl = /** @class */ (function () {
                         catch (err) {
                             var error = "".concat(String(prop), " failed for value ").concat(args === null || args === void 0 ? void 0 : args[0], ". Error: ").concat(typeof err === 'string' ? err : err.message);
                             throw new data_interfaces_js_1.EntityError({
-                                message: _this.caption + ': ' + error,
+                                message: _this.label + ': ' + error,
                                 modelState: (_a = {},
                                     _a[_this.key] = error,
                                     _a),
@@ -3408,7 +3411,7 @@ var columnDefsImpl = /** @class */ (function () {
         this.dbName = settings.dbName;
         if (this.dbName == undefined)
             this.dbName = settings.key;
-        this.caption = buildCaption(settings.caption, settings.key, remult, entityDefs);
+        this.label = buildLabel((_b = settings.label) !== null && _b !== void 0 ? _b : settings.caption, settings.key, remult, entityDefs);
     }
     columnDefsImpl.prototype.apiUpdateAllowed = function (item) {
         if (this.options.allowApiUpdate === undefined)
@@ -3438,6 +3441,13 @@ var columnDefsImpl = /** @class */ (function () {
             });
         });
     };
+    Object.defineProperty(columnDefsImpl.prototype, "caption", {
+        get: function () {
+            return this.label;
+        },
+        enumerable: false,
+        configurable: true
+    });
     Object.defineProperty(columnDefsImpl.prototype, "dbReadOnly", {
         get: function () {
             return Boolean(this.settings.dbReadOnly);
@@ -3452,6 +3462,7 @@ var EntityFullInfo = /** @class */ (function () {
     function EntityFullInfo(columnsInfo, entityInfo, remult, entityType, key) {
         var _a, e_49, _b;
         var _this = this;
+        var _c;
         this.entityInfo = entityInfo;
         this.remult = remult;
         this.entityType = entityType;
@@ -3562,7 +3573,7 @@ var EntityFullInfo = /** @class */ (function () {
             finally { if (e_49) throw e_49.error; }
         }
         this.fields = r;
-        this.caption = buildCaption(entityInfo.caption, this.key, remult, this);
+        this.label = buildLabel((_c = entityInfo.label) !== null && _c !== void 0 ? _c : entityInfo.caption, this.key, remult, this);
         if (entityInfo.id) {
             var r_2 = typeof entityInfo.id === 'string'
                 ? this.fields.find(entityInfo.id)
@@ -3627,6 +3638,13 @@ var EntityFullInfo = /** @class */ (function () {
     EntityFullInfo.prototype.getDbName = function () {
         return (0, entityDbName_js_1.entityDbName)(this);
     };
+    Object.defineProperty(EntityFullInfo.prototype, "caption", {
+        get: function () {
+            return this.label;
+        },
+        enumerable: false,
+        configurable: true
+    });
     return EntityFullInfo;
 }());
 function FieldType() {
@@ -3656,7 +3674,7 @@ function ValueListFieldType() {
         FieldType.apply(void 0, tslib_1.__spreadArray([function (o) {
                 ;
                 (o.valueConverter = ValueListInfo.get(type)),
-                    (o.displayValue = function (item, val) { return val === null || val === void 0 ? void 0 : val.caption; });
+                    (o.displayValue = function (item, val) { var _a; return (_a = val === null || val === void 0 ? void 0 : val.label) !== null && _a !== void 0 ? _a : val === null || val === void 0 ? void 0 : val.caption; });
                 o.validate = function (entity, ref) {
                     var values = ValueListInfo.get(type).getValues();
                     if (ref.value && !values.find(function (v) { return v === ref.value; })) {
@@ -3682,8 +3700,7 @@ var ValueListInfo = /** @class */ (function () {
                     s.id = member;
                 if (typeof s.id === 'number')
                     this.isNumeric = true;
-                if (s.caption === undefined)
-                    s.caption = (0, column_js_1.makeTitle)(s.id !== undefined ? s.id.toString() : member);
+                setLabelAndCaption(s, member);
                 this.byIdMap.set(s.id, s);
                 this.values.push(s);
             }
@@ -3700,8 +3717,7 @@ var ValueListInfo = /** @class */ (function () {
                         (_b = this.values).splice.apply(_b, tslib_1.__spreadArray([0, this.values.length], tslib_1.__read(op.getValues()), false));
                         this.byIdMap.clear();
                         this.values.forEach(function (s) {
-                            if (s.caption === undefined && s.id !== undefined)
-                                s.caption = (0, column_js_1.makeTitle)(s.id);
+                            setLabelAndCaption(s, '');
                             _this.byIdMap.set(s.id, s);
                         });
                     }
@@ -3766,6 +3782,16 @@ var ValueListInfo = /** @class */ (function () {
 }());
 exports.ValueListInfo = ValueListInfo;
 var typeCache = new Map();
+function setLabelAndCaption(s, member) {
+    var _a;
+    var label = (_a = s.label) !== null && _a !== void 0 ? _a : s.caption;
+    if (label === undefined)
+        label = (0, column_js_1.makeTitle)(s.id !== undefined ? s.id.toString() : member);
+    if (s.label === undefined)
+        s.label = label;
+    if (s.caption === undefined)
+        s.caption = label;
+}
 function getValueList(type) {
     var meta = type === null || type === void 0 ? void 0 : type.metadata;
     if (!meta && (0, isOfType_js_1.isOfType)(type, 'options'))

package/src/remult3/remult3.d.ts

@@ -198,6 +198,12 @@ export interface EntityMetadata<entityType = unknown> {
      * @see {@link EntityOptions.caption}
      */
     readonly caption: string;
+    /** A human readable label for the entity. Can be used to achieve a consistent label for a field throughout the app
+     * @example
+     * <h1>Create a new item in {taskRepo.metadata.label}</h1>
+     * @see {@link EntityOptions.label}
+     */
+    readonly label: string;
     /** The name of the table in the database that holds the data for this entity.
      * If no name is set in the entity options, the `key` will be used instead.
      * @see {@link EntityOptions.dbName}
@@ -641,7 +647,7 @@ export interface Repository<entityType> {
     getEntityRef(item: entityType): EntityRef<entityType>;
     /** Provides information about the fields of the Repository's entity
      * @example
-     * console.log(repo.fields.title.caption) // displays the caption of a specific field
+     * console.log(repo.fields.title.label) // displays the label of a specific field
      * console.log(repo.fields.title.options)// writes the options that were defined for this field
      */
     fields: FieldsMetadata<entityType>;
@@ -1129,7 +1135,7 @@ export type Paginator<entityType, AggregateResult = EmptyAggregateResult> = {
  * @template matchIdEntity The type used for matching IDs in the relation.
  * @template optionsType The type of find options to apply to the relation (default is FindOptionsBase<toEntity>).
  */
-export interface RelationOptions<fromEntity, toEntity, matchIdEntity, optionsType extends FindOptionsBase<toEntity> = FindOptionsBase<toEntity>> extends Pick<FieldOptions, 'caption'> {
+export interface RelationOptions<fromEntity, toEntity, matchIdEntity, optionsType extends FindOptionsBase<toEntity> = FindOptionsBase<toEntity>> extends Pick<FieldOptions, 'caption' | 'label'> {
     /**
      * An object specifying custom field names for the relation.
      * Each key represents a field in the related entity, and its value is the corresponding field in the source entity.