clivly 0.9.1 → 0.9.3

package/{entity-config-nuXge6rY.cjs → entity-config-DtBsl2MQ.cjs}

@@ -437,10 +437,23 @@ const entitySchema = require_projection.strictObject({
 	relationships: require_projection.record(require_projection.string(), relationshipSchema).optional(),
 	/**
 	* For a "custom" entity, the crm_object_types row this materializes into.
-	* Required for custom (enforced at the API layer), unused for standard concepts.
+	* Server-generated, so pasting one into config couples the file to a
+	* specific workspace. Prefer declaring `objectType` and letting
+	* `clivly push-schema` resolve the id by slug.
 	*/
 	targetObjectTypeId: require_projection.string().min(1).optional(),
 	/**
+	* Declares the custom object this entity materializes into, so config is
+	* self-contained: the entity key is the slug (unique per org and immutable),
+	* and `clivly push-schema` creates the object type if the workspace does not
+	* have it yet. An alternative to pasting a `targetObjectTypeId`.
+	*/
+	objectType: require_projection.strictObject({
+		name: require_projection.string().min(1),
+		pluralName: require_projection.string().min(1).optional(),
+		iconKey: require_projection.string().min(1).optional()
+	}).optional(),
+	/**
 	* Advanced mapping: derive this entity from a base table plus explicit joins
 	* instead of a single source table. Valid only for `concept: "custom"`.
 	*
@@ -482,17 +495,22 @@ function defaultWarn(message) {
 	console.warn(message);
 }
 /**
-* Structural helper for `clivly.config.ts`. Gives full type inference on the
-* literal you pass and eagerly parses it, so shape errors surface at config
-* load rather than at sync time.
-*
-* It also catches the silent-data-loss footgun: a non-canonical field key for a
-* materialised concept (e.g. `fullName` instead of `name` on a `contact`) has no
-* destination column, so the store would write an empty value. By default these
-* are reported via `onWarn` (a `console.warn`); pass `{ strict: true }` to throw
-* a `ClivlyConfigError` instead. Does NOT validate against the host schema — that
-* needs the discovered schema; see `validateEntitiesConfig`.
+* The custom objects a config declares, keyed by entity slug. Entities that
+* already carry an explicit `targetObjectTypeId` are omitted: their object type
+* exists server-side and re-declaring it would be a no-op at best.
 */
+function customObjectDeclarations(config) {
+	const declarations = [];
+	for (const [slug, entity] of Object.entries(config.entities)) {
+		if (entity.concept !== "custom" || entity.targetObjectTypeId) continue;
+		if (!entity.objectType) continue;
+		declarations.push({
+			slug,
+			...entity.objectType
+		});
+	}
+	return declarations;
+}
 /**
 * The `fields` entry a projection binding implies, qualified as `ref.column`.
 * Qualified rather than bare: two bindings can pull the same column name from
@@ -632,7 +650,7 @@ function validateEntity(v, config, key, entity, schema) {
 	}
 	if (entity.projection) {
 		if (entity.concept !== "custom") v.report(`${base}.projection`, `projection mappings are only supported for concept "${CUSTOM_CONCEPT}"`);
-		if (!entity.targetObjectTypeId) v.report(`${base}.targetObjectTypeId`, "a projection mapping must target a custom object type");
+		if (!(entity.targetObjectTypeId || entity.objectType)) v.report(`${base}.targetObjectTypeId`, "a projection mapping must target a custom object type — declare `objectType: { name: \"…\" }` (recommended: the entity key becomes its slug) or set an explicit `targetObjectTypeId`");
 		if (entity.source !== entity.projection.baseTable) v.report(`${base}.source`, `"source" ("${entity.source}") must match "projection.baseTable" ("${entity.projection.baseTable}") — the view compiler reads baseTable and the sync engine reads source, so a mismatch makes them disagree about which table this entity is`);
 		for (const error of validateProjection(entity.projection, schema, base)) v.report(error.path, error.message);
 		validateReadOnly(v, base, entity);
@@ -704,6 +722,12 @@ Object.defineProperty(exports, "coversUniqueKey", {
 		return coversUniqueKey;
 	}
 });
+Object.defineProperty(exports, "customObjectDeclarations", {
+	enumerable: true,
+	get: function() {
+		return customObjectDeclarations;
+	}
+});
 Object.defineProperty(exports, "defineClivlyConfig", {
 	enumerable: true,
 	get: function() {

package/{entity-config-D08zAeFY.mjs → entity-config-kUHri9yA.mjs}

@@ -429,10 +429,23 @@ const entitySchema = strictObject({
 	relationships: record(string(), relationshipSchema).optional(),
 	/**
 	* For a "custom" entity, the crm_object_types row this materializes into.
-	* Required for custom (enforced at the API layer), unused for standard concepts.
+	* Server-generated, so pasting one into config couples the file to a
+	* specific workspace. Prefer declaring `objectType` and letting
+	* `clivly push-schema` resolve the id by slug.
 	*/
 	targetObjectTypeId: string().min(1).optional(),
 	/**
+	* Declares the custom object this entity materializes into, so config is
+	* self-contained: the entity key is the slug (unique per org and immutable),
+	* and `clivly push-schema` creates the object type if the workspace does not
+	* have it yet. An alternative to pasting a `targetObjectTypeId`.
+	*/
+	objectType: strictObject({
+		name: string().min(1),
+		pluralName: string().min(1).optional(),
+		iconKey: string().min(1).optional()
+	}).optional(),
+	/**
 	* Advanced mapping: derive this entity from a base table plus explicit joins
 	* instead of a single source table. Valid only for `concept: "custom"`.
 	*
@@ -474,17 +487,22 @@ function defaultWarn(message) {
 	console.warn(message);
 }
 /**
-* Structural helper for `clivly.config.ts`. Gives full type inference on the
-* literal you pass and eagerly parses it, so shape errors surface at config
-* load rather than at sync time.
-*
-* It also catches the silent-data-loss footgun: a non-canonical field key for a
-* materialised concept (e.g. `fullName` instead of `name` on a `contact`) has no
-* destination column, so the store would write an empty value. By default these
-* are reported via `onWarn` (a `console.warn`); pass `{ strict: true }` to throw
-* a `ClivlyConfigError` instead. Does NOT validate against the host schema — that
-* needs the discovered schema; see `validateEntitiesConfig`.
+* The custom objects a config declares, keyed by entity slug. Entities that
+* already carry an explicit `targetObjectTypeId` are omitted: their object type
+* exists server-side and re-declaring it would be a no-op at best.
 */
+function customObjectDeclarations(config) {
+	const declarations = [];
+	for (const [slug, entity] of Object.entries(config.entities)) {
+		if (entity.concept !== "custom" || entity.targetObjectTypeId) continue;
+		if (!entity.objectType) continue;
+		declarations.push({
+			slug,
+			...entity.objectType
+		});
+	}
+	return declarations;
+}
 /**
 * The `fields` entry a projection binding implies, qualified as `ref.column`.
 * Qualified rather than bare: two bindings can pull the same column name from
@@ -624,7 +642,7 @@ function validateEntity(v, config, key, entity, schema) {
 	}
 	if (entity.projection) {
 		if (entity.concept !== "custom") v.report(`${base}.projection`, `projection mappings are only supported for concept "${CUSTOM_CONCEPT}"`);
-		if (!entity.targetObjectTypeId) v.report(`${base}.targetObjectTypeId`, "a projection mapping must target a custom object type");
+		if (!(entity.targetObjectTypeId || entity.objectType)) v.report(`${base}.targetObjectTypeId`, "a projection mapping must target a custom object type — declare `objectType: { name: \"…\" }` (recommended: the entity key becomes its slug) or set an explicit `targetObjectTypeId`");
 		if (entity.source !== entity.projection.baseTable) v.report(`${base}.source`, `"source" ("${entity.source}") must match "projection.baseTable" ("${entity.projection.baseTable}") — the view compiler reads baseTable and the sync engine reads source, so a mismatch makes them disagree about which table this entity is`);
 		for (const error of validateProjection(entity.projection, schema, base)) v.report(error.path, error.message);
 		validateReadOnly(v, base, entity);
@@ -654,4 +672,4 @@ function validateEntitiesConfig(config, schema) {
 	};
 }
 //#endregion
-export { coversUniqueKey as _, MATERIALIZING_CONCEPTS as a, filterSchema as c, relationshipsSchema as d, validateEntitiesConfig as f, columnMetaFor as g, joinFansOut as h, ClivlyConfigError as i, projectionFields as l, fanOutJoins as m, CRM_CONCEPTS as n, defineClivlyConfig as o, validateProjection as p, CUSTOM_CONCEPT as r, entitiesConfigSchema as s, CANONICAL_FIELDS as t, relationshipSchema as u, hasRichMeta as v, primaryKeyColumns as y };
+export { columnMetaFor as _, MATERIALIZING_CONCEPTS as a, primaryKeyColumns as b, entitiesConfigSchema as c, relationshipSchema as d, relationshipsSchema as f, joinFansOut as g, fanOutJoins as h, ClivlyConfigError as i, filterSchema as l, validateProjection as m, CRM_CONCEPTS as n, customObjectDeclarations as o, validateEntitiesConfig as p, CUSTOM_CONCEPT as r, defineClivlyConfig as s, CANONICAL_FIELDS as t, projectionFields as u, coversUniqueKey as v, hasRichMeta as y };