thinkwork-cli 0.13.2 → 1.0.0

package/dist/plugins/twenty/scripts/lib/schema-ensure.ts

@@ -30,6 +30,41 @@ export const OPPORTUNITY_PRODUCT_OBJECT = {
   targetFieldLabel: "Products",
 } as const;
 
+/**
+ * LastMile branches ("Golden West Oil Co..San Antonio (300)", displayed as
+ * "GWO 300"). Opportunities belong to exactly one, so it is a related object
+ * rather than a free-text field: 38 of them, filterable and roll-up-able.
+ */
+export const ORGANIZATION_OBJECT = {
+  nameSingular: "organization",
+  namePlural: "organizations",
+  labelSingular: "Organization",
+  labelPlural: "Organizations",
+  icon: "IconBuildingCommunity",
+  targetFieldLabel: "Opportunities",
+} as const;
+
+/**
+ * TEI's product catalog: exactly the seven lines LastMile's "Product Line"
+ * picker offers. Opportunity product lines point at these, so a product is one
+ * record you can filter and report on rather than 19 free-text spellings.
+ */
+export const PRODUCT_OBJECT = {
+  nameSingular: "product",
+  namePlural: "products",
+  labelSingular: "Product",
+  labelPlural: "Products",
+  icon: "IconBox",
+  targetFieldLabel: "Lines",
+} as const;
+
+/** Legacy fields from the first import, superseded by the product lines.
+ * `amount` on the opportunity is Twenty's native deal total and stays. */
+export const LEGACY_OPPORTUNITY_FIELDS: readonly string[] = [
+  "product",
+  "quantity",
+];
+
 export const FIELD_SPECS: Array<{
   object: string;
   name: string;
@@ -45,6 +80,9 @@ export const FIELD_SPECS: Array<{
     isUnique: true,
   },
   { object: "company", name: "sourceHash", label: "Source Hash", type: "TEXT" },
+  // The customer's P21 account number (dispatch customer.external_id,
+  // e.g. "P21:13028") — TEI's ERP key, visible on the company.
+  { object: "company", name: "p21Code", label: "P21 Code", type: "TEXT" },
   {
     object: "person",
     name: "sourceId",
@@ -66,13 +104,9 @@ export const FIELD_SPECS: Array<{
     label: "Source Hash",
     type: "TEXT",
   },
-  { object: "opportunity", name: "product", label: "Product", type: "TEXT" },
-  {
-    object: "opportunity",
-    name: "quantity",
-    label: "Quantity",
-    type: "NUMBER",
-  },
+  // product + quantity live on the opportunityProduct lines, not here — an
+  // opportunity can carry several. isMobil stays as a roll-up: true when any
+  // line is a Mobil product, so the pipeline can be filtered on it.
   {
     object: "opportunity",
     name: "isMobil",
@@ -87,6 +121,9 @@ export const FIELD_SPECS: Array<{
     isUnique: true,
   },
   { object: "note", name: "sourceHash", label: "Source Hash", type: "TEXT" },
+  // Twenty's createdBy actor is not settable through the API, so the LastMile
+  // author rides on the note itself.
+  { object: "note", name: "author", label: "Author", type: "TEXT" },
   {
     object: "attachment",
     name: "sourceId",
@@ -108,12 +145,6 @@ export const FIELD_SPECS: Array<{
     label: "Source Hash",
     type: "TEXT",
   },
-  {
-    object: "opportunityProduct",
-    name: "product",
-    label: "Product",
-    type: "TEXT",
-  },
   {
     object: "opportunityProduct",
     name: "quantity",
@@ -138,6 +169,25 @@ export const FIELD_SPECS: Array<{
     label: "Line",
     type: "NUMBER",
   },
+  {
+    object: "organization",
+    name: "sourceId",
+    label: "Source ID",
+    type: "TEXT",
+    isUnique: true,
+  },
+  {
+    object: "organization",
+    name: "sourceHash",
+    label: "Source Hash",
+    type: "TEXT",
+  },
+  {
+    object: "organization",
+    name: "fullName",
+    label: "Full Name",
+    type: "TEXT",
+  },
 ];
 
 /** Placeholder id used only in dry-run plans, never sent to Twenty. */
@@ -202,21 +252,34 @@ const CREATE_OBJECT_MUTATION = `
  * RELATION fields via `relationCreationPayload`, and Twenty exposes the FK to
  * the data API as `opportunityId` on the line's create input.
  */
-export async function ensureOpportunityProductObject(
+async function ensureCustomObjectWithOpportunityRelation(
   client: TwentyClient,
   objects: Map<string, ObjectMetadata>,
   dryRun: boolean,
+  spec: {
+    nameSingular: string;
+    namePlural: string;
+    labelSingular: string;
+    labelPlural: string;
+    icon: string;
+    targetFieldLabel: string;
+  },
+  /** Which side owns the FK. "child" = many spec-rows -> one opportunity;
+   * "parent" = many opportunities -> one spec-row. */
+  direction: "child" | "parent",
 ): Promise<{ created: boolean; relationCreated: boolean }> {
-  const existing = objects.get(OPPORTUNITY_PRODUCT_OBJECT.nameSingular);
+  const existing = objects.get(spec.nameSingular);
   const opportunity = objects.get("opportunity");
   if (!opportunity) throw new Error('Twenty object "opportunity" not found.');
 
-  if (existing?.fields.has("opportunity")) {
+  const relationLives =
+    direction === "child"
+      ? existing?.fields.has("opportunity")
+      : opportunity.fields.has(spec.nameSingular);
+  if (existing && relationLives) {
     return { created: false, relationCreated: false };
   }
-  if (dryRun) {
-    return { created: !existing, relationCreated: true };
-  }
+  if (dryRun) return { created: !existing, relationCreated: true };
 
   let objectId = existing?.id;
   if (!objectId) {
@@ -225,28 +288,36 @@ export async function ensureOpportunityProductObject(
     }>("/metadata", CREATE_OBJECT_MUTATION, {
       input: {
         object: {
-          nameSingular: OPPORTUNITY_PRODUCT_OBJECT.nameSingular,
-          namePlural: OPPORTUNITY_PRODUCT_OBJECT.namePlural,
-          labelSingular: OPPORTUNITY_PRODUCT_OBJECT.labelSingular,
-          labelPlural: OPPORTUNITY_PRODUCT_OBJECT.labelPlural,
-          icon: OPPORTUNITY_PRODUCT_OBJECT.icon,
+          nameSingular: spec.nameSingular,
+          namePlural: spec.namePlural,
+          labelSingular: spec.labelSingular,
+          labelPlural: spec.labelPlural,
+          icon: spec.icon,
         },
       },
     });
     objectId = created.createOneObject.id;
   }
 
+  // MANY_TO_ONE always reads "many <owner> -> one <target>". For the child
+  // direction the line owns the FK; for the parent direction the opportunity
+  // does, so the field is created on opportunity pointing at spec's object.
+  const [ownerObjectId, targetObjectId, fieldName, fieldLabel] =
+    direction === "child"
+      ? [objectId, opportunity.id, "opportunity", "Opportunity"]
+      : [opportunity.id, objectId, spec.nameSingular, spec.labelSingular];
+
   await client.requestOnce("/metadata", CREATE_FIELD_MUTATION, {
     input: {
       field: {
-        objectMetadataId: objectId,
-        name: "opportunity",
-        label: "Opportunity",
+        objectMetadataId: ownerObjectId,
+        name: fieldName,
+        label: fieldLabel,
         type: "RELATION",
         relationCreationPayload: {
-          targetObjectMetadataId: opportunity.id,
-          targetFieldLabel: OPPORTUNITY_PRODUCT_OBJECT.targetFieldLabel,
-          targetFieldIcon: OPPORTUNITY_PRODUCT_OBJECT.icon,
+          targetObjectMetadataId: targetObjectId,
+          targetFieldLabel: spec.targetFieldLabel,
+          targetFieldIcon: spec.icon,
           type: "MANY_TO_ONE",
         },
       },
@@ -256,6 +327,36 @@ export async function ensureOpportunityProductObject(
   return { created: !existing, relationCreated: true };
 }
 
+export async function ensureOpportunityProductObject(
+  client: TwentyClient,
+  objects: Map<string, ObjectMetadata>,
+  dryRun: boolean,
+): Promise<{ created: boolean; relationCreated: boolean }> {
+  return ensureCustomObjectWithOpportunityRelation(
+    client,
+    objects,
+    dryRun,
+    OPPORTUNITY_PRODUCT_OBJECT,
+    "child",
+  );
+}
+
+/** Many opportunities belong to one organization, so the FK lives on
+ * opportunity as `organizationId`. */
+export async function ensureOrganizationObject(
+  client: TwentyClient,
+  objects: Map<string, ObjectMetadata>,
+  dryRun: boolean,
+): Promise<{ created: boolean; relationCreated: boolean }> {
+  return ensureCustomObjectWithOpportunityRelation(
+    client,
+    objects,
+    dryRun,
+    ORGANIZATION_OBJECT,
+    "parent",
+  );
+}
+
 export async function fetchObjectMetadata(
   client: TwentyClient,
 ): Promise<Map<string, ObjectMetadata>> {
@@ -315,7 +416,11 @@ export function planSchemaEnsure(
       // ensureOpportunityProductObject creates this object earlier in the same
       // run; in a dry-run against a workspace that lacks it, its fields are
       // planned rather than an error.
-      if (spec.object === OPPORTUNITY_PRODUCT_OBJECT.nameSingular) {
+      if (
+        spec.object === OPPORTUNITY_PRODUCT_OBJECT.nameSingular ||
+        spec.object === ORGANIZATION_OBJECT.nameSingular ||
+        spec.object === PRODUCT_OBJECT.nameSingular
+      ) {
         createFields.push({
           object: spec.object,
           objectMetadataId: PENDING_OBJECT_ID,