UncountablePythonSDK 0.0.115__py3-none-any.whl → 0.0.116__py3-none-any.whl

examples/integration-server/jobs/materials_auto/example_http.py

@@ -19,17 +19,17 @@ class HttpExample(CustomHttpJob):
     @staticmethod
     def validate_request(
         *,
-        request: GenericHttpRequest,
-        job_definition: job_definition_t.HttpJobDefinitionBase,
-        profile_meta: job_definition_t.ProfileMetadata,
+        request: GenericHttpRequest,  # noqa: ARG004
+        job_definition: job_definition_t.HttpJobDefinitionBase,  # noqa: ARG004
+        profile_meta: job_definition_t.ProfileMetadata,  # noqa: ARG004
     ) -> None:
         return None
 
     @staticmethod
     def handle_request(
         *,
-        request: GenericHttpRequest,
-        job_definition: job_definition_t.HttpJobDefinitionBase,
-        profile_meta: job_definition_t.ProfileMetadata,
+        request: GenericHttpRequest,  # noqa: ARG004
+        job_definition: job_definition_t.HttpJobDefinitionBase,  # noqa: ARG004
+        profile_meta: job_definition_t.ProfileMetadata,  # noqa: ARG004
     ) -> GenericHttpResponse:
         return GenericHttpResponse(response="OK", status_code=200)

examples/integration-server/jobs/materials_auto/example_instrument.py

@@ -0,0 +1,38 @@
+from dataclasses import dataclass
+
+from uncountable.integration.job import JobArguments, WebhookJob, register_job
+from uncountable.types import base_t, entity_t, job_definition_t
+
+
+@dataclass(kw_only=True)
+class InstrumentPayload:
+    equipment_id: base_t.ObjectId
+
+
+@register_job
+class InstrumentExample(WebhookJob[InstrumentPayload]):
+    def run(
+        self, args: JobArguments, payload: InstrumentPayload
+    ) -> job_definition_t.JobResult:
+        equipment_data = args.client.get_entities_data(
+            entity_type=entity_t.EntityType.EQUIPMENT,
+            entity_ids=[payload.equipment_id],
+        ).entity_details[0]
+
+        # Load the instrument's connection details from the entity
+        instrument_id = None
+        for field in equipment_data.field_values:
+            if field.field_ref_name == "ins_instrument_id":
+                instrument_id = field.value
+
+        if instrument_id is None:
+            args.logger.log_error("Could not find instrument ID")
+            return job_definition_t.JobResult(success=False)
+
+        args.logger.log_info(f"Instrument ID: {instrument_id}")
+
+        return job_definition_t.JobResult(success=True)
+
+    @property
+    def webhook_payload_type(self) -> type:
+        return InstrumentPayload

examples/integration-server/jobs/materials_auto/profile.yaml

@@ -75,3 +75,12 @@ jobs:
     executor:
       type: script
       import_path: example_runsheet_wh
+  - id: example_instrument
+    type: webhook
+    name: Webhook Instrument Connection
+    signature_key_secret:
+      type: env
+      env_key: WH_INSTRUMENT_SIGNATURE_KEY
+    executor:
+      type: script
+      import_path: example_instrument

pkgs/type_spec/builder.py

@@ -15,12 +15,23 @@ from typing import Any, Self
 from . import util
 from .cross_output_links import CrossOutputPaths
 from .non_discriminated_union_exceptions import NON_DISCRIMINATED_UNION_EXCEPTIONS
-from .util import parse_type_str, unused
+from .util import parse_type_str
 
 RawDict = dict[Any, Any]
 EndpointKey = str
 
 
+class PathMapping(StrEnum):
+    NO_MAPPING = "no_mapping"
+    DEFAULT_MAPPING = "default_mapping"
+
+
+@dataclass(kw_only=True)
+class APIEndpointInfo:
+    root_path: str
+    path_mapping: PathMapping
+
+
 class StabilityLevel(StrEnum):
     """These are currently used for open api,
     see: https://github.com/Tufin/oasdiff/blob/main/docs/STABILITY.md
@@ -835,7 +846,7 @@ class _EndpointPathDetails:
 
 
 def _resolve_endpoint_path(
-    path: str, api_endpoints: dict[EndpointKey, str]
+    path: str, api_endpoints: dict[EndpointKey, APIEndpointInfo]
 ) -> _EndpointPathDetails:
     root_path_source = path.split("/")[0]
     root_match = RE_ENDPOINT_ROOT.fullmatch(root_path_source)
@@ -843,7 +854,7 @@ def _resolve_endpoint_path(
         raise Exception(f"invalid-api-path-root:{root_path_source}")
 
     root_var = root_match.group(1)
-    root_path = api_endpoints[root_var]
+    root_path = api_endpoints[root_var].root_path
 
     _, *rest_path = path.split("/", 1)
     resolved_path = "/".join([root_path] + rest_path)
@@ -911,6 +922,7 @@ class SpecEndpoint:
     stability_level: StabilityLevel | None
     # Don't emit TypeScript endpoint code
     suppress_ts: bool
+    deprecated: bool = False
     async_batch_path: str | None = None
     result_type: ResultType = ResultType.json
     has_attachment: bool = False
@@ -928,13 +940,13 @@ class SpecEndpoint:
         pass
 
     def process(self, builder: SpecBuilder, data: RawDict) -> None:
-        unused(builder)
         util.check_fields(
             data,
             [
                 "method",
                 "path",
                 "data_loader",
+                "deprecated",
                 "is_sdk",
                 "stability_level",
                 "async_batch_path",
@@ -954,6 +966,7 @@ class SpecEndpoint:
         data_loader = data.get("data_loader", False)
         assert isinstance(data_loader, bool)
         self.data_loader = data_loader
+        self.deprecated = data.get("deprecated", False)
 
         is_sdk = data.get("is_sdk", EndpointEmitType.EMIT_NOTHING)
 
@@ -1346,7 +1359,7 @@ class SpecBuilder:
     def __init__(
         self,
         *,
-        api_endpoints: dict[EndpointKey, str],
+        api_endpoints: dict[EndpointKey, APIEndpointInfo],
         top_namespace: str,
         cross_output_paths: CrossOutputPaths | None,
     ) -> None:

pkgs/type_spec/config.py

@@ -4,6 +4,7 @@ from dataclasses import dataclass
 from typing import Self, TypeVar
 
 from pkgs.serialization import yaml
+from pkgs.type_spec.builder import APIEndpointInfo, EndpointKey
 
 ConfigValueType = str | None | Mapping[str, str | None] | list[str]
 
@@ -19,6 +20,22 @@ def _parse_string_lookup(
     }
 
 
+VT = TypeVar("VT")
+
+
+def _parse_data_lookup(
+    key: str,
+    raw_value: ConfigValueType,
+    conv_func: type[VT],
+) -> dict[str, VT]:
+    assert isinstance(raw_value, dict), f"{key} must be key/values"
+    return {
+        k: conv_func(**v)
+        for k, v in raw_value.items()
+        if v is not None and isinstance(v, dict)
+    }
+
+
 @dataclass(kw_only=True)
 class BaseLanguageConfig:
     types_output: (
@@ -31,7 +48,9 @@ class BaseLanguageConfig:
 
 @dataclass(kw_only=True)
 class TypeScriptConfig(BaseLanguageConfig):
-    routes_output: str  # folder for generate route files will be located.
+    endpoint_to_routes_output: dict[
+        EndpointKey, str
+    ]  # folder for generate route files will be located.
     type_info_output: str  # folder for generated type info files
     id_source_output: str | None = None  # folder for emitted id source maps.
     endpoint_to_frontend_app_type: dict[
@@ -39,7 +58,7 @@ class TypeScriptConfig(BaseLanguageConfig):
     ]  # map from api_endpoint to frontend app type
 
     def __post_init__(self: Self) -> None:
-        self.routes_output = self.routes_output
+        self.endpoint_to_routes_output = self.endpoint_to_routes_output
         self.type_info_output = os.path.abspath(self.type_info_output)
         self.id_source_output = (
             os.path.abspath(self.id_source_output)
@@ -100,7 +119,7 @@ class OpenAPIConfig(BaseLanguageConfig):
 class Config:
     top_namespace: str
     type_spec_types: list[str]  # folders containing the yaml type spec definitions
-    api_endpoint: dict[str, str]
+    api_endpoint: dict[str, APIEndpointInfo]
     # languages
     typescript: TypeScriptConfig | None
     python: PythonConfig
@@ -125,8 +144,10 @@ def parse_yaml_config(config_file: str) -> Config:
     )
     type_spec_types = [os.path.abspath(folder) for folder in raw_type_spec_types]
 
-    api_endpoint = _parse_string_lookup(
-        "api_endpoint", raw_config.get("api_endpoint", {}), lambda x: x
+    api_endpoint = _parse_data_lookup(
+        "api_endpoint",
+        raw_config.get("api_endpoint", {}),
+        APIEndpointInfo,
     )
 
     raw_typescript = raw_config.get("typescript")

pkgs/type_spec/cross_output_links.py

@@ -21,7 +21,7 @@ def get_python_stub_file_path(
 class CrossOutputPaths:
     python_types_output: str
     typescript_types_output: str
-    typescript_routes_output: str
+    typescript_routes_output_by_endpoint: dict[str, str]
     typespec_files_input: list[str]
 
 
@@ -35,10 +35,9 @@ def get_python_api_file_path(
 def get_typescript_api_file_path(
     cross_output_paths: CrossOutputPaths,
     namespace: builder.SpecNamespace,
+    endpoint_key: builder.EndpointKey,
 ) -> str:
-    return (
-        f"{cross_output_paths.typescript_routes_output}/{'/'.join(namespace.path)}.tsx"
-    )
+    return f"{cross_output_paths.typescript_routes_output_by_endpoint[endpoint_key]}/{'/'.join(namespace.path)}.tsx"
 
 
 def get_yaml_api_file_path(
@@ -68,13 +67,16 @@ def get_path_links(
     namespace: builder.SpecNamespace,
     *,
     current_path_type: str,
+    endpoint: builder.SpecEndpoint,
 ) -> str:
     if cross_output_paths is None:
         return ""
 
     api_paths = {
         "Python": get_python_api_file_path(cross_output_paths, namespace),
-        "TypeScript": get_typescript_api_file_path(cross_output_paths, namespace),
+        "TypeScript": get_typescript_api_file_path(
+            cross_output_paths, namespace, endpoint.default_endpoint_key
+        ),
         "YAML": get_yaml_api_file_path(cross_output_paths, namespace),
     }
 
@@ -95,11 +97,11 @@ def get_path_links(
 
     if namespace.endpoint is not None:
         for (
-            endpoint,
+            endpoint_key,
             path_specific_endpoint,
         ) in namespace.endpoint.path_per_api_endpoint.items():
             path_from_root = get_python_stub_file_path(path_specific_endpoint.function)
             if path_from_root is None:
                 continue
-            paths_string += f"{comment_prefix} Implementation for {endpoint}: file://./{return_to_root_path}{path_from_root}\n"
+            paths_string += f"{comment_prefix} Implementation for {endpoint_key}: file://./{return_to_root_path}{path_from_root}\n"
     return paths_string

pkgs/type_spec/emit_open_api.py

@@ -261,6 +261,10 @@ def _emit_endpoint_parameters(
     } | _emit_endpoint_parameter_examples(examples)
 
 
+def _emit_endpoint_deprecated(deprecated: bool) -> DictApiSchema:
+    return {"deprecated": True} if deprecated else {}
+
+
 def _emit_stability_level(
     stability_level: EmitOpenAPIStabilityLevel | None,
 ) -> DictApiSchema:
@@ -376,6 +380,7 @@ def _emit_namespace(
                 "tags": endpoint.tags,
                 "summary": endpoint.summary,
             }
+            | _emit_endpoint_deprecated(endpoint.deprecated)
             | _emit_endpoint_description(endpoint.description, ctx.endpoint.guides)
             | _emit_stability_level(endpoint.stability_level)
             | _emit_endpoint_parameters(endpoint, argument_type, ctx.endpoint.examples)
@@ -474,8 +479,9 @@ def _emit_type(
         return
 
     if isinstance(stype, builder.SpecTypeDefnUnion):
-        ctx.types[stype.name] = open_api_type(
-            ctx, stype.get_backing_type(), config=config
+        ctx.types[stype.name] = OpenAPIUnionType(
+            [open_api_type(ctx, p, config=config) for p in stype.types],
+            discrimnator=stype.discriminator,
         )
         return
 
@@ -617,6 +623,7 @@ def _emit_endpoint(
         tags=[tag_name],
         summary=f"{'/'.join(namespace.path[path_cutoff:])}",
         description=description,
+        deprecated=namespace.endpoint.deprecated,
         stability_level=namespace.endpoint.stability_level,
         examples=[
             EmitOpenAPIEndpointExample(

pkgs/type_spec/emit_open_api_util.py

@@ -82,6 +82,7 @@ class EmitOpenAPIEndpoint:
     tags: list[str]
     summary: str
     description: str
+    deprecated: bool
     stability_level: EmitOpenAPIStabilityLevel | None
     examples: list[EmitOpenAPIEndpointExample]
     guides: list[EmitOpenAPIGuide]

pkgs/type_spec/emit_python.py

@@ -357,7 +357,10 @@ def _emit_namespace(ctx: Context, namespace: builder.SpecNamespace) -> None:
     endpoint = namespace.endpoint
     if endpoint is not None:
         path_links = get_path_links(
-            ctx.builder.cross_output_paths, namespace, current_path_type="Python"
+            ctx.builder.cross_output_paths,
+            namespace,
+            current_path_type="Python",
+            endpoint=endpoint,
         )
         if path_links != "":
             ctx.out.write("\n")

pkgs/type_spec/emit_typescript.py

@@ -1,17 +1,18 @@
 import io
 import os
+from typing import assert_never
 
 from . import builder, util
-from .builder import EndpointKey, EndpointSpecificPath
+from .builder import EndpointKey, EndpointSpecificPath, PathMapping
 from .config import TypeScriptConfig
 from .cross_output_links import get_path_links
 from .emit_io_ts import emit_type_io_ts
 from .emit_typescript_util import (
     MODIFY_NOTICE,
     EmitTypescriptContext,
+    emit_constant_ts,
     emit_namespace_imports_ts,
     emit_type_ts,
-    emit_value_ts,
     resolve_namespace_name,
     resolve_namespace_ref,
     ts_type_name,
@@ -37,6 +38,7 @@ def _emit_types(builder: builder.SpecBuilder, config: TypeScriptConfig) -> None:
             out=io.StringIO(),
             namespace=namespace,
             cross_output_paths=builder.cross_output_paths,
+            api_endpoints=builder.api_endpoints,
         )
 
         _emit_namespace(ctx, config, namespace)
@@ -78,6 +80,7 @@ def _emit_types(builder: builder.SpecBuilder, config: TypeScriptConfig) -> None:
             full.write("\n")
             full.write(MODIFY_NOTICE)
             full.write(f"// === START section from {namespace.name}.ts.part ===\n")
+            full.write("\n")
             full.write(part)
             full.write(f"// === END section from {namespace.name}.ts.part ===\n")
 
@@ -112,7 +115,7 @@ def _emit_namespace(
             emit_type_ts(ctx, stype)
 
     for sconst in namespace.constants.values():
-        _emit_constant(ctx, sconst)
+        emit_constant_ts(ctx, sconst)
 
     if namespace.endpoint is not None:
         _emit_endpoint(ctx, config, namespace, namespace.endpoint)
@@ -145,7 +148,10 @@ def _emit_endpoint(
         assert endpoint.result_type == builder.ResultType.json
 
     paths_string = get_path_links(
-        ctx.cross_output_paths, namespace, current_path_type="TypeScript"
+        ctx.cross_output_paths,
+        namespace,
+        current_path_type="TypeScript",
+        endpoint=endpoint,
     )
 
     data_loader_head = ""
@@ -155,7 +161,7 @@ def _emit_endpoint(
         assert has_data
 
         data_loader_head = (
-            'import { buildApiDataLoader, argsKey } from "unc_base/data_manager"\n'
+            'import { argsKey, buildApiDataLoader } from "unc_base/data_manager"\n'
         )
         data_loader_body = (
             "\nexport const data = buildApiDataLoader(argsKey(), apiCall)\n"
@@ -175,38 +181,56 @@ def _emit_endpoint(
     unc_base_api_imports = (
         f"appSpecificApiPath, {wrap_name}" if has_multiple_endpoints else wrap_name
     )
+    path_mapping = ctx.api_endpoints[endpoint.default_endpoint_key].path_mapping
+
+    match path_mapping:
+        case PathMapping.NO_MAPPING:
+            path_mapping_part = (
+                "\n  { pathMapping: ApplicationT.APIPathMapping.noMapping },"
+            )
+        case PathMapping.DEFAULT_MAPPING:
+            path_mapping_part = ""
+        case _:
+            assert_never(path_mapping)
+
     unc_types_imports = (
-        'import { ApplicationT } from "unc_types"\n' if has_multiple_endpoints else ""
+        'import { ApplicationT } from "unc_types"\n'
+        if has_multiple_endpoints or path_mapping_part != ""
+        else ""
     )
 
     type_path = f"unc_types/{'/'.join(namespace.path)}"
 
     if is_binary:
-        tsx_response_part = f"""import {{ {unc_base_api_imports} }} from "unc_base/api"
-import type {{ Arguments }} from "{type_path}"
-{unc_types_imports}
+        tsx_response_head = f"""import {{ {unc_base_api_imports} }} from "unc_base/api"
+"""
+        tsx_response_part = f"""import type {{ Arguments }} from "{type_path}"
+
 export type {{ Arguments }}
 """
     elif has_data and endpoint.has_attachment:
-        tsx_response_part = f"""import {{ {unc_base_api_imports}, type AttachmentResponse }} from "unc_base/api"
-import type {{ Arguments, Data }} from "{type_path}"
-{unc_types_imports}
+        tsx_response_head = f"""import {{ type AttachmentResponse, {unc_base_api_imports} }} from "unc_base/api"
+"""
+        tsx_response_part = f"""import type {{ Arguments, Data }} from "{type_path}"
+
 export type {{ Arguments, Data }}
 export type Response = AttachmentResponse<Data>
 """
     elif has_data:
-        tsx_response_part = f"""import {{ {unc_base_api_imports}, type JsonResponse }} from "unc_base/api"
-import type {{ Arguments, Data }} from "{type_path}"
-{unc_types_imports}
+        tsx_response_head = f"""import {{ {unc_base_api_imports}, type JsonResponse }} from "unc_base/api"
+"""
+        tsx_response_part = f"""import type {{ Arguments, Data }} from "{type_path}"
+
 export type {{ Arguments, Data }}
 export type Response = JsonResponse<Data>
 """
 
     else:
         assert has_deprecated_result
-        tsx_response_part = f"""import {{ {unc_base_api_imports} }} from "unc_base/api"
-import type {{ Arguments, DeprecatedResult }} from "{type_path}"
-{unc_types_imports}
+        tsx_response_head = f"""import {{ {unc_base_api_imports} }} from "unc_base/api"
+"""
+        tsx_response_part = f"""import type {{ Arguments, DeprecatedResult }} from "{type_path}"
+
 export type {{ Arguments }}
 export type Response = DeprecatedResult
 """
@@ -247,18 +271,18 @@ export type Response = DeprecatedResult
 
     # tsx_api = f"""{MODIFY_NOTICE}
     tsx_api = f"""{MODIFY_NOTICE}{paths_string}
-{data_loader_head}{tsx_response_part}
+{tsx_response_head}{data_loader_head}{unc_types_imports}{tsx_response_part}
 export const apiCall = {wrap_call}(
-  {endpoint_path_part}
+  {endpoint_path_part}{path_mapping_part}
 )
 {data_loader_body}"""
 
-    output = f"{config.routes_output}/{'/'.join(namespace.path)}.tsx"
+    output = f"{config.endpoint_to_routes_output[endpoint.default_endpoint_key]}/{'/'.join(namespace.path)}.tsx"
     util.rewrite_file(output, tsx_api)
 
     # Hacky index support, until enough is migrated to regen entirely
     # Emits the import into the UI API index file
-    index_path = f"{config.routes_output}/{'/'.join(namespace.path[0:-1])}/index.tsx"
+    index_path = f"{config.endpoint_to_routes_output[endpoint.default_endpoint_key]}/{'/'.join(namespace.path[0:-1])}/index.tsx"
     api_name = f"Api{ts_type_name(namespace.path[0 - 1])}"
     if os.path.exists(index_path):
         with open(index_path) as index:
@@ -274,14 +298,6 @@ export const apiCall = {wrap_call}(
             index.write(f"export {{ {api_name} }}\n")
 
 
-def _emit_constant(ctx: EmitTypescriptContext, sconst: builder.SpecConstant) -> None:
-    ctx.out.write("\n\n")
-    ctx.out.write(MODIFY_NOTICE)
-    value = emit_value_ts(ctx, sconst.value_type, sconst.value)
-    const_name = sconst.name.upper()
-    ctx.out.write(f"export const {const_name} = {value}\n")
-
-
 def _emit_id_source(builder: builder.SpecBuilder, config: TypeScriptConfig) -> None:
     id_source_output = config.id_source_output
     if id_source_output is None:

pkgs/type_spec/emit_typescript_util.py

@@ -32,6 +32,7 @@ class EmitTypescriptContext:
     namespace: builder.SpecNamespace
     namespaces: set[builder.SpecNamespace] = field(default_factory=set)
     cross_output_paths: CrossOutputPaths | None = None
+    api_endpoints: dict[builder.EndpointKey, builder.APIEndpointInfo]
 
 
 def ts_type_name(name: str) -> str:
@@ -80,6 +81,12 @@ def emit_value_ts(
         if stype.defn_type.is_base_type(builder.BaseTypeName.s_dict):
             key_type = stype.parameters[0]
             value_type = stype.parameters[1]
+
+            if not key_type.is_base_type(
+                builder.BaseTypeName.s_string
+            ) and not isinstance(key_type, builder.SpecTypeDefnStringEnum):
+                raise Exception("invalid dict keys -- dict keys must be string or enum")
+
             return (
                 "{\n\t"
                 + ",\n\t".join(
@@ -106,6 +113,14 @@ def emit_value_ts(
     raise Exception("invalid constant type", value, stype, type(stype))
 
 
+def emit_constant_ts(ctx: EmitTypescriptContext, sconst: builder.SpecConstant) -> None:
+    ctx.out.write("\n\n")
+    ctx.out.write(MODIFY_NOTICE)
+    value = emit_value_ts(ctx, sconst.value_type, sconst.value)
+    const_name = sconst.name.upper()
+    ctx.out.write(f"export const {const_name} = {value}\n")
+
+
 def emit_type_ts(ctx: EmitTypescriptContext, stype: builder.SpecType) -> None:
     if not isinstance(stype, builder.SpecTypeDefn):
         return
@@ -118,6 +133,7 @@ def emit_type_ts(ctx: EmitTypescriptContext, stype: builder.SpecType) -> None:
 
     if isinstance(stype, builder.SpecTypeDefnExternal):
         assert not stype.is_exported, "expecting private names"
+        ctx.out.write("\n")
         ctx.out.write(stype.external_map["ts"])
         ctx.out.write("\n")
         return

pkgs/type_spec/load_types.py

@@ -46,7 +46,7 @@ def load_types(config: Config) -> SpecBuilder | None:
         cross_output_paths = CrossOutputPaths(
             python_types_output=config.python.types_output,
             typescript_types_output=config.typescript.types_output,
-            typescript_routes_output=config.typescript.routes_output,
+            typescript_routes_output_by_endpoint=config.typescript.endpoint_to_routes_output,
             typespec_files_input=config.type_spec_types,
             # IMPROVE not sure how to know which one is the correct one in emit_typescript
         )

pkgs/type_spec/open_api_util.py

@@ -223,13 +223,21 @@ class OpenAPIUnionType(OpenAPIType):
         base_types: list[OpenAPIType],
         description: str | None = None,
         nullable: bool = False,
+        discrimnator: str | None = None,
+        discriminator_map: dict[str, OpenAPIType] | None = None,
     ) -> None:
         self.base_types = base_types
+        self._discriminator = discrimnator
         super().__init__(description=description, nullable=nullable)
 
     def asdict(self) -> dict[str, object]:
         # TODO: use parents description and nullable
-        return {"oneOf": [base_type.asdict() for base_type in self.base_types]}
+        return {
+            "oneOf": [base_type.asdict() for base_type in self.base_types],
+            "discriminator": {"propertyName": self._discriminator}
+            if self._discriminator is not None
+            else None,
+        }
 
 
 class OpenAPIIntersectionType(OpenAPIType):

pkgs/type_spec/parts/base.ts.prepart

@@ -3,6 +3,7 @@
 // doesn't allow referring explicitly to global names (thus cannot override here)
 // IMPROVE: invert relationship for global.d.ts looks here instead
 import * as IO from 'io-ts';
+
 type localJsonScalar = JsonScalar
 type localJsonValue = JsonValue
 type localObjectId = ObjectId

pkgs/type_spec/ui_entry_actions/generate_ui_entry_actions.py

@@ -282,6 +282,7 @@ def generate_entry_actions_typescript(
     ctx = emit_typescript_util.EmitTypescriptContext(
         out=definition_buffer,
         namespace=index_namespace,
+        api_endpoints={},
     )
     builder.namespaces[index_namespace.name] = index_namespace
 

uncountable/types/api/entity/create_or_update_entity.py

@@ -35,6 +35,7 @@ class Arguments:
     definition_key: identifier_t.IdentifierKey
     field_values: list[field_values_t.FieldArgumentValue]
     entity_key: identifier_t.IdentifierKey | None = None
+    on_create_init_field_values: list[field_values_t.FieldArgumentValue] | None = None
 
 
 # DO NOT MODIFY -- This file is generated by type_spec

uncountable/types/async_batch_processor.py

@@ -258,10 +258,12 @@ class AsyncBatchProcessorBase(ABC):
         definition_key: identifier_t.IdentifierKey,
         field_values: list[field_values_t.FieldArgumentValue],
         entity_key: identifier_t.IdentifierKey | None = None,
+        on_create_init_field_values: list[field_values_t.FieldArgumentValue] | None = None,
         depends_on: list[str] | None = None,
     ) -> async_batch_t.QueuedAsyncBatchRequest:
         """Creates or updates field values for an entity
 
+        :param on_create_init_field_values: Field values set only when the entity is created (will be ignored if entity already exists)
         :param depends_on: A list of batch reference keys to process before processing this request
         """
         args = create_or_update_entity_t.Arguments(
@@ -269,6 +271,7 @@ class AsyncBatchProcessorBase(ABC):
             entity_type=entity_type,
             definition_key=definition_key,
             field_values=field_values,
+            on_create_init_field_values=on_create_init_field_values,
         )
         json_data = serialize_for_api(args)
 

uncountable/types/client_base.py

@@ -412,15 +412,18 @@ class ClientMethods(ABC):
         definition_key: identifier_t.IdentifierKey,
         field_values: list[field_values_t.FieldArgumentValue],
         entity_key: identifier_t.IdentifierKey | None = None,
+        on_create_init_field_values: list[field_values_t.FieldArgumentValue] | None = None,
     ) -> create_or_update_entity_t.Data:
         """Creates or updates field values for an entity
 
+        :param on_create_init_field_values: Field values set only when the entity is created (will be ignored if entity already exists)
         """
         args = create_or_update_entity_t.Arguments(
             entity_key=entity_key,
             entity_type=entity_type,
             definition_key=definition_key,
             field_values=field_values,
+            on_create_init_field_values=on_create_init_field_values,
         )
         api_request = APIRequest(
             method=create_or_update_entity_t.ENDPOINT_METHOD,

uncountable/types/entity_t.py

@@ -42,6 +42,7 @@ __all__: list[str] = [
         "condition_match": "Condition Match",
         "condition_parameter": "Condition Parameter",
         "condition_parameter_mat_family": "Condition Parameter Material Family",
+        "condition_parameter_matches": "Condition Parameter Matches",
         "condition_parameter_rule": "Condition Parameter Rule",
         "condition_parameter_value": "Condition Parameter Value",
         "constraint": "Constraint",
@@ -110,6 +111,7 @@ __all__: list[str] = [
         "output_calculation_entity_mapping": "Output Calculation Entity Mapping",
         "output_category_all": "Output Category",
         "output_condition": "Output Condition",
+        "output_condition_condition_parameter": "Output Condition Condition Parameter",
         "output_default_condition": "Output Default Condition",
         "output_condition_parameter": "Output Condition Parameter",
         "output_condition_parameter_analytical_method_category": "Output Condition Parameter Analytical Method Category",
@@ -138,6 +140,7 @@ __all__: list[str] = [
         "recipe_ingredient_actual": "Recipe Ingredient Actual",
         "recipe_ingredients_compounded": "Recipe Ingredients Compounded",
         "recipe_ingredients_compounded_calculation": "Recipe Ingredients Compounded Calculation",
+        "recipe_link": "Experiment Link",
         "recipe_output": "Recipe Output",
         "recipe_output_annotation": "Recipe Output Annotation",
         "recipe_output_metadata": "Recipe Output Metadata",
@@ -224,6 +227,7 @@ class EntityType(StrEnum):
     CONDITION_MATCH = "condition_match"
     CONDITION_PARAMETER = "condition_parameter"
     CONDITION_PARAMETER_MAT_FAMILY = "condition_parameter_mat_family"
+    CONDITION_PARAMETER_MATCHES = "condition_parameter_matches"
     CONDITION_PARAMETER_RULE = "condition_parameter_rule"
     CONDITION_PARAMETER_VALUE = "condition_parameter_value"
     CONSTRAINT = "constraint"
@@ -292,6 +296,7 @@ class EntityType(StrEnum):
     OUTPUT_CALCULATION_ENTITY_MAPPING = "output_calculation_entity_mapping"
     OUTPUT_CATEGORY_ALL = "output_category_all"
     OUTPUT_CONDITION = "output_condition"
+    OUTPUT_CONDITION_CONDITION_PARAMETER = "output_condition_condition_parameter"
     OUTPUT_DEFAULT_CONDITION = "output_default_condition"
     OUTPUT_CONDITION_PARAMETER = "output_condition_parameter"
     OUTPUT_CONDITION_PARAMETER_ANALYTICAL_METHOD_CATEGORY = "output_condition_parameter_analytical_method_category"
@@ -320,6 +325,7 @@ class EntityType(StrEnum):
     RECIPE_INGREDIENT_ACTUAL = "recipe_ingredient_actual"
     RECIPE_INGREDIENTS_COMPOUNDED = "recipe_ingredients_compounded"
     RECIPE_INGREDIENTS_COMPOUNDED_CALCULATION = "recipe_ingredients_compounded_calculation"
+    RECIPE_LINK = "recipe_link"
     RECIPE_OUTPUT = "recipe_output"
     RECIPE_OUTPUT_ANNOTATION = "recipe_output_annotation"
     RECIPE_OUTPUT_METADATA = "recipe_output_metadata"

{uncountablepythonsdk-0.0.115.dist-info → uncountablepythonsdk-0.0.116.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: UncountablePythonSDK
-Version: 0.0.115
+Version: 0.0.116
 Summary: Uncountable SDK
 Project-URL: Homepage, https://github.com/uncountableinc/uncountable-python-sdk
 Project-URL: Repository, https://github.com/uncountableinc/uncountable-python-sdk.git

{uncountablepythonsdk-0.0.115.dist-info → uncountablepythonsdk-0.0.116.dist-info}/RECORD

@@ -26,10 +26,11 @@ examples/upload_files.py,sha256=qMaSvMSdTMPOOP55y1AwEurc0SOdZAMvEydlqJPsGpg,432
 examples/integration-server/pyproject.toml,sha256=i4Px7I__asDvP4WlAd2PncfRRQ-U4t5xp0tqT9YYs3s,9149
 examples/integration-server/jobs/materials_auto/concurrent_cron.py,sha256=xsK3H9ZEaniedC2nJUB0rqOcFI8y-ojfl_nLSJb9AMM,312
 examples/integration-server/jobs/materials_auto/example_cron.py,sha256=7VVQ-UJsq3DbGpN3XPnorRVZYo-vCwbfSU3VVDluIzA,699
-examples/integration-server/jobs/materials_auto/example_http.py,sha256=h97_IBC5EQiAUA4A5xyPpgFIqPTZWKIhMpmVAgVZEBE,941
+examples/integration-server/jobs/materials_auto/example_http.py,sha256=eVq-Fss_AhmztxOMqqO-GYGF3KvPt1O5HbNwwC2arh8,1037
+examples/integration-server/jobs/materials_auto/example_instrument.py,sha256=6qq6a8S5soKC-ypVswZEhkLzB_mxd4dxCSIoXKrbGDs,1261
 examples/integration-server/jobs/materials_auto/example_runsheet_wh.py,sha256=_wILTnbzzLf9zrcQb_KQKytxxcya1ej6MqQnoUSS4fA,1180
 examples/integration-server/jobs/materials_auto/example_wh.py,sha256=PN-skP27yJwDZboWk5g5EZEc3AKfVayQLfnopjsDKJc,659
-examples/integration-server/jobs/materials_auto/profile.yaml,sha256=MNKRn09iaiNF8dxOZ7Y6558UW6aCZ-9l9hQAwzYN8zs,1685
+examples/integration-server/jobs/materials_auto/profile.yaml,sha256=btUdn8hStM6Zp4zr0kBI2lL461MqDdzfSuF4LvuSQ8k,1926
 pkgs/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/argument_parser/__init__.py,sha256=VWUOOtJ-ueRF2lkIJzgQe4xhBKR9IPkgf9vY28nF35s,870
@@ -63,29 +64,29 @@ pkgs/strenum_compat/__init__.py,sha256=wXRFeNvBm8RU6dy1PFJ5sRLgUIEeH_DVR95Sv5qpG
 pkgs/strenum_compat/strenum_compat.py,sha256=uOUAgpYTjHs1MX8dG81jRlyTkt3KNbkV_25zp7xTX2s,36
 pkgs/type_spec/__init__.py,sha256=h5DmJTca4QVV10sZR1x0-MlkZfuGYDfapR3zHvXfzto,19
 pkgs/type_spec/__main__.py,sha256=5bJaX9Y_-FavP0qwzhk-z-V97UY7uaezJTa1zhO_HHQ,1048
-pkgs/type_spec/builder.py,sha256=XqkKO-GxV2DLS_iDN9tnQJfNcefz5yMAwyjnMog87jE,54049
-pkgs/type_spec/config.py,sha256=K6WebgeI3Saew0IEBcm1s2fauw_CyvH183emVrNoUXg,5327
-pkgs/type_spec/cross_output_links.py,sha256=bVNn0a4LMVTRLg_zjtiHnoTwdINHfftjWoH6tGdxhlk,3124
+pkgs/type_spec/builder.py,sha256=17_hkJI5jDb_IGOHZCiZDJ8_er-amVH0-WRpqJb7hEE,54365
+pkgs/type_spec/config.py,sha256=m0Rky7Rg2jMglDPQChF30p5h5P86Ap1GObwzLzmypNE,5829
+pkgs/type_spec/cross_output_links.py,sha256=ttFNfuQmR3sNnPSeUER5IPgLiYc-FB5gjlf7RyFYMpc,3293
 pkgs/type_spec/emit_io_ts.py,sha256=CUvBs0boB_X-Kndh66yYcqFfq3oC_LGs8YffLkJ0ZXA,5707
-pkgs/type_spec/emit_open_api.py,sha256=B9cGFR7TU90_yky-HdNq1sDIJOuP3eU4o3j7nNgIpkU,26047
-pkgs/type_spec/emit_open_api_util.py,sha256=xnc4ymNzEyAS1Q2cV6Ma9Y6mQ1MbPPi2WaHKTSFETr8,2346
-pkgs/type_spec/emit_python.py,sha256=JCT_o6sPJRaAL1J-TlMT-RN8d4bzLcYJF2iwNTcGlBA,52651
-pkgs/type_spec/emit_typescript.py,sha256=0HRzxlbIP91rzbVkAntF4TKZppoKcWsqnDLAIRc1bng,10927
-pkgs/type_spec/emit_typescript_util.py,sha256=pYhzRb-U-B5peWdfJDQ0i9kI80Ojf2wbfkvJutk9rTw,10975
-pkgs/type_spec/load_types.py,sha256=GndEKQtICCQi4oXsL6cZ9khm8lBB830e6hx0wML4dHs,4278
+pkgs/type_spec/emit_open_api.py,sha256=5M0lAEbjm0bRPjuGpChMS1eB4oCkb2Hd3e7mr-rLv0Y,26345
+pkgs/type_spec/emit_open_api_util.py,sha256=bTmRvrGP82-eB75hwf9ySI7pDEC87FNQTF18VKEWSXY,2367
+pkgs/type_spec/emit_python.py,sha256=aURsc-wWdamVDCrIWxA7s8_MLAMjLdXZor6ykkibzXY,52707
+pkgs/type_spec/emit_typescript.py,sha256=FINir79bz4tJYgJuUylNJFvqChzaFlHNCfZ5D7A6B1I,11447
+pkgs/type_spec/emit_typescript_util.py,sha256=ChP4oF2ZJoL0qErGCL0nscj0w_yH6TBgE92MtQS8nPI,11638
+pkgs/type_spec/load_types.py,sha256=JL7tX2H_cy3p5HjGuvNFJlY4pDSbDVnYFsh9mK16-ic,4302
 pkgs/type_spec/non_discriminated_union_exceptions.py,sha256=JB4WNDJWc3e9WMOabX4aTd0-6K7n1hctIW2lGf1bYts,612
-pkgs/type_spec/open_api_util.py,sha256=DYnlygaMIqDQtSuYpUpd5lpA9JG4JHd_-iGe-BY2lhw,7333
+pkgs/type_spec/open_api_util.py,sha256=muEX3hYIhlLFA9XDfMruk2687w6bKrZnluIVVqEtDao,7642
 pkgs/type_spec/test.py,sha256=4ueujBq-pEgnX3Z69HyPmD-bullFXmpixcpVzfOkhP4,489
 pkgs/type_spec/util.py,sha256=S_SGTJU192x-wIbngVUTvXhQENMbBfxluigLmnItGI8,4848
 pkgs/type_spec/actions_registry/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pkgs/type_spec/actions_registry/__main__.py,sha256=SRw6kIhHTW7W2wGijYq66JARzoc4KpPmbLqwvnETyTE,4277
 pkgs/type_spec/actions_registry/emit_typescript.py,sha256=W1lI36ITdJ7MBf37wlTB7H3X9Ljt217vIGMv4e3fxfY,5986
 pkgs/type_spec/parts/base.py.prepart,sha256=Xy8my5ol_Iu0hpQpvgsmqGLkGcMsLSg-cgjm4Yp-QI4,2369
-pkgs/type_spec/parts/base.ts.prepart,sha256=2FJJvpg2olCcavxj0nbYWdwKl6KeScour2JjSvN42l8,1001
+pkgs/type_spec/parts/base.ts.prepart,sha256=42-1_N_K04t4c6pE62V4wBw3bR5bgPxhmXUk__A7gAs,1002
 pkgs/type_spec/type_info/__main__.py,sha256=TLNvCHGcmaj_8Sj5bAQNpuNaaw2dpDzoFDWZds0V4Qo,1002
 pkgs/type_spec/type_info/emit_type_info.py,sha256=xRjZiwDDii4Bq8yVfcgE8YFechoKAcGmYXBk3Dq-K-s,15387
 pkgs/type_spec/ui_entry_actions/__init__.py,sha256=WiHE_BexOEZWbkkbD7EnFau1aMLNmfgQywG9PTQNCkw,135
-pkgs/type_spec/ui_entry_actions/generate_ui_entry_actions.py,sha256=IPBdVfJReLLGVaZOkb0QYGGrm73JqMXuAGSbeoBVbDg,9477
+pkgs/type_spec/ui_entry_actions/generate_ui_entry_actions.py,sha256=65qUEp9zVcAsHEe3QjOTlPfLf45kH980fOXZXKNmOC8,9503
 pkgs/type_spec/value_spec/__init__.py,sha256=Z-grlcZtxAfEXhPHsK0nD7PFLGsv4eqvunaPN7_TA84,83
 pkgs/type_spec/value_spec/__main__.py,sha256=oM5lcV6Hv_03okjtfWn2fzSHsarFVa9ArU_g02XnQJw,8879
 pkgs/type_spec/value_spec/convert_type.py,sha256=OvP7dwUMHXNHVXWYT4jkaYJ96S3a2SnFuC_iMdYVB7s,2927
@@ -141,7 +142,7 @@ uncountable/integration/secret_retrieval/retrieve_secret.py,sha256=LBEf18KHtXZxg
 uncountable/integration/webhook_server/entrypoint.py,sha256=NQawXl_JCRojdVniS5RF7dobQQKW_Wy03bwy-uXknuA,3441
 uncountable/types/__init__.py,sha256=eqeDMCXTr9Mwo10RSGMa4znfu_7TVp_0gYJxPKmLCfQ,9990
 uncountable/types/async_batch.py,sha256=yCCWrrLQfxXVqZp-KskxLBNkNmuELdz4PJjx8ULppgs,662
-uncountable/types/async_batch_processor.py,sha256=Y8rp-GtuhwUBg18yb5T7bQpb48vsQpACGrvaIiFYLrU,21765
+uncountable/types/async_batch_processor.py,sha256=h_8Snzt3lbEFlZAZFByt4Hg4dv2YlxMijHjTHjZ0aXY,22062
 uncountable/types/async_batch_t.py,sha256=JuswurXlYW38MfAXJ0UWb7hE2rmzFaHBAsNhRYAyMD4,3779
 uncountable/types/async_jobs.py,sha256=JI0ScfawaqMRbJ2jbgW3YQLhijPnBeYdMnZJjygSxHg,322
 uncountable/types/async_jobs_t.py,sha256=u4xd3i512PZ-9592Q2ZgWh_faMiI4UMm0F_gOmZnerI,1389
@@ -153,7 +154,7 @@ uncountable/types/calculations.py,sha256=fApOFpgBemt_t7IVneVR0VdI3X5EOxiG6Xhzr6R
 uncountable/types/calculations_t.py,sha256=pl-lhjyDQuj11Sf9g1-0BsSkN7Ez8UxDp8-KMQ_3enM,709
 uncountable/types/chemical_structure.py,sha256=ujyragaD26-QG5jgKnWhO7TN3N1V9b_04T2WhqNYxxo,281
 uncountable/types/chemical_structure_t.py,sha256=VFFyits_vx4t5L2euu_qFiSpsGJjURkDPr3ISnr3nPc,855
-uncountable/types/client_base.py,sha256=m4AI0E4ET-FFmewHicW1t2oayraIhS_VYMuyTCnOk1g,76085
+uncountable/types/client_base.py,sha256=Qd8kxA0C76FKTAuoJOVjEw48mInfV_IXH2CBBTyYwAs,76382
 uncountable/types/client_config.py,sha256=qLpHt4O_B098CyN6qQajoxZ2zjZ1DILXLUEGyyGP0TQ,280
 uncountable/types/client_config_t.py,sha256=yTFIYAitMrcc4oV9J-HADODS_Hwi45z-piz7rr7QT04,781
 uncountable/types/curves.py,sha256=QyEyC20jsG-LGKVx6miiF-w70vKMwNkILFBDIJ5Ok9g,345
@@ -161,7 +162,7 @@ uncountable/types/curves_t.py,sha256=DxYepdC3QKKR7mepOOBoyarNcFZQdUa5ZYH-hwCY3BI
 uncountable/types/data.py,sha256=u2isf4XEug3Eu-xSIoqGaCQmW2dFaKBHCkP_WKYwwBc,500
 uncountable/types/data_t.py,sha256=vFoypK_WMGfN28r1sSlDYHZNUdBQC0XCN7-_Mlo4FJk,2832
 uncountable/types/entity.py,sha256=Zclk1LYcRaYrMDhqyCjMSLEg0fE6_q8LHvV22Qvscgs,566
-uncountable/types/entity_t.py,sha256=I_dJ08Wd7NsVFkZx3p9-VAARx8nCkLJCtY--hv0zR8c,20288
+uncountable/types/entity_t.py,sha256=Q-Ji3IMpQxXoY680ZOYz5Zkcy_wrz3lgQOnKqoU9noA,20666
 uncountable/types/experiment_groups.py,sha256=qUpFOx1AKgzaT_4khCOv5Xs6jwiQGbvHH-GUh3v1nv4,288
 uncountable/types/experiment_groups_t.py,sha256=29Ct-WPejpYMuGfnFfOoosU9iSfjzxpabpBX6oTPFUA,761
 uncountable/types/exports.py,sha256=VMmxUO2PpV1Y63hZ2AnVor4H-B6aswJ7YpSru_u89lU,334
@@ -235,7 +236,7 @@ uncountable/types/api/condition_parameters/upsert_condition_match.py,sha256=7I9l
 uncountable/types/api/entity/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/entity/create_entities.py,sha256=cCDEra2SHvGWvz7nIxxMDSQN6OWrHMTT0JSomWUesto,1794
 uncountable/types/api/entity/create_entity.py,sha256=urT6C7iGAa7_rCv9Wcz6GM_lKg1tP55E__rjNkj-Rjc,1879
-uncountable/types/api/entity/create_or_update_entity.py,sha256=OK05B9nqlxsCU41iVCI_Nn66qVeQfqgdf2oZn7kUPFM,1445
+uncountable/types/api/entity/create_or_update_entity.py,sha256=cxjJIcZTKOg8Y5kGzctYKayfnr8BNZDOM5YfI4dBSf0,1532
 uncountable/types/api/entity/export_entities.py,sha256=zz_4P6bQAt7gU2o2to9zUh0HHLQKaxLkbFGfbgY3KVk,1395
 uncountable/types/api/entity/get_entities_data.py,sha256=hu0UfkU4PTyv3_CBZ7YmR8L8BKMq8hx6zH43XtUm16E,1616
 uncountable/types/api/entity/grant_entity_permissions.py,sha256=4CvVIMvpdok8K1Bh6wMlwuUmoeP_-nL9y2GCEM6uAhY,1536
@@ -318,7 +319,7 @@ uncountable/types/api/triggers/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr
 uncountable/types/api/triggers/run_trigger.py,sha256=dgDX_sRWSJ36UuzMZhG25oHV1HIOUKYY2G3fjKugZrw,1204
 uncountable/types/api/uploader/__init__.py,sha256=gCgbynxG3jA8FQHzercKtrHKHkiIKr8APdZYUniAor8,55
 uncountable/types/api/uploader/invoke_uploader.py,sha256=Bj7Dq4A90k00suacwk3bLA_dCb2aovS1kAbVam2AQnM,1395
-uncountablepythonsdk-0.0.115.dist-info/METADATA,sha256=-CVaJt1Lh0NBrGUWB8G7L3jEsniPCdVd_1un50_IUQo,2143
-uncountablepythonsdk-0.0.115.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-uncountablepythonsdk-0.0.115.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
-uncountablepythonsdk-0.0.115.dist-info/RECORD,,
+uncountablepythonsdk-0.0.116.dist-info/METADATA,sha256=oPQJIEgmWPjJGw_pV9kIAdtXYNfSegMl15O4xPvJ080,2143
+uncountablepythonsdk-0.0.116.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+uncountablepythonsdk-0.0.116.dist-info/top_level.txt,sha256=1UVGjAU-6hJY9qw2iJ7nCBeEwZ793AEN5ZfKX9A1uj4,31
+uncountablepythonsdk-0.0.116.dist-info/RECORD,,