@xyo-network/rebilly-payment-card-authorization-plugin 4.1.1 → 5.0.0

package/dist/neutral/index.d.ts

@@ -1,69 +1,5 @@
-import { RebillyApiDomainSettings, RebillyPublishableApiSettings, RebillyOrganizationSettings } from '@xyo-network/rebilly-payment-payload-plugin';
-import { SentinelConfig, SentinelParams, SentinelModuleEventData, SentinelInstance } from '@xyo-network/sentinel-model';
-import { AnyConfigSchema } from '@xyo-network/module-model';
-import { Payload } from '@xyo-network/payload-model';
-import { AbstractSentinel } from '@xyo-network/sentinel-abstract';
-import { AxiosRequestConfig } from 'axios';
-
-declare const RebillyPaymentCardAuthorizationSentinelConfigSchema = "network.xyo.sentinel.payments.payment.instrument.card.authorization.rebilly.config";
-type RebillyPaymentCardAuthorizationSentinelConfigSchema = typeof RebillyPaymentCardAuthorizationSentinelConfigSchema;
-interface RebillyPaymentCardAuthorizationSentinelConfig extends SentinelConfig<{
-    /**
-     * The config schema
-     */
-    schema: RebillyPaymentCardAuthorizationSentinelConfigSchema;
-}>, Partial<RebillyApiDomainSettings> {
-}
-
-type RebillyPaymentCardAuthorizationParams = Partial<RebillyPublishableApiSettings & RebillyOrganizationSettings>;
-interface RebillyPaymentCardAuthorizationSentinelParams<TConfig extends AnyConfigSchema<RebillyPaymentCardAuthorizationSentinelConfig> = AnyConfigSchema<RebillyPaymentCardAuthorizationSentinelConfig>> extends SentinelParams<TConfig> {
-    domain?: string;
-    organizationId?: string;
-    publishableApiKey?: string;
-}
-
-declare const RebillyPaymentCardAuthorizationSentinelSchema = "network.xyo.sentinel.payments.payment.instrument.card.authorization.rebilly";
-type RebillyPaymentCardAuthorizationSentinelSchema = typeof RebillyPaymentCardAuthorizationSentinelSchema;
-
-declare class RebillyPaymentCardAuthorizationSentinel<TParams extends RebillyPaymentCardAuthorizationSentinelParams = RebillyPaymentCardAuthorizationSentinelParams, TEventData extends SentinelModuleEventData<SentinelInstance<TParams>> = SentinelModuleEventData<SentinelInstance<TParams>>> extends AbstractSentinel<TParams, TEventData> {
-    static readonly configSchemas: string[];
-    static readonly defaultConfigSchema = "network.xyo.sentinel.payments.payment.instrument.card.authorization.rebilly.config";
-    protected _apiRoot: string | undefined;
-    protected _domain: string | undefined;
-    protected _headers: AxiosRequestConfig['headers'] | undefined;
-    protected _organizationId: string | undefined;
-    protected _publishableApiKey: string | undefined;
-    protected _tokenEndpoint: string | undefined;
-    /**
-     * The Rebilly Organization API root endpoint
-     */
-    protected get apiRoot(): string;
-    /**
-     * The Rebilly domain
-     */
-    protected get domain(): string;
-    /**
-     * The headers to be included in the request for each request
-     */
-    protected get headers(): AxiosRequestConfig['headers'];
-    /**
-     * True if the environment is sandbox (testing), false otherwise
-     */
-    protected get isSandboxEnvironment(): boolean;
-    /**
-     * The Rebilly organization ID
-     */
-    protected get organizationId(): string;
-    /**
-     * The Rebilly Publishable API key
-     */
-    protected get publishableApiKey(): string;
-    /**
-     * The Rebilly Organization token creation endpoint
-     */
-    protected get tokenEndpoint(): string;
-    reportHandler(payloads?: Payload[]): Promise<Payload[]>;
-}
-
-export { RebillyPaymentCardAuthorizationSentinel, RebillyPaymentCardAuthorizationSentinelConfigSchema, RebillyPaymentCardAuthorizationSentinelSchema };
-export type { RebillyPaymentCardAuthorizationParams, RebillyPaymentCardAuthorizationSentinelConfig, RebillyPaymentCardAuthorizationSentinelParams };
+export * from './Config.ts';
+export * from './Params.ts';
+export * from './Schema.ts';
+export * from './Sentinel.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/rebilly-payment-card-authorization-plugin",
-  "version": "4.1.1",
+  "version": "5.0.0",
   "description": "Typescript/Javascript Plugins for XYO Platform",
   "homepage": "https://xyo.network",
   "bugs": {
@@ -28,24 +28,27 @@
   },
   "module": "dist/neutral/index.mjs",
   "types": "dist/neutral/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/assert": "^4.13.23",
-    "@xylabs/axios": "^4.13.23",
-    "@xyo-network/module-model": "^4.1.7",
-    "@xyo-network/payload-builder": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7",
-    "@xyo-network/payment-payload-plugins": "^4.1.1",
-    "@xyo-network/rebilly-payment-payload-plugin": "^4.1.1",
-    "@xyo-network/sentinel-abstract": "^4.1.7",
-    "@xyo-network/sentinel-model": "^4.1.7",
-    "axios": "^1.10.0"
+    "@xylabs/assert": "^5.0.0",
+    "@xylabs/axios": "^5.0.0",
+    "@xyo-network/module-model": "^5.0.0",
+    "@xyo-network/payload-builder": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0",
+    "@xyo-network/payment-payload-plugins": "^5.0.0",
+    "@xyo-network/rebilly-payment-payload-plugin": "^5.0.0",
+    "@xyo-network/sentinel-abstract": "^5.0.0",
+    "@xyo-network/sentinel-model": "^5.0.0",
+    "axios": "^1.11.0"
   },
   "devDependencies": {
-    "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.24",
-    "@xylabs/tsconfig": "^7.0.0-rc.24",
-    "@xylabs/vitest-extended": "^4.13.23",
-    "@xyo-network/boundwitness-model": "^4.1.7",
-    "knip": "^5.62.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig": "^7.0.2",
+    "@xylabs/vitest-extended": "^5.0.0",
+    "@xyo-network/boundwitness-model": "^5.0.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4"
   },

package/src/spec/Sentinel.spec.ts

@@ -0,0 +1,94 @@
+import '@xylabs/vitest-extended'
+
+import { assertEx } from '@xylabs/assert'
+import type { BoundWitness } from '@xyo-network/boundwitness-model'
+import { isBoundWitness } from '@xyo-network/boundwitness-model'
+import { PayloadBuilder } from '@xyo-network/payload-builder'
+import type { BillingAddress, PaymentCard } from '@xyo-network/payment-payload-plugins'
+import { BillingAddressSchema, PaymentCardSchema } from '@xyo-network/payment-payload-plugins'
+import { isRebillyPaymentAuthorizationTokenWithSources } from '@xyo-network/rebilly-payment-payload-plugin'
+import {
+  beforeAll, describe, expect,
+  it,
+} from 'vitest'
+
+import { RebillyPaymentCardAuthorizationSentinelConfigSchema } from '../Config.ts'
+import type { RebillyPaymentCardAuthorizationSentinelParams } from '../Params.ts'
+import { RebillyPaymentCardAuthorizationSentinel } from '../Sentinel.ts'
+
+const getTestPaymentCardRequest = (cardNumber: string, cvv: string): [PaymentCard, BillingAddress] => {
+  const paymentCard: PaymentCard = {
+    cardNumber,
+    cvv,
+    expMonth: new Date().getMonth() + 1,
+    expYear: new Date().getFullYear() + 1,
+    schema: PaymentCardSchema,
+  }
+  // https://simpsons.fandom.com/wiki/123_Fake_Street
+  const billingAddress: BillingAddress = {
+    address: '123 Fake Street',
+    city: 'Oak Lawn',
+    country: 'US',
+    firstName: 'Marge',
+    lastName: 'Simpson',
+    postalCode: '60453',
+    region: 'IL',
+    schema: BillingAddressSchema,
+  }
+  return [paymentCard, billingAddress]
+}
+
+describe.skipIf(!process.env.REB_PUB_APIKEY)('RebillyPaymentCardAuthorizationSentinel', () => {
+  const publishableApiKey = assertEx(process.env.REB_PUB_APIKEY)
+  assertEx(publishableApiKey.includes('sandbox'), () => 'RebillyPaymentCardAuthorizationSentinel should only be tested in sandbox environment')
+  const organizationId = assertEx(process.env.REB_ORGANIZATION_ID)
+  let sentinel: RebillyPaymentCardAuthorizationSentinel
+  beforeAll(async () => {
+    const config = {
+      schema: RebillyPaymentCardAuthorizationSentinelConfigSchema, synchronous: true, tasks: [],
+    }
+    const domain = 'https://api-sandbox.rebilly.com'
+    sentinel = await RebillyPaymentCardAuthorizationSentinel.create({
+      account: 'random',
+      config,
+      domain,
+      organizationId,
+      publishableApiKey,
+    } as RebillyPaymentCardAuthorizationSentinelParams)
+  })
+
+  const cases = [
+    ['Visa', '4111111111111111', '123'],
+    ['Mastercard', '5555555555554444', '123'],
+    ['American Express', '378282246310005', '1234'],
+    ['Discover', '6011111111111117', '123'],
+  ]
+  describe('report', () => {
+    it.each(cases)('returns created payment token for %s', async (_, pan, cvv) => {
+      // Arrange
+      const [paymentCard, billingAddress] = getTestPaymentCardRequest(pan, cvv)
+
+      // Act
+      const response = await sentinel.report([paymentCard, billingAddress])
+
+      // Assert
+      expect(response).toBeDefined()
+      expect(response).toBeArray()
+      const [bw, ...payloads] = response
+      expect(bw).toBeDefined()
+      expect(isBoundWitness(bw)).toBeTrue()
+      const boundWitness: BoundWitness = assertEx([bw].find(isBoundWitness))
+      expect(boundWitness.addresses).toContain(sentinel.address)
+
+      expect(payloads).toBeArray()
+      expect(payloads.length).toBeGreaterThanOrEqual(1)
+
+      const payload = payloads.find(isRebillyPaymentAuthorizationTokenWithSources)
+      expect(payload).toBeDefined()
+      const token = assertEx(payload)
+      expect(token.id).toBeString()
+      expect(token.$sources).toBeArrayOfSize(2)
+      expect(token.$sources).toEqual(await PayloadBuilder.dataHashes([paymentCard, billingAddress]))
+    })
+  })
+})

package/src/util/spec/__snapshots__/toTokenRequest.spec.ts.snap

@@ -0,0 +1,22 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`toTokenRequest > convert a payment card and billing address to a token request 1`] = `
+{
+  "billingAddress": {
+    "address": "123 Fake Street",
+    "city": "Oak Lawn",
+    "country": "US",
+    "firstName": "Marge",
+    "lastName": "Simpson",
+    "postalCode": "60453",
+    "region": "IL",
+  },
+  "method": "payment-card",
+  "paymentInstrument": {
+    "cvv": "123",
+    "expMonth": 1,
+    "expYear": 3030,
+    "pan": "4111111111111111",
+  },
+}
+`;

package/src/util/spec/toTokenRequest.spec.ts

@@ -0,0 +1,37 @@
+import type { BillingAddress, PaymentCard } from '@xyo-network/payment-payload-plugins'
+import { BillingAddressSchema, PaymentCardSchema } from '@xyo-network/payment-payload-plugins'
+import {
+  describe, expect,
+  it,
+} from 'vitest'
+
+import { toTokenRequest } from '../toTokenRequest.ts'
+
+describe('toTokenRequest', () => {
+  const cases: [PaymentCard, BillingAddress][] = [
+    [
+      {
+        cardNumber: '4111111111111111',
+        cvv: '123',
+        expMonth: 1,
+        expYear: 3030,
+        schema: PaymentCardSchema,
+      },
+      {
+        // https://simpsons.fandom.com/wiki/123_Fake_Street
+        address: '123 Fake Street',
+        city: 'Oak Lawn',
+        country: 'US',
+        firstName: 'Marge',
+        lastName: 'Simpson',
+        postalCode: '60453',
+        region: 'IL',
+        schema: BillingAddressSchema,
+      },
+    ],
+  ]
+  it.each(cases)('convert a payment card and billing address to a token request', (paymentCard, billingAddress) => {
+    const result = toTokenRequest(paymentCard, billingAddress)
+    expect(result).toMatchSnapshot()
+  })
+})

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["./src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: {},
-    node: {},
-    neutral: { src: true },
-  },
-}
-
-export default config