@doflo/flow-interfaces - npm Package Compare versions

Comparing version 1.12.0 to 1.13.0

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

@@ -8,11 +8,15 @@ {
   "properties": {
-    "hostkey":{
+    "description": {
+      "$ref": "./basicElementInfo.json"
+    },
+    "hostkey": {
       "description": "If a host key is supplied the root host name of the element is modified to include the host key so the host name will effectively become {hostkey}-{elementName}.doflo.com",
       "type": "string"
     },
-    "endpoints":{
+    "endpoints": {
       "$ref": "./appEndpointsSchema.json"
     }
   },
+  "required": ["description"],
   "additionalProperties": false
-}
+}

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

@@ -10,2 +10,3 @@ {
       "type": "array",
+      "title": "ElementActionsTasksSchema",
       "items": {
@@ -12,0 +13,0 @@ "$ref": "./elementActionTaskSchema.json",

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

@@ -31,3 +31,3 @@ {
   },
-  "required": ["group", "version", "description", "defaults", "inputs", "outputs", "properties"]
+  "required": ["name", "group", "version", "description", "defaults", "inputs", "outputs", "properties"]
 }

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

@@ -14,17 +14,15 @@ {
     "description": { "$ref": "./elementInfo.json" },
-    "credentialTypes":
-    {
-      "type":"array"
-      ,"items": {
-        "type":"string"
+    "credentialTypes": {
+      "type": "array",
+      "items": {
+        "type": "string"
       }
     },
-    "fileName":
-    {
+    "fileName": {
       "description": "By specifying the file name you override the default behavior of matching the file name to the triggers name",
       "type": "string"
     },
-    "processes": { 
+    "processes": {
       "type": "object",
-      "additionalProperties": { 
+      "additionalProperties": {
         "$ref": "../../../v1.0.0/ecma-function-name.json"
@@ -42,2 +40,5 @@ }
       "$ref": "./endpointsSchema.json"
+    },
+    "tasks": {
+      "$ref": "./elementSignalTaskSchema.json"
     }
@@ -47,2 +48,2 @@ },
   "required": ["description"]
-}
+}

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

@@ -34,63 +34,39 @@ {
     "element-actions-schema": {
-      "type": "object",
-      "patternProperties": {
-        "([A-Z].*Action)": {
-          "$ref": "./definitions/elementActionSchema.json"
-        }
-      },
-      "additionalProperties": {
-        "$ref": "./definitions/elementActionSchema.json"
+      "type": "array",
+      "items": {
+        "$ref": "./definitions/elementActionSchema.json",
+        "uniqueItems": true
       }
     },
     "element-credentials-schema": {
-      "type": "object",
-      "patternProperties": {
-        "([A-Z].*Credential)": {
-          "$ref": "./definitions/credentialSchema.json"
-        }
-      },
-      "additionalProperties": {
-        "$ref": "./definitions/credentialSchema.json"
+      "type": "array",
+      "items": {
+        "$ref": "./definitions/credentialSchema.json",
+        "uniqueItems": true
       }
     },
     "bridgeapps-schema": {
-      "type": "object",
-      "patternProperties": {
-        "([A-Z].*App)": {
-          "$ref": "./definitions/bridgeAppSchema.json"
-        }
-      },
-      "additionalProperties": {
-        "$ref": "./definitions/bridgeAppSchema.json"
+      "type": "array",
+      "items": {
+        "$ref": "./definitions/bridgeAppSchema.json",
+        "uniqueItems": true
       }
     },
     "element-signals-schema": {
-      "type": "object",
-      "patternProperties": {
-        "([A-Z].*Signal)": {
-          "$ref": "./definitions/elementSignalSchema.json"
-        }
-      },
-      "additionalProperties": {
-        "$ref": "./definitions/elementSignalSchema.json"
+      "type": "array",
+      "items": {
+        "$ref": "./definitions/elementSignalSchema.json",
+        "uniqueItems": true
       }
     },
     "element-actions-auths-schema": {
-      "type": "object",
-      "patternProperties": {
-        "(auth[A-Z].*)": {
-          "$ref": "./definitions/elementAuthenticatorSchema.json"
-        }
-      },
-      "additionalProperties": {
-        "$ref": "./definitions/elementAuthenticatorSchema.json"
+      "type": "array",
+      "items": {
+        "$ref": "./definitions/elementAuthenticatorSchema.json",
+        "uniqueItems": true
       }
     },
     "element-events-schema": {
-      "patternProperties": {
-        "(on[A-Z].*)": {
-          "$ref": "#/definitions/element-event-schema"
-        }
-      },
-      "additionalProperties": {
+      "type": "array",
+      "items": {
         "$ref": "#/definitions/element-event-schema"
@@ -97,0 +73,0 @@ }

dist/types/schemaTypes.d.ts

@@ -9,13 +9,7 @@ /**
     $schema?: string;
-    actions?: {
-        [key: string]: ElementActionSchema;
-    };
-    bridgeApps?: {
-        [key: string]: BridgeAppSchema;
-    };
+    actions?: ElementActionSchema[];
+    bridgeApps?: BridgeAppSchema[];
     configuration: any;
     contexts?: any;
-    credentials?: {
-        [key: string]: CredentialsSchema;
-    };
+    credentials?: CredentialsSchema[];
     /**
@@ -31,5 +25,3 @@ * Informs the element loader which language to assume the default text queues (contained in
     projectName: string;
-    signals?: {
-        [key: string]: ElementSignalSchema;
-    };
+    signals?: ElementSignalSchema[];
     spaSettings?: any[] | boolean | number | number | null | SPASettingsObject | string;
@@ -110,3 +102,3 @@ token?: string;
      */
-    name?: string;
+    name: string;
     outputNames?: string[];
@@ -255,2 +247,3 @@ outputs: string[];
 export interface BridgeAppSchema {
+    description: BasicElementInfo;
     endpoints?: AppEndpointsSchema[];
@@ -263,2 +256,14 @@ /**
 }
+export interface BasicElementInfo {
+    /**
+     * 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;
+    version?: string;
+}
 export interface AppEndpointsSchema {
@@ -351,2 +356,3 @@ action?: string;
     };
+    tasks?: ElementSignalTaskSchema;
     webhooks?: {
@@ -363,2 +369,16 @@ [key: string]: WebhooksSchema;
 }
+/**
+ * Definition of a doFlo signal task element
+ */
+export interface ElementSignalTaskSchema {
+    /**
+     * when present description is used, if a localization file is present name is used as the
+     * key for a localized description
+     */
+    description?: string;
+    /**
+     * These are the interfaces that are present on rows produced by this signal
+     */
+    interfaces?: string[];
+}
 export interface WebhooksSchema {
@@ -365,0 +385,0 @@ executionType?: ExecutionType;

package.json

 {
   "name": "@doflo/flow-interfaces",
-  "version": "1.12.0",
+  "version": "1.13.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

276459

increased by0.49%

Number of package files

124

increased by1.64%

Lines of code

4336

increased by0.93%

No dependency changes