@launchedla/snacktime - npm Package Compare versions

Comparing version 0.0.35 to 0.0.36

dist/types.d.ts

@@ -67,11 +67,3 @@ export interface RecordActionRequiredProps {
 }
-export interface CancelledBundleAction extends CommonProps {
-    label: 'CancelledBundle';
-    scheduledAt: string;
-    cancelFlowSource: CancelFlowSource;
-    reason: string;
-    otherReason?: string;
-    comments?: string;
-    decisionIsFromBrightback?: boolean;
-}
+export declare type CancelledBundleAction = CancelledBundleActionBase | CancelledBundleActionWithOtherReason;
 export interface OrderNowAction extends CommonProps {
@@ -183,2 +175,19 @@ label: 'OrderNow';
 };
+interface CancelledBundleActionBase extends CommonProps {
+    label: 'CancelledBundle';
+    scheduledAt: string;
+    cancelFlowSource: CancelFlowSource;
+    /**
+     * When reason is undefined, the assumption is that the reason for cancellation was not provided by the customer
+     * @todo consider narrowing this to a union of valid reasons
+     */
+    reason?: string;
+    comments?: string;
+    decisionIsFromBrightback?: boolean;
+}
+/** To provide the `otherReason` property, `reason` must be "Other" */
+interface CancelledBundleActionWithOtherReason extends CancelledBundleActionBase {
+    reason: 'Other';
+    otherReason: string;
+}
 interface CommonProps {
@@ -185,0 +194,0 @@ storeCustomer: string;

package.json

 {
   "name": "@launchedla/snacktime",
-  "version": "0.0.35",
+  "version": "0.0.36",
   "description": "Snacktime is a wrapper for the Launched LA internal database that will replicate into Snowflake. It is a replacement for Shopify metafields and an enhanced place to store event-driven data.",
@@ -5,0 +5,0 @@ "main": "dist/index.js",

src/types.ts

@@ -98,11 +98,3 @@ export interface RecordActionRequiredProps {
 
-export interface CancelledBundleAction extends CommonProps {
-  label: 'CancelledBundle'
-  scheduledAt: string
-  cancelFlowSource: CancelFlowSource
-  reason: string
-  otherReason?: string
-  comments?: string
-  decisionIsFromBrightback?: boolean
-}
+export type CancelledBundleAction = CancelledBundleActionBase | CancelledBundleActionWithOtherReason
 
@@ -234,2 +226,21 @@ export interface OrderNowAction extends CommonProps {
 
+interface CancelledBundleActionBase extends CommonProps {
+  label: 'CancelledBundle'
+  scheduledAt: string
+  cancelFlowSource: CancelFlowSource
+  /**
+   * When reason is undefined, the assumption is that the reason for cancellation was not provided by the customer
+   * @todo consider narrowing this to a union of valid reasons
+   */
+  reason?: string
+  comments?: string
+  decisionIsFromBrightback?: boolean
+}
+
+/** To provide the `otherReason` property, `reason` must be "Other" */
+interface CancelledBundleActionWithOtherReason extends CancelledBundleActionBase {
+  reason: 'Other'
+  otherReason: string
+}
+
 interface CommonProps {
@@ -236,0 +247,0 @@ storeCustomer: string

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

782140

increased by0.12%

Lines of code

1959

increased by0.93%

No dependency changes