@memberjunction/database-designer-actions 0.0.1 → 5.32.0

package/src/actions/list-entities.action.ts

@@ -0,0 +1,110 @@
+/**
+ * @module list-entities.action
+ * @description Returns a summary list of entities created via the Database Designer.
+ *
+ * Queries MJ: Entity Settings for records with `MJ:UDT:Owner = contextUser.ID`
+ * then joins with Entities metadata to build a human-readable summary.
+ */
+
+import { RegisterClass, UUIDsEqual } from '@memberjunction/global';
+import { BaseAction } from '@memberjunction/actions';
+import type { ActionResultSimple, RunActionParams } from '@memberjunction/actions-base';
+import { RunView, Metadata, UserInfo } from '@memberjunction/core';
+
+import { UDT_SETTINGS, escapeSqlLiteral } from '@memberjunction/database-designer-core';
+
+import { BaseDatabaseDesignerAction } from './base-database-designer.action.js';
+
+// ─── Types ────────────────────────────────────────────────────────────────────
+
+interface EntitySummary {
+    EntityID: string;
+    EntityName: string;
+    SchemaName: string;
+    TableName: string;
+    Description: string | null;
+}
+
+// ─── Registration ─────────────────────────────────────────────────────────────
+
+/**
+ * Lists all entities created by the current user via the Database Designer.
+ *
+ * Input params: none — uses `ContextUser` for ownership lookup.
+ *
+ * Output params:
+ *  - `Entities`     — Array of EntitySummary objects.
+ *  - `EntityCount`  — Total number of entities owned by this user.
+ */
+@RegisterClass(BaseAction, 'List My Entities')
+export class ListMyEntitiesAction extends BaseDatabaseDesignerAction {
+    protected async InternalRunAction(params: RunActionParams): Promise<ActionResultSimple> {
+        try {
+            const userID = params.ContextUser?.ID;
+            if (!userID) {
+                return {
+                    Success: false,
+                    ResultCode: 'NO_USER_CONTEXT',
+                    Message: 'ContextUser is required to list owned entities.',
+                };
+            }
+
+            const entities = await this.loadUserEntities(userID, params);
+
+            this.addOutputParam(params, 'Entities', entities);
+            this.addOutputParam(params, 'EntityCount', entities.length);
+
+            return {
+                Success: true,
+                ResultCode: 'SUCCESS',
+                Message: `Found ${entities.length} entity${entities.length === 1 ? '' : 'ies'} created by this user.`,
+            };
+        } catch (err) {
+            return this.handleUnexpected(err, 'List My Entities');
+        }
+    }
+
+    // ─── Private helpers ──────────────────────────────────────────────────
+
+    /** Query Entity Settings for ownership records, then enrich from metadata. */
+    private async loadUserEntities(
+        userID: string,
+        params: RunActionParams
+    ): Promise<EntitySummary[]> {
+        const rv = new RunView();
+        const settingsResult = await rv.RunView<{ EntityID: string }>({
+            EntityName: 'MJ: Entity Settings',
+            ExtraFilter: `Name = '${UDT_SETTINGS.OWNER_KEY}' AND Value = '${escapeSqlLiteral(userID)}'`,
+            Fields: ['EntityID'],
+            ResultType: 'simple',
+        }, params.ContextUser);
+
+        if (!settingsResult.Success || settingsResult.Results.length === 0) {
+            return [];
+        }
+
+        const entityIDs = settingsResult.Results.map(r => r.EntityID);
+        return this.buildEntitySummaries(entityIDs, params.ContextUser);
+    }
+
+    /** Look up entity metadata for a list of entity IDs. */
+    private buildEntitySummaries(
+        entityIDs: string[],
+        contextUser: UserInfo
+    ): EntitySummary[] {
+        const md = new Metadata(); // global-provider-ok: MJAPI server-side, single-provider deployment
+        return entityIDs.reduce<EntitySummary[]>((acc, id) => {
+            const info = md.Entities.find(e => UUIDsEqual(e.ID, id));
+            if (info) {
+                acc.push({
+                    EntityID: info.ID,
+                    EntityName: info.Name,
+                    SchemaName: info.SchemaName ?? '',
+                    TableName: info.BaseTable ?? '',
+                    Description: info.Description ?? null,
+                });
+            }
+            return acc;
+        }, []);
+    }
+}

package/src/actions/modify-entity.action.ts

@@ -0,0 +1,75 @@
+/**
+ * @module modify-entity.action
+ * @description Action that applies ALTER TABLE changes to an existing MJ entity
+ * based on a new `TableDefinition` (desired state).
+ *
+ * Execution path:
+ *  1. Extract and validate params
+ *  2. Authorization check
+ *  3. Load existing table info via DatabaseDesignerPipelineExecutor.LoadExistingTableInfo
+ *  4. Delegate to DatabaseDesignerPipelineExecutor.ModifyEntity
+ */
+
+import { RegisterClass } from '@memberjunction/global';
+import { BaseAction } from '@memberjunction/actions';
+import type { ActionResultSimple, RunActionParams } from '@memberjunction/actions-base';
+
+import {
+    DatabaseDesignerPipelineExecutor,
+    UDT_SETTINGS,
+} from '@memberjunction/database-designer-core';
+
+import { BaseDatabaseDesignerAction } from './base-database-designer.action.js';
+
+// ─── Registration ─────────────────────────────────────────────────────────────
+
+/**
+ * Applies ALTER TABLE changes to an existing MemberJunction entity.
+ *
+ * Input params:
+ *  - `TableDefinition` (required) — desired table state as a JSON object.
+ *  - `SkipGitCommit`   (optional, default false)
+ *  - `SkipRestart`     (optional, default false)
+ *
+ * Output params written on success:
+ *  - `EntityID`, `EntityName`, `SchemaName`, `TableName`, `PipelineSteps`
+ */
+@RegisterClass(BaseAction, 'Modify Entity')
+export class ModifyEntityAction extends BaseDatabaseDesignerAction {
+    protected async InternalRunAction(params: RunActionParams): Promise<ActionResultSimple> {
+        try {
+            const { td, error: tdError } = this.getTableDefinitionParam(params);
+            if (tdError) return tdError;
+
+            const authError = await this.checkAuthorization(td!, 'alter', params.ContextUser);
+            if (authError) {
+                return { Success: false, ResultCode: 'UNAUTHORIZED', Message: authError };
+            }
+
+            const existingInfo = await DatabaseDesignerPipelineExecutor.LoadExistingTableInfo(
+                td!.SchemaName,
+                td!.TableName,
+                params.ContextUser
+            );
+            if (!existingInfo) {
+                return {
+                    Success: false,
+                    ResultCode: 'ENTITY_NOT_FOUND',
+                    Message: `Table '${td!.SchemaName}.${td!.TableName}' was not found in the database.`,
+                };
+            }
+
+            const options = this.buildPipelineOptions(params, UDT_SETTINGS.SOURCE_DATABASE_DESIGNER);
+            const execResult = await DatabaseDesignerPipelineExecutor.ModifyEntity(
+                td!,
+                existingInfo,
+                params.ContextUser,
+                options
+            );
+
+            return this.buildPipelineResult(execResult, params);
+        } catch (err) {
+            return this.handleUnexpected(err, 'Modify Entity');
+        }
+    }
+}

package/src/actions/validate-entity-schema.action.ts

@@ -0,0 +1,89 @@
+/**
+ * @module validate-entity-schema.action
+ * @description Action that validates a `TableDefinition` against all Entity
+ * Designer pre-creation checks without executing the RSU pipeline.
+ *
+ * Intended callers:
+ *  - Angular visual wizard (Step 4 — Review) pre-validates before the user
+ *    submits to `CreateEntityAction` so errors surface early without a
+ *    round-trip through the full pipeline.
+ *  - Any workflow that needs a dry-run validation step before creation.
+ *
+ * This action runs the same `DatabaseSchemaValidationService` that the agent
+ * path (`DatabaseDesignerSchemaValidator`) uses, ensuring both paths are
+ * governed by identical rules.
+ *
+ * Input params:
+ *  - `TableDefinition` (required) — JSON object conforming to the schema-engine
+ *    `TableDefinition` interface.
+ *  - `ModificationType` (optional, default 'create') — 'create' | 'alter'.
+ *    Determines which authorization is checked before validation.
+ *
+ * Output params written on both success and validation failure:
+ *  - `ValidationResult` — `{ Valid, Errors, Warnings }` — always present on
+ *    `Success: true` so callers can inspect details without parsing `Message`.
+ *
+ * ResultCode values:
+ *  - `VALIDATION_PASSED` — definition is valid, safe to proceed to CreateEntity.
+ *  - `VALIDATION_FAILED` — definition has errors; inspect `ValidationResult.Errors`.
+ *  - `UNAUTHORIZED`      — contextUser lacks the required authorization.
+ *  - `MISSING_PARAMETER` — required params were not provided.
+ *  - `UNEXPECTED_ERROR`  — unhandled exception (check server logs).
+ */
+
+import { RegisterClass } from '@memberjunction/global';
+import { BaseAction } from '@memberjunction/actions';
+import type { ActionResultSimple, RunActionParams } from '@memberjunction/actions-base';
+
+import {
+    DatabaseSchemaValidationService,
+} from '@memberjunction/database-designer-core';
+
+import { BaseDatabaseDesignerAction } from './base-database-designer.action.js';
+
+// ─── Registration ─────────────────────────────────────────────────────────────
+
+@RegisterClass(BaseAction, 'Validate Entity Schema')
+export class ValidateEntitySchemaAction extends BaseDatabaseDesignerAction {
+
+    protected async InternalRunAction(params: RunActionParams): Promise<ActionResultSimple> {
+        try {
+            const { td, error: tdError } = this.getTableDefinitionParam(params);
+            if (tdError) return tdError;
+
+            const modificationType = this.getModificationTypeParam(params);
+
+            // Authorization check: verify the user is allowed to perform this
+            // operation type before revealing any validation details.
+            const authError = await this.checkAuthorization(td!, modificationType, params.ContextUser);
+            if (authError) {
+                return { Success: false, ResultCode: 'UNAUTHORIZED', Message: authError };
+            }
+
+            // Run all deterministic validation checks via the shared service.
+            const service = new DatabaseSchemaValidationService();
+            const validationResult = await service.validate(td!, params.ContextUser, modificationType);
+
+            // Always write the structured result as an output param so callers
+            // can read Errors/Warnings without parsing the human-readable Message.
+            this.addOutputParam(params, 'ValidationResult', validationResult);
+
+            if (validationResult.Valid) {
+                return {
+                    Success: true,
+                    ResultCode: 'VALIDATION_PASSED',
+                    Message: 'Validation passed. The entity definition is ready for creation.',
+                };
+            }
+
+            return {
+                Success: true, // Action ran successfully — validation result is the output
+                ResultCode: 'VALIDATION_FAILED',
+                Message: `Validation failed: ${validationResult.Errors.join('; ')}`,
+            };
+
+        } catch (err) {
+            return this.handleUnexpected(err, 'Validate Entity Schema');
+        }
+    }
+}

package/src/index.ts

@@ -0,0 +1,15 @@
+/**
+ * @module @memberjunction/database-designer-actions
+ * @description Database Designer action classes for use by AI agents,
+ * workflow engines, and low-code builders.
+ *
+ * Importing this module registers all action driver classes with the MJ
+ * ClassFactory so they are discoverable at runtime.
+ */
+
+export * from './actions/base-database-designer.action.js';
+export * from './actions/create-entity.action.js';
+export * from './actions/modify-entity.action.js';
+export * from './actions/list-entities.action.js';
+export * from './actions/describe-entity.action.js';
+export * from './actions/validate-entity-schema.action.js';

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../../../tsconfig.server.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src"
+  },
+  "include": [
+    "src/**/*"
+  ],
+  "exclude": [
+    "node_modules",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "vitest.config.ts"
+  ]
+}

package/vitest.config.ts

@@ -0,0 +1,8 @@
+import { mergeConfig, defineProject } from 'vitest/config';
+import sharedConfig from '../../../../vitest.shared';
+
+export default mergeConfig(sharedConfig, defineProject({
+    test: {
+        environment: 'node',
+    },
+}));

package/README.md

@@ -1,45 +0,0 @@
-# @memberjunction/database-designer-actions
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@memberjunction/database-designer-actions`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**