@skmtc/core 0.0.792 → 0.0.793

package/script/typescript/identifiers.js

@@ -2,10 +2,169 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.handlePropertyName = exports.handleKey = void 0;
 const helper_validator_identifier_1 = require("@babel/helper-validator-identifier");
+/**
+ * Safely formats a key for use in object literals, adding quotes if needed.
+ *
+ * This function determines whether a property key needs to be quoted in JavaScript/TypeScript
+ * object literals based on identifier naming rules. Valid identifiers are left unquoted,
+ * while invalid identifiers (containing spaces, special characters, starting with numbers, etc.)
+ * are wrapped in single quotes.
+ *
+ * @param key - The property key to format
+ * @returns The key as-is if it's a valid identifier, otherwise wrapped in quotes
+ *
+ * @example Valid identifiers (no quotes needed)
+ * ```typescript
+ * import { handleKey } from '@skmtc/core';
+ *
+ * console.log(handleKey('name'));      // 'name'
+ * console.log(handleKey('userName'));  // 'userName'
+ * console.log(handleKey('_private'));  // '_private'
+ * console.log(handleKey('$special'));  // '$special'
+ * ```
+ *
+ * @example Invalid identifiers (quotes added)
+ * ```typescript
+ * console.log(handleKey('first-name'));  // "'first-name'"
+ * console.log(handleKey('2nd-place'));   // "'2nd-place'"
+ * console.log(handleKey('user name'));   // "'user name'"
+ * console.log(handleKey('api-key'));     // "'api-key'"
+ * console.log(handleKey('data.nested')); // "'data.nested'"
+ * ```
+ *
+ * @example Usage in object generation
+ * ```typescript
+ * class ObjectGenerator {
+ *   generateObjectLiteral(properties: Record<string, string>) {
+ *     const props = Object.entries(properties)
+ *       .map(([key, value]) => `${handleKey(key)}: ${value}`)
+ *       .join(', ');
+ *
+ *     return `{ ${props} }`;
+ *   }
+ * }
+ *
+ * const generator = new ObjectGenerator();
+ * const result = generator.generateObjectLiteral({
+ *   'name': 'string',
+ *   'first-name': 'string',
+ *   'age': 'number'
+ * });
+ *
+ * console.log(result);
+ * // { name: string, 'first-name': string, age: number }
+ * ```
+ *
+ * @example TypeScript interface generation
+ * ```typescript
+ * function generateInterface(name: string, properties: Record<string, string>) {
+ *   const props = Object.entries(properties)
+ *     .map(([key, type]) => `  ${handleKey(key)}: ${type};`)
+ *     .join('\n');
+ *
+ *   return `interface ${name} {\n${props}\n}`;
+ * }
+ *
+ * const userInterface = generateInterface('User', {
+ *   'id': 'string',
+ *   'first-name': 'string',
+ *   'last_name': 'string',
+ *   '2fa-enabled': 'boolean'
+ * });
+ *
+ * console.log(userInterface);
+ * // interface User {
+ * //   id: string;
+ * //   'first-name': string;
+ * //   last_name: string;
+ * //   '2fa-enabled': boolean;
+ * // }
+ * ```
+ */
 const handleKey = (key) => {
     return (0, helper_validator_identifier_1.isIdentifierName)(key) ? key : `'${key}'`;
 };
 exports.handleKey = handleKey;
+/**
+ * Safely formats property access, using dot notation or bracket notation as appropriate.
+ *
+ * This function generates the appropriate property access syntax for JavaScript/TypeScript
+ * code. Valid identifiers use dot notation (`parent.property`), while invalid identifiers
+ * use bracket notation (`parent['property']`).
+ *
+ * @param name - The property name to access
+ * @param parent - The parent object expression
+ * @returns Properly formatted property access expression
+ *
+ * @example Valid identifiers (dot notation)
+ * ```typescript
+ * import { handlePropertyName } from '@skmtc/core';
+ *
+ * console.log(handlePropertyName('name', 'user'));      // 'user.name'
+ * console.log(handlePropertyName('firstName', 'user')); // 'user.firstName'
+ * console.log(handlePropertyName('_id', 'document'));   // 'document._id'
+ * console.log(handlePropertyName('$meta', 'data'));     // 'data.$meta'
+ * ```
+ *
+ * @example Invalid identifiers (bracket notation)
+ * ```typescript
+ * console.log(handlePropertyName('first-name', 'user'));  // "user['first-name']"
+ * console.log(handlePropertyName('2nd-place', 'result')); // "result['2nd-place']"
+ * console.log(handlePropertyName('user name', 'form'));   // "form['user name']"
+ * console.log(handlePropertyName('api-key', 'config'));   // "config['api-key']"
+ * ```
+ *
+ * @example Usage in accessor generation
+ * ```typescript
+ * class PropertyAccessor {
+ *   generateGetter(objectName: string, propertyPath: string[]) {
+ *     return propertyPath.reduce((acc, prop) =>
+ *       handlePropertyName(prop, acc), objectName
+ *     );
+ *   }
+ * }
+ *
+ * const accessor = new PropertyAccessor();
+ * const path1 = accessor.generateGetter('data', ['user', 'profile', 'firstName']);
+ * const path2 = accessor.generateGetter('config', ['api-settings', 'retry-count']);
+ *
+ * console.log(path1); // 'data.user.profile.firstName'
+ * console.log(path2); // "config['api-settings']['retry-count']"
+ * ```
+ *
+ * @example Complex object navigation
+ * ```typescript
+ * function generateObjectAccess(base: string, properties: string[]) {
+ *   let result = base;
+ *
+ *   for (const prop of properties) {
+ *     result = handlePropertyName(prop, result);
+ *   }
+ *
+ *   return result;
+ * }
+ *
+ * const access1 = generateObjectAccess('response', ['data', 'user-info', 'name']);
+ * const access2 = generateObjectAccess('settings', ['ui', 'theme', 'darkMode']);
+ *
+ * console.log(access1); // "response.data['user-info'].name"
+ * console.log(access2); // "settings.ui.theme.darkMode"
+ * ```
+ *
+ * @example Function generation
+ * ```typescript
+ * function generatePropertyGetter(objName: string, propName: string) {
+ *   const access = handlePropertyName(propName, objName);
+ *   return `function get${propName.replace(/[^a-zA-Z0-9]/g, '')}() { return ${access}; }`;
+ * }
+ *
+ * const getter1 = generatePropertyGetter('user', 'firstName');
+ * const getter2 = generatePropertyGetter('config', 'api-key');
+ *
+ * console.log(getter1); // "function getfirstName() { return user.firstName; }"
+ * console.log(getter2); // "function getapikey() { return config['api-key']; }"
+ * ```
+ */
 const handlePropertyName = (name, parent) => {
     return (0, helper_validator_identifier_1.isIdentifierName)(name) ? `${parent}.${name}` : `${parent}['${name}']`;
 };

package/script/typescript/withDescription.d.ts

@@ -1,4 +1,123 @@
 import type { Stringable } from '../dsl/Stringable.js';
 import type { Modifiers } from '../types/Modifiers.js';
+/**
+ * Wraps a value with a JSDoc comment if a description is provided.
+ *
+ * This utility function is used throughout the SKMTC code generation system to
+ * add JSDoc documentation comments to generated TypeScript code. If a description
+ * is provided, it formats it as a single-line JSDoc comment above the value.
+ * If no description is provided, the value is returned unchanged.
+ *
+ * @param value - The code value to potentially wrap with documentation
+ * @param modifiers - Modifiers object containing optional description
+ * @param modifiers.description - Optional description text for the JSDoc comment
+ * @returns The value with JSDoc comment prepended if description exists, otherwise just the value
+ *
+ * @example With description
+ * ```typescript
+ * import { withDescription } from '@skmtc/core';
+ *
+ * const result = withDescription(
+ *   'export const API_URL = "https://api.example.com";',
+ *   { description: 'Base URL for all API requests' }
+ * );
+ *
+ * console.log(result);
+ * // /** Base URL for all API requests *\/
+ * // export const API_URL = "https://api.example.com";
+ * ```
+ *
+ * @example Without description
+ * ```typescript
+ * const result = withDescription(
+ *   'export const API_URL = "https://api.example.com";',
+ *   { description: undefined }
+ * );
+ *
+ * console.log(result);
+ * // export const API_URL = "https://api.example.com";
+ * ```
+ *
+ * @example Using with Definition class
+ * ```typescript
+ * class ModelGenerator {
+ *   generateInterface(name: string, description?: string) {
+ *     const interfaceCode = `interface ${name} {
+ *   id: string;
+ *   name: string;
+ * }`;
+ *
+ *     return withDescription(interfaceCode, { description });
+ *   }
+ * }
+ *
+ * const generator = new ModelGenerator();
+ * const documented = generator.generateInterface('User', 'Represents a user in the system');
+ *
+ * console.log(documented);
+ * // /** Represents a user in the system *\/
+ * // interface User {
+ * //   id: string;
+ * //   name: string;
+ * // }
+ * ```
+ *
+ * @example Integration with generated definitions
+ * ```typescript
+ * import { Definition, Identifier, withDescription } from '@skmtc/core';
+ *
+ * class DocumentedGenerator {
+ *   createDefinition(name: string, value: string, docs?: string) {
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createVariable(name),
+ *       description: docs, // This gets processed by withDescription internally
+ *       value: {
+ *         generatorKey: 'documented',
+ *         content: value
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Complex documentation
+ * ```typescript
+ * const complexDoc = withDescription(
+ *   `export type Status = 'active' | 'inactive' | 'pending';`,
+ *   {
+ *     description: 'User account status - active users can access all features'
+ *   }
+ * );
+ *
+ * console.log(complexDoc);
+ * // /** User account status - active users can access all features *\/
+ * // export type Status = 'active' | 'inactive' | 'pending';
+ * ```
+ *
+ * @example Conditional documentation
+ * ```typescript
+ * function generateWithOptionalDocs(
+ *   code: string,
+ *   includeDescription: boolean
+ * ) {
+ *   return withDescription(code, {
+ *     description: includeDescription
+ *       ? 'This is an auto-generated definition'
+ *       : undefined
+ *   });
+ * }
+ *
+ * const withDocs = generateWithOptionalDocs('export const VALUE = 42;', true);
+ * const withoutDocs = generateWithOptionalDocs('export const VALUE = 42;', false);
+ *
+ * console.log(withDocs);
+ * // /** This is an auto-generated definition *\/
+ * // export const VALUE = 42;
+ *
+ * console.log(withoutDocs);
+ * // export const VALUE = 42;
+ * ```
+ */
 export declare const withDescription: (value: Stringable, { description }: Modifiers) => string;
 //# sourceMappingURL=withDescription.d.ts.map

package/script/typescript/withDescription.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"withDescription.d.ts","sourceRoot":"","sources":["../../src/typescript/withDescription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD,eAAO,MAAM,eAAe,GAC1B,OAAO,UAAU,EACjB,iBAAiB,SAAS,KACzB,MAEF,CAAA"}
+{"version":3,"file":"withDescription.d.ts","sourceRoot":"","sources":["../../src/typescript/withDescription.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsHG;AACH,eAAO,MAAM,eAAe,GAC1B,OAAO,UAAU,EACjB,iBAAiB,SAAS,KACzB,MAEF,CAAA"}

package/script/typescript/withDescription.js

@@ -1,6 +1,125 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withDescription = void 0;
+/**
+ * Wraps a value with a JSDoc comment if a description is provided.
+ *
+ * This utility function is used throughout the SKMTC code generation system to
+ * add JSDoc documentation comments to generated TypeScript code. If a description
+ * is provided, it formats it as a single-line JSDoc comment above the value.
+ * If no description is provided, the value is returned unchanged.
+ *
+ * @param value - The code value to potentially wrap with documentation
+ * @param modifiers - Modifiers object containing optional description
+ * @param modifiers.description - Optional description text for the JSDoc comment
+ * @returns The value with JSDoc comment prepended if description exists, otherwise just the value
+ *
+ * @example With description
+ * ```typescript
+ * import { withDescription } from '@skmtc/core';
+ *
+ * const result = withDescription(
+ *   'export const API_URL = "https://api.example.com";',
+ *   { description: 'Base URL for all API requests' }
+ * );
+ *
+ * console.log(result);
+ * // /** Base URL for all API requests *\/
+ * // export const API_URL = "https://api.example.com";
+ * ```
+ *
+ * @example Without description
+ * ```typescript
+ * const result = withDescription(
+ *   'export const API_URL = "https://api.example.com";',
+ *   { description: undefined }
+ * );
+ *
+ * console.log(result);
+ * // export const API_URL = "https://api.example.com";
+ * ```
+ *
+ * @example Using with Definition class
+ * ```typescript
+ * class ModelGenerator {
+ *   generateInterface(name: string, description?: string) {
+ *     const interfaceCode = `interface ${name} {
+ *   id: string;
+ *   name: string;
+ * }`;
+ *
+ *     return withDescription(interfaceCode, { description });
+ *   }
+ * }
+ *
+ * const generator = new ModelGenerator();
+ * const documented = generator.generateInterface('User', 'Represents a user in the system');
+ *
+ * console.log(documented);
+ * // /** Represents a user in the system *\/
+ * // interface User {
+ * //   id: string;
+ * //   name: string;
+ * // }
+ * ```
+ *
+ * @example Integration with generated definitions
+ * ```typescript
+ * import { Definition, Identifier, withDescription } from '@skmtc/core';
+ *
+ * class DocumentedGenerator {
+ *   createDefinition(name: string, value: string, docs?: string) {
+ *     return new Definition({
+ *       context: this.context,
+ *       identifier: Identifier.createVariable(name),
+ *       description: docs, // This gets processed by withDescription internally
+ *       value: {
+ *         generatorKey: 'documented',
+ *         content: value
+ *       }
+ *     });
+ *   }
+ * }
+ * ```
+ *
+ * @example Complex documentation
+ * ```typescript
+ * const complexDoc = withDescription(
+ *   `export type Status = 'active' | 'inactive' | 'pending';`,
+ *   {
+ *     description: 'User account status - active users can access all features'
+ *   }
+ * );
+ *
+ * console.log(complexDoc);
+ * // /** User account status - active users can access all features *\/
+ * // export type Status = 'active' | 'inactive' | 'pending';
+ * ```
+ *
+ * @example Conditional documentation
+ * ```typescript
+ * function generateWithOptionalDocs(
+ *   code: string,
+ *   includeDescription: boolean
+ * ) {
+ *   return withDescription(code, {
+ *     description: includeDescription
+ *       ? 'This is an auto-generated definition'
+ *       : undefined
+ *   });
+ * }
+ *
+ * const withDocs = generateWithOptionalDocs('export const VALUE = 42;', true);
+ * const withoutDocs = generateWithOptionalDocs('export const VALUE = 42;', false);
+ *
+ * console.log(withDocs);
+ * // /** This is an auto-generated definition *\/
+ * // export const VALUE = 42;
+ *
+ * console.log(withoutDocs);
+ * // export const VALUE = 42;
+ * ```
+ */
 const withDescription = (value, { description }) => {
     return description ? `/** ${description} */\n${value}` : `${value}`;
 };