@paakd/api 0.0.1

package/src/proto/stocknodes/v1/entities/stocknode.proto

@@ -0,0 +1,167 @@
+syntax = "proto3";
+
+
+import "buf/validate/validate.proto";
+
+message StockNodeAddress {
+  optional string id = 1;
+  string address_1 = 2;
+  string address_2 = 3;
+  string address_3 = 4;
+  string phone_number = 5;
+  string zip_code = 6;
+  string country = 7;
+  string country_code = 8;
+  string company = 9;
+  string city = 10;
+  string province = 11;
+  string state_code = 12;
+  string email_address = 13;
+}
+
+message StockNodeFulfillmentSet {
+  string id = 1;
+  string name = 2;
+  string type = 3;
+}
+
+message CreateStockNodeRequest {
+  string name = 1 [
+    (buf.validate.field).required = true
+  ];
+  optional string description = 2;
+  optional string contact_name = 3;
+  string contact_email = 4 [
+        (buf.validate.field).string.email = true
+    ];
+  repeated string tags = 5;
+  repeated string sales_channels = 6;
+  repeated string fulfillment_providers = 7;
+  StockNodeAddress address = 8;
+}
+
+message CreateStockNodeResponse {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  string contact_name = 4;
+  string contact_email = 5;
+  repeated string tags = 6;
+  repeated string sales_channels = 7;
+  repeated string fulfillment_providers = 8;
+  StockNodeAddress address = 9;
+  repeated StockNodeFulfillmentSet fulfillment_sets = 10;
+}
+
+message UpdateStockNodeRequest {
+  string id = 1 [
+    (buf.validate.field).required = true,
+    (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+  ];
+  optional string name = 2 ;
+  optional string description = 3;
+  optional string contact_name = 4;
+  optional string contact_email = 5 [
+        (buf.validate.field).string.email = true
+    ];
+  repeated string tags = 6;
+  repeated string sales_channels = 7;
+  repeated string fulfillment_providers = 8;
+  optional StockNodeAddress address = 9;
+}
+
+message UpdateStockNodeResponse {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  string contact_name = 4;
+  string contact_email = 5;
+  repeated string tags = 6;
+  repeated string sales_channels = 7;
+  repeated string fulfillment_providers = 8;
+  StockNodeAddress address = 9;
+  repeated StockNodeFulfillmentSet fulfillment_sets = 10;
+}
+
+message DeleteStockNodeRequest {
+  string id = 1 [
+    (buf.validate.field).required = true,
+    (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+  ];
+}
+
+message DeleteStockNodeResponse {
+  string id = 1;
+}
+
+message GetStockNodeRequest {
+  string id = 1 [
+    (buf.validate.field).required = true,
+    (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+  ];
+}
+
+message GetStockNodeResponse {
+  string id = 1;
+  string name = 2;
+  string description = 3;
+  string contact_name = 4;
+  string contact_email = 5;
+  repeated string tags = 6;
+  repeated string sales_channels = 7;
+  repeated string fulfillment_providers = 8;
+  StockNodeAddress address = 9;
+  repeated StockNodeFulfillmentSet fulfillment_sets = 10;
+}
+
+message ListStockNodesRequest {
+    int32 offset = 1 [
+      (buf.validate.field).int32.gte = 0
+    ];
+    uint32 limit = 2 [
+      (buf.validate.field).uint32.gte = 1,
+      (buf.validate.field).uint32.lte = 100
+    ];
+   optional string order_by = 3;
+   optional string filter = 4;
+   optional bool ascending = 5;
+   optional string request_path = 6;
+}
+
+message ListStockNodesResponse {
+  repeated CreateStockNodeResponse stock_nodes = 1;
+}
+
+enum FulfillmentSetType {
+  SHIPPING = 0;
+  PICKUP = 1;
+  DROPOFF = 2;
+}
+
+message AddFulfillmentSetRequest {
+  string name = 1;
+  FulfillmentSetType type = 2;
+  string stock_node_id = 3 [
+    (buf.validate.field).required = true,
+    (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+  ];
+}
+
+message AddFulfillmentSetResponse {
+    CreateStockNodeResponse stock_node = 1;
+}
+
+message RemoveFulfillmentSetRequest {
+    string stock_node_id = 1 [
+      (buf.validate.field).required = true,
+      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+    ];
+    string fulfillment_set_id = 2 [
+      (buf.validate.field).required = true,
+      (buf.validate.field).string.pattern = "^[a-z]{3}[_][0-9a-hjkmnp-tv-z]{26}$"
+    ];
+}
+
+message RemoveFulfillmentSetResponse {
+    CreateStockNodeResponse stock_node = 1;
+}

package/src/proto/stocknodes/v1/service.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+
+package apps.enterprise.interfaces.rpc.stocknodes.v1;
+
+option go_package = "paakd.com/packages/api/gen/stocknodes/v1;stocknodesv1";
+
+import "src/proto/stocknodes/v1/entities/stocknode.proto";
+
+service StockNodesService {
+  rpc RemoveFulfillmentSet(RemoveFulfillmentSetRequest) returns (RemoveFulfillmentSetResponse) {}
+  rpc AddFulfillmentSet(AddFulfillmentSetRequest) returns (AddFulfillmentSetResponse) {}
+  rpc CreateStockNode(CreateStockNodeRequest) returns (CreateStockNodeResponse) {}
+  rpc DeleteStockNode(DeleteStockNodeRequest) returns (DeleteStockNodeResponse) {}
+  rpc GetStockNode(GetStockNodeRequest) returns (GetStockNodeResponse) {}
+  rpc UpdateStockNode(UpdateStockNodeRequest) returns (UpdateStockNodeResponse) {
+       option idempotency_level = NO_SIDE_EFFECTS;
+  }
+  rpc ListStockNodes(ListStockNodesRequest) returns (ListStockNodesResponse) {
+       option idempotency_level = NO_SIDE_EFFECTS;
+  }
+}

package/src/registration.ts

@@ -0,0 +1,170 @@
+import { Code, ConnectError, createClient } from '@connectrpc/connect'
+import { createGrpcTransport } from '@connectrpc/connect-node'
+import { getCheckoutConfig } from '@paakd/config'
+import { AuthService } from '../gen/src/proto/auth/v1/service_pb'
+import type { RegisterRequest } from '../gen/src/proto/auth/v1/entities/auth_pb'
+import { brotliCompression } from './compressor/brotli'
+import {
+  createAuthenticationInterceptor,
+  createHeadersInterceptor,
+} from './interceptors'
+
+const localeMap: Record<string, number> = {
+  'en-GB': 0,
+  'en-US': 1,
+  'nl-NL': 2,
+  'de-DE': 3,
+  en: 0,
+}
+
+export interface RegisterCustomerRequest {
+  body: Omit<RegisterRequest, '$typeName'>
+  headers: Record<string, string | null>
+}
+
+interface VerifyEmailRequest {
+  body: {
+    email: string
+    locale: string
+    idempotencyKey?: string
+  }
+  headers: Record<string, string | null>
+}
+
+interface ValidateOTPRequest {
+  body: {
+    email: string
+    otp: string
+  }
+  headers: Record<string, string | null>
+}
+
+export async function verifyEmail({
+  body: { email, idempotencyKey, locale },
+  headers,
+}: VerifyEmailRequest) {
+  const checkoutConfig = await getCheckoutConfig()
+  const transport = createGrpcTransport({
+    baseUrl: checkoutConfig.enterpriseURL,
+    interceptors: [
+      createHeadersInterceptor(headers),
+      createAuthenticationInterceptor(checkoutConfig),
+    ],
+    acceptCompression: [brotliCompression],
+    sendCompression: brotliCompression,
+  })
+  const auth = createClient(AuthService, transport)
+
+  try {
+    const value = await auth.verifyEmail({
+      email,
+      locale: localeMap[locale] ?? 0,
+      idempotencyKey,
+    })
+
+    return {
+      value,
+      status: 'success',
+    }
+  } catch (err: unknown) {
+    if (err instanceof ConnectError) {
+      return {
+        code: err.code,
+        rawMessage: err.rawMessage,
+        message: err.rawMessage,
+        status: 'failed',
+      }
+    }
+
+    return {
+      code: Code.Internal,
+      rawMessage: 'An unexpected error occurred while verifying the email.',
+      message: 'An unexpected error occurred while verifying the email.',
+      status: 'failed',
+    } as unknown as ConnectError
+  }
+}
+
+export async function validateOTP({
+  body: { email, otp },
+  headers,
+}: ValidateOTPRequest) {
+  const checkoutConfig = await getCheckoutConfig()
+  const transport = createGrpcTransport({
+    baseUrl: checkoutConfig.enterpriseURL,
+    interceptors: [
+      createHeadersInterceptor(headers),
+      createAuthenticationInterceptor(checkoutConfig),
+    ],
+    acceptCompression: [brotliCompression],
+    sendCompression: brotliCompression,
+  })
+  const auth = createClient(AuthService, transport)
+
+  try {
+    const value = await auth.validateOTP({
+      email,
+      otp,
+    })
+
+    return {
+      value,
+      status: 'success',
+    }
+  } catch (err: unknown) {
+    if (err instanceof ConnectError) {
+      return {
+        code: err.code,
+        rawMessage: err.rawMessage,
+        message: err.rawMessage,
+        status: 'failed',
+      }
+    }
+
+    return {
+      code: Code.Internal,
+      rawMessage: 'An unexpected error occurred while validating the OTP.',
+      message: 'An unexpected error occurred while validating the OTP.',
+      status: 'failed',
+    } as unknown as ConnectError
+  }
+}
+
+export async function registerCustomer({
+  body: val,
+  headers,
+}: RegisterCustomerRequest) {
+  const checkoutConfig = await getCheckoutConfig()
+  const transport = createGrpcTransport({
+    baseUrl: checkoutConfig.enterpriseURL,
+    interceptors: [
+      createHeadersInterceptor(headers),
+      createAuthenticationInterceptor(checkoutConfig),
+    ],
+    acceptCompression: [brotliCompression],
+    sendCompression: brotliCompression,
+  })
+  const auth = createClient(AuthService, transport)
+
+  try {
+    await auth.register(val)
+    return {
+      status: 'success',
+    }
+  } catch (err: unknown) {
+    if (err instanceof ConnectError) {
+      return {
+        code: err.code,
+        rawMessage: err.rawMessage,
+        message: err.rawMessage,
+        status: 'failed',
+      }
+    }
+
+    return {
+      code: Code.Internal,
+      message: 'An unexpected error occurred during registration.',
+      status: 'failed',
+    } as unknown as ConnectError
+  }
+}

package/src/test-utils.ts

@@ -0,0 +1,176 @@
+import { ConnectError } from '@connectrpc/connect'
+import type { Checkout } from '@paakd/config'
+import { vi, type MockedFunction } from 'vitest'
+
+// Re-export for test files
+export type { Checkout, MockedFunction }
+
+/**
+ * Common mock client interface for service tests
+ */
+export type MockServiceClient = Record<
+  string,
+  MockedFunction<(...args: unknown[]) => unknown>
+>
+
+/**
+ * Mock Transport type
+ */
+export type Transport = any
+
+/**
+ * Base test context for API service tests
+ */
+export interface BaseTestContext {
+  client: MockServiceClient
+  config: Checkout
+  interceptors: Record<string, MockedFunction<(...args: unknown[]) => unknown>>
+  transport: Transport
+}
+
+/**
+ * Creates a mock ConnectError with proper prototype chain
+ * This ensures that instanceof ConnectError checks work correctly
+ */
+export function createMockConnectError(
+  code: number,
+  rawMessage: string,
+  message: string
+): ConnectError {
+  const error = {
+    code,
+    rawMessage,
+    message,
+    name: 'ConnectError',
+  } as ConnectError
+
+  Object.setPrototypeOf(error, ConnectError.prototype)
+  return error
+}
+
+/**
+ * Creates a default mock configuration used across API services
+ */
+export function createMockConfig(): Checkout {
+  return {
+    hostname: 'example.com',
+    cmsRemoteURL: 'https://cms.example.com',
+    enterpriseRemoteURL: 'https://enterprise.example.com',
+    cmsURL: 'https://cms-local.example.com',
+    enterpriseURL: 'https://enterprise.example.com',
+    secureCookiePassword: 'secure-cookie-password',
+    forestAPIKey: 'forest-api-key',
+    saleChannelAccessKey: 'channel-access',
+    salesChannelAPISecret: 'channel-secret',
+    storeAccessKey: 'store-access',
+    storeAPISecret: 'store-secret',
+    isProduction: false,
+    posthogKey: 'posthog-key',
+    posthogDomain: 'posthog.example.com',
+    posthogHost: 'posthog.example.com',
+    assetsPath: '/assets',
+    assetsDomain: 'assets.example.com',
+    turnstileKey: 'turnstile-key',
+    turnstileSecret: 'turnstile-secret',
+    redis: {
+      user: 'redis-user',
+      host: 'localhost',
+      password: 'redis-password',
+      port: 6379,
+    },
+  }
+}
+
+/**
+ * Creates a default mock interceptors object
+ */
+export function createMockInterceptors(): Record<
+  string,
+  MockedFunction<(...args: unknown[]) => unknown>
+> {
+  return {
+    headers: vi
+      .fn()
+      .mockReturnValue(Symbol('headers-interceptor')) as MockedFunction<
+      (...args: unknown[]) => unknown
+    >,
+    auth: vi.fn().mockReturnValue(Symbol('auth-interceptor')) as MockedFunction<
+      (...args: unknown[]) => unknown
+    >,
+    customer: vi
+      .fn()
+      .mockReturnValue(Symbol('customer-interceptor')) as MockedFunction<
+      (...args: unknown[]) => unknown
+    >,
+  }
+}
+
+/**
+ * Creates a mock gRPC transport
+ */
+export function createMockTransport(): Transport {
+  return {} as Transport
+}
+
+/**
+ * Helper to setup common mocks for API service tests
+ * Returns objects ready to be used with setupService functions
+ */
+export function setupCommonMocks(): {
+  config: Checkout
+  interceptors: Record<string, MockedFunction<(...args: unknown[]) => unknown>>
+  transport: Transport
+} {
+  const config = createMockConfig()
+  const interceptors = createMockInterceptors()
+  const transport = createMockTransport()
+
+  return {
+    config,
+    interceptors,
+    transport,
+  }
+}
+
+/**
+ * Clears all Vitest mocks - useful for test isolation
+ */
+export function clearAllMocks(): void {
+  vi.clearAllMocks()
+}
+
+/**
+ * Common error scenarios for testing
+ */
+export const COMMON_ERROR_SCENARIOS = {
+  INVALID_CREDENTIALS: {
+    code: 16,
+    message: 'UNAUTHENTICATED',
+    rawMessage: 'Invalid credentials provided',
+  },
+  NOT_FOUND: {
+    code: 5,
+    message: 'NOT_FOUND',
+    rawMessage: 'Resource not found',
+  },
+  PERMISSION_DENIED: {
+    code: 7,
+    message: 'PERMISSION_DENIED',
+    rawMessage: 'Permission denied',
+  },
+  INTERNAL_ERROR: {
+    code: 13,
+    message: 'INTERNAL',
+    rawMessage: 'Internal server error',
+  },
+  SERVICE_UNAVAILABLE: {
+    code: 14,
+    message: 'UNAVAILABLE',
+    rawMessage: 'Service temporarily unavailable',
+  },
+  INVALID_ARGUMENT: {
+    code: 3,
+    message: 'INVALID_ARGUMENT',
+    rawMessage: 'Invalid argument provided',
+  },
+} as const