@opencxh/domain 1.239.0 → 1.240.0

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

@@ -3,6 +3,10 @@ import { OwnerScope } from '../scope/types';
 export interface CompanySource {
     providerId: string;
     readOnly?: boolean;
+    /** A headline index rather than a copy; see `ContactSource.mode`. */
+    mode?: "proxy";
+    /** → `SyncConnection.id`; see `ContactSource.connectionId`. */
+    connectionId?: string;
 }
 /**
  * A company we own a row for.

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

@@ -10,6 +10,19 @@ export interface ContactSource {
     providerId: string;
     externalId?: string;
     readOnly?: boolean;
+    /**
+     * This row is a **headline index**, not a copy: its truth stays at the source.
+     *
+     * Absent = an ordinary row, which is what every row made before this field existed is — and the
+     * right default, because sending those outward would write to a connection that is not there.
+     * Set by the landing and only by the landing. Same field, same meaning as `WorkItemSource.mode`.
+     */
+    mode?: "proxy";
+    /**
+     * → `SyncConnection.id`. Which connection, not just which product: it carries the credential,
+     * and two links to the same CRM are two different answers.
+     */
+    connectionId?: string;
 }
 /**
  * Where a contact row came from.

package/dist/index.d.ts

@@ -55,9 +55,9 @@ export * from './platform/common';
 export * from './platform/communication';
 export * from './platform/connector';
 export * from './platform/context';
-export * from './platform/document-operations';
 export * from './platform/document-blocks';
 export * from './platform/document-markdown';
+export * from './platform/document-operations';
 export * from './platform/document-parse';
 export * from './platform/document-text';
 export * from './platform/documents';

package/dist/platform/connector.d.ts

@@ -13,7 +13,7 @@ export declare const CONNECTOR_PROVIDER_GROUP = "connector";
  * headline deliberately omits — a Jira issue has a description, comments and custom fields; a
  * To Do task has nothing the headline leaves out, and declares none.
  */
-export type ConnectorCapability = "list" | "get" | "fields" | "write" | "create" | "comment" | "attach" | "options";
+export type ConnectorCapability = "list" | "get" | "fields" | "write" | "create" | "delete" | "comment" | "attach" | "options";
 /**
  * Continuous or one-off — a real difference, not a label.
  *
@@ -281,10 +281,16 @@ export interface ConnectorCreateRequest {
     /**
      * Where the new record goes, in the source's own id space: the project, the board, the list.
      *
-     * Required, and there is no "somewhere sensible" fallback. A connector that guessed a container
-     * would put work in a project nobody is looking at, and report success.
+     * **Never guessed.** A connector that invented a container would put work in a project nobody is
+     * looking at, and report success. So a caller that does not know one leaves it out rather than
+     * filling in something plausible.
+     *
+     * Optional because not every record kind has a container: a Jira issue is always inside a
+     * project, a CRM contact is a top-level object with an optional company beside it. Absent means
+     * "at the top", and a connector whose kind genuinely needs one refuses the create — which is the
+     * loud failure the required field used to buy, now stated by the side that knows.
      */
-    containerExternalId: string;
+    containerExternalId?: string;
     /** The new record, in the **target app's** field names — same vocabulary as `patch`. */
     data: Record<string, unknown>;
 }
@@ -300,6 +306,43 @@ export interface ConnectorCreateResponse {
     externalId: string;
     data: Record<string, unknown>;
 }
+/**
+ * `POST /provider/connector/delete` — remove a record in the system that owns it.
+ *
+ * The third of the write trio, and the one whose absence was a hole rather than a limitation:
+ * without it, deleting a proxy row here removed our index of a record that still exists there,
+ * and the next round landed it straight back. Two rounds later the person who deleted it is
+ * looking at it again, with no way to tell why.
+ *
+ * Separate from a write with a `deleted: true` patch for the same reason a create is separate:
+ * the vendor call is a different one (usually an archive), and a contract that expresses a delete
+ * as a field lets a connector implement the field and quietly not delete.
+ *
+ * A connector that cannot delete does not declare the capability, and the caller then refuses the
+ * delete with a reason instead of removing its own row alone.
+ */
+export interface ConnectorDeleteRequest {
+    /** → {@link ConnectorDefinition.id} */
+    sourceId: string;
+    connectionId: string;
+    /** The {@link ManagedAccount} to talk with. Absent when no credential is needed. */
+    accountId?: string;
+    settings?: Record<string, unknown>;
+    /** From {@link ConnectorDefinition.kinds}. */
+    kind: string;
+    /** The record to remove, in the source system's own id space. */
+    externalId: string;
+}
+/**
+ * Answer to `POST /provider/connector/delete`. Wrapped in `ResponseFactory`.
+ *
+ * `deleted: false` is a real answer and not an error: a record that was already gone is the
+ * outcome the caller wanted, and saying so lets it log the difference without failing.
+ */
+export interface ConnectorDeleteResponse {
+    externalId: string;
+    deleted: boolean;
+}
 /**
  * One editable field of a **record**, as the connector describes it.
  *

package/package.json

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