@relyio/sdk 0.10.0 → 0.11.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/CHANGELOG.md +47 -0
- package/dist/.tsbuildinfo +1 -1
- package/dist/{chunk-IGHYC2WM.js → chunk-2TIJLV2X.js} +2 -2
- package/dist/{chunk-DC4QLAI3.cjs → chunk-4HTIU5YE.cjs} +2 -2
- package/dist/{chunk-2L5JUW7O.js → chunk-7GLDVHIH.js} +2 -2
- package/dist/{chunk-2HP566NI.cjs → chunk-PO7CUR5U.cjs} +2 -2
- package/dist/client/index.cjs +3 -3
- package/dist/client/index.d.cts +4 -4
- package/dist/client/index.d.ts +4 -4
- package/dist/client/index.js +1 -1
- package/dist/{define-content-type-DfnTu26S.d.cts → define-content-type-ENAod5Ve.d.cts} +27 -14
- package/dist/{define-content-type-DfnTu26S.d.ts → define-content-type-ENAod5Ve.d.ts} +27 -14
- package/dist/{define-schema-W-0u1Jg1.d.cts → define-schema-CVi8nwc7.d.ts} +17 -11
- package/dist/{define-schema-rbTrXxNN.d.ts → define-schema-DqpipEHv.d.cts} +17 -11
- package/dist/{index-rLEBSFvK.d.ts → index-BKEAYvvz.d.ts} +6 -6
- package/dist/{index-NnLCwSqF.d.cts → index-BM42r4yg.d.cts} +1 -1
- package/dist/{index-B9hDmCho.d.ts → index-C73cK2Tt.d.ts} +1 -1
- package/dist/{index-KuYgc7eG.d.cts → index-MLAFUuco.d.cts} +6 -6
- package/dist/index.cjs +82 -82
- package/dist/index.d.cts +7 -7
- package/dist/index.d.ts +7 -7
- package/dist/index.js +3 -3
- package/dist/schema/index.cjs +35 -35
- package/dist/schema/index.d.cts +5 -4
- package/dist/schema/index.d.ts +5 -4
- package/dist/schema/index.js +1 -1
- package/dist/types/index.d.cts +2 -2
- package/dist/types/index.d.ts +2 -2
- package/package.json +3 -3
|
@@ -690,5 +690,5 @@ __name(component, "component");
|
|
|
690
690
|
var fields = fields_exports;
|
|
691
691
|
|
|
692
692
|
export { BUILT_IN_ROLES, BUILT_IN_ROLE_ACTIONS, ROLE_ACTIONS, buildFallbackChain, defineAssetType, defineComponent, defineContentType, defineContentTypeWorkflow, defineLocale, defineQuery, defineRole, defineSchema, defineSettingsGroup, defineSingleton, defineSingletonContentType, defineView, defineWorkflow, defineWorkflowStage, fields, fieldset, findDefaultLocale, findWorkflowStage, getActiveLocales, getBuiltInRoleActions, getFirstWorkflowStage, getLocaleCodes, getNextWorkflowStage, getWorkflowStageIds, isBuiltInRole, isFinalWorkflowStage, isLocaleDefinition, isRoleDefinition, isWorkflowDefinition, isWorkflowStageDefinition };
|
|
693
|
-
//# sourceMappingURL=chunk-
|
|
694
|
-
//# sourceMappingURL=chunk-
|
|
693
|
+
//# sourceMappingURL=chunk-2TIJLV2X.js.map
|
|
694
|
+
//# sourceMappingURL=chunk-2TIJLV2X.js.map
|
|
@@ -6346,5 +6346,5 @@ exports.matchRoute = matchRoute;
|
|
|
6346
6346
|
exports.serviceInstructedDelayMs = serviceInstructedDelayMs;
|
|
6347
6347
|
exports.sleep = sleep;
|
|
6348
6348
|
exports.validateFile = validateFile;
|
|
6349
|
-
//# sourceMappingURL=chunk-
|
|
6350
|
-
//# sourceMappingURL=chunk-
|
|
6349
|
+
//# sourceMappingURL=chunk-4HTIU5YE.cjs.map
|
|
6350
|
+
//# sourceMappingURL=chunk-4HTIU5YE.cjs.map
|
|
@@ -6285,5 +6285,5 @@ function randomClientId() {
|
|
|
6285
6285
|
__name(randomClientId, "randomClientId");
|
|
6286
6286
|
|
|
6287
6287
|
export { AdhocQueryBuilder, AdhocQueryClient, AssetClient, AssetFileBuilder, AssetUploadBuilder, AuthorizationError, AutocompleteBuilder, BaseValidationError, BatchBuilder, BatchClient, ChangesExpiredError, ConnectionError, ContentByIdBuilder, ContentClient, ContentQueryBuilder, ErrorMapper, FileUploadError, FileValidationError, HttpClient, InvalidApiKeyError, InvalidPayloadError, LIVE_KEEPALIVE_INTERVAL_MS, LIVE_SOCKET_OPEN_TIMEOUT_MS, LiveEdgeError, MethodNotAllowedError, MissingApiKeyError, NetworkError, PUBLISHABLE_KEY_PREFIX, PayloadTooLargeError, PlanFeatureUnavailableError, RateLimitError, ReadOnlyKeyError, ResourceConflictError, ResourceExpiredError, ResourceNotFoundError, SDKError, SearchBuilder, SearchClient, ServerError, ServiceIndeterminateError, SettingsClient, SimilarBuilder, SingletonClient, TimeoutError, TransactionRolledBackError, TypedRelyIOClient, UnknownContractError, UsageQuotaExceededError, VISITOR_ADMISSION_RETRY_AFTER_SECONDS, ValidationError, createClient, entityTagOf, isAborted, isAssetEntry, isPublishableKey, isResourceNotFound, matchRoute, serviceInstructedDelayMs, sleep, validateFile };
|
|
6288
|
-
//# sourceMappingURL=chunk-
|
|
6289
|
-
//# sourceMappingURL=chunk-
|
|
6288
|
+
//# sourceMappingURL=chunk-7GLDVHIH.js.map
|
|
6289
|
+
//# sourceMappingURL=chunk-7GLDVHIH.js.map
|
|
@@ -725,5 +725,5 @@ exports.isLocaleDefinition = isLocaleDefinition;
|
|
|
725
725
|
exports.isRoleDefinition = isRoleDefinition;
|
|
726
726
|
exports.isWorkflowDefinition = isWorkflowDefinition;
|
|
727
727
|
exports.isWorkflowStageDefinition = isWorkflowStageDefinition;
|
|
728
|
-
//# sourceMappingURL=chunk-
|
|
729
|
-
//# sourceMappingURL=chunk-
|
|
728
|
+
//# sourceMappingURL=chunk-PO7CUR5U.cjs.map
|
|
729
|
+
//# sourceMappingURL=chunk-PO7CUR5U.cjs.map
|
package/dist/client/index.cjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunk4HTIU5YE_cjs = require('../chunk-4HTIU5YE.cjs');
|
|
4
4
|
require('../chunk-LSRPMNPT.cjs');
|
|
5
5
|
require('../chunk-TZL374LS.cjs');
|
|
6
6
|
require('../chunk-MWMSFIWN.cjs');
|
|
@@ -9,11 +9,11 @@ require('../chunk-MWMSFIWN.cjs');
|
|
|
9
9
|
|
|
10
10
|
Object.defineProperty(exports, "TypedRelyIOClient", {
|
|
11
11
|
enumerable: true,
|
|
12
|
-
get: function () { return
|
|
12
|
+
get: function () { return chunk4HTIU5YE_cjs.TypedRelyIOClient; }
|
|
13
13
|
});
|
|
14
14
|
Object.defineProperty(exports, "createClient", {
|
|
15
15
|
enumerable: true,
|
|
16
|
-
get: function () { return
|
|
16
|
+
get: function () { return chunk4HTIU5YE_cjs.createClient; }
|
|
17
17
|
});
|
|
18
18
|
//# sourceMappingURL=index.cjs.map
|
|
19
19
|
//# sourceMappingURL=index.cjs.map
|
package/dist/client/index.d.cts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-
|
|
2
|
-
import '../index-
|
|
3
|
-
import '../define-content-type-
|
|
4
|
-
import '../define-schema-
|
|
1
|
+
export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-MLAFUuco.cjs';
|
|
2
|
+
import '../index-BM42r4yg.cjs';
|
|
3
|
+
import '../define-content-type-ENAod5Ve.cjs';
|
|
4
|
+
import '../define-schema-DqpipEHv.cjs';
|
|
5
5
|
import './live-visitor.js';
|
|
6
6
|
import '../dev-handshake/index.cjs';
|
package/dist/client/index.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-
|
|
2
|
-
import '../index-
|
|
3
|
-
import '../define-content-type-
|
|
4
|
-
import '../define-schema-
|
|
1
|
+
export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-BKEAYvvz.js';
|
|
2
|
+
import '../index-C73cK2Tt.js';
|
|
3
|
+
import '../define-content-type-ENAod5Ve.js';
|
|
4
|
+
import '../define-schema-CVi8nwc7.js';
|
|
5
5
|
import './live-visitor.js';
|
|
6
6
|
import '../dev-handshake/index.js';
|
package/dist/client/index.js
CHANGED
|
@@ -1058,14 +1058,14 @@ interface components {
|
|
|
1058
1058
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1059
1059
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1060
1060
|
localeHasDraft: boolean;
|
|
1061
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1061
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1062
1062
|
draftLocales: string[];
|
|
1063
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1064
|
+
hasDraft: boolean;
|
|
1063
1065
|
/** @description The locale the request named, when it named one other than the default. On `?locales=a,b,c` it is always sent: the primary, or `*` when the list names as many locales as the entry has — as on `?locale=*`. */
|
|
1064
1066
|
requestedLocale?: string;
|
|
1065
1067
|
/** @description The schema’s default locale. */
|
|
1066
1068
|
defaultLocale: string;
|
|
1067
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1068
|
-
hasDraft: boolean;
|
|
1069
1069
|
/** @description Each field whose value came from another locale, mapped to that locale. Absent when none did. */
|
|
1070
1070
|
localeFallbacksApplied?: {
|
|
1071
1071
|
[key: string]: string;
|
|
@@ -1354,9 +1354,9 @@ interface components {
|
|
|
1354
1354
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1355
1355
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1356
1356
|
localeHasDraft: boolean;
|
|
1357
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1357
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1358
1358
|
draftLocales: string[];
|
|
1359
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1359
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1360
1360
|
hasDraft: boolean;
|
|
1361
1361
|
/**
|
|
1362
1362
|
* Format: date-time
|
|
@@ -1407,8 +1407,10 @@ interface components {
|
|
|
1407
1407
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1408
1408
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1409
1409
|
localeHasDraft: boolean;
|
|
1410
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1410
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1411
1411
|
draftLocales: string[];
|
|
1412
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1413
|
+
hasDraft: boolean;
|
|
1412
1414
|
/**
|
|
1413
1415
|
* Format: date-time
|
|
1414
1416
|
* @description When the group was last written.
|
|
@@ -1439,8 +1441,10 @@ interface components {
|
|
|
1439
1441
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1440
1442
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1441
1443
|
localeHasDraft: boolean;
|
|
1442
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1444
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1443
1445
|
draftLocales: string[];
|
|
1446
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1447
|
+
hasDraft: boolean;
|
|
1444
1448
|
/**
|
|
1445
1449
|
* Format: date-time
|
|
1446
1450
|
* @description When the group was last written.
|
|
@@ -1482,9 +1486,9 @@ interface components {
|
|
|
1482
1486
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1483
1487
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1484
1488
|
localeHasDraft: boolean;
|
|
1485
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1489
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1486
1490
|
draftLocales: string[];
|
|
1487
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1491
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1488
1492
|
hasDraft: boolean;
|
|
1489
1493
|
/**
|
|
1490
1494
|
* Format: date-time
|
|
@@ -6829,7 +6833,10 @@ interface DateConfig extends BaseFieldConfig {
|
|
|
6829
6833
|
interface DateTimeConfig extends BaseFieldConfig {
|
|
6830
6834
|
minDateTime?: string;
|
|
6831
6835
|
maxDateTime?: string;
|
|
6832
|
-
/**
|
|
6836
|
+
/**
|
|
6837
|
+
* Show the instant in UTC (`'UTC'`) or in the author's local time (`'local'`) in the editor. The
|
|
6838
|
+
* instant is stored in UTC either way.
|
|
6839
|
+
*/
|
|
6833
6840
|
timeZoneHandling?: 'UTC' | 'local';
|
|
6834
6841
|
defaultValue?: string;
|
|
6835
6842
|
}
|
|
@@ -7451,8 +7458,9 @@ type InferAssetType<T extends AnyAssetTypeDefinition, S extends FieldSchemaConte
|
|
|
7451
7458
|
* typed by one table. The types describe **what a read returns**, which is not always what a write
|
|
7452
7459
|
* accepts:
|
|
7453
7460
|
*
|
|
7454
|
-
* - `richText` is the stored HTML string; `date` is `YYYY-MM-DD` and `dateTime` an ISO 8601 string
|
|
7455
|
-
*
|
|
7461
|
+
* - `richText` is the stored HTML string; `date` is `YYYY-MM-DD` and `dateTime` an ISO 8601 string
|
|
7462
|
+
* in UTC at millisecond precision (`2026-10-01T04:30:00.000Z`), whatever offset it was written in
|
|
7463
|
+
* — the client does not revive dates.
|
|
7456
7464
|
* - A `reference` is the target's id until `include` names it, and then the target entry itself.
|
|
7457
7465
|
* The type cannot see `include`, so it is both: `string | <entry>`. A single reference whose target
|
|
7458
7466
|
* was deleted with `onTargetDelete: 'nullify'` is `null`.
|
|
@@ -7508,7 +7516,7 @@ type FieldValueByType<C, S extends Context> = OverEveryFieldType<{
|
|
|
7508
7516
|
enum: EnumValue<C>;
|
|
7509
7517
|
/** `YYYY-MM-DD`. */
|
|
7510
7518
|
date: string;
|
|
7511
|
-
/** ISO 8601. */
|
|
7519
|
+
/** ISO 8601 in UTC at millisecond precision: `2026-10-01T04:30:00.000Z`. */
|
|
7512
7520
|
dateTime: string;
|
|
7513
7521
|
reference: ReferenceValue<C, S>;
|
|
7514
7522
|
tags: string[];
|
|
@@ -7769,8 +7777,13 @@ type EntryMetadata = components['schemas']['EntryMetadata'];
|
|
|
7769
7777
|
* settings group's alike (`INV-LM-PUBLICATION-IS-REPORTED-PER-LOCALE`): a `Pick` of the document's
|
|
7770
7778
|
* {@link EntryMetadata}, so this package holds no copy of them. `localeStatus` is absent when the
|
|
7771
7779
|
* locale has no content of its own.
|
|
7780
|
+
*
|
|
7781
|
+
* Unpublished work comes in two kinds, reported apart: `draftLocales` names the locales with edits
|
|
7782
|
+
* of their own, and `hasDraft` is a change to the shared (non-localized) fields. Publishing any
|
|
7783
|
+
* locale makes a shared change live, so it is pending in every locale and no locale code is listed
|
|
7784
|
+
* for it. A locale has unpublished work when `draftLocales` names it or `hasDraft` is `true`.
|
|
7772
7785
|
*/
|
|
7773
|
-
type LocalePublicationFields = Pick<EntryMetadata, 'localeStatus' | 'localeHasDraft' | 'draftLocales'>;
|
|
7786
|
+
type LocalePublicationFields = Pick<EntryMetadata, 'localeStatus' | 'localeHasDraft' | 'draftLocales' | 'hasDraft'>;
|
|
7774
7787
|
/**
|
|
7775
7788
|
* Infer the TypeScript type of an entry from a content type definition: every field it declares,
|
|
7776
7789
|
* directly or through fieldsets, typed as a read returns it (`INV-SS-TYPES-INFERRED`), plus
|
|
@@ -1058,14 +1058,14 @@ interface components {
|
|
|
1058
1058
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1059
1059
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1060
1060
|
localeHasDraft: boolean;
|
|
1061
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1061
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1062
1062
|
draftLocales: string[];
|
|
1063
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1064
|
+
hasDraft: boolean;
|
|
1063
1065
|
/** @description The locale the request named, when it named one other than the default. On `?locales=a,b,c` it is always sent: the primary, or `*` when the list names as many locales as the entry has — as on `?locale=*`. */
|
|
1064
1066
|
requestedLocale?: string;
|
|
1065
1067
|
/** @description The schema’s default locale. */
|
|
1066
1068
|
defaultLocale: string;
|
|
1067
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1068
|
-
hasDraft: boolean;
|
|
1069
1069
|
/** @description Each field whose value came from another locale, mapped to that locale. Absent when none did. */
|
|
1070
1070
|
localeFallbacksApplied?: {
|
|
1071
1071
|
[key: string]: string;
|
|
@@ -1354,9 +1354,9 @@ interface components {
|
|
|
1354
1354
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1355
1355
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1356
1356
|
localeHasDraft: boolean;
|
|
1357
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1357
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1358
1358
|
draftLocales: string[];
|
|
1359
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1359
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1360
1360
|
hasDraft: boolean;
|
|
1361
1361
|
/**
|
|
1362
1362
|
* Format: date-time
|
|
@@ -1407,8 +1407,10 @@ interface components {
|
|
|
1407
1407
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1408
1408
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1409
1409
|
localeHasDraft: boolean;
|
|
1410
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1410
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1411
1411
|
draftLocales: string[];
|
|
1412
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1413
|
+
hasDraft: boolean;
|
|
1412
1414
|
/**
|
|
1413
1415
|
* Format: date-time
|
|
1414
1416
|
* @description When the group was last written.
|
|
@@ -1439,8 +1441,10 @@ interface components {
|
|
|
1439
1441
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1440
1442
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1441
1443
|
localeHasDraft: boolean;
|
|
1442
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1444
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1443
1445
|
draftLocales: string[];
|
|
1446
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1447
|
+
hasDraft: boolean;
|
|
1444
1448
|
/**
|
|
1445
1449
|
* Format: date-time
|
|
1446
1450
|
* @description When the group was last written.
|
|
@@ -1482,9 +1486,9 @@ interface components {
|
|
|
1482
1486
|
localeStatus?: 'archived' | 'draft' | 'published';
|
|
1483
1487
|
/** @description Whether `locale` has unpublished changes of its own. */
|
|
1484
1488
|
localeHasDraft: boolean;
|
|
1485
|
-
/** @description Every locale holding unpublished content, sorted. A shared-field draft is listed
|
|
1489
|
+
/** @description Every locale holding unpublished content of its own, sorted. A shared-field draft is not listed: it is `hasDraft`. */
|
|
1486
1490
|
draftLocales: string[];
|
|
1487
|
-
/** @description Whether the shared (non-localized) fields have unpublished changes. */
|
|
1491
|
+
/** @description Whether the shared (non-localized) fields have unpublished changes. Publishing any locale makes them live, so they are unpublished work in every locale. */
|
|
1488
1492
|
hasDraft: boolean;
|
|
1489
1493
|
/**
|
|
1490
1494
|
* Format: date-time
|
|
@@ -6829,7 +6833,10 @@ interface DateConfig extends BaseFieldConfig {
|
|
|
6829
6833
|
interface DateTimeConfig extends BaseFieldConfig {
|
|
6830
6834
|
minDateTime?: string;
|
|
6831
6835
|
maxDateTime?: string;
|
|
6832
|
-
/**
|
|
6836
|
+
/**
|
|
6837
|
+
* Show the instant in UTC (`'UTC'`) or in the author's local time (`'local'`) in the editor. The
|
|
6838
|
+
* instant is stored in UTC either way.
|
|
6839
|
+
*/
|
|
6833
6840
|
timeZoneHandling?: 'UTC' | 'local';
|
|
6834
6841
|
defaultValue?: string;
|
|
6835
6842
|
}
|
|
@@ -7451,8 +7458,9 @@ type InferAssetType<T extends AnyAssetTypeDefinition, S extends FieldSchemaConte
|
|
|
7451
7458
|
* typed by one table. The types describe **what a read returns**, which is not always what a write
|
|
7452
7459
|
* accepts:
|
|
7453
7460
|
*
|
|
7454
|
-
* - `richText` is the stored HTML string; `date` is `YYYY-MM-DD` and `dateTime` an ISO 8601 string
|
|
7455
|
-
*
|
|
7461
|
+
* - `richText` is the stored HTML string; `date` is `YYYY-MM-DD` and `dateTime` an ISO 8601 string
|
|
7462
|
+
* in UTC at millisecond precision (`2026-10-01T04:30:00.000Z`), whatever offset it was written in
|
|
7463
|
+
* — the client does not revive dates.
|
|
7456
7464
|
* - A `reference` is the target's id until `include` names it, and then the target entry itself.
|
|
7457
7465
|
* The type cannot see `include`, so it is both: `string | <entry>`. A single reference whose target
|
|
7458
7466
|
* was deleted with `onTargetDelete: 'nullify'` is `null`.
|
|
@@ -7508,7 +7516,7 @@ type FieldValueByType<C, S extends Context> = OverEveryFieldType<{
|
|
|
7508
7516
|
enum: EnumValue<C>;
|
|
7509
7517
|
/** `YYYY-MM-DD`. */
|
|
7510
7518
|
date: string;
|
|
7511
|
-
/** ISO 8601. */
|
|
7519
|
+
/** ISO 8601 in UTC at millisecond precision: `2026-10-01T04:30:00.000Z`. */
|
|
7512
7520
|
dateTime: string;
|
|
7513
7521
|
reference: ReferenceValue<C, S>;
|
|
7514
7522
|
tags: string[];
|
|
@@ -7769,8 +7777,13 @@ type EntryMetadata = components['schemas']['EntryMetadata'];
|
|
|
7769
7777
|
* settings group's alike (`INV-LM-PUBLICATION-IS-REPORTED-PER-LOCALE`): a `Pick` of the document's
|
|
7770
7778
|
* {@link EntryMetadata}, so this package holds no copy of them. `localeStatus` is absent when the
|
|
7771
7779
|
* locale has no content of its own.
|
|
7780
|
+
*
|
|
7781
|
+
* Unpublished work comes in two kinds, reported apart: `draftLocales` names the locales with edits
|
|
7782
|
+
* of their own, and `hasDraft` is a change to the shared (non-localized) fields. Publishing any
|
|
7783
|
+
* locale makes a shared change live, so it is pending in every locale and no locale code is listed
|
|
7784
|
+
* for it. A locale has unpublished work when `draftLocales` names it or `hasDraft` is `true`.
|
|
7772
7785
|
*/
|
|
7773
|
-
type LocalePublicationFields = Pick<EntryMetadata, 'localeStatus' | 'localeHasDraft' | 'draftLocales'>;
|
|
7786
|
+
type LocalePublicationFields = Pick<EntryMetadata, 'localeStatus' | 'localeHasDraft' | 'draftLocales' | 'hasDraft'>;
|
|
7774
7787
|
/**
|
|
7775
7788
|
* Infer the TypeScript type of an entry from a content type definition: every field it declares,
|
|
7776
7789
|
* directly or through fieldsets, typed as a read returns it (`INV-SS-TYPES-INFERRED`), plus
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as AnyFieldDefinition, c as FieldDefinition, k as AIConfig, v as FieldSchemaContext, x as FieldValues, y as DeclaredFields, aK as components, P as ContentTypeDefinition, a0 as SingletonContentTypeDefinition, aH as WorkflowDefinition, a9 as AssetTypeDefinition, W as InferContentType } from './define-content-type-
|
|
1
|
+
import { A as AnyFieldDefinition, c as FieldDefinition, k as AIConfig, v as FieldSchemaContext, x as FieldValues, y as DeclaredFields, aK as components, P as ContentTypeDefinition, a0 as SingletonContentTypeDefinition, aH as WorkflowDefinition, a9 as AssetTypeDefinition, W as InferContentType } from './define-content-type-ENAod5Ve.js';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Component definition matching @relyio/schema ComponentSchema
|
|
@@ -928,7 +928,11 @@ type ViewFilterValue = string | number | boolean | null | (string | number)[] |
|
|
|
928
928
|
*/
|
|
929
929
|
interface ViewFilterCondition {
|
|
930
930
|
/**
|
|
931
|
-
*
|
|
931
|
+
* The Property to filter on, as the Studio's entry list names it: `fields.<id>` for a field your
|
|
932
|
+
* schema declares (`fields.seo.title` for a component's sub-field), `_metadata.<id>` for a system
|
|
933
|
+
* field — `_metadata.status`, `_metadata.createdAt`, `_metadata.updatedAt`. So a field called
|
|
934
|
+
* `status` (`fields.status`) and the entry's own lifecycle (`_metadata.status`) are both
|
|
935
|
+
* filterable.
|
|
932
936
|
*/
|
|
933
937
|
field: string;
|
|
934
938
|
/**
|
|
@@ -994,7 +998,9 @@ interface ViewConfig {
|
|
|
994
998
|
*/
|
|
995
999
|
metadataFields?: string[];
|
|
996
1000
|
/**
|
|
997
|
-
* Default sort
|
|
1001
|
+
* Default sort (optional). `field` names the Property to sort by, as a filter names one —
|
|
1002
|
+
* `fields.<id>` or `_metadata.<id>` — and deploy refuses one the view's entries cannot be sorted
|
|
1003
|
+
* by. `columns` and `metadataFields` are display settings and name field IDs as written.
|
|
998
1004
|
*/
|
|
999
1005
|
sort?: {
|
|
1000
1006
|
field: string;
|
|
@@ -1025,25 +1031,25 @@ interface ViewDefinition extends ViewConfig {
|
|
|
1025
1031
|
* columns, and metadata settings.
|
|
1026
1032
|
*
|
|
1027
1033
|
* @example
|
|
1028
|
-
* const
|
|
1029
|
-
* name: '
|
|
1030
|
-
* description: '
|
|
1034
|
+
* const featuredPosts = defineView('featuredPosts', {
|
|
1035
|
+
* name: 'Featured Posts',
|
|
1036
|
+
* description: 'Blog posts marked as featured',
|
|
1031
1037
|
* icon: '📝',
|
|
1032
1038
|
* scope: { type: 'contentType', contentType: 'post' },
|
|
1033
1039
|
* filters: [
|
|
1034
|
-
* { field: '
|
|
1040
|
+
* { field: 'fields.featured', operator: 'is', value: true }
|
|
1035
1041
|
* ],
|
|
1036
1042
|
* columns: ['title', 'author', 'publishedAt'],
|
|
1037
1043
|
* metadataFields: ['category', 'views'],
|
|
1038
|
-
* sort: { field: 'publishedAt', direction: 'desc' }
|
|
1044
|
+
* sort: { field: '_metadata.publishedAt', direction: 'desc' }
|
|
1039
1045
|
* })
|
|
1040
1046
|
*
|
|
1041
1047
|
* @example
|
|
1042
|
-
* const
|
|
1043
|
-
* name: '
|
|
1048
|
+
* const archivedContent = defineView('archivedContent', {
|
|
1049
|
+
* name: 'Archived',
|
|
1044
1050
|
* scope: { type: 'all' },
|
|
1045
1051
|
* filters: [
|
|
1046
|
-
* { field: 'status', operator: 'is', value: '
|
|
1052
|
+
* { field: '_metadata.status', operator: 'is', value: 'archived' }
|
|
1047
1053
|
* ]
|
|
1048
1054
|
* })
|
|
1049
1055
|
*
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { A as AnyFieldDefinition, c as FieldDefinition, k as AIConfig, v as FieldSchemaContext, x as FieldValues, y as DeclaredFields, aK as components, P as ContentTypeDefinition, a0 as SingletonContentTypeDefinition, aH as WorkflowDefinition, a9 as AssetTypeDefinition, W as InferContentType } from './define-content-type-
|
|
1
|
+
import { A as AnyFieldDefinition, c as FieldDefinition, k as AIConfig, v as FieldSchemaContext, x as FieldValues, y as DeclaredFields, aK as components, P as ContentTypeDefinition, a0 as SingletonContentTypeDefinition, aH as WorkflowDefinition, a9 as AssetTypeDefinition, W as InferContentType } from './define-content-type-ENAod5Ve.cjs';
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* Component definition matching @relyio/schema ComponentSchema
|
|
@@ -928,7 +928,11 @@ type ViewFilterValue = string | number | boolean | null | (string | number)[] |
|
|
|
928
928
|
*/
|
|
929
929
|
interface ViewFilterCondition {
|
|
930
930
|
/**
|
|
931
|
-
*
|
|
931
|
+
* The Property to filter on, as the Studio's entry list names it: `fields.<id>` for a field your
|
|
932
|
+
* schema declares (`fields.seo.title` for a component's sub-field), `_metadata.<id>` for a system
|
|
933
|
+
* field — `_metadata.status`, `_metadata.createdAt`, `_metadata.updatedAt`. So a field called
|
|
934
|
+
* `status` (`fields.status`) and the entry's own lifecycle (`_metadata.status`) are both
|
|
935
|
+
* filterable.
|
|
932
936
|
*/
|
|
933
937
|
field: string;
|
|
934
938
|
/**
|
|
@@ -994,7 +998,9 @@ interface ViewConfig {
|
|
|
994
998
|
*/
|
|
995
999
|
metadataFields?: string[];
|
|
996
1000
|
/**
|
|
997
|
-
* Default sort
|
|
1001
|
+
* Default sort (optional). `field` names the Property to sort by, as a filter names one —
|
|
1002
|
+
* `fields.<id>` or `_metadata.<id>` — and deploy refuses one the view's entries cannot be sorted
|
|
1003
|
+
* by. `columns` and `metadataFields` are display settings and name field IDs as written.
|
|
998
1004
|
*/
|
|
999
1005
|
sort?: {
|
|
1000
1006
|
field: string;
|
|
@@ -1025,25 +1031,25 @@ interface ViewDefinition extends ViewConfig {
|
|
|
1025
1031
|
* columns, and metadata settings.
|
|
1026
1032
|
*
|
|
1027
1033
|
* @example
|
|
1028
|
-
* const
|
|
1029
|
-
* name: '
|
|
1030
|
-
* description: '
|
|
1034
|
+
* const featuredPosts = defineView('featuredPosts', {
|
|
1035
|
+
* name: 'Featured Posts',
|
|
1036
|
+
* description: 'Blog posts marked as featured',
|
|
1031
1037
|
* icon: '📝',
|
|
1032
1038
|
* scope: { type: 'contentType', contentType: 'post' },
|
|
1033
1039
|
* filters: [
|
|
1034
|
-
* { field: '
|
|
1040
|
+
* { field: 'fields.featured', operator: 'is', value: true }
|
|
1035
1041
|
* ],
|
|
1036
1042
|
* columns: ['title', 'author', 'publishedAt'],
|
|
1037
1043
|
* metadataFields: ['category', 'views'],
|
|
1038
|
-
* sort: { field: 'publishedAt', direction: 'desc' }
|
|
1044
|
+
* sort: { field: '_metadata.publishedAt', direction: 'desc' }
|
|
1039
1045
|
* })
|
|
1040
1046
|
*
|
|
1041
1047
|
* @example
|
|
1042
|
-
* const
|
|
1043
|
-
* name: '
|
|
1048
|
+
* const archivedContent = defineView('archivedContent', {
|
|
1049
|
+
* name: 'Archived',
|
|
1044
1050
|
* scope: { type: 'all' },
|
|
1045
1051
|
* filters: [
|
|
1046
|
-
* { field: 'status', operator: 'is', value: '
|
|
1052
|
+
* { field: '_metadata.status', operator: 'is', value: 'archived' }
|
|
1047
1053
|
* ]
|
|
1048
1054
|
* })
|
|
1049
1055
|
*
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { K as MergedRelyIOConfig, A as ApiPath, c as ApiMethod, N as PathParamsOf, w as ApiResponse, W as Wire, v as RequestConfig, B as BaseContent, h as WhereClause, Q as QueryOptions, j as SortOptions, k as ContentQueryResult, C as CreateInput, U as UpdateInput, S as SDKError, H as BaseValidationError, G as ValidationViolation, R as RelyIOConfig, a as RelyIOConfigUpdate } from './index-
|
|
2
|
-
import { aK as components, aJ as paths, W as InferContentType, aa as InferAssetType, a3 as InferSingleton } from './define-content-type-
|
|
3
|
-
import { a as SchemaDefinition, b as SchemaContentTypeNames, j as SchemaEntryOf, ax as FilterOperator, h as SchemaAssetTypeNames, c as SchemaSingletonNames, g as SchemaSettingsGroupNames, I as InferSettingsGroup, e as SchemaQueryNames, f as SchemaLocaleCodes } from './define-schema-
|
|
1
|
+
import { K as MergedRelyIOConfig, A as ApiPath, c as ApiMethod, N as PathParamsOf, w as ApiResponse, W as Wire, v as RequestConfig, B as BaseContent, h as WhereClause, Q as QueryOptions, j as SortOptions, k as ContentQueryResult, C as CreateInput, U as UpdateInput, S as SDKError, H as BaseValidationError, G as ValidationViolation, R as RelyIOConfig, a as RelyIOConfigUpdate } from './index-C73cK2Tt.js';
|
|
2
|
+
import { aK as components, aJ as paths, W as InferContentType, aa as InferAssetType, a3 as InferSingleton } from './define-content-type-ENAod5Ve.js';
|
|
3
|
+
import { a as SchemaDefinition, b as SchemaContentTypeNames, j as SchemaEntryOf, ax as FilterOperator, h as SchemaAssetTypeNames, c as SchemaSingletonNames, g as SchemaSettingsGroupNames, I as InferSettingsGroup, e as SchemaQueryNames, f as SchemaLocaleCodes } from './define-schema-CVi8nwc7.js';
|
|
4
4
|
import { VisitorResyncReason } from './live-visitor.js';
|
|
5
5
|
import { DevUnreadableReason } from './dev-handshake/index.js';
|
|
6
6
|
|
|
@@ -863,9 +863,9 @@ declare class ContentClient<T extends BaseContent = BaseContent> {
|
|
|
863
863
|
/**
|
|
864
864
|
* Upload/processing error taxonomy (plan 17, 00b Step 4).
|
|
865
865
|
*
|
|
866
|
-
* A **thin customer-side mirror** of the
|
|
866
|
+
* A **thin customer-side mirror** of the live-contracts `FileErrorCode`
|
|
867
867
|
* (correction C6 — the SDK must not import the server/Studio contracts package).
|
|
868
|
-
* Keep the members in sync with `@relyio/
|
|
868
|
+
* Keep the members in sync with `@relyio/live-contracts`.
|
|
869
869
|
*
|
|
870
870
|
* Written once, as values, because a processing failure's code arrives as a string the service
|
|
871
871
|
* stored and has to be recognised at runtime; `FileErrorCode` is read off this list. The module is
|
|
@@ -876,7 +876,7 @@ declare const FILE_ERROR_CODES: readonly ["UPLOAD_TOO_LARGE", "UNSUPPORTED_MIME"
|
|
|
876
876
|
|
|
877
877
|
/**
|
|
878
878
|
* Upload/processing error taxonomy (plan 17, 00b Step 4): a customer-side mirror of the
|
|
879
|
-
*
|
|
879
|
+
* live-contracts `FileErrorCode`, read off the list in `./file-error-codes`.
|
|
880
880
|
*/
|
|
881
881
|
type FileErrorCode = (typeof FILE_ERROR_CODES)[number];
|
|
882
882
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { K as MergedRelyIOConfig, A as ApiPath, c as ApiMethod, N as PathParamsOf, w as ApiResponse, W as Wire, v as RequestConfig, B as BaseContent, h as WhereClause, Q as QueryOptions, j as SortOptions, k as ContentQueryResult, C as CreateInput, U as UpdateInput, S as SDKError, H as BaseValidationError, G as ValidationViolation, R as RelyIOConfig, a as RelyIOConfigUpdate } from './index-
|
|
2
|
-
import { aK as components, aJ as paths, W as InferContentType, aa as InferAssetType, a3 as InferSingleton } from './define-content-type-
|
|
3
|
-
import { a as SchemaDefinition, b as SchemaContentTypeNames, j as SchemaEntryOf, ax as FilterOperator, h as SchemaAssetTypeNames, c as SchemaSingletonNames, g as SchemaSettingsGroupNames, I as InferSettingsGroup, e as SchemaQueryNames, f as SchemaLocaleCodes } from './define-schema-
|
|
1
|
+
import { K as MergedRelyIOConfig, A as ApiPath, c as ApiMethod, N as PathParamsOf, w as ApiResponse, W as Wire, v as RequestConfig, B as BaseContent, h as WhereClause, Q as QueryOptions, j as SortOptions, k as ContentQueryResult, C as CreateInput, U as UpdateInput, S as SDKError, H as BaseValidationError, G as ValidationViolation, R as RelyIOConfig, a as RelyIOConfigUpdate } from './index-BM42r4yg.cjs';
|
|
2
|
+
import { aK as components, aJ as paths, W as InferContentType, aa as InferAssetType, a3 as InferSingleton } from './define-content-type-ENAod5Ve.cjs';
|
|
3
|
+
import { a as SchemaDefinition, b as SchemaContentTypeNames, j as SchemaEntryOf, ax as FilterOperator, h as SchemaAssetTypeNames, c as SchemaSingletonNames, g as SchemaSettingsGroupNames, I as InferSettingsGroup, e as SchemaQueryNames, f as SchemaLocaleCodes } from './define-schema-DqpipEHv.cjs';
|
|
4
4
|
import { VisitorResyncReason } from './live-visitor.js';
|
|
5
5
|
import { DevUnreadableReason } from './dev-handshake/index.cjs';
|
|
6
6
|
|
|
@@ -863,9 +863,9 @@ declare class ContentClient<T extends BaseContent = BaseContent> {
|
|
|
863
863
|
/**
|
|
864
864
|
* Upload/processing error taxonomy (plan 17, 00b Step 4).
|
|
865
865
|
*
|
|
866
|
-
* A **thin customer-side mirror** of the
|
|
866
|
+
* A **thin customer-side mirror** of the live-contracts `FileErrorCode`
|
|
867
867
|
* (correction C6 — the SDK must not import the server/Studio contracts package).
|
|
868
|
-
* Keep the members in sync with `@relyio/
|
|
868
|
+
* Keep the members in sync with `@relyio/live-contracts`.
|
|
869
869
|
*
|
|
870
870
|
* Written once, as values, because a processing failure's code arrives as a string the service
|
|
871
871
|
* stored and has to be recognised at runtime; `FileErrorCode` is read off this list. The module is
|
|
@@ -876,7 +876,7 @@ declare const FILE_ERROR_CODES: readonly ["UPLOAD_TOO_LARGE", "UNSUPPORTED_MIME"
|
|
|
876
876
|
|
|
877
877
|
/**
|
|
878
878
|
* Upload/processing error taxonomy (plan 17, 00b Step 4): a customer-side mirror of the
|
|
879
|
-
*
|
|
879
|
+
* live-contracts `FileErrorCode`, read off the list in `./file-error-codes`.
|
|
880
880
|
*/
|
|
881
881
|
type FileErrorCode = (typeof FILE_ERROR_CODES)[number];
|
|
882
882
|
/**
|