@relyio/sdk 0.12.0 → 0.13.0

package/dist/{chunk-FRJEUAAF.js → chunk-6NGJXLOR.js}

@@ -1662,13 +1662,19 @@ var _ContentQueryBuilder = class _ContentQueryBuilder {
     return this;
   }
   /**
-   * Add where conditions to the query: conditions on the fields the content type declares. A
-   * condition on `_metadata` is refused here, before anything is sent (`refuseMetadataConditions`).
+   * Add where conditions to the query, each naming a value by its path: a field the content type
+   * declares, a field inside an object (`'pricing.basePrice'`), a reference inside its blocks —
+   * `{ 'sections.features': featureId }` keeps the entries some block of which holds that feature
+   * (REL-1810) — and rich text that can point at an entry, by the entries it points at. A typed read
+   * takes exactly the paths the API filters by (`FilterPaths`, REL-2136). A condition on `_metadata`
+   * is refused here, before anything is sent (`refuseMetadataConditions`).
    */
   where(conditions) {
     refuseMetadataConditions(conditions);
     this.queryOptions.where = {
       ...this.queryOptions.where,
+      // Sent as written: a path into an object or a block, or a rich-text field's condition, rides
+      // beside the fields', which `QueryOptions` types by the record's own keys alone
       ...conditions
     };
     return this;
@@ -2260,10 +2266,11 @@ var _ContentClient = class _ContentClient {
     return builder.execute();
   }
   async fetch(options) {
-    const builder = this.query();
+    const query = this.query();
     if (options?.where) {
-      builder.where(options.where);
+      query.where(options.where);
     }
+    const builder = query;
     if (options?.limit != null) {
       builder.limit(options.limit);
     }
@@ -2358,6 +2365,8 @@ var _ContentClient = class _ContentClient {
    *   request adds, as for {@link create}. `ifMatch` and `idempotencyKey` win over the same
    *   header among them. `locale` defaults to the client's own, the locale whose entity tag
    *   {@link fetchOneWithTag} reads, so the tag it hands back is checked against the same locale.
+   * @returns The entry, its `_metadata.brokenLinks` naming each entry link another entry publishes
+   *   that this revision left pointing nowhere — empty when it took no heading away.
    */
   async update(id, data, options) {
     const { idempotencyKey, ifMatch, headers, locale, ...body } = options ?? {};
@@ -2441,6 +2450,9 @@ var _ContentClient = class _ContentClient {
    * The restore is validated as strictly as a publish, so it cannot publish invalid content, and it
    * records a new version of its own rather than rewinding the counter — so the revert is auditable
    * and itself reversible.
+   *
+   * @returns The entry, its `_metadata.leftOut` naming each value of the version the active schema
+   *   no longer declares, and `_metadata.brokenLinks` the entry links it left pointing nowhere.
    */
   async restore(id, versionNumber, locale, options) {
     return this.httpClient.fetchPayload("/v1/{contentType}/{id}/versions/{versionNumber}/restore", "post", {
@@ -2454,15 +2466,14 @@ var _ContentClient = class _ContentClient {
     });
   }
   /**
-   * Get children of a hierarchical entry
+   * Get the direct children of a hierarchical entry. The route lists one level and takes no depth
+   * (REL-2195): `{ depth }` was sent as `?depth=`, which the API refused with `400`. A tree nested
+   * under each entry is a list or entry read's `query().children()`.
    * @param id - Parent entry ID
-   * @param options - Fetch options
+   * @param options - Include paths to expand on each child, and the locale to read
    */
   async children(id, options) {
     const params = {};
-    if (options?.depth != null) {
-      params.depth = options.depth;
-    }
     if (options?.include != null) {
       params.include = options.include.join(",");
     }
@@ -6272,5 +6283,5 @@ function randomClientId() {
 __name(randomClientId, "randomClientId");
 
 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 };
-//# sourceMappingURL=chunk-FRJEUAAF.js.map
-//# sourceMappingURL=chunk-FRJEUAAF.js.map
+//# sourceMappingURL=chunk-6NGJXLOR.js.map
+//# sourceMappingURL=chunk-6NGJXLOR.js.map

package/dist/{chunk-DXCVO6M5.cjs → chunk-DEDIJKHY.cjs}

@@ -1664,13 +1664,19 @@ var _ContentQueryBuilder = class _ContentQueryBuilder {
     return this;
   }
   /**
-   * Add where conditions to the query: conditions on the fields the content type declares. A
-   * condition on `_metadata` is refused here, before anything is sent (`refuseMetadataConditions`).
+   * Add where conditions to the query, each naming a value by its path: a field the content type
+   * declares, a field inside an object (`'pricing.basePrice'`), a reference inside its blocks —
+   * `{ 'sections.features': featureId }` keeps the entries some block of which holds that feature
+   * (REL-1810) — and rich text that can point at an entry, by the entries it points at. A typed read
+   * takes exactly the paths the API filters by (`FilterPaths`, REL-2136). A condition on `_metadata`
+   * is refused here, before anything is sent (`refuseMetadataConditions`).
    */
   where(conditions) {
     refuseMetadataConditions(conditions);
     this.queryOptions.where = {
       ...this.queryOptions.where,
+      // Sent as written: a path into an object or a block, or a rich-text field's condition, rides
+      // beside the fields', which `QueryOptions` types by the record's own keys alone
       ...conditions
     };
     return this;
@@ -2262,10 +2268,11 @@ var _ContentClient = class _ContentClient {
     return builder.execute();
   }
   async fetch(options) {
-    const builder = this.query();
+    const query = this.query();
     if (options?.where) {
-      builder.where(options.where);
+      query.where(options.where);
     }
+    const builder = query;
     if (options?.limit != null) {
       builder.limit(options.limit);
     }
@@ -2360,6 +2367,8 @@ var _ContentClient = class _ContentClient {
    *   request adds, as for {@link create}. `ifMatch` and `idempotencyKey` win over the same
    *   header among them. `locale` defaults to the client's own, the locale whose entity tag
    *   {@link fetchOneWithTag} reads, so the tag it hands back is checked against the same locale.
+   * @returns The entry, its `_metadata.brokenLinks` naming each entry link another entry publishes
+   *   that this revision left pointing nowhere — empty when it took no heading away.
    */
   async update(id, data, options) {
     const { idempotencyKey, ifMatch, headers, locale, ...body } = options ?? {};
@@ -2443,6 +2452,9 @@ var _ContentClient = class _ContentClient {
    * The restore is validated as strictly as a publish, so it cannot publish invalid content, and it
    * records a new version of its own rather than rewinding the counter — so the revert is auditable
    * and itself reversible.
+   *
+   * @returns The entry, its `_metadata.leftOut` naming each value of the version the active schema
+   *   no longer declares, and `_metadata.brokenLinks` the entry links it left pointing nowhere.
    */
   async restore(id, versionNumber, locale, options) {
     return this.httpClient.fetchPayload("/v1/{contentType}/{id}/versions/{versionNumber}/restore", "post", {
@@ -2456,15 +2468,14 @@ var _ContentClient = class _ContentClient {
     });
   }
   /**
-   * Get children of a hierarchical entry
+   * Get the direct children of a hierarchical entry. The route lists one level and takes no depth
+   * (REL-2195): `{ depth }` was sent as `?depth=`, which the API refused with `400`. A tree nested
+   * under each entry is a list or entry read's `query().children()`.
    * @param id - Parent entry ID
-   * @param options - Fetch options
+   * @param options - Include paths to expand on each child, and the locale to read
    */
   async children(id, options) {
     const params = {};
-    if (options?.depth != null) {
-      params.depth = options.depth;
-    }
     if (options?.include != null) {
       params.include = options.include.join(",");
     }
@@ -6333,5 +6344,5 @@ exports.matchRoute = matchRoute;
 exports.serviceInstructedDelayMs = serviceInstructedDelayMs;
 exports.sleep = sleep;
 exports.validateFile = validateFile;
-//# sourceMappingURL=chunk-DXCVO6M5.cjs.map
-//# sourceMappingURL=chunk-DXCVO6M5.cjs.map
+//# sourceMappingURL=chunk-DEDIJKHY.cjs.map
+//# sourceMappingURL=chunk-DEDIJKHY.cjs.map

package/dist/{chunk-POEEDYFM.js → chunk-EW23SZPX.js}

@@ -558,6 +558,7 @@ __export(fields_exports, {
   email: () => email,
   enum: () => enumField,
   integer: () => integer,
+  json: () => json,
   list: () => list,
   longText: () => longText,
   object: () => object,
@@ -658,10 +659,14 @@ function object(id, options) {
   return createField(id, "object", options);
 }
 __name(object, "object");
+function json(id, options = {}) {
+  return createField(id, "json", options);
+}
+__name(json, "json");
 
 // src/schema/index.ts
 var fields = fields_exports;
 
 export { BUILT_IN_ROLES, BUILT_IN_ROLE_ACTIONS, ROLE_ACTIONS, buildFallbackChain, defineAssetType, 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 };
-//# sourceMappingURL=chunk-POEEDYFM.js.map
-//# sourceMappingURL=chunk-POEEDYFM.js.map
+//# sourceMappingURL=chunk-EW23SZPX.js.map
+//# sourceMappingURL=chunk-EW23SZPX.js.map

package/dist/{chunk-3MSFWXQL.cjs → chunk-FOSM4LMM.cjs}

@@ -560,6 +560,7 @@ chunkMWMSFIWN_cjs.__export(fields_exports, {
   email: () => email,
   enum: () => enumField,
   integer: () => integer,
+  json: () => json,
   list: () => list,
   longText: () => longText,
   object: () => object,
@@ -660,6 +661,10 @@ function object(id, options) {
   return createField(id, "object", options);
 }
 chunkMWMSFIWN_cjs.__name(object, "object");
+function json(id, options = {}) {
+  return createField(id, "json", options);
+}
+chunkMWMSFIWN_cjs.__name(json, "json");
 
 // src/schema/index.ts
 var fields = fields_exports;
@@ -697,5 +702,5 @@ exports.isLocaleDefinition = isLocaleDefinition;
 exports.isRoleDefinition = isRoleDefinition;
 exports.isWorkflowDefinition = isWorkflowDefinition;
 exports.isWorkflowStageDefinition = isWorkflowStageDefinition;
-//# sourceMappingURL=chunk-3MSFWXQL.cjs.map
-//# sourceMappingURL=chunk-3MSFWXQL.cjs.map
+//# sourceMappingURL=chunk-FOSM4LMM.cjs.map
+//# sourceMappingURL=chunk-FOSM4LMM.cjs.map