@schematichq/schematic-typescript-node 1.1.7 → 1.1.9

package/dist/wrapper.d.ts

@@ -2,19 +2,32 @@ import * as api from "./api";
 import { SchematicClient as BaseClient } from "./Client";
 import { CacheProvider } from "./cache";
 import { Logger } from "./logger";
+/**
+ * Configuration options for the SchematicClient
+ */
 export interface SchematicOptions {
+    /** API key for authentication */
     apiKey?: string;
+    /** Custom base URL for API endpoints */
     basePath?: string;
+    /** Cache provider configuration */
     cacheProviders?: {
+        /** Providers for caching flag check results */
         flagChecks?: CacheProvider<boolean>[];
     };
+    /** If using an API key that is not environment-specific, use this option to specify the environment */
     environmentId?: string;
+    /** Interval in milliseconds for flushing event buffer */
     eventBufferInterval?: number;
+    /** Default values for feature flags */
     flagDefaults?: {
         [key: string]: boolean;
     };
+    /** Additional HTTP headers for API requests */
     headers?: Record<string, string>;
+    /** Custom logger implementation */
     logger?: Logger;
+    /** Enable offline mode to prevent network activity */
     offline?: boolean;
 }
 export declare class SchematicClient extends BaseClient {
@@ -23,12 +36,48 @@ export declare class SchematicClient extends BaseClient {
     private flagDefaults;
     private logger;
     private offline;
+    /**
+     * Creates a new instance of the SchematicClient
+     * @param opts - Configuration options for the client
+     */
     constructor(opts?: SchematicOptions);
+    /**
+     * Checks the value of a feature flag for the given evaluation context
+     * @param evalCtx - The context (company and/or user) for evaluating the feature flag
+     * @param key - The unique identifier of the feature flag
+     * @returns Promise resolving to the flag's boolean value, falling back to default if unavailable
+     * @throws Will log error and return flag default if check fails
+     */
     checkFlag(evalCtx: api.CheckFlagRequestBody, key: string): Promise<boolean>;
+    /**
+     * Gracefully shuts down the client by stopping the event buffer
+     * @returns Promise that resolves when the event buffer has been stopped
+     */
     close(): Promise<void>;
+    /**
+     * Send a non-blocking event to create or update companies and users
+     * @param body - The identify event payload containing user properties
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     identify(body: api.EventBodyIdentify): Promise<void>;
+    /**
+     * Send a non-blocking event to track usage
+     * @param body - The track event payload containing event details
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     track(body: api.EventBodyTrack): Promise<void>;
+    /**
+     * Sets the default value for a specific feature flag
+     * @param flag - The feature flag identifier
+     * @param value - The default boolean value to set
+     */
     setFlagDefault(flag: string, value: boolean): void;
+    /**
+     * Sets default values for multiple feature flags at once
+     * @param values - Object mapping flag identifiers to their default boolean values
+     */
     setFlagDefaults(values: {
         [key: string]: boolean;
     }): void;

package/dist/wrapper.js

@@ -16,6 +16,10 @@ const logger_1 = require("./logger");
 const events_1 = require("./events");
 const custom_1 = require("./core/fetcher/custom");
 class SchematicClient extends Client_1.SchematicClient {
+    /**
+     * Creates a new instance of the SchematicClient
+     * @param opts - Configuration options for the client
+     */
     constructor(opts) {
         var _a, _b;
         const { apiKey = "", basePath, eventBufferInterval, flagDefaults = {}, logger = new logger_1.ConsoleLogger(), } = opts !== null && opts !== void 0 ? opts : {};
@@ -54,6 +58,13 @@ class SchematicClient extends Client_1.SchematicClient {
         this.flagDefaults = flagDefaults;
         this.offline = offline;
     }
+    /**
+     * Checks the value of a feature flag for the given evaluation context
+     * @param evalCtx - The context (company and/or user) for evaluating the feature flag
+     * @param key - The unique identifier of the feature flag
+     * @returns Promise resolving to the flag's boolean value, falling back to default if unavailable
+     * @throws Will log error and return flag default if check fails
+     */
     checkFlag(evalCtx, key) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline) {
@@ -82,11 +93,21 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Gracefully shuts down the client by stopping the event buffer
+     * @returns Promise that resolves when the event buffer has been stopped
+     */
     close() {
         return __awaiter(this, void 0, void 0, function* () {
             return this.eventBuffer.stop();
         });
     }
+    /**
+     * Send a non-blocking event to create or update companies and users
+     * @param body - The identify event payload containing user properties
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     identify(body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline)
@@ -99,6 +120,12 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Send a non-blocking event to track usage
+     * @param body - The track event payload containing event details
+     * @returns Promise that resolves when the event has been enqueued
+     * @throws Will log error if event enqueueing fails
+     */
     track(body) {
         return __awaiter(this, void 0, void 0, function* () {
             if (this.offline)
@@ -111,9 +138,18 @@ class SchematicClient extends Client_1.SchematicClient {
             }
         });
     }
+    /**
+     * Sets the default value for a specific feature flag
+     * @param flag - The feature flag identifier
+     * @param value - The default boolean value to set
+     */
     setFlagDefault(flag, value) {
         this.flagDefaults[flag] = value;
     }
+    /**
+     * Sets default values for multiple feature flags at once
+     * @param values - Object mapping flag identifiers to their default boolean values
+     */
     setFlagDefaults(values) {
         Object.assign(this.flagDefaults, values);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@schematichq/schematic-typescript-node",
-    "version": "1.1.7",
+    "version": "1.1.9",
     "private": false,
     "repository": "https://github.com/schematichq/schematic-node",
     "main": "./index.js",