@relyio/sdk 0.11.0 → 0.12.0

package/dist/{chunk-7GLDVHIH.js → chunk-FRJEUAAF.js}

@@ -1681,10 +1681,18 @@ var _ContentQueryBuilder = class _ContentQueryBuilder {
     return this;
   }
   /**
-   * Include related content in the response
-   */
-  include(relations) {
-    this.queryOptions.include = [...this.queryOptions.include ?? [], ...relations];
+   * Expand references into the entries they point at: one include path per element (REL-1801).
+   * A path names fields through lists, page builders, objects and references —
+   * `'sections.features'`, `'sections.customers.logo'` — and may pick the fields each entry returns,
+   * `'sections.features(name,slug)'`. Each is checked against the schema: a path that holds no
+   * reference does not compile, and the read's type follows the paths — an expanded reference is the
+   * entry, every other one its id.
+   */
+  include(paths) {
+    this.queryOptions.include = [
+      ...this.queryOptions.include ?? [],
+      ...paths
+    ];
     return this;
   }
   sort(fieldOrOptions, direction) {
@@ -2069,10 +2077,15 @@ var _ContentByIdBuilder = class _ContentByIdBuilder {
     return this;
   }
   /**
-   * Include related content in the response
+   * Expand references into the entries they point at: one include path per element (REL-1801).
+   * A path names fields through lists, page builders, objects and references —
+   * `'sections.features'`, `'sections.customers.logo'` — and may pick the fields each entry returns,
+   * `'sections.features(name,slug)'`. Each is checked against the schema: a path that holds no
+   * reference does not compile, and the read's type follows the paths — an expanded reference is the
+   * entry, every other one its id. A second call adds to the first.
    */
-  include(relations) {
-    this.includeRelations = relations;
+  include(paths) {
+    this.includeRelations = [...this.includeRelations ?? [], ...paths];
     return this;
   }
   /**
@@ -2246,9 +2259,6 @@ var _ContentClient = class _ContentClient {
     }
     return builder.execute();
   }
-  /**
-   * Fetch content with query options
-   */
   async fetch(options) {
     const builder = this.query();
     if (options?.where) {
@@ -2264,7 +2274,7 @@ var _ContentClient = class _ContentClient {
       builder.sort(options.sort);
     }
     if (options?.include) {
-      builder.include(options.include);
+      builder.include([...options.include]);
     }
     if (options?.locale != null && options.locale !== "") {
       builder.locale(options.locale);
@@ -2277,16 +2287,10 @@ var _ContentClient = class _ContentClient {
     }
     return builder.execute();
   }
-  /**
-   * Fetch a single content item by ID
-   * @param id - Entry ID or slug
-   * @param options - Fetch options (include, locale, and `headers` this one request adds — e.g.
-   *   `{ 'X-RelyIO-Dataset': 'staging' }` to read a dataset other than the client's)
-   */
   async fetchOne(id, options) {
     const builder = this.findById(id);
     if (options?.include != null) {
-      builder.include(options.include);
+      builder.include([...options.include]);
     }
     if (options?.locale != null && options.locale !== "") {
       builder.locale(options.locale);
@@ -2296,27 +2300,11 @@ var _ContentClient = class _ContentClient {
     }
     return builder.execute();
   }
-  /**
-   * Fetch one entry **and the entity tag that read served**.
-   *
-   * This is the read half of a conditional write. `X-Entity-Tag` is minted from
-   * `(entryUid, locale, localeVersion)` and is exactly what `If-Match` takes,
-   * so a caller reads here, edits, and hands the same string back to `update`
-   * — with nothing to assemble in between
-   * (`INV-API-CONDITIONAL-WRITE-IS-REACHABLE`).
-   *
-   * `entityTag` is `undefined` when the response came from the cache: a cached
-   * body cannot know the current version, and an absent tag beats a stale one
-   * that would refuse the next write.
-   *
-   * Unlike {@link fetchOne}, a missing entry is not `null`: the service's
-   * `RESOURCE_NOT_FOUND` is thrown as it arrived, with the `kind` that says
-   * whether the entry, the content type or the schema was missing. `headers`
-   * are the ones this read adds, as for `fetchOne`.
-   */
   async fetchOneWithTag(id, options) {
     const query = {};
-    if (options?.include != null) query.include = options.include.join(",");
+    if (options?.include != null) {
+      query.include = options.include.join(",");
+    }
     const locale = options?.locale ?? this.clientLocale();
     if (locale != null && locale !== "") query.locale = locale;
     const response = await this.httpClient.send(
@@ -3179,10 +3167,9 @@ var _AssetClient = class _AssetClient {
       this.clientLocale
     );
   }
-  /** Fetch a single asset entry by id (or slug), or `null` if not found. */
   async fetchOne(id, options) {
     const builder = this.findById(id);
-    if (options?.include != null) builder.include(options.include);
+    if (options?.include != null) builder.include([...options.include]);
     if (options?.locale != null && options.locale !== "") builder.locale(options.locale);
     return builder.execute();
   }
@@ -3285,11 +3272,15 @@ var _SingletonClient = class _SingletonClient {
     this.clientLocale = readClientLocale(locale);
   }
   /**
-   * Include reference fields in the response
-   * @param fields - Reference field names to populate
+   * Expand references into the entries they point at: one include path per element (REL-1801).
+   * A path names fields through lists, objects and references — `'hero.media.image'`,
+   * `'featured.author'` — and may pick the fields each entry returns, `'featured(title,slug)'`.
+   * Each is checked against the schema: a path that holds no reference does not compile, and the
+   * read's type follows the paths — an expanded reference is the entry, every other one its id. A
+   * second call adds to the first.
    */
-  include(fields) {
-    this.includeFields = fields;
+  include(paths) {
+    this.includeFields = [...this.includeFields ?? [], ...paths];
     return this;
   }
   /**
@@ -3300,10 +3291,6 @@ var _SingletonClient = class _SingletonClient {
     this.localeValue = locale;
     return this;
   }
-  /**
-   * Fetch the singleton content
-   * @param options - Optional fetch options (alternative to fluent methods)
-   */
   async fetch(options) {
     try {
       return (await this.fetchWithTag(options)).content;
@@ -3321,7 +3308,7 @@ var _SingletonClient = class _SingletonClient {
    */
   async fetchWithTag(options) {
     const query = {};
-    const includeValue = options?.include ?? this.includeFields;
+    const includeValue = this.includeFields === void 0 && options?.include === void 0 ? void 0 : [...this.includeFields ?? [], ...options?.include ?? []];
     const localeValueFinal = options?.locale ?? this.localeValue ?? this.clientLocale();
     if (includeValue) query.include = includeValue.join(",");
     if (localeValueFinal != null && localeValueFinal !== "") query.locale = localeValueFinal;
@@ -3442,11 +3429,15 @@ var _SettingsClient = class _SettingsClient {
     this.clientLocale = readClientLocale(locale);
   }
   /**
-   * Include reference fields in the response
-   * @param fields - Reference field names to populate
+   * Expand references into the entries they point at: one include path per element (REL-1801).
+   * A path names fields through lists, objects and references — `'hero.media.image'`,
+   * `'featured.author'` — and may pick the fields each entry returns, `'featured(title,slug)'`.
+   * Each is checked against the schema: a path that holds no reference does not compile, and the
+   * read's type follows the paths — an expanded reference is the entry, every other one its id. A
+   * second call adds to the first.
    */
-  include(fields) {
-    this.includeFields = fields;
+  include(paths) {
+    this.includeFields = [...this.includeFields ?? [], ...paths];
     return this;
   }
   /**
@@ -3457,10 +3448,6 @@ var _SettingsClient = class _SettingsClient {
     this.localeValue = locale;
     return this;
   }
-  /**
-   * Fetch the settings group
-   * @param options - Optional fetch options (alternative to fluent methods)
-   */
   async fetch(options) {
     try {
       return (await this.fetchWithTag(options)).settings;
@@ -3498,7 +3485,7 @@ var _SettingsClient = class _SettingsClient {
    */
   async fetchWithTag(options) {
     const query = {};
-    const includeValue = options?.include ?? this.includeFields;
+    const includeValue = this.includeFields === void 0 && options?.include === void 0 ? void 0 : [...this.includeFields ?? [], ...options?.include ?? []];
     const localeValueFinal = options?.locale ?? this.localeValue ?? this.clientLocale();
     if (includeValue) query.include = includeValue.join(",");
     if (localeValueFinal != null && localeValueFinal !== "") query.locale = localeValueFinal;
@@ -6285,5 +6272,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-7GLDVHIH.js.map
-//# sourceMappingURL=chunk-7GLDVHIH.js.map
+//# sourceMappingURL=chunk-FRJEUAAF.js.map
+//# sourceMappingURL=chunk-FRJEUAAF.js.map

package/dist/{chunk-2TIJLV2X.js → chunk-POEEDYFM.js}

@@ -95,7 +95,6 @@ function defineSchema(config) {
     _tag: "schema",
     ...config.locales !== void 0 && { locales: config.locales },
     contentTypes: config.contentTypes,
-    components: config.components ?? {},
     singletonContentTypes: config.singletonContentTypes ?? {},
     queries: config.queries ?? {},
     settingsGroups: config.settingsGroups,
@@ -109,30 +108,30 @@ __name(defineSchema, "defineSchema");
 
 // src/schema/define-locale.ts
 var BCP47_PATTERN = /^[a-z]{2}(-[A-Z]{2})?$/;
-function defineLocale(code, options) {
-  if (!BCP47_PATTERN.test(code)) {
+function defineLocale(code2, options) {
+  if (!BCP47_PATTERN.test(code2)) {
     throw new Error(
-      `Invalid locale code '${code}'. Expected BCP 47 format: 'xx' or 'xx-XX' (e.g., 'en', 'en-US', 'fr-FR')`
+      `Invalid locale code '${code2}'. Expected BCP 47 format: 'xx' or 'xx-XX' (e.g., 'en', 'en-US', 'fr-FR')`
     );
   }
   if (!options.displayName || options.displayName.trim().length === 0) {
-    throw new Error(`Locale '${code}' requires a displayName`);
+    throw new Error(`Locale '${code2}' requires a displayName`);
   }
   if (options.fallback) {
     for (const fallbackCode of options.fallback) {
       if (typeof fallbackCode !== "string" || !BCP47_PATTERN.test(fallbackCode)) {
         throw new Error(
-          `Invalid fallback locale code '${fallbackCode}' in locale '${code}'. Expected BCP 47 format.`
+          `Invalid fallback locale code '${fallbackCode}' in locale '${code2}'. Expected BCP 47 format.`
         );
       }
-      if (fallbackCode === code) {
-        throw new Error(`Locale '${code}' cannot reference itself in fallback chain`);
+      if (fallbackCode === code2) {
+        throw new Error(`Locale '${code2}' cannot reference itself in fallback chain`);
       }
     }
   }
   return {
     _tag: "locale",
-    code,
+    code: code2,
     displayName: options.displayName,
     ...options.default !== void 0 && { default: options.default },
     ...options.fallback !== void 0 && { fallback: options.fallback },
@@ -161,11 +160,11 @@ function buildFallbackChain(localeCode, locales, maxDepth = 10) {
   const localeMap = new Map(locales.map((l) => [l.code, l]));
   const chain = [];
   const visited = /* @__PURE__ */ new Set();
-  function addFallbacks(code, depth) {
-    if (depth > maxDepth || visited.has(code)) return;
-    const locale = localeMap.get(code);
+  function addFallbacks(code2, depth) {
+    if (depth > maxDepth || visited.has(code2)) return;
+    const locale = localeMap.get(code2);
     if (!locale?.fallback) return;
-    visited.add(code);
+    visited.add(code2);
     for (const fallbackCode of locale.fallback) {
       if (!chain.includes(fallbackCode) && fallbackCode !== localeCode) {
         chain.push(fallbackCode);
@@ -194,7 +193,7 @@ function fieldset(id, config) {
 }
 __name(fieldset, "fieldset");
 function defineContentType(name, config) {
-  const base = {
+  return {
     _tag: "contentType",
     name,
     displayName: config.displayName,
@@ -206,21 +205,15 @@ function defineContentType(name, config) {
     // definition from YAML and another from TypeScript, with a different schemaHash (REL-1458)
     ...config.hierarchical !== void 0 && { hierarchical: config.hierarchical },
     ...config.accessTags !== void 0 && { accessTags: config.accessTags },
-    ...config.workflow !== void 0 && { workflow: config.workflow }
+    ...config.workflow !== void 0 && { workflow: config.workflow },
+    fields: config.fields
   };
-  if ("fields" in config && config.fields) {
-    return { ...base, fields: config.fields };
-  }
-  if ("fieldsets" in config && config.fieldsets) {
-    return { ...base, fieldsets: config.fieldsets };
-  }
-  throw new Error("Content type must have either fields or fieldsets");
 }
 __name(defineContentType, "defineContentType");
 
 // src/schema/define-singleton.ts
 function defineSingletonContentType(name, config) {
-  const base = {
+  return {
     _tag: "singletonContentType",
     name,
     displayName: config.displayName,
@@ -232,36 +225,13 @@ function defineSingletonContentType(name, config) {
     ...config.hierarchical !== void 0 && { hierarchical: config.hierarchical },
     ...config.accessTags !== void 0 && { accessTags: config.accessTags },
     // Its config type took `workflow` and this dropped it, so a singleton's workflow never deployed
-    ...config.workflow !== void 0 && { workflow: config.workflow }
+    ...config.workflow !== void 0 && { workflow: config.workflow },
+    fields: config.fields
   };
-  if ("fields" in config && config.fields) {
-    return { ...base, fields: config.fields };
-  }
-  if ("fieldsets" in config && config.fieldsets) {
-    return { ...base, fieldsets: config.fieldsets };
-  }
-  throw new Error("Singleton content type must have either fields or fieldsets");
 }
 __name(defineSingletonContentType, "defineSingletonContentType");
 var defineSingleton = defineSingletonContentType;
 
-// src/schema/define-component.ts
-function defineComponent(name, config) {
-  return {
-    _tag: "component",
-    name,
-    displayName: config.displayName,
-    description: config.description,
-    ai: config.ai,
-    // Written only when given: `false` whenever not made a YAML and a TypeScript component two
-    // definitions (REL-1458)
-    ...config.deprecated !== void 0 && { deprecated: config.deprecated },
-    fields: config.fields,
-    metadata: config.metadata
-  };
-}
-__name(defineComponent, "defineComponent");
-
 // src/schema/define-settings-group.ts
 function defineSettingsGroup(name, config) {
   return {
@@ -287,7 +257,7 @@ function defineAssetType(name, config) {
       `Asset type '${name}' declares multiple kind keys (${kindKeys.join(", ")}); exactly one is allowed`
     );
   }
-  const base = {
+  return {
     _tag: "assetType",
     name,
     displayName: config.displayName,
@@ -300,15 +270,9 @@ function defineAssetType(name, config) {
     ...config.workflow !== void 0 && { workflow: config.workflow },
     ...config.image !== void 0 && { image: config.image },
     ...config.video !== void 0 && { video: config.video },
-    ...config.file !== void 0 && { file: config.file }
+    ...config.file !== void 0 && { file: config.file },
+    ...config.fields !== void 0 && { fields: config.fields }
   };
-  if ("fields" in config && config.fields) {
-    return { ...base, fields: config.fields };
-  }
-  if ("fieldsets" in config && config.fieldsets) {
-    return { ...base, fieldsets: config.fieldsets };
-  }
-  return base;
 }
 __name(defineAssetType, "defineAssetType");
 
@@ -587,7 +551,7 @@ __name(defineQuery, "defineQuery");
 var fields_exports = {};
 __export(fields_exports, {
   boolean: () => boolean,
-  component: () => component,
+  code: () => code,
   date: () => date,
   dateTime: () => dateTime,
   decimal: () => decimal,
@@ -596,10 +560,12 @@ __export(fields_exports, {
   integer: () => integer,
   list: () => list,
   longText: () => longText,
+  object: () => object,
   reference: () => reference,
   richText: () => richText,
   shortText: () => shortText,
   slug: () => slug,
+  table: () => table,
   tags: () => tags,
   url: () => url
 });
@@ -632,6 +598,14 @@ function richText(id, options = {}) {
   return createField(id, "richText", options);
 }
 __name(richText, "richText");
+function table(id, options = {}) {
+  return createField(id, "table", options);
+}
+__name(table, "table");
+function code(id, options = {}) {
+  return createField(id, "code", options);
+}
+__name(code, "code");
 function slug(id, options = {}) {
   return createField(id, "slug", options);
 }
@@ -680,15 +654,14 @@ function list(id, options = {}) {
   return createField(id, "list", options);
 }
 __name(list, "list");
-function component(id, componentId, options = {}) {
-  const type = `component(${componentId})`;
-  return createField(id, type, options);
+function object(id, options) {
+  return createField(id, "object", options);
 }
-__name(component, "component");
+__name(object, "object");
 
 // src/schema/index.ts
 var fields = fields_exports;
 
-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 };
-//# sourceMappingURL=chunk-2TIJLV2X.js.map
-//# sourceMappingURL=chunk-2TIJLV2X.js.map
+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

package/dist/client/index.cjs

@@ -1,6 +1,6 @@
 'use strict';
 
-var chunk4HTIU5YE_cjs = require('../chunk-4HTIU5YE.cjs');
+var chunkDXCVO6M5_cjs = require('../chunk-DXCVO6M5.cjs');
 require('../chunk-LSRPMNPT.cjs');
 require('../chunk-TZL374LS.cjs');
 require('../chunk-MWMSFIWN.cjs');
@@ -9,11 +9,11 @@ require('../chunk-MWMSFIWN.cjs');
 
 Object.defineProperty(exports, "TypedRelyIOClient", {
   enumerable: true,
-  get: function () { return chunk4HTIU5YE_cjs.TypedRelyIOClient; }
+  get: function () { return chunkDXCVO6M5_cjs.TypedRelyIOClient; }
 });
 Object.defineProperty(exports, "createClient", {
   enumerable: true,
-  get: function () { return chunk4HTIU5YE_cjs.createClient; }
+  get: function () { return chunkDXCVO6M5_cjs.createClient; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/client/index.d.cts

@@ -1,6 +1,7 @@
-export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-MLAFUuco.cjs';
-import '../index-BM42r4yg.cjs';
-import '../define-content-type-ENAod5Ve.cjs';
-import '../define-schema-DqpipEHv.cjs';
+export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-BrvEg6-A.cjs';
+import '../index-b-AkfTUv.cjs';
+import '../rich-text.d-rKmpgdGd.cjs';
+import '../include-paths-CL4gHv6I.cjs';
+import '../define-schema-DgctHlI2.cjs';
 import './live-visitor.js';
 import '../dev-handshake/index.cjs';

package/dist/client/index.d.ts

@@ -1,6 +1,7 @@
-export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-BKEAYvvz.js';
-import '../index-C73cK2Tt.js';
-import '../define-content-type-ENAod5Ve.js';
-import '../define-schema-CVi8nwc7.js';
+export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-Pw0onkJe.js';
+import '../index-B9RfZVF1.js';
+import '../rich-text.d-rKmpgdGd.js';
+import '../include-paths-CrJNTsMl.js';
+import '../define-schema-mrEZbY1h.js';
 import './live-visitor.js';
 import '../dev-handshake/index.js';

package/dist/client/index.js

@@ -1,4 +1,4 @@
-export { TypedRelyIOClient, createClient } from '../chunk-7GLDVHIH.js';
+export { TypedRelyIOClient, createClient } from '../chunk-FRJEUAAF.js';
 import '../chunk-BBUB7C2Z.js';
 import '../chunk-H6IBQSMM.js';
 import '../chunk-XQ4QHWZE.js';