@conseqa/connector-shopify 0.0.0-reserved.0 → 0.1.8

package/dist/types.d.ts

@@ -0,0 +1,88 @@
+import { z } from "zod";
+/** Shopify names an order by a global ID; the numeric ID from the admin URL is accepted too. */
+export declare function toShopifyOrderGid(value: string): string;
+/**
+ * The refund an agent means to make. Amounts follow the Conseqa convention of
+ * whole minor units (paise, cents) and upper-case ISO currency codes; Shopify
+ * reports decimal strings and is converted at the comparison boundary.
+ */
+export declare const shopifyRefundIntentSchema: z.ZodObject<{
+    orderId: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+    amountMinor: z.ZodNumber;
+    currency: z.ZodPipe<z.ZodString, z.ZodTransform<string, string>>;
+}, z.core.$strict>;
+export type ShopifyRefundIntent = z.infer<typeof shopifyRefundIntentSchema>;
+export declare const shopifyRefundBindingSchema: z.ZodObject<{
+    refundId: z.ZodString;
+    recovered: z.ZodDefault<z.ZodBoolean>;
+}, z.core.$strict>;
+export type ShopifyRefundBinding = z.infer<typeof shopifyRefundBindingSchema>;
+/** What the connector saw, reduced to the facts the verdict rests on. */
+export declare const shopifyRefundObservationSchema: z.ZodObject<{
+    refundId: z.ZodString;
+    orderId: z.ZodNullable<z.ZodString>;
+    correlationKey: z.ZodNullable<z.ZodString>;
+    amountMinor: z.ZodNumber;
+    currency: z.ZodNullable<z.ZodString>;
+    transactionStatuses: z.ZodArray<z.ZodString>;
+    status: z.ZodEnum<{
+        succeeded: "succeeded";
+        pending: "pending";
+        failed: "failed";
+        no_transactions: "no_transactions";
+    }>;
+    settled: z.ZodBoolean;
+    createdAt: z.ZodNullable<z.ZodString>;
+}, z.core.$strict>;
+export type ShopifyRefundObservation = z.infer<typeof shopifyRefundObservationSchema>;
+export interface ShopifyMoney {
+    readonly amount: string;
+    readonly currencyCode: string;
+}
+export interface ShopifyMoneyBag {
+    readonly shopMoney: ShopifyMoney;
+    readonly presentmentMoney?: ShopifyMoney | null;
+}
+export interface ShopifyRefundTransaction {
+    readonly id: string;
+    readonly kind: string;
+    /** SUCCESS, PENDING, FAILURE, ERROR, AWAITING_RESPONSE or UNKNOWN. */
+    readonly status: string;
+    readonly amountSet: ShopifyMoneyBag;
+}
+export interface ShopifyRefundResource {
+    readonly id: string;
+    readonly createdAt?: string | null;
+    readonly note?: string | null;
+    /** Present when the refund was read on its own rather than through its order. */
+    readonly orderId?: string;
+    readonly transactions: readonly ShopifyRefundTransaction[];
+    /** False when the refund has more transactions than one read returns. */
+    readonly transactionsComplete: boolean;
+}
+export interface ShopifyOrderRefunds {
+    readonly orderId: string;
+    readonly refunds: readonly ShopifyRefundResource[];
+    /** False when the order has more refunds than one read returns. */
+    readonly refundsComplete: boolean;
+}
+/** Everything the connector may ask Shopify. There is no method that writes. */
+export interface ShopifyReadApi {
+    /** The order's refunds, or null when the order cannot be read with this token. */
+    getOrderRefunds(orderId: string, signal?: AbortSignal): Promise<ShopifyOrderRefunds | null>;
+    /** One refund, or null when it does not exist or cannot be read. */
+    getRefund(refundId: string, signal?: AbortSignal): Promise<ShopifyRefundResource | null>;
+}
+export type ShopifyRefundDiscoveryResult = {
+    readonly kind: "found";
+    readonly binding: ShopifyRefundBinding;
+} | {
+    readonly kind: "not_found";
+} | {
+    readonly kind: "inconclusive";
+    readonly reason: "multiple_candidates" | "order_unreadable" | "too_many_refunds" | "schema" | "authentication" | "provider";
+    readonly message: string;
+    readonly candidateCount?: number;
+    readonly retryable?: boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB,gGAAgG;AAChG,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEvD;AAED;;;;GAIG;AACH,eAAO,MAAM,yBAAyB;;;;kBAY3B,CAAC;AAEZ,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAC;AAE5E,eAAO,MAAM,0BAA0B;;;kBAK5B,CAAC;AAEZ,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E,yEAAyE;AACzE,eAAO,MAAM,8BAA8B;;;;;;;;;;;;;;;kBAkBhC,CAAC;AAEZ,MAAM,MAAM,wBAAwB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,8BAA8B,CAAC,CAAC;AAEtF,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC/B;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC;IACjC,QAAQ,CAAC,gBAAgB,CAAC,EAAE,YAAY,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,wBAAwB;IACvC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,sEAAsE;IACtE,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,SAAS,EAAE,eAAe,CAAC;CACrC;AAED,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IACpB,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,iFAAiF;IACjF,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,YAAY,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAC3D,yEAAyE;IACzE,QAAQ,CAAC,oBAAoB,EAAE,OAAO,CAAC;CACxC;AAED,MAAM,WAAW,mBAAmB;IAClC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,OAAO,EAAE,SAAS,qBAAqB,EAAE,CAAC;IACnD,mEAAmE;IACnE,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC;CACnC;AAED,gFAAgF;AAChF,MAAM,WAAW,cAAc;IAC7B,kFAAkF;IAClF,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,mBAAmB,GAAG,IAAI,CAAC,CAAC;IAC5F,oEAAoE;IACpE,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,qBAAqB,GAAG,IAAI,CAAC,CAAC;CAC1F;AAED,MAAM,MAAM,4BAA4B,GACpC;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,CAAA;CAAE,GAClE;IAAE,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAA;CAAE,GAC9B;IACE,QAAQ,CAAC,IAAI,EAAE,cAAc,CAAC;IAC9B,QAAQ,CAAC,MAAM,EACX,qBAAqB,GACrB,kBAAkB,GAClB,kBAAkB,GAClB,QAAQ,GACR,gBAAgB,GAChB,UAAU,CAAC;IACf,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,QAAQ,CAAC,cAAc,CAAC,EAAE,MAAM,CAAC;IACjC,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC"}

package/dist/types.js

@@ -0,0 +1,51 @@
+import { z } from "zod";
+const ORDER_GID = "gid://shopify/Order/";
+/** Shopify names an order by a global ID; the numeric ID from the admin URL is accepted too. */
+export function toShopifyOrderGid(value) {
+    return value.startsWith(ORDER_GID) ? value : `${ORDER_GID}${value}`;
+}
+/**
+ * The refund an agent means to make. Amounts follow the Conseqa convention of
+ * whole minor units (paise, cents) and upper-case ISO currency codes; Shopify
+ * reports decimal strings and is converted at the comparison boundary.
+ */
+export const shopifyRefundIntentSchema = z
+    .object({
+    orderId: z
+        .string()
+        .regex(/^(?:gid:\/\/shopify\/Order\/)?\d{1,20}$/u)
+        .transform(toShopifyOrderGid),
+    amountMinor: z.number().int().positive(),
+    currency: z
+        .string()
+        .length(3)
+        .transform((value) => value.toUpperCase()),
+})
+    .strict();
+export const shopifyRefundBindingSchema = z
+    .object({
+    refundId: z.string().regex(/^gid:\/\/shopify\/Refund\/\d{1,20}$/u),
+    recovered: z.boolean().default(false),
+})
+    .strict();
+/** What the connector saw, reduced to the facts the verdict rests on. */
+export const shopifyRefundObservationSchema = z
+    .object({
+    refundId: z.string(),
+    orderId: z.string().nullable(),
+    correlationKey: z.string().nullable(),
+    /** The sum of the refund's REFUND transactions in the intended currency. */
+    amountMinor: z.number().int(),
+    currency: z.string().nullable(),
+    transactionStatuses: z.array(z.string()),
+    status: z.enum(["succeeded", "pending", "failed", "no_transactions"]),
+    /**
+     * True once Shopify will not change its answer: every refund transaction
+     * succeeded, or one failed. A contract file can then call a settled refund
+     * that is not exactly right a failure instead of waiting for its deadline.
+     */
+    settled: z.boolean(),
+    createdAt: z.string().nullable(),
+})
+    .strict();
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,MAAM,SAAS,GAAG,sBAAsB,CAAC;AAEzC,gGAAgG;AAChG,MAAM,UAAU,iBAAiB,CAAC,KAAa;IAC7C,OAAO,KAAK,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,KAAK,EAAE,CAAC;AACtE,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC;KACvC,MAAM,CAAC;IACN,OAAO,EAAE,CAAC;SACP,MAAM,EAAE;SACR,KAAK,CAAC,0CAA0C,CAAC;SACjD,SAAS,CAAC,iBAAiB,CAAC;IAC/B,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE;IACxC,QAAQ,EAAE,CAAC;SACR,MAAM,EAAE;SACR,MAAM,CAAC,CAAC,CAAC;SACT,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;CAC7C,CAAC;KACD,MAAM,EAAE,CAAC;AAIZ,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC;KACxC,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,sCAAsC,CAAC;IAClE,SAAS,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC;CACtC,CAAC;KACD,MAAM,EAAE,CAAC;AAIZ,yEAAyE;AACzE,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC;KAC5C,MAAM,CAAC;IACN,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC9B,cAAc,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACrC,4EAA4E;IAC5E,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE;IAC7B,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC/B,mBAAmB,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACxC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;IACrE;;;;OAIG;IACH,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE;IACpB,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACjC,CAAC;KACD,MAAM,EAAE,CAAC"}

package/package.json

@@ -1,13 +1,44 @@
 {
   "name": "@conseqa/connector-shopify",
-  "version": "0.0.0-reserved.0",
-  "description": "Reserved for @conseqa/connector-shopify. Install a released version: npm install @conseqa/connector-shopify@latest",
+  "version": "0.1.8",
+  "description": "Typed, read-only Shopify refund outcome connector for Conseqa",
+  "type": "module",
   "license": "Apache-2.0",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!dist/**/*.test.*"
+  ],
+  "dependencies": {
+    "zod": "^4.0.17",
+    "@conseqa/contracts": "0.1.8",
+    "@conseqa/verifiers": "0.1.8"
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/Devrajsinh-Jhala/Conseqa.git"
+    "url": "https://github.com/Devrajsinh-Jhala/Conseqa.git",
+    "directory": "packages/connector-shopify"
   },
-  "files": [
-    "README.md"
-  ]
-}
+  "homepage": "https://github.com/Devrajsinh-Jhala/Conseqa#readme",
+  "bugs": {
+    "url": "https://github.com/Devrajsinh-Jhala/Conseqa/issues"
+  },
+  "engines": {
+    "node": ">=22.13.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "check": "pnpm typecheck && pnpm test",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}

package/README.md

@@ -1,7 +0,0 @@
-# @conseqa/connector-shopify
-
-This version only reserves the name. Install a released version:
-
-    npm install @conseqa/connector-shopify@latest
-
-See https://github.com/Devrajsinh-Jhala/Conseqa.