@try-works/dsh-model-as-tool 0.1.2 → 0.3.6

package/client/client.model-tools.js

@@ -0,0 +1,592 @@
+// Generated by scripts/gen-remote-artifacts.mjs from remote/spec.mjs — do not edit.
+//
+// The package-local chunk the browser half loads with
+// require.async('./client.model-tools.js'). It carries the same strict descriptors as
+// the ESM ./remote artifact; see remote/spec.mjs for the wire contract.
+window.__ModuleLoader__.load({
+  id: "@try-works/dsh-model-as-tool",
+  chunk: "client.model-tools.js",
+  factory(require) {
+    var module = { exports: {} }
+    var exports = module.exports
+    Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' })
+
+    const PACKAGE = "@try-works/dsh-model-as-tool"
+    const SERVICE = "modelTools"
+    const NAMESPACE = "modelTools"
+    const INSTALL_WIRE_METHOD = "installExtension"
+
+    function parseModelToolsValue(schema, value) {
+  switch (schema.kind) {
+    case 'string':
+      if (typeof value !== 'string') throw new TypeError('expected a string')
+      return value
+    case 'boolean':
+      if (typeof value !== 'boolean') throw new TypeError('expected a boolean')
+      return value
+    case 'number':
+      if (typeof value !== 'number' || !Number.isFinite(value)) throw new TypeError('expected a finite number')
+      return value
+    case 'null':
+      if (value !== null) throw new TypeError('expected null')
+      return null
+    case 'literal':
+      if (value !== schema.value) throw new TypeError('expected ' + JSON.stringify(schema.value))
+      return value
+    case 'optional':
+      return value === undefined ? undefined : parseModelToolsValue(schema.of, value)
+    case 'nullable':
+      return value === null ? null : parseModelToolsValue(schema.of, value)
+    case 'array':
+      if (!Array.isArray(value)) throw new TypeError('expected an array')
+      return value.map((item) => parseModelToolsValue(schema.of, item))
+    case 'record': {
+      if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        throw new TypeError('expected a string-keyed record')
+      }
+      const parsed = {}
+      for (const [key, item] of Object.entries(value)) parsed[key] = parseModelToolsValue(schema.of, item)
+      return parsed
+    }
+    case 'object': {
+      if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+        throw new TypeError('expected an object')
+      }
+      const parsed = {}
+      for (const [key, field] of Object.entries(schema.fields)) {
+        const raw = value[key]
+        if (field.kind === 'optional') {
+          const item = parseModelToolsValue(field, raw)
+          if (item !== undefined) parsed[key] = item
+          continue
+        }
+        if (raw === undefined) throw new TypeError('missing field ' + JSON.stringify(key))
+        parsed[key] = parseModelToolsValue(field, raw)
+      }
+      return parsed
+    }
+    case 'union': {
+      let last
+      for (const variant of schema.of) {
+        try {
+          return parseModelToolsValue(variant, value)
+        } catch (error) {
+          last = error
+        }
+      }
+      throw new TypeError('value matched no union variant: ' + last.message)
+    }
+    default:
+      throw new TypeError('unknown schema kind ' + JSON.stringify(schema.kind))
+  }
+}
+
+    function codecForModelToolsValue(typeSymbol, schema) {
+  let parser
+  return {
+    mode: 'strict',
+    typeSymbol,
+    create: () => (parser ??= { parse: (value) => parseModelToolsValue(schema, value) }),
+  }
+}
+
+    function descriptorsFromModelToolsSpecs(packageName, serviceKey, namespace, specs) {
+  return specs.map((spec) => {
+    const descriptor = {
+      id: packageName + '#' + namespace + '/' + spec.method,
+      service: serviceKey,
+      namespace,
+      method: spec.method,
+      description: spec.description,
+      invocation: { kind: 'direct' },
+      parameters: spec.parameters.map((parameter) => {
+        const entry = {
+          name: parameter.name,
+          wire: parameter.wire,
+          source: 'json',
+          codec: codecForModelToolsValue(parameter.typeSymbol, parameter.schema),
+          strictCodec: codecForModelToolsValue(parameter.strictTypeSymbol, parameter.schema),
+        }
+        if (parameter.description !== undefined) entry.description = parameter.description
+        if (parameter.acceptsUndefined === true) entry.acceptsUndefined = true
+        return entry
+      }),
+      cancellation: { parameter: 'signal' },
+      result: {
+        mode: 'strict',
+        typeSymbol: spec.result.typeSymbol,
+        create: codecForModelToolsValue(spec.result.typeSymbol, spec.result.schema).create,
+        description: spec.result.description,
+      },
+    }
+    if (spec.implementation !== undefined) descriptor.implementation = spec.implementation
+    return descriptor
+  })
+}
+
+    const METHOD_SPECS = [
+  {
+    "method": "describe",
+    "description": "Read the current extension state; the page calls it on mount and after each action.",
+    "parameters": [],
+    "result": {
+      "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/describe:result",
+      "description": "the extension surface as the host currently sees it.",
+      "schema": {
+        "kind": "object",
+        "fields": {
+          "store": {
+            "kind": "nullable",
+            "of": {
+              "kind": "string"
+            }
+          },
+          "writable": {
+            "kind": "boolean"
+          },
+          "sourceDir": {
+            "kind": "nullable",
+            "of": {
+              "kind": "string"
+            }
+          },
+          "extensions": {
+            "kind": "array",
+            "of": {
+              "kind": "object",
+              "fields": {
+                "id": {
+                  "kind": "string"
+                },
+                "package": {
+                  "kind": "nullable",
+                  "of": {
+                    "kind": "string"
+                  }
+                },
+                "version": {
+                  "kind": "nullable",
+                  "of": {
+                    "kind": "string"
+                  }
+                },
+                "installed": {
+                  "kind": "boolean"
+                },
+                "active": {
+                  "kind": "boolean"
+                },
+                "disabled": {
+                  "kind": "boolean"
+                },
+                "integrity": {
+                  "kind": "union",
+                  "of": [
+                    {
+                      "kind": "literal",
+                      "value": "unchanged"
+                    },
+                    {
+                      "kind": "literal",
+                      "value": "changed"
+                    },
+                    {
+                      "kind": "literal",
+                      "value": "unknown"
+                    }
+                  ]
+                },
+                "tools": {
+                  "kind": "array",
+                  "of": {
+                    "kind": "string"
+                  }
+                },
+                "reason": {
+                  "kind": "nullable",
+                  "of": {
+                    "kind": "string"
+                  }
+                },
+                "requirements": {
+                  "kind": "optional",
+                  "of": {
+                    "kind": "array",
+                    "of": {
+                      "kind": "object",
+                      "fields": {
+                        "kind": {
+                          "kind": "union",
+                          "of": [
+                            {
+                              "kind": "literal",
+                              "value": "store"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "source"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "dependencies"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "assets"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "executable"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "harness-model"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "platform"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "integrity"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "activation"
+                            }
+                          ]
+                        },
+                        "satisfied": {
+                          "kind": "boolean"
+                        },
+                        "reason": {
+                          "kind": "string"
+                        },
+                        "action": {
+                          "kind": "union",
+                          "of": [
+                            {
+                              "kind": "literal",
+                              "value": "install"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "prepare"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "enable"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "config"
+                            },
+                            {
+                              "kind": "literal",
+                              "value": "none"
+                            }
+                          ]
+                        }
+                      }
+                    }
+                  }
+                },
+                "blocked": {
+                  "kind": "optional",
+                  "of": {
+                    "kind": "boolean"
+                  }
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  {
+    "method": "installExtension",
+    "implementation": "install",
+    "description": "Install one extension from `source`, or the configured first-party source.",
+    "parameters": [
+      {
+        "name": "id",
+        "wire": "id",
+        "description": "the extension id, for example `@try-works/extension-laya`.",
+        "acceptsUndefined": false,
+        "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/install:id",
+        "strictTypeSymbol": "@try-works/dsh-model-as-tool#modelTools/install:id",
+        "schema": {
+          "kind": "string"
+        }
+      },
+      {
+        "name": "source",
+        "wire": "source",
+        "description": "an explicit install directory; absent means the configured first-party source.",
+        "acceptsUndefined": true,
+        "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/install:source",
+        "strictTypeSymbol": "@try-works/dsh-model-as-tool#modelTools/install:source",
+        "schema": {
+          "kind": "optional",
+          "of": {
+            "kind": "string"
+          }
+        }
+      }
+    ],
+    "result": {
+      "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/install:result",
+      "description": "the installed extension; installation is not activation.",
+      "schema": {
+        "kind": "object",
+        "fields": {
+          "id": {
+            "kind": "string"
+          },
+          "version": {
+            "kind": "string"
+          },
+          "active": {
+            "kind": "boolean"
+          }
+        }
+      }
+    }
+  },
+  {
+    "method": "enable",
+    "description": "Activate an installed extension (removes it from `disabledExtensions`).",
+    "parameters": [
+      {
+        "name": "id",
+        "wire": "id",
+        "description": "the extension id to activate.",
+        "acceptsUndefined": false,
+        "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/enable:id",
+        "strictTypeSymbol": "@try-works/dsh-model-as-tool#modelTools/enable:id",
+        "schema": {
+          "kind": "string"
+        }
+      }
+    ],
+    "result": {
+      "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/enable:result",
+      "description": "the extension state after activation.",
+      "schema": {
+        "kind": "object",
+        "fields": {
+          "id": {
+            "kind": "string"
+          },
+          "active": {
+            "kind": "boolean"
+          },
+          "disabled": {
+            "kind": "boolean"
+          }
+        }
+      }
+    }
+  },
+  {
+    "method": "disable",
+    "description": "Deactivate an extension (adds it to `disabledExtensions`).",
+    "parameters": [
+      {
+        "name": "id",
+        "wire": "id",
+        "description": "the extension id to deactivate.",
+        "acceptsUndefined": false,
+        "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/disable:id",
+        "strictTypeSymbol": "@try-works/dsh-model-as-tool#modelTools/disable:id",
+        "schema": {
+          "kind": "string"
+        }
+      }
+    ],
+    "result": {
+      "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/disable:result",
+      "description": "the extension state after deactivation.",
+      "schema": {
+        "kind": "object",
+        "fields": {
+          "id": {
+            "kind": "string"
+          },
+          "active": {
+            "kind": "boolean"
+          },
+          "disabled": {
+            "kind": "boolean"
+          }
+        }
+      }
+    }
+  },
+  {
+    "method": "prepare",
+    "description": "Acquire and verify the installed extension's model assets, then record the readiness a following enable needs.",
+    "parameters": [
+      {
+        "name": "id",
+        "wire": "id",
+        "description": "the installed extension id to prepare.",
+        "acceptsUndefined": false,
+        "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/prepare:id",
+        "strictTypeSymbol": "@try-works/dsh-model-as-tool#modelTools/prepare:id",
+        "schema": {
+          "kind": "string"
+        }
+      }
+    ],
+    "result": {
+      "typeSymbol": "@try-works/dsh-model-as-tool#modelTools/prepare:result",
+      "description": "the preparation outcome, its RES-02 disclosure, and the readiness recorded for each declared model.",
+      "schema": {
+        "kind": "object",
+        "fields": {
+          "id": {
+            "kind": "string"
+          },
+          "prepared": {
+            "kind": "boolean"
+          },
+          "reason": {
+            "kind": "nullable",
+            "of": {
+              "kind": "string"
+            }
+          },
+          "plan": {
+            "kind": "nullable",
+            "of": {
+              "kind": "object",
+              "fields": {
+                "modelId": {
+                  "kind": "string"
+                },
+                "modelRevision": {
+                  "kind": "string"
+                },
+                "assets": {
+                  "kind": "array",
+                  "of": {
+                    "kind": "object",
+                    "fields": {
+                      "assetId": {
+                        "kind": "string"
+                      },
+                      "bytes": {
+                        "kind": "number"
+                      },
+                      "source": {
+                        "kind": "string"
+                      },
+                      "executable": {
+                        "kind": "boolean"
+                      }
+                    }
+                  }
+                },
+                "totalBytes": {
+                  "kind": "number"
+                },
+                "storageBytes": {
+                  "kind": "number"
+                },
+                "requiresExecutableApproval": {
+                  "kind": "boolean"
+                },
+                "license": {
+                  "kind": "object",
+                  "fields": {
+                    "name": {
+                      "kind": "string"
+                    },
+                    "url": {
+                      "kind": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "readiness": {
+            "kind": "record",
+            "of": {
+              "kind": "union",
+              "of": [
+                {
+                  "kind": "literal",
+                  "value": "unavailable"
+                },
+                {
+                  "kind": "literal",
+                  "value": "needs-preparation"
+                },
+                {
+                  "kind": "literal",
+                  "value": "preparing"
+                },
+                {
+                  "kind": "literal",
+                  "value": "prepared-cold"
+                },
+                {
+                  "kind": "literal",
+                  "value": "loading"
+                },
+                {
+                  "kind": "literal",
+                  "value": "ready"
+                },
+                {
+                  "kind": "literal",
+                  "value": "busy"
+                },
+                {
+                  "kind": "literal",
+                  "value": "failed"
+                }
+              ]
+            }
+          },
+          "groups": {
+            "kind": "array",
+            "of": {
+              "kind": "string"
+            }
+          },
+          "activationReady": {
+            "kind": "boolean"
+          }
+        }
+      }
+    }
+  }
+]
+
+    const contribution = {
+      package: PACKAGE,
+      descriptors: descriptorsFromModelToolsSpecs(PACKAGE, SERVICE, NAMESPACE, METHOD_SPECS),
+    }
+
+    /**
+     * Mount the contribution in the calling client plugin's fiber.
+     * @param ctx - the client Cordis context whose Remote service is available.
+     * @returns null when this Host/assembly has no Client Remote service, else
+     *   the Remote service and the namespace disposer.
+     */
+    async function mount(ctx) {
+      const remote = typeof ctx?.get === 'function' ? ctx.get('remote') : undefined
+      if (remote === undefined || remote === null || typeof remote.$mount !== 'function') return null
+      const dispose = await remote.$mount(contribution)
+      return { remote, dispose }
+    }
+
+    exports.contribution = contribution
+    exports.mount = mount
+    return module.exports
+  },
+})