foobara-typescript-remote-command-generator 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9636a0e5c388533ffbff27af94716f4331f37b8b4e0c2261de0e1d42105e7e83
-  data.tar.gz: c78a86ed94e77fdd6f15e11784dd2decc99c699a0e69de8b0d694b05bfaa4189
+  metadata.gz: 5045b4f54238822deb4764d5ea2f259b482c3350c20e348472b20d30fd1feb83
+  data.tar.gz: 24187f3f79dc8fcd275ff4a8b98010dbac41128b4a6dd92faaf073544746eb7c
 SHA512:
-  metadata.gz: 63441cad1c78b161556fa5cab4477960e5f35bca1bd0871440b5b8e880b2b9f50ec8d81e9ecc122b8211f583cdae993af70c8c3a63f506ec44b9f9329dd5b2aa
-  data.tar.gz: 671c9580a817b76939d2acfb0a9ae12c5da0a442c41ff05fb2307e5b7d8c728b2ba06bfcb9412d281690f2fbef5986e92244dcb8eece6947e031dd49a2432c92
+  metadata.gz: ae7f0d944f64a64faf54c8cc78f9d0afc53f9c4e857c75efff8993c3132ecefcaa96aec799909444f80dd38b3023db947ab3381a116f298e365b2fb0455432e3
+  data.tar.gz: 8b8b124b10f82ce701b48216f338561b7104d44b45f0793148df2d0545d41947cde9d5b12dd2dea4796c9a5c79005d4f9489ebc6f52cbf68d39cf1698b863b26

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## [0.0.13] - 2025-03-17
+
+- Fix bug incorrectly generating model typescript for detached entities
+- Fix bug preventing Loaded/Unloaded entity import from being destructured properly
+- Handle errors with prefixes
+- Include custom types and models in error generator dependencies
+- Fix bug preventing allow_nil from having an effect
+
+## [0.0.12] - 2025-03-02
+
+- Add ability to ask RemoteCommand for its state and outcome
+
 ## [0.0.11] - 2025-02-26
 
 - Implement support for command result types that are arrays

data/src/remote_generator/services/error_generator.rb

@@ -9,17 +9,17 @@ module Foobara
         def target_path
           p = parent
 
-          basename = "#{error_name}.ts"
+          basename = "#{error_name}.ts".split("::")
 
           case parent
           when OrganizationGenerator, DomainGenerator, CommandGenerator
-            [*p.target_dir, "errors", basename]
+            [*p.target_dir, "errors", *basename]
           when nil
             # :nocov:
             raise "Expected #{error_name} to have a parent but it did not"
             # :nocov:
           else
-            [*p.target_dir, basename]
+            [*p.target_dir, *basename]
           end
         end
 
@@ -50,8 +50,7 @@ module Foobara
         end
 
         def dependencies
-          # Why don't we need models and custom types?
-          types_depended_on.select(&:detached_entity?)
+          types_depended_on.select { |type| type.detached_entity? || type.custom? || type.model? }
         end
 
         def ts_type_full_path

data/src/remote_generator/services/loaded_entity_generator.rb

@@ -21,6 +21,10 @@ module Foobara
           *prefix, name = super
           [*prefix, "Loaded#{name}"]
         end
+
+        def import_destructure
+          "{ Loaded#{scoped_short_name} }"
+        end
       end
     end
   end

data/src/remote_generator/services/type_generator.rb

@@ -76,7 +76,7 @@ module Foobara
                    # :nocov:
                  end
 
-          if declaration_data["allows_nil"]
+          if declaration_data["allow_nil"]
             # TODO: add a custom type to the fixture manifest that includes allows_nil
             # :nocov:
             guts += " | undefined"

data/src/remote_generator/services/typescript_from_manifest_base_generator.rb

@@ -48,7 +48,7 @@ module Foobara
                 Services::OrganizationConfigGenerator,
                 Services::OrganizationManifestGenerator
               ]
-            when Manifest::Entity
+            when Manifest::Entity, Manifest::DetachedEntity
               [
                 Services::EntityGenerator,
                 Services::EntityVariantsGenerator,

data/src/remote_generator/services/unloaded_entity_generator.rb

@@ -14,6 +14,10 @@ module Foobara
           *prefix, name = super
           [*prefix, "Unloaded#{name}"]
         end
+
+        def import_destructure
+          "{ Unloaded#{scoped_short_name} }"
+        end
       end
     end
   end

data/templates/Error.ts.erb

@@ -4,5 +4,5 @@ import <%= dependency_root.import_destructure %> from "<%= path_to_root %><%= de
 
 import { <%= error_base_class %> } from "<%= path_to_root %>base/Error"
 
-export class <%= error_name %> extends <%= error_base_class %><<%= context_ts_type %>> {
+export class <%= short_error_name %> extends <%= error_base_class %><<%= context_ts_type %>> {
 }

data/templates/base/RemoteCommand.ts

@@ -1,6 +1,8 @@
 import { type Outcome, SuccessfulOutcome, ErrorOutcome } from './Outcome'
 import { type FoobaraError } from './Error'
 
+export type commandState = 'initialized' | 'executing' | 'succeeded' | 'errored' | 'failed'
+
 export default abstract class RemoteCommand<Inputs, Result, CommandError extends FoobaraError> {
   static _urlBase: string | undefined
   static commandName: string
@@ -16,7 +18,7 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
     }
 
     if (base == null) {
-      throw new Error("urlBase is not set and REACT_APP_FOOBARA_GLOBAL_URL_BASE is undefined")
+      throw new Error('urlBase is not set and REACT_APP_FOOBARA_GLOBAL_URL_BASE is undefined')
     }
 
     return base
@@ -35,9 +37,13 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   }
 
   inputs: Inputs
+  outcome: null | Outcome<Result, CommandError>
+  commandState: commandState
 
   constructor (inputs: Inputs) {
     this.inputs = inputs
+    this.commandState = 'initialized'
+    this.outcome = null
   }
 
   get commandName (): string {
@@ -51,10 +57,10 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   static get fullCommandName (): string {
     const path = []
 
-    if (this.organizationName != null && this.organizationName !== "GlobalOrganization") {
+    if (this.organizationName != null && this.organizationName !== 'GlobalOrganization') {
       path.push(this.organizationName)
     }
-    if (this.domainName != null && this.domainName !== "GlobalDomain") {
+    if (this.domainName != null && this.domainName !== 'GlobalDomain') {
       path.push(this.domainName)
     }
     if (this.commandName != null) {
@@ -70,18 +76,26 @@ export default abstract class RemoteCommand<Inputs, Result, CommandError extends
   async run (): Promise<Outcome<Result, CommandError>> {
     const url = `${this.urlBase}/run/${this.fullCommandName}`
 
+    this.commandState = 'executing'
     const response = await fetch(url, {
       method: 'POST',
       headers: { 'Content-Type': 'application/json' },
       body: JSON.stringify(this.inputs)
     })
 
+    const body = await response.json()
+
     if (response.ok) {
-      return new SuccessfulOutcome<Result, CommandError>(await response.json())
+      this.commandState = 'succeeded'
+      this.outcome = new SuccessfulOutcome<Result, CommandError>(body)
     } else if (response.status === 422) {
-      return new ErrorOutcome<Result, CommandError>(await response.json())
+      this.commandState = 'errored'
+      this.outcome = new ErrorOutcome<Result, CommandError>(body)
     } else {
+      this.commandState = 'failed'
       throw new Error(`not sure how to handle ${await response.text()}`)
     }
+
+    return this.outcome
   }
 }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: foobara-typescript-remote-command-generator
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.13
 platform: ruby
 authors:
 - Miles Georgi
 bindir: bin
 cert_chain: []
-date: 2025-02-26 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: foobara
@@ -134,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.3
+rubygems_version: 3.6.5
 specification_version: 4
 summary: Generates remote commands for Typescript from a foobara manifest
 test_files: []