@payark/sdk-effect 0.1.6 → 0.1.9

package/dist/api-spec.js

@@ -12,11 +12,17 @@ var UrlString = effect.Schema.String.pipe(
   effect.Schema.pattern(/^https?:\/\/.+/),
   effect.Schema.brand("UrlString")
 );
-var MinorUnitsInt = effect.Schema.Number.pipe(
+effect.Schema.Number.pipe(
   effect.Schema.int(),
   effect.Schema.greaterThan(0),
   effect.Schema.brand("MinorUnitsInt")
 );
+var NprAmount = effect.Schema.Number.pipe(
+  effect.Schema.filter(
+    (n) => Number.isFinite(n) && n > 0 && Math.round(n * 100) === n * 100
+  ),
+  effect.Schema.brand("NprAmount")
+);
 
 // src/schemas.ts
 var Id = effect.Schema.String.pipe(effect.Schema.brand("Id"));
@@ -28,6 +34,10 @@ var CheckoutSessionId = effect.Schema.String.pipe(
 var SubscriptionId = effect.Schema.String.pipe(
   effect.Schema.brand("SubscriptionId")
 );
+var MandateId = effect.Schema.String.pipe(effect.Schema.brand("MandateId"));
+var AgentSessionId = effect.Schema.String.pipe(
+  effect.Schema.brand("AgentSessionId")
+);
 var CustomerId = effect.Schema.String.pipe(effect.Schema.brand("CustomerId"));
 var TokenId = effect.Schema.String.pipe(effect.Schema.brand("TokenId"));
 var Email = effect.Schema.String.pipe(
@@ -46,6 +56,7 @@ effect.Schema.Struct({
 var Provider = effect.Schema.Literal(
   "esewa",
   "khalti",
+  "hamropay",
   "connectips",
   "imepay",
   "fonepay",
@@ -53,12 +64,27 @@ var Provider = effect.Schema.Literal(
 );
 var PaymentStatus = effect.Schema.Literal("pending", "success", "failed");
 var SubscriptionStatus = effect.Schema.Literal(
+  "pending_checkout",
   "active",
   "past_due",
   "canceled",
   "paused"
 );
 var SubscriptionInterval = effect.Schema.Literal("month", "year", "week");
+var CustomerLifecycle = effect.Schema.Literal(
+  "new",
+  "active",
+  "loyal",
+  "at_risk",
+  "churned"
+);
+var MandateType = effect.Schema.Literal("intent", "cart");
+var MandateStatus = effect.Schema.Literal(
+  "active",
+  "consumed",
+  "expired",
+  "violated"
+);
 var Customer = effect.Schema.Struct({
   id: CustomerId,
   merchant_customer_id: NonEmptyString,
@@ -67,12 +93,18 @@ var Customer = effect.Schema.Struct({
   phone: effect.Schema.NullOr(effect.Schema.String),
   project_id: ProjectId,
   metadata: effect.Schema.NullOr(Metadata),
+  total_ltv: effect.Schema.optional(effect.Schema.Number),
+  is_high_value: effect.Schema.optional(effect.Schema.Boolean),
+  lifecycle_stage: effect.Schema.optional(CustomerLifecycle),
+  ltv_cents: effect.Schema.optional(effect.Schema.Number),
+  tier: effect.Schema.NullOr(effect.Schema.String),
   created_at: Timestamp,
   updated_at: effect.Schema.optional(Timestamp)
 });
 var Payment = effect.Schema.Struct({
   id: PaymentId,
   project_id: ProjectId,
+  customer_id: effect.Schema.optional(effect.Schema.NullOr(CustomerId)),
   amount: effect.Schema.Number,
   currency: effect.Schema.String,
   status: PaymentStatus,
@@ -94,7 +126,9 @@ var Subscription = effect.Schema.Struct({
   current_period_start: Timestamp,
   current_period_end: Timestamp,
   payment_link: UrlString,
+  customer_email: effect.Schema.optional(effect.Schema.NullOr(effect.Schema.String)),
   auto_send_link: effect.Schema.Boolean,
+  grace_days: effect.Schema.optional(effect.Schema.Number),
   metadata: effect.Schema.optional(effect.Schema.NullOr(Metadata)),
   canceled_at: effect.Schema.optional(effect.Schema.NullOr(Timestamp)),
   created_at: Timestamp,
@@ -104,6 +138,13 @@ var Project = effect.Schema.Struct({
   id: ProjectId,
   name: NonEmptyString,
   api_key_secret: effect.Schema.String,
+  subscription_tier: effect.Schema.optional(
+    effect.Schema.Literal("free", "pro", "enterprise")
+  ),
+  subscription_status: effect.Schema.optional(
+    effect.Schema.Literal("active", "past_due", "canceled", "incomplete")
+  ),
+  expires_at: effect.Schema.optional(effect.Schema.NullOr(Timestamp)),
   created_at: Timestamp
 });
 var Token = effect.Schema.Struct({
@@ -114,6 +155,38 @@ var Token = effect.Schema.Struct({
   expires_at: effect.Schema.NullOr(Timestamp),
   created_at: Timestamp
 });
+var Mandate = effect.Schema.Struct({
+  id: MandateId,
+  project_id: ProjectId,
+  customer_id: effect.Schema.NullOr(CustomerId),
+  type: MandateType,
+  status: MandateStatus,
+  principal_id: effect.Schema.String,
+  max_amount: effect.Schema.Number,
+  currency: effect.Schema.String,
+  permitted_vendors: effect.Schema.NullOr(effect.Schema.Array(effect.Schema.String)),
+  valid_from: Timestamp,
+  valid_until: Timestamp,
+  credential_jwt: effect.Schema.String,
+  public_key: effect.Schema.String,
+  signature: effect.Schema.String,
+  parent_mandate_id: effect.Schema.NullOr(MandateId),
+  payment_id: effect.Schema.NullOr(PaymentId),
+  created_at: Timestamp,
+  consumed_at: effect.Schema.NullOr(Timestamp),
+  metadata_json: Metadata
+});
+effect.Schema.Struct({
+  id: AgentSessionId,
+  project_id: ProjectId,
+  context_id: effect.Schema.String,
+  agent_card_url: UrlString,
+  capabilities: effect.Schema.Any,
+  auth_scheme: effect.Schema.Literal("bearer", "mandate"),
+  status: effect.Schema.String,
+  created_at: Timestamp,
+  expires_at: Timestamp
+});
 var PaginationMeta = effect.Schema.Struct({
   total: effect.Schema.NullOr(effect.Schema.Number),
   limit: effect.Schema.Number,
@@ -127,6 +200,8 @@ var WebhookEventType = effect.Schema.Literal(
   "payment.success",
   "payment.failed",
   "subscription.created",
+  "subscription.activated",
+  "subscription.renewed",
   "subscription.payment_succeeded",
   "subscription.payment_failed",
   "subscription.renewal_due",
@@ -151,13 +226,15 @@ effect.Schema.Struct({
   created: effect.Schema.optional(effect.Schema.Number)
 });
 var CreateCheckoutParams = effect.Schema.Struct({
-  amount: effect.Schema.optional(MinorUnitsInt),
+  amount: effect.Schema.optional(NprAmount),
   currency: effect.Schema.optionalWith(effect.Schema.String, { default: () => "NPR" }),
   provider: Provider,
   returnUrl: UrlString,
   cancelUrl: effect.Schema.optional(UrlString),
   metadata: effect.Schema.optional(Metadata),
-  subscriptionId: effect.Schema.optional(SubscriptionId)
+  subscriptionId: effect.Schema.optional(SubscriptionId),
+  customerId: effect.Schema.optional(CustomerId),
+  mandate_id: effect.Schema.optional(MandateId)
 }).pipe(
   effect.Schema.filter((data) => {
     if (!data.subscriptionId && !data.amount) {
@@ -169,6 +246,7 @@ var CreateCheckoutParams = effect.Schema.Struct({
 var CheckoutSession = effect.Schema.Struct({
   id: CheckoutSessionId,
   checkout_url: UrlString,
+  qr_string: effect.Schema.optional(effect.Schema.String),
   payment_method: effect.Schema.Struct({
     type: Provider,
     url: effect.Schema.optional(UrlString),
@@ -202,22 +280,27 @@ var UpdateCustomerParams = effect.Schema.Struct({
   email: effect.Schema.optional(Email),
   name: effect.Schema.optional(NonEmptyString),
   phone: effect.Schema.optional(effect.Schema.String),
+  tier: effect.Schema.optional(effect.Schema.String),
+  merchant_customer_id: effect.Schema.optional(effect.Schema.String),
   metadata: effect.Schema.optional(Metadata)
 });
 var CreateSubscriptionParams = effect.Schema.Struct({
   customer_id: CustomerId,
-  amount: MinorUnitsInt,
+  amount: NprAmount,
   currency: effect.Schema.optionalWith(effect.Schema.String, { default: () => "NPR" }),
   interval: SubscriptionInterval,
   interval_count: effect.Schema.optional(effect.Schema.Number),
   project_id: effect.Schema.optional(ProjectId),
+  customer_email: effect.Schema.optional(effect.Schema.String),
   auto_send_link: effect.Schema.optional(effect.Schema.Boolean),
   metadata: effect.Schema.optional(Metadata)
 });
-var CallbackQueryParams = effect.Schema.Struct({
+effect.Schema.Struct({
   payment_id: effect.Schema.optional(effect.Schema.String),
   data: effect.Schema.optional(effect.Schema.String),
-  pidx: effect.Schema.optional(effect.Schema.String)
+  pidx: effect.Schema.optional(effect.Schema.String),
+  /** HamroPay-specific: the gateway's own transactionId returned on callback. */
+  ref_id: effect.Schema.optional(effect.Schema.String)
 });
 var ListSubscriptionsParams = effect.Schema.Struct({
   limit: effect.Schema.optional(effect.Schema.NumberFromString),
@@ -235,7 +318,8 @@ effect.Schema.Struct({
   baseUrl: effect.Schema.optional(effect.Schema.String),
   timeout: effect.Schema.optional(effect.Schema.Number),
   maxRetries: effect.Schema.optional(effect.Schema.Number),
-  sandbox: effect.Schema.optional(effect.Schema.Boolean)
+  sandbox: effect.Schema.optional(effect.Schema.Boolean),
+  signingPrivateKey: effect.Schema.optional(effect.Schema.String)
 });
 effect.Schema.Struct({
   error: effect.Schema.String,
@@ -245,21 +329,30 @@ var IndustrialError = class extends effect.Schema.TaggedError()(
   "IndustrialError",
   {
     error: effect.Schema.String,
-    details: effect.Schema.optional(effect.Schema.Any)
+    details: effect.Schema.optional(effect.Schema.Any),
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
   }
 ) {
 };
 var AuthenticationError = class extends effect.Schema.TaggedError()(
   "AuthenticationError",
   {
-    error: effect.Schema.String
+    error: effect.Schema.String,
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
   }
 ) {
 };
 var NotFoundError = class extends effect.Schema.TaggedError()(
   "NotFoundError",
   {
-    error: effect.Schema.String
+    error: effect.Schema.String,
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
   }
 ) {
 };
@@ -267,14 +360,43 @@ var InternalServerError = class extends effect.Schema.TaggedError()(
   "InternalServerError",
   {
     error: effect.Schema.String,
-    details: effect.Schema.optional(effect.Schema.Any)
+    details: effect.Schema.optional(effect.Schema.Any),
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
   }
 ) {
 };
 var ConflictError = class extends effect.Schema.TaggedError()(
   "ConflictError",
   {
-    error: effect.Schema.String
+    error: effect.Schema.String,
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
+  }
+) {
+};
+var MandateViolationError = class extends effect.Schema.TaggedError()(
+  "MandateViolationError",
+  {
+    error: effect.Schema.String,
+    mandateId: effect.Schema.optional(effect.Schema.String),
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
+  }
+) {
+};
+var MandateExpiredError = class extends effect.Schema.TaggedError()(
+  "MandateExpiredError",
+  {
+    error: effect.Schema.String,
+    mandateId: MandateId,
+    expiredAt: Timestamp,
+    code: effect.Schema.optional(effect.Schema.String),
+    doc_url: effect.Schema.optional(effect.Schema.String),
+    suggestion: effect.Schema.optional(effect.Schema.String)
   }
 ) {
 };
@@ -365,7 +487,22 @@ var AutomationGroup = platform.HttpApiGroup.make("automation").add(
   platform.HttpApiEndpoint.post("reaper", "/reaper").addSuccess(
     effect.Schema.Struct({
       message: effect.Schema.String,
-      count: effect.Schema.Number
+      count: effect.Schema.Number,
+      purged_projects: effect.Schema.Number
+    })
+  ).addError(InternalServerError, { status: 500 })
+).add(
+  platform.HttpApiEndpoint.post("processRenewals", "/process-renewals").addSuccess(
+    effect.Schema.Struct({
+      message: effect.Schema.String,
+      emails_sent: effect.Schema.Number
+    })
+  ).addError(InternalServerError, { status: 500 })
+).add(
+  platform.HttpApiEndpoint.post("processGracePeriod", "/process-grace-period").addSuccess(
+    effect.Schema.Struct({
+      message: effect.Schema.String,
+      marked_past_due: effect.Schema.Number
     })
   ).addError(InternalServerError, { status: 500 })
 ).prefix("/v1/automation").middleware(CronSecurity);
@@ -391,10 +528,30 @@ var TokensGroup = platform.HttpApiGroup.make("tokens").add(
 ).prefix("/v1/tokens").middleware(UserSecurity);
 var ProjectsGroup = platform.HttpApiGroup.make("projects").add(
   platform.HttpApiEndpoint.get("list", "/").addSuccess(effect.Schema.Array(Project)).addError(AuthenticationError, { status: 401 }).addError(InternalServerError, { status: 500 })
-).prefix("/v1/projects").middleware(SecurityMiddleware);
+).add(
+  platform.HttpApiEndpoint.post("upgrade", "/:id/upgrade").addSuccess(Project).setPath(effect.Schema.Struct({ id: ProjectId })).setPayload(effect.Schema.Struct({ tier: effect.Schema.Literal("pro", "enterprise") })).addError(AuthenticationError, { status: 401 }).addError(InternalServerError, { status: 500 })
+).prefix("/v1/projects").middleware(UserSecurity);
+var PaymentCallbackQueryParams = effect.Schema.Struct({
+  payment_id: effect.Schema.optional(effect.Schema.String),
+  data: effect.Schema.optional(effect.Schema.String),
+  pidx: effect.Schema.optional(effect.Schema.String),
+  /** HamroPay-specific: the gateway's own transactionId returned on callback. */
+  ref_id: effect.Schema.optional(effect.Schema.String),
+  /** Supabase Auth: access_token and refresh_token can be in the fragment or query */
+  access_token: effect.Schema.optional(effect.Schema.String),
+  refresh_token: effect.Schema.optional(effect.Schema.String),
+  code: effect.Schema.optional(effect.Schema.String)
+});
 var CallbacksGroup = platform.HttpApiGroup.make("callbacks").add(
-  platform.HttpApiEndpoint.get("handle", "/:provider").addSuccess(effect.Schema.Any).setPath(effect.Schema.Struct({ provider: effect.Schema.String })).setUrlParams(CallbackQueryParams).addError(NotFoundError, { status: 404 }).addError(InternalServerError, { status: 500 }).addError(IndustrialError, { status: 400 })
+  platform.HttpApiEndpoint.get("handle", "/:provider").addSuccess(effect.Schema.Any).setPath(effect.Schema.Struct({ provider: effect.Schema.String })).setUrlParams(PaymentCallbackQueryParams).addError(NotFoundError, { status: 404 }).addError(InternalServerError, { status: 500 }).addError(IndustrialError, { status: 400 })
 ).prefix("/v1/callback");
+var AuthCallbackQueryParams = effect.Schema.Struct({
+  code: effect.Schema.optional(effect.Schema.String),
+  next: effect.Schema.optional(effect.Schema.String)
+});
+var AuthGroup = platform.HttpApiGroup.make("auth").add(
+  platform.HttpApiEndpoint.post("callback", "/callback").addSuccess(effect.Schema.Any).setUrlParams(AuthCallbackQueryParams).addError(AuthenticationError, { status: 401 }).addError(InternalServerError, { status: 500 })
+).prefix("/auth");
 var RealtimeGroup = platform.HttpApiGroup.make("realtime").add(
   platform.HttpApiEndpoint.get("connect", "/").addSuccess(effect.Schema.Any).setUrlParams(effect.Schema.Struct({ token: effect.Schema.String })).addError(AuthenticationError, { status: 401 }).addError(InternalServerError, { status: 500 })
 ).add(
@@ -405,9 +562,66 @@ var RealtimeGroup = platform.HttpApiGroup.make("realtime").add(
     })
   ).setPayload(RealtimeTriggerPayload).setUrlParams(effect.Schema.Struct({ token: effect.Schema.optional(effect.Schema.String) })).addError(AuthenticationError, { status: 401 }).addError(InternalServerError, { status: 500 })
 ).prefix("/v1/realtime");
-var PayArkApi = platform.HttpApi.make("PayArkApi").add(CheckoutGroup).add(PaymentsGroup).add(CustomersGroup).add(SubscriptionsGroup).add(AutomationGroup).add(TokensGroup).add(ProjectsGroup).add(CallbacksGroup).add(RealtimeGroup).addError(AuthenticationError, { status: 401 }).addError(NotFoundError, { status: 404 }).addError(ConflictError, { status: 409 }).addError(InternalServerError, { status: 500 }).addError(IndustrialError, { status: 400 });
+var MandatesGroup = platform.HttpApiGroup.make("mandates").add(
+  platform.HttpApiEndpoint.post("registerIntent", "/intent").addSuccess(Mandate, { status: 201 }).setPayload(
+    effect.Schema.Struct({
+      principal_id: effect.Schema.String,
+      max_amount: effect.Schema.Number,
+      currency: effect.Schema.String,
+      valid_until: Timestamp,
+      permitted_vendors: effect.Schema.optional(effect.Schema.Array(effect.Schema.String)),
+      credential_jwt: effect.Schema.String,
+      public_key: effect.Schema.String,
+      customer_id: effect.Schema.optional(CustomerId)
+    })
+  ).addError(AuthenticationError, { status: 401 }).addError(IndustrialError, { status: 400 })
+).add(
+  platform.HttpApiEndpoint.get("retrieve", "/:id").addSuccess(Mandate).setPath(effect.Schema.Struct({ id: MandateId })).addError(AuthenticationError, { status: 401 }).addError(NotFoundError, { status: 404 })
+).prefix("/v1/mandates").middleware(SecurityMiddleware);
+var SandboxGroup = platform.HttpApiGroup.make("sandbox").add(
+  platform.HttpApiEndpoint.post("init", "/init").addSuccess(
+    effect.Schema.Struct({
+      projectId: effect.Schema.String,
+      apiKey: effect.Schema.optional(effect.Schema.String),
+      expiresAt: Timestamp,
+      session: effect.Schema.optional(
+        effect.Schema.Struct({
+          access_token: effect.Schema.String,
+          refresh_token: effect.Schema.String
+        })
+      )
+    })
+  ).addError(InternalServerError, { status: 500 })
+).prefix("/v1/sandbox").middleware(UserSecurity);
+var DiscoveryGroup = platform.HttpApiGroup.make("discovery").add(
+  platform.HttpApiEndpoint.get("agentCard", "/agent.json").addSuccess(effect.Schema.Any).addError(InternalServerError, { status: 500 })
+).prefix("/.well-known");
+var SigningKeysGroup = platform.HttpApiGroup.make("signingKeys").add(
+  platform.HttpApiEndpoint.post("generate", "/").addSuccess(
+    effect.Schema.Struct({
+      id: effect.Schema.String,
+      publicKey: effect.Schema.String,
+      privateKey: effect.Schema.String,
+      algorithm: effect.Schema.String,
+      createdAt: Timestamp
+    }),
+    { status: 201 }
+  ).setPath(effect.Schema.Struct({ id: ProjectId })).addError(AuthenticationError, { status: 401 }).addError(NotFoundError, { status: 404 }).addError(InternalServerError, { status: 500 })
+).add(
+  platform.HttpApiEndpoint.get("get", "/").addSuccess(
+    effect.Schema.Struct({
+      id: effect.Schema.String,
+      publicKey: effect.Schema.String,
+      algorithm: effect.Schema.String,
+      createdAt: Timestamp
+    })
+  ).setPath(effect.Schema.Struct({ id: ProjectId })).addError(AuthenticationError, { status: 401 }).addError(NotFoundError, { status: 404 }).addError(InternalServerError, { status: 500 })
+).prefix("/v1/projects/:id/signing-keys").middleware(UserSecurity);
+var PayArkApi = platform.HttpApi.make("PayArkApi").add(CheckoutGroup).add(PaymentsGroup).add(CustomersGroup).add(SubscriptionsGroup).add(AutomationGroup).add(TokensGroup).add(ProjectsGroup).add(CallbacksGroup).add(AuthGroup).add(MandatesGroup).add(DiscoveryGroup).add(RealtimeGroup).add(SandboxGroup).add(SigningKeysGroup).addError(AuthenticationError, { status: 401 }).addError(NotFoundError, { status: 404 }).addError(MandateViolationError, { status: 403 }).addError(MandateExpiredError, { status: 410 }).addError(ConflictError, { status: 409 }).addError(InternalServerError, { status: 500 }).addError(IndustrialError, { status: 400 });
 
+exports.AuthCallbackQueryParams = AuthCallbackQueryParams;
 exports.AuthContext = AuthContext;
+exports.AuthGroup = AuthGroup;
 exports.AuthenticationError = AuthenticationError;
 exports.AutomationGroup = AutomationGroup;
 exports.CallbacksGroup = CallbacksGroup;
@@ -415,14 +629,21 @@ exports.CheckoutGroup = CheckoutGroup;
 exports.ConflictError = ConflictError;
 exports.CronSecurity = CronSecurity;
 exports.CustomersGroup = CustomersGroup;
+exports.DiscoveryGroup = DiscoveryGroup;
 exports.IndustrialError = IndustrialError;
 exports.InternalServerError = InternalServerError;
+exports.MandateExpiredError = MandateExpiredError;
+exports.MandateViolationError = MandateViolationError;
+exports.MandatesGroup = MandatesGroup;
 exports.NotFoundError = NotFoundError;
 exports.PayArkApi = PayArkApi;
+exports.PaymentCallbackQueryParams = PaymentCallbackQueryParams;
 exports.PaymentsGroup = PaymentsGroup;
 exports.ProjectsGroup = ProjectsGroup;
 exports.RealtimeGroup = RealtimeGroup;
+exports.SandboxGroup = SandboxGroup;
 exports.SecurityMiddleware = SecurityMiddleware;
+exports.SigningKeysGroup = SigningKeysGroup;
 exports.SubscriptionsGroup = SubscriptionsGroup;
 exports.TokensGroup = TokensGroup;
 exports.UserSecurity = UserSecurity;