@opentrons/components 0.2.1-alpha.0 → 0.3.0-alpha.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

package/README.md

@@ -1,55 +1,19 @@
-# opentrons components library
+# @opentrons/components
 
-React components for Opentrons' applications. Visit the [Opentrons Components Library][components-library] to see available components.
+> **Alpha software - not intended for public use.**
+>
+> This package is published as a true alpha. There is no guarantee it works,
+> no guarantee of API stability, and no support commitment. It may be broken,
+> incomplete, or removed without notice. Do not use this in production.
 
-[components-library]: https://s3-us-west-2.amazonaws.com/opentrons-components/edge/index.html
+## Version
 
-## example usage
+`0.3.0-alpha.1`
 
-```javascript
-import { PrimaryButton } from '@opentrons/components'
-export default function CowButton(props) {
-  return <PrimaryButton onClick={() => console.log('🐄')} />
-}
-```
+## License
 
-## setup
+Apache-2.0 - see [LICENSE](./LICENSE).
 
-Usage requirements for dependent projects:
+## Source
 
-- Node v22.11.0+ and yarn
-- The following `dependencies` (peer dependencies of `@opentrons/components`)
-  - `react`: `17.0.1`,
-  - `react-router-dom`: `^4.2.2`,
-  - `classnames`: `^2.2.5`,
-  - `lodash`: `^4.17.4`
-
-## contributing
-
-Make sure you have read the top-level [Contributing Guide][contributing].
-
-### unit tests
-
-Unit tests are run with the rest of the repositories unit tests from the top level of the project.
-
-```shell
-make test-js
-```
-
-Unit tests live in a `__tests__` directory in the same directory as the module under test. When writing unit tests for components, we've found the following tests to be the most useful:
-
-- DOM tests
-  - Make sure the component renders the correct node type
-  - Make sure DOM attributes are mapped correctly
-  - Make sure handlers fire correctly
-- Render tests
-
-  - Snapshot tests using [jest's snapshot functionality][jest-snapshots]
-  - To regenerate snapshots after an intentional rendering change, run:
-
-  ```shell
-  make test-js updateSnapshot=true
-  ```
-
-[jest-snapshots]: https://facebook.github.io/jest/docs/en/snapshot-testing.html
-[contributing]: ../CONTRIBUTING.md
+This package is built from the [Opentrons monorepo](https://github.com/Opentrons/opentrons).

package/lib/assets/index.d.ts

@@ -0,0 +1 @@
+export * from './localization';

package/lib/assets/localization/en/index.d.ts

@@ -1,23 +1,189 @@
-export declare const en: {
+export declare const shared_en_resources: {
+    command_type_summary: {
+        "absorbanceReader/closeLid": string;
+        "absorbanceReader/initialize": string;
+        "absorbanceReader/openLid": string;
+        "absorbanceReader/read": string;
+        airGapInPlace: string;
+        aspirate: string;
+        aspirateInPlace: string;
+        aspirateWhileTracking: string;
+        blowout: string;
+        blowOutInPlace: string;
+        "calibration/calibrateGripper": string;
+        "calibration/calibrateModule": string;
+        "calibration/calibratePipette": string;
+        "calibration/moveToMaintenancePosition": string;
+        captureImage: string;
+        comment: string;
+        configureForVolume: string;
+        configureNozzleLayout: string;
+        createCSV: string;
+        createTimer: string;
+        csvWriteRow: string;
+        custom: string;
+        delay: string;
+        dispense: string;
+        dispenseInPlace: string;
+        dispenseWhileTracking: string;
+        dropTip: string;
+        dropTipInPlace: string;
+        "flexStacker/closeLatch": string;
+        "flexStacker/empty": string;
+        "flexStacker/fill": string;
+        "flexStacker/openLatch": string;
+        "flexStacker/prepareShuttle": string;
+        "flexStacker/retrieve": string;
+        "flexStacker/setStoredLabware": string;
+        "flexStacker/store": string;
+        getNextTip: string;
+        getTipPresence: string;
+        "heaterShaker/closeLabwareLatch": string;
+        "heaterShaker/deactivateHeater": string;
+        "heaterShaker/deactivateShaker": string;
+        "heaterShaker/openLabwareLatch": string;
+        "heaterShaker/setAndWaitForShakeSpeed": string;
+        "heaterShaker/setShakeSpeed": string;
+        "heaterShaker/setTargetTemperature": string;
+        "heaterShaker/waitForTemperature": string;
+        home: string;
+        identifyModule: string;
+        liquidProbe: string;
+        loadLabware: string;
+        loadLid: string;
+        loadLidStack: string;
+        loadLiquid: string;
+        loadLiquidClass: string;
+        loadModule: string;
+        loadPipette: string;
+        "magneticModule/disengage": string;
+        "magneticModule/engage": string;
+        moveLabware: string;
+        moveRelative: string;
+        moveToAddressableArea: string;
+        moveToAddressableAreaForDropTip: string;
+        moveTocoordinates: string;
+        moveToCoordinates: string;
+        moveToSlot: string;
+        moveToWell: string;
+        pause: string;
+        pickUpTip: string;
+        prepareToAspirate: string;
+        pressureDispense: string;
+        reloadLabware: string;
+        retractAxis: string;
+        "robot/closeGripperJaw": string;
+        "robot/moveAxesRelative": string;
+        "robot/moveAxesTo": string;
+        "robot/moveTo": string;
+        "robot/openGripperJaw": string;
+        savePosition: string;
+        sealPipetteToTip: string;
+        setRailLights: string;
+        setStatusBar: string;
+        setTipState: string;
+        "temperatureModule/deactivate": string;
+        "temperatureModule/setTargetTemperature": string;
+        "temperatureModule/waitForTemperature": string;
+        "thermocycler/awaitProfileComplete": string;
+        "thermocycler/closeLid": string;
+        "thermocycler/deactivateBlock": string;
+        "thermocycler/deactivateLid": string;
+        "thermocycler/openLid": string;
+        "thermocycler/runExtendedProfile": string;
+        "thermocycler/runProfile": string;
+        "thermocycler/setTargetBlockTemperature": string;
+        "thermocycler/setTargetLidTemperature": string;
+        "thermocycler/startRunExtendedProfile": string;
+        "thermocycler/waitForBlockTemperature": string;
+        "thermocycler/waitForLidTemperature": string;
+        touchTip: string;
+        tryLiquidProbe: string;
+        unknown: string;
+        "unsafe/blowOutInPlace": string;
+        "unsafe/dropTipInPlace": string;
+        "unsafe/engageAxes": string;
+        "unsafe/flexStacker/closeLatch": string;
+        "unsafe/flexStacker/manualRetrieve": string;
+        "unsafe/flexStacker/openLatch": string;
+        "unsafe/flexStacker/prepareShuttle": string;
+        "unsafe/placeLabware": string;
+        "unsafe/ungripLabware": string;
+        "unsafe/updatePositionEstimators": string;
+        unsealPipetteFromTip: string;
+        "vacuum_module/startSetVacuumPressure": string;
+        "vacuum_module/stopVacuum": string;
+        "vacuum_module/startSetVacuumPump": string;
+        verifyTipPresence: string;
+        waitForDuration: string;
+        waitForResume: string;
+        waitForTasks: string;
+    };
+    deck_configuration: {
+        absorbance: string;
+        center_slot: string;
+        flex_stacker_display_name: string;
+        flex_stacker_waste_chute_display_name: string;
+        heater_Shaker: string;
+        left_slot: string;
+        mag_block: string;
+        magnetic_block: string;
+        magnetic_block_with_staging_area_slot: string;
+        magnetic_block_with_waste_chute_right_adapter_covered: string;
+        magnetic_block_with_waste_chute_right_adapter_no_cover: string;
+        module_in_port: string;
+        module_in_port_and_magnetic_block: string;
+        module_in_port_and_waste_chute: string;
+        module_in_port_and_waste_chute_with_cover: string;
+        module_with_mag_block: string;
+        module_with_staging_area: string;
+        module_with_waste_chute: string;
+        module_with_waste_chute_and_cover: string;
+        right_slot: string;
+        slot: string;
+        staging_area: string;
+        staging_area_slot: string;
+        staging_area_slot_title: string;
+        temperature: string;
+        thermocycler: string;
+        trash_bin: string;
+        vacuum: string;
+        waste: string;
+        waste_chute: string;
+        waste_chute_with_cover: string;
+        waste_chute_with_staging_area_slot: string;
+        waste_chute_with_staging_area_slot_and_cover: string;
+    };
     protocol_command_text: {
         absorbance_reader_close_lid: string;
         absorbance_reader_initialize: string;
         absorbance_reader_open_lid: string;
         absorbance_reader_read: string;
         adapter_in_mod_in_slot: string;
+        adapter_in_mod_in_slot_plural: string;
         adapter_in_slot: string;
         air_gap_in_place: string;
         all_nozzles: string;
         aspirate: string;
         aspirate_in_place: string;
+        aspirate_while_tracking: string;
         blowout: string;
         blowout_in_place: string;
+        capture_image_brightness: string;
+        capture_image_contrast: string;
+        capture_image_list_separator: string;
+        capture_image_resolution: string;
+        capture_image_saturation: string;
+        capture_image_simple: string;
+        capture_image_with_options: string;
+        capture_image_zoom: string;
         closing_tc_lid: string;
         column_layout: string;
         comment: string;
         configure_for_volume: string;
         configure_nozzle_layout: string;
         confirm_and_resume: string;
+        create_timer: string;
         deactivate_hs_shake: string;
         deactivate_temperature_module: string;
         deactivating_hs_heater: string;
@@ -29,13 +195,16 @@ export declare const en: {
         dispense: string;
         dispense_in_place: string;
         dispense_push_out: string;
+        dispense_while_tracking: string;
         drop_tip: string;
         drop_tip_in_place: string;
         dropping_tip_in_trash: string;
+        empty_stacker: string;
         engaging_magnetic_module: string;
+        extension_jaw: string;
         extension_mount: string;
         extension_z: string;
-        extension_jaw: string;
+        fill_stacker: string;
         fixed_trash: string;
         get_next_tip: string;
         home_gantry: string;
@@ -46,6 +215,9 @@ export declare const en: {
         left_plunger: string;
         left_z: string;
         load_labware_to_display_location: string;
+        load_lid: string;
+        load_lid_stack: string;
+        load_lid_stack_empty: string;
         load_liquid_class: string;
         load_liquids_info_protocol_setup: string;
         load_module_protocol_setup: string;
@@ -56,6 +228,8 @@ export declare const en: {
         move_labware_manually: string;
         move_labware_on: string;
         move_labware_using_gripper: string;
+        move_lid_stack_from_deck: string;
+        move_lid_stack_to_deck: string;
         move_relative: string;
         move_to_addressable_area: string;
         move_to_addressable_area_drop_tip: string;
@@ -63,16 +237,19 @@ export declare const en: {
         move_to_slot: string;
         move_to_well: string;
         multiple: string;
+        ninety_six_channel_cam: string;
         notes: string;
         off_deck: string;
         offdeck: string;
         on_location: string;
         opening_tc_lid: string;
+        partial_layout: string;
         pause: string;
         pause_on: string;
-        partial_layout: string;
         pickup_tip: string;
         prepare_to_aspirate: string;
+        pressurizing_to_dispense: string;
+        quantity: string;
         reloading_labware: string;
         return_tip: string;
         right: string;
@@ -80,25 +257,32 @@ export declare const en: {
         right_plunger: string;
         right_z: string;
         robot_close_gripper_jaw: string;
-        robot_move_to: string;
         robot_move_axes_relative: string;
         robot_move_axes_to: string;
+        robot_move_to: string;
         robot_open_gripper_jaw: string;
         row_layout: string;
         save_position: string;
+        sealing_to_location: string;
         set_and_await_hs_shake: string;
+        set_hs_shake: string;
+        set_tip_state: string;
         setting_hs_temp: string;
         setting_temperature_module_temp: string;
         setting_thermocycler_block_temp: string;
+        setting_thermocycler_block_temp_in_background: string;
         setting_thermocycler_lid_temp: string;
+        setting_thermocycler_lid_temp_in_background: string;
         single: string;
         single_nozzle_layout: string;
         slot: string;
+        stacker_hopper_display: string;
         target_temperature: string;
         tc_awaiting_for_duration: string;
         tc_run_profile_steps: string;
         tc_starting_extended_profile: string;
         tc_starting_extended_profile_cycle: string;
+        tc_starting_extended_profile_in_background: string;
         tc_starting_profile: string;
         touch_tip: string;
         trash_bin: string;
@@ -106,25 +290,16 @@ export declare const en: {
         turning_rail_lights_off: string;
         turning_rail_lights_on: string;
         unlatching_hs_latch: string;
+        unsealing_from_location: string;
         wait_for_duration: string;
         wait_for_resume: string;
+        wait_for_tasks: string;
         waiting_for_hs_to_reach: string;
         waiting_for_tc_block_to_reach: string;
         waiting_for_tc_lid_to_reach: string;
         waiting_to_reach_temp_module: string;
         waste_chute: string;
+        with_lid_name: string;
         with_reference_of: string;
     };
-    deck_configuration: {
-        flex_stacker_display_name: string;
-        flex_stacker_waste_chute_display_name: string;
-        absorbance: string;
-        heater_Shaker: string;
-        mag_block: string;
-        staging_area: string;
-        temperature: string;
-        thermocycler: string;
-        trash_bin: string;
-        waste: string;
-    };
 };