@openfga/sdk - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

CHANGELOG.md

 # Changelog
 
+## v0.5.0
+
+### [0.5.0](https://github.com/openfga/js-sdk/compare/v0.4.0...v0.5.0) (2024-06-14)
+- chore!: remove excluded users from ListUsers response
+
+BREAKING CHANGE:
+
+This version removes the `excluded_users` property from the `ListUsersResponse` and `ClientListUsersResponse` interfaces,
+for more details see the [associated API change](https://github.com/openfga/api/pull/171).
+
 ## v0.4.0
@@ -4,0 +14,0 @@

dist/apiModel.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -687,3 +687,3 @@ * Documentation: https://openfga.dev/docs
     /**
-     *
+     * The type of results returned. Only accepts exactly one value.
      * @type {Array<UserTypeFilter>}
@@ -718,8 +718,2 @@ * @memberof ListUsersRequest
     users: Array<User>;
-    /**
-     *
-     * @type {Array<ObjectOrUserset>}
-     * @memberof ListUsersResponse
-     */
-    excluded_users: Array<ObjectOrUserset>;
 }
@@ -825,21 +819,2 @@ /**
  * @export
- * @interface ObjectOrUserset
- */
-export interface ObjectOrUserset {
-    /**
-     *
-     * @type {FgaObject}
-     * @memberof ObjectOrUserset
-     */
-    object?: FgaObject;
-    /**
-     *
-     * @type {UsersetUser}
-     * @memberof ObjectOrUserset
-     */
-    userset?: UsersetUser;
-}
-/**
- *
- * @export
  * @interface ObjectRelation
@@ -1344,3 +1319,3 @@ */
 /**
- *
+ * Type bound public access.  Normally represented using the `<type>:*` syntax  `employee:*` represents every object of type `employee`, including those not currently present in the system  See https://openfga.dev/docs/concepts#what-is-type-bound-public-access
  * @export
@@ -1360,2 +1335,21 @@ * @interface TypedWildcard
  * @export
+ * @interface UnauthenticatedResponse
+ */
+export interface UnauthenticatedResponse {
+    /**
+     *
+     * @type {ErrorCode}
+     * @memberof UnauthenticatedResponse
+     */
+    code?: ErrorCode;
+    /**
+     *
+     * @type {string}
+     * @memberof UnauthenticatedResponse
+     */
+    message?: string;
+}
+/**
+ *
+ * @export
  * @enum {string}
@@ -1387,3 +1381,3 @@ */
 /**
- *
+ * User.  Represents any possible value for a user (subject or principal). Can be a: - Specific user object e.g.: \'user:will\', \'folder:marketing\', \'org:contoso\', ...) - Specific userset (e.g. \'group:engineering#member\') - Public-typed wildcard (e.g. \'user:*\')  See https://openfga.dev/docs/concepts#what-is-a-user
  * @export
@@ -1539,3 +1533,3 @@ * @interface User
 /**
- *
+ * Userset.  A set or group of users, represented in the `<type>:<id>#<relation>` format  `group:fga#member` represents all members of group FGA, not to be confused by `group:fga` which represents the group itself as a specific object.  See: https://openfga.dev/docs/modeling/building-blocks/usersets#what-is-a-userset
  * @export
@@ -1542,0 +1536,0 @@ * @interface UsersetUser

dist/apiModel.js

@@ -7,3 +7,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -10,0 +10,0 @@ * Documentation: https://openfga.dev/docs

dist/base.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/base.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/client.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/client.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/common.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/common.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/configuration.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/configuration.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -23,3 +23,3 @@ * Documentation: https://openfga.dev/docs
 const DEFAULT_MIN_WAIT_MS = 100;
-const DEFAULT_USER_AGENT = "openfga-sdk js/0.4.0";
+const DEFAULT_USER_AGENT = "openfga-sdk js/0.5.0";
 function GetDefaultRetryParams(maxRetry = DEFAULT_MAX_RETRY, minWaitInMs = DEFAULT_MIN_WAIT_MS) {
@@ -125,2 +125,2 @@ return {
  */
-Configuration.sdkVersion = "0.4.0";
+Configuration.sdkVersion = "0.5.0";

dist/credentials/credentials.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/credentials/credentials.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/credentials/index.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/credentials/index.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/credentials/types.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/credentials/types.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/errors.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/errors.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/index.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/index.js

@@ -7,3 +7,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -10,0 +10,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/assert-never.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/assert-never.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/chunk-array.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/chunk-array.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/generate-random-id.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/generate-random-id.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/index.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/index.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/set-header-if-not-set.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/set-header-if-not-set.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/set-not-enumerable-property.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/utils/set-not-enumerable-property.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

dist/validation.d.ts

 /**
  * JavaScript and Node.js SDK for OpenFGA
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -6,0 +6,0 @@ * Documentation: https://openfga.dev/docs

dist/validation.js

@@ -5,3 +5,3 @@ "use strict";
  *
- * API version: 0.1
+ * API version: 1.x
  * Website: https://openfga.dev
@@ -8,0 +8,0 @@ * Documentation: https://openfga.dev/docs

package.json

 {
   "name": "@openfga/sdk",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "JavaScript and Node.js SDK for OpenFGA",
@@ -5,0 +5,0 @@ "author": "OpenFGA",

README.md

@@ -466,3 +466,3 @@ # JavaScript and Node.js SDK for OpenFGA
   object: "document:roadmap",
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
@@ -496,3 +496,3 @@ relation: "writer",
     object: "document:roadmap",
-    contextual_tuples: [{
+    contextualTuples: [{
       user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
@@ -543,3 +543,3 @@ relation: "writer",
   type: "document",
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
@@ -570,3 +570,3 @@ relation: "writer",
   relations: ["can_view", "can_edit", "can_delete"],
-  contextual_tuples: [{
+  contextualTuples: [{
     user: "user:81684243-9356-4421-8fbf-a4f8d36aa31b",
@@ -621,3 +621,2 @@ relation: "writer",
 // response.users = [{object: {type: "user", id: "81684243-9356-4421-8fbf-a4f8d36aa31b"}}, {userset: { type: "user" }}, ...]
-// response.excluded_users = [ {object: {type: "user", id: "4a455e27-d15a-4434-82e0-136f9c2aa4cf"}}, ... ]
 ```
@@ -624,0 +623,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

1410026

increased by1.34%

Lines of code

6786

increased by0.77%

Worsened metrics

Number of lines in readme file

733

decreased by-0.14%

No dependency changes