foobara-typescript-remote-command-generator 1.2.7 → 1.3.1

data/src/{remote_generator/services → generators}/domain_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class DomainGenerator < TypescriptFromManifestBaseGenerator
         alias domain_manifest relevant_manifest
 

data/src/{remote_generator/services → generators}/domain_manifest_generator.rb

@@ -2,7 +2,7 @@ require_relative "manifest_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class DomainManifestGenerator < ManifestGenerator
         def target_path
           if global?

data/src/{remote_generator/services → generators}/entity_generator.rb

@@ -2,7 +2,7 @@ require_relative "model_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class EntityGenerator < ModelGenerator
         alias entity_manifest relevant_manifest
 

data/src/{remote_generator/services → generators}/entity_manifest_generator.rb

@@ -2,7 +2,7 @@ require_relative "model_manifest_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class EntityManifestGenerator < ModelManifestGenerator
       end
     end

data/src/{remote_generator/services → generators}/entity_variants_generator.rb

@@ -2,7 +2,7 @@ require_relative "model_variants_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class EntityVariantsGenerator < EntityGenerator
         def target_path
           *prefix, _entity_name, _file = super

data/src/{remote_generator/services → generators}/error_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ErrorGenerator < TypescriptFromManifestBaseGenerator
         alias error_manifest relevant_manifest
 

data/src/{remote_generator/services → generators}/loaded_entity_generator.rb

@@ -2,7 +2,7 @@ require_relative "entity_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class LoadedEntityGenerator < EntityGenerator
         def target_path
           [*super[..-2], "Loaded.ts"]

data/src/{remote_generator/services → generators}/manifest_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ManifestGenerator < TypescriptFromManifestBaseGenerator
         def generate(_elements_to_generate)
           JSON.pretty_generate(relevant_manifest.relevant_manifest)

data/src/{remote_generator/services → generators}/model_generator.rb

@@ -3,7 +3,7 @@ require_relative "type_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ModelGenerator < TypeGenerator
         class << self
           def new(relevant_manifest)

data/src/{remote_generator/services → generators}/model_manifest_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ModelManifestGenerator < ManifestGenerator
         def target_path
           [*domain.scoped_full_path, "Types", *model_prefix, scoped_short_name, "manifest.json"]

data/src/{remote_generator/services → generators}/model_variants_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ModelVariantsGenerator < ModelGenerator
         def target_path
           [*domain.scoped_full_path, "Types", *model_prefix, "#{scoped_short_name}.ts"]

data/src/{remote_generator/services → generators}/organization_config_generator.rb

@@ -2,7 +2,7 @@ require_relative "organization_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class OrganizationConfigGenerator < OrganizationGenerator
         def target_path
           [*super[0..-2], "config.ts"]

data/src/{remote_generator/services → generators}/organization_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class OrganizationGenerator < TypescriptFromManifestBaseGenerator
         alias organization_manifest relevant_manifest
 

data/src/{remote_generator/services → generators}/organization_manifest_generator.rb

@@ -2,7 +2,7 @@ require_relative "manifest_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class OrganizationManifestGenerator < ManifestGenerator
         def target_path
           if global?

data/src/{remote_generator/services → generators}/processor_class_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class ProcessorClassGenerator < TypescriptFromManifestBaseGenerator
         alias processor_class_manifest relevant_manifest
 

data/src/generators/remote_command_generator.rb

@@ -0,0 +1,41 @@
+module Foobara
+  module RemoteGenerator
+    module Generators
+      class RemoteCommandGenerator < TypescriptFromManifestBaseGenerator
+        def import_destructure
+          ts_instance_path.first
+        end
+
+        def ts_instance_path
+          ["RemoteCommand"]
+        end
+
+        def ts_instance_full_path
+          ["RemoteCommand"]
+        end
+
+        def template_path
+          ["base", "RemoteCommand.ts.erb"]
+        end
+
+        def hash
+          template_path.hash
+        end
+
+        def domain_reference
+          "global_organization::global_domain"
+        end
+
+        # TODO: awkward to have this here hmmm... maybe create a manifest for these static files?
+        # something doesn't feel right about this.
+        def domain
+          Manifest::Domain.new(root_manifest, [:domain, domain_reference])
+        end
+
+        def scoped_full_name
+          ts_instance_path.first
+        end
+      end
+    end
+  end
+end

data/src/{remote_generator/services → generators}/root_manifest_generator.rb

@@ -2,7 +2,7 @@ require_relative "manifest_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class RootManifestGenerator < ManifestGenerator
         def target_path
           ["manifest.json"]

data/src/{remote_generator/services → generators}/type_generator.rb

@@ -2,7 +2,7 @@ require_relative "typescript_from_manifest_base_generator"
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class TypeGenerator < TypescriptFromManifestBaseGenerator
         class << self
           def lru_cache
@@ -100,13 +100,13 @@ module Foobara
 
         def model_generators
           @model_generators ||= types_depended_on.select(&:model?).reject(&:builtin?).map do |model|
-            Services::ModelGenerator.new(model)
+            ModelGenerator.new(model)
           end
         end
 
         def custom_type_generators
           @custom_type_generators ||= types_depended_on.reject(&:builtin?).reject(&:model?).map do |type|
-            Services::TypeGenerator.new(type)
+            TypeGenerator.new(type)
           end
         end
 

data/src/{remote_generator/services → generators}/typescript_from_manifest_base_generator.rb

@@ -22,7 +22,7 @@
 
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class TypescriptFromManifestBaseGenerator < Foobara::FilesGenerator
         class << self
           def manifest_to_generator_classes(manifest)
@@ -30,62 +30,62 @@ module Foobara
             when Manifest::Command
               generator_classes = case manifest.full_command_name
                                   when "Foobara::Auth::RefreshLogin"
-                                    Services::Auth::RefreshLoginGenerator
+                                    Auth::RefreshLoginGenerator
                                   when "Foobara::Auth::Login"
-                                    Services::Auth::LoginGenerator
+                                    Auth::LoginGenerator
                                   when "Foobara::Auth::Logout"
-                                    Services::Auth::LogoutGenerator
+                                    Auth::LogoutGenerator
                                   when /\bGetCurrentUser$/
-                                    Services::Auth::RequiresAuthGenerator
+                                    Auth::RequiresAuthGenerator
                                   else
                                     if manifest.requires_authentication?
-                                      Services::Auth::RequiresAuthGenerator
+                                      Auth::RequiresAuthGenerator
                                     else
-                                      Services::CommandGenerator
+                                      CommandGenerator
                                     end
                                   end
 
               [
                 *generator_classes,
-                Services::CommandInputsGenerator,
-                Services::CommandResultGenerator,
-                Services::CommandCastResultGenerator,
-                Services::CommandErrorsGenerator,
-                Services::CommandErrorsIndexGenerator,
-                Services::CommandManifestGenerator
+                CommandInputsGenerator,
+                CommandResultGenerator,
+                CommandCastResultGenerator,
+                CommandErrorsGenerator,
+                CommandErrorsIndexGenerator,
+                CommandManifestGenerator
               ]
             when Manifest::Domain
               [
-                Services::DomainGenerator,
-                Services::DomainConfigGenerator,
-                Services::DomainManifestGenerator
+                DomainGenerator,
+                DomainConfigGenerator,
+                DomainManifestGenerator
               ]
             when Manifest::Organization
               [
-                Services::OrganizationGenerator,
-                Services::OrganizationConfigGenerator,
-                Services::OrganizationManifestGenerator
+                OrganizationGenerator,
+                OrganizationConfigGenerator,
+                OrganizationManifestGenerator
               ]
             when Manifest::Entity, Manifest::DetachedEntity
               [
-                Services::EntityGenerator,
-                Services::EntityVariantsGenerator,
-                Services::EntityManifestGenerator
+                EntityGenerator,
+                EntityVariantsGenerator,
+                EntityManifestGenerator
               ]
             when Manifest::Model
               [
-                Services::ModelGenerator,
-                Services::ModelVariantsGenerator,
-                Services::ModelManifestGenerator
+                ModelGenerator,
+                ModelVariantsGenerator,
+                ModelManifestGenerator
               ]
             when Manifest::Error
-              Services::ErrorGenerator
+              ErrorGenerator
             when Manifest::ProcessorClass
-              Services::ProcessorClassGenerator
+              ProcessorClassGenerator
             when Manifest::RootManifest
-              Services::RootManifestGenerator
+              RootManifestGenerator
             when Manifest::Type
-              Services::TypeGenerator
+              TypeGenerator
             else
               # :nocov:
               raise "Not sure how build a generator for a #{manifest}"
@@ -94,18 +94,18 @@ module Foobara
           end
         end
 
-        def initialize(relevant_manifest)
-          unless relevant_manifest.is_a?(Manifest::BaseManifest)
+        def initialize(relevant_manifest = (none_given = true))
+          if none_given || relevant_manifest.is_a?(Manifest::BaseManifest)
+            super
+          else
             # :nocov:
             raise ArgumentError, "Expected a Foobara::Manifest, got #{relevant_manifest.class}"
             # :nocov:
           end
-
-          super
         end
 
         def templates_dir
-          "#{__dir__}/../../../templates"
+          "#{__dir__}/../../templates"
         end
 
         def parent
@@ -389,15 +389,15 @@ module Foobara
 
           generator_class = case association_depth
                             when AssociationDepth::AMBIGUOUS
-                              Services::ModelGenerator
+                              ModelGenerator
                             when AssociationDepth::ATOM
                               if !initial && model.detached_entity?
-                                Services::UnloadedEntityGenerator
+                                UnloadedEntityGenerator
                               else
-                                Services::AtomModelGenerator
+                                AtomModelGenerator
                               end
                             when AssociationDepth::AGGREGATE
-                              Services::AggregateModelGenerator
+                              AggregateModelGenerator
                             else
                               # :nocov:
                               raise "Bad association_depth: #{association_depth}"
@@ -431,6 +431,10 @@ module Foobara
           path = super
           path.empty? ? "./" : path
         end
+
+        def auto_dirty_queries?
+          RemoteGenerator.auto_dirty_queries?
+        end
       end
     end
   end

data/src/{remote_generator/services → generators}/unloaded_entity_generator.rb

@@ -1,6 +1,6 @@
 module Foobara
   module RemoteGenerator
-    class Services
+    module Generators
       class UnloadedEntityGenerator < EntityGenerator
         def target_path
           [*super[..-2], "Unloaded.ts"]

data/src/remote_generator.rb

@@ -1,5 +1,26 @@
 module Foobara
   module RemoteGenerator
     foobara_domain!
+
+    class << self
+      def auto_dirty_queries(auto_dirty_queries)
+        if auto_dirty_queries == @auto_dirty_queries
+          yield
+        else
+          old = @auto_dirty_queries
+          begin
+            @auto_dirty_queries = auto_dirty_queries
+            yield
+          ensure
+            @auto_dirty_queries = old
+          end
+        end
+        @auto_dirty_queries = auto_dirty_queries
+      end
+
+      def auto_dirty_queries?
+        @auto_dirty_queries
+      end
+    end
   end
 end

data/src/{remote_generator/write_typescript_to_disk.rb → write_typescript_to_disk.rb}

@@ -2,7 +2,7 @@ require_relative "generate_typescript"
 
 module Foobara
   module RemoteGenerator
-    class WriteTypescriptToDisk < Generators::WriteGeneratedFilesToDisk
+    class WriteTypescriptToDisk < Foobara::Generators::WriteGeneratedFilesToDisk
       def self.generator_key = "typescript-remote-commands"
 
       inputs do
@@ -14,6 +14,7 @@ module Foobara
                           description: "This lets you specify a directory to run the linter or npm run build in"
         output_directory :string, default: "src/domains"
         fail_if_does_not_pass_linter :boolean, default: false
+        auto_dirty_queries :boolean, default: false
       end
 
       possible_error :missing_manifest
@@ -49,9 +50,17 @@ module Foobara
         # TODO: we need a way to allow values to be nil in type declarations
         inputs = raw_manifest ? { raw_manifest: } : { manifest_url: }
 
+        if auto_dirty_queries?
+          inputs[:auto_dirty_queries] = auto_dirty_queries
+        end
+
         self.paths_to_source_code = run_subcommand!(GenerateTypescript, inputs)
       end
 
+      def auto_dirty_queries?
+        auto_dirty_queries
+      end
+
       def run_post_generation_tasks
         Dir.chdir(project_directory || output_directory) do
           eslint_fix

data/templates/Command.ts.erb

@@ -1,4 +1,6 @@
-import <%= base_class_name %> from "<%= path_to_root %><%= base_class_path %>"
+<% dependency_roots.each do |dependency_root| %>
+import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
+<% end %>
 
 import Inputs from "./Inputs"
 import Result from "./Result"
@@ -7,6 +9,7 @@ import { Error } from "./Errors"
 import castJsonResult from "./castJsonResult"
 <% end %>
 
+
 export class <%= command_name %> extends <%= base_class_name %><Inputs, Result, Error> {
   static readonly organizationName = "<%= organization_name %>"
   static readonly domainName = "<%= domain_name %>"
@@ -17,4 +20,39 @@ export class <%= command_name %> extends <%= base_class_name %><Inputs, Result,
     return castJsonResult(json)
   }
 <% end %>
+
+<% if queries_that_are_dirtied_by_this_command.any? %>
+  dirties (): Array<[any] | [any, string, any]> {
+    <% if queries_dirtied_without_inputs.any? %>
+    const queries: Array<[any] | [any, string, any]> = [
+      <% queries_dirtied_without_inputs.each do |query| %>
+      [<%= dependency_group.non_colliding_type(query) %>],
+      <% end %>
+    ]
+    <% end %>
+
+    <% if queries_dirtied_with_inputs.any? %>
+      <% queries_dirtied_with_inputs.each_pair do |query, value_path_and_query_input_path| %>
+        <% value_path_and_query_input_path => [value_path, query_input_path] %>
+        <% if value_path.first == :result %>
+          queries.push([
+            <%= dependency_group.non_colliding_type(query) %>,
+            <%= query_input_path.to_s.inspect %>,
+            this.<%= value_path.join(".") %>
+          ])
+        <% else %>
+          if (this.<%= value_path.join("?.") %> != null) {
+            queries.push([
+              <%= dependency_group.non_colliding_type(query) %>,
+              <%= query_input_path.to_s.inspect %>,
+              this.<%= value_path.join(".") %>
+            ])
+          }
+        <% end %>
+      <% end %>
+    <% end %>
+
+    return queries
+  }
+<% end %>
 }

data/templates/base/QueryCache.ts

@@ -38,6 +38,54 @@ export function forEachQuery (callback: (query: Query<RemoteCommand<any, any, an
   queryCache.forEach(callback)
 }
 
+interface DirtyQueryEvent {
+  commandName: string
+  propertyName: string | undefined
+  value: string | number | undefined
+}
+
+let dirtyQueryChannel: BroadcastChannel | null = null
+
+if (typeof BroadcastChannel !== 'undefined') {
+  dirtyQueryChannel = new BroadcastChannel('dirty-query')
+
+  dirtyQueryChannel.addEventListener('message', (event: MessageEvent<DirtyQueryEvent>) => {
+    const { commandName, propertyName, value } = event.data
+
+    dirtyQuery(commandName, propertyName, value, { skipBroadcast: true })
+  })
+}
+
+export function dirtyQuery<CommandT extends RemoteCommand<any, any, any>> (
+  commandClass: RemoteCommandConstructor<CommandT> | string,
+  propertyName: string | undefined = undefined,
+  propertyValue: string | number | undefined = undefined,
+  options: { skipBroadcast: boolean } = { skipBroadcast: false }) {
+  if (typeof commandClass !== 'string') {
+    commandClass = commandClass.fullCommandName
+  }
+
+  forEachQuery((query) => {
+    if (query.CommandClass.fullCommandName === commandClass) {
+      if (query.inputs == null || Object.keys(query.inputs).length === 0) {
+        query.setDirty()
+      } else {
+        if (propertyName != null) {
+          if (query.inputs[propertyName] !== propertyValue) {
+            return
+          }
+        }
+
+        query.setDirty()
+      }
+    }
+  })
+
+  if (dirtyQueryChannel != null && !options.skipBroadcast) {
+    dirtyQueryChannel.postMessage({ commandName: commandClass, propertyName, value: propertyValue })
+  }
+}
+
 function toKey<CommandT extends RemoteCommand<any, any, any>> (
   CommandClass: RemoteCommandConstructor<CommandT>,
   inputs: InputsOf<CommandT> | undefined

data/templates/base/{RemoteCommand.ts → RemoteCommand.ts.erb}

@@ -1,5 +1,8 @@
 import { type Outcome, SuccessfulOutcome, ErrorOutcome } from './Outcome'
 import { type FoobaraError } from './Error'
+<% if auto_dirty_queries? %>
+import { dirtyQuery } from './QueryCache'
+<% end %>
 
 export default abstract class RemoteCommand<Inputs, Result, CommandError extends FoobaraError> {
   static _urlBase: string | undefined
@@ -105,6 +108,10 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     return json
   }
 
+  <% if auto_dirty_queries? %>
+  dirties (): Array<[any] | [any, string, any]> { return [] }
+  <% end %>
+
   async _handleResponse (response: Response): Promise<Outcome<Result, CommandError>> {
     const text = await response.text()
     const body = JSON.parse(text)
@@ -114,6 +121,7 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
 
       this.outcome = new SuccessfulOutcome<Result, CommandError>(result)
       this.commandState = 'succeeded'
+      this.dirtyQueries()
     } else if (response.status === 422 || response.status === 401 || response.status === 403) {
       this.commandState = 'errored'
       this.outcome = new ErrorOutcome<Result, CommandError>(body)
@@ -124,4 +132,18 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
 
     return this.outcome
   }
+
+  <% if auto_dirty_queries? %>
+  dirtyQueries () {
+    for (const [commandClass, inputs] of this.dirties()) {
+      if (inputs != null) {
+        for (const [propertyName, value] of Object.entries(inputs)) {
+          dirtyQuery(commandClass, propertyName, value)
+        }
+      } else {
+        dirtyQuery(commandClass)
+      }
+    }
+  }
+  <% end %>
 }