@veruna/api-contracts 20.0.0 → 20.1.0

package/build/v1/payment/schemas/provider-api-outcome.enum.js

@@ -1,6 +1,14 @@
 "use strict";
+// libs/contracts/v1/payment/schemas/provider-api-outcome.enum.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ProviderApiOutcome = void 0;
+/**
+ * Result of a call to a payment provider's recurring-billing API.
+ * OK       — the provider confirmed the call.
+ * REJECTED — the provider definitely refused (business error or a 4xx): nothing was applied.
+ * UNKNOWN  — transport failure or 5xx: it may or may not have been applied; the caller must
+ *            observe the provider state before acting again.
+ */
 var ProviderApiOutcome;
 (function (ProviderApiOutcome) {
     ProviderApiOutcome["OK"] = "OK";

package/build/v1/payment/schemas/provider-api-outcome.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"provider-api-outcome.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/provider-api-outcome.enum.ts"],"names":[],"mappings":";;;AASA,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,+BAAS,CAAA;IACT,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;AACvB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}
+{"version":3,"file":"provider-api-outcome.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/provider-api-outcome.enum.ts"],"names":[],"mappings":";AAAA,iEAAiE;;;AAEjE;;;;;;GAMG;AACH,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC1B,+BAAS,CAAA;IACT,2CAAqB,CAAA;IACrB,yCAAmB,CAAA;AACvB,CAAC,EAJW,kBAAkB,kCAAlB,kBAAkB,QAI7B"}

package/build/v1/payment/schemas/refund-reason.enum.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Why money is returned.
+ *
+ * ADMIN       — an admin refunded an order.
+ * NOT_APPLIED — a captured payment the purchase was not applied for (a duplicate of a paid order, or an order that cannot be applied).
+ * OVERPAYMENT — the surplus over the order amount.
+ * PROVIDER    — a return made in the provider's cabinet, and every historical return.
+ */
 export declare enum RefundReason {
     ADMIN = "ADMIN",
     NOT_APPLIED = "NOT_APPLIED",

package/build/v1/payment/schemas/refund-reason.enum.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RefundReason = void 0;
+/**
+ * Why money is returned.
+ *
+ * ADMIN       — an admin refunded an order.
+ * NOT_APPLIED — a captured payment the purchase was not applied for (a duplicate of a paid order, or an order that cannot be applied).
+ * OVERPAYMENT — the surplus over the order amount.
+ * PROVIDER    — a return made in the provider's cabinet, and every historical return.
+ */
 var RefundReason;
 (function (RefundReason) {
     RefundReason["ADMIN"] = "ADMIN";

package/build/v1/payment/schemas/refund-reason.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"refund-reason.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/refund-reason.enum.ts"],"names":[],"mappings":";;;AAQA,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,+BAAe,CAAA;IACf,2CAA2B,CAAA;IAC3B,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;AACzB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB"}
+{"version":3,"file":"refund-reason.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/refund-reason.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;GAOG;AACH,IAAY,YAKX;AALD,WAAY,YAAY;IACpB,+BAAe,CAAA;IACf,2CAA2B,CAAA;IAC3B,2CAA2B,CAAA;IAC3B,qCAAqB,CAAA;AACzB,CAAC,EALW,YAAY,4BAAZ,YAAY,QAKvB"}

package/build/v1/payment/schemas/refund-status.enum.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Status of a Refund (a return of a captured payment).
+ *
+ * REQUESTED — recorded before the HTTP call to the provider; may be sent, resent in the idempotency window or reconciled.
+ * SUCCEEDED — the provider returned the money (our request, or a return made in the provider's cabinet).
+ * FAILED    — the provider refused, or proved that no return happened; an automatic refund is not retried on its own.
+ */
 export declare enum RefundStatus {
     REQUESTED = "REQUESTED",
     SUCCEEDED = "SUCCEEDED",

package/build/v1/payment/schemas/refund-status.enum.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RefundStatus = void 0;
+/**
+ * Status of a Refund (a return of a captured payment).
+ *
+ * REQUESTED — recorded before the HTTP call to the provider; may be sent, resent in the idempotency window or reconciled.
+ * SUCCEEDED — the provider returned the money (our request, or a return made in the provider's cabinet).
+ * FAILED    — the provider refused, or proved that no return happened; an automatic refund is not retried on its own.
+ */
 var RefundStatus;
 (function (RefundStatus) {
     RefundStatus["REQUESTED"] = "REQUESTED";

package/build/v1/payment/schemas/refund-status.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"refund-status.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/refund-status.enum.ts"],"names":[],"mappings":";;;AAOA,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACrB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}
+{"version":3,"file":"refund-status.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/refund-status.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,IAAY,YAIX;AAJD,WAAY,YAAY;IACpB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;IACvB,iCAAiB,CAAA;AACrB,CAAC,EAJW,YAAY,4BAAZ,YAAY,QAIvB"}

package/build/v1/payment/schemas/saved-method-status.enum.d.ts

@@ -1,3 +1,14 @@
+/**
+ * Status of a SavedPaymentMethod (stored card token for recurrent charges).
+ *
+ * ACTIVE   — the card can be charged.
+ * UNUSABLE — «Карта непригодна»: the bank answered an unconditional decline. The card is not charged, but stays in the
+ *            user's list with `unusableReason` so the user can pay with another card or delete it. A successful payment
+ *            with this card started after it became unusable makes it ACTIVE again.
+ * REVOKED  — the user (or an admin) deleted the card. Not returned to the user.
+ *
+ * One ACTIVE default per user.
+ */
 export declare enum SavedMethodStatus {
     ACTIVE = "ACTIVE",
     UNUSABLE = "UNUSABLE",

package/build/v1/payment/schemas/saved-method-status.enum.js

@@ -1,6 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SavedMethodStatus = void 0;
+/**
+ * Status of a SavedPaymentMethod (stored card token for recurrent charges).
+ *
+ * ACTIVE   — the card can be charged.
+ * UNUSABLE — «Карта непригодна»: the bank answered an unconditional decline. The card is not charged, but stays in the
+ *            user's list with `unusableReason` so the user can pay with another card or delete it. A successful payment
+ *            with this card started after it became unusable makes it ACTIVE again.
+ * REVOKED  — the user (or an admin) deleted the card. Not returned to the user.
+ *
+ * One ACTIVE default per user.
+ */
 var SavedMethodStatus;
 (function (SavedMethodStatus) {
     SavedMethodStatus["ACTIVE"] = "ACTIVE";

package/build/v1/payment/schemas/saved-method-status.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"saved-method-status.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/saved-method-status.enum.ts"],"names":[],"mappings":";;;AAWA,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}
+{"version":3,"file":"saved-method-status.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/saved-method-status.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IACzB,sCAAiB,CAAA;IACjB,0CAAqB,CAAA;IACrB,wCAAmB,CAAA;AACvB,CAAC,EAJW,iBAAiB,iCAAjB,iBAAiB,QAI5B"}

package/build/v1/payment/schemas/saved-method-unusable-reason.enum.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Why a saved card is UNUSABLE (from the bank's unconditional decline code).
+ *
+ * CARD_EXPIRED      — 5033: the card has expired («истёк срок действия карты»).
+ * CARD_BLOCKED      — 5004, 5007, 5041, 5043: the bank blocked the card — lost, stolen or to be picked up («банк заблокировал карту»).
+ * CHARGES_FORBIDDEN — 5001, 5012, 5017, 5034, 5057: the bank forbids charges from this card («банк запретил списания с этой карты»).
+ */
 export declare enum SavedMethodUnusableReason {
     CARD_EXPIRED = "CARD_EXPIRED",
     CARD_BLOCKED = "CARD_BLOCKED",

package/build/v1/payment/schemas/saved-method-unusable-reason.enum.js

@@ -1,6 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SavedMethodUnusableReason = void 0;
+/**
+ * Why a saved card is UNUSABLE (from the bank's unconditional decline code).
+ *
+ * CARD_EXPIRED      — 5033: the card has expired («истёк срок действия карты»).
+ * CARD_BLOCKED      — 5004, 5007, 5041, 5043: the bank blocked the card — lost, stolen or to be picked up («банк заблокировал карту»).
+ * CHARGES_FORBIDDEN — 5001, 5012, 5017, 5034, 5057: the bank forbids charges from this card («банк запретил списания с этой карты»).
+ */
 var SavedMethodUnusableReason;
 (function (SavedMethodUnusableReason) {
     SavedMethodUnusableReason["CARD_EXPIRED"] = "CARD_EXPIRED";

package/build/v1/payment/schemas/saved-method-unusable-reason.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"saved-method-unusable-reason.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/saved-method-unusable-reason.enum.ts"],"names":[],"mappings":";;;AAOA,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACjC,0DAA6B,CAAA;IAC7B,0DAA6B,CAAA;IAC7B,oEAAuC,CAAA;AAC3C,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC"}
+{"version":3,"file":"saved-method-unusable-reason.enum.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/saved-method-unusable-reason.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;GAMG;AACH,IAAY,yBAIX;AAJD,WAAY,yBAAyB;IACjC,0DAA6B,CAAA;IAC7B,0DAA6B,CAAA;IAC7B,oEAAuC,CAAA;AAC3C,CAAC,EAJW,yBAAyB,yCAAzB,yBAAyB,QAIpC"}

package/build/v1/payment/schemas/three-ds-complete.schema.d.ts

@@ -1,4 +1,10 @@
 import { z } from 'zod';
+/**
+ * Item 10 — 3-D Secure TermUrl request body. The issuing bank's ACS page POSTs this as a
+ * standard HTML form (`application/x-www-form-urlencoded`) — field names `MD` and `PaRes`
+ * are fixed by the 3-D Secure spec, not by CloudPayments or us; they must NOT be
+ * camelCased or renamed.
+ */
 export declare const ThreeDsCompleteRequestSchema: z.ZodObject<{
     MD: z.ZodString;
     PaRes: z.ZodString;

package/build/v1/payment/schemas/three-ds-complete.schema.js

@@ -1,9 +1,18 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ThreeDsCompleteRequestSchema = void 0;
+// libs/contracts/v1/payment/schemas/three-ds-complete.schema.ts
 const zod_1 = require("zod");
+/**
+ * Item 10 — 3-D Secure TermUrl request body. The issuing bank's ACS page POSTs this as a
+ * standard HTML form (`application/x-www-form-urlencoded`) — field names `MD` and `PaRes`
+ * are fixed by the 3-D Secure spec, not by CloudPayments or us; they must NOT be
+ * camelCased or renamed.
+ */
 exports.ThreeDsCompleteRequestSchema = zod_1.z.object({
+    /** The original chargeToken transactionId, round-tripped through the ACS challenge. */
     MD: zod_1.z.string().min(1),
+    /** The 3-D Secure authentication response the ACS page produced. */
     PaRes: zod_1.z.string().min(1),
 });
 //# sourceMappingURL=three-ds-complete.schema.js.map

package/build/v1/payment/schemas/three-ds-complete.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"three-ds-complete.schema.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/three-ds-complete.schema.ts"],"names":[],"mappings":";;;AACA,6BAAwB;AAQX,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IAEjD,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IAErB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC"}
+{"version":3,"file":"three-ds-complete.schema.js","sourceRoot":"","sources":["../../../../v1/payment/schemas/three-ds-complete.schema.ts"],"names":[],"mappings":";;;AAAA,gEAAgE;AAChE,6BAAwB;AAExB;;;;;GAKG;AACU,QAAA,4BAA4B,GAAG,OAAC,CAAC,MAAM,CAAC;IACjD,uFAAuF;IACvF,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACrB,oEAAoE;IACpE,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;CAC3B,CAAC,CAAC"}

package/build/v1/plans/commands/admin-delete-plan.command.d.ts

@@ -5,6 +5,7 @@ export declare namespace AdminDeletePlanCommand {
     const Response: z.ZodObject<{
         success: z.ZodBoolean;
     }, z.core.$strip>;
+    /** URL factory — call with plan id to get the full URL. */
     const URL: (id: string) => string;
     const METHOD = HttpMethod.DELETE;
     type RequestType = z.infer<typeof Request>;

package/build/v1/plans/commands/admin-delete-plan.command.js

@@ -9,6 +9,7 @@ var AdminDeletePlanCommand;
 (function (AdminDeletePlanCommand) {
     AdminDeletePlanCommand.Request = zod_1.z.object({});
     AdminDeletePlanCommand.Response = admin_delete_plan_schema_1.AdminDeletePlanResponseSchema;
+    /** URL factory — call with plan id to get the full URL. */
     AdminDeletePlanCommand.URL = rest_api_1.REST_API.V1.PLANS.ADMIN.DELETE;
     AdminDeletePlanCommand.METHOD = http_method_enum_1.HttpMethod.DELETE;
 })(AdminDeletePlanCommand || (exports.AdminDeletePlanCommand = AdminDeletePlanCommand = {}));

package/build/v1/plans/commands/admin-delete-plan.command.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-delete-plan.command.js","sourceRoot":"","sources":["../../../../v1/plans/commands/admin-delete-plan.command.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gDAA6C;AAC7C,uEAA8D;AAC9D,kFAAoF;AAEpF,IAAiB,sBAAsB,CAUtC;AAVD,WAAiB,sBAAsB;IACtB,8BAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,+BAAQ,GAAG,wDAA6B,CAAC;IAGzC,0BAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,6BAAM,GAAG,6BAAU,CAAC,MAAM,CAAC;AAI5C,CAAC,EAVgB,sBAAsB,sCAAtB,sBAAsB,QAUtC"}
+{"version":3,"file":"admin-delete-plan.command.js","sourceRoot":"","sources":["../../../../v1/plans/commands/admin-delete-plan.command.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,gDAA6C;AAC7C,uEAA8D;AAC9D,kFAAoF;AAEpF,IAAiB,sBAAsB,CAUtC;AAVD,WAAiB,sBAAsB;IACtB,8BAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,+BAAQ,GAAG,wDAA6B,CAAC;IAEtD,2DAA2D;IAC9C,0BAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,6BAAM,GAAG,6BAAU,CAAC,MAAM,CAAC;AAI5C,CAAC,EAVgB,sBAAsB,sCAAtB,sBAAsB,QAUtC"}

package/build/v1/plans/commands/admin-update-plan.command.d.ts

@@ -67,6 +67,7 @@ export declare namespace AdminUpdatePlanCommand {
             max: z.ZodNullable<z.ZodNumber>;
         }, z.core.$strip>>;
     }, z.core.$strip>;
+    /** URL factory — call with plan id to get the full URL. */
     const URL: (id: string) => string;
     const METHOD = HttpMethod.PATCH;
     type RequestType = z.infer<typeof Request>;

package/build/v1/plans/commands/admin-update-plan.command.js

@@ -8,6 +8,7 @@ var AdminUpdatePlanCommand;
 (function (AdminUpdatePlanCommand) {
     AdminUpdatePlanCommand.Request = schemas_1.AdminUpdatePlanRequestSchema;
     AdminUpdatePlanCommand.Response = schemas_1.PlanSchema;
+    /** URL factory — call with plan id to get the full URL. */
     AdminUpdatePlanCommand.URL = rest_api_1.REST_API.V1.PLANS.ADMIN.UPDATE;
     AdminUpdatePlanCommand.METHOD = http_method_enum_1.HttpMethod.PATCH;
 })(AdminUpdatePlanCommand || (exports.AdminUpdatePlanCommand = AdminUpdatePlanCommand = {}));

package/build/v1/plans/commands/admin-update-plan.command.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-update-plan.command.js","sourceRoot":"","sources":["../../../../v1/plans/commands/admin-update-plan.command.ts"],"names":[],"mappings":";;;AACA,wCAAsE;AACtE,gDAA6C;AAC7C,uEAA8D;AAE9D,IAAiB,sBAAsB,CAUtC;AAVD,WAAiB,sBAAsB;IACtB,8BAAO,GAAG,sCAA4B,CAAC;IACvC,+BAAQ,GAAG,oBAAU,CAAC;IAGtB,0BAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,6BAAM,GAAG,6BAAU,CAAC,KAAK,CAAC;AAI3C,CAAC,EAVgB,sBAAsB,sCAAtB,sBAAsB,QAUtC"}
+{"version":3,"file":"admin-update-plan.command.js","sourceRoot":"","sources":["../../../../v1/plans/commands/admin-update-plan.command.ts"],"names":[],"mappings":";;;AACA,wCAAsE;AACtE,gDAA6C;AAC7C,uEAA8D;AAE9D,IAAiB,sBAAsB,CAUtC;AAVD,WAAiB,sBAAsB;IACtB,8BAAO,GAAG,sCAA4B,CAAC;IACvC,+BAAQ,GAAG,oBAAU,CAAC;IAEnC,2DAA2D;IAC9C,0BAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC;IACrC,6BAAM,GAAG,6BAAU,CAAC,KAAK,CAAC;AAI3C,CAAC,EAVgB,sBAAsB,sCAAtB,sBAAsB,QAUtC"}

package/build/v1/plans/index.js

@@ -19,6 +19,7 @@ __exportStar(require("./schemas"), exports);
 __exportStar(require("./plans.errors"), exports);
 __exportStar(require("./commands"), exports);
 __exportStar(require("./queries"), exports);
+// Re-export from centralized locations
 var controllers_1 = require("../../controllers");
 Object.defineProperty(exports, "PLANS_CONTROLLER", { enumerable: true, get: function () { return controllers_1.PLANS_CONTROLLER; } });
 Object.defineProperty(exports, "PLANS_ADMIN_CONTROLLER", { enumerable: true, get: function () { return controllers_1.PLANS_ADMIN_CONTROLLER; } });

package/build/v1/plans/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../v1/plans/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,4CAA0B;AAE1B,iDAA6E;AAApE,+GAAA,gBAAgB,OAAA;AAAE,qHAAA,sBAAsB,OAAA;AACjD,uCAAgE;AAAvD,sGAAA,YAAY,OAAA;AAAE,4GAAA,kBAAkB,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../v1/plans/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAA0B;AAC1B,iDAA+B;AAC/B,6CAA2B;AAC3B,4CAA0B;AAC1B,uCAAuC;AACvC,iDAA6E;AAApE,+GAAA,gBAAgB,OAAA;AAAE,qHAAA,sBAAsB,OAAA;AACjD,uCAAgE;AAAvD,sGAAA,YAAY,OAAA;AAAE,4GAAA,kBAAkB,OAAA"}

package/build/v1/plans/plans.errors.d.ts

@@ -3,10 +3,21 @@ export declare enum PlanErrorCode {
     PLAN_NOT_FOUND = "PLAN_NOT_FOUND",
     PLAN_NOT_AVAILABLE = "PLAN_NOT_AVAILABLE",
     INVALID_PLAN_TYPE = "INVALID_PLAN_TYPE",
+    /**
+     * Numeric invariant violation: bonusPercent/rolloverPercent out of [0,100]
+     * or maxCharsPerRequest < 1. Distinct from INVALID_PLAN_TYPE which means
+     * the `type` enum field is illegal.
+     */
     INVALID_PLAN_CONFIG = "INVALID_PLAN_CONFIG",
     INVALID_PERIOD = "INVALID_PERIOD",
     CUSTOM_PRICE_OUT_OF_RANGE = "CUSTOM_PRICE_OUT_OF_RANGE",
+    /**
+     * One or more modelIds provided in an admin create/update request do not
+     * correspond to active AI models. The request is rejected — the client must
+     * supply only valid active model UUIDs.
+     */
     INVALID_MODEL_IDS = "INVALID_MODEL_IDS",
+    /** One or more supplied tool UUIDs do not exist. Supply only existing tool UUIDs. */
     INVALID_TOOL_IDS = "INVALID_TOOL_IDS"
 }
 export declare const PLAN_ERRORS: Record<PlanErrorCode, ErrorMetadata>;

package/build/v1/plans/plans.errors.js

@@ -6,10 +6,21 @@ var PlanErrorCode;
     PlanErrorCode["PLAN_NOT_FOUND"] = "PLAN_NOT_FOUND";
     PlanErrorCode["PLAN_NOT_AVAILABLE"] = "PLAN_NOT_AVAILABLE";
     PlanErrorCode["INVALID_PLAN_TYPE"] = "INVALID_PLAN_TYPE";
+    /**
+     * Numeric invariant violation: bonusPercent/rolloverPercent out of [0,100]
+     * or maxCharsPerRequest < 1. Distinct from INVALID_PLAN_TYPE which means
+     * the `type` enum field is illegal.
+     */
     PlanErrorCode["INVALID_PLAN_CONFIG"] = "INVALID_PLAN_CONFIG";
     PlanErrorCode["INVALID_PERIOD"] = "INVALID_PERIOD";
     PlanErrorCode["CUSTOM_PRICE_OUT_OF_RANGE"] = "CUSTOM_PRICE_OUT_OF_RANGE";
+    /**
+     * One or more modelIds provided in an admin create/update request do not
+     * correspond to active AI models. The request is rejected — the client must
+     * supply only valid active model UUIDs.
+     */
     PlanErrorCode["INVALID_MODEL_IDS"] = "INVALID_MODEL_IDS";
+    /** One or more supplied tool UUIDs do not exist. Supply only existing tool UUIDs. */
     PlanErrorCode["INVALID_TOOL_IDS"] = "INVALID_TOOL_IDS";
 })(PlanErrorCode || (exports.PlanErrorCode = PlanErrorCode = {}));
 exports.PLAN_ERRORS = {

package/build/v1/plans/plans.errors.js.map

@@ -1 +1 @@
-{"version":3,"file":"plans.errors.js","sourceRoot":"","sources":["../../../v1/plans/plans.errors.ts"],"names":[],"mappings":";;;AAEA,IAAY,aAoBX;AApBD,WAAY,aAAa;IACrB,kDAAiC,CAAA;IACjC,0DAAyC,CAAA;IACzC,wDAAuC,CAAA;IAMvC,4DAA2C,CAAA;IAC3C,kDAAiC,CAAA;IACjC,wEAAuD,CAAA;IAMvD,wDAAuC,CAAA;IAEvC,sDAAqC,CAAA;AACzC,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB;AAEY,QAAA,WAAW,GAAyC;IAC7D,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;QAC5B,IAAI,EAAE,aAAa,CAAC,cAAc;QAClC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE;QAChC,IAAI,EAAE,aAAa,CAAC,kBAAkB;QACtC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE;QAC/B,IAAI,EAAE,aAAa,CAAC,iBAAiB;QACrC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,mBAAmB,CAAC,EAAE;QACjC,IAAI,EAAE,aAAa,CAAC,mBAAmB;QACvC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;QAC5B,IAAI,EAAE,aAAa,CAAC,cAAc;QAClC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE;QACvC,IAAI,EAAE,aAAa,CAAC,yBAAyB;QAC7C,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE;QAC/B,IAAI,EAAE,aAAa,CAAC,iBAAiB;QACrC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE;QAC9B,IAAI,EAAE,aAAa,CAAC,gBAAgB;QACpC,UAAU,EAAE,GAAG;KAClB;CACK,CAAC"}
+{"version":3,"file":"plans.errors.js","sourceRoot":"","sources":["../../../v1/plans/plans.errors.ts"],"names":[],"mappings":";;;AAEA,IAAY,aAoBX;AApBD,WAAY,aAAa;IACrB,kDAAiC,CAAA;IACjC,0DAAyC,CAAA;IACzC,wDAAuC,CAAA;IACvC;;;;OAIG;IACH,4DAA2C,CAAA;IAC3C,kDAAiC,CAAA;IACjC,wEAAuD,CAAA;IACvD;;;;OAIG;IACH,wDAAuC,CAAA;IACvC,qFAAqF;IACrF,sDAAqC,CAAA;AACzC,CAAC,EApBW,aAAa,6BAAb,aAAa,QAoBxB;AAEY,QAAA,WAAW,GAAyC;IAC7D,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;QAC5B,IAAI,EAAE,aAAa,CAAC,cAAc;QAClC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,kBAAkB,CAAC,EAAE;QAChC,IAAI,EAAE,aAAa,CAAC,kBAAkB;QACtC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE;QAC/B,IAAI,EAAE,aAAa,CAAC,iBAAiB;QACrC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,mBAAmB,CAAC,EAAE;QACjC,IAAI,EAAE,aAAa,CAAC,mBAAmB;QACvC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,cAAc,CAAC,EAAE;QAC5B,IAAI,EAAE,aAAa,CAAC,cAAc;QAClC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,yBAAyB,CAAC,EAAE;QACvC,IAAI,EAAE,aAAa,CAAC,yBAAyB;QAC7C,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,iBAAiB,CAAC,EAAE;QAC/B,IAAI,EAAE,aAAa,CAAC,iBAAiB;QACrC,UAAU,EAAE,GAAG;KAClB;IACD,CAAC,aAAa,CAAC,gBAAgB,CAAC,EAAE;QAC9B,IAAI,EAAE,aAAa,CAAC,gBAAgB;QACpC,UAAU,EAAE,GAAG;KAClB;CACK,CAAC"}

package/build/v1/plans/queries/admin-get-plan-by-id.query.d.ts

@@ -1,6 +1,11 @@
 import { z } from 'zod';
 import { HttpMethod } from '../../../shared/http-method.enum';
+/**
+ * Contract for the admin GET /v1/admin/plans/:id endpoint.
+ * No request body — the plan ID comes from the path parameter.
+ */
 export declare namespace AdminGetPlanByIdQuery {
+    /** Empty request body (plan ID is a path parameter). */
     const Request: z.ZodObject<{}, z.core.$strip>;
     const Response: z.ZodObject<{
         id: z.ZodString;
@@ -44,6 +49,7 @@ export declare namespace AdminGetPlanByIdQuery {
             max: z.ZodNullable<z.ZodNumber>;
         }, z.core.$strip>>;
     }, z.core.$strip>;
+    /** URL factory — call with plan id to get the full URL. */
     const URL: (id: string) => string;
     const METHOD = HttpMethod.GET;
     type RequestType = z.infer<typeof Request>;

package/build/v1/plans/queries/admin-get-plan-by-id.query.js

@@ -5,10 +5,16 @@ const zod_1 = require("zod");
 const schemas_1 = require("../schemas");
 const rest_api_1 = require("../../../rest-api");
 const http_method_enum_1 = require("../../../shared/http-method.enum");
+/**
+ * Contract for the admin GET /v1/admin/plans/:id endpoint.
+ * No request body — the plan ID comes from the path parameter.
+ */
 var AdminGetPlanByIdQuery;
 (function (AdminGetPlanByIdQuery) {
+    /** Empty request body (plan ID is a path parameter). */
     AdminGetPlanByIdQuery.Request = zod_1.z.object({});
     AdminGetPlanByIdQuery.Response = schemas_1.PlanSchema;
+    /** URL factory — call with plan id to get the full URL. */
     AdminGetPlanByIdQuery.URL = rest_api_1.REST_API.V1.PLANS.ADMIN.GET_BY_ID;
     AdminGetPlanByIdQuery.METHOD = http_method_enum_1.HttpMethod.GET;
 })(AdminGetPlanByIdQuery || (exports.AdminGetPlanByIdQuery = AdminGetPlanByIdQuery = {}));

package/build/v1/plans/queries/admin-get-plan-by-id.query.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-get-plan-by-id.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/admin-get-plan-by-id.query.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,wCAAwC;AACxC,gDAA6C;AAC7C,uEAA8D;AAM9D,IAAiB,qBAAqB,CAWrC;AAXD,WAAiB,qBAAqB;IAErB,6BAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,8BAAQ,GAAG,oBAAU,CAAC;IAGtB,yBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;IACxC,4BAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EAXgB,qBAAqB,qCAArB,qBAAqB,QAWrC"}
+{"version":3,"file":"admin-get-plan-by-id.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/admin-get-plan-by-id.query.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,wCAAwC;AACxC,gDAA6C;AAC7C,uEAA8D;AAE9D;;;GAGG;AACH,IAAiB,qBAAqB,CAWrC;AAXD,WAAiB,qBAAqB;IAClC,wDAAwD;IAC3C,6BAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,8BAAQ,GAAG,oBAAU,CAAC;IAEnC,2DAA2D;IAC9C,yBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,SAAS,CAAC;IACxC,4BAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EAXgB,qBAAqB,qCAArB,qBAAqB,QAWrC"}

package/build/v1/plans/queries/admin-list-plans.query.d.ts

@@ -1,5 +1,13 @@
 import { z } from 'zod';
 import { HttpMethod } from '../../../shared/http-method.enum';
+/**
+ * Admin plan catalog list — `v1/admin/plans` (GET, admin role).
+ * Request: AdminListPlansFiltersSchema — optional filters + sort.
+ * Response: PlanListResponseSchema — reuses the public catalog shape
+ *   (modelTree + toolTree + items). Unlike the public list, the admin list
+ *   is unfiltered by status (defaults to ACTIVE, override via `status`) and
+ *   includes custom plans.
+ */
 export declare namespace AdminListPlansQuery {
     const Request: z.ZodObject<{
         q: z.ZodOptional<z.ZodString>;

package/build/v1/plans/queries/admin-list-plans.query.js

@@ -4,6 +4,14 @@ exports.AdminListPlansQuery = void 0;
 const schemas_1 = require("../schemas");
 const rest_api_1 = require("../../../rest-api");
 const http_method_enum_1 = require("../../../shared/http-method.enum");
+/**
+ * Admin plan catalog list — `v1/admin/plans` (GET, admin role).
+ * Request: AdminListPlansFiltersSchema — optional filters + sort.
+ * Response: PlanListResponseSchema — reuses the public catalog shape
+ *   (modelTree + toolTree + items). Unlike the public list, the admin list
+ *   is unfiltered by status (defaults to ACTIVE, override via `status`) and
+ *   includes custom plans.
+ */
 var AdminListPlansQuery;
 (function (AdminListPlansQuery) {
     AdminListPlansQuery.Request = schemas_1.AdminListPlansFiltersSchema;

package/build/v1/plans/queries/admin-list-plans.query.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-list-plans.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/admin-list-plans.query.ts"],"names":[],"mappings":";;;AACA,wCAAiF;AACjF,gDAA6C;AAC7C,uEAA8D;AAU9D,IAAiB,mBAAmB,CASnC;AATD,WAAiB,mBAAmB;IACnB,2BAAO,GAAG,qCAA2B,CAAC;IACtC,4BAAQ,GAAG,gCAAsB,CAAC;IAElC,uBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACnC,0BAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,mBAAmB,mCAAnB,mBAAmB,QASnC"}
+{"version":3,"file":"admin-list-plans.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/admin-list-plans.query.ts"],"names":[],"mappings":";;;AACA,wCAAiF;AACjF,gDAA6C;AAC7C,uEAA8D;AAE9D;;;;;;;GAOG;AACH,IAAiB,mBAAmB,CASnC;AATD,WAAiB,mBAAmB;IACnB,2BAAO,GAAG,qCAA2B,CAAC;IACtC,4BAAQ,GAAG,gCAAsB,CAAC;IAElC,uBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACnC,0BAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,mBAAmB,mCAAnB,mBAAmB,QASnC"}

package/build/v1/plans/queries/list-plans.query.d.ts

@@ -1,5 +1,9 @@
 import { z } from 'zod';
 import { HttpMethod } from '../../../shared/http-method.enum';
+/**
+ * Public (unauthenticated) plan catalog — `v1/unreg/plans/list`.
+ * Response: PlanListResponseSchema — no subscription context.
+ */
 export declare namespace ListPlansQuery {
     const Request: z.ZodObject<{}, z.core.$strip>;
     const Response: z.ZodObject<{
@@ -73,6 +77,11 @@ export declare namespace ListPlansQuery {
     type RequestType = z.infer<typeof Request>;
     type ResponseType = z.infer<typeof Response>;
 }
+/**
+ * Authenticated (reg) plan catalog — `v1/plans/list` (JWT).
+ * Response: PlanCatalogResponseSchema — each item enriched with
+ * currentPlanCode / transition / surcharge from the user's active subscription.
+ */
 export declare namespace ListPlansRegQuery {
     const Request: z.ZodObject<{}, z.core.$strip>;
     const Response: z.ZodObject<{

package/build/v1/plans/queries/list-plans.query.js

@@ -5,6 +5,10 @@ const zod_1 = require("zod");
 const schemas_1 = require("../schemas");
 const rest_api_1 = require("../../../rest-api");
 const http_method_enum_1 = require("../../../shared/http-method.enum");
+/**
+ * Public (unauthenticated) plan catalog — `v1/unreg/plans/list`.
+ * Response: PlanListResponseSchema — no subscription context.
+ */
 var ListPlansQuery;
 (function (ListPlansQuery) {
     ListPlansQuery.Request = zod_1.z.object({});
@@ -12,6 +16,11 @@ var ListPlansQuery;
     ListPlansQuery.URL = rest_api_1.REST_API.V1.PLANS.UNREG.LIST;
     ListPlansQuery.METHOD = http_method_enum_1.HttpMethod.GET;
 })(ListPlansQuery || (exports.ListPlansQuery = ListPlansQuery = {}));
+/**
+ * Authenticated (reg) plan catalog — `v1/plans/list` (JWT).
+ * Response: PlanCatalogResponseSchema — each item enriched with
+ * currentPlanCode / transition / surcharge from the user's active subscription.
+ */
 var ListPlansRegQuery;
 (function (ListPlansRegQuery) {
     ListPlansRegQuery.Request = zod_1.z.object({});

package/build/v1/plans/queries/list-plans.query.js.map

@@ -1 +1 @@
-{"version":3,"file":"list-plans.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/list-plans.query.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,wCAA+E;AAC/E,gDAA6C;AAC7C,uEAA8D;AAM9D,IAAiB,cAAc,CAS9B;AATD,WAAiB,cAAc;IACd,sBAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,uBAAQ,GAAG,gCAAsB,CAAC;IAElC,kBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACnC,qBAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,cAAc,8BAAd,cAAc,QAS9B;AAOD,IAAiB,iBAAiB,CASjC;AATD,WAAiB,iBAAiB;IACjB,yBAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,0BAAQ,GAAG,mCAAyB,CAAC;IAErC,qBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,wBAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,iBAAiB,iCAAjB,iBAAiB,QASjC"}
+{"version":3,"file":"list-plans.query.js","sourceRoot":"","sources":["../../../../v1/plans/queries/list-plans.query.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,wCAA+E;AAC/E,gDAA6C;AAC7C,uEAA8D;AAE9D;;;GAGG;AACH,IAAiB,cAAc,CAS9B;AATD,WAAiB,cAAc;IACd,sBAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,uBAAQ,GAAG,gCAAsB,CAAC;IAElC,kBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC;IACnC,qBAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,cAAc,8BAAd,cAAc,QAS9B;AAED;;;;GAIG;AACH,IAAiB,iBAAiB,CASjC;AATD,WAAiB,iBAAiB;IACjB,yBAAO,GAAG,OAAC,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACvB,0BAAQ,GAAG,mCAAyB,CAAC;IAErC,qBAAG,GAAG,mBAAQ,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;IACjC,wBAAM,GAAG,6BAAU,CAAC,GAAG,CAAC;AAIzC,CAAC,EATgB,iBAAiB,iCAAjB,iBAAiB,QASjC"}

package/build/v1/plans/schemas/admin-list-plans-filters.schema.d.ts

@@ -3,6 +3,13 @@ import { PlanStatus } from './plan-status.enum';
 import { PlanType } from './plan-type.enum';
 import { AdminPlanSortField } from './admin-plan-sort.enum';
 import { SortOrder } from '../../shared/sort-order.enum';
+/**
+ * Admin List Plans Filters Schema — query params for the admin plan list.
+ * Error messages: AdminListPlansFilters.{field}.{rule}
+ *
+ * All filters are optional; sortBy/sortOrder default to the existing list
+ * behaviour (displayOrder ascending). `q` matches plan code / badge.
+ */
 export declare const AdminListPlansFiltersSchema: z.ZodObject<{
     q: z.ZodOptional<z.ZodString>;
     status: z.ZodOptional<z.ZodEnum<typeof PlanStatus>>;

package/build/v1/plans/schemas/admin-list-plans-filters.schema.js

@@ -6,6 +6,13 @@ const plan_status_enum_1 = require("./plan-status.enum");
 const plan_type_enum_1 = require("./plan-type.enum");
 const admin_plan_sort_enum_1 = require("./admin-plan-sort.enum");
 const sort_order_enum_1 = require("../../shared/sort-order.enum");
+/**
+ * Admin List Plans Filters Schema — query params for the admin plan list.
+ * Error messages: AdminListPlansFilters.{field}.{rule}
+ *
+ * All filters are optional; sortBy/sortOrder default to the existing list
+ * behaviour (displayOrder ascending). `q` matches plan code / badge.
+ */
 exports.AdminListPlansFiltersSchema = zod_1.z.object({
     q: zod_1.z.string().max(255).optional(),
     status: zod_1.z.nativeEnum(plan_status_enum_1.PlanStatus).optional(),

package/build/v1/plans/schemas/admin-list-plans-filters.schema.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-list-plans-filters.schema.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/admin-list-plans-filters.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,yDAAgD;AAChD,qDAA4C;AAC5C,iEAA4D;AAC5D,kEAAyD;AAS5C,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAChD,CAAC,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,OAAC,CAAC,UAAU,CAAC,6BAAU,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,OAAC,CAAC,UAAU,CAAC,yBAAQ,CAAC,CAAC,QAAQ,EAAE;IACvC,WAAW,EAAE,OAAC;SACT,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;SAClE,QAAQ,EAAE;IACf,SAAS,EAAE,OAAC;SACP,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;SAChE,QAAQ,EAAE;IACf,MAAM,EAAE,OAAC,CAAC,UAAU,CAAC,yCAAkB,CAAC,CAAC,OAAO,CAAC,yCAAkB,CAAC,aAAa,CAAC;IAClF,SAAS,EAAE,OAAC,CAAC,UAAU,CAAC,2BAAS,CAAC,CAAC,OAAO,CAAC,2BAAS,CAAC,GAAG,CAAC;CAC5D,CAAC,CAAC"}
+{"version":3,"file":"admin-list-plans-filters.schema.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/admin-list-plans-filters.schema.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,yDAAgD;AAChD,qDAA4C;AAC5C,iEAA4D;AAC5D,kEAAyD;AAEzD;;;;;;GAMG;AACU,QAAA,2BAA2B,GAAG,OAAC,CAAC,MAAM,CAAC;IAChD,CAAC,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACjC,MAAM,EAAE,OAAC,CAAC,UAAU,CAAC,6BAAU,CAAC,CAAC,QAAQ,EAAE;IAC3C,IAAI,EAAE,OAAC,CAAC,UAAU,CAAC,yBAAQ,CAAC,CAAC,QAAQ,EAAE;IACvC,WAAW,EAAE,OAAC;SACT,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,OAAO,EAAE,2CAA2C,EAAE,CAAC;SAClE,QAAQ,EAAE;IACf,SAAS,EAAE,OAAC;SACP,MAAM,EAAE;SACR,QAAQ,CAAC,EAAE,OAAO,EAAE,yCAAyC,EAAE,CAAC;SAChE,QAAQ,EAAE;IACf,MAAM,EAAE,OAAC,CAAC,UAAU,CAAC,yCAAkB,CAAC,CAAC,OAAO,CAAC,yCAAkB,CAAC,aAAa,CAAC;IAClF,SAAS,EAAE,OAAC,CAAC,UAAU,CAAC,2BAAS,CAAC,CAAC,OAAO,CAAC,2BAAS,CAAC,GAAG,CAAC;CAC5D,CAAC,CAAC"}

package/build/v1/plans/schemas/admin-plan-sort.enum.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Admin Plan list sort fields and order.
+ * Values map to sortable Plan columns.
+ */
 export declare enum AdminPlanSortField {
     DISPLAY_ORDER = "displayOrder",
     CODE = "code",

package/build/v1/plans/schemas/admin-plan-sort.enum.js

@@ -1,6 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AdminPlanSortField = void 0;
+/**
+ * Admin Plan list sort fields and order.
+ * Values map to sortable Plan columns.
+ */
 var AdminPlanSortField;
 (function (AdminPlanSortField) {
     AdminPlanSortField["DISPLAY_ORDER"] = "displayOrder";

package/build/v1/plans/schemas/admin-plan-sort.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"admin-plan-sort.enum.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/admin-plan-sort.enum.ts"],"names":[],"mappings":";;;AAIA,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC1B,oDAA8B,CAAA;IAC9B,mCAAa,CAAA;IACb,oDAA8B,CAAA;IAC9B,8CAAwB,CAAA;AAC5B,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}
+{"version":3,"file":"admin-plan-sort.enum.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/admin-plan-sort.enum.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC1B,oDAA8B,CAAA;IAC9B,mCAAa,CAAA;IACb,oDAA8B,CAAA;IAC9B,8CAAwB,CAAA;AAC5B,CAAC,EALW,kBAAkB,kCAAlB,kBAAkB,QAK7B"}

package/build/v1/plans/schemas/plan-feature.enum.d.ts

@@ -1,7 +1,31 @@
+/**
+ * Feature flags advertised on a plan. Some are ENFORCED (FILE_ATTACH gates
+ * attachments in message.service; WEB_SEARCH / REASONING gate the matching
+ * plugins in plugin-validator). Others are DISPLAY-ONLY hints for the tariff UI.
+ *
+ * MEMORY is display-only: actual memory access is gated by plan_tools
+ * (requiresPlanGrant on the memory tools), not by this flag. Keep them in sync
+ * in the seed (memory granted on the same SUBSCRIPTION plans that carry this
+ * feature); the flag just lets the FE show "Память" / hide the page without
+ * probing the REST 403.
+ */
 export declare enum PlanFeature {
     WEB_SEARCH = "WEB_SEARCH",
     FILE_ATTACH = "FILE_ATTACH",
     REASONING = "REASONING",
     MEMORY = "MEMORY",
+    /**
+     * ENFORCED, and only at CREATION.
+     *
+     * Gates `POST v1/assistants` — building your own assistant. Everything
+     * afterwards is deliberately ungated: reading, editing, deleting and
+     * favouriting an assistant the person already made keep working when the
+     * plan lapses, and nothing deletes those rows. They paid to build it; it
+     * stays theirs.
+     *
+     * Per-plan rather than a bare "has an active subscription" check, so a
+     * cheaper paid plan can be sold without this and an expensive one with it.
+     * To mean "any paid plan", simply enable it on every paid plan.
+     */
     CUSTOM_ASSISTANTS = "CUSTOM_ASSISTANTS"
 }

package/build/v1/plans/schemas/plan-feature.enum.js

@@ -1,12 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PlanFeature = void 0;
+/**
+ * Feature flags advertised on a plan. Some are ENFORCED (FILE_ATTACH gates
+ * attachments in message.service; WEB_SEARCH / REASONING gate the matching
+ * plugins in plugin-validator). Others are DISPLAY-ONLY hints for the tariff UI.
+ *
+ * MEMORY is display-only: actual memory access is gated by plan_tools
+ * (requiresPlanGrant on the memory tools), not by this flag. Keep them in sync
+ * in the seed (memory granted on the same SUBSCRIPTION plans that carry this
+ * feature); the flag just lets the FE show "Память" / hide the page without
+ * probing the REST 403.
+ */
 var PlanFeature;
 (function (PlanFeature) {
     PlanFeature["WEB_SEARCH"] = "WEB_SEARCH";
     PlanFeature["FILE_ATTACH"] = "FILE_ATTACH";
     PlanFeature["REASONING"] = "REASONING";
     PlanFeature["MEMORY"] = "MEMORY";
+    /**
+     * ENFORCED, and only at CREATION.
+     *
+     * Gates `POST v1/assistants` — building your own assistant. Everything
+     * afterwards is deliberately ungated: reading, editing, deleting and
+     * favouriting an assistant the person already made keep working when the
+     * plan lapses, and nothing deletes those rows. They paid to build it; it
+     * stays theirs.
+     *
+     * Per-plan rather than a bare "has an active subscription" check, so a
+     * cheaper paid plan can be sold without this and an expensive one with it.
+     * To mean "any paid plan", simply enable it on every paid plan.
+     */
     PlanFeature["CUSTOM_ASSISTANTS"] = "CUSTOM_ASSISTANTS";
 })(PlanFeature || (exports.PlanFeature = PlanFeature = {}));
 //# sourceMappingURL=plan-feature.enum.js.map

package/build/v1/plans/schemas/plan-feature.enum.js.map

@@ -1 +1 @@
-{"version":3,"file":"plan-feature.enum.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/plan-feature.enum.ts"],"names":[],"mappings":";;;AAWA,IAAY,WAmBX;AAnBD,WAAY,WAAW;IACnB,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,sCAAuB,CAAA;IACvB,gCAAiB,CAAA;IAcjB,sDAAuC,CAAA;AAC3C,CAAC,EAnBW,WAAW,2BAAX,WAAW,QAmBtB"}
+{"version":3,"file":"plan-feature.enum.js","sourceRoot":"","sources":["../../../../v1/plans/schemas/plan-feature.enum.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;GAUG;AACH,IAAY,WAmBX;AAnBD,WAAY,WAAW;IACnB,wCAAyB,CAAA;IACzB,0CAA2B,CAAA;IAC3B,sCAAuB,CAAA;IACvB,gCAAiB,CAAA;IACjB;;;;;;;;;;;;OAYG;IACH,sDAAuC,CAAA;AAC3C,CAAC,EAnBW,WAAW,2BAAX,WAAW,QAmBtB"}

package/build/v1/plans/schemas/plan-status.enum.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Lifecycle status of a Plan catalogue entry.
+ *
+ * ACTIVE   — available for purchase.
+ * INACTIVE — hidden from public; admin can still see it.
+ * DELETED  — soft-deleted; FK ON DELETE RESTRICT keeps historical records intact.
+ */
 export declare enum PlanStatus {
     ACTIVE = "ACTIVE",
     INACTIVE = "INACTIVE",