@databutton/firebase-types 1.95.12 → 1.97.0

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

@@ -46,7 +46,8 @@ export declare enum CollectionName {
     NOTEBOOKS = "notebooks",
     INTEGRATIONS = "integrations",
     INTEGRATION_TEMPLATES = "integration-templates",
-    INSTALLED_INTEGRATIONS = "installed-integrations",
+    INTEGRATION_CONNECTIONS = "installed-integrations",
+    INTEGRATION_DATA_ACCESS_RESOURCES = "data-access",
     PAGES = "pages",
     PATCH_ATTEMPTS = "patch-attempts",
     PROFILES = "profiles",

package/lib/types/published/enums.js

@@ -47,7 +47,8 @@ export var CollectionName;
     CollectionName["NOTEBOOKS"] = "notebooks";
     CollectionName["INTEGRATIONS"] = "integrations";
     CollectionName["INTEGRATION_TEMPLATES"] = "integration-templates";
-    CollectionName["INSTALLED_INTEGRATIONS"] = "installed-integrations";
+    CollectionName["INTEGRATION_CONNECTIONS"] = "installed-integrations";
+    CollectionName["INTEGRATION_DATA_ACCESS_RESOURCES"] = "data-access";
     CollectionName["PAGES"] = "pages";
     CollectionName["PATCH_ATTEMPTS"] = "patch-attempts";
     CollectionName["PROFILES"] = "profiles";

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

@@ -1,7 +1,7 @@
 import type { Timestamp } from "firebase/firestore";
 import type { JsonObject, Primitive } from "type-fest";
 import type { ProjectMigration } from "../internal/enums.js";
-import type { AccountRole, ConfigTypes, IntegrationType, TaskPriority, TaskRelation, ThirdPartyAuthName, ThirdPartyDatabaseName, ThirdPartyPaymentsName, ThirdPartyServiceCategory, ThirdPartyStorageName, UiComponentTag } from "./enums.js";
+import type { AccountRole, ConfigTypes, TaskPriority, TaskRelation, ThirdPartyAuthName, ThirdPartyDatabaseName, ThirdPartyPaymentsName, ThirdPartyServiceCategory, ThirdPartyStorageName, UiComponentTag } from "./enums.js";
 /**
  * Types here should reflect data format stored in firestore and
  * either be backwards-compatible or migrated when needed
@@ -162,6 +162,7 @@ export interface AccountList {
 export interface AccountMember {
     createdBy: PerformedBy;
     lastUpdatedBy: PerformedBy;
+    displayName: string;
     email: string;
     roles: Array<AccountRole>;
 }
@@ -956,40 +957,6 @@ export interface ProjectMigrationRecord {
     name: ProjectMigration;
     migratedAt: Timestamp;
 }
-/**
- * Collection of integrations that you can add to your project. @deprecated Use InstalledIntegration and IntegrationTemplate instead.
- */
-export interface Integration {
-    displayName: string;
-    version: string;
-    state: "active" | "early-access" | "inactive";
-    /**
-     * The type of integration
-     */
-    type: IntegrationType;
-    /**
-     * The name of the Python packages needed to use the integration
-     */
-    pythonPackageNames: string[];
-    /**
-     * Short description of the integration
-     * Ment for the user to understand what the integration does
-     */
-    description: string;
-    /**
-     * URL to the documentation for the integration
-     */
-    documentationUrl: string | null;
-    createdBy: PerformedBy;
-    lastUpdatedBy: PerformedBy;
-    credentials: string[];
-    /**
-     * Example code snippet to test if the integration is working
-     */
-    healthCheck: {
-        codeSnippet: string;
-    } | null;
-}
 export type ProjectVariant = "beyond-streamlit" | "riff";
 export interface IntegrationPackages {
     npmPackages: {
@@ -1084,62 +1051,6 @@ export interface IntegrationTemplate {
     lastUpdatedBy: PerformedBy;
 }
 export type IntegrationStatus = "connecting" | "connected" | "needs_reconnect";
-/**
- * Integrations installed to user apps. If supported taken from AvailableIntegrations, otherwise custom.
- * Once installed they evolve by themselves.
- */
-export interface InstalledIntegration {
-    status?: IntegrationStatus;
-    displayName: string;
-    templateSemVerVersion: string;
-    templateId: string;
-    enabled: boolean;
-    logoUrl?: string;
-    apiVersion?: IntegrationApiVersion;
-    metadata?: Record<string, string>;
-    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" | "riff-custom" | "community";
-    /**
-     * Short description of the integration
-     * Ment for the user to understand what the integration does
-     */
-    description: string;
-    provider: {
-        name: string;
-    };
-    /** Installed optional scopes for the integration. e.g. "read:contacts", "write:contacts". Allows for managing these via the admin panel and comparing installed vs available scopes. Broken down into sections for easier management and allowing users to select scope sections they need. */
-    optionalScopes?: IntegrationScope[];
-    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;
-}
 /**
  * Summary information for an integration template
  * Stored at: /integration-templates/{label}
@@ -1195,14 +1106,15 @@ export interface IntegrationTemplateVersion {
  * This document is lightweight and references the template for most data.
  * Only instance-specific data is stored here.
  */
-export interface InstalledIntegrationV2 {
+export interface Integration {
     installedBy: PerformedBy;
     lastUpdatedBy: PerformedBy;
     templateId: string;
     templateVersion: string;
     displayName: string;
+    userDescription?: string;
     enabled: boolean;
-    status?: "connecting" | "connected" | "needs_reconnect";
+    status?: IntegrationStatus;
     metadata?: Record<string, string>;
     credentials: {
         key: string;
@@ -1221,6 +1133,18 @@ export interface IntegrationLearning {
     createdBy: PerformedBy;
     createdAt: Timestamp;
 }
+export interface IntegrationDataAccessResource {
+    resourceType: string;
+    resourceName: string;
+    accessLevel: string;
+    allowedRoles?: string[];
+    permissions?: string[];
+    description?: string;
+    createdBy: PerformedBy;
+    createdAt: Timestamp;
+    lastUpdatedBy: PerformedBy;
+    lastUpdatedAt: Timestamp;
+}
 /**
  * Account integration usage tracking
  * Stored at: /accounts/{account_id}/integrations/{integration_label}/usage/{project_id}
@@ -1233,13 +1157,13 @@ export interface AccountIntegrationUsage {
     lastUsedAt?: Timestamp;
 }
 /**
- * Integration mount point that links to either account or project integration
+ * Integration connection links to either account or project integration
  * Stored at: /projects/{project_id}/installed-integrations/{integration_label}
  *
  * This is the mount point that determines how the integration is accessed
  * and where it's actually stored (account vs project level)
  */
-export interface InstalledIntegrationMount {
+export interface IntegrationConnection {
     parent: string;
     templateId: string;
     templateVersion: string;

package/package.json

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