@opencxh/domain 1.97.0 → 1.99.0

package/dist/entities/activity/types.d.ts

@@ -22,7 +22,7 @@ export interface BaseActivity {
     channelId?: string;
     providerId: string;
     author: {
-        type: "user" | "contact" | "system";
+        type: "user" | "contact" | "system" | "app";
         /** Provider/account-id (Microsoft user-id, SIP account-id, etc.). */
         id?: string;
         name: string;

package/dist/entities/ai-account/types.d.ts

@@ -6,4 +6,5 @@ export interface AiAccount {
     isDefaultLlm?: boolean;
     isDefaultStt?: boolean;
     isDefaultTts?: boolean;
+    isDefaultEmbedding?: boolean;
 }

package/dist/entities/analytics/dimensions.d.ts

@@ -19,6 +19,11 @@ export type DimensionId = string;
 export type HandledBy = "teammate" | "autopilot" | "ai_assistant";
 /** How the frontend turns a raw dimension key into a display label. */
 export type DimensionLabelSource = "user" | "team" | "inbox" | "channel" | "topic" | "raw";
+/** A value->label pair for a bounded dimension, carried in the dimension declaration itself. */
+export interface DimensionOption {
+    value: string;
+    label: string;
+}
 export interface DimensionDefinition {
     id: DimensionId;
     label: string;
@@ -29,6 +34,13 @@ export interface DimensionDefinition {
      */
     multiValued?: boolean;
     labelSource?: DimensionLabelSource;
+    /**
+     * Bounded value->label set declared by the owning source. When present, the frontend resolves this
+     * dimension's value labels straight from the catalog — no per-dimension code, no source-specific
+     * fetch. This is how a source (any app) federates its own dimension labels; unbounded/entity-backed
+     * dims (agent, team, channel) omit this and are resolved by id-lookup instead.
+     */
+    options?: DimensionOption[];
 }
 /**
  * Shared base dimensions — any source app may emit facts on these. Kept un-namespaced on purpose.

package/dist/entities/attribute/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/entities/attribute/types.d.ts

@@ -0,0 +1,41 @@
+import { MutationAuthor } from '../../platform/author';
+/**
+ * Who wrote an attribute value. Doubles as the idempotency axis: each
+ * (resource, key, source) is one row, so re-writing by the same source replaces
+ * in place while different sources (a human vs the AI) keep their own value
+ * without clobbering each other. Derived from MutationAuthor; `id` is the user-id
+ * or app-name, absent for `system`.
+ */
+export interface AttributeSourceRef {
+    type: MutationAuthor["type"];
+    id?: string;
+}
+/**
+ * A single key/value fact attached to any resource (interaction, contact,
+ * activity, ...), addressed polymorphically by (resourceType, resourceId) - the
+ * same ResourceRef shape read-state uses. Keywords, summary, sentiment and future
+ * custom fields are all just keys; a new key costs zero schema changes.
+ */
+export interface Attribute {
+    id: string;
+    organizationId: string;
+    resourceType: string;
+    resourceId: string;
+    key: string;
+    /** JSON scalar | array | object; readers interpret per key. */
+    value: unknown;
+    source: AttributeSourceRef;
+    createdAt?: number;
+    updatedAt?: number;
+}
+/** One (key,value) to set on a resource. */
+export interface AttributeInput {
+    key: string;
+    value: unknown;
+}
+/** POST /attribute/:type/:id body. */
+export interface SetAttributesRequest {
+    attributes: AttributeInput[];
+}
+/** Collapsed key -> value view after applying source precedence (user > app > system). */
+export type ResolvedAttributes = Record<string, unknown>;

package/dist/entities/custom-field-def/index.d.ts

@@ -0,0 +1 @@
+export * from './types';

package/dist/entities/custom-field-def/types.d.ts

@@ -0,0 +1,40 @@
+export type CustomFieldType = "text" | "select";
+/** A selectable option for a `select` field. `label` falls back to `value` when absent. */
+export interface CustomFieldOption {
+    value: string;
+    label?: string;
+}
+/**
+ * An org-defined custom field. It gives an attribute key meaning (label, type,
+ * dropdown options) so users can fill it in on a resource; the value itself lives
+ * in the generic Attribute store keyed by `key`. Empty `teamIds` = visible on every
+ * team's conversations; otherwise only on conversations owned by one of those teams.
+ */
+export interface CustomFieldDef {
+    id: string;
+    organizationId: string;
+    /** Stable machine key, equals the Attribute key. Constrained to [a-z0-9_]+ (a dot would read as a nested form path). */
+    key: string;
+    label: string;
+    type: CustomFieldType;
+    /** For `select`: the allowed options. The stored attribute value is the option's `value`. */
+    options?: CustomFieldOption[];
+    /** `select` only: multi-select — the stored value becomes a string[]. */
+    multiValued?: boolean;
+    /** Resource kinds this field applies to, e.g. ["interaction"]. */
+    appliesTo: string[];
+    /** Empty/absent = all teams; otherwise only shown when the resource belongs to one of these teams. */
+    teamIds?: string[];
+    /**
+     * When true, this field becomes an analytics dimension `comms.cf.<key>`: every conversation-level
+     * metric can be grouped/filtered by its value. Opt-in to avoid turning free-text fields into
+     * high-cardinality dimensions.
+     */
+    reportable?: boolean;
+    required?: boolean;
+    description?: string;
+    /** Display order in the fields panel. */
+    order: number;
+    createdAt?: number;
+    updatedAt?: number;
+}

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from './entities/activity';
 export * from './entities/analytics';
+export * from './entities/attribute';
 export * from './entities/playbook';
 export * from './entities/kb';
 export * from './entities/topic';
@@ -12,6 +13,7 @@ export * from './entities/mcp';
 export * from './entities/channel';
 export * from './entities/communication';
 export * from './entities/contact';
+export * from './entities/custom-field-def';
 export * from './entities/calendar-event';
 export * from './entities/draft';
 export * from './entities/inbox';
@@ -28,6 +30,7 @@ export * from './entities/webhook';
 export * from './text/message';
 export * from './platform/ai-tools';
 export * from './platform/api';
+export * from './platform/author';
 export * from './platform/common';
 export * from './platform/capabilities';
 export * from './platform/context';
@@ -41,6 +44,7 @@ export * from './platform/manifest';
 export * from './platform/menu';
 export * from './platform/reactive';
 export * from './platform/routing';
+export * from './platform/scope';
 export * from './platform/sdk';
 export * from './platform/settings';
 export * from './platform/service-registry';

package/dist/platform/author.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Wie een mutatie heeft uitgevoerd — voor attributie op de timeline en in
+ * analytics. Server-side afgeleid uit de request (zie `resolveAuthor` in
+ * `@opencxh/platform-api`). De shape sluit aan op `BaseActivity.author`, zodat
+ * een author direct als activity-author kan worden weggeschreven.
+ *
+ * - `user`   — ingelogde gebruiker; `id` is de user-id (analytics-attributie).
+ * - `app`    — een provider/integratie-app (bv. een playbook dat als de `ai`-app
+ *              muteert); `id` is de app-naam. De timeline toont dan de app
+ *              i.p.v. een anonieme "System".
+ * - `system` — geen geïdentificeerde actor (cron, achtergrondjob).
+ */
+export type MutationAuthor = {
+    type: "user";
+    id: string;
+    name: string;
+} | {
+    type: "app";
+    id: string;
+    name: string;
+} | {
+    type: "system";
+    name: string;
+};

package/dist/platform/scope.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Cross-app scope-authorization contract. A resource is addressed by an opaque
+ * scopeKey ("<kind>:<ref>", e.g. "interaction:abc"); the app that owns that kind
+ * answers "may this user access it?" over the `scope` provider role. Consumed by
+ * the AI live-assistant (conversation access) and, from fase 2, the attribute store.
+ * Implementation: authorizeScope / assertScopeAccess in @opencxh/platform-api.
+ */
+/** Access decision + whether the scope anchor is team-shared + the SSE audience. */
+export interface ScopeAuth {
+    allowed: boolean;
+    shared?: boolean;
+    audience?: string[];
+}
+/** GET /provider/scope/describe response: the scopeKey prefixes an app owns. */
+export interface ScopeDescribe {
+    kinds: string[];
+}
+/** POST /provider/scope/authorize body. userId omitted = trusted system caller. */
+export interface ScopeAuthorizeRequest {
+    scopeKey: string;
+    userId?: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@opencxh/domain",
-  "version": "1.97.0",
+  "version": "1.99.0",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",