@relyio/sdk 0.6.0 → 0.8.0

package/dist/{chunk-XJVY2CLY.js → chunk-YEJUMW4X.js}

@@ -4,8 +4,8 @@ import { __name, __export } from './chunk-XQ4QHWZE.js';
 
 // src/schema/define-schema.ts
 function defineSchema(config) {
-  if (config.contentTypes == null || Object.keys(config.contentTypes).length === 0) {
-    throw new Error("Schema must have at least one content type");
+  if (config.contentTypes == null) {
+    throw new Error("Schema must declare contentTypes (an empty object declares none)");
   }
   if (config.locales && config.locales.length > 0) {
     const defaultLocales = config.locales.filter((l) => l.default === true);
@@ -47,7 +47,7 @@ function defineSchema(config) {
     const builtInRoles = /* @__PURE__ */ new Set(["admin", "editor", "viewer"]);
     const customRoleIds = new Set(config.roles?.map((r) => r.id) ?? []);
     const allRoleIds = /* @__PURE__ */ new Set([...builtInRoles, ...customRoleIds]);
-    for (const stage of config.workflow.stages) {
+    for (const stage of config.workflow.stages ?? []) {
       if (stage.allowedRoles) {
         for (const roleId of stage.allowedRoles) {
           if (!allRoleIds.has(roleId)) {
@@ -93,16 +93,16 @@ function defineSchema(config) {
   }
   return {
     _tag: "schema",
-    ...config.locales && config.locales.length > 0 && { locales: config.locales },
+    ...config.locales !== void 0 && { locales: config.locales },
     contentTypes: config.contentTypes,
     components: config.components ?? {},
     singletonContentTypes: config.singletonContentTypes ?? {},
     queries: config.queries ?? {},
     settingsGroups: config.settingsGroups,
     ...config.assetTypes && { assetTypes: config.assetTypes },
-    ...config.roles && config.roles.length > 0 && { roles: config.roles },
+    ...config.roles !== void 0 && { roles: config.roles },
     ...config.workflow && { workflow: config.workflow },
-    ...config.views && config.views.length > 0 && { views: config.views }
+    ...config.views !== void 0 && { views: config.views }
   };
 }
 __name(defineSchema, "defineSchema");
@@ -135,9 +135,9 @@ function defineLocale(code, options) {
     code,
     displayName: options.displayName,
     ...options.default !== void 0 && { default: options.default },
-    ...options.fallback && options.fallback.length > 0 && { fallback: options.fallback },
-    ...options.direction && options.direction !== "ltr" && { direction: options.direction },
-    ...options.active !== void 0 && options.active !== true && { active: options.active }
+    ...options.fallback !== void 0 && { fallback: options.fallback },
+    ...options.direction !== void 0 && { direction: options.direction },
+    ...options.active !== void 0 && { active: options.active }
   };
 }
 __name(defineLocale, "defineLocale");
@@ -185,6 +185,9 @@ function fieldset(id, config) {
     id,
     displayName: config.displayName,
     description: config.description,
+    ...config.collapsedByDefault !== void 0 && {
+      collapsedByDefault: config.collapsedByDefault
+    },
     ai: config.ai,
     fields: config.fields
   };
@@ -199,8 +202,10 @@ function defineContentType(name, config) {
     description: config.description,
     ai: config.ai,
     displayField: config.displayField,
-    hierarchical: config.hierarchical ?? false,
-    ...config.accessTags !== void 0 && config.accessTags.length > 0 && { accessTags: config.accessTags },
+    // Written only when given: it was `false` whenever not, so the same content type was one
+    // 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 }
   };
   if ("fields" in config && config.fields) {
@@ -223,8 +228,11 @@ function defineSingletonContentType(name, config) {
     description: config.description,
     ai: config.ai,
     displayField: config.displayField,
-    hierarchical: false,
-    ...config.accessTags !== void 0 && config.accessTags.length > 0 && { accessTags: config.accessTags }
+    // Written only when given, as a content type's is (REL-1458)
+    ...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 }
   };
   if ("fields" in config && config.fields) {
     return { ...base, fields: config.fields };
@@ -245,7 +253,9 @@ function defineComponent(name, config) {
     displayName: config.displayName,
     description: config.description,
     ai: config.ai,
-    deprecated: config.deprecated ?? false,
+    // 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
   };
@@ -260,7 +270,7 @@ function defineSettingsGroup(name, config) {
     displayName: config.displayName,
     description: config.description,
     ai: config.ai,
-    ...config.accessTags !== void 0 && config.accessTags.length > 0 && { accessTags: config.accessTags },
+    ...config.accessTags !== void 0 && { accessTags: config.accessTags },
     fields: config.fields
   };
 }
@@ -285,7 +295,8 @@ function defineAssetType(name, config) {
     description: config.description,
     ai: config.ai,
     displayField: config.displayField,
-    ...config.accessTags !== void 0 && config.accessTags.length > 0 && { accessTags: config.accessTags },
+    // An empty list too, as a content type's and a settings group's are kept (REL-1457, REL-1458)
+    ...config.accessTags !== void 0 && { accessTags: config.accessTags },
     ...config.workflow !== void 0 && { workflow: config.workflow },
     ...config.image !== void 0 && { image: config.image },
     ...config.video !== void 0 && { video: config.video },
@@ -297,7 +308,7 @@ function defineAssetType(name, config) {
   if ("fieldsets" in config && config.fieldsets) {
     return { ...base, fieldsets: config.fieldsets };
   }
-  throw new Error(`Asset type '${name}' must have either fields or fieldsets`);
+  return base;
 }
 __name(defineAssetType, "defineAssetType");
 
@@ -367,10 +378,10 @@ function defineRole(id, config) {
     _tag: "role",
     id,
     displayName: config.displayName,
-    ...config.description !== void 0 && config.description !== "" && { description: config.description },
+    ...config.description !== void 0 && { description: config.description },
     ...config.baseRole !== void 0 && { baseRole: config.baseRole },
-    ...hasIncludes && { includes: config.includes },
-    ...hasPermissions && { permissions: config.permissions },
+    ...config.includes !== void 0 && { includes: config.includes },
+    ...config.permissions !== void 0 && { permissions: config.permissions },
     ...config.fields !== void 0 && { fields: config.fields }
   };
 }
@@ -411,8 +422,7 @@ function defineWorkflowStage(id, config) {
   if (config.description != null && config.description.length > 512) {
     throw new Error(`Workflow stage description must be 512 characters or less`);
   }
-  const requiredApprovals = config.requiredApprovals ?? 1;
-  if (requiredApprovals < 1 || requiredApprovals > 10) {
+  if (config.requiredApprovals !== void 0 && (config.requiredApprovals < 1 || config.requiredApprovals > 10)) {
     throw new Error(`requiredApprovals must be between 1 and 10`);
   }
   if (config.timeoutDays !== void 0) {
@@ -429,9 +439,9 @@ function defineWorkflowStage(id, config) {
     _tag: "workflowStage",
     id,
     displayName: config.displayName,
-    ...config.description !== void 0 && config.description !== "" && { description: config.description },
-    requiredApprovals,
-    ...config.allowedRoles !== void 0 && config.allowedRoles.length > 0 && { allowedRoles: config.allowedRoles },
+    ...config.description !== void 0 && { description: config.description },
+    ...config.requiredApprovals !== void 0 && { requiredApprovals: config.requiredApprovals },
+    ...config.allowedRoles !== void 0 && { allowedRoles: config.allowedRoles },
     ...config.autoAssign !== void 0 && { autoAssign: config.autoAssign },
     ...config.timeoutDays !== void 0 && { timeoutDays: config.timeoutDays },
     ...config.escalation !== void 0 && { escalation: config.escalation }
@@ -439,28 +449,25 @@ function defineWorkflowStage(id, config) {
 }
 __name(defineWorkflowStage, "defineWorkflowStage");
 function defineWorkflow(config) {
-  const enabled = config.enabled ?? false;
-  const stages = config.stages ?? [];
-  if (stages.length > 0) {
-    const stageIds = /* @__PURE__ */ new Set();
-    for (const stage of stages) {
-      if (stageIds.has(stage.id)) {
-        throw new Error(`Duplicate workflow stage ID '${stage.id}'`);
-      }
-      stageIds.add(stage.id);
+  const stageIds = /* @__PURE__ */ new Set();
+  for (const stage of config.stages ?? []) {
+    if (stageIds.has(stage.id)) {
+      throw new Error(`Duplicate workflow stage ID '${stage.id}'`);
     }
+    stageIds.add(stage.id);
   }
   return {
     _tag: "workflow",
-    enabled,
-    stages
+    ...config.enabled !== void 0 && { enabled: config.enabled },
+    ...config.stages !== void 0 && { stages: config.stages }
   };
 }
 __name(defineWorkflow, "defineWorkflow");
 function defineContentTypeWorkflow(config) {
   return {
     ...config.enabled !== void 0 && { enabled: config.enabled },
-    ...config.stages !== void 0 && config.stages.length > 0 && { stages: config.stages },
+    // An empty list too, as YAML keeps it (REL-1458)
+    ...config.stages !== void 0 && { stages: config.stages },
     ...config.autoPublish !== void 0 && { autoPublish: config.autoPublish },
     ...config.requireAllLocales !== void 0 && { requireAllLocales: config.requireAllLocales }
   };
@@ -474,41 +481,44 @@ function isWorkflowDefinition(value) {
   return typeof value === "object" && value !== null && "_tag" in value && value._tag === "workflow";
 }
 __name(isWorkflowDefinition, "isWorkflowDefinition");
+function stagesOf(workflow) {
+  return workflow.stages ?? [];
+}
+__name(stagesOf, "stagesOf");
 function getWorkflowStageIds(workflow) {
-  return workflow.stages.map((s) => s.id);
+  return stagesOf(workflow).map((s) => s.id);
 }
 __name(getWorkflowStageIds, "getWorkflowStageIds");
 function findWorkflowStage(workflow, stageId) {
-  return workflow.stages.find((s) => s.id === stageId);
+  return stagesOf(workflow).find((s) => s.id === stageId);
 }
 __name(findWorkflowStage, "findWorkflowStage");
 function getNextWorkflowStage(workflow, currentStageId) {
-  const currentIndex = workflow.stages.findIndex((s) => s.id === currentStageId);
-  if (currentIndex === -1 || currentIndex === workflow.stages.length - 1) {
+  const stages = stagesOf(workflow);
+  const currentIndex = stages.findIndex((s) => s.id === currentStageId);
+  if (currentIndex === -1 || currentIndex === stages.length - 1) {
     return null;
   }
-  const nextStage = workflow.stages[currentIndex + 1];
+  const nextStage = stages[currentIndex + 1];
   return nextStage ?? null;
 }
 __name(getNextWorkflowStage, "getNextWorkflowStage");
 function getFirstWorkflowStage(workflow) {
-  if (workflow.stages.length === 0) return null;
-  const firstStage = workflow.stages[0];
+  const stages = stagesOf(workflow);
+  if (stages.length === 0) return null;
+  const firstStage = stages[0];
   return firstStage ?? null;
 }
 __name(getFirstWorkflowStage, "getFirstWorkflowStage");
 function isFinalWorkflowStage(workflow, stageId) {
-  if (workflow.stages.length === 0) return false;
-  const lastStage = workflow.stages[workflow.stages.length - 1];
+  const stages = stagesOf(workflow);
+  if (stages.length === 0) return false;
+  const lastStage = stages[stages.length - 1];
   return lastStage?.id === stageId;
 }
 __name(isFinalWorkflowStage, "isFinalWorkflowStage");
 
 // src/schema/define-view.ts
-function generateSlugFromId(id) {
-  return id.replace(/([a-z])([A-Z])/g, "$1-$2").replace(/[_\s]+/g, "-").toLowerCase();
-}
-__name(generateSlugFromId, "generateSlugFromId");
 function defineView(id, config) {
   if (!id.match(/^[a-zA-Z][a-zA-Z0-9_-]*$/)) {
     throw new Error(
@@ -524,16 +534,14 @@ function defineView(id, config) {
   if (!config.scope?.type) {
     throw new Error(`View '${id}' must have a valid scope`);
   }
-  const slug2 = config.slug ?? generateSlugFromId(id);
-  if (!slug2.match(/^[a-z][a-z0-9-]*$/)) {
+  if (config.slug !== void 0 && !/^[a-z][a-z0-9-]*$/.test(config.slug)) {
     throw new Error(
-      `View '${id}' slug '${slug2}' must be lowercase, start with a letter, and contain only letters, numbers, and hyphens`
+      `View '${id}' slug '${config.slug}' must be lowercase, start with a letter, and contain only letters, numbers, and hyphens`
     );
   }
   return {
     _tag: "view",
     id,
-    slug: slug2,
     ...config
   };
 }
@@ -541,8 +549,8 @@ __name(defineView, "defineView");
 
 // src/schema/define-query.ts
 function defineQuery(name, config) {
-  if (!config.fetch && !config.aggregate && !config.search && !config.similar) {
-    throw new Error("Query must have at least one of: fetch, aggregate, search, or similar");
+  if (!config.fetch && !config.aggregate && !config.search) {
+    throw new Error("Query must have at least one of: fetch, aggregate or search");
   }
   if (!config.endpoint.startsWith("/api/")) {
     throw new Error("Query endpoint must start with /api/");
@@ -550,14 +558,15 @@ function defineQuery(name, config) {
   return {
     _tag: "query",
     name,
+    type: config.type,
     endpoint: config.endpoint,
     description: config.description,
     fetch: config.fetch,
     aggregate: config.aggregate,
     search: config.search,
-    similar: config.similar,
     include: config.include,
     filters: config.filters,
+    fullText: config.fullText,
     select: config.select,
     cache: config.cache,
     parameters: config.parameters,
@@ -595,7 +604,8 @@ function createField(id, type, options = {}) {
     ...options.config !== void 0 && { config: options.config },
     ...options.ui !== void 0 && { ui: options.ui },
     ...options.ai !== void 0 && { ai: options.ai },
-    ...options.rules !== void 0 && options.rules.length > 0 && { rules: options.rules },
+    // An empty list too: dropping it made a YAML field and a TypeScript one two definitions (REL-1458)
+    ...options.rules !== void 0 && { rules: options.rules },
     ...options.localization !== void 0 && { localization: options.localization },
     ...options.fallback !== void 0 && { fallback: options.fallback },
     ...options.deprecated !== void 0 && { deprecated: options.deprecated }
@@ -672,5 +682,5 @@ __name(component, "component");
 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-XJVY2CLY.js.map
-//# sourceMappingURL=chunk-XJVY2CLY.js.map
+//# sourceMappingURL=chunk-YEJUMW4X.js.map
+//# sourceMappingURL=chunk-YEJUMW4X.js.map

package/dist/client/index.cjs

@@ -1,18 +1,19 @@
 'use strict';
 
-var chunkGCMQUM6N_cjs = require('../chunk-GCMQUM6N.cjs');
+var chunkXIE7WJV3_cjs = require('../chunk-XIE7WJV3.cjs');
 require('../chunk-LSRPMNPT.cjs');
+require('../chunk-TZL374LS.cjs');
 require('../chunk-MWMSFIWN.cjs');
 
 
 
 Object.defineProperty(exports, "TypedRelyIOClient", {
   enumerable: true,
-  get: function () { return chunkGCMQUM6N_cjs.TypedRelyIOClient; }
+  get: function () { return chunkXIE7WJV3_cjs.TypedRelyIOClient; }
 });
 Object.defineProperty(exports, "createClient", {
   enumerable: true,
-  get: function () { return chunkGCMQUM6N_cjs.createClient; }
+  get: function () { return chunkXIE7WJV3_cjs.createClient; }
 });
 //# sourceMappingURL=index.cjs.map
 //# sourceMappingURL=index.cjs.map

package/dist/client/index.d.cts

@@ -1,5 +1,6 @@
-export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-Df1VsfJR.cjs';
-import '../index-d1Kz1e19.cjs';
-import '../define-content-type-CDB3kyeA.cjs';
-import '../define-schema-1kr2HIzN.cjs';
+export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-DBoPPlT1.cjs';
+import '../index-B_rIWO_l.cjs';
+import '../define-content-type-cEGjIwT5.cjs';
+import '../define-schema-DgbJ5Kwn.cjs';
+import './live-visitor.js';
 import '../dev-handshake/index.cjs';

package/dist/client/index.d.ts

@@ -1,5 +1,6 @@
-export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-XqoGUaAY.js';
-import '../index-yPbhZc6q.js';
-import '../define-content-type-CDB3kyeA.js';
-import '../define-schema-ChvAzY8H.js';
+export { e as ClientSchema, R as Register, f as RegisteredSchema, d as TypedClientConfig, T as TypedRelyIOClient, c as createClient } from '../index-yRJ2IqM_.js';
+import '../index-Cv4tmcrw.js';
+import '../define-content-type-cEGjIwT5.js';
+import '../define-schema-BPj2srgh.js';
+import './live-visitor.js';
 import '../dev-handshake/index.js';

package/dist/client/index.js

@@ -1,5 +1,6 @@
-export { TypedRelyIOClient, createClient } from '../chunk-7ABNXVWL.js';
+export { TypedRelyIOClient, createClient } from '../chunk-QFHVF3YF.js';
 import '../chunk-BBUB7C2Z.js';
+import '../chunk-H6IBQSMM.js';
 import '../chunk-XQ4QHWZE.js';
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map