@quadient/evolve-scripting-api - npm Package Compare versions

Comparing version 0.0.10 to 0.0.11

evolve-scripting-api.d.ts

 export {};
 
+interface BundledGenerateCommon {
+    template: string;
+    inputPaths?: InputPath[];
+    outputModule?: string;
+    metadataPath?: string;
+    customParameters?: CustomParameter[];
+    documentLayoutPath?: string;
+    documentLayoutConfig?: string;
+    productionConfiguration?: string;
+    correlationId?: string;
+}
+
+type BundledGeneratePrint = {
+    channel: "Print";
+    outputType: BundledGenerateOutputType;
+    outputPath: string;
+} & BundledGenerateCommon;
+
+type BundledGenerateEmail = {
+    channel: "Email";
+    attachments: Attachment[];
+} & BundledGenerateCommon;
+
 declare global {
@@ -9,2 +32,10 @@ interface Context {
 
+        read(resource: string): Promise<string>;
+
+        readAsBase64(resource: string): Promise<string>;
+
+        write(resource: string, content: string): Promise<void>;
+
+        copy(source: string, target: string, targetIsDir?: boolean): Promise<void>;
+
         openRead(resource: string): Promise<ReadableStream<Uint8Array>>;
@@ -14,5 +45,5 @@
 
-        openWrite(resource: string): Promise<WritableStream<Uint8Array | ArrayBuffer | ArrayBufferView>>;
+        openWrite(resource: string, options?: ResponseOptions): Promise<WritableStream<Uint8Array | ArrayBuffer | ArrayBufferView>>;
 
-        openWriteText(resource: string, encoding?: string): Promise<WritableStream<string>>;
+        openWriteText(resource: string, encoding?: string, options?: ResponseOptions): Promise<WritableStream<string>>;
 
@@ -46,5 +77,15 @@ getFile(resource: string): IFile;
     type Output = {
-        [id: string]: number | string | BundledGenerateOutput | BundledGenerateOutput[] | PipelineTerminateOutput;
+        [id: string]:
+            | number
+            | string
+            | BundledGenerateOutput
+            | BundledGenerateOutput[]
+            | BundledGenerateOutputV2
+            | BundledGenerateOutputV2[]
+            | PipelineTerminateOutput;
     };
 
+    /**
+     * @deprecated Please use {@link BundledGenerateOutputV2} instead.
+     */
     interface BundledGenerateOutput {
@@ -63,2 +104,9 @@ template: string;
 
+    type BundledGenerateOutputV2 = BundledGeneratePrint | BundledGenerateEmail;
+
+    interface Attachment {
+        attachmentName: string;
+        path: string;
+    }
+
     interface InputPath {
@@ -102,2 +150,7 @@ name: string;
 
+    interface ResponseOptions {
+        status?: number;
+        headers?: { [key: string]: string };
+    }
+
     //description
@@ -114,3 +167,3 @@
 
-    interface ArrayInputParameterDescription extends InputParameterDescription {
+    interface ArrayInputParameterDescription<T> extends InputParameterDescription {
         type: "Array";
@@ -120,3 +173,3 @@ minCount?: number;
         uniqueValues?: boolean;
-        defaultValue?: string;
+        defaultValue?: T[];
     }
@@ -154,2 +207,9 @@
 
+    interface UnitLengthParameterDescription extends InputParameterDescription {
+        type: "Unit";
+        unitType: "Length";
+        defaultValue?: number;
+        isDecimal: boolean;
+    }
+
     interface SelectionInputParameterDescription extends InputParameterDescription {
@@ -161,3 +221,3 @@ type: "Selection";
 
-    interface ArraySelectionInputParameterDescription extends ArrayInputParameterDescription {
+    interface ArraySelectionInputParameterDescription extends ArrayInputParameterDescription<string> {
         itemType: "Selection";
@@ -168,3 +228,3 @@ options: string[];
 
-    interface ArrayNumberInputParameterDescription extends ArrayInputParameterDescription {
+    interface ArrayNumberInputParameterDescription extends ArrayInputParameterDescription<number> {
         itemType: "Number";
@@ -174,3 +234,3 @@ newItemDefaultValue?: number;
 
-    interface ArrayStringInputParameterDescription extends ArrayInputParameterDescription {
+    interface ArrayStringInputParameterDescription extends ArrayInputParameterDescription<string> {
         itemType: "String";
@@ -198,6 +258,14 @@ allowsEmptyValue?: boolean;
     interface ScriptDescription {
-        readonly displayName: string;
+        /** @deprecated
+         * Deprecated functionality that is preserved only for backwards compatibility.
+         * It is ignored starting with the 22.10 version of Quadient Cloud.
+         * */
+        readonly displayName?: string;
+        /** @deprecated
+         * Deprecated functionality that is preserved only for backwards compatibility.
+         * It is ignored starting with the 22.10 version of Quadient Cloud.
+         * */
+        readonly category?: string;
         readonly description: string;
         readonly icon?: string;
-        readonly category?: string;
         readonly input?: (
@@ -231,3 +299,4 @@ | StringParameterDescription
         | "Array"
-        | "PipelineTerminate";
+        | "PipelineTerminate"
+        | "Unit";
 
@@ -346,2 +415,22 @@ //services
     function createGuid(): string;
+
+    /**
+     * This LengthUnitSpan API interface represents a value of input parameter with the following values.
+     * ```
+     *      id: "unitExample",
+     *      displayName: "Unit example",
+     *      description: "Unit example",
+     *      type: "Unit",
+     *      unitType: "Length"
+     * ```
+     * Usage example:
+     * ```
+     * const lengthInput = context.parameters.unitExample as LengthUnitSpan;
+     * console.log(lengthInput.toMeters());
+     * ```
+     */
+    interface LengthUnitSpan {
+        toMeters(): number;
+        toInches(): number;
+    }
 }

package.json

 {
   "name": "@quadient/evolve-scripting-api",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "description": "Api for scripting.",
@@ -5,0 +5,0 @@ "main": "",

No alert changes

Improved metrics

Total package byte prevSize

34721

increased by8.13%

Lines of code

843

increased by10.05%

No dependency changes