@friggframework/core 2.0.0--canary.703.12b980b.0 → 2.0.0--canary.707.df80bfd.0

package/integrations/definitions/schema/capability-manifest.v0.1.schema.json

@@ -1,549 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://friggframework.org/schemas/capability-manifest/v0.1.json",
-  "title": "Frigg API module capability manifest v0.1",
-  "description": "What an API module can do, in terms a definition can reference: objects and their fields, events it emits, capabilities (each backed by one Api method) and option lists for settings. Shipped with the module.",
-  "type": "object",
-  "required": [
-    "module",
-    "package",
-    "objects",
-    "capabilities"
-  ],
-  "additionalProperties": false,
-  "properties": {
-    "$schema": {
-      "type": "string"
-    },
-    "module": {
-      "type": "string"
-    },
-    "label": {
-      "type": "string"
-    },
-    "package": {
-      "type": "string"
-    },
-    "version": {
-      "type": "string"
-    },
-    "auth": {
-      "enum": [
-        "oauth2",
-        "api_key",
-        "basic"
-      ]
-    },
-    "account": {
-      "type": "object",
-      "description": "Values about the connected account the module persists (apiPropertiesToPersist). Definitions read them as $.install.accounts.<module key>.<name>; nothing undeclared is exposed.",
-      "required": [
-        "fields"
-      ],
-      "properties": {
-        "description": {
-          "type": "string"
-        },
-        "fields": {
-          "type": "array",
-          "items": {
-            "type": "object",
-            "required": [
-              "name",
-              "type"
-            ],
-            "additionalProperties": false,
-            "properties": {
-              "name": {
-                "type": "string",
-                "pattern": "^[A-Za-z_]\\w*$"
-              },
-              "type": {
-                "type": "string"
-              },
-              "description": {
-                "type": "string"
-              }
-            }
-          }
-        }
-      }
-    },
-    "objects": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "properties": {
-          "label": {
-            "type": "string"
-          },
-          "fields": {
-            "type": "array",
-            "items": {
-              "type": "object",
-              "required": [
-                "name",
-                "type"
-              ],
-              "properties": {
-                "name": {
-                  "type": "string"
-                },
-                "type": {
-                  "type": "string"
-                },
-                "tag": {
-                  "type": "string"
-                },
-                "required": {
-                  "type": "boolean"
-                },
-                "readOnly": {
-                  "type": "boolean"
-                },
-                "values": {
-                  "description": "enum: the values, or the name of one of this module's option lists when they differ per account.",
-                  "oneOf": [
-                    {
-                      "type": "array"
-                    },
-                    {
-                      "type": "string"
-                    }
-                  ]
-                }
-              }
-            }
-          },
-          "sync": {
-            "type": "object",
-            "additionalProperties": false,
-            "description": "How a sync reads and writes this object (sync-engine.js). A write's arguments are the mapped record (wrapped in `body` when the capability takes it in one argument); update and get also pass the record id as `id`.",
-            "properties": {
-              "id": {
-                "type": "string",
-                "default": "id",
-                "description": "Path of the record's id."
-              },
-              "updatedAt": {
-                "type": "string",
-                "description": "Path of the record's last-modified time: poll high-water marks and master: newest."
-              },
-              "list": {
-                "type": "object",
-                "required": [
-                  "capability"
-                ],
-                "additionalProperties": false,
-                "description": "Pages through every record.",
-                "properties": {
-                  "capability": {
-                    "type": "string"
-                  },
-                  "cursor": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$",
-                    "description": "Argument taking the cursor, offset or page number."
-                  },
-                  "limit": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$",
-                    "description": "Argument taking the page size."
-                  },
-                  "since": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$",
-                    "description": "Argument taking a modified-since time (polling)."
-                  },
-                  "items": {
-                    "type": "string",
-                    "description": "Path of the records in the response; omit when the response is the array."
-                  },
-                  "next": {
-                    "type": "string",
-                    "description": "cursor paging: path of the next cursor in the response."
-                  },
-                  "paging": {
-                    "enum": [
-                      "cursor",
-                      "offset",
-                      "page"
-                    ],
-                    "default": "cursor"
-                  }
-                }
-              },
-              "get": {
-                "type": "object",
-                "required": [
-                  "capability"
-                ],
-                "additionalProperties": false,
-                "description": "Reads one record by id (an event that carries only an id is fetched with it).",
-                "properties": {
-                  "capability": {
-                    "type": "string"
-                  },
-                  "id": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$"
-                  }
-                }
-              },
-              "search": {
-                "type": "object",
-                "required": [
-                  "capability"
-                ],
-                "additionalProperties": false,
-                "description": "Finds candidates by identity key; its arguments are named after the definition's identity keys.",
-                "properties": {
-                  "capability": {
-                    "type": "string"
-                  }
-                }
-              },
-              "create": {
-                "type": "object",
-                "required": [
-                  "capability"
-                ],
-                "additionalProperties": false,
-                "description": "Creates a record.",
-                "properties": {
-                  "capability": {
-                    "type": "string"
-                  },
-                  "body": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$"
-                  }
-                }
-              },
-              "update": {
-                "type": "object",
-                "required": [
-                  "capability"
-                ],
-                "additionalProperties": false,
-                "description": "Updates a record.",
-                "properties": {
-                  "capability": {
-                    "type": "string"
-                  },
-                  "id": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$"
-                  },
-                  "body": {
-                    "type": "string",
-                    "pattern": "^[A-Za-z_]\\w*$"
-                  }
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "events": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "required": [
-          "delivery"
-        ],
-        "properties": {
-          "delivery": {
-            "enum": [
-              "webhook",
-              "poll"
-            ]
-          },
-          "object": {
-            "type": "string"
-          },
-          "description": {
-            "type": "string"
-          },
-          "payload": {
-            "type": [
-              "object",
-              "array"
-            ],
-            "description": "Example delivery body, exactly as the provider sends it (HubSpot sends an array). With the manifest's webhook block it must route to this event; $.event is the event item."
-          },
-          "subscribe": {
-            "type": "string",
-            "description": "Capability that registers the subscription on install."
-          },
-          "record": {
-            "type": "string",
-            "description": "Path inside the payload to the record the event is about (exposed as $.record). Omit when the payload is the record."
-          },
-          "idPath": {
-            "type": "string",
-            "default": "id",
-            "description": "Path to the provider's event id, used to run each event once."
-          },
-          "match": {
-            "type": "string",
-            "description": "The provider's topic for this event (default: the event key)."
-          },
-          "when": {
-            "type": "string",
-            "description": "Condition on $.record / $.event: a phone module reports a missed call as call.completed with status missed."
-          },
-          "headers": {
-            "type": "object",
-            "description": "Headers of the example delivery, when the topic is in a header."
-          },
-          "recordId": {
-            "type": "string",
-            "description": "Path in the event to the record id, when the event carries only an id (HubSpot's objectId): a sync fetches the record with the object's sync.get."
-          }
-        }
-      }
-    },
-    "webhook": {
-      "type": "object",
-      "description": "How a POST from this provider becomes module events (webhooks.js). Templates read body, headers (lower-case), query, item (one event of a batch) and parent (the outer item of a two-level batch).",
-      "required": [
-        "scope",
-        "topic",
-        "eventId"
-      ],
-      "additionalProperties": false,
-      "properties": {
-        "scope": {
-          "enum": [
-            "installation",
-            "app"
-          ],
-          "description": "installation: a URL per installation. app: one URL for every account, routed by account."
-        },
-        "topic": {
-          "oneOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "minItems": 1
-            }
-          ],
-          "description": "The provider's event type. A list tries each template until one renders non-empty."
-        },
-        "eventId": {
-          "oneOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "minItems": 1
-            }
-          ],
-          "description": "The id that makes a redelivery a no-op."
-        },
-        "account": {
-          "oneOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "minItems": 1
-            }
-          ],
-          "description": "The connected account (entity externalId) an event is about. Required for app scope."
-        },
-        "batch": {
-          "oneOf": [
-            {
-              "type": "string"
-            },
-            {
-              "type": "array",
-              "items": {
-                "type": "string"
-              },
-              "minItems": 1,
-              "maxItems": 2
-            }
-          ],
-          "description": "Path to the array of events; [outer, inner] for two levels."
-        },
-        "verify": {
-          "type": "string",
-          "pattern": "^[A-Za-z_$][\\w$]*$",
-          "description": "Api method that checks the signature: ({ headers, body, query }) -> true."
-        },
-        "unwrap": {
-          "type": "string",
-          "description": "A form field holding the JSON body (Slack interactivity)."
-        },
-        "handshake": {
-          "type": "object",
-          "required": [
-            "when"
-          ],
-          "additionalProperties": false,
-          "properties": {
-            "when": {
-              "type": "string"
-            },
-            "status": {
-              "type": "integer"
-            },
-            "headers": {
-              "type": "object"
-            },
-            "body": {}
-          },
-          "description": "Answered at receipt, before anything is queued (Slack url_verification, Asana X-Hook-Secret)."
-        },
-        "status": {
-          "enum": [
-            "unimplemented"
-          ],
-          "description": "The module's Api has no `verify` method (or none that checks a signature). Every delivery fails verification until it does, so definitions that trigger on this module's events validate with a warning."
-        },
-        "note": {
-          "type": "string"
-        }
-      }
-    },
-    "capabilities": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "required": [
-          "kind",
-          "method"
-        ],
-        "properties": {
-          "kind": {
-            "enum": [
-              "read",
-              "write",
-              "delete",
-              "subscribe",
-              "search"
-            ]
-          },
-          "method": {
-            "type": "string",
-            "description": "Api class method that implements it."
-          },
-          "label": {
-            "type": "string"
-          },
-          "input": {
-            "type": "object",
-            "description": "Argument names -> {type, required}."
-          },
-          "output": {
-            "type": "string"
-          },
-          "args": {
-            "type": "array",
-            "description": "How the Api method takes its arguments, when it is not one object holding every input. Each entry is an input name (passed positionally), \"$rest\" (an object of every input not named elsewhere in the list) or {\"value\": x} (a constant, such as the sObject name of a generic Api). Omitted: the method is called with one object of all inputs.",
-            "items": {
-              "oneOf": [
-                {
-                  "type": "string"
-                },
-                {
-                  "type": "object",
-                  "required": [
-                    "value"
-                  ],
-                  "additionalProperties": false,
-                  "properties": {
-                    "value": {}
-                  }
-                }
-              ]
-            }
-          },
-          "status": {
-            "enum": [
-              "unimplemented"
-            ],
-            "description": "The module's real Api class has no method that does this (or none shaped so the call can be made). Definitions that use it validate with a warning, never an error."
-          },
-          "note": {
-            "type": "string",
-            "description": "What the real method does differently, or what is missing upstream."
-          }
-        }
-      }
-    },
-    "options": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "required": [
-          "capability",
-          "label",
-          "value"
-        ],
-        "properties": {
-          "capability": {
-            "type": "string"
-          },
-          "label": {
-            "type": "string",
-            "description": "One reference ($.item.name) or a template ({{item.firstName}} {{item.lastName}}); never a $. reference mixed into text."
-          },
-          "value": {
-            "type": "string"
-          },
-          "inputs": {
-            "type": "object",
-            "description": "Arguments the list capability needs, filled from a setting's options.with.",
-            "additionalProperties": {
-              "type": "object",
-              "required": [
-                "type"
-              ],
-              "properties": {
-                "type": {
-                  "type": "string"
-                },
-                "required": {
-                  "type": "boolean"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "ui": {
-      "type": "object",
-      "properties": {
-        "placements": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          }
-        },
-        "renderer": {
-          "type": "string",
-          "description": "The generic renderer extension deployed once for this host."
-        }
-      }
-    }
-  }
-}

package/integrations/definitions/schema/installation.v0.1.schema.json

@@ -1,130 +0,0 @@
-{
-  "$schema": "https://json-schema.org/draft/2020-12/schema",
-  "$id": "https://friggframework.org/schemas/installation/v0.1.json",
-  "title": "Installation config v0.1",
-  "description": "What one customer chose, stored as Integration.config. The definition says what is possible; this says what is on.",
-  "type": "object",
-  "required": [
-    "definition"
-  ],
-  "properties": {
-    "definition": {
-      "type": "object",
-      "required": [
-        "id",
-        "version"
-      ],
-      "properties": {
-        "id": {
-          "type": "string"
-        },
-        "version": {
-          "type": "string"
-        },
-        "checksum": {
-          "type": "string"
-        }
-      }
-    },
-    "settings": {
-      "type": "object"
-    },
-    "syncs": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "properties": {
-          "enabled": {
-            "type": "boolean"
-          },
-          "mapping": {
-            "type": "array",
-            "description": "Full replacement mapping when the customer overrides the default."
-          },
-          "schedule": {
-            "$ref": "#/$defs/scheduleChoice"
-          }
-        }
-      }
-    },
-    "workflows": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "properties": {
-          "enabled": {
-            "type": "boolean"
-          },
-          "settings": {
-            "type": "object"
-          },
-          "schedule": {
-            "$ref": "#/$defs/scheduleChoice"
-          }
-        }
-      }
-    },
-    "ui": {
-      "type": "object",
-      "additionalProperties": {
-        "type": "object",
-        "properties": {
-          "enabled": {
-            "type": "boolean"
-          }
-        }
-      }
-    },
-    "runtime": {
-      "type": "object",
-      "description": "Owned by the runtime, not the customer. installed: each onInstall step's result by step id (webhook subscriptions), read by onUninstall as $.install.runtime.installed.<id>. Sync cursors join it with the sync engine.",
-      "additionalProperties": false,
-      "properties": {
-        "installed": {
-          "type": "object"
-        }
-      }
-    }
-  },
-  "$defs": {
-    "scheduleChoice": {
-      "description": "The installation's timing for a schedule trigger or polling sync the definition marks configurable: every, or cron with an optional time zone. Honoured only within the definition's minimum; otherwise the definition's timing runs. The integration's shared trigger tick reads it (ADR-055); nothing is scheduled per installation.",
-      "type": "object",
-      "additionalProperties": false,
-      "properties": {
-        "every": {
-          "type": "string",
-          "pattern": "^\\d+\\s*(m|h|d)$"
-        },
-        "cron": {
-          "type": "string"
-        },
-        "timezone": {
-          "type": "string"
-        }
-      },
-      "oneOf": [
-        {
-          "required": [
-            "every"
-          ],
-          "not": {
-            "required": [
-              "cron"
-            ]
-          }
-        },
-        {
-          "required": [
-            "cron"
-          ],
-          "not": {
-            "required": [
-              "every"
-            ]
-          }
-        }
-      ]
-    }
-  }
-}