foobara-typescript-remote-command-generator 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63a56366d8d763f7a5945acb31f26942889b8801d87d473f1cf80670492984ea
-  data.tar.gz: f743ce22ffdf47ece2df4d68763a76c959072098fb50c2314da236c667cbc7e6
+  metadata.gz: 16a68cb56fbf77e520f577b5ef5d0b6c677d6461fb69ce242906d608b6412e3f
+  data.tar.gz: 35dcccf09cff04cad00c02423b77ebecdebc3643080cc9e534bae8e957dd273c
 SHA512:
-  metadata.gz: 3296bab04a57c964281ee3e8b5e4b5db4f3cda345bfbbbf6c9667cbc1eba4cd2e75266a1be6d9cc38836d44b310355201f4590bec04fcf87a33f96e7e988c6fd
-  data.tar.gz: 18a1e5716e44579286b0251cbc9b30fc4814c5c7033578ff33d00b91a6640e7e20042acc0a93ded4ff2cc4d001c310f605a3eed448c839d7391b40dad0abf6ea
+  metadata.gz: 952c659c1ace30fbbd24f980c8382db56f95757ac5a802b25ed19e5c6faf276dd1647f6fe999cb3afc49c3bb35b90003e95765ad2363f1ce160846cd9d3100d3
+  data.tar.gz: 78c60b378c18f6786c9d6cd29db44d7c693c45c433977deedeaec79694ccb4f640f092159349758be3d1094d04c83f379e6caaea4c3e3bd4c9d5e820e4929fcc

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [1.4.0] - 2026-03-19
+
+- Make things work with Vite instead of CRA
+
+## [1.3.1] - 2026-02-28
+
+- Use a channel to make other tabs automatically reload their queries
+
 ## [1.3.0] - 2026-02-26
 
 - Add auto-dirty queries feature

data/src/generators/type_generator.rb

@@ -148,6 +148,10 @@ module Foobara
         def attribute_names
           attributes_type.attribute_names
         end
+
+        def import_destructure
+          "{ type #{scoped_short_name} }"
+        end
       end
     end
   end

data/templates/Command/Inputs.ts.erb

@@ -4,4 +4,4 @@
 
 type Inputs = <%= foobara_type_to_ts_type(inputs_type, dependency_group:, model_and_entity_free: true) %>
 
-export default Inputs
+export type { Inputs as default }

data/templates/Command/Result.ts.erb

@@ -6,4 +6,4 @@ type Result = <%=
 result_type.nil? ? "null" : foobara_type_to_ts_type(result_type, dependency_group:, association_depth:)
 %>
 
-export default Result
+export type { Result as default }

data/templates/Command/castJsonResult.ts.erb

@@ -1,4 +1,4 @@
-import Result from "./Result"
+import type Result from "./Result"
 
 <% dependency_roots.each do |dependency_root| %>
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"

data/templates/Command.ts.erb

@@ -2,9 +2,9 @@
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"
 <% end %>
 
-import Inputs from "./Inputs"
-import Result from "./Result"
-import { Error } from "./Errors"
+import type Inputs from "./Inputs"
+import type Result from "./Result"
+import { type Error } from "./Errors"
 <% if result_json_requires_cast? %>
 import castJsonResult from "./castJsonResult"
 <% end %>

data/templates/Domain/config.ts.erb

@@ -1,4 +1,4 @@
-let _urlBase = process.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+let _urlBase = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
 
 const config = {
   get urlBase(): string {

data/templates/Entity/Aggregate.ts.erb

@@ -1,5 +1,5 @@
 import {
-  <%= entity_short_name %>AttributesType
+  type <%= entity_short_name %>AttributesType
 } from "./Ambiguous"
 
 <% dependency_roots.each do |dependency_root| %>

data/templates/Entity/Atom.ts.erb

@@ -1,5 +1,5 @@
 import {
-  <%= entity_short_name %>AttributesType
+  type <%= entity_short_name %>AttributesType
 } from "./Ambiguous"
 import { Loaded<%= entity_short_name %> } from "./Loaded"
 <% dependency_roots.each do |dependency_root| %>

data/templates/Entity/Loaded.ts.erb

@@ -1,6 +1,6 @@
 import {
   <%= entity_short_name %>,
-  <%= entity_short_name %>AttributesType
+  type <%= entity_short_name %>AttributesType
 } from "./Ambiguous"
 
 export class Loaded<%= entity_short_name %><T extends <%= entity_short_name %>AttributesType = <%= entity_short_name %>AttributesType> extends <%= entity_short_name %><T> {

data/templates/Entity/Unloaded.ts.erb

@@ -1,8 +1,8 @@
-import { Never } from "<%= path_to_root %>base/Entity"
+import { type Never } from "<%= path_to_root %>base/Entity"
 import {
   <%= entity_short_name %>,
-  <%= entity_short_name %>PrimaryKeyType,
-  <%= entity_short_name %>AttributesType
+  type <%= entity_short_name %>PrimaryKeyType,
+  type <%= entity_short_name %>AttributesType
 } from "./Ambiguous"
 
 export type Unloaded<%= entity_short_name %>AttributesType = Never<<%= entity_short_name %>AttributesType>

data/templates/EntityVariants.ts.erb

@@ -1,12 +1,12 @@
 import {
   <%= entity_short_name %>,
-  <%= entity_short_name %>PrimaryKeyType,
+  type <%= entity_short_name %>PrimaryKeyType,
   <%= entity_name_downcase %>PrimaryKeyAttributeName,
-  <%= entity_short_name %>AttributesType
+  type <%= entity_short_name %>AttributesType
 } from "./<%= entity_short_name %>/Ambiguous"
 import {
   Unloaded<%= entity_short_name %>,
-  Unloaded<%= entity_short_name %>AttributesType
+  type Unloaded<%= entity_short_name %>AttributesType
 } from "./<%= entity_short_name %>/Unloaded"
 import {
   Loaded<%= entity_short_name %>
@@ -15,11 +15,11 @@ import {
 <% if has_associations? %>
 import {
   <%= entity_short_name %>Atom,
-  <%= entity_short_name %>AtomAttributesType
+  type <%= entity_short_name %>AtomAttributesType
 } from "./<%= entity_short_name %>/Atom"
 import {
   <%= entity_short_name %>Aggregate,
-  <%= entity_short_name %>AggregateAttributesType
+  type <%= entity_short_name %>AggregateAttributesType
 } from "./<%= entity_short_name %>/Aggregate"
 <% end %>
 

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

@@ -2,6 +2,7 @@ import RemoteCommand from '../../base/RemoteCommand'
 import { type Outcome } from '../../base/Outcome'
 import { type FoobaraError } from '../../base/Error'
 import { tokenForUrl } from './utils/accessTokens'
+import { RefreshLogin } from './RefreshLogin'
 
 export default class RequiresAuthCommand<Inputs, Result, Error extends FoobaraError<any>>
   extends RemoteCommand<Inputs, Result, Error> {
@@ -27,7 +28,6 @@ export default class RequiresAuthCommand<Inputs, Result, Error extends FoobaraEr
     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()

data/templates/Model/Aggregate.ts.erb

@@ -1,6 +1,6 @@
 import {
   <%= model_short_name %>,
-  <%= model_short_name %>AttributesType
+  type <%= model_short_name %>AttributesType
 } from "./<%= model_short_name %>"
 <% dependency_roots.each do |dependency_root| %>
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"

data/templates/Model/Atom.ts.erb

@@ -1,6 +1,6 @@
 import {
   <%= model_short_name %>,
-  <%= model_short_name %>AttributesType
+  type <%= model_short_name %>AttributesType
 } from "./<%= model_short_name %>"
 <% dependency_roots.each do |dependency_root| %>
 import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= dependency_root.import_path %>"

data/templates/ModelVariants.ts.erb

@@ -1,16 +1,16 @@
 import {
   <%= model_short_name %>,
-  <%= model_short_name %>AttributesType
+  type <%= model_short_name %>AttributesType
 } from "./<%= model_short_name %>/<%= model_short_name %>"
 
 <% if has_associations? %>
 import {
   <%= model_short_name %>Atom,
-  <%= model_short_name %>AtomAttributesType
+  type <%= model_short_name %>AtomAttributesType
 } from "./<%= model_short_name %>/Atom"
 import {
   <%= model_short_name %>Aggregate,
-  <%= model_short_name %>AggregateAttributesType
+  type <%= model_short_name %>AggregateAttributesType
 } from "./<%= model_short_name %>/Aggregate"
 <% end %>
 

data/templates/Organization/config.ts.erb

@@ -1,4 +1,4 @@
-let _urlBase = process.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+let _urlBase = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
 
 const config = {
   get urlBase(): string {

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.erb

@@ -1,7 +1,7 @@
 import { type Outcome, SuccessfulOutcome, ErrorOutcome } from './Outcome'
 import { type FoobaraError } from './Error'
 <% if auto_dirty_queries? %>
-import * as QueryCache from './QueryCache'
+import { dirtyQuery } from './QueryCache'
 <% end %>
 
 export default abstract class RemoteCommand<Inputs, Result, CommandError extends FoobaraError> {
@@ -10,12 +10,12 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   static organizationName: string
   static domainName: string
 
-  // TODO: make use of domain's config instead of process.env directly.
+  // TODO: make use of domain's config instead of import.meta.env directly.
   static get urlBase (): string {
     let base = this._urlBase
 
     if (base == null) {
-      base = process.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
+      base = import.meta.env.REACT_APP_FOOBARA_GLOBAL_URL_BASE
     }
 
     if (base == null) {
@@ -136,19 +136,13 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   <% if auto_dirty_queries? %>
   dirtyQueries () {
     for (const [commandClass, inputs] of this.dirties()) {
-      QueryCache.forEachQuery((query) => {
-        // debugger
-        if (query.CommandClass === commandClass) {
-          if (inputs == null || Object.keys(inputs).length === 0) {
-            query.setDirty()
-          } else {
-            for (const [property, value] of Object.entries(inputs)) {
-              if (query.inputs[property] !== value) { return }
-            }
-            query.setDirty()
-          }
+      if (inputs != null) {
+        for (const [propertyName, value] of Object.entries(inputs)) {
+          dirtyQuery(commandClass, propertyName, value)
         }
-      })
+      } else {
+        dirtyQuery(commandClass)
+      }
     }
   }
   <% end %>

data/templates/hooks/useQuery.ts

@@ -4,7 +4,7 @@ import {
   type InputsOf, type ResultOf, type ErrorOf, type RemoteCommandConstructor
 } from '../base/RemoteCommandTypes'
 import type Query from '../base/Query'
-import { useState, useRef, useEffect } from 'react'
+import { useState, useEffect } from 'react'
 import { getQuery } from '../base/QueryCache'
 
 interface QueryState<CommandT extends RemoteCommand<any, any, any>> {
@@ -43,14 +43,7 @@ export default function useQuery<CommandT extends RemoteCommand<any, any, any>>
   CommandClass: RemoteCommandConstructor<CommandT>,
   inputs: InputsOf<CommandT> | undefined = undefined
 ): QueryState<CommandT> {
-  const queryRef = useRef<Query<CommandT>>(null)
-
-  let query = queryRef.current
-
-  if (query == null) {
-    query = getQuery(CommandClass, inputs)
-    queryRef.current = query
-  }
+  const [query] = useState<Query<CommandT>>(() => getQuery(CommandClass, inputs))
 
   const [queryState, setQueryState] = useState<QueryState<CommandT>>(
     queryToQueryState<CommandT>(query)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Miles Georgi