strapi-plugin-hubspot 0.2.1 → 0.4.0

package/dist/server/src/content-types.d.ts

@@ -0,0 +1,56 @@
+/**
+ * The dead-letter queue for submissions HubSpot couldn't take: transient
+ * failures land here after the in-process retries are exhausted, and
+ * `retryFailures()` replays them.
+ *
+ * Visible in the Content Manager on purpose — an admin can inspect a stuck
+ * payload and delete it — but hidden from the Content-Type Builder: its shape
+ * belongs to the plugin.
+ */
+declare const _default: {
+    failure: {
+        schema: {
+            kind: string;
+            collectionName: string;
+            info: {
+                singularName: string;
+                pluralName: string;
+                displayName: string;
+                description: string;
+            };
+            options: {
+                draftAndPublish: boolean;
+            };
+            pluginOptions: {
+                "content-manager": {
+                    visible: boolean;
+                };
+                "content-type-builder": {
+                    visible: boolean;
+                };
+            };
+            attributes: {
+                object: {
+                    type: string;
+                    required: boolean;
+                };
+                idProperty: {
+                    type: string;
+                    required: boolean;
+                };
+                properties: {
+                    type: string;
+                    required: boolean;
+                };
+                error: {
+                    type: string;
+                };
+                attempts: {
+                    type: string;
+                    default: number;
+                };
+            };
+        };
+    };
+};
+export default _default;

package/dist/server/src/index.d.ts

@@ -1,24 +1,5 @@
 import type { Core } from "@strapi/strapi";
-/**
- * Plugin configuration (config/plugins.ts of the host app):
- *
- * hubspot: {
- *   enabled: true,
- *   config: {
- *     apiKey: env("HUBSPOT_API_KEY"),   // optional — can be set from the admin UI
- *     validate: [                       // optional — entries whose mappings are checked on save
- *       { uid: "api::form.form", objectField: "hsObject", propertyField: "hsProperty" },
- *     ],
- *   },
- * }
- *
- * The API key set from the admin UI takes precedence over both.
- */
-interface ValidateTarget {
-    uid: string;
-    objectField: string;
-    propertyField: string;
-}
+import { type ValidateTarget } from "./validation";
 declare const _default: {
     config: {
         default: {
@@ -30,6 +11,68 @@ declare const _default: {
             validate?: unknown;
         }): void;
     };
+    contentTypes: {
+        failure: {
+            /**
+             * Plugin configuration (config/plugins.ts of the host app):
+             *
+             * hubspot: {
+             *   enabled: true,
+             *   config: {
+             *     apiKey: env("HUBSPOT_API_KEY"),   // optional — can be set from the admin UI
+             *     validate: [                       // optional — entries whose mappings are checked on save
+             *       { uid: "api::form.form", objectField: "hsObject", propertyField: "hsProperty" },
+             *     ],
+             *   },
+             * }
+             *
+             * The API key set from the admin UI takes precedence over both.
+             */
+            /** RBAC action gating the settings screen and its routes. */
+            schema: {
+                kind: string;
+                collectionName: string;
+                info: {
+                    singularName: string;
+                    pluralName: string;
+                    displayName: string;
+                    description: string;
+                };
+                options: {
+                    draftAndPublish: boolean;
+                };
+                pluginOptions: {
+                    "content-manager": {
+                        visible: boolean;
+                    };
+                    "content-type-builder": {
+                        visible: boolean;
+                    };
+                };
+                attributes: {
+                    object: {
+                        type: string;
+                        required: boolean;
+                    };
+                    idProperty: {
+                        type: string;
+                        required: boolean;
+                    };
+                    properties: {
+                        type: string;
+                        required: boolean;
+                    };
+                    error: {
+                        type: string;
+                    };
+                    attempts: {
+                        type: string;
+                        default: number;
+                    };
+                };
+            };
+        };
+    };
     controllers: {
         properties: ({ strapi }: {
             strapi: Core.Strapi;
@@ -42,6 +85,24 @@ declare const _default: {
                 throw: (s: number, m: string) => never;
             }): Promise<void>;
         };
+        audit: ({ strapi }: {
+            strapi: Core.Strapi;
+        }) => {
+            run(ctx: {
+                body: unknown;
+                throw: (s: number, m: string) => never;
+            }): Promise<void>;
+        };
+        failures: ({ strapi }: {
+            strapi: Core.Strapi;
+        }) => {
+            list(ctx: {
+                body: unknown;
+            }): Promise<void>;
+            retry(ctx: {
+                body: unknown;
+            }): Promise<void>;
+        };
         settings: ({ strapi }: {
             strapi: Core.Strapi;
         }) => {
@@ -69,16 +130,37 @@ declare const _default: {
                 path: string;
                 handler: string;
                 config: {
-                    policies: string[];
+                    policies: (string | {
+                        name: string;
+                        config: {
+                            actions: string[];
+                        };
+                    })[];
                 };
             }[];
         };
     };
+    services: {
+        submit: ({ strapi }: {
+            strapi: Core.Strapi;
+        }) => {
+            upsert: (input: import("./submit").UpsertInput, { queueOnFailure }?: {
+                queueOnFailure?: boolean;
+            }) => Promise<import("./submit").UpsertResult>;
+            retryFailures: ({ limit }?: {
+                limit?: number;
+            }) => Promise<{
+                retried: number;
+                succeeded: number;
+                failed: number;
+            }>;
+        };
+    };
     register({ strapi }: {
         strapi: Core.Strapi;
     }): void;
     bootstrap({ strapi }: {
         strapi: Core.Strapi;
-    }): void;
+    }): Promise<void>;
 };
 export default _default;

package/dist/server/src/properties.d.ts

@@ -7,6 +7,11 @@ export interface HsObjectDef {
 }
 /** Objects HubSpot ships with; anything else is declared in the plugin config. */
 export declare const STANDARD_OBJECTS: HsObjectDef[];
+export interface HsPropertyOption {
+    value: string;
+    /** Human label, when HubSpot has one — used when importing options into Strapi. */
+    label?: string;
+}
 export interface HsProperty {
     name: string;
     label: string;
@@ -14,8 +19,8 @@ export interface HsProperty {
     object: string;
     type?: string;
     /** Allowed values, for enumeration properties. */
-    options: string[];
-    /** HubSpot's own grouping, shown to help editors locate a property. */
+    options: HsPropertyOption[];
+    /** HubSpot's own grouping (display label), shown to help editors locate a property. */
     group?: string;
 }
 export interface Schema {
@@ -50,10 +55,41 @@ export declare function loadSchema(strapi: Core.Strapi, apiKey: string, objects:
 }): Promise<Schema>;
 /** Drop the cache — used after the API key or the object list changes. */
 export declare function clearCache(): void;
+/** A mapping the portal would reject, and why. */
+export type Problem = {
+    code: "unknown";
+    property: string;
+    object: string;
+} | {
+    code: "wrong-object";
+    property: string;
+    object: string;
+    actualObject: string;
+} | {
+    code: "whitespace";
+    property: string;
+    object: string;
+} | {
+    code: "bad-option";
+    property: string;
+    object: string;
+    values: string[];
+};
+export interface Mapping {
+    object: string;
+    property: string;
+    /** Values the field can submit — checked against enumeration properties. */
+    values?: string[];
+}
 /**
- * Why a property can't be written, or `null` when it's fine. Returning a reason
- * rather than a boolean lets the caller tell an editor what to fix.
+ * Why a mapping can't be written, or `null` when it's fine.
+ *
+ * Returns a structured code rather than a sentence: the message is rendered by
+ * the caller, so the wording stays in one place and stays translatable. The
+ * codes are also carried in the ValidationError details, for anyone localizing.
  */
-export declare function checkProperty(properties: HsProperty[], object: string, name: string): string | null;
+export declare function checkMapping(properties: HsProperty[], mapping: Mapping): Problem | null;
+/** English rendering of a problem — the package's language. */
+export declare function describeProblem(problem: Problem): string;
 /** Resolve the configured object list, accepting names or full definitions. */
 export declare function resolveObjects(configured: unknown): HsObjectDef[];

package/dist/server/src/submit.d.ts

@@ -0,0 +1,35 @@
+import type { Core } from "@strapi/strapi";
+import { type Problem } from "./properties";
+export declare const FAILURE_UID = "plugin::hubspot.failure";
+export interface UpsertInput {
+    /** Target object (`contact`, `company`, a custom type id…). */
+    object: string;
+    /** Unique property used to find-or-create — `email` for contacts. */
+    idProperty: string;
+    /** Property name → value. Values are coerced to strings; empty ones are dropped. */
+    properties: Record<string, unknown>;
+}
+export interface UpsertResult {
+    ok: boolean;
+    /** HubSpot record id, on success. */
+    id?: string;
+    /** Pre-validation refusals — the payload never left the server. */
+    problems?: Problem[];
+    /** True when the payload was parked for `retryFailures()`. */
+    queued?: boolean;
+    error?: string;
+}
+export declare function createSubmitService(strapi: Core.Strapi, { sleep }?: {
+    sleep?: (ms: number) => Promise<void>;
+}): {
+    upsert: (input: UpsertInput, { queueOnFailure }?: {
+        queueOnFailure?: boolean;
+    }) => Promise<UpsertResult>;
+    retryFailures: ({ limit }?: {
+        limit?: number;
+    }) => Promise<{
+        retried: number;
+        succeeded: number;
+        failed: number;
+    }>;
+};

package/dist/server/src/validation.d.ts

@@ -0,0 +1,37 @@
+import type { Core } from "@strapi/strapi";
+import { type Mapping } from "./properties";
+/** An entry type whose HubSpot mappings are checked before every write. */
+export interface ValidateTarget {
+    uid: string;
+    objectField: string;
+    propertyField: string;
+    /**
+     * Repeatable holding the values a field can submit (default `options`), each
+     * `{ value?, label? }`. Checked against enumeration properties: a select whose
+     * choices drifted from HubSpot fails exactly like an unknown property.
+     */
+    optionsField?: string;
+    /**
+     * When `false`, an `unknown` property is logged and let through instead of
+     * blocking the save — the workflow where a property is staged in HubSpot but
+     * not created yet. The other codes (`wrong-object`, `whitespace`,
+     * `bad-option`) always block: no legitimate workflow produces them.
+     * Defaults to `true`.
+     */
+    strict?: boolean;
+}
+/** Every `{ object, property }` pair found anywhere in an entry, at any depth. */
+export declare function collectMappings(node: unknown, target: ValidateTarget, found?: Mapping[]): Mapping[];
+interface DocumentContext {
+    action: string;
+    uid: string;
+    params?: unknown;
+}
+/**
+ * The document-service middleware validating one target's mappings on write.
+ *
+ * Extracted from `bootstrap` so the strict/non-strict behaviour can be tested
+ * against a minimal strapi mock instead of a running instance.
+ */
+export declare function makeValidationMiddleware(strapi: Core.Strapi, target: ValidateTarget): (context: DocumentContext, next: () => any) => Promise<any>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "strapi-plugin-hubspot",
-  "version": "0.2.1",
+  "version": "0.4.0",
   "description": "HubSpot integration for Strapi — pick CRM properties from a searchable list filtered by object, and catch bad mappings before they reach the API.",
   "keywords": [
     "strapi",
@@ -44,6 +44,8 @@
     "build": "strapi-plugin build",
     "watch": "strapi-plugin watch",
     "verify": "strapi-plugin verify",
+    "test": "vitest run",
+    "test:watch": "vitest",
     "prepublishOnly": "npm run build"
   },
   "devDependencies": {
@@ -59,7 +61,8 @@
     "react-dom": "^18.3.1",
     "react-router-dom": "^6.26.0",
     "styled-components": "^6.1.11",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "vitest": "^3.2.4"
   },
   "peerDependencies": {
     "@strapi/design-system": "^2.0.0-rc.29",

package/dist/_chunks/HubspotPropertyInput-BVFRtt49.js

@@ -1,124 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const jsxRuntime = require("react/jsx-runtime");
-const React = require("react");
-const designSystem = require("@strapi/design-system");
-const admin = require("@strapi/strapi/admin");
-const index = require("./index-DgsAHPui.js");
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  const n = Object.create(null, { [Symbol.toStringTag]: { value: "Module" } });
-  if (e) {
-    for (const k in e) {
-      if (k !== "default") {
-        const d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: () => e[k]
-        });
-      }
-    }
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-const React__namespace = /* @__PURE__ */ _interopNamespace(React);
-const LABELS = {
-  contact: "Contact",
-  company: "Société",
-  deal: "Transaction",
-  ticket: "Ticket",
-  product: "Produit",
-  line_item: "Ligne de commande",
-  quote: "Devis"
-};
-function objectLabel(object) {
-  return LABELS[object] ?? object;
-}
-const HubspotPropertyInput = React__namespace.forwardRef(
-  ({ name, value, onChange, attribute, disabled, error, required, label, hint, labelAction }, ref) => {
-    const { get } = admin.useFetchClient();
-    const [schema, setSchema] = React__namespace.useState(null);
-    const [loadError, setLoadError] = React__namespace.useState("");
-    const objectFieldName = attribute?.options?.objectField || "hsObject";
-    const siblingPath = React__namespace.useMemo(
-      () => name.replace(/[^.]+$/, objectFieldName),
-      [name, objectFieldName]
-    );
-    const siblingField = admin.useField(siblingPath);
-    const selectedObject = siblingField?.value;
-    React__namespace.useEffect(() => {
-      let cancelled = false;
-      get(`/${index.PLUGIN_ID}/properties`).then(({ data }) => {
-        if (!cancelled) setSchema(data);
-      }).catch((err) => {
-        if (cancelled) return;
-        setSchema({ configured: false, properties: [], objects: [], unavailable: [] });
-        setLoadError(err?.response?.data?.error?.message ?? "Propriétés HubSpot indisponibles");
-      });
-      return () => {
-        cancelled = true;
-      };
-    }, [get]);
-    const emit = (next) => onChange({ target: { name, value: next ?? "", type: "string" } });
-    const options = React__namespace.useMemo(() => {
-      const all = schema?.properties ?? [];
-      const scoped = selectedObject ? all.filter((p) => p.object === selectedObject) : all;
-      const shown = scoped.map((p) => ({
-        value: p.name,
-        // The object prefix is redundant once filtered, and noisy.
-        label: selectedObject ? `${p.label} (${p.name})` : `${objectLabel(p.object)} · ${p.label} (${p.name})`
-      }));
-      if (value && !scoped.some((p) => p.name === value)) {
-        const elsewhere = all.find((p) => p.name === value);
-        shown.unshift({
-          value,
-          label: elsewhere ? `${value} — appartient à ${objectLabel(elsewhere.object)}` : `${value} — inconnue du portail`
-        });
-      }
-      return shown;
-    }, [schema, selectedObject, value]);
-    const describe = () => {
-      if (loadError) return loadError;
-      if (schema && !schema.configured) {
-        return "Aucune clé API HubSpot — saisie libre. Renseignez-la dans Réglages → HubSpot.";
-      }
-      if (selectedObject && schema?.unavailable.some((u) => u.object === selectedObject)) {
-        return `Propriétés de « ${objectLabel(selectedObject)} » illisibles — portée manquante sur le jeton.`;
-      }
-      return hint;
-    };
-    const crmLink = schema?.portalId && value && schema.properties.some((p) => p.name === value) ? `https://${schema.uiDomain || "app.hubspot.com"}/property-settings/${schema.portalId}/properties?search=${encodeURIComponent(value)}` : null;
-    return /* @__PURE__ */ jsxRuntime.jsxs(designSystem.Field.Root, { name, error, hint: describe(), required, children: [
-      /* @__PURE__ */ jsxRuntime.jsx(designSystem.Field.Label, { action: labelAction, children: label }),
-      !schema ? /* @__PURE__ */ jsxRuntime.jsx(designSystem.Flex, { paddingTop: 2, paddingBottom: 2, children: /* @__PURE__ */ jsxRuntime.jsx(designSystem.Loader, { small: true, children: "Chargement des propriétés HubSpot…" }) }) : schema.configured ? /* @__PURE__ */ jsxRuntime.jsx(
-        designSystem.Combobox,
-        {
-          ref,
-          value: value || "",
-          onChange: emit,
-          onClear: () => emit(""),
-          disabled,
-          placeholder: "Rechercher une propriété…",
-          creatable: true,
-          onCreateOption: emit,
-          children: options.map((o) => /* @__PURE__ */ jsxRuntime.jsx(designSystem.ComboboxOption, { value: o.value, children: o.label }, o.value))
-        }
-      ) : /* @__PURE__ */ jsxRuntime.jsx(
-        designSystem.Field.Input,
-        {
-          ref,
-          value: value || "",
-          onChange: (e) => emit(e.target.value),
-          disabled,
-          placeholder: "ex. hs_role, numberofemployees"
-        }
-      ),
-      crmLink ? /* @__PURE__ */ jsxRuntime.jsx(designSystem.Flex, { paddingTop: 1, children: /* @__PURE__ */ jsxRuntime.jsx(designSystem.Link, { href: crmLink, isExternal: true, children: "Voir dans HubSpot" }) }) : null,
-      /* @__PURE__ */ jsxRuntime.jsx(designSystem.Field.Hint, {}),
-      /* @__PURE__ */ jsxRuntime.jsx(designSystem.Field.Error, {})
-    ] });
-  }
-);
-HubspotPropertyInput.displayName = "HubspotPropertyInput";
-exports.default = HubspotPropertyInput;

package/dist/_chunks/HubspotPropertyInput-C7Wcw8ee.mjs

@@ -1,106 +0,0 @@
-import { jsxs, jsx } from "react/jsx-runtime";
-import * as React from "react";
-import { Field, Flex, Loader, Combobox, ComboboxOption, Link } from "@strapi/design-system";
-import { useFetchClient, useField } from "@strapi/strapi/admin";
-import { P as PLUGIN_ID } from "./index-BpZtcsPM.mjs";
-const LABELS = {
-  contact: "Contact",
-  company: "Société",
-  deal: "Transaction",
-  ticket: "Ticket",
-  product: "Produit",
-  line_item: "Ligne de commande",
-  quote: "Devis"
-};
-function objectLabel(object) {
-  return LABELS[object] ?? object;
-}
-const HubspotPropertyInput = React.forwardRef(
-  ({ name, value, onChange, attribute, disabled, error, required, label, hint, labelAction }, ref) => {
-    const { get } = useFetchClient();
-    const [schema, setSchema] = React.useState(null);
-    const [loadError, setLoadError] = React.useState("");
-    const objectFieldName = attribute?.options?.objectField || "hsObject";
-    const siblingPath = React.useMemo(
-      () => name.replace(/[^.]+$/, objectFieldName),
-      [name, objectFieldName]
-    );
-    const siblingField = useField(siblingPath);
-    const selectedObject = siblingField?.value;
-    React.useEffect(() => {
-      let cancelled = false;
-      get(`/${PLUGIN_ID}/properties`).then(({ data }) => {
-        if (!cancelled) setSchema(data);
-      }).catch((err) => {
-        if (cancelled) return;
-        setSchema({ configured: false, properties: [], objects: [], unavailable: [] });
-        setLoadError(err?.response?.data?.error?.message ?? "Propriétés HubSpot indisponibles");
-      });
-      return () => {
-        cancelled = true;
-      };
-    }, [get]);
-    const emit = (next) => onChange({ target: { name, value: next ?? "", type: "string" } });
-    const options = React.useMemo(() => {
-      const all = schema?.properties ?? [];
-      const scoped = selectedObject ? all.filter((p) => p.object === selectedObject) : all;
-      const shown = scoped.map((p) => ({
-        value: p.name,
-        // The object prefix is redundant once filtered, and noisy.
-        label: selectedObject ? `${p.label} (${p.name})` : `${objectLabel(p.object)} · ${p.label} (${p.name})`
-      }));
-      if (value && !scoped.some((p) => p.name === value)) {
-        const elsewhere = all.find((p) => p.name === value);
-        shown.unshift({
-          value,
-          label: elsewhere ? `${value} — appartient à ${objectLabel(elsewhere.object)}` : `${value} — inconnue du portail`
-        });
-      }
-      return shown;
-    }, [schema, selectedObject, value]);
-    const describe = () => {
-      if (loadError) return loadError;
-      if (schema && !schema.configured) {
-        return "Aucune clé API HubSpot — saisie libre. Renseignez-la dans Réglages → HubSpot.";
-      }
-      if (selectedObject && schema?.unavailable.some((u) => u.object === selectedObject)) {
-        return `Propriétés de « ${objectLabel(selectedObject)} » illisibles — portée manquante sur le jeton.`;
-      }
-      return hint;
-    };
-    const crmLink = schema?.portalId && value && schema.properties.some((p) => p.name === value) ? `https://${schema.uiDomain || "app.hubspot.com"}/property-settings/${schema.portalId}/properties?search=${encodeURIComponent(value)}` : null;
-    return /* @__PURE__ */ jsxs(Field.Root, { name, error, hint: describe(), required, children: [
-      /* @__PURE__ */ jsx(Field.Label, { action: labelAction, children: label }),
-      !schema ? /* @__PURE__ */ jsx(Flex, { paddingTop: 2, paddingBottom: 2, children: /* @__PURE__ */ jsx(Loader, { small: true, children: "Chargement des propriétés HubSpot…" }) }) : schema.configured ? /* @__PURE__ */ jsx(
-        Combobox,
-        {
-          ref,
-          value: value || "",
-          onChange: emit,
-          onClear: () => emit(""),
-          disabled,
-          placeholder: "Rechercher une propriété…",
-          creatable: true,
-          onCreateOption: emit,
-          children: options.map((o) => /* @__PURE__ */ jsx(ComboboxOption, { value: o.value, children: o.label }, o.value))
-        }
-      ) : /* @__PURE__ */ jsx(
-        Field.Input,
-        {
-          ref,
-          value: value || "",
-          onChange: (e) => emit(e.target.value),
-          disabled,
-          placeholder: "ex. hs_role, numberofemployees"
-        }
-      ),
-      crmLink ? /* @__PURE__ */ jsx(Flex, { paddingTop: 1, children: /* @__PURE__ */ jsx(Link, { href: crmLink, isExternal: true, children: "Voir dans HubSpot" }) }) : null,
-      /* @__PURE__ */ jsx(Field.Hint, {}),
-      /* @__PURE__ */ jsx(Field.Error, {})
-    ] });
-  }
-);
-HubspotPropertyInput.displayName = "HubspotPropertyInput";
-export {
-  HubspotPropertyInput as default
-};