@ondewo/nlu-client-typescript 6.14.0 → 7.0.0

package/api/ondewo/nlu/user_pb.js

@@ -56,8 +56,6 @@ goog.exportSymbol('proto.ondewo.nlu.ListUserPreferencesRequest', null, global);
 goog.exportSymbol('proto.ondewo.nlu.ListUserPreferencesResponse', null, global);
 goog.exportSymbol('proto.ondewo.nlu.ListUsersRequest', null, global);
 goog.exportSymbol('proto.ondewo.nlu.ListUsersResponse', null, global);
-goog.exportSymbol('proto.ondewo.nlu.LoginRequest', null, global);
-goog.exportSymbol('proto.ondewo.nlu.LoginResponse', null, global);
 goog.exportSymbol('proto.ondewo.nlu.ServerRole', null, global);
 goog.exportSymbol('proto.ondewo.nlu.SetUserPreferencesRequest', null, global);
 goog.exportSymbol('proto.ondewo.nlu.SetUserPreferencesResponse', null, global);
@@ -443,48 +441,6 @@ if (goog.DEBUG && !COMPILED) {
    */
   proto.ondewo.nlu.ListServerPermissionsResponse.displayName = 'proto.ondewo.nlu.ListServerPermissionsResponse';
 }
-/**
- * Generated by JsPbCodeGenerator.
- * @param {Array=} opt_data Optional initial data array, typically from a
- * server response, or constructed directly in Javascript. The array is used
- * in place and becomes part of the constructed object. It is not cloned.
- * If no data is provided, the constructed object will be empty, but still
- * valid.
- * @extends {jspb.Message}
- * @constructor
- */
-proto.ondewo.nlu.LoginRequest = function(opt_data) {
-  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
-};
-goog.inherits(proto.ondewo.nlu.LoginRequest, jspb.Message);
-if (goog.DEBUG && !COMPILED) {
-  /**
-   * @public
-   * @override
-   */
-  proto.ondewo.nlu.LoginRequest.displayName = 'proto.ondewo.nlu.LoginRequest';
-}
-/**
- * Generated by JsPbCodeGenerator.
- * @param {Array=} opt_data Optional initial data array, typically from a
- * server response, or constructed directly in Javascript. The array is used
- * in place and becomes part of the constructed object. It is not cloned.
- * If no data is provided, the constructed object will be empty, but still
- * valid.
- * @extends {jspb.Message}
- * @constructor
- */
-proto.ondewo.nlu.LoginResponse = function(opt_data) {
-  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
-};
-goog.inherits(proto.ondewo.nlu.LoginResponse, jspb.Message);
-if (goog.DEBUG && !COMPILED) {
-  /**
-   * @public
-   * @override
-   */
-  proto.ondewo.nlu.LoginResponse.displayName = 'proto.ondewo.nlu.LoginResponse';
-}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -4545,398 +4501,6 @@ proto.ondewo.nlu.ListServerPermissionsResponse.prototype.setNextPageToken = func
 
 
 
-
-
-if (jspb.Message.GENERATE_TO_OBJECT) {
-/**
- * Creates an object representation of this proto.
- * Field names that are reserved in JavaScript and will be renamed to pb_name.
- * Optional fields that are not set will be set to undefined.
- * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
- * For the list of reserved names please see:
- *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
- * @param {boolean=} opt_includeInstance Deprecated. whether to include the
- *     JSPB instance for transitional soy proto support:
- *     http://goto/soy-param-migration
- * @return {!Object}
- */
-proto.ondewo.nlu.LoginRequest.prototype.toObject = function(opt_includeInstance) {
-  return proto.ondewo.nlu.LoginRequest.toObject(opt_includeInstance, this);
-};
-
-
-/**
- * Static version of the {@see toObject} method.
- * @param {boolean|undefined} includeInstance Deprecated. Whether to include
- *     the JSPB instance for transitional soy proto support:
- *     http://goto/soy-param-migration
- * @param {!proto.ondewo.nlu.LoginRequest} msg The msg instance to transform.
- * @return {!Object}
- * @suppress {unusedLocalVariables} f is only used for nested messages
- */
-proto.ondewo.nlu.LoginRequest.toObject = function(includeInstance, msg) {
-  var f, obj = {
-userEmail: jspb.Message.getFieldWithDefault(msg, 1, ""),
-password: jspb.Message.getFieldWithDefault(msg, 2, ""),
-fieldMask: (f = msg.getFieldMask()) && google_protobuf_field_mask_pb.FieldMask.toObject(includeInstance, f)
-  };
-
-  if (includeInstance) {
-    obj.$jspbMessageInstance = msg;
-  }
-  return obj;
-};
-}
-
-
-/**
- * Deserializes binary data (in protobuf wire format).
- * @param {jspb.ByteSource} bytes The bytes to deserialize.
- * @return {!proto.ondewo.nlu.LoginRequest}
- */
-proto.ondewo.nlu.LoginRequest.deserializeBinary = function(bytes) {
-  var reader = new jspb.BinaryReader(bytes);
-  var msg = new proto.ondewo.nlu.LoginRequest;
-  return proto.ondewo.nlu.LoginRequest.deserializeBinaryFromReader(msg, reader);
-};
-
-
-/**
- * Deserializes binary data (in protobuf wire format) from the
- * given reader into the given message object.
- * @param {!proto.ondewo.nlu.LoginRequest} msg The message object to deserialize into.
- * @param {!jspb.BinaryReader} reader The BinaryReader to use.
- * @return {!proto.ondewo.nlu.LoginRequest}
- */
-proto.ondewo.nlu.LoginRequest.deserializeBinaryFromReader = function(msg, reader) {
-  while (reader.nextField()) {
-    if (reader.isEndGroup()) {
-      break;
-    }
-    var field = reader.getFieldNumber();
-    switch (field) {
-    case 1:
-      var value = /** @type {string} */ (reader.readString());
-      msg.setUserEmail(value);
-      break;
-    case 2:
-      var value = /** @type {string} */ (reader.readString());
-      msg.setPassword(value);
-      break;
-    case 3:
-      var value = new google_protobuf_field_mask_pb.FieldMask;
-      reader.readMessage(value,google_protobuf_field_mask_pb.FieldMask.deserializeBinaryFromReader);
-      msg.setFieldMask(value);
-      break;
-    default:
-      reader.skipField();
-      break;
-    }
-  }
-  return msg;
-};
-
-
-/**
- * Serializes the message to binary data (in protobuf wire format).
- * @return {!Uint8Array}
- */
-proto.ondewo.nlu.LoginRequest.prototype.serializeBinary = function() {
-  var writer = new jspb.BinaryWriter();
-  proto.ondewo.nlu.LoginRequest.serializeBinaryToWriter(this, writer);
-  return writer.getResultBuffer();
-};
-
-
-/**
- * Serializes the given message to binary data (in protobuf wire
- * format), writing to the given BinaryWriter.
- * @param {!proto.ondewo.nlu.LoginRequest} message
- * @param {!jspb.BinaryWriter} writer
- * @suppress {unusedLocalVariables} f is only used for nested messages
- */
-proto.ondewo.nlu.LoginRequest.serializeBinaryToWriter = function(message, writer) {
-  var f = undefined;
-  f = message.getUserEmail();
-  if (f.length > 0) {
-    writer.writeString(
-      1,
-      f
-    );
-  }
-  f = message.getPassword();
-  if (f.length > 0) {
-    writer.writeString(
-      2,
-      f
-    );
-  }
-  f = message.getFieldMask();
-  if (f != null) {
-    writer.writeMessage(
-      3,
-      f,
-      google_protobuf_field_mask_pb.FieldMask.serializeBinaryToWriter
-    );
-  }
-};
-
-
-/**
- * optional string user_email = 1;
- * @return {string}
- */
-proto.ondewo.nlu.LoginRequest.prototype.getUserEmail = function() {
-  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
-};
-
-
-/**
- * @param {string} value
- * @return {!proto.ondewo.nlu.LoginRequest} returns this
- */
-proto.ondewo.nlu.LoginRequest.prototype.setUserEmail = function(value) {
-  return jspb.Message.setProto3StringField(this, 1, value);
-};
-
-
-/**
- * optional string password = 2;
- * @return {string}
- */
-proto.ondewo.nlu.LoginRequest.prototype.getPassword = function() {
-  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 2, ""));
-};
-
-
-/**
- * @param {string} value
- * @return {!proto.ondewo.nlu.LoginRequest} returns this
- */
-proto.ondewo.nlu.LoginRequest.prototype.setPassword = function(value) {
-  return jspb.Message.setProto3StringField(this, 2, value);
-};
-
-
-/**
- * optional google.protobuf.FieldMask field_mask = 3;
- * @return {?proto.google.protobuf.FieldMask}
- */
-proto.ondewo.nlu.LoginRequest.prototype.getFieldMask = function() {
-  return /** @type{?proto.google.protobuf.FieldMask} */ (
-    jspb.Message.getWrapperField(this, google_protobuf_field_mask_pb.FieldMask, 3));
-};
-
-
-/**
- * @param {?proto.google.protobuf.FieldMask|undefined} value
- * @return {!proto.ondewo.nlu.LoginRequest} returns this
-*/
-proto.ondewo.nlu.LoginRequest.prototype.setFieldMask = function(value) {
-  return jspb.Message.setWrapperField(this, 3, value);
-};
-
-
-/**
- * Clears the message field making it undefined.
- * @return {!proto.ondewo.nlu.LoginRequest} returns this
- */
-proto.ondewo.nlu.LoginRequest.prototype.clearFieldMask = function() {
-  return this.setFieldMask(undefined);
-};
-
-
-/**
- * Returns whether this field is set.
- * @return {boolean}
- */
-proto.ondewo.nlu.LoginRequest.prototype.hasFieldMask = function() {
-  return jspb.Message.getField(this, 3) != null;
-};
-
-
-
-
-
-if (jspb.Message.GENERATE_TO_OBJECT) {
-/**
- * Creates an object representation of this proto.
- * Field names that are reserved in JavaScript and will be renamed to pb_name.
- * Optional fields that are not set will be set to undefined.
- * To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
- * For the list of reserved names please see:
- *     net/proto2/compiler/js/internal/generator.cc#kKeyword.
- * @param {boolean=} opt_includeInstance Deprecated. whether to include the
- *     JSPB instance for transitional soy proto support:
- *     http://goto/soy-param-migration
- * @return {!Object}
- */
-proto.ondewo.nlu.LoginResponse.prototype.toObject = function(opt_includeInstance) {
-  return proto.ondewo.nlu.LoginResponse.toObject(opt_includeInstance, this);
-};
-
-
-/**
- * Static version of the {@see toObject} method.
- * @param {boolean|undefined} includeInstance Deprecated. Whether to include
- *     the JSPB instance for transitional soy proto support:
- *     http://goto/soy-param-migration
- * @param {!proto.ondewo.nlu.LoginResponse} msg The msg instance to transform.
- * @return {!Object}
- * @suppress {unusedLocalVariables} f is only used for nested messages
- */
-proto.ondewo.nlu.LoginResponse.toObject = function(includeInstance, msg) {
-  var f, obj = {
-user: (f = msg.getUser()) && proto.ondewo.nlu.User.toObject(includeInstance, f),
-authToken: jspb.Message.getFieldWithDefault(msg, 2, "")
-  };
-
-  if (includeInstance) {
-    obj.$jspbMessageInstance = msg;
-  }
-  return obj;
-};
-}
-
-
-/**
- * Deserializes binary data (in protobuf wire format).
- * @param {jspb.ByteSource} bytes The bytes to deserialize.
- * @return {!proto.ondewo.nlu.LoginResponse}
- */
-proto.ondewo.nlu.LoginResponse.deserializeBinary = function(bytes) {
-  var reader = new jspb.BinaryReader(bytes);
-  var msg = new proto.ondewo.nlu.LoginResponse;
-  return proto.ondewo.nlu.LoginResponse.deserializeBinaryFromReader(msg, reader);
-};
-
-
-/**
- * Deserializes binary data (in protobuf wire format) from the
- * given reader into the given message object.
- * @param {!proto.ondewo.nlu.LoginResponse} msg The message object to deserialize into.
- * @param {!jspb.BinaryReader} reader The BinaryReader to use.
- * @return {!proto.ondewo.nlu.LoginResponse}
- */
-proto.ondewo.nlu.LoginResponse.deserializeBinaryFromReader = function(msg, reader) {
-  while (reader.nextField()) {
-    if (reader.isEndGroup()) {
-      break;
-    }
-    var field = reader.getFieldNumber();
-    switch (field) {
-    case 1:
-      var value = new proto.ondewo.nlu.User;
-      reader.readMessage(value,proto.ondewo.nlu.User.deserializeBinaryFromReader);
-      msg.setUser(value);
-      break;
-    case 2:
-      var value = /** @type {string} */ (reader.readString());
-      msg.setAuthToken(value);
-      break;
-    default:
-      reader.skipField();
-      break;
-    }
-  }
-  return msg;
-};
-
-
-/**
- * Serializes the message to binary data (in protobuf wire format).
- * @return {!Uint8Array}
- */
-proto.ondewo.nlu.LoginResponse.prototype.serializeBinary = function() {
-  var writer = new jspb.BinaryWriter();
-  proto.ondewo.nlu.LoginResponse.serializeBinaryToWriter(this, writer);
-  return writer.getResultBuffer();
-};
-
-
-/**
- * Serializes the given message to binary data (in protobuf wire
- * format), writing to the given BinaryWriter.
- * @param {!proto.ondewo.nlu.LoginResponse} message
- * @param {!jspb.BinaryWriter} writer
- * @suppress {unusedLocalVariables} f is only used for nested messages
- */
-proto.ondewo.nlu.LoginResponse.serializeBinaryToWriter = function(message, writer) {
-  var f = undefined;
-  f = message.getUser();
-  if (f != null) {
-    writer.writeMessage(
-      1,
-      f,
-      proto.ondewo.nlu.User.serializeBinaryToWriter
-    );
-  }
-  f = message.getAuthToken();
-  if (f.length > 0) {
-    writer.writeString(
-      2,
-      f
-    );
-  }
-};
-
-
-/**
- * optional User user = 1;
- * @return {?proto.ondewo.nlu.User}
- */
-proto.ondewo.nlu.LoginResponse.prototype.getUser = function() {
-  return /** @type{?proto.ondewo.nlu.User} */ (
-    jspb.Message.getWrapperField(this, proto.ondewo.nlu.User, 1));
-};
-
-
-/**
- * @param {?proto.ondewo.nlu.User|undefined} value
- * @return {!proto.ondewo.nlu.LoginResponse} returns this
-*/
-proto.ondewo.nlu.LoginResponse.prototype.setUser = function(value) {
-  return jspb.Message.setWrapperField(this, 1, value);
-};
-
-
-/**
- * Clears the message field making it undefined.
- * @return {!proto.ondewo.nlu.LoginResponse} returns this
- */
-proto.ondewo.nlu.LoginResponse.prototype.clearUser = function() {
-  return this.setUser(undefined);
-};
-
-
-/**
- * Returns whether this field is set.
- * @return {boolean}
- */
-proto.ondewo.nlu.LoginResponse.prototype.hasUser = function() {
-  return jspb.Message.getField(this, 1) != null;
-};
-
-
-/**
- * optional string auth_token = 2;
- * @return {string}
- */
-proto.ondewo.nlu.LoginResponse.prototype.getAuthToken = function() {
-  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 2, ""));
-};
-
-
-/**
- * @param {string} value
- * @return {!proto.ondewo.nlu.LoginResponse} returns this
- */
-proto.ondewo.nlu.LoginResponse.prototype.setAuthToken = function(value) {
-  return jspb.Message.setProto3StringField(this, 2, value);
-};
-
-
-
 /**
  * List of repeated fields within this message type.
  * @private {!Array<number>}

package/auth/offlineTokenProvider.d.ts

@@ -63,10 +63,16 @@ export interface OfflineTokenLoginOptions {
     /** Optional clock override returning epoch ms (tests); defaults to Date.now. */
     nowInMs?: () => number;
 }
-/** Error raised on any token-endpoint or token-shape failure. */
+/**
+ * Error raised on any token-endpoint or token-shape failure.
+ *
+ * Name contract: every instance carries `name === "TokenError"` (set in the constructor, because
+ * subclassing `Error` does not propagate the subclass name). Callers may therefore discriminate on
+ * `error.name` as well as on `instanceof TokenError` -- the latter being unreliable across bundles.
+ */
 export declare class TokenError extends Error {
     /**
-     * Construct a token error.
+     * Construct a token error and pin its `name` to `"TokenError"`.
      *
      * @param message - Human-readable description of the token failure.
      */
@@ -97,7 +103,10 @@ export declare class OfflineTokenProvider {
     private readonly fetchImpl;
     /** Epoch-ms clock (injectable for deterministic tests; defaults to `Date.now`). */
     private readonly nowInMs;
-    /** The current access token, or `null` before bootstrap / after the loop has lapsed. */
+    /**
+     * The current access token, or `null` until {@link bootstrap} has completed. It is NEVER reset to
+     * `null` afterwards: neither {@link stop} nor the bounded deadline clears it.
+     */
     private accessToken;
     /** The current offline refresh token, or `null` before bootstrap. */
     private refreshToken;
@@ -149,17 +158,28 @@ export declare class OfflineTokenProvider {
     /**
      * Read the current access token.
      *
-     * @returns The current access token, or `null` before bootstrap / after the bounded loop has lapsed.
+     * Once {@link bootstrap} has succeeded this never returns `null` again: when the bounded refresh
+     * loop lapses (or {@link stop} is called) the LAST fetched token keeps being returned even though
+     * it is by then expiring/expired. Callers must treat an `UNAUTHENTICATED` gRPC response -- not a
+     * `null` here -- as the signal to re-login.
+     *
+     * @returns The current access token, or `null` before {@link bootstrap} has completed.
      */
     getAccessToken(): string | null;
     /**
      * Build the value for an `Authorization` gRPC metadata header.
      *
      * @returns The `Bearer <access_token>` header value.
-     * @throws {TokenError} When no access token is available (login not completed or already lapsed).
+     * @throws {TokenError} When no access token has been fetched yet, i.e. {@link bootstrap} /
+     *   {@link login} has not completed. It does NOT throw once the refresh loop has lapsed -- see
+     *   {@link getAccessToken}.
      */
     getAuthorizationHeader(): string;
-    /** Stop the auto-refresh loop. Idempotent; safe to call from any state. */
+    /**
+     * Stop the auto-refresh loop. Idempotent; safe to call from any state. It disarms the pending timer
+     * and suppresses further scheduling, but deliberately KEEPS the last access token readable through
+     * {@link getAccessToken} / {@link getAuthorizationHeader}.
+     */
     stop(): void;
 }
 /**