@doflo/flow-interfaces - npm Package Compare versions

Comparing version 1.8.2 to 1.9.0

dist/schema/doflo/v1.0.0/definitions/credentialSchema.json

 {
-    "$schema": "http://json-schema.org/draft-07/schema#",
-    "type": "object",
-    "title": "CredentialSchema",
-    "properties": {
-
-      "hidden":{ "type":"boolean" },
-
-      "extends": {
-        "type":"array",
-        "items": {
-          "type":"string"
-        },
-        "examples": [["oAuth2"],["BasicAuthentication"]]
-     },
-      "properties":{
-        "type":"object",
-        "additionalProperties":{
-          "type":"object",
-          "title": "CredentialPropertySchema",
-          "properties": {
-            "required":{
-              "type":"boolean"
-            },
-            "type":{
-              "type":"string", 
-              "title": "SemanticTypes",
-              "enum": ["boolean","collection", "color", "dateTime","fixedCollection", "hidden", "json","multiOptions", "number", "options", "string"]
-            },
-            "default":{"type":"string"},
-            "description":{"type":"string"},
-            "title":{"type":"string"}
-          }
-        }
-      }
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "title": "CredentialSchema",
+  "properties": {
+    "title": {
+      "type": "string",
+      "description": "when present title is used in place of name as long as a localization file is not present"
     },
-    "additionalProperties": false
+    "hidden": { "type": "boolean" },
+    "extends": {
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "examples": [["oAuth2"], ["BasicAuthentication"]]
+    },
+    "properties": { "type": "array", "items": { "$ref": "./elementProperties.json" } }
+  },
+  "additionalProperties": false
 }

dist/schema/doflo/v1.0.0/definitions/elementActionSchema.json

@@ -39,5 +39,7 @@ {
   "properties": {
-    "notes": {}
+    "notes": {},
+    "description": { "$ref": "./elementInfo.json" }
   },
+  "required": ["description"],
   "additionalProperties": false
 }

dist/schema/doflo/v1.0.0/definitions/elementSchema.json

@@ -11,6 +11,8 @@ {
     },
+    "description": { "$ref": "./elementInfo.json" },
     "notes": {
       "$ref": "./developerNotes.json"
     }
-  }
-}
+  },
+  "required": ["description"]
+}

dist/schema/doflo/v1.0.0/definitions/elementSignalSchema.json

@@ -13,3 +13,2 @@ {
   "properties": {
-    
     "credentialTypes":
@@ -16,0 +15,0 @@ {

dist/schema/doflo/v1.0.0/definitions/webhookSchema.json

@@ -21,2 +21,10 @@ {
       },
+      "path": {
+        "type": "string",
+        "description": "This is the path of the webhook, if specified it must be unique within your namespace",
+        "examples": [
+          "/path",
+          "/path/:id"
+        ]
+      },
       "postProcess":
@@ -23,0 +31,0 @@ {

dist/schema/doflo/v1.0.0/doflo.json

@@ -97,3 +97,3 @@ {
 			}
-		},
+		}, 
 		"element-event-schema": {
@@ -115,7 +115,7 @@ "allOf": [
 			"additionalProperties": false
-		},
+		},  
 		"configuration-schema": {
 			"description": "Definition of a doFlo configuration",
 			"title": "doFlo Element Configuration Options"
-		},
+		}, 
 		"serverGenerated-script-dependency-schema": {
@@ -122,0 +122,0 @@ "type": "object",

dist/types/index.d.ts

 /// <reference types="node" />
 import type * as http from 'http';
 import type { Struct } from 'google-protobuf/google/protobuf/struct_pb';
-import type { AuthContextInterface, ExecutionResponseInterface, ElementActionSchema, HTTPStatus, ElementSignalSchema, WebhooksSchema } from './schemaTypes';
+import type { AuthContextInterface, ExecutionResponseInterface, ElementActionSchema, ElementPropertyOption, HTTPStatus, ElementSignalSchema, WebhooksSchema } from './schemaTypes';
 import type { Logger } from './logger';
@@ -11,2 +11,24 @@ export declare type ExecutionResponseOrVoid = ExecutionResponseInterface | void;
 }
+export interface IPropertyOptionsLoadFunctions {
+    getElement(): IElement;
+    getEndpoint: (key: string) => string | undefined;
+    extensions: {
+        [key: string]: (...args: any[]) => any;
+    };
+}
+export interface IBridgeSetupFunction extends ISetupFunction {
+}
+export interface ISignalSetupFunction extends ISetupFunction {
+}
+export interface IActionSetupFunction extends ISetupFunction {
+}
+export interface IWebhookSetupFunction extends ISetupFunction {
+}
+export interface ISetupFunction {
+    getElement(): IElement;
+    getEndpoint: (key: string) => string | undefined;
+    extensions: {
+        [key: string]: (...args: any[]) => any;
+    };
+}
 export interface IResponse {
@@ -44,2 +66,22 @@ /**
     webhook(context: ExecutionContext): IWebHookResponses;
+    load: {
+        [key: string]: (this: IPropertyOptionsLoadFunctions) => Promise<ElementPropertyOption[]>;
+    };
+    setup: {
+        bridges: {
+            [key: string]: ((this: IBridgeSetupFunction) => Promise<boolean>) | undefined;
+        };
+        signals: {
+            [key: string]: ((this: ISignalSetupFunction) => Promise<boolean>) | undefined;
+        };
+        actions: {
+            [key: string]: ((this: IActionSetupFunction) => Promise<boolean>) | undefined;
+        };
+        webhooks: {
+            [key: string]: ((this: IWebhookSetupFunction) => Promise<boolean>) | undefined;
+            check?: (this: IWebhookSetupFunction) => Promise<boolean>;
+            create?: (this: IWebhookSetupFunction) => Promise<boolean>;
+            destroy?: (this: IWebhookSetupFunction) => Promise<boolean>;
+        };
+    };
 }
@@ -46,0 +88,0 @@ export interface IWebhookContext {

dist/types/schemaTypes.d.ts

@@ -47,4 +47,153 @@ /**
 export interface ElementActionSchema {
+    description: ElementInfo;
     notes?: string;
 }
+export interface ElementInfo {
+    credentials?: any;
+    defaults: {
+        [key: string]: Array<boolean | number | {
+            [key: string]: any;
+        } | null | string> | boolean | number | {
+            [key: string]: any;
+        } | null | string;
+    };
+    /**
+     * when present description is used, if a localization file is present name is used as the
+     * key for a localized description
+     */
+    description: string;
+    group: string[];
+    icon?: string;
+    inputNames?: string[];
+    inputs: string[];
+    maxNodes?: number;
+    /**
+     * when a localization file is present name will be used as the key
+     */
+    name?: string;
+    outputNames?: string[];
+    outputs: string[];
+    polling?: boolean;
+    properties: ElementProperties[];
+    subtitle?: string;
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
+    title?: string;
+    version: string;
+}
+export interface ElementProperties {
+    default?: Array<boolean | number | {
+        [key: string]: Array<boolean | number | {
+            [key: string]: any;
+        } | null | string> | boolean | number | {
+            [key: string]: any;
+        } | null | string;
+    } | null | string> | boolean | number | {
+        [key: string]: Array<boolean | number | {
+            [key: string]: any;
+        } | null | string> | boolean | number | {
+            [key: string]: any;
+        } | null | string;
+    } | null | string;
+    /**
+     * when present description is used, if a localization file is present name is used as the
+     * key for a localized description
+     */
+    description?: string;
+    displayOptions?: DisplayOptions;
+    isElementSetting?: boolean;
+    /**
+     * when a localization file is present name will be used as the key
+     */
+    name?: string;
+    noDataExpression?: boolean;
+    options?: Option[];
+    placeholder?: string;
+    required?: boolean;
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
+    title?: string;
+    type?: SemanticTypes;
+    typeOptions?: ElementPropertyTypeOptions;
+}
+export interface DisplayOptions {
+    hide?: {
+        [key: string]: Array<boolean | number | null | string>;
+    };
+    show?: {
+        [key: string]: Array<boolean | number | null | string>;
+    };
+}
+export interface Option {
+    /**
+     * when present description is used, if a localization file is present name is used as the
+     * key for a localized description
+     */
+    description?: string;
+    /**
+     * when a localization file is present name will be used as the key
+     */
+    name?: string;
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
+    title?: string;
+    type?: SemanticTypes;
+    typeOptions?: any;
+    value?: any;
+    default?: Array<boolean | number | {
+        [key: string]: Array<boolean | number | {
+            [key: string]: any;
+        } | null | string> | boolean | number | {
+            [key: string]: any;
+        } | null | string;
+    } | null | string> | boolean | number | {
+        [key: string]: Array<boolean | number | {
+            [key: string]: any;
+        } | null | string> | boolean | number | {
+            [key: string]: any;
+        } | null | string;
+    } | null | string;
+    displayOptions?: DisplayOptions;
+    isElementSetting?: boolean;
+    noDataExpression?: boolean;
+    options?: Option[];
+    placeholder?: string;
+    required?: boolean;
+}
+export declare enum SemanticTypes {
+    Boolean = "boolean",
+    Collection = "collection",
+    Color = "color",
+    DateTime = "dateTime",
+    FixedCollection = "fixedCollection",
+    Hidden = "hidden",
+    JSON = "json",
+    MultiOptions = "multiOptions",
+    Number = "number",
+    Options = "options",
+    String = "string"
+}
+export interface ElementPropertyTypeOptions {
+    additionalProperties?: string[] | boolean | number | null | string;
+    alwaysOpenEditWindow?: boolean;
+    editor?: EditorTypes;
+    loadOptionsDependsOn?: string[];
+    loadOptionsMethod?: string;
+    maxValue?: number;
+    minValue?: number;
+    multipleValueButtonText?: string;
+    multipleValues?: boolean;
+    numberPrecision?: number;
+    numberStepSize?: number;
+    password?: boolean;
+    rows?: number;
+    showAlpha?: boolean;
+    sortable?: boolean;
+}
+export declare enum EditorTypes {
+    Code = "code"
+}
 /**
@@ -91,26 +240,8 @@ * Definition of a doFlo bridge application
     hidden?: boolean;
-    properties?: {
-        [key: string]: CredentialPropertySchema;
-    };
-}
-export interface CredentialPropertySchema {
-    default?: string;
-    description?: string;
-    required?: boolean;
+    properties?: ElementProperties[];
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
     title?: string;
-    type?: SemanticTypes;
 }
-export declare enum SemanticTypes {
-    Boolean = "boolean",
-    Collection = "collection",
-    Color = "color",
-    DateTime = "dateTime",
-    FixedCollection = "fixedCollection",
-    Hidden = "hidden",
-    JSON = "json",
-    MultiOptions = "multiOptions",
-    Number = "number",
-    Options = "options",
-    String = "string"
-}
 /**
@@ -180,2 +311,6 @@ * Informs the element loader which language to assume the default text queues (contained in
     /**
+     * This is the path of the webhook, if specified it must be unique within your namespace
+     */
+    path?: string;
+    /**
      * Named method to handled webhooks that are automatically deferred
@@ -486,2 +621,31 @@ */
 }
+export interface ElementPropertyCollection {
+    /**
+     * when a localization file is present name will be used as the key
+     */
+    name: string;
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
+    title?: string;
+    value: ElementProperties[];
+}
+export interface ElementPropertyOption {
+    /**
+     * when present description is used, if a localization file is present name is used as the
+     * key for a localized description
+     */
+    description?: string;
+    /**
+     * when a localization file is present name will be used as the key
+     */
+    name: string;
+    /**
+     * when present title is used in place of name as long as a localization file is not present
+     */
+    title?: string;
+    type?: SemanticTypes;
+    typeOptions?: any;
+    value: any;
+}
 /**
@@ -491,2 +655,3 @@ * Base Element Schema for for doFlo Elements
 export interface ElementSchema {
+    description: ElementInfo;
     notes?: string;
@@ -493,0 +658,0 @@ /**

dist/types/schemaTypes.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ElementTypes = exports.Protocol = exports.TagName = exports.ReferrerPolicy = exports.HTTPStatus = exports.ExecutionType = exports.DefaultLanguage = exports.SemanticTypes = exports.HTTPMethods = void 0;
-/**
- * Standard HTTP methods
- */
-var HTTPMethods;
-(function (HTTPMethods) {
-    HTTPMethods["Delete"] = "delete";
-    HTTPMethods["Get"] = "get";
-    HTTPMethods["Head"] = "head";
-    HTTPMethods["Options"] = "options";
-    HTTPMethods["Patch"] = "patch";
-    HTTPMethods["Post"] = "post";
-    HTTPMethods["Put"] = "put";
-})(HTTPMethods = exports.HTTPMethods || (exports.HTTPMethods = {}));
+exports.ElementTypes = exports.Protocol = exports.TagName = exports.ReferrerPolicy = exports.HTTPStatus = exports.ExecutionType = exports.DefaultLanguage = exports.HTTPMethods = exports.EditorTypes = exports.SemanticTypes = void 0;
 var SemanticTypes;
@@ -31,3 +18,20 @@ (function (SemanticTypes) {
 })(SemanticTypes = exports.SemanticTypes || (exports.SemanticTypes = {}));
+var EditorTypes;
+(function (EditorTypes) {
+    EditorTypes["Code"] = "code";
+})(EditorTypes = exports.EditorTypes || (exports.EditorTypes = {}));
 /**
+ * Standard HTTP methods
+ */
+var HTTPMethods;
+(function (HTTPMethods) {
+    HTTPMethods["Delete"] = "delete";
+    HTTPMethods["Get"] = "get";
+    HTTPMethods["Head"] = "head";
+    HTTPMethods["Options"] = "options";
+    HTTPMethods["Patch"] = "patch";
+    HTTPMethods["Post"] = "post";
+    HTTPMethods["Put"] = "put";
+})(HTTPMethods = exports.HTTPMethods || (exports.HTTPMethods = {}));
+/**
  * Informs the element loader which language to assume the default text queues (contained in
@@ -34,0 +38,0 @@ * this file) are written in.

package.json

 {
   "name": "@doflo/flow-interfaces",
-  "version": "1.8.2",
+  "version": "1.9.0",
   "description": "Public Interfaces, Schemas, & GRPC Signatures for doFlo developers",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

No alert changes

Improved metrics

Total package byte prevSize

240657

increased by5.99%

Number of package files

81

increased by15.71%

Lines of code

3715

increased by13.06%

No dependency changes