@monterosa/sdk-core 2.0.0-rc.4 → 2.0.0-rc.5

package/dist/index.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var sdkUtil = require('@monterosa/sdk-util');
 
-var version = "2.0.0-rc.4";
+var version = "2.0.0-rc.5";
 
 /**
  * @license

package/dist/index.js

@@ -1,6 +1,6 @@
 import { checkAvailability, generateUUID, getItem, setItem } from '@monterosa/sdk-util';
 
-var version = "2.0.0-rc.4";
+var version = "2.0.0-rc.5";
 
 /**
  * @license

package/dist/sdk-core.d.ts

@@ -0,0 +1,249 @@
+/**
+ * Initialises the SDK and provides access to projects and configuration.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * @internal
+ */
+export declare function addKit(sdk: MonterosaSdk, name: string, kit: MonterosaKit): void;
+
+/**
+ * Creates an SDK instance.
+ *
+ * @example
+ *
+ * Configure default SDK with host and Project ID
+ *
+ * ```javascript
+ * configure({
+ *   host: "...",
+ *   projectId: "..."
+ * });
+ * ```
+ *
+ * @param options - Configuration object containing `host` and `projectId`.
+ *   These values can be found in the Embed section of your Project in Studio.
+ * @param name - Optional name of the sdk to initialise.
+ *   If name is not provided, the default is "[DEFAULT]"
+ *
+ * @returns Configured SDK instance.
+ *
+ * @public
+ */
+export declare function configure(options: SdkOptions, name?: string): MonterosaSdk;
+
+/**
+ * Default sdk name.
+ *
+ * @internal
+ */
+export declare const DEFAULT_SDK_NAME = "[DEFAULT]";
+
+/**
+ * @internal
+ */
+export declare function deleteKit(sdk: MonterosaSdk, name: string): void;
+
+/**
+ * Destroy initialised SDK
+ *
+ * @example
+ * ```javascript
+ * const sdk = configure(...);
+ *
+ * destroy(sdk);
+ * ```
+ *
+ * @param sdk - sdk instance
+ */
+export declare function destroy(sdk: MonterosaSdk): void;
+
+/**
+ * Device ID storage key name
+ *
+ * @internal
+ */
+export declare const DEVICE_ID_KEY = "device_id";
+
+/**
+ * @internal
+ */
+export declare function getDeviceId(): string;
+
+/**
+ * @internal
+ */
+export declare function getKit(sdk: MonterosaSdk, name: string): MonterosaKit | undefined;
+
+/**
+ * Retrieves an SDK instance by its name.
+ *
+ * @example
+ * ```javascript
+ * const sdk = getSdk('my-sdk');
+ * ```
+ *
+ * @param name - Optional name of the sdk to initialise.
+ *   If name is not provided, the default is "[DEFAULT]"
+ *
+ * @returns The configured SDK instance.
+ *
+ * @public
+ */
+export declare function getSdk(name?: string): MonterosaSdk;
+
+/**
+ * Returns all configured SDK instances.
+ *
+ * @returns An array of all configured SDK instances.
+ *
+ * @public
+ */
+export declare function getSdks(): MonterosaSdk[];
+
+/**
+ * @license
+ * @monterosa/sdk-core
+ *
+ * Copyright © 2021-2024 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+/** @internal */
+export declare type Kits = Map<string, MonterosaKit>;
+
+/** @internal */
+export declare class Logger {
+    name: string;
+    private _logLevel;
+    private _logHandler;
+    constructor(name: string);
+    get logLevel(): LogLevel;
+    set logLevel(level: LogLevel);
+    get logHandler(): LogHandler;
+    set logHandler(handler: LogHandler);
+    log(...args: unknown[]): void;
+    debug(...args: unknown[]): void;
+    info(...args: unknown[]): void;
+    warn(...args: unknown[]): void;
+    error(...args: unknown[]): void;
+}
+
+/** @internal */
+export declare type LogHandler = (logger: Logger, logType: LogLevel, ...args: unknown[]) => void;
+
+/**
+ * @license
+ * @monterosa/sdk-core
+ *
+ * Copyright © 2022 Monterosa Productions Limited. All rights reserved.
+ *
+ * More details on the license can be found at https://www.monterosa.co/sdk/license
+ */
+/**
+ * Represents the possible log levels.
+ */
+export declare enum LogLevel {
+    /**
+     * Verbose level. Provides detailed and extensive logging.
+     */
+    Verbose = 0,
+    /**
+     * Debug level. Used for debugging and development purposes.
+     */
+    Debug = 1,
+    /**
+     * Info level. Used to provide general information about the system's state.
+     */
+    Info = 2,
+    /**
+     * Warn level. Indicates potential issues or situations that might cause problems in the future.
+     */
+    Warn = 3,
+    /**
+     * Error level. Indicates critical errors and issues that require immediate attention.
+     */
+    Error = 4,
+    /**
+     * Silent level. No logs will be output.
+     */
+    Silent = 5
+}
+
+/** @internal */
+export declare interface MonterosaKit {
+    delete(): void;
+}
+
+/**
+ * Represents a configured SDK instance. Obtain one via
+ * {@link configure} or retrieve an existing one with
+ * {@link getSdk}.
+ */
+export declare interface MonterosaSdk {
+    /**
+     * SDK options
+     */
+    readonly options: SdkOptions;
+    /**
+     * SDK name
+     */
+    readonly name: string;
+    /**
+     * @internal
+     */
+    isDestroyed: boolean;
+    /**
+     * @internal
+     */
+    kits: Kits;
+    /**
+     * @internal
+     */
+    deleteKits(): void;
+}
+
+/**
+ * @internal
+ */
+export declare class Sdk implements MonterosaSdk {
+    private readonly _options;
+    private readonly _name;
+    private _isDestroyed;
+    private _kits;
+    constructor(options: SdkOptions, name: string);
+    get name(): string;
+    get options(): SdkOptions;
+    get isDestroyed(): boolean;
+    get kits(): Kits;
+    set isDestroyed(value: boolean);
+    deleteKits(): void;
+    private checkDestroyed;
+}
+
+/**
+ * Configuration object that used to initialise SDK and kits. Required values
+ * can be found in Monterosa / Interaction Cloud under
+ * {@link https://products.monterosa.co/mic/producer-guide/studio/project-settings | Project Settings tab}.
+ */
+export declare interface SdkOptions {
+    /**
+     * Studio instance host
+     */
+    readonly host: string;
+    /**
+     * Unique identifier for the Studio Project
+     */
+    readonly projectId: string;
+}
+
+/**
+ * The current SDK version.
+ *
+ * @public
+ */
+export declare const VERSION: string;
+
+export { }

package/dist/src/tsdoc-metadata.json

@@ -0,0 +1,11 @@
+// This file is read by tools that parse documentation comments conforming to the TSDoc standard.
+// It should be published with your NPM package.  It should not be tracked by Git.
+{
+  "tsdocVersion": "0.12",
+  "toolPackages": [
+    {
+      "packageName": "@microsoft/api-extractor",
+      "packageVersion": "7.23.0"
+    }
+  ]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@monterosa/sdk-core",
-  "version": "2.0.0-rc.4",
+  "version": "2.0.0-rc.5",
   "description": "Monterosa JS SDK / Core",
   "author": "Monterosa Productions Limited <hello@monterosa.co.uk> (https://www.monterosa.co/)",
   "main": "./dist/index.cjs",
@@ -32,7 +32,7 @@
   ],
   "license": "MIT",
   "dependencies": {
-    "@monterosa/sdk-util": "2.0.0-rc.4"
+    "@monterosa/sdk-util": "2.0.0-rc.5"
   },
   "devDependencies": {
     "@rollup/plugin-json": "^4.1.0",
@@ -53,5 +53,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "1c7b10a4da9d2b85a20a67cc4dac61c7aa8e692d"
+  "gitHead": "4f697a9733d36fb689a35b8e1dd6d589a9ae284c"
 }