Class CreateDocumentAction

Creates a new in-progress document and returns a handle for incremental building. The handle is used by subsequent actions (Add Document Content, Preview Document, Modify Document Section, Finalize Document) to build the document piece by piece.

Parameters:

DocumentType (required): 'pdf', 'docx', or 'xlsx'
FileName (optional): suggested filename (e.g., 'quarterly-report.docx')
Options (optional, JSON): type-specific options (page size, margins, fonts, etc.)

Output:

Handle: UUID for the in-progress document

Hierarchy

BaseFileHandlerAction
- CreateDocumentAction

Index

Constructors

constructor

new CreateDocumentAction(): CreateDocumentAction
Returns CreateDocumentAction
Inherited from BaseFileHandlerAction.constructor

Properties

`Static` `Readonly`AuthorizesCaller

AuthorizesCaller: boolean

True when the action authorizes its caller itself, so a public entry point such as the RunAction mutation may run it for an authenticated user without an MJ: Action Authorizations link. Set it only on an action that either checks an authorization the caller must hold, or reads and writes only with the caller's own permissions. Leave it false for an action that acts with more authority than its caller, or that reaches data or sends messages the caller chooses but could not otherwise reach.

The engine reads the marker only from the class that runs, never from its parent classes. A subclass that overrides a marked action must declare the marker again.

Methods

`Protected`getBooleanParam

getBooleanParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: boolean,
): boolean
Get boolean parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: boolean = false
Returns boolean
Inherited from BaseFileHandlerAction.getBooleanParam
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:251

`Protected`getFileContent

getFileContent(
    params: RunActionParams,
    dataParamName: string,
    fileParamName?: string,
    urlParamName?: string,
): Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>
Get file content from various sources based on parameters Priority: FileID > FileURL > Data parameter
Parameters
- params: RunActionParams
  Action parameters
- dataParamName: string
  Name of the parameter containing direct data
- fileParamName: string = 'FileID'
  Name of the parameter containing file ID (default: 'FileID')
- urlParamName: string = 'FileURL'
  Name of the parameter containing file URL (default: 'FileURL')
Returns Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>
Object with content and metadata
Inherited from BaseFileHandlerAction.getFileContent
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:25

`Protected`getNumericParam

getNumericParam(
    params: RunActionParams,
    paramName: string,
    defaultValue?: number,
): number
Get numeric parameter value with default
Parameters
- params: RunActionParams
- paramName: string
- defaultValue: number = 0
Returns number
Inherited from BaseFileHandlerAction.getNumericParam
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:260

`Protected`getParamValue

getParamValue(params: RunActionParams, paramName: string): any
Extract parameter value by name (case-insensitive)
Parameters
- params: RunActionParams
- paramName: string
Returns any
Inherited from BaseFileHandlerAction.getParamValue
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:243

`Protected`InternalRunAction

InternalRunAction(params: RunActionParams): Promise<ActionResultSimple>
Internal method that must be implemented by derived action classes. This is where the actual action logic should be implemented.
Parameters
- params: RunActionParams
  The action execution parameters including typed context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Overrides BaseFileHandlerAction.InternalRunAction
- Defined in Actions/CoreActions/src/custom/files/create-document.action.ts:24

Run

Run(params: RunActionParams): Promise<ActionResultSimple>
Executes the action with the provided parameters.
Parameters
- params: RunActionParams
  The action execution parameters including context
Returns Promise<ActionResultSimple>
Promise resolving to the action result
Inherited from BaseFileHandlerAction.Run
- Defined in Actions/Engine/dist/generic/BaseAction.d.ts:49

`Protected`saveToMJStorage

saveToMJStorage(
    content: string | Buffer,
    fileName: string,
    mimeType: string,
    params: RunActionParams,
    storageAccountName?: string,
    storagePath?: string,
): Promise<string>
Save file to MJ Storage. Uploads the content to a FileStorageAccount and creates the corresponding MJ: Files entity record.
Parameters
- content: string | Buffer
  File content as string or Buffer
- fileName: string
  Name for the file
- mimeType: string
  MIME type of the file
- params: RunActionParams
  Action parameters (for contextUser)
- OptionalstorageAccountName: string
  Optional: name of the storage account to use (falls back to first active)
- OptionalstoragePath: string
  Optional: custom storage path prefix (falls back to artifacts/{date}/{uuid}/)
Returns Promise<string>
The ID of the newly created MJ: Files record
Inherited from BaseFileHandlerAction.saveToMJStorage
- Defined in Actions/CoreActions/src/custom/utilities/base-file-handler.ts:160

Class CreateDocumentAction

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CreateDocumentAction

Properties

`Static` `Readonly`AuthorizesCaller

Methods

`Protected`getBooleanParam

Parameters

Returns boolean

`Protected`getFileContent

Parameters

Returns Promise<
    {
        content: string
        | Buffer;
        fileName?: string;
        mimeType?: string;
        source: "url" | "storage" | "direct";
    },
>

`Protected`getNumericParam

Parameters

Returns number

`Protected`getParamValue

Parameters

Returns any

`Protected`InternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

`Protected`saveToMJStorage

Parameters

Returns Promise<string>

Settings

On This Page

Class CreateDocumentAction

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns CreateDocumentAction

Properties

Static ReadonlyAuthorizesCaller

Methods

ProtectedgetBooleanParam

Parameters

Returns boolean

ProtectedgetFileContent

Parameters

Returns Promise< { content: string | Buffer; fileName?: string; mimeType?: string; source: "url" | "storage" | "direct"; },>

ProtectedgetNumericParam

Parameters

Returns number

ProtectedgetParamValue

Parameters

Returns any

ProtectedInternalRunAction

Parameters

Returns Promise<ActionResultSimple>

Run

Parameters

Returns Promise<ActionResultSimple>

ProtectedsaveToMJStorage

Parameters

Returns Promise<string>

Settings

On This Page

`Static` `Readonly`AuthorizesCaller

`Protected`getBooleanParam

`Protected`getFileContent

Returns Promise<
{
content: string
| Buffer;
fileName?: string;
mimeType?: string;
source: "url" | "storage" | "direct";
},
>

`Protected`getNumericParam

`Protected`getParamValue

`Protected`InternalRunAction

`Protected`saveToMJStorage