@hyphen/sdk 1.8.0 → 1.10.0

package/dist/index.d.cts

@@ -1,5 +1,9 @@
-import { Hookified } from 'hookified';
+import { Hookified, HookifiedOptions } from 'hookified';
 import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { Cacheable } from 'cacheable';
+import pino from 'pino';
 
 type ToggleContext = EvaluationContext;
 declare enum ToggleHooks {
@@ -218,4 +222,292 @@ type LoadEnvOptions = {
  */
 declare function loadEnv(options?: LoadEnvOptions): void;
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+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 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;
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * 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.
+     * This is used for public endpoints that do not require authentication.
+     */
+    publicApiKey?: string;
+    /**
+     * The API key to use for the Hyphen service.
+     * This is used for authenticated endpoints that require an API key.
+     */
+    apiKey?: string;
+    /**
+     * Whether to throw errors or not.
+     * If set to true, errors will be thrown instead of logged.
+     * @default false
+     */
+    throwErrors?: boolean;
+    /**
+     * Options for the Toggle service.
+     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * @see ToggleOptions
+     * @default {Toggle}
+     */
+    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'>;
+    /**
+     * Options for the Link service.
+     * Excludes apiKey and throwErrors from LinkOptions.
+     * @see LinkOptions
+     * @default {Link}
+     */
+    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
+} & HookifiedOptions;
+declare class Hyphen extends Hookified {
+    private readonly _netInfo;
+    private readonly _toggle;
+    private readonly _link;
+    private _publicApiKey?;
+    private _apiKey?;
+    constructor(options?: HyphenOptions);
+    /**
+     * Get the NetInfo service instance.
+     * @returns {NetInfo} The NetInfo service instance.
+     */
+    get netInfo(): NetInfo;
+    /**
+     * Get the Toggle service instance.
+     * @returns {Toggle} The Toggle service instance.
+     */
+    get toggle(): Toggle;
+    /**
+     * Get the Link service instance.
+     * @returns {Link} The Link service instance.
+     */
+    get link(): Link;
+    /**
+     * Get the public API key for the Hyphen service.
+     * This is used for public endpoints that do not require authentication.
+     * @returns {string | undefined} The public API key.
+     */
+    get publicApiKey(): string | undefined;
+    /**
+     * Set the public API key for the Hyphen service. If set, this will also update the underlying services.
+     * This is used for public endpoints that do not require authentication such as the Toggle service.
+     * @param {string | undefined} value - The public API key to set.
+     */
+    set publicApiKey(value: string | undefined);
+    /**
+     * Get the API key for the Hyphen service.
+     * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+     * @returns {string | undefined} The API key.
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Set the API key for the Hyphen service. If set, this will also update the underlying services.
+     * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+     * @param {string | undefined} value - The API key to set.
+     */
+    set apiKey(value: string | undefined);
+    /**
+     * Get whether to throw errors or not.
+     * If set to true, errors will be thrown instead of logged.
+     * @returns {boolean} Whether to throw errors or not.
+     */
+    get throwErrors(): boolean;
+    /**
+     * Set whether to throw errors or not. If set to true, errors will be thrown instead of logged.
+     * This will update the underlying services as well.
+     * @param {boolean} value - Whether to throw errors or not.
+     */
+    set throwErrors(value: boolean);
+}
+
+export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };

package/dist/index.d.ts

@@ -1,5 +1,9 @@
-import { Hookified } from 'hookified';
+import { Hookified, HookifiedOptions } from 'hookified';
 import { EvaluationContext, Client } from '@openfeature/server-sdk';
+import * as axios from 'axios';
+import { AxiosRequestConfig } from 'axios';
+import { Cacheable } from 'cacheable';
+import pino from 'pino';
 
 type ToggleContext = EvaluationContext;
 declare enum ToggleHooks {
@@ -218,4 +222,292 @@ type LoadEnvOptions = {
  */
 declare function loadEnv(options?: LoadEnvOptions): void;
 
-export { Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };
+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 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;
+    createShortCode(longUrl: string, domain: string, options?: CreateShortCodeOptions): Promise<CreateShortCodeResponse>;
+    /**
+     * 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.
+     * This is used for public endpoints that do not require authentication.
+     */
+    publicApiKey?: string;
+    /**
+     * The API key to use for the Hyphen service.
+     * This is used for authenticated endpoints that require an API key.
+     */
+    apiKey?: string;
+    /**
+     * Whether to throw errors or not.
+     * If set to true, errors will be thrown instead of logged.
+     * @default false
+     */
+    throwErrors?: boolean;
+    /**
+     * Options for the Toggle service.
+     * Excludes publicApiKey and throwErrors from ToggleOptions.
+     * @see ToggleOptions
+     * @default {Toggle}
+     */
+    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'>;
+    /**
+     * Options for the Link service.
+     * Excludes apiKey and throwErrors from LinkOptions.
+     * @see LinkOptions
+     * @default {Link}
+     */
+    link?: Omit<LinkOptions, 'apiKey' | 'throwErrors'>;
+} & HookifiedOptions;
+declare class Hyphen extends Hookified {
+    private readonly _netInfo;
+    private readonly _toggle;
+    private readonly _link;
+    private _publicApiKey?;
+    private _apiKey?;
+    constructor(options?: HyphenOptions);
+    /**
+     * Get the NetInfo service instance.
+     * @returns {NetInfo} The NetInfo service instance.
+     */
+    get netInfo(): NetInfo;
+    /**
+     * Get the Toggle service instance.
+     * @returns {Toggle} The Toggle service instance.
+     */
+    get toggle(): Toggle;
+    /**
+     * Get the Link service instance.
+     * @returns {Link} The Link service instance.
+     */
+    get link(): Link;
+    /**
+     * Get the public API key for the Hyphen service.
+     * This is used for public endpoints that do not require authentication.
+     * @returns {string | undefined} The public API key.
+     */
+    get publicApiKey(): string | undefined;
+    /**
+     * Set the public API key for the Hyphen service. If set, this will also update the underlying services.
+     * This is used for public endpoints that do not require authentication such as the Toggle service.
+     * @param {string | undefined} value - The public API key to set.
+     */
+    set publicApiKey(value: string | undefined);
+    /**
+     * Get the API key for the Hyphen service.
+     * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+     * @returns {string | undefined} The API key.
+     */
+    get apiKey(): string | undefined;
+    /**
+     * Set the API key for the Hyphen service. If set, this will also update the underlying services.
+     * This is used for authenticated endpoints that require an API key such as the NetInfo and Link services.
+     * @param {string | undefined} value - The API key to set.
+     */
+    set apiKey(value: string | undefined);
+    /**
+     * Get whether to throw errors or not.
+     * If set to true, errors will be thrown instead of logged.
+     * @returns {boolean} Whether to throw errors or not.
+     */
+    get throwErrors(): boolean;
+    /**
+     * Set whether to throw errors or not. If set to true, errors will be thrown instead of logged.
+     * This will update the underlying services as well.
+     * @param {boolean} value - Whether to throw errors or not.
+     */
+    set throwErrors(value: boolean);
+}
+
+export { Hyphen, type HyphenOptions, Toggle, type ToggleCachingOptions, type ToggleContext, type ToggleGetOptions, ToggleHooks, type ToggleOptions, loadEnv };