release: v0.3.5 (#79)

Author: ewanharris

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.3.5
+
+### [0.3.5](https://github.com/openfga/js-sdk/compare/v0.3.4...v0.3.5) (2024-03-19)
+
+- feat: add support for modular models metadata
+
 ## v0.3.4
 
 ### [0.3.4](https://github.com/openfga/js-sdk/compare/v0.3.3...v0.3.4) (2024-03-15)

api.ts

@@ -38,6 +38,7 @@ import {
   CheckResponse,
   Computed,
   Condition,
+  ConditionMetadata,
   ConditionParamTypeRef,
   ContextualTupleKeys,
   CreateStoreRequest,
@@ -71,6 +72,7 @@ import {
   RelationMetadata,
   RelationReference,
   RelationshipCondition,
+  SourceInfo,
   Status,
   Store,
   Tuple,

apiModel.ts

@@ -240,6 +240,31 @@ export interface Condition {
      * @memberof Condition
      */
     parameters?: { [key: string]: ConditionParamTypeRef; };
+    /**
+     * 
+     * @type {ConditionMetadata}
+     * @memberof Condition
+     */
+    metadata?: ConditionMetadata;
+}
+/**
+ * 
+ * @export
+ * @interface ConditionMetadata
+ */
+export interface ConditionMetadata {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConditionMetadata
+     */
+    module?: string;
+    /**
+     * 
+     * @type {SourceInfo}
+     * @memberof ConditionMetadata
+     */
+    source_info?: SourceInfo;
 }
 /**
  * 
@@ -636,6 +661,18 @@ export interface Metadata {
      * @memberof Metadata
      */
     relations?: { [key: string]: RelationMetadata; };
+    /**
+     * 
+     * @type {string}
+     * @memberof Metadata
+     */
+    module?: string;
+    /**
+     * 
+     * @type {SourceInfo}
+     * @memberof Metadata
+     */
+    source_info?: SourceInfo;
 }
 /**
  * 
@@ -901,6 +938,18 @@ export interface RelationMetadata {
      * @memberof RelationMetadata
      */
     directly_related_user_types?: Array<RelationReference>;
+    /**
+     * 
+     * @type {string}
+     * @memberof RelationMetadata
+     */
+    module?: string;
+    /**
+     * 
+     * @type {SourceInfo}
+     * @memberof RelationMetadata
+     */
+    source_info?: SourceInfo;
 }
 /**
  * RelationReference represents a relation of a particular object type (e.g. \'document#viewer\').
@@ -952,6 +1001,19 @@ export interface RelationshipCondition {
      */
     context?: object;
 }
+/**
+ * 
+ * @export
+ * @interface SourceInfo
+ */
+export interface SourceInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof SourceInfo
+     */
+    file?: string;
+}
 /**
  * 
  * @export

configuration.ts

@@ -21,7 +21,7 @@ const DEFAULT_MAX_RETRY = 15;
 // default minimum wait period in retry - but will backoff exponentially
 const DEFAULT_MIN_WAIT_MS = 100;
 
-const DEFAULT_USER_AGENT = "openfga-sdk js/0.3.4";
+const DEFAULT_USER_AGENT = "openfga-sdk js/0.3.5";
 
 export interface RetryParams {
   maxRetry?: number;
@@ -74,7 +74,7 @@ export class Configuration {
    * @type {string}
    * @memberof Configuration
    */
-  private static sdkVersion = "0.3.4";
+  private static sdkVersion = "0.3.5";
 
   /**
    * provide the full api URL (e.g. `https://api.fga.example`)

example/README.md

@@ -28,7 +28,7 @@ Steps
 2. In the Example `package.json` change the `@openfga/sdk` dependency from a semver range like below
 ```json
 "dependencies": {
-    "@openfga/sdk": "^0.3.4"
+    "@openfga/sdk": "^0.3.5"
   }
 ```
 to a `file:` reference like below

example/example1/package.json

@@ -9,7 +9,7 @@
     "start": "node example1.mjs"
   },
   "dependencies": {
-    "@openfga/sdk": "^0.3.4"
+    "@openfga/sdk": "^0.3.5"
   },
   "engines": {
     "node": ">=16.13.0"

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfga/sdk",
-  "version": "0.3.4",
+  "version": "0.3.5",
   "description": "JavaScript and Node.js SDK for OpenFGA",
   "author": "OpenFGA",
   "keywords": [