@reactionary/core 0.2.1 → 0.2.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reactionary/core",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "main": "index.js",
   "types": "src/index.d.ts",
   "dependencies": {

package/schemas/models/profile.model.js

@@ -22,7 +22,7 @@ const ProfileSchema = BaseModelSchema.extend({
   updatedAt: z.string(),
   shippingAddress: AddressSchema.optional(),
   billingAddress: AddressSchema.optional(),
-  alternateShippingAddresses: z.array(AddressSchema)
+  alternateShippingAddresses: z.array(AddressSchema).default(() => [])
 });
 export {
   AddressSchema,

package/schemas/mutations/profile.mutation.js

@@ -1,9 +1,37 @@
 import { z } from "zod";
 import { BaseMutationSchema } from "./base.mutation.js";
+import { AddressIdentifierSchema, IdentityIdentifierSchema } from "../models/identifiers.model.js";
+import { AddressSchema } from "../models/profile.model.js";
 const ProfileMutationUpdateSchema = BaseMutationSchema.extend({
-  email: z.email(),
-  phone: z.string()
+  identifier: IdentityIdentifierSchema,
+  email: z.email().describe("The main contact email of the profile"),
+  phone: z.string().describe("The main phone number of the profile")
+});
+const ProfileMutationAddShippingAddressSchema = BaseMutationSchema.extend({
+  identifier: IdentityIdentifierSchema,
+  address: AddressSchema
+});
+const ProfileMutationRemoveShippingAddressSchema = BaseMutationSchema.extend({
+  identifier: IdentityIdentifierSchema,
+  addressIdentifier: AddressIdentifierSchema
+});
+const ProfileMutationUpdateShippingAddressSchema = BaseMutationSchema.extend({
+  identifier: IdentityIdentifierSchema,
+  address: AddressSchema
+});
+const ProfileMutationMakeShippingAddressDefaultSchema = BaseMutationSchema.extend({
+  identifier: IdentityIdentifierSchema,
+  addressIdentifier: AddressIdentifierSchema
+});
+const ProfileMutationSetBillingAddressSchema = BaseMutationSchema.extend({
+  identifier: IdentityIdentifierSchema,
+  address: AddressSchema
 });
 export {
-  ProfileMutationUpdateSchema
+  ProfileMutationAddShippingAddressSchema,
+  ProfileMutationMakeShippingAddressDefaultSchema,
+  ProfileMutationRemoveShippingAddressSchema,
+  ProfileMutationSetBillingAddressSchema,
+  ProfileMutationUpdateSchema,
+  ProfileMutationUpdateShippingAddressSchema
 };

package/schemas/queries/profile.query.js

@@ -1,5 +1,8 @@
 import { BaseQuerySchema } from "./base.query.js";
-const ProfileQuerySelfSchema = BaseQuerySchema.extend({});
+import { IdentityIdentifierSchema } from "../models/identifiers.model.js";
+const ProfileQueryByIdSchema = BaseQuerySchema.extend({
+  identifier: IdentityIdentifierSchema
+});
 export {
-  ProfileQuerySelfSchema
+  ProfileQueryByIdSchema
 };

package/src/providers/profile.provider.d.ts

@@ -1,10 +1,71 @@
+import type { NotFoundError } from '../schemas/index.js';
 import type { Profile } from '../schemas/models/index.js';
-import type { ProfileMutationUpdate } from '../schemas/mutations/index.js';
-import type { ProfileQuerySelf } from '../schemas/queries/index.js';
+import type { ProfileMutationAddShippingAddress, ProfileMutationMakeShippingAddressDefault, ProfileMutationRemoveShippingAddress, ProfileMutationSetBillingAddress, ProfileMutationUpdate, ProfileMutationUpdateShippingAddress } from '../schemas/mutations/index.js';
+import type { ProfileQuerySelf as ProfileQueryById } from '../schemas/queries/index.js';
 import type { Result } from '../schemas/result.js';
 import { BaseProvider } from './base.provider.js';
 export declare abstract class ProfileProvider extends BaseProvider {
-    abstract getSelf(payload: ProfileQuerySelf): Promise<Result<Profile>>;
-    abstract update(payload: ProfileMutationUpdate): Promise<Result<Profile>>;
+    /**
+     * Returns the profile of the currently authenticated (registered) user.
+     *
+     * Usecase: Fetch the profile of the logged-in user for display in header, or account settings.
+     * @param payload
+     */
+    abstract getById(payload: ProfileQueryById): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Updates the base profile information of the currently authenticated (registered) user.
+     *
+     * TODO: This should include first/lastname.
+     * TODO: In some systems, updating email/phone may require re-verification.
+     * TODO: Handle conflicts if email/phone is already in use by another user.
+     * TODO: In some systems the email might not be editable.
+     *
+     * Usecase: Update the user's name, email, or phone number.
+     * @param payload
+     */
+    abstract update(payload: ProfileMutationUpdate): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Creates a new shipping address for the currently authenticated (registered) user.
+     * Does not set it as default automatically.
+     *
+     * Usecase: User adds a new shipping address in their profile or during checkout. Ideally, any address manipulation
+     * done at checkout should be considered local to that session, unless the addressbook is empty.
+     * @param payload
+     */
+    abstract addShippingAddress(payload: ProfileMutationAddShippingAddress): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Updates an existing shipping address for the currently authenticated (registered) user.
+     *
+     * Usecase: User edits an existing shipping address in their profile. Ideally, any address manipulation
+     * done at checkout should be considered local to that session/order, unless the addressbook is empty.
+     * @param payload
+     */
+    abstract updateShippingAddress(payload: ProfileMutationUpdateShippingAddress): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Removes an existing shipping address for the currently authenticated (registered) user.
+     *
+     * If the removed address was the default shipping address, the default shipping address is set to a random other address.
+     *
+     * Usecase: User deletes a shipping address from their profile.
+     * @param payload
+     */
+    abstract removeShippingAddress(payload: ProfileMutationRemoveShippingAddress): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Configures an existing shipping address as the default shipping address for the currently authenticated (registered) user.
+     *
+     * Usecase: User selects a default shipping address in their profile.
+     * @param payload
+     */
+    abstract makeShippingAddressDefault(payload: ProfileMutationMakeShippingAddressDefault): Promise<Result<Profile, NotFoundError>>;
+    /**
+     * Sets the current/active billing address for the currently authenticated (registered) user.
+     *
+     * Usecase: User sets or updates their billing address in their profile or during checkout.
+     *
+     * It was a design decision not to support multiple billing addresses. The billing address represents who you are as the commercial
+     * entity being billed, and as such it makes sense to have a single authoritative billing address.
+     * @param payload
+     */
+    abstract setBillingAddress(payload: ProfileMutationSetBillingAddress): Promise<Result<Profile, NotFoundError>>;
     protected getResourceName(): string;
 }

package/src/schemas/models/profile.model.d.ts

@@ -49,7 +49,7 @@ export declare const ProfileSchema: z.ZodObject<{
         postalCode: z.ZodString;
         countryCode: z.ZodString;
     }, z.core.$loose>>;
-    alternateShippingAddresses: z.ZodArray<z.ZodObject<{
+    alternateShippingAddresses: z.ZodDefault<z.ZodArray<z.ZodObject<{
         identifier: z.ZodDefault<z.ZodObject<{
             nickName: z.ZodString;
         }, z.core.$loose>>;
@@ -61,7 +61,7 @@ export declare const ProfileSchema: z.ZodObject<{
         region: z.ZodString;
         postalCode: z.ZodString;
         countryCode: z.ZodString;
-    }, z.core.$loose>>;
+    }, z.core.$loose>>>;
 }, z.core.$loose>;
 export type Address = InferType<typeof AddressSchema>;
 export type Profile = InferType<typeof ProfileSchema>;

package/src/schemas/mutations/profile.mutation.d.ts

@@ -1,7 +1,85 @@
 import { z } from 'zod';
 import type { InferType } from '../../zod-utils.js';
 export declare const ProfileMutationUpdateSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
     email: z.ZodEmail;
     phone: z.ZodString;
 }, z.core.$loose>;
+export declare const ProfileMutationAddShippingAddressSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+    address: z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodString;
+        }, z.core.$loose>>;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        streetAddress: z.ZodString;
+        streetNumber: z.ZodString;
+        city: z.ZodString;
+        region: z.ZodString;
+        postalCode: z.ZodString;
+        countryCode: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const ProfileMutationRemoveShippingAddressSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+    addressIdentifier: z.ZodObject<{
+        nickName: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const ProfileMutationUpdateShippingAddressSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+    address: z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodString;
+        }, z.core.$loose>>;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        streetAddress: z.ZodString;
+        streetNumber: z.ZodString;
+        city: z.ZodString;
+        region: z.ZodString;
+        postalCode: z.ZodString;
+        countryCode: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const ProfileMutationMakeShippingAddressDefaultSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+    addressIdentifier: z.ZodObject<{
+        nickName: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export declare const ProfileMutationSetBillingAddressSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+    address: z.ZodObject<{
+        identifier: z.ZodDefault<z.ZodObject<{
+            nickName: z.ZodString;
+        }, z.core.$loose>>;
+        firstName: z.ZodString;
+        lastName: z.ZodString;
+        streetAddress: z.ZodString;
+        streetNumber: z.ZodString;
+        city: z.ZodString;
+        region: z.ZodString;
+        postalCode: z.ZodString;
+        countryCode: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
 export type ProfileMutationUpdate = InferType<typeof ProfileMutationUpdateSchema>;
+export type ProfileMutationAddShippingAddress = InferType<typeof ProfileMutationAddShippingAddressSchema>;
+export type ProfileMutationRemoveShippingAddress = InferType<typeof ProfileMutationRemoveShippingAddressSchema>;
+export type ProfileMutationMakeShippingAddressDefault = InferType<typeof ProfileMutationMakeShippingAddressDefaultSchema>;
+export type ProfileMutationSetBillingAddress = InferType<typeof ProfileMutationSetBillingAddressSchema>;
+export type ProfileMutationUpdateShippingAddress = InferType<typeof ProfileMutationUpdateShippingAddressSchema>;

package/src/schemas/queries/profile.query.d.ts

@@ -1,4 +1,8 @@
 import type { z } from 'zod';
 import type { InferType } from '../../zod-utils.js';
-export declare const ProfileQuerySelfSchema: z.ZodObject<{}, z.core.$loose>;
-export type ProfileQuerySelf = InferType<typeof ProfileQuerySelfSchema>;
+export declare const ProfileQueryByIdSchema: z.ZodObject<{
+    identifier: z.ZodObject<{
+        userId: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+export type ProfileQuerySelf = InferType<typeof ProfileQueryByIdSchema>;