@vandenberghinc/volt 1.1.2

package/backend/dist/esm/meta.js

@@ -0,0 +1,149 @@
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+// ---------------------------------------------------------
+// Meta information.
+/*  @docs:
+ *  @nav: Backend
+    @chapter: Endpoints
+    @title: Meta
+    @description: The js view meta information class.
+    @parameter:
+        @name: author
+        @description: The author's name.
+        @type: string
+    @parameter:
+        @name: title
+        @description: The page's title.
+        @type: string
+    @parameter:
+        @name: description
+        @description: The page's description.
+        @type: string
+    @parameter:
+        @name: image
+        @description: The page's image source.
+        @type: string
+    @parameter:
+        @name: robots
+        @description: The robots rules.
+        @type: string
+    @parameter:
+        @name: charset
+        @description: The used charset.
+        @type: string
+    @parameter:
+        @name: viewport
+        @description: The viewport settings.
+        @type: string
+    @parameter:
+        @name: favicon
+        @description: The url to the favicon.
+        @type: string
+ */
+export class Meta {
+    author;
+    title;
+    description;
+    image;
+    robots;
+    charset;
+    viewport;
+    favicon;
+    constructor({ author = null, title = null, description = null, image = null, robots = "index, follow", charset = "UTF-8", viewport = "width=device-width, initial-scale=1", favicon = "/favicon.ico", } = {}) {
+        this.author = author;
+        this.title = title;
+        this.description = description;
+        this.image = image;
+        this.robots = robots;
+        this.charset = charset;
+        this.viewport = viewport;
+        this.favicon = favicon;
+    }
+    // Copy.
+    /*  @docs:
+        @title: Copy
+        @description: Create a copy of the current meta object without any references.
+        @param:
+            @name: override
+            @descr: The <Type>Meta</Type> constructor arguments to override.
+     */
+    copy(override = {}) {
+        return new Meta({
+            author: this.author,
+            title: this.title,
+            description: this.description,
+            image: this.image,
+            robots: this.robots,
+            charset: this.charset,
+            viewport: this.viewport,
+            favicon: this.favicon,
+            ...override,
+        });
+    }
+    /* @docs:
+     * @title: Set value
+     * @description: Set value funcs that return the current object.
+     * @return: Returns the current <Type>Meta</Type> object.
+     * @type: Meta
+     * @funcs: 8
+     */
+    set_author(value) { this.author = value; return this; }
+    set_title(value) { this.title = value; return this; }
+    set_description(value) { this.description = value; return this; }
+    set_image(value) { this.image = value; return this; }
+    set_robots(value) { this.robots = value; return this; }
+    set_charset(value) { this.charset = value; return this; }
+    set_viewport(value) { this.viewport = value; return this; }
+    set_favicon(value) { this.favicon = value; return this; }
+    // Get as object.
+    obj() {
+        return {
+            author: this.author,
+            title: this.title,
+            description: this.description,
+            image: this.image,
+            robots: this.robots,
+            charset: this.charset,
+            viewport: this.viewport,
+            favicon: this.favicon,
+        };
+    }
+    // Build meta headers.
+    build_html(domain = null) {
+        let html = "";
+        // Default meta data.
+        html += `<meta charset='${this.charset}'>`;
+        html += `<meta name='viewport' content='${this.viewport}'/>`;
+        // Meta.
+        html += `<title id='__page_title'>${this.title}</title>`;
+        html += `<meta name='author' content='${this.author}'/>`;
+        html += `<meta name='description' content='${this.description}'/>`;
+        // Meta/facebook.
+        html += `<meta property='og:title' content='${this.title}'/>`;
+        html += `<meta property='og:description' content='${this.description}'/>`;
+        html += `<meta property='og:image' content='${this.image}'/>`;
+        if (domain) {
+            html += `<meta property="og:url" content="${domain}"/>`;
+        }
+        html += `<meta property="og:type" content="website"/>`;
+        // Twitter/X.
+        html += `<meta name='twitter:card' content='summary_large_image'/>`;
+        // html += `<meta name='twitter:site' content='${this.image}'/>`; // twitter username.
+        html += `<meta name='twitter:title' content='${this.title}'/>`;
+        html += `<meta name='twitter:description' content='${this.description}'/>`;
+        html += `<meta name='twitter:image' content='${this.image}'/>`;
+        // FB App id.
+        // <meta property="fb:app_id" content="your-facebook-app-id" />
+        // Meta robots.
+        html += `<meta name='robots' content='${this.robots}'>`;
+        // Favicon.
+        html += `<link rel='icon' href='${this.favicon}' type='image/x-icon'/>`;
+        // Response.
+        return html;
+    }
+}
+// ---------------------------------------------------------
+// Exports.
+export default Meta;

package/backend/dist/esm/mutex.d.ts

@@ -0,0 +1,24 @@
+/** @docs
+ *  @chapter: System
+ *  @title: Mutex
+ *  @desc: A mutual exclusion primitive useful for protecting shared data structures from concurrent access
+ */
+export declare class Mutex {
+    private locked;
+    private queue;
+    constructor();
+    /** @docs
+     *  @title: Lock
+     *  @desc: Acquire the mutex lock. Should be awaited
+     *  @returns
+     *      @type Promise<void>
+     *      @desc Resolves when the lock is acquired
+     */
+    lock(): Promise<void>;
+    /** @docs
+     *  @title: Unlock
+     *  @desc: Release the mutex lock
+     */
+    unlock(): void;
+}
+export default Mutex;

package/backend/dist/esm/mutex.js

@@ -0,0 +1,48 @@
+/*
+ * Author: Daan van den Bergh
+ * Copyright: © 2022 - 2024 Daan van den Bergh.
+ */
+/** @docs
+ *  @chapter: System
+ *  @title: Mutex
+ *  @desc: A mutual exclusion primitive useful for protecting shared data structures from concurrent access
+ */
+export class Mutex {
+    locked;
+    queue;
+    constructor() {
+        this.locked = false;
+        this.queue = [];
+    }
+    /** @docs
+     *  @title: Lock
+     *  @desc: Acquire the mutex lock. Should be awaited
+     *  @returns
+     *      @type Promise<void>
+     *      @desc Resolves when the lock is acquired
+     */
+    async lock() {
+        if (!this.locked) {
+            this.locked = true;
+        }
+        else {
+            return new Promise((resolve) => {
+                this.queue.push(resolve);
+            });
+        }
+    }
+    /** @docs
+     *  @title: Unlock
+     *  @desc: Release the mutex lock
+     */
+    unlock() {
+        if (this.queue.length > 0) {
+            const next_resolve = this.queue.shift();
+            next_resolve();
+        }
+        else {
+            this.locked = false;
+        }
+    }
+}
+export default Mutex;

package/backend/dist/esm/payments/paddle.d.ts

@@ -0,0 +1,161 @@
+export interface ProductObject {
+    id: string;
+    name: string;
+    price: number;
+    currency: string;
+    tax_category: string;
+    icon?: string;
+    frequency?: number;
+    interval?: 'day' | 'week' | 'month' | 'year';
+    trial?: {
+        frequency: number;
+        interval: 'day' | 'week' | 'month' | 'year';
+    } | null;
+    plans?: ProductObject[];
+    description: string;
+    paddle_prod_id?: string;
+    price_id?: string;
+    is_subscription?: boolean;
+    subscription_id?: string;
+}
+export interface PaymentBillingDetails {
+    name?: string;
+    email?: string;
+    business?: string;
+    vat_id?: string;
+    address?: string;
+    city?: string;
+    postal_code?: string;
+    province?: string;
+    country?: string;
+    tax_identifier?: string;
+}
+export interface LineItem {
+    product: string;
+    item_id: string;
+    paddle_prod_id: string;
+    quantity: number;
+    tax_rate: number;
+    tax: number;
+    discount: number;
+    subtotal: number;
+    total: number;
+    status: 'paid' | 'refunded' | 'refunding';
+}
+export interface ExpandedLineItem extends Omit<LineItem, 'product'> {
+    product: ProductObject;
+}
+export type PaymentStatus = 'open' | 'paid' | 'past_due' | 'unknown';
+export interface Payment {
+    id: string;
+    uid: string;
+    cus_id: string;
+    tran_id: string;
+    timestamp: number;
+    status: PaymentStatus;
+    line_items: LineItem[];
+    billing_details: PaymentBillingDetails;
+    sub_id?: string;
+}
+export interface ExpandedPayment extends Omit<Payment, 'line_items'> {
+    line_items: ExpandedLineItem[];
+}
+export type SubscriptionStatus = 'active' | 'cancelling' | 'cancelled';
+export interface Subscription {
+    uid: string;
+    id: string;
+    cus_id: string;
+    status: SubscriptionStatus;
+    plans: string[];
+}
+export interface PaddleConstructorOptions {
+    api_key: string;
+    client_key: string;
+    sandbox?: boolean;
+    products?: ProductObject[];
+    inclusive_tax?: boolean;
+    _server?: any;
+}
+export declare class Paddle {
+    private type;
+    private client_key;
+    private sandbox;
+    private inclusive_tax;
+    private products;
+    private server;
+    private _host;
+    private _headers;
+    private webhook_key?;
+    private _has_create_products_permission?;
+    private _settings_db;
+    private _sub_db;
+    private _active_sub_db;
+    private _pay_db;
+    private _inv_db;
+    private performance;
+    constructor({ api_key, client_key, sandbox, products, inclusive_tax, _server, }: PaddleConstructorOptions);
+    private _req;
+    private _add_subscription;
+    private _delete_subscription;
+    private _check_subscription;
+    private _get_active_subscriptions;
+    private _save_subscription;
+    private _load_subscription;
+    private _get_subscriptions;
+    private _save_payment;
+    private _load_payment;
+    private _load_payment_by_transaction;
+    private _delete_payment;
+    _delete_user(uid: string): Promise<void>;
+    _get_all_active_subscriptions(): Promise<any[]>;
+    private _get_product_by_paddle_prod_id;
+    private _get_products;
+    private _get_prices;
+    private _check_product;
+    private _cancel_subscription;
+    private _initialize_products;
+    _initialize(): Promise<void>;
+    private _exec_user_callback;
+    private _payment_webhook;
+    private _subscription_webhook;
+    private _subscription_cancelled_webhook;
+    private _adjustment_webhook;
+    private _create_webhook;
+    get_product(id: string): Promise<ProductObject | null>;
+    get_product(id: string, throw_err: true): Promise<ProductObject>;
+    get_product(id: string, throw_err: boolean): Promise<ProductObject | null>;
+    get_product_sync(id: string): ProductObject | null;
+    get_product_sync(id: string, throw_err: true): ProductObject;
+    get_product_sync(id: string, throw_err: boolean): ProductObject | null;
+    get_payment(id: string): Promise<Payment>;
+    get_payments({ uid, days, limit, status, }: {
+        uid: string;
+        days?: number;
+        limit?: number;
+        status?: string | string[];
+    }): Promise<Payment[]>;
+    get_refundable_payments({ uid, days, limit, }: {
+        uid: string;
+        days?: number;
+        limit?: number;
+    }): Promise<Payment[]>;
+    get_refunded_payments({ uid, days, limit, }: {
+        uid: string;
+        days?: number;
+        limit?: number;
+    }): Promise<Payment[]>;
+    get_refunding_payments({ uid, days, limit, }: {
+        uid: string;
+        days?: number;
+        limit?: number;
+    }): Promise<Payment[]>;
+    create_refund(payment: Payment | string, line_items?: LineItem[] | undefined, reason?: string): Promise<void>;
+    cancel_subscription(uid: string, products: string | (string | ProductObject)[], _throw_no_cancelled_err?: boolean): Promise<void>;
+    cancel_subscription_by_id(subscription: string | Subscription, immediate?: boolean): Promise<void>;
+    get_active_subscriptions(uid: string): Promise<string[]>;
+    get_subscriptions(uid: string): Promise<Subscription[]>;
+    is_subscribed(uid: string, product: string): Promise<boolean>;
+    generate_invoice(payment: Payment | ExpandedPayment): Promise<Buffer>;
+    dev_cancel_all_subscriptions(): Promise<void>;
+}
+export default Paddle;