jdg-keyforge-protocol 0.16.1__py3-none-any.whl

jdg_keyforge_protocol-0.16.1.dist-info/METADATA

@@ -0,0 +1,76 @@
+Metadata-Version: 2.4
+Name: jdg-keyforge-protocol
+Version: 0.16.1
+Summary: Python types for the KeyForge WebSocket protocol, generated from the canonical JSON Schema contracts.
+Keywords: keyforge,protocol,types,json-schema,websocket
+Author: Jonathan Daniel Gomez
+Author-email: Jonathan Daniel Gomez <jonathan.d.gomez98@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Typing :: Typed
+Requires-Python: >=3.15
+Project-URL: Homepage, https://github.com/JoniDG/keyforge-protocol
+Project-URL: Repository, https://github.com/JoniDG/keyforge-protocol
+Project-URL: Issues, https://github.com/JoniDG/keyforge-protocol/issues
+Description-Content-Type: text/markdown
+
+# jdg-keyforge-protocol
+
+> Python types for the [KeyForge](https://github.com/JoniDG/keyforge) WebSocket protocol, generated from the canonical JSON Schema contracts in this repository.
+
+This package contains only `TypedDict`s and type aliases, with no runtime dependencies. It mirrors the TypeScript package [`@jdg-keyforge/protocol`](https://www.npmjs.com/package/@jdg-keyforge/protocol) and the Go submodule at `github.com/JoniDG/keyforge-protocol/go/protocol`.
+
+Requires Python 3.15+ (it uses PEP 728 closed `TypedDict`s from the standard library).
+
+## Install
+
+```bash
+uv add jdg-keyforge-protocol      # or: pip install jdg-keyforge-protocol
+```
+
+## Usage
+
+```python
+import json
+
+from keyforge_protocol import ActionInvokedData, HelloParams, PluginLaunchInfo
+
+hello: HelloParams = {
+    "protocol_version": "1",
+    "client": {"name": "dev.example.counter", "version": "0.1.0"},
+}
+
+def on_action(data: ActionInvokedData) -> None:
+    print(data["action"]["id"], data["action"]["params"])
+```
+
+The package root re-exports:
+
+- every shared type from `common` and `envelope` (`InputEvent`, `PluginManifest`, `PluginLaunchInfo`, `Error`, ...);
+- `Method<Name>` plus `<Name>Params` / `<Name>Result` for each method (e.g. `MethodHello`, `HelloParams`, `HelloResult`);
+- `Event<Name>` plus `<Name>Data` for each event (e.g. `EventActionInvoked`, `ActionInvokedData`);
+- types local to one method keep their schema name (`PeerInfo`, `ActionDescriptor`); other nested objects are prefixed with the method or event name (`ActionInvokedAction`);
+- `JsonValue` / `JsonObject`, used for open objects such as `Action.params` and `Error.details`.
+
+Types are static only: nothing is validated at runtime. Validate untrusted JSON against the schemas if you need to.
+
+## Versioning
+
+Versioned together with the Go submodule and the TS package, with tags `py/vX.Y.Z`. A breaking schema change bumps the schema's `/v1/` path and the major version of every package.
+
+## Local regeneration
+
+The contents of `src/keyforge_protocol/` are auto-generated. From the repository root:
+
+```bash
+make generate-py   # regenerate
+make check-py      # mypy --strict + contract tests
+make build-py      # sdist + wheel into py/dist/
+```
+
+## License
+
+[Apache 2.0](./LICENSE) — Copyright (c) 2026 Jonathan Daniel Gomez.

jdg_keyforge_protocol-0.16.1.dist-info/RECORD

@@ -0,0 +1,35 @@
+keyforge_protocol/__init__.py,sha256=2OoVgWyxZynHH9BZ-8G4rotb-zntsIP9PWfBnCsRqxM,6910
+keyforge_protocol/_json.py,sha256=Ac7rm3c9J8zs8YkatKk48AN4HQl1jLL1SKUo4jgl4Bw,281
+keyforge_protocol/common_schema.py,sha256=6a2eSfSvxsZO_slrgxFFPjmRnUQ41CnjPxN46oZ0ves,20302
+keyforge_protocol/envelope_schema.py,sha256=PKuR3fTUsL1DF1SQfbnnCJPJMyTMZu3Cud4m5r9lE5g,2251
+keyforge_protocol/events/__init__.py,sha256=sIyaEvJdP-VmGTGPPqZuRjKn4bc7NUClJ76Gd5uq-5s,57
+keyforge_protocol/events/action_invoked_schema.py,sha256=n05LRBzGFUrWLMNX7mCrFjrJP63qtcJvxscvc9e_Ygs,1616
+keyforge_protocol/events/active_profile_changed_schema.py,sha256=QWFgRetfJ2NLIJoh43wNKYiTkNbyFHwjYblFXeYRL5o,610
+keyforge_protocol/events/input_schema.py,sha256=KF8RNCAwRqgQ6uzDhR5arzKgqUk1Zs8lJJlVQsouPO0,367
+keyforge_protocol/methods/__init__.py,sha256=sIyaEvJdP-VmGTGPPqZuRjKn4bc7NUClJ76Gd5uq-5s,57
+keyforge_protocol/methods/create_profile_schema.py,sha256=_EK-4mJuesjE6KVrIZq4PzHMj_8b5CmH1-68n-3jczg,551
+keyforge_protocol/methods/delete_profile_schema.py,sha256=eZdP4acGbaIV33hwlB5z_8iTwdzWgJDp8f5p2qUQkYs,866
+keyforge_protocol/methods/duplicate_profile_schema.py,sha256=-KaXqKW53gwwOCPFsz_eqtF10umnyk9_GrVBqWJ_-mA,717
+keyforge_protocol/methods/export_profile_schema.py,sha256=aATVa_osUb8BwWhw7tQpdhC_NxZ9j9EI95MekSkRVEQ,767
+keyforge_protocol/methods/get_auto_switch_schema.py,sha256=hNmcB5gi0zYWZv_7e4PDyFRKNNNniwieKu76obvQ_N8,796
+keyforge_protocol/methods/hello_schema.py,sha256=I0ZJI-rE5zPIC42MzdtQ1dBhBqBa6oLn-OkW2reD7rE,1325
+keyforge_protocol/methods/import_profile_schema.py,sha256=BqbcEdM6bEGabaOQfi0QH-W7wpIoTpCSyF9eiT0j1Uw,729
+keyforge_protocol/methods/inspect_plugin_schema.py,sha256=Otia71Rs9zb3rjzqVUaDz964V-p93ck9Vj5s8IJGGaE,1003
+keyforge_protocol/methods/install_plugin_schema.py,sha256=em04gQ2_BxwA7tH8Vt-YmudCU-5pBNSbb-Hxgr_wDWE,1266
+keyforge_protocol/methods/list_actions_schema.py,sha256=9tODH6x89yFDKh54XNkdSLtObVKsRa2YSv0zFGcQIqQ,1185
+keyforge_protocol/methods/list_bindings_schema.py,sha256=LtEcpQR9DFhoZy3qLDl7F4xNFzwuLyrjdkrstGOlYfM,619
+keyforge_protocol/methods/list_devices_schema.py,sha256=XdeIWvfnoEBnyYm5HisrIYWjc0IYCpYmMs_sH6B3T1Q,577
+keyforge_protocol/methods/list_plugins_schema.py,sha256=H3DkJMCANy6jyKCv7wqq2BBC5WAI_1lKFGCJVPWo1nc,535
+keyforge_protocol/methods/list_profiles_schema.py,sha256=odeCmONa4cS39nSENC1ievOW1Fnay5GKnFJjfL_0iGQ,769
+keyforge_protocol/methods/rename_profile_schema.py,sha256=CRQ670PG-ZSatGCv4U6tdwN8XxfXzzZBcFsUKizpSHM,633
+keyforge_protocol/methods/set_active_profile_schema.py,sha256=0rv4vel6SKPx_Gc2vX_xnTedDdDEMmvCyOUVDKh47Xg,643
+keyforge_protocol/methods/set_auto_switch_schema.py,sha256=SAHZd3ur-2IyXSXamqBOHIi_5JtHvMR99o0x2erEzc0,1155
+keyforge_protocol/methods/set_binding_schema.py,sha256=BVhprEF4_hAqbk1wf7OTW7LewhA4siIZ65DFiKzEfow,690
+keyforge_protocol/methods/set_device_rotation_schema.py,sha256=oTxVJ8MTsFTRXZWwKoeZaJ5eJcVFZBtpXLF83ezYwxY,885
+keyforge_protocol/methods/set_input_color_schema.py,sha256=pN6lUHbuwZf_WibWpqY3sPsn9ZhkhCg4Okqf2QIFUmc,992
+keyforge_protocol/methods/uninstall_plugin_schema.py,sha256=hmHGb8oe5x2RwgABz0oUw2EEZ7zsF6W0fIKStaRMCzg,750
+keyforge_protocol/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+jdg_keyforge_protocol-0.16.1.dist-info/licenses/LICENSE,sha256=ppL7g6LKqm71f6wOYrIARgKvzURdUsQvwE9QqTGWS08,864
+jdg_keyforge_protocol-0.16.1.dist-info/WHEEL,sha256=xTCBFIZIIyRSxyowOv5Wqg_jFU6KsdIffuulBB09Ph8,80
+jdg_keyforge_protocol-0.16.1.dist-info/METADATA,sha256=ztX_KUBWdNi_uWknfx0kEkuZOKcEa0anFLYDuaaczCs,3130
+jdg_keyforge_protocol-0.16.1.dist-info/RECORD,,

jdg_keyforge_protocol-0.16.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.13.0
+Root-Is-Purelib: true
+Tag: py3-none-any

jdg_keyforge_protocol-0.16.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright (c) 2026 Jonathan Daniel Gomez <jonathan.d.gomez98@gmail.com>
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+   ---
+
+   Full license text: https://www.apache.org/licenses/LICENSE-2.0.txt

keyforge_protocol/__init__.py

@@ -0,0 +1,281 @@
+# AUTO-GENERATED by 'make generate-py'. DO NOT EDIT BY HAND.
+
+"""Types for the KeyForge WebSocket protocol, generated from its JSON Schemas."""
+
+from ._json import JsonObject, JsonValue
+from .common_schema import (
+    DeviceID,
+    InputKind,
+    InputAction,
+    InputEvent,
+    Action,
+    SendKeysActionParams,
+    LaunchAppActionParams,
+    DelayActionParams,
+    MacroActionParams,
+    ToggleActionParams,
+    Binding,
+    InputLayout,
+    DeviceRotation,
+    Color,
+    InputColor,
+    AutoSwitchRule,
+    InputFilter,
+    PluginID,
+    PluginLaunchInfo,
+    PluginCommand,
+    SetColorActionParams,
+    Profile,
+    ExportedProfile,
+    Input,
+    Device,
+    ParamSpec,
+    Entrypoint,
+    PluginAction,
+    PluginManifest,
+    InstalledPlugin,
+)
+from .envelope_schema import (
+    Request,
+    ResponseOk,
+    Error,
+    Event,
+    ResponseErr,
+    Response,
+    Envelope,
+)
+from .methods.create_profile_schema import (
+    MethodCreateProfile,
+    Params as CreateProfileParams,
+    Result as CreateProfileResult,
+)
+from .methods.delete_profile_schema import (
+    MethodDeleteProfile,
+    Params as DeleteProfileParams,
+    Result as DeleteProfileResult,
+)
+from .methods.duplicate_profile_schema import (
+    MethodDuplicateProfile,
+    Params as DuplicateProfileParams,
+    Result as DuplicateProfileResult,
+)
+from .methods.export_profile_schema import (
+    MethodExportProfile,
+    Params as ExportProfileParams,
+    Result as ExportProfileResult,
+)
+from .methods.get_auto_switch_schema import (
+    MethodGetAutoSwitch,
+    Result as GetAutoSwitchResult,
+)
+from .methods.hello_schema import (
+    MethodHello,
+    Params as HelloParams,
+    PeerInfo,
+    Result as HelloResult,
+)
+from .methods.import_profile_schema import (
+    MethodImportProfile,
+    Params as ImportProfileParams,
+    Result as ImportProfileResult,
+)
+from .methods.inspect_plugin_schema import (
+    MethodInspectPlugin,
+    Params as InspectPluginParams,
+    Result as InspectPluginResult,
+)
+from .methods.install_plugin_schema import (
+    MethodInstallPlugin,
+    Params as InstallPluginParams,
+    Result as InstallPluginResult,
+)
+from .methods.list_actions_schema import (
+    ActionDescriptor,
+    MethodListActions,
+    Result as ListActionsResult,
+)
+from .methods.list_bindings_schema import (
+    MethodListBindings,
+    Result as ListBindingsResult,
+)
+from .methods.list_devices_schema import (
+    MethodListDevices,
+    Result as ListDevicesResult,
+)
+from .methods.list_plugins_schema import (
+    MethodListPlugins,
+    Result as ListPluginsResult,
+)
+from .methods.list_profiles_schema import (
+    MethodListProfiles,
+    Result as ListProfilesResult,
+)
+from .methods.rename_profile_schema import (
+    MethodRenameProfile,
+    Params as RenameProfileParams,
+)
+from .methods.set_active_profile_schema import (
+    MethodSetActiveProfile,
+    Params as SetActiveProfileParams,
+    Result as SetActiveProfileResult,
+)
+from .methods.set_auto_switch_schema import (
+    MethodSetAutoSwitch,
+    Params as SetAutoSwitchParams,
+    Result as SetAutoSwitchResult,
+)
+from .methods.set_binding_schema import (
+    MethodSetBinding,
+    Params as SetBindingParams,
+)
+from .methods.set_device_rotation_schema import (
+    MethodSetDeviceRotation,
+    Params as SetDeviceRotationParams,
+)
+from .methods.set_input_color_schema import (
+    MethodSetInputColor,
+    Params as SetInputColorParams,
+)
+from .methods.uninstall_plugin_schema import (
+    MethodUninstallPlugin,
+    Params as UninstallPluginParams,
+)
+from .events.action_invoked_schema import (
+    Action as ActionInvokedAction,
+    Data as ActionInvokedData,
+    EventActionInvoked,
+)
+from .events.active_profile_changed_schema import (
+    Data as ActiveProfileChangedData,
+    EventActiveProfileChanged,
+)
+from .events.input_schema import (
+    EventInput,
+)
+
+type GetAutoSwitchParams = JsonObject
+type ListActionsParams = JsonObject
+type ListBindingsParams = JsonObject
+type ListDevicesParams = JsonObject
+type ListPluginsParams = JsonObject
+type ListProfilesParams = JsonObject
+type RenameProfileResult = JsonObject
+type SetBindingResult = JsonObject
+type SetDeviceRotationResult = JsonObject
+type SetInputColorResult = JsonObject
+type UninstallPluginResult = JsonObject
+type InputData = InputEvent
+
+__all__ = [
+    "Action",
+    "ActionDescriptor",
+    "ActionInvokedAction",
+    "ActionInvokedData",
+    "ActiveProfileChangedData",
+    "AutoSwitchRule",
+    "Binding",
+    "Color",
+    "CreateProfileParams",
+    "CreateProfileResult",
+    "DelayActionParams",
+    "DeleteProfileParams",
+    "DeleteProfileResult",
+    "Device",
+    "DeviceID",
+    "DeviceRotation",
+    "DuplicateProfileParams",
+    "DuplicateProfileResult",
+    "Entrypoint",
+    "Envelope",
+    "Error",
+    "Event",
+    "EventActionInvoked",
+    "EventActiveProfileChanged",
+    "EventInput",
+    "ExportProfileParams",
+    "ExportProfileResult",
+    "ExportedProfile",
+    "GetAutoSwitchParams",
+    "GetAutoSwitchResult",
+    "HelloParams",
+    "HelloResult",
+    "ImportProfileParams",
+    "ImportProfileResult",
+    "Input",
+    "InputAction",
+    "InputColor",
+    "InputData",
+    "InputEvent",
+    "InputFilter",
+    "InputKind",
+    "InputLayout",
+    "InspectPluginParams",
+    "InspectPluginResult",
+    "InstallPluginParams",
+    "InstallPluginResult",
+    "InstalledPlugin",
+    "JsonObject",
+    "JsonValue",
+    "LaunchAppActionParams",
+    "ListActionsParams",
+    "ListActionsResult",
+    "ListBindingsParams",
+    "ListBindingsResult",
+    "ListDevicesParams",
+    "ListDevicesResult",
+    "ListPluginsParams",
+    "ListPluginsResult",
+    "ListProfilesParams",
+    "ListProfilesResult",
+    "MacroActionParams",
+    "MethodCreateProfile",
+    "MethodDeleteProfile",
+    "MethodDuplicateProfile",
+    "MethodExportProfile",
+    "MethodGetAutoSwitch",
+    "MethodHello",
+    "MethodImportProfile",
+    "MethodInspectPlugin",
+    "MethodInstallPlugin",
+    "MethodListActions",
+    "MethodListBindings",
+    "MethodListDevices",
+    "MethodListPlugins",
+    "MethodListProfiles",
+    "MethodRenameProfile",
+    "MethodSetActiveProfile",
+    "MethodSetAutoSwitch",
+    "MethodSetBinding",
+    "MethodSetDeviceRotation",
+    "MethodSetInputColor",
+    "MethodUninstallPlugin",
+    "ParamSpec",
+    "PeerInfo",
+    "PluginAction",
+    "PluginCommand",
+    "PluginID",
+    "PluginLaunchInfo",
+    "PluginManifest",
+    "Profile",
+    "RenameProfileParams",
+    "RenameProfileResult",
+    "Request",
+    "Response",
+    "ResponseErr",
+    "ResponseOk",
+    "SendKeysActionParams",
+    "SetActiveProfileParams",
+    "SetActiveProfileResult",
+    "SetAutoSwitchParams",
+    "SetAutoSwitchResult",
+    "SetBindingParams",
+    "SetBindingResult",
+    "SetColorActionParams",
+    "SetDeviceRotationParams",
+    "SetDeviceRotationResult",
+    "SetInputColorParams",
+    "SetInputColorResult",
+    "ToggleActionParams",
+    "UninstallPluginParams",
+    "UninstallPluginResult",
+]

keyforge_protocol/_json.py

@@ -0,0 +1,5 @@
+# AUTO-GENERATED by 'make generate-py'. DO NOT EDIT BY HAND.
+"""JSON values for the open objects of the schema (Action.params, Error.details, ...)."""
+
+type JsonValue = str | int | float | bool | None | list[JsonValue] | dict[str, JsonValue]
+type JsonObject = dict[str, JsonValue]