@hyphen/sdk 1.11.0 → 1.12.1

package/dist/index.d.ts

@@ -1,9 +1,390 @@
-import { Hookified, HookifiedOptions } from 'hookified';
-import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import { HookifiedOptions, Hookified } from 'hookified';
 import * as axios from 'axios';
 import { AxiosRequestConfig } from 'axios';
 import { Cacheable } from 'cacheable';
 import pino from 'pino';
+import { EvaluationContext, Client } from '@openfeature/server-sdk';
+
+type EnvOptions = {
+    path?: string;
+    environment?: string;
+    local?: boolean;
+};
+/**
+ * @description Helper function to load your environment variables based on your default .env file
+ * and the current environment.
+ * @param {EnvOptions} [options] - Options to customize the loading of environment variables.
+ * @returns {void}
+ * @example
+ * import { env } from '@hyphen/sdk';
+ * env();
+ */
+declare function env(options?: EnvOptions): void;
+declare const loadEnv: typeof env;
+type LoadEnvOptions = EnvOptions;
+
+type BaseServiceOptions = {
+    throwErrors?: boolean;
+} & HookifiedOptions;
+declare class BaseService extends Hookified {
+    private _log;
+    private _cache;
+    private _throwErrors;
+    constructor(options?: BaseServiceOptions);
+    get log(): pino.Logger;
+    set log(value: pino.Logger);
+    get cache(): Cacheable;
+    set cache(value: Cacheable);
+    get throwErrors(): boolean;
+    set throwErrors(value: boolean);
+    error(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
+    createHeaders(apiKey?: string): Record<string, string>;
+}
+
+type ClickByDay = {
+    date: string;
+    total: number;
+    unique: number;
+};
+type Clicks = {
+    total: number;
+    unique: number;
+    byDay: ClickByDay[];
+};
+type Referral = {
+    url: string;
+    total: number;
+};
+type Browser = {
+    name: string;
+    total: number;
+};
+type Device = {
+    name: string;
+    total: number;
+};
+type Location = {
+    country: string;
+    total: number;
+    unique: number;
+};
+type GetCodeStatsResponse = {
+    clicks: Clicks;
+    referrals: Referral[];
+    browsers: Browser[];
+    devices: Device[];
+    locations: Location[];
+};
+
+type CreateShortCodeOptions = {
+    /**
+     * The short code used for this link. If not provided, a random code will be generated.
+     * @default undefined
+     */
+    code?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type CreateShortCodeResponse = {
+    id: string;
+    code: string;
+    long_url: string;
+    domain: string;
+    createdAt: string;
+    title?: string;
+    tags?: string[];
+    organizationId: {
+        id: string;
+        name: string;
+    };
+};
+type UpdateShortCodeResponse = CreateShortCodeResponse;
+type UpdateShortCodeOptions = {
+    /**
+     * The long URL that the short code will redirect to.
+     * @default undefined
+     */
+    long_url?: string;
+    /**
+     * The title of the link. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The tags associated with the link. This is used for categorization purposes.
+     * @default undefined
+     */
+    tags?: string[];
+};
+type GetShortCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: GetShortCodeResponse[];
+};
+type GetShortCodeResponse = CreateShortCodeResponse;
+declare enum QrSize {
+    SMALL = "small",
+    MEDIUM = "medium",
+    LARGE = "large"
+}
+type CreateQrCodeOptions = {
+    /**
+     * The title of the QR code. This is used for display purposes.
+     * @default undefined
+     */
+    title?: string;
+    /**
+     * The background color of the QR code. This is a hex color code.
+     * @default '#ffffff'
+     */
+    backgroundColor?: string;
+    /**
+     * The color of the QR code. This is a hex color code.
+     * @default '#000000'
+     */
+    color?: string;
+    /**
+     * The size of the QR code. This can be 'small', 'medium', or 'large'.
+     * @default QrSize.MEDIUM
+     */
+    size?: QrSize;
+    /**
+     * The logo to include in the QR code. This should be a base64 encoded string.
+     * @default undefined
+     */
+    logo?: string;
+};
+type CreateQrCodeResponse = {
+    id: string;
+    title?: string;
+    qrCode: string;
+    qrCodeBytes: Uint16Array;
+    qrLink: string;
+};
+type GetQrCodesResponse = {
+    total: number;
+    pageNum: number;
+    pageSize: number;
+    data: CreateQrCodeResponse[];
+};
+type LinkOptions = {
+    /**
+     * The URIs to access the link service.
+     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
+     */
+    uris?: string[];
+    /**
+     * The organization ID to use for the link service.
+     * @requires organizationId
+     */
+    organizationId?: string;
+    /**
+     * The API key to use for the link service. This should be provided as the service requires authentication.
+     */
+    apiKey?: string;
+} & BaseServiceOptions;
+declare class Link extends BaseService {
+    private _uris;
+    private _organizationId?;
+    private _apiKey?;
+    constructor(options?: LinkOptions);
+    /**
+     * Get the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+     * @returns {string[]} The URIs for the link service.
+     */
+    get uris(): string[];
+    /**
+     * Set the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
+     * @param {string[]} uris - The URIs to set.
+     */
+    set uris(uris: string[]);
+    /**
+     * Get the organization ID for the link service. This is required to access the link service.
+     * @returns {string | undefined} The organization ID.
+     */
+    get organizationId(): string | undefined;
+    /**
+     * Set the organization ID for the link service. This is required to access the link service.
+     * @param {string | undefined} organizationId - The organization ID to set.
+     */
+    set organizationId(organizationId: string | undefined);
+    /**
+     * Get the API key for the link service. This is required to access the link service.
+     * @returns {string | undefined} The API key.
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Set the API key for the link service. This is required to access the link service.
+     * @param {string | undefined} apiKey - The API key to set.
+     */
+    set apiKey(apiKey: string | undefined);
+    /**
+     * Set the API key for the link service. If the API key starts with 'public_', an error is thrown.
+     * This is to ensure that the API key is not a public key, which should not be used for authenticated requests.
+     * @param {string} apiKey
+     */
+    setApiKey(apiKey: string | undefined): void;
+    /**
+     * Get the URI for a specific organization and code. This is used internally to construct the URI for the link service.
+     * @param {string} organizationId The ID of the organization.
+     * @param {string} code The code to include in the URI.
+     * @returns {string} The constructed URI.
+     */
+    getUri(organizationId: string, prefix1?: string, prefix2?: string, prefix3?: string): string;
+    /**
+     * Create a short code for a long URL.
+     * @param {string} longUrl The long URL to shorten.
+     * @param {string} domain The domain to use for the short code.
+     * @param {CreateShortCodeOptions} options Optional parameters for creating the short code.
+     * @returns {Promise<CreateShortCodeResponse>} A promise that resolves to the created short code details.
+     */
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * Get a short code by its code.
+     * @param {string} code The short code to retrieve. Example: 'code_686bed403c3991bd676bba4d'
+     * @returns {Promise<GetShortCodeResponse>} A promise that resolves to the short code details.
+     */
+    getShortCode(code: string): Promise<GetShortCodeResponse>;
+    /**
+     * Get all short codes for the organization.
+     * @param {string} titleSearch Optional search term to filter short codes by title.
+     * @param {string[]} tags Optional tags to filter short codes.
+     * @param {number} pageNumber The page number to retrieve. Default is 1.
+     * @param {number} pageSize The number of short codes per page. Default is 100.
+     * @returns {Promise<GetShortCodesResponse>} A promise that resolves to the list of short codes.
+     */
+    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
+    /**
+     * Get all tags associated with the organization's short codes.
+     * @returns {Promise<string[]>} A promise that resolves to an array of tags.
+     */
+    getTags(): Promise<string[]>;
+    /**
+     * Get statistics for a specific short code.
+     * @param code The short code to retrieve statistics for.
+     * @returns {Promise<GetCodeStatsResponse>} A promise that resolves to the code statistics.
+     */
+    getCodeStats(code: string, startDate: Date, endDate: Date): Promise<GetCodeStatsResponse>;
+    /**
+     * Update a short code.
+     * @param {string} code The short code to update. Example: 'code_686bed403c3991bd676bba4d'
+     * @param {UpdateShortCodeOptions} options The options to update the short code with.
+     * @returns {Promise<UpdateShortCodeResponse>} A promise that resolves to the updated short code details.
+     */
+    updateShortCode(code: string, options: UpdateShortCodeOptions): Promise<UpdateShortCodeResponse>;
+    /**
+     * Delete a short code.
+     * @param {string} code The short code to delete. Example: 'code_686bed403c3991bd676bba4d'
+     * @returns {Promise<boolean>} A promise that resolves to true if the short code was deleted successfully, or false if it was not.
+     */
+    deleteShortCode(code: string): Promise<boolean>;
+    /**
+     * Create a QR code for a specific short code.
+     * @param {string} code The short code to create a QR code for.
+     * @param {CreateQrCodeOptions} options The options for creating the QR code.
+     * @returns {Promise<CreateQrCodeResponse>} A promise that resolves to the created QR code details.
+     */
+    createQrCode(code: string, options?: CreateQrCodeOptions): Promise<CreateQrCodeResponse>;
+    /**
+     * Get a QR code by its ID.
+     * @param code The short code associated with the QR code.
+     * @param qr The ID of the QR code to retrieve.
+     * @returns The details of the requested QR code.
+     */
+    getQrCode(code: string, qr: string): Promise<CreateQrCodeResponse>;
+    getQrCodes(code: string, pageNumber?: number, pageSize?: number): Promise<GetQrCodesResponse>;
+    /**
+     * Delete a QR code by its ID.
+     * @param {string} code The short code associated with the QR code.
+     * @param {string} qr The ID of the QR code to delete.
+     * @returns {Promise<boolean>} A promise that resolves to true if the QR code was deleted successfully, or false if it was not.
+     */
+    deleteQrCode(code: string, qr: string): Promise<boolean>;
+}
+
+type NetInfoOptions = {
+    /**
+     * API key for authentication. If this is not provided it will try to use `HYPHEN_API_KEY` environment variable.
+     * @type {string} - The API key for authentication. This is not the public API key.
+     * @default undefined
+     */
+    apiKey?: string;
+    /**
+     * Base URI for the API. If not provided, it will use the default Hyphen API base URI.
+     * @type {string} - The base URI for the API.
+     * @default 'https://net.info'
+     */
+    baseUri?: string;
+} & BaseServiceOptions;
+type ipInfo = {
+    ip: string;
+    type: string;
+    location: {
+        country: string;
+        region: string;
+        city: string;
+        lat: number;
+        lng: number;
+        postalCode: string;
+        timezone: string;
+        geonameId: number;
+    };
+};
+type ipInfoError = {
+    ip: string;
+    type: string;
+    errorMessage: string;
+};
+declare class NetInfo extends BaseService {
+    private _apiKey;
+    private _baseUri;
+    constructor(options?: NetInfoOptions);
+    /**
+     * Gets or sets the API key for authentication.
+     * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
+     * @type {string | undefined}
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Sets the API key for authentication.
+     * @param {string | undefined} value - The API key to set.
+     */
+    set apiKey(value: string | undefined);
+    /**
+     * Gets or sets the base URI for the API.
+     * @type {string}
+     */
+    get baseUri(): string;
+    /**
+     * Sets the base URI for the API.
+     * @param {string} value - The base URI to set.
+     */
+    set baseUri(value: string);
+    setApiKey(value: string | undefined): void;
+    /**
+     * Fetches GeoIP information for a given IP address.
+     * @param {string} ip - The IP address to fetch GeoIP information for.
+     * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
+     */
+    getIpInfo(ip: string): Promise<ipInfo | ipInfoError>;
+    getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
+}
 
 type ToggleContext = EvaluationContext;
 declare enum ToggleHooks {
@@ -206,232 +587,6 @@ declare class Toggle extends Hookified {
     getObject<T>(key: string, defaultValue: T, options?: ToggleGetOptions): Promise<T>;
 }
 
-type LoadEnvOptions = {
-    path?: string;
-    environment?: string;
-    local?: boolean;
-};
-/**
- * @description Helper function to load your environment variables based on your default .env file
- * and the current environment.
- * @param {LoadEnvOptions} [options] - Options to customize the loading of environment variables.
- * @returns {void}
- * @example
- * import { loadEnv } from '@hyphen/sdk';
- * loadEnv();
- */
-declare function loadEnv(options?: LoadEnvOptions): void;
-
-type BaseServiceOptions = {
-    throwErrors?: boolean;
-} & HookifiedOptions;
-declare class BaseService extends Hookified {
-    private _log;
-    private _cache;
-    private _throwErrors;
-    constructor(options?: BaseServiceOptions);
-    get log(): pino.Logger;
-    set log(value: pino.Logger);
-    get cache(): Cacheable;
-    set cache(value: Cacheable);
-    get throwErrors(): boolean;
-    set throwErrors(value: boolean);
-    error(message: string, ...args: any[]): void;
-    warn(message: string, ...args: any[]): void;
-    info(message: string, ...args: any[]): void;
-    get<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    post<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    put<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    delete<T>(url: string, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    patch<T>(url: string, data: any, config?: AxiosRequestConfig): Promise<axios.AxiosResponse<T, any>>;
-    createHeaders(apiKey?: string): Record<string, string>;
-}
-
-type NetInfoOptions = {
-    /**
-     * API key for authentication. If this is not provided it will try to use `HYPHEN_API_KEY` environment variable.
-     * @type {string} - The API key for authentication. This is not the public API key.
-     * @default undefined
-     */
-    apiKey?: string;
-    /**
-     * Base URI for the API. If not provided, it will use the default Hyphen API base URI.
-     * @type {string} - The base URI for the API.
-     * @default 'https://net.info'
-     */
-    baseUri?: string;
-} & BaseServiceOptions;
-type ipInfo = {
-    ip: string;
-    type: string;
-    location: {
-        country: string;
-        region: string;
-        city: string;
-        lat: number;
-        lng: number;
-        postalCode: string;
-        timezone: string;
-        geonameId: number;
-    };
-};
-type ipInfoError = {
-    ip: string;
-    type: string;
-    errorMessage: string;
-};
-declare class NetInfo extends BaseService {
-    private _apiKey;
-    private _baseUri;
-    constructor(options?: NetInfoOptions);
-    /**
-     * Gets or sets the API key for authentication.
-     * If not set, it will try to use the `HYPHEN_API_KEY` environment variable.
-     * @type {string | undefined}
-     */
-    get apiKey(): string | undefined;
-    /**
-     * Sets the API key for authentication.
-     * @param {string | undefined} value - The API key to set.
-     */
-    set apiKey(value: string | undefined);
-    /**
-     * Gets or sets the base URI for the API.
-     * @type {string}
-     */
-    get baseUri(): string;
-    /**
-     * Sets the base URI for the API.
-     * @param {string} value - The base URI to set.
-     */
-    set baseUri(value: string);
-    setApiKey(value: string | undefined): void;
-    /**
-     * Fetches GeoIP information for a given IP address.
-     * @param {string} ip - The IP address to fetch GeoIP information for.
-     * @returns {Promise<ipInfo | ipInfoError>} - A promise that resolves to the ip information or an error.
-     */
-    getIpInfo(ip: string): Promise<ipInfo | ipInfoError>;
-    getIpInfos(ips: string[]): Promise<Array<ipInfo | ipInfoError>>;
-}
-
-type CreateShortCodeOptions = {
-    /**
-     * The short code used for this link. If not provided, a random code will be generated.
-     * @default undefined
-     */
-    code?: string;
-    /**
-     * The title of the link. This is used for display purposes.
-     * @default undefined
-     */
-    title?: string;
-    /**
-     * The tags associated with the link. This is used for categorization purposes.
-     * @default undefined
-     */
-    tags?: string[];
-};
-type CreateShortCodeResponse = {
-    id: string;
-    code: string;
-    long_url: string;
-    domain: string;
-    createdAt: string;
-    title?: string;
-    tags?: string[];
-    organizationId: {
-        id: string;
-        name: string;
-    };
-};
-type GetShortCodesResponse = {
-    total: number;
-    pageNum: number;
-    pageSize: number;
-    data: GetShortCodeResponse[];
-};
-type GetShortCodeResponse = CreateShortCodeResponse;
-type LinkOptions = {
-    /**
-     * The URIs to access the link service.
-     * @default ["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]
-     */
-    uris?: string[];
-    /**
-     * The organization ID to use for the link service.
-     * @requires organizationId
-     */
-    organizationId?: string;
-    /**
-     * The API key to use for the link service. This should be provided as the service requires authentication.
-     */
-    apiKey?: string;
-} & BaseServiceOptions;
-declare class Link extends BaseService {
-    private _uris;
-    private _organizationId?;
-    private _apiKey?;
-    constructor(options?: LinkOptions);
-    /**
-     * Get the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
-     * @returns {string[]} The URIs for the link service.
-     */
-    get uris(): string[];
-    /**
-     * Set the URIs for the link service. The default is `["https://api.hyphen.ai/api/organizations/{organizationId}/link/codes/"]`.
-     * @param {string[]} uris - The URIs to set.
-     */
-    set uris(uris: string[]);
-    /**
-     * Get the organization ID for the link service. This is required to access the link service.
-     * @returns {string | undefined} The organization ID.
-     */
-    get organizationId(): string | undefined;
-    /**
-     * Set the organization ID for the link service. This is required to access the link service.
-     * @param {string | undefined} organizationId - The organization ID to set.
-     */
-    set organizationId(organizationId: string | undefined);
-    /**
-     * Get the API key for the link service. This is required to access the link service.
-     * @returns {string | undefined} The API key.
-     */
-    get apiKey(): string | undefined;
-    /**
-     * Set the API key for the link service. This is required to access the link service.
-     * @param {string | undefined} apiKey - The API key to set.
-     */
-    set apiKey(apiKey: string | undefined);
-    /**
-     * Set the API key for the link service. If the API key starts with 'public_', an error is thrown.
-     * This is to ensure that the API key is not a public key, which should not be used for authenticated requests.
-     * @param {string} apiKey
-     */
-    setApiKey(apiKey: string | undefined): void;
-    /**
-     * Get the URI for a specific organization and code. This is used internally to construct the URI for the link service.
-     * @param {string} organizationId The ID of the organization.
-     * @param {string} code The code to include in the URI.
-     * @returns {string} The constructed URI.
-     */
-    getUri(organizationId: string, code?: string): string;
-    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
-    /**
-     * Get a short code by its code.
-     * @param {string} code The short code to retrieve. Example: 'code_686bed403c3991bd676bba4d'
-     * @returns {Promise<GetShortCodeResponse>} A promise that resolves to the short code details.
-     */
-    getShortCode(code: string): Promise<GetShortCodeResponse>;
-    getShortCodes(titleSearch: string, tags?: string[], pageNumber?: number, pageSize?: number): Promise<GetShortCodesResponse>;
-    /**
-     * Delete a short code.
-     * @param {string} code The short code to delete. Example: 'code_686bed403c3991bd676bba4d'
-     * @returns {Promise<boolean>} A promise that resolves to true if the short code was deleted successfully, or false if it was not.
-     */
-    deleteShortCode(code: string): Promise<boolean>;
-}
-
 type HyphenOptions = {
     /**
      * The public API key to use for the Hyphen service.
@@ -455,21 +610,21 @@ type HyphenOptions = {
      * @see ToggleOptions
      * @default {Toggle}
      */
-    toggle?: Omit<ToggleOptions, 'publicApiKey' | 'throwErrors'>;
+    toggle?: Omit<ToggleOptions, "publicApiKey" | "throwErrors">;
     /**
      * Options for the NetInfo service.
      * Excludes apiKey and throwErrors from NetInfoOptions.
      * @see NetInfoOptions
      * @default {NetInfo}
      */
-    netInfo?: Omit<NetInfoOptions, 'apiKey' | 'throwErrors'>;
+    netInfo?: Omit<NetInfoOptions, "apiKey" | "throwErrors">;
     /**
      * Options for the Link service.
      * Excludes apiKey and throwErrors from LinkOptions.
      * @see LinkOptions
      * @default {Link}
      */
-    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
+    link?: Omit<LinkOptions, "apiKey" | "throwErrors">;
 } & HookifiedOptions;
 declare class Hyphen extends Hookified {
     private readonly _netInfo;
@@ -531,4 +686,4 @@ declare class Hyphen extends Hookified {
     set throwErrors(value: boolean);
 }
 
-export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+export { type EnvOptions, Hyphen, type HyphenOptions, type LoadEnvOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, env, loadEnv };