@hexclave/shared 1.0.0

package/dist/esm/interface/crud/teams.js

@@ -0,0 +1,129 @@
+import { createCrud } from "../../crud.js";
+import * as fieldSchema from "../../schema-fields.js";
+import { yupObject } from "../../schema-fields.js";
+
+//#region src/interface/crud/teams.ts
+const teamsCrudClientReadSchema = yupObject({
+	id: fieldSchema.teamIdSchema.defined(),
+	display_name: fieldSchema.teamDisplayNameSchema.defined(),
+	profile_image_url: fieldSchema.teamProfileImageUrlSchema.nullable().defined(),
+	client_metadata: fieldSchema.teamClientMetadataSchema.optional(),
+	client_read_only_metadata: fieldSchema.teamClientReadOnlyMetadataSchema.optional()
+}).defined();
+const teamsCrudServerReadSchema = teamsCrudClientReadSchema.concat(yupObject({
+	created_at_millis: fieldSchema.teamCreatedAtMillisSchema.defined(),
+	server_metadata: fieldSchema.teamServerMetadataSchema.optional()
+}).defined());
+const teamsCrudClientUpdateSchema = yupObject({
+	display_name: fieldSchema.teamDisplayNameSchema.optional(),
+	profile_image_url: fieldSchema.teamProfileImageUrlSchema.nullable().optional(),
+	client_metadata: fieldSchema.teamClientMetadataSchema.optional()
+}).defined();
+const teamsCrudServerUpdateSchema = teamsCrudClientUpdateSchema.concat(yupObject({
+	client_read_only_metadata: fieldSchema.teamClientReadOnlyMetadataSchema.optional(),
+	server_metadata: fieldSchema.teamServerMetadataSchema.optional()
+}).defined());
+const teamsCrudClientCreateSchema = teamsCrudClientUpdateSchema.concat(yupObject({
+	display_name: fieldSchema.teamDisplayNameSchema.defined(),
+	creator_user_id: fieldSchema.teamCreatorUserIdSchema.optional()
+}).defined());
+const teamsCrudServerCreateSchema = teamsCrudServerUpdateSchema.concat(yupObject({
+	display_name: fieldSchema.teamDisplayNameSchema.defined(),
+	creator_user_id: fieldSchema.teamCreatorUserIdSchema.optional()
+}).defined());
+const teamsCrudClientDeleteSchema = fieldSchema.yupMixed();
+const teamsCrudServerDeleteSchema = teamsCrudClientDeleteSchema;
+const teamsCrud = createCrud({
+	clientReadSchema: teamsCrudClientReadSchema,
+	clientUpdateSchema: teamsCrudClientUpdateSchema,
+	clientCreateSchema: teamsCrudClientCreateSchema,
+	clientDeleteSchema: teamsCrudClientDeleteSchema,
+	serverReadSchema: teamsCrudServerReadSchema,
+	serverUpdateSchema: teamsCrudServerUpdateSchema,
+	serverCreateSchema: teamsCrudServerCreateSchema,
+	serverDeleteSchema: teamsCrudServerDeleteSchema,
+	docs: {
+		clientList: {
+			summary: "List teams",
+			description: "List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters.",
+			tags: ["Teams"]
+		},
+		clientCreate: {
+			summary: "Create a team",
+			description: "Create a new team and optionally add the current user as a member.",
+			tags: ["Teams"]
+		},
+		clientRead: {
+			summary: "Get a team",
+			description: "Get a team that the current user is a member of.",
+			tags: ["Teams"]
+		},
+		clientUpdate: {
+			summary: "Update a team",
+			description: "Update the team information. Only allowed if the current user is a member of the team and has the `$update_team` permission.",
+			tags: ["Teams"]
+		},
+		clientDelete: {
+			summary: "Delete a team",
+			description: "Delete a team. Only allowed if the current user is a member of the team and has the `$delete_team` permission.",
+			tags: ["Teams"]
+		},
+		serverCreate: {
+			summary: "Create a team",
+			description: "Create a new team and optionally add the current user as a member.",
+			tags: ["Teams"]
+		},
+		serverList: {
+			summary: "List teams",
+			description: "List all the teams in the project.",
+			tags: ["Teams"]
+		},
+		serverRead: {
+			summary: "Get a team",
+			description: "Get a team by ID.",
+			tags: ["Teams"]
+		},
+		serverUpdate: {
+			summary: "Update a team",
+			description: "Update the team information by ID.",
+			tags: ["Teams"]
+		},
+		serverDelete: {
+			summary: "Delete a team",
+			description: "Delete a team by ID.",
+			tags: ["Teams"]
+		}
+	}
+});
+const teamCreatedWebhookEvent = {
+	type: "team.created",
+	schema: teamsCrud.server.readSchema,
+	metadata: {
+		summary: "Team Created",
+		description: "This event is triggered when a team is created.",
+		tags: ["Teams"]
+	}
+};
+const teamUpdatedWebhookEvent = {
+	type: "team.updated",
+	schema: teamsCrud.server.readSchema,
+	metadata: {
+		summary: "Team Updated",
+		description: "This event is triggered when a team is updated.",
+		tags: ["Teams"]
+	}
+};
+const webhookTeamDeletedSchema = fieldSchema.yupObject({ id: fieldSchema.userIdSchema.defined() }).defined();
+const teamDeletedWebhookEvent = {
+	type: "team.deleted",
+	schema: webhookTeamDeletedSchema,
+	metadata: {
+		summary: "Team Deleted",
+		description: "This event is triggered when a team is deleted.",
+		tags: ["Teams"]
+	}
+};
+
+//#endregion
+export { teamCreatedWebhookEvent, teamDeletedWebhookEvent, teamUpdatedWebhookEvent, teamsCrud, teamsCrudClientCreateSchema, teamsCrudClientDeleteSchema, teamsCrudClientReadSchema, teamsCrudClientUpdateSchema, teamsCrudServerCreateSchema, teamsCrudServerDeleteSchema, teamsCrudServerReadSchema, teamsCrudServerUpdateSchema };
+//# sourceMappingURL=teams.js.map

package/dist/esm/interface/crud/teams.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"teams.js","names":[],"sources":["../../../../src/interface/crud/teams.ts"],"sourcesContent":["import { CrudTypeOf, createCrud } from \"../../crud\";\nimport * as fieldSchema from \"../../schema-fields\";\nimport { yupObject } from \"../../schema-fields\";\nimport { WebhookEvent } from \"../webhooks\";\n\n// Read\nexport const teamsCrudClientReadSchema = yupObject({\n  id: fieldSchema.teamIdSchema.defined(),\n  display_name: fieldSchema.teamDisplayNameSchema.defined(),\n  profile_image_url: fieldSchema.teamProfileImageUrlSchema.nullable().defined(),\n  client_metadata: fieldSchema.teamClientMetadataSchema.optional(),\n  client_read_only_metadata: fieldSchema.teamClientReadOnlyMetadataSchema.optional(),\n}).defined();\nexport const teamsCrudServerReadSchema = teamsCrudClientReadSchema.concat(yupObject({\n  created_at_millis: fieldSchema.teamCreatedAtMillisSchema.defined(),\n  server_metadata: fieldSchema.teamServerMetadataSchema.optional(),\n}).defined());\n\n// Update\nexport const teamsCrudClientUpdateSchema = yupObject({\n  display_name: fieldSchema.teamDisplayNameSchema.optional(),\n  profile_image_url: fieldSchema.teamProfileImageUrlSchema.nullable().optional(),\n  client_metadata: fieldSchema.teamClientMetadataSchema.optional(),\n}).defined();\nexport const teamsCrudServerUpdateSchema = teamsCrudClientUpdateSchema.concat(yupObject({\n  client_read_only_metadata: fieldSchema.teamClientReadOnlyMetadataSchema.optional(),\n  server_metadata: fieldSchema.teamServerMetadataSchema.optional(),\n}).defined());\n\n// Create\nexport const teamsCrudClientCreateSchema = teamsCrudClientUpdateSchema.concat(yupObject({\n  display_name: fieldSchema.teamDisplayNameSchema.defined(),\n  creator_user_id: fieldSchema.teamCreatorUserIdSchema.optional(),\n}).defined());\nexport const teamsCrudServerCreateSchema = teamsCrudServerUpdateSchema.concat(yupObject({\n  display_name: fieldSchema.teamDisplayNameSchema.defined(),\n  creator_user_id: fieldSchema.teamCreatorUserIdSchema.optional(),\n}).defined());\n\n// Delete\nexport const teamsCrudClientDeleteSchema = fieldSchema.yupMixed();\nexport const teamsCrudServerDeleteSchema = teamsCrudClientDeleteSchema;\n\nexport const teamsCrud = createCrud({\n  // Client\n  clientReadSchema: teamsCrudClientReadSchema,\n  clientUpdateSchema: teamsCrudClientUpdateSchema,\n  clientCreateSchema: teamsCrudClientCreateSchema,\n  clientDeleteSchema: teamsCrudClientDeleteSchema,\n  // Server\n  serverReadSchema: teamsCrudServerReadSchema,\n  serverUpdateSchema: teamsCrudServerUpdateSchema,\n  serverCreateSchema: teamsCrudServerCreateSchema,\n  serverDeleteSchema: teamsCrudServerDeleteSchema,\n  docs: {\n    clientList: {\n      summary: \"List teams\",\n      description: \"List all the teams that the current user is a member of. `user_id=me` must be passed in the query parameters.\",\n      tags: [\"Teams\"],\n    },\n    clientCreate: {\n      summary: \"Create a team\",\n      description: \"Create a new team and optionally add the current user as a member.\",\n      tags: [\"Teams\"],\n    },\n    clientRead: {\n      summary: \"Get a team\",\n      description: \"Get a team that the current user is a member of.\",\n      tags: [\"Teams\"],\n    },\n    clientUpdate: {\n      summary: \"Update a team\",\n      description: \"Update the team information. Only allowed if the current user is a member of the team and has the `$update_team` permission.\",\n      tags: [\"Teams\"],\n    },\n    clientDelete: {\n      summary: \"Delete a team\",\n      description: \"Delete a team. Only allowed if the current user is a member of the team and has the `$delete_team` permission.\",\n      tags: [\"Teams\"],\n    },\n    serverCreate: {\n      summary: \"Create a team\",\n      description: \"Create a new team and optionally add the current user as a member.\",\n      tags: [\"Teams\"],\n    },\n    serverList: {\n      summary: \"List teams\",\n      description: \"List all the teams in the project.\",\n      tags: [\"Teams\"],\n    },\n    serverRead: {\n      summary: \"Get a team\",\n      description: \"Get a team by ID.\",\n      tags: [\"Teams\"],\n    },\n    serverUpdate: {\n      summary: \"Update a team\",\n      description: \"Update the team information by ID.\",\n      tags: [\"Teams\"],\n    },\n    serverDelete: {\n      summary: \"Delete a team\",\n      description: \"Delete a team by ID.\",\n      tags: [\"Teams\"],\n    },\n  },\n});\nexport type TeamsCrud = CrudTypeOf<typeof teamsCrud>;\n\nexport const teamCreatedWebhookEvent = {\n  type: \"team.created\",\n  schema: teamsCrud.server.readSchema,\n  metadata: {\n    summary: \"Team Created\",\n    description: \"This event is triggered when a team is created.\",\n    tags: [\"Teams\"],\n  },\n} satisfies WebhookEvent<typeof teamsCrud.server.readSchema>;\n\nexport const teamUpdatedWebhookEvent = {\n  type: \"team.updated\",\n  schema: teamsCrud.server.readSchema,\n  metadata: {\n    summary: \"Team Updated\",\n    description: \"This event is triggered when a team is updated.\",\n    tags: [\"Teams\"],\n  },\n} satisfies WebhookEvent<typeof teamsCrud.server.readSchema>;\n\nconst webhookTeamDeletedSchema = fieldSchema.yupObject({\n  id: fieldSchema.userIdSchema.defined(),\n}).defined();\n\nexport const teamDeletedWebhookEvent = {\n  type: \"team.deleted\",\n  schema: webhookTeamDeletedSchema,\n  metadata: {\n    summary: \"Team Deleted\",\n    description: \"This event is triggered when a team is deleted.\",\n    tags: [\"Teams\"],\n  },\n} satisfies WebhookEvent<typeof webhookTeamDeletedSchema>;\n"],"mappings":";;;;;AAMA,MAAa,4BAA4B,UAAU;CACjD,IAAI,YAAY,aAAa,SAAS;CACtC,cAAc,YAAY,sBAAsB,SAAS;CACzD,mBAAmB,YAAY,0BAA0B,UAAU,CAAC,SAAS;CAC7E,iBAAiB,YAAY,yBAAyB,UAAU;CAChE,2BAA2B,YAAY,iCAAiC,UAAU;CACnF,CAAC,CAAC,SAAS;AACZ,MAAa,4BAA4B,0BAA0B,OAAO,UAAU;CAClF,mBAAmB,YAAY,0BAA0B,SAAS;CAClE,iBAAiB,YAAY,yBAAyB,UAAU;CACjE,CAAC,CAAC,SAAS,CAAC;AAGb,MAAa,8BAA8B,UAAU;CACnD,cAAc,YAAY,sBAAsB,UAAU;CAC1D,mBAAmB,YAAY,0BAA0B,UAAU,CAAC,UAAU;CAC9E,iBAAiB,YAAY,yBAAyB,UAAU;CACjE,CAAC,CAAC,SAAS;AACZ,MAAa,8BAA8B,4BAA4B,OAAO,UAAU;CACtF,2BAA2B,YAAY,iCAAiC,UAAU;CAClF,iBAAiB,YAAY,yBAAyB,UAAU;CACjE,CAAC,CAAC,SAAS,CAAC;AAGb,MAAa,8BAA8B,4BAA4B,OAAO,UAAU;CACtF,cAAc,YAAY,sBAAsB,SAAS;CACzD,iBAAiB,YAAY,wBAAwB,UAAU;CAChE,CAAC,CAAC,SAAS,CAAC;AACb,MAAa,8BAA8B,4BAA4B,OAAO,UAAU;CACtF,cAAc,YAAY,sBAAsB,SAAS;CACzD,iBAAiB,YAAY,wBAAwB,UAAU;CAChE,CAAC,CAAC,SAAS,CAAC;AAGb,MAAa,8BAA8B,YAAY,UAAU;AACjE,MAAa,8BAA8B;AAE3C,MAAa,YAAY,WAAW;CAElC,kBAAkB;CAClB,oBAAoB;CACpB,oBAAoB;CACpB,oBAAoB;CAEpB,kBAAkB;CAClB,oBAAoB;CACpB,oBAAoB;CACpB,oBAAoB;CACpB,MAAM;EACJ,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,QAAQ;GAChB;EACF;CACF,CAAC;AAGF,MAAa,0BAA0B;CACrC,MAAM;CACN,QAAQ,UAAU,OAAO;CACzB,UAAU;EACR,SAAS;EACT,aAAa;EACb,MAAM,CAAC,QAAQ;EAChB;CACF;AAED,MAAa,0BAA0B;CACrC,MAAM;CACN,QAAQ,UAAU,OAAO;CACzB,UAAU;EACR,SAAS;EACT,aAAa;EACb,MAAM,CAAC,QAAQ;EAChB;CACF;AAED,MAAM,2BAA2B,YAAY,UAAU,EACrD,IAAI,YAAY,aAAa,SAAS,EACvC,CAAC,CAAC,SAAS;AAEZ,MAAa,0BAA0B;CACrC,MAAM;CACN,QAAQ;CACR,UAAU;EACR,SAAS;EACT,aAAa;EACb,MAAM,CAAC,QAAQ;EAChB;CACF"}

package/dist/esm/interface/crud/transactions.d.ts

@@ -0,0 +1,183 @@
+import * as yup$1 from "yup";
+import { InferType } from "yup";
+import * as ______utils_dates0 from "../../utils/dates";
+
+//#region src/interface/crud/transactions.d.ts
+declare const transactionEntrySchema: yup$1.MixedSchema<{
+  type: "money_transfer";
+  customer_type: "user" | "team" | "custom";
+  customer_id: string;
+  charged_amount: {
+    USD?: string | undefined;
+    EUR?: string | undefined;
+    GBP?: string | undefined;
+    JPY?: string | undefined;
+    INR?: string | undefined;
+    AUD?: string | undefined;
+    CAD?: string | undefined;
+  };
+  net_amount: {
+    USD: string;
+  };
+  adjusted_transaction_id: string | null;
+  adjusted_entry_index: number | null;
+} | {
+  type: "item_quantity_change";
+  quantity: number;
+  customer_type: "user" | "team" | "custom";
+  item_id: string;
+  customer_id: string;
+  adjusted_transaction_id: string | null;
+  adjusted_entry_index: number | null;
+} | {
+  one_time_purchase_id?: string | undefined;
+  subscription_id?: string | undefined;
+  type: "product_grant";
+  product: {
+    free_trial?: ______utils_dates0.DayInterval | undefined;
+    client_metadata?: {} | null | undefined;
+    client_read_only_metadata?: {} | null | undefined;
+    server_metadata?: {} | null | undefined;
+    stackable: boolean;
+    prices: Record<string, {
+      USD?: string | undefined;
+      EUR?: string | undefined;
+      GBP?: string | undefined;
+      JPY?: string | undefined;
+      INR?: string | undefined;
+      AUD?: string | undefined;
+      CAD?: string | undefined;
+      interval?: ______utils_dates0.DayInterval | undefined;
+      free_trial?: ______utils_dates0.DayInterval | undefined;
+    }>;
+    display_name: string;
+    customer_type: "user" | "team" | "custom";
+    server_only: boolean;
+    included_items: Record<string, {
+      repeat?: "never" | ______utils_dates0.DayInterval | undefined;
+      quantity?: number | undefined;
+      expires?: "never" | "when-purchase-expires" | "when-repeated" | undefined;
+    }>;
+  };
+  quantity: number;
+  customer_type: "user" | "team" | "custom";
+  customer_id: string;
+  product_id: string | null;
+  adjusted_transaction_id: string | null;
+  adjusted_entry_index: number | null;
+  price_id: string | null;
+} | {
+  type: "product_revocation";
+  quantity: number;
+  adjusted_transaction_id: string;
+  adjusted_entry_index: number;
+} | {
+  type: "product_revocation_reversal";
+  quantity: number;
+  adjusted_transaction_id: string;
+  adjusted_entry_index: number;
+}, yup$1.AnyObject, undefined, "">;
+type TransactionEntry = InferType<typeof transactionEntrySchema>;
+declare const TRANSACTION_TYPES: readonly ["purchase", "subscription-cancellation", "subscription-renewal", "manual-item-quantity-change", "refund", "chargeback", "product-change"];
+type TransactionType = (typeof TRANSACTION_TYPES)[number];
+declare const transactionSchema: yup$1.ObjectSchema<{
+  id: string;
+  created_at_millis: number;
+  effective_at_millis: number;
+  type: "purchase" | "subscription-cancellation" | "subscription-renewal" | "manual-item-quantity-change" | "refund" | "chargeback" | "product-change" | null;
+  customer_type: "user" | "team" | "custom";
+  customer_id: string;
+  entries: ({
+    type: "money_transfer";
+    customer_type: "user" | "team" | "custom";
+    customer_id: string;
+    charged_amount: {
+      USD?: string | undefined;
+      EUR?: string | undefined;
+      GBP?: string | undefined;
+      JPY?: string | undefined;
+      INR?: string | undefined;
+      AUD?: string | undefined;
+      CAD?: string | undefined;
+    };
+    net_amount: {
+      USD: string;
+    };
+    adjusted_transaction_id: string | null;
+    adjusted_entry_index: number | null;
+  } | {
+    type: "item_quantity_change";
+    quantity: number;
+    customer_type: "user" | "team" | "custom";
+    item_id: string;
+    customer_id: string;
+    adjusted_transaction_id: string | null;
+    adjusted_entry_index: number | null;
+  } | {
+    one_time_purchase_id?: string | undefined;
+    subscription_id?: string | undefined;
+    type: "product_grant";
+    product: {
+      free_trial?: ______utils_dates0.DayInterval | undefined;
+      client_metadata?: {} | null | undefined;
+      client_read_only_metadata?: {} | null | undefined;
+      server_metadata?: {} | null | undefined;
+      stackable: boolean;
+      prices: Record<string, {
+        USD?: string | undefined;
+        EUR?: string | undefined;
+        GBP?: string | undefined;
+        JPY?: string | undefined;
+        INR?: string | undefined;
+        AUD?: string | undefined;
+        CAD?: string | undefined;
+        interval?: ______utils_dates0.DayInterval | undefined;
+        free_trial?: ______utils_dates0.DayInterval | undefined;
+      }>;
+      display_name: string;
+      customer_type: "user" | "team" | "custom";
+      server_only: boolean;
+      included_items: Record<string, {
+        repeat?: "never" | ______utils_dates0.DayInterval | undefined;
+        quantity?: number | undefined;
+        expires?: "never" | "when-purchase-expires" | "when-repeated" | undefined;
+      }>;
+    };
+    quantity: number;
+    customer_type: "user" | "team" | "custom";
+    customer_id: string;
+    product_id: string | null;
+    adjusted_transaction_id: string | null;
+    adjusted_entry_index: number | null;
+    price_id: string | null;
+  } | {
+    type: "product_revocation";
+    quantity: number;
+    adjusted_transaction_id: string;
+    adjusted_entry_index: number;
+  } | {
+    type: "product_revocation_reversal";
+    quantity: number;
+    adjusted_transaction_id: string;
+    adjusted_entry_index: number;
+  })[];
+  adjusted_by: {
+    transaction_id: string;
+    entry_index: number;
+  }[];
+  test_mode: boolean;
+}, yup$1.AnyObject, {
+  id: undefined;
+  created_at_millis: undefined;
+  effective_at_millis: undefined;
+  type: undefined;
+  customer_type: undefined;
+  customer_id: undefined;
+  entries: undefined;
+  adjusted_by: undefined;
+  test_mode: undefined;
+}, "">;
+type Transaction = InferType<typeof transactionSchema>;
+//#endregion
+export { TRANSACTION_TYPES, Transaction, TransactionEntry, TransactionType, transactionEntrySchema, transactionSchema };
+//# sourceMappingURL=transactions.d.ts.map

package/dist/esm/interface/crud/transactions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.d.ts","names":[],"sources":["../../../../src/interface/crud/transactions.ts"],"mappings":";;;;;cAwFa,sBAAA,QAAsB,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBAMxB,kBAAA,CAAA,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAEC,gBAAA,GAAmB,SAAA,QAAiB,sBAAA;AAAA,cAEnC,iBAAA;AAAA,KAUD,eAAA,WAA0B,iBAAA;AAAA,cAEzB,iBAAA,QAAiB,YAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAkBlB,kBAAA,CAAA,WAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAEA,WAAA,GAAc,SAAA,QAAiB,iBAAA"}

package/dist/esm/interface/crud/transactions.js

@@ -0,0 +1,85 @@
+import { customerTypeSchema, inlineProductSchema, moneyAmountSchema, yupArray, yupBoolean, yupNumber, yupObject, yupString, yupUnion } from "../../schema-fields.js";
+import { typedFromEntries } from "../../utils/objects.js";
+import { SUPPORTED_CURRENCIES } from "../../utils/currency-constants.js";
+import { throwErr } from "../../utils/errors.js";
+
+//#region src/interface/crud/transactions.ts
+const USD_CURRENCY = SUPPORTED_CURRENCIES.find((currency) => currency.code === "USD") ?? throwErr("USD currency configuration missing in SUPPORTED_CURRENCIES");
+const chargedAmountSchema = yupObject({ ...typedFromEntries(SUPPORTED_CURRENCIES.map((currency) => [currency.code, moneyAmountSchema(currency).optional()])) }).noUnknown(true).test("at-least-one-currency", "charged_amount must include at least one currency amount", (value) => {
+	return Object.values(value).some((amount) => typeof amount === "string");
+}).defined();
+const netAmountSchema = yupObject({ USD: moneyAmountSchema(USD_CURRENCY).defined() }).noUnknown(true).defined();
+const transactionEntryMoneyTransferSchema = yupObject({
+	type: yupString().oneOf(["money_transfer"]).defined(),
+	adjusted_transaction_id: yupString().nullable().defined(),
+	adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),
+	customer_type: customerTypeSchema.defined(),
+	customer_id: yupString().defined(),
+	charged_amount: chargedAmountSchema,
+	net_amount: netAmountSchema
+}).defined();
+const transactionEntryItemQuantityChangeSchema = yupObject({
+	type: yupString().oneOf(["item_quantity_change"]).defined(),
+	adjusted_transaction_id: yupString().nullable().defined(),
+	adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),
+	customer_type: customerTypeSchema.defined(),
+	customer_id: yupString().defined(),
+	item_id: yupString().defined(),
+	quantity: yupNumber().defined()
+}).defined();
+const transactionEntryProductGrantSchema = yupObject({
+	type: yupString().oneOf(["product_grant"]).defined(),
+	adjusted_transaction_id: yupString().nullable().defined(),
+	adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),
+	customer_type: customerTypeSchema.defined(),
+	customer_id: yupString().defined(),
+	product_id: yupString().nullable().defined(),
+	product: inlineProductSchema.defined(),
+	price_id: yupString().nullable().defined(),
+	quantity: yupNumber().defined(),
+	subscription_id: yupString().optional(),
+	one_time_purchase_id: yupString().optional()
+}).test("exclusive-reference", "subscription_id and one_time_purchase_id cannot both be set", (value, context) => {
+	if (value.subscription_id != null && value.one_time_purchase_id != null) return context.createError({ message: "subscription_id and one_time_purchase_id cannot both be set" });
+	return true;
+}).defined();
+const transactionEntryProductRevocationSchema = yupObject({
+	type: yupString().oneOf(["product_revocation"]).defined(),
+	adjusted_transaction_id: yupString().defined(),
+	adjusted_entry_index: yupNumber().integer().min(0).defined(),
+	quantity: yupNumber().defined()
+}).defined();
+const transactionEntryProductRevocationReversalSchema = yupObject({
+	type: yupString().oneOf(["product_revocation_reversal"]).defined(),
+	adjusted_transaction_id: yupString().defined(),
+	adjusted_entry_index: yupNumber().integer().min(0).defined(),
+	quantity: yupNumber().defined()
+}).defined();
+const transactionEntrySchema = yupUnion(transactionEntryMoneyTransferSchema, transactionEntryItemQuantityChangeSchema, transactionEntryProductGrantSchema, transactionEntryProductRevocationSchema, transactionEntryProductRevocationReversalSchema).defined();
+const TRANSACTION_TYPES = [
+	"purchase",
+	"subscription-cancellation",
+	"subscription-renewal",
+	"manual-item-quantity-change",
+	"refund",
+	"chargeback",
+	"product-change"
+];
+const transactionSchema = yupObject({
+	id: yupString().defined(),
+	created_at_millis: yupNumber().defined(),
+	effective_at_millis: yupNumber().defined(),
+	type: yupString().oneOf(TRANSACTION_TYPES).nullable().defined(),
+	customer_type: customerTypeSchema.defined(),
+	customer_id: yupString().defined(),
+	entries: yupArray(transactionEntrySchema).defined(),
+	adjusted_by: yupArray(yupObject({
+		transaction_id: yupString().defined(),
+		entry_index: yupNumber().integer().min(0).defined()
+	}).defined()).defined(),
+	test_mode: yupBoolean().defined()
+}).defined();
+
+//#endregion
+export { TRANSACTION_TYPES, transactionEntrySchema, transactionSchema };
+//# sourceMappingURL=transactions.js.map

package/dist/esm/interface/crud/transactions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transactions.js","names":[],"sources":["../../../../src/interface/crud/transactions.ts"],"sourcesContent":["import type { InferType } from \"yup\";\nimport {\n  customerTypeSchema,\n  inlineProductSchema,\n  moneyAmountSchema,\n  yupArray,\n  yupBoolean,\n  yupNumber,\n  yupObject,\n  yupString,\n  yupUnion,\n} from \"../../schema-fields\";\nimport { SUPPORTED_CURRENCIES } from \"../../utils/currency-constants\";\nimport { typedFromEntries } from \"../../utils/objects\";\nimport { throwErr } from \"../../utils/errors\";\n\n\nconst USD_CURRENCY = SUPPORTED_CURRENCIES.find((currency) => currency.code === \"USD\") ?? throwErr(\"USD currency configuration missing in SUPPORTED_CURRENCIES\");\n\nconst chargedAmountSchema = yupObject({\n  ...typedFromEntries(SUPPORTED_CURRENCIES.map((currency) => [currency.code, moneyAmountSchema(currency).optional()])),\n}).noUnknown(true).test(\"at-least-one-currency\", \"charged_amount must include at least one currency amount\", (value) => {\n  return Object.values(value).some((amount) => typeof amount === \"string\");\n}).defined();\n\nconst netAmountSchema = yupObject({\n  USD: moneyAmountSchema(USD_CURRENCY).defined(),\n}).noUnknown(true).defined();\n\nconst transactionEntryMoneyTransferSchema = yupObject({\n  type: yupString().oneOf([\"money_transfer\"]).defined(),\n  adjusted_transaction_id: yupString().nullable().defined(),\n  adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),\n  customer_type: customerTypeSchema.defined(),\n  customer_id: yupString().defined(),\n  charged_amount: chargedAmountSchema,\n  net_amount: netAmountSchema,\n}).defined();\n\nconst transactionEntryItemQuantityChangeSchema = yupObject({\n  type: yupString().oneOf([\"item_quantity_change\"]).defined(),\n  adjusted_transaction_id: yupString().nullable().defined(),\n  adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),\n  customer_type: customerTypeSchema.defined(),\n  customer_id: yupString().defined(),\n  item_id: yupString().defined(),\n  quantity: yupNumber().defined(),\n}).defined();\n\nconst transactionEntryProductGrantSchema = yupObject({\n  type: yupString().oneOf([\"product_grant\"]).defined(),\n  adjusted_transaction_id: yupString().nullable().defined(),\n  adjusted_entry_index: yupNumber().integer().min(0).nullable().defined(),\n  customer_type: customerTypeSchema.defined(),\n  customer_id: yupString().defined(),\n  product_id: yupString().nullable().defined(),\n  product: inlineProductSchema.defined(),\n  price_id: yupString().nullable().defined(),\n  quantity: yupNumber().defined(),\n  subscription_id: yupString().optional(),\n  one_time_purchase_id: yupString().optional(),\n}).test(\n  \"exclusive-reference\",\n  \"subscription_id and one_time_purchase_id cannot both be set\",\n  (value, context) => {\n    if (value.subscription_id != null && value.one_time_purchase_id != null) {\n      return context.createError({\n        message: \"subscription_id and one_time_purchase_id cannot both be set\",\n      });\n    }\n    return true;\n  },\n).defined();\n\nconst transactionEntryProductRevocationSchema = yupObject({\n  type: yupString().oneOf([\"product_revocation\"]).defined(),\n  adjusted_transaction_id: yupString().defined(),\n  adjusted_entry_index: yupNumber().integer().min(0).defined(),\n  quantity: yupNumber().defined(),\n}).defined();\n\nconst transactionEntryProductRevocationReversalSchema = yupObject({\n  type: yupString().oneOf([\"product_revocation_reversal\"]).defined(),\n  adjusted_transaction_id: yupString().defined(),\n  adjusted_entry_index: yupNumber().integer().min(0).defined(),\n  quantity: yupNumber().defined(),\n}).defined();\n\nexport const transactionEntrySchema = yupUnion(\n  transactionEntryMoneyTransferSchema,\n  transactionEntryItemQuantityChangeSchema,\n  transactionEntryProductGrantSchema,\n  transactionEntryProductRevocationSchema,\n  transactionEntryProductRevocationReversalSchema,\n).defined();\n\nexport type TransactionEntry = InferType<typeof transactionEntrySchema>;\n\nexport const TRANSACTION_TYPES = [\n  \"purchase\",\n  \"subscription-cancellation\",\n  \"subscription-renewal\",\n  \"manual-item-quantity-change\",\n  \"refund\",\n  \"chargeback\", // todo\n  \"product-change\", // todo\n] as const;\n\nexport type TransactionType = (typeof TRANSACTION_TYPES)[number];\n\nexport const transactionSchema = yupObject({\n  id: yupString().defined(),\n  created_at_millis: yupNumber().defined(),\n  effective_at_millis: yupNumber().defined(),\n  type: yupString().oneOf(TRANSACTION_TYPES).nullable().defined(),\n  // Customer is exposed at the transaction level (not only per-entry) so\n  // consumers can attribute every row — including refund rows whose surviving\n  // entries (`product_revocation`, or none at all) carry no customer fields.\n  customer_type: customerTypeSchema.defined(),\n  customer_id: yupString().defined(),\n  entries: yupArray(transactionEntrySchema).defined(),\n  adjusted_by: yupArray(\n    yupObject({\n      transaction_id: yupString().defined(),\n      entry_index: yupNumber().integer().min(0).defined(),\n    }).defined(),\n  ).defined(),\n  test_mode: yupBoolean().defined(),\n}).defined();\n\nexport type Transaction = InferType<typeof transactionSchema>;\n"],"mappings":";;;;;;AAiBA,MAAM,eAAe,qBAAqB,MAAM,aAAa,SAAS,SAAS,MAAM,IAAI,SAAS,6DAA6D;AAE/J,MAAM,sBAAsB,UAAU,EACpC,GAAG,iBAAiB,qBAAqB,KAAK,aAAa,CAAC,SAAS,MAAM,kBAAkB,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,EACrH,CAAC,CAAC,UAAU,KAAK,CAAC,KAAK,yBAAyB,6DAA6D,UAAU;AACtH,QAAO,OAAO,OAAO,MAAM,CAAC,MAAM,WAAW,OAAO,WAAW,SAAS;EACxE,CAAC,SAAS;AAEZ,MAAM,kBAAkB,UAAU,EAChC,KAAK,kBAAkB,aAAa,CAAC,SAAS,EAC/C,CAAC,CAAC,UAAU,KAAK,CAAC,SAAS;AAE5B,MAAM,sCAAsC,UAAU;CACpD,MAAM,WAAW,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,SAAS;CACrD,yBAAyB,WAAW,CAAC,UAAU,CAAC,SAAS;CACzD,sBAAsB,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS;CACvE,eAAe,mBAAmB,SAAS;CAC3C,aAAa,WAAW,CAAC,SAAS;CAClC,gBAAgB;CAChB,YAAY;CACb,CAAC,CAAC,SAAS;AAEZ,MAAM,2CAA2C,UAAU;CACzD,MAAM,WAAW,CAAC,MAAM,CAAC,uBAAuB,CAAC,CAAC,SAAS;CAC3D,yBAAyB,WAAW,CAAC,UAAU,CAAC,SAAS;CACzD,sBAAsB,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS;CACvE,eAAe,mBAAmB,SAAS;CAC3C,aAAa,WAAW,CAAC,SAAS;CAClC,SAAS,WAAW,CAAC,SAAS;CAC9B,UAAU,WAAW,CAAC,SAAS;CAChC,CAAC,CAAC,SAAS;AAEZ,MAAM,qCAAqC,UAAU;CACnD,MAAM,WAAW,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,SAAS;CACpD,yBAAyB,WAAW,CAAC,UAAU,CAAC,SAAS;CACzD,sBAAsB,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,SAAS;CACvE,eAAe,mBAAmB,SAAS;CAC3C,aAAa,WAAW,CAAC,SAAS;CAClC,YAAY,WAAW,CAAC,UAAU,CAAC,SAAS;CAC5C,SAAS,oBAAoB,SAAS;CACtC,UAAU,WAAW,CAAC,UAAU,CAAC,SAAS;CAC1C,UAAU,WAAW,CAAC,SAAS;CAC/B,iBAAiB,WAAW,CAAC,UAAU;CACvC,sBAAsB,WAAW,CAAC,UAAU;CAC7C,CAAC,CAAC,KACD,uBACA,gEACC,OAAO,YAAY;AAClB,KAAI,MAAM,mBAAmB,QAAQ,MAAM,wBAAwB,KACjE,QAAO,QAAQ,YAAY,EACzB,SAAS,+DACV,CAAC;AAEJ,QAAO;EAEV,CAAC,SAAS;AAEX,MAAM,0CAA0C,UAAU;CACxD,MAAM,WAAW,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,SAAS;CACzD,yBAAyB,WAAW,CAAC,SAAS;CAC9C,sBAAsB,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS;CAC5D,UAAU,WAAW,CAAC,SAAS;CAChC,CAAC,CAAC,SAAS;AAEZ,MAAM,kDAAkD,UAAU;CAChE,MAAM,WAAW,CAAC,MAAM,CAAC,8BAA8B,CAAC,CAAC,SAAS;CAClE,yBAAyB,WAAW,CAAC,SAAS;CAC9C,sBAAsB,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS;CAC5D,UAAU,WAAW,CAAC,SAAS;CAChC,CAAC,CAAC,SAAS;AAEZ,MAAa,yBAAyB,SACpC,qCACA,0CACA,oCACA,yCACA,gDACD,CAAC,SAAS;AAIX,MAAa,oBAAoB;CAC/B;CACA;CACA;CACA;CACA;CACA;CACA;CACD;AAID,MAAa,oBAAoB,UAAU;CACzC,IAAI,WAAW,CAAC,SAAS;CACzB,mBAAmB,WAAW,CAAC,SAAS;CACxC,qBAAqB,WAAW,CAAC,SAAS;CAC1C,MAAM,WAAW,CAAC,MAAM,kBAAkB,CAAC,UAAU,CAAC,SAAS;CAI/D,eAAe,mBAAmB,SAAS;CAC3C,aAAa,WAAW,CAAC,SAAS;CAClC,SAAS,SAAS,uBAAuB,CAAC,SAAS;CACnD,aAAa,SACX,UAAU;EACR,gBAAgB,WAAW,CAAC,SAAS;EACrC,aAAa,WAAW,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,SAAS;EACpD,CAAC,CAAC,SAAS,CACb,CAAC,SAAS;CACX,WAAW,YAAY,CAAC,SAAS;CAClC,CAAC,CAAC,SAAS"}