@rvoh/psychic 3.3.0 → 3.4.0

package/dist/cjs/src/cli/index.js

@@ -8,7 +8,7 @@ import generateOpenapiZustandBindings from '../generate/openapi/zustandBindings.
 import generateResource from '../generate/resource.js';
 import Watcher from '../watcher/Watcher.js';
 const INDENT = '                  ';
-const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
+const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name, which may take an @alias suffix to rename the FK) properties like this:
 ${INDENT}    title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
 ${INDENT}
 ${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
@@ -68,7 +68,16 @@ ${INDENT}
 ${INDENT}        use the fully qualified model name (matching its path under src/app/models/):
 ${INDENT}          User:belongs_to                  # creates user_id column + BelongsTo association
 ${INDENT}          Health/Coach:belongs_to           # creates health_coach_id column + BelongsTo association
-${INDENT}          User:belongs_to:optional          # nullable foreign key (for optional associations)`;
+${INDENT}          User:belongs_to:optional          # nullable foreign key (for optional associations)
+${INDENT}
+${INDENT}        rename the association with Model@alias — the snake_case alias drives the FK column name AND the
+${INDENT}        @deco.BelongsTo association + typed FK property on the generated model:
+${INDENT}          InternalUser@canceled_by:belongs_to:optional       # canceled_by_id column, canceledById property, canceledBy association,
+${INDENT}                                                             #   @deco.BelongsTo('InternalUser', { on: 'canceledById', optional: true })
+${INDENT}          Messaging/Template@template:belongs_to             # template_id column, templateId property, template association
+${INDENT}                                                             #   (strips the namespace from the property/association names while keeping
+${INDENT}                                                             #   the namespaced model reference intact)
+${INDENT}        Aliasing also lets you declare multiple FKs to the same model in one generator call without column collisions.`;
 export default class PsychicCLI {
     static provide(program, { initializePsychicApp, seedDb, }) {
         DreamCLI.generateDreamCli(program, {

package/dist/cjs/src/generate/helpers/parseAttribute.js

@@ -9,16 +9,46 @@ import { camelize } from '@rvoh/dream/utils';
  * paramSafe column allowlist) share one canonical interpretation of the
  * tokens — and one canonical casing (camelCase) for the resulting attribute
  * name.
+ *
+ * Supports the `Model@alias:belongs_to` shorthand for renaming the FK
+ * association. When `@alias` is present, the camelized alias becomes
+ * `attributeName`; otherwise (legacy form `Model:belongs_to`) the
+ * attribute name is derived from the model's last namespace segment.
+ *
+ * Mirrors Dream's CLI-side `parseAttribute` (kept as a parallel
+ * implementation rather than a shared import so neither package leaks an
+ * internal CLI helper through its public API surface).
  */
 export default function parseAttribute(attribute) {
-    const [rawAttributeName, rawAttributeType, , enumValues] = attribute.split(':');
-    if (!rawAttributeName || !rawAttributeType)
+    const segments = attribute.split(':');
+    const rawSegmentOne = segments[0];
+    const rawAttributeType = segments[1];
+    if (!rawSegmentOne || !rawAttributeType)
         return null;
+    // Extract optional `@alias` from segment-1 (used by the belongs_to FK alias
+    // shorthand, e.g., `InternalUser@canceled_by:belongs_to`).
+    let rawAttributeName = rawSegmentOne;
+    let aliasName;
+    const atIndex = rawSegmentOne.indexOf('@');
+    if (atIndex !== -1) {
+        rawAttributeName = rawSegmentOne.slice(0, atIndex);
+        const rawAlias = rawSegmentOne.slice(atIndex + 1);
+        if (!rawAttributeName || !rawAlias)
+            return null;
+        aliasName = rawAlias;
+    }
+    // Pop trailing `optional` keyword from descriptors so it doesn't get
+    // mistaken for enum values or other positional descriptors.
+    const descriptors = segments.slice(2);
+    if (descriptors[descriptors.length - 1] === 'optional')
+        descriptors.pop();
+    const enumValues = descriptors[1];
     const sanitizedAttrType = camelize(rawAttributeType)?.toLowerCase();
     // Handle belongs_to relationships
     if (sanitizedAttrType === 'belongsto') {
-        // For belongs_to relationships, convert "Ticketing/Ticket" to "ticket"
-        const attributeName = camelize(rawAttributeName.split('/').pop());
+        // For belongs_to relationships, prefer the explicit alias when present;
+        // otherwise convert "Ticketing/Ticket" → "ticket".
+        const attributeName = aliasName ? camelize(aliasName) : camelize(rawAttributeName.split('/').pop());
         return { attributeName, attributeType: 'belongs_to', isArray: false, enumValues };
     }
     // Skip _type and _id columns, but not belongs_to relationships

package/dist/esm/src/cli/index.js

@@ -8,7 +8,7 @@ import generateOpenapiZustandBindings from '../generate/openapi/zustandBindings.
 import generateResource from '../generate/resource.js';
 import Watcher from '../watcher/Watcher.js';
 const INDENT = '                  ';
-const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name) properties like this:
+const baseColumnsWithTypesDescription = `space separated snake-case (except for belongs_to model name, which may take an @alias suffix to rename the FK) properties like this:
 ${INDENT}    title:citext subtitle:string body_markdown:text style:enum:post_styles:formal,informal User:belongs_to
 ${INDENT}
 ${INDENT}all properties default to not nullable; null can be allowed by appending ':optional':
@@ -68,7 +68,16 @@ ${INDENT}
 ${INDENT}        use the fully qualified model name (matching its path under src/app/models/):
 ${INDENT}          User:belongs_to                  # creates user_id column + BelongsTo association
 ${INDENT}          Health/Coach:belongs_to           # creates health_coach_id column + BelongsTo association
-${INDENT}          User:belongs_to:optional          # nullable foreign key (for optional associations)`;
+${INDENT}          User:belongs_to:optional          # nullable foreign key (for optional associations)
+${INDENT}
+${INDENT}        rename the association with Model@alias — the snake_case alias drives the FK column name AND the
+${INDENT}        @deco.BelongsTo association + typed FK property on the generated model:
+${INDENT}          InternalUser@canceled_by:belongs_to:optional       # canceled_by_id column, canceledById property, canceledBy association,
+${INDENT}                                                             #   @deco.BelongsTo('InternalUser', { on: 'canceledById', optional: true })
+${INDENT}          Messaging/Template@template:belongs_to             # template_id column, templateId property, template association
+${INDENT}                                                             #   (strips the namespace from the property/association names while keeping
+${INDENT}                                                             #   the namespaced model reference intact)
+${INDENT}        Aliasing also lets you declare multiple FKs to the same model in one generator call without column collisions.`;
 export default class PsychicCLI {
     static provide(program, { initializePsychicApp, seedDb, }) {
         DreamCLI.generateDreamCli(program, {

package/dist/esm/src/generate/helpers/parseAttribute.js

@@ -9,16 +9,46 @@ import { camelize } from '@rvoh/dream/utils';
  * paramSafe column allowlist) share one canonical interpretation of the
  * tokens — and one canonical casing (camelCase) for the resulting attribute
  * name.
+ *
+ * Supports the `Model@alias:belongs_to` shorthand for renaming the FK
+ * association. When `@alias` is present, the camelized alias becomes
+ * `attributeName`; otherwise (legacy form `Model:belongs_to`) the
+ * attribute name is derived from the model's last namespace segment.
+ *
+ * Mirrors Dream's CLI-side `parseAttribute` (kept as a parallel
+ * implementation rather than a shared import so neither package leaks an
+ * internal CLI helper through its public API surface).
  */
 export default function parseAttribute(attribute) {
-    const [rawAttributeName, rawAttributeType, , enumValues] = attribute.split(':');
-    if (!rawAttributeName || !rawAttributeType)
+    const segments = attribute.split(':');
+    const rawSegmentOne = segments[0];
+    const rawAttributeType = segments[1];
+    if (!rawSegmentOne || !rawAttributeType)
         return null;
+    // Extract optional `@alias` from segment-1 (used by the belongs_to FK alias
+    // shorthand, e.g., `InternalUser@canceled_by:belongs_to`).
+    let rawAttributeName = rawSegmentOne;
+    let aliasName;
+    const atIndex = rawSegmentOne.indexOf('@');
+    if (atIndex !== -1) {
+        rawAttributeName = rawSegmentOne.slice(0, atIndex);
+        const rawAlias = rawSegmentOne.slice(atIndex + 1);
+        if (!rawAttributeName || !rawAlias)
+            return null;
+        aliasName = rawAlias;
+    }
+    // Pop trailing `optional` keyword from descriptors so it doesn't get
+    // mistaken for enum values or other positional descriptors.
+    const descriptors = segments.slice(2);
+    if (descriptors[descriptors.length - 1] === 'optional')
+        descriptors.pop();
+    const enumValues = descriptors[1];
     const sanitizedAttrType = camelize(rawAttributeType)?.toLowerCase();
     // Handle belongs_to relationships
     if (sanitizedAttrType === 'belongsto') {
-        // For belongs_to relationships, convert "Ticketing/Ticket" to "ticket"
-        const attributeName = camelize(rawAttributeName.split('/').pop());
+        // For belongs_to relationships, prefer the explicit alias when present;
+        // otherwise convert "Ticketing/Ticket" → "ticket".
+        const attributeName = aliasName ? camelize(aliasName) : camelize(rawAttributeName.split('/').pop());
         return { attributeName, attributeType: 'belongs_to', isArray: false, enumValues };
     }
     // Skip _type and _id columns, but not belongs_to relationships

package/dist/types/src/generate/helpers/parseAttribute.d.ts

@@ -14,5 +14,14 @@ export interface ParsedAttribute {
  * paramSafe column allowlist) share one canonical interpretation of the
  * tokens — and one canonical casing (camelCase) for the resulting attribute
  * name.
+ *
+ * Supports the `Model@alias:belongs_to` shorthand for renaming the FK
+ * association. When `@alias` is present, the camelized alias becomes
+ * `attributeName`; otherwise (legacy form `Model:belongs_to`) the
+ * attribute name is derived from the model's last namespace segment.
+ *
+ * Mirrors Dream's CLI-side `parseAttribute` (kept as a parallel
+ * implementation rather than a shared import so neither package leaks an
+ * internal CLI helper through its public API surface).
  */
 export default function parseAttribute(attribute: string): ParsedAttribute | null;

package/package.json

@@ -2,7 +2,7 @@
   "type": "module",
   "name": "@rvoh/psychic",
   "description": "Typescript web framework",
-  "version": "3.3.0",
+  "version": "3.4.0",
   "author": "RVOHealth",
   "repository": {
     "type": "git",