@databutton/firebase-types 1.78.152 → 1.79.0

package/lib/types/published/enums.d.ts

@@ -34,6 +34,8 @@ export declare enum CollectionName {
     MIGRATIONS = "migrations",
     NOTEBOOKS = "notebooks",
     INTEGRATIONS = "integrations",
+    INTEGRATION_TEMPLATES = "integration-templates",
+    INSTALLED_INTEGRATIONS = "installed-integrations",
     PAGES = "pages",
     PATCH_ATTEMPTS = "patch-attempts",
     PROFILES = "profiles",

package/lib/types/published/enums.js

@@ -35,6 +35,8 @@ export var CollectionName;
     CollectionName["MIGRATIONS"] = "migrations";
     CollectionName["NOTEBOOKS"] = "notebooks";
     CollectionName["INTEGRATIONS"] = "integrations";
+    CollectionName["INTEGRATION_TEMPLATES"] = "integration-templates";
+    CollectionName["INSTALLED_INTEGRATIONS"] = "installed-integrations";
     CollectionName["PAGES"] = "pages";
     CollectionName["PATCH_ATTEMPTS"] = "patch-attempts";
     CollectionName["PROFILES"] = "profiles";

package/lib/types/published/persisted.d.ts

@@ -787,6 +787,116 @@ export interface Integration {
     } | null;
 }
 export type ProjectVariant = "beyond-streamlit" | "riff";
+export interface IntegrationPackages {
+    npmPackages: {
+        dependencies: {
+            [key: string]: string;
+        };
+        devDependencies: {
+            [key: string]: string;
+        };
+    };
+    pythonPackages: {
+        app: string[];
+        dev: string[];
+    };
+}
+/**
+ * Pre-defined integrations. To speed up the process for the user by pre-defining auth strategy and other fields.
+ * These include OAuth connections managed by Riff.
+ */
+export interface IntegrationTemplate {
+    displayName: string;
+    state: "active" | "early-access" | "inactive";
+    semVerVersion: string;
+    managedBy: "riff" | "community";
+    /**
+     * Short description of the integration
+     * Ment for the user to understand what the integration does
+     */
+    description: string;
+    provider: {
+        name: string;
+    };
+    /**
+     * Riff-oauth are integrations that use our provided Riff OAuth flow
+     * Any integration using a custom flow should have usage descriubed in the guide field
+     */
+    authStrategy: "riff-oauth" | "oauth" | "api-key" | "custom";
+    requiredCredentials: {
+        key: string;
+    }[];
+    /**
+     * human/agent-readable notes (scopes, pagination, rate limits, usage examples). Living document. used by agent, and for debug
+     */
+    guide: string | null;
+    /**
+     * Set of URLs for the agent to learn about how to use the integration.
+     * Quickstart is a human-friendly guide from the integration docs
+     * OpenAPI is the API spec to learn from
+     * Docs is a generic catch all for the documentation presented by the provider. e.g. docs.stripe.com
+     */
+    documentationUrls: {
+        type: "quickstart" | "openapi" | "docs";
+        url: string;
+    }[];
+    /**
+     * The name of the Python packages needed to use the integration
+     */
+    packages: IntegrationPackages;
+    createdBy: PerformedBy;
+    lastUpdatedBy: PerformedBy;
+}
+/**
+ * Integrations installed to user apps. If supported taken from AvailableIntegrations, otherwise custom.
+ * Once installed they evolve by themselves.
+ */
+export interface InstalledIntegration {
+    displayName: string;
+    templateSemVerVersion: string;
+    templateId: string;
+    enabled: boolean;
+    credentials: {
+        key: string;
+        ref: string;
+    }[];
+    /**
+     * Learnings are notes collected by the agent as it learns about the integration and the way a given company uses it.
+     * This should evolve over time and allow the agent to provide mroe acurate results tailored to the specific dataset.
+     * e.g. For example in intercom user_id is called external_ref
+     */
+    learnings: string[];
+    managedBy: "riff" | "community";
+    /**
+     * Short description of the integration
+     * Ment for the user to understand what the integration does
+     */
+    description: string;
+    provider: {
+        name: string;
+    };
+    authStrategy: "riff-oauth" | "oauth" | "api-key" | "custom";
+    /**
+     * human/agent-readable notes (scopes, pagination, rate limits, usage examples). Living document. used by agent, and for debug
+     */
+    guide: string | null;
+    /**
+     * Set of URLs for the agent to learn about how to use the integration.
+     * Quickstart is a human-friendly guide from the integration docs
+     * OpenAPI is the API spec to learn from
+     * Docs is a generic catch all for the documentation presented by the provider. e.g. docs.stripe.com
+     */
+    documentationUrls: {
+        type: "quickstart" | "openapi" | "docs";
+        url: string;
+    }[];
+    /**
+     * The name of the Python packages needed to use the integration
+     */
+    packages: IntegrationPackages;
+    installedBy: PerformedBy;
+    lastUpdatedBy: PerformedBy;
+}
 export interface CompanyKnowledgeBase {
     createdBy: PerformedBy;
     lastUpdatedBy: PerformedBy;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@databutton/firebase-types",
-  "version": "1.78.152",
+  "version": "1.79.0",
   "main": "lib/types/published/index.js",
   "type": "module",
   "engines": {