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

package/src/changeset.ts

@@ -0,0 +1,204 @@
+import { Schema } from "effect";
+
+// ============================================================================
+// Paywall Location Changes
+// ============================================================================
+
+export const PaywallLocationCreateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("create-paywall-location"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    description: Schema.optional(Schema.NullOr(Schema.String)),
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const PaywallLocationUpdateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("update-paywall-location"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    description: Schema.optional(Schema.NullOr(Schema.String)),
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const PaywallLocationArchiveChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("archive-paywall-location"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    slug: Schema.String,
+  }),
+});
+
+// ============================================================================
+// Perk Changes
+// ============================================================================
+
+export const PerkCreateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("create-perk"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const PerkUpdateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("update-perk"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const PerkDeleteChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("delete-perk"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    slug: Schema.String,
+  }),
+});
+
+// ============================================================================
+// Product Changes
+// ============================================================================
+
+export const ProductCreateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("create-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const ProductUpdateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("update-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    name: Schema.String,
+    slug: Schema.String,
+  }),
+});
+
+export const ProductDeleteChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("delete-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    slug: Schema.String,
+  }),
+});
+
+// ============================================================================
+// Product Perk Changes
+// ============================================================================
+
+export const ProductPerkCreateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("create-product-perk"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    perkSlug: Schema.String,
+    productSlug: Schema.String,
+  }),
+});
+
+export const ProductPerkDeleteChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("delete-product-perk"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    perkSlug: Schema.String,
+    productSlug: Schema.String,
+  }),
+});
+
+// ============================================================================
+// Payment Provider Product Changes
+// ============================================================================
+
+export const PaymentProviderProductCreateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("create-payment-provider-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    configuration: Schema.Record({ key: Schema.String, value: Schema.Unknown }),
+    productSlug: Schema.String,
+    providerId: Schema.String,
+  }),
+});
+
+export const PaymentProviderProductUpdateChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("update-payment-provider-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    configuration: Schema.Record({ key: Schema.String, value: Schema.Unknown }),
+    productSlug: Schema.String,
+    providerId: Schema.String,
+  }),
+});
+
+export const PaymentProviderProductDeleteChangeSchema = Schema.Struct({
+  changeType: Schema.Literal("delete-payment-provider-product"),
+  key: Schema.String,
+  payload: Schema.Struct({
+    productSlug: Schema.String,
+    providerId: Schema.String,
+  }),
+});
+
+// ============================================================================
+// Combined Schemas
+// ============================================================================
+
+export const ChangeSchema = Schema.Union(
+  PaywallLocationCreateChangeSchema,
+  PaywallLocationUpdateChangeSchema,
+  PaywallLocationArchiveChangeSchema,
+  PerkCreateChangeSchema,
+  PerkUpdateChangeSchema,
+  PerkDeleteChangeSchema,
+  ProductCreateChangeSchema,
+  ProductUpdateChangeSchema,
+  ProductDeleteChangeSchema,
+  ProductPerkCreateChangeSchema,
+  ProductPerkDeleteChangeSchema,
+  PaymentProviderProductCreateChangeSchema,
+  PaymentProviderProductUpdateChangeSchema,
+  PaymentProviderProductDeleteChangeSchema
+);
+
+export const ChangesetSchema = Schema.Struct({
+  changes: Schema.Array(ChangeSchema),
+});
+
+// ============================================================================
+// Utility Functions
+// ============================================================================
+
+export function sortChangeset(changeset: typeof ChangesetSchema.Type) {
+  const sortedChangeTypesByPriority: (typeof ChangeSchema.Type.changeType)[] = [
+    "create-paywall-location",
+    "create-perk",
+    "create-product",
+    "update-paywall-location",
+    "update-perk",
+    "update-product",
+    "create-product-perk",
+    "create-payment-provider-product",
+    "update-payment-provider-product",
+    "archive-paywall-location",
+    "delete-product-perk",
+    "delete-payment-provider-product",
+    "delete-product",
+    "delete-perk",
+  ];
+
+  const sortedChangeset = [...changeset.changes].sort(
+    (a, b) =>
+      sortedChangeTypesByPriority.indexOf(a.changeType) -
+      sortedChangeTypesByPriority.indexOf(b.changeType)
+  );
+
+  return sortedChangeset;
+}

package/src/errors/admin.ts

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

package/src/errors/analytics.ts

@@ -0,0 +1,29 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic analytics service error */
+export class AnalyticsServiceError extends Schema.TaggedError<AnalyticsServiceError>()(
+  "AnalyticsServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Invalid time range error */
+export class InvalidTimeRangeError extends Schema.TaggedError<InvalidTimeRangeError>()(
+  "InvalidTimeRangeError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}
+
+/** Invalid metric error */
+export class InvalidMetricError extends Schema.TaggedError<InvalidMetricError>()(
+  "InvalidMetricError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}

package/src/errors/api-key.ts

@@ -0,0 +1,20 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic API key service error */
+export class ApiKeyServiceError extends Schema.TaggedError<ApiKeyServiceError>()(
+  "ApiKeyServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** API key not found */
+export class ApiKeyNotFoundError extends Schema.TaggedError<ApiKeyNotFoundError>()(
+  "ApiKeyNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}

package/src/errors/billing.ts

@@ -0,0 +1,29 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic billing service error */
+export class BillingServiceError extends Schema.TaggedError<BillingServiceError>()(
+  "BillingServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Organization billing not found */
+export class OrganizationBillingNotFoundError extends Schema.TaggedError<OrganizationBillingNotFoundError>()(
+  "OrganizationBillingNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Invalid billing tier error */
+export class InvalidBillingTierError extends Schema.TaggedError<InvalidBillingTierError>()(
+  "InvalidBillingTierError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}

package/src/errors/changeset.ts

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

package/src/errors/common.ts

@@ -0,0 +1,30 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Action is forbidden due to insufficient permissions */
+export class ActionForbiddenError extends Schema.TaggedError<ActionForbiddenError>()(
+  "ActionForbiddenError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 403 })
+) {}
+
+/** Authentication failed */
+export class AuthenticationError extends Schema.TaggedError<AuthenticationError>()(
+  "AuthenticationError",
+  {
+    cause: Schema.String,
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** User is not authenticated */
+export class NotAuthenticatedError extends Schema.TaggedError<NotAuthenticatedError>()(
+  "NotAuthenticatedError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 401 })
+) {}

package/src/errors/customer.ts

@@ -0,0 +1,37 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic customer service error */
+export class CustomerServiceError extends Schema.TaggedError<CustomerServiceError>()(
+  "CustomerServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Customer not found */
+export class CustomerNotFoundError extends Schema.TaggedError<CustomerNotFoundError>()(
+  "CustomerNotFoundError",
+  {
+    id: Schema.NonEmptyString,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {
+  toString(): string {
+    return `The following customer not found: ${this.id}`;
+  }
+}
+
+/** Anonymous ID is invalid */
+export class CustomerInvalidAnonymousIdError extends Schema.TaggedError<CustomerInvalidAnonymousIdError>()(
+  "CustomerInvalidAnonymousIdError",
+  {
+    id: Schema.NonEmptyString,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {
+  toString(): string {
+    return `The following anonymous ID is invalid: ${this.id}`;
+  }
+}

package/src/errors/index.ts

@@ -0,0 +1,18 @@
+export * from "./admin";
+export * from "./analytics";
+export * from "./api-key";
+export * from "./billing";
+export * from "./changeset";
+export * from "./common";
+export * from "./customer";
+export * from "./organization";
+export * from "./payment-provider";
+export * from "./paywall";
+export * from "./paywall-location";
+export * from "./perk";
+export * from "./product";
+export * from "./product-perk";
+export * from "./project";
+export * from "./sdk";
+export * from "./user";
+export * from "./webhook";

package/src/errors/organization.ts

@@ -0,0 +1,20 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic organization service error */
+export class OrganizationServiceError extends Schema.TaggedError<OrganizationServiceError>()(
+  "OrganizationServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Organization not found */
+export class OrganizationNotFoundError extends Schema.TaggedError<OrganizationNotFoundError>()(
+  "OrganizationNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}

package/src/errors/payment-provider.ts

@@ -0,0 +1,74 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic payment provider configuration service error */
+export class PaymentProviderConfigurationServiceError extends Schema.TaggedError<PaymentProviderConfigurationServiceError>()(
+  "PaymentProviderConfigurationServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Payment provider configuration not found */
+export class PaymentProviderConfigurationNotFoundError extends Schema.TaggedError<PaymentProviderConfigurationNotFoundError>()(
+  "PaymentProviderConfigurationNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Payment provider configuration validation error */
+export class PaymentProviderConfigurationValidationError extends Schema.TaggedError<PaymentProviderConfigurationValidationError>()(
+  "PaymentProviderConfigurationValidationError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}
+
+/** Payment provider configuration key unavailable */
+export class PaymentProviderConfigurationKeyUnavailableError extends Schema.TaggedError<PaymentProviderConfigurationKeyUnavailableError>()(
+  "PaymentProviderConfigurationKeyUnavailableError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}
+
+/** Payment provider already exists */
+export class PaymentProviderAlreadyExistsError extends Schema.TaggedError<PaymentProviderAlreadyExistsError>()(
+  "PaymentProviderAlreadyExistsError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 409 })
+) {}
+
+/** Generic payment provider product service error */
+export class PaymentProviderProductServiceError extends Schema.TaggedError<PaymentProviderProductServiceError>()(
+  "PaymentProviderProductServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Payment provider product validation error */
+export class PaymentProviderProductValidationError extends Schema.TaggedError<PaymentProviderProductValidationError>()(
+  "PaymentProviderProductValidationError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}
+
+/** Payment provider product not found */
+export class PaymentProviderProductNotFoundError extends Schema.TaggedError<PaymentProviderProductNotFoundError>()(
+  "PaymentProviderProductNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}

package/src/errors/paywall-location.ts

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

package/src/errors/paywall.ts

@@ -0,0 +1,38 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic paywall service error */
+export class PaywallServiceError extends Schema.TaggedError<PaywallServiceError>()(
+  "PaywallServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Paywall not found */
+export class PaywallNotFoundError extends Schema.TaggedError<PaywallNotFoundError>()(
+  "PaywallNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Paywall slug already exists */
+export class PaywallSlugAlreadyExistsError extends Schema.TaggedError<PaywallSlugAlreadyExistsError>()(
+  "PaywallSlugAlreadyExistsError",
+  {
+    slug: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 409 })
+) {}
+
+/** Paywall publish error */
+export class PaywallPublishError extends Schema.TaggedError<PaywallPublishError>()(
+  "PaywallPublishError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}

package/src/errors/perk.ts

@@ -0,0 +1,33 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic perk service error */
+export class PerkServiceError extends Schema.TaggedError<PerkServiceError>()(
+  "PerkServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Perk not found */
+export class PerkNotFoundError extends Schema.TaggedError<PerkNotFoundError>()(
+  "PerkNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Perk slug already exists */
+export class PerkSlugAlreadyExistsError extends Schema.TaggedError<PerkSlugAlreadyExistsError>()(
+  "PerkSlugAlreadyExistsError",
+  {
+    slug: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 409 })
+) {
+  toString(): string {
+    return `The following perk slug already exists: ${this.slug}`;
+  }
+}

package/src/errors/product-perk.ts

@@ -0,0 +1,20 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic product perk service error */
+export class ProductPerkServiceError extends Schema.TaggedError<ProductPerkServiceError>()(
+  "ProductPerkServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Product perk validation error */
+export class ProductPerkValidationError extends Schema.TaggedError<ProductPerkValidationError>()(
+  "ProductPerkValidationError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 400 })
+) {}

package/src/errors/product.ts

@@ -0,0 +1,33 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic product service error */
+export class ProductServiceError extends Schema.TaggedError<ProductServiceError>()(
+  "ProductServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Product not found */
+export class ProductNotFoundError extends Schema.TaggedError<ProductNotFoundError>()(
+  "ProductNotFoundError",
+  {
+    message: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {}
+
+/** Product slug already exists */
+export class ProductSlugAlreadyExistsError extends Schema.TaggedError<ProductSlugAlreadyExistsError>()(
+  "ProductSlugAlreadyExistsError",
+  {
+    slug: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 409 })
+) {
+  toString(): string {
+    return `The following product slug already exists: ${this.slug}`;
+  }
+}

package/src/errors/project.ts

@@ -0,0 +1,24 @@
+import { HttpApiSchema } from "@effect/platform";
+import { Schema } from "effect";
+
+/** Generic project service error */
+export class ProjectServiceError extends Schema.TaggedError<ProjectServiceError>()(
+  "ProjectServiceError",
+  {
+    cause: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 500 })
+) {}
+
+/** Project not found */
+export class ProjectNotFoundError extends Schema.TaggedError<ProjectNotFoundError>()(
+  "ProjectNotFoundError",
+  {
+    projectId: Schema.String,
+  },
+  HttpApiSchema.annotations({ status: 404 })
+) {
+  toString(): string {
+    return `The following project not found: ${this.projectId}`;
+  }
+}