@siloy/hubspot-provisioning 0.0.0-stage → 0.1.1

package/dist/provisioning/src/targets.js

@@ -0,0 +1,27 @@
+export { mappingTargetsSchema } from '../../engine/src/blueprint/index.js';
+/**
+ * The offline part of the mapping-target check (#105): which targets the blueprint defines, and which are assumed to
+ * exist in HubSpot. `assumed` is sorted by object type, then property, `null` first; a missing object is listed once.
+ */
+export function checkMappingTargets(blueprint, targets) {
+    const defined = [];
+    const assumed = [];
+    for (const { objectType, properties } of targets) {
+        const object = blueprint.objects.find((o) => o.objectType === objectType);
+        if (!object) {
+            assumed.push({ objectType, property: null });
+            continue;
+        }
+        const names = new Set(object.properties.map((p) => p.name));
+        const inBlueprint = properties.filter((property) => names.has(property));
+        if (inBlueprint.length > 0)
+            defined.push({ objectType, properties: inBlueprint });
+        for (const property of properties)
+            if (!names.has(property))
+                assumed.push({ objectType, property });
+    }
+    assumed.sort((a, b) => compare(a.objectType, b.objectType) || compareProperty(a.property, b.property));
+    return { defined, assumed };
+}
+const compare = (a, b) => (a < b ? -1 : a > b ? 1 : 0);
+const compareProperty = (a, b) => (a === b ? 0 : a === null ? -1 : b === null ? 1 : compare(a, b));

package/dist/provisioning/src/validate.d.ts

@@ -0,0 +1,10 @@
+import { type Blueprint } from '../../engine/src/blueprint/index.ts';
+export type ValidationResult = {
+    ok: true;
+    blueprint: Blueprint;
+} | {
+    ok: false;
+    issues: string[];
+};
+/** Parse + validate exactly as the server's import does (parseBlueprintText in apps/web). Never throws on bad input. */
+export declare function validateBlueprintText(text: string): ValidationResult;

package/dist/provisioning/src/validate.js

@@ -0,0 +1,15 @@
+import { parseBlueprint } from '../../engine/src/blueprint/index.js';
+import { BlueprintError } from '../../engine/src/errors.js';
+/** Parse + validate exactly as the server's import does (parseBlueprintText in apps/web). Never throws on bad input. */
+export function validateBlueprintText(text) {
+    if (text.trim() === '')
+        return { ok: false, issues: ['The blueprint is empty.'] };
+    try {
+        return { ok: true, blueprint: parseBlueprint(text) };
+    }
+    catch (error) {
+        if (error instanceof BlueprintError)
+            return { ok: false, issues: error.issues };
+        throw error;
+    }
+}

package/dist/provisioning/src/version.d.ts

@@ -0,0 +1,2 @@
+/** This package's version, from its package.json: the nearest one above both src/ and dist/provisioning/src/. */
+export declare const CLI_VERSION: string;

package/dist/provisioning/src/version.js

@@ -0,0 +1,17 @@
+import { existsSync, readFileSync } from 'node:fs';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+/** This package's version, from its package.json: the nearest one above both src/ and dist/provisioning/src/. */
+export const CLI_VERSION = readOwnVersion();
+function readOwnVersion() {
+    let dir = dirname(fileURLToPath(import.meta.url));
+    for (;;) {
+        const file = join(dir, 'package.json');
+        if (existsSync(file))
+            return JSON.parse(readFileSync(file, 'utf8')).version;
+        const parent = dirname(dir);
+        if (parent === dir)
+            throw new Error('@siloy/hubspot-provisioning: package.json not found');
+        dir = parent;
+    }
+}

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "@siloy/hubspot-provisioning",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.1",
+  "description": "Validate HubSpot provisioning blueprints offline and deploy them from CI.",
+  "type": "module",
+  "engines": { "node": ">=20" },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Conversion-Crew/cc-hubspot-provisioning.git",
+    "directory": "packages/provisioning"
+  },
+  "publishConfig": { "access": "public" },
+  "exports": {
+    ".": {
+      "types": "./dist/provisioning/src/index.d.ts",
+      "default": "./dist/provisioning/src/index.js"
+    },
+    "./schema.json": "./schema/blueprint.schema.json"
+  },
+  "bin": {
+    "hubspot-provisioning": "./dist/provisioning/src/cli/main.js"
+  },
+  "license": "MIT",
+  "files": ["dist", "schema", "README.md", "LICENSE"],
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json && node scripts/write-schema.ts",
+    "prepack": "node -e \"for (const d of ['dist', 'schema']) require('node:fs').rmSync(d, { recursive: true, force: true })\" && pnpm run build",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit -p tsconfig.json"
+  },
+  "dependencies": {
+    "yaml": "2.9.1",
+    "zod": "4.6.7"
+  },
+  "devDependencies": {
+    "@types/node": "24.19.2",
+    "typescript": "7.0.2",
+    "vitest": "5.0.5"
+  }
+}

package/schema/blueprint.schema.json

@@ -0,0 +1,420 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "properties": {
+    "format": {
+      "type": "string",
+      "const": "hubspot-blueprint/v1"
+    },
+    "source": {
+      "type": "object",
+      "properties": {
+        "portalId": {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        "ingestedAt": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "portalId",
+        "ingestedAt"
+      ],
+      "additionalProperties": false
+    },
+    "objects": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "objectType": {
+            "type": "string",
+            "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+          },
+          "schema": {
+            "type": "object",
+            "properties": {
+              "labels": {
+                "type": "object",
+                "properties": {
+                  "singular": {
+                    "type": "string",
+                    "minLength": 1
+                  },
+                  "plural": {
+                    "type": "string",
+                    "minLength": 1
+                  }
+                },
+                "required": [
+                  "singular",
+                  "plural"
+                ],
+                "additionalProperties": false
+              },
+              "description": {
+                "type": "string"
+              },
+              "primaryDisplayProperty": {
+                "type": "string",
+                "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+              },
+              "secondaryDisplayProperties": {
+                "default": [],
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                }
+              },
+              "requiredProperties": {
+                "default": [],
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                }
+              },
+              "searchableProperties": {
+                "default": [],
+                "type": "array",
+                "items": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                }
+              }
+            },
+            "required": [
+              "labels",
+              "primaryDisplayProperty"
+            ],
+            "additionalProperties": false
+          },
+          "labels": {
+            "type": "object",
+            "properties": {
+              "singular": {
+                "type": "string",
+                "minLength": 1
+              },
+              "plural": {
+                "type": "string",
+                "minLength": 1
+              }
+            },
+            "required": [
+              "singular",
+              "plural"
+            ],
+            "additionalProperties": false
+          },
+          "propertyGroups": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "pattern": "^[^/\\u0000-\\u001f\\u007f-\\u009f]{1,100}$"
+                },
+                "label": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "displayOrder": {
+                  "type": "integer",
+                  "minimum": -9007199254740991,
+                  "maximum": 9007199254740991
+                }
+              },
+              "required": [
+                "name",
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "properties": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "name": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                },
+                "origin": {
+                  "default": "custom",
+                  "type": "string",
+                  "enum": [
+                    "custom",
+                    "hubspot"
+                  ]
+                },
+                "label": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "type": {
+                  "type": "string",
+                  "enum": [
+                    "string",
+                    "number",
+                    "date",
+                    "datetime",
+                    "enumeration",
+                    "bool",
+                    "phone_number"
+                  ]
+                },
+                "fieldType": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "groupName": {
+                  "type": "string",
+                  "pattern": "^[^/\\u0000-\\u001f\\u007f-\\u009f]{1,100}$"
+                },
+                "description": {
+                  "type": "string"
+                },
+                "displayOrder": {
+                  "type": "integer",
+                  "minimum": -9007199254740991,
+                  "maximum": 9007199254740991
+                },
+                "hidden": {
+                  "type": "boolean"
+                },
+                "formField": {
+                  "type": "boolean"
+                },
+                "hasUniqueValue": {
+                  "default": false,
+                  "type": "boolean"
+                },
+                "referencedObjectType": {
+                  "type": "string"
+                },
+                "externalOptions": {
+                  "type": "boolean"
+                },
+                "calculationFormula": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "numberDisplayHint": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "showCurrencySymbol": {
+                  "type": "boolean"
+                },
+                "options": {
+                  "default": [],
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "value": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "label": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "displayOrder": {
+                        "type": "integer",
+                        "minimum": -9007199254740991,
+                        "maximum": 9007199254740991
+                      },
+                      "hidden": {
+                        "default": false,
+                        "type": "boolean"
+                      },
+                      "description": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "value",
+                      "label"
+                    ],
+                    "additionalProperties": false
+                  }
+                }
+              },
+              "required": [
+                "name",
+                "label",
+                "type",
+                "fieldType",
+                "groupName"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "pipelines": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "key": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                },
+                "origin": {
+                  "default": "custom",
+                  "type": "string",
+                  "enum": [
+                    "custom",
+                    "hubspot"
+                  ]
+                },
+                "label": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "displayOrder": {
+                  "type": "integer",
+                  "minimum": -9007199254740991,
+                  "maximum": 9007199254740991
+                },
+                "stages": {
+                  "minItems": 1,
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "key": {
+                        "type": "string",
+                        "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                      },
+                      "label": {
+                        "type": "string",
+                        "minLength": 1
+                      },
+                      "metadata": {
+                        "type": "object",
+                        "properties": {
+                          "probability": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "ticketState": {
+                            "type": "string",
+                            "minLength": 1
+                          },
+                          "state": {
+                            "type": "string",
+                            "minLength": 1
+                          }
+                        },
+                        "additionalProperties": false
+                      }
+                    },
+                    "required": [
+                      "key",
+                      "label",
+                      "metadata"
+                    ],
+                    "additionalProperties": false
+                  }
+                }
+              },
+              "required": [
+                "key",
+                "label",
+                "stages"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "objectType"
+        ],
+        "additionalProperties": false
+      }
+    },
+    "associations": {
+      "default": [],
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "from": {
+            "type": "string",
+            "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+          },
+          "to": {
+            "type": "string",
+            "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+          },
+          "limit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 10000
+          },
+          "inverseLimit": {
+            "type": "integer",
+            "minimum": 1,
+            "maximum": 10000
+          },
+          "labels": {
+            "default": [],
+            "type": "array",
+            "items": {
+              "type": "object",
+              "properties": {
+                "key": {
+                  "type": "string",
+                  "pattern": "^[A-Za-z][A-Za-z0-9_]*$"
+                },
+                "label": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "inverseLabel": {
+                  "type": "string",
+                  "minLength": 1
+                },
+                "limit": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 10000
+                },
+                "inverseLimit": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 10000
+                }
+              },
+              "required": [
+                "key",
+                "label"
+              ],
+              "additionalProperties": false
+            }
+          }
+        },
+        "required": [
+          "from",
+          "to"
+        ],
+        "additionalProperties": false
+      }
+    }
+  },
+  "required": [
+    "format",
+    "objects"
+  ],
+  "additionalProperties": false
+}