@flopflip/types - npm Package Compare versions

Comparing version 2.5.0 to 2.5.1-next.18

dist/typings/index.d.ts

 /// <reference types="react" />
 import { LDClient as TLDClient } from 'launchdarkly-js-client-sdk';
+import { DeepReadonly } from 'ts-essentials';
 export declare type TFlagName = string;
@@ -35,4 +36,4 @@ export declare type TFlagVariation = boolean | string;
 export declare type TAdapterEventHandlers = {
-    onFlagsStateChange: (flags: TFlagsChange) => void;
-    onStatusStateChange: (status: TAdapterStatusChange) => void;
+    onFlagsStateChange: (flags: Readonly<TFlagsChange>) => void;
+    onStatusStateChange: (status: Readonly<TAdapterStatusChange>) => void;
 };
@@ -52,6 +53,7 @@ export declare type TBaseAdapterArgs = {
 };
+export declare type TLocalStorageAdapterSubscriptionOptions = {
+    pollingInteral?: number;
+};
 export declare type TLocalStorageAdapterArgs = TBaseAdapterArgs & {
-    adapterConfiguration?: {
-        pollingInteral?: number;
-    };
+    adapterConfiguration?: TLocalStorageAdapterSubscriptionOptions;
 };
@@ -81,4 +83,4 @@ export declare type TMemoryAdapterArgs = TBaseAdapterArgs;
     id: TAdapterInterfaceIdentifiers;
-    configure(adapterArgs: Args, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
-    reconfigure(adapterArgs: Args, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
+    configure(adapterArgs: DeepReadonly<Args>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
+    reconfigure(adapterArgs: DeepReadonly<Args>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
     getIsConfigurationStatus(configurationStatus: TAdapterConfigurationStatus): boolean;
@@ -94,8 +96,8 @@ setConfigurationStatus?(nextConfigurationStatus: TAdapterConfigurationStatus): void;
     id: typeof interfaceIdentifiers.launchdarkly;
-    configure(adapterArgs: TLaunchDarklyAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
-    reconfigure(adapterArgs: TLaunchDarklyAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
+    configure(adapterArgs: DeepReadonly<TLaunchDarklyAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
+    reconfigure(adapterArgs: DeepReadonly<TLaunchDarklyAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
     getIsConfigurationStatus(adapterConfigurationStatus: TAdapterConfigurationStatus): boolean;
     getClient(): TLDClient | undefined;
     getFlag(flagName: TFlagName): TFlagVariation | undefined;
-    updateUserContext(updatedUserProps: TUser): Promise<unknown>;
+    updateUserContext(updatedUserProps: Readonly<TUser>): Promise<unknown>;
     unsubscribe(): void;
@@ -106,4 +108,4 @@ subscribe(): void;
     id: typeof interfaceIdentifiers.localstorage;
-    configure(adapterArgs: TLocalStorageAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
-    reconfigure(adapterArgs: TLocalStorageAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
+    configure(adapterArgs: DeepReadonly<TLocalStorageAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
+    reconfigure(adapterArgs: DeepReadonly<TLocalStorageAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
     getIsConfigurationStatus(adapterConfigurationStatus: TAdapterConfigurationStatus): boolean;
@@ -116,8 +118,8 @@ waitUntilConfigured(): Promise<unknown>;
     id: typeof interfaceIdentifiers.memory;
-    configure(adapterArgs: TMemoryAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
-    reconfigure(adapterArgs: TMemoryAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
+    configure(adapterArgs: DeepReadonly<TMemoryAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
+    reconfigure(adapterArgs: DeepReadonly<TMemoryAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
     getIsConfigurationStatus(adapterConfigurationStatus: TAdapterConfigurationStatus): boolean;
     waitUntilConfigured(): Promise<unknown>;
     reset(): void;
-    updateFlags(flags: TFlags): void;
+    updateFlags(flags: Readonly<TFlags>): void;
     unsubscribe(): void;
@@ -128,4 +130,4 @@ subscribe(): void;
     id: typeof interfaceIdentifiers.splitio;
-    configure(adapterArgs: TSplitioAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
-    reconfigure(adapterArgs: TSplitioAdapterArgs, adapterEventHandlers: TAdapterEventHandlers): Promise<TAdapterConfiguration>;
+    configure(adapterArgs: DeepReadonly<TSplitioAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
+    reconfigure(adapterArgs: DeepReadonly<TSplitioAdapterArgs>, adapterEventHandlers: DeepReadonly<TAdapterEventHandlers>): Promise<TAdapterConfiguration>;
     getIsConfigurationStatus(adapterConfigurationStatus: TAdapterConfigurationStatus): boolean;
@@ -141,4 +143,4 @@ unsubscribe(): void;
 };
-export declare type TOnFlagsStateChangeCallback = (flags: TFlags) => void;
-export declare type TOnStatusStateChangeCallback = (statusChange: TAdapterStatusChange) => void;
+export declare type TOnFlagsStateChangeCallback = (flags: Readonly<TFlags>) => void;
+export declare type TOnStatusStateChangeCallback = (statusChange: Readonly<TAdapterStatusChange>) => void;
 export declare type TAdapterReconfigurationOptions = {
@@ -155,5 +157,5 @@ shouldOverwrite?: boolean;
 };
-export declare type TConfigureAdapterChildrenAsFunction = (args: TConfigureAdapterChildrenAsFunctionArgs) => React.ReactNode;
+export declare type TConfigureAdapterChildrenAsFunction = (args: Readonly<TConfigureAdapterChildrenAsFunctionArgs>) => React.ReactNode;
 export declare type TConfigureAdapterChildren = TConfigureAdapterChildrenAsFunction | React.ReactNode;
-export declare type TReconfigureAdapter = (adapterArgs: TAdapterArgs, options: TAdapterReconfigurationOptions) => void;
+export declare type TReconfigureAdapter = (adapterArgs: TAdapterArgs, options: Readonly<TAdapterReconfigurationOptions>) => void;
 export declare type TAdapterContext = {
@@ -160,0 +162,0 @@ reconfigure: TReconfigureAdapter;

package.json

 {
   "name": "@flopflip/types",
-  "version": "2.5.0",
+  "version": "2.5.1-next.18+da8f684",
   "description": "Type definitions for flipflop",
@@ -39,3 +39,3 @@ "main": "dist/@flopflip-types.cjs.js",
   ],
-  "gitHead": "31510732f88ed3792bd52f1d0282674effc7b5bf"
+  "gitHead": "da8f6848861ca686fcd929822275ff56e3faffb2"
 }

New alerts

Manifest confusion

Supply chain risk

This package has inconsistent metadata. This could be malicious or caused by an error when publishing the package.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

32372

increased by4.91%

Lines of code

205

increased by0.99%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes