@vertx/auth-common - npm Package Compare versions

Comparing version 3.9.1 to 3.9.2

options.d.ts

@@ -27,2 +27,73 @@ /*
 /**
+ * Options related to creation of new tokens.
+ *
+ * If any expiresInMinutes, audience, subject, issuer are not provided, there is no default.
+ * The jwt generated won't include those properties in the payload.
+ *
+ * Generated JWTs will include an iat claim by default unless noTimestamp is specified.
+ */
+export class JWTOptions {
+
+  constructor();
+
+  constructor(obj: JWTOptions);
+
+  getAlgorithm(): string;
+
+  setAlgorithm(algorithm: string): JWTOptions;
+
+  getAudience(): string;
+
+  setAudience(audience: string): JWTOptions;
+
+  addAudience(audiences: string): JWTOptions;
+
+  setExpiresInMinutes(expiresInMinutes: number): JWTOptions;
+
+  getExpiresInSeconds(): number;
+
+  setExpiresInSeconds(expiresInSeconds: number): JWTOptions;
+
+  getHeader(): { [key: string]: any };
+
+  setHeader(header: { [key: string]: any }): JWTOptions;
+
+  isIgnoreExpiration(): boolean;
+
+  setIgnoreExpiration(ignoreExpiration: boolean): JWTOptions;
+
+  getIssuer(): string;
+
+  setIssuer(issuer: string): JWTOptions;
+
+  getLeeway(): number;
+
+  setLeeway(leeway: number): JWTOptions;
+
+  isNoTimestamp(): boolean;
+
+  setNoTimestamp(noTimestamp: boolean): JWTOptions;
+
+  /**
+   * The permissions of this token.
+   */
+  getPermissions(): string;
+
+  /**
+   * The permissions of this token.
+   */
+  setPermissions(permissions: string): JWTOptions;
+
+  /**
+   * The permissions of this token.
+   */
+  addPermission(permissions: string): JWTOptions;
+
+  getSubject(): string;
+
+  setSubject(subject: string): JWTOptions;
+
+}
+
+/**
  * Options describing how an JWT KeyStore should behave.
@@ -29,0 +100,0 @@ */

options.js

@@ -24,2 +24,3 @@ /*
   AuthOptions: Java.type('io.vertx.ext.auth.AuthOptions'),
+  JWTOptions: Java.type('io.vertx.ext.auth.JWTOptions'),
   KeyStoreOptions: Java.type('io.vertx.ext.auth.KeyStoreOptions'),
@@ -26,0 +27,0 @@ PubSecKeyOptions: Java.type('io.vertx.ext.auth.PubSecKeyOptions'),

package.json

 {
   "name" : "@vertx/auth-common",
   "description" : "Generated Eclipse Vert.x bindings for 'vertx-auth-common'",
-  "version" : "3.9.1",
+  "version" : "3.9.2",
   "license" : "Apache-2.0",
@@ -10,9 +10,9 @@ "public" : true,
     "artifactId" : "vertx-auth-common",
-    "version" : "3.9.1"
+    "version" : "3.9.2"
   },
   "dependencies" : {
-    "@vertx/core" : "3.9.1"
+    "@vertx/core" : "3.9.2"
   },
   "main" : "index.js",
-  "module" : "module.mjs",
+  "module" : "index.mjs",
   "types" : "index.d.ts",
@@ -19,0 +19,0 @@ "sideEffects" : false,

README.md

@@ -14,4 +14,29 @@ ![npm (scoped)](https://img.shields.io/npm/v/@vertx/auth-common.svg)
 
-This is a meta package, meaning that it contains only metadata for the build.
+Import the required `API`/`Enum`/`DataObject` and profit!
 
+```js
+// Base API
+import * as API from '@vertx/auth-common';
+// DataObject's
+import * as OPTIONS from '@vertx/auth-common/options';
+
+// refer to the API docs for specific help...
+
+// your code here!!!
+
+```
+
+## Typescript
+
+This package includes [Typescript](http://www.typescriptlang.org/) typedefinitions and your IDE should find then automatically.
+
+When working in a project you can enable type hinting for the runtime as:
+
+```js
+/// <definition types="es4x" />
+// @ts-check
+
+// your TypeScript code here...
+```
+
 ## Links
@@ -18,0 +43,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

16571

increased by20.21%

Number of package files

9

increased by12.5%

Lines of code

402

increased by18.58%

Number of lines in readme file

45

increased by125%

Dependency changes

• + Added@vertx/core@3.9.2(transitive)

• - Removed@vertx/core@3.9.1(transitive)

• Updated@vertx/core@3.9.2