@memberjunction/server 3.4.0 → 4.1.0

package/dist/resolvers/APIKeyResolver.d.ts

@@ -1,24 +1,98 @@
 import { AppContext } from "../types.js";
 import { ResolverBase } from "../generic/ResolverBase.js";
+/**
+ * Input type for creating a new API key
+ */
 export declare class CreateAPIKeyInput {
+    /**
+     * Human-readable label for the API key
+     */
     Label: string;
+    /**
+     * Optional description of what the key is used for
+     */
     Description?: string;
+    /**
+     * Optional expiration date for the key
+     */
     ExpiresAt?: Date;
+    /**
+     * Optional array of scope IDs to assign to this key
+     */
     ScopeIDs?: string[];
 }
+/**
+ * Result type for API key creation
+ * Returns the raw key ONCE - it cannot be recovered after this
+ */
 export declare class CreateAPIKeyResult {
+    /**
+     * Whether the key was created successfully
+     */
     Success: boolean;
+    /**
+     * The raw API key - show this to the user ONCE
+     * This cannot be recovered after the initial response
+     */
     RawKey?: string;
+    /**
+     * The database ID of the created API key
+     */
     APIKeyID?: string;
+    /**
+     * Error message if creation failed
+     */
     Error?: string;
 }
+/**
+ * Result type for API key revocation
+ */
 export declare class RevokeAPIKeyResult {
+    /**
+     * Whether the key was revoked successfully
+     */
     Success: boolean;
+    /**
+     * Error message if revocation failed
+     */
     Error?: string;
 }
+/**
+ * Resolver for API key operations
+ * Handles secure server-side API key generation
+ */
 export declare class APIKeyResolver extends ResolverBase {
+    /**
+     * Creates a new API key with proper server-side cryptographic hashing.
+     *
+     * This mutation:
+     * 1. Generates a cryptographically secure API key using APIKeyEngine
+     * 2. Stores only the SHA-256 hash in the database (never the raw key)
+     * 3. Returns the raw key ONCE - it cannot be recovered after this call
+     * 4. Optionally assigns scope permissions to the key
+     *
+     * @param input The creation parameters
+     * @param ctx The GraphQL context with authenticated user
+     * @returns The raw key (show once!) and database ID
+     */
     CreateAPIKey(input: CreateAPIKeyInput, ctx: AppContext): Promise<CreateAPIKeyResult>;
+    /**
+     * Revokes an API key, permanently disabling it.
+     *
+     * Once revoked, an API key cannot be reactivated. Users must create a new key.
+     * This uses APIKeyEngine.RevokeAPIKey() for consistency.
+     *
+     * @param apiKeyId The database ID of the API key to revoke
+     * @param ctx The GraphQL context with authenticated user
+     * @returns Success status
+     */
     RevokeAPIKey(apiKeyId: string, ctx: AppContext): Promise<RevokeAPIKeyResult>;
+    /**
+     * Saves scope associations for the newly created API key
+     * @param apiKeyId The ID of the created API key
+     * @param scopeIds Array of scope IDs to associate
+     * @param user The context user
+     */
     private saveScopeAssociations;
 }
 //# sourceMappingURL=APIKeyResolver.d.ts.map

package/dist/resolvers/APIKeyResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"APIKeyResolver.d.ts","sourceRoot":"","sources":["../../src/resolvers/APIKeyResolver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAK1D,qBACa,iBAAiB;IAK1B,KAAK,EAAE,MAAM,CAAC;IAMd,WAAW,CAAC,EAAE,MAAM,CAAC;IAMrB,SAAS,CAAC,EAAE,IAAI,CAAC;IAMjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAMD,qBACa,kBAAkB;IAK3B,OAAO,EAAE,OAAO,CAAC;IAOjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAMhB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAMlB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAKD,qBACa,kBAAkB;IAK3B,OAAO,EAAE,OAAO,CAAC;IAMjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,qBACa,cAAe,SAAQ,YAAY;IAetC,YAAY,CACA,KAAK,EAAE,iBAAiB,EAC/B,GAAG,EAAE,UAAU,GACvB,OAAO,CAAC,kBAAkB,CAAC;IAgExB,YAAY,CACG,QAAQ,EAAE,MAAM,EAC1B,GAAG,EAAE,UAAU,GACvB,OAAO,CAAC,kBAAkB,CAAC;YAwChB,qBAAqB;CAsBtC"}
+{"version":3,"file":"APIKeyResolver.d.ts","sourceRoot":"","sources":["../../src/resolvers/APIKeyResolver.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;GAEG;AACH,qBACa,iBAAiB;IAC1B;;OAEG;IAEH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IAEH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IAEH,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB;;OAEG;IAEH,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;GAGG;AACH,qBACa,kBAAkB;IAC3B;;OAEG;IAEH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IAEH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IAEH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,qBACa,kBAAkB;IAC3B;;OAEG;IAEH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IAEH,KAAK,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;GAGG;AACH,qBACa,cAAe,SAAQ,YAAY;IAC5C;;;;;;;;;;;;OAYG;IAEG,YAAY,CACA,KAAK,EAAE,iBAAiB,EAC/B,GAAG,EAAE,UAAU,GACvB,OAAO,CAAC,kBAAkB,CAAC;IAqD9B;;;;;;;;;OASG;IAEG,YAAY,CACG,QAAQ,EAAE,MAAM,EAC1B,GAAG,EAAE,UAAU,GACvB,OAAO,CAAC,kBAAkB,CAAC;IAkC9B;;;;;OAKG;YACW,qBAAqB;CAsBtC"}

package/dist/resolvers/APIKeyResolver.js

@@ -15,11 +15,10 @@ import { Field, InputType, ObjectType } from "type-graphql";
 import { LogError, Metadata } from "@memberjunction/core";
 import { GetAPIKeyEngine } from "@memberjunction/api-keys";
 import { ResolverBase } from "../generic/ResolverBase.js";
+/**
+ * Input type for creating a new API key
+ */
 let CreateAPIKeyInput = class CreateAPIKeyInput {
-    Label;
-    Description;
-    ExpiresAt;
-    ScopeIDs;
 };
 __decorate([
     Field(),
@@ -41,11 +40,11 @@ CreateAPIKeyInput = __decorate([
     InputType()
 ], CreateAPIKeyInput);
 export { CreateAPIKeyInput };
+/**
+ * Result type for API key creation
+ * Returns the raw key ONCE - it cannot be recovered after this
+ */
 let CreateAPIKeyResult = class CreateAPIKeyResult {
-    Success;
-    RawKey;
-    APIKeyID;
-    Error;
 };
 __decorate([
     Field(),
@@ -67,9 +66,10 @@ CreateAPIKeyResult = __decorate([
     ObjectType()
 ], CreateAPIKeyResult);
 export { CreateAPIKeyResult };
+/**
+ * Result type for API key revocation
+ */
 let RevokeAPIKeyResult = class RevokeAPIKeyResult {
-    Success;
-    Error;
 };
 __decorate([
     Field(),
@@ -83,10 +83,29 @@ RevokeAPIKeyResult = __decorate([
     ObjectType()
 ], RevokeAPIKeyResult);
 export { RevokeAPIKeyResult };
+/**
+ * Resolver for API key operations
+ * Handles secure server-side API key generation
+ */
 let APIKeyResolver = class APIKeyResolver extends ResolverBase {
+    /**
+     * Creates a new API key with proper server-side cryptographic hashing.
+     *
+     * This mutation:
+     * 1. Generates a cryptographically secure API key using APIKeyEngine
+     * 2. Stores only the SHA-256 hash in the database (never the raw key)
+     * 3. Returns the raw key ONCE - it cannot be recovered after this call
+     * 4. Optionally assigns scope permissions to the key
+     *
+     * @param input The creation parameters
+     * @param ctx The GraphQL context with authenticated user
+     * @returns The raw key (show once!) and database ID
+     */
     async CreateAPIKey(input, ctx) {
+        // Check API key scope authorization for API key creation
         await this.CheckAPIKeyScopeAuthorization('apikey:create', '*', ctx.userPayload);
         try {
+            // Get the authenticated user
             const user = ctx.userPayload.userRecord;
             if (!user) {
                 return {
@@ -94,6 +113,7 @@ let APIKeyResolver = class APIKeyResolver extends ResolverBase {
                     Error: "User is not authenticated"
                 };
             }
+            // Use APIKeyEngine to create the API key with proper server-side crypto
             const apiKeyEngine = GetAPIKeyEngine();
             const result = await apiKeyEngine.CreateAPIKey({
                 UserId: user.ID,
@@ -107,6 +127,7 @@ let APIKeyResolver = class APIKeyResolver extends ResolverBase {
                     Error: result.Error || "Failed to create API key"
                 };
             }
+            // Save scope associations if provided
             if (input.ScopeIDs && input.ScopeIDs.length > 0 && result.APIKeyId) {
                 await this.saveScopeAssociations(result.APIKeyId, input.ScopeIDs, user);
             }
@@ -125,7 +146,18 @@ let APIKeyResolver = class APIKeyResolver extends ResolverBase {
             };
         }
     }
+    /**
+     * Revokes an API key, permanently disabling it.
+     *
+     * Once revoked, an API key cannot be reactivated. Users must create a new key.
+     * This uses APIKeyEngine.RevokeAPIKey() for consistency.
+     *
+     * @param apiKeyId The database ID of the API key to revoke
+     * @param ctx The GraphQL context with authenticated user
+     * @returns Success status
+     */
     async RevokeAPIKey(apiKeyId, ctx) {
+        // Check API key scope authorization for API key revocation
         await this.CheckAPIKeyScopeAuthorization('apikey:revoke', apiKeyId, ctx.userPayload);
         try {
             const user = ctx.userPayload.userRecord;
@@ -156,6 +188,12 @@ let APIKeyResolver = class APIKeyResolver extends ResolverBase {
             };
         }
     }
+    /**
+     * Saves scope associations for the newly created API key
+     * @param apiKeyId The ID of the created API key
+     * @param scopeIds Array of scope IDs to associate
+     * @param user The context user
+     */
     async saveScopeAssociations(apiKeyId, scopeIds, user) {
         const md = new Metadata();
         for (const scopeId of scopeIds) {
@@ -167,6 +205,7 @@ let APIKeyResolver = class APIKeyResolver extends ResolverBase {
             }
             catch (error) {
                 LogError(`Error saving scope association for API key ${apiKeyId}, scope ${scopeId}: ${error}`);
+                // Continue with other scopes even if one fails
             }
         }
     }

package/dist/resolvers/APIKeyResolver.js.map

@@ -1 +1 @@
-{"version":3,"file":"APIKeyResolver.js","sourceRoot":"","sources":["../../src/resolvers/APIKeyResolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAMnD,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;IAK1B,KAAK,CAAS;IAMd,WAAW,CAAU;IAMrB,SAAS,CAAQ;IAMjB,QAAQ,CAAY;CACvB,CAAA;AAnBG;IADC,KAAK,EAAE;;gDACM;AAMd;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACnB;AAMrB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAC1B,IAAI;oDAAC;AAMjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACtB;AAvBX,iBAAiB;IAD7B,SAAS,EAAE;GACC,iBAAiB,CAwB7B;;AAOM,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAK3B,OAAO,CAAU;IAOjB,MAAM,CAAU;IAMhB,QAAQ,CAAU;IAMlB,KAAK,CAAU;CAClB,CAAA;AApBG;IADC,KAAK,EAAE;;mDACS;AAOjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACxB;AAMhB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACtB;AAMlB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACzB;AAxBN,kBAAkB;IAD9B,UAAU,EAAE;GACA,kBAAkB,CAyB9B;;AAMM,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;IAK3B,OAAO,CAAU;IAMjB,KAAK,CAAU;CAClB,CAAA;AAPG;IADC,KAAK,EAAE;;mDACS;AAMjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACzB;AAXN,kBAAkB;IAD9B,UAAU,EAAE;GACA,kBAAkB,CAY9B;;AAOM,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,YAAY;IAetC,AAAN,KAAK,CAAC,YAAY,CACA,KAAwB,EAC/B,GAAe;QAGtB,MAAM,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;QAEhF,IAAI,CAAC;YAED,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC;YACxC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,2BAA2B;iBACrC,CAAC;YACN,CAAC;YAGD,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,YAAY,CAC1C;gBACI,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;aAC7B,EACD,IAAI,CACP,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,0BAA0B;iBACpD,CAAC;YACN,CAAC;YAGD,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACjE,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5E,CAAC;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC5B,CAAC;QACN,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,QAAQ,CAAC,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,2BAA2B,KAAK,CAAC,OAAO,EAAE;aACpD,CAAC;QACN,CAAC;IACL,CAAC;IAaK,AAAN,KAAK,CAAC,YAAY,CACG,QAAgB,EAC1B,GAAe;QAGtB,MAAM,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;QAErF,IAAI,CAAC;YACD,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC;YACxC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,2BAA2B;iBACrC,CAAC;YACN,CAAC;YAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE/D,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,4EAA4E;iBACtF,CAAC;YACN,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,QAAQ,CAAC,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,2BAA2B,KAAK,CAAC,OAAO,EAAE;aACpD,CAAC;QACN,CAAC;IACL,CAAC;IAQO,KAAK,CAAC,qBAAqB,CAC/B,QAAgB,EAChB,QAAkB,EAClB,IAAS;QAET,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAE1B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,eAAe,CACrC,oBAAoB,EACpB,IAAI,CACP,CAAC;gBACF,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC7B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;gBAC3B,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC1B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,QAAQ,CAAC,8CAA8C,QAAQ,WAAW,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC;YAEnG,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAA;AApIS;IADL,QAAQ,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;IAE9B,WAAA,GAAG,CAAC,OAAO,CAAC,CAAA;IACZ,WAAA,GAAG,EAAE,CAAA;;qCADe,iBAAiB;;kDAqDzC;AAaK;IADL,QAAQ,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;IAE9B,WAAA,GAAG,CAAC,UAAU,CAAC,CAAA;IACf,WAAA,GAAG,EAAE,CAAA;;;;kDAiCT;AArHQ,cAAc;IAD1B,QAAQ,EAAE;GACE,cAAc,CAmJ1B"}
+{"version":3,"file":"APIKeyResolver.js","sourceRoot":"","sources":["../../src/resolvers/APIKeyResolver.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,sBAAsB,CAAC;AAE1D,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;GAEG;AAEI,IAAM,iBAAiB,GAAvB,MAAM,iBAAiB;CAwB7B,CAAA;AAnBG;IADC,KAAK,EAAE;;gDACM;AAMd;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;sDACnB;AAMrB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;8BAC1B,IAAI;oDAAC;AAMjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;mDACtB;AAvBX,iBAAiB;IAD7B,SAAS,EAAE;GACC,iBAAiB,CAwB7B;;AAED;;;GAGG;AAEI,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;CAyB9B,CAAA;AApBG;IADC,KAAK,EAAE;;mDACS;AAOjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;kDACxB;AAMhB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;oDACtB;AAMlB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACzB;AAxBN,kBAAkB;IAD9B,UAAU,EAAE;GACA,kBAAkB,CAyB9B;;AAED;;GAEG;AAEI,IAAM,kBAAkB,GAAxB,MAAM,kBAAkB;CAY9B,CAAA;AAPG;IADC,KAAK,EAAE;;mDACS;AAMjB;IADC,KAAK,CAAC,GAAG,EAAE,CAAC,MAAM,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;;iDACzB;AAXN,kBAAkB;IAD9B,UAAU,EAAE;GACA,kBAAkB,CAY9B;;AAED;;;GAGG;AAEI,IAAM,cAAc,GAApB,MAAM,cAAe,SAAQ,YAAY;IAC5C;;;;;;;;;;;;OAYG;IAEG,AAAN,KAAK,CAAC,YAAY,CACA,KAAwB,EAC/B,GAAe;QAEtB,yDAAyD;QACzD,MAAM,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;QAEhF,IAAI,CAAC;YACD,6BAA6B;YAC7B,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC;YACxC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,2BAA2B;iBACrC,CAAC;YACN,CAAC;YAED,wEAAwE;YACxE,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,YAAY,CAC1C;gBACI,MAAM,EAAE,IAAI,CAAC,EAAE;gBACf,KAAK,EAAE,KAAK,CAAC,KAAK;gBAClB,WAAW,EAAE,KAAK,CAAC,WAAW;gBAC9B,SAAS,EAAE,KAAK,CAAC,SAAS;aAC7B,EACD,IAAI,CACP,CAAC;YAEF,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBAClB,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,0BAA0B;iBACpD,CAAC;YACN,CAAC;YAED,sCAAsC;YACtC,IAAI,KAAK,CAAC,QAAQ,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACjE,MAAM,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAC5E,CAAC;YAED,OAAO;gBACH,OAAO,EAAE,IAAI;gBACb,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC5B,CAAC;QACN,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,QAAQ,CAAC,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,2BAA2B,KAAK,CAAC,OAAO,EAAE;aACpD,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;;;;;OASG;IAEG,AAAN,KAAK,CAAC,YAAY,CACG,QAAgB,EAC1B,GAAe;QAEtB,2DAA2D;QAC3D,MAAM,IAAI,CAAC,6BAA6B,CAAC,eAAe,EAAE,QAAQ,EAAE,GAAG,CAAC,WAAW,CAAC,CAAC;QAErF,IAAI,CAAC;YACD,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,UAAU,CAAC;YACxC,IAAI,CAAC,IAAI,EAAE,CAAC;gBACR,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,2BAA2B;iBACrC,CAAC;YACN,CAAC;YAED,MAAM,YAAY,GAAG,eAAe,EAAE,CAAC;YACvC,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,YAAY,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;YAE/D,IAAI,MAAM,EAAE,CAAC;gBACT,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACJ,OAAO;oBACH,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,4EAA4E;iBACtF,CAAC;YACN,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,KAAK,GAAG,CAAU,CAAC;YACzB,QAAQ,CAAC,mCAAmC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;YAC7D,OAAO;gBACH,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,2BAA2B,KAAK,CAAC,OAAO,EAAE;aACpD,CAAC;QACN,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,KAAK,CAAC,qBAAqB,CAC/B,QAAgB,EAChB,QAAkB,EAClB,IAAS;QAET,MAAM,EAAE,GAAG,IAAI,QAAQ,EAAE,CAAC;QAE1B,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE,CAAC;YAC7B,IAAI,CAAC;gBACD,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAC,eAAe,CACrC,oBAAoB,EACpB,IAAI,CACP,CAAC;gBACF,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC;gBAC7B,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC;gBAC3B,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;YAC1B,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACb,QAAQ,CAAC,8CAA8C,QAAQ,WAAW,OAAO,KAAK,KAAK,EAAE,CAAC,CAAC;gBAC/F,+CAA+C;YACnD,CAAC;QACL,CAAC;IACL,CAAC;CACJ,CAAA;AApIS;IADL,QAAQ,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;IAE9B,WAAA,GAAG,CAAC,OAAO,CAAC,CAAA;IACZ,WAAA,GAAG,EAAE,CAAA;;qCADe,iBAAiB;;kDAqDzC;AAaK;IADL,QAAQ,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC;IAE9B,WAAA,GAAG,CAAC,UAAU,CAAC,CAAA;IACf,WAAA,GAAG,EAAE,CAAA;;;;kDAiCT;AArHQ,cAAc;IAD1B,QAAQ,EAAE;GACE,cAAc,CAmJ1B"}

package/dist/resolvers/ActionResolver.d.ts

@@ -1,50 +1,239 @@
 import { KeyValuePairInput } from "../generic/KeyValuePairInput.js";
 import { AppContext } from "../types.js";
 import { ResolverBase } from "../generic/ResolverBase.js";
+/**
+ * Input type for action parameters
+ * Used to pass parameters to actions when invoking them
+ */
 export declare class ActionParamInput {
+    /**
+     * The name of the parameter
+     */
     Name: string;
+    /**
+     * The value of the parameter
+     * Complex objects should be serialized to JSON strings
+     */
     Value: string;
+    /**
+     * The data type of the parameter
+     * Used for type conversion on the server
+     */
     Type: string;
 }
+/**
+ * Input type for running an action
+ */
 export declare class RunActionInput {
+    /**
+     * The ID of the action to run
+     */
     ActionID: string;
+    /**
+     * Parameters to pass to the action
+     */
     Params?: ActionParamInput[];
+    /**
+     * Whether to skip logging the action execution
+     * Defaults to false
+     */
     SkipActionLog?: boolean;
 }
+/**
+ * Represents a collection of key-value pairs that make up a composite key
+ * Used for both primary keys and foreign keys
+ */
 export declare class CompositeKeyInput {
+    /**
+     * The collection of key-value pairs that make up the composite key
+     */
     KeyValuePairs: KeyValuePairInput[];
 }
+/**
+ * Input type for running entity actions
+ */
 export declare class EntityActionInput {
+    /**
+     * The ID of the entity action to run
+     */
     EntityActionID: string;
+    /**
+     * The type of invocation (SingleRecord, View, List, etc.)
+     */
     InvocationType: string;
+    /**
+     * The name of the entity
+     * This is the preferred way to identify an entity as it's more human-readable than EntityID
+     */
     EntityName?: string;
+    /**
+     * The ID of the entity
+     * Use EntityName instead when possible for better code readability
+     * @deprecated Use EntityName instead when possible
+     */
     EntityID?: string;
+    /**
+     * The primary key of the entity record to act on
+     * This is used for SingleRecord invocation types
+     */
     PrimaryKey?: CompositeKeyInput;
+    /**
+     * The ID of the list to operate on
+     * This is used for List invocation types
+     */
     ListID?: string;
+    /**
+     * The ID of the view to operate on
+     * This is used for View invocation types
+     */
     ViewID?: string;
+    /**
+     * Additional parameters to pass to the action
+     */
     Params?: ActionParamInput[];
 }
+/**
+ * Output type for action results
+ * Used to return results from actions to clients
+ */
 export declare class ActionResultOutput {
+    /**
+     * Whether the action was executed successfully
+     */
     Success: boolean;
+    /**
+     * Optional message describing the result of the action
+     */
     Message?: string;
+    /**
+     * Optional result code from the action
+     */
     ResultCode?: string;
+    /**
+     * Optional result data from the action
+     * Complex objects are serialized to JSON strings
+     */
     ResultData?: string;
 }
+/**
+ * Resolver for action-related GraphQL operations
+ * Handles running actions and entity actions through GraphQL
+ */
 export declare class ActionResolver extends ResolverBase {
+    /**
+     * Mutation for running an action
+     * @param input The input parameters for running the action
+     * @param ctx The GraphQL context containing user authentication information
+     * @returns The result of running the action
+     */
     RunAction(input: RunActionInput, ctx: AppContext): Promise<ActionResultOutput>;
+    /**
+     * Finds an action by its ID
+     * @param actionID The ID of the action to find
+     * @returns The action
+     * @throws Error if the action is not found
+     * @private
+     */
     private findActionById;
+    /**
+     * Parses action parameters from the input
+     * @param inputParams The input parameters
+     * @returns The parsed parameters
+     * @private
+     */
     private parseActionParameters;
+    /**
+     * Executes an action
+     * @param action The action to execute
+     * @param user The user context
+     * @param params The action parameters
+     * @param skipActionLog Whether to skip action logging
+     * @returns The action result
+     * @private
+     */
     private executeAction;
+    /**
+     * Creates an action result from the execution result
+     * @param result The execution result
+     * @returns The formatted action result
+     * @private
+     */
     private createActionResult;
+    /**
+     * Handles errors in the action resolver
+     * @param e The error
+     * @returns An error result
+     * @private
+     */
     private handleActionError;
+    /**
+     * Mutation for running an entity action
+     * @param input The input parameters for running the entity action
+     * @param ctx The GraphQL context containing user authentication information
+     * @returns The result of running the entity action
+     */
     RunEntityAction(input: EntityActionInput, ctx: AppContext): Promise<ActionResultOutput>;
+    /**
+     * Gets an entity action by ID
+     * @param actionID The ID of the entity action
+     * @returns The entity action
+     * @throws Error if entity action is not found
+     * @private
+     */
     private getEntityAction;
+    /**
+     * Creates the base parameters for the entity action
+     * @param entityAction The entity action
+     * @param invocationTypeName The invocation type name
+     * @param user The authenticated user
+     * @returns The base parameters
+     * @private
+     */
     private createBaseParams;
+    /**
+     * Adds the entity object to the parameters
+     * @param params The parameters to add to
+     * @param input The input parameters
+     * @param user The authenticated user
+     * @private
+     */
     private addEntityObject;
+    /**
+     * Creates a composite key from the input
+     * @param entity The entity information
+     * @param primaryKey The primary key input
+     * @returns The composite key
+     * @private
+     */
     private createCompositeKey;
+    /**
+     * Converts a value to the proper type based on the field information
+     * @param value The value to convert
+     * @param field The field information
+     * @returns The converted value
+     * @private
+     */
     private convertValueToProperType;
+    /**
+     * Adds optional parameters to the entity action parameters
+     * @param params The parameters to add to
+     * @param input The input parameters
+     * @private
+     */
     private addOptionalParams;
+    /**
+     * Converts a parameter value to the proper format
+     * @param p The parameter to convert
+     * @returns The converted parameter
+     * @private
+     */
     private convertParameterValue;
+    /**
+     * Handles errors in the entity action resolver
+     * @param e The error
+     * @returns An error result
+     * @private
+     */
     private handleError;
 }
 //# sourceMappingURL=ActionResolver.d.ts.map

package/dist/resolvers/ActionResolver.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionResolver.d.ts","sourceRoot":"","sources":["../../src/resolvers/ActionResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,UAAU,EAAgB,MAAM,aAAa,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAM1D,qBACa,gBAAgB;IAK3B,IAAI,EAAE,MAAM,CAAC;IAOb,KAAK,EAAE,MAAM,CAAC;IAOd,IAAI,EAAE,MAAM,CAAC;CACd;AAKD,qBACa,cAAc;IAKzB,QAAQ,EAAE,MAAM,CAAC;IAMjB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAO5B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAMD,qBACa,iBAAiB;IAK5B,aAAa,EAAE,iBAAiB,EAAE,CAAC;CACpC;AAKD,qBACa,iBAAiB;IAK5B,cAAc,EAAE,MAAM,CAAC;IAMvB,cAAc,EAAE,MAAM,CAAC;IAOvB,UAAU,CAAC,EAAE,MAAM,CAAC;IAQpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAOlB,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAO/B,MAAM,CAAC,EAAE,MAAM,CAAC;IAOhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAMhB,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAMD,qBACa,kBAAkB;IAK7B,OAAO,EAAE,OAAO,CAAC;IAMjB,OAAO,CAAC,EAAE,MAAM,CAAC;IAMjB,UAAU,CAAC,EAAE,MAAM,CAAC;IAOpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAMD,qBACa,cAAe,SAAQ,YAAY;IAQxC,SAAS,CACC,KAAK,EAAE,cAAc,EAC5B,GAAG,EAAE,UAAU,GACrB,OAAO,CAAC,kBAAkB,CAAC;IAqC9B,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,qBAAqB;YAoCf,aAAa;IAqB3B,OAAO,CAAC,kBAAkB;IAkB1B,OAAO,CAAC,iBAAiB;IAgBnB,eAAe,CACL,KAAK,EAAE,iBAAiB,EAC/B,GAAG,EAAE,UAAU,GACrB,OAAO,CAAC,kBAAkB,CAAC;IAgD9B,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,gBAAgB;YAgBV,eAAe;IAmC7B,OAAO,CAAC,kBAAkB;IA8B1B,OAAO,CAAC,wBAAwB;IAgBhC,OAAO,CAAC,iBAAiB;IAuBzB,OAAO,CAAC,qBAAqB;IA2B7B,OAAO,CAAC,WAAW;CAQpB"}
+{"version":3,"file":"ActionResolver.d.ts","sourceRoot":"","sources":["../../src/resolvers/ActionResolver.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,UAAU,EAAgB,MAAM,aAAa,CAAC;AAGvD,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAE1D;;;GAGG;AACH,qBACa,gBAAgB;IAC3B;;OAEG;IAEH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IAEH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IAEH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;GAEG;AACH,qBACa,cAAc;IACzB;;OAEG;IAEH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE5B;;;OAGG;IAEH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;;GAGG;AACH,qBACa,iBAAiB;IAC5B;;OAEG;IAEH,aAAa,EAAE,iBAAiB,EAAE,CAAC;CACpC;AAED;;GAEG;AACH,qBACa,iBAAiB;IAC5B;;OAEG;IAEH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IAEH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IAEH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IAEH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IAEH,UAAU,CAAC,EAAE,iBAAiB,CAAC;IAE/B;;;OAGG;IAEH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IAEH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IAEH,MAAM,CAAC,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED;;;GAGG;AACH,qBACa,kBAAkB;IAC7B;;OAEG;IAEH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IAEH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IAEH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IAEH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;;GAGG;AACH,qBACa,cAAe,SAAQ,YAAY;IAC9C;;;;;OAKG;IAEG,SAAS,CACC,KAAK,EAAE,cAAc,EAC5B,GAAG,EAAE,UAAU,GACrB,OAAO,CAAC,kBAAkB,CAAC;IA8B9B;;;;;;OAMG;IACH,OAAO,CAAC,cAAc;IAQtB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IA2B7B;;;;;;;;OAQG;YACW,aAAa;IAe3B;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;IAY1B;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IASzB;;;;;OAKG;IAEG,eAAe,CACL,KAAK,EAAE,iBAAiB,EAC/B,GAAG,EAAE,UAAU,GACrB,OAAO,CAAC,kBAAkB,CAAC;IAyC9B;;;;;;OAMG;IACH,OAAO,CAAC,eAAe;IAQvB;;;;;;;OAOG;IACH,OAAO,CAAC,gBAAgB;IASxB;;;;;;OAMG;YACW,eAAe;IA4B7B;;;;;;OAMG;IACH,OAAO,CAAC,kBAAkB;IAuB1B;;;;;;OAMG;IACH,OAAO,CAAC,wBAAwB;IAUhC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAqB7B;;;;;OAKG;IACH,OAAO,CAAC,WAAW;CAQpB"}