fuze-store-shared 1.0.0

package/README.md

@@ -0,0 +1,2 @@
+# fuze-store-shared
+Fuze Store helpers and types

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './types/invoice';
+export * from './types/plan';
+export * from './types/subscription';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,sBAAsB,CAAC"}

package/dist/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./types/invoice"), exports);
+__exportStar(require("./types/plan"), exports);
+__exportStar(require("./types/subscription"), exports);
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,+CAA6B;AAC7B,uDAAqC"}

package/dist/types/invoice.d.ts

@@ -0,0 +1,63 @@
+export interface InvoiceStatus {
+    id: string;
+    code: "PAID" | "PENDING";
+}
+export interface Invoice {
+    id: string;
+    /**
+     * The reference identifier that connects to payments service
+     */
+    reference: string | null;
+    /**
+     * The first day of your billing cycle
+     */
+    billingStartDate: string;
+    /**
+     * The last day of your billing cycle
+     */
+    billingEndDate: string;
+    /**
+     * Total amount of your billings (base fee, store sales fee, etc)
+     */
+    totalAmount: number;
+    /**
+     * Filename of the invoice document
+     */
+    filename: string;
+    /**
+     * Currency code (e.g., USD, EUR)
+     */
+    currency: string;
+    /**
+     * ISO 8601 formatted date-time string
+     */
+    createdAt: string;
+    /**
+     * ISO 8601 formatted date-time string
+     */
+    updatedAt: string;
+    /**
+     * Status of invoice
+     */
+    status?: InvoiceStatus;
+    /**
+     * List of payments associated with this invoice
+     */
+    payments?: InvoicePayment[];
+}
+export interface InvoicePayment {
+    amount: number;
+    createdAt: string;
+    currency: string;
+    id: string;
+    paymentMethodId: string | null;
+    pspReference: string | null;
+    reference: string | null;
+    updatedAt: string;
+    status?: InvoicePaymentStatus;
+}
+export interface InvoicePaymentStatus {
+    id: string;
+    code: "PAID" | "PENDING" | "FAILED" | "UNKNOWN";
+}
+//# sourceMappingURL=invoice.d.ts.map

package/dist/types/invoice.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice.d.ts","sourceRoot":"","sources":["../../src/types/invoice.ts"],"names":[],"mappings":"AACA,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,SAAS,CAAE;CAC3B;AAED,MAAM,WAAW,OAAO;IACtB,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IACvB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,aAAa,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,oBAAoB,CAAC;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,GAAG,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAC;CACjD"}

package/dist/types/invoice.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=invoice.js.map

package/dist/types/invoice.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"invoice.js","sourceRoot":"","sources":["../../src/types/invoice.ts"],"names":[],"mappings":""}

package/dist/types/plan.d.ts

@@ -0,0 +1,13 @@
+export type PlanCode = 'FREE' | 'BASIC' | 'STARTER' | 'STANDARD' | 'PREMIUM';
+export type Plan = {
+    id: string;
+    name: string;
+    baseFee: number;
+    description: string;
+    salesThreshold: number;
+    commissionRate: number;
+    currency: string;
+    code: PlanCode;
+    features: Record<string, string | number | boolean>;
+};
+//# sourceMappingURL=plan.d.ts.map

package/dist/types/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../src/types/plan.ts"],"names":[],"mappings":"AACA,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,UAAU,GAAE,SAAS,CAAC;AAE5E,MAAM,MAAM,IAAI,GAAG;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,cAAc,EAAE,MAAM,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAC,MAAM,GAAC,OAAO,CAAC,CAAC;CACjD,CAAC"}

package/dist/types/plan.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=plan.js.map

package/dist/types/plan.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.js","sourceRoot":"","sources":["../../src/types/plan.ts"],"names":[],"mappings":""}

package/dist/types/subscription.d.ts

@@ -0,0 +1,54 @@
+import { Invoice } from './invoice';
+import { Plan } from './plan';
+export type Subscription = {
+    id: string;
+    /**
+     * The reference identifier that connects to payments service
+     */
+    reference: string | null;
+    /**
+     * The default payment id where you billed
+     */
+    paymentMethodId: string | null;
+    /**
+     * Start date of billing
+     */
+    startDate: string | null;
+    /**
+     * End date of billing
+     */
+    endDate: string | null;
+    /**
+     * Expiry date of subscription
+     */
+    expiresAt: string | null;
+    /**
+     * Status of subscription
+     */
+    status: 'ACTIVE' | 'PENDING' | 'CANCELED';
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string | null;
+    /**
+     * Subscribed Plan
+     */
+    plan?: Plan;
+    /**
+     * The date for subscribing to new plan
+     */
+    scheduleChangeDate: string | null;
+    /**
+     * The new plan to be subscribed on next billing
+     */
+    newPlan?: Plan;
+    /**
+     * list of subscription invoices
+     */
+    invoices?: Invoice[];
+};
+//# sourceMappingURL=subscription.d.ts.map

package/dist/types/subscription.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.d.ts","sourceRoot":"","sources":["../../src/types/subscription.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAE9B,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAC/B;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,UAAU,CAAC;IAC1C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB;;OAEG;IACH,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ;;OAEG;IACH,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,IAAI,CAAC;IACf;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;CAKtB,CAAC"}

package/dist/types/subscription.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=subscription.js.map

package/dist/types/subscription.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscription.js","sourceRoot":"","sources":["../../src/types/subscription.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "fuze-store-shared",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "repository": "https://github.com/Fuze-Store/fuze-store-shared.git",
+  "author": "kimdelrosario006 <KDelRosario@jaycar.com.au>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc"
+  },
+  "devDependencies": {
+    "typescript": "^5.9.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,4 @@
+export * from './types/invoice';
+export * from './types/plan';
+export * from './types/subscription';
+

package/src/types/invoice.ts

@@ -0,0 +1,67 @@
+
+export interface InvoiceStatus {
+  id: string;
+  code: "PAID" | "PENDING" ;
+}
+
+export interface Invoice {
+  id: string;
+  /**
+   * The reference identifier that connects to payments service
+   */
+  reference: string | null;
+  /**
+   * The first day of your billing cycle
+   */
+  billingStartDate: string;
+  /**
+   * The last day of your billing cycle
+   */
+  billingEndDate: string;
+  /**
+   * Total amount of your billings (base fee, store sales fee, etc)
+   */
+  totalAmount: number;
+  /**
+   * Filename of the invoice document
+   */
+  filename: string;
+  /**
+   * Currency code (e.g., USD, EUR)
+   */
+  currency: string;
+  /**
+   * ISO 8601 formatted date-time string
+   */
+  createdAt: string;
+  /**
+   * ISO 8601 formatted date-time string
+   */
+  updatedAt: string;
+  /**
+   * Status of invoice
+   */
+  status?: InvoiceStatus;
+  /**
+   * List of payments associated with this invoice
+   */
+  payments?: InvoicePayment[];
+}
+
+export interface InvoicePayment {
+  amount: number;
+  createdAt: string;
+  currency: string;
+  id: string;
+  paymentMethodId: string | null;
+  pspReference: string | null;
+  reference: string | null;
+  updatedAt: string;
+  status?: InvoicePaymentStatus;
+}
+
+export interface InvoicePaymentStatus {
+  id: string;
+  code: "PAID" | "PENDING" | "FAILED" | "UNKNOWN";
+}
+

package/src/types/plan.ts

@@ -0,0 +1,14 @@
+
+export type PlanCode = 'FREE' | 'BASIC' | 'STARTER' | 'STANDARD' |'PREMIUM';
+
+export type Plan = {
+  id: string;
+  name: string;
+  baseFee: number;
+  description: string;
+  salesThreshold: number;
+  commissionRate: number;
+  currency: string;
+  code: PlanCode;
+  features: Record<string, string|number|boolean>;
+};

package/src/types/subscription.ts

@@ -0,0 +1,58 @@
+import { Invoice } from './invoice';
+import { Plan } from './plan';
+
+export type Subscription = {
+  id: string;
+  /**
+   * The reference identifier that connects to payments service
+   */
+  reference: string | null;
+  /**
+   * The default payment id where you billed
+   */
+  paymentMethodId: string | null;
+  /**
+   * Start date of billing
+   */
+  startDate: string | null;
+  /**
+   * End date of billing
+   */
+  endDate: string | null;
+  /**
+   * Expiry date of subscription
+   */
+  expiresAt: string | null;
+  /**
+   * Status of subscription
+   */
+  status: 'ACTIVE' | 'PENDING' | 'CANCELED';
+  /**
+   * Creation timestamp
+   */
+  createdAt: string;
+  /**
+   * Last update timestamp
+   */
+  updatedAt: string | null;
+  /**
+   * Subscribed Plan
+   */
+  plan?: Plan;
+  /**
+   * The date for subscribing to new plan
+   */
+  scheduleChangeDate: string | null;
+  /**
+   * The new plan to be subscribed on next billing
+   */
+  newPlan?: Plan;
+  /**
+   * list of subscription invoices
+   */
+  invoices?: Invoice[];
+//   /**
+//    * list of active coupon redemptions
+//    */
+//   activeRedemptions?: CouponRedemption[];
+};

package/tsconfig.json

@@ -0,0 +1,45 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    "types": [],
+    // For nodejs:
+    // "lib": ["esnext"],
+    // "types": ["node"],
+    // and npm install -D @types/node
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    // "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  },
+  "include": ["src"]
+}