@ankhorage/auth 0.0.0-stage → 0.1.2

package/src/capabilities/index.test.ts

@@ -0,0 +1,80 @@
+import { isCapability } from '@ankhorage/capability';
+import {
+  AUTH_EMPTY_INPUT_SCHEMA,
+  AUTH_NULLABLE_SESSION_RESULT_SCHEMA,
+  AUTH_OAUTH_COMPLETION_RESULT_SCHEMA,
+  AUTH_OAUTH_START_RESULT_SCHEMA,
+  AUTH_VOID_RESULT_SCHEMA,
+  COMPLETE_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+  PASSWORD_RESET_INPUT_SCHEMA,
+  SIGN_IN_INPUT_SCHEMA,
+  SIGN_IN_RESULT_SCHEMA,
+  SIGN_OUT_INPUT_SCHEMA,
+  SIGN_UP_INPUT_SCHEMA,
+  SIGN_UP_RESULT_SCHEMA,
+  START_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+  VERIFY_OTP_INPUT_SCHEMA,
+} from '@ankhorage/contracts/auth';
+import type { Capability } from '@ankhorage/contracts/capability';
+import { expect, test } from 'bun:test';
+
+import { CAPABILITIES } from './index.js';
+
+test('publishes only the canonical invocable auth descriptors', () => {
+  const capabilities: readonly Capability[] = CAPABILITIES;
+
+  expect(capabilities.every(isCapability)).toBe(true);
+  expect(capabilities.map(({ id }) => id)).toEqual([
+    'auth.signIn',
+    'auth.signUp',
+    'auth.signOut',
+    'auth.getSession',
+    'auth.refreshSession',
+    'auth.requestPasswordReset',
+    'auth.verifyOtp',
+    'auth.oauth.startAuthorization',
+    'auth.oauth.completeAuthorization',
+  ]);
+  expect(
+    capabilities.every(
+      (capability) =>
+        capability.owner === '@ankhorage/auth' &&
+        capability.access[0] === 'invoke' &&
+        capability.binding.kind === 'auth' &&
+        capability.binding.bindableAs[0] === 'target',
+    ),
+  ).toBe(true);
+});
+
+test('binds every descriptor schema to the released Contracts source', () => {
+  expect(CAPABILITIES.map((capability) => capability.input.schema)).toEqual([
+    SIGN_IN_INPUT_SCHEMA,
+    SIGN_UP_INPUT_SCHEMA,
+    SIGN_OUT_INPUT_SCHEMA,
+    AUTH_EMPTY_INPUT_SCHEMA,
+    AUTH_EMPTY_INPUT_SCHEMA,
+    PASSWORD_RESET_INPUT_SCHEMA,
+    VERIFY_OTP_INPUT_SCHEMA,
+    START_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+    COMPLETE_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+  ]);
+  expect(CAPABILITIES.map((capability) => capability.output.schema)).toEqual([
+    SIGN_IN_RESULT_SCHEMA,
+    SIGN_UP_RESULT_SCHEMA,
+    AUTH_VOID_RESULT_SCHEMA,
+    AUTH_NULLABLE_SESSION_RESULT_SCHEMA,
+    AUTH_NULLABLE_SESSION_RESULT_SCHEMA,
+    AUTH_VOID_RESULT_SCHEMA,
+    SIGN_IN_RESULT_SCHEMA,
+    AUTH_OAUTH_START_RESULT_SCHEMA,
+    AUTH_OAUTH_COMPLETION_RESULT_SCHEMA,
+  ]);
+});
+
+test('materializes the package metadata directly from the canonical catalog', async () => {
+  const manifest: unknown = JSON.parse(
+    await Bun.file(new URL('../../package.json', import.meta.url)).text(),
+  );
+
+  expect(manifest).toMatchObject({ ankh: { capabilities: CAPABILITIES } });
+});

package/src/capabilities/index.ts

@@ -0,0 +1,93 @@
+import {
+  AUTH_EMPTY_INPUT_SCHEMA,
+  AUTH_NULLABLE_SESSION_RESULT_SCHEMA,
+  AUTH_OAUTH_COMPLETION_RESULT_SCHEMA,
+  AUTH_OAUTH_START_RESULT_SCHEMA,
+  AUTH_VOID_RESULT_SCHEMA,
+  COMPLETE_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+  PASSWORD_RESET_INPUT_SCHEMA,
+  SIGN_IN_INPUT_SCHEMA,
+  SIGN_IN_RESULT_SCHEMA,
+  SIGN_OUT_INPUT_SCHEMA,
+  SIGN_UP_INPUT_SCHEMA,
+  SIGN_UP_RESULT_SCHEMA,
+  START_OAUTH_AUTHORIZATION_INPUT_SCHEMA,
+  VERIFY_OTP_INPUT_SCHEMA,
+} from '@ankhorage/contracts/auth';
+import type { Capability } from '@ankhorage/contracts/capability';
+
+/*** Define the provider-neutral authentication operations published by this package. */
+export const CAPABILITIES = [
+  {
+    id: 'auth.signIn',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: SIGN_IN_INPUT_SCHEMA },
+    output: { schema: SIGN_IN_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.signUp',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: SIGN_UP_INPUT_SCHEMA },
+    output: { schema: SIGN_UP_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.signOut',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: SIGN_OUT_INPUT_SCHEMA },
+    output: { schema: AUTH_VOID_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.getSession',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: AUTH_EMPTY_INPUT_SCHEMA },
+    output: { schema: AUTH_NULLABLE_SESSION_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.refreshSession',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: AUTH_EMPTY_INPUT_SCHEMA },
+    output: { schema: AUTH_NULLABLE_SESSION_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.requestPasswordReset',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: PASSWORD_RESET_INPUT_SCHEMA },
+    output: { schema: AUTH_VOID_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.verifyOtp',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: VERIFY_OTP_INPUT_SCHEMA },
+    output: { schema: SIGN_IN_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.oauth.startAuthorization',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: START_OAUTH_AUTHORIZATION_INPUT_SCHEMA },
+    output: { schema: AUTH_OAUTH_START_RESULT_SCHEMA },
+  },
+  {
+    id: 'auth.oauth.completeAuthorization',
+    owner: '@ankhorage/auth',
+    access: ['invoke'],
+    binding: { kind: 'auth', bindableAs: ['target'] },
+    input: { schema: COMPLETE_OAUTH_AUTHORIZATION_INPUT_SCHEMA },
+    output: { schema: AUTH_OAUTH_COMPLETION_RESULT_SCHEMA },
+  },
+] as const satisfies readonly Capability[];

package/src/features/auth/ports/authPort.ts

@@ -0,0 +1,27 @@
+import type {
+  AuthOAuthCompletionResult,
+  AuthOAuthStartResult,
+  AuthResult,
+  AuthSession,
+  AuthUser,
+  CompleteOAuthAuthorizationInput,
+  PasswordResetInput,
+  SignInInput,
+  SignOutInput,
+  SignUpInput,
+  StartOAuthAuthorizationInput,
+  VerifyOtpInput,
+} from '@ankhorage/contracts/auth';
+
+/*** Define the provider-neutral executable authentication boundary. */
+export interface AuthPort {
+  signIn(input: SignInInput): Promise<AuthResult<AuthSession>>;
+  signUp(input: SignUpInput): Promise<AuthResult<AuthSession | AuthUser>>;
+  signOut(input?: SignOutInput): Promise<AuthResult>;
+  getSession(): Promise<AuthResult<AuthSession | null>>;
+  refreshSession(): Promise<AuthResult<AuthSession | null>>;
+  requestPasswordReset(input: PasswordResetInput): Promise<AuthResult>;
+  verifyOtp(input: VerifyOtpInput): Promise<AuthResult<AuthSession>>;
+  startAuthorization(input: StartOAuthAuthorizationInput): Promise<AuthOAuthStartResult>;
+  completeAuthorization(input: CompleteOAuthAuthorizationInput): Promise<AuthOAuthCompletionResult>;
+}

package/src/index.test.ts

@@ -0,0 +1,35 @@
+import { expect, test } from 'bun:test';
+
+import type { AuthPort } from './index.js';
+import { CAPABILITIES } from './index.js';
+
+const AUTH_PORT_OPERATIONS = [
+  'signIn',
+  'signUp',
+  'signOut',
+  'getSession',
+  'refreshSession',
+  'requestPasswordReset',
+  'verifyOtp',
+  'startAuthorization',
+  'completeAuthorization',
+] as const satisfies readonly (keyof AuthPort)[];
+
+test('exports the neutral execution port for every canonical operation', () => {
+  expect(AUTH_PORT_OPERATIONS).toEqual([
+    'signIn',
+    'signUp',
+    'signOut',
+    'getSession',
+    'refreshSession',
+    'requestPasswordReset',
+    'verifyOtp',
+    'startAuthorization',
+    'completeAuthorization',
+  ]);
+  expect(CAPABILITIES).toHaveLength(AUTH_PORT_OPERATIONS.length);
+});
+
+test('publishes no provider implementation from the JavaScript surface', () => {
+  expect(Object.keys({ CAPABILITIES })).toEqual(['CAPABILITIES']);
+});

package/src/index.ts

@@ -0,0 +1,2 @@
+export { CAPABILITIES } from './capabilities/index.js';
+export type { AuthPort } from './features/auth/ports/authPort.js';