type-crafter 0.1.0

package/dist/runtime.d.ts

@@ -0,0 +1,24 @@
+import type { Configuration, ExporterModuleTemplateInput, ObjectTemplateInput, SpecFileData, TypeFilePath, TypesFileTemplateInput } from '$types';
+declare function setConfig(newConfig: Configuration): void;
+declare function getConfig(): Configuration;
+declare function setSpecFileData(newSpecFileData: SpecFileData): void;
+declare function getSpecFileData(): SpecFileData;
+declare function compileTemplates(): void;
+declare function getObjectTemplate(): HandlebarsTemplateDelegate<ObjectTemplateInput>;
+declare function getExporterModuleTemplate(): HandlebarsTemplateDelegate<ExporterModuleTemplateInput>;
+declare function getTypesFileTemplate(): HandlebarsTemplateDelegate<TypesFileTemplateInput>;
+declare function setExpectedOutputFiles(newExpectedOutputFiles: Map<string, TypeFilePath>): void;
+declare function getExpectedOutputFiles(): Map<string, TypeFilePath>;
+declare const _default: {
+    getConfig: typeof getConfig;
+    setConfig: typeof setConfig;
+    setSpecFileData: typeof setSpecFileData;
+    setExpectedOutputFiles: typeof setExpectedOutputFiles;
+    getSpecFileData: typeof getSpecFileData;
+    getObjectTemplate: typeof getObjectTemplate;
+    getExporterModuleTemplate: typeof getExporterModuleTemplate;
+    getTypesFileTemplate: typeof getTypesFileTemplate;
+    getExpectedOutputFiles: typeof getExpectedOutputFiles;
+    compileTemplates: typeof compileTemplates;
+};
+export default _default;

package/dist/templates/index.d.ts

@@ -0,0 +1 @@
+export * as typescript from './typescript';

package/dist/templates/typescript/exporter-module-syntax.hbs

@@ -0,0 +1,3 @@
+{{#each modules}}
+export * from './{{this}}';
+{{/each}}

package/dist/templates/typescript/index.d.ts

@@ -0,0 +1,2 @@
+import type { Configuration, TypesWriterMode, GroupedTypesWriterMode } from '$types';
+export declare function config(inputFilePath: string, outputDirectory: string, typesWriterMode: TypesWriterMode, groupedTypesWriterMode: GroupedTypesWriterMode): Promise<Configuration>;

package/dist/templates/typescript/object-syntax.hbs

@@ -0,0 +1,5 @@
+export type {{typeName}} = {
+  {{#each properties}}
+  {{@key}}: {{{this.type}}}{{#unless this.required}} | null{{/unless}};
+  {{/each}}
+};

package/dist/templates/typescript/types-file-syntax.hbs

@@ -0,0 +1,5 @@
+{{#each (getReferencedTypeModules referencedTypes writtenAt)}}
+import type { {{{this.referencedTypes}}} } from '{{this.moduleRelativePath}}';
+{{/each}}
+
+{{{typesContent}}}

package/dist/types/decoders.d.ts

@@ -0,0 +1,5 @@
+import type { GroupedTypesWriterMode, ObjectTemplateInputProperties, SpecFileData, TypesWriterMode } from '.';
+export declare function decodeGroupedTypesWriterMode(rawInput: unknown): GroupedTypesWriterMode | null;
+export declare function decodeTypesWriterMode(rawInput: unknown): TypesWriterMode | null;
+export declare function decodeSpecFileData(rawInput: unknown): SpecFileData | null;
+export declare function decodeObjectTemplateInputProperties(rawInput: unknown): ObjectTemplateInputProperties | null;

package/dist/types/index.d.ts

@@ -0,0 +1,100 @@
+export * from './decoders';
+export type Configuration = {
+    input: string;
+    output: OutputConfig;
+    template: Template;
+    language: LanguageConfig;
+};
+export type OutputConfig = {
+    cleanWrite: boolean;
+    fileExtension: string;
+    directory: string;
+    writerMode: {
+        groupedTypes: GroupedTypesWriterMode;
+        types: TypesWriterMode;
+    };
+};
+export type GroupedTypesWriterMode = 'FolderWithFiles' | 'SingleFile';
+export type TypesWriterMode = 'SingleFile' | 'Files';
+export type Template = {
+    objectSyntax: string;
+    exporterModuleSyntax: string;
+    typesFileSyntax: string;
+};
+export type LanguageConfig = {
+    exporterModuleName: string;
+    typeMapper: LanguageTypeMapper;
+};
+/**
+ * @description Mappers for all the types supported by OpenAPI 3.0.0
+ * @see https://swagger.io/docs/specification/data-models/data-types/
+ */
+export type LanguageTypeMapper = Record<TypeDataType, FormatType | string>;
+export type FormatType = {
+    default: string;
+    [format: string]: string | undefined;
+};
+export type SpecFileData = {
+    info: SpecInfo;
+    groupedTypes: GroupedTypes | null;
+    types: Types | null;
+};
+export type SpecInfo = {
+    version: string;
+    title: string;
+};
+type GroupName = string;
+export type GroupedTypes = Record<GroupName, Types>;
+type TypeName = string;
+export type Types = Record<TypeName, TypeInfo>;
+export type TypeInfo = {
+    required: string[] | null;
+    type: TypeDataType | null;
+    format: string | null;
+    items: TypeInfo | null;
+    properties: TypeProperties | null;
+    $ref: string | null;
+};
+type PropertyName = string;
+export type TypeProperties = Record<PropertyName, TypeInfo>;
+export type TypeDataType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'unknown';
+export type ObjectTemplateInput = {
+    typeName: string;
+    properties: ObjectTemplateInputProperties;
+};
+export type ObjectTemplateInputProperties = Record<PropertyName, ObjectTemplateInputProperty>;
+export type ObjectTemplateInputProperty = {
+    type: string;
+    required: boolean;
+    referenced: boolean;
+};
+export type ExporterModuleTemplateInput = {
+    modules: string[];
+};
+export type TypesFileTemplateInput = {
+    referencedTypes: string[];
+    primitives: string[];
+    typesContent: string;
+    writtenAt: string;
+};
+export type ReferencedModule = {
+    modulePath: string;
+    moduleRelativePath: string;
+    referencedTypes: string[];
+};
+export type GenerationResult = {
+    groupedTypes: GroupedTypesOutput;
+    types: GeneratedTypes;
+};
+export type GeneratedType = {
+    content: string;
+    references: Set<string>;
+    primitives: Set<string>;
+};
+export type GroupedTypesOutput = Record<GroupName, GeneratedTypes>;
+export type GeneratedTypes = Record<TypeName, GeneratedType>;
+export type TypeFilePath = {
+    modulePath: string;
+    filePath: string;
+    extension: string;
+};

package/dist/utils/error-handler.d.ts

@@ -0,0 +1,16 @@
+export declare class LanguageNotSupportedError extends Error {
+    constructor(language: string);
+}
+export declare class InvalidParamError extends Error {
+    constructor(key: string, value: string);
+}
+export declare class InvalidSpecFileError extends Error {
+    constructor(param: string);
+}
+export declare class RuntimeError extends Error {
+    constructor(message: string);
+}
+export declare class UnsupportedFeatureError extends Error {
+    constructor(message: string);
+}
+export declare function handleErrors(error: unknown): void;

package/dist/utils/file-system.d.ts

@@ -0,0 +1,8 @@
+export declare function resolveFilePath(filePath: string): string;
+export declare function readFile(filePath: string): Promise<string>;
+export declare function createFolderWithBasePath(basePath: string, folderName: string): Promise<void>;
+export declare function createFolder(folderPath: string): Promise<void>;
+export declare function deleteFolder(folderPath: string): Promise<void>;
+export declare function getCompleteFolderPath(folderName: string): Promise<string>;
+export declare function getExpectedWrittenPath(basePath: string, fileName: string): Promise<string>;
+export declare function writeFile(basePath: string, fileName: string, content: string): Promise<void>;

package/dist/utils/index.d.ts

@@ -0,0 +1,12 @@
+import { type JSONObject } from 'type-decoder';
+export * from './file-system';
+export * from './logger';
+export declare function addValuesToMappedSet(map: Map<string, Set<string>>, key: string, values: string[]): void;
+export declare function getOptionalKeys(object: unknown): string[];
+export declare function getReferencedTypes(object: unknown): string[];
+export declare function getReferencedTypeModules(_referencedTypes: unknown, _writtenAt: string): unknown[];
+export declare function toPascalCase(input: string): string;
+export declare function registerTemplateHelpers(): void;
+export declare function readNestedValue(json: JSONObject, keyPath: string[]): JSONObject;
+export declare function generateRelativePath(fromPath: string, toPath: string): string;
+export declare function stripPrefix(value: string, prefix: string): string;

package/dist/utils/logger.d.ts

@@ -0,0 +1,4 @@
+export declare function logError(header: string, message?: string | null): void;
+export declare function logWarning(header: string, message: string): void;
+export declare function logSuccess(header: string, message: string): void;
+export declare function greeting(): void;

package/dist/writer/helpers.d.ts

@@ -0,0 +1,3 @@
+import type { TypeFilePath, Types } from '$types';
+export declare function generateTypesOutputFiles(types: Types | null, groupName?: string | null): Map<string, TypeFilePath>;
+export declare function generateExpectedOutputFile(): Map<string, TypeFilePath>;

package/dist/writer/index.d.ts

@@ -0,0 +1,2 @@
+import type { GenerationResult } from '$types';
+export declare function writeOutput(generationResult: GenerationResult): Promise<void>;

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "type-crafter",
+  "version": "0.1.0",
+  "description": "A tool to generate types from a yaml schema for any language",
+  "main": "./dist/index.js",
+  "type": "module",
+  "bin": {
+    "type-crafter": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*",
+    "!dist/**/*.spec.*",
+    "scripts/postinstall.js"
+  ],
+  "scripts": {
+    "dev": "tsc --watch",
+    "format:all": "npx prettier --write .",
+    "lint:all": "eslint . --ext .ts",
+    "clean:output": "rm -rf dist",
+    "build": "npm run clean:output && rollup --config rollup.config.js",
+    "publish": "node scripts/publish.js",
+    "changeset:version": "changeset version && git add --all"
+  },
+  "keywords": [
+    "type-crafter",
+    "types",
+    "crafter",
+    "generation",
+    "generator",
+    "typescript"
+  ],
+  "author": "Sahil Sinha",
+  "license": "ISC",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    }
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/sinha-sahil/type-crafter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/sinha-sahil/type-crafter/issues"
+  },
+  "homepage": "https://github.com/sinha-sahil/type-crafter#readme",
+  "devDependencies": {
+    "@changesets/cli": "^2.26.2",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-typescript": "^11.1.5",
+    "@types/node": "^20.8.4",
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "commander": "^11.1.0",
+    "eslint": "^8.51.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-config-standard-with-typescript": "^39.1.1",
+    "eslint-plugin-import": "^2.25.2",
+    "eslint-plugin-n": "^15.0.0 || ^16.0.0 ",
+    "eslint-plugin-promise": "^6.0.0",
+    "handlebars": "^4.7.8",
+    "husky": "^8.0.3",
+    "prettier": "^3.0.3",
+    "rollup": "^4.5.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "tslib": "^2.6.2",
+    "type-decoder": "^1.2.0",
+    "typescript": "^5.2.2",
+    "yaml": "^2.3.2"
+  }
+}