@rpcbase/db 0.24.0 → 0.25.0

package/dist/index.js

@@ -31,6 +31,142 @@ const RBTenantSchema = new Schema({
   parentTenantId: { type: String },
   name: { type: String }
 }, { collection: "tenants" });
+const ZRBTenantSubscriptionStatus = z.enum([
+  "trialing",
+  "active",
+  "past_due",
+  "paused",
+  "canceled",
+  "expired"
+]);
+const ZRBTenantSubscriptionIntervalUnit = z.enum(["day", "month", "year"]);
+const ZRBTenantSubscriptionType = z.enum(["primary", "addon"]);
+const ZRBTenantSubscriptionScope = z.enum(["tenant", "shop", "custom"]);
+const ZRBTenantSubscription = z.object({
+  tenantId: z.string(),
+  subscriptionId: z.string(),
+  type: ZRBTenantSubscriptionType.optional(),
+  parentSubscriptionId: z.string().optional(),
+  scope: ZRBTenantSubscriptionScope.optional(),
+  scopeId: z.string().optional(),
+  planKey: z.string(),
+  status: ZRBTenantSubscriptionStatus,
+  intervalUnit: ZRBTenantSubscriptionIntervalUnit,
+  intervalCount: z.number().int().min(1).optional(),
+  modules: z.array(z.string()).optional(),
+  currentPeriodStart: z.date().optional(),
+  currentPeriodEnd: z.date().optional(),
+  trialEndsAt: z.date().optional(),
+  cancelAt: z.date().optional(),
+  cancelAtPeriodEnd: z.boolean().optional(),
+  canceledAt: z.date().optional(),
+  provider: z.string().optional(),
+  providerCustomerId: z.string().optional(),
+  providerSubscriptionId: z.string().optional(),
+  latestEventId: z.string().optional(),
+  latestEventAt: z.date().optional(),
+  metadata: z.record(z.string(), z.unknown()).optional()
+});
+const RBTenantSubscriptionSchema = new Schema(
+  {
+    tenantId: { type: String, required: true, index: true },
+    subscriptionId: { type: String, required: true },
+    type: { type: String, required: true, enum: ZRBTenantSubscriptionType.options, default: "primary" },
+    parentSubscriptionId: { type: String },
+    scope: { type: String, enum: ZRBTenantSubscriptionScope.options, default: "tenant" },
+    scopeId: { type: String },
+    planKey: { type: String, required: true },
+    status: { type: String, required: true, enum: ZRBTenantSubscriptionStatus.options },
+    intervalUnit: { type: String, required: true, enum: ZRBTenantSubscriptionIntervalUnit.options },
+    intervalCount: { type: Number, min: 1, default: 1 },
+    modules: { type: [String], default: [] },
+    currentPeriodStart: { type: Date },
+    currentPeriodEnd: { type: Date },
+    trialEndsAt: { type: Date },
+    cancelAt: { type: Date },
+    cancelAtPeriodEnd: { type: Boolean, default: false },
+    canceledAt: { type: Date },
+    provider: { type: String },
+    providerCustomerId: { type: String },
+    providerSubscriptionId: { type: String },
+    latestEventId: { type: String },
+    latestEventAt: { type: Date },
+    metadata: { type: Schema.Types.Mixed }
+  },
+  {
+    collection: "tenantSubscriptions"
+  }
+);
+RBTenantSubscriptionSchema.index({ tenantId: 1, subscriptionId: 1 }, { unique: true });
+RBTenantSubscriptionSchema.index({ tenantId: 1, scope: 1, scopeId: 1 });
+const ZRBTenantSubscriptionEventSource = z.enum([
+  "admin",
+  "system",
+  "webhook",
+  "user"
+]);
+const ZRBTenantSubscriptionChangeDirection = z.enum([
+  "upgrade",
+  "downgrade",
+  "lateral"
+]);
+const ZRBTenantSubscriptionEvent = z.object({
+  tenantId: z.string(),
+  subscriptionId: z.string(),
+  type: z.string(),
+  occurredAt: z.date(),
+  effectiveAt: z.date().optional(),
+  fromPlanKey: z.string().optional(),
+  toPlanKey: z.string().optional(),
+  fromStatus: ZRBTenantSubscriptionStatus.optional(),
+  toStatus: ZRBTenantSubscriptionStatus.optional(),
+  fromModules: z.array(z.string()).optional(),
+  toModules: z.array(z.string()).optional(),
+  fromIntervalUnit: ZRBTenantSubscriptionIntervalUnit.optional(),
+  toIntervalUnit: ZRBTenantSubscriptionIntervalUnit.optional(),
+  fromIntervalCount: z.number().int().min(1).optional(),
+  toIntervalCount: z.number().int().min(1).optional(),
+  direction: ZRBTenantSubscriptionChangeDirection.optional(),
+  actorUserId: z.string().optional(),
+  source: ZRBTenantSubscriptionEventSource.optional(),
+  reason: z.string().optional(),
+  provider: z.string().optional(),
+  providerEventId: z.string().optional(),
+  providerPayload: z.unknown().optional(),
+  metadata: z.record(z.string(), z.unknown()).optional()
+});
+const RBTenantSubscriptionEventSchema = new Schema(
+  {
+    tenantId: { type: String, required: true, index: true },
+    subscriptionId: { type: String, required: true, index: true },
+    type: { type: String, required: true },
+    occurredAt: { type: Date, required: true, default: Date.now },
+    effectiveAt: { type: Date },
+    fromPlanKey: { type: String },
+    toPlanKey: { type: String },
+    fromStatus: { type: String, enum: ZRBTenantSubscriptionStatus.options },
+    toStatus: { type: String, enum: ZRBTenantSubscriptionStatus.options },
+    fromModules: { type: [String], default: void 0 },
+    toModules: { type: [String], default: void 0 },
+    fromIntervalUnit: { type: String, enum: ZRBTenantSubscriptionIntervalUnit.options },
+    toIntervalUnit: { type: String, enum: ZRBTenantSubscriptionIntervalUnit.options },
+    fromIntervalCount: { type: Number, min: 1 },
+    toIntervalCount: { type: Number, min: 1 },
+    direction: { type: String, enum: ZRBTenantSubscriptionChangeDirection.options },
+    actorUserId: { type: String },
+    source: { type: String, enum: ZRBTenantSubscriptionEventSource.options },
+    reason: { type: String },
+    provider: { type: String },
+    providerEventId: { type: String },
+    providerPayload: { type: Schema.Types.Mixed },
+    metadata: { type: Schema.Types.Mixed }
+  },
+  {
+    collection: "tenantSubscriptionEvents"
+  }
+);
+RBTenantSubscriptionEventSchema.index({ tenantId: 1, subscriptionId: 1, occurredAt: 1 });
+RBTenantSubscriptionEventSchema.index({ provider: 1, providerEventId: 1 }, { unique: true, sparse: true });
 const ZRBRtsCounter = z.object({
   _id: z.string(),
   seq: z.number().int().min(0)
@@ -139,6 +275,8 @@ const frameworkSchemas = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.de
   RBRtsChangeSchema,
   RBRtsCounterSchema,
   RBTenantSchema,
+  RBTenantSubscriptionEventSchema,
+  RBTenantSubscriptionSchema,
   RBUploadChunkSchema,
   RBUploadSessionSchema,
   RBUserSchema,
@@ -146,6 +284,14 @@ const frameworkSchemas = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.de
   ZRBRtsChangeOp,
   ZRBRtsCounter,
   ZRBTenant,
+  ZRBTenantSubscription,
+  ZRBTenantSubscriptionChangeDirection,
+  ZRBTenantSubscriptionEvent,
+  ZRBTenantSubscriptionEventSource,
+  ZRBTenantSubscriptionIntervalUnit,
+  ZRBTenantSubscriptionScope,
+  ZRBTenantSubscriptionStatus,
+  ZRBTenantSubscriptionType,
   ZRBUploadChunk,
   ZRBUploadSession,
   ZRBUploadSessionStatus,
@@ -1159,6 +1305,8 @@ export {
   RBRtsChangeSchema,
   RBRtsCounterSchema,
   RBTenantSchema,
+  RBTenantSubscriptionEventSchema,
+  RBTenantSubscriptionSchema,
   RBUploadChunkSchema,
   RBUploadSessionSchema,
   RBUserSchema,
@@ -1166,6 +1314,14 @@ export {
   ZRBRtsChangeOp,
   ZRBRtsCounter,
   ZRBTenant,
+  ZRBTenantSubscription,
+  ZRBTenantSubscriptionChangeDirection,
+  ZRBTenantSubscriptionEvent,
+  ZRBTenantSubscriptionEventSource,
+  ZRBTenantSubscriptionIntervalUnit,
+  ZRBTenantSubscriptionScope,
+  ZRBTenantSubscriptionStatus,
+  ZRBTenantSubscriptionType,
   ZRBUploadChunk,
   ZRBUploadSession,
   ZRBUploadSessionStatus,

package/dist/models/RBTenantSubscription.d.ts

@@ -0,0 +1,70 @@
+import { Schema } from '../../../vite/node_modules/mongoose';
+import { z } from '../../../vite/node_modules/zod';
+export declare const ZRBTenantSubscriptionStatus: z.ZodEnum<{
+    trialing: "trialing";
+    active: "active";
+    past_due: "past_due";
+    paused: "paused";
+    canceled: "canceled";
+    expired: "expired";
+}>;
+export declare const ZRBTenantSubscriptionIntervalUnit: z.ZodEnum<{
+    day: "day";
+    month: "month";
+    year: "year";
+}>;
+export declare const ZRBTenantSubscriptionType: z.ZodEnum<{
+    primary: "primary";
+    addon: "addon";
+}>;
+export declare const ZRBTenantSubscriptionScope: z.ZodEnum<{
+    custom: "custom";
+    tenant: "tenant";
+    shop: "shop";
+}>;
+export declare const ZRBTenantSubscription: z.ZodObject<{
+    tenantId: z.ZodString;
+    subscriptionId: z.ZodString;
+    type: z.ZodOptional<z.ZodEnum<{
+        primary: "primary";
+        addon: "addon";
+    }>>;
+    parentSubscriptionId: z.ZodOptional<z.ZodString>;
+    scope: z.ZodOptional<z.ZodEnum<{
+        custom: "custom";
+        tenant: "tenant";
+        shop: "shop";
+    }>>;
+    scopeId: z.ZodOptional<z.ZodString>;
+    planKey: z.ZodString;
+    status: z.ZodEnum<{
+        trialing: "trialing";
+        active: "active";
+        past_due: "past_due";
+        paused: "paused";
+        canceled: "canceled";
+        expired: "expired";
+    }>;
+    intervalUnit: z.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>;
+    intervalCount: z.ZodOptional<z.ZodNumber>;
+    modules: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    currentPeriodStart: z.ZodOptional<z.ZodDate>;
+    currentPeriodEnd: z.ZodOptional<z.ZodDate>;
+    trialEndsAt: z.ZodOptional<z.ZodDate>;
+    cancelAt: z.ZodOptional<z.ZodDate>;
+    cancelAtPeriodEnd: z.ZodOptional<z.ZodBoolean>;
+    canceledAt: z.ZodOptional<z.ZodDate>;
+    provider: z.ZodOptional<z.ZodString>;
+    providerCustomerId: z.ZodOptional<z.ZodString>;
+    providerSubscriptionId: z.ZodOptional<z.ZodString>;
+    latestEventId: z.ZodOptional<z.ZodString>;
+    latestEventAt: z.ZodOptional<z.ZodDate>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type IRBTenantSubscription = z.infer<typeof ZRBTenantSubscription>;
+export declare const RBTenantSubscriptionSchema: Schema;
+//# sourceMappingURL=RBTenantSubscription.d.ts.map

package/dist/models/RBTenantSubscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RBTenantSubscription.d.ts","sourceRoot":"","sources":["../../src/models/RBTenantSubscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAGvB,eAAO,MAAM,2BAA2B;;;;;;;EAOtC,CAAA;AAEF,eAAO,MAAM,iCAAiC;;;;EAAmC,CAAA;AAEjF,eAAO,MAAM,yBAAyB;;;EAA+B,CAAA;AAErE,eAAO,MAAM,0BAA0B;;;;EAAuC,CAAA;AAE9E,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwBhC,CAAA;AAEF,MAAM,MAAM,qBAAqB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,qBAAqB,CAAC,CAAA;AAEzE,eAAO,MAAM,0BAA0B,EAAE,MA6BxC,CAAA"}

package/dist/models/RBTenantSubscriptionEvent.d.ts

@@ -0,0 +1,72 @@
+import { Schema } from '../../../vite/node_modules/mongoose';
+import { z } from '../../../vite/node_modules/zod';
+export declare const ZRBTenantSubscriptionEventSource: z.ZodEnum<{
+    admin: "admin";
+    system: "system";
+    webhook: "webhook";
+    user: "user";
+}>;
+export declare const ZRBTenantSubscriptionChangeDirection: z.ZodEnum<{
+    upgrade: "upgrade";
+    downgrade: "downgrade";
+    lateral: "lateral";
+}>;
+export declare const ZRBTenantSubscriptionEvent: z.ZodObject<{
+    tenantId: z.ZodString;
+    subscriptionId: z.ZodString;
+    type: z.ZodString;
+    occurredAt: z.ZodDate;
+    effectiveAt: z.ZodOptional<z.ZodDate>;
+    fromPlanKey: z.ZodOptional<z.ZodString>;
+    toPlanKey: z.ZodOptional<z.ZodString>;
+    fromStatus: z.ZodOptional<z.ZodEnum<{
+        trialing: "trialing";
+        active: "active";
+        past_due: "past_due";
+        paused: "paused";
+        canceled: "canceled";
+        expired: "expired";
+    }>>;
+    toStatus: z.ZodOptional<z.ZodEnum<{
+        trialing: "trialing";
+        active: "active";
+        past_due: "past_due";
+        paused: "paused";
+        canceled: "canceled";
+        expired: "expired";
+    }>>;
+    fromModules: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    toModules: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    fromIntervalUnit: z.ZodOptional<z.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>>;
+    toIntervalUnit: z.ZodOptional<z.ZodEnum<{
+        day: "day";
+        month: "month";
+        year: "year";
+    }>>;
+    fromIntervalCount: z.ZodOptional<z.ZodNumber>;
+    toIntervalCount: z.ZodOptional<z.ZodNumber>;
+    direction: z.ZodOptional<z.ZodEnum<{
+        upgrade: "upgrade";
+        downgrade: "downgrade";
+        lateral: "lateral";
+    }>>;
+    actorUserId: z.ZodOptional<z.ZodString>;
+    source: z.ZodOptional<z.ZodEnum<{
+        admin: "admin";
+        system: "system";
+        webhook: "webhook";
+        user: "user";
+    }>>;
+    reason: z.ZodOptional<z.ZodString>;
+    provider: z.ZodOptional<z.ZodString>;
+    providerEventId: z.ZodOptional<z.ZodString>;
+    providerPayload: z.ZodOptional<z.ZodUnknown>;
+    metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, z.core.$strip>;
+export type IRBTenantSubscriptionEvent = z.infer<typeof ZRBTenantSubscriptionEvent>;
+export declare const RBTenantSubscriptionEventSchema: Schema;
+//# sourceMappingURL=RBTenantSubscriptionEvent.d.ts.map

package/dist/models/RBTenantSubscriptionEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RBTenantSubscriptionEvent.d.ts","sourceRoot":"","sources":["../../src/models/RBTenantSubscriptionEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAA;AACjC,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAQvB,eAAO,MAAM,gCAAgC;;;;;EAK3C,CAAA;AAEF,eAAO,MAAM,oCAAoC;;;;EAI/C,CAAA;AAEF,eAAO,MAAM,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAwBrC,CAAA;AAEF,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAA;AAEnF,eAAO,MAAM,+BAA+B,EAAE,MA6B7C,CAAA"}

package/dist/models/index.d.ts

@@ -1,5 +1,7 @@
 export * from './User';
 export * from './Tenant';
+export * from './RBTenantSubscription';
+export * from './RBTenantSubscriptionEvent';
 export * from './RBRtsCounter';
 export * from './RBRtsChange';
 export * from './RBUploadSession';

package/dist/models/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/models/index.ts"],"names":[],"mappings":"AAAA,cAAc,QAAQ,CAAA;AACtB,cAAc,UAAU,CAAA;AACxB,cAAc,wBAAwB,CAAA;AACtC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,gBAAgB,CAAA;AAC9B,cAAc,eAAe,CAAA;AAC7B,cAAc,mBAAmB,CAAA;AACjC,cAAc,iBAAiB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rpcbase/db",
-  "version": "0.24.0",
+  "version": "0.25.0",
   "type": "module",
   "files": [
     "dist"