@makehq/forman-schema 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Make
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1 @@
+# Forman Schema Tools

package/dist/index.d.ts

@@ -0,0 +1,22 @@
+export type FormanSchemaField = {
+    name?: string;
+    type: string;
+    required?: boolean;
+    default?: string | number | boolean | null;
+    options?: {
+        value: string;
+    }[];
+    help?: string;
+    spec?: FormanSchemaField[] | FormanSchemaField;
+};
+export type JSONSchemaField = {
+    type: string;
+    description?: string;
+    default?: string | number | boolean | null;
+    enum?: string[];
+    properties?: Record<string, JSONSchemaField>;
+    items?: JSONSchemaField;
+    required?: string[];
+};
+export declare function toJSONSchema(field: FormanSchemaField): JSONSchemaField;
+export declare function toFormanSchema(field: JSONSchemaField): FormanSchemaField;

package/dist/index.js

@@ -0,0 +1,114 @@
+const FORMAN_PRIMITIVE_TYPE_MAP = {
+    text: 'string',
+    number: 'number',
+    boolean: 'boolean',
+    date: 'string',
+    json: 'string',
+};
+const JSON_PRIMITIVE_TYPE_MAP = {
+    string: 'text',
+    number: 'number',
+    boolean: 'boolean',
+};
+function noEmpty(text) {
+    if (!text)
+        return undefined;
+    return text;
+}
+export function toJSONSchema(field) {
+    switch (field.type) {
+        case 'collection':
+            const required = [];
+            const properties = (Array.isArray(field.spec) ? field.spec : []).reduce((object, subField) => {
+                if (!subField.name)
+                    return object;
+                if (subField.required)
+                    required.push(subField.name);
+                return Object.defineProperty(object, subField.name, {
+                    enumerable: true,
+                    value: toJSONSchema(subField),
+                });
+            }, {});
+            return {
+                type: 'object',
+                description: noEmpty(field.help),
+                properties,
+                required,
+            };
+        case 'array':
+            return {
+                type: 'array',
+                description: noEmpty(field.help),
+                items: field.spec &&
+                    toJSONSchema(Array.isArray(field.spec)
+                        ? {
+                            type: 'collection',
+                            spec: field.spec,
+                        }
+                        : field.spec),
+            };
+        case 'select':
+            return {
+                type: 'string',
+                description: noEmpty(field.help),
+                enum: (field.options || []).map(option => option.value),
+            };
+        default:
+            return {
+                type: FORMAN_PRIMITIVE_TYPE_MAP[field.type],
+                default: field.default != '' && field.default != null ? field.default : undefined,
+                description: noEmpty(field.help),
+            };
+    }
+}
+export function toFormanSchema(field) {
+    switch (field.type) {
+        case 'object':
+            const spec = field.properties
+                ? Object.entries(field.properties).map(([name, property]) => {
+                    const subField = toFormanSchema(property);
+                    subField.name = name;
+                    subField.required = field.required?.includes(name) || false;
+                    return subField;
+                })
+                : [];
+            return {
+                type: 'collection',
+                help: field.description,
+                spec,
+            };
+        case 'array':
+            return {
+                type: 'array',
+                help: field.description,
+                spec: field.items &&
+                    (field.items?.type === 'object' && field.items.properties
+                        ? Object.entries(field.items.properties).map(([name, property]) => {
+                            const subField = toFormanSchema(property);
+                            subField.name = name;
+                            subField.required = field.items?.required?.includes(name) || false;
+                            return subField;
+                        })
+                        : toFormanSchema(field.items)),
+            };
+        case 'string':
+            if (field.enum) {
+                return {
+                    type: 'select',
+                    help: field.description,
+                    options: field.enum.map(value => ({ value })),
+                };
+            }
+            return {
+                type: 'text',
+                help: field.description,
+                default: field.default,
+            };
+        default:
+            return {
+                type: JSON_PRIMITIVE_TYPE_MAP[field.type],
+                help: field.description,
+                default: field.default,
+            };
+    }
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+    "name": "@makehq/forman-schema",
+    "version": "0.1.0",
+    "description": "Foman Schema Tools",
+    "license": "MIT",
+    "author": "Make",
+    "repository": "github:integromat/forman-schema",
+    "homepage": "https://www.make.com",
+    "type": "module",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
+    "engines": {
+        "node": ">=18"
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "test": "jest --runInBand --forceExit --verbose false",
+        "build": "tsc"
+    },
+    "devDependencies": {
+        "@jest/globals": "^29.7.0",
+        "@types/node": "^22.13.10",
+        "jest": "^29.7.0",
+        "ts-jest": "^29.2.6",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.8.2"
+    }
+}