@skmtc/core 0.0.983 → 0.16.1

package/script/typescript/ReactRouterPathParams.js

@@ -1,236 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReactRouterPathParams = void 0;
-const ContentBase_js_1 = require("../dsl/ContentBase.js");
-/**
- * Generates React Router path parameter handling code for OpenAPI operations.
- *
- * `ReactRouterPathParams` is a specialized content generator that creates the necessary
- * React code for extracting and validating path parameters from React Router's `useParams`
- * hook. It automatically generates parameter extraction, assertion logic, and prop passing
- * code based on OpenAPI operation path parameters.
- *
- * This class is essential for generating type-safe React components that need to access
- * URL path parameters, ensuring runtime validation and proper TypeScript typing. It
- * integrates with React Router's `useParams` hook and adds runtime assertions using
- * the `tiny-invariant` library.
- *
- * ## Key Features
- *
- * - **Automatic Parameter Extraction**: Generates `useParams()` destructuring code
- * - **Runtime Assertions**: Creates invariant checks for required parameters
- * - **Prop Passing**: Generates prop spreading syntax for component integration
- * - **Import Management**: Automatically registers required imports
- * - **Type Safety**: Ensures parameters are properly validated at runtime
- *
- * @example Basic usage with single path parameter
- * ```typescript
- * import { ReactRouterPathParams } from '@skmtc/core';
- *
- * const operation = new OasOperation({
- *   path: '/users/{id}',
- *   method: 'get',
- *   // ... other operation properties
- * });
- *
- * const pathParams = new ReactRouterPathParams({
- *   context: generateContext,
- *   generatorKey: 'react-router-params',
- *   operation,
- *   destinationPath: './UserDetail.tsx'
- * });
- *
- * console.log(pathParams.getParams);
- * // 'const { id } = useParams()'
- *
- * console.log(pathParams.assertParams);
- * // 'invariant(id, 'Expected id to be defined')'
- *
- * console.log(pathParams.passProps);
- * // 'id={id}'
- * ```
- *
- * @example Multiple path parameters
- * ```typescript
- * const complexOperation = new OasOperation({
- *   path: '/organizations/{orgId}/projects/{projectId}/issues/{issueId}',
- *   method: 'get',
- *   // ... other properties
- * });
- *
- * const multiParams = new ReactRouterPathParams({
- *   context: generateContext,
- *   generatorKey: 'react-router-params',
- *   operation: complexOperation,
- *   destinationPath: './IssueDetail.tsx'
- * });
- *
- * console.log(multiParams.getParams);
- * // 'const { orgId, projectId, issueId } = useParams()'
- *
- * console.log(multiParams.assertParams);
- * // 'invariant(orgId, 'Expected orgId to be defined')
- * // invariant(projectId, 'Expected projectId to be defined')
- * // invariant(issueId, 'Expected issueId to be defined')'
- *
- * console.log(multiParams.passProps);
- * // 'orgId={orgId} projectId={projectId} issueId={issueId}'
- * ```
- *
- * @example Generated React component integration
- * ```typescript
- * // Generated component might look like:
- * import { useParams } from 'react-router-dom';
- * import invariant from 'tiny-invariant';
- *
- * function UserDetail() {
- *   const { id } = useParams();
- *   invariant(id, 'Expected id to be defined');
- *
- *   return <UserDetailView id={id} />;
- * }
- * ```
- *
- * @example No path parameters (empty generation)
- * ```typescript
- * const simpleOperation = new OasOperation({
- *   path: '/users',
- *   method: 'get',
- *   // ... other properties
- * });
- *
- * const emptyParams = new ReactRouterPathParams({
- *   context: generateContext,
- *   generatorKey: 'react-router-params',
- *   operation: simpleOperation,
- *   destinationPath: './UserList.tsx'
- * });
- *
- * console.log(emptyParams.getParams);    // ''
- * console.log(emptyParams.assertParams); // ''
- * console.log(emptyParams.passProps);    // ''
- * // No imports registered for this case
- * ```
- *
- * @example Integration in component generation
- * ```typescript
- * class ReactComponentGenerator {
- *   generateDetailComponent(operation: OasOperation) {
- *     const pathParams = new ReactRouterPathParams({
- *       context: this.context,
- *       generatorKey: 'react-component',
- *       operation,
- *       destinationPath: this.getDestinationPath(operation)
- *     });
- *
- *     if (pathParams.names.length === 0) {
- *       // Generate simple component without parameters
- *       return this.generateSimpleComponent(operation);
- *     }
- *
- *     return `
- * function ${operation.operationId}() {
- *   ${pathParams.getParams}
- *   ${pathParams.assertParams}
- *
- *   return (
- *     <DetailView ${pathParams.passProps} />
- *   );
- * }`;
- *   }
- * }
- * ```
- *
- * @example Custom parameter validation
- * ```typescript
- * class CustomReactRouterParams extends ReactRouterPathParams {
- *   generateCustomAssertions(paramName: string): string {
- *     return `
- * invariant(${paramName}, 'Expected ${paramName} to be defined');
- * invariant(typeof ${paramName} === 'string', '${paramName} must be a string');
- * invariant(${paramName}.length > 0, '${paramName} cannot be empty');`;
- *   }
- * }
- * ```
- */
-class ReactRouterPathParams extends ContentBase_js_1.ContentBase {
-    /**
-     * Creates a new ReactRouterPathParams instance with generated parameter handling code.
-     *
-     * The constructor analyzes the OpenAPI operation to extract path parameters and
-     * generates the necessary React code for parameter extraction, validation, and
-     * prop passing. It automatically registers required imports when parameters are present.
-     *
-     * @param args - Configuration for React Router parameter generation
-     *
-     * @example
-     * ```typescript
-     * const pathParams = new ReactRouterPathParams({
-     *   context: generateContext,
-     *   generatorKey: 'react-params',
-     *   operation: userDetailOperation, // has path '/users/{id}'
-     *   destinationPath: './UserDetail.tsx'
-     * });
-     * ```
-     */
-    constructor({ context, operation, generatorKey, destinationPath }) {
-        super({ context, generatorKey });
-        /** Generated code for extracting parameters from useParams() */
-        Object.defineProperty(this, "getParams", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ''
-        });
-        /** Generated code for runtime parameter assertions */
-        Object.defineProperty(this, "assertParams", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ''
-        });
-        /** Generated code for passing parameters as component props */
-        Object.defineProperty(this, "passProps", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ''
-        });
-        /** Array of parameter names extracted from the operation path */
-        Object.defineProperty(this, "names", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        const names = operation.toParams(['path']).map(param => param.name);
-        this.names = names;
-        if (names.length > 0) {
-            this.getParams = `const { ${names.join(', ')} } = useParams()`;
-            this.assertParams = names
-                .map(param => `invariant(${param}, 'Expected ${param} to be defined')`)
-                .join('\n');
-            this.passProps = names.map(param => `${param}={${param}}`).join(' ');
-            this.register({
-                imports: {
-                    'react-router-dom': ['useParams'],
-                    'tiny-invariant': [{ default: 'invariant' }]
-                },
-                destinationPath
-            });
-        }
-    }
-    /**
-     * Returns an empty string as this class provides code through its properties.
-     *
-     * The ReactRouterPathParams class doesn't generate output through toString(),
-     * instead providing generated code through the `getParams`, `assertParams`,
-     * and `passProps` properties which can be used directly in template generation.
-     *
-     * @returns Empty string
-     */
-    toString() {
-        return ``;
-    }
-}
-exports.ReactRouterPathParams = ReactRouterPathParams;

package/script/typescript/identifiers.d.ts

@@ -1,162 +0,0 @@
-/**
- * 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;
- * // }
- * ```
- */
-export declare const handleKey: (key: string) => string;
-/**
- * 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']; }"
- * ```
- */
-export declare const handlePropertyName: (name: string, parent: string) => string;
-//# sourceMappingURL=identifiers.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"identifiers.d.ts","sourceRoot":"","sources":["../../src/typescript/identifiers.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8EG;AACH,eAAO,MAAM,SAAS,GAAI,KAAK,MAAM,KAAG,MAEvC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+EG;AACH,eAAO,MAAM,kBAAkB,GAAI,MAAM,MAAM,EAAE,QAAQ,MAAM,KAAG,MAEjE,CAAA"}

package/script/typescript/identifiers.js

@@ -1,171 +0,0 @@
-"use strict";
-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}']`;
-};
-exports.handlePropertyName = handlePropertyName;