@cauthyhq/node 1.1.0 → 1.2.1

package/dist/index.d.mts

@@ -1,8 +1,27 @@
-export { A as AttributeType, a as CatalogResource, C as Cauthy, b as CauthyApiError, c as CauthyConfigError, d as CauthyEvent, e as CauthyOptions, f as CauthyPact, g as CauthySystem, h as CauthyTokenError, i as CauthyUnavailableError, j as CauthyWebhookError, k as CheckOf, l as CheckQuestion, m as CheckResult, n as CheckRule, o as ConditionalPermission, p as ContractOptions, J as JsonValue, M as MountTarget, N as NewMember, O as Organization, q as OrganizationMember, r as OrganizationRef, P as PactItem, s as PactStatus, t as PermissionOf, u as Permitted, v as Policy, w as PolicyDefinition, x as PolicyPermission, y as PolicyRole, z as PublicSession, B as PushPolicyOptions, R as ReplayStore, D as Resolved, E as ResolvedContract, F as RoleOf, G as STANDARD_VARIABLES, S as Session, H as SessionOrganization, I as SessionStatus, K as SessionUser, L as SystemKey, Q as SystemOptions, T as SystemPolicy, U as TokenIdentity, V as TokenRefusal, W as VerifyTokenOptions, X as VerifyWebhookOptions, Y as can, Z as createCauthy, _ as createSystem, $ as createTokenVerifier, a0 as definePolicy, a1 as failClosed, a2 as memoryReplayStore, a3 as policySource, a4 as pullCatalog, a5 as pullPolicy, a6 as pushCatalog, a7 as pushPolicy, a8 as readContract, a9 as remoteKeys, aa as verifyToken, ab as verifyWebhook } from './cauthy-Bn-i7cKD.mjs';
+export { A as AttributeType, a as CatalogResource, C as Cauthy, b as CauthyApiError, c as CauthyConfigError, d as CauthyEvent, e as CauthyKeyError, f as CauthyKeyReason, g as CauthyOptions, h as CauthyPact, i as CauthySystem, j as CauthyTokenError, k as CauthyUnavailableError, l as CauthyWebhookError, m as CheckOf, n as CheckQuestion, o as CheckResult, p as CheckRule, q as ConditionalPermission, r as ContractOptions, J as JsonValue, M as MountTarget, N as NewMember, O as Organization, s as OrganizationMember, t as OrganizationRef, P as PactItem, u as PactStatus, v as PermissionOf, w as Permitted, x as Policy, y as PolicyDefinition, z as PolicyPermission, B as PolicyRole, D as PublicSession, E as PushPolicyOptions, R as ReplayStore, F as Resolved, G as ResolvedContract, H as RoleOf, I as STANDARD_VARIABLES, S as Session, K as SessionOrganization, L as SessionStatus, Q as SessionUser, T as SystemKey, U as SystemOptions, V as SystemPolicy, W as TokenIdentity, X as TokenRefusal, Y as VerifyTokenOptions, Z as VerifyWebhookOptions, _ as can, $ as createCauthy, a0 as createSystem, a1 as createTokenVerifier, a2 as createVerifierFromEnv, a3 as definePolicy, a4 as failClosed, a5 as memoryReplayStore, a6 as policySource, a7 as pullCatalog, a8 as pullPolicy, a9 as pushCatalog, aa as pushPolicy, ab as readContract, ac as remoteKeys, ad as verifyToken, ae as verifyWebhook } from './cauthy-CCSSj3Lg.mjs';
+export { I as Identity } from './identity-BTJ8NB_w.mjs';
 export { K as KeyStore, P as PactKeys, S as StoredKey } from './keys-D5k0omTb.mjs';
 export { CauthyTheme, ImportedTheme, PushThemeOptions, StackmythThemeOptions, StackmythTokens, ThemeFont, ThemeTexts, pushTheme, themeFromStackmyth, tokensFromStackmyth } from './theme.mjs';
 import 'jose';
 
+/**
+ * The variables CAUTHY_KEY replaces: set beside it, each is a second source
+ * of the same thing, and the application refuses to start (key/cauthy-key.md §10).
+ */
+declare const KEY_REPLACES: readonly ["CAUTHY_ISSUER", "CAUTHY_CLIENT_ID", "CAUTHY_CLIENT_SECRET", "CAUTHY_SYSTEM", "CAUTHY_TENANT", "CAUTHY_SYSTEM_KEY", "CAUTHY_SYSTEM_KEY_ID", "CAUTHY_BASE_URL", "CAUTHY_AUDIENCE", "CAUTHY_TENANT_ID"];
+/** What a CAUTHY_KEY names. Never logged, never printed. */
+interface CauthyKey {
+    /** Cauthy's origin, e.g. https://cauthy.api.example.com */
+    issuer: string;
+    clientId: string;
+    /** The 43-character secret segment: the HKDF input, as text. */
+    secret: string;
+}
+/** Reads a CAUTHY_KEY; throws CauthyKeyError with the reason, never the value. */
+declare function parseKey(text: string): CauthyKey;
+/** Writes a CAUTHY_KEY (what the dashboard does in the browser; here for tests and tools). */
+declare function composeKey(issuer: string, clientId: string, secret: string): string;
+
 interface ConnectOptions {
     /** The system's name, as its organizations are filed under: lowercase, digits, - or _. */
     system: string;
@@ -135,4 +154,4 @@ declare const PROTOCOL_VERSION = "1";
  */
 type NextStep = 'done' | 'mfa' | 'verify_email' | 'code' | 'passkey' | 'one_tap' | 'redirect';
 
-export { type AuthField, type ConnectOptions, type Connected, DEFAULT_PASSWORD_POLICY, type FieldProblem, MIN_PASSWORD, type NextStep, PROTOCOL_VERSION, type PasswordClass, type PasswordLocale, type PasswordPolicy, type PasswordReason, checkCode, checkEmail, checkName, checkNewPassword, checkPassword, connectSystem, describePasswordPolicy, explainPasswordProblems, passwordPolicyOf, passwordProblems };
+export { type AuthField, type CauthyKey, type ConnectOptions, type Connected, DEFAULT_PASSWORD_POLICY, type FieldProblem, KEY_REPLACES, MIN_PASSWORD, type NextStep, PROTOCOL_VERSION, type PasswordClass, type PasswordLocale, type PasswordPolicy, type PasswordReason, checkCode, checkEmail, checkName, checkNewPassword, checkPassword, composeKey, connectSystem, describePasswordPolicy, explainPasswordProblems, parseKey, passwordPolicyOf, passwordProblems };

package/dist/index.d.ts

@@ -1,8 +1,27 @@
-export { A as AttributeType, a as CatalogResource, C as Cauthy, b as CauthyApiError, c as CauthyConfigError, d as CauthyEvent, e as CauthyOptions, f as CauthyPact, g as CauthySystem, h as CauthyTokenError, i as CauthyUnavailableError, j as CauthyWebhookError, k as CheckOf, l as CheckQuestion, m as CheckResult, n as CheckRule, o as ConditionalPermission, p as ContractOptions, J as JsonValue, M as MountTarget, N as NewMember, O as Organization, q as OrganizationMember, r as OrganizationRef, P as PactItem, s as PactStatus, t as PermissionOf, u as Permitted, v as Policy, w as PolicyDefinition, x as PolicyPermission, y as PolicyRole, z as PublicSession, B as PushPolicyOptions, R as ReplayStore, D as Resolved, E as ResolvedContract, F as RoleOf, G as STANDARD_VARIABLES, S as Session, H as SessionOrganization, I as SessionStatus, K as SessionUser, L as SystemKey, Q as SystemOptions, T as SystemPolicy, U as TokenIdentity, V as TokenRefusal, W as VerifyTokenOptions, X as VerifyWebhookOptions, Y as can, Z as createCauthy, _ as createSystem, $ as createTokenVerifier, a0 as definePolicy, a1 as failClosed, a2 as memoryReplayStore, a3 as policySource, a4 as pullCatalog, a5 as pullPolicy, a6 as pushCatalog, a7 as pushPolicy, a8 as readContract, a9 as remoteKeys, aa as verifyToken, ab as verifyWebhook } from './cauthy-Wy-YDGrM.js';
+export { A as AttributeType, a as CatalogResource, C as Cauthy, b as CauthyApiError, c as CauthyConfigError, d as CauthyEvent, e as CauthyKeyError, f as CauthyKeyReason, g as CauthyOptions, h as CauthyPact, i as CauthySystem, j as CauthyTokenError, k as CauthyUnavailableError, l as CauthyWebhookError, m as CheckOf, n as CheckQuestion, o as CheckResult, p as CheckRule, q as ConditionalPermission, r as ContractOptions, J as JsonValue, M as MountTarget, N as NewMember, O as Organization, s as OrganizationMember, t as OrganizationRef, P as PactItem, u as PactStatus, v as PermissionOf, w as Permitted, x as Policy, y as PolicyDefinition, z as PolicyPermission, B as PolicyRole, D as PublicSession, E as PushPolicyOptions, R as ReplayStore, F as Resolved, G as ResolvedContract, H as RoleOf, I as STANDARD_VARIABLES, S as Session, K as SessionOrganization, L as SessionStatus, Q as SessionUser, T as SystemKey, U as SystemOptions, V as SystemPolicy, W as TokenIdentity, X as TokenRefusal, Y as VerifyTokenOptions, Z as VerifyWebhookOptions, _ as can, $ as createCauthy, a0 as createSystem, a1 as createTokenVerifier, a2 as createVerifierFromEnv, a3 as definePolicy, a4 as failClosed, a5 as memoryReplayStore, a6 as policySource, a7 as pullCatalog, a8 as pullPolicy, a9 as pushCatalog, aa as pushPolicy, ab as readContract, ac as remoteKeys, ad as verifyToken, ae as verifyWebhook } from './cauthy-C7gZ-pbv.js';
+export { I as Identity } from './identity-BTJ8NB_w.js';
 export { K as KeyStore, P as PactKeys, S as StoredKey } from './keys-D5k0omTb.js';
 export { CauthyTheme, ImportedTheme, PushThemeOptions, StackmythThemeOptions, StackmythTokens, ThemeFont, ThemeTexts, pushTheme, themeFromStackmyth, tokensFromStackmyth } from './theme.js';
 import 'jose';
 
+/**
+ * The variables CAUTHY_KEY replaces: set beside it, each is a second source
+ * of the same thing, and the application refuses to start (key/cauthy-key.md §10).
+ */
+declare const KEY_REPLACES: readonly ["CAUTHY_ISSUER", "CAUTHY_CLIENT_ID", "CAUTHY_CLIENT_SECRET", "CAUTHY_SYSTEM", "CAUTHY_TENANT", "CAUTHY_SYSTEM_KEY", "CAUTHY_SYSTEM_KEY_ID", "CAUTHY_BASE_URL", "CAUTHY_AUDIENCE", "CAUTHY_TENANT_ID"];
+/** What a CAUTHY_KEY names. Never logged, never printed. */
+interface CauthyKey {
+    /** Cauthy's origin, e.g. https://cauthy.api.example.com */
+    issuer: string;
+    clientId: string;
+    /** The 43-character secret segment: the HKDF input, as text. */
+    secret: string;
+}
+/** Reads a CAUTHY_KEY; throws CauthyKeyError with the reason, never the value. */
+declare function parseKey(text: string): CauthyKey;
+/** Writes a CAUTHY_KEY (what the dashboard does in the browser; here for tests and tools). */
+declare function composeKey(issuer: string, clientId: string, secret: string): string;
+
 interface ConnectOptions {
     /** The system's name, as its organizations are filed under: lowercase, digits, - or _. */
     system: string;
@@ -135,4 +154,4 @@ declare const PROTOCOL_VERSION = "1";
  */
 type NextStep = 'done' | 'mfa' | 'verify_email' | 'code' | 'passkey' | 'one_tap' | 'redirect';
 
-export { type AuthField, type ConnectOptions, type Connected, DEFAULT_PASSWORD_POLICY, type FieldProblem, MIN_PASSWORD, type NextStep, PROTOCOL_VERSION, type PasswordClass, type PasswordLocale, type PasswordPolicy, type PasswordReason, checkCode, checkEmail, checkName, checkNewPassword, checkPassword, connectSystem, describePasswordPolicy, explainPasswordProblems, passwordPolicyOf, passwordProblems };
+export { type AuthField, type CauthyKey, type ConnectOptions, type Connected, DEFAULT_PASSWORD_POLICY, type FieldProblem, KEY_REPLACES, MIN_PASSWORD, type NextStep, PROTOCOL_VERSION, type PasswordClass, type PasswordLocale, type PasswordPolicy, type PasswordReason, checkCode, checkEmail, checkName, checkNewPassword, checkPassword, composeKey, connectSystem, describePasswordPolicy, explainPasswordProblems, parseKey, passwordPolicyOf, passwordProblems };