@voidhash/api-spec 0.0.1-alpha.1-canary.2.1.223955

package/src/errors/sdk.ts

@@ -0,0 +1,42 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic SDK service error */
+export class SdkServiceError extends Schema.TaggedError<SdkServiceError>()(
+  "SdkServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** SDK customer not found */
+export class SdkCustomerNotFoundError extends Schema.TaggedError<SdkCustomerNotFoundError>()(
+  "SdkCustomerNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** SDK customer already identified */
+export class SdkCustomerAlreadyIdentifiedError extends Schema.TaggedError<SdkCustomerAlreadyIdentifiedError>()(
+  "SdkCustomerAlreadyIdentifiedError",
+  {
+    appUserId: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 409 })
+) {
+  toString(): string {
+    return `The following customer was already identified: ${this.appUserId}`;
+  }
+}
+
+/** SDK validation error */
+export class SdkValidationError extends Schema.TaggedError<SdkValidationError>()(
+  "SdkValidationError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}

package/src/errors/user.ts

@@ -0,0 +1,11 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic user service error */
+export class UserServiceError extends Schema.TaggedError<UserServiceError>()(
+  "UserServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}

package/src/errors/webhook.ts

@@ -0,0 +1,38 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic webhook service error */
+export class WebhookServiceError extends Schema.TaggedError<WebhookServiceError>()(
+  "WebhookServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Webhook endpoint not found */
+export class WebhookEndpointNotFoundError extends Schema.TaggedError<WebhookEndpointNotFoundError>()(
+  "WebhookEndpointNotFoundError",
+  {
+    endpointId: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Webhook delivery not found */
+export class WebhookDeliveryNotFoundError extends Schema.TaggedError<WebhookDeliveryNotFoundError>()(
+  "WebhookDeliveryNotFoundError",
+  {
+    deliveryId: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Webhook validation error */
+export class WebhookValidationError extends Schema.TaggedError<WebhookValidationError>()(
+  "WebhookValidationError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}

package/src/index.ts

@@ -0,0 +1,5 @@
+export * from "./api";
+export * from "./auth";
+export * from "./changeset";
+export * from "./middlewares";
+export * from "./schema";

package/src/middlewares.ts

@@ -0,0 +1,32 @@
+import { HttpApiMiddleware, HttpApiSecurity } from "@effect/platform";
+import { Schema } from "effect";
+
+import { ApiAuthSession } from "./auth";
+import { AuthenticationError, NotAuthenticatedError } from "./errors";
+
+export class AuthMiddleware extends HttpApiMiddleware.Tag<AuthMiddleware>()(
+  "Http/AuthenticationMiddleware",
+  {
+    // Optionally define the error schema for the middleware
+    failure: Schema.Union(AuthenticationError, NotAuthenticatedError),
+    provides: ApiAuthSession,
+    security: {
+      apiKey: HttpApiSecurity.apiKey({
+        in: "header",
+        key: "x-api-key",
+      }),
+      betterAuthCookie: HttpApiSecurity.apiKey({
+        in: "cookie",
+        key: "__Secure-better-auth.session_token",
+      }),
+      publishableKey: HttpApiSecurity.apiKey({
+        in: "header",
+        key: "x-publishable-key",
+      }),
+      secretKey: HttpApiSecurity.apiKey({
+        in: "header",
+        key: "x-secret-key",
+      }),
+    },
+  }
+) {}

package/src/schema.ts

@@ -0,0 +1,535 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+import { ChangesetSchema } from "./changeset";
+
+export const PublishableKeyAuthHeaders = Schema.Struct({
+  "x-app-user-id": Schema.String,
+  "x-publishable-key": Schema.String,
+});
+
+export const ApiKeyAuthHeaders = Schema.Struct({
+  "x-api-key": Schema.String,
+});
+
+export const SecretKeyAuthHeaders = Schema.Struct({
+  "x-secret-key": Schema.String,
+});
+
+// ========================================================
+// Auth
+// ========================================================
+
+const SessionAuthMethods = Schema.Union(
+  Schema.Literal("api-key"),
+  Schema.Literal("publishable-key"),
+  Schema.Literal("secret-key")
+);
+
+export const Session = Schema.Struct({
+  method: SessionAuthMethods,
+  name: Schema.String,
+  organizations: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      name: Schema.String,
+      slug: Schema.String,
+    })
+  ),
+  projects: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      name: Schema.String,
+      organizationId: Schema.String,
+      slug: Schema.String,
+    })
+  ),
+});
+
+// ========================================================
+// API Keys
+// ========================================================
+
+export class ApiKey extends Schema.Class<ApiKey>("ApiKey")({
+  end: Schema.String,
+  id: Schema.String,
+  isPublic: Schema.Boolean,
+  name: Schema.String,
+  prefix: Schema.String,
+  projectId: Schema.String,
+  rawKey: Schema.optional(Schema.String),
+}) {}
+
+export class ApiKeyWithRawKey extends Schema.Class<ApiKeyWithRawKey>(
+  "ApiKeyWithRawKey"
+)({
+  end: Schema.String,
+  id: Schema.String,
+  isPublic: Schema.Boolean,
+  name: Schema.String,
+  prefix: Schema.String,
+  projectId: Schema.String,
+  rawKey: Schema.String,
+}) {}
+
+export class CreateSecretKeyBody extends Schema.Class<CreateSecretKeyBody>(
+  "CreateSecretKeyBody"
+)({
+  name: Schema.String,
+  projectId: Schema.String,
+}) {}
+
+export const ApiKeyIdParam = HttpApiSchema.param("apiKeyId", Schema.String);
+
+// ========================================================
+// Customers
+// ========================================================
+
+export class Customer extends Schema.Class<Customer>("Customer")({
+  appUserId: Schema.String,
+  email: Schema.NullOr(Schema.String),
+  id: Schema.String,
+  name: Schema.NullOr(Schema.String),
+}) {}
+
+export class CreateCustomerBody extends Schema.Class<CreateCustomerBody>(
+  "CreateCustomerBody"
+)({
+  appUserId: Schema.String,
+  email: Schema.optional(Schema.String),
+  name: Schema.optional(Schema.String),
+}) {}
+
+export const CustomerIdParam = HttpApiSchema.param("customerId", Schema.String);
+
+export const AppUserIdParam = HttpApiSchema.param("appUserId", Schema.String);
+
+// ========================================================
+// Organizations
+// ========================================================
+
+export class CreateOrganizationBody extends Schema.Class<CreateOrganizationBody>(
+  "CreateOrganizationBody"
+)({
+  name: Schema.String,
+}) {}
+
+export class Organization extends Schema.Class<Organization>("Organization")({
+  id: Schema.String,
+  name: Schema.String,
+  slug: Schema.String,
+}) {}
+
+// ========================================================
+// Perks
+// ========================================================
+
+export class Perk extends Schema.Class<Perk>("Perk")({
+  id: Schema.String,
+  name: Schema.String,
+  projectId: Schema.String,
+  slug: Schema.String,
+}) {}
+
+// ========================================================
+// Paywall Locations
+// ========================================================
+
+export class PaywallLocation extends Schema.Class<PaywallLocation>("PaywallLocation")({
+  description: Schema.NullOr(Schema.String),
+  id: Schema.String,
+  name: Schema.String,
+  projectId: Schema.String,
+  slug: Schema.String,
+}) {}
+
+// ========================================================
+// Products
+// ========================================================
+
+export const ProductType = Schema.Literal(
+  "subscription",
+  "one-time",
+  "one-time-consumable"
+);
+
+export class Product extends Schema.Class<Product>("Product")({
+  id: Schema.String,
+  name: Schema.String,
+  projectId: Schema.String,
+  slug: Schema.String,
+  type: ProductType,
+}) {}
+
+// ========================================================
+// Product Perks
+// ========================================================
+
+export const ProductIdParam = HttpApiSchema.param("productId", Schema.String);
+
+export class ProductPerk extends Schema.Class<ProductPerk>("ProductPerk")({
+  id: Schema.String,
+  perkId: Schema.String,
+  productId: Schema.String,
+}) {}
+
+// ========================================================
+// Payment Provider Configurations
+// ========================================================
+
+export class PaymentProviderConfiguration extends Schema.Class<PaymentProviderConfiguration>(
+  "PaymentProviderConfiguration"
+)({
+  enabled: Schema.Boolean,
+  id: Schema.String,
+  name: Schema.String,
+  projectId: Schema.String,
+  providerId: Schema.String,
+}) {}
+
+// ========================================================
+// Payment Provider Products
+// ========================================================
+
+export class PaymentProviderProduct extends Schema.Class<PaymentProviderProduct>(
+  "PaymentProviderProduct"
+)({
+  configuration: Schema.Record({ key: Schema.String, value: Schema.Unknown }),
+  id: Schema.String,
+  paymentProviderConfigurationId: Schema.String,
+  productId: Schema.String,
+  providerId: Schema.String,
+}) {}
+
+// ========================================================
+// Changesets
+// ========================================================
+
+export class DeployChangesetBody extends Schema.Class<DeployChangesetBody>(
+  "DeployChangesetBody"
+)({
+  changeset: ChangesetSchema,
+}) {}
+
+export class DeployChangesetResponse extends Schema.Class<DeployChangesetResponse>(
+  "DeployChangesetResponse"
+)({
+  deploymentId: Schema.String,
+}) {}
+
+// ========================================================
+// Projects
+// ========================================================
+
+export class CreateProjectBody extends Schema.Class<CreateProjectBody>(
+  "CreateProjectBody"
+)({
+  name: Schema.String,
+  organizationId: Schema.String,
+}) {}
+
+export class Project extends Schema.Class<Project>("Project")({
+  id: Schema.String,
+  name: Schema.String,
+  slug: Schema.String,
+}) {}
+
+export const OrganizationIdParam = HttpApiSchema.param(
+  "organizationId",
+  Schema.String
+);
+
+// ========================================================
+// SDK
+// ========================================================
+
+const CommonSdkHeaders = Schema.Struct({
+  "x-client-bundle-id": Schema.String,
+  "x-client-locale": Schema.optional(Schema.String),
+  "x-client-version": Schema.optional(Schema.String),
+  "x-is-backgrounded": Schema.Literal("false"),
+  "x-is-debug-build": Schema.Literal("true", "false"),
+  "x-nonce": Schema.optional(Schema.String),
+  "x-observer-mode": Schema.Literal("true", "false"),
+  "x-platform": Schema.String,
+  "x-platform-brand": Schema.optional(Schema.String),
+  "x-platform-device": Schema.optional(Schema.String),
+  "x-platform-flavor": Schema.Literal("native"),
+  "x-platform-flavor-version": Schema.optional(Schema.String),
+  "x-platform-version": Schema.optional(Schema.String),
+  "x-preferred-locales": Schema.optional(Schema.String),
+  "x-sdk": Schema.Literal("react-native"),
+  "x-sdk-version": Schema.String,
+  "x-storefront": Schema.optional(Schema.String),
+});
+
+export const SdkHeaders = Schema.Struct({
+  ...PublishableKeyAuthHeaders.fields,
+  ...CommonSdkHeaders.fields,
+});
+
+// SDK Identify
+export class SdkIdentifyBody extends Schema.Class<SdkIdentifyBody>(
+  "SdkIdentifyBody"
+)({
+  appUserId: Schema.String,
+  email: Schema.optional(Schema.String),
+  name: Schema.optional(Schema.String),
+}) {}
+
+// SDK Sync Customer Attributes
+export class SdkSyncCustomerAttributesBody extends Schema.Class<SdkSyncCustomerAttributesBody>(
+  "SdkSyncCustomerAttributesBody"
+)({
+  email: Schema.optional(Schema.String),
+  name: Schema.optional(Schema.String),
+}) {}
+
+export const SdkSyncTransactionBody = Schema.Struct({
+  platform: Schema.Literal("ios", "android"),
+  productId: Schema.String,
+  purchaseDate: Schema.Number,
+  purchaseToken: Schema.optional(Schema.String),
+  quantity: Schema.Number,
+  receipt: Schema.optional(Schema.String),
+  transactionId: Schema.String,
+});
+
+export class SdkSyncTransactionResponse extends Schema.Class<SdkSyncTransactionResponse>(
+  "SdkSyncTransactionResponse"
+)({
+  accepted: Schema.Boolean,
+}) {}
+
+export class SdkCustomer extends Schema.Class<SdkCustomer>("SdkCustomer")({
+  appUserId: Schema.String,
+  customerId: Schema.String,
+  email: Schema.NullOr(Schema.String),
+  name: Schema.NullOr(Schema.String),
+}) {}
+
+// ========================================================
+// User
+// ========================================================
+
+export class User extends Schema.Class<User>("User")({
+  createdAt: Schema.Date,
+  email: Schema.String,
+  emailVerified: Schema.Boolean,
+  id: Schema.String,
+  image: Schema.NullOr(Schema.String),
+  name: Schema.String,
+  organizations: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      logo: Schema.NullOr(Schema.String),
+      name: Schema.String,
+      slug: Schema.String,
+    })
+  ),
+  projects: Schema.Array(
+    Schema.Struct({
+      id: Schema.String,
+      logo: Schema.NullOr(Schema.String),
+      name: Schema.String,
+      organizationId: Schema.String,
+      slug: Schema.String,
+    })
+  ),
+  updatedAt: Schema.Date,
+}) {}
+
+// ========================================================
+// Webhooks
+// ========================================================
+
+export const WebhookEventType = Schema.Literal(
+  "customer.created",
+  "customer.updated",
+  "customer.deleted",
+  "subscription.created",
+  "subscription.renewed",
+  "subscription.cancelled",
+  "subscription.expired",
+  "purchase.completed",
+  "purchase.refunded"
+);
+
+export const WebhookEndpointStatus = Schema.Literal("active", "disabled", "failed");
+
+export const WebhookDeliveryStatus = Schema.Literal(
+  "pending",
+  "in_progress",
+  "succeeded",
+  "failed",
+  "exhausted"
+);
+
+export class WebhookEndpoint extends Schema.Class<WebhookEndpoint>(
+  "WebhookEndpoint"
+)({
+  consecutiveFailures: Schema.Number,
+  createdAt: Schema.NullOr(Schema.Date),
+  description: Schema.NullOr(Schema.String),
+  events: Schema.Array(WebhookEventType),
+  id: Schema.String,
+  lastSuccessAt: Schema.NullOr(Schema.Date),
+  name: Schema.String,
+  projectId: Schema.String,
+  secret: Schema.String,
+  status: WebhookEndpointStatus,
+  url: Schema.String,
+}) {}
+
+export class CreateWebhookEndpointBody extends Schema.Class<CreateWebhookEndpointBody>(
+  "CreateWebhookEndpointBody"
+)({
+  description: Schema.optional(Schema.String),
+  events: Schema.Array(Schema.String),
+  name: Schema.String,
+  url: Schema.String,
+}) {}
+
+export class UpdateWebhookEndpointBody extends Schema.Class<UpdateWebhookEndpointBody>(
+  "UpdateWebhookEndpointBody"
+)({
+  description: Schema.optional(Schema.NullOr(Schema.String)),
+  events: Schema.optional(Schema.Array(Schema.String)),
+  name: Schema.optional(Schema.String),
+  status: Schema.optional(Schema.Literal("active", "disabled")),
+  url: Schema.optional(Schema.String),
+}) {}
+
+export const WebhookEndpointIdParam = HttpApiSchema.param(
+  "endpointId",
+  Schema.String
+);
+
+export class WebhookDelivery extends Schema.Class<WebhookDelivery>(
+  "WebhookDelivery"
+)({
+  attemptCount: Schema.Number,
+  completedAt: Schema.NullOr(Schema.Date),
+  createdAt: Schema.NullOr(Schema.Date),
+  eventOccurredAt: Schema.Date,
+  eventType: Schema.String,
+  id: Schema.String,
+  maxAttempts: Schema.Number,
+  nextAttemptAt: Schema.NullOr(Schema.Date),
+  payload: Schema.Unknown,
+  projectId: Schema.String,
+  status: WebhookDeliveryStatus,
+  webhookEndpointId: Schema.String,
+}) {}
+
+export class WebhookDeliveryAttempt extends Schema.Class<WebhookDeliveryAttempt>(
+  "WebhookDeliveryAttempt"
+)({
+  attemptNumber: Schema.Number,
+  createdAt: Schema.NullOr(Schema.Date),
+  durationMs: Schema.NullOr(Schema.Number),
+  errorMessage: Schema.NullOr(Schema.String),
+  id: Schema.String,
+  responseBody: Schema.NullOr(Schema.String),
+  statusCode: Schema.NullOr(Schema.Number),
+  succeeded: Schema.Boolean,
+}) {}
+
+export class WebhookDeliveryWithAttempts extends Schema.Class<WebhookDeliveryWithAttempts>(
+  "WebhookDeliveryWithAttempts"
+)({
+  attemptCount: Schema.Number,
+  attempts: Schema.Array(WebhookDeliveryAttempt),
+  completedAt: Schema.NullOr(Schema.Date),
+  createdAt: Schema.NullOr(Schema.Date),
+  eventOccurredAt: Schema.Date,
+  eventType: Schema.String,
+  id: Schema.String,
+  maxAttempts: Schema.Number,
+  nextAttemptAt: Schema.NullOr(Schema.Date),
+  payload: Schema.Unknown,
+  projectId: Schema.String,
+  status: WebhookDeliveryStatus,
+  webhookEndpointId: Schema.String,
+}) {}
+
+export const WebhookDeliveryIdParam = HttpApiSchema.param(
+  "deliveryId",
+  Schema.String
+);
+
+// ========================================================
+// Feature Flags (SDK)
+// ========================================================
+
+export class EvaluateFeatureFlagsBody extends Schema.Class<EvaluateFeatureFlagsBody>(
+  "EvaluateFeatureFlagsBody"
+)({
+  flagKeys: Schema.optional(Schema.Array(Schema.String)),
+}) {}
+
+export class SdkFeatureFlagResult extends Schema.Class<SdkFeatureFlagResult>(
+  "SdkFeatureFlagResult"
+)({
+  enabled: Schema.Boolean,
+  key: Schema.String,
+  payload: Schema.NullOr(Schema.Unknown),
+  variantKey: Schema.NullOr(Schema.String),
+}) {}
+
+export class SdkFeatureFlagsResponse extends Schema.Class<SdkFeatureFlagsResponse>(
+  "SdkFeatureFlagsResponse"
+)({
+  flags: Schema.Array(SdkFeatureFlagResult),
+}) {}
+
+// ========================================================
+// Paywall Resolution (SDK)
+// ========================================================
+
+export class SdkResolvePaywallBody extends Schema.Class<SdkResolvePaywallBody>(
+  "SdkResolvePaywallBody"
+)({
+  locationSlug: Schema.String,
+}) {}
+
+const SdkResolvedPaywallShowingType = Schema.Literal(
+  "paywall_release",
+  "feature_flag"
+);
+
+const SdkResolvedPaywallShowingPaywall = Schema.Struct({
+  id: Schema.String,
+  name: Schema.String,
+  slug: Schema.String,
+});
+
+const SdkResolvedPaywallShowingPaywallRelease = Schema.Struct({
+  htmlUrl: Schema.String,
+  publishedAt: Schema.NullOr(Schema.Date),
+  releaseId: Schema.String,
+  version: Schema.Number,
+});
+
+export class SdkResolvedPaywallShowing extends Schema.Class<SdkResolvedPaywallShowing>(
+  "SdkResolvedPaywallShowing"
+)({
+  id: Schema.String,
+  paywall: Schema.NullOr(SdkResolvedPaywallShowingPaywall),
+  paywallId: Schema.NullOr(Schema.String),
+  paywallRelease: Schema.NullOr(SdkResolvedPaywallShowingPaywallRelease),
+  paywallReleaseId: Schema.NullOr(Schema.String),
+  startedAt: Schema.Date,
+  type: SdkResolvedPaywallShowingType,
+}) {}
+
+export class SdkResolvedPaywall extends Schema.Class<SdkResolvedPaywall>(
+  "SdkResolvedPaywall"
+)({
+  location: Schema.Struct({
+    id: Schema.String,
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+  showing: SdkResolvedPaywallShowing,
+}) {}