@oxy.so/contracts 4.10.0 → 4.11.0

package/dist/types/products/plans.d.ts

@@ -0,0 +1,319 @@
+import { z } from 'zod';
+/** Approved display terms never identify or activate a billing-provider price. */
+export declare const personalPlanDisplayPriceSchema: z.ZodObject<{
+    currency: z.ZodString;
+    amountMinorUnits: z.ZodNumber;
+    interval: z.ZodLiteral<"month">;
+    trial: z.ZodLiteral<"none">;
+    taxTreatment: z.ZodLiteral<"inclusive">;
+    merchantTotal: z.ZodLiteral<"final">;
+}, "strict", z.ZodTypeAny, {
+    currency: string;
+    amountMinorUnits: number;
+    interval: "month";
+    trial: "none";
+    taxTreatment: "inclusive";
+    merchantTotal: "final";
+}, {
+    currency: string;
+    amountMinorUnits: number;
+    interval: "month";
+    trial: "none";
+    taxTreatment: "inclusive";
+    merchantTotal: "final";
+}>;
+/** Public discovery is separate from customer access. No provider or owner IDs. */
+export declare const personalPlanCatalogueSchema: z.ZodEffects<z.ZodObject<{
+    schemaVersion: z.ZodLiteral<1>;
+    state: z.ZodEnum<["unconfigured", "configured"]>;
+    purchase: z.ZodLiteral<"unavailable">;
+    plans: z.ZodArray<z.ZodObject<{
+        offerId: z.ZodString;
+        offerVersion: z.ZodNumber;
+        displayName: z.ZodString;
+        audience: z.ZodLiteral<"personal">;
+        kind: z.ZodLiteral<"oxy_one">;
+        price: z.ZodOptional<z.ZodObject<{
+            currency: z.ZodString;
+            amountMinorUnits: z.ZodNumber;
+            interval: z.ZodLiteral<"month">;
+            trial: z.ZodLiteral<"none">;
+            taxTreatment: z.ZodLiteral<"inclusive">;
+            merchantTotal: z.ZodLiteral<"final">;
+        }, "strict", z.ZodTypeAny, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }, {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        }>>;
+        benefits: z.ZodArray<z.ZodObject<{
+            displayName: z.ZodString;
+            benefit: z.ZodDiscriminatedUnion<"kind", [z.ZodObject<{
+                kind: z.ZodLiteral<"capability">;
+                productId: z.ZodString;
+                key: z.ZodString;
+            }, "strict", z.ZodTypeAny, {
+                kind: "capability";
+                key: string;
+                productId: string;
+            }, {
+                kind: "capability";
+                key: string;
+                productId: string;
+            }>, z.ZodObject<{
+                kind: z.ZodLiteral<"quota">;
+                productId: z.ZodString;
+                key: z.ZodString;
+                unit: z.ZodString;
+                included: z.ZodNumber;
+                combination: z.ZodEnum<["maximum", "sum", "exclusive"]>;
+            }, "strict", z.ZodTypeAny, {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            }, {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            }>]>;
+        }, "strict", z.ZodTypeAny, {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }, {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }>, "many">;
+    }, "strict", z.ZodTypeAny, {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }, {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }>, "many">;
+}, "strict", z.ZodTypeAny, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}>, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}, {
+    schemaVersion: 1;
+    state: "unconfigured" | "configured";
+    purchase: "unavailable";
+    plans: {
+        displayName: string;
+        kind: "oxy_one";
+        audience: "personal";
+        benefits: {
+            displayName: string;
+            benefit: {
+                kind: "capability";
+                key: string;
+                productId: string;
+            } | {
+                kind: "quota";
+                key: string;
+                unit: string;
+                included: number;
+                productId: string;
+                combination: "maximum" | "sum" | "exclusive";
+            };
+        }[];
+        offerId: string;
+        offerVersion: number;
+        price?: {
+            currency: string;
+            amountMinorUnits: number;
+            interval: "month";
+            trial: "none";
+            taxTreatment: "inclusive";
+            merchantTotal: "final";
+        } | undefined;
+    }[];
+}>;
+export type PersonalPlanCatalogue = z.infer<typeof personalPlanCatalogueSchema>;

package/dist/types/reputation.d.ts

@@ -24,8 +24,8 @@
  *  - **The balance has two views, and the union is the contract.** See
  *    {@link ReputationBalanceView} — the compile-time assertions below are what
  *    stop the private view's fields becoming reachable on a stranger's balance.
- *  - **The closed value sets live here, not beside the mongoose models.** The
- *    API's model enums and the SDK's unions are the same `as const` tuple, so a
+ *  - **The closed value sets live here, not beside the database schema.** The
+ *    API's column enums and the SDK's unions are the same `as const` tuple, so a
  *    seventh category cannot be added on one side only.
  *
  * The response entities are declared as explicit `interface`s with their runtime
@@ -93,7 +93,7 @@ export declare const reputationInfluenceContextSchema: z.ZodEnum<["default", "re
  * appended), written only by policy-driven code — never by a person.
  */
 export interface ReputationTransaction {
-    /** The transaction's Mongo `_id` as a string. */
+    /** The transaction's id, as a string. */
     id: string;
     /** Subject of the reputation change — the user whose balance moves. */
     userId: string;
@@ -298,7 +298,7 @@ export declare const reputationRulesResponseSchema: z.ZodType<ReputationRulesRes
  * real name — fall back to the handle when it is absent, never recompose.
  */
 export interface ReputationLeaderboardUser {
-    /** The user's Mongo `_id` as a string. */
+    /** The user's id, as a string. */
     id: string;
     username: string;
     name: UserNameResponse;

package/dist/types/updates.d.ts

@@ -11,7 +11,7 @@
  * CLI, the console hook) validates its INPUT against the same definitions, so
  * producer and consumers cannot drift.
  *
- * Domain model (mirrors the Mongoose models in `@oxy.so/api`):
+ * Domain model (mirrors the update tables in `@oxy.so/api`):
  *  - A `channel` (e.g. `production`, `preview`, `pr-123`) is a named release
  *    track for one application.
  *  - An `update` is one published bundle for a single `(channel, runtimeVersion,