@shopimind/integration-kit-js 1.2.0 → 1.3.0

package/dist/contracts/sdk.d.ts

@@ -40,9 +40,11 @@ export interface NewCustomDataDefinition {
     /**
      * Schema-level relationships to other definitions (forwarded as-is to the API).
      * `sourceField` is a field of THIS definition; it links to `targetSchema` — a
-     * `'system'` schema (e.g. `contacts`, `products`) or another `'custom'` definition
-     * (by its numeric id) — optionally matched on `targetField` (defaults to the
-     * target's id). Mirrors the API's relationship DTO; `custom`→`custom` is supported.
+     * `'system'` schema (e.g. `contacts`, `products`) or another `'custom'` definition.
+     * For a custom target, `targetSchema` is the target's numeric id — OR, inside a
+     * `provisioning.customData` plan, the NAME of a sibling definition (declared before
+     * this one), which the kit resolves to its id at creation. Optionally matched on
+     * `targetField` (defaults to the target's id). `custom`→`custom` is supported.
      */
     relationships?: Array<{
         sourceField: string;

package/dist/provisioning/ensure.js

@@ -72,12 +72,19 @@ export async function ensureCustomDataDefinition(client, def) {
     if (found) {
         const id = numId(found, 'id_definition', 'id');
         const full = SpmHelpers.unwrapOrThrow(await SpmCustomDataDefinitions.get(client, id), 'getCustomDataDefinition');
+        // Convergent extend: send only what the existing definition LACKS — new fields
+        // (by `name`) AND new relationships (by `sourceField`). The API appends, so
+        // existing fields/relationships are preserved.
         const fields = Array.isArray(full.fields) ? full.fields : [];
-        const have = new Set(fields.map((f) => f.name).filter((n) => !!n));
-        const missing = def.fields.filter((f) => !have.has(f.name));
-        if (missing.length > 0) {
+        const haveFields = new Set(fields.map((f) => f.name).filter((n) => !!n));
+        const missingFields = def.fields.filter((f) => !haveFields.has(f.name));
+        const rels = Array.isArray(full.relationships) ? full.relationships : [];
+        const haveRels = new Set(rels.map((r) => r.sourceField).filter((s) => !!s));
+        const missingRels = (def.relationships ?? []).filter((r) => !haveRels.has(r.sourceField));
+        if (missingFields.length > 0 || missingRels.length > 0) {
             SpmHelpers.unwrapOrThrow(await SpmCustomDataDefinitions.extend(client, id, {
-                fields: missing.map(toSdkField),
+                ...(missingFields.length > 0 ? { fields: missingFields.map(toSdkField) } : {}),
+                ...(missingRels.length > 0 ? { relationships: missingRels } : {}),
             }), 'extendCustomDataDefinition');
         }
         return id;

package/dist/provisioning/runner.js

@@ -15,7 +15,7 @@ export async function runProvisioning(client, plan) {
     }
     for (const def of plan.customData ?? []) {
         try {
-            result.defIds[def.name] = await ensureCustomDataDefinition(client, def);
+            result.defIds[def.name] = await ensureCustomDataDefinition(client, resolveCustomRelationTargets(def, result.defIds));
         }
         catch (e) {
             result.errors.push(`def ${def.name}: ${errMsg(e)}`);
@@ -44,6 +44,24 @@ export async function runProvisioning(client, plan) {
     }
     return result;
 }
+/**
+ * Resolves a custom relationship's `targetSchema` declared by NAME (a sibling
+ * definition in the same plan) to the sibling's numeric id — mirroring how
+ * dataSources resolve `parentKey` -> `parent_id`. The target must have been created
+ * earlier in the run (declare it BEFORE the definition that references it); a
+ * `targetSchema` that is already an id, or that names an out-of-plan definition, is
+ * left untouched.
+ */
+function resolveCustomRelationTargets(def, defIds) {
+    if (!def.relationships?.length)
+        return def;
+    return {
+        ...def,
+        relationships: def.relationships.map((r) => r.targetSchemaType === 'custom' && defIds[r.targetSchema] != null
+            ? { ...r, targetSchema: String(defIds[r.targetSchema]) }
+            : r),
+    };
+}
 function errMsg(e) {
     return e instanceof Error ? e.message : String(e);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shopimind/integration-kit-js",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Foundation for building ShopiMind integrations: a runtime plus typed, once-tested primitives (HMAC webhook signatures, encryption, log redaction, a safe cursor-based sync engine, pagination/concurrency, persistence, ShopiMind SDK re-export, idempotent provisioning, secured inbound middleware, HTTP server). An integration only writes pure functions and declarations passed to defineIntegration.",
   "license": "SEE LICENSE IN LICENSE",
   "repository": {