@configdirector/nextjs-sdk 1.9.2 → 1.10.0

package/dist/client/{types-DA2VZKNX.d.mts → types-De4z0tu4.d.mts}

@@ -40,27 +40,40 @@ type ConfigEvaluation = {
   context?: ConfigDirectorContext;
 };
 /**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
+ * The context to be sent to ConfigDirector: the user or other entity, such as a device or an
+ * organization, that configs are evaluated for. This context will be used for targeting rules
+ * evaluation.
  */
 type ConfigDirectorContext = {
   /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
+   * The context's identifier. This should be a value that uniquely identifies the user or other
+   * entity among contexts of the same {@link kind}.
    * In the case of anonymous users, you could generate a UUID or alternatively not provide
    * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
+   * value is used for segmenting contexts in percentage rollouts, and changes to the {@link id}
+   * could result in the context being assigned to a different percentile.
    */
   id?: string;
   /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
+   * The kind of entity this context represents, such as `user`, `device`, `organization`,
+   * `tenant` or `listing`. You can use any other kind that fits your application. A kind has 1
+   * to 64 characters, using only lowercase letters (`a`-`z`), digits, `-` and `_`. It is used
+   * exactly as given, without trimming or changing its case.
+   *
+   * A context with an invalid kind is ignored as a whole: the SDK logs an error and evaluates
+   * as if no context had been provided.
+   *
+   * @default "user"
+   */
+  kind?: string;
+  /**
+   * The context's display name. This will be shown in the ConfigDirector dashboard and may be
    * used for targeting rules.
    */
   name?: string;
   /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
+   * Any arbitrary traits for the context. They will be shown in the ConfigDirector dashboard
+   * and may be used for targeting rules.
    */
   traits?: {
     [key: string]: unknown;
@@ -126,17 +139,25 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
    * not attempt to re-connect and an error will be logged to the console or the provided
    * logger.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, and the client connects as if no context had been provided.
+   *
+   * @param context The current context to be used for evaluating targeting rules (optional).
    */
   initialize(context?: ConfigDirectorContext): Promise<void>;
   /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
+   * Updates the context and re-evaluates all config and flag values based on the new context.
+   *
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, the previous context is no longer used, and the client connects as if no context had been
+   * provided.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
+   * @param context The current context to be used for evaluating targeting rules (required).
    */
   updateContext(context: ConfigDirectorContext): Promise<void>;
   /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
+   * Returns the current context the client is configured with, or undefined if there is no context,
+   * including after a context with an invalid kind was ignored.
    *
    * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
    * once the underlying connection was successful or timed out, the current context is updated. This is
@@ -217,4 +238,4 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
 }
 //#endregion
 export { ConfigDirectorLoggingLevel as a, ConnectionMode as c, ConfigDirectorLogger as i, ConfigDirectorClient as n, ConfigState as o, ConfigDirectorContext as r, ConfigValueType as s, ClientHooks as t };
-//# sourceMappingURL=types-DA2VZKNX.d.mts.map
+//# sourceMappingURL=types-De4z0tu4.d.mts.map

package/dist/client/types-De4z0tu4.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-De4z0tu4.d.mts","names":[],"sources":["../../../js-client-core/src/Emitter.ts","../../../shared/src/types.ts","../../../js-client-core/src/types.ts"],"mappings":";;KAAK,SAAA;AAAA,KACA,YAAA,GAAe,MAAA,CAAO,SAAA;AAAA,KAEtB,OAAA,uBAA8B,YAAA,qBAAiC,aAAA,KAClE,OAAA,EAAS,aAAA,CAAc,IAAA;AAAA,UAGR,aAAA,uBAAoC,YAAA;EACnD,EAAA,qBAAuB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,EAAS,OAAA,CAAQ,aAAA,EAAe,KAAA;EACnF,GAAA,qBAAwB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,GAAU,OAAA,CAAQ,aAAA,EAAe,KAAA;EACrF,KAAA;AAAA;;;cCVW,cAAA;AAAA,KAUD,UAAA,WAAqB,cAAA;AAAA,KAErB,kBAAA;EAAA,CAAwB,GAAA;AAAA;AAAA,KAExB,eAAA,wCAAuD,kBAAA;AAAA,KAEvD,WAAA;EACV,EAAA;EACA,GAAA;EACA,IAAA,EAAM,UAAA;EACN,KAAA;EACA,OAAA;AAAA;AAAA,KAQU,0BAAA;AAAA,UAEK,oBAAA;EACf,KAAA,CAAM,OAAA,aAAoB,IAAA;EAE1B,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,KAAA,CAAM,OAAA,aAAoB,IAAA;AAAA;AAAA,KAOhB,gBAAA;AAAA,KAUA,gBAAA;EACV,GAAA;EACA,KAAA,EAAO,eAAA;EACP,OAAA;EACA,cAAA;EACA,MAAA,EAAQ,gBAAA;EACR,OAAA,GAAU,qBAAA;AAAA;;;;;;KAOA,qBAAA;ED3DoD;;;;;;;;ECoE9D,EAAA;EDrEsC;;;;;;;;;;;ECkFtC,IAAA;EDjFqF;;;;ECuFrF,IAAA;;;;AAhGF;EAsGE,MAAA;IAAA,CAAY,GAAA;EAAA;EA7FJ;AACV;;;;;AAEA;EAmGE,SAAA;AAAA;AAAA,KAYU,cAAA;;;KCIA,WAAA;EACV,WAAA,GAAc,WAAA,kBAA6B,WAAA;EAC3C,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;EACnD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;AAAA;AAAA,KAGzC,mBAAA;AAAA,KAEA,WAAA,sBAAiC,YAAA,KAAiB,OAAA,EAAS,YAAA,CAAa,MAAA;AAAA,KAExE,YAAA;EACV,cAAA;IAAkB,IAAA;IAAgB,WAAA;EAAA;EAClC,WAAA;IAAe,MAAA,EAAQ,mBAAA;EAAA;EACvB,cAAA;IAAkB,OAAA,EAAS,qBAAA;EAAA;EAC3B,eAAA;IAAmB,UAAA,EAAY,gBAAA;EAAA;EAC/B,eAAA;IAAmB,KAAA,EAAO,KAAA;EAAA;AAAA;AAAA,KAGhB,YAAA,WAAuB,eAAA,KAAoB,OAAA,EAAS,CAAA;;;;;;;;;;UAW/C,oBAAA,SAA6B,aAAA,CAAc,YAAA;EDjG1D;;;;AAOF;;;;;;;;;;;;EC2GE,UAAA,CAAW,OAAA,GAAU,qBAAA,GAAwB,OAAA;EDpDrB;;;;;;;ACI1B;;EA2DE,aAAA,CAAc,OAAA,EAAS,qBAAA,GAAwB,OAAA;EA1DjC;;;;;;;;;EAAA,IAqEV,OAAA,IAAW,qBAAA;EAjE+C;;;;;;EAAA,IAyE1D,OAAA;EA5E6C;;;;;;;EAAA,IAqF7C,cAAA;EAlFc;;;;AAGpB;;;;;EA0FE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,GAAI,CAAA;EAxFpD;;;;;;;;;;;EAqGrB,KAAA,WAAgB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,QAAA,EAAU,YAAA,CAAa,CAAA;EArGH;;AAE3F;;;;;;EA6GE,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAxG/C;;;EA6G/B,UAAA;EAjHkC;;;;;;;EA0HlC,YAAA;EAvHmB;;;;EA6HnB,aAAA,IAAiB,OAAA;EA5Hc;;AAGjC;;;;EAiIE,OAAA;AAAA"}