foobara-typescript-remote-command-generator 0.0.15 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30a3b38f66be2984ac2e6db57d53fe9abf21def7569fc0472938a0166f83934c
-  data.tar.gz: afb81264f3fb218f0e596ad946c77ea509c8fa1e4c99816c2c77e64740892b22
+  metadata.gz: 0edeec83ef5a6e8fdd8f4b0bf8352c0791a593386aec53f70724d3437b7b3b13
+  data.tar.gz: c80f2d935699af9c03f0af3e0db70e9f411299d8017790cd78ae865fe21573eb
 SHA512:
-  metadata.gz: 469376f5e5e6f22706a954172b8e60610d1c390b74eb8a3f038c56229459cb292893b8ee6e29caa45b398d96f6fcc81e5165517a88c1f82df415fb94e63b1aaa
-  data.tar.gz: 0dd2303b15e531e72deed4a4d876d1e5e1dbe5d5cdb85f4577ebeb1fcaea0bc0c33be0fede4f5aededbd1c4c965cc07b565a789bad7fd56852ee675994972bac
+  metadata.gz: acb79c060d229a21d77a0962f72e6ce30adadd7a513ab061725d3fde6a60a414bf0fd5b917d48df58ecaf0012290d6021886ddcf3a11913f9ed798bff2018d63
+  data.tar.gz: caea17f1356db403b37e29bc6edeefea58107e94b57f3d4bc19987ae9c1b112e506f3248c1468cbb07746947604f0a95a68368380d2633e9e835b00d2dba3d96

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [0.0.17] - 2025-04-08
+
+- 
+
+## [0.0.16] - 2025-03-31
+
+- Add a bunch of special-case support for Foobara::Auth domain convenience
+
 ## [0.0.15] - 2025-03-30
 
 - Better error handling in RemoteCommand

data/src/remote_generator/services/auth/access_tokens_generator.rb

@@ -0,0 +1,13 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class AccessTokensGenerator < TypescriptFromManifestBaseGenerator
+          def template_path
+            "Foobara/Auth/utils/accessTokens.ts.erb"
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/login_command_generator.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class LoginCommandGenerator < TypescriptFromManifestBaseGenerator
+          def template_path
+            "Foobara/Auth/LoginCommand.ts.erb"
+          end
+
+          def dependencies
+            super + [AccessTokensGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/login_generator.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class LoginGenerator < CommandGenerator
+          def base_class_path
+            "Foobara/Auth/LoginCommand"
+          end
+
+          def dependencies
+            super + [LoginCommandGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/logout_command_generator.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class LogoutCommandGenerator < TypescriptFromManifestBaseGenerator
+          def template_path
+            "Foobara/Auth/LogoutCommand.ts.erb"
+          end
+
+          def dependencies
+            super + [AccessTokensGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/logout_generator.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class LogoutGenerator < CommandGenerator
+          def base_class_path
+            "Foobara/Auth/LogoutCommand"
+          end
+
+          def dependencies
+            super + [LogoutCommandGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/refresh_login_generator.rb

@@ -0,0 +1,17 @@
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class RefreshLoginGenerator < CommandGenerator
+          def base_class_path
+            "Foobara/Auth/LoginCommand"
+          end
+
+          def dependencies
+            super + [LoginCommandGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/requires_auth_command_generator.rb

@@ -0,0 +1,15 @@
+require_relative "../typescript_from_manifest_base_generator"
+
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class RequiresAuthCommandGenerator < TypescriptFromManifestBaseGenerator
+          def template_path
+            "Foobara/Auth/RequiresAuthCommand.ts.erb"
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/auth/requires_auth_generator.rb

@@ -0,0 +1,19 @@
+require_relative "../command_generator"
+
+module Foobara
+  module RemoteGenerator
+    class Services
+      module Auth
+        class RequiresAuthGenerator < CommandGenerator
+          def base_class_path
+            "Foobara/Auth/RequiresAuthCommand"
+          end
+
+          def dependencies
+            super + [RequiresAuthCommandGenerator.new(relevant_manifest)]
+          end
+        end
+      end
+    end
+  end
+end

data/src/remote_generator/services/command_generator.rb

@@ -35,6 +35,14 @@ module Foobara
         def command_errors_index_generator
           Services::CommandErrorsIndexGenerator.new(command_manifest)
         end
+
+        def base_class_path
+          "base/RemoteCommand"
+        end
+
+        def base_class_name
+          base_class_path.split("/").last
+        end
       end
     end
   end

data/src/remote_generator/services/domain_generator.rb

@@ -24,7 +24,7 @@ module Foobara
 
         def command_generators
           @command_generators ||= domain_manifest.commands.map do |command_manifest|
-            CommandGenerator.new(command_manifest)
+            generator_for(command_manifest)
           end
         end
 

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -28,8 +28,23 @@ module Foobara
           def manifest_to_generator_classes(manifest)
             case manifest
             when Manifest::Command
+              generator_classes = case manifest.full_command_name
+                                  when "Foobara::Auth::RefreshLogin"
+                                    Services::Auth::RefreshLoginGenerator
+                                  when "Foobara::Auth::Login"
+                                    Services::Auth::LoginGenerator
+                                  when "Foobara::Auth::Logout"
+                                    Services::Auth::LogoutGenerator
+                                  else
+                                    if manifest.requires_authentication?
+                                      Services::Auth::RequiresAuthGenerator
+                                    else
+                                      Services::CommandGenerator
+                                    end
+                                  end
+
               [
-                Services::CommandGenerator,
+                *generator_classes,
                 Services::CommandInputsGenerator,
                 Services::CommandResultGenerator,
                 Services::CommandErrorsGenerator,
@@ -190,10 +205,15 @@ module Foobara
           type_string = if type_declaration.is_a?(Manifest::Attributes)
                           ts_type = attributes_to_ts_type(type_declaration, association_depth:, dependency_group:)
 
+                          is_empty = type_declaration.attribute_declarations.empty?
+
                           if name
-                            return "interface #{name} #{ts_type}"
+                            # TODO: test this code path or delete it
+                            # :nocov:
+                            return is_empty ? "undefined" : "interface #{name} #{ts_type}"
+                            # :nocov:
                           else
-                            ts_type
+                            is_empty ? "undefined" : ts_type
                           end
                         elsif type_declaration.is_a?(Manifest::Array)
                           # TODO: which association_depth do we pass here?

data/templates/Command/Inputs.ts.erb

@@ -2,4 +2,6 @@
   import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
 
-export default <%= foobara_type_to_ts_type(inputs_type, name: "Inputs", dependency_group:) %>
+type Inputs = <%= foobara_type_to_ts_type(inputs_type, dependency_group:) %>
+
+export default Inputs

data/templates/Command.ts.erb

@@ -1,10 +1,10 @@
-import RemoteCommand from "<%= path_to_root %>base/RemoteCommand"
+import <%= base_class_name %> from "<%= path_to_root %><%= base_class_path %>"
 
 import Inputs from "./Inputs"
 import Result from "./Result"
 import { Error } from "./Errors"
 
-export class <%= command_name %> extends RemoteCommand<Inputs, Result, Error> {
+export class <%= command_name %> extends <%= base_class_name %><Inputs, Result, Error> {
   static readonly organizationName = "<%= organization_name %>"
   static readonly domainName = "<%= domain_name %>"
   static readonly commandName = "<%= command_name %>"

data/templates/Foobara/Auth/LoginCommand.ts.erb

@@ -0,0 +1,19 @@
+import RemoteCommand from '../../base/RemoteCommand'
+import { type FoobaraError } from '../../base/Error'
+import { type Outcome } from '../../base/Outcome'
+import { handleLogin } from './utils/accessTokens'
+
+export default class LoginCommand<Inputs, Result, Error extends FoobaraError<any>>
+  extends RemoteCommand<Inputs, Result, Error> {
+  async _handleResponse (response: Response): Promise<Outcome<Result, Error>> {
+    if (response.ok) {
+      const accessToken: string | null = response.headers.get('X-Access-Token')
+
+      if (accessToken != null) {
+        handleLogin(this.urlBase, accessToken)
+      }
+    }
+
+    return await super._handleResponse(response)
+  }
+}

data/templates/Foobara/Auth/LogoutCommand.ts.erb

@@ -0,0 +1,18 @@
+import RemoteCommand from '../../base/RemoteCommand'
+import { type FoobaraError } from '../../base/Error'
+import { type Outcome } from '../../base/Outcome'
+import { handleLogout } from './utils/accessTokens'
+
+export default class LogoutCommand<Inputs, Result, Error extends FoobaraError<any>>
+  extends RemoteCommand<Inputs, Result, Error> {
+  async run (): Promise<Outcome<Result, Error>> {
+    const outcome = await super.run()
+
+    if (outcome.isSuccess()) {
+      // Broadcast logout event to all tabs
+      handleLogout(this.urlBase)
+    }
+
+    return outcome
+  }
+}

data/templates/Foobara/Auth/RequiresAuthCommand.ts.erb

@@ -0,0 +1,43 @@
+import RemoteCommand from '../../base/RemoteCommand'
+import { type Outcome } from '../../base/Outcome'
+import { type FoobaraError } from '../../base/Error'
+import { tokenForUrl } from './utils/accessTokens'
+
+export default class RequiresAuthCommand<Inputs, Result, Error extends FoobaraError<any>>
+  extends RemoteCommand<Inputs, Result, Error> {
+  _buildRequestParams (): RequestInit {
+    const requestParams = super._buildRequestParams()
+
+    const bearerToken = tokenForUrl(this.urlBase)
+
+    if (bearerToken != null && requestParams.headers != null) {
+      requestParams.headers = { ...requestParams.headers, Authorization: `Bearer ${bearerToken}` }
+    }
+
+    return requestParams
+  }
+
+  async _handleResponse (response: Response): Promise<Outcome<Result, Error>> {
+    response = await this._handleUnauthenticated(response)
+
+    return await super._handleResponse(response)
+  }
+
+  async _handleUnauthenticated (response: Response): Promise<Response> {
+    if (response.status === 401) {
+      this.commandState = 'refreshing_authentication'
+
+      const { RefreshLogin } = await import('./RefreshLogin')
+      // See if we can authenticate using the refresh token
+      const refreshCommand = new RefreshLogin()
+      const outcome = await refreshCommand.run()
+
+      if (outcome.isSuccess()) {
+        this.commandState = 'executing'
+        response = await this._issueRequest()
+      }
+    }
+
+    return response
+  }
+}

data/templates/Foobara/Auth/utils/accessTokens.ts.erb

@@ -0,0 +1,28 @@
+const accessTokens = new Map<string, string>()
+
+const logout = (urlBase: string): void => { accessTokens.delete(urlBase) }
+let handleLogout: (baseUrl: string) => void = logout
+
+const tokenForUrl = (baseUrl: string): string | undefined => accessTokens.get(baseUrl)
+const handleLogin: (baseUrl: string, accessToken: string) => void = (baseUrl, accessToken) => {
+  accessTokens.set(baseUrl, accessToken)
+}
+
+if (typeof BroadcastChannel !== 'undefined') {
+  const logoutChannel = new BroadcastChannel('foobara-auth-events')
+
+  logoutChannel.addEventListener('message', (event: MessageEvent<string>) => {
+    accessTokens.delete(event.data)
+  })
+
+  handleLogout = (baseUrl: string) => {
+    logout(baseUrl)
+    logoutChannel.postMessage(baseUrl)
+  }
+}
+
+export {
+  handleLogin,
+  handleLogout,
+  tokenForUrl
+}

data/templates/base/RemoteCommand.ts

@@ -1,16 +1,11 @@
 import { type Outcome, SuccessfulOutcome, ErrorOutcome } from './Outcome'
 import { type FoobaraError } from './Error'
 
-export type commandState = 'initialized' | 'executing' | 'refreshing_auth' | 'succeeded' | 'errored' | 'failed'
-
-const accessTokens: Record<string, string> = {}
-
 export default abstract class RemoteCommand<Inputs, Result, CommandError extends FoobaraError> {
   static _urlBase: string | undefined
   static commandName: string
   static organizationName: string
   static domainName: string
-  static authRequired: boolean = true // TODO: set this from generator
 
   // TODO: make use of domain's config instead of process.env directly.
   static get urlBase (): string {
@@ -39,11 +34,11 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     return (this.constructor as typeof RemoteCommand<Inputs, Result, CommandError>).domainName
   }
 
-  inputs: Inputs
+  inputs: Inputs | undefined
   outcome: null | Outcome<Result, CommandError>
-  commandState: commandState
+  commandState: string
 
-  constructor (inputs: Inputs) {
+  constructor (inputs: Inputs | undefined = undefined) {
     this.inputs = inputs
     this.commandState = 'initialized'
     this.outcome = null
@@ -81,57 +76,36 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   }
 
   async run (): Promise<Outcome<Result, CommandError>> {
-    const url = `${this.urlBase}/run/${this.commandPath}`
+    this.commandState = 'executing'
+    const response = await this._issueRequest()
 
-    const bearerToken = accessTokens[this.urlBase]
+    this.outcome = await this._handleResponse(response)
+
+    return this.outcome
+  }
 
-    const requestParams: RequestInit = {
+  _buildUrl (): string {
+    return `${this.urlBase}/run/${this.commandPath}`
+  }
+
+  _buildRequestParams (): RequestInit {
+    return {
       method: 'POST',
+      headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify(this.inputs),
       credentials: 'include'
     }
+  }
 
-    requestParams.headers = { 'Content-Type': 'application/json' }
-
-    if (bearerToken != null) {
-      requestParams.headers.Authorization = `Bearer ${bearerToken}`
-    }
-
-    this.commandState = 'executing'
-    let response = await fetch(url, requestParams)
-
-    if ((this.constructor as typeof RemoteCommand<Inputs, Result, CommandError>).authRequired &&
-        response.status === 401) {
-      this.commandState = 'refreshing_auth'
-
-      // TODO: in generator make this conditional
-      const { RefreshLogin } = await import('../Foobara/Auth')
-      // See if we can authenticate using the refresh token
-      const refreshCommand = new RefreshLogin({})
-      const outcome = await refreshCommand.run()
-
-      if (outcome.isSuccess()) {
-        const bearerToken = accessTokens[this.urlBase]
-
-        if (bearerToken != null) {
-          requestParams.headers.Authorization = `Bearer ${bearerToken}`
-        }
-
-        this.commandState = 'executing'
-        response = await fetch(url, requestParams)
-      }
-    }
+  async _issueRequest (): Promise<Response> {
+    return await fetch(this._buildUrl(), this._buildRequestParams())
+  }
 
+  async _handleResponse (response: Response): Promise<Outcome<Result, CommandError>> {
     const text = await response.text()
     const body = JSON.parse(text)
 
     if (response.ok) {
-      const accessToken: string | null = response.headers.get('X-Access-Token')
-
-      if (accessToken != null) {
-        accessTokens[this.urlBase] = accessToken
-      }
-
       this.commandState = 'succeeded'
       this.outcome = new SuccessfulOutcome<Result, CommandError>(body)
     } else if (response.status === 422 || response.status === 401 || response.status === 403) {

metadata

@@ -1,28 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.15
+  version: 0.0.17
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-03-31 00:00:00.000000000 Z
+date: 2025-04-09 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: foobara
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.88
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.0.88
 - !ruby/object:Gem::Dependency
   name: foobara-files-generator
   requirement: !ruby/object:Gem::Requirement
@@ -56,6 +42,14 @@ files:
 - src/remote_generator/services/aggregate_model_generator.rb
 - src/remote_generator/services/atom_entity_generator.rb
 - src/remote_generator/services/atom_model_generator.rb
+- src/remote_generator/services/auth/access_tokens_generator.rb
+- src/remote_generator/services/auth/login_command_generator.rb
+- src/remote_generator/services/auth/login_generator.rb
+- src/remote_generator/services/auth/logout_command_generator.rb
+- src/remote_generator/services/auth/logout_generator.rb
+- src/remote_generator/services/auth/refresh_login_generator.rb
+- src/remote_generator/services/auth/requires_auth_command_generator.rb
+- src/remote_generator/services/auth/requires_auth_generator.rb
 - src/remote_generator/services/command_errors_generator.rb
 - src/remote_generator/services/command_errors_index_generator.rb
 - src/remote_generator/services/command_generator.rb
@@ -98,6 +92,10 @@ files:
 - templates/Entity/Unloaded.ts.erb
 - templates/EntityVariants.ts.erb
 - templates/Error.ts.erb
+- templates/Foobara/Auth/LoginCommand.ts.erb
+- templates/Foobara/Auth/LogoutCommand.ts.erb
+- templates/Foobara/Auth/RequiresAuthCommand.ts.erb
+- templates/Foobara/Auth/utils/accessTokens.ts.erb
 - templates/Model/Aggregate.ts.erb
 - templates/Model/Atom.ts.erb
 - templates/Model/Model.ts.erb
@@ -134,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.6
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []