@productcraft/auth 1.0.0 → 1.1.0

package/dist/testing.d.cts

@@ -0,0 +1,32 @@
+/** Every operation name, as `resource.method`. */
+type OperationName = "acceptInvite" | "acceptTenantInvite" | "apiKeys.create" | "apiKeys.delete" | "apiKeys.list" | "apiKeys.rotate" | "apps.create" | "apps.delete" | "apps.list" | "apps.retrieve" | "apps.update" | "auditLogs.export" | "auditLogs.list" | "auditSink.disconnect" | "auditSink.replace" | "auditSink.retrieve" | "auditSink.rotateSecret" | "auditSink.setupStatus" | "auditSink.test" | "auditSink.update" | "authConfig.providers.check" | "authConfig.providers.delete" | "authConfig.providers.list" | "authConfig.providers.replace" | "authConfig.providers.retrieve" | "authConfig.providers.update" | "authConfig.retrieve" | "authConfig.update" | "clone" | "credentials.create" | "credentials.delete" | "credentials.list" | "credentials.retrieve" | "credentials.rotate" | "credentials.update" | "credentials.updateScopes" | "customDomains.apply" | "customDomains.check" | "customDomains.create" | "customDomains.delete" | "customDomains.export" | "customDomains.list" | "customDomains.retrieve" | "endUserInsights.retrieve" | "endUserInsights.users.retrieve" | "endUsers.bulkDelete" | "endUsers.bulkRevokeSessions" | "endUsers.bulkUpdateRole" | "endUsers.bulkUpdateStatus" | "endUsers.contacts.create" | "endUsers.contacts.delete" | "endUsers.contacts.list" | "endUsers.contacts.promote" | "endUsers.contacts.resendVerification" | "endUsers.delete" | "endUsers.export" | "endUsers.imports.create" | "endUsers.imports.retrieve" | "endUsers.invites.create" | "endUsers.invites.delete" | "endUsers.invites.list" | "endUsers.list" | "endUsers.mfa.requireReenrollment" | "endUsers.resendVerification" | "endUsers.retrieve" | "endUsers.sessions.revokeAll" | "endUsers.update" | "endUsers.updateRole" | "endUsers.updateStatus" | "exchangeProviderCode" | "logout" | "me.activity.list" | "me.changePassword" | "me.contacts.create" | "me.contacts.delete" | "me.contacts.list" | "me.contacts.promote" | "me.deleteAccount" | "me.deleteAvatar" | "me.mfa.factors.create" | "me.mfa.factors.delete" | "me.mfa.factors.list" | "me.mfa.factors.verify" | "me.mfa.recoveryCodes.regenerate" | "me.mfa.stepUp.sendCode" | "me.mfa.stepUp.verify" | "me.mfa.stepUp.webauthn.options" | "me.permissions" | "me.retrieve" | "me.sessions.delete" | "me.sessions.list" | "me.tenantInvites.accept" | "me.tenants.list" | "me.update" | "me.uploadAvatar" | "members.delete" | "members.list" | "mfa.enroll" | "mfa.recover" | "mfa.sendCode" | "mfa.verify" | "mfa.verifyEnrollment" | "mfa.webauthn.options" | "notificationSettings.retrieve" | "notificationSettings.update" | "notifications.test" | "oauth.introspect" | "oauth.token" | "passkey.options" | "passkey.verify" | "permissions.create" | "permissions.create" | "permissions.delete" | "permissions.delete" | "permissions.enforcement.list" | "permissions.list" | "permissions.list" | "refresh" | "requestPasswordReset" | "requestVerification" | "resetPassword" | "roles.assign" | "roles.create" | "roles.create" | "roles.delete" | "roles.delete" | "roles.list" | "roles.list" | "roles.permissions.list" | "roles.retrieve" | "roles.retrieve" | "roles.update" | "roles.update" | "roles.updatePermissions" | "roles.updatePermissions" | "sendPasswordResetEmail" | "sendVerificationEmail" | "setupStatus.retrieve" | "signInTests.create" | "signInTests.retrieve" | "signin" | "signinWithProvider" | "signup" | "stats.me" | "stats.retrieve" | "switchTenant" | "tenantApiKeys.config.retrieve" | "tenantApiKeys.config.retrieve" | "tenantApiKeys.config.update" | "tenantApiKeys.config.update" | "tenantApiKeys.create" | "tenantApiKeys.delete" | "tenantApiKeys.delete" | "tenantApiKeys.introspect" | "tenantApiKeys.list" | "tenantApiKeys.list" | "tenantApiKeys.rotate" | "tenantApiKeys.status" | "tenants.create" | "tenants.create" | "tenants.delete" | "tenants.delete" | "tenants.invites.create" | "tenants.invites.create" | "tenants.invites.delete" | "tenants.invites.delete" | "tenants.invites.list" | "tenants.invites.list" | "tenants.list" | "tenants.list" | "tenants.members.create" | "tenants.members.create" | "tenants.members.delete" | "tenants.members.delete" | "tenants.members.list" | "tenants.members.list" | "tenants.members.update" | "tenants.members.update" | "tenants.retrieve" | "tenants.retrieve" | "tenants.update" | "tenants.update" | "unverifiedAccountExpiry.retrieve" | "unverifiedAccountExpiry.run" | "updateStatus" | "users.create" | "users.delete" | "users.factors.create" | "users.factors.delete" | "users.factors.list" | "users.list" | "users.retrieve" | "users.update" | "users.updateRole" | "users.updateStatus" | "verify.authorize" | "verify.authorizeBatch" | "verify.token" | "verifyEmail" | "webauthnConfig.retrieve" | "webauthnConfig.update" | "webhooks.endpoints.create" | "webhooks.endpoints.delete" | "webhooks.endpoints.list" | "webhooks.endpoints.retrieve" | "webhooks.endpoints.rotateSecret" | "webhooks.endpoints.test" | "webhooks.endpoints.update" | "webhooks.eventTypes.list" | "webhooks.events.list" | "webhooks.events.replay" | "webhooks.events.retrieve" | "wellKnown.jwks" | "wellKnown.openidConfiguration";
+/** One request the mock received. */
+interface MockCall {
+    /** The matched operation, or `undefined` when nothing matched (the mock answers 404). */
+    operation: OperationName | undefined;
+    method: string;
+    url: URL;
+    headers: Headers;
+    /** The JSON-parsed body (the raw value when it is not JSON). */
+    body: unknown;
+}
+/** Answers one call: a `Response`, or a value sent as JSON with the operation's success status. */
+type MockHandler = (call: MockCall) => unknown;
+interface MockFetch {
+    (input: string | URL | Request, init?: RequestInit): Promise<Response>;
+    /** Every call, in order. */
+    readonly calls: MockCall[];
+}
+/**
+ * A `fetch` that answers every Auth operation with its spec example, for unit tests.
+ * Override an operation with a value (sent as its JSON body) or a handler.
+ *
+ * @example
+ * ```ts
+ * const fetch = createMockFetch();
+ * const auth = new Auth({ apiKey: "test", workspaceId: "9b2f6c1e-0d6a-4a63-9a43-2f1c3e4d5a6b", fetch });
+ * ```
+ */
+declare function createMockFetch(overrides?: Partial<Record<OperationName, unknown>>): MockFetch;
+
+export { type MockCall, type MockFetch, type MockHandler, type OperationName, createMockFetch };