merchi_sdk_ts 1.35.0 → 1.36.0

package/RELEASING.md

@@ -0,0 +1,43 @@
+# Automatic npm releases
+
+Merging to `main` triggers `.github/workflows/publish.yml`. No manually edited version or local `npm publish` is needed after the one-time npm trust setup.
+
+## One-time setup
+
+In npm package **merchi_sdk_ts** settings, add a GitHub Actions trusted publisher:
+
+- Owner: `merchisdk`
+- Repository: `merchi_sdk_ts`
+- Workflow filename: `publish.yml`
+- Environment: leave blank (the job has no GitHub environment)
+- Allow direct publishing (`npm publish`), not stage-only publishing.
+
+An npm package owner must authorize this once. There is no `NPM_TOKEN` dependency. Current local npm credentials returned 401, so this trust setup has not been verified or completed by Codex. GitHub branch rules must allow the workflow bot to write the version commit to `main`; the workflow never disables protection or force-pushes.
+
+Official setup: https://docs.npmjs.com/trusted-publishers/
+
+## Behavior
+
+- Builds latest `main` after acquiring a per-repository concurrency slot. Several rapid merges may be included in one release.
+- Uses an explicitly prepared stable version if it is newer than npm latest; otherwise automatically increments the registry's patch version. Major/minor releases remain deliberate changes to package.json.
+- Installs dependencies and builds before publishing. npm install also repairs the historical lockfile/manifest mismatch; the resulting lockfile and version are committed together.
+- Pushes the version commit with `[skip ci]` using `GITHUB_TOKEN`; it does not trigger another push workflow. A concurrent main update rejects the push and prevents publication of that attempt.
+- Publishes through npm OIDC, verifies registry version and git commit, then tags `v<version>`.
+- Re-runs of the already published commit do not bump or republish. If publication failed after the version commit, retries reuse the unpublished version only while it remains newer than latest and unoccupied.
+- The hourly run recovers interrupted releases and packages whose new dependencies were not published yet. A failed build or missing authorization still reports failure; it cannot be solved by inventing credentials or publishing broken code. A manual Actions rerun is optional.
+
+Merge/release SDK and invoice before cart and checkout for the initial wallet release. Cart/checkout require invoice 1.3.2 or later; if merged sooner they wait through failed install/retry runs until it exists. Consumers such as Dashboard retain their normal lockfile update/review process; this workflow does not merge or deploy consumers.
+
+Validation: local release planner tests and YAML parsing. Package builds and payment regression tests were verified separately. Actual GitHub-to-npm publishing still requires the one-time trusted publisher setup and a merged workflow.
+
+## Coexistence with manual publishing
+
+Manual npm publishing remains allowed. The planner reads both latest and all occupied versions, skips occupied versions, and recognizes a manually published main commit even when its version differs from package.json. If latest has no gitHead or its commit is not an ancestor of main, automation pauses with a warning; merge the released source into main or investigate the package provenance before continuing. It never assumes unknown manual code is safe to replace.
+
+Immediately before publishing, the workflow rechecks latest and version availability. A changed registry or a concurrent same-version manual publication is deferred with a warning, without replacing that version or its Git tag. Network/auth/build failures remain failures; the next scheduled run retries. A successful publish with a lost response is reconciled against the registry gitHead.
+
+GitHub concurrency serializes Actions only, not developers' npm commands. npm has no cross-publisher lock or atomic compare-and-set for latest: simultaneous different-version manual and automatic publishes can still race on latest. When doing an exceptional manual release, coordinate to avoid an active publish job (or temporarily disable this workflow and wait for any active job to finish). Prefer the automatic workflow for routine releases. No script force-pushes, unpublishes, or rewrites an existing Git tag. Published version immutability prevents overwriting that version, but does not make latest race-free. First hosted OIDC publication still needs verification after merge.
+
+## Release recovery
+
+Publication verification queries the exact version with fresh registry reads, retrying up to seven times over 30 seconds without repeating npm publish. Each run also recovers the latest published version's missing Git tag before preparing a new release, including when main has advanced. Recovery requires the registry gitHead to be contained in the checkout history. Existing conflicting tags fail visibly and are never overwritten. Ignored, untracked lockfiles are not staged. Branch rules must still permit the normal version commit push; protection is never changed by this workflow.

package/dist/constants/roles.js

@@ -34,6 +34,7 @@ export var Role;
     Role[Role["MANAGER"] = 6] = "MANAGER";
     Role[Role["ACCOUNTANT"] = 7] = "ACCOUNTANT";
     Role[Role["THEME_EDITOR"] = 8] = "THEME_EDITOR";
+    Role[Role["REFERRER"] = 9] = "REFERRER";
 })(Role || (Role = {}));
 export var DOMAIN_MANAGERS = [Role.ADMIN, Role.MANAGER];
 export var MANAGEMENT_TEAM = __spreadArray(__spreadArray([], __read(DOMAIN_MANAGERS), false), [

package/dist/entities/cart.js

@@ -76,6 +76,10 @@ var Cart = /** @class */ (function (_super) {
         Cart.property(),
         __metadata("design:type", Number)
     ], Cart.prototype, "id", void 0);
+    __decorate([
+        Cart.property(),
+        __metadata("design:type", String)
+    ], Cart.prototype, "stripePaymentEngine", void 0);
     __decorate([
         Cart.property(),
         __metadata("design:type", Date)

package/dist/entities/cart.test.js

@@ -43,3 +43,9 @@ test('pass cookie tokens to query string', function () {
     expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
     return invocation;
 });
+test('preserves server payment engine hint', function () {
+    var merchi = new Merchi();
+    var entity = new merchi.Cart();
+    entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
+    expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
+});

package/dist/entities/discount.js

@@ -24,6 +24,7 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 import { Entity } from '../entity.js';
 import { DiscountGroup } from './discount_group.js';
+import { User } from './user.js';
 var Discount = /** @class */ (function (_super) {
     __extends(Discount, _super);
     function Discount() {
@@ -75,6 +76,10 @@ var Discount = /** @class */ (function (_super) {
         Discount.property({ arrayType: 'User' }),
         __metadata("design:type", Array)
     ], Discount.prototype, "assignedUsers", void 0);
+    __decorate([
+        Discount.property({ type: User }),
+        __metadata("design:type", Object)
+    ], Discount.prototype, "referrer", void 0);
     __decorate([
         Discount.property({ type: DiscountGroup }),
         __metadata("design:type", Object)

package/dist/entities/discount.test.js

@@ -13,6 +13,15 @@ test('can set assignedUsers', function () {
     discount.assignedUsers = [user];
     expect((_a = discount.assignedUsers) === null || _a === void 0 ? void 0 : _a.map(function (assigned) { return assigned.id; })).toEqual([11]);
 });
+test('can set referrer', function () {
+    var _a;
+    var merchi = new Merchi();
+    var discount = new merchi.Discount();
+    var user = new merchi.User();
+    user.id = 22;
+    discount.referrer = user;
+    expect((_a = discount.referrer) === null || _a === void 0 ? void 0 : _a.id).toEqual(22);
+});
 test('discountedUnitCost', function () {
     var merchi = new Merchi();
     var discount = new merchi.Discount();

package/dist/entities/invoice.js

@@ -47,6 +47,10 @@ var Invoice = /** @class */ (function (_super) {
         Invoice.property(),
         __metadata("design:type", Number)
     ], Invoice.prototype, "id", void 0);
+    __decorate([
+        Invoice.property(),
+        __metadata("design:type", String)
+    ], Invoice.prototype, "stripePaymentEngine", void 0);
     __decorate([
         Invoice.property({ type: Date }),
         __metadata("design:type", Object)

package/dist/entities/invoice.test.js

@@ -37,3 +37,9 @@ test('client and invoice tokens supported by merchi', function () {
     expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
     return invocation;
 });
+test('preserves server payment engine hint', function () {
+    var merchi = new Merchi();
+    var entity = new merchi.Invoice();
+    entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
+    expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
+});

package/dist/entities/payment.js

@@ -61,6 +61,22 @@ var Payment = /** @class */ (function (_super) {
         Payment.property(),
         __metadata("design:type", Number)
     ], Payment.prototype, "paymentType", void 0);
+    __decorate([
+        Payment.property(),
+        __metadata("design:type", String)
+    ], Payment.prototype, "paymentProvider", void 0);
+    __decorate([
+        Payment.property(),
+        __metadata("design:type", String)
+    ], Payment.prototype, "paymentMethod", void 0);
+    __decorate([
+        Payment.property(),
+        __metadata("design:type", Number)
+    ], Payment.prototype, "refundedAmount", void 0);
+    __decorate([
+        Payment.property({ type: String }),
+        __metadata("design:type", Object)
+    ], Payment.prototype, "refundStatus", void 0);
     __decorate([
         Payment.property(),
         __metadata("design:type", String)

package/dist/entities/payment.test.js

@@ -14,3 +14,9 @@ test('payment refund', function () {
         expect(payment.amount).toEqual(10);
     });
 });
+test('wallet method and partial refund survive API serialization', function () {
+    var payment = new (new Merchi()).Payment();
+    payment.fromJson({ id: 8, amount: 20, paymentType: 1, paymentProvider: 'stripe',
+        paymentMethod: 'wechat_pay', refundedAmount: 5, refundStatus: 'pending' });
+    expect(payment.toJson()).toMatchObject({ paymentMethod: 'wechat_pay', refundedAmount: 5, refundStatus: 'pending' });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "merchi_sdk_ts",
-  "version": "1.35.0",
+  "version": "1.36.0",
   "main": "dist/index.js",
   "type": "module",
   "repository": "git@github.com:merchisdk/merchi_sdk_ts.git",

package/src/constants/roles.ts

@@ -8,6 +8,7 @@ export enum Role {
   MANAGER = 6,
   ACCOUNTANT = 7,
   THEME_EDITOR = 8,
+  REFERRER = 9,
 }
 
 export const DOMAIN_MANAGERS = [Role.ADMIN, Role.MANAGER];

package/src/entities/cart.test.ts

@@ -48,3 +48,10 @@ test('pass cookie tokens to query string', () => {
   expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
   return invocation;
 });
+
+test('preserves server payment engine hint', () => {
+  const merchi = new Merchi();
+  const entity = new merchi.Cart();
+  entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
+  expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
+});

package/src/entities/cart.ts

@@ -19,6 +19,9 @@ export class Cart extends Entity {
   @Cart.property()
   public id?: number;
 
+  @Cart.property()
+  public stripePaymentEngine?: string;
+
   @Cart.property()
   public creationDate?: Date;
 

package/src/entities/discount.test.ts

@@ -15,6 +15,15 @@ test('can set assignedUsers', () => {
   expect(discount.assignedUsers?.map((assigned) => assigned.id)).toEqual([11]);
 });
 
+test('can set referrer', () => {
+  const merchi = new Merchi();
+  const discount = new merchi.Discount();
+  const user = new merchi.User();
+  user.id = 22;
+  discount.referrer = user;
+  expect(discount.referrer?.id).toEqual(22);
+});
+
 test('discountedUnitCost', () => {
   const merchi = new Merchi();
   const discount = new merchi.Discount();

package/src/entities/discount.ts

@@ -31,6 +31,9 @@ export class Discount extends Entity {
   @Discount.property({arrayType: 'User'})
   public assignedUsers?: User[];
 
+  @Discount.property({type: User})
+  public referrer?: User | null;
+
   @Discount.property({type: DiscountGroup})
   public discountGroup?: DiscountGroup | null;
 

package/src/entities/invoice.test.ts

@@ -41,3 +41,10 @@ test('client and invoice tokens supported by merchi', () => {
   expect(fetch.mock.calls[0][1]['query']).toEqual(correct);
   return invocation;
 });
+
+test('preserves server payment engine hint', () => {
+  const merchi = new Merchi();
+  const entity = new merchi.Invoice();
+  entity.fromJson({ id: 1, stripePaymentEngine: 'wallet' });
+  expect(entity.toJson()).toMatchObject({ stripePaymentEngine: 'wallet' });
+});

package/src/entities/invoice.ts

@@ -28,6 +28,9 @@ export class Invoice extends Entity {
   @Invoice.property()
   public id?: number;
 
+  @Invoice.property()
+  public stripePaymentEngine?: string;
+
   @Invoice.property({type: Date})
   public creationDate?: Date | null;
 

package/src/entities/payment.test.ts

@@ -17,3 +17,11 @@ test('payment refund', () => {
     expect(payment.amount).toEqual(10);
   });
 });
+
+
+test('wallet method and partial refund survive API serialization', () => {
+  const payment = new (new Merchi()).Payment();
+  payment.fromJson({ id: 8, amount: 20, paymentType: 1, paymentProvider: 'stripe',
+    paymentMethod: 'wechat_pay', refundedAmount: 5, refundStatus: 'pending' });
+  expect(payment.toJson()).toMatchObject({ paymentMethod: 'wechat_pay', refundedAmount: 5, refundStatus: 'pending' });
+});

package/src/entities/payment.ts

@@ -21,6 +21,18 @@ export class Payment extends Entity {
   @Payment.property()
   public paymentType?: number;
 
+  @Payment.property()
+  public paymentProvider?: string;
+
+  @Payment.property()
+  public paymentMethod?: string;
+
+  @Payment.property()
+  public refundedAmount?: number;
+
+  @Payment.property({ type: String })
+  public refundStatus?: string | null;
+
   @Payment.property()
   public note?: string;