@party-stack/ontology 0.19.1 → 0.21.0

package/lib/authentication.d.ts

@@ -0,0 +1,1068 @@
+import { OntologyCollectionDescriptors } from "./tanstack/descriptors.js";
+import { AccountRef, AccountRef as AccountRef$1, AccountSummary } from "@party-stack/connect";
+import { BackendError } from "@party-stack/ontology-backend";
+import { RuntimesLayer } from "@party-stack/runtime";
+import { Effect, Scope } from "effect";
+import { OntologyClient, OntologyServerClient } from "@party-stack/ontology-server/rpc";
+//#region src/authentication.d.ts
+/** Collection descriptors for live queries over Connect's saved accounts and
+ * configuration. Resolve them through the authentication view's DbClient.
+ * Importing descriptors does not open a client or grant access to secret fields.
+ */
+export declare const authenticationObjects: OntologyCollectionDescriptors<import("@party-stack/ontology-spec").InferOntology<{
+  types: never[];
+  objectTypes: ({
+    name: "ServiceInstance";
+    pluralDisplayName: "Service instances";
+    displayName: "Service instance";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "title";
+      displayName: "Title";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "service";
+      displayName: "Service";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "instanceUrl";
+      displayName: "Instance url";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    })[];
+  } | {
+    name: "OAuthApplication";
+    pluralDisplayName: "OAuthApplications";
+    displayName: "OAuth application";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "title";
+      displayName: "Title";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "serviceInstance";
+      displayName: "Service instance";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ServiceInstance";
+        };
+      };
+    } | {
+      name: "flow";
+      displayName: "Flow";
+      type: {
+        kind: "string";
+        value: {
+          constraint: {
+            kind: "enum";
+            value: {
+              options: ({
+                value: "authorization-code";
+                label: "authorization-code";
+              } | {
+                value: "client-credentials";
+                label: "client-credentials";
+              })[];
+            };
+          };
+        };
+      };
+    } | {
+      name: "clientId";
+      displayName: "Client id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "scopes";
+      displayName: "Requested scopes";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "list";
+            value: {
+              elementType: {
+                kind: "string";
+                value: {};
+              };
+            };
+          };
+        };
+      };
+    } | {
+      name: "redirectUrl";
+      displayName: "Redirect URL";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "clientSecret";
+      displayName: "Client secret";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "encrypted";
+            value: {
+              type: {
+                kind: "string";
+                value: {};
+              };
+            };
+          };
+        };
+      };
+    } | {
+      name: "serviceAppId";
+      displayName: "Service app id";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "connection";
+      displayName: "Connection";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        };
+      };
+    })[];
+  } | {
+    name: "OAuthConnection";
+    pluralDisplayName: "OAuthConnections";
+    displayName: "OAuth connection";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "title";
+      displayName: "Title";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "application";
+      displayName: "Application";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthApplication";
+        };
+      };
+    } | {
+      name: "userId";
+      displayName: "User id";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "status";
+      displayName: "Status";
+      type: {
+        kind: "string";
+        value: {
+          constraint: {
+            kind: "enum";
+            value: {
+              options: ({
+                value: "active";
+                label: "active";
+              } | {
+                value: "needs-auth";
+                label: "needs-auth";
+              } | {
+                value: "inactive";
+                label: "inactive";
+              })[];
+            };
+          };
+        };
+      };
+    } | {
+      name: "accessToken";
+      displayName: "Access token";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "encrypted";
+            value: {
+              type: {
+                kind: "string";
+                value: {};
+              };
+            };
+          };
+        };
+      };
+    } | {
+      name: "accessTokenExpiresAt";
+      displayName: "Access token expires at";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "timestamp";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "refreshToken";
+      displayName: "Refresh token";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "encrypted";
+            value: {
+              type: {
+                kind: "string";
+                value: {};
+              };
+            };
+          };
+        };
+      };
+    } | {
+      name: "refreshTokenExpiresAt";
+      displayName: "Refresh token expires at";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "timestamp";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "grantedScopes";
+      displayName: "Granted scopes";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "operationId";
+      displayName: "Operation id";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "operationExpiresAt";
+      displayName: "Operation expires at";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "timestamp";
+            value: {};
+          };
+        };
+      };
+    })[];
+  } | {
+    name: "ApiKeyConnection";
+    pluralDisplayName: "API key connections";
+    displayName: "API key connection";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "title";
+      displayName: "Title";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "serviceInstance";
+      displayName: "Service instance";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ServiceInstance";
+        };
+      };
+    } | {
+      name: "userId";
+      displayName: "User id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "status";
+      displayName: "Status";
+      type: {
+        kind: "string";
+        value: {
+          constraint: {
+            kind: "enum";
+            value: {
+              options: ({
+                value: "active";
+                label: "Active";
+              } | {
+                value: "needs-auth";
+                label: "Needs authentication";
+              } | {
+                value: "inactive";
+                label: "Inactive";
+              })[];
+            };
+          };
+        };
+      };
+    } | {
+      name: "apiKey";
+      displayName: "API key";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "encrypted";
+            value: {
+              type: {
+                kind: "string";
+                value: {};
+              };
+            };
+          };
+        };
+      };
+    } | {
+      name: "expiresAt";
+      displayName: "Expires at";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "timestamp";
+            value: {};
+          };
+        };
+      };
+    })[];
+  } | {
+    name: "ExternalSessionConnection";
+    pluralDisplayName: "External session connections";
+    displayName: "External session connection";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "title";
+      displayName: "Title";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "serviceInstance";
+      displayName: "Service instance";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ServiceInstance";
+        };
+      };
+    } | {
+      name: "userId";
+      displayName: "User id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "status";
+      displayName: "Status";
+      type: {
+        kind: "string";
+        value: {
+          constraint: {
+            kind: "enum";
+            value: {
+              options: ({
+                value: "active";
+                label: "Active";
+              } | {
+                value: "needs-auth";
+                label: "Needs authentication";
+              } | {
+                value: "inactive";
+                label: "Inactive";
+              })[];
+            };
+          };
+        };
+      };
+    } | {
+      name: "sessionId";
+      displayName: "Session id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "expiresAt";
+      displayName: "Expires at";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "timestamp";
+            value: {};
+          };
+        };
+      };
+    })[];
+  } | {
+    name: "OAuthAuthorizationAttempt";
+    pluralDisplayName: "OAuthAuthorizationAttempts";
+    displayName: "OAuth authorization attempt";
+    primaryKey: "id";
+    properties: ({
+      name: "id";
+      displayName: "Id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "application";
+      displayName: "Application";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthApplication";
+        };
+      };
+    } | {
+      name: "principalId";
+      displayName: "Principal id";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "connectionId";
+      displayName: "Connection id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "redirectUrl";
+      displayName: "Redirect url";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "returnUrl";
+      displayName: "Return url";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "codeVerifier";
+      displayName: "Code verifier";
+      type: {
+        kind: "encrypted";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "expiresAt";
+      displayName: "Expires at";
+      type: {
+        kind: "timestamp";
+        value: {};
+      };
+    } | {
+      name: "status";
+      displayName: "Status";
+      type: {
+        kind: "string";
+        value: {
+          constraint: {
+            kind: "enum";
+            value: {
+              options: ({
+                value: "pending";
+                label: "pending";
+              } | {
+                value: "exchanging";
+                label: "exchanging";
+              } | {
+                value: "completed";
+                label: "completed";
+              } | {
+                value: "failed";
+                label: "failed";
+              })[];
+            };
+          };
+        };
+      };
+    })[];
+  })[];
+  linkTypes: never[];
+  actionTypes: ({
+    name: "beginAuthorization";
+    displayName: "Begin authorization";
+    logic: never[];
+    parameters: ({
+      name: "applicationId";
+      displayName: "Application";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthApplication";
+        };
+      };
+    } | {
+      name: "principalId";
+      displayName: "Principal";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "redirectUrl";
+      displayName: "Redirect URL";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "returnUrl";
+      displayName: "Return URL";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    } | {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        };
+      };
+    })[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: ({
+          name: "id";
+          displayName: "Attempt";
+          type: {
+            kind: "string";
+            value: {};
+          };
+        } | {
+          name: "authorizationUrl";
+          displayName: "Authorization URL";
+          type: {
+            kind: "string";
+            value: {};
+          };
+        })[];
+      };
+    };
+  } | {
+    name: "completeAuthorization";
+    displayName: "Complete authorization";
+    logic: never[];
+    parameters: ({
+      name: "callbackUrl";
+      displayName: "Callback URL";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    } | {
+      name: "principalId";
+      displayName: "Principal";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "string";
+            value: {};
+          };
+        };
+      };
+    })[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: {
+          name: "connectionId";
+          displayName: "Connection";
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        }[];
+      };
+    };
+  } | {
+    name: "connectClientCredentials";
+    displayName: "Connect client credentials";
+    logic: never[];
+    parameters: ({
+      name: "applicationId";
+      displayName: "Application";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthApplication";
+        };
+      };
+    } | {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "optional";
+        value: {
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        };
+      };
+    })[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: {
+          name: "connectionId";
+          displayName: "Connection";
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        }[];
+      };
+    };
+  } | {
+    name: "refreshConnection";
+    displayName: "Refresh connection";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthConnection";
+        };
+      };
+    }[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: {
+          name: "connectionId";
+          displayName: "Connection";
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "OAuthConnection";
+            };
+          };
+        }[];
+      };
+    };
+  } | {
+    name: "disconnectConnection";
+    displayName: "Disconnect connection";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthConnection";
+        };
+      };
+    }[];
+  } | {
+    name: "forgetConnection";
+    displayName: "Forget connection";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "OAuthConnection";
+        };
+      };
+    }[];
+  } | {
+    name: "connectApiKey";
+    displayName: "Connect API key";
+    logic: never[];
+    parameters: ({
+      name: "serviceInstanceId";
+      displayName: "Service instance";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ServiceInstance";
+        };
+      };
+    } | {
+      name: "apiKey";
+      displayName: "API key";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    })[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: {
+          name: "connectionId";
+          displayName: "Connection";
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "ApiKeyConnection";
+            };
+          };
+        }[];
+      };
+    };
+  } | {
+    name: "attachExternalSession";
+    displayName: "Attach external session";
+    logic: never[];
+    parameters: ({
+      name: "serviceInstanceId";
+      displayName: "Service instance";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ServiceInstance";
+        };
+      };
+    } | {
+      name: "sessionId";
+      displayName: "Session id";
+      type: {
+        kind: "string";
+        value: {};
+      };
+    })[];
+    returnType: {
+      kind: "struct";
+      value: {
+        fields: {
+          name: "connectionId";
+          displayName: "Connection";
+          type: {
+            kind: "objectReference";
+            value: {
+              objectType: "ExternalSessionConnection";
+            };
+          };
+        }[];
+      };
+    };
+  } | {
+    name: "disconnectApiKey";
+    displayName: "Disconnect API key";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ApiKeyConnection";
+        };
+      };
+    }[];
+  } | {
+    name: "forgetApiKey";
+    displayName: "Forget API key";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ApiKeyConnection";
+        };
+      };
+    }[];
+  } | {
+    name: "disconnectExternalSession";
+    displayName: "Disconnect external session";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ExternalSessionConnection";
+        };
+      };
+    }[];
+  } | {
+    name: "forgetExternalSession";
+    displayName: "Forget external session";
+    logic: never[];
+    parameters: {
+      name: "connectionId";
+      displayName: "Connection";
+      type: {
+        kind: "objectReference";
+        value: {
+          objectType: "ExternalSessionConnection";
+        };
+      };
+    }[];
+  })[];
+  queryFunctionTypes: never[];
+}>, Record<never, never>>;
+export interface AuthenticationClientOptions {
+  readonly client: OntologyServerClient | Effect.Effect<OntologyClient | OntologyServerClient, BackendError, Scope.Scope>;
+  readonly ontology?: string;
+  readonly runtime?: RuntimesLayer;
+}
+/** Promise browser commands over the selected Connect ontology. Inventory is read
+ * from its ordinary Query endpoint; no account stream or authentication-method proxy.
+ * Authentication workflows execute directly and never enter an optimistic outbox.
+ */
+export declare function createAuthenticationClient(options: AuthenticationClientOptions): Promise<{
+  oauth(settings: Parameters<(settings: {
+    readonly applicationId: string;
+    readonly redirectUrl: string;
+  }) => {
+    redirectUrl: string;
+    signIn: (input?: Parameters<(options?: {
+      browserPresentation?: import("@party-stack/runtime").BrowserAuthenticationPresentation;
+      connectionId?: string;
+    }) => Effect.Effect<import("@party-stack/connect").Connection<"active"> & {
+      readonly id: string;
+    }, BackendError>>[0]) => Effect.Effect<{
+      userId: string;
+      state: {
+        readonly status: "active";
+        readonly expiration?: {
+          readonly expiresAt: number;
+          readonly refreshable: boolean;
+        } | undefined;
+      } & {
+        status: "active";
+      };
+      id: string;
+      kind: "oauth";
+    }, BackendError<"Conflict" | "Forbidden" | "HistoryExpired" | "Internal" | "InvalidConfiguration" | "InvalidRequest" | "InvalidResponse" | "NotFound" | "NotImplemented" | "RateLimited" | "ResultExpired" | "SchemaMismatch" | "SessionExpired" | "SessionReplaced" | "SourceMismatch" | "Unauthenticated" | "Unavailable" | "ValidationFailed" | "ViewReplaced">, never>;
+    complete: (url: string) => Effect.Effect<{
+      userId: string;
+      state: {
+        readonly status: "active";
+        readonly expiration?: {
+          readonly expiresAt: number;
+          readonly refreshable: boolean;
+        } | undefined;
+      } & {
+        status: "active";
+      };
+      id: string;
+      kind: "oauth";
+    } | undefined, BackendError<"Conflict" | "Forbidden" | "HistoryExpired" | "Internal" | "InvalidConfiguration" | "InvalidRequest" | "InvalidResponse" | "NotFound" | "NotImplemented" | "RateLimited" | "ResultExpired" | "SchemaMismatch" | "SessionExpired" | "SessionReplaced" | "SourceMismatch" | "Unauthenticated" | "Unavailable" | "ValidationFailed" | "ViewReplaced">, never>;
+  }>[0]): {
+    signIn: (settings?: Parameters<(input?: Parameters<(options?: {
+      browserPresentation?: import("@party-stack/runtime").BrowserAuthenticationPresentation;
+      connectionId?: string;
+    }) => Effect.Effect<import("@party-stack/connect").Connection<"active"> & {
+      readonly id: string;
+    }, BackendError>>[0]) => Effect.Effect<{
+      userId: string;
+      state: {
+        readonly status: "active";
+        readonly expiration?: {
+          readonly expiresAt: number;
+          readonly refreshable: boolean;
+        } | undefined;
+      } & {
+        status: "active";
+      };
+      id: string;
+      kind: "oauth";
+    }, BackendError<"Conflict" | "Forbidden" | "HistoryExpired" | "Internal" | "InvalidConfiguration" | "InvalidRequest" | "InvalidResponse" | "NotFound" | "NotImplemented" | "RateLimited" | "ResultExpired" | "SchemaMismatch" | "SessionExpired" | "SessionReplaced" | "SourceMismatch" | "Unauthenticated" | "Unavailable" | "ValidationFailed" | "ViewReplaced">, never>>[0]) => Promise<{
+      userId: string;
+      state: {
+        readonly status: "active";
+        readonly expiration?: {
+          readonly expiresAt: number;
+          readonly refreshable: boolean;
+        } | undefined;
+      } & {
+        status: "active";
+      };
+      id: string;
+      kind: "oauth";
+    }>;
+    complete: (url: string) => Promise<{
+      userId: string;
+      state: {
+        readonly status: "active";
+        readonly expiration?: {
+          readonly expiresAt: number;
+          readonly refreshable: boolean;
+        } | undefined;
+      } & {
+        status: "active";
+      };
+      id: string;
+      kind: "oauth";
+    } | undefined>;
+  };
+  attachExternalSession: (instance: string, session: string) => Promise<{
+    kind: "external-session";
+    id: string;
+  }>;
+  connectApiKey: (instance: string, key: string) => Promise<{
+    kind: "api-key";
+    id: string;
+  }>;
+  signOut: (account: AccountRef$1) => Promise<void>;
+  forget: (account: AccountRef$1) => Promise<void>;
+  connections: () => Promise<import("@party-stack/connect").AccountSummary[]>;
+  cleanup: () => Promise<void>;
+}>;
+export type AuthenticationClient = Awaited<ReturnType<typeof createAuthenticationClient>>;
+//#endregion
+export type { AccountRef, AccountSummary };
+//# sourceMappingURL=authentication.d.ts.map