@makehq/forman-schema 0.1.4 → 1.0.0

package/README.md

@@ -1 +1,92 @@
-# Forman Schema Tools
+# Forman Schema
+
+A utility for converting between Forman Schema and JSON Schema.
+
+## Installation
+
+```bash
+npm install @makehq/forman-schema
+```
+
+## Usage
+
+### Converting from Forman Schema to JSON Schema
+
+```typescript
+import { toJSONSchema } from '@makehq/forman-schema';
+
+const formanField = {
+    type: 'collection',
+    spec: [
+        {
+            name: 'name',
+            type: 'text',
+            required: true,
+        },
+        {
+            name: 'age',
+            type: 'number',
+        },
+    ],
+};
+
+const jsonSchema = toJSONSchema(formanField);
+```
+
+### Converting from JSON Schema to Forman Schema
+
+```typescript
+import { toFormanSchema } from '@makehq/forman-schema';
+
+const jsonSchemaField = {
+    type: 'object',
+    properties: {
+        name: {
+            type: 'string',
+        },
+        age: {
+            type: 'number',
+        },
+    },
+    required: ['name'],
+};
+
+const formanSchema = toFormanSchema(jsonSchemaField);
+```
+
+## Supported Types
+
+### Forman Schema Types
+
+- text → string
+- number → number
+- boolean → boolean
+- date → string
+- json → string
+- select → string with enum
+- collection → object
+- array → array
+
+### JSON Schema Types
+
+- string → text
+- number → number
+- boolean → boolean
+- object → collection
+- array → array
+
+## Testing
+
+To test the project:
+
+```bash
+npm test
+```
+
+## Building
+
+To build the project:
+
+```bash
+npm run build        # Builds both ESM and CJS versions
+```

package/dist/index.cjs

@@ -67,6 +67,7 @@ function toJSONSchema(field) {
         description: noEmpty(field.help),
         items: field.spec && toJSONSchema(
           Array.isArray(field.spec) ? {
+            // If spec is an array, treat it as a collection
             type: "collection",
             spec: field.spec
           } : field.spec

package/dist/index.d.cts

@@ -1,24 +1,55 @@
+/**
+ * Represents a field in Forman Schema format.
+ */
 type FormanSchemaField = {
+    /** Field name identifier */
     name?: string;
+    /** The field type (e.g., 'text', 'number', 'boolean', 'collection', 'array', etc.) */
     type: string;
+    /** Whether the field is required or not */
     required?: boolean;
+    /** Default value for the field */
     default?: string | number | boolean | null;
+    /** Available options for select type fields */
     options?: {
+        /** Option value */
         value: string;
     }[];
+    /** Help text or description for the field */
     help?: string;
+    /** Sub-fields specification for collection or array types */
     spec?: FormanSchemaField[] | FormanSchemaField;
 };
+/**
+ * Represents a field in JSON Schema format.
+ */
 type JSONSchemaField = {
+    /** The JSON Schema type (e.g., 'string', 'number', 'boolean', 'object', 'array', etc.) */
     type: string;
+    /** Field description */
     description?: string;
+    /** Default value for the field */
     default?: string | number | boolean | null;
+    /** Enumeration of allowed values for the field */
     enum?: string[];
+    /** Child properties for object type */
     properties?: Record<string, JSONSchemaField>;
+    /** Array item specification for array type */
     items?: JSONSchemaField;
+    /** List of required property names */
     required?: string[];
 };
+/**
+ * Converts a Forman Schema field to its JSON Schema equivalent.
+ * @param field - The Forman Schema field to convert
+ * @returns The equivalent JSON Schema field
+ */
 declare function toJSONSchema(field: FormanSchemaField): JSONSchemaField;
+/**
+ * Converts a JSON Schema field to its Forman Schema equivalent.
+ * @param field - The JSON Schema field to convert
+ * @returns The equivalent Forman Schema field
+ */
 declare function toFormanSchema(field: JSONSchemaField): FormanSchemaField;
 
 export { type FormanSchemaField, type JSONSchemaField, toFormanSchema, toJSONSchema };

package/dist/index.d.ts

@@ -1,24 +1,55 @@
+/**
+ * Represents a field in Forman Schema format.
+ */
 type FormanSchemaField = {
+    /** Field name identifier */
     name?: string;
+    /** The field type (e.g., 'text', 'number', 'boolean', 'collection', 'array', etc.) */
     type: string;
+    /** Whether the field is required or not */
     required?: boolean;
+    /** Default value for the field */
     default?: string | number | boolean | null;
+    /** Available options for select type fields */
     options?: {
+        /** Option value */
         value: string;
     }[];
+    /** Help text or description for the field */
     help?: string;
+    /** Sub-fields specification for collection or array types */
     spec?: FormanSchemaField[] | FormanSchemaField;
 };
+/**
+ * Represents a field in JSON Schema format.
+ */
 type JSONSchemaField = {
+    /** The JSON Schema type (e.g., 'string', 'number', 'boolean', 'object', 'array', etc.) */
     type: string;
+    /** Field description */
     description?: string;
+    /** Default value for the field */
     default?: string | number | boolean | null;
+    /** Enumeration of allowed values for the field */
     enum?: string[];
+    /** Child properties for object type */
     properties?: Record<string, JSONSchemaField>;
+    /** Array item specification for array type */
     items?: JSONSchemaField;
+    /** List of required property names */
     required?: string[];
 };
+/**
+ * Converts a Forman Schema field to its JSON Schema equivalent.
+ * @param field - The Forman Schema field to convert
+ * @returns The equivalent JSON Schema field
+ */
 declare function toJSONSchema(field: FormanSchemaField): JSONSchemaField;
+/**
+ * Converts a JSON Schema field to its Forman Schema equivalent.
+ * @param field - The JSON Schema field to convert
+ * @returns The equivalent Forman Schema field
+ */
 declare function toFormanSchema(field: JSONSchemaField): FormanSchemaField;
 
 export { type FormanSchemaField, type JSONSchemaField, toFormanSchema, toJSONSchema };

package/dist/index.js

@@ -42,6 +42,7 @@ function toJSONSchema(field) {
         description: noEmpty(field.help),
         items: field.spec && toJSONSchema(
           Array.isArray(field.spec) ? {
+            // If spec is an array, treat it as a collection
             type: "collection",
             spec: field.spec
           } : field.spec

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@makehq/forman-schema",
-    "version": "0.1.4",
+    "version": "1.0.0",
     "description": "Forman Schema Tools",
     "license": "MIT",
     "author": "Make",
     "repository": "github:integromat/forman-schema",
     "homepage": "https://www.make.com",
     "type": "module",
-    "main": "dist/index.js",
-    "types": "dist/index.d.cts",
+    "main": "./dist/index.js",
+    "types": "./dist/index.d.cts",
     "exports": {
         ".": {
             "import": {
@@ -30,12 +30,12 @@
     "scripts": {
         "test": "jest --runInBand --forceExit --verbose false",
         "build": "tsup",
-        "lint": "tsc",
-        "check-exports": "attw --pack .",
-        "format": "npx prettier . --write"
+        "build:version": "node scripts/build-version.mjs",
+        "format": "npx prettier . --write",
+        "publish:jsr": "npx jsr publish",
+        "lint": "tsc"
     },
     "devDependencies": {
-        "@arethetypeswrong/cli": "^0.17.4",
         "@jest/globals": "^29.7.0",
         "@types/node": "^22.13.10",
         "jest": "^29.7.0",