@osovitny/anatoly 3.17.67 → 3.17.68

package/lib/payments/PayPal/components/paypal.component.d.ts

@@ -0,0 +1,50 @@
+import { AfterViewInit, ChangeDetectorRef, ElementRef, EventEmitter, NgZone, OnChanges, OnDestroy, SimpleChanges } from "@angular/core";
+import { IPayPalConfig } from "../models/paypal-models";
+import { PayPalScriptService } from "../services/paypal-script.service";
+import * as i0 from "@angular/core";
+export declare class PayPalComponent implements OnChanges, OnDestroy, AfterViewInit {
+    private paypalScriptService;
+    private cdr;
+    private ngZone;
+    /**
+     * Configuration for paypal.
+     */
+    config?: IPayPalConfig;
+    /**
+     * If enabled, paypal SDK script will be loaded. Useful if you want to have multiple PayPal components on the same page
+     * sharing base configuration. In such a case only a single component may register script.
+     */
+    registerScript: boolean;
+    /**
+     * Emitted when paypal script is loaded
+     */
+    scriptLoaded: EventEmitter<any>;
+    /**
+     * Id of the element where PayPal button will be rendered
+     */
+    payPalButtonContainerId?: string;
+    private readonly ngUnsubscribe;
+    private payPalButtonContainerElem?;
+    set payPalButtonContainer(content: ElementRef);
+    /**
+     * Flag that indicates if paypal should be initialized (required for handling script load events and availability of DOM element)
+     */
+    private initializePayPal;
+    /**
+     * Reference to PayPal global API
+     */
+    private payPal;
+    constructor(paypalScriptService: PayPalScriptService, cdr: ChangeDetectorRef, ngZone: NgZone);
+    ngOnChanges(changes: SimpleChanges): void;
+    ngOnDestroy(): void;
+    ngAfterViewInit(): void;
+    customInit(payPal: any): void;
+    reinitialize(config: IPayPalConfig | undefined): void;
+    private doPayPalCheck;
+    private initPayPalScript;
+    private generateElementId;
+    private initPayPal;
+    private generateGuid;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PayPalComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<PayPalComponent, "anatoly-paypal", never, { "config": { "alias": "config"; "required": false; }; "registerScript": { "alias": "registerScript"; "required": false; }; }, { "scriptLoaded": "scriptLoaded"; }, never, never, false, never>;
+}

package/lib/payments/PayPal/models/paypal-models.d.ts

@@ -0,0 +1,309 @@
+export interface IPayPalConfig {
+    /**
+     * Currency - Defaults to USD if not provided
+     */
+    currency?: string;
+    /**
+     * Use when creating order on client
+     */
+    createOrderOnClient?: (data: any) => ICreateOrderRequest;
+    /**
+     * Use when creating subscription on client
+     */
+    createSubscriptionOnClient?: (data: any) => ICreateSubscriptionRequest;
+    /**
+     * Use for creating orders on server. PayPal expects you to return 'orderId' in this method
+     */
+    createOrderOnServer?: (data: any) => Promise<string>;
+    /**
+     * Advanced configuration
+     */
+    advanced?: IAdvancedConfiguration;
+    /**
+     * Client id
+     */
+    clientId: string;
+    /**
+     * Shipping callback
+     * see https://developer.paypal.com/docs/checkout/integration-features/shipping-callback/
+     */
+    onShippingChange?: OnShippingChangeCallback;
+    /**
+     * Called when 'onApprove' event occurs
+     */
+    onApprove?: (data: IOnApproveCallbackData, actions: any) => void;
+    /**
+     * Called when authorization on client succeeds
+     */
+    onClientAuthorization?: (authorization: IClientAuthorizeCallbackData) => void;
+    /**
+     * Implement for authorizing on server side
+     */
+    authorizeOnServer?: (data: IOnApproveCallbackData, actions: any) => Promise<any>;
+    /**
+     * Button style configuration
+     */
+    style?: IPayPalButtonStyle;
+    /**
+     * Error handler
+     */
+    onError?: (err: any) => void;
+    /**
+     * Click handler
+     */
+    onClick?: (data: any, actions: IOnClickCallbackActions) => void;
+    /**
+     * Cancel handler
+     */
+    onCancel?: (data: ICancelCallbackData, actions: any) => void;
+    /**
+     * Init handler.
+     * can be used for validation, see: https://developer.paypal.com/docs/checkout/integration-features/validation/#
+     */
+    onInit?: (data: IInitCallbackData, actions: IOnInitCallbackActions) => void;
+    /**
+     * Create subscription handler
+     * https://developer.paypal.com/docs/subscriptions/integrate/
+     *
+     * Note: the vault property in the advanced configuration also has to be set to true
+     */
+    createSubscription?: (data: any) => ICreateSubscriptionRequest;
+    /**
+     * Vault - must be set to true when creating subscriptions
+     */
+    vault?: TrueFalse;
+    intent?: OrderIntent;
+    fundingSource?: "PAYPAL" | "CARD" | "PAYLATER" | "CREDIT" | "VENMO";
+}
+export type TrueFalse = "true" | "false";
+export interface IPayPalUrlConfig {
+    clientId: string;
+    currency?: string;
+    funding?: boolean;
+    commit?: TrueFalse;
+    vault?: TrueFalse;
+    intent?: OrderIntent;
+    locale?: string;
+    extraParams?: IQueryParam[];
+}
+export interface IOrderDetails {
+    create_time: string;
+    update_time: string;
+    id: string;
+    intent: OrderIntent;
+    payer: IPayer;
+    status: OrderStatus;
+    links: ILinkDescription[];
+    purchase_units: IPurchaseUnit[];
+}
+export interface IClientAuthorizeCallbackData extends IOrderDetails {
+    links: ILinkDescription[];
+}
+export interface ILinkDescription {
+    href: string;
+    rel: String;
+    method?: LinkMethod;
+}
+export interface IQueryParam {
+    name: string;
+    value: string;
+}
+export type OnShippingChangeCallback = (data: IOnShippingChangeData, actions: IOnShippingChangeActions) => any;
+export interface IOnShippingChangeData {
+    paymentToken: string;
+    shipping_address: any;
+    selected_shipping_method?: any;
+}
+export interface IOnShippingChangeActions {
+    resolve: () => any;
+    reject: () => any;
+    patch: () => any;
+}
+export type LinkMethod = "GET" | "POST" | "PUT" | "DELETE" | "HEAD" | "CONNECT" | "OPTIONS" | "PATCH";
+export interface IAdvancedConfiguration {
+    commit?: TrueFalse;
+    locale?: string;
+    extraQueryParams?: IQueryParam[];
+}
+export interface IOnApproveCallbackData {
+    orderID: string;
+    payerID: string;
+    subscriptionID: string;
+}
+export interface ICreateOrderCallbackActions {
+    order: {
+        create: (order: ICreateOrderRequest) => Promise<any>;
+    };
+}
+export interface ICancelCallbackData {
+    orderID: string;
+}
+export interface IOnApproveCallbackActions {
+    redirect: () => void;
+    restart: () => void;
+    order: {
+        authorize: () => Promise<any>;
+        capture: () => Promise<any>;
+        get: () => Promise<IOrderDetails>;
+        patch: () => Promise<any>;
+    };
+}
+export interface IOnInitCallbackActions {
+    enable: () => void;
+    disable: () => void;
+}
+export interface ICreateSubscriptionCallbackActions {
+    subscription: {
+        create: (subscription: ICreateSubscriptionRequest) => Promise<any>;
+        revise: (subscriptionId: string, subscription: ICreateSubscriptionRequest) => Promise<any>;
+    };
+}
+export interface IInitCallbackData {
+}
+export interface ICreateSubscriptionCallbackData {
+}
+export interface IOnClickCallbackActions {
+    resolve: () => void;
+    reject: () => void;
+}
+export interface IPayPalButtonStyle {
+    label?: "paypal" | "checkout" | "pay" | "installment" | "buynow" | "subscribe";
+    shape?: "pill" | "rect";
+    color?: "gold" | "blue" | "silver" | "white" | "black";
+    layout?: "horizontal" | "vertical";
+    tagline?: boolean;
+    height?: number;
+    fundingicons?: boolean;
+}
+export interface ICreateOrderRequest {
+    intent: OrderIntent;
+    purchase_units: IPurchaseUnit[];
+    payer?: IPayer;
+    application_context?: IApplicationContext;
+}
+export interface ICreateSubscriptionRequest {
+    plan_id: string;
+    quantity?: number;
+    custom_id: string;
+}
+export interface IPayer {
+    name?: IPartyName;
+    email_address?: string;
+    payer_id?: string;
+    birth_date?: string;
+    tax_info?: ITaxInfo;
+    address?: IAddressPortable;
+    phone?: IPhone;
+}
+export interface IApplicationContext {
+    brand_name?: string;
+    locale?: string;
+    landing_page?: PaypalLandingPage;
+    shipping_preference?: ShippingPreference;
+    user_action?: PayPalUserAction;
+    payment_method?: IPaymentMethod;
+    return_url?: string;
+    cancel_url?: string;
+}
+export interface IPaymentMethod {
+    payer_selected?: PayerSelected;
+    payee_preferred?: PayeePreferred;
+}
+export type PayeePreferred = "UNRESTRICTED" | "IMMEDIATE_PAYMENT_REQUIRED";
+export type PayerSelected = "PAYPAL_CREDIT" | "PAYPAL";
+export type PayPalUserAction = "CONTINUE" | "PAY_NOW";
+export type ShippingPreference = "GET_FROM_FILE" | "NO_SHIPPING" | "SET_PROVIDED_ADDRESS";
+export type PaypalLandingPage = "LOGIN" | "BILLING";
+export type OrderIntent = "CAPTURE" | "AUTHORIZE" | "subscription";
+export type DisbursementMode = "INSTANT" | "DELAYED";
+export type ItemCategory = "DIGITAL_GOODS" | "PHYSICAL_GOODS";
+export type PhoneType = "FAX" | "HOME" | "MOBILE" | "OTHER" | "PAGER";
+export type TaxIdType = "BR_CPF" | "BR_CNPJ";
+export interface IPhone {
+    phone_type?: PhoneType;
+    phone_number?: IPhoneNumber;
+}
+export interface ITaxInfo {
+    tax_id: string;
+    tax_id_type: TaxIdType;
+}
+export interface IPhoneNumber {
+    national_number: string;
+}
+export interface IPurchaseUnit {
+    amount: IUnitAmount;
+    reference_id?: string;
+    payee?: IPayee;
+    payment_instruction?: IPaymentInstructions;
+    description?: string;
+    custom_id?: string;
+    invoice_id?: string;
+    soft_descriptor?: string;
+    items: ITransactionItem[];
+    shipping?: IShipping;
+}
+export interface IPayee {
+    email_address?: string;
+    merchant_id?: string;
+}
+export interface IPaymentInstructions {
+    platform_fees?: IPlatformFee[];
+    disbursement_mode?: DisbursementMode;
+}
+export interface IPlatformFee {
+    amount: IUnitAmount;
+    payee?: IPayee;
+}
+export interface ITransactionItem {
+    name: string;
+    unit_amount: IUnitAmount;
+    quantity: string;
+    description?: string;
+    sku?: string;
+    category?: ItemCategory;
+    tax?: ITax;
+}
+export interface ITax {
+    currency_code: string;
+    value: string;
+}
+export interface IUnitAmount {
+    currency_code: string;
+    value: string;
+    breakdown?: IUnitBreakdown;
+}
+export interface IMoney {
+    currency_code: string;
+    value: string;
+}
+export interface IUnitBreakdown {
+    item_total?: IUnitAmount;
+    shipping?: IUnitAmount;
+    handling?: IUnitAmount;
+    tax_total?: IUnitAmount;
+    insurance?: IUnitAmount;
+    shipping_discount?: IUnitAmount;
+    discount?: IMoney;
+}
+export interface IPartyName {
+    prefix?: string;
+    given_name?: string;
+    surname?: string;
+    middle_name?: string;
+    suffix?: string;
+    alternate_full_name?: string;
+    full_name?: string;
+}
+export interface IAddressPortable {
+    country_code: string;
+    address_line_1?: string;
+    address_line_2?: string;
+    admin_area_2?: string;
+    admin_area_1?: string;
+    postal_code?: string;
+}
+export interface IShipping {
+    name?: IPartyName;
+    address?: IAddressPortable;
+}
+export type OrderStatus = "APPROVED" | "SAVED" | "CREATED" | "VOIDED" | "COMPLETED";

package/lib/payments/PayPal/services/paypal-script.service.d.ts

@@ -0,0 +1,14 @@
+import { IPayPalUrlConfig } from '../models/paypal-models';
+import { ScriptService } from '../../services/script.service';
+import * as i0 from "@angular/core";
+export declare class PayPalScriptService {
+    protected scriptService: ScriptService;
+    private readonly paypalWindowName;
+    constructor(scriptService: ScriptService);
+    registerPayPalScript(config: IPayPalUrlConfig, onReady: (payPalApi: any) => void): void;
+    destroyPayPalScript(): void;
+    private getUrlForConfig;
+    private getQueryString;
+    static ɵfac: i0.ɵɵFactoryDeclaration<PayPalScriptService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<PayPalScriptService>;
+}

package/lib/payments/index.d.ts

@@ -0,0 +1,4 @@
+export * from './services/script.service';
+export * from './PayPal/components/paypal.component';
+export * from './PayPal/models/paypal-models';
+export * from './PayPal/services/paypal-script.service';

package/lib/payments/payments.module.d.ts

@@ -0,0 +1,8 @@
+import * as i0 from "@angular/core";
+import * as i1 from "./PayPal/components/paypal.component";
+import * as i2 from "@angular/common";
+export declare class AnatolyPaymentsModule {
+    static ɵfac: i0.ɵɵFactoryDeclaration<AnatolyPaymentsModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<AnatolyPaymentsModule, [typeof i1.PayPalComponent], [typeof i2.CommonModule], [typeof i1.PayPalComponent]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<AnatolyPaymentsModule>;
+}

package/lib/payments/services/script.service.d.ts

@@ -0,0 +1,11 @@
+import { NgZone } from '@angular/core';
+import * as i0 from "@angular/core";
+export declare class ScriptService {
+    protected zone: NgZone;
+    constructor(zone: NgZone);
+    registerScript(url: string, globalVar: string, onReady: (globalVar: any) => void): void;
+    cleanup(globalVar: string): void;
+    private getElemId;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ScriptService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ScriptService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@osovitny/anatoly",
-  "version": "3.17.67",
+  "version": "3.17.68",
   "peerDependencies": {
     "@angular/common": "17.1.2",
     "@angular/core": "17.1.2",

package/public-api.d.ts

@@ -1,6 +1,7 @@
 export * from './lib/core';
 export * from './lib/data';
 export * from './lib/iam';
+export * from './lib/payments';
 export * from './lib/ui/components';
 export * from './lib/ui/dialogs';
 export * from './lib/ui/directives';
@@ -11,5 +12,6 @@ export * from './lib/core/core.module';
 export * from './lib/data/data.module';
 export * from './lib/iam/iam.module';
 export * from './lib/iam/iam-pages.module';
+export * from './lib/payments/payments.module';
 export * from './lib/ui/ui.module';
 export * from './lib/anatoly.module';