poptart_lex

Generated Dart types, record models, method values, method descriptors, IDs, and curated protocol surfaces for com.atproto.* lexicons.

poptart_lex is the neatly sliced ATProto base lexicon layer. It stays generated and predictable so app code can use typed requests without hand-writing JSON.

Use the sibling generated packages for other common namespaces: bluesky_poptart for app.bsky.* and chat.bsky.*, ozone_poptart for tools.ozone.*, sprk_poptart for so.sprk.*, and margin_poptart for at.margin.*.

Install

dart pub add poptart
dart pub add poptart_lex

Call A Generated Method

import 'package:poptart/poptart.dart';
import 'package:poptart_lex/com/atproto/server/describe_server.dart'
    as describe_server;

Future<void> main() async {
  final client = PoptartClient.anonymous();

  final response = await client.call(
    describe_server.comAtprotoServerDescribeServer,
  );

  print(response.data.availableUserDomains);
}

client.call(...) also accepts describe_server.methodDescriptor. Generated method values are a pleasant default for app code; descriptors are useful for tooling and generic dispatch.

Work With Records

import 'package:poptart_lex/com/atproto/repo/strong_ref.dart';

void main() {
  final ref = RepoStrongRef.fromJson({
    'uri': 'at://did:plc:example/app.bsky.feed.post/3kexample',
    'cid': 'bafyexample',
  });

  print(ref.toJson());
}

Import Shape

Use leaf imports for focused code:

import 'package:poptart_lex/com/atproto/repo/create_record.dart'
    as create_record;

Use generated barrels when you want broader namespace access:

import 'package:poptart_lex/docs.dart';
import 'package:poptart_lex/ids.dart';

Generated files are checked in for consumers and should not be edited by hand. Regenerate them from the lexicon sources when changing the protocol surface.

Libraries

com/atproto/admin
com/atproto/admin/defs
com/atproto/admin/defs/account_view
com/atproto/admin/defs/descriptor
com/atproto/admin/defs/repo_blob_ref
com/atproto/admin/defs/repo_ref
com/atproto/admin/defs/status_attr
com/atproto/admin/defs/threat_signature
com/atproto/admin/delete_account
com/atproto/admin/delete_account/descriptor
com/atproto/admin/delete_account/input
com/atproto/admin/disable_account_invites
com/atproto/admin/disable_account_invites/descriptor
com/atproto/admin/disable_account_invites/input
com/atproto/admin/disable_invite_codes
com/atproto/admin/disable_invite_codes/descriptor
com/atproto/admin/disable_invite_codes/input
com/atproto/admin/enable_account_invites
com/atproto/admin/enable_account_invites/descriptor
com/atproto/admin/enable_account_invites/input
com/atproto/admin/get_account_info
com/atproto/admin/get_account_info/descriptor
com/atproto/admin/get_account_info/input
com/atproto/admin/get_account_infos
com/atproto/admin/get_account_infos/descriptor
com/atproto/admin/get_account_infos/input
com/atproto/admin/get_account_infos/output
com/atproto/admin/get_invite_codes
com/atproto/admin/get_invite_codes/descriptor
com/atproto/admin/get_invite_codes/input
com/atproto/admin/get_invite_codes/main_parameters_sort
com/atproto/admin/get_invite_codes/output
com/atproto/admin/get_subject_status
com/atproto/admin/get_subject_status/descriptor
com/atproto/admin/get_subject_status/input
com/atproto/admin/get_subject_status/output
com/atproto/admin/get_subject_status/union_main_output_subject
com/atproto/admin/search_accounts
com/atproto/admin/search_accounts/descriptor
com/atproto/admin/search_accounts/input
com/atproto/admin/search_accounts/output
com/atproto/admin/send_email
com/atproto/admin/send_email/descriptor
com/atproto/admin/send_email/input
com/atproto/admin/send_email/output
com/atproto/admin/update_account_email
com/atproto/admin/update_account_email/descriptor
com/atproto/admin/update_account_email/input
com/atproto/admin/update_account_handle
com/atproto/admin/update_account_handle/descriptor
com/atproto/admin/update_account_handle/input
com/atproto/admin/update_account_password
com/atproto/admin/update_account_password/descriptor
com/atproto/admin/update_account_password/input
com/atproto/admin/update_account_signing_key
com/atproto/admin/update_account_signing_key/descriptor
com/atproto/admin/update_account_signing_key/input
com/atproto/admin/update_subject_status
com/atproto/admin/update_subject_status/descriptor
com/atproto/admin/update_subject_status/input
com/atproto/admin/update_subject_status/output
com/atproto/admin/update_subject_status/union_main_input_subject
com/atproto/admin/update_subject_status/union_main_output_subject
com/atproto/identity
com/atproto/identity/defs
com/atproto/identity/defs/descriptor
com/atproto/identity/defs/identity_info
com/atproto/identity/get_recommended_did_credentials/descriptor
com/atproto/identity/get_recommended_did_credentials/output
com/atproto/identity/refresh_identity
com/atproto/identity/refresh_identity/descriptor
com/atproto/identity/refresh_identity/input
com/atproto/identity/request_plc_operation_signature
com/atproto/identity/request_plc_operation_signature/descriptor
com/atproto/identity/resolve_did
com/atproto/identity/resolve_did/descriptor
com/atproto/identity/resolve_did/input
com/atproto/identity/resolve_did/output
com/atproto/identity/resolve_handle
com/atproto/identity/resolve_handle/descriptor
com/atproto/identity/resolve_handle/input
com/atproto/identity/resolve_handle/output
com/atproto/identity/resolve_identity
com/atproto/identity/resolve_identity/descriptor
com/atproto/identity/resolve_identity/input
com/atproto/identity/sign_plc_operation
com/atproto/identity/sign_plc_operation/descriptor
com/atproto/identity/sign_plc_operation/input
com/atproto/identity/sign_plc_operation/output
com/atproto/identity/submit_plc_operation
com/atproto/identity/submit_plc_operation/descriptor
com/atproto/identity/submit_plc_operation/input
com/atproto/identity/update_handle
com/atproto/identity/update_handle/descriptor
com/atproto/identity/update_handle/input
com/atproto/label
com/atproto/label/defs
com/atproto/label/defs/descriptor
com/atproto/label/defs/label
com/atproto/label/defs/label_value
com/atproto/label/defs/label_value_definition
com/atproto/label/defs/label_value_definition_blurs
com/atproto/label/defs/label_value_definition_default_setting
com/atproto/label/defs/label_value_definition_severity
com/atproto/label/defs/label_value_definition_strings
com/atproto/label/defs/self_label
com/atproto/label/defs/self_labels
com/atproto/label/query_labels
com/atproto/label/query_labels/descriptor
com/atproto/label/query_labels/input
com/atproto/label/query_labels/output
com/atproto/label/subscribe_labels
com/atproto/label/subscribe_labels/descriptor
com/atproto/label/subscribe_labels/info
com/atproto/label/subscribe_labels/info_name
com/atproto/label/subscribe_labels/input
com/atproto/label/subscribe_labels/labels
com/atproto/label/subscribe_labels/union_main_message
com/atproto/lexicon
com/atproto/lexicon/resolve_lexicon
com/atproto/lexicon/resolve_lexicon/descriptor
com/atproto/lexicon/resolve_lexicon/input
com/atproto/lexicon/resolve_lexicon/output
com/atproto/lexicon/schema
com/atproto/lexicon/schema/descriptor
com/atproto/lexicon/schema/main
com/atproto/moderation
com/atproto/moderation/create_report
com/atproto/moderation/create_report/descriptor
com/atproto/moderation/create_report/input
com/atproto/moderation/create_report/mod_tool
com/atproto/moderation/create_report/output
com/atproto/moderation/create_report/union_main_input_subject
com/atproto/moderation/create_report/union_main_output_subject
com/atproto/moderation/defs
com/atproto/moderation/defs/reason_type
com/atproto/moderation/defs/subject_type
com/atproto/repo
com/atproto/repo/apply_writes
com/atproto/repo/apply_writes/create
com/atproto/repo/apply_writes/create_result
com/atproto/repo/apply_writes/create_result_validation_status
com/atproto/repo/apply_writes/delete
com/atproto/repo/apply_writes/delete_result
com/atproto/repo/apply_writes/descriptor
com/atproto/repo/apply_writes/input
com/atproto/repo/apply_writes/output
com/atproto/repo/apply_writes/union_main_input_writes
com/atproto/repo/apply_writes/union_main_output_results
com/atproto/repo/apply_writes/update
com/atproto/repo/apply_writes/update_result
com/atproto/repo/apply_writes/update_result_validation_status
com/atproto/repo/create_record
com/atproto/repo/create_record/descriptor
com/atproto/repo/create_record/input
com/atproto/repo/create_record/main_output_validation_status
com/atproto/repo/create_record/output
com/atproto/repo/defs
com/atproto/repo/defs/commit_meta
com/atproto/repo/defs/descriptor
com/atproto/repo/delete_record
com/atproto/repo/delete_record/descriptor
com/atproto/repo/delete_record/input
com/atproto/repo/delete_record/output
com/atproto/repo/describe_repo
com/atproto/repo/describe_repo/descriptor
com/atproto/repo/describe_repo/input
com/atproto/repo/describe_repo/output
com/atproto/repo/get_record
com/atproto/repo/get_record/descriptor
com/atproto/repo/get_record/input
com/atproto/repo/get_record/output
com/atproto/repo/import_repo
com/atproto/repo/import_repo/descriptor
com/atproto/repo/list_missing_blobs
com/atproto/repo/list_missing_blobs/descriptor
com/atproto/repo/list_missing_blobs/input
com/atproto/repo/list_missing_blobs/output
com/atproto/repo/list_missing_blobs/record_blob
com/atproto/repo/list_records
com/atproto/repo/list_records/descriptor
com/atproto/repo/list_records/input
com/atproto/repo/list_records/output
com/atproto/repo/list_records/record
com/atproto/repo/put_record
com/atproto/repo/put_record/descriptor
com/atproto/repo/put_record/input
com/atproto/repo/put_record/main_output_validation_status
com/atproto/repo/put_record/output
com/atproto/repo/strong_ref
com/atproto/repo/strong_ref/descriptor
com/atproto/repo/strong_ref/main
com/atproto/repo/upload_blob
com/atproto/repo/upload_blob/descriptor
com/atproto/repo/upload_blob/output
com/atproto/server
com/atproto/server/activate_account
com/atproto/server/activate_account/descriptor
com/atproto/server/check_account_status
com/atproto/server/check_account_status/descriptor
com/atproto/server/check_account_status/output
com/atproto/server/confirm_email
com/atproto/server/confirm_email/descriptor
com/atproto/server/confirm_email/input
com/atproto/server/create_account
com/atproto/server/create_account/descriptor
com/atproto/server/create_account/input
com/atproto/server/create_account/output
com/atproto/server/create_app_password
com/atproto/server/create_app_password/app_password
com/atproto/server/create_app_password/descriptor
com/atproto/server/create_app_password/input
com/atproto/server/create_invite_code
com/atproto/server/create_invite_code/descriptor
com/atproto/server/create_invite_code/input
com/atproto/server/create_invite_code/output
com/atproto/server/create_invite_codes
com/atproto/server/create_invite_codes/account_codes
com/atproto/server/create_invite_codes/descriptor
com/atproto/server/create_invite_codes/input
com/atproto/server/create_invite_codes/output
com/atproto/server/create_session
com/atproto/server/create_session/descriptor
com/atproto/server/create_session/input
com/atproto/server/create_session/main_output_status
com/atproto/server/create_session/output
com/atproto/server/deactivate_account
com/atproto/server/deactivate_account/descriptor
com/atproto/server/deactivate_account/input
com/atproto/server/defs
com/atproto/server/defs/descriptor
com/atproto/server/defs/invite_code
com/atproto/server/defs/invite_code_use
com/atproto/server/delete_account
com/atproto/server/delete_account/descriptor
com/atproto/server/delete_account/input
com/atproto/server/delete_session
com/atproto/server/delete_session/descriptor
com/atproto/server/describe_server
com/atproto/server/describe_server/contact
com/atproto/server/describe_server/descriptor
com/atproto/server/describe_server/output
com/atproto/server/get_account_invite_codes
com/atproto/server/get_account_invite_codes/descriptor
com/atproto/server/get_account_invite_codes/input
com/atproto/server/get_account_invite_codes/output
com/atproto/server/get_service_auth
com/atproto/server/get_service_auth/descriptor
com/atproto/server/get_service_auth/input
com/atproto/server/get_service_auth/output
com/atproto/server/get_session
com/atproto/server/get_session/descriptor
com/atproto/server/get_session/main_output_status
com/atproto/server/get_session/output
com/atproto/server/list_app_passwords
com/atproto/server/list_app_passwords/app_password
com/atproto/server/list_app_passwords/descriptor
com/atproto/server/list_app_passwords/output
com/atproto/server/refresh_session
com/atproto/server/refresh_session/descriptor
com/atproto/server/refresh_session/main_output_status
com/atproto/server/refresh_session/output
com/atproto/server/request_account_delete
com/atproto/server/request_account_delete/descriptor
com/atproto/server/request_email_confirmation
com/atproto/server/request_email_confirmation/descriptor
com/atproto/server/request_email_update
com/atproto/server/request_email_update/descriptor
com/atproto/server/request_email_update/output
com/atproto/server/request_password_reset
com/atproto/server/request_password_reset/descriptor
com/atproto/server/request_password_reset/input
com/atproto/server/reserve_signing_key
com/atproto/server/reserve_signing_key/descriptor
com/atproto/server/reserve_signing_key/input
com/atproto/server/reserve_signing_key/output
com/atproto/server/reset_password
com/atproto/server/reset_password/descriptor
com/atproto/server/reset_password/input
com/atproto/server/revoke_app_password
com/atproto/server/revoke_app_password/descriptor
com/atproto/server/revoke_app_password/input
com/atproto/server/update_email
com/atproto/server/update_email/descriptor
com/atproto/server/update_email/input
com/atproto/sync
com/atproto/sync/defs
com/atproto/sync/defs/host_status
com/atproto/sync/get_blob
com/atproto/sync/get_blob/descriptor
com/atproto/sync/get_blob/input
com/atproto/sync/get_blocks
com/atproto/sync/get_blocks/descriptor
com/atproto/sync/get_blocks/input
com/atproto/sync/get_checkout
com/atproto/sync/get_checkout/descriptor
com/atproto/sync/get_checkout/input
com/atproto/sync/get_head
com/atproto/sync/get_head/descriptor
com/atproto/sync/get_head/input
com/atproto/sync/get_head/output
com/atproto/sync/get_host_status
com/atproto/sync/get_host_status/descriptor
com/atproto/sync/get_host_status/input
com/atproto/sync/get_host_status/output
com/atproto/sync/get_latest_commit
com/atproto/sync/get_latest_commit/descriptor
com/atproto/sync/get_latest_commit/input
com/atproto/sync/get_latest_commit/output
com/atproto/sync/get_record
com/atproto/sync/get_record/descriptor
com/atproto/sync/get_record/input
com/atproto/sync/get_repo
com/atproto/sync/get_repo/descriptor
com/atproto/sync/get_repo/input
com/atproto/sync/get_repo_status
com/atproto/sync/get_repo_status/descriptor
com/atproto/sync/get_repo_status/input
com/atproto/sync/get_repo_status/main_output_status
com/atproto/sync/get_repo_status/output
com/atproto/sync/list_blobs
com/atproto/sync/list_blobs/descriptor
com/atproto/sync/list_blobs/input
com/atproto/sync/list_blobs/output
com/atproto/sync/list_hosts
com/atproto/sync/list_hosts/descriptor
com/atproto/sync/list_hosts/host
com/atproto/sync/list_hosts/input
com/atproto/sync/list_hosts/output
com/atproto/sync/list_repos
com/atproto/sync/list_repos/descriptor
com/atproto/sync/list_repos/input
com/atproto/sync/list_repos/output
com/atproto/sync/list_repos/repo
com/atproto/sync/list_repos/repo_status
com/atproto/sync/list_repos_by_collection
com/atproto/sync/list_repos_by_collection/descriptor
com/atproto/sync/list_repos_by_collection/input
com/atproto/sync/list_repos_by_collection/output
com/atproto/sync/list_repos_by_collection/repo
com/atproto/sync/notify_of_update
com/atproto/sync/notify_of_update/descriptor
com/atproto/sync/notify_of_update/input
com/atproto/sync/request_crawl
com/atproto/sync/request_crawl/descriptor
com/atproto/sync/request_crawl/input
com/atproto/sync/subscribe_repos
com/atproto/sync/subscribe_repos/account
com/atproto/sync/subscribe_repos/account_status
com/atproto/sync/subscribe_repos/commit
com/atproto/sync/subscribe_repos/descriptor
com/atproto/sync/subscribe_repos/identity
com/atproto/sync/subscribe_repos/info
com/atproto/sync/subscribe_repos/info_name
com/atproto/sync/subscribe_repos/input
com/atproto/sync/subscribe_repos/repo_op
com/atproto/sync/subscribe_repos/repo_op_action
com/atproto/sync/subscribe_repos/sync
com/atproto/sync/subscribe_repos/union_main_message
com/atproto/temp
com/atproto/temp/add_reserved_handle
com/atproto/temp/add_reserved_handle/descriptor
com/atproto/temp/add_reserved_handle/input
com/atproto/temp/check_handle_availability
com/atproto/temp/check_handle_availability/descriptor
com/atproto/temp/check_handle_availability/input
com/atproto/temp/check_handle_availability/output
com/atproto/temp/check_handle_availability/result_available
com/atproto/temp/check_handle_availability/result_unavailable
com/atproto/temp/check_handle_availability/suggestion
com/atproto/temp/check_handle_availability/union_main_output_result
com/atproto/temp/check_signup_queue
com/atproto/temp/check_signup_queue/descriptor
com/atproto/temp/check_signup_queue/output
com/atproto/temp/dereference_scope
com/atproto/temp/dereference_scope/descriptor
com/atproto/temp/dereference_scope/input
com/atproto/temp/dereference_scope/output
com/atproto/temp/fetch_labels
com/atproto/temp/fetch_labels/descriptor
com/atproto/temp/fetch_labels/input
com/atproto/temp/fetch_labels/output
com/atproto/temp/request_phone_verification
com/atproto/temp/request_phone_verification/descriptor
com/atproto/temp/request_phone_verification/input
com/atproto/temp/revoke_account_credentials
com/atproto/temp/revoke_account_credentials/descriptor
com/atproto/temp/revoke_account_credentials/input
docs
ids
poptart_lex