@codeleap/debug 6.3.0 → 6.8.0

package/dist/EnvironmentManager/class.d.ts

@@ -0,0 +1,55 @@
+import { Keyof, StringRecord } from '@codeleap/types';
+import { EnvironmentStore, EnvironmentManagerConfig, Editor } from './types';
+/**
+ * Runtime switchboard for backend environments in debug builds.
+ *
+ * The override is opt-in: until `setEnabled` is called the manager always
+ * returns `defaultEnvironment`, making it safe to instantiate unconditionally.
+ * State is persisted via `@codeleap/store` `globalState` so it survives page
+ * reloads, but the `enabledBy` flag gates whether that persisted state is
+ * actually honoured.
+ *
+ * When the active environment is `customEnvironment`, `serverUrl` validates the
+ * stored URL against a strict regex and falls back to `defaultEnvironment` if
+ * it fails — callers can rely on `serverUrl` always returning a usable value.
+ */
+export declare class EnvironmentManager<T extends StringRecord> {
+    private config;
+    private store;
+    private initialStoreValue;
+    readonly editors: {
+        readonly SYSTEM: "system";
+        readonly USER: "user";
+    };
+    get environments(): T;
+    get defaultConfig(): EnvironmentStore<T>;
+    constructor(config: EnvironmentManagerConfig<T>);
+    testUrl(url: string | undefined): boolean;
+    get env(): EnvironmentStore<T>;
+    setEnabled(by?: Editor | false): by is import("@codeleap/types").ValueOf<{
+        readonly SYSTEM: "system";
+        readonly USER: "user";
+    }>;
+    get isEnabled(): boolean;
+    get isEnabledBy(): Editor;
+    get isEnabledBySystem(): boolean;
+    get isEnabledByUser(): boolean;
+    get is(): Record<Capitalize<Keyof<T> extends string ? Keyof<T> : string>, boolean>;
+    get serverUrl(): string;
+    setEnvironment(environment: Keyof<T>): void;
+    isEnvironment(env: Keyof<T>): boolean;
+    setCustomUrl(url: string): void;
+    use(): {
+        enabled: boolean;
+        enabledByUser: boolean;
+        enabledBySystem: boolean;
+        config: {
+            environment: keyof T;
+            customUrl: string;
+        };
+        changed: boolean;
+        customUrl: string;
+        setCustomUrl: import("react").Dispatch<import("react").SetStateAction<string>>;
+    };
+}
+//# sourceMappingURL=class.d.ts.map

package/dist/EnvironmentManager/class.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class.d.ts","sourceRoot":"","sources":["../../src/EnvironmentManager/class.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,YAAY,EAAc,MAAM,iBAAiB,CAAA;AAGjE,OAAO,EAAE,gBAAgB,EAAE,wBAAwB,EAAE,MAAM,EAAE,MAAM,SAAS,CAAA;AAG5E;;;;;;;;;;;;GAYG;AACH,qBAAa,kBAAkB,CAAC,CAAC,SAAS,YAAY;IAmBxC,OAAO,CAAC,MAAM;IAlB1B,OAAO,CAAC,KAAK,CAAqD;IAElE,OAAO,CAAC,iBAAiB,CAAqB;IAE9C,QAAQ,CAAC,OAAO;;;MAAU;IAE1B,IAAI,YAAY,MAEf;IAED,IAAI,aAAa,IAKV,gBAAgB,CAAC,CAAC,CAAC,CACzB;gBAEmB,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC;IASvD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS;IAM/B,IAAI,GAAG,IAAI,gBAAgB,CAAC,CAAC,CAAC,CAY7B;IAED,UAAU,CAAC,EAAE,GAAE,MAAM,GAAG,KAAa;;;;IAMrC,IAAI,SAAS,IAAI,OAAO,CAEvB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,iBAAiB,IAAI,OAAO,CAE/B;IAED,IAAI,eAAe,IAAI,OAAO,CAE7B;IAED,IAAI,EAAE,IAAI,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,EAAE,OAAO,CAAC,CAOjF;IAED,IAAI,SAAS,WAYZ;IAED,cAAc,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC;IAKpC,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,GAAG,OAAO;IAKrC,YAAY,CAAC,GAAG,EAAE,MAAM;IAUxB,GAAG;;;;;;;;;;;;CAmBJ"}

package/dist/EnvironmentManager/const.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Identifies who enabled the environment override — the application itself
+ * (`SYSTEM`) or an end user via a debug UI (`USER`). Used to gate which
+ * controls are exposed and whether the override survives a session reset.
+ */
+export declare const EDITORS: {
+    readonly SYSTEM: "system";
+    readonly USER: "user";
+};
+//# sourceMappingURL=const.d.ts.map

package/dist/EnvironmentManager/const.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"const.d.ts","sourceRoot":"","sources":["../../src/EnvironmentManager/const.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,OAAO;;;CAGV,CAAA"}

package/dist/EnvironmentManager/factor.d.ts

@@ -0,0 +1,10 @@
+import { StringRecord } from '@codeleap/types';
+import { EnvironmentManager } from './class';
+import { EnvironmentManagerConfig } from './types';
+/**
+ * Preferred entry point for instantiating an `EnvironmentManager`.
+ * Keeps call-sites free of the generic `new` syntax and makes the config
+ * shape the only public API surface that needs to be imported.
+ */
+export declare function createEnvironmentManager<T extends StringRecord>(config: EnvironmentManagerConfig<T>): EnvironmentManager<T>;
+//# sourceMappingURL=factor.d.ts.map

package/dist/EnvironmentManager/factor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factor.d.ts","sourceRoot":"","sources":["../../src/EnvironmentManager/factor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAC5C,OAAO,EAAE,wBAAwB,EAAE,MAAM,SAAS,CAAA;AAElD;;;;GAIG;AACH,wBAAgB,wBAAwB,CAAC,CAAC,SAAS,YAAY,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,yBAEnG"}

package/dist/EnvironmentManager/index.d.ts

@@ -0,0 +1,4 @@
+export * from './factor';
+export * from './class';
+export * from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/EnvironmentManager/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/EnvironmentManager/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,cAAc,SAAS,CAAA"}

package/dist/EnvironmentManager/types.d.ts

@@ -0,0 +1,27 @@
+import { Keyof, StringRecord, ValueOf } from '@codeleap/types';
+import { EDITORS } from './const';
+/** `null` means the override is disabled; a non-null value identifies who enabled it. */
+export type Editor = ValueOf<typeof EDITORS> | null;
+/**
+ * `customEnvironment` names the key whose URL is taken from `EnvironmentStore.customUrl`
+ * rather than the `environments` map, so it must exist as a key in `T` even though its
+ * map value is ignored at runtime. `persistKey` controls the localStorage slot;
+ * omitting it falls back to `'environment-manager'`.
+ */
+export type EnvironmentManagerConfig<T extends StringRecord> = {
+    environments: T;
+    defaultEnvironment: Keyof<T>;
+    customEnvironment: Keyof<T>;
+    persistKey?: string;
+};
+/**
+ * Persisted slice of debug state. When `enabledBy` is `null` the manager
+ * ignores `environment` and `customUrl` entirely, returning the default config
+ * instead — so the store being populated does not mean the override is active.
+ */
+export type EnvironmentStore<T extends StringRecord> = {
+    environment: Keyof<T>;
+    customUrl: string;
+    enabledBy: Editor;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/EnvironmentManager/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/EnvironmentManager/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AAEjC,yFAAyF;AACzF,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,OAAO,CAAC,GAAG,IAAI,CAAA;AAEnD;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,CAAC,CAAC,SAAS,YAAY,IAAI;IAC7D,YAAY,EAAE,CAAC,CAAA;IACf,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IAC5B,iBAAiB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,SAAS,YAAY,IAAI;IACrD,WAAW,EAAE,KAAK,CAAC,CAAC,CAAC,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,MAAM,CAAA;CAClB,CAAA"}

package/dist/FakeRestApi/class.d.ts

@@ -0,0 +1,118 @@
+import { FakeItem, FakeRestApiOptions, PaginationResponse } from './types';
+/**
+ * A fake REST API implementation for testing and prototyping.
+ * Provides CRUD operations with pagination support and optional request delays.
+ * @template T - The type of items to manage, must extend FakeItem
+ * @template F - The type of filters to apply when listing items
+ */
+export declare class FakeRestApi<T extends FakeItem, F = Record<string, unknown>> {
+    private data;
+    private options;
+    /**
+     * Gets the ID of the last item in the data array.
+     * @private
+     * @returns The highest ID or 0 if no items exist
+     */
+    private get lastId();
+    /**
+     * Gets the name of the API.
+     * @returns The API name
+     */
+    get name(): string;
+    /**
+     * Gets the current count of items.
+     * @returns The number of items in the data array
+     */
+    get count(): number;
+    /**
+     * Creates a new FakeRestApi instance.
+     * @param options - Configuration options for the API
+     */
+    constructor(options: FakeRestApiOptions<T, F>);
+    /**
+     * Initializes the data array with items up to maxCount.
+     * @private
+     */
+    private initialize;
+    /**
+     * Updates the API options partially.
+     * @param newOptions - Partial options to update
+     */
+    setOptions(newOptions: Partial<FakeRestApiOptions<T, F>>): void;
+    /**
+     * Generates a new item using the generator function.
+     * @param id - The ID for the new item (defaults to lastId + 1)
+     * @returns A newly generated item
+     */
+    generateItem(id?: T['id']): T;
+    /**
+     * Introduces an artificial delay if enabled in options.
+     * @private
+     * @returns A promise that resolves after the delay period
+     */
+    private delay;
+    /**
+     * Builds a URL with pagination parameters.
+     * @private
+     * @param limit - Number of items per page
+     * @param offset - Starting position
+     * @returns A formatted URL string
+     */
+    private buildUrl;
+    /**
+     * Retrieves a paginated list of items with optional filtering.
+     * @param limit - Number of items to return (default: 10)
+     * @param offset - Starting position (default: 0)
+     * @param filters - Optional filters to apply
+     * @returns A promise that resolves to a paginated response
+     */
+    listItems(limit?: number, offset?: number, filters?: F): Promise<PaginationResponse<T>>;
+    /**
+     * Retrieves a single item by ID.
+     * @param id - The ID of the item to retrieve
+     * @returns A promise that resolves to the requested item
+     * @throws {Error} If the item is not found
+     */
+    retrieveItem(id: T['id']): Promise<T>;
+    /**
+     * Creates a new item and adds it to the data array.
+     * @param item - Optional partial item data (ID will be auto-generated)
+     * @returns A promise that resolves to the created item
+     */
+    createItem(item?: Partial<T>): Promise<T>;
+    /**
+     * Updates an existing item by ID.
+     * @param id - The ID of the item to update
+     * @param updates - Partial item data to update
+     * @returns A promise that resolves to the updated item
+     * @throws {Error} If the item is not found
+     */
+    updateItem(id: T['id'], updates: Partial<T>): Promise<T>;
+    /**
+     * Deletes an item by ID.
+     * @param id - The ID of the item to delete
+     * @returns A promise that resolves to the deleted item
+     * @throws {Error} If the item is not found
+     */
+    deleteItem(id: T['id']): Promise<T>;
+    /**
+     * Resets the data array to its initial state by regenerating all items.
+     */
+    reset(): void;
+    /**
+     * Clears all items from the data array.
+     */
+    clear(): void;
+    /**
+     * Gets a readonly copy of all items in the data array.
+     * @returns A frozen array of all items
+     */
+    getData(): readonly T[];
+    /**
+     * Gets a single item by ID without delay.
+     * @param id - The ID of the item to retrieve
+     * @returns The item if found, undefined otherwise
+     */
+    getItem(id: T['id']): T | undefined;
+}
+//# sourceMappingURL=class.d.ts.map

package/dist/FakeRestApi/class.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"class.d.ts","sourceRoot":"","sources":["../../src/FakeRestApi/class.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE1E;;;;;GAKG;AACH,qBAAa,WAAW,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACtE,OAAO,CAAC,IAAI,CAAU;IACtB,OAAO,CAAC,OAAO,CAAoC;IAEnD;;;;OAIG;IACH,OAAO,KAAK,MAAM,GAEjB;IAED;;;OAGG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;;OAGG;gBACS,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC;IAY7C;;;OAGG;IACH,OAAO,CAAC,UAAU;IAMlB;;;OAGG;IACI,UAAU,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI;IAItE;;;;OAIG;IACI,YAAY,CAAC,EAAE,GAAE,CAAC,CAAC,IAAI,CAAmB,GAAG,CAAC;IAIrD;;;;OAIG;YACW,KAAK;IAQnB;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ;IAIhB;;;;;;OAMG;IACG,SAAS,CACb,KAAK,SAAK,EACV,MAAM,SAAI,EACV,OAAO,CAAC,EAAE,CAAC,GACV,OAAO,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAsBjC;;;;;OAKG;IACG,YAAY,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAY3C;;;;OAIG;IACG,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAW/C;;;;;;OAMG;IACG,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAc9D;;;;;OAKG;IACG,UAAU,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAczC;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;OAEG;IACI,KAAK,IAAI,IAAI;IAIpB;;;OAGG;IACI,OAAO,IAAI,SAAS,CAAC,EAAE;IAI9B;;;;OAIG;IACI,OAAO,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS;CAG3C"}

package/dist/FakeRestApi/factor.d.ts

@@ -0,0 +1,25 @@
+import { FakeRestApi } from './class';
+import { FakeItem, FakeRestApiOptions } from './types';
+/**
+ * Factory function to create a new FakeRestApi instance.
+ * @template T - The type of items to manage, must extend FakeItem
+ * @template F - The type of filters to apply when listing items
+ * @param options - Configuration options for the API
+ * @returns A new FakeRestApi instance
+ * @example
+ * ```typescript
+ * type User = { id: number; name: string; email: string }
+ *
+ * const api = createFakeRestApi<User>({
+ *   name: 'users',
+ *   maxCount: 50,
+ *   generatorFn: (id) => ({
+ *     id,
+ *     name: `User ${id}`,
+ *     email: `user${id}@example.com`
+ *   })
+ * })
+ * ```
+ */
+export declare function createFakeRestApi<T extends FakeItem, F = Record<string, unknown>>(options: FakeRestApiOptions<T, F>): FakeRestApi<T, F>;
+//# sourceMappingURL=factor.d.ts.map

package/dist/FakeRestApi/factor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"factor.d.ts","sourceRoot":"","sources":["../../src/FakeRestApi/factor.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,SAAS,CAAA;AACrC,OAAO,EAAE,QAAQ,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/E,OAAO,EAAE,kBAAkB,CAAC,CAAC,EAAE,CAAC,CAAC,GAChC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,CAEnB"}

package/dist/FakeRestApi/index.d.ts

@@ -0,0 +1,4 @@
+export * from './factor';
+export * from './class';
+export type { FakeRestApiOptions } from './types';
+//# sourceMappingURL=index.d.ts.map

package/dist/FakeRestApi/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/FakeRestApi/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,SAAS,CAAA;AACvB,YAAY,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA"}

package/dist/FakeRestApi/types.d.ts

@@ -0,0 +1,40 @@
+/**
+ * Represents a basic item with an ID.
+ */
+export type FakeItem = {
+    id: number;
+};
+/**
+ * Represents a paginated response structure.
+ * @template T - The type of items in the results array, must extend FakeItem
+ */
+export type PaginationResponse<T extends FakeItem> = {
+    /** Total count of items */
+    count: number;
+    /** URL for the next page, or null if there are no more pages */
+    next: string | null;
+    /** URL for the previous page, or null if this is the first page */
+    previous: string | null;
+    /** Array of items for the current page */
+    results: T[];
+};
+/**
+ * Configuration options for creating a FakeRestApi instance.
+ * @template T - The type of items to manage, must extend FakeItem
+ * @template F - The type of filters to apply when listing items
+ */
+export type FakeRestApiOptions<T extends FakeItem, F = Record<string, unknown>> = {
+    /** Name of the API (used in URLs and error messages) */
+    name: string;
+    /** Whether to enable artificial delay for requests */
+    enableDelay?: boolean;
+    /** Maximum number of items to generate on initialization */
+    maxCount?: number;
+    /** Delay duration in milliseconds */
+    delayMs?: number;
+    /** Function to generate a new item given an ID */
+    generatorFn: (id: T['id']) => T;
+    /** Optional function to filter items based on criteria */
+    filterFn?: (item: T, filters: F) => boolean;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/FakeRestApi/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/FakeRestApi/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB,EAAE,EAAE,MAAM,CAAA;CACX,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,QAAQ,IAAI;IACnD,2BAA2B;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,gEAAgE;IAChE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IACnB,mEAAmE;IACnE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,0CAA0C;IAC1C,OAAO,EAAE,CAAC,EAAE,CAAA;CACb,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,CAAC,CAAC,SAAS,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI;IAChF,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAA;IACZ,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,kDAAkD;IAClD,WAAW,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IAC/B,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,KAAK,OAAO,CAAA;CAC5C,CAAA"}

package/dist/faker.d.ts

@@ -0,0 +1,17 @@
+declare function number(min?: number, max?: number): number;
+/**
+ * Lightweight fixture-data helper for tests and Storybook stories.
+ * All string generators draw from fixed lists, so output is deterministic
+ * in terms of domain (real-looking names/animals) but random in selection —
+ * not suitable as a seed-based reproducible faker. Use `number(min, max)`
+ * for bounded integers.
+ */
+export declare const faker: {
+    lastName: () => string;
+    firstName: () => string;
+    animal: () => string;
+    number: typeof number;
+    name: () => string;
+};
+export {};
+//# sourceMappingURL=faker.d.ts.map

package/dist/faker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"faker.d.ts","sourceRoot":"","sources":["../src/faker.ts"],"names":[],"mappings":"AAuBA,iBAAS,MAAM,CAAC,GAAG,GAAE,MAAU,EAAE,GAAG,GAAE,MAAY,UAEjD;AAED;;;;;;GAMG;AACH,eAAO,MAAM,KAAK;;;;;;CAMjB,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './FakeRestApi';
+export * from './EnvironmentManager';
+export * from './faker';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,sBAAsB,CAAA;AACpC,cAAc,SAAS,CAAA"}

package/package.json

@@ -1,7 +1,20 @@
 {
   "name": "@codeleap/debug",
-  "version": "6.3.0",
+  "version": "6.8.0",
   "main": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
   "license": "UNLICENSED",
   "repository": {
     "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
@@ -9,13 +22,21 @@
     "directory": "packages/debug"
   },
   "devDependencies": {
-    "@codeleap/config": "6.3.0",
+    "@codeleap/config": "6.8.0",
+    "@codeleap/store": "6.8.0",
+    "@codeleap/types": "6.8.0",
+    "@codeleap/utils": "6.8.0",
     "ts-node-dev": "1.1.8"
   },
   "scripts": {
-    "build": "echo 'No build needed'"
+    "build": "tsc --build tsconfig.build.json",
+    "typecheck": "bun tsc --noEmit -p ./tsconfig.json"
   },
   "peerDependencies": {
-    "typescript": "5.5.2"
+    "typescript": "5.5.2",
+    "@codeleap/config": "6.8.0",
+    "@codeleap/store": "6.8.0",
+    "@codeleap/types": "6.8.0",
+    "@codeleap/utils": "6.8.0"
   }
-}
+}

package/src/EnvironmentManager/class.ts

@@ -5,6 +5,19 @@ import { useState, useMemo } from 'react'
 import { EnvironmentStore, EnvironmentManagerConfig, Editor } from './types'
 import { EDITORS } from './const'
 
+/**
+ * Runtime switchboard for backend environments in debug builds.
+ *
+ * The override is opt-in: until `setEnabled` is called the manager always
+ * returns `defaultEnvironment`, making it safe to instantiate unconditionally.
+ * State is persisted via `@codeleap/store` `globalState` so it survives page
+ * reloads, but the `enabledBy` flag gates whether that persisted state is
+ * actually honoured.
+ *
+ * When the active environment is `customEnvironment`, `serverUrl` validates the
+ * stored URL against a strict regex and falls back to `defaultEnvironment` if
+ * it fails — callers can rely on `serverUrl` always returning a usable value.
+ */
 export class EnvironmentManager<T extends StringRecord> {
   private store: ReturnType<typeof globalState<EnvironmentStore<T>>>
 
@@ -33,7 +46,8 @@ export class EnvironmentManager<T extends StringRecord> {
     this.initialStoreValue = this.store.get()
   }
 
-  testUrl(url: string) {
+  testUrl(url: string | undefined) {
+    if (!url) return false
     const urlValidator: RegExp = /^https?:\/\/([a-zA-Z0-9.-]+|localhost|(\d{1,3}\.){3}\d{1,3})(?::\d+)?\/$/
     return urlValidator.test(url)
   }

package/src/EnvironmentManager/const.ts

@@ -1,3 +1,8 @@
+/**
+ * Identifies who enabled the environment override — the application itself
+ * (`SYSTEM`) or an end user via a debug UI (`USER`). Used to gate which
+ * controls are exposed and whether the override survives a session reset.
+ */
 export const EDITORS = {
   SYSTEM: 'system',
   USER: 'user',

package/src/EnvironmentManager/factor.ts

@@ -2,6 +2,11 @@ import { StringRecord } from '@codeleap/types'
 import { EnvironmentManager } from './class'
 import { EnvironmentManagerConfig } from './types'
 
+/**
+ * Preferred entry point for instantiating an `EnvironmentManager`.
+ * Keeps call-sites free of the generic `new` syntax and makes the config
+ * shape the only public API surface that needs to be imported.
+ */
 export function createEnvironmentManager<T extends StringRecord>(config: EnvironmentManagerConfig<T>) {
   return new EnvironmentManager<T>(config)
 }

package/src/EnvironmentManager/types.ts

@@ -1,8 +1,15 @@
 import { Keyof, StringRecord, ValueOf } from '@codeleap/types'
 import { EDITORS } from './const'
 
+/** `null` means the override is disabled; a non-null value identifies who enabled it. */
 export type Editor = ValueOf<typeof EDITORS> | null
 
+/**
+ * `customEnvironment` names the key whose URL is taken from `EnvironmentStore.customUrl`
+ * rather than the `environments` map, so it must exist as a key in `T` even though its
+ * map value is ignored at runtime. `persistKey` controls the localStorage slot;
+ * omitting it falls back to `'environment-manager'`.
+ */
 export type EnvironmentManagerConfig<T extends StringRecord> = {
   environments: T
   defaultEnvironment: Keyof<T>
@@ -10,8 +17,13 @@ export type EnvironmentManagerConfig<T extends StringRecord> = {
   persistKey?: string
 }
 
+/**
+ * Persisted slice of debug state. When `enabledBy` is `null` the manager
+ * ignores `environment` and `customUrl` entirely, returning the default config
+ * instead — so the store being populated does not mean the override is active.
+ */
 export type EnvironmentStore<T extends StringRecord> = {
   environment: Keyof<T>
-  customUrl?: string
+  customUrl: string
   enabledBy: Editor
 }

package/src/faker.ts

@@ -25,6 +25,13 @@ function number(min: number = 0, max: number = 100) {
   return Math.floor(Math.random() * (max - min + 1)) + min
 }
 
+/**
+ * Lightweight fixture-data helper for tests and Storybook stories.
+ * All string generators draw from fixed lists, so output is deterministic
+ * in terms of domain (real-looking names/animals) but random in selection —
+ * not suitable as a seed-based reproducible faker. Use `number(min, max)`
+ * for bounded integers.
+ */
 export const faker = {
   lastName: () => getRandom(surnames),
   firstName: () => getRandom(names),

package/package.json.bak

@@ -1,21 +0,0 @@
-{
-  "name": "@codeleap/debug",
-  "version": "6.3.0",
-  "main": "src/index.ts",
-  "license": "UNLICENSED",
-  "repository": {
-    "url": "https://github.com/codeleap-uk/internal-libs-monorepo.git",
-    "type": "git",
-    "directory": "packages/debug"
-  },
-  "devDependencies": {
-    "@codeleap/config": "workspace:*",
-    "ts-node-dev": "1.1.8"
-  },
-  "scripts": {
-    "build": "echo 'No build needed'"
-  },
-  "peerDependencies": {
-    "typescript": "5.5.2"
-  }
-}