release(js-sdk): v0.3.0 (#250)

openfga · Dec 11, 2023 · bd8c0c4 · bd8c0c4
2 parents 3d0557d + bf2ebb1
commit bd8c0c4
Show file tree

Hide file tree

Showing 8 changed files with 443 additions and 442 deletions.
diff --git a/Makefile b/Makefile
@@ -2,7 +2,7 @@
 OPENFGA_DOCKER_TAG = v1.4.0-rc1
 OPEN_API_URL = https://raw.githubusercontent.com/openfga/api/main/docs/openapiv2/apidocs.swagger.json
 OPENAPI_GENERATOR_CLI_DOCKER_TAG = v6.4.0
-NODE_DOCKER_TAG = 18-alpine
+NODE_DOCKER_TAG = 20-alpine
 GO_DOCKER_TAG = 1
 DOTNET_DOCKER_TAG = 6.0
 GOLINT_DOCKER_TAG = v1.54-alpine
@@ -169,8 +169,7 @@ build-client: build-openapi
 .PHONY: build-openapi
 build-openapi: init get-openapi-doc
 	cat "${DOCS_CACHE_DIR}/openfga.openapiv2.raw.json" | \
-		docker run --rm -i stedolan/jq \
-		 '(.. | .tags? | select(.)) |= ["OpenFga"] | (.tags? | select(.)) |= [{"name":"OpenFga"}] | del(.definitions.ReadTuplesParams, .definitions.ReadTuplesResponse, .paths."/stores/{store_id}/read-tuples", .definitions.StreamedListObjectsRequest, .definitions.StreamedListObjectsResponse, .paths."/stores/{store_id}/streamed-list-objects")' > \
+		jq '(.. | .tags? | select(.)) |= ["OpenFga"] | (.tags? | select(.)) |= [{"name":"OpenFga"}] | del(.definitions.ReadTuplesParams, .definitions.ReadTuplesResponse, .paths."/stores/{store_id}/read-tuples", .definitions.StreamedListObjectsRequest, .definitions.StreamedListObjectsResponse, .paths."/stores/{store_id}/streamed-list-objects")' > \
 		${DOCS_CACHE_DIR}/openfga.openapiv2.json
 	sed -i -e 's/v1.//g' ${DOCS_CACHE_DIR}/openfga.openapiv2.json
 

diff --git a/config/clients/js/CHANGELOG.md.mustache b/config/clients/js/CHANGELOG.md.mustache
@@ -2,9 +2,11 @@
 
 ## v0.3.0
 
-### [0.3.0](https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}/compare/v0.2.10...v0.3.0) (2023-11-01)
+### [0.3.0](https://{{gitHost}}/{{gitUserId}}/{{gitRepoId}}/compare/v0.2.10...v0.3.0) (2023-12-11)
 
-- feat!: support for conditions
+- feat: support for conditions
+- chore: use latest API interfaces
+- chore: dependency updates
 
 ## v0.2.10
 

diff --git a/config/clients/js/config.overrides.json b/config/clients/js/config.overrides.json
@@ -2,7 +2,7 @@
   "sdkId": "js",
   "gitRepoId": "js-sdk",
   "packageName": "@openfga/sdk",
-  "packageVersion": "0.2.10",
+  "packageVersion": "0.3.0",
   "packageDescription": "JavaScript and Node.js SDK for OpenFGA",
   "packageDetailedDescription": "This is an autogenerated JavaScript SDK for OpenFGA. It provides a wrapper around the [OpenFGA API definition](https://openfga.dev/api), and includes TS typings.",
   "npmRegistry": "https://registry.npmjs.org/",

diff --git a/config/clients/js/template/.github/dependabot.yaml b/config/clients/js/template/.github/dependabot.yaml
@@ -1,6 +1,6 @@
 version: 2
 updates:
-  - package-ecosystem: "gomod"
+  - package-ecosystem: "npm"
     directory: "/"
     schedule:
       interval: "weekly"

diff --git a/config/clients/js/template/.github/workflows/main.yaml b/config/clients/js/template/.github/workflows/main.yaml
@@ -23,7 +23,7 @@ jobs:
           fetch-depth: 0
 
       - name: Set up node
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
           node-version: ${{ matrix.node-version }}
           registry-url: 'https://registry.npmjs.org'
@@ -46,9 +46,9 @@ jobs:
           fetch-depth: 0
 
       - name: Set up node
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
-          node-version: '18'
+          node-version: '20'
           cache: 'npm'
 
       - name: Install dependencies
@@ -77,9 +77,9 @@ jobs:
           fetch-depth: 0
 
       - name: Set up node
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d # v3.8.1
+        uses: actions/setup-node@8f152de45cc393bb48ce5d89d36b731f54556e65 # v4.0.0
         with:
-          node-version: '18'
+          node-version: '20'
           registry-url: 'https://registry.npmjs.org'
           scope: '@openfga'
           always-auth: false
@@ -105,7 +105,7 @@ jobs:
         with:
           fetch-depth: 0
 
-      - uses: Roang-zero1/github-create-release-action@5cf058ddffa6fa04e5cda07c98570c757dc4a0e1 # v3.0.1
+      - uses: Roang-zero1/github-create-release-action@57eb9bdce7a964e48788b9e78b5ac766cb684803 # v3.0.1
         with:
           version_regex: ^v[[:digit:]]+\.[[:digit:]]+\.[[:digit:]]+
         env:

diff --git a/config/clients/js/template/client.mustache b/config/clients/js/template/client.mustache
@@ -25,10 +25,10 @@ import {
   ReadRequestTupleKey,
   ReadResponse,
   TupleKey,
+  TupleKeyWithoutCondition,
   WriteAuthorizationModelRequest,
   WriteAuthorizationModelResponse,
   WriteRequest,
-  WriteRequestTupleKey,
 } from "./apiModel";
 import { BaseAPI } from "./base";
 import { CallResult, PromiseResult } from "./common";
@@ -95,8 +95,8 @@ export interface BatchCheckRequestOpts {
 }
 
 export interface ClientWriteRequest {
-  writes?: WriteRequestTupleKey[];
-  deletes?: WriteRequestTupleKey[];
+  writes?: TupleKey[];
+  deletes?: TupleKeyWithoutCondition[];
 }
 
 export enum ClientWriteStatus {
@@ -105,7 +105,7 @@ export enum ClientWriteStatus {
 }
 
 export interface ClientWriteSingleResponse {
-  tuple_key: WriteRequestTupleKey;
+  tuple_key: TupleKey;
   status: ClientWriteStatus;
   err?: Error;
 }
@@ -430,7 +430,7 @@ export class {{appShortName}}Client extends BaseAPI {
 
   /**
    * WriteTuples - Utility method to write tuples, wraps Write
-   * @param {WriteRequestTupleKey[]} tuples
+   * @param {TupleKey[]} tuples
    * @param {ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts} [options]
    * @param {string} [options.authorizationModelId] - Overrides the authorization model id in the configuration
    * @param {object} [options.transaction]
@@ -442,15 +442,15 @@ export class {{appShortName}}Client extends BaseAPI {
    * @param {number} [options.retryParams.maxRetry] - Override the max number of retries on each API request
    * @param {number} [options.retryParams.minWaitInMs] - Override the minimum wait before a retry is initiated
    */
-  async writeTuples(tuples: WriteRequestTupleKey[], options: ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts = {}): Promise<ClientWriteResponse> {
+  async writeTuples(tuples: TupleKey[], options: ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts = {}): Promise<ClientWriteResponse> {
     const { headers = {} } = options;
     setHeaderIfNotSet(headers, CLIENT_METHOD_HEADER, "WriteTuples");
     return this.write({ writes: tuples }, { ...options, headers });
   }
 
   /**
    * DeleteTuples - Utility method to delete tuples, wraps Write
-   * @param {WriteRequestTupleKey[]} tuples
+   * @param {TupleKeyWithoutCondition[]} tuples
    * @param {ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts} [options]
    * @param {string} [options.authorizationModelId] - Overrides the authorization model id in the configuration
    * @param {object} [options.transaction]
@@ -462,7 +462,7 @@ export class {{appShortName}}Client extends BaseAPI {
    * @param {number} [options.retryParams.maxRetry] - Override the max number of retries on each API request
    * @param {number} [options.retryParams.minWaitInMs] - Override the minimum wait before a retry is initiated
    */
-  async deleteTuples(tuples: WriteRequestTupleKey[], options: ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts = {}): Promise<ClientWriteResponse> {
+  async deleteTuples(tuples: TupleKeyWithoutCondition[], options: ClientRequestOptsWithAuthZModelId & ClientWriteRequestOpts = {}): Promise<ClientWriteResponse> {
     const { headers = {} } = options;
     setHeaderIfNotSet(headers, CLIENT_METHOD_HEADER, "DeleteTuples");
     return this.write({ deletes: tuples }, { ...options, headers });