ajsc 5.0.0 → 5.0.1

package/README.md

@@ -102,11 +102,23 @@ console.log(converter.irNode);
 The package includes a TypeScript language plugin that converts the IRNode into TypeScript type definitions.
 
 - Constructor:
-  `new TypescriptConverter(schema: object, options?: { inlineTypes?: boolean })`
+  `new TypescriptConverter(schema: object, options?: TypescriptConverterOpts)`
 - Properties:
   - code: A string containing the generated TypeScript code.
 
-Usage Example:
+#### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `inlineTypes` | `boolean` | `false` | If true, object types are inlined instead of extracted as named type aliases. |
+| `depluralize` | `boolean` | `true` | Singularize array item type names. Handles irregular plurals (e.g. `entries` → `Entry`, `people` → `Person`). |
+| `arrayItemNaming` | `string \| false` | `false` | Controls the postfix for array item type names. `false` = no postfix, `string` = custom postfix (e.g. `"Item"` → `ContactItem`). |
+| `enumStyle` | `"union" \| "enum"` | `"union"` | `"union"` emits `"a" \| "b"`, `"enum"` emits `export enum`. Only applies when `inlineTypes` is false and all values are strings. |
+| `uncountableWords` | `string[]` | `undefined` | Additional words that should not be singularized (built-in: `"data"`, `"metadata"`). |
+
+#### Usage Examples
+
+Default behavior — array item types are automatically singularized:
 
 ```javascript
 import { TypescriptConverter } from "ajsc";
@@ -137,14 +149,50 @@ const schema = {
   required: ["name", "age"],
 };
 
+const tsConverter = new TypescriptConverter(schema);
+console.log(tsConverter.code);
+
+// Output:
+// export type Contact = { email: string; };
+// export type Profile = { email: string; };
+//
+// export type Root = { name: string; age: number; contacts?: Array<Contact>; profile?: Profile; };
+```
+
+Inline types (no extracted type aliases):
+
+```javascript
 const tsConverter = new TypescriptConverter(schema, { inlineTypes: true });
 console.log(tsConverter.code);
 
-// Expected output (formatted):
-// {
-//   name: string;
-//   age: number;
-//   contacts?: Array<{ email: string; }>;
-//   profile?: { email: string; };
-// }
+// Output:
+// { name: string; age: number; contacts?: Array<{ email: string; }>; profile?: { email: string; }; }
+```
+
+Enum style:
+
+```javascript
+const enumSchema = {
+  type: "object",
+  properties: {
+    status: { type: "string", enum: ["active", "inactive", "pending"] },
+  },
+};
+
+const tsConverter = new TypescriptConverter(enumSchema, { enumStyle: "enum" });
+console.log(tsConverter.code);
+
+// Output:
+// export enum Status { Active = "active", Inactive = "inactive", Pending = "pending" }
+//
+// export type Root = { status?: Status; };
+```
+
+Custom uncountable words:
+
+```javascript
+const tsConverter = new TypescriptConverter(schema, {
+  uncountableWords: ["criteria", "alumni"],
+});
+// "criteria" array items will produce type "Criteria", not "Criterium"
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ajsc",
-  "version": "5.0.0",
+  "version": "5.0.1",
   "description": "Another Json-Schema Converter",
   "type": "module",
   "main": "./dist/index.js",