@rebilly/instruments 9.48.0 → 9.50.0

package/CHANGELOG.md

@@ -1,6 +1,6 @@
-## [9.48.0](https://github.com/Rebilly/rebilly/compare/instruments/core-v9.47.3...instruments/core-v9.48.0) (2024-05-23)
+## [9.50.0](https://github.com/Rebilly/rebilly/compare/instruments/core-v9.49.0...instruments/core-v9.50.0) (2024-05-24)
 
 
 ### Features
 
-* **Instruments:** Manage instruments Make Default action ([#5266](https://github.com/Rebilly/rebilly/issues/5266)) ([f34dc2a](https://github.com/Rebilly/rebilly/commit/f34dc2a55d45fb8220d8f6eff0e97056841a55c7)), closes [#5425](https://github.com/Rebilly/rebilly/issues/5425)
+* **instruments:** Add TS declaration file generation to instruments core. ([#5473](https://github.com/Rebilly/rebilly/issues/5473)) ([ef75aa7](https://github.com/Rebilly/rebilly/commit/ef75aa7105d8acb527ff025e10d13f796fe37d0b))

package/dist/index.d.ts

@@ -0,0 +1,295 @@
+export interface PlanItem {
+	planId: string;
+	quantity: number;
+	thumbnail?: string;
+}
+export interface Item {
+	planId: string;
+	quantity: number | {
+		default?: number;
+		minimum?: number;
+		maximum?: number;
+		multipleOf?: number;
+	};
+	thumbnail?: string;
+}
+export interface Money {
+	amount: number;
+	currency: string;
+}
+export interface DepositObject {
+	currency: string;
+	amount?: number;
+	buttons?: number[];
+	editable?: boolean;
+	customAmount?: {
+		minimum?: number;
+		maximum?: number;
+		multipleOf?: number;
+	};
+}
+export interface DepositRequest {
+	depositRequestId: string;
+}
+export type Deposit = DepositRequest | DepositObject;
+export interface Payout {
+	payoutRequestId: string;
+}
+export interface I18n {
+	[key: string]: {
+		summary?: object;
+		form?: object;
+		confirmation?: object;
+		result?: object;
+		validations?: object;
+		paymentMethods?: object;
+	};
+}
+export interface ThemeProperties {
+	[key: string]: string | undefined;
+	colorPrimary?: string;
+	colorBackground?: string;
+	colorText?: string;
+	colorDanger?: string;
+	borderRadius?: string;
+	labels?: "stacked" | "floating";
+	fontFamily?: string;
+	fontSizeBase?: string;
+	fontWeightBase?: string;
+	fontLineHeightBase?: string;
+	fontSmooth?: "auto" | "never" | "always";
+	headingFontFamily?: string;
+	headingFontWeight?: string;
+	headingColorText?: string;
+	buttonColorBackground?: string;
+	buttonColorText?: string;
+	buttonFontFamily?: string;
+	buttonFontSize?: string;
+	buttonFontLineHeight?: string;
+	buttonFontWeight?: string;
+	buttonBorder?: string;
+	buttonBorderColor?: string;
+	buttonBorderWidth?: string;
+	buttonBorderType?: string;
+	buttonBorderRadius?: string;
+	buttonBoxShadow?: string;
+	buttonSecondaryColorText?: string;
+	buttonSecondaryFontFamily?: string;
+	buttonSecondaryFontSize?: string;
+	buttonSecondaryFontLineHeight?: string;
+	buttonSecondaryFontWeight?: string;
+	buttonSecondaryBorder?: string;
+	buttonSecondaryBorderColor?: string;
+	buttonSecondaryBorderWidth?: string;
+	buttonSecondaryBorderType?: string;
+	buttonSecondaryBorderRadius?: string;
+	buttonSecondaryBoxShadow?: string;
+	buttonHoverColorBackground?: string;
+	buttonHoverColorText?: string;
+	buttonHoverFontFamily?: string;
+	buttonHoverFontSize?: string;
+	buttonHoverFontLineHeight?: string;
+	buttonHoverFontWeight?: string;
+	buttonHoverBorder?: string;
+	buttonHoverBorderColor?: string;
+	buttonHoverBorderWidth?: string;
+	buttonHoverBorderType?: string;
+	buttonHoverBorderRadius?: string;
+	buttonHoverBoxShadow?: string;
+	buttonSecondaryHoverColorBackground?: string;
+	buttonSecondaryHoverColorText?: string;
+	buttonSecondaryHoverFontFamily?: string;
+	buttonSecondaryHoverFontSize?: string;
+	buttonSecondaryHoverFontLineHeight?: string;
+	buttonSecondaryHoverFontWeight?: string;
+	buttonSecondaryHoverBorder?: string;
+	buttonSecondaryHoverBorderColor?: string;
+	buttonSecondaryHoverBorderWidth?: string;
+	buttonSecondaryHoverBorderType?: string;
+	buttonSecondaryHoverBorderRadius?: string;
+	buttonSecondaryHoverBoxShadow?: string;
+	buttonActiveColorBackground?: string;
+	buttonActiveColorText?: string;
+	buttonActiveFontFamily?: string;
+	buttonActiveFontSize?: string;
+	buttonActiveFontLineHeight?: string;
+	buttonActiveFontWeight?: string;
+	buttonActiveBorder?: string;
+	buttonActiveBorderColor?: string;
+	buttonActiveBorderWidth?: string;
+	buttonActiveBorderType?: string;
+	buttonActiveBorderRadius?: string;
+	buttonActiveBoxShadow?: string;
+	buttonSecondaryActiveColorBackground?: string;
+	buttonSecondaryActiveColorText?: string;
+	buttonSecondaryActiveFontFamily?: string;
+	buttonSecondaryActiveFontSize?: string;
+	buttonSecondaryActiveFontLineHeight?: string;
+	buttonSecondaryActiveFontWeight?: string;
+	buttonSecondaryActiveBorder?: string;
+	buttonSecondaryActiveBorderColor?: string;
+	buttonSecondaryActiveBorderWidth?: string;
+	buttonSecondaryActiveBorderType?: string;
+	buttonSecondaryActiveBorderRadius?: string;
+	buttonSecondaryActiveBoxShadow?: string;
+	inputColorBackground?: string;
+	inputColorText?: string;
+	inputFontFamily?: string;
+	inputFontSize?: string;
+	inputFontLineHeight?: string;
+	inputFontWeight?: string;
+	inputBorder?: string;
+	inputBorderRadius?: string;
+	inputBoxShadow?: string;
+	inputHoverColorBackground?: string;
+	inputHoverColorText?: string;
+	inputHoverFontFamily?: string;
+	inputHoverFontSize?: string;
+	inputHoverFontLineHeight?: string;
+	inputHoverFontWeight?: string;
+	inputHoverBorder?: string;
+	inputHoverBorderRadius?: string;
+	inputHoverBoxShadow?: string;
+	inputFocusColorBackground?: string;
+	inputFocusColorText?: string;
+	inputFocusFontFamily?: string;
+	inputFocusFontSize?: string;
+	inputFocusFontLineHeight?: string;
+	inputFocusFontWeight?: string;
+	inputFocusBorder?: string;
+	inputFocusBorderRadius?: string;
+	inputFocusBoxShadow?: string;
+	inputPlaceholderColorText?: string;
+	inputPlaceholderFontFamily?: string;
+	inputPlaceholderFontSize?: string;
+	inputPlaceholderFontLineHeight?: string;
+	inputPlaceholderFontWeight?: string;
+	inputSelectionColorText?: string;
+	inputSelectionColorBackground?: string;
+	inputErrorColorBackground?: string;
+	inputErrorColorText?: string;
+	inputErrorFontFamily?: string;
+	inputErrorFontSize?: string;
+	inputErrorFontLineHeight?: string;
+	inputErrorFontWeight?: string;
+	inputErrorBorder?: string;
+	inputErrorBorderRadius?: string;
+	inputErrorBoxShadow?: string;
+	inputErrorHoverColorBackground?: string;
+	inputErrorHoverColorText?: string;
+	inputErrorHoverFontFamily?: string;
+	inputErrorHoverFontSize?: string;
+	inputErrorHoverFontLineHeight?: string;
+	inputErrorHoverFontWeight?: string;
+	inputErrorHoverBorder?: string;
+	inputErrorHoverBorderRadius?: string;
+	inputErrorHoverBoxShadow?: string;
+	inputErrorFocusColorBackground?: string;
+	inputErrorFocusColorText?: string;
+	inputErrorFocusFontFamily?: string;
+	inputErrorFocusFontSize?: string;
+	inputErrorFocusFontLineHeight?: string;
+	inputErrorFocusFontWeight?: string;
+	inputErrorFocusBorder?: string;
+	inputErrorFocusBorderRadius?: string;
+	inputErrorFocusBoxShadow?: string;
+	inputErrorPlaceholderColorText?: string;
+	inputErrorPlaceholderFontFamily?: string;
+	inputErrorPlaceholderFontSize?: string;
+	inputErrorPlaceholderFontLineHeight?: string;
+	inputErrorPlaceholderFontWeight?: string;
+	inputErrorSelectionColorText?: string;
+	inputErrorSelectionColorBackground?: string;
+}
+export type AddressFields = "email" | "organization" | "phoneNumber" | "city" | "country" | "region" | "postalCode" | "address" | "address2";
+export interface Address {
+	name?: "default" | "combined" | "stacked";
+	region?: "default" | "split" | "stacked";
+	show?: (AddressFields | "all")[];
+	hide?: (AddressFields | "all")[];
+	require?: AddressFields[];
+}
+export type AdditionalFields = "poNumber";
+export interface DisplayOptions {
+	buttonColor?: string;
+	buttonHeight?: string;
+	buttonType?: string;
+}
+export interface DigitalWalletConfiguration {
+	displayOptions?: DisplayOptions;
+}
+export interface PaymentInstrumentsOptionFlags {
+	compactExpressInstruments?: boolean;
+	allowDeactivate?: boolean;
+	allowUpdate?: boolean;
+	allowMakeDefault?: boolean;
+}
+export interface PaymentInstrumentsDisplayOptions extends PaymentInstrumentsOptionFlags {
+	address?: Address;
+	paypal?: {
+		buttonHeight?: number;
+	};
+	googlePay?: DigitalWalletConfiguration;
+	applePay?: DigitalWalletConfiguration;
+	additionalFields?: {
+		show?: AdditionalFields[];
+		require?: AdditionalFields[];
+	};
+}
+export interface Features {
+	enableTelemetry?: boolean;
+	hideConfirmation?: boolean;
+	hideResult?: boolean;
+	fullPageRedirect?: boolean;
+	showCoupons?: string[];
+}
+export interface DevProperties {
+	paymentMethodsUrl?: string;
+	liveUrl?: string;
+	sandboxUrl?: string;
+	framePayScriptLink?: string;
+	framePayStyleLink?: string;
+}
+export interface Options {
+	organizationId?: string;
+	publishableKey?: string;
+	websiteId?: string;
+	addons?: PlanItem[];
+	bumpOffer?: PlanItem[];
+	items: Item[];
+	money: Money;
+	invoiceId: string;
+	transactionId: string;
+	deposit: Deposit;
+	payout: Payout;
+	form?: string | object;
+	summary?: string | object;
+	jwt?: string;
+	apiMode: "sandbox" | "live";
+	transactionType?: "purchase" | "setup";
+	css?: string;
+	theme?: ThemeProperties;
+	i18n?: I18n;
+	countryCode?: string;
+	locale?: "en" | "es" | "auto";
+	paymentInstruments?: PaymentInstrumentsDisplayOptions;
+	features?: Features;
+	_dev?: DevProperties;
+}
+declare class RebillyInstruments {
+	mount: (config: any) => void;
+	update: (config: any) => void;
+	destroy: () => void;
+	purchase: (data: any) => void;
+	setup: (data: any) => void;
+	on: (eventName: string, callback: Function) => void;
+	show: (componentName: string, data: any) => void;
+	version: number;
+}
+declare const RebillyInstrumentsInstance: RebillyInstruments;
+
+export {
+	RebillyInstrumentsInstance as default,
+};
+
+export {};

package/package.json

@@ -1,21 +1,23 @@
 {
     "name": "@rebilly/instruments",
-    "version": "9.48.0",
+    "version": "9.50.0",
     "author": "Rebilly",
     "license": "MIT",
     "main": "dist/index.js",
+    "types": "dist/index.d.ts",
     "unpkg": "dist/index.min.js",
     "files": [
         "dist",
         "CHANGELOG.md"
     ],
     "scripts": {
-        "build": "concurrently yarn:type:check \"vite build\"",
+        "build": "concurrently yarn:type:check \"vite build\" yarn:generate:type-declaration",
         "dev": "vite build --watch",
         "test:update-snapshot": "vitest -u",
         "test:unit": "vitest run",
         "test:unit:watch": "vitest",
-        "type:check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false"
+        "type:check": "vue-tsc --noEmit -p tsconfig.vitest.json --composite false",
+        "generate:type-declaration": "dts-bundle-generator --project tsconfig.declaration.json --no-check --no-banner --out-file dist/index.d.ts src/index.d.ts"
     },
     "devDependencies": {
         "@rebilly/api-metadata": "*",
@@ -37,6 +39,7 @@
         "values.js": "^2.0.0",
         "vite": "^5.2.10",
         "vite-plugin-package-version": "^1.1.0",
+        "dts-bundle-generator": "^9.5.1",
         "vitest": "^1.6.0",
         "vitest-canvas-mock": "^0.3.3",
         "lodash": "^4.17.21",