From 1b47e96a203edd6d8cf83ac385c4750b885c7cfc Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 11:41:24 +0100 Subject: [PATCH 01/33] implement basic api extractor impl --- .gitignore | 1 - api-extractor.json | 43 +++ docs/index.md | 12 + docs/js.anyid.md | 13 + docs/js.api.md | 11 + docs/js.apiauthentication.md | 13 + docs/js.apiauthenticationprefix.md | 13 + docs/js.apiclient._constructor_.md | 20 ++ docs/js.apiclient.authtype.md | 11 + docs/js.apiclient.delete.md | 63 ++++ docs/js.apiclient.get.md | 163 ++++++++++ docs/js.apiclient.getauthtype.md | 22 ++ docs/js.apiclient.md | 37 +++ docs/js.apiclient.patch.md | 46 +++ docs/js.apiclient.post.md | 128 ++++++++ docs/js.apiclient.put.md | 59 ++++ docs/js.apiclient.raw.md | 22 ++ docs/js.apiclient.url.md | 11 + docs/js.apiclientoptions.authentication.md | 11 + docs/js.apiclientoptions.baseurl.md | 11 + docs/js.apiclientoptions.md | 19 ++ docs/js.apiresponse.md | 13 + docs/js.assertid.md | 26 ++ docs/js.auth.md | 21 ++ docs/js.auth.password.md | 11 + docs/js.auth.username.md | 11 + docs/js.broad_permissions_map.md | 23 ++ docs/js.build.deployment_id.md | 13 + docs/js.build.digest.md | 13 + docs/js.build.finished_at.md | 13 + docs/js.build.id.md | 13 + docs/js.build.md | 25 ++ docs/js.build.metadata.md | 13 + docs/js.build.method.md | 13 + docs/js.build.started_at.md | 13 + docs/js.build.state.md | 13 + docs/js.buildmetadata.account_type.md | 13 + docs/js.buildmetadata.author.md | 16 + docs/js.buildmetadata.branch.md | 13 + docs/js.buildmetadata.commit_msg.md | 13 + docs/js.buildmetadata.commit_sha.md | 13 + docs/js.buildmetadata.commit_url.md | 13 + docs/js.buildmetadata.md | 25 ++ docs/js.buildmetadata.repo_id.md | 13 + docs/js.buildmetadata.repo_name.md | 13 + docs/js.buildmethod.md | 21 ++ docs/js.buildstate.md | 21 ++ docs/js.bytesizestring.md | 13 + docs/js.bytestring.md | 17 ++ docs/js.byteunit.md | 13 + docs/js.byteunits.md | 11 + docs/js.channel.capabilities.md | 13 + docs/js.channel.created_at.md | 13 + docs/js.channel.id.md | 13 + docs/js.channel.md | 23 ++ docs/js.channel.project.md | 13 + docs/js.channel.state.md | 13 + docs/js.channel.type.md | 13 + docs/js.channelendpoints.md | 52 ++++ docs/js.channels.md | 11 + docs/js.channeltoken.id.md | 13 + docs/js.channeltoken.is_online.md | 13 + docs/js.channeltoken.md | 21 ++ docs/js.channeltoken.project_id.md | 13 + docs/js.channeltoken.state.md | 13 + docs/js.channeltype.md | 20 ++ docs/js.container.created_at.md | 13 + docs/js.container.deployment_id.md | 13 + docs/js.container.id.md | 13 + docs/js.container.internal_ip.md | 13 + docs/js.container.md | 27 ++ docs/js.container.metadata.md | 15 + docs/js.container.region.md | 13 + docs/js.container.state.md | 13 + docs/js.container.type.md | 13 + docs/js.container.uptime.md | 15 + docs/js.container.volume.md | 13 + docs/js.containerlog.level.md | 13 + docs/js.containerlog.md | 23 ++ docs/js.containerlog.message.md | 13 + docs/js.containerlog.nonce.md | 13 + docs/js.containerlog.timestamp.md | 13 + docs/js.containerstate.md | 25 ++ docs/js.default_base_url.md | 13 + docs/js.defaultquotas.md | 19 ++ docs/js.defaultquotas.ram.md | 11 + docs/js.defaultquotas.vcpu.md | 11 + docs/js.deliveryprotocol.md | 11 + docs/js.deployment.active_build.md | 13 + docs/js.deployment.active_rollout.md | 13 + docs/js.deployment.config.md | 13 + docs/js.deployment.container_count.md | 13 + docs/js.deployment.created_at.md | 13 + docs/js.deployment.id.md | 13 + docs/js.deployment.md | 24 ++ docs/js.deployment.name.md | 13 + docs/js.deploymentconfig.md | 23 ++ docs/js.deploymentrollout.md | 20 ++ docs/js.domain.created_at.md | 13 + docs/js.domain.domain.md | 13 + docs/js.domain.id.md | 13 + docs/js.domain.md | 21 ++ docs/js.domain.state.md | 13 + docs/js.domainstate.md | 20 ++ docs/js.empty.md | 11 + docs/js.endpoint.md | 18 ++ docs/js.endpoints.md | 13 + docs/js.erroredapiresponse.md | 17 ++ docs/js.extractrouteparams.md | 17 ++ docs/js.gateway.created_at.md | 13 + docs/js.gateway.deployment_id.md | 13 + docs/js.gateway.domains.md | 13 + docs/js.gateway.hopsh_domain.md | 13 + docs/js.gateway.id.md | 13 + docs/js.gateway.internal_domain.md | 13 + docs/js.gateway.md | 28 ++ docs/js.gateway.name.md | 13 + docs/js.gateway.target_port.md | 13 + docs/js.gateway.type.md | 13 + docs/js.gatewaytype.md | 21 ++ docs/js.getidprefix.md | 23 ++ docs/js.ghrepo.account_name.md | 11 + docs/js.ghrepo.default_branch.md | 11 + docs/js.ghrepo.full_name.md | 11 + docs/js.ghrepo.id.md | 11 + docs/js.ghrepo.md | 24 ++ docs/js.ghrepo.private.md | 11 + docs/js.hop._constructor_.md | 20 ++ docs/js.hop._constructor__1.md | 21 ++ docs/js.hop.channels.md | 53 ++++ docs/js.hop.client.md | 11 + docs/js.hop.ignite.md | 85 ++++++ docs/js.hop.md | 41 +++ docs/js.hop.pipe.md | 30 ++ docs/js.hop.projects.md | 33 ++ docs/js.hop.registry.md | 24 ++ docs/js.hop.users.md | 25 ++ docs/js.hopapierror._constructor_.md | 22 ++ docs/js.hopapierror.data.md | 11 + docs/js.hopapierror.md | 28 ++ docs/js.hopapierror.request.md | 11 + docs/js.hopapierror.response.md | 11 + docs/js.hopapierror.status.md | 11 + docs/js.hopshdomain.md | 11 + docs/js.id.md | 13 + docs/js.id_prefixes.md | 65 ++++ docs/js.idprefixes.md | 13 + docs/js.ignite.md | 11 + docs/js.igniteendpoints.md | 46 +++ docs/js.image_2.auth.md | 13 + docs/js.image_2.gh_repo.md | 13 + docs/js.image_2.md | 22 ++ docs/js.image_2.name.md | 13 + docs/js.imageghrepo.branch.md | 11 + docs/js.imageghrepo.full_name.md | 11 + docs/js.imageghrepo.md | 22 ++ docs/js.imageghrepo.repo_id.md | 11 + docs/js.internalhopdomain.md | 11 + docs/js.is_browser.md | 13 + docs/js.isvalidbytestring.md | 22 ++ docs/js.md | 145 +++++++++ docs/js.member.md | 17 ++ docs/js.memberrole.flags.md | 13 + docs/js.memberrole.id.md | 13 + docs/js.memberrole.md | 20 ++ docs/js.memberrole.name.md | 13 + docs/js.method.md | 11 + docs/js.parsesize.md | 24 ++ docs/js.partialapioptions.md | 13 + docs/js.pat.created_at.md | 13 + docs/js.pat.id.md | 13 + docs/js.pat.md | 20 ++ docs/js.pat.name.md | 13 + docs/js.permissions.md | 15 + docs/js.permissionsmap.md | 56 ++++ docs/js.pipe.md | 11 + docs/js.pipeendpoints.md | 28 ++ docs/js.project.created_at.md | 13 + docs/js.project.default_quotas.md | 11 + docs/js.project.icon.md | 13 + docs/js.project.id.md | 13 + docs/js.project.md | 27 ++ docs/js.project.name.md | 13 + docs/js.project.namespace.md | 13 + docs/js.project.quota_overrides.md | 11 + docs/js.project.quota_usage.md | 11 + docs/js.project.tier.md | 13 + docs/js.project.type.md | 13 + docs/js.project_permission.md | 61 ++++ docs/js.projects.md | 11 + docs/js.projectsendpoints.md | 43 +++ docs/js.projecttier.md | 19 ++ docs/js.projecttoken.created_at.md | 13 + docs/js.projecttoken.flags.md | 13 + docs/js.projecttoken.id.md | 13 + docs/js.projecttoken.md | 23 ++ docs/js.projecttoken.token.md | 13 + docs/js.projecttype.md | 21 ++ docs/js.query.md | 13 + docs/js.quotaoverrides.md | 11 + docs/js.quotausage.md | 19 ++ docs/js.quotausage.ram.md | 11 + docs/js.quotausage.vcpu.md | 11 + docs/js.regions.md | 18 ++ docs/js.registry.md | 11 + docs/js.registryendpoints.md | 24 ++ docs/js.resources.md | 22 ++ docs/js.resources.ram.md | 13 + docs/js.resources.vcpu.md | 13 + docs/js.resources.vgpu.md | 13 + docs/js.restartpolicy.md | 22 ++ docs/js.roles.md | 16 + docs/js.rolloutstate.md | 22 ++ docs/js.room.created_at.md | 13 + docs/js.room.delivery_protocols.md | 13 + docs/js.room.id.md | 13 + docs/js.room.ingest_endpoint.md | 13 + docs/js.room.ingest_protocol.md | 13 + docs/js.room.ingest_region.md | 13 + docs/js.room.join_token.md | 13 + docs/js.room.md | 26 ++ docs/js.room.name.md | 13 + docs/js.room.state.md | 13 + docs/js.runtimetype.md | 22 ++ docs/js.secret.created_at.md | 13 + docs/js.secret.digest.md | 13 + docs/js.secret.id.md | 13 + docs/js.secret.md | 21 ++ docs/js.secret.name.md | 13 + docs/js.state.md | 11 + docs/js.successfulapiresponse.md | 14 + docs/js.supports_intl.md | 11 + docs/js.tag.md | 13 + docs/js.timestamp.md | 15 + docs/js.units.md | 16 + docs/js.user.email.md | 13 + docs/js.user.id.md | 13 + docs/js.user.md | 23 ++ docs/js.user.name.md | 13 + docs/js.user.username.md | 13 + docs/js.userendpoints.md | 24 ++ docs/js.users.md | 11 + docs/js.validateapiauthentication.md | 22 ++ docs/js.validateid.md | 27 ++ docs/js.validateidprefix.md | 27 ++ docs/js.values.md | 11 + docs/js.vgpu.count.md | 13 + docs/js.vgpu.md | 21 ++ docs/js.vgpu.type.md | 13 + docs/js.vgputype.md | 20 ++ docs/js.volumedefinition.fs.md | 13 + docs/js.volumedefinition.md | 20 ++ docs/js.volumedefinition.mount_path.md | 13 + docs/js.volumedefinition.size.md | 13 + docs/js.volumeformat.md | 19 ++ package.json | 2 + src/index.ts | 23 +- src/rest/index.ts | 8 + src/rest/types/ignite.ts | 4 +- src/rest/types/users.ts | 2 +- src/util/types.ts | 32 +- tsconfig.json | 4 +- yarn.lock | 334 ++++++++++++++++++++- 263 files changed, 5234 insertions(+), 20 deletions(-) create mode 100644 api-extractor.json create mode 100644 docs/index.md create mode 100644 docs/js.anyid.md create mode 100644 docs/js.api.md create mode 100644 docs/js.apiauthentication.md create mode 100644 docs/js.apiauthenticationprefix.md create mode 100644 docs/js.apiclient._constructor_.md create mode 100644 docs/js.apiclient.authtype.md create mode 100644 docs/js.apiclient.delete.md create mode 100644 docs/js.apiclient.get.md create mode 100644 docs/js.apiclient.getauthtype.md create mode 100644 docs/js.apiclient.md create mode 100644 docs/js.apiclient.patch.md create mode 100644 docs/js.apiclient.post.md create mode 100644 docs/js.apiclient.put.md create mode 100644 docs/js.apiclient.raw.md create mode 100644 docs/js.apiclient.url.md create mode 100644 docs/js.apiclientoptions.authentication.md create mode 100644 docs/js.apiclientoptions.baseurl.md create mode 100644 docs/js.apiclientoptions.md create mode 100644 docs/js.apiresponse.md create mode 100644 docs/js.assertid.md create mode 100644 docs/js.auth.md create mode 100644 docs/js.auth.password.md create mode 100644 docs/js.auth.username.md create mode 100644 docs/js.broad_permissions_map.md create mode 100644 docs/js.build.deployment_id.md create mode 100644 docs/js.build.digest.md create mode 100644 docs/js.build.finished_at.md create mode 100644 docs/js.build.id.md create mode 100644 docs/js.build.md create mode 100644 docs/js.build.metadata.md create mode 100644 docs/js.build.method.md create mode 100644 docs/js.build.started_at.md create mode 100644 docs/js.build.state.md create mode 100644 docs/js.buildmetadata.account_type.md create mode 100644 docs/js.buildmetadata.author.md create mode 100644 docs/js.buildmetadata.branch.md create mode 100644 docs/js.buildmetadata.commit_msg.md create mode 100644 docs/js.buildmetadata.commit_sha.md create mode 100644 docs/js.buildmetadata.commit_url.md create mode 100644 docs/js.buildmetadata.md create mode 100644 docs/js.buildmetadata.repo_id.md create mode 100644 docs/js.buildmetadata.repo_name.md create mode 100644 docs/js.buildmethod.md create mode 100644 docs/js.buildstate.md create mode 100644 docs/js.bytesizestring.md create mode 100644 docs/js.bytestring.md create mode 100644 docs/js.byteunit.md create mode 100644 docs/js.byteunits.md create mode 100644 docs/js.channel.capabilities.md create mode 100644 docs/js.channel.created_at.md create mode 100644 docs/js.channel.id.md create mode 100644 docs/js.channel.md create mode 100644 docs/js.channel.project.md create mode 100644 docs/js.channel.state.md create mode 100644 docs/js.channel.type.md create mode 100644 docs/js.channelendpoints.md create mode 100644 docs/js.channels.md create mode 100644 docs/js.channeltoken.id.md create mode 100644 docs/js.channeltoken.is_online.md create mode 100644 docs/js.channeltoken.md create mode 100644 docs/js.channeltoken.project_id.md create mode 100644 docs/js.channeltoken.state.md create mode 100644 docs/js.channeltype.md create mode 100644 docs/js.container.created_at.md create mode 100644 docs/js.container.deployment_id.md create mode 100644 docs/js.container.id.md create mode 100644 docs/js.container.internal_ip.md create mode 100644 docs/js.container.md create mode 100644 docs/js.container.metadata.md create mode 100644 docs/js.container.region.md create mode 100644 docs/js.container.state.md create mode 100644 docs/js.container.type.md create mode 100644 docs/js.container.uptime.md create mode 100644 docs/js.container.volume.md create mode 100644 docs/js.containerlog.level.md create mode 100644 docs/js.containerlog.md create mode 100644 docs/js.containerlog.message.md create mode 100644 docs/js.containerlog.nonce.md create mode 100644 docs/js.containerlog.timestamp.md create mode 100644 docs/js.containerstate.md create mode 100644 docs/js.default_base_url.md create mode 100644 docs/js.defaultquotas.md create mode 100644 docs/js.defaultquotas.ram.md create mode 100644 docs/js.defaultquotas.vcpu.md create mode 100644 docs/js.deliveryprotocol.md create mode 100644 docs/js.deployment.active_build.md create mode 100644 docs/js.deployment.active_rollout.md create mode 100644 docs/js.deployment.config.md create mode 100644 docs/js.deployment.container_count.md create mode 100644 docs/js.deployment.created_at.md create mode 100644 docs/js.deployment.id.md create mode 100644 docs/js.deployment.md create mode 100644 docs/js.deployment.name.md create mode 100644 docs/js.deploymentconfig.md create mode 100644 docs/js.deploymentrollout.md create mode 100644 docs/js.domain.created_at.md create mode 100644 docs/js.domain.domain.md create mode 100644 docs/js.domain.id.md create mode 100644 docs/js.domain.md create mode 100644 docs/js.domain.state.md create mode 100644 docs/js.domainstate.md create mode 100644 docs/js.empty.md create mode 100644 docs/js.endpoint.md create mode 100644 docs/js.endpoints.md create mode 100644 docs/js.erroredapiresponse.md create mode 100644 docs/js.extractrouteparams.md create mode 100644 docs/js.gateway.created_at.md create mode 100644 docs/js.gateway.deployment_id.md create mode 100644 docs/js.gateway.domains.md create mode 100644 docs/js.gateway.hopsh_domain.md create mode 100644 docs/js.gateway.id.md create mode 100644 docs/js.gateway.internal_domain.md create mode 100644 docs/js.gateway.md create mode 100644 docs/js.gateway.name.md create mode 100644 docs/js.gateway.target_port.md create mode 100644 docs/js.gateway.type.md create mode 100644 docs/js.gatewaytype.md create mode 100644 docs/js.getidprefix.md create mode 100644 docs/js.ghrepo.account_name.md create mode 100644 docs/js.ghrepo.default_branch.md create mode 100644 docs/js.ghrepo.full_name.md create mode 100644 docs/js.ghrepo.id.md create mode 100644 docs/js.ghrepo.md create mode 100644 docs/js.ghrepo.private.md create mode 100644 docs/js.hop._constructor_.md create mode 100644 docs/js.hop._constructor__1.md create mode 100644 docs/js.hop.channels.md create mode 100644 docs/js.hop.client.md create mode 100644 docs/js.hop.ignite.md create mode 100644 docs/js.hop.md create mode 100644 docs/js.hop.pipe.md create mode 100644 docs/js.hop.projects.md create mode 100644 docs/js.hop.registry.md create mode 100644 docs/js.hop.users.md create mode 100644 docs/js.hopapierror._constructor_.md create mode 100644 docs/js.hopapierror.data.md create mode 100644 docs/js.hopapierror.md create mode 100644 docs/js.hopapierror.request.md create mode 100644 docs/js.hopapierror.response.md create mode 100644 docs/js.hopapierror.status.md create mode 100644 docs/js.hopshdomain.md create mode 100644 docs/js.id.md create mode 100644 docs/js.id_prefixes.md create mode 100644 docs/js.idprefixes.md create mode 100644 docs/js.ignite.md create mode 100644 docs/js.igniteendpoints.md create mode 100644 docs/js.image_2.auth.md create mode 100644 docs/js.image_2.gh_repo.md create mode 100644 docs/js.image_2.md create mode 100644 docs/js.image_2.name.md create mode 100644 docs/js.imageghrepo.branch.md create mode 100644 docs/js.imageghrepo.full_name.md create mode 100644 docs/js.imageghrepo.md create mode 100644 docs/js.imageghrepo.repo_id.md create mode 100644 docs/js.internalhopdomain.md create mode 100644 docs/js.is_browser.md create mode 100644 docs/js.isvalidbytestring.md create mode 100644 docs/js.md create mode 100644 docs/js.member.md create mode 100644 docs/js.memberrole.flags.md create mode 100644 docs/js.memberrole.id.md create mode 100644 docs/js.memberrole.md create mode 100644 docs/js.memberrole.name.md create mode 100644 docs/js.method.md create mode 100644 docs/js.parsesize.md create mode 100644 docs/js.partialapioptions.md create mode 100644 docs/js.pat.created_at.md create mode 100644 docs/js.pat.id.md create mode 100644 docs/js.pat.md create mode 100644 docs/js.pat.name.md create mode 100644 docs/js.permissions.md create mode 100644 docs/js.permissionsmap.md create mode 100644 docs/js.pipe.md create mode 100644 docs/js.pipeendpoints.md create mode 100644 docs/js.project.created_at.md create mode 100644 docs/js.project.default_quotas.md create mode 100644 docs/js.project.icon.md create mode 100644 docs/js.project.id.md create mode 100644 docs/js.project.md create mode 100644 docs/js.project.name.md create mode 100644 docs/js.project.namespace.md create mode 100644 docs/js.project.quota_overrides.md create mode 100644 docs/js.project.quota_usage.md create mode 100644 docs/js.project.tier.md create mode 100644 docs/js.project.type.md create mode 100644 docs/js.project_permission.md create mode 100644 docs/js.projects.md create mode 100644 docs/js.projectsendpoints.md create mode 100644 docs/js.projecttier.md create mode 100644 docs/js.projecttoken.created_at.md create mode 100644 docs/js.projecttoken.flags.md create mode 100644 docs/js.projecttoken.id.md create mode 100644 docs/js.projecttoken.md create mode 100644 docs/js.projecttoken.token.md create mode 100644 docs/js.projecttype.md create mode 100644 docs/js.query.md create mode 100644 docs/js.quotaoverrides.md create mode 100644 docs/js.quotausage.md create mode 100644 docs/js.quotausage.ram.md create mode 100644 docs/js.quotausage.vcpu.md create mode 100644 docs/js.regions.md create mode 100644 docs/js.registry.md create mode 100644 docs/js.registryendpoints.md create mode 100644 docs/js.resources.md create mode 100644 docs/js.resources.ram.md create mode 100644 docs/js.resources.vcpu.md create mode 100644 docs/js.resources.vgpu.md create mode 100644 docs/js.restartpolicy.md create mode 100644 docs/js.roles.md create mode 100644 docs/js.rolloutstate.md create mode 100644 docs/js.room.created_at.md create mode 100644 docs/js.room.delivery_protocols.md create mode 100644 docs/js.room.id.md create mode 100644 docs/js.room.ingest_endpoint.md create mode 100644 docs/js.room.ingest_protocol.md create mode 100644 docs/js.room.ingest_region.md create mode 100644 docs/js.room.join_token.md create mode 100644 docs/js.room.md create mode 100644 docs/js.room.name.md create mode 100644 docs/js.room.state.md create mode 100644 docs/js.runtimetype.md create mode 100644 docs/js.secret.created_at.md create mode 100644 docs/js.secret.digest.md create mode 100644 docs/js.secret.id.md create mode 100644 docs/js.secret.md create mode 100644 docs/js.secret.name.md create mode 100644 docs/js.state.md create mode 100644 docs/js.successfulapiresponse.md create mode 100644 docs/js.supports_intl.md create mode 100644 docs/js.tag.md create mode 100644 docs/js.timestamp.md create mode 100644 docs/js.units.md create mode 100644 docs/js.user.email.md create mode 100644 docs/js.user.id.md create mode 100644 docs/js.user.md create mode 100644 docs/js.user.name.md create mode 100644 docs/js.user.username.md create mode 100644 docs/js.userendpoints.md create mode 100644 docs/js.users.md create mode 100644 docs/js.validateapiauthentication.md create mode 100644 docs/js.validateid.md create mode 100644 docs/js.validateidprefix.md create mode 100644 docs/js.values.md create mode 100644 docs/js.vgpu.count.md create mode 100644 docs/js.vgpu.md create mode 100644 docs/js.vgpu.type.md create mode 100644 docs/js.vgputype.md create mode 100644 docs/js.volumedefinition.fs.md create mode 100644 docs/js.volumedefinition.md create mode 100644 docs/js.volumedefinition.mount_path.md create mode 100644 docs/js.volumedefinition.size.md create mode 100644 docs/js.volumeformat.md diff --git a/.gitignore b/.gitignore index 80eea3d4..d779188e 100644 --- a/.gitignore +++ b/.gitignore @@ -6,5 +6,4 @@ node_modules .DS_Store dist _workbench.ts -docs .env diff --git a/api-extractor.json b/api-extractor.json new file mode 100644 index 00000000..1577b856 --- /dev/null +++ b/api-extractor.json @@ -0,0 +1,43 @@ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + "mainEntryPointFilePath": "/dist/index.d.ts", + + "bundledPackages": [], + + "compiler": {}, + + "apiReport": { + "enabled": false + }, + + "docModel": { + "enabled": true, + "apiJsonFilePath": "/docs/js.api.json" + }, + + "dtsRollup": { + "enabled": false + }, + + "tsdocMetadata": {}, + + "messages": { + "compilerMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + } + }, + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + } + } + } +} diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..68578b1b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@onehop/js](./js.md) | | + diff --git a/docs/js.anyid.md b/docs/js.anyid.md new file mode 100644 index 00000000..1a818b72 --- /dev/null +++ b/docs/js.anyid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [AnyId](./js.anyid.md) + +## AnyId type + +Signature: + +```typescript +declare type AnyId = Id; +``` +References: [Id](./js.id.md), [IdPrefixes](./js.idprefixes.md) + diff --git a/docs/js.api.md b/docs/js.api.md new file mode 100644 index 00000000..3416e85f --- /dev/null +++ b/docs/js.api.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [API](./js.api.md) + +## API namespace + +Signature: + +```typescript +declare namespace api +``` diff --git a/docs/js.apiauthentication.md b/docs/js.apiauthentication.md new file mode 100644 index 00000000..d900aec7 --- /dev/null +++ b/docs/js.apiauthentication.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthentication](./js.apiauthentication.md) + +## APIAuthentication type + +Signature: + +```typescript +declare type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; +``` +References: [Id](./js.id.md) + diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md new file mode 100644 index 00000000..4c37a0f7 --- /dev/null +++ b/docs/js.apiauthenticationprefix.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) + +## APIAuthenticationPrefix type + +Signature: + +```typescript +declare type APIAuthenticationPrefix = APIAuthentication extends Id ? T : never; +``` +References: [APIAuthentication](./js.apiauthentication.md), [Id](./js.id.md) + diff --git a/docs/js.apiclient._constructor_.md b/docs/js.apiclient._constructor_.md new file mode 100644 index 00000000..4d08fdcf --- /dev/null +++ b/docs/js.apiclient._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [(constructor)](./js.apiclient._constructor_.md) + +## APIClient.(constructor) + +Constructs a new instance of the `APIClient` class + +Signature: + +```typescript +constructor(options: APIClientOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [APIClientOptions](./js.apiclientoptions.md) | | + diff --git a/docs/js.apiclient.authtype.md b/docs/js.apiclient.authtype.md new file mode 100644 index 00000000..f315c069 --- /dev/null +++ b/docs/js.apiclient.authtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [authType](./js.apiclient.authtype.md) + +## APIClient.authType property + +Signature: + +```typescript +readonly authType: "ptk" | "pat" | "bearer"; +``` diff --git a/docs/js.apiclient.delete.md b/docs/js.apiclient.delete.md new file mode 100644 index 00000000..1c3d9b4a --- /dev/null +++ b/docs/js.apiclient.delete.md @@ -0,0 +1,63 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [delete](./js.apiclient.delete.md) + +## APIClient.delete() method + +Signature: + +```typescript +delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }>)["res"]>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; }>\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise<(Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/users/@me/pats/:pat\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/:channel\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/tokens/:token", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/registry/images/:image", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/deployments/:deployment\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/containers/:container\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/pipe/rooms/:room\_id", void, undefined>, { path: Path; method: 'DELETE'; }>)\["res"\]> + diff --git a/docs/js.apiclient.get.md b/docs/js.apiclient.get.md new file mode 100644 index 00000000..abe7d784 --- /dev/null +++ b/docs/js.apiclient.get.md @@ -0,0 +1,163 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [get](./js.apiclient.get.md) + +## APIClient.get() method + +Signature: + +```typescript +get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; + leap_token: string | null; + }, undefined>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }>)["res"]>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise<(Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me", { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me/pats", { pats: [PAT](./js.pat.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members/@me", { project\_member: [Member](./js.member.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/tokens", { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/state", { state: [State](./js.state.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels", { channels: [Channel](./js.channel.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/stats", { stats: { online\_count: number; }; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images", { images: string\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images/:image/manifests", { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments", { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/containers", { containers: [Container](./js.container.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/containers/:container\_id/logs", { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/search", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/gateways/:gateway\_id", { gateway: [Gateway](./js.gateway.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/gateways", { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/pipe/rooms", { rooms: [Room](./js.room.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }>)\["res"\]> + diff --git a/docs/js.apiclient.getauthtype.md b/docs/js.apiclient.getauthtype.md new file mode 100644 index 00000000..0323dab7 --- /dev/null +++ b/docs/js.apiclient.getauthtype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [getAuthType](./js.apiclient.getauthtype.md) + +## APIClient.getAuthType() method + +Signature: + +```typescript +static getAuthType(auth: APIAuthentication): "ptk" | "pat" | "bearer"; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | [APIAuthentication](./js.apiauthentication.md) | | + +Returns: + +"ptk" \| "pat" \| "bearer" + diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md new file mode 100644 index 00000000..ae2b398d --- /dev/null +++ b/docs/js.apiclient.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) + +## APIClient class + +Signature: + +```typescript +declare class APIClient +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./js.apiclient._constructor_.md) | | Constructs a new instance of the APIClient class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [authType](./js.apiclient.authtype.md) | readonly | "ptk" \| "pat" \| "bearer" | | +| [url](./js.apiclient.url.md) | readonly | <Path extends string>(path: Path, query: [Query](./js.query.md)<Path>) => string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [delete(path, body, query, init)](./js.apiclient.delete.md) | | | +| [get(path, query, init)](./js.apiclient.get.md) | | | +| [getAuthType(auth)](./js.apiclient.getauthtype.md) | static | | +| [patch(path, body, query, init)](./js.apiclient.patch.md) | | | +| [post(path, body, query, init)](./js.apiclient.post.md) | | | +| [put(path, body, query, init)](./js.apiclient.put.md) | | | +| [raw(request)](./js.apiclient.raw.md) | | | + diff --git a/docs/js.apiclient.patch.md b/docs/js.apiclient.patch.md new file mode 100644 index 00000000..dc0439ff --- /dev/null +++ b/docs/js.apiclient.patch.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [patch](./js.apiclient.patch.md) + +## APIClient.patch() method + +Signature: + +```typescript +patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }>)["res"]>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; }>\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise<(Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); }>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'PATCH'; }>)\["res"\]> + diff --git a/docs/js.apiclient.post.md b/docs/js.apiclient.post.md new file mode 100644 index 00000000..24f385e0 --- /dev/null +++ b/docs/js.apiclient.post.md @@ -0,0 +1,128 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [post](./js.apiclient.post.md) + +## APIClient.post() method + +Signature: + +```typescript +post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract | null; + }>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }>)["res"]>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; }>\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise<(Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/users/@me/pats", { pat: [PAT](./js.pat.md); }, { name: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/:project\_id/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/@this/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens", { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens/:token/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/:channel\_id/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers", { container: [Container](./js.container.md); }, undefined>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers/:container\_id", never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/gateways/:gateway\_id/domains", void, { domain: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/gateways", { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: "http" \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/pipe/rooms", { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: "rtmp" \| "rtp"; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }>, { path: Path; method: 'POST'; }>)\["res"\]> + diff --git a/docs/js.apiclient.put.md b/docs/js.apiclient.put.md new file mode 100644 index 00000000..df948bae --- /dev/null +++ b/docs/js.apiclient.put.md @@ -0,0 +1,59 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [put](./js.apiclient.put.md) + +## APIClient.put() method + +Signature: + +```typescript +put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract | null; + }>, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }>)["res"]>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; }>\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise<(Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/:project\_id/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/@this/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/subscribers/:token", void, undefined>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/ignite/containers/:container\_id/state", void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); }>, { path: Path; method: 'PUT'; }>)\["res"\]> + diff --git a/docs/js.apiclient.raw.md b/docs/js.apiclient.raw.md new file mode 100644 index 00000000..68c10574 --- /dev/null +++ b/docs/js.apiclient.raw.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [raw](./js.apiclient.raw.md) + +## APIClient.raw() method + +Signature: + +```typescript +raw(request: Request): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | Request | | + +Returns: + +Promise<T> + diff --git a/docs/js.apiclient.url.md b/docs/js.apiclient.url.md new file mode 100644 index 00000000..72b14f7d --- /dev/null +++ b/docs/js.apiclient.url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [url](./js.apiclient.url.md) + +## APIClient.url property + +Signature: + +```typescript +readonly url: (path: Path, query: Query) => string; +``` diff --git a/docs/js.apiclientoptions.authentication.md b/docs/js.apiclientoptions.authentication.md new file mode 100644 index 00000000..07b6a1e5 --- /dev/null +++ b/docs/js.apiclientoptions.authentication.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [authentication](./js.apiclientoptions.authentication.md) + +## APIClientOptions.authentication property + +Signature: + +```typescript +readonly authentication: APIAuthentication; +``` diff --git a/docs/js.apiclientoptions.baseurl.md b/docs/js.apiclientoptions.baseurl.md new file mode 100644 index 00000000..1faa1238 --- /dev/null +++ b/docs/js.apiclientoptions.baseurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [baseUrl](./js.apiclientoptions.baseurl.md) + +## APIClientOptions.baseUrl property + +Signature: + +```typescript +readonly baseUrl: string; +``` diff --git a/docs/js.apiclientoptions.md b/docs/js.apiclientoptions.md new file mode 100644 index 00000000..708447b2 --- /dev/null +++ b/docs/js.apiclientoptions.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) + +## APIClientOptions interface + +Signature: + +```typescript +interface APIClientOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [authentication](./js.apiclientoptions.authentication.md) | readonly | [APIAuthentication](./js.apiauthentication.md) | | +| [baseUrl](./js.apiclientoptions.baseurl.md) | readonly | string | | + diff --git a/docs/js.apiresponse.md b/docs/js.apiresponse.md new file mode 100644 index 00000000..4cb4fbde --- /dev/null +++ b/docs/js.apiresponse.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIResponse](./js.apiresponse.md) + +## APIResponse type + +Signature: + +```typescript +declare type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; +``` +References: [SuccessfulAPIResponse](./js.successfulapiresponse.md), [ErroredAPIResponse](./js.erroredapiresponse.md) + diff --git a/docs/js.assertid.md b/docs/js.assertid.md new file mode 100644 index 00000000..76685fdb --- /dev/null +++ b/docs/js.assertid.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [assertId](./js.assertid.md) + +## assertId() function + +Asserts that a string is a valid ID + +Signature: + +```typescript +declare function assertId(maybeId?: string, prefix?: T | T[], message?: string): asserts maybeId is Id; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| maybeId | string | (Optional) A string that is possibly an ID | +| prefix | T \| T\[\] | (Optional) A prefix or array of prefixes to check against | +| message | string | (Optional) An error message to throw if the ID is invalid | + +Returns: + +asserts maybeId is [Id](./js.id.md)<T> + diff --git a/docs/js.auth.md b/docs/js.auth.md new file mode 100644 index 00000000..b839dd9f --- /dev/null +++ b/docs/js.auth.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) + +## Auth interface + +Docker image registry authorization + +Signature: + +```typescript +interface Auth +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [password](./js.auth.password.md) | | string | | +| [username](./js.auth.username.md) | | string | | + diff --git a/docs/js.auth.password.md b/docs/js.auth.password.md new file mode 100644 index 00000000..3856a18d --- /dev/null +++ b/docs/js.auth.password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [password](./js.auth.password.md) + +## Auth.password property + +Signature: + +```typescript +password: string; +``` diff --git a/docs/js.auth.username.md b/docs/js.auth.username.md new file mode 100644 index 00000000..f837a54e --- /dev/null +++ b/docs/js.auth.username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [username](./js.auth.username.md) + +## Auth.username property + +Signature: + +```typescript +username: string; +``` diff --git a/docs/js.broad_permissions_map.md b/docs/js.broad_permissions_map.md new file mode 100644 index 00000000..14eadb3d --- /dev/null +++ b/docs/js.broad_permissions_map.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) + +## BROAD\_PERMISSIONS\_MAP variable + +Signature: + +```typescript +BROAD_PERMISSIONS_MAP: { + MANAGE_MEMBERS: bigint; + MANAGE_PROJECT_TOKENS: bigint; + MANAGE_DEPLOYMENTS: bigint; + MANAGE_PIPE: bigint; + MANAGE_SECRETS: bigint; + MANAGE_CHANNELS: bigint; + MANAGE_REGISTRY: bigint; + READ_ONLY: bigint; + MANAGE_QUOTAS: bigint; + MANAGE_ROLLOUTS: bigint; + MANAGE_BILLING: bigint; +} +``` diff --git a/docs/js.build.deployment_id.md b/docs/js.build.deployment_id.md new file mode 100644 index 00000000..05320027 --- /dev/null +++ b/docs/js.build.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [deployment\_id](./js.build.deployment_id.md) + +## Build.deployment\_id property + +Deployment ID for build + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.build.digest.md b/docs/js.build.digest.md new file mode 100644 index 00000000..265b829b --- /dev/null +++ b/docs/js.build.digest.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [digest](./js.build.digest.md) + +## Build.digest property + +Digest for image + +Signature: + +```typescript +digest: string | null; +``` diff --git a/docs/js.build.finished_at.md b/docs/js.build.finished_at.md new file mode 100644 index 00000000..264bcbc3 --- /dev/null +++ b/docs/js.build.finished_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [finished\_at](./js.build.finished_at.md) + +## Build.finished\_at property + +Timestamp of when the build has finished + +Signature: + +```typescript +finished_at: Timestamp | null; +``` diff --git a/docs/js.build.id.md b/docs/js.build.id.md new file mode 100644 index 00000000..ce741698 --- /dev/null +++ b/docs/js.build.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [id](./js.build.id.md) + +## Build.id property + +ID of the build + +Signature: + +```typescript +id: Id<'build'>; +``` diff --git a/docs/js.build.md b/docs/js.build.md new file mode 100644 index 00000000..96489fe6 --- /dev/null +++ b/docs/js.build.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) + +## Build interface + +Signature: + +```typescript +interface Build +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [deployment\_id](./js.build.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | Deployment ID for build | +| [digest](./js.build.digest.md) | | string \| null | Digest for image | +| [finished\_at](./js.build.finished_at.md) | | [Timestamp](./js.timestamp.md) \| null | Timestamp of when the build has finished | +| [id](./js.build.id.md) | | [Id](./js.id.md)<'build'> | ID of the build | +| [metadata](./js.build.metadata.md) | | [BuildMetaData](./js.buildmetadata.md) \| null | Metadata pertaining to build (mostly for GitHub) | +| [method](./js.build.method.md) | | [BuildMethod](./js.buildmethod.md) | Build method (GitHub or CLI) | +| [started\_at](./js.build.started_at.md) | | [Timestamp](./js.timestamp.md) | Timestamp of when the build has started | +| [state](./js.build.state.md) | | [BuildState](./js.buildstate.md) | State of the build | + diff --git a/docs/js.build.metadata.md b/docs/js.build.metadata.md new file mode 100644 index 00000000..c41c702c --- /dev/null +++ b/docs/js.build.metadata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [metadata](./js.build.metadata.md) + +## Build.metadata property + +Metadata pertaining to build (mostly for GitHub) + +Signature: + +```typescript +metadata: BuildMetaData | null; +``` diff --git a/docs/js.build.method.md b/docs/js.build.method.md new file mode 100644 index 00000000..549e9cf5 --- /dev/null +++ b/docs/js.build.method.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [method](./js.build.method.md) + +## Build.method property + +Build method (GitHub or CLI) + +Signature: + +```typescript +method: BuildMethod; +``` diff --git a/docs/js.build.started_at.md b/docs/js.build.started_at.md new file mode 100644 index 00000000..3d633757 --- /dev/null +++ b/docs/js.build.started_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [started\_at](./js.build.started_at.md) + +## Build.started\_at property + +Timestamp of when the build has started + +Signature: + +```typescript +started_at: Timestamp; +``` diff --git a/docs/js.build.state.md b/docs/js.build.state.md new file mode 100644 index 00000000..93ed8148 --- /dev/null +++ b/docs/js.build.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [state](./js.build.state.md) + +## Build.state property + +State of the build + +Signature: + +```typescript +state: BuildState; +``` diff --git a/docs/js.buildmetadata.account_type.md b/docs/js.buildmetadata.account_type.md new file mode 100644 index 00000000..a54d88f1 --- /dev/null +++ b/docs/js.buildmetadata.account_type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [account\_type](./js.buildmetadata.account_type.md) + +## BuildMetaData.account\_type property + +Account type of repo owner + +Signature: + +```typescript +account_type?: 'user' | 'organization'; +``` diff --git a/docs/js.buildmetadata.author.md b/docs/js.buildmetadata.author.md new file mode 100644 index 00000000..0ef445f1 --- /dev/null +++ b/docs/js.buildmetadata.author.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [author](./js.buildmetadata.author.md) + +## BuildMetaData.author property + +Author information about build + +Signature: + +```typescript +author?: { + avatar_url: string; + username: string; + }; +``` diff --git a/docs/js.buildmetadata.branch.md b/docs/js.buildmetadata.branch.md new file mode 100644 index 00000000..894d86c8 --- /dev/null +++ b/docs/js.buildmetadata.branch.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [branch](./js.buildmetadata.branch.md) + +## BuildMetaData.branch property + +Repo branch for build + +Signature: + +```typescript +branch: string; +``` diff --git a/docs/js.buildmetadata.commit_msg.md b/docs/js.buildmetadata.commit_msg.md new file mode 100644 index 00000000..82e95cdd --- /dev/null +++ b/docs/js.buildmetadata.commit_msg.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_msg](./js.buildmetadata.commit_msg.md) + +## BuildMetaData.commit\_msg property + +commit message for build + +Signature: + +```typescript +commit_msg: string; +``` diff --git a/docs/js.buildmetadata.commit_sha.md b/docs/js.buildmetadata.commit_sha.md new file mode 100644 index 00000000..b4d5896d --- /dev/null +++ b/docs/js.buildmetadata.commit_sha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_sha](./js.buildmetadata.commit_sha.md) + +## BuildMetaData.commit\_sha property + +commit SHA for build + +Signature: + +```typescript +commit_sha: string; +``` diff --git a/docs/js.buildmetadata.commit_url.md b/docs/js.buildmetadata.commit_url.md new file mode 100644 index 00000000..fcbbe4fc --- /dev/null +++ b/docs/js.buildmetadata.commit_url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_url](./js.buildmetadata.commit_url.md) + +## BuildMetaData.commit\_url property + +commit URL for build + +Signature: + +```typescript +commit_url?: string; +``` diff --git a/docs/js.buildmetadata.md b/docs/js.buildmetadata.md new file mode 100644 index 00000000..5dd3c2f5 --- /dev/null +++ b/docs/js.buildmetadata.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) + +## BuildMetaData interface + +Signature: + +```typescript +interface BuildMetaData +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [account\_type?](./js.buildmetadata.account_type.md) | | 'user' \| 'organization' | (Optional) Account type of repo owner | +| [author?](./js.buildmetadata.author.md) | | { avatar\_url: string; username: string; } | (Optional) Author information about build | +| [branch](./js.buildmetadata.branch.md) | | string | Repo branch for build | +| [commit\_msg](./js.buildmetadata.commit_msg.md) | | string | commit message for build | +| [commit\_sha](./js.buildmetadata.commit_sha.md) | | string | commit SHA for build | +| [commit\_url?](./js.buildmetadata.commit_url.md) | | string | (Optional) commit URL for build | +| [repo\_id](./js.buildmetadata.repo_id.md) | | number | Repo ID for build | +| [repo\_name](./js.buildmetadata.repo_name.md) | | string | Repo name for build | + diff --git a/docs/js.buildmetadata.repo_id.md b/docs/js.buildmetadata.repo_id.md new file mode 100644 index 00000000..d75d34e8 --- /dev/null +++ b/docs/js.buildmetadata.repo_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_id](./js.buildmetadata.repo_id.md) + +## BuildMetaData.repo\_id property + +Repo ID for build + +Signature: + +```typescript +repo_id: number; +``` diff --git a/docs/js.buildmetadata.repo_name.md b/docs/js.buildmetadata.repo_name.md new file mode 100644 index 00000000..975f39cd --- /dev/null +++ b/docs/js.buildmetadata.repo_name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_name](./js.buildmetadata.repo_name.md) + +## BuildMetaData.repo\_name property + +Repo name for build + +Signature: + +```typescript +repo_name: string; +``` diff --git a/docs/js.buildmethod.md b/docs/js.buildmethod.md new file mode 100644 index 00000000..c7523589 --- /dev/null +++ b/docs/js.buildmethod.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMethod](./js.buildmethod.md) + +## BuildMethod enum + +Types of build methods supported by Hop + +Signature: + +```typescript +declare enum BuildMethod +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CLI | "cli" | | +| GITHUB | "github" | | + diff --git a/docs/js.buildstate.md b/docs/js.buildstate.md new file mode 100644 index 00000000..709f397f --- /dev/null +++ b/docs/js.buildstate.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildState](./js.buildstate.md) + +## BuildState enum + +Signature: + +```typescript +declare enum BuildState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CANCELLED | "cancelled" | | +| FAILED | "failed" | | +| PENDING | "pending" | | +| SUCCEEDED | "succeeded" | | + diff --git a/docs/js.bytesizestring.md b/docs/js.bytesizestring.md new file mode 100644 index 00000000..1242e0aa --- /dev/null +++ b/docs/js.bytesizestring.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteSizeString](./js.bytesizestring.md) + +## ByteSizeString type + +Signature: + +```typescript +declare type ByteSizeString = `${number}${ByteUnit}`; +``` +References: [ByteUnit](./js.byteunit.md) + diff --git a/docs/js.bytestring.md b/docs/js.bytestring.md new file mode 100644 index 00000000..58797fc6 --- /dev/null +++ b/docs/js.bytestring.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteString](./js.bytestring.md) + +## ByteString type + +> Warning: This API is now obsolete. +> +> + +Signature: + +```typescript +declare type ByteString = ByteSizeString; +``` +References: [ByteSizeString](./js.bytesizestring.md) + diff --git a/docs/js.byteunit.md b/docs/js.byteunit.md new file mode 100644 index 00000000..12ed8a07 --- /dev/null +++ b/docs/js.byteunit.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteUnit](./js.byteunit.md) + +## ByteUnit type + +Signature: + +```typescript +declare type ByteUnit = typeof byteUnits[number] | Uppercase; +``` +References: [byteUnits](./js.byteunits.md) + diff --git a/docs/js.byteunits.md b/docs/js.byteunits.md new file mode 100644 index 00000000..d4228c14 --- /dev/null +++ b/docs/js.byteunits.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [byteUnits](./js.byteunits.md) + +## byteUnits variable + +Signature: + +```typescript +byteUnits: readonly ["GB", "MB", "KB", "B"] +``` diff --git a/docs/js.channel.capabilities.md b/docs/js.channel.capabilities.md new file mode 100644 index 00000000..b3ea3beb --- /dev/null +++ b/docs/js.channel.capabilities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [capabilities](./js.channel.capabilities.md) + +## Channel.capabilities property + +Capabilities of the channel + +Signature: + +```typescript +capabilities: number; +``` diff --git a/docs/js.channel.created_at.md b/docs/js.channel.created_at.md new file mode 100644 index 00000000..79b26d9b --- /dev/null +++ b/docs/js.channel.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [created\_at](./js.channel.created_at.md) + +## Channel.created\_at property + +When this channel was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.channel.id.md b/docs/js.channel.id.md new file mode 100644 index 00000000..e5171cc3 --- /dev/null +++ b/docs/js.channel.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [id](./js.channel.id.md) + +## Channel.id property + +The ID of the channel + +Signature: + +```typescript +id: string; +``` diff --git a/docs/js.channel.md b/docs/js.channel.md new file mode 100644 index 00000000..5c6b2553 --- /dev/null +++ b/docs/js.channel.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) + +## Channel interface + +Signature: + +```typescript +interface Channel +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [capabilities](./js.channel.capabilities.md) | | number | Capabilities of the channel | +| [created\_at](./js.channel.created_at.md) | | [Timestamp](./js.timestamp.md) | When this channel was created | +| [id](./js.channel.id.md) | | string | The ID of the channel | +| [project](./js.channel.project.md) | | [Project](./js.project.md) | The project it is associated with | +| [state](./js.channel.state.md) | | [State](./js.state.md) | State metadata | +| [type](./js.channel.type.md) | | [ChannelType](./js.channeltype.md) | The type of this channel | + diff --git a/docs/js.channel.project.md b/docs/js.channel.project.md new file mode 100644 index 00000000..24a252b1 --- /dev/null +++ b/docs/js.channel.project.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [project](./js.channel.project.md) + +## Channel.project property + +The project it is associated with + +Signature: + +```typescript +project: Project; +``` diff --git a/docs/js.channel.state.md b/docs/js.channel.state.md new file mode 100644 index 00000000..82c4daa1 --- /dev/null +++ b/docs/js.channel.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [state](./js.channel.state.md) + +## Channel.state property + +State metadata + +Signature: + +```typescript +state: State; +``` diff --git a/docs/js.channel.type.md b/docs/js.channel.type.md new file mode 100644 index 00000000..10abf46b --- /dev/null +++ b/docs/js.channel.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [type](./js.channel.type.md) + +## Channel.type property + +The type of this channel + +Signature: + +```typescript +type: ChannelType; +``` diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md new file mode 100644 index 00000000..a8b9f4b7 --- /dev/null +++ b/docs/js.channelendpoints.md @@ -0,0 +1,52 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelEndpoints](./js.channelendpoints.md) + +## ChannelEndpoints type + +Signature: + +```typescript +declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'PUT', '/v1/channels/:channel_id', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'POST', '/v1/channels/tokens', { + token: ChannelToken; +}, { + state: State; +}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { + channel: Channel; +}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { + tokens: ChannelToken[]; +}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { + state: State; +}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'GET', '/v1/channels', { + channels: Channel[]; +}> | Endpoint<'GET', '/v1/channels/tokens/:token', { + token: ChannelToken; +}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { + token: ChannelToken; +}, { + expiresAt?: Timestamp | null; + state: ChannelToken['state']; +}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { + stats: { + online_count: number; + }; +}>; +``` +References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) + diff --git a/docs/js.channels.md b/docs/js.channels.md new file mode 100644 index 00000000..f2cb6af5 --- /dev/null +++ b/docs/js.channels.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channels](./js.channels.md) + +## Channels namespace + +Signature: + +```typescript +declare namespace channels +``` diff --git a/docs/js.channeltoken.id.md b/docs/js.channeltoken.id.md new file mode 100644 index 00000000..0ea11a85 --- /dev/null +++ b/docs/js.channeltoken.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [id](./js.channeltoken.id.md) + +## ChannelToken.id property + +The ID for the token + +Signature: + +```typescript +id: Id<'leap_token'>; +``` diff --git a/docs/js.channeltoken.is_online.md b/docs/js.channeltoken.is_online.md new file mode 100644 index 00000000..0a64c0ae --- /dev/null +++ b/docs/js.channeltoken.is_online.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [is\_online](./js.channeltoken.is_online.md) + +## ChannelToken.is\_online property + +If this token is currently online (e.g. active heartbeat and connected to leap) + +Signature: + +```typescript +is_online: boolean; +``` diff --git a/docs/js.channeltoken.md b/docs/js.channeltoken.md new file mode 100644 index 00000000..e22b6fc8 --- /dev/null +++ b/docs/js.channeltoken.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) + +## ChannelToken interface + +Signature: + +```typescript +interface ChannelToken +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [id](./js.channeltoken.id.md) | | [Id](./js.id.md)<'leap\_token'> | The ID for the token | +| [is\_online](./js.channeltoken.is_online.md) | | boolean | If this token is currently online (e.g. active heartbeat and connected to leap) | +| [project\_id](./js.channeltoken.project_id.md) | | [Id](./js.id.md)<'project'> | The project this channel token is associated with | +| [state](./js.channeltoken.state.md) | | [State](./js.state.md) | State for this token | + diff --git a/docs/js.channeltoken.project_id.md b/docs/js.channeltoken.project_id.md new file mode 100644 index 00000000..07a80b63 --- /dev/null +++ b/docs/js.channeltoken.project_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [project\_id](./js.channeltoken.project_id.md) + +## ChannelToken.project\_id property + +The project this channel token is associated with + +Signature: + +```typescript +project_id: Id<'project'>; +``` diff --git a/docs/js.channeltoken.state.md b/docs/js.channeltoken.state.md new file mode 100644 index 00000000..4dfab383 --- /dev/null +++ b/docs/js.channeltoken.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [state](./js.channeltoken.state.md) + +## ChannelToken.state property + +State for this token + +Signature: + +```typescript +state: State; +``` diff --git a/docs/js.channeltype.md b/docs/js.channeltype.md new file mode 100644 index 00000000..f1fa66df --- /dev/null +++ b/docs/js.channeltype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelType](./js.channeltype.md) + +## ChannelType enum + +Signature: + +```typescript +declare enum ChannelType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PRIVATE | "private" | | +| PUBLIC | "public" | | +| UNPROTECTED | "unprotected" | | + diff --git a/docs/js.container.created_at.md b/docs/js.container.created_at.md new file mode 100644 index 00000000..ea0fb999 --- /dev/null +++ b/docs/js.container.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [created\_at](./js.container.created_at.md) + +## Container.created\_at property + +The time this container was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.container.deployment_id.md b/docs/js.container.deployment_id.md new file mode 100644 index 00000000..b3484036 --- /dev/null +++ b/docs/js.container.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [deployment\_id](./js.container.deployment_id.md) + +## Container.deployment\_id property + +The ID of the deployment this container is associated with + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.container.id.md b/docs/js.container.id.md new file mode 100644 index 00000000..9bc7359f --- /dev/null +++ b/docs/js.container.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [id](./js.container.id.md) + +## Container.id property + +The ID of the container + +Signature: + +```typescript +id: Id<'container'>; +``` diff --git a/docs/js.container.internal_ip.md b/docs/js.container.internal_ip.md new file mode 100644 index 00000000..a41a7c6f --- /dev/null +++ b/docs/js.container.internal_ip.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [internal\_ip](./js.container.internal_ip.md) + +## Container.internal\_ip property + +The internal IP of the container + +Signature: + +```typescript +internal_ip: string; +``` diff --git a/docs/js.container.md b/docs/js.container.md new file mode 100644 index 00000000..a06f1f56 --- /dev/null +++ b/docs/js.container.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) + +## Container interface + +Signature: + +```typescript +interface Container +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.container.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this container was created | +| [deployment\_id](./js.container.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment this container is associated with | +| [id](./js.container.id.md) | | [Id](./js.id.md)<'container'> | The ID of the container | +| [internal\_ip](./js.container.internal_ip.md) | | string | The internal IP of the container | +| [metadata](./js.container.metadata.md) | | { last\_exit\_code?: number; } | Information about the container | +| [region](./js.container.region.md) | | [Regions](./js.regions.md) | The region this container runs in | +| [state](./js.container.state.md) | | [ContainerState](./js.containerstate.md) | The state this container is in | +| [type](./js.container.type.md) | | [RuntimeType](./js.runtimetype.md) | The type of this container | +| [uptime](./js.container.uptime.md) | | { last\_start: [Timestamp](./js.timestamp.md); } | Information about uptime/downtime for this container | +| [volume](./js.container.volume.md) | | [VolumeDefinition](./js.volumedefinition.md) \| null | The volume definition for this container | + diff --git a/docs/js.container.metadata.md b/docs/js.container.metadata.md new file mode 100644 index 00000000..b8ef4353 --- /dev/null +++ b/docs/js.container.metadata.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [metadata](./js.container.metadata.md) + +## Container.metadata property + +Information about the container + +Signature: + +```typescript +metadata: { + last_exit_code?: number; + }; +``` diff --git a/docs/js.container.region.md b/docs/js.container.region.md new file mode 100644 index 00000000..1e6dacc8 --- /dev/null +++ b/docs/js.container.region.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [region](./js.container.region.md) + +## Container.region property + +The region this container runs in + +Signature: + +```typescript +region: Regions; +``` diff --git a/docs/js.container.state.md b/docs/js.container.state.md new file mode 100644 index 00000000..be7ce2ec --- /dev/null +++ b/docs/js.container.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [state](./js.container.state.md) + +## Container.state property + +The state this container is in + +Signature: + +```typescript +state: ContainerState; +``` diff --git a/docs/js.container.type.md b/docs/js.container.type.md new file mode 100644 index 00000000..aa89d51b --- /dev/null +++ b/docs/js.container.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [type](./js.container.type.md) + +## Container.type property + +The type of this container + +Signature: + +```typescript +type: RuntimeType; +``` diff --git a/docs/js.container.uptime.md b/docs/js.container.uptime.md new file mode 100644 index 00000000..b801f1a4 --- /dev/null +++ b/docs/js.container.uptime.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [uptime](./js.container.uptime.md) + +## Container.uptime property + +Information about uptime/downtime for this container + +Signature: + +```typescript +uptime: { + last_start: Timestamp; + }; +``` diff --git a/docs/js.container.volume.md b/docs/js.container.volume.md new file mode 100644 index 00000000..e1aa34a5 --- /dev/null +++ b/docs/js.container.volume.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [volume](./js.container.volume.md) + +## Container.volume property + +The volume definition for this container + +Signature: + +```typescript +volume: VolumeDefinition | null; +``` diff --git a/docs/js.containerlog.level.md b/docs/js.containerlog.level.md new file mode 100644 index 00000000..10fdce77 --- /dev/null +++ b/docs/js.containerlog.level.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [level](./js.containerlog.level.md) + +## ContainerLog.level property + +The level of the log. stdout becomes `info` + +Signature: + +```typescript +level: 'info' | 'error'; +``` diff --git a/docs/js.containerlog.md b/docs/js.containerlog.md new file mode 100644 index 00000000..16e7237c --- /dev/null +++ b/docs/js.containerlog.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) + +## ContainerLog interface + +Logs from a container + +Signature: + +```typescript +interface ContainerLog +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [level](./js.containerlog.level.md) | | 'info' \| 'error' | The level of the log. stdout becomes info | +| [message](./js.containerlog.message.md) | | string | The log message | +| [nonce](./js.containerlog.nonce.md) | | string | The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. | +| [timestamp](./js.containerlog.timestamp.md) | | [Timestamp](./js.timestamp.md) | The timestamp of the log | + diff --git a/docs/js.containerlog.message.md b/docs/js.containerlog.message.md new file mode 100644 index 00000000..b3334c65 --- /dev/null +++ b/docs/js.containerlog.message.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [message](./js.containerlog.message.md) + +## ContainerLog.message property + +The log message + +Signature: + +```typescript +message: string; +``` diff --git a/docs/js.containerlog.nonce.md b/docs/js.containerlog.nonce.md new file mode 100644 index 00000000..ea3b06a4 --- /dev/null +++ b/docs/js.containerlog.nonce.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [nonce](./js.containerlog.nonce.md) + +## ContainerLog.nonce property + +The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. + +Signature: + +```typescript +nonce: string; +``` diff --git a/docs/js.containerlog.timestamp.md b/docs/js.containerlog.timestamp.md new file mode 100644 index 00000000..d415f14e --- /dev/null +++ b/docs/js.containerlog.timestamp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [timestamp](./js.containerlog.timestamp.md) + +## ContainerLog.timestamp property + +The timestamp of the log + +Signature: + +```typescript +timestamp: Timestamp; +``` diff --git a/docs/js.containerstate.md b/docs/js.containerstate.md new file mode 100644 index 00000000..b916dd94 --- /dev/null +++ b/docs/js.containerstate.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerState](./js.containerstate.md) + +## ContainerState enum + +Container state is relatively self-explanatory. It describes what the container is currently doing. + +Signature: + +```typescript +declare enum ContainerState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXITED | "exited" | The container exited (e.g. with a zero exit code) | +| FAILED | "failed" | The container's entrypoint failed (e.g. exited with a non-zero exit code) | +| PENDING | "pending" | The container is pending creation | +| RUNNING | "running" | The container is running | +| STOPPED | "stopped" | The container is stopped | +| TERMINATING | "terminating" | The container is being deleted | + diff --git a/docs/js.default_base_url.md b/docs/js.default_base_url.md new file mode 100644 index 00000000..d364d83a --- /dev/null +++ b/docs/js.default_base_url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DEFAULT\_BASE\_URL](./js.default_base_url.md) + +## DEFAULT\_BASE\_URL variable + +The default base URL for Hop's API. + +Signature: + +```typescript +DEFAULT_BASE_URL = "https://api.hop.io" +``` diff --git a/docs/js.defaultquotas.md b/docs/js.defaultquotas.md new file mode 100644 index 00000000..7c88bdd0 --- /dev/null +++ b/docs/js.defaultquotas.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) + +## DefaultQuotas interface + +Signature: + +```typescript +interface DefaultQuotas +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.defaultquotas.ram.md) | | number | | +| [vcpu](./js.defaultquotas.vcpu.md) | | number | | + diff --git a/docs/js.defaultquotas.ram.md b/docs/js.defaultquotas.ram.md new file mode 100644 index 00000000..0b1bc129 --- /dev/null +++ b/docs/js.defaultquotas.ram.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [ram](./js.defaultquotas.ram.md) + +## DefaultQuotas.ram property + +Signature: + +```typescript +ram: number; +``` diff --git a/docs/js.defaultquotas.vcpu.md b/docs/js.defaultquotas.vcpu.md new file mode 100644 index 00000000..7386459d --- /dev/null +++ b/docs/js.defaultquotas.vcpu.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [vcpu](./js.defaultquotas.vcpu.md) + +## DefaultQuotas.vcpu property + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.deliveryprotocol.md b/docs/js.deliveryprotocol.md new file mode 100644 index 00000000..d96e760d --- /dev/null +++ b/docs/js.deliveryprotocol.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeliveryProtocol](./js.deliveryprotocol.md) + +## DeliveryProtocol type + +Signature: + +```typescript +declare type DeliveryProtocol = 'webrtc' | 'hls'; +``` diff --git a/docs/js.deployment.active_build.md b/docs/js.deployment.active_build.md new file mode 100644 index 00000000..13170351 --- /dev/null +++ b/docs/js.deployment.active_build.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_build](./js.deployment.active_build.md) + +## Deployment.active\_build property + +Current active build for deployment + +Signature: + +```typescript +active_build: Build | null; +``` diff --git a/docs/js.deployment.active_rollout.md b/docs/js.deployment.active_rollout.md new file mode 100644 index 00000000..8cb6418b --- /dev/null +++ b/docs/js.deployment.active_rollout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_rollout](./js.deployment.active_rollout.md) + +## Deployment.active\_rollout property + +Current active rollout for deployment + +Signature: + +```typescript +active_rollout: DeploymentRollout | null; +``` diff --git a/docs/js.deployment.config.md b/docs/js.deployment.config.md new file mode 100644 index 00000000..7526bfe8 --- /dev/null +++ b/docs/js.deployment.config.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [config](./js.deployment.config.md) + +## Deployment.config property + +The config for this deployment + +Signature: + +```typescript +config: Omit; +``` diff --git a/docs/js.deployment.container_count.md b/docs/js.deployment.container_count.md new file mode 100644 index 00000000..b626b1a7 --- /dev/null +++ b/docs/js.deployment.container_count.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [container\_count](./js.deployment.container_count.md) + +## Deployment.container\_count property + +The amount of containers this deployment is currently running + +Signature: + +```typescript +container_count: number; +``` diff --git a/docs/js.deployment.created_at.md b/docs/js.deployment.created_at.md new file mode 100644 index 00000000..fdd0df48 --- /dev/null +++ b/docs/js.deployment.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [created\_at](./js.deployment.created_at.md) + +## Deployment.created\_at property + +The time this deployment was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.deployment.id.md b/docs/js.deployment.id.md new file mode 100644 index 00000000..5ff910b0 --- /dev/null +++ b/docs/js.deployment.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [id](./js.deployment.id.md) + +## Deployment.id property + +The ID of the deployment + +Signature: + +```typescript +id: Id<'deployment'>; +``` diff --git a/docs/js.deployment.md b/docs/js.deployment.md new file mode 100644 index 00000000..ac2ded0e --- /dev/null +++ b/docs/js.deployment.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) + +## Deployment interface + +Signature: + +```typescript +interface Deployment +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [active\_build](./js.deployment.active_build.md) | | [Build](./js.build.md) \| null | Current active build for deployment | +| [active\_rollout](./js.deployment.active_rollout.md) | | [DeploymentRollout](./js.deploymentrollout.md) \| null | Current active rollout for deployment | +| [config](./js.deployment.config.md) | | Omit<[DeploymentConfig](./js.deploymentconfig.md), 'volume' \| 'name'> | The config for this deployment | +| [container\_count](./js.deployment.container_count.md) | | number | The amount of containers this deployment is currently running | +| [created\_at](./js.deployment.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this deployment was created at | +| [id](./js.deployment.id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment | +| [name](./js.deployment.name.md) | | string | The name of the deployment | + diff --git a/docs/js.deployment.name.md b/docs/js.deployment.name.md new file mode 100644 index 00000000..f13f40ae --- /dev/null +++ b/docs/js.deployment.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [name](./js.deployment.name.md) + +## Deployment.name property + +The name of the deployment + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.deploymentconfig.md b/docs/js.deploymentconfig.md new file mode 100644 index 00000000..6e173bbf --- /dev/null +++ b/docs/js.deploymentconfig.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentConfig](./js.deploymentconfig.md) + +## DeploymentConfig type + +Signature: + +```typescript +declare type DeploymentConfig = { + name: string; + container_strategy: 'manual'; + type: RuntimeType; + version: '2022-05-17'; + image: Image; + env: Record; + resources: Resources; + restart_policy: RestartPolicy; + volume?: VolumeDefinition; +}; +``` +References: [RuntimeType](./js.runtimetype.md), [Image](./js.image_2.md), [Resources](./js.resources.md), [RestartPolicy](./js.restartpolicy.md), [VolumeDefinition](./js.volumedefinition.md) + diff --git a/docs/js.deploymentrollout.md b/docs/js.deploymentrollout.md new file mode 100644 index 00000000..3bfdcc40 --- /dev/null +++ b/docs/js.deploymentrollout.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentRollout](./js.deploymentrollout.md) + +## DeploymentRollout type + +Signature: + +```typescript +declare type DeploymentRollout = { + count: number; + created_at: Timestamp; + deployment_id: Id<'deployment'>; + id: Id<'rollout'>; + state: RolloutState; + build: Build | null; +}; +``` +References: [Timestamp](./js.timestamp.md), [Id](./js.id.md), [RolloutState](./js.rolloutstate.md), [Build](./js.build.md) + diff --git a/docs/js.domain.created_at.md b/docs/js.domain.created_at.md new file mode 100644 index 00000000..c16c478c --- /dev/null +++ b/docs/js.domain.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [created\_at](./js.domain.created_at.md) + +## Domain.created\_at property + +The date this domain was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.domain.domain.md b/docs/js.domain.domain.md new file mode 100644 index 00000000..429325c1 --- /dev/null +++ b/docs/js.domain.domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [domain](./js.domain.domain.md) + +## Domain.domain property + +The domain name + +Signature: + +```typescript +domain: string; +``` diff --git a/docs/js.domain.id.md b/docs/js.domain.id.md new file mode 100644 index 00000000..659db5cc --- /dev/null +++ b/docs/js.domain.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [id](./js.domain.id.md) + +## Domain.id property + +The ID of the domain + +Signature: + +```typescript +id: Id<'domain'>; +``` diff --git a/docs/js.domain.md b/docs/js.domain.md new file mode 100644 index 00000000..9668e178 --- /dev/null +++ b/docs/js.domain.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) + +## Domain interface + +Signature: + +```typescript +interface Domain +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.domain.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this domain was created | +| [domain](./js.domain.domain.md) | | string | The domain name | +| [id](./js.domain.id.md) | | [Id](./js.id.md)<'domain'> | The ID of the domain | +| [state](./js.domain.state.md) | | [DomainState](./js.domainstate.md) | The domain state | + diff --git a/docs/js.domain.state.md b/docs/js.domain.state.md new file mode 100644 index 00000000..9f613f54 --- /dev/null +++ b/docs/js.domain.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [state](./js.domain.state.md) + +## Domain.state property + +The domain state + +Signature: + +```typescript +state: DomainState; +``` diff --git a/docs/js.domainstate.md b/docs/js.domainstate.md new file mode 100644 index 00000000..df9bf6f1 --- /dev/null +++ b/docs/js.domainstate.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DomainState](./js.domainstate.md) + +## DomainState enum + +Signature: + +```typescript +declare enum DomainState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PENDING | "pending" | | +| SSL\_ACTIVE | "ssl_active" | | +| VALID\_CNAME | "valid_cname" | | + diff --git a/docs/js.empty.md b/docs/js.empty.md new file mode 100644 index 00000000..534185e2 --- /dev/null +++ b/docs/js.empty.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) + +## Empty type + +Signature: + +```typescript +declare type Empty = void; +``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md new file mode 100644 index 00000000..1e66a431 --- /dev/null +++ b/docs/js.endpoint.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Endpoint](./js.endpoint.md) + +## Endpoint type + +Signature: + +```typescript +declare type Endpoint = { + method: M; + path: Path; + res: Res; + body: Body; +}; +``` +References: [Method](./js.method.md) + diff --git a/docs/js.endpoints.md b/docs/js.endpoints.md new file mode 100644 index 00000000..278f448b --- /dev/null +++ b/docs/js.endpoints.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Endpoints](./js.endpoints.md) + +## Endpoints type + +Signature: + +```typescript +declare type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; +``` +References: [IgniteEndpoints](./js.igniteendpoints.md), [RegistryEndpoints](./js.registryendpoints.md), [UserEndpoints](./js.userendpoints.md), [ProjectsEndpoints](./js.projectsendpoints.md), [PipeEndpoints](./js.pipeendpoints.md), [ChannelEndpoints](./js.channelendpoints.md) + diff --git a/docs/js.erroredapiresponse.md b/docs/js.erroredapiresponse.md new file mode 100644 index 00000000..35a4aadc --- /dev/null +++ b/docs/js.erroredapiresponse.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ErroredAPIResponse](./js.erroredapiresponse.md) + +## ErroredAPIResponse type + +Signature: + +```typescript +declare type ErroredAPIResponse = { + success: false; + error: { + code: string; + message: string; + }; +}; +``` diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md new file mode 100644 index 00000000..eb6d9b5a --- /dev/null +++ b/docs/js.extractrouteparams.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) + +## ExtractRouteParams type + +Signature: + +```typescript +declare type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { + [k in Param | keyof ExtractRouteParams]: string | number; +} : T extends `${string}:${infer Param}` ? { + [k in Param]: string | number; +} : {}; +``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.gateway.created_at.md b/docs/js.gateway.created_at.md new file mode 100644 index 00000000..c6c94097 --- /dev/null +++ b/docs/js.gateway.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [created\_at](./js.gateway.created_at.md) + +## Gateway.created\_at property + +The date this gateway was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.gateway.deployment_id.md b/docs/js.gateway.deployment_id.md new file mode 100644 index 00000000..6300a5b1 --- /dev/null +++ b/docs/js.gateway.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [deployment\_id](./js.gateway.deployment_id.md) + +## Gateway.deployment\_id property + +The deployment this gateway is associated with + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.gateway.domains.md b/docs/js.gateway.domains.md new file mode 100644 index 00000000..fffb4603 --- /dev/null +++ b/docs/js.gateway.domains.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [domains](./js.gateway.domains.md) + +## Gateway.domains property + +Domains associated with this gateway + +Signature: + +```typescript +domains: Domain[]; +``` diff --git a/docs/js.gateway.hopsh_domain.md b/docs/js.gateway.hopsh_domain.md new file mode 100644 index 00000000..d7b3c930 --- /dev/null +++ b/docs/js.gateway.hopsh_domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [hopsh\_domain](./js.gateway.hopsh_domain.md) + +## Gateway.hopsh\_domain property + +Domain automatically assigned by Hop + +Signature: + +```typescript +hopsh_domain: HopShDomain | null; +``` diff --git a/docs/js.gateway.id.md b/docs/js.gateway.id.md new file mode 100644 index 00000000..68dc79d4 --- /dev/null +++ b/docs/js.gateway.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [id](./js.gateway.id.md) + +## Gateway.id property + +The ID of the gateway + +Signature: + +```typescript +id: Id<'gateway'>; +``` diff --git a/docs/js.gateway.internal_domain.md b/docs/js.gateway.internal_domain.md new file mode 100644 index 00000000..58b36080 --- /dev/null +++ b/docs/js.gateway.internal_domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [internal\_domain](./js.gateway.internal_domain.md) + +## Gateway.internal\_domain property + +Internal domain assigned by user upon gateway creation + +Signature: + +```typescript +internal_domain: InternalHopDomain | null; +``` diff --git a/docs/js.gateway.md b/docs/js.gateway.md new file mode 100644 index 00000000..685ce83f --- /dev/null +++ b/docs/js.gateway.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) + +## Gateway interface + +Gateways are used to connect services to the internet or a private network + +Signature: + +```typescript +interface Gateway +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.gateway.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this gateway was created | +| [deployment\_id](./js.gateway.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The deployment this gateway is associated with | +| [domains](./js.gateway.domains.md) | | [Domain](./js.domain.md)\[\] | Domains associated with this gateway | +| [hopsh\_domain](./js.gateway.hopsh_domain.md) | | [HopShDomain](./js.hopshdomain.md) \| null | Domain automatically assigned by Hop | +| [id](./js.gateway.id.md) | | [Id](./js.id.md)<'gateway'> | The ID of the gateway | +| [internal\_domain](./js.gateway.internal_domain.md) | | [InternalHopDomain](./js.internalhopdomain.md) \| null | Internal domain assigned by user upon gateway creation | +| [name](./js.gateway.name.md) | | string | The name of the gateway | +| [target\_port](./js.gateway.target_port.md) | | number \| null | Port the Gateway targets (Only for external gateways) | +| [type](./js.gateway.type.md) | | [GatewayType](./js.gatewaytype.md) | The type of the gateway | + diff --git a/docs/js.gateway.name.md b/docs/js.gateway.name.md new file mode 100644 index 00000000..8386952e --- /dev/null +++ b/docs/js.gateway.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [name](./js.gateway.name.md) + +## Gateway.name property + +The name of the gateway + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.gateway.target_port.md b/docs/js.gateway.target_port.md new file mode 100644 index 00000000..6f14c324 --- /dev/null +++ b/docs/js.gateway.target_port.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [target\_port](./js.gateway.target_port.md) + +## Gateway.target\_port property + +Port the Gateway targets (Only for external gateways) + +Signature: + +```typescript +target_port: number | null; +``` diff --git a/docs/js.gateway.type.md b/docs/js.gateway.type.md new file mode 100644 index 00000000..91a41587 --- /dev/null +++ b/docs/js.gateway.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [type](./js.gateway.type.md) + +## Gateway.type property + +The type of the gateway + +Signature: + +```typescript +type: GatewayType; +``` diff --git a/docs/js.gatewaytype.md b/docs/js.gatewaytype.md new file mode 100644 index 00000000..3df5ce11 --- /dev/null +++ b/docs/js.gatewaytype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GatewayType](./js.gatewaytype.md) + +## GatewayType enum + +Types of gateways supported by Hop + +Signature: + +```typescript +declare enum GatewayType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXTERNAL | "external" | The gateway can be accessed from the internet | +| INTERNAL | "internal" | The gateway can only be accessed inside of a project's network | + diff --git a/docs/js.getidprefix.md b/docs/js.getidprefix.md new file mode 100644 index 00000000..6292890d --- /dev/null +++ b/docs/js.getidprefix.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [getIdPrefix](./js.getidprefix.md) + +## getIdPrefix() function + +Signature: + +```typescript +declare function getIdPrefix(id: string, expect?: T): T; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| id | string | | +| expect | T | (Optional) | + +Returns: + +T + diff --git a/docs/js.ghrepo.account_name.md b/docs/js.ghrepo.account_name.md new file mode 100644 index 00000000..17dad093 --- /dev/null +++ b/docs/js.ghrepo.account_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [account\_name](./js.ghrepo.account_name.md) + +## GHRepo.account\_name property + +Signature: + +```typescript +account_name: string; +``` diff --git a/docs/js.ghrepo.default_branch.md b/docs/js.ghrepo.default_branch.md new file mode 100644 index 00000000..bae06423 --- /dev/null +++ b/docs/js.ghrepo.default_branch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [default\_branch](./js.ghrepo.default_branch.md) + +## GHRepo.default\_branch property + +Signature: + +```typescript +default_branch: string; +``` diff --git a/docs/js.ghrepo.full_name.md b/docs/js.ghrepo.full_name.md new file mode 100644 index 00000000..8a2776bb --- /dev/null +++ b/docs/js.ghrepo.full_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [full\_name](./js.ghrepo.full_name.md) + +## GHRepo.full\_name property + +Signature: + +```typescript +full_name: string; +``` diff --git a/docs/js.ghrepo.id.md b/docs/js.ghrepo.id.md new file mode 100644 index 00000000..f9607b9b --- /dev/null +++ b/docs/js.ghrepo.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [id](./js.ghrepo.id.md) + +## GHRepo.id property + +Signature: + +```typescript +id: number; +``` diff --git a/docs/js.ghrepo.md b/docs/js.ghrepo.md new file mode 100644 index 00000000..84df8456 --- /dev/null +++ b/docs/js.ghrepo.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) + +## GHRepo interface + +GitHub repo type sent from API (NOT USED IN IMAGES) + +Signature: + +```typescript +interface GHRepo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [account\_name](./js.ghrepo.account_name.md) | | string | | +| [default\_branch](./js.ghrepo.default_branch.md) | | string | | +| [full\_name](./js.ghrepo.full_name.md) | | string | | +| [id](./js.ghrepo.id.md) | | number | | +| [private](./js.ghrepo.private.md) | | boolean | | + diff --git a/docs/js.ghrepo.private.md b/docs/js.ghrepo.private.md new file mode 100644 index 00000000..3a4e994b --- /dev/null +++ b/docs/js.ghrepo.private.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [private](./js.ghrepo.private.md) + +## GHRepo.private property + +Signature: + +```typescript +private: boolean; +``` diff --git a/docs/js.hop._constructor_.md b/docs/js.hop._constructor_.md new file mode 100644 index 00000000..cd3f058d --- /dev/null +++ b/docs/js.hop._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor_.md) + +## Hop.(constructor) + +Constructs a new instance of the `Hop` class + +Signature: + +```typescript +constructor(options: PartialAPIOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [PartialAPIOptions](./js.partialapioptions.md) | | + diff --git a/docs/js.hop._constructor__1.md b/docs/js.hop._constructor__1.md new file mode 100644 index 00000000..b426e3df --- /dev/null +++ b/docs/js.hop._constructor__1.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor__1.md) + +## Hop.(constructor) + +Constructs a new instance of the `Hop` class + +Signature: + +```typescript +constructor(authentication: APIAuthentication, baseurl?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| authentication | [APIAuthentication](./js.apiauthentication.md) | | +| baseurl | string | (Optional) | + diff --git a/docs/js.hop.channels.md b/docs/js.hop.channels.md new file mode 100644 index 00000000..59b9dbc0 --- /dev/null +++ b/docs/js.hop.channels.md @@ -0,0 +1,53 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [channels](./js.hop.channels.md) + +## Hop.channels property + +Signature: + +```typescript +readonly channels: { + create(type: ChannelType, id?: string | null | undefined, options?: { + state?: T | undefined; + } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + get(id: string): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + getAll(project?: `project_${string}` | undefined): Promise<(Channel & { + setState(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + })[]>; + subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; + subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + getAllTokens(channel: string | Channel): Promise; + setState(channel: string | Channel, state: SetStateAction): Promise; + patchState(channel: string | Channel, state: SetStateAction): Promise; + publishMessage(channel: string | Channel, event: string, data: T_5): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: `leap_token_${string}`): Promise; + create(state?: State, project?: `project_${string}` | undefined): Promise; + setState(id: `leap_token_${string}`, state: State): Promise; + get(id: `leap_token_${string}`): Promise; + isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; + publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; + }; + }; +``` diff --git a/docs/js.hop.client.md b/docs/js.hop.client.md new file mode 100644 index 00000000..c23e7fa5 --- /dev/null +++ b/docs/js.hop.client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [client](./js.hop.client.md) + +## Hop.client property + +Signature: + +```typescript +readonly client: APIClient; +``` diff --git a/docs/js.hop.ignite.md b/docs/js.hop.ignite.md new file mode 100644 index 00000000..1afad47b --- /dev/null +++ b/docs/js.hop.ignite.md @@ -0,0 +1,85 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [ignite](./js.hop.ignite.md) + +## Hop.ignite property + +Signature: + +```typescript +readonly ignite: { + gateways: { + addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; + get(gatewayId: `gateway_${string}`): Promise; + }; + deployments: { + create: { + (configOrProject: `project_${string}`, bearerOrPatConfig: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + (configOrProject: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + }; + get: { + (name: string, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + }; + update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; + getContainers(deployment: `deployment_${string}`): Promise; + getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + })[]>; + delete(deployment: `deployment_${string}`): Promise; + gateways: { + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, type: GatewayType, protocol: "http" | null, targetPort: number): Promise; + }>; + }; + }; + containers: { + delete(container: `container_${string}`): Promise; + getLogs(container: `container_${string}`, options?: Partial<{ + sortBy: "timestamp"; + orderBy: "desc" | "asc"; + limit: number; + offset: number; + }>): Promise; + stop(container: `container_${string}`): Promise; + start(container: `container_${string}`): Promise; + create(deployment: `deployment_${string}`): Promise; + }; + }; +``` diff --git a/docs/js.hop.md b/docs/js.hop.md new file mode 100644 index 00000000..ecdd264f --- /dev/null +++ b/docs/js.hop.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) + +## Hop class + +Constructs a new instance of Hop and all of its SDKs. + +Signature: + +```typescript +declare class Hop +``` + +## Example + + +```ts +const hop = new Hop(bearerTokenOrPATOrProjectToken); +await hop.ignite.containers.create(deploymentId); +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./js.hop._constructor_.md) | | Constructs a new instance of the Hop class | +| [(constructor)(authentication, baseurl)](./js.hop._constructor__1.md) | | Constructs a new instance of the Hop class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>(type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; get(id: string): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; getAll(project?: \`project\_${string}\` \| undefined): Promise<([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\]>; subscribeToken(channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_3>): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_4>): Promise<void>; publishMessage<T\_5>(channel: string \| [Channel](./js.channel.md), event: string, data: T\_5): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create(state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline(idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md)): Promise<boolean>; publishDirectMessage<T\_6>(token: \`leap\_token\_${string}\`, event: string, data: T\_6): Promise<void>; }; } | | +| [client](./js.hop.client.md) | readonly | [APIClient](./js.apiclient.md) | | +| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { (configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; update(deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise<([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; })\[\]>; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise<([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\]>; create(deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, targetPort: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs(container: \`container\_${string}\`, options?: Partial<{ sortBy: "timestamp"; orderBy: "desc" \| "asc"; limit: number; offset: number; }>): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | +| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise<([Room](./js.room.md) & { delete(): Promise<void>; })\[\]>; create(name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: "rtmp" \| "rtp"; hlsConfig?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }): Promise<[Room](./js.room.md) & { delete(): Promise<void>; }>; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | +| [projects](./js.hop.projects.md) | readonly | { getAllMembers(projectId?: \`project\_${string}\` \| undefined): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; tokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create(name: string, value: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)>; delete(id: string, projectId?: \`project\_${string}\` \| undefined): Promise<void>; }; } | | +| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise<{ digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]>; delete(image: string): Promise<void>; }; } | | +| [users](./js.hop.users.md) | readonly | { me: { get(): Promise<{ projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }>; pats: { create(name: string): Promise<[PAT](./js.pat.md)>; getAll(): Promise<[PAT](./js.pat.md)\[\]>; delete(id: \`pat\_${string}\`): Promise<void>; }; }; } | | + diff --git a/docs/js.hop.pipe.md b/docs/js.hop.pipe.md new file mode 100644 index 00000000..8aeff3ff --- /dev/null +++ b/docs/js.hop.pipe.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [pipe](./js.hop.pipe.md) + +## Hop.pipe property + +Signature: + +```typescript +readonly pipe: { + rooms: { + getAll(project?: `project_${string}` | undefined): Promise<(Room & { + delete(): Promise; + })[]>; + create(name: string, options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean | undefined; + ingestProtocol: "rtmp" | "rtp"; + hlsConfig?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } | undefined; + }): Promise; + }>; + delete(room: `pipe_room_${string}`): Promise; + }; + }; +``` diff --git a/docs/js.hop.projects.md b/docs/js.hop.projects.md new file mode 100644 index 00000000..3d6a89ee --- /dev/null +++ b/docs/js.hop.projects.md @@ -0,0 +1,33 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [projects](./js.hop.projects.md) + +## Hop.projects property + +Signature: + +```typescript +readonly projects: { + getAllMembers(projectId?: `project_${string}` | undefined): Promise; + getCurrentMember(projectId: `project_${string}`): Promise; + projectTokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + tokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + secrets: { + getAll(projectId?: `project_${string}` | undefined): Promise; + create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; + delete(id: string, projectId?: `project_${string}` | undefined): Promise; + }; + }; +``` diff --git a/docs/js.hop.registry.md b/docs/js.hop.registry.md new file mode 100644 index 00000000..66413e43 --- /dev/null +++ b/docs/js.hop.registry.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [registry](./js.hop.registry.md) + +## Hop.registry property + +Signature: + +```typescript +readonly registry: { + images: { + getAll(project?: `project_${string}` | undefined): Promise; + getManifest(image: string): Promise<{ + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]>; + delete(image: string): Promise; + }; + }; +``` diff --git a/docs/js.hop.users.md b/docs/js.hop.users.md new file mode 100644 index 00000000..751a0e80 --- /dev/null +++ b/docs/js.hop.users.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [users](./js.hop.users.md) + +## Hop.users property + +Signature: + +```typescript +readonly users: { + me: { + get(): Promise<{ + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: `pat_${string}`): Promise; + }; + }; + }; +``` diff --git a/docs/js.hopapierror._constructor_.md b/docs/js.hopapierror._constructor_.md new file mode 100644 index 00000000..3f22086e --- /dev/null +++ b/docs/js.hopapierror._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [(constructor)](./js.hopapierror._constructor_.md) + +## HopAPIError.(constructor) + +Constructs a new instance of the `HopAPIError` class + +Signature: + +```typescript +constructor(request: Request, response: Response, data: ErroredAPIResponse); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | Request | | +| response | Response | | +| data | [ErroredAPIResponse](./js.erroredapiresponse.md) | | + diff --git a/docs/js.hopapierror.data.md b/docs/js.hopapierror.data.md new file mode 100644 index 00000000..a73cfc20 --- /dev/null +++ b/docs/js.hopapierror.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [data](./js.hopapierror.data.md) + +## HopAPIError.data property + +Signature: + +```typescript +readonly data: ErroredAPIResponse; +``` diff --git a/docs/js.hopapierror.md b/docs/js.hopapierror.md new file mode 100644 index 00000000..fe8da293 --- /dev/null +++ b/docs/js.hopapierror.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) + +## HopAPIError class + +Signature: + +```typescript +declare class HopAPIError extends Error +``` +Extends: Error + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(request, response, data)](./js.hopapierror._constructor_.md) | | Constructs a new instance of the HopAPIError class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./js.hopapierror.data.md) | readonly | [ErroredAPIResponse](./js.erroredapiresponse.md) | | +| [request](./js.hopapierror.request.md) | readonly | Request | | +| [response](./js.hopapierror.response.md) | readonly | Response | | +| [status](./js.hopapierror.status.md) | readonly | number | | + diff --git a/docs/js.hopapierror.request.md b/docs/js.hopapierror.request.md new file mode 100644 index 00000000..8d307953 --- /dev/null +++ b/docs/js.hopapierror.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [request](./js.hopapierror.request.md) + +## HopAPIError.request property + +Signature: + +```typescript +readonly request: Request; +``` diff --git a/docs/js.hopapierror.response.md b/docs/js.hopapierror.response.md new file mode 100644 index 00000000..50d62913 --- /dev/null +++ b/docs/js.hopapierror.response.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [response](./js.hopapierror.response.md) + +## HopAPIError.response property + +Signature: + +```typescript +readonly response: Response; +``` diff --git a/docs/js.hopapierror.status.md b/docs/js.hopapierror.status.md new file mode 100644 index 00000000..3fd9681c --- /dev/null +++ b/docs/js.hopapierror.status.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [status](./js.hopapierror.status.md) + +## HopAPIError.status property + +Signature: + +```typescript +readonly status: number; +``` diff --git a/docs/js.hopshdomain.md b/docs/js.hopshdomain.md new file mode 100644 index 00000000..9e1292f6 --- /dev/null +++ b/docs/js.hopshdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopShDomain](./js.hopshdomain.md) + +## HopShDomain type + +Signature: + +```typescript +declare type HopShDomain = `${string}.hop.sh`; +``` diff --git a/docs/js.id.md b/docs/js.id.md new file mode 100644 index 00000000..cfb88226 --- /dev/null +++ b/docs/js.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Id](./js.id.md) + +## Id type + +Signature: + +```typescript +declare type Id = `${T}_${string}`; +``` +References: [IdPrefixes](./js.idprefixes.md) + diff --git a/docs/js.id_prefixes.md b/docs/js.id_prefixes.md new file mode 100644 index 00000000..3fe89473 --- /dev/null +++ b/docs/js.id_prefixes.md @@ -0,0 +1,65 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ID\_PREFIXES](./js.id_prefixes.md) + +## ID\_PREFIXES variable + +Signature: + +```typescript +ID_PREFIXES: readonly [{ + readonly prefix: "user"; + readonly description: "Users"; +}, { + readonly prefix: "project"; + readonly description: "Project"; +}, { + readonly prefix: "pm"; + readonly description: "Project Members"; +}, { + readonly prefix: "role"; + readonly description: "Roles"; +}, { + readonly prefix: "pi"; + readonly description: "Project Invite"; +}, { + readonly prefix: "ptk"; + readonly description: "Project token"; +}, { + readonly prefix: "pat"; + readonly description: "User personal access token"; +}, { + readonly prefix: "container"; + readonly description: "Ignite container"; +}, { + readonly prefix: "pipe_room"; + readonly description: "Pipe room"; +}, { + readonly prefix: "deployment"; + readonly description: "Ignite deployment"; +}, { + readonly prefix: "bearer"; + readonly description: "Users bearer token"; +}, { + readonly prefix: "ptkid"; + readonly description: "Project token ID"; +}, { + readonly prefix: "secret"; + readonly description: "Project secret ID"; +}, { + readonly prefix: "gateway"; + readonly description: "Gateway"; +}, { + readonly prefix: "domain"; + readonly description: "Domain for a gateway"; +}, { + readonly prefix: "leap_token"; + readonly description: "Token for connecting to leap as a client"; +}, { + readonly prefix: "build"; + readonly description: "Build ID for build logs"; +}, { + readonly prefix: "rollout"; + readonly description: "Rollout ID for rollouts."; +}] +``` diff --git a/docs/js.idprefixes.md b/docs/js.idprefixes.md new file mode 100644 index 00000000..565ed27c --- /dev/null +++ b/docs/js.idprefixes.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IdPrefixes](./js.idprefixes.md) + +## IdPrefixes type + +Signature: + +```typescript +declare type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; +``` +References: [ID\_PREFIXES](./js.id_prefixes.md) + diff --git a/docs/js.ignite.md b/docs/js.ignite.md new file mode 100644 index 00000000..02f64de6 --- /dev/null +++ b/docs/js.ignite.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Ignite](./js.ignite.md) + +## Ignite namespace + +Signature: + +```typescript +declare namespace ignite +``` diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md new file mode 100644 index 00000000..bc5d4138 --- /dev/null +++ b/docs/js.igniteendpoints.md @@ -0,0 +1,46 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IgniteEndpoints](./js.igniteendpoints.md) + +## IgniteEndpoints type + +Signature: + +```typescript +declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { + deployments: Deployment[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { + containers: Container[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { + container: Container; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { + deployment_id: Id<'deployment'>; + container_id: Id<'container'>; +}> | Endpoint<'POST', '/v1/ignite/deployments', { + deployment: Deployment; +}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { + logs: ContainerLog[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/search', { + deployment: Deployment; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { + preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; +}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { + domain: string; +}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { + gateway: Gateway; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { + gateways: Gateway[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { + gateway: Gateway; +}, { + type: GatewayType; + target_port: number; + protocol: Gateway['protocol']; +}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}, DeploymentConfig>; +``` +References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) + diff --git a/docs/js.image_2.auth.md b/docs/js.image_2.auth.md new file mode 100644 index 00000000..95a908e5 --- /dev/null +++ b/docs/js.image_2.auth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [auth](./js.image_2.auth.md) + +## Image\_2.auth property + +Authorization required for the registry to access this image This is not required if you use Hop's own registry. + +Signature: + +```typescript +auth: Auth | null; +``` diff --git a/docs/js.image_2.gh_repo.md b/docs/js.image_2.gh_repo.md new file mode 100644 index 00000000..a9bb16be --- /dev/null +++ b/docs/js.image_2.gh_repo.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [gh\_repo](./js.image_2.gh_repo.md) + +## Image\_2.gh\_repo property + +GitHub repo information (if applicable) + +Signature: + +```typescript +gh_repo: ImageGHRepo | null; +``` diff --git a/docs/js.image_2.md b/docs/js.image_2.md new file mode 100644 index 00000000..0a81cf6f --- /dev/null +++ b/docs/js.image_2.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) + +## Image\_2 interface + +Docker image config + +Signature: + +```typescript +interface Image +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [auth](./js.image_2.auth.md) | | [Auth](./js.auth.md) \| null | Authorization required for the registry to access this image This is not required if you use Hop's own registry. | +| [gh\_repo](./js.image_2.gh_repo.md) | | [ImageGHRepo](./js.imageghrepo.md) \| null | GitHub repo information (if applicable) | +| [name](./js.image_2.name.md) | | string \| null | The name of the docker image | + diff --git a/docs/js.image_2.name.md b/docs/js.image_2.name.md new file mode 100644 index 00000000..8ab4559d --- /dev/null +++ b/docs/js.image_2.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [name](./js.image_2.name.md) + +## Image\_2.name property + +The name of the docker image + +Signature: + +```typescript +name: string | null; +``` diff --git a/docs/js.imageghrepo.branch.md b/docs/js.imageghrepo.branch.md new file mode 100644 index 00000000..479d9e9a --- /dev/null +++ b/docs/js.imageghrepo.branch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [branch](./js.imageghrepo.branch.md) + +## ImageGHRepo.branch property + +Signature: + +```typescript +branch: string; +``` diff --git a/docs/js.imageghrepo.full_name.md b/docs/js.imageghrepo.full_name.md new file mode 100644 index 00000000..40c3657a --- /dev/null +++ b/docs/js.imageghrepo.full_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [full\_name](./js.imageghrepo.full_name.md) + +## ImageGHRepo.full\_name property + +Signature: + +```typescript +full_name: string; +``` diff --git a/docs/js.imageghrepo.md b/docs/js.imageghrepo.md new file mode 100644 index 00000000..8503ddd1 --- /dev/null +++ b/docs/js.imageghrepo.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) + +## ImageGHRepo interface + +GitHub repo partial used for images + +Signature: + +```typescript +interface ImageGHRepo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [branch](./js.imageghrepo.branch.md) | | string | | +| [full\_name](./js.imageghrepo.full_name.md) | | string | | +| [repo\_id](./js.imageghrepo.repo_id.md) | | number | | + diff --git a/docs/js.imageghrepo.repo_id.md b/docs/js.imageghrepo.repo_id.md new file mode 100644 index 00000000..4e2439d4 --- /dev/null +++ b/docs/js.imageghrepo.repo_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [repo\_id](./js.imageghrepo.repo_id.md) + +## ImageGHRepo.repo\_id property + +Signature: + +```typescript +repo_id: number; +``` diff --git a/docs/js.internalhopdomain.md b/docs/js.internalhopdomain.md new file mode 100644 index 00000000..8ee254c8 --- /dev/null +++ b/docs/js.internalhopdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [InternalHopDomain](./js.internalhopdomain.md) + +## InternalHopDomain type + +Signature: + +```typescript +declare type InternalHopDomain = `${string}.hop`; +``` diff --git a/docs/js.is_browser.md b/docs/js.is_browser.md new file mode 100644 index 00000000..a071fafc --- /dev/null +++ b/docs/js.is_browser.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IS\_BROWSER](./js.is_browser.md) + +## IS\_BROWSER variable + +If we are in the browser. + +Signature: + +```typescript +IS_BROWSER: boolean +``` diff --git a/docs/js.isvalidbytestring.md b/docs/js.isvalidbytestring.md new file mode 100644 index 00000000..556da828 --- /dev/null +++ b/docs/js.isvalidbytestring.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [isValidByteString](./js.isvalidbytestring.md) + +## isValidByteString() function + +Signature: + +```typescript +declare function isValidByteString(value: string): value is ByteSizeString; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string | | + +Returns: + +value is [ByteSizeString](./js.bytesizestring.md) + diff --git a/docs/js.md b/docs/js.md new file mode 100644 index 00000000..af94a8fe --- /dev/null +++ b/docs/js.md @@ -0,0 +1,145 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) + +## js package + +## Classes + +| Class | Description | +| --- | --- | +| [APIClient](./js.apiclient.md) | | +| [Hop](./js.hop.md) | Constructs a new instance of Hop and all of its SDKs. | +| [HopAPIError](./js.hopapierror.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [BuildMethod](./js.buildmethod.md) | Types of build methods supported by Hop | +| [BuildState](./js.buildstate.md) | | +| [ChannelType](./js.channeltype.md) | | +| [ContainerState](./js.containerstate.md) | Container state is relatively self-explanatory. It describes what the container is currently doing. | +| [DomainState](./js.domainstate.md) | | +| [GatewayType](./js.gatewaytype.md) | Types of gateways supported by Hop | +| [PROJECT\_PERMISSION](./js.project_permission.md) | | +| [ProjectTier](./js.projecttier.md) | | +| [ProjectType](./js.projecttype.md) | Type of a project | +| [Regions](./js.regions.md) | | +| [RestartPolicy](./js.restartpolicy.md) | Restart policy for deployments | +| [RolloutState](./js.rolloutstate.md) | Rollout state for deployments | +| [RuntimeType](./js.runtimetype.md) | Runtime types are used to describe the type of a deployment or container | +| [VgpuType](./js.vgputype.md) | Types for supported GPU | +| [VolumeFormat](./js.volumeformat.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [assertId(maybeId, prefix, message)](./js.assertid.md) | Asserts that a string is a valid ID | +| [getIdPrefix(id, expect)](./js.getidprefix.md) | | +| [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | +| [isValidByteString(value)](./js.isvalidbytestring.md) | | +| [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | +| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | | +| [validateId(maybeId, prefix)](./js.validateid.md) | Validates that a string is a valid ID | +| [validateIdPrefix(prefix, expect)](./js.validateidprefix.md) | Checks if a string is a valid Hop ID prefix | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [APIClientOptions](./js.apiclientoptions.md) | | +| [Auth](./js.auth.md) | Docker image registry authorization | +| [Build](./js.build.md) | | +| [BuildMetaData](./js.buildmetadata.md) | | +| [Channel](./js.channel.md) | | +| [ChannelToken](./js.channeltoken.md) | | +| [Container](./js.container.md) | | +| [ContainerLog](./js.containerlog.md) | Logs from a container | +| [DefaultQuotas](./js.defaultquotas.md) | | +| [Deployment](./js.deployment.md) | | +| [Domain](./js.domain.md) | | +| [Gateway](./js.gateway.md) | Gateways are used to connect services to the internet or a private network | +| [GHRepo](./js.ghrepo.md) | GitHub repo type sent from API (NOT USED IN IMAGES) | +| [Image\_2](./js.image_2.md) | Docker image config | +| [ImageGHRepo](./js.imageghrepo.md) | GitHub repo partial used for images | +| [MemberRole](./js.memberrole.md) | | +| [PAT](./js.pat.md) | | +| [Project](./js.project.md) | | +| [ProjectToken](./js.projecttoken.md) | A project token for a project | +| [QuotaOverrides](./js.quotaoverrides.md) | | +| [QuotaUsage](./js.quotausage.md) | | +| [Resources](./js.resources.md) | Resources allocated to a deployment | +| [Room](./js.room.md) | | +| [Secret](./js.secret.md) | | +| [User](./js.user.md) | A user objct | +| [Vgpu](./js.vgpu.md) | Virtual GPU config | +| [VolumeDefinition](./js.volumedefinition.md) | | + +## Namespaces + +| Namespace | Description | +| --- | --- | +| [API](./js.api.md) | | +| [Channels](./js.channels.md) | | +| [Ignite](./js.ignite.md) | | +| [Pipe](./js.pipe.md) | | +| [Projects](./js.projects.md) | | +| [Registry](./js.registry.md) | | +| [Users](./js.users.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | | +| [byteUnits](./js.byteunits.md) | | +| [DEFAULT\_BASE\_URL](./js.default_base_url.md) | The default base URL for Hop's API. | +| [ID\_PREFIXES](./js.id_prefixes.md) | | +| [IS\_BROWSER](./js.is_browser.md) | If we are in the browser. | +| [permissions](./js.permissions.md) | | +| [permissionsMap](./js.permissionsmap.md) | | +| [roles](./js.roles.md) | | +| [SUPPORTS\_INTL](./js.supports_intl.md) | | +| [units](./js.units.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [AnyId](./js.anyid.md) | | +| [APIAuthentication](./js.apiauthentication.md) | | +| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | | +| [APIResponse](./js.apiresponse.md) | | +| [ByteSizeString](./js.bytesizestring.md) | | +| [ByteString](./js.bytestring.md) | | +| [ByteUnit](./js.byteunit.md) | | +| [ChannelEndpoints](./js.channelendpoints.md) | | +| [DeliveryProtocol](./js.deliveryprotocol.md) | | +| [DeploymentConfig](./js.deploymentconfig.md) | | +| [DeploymentRollout](./js.deploymentrollout.md) | | +| [Empty](./js.empty.md) | | +| [Endpoint](./js.endpoint.md) | | +| [Endpoints](./js.endpoints.md) | | +| [ErroredAPIResponse](./js.erroredapiresponse.md) | | +| [ExtractRouteParams](./js.extractrouteparams.md) | | +| [HopShDomain](./js.hopshdomain.md) | | +| [Id](./js.id.md) | | +| [IdPrefixes](./js.idprefixes.md) | | +| [IgniteEndpoints](./js.igniteendpoints.md) | | +| [InternalHopDomain](./js.internalhopdomain.md) | | +| [Member](./js.member.md) | | +| [Method](./js.method.md) | | +| [PartialAPIOptions](./js.partialapioptions.md) | | +| [PipeEndpoints](./js.pipeendpoints.md) | | +| [ProjectsEndpoints](./js.projectsendpoints.md) | | +| [Query](./js.query.md) | | +| [RegistryEndpoints](./js.registryendpoints.md) | | +| [State](./js.state.md) | | +| [SuccessfulAPIResponse](./js.successfulapiresponse.md) | | +| [Tag](./js.tag.md) | | +| [Timestamp](./js.timestamp.md) | Hop's API uses ISO 8601 date strings | +| [UserEndpoints](./js.userendpoints.md) | | +| [Values](./js.values.md) | | + diff --git a/docs/js.member.md b/docs/js.member.md new file mode 100644 index 00000000..0ee4a3b3 --- /dev/null +++ b/docs/js.member.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Member](./js.member.md) + +## Member type + +Signature: + +```typescript +declare type Member = Omit & { + id: Id<'pm'>; + role: MemberRole; + joined_at: Timestamp; +}; +``` +References: [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [Timestamp](./js.timestamp.md) + diff --git a/docs/js.memberrole.flags.md b/docs/js.memberrole.flags.md new file mode 100644 index 00000000..2e0c80d2 --- /dev/null +++ b/docs/js.memberrole.flags.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [flags](./js.memberrole.flags.md) + +## MemberRole.flags property + +The flags for this role + +Signature: + +```typescript +flags: number; +``` diff --git a/docs/js.memberrole.id.md b/docs/js.memberrole.id.md new file mode 100644 index 00000000..f270fc72 --- /dev/null +++ b/docs/js.memberrole.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [id](./js.memberrole.id.md) + +## MemberRole.id property + +The ID of the role + +Signature: + +```typescript +id: Id<'role'>; +``` diff --git a/docs/js.memberrole.md b/docs/js.memberrole.md new file mode 100644 index 00000000..25369fad --- /dev/null +++ b/docs/js.memberrole.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) + +## MemberRole interface + +Signature: + +```typescript +interface MemberRole +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [flags](./js.memberrole.flags.md) | | number | The flags for this role | +| [id](./js.memberrole.id.md) | | [Id](./js.id.md)<'role'> | The ID of the role | +| [name](./js.memberrole.name.md) | | string | The name of the role | + diff --git a/docs/js.memberrole.name.md b/docs/js.memberrole.name.md new file mode 100644 index 00000000..ecdd270d --- /dev/null +++ b/docs/js.memberrole.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [name](./js.memberrole.name.md) + +## MemberRole.name property + +The name of the role + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.method.md b/docs/js.method.md new file mode 100644 index 00000000..a7e55a41 --- /dev/null +++ b/docs/js.method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) + +## Method type + +Signature: + +```typescript +declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +``` diff --git a/docs/js.parsesize.md b/docs/js.parsesize.md new file mode 100644 index 00000000..322ce2fa --- /dev/null +++ b/docs/js.parsesize.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [parseSize](./js.parsesize.md) + +## parseSize() function + +Parses a byte size string into bytes + +Signature: + +```typescript +declare function parseSize(size: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| size | string | The size of anything in gigabytes, megabytes, kilobytes or bytes | + +Returns: + +number + diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md new file mode 100644 index 00000000..27242ba4 --- /dev/null +++ b/docs/js.partialapioptions.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PartialAPIOptions](./js.partialapioptions.md) + +## PartialAPIOptions type + +Signature: + +```typescript +declare type PartialAPIOptions = Partial> & Pick; +``` +References: [APIClientOptions](./js.apiclientoptions.md) + diff --git a/docs/js.pat.created_at.md b/docs/js.pat.created_at.md new file mode 100644 index 00000000..06e61761 --- /dev/null +++ b/docs/js.pat.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [created\_at](./js.pat.created_at.md) + +## PAT.created\_at property + +The date the pat was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.pat.id.md b/docs/js.pat.id.md new file mode 100644 index 00000000..2931e3ae --- /dev/null +++ b/docs/js.pat.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [id](./js.pat.id.md) + +## PAT.id property + +The ID of the pat + +Signature: + +```typescript +id: Id<'pat'>; +``` diff --git a/docs/js.pat.md b/docs/js.pat.md new file mode 100644 index 00000000..ebd93103 --- /dev/null +++ b/docs/js.pat.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) + +## PAT interface + +Signature: + +```typescript +interface PAT +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.pat.created_at.md) | | [Timestamp](./js.timestamp.md) | The date the pat was created | +| [id](./js.pat.id.md) | | [Id](./js.id.md)<'pat'> | The ID of the pat | +| [name](./js.pat.name.md) | | string \| null | The name of the pat | + diff --git a/docs/js.pat.name.md b/docs/js.pat.name.md new file mode 100644 index 00000000..1312d7b5 --- /dev/null +++ b/docs/js.pat.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [name](./js.pat.name.md) + +## PAT.name property + +The name of the pat + +Signature: + +```typescript +name: string | null; +``` diff --git a/docs/js.permissions.md b/docs/js.permissions.md new file mode 100644 index 00000000..85dc9aba --- /dev/null +++ b/docs/js.permissions.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [permissions](./js.permissions.md) + +## permissions variable + +Signature: + +```typescript +permissions: { + add(value: bigint, flag: bigint): bigint; + test(value: bigint, flag: bigint): boolean; + subtract(value: bigint, flag: bigint): bigint; +} +``` diff --git a/docs/js.permissionsmap.md b/docs/js.permissionsmap.md new file mode 100644 index 00000000..4b05272c --- /dev/null +++ b/docs/js.permissionsmap.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [permissionsMap](./js.permissionsmap.md) + +## permissionsMap variable + +Signature: + +```typescript +permissionsMap: { + add_member: bigint; + remove_member: bigint; + get_project_members: bigint; + delete_project: bigint; + delete_deployment: bigint; + delete_container: bigint; + update_container_state: bigint; + read_deployments: bigint; + create_deployment: bigint; + create_container: bigint; + update_container_config: bigint; + create_room: bigint; + read_room: bigint; + delete_room: bigint; + create_room_producer: bigint; + create_project_token: bigint; + delete_project_token: bigint; + read_project_tokens: bigint; + read_container_logs: bigint; + create_project_secret: bigint; + read_project_secrets: bigint; + delete_project_secret: bigint; + get_registry_images: bigint; + create_channel_token: bigint; + create_gateway: bigint; + add_domain: bigint; + delete_channels: bigint; + update_channel_state: bigint; + read_channels: bigint; + publish_channel_messages: bigint; + manage_channel_subscribers: bigint; + delete_domain: bigint; + delete_gateway: bigint; + get_internal_domain: bigint; + create_leap_token: bigint; + read_leap_tokens: bigint; + update_leap_token: bigint; + message_token: bigint; + create_channel: bigint; + rollout: bigint; + request_quota_increase: bigint; + read_billing: bigint; + read_gateways: bigint; + delete_registry_images: bigint; +} +``` diff --git a/docs/js.pipe.md b/docs/js.pipe.md new file mode 100644 index 00000000..09432b46 --- /dev/null +++ b/docs/js.pipe.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Pipe](./js.pipe.md) + +## Pipe namespace + +Signature: + +```typescript +declare namespace pipe +``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md new file mode 100644 index 00000000..5d8178ef --- /dev/null +++ b/docs/js.pipeendpoints.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PipeEndpoints](./js.pipeendpoints.md) + +## PipeEndpoints type + +Signature: + +```typescript +declare type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { + rooms: Room[]; +}> | Endpoint<'POST', '/v1/pipe/rooms', { + room: Room; +}, { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; +}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) + diff --git a/docs/js.project.created_at.md b/docs/js.project.created_at.md new file mode 100644 index 00000000..0b1cbd9f --- /dev/null +++ b/docs/js.project.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [created\_at](./js.project.created_at.md) + +## Project.created\_at property + +The time this project was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.project.default_quotas.md b/docs/js.project.default_quotas.md new file mode 100644 index 00000000..3c67e09b --- /dev/null +++ b/docs/js.project.default_quotas.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [default\_quotas](./js.project.default_quotas.md) + +## Project.default\_quotas property + +Signature: + +```typescript +default_quotas: DefaultQuotas; +``` diff --git a/docs/js.project.icon.md b/docs/js.project.icon.md new file mode 100644 index 00000000..50950ecf --- /dev/null +++ b/docs/js.project.icon.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [icon](./js.project.icon.md) + +## Project.icon property + +An icon for this project + +Signature: + +```typescript +icon: string | null; +``` diff --git a/docs/js.project.id.md b/docs/js.project.id.md new file mode 100644 index 00000000..1e88e80b --- /dev/null +++ b/docs/js.project.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [id](./js.project.id.md) + +## Project.id property + +The ID of the project + +Signature: + +```typescript +id: Id<'project'>; +``` diff --git a/docs/js.project.md b/docs/js.project.md new file mode 100644 index 00000000..447623d1 --- /dev/null +++ b/docs/js.project.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) + +## Project interface + +Signature: + +```typescript +interface Project +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.project.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project was created at | +| [default\_quotas](./js.project.default_quotas.md) | | [DefaultQuotas](./js.defaultquotas.md) | | +| [icon](./js.project.icon.md) | | string \| null | An icon for this project | +| [id](./js.project.id.md) | | [Id](./js.id.md)<'project'> | The ID of the project | +| [name](./js.project.name.md) | | string | The name of the project | +| [namespace](./js.project.namespace.md) | | string | The registry namespace for this project | +| [quota\_overrides](./js.project.quota_overrides.md) | | [QuotaOverrides](./js.quotaoverrides.md) | | +| [quota\_usage](./js.project.quota_usage.md) | | [QuotaUsage](./js.quotausage.md) | | +| [tier](./js.project.tier.md) | | [ProjectTier](./js.projecttier.md) | The tier this project is | +| [type](./js.project.type.md) | | [ProjectType](./js.projecttype.md) | The type of this project. Either regular or personal | + diff --git a/docs/js.project.name.md b/docs/js.project.name.md new file mode 100644 index 00000000..b138c95c --- /dev/null +++ b/docs/js.project.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [name](./js.project.name.md) + +## Project.name property + +The name of the project + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.project.namespace.md b/docs/js.project.namespace.md new file mode 100644 index 00000000..aaa8fdc8 --- /dev/null +++ b/docs/js.project.namespace.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [namespace](./js.project.namespace.md) + +## Project.namespace property + +The registry namespace for this project + +Signature: + +```typescript +namespace: string; +``` diff --git a/docs/js.project.quota_overrides.md b/docs/js.project.quota_overrides.md new file mode 100644 index 00000000..1d16a7da --- /dev/null +++ b/docs/js.project.quota_overrides.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_overrides](./js.project.quota_overrides.md) + +## Project.quota\_overrides property + +Signature: + +```typescript +quota_overrides: QuotaOverrides; +``` diff --git a/docs/js.project.quota_usage.md b/docs/js.project.quota_usage.md new file mode 100644 index 00000000..0ba5afce --- /dev/null +++ b/docs/js.project.quota_usage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_usage](./js.project.quota_usage.md) + +## Project.quota\_usage property + +Signature: + +```typescript +quota_usage: QuotaUsage; +``` diff --git a/docs/js.project.tier.md b/docs/js.project.tier.md new file mode 100644 index 00000000..684e6f73 --- /dev/null +++ b/docs/js.project.tier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [tier](./js.project.tier.md) + +## Project.tier property + +The tier this project is + +Signature: + +```typescript +tier: ProjectTier; +``` diff --git a/docs/js.project.type.md b/docs/js.project.type.md new file mode 100644 index 00000000..66f2c248 --- /dev/null +++ b/docs/js.project.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [type](./js.project.type.md) + +## Project.type property + +The type of this project. Either regular or personal + +Signature: + +```typescript +type: ProjectType; +``` diff --git a/docs/js.project_permission.md b/docs/js.project_permission.md new file mode 100644 index 00000000..b07a7f43 --- /dev/null +++ b/docs/js.project_permission.md @@ -0,0 +1,61 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PROJECT\_PERMISSION](./js.project_permission.md) + +## PROJECT\_PERMISSION enum + +Signature: + +```typescript +declare enum PROJECT_PERMISSION +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ADD\_DOMAIN | "add_domain" | | +| ADD\_MEMBER | "add_member" | | +| CREATE\_CHANNEL | "create_channel" | | +| CREATE\_CHANNEL\_TOKEN | "create_channel_token" | | +| CREATE\_CONTAINER | "create_container" | | +| CREATE\_DEPLOYMENT | "create_deployment" | | +| CREATE\_GATEWAY | "create_gateway" | | +| CREATE\_LEAP\_TOKEN | "create_leap_token" | | +| CREATE\_PROJECT\_SECRET | "create_project_secret" | | +| CREATE\_PROJECT\_TOKEN | "create_project_token" | | +| CREATE\_ROOM | "create_room" | | +| CREATE\_ROOM\_PRODUCER | "create_room_producer" | | +| DELETE\_CHANNELS | "delete_channels" | | +| DELETE\_CONTAINER | "delete_container" | | +| DELETE\_DEPLOYMENT | "delete_deployment" | | +| DELETE\_DOMAIN | "delete_domain" | | +| DELETE\_GATEWAY | "delete_gateway" | | +| DELETE\_PROJECT | "delete_project" | | +| DELETE\_PROJECT\_SECRET | "delete_project_secret" | | +| DELETE\_PROJECT\_TOKEN | "delete_project_token" | | +| DELETE\_REGISTRY\_IMAGES | "delete_registry_images" | | +| DELETE\_ROOM | "delete_room" | | +| GET\_INTERNAL\_DOMAIN | "get_internal_domain" | | +| GET\_PROJECT\_MEMBERS | "get_project_members" | | +| GET\_REGISTRY\_IMAGES | "get_registry_images" | | +| MANAGE\_CHANNEL\_SUBSCRIBERS | "manage_channel_subscribers" | | +| MESSAGE\_TOKEN | "message_token" | | +| PUBLISH\_CHANNEL\_MESSAGES | "publish_channel_messages" | | +| READ\_BILLING | "read_billing" | | +| READ\_CHANNELS | "read_channels" | | +| READ\_CONTAINER\_LOGS | "read_container_logs" | | +| READ\_DEPLOYMENTS | "read_deployments" | | +| READ\_GATEWAYS | "read_gateways" | | +| READ\_LEAP\_TOKENS | "read_leap_tokens" | | +| READ\_PROJECT\_SECRETS | "read_project_secrets" | | +| READ\_PROJECT\_TOKENS | "read_project_tokens" | | +| READ\_ROOM | "read_room" | | +| REMOVE\_MEMBER | "remove_member" | | +| REQUEST\_QUOTA\_INCREASE | "request_quota_increase" | | +| ROLLOUT | "rollout" | | +| UPDATE\_CHANNEL\_STATE | "update_channel_state" | | +| UPDATE\_CONTAINER\_CONFIG | "update_container_config" | | +| UPDATE\_CONTAINER\_STATE | "update_container_state" | | +| UPDATE\_LEAP\_TOKEN | "update_leap_token" | | + diff --git a/docs/js.projects.md b/docs/js.projects.md new file mode 100644 index 00000000..6cadb993 --- /dev/null +++ b/docs/js.projects.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Projects](./js.projects.md) + +## Projects namespace + +Signature: + +```typescript +declare namespace projects +``` diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md new file mode 100644 index 00000000..e666e15c --- /dev/null +++ b/docs/js.projectsendpoints.md @@ -0,0 +1,43 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectsEndpoints](./js.projectsendpoints.md) + +## ProjectsEndpoints type + +Signature: + +```typescript +declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { + project_member: Member; +}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/@this/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/:project_id/members', { + members: Member[]; +}> | Endpoint<'GET', '/v1/projects/@this/members', { + members: Member[]; +}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'POST', '/v1/projects/@this/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { + secrets: Secret[]; +}> | Endpoint<'GET', '/v1/projects/@this/secrets', { + secrets: Secret[]; +}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) + diff --git a/docs/js.projecttier.md b/docs/js.projecttier.md new file mode 100644 index 00000000..0693bcce --- /dev/null +++ b/docs/js.projecttier.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectTier](./js.projecttier.md) + +## ProjectTier enum + +Signature: + +```typescript +declare enum ProjectTier +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| FREE | "free" | | +| PAID | "paid" | | + diff --git a/docs/js.projecttoken.created_at.md b/docs/js.projecttoken.created_at.md new file mode 100644 index 00000000..4ff2416f --- /dev/null +++ b/docs/js.projecttoken.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [created\_at](./js.projecttoken.created_at.md) + +## ProjectToken.created\_at property + +The time this project token was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.projecttoken.flags.md b/docs/js.projecttoken.flags.md new file mode 100644 index 00000000..af2769a6 --- /dev/null +++ b/docs/js.projecttoken.flags.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [flags](./js.projecttoken.flags.md) + +## ProjectToken.flags property + +Permissions and flags that this project token can perform + +Signature: + +```typescript +flags: number; +``` diff --git a/docs/js.projecttoken.id.md b/docs/js.projecttoken.id.md new file mode 100644 index 00000000..1b4ef352 --- /dev/null +++ b/docs/js.projecttoken.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [id](./js.projecttoken.id.md) + +## ProjectToken.id property + +The Id of the project token + +Signature: + +```typescript +id: Id<'ptkid'>; +``` diff --git a/docs/js.projecttoken.md b/docs/js.projecttoken.md new file mode 100644 index 00000000..b35917ad --- /dev/null +++ b/docs/js.projecttoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) + +## ProjectToken interface + +A project token for a project + +Signature: + +```typescript +interface ProjectToken +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.projecttoken.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project token was created | +| [flags](./js.projecttoken.flags.md) | | number | Permissions and flags that this project token can perform | +| [id](./js.projecttoken.id.md) | | [Id](./js.id.md)<'ptkid'> | The Id of the project token | +| [token](./js.projecttoken.token.md) | | [Id](./js.id.md)<'ptk'> | The key value. This will likely have half of the key obfuscated | + diff --git a/docs/js.projecttoken.token.md b/docs/js.projecttoken.token.md new file mode 100644 index 00000000..5a4ac224 --- /dev/null +++ b/docs/js.projecttoken.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [token](./js.projecttoken.token.md) + +## ProjectToken.token property + +The key value. This will likely have half of the key obfuscated + +Signature: + +```typescript +token: Id<'ptk'>; +``` diff --git a/docs/js.projecttype.md b/docs/js.projecttype.md new file mode 100644 index 00000000..abf51c1e --- /dev/null +++ b/docs/js.projecttype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectType](./js.projecttype.md) + +## ProjectType enum + +Type of a project + +Signature: + +```typescript +declare enum ProjectType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PERSONAL | "personal" | A personal project are created when you register an account | +| REGULAR | "regular" | A standard project type | + diff --git a/docs/js.query.md b/docs/js.query.md new file mode 100644 index 00000000..4592c5d8 --- /dev/null +++ b/docs/js.query.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Query](./js.query.md) + +## Query type + +Signature: + +```typescript +declare type Query = ExtractRouteParams & Record; +``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.quotaoverrides.md b/docs/js.quotaoverrides.md new file mode 100644 index 00000000..b621ac8b --- /dev/null +++ b/docs/js.quotaoverrides.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaOverrides](./js.quotaoverrides.md) + +## QuotaOverrides interface + +Signature: + +```typescript +interface QuotaOverrides +``` diff --git a/docs/js.quotausage.md b/docs/js.quotausage.md new file mode 100644 index 00000000..343de5a0 --- /dev/null +++ b/docs/js.quotausage.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) + +## QuotaUsage interface + +Signature: + +```typescript +interface QuotaUsage +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.quotausage.ram.md) | | number | | +| [vcpu](./js.quotausage.vcpu.md) | | number | | + diff --git a/docs/js.quotausage.ram.md b/docs/js.quotausage.ram.md new file mode 100644 index 00000000..2f0bc2e4 --- /dev/null +++ b/docs/js.quotausage.ram.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [ram](./js.quotausage.ram.md) + +## QuotaUsage.ram property + +Signature: + +```typescript +ram: number; +``` diff --git a/docs/js.quotausage.vcpu.md b/docs/js.quotausage.vcpu.md new file mode 100644 index 00000000..a4609646 --- /dev/null +++ b/docs/js.quotausage.vcpu.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [vcpu](./js.quotausage.vcpu.md) + +## QuotaUsage.vcpu property + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.regions.md b/docs/js.regions.md new file mode 100644 index 00000000..a1cbc0e7 --- /dev/null +++ b/docs/js.regions.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Regions](./js.regions.md) + +## Regions enum + +Signature: + +```typescript +declare enum Regions +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| US\_EAST\_1 | "us-east-1" | | + diff --git a/docs/js.registry.md b/docs/js.registry.md new file mode 100644 index 00000000..3df4f856 --- /dev/null +++ b/docs/js.registry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Registry](./js.registry.md) + +## Registry namespace + +Signature: + +```typescript +declare namespace registry +``` diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md new file mode 100644 index 00000000..b924f713 --- /dev/null +++ b/docs/js.registryendpoints.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RegistryEndpoints](./js.registryendpoints.md) + +## RegistryEndpoints type + +Signature: + +```typescript +declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { + images: string[]; +}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; +}>; +``` +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) + diff --git a/docs/js.resources.md b/docs/js.resources.md new file mode 100644 index 00000000..70132304 --- /dev/null +++ b/docs/js.resources.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) + +## Resources interface + +Resources allocated to a deployment + +Signature: + +```typescript +interface Resources +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.resources.ram.md) | | [ByteSizeString](./js.bytesizestring.md) | Amount of memory to allocate in a readible format You can use the parseSize function to convert this to bytes. | +| [vcpu](./js.resources.vcpu.md) | | number | Amount of vCPU to allocate | +| [vgpu](./js.resources.vgpu.md) | | [Vgpu](./js.vgpu.md)\[\] | vGPUs to allocate | + diff --git a/docs/js.resources.ram.md b/docs/js.resources.ram.md new file mode 100644 index 00000000..f4d6207d --- /dev/null +++ b/docs/js.resources.ram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [ram](./js.resources.ram.md) + +## Resources.ram property + +Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes. + +Signature: + +```typescript +ram: ByteSizeString; +``` diff --git a/docs/js.resources.vcpu.md b/docs/js.resources.vcpu.md new file mode 100644 index 00000000..ebcb3493 --- /dev/null +++ b/docs/js.resources.vcpu.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vcpu](./js.resources.vcpu.md) + +## Resources.vcpu property + +Amount of vCPU to allocate + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.resources.vgpu.md b/docs/js.resources.vgpu.md new file mode 100644 index 00000000..cac4f7bf --- /dev/null +++ b/docs/js.resources.vgpu.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vgpu](./js.resources.vgpu.md) + +## Resources.vgpu property + +vGPUs to allocate + +Signature: + +```typescript +vgpu: Vgpu[]; +``` diff --git a/docs/js.restartpolicy.md b/docs/js.restartpolicy.md new file mode 100644 index 00000000..fcfb286e --- /dev/null +++ b/docs/js.restartpolicy.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RestartPolicy](./js.restartpolicy.md) + +## RestartPolicy enum + +Restart policy for deployments + +Signature: + +```typescript +declare enum RestartPolicy +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ALWAYS | "always" | | +| NEVER | "never" | | +| ON\_FAILURE | "on-failure" | | + diff --git a/docs/js.roles.md b/docs/js.roles.md new file mode 100644 index 00000000..18fec69a --- /dev/null +++ b/docs/js.roles.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [roles](./js.roles.md) + +## roles variable + +Signature: + +```typescript +roles: { + viewer: bigint; + editor: bigint; + admin: bigint; + owner: bigint; +} +``` diff --git a/docs/js.rolloutstate.md b/docs/js.rolloutstate.md new file mode 100644 index 00000000..53d6720f --- /dev/null +++ b/docs/js.rolloutstate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RolloutState](./js.rolloutstate.md) + +## RolloutState enum + +Rollout state for deployments + +Signature: + +```typescript +declare enum RolloutState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| FAILED | "failed" | | +| FINISHED | "finished" | | +| PENDING | "pending" | | + diff --git a/docs/js.room.created_at.md b/docs/js.room.created_at.md new file mode 100644 index 00000000..433be446 --- /dev/null +++ b/docs/js.room.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [created\_at](./js.room.created_at.md) + +## Room.created\_at property + +The unix timestamp of when this stream was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.room.delivery_protocols.md b/docs/js.room.delivery_protocols.md new file mode 100644 index 00000000..197896db --- /dev/null +++ b/docs/js.room.delivery_protocols.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [delivery\_protocols](./js.room.delivery_protocols.md) + +## Room.delivery\_protocols property + +Protocols that are supported by this room to the client + +Signature: + +```typescript +delivery_protocols: DeliveryProtocol[]; +``` diff --git a/docs/js.room.id.md b/docs/js.room.id.md new file mode 100644 index 00000000..2ec7f4f4 --- /dev/null +++ b/docs/js.room.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [id](./js.room.id.md) + +## Room.id property + +The ID of this stream + +Signature: + +```typescript +id: Id<'pipe_room'>; +``` diff --git a/docs/js.room.ingest_endpoint.md b/docs/js.room.ingest_endpoint.md new file mode 100644 index 00000000..8abeaa5d --- /dev/null +++ b/docs/js.room.ingest_endpoint.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_endpoint](./js.room.ingest_endpoint.md) + +## Room.ingest\_endpoint property + +The URL that you can stream to + +Signature: + +```typescript +ingest_endpoint: string; +``` diff --git a/docs/js.room.ingest_protocol.md b/docs/js.room.ingest_protocol.md new file mode 100644 index 00000000..672c9a50 --- /dev/null +++ b/docs/js.room.ingest_protocol.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_protocol](./js.room.ingest_protocol.md) + +## Room.ingest\_protocol property + +Protocol you can stream with + +Signature: + +```typescript +ingest_protocol: 'rtmp'; +``` diff --git a/docs/js.room.ingest_region.md b/docs/js.room.ingest_region.md new file mode 100644 index 00000000..1ac0ab09 --- /dev/null +++ b/docs/js.room.ingest_region.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_region](./js.room.ingest_region.md) + +## Room.ingest\_region property + +The region that the stream url is located in + +Signature: + +```typescript +ingest_region: Regions; +``` diff --git a/docs/js.room.join_token.md b/docs/js.room.join_token.md new file mode 100644 index 00000000..f701d3db --- /dev/null +++ b/docs/js.room.join_token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [join\_token](./js.room.join_token.md) + +## Room.join\_token property + +A join token to subscribe into this room + +Signature: + +```typescript +join_token: string; +``` diff --git a/docs/js.room.md b/docs/js.room.md new file mode 100644 index 00000000..438ec36e --- /dev/null +++ b/docs/js.room.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) + +## Room interface + +Signature: + +```typescript +interface Room +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.room.created_at.md) | | [Timestamp](./js.timestamp.md) | The unix timestamp of when this stream was created | +| [delivery\_protocols](./js.room.delivery_protocols.md) | | [DeliveryProtocol](./js.deliveryprotocol.md)\[\] | Protocols that are supported by this room to the client | +| [id](./js.room.id.md) | | [Id](./js.id.md)<'pipe\_room'> | The ID of this stream | +| [ingest\_endpoint](./js.room.ingest_endpoint.md) | | string | The URL that you can stream to | +| [ingest\_protocol](./js.room.ingest_protocol.md) | | 'rtmp' | Protocol you can stream with | +| [ingest\_region](./js.room.ingest_region.md) | | [Regions](./js.regions.md) | The region that the stream url is located in | +| [join\_token](./js.room.join_token.md) | | string | A join token to subscribe into this room | +| [name](./js.room.name.md) | | string | The name of this room | +| [state](./js.room.state.md) | | 'live' \| 'offline' | The state of the stream currently | + diff --git a/docs/js.room.name.md b/docs/js.room.name.md new file mode 100644 index 00000000..705a6e13 --- /dev/null +++ b/docs/js.room.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [name](./js.room.name.md) + +## Room.name property + +The name of this room + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.room.state.md b/docs/js.room.state.md new file mode 100644 index 00000000..bfa47804 --- /dev/null +++ b/docs/js.room.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [state](./js.room.state.md) + +## Room.state property + +The state of the stream currently + +Signature: + +```typescript +state: 'live' | 'offline'; +``` diff --git a/docs/js.runtimetype.md b/docs/js.runtimetype.md new file mode 100644 index 00000000..d980ef63 --- /dev/null +++ b/docs/js.runtimetype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RuntimeType](./js.runtimetype.md) + +## RuntimeType enum + +Runtime types are used to describe the type of a deployment or container + +Signature: + +```typescript +declare enum RuntimeType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EPHEMERAL | "ephemeral" | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | +| PERSISTENT | "persistent" | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | +| STATEFUL | "stateful" | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | + diff --git a/docs/js.secret.created_at.md b/docs/js.secret.created_at.md new file mode 100644 index 00000000..b28a9883 --- /dev/null +++ b/docs/js.secret.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [created\_at](./js.secret.created_at.md) + +## Secret.created\_at property + +The time this secret was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.secret.digest.md b/docs/js.secret.digest.md new file mode 100644 index 00000000..93e79489 --- /dev/null +++ b/docs/js.secret.digest.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [digest](./js.secret.digest.md) + +## Secret.digest property + +A digest hash of the secret + +Signature: + +```typescript +digest: string; +``` diff --git a/docs/js.secret.id.md b/docs/js.secret.id.md new file mode 100644 index 00000000..6a9d0d47 --- /dev/null +++ b/docs/js.secret.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [id](./js.secret.id.md) + +## Secret.id property + +The ID of the secret + +Signature: + +```typescript +id: Id<'secret'>; +``` diff --git a/docs/js.secret.md b/docs/js.secret.md new file mode 100644 index 00000000..75cd9fb3 --- /dev/null +++ b/docs/js.secret.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) + +## Secret interface + +Signature: + +```typescript +interface Secret +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.secret.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this secret was created at | +| [digest](./js.secret.digest.md) | | string | A digest hash of the secret | +| [id](./js.secret.id.md) | | [Id](./js.id.md)<'secret'> | The ID of the secret | +| [name](./js.secret.name.md) | | string | The name of the secret | + diff --git a/docs/js.secret.name.md b/docs/js.secret.name.md new file mode 100644 index 00000000..653530e7 --- /dev/null +++ b/docs/js.secret.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [name](./js.secret.name.md) + +## Secret.name property + +The name of the secret + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.state.md b/docs/js.state.md new file mode 100644 index 00000000..91570529 --- /dev/null +++ b/docs/js.state.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [State](./js.state.md) + +## State type + +Signature: + +```typescript +declare type State = Record; +``` diff --git a/docs/js.successfulapiresponse.md b/docs/js.successfulapiresponse.md new file mode 100644 index 00000000..da2e0365 --- /dev/null +++ b/docs/js.successfulapiresponse.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [SuccessfulAPIResponse](./js.successfulapiresponse.md) + +## SuccessfulAPIResponse type + +Signature: + +```typescript +declare type SuccessfulAPIResponse = { + success: true; + data: T; +}; +``` diff --git a/docs/js.supports_intl.md b/docs/js.supports_intl.md new file mode 100644 index 00000000..abcbc5d0 --- /dev/null +++ b/docs/js.supports_intl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [SUPPORTS\_INTL](./js.supports_intl.md) + +## SUPPORTS\_INTL variable + +Signature: + +```typescript +SUPPORTS_INTL: boolean +``` diff --git a/docs/js.tag.md b/docs/js.tag.md new file mode 100644 index 00000000..458816c5 --- /dev/null +++ b/docs/js.tag.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Tag](./js.tag.md) + +## Tag type + +Signature: + +```typescript +declare type Tag = T & { + ___tag: Name; +}; +``` diff --git a/docs/js.timestamp.md b/docs/js.timestamp.md new file mode 100644 index 00000000..bd3efe15 --- /dev/null +++ b/docs/js.timestamp.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Timestamp](./js.timestamp.md) + +## Timestamp type + +Hop's API uses ISO 8601 date strings + +Signature: + +```typescript +declare type Timestamp = Tag; +``` +References: [Tag](./js.tag.md) + diff --git a/docs/js.units.md b/docs/js.units.md new file mode 100644 index 00000000..fed751ae --- /dev/null +++ b/docs/js.units.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [units](./js.units.md) + +## units variable + +> Warning: This API is now obsolete. +> +> use `byteUnits` instead +> + +Signature: + +```typescript +units: readonly ["GB", "MB", "KB", "B"] +``` diff --git a/docs/js.user.email.md b/docs/js.user.email.md new file mode 100644 index 00000000..6c90f052 --- /dev/null +++ b/docs/js.user.email.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [email](./js.user.email.md) + +## User.email property + +The email of the user + +Signature: + +```typescript +email: string; +``` diff --git a/docs/js.user.id.md b/docs/js.user.id.md new file mode 100644 index 00000000..404e7ca0 --- /dev/null +++ b/docs/js.user.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [id](./js.user.id.md) + +## User.id property + +The ID of the user + +Signature: + +```typescript +id: Id<'user'>; +``` diff --git a/docs/js.user.md b/docs/js.user.md new file mode 100644 index 00000000..4382cd49 --- /dev/null +++ b/docs/js.user.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) + +## User interface + +A user objct + +Signature: + +```typescript +interface User +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [email](./js.user.email.md) | | string | The email of the user | +| [id](./js.user.id.md) | | [Id](./js.id.md)<'user'> | The ID of the user | +| [name](./js.user.name.md) | | string | The name of the user. Think of this as a display name | +| [username](./js.user.username.md) | | string | A unqiue username for the user | + diff --git a/docs/js.user.name.md b/docs/js.user.name.md new file mode 100644 index 00000000..36394000 --- /dev/null +++ b/docs/js.user.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [name](./js.user.name.md) + +## User.name property + +The name of the user. Think of this as a display name + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.user.username.md b/docs/js.user.username.md new file mode 100644 index 00000000..1b929208 --- /dev/null +++ b/docs/js.user.username.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [username](./js.user.username.md) + +## User.username property + +A unqiue username for the user + +Signature: + +```typescript +username: string; +``` diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md new file mode 100644 index 00000000..c9a3effc --- /dev/null +++ b/docs/js.userendpoints.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [UserEndpoints](./js.userendpoints.md) + +## UserEndpoints type + +Signature: + +```typescript +declare type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { + projects: Project[]; + user: User; + project_member_role_map: Record, MemberRole>; + leap_token: string | null; +}> | Endpoint<'POST', '/v1/users/@me/pats', { + pat: PAT; +}, { + name: string; +}> | Endpoint<'GET', '/v1/users/@me/pats', { + pats: PAT[]; +}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) + diff --git a/docs/js.users.md b/docs/js.users.md new file mode 100644 index 00000000..3c959755 --- /dev/null +++ b/docs/js.users.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Users](./js.users.md) + +## Users namespace + +Signature: + +```typescript +declare namespace users +``` diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md new file mode 100644 index 00000000..590180e5 --- /dev/null +++ b/docs/js.validateapiauthentication.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateAPIAuthentication](./js.validateapiauthentication.md) + +## validateAPIAuthentication() function + +Signature: + +```typescript +declare function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | string | | + +Returns: + +auth is [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) + diff --git a/docs/js.validateid.md b/docs/js.validateid.md new file mode 100644 index 00000000..d6e273b7 --- /dev/null +++ b/docs/js.validateid.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateId](./js.validateid.md) + +## validateId() function + +Validates that a string is a valid ID + +Signature: + +```typescript +declare function validateId(maybeId: string, prefix?: T | T[]): maybeId is Id; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| maybeId | string | A string that might be an id | +| prefix | T \| T\[\] | (Optional) Optionally an id prefix to check against | + +Returns: + +maybeId is [Id](./js.id.md)<T> + +- true if the string is an id + diff --git a/docs/js.validateidprefix.md b/docs/js.validateidprefix.md new file mode 100644 index 00000000..59c6d9a0 --- /dev/null +++ b/docs/js.validateidprefix.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateIdPrefix](./js.validateidprefix.md) + +## validateIdPrefix() function + +Checks if a string is a valid Hop ID prefix + +Signature: + +```typescript +declare function validateIdPrefix(prefix: string, expect?: T): prefix is T; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prefix | string | A string that is a potential prefix | +| expect | T | (Optional) An expected prefix to check against | + +Returns: + +prefix is T + +- Whether the prefix is valid + diff --git a/docs/js.values.md b/docs/js.values.md new file mode 100644 index 00000000..b8dbb26f --- /dev/null +++ b/docs/js.values.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Values](./js.values.md) + +## Values type + +Signature: + +```typescript +declare type Values = T[keyof T]; +``` diff --git a/docs/js.vgpu.count.md b/docs/js.vgpu.count.md new file mode 100644 index 00000000..7ffa7aa5 --- /dev/null +++ b/docs/js.vgpu.count.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [count](./js.vgpu.count.md) + +## Vgpu.count property + +The amount of vGPUs to allocate + +Signature: + +```typescript +count: number; +``` diff --git a/docs/js.vgpu.md b/docs/js.vgpu.md new file mode 100644 index 00000000..3897532d --- /dev/null +++ b/docs/js.vgpu.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) + +## Vgpu interface + +Virtual GPU config + +Signature: + +```typescript +interface Vgpu +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [count](./js.vgpu.count.md) | | number | The amount of vGPUs to allocate | +| [type](./js.vgpu.type.md) | | [VgpuType](./js.vgputype.md) | The type of vGPU to allocate | + diff --git a/docs/js.vgpu.type.md b/docs/js.vgpu.type.md new file mode 100644 index 00000000..9d3e5d20 --- /dev/null +++ b/docs/js.vgpu.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [type](./js.vgpu.type.md) + +## Vgpu.type property + +The type of vGPU to allocate + +Signature: + +```typescript +type: VgpuType; +``` diff --git a/docs/js.vgputype.md b/docs/js.vgputype.md new file mode 100644 index 00000000..72d39dd5 --- /dev/null +++ b/docs/js.vgputype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VgpuType](./js.vgputype.md) + +## VgpuType enum + +Types for supported GPU + +Signature: + +```typescript +declare enum VgpuType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| A400 | "a400" | | + diff --git a/docs/js.volumedefinition.fs.md b/docs/js.volumedefinition.fs.md new file mode 100644 index 00000000..13e0bde3 --- /dev/null +++ b/docs/js.volumedefinition.fs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [fs](./js.volumedefinition.fs.md) + +## VolumeDefinition.fs property + +The format of the volume + +Signature: + +```typescript +fs: VolumeFormat; +``` diff --git a/docs/js.volumedefinition.md b/docs/js.volumedefinition.md new file mode 100644 index 00000000..0a63f366 --- /dev/null +++ b/docs/js.volumedefinition.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) + +## VolumeDefinition interface + +Signature: + +```typescript +interface VolumeDefinition +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fs](./js.volumedefinition.fs.md) | | [VolumeFormat](./js.volumeformat.md) | The format of the volume | +| [mount\_path](./js.volumedefinition.mount_path.md) | | string | The mount point of the volume | +| [size](./js.volumedefinition.size.md) | | [ByteSizeString](./js.bytesizestring.md) | The size of the volume in bytes | + diff --git a/docs/js.volumedefinition.mount_path.md b/docs/js.volumedefinition.mount_path.md new file mode 100644 index 00000000..b089b026 --- /dev/null +++ b/docs/js.volumedefinition.mount_path.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [mount\_path](./js.volumedefinition.mount_path.md) + +## VolumeDefinition.mount\_path property + +The mount point of the volume + +Signature: + +```typescript +mount_path: string; +``` diff --git a/docs/js.volumedefinition.size.md b/docs/js.volumedefinition.size.md new file mode 100644 index 00000000..493b250e --- /dev/null +++ b/docs/js.volumedefinition.size.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [size](./js.volumedefinition.size.md) + +## VolumeDefinition.size property + +The size of the volume in bytes + +Signature: + +```typescript +size: ByteSizeString; +``` diff --git a/docs/js.volumeformat.md b/docs/js.volumeformat.md new file mode 100644 index 00000000..829d1752 --- /dev/null +++ b/docs/js.volumeformat.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeFormat](./js.volumeformat.md) + +## VolumeFormat enum + +Signature: + +```typescript +declare enum VolumeFormat +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXT4 | "ext4" | | +| XFS | "xfs" | | + diff --git a/package.json b/package.json index b73a0bcf..dd70d42c 100644 --- a/package.json +++ b/package.json @@ -48,6 +48,8 @@ }, "devDependencies": { "@changesets/cli": "2.25.0", + "@microsoft/api-documenter": "^7.19.20", + "@microsoft/api-extractor": "^7.33.2", "@types/glob": "8.0.0", "@types/node": "18.11.0", "dotenv": "16.0.3", diff --git a/src/index.ts b/src/index.ts index d581fb9f..c23c55d6 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,7 +3,22 @@ export * from './permissions.js'; export * from './rest/index.js'; export * from './util/index.js'; -// Commonly used in the API, so nice to export in two place -export {type APIAuthentication} from './rest/index.js'; -export {ContainerState, RuntimeType} from './rest/types/ignite.js'; -export {ChannelType} from './rest/types/channels.js'; +export type { + Project, + User, + MemberRole, + PAT, + Member, + ProjectToken, + Secret, + Channel, + ChannelToken, + State, + Deployment, + Container, + ContainerLog, + Gateway, + Room, + GatewayType, + DeliveryProtocol, +} from './rest/index.js'; diff --git a/src/rest/index.ts b/src/rest/index.ts index 0bcbfe61..185f5689 100644 --- a/src/rest/index.ts +++ b/src/rest/index.ts @@ -1,3 +1,11 @@ export * from './client.js'; export * from './endpoints.js'; export * from './types/index.js'; + +export * from './types/api.js'; +export * from './types/channels.js'; +export * from './types/ignite.js'; +export * from './types/pipe.js'; +export * from './types/projects.js'; +export * from './types/registry.js'; +export * from './types/users.js'; diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 0d2e26ad..4d45970d 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -352,7 +352,7 @@ export type DeploymentConfig = { * * Manual = add containers yourself * - * @warning This property is not yet fully complete + * @alpha This property is not yet fully complete */ container_strategy: 'manual'; @@ -550,7 +550,7 @@ export interface Gateway { /** * The protocol for this gateway (Only for external) * - * @warning Currently, hop only supports HTTP. This will eventually change to an enum + * @alpha Currently, hop only supports HTTP. This will eventually change to an enum */ protocol: 'http' | null; diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index 2d306bde..31bcd5c4 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -41,7 +41,7 @@ export interface PAT { /** * The pat token * - * @warning This value will be partially censored if it + * @alpha This value will be partially censored if it */ pat: string; diff --git a/src/util/types.ts b/src/util/types.ts index c551cc59..288b394a 100644 --- a/src/util/types.ts +++ b/src/util/types.ts @@ -115,6 +115,13 @@ export type HopShDomain = `${string}.hop.sh`; export type InternalHopDomain = `${string}.hop`; export type AnyId = Id; +/** + * Checks if a string is a valid Hop ID prefix + * + * @param prefix - A string that is a potential prefix + * @param expect - An expected prefix to check against + * @returns - Whether the prefix is valid + */ export function validateIdPrefix( prefix: string, expect?: T, @@ -129,9 +136,10 @@ export function validateIdPrefix( /** * Validates that a string is a valid ID * - * @param maybeId A string that might be an id - * @param prefix Optionally an id prefix to check against - * @returns true if the string is an id + * @public + * @param maybeId - A string that might be an id + * @param prefix - Optionally an id prefix to check against + * @returns - true if the string is an id */ export function validateId( maybeId: string, @@ -166,14 +174,30 @@ export function getIdPrefix(id: string, expect?: T) { return prefix; } +/** + * Casts a string to an ID and asserts that it is of the correct type. + * This function will throw if the string is not a valid ID. + * + * @public + * @param maybeId - Cast and assert that a string is an id + * @param prefix - Optionally an prefix or array of prefixes to check against + * @returns - The ID cast to the correct type + */ export function id( maybeId?: string, prefix?: T | T[], -) { +): Id { assertId(maybeId, prefix); return maybeId; } +/** + * Asserts that a string is a valid ID + * @public + * @param maybeId - A string that is possibly an ID + * @param prefix - A prefix or array of prefixes to check against + * @param message - An error message to throw if the ID is invalid + */ export function assertId( maybeId?: string, prefix?: T | T[], diff --git a/tsconfig.json b/tsconfig.json index de244695..40a14b82 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -12,7 +12,9 @@ "resolveJsonModule": true, "isolatedModules": true, "jsx": "react", - "noFallthroughCasesInSwitch": true + "noFallthroughCasesInSwitch": true, + "declaration": true, + "declarationMap": true }, "exclude": ["node_modules", "dist"], "include": ["./**/*.ts", "./**/*.tsx", "gen-docs.mts"] diff --git a/yarn.lock b/yarn.lock index ebb5ea5b..ee8c4a5e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -360,6 +360,82 @@ __metadata: languageName: node linkType: hard +"@microsoft/api-documenter@npm:^7.19.20": + version: 7.19.20 + resolution: "@microsoft/api-documenter@npm:7.19.20" + dependencies: + "@microsoft/api-extractor-model": 7.25.1 + "@microsoft/tsdoc": 0.14.1 + "@rushstack/node-core-library": 3.53.2 + "@rushstack/ts-command-line": 4.12.5 + colors: ~1.2.1 + js-yaml: ~3.13.1 + resolve: ~1.17.0 + bin: + api-documenter: bin/api-documenter + checksum: 31bc23c4a5971a97c509d3eabc09e5fc1522bf50ea61e7373ebbd572cb2c31129bdc34070cc7ff9ca85f683236260684f93565edb2c83c7418cd33a65304bd6d + languageName: node + linkType: hard + +"@microsoft/api-extractor-model@npm:7.25.1": + version: 7.25.1 + resolution: "@microsoft/api-extractor-model@npm:7.25.1" + dependencies: + "@microsoft/tsdoc": 0.14.1 + "@microsoft/tsdoc-config": ~0.16.1 + "@rushstack/node-core-library": 3.53.2 + checksum: fd63f794358b92de84dda95c545ad8147ebd0c71bb4aff63d2ef4f727243d5de7251aa3301f3f917dda1e84248683d9a569a5aa884124fc1f1f6e40444ba8633 + languageName: node + linkType: hard + +"@microsoft/api-extractor@npm:^7.33.2": + version: 7.33.2 + resolution: "@microsoft/api-extractor@npm:7.33.2" + dependencies: + "@microsoft/api-extractor-model": 7.25.1 + "@microsoft/tsdoc": 0.14.1 + "@microsoft/tsdoc-config": ~0.16.1 + "@rushstack/node-core-library": 3.53.2 + "@rushstack/rig-package": 0.3.17 + "@rushstack/ts-command-line": 4.12.5 + colors: ~1.2.1 + lodash: ~4.17.15 + resolve: ~1.17.0 + semver: ~7.3.0 + source-map: ~0.6.1 + typescript: ~4.8.4 + bin: + api-extractor: bin/api-extractor + checksum: c08135537b864339c8f562fdf51a2375f5892f3a229153b14908395212d80718ee62e187ddee792f3973a338f4e6dc10914503a33e486af4bd8a1dca503850c3 + languageName: node + linkType: hard + +"@microsoft/tsdoc-config@npm:~0.16.1": + version: 0.16.2 + resolution: "@microsoft/tsdoc-config@npm:0.16.2" + dependencies: + "@microsoft/tsdoc": 0.14.2 + ajv: ~6.12.6 + jju: ~1.4.0 + resolve: ~1.19.0 + checksum: 12b0d703154076bcaac75ca42e804e4fc292672396441e54346d7eadd0d6b57f90980eda2b1bab89b224af86da34a2389f9054002e282011e795ca5919a4386f + languageName: node + linkType: hard + +"@microsoft/tsdoc@npm:0.14.1": + version: 0.14.1 + resolution: "@microsoft/tsdoc@npm:0.14.1" + checksum: e4ad038ccff2cd96e0d53ee42e2136f0f5a925b16cfda14261f1c2eb55ba0088a0e3b08ff819b476ddc69b2242a391925fab7f6ae2afabb19b96f87e19c114fc + languageName: node + linkType: hard + +"@microsoft/tsdoc@npm:0.14.2": + version: 0.14.2 + resolution: "@microsoft/tsdoc@npm:0.14.2" + checksum: b167c89e916ba73ee20b9c9d5dba6aa3a0de25ed3d50050e8a344dca7cd43cb2e1059bd515c820369b6e708901dd3fda476a42bc643ca74a35671ce77f724a3a + languageName: node + linkType: hard + "@nodelib/fs.scandir@npm:2.1.5": version: 2.1.5 resolution: "@nodelib/fs.scandir@npm:2.1.5" @@ -412,6 +488,8 @@ __metadata: resolution: "@onehop/js@workspace:." dependencies: "@changesets/cli": 2.25.0 + "@microsoft/api-documenter": ^7.19.20 + "@microsoft/api-extractor": ^7.33.2 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.0.0 "@types/node": 18.11.0 @@ -436,6 +514,44 @@ __metadata: languageName: node linkType: hard +"@rushstack/node-core-library@npm:3.53.2": + version: 3.53.2 + resolution: "@rushstack/node-core-library@npm:3.53.2" + dependencies: + "@types/node": 12.20.24 + colors: ~1.2.1 + fs-extra: ~7.0.1 + import-lazy: ~4.0.0 + jju: ~1.4.0 + resolve: ~1.17.0 + semver: ~7.3.0 + z-schema: ~5.0.2 + checksum: eca9ef5dd099649c7e54ac7c6f1019c831e9405ce66210f76d6a597d83341bcd8de197d69539042029ea8aa9862e0515b8102e16a4980c66812f599f7c63479d + languageName: node + linkType: hard + +"@rushstack/rig-package@npm:0.3.17": + version: 0.3.17 + resolution: "@rushstack/rig-package@npm:0.3.17" + dependencies: + resolve: ~1.17.0 + strip-json-comments: ~3.1.1 + checksum: 54eeea471c85b547575d7efc84fad3c9588f10106e2bfd8cd022bccb02c2fb0bf8ff597fab9114450b3c262abab0f0a4e52dd074bfd120e850b95037cd7b3102 + languageName: node + linkType: hard + +"@rushstack/ts-command-line@npm:4.12.5": + version: 4.12.5 + resolution: "@rushstack/ts-command-line@npm:4.12.5" + dependencies: + "@types/argparse": 1.0.38 + argparse: ~1.0.9 + colors: ~1.2.1 + string-argv: ~0.3.1 + checksum: 4da741e10382b119d46e3fcdbc2daf0747c63f98c97d44c354b45da1f7e31e7ccf45753668fe636f515663930340e4ac2c0535f2178130e04ce1714d4b8dd688 + languageName: node + linkType: hard + "@tootallnate/once@npm:2": version: 2.0.0 resolution: "@tootallnate/once@npm:2.0.0" @@ -443,6 +559,13 @@ __metadata: languageName: node linkType: hard +"@types/argparse@npm:1.0.38": + version: 1.0.38 + resolution: "@types/argparse@npm:1.0.38" + checksum: 26ed7e3f1e3595efdb883a852f5205f971b798e4c28b7e30a32c5298eee596e8b45834ce831f014d250b9730819ab05acff5b31229666d3af4ba465b4697d0eb + languageName: node + linkType: hard + "@types/glob@npm:8.0.0": version: 8.0.0 resolution: "@types/glob@npm:8.0.0" @@ -483,6 +606,13 @@ __metadata: languageName: node linkType: hard +"@types/node@npm:12.20.24": + version: 12.20.24 + resolution: "@types/node@npm:12.20.24" + checksum: e7a13460e2f5b0b5a32c0f3af7daf1a05201552a66d542d3cc3b1ea8b52d4730250f9eb1961d755e31cfe5d03c78340911a6242657a0a9a17d6f7e341fc9f366 + languageName: node + linkType: hard + "@types/node@npm:18.11.0": version: 18.11.0 resolution: "@types/node@npm:18.11.0" @@ -548,6 +678,18 @@ __metadata: languageName: node linkType: hard +"ajv@npm:~6.12.6": + version: 6.12.6 + resolution: "ajv@npm:6.12.6" + dependencies: + fast-deep-equal: ^3.1.1 + fast-json-stable-stringify: ^2.0.0 + json-schema-traverse: ^0.4.1 + uri-js: ^4.2.2 + checksum: 874972efe5c4202ab0a68379481fbd3d1b5d0a7bd6d3cc21d40d3536ebff3352a2a1fabb632d4fd2cc7fe4cbdcd5ed6782084c9bbf7f32a1536d18f9da5007d4 + languageName: node + linkType: hard + "ansi-colors@npm:^4.1.1, ansi-colors@npm:^4.1.3": version: 4.1.3 resolution: "ansi-colors@npm:4.1.3" @@ -614,7 +756,7 @@ __metadata: languageName: node linkType: hard -"argparse@npm:^1.0.7": +"argparse@npm:^1.0.7, argparse@npm:~1.0.9": version: 1.0.10 resolution: "argparse@npm:1.0.10" dependencies: @@ -926,6 +1068,20 @@ __metadata: languageName: node linkType: hard +"colors@npm:~1.2.1": + version: 1.2.5 + resolution: "colors@npm:1.2.5" + checksum: b6e23de735f68b72d5cdf6fd854ca43d1b66d82dcf54bda0b788083b910164a040f2c4edf23c670d36a7a2d8f1b7d6e62e3292703e4642691e6ccaa1c62d8f74 + languageName: node + linkType: hard + +"commander@npm:^2.20.3": + version: 2.20.3 + resolution: "commander@npm:2.20.3" + checksum: ab8c07884e42c3a8dbc5dd9592c606176c7eb5c1ca5ff274bcf907039b2c41de3626f684ea75ccf4d361ba004bbaff1f577d5384c155f3871e456bdf27becf9e + languageName: node + linkType: hard + "commander@npm:^4.0.0": version: 4.1.1 resolution: "commander@npm:4.1.1" @@ -1685,6 +1841,13 @@ __metadata: languageName: node linkType: hard +"fast-deep-equal@npm:^3.1.1": + version: 3.1.3 + resolution: "fast-deep-equal@npm:3.1.3" + checksum: e21a9d8d84f53493b6aa15efc9cfd53dd5b714a1f23f67fb5dc8f574af80df889b3bce25dc081887c6d25457cce704e636395333abad896ccdec03abaf1f3f9d + languageName: node + linkType: hard + "fast-glob@npm:^3.2.9": version: 3.2.11 resolution: "fast-glob@npm:3.2.11" @@ -1698,6 +1861,13 @@ __metadata: languageName: node linkType: hard +"fast-json-stable-stringify@npm:^2.0.0": + version: 2.1.0 + resolution: "fast-json-stable-stringify@npm:2.1.0" + checksum: b191531e36c607977e5b1c47811158733c34ccb3bfde92c44798929e9b4154884378536d26ad90dfecd32e1ffc09c545d23535ad91b3161a27ddbb8ebe0cbecb + languageName: node + linkType: hard + "fastq@npm:^1.6.0": version: 1.13.0 resolution: "fastq@npm:1.13.0" @@ -1746,7 +1916,7 @@ __metadata: languageName: node linkType: hard -"fs-extra@npm:^7.0.1": +"fs-extra@npm:^7.0.1, fs-extra@npm:~7.0.1": version: 7.0.1 resolution: "fs-extra@npm:7.0.1" dependencies: @@ -2135,6 +2305,13 @@ __metadata: languageName: node linkType: hard +"import-lazy@npm:~4.0.0": + version: 4.0.0 + resolution: "import-lazy@npm:4.0.0" + checksum: 22f5e51702134aef78890156738454f620e5fe7044b204ebc057c614888a1dd6fdf2ede0fdcca44d5c173fd64f65c985f19a51775b06967ef58cc3d26898df07 + languageName: node + linkType: hard + "imurmurhash@npm:^0.1.4": version: 0.1.4 resolution: "imurmurhash@npm:0.1.4" @@ -2244,7 +2421,7 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.9.0": +"is-core-module@npm:^2.1.0, is-core-module@npm:^2.9.0": version: 2.10.0 resolution: "is-core-module@npm:2.10.0" dependencies: @@ -2398,6 +2575,13 @@ __metadata: languageName: node linkType: hard +"jju@npm:~1.4.0": + version: 1.4.0 + resolution: "jju@npm:1.4.0" + checksum: 3790481bd2b7827dd6336e6e3dc2dcc6d425679ba7ebde7b679f61dceb4457ea0cda330972494de608571f4973c6dfb5f70fab6f3c5037dbab19ac449a60424f + languageName: node + linkType: hard + "joycon@npm:^3.0.1": version: 3.1.1 resolution: "joycon@npm:3.1.1" @@ -2424,6 +2608,18 @@ __metadata: languageName: node linkType: hard +"js-yaml@npm:~3.13.1": + version: 3.13.1 + resolution: "js-yaml@npm:3.13.1" + dependencies: + argparse: ^1.0.7 + esprima: ^4.0.0 + bin: + js-yaml: bin/js-yaml.js + checksum: 7511b764abb66d8aa963379f7d2a404f078457d106552d05a7b556d204f7932384e8477513c124749fa2de52eb328961834562bd09924902c6432e40daa408bc + languageName: node + linkType: hard + "json-parse-even-better-errors@npm:^2.3.0": version: 2.3.1 resolution: "json-parse-even-better-errors@npm:2.3.1" @@ -2431,6 +2627,13 @@ __metadata: languageName: node linkType: hard +"json-schema-traverse@npm:^0.4.1": + version: 0.4.1 + resolution: "json-schema-traverse@npm:0.4.1" + checksum: 7486074d3ba247769fda17d5181b345c9fb7d12e0da98b22d1d71a5db9698d8b4bd900a3ec1a4ffdd60846fc2556274a5c894d0c48795f14cb03aeae7b55260b + languageName: node + linkType: hard + "jsonc-parser@npm:^3.0.0": version: 3.2.0 resolution: "jsonc-parser@npm:3.2.0" @@ -2515,6 +2718,20 @@ __metadata: languageName: node linkType: hard +"lodash.get@npm:^4.4.2": + version: 4.4.2 + resolution: "lodash.get@npm:4.4.2" + checksum: e403047ddb03181c9d0e92df9556570e2b67e0f0a930fcbbbd779370972368f5568e914f913e93f3b08f6d492abc71e14d4e9b7a18916c31fa04bd2306efe545 + languageName: node + linkType: hard + +"lodash.isequal@npm:^4.5.0": + version: 4.5.0 + resolution: "lodash.isequal@npm:4.5.0" + checksum: da27515dc5230eb1140ba65ff8de3613649620e8656b19a6270afe4866b7bd461d9ba2ac8a48dcc57f7adac4ee80e1de9f965d89d4d81a0ad52bb3eec2609644 + languageName: node + linkType: hard + "lodash.sortby@npm:^4.7.0": version: 4.7.0 resolution: "lodash.sortby@npm:4.7.0" @@ -2529,6 +2746,13 @@ __metadata: languageName: node linkType: hard +"lodash@npm:~4.17.15": + version: 4.17.21 + resolution: "lodash@npm:4.17.21" + checksum: eb835a2e51d381e561e508ce932ea50a8e5a68f4ebdd771ea240d3048244a8d13658acbd502cd4829768c56f2e16bdd4340b9ea141297d472517b83868e677f7 + languageName: node + linkType: hard + "lru-cache@npm:^4.0.1": version: 4.1.5 resolution: "lru-cache@npm:4.1.5" @@ -3078,7 +3302,7 @@ __metadata: languageName: node linkType: hard -"path-parse@npm:^1.0.7": +"path-parse@npm:^1.0.6, path-parse@npm:^1.0.7": version: 1.0.7 resolution: "path-parse@npm:1.0.7" checksum: 49abf3d81115642938a8700ec580da6e830dde670be21893c62f4e10bd7dd4c3742ddc603fe24f898cba7eb0c6bc1777f8d9ac14185d34540c6d4d80cd9cae8a @@ -3323,6 +3547,25 @@ __metadata: languageName: node linkType: hard +"resolve@npm:~1.17.0": + version: 1.17.0 + resolution: "resolve@npm:1.17.0" + dependencies: + path-parse: ^1.0.6 + checksum: 9ceaf83b3429f2d7ff5d0281b8d8f18a1f05b6ca86efea7633e76b8f76547f33800799dfdd24434942dec4fbd9e651ed3aef577d9a6b5ec87ad89c1060e24759 + languageName: node + linkType: hard + +"resolve@npm:~1.19.0": + version: 1.19.0 + resolution: "resolve@npm:1.19.0" + dependencies: + is-core-module: ^2.1.0 + path-parse: ^1.0.6 + checksum: a05b356e47b85ad3613d9e2a39a824f3c27f4fcad9c9ff6c7cc71a2e314c5904a90ab37481ad0069d03cab9eaaac6eb68aca1bc3355fdb05f1045cd50e2aacea + languageName: node + linkType: hard + "resolve@patch:resolve@^1.10.0#~builtin": version: 1.22.1 resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=07638b" @@ -3336,6 +3579,25 @@ __metadata: languageName: node linkType: hard +"resolve@patch:resolve@~1.17.0#~builtin": + version: 1.17.0 + resolution: "resolve@patch:resolve@npm%3A1.17.0#~builtin::version=1.17.0&hash=07638b" + dependencies: + path-parse: ^1.0.6 + checksum: 6fd799f282ddf078c4bc20ce863e3af01fa8cb218f0658d9162c57161a2dbafe092b13015b9a4c58d0e1e801cf7aa7a4f13115fea9db98c3f9a0c43e429bad6f + languageName: node + linkType: hard + +"resolve@patch:resolve@~1.19.0#~builtin": + version: 1.19.0 + resolution: "resolve@patch:resolve@npm%3A1.19.0#~builtin::version=1.19.0&hash=07638b" + dependencies: + is-core-module: ^2.1.0 + path-parse: ^1.0.6 + checksum: 2443b94d347e6946c87c85faf13071f605e609e0b54784829b0ed2b917d050bfc1cbaf4ecc6453f224cfa7d0c5dcd97cbb273454cd210bee68e4af15c1a5abc9 + languageName: node + linkType: hard + "retry@npm:^0.12.0": version: 0.12.0 resolution: "retry@npm:0.12.0" @@ -3418,6 +3680,17 @@ __metadata: languageName: node linkType: hard +"semver@npm:~7.3.0": + version: 7.3.8 + resolution: "semver@npm:7.3.8" + dependencies: + lru-cache: ^6.0.0 + bin: + semver: bin/semver.js + checksum: ba9c7cbbf2b7884696523450a61fee1a09930d888b7a8d7579025ad93d459b2d1949ee5bbfeb188b2be5f4ac163544c5e98491ad6152df34154feebc2cc337c1 + languageName: node + linkType: hard + "set-blocking@npm:^2.0.0": version: 2.0.0 resolution: "set-blocking@npm:2.0.0" @@ -3556,7 +3829,7 @@ __metadata: languageName: node linkType: hard -"source-map@npm:^0.6.0, source-map@npm:^0.6.1": +"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1": version: 0.6.1 resolution: "source-map@npm:0.6.1" checksum: 59ce8640cf3f3124f64ac289012c2b8bd377c238e316fb323ea22fbfe83da07d81e000071d7242cad7a23cd91c7de98e4df8830ec3f133cb6133a5f6e9f67bc2 @@ -3632,6 +3905,13 @@ __metadata: languageName: node linkType: hard +"string-argv@npm:~0.3.1": + version: 0.3.1 + resolution: "string-argv@npm:0.3.1" + checksum: efbd0289b599bee808ce80820dfe49c9635610715429c6b7cc50750f0437e3c2f697c81e5c390208c13b5d5d12d904a1546172a88579f6ee5cbaaaa4dc9ec5cf + languageName: node + linkType: hard + "string-width@npm:^1.0.2 || 2 || 3 || 4, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.3": version: 4.2.3 resolution: "string-width@npm:4.2.3" @@ -3706,6 +3986,13 @@ __metadata: languageName: node linkType: hard +"strip-json-comments@npm:~3.1.1": + version: 3.1.1 + resolution: "strip-json-comments@npm:3.1.1" + checksum: 492f73e27268f9b1c122733f28ecb0e7e8d8a531a6662efbd08e22cccb3f9475e90a1b82cab06a392f6afae6d2de636f977e231296400d0ec5304ba70f166443 + languageName: node + linkType: hard + "sucrase@npm:^3.20.3": version: 3.21.0 resolution: "sucrase@npm:3.21.0" @@ -3971,7 +4258,7 @@ __metadata: languageName: node linkType: hard -"typescript@npm:4.8.4": +"typescript@npm:4.8.4, typescript@npm:~4.8.4": version: 4.8.4 resolution: "typescript@npm:4.8.4" bin: @@ -3981,7 +4268,7 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@4.8.4#~builtin": +"typescript@patch:typescript@4.8.4#~builtin, typescript@patch:typescript@~4.8.4#~builtin": version: 4.8.4 resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=a1c5e5" bin: @@ -4037,6 +4324,15 @@ __metadata: languageName: node linkType: hard +"uri-js@npm:^4.2.2": + version: 4.4.1 + resolution: "uri-js@npm:4.4.1" + dependencies: + punycode: ^2.1.0 + checksum: 7167432de6817fe8e9e0c9684f1d2de2bb688c94388f7569f7dbdb1587c9f4ca2a77962f134ec90be0cc4d004c939ff0d05acc9f34a0db39a3c797dada262633 + languageName: node + linkType: hard + "util-deprecate@npm:^1.0.1": version: 1.0.2 resolution: "util-deprecate@npm:1.0.2" @@ -4054,6 +4350,13 @@ __metadata: languageName: node linkType: hard +"validator@npm:^13.7.0": + version: 13.7.0 + resolution: "validator@npm:13.7.0" + checksum: 2b83283de1222ca549a7ef57f46e8d49c6669213348db78b7045bce36a3b5843ff1e9f709ebf74574e06223461ee1f264f8cc9a26a0060a79a27de079d8286ef + languageName: node + linkType: hard + "vscode-oniguruma@npm:^1.6.1": version: 1.6.2 resolution: "vscode-oniguruma@npm:1.6.2" @@ -4302,6 +4605,23 @@ __metadata: languageName: node linkType: hard +"z-schema@npm:~5.0.2": + version: 5.0.4 + resolution: "z-schema@npm:5.0.4" + dependencies: + commander: ^2.20.3 + lodash.get: ^4.4.2 + lodash.isequal: ^4.5.0 + validator: ^13.7.0 + dependenciesMeta: + commander: + optional: true + bin: + z-schema: bin/z-schema + checksum: afa4e0039a104a53eeb6977bf754ef44e32042aecbf3b5eb18b82649763abd5c2608e47d6d6902291359b41e76130594d7f2b6132316d819c3529f17d4d3464d + languageName: node + linkType: hard + "zod@npm:^3.19.1": version: 3.19.1 resolution: "zod@npm:3.19.1" From 861bd4896d8baf64f871f2ae1640f24359c41b04 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 11:43:38 +0100 Subject: [PATCH 02/33] generate api-extractor docs --- docs/index.md | 12 -- docs/js.anyid.md | 13 -- docs/js.api.md | 11 -- docs/js.apiauthentication.md | 13 -- docs/js.apiauthenticationprefix.md | 13 -- docs/js.apiclient._constructor_.md | 20 --- docs/js.apiclient.authtype.md | 11 -- docs/js.apiclient.delete.md | 63 -------- docs/js.apiclient.get.md | 163 --------------------- docs/js.apiclient.getauthtype.md | 22 --- docs/js.apiclient.md | 37 ----- docs/js.apiclient.patch.md | 46 ------ docs/js.apiclient.post.md | 128 ---------------- docs/js.apiclient.put.md | 59 -------- docs/js.apiclient.raw.md | 22 --- docs/js.apiclient.url.md | 11 -- docs/js.apiclientoptions.authentication.md | 11 -- docs/js.apiclientoptions.baseurl.md | 11 -- docs/js.apiclientoptions.md | 19 --- docs/js.apiresponse.md | 13 -- docs/js.assertid.md | 26 ---- docs/js.auth.md | 21 --- docs/js.auth.password.md | 11 -- docs/js.auth.username.md | 11 -- docs/js.broad_permissions_map.md | 23 --- docs/js.build.deployment_id.md | 13 -- docs/js.build.digest.md | 13 -- docs/js.build.finished_at.md | 13 -- docs/js.build.id.md | 13 -- docs/js.build.md | 25 ---- docs/js.build.metadata.md | 13 -- docs/js.build.method.md | 13 -- docs/js.build.started_at.md | 13 -- docs/js.build.state.md | 13 -- docs/js.buildmetadata.account_type.md | 13 -- docs/js.buildmetadata.author.md | 16 -- docs/js.buildmetadata.branch.md | 13 -- docs/js.buildmetadata.commit_msg.md | 13 -- docs/js.buildmetadata.commit_sha.md | 13 -- docs/js.buildmetadata.commit_url.md | 13 -- docs/js.buildmetadata.md | 25 ---- docs/js.buildmetadata.repo_id.md | 13 -- docs/js.buildmetadata.repo_name.md | 13 -- docs/js.buildmethod.md | 21 --- docs/js.buildstate.md | 21 --- docs/js.bytesizestring.md | 13 -- docs/js.bytestring.md | 17 --- docs/js.byteunit.md | 13 -- docs/js.byteunits.md | 11 -- docs/js.channel.capabilities.md | 13 -- docs/js.channel.created_at.md | 13 -- docs/js.channel.id.md | 13 -- docs/js.channel.md | 23 --- docs/js.channel.project.md | 13 -- docs/js.channel.state.md | 13 -- docs/js.channel.type.md | 13 -- docs/js.channelendpoints.md | 52 ------- docs/js.channels.md | 11 -- docs/js.channeltoken.id.md | 13 -- docs/js.channeltoken.is_online.md | 13 -- docs/js.channeltoken.md | 21 --- docs/js.channeltoken.project_id.md | 13 -- docs/js.channeltoken.state.md | 13 -- docs/js.channeltype.md | 20 --- docs/js.container.created_at.md | 13 -- docs/js.container.deployment_id.md | 13 -- docs/js.container.id.md | 13 -- docs/js.container.internal_ip.md | 13 -- docs/js.container.md | 27 ---- docs/js.container.metadata.md | 15 -- docs/js.container.region.md | 13 -- docs/js.container.state.md | 13 -- docs/js.container.type.md | 13 -- docs/js.container.uptime.md | 15 -- docs/js.container.volume.md | 13 -- docs/js.containerlog.level.md | 13 -- docs/js.containerlog.md | 23 --- docs/js.containerlog.message.md | 13 -- docs/js.containerlog.nonce.md | 13 -- docs/js.containerlog.timestamp.md | 13 -- docs/js.containerstate.md | 25 ---- docs/js.default_base_url.md | 13 -- docs/js.defaultquotas.md | 19 --- docs/js.defaultquotas.ram.md | 11 -- docs/js.defaultquotas.vcpu.md | 11 -- docs/js.deliveryprotocol.md | 11 -- docs/js.deployment.active_build.md | 13 -- docs/js.deployment.active_rollout.md | 13 -- docs/js.deployment.config.md | 13 -- docs/js.deployment.container_count.md | 13 -- docs/js.deployment.created_at.md | 13 -- docs/js.deployment.id.md | 13 -- docs/js.deployment.md | 24 --- docs/js.deployment.name.md | 13 -- docs/js.deploymentconfig.md | 23 --- docs/js.deploymentrollout.md | 20 --- docs/js.domain.created_at.md | 13 -- docs/js.domain.domain.md | 13 -- docs/js.domain.id.md | 13 -- docs/js.domain.md | 21 --- docs/js.domain.state.md | 13 -- docs/js.domainstate.md | 20 --- docs/js.empty.md | 11 -- docs/js.endpoint.md | 18 --- docs/js.endpoints.md | 13 -- docs/js.erroredapiresponse.md | 17 --- docs/js.extractrouteparams.md | 17 --- docs/js.gateway.created_at.md | 13 -- docs/js.gateway.deployment_id.md | 13 -- docs/js.gateway.domains.md | 13 -- docs/js.gateway.hopsh_domain.md | 13 -- docs/js.gateway.id.md | 13 -- docs/js.gateway.internal_domain.md | 13 -- docs/js.gateway.md | 28 ---- docs/js.gateway.name.md | 13 -- docs/js.gateway.target_port.md | 13 -- docs/js.gateway.type.md | 13 -- docs/js.gatewaytype.md | 21 --- docs/js.getidprefix.md | 23 --- docs/js.ghrepo.account_name.md | 11 -- docs/js.ghrepo.default_branch.md | 11 -- docs/js.ghrepo.full_name.md | 11 -- docs/js.ghrepo.id.md | 11 -- docs/js.ghrepo.md | 24 --- docs/js.ghrepo.private.md | 11 -- docs/js.hop._constructor_.md | 20 --- docs/js.hop._constructor__1.md | 21 --- docs/js.hop.channels.md | 53 ------- docs/js.hop.client.md | 11 -- docs/js.hop.ignite.md | 85 ----------- docs/js.hop.md | 41 ------ docs/js.hop.pipe.md | 30 ---- docs/js.hop.projects.md | 33 ----- docs/js.hop.registry.md | 24 --- docs/js.hop.users.md | 25 ---- docs/js.hopapierror._constructor_.md | 22 --- docs/js.hopapierror.data.md | 11 -- docs/js.hopapierror.md | 28 ---- docs/js.hopapierror.request.md | 11 -- docs/js.hopapierror.response.md | 11 -- docs/js.hopapierror.status.md | 11 -- docs/js.hopshdomain.md | 11 -- docs/js.id.md | 13 -- docs/js.id_prefixes.md | 65 -------- docs/js.idprefixes.md | 13 -- docs/js.ignite.md | 11 -- docs/js.igniteendpoints.md | 46 ------ docs/js.image_2.auth.md | 13 -- docs/js.image_2.gh_repo.md | 13 -- docs/js.image_2.md | 22 --- docs/js.image_2.name.md | 13 -- docs/js.imageghrepo.branch.md | 11 -- docs/js.imageghrepo.full_name.md | 11 -- docs/js.imageghrepo.md | 22 --- docs/js.imageghrepo.repo_id.md | 11 -- docs/js.internalhopdomain.md | 11 -- docs/js.is_browser.md | 13 -- docs/js.isvalidbytestring.md | 22 --- docs/js.md | 145 ------------------ docs/js.member.md | 17 --- docs/js.memberrole.flags.md | 13 -- docs/js.memberrole.id.md | 13 -- docs/js.memberrole.md | 20 --- docs/js.memberrole.name.md | 13 -- docs/js.method.md | 11 -- docs/js.parsesize.md | 24 --- docs/js.partialapioptions.md | 13 -- docs/js.pat.created_at.md | 13 -- docs/js.pat.id.md | 13 -- docs/js.pat.md | 20 --- docs/js.pat.name.md | 13 -- docs/js.permissions.md | 15 -- docs/js.permissionsmap.md | 56 ------- docs/js.pipe.md | 11 -- docs/js.pipeendpoints.md | 28 ---- docs/js.project.created_at.md | 13 -- docs/js.project.default_quotas.md | 11 -- docs/js.project.icon.md | 13 -- docs/js.project.id.md | 13 -- docs/js.project.md | 27 ---- docs/js.project.name.md | 13 -- docs/js.project.namespace.md | 13 -- docs/js.project.quota_overrides.md | 11 -- docs/js.project.quota_usage.md | 11 -- docs/js.project.tier.md | 13 -- docs/js.project.type.md | 13 -- docs/js.project_permission.md | 61 -------- docs/js.projects.md | 11 -- docs/js.projectsendpoints.md | 43 ------ docs/js.projecttier.md | 19 --- docs/js.projecttoken.created_at.md | 13 -- docs/js.projecttoken.flags.md | 13 -- docs/js.projecttoken.id.md | 13 -- docs/js.projecttoken.md | 23 --- docs/js.projecttoken.token.md | 13 -- docs/js.projecttype.md | 21 --- docs/js.query.md | 13 -- docs/js.quotaoverrides.md | 11 -- docs/js.quotausage.md | 19 --- docs/js.quotausage.ram.md | 11 -- docs/js.quotausage.vcpu.md | 11 -- docs/js.regions.md | 18 --- docs/js.registry.md | 11 -- docs/js.registryendpoints.md | 24 --- docs/js.resources.md | 22 --- docs/js.resources.ram.md | 13 -- docs/js.resources.vcpu.md | 13 -- docs/js.resources.vgpu.md | 13 -- docs/js.restartpolicy.md | 22 --- docs/js.roles.md | 16 -- docs/js.rolloutstate.md | 22 --- docs/js.room.created_at.md | 13 -- docs/js.room.delivery_protocols.md | 13 -- docs/js.room.id.md | 13 -- docs/js.room.ingest_endpoint.md | 13 -- docs/js.room.ingest_protocol.md | 13 -- docs/js.room.ingest_region.md | 13 -- docs/js.room.join_token.md | 13 -- docs/js.room.md | 26 ---- docs/js.room.name.md | 13 -- docs/js.room.state.md | 13 -- docs/js.runtimetype.md | 22 --- docs/js.secret.created_at.md | 13 -- docs/js.secret.digest.md | 13 -- docs/js.secret.id.md | 13 -- docs/js.secret.md | 21 --- docs/js.secret.name.md | 13 -- docs/js.state.md | 11 -- docs/js.successfulapiresponse.md | 14 -- docs/js.supports_intl.md | 11 -- docs/js.tag.md | 13 -- docs/js.timestamp.md | 15 -- docs/js.units.md | 16 -- docs/js.user.email.md | 13 -- docs/js.user.id.md | 13 -- docs/js.user.md | 23 --- docs/js.user.name.md | 13 -- docs/js.user.username.md | 13 -- docs/js.userendpoints.md | 24 --- docs/js.users.md | 11 -- docs/js.validateapiauthentication.md | 22 --- docs/js.validateid.md | 27 ---- docs/js.validateidprefix.md | 27 ---- docs/js.values.md | 11 -- docs/js.vgpu.count.md | 13 -- docs/js.vgpu.md | 21 --- docs/js.vgpu.type.md | 13 -- docs/js.vgputype.md | 20 --- docs/js.volumedefinition.fs.md | 13 -- docs/js.volumedefinition.md | 20 --- docs/js.volumedefinition.mount_path.md | 13 -- docs/js.volumedefinition.size.md | 13 -- docs/js.volumeformat.md | 19 --- 253 files changed, 4801 deletions(-) delete mode 100644 docs/index.md delete mode 100644 docs/js.anyid.md delete mode 100644 docs/js.api.md delete mode 100644 docs/js.apiauthentication.md delete mode 100644 docs/js.apiauthenticationprefix.md delete mode 100644 docs/js.apiclient._constructor_.md delete mode 100644 docs/js.apiclient.authtype.md delete mode 100644 docs/js.apiclient.delete.md delete mode 100644 docs/js.apiclient.get.md delete mode 100644 docs/js.apiclient.getauthtype.md delete mode 100644 docs/js.apiclient.md delete mode 100644 docs/js.apiclient.patch.md delete mode 100644 docs/js.apiclient.post.md delete mode 100644 docs/js.apiclient.put.md delete mode 100644 docs/js.apiclient.raw.md delete mode 100644 docs/js.apiclient.url.md delete mode 100644 docs/js.apiclientoptions.authentication.md delete mode 100644 docs/js.apiclientoptions.baseurl.md delete mode 100644 docs/js.apiclientoptions.md delete mode 100644 docs/js.apiresponse.md delete mode 100644 docs/js.assertid.md delete mode 100644 docs/js.auth.md delete mode 100644 docs/js.auth.password.md delete mode 100644 docs/js.auth.username.md delete mode 100644 docs/js.broad_permissions_map.md delete mode 100644 docs/js.build.deployment_id.md delete mode 100644 docs/js.build.digest.md delete mode 100644 docs/js.build.finished_at.md delete mode 100644 docs/js.build.id.md delete mode 100644 docs/js.build.md delete mode 100644 docs/js.build.metadata.md delete mode 100644 docs/js.build.method.md delete mode 100644 docs/js.build.started_at.md delete mode 100644 docs/js.build.state.md delete mode 100644 docs/js.buildmetadata.account_type.md delete mode 100644 docs/js.buildmetadata.author.md delete mode 100644 docs/js.buildmetadata.branch.md delete mode 100644 docs/js.buildmetadata.commit_msg.md delete mode 100644 docs/js.buildmetadata.commit_sha.md delete mode 100644 docs/js.buildmetadata.commit_url.md delete mode 100644 docs/js.buildmetadata.md delete mode 100644 docs/js.buildmetadata.repo_id.md delete mode 100644 docs/js.buildmetadata.repo_name.md delete mode 100644 docs/js.buildmethod.md delete mode 100644 docs/js.buildstate.md delete mode 100644 docs/js.bytesizestring.md delete mode 100644 docs/js.bytestring.md delete mode 100644 docs/js.byteunit.md delete mode 100644 docs/js.byteunits.md delete mode 100644 docs/js.channel.capabilities.md delete mode 100644 docs/js.channel.created_at.md delete mode 100644 docs/js.channel.id.md delete mode 100644 docs/js.channel.md delete mode 100644 docs/js.channel.project.md delete mode 100644 docs/js.channel.state.md delete mode 100644 docs/js.channel.type.md delete mode 100644 docs/js.channelendpoints.md delete mode 100644 docs/js.channels.md delete mode 100644 docs/js.channeltoken.id.md delete mode 100644 docs/js.channeltoken.is_online.md delete mode 100644 docs/js.channeltoken.md delete mode 100644 docs/js.channeltoken.project_id.md delete mode 100644 docs/js.channeltoken.state.md delete mode 100644 docs/js.channeltype.md delete mode 100644 docs/js.container.created_at.md delete mode 100644 docs/js.container.deployment_id.md delete mode 100644 docs/js.container.id.md delete mode 100644 docs/js.container.internal_ip.md delete mode 100644 docs/js.container.md delete mode 100644 docs/js.container.metadata.md delete mode 100644 docs/js.container.region.md delete mode 100644 docs/js.container.state.md delete mode 100644 docs/js.container.type.md delete mode 100644 docs/js.container.uptime.md delete mode 100644 docs/js.container.volume.md delete mode 100644 docs/js.containerlog.level.md delete mode 100644 docs/js.containerlog.md delete mode 100644 docs/js.containerlog.message.md delete mode 100644 docs/js.containerlog.nonce.md delete mode 100644 docs/js.containerlog.timestamp.md delete mode 100644 docs/js.containerstate.md delete mode 100644 docs/js.default_base_url.md delete mode 100644 docs/js.defaultquotas.md delete mode 100644 docs/js.defaultquotas.ram.md delete mode 100644 docs/js.defaultquotas.vcpu.md delete mode 100644 docs/js.deliveryprotocol.md delete mode 100644 docs/js.deployment.active_build.md delete mode 100644 docs/js.deployment.active_rollout.md delete mode 100644 docs/js.deployment.config.md delete mode 100644 docs/js.deployment.container_count.md delete mode 100644 docs/js.deployment.created_at.md delete mode 100644 docs/js.deployment.id.md delete mode 100644 docs/js.deployment.md delete mode 100644 docs/js.deployment.name.md delete mode 100644 docs/js.deploymentconfig.md delete mode 100644 docs/js.deploymentrollout.md delete mode 100644 docs/js.domain.created_at.md delete mode 100644 docs/js.domain.domain.md delete mode 100644 docs/js.domain.id.md delete mode 100644 docs/js.domain.md delete mode 100644 docs/js.domain.state.md delete mode 100644 docs/js.domainstate.md delete mode 100644 docs/js.empty.md delete mode 100644 docs/js.endpoint.md delete mode 100644 docs/js.endpoints.md delete mode 100644 docs/js.erroredapiresponse.md delete mode 100644 docs/js.extractrouteparams.md delete mode 100644 docs/js.gateway.created_at.md delete mode 100644 docs/js.gateway.deployment_id.md delete mode 100644 docs/js.gateway.domains.md delete mode 100644 docs/js.gateway.hopsh_domain.md delete mode 100644 docs/js.gateway.id.md delete mode 100644 docs/js.gateway.internal_domain.md delete mode 100644 docs/js.gateway.md delete mode 100644 docs/js.gateway.name.md delete mode 100644 docs/js.gateway.target_port.md delete mode 100644 docs/js.gateway.type.md delete mode 100644 docs/js.gatewaytype.md delete mode 100644 docs/js.getidprefix.md delete mode 100644 docs/js.ghrepo.account_name.md delete mode 100644 docs/js.ghrepo.default_branch.md delete mode 100644 docs/js.ghrepo.full_name.md delete mode 100644 docs/js.ghrepo.id.md delete mode 100644 docs/js.ghrepo.md delete mode 100644 docs/js.ghrepo.private.md delete mode 100644 docs/js.hop._constructor_.md delete mode 100644 docs/js.hop._constructor__1.md delete mode 100644 docs/js.hop.channels.md delete mode 100644 docs/js.hop.client.md delete mode 100644 docs/js.hop.ignite.md delete mode 100644 docs/js.hop.md delete mode 100644 docs/js.hop.pipe.md delete mode 100644 docs/js.hop.projects.md delete mode 100644 docs/js.hop.registry.md delete mode 100644 docs/js.hop.users.md delete mode 100644 docs/js.hopapierror._constructor_.md delete mode 100644 docs/js.hopapierror.data.md delete mode 100644 docs/js.hopapierror.md delete mode 100644 docs/js.hopapierror.request.md delete mode 100644 docs/js.hopapierror.response.md delete mode 100644 docs/js.hopapierror.status.md delete mode 100644 docs/js.hopshdomain.md delete mode 100644 docs/js.id.md delete mode 100644 docs/js.id_prefixes.md delete mode 100644 docs/js.idprefixes.md delete mode 100644 docs/js.ignite.md delete mode 100644 docs/js.igniteendpoints.md delete mode 100644 docs/js.image_2.auth.md delete mode 100644 docs/js.image_2.gh_repo.md delete mode 100644 docs/js.image_2.md delete mode 100644 docs/js.image_2.name.md delete mode 100644 docs/js.imageghrepo.branch.md delete mode 100644 docs/js.imageghrepo.full_name.md delete mode 100644 docs/js.imageghrepo.md delete mode 100644 docs/js.imageghrepo.repo_id.md delete mode 100644 docs/js.internalhopdomain.md delete mode 100644 docs/js.is_browser.md delete mode 100644 docs/js.isvalidbytestring.md delete mode 100644 docs/js.md delete mode 100644 docs/js.member.md delete mode 100644 docs/js.memberrole.flags.md delete mode 100644 docs/js.memberrole.id.md delete mode 100644 docs/js.memberrole.md delete mode 100644 docs/js.memberrole.name.md delete mode 100644 docs/js.method.md delete mode 100644 docs/js.parsesize.md delete mode 100644 docs/js.partialapioptions.md delete mode 100644 docs/js.pat.created_at.md delete mode 100644 docs/js.pat.id.md delete mode 100644 docs/js.pat.md delete mode 100644 docs/js.pat.name.md delete mode 100644 docs/js.permissions.md delete mode 100644 docs/js.permissionsmap.md delete mode 100644 docs/js.pipe.md delete mode 100644 docs/js.pipeendpoints.md delete mode 100644 docs/js.project.created_at.md delete mode 100644 docs/js.project.default_quotas.md delete mode 100644 docs/js.project.icon.md delete mode 100644 docs/js.project.id.md delete mode 100644 docs/js.project.md delete mode 100644 docs/js.project.name.md delete mode 100644 docs/js.project.namespace.md delete mode 100644 docs/js.project.quota_overrides.md delete mode 100644 docs/js.project.quota_usage.md delete mode 100644 docs/js.project.tier.md delete mode 100644 docs/js.project.type.md delete mode 100644 docs/js.project_permission.md delete mode 100644 docs/js.projects.md delete mode 100644 docs/js.projectsendpoints.md delete mode 100644 docs/js.projecttier.md delete mode 100644 docs/js.projecttoken.created_at.md delete mode 100644 docs/js.projecttoken.flags.md delete mode 100644 docs/js.projecttoken.id.md delete mode 100644 docs/js.projecttoken.md delete mode 100644 docs/js.projecttoken.token.md delete mode 100644 docs/js.projecttype.md delete mode 100644 docs/js.query.md delete mode 100644 docs/js.quotaoverrides.md delete mode 100644 docs/js.quotausage.md delete mode 100644 docs/js.quotausage.ram.md delete mode 100644 docs/js.quotausage.vcpu.md delete mode 100644 docs/js.regions.md delete mode 100644 docs/js.registry.md delete mode 100644 docs/js.registryendpoints.md delete mode 100644 docs/js.resources.md delete mode 100644 docs/js.resources.ram.md delete mode 100644 docs/js.resources.vcpu.md delete mode 100644 docs/js.resources.vgpu.md delete mode 100644 docs/js.restartpolicy.md delete mode 100644 docs/js.roles.md delete mode 100644 docs/js.rolloutstate.md delete mode 100644 docs/js.room.created_at.md delete mode 100644 docs/js.room.delivery_protocols.md delete mode 100644 docs/js.room.id.md delete mode 100644 docs/js.room.ingest_endpoint.md delete mode 100644 docs/js.room.ingest_protocol.md delete mode 100644 docs/js.room.ingest_region.md delete mode 100644 docs/js.room.join_token.md delete mode 100644 docs/js.room.md delete mode 100644 docs/js.room.name.md delete mode 100644 docs/js.room.state.md delete mode 100644 docs/js.runtimetype.md delete mode 100644 docs/js.secret.created_at.md delete mode 100644 docs/js.secret.digest.md delete mode 100644 docs/js.secret.id.md delete mode 100644 docs/js.secret.md delete mode 100644 docs/js.secret.name.md delete mode 100644 docs/js.state.md delete mode 100644 docs/js.successfulapiresponse.md delete mode 100644 docs/js.supports_intl.md delete mode 100644 docs/js.tag.md delete mode 100644 docs/js.timestamp.md delete mode 100644 docs/js.units.md delete mode 100644 docs/js.user.email.md delete mode 100644 docs/js.user.id.md delete mode 100644 docs/js.user.md delete mode 100644 docs/js.user.name.md delete mode 100644 docs/js.user.username.md delete mode 100644 docs/js.userendpoints.md delete mode 100644 docs/js.users.md delete mode 100644 docs/js.validateapiauthentication.md delete mode 100644 docs/js.validateid.md delete mode 100644 docs/js.validateidprefix.md delete mode 100644 docs/js.values.md delete mode 100644 docs/js.vgpu.count.md delete mode 100644 docs/js.vgpu.md delete mode 100644 docs/js.vgpu.type.md delete mode 100644 docs/js.vgputype.md delete mode 100644 docs/js.volumedefinition.fs.md delete mode 100644 docs/js.volumedefinition.md delete mode 100644 docs/js.volumedefinition.mount_path.md delete mode 100644 docs/js.volumedefinition.size.md delete mode 100644 docs/js.volumeformat.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 68578b1b..00000000 --- a/docs/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@onehop/js](./js.md) | | - diff --git a/docs/js.anyid.md b/docs/js.anyid.md deleted file mode 100644 index 1a818b72..00000000 --- a/docs/js.anyid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [AnyId](./js.anyid.md) - -## AnyId type - -Signature: - -```typescript -declare type AnyId = Id; -``` -References: [Id](./js.id.md), [IdPrefixes](./js.idprefixes.md) - diff --git a/docs/js.api.md b/docs/js.api.md deleted file mode 100644 index 3416e85f..00000000 --- a/docs/js.api.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [API](./js.api.md) - -## API namespace - -Signature: - -```typescript -declare namespace api -``` diff --git a/docs/js.apiauthentication.md b/docs/js.apiauthentication.md deleted file mode 100644 index d900aec7..00000000 --- a/docs/js.apiauthentication.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthentication](./js.apiauthentication.md) - -## APIAuthentication type - -Signature: - -```typescript -declare type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; -``` -References: [Id](./js.id.md) - diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md deleted file mode 100644 index 4c37a0f7..00000000 --- a/docs/js.apiauthenticationprefix.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) - -## APIAuthenticationPrefix type - -Signature: - -```typescript -declare type APIAuthenticationPrefix = APIAuthentication extends Id ? T : never; -``` -References: [APIAuthentication](./js.apiauthentication.md), [Id](./js.id.md) - diff --git a/docs/js.apiclient._constructor_.md b/docs/js.apiclient._constructor_.md deleted file mode 100644 index 4d08fdcf..00000000 --- a/docs/js.apiclient._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [(constructor)](./js.apiclient._constructor_.md) - -## APIClient.(constructor) - -Constructs a new instance of the `APIClient` class - -Signature: - -```typescript -constructor(options: APIClientOptions); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [APIClientOptions](./js.apiclientoptions.md) | | - diff --git a/docs/js.apiclient.authtype.md b/docs/js.apiclient.authtype.md deleted file mode 100644 index f315c069..00000000 --- a/docs/js.apiclient.authtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [authType](./js.apiclient.authtype.md) - -## APIClient.authType property - -Signature: - -```typescript -readonly authType: "ptk" | "pat" | "bearer"; -``` diff --git a/docs/js.apiclient.delete.md b/docs/js.apiclient.delete.md deleted file mode 100644 index 1c3d9b4a..00000000 --- a/docs/js.apiclient.delete.md +++ /dev/null @@ -1,63 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [delete](./js.apiclient.delete.md) - -## APIClient.delete() method - -Signature: - -```typescript -delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/users/@me/pats/:pat\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/:channel\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/tokens/:token", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/registry/images/:image", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/deployments/:deployment\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/containers/:container\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/pipe/rooms/:room\_id", void, undefined>, { path: Path; method: 'DELETE'; }>)\["res"\]> - diff --git a/docs/js.apiclient.get.md b/docs/js.apiclient.get.md deleted file mode 100644 index abe7d784..00000000 --- a/docs/js.apiclient.get.md +++ /dev/null @@ -1,163 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [get](./js.apiclient.get.md) - -## APIClient.get() method - -Signature: - -```typescript -get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; - leap_token: string | null; - }, undefined>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me", { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me/pats", { pats: [PAT](./js.pat.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members/@me", { project\_member: [Member](./js.member.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/tokens", { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/state", { state: [State](./js.state.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels", { channels: [Channel](./js.channel.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/stats", { stats: { online\_count: number; }; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images", { images: string\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images/:image/manifests", { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments", { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/containers", { containers: [Container](./js.container.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/containers/:container\_id/logs", { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/search", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/gateways/:gateway\_id", { gateway: [Gateway](./js.gateway.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/gateways", { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/pipe/rooms", { rooms: [Room](./js.room.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }>)\["res"\]> - diff --git a/docs/js.apiclient.getauthtype.md b/docs/js.apiclient.getauthtype.md deleted file mode 100644 index 0323dab7..00000000 --- a/docs/js.apiclient.getauthtype.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [getAuthType](./js.apiclient.getauthtype.md) - -## APIClient.getAuthType() method - -Signature: - -```typescript -static getAuthType(auth: APIAuthentication): "ptk" | "pat" | "bearer"; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | [APIAuthentication](./js.apiauthentication.md) | | - -Returns: - -"ptk" \| "pat" \| "bearer" - diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md deleted file mode 100644 index ae2b398d..00000000 --- a/docs/js.apiclient.md +++ /dev/null @@ -1,37 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) - -## APIClient class - -Signature: - -```typescript -declare class APIClient -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./js.apiclient._constructor_.md) | | Constructs a new instance of the APIClient class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [authType](./js.apiclient.authtype.md) | readonly | "ptk" \| "pat" \| "bearer" | | -| [url](./js.apiclient.url.md) | readonly | <Path extends string>(path: Path, query: [Query](./js.query.md)<Path>) => string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [delete(path, body, query, init)](./js.apiclient.delete.md) | | | -| [get(path, query, init)](./js.apiclient.get.md) | | | -| [getAuthType(auth)](./js.apiclient.getauthtype.md) | static | | -| [patch(path, body, query, init)](./js.apiclient.patch.md) | | | -| [post(path, body, query, init)](./js.apiclient.post.md) | | | -| [put(path, body, query, init)](./js.apiclient.put.md) | | | -| [raw(request)](./js.apiclient.raw.md) | | | - diff --git a/docs/js.apiclient.patch.md b/docs/js.apiclient.patch.md deleted file mode 100644 index dc0439ff..00000000 --- a/docs/js.apiclient.patch.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [patch](./js.apiclient.patch.md) - -## APIClient.patch() method - -Signature: - -```typescript -patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); }>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'PATCH'; }>)\["res"\]> - diff --git a/docs/js.apiclient.post.md b/docs/js.apiclient.post.md deleted file mode 100644 index 24f385e0..00000000 --- a/docs/js.apiclient.post.md +++ /dev/null @@ -1,128 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [post](./js.apiclient.post.md) - -## APIClient.post() method - -Signature: - -```typescript -post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract | null; - }>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/users/@me/pats", { pat: [PAT](./js.pat.md); }, { name: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/:project\_id/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/@this/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens", { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens/:token/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/:channel\_id/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers", { container: [Container](./js.container.md); }, undefined>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers/:container\_id", never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/gateways/:gateway\_id/domains", void, { domain: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/gateways", { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: "http" \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/pipe/rooms", { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: "rtmp" \| "rtp"; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }>, { path: Path; method: 'POST'; }>)\["res"\]> - diff --git a/docs/js.apiclient.put.md b/docs/js.apiclient.put.md deleted file mode 100644 index df948bae..00000000 --- a/docs/js.apiclient.put.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [put](./js.apiclient.put.md) - -## APIClient.put() method - -Signature: - -```typescript -put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract | null; - }>, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/:project\_id/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/@this/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/subscribers/:token", void, undefined>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/ignite/containers/:container\_id/state", void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); }>, { path: Path; method: 'PUT'; }>)\["res"\]> - diff --git a/docs/js.apiclient.raw.md b/docs/js.apiclient.raw.md deleted file mode 100644 index 68c10574..00000000 --- a/docs/js.apiclient.raw.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [raw](./js.apiclient.raw.md) - -## APIClient.raw() method - -Signature: - -```typescript -raw(request: Request): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | - -Returns: - -Promise<T> - diff --git a/docs/js.apiclient.url.md b/docs/js.apiclient.url.md deleted file mode 100644 index 72b14f7d..00000000 --- a/docs/js.apiclient.url.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [url](./js.apiclient.url.md) - -## APIClient.url property - -Signature: - -```typescript -readonly url: (path: Path, query: Query) => string; -``` diff --git a/docs/js.apiclientoptions.authentication.md b/docs/js.apiclientoptions.authentication.md deleted file mode 100644 index 07b6a1e5..00000000 --- a/docs/js.apiclientoptions.authentication.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [authentication](./js.apiclientoptions.authentication.md) - -## APIClientOptions.authentication property - -Signature: - -```typescript -readonly authentication: APIAuthentication; -``` diff --git a/docs/js.apiclientoptions.baseurl.md b/docs/js.apiclientoptions.baseurl.md deleted file mode 100644 index 1faa1238..00000000 --- a/docs/js.apiclientoptions.baseurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [baseUrl](./js.apiclientoptions.baseurl.md) - -## APIClientOptions.baseUrl property - -Signature: - -```typescript -readonly baseUrl: string; -``` diff --git a/docs/js.apiclientoptions.md b/docs/js.apiclientoptions.md deleted file mode 100644 index 708447b2..00000000 --- a/docs/js.apiclientoptions.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) - -## APIClientOptions interface - -Signature: - -```typescript -interface APIClientOptions -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [authentication](./js.apiclientoptions.authentication.md) | readonly | [APIAuthentication](./js.apiauthentication.md) | | -| [baseUrl](./js.apiclientoptions.baseurl.md) | readonly | string | | - diff --git a/docs/js.apiresponse.md b/docs/js.apiresponse.md deleted file mode 100644 index 4cb4fbde..00000000 --- a/docs/js.apiresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIResponse](./js.apiresponse.md) - -## APIResponse type - -Signature: - -```typescript -declare type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; -``` -References: [SuccessfulAPIResponse](./js.successfulapiresponse.md), [ErroredAPIResponse](./js.erroredapiresponse.md) - diff --git a/docs/js.assertid.md b/docs/js.assertid.md deleted file mode 100644 index 76685fdb..00000000 --- a/docs/js.assertid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [assertId](./js.assertid.md) - -## assertId() function - -Asserts that a string is a valid ID - -Signature: - -```typescript -declare function assertId(maybeId?: string, prefix?: T | T[], message?: string): asserts maybeId is Id; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| maybeId | string | (Optional) A string that is possibly an ID | -| prefix | T \| T\[\] | (Optional) A prefix or array of prefixes to check against | -| message | string | (Optional) An error message to throw if the ID is invalid | - -Returns: - -asserts maybeId is [Id](./js.id.md)<T> - diff --git a/docs/js.auth.md b/docs/js.auth.md deleted file mode 100644 index b839dd9f..00000000 --- a/docs/js.auth.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) - -## Auth interface - -Docker image registry authorization - -Signature: - -```typescript -interface Auth -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [password](./js.auth.password.md) | | string | | -| [username](./js.auth.username.md) | | string | | - diff --git a/docs/js.auth.password.md b/docs/js.auth.password.md deleted file mode 100644 index 3856a18d..00000000 --- a/docs/js.auth.password.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [password](./js.auth.password.md) - -## Auth.password property - -Signature: - -```typescript -password: string; -``` diff --git a/docs/js.auth.username.md b/docs/js.auth.username.md deleted file mode 100644 index f837a54e..00000000 --- a/docs/js.auth.username.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [username](./js.auth.username.md) - -## Auth.username property - -Signature: - -```typescript -username: string; -``` diff --git a/docs/js.broad_permissions_map.md b/docs/js.broad_permissions_map.md deleted file mode 100644 index 14eadb3d..00000000 --- a/docs/js.broad_permissions_map.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) - -## BROAD\_PERMISSIONS\_MAP variable - -Signature: - -```typescript -BROAD_PERMISSIONS_MAP: { - MANAGE_MEMBERS: bigint; - MANAGE_PROJECT_TOKENS: bigint; - MANAGE_DEPLOYMENTS: bigint; - MANAGE_PIPE: bigint; - MANAGE_SECRETS: bigint; - MANAGE_CHANNELS: bigint; - MANAGE_REGISTRY: bigint; - READ_ONLY: bigint; - MANAGE_QUOTAS: bigint; - MANAGE_ROLLOUTS: bigint; - MANAGE_BILLING: bigint; -} -``` diff --git a/docs/js.build.deployment_id.md b/docs/js.build.deployment_id.md deleted file mode 100644 index 05320027..00000000 --- a/docs/js.build.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [deployment\_id](./js.build.deployment_id.md) - -## Build.deployment\_id property - -Deployment ID for build - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.build.digest.md b/docs/js.build.digest.md deleted file mode 100644 index 265b829b..00000000 --- a/docs/js.build.digest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [digest](./js.build.digest.md) - -## Build.digest property - -Digest for image - -Signature: - -```typescript -digest: string | null; -``` diff --git a/docs/js.build.finished_at.md b/docs/js.build.finished_at.md deleted file mode 100644 index 264bcbc3..00000000 --- a/docs/js.build.finished_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [finished\_at](./js.build.finished_at.md) - -## Build.finished\_at property - -Timestamp of when the build has finished - -Signature: - -```typescript -finished_at: Timestamp | null; -``` diff --git a/docs/js.build.id.md b/docs/js.build.id.md deleted file mode 100644 index ce741698..00000000 --- a/docs/js.build.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [id](./js.build.id.md) - -## Build.id property - -ID of the build - -Signature: - -```typescript -id: Id<'build'>; -``` diff --git a/docs/js.build.md b/docs/js.build.md deleted file mode 100644 index 96489fe6..00000000 --- a/docs/js.build.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) - -## Build interface - -Signature: - -```typescript -interface Build -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [deployment\_id](./js.build.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | Deployment ID for build | -| [digest](./js.build.digest.md) | | string \| null | Digest for image | -| [finished\_at](./js.build.finished_at.md) | | [Timestamp](./js.timestamp.md) \| null | Timestamp of when the build has finished | -| [id](./js.build.id.md) | | [Id](./js.id.md)<'build'> | ID of the build | -| [metadata](./js.build.metadata.md) | | [BuildMetaData](./js.buildmetadata.md) \| null | Metadata pertaining to build (mostly for GitHub) | -| [method](./js.build.method.md) | | [BuildMethod](./js.buildmethod.md) | Build method (GitHub or CLI) | -| [started\_at](./js.build.started_at.md) | | [Timestamp](./js.timestamp.md) | Timestamp of when the build has started | -| [state](./js.build.state.md) | | [BuildState](./js.buildstate.md) | State of the build | - diff --git a/docs/js.build.metadata.md b/docs/js.build.metadata.md deleted file mode 100644 index c41c702c..00000000 --- a/docs/js.build.metadata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [metadata](./js.build.metadata.md) - -## Build.metadata property - -Metadata pertaining to build (mostly for GitHub) - -Signature: - -```typescript -metadata: BuildMetaData | null; -``` diff --git a/docs/js.build.method.md b/docs/js.build.method.md deleted file mode 100644 index 549e9cf5..00000000 --- a/docs/js.build.method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [method](./js.build.method.md) - -## Build.method property - -Build method (GitHub or CLI) - -Signature: - -```typescript -method: BuildMethod; -``` diff --git a/docs/js.build.started_at.md b/docs/js.build.started_at.md deleted file mode 100644 index 3d633757..00000000 --- a/docs/js.build.started_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [started\_at](./js.build.started_at.md) - -## Build.started\_at property - -Timestamp of when the build has started - -Signature: - -```typescript -started_at: Timestamp; -``` diff --git a/docs/js.build.state.md b/docs/js.build.state.md deleted file mode 100644 index 93ed8148..00000000 --- a/docs/js.build.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [state](./js.build.state.md) - -## Build.state property - -State of the build - -Signature: - -```typescript -state: BuildState; -``` diff --git a/docs/js.buildmetadata.account_type.md b/docs/js.buildmetadata.account_type.md deleted file mode 100644 index a54d88f1..00000000 --- a/docs/js.buildmetadata.account_type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [account\_type](./js.buildmetadata.account_type.md) - -## BuildMetaData.account\_type property - -Account type of repo owner - -Signature: - -```typescript -account_type?: 'user' | 'organization'; -``` diff --git a/docs/js.buildmetadata.author.md b/docs/js.buildmetadata.author.md deleted file mode 100644 index 0ef445f1..00000000 --- a/docs/js.buildmetadata.author.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [author](./js.buildmetadata.author.md) - -## BuildMetaData.author property - -Author information about build - -Signature: - -```typescript -author?: { - avatar_url: string; - username: string; - }; -``` diff --git a/docs/js.buildmetadata.branch.md b/docs/js.buildmetadata.branch.md deleted file mode 100644 index 894d86c8..00000000 --- a/docs/js.buildmetadata.branch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [branch](./js.buildmetadata.branch.md) - -## BuildMetaData.branch property - -Repo branch for build - -Signature: - -```typescript -branch: string; -``` diff --git a/docs/js.buildmetadata.commit_msg.md b/docs/js.buildmetadata.commit_msg.md deleted file mode 100644 index 82e95cdd..00000000 --- a/docs/js.buildmetadata.commit_msg.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_msg](./js.buildmetadata.commit_msg.md) - -## BuildMetaData.commit\_msg property - -commit message for build - -Signature: - -```typescript -commit_msg: string; -``` diff --git a/docs/js.buildmetadata.commit_sha.md b/docs/js.buildmetadata.commit_sha.md deleted file mode 100644 index b4d5896d..00000000 --- a/docs/js.buildmetadata.commit_sha.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_sha](./js.buildmetadata.commit_sha.md) - -## BuildMetaData.commit\_sha property - -commit SHA for build - -Signature: - -```typescript -commit_sha: string; -``` diff --git a/docs/js.buildmetadata.commit_url.md b/docs/js.buildmetadata.commit_url.md deleted file mode 100644 index fcbbe4fc..00000000 --- a/docs/js.buildmetadata.commit_url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_url](./js.buildmetadata.commit_url.md) - -## BuildMetaData.commit\_url property - -commit URL for build - -Signature: - -```typescript -commit_url?: string; -``` diff --git a/docs/js.buildmetadata.md b/docs/js.buildmetadata.md deleted file mode 100644 index 5dd3c2f5..00000000 --- a/docs/js.buildmetadata.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) - -## BuildMetaData interface - -Signature: - -```typescript -interface BuildMetaData -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [account\_type?](./js.buildmetadata.account_type.md) | | 'user' \| 'organization' | (Optional) Account type of repo owner | -| [author?](./js.buildmetadata.author.md) | | { avatar\_url: string; username: string; } | (Optional) Author information about build | -| [branch](./js.buildmetadata.branch.md) | | string | Repo branch for build | -| [commit\_msg](./js.buildmetadata.commit_msg.md) | | string | commit message for build | -| [commit\_sha](./js.buildmetadata.commit_sha.md) | | string | commit SHA for build | -| [commit\_url?](./js.buildmetadata.commit_url.md) | | string | (Optional) commit URL for build | -| [repo\_id](./js.buildmetadata.repo_id.md) | | number | Repo ID for build | -| [repo\_name](./js.buildmetadata.repo_name.md) | | string | Repo name for build | - diff --git a/docs/js.buildmetadata.repo_id.md b/docs/js.buildmetadata.repo_id.md deleted file mode 100644 index d75d34e8..00000000 --- a/docs/js.buildmetadata.repo_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_id](./js.buildmetadata.repo_id.md) - -## BuildMetaData.repo\_id property - -Repo ID for build - -Signature: - -```typescript -repo_id: number; -``` diff --git a/docs/js.buildmetadata.repo_name.md b/docs/js.buildmetadata.repo_name.md deleted file mode 100644 index 975f39cd..00000000 --- a/docs/js.buildmetadata.repo_name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_name](./js.buildmetadata.repo_name.md) - -## BuildMetaData.repo\_name property - -Repo name for build - -Signature: - -```typescript -repo_name: string; -``` diff --git a/docs/js.buildmethod.md b/docs/js.buildmethod.md deleted file mode 100644 index c7523589..00000000 --- a/docs/js.buildmethod.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMethod](./js.buildmethod.md) - -## BuildMethod enum - -Types of build methods supported by Hop - -Signature: - -```typescript -declare enum BuildMethod -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| CLI | "cli" | | -| GITHUB | "github" | | - diff --git a/docs/js.buildstate.md b/docs/js.buildstate.md deleted file mode 100644 index 709f397f..00000000 --- a/docs/js.buildstate.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildState](./js.buildstate.md) - -## BuildState enum - -Signature: - -```typescript -declare enum BuildState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| CANCELLED | "cancelled" | | -| FAILED | "failed" | | -| PENDING | "pending" | | -| SUCCEEDED | "succeeded" | | - diff --git a/docs/js.bytesizestring.md b/docs/js.bytesizestring.md deleted file mode 100644 index 1242e0aa..00000000 --- a/docs/js.bytesizestring.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteSizeString](./js.bytesizestring.md) - -## ByteSizeString type - -Signature: - -```typescript -declare type ByteSizeString = `${number}${ByteUnit}`; -``` -References: [ByteUnit](./js.byteunit.md) - diff --git a/docs/js.bytestring.md b/docs/js.bytestring.md deleted file mode 100644 index 58797fc6..00000000 --- a/docs/js.bytestring.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteString](./js.bytestring.md) - -## ByteString type - -> Warning: This API is now obsolete. -> -> - -Signature: - -```typescript -declare type ByteString = ByteSizeString; -``` -References: [ByteSizeString](./js.bytesizestring.md) - diff --git a/docs/js.byteunit.md b/docs/js.byteunit.md deleted file mode 100644 index 12ed8a07..00000000 --- a/docs/js.byteunit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteUnit](./js.byteunit.md) - -## ByteUnit type - -Signature: - -```typescript -declare type ByteUnit = typeof byteUnits[number] | Uppercase; -``` -References: [byteUnits](./js.byteunits.md) - diff --git a/docs/js.byteunits.md b/docs/js.byteunits.md deleted file mode 100644 index d4228c14..00000000 --- a/docs/js.byteunits.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [byteUnits](./js.byteunits.md) - -## byteUnits variable - -Signature: - -```typescript -byteUnits: readonly ["GB", "MB", "KB", "B"] -``` diff --git a/docs/js.channel.capabilities.md b/docs/js.channel.capabilities.md deleted file mode 100644 index b3ea3beb..00000000 --- a/docs/js.channel.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [capabilities](./js.channel.capabilities.md) - -## Channel.capabilities property - -Capabilities of the channel - -Signature: - -```typescript -capabilities: number; -``` diff --git a/docs/js.channel.created_at.md b/docs/js.channel.created_at.md deleted file mode 100644 index 79b26d9b..00000000 --- a/docs/js.channel.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [created\_at](./js.channel.created_at.md) - -## Channel.created\_at property - -When this channel was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.channel.id.md b/docs/js.channel.id.md deleted file mode 100644 index e5171cc3..00000000 --- a/docs/js.channel.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [id](./js.channel.id.md) - -## Channel.id property - -The ID of the channel - -Signature: - -```typescript -id: string; -``` diff --git a/docs/js.channel.md b/docs/js.channel.md deleted file mode 100644 index 5c6b2553..00000000 --- a/docs/js.channel.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) - -## Channel interface - -Signature: - -```typescript -interface Channel -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [capabilities](./js.channel.capabilities.md) | | number | Capabilities of the channel | -| [created\_at](./js.channel.created_at.md) | | [Timestamp](./js.timestamp.md) | When this channel was created | -| [id](./js.channel.id.md) | | string | The ID of the channel | -| [project](./js.channel.project.md) | | [Project](./js.project.md) | The project it is associated with | -| [state](./js.channel.state.md) | | [State](./js.state.md) | State metadata | -| [type](./js.channel.type.md) | | [ChannelType](./js.channeltype.md) | The type of this channel | - diff --git a/docs/js.channel.project.md b/docs/js.channel.project.md deleted file mode 100644 index 24a252b1..00000000 --- a/docs/js.channel.project.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [project](./js.channel.project.md) - -## Channel.project property - -The project it is associated with - -Signature: - -```typescript -project: Project; -``` diff --git a/docs/js.channel.state.md b/docs/js.channel.state.md deleted file mode 100644 index 82c4daa1..00000000 --- a/docs/js.channel.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [state](./js.channel.state.md) - -## Channel.state property - -State metadata - -Signature: - -```typescript -state: State; -``` diff --git a/docs/js.channel.type.md b/docs/js.channel.type.md deleted file mode 100644 index 10abf46b..00000000 --- a/docs/js.channel.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [type](./js.channel.type.md) - -## Channel.type property - -The type of this channel - -Signature: - -```typescript -type: ChannelType; -``` diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md deleted file mode 100644 index a8b9f4b7..00000000 --- a/docs/js.channelendpoints.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelEndpoints](./js.channelendpoints.md) - -## ChannelEndpoints type - -Signature: - -```typescript -declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'PUT', '/v1/channels/:channel_id', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'POST', '/v1/channels/tokens', { - token: ChannelToken; -}, { - state: State; -}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { - channel: Channel; -}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { - tokens: ChannelToken[]; -}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { - state: State; -}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'GET', '/v1/channels', { - channels: Channel[]; -}> | Endpoint<'GET', '/v1/channels/tokens/:token', { - token: ChannelToken; -}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { - token: ChannelToken; -}, { - expiresAt?: Timestamp | null; - state: ChannelToken['state']; -}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { - stats: { - online_count: number; - }; -}>; -``` -References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) - diff --git a/docs/js.channels.md b/docs/js.channels.md deleted file mode 100644 index f2cb6af5..00000000 --- a/docs/js.channels.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channels](./js.channels.md) - -## Channels namespace - -Signature: - -```typescript -declare namespace channels -``` diff --git a/docs/js.channeltoken.id.md b/docs/js.channeltoken.id.md deleted file mode 100644 index 0ea11a85..00000000 --- a/docs/js.channeltoken.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [id](./js.channeltoken.id.md) - -## ChannelToken.id property - -The ID for the token - -Signature: - -```typescript -id: Id<'leap_token'>; -``` diff --git a/docs/js.channeltoken.is_online.md b/docs/js.channeltoken.is_online.md deleted file mode 100644 index 0a64c0ae..00000000 --- a/docs/js.channeltoken.is_online.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [is\_online](./js.channeltoken.is_online.md) - -## ChannelToken.is\_online property - -If this token is currently online (e.g. active heartbeat and connected to leap) - -Signature: - -```typescript -is_online: boolean; -``` diff --git a/docs/js.channeltoken.md b/docs/js.channeltoken.md deleted file mode 100644 index e22b6fc8..00000000 --- a/docs/js.channeltoken.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) - -## ChannelToken interface - -Signature: - -```typescript -interface ChannelToken -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./js.channeltoken.id.md) | | [Id](./js.id.md)<'leap\_token'> | The ID for the token | -| [is\_online](./js.channeltoken.is_online.md) | | boolean | If this token is currently online (e.g. active heartbeat and connected to leap) | -| [project\_id](./js.channeltoken.project_id.md) | | [Id](./js.id.md)<'project'> | The project this channel token is associated with | -| [state](./js.channeltoken.state.md) | | [State](./js.state.md) | State for this token | - diff --git a/docs/js.channeltoken.project_id.md b/docs/js.channeltoken.project_id.md deleted file mode 100644 index 07a80b63..00000000 --- a/docs/js.channeltoken.project_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [project\_id](./js.channeltoken.project_id.md) - -## ChannelToken.project\_id property - -The project this channel token is associated with - -Signature: - -```typescript -project_id: Id<'project'>; -``` diff --git a/docs/js.channeltoken.state.md b/docs/js.channeltoken.state.md deleted file mode 100644 index 4dfab383..00000000 --- a/docs/js.channeltoken.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [state](./js.channeltoken.state.md) - -## ChannelToken.state property - -State for this token - -Signature: - -```typescript -state: State; -``` diff --git a/docs/js.channeltype.md b/docs/js.channeltype.md deleted file mode 100644 index f1fa66df..00000000 --- a/docs/js.channeltype.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelType](./js.channeltype.md) - -## ChannelType enum - -Signature: - -```typescript -declare enum ChannelType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PRIVATE | "private" | | -| PUBLIC | "public" | | -| UNPROTECTED | "unprotected" | | - diff --git a/docs/js.container.created_at.md b/docs/js.container.created_at.md deleted file mode 100644 index ea0fb999..00000000 --- a/docs/js.container.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [created\_at](./js.container.created_at.md) - -## Container.created\_at property - -The time this container was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.container.deployment_id.md b/docs/js.container.deployment_id.md deleted file mode 100644 index b3484036..00000000 --- a/docs/js.container.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [deployment\_id](./js.container.deployment_id.md) - -## Container.deployment\_id property - -The ID of the deployment this container is associated with - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.container.id.md b/docs/js.container.id.md deleted file mode 100644 index 9bc7359f..00000000 --- a/docs/js.container.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [id](./js.container.id.md) - -## Container.id property - -The ID of the container - -Signature: - -```typescript -id: Id<'container'>; -``` diff --git a/docs/js.container.internal_ip.md b/docs/js.container.internal_ip.md deleted file mode 100644 index a41a7c6f..00000000 --- a/docs/js.container.internal_ip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [internal\_ip](./js.container.internal_ip.md) - -## Container.internal\_ip property - -The internal IP of the container - -Signature: - -```typescript -internal_ip: string; -``` diff --git a/docs/js.container.md b/docs/js.container.md deleted file mode 100644 index a06f1f56..00000000 --- a/docs/js.container.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) - -## Container interface - -Signature: - -```typescript -interface Container -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.container.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this container was created | -| [deployment\_id](./js.container.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment this container is associated with | -| [id](./js.container.id.md) | | [Id](./js.id.md)<'container'> | The ID of the container | -| [internal\_ip](./js.container.internal_ip.md) | | string | The internal IP of the container | -| [metadata](./js.container.metadata.md) | | { last\_exit\_code?: number; } | Information about the container | -| [region](./js.container.region.md) | | [Regions](./js.regions.md) | The region this container runs in | -| [state](./js.container.state.md) | | [ContainerState](./js.containerstate.md) | The state this container is in | -| [type](./js.container.type.md) | | [RuntimeType](./js.runtimetype.md) | The type of this container | -| [uptime](./js.container.uptime.md) | | { last\_start: [Timestamp](./js.timestamp.md); } | Information about uptime/downtime for this container | -| [volume](./js.container.volume.md) | | [VolumeDefinition](./js.volumedefinition.md) \| null | The volume definition for this container | - diff --git a/docs/js.container.metadata.md b/docs/js.container.metadata.md deleted file mode 100644 index b8ef4353..00000000 --- a/docs/js.container.metadata.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [metadata](./js.container.metadata.md) - -## Container.metadata property - -Information about the container - -Signature: - -```typescript -metadata: { - last_exit_code?: number; - }; -``` diff --git a/docs/js.container.region.md b/docs/js.container.region.md deleted file mode 100644 index 1e6dacc8..00000000 --- a/docs/js.container.region.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [region](./js.container.region.md) - -## Container.region property - -The region this container runs in - -Signature: - -```typescript -region: Regions; -``` diff --git a/docs/js.container.state.md b/docs/js.container.state.md deleted file mode 100644 index be7ce2ec..00000000 --- a/docs/js.container.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [state](./js.container.state.md) - -## Container.state property - -The state this container is in - -Signature: - -```typescript -state: ContainerState; -``` diff --git a/docs/js.container.type.md b/docs/js.container.type.md deleted file mode 100644 index aa89d51b..00000000 --- a/docs/js.container.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [type](./js.container.type.md) - -## Container.type property - -The type of this container - -Signature: - -```typescript -type: RuntimeType; -``` diff --git a/docs/js.container.uptime.md b/docs/js.container.uptime.md deleted file mode 100644 index b801f1a4..00000000 --- a/docs/js.container.uptime.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [uptime](./js.container.uptime.md) - -## Container.uptime property - -Information about uptime/downtime for this container - -Signature: - -```typescript -uptime: { - last_start: Timestamp; - }; -``` diff --git a/docs/js.container.volume.md b/docs/js.container.volume.md deleted file mode 100644 index e1aa34a5..00000000 --- a/docs/js.container.volume.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [volume](./js.container.volume.md) - -## Container.volume property - -The volume definition for this container - -Signature: - -```typescript -volume: VolumeDefinition | null; -``` diff --git a/docs/js.containerlog.level.md b/docs/js.containerlog.level.md deleted file mode 100644 index 10fdce77..00000000 --- a/docs/js.containerlog.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [level](./js.containerlog.level.md) - -## ContainerLog.level property - -The level of the log. stdout becomes `info` - -Signature: - -```typescript -level: 'info' | 'error'; -``` diff --git a/docs/js.containerlog.md b/docs/js.containerlog.md deleted file mode 100644 index 16e7237c..00000000 --- a/docs/js.containerlog.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) - -## ContainerLog interface - -Logs from a container - -Signature: - -```typescript -interface ContainerLog -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [level](./js.containerlog.level.md) | | 'info' \| 'error' | The level of the log. stdout becomes info | -| [message](./js.containerlog.message.md) | | string | The log message | -| [nonce](./js.containerlog.nonce.md) | | string | The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. | -| [timestamp](./js.containerlog.timestamp.md) | | [Timestamp](./js.timestamp.md) | The timestamp of the log | - diff --git a/docs/js.containerlog.message.md b/docs/js.containerlog.message.md deleted file mode 100644 index b3334c65..00000000 --- a/docs/js.containerlog.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [message](./js.containerlog.message.md) - -## ContainerLog.message property - -The log message - -Signature: - -```typescript -message: string; -``` diff --git a/docs/js.containerlog.nonce.md b/docs/js.containerlog.nonce.md deleted file mode 100644 index ea3b06a4..00000000 --- a/docs/js.containerlog.nonce.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [nonce](./js.containerlog.nonce.md) - -## ContainerLog.nonce property - -The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. - -Signature: - -```typescript -nonce: string; -``` diff --git a/docs/js.containerlog.timestamp.md b/docs/js.containerlog.timestamp.md deleted file mode 100644 index d415f14e..00000000 --- a/docs/js.containerlog.timestamp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [timestamp](./js.containerlog.timestamp.md) - -## ContainerLog.timestamp property - -The timestamp of the log - -Signature: - -```typescript -timestamp: Timestamp; -``` diff --git a/docs/js.containerstate.md b/docs/js.containerstate.md deleted file mode 100644 index b916dd94..00000000 --- a/docs/js.containerstate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerState](./js.containerstate.md) - -## ContainerState enum - -Container state is relatively self-explanatory. It describes what the container is currently doing. - -Signature: - -```typescript -declare enum ContainerState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXITED | "exited" | The container exited (e.g. with a zero exit code) | -| FAILED | "failed" | The container's entrypoint failed (e.g. exited with a non-zero exit code) | -| PENDING | "pending" | The container is pending creation | -| RUNNING | "running" | The container is running | -| STOPPED | "stopped" | The container is stopped | -| TERMINATING | "terminating" | The container is being deleted | - diff --git a/docs/js.default_base_url.md b/docs/js.default_base_url.md deleted file mode 100644 index d364d83a..00000000 --- a/docs/js.default_base_url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DEFAULT\_BASE\_URL](./js.default_base_url.md) - -## DEFAULT\_BASE\_URL variable - -The default base URL for Hop's API. - -Signature: - -```typescript -DEFAULT_BASE_URL = "https://api.hop.io" -``` diff --git a/docs/js.defaultquotas.md b/docs/js.defaultquotas.md deleted file mode 100644 index 7c88bdd0..00000000 --- a/docs/js.defaultquotas.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) - -## DefaultQuotas interface - -Signature: - -```typescript -interface DefaultQuotas -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.defaultquotas.ram.md) | | number | | -| [vcpu](./js.defaultquotas.vcpu.md) | | number | | - diff --git a/docs/js.defaultquotas.ram.md b/docs/js.defaultquotas.ram.md deleted file mode 100644 index 0b1bc129..00000000 --- a/docs/js.defaultquotas.ram.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [ram](./js.defaultquotas.ram.md) - -## DefaultQuotas.ram property - -Signature: - -```typescript -ram: number; -``` diff --git a/docs/js.defaultquotas.vcpu.md b/docs/js.defaultquotas.vcpu.md deleted file mode 100644 index 7386459d..00000000 --- a/docs/js.defaultquotas.vcpu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [vcpu](./js.defaultquotas.vcpu.md) - -## DefaultQuotas.vcpu property - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.deliveryprotocol.md b/docs/js.deliveryprotocol.md deleted file mode 100644 index d96e760d..00000000 --- a/docs/js.deliveryprotocol.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeliveryProtocol](./js.deliveryprotocol.md) - -## DeliveryProtocol type - -Signature: - -```typescript -declare type DeliveryProtocol = 'webrtc' | 'hls'; -``` diff --git a/docs/js.deployment.active_build.md b/docs/js.deployment.active_build.md deleted file mode 100644 index 13170351..00000000 --- a/docs/js.deployment.active_build.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_build](./js.deployment.active_build.md) - -## Deployment.active\_build property - -Current active build for deployment - -Signature: - -```typescript -active_build: Build | null; -``` diff --git a/docs/js.deployment.active_rollout.md b/docs/js.deployment.active_rollout.md deleted file mode 100644 index 8cb6418b..00000000 --- a/docs/js.deployment.active_rollout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_rollout](./js.deployment.active_rollout.md) - -## Deployment.active\_rollout property - -Current active rollout for deployment - -Signature: - -```typescript -active_rollout: DeploymentRollout | null; -``` diff --git a/docs/js.deployment.config.md b/docs/js.deployment.config.md deleted file mode 100644 index 7526bfe8..00000000 --- a/docs/js.deployment.config.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [config](./js.deployment.config.md) - -## Deployment.config property - -The config for this deployment - -Signature: - -```typescript -config: Omit; -``` diff --git a/docs/js.deployment.container_count.md b/docs/js.deployment.container_count.md deleted file mode 100644 index b626b1a7..00000000 --- a/docs/js.deployment.container_count.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [container\_count](./js.deployment.container_count.md) - -## Deployment.container\_count property - -The amount of containers this deployment is currently running - -Signature: - -```typescript -container_count: number; -``` diff --git a/docs/js.deployment.created_at.md b/docs/js.deployment.created_at.md deleted file mode 100644 index fdd0df48..00000000 --- a/docs/js.deployment.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [created\_at](./js.deployment.created_at.md) - -## Deployment.created\_at property - -The time this deployment was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.deployment.id.md b/docs/js.deployment.id.md deleted file mode 100644 index 5ff910b0..00000000 --- a/docs/js.deployment.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [id](./js.deployment.id.md) - -## Deployment.id property - -The ID of the deployment - -Signature: - -```typescript -id: Id<'deployment'>; -``` diff --git a/docs/js.deployment.md b/docs/js.deployment.md deleted file mode 100644 index ac2ded0e..00000000 --- a/docs/js.deployment.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) - -## Deployment interface - -Signature: - -```typescript -interface Deployment -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [active\_build](./js.deployment.active_build.md) | | [Build](./js.build.md) \| null | Current active build for deployment | -| [active\_rollout](./js.deployment.active_rollout.md) | | [DeploymentRollout](./js.deploymentrollout.md) \| null | Current active rollout for deployment | -| [config](./js.deployment.config.md) | | Omit<[DeploymentConfig](./js.deploymentconfig.md), 'volume' \| 'name'> | The config for this deployment | -| [container\_count](./js.deployment.container_count.md) | | number | The amount of containers this deployment is currently running | -| [created\_at](./js.deployment.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this deployment was created at | -| [id](./js.deployment.id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment | -| [name](./js.deployment.name.md) | | string | The name of the deployment | - diff --git a/docs/js.deployment.name.md b/docs/js.deployment.name.md deleted file mode 100644 index f13f40ae..00000000 --- a/docs/js.deployment.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [name](./js.deployment.name.md) - -## Deployment.name property - -The name of the deployment - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.deploymentconfig.md b/docs/js.deploymentconfig.md deleted file mode 100644 index 6e173bbf..00000000 --- a/docs/js.deploymentconfig.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentConfig](./js.deploymentconfig.md) - -## DeploymentConfig type - -Signature: - -```typescript -declare type DeploymentConfig = { - name: string; - container_strategy: 'manual'; - type: RuntimeType; - version: '2022-05-17'; - image: Image; - env: Record; - resources: Resources; - restart_policy: RestartPolicy; - volume?: VolumeDefinition; -}; -``` -References: [RuntimeType](./js.runtimetype.md), [Image](./js.image_2.md), [Resources](./js.resources.md), [RestartPolicy](./js.restartpolicy.md), [VolumeDefinition](./js.volumedefinition.md) - diff --git a/docs/js.deploymentrollout.md b/docs/js.deploymentrollout.md deleted file mode 100644 index 3bfdcc40..00000000 --- a/docs/js.deploymentrollout.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentRollout](./js.deploymentrollout.md) - -## DeploymentRollout type - -Signature: - -```typescript -declare type DeploymentRollout = { - count: number; - created_at: Timestamp; - deployment_id: Id<'deployment'>; - id: Id<'rollout'>; - state: RolloutState; - build: Build | null; -}; -``` -References: [Timestamp](./js.timestamp.md), [Id](./js.id.md), [RolloutState](./js.rolloutstate.md), [Build](./js.build.md) - diff --git a/docs/js.domain.created_at.md b/docs/js.domain.created_at.md deleted file mode 100644 index c16c478c..00000000 --- a/docs/js.domain.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [created\_at](./js.domain.created_at.md) - -## Domain.created\_at property - -The date this domain was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.domain.domain.md b/docs/js.domain.domain.md deleted file mode 100644 index 429325c1..00000000 --- a/docs/js.domain.domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [domain](./js.domain.domain.md) - -## Domain.domain property - -The domain name - -Signature: - -```typescript -domain: string; -``` diff --git a/docs/js.domain.id.md b/docs/js.domain.id.md deleted file mode 100644 index 659db5cc..00000000 --- a/docs/js.domain.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [id](./js.domain.id.md) - -## Domain.id property - -The ID of the domain - -Signature: - -```typescript -id: Id<'domain'>; -``` diff --git a/docs/js.domain.md b/docs/js.domain.md deleted file mode 100644 index 9668e178..00000000 --- a/docs/js.domain.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) - -## Domain interface - -Signature: - -```typescript -interface Domain -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.domain.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this domain was created | -| [domain](./js.domain.domain.md) | | string | The domain name | -| [id](./js.domain.id.md) | | [Id](./js.id.md)<'domain'> | The ID of the domain | -| [state](./js.domain.state.md) | | [DomainState](./js.domainstate.md) | The domain state | - diff --git a/docs/js.domain.state.md b/docs/js.domain.state.md deleted file mode 100644 index 9f613f54..00000000 --- a/docs/js.domain.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [state](./js.domain.state.md) - -## Domain.state property - -The domain state - -Signature: - -```typescript -state: DomainState; -``` diff --git a/docs/js.domainstate.md b/docs/js.domainstate.md deleted file mode 100644 index df9bf6f1..00000000 --- a/docs/js.domainstate.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DomainState](./js.domainstate.md) - -## DomainState enum - -Signature: - -```typescript -declare enum DomainState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PENDING | "pending" | | -| SSL\_ACTIVE | "ssl_active" | | -| VALID\_CNAME | "valid_cname" | | - diff --git a/docs/js.empty.md b/docs/js.empty.md deleted file mode 100644 index 534185e2..00000000 --- a/docs/js.empty.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) - -## Empty type - -Signature: - -```typescript -declare type Empty = void; -``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md deleted file mode 100644 index 1e66a431..00000000 --- a/docs/js.endpoint.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Endpoint](./js.endpoint.md) - -## Endpoint type - -Signature: - -```typescript -declare type Endpoint = { - method: M; - path: Path; - res: Res; - body: Body; -}; -``` -References: [Method](./js.method.md) - diff --git a/docs/js.endpoints.md b/docs/js.endpoints.md deleted file mode 100644 index 278f448b..00000000 --- a/docs/js.endpoints.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Endpoints](./js.endpoints.md) - -## Endpoints type - -Signature: - -```typescript -declare type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; -``` -References: [IgniteEndpoints](./js.igniteendpoints.md), [RegistryEndpoints](./js.registryendpoints.md), [UserEndpoints](./js.userendpoints.md), [ProjectsEndpoints](./js.projectsendpoints.md), [PipeEndpoints](./js.pipeendpoints.md), [ChannelEndpoints](./js.channelendpoints.md) - diff --git a/docs/js.erroredapiresponse.md b/docs/js.erroredapiresponse.md deleted file mode 100644 index 35a4aadc..00000000 --- a/docs/js.erroredapiresponse.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ErroredAPIResponse](./js.erroredapiresponse.md) - -## ErroredAPIResponse type - -Signature: - -```typescript -declare type ErroredAPIResponse = { - success: false; - error: { - code: string; - message: string; - }; -}; -``` diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md deleted file mode 100644 index eb6d9b5a..00000000 --- a/docs/js.extractrouteparams.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) - -## ExtractRouteParams type - -Signature: - -```typescript -declare type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { - [k in Param | keyof ExtractRouteParams]: string | number; -} : T extends `${string}:${infer Param}` ? { - [k in Param]: string | number; -} : {}; -``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.gateway.created_at.md b/docs/js.gateway.created_at.md deleted file mode 100644 index c6c94097..00000000 --- a/docs/js.gateway.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [created\_at](./js.gateway.created_at.md) - -## Gateway.created\_at property - -The date this gateway was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.gateway.deployment_id.md b/docs/js.gateway.deployment_id.md deleted file mode 100644 index 6300a5b1..00000000 --- a/docs/js.gateway.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [deployment\_id](./js.gateway.deployment_id.md) - -## Gateway.deployment\_id property - -The deployment this gateway is associated with - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.gateway.domains.md b/docs/js.gateway.domains.md deleted file mode 100644 index fffb4603..00000000 --- a/docs/js.gateway.domains.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [domains](./js.gateway.domains.md) - -## Gateway.domains property - -Domains associated with this gateway - -Signature: - -```typescript -domains: Domain[]; -``` diff --git a/docs/js.gateway.hopsh_domain.md b/docs/js.gateway.hopsh_domain.md deleted file mode 100644 index d7b3c930..00000000 --- a/docs/js.gateway.hopsh_domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [hopsh\_domain](./js.gateway.hopsh_domain.md) - -## Gateway.hopsh\_domain property - -Domain automatically assigned by Hop - -Signature: - -```typescript -hopsh_domain: HopShDomain | null; -``` diff --git a/docs/js.gateway.id.md b/docs/js.gateway.id.md deleted file mode 100644 index 68dc79d4..00000000 --- a/docs/js.gateway.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [id](./js.gateway.id.md) - -## Gateway.id property - -The ID of the gateway - -Signature: - -```typescript -id: Id<'gateway'>; -``` diff --git a/docs/js.gateway.internal_domain.md b/docs/js.gateway.internal_domain.md deleted file mode 100644 index 58b36080..00000000 --- a/docs/js.gateway.internal_domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [internal\_domain](./js.gateway.internal_domain.md) - -## Gateway.internal\_domain property - -Internal domain assigned by user upon gateway creation - -Signature: - -```typescript -internal_domain: InternalHopDomain | null; -``` diff --git a/docs/js.gateway.md b/docs/js.gateway.md deleted file mode 100644 index 685ce83f..00000000 --- a/docs/js.gateway.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) - -## Gateway interface - -Gateways are used to connect services to the internet or a private network - -Signature: - -```typescript -interface Gateway -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.gateway.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this gateway was created | -| [deployment\_id](./js.gateway.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The deployment this gateway is associated with | -| [domains](./js.gateway.domains.md) | | [Domain](./js.domain.md)\[\] | Domains associated with this gateway | -| [hopsh\_domain](./js.gateway.hopsh_domain.md) | | [HopShDomain](./js.hopshdomain.md) \| null | Domain automatically assigned by Hop | -| [id](./js.gateway.id.md) | | [Id](./js.id.md)<'gateway'> | The ID of the gateway | -| [internal\_domain](./js.gateway.internal_domain.md) | | [InternalHopDomain](./js.internalhopdomain.md) \| null | Internal domain assigned by user upon gateway creation | -| [name](./js.gateway.name.md) | | string | The name of the gateway | -| [target\_port](./js.gateway.target_port.md) | | number \| null | Port the Gateway targets (Only for external gateways) | -| [type](./js.gateway.type.md) | | [GatewayType](./js.gatewaytype.md) | The type of the gateway | - diff --git a/docs/js.gateway.name.md b/docs/js.gateway.name.md deleted file mode 100644 index 8386952e..00000000 --- a/docs/js.gateway.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [name](./js.gateway.name.md) - -## Gateway.name property - -The name of the gateway - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.gateway.target_port.md b/docs/js.gateway.target_port.md deleted file mode 100644 index 6f14c324..00000000 --- a/docs/js.gateway.target_port.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [target\_port](./js.gateway.target_port.md) - -## Gateway.target\_port property - -Port the Gateway targets (Only for external gateways) - -Signature: - -```typescript -target_port: number | null; -``` diff --git a/docs/js.gateway.type.md b/docs/js.gateway.type.md deleted file mode 100644 index 91a41587..00000000 --- a/docs/js.gateway.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [type](./js.gateway.type.md) - -## Gateway.type property - -The type of the gateway - -Signature: - -```typescript -type: GatewayType; -``` diff --git a/docs/js.gatewaytype.md b/docs/js.gatewaytype.md deleted file mode 100644 index 3df5ce11..00000000 --- a/docs/js.gatewaytype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GatewayType](./js.gatewaytype.md) - -## GatewayType enum - -Types of gateways supported by Hop - -Signature: - -```typescript -declare enum GatewayType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXTERNAL | "external" | The gateway can be accessed from the internet | -| INTERNAL | "internal" | The gateway can only be accessed inside of a project's network | - diff --git a/docs/js.getidprefix.md b/docs/js.getidprefix.md deleted file mode 100644 index 6292890d..00000000 --- a/docs/js.getidprefix.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [getIdPrefix](./js.getidprefix.md) - -## getIdPrefix() function - -Signature: - -```typescript -declare function getIdPrefix(id: string, expect?: T): T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | | -| expect | T | (Optional) | - -Returns: - -T - diff --git a/docs/js.ghrepo.account_name.md b/docs/js.ghrepo.account_name.md deleted file mode 100644 index 17dad093..00000000 --- a/docs/js.ghrepo.account_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [account\_name](./js.ghrepo.account_name.md) - -## GHRepo.account\_name property - -Signature: - -```typescript -account_name: string; -``` diff --git a/docs/js.ghrepo.default_branch.md b/docs/js.ghrepo.default_branch.md deleted file mode 100644 index bae06423..00000000 --- a/docs/js.ghrepo.default_branch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [default\_branch](./js.ghrepo.default_branch.md) - -## GHRepo.default\_branch property - -Signature: - -```typescript -default_branch: string; -``` diff --git a/docs/js.ghrepo.full_name.md b/docs/js.ghrepo.full_name.md deleted file mode 100644 index 8a2776bb..00000000 --- a/docs/js.ghrepo.full_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [full\_name](./js.ghrepo.full_name.md) - -## GHRepo.full\_name property - -Signature: - -```typescript -full_name: string; -``` diff --git a/docs/js.ghrepo.id.md b/docs/js.ghrepo.id.md deleted file mode 100644 index f9607b9b..00000000 --- a/docs/js.ghrepo.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [id](./js.ghrepo.id.md) - -## GHRepo.id property - -Signature: - -```typescript -id: number; -``` diff --git a/docs/js.ghrepo.md b/docs/js.ghrepo.md deleted file mode 100644 index 84df8456..00000000 --- a/docs/js.ghrepo.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) - -## GHRepo interface - -GitHub repo type sent from API (NOT USED IN IMAGES) - -Signature: - -```typescript -interface GHRepo -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [account\_name](./js.ghrepo.account_name.md) | | string | | -| [default\_branch](./js.ghrepo.default_branch.md) | | string | | -| [full\_name](./js.ghrepo.full_name.md) | | string | | -| [id](./js.ghrepo.id.md) | | number | | -| [private](./js.ghrepo.private.md) | | boolean | | - diff --git a/docs/js.ghrepo.private.md b/docs/js.ghrepo.private.md deleted file mode 100644 index 3a4e994b..00000000 --- a/docs/js.ghrepo.private.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [private](./js.ghrepo.private.md) - -## GHRepo.private property - -Signature: - -```typescript -private: boolean; -``` diff --git a/docs/js.hop._constructor_.md b/docs/js.hop._constructor_.md deleted file mode 100644 index cd3f058d..00000000 --- a/docs/js.hop._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor_.md) - -## Hop.(constructor) - -Constructs a new instance of the `Hop` class - -Signature: - -```typescript -constructor(options: PartialAPIOptions); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [PartialAPIOptions](./js.partialapioptions.md) | | - diff --git a/docs/js.hop._constructor__1.md b/docs/js.hop._constructor__1.md deleted file mode 100644 index b426e3df..00000000 --- a/docs/js.hop._constructor__1.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor__1.md) - -## Hop.(constructor) - -Constructs a new instance of the `Hop` class - -Signature: - -```typescript -constructor(authentication: APIAuthentication, baseurl?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| authentication | [APIAuthentication](./js.apiauthentication.md) | | -| baseurl | string | (Optional) | - diff --git a/docs/js.hop.channels.md b/docs/js.hop.channels.md deleted file mode 100644 index 59b9dbc0..00000000 --- a/docs/js.hop.channels.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [channels](./js.hop.channels.md) - -## Hop.channels property - -Signature: - -```typescript -readonly channels: { - create(type: ChannelType, id?: string | null | undefined, options?: { - state?: T | undefined; - } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - get(id: string): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - getAll(project?: `project_${string}` | undefined): Promise<(Channel & { - setState(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - })[]>; - subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; - subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - getAllTokens(channel: string | Channel): Promise; - setState(channel: string | Channel, state: SetStateAction): Promise; - patchState(channel: string | Channel, state: SetStateAction): Promise; - publishMessage(channel: string | Channel, event: string, data: T_5): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: `leap_token_${string}`): Promise; - create(state?: State, project?: `project_${string}` | undefined): Promise; - setState(id: `leap_token_${string}`, state: State): Promise; - get(id: `leap_token_${string}`): Promise; - isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; - publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; - }; - }; -``` diff --git a/docs/js.hop.client.md b/docs/js.hop.client.md deleted file mode 100644 index c23e7fa5..00000000 --- a/docs/js.hop.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [client](./js.hop.client.md) - -## Hop.client property - -Signature: - -```typescript -readonly client: APIClient; -``` diff --git a/docs/js.hop.ignite.md b/docs/js.hop.ignite.md deleted file mode 100644 index 1afad47b..00000000 --- a/docs/js.hop.ignite.md +++ /dev/null @@ -1,85 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [ignite](./js.hop.ignite.md) - -## Hop.ignite property - -Signature: - -```typescript -readonly ignite: { - gateways: { - addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; - get(gatewayId: `gateway_${string}`): Promise; - }; - deployments: { - create: { - (configOrProject: `project_${string}`, bearerOrPatConfig: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - (configOrProject: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - }; - get: { - (name: string, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - }; - update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; - getContainers(deployment: `deployment_${string}`): Promise; - getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - })[]>; - delete(deployment: `deployment_${string}`): Promise; - gateways: { - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, type: GatewayType, protocol: "http" | null, targetPort: number): Promise; - }>; - }; - }; - containers: { - delete(container: `container_${string}`): Promise; - getLogs(container: `container_${string}`, options?: Partial<{ - sortBy: "timestamp"; - orderBy: "desc" | "asc"; - limit: number; - offset: number; - }>): Promise; - stop(container: `container_${string}`): Promise; - start(container: `container_${string}`): Promise; - create(deployment: `deployment_${string}`): Promise; - }; - }; -``` diff --git a/docs/js.hop.md b/docs/js.hop.md deleted file mode 100644 index ecdd264f..00000000 --- a/docs/js.hop.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) - -## Hop class - -Constructs a new instance of Hop and all of its SDKs. - -Signature: - -```typescript -declare class Hop -``` - -## Example - - -```ts -const hop = new Hop(bearerTokenOrPATOrProjectToken); -await hop.ignite.containers.create(deploymentId); -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./js.hop._constructor_.md) | | Constructs a new instance of the Hop class | -| [(constructor)(authentication, baseurl)](./js.hop._constructor__1.md) | | Constructs a new instance of the Hop class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>(type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; get(id: string): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; getAll(project?: \`project\_${string}\` \| undefined): Promise<([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: SetStateAction<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\]>; subscribeToken(channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_3>): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_4>): Promise<void>; publishMessage<T\_5>(channel: string \| [Channel](./js.channel.md), event: string, data: T\_5): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create(state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline(idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md)): Promise<boolean>; publishDirectMessage<T\_6>(token: \`leap\_token\_${string}\`, event: string, data: T\_6): Promise<void>; }; } | | -| [client](./js.hop.client.md) | readonly | [APIClient](./js.apiclient.md) | | -| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { (configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; update(deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise<([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; })\[\]>; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise<([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\]>; create(deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, targetPort: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs(container: \`container\_${string}\`, options?: Partial<{ sortBy: "timestamp"; orderBy: "desc" \| "asc"; limit: number; offset: number; }>): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | -| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise<([Room](./js.room.md) & { delete(): Promise<void>; })\[\]>; create(name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: "rtmp" \| "rtp"; hlsConfig?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }): Promise<[Room](./js.room.md) & { delete(): Promise<void>; }>; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | -| [projects](./js.hop.projects.md) | readonly | { getAllMembers(projectId?: \`project\_${string}\` \| undefined): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; tokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create(name: string, value: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)>; delete(id: string, projectId?: \`project\_${string}\` \| undefined): Promise<void>; }; } | | -| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise<{ digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]>; delete(image: string): Promise<void>; }; } | | -| [users](./js.hop.users.md) | readonly | { me: { get(): Promise<{ projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }>; pats: { create(name: string): Promise<[PAT](./js.pat.md)>; getAll(): Promise<[PAT](./js.pat.md)\[\]>; delete(id: \`pat\_${string}\`): Promise<void>; }; }; } | | - diff --git a/docs/js.hop.pipe.md b/docs/js.hop.pipe.md deleted file mode 100644 index 8aeff3ff..00000000 --- a/docs/js.hop.pipe.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [pipe](./js.hop.pipe.md) - -## Hop.pipe property - -Signature: - -```typescript -readonly pipe: { - rooms: { - getAll(project?: `project_${string}` | undefined): Promise<(Room & { - delete(): Promise; - })[]>; - create(name: string, options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean | undefined; - ingestProtocol: "rtmp" | "rtp"; - hlsConfig?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } | undefined; - }): Promise; - }>; - delete(room: `pipe_room_${string}`): Promise; - }; - }; -``` diff --git a/docs/js.hop.projects.md b/docs/js.hop.projects.md deleted file mode 100644 index 3d6a89ee..00000000 --- a/docs/js.hop.projects.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [projects](./js.hop.projects.md) - -## Hop.projects property - -Signature: - -```typescript -readonly projects: { - getAllMembers(projectId?: `project_${string}` | undefined): Promise; - getCurrentMember(projectId: `project_${string}`): Promise; - projectTokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - tokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - secrets: { - getAll(projectId?: `project_${string}` | undefined): Promise; - create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; - delete(id: string, projectId?: `project_${string}` | undefined): Promise; - }; - }; -``` diff --git a/docs/js.hop.registry.md b/docs/js.hop.registry.md deleted file mode 100644 index 66413e43..00000000 --- a/docs/js.hop.registry.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [registry](./js.hop.registry.md) - -## Hop.registry property - -Signature: - -```typescript -readonly registry: { - images: { - getAll(project?: `project_${string}` | undefined): Promise; - getManifest(image: string): Promise<{ - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]>; - delete(image: string): Promise; - }; - }; -``` diff --git a/docs/js.hop.users.md b/docs/js.hop.users.md deleted file mode 100644 index 751a0e80..00000000 --- a/docs/js.hop.users.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [users](./js.hop.users.md) - -## Hop.users property - -Signature: - -```typescript -readonly users: { - me: { - get(): Promise<{ - projects: Project[]; - user: User; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: `pat_${string}`): Promise; - }; - }; - }; -``` diff --git a/docs/js.hopapierror._constructor_.md b/docs/js.hopapierror._constructor_.md deleted file mode 100644 index 3f22086e..00000000 --- a/docs/js.hopapierror._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [(constructor)](./js.hopapierror._constructor_.md) - -## HopAPIError.(constructor) - -Constructs a new instance of the `HopAPIError` class - -Signature: - -```typescript -constructor(request: Request, response: Response, data: ErroredAPIResponse); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | -| response | Response | | -| data | [ErroredAPIResponse](./js.erroredapiresponse.md) | | - diff --git a/docs/js.hopapierror.data.md b/docs/js.hopapierror.data.md deleted file mode 100644 index a73cfc20..00000000 --- a/docs/js.hopapierror.data.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [data](./js.hopapierror.data.md) - -## HopAPIError.data property - -Signature: - -```typescript -readonly data: ErroredAPIResponse; -``` diff --git a/docs/js.hopapierror.md b/docs/js.hopapierror.md deleted file mode 100644 index fe8da293..00000000 --- a/docs/js.hopapierror.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) - -## HopAPIError class - -Signature: - -```typescript -declare class HopAPIError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(request, response, data)](./js.hopapierror._constructor_.md) | | Constructs a new instance of the HopAPIError class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./js.hopapierror.data.md) | readonly | [ErroredAPIResponse](./js.erroredapiresponse.md) | | -| [request](./js.hopapierror.request.md) | readonly | Request | | -| [response](./js.hopapierror.response.md) | readonly | Response | | -| [status](./js.hopapierror.status.md) | readonly | number | | - diff --git a/docs/js.hopapierror.request.md b/docs/js.hopapierror.request.md deleted file mode 100644 index 8d307953..00000000 --- a/docs/js.hopapierror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [request](./js.hopapierror.request.md) - -## HopAPIError.request property - -Signature: - -```typescript -readonly request: Request; -``` diff --git a/docs/js.hopapierror.response.md b/docs/js.hopapierror.response.md deleted file mode 100644 index 50d62913..00000000 --- a/docs/js.hopapierror.response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [response](./js.hopapierror.response.md) - -## HopAPIError.response property - -Signature: - -```typescript -readonly response: Response; -``` diff --git a/docs/js.hopapierror.status.md b/docs/js.hopapierror.status.md deleted file mode 100644 index 3fd9681c..00000000 --- a/docs/js.hopapierror.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [status](./js.hopapierror.status.md) - -## HopAPIError.status property - -Signature: - -```typescript -readonly status: number; -``` diff --git a/docs/js.hopshdomain.md b/docs/js.hopshdomain.md deleted file mode 100644 index 9e1292f6..00000000 --- a/docs/js.hopshdomain.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopShDomain](./js.hopshdomain.md) - -## HopShDomain type - -Signature: - -```typescript -declare type HopShDomain = `${string}.hop.sh`; -``` diff --git a/docs/js.id.md b/docs/js.id.md deleted file mode 100644 index cfb88226..00000000 --- a/docs/js.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Id](./js.id.md) - -## Id type - -Signature: - -```typescript -declare type Id = `${T}_${string}`; -``` -References: [IdPrefixes](./js.idprefixes.md) - diff --git a/docs/js.id_prefixes.md b/docs/js.id_prefixes.md deleted file mode 100644 index 3fe89473..00000000 --- a/docs/js.id_prefixes.md +++ /dev/null @@ -1,65 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ID\_PREFIXES](./js.id_prefixes.md) - -## ID\_PREFIXES variable - -Signature: - -```typescript -ID_PREFIXES: readonly [{ - readonly prefix: "user"; - readonly description: "Users"; -}, { - readonly prefix: "project"; - readonly description: "Project"; -}, { - readonly prefix: "pm"; - readonly description: "Project Members"; -}, { - readonly prefix: "role"; - readonly description: "Roles"; -}, { - readonly prefix: "pi"; - readonly description: "Project Invite"; -}, { - readonly prefix: "ptk"; - readonly description: "Project token"; -}, { - readonly prefix: "pat"; - readonly description: "User personal access token"; -}, { - readonly prefix: "container"; - readonly description: "Ignite container"; -}, { - readonly prefix: "pipe_room"; - readonly description: "Pipe room"; -}, { - readonly prefix: "deployment"; - readonly description: "Ignite deployment"; -}, { - readonly prefix: "bearer"; - readonly description: "Users bearer token"; -}, { - readonly prefix: "ptkid"; - readonly description: "Project token ID"; -}, { - readonly prefix: "secret"; - readonly description: "Project secret ID"; -}, { - readonly prefix: "gateway"; - readonly description: "Gateway"; -}, { - readonly prefix: "domain"; - readonly description: "Domain for a gateway"; -}, { - readonly prefix: "leap_token"; - readonly description: "Token for connecting to leap as a client"; -}, { - readonly prefix: "build"; - readonly description: "Build ID for build logs"; -}, { - readonly prefix: "rollout"; - readonly description: "Rollout ID for rollouts."; -}] -``` diff --git a/docs/js.idprefixes.md b/docs/js.idprefixes.md deleted file mode 100644 index 565ed27c..00000000 --- a/docs/js.idprefixes.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IdPrefixes](./js.idprefixes.md) - -## IdPrefixes type - -Signature: - -```typescript -declare type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; -``` -References: [ID\_PREFIXES](./js.id_prefixes.md) - diff --git a/docs/js.ignite.md b/docs/js.ignite.md deleted file mode 100644 index 02f64de6..00000000 --- a/docs/js.ignite.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Ignite](./js.ignite.md) - -## Ignite namespace - -Signature: - -```typescript -declare namespace ignite -``` diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md deleted file mode 100644 index bc5d4138..00000000 --- a/docs/js.igniteendpoints.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IgniteEndpoints](./js.igniteendpoints.md) - -## IgniteEndpoints type - -Signature: - -```typescript -declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { - deployments: Deployment[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { - containers: Container[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { - container: Container; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { - deployment_id: Id<'deployment'>; - container_id: Id<'container'>; -}> | Endpoint<'POST', '/v1/ignite/deployments', { - deployment: Deployment; -}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { - logs: ContainerLog[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/search', { - deployment: Deployment; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { - preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; -}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { - domain: string; -}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { - gateway: Gateway; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { - gateways: Gateway[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { - gateway: Gateway; -}, { - type: GatewayType; - target_port: number; - protocol: Gateway['protocol']; -}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}, DeploymentConfig>; -``` -References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) - diff --git a/docs/js.image_2.auth.md b/docs/js.image_2.auth.md deleted file mode 100644 index 95a908e5..00000000 --- a/docs/js.image_2.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [auth](./js.image_2.auth.md) - -## Image\_2.auth property - -Authorization required for the registry to access this image This is not required if you use Hop's own registry. - -Signature: - -```typescript -auth: Auth | null; -``` diff --git a/docs/js.image_2.gh_repo.md b/docs/js.image_2.gh_repo.md deleted file mode 100644 index a9bb16be..00000000 --- a/docs/js.image_2.gh_repo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [gh\_repo](./js.image_2.gh_repo.md) - -## Image\_2.gh\_repo property - -GitHub repo information (if applicable) - -Signature: - -```typescript -gh_repo: ImageGHRepo | null; -``` diff --git a/docs/js.image_2.md b/docs/js.image_2.md deleted file mode 100644 index 0a81cf6f..00000000 --- a/docs/js.image_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) - -## Image\_2 interface - -Docker image config - -Signature: - -```typescript -interface Image -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [auth](./js.image_2.auth.md) | | [Auth](./js.auth.md) \| null | Authorization required for the registry to access this image This is not required if you use Hop's own registry. | -| [gh\_repo](./js.image_2.gh_repo.md) | | [ImageGHRepo](./js.imageghrepo.md) \| null | GitHub repo information (if applicable) | -| [name](./js.image_2.name.md) | | string \| null | The name of the docker image | - diff --git a/docs/js.image_2.name.md b/docs/js.image_2.name.md deleted file mode 100644 index 8ab4559d..00000000 --- a/docs/js.image_2.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [name](./js.image_2.name.md) - -## Image\_2.name property - -The name of the docker image - -Signature: - -```typescript -name: string | null; -``` diff --git a/docs/js.imageghrepo.branch.md b/docs/js.imageghrepo.branch.md deleted file mode 100644 index 479d9e9a..00000000 --- a/docs/js.imageghrepo.branch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [branch](./js.imageghrepo.branch.md) - -## ImageGHRepo.branch property - -Signature: - -```typescript -branch: string; -``` diff --git a/docs/js.imageghrepo.full_name.md b/docs/js.imageghrepo.full_name.md deleted file mode 100644 index 40c3657a..00000000 --- a/docs/js.imageghrepo.full_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [full\_name](./js.imageghrepo.full_name.md) - -## ImageGHRepo.full\_name property - -Signature: - -```typescript -full_name: string; -``` diff --git a/docs/js.imageghrepo.md b/docs/js.imageghrepo.md deleted file mode 100644 index 8503ddd1..00000000 --- a/docs/js.imageghrepo.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) - -## ImageGHRepo interface - -GitHub repo partial used for images - -Signature: - -```typescript -interface ImageGHRepo -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [branch](./js.imageghrepo.branch.md) | | string | | -| [full\_name](./js.imageghrepo.full_name.md) | | string | | -| [repo\_id](./js.imageghrepo.repo_id.md) | | number | | - diff --git a/docs/js.imageghrepo.repo_id.md b/docs/js.imageghrepo.repo_id.md deleted file mode 100644 index 4e2439d4..00000000 --- a/docs/js.imageghrepo.repo_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [repo\_id](./js.imageghrepo.repo_id.md) - -## ImageGHRepo.repo\_id property - -Signature: - -```typescript -repo_id: number; -``` diff --git a/docs/js.internalhopdomain.md b/docs/js.internalhopdomain.md deleted file mode 100644 index 8ee254c8..00000000 --- a/docs/js.internalhopdomain.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [InternalHopDomain](./js.internalhopdomain.md) - -## InternalHopDomain type - -Signature: - -```typescript -declare type InternalHopDomain = `${string}.hop`; -``` diff --git a/docs/js.is_browser.md b/docs/js.is_browser.md deleted file mode 100644 index a071fafc..00000000 --- a/docs/js.is_browser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IS\_BROWSER](./js.is_browser.md) - -## IS\_BROWSER variable - -If we are in the browser. - -Signature: - -```typescript -IS_BROWSER: boolean -``` diff --git a/docs/js.isvalidbytestring.md b/docs/js.isvalidbytestring.md deleted file mode 100644 index 556da828..00000000 --- a/docs/js.isvalidbytestring.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [isValidByteString](./js.isvalidbytestring.md) - -## isValidByteString() function - -Signature: - -```typescript -declare function isValidByteString(value: string): value is ByteSizeString; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -value is [ByteSizeString](./js.bytesizestring.md) - diff --git a/docs/js.md b/docs/js.md deleted file mode 100644 index af94a8fe..00000000 --- a/docs/js.md +++ /dev/null @@ -1,145 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) - -## js package - -## Classes - -| Class | Description | -| --- | --- | -| [APIClient](./js.apiclient.md) | | -| [Hop](./js.hop.md) | Constructs a new instance of Hop and all of its SDKs. | -| [HopAPIError](./js.hopapierror.md) | | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [BuildMethod](./js.buildmethod.md) | Types of build methods supported by Hop | -| [BuildState](./js.buildstate.md) | | -| [ChannelType](./js.channeltype.md) | | -| [ContainerState](./js.containerstate.md) | Container state is relatively self-explanatory. It describes what the container is currently doing. | -| [DomainState](./js.domainstate.md) | | -| [GatewayType](./js.gatewaytype.md) | Types of gateways supported by Hop | -| [PROJECT\_PERMISSION](./js.project_permission.md) | | -| [ProjectTier](./js.projecttier.md) | | -| [ProjectType](./js.projecttype.md) | Type of a project | -| [Regions](./js.regions.md) | | -| [RestartPolicy](./js.restartpolicy.md) | Restart policy for deployments | -| [RolloutState](./js.rolloutstate.md) | Rollout state for deployments | -| [RuntimeType](./js.runtimetype.md) | Runtime types are used to describe the type of a deployment or container | -| [VgpuType](./js.vgputype.md) | Types for supported GPU | -| [VolumeFormat](./js.volumeformat.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [assertId(maybeId, prefix, message)](./js.assertid.md) | Asserts that a string is a valid ID | -| [getIdPrefix(id, expect)](./js.getidprefix.md) | | -| [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | -| [isValidByteString(value)](./js.isvalidbytestring.md) | | -| [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | -| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | | -| [validateId(maybeId, prefix)](./js.validateid.md) | Validates that a string is a valid ID | -| [validateIdPrefix(prefix, expect)](./js.validateidprefix.md) | Checks if a string is a valid Hop ID prefix | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [APIClientOptions](./js.apiclientoptions.md) | | -| [Auth](./js.auth.md) | Docker image registry authorization | -| [Build](./js.build.md) | | -| [BuildMetaData](./js.buildmetadata.md) | | -| [Channel](./js.channel.md) | | -| [ChannelToken](./js.channeltoken.md) | | -| [Container](./js.container.md) | | -| [ContainerLog](./js.containerlog.md) | Logs from a container | -| [DefaultQuotas](./js.defaultquotas.md) | | -| [Deployment](./js.deployment.md) | | -| [Domain](./js.domain.md) | | -| [Gateway](./js.gateway.md) | Gateways are used to connect services to the internet or a private network | -| [GHRepo](./js.ghrepo.md) | GitHub repo type sent from API (NOT USED IN IMAGES) | -| [Image\_2](./js.image_2.md) | Docker image config | -| [ImageGHRepo](./js.imageghrepo.md) | GitHub repo partial used for images | -| [MemberRole](./js.memberrole.md) | | -| [PAT](./js.pat.md) | | -| [Project](./js.project.md) | | -| [ProjectToken](./js.projecttoken.md) | A project token for a project | -| [QuotaOverrides](./js.quotaoverrides.md) | | -| [QuotaUsage](./js.quotausage.md) | | -| [Resources](./js.resources.md) | Resources allocated to a deployment | -| [Room](./js.room.md) | | -| [Secret](./js.secret.md) | | -| [User](./js.user.md) | A user objct | -| [Vgpu](./js.vgpu.md) | Virtual GPU config | -| [VolumeDefinition](./js.volumedefinition.md) | | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [API](./js.api.md) | | -| [Channels](./js.channels.md) | | -| [Ignite](./js.ignite.md) | | -| [Pipe](./js.pipe.md) | | -| [Projects](./js.projects.md) | | -| [Registry](./js.registry.md) | | -| [Users](./js.users.md) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | | -| [byteUnits](./js.byteunits.md) | | -| [DEFAULT\_BASE\_URL](./js.default_base_url.md) | The default base URL for Hop's API. | -| [ID\_PREFIXES](./js.id_prefixes.md) | | -| [IS\_BROWSER](./js.is_browser.md) | If we are in the browser. | -| [permissions](./js.permissions.md) | | -| [permissionsMap](./js.permissionsmap.md) | | -| [roles](./js.roles.md) | | -| [SUPPORTS\_INTL](./js.supports_intl.md) | | -| [units](./js.units.md) | | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnyId](./js.anyid.md) | | -| [APIAuthentication](./js.apiauthentication.md) | | -| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | | -| [APIResponse](./js.apiresponse.md) | | -| [ByteSizeString](./js.bytesizestring.md) | | -| [ByteString](./js.bytestring.md) | | -| [ByteUnit](./js.byteunit.md) | | -| [ChannelEndpoints](./js.channelendpoints.md) | | -| [DeliveryProtocol](./js.deliveryprotocol.md) | | -| [DeploymentConfig](./js.deploymentconfig.md) | | -| [DeploymentRollout](./js.deploymentrollout.md) | | -| [Empty](./js.empty.md) | | -| [Endpoint](./js.endpoint.md) | | -| [Endpoints](./js.endpoints.md) | | -| [ErroredAPIResponse](./js.erroredapiresponse.md) | | -| [ExtractRouteParams](./js.extractrouteparams.md) | | -| [HopShDomain](./js.hopshdomain.md) | | -| [Id](./js.id.md) | | -| [IdPrefixes](./js.idprefixes.md) | | -| [IgniteEndpoints](./js.igniteendpoints.md) | | -| [InternalHopDomain](./js.internalhopdomain.md) | | -| [Member](./js.member.md) | | -| [Method](./js.method.md) | | -| [PartialAPIOptions](./js.partialapioptions.md) | | -| [PipeEndpoints](./js.pipeendpoints.md) | | -| [ProjectsEndpoints](./js.projectsendpoints.md) | | -| [Query](./js.query.md) | | -| [RegistryEndpoints](./js.registryendpoints.md) | | -| [State](./js.state.md) | | -| [SuccessfulAPIResponse](./js.successfulapiresponse.md) | | -| [Tag](./js.tag.md) | | -| [Timestamp](./js.timestamp.md) | Hop's API uses ISO 8601 date strings | -| [UserEndpoints](./js.userendpoints.md) | | -| [Values](./js.values.md) | | - diff --git a/docs/js.member.md b/docs/js.member.md deleted file mode 100644 index 0ee4a3b3..00000000 --- a/docs/js.member.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Member](./js.member.md) - -## Member type - -Signature: - -```typescript -declare type Member = Omit & { - id: Id<'pm'>; - role: MemberRole; - joined_at: Timestamp; -}; -``` -References: [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [Timestamp](./js.timestamp.md) - diff --git a/docs/js.memberrole.flags.md b/docs/js.memberrole.flags.md deleted file mode 100644 index 2e0c80d2..00000000 --- a/docs/js.memberrole.flags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [flags](./js.memberrole.flags.md) - -## MemberRole.flags property - -The flags for this role - -Signature: - -```typescript -flags: number; -``` diff --git a/docs/js.memberrole.id.md b/docs/js.memberrole.id.md deleted file mode 100644 index f270fc72..00000000 --- a/docs/js.memberrole.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [id](./js.memberrole.id.md) - -## MemberRole.id property - -The ID of the role - -Signature: - -```typescript -id: Id<'role'>; -``` diff --git a/docs/js.memberrole.md b/docs/js.memberrole.md deleted file mode 100644 index 25369fad..00000000 --- a/docs/js.memberrole.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) - -## MemberRole interface - -Signature: - -```typescript -interface MemberRole -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [flags](./js.memberrole.flags.md) | | number | The flags for this role | -| [id](./js.memberrole.id.md) | | [Id](./js.id.md)<'role'> | The ID of the role | -| [name](./js.memberrole.name.md) | | string | The name of the role | - diff --git a/docs/js.memberrole.name.md b/docs/js.memberrole.name.md deleted file mode 100644 index ecdd270d..00000000 --- a/docs/js.memberrole.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [name](./js.memberrole.name.md) - -## MemberRole.name property - -The name of the role - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.method.md b/docs/js.method.md deleted file mode 100644 index a7e55a41..00000000 --- a/docs/js.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) - -## Method type - -Signature: - -```typescript -declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; -``` diff --git a/docs/js.parsesize.md b/docs/js.parsesize.md deleted file mode 100644 index 322ce2fa..00000000 --- a/docs/js.parsesize.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [parseSize](./js.parsesize.md) - -## parseSize() function - -Parses a byte size string into bytes - -Signature: - -```typescript -declare function parseSize(size: string): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| size | string | The size of anything in gigabytes, megabytes, kilobytes or bytes | - -Returns: - -number - diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md deleted file mode 100644 index 27242ba4..00000000 --- a/docs/js.partialapioptions.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PartialAPIOptions](./js.partialapioptions.md) - -## PartialAPIOptions type - -Signature: - -```typescript -declare type PartialAPIOptions = Partial> & Pick; -``` -References: [APIClientOptions](./js.apiclientoptions.md) - diff --git a/docs/js.pat.created_at.md b/docs/js.pat.created_at.md deleted file mode 100644 index 06e61761..00000000 --- a/docs/js.pat.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [created\_at](./js.pat.created_at.md) - -## PAT.created\_at property - -The date the pat was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.pat.id.md b/docs/js.pat.id.md deleted file mode 100644 index 2931e3ae..00000000 --- a/docs/js.pat.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [id](./js.pat.id.md) - -## PAT.id property - -The ID of the pat - -Signature: - -```typescript -id: Id<'pat'>; -``` diff --git a/docs/js.pat.md b/docs/js.pat.md deleted file mode 100644 index ebd93103..00000000 --- a/docs/js.pat.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) - -## PAT interface - -Signature: - -```typescript -interface PAT -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.pat.created_at.md) | | [Timestamp](./js.timestamp.md) | The date the pat was created | -| [id](./js.pat.id.md) | | [Id](./js.id.md)<'pat'> | The ID of the pat | -| [name](./js.pat.name.md) | | string \| null | The name of the pat | - diff --git a/docs/js.pat.name.md b/docs/js.pat.name.md deleted file mode 100644 index 1312d7b5..00000000 --- a/docs/js.pat.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [name](./js.pat.name.md) - -## PAT.name property - -The name of the pat - -Signature: - -```typescript -name: string | null; -``` diff --git a/docs/js.permissions.md b/docs/js.permissions.md deleted file mode 100644 index 85dc9aba..00000000 --- a/docs/js.permissions.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [permissions](./js.permissions.md) - -## permissions variable - -Signature: - -```typescript -permissions: { - add(value: bigint, flag: bigint): bigint; - test(value: bigint, flag: bigint): boolean; - subtract(value: bigint, flag: bigint): bigint; -} -``` diff --git a/docs/js.permissionsmap.md b/docs/js.permissionsmap.md deleted file mode 100644 index 4b05272c..00000000 --- a/docs/js.permissionsmap.md +++ /dev/null @@ -1,56 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [permissionsMap](./js.permissionsmap.md) - -## permissionsMap variable - -Signature: - -```typescript -permissionsMap: { - add_member: bigint; - remove_member: bigint; - get_project_members: bigint; - delete_project: bigint; - delete_deployment: bigint; - delete_container: bigint; - update_container_state: bigint; - read_deployments: bigint; - create_deployment: bigint; - create_container: bigint; - update_container_config: bigint; - create_room: bigint; - read_room: bigint; - delete_room: bigint; - create_room_producer: bigint; - create_project_token: bigint; - delete_project_token: bigint; - read_project_tokens: bigint; - read_container_logs: bigint; - create_project_secret: bigint; - read_project_secrets: bigint; - delete_project_secret: bigint; - get_registry_images: bigint; - create_channel_token: bigint; - create_gateway: bigint; - add_domain: bigint; - delete_channels: bigint; - update_channel_state: bigint; - read_channels: bigint; - publish_channel_messages: bigint; - manage_channel_subscribers: bigint; - delete_domain: bigint; - delete_gateway: bigint; - get_internal_domain: bigint; - create_leap_token: bigint; - read_leap_tokens: bigint; - update_leap_token: bigint; - message_token: bigint; - create_channel: bigint; - rollout: bigint; - request_quota_increase: bigint; - read_billing: bigint; - read_gateways: bigint; - delete_registry_images: bigint; -} -``` diff --git a/docs/js.pipe.md b/docs/js.pipe.md deleted file mode 100644 index 09432b46..00000000 --- a/docs/js.pipe.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Pipe](./js.pipe.md) - -## Pipe namespace - -Signature: - -```typescript -declare namespace pipe -``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md deleted file mode 100644 index 5d8178ef..00000000 --- a/docs/js.pipeendpoints.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PipeEndpoints](./js.pipeendpoints.md) - -## PipeEndpoints type - -Signature: - -```typescript -declare type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { - rooms: Room[]; -}> | Endpoint<'POST', '/v1/pipe/rooms', { - room: Room; -}, { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; -}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) - diff --git a/docs/js.project.created_at.md b/docs/js.project.created_at.md deleted file mode 100644 index 0b1cbd9f..00000000 --- a/docs/js.project.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [created\_at](./js.project.created_at.md) - -## Project.created\_at property - -The time this project was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.project.default_quotas.md b/docs/js.project.default_quotas.md deleted file mode 100644 index 3c67e09b..00000000 --- a/docs/js.project.default_quotas.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [default\_quotas](./js.project.default_quotas.md) - -## Project.default\_quotas property - -Signature: - -```typescript -default_quotas: DefaultQuotas; -``` diff --git a/docs/js.project.icon.md b/docs/js.project.icon.md deleted file mode 100644 index 50950ecf..00000000 --- a/docs/js.project.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [icon](./js.project.icon.md) - -## Project.icon property - -An icon for this project - -Signature: - -```typescript -icon: string | null; -``` diff --git a/docs/js.project.id.md b/docs/js.project.id.md deleted file mode 100644 index 1e88e80b..00000000 --- a/docs/js.project.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [id](./js.project.id.md) - -## Project.id property - -The ID of the project - -Signature: - -```typescript -id: Id<'project'>; -``` diff --git a/docs/js.project.md b/docs/js.project.md deleted file mode 100644 index 447623d1..00000000 --- a/docs/js.project.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) - -## Project interface - -Signature: - -```typescript -interface Project -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.project.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project was created at | -| [default\_quotas](./js.project.default_quotas.md) | | [DefaultQuotas](./js.defaultquotas.md) | | -| [icon](./js.project.icon.md) | | string \| null | An icon for this project | -| [id](./js.project.id.md) | | [Id](./js.id.md)<'project'> | The ID of the project | -| [name](./js.project.name.md) | | string | The name of the project | -| [namespace](./js.project.namespace.md) | | string | The registry namespace for this project | -| [quota\_overrides](./js.project.quota_overrides.md) | | [QuotaOverrides](./js.quotaoverrides.md) | | -| [quota\_usage](./js.project.quota_usage.md) | | [QuotaUsage](./js.quotausage.md) | | -| [tier](./js.project.tier.md) | | [ProjectTier](./js.projecttier.md) | The tier this project is | -| [type](./js.project.type.md) | | [ProjectType](./js.projecttype.md) | The type of this project. Either regular or personal | - diff --git a/docs/js.project.name.md b/docs/js.project.name.md deleted file mode 100644 index b138c95c..00000000 --- a/docs/js.project.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [name](./js.project.name.md) - -## Project.name property - -The name of the project - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.project.namespace.md b/docs/js.project.namespace.md deleted file mode 100644 index aaa8fdc8..00000000 --- a/docs/js.project.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [namespace](./js.project.namespace.md) - -## Project.namespace property - -The registry namespace for this project - -Signature: - -```typescript -namespace: string; -``` diff --git a/docs/js.project.quota_overrides.md b/docs/js.project.quota_overrides.md deleted file mode 100644 index 1d16a7da..00000000 --- a/docs/js.project.quota_overrides.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_overrides](./js.project.quota_overrides.md) - -## Project.quota\_overrides property - -Signature: - -```typescript -quota_overrides: QuotaOverrides; -``` diff --git a/docs/js.project.quota_usage.md b/docs/js.project.quota_usage.md deleted file mode 100644 index 0ba5afce..00000000 --- a/docs/js.project.quota_usage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_usage](./js.project.quota_usage.md) - -## Project.quota\_usage property - -Signature: - -```typescript -quota_usage: QuotaUsage; -``` diff --git a/docs/js.project.tier.md b/docs/js.project.tier.md deleted file mode 100644 index 684e6f73..00000000 --- a/docs/js.project.tier.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [tier](./js.project.tier.md) - -## Project.tier property - -The tier this project is - -Signature: - -```typescript -tier: ProjectTier; -``` diff --git a/docs/js.project.type.md b/docs/js.project.type.md deleted file mode 100644 index 66f2c248..00000000 --- a/docs/js.project.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [type](./js.project.type.md) - -## Project.type property - -The type of this project. Either regular or personal - -Signature: - -```typescript -type: ProjectType; -``` diff --git a/docs/js.project_permission.md b/docs/js.project_permission.md deleted file mode 100644 index b07a7f43..00000000 --- a/docs/js.project_permission.md +++ /dev/null @@ -1,61 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PROJECT\_PERMISSION](./js.project_permission.md) - -## PROJECT\_PERMISSION enum - -Signature: - -```typescript -declare enum PROJECT_PERMISSION -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ADD\_DOMAIN | "add_domain" | | -| ADD\_MEMBER | "add_member" | | -| CREATE\_CHANNEL | "create_channel" | | -| CREATE\_CHANNEL\_TOKEN | "create_channel_token" | | -| CREATE\_CONTAINER | "create_container" | | -| CREATE\_DEPLOYMENT | "create_deployment" | | -| CREATE\_GATEWAY | "create_gateway" | | -| CREATE\_LEAP\_TOKEN | "create_leap_token" | | -| CREATE\_PROJECT\_SECRET | "create_project_secret" | | -| CREATE\_PROJECT\_TOKEN | "create_project_token" | | -| CREATE\_ROOM | "create_room" | | -| CREATE\_ROOM\_PRODUCER | "create_room_producer" | | -| DELETE\_CHANNELS | "delete_channels" | | -| DELETE\_CONTAINER | "delete_container" | | -| DELETE\_DEPLOYMENT | "delete_deployment" | | -| DELETE\_DOMAIN | "delete_domain" | | -| DELETE\_GATEWAY | "delete_gateway" | | -| DELETE\_PROJECT | "delete_project" | | -| DELETE\_PROJECT\_SECRET | "delete_project_secret" | | -| DELETE\_PROJECT\_TOKEN | "delete_project_token" | | -| DELETE\_REGISTRY\_IMAGES | "delete_registry_images" | | -| DELETE\_ROOM | "delete_room" | | -| GET\_INTERNAL\_DOMAIN | "get_internal_domain" | | -| GET\_PROJECT\_MEMBERS | "get_project_members" | | -| GET\_REGISTRY\_IMAGES | "get_registry_images" | | -| MANAGE\_CHANNEL\_SUBSCRIBERS | "manage_channel_subscribers" | | -| MESSAGE\_TOKEN | "message_token" | | -| PUBLISH\_CHANNEL\_MESSAGES | "publish_channel_messages" | | -| READ\_BILLING | "read_billing" | | -| READ\_CHANNELS | "read_channels" | | -| READ\_CONTAINER\_LOGS | "read_container_logs" | | -| READ\_DEPLOYMENTS | "read_deployments" | | -| READ\_GATEWAYS | "read_gateways" | | -| READ\_LEAP\_TOKENS | "read_leap_tokens" | | -| READ\_PROJECT\_SECRETS | "read_project_secrets" | | -| READ\_PROJECT\_TOKENS | "read_project_tokens" | | -| READ\_ROOM | "read_room" | | -| REMOVE\_MEMBER | "remove_member" | | -| REQUEST\_QUOTA\_INCREASE | "request_quota_increase" | | -| ROLLOUT | "rollout" | | -| UPDATE\_CHANNEL\_STATE | "update_channel_state" | | -| UPDATE\_CONTAINER\_CONFIG | "update_container_config" | | -| UPDATE\_CONTAINER\_STATE | "update_container_state" | | -| UPDATE\_LEAP\_TOKEN | "update_leap_token" | | - diff --git a/docs/js.projects.md b/docs/js.projects.md deleted file mode 100644 index 6cadb993..00000000 --- a/docs/js.projects.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Projects](./js.projects.md) - -## Projects namespace - -Signature: - -```typescript -declare namespace projects -``` diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md deleted file mode 100644 index e666e15c..00000000 --- a/docs/js.projectsendpoints.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectsEndpoints](./js.projectsendpoints.md) - -## ProjectsEndpoints type - -Signature: - -```typescript -declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { - project_member: Member; -}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/@this/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/:project_id/members', { - members: Member[]; -}> | Endpoint<'GET', '/v1/projects/@this/members', { - members: Member[]; -}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'POST', '/v1/projects/@this/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { - secrets: Secret[]; -}> | Endpoint<'GET', '/v1/projects/@this/secrets', { - secrets: Secret[]; -}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) - diff --git a/docs/js.projecttier.md b/docs/js.projecttier.md deleted file mode 100644 index 0693bcce..00000000 --- a/docs/js.projecttier.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectTier](./js.projecttier.md) - -## ProjectTier enum - -Signature: - -```typescript -declare enum ProjectTier -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| FREE | "free" | | -| PAID | "paid" | | - diff --git a/docs/js.projecttoken.created_at.md b/docs/js.projecttoken.created_at.md deleted file mode 100644 index 4ff2416f..00000000 --- a/docs/js.projecttoken.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [created\_at](./js.projecttoken.created_at.md) - -## ProjectToken.created\_at property - -The time this project token was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.projecttoken.flags.md b/docs/js.projecttoken.flags.md deleted file mode 100644 index af2769a6..00000000 --- a/docs/js.projecttoken.flags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [flags](./js.projecttoken.flags.md) - -## ProjectToken.flags property - -Permissions and flags that this project token can perform - -Signature: - -```typescript -flags: number; -``` diff --git a/docs/js.projecttoken.id.md b/docs/js.projecttoken.id.md deleted file mode 100644 index 1b4ef352..00000000 --- a/docs/js.projecttoken.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [id](./js.projecttoken.id.md) - -## ProjectToken.id property - -The Id of the project token - -Signature: - -```typescript -id: Id<'ptkid'>; -``` diff --git a/docs/js.projecttoken.md b/docs/js.projecttoken.md deleted file mode 100644 index b35917ad..00000000 --- a/docs/js.projecttoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) - -## ProjectToken interface - -A project token for a project - -Signature: - -```typescript -interface ProjectToken -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.projecttoken.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project token was created | -| [flags](./js.projecttoken.flags.md) | | number | Permissions and flags that this project token can perform | -| [id](./js.projecttoken.id.md) | | [Id](./js.id.md)<'ptkid'> | The Id of the project token | -| [token](./js.projecttoken.token.md) | | [Id](./js.id.md)<'ptk'> | The key value. This will likely have half of the key obfuscated | - diff --git a/docs/js.projecttoken.token.md b/docs/js.projecttoken.token.md deleted file mode 100644 index 5a4ac224..00000000 --- a/docs/js.projecttoken.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [token](./js.projecttoken.token.md) - -## ProjectToken.token property - -The key value. This will likely have half of the key obfuscated - -Signature: - -```typescript -token: Id<'ptk'>; -``` diff --git a/docs/js.projecttype.md b/docs/js.projecttype.md deleted file mode 100644 index abf51c1e..00000000 --- a/docs/js.projecttype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectType](./js.projecttype.md) - -## ProjectType enum - -Type of a project - -Signature: - -```typescript -declare enum ProjectType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PERSONAL | "personal" | A personal project are created when you register an account | -| REGULAR | "regular" | A standard project type | - diff --git a/docs/js.query.md b/docs/js.query.md deleted file mode 100644 index 4592c5d8..00000000 --- a/docs/js.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Query](./js.query.md) - -## Query type - -Signature: - -```typescript -declare type Query = ExtractRouteParams & Record; -``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.quotaoverrides.md b/docs/js.quotaoverrides.md deleted file mode 100644 index b621ac8b..00000000 --- a/docs/js.quotaoverrides.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaOverrides](./js.quotaoverrides.md) - -## QuotaOverrides interface - -Signature: - -```typescript -interface QuotaOverrides -``` diff --git a/docs/js.quotausage.md b/docs/js.quotausage.md deleted file mode 100644 index 343de5a0..00000000 --- a/docs/js.quotausage.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) - -## QuotaUsage interface - -Signature: - -```typescript -interface QuotaUsage -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.quotausage.ram.md) | | number | | -| [vcpu](./js.quotausage.vcpu.md) | | number | | - diff --git a/docs/js.quotausage.ram.md b/docs/js.quotausage.ram.md deleted file mode 100644 index 2f0bc2e4..00000000 --- a/docs/js.quotausage.ram.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [ram](./js.quotausage.ram.md) - -## QuotaUsage.ram property - -Signature: - -```typescript -ram: number; -``` diff --git a/docs/js.quotausage.vcpu.md b/docs/js.quotausage.vcpu.md deleted file mode 100644 index a4609646..00000000 --- a/docs/js.quotausage.vcpu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [vcpu](./js.quotausage.vcpu.md) - -## QuotaUsage.vcpu property - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.regions.md b/docs/js.regions.md deleted file mode 100644 index a1cbc0e7..00000000 --- a/docs/js.regions.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Regions](./js.regions.md) - -## Regions enum - -Signature: - -```typescript -declare enum Regions -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| US\_EAST\_1 | "us-east-1" | | - diff --git a/docs/js.registry.md b/docs/js.registry.md deleted file mode 100644 index 3df4f856..00000000 --- a/docs/js.registry.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Registry](./js.registry.md) - -## Registry namespace - -Signature: - -```typescript -declare namespace registry -``` diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md deleted file mode 100644 index b924f713..00000000 --- a/docs/js.registryendpoints.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RegistryEndpoints](./js.registryendpoints.md) - -## RegistryEndpoints type - -Signature: - -```typescript -declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { - images: string[]; -}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; -}>; -``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) - diff --git a/docs/js.resources.md b/docs/js.resources.md deleted file mode 100644 index 70132304..00000000 --- a/docs/js.resources.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) - -## Resources interface - -Resources allocated to a deployment - -Signature: - -```typescript -interface Resources -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.resources.ram.md) | | [ByteSizeString](./js.bytesizestring.md) | Amount of memory to allocate in a readible format You can use the parseSize function to convert this to bytes. | -| [vcpu](./js.resources.vcpu.md) | | number | Amount of vCPU to allocate | -| [vgpu](./js.resources.vgpu.md) | | [Vgpu](./js.vgpu.md)\[\] | vGPUs to allocate | - diff --git a/docs/js.resources.ram.md b/docs/js.resources.ram.md deleted file mode 100644 index f4d6207d..00000000 --- a/docs/js.resources.ram.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [ram](./js.resources.ram.md) - -## Resources.ram property - -Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes. - -Signature: - -```typescript -ram: ByteSizeString; -``` diff --git a/docs/js.resources.vcpu.md b/docs/js.resources.vcpu.md deleted file mode 100644 index ebcb3493..00000000 --- a/docs/js.resources.vcpu.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vcpu](./js.resources.vcpu.md) - -## Resources.vcpu property - -Amount of vCPU to allocate - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.resources.vgpu.md b/docs/js.resources.vgpu.md deleted file mode 100644 index cac4f7bf..00000000 --- a/docs/js.resources.vgpu.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vgpu](./js.resources.vgpu.md) - -## Resources.vgpu property - -vGPUs to allocate - -Signature: - -```typescript -vgpu: Vgpu[]; -``` diff --git a/docs/js.restartpolicy.md b/docs/js.restartpolicy.md deleted file mode 100644 index fcfb286e..00000000 --- a/docs/js.restartpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RestartPolicy](./js.restartpolicy.md) - -## RestartPolicy enum - -Restart policy for deployments - -Signature: - -```typescript -declare enum RestartPolicy -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ALWAYS | "always" | | -| NEVER | "never" | | -| ON\_FAILURE | "on-failure" | | - diff --git a/docs/js.roles.md b/docs/js.roles.md deleted file mode 100644 index 18fec69a..00000000 --- a/docs/js.roles.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [roles](./js.roles.md) - -## roles variable - -Signature: - -```typescript -roles: { - viewer: bigint; - editor: bigint; - admin: bigint; - owner: bigint; -} -``` diff --git a/docs/js.rolloutstate.md b/docs/js.rolloutstate.md deleted file mode 100644 index 53d6720f..00000000 --- a/docs/js.rolloutstate.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RolloutState](./js.rolloutstate.md) - -## RolloutState enum - -Rollout state for deployments - -Signature: - -```typescript -declare enum RolloutState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| FAILED | "failed" | | -| FINISHED | "finished" | | -| PENDING | "pending" | | - diff --git a/docs/js.room.created_at.md b/docs/js.room.created_at.md deleted file mode 100644 index 433be446..00000000 --- a/docs/js.room.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [created\_at](./js.room.created_at.md) - -## Room.created\_at property - -The unix timestamp of when this stream was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.room.delivery_protocols.md b/docs/js.room.delivery_protocols.md deleted file mode 100644 index 197896db..00000000 --- a/docs/js.room.delivery_protocols.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [delivery\_protocols](./js.room.delivery_protocols.md) - -## Room.delivery\_protocols property - -Protocols that are supported by this room to the client - -Signature: - -```typescript -delivery_protocols: DeliveryProtocol[]; -``` diff --git a/docs/js.room.id.md b/docs/js.room.id.md deleted file mode 100644 index 2ec7f4f4..00000000 --- a/docs/js.room.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [id](./js.room.id.md) - -## Room.id property - -The ID of this stream - -Signature: - -```typescript -id: Id<'pipe_room'>; -``` diff --git a/docs/js.room.ingest_endpoint.md b/docs/js.room.ingest_endpoint.md deleted file mode 100644 index 8abeaa5d..00000000 --- a/docs/js.room.ingest_endpoint.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_endpoint](./js.room.ingest_endpoint.md) - -## Room.ingest\_endpoint property - -The URL that you can stream to - -Signature: - -```typescript -ingest_endpoint: string; -``` diff --git a/docs/js.room.ingest_protocol.md b/docs/js.room.ingest_protocol.md deleted file mode 100644 index 672c9a50..00000000 --- a/docs/js.room.ingest_protocol.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_protocol](./js.room.ingest_protocol.md) - -## Room.ingest\_protocol property - -Protocol you can stream with - -Signature: - -```typescript -ingest_protocol: 'rtmp'; -``` diff --git a/docs/js.room.ingest_region.md b/docs/js.room.ingest_region.md deleted file mode 100644 index 1ac0ab09..00000000 --- a/docs/js.room.ingest_region.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_region](./js.room.ingest_region.md) - -## Room.ingest\_region property - -The region that the stream url is located in - -Signature: - -```typescript -ingest_region: Regions; -``` diff --git a/docs/js.room.join_token.md b/docs/js.room.join_token.md deleted file mode 100644 index f701d3db..00000000 --- a/docs/js.room.join_token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [join\_token](./js.room.join_token.md) - -## Room.join\_token property - -A join token to subscribe into this room - -Signature: - -```typescript -join_token: string; -``` diff --git a/docs/js.room.md b/docs/js.room.md deleted file mode 100644 index 438ec36e..00000000 --- a/docs/js.room.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) - -## Room interface - -Signature: - -```typescript -interface Room -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.room.created_at.md) | | [Timestamp](./js.timestamp.md) | The unix timestamp of when this stream was created | -| [delivery\_protocols](./js.room.delivery_protocols.md) | | [DeliveryProtocol](./js.deliveryprotocol.md)\[\] | Protocols that are supported by this room to the client | -| [id](./js.room.id.md) | | [Id](./js.id.md)<'pipe\_room'> | The ID of this stream | -| [ingest\_endpoint](./js.room.ingest_endpoint.md) | | string | The URL that you can stream to | -| [ingest\_protocol](./js.room.ingest_protocol.md) | | 'rtmp' | Protocol you can stream with | -| [ingest\_region](./js.room.ingest_region.md) | | [Regions](./js.regions.md) | The region that the stream url is located in | -| [join\_token](./js.room.join_token.md) | | string | A join token to subscribe into this room | -| [name](./js.room.name.md) | | string | The name of this room | -| [state](./js.room.state.md) | | 'live' \| 'offline' | The state of the stream currently | - diff --git a/docs/js.room.name.md b/docs/js.room.name.md deleted file mode 100644 index 705a6e13..00000000 --- a/docs/js.room.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [name](./js.room.name.md) - -## Room.name property - -The name of this room - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.room.state.md b/docs/js.room.state.md deleted file mode 100644 index bfa47804..00000000 --- a/docs/js.room.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [state](./js.room.state.md) - -## Room.state property - -The state of the stream currently - -Signature: - -```typescript -state: 'live' | 'offline'; -``` diff --git a/docs/js.runtimetype.md b/docs/js.runtimetype.md deleted file mode 100644 index d980ef63..00000000 --- a/docs/js.runtimetype.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RuntimeType](./js.runtimetype.md) - -## RuntimeType enum - -Runtime types are used to describe the type of a deployment or container - -Signature: - -```typescript -declare enum RuntimeType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EPHEMERAL | "ephemeral" | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | -| PERSISTENT | "persistent" | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | -| STATEFUL | "stateful" | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | - diff --git a/docs/js.secret.created_at.md b/docs/js.secret.created_at.md deleted file mode 100644 index b28a9883..00000000 --- a/docs/js.secret.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [created\_at](./js.secret.created_at.md) - -## Secret.created\_at property - -The time this secret was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.secret.digest.md b/docs/js.secret.digest.md deleted file mode 100644 index 93e79489..00000000 --- a/docs/js.secret.digest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [digest](./js.secret.digest.md) - -## Secret.digest property - -A digest hash of the secret - -Signature: - -```typescript -digest: string; -``` diff --git a/docs/js.secret.id.md b/docs/js.secret.id.md deleted file mode 100644 index 6a9d0d47..00000000 --- a/docs/js.secret.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [id](./js.secret.id.md) - -## Secret.id property - -The ID of the secret - -Signature: - -```typescript -id: Id<'secret'>; -``` diff --git a/docs/js.secret.md b/docs/js.secret.md deleted file mode 100644 index 75cd9fb3..00000000 --- a/docs/js.secret.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) - -## Secret interface - -Signature: - -```typescript -interface Secret -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.secret.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this secret was created at | -| [digest](./js.secret.digest.md) | | string | A digest hash of the secret | -| [id](./js.secret.id.md) | | [Id](./js.id.md)<'secret'> | The ID of the secret | -| [name](./js.secret.name.md) | | string | The name of the secret | - diff --git a/docs/js.secret.name.md b/docs/js.secret.name.md deleted file mode 100644 index 653530e7..00000000 --- a/docs/js.secret.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [name](./js.secret.name.md) - -## Secret.name property - -The name of the secret - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.state.md b/docs/js.state.md deleted file mode 100644 index 91570529..00000000 --- a/docs/js.state.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [State](./js.state.md) - -## State type - -Signature: - -```typescript -declare type State = Record; -``` diff --git a/docs/js.successfulapiresponse.md b/docs/js.successfulapiresponse.md deleted file mode 100644 index da2e0365..00000000 --- a/docs/js.successfulapiresponse.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [SuccessfulAPIResponse](./js.successfulapiresponse.md) - -## SuccessfulAPIResponse type - -Signature: - -```typescript -declare type SuccessfulAPIResponse = { - success: true; - data: T; -}; -``` diff --git a/docs/js.supports_intl.md b/docs/js.supports_intl.md deleted file mode 100644 index abcbc5d0..00000000 --- a/docs/js.supports_intl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [SUPPORTS\_INTL](./js.supports_intl.md) - -## SUPPORTS\_INTL variable - -Signature: - -```typescript -SUPPORTS_INTL: boolean -``` diff --git a/docs/js.tag.md b/docs/js.tag.md deleted file mode 100644 index 458816c5..00000000 --- a/docs/js.tag.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Tag](./js.tag.md) - -## Tag type - -Signature: - -```typescript -declare type Tag = T & { - ___tag: Name; -}; -``` diff --git a/docs/js.timestamp.md b/docs/js.timestamp.md deleted file mode 100644 index bd3efe15..00000000 --- a/docs/js.timestamp.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Timestamp](./js.timestamp.md) - -## Timestamp type - -Hop's API uses ISO 8601 date strings - -Signature: - -```typescript -declare type Timestamp = Tag; -``` -References: [Tag](./js.tag.md) - diff --git a/docs/js.units.md b/docs/js.units.md deleted file mode 100644 index fed751ae..00000000 --- a/docs/js.units.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [units](./js.units.md) - -## units variable - -> Warning: This API is now obsolete. -> -> use `byteUnits` instead -> - -Signature: - -```typescript -units: readonly ["GB", "MB", "KB", "B"] -``` diff --git a/docs/js.user.email.md b/docs/js.user.email.md deleted file mode 100644 index 6c90f052..00000000 --- a/docs/js.user.email.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [email](./js.user.email.md) - -## User.email property - -The email of the user - -Signature: - -```typescript -email: string; -``` diff --git a/docs/js.user.id.md b/docs/js.user.id.md deleted file mode 100644 index 404e7ca0..00000000 --- a/docs/js.user.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [id](./js.user.id.md) - -## User.id property - -The ID of the user - -Signature: - -```typescript -id: Id<'user'>; -``` diff --git a/docs/js.user.md b/docs/js.user.md deleted file mode 100644 index 4382cd49..00000000 --- a/docs/js.user.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) - -## User interface - -A user objct - -Signature: - -```typescript -interface User -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [email](./js.user.email.md) | | string | The email of the user | -| [id](./js.user.id.md) | | [Id](./js.id.md)<'user'> | The ID of the user | -| [name](./js.user.name.md) | | string | The name of the user. Think of this as a display name | -| [username](./js.user.username.md) | | string | A unqiue username for the user | - diff --git a/docs/js.user.name.md b/docs/js.user.name.md deleted file mode 100644 index 36394000..00000000 --- a/docs/js.user.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [name](./js.user.name.md) - -## User.name property - -The name of the user. Think of this as a display name - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.user.username.md b/docs/js.user.username.md deleted file mode 100644 index 1b929208..00000000 --- a/docs/js.user.username.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [username](./js.user.username.md) - -## User.username property - -A unqiue username for the user - -Signature: - -```typescript -username: string; -``` diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md deleted file mode 100644 index c9a3effc..00000000 --- a/docs/js.userendpoints.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [UserEndpoints](./js.userendpoints.md) - -## UserEndpoints type - -Signature: - -```typescript -declare type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { - projects: Project[]; - user: User; - project_member_role_map: Record, MemberRole>; - leap_token: string | null; -}> | Endpoint<'POST', '/v1/users/@me/pats', { - pat: PAT; -}, { - name: string; -}> | Endpoint<'GET', '/v1/users/@me/pats', { - pats: PAT[]; -}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) - diff --git a/docs/js.users.md b/docs/js.users.md deleted file mode 100644 index 3c959755..00000000 --- a/docs/js.users.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Users](./js.users.md) - -## Users namespace - -Signature: - -```typescript -declare namespace users -``` diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md deleted file mode 100644 index 590180e5..00000000 --- a/docs/js.validateapiauthentication.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateAPIAuthentication](./js.validateapiauthentication.md) - -## validateAPIAuthentication() function - -Signature: - -```typescript -declare function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | string | | - -Returns: - -auth is [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) - diff --git a/docs/js.validateid.md b/docs/js.validateid.md deleted file mode 100644 index d6e273b7..00000000 --- a/docs/js.validateid.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateId](./js.validateid.md) - -## validateId() function - -Validates that a string is a valid ID - -Signature: - -```typescript -declare function validateId(maybeId: string, prefix?: T | T[]): maybeId is Id; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| maybeId | string | A string that might be an id | -| prefix | T \| T\[\] | (Optional) Optionally an id prefix to check against | - -Returns: - -maybeId is [Id](./js.id.md)<T> - -- true if the string is an id - diff --git a/docs/js.validateidprefix.md b/docs/js.validateidprefix.md deleted file mode 100644 index 59c6d9a0..00000000 --- a/docs/js.validateidprefix.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateIdPrefix](./js.validateidprefix.md) - -## validateIdPrefix() function - -Checks if a string is a valid Hop ID prefix - -Signature: - -```typescript -declare function validateIdPrefix(prefix: string, expect?: T): prefix is T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prefix | string | A string that is a potential prefix | -| expect | T | (Optional) An expected prefix to check against | - -Returns: - -prefix is T - -- Whether the prefix is valid - diff --git a/docs/js.values.md b/docs/js.values.md deleted file mode 100644 index b8dbb26f..00000000 --- a/docs/js.values.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Values](./js.values.md) - -## Values type - -Signature: - -```typescript -declare type Values = T[keyof T]; -``` diff --git a/docs/js.vgpu.count.md b/docs/js.vgpu.count.md deleted file mode 100644 index 7ffa7aa5..00000000 --- a/docs/js.vgpu.count.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [count](./js.vgpu.count.md) - -## Vgpu.count property - -The amount of vGPUs to allocate - -Signature: - -```typescript -count: number; -``` diff --git a/docs/js.vgpu.md b/docs/js.vgpu.md deleted file mode 100644 index 3897532d..00000000 --- a/docs/js.vgpu.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) - -## Vgpu interface - -Virtual GPU config - -Signature: - -```typescript -interface Vgpu -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [count](./js.vgpu.count.md) | | number | The amount of vGPUs to allocate | -| [type](./js.vgpu.type.md) | | [VgpuType](./js.vgputype.md) | The type of vGPU to allocate | - diff --git a/docs/js.vgpu.type.md b/docs/js.vgpu.type.md deleted file mode 100644 index 9d3e5d20..00000000 --- a/docs/js.vgpu.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [type](./js.vgpu.type.md) - -## Vgpu.type property - -The type of vGPU to allocate - -Signature: - -```typescript -type: VgpuType; -``` diff --git a/docs/js.vgputype.md b/docs/js.vgputype.md deleted file mode 100644 index 72d39dd5..00000000 --- a/docs/js.vgputype.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VgpuType](./js.vgputype.md) - -## VgpuType enum - -Types for supported GPU - -Signature: - -```typescript -declare enum VgpuType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| A400 | "a400" | | - diff --git a/docs/js.volumedefinition.fs.md b/docs/js.volumedefinition.fs.md deleted file mode 100644 index 13e0bde3..00000000 --- a/docs/js.volumedefinition.fs.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [fs](./js.volumedefinition.fs.md) - -## VolumeDefinition.fs property - -The format of the volume - -Signature: - -```typescript -fs: VolumeFormat; -``` diff --git a/docs/js.volumedefinition.md b/docs/js.volumedefinition.md deleted file mode 100644 index 0a63f366..00000000 --- a/docs/js.volumedefinition.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) - -## VolumeDefinition interface - -Signature: - -```typescript -interface VolumeDefinition -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fs](./js.volumedefinition.fs.md) | | [VolumeFormat](./js.volumeformat.md) | The format of the volume | -| [mount\_path](./js.volumedefinition.mount_path.md) | | string | The mount point of the volume | -| [size](./js.volumedefinition.size.md) | | [ByteSizeString](./js.bytesizestring.md) | The size of the volume in bytes | - diff --git a/docs/js.volumedefinition.mount_path.md b/docs/js.volumedefinition.mount_path.md deleted file mode 100644 index b089b026..00000000 --- a/docs/js.volumedefinition.mount_path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [mount\_path](./js.volumedefinition.mount_path.md) - -## VolumeDefinition.mount\_path property - -The mount point of the volume - -Signature: - -```typescript -mount_path: string; -``` diff --git a/docs/js.volumedefinition.size.md b/docs/js.volumedefinition.size.md deleted file mode 100644 index 493b250e..00000000 --- a/docs/js.volumedefinition.size.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [size](./js.volumedefinition.size.md) - -## VolumeDefinition.size property - -The size of the volume in bytes - -Signature: - -```typescript -size: ByteSizeString; -``` diff --git a/docs/js.volumeformat.md b/docs/js.volumeformat.md deleted file mode 100644 index 829d1752..00000000 --- a/docs/js.volumeformat.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeFormat](./js.volumeformat.md) - -## VolumeFormat enum - -Signature: - -```typescript -declare enum VolumeFormat -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXT4 | "ext4" | | -| XFS | "xfs" | | - From dabfd48a6723fae0e3d2284cf2ae4452e220cd35 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 11:43:50 +0100 Subject: [PATCH 03/33] build before writing docs --- .gitignore | 1 + package.json | 5 +- yarn.lock | 139 +-------------------------------------------------- 3 files changed, 4 insertions(+), 141 deletions(-) diff --git a/.gitignore b/.gitignore index d779188e..b62e4494 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,4 @@ node_modules dist _workbench.ts .env +docs diff --git a/package.json b/package.json index dd70d42c..80a8eb8e 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "vercel-build": "yarn typedoc --plugin typedoc-plugin-missing-exports src/index.ts", + "vercel-build": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./docs --output-folder ./docs", "test": "tsx tests/index.ts" }, "devDependencies": { @@ -57,9 +57,6 @@ "prettier": "2.7.1", "tsup": "6.2.3", "tsx": "3.10.1", - "typedoc": "0.23.16", - "typedoc-plugin-markdown": "3.13.6", - "typedoc-plugin-missing-exports": "1.0.0", "typescript": "4.8.4" }, "dependencies": { diff --git a/yarn.lock b/yarn.lock index ee8c4a5e..23558b85 100644 --- a/yarn.lock +++ b/yarn.lock @@ -499,9 +499,6 @@ __metadata: prettier: 2.7.1 tsup: 6.2.3 tsx: 3.10.1 - typedoc: 0.23.16 - typedoc-plugin-markdown: 3.13.6 - typedoc-plugin-missing-exports: 1.0.0 typescript: 4.8.4 zod: ^3.19.1 languageName: unknown @@ -2135,24 +2132,6 @@ __metadata: languageName: node linkType: hard -"handlebars@npm:^4.7.7": - version: 4.7.7 - resolution: "handlebars@npm:4.7.7" - dependencies: - minimist: ^1.2.5 - neo-async: ^2.6.0 - source-map: ^0.6.1 - uglify-js: ^3.1.4 - wordwrap: ^1.0.0 - dependenciesMeta: - uglify-js: - optional: true - bin: - handlebars: bin/handlebars - checksum: 1e79a43f5e18d15742977cb987923eab3e2a8f44f2d9d340982bcb69e1735ed049226e534d7c1074eaddaf37e4fb4f471a8adb71cddd5bc8cf3f894241df5cee - languageName: node - linkType: hard - "hard-rejection@npm:^2.1.0": version: 2.1.0 resolution: "hard-rejection@npm:2.1.0" @@ -2634,13 +2613,6 @@ __metadata: languageName: node linkType: hard -"jsonc-parser@npm:^3.0.0": - version: 3.2.0 - resolution: "jsonc-parser@npm:3.2.0" - checksum: 946dd9a5f326b745aa326d48a7257e3f4a4b62c5e98ec8e49fa2bdd8d96cef7e6febf1399f5c7016114fd1f68a1c62c6138826d5d90bc650448e3cf0951c53c7 - languageName: node - linkType: hard - "jsonfile@npm:^4.0.0": version: 4.0.0 resolution: "jsonfile@npm:4.0.0" @@ -2779,13 +2751,6 @@ __metadata: languageName: node linkType: hard -"lunr@npm:^2.3.9": - version: 2.3.9 - resolution: "lunr@npm:2.3.9" - checksum: 176719e24fcce7d3cf1baccce9dd5633cd8bdc1f41ebe6a180112e5ee99d80373fe2454f5d4624d437e5a8319698ca6837b9950566e15d2cae5f2a543a3db4b8 - languageName: node - linkType: hard - "make-fetch-happen@npm:^10.0.3": version: 10.1.3 resolution: "make-fetch-happen@npm:10.1.3" @@ -2824,15 +2789,6 @@ __metadata: languageName: node linkType: hard -"marked@npm:^4.0.19": - version: 4.1.0 - resolution: "marked@npm:4.1.0" - bin: - marked: bin/marked.js - checksum: f0b3732a9d6208c933541342e60eb78029bd046c143a6ade0e76ed80b6174f92b186205a9dfe805e435070806ec475b0e87e62d04348eafd2f761c24281b192a - languageName: node - linkType: hard - "meow@npm:^6.0.0": version: 6.1.1 resolution: "meow@npm:6.1.1" @@ -2899,7 +2855,7 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:^5.0.1, minimatch@npm:^5.1.0": +"minimatch@npm:^5.0.1": version: 5.1.0 resolution: "minimatch@npm:5.1.0" dependencies: @@ -2919,13 +2875,6 @@ __metadata: languageName: node linkType: hard -"minimist@npm:^1.2.5": - version: 1.2.6 - resolution: "minimist@npm:1.2.6" - checksum: d15428cd1e11eb14e1233bcfb88ae07ed7a147de251441d61158619dfb32c4d7e9061d09cab4825fdee18ecd6fce323228c8c47b5ba7cd20af378ca4048fb3fb - languageName: node - linkType: hard - "minipass-collect@npm:^1.0.2": version: 1.0.2 resolution: "minipass-collect@npm:1.0.2" @@ -3044,13 +2993,6 @@ __metadata: languageName: node linkType: hard -"neo-async@npm:^2.6.0": - version: 2.6.2 - resolution: "neo-async@npm:2.6.2" - checksum: deac9f8d00eda7b2e5cd1b2549e26e10a0faa70adaa6fdadca701cc55f49ee9018e427f424bac0c790b7c7e2d3068db97f3093f1093975f2acb8f8818b936ed9 - languageName: node - linkType: hard - "node-fetch@npm:2.6.7": version: 2.6.7 resolution: "node-fetch@npm:2.6.7" @@ -3730,17 +3672,6 @@ __metadata: languageName: node linkType: hard -"shiki@npm:^0.11.1": - version: 0.11.1 - resolution: "shiki@npm:0.11.1" - dependencies: - jsonc-parser: ^3.0.0 - vscode-oniguruma: ^1.6.1 - vscode-textmate: ^6.0.0 - checksum: 2a4ebc3b466816263fc244ae4f67a4ff96aa74d863b9c5e7e4affc50f37fd6d1a781405de0dbf763b777bc33e49a0d441de7ff3fededb8b01e3b8dbb37e2927d - languageName: node - linkType: hard - "side-channel@npm:^1.0.4": version: 1.0.4 resolution: "side-channel@npm:1.0.4" @@ -3829,7 +3760,7 @@ __metadata: languageName: node linkType: hard -"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1": +"source-map@npm:^0.6.0, source-map@npm:~0.6.1": version: 0.6.1 resolution: "source-map@npm:0.6.1" checksum: 59ce8640cf3f3124f64ac289012c2b8bd377c238e316fb323ea22fbfe83da07d81e000071d7242cad7a23cd91c7de98e4df8830ec3f133cb6133a5f6e9f67bc2 @@ -4222,42 +4153,6 @@ __metadata: languageName: node linkType: hard -"typedoc-plugin-markdown@npm:3.13.6": - version: 3.13.6 - resolution: "typedoc-plugin-markdown@npm:3.13.6" - dependencies: - handlebars: ^4.7.7 - peerDependencies: - typedoc: ">=0.23.0" - checksum: eae59997759f485b2a6f2c306dc6de47dc0b008acc4651d66a24b8ba31fc7fd7729b69ba0b1235aaab268931701510ef5af88588f9b3ea124166a2ca7b63f954 - languageName: node - linkType: hard - -"typedoc-plugin-missing-exports@npm:1.0.0": - version: 1.0.0 - resolution: "typedoc-plugin-missing-exports@npm:1.0.0" - peerDependencies: - typedoc: 0.22.x || 0.23.x - checksum: 11ef3ba347a88924397f2f2f84216e5d41f9714baba671e4f9a86dd4de22d5e5e47477a295776c4f489be91065a152fedcbfa9aa6cba90499894e6670441ce31 - languageName: node - linkType: hard - -"typedoc@npm:0.23.16": - version: 0.23.16 - resolution: "typedoc@npm:0.23.16" - dependencies: - lunr: ^2.3.9 - marked: ^4.0.19 - minimatch: ^5.1.0 - shiki: ^0.11.1 - peerDependencies: - typescript: 4.6.x || 4.7.x || 4.8.x - bin: - typedoc: bin/typedoc - checksum: 3574ee4a5fe3ca485b8a7d18cbe745bffe6d21886fcbc09c59551d0442d90b6391d435b06245199293914500c4f237fd0e7cc3eec678f1f8ee796b88b3d96089 - languageName: node - linkType: hard - "typescript@npm:4.8.4, typescript@npm:~4.8.4": version: 4.8.4 resolution: "typescript@npm:4.8.4" @@ -4278,15 +4173,6 @@ __metadata: languageName: node linkType: hard -"uglify-js@npm:^3.1.4": - version: 3.17.0 - resolution: "uglify-js@npm:3.17.0" - bin: - uglifyjs: bin/uglifyjs - checksum: 20d1fcac05e74db949a9579a36f9a1af88430e590bc9c22410b76686035c55cef65247ca1935d2f6440c78928227684219c8b1ddfcd858213049cb2890821392 - languageName: node - linkType: hard - "unbox-primitive@npm:^1.0.2": version: 1.0.2 resolution: "unbox-primitive@npm:1.0.2" @@ -4357,20 +4243,6 @@ __metadata: languageName: node linkType: hard -"vscode-oniguruma@npm:^1.6.1": - version: 1.6.2 - resolution: "vscode-oniguruma@npm:1.6.2" - checksum: 6b754acdafd5b68242ea5938bb00a32effc16c77f471d4f0f337d879d0e8e592622998e2441f42d9a7ff799c1593f31c11f26ca8d9bf9917e3ca881d3c1f3e19 - languageName: node - linkType: hard - -"vscode-textmate@npm:^6.0.0": - version: 6.0.0 - resolution: "vscode-textmate@npm:6.0.0" - checksum: ff6f17a406c2906586afc14ef01cb122e33acd35312e815abb5c924347a777c6783ce3fe7db8b83f1760ebf843c669843b9390f905b69c433b3395af28e4b483 - languageName: node - linkType: hard - "wcwidth@npm:^1.0.1": version: 1.0.1 resolution: "wcwidth@npm:1.0.1" @@ -4476,13 +4348,6 @@ __metadata: languageName: node linkType: hard -"wordwrap@npm:^1.0.0": - version: 1.0.0 - resolution: "wordwrap@npm:1.0.0" - checksum: 2a44b2788165d0a3de71fd517d4880a8e20ea3a82c080ce46e294f0b68b69a2e49cff5f99c600e275c698a90d12c5ea32aff06c311f0db2eb3f1201f3e7b2a04 - languageName: node - linkType: hard - "wrap-ansi@npm:^6.2.0": version: 6.2.0 resolution: "wrap-ansi@npm:6.2.0" From bcfa76093af395d0b0d0b9b5fda81c9c3cd2e810 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 12:09:34 +0100 Subject: [PATCH 04/33] commit docs --- .gitignore | 3 +- api-extractor.json | 2 +- docs/index.md | 12 + docs/js.anyid.md | 13 + docs/js.api.md | 11 + docs/js.apiauthentication.md | 13 + docs/js.apiauthenticationprefix.md | 15 + docs/js.apiclient._constructor_.md | 20 ++ docs/js.apiclient.authtype.md | 11 + docs/js.apiclient.delete.md | 153 ++++++++ docs/js.apiclient.get.md | 400 +++++++++++++++++++++ docs/js.apiclient.getauthtype.md | 22 ++ docs/js.apiclient.md | 37 ++ docs/js.apiclient.patch.md | 84 +++++ docs/js.apiclient.post.md | 263 ++++++++++++++ docs/js.apiclient.put.md | 124 +++++++ docs/js.apiclient.raw.md | 22 ++ docs/js.apiclient.url.md | 11 + docs/js.apiclientoptions.authentication.md | 11 + docs/js.apiclientoptions.baseurl.md | 11 + docs/js.apiclientoptions.md | 19 + docs/js.apiresponse.md | 13 + docs/js.assertid.md | 30 ++ docs/js.auth.md | 21 ++ docs/js.auth.password.md | 11 + docs/js.auth.username.md | 11 + docs/js.broad_permissions_map.md | 23 ++ docs/js.build.deployment_id.md | 13 + docs/js.build.digest.md | 13 + docs/js.build.finished_at.md | 13 + docs/js.build.id.md | 13 + docs/js.build.md | 25 ++ docs/js.build.metadata.md | 13 + docs/js.build.method.md | 13 + docs/js.build.started_at.md | 13 + docs/js.build.state.md | 13 + docs/js.buildmetadata.account_type.md | 13 + docs/js.buildmetadata.author.md | 16 + docs/js.buildmetadata.branch.md | 13 + docs/js.buildmetadata.commit_msg.md | 13 + docs/js.buildmetadata.commit_sha.md | 13 + docs/js.buildmetadata.commit_url.md | 13 + docs/js.buildmetadata.md | 25 ++ docs/js.buildmetadata.repo_id.md | 13 + docs/js.buildmetadata.repo_name.md | 13 + docs/js.buildmethod.md | 21 ++ docs/js.buildstate.md | 21 ++ docs/js.bytesizestring.md | 13 + docs/js.bytestring.md | 17 + docs/js.byteunit.md | 15 + docs/js.byteunits.md | 11 + docs/js.channel.capabilities.md | 13 + docs/js.channel.created_at.md | 13 + docs/js.channel.id.md | 13 + docs/js.channel.md | 23 ++ docs/js.channel.project.md | 13 + docs/js.channel.state.md | 13 + docs/js.channel.type.md | 13 + docs/js.channelendpoints.md | 123 +++++++ docs/js.channels.md | 11 + docs/js.channeltoken.id.md | 13 + docs/js.channeltoken.is_online.md | 13 + docs/js.channeltoken.md | 21 ++ docs/js.channeltoken.project_id.md | 13 + docs/js.channeltoken.state.md | 13 + docs/js.channeltype.md | 20 ++ docs/js.container.created_at.md | 13 + docs/js.container.deployment_id.md | 13 + docs/js.container.id.md | 13 + docs/js.container.internal_ip.md | 13 + docs/js.container.md | 27 ++ docs/js.container.metadata.md | 15 + docs/js.container.region.md | 13 + docs/js.container.state.md | 13 + docs/js.container.type.md | 13 + docs/js.container.uptime.md | 15 + docs/js.container.volume.md | 13 + docs/js.containerlog.level.md | 13 + docs/js.containerlog.md | 23 ++ docs/js.containerlog.message.md | 13 + docs/js.containerlog.nonce.md | 13 + docs/js.containerlog.timestamp.md | 13 + docs/js.containerstate.md | 25 ++ docs/js.default_base_url.md | 13 + docs/js.defaultquotas.md | 19 + docs/js.defaultquotas.ram.md | 11 + docs/js.defaultquotas.vcpu.md | 11 + docs/js.deliveryprotocol.md | 11 + docs/js.deployment.active_build.md | 13 + docs/js.deployment.active_rollout.md | 13 + docs/js.deployment.config.md | 13 + docs/js.deployment.container_count.md | 13 + docs/js.deployment.created_at.md | 13 + docs/js.deployment.id.md | 13 + docs/js.deployment.md | 24 ++ docs/js.deployment.name.md | 13 + docs/js.deploymentconfig.md | 23 ++ docs/js.deploymentrollout.md | 20 ++ docs/js.domain.created_at.md | 13 + docs/js.domain.domain.md | 13 + docs/js.domain.id.md | 13 + docs/js.domain.md | 21 ++ docs/js.domain.state.md | 13 + docs/js.domainstate.md | 20 ++ docs/js.empty.md | 11 + docs/js.endpoint.md | 23 ++ docs/js.endpoints.md | 19 + docs/js.erroredapiresponse.md | 17 + docs/js.extractrouteparams.md | 23 ++ docs/js.gateway.created_at.md | 13 + docs/js.gateway.deployment_id.md | 13 + docs/js.gateway.domains.md | 13 + docs/js.gateway.hopsh_domain.md | 13 + docs/js.gateway.id.md | 13 + docs/js.gateway.internal_domain.md | 13 + docs/js.gateway.md | 28 ++ docs/js.gateway.name.md | 13 + docs/js.gateway.target_port.md | 13 + docs/js.gateway.type.md | 13 + docs/js.gatewaytype.md | 21 ++ docs/js.getidprefix.md | 23 ++ docs/js.ghrepo.account_name.md | 11 + docs/js.ghrepo.default_branch.md | 11 + docs/js.ghrepo.full_name.md | 11 + docs/js.ghrepo.id.md | 11 + docs/js.ghrepo.md | 24 ++ docs/js.ghrepo.private.md | 11 + docs/js.hop._constructor_.md | 20 ++ docs/js.hop._constructor__1.md | 21 ++ docs/js.hop.channels.md | 104 ++++++ docs/js.hop.client.md | 11 + docs/js.hop.ignite.md | 146 ++++++++ docs/js.hop.md | 41 +++ docs/js.hop.pipe.md | 39 ++ docs/js.hop.projects.md | 58 +++ docs/js.hop.registry.md | 26 ++ docs/js.hop.users.md | 25 ++ docs/js.hopapierror._constructor_.md | 22 ++ docs/js.hopapierror.data.md | 11 + docs/js.hopapierror.md | 28 ++ docs/js.hopapierror.request.md | 11 + docs/js.hopapierror.response.md | 11 + docs/js.hopapierror.status.md | 11 + docs/js.hopshdomain.md | 11 + docs/js.id.md | 13 + docs/js.id_prefixes.md | 84 +++++ docs/js.idprefixes.md | 13 + docs/js.ignite.md | 11 + docs/js.igniteendpoints.md | 124 +++++++ docs/js.image_2.auth.md | 13 + docs/js.image_2.gh_repo.md | 13 + docs/js.image_2.md | 22 ++ docs/js.image_2.name.md | 13 + docs/js.imageghrepo.branch.md | 11 + docs/js.imageghrepo.full_name.md | 11 + docs/js.imageghrepo.md | 22 ++ docs/js.imageghrepo.repo_id.md | 11 + docs/js.internalhopdomain.md | 11 + docs/js.is_browser.md | 13 + docs/js.isvalidbytestring.md | 22 ++ docs/js.md | 145 ++++++++ docs/js.member.md | 17 + docs/js.memberrole.flags.md | 13 + docs/js.memberrole.id.md | 13 + docs/js.memberrole.md | 20 ++ docs/js.memberrole.name.md | 13 + docs/js.method.md | 11 + docs/js.parsesize.md | 24 ++ docs/js.partialapioptions.md | 16 + docs/js.pat.created_at.md | 13 + docs/js.pat.id.md | 13 + docs/js.pat.md | 20 ++ docs/js.pat.name.md | 13 + docs/js.permissions.md | 15 + docs/js.permissionsmap.md | 56 +++ docs/js.pipe.md | 11 + docs/js.pipeendpoints.md | 40 +++ docs/js.project.created_at.md | 13 + docs/js.project.default_quotas.md | 11 + docs/js.project.icon.md | 13 + docs/js.project.id.md | 13 + docs/js.project.md | 27 ++ docs/js.project.name.md | 13 + docs/js.project.namespace.md | 13 + docs/js.project.quota_overrides.md | 11 + docs/js.project.quota_usage.md | 11 + docs/js.project.tier.md | 13 + docs/js.project.type.md | 13 + docs/js.project_permission.md | 61 ++++ docs/js.projects.md | 11 + docs/js.projectsendpoints.md | 110 ++++++ docs/js.projecttier.md | 19 + docs/js.projecttoken.created_at.md | 13 + docs/js.projecttoken.flags.md | 13 + docs/js.projecttoken.id.md | 13 + docs/js.projecttoken.md | 23 ++ docs/js.projecttoken.token.md | 13 + docs/js.projecttype.md | 21 ++ docs/js.query.md | 14 + docs/js.quotaoverrides.md | 11 + docs/js.quotausage.md | 19 + docs/js.quotausage.ram.md | 11 + docs/js.quotausage.vcpu.md | 11 + docs/js.regions.md | 18 + docs/js.registry.md | 11 + docs/js.registryendpoints.md | 35 ++ docs/js.resources.md | 22 ++ docs/js.resources.ram.md | 13 + docs/js.resources.vcpu.md | 13 + docs/js.resources.vgpu.md | 13 + docs/js.restartpolicy.md | 22 ++ docs/js.roles.md | 16 + docs/js.rolloutstate.md | 22 ++ docs/js.room.created_at.md | 13 + docs/js.room.delivery_protocols.md | 13 + docs/js.room.id.md | 13 + docs/js.room.ingest_endpoint.md | 13 + docs/js.room.ingest_protocol.md | 13 + docs/js.room.ingest_region.md | 13 + docs/js.room.join_token.md | 13 + docs/js.room.md | 26 ++ docs/js.room.name.md | 13 + docs/js.room.state.md | 13 + docs/js.runtimetype.md | 22 ++ docs/js.secret.created_at.md | 13 + docs/js.secret.digest.md | 13 + docs/js.secret.id.md | 13 + docs/js.secret.md | 21 ++ docs/js.secret.name.md | 13 + docs/js.state.md | 11 + docs/js.successfulapiresponse.md | 14 + docs/js.supports_intl.md | 11 + docs/js.tag.md | 13 + docs/js.timestamp.md | 15 + docs/js.units.md | 16 + docs/js.user.email.md | 13 + docs/js.user.id.md | 13 + docs/js.user.md | 23 ++ docs/js.user.name.md | 13 + docs/js.user.username.md | 13 + docs/js.userendpoints.md | 41 +++ docs/js.users.md | 11 + docs/js.validateapiauthentication.md | 24 ++ docs/js.validateid.md | 30 ++ docs/js.validateidprefix.md | 30 ++ docs/js.values.md | 11 + docs/js.vgpu.count.md | 13 + docs/js.vgpu.md | 21 ++ docs/js.vgpu.type.md | 13 + docs/js.vgputype.md | 20 ++ docs/js.volumedefinition.fs.md | 13 + docs/js.volumedefinition.md | 20 ++ docs/js.volumedefinition.mount_path.md | 13 + docs/js.volumedefinition.size.md | 13 + docs/js.volumeformat.md | 19 + next-env.d.ts | 5 + package.json | 7 +- renovate.json | 6 +- tsconfig.json | 1 - yarn.lock | 41 ++- 260 files changed, 5870 insertions(+), 21 deletions(-) create mode 100644 docs/index.md create mode 100644 docs/js.anyid.md create mode 100644 docs/js.api.md create mode 100644 docs/js.apiauthentication.md create mode 100644 docs/js.apiauthenticationprefix.md create mode 100644 docs/js.apiclient._constructor_.md create mode 100644 docs/js.apiclient.authtype.md create mode 100644 docs/js.apiclient.delete.md create mode 100644 docs/js.apiclient.get.md create mode 100644 docs/js.apiclient.getauthtype.md create mode 100644 docs/js.apiclient.md create mode 100644 docs/js.apiclient.patch.md create mode 100644 docs/js.apiclient.post.md create mode 100644 docs/js.apiclient.put.md create mode 100644 docs/js.apiclient.raw.md create mode 100644 docs/js.apiclient.url.md create mode 100644 docs/js.apiclientoptions.authentication.md create mode 100644 docs/js.apiclientoptions.baseurl.md create mode 100644 docs/js.apiclientoptions.md create mode 100644 docs/js.apiresponse.md create mode 100644 docs/js.assertid.md create mode 100644 docs/js.auth.md create mode 100644 docs/js.auth.password.md create mode 100644 docs/js.auth.username.md create mode 100644 docs/js.broad_permissions_map.md create mode 100644 docs/js.build.deployment_id.md create mode 100644 docs/js.build.digest.md create mode 100644 docs/js.build.finished_at.md create mode 100644 docs/js.build.id.md create mode 100644 docs/js.build.md create mode 100644 docs/js.build.metadata.md create mode 100644 docs/js.build.method.md create mode 100644 docs/js.build.started_at.md create mode 100644 docs/js.build.state.md create mode 100644 docs/js.buildmetadata.account_type.md create mode 100644 docs/js.buildmetadata.author.md create mode 100644 docs/js.buildmetadata.branch.md create mode 100644 docs/js.buildmetadata.commit_msg.md create mode 100644 docs/js.buildmetadata.commit_sha.md create mode 100644 docs/js.buildmetadata.commit_url.md create mode 100644 docs/js.buildmetadata.md create mode 100644 docs/js.buildmetadata.repo_id.md create mode 100644 docs/js.buildmetadata.repo_name.md create mode 100644 docs/js.buildmethod.md create mode 100644 docs/js.buildstate.md create mode 100644 docs/js.bytesizestring.md create mode 100644 docs/js.bytestring.md create mode 100644 docs/js.byteunit.md create mode 100644 docs/js.byteunits.md create mode 100644 docs/js.channel.capabilities.md create mode 100644 docs/js.channel.created_at.md create mode 100644 docs/js.channel.id.md create mode 100644 docs/js.channel.md create mode 100644 docs/js.channel.project.md create mode 100644 docs/js.channel.state.md create mode 100644 docs/js.channel.type.md create mode 100644 docs/js.channelendpoints.md create mode 100644 docs/js.channels.md create mode 100644 docs/js.channeltoken.id.md create mode 100644 docs/js.channeltoken.is_online.md create mode 100644 docs/js.channeltoken.md create mode 100644 docs/js.channeltoken.project_id.md create mode 100644 docs/js.channeltoken.state.md create mode 100644 docs/js.channeltype.md create mode 100644 docs/js.container.created_at.md create mode 100644 docs/js.container.deployment_id.md create mode 100644 docs/js.container.id.md create mode 100644 docs/js.container.internal_ip.md create mode 100644 docs/js.container.md create mode 100644 docs/js.container.metadata.md create mode 100644 docs/js.container.region.md create mode 100644 docs/js.container.state.md create mode 100644 docs/js.container.type.md create mode 100644 docs/js.container.uptime.md create mode 100644 docs/js.container.volume.md create mode 100644 docs/js.containerlog.level.md create mode 100644 docs/js.containerlog.md create mode 100644 docs/js.containerlog.message.md create mode 100644 docs/js.containerlog.nonce.md create mode 100644 docs/js.containerlog.timestamp.md create mode 100644 docs/js.containerstate.md create mode 100644 docs/js.default_base_url.md create mode 100644 docs/js.defaultquotas.md create mode 100644 docs/js.defaultquotas.ram.md create mode 100644 docs/js.defaultquotas.vcpu.md create mode 100644 docs/js.deliveryprotocol.md create mode 100644 docs/js.deployment.active_build.md create mode 100644 docs/js.deployment.active_rollout.md create mode 100644 docs/js.deployment.config.md create mode 100644 docs/js.deployment.container_count.md create mode 100644 docs/js.deployment.created_at.md create mode 100644 docs/js.deployment.id.md create mode 100644 docs/js.deployment.md create mode 100644 docs/js.deployment.name.md create mode 100644 docs/js.deploymentconfig.md create mode 100644 docs/js.deploymentrollout.md create mode 100644 docs/js.domain.created_at.md create mode 100644 docs/js.domain.domain.md create mode 100644 docs/js.domain.id.md create mode 100644 docs/js.domain.md create mode 100644 docs/js.domain.state.md create mode 100644 docs/js.domainstate.md create mode 100644 docs/js.empty.md create mode 100644 docs/js.endpoint.md create mode 100644 docs/js.endpoints.md create mode 100644 docs/js.erroredapiresponse.md create mode 100644 docs/js.extractrouteparams.md create mode 100644 docs/js.gateway.created_at.md create mode 100644 docs/js.gateway.deployment_id.md create mode 100644 docs/js.gateway.domains.md create mode 100644 docs/js.gateway.hopsh_domain.md create mode 100644 docs/js.gateway.id.md create mode 100644 docs/js.gateway.internal_domain.md create mode 100644 docs/js.gateway.md create mode 100644 docs/js.gateway.name.md create mode 100644 docs/js.gateway.target_port.md create mode 100644 docs/js.gateway.type.md create mode 100644 docs/js.gatewaytype.md create mode 100644 docs/js.getidprefix.md create mode 100644 docs/js.ghrepo.account_name.md create mode 100644 docs/js.ghrepo.default_branch.md create mode 100644 docs/js.ghrepo.full_name.md create mode 100644 docs/js.ghrepo.id.md create mode 100644 docs/js.ghrepo.md create mode 100644 docs/js.ghrepo.private.md create mode 100644 docs/js.hop._constructor_.md create mode 100644 docs/js.hop._constructor__1.md create mode 100644 docs/js.hop.channels.md create mode 100644 docs/js.hop.client.md create mode 100644 docs/js.hop.ignite.md create mode 100644 docs/js.hop.md create mode 100644 docs/js.hop.pipe.md create mode 100644 docs/js.hop.projects.md create mode 100644 docs/js.hop.registry.md create mode 100644 docs/js.hop.users.md create mode 100644 docs/js.hopapierror._constructor_.md create mode 100644 docs/js.hopapierror.data.md create mode 100644 docs/js.hopapierror.md create mode 100644 docs/js.hopapierror.request.md create mode 100644 docs/js.hopapierror.response.md create mode 100644 docs/js.hopapierror.status.md create mode 100644 docs/js.hopshdomain.md create mode 100644 docs/js.id.md create mode 100644 docs/js.id_prefixes.md create mode 100644 docs/js.idprefixes.md create mode 100644 docs/js.ignite.md create mode 100644 docs/js.igniteendpoints.md create mode 100644 docs/js.image_2.auth.md create mode 100644 docs/js.image_2.gh_repo.md create mode 100644 docs/js.image_2.md create mode 100644 docs/js.image_2.name.md create mode 100644 docs/js.imageghrepo.branch.md create mode 100644 docs/js.imageghrepo.full_name.md create mode 100644 docs/js.imageghrepo.md create mode 100644 docs/js.imageghrepo.repo_id.md create mode 100644 docs/js.internalhopdomain.md create mode 100644 docs/js.is_browser.md create mode 100644 docs/js.isvalidbytestring.md create mode 100644 docs/js.md create mode 100644 docs/js.member.md create mode 100644 docs/js.memberrole.flags.md create mode 100644 docs/js.memberrole.id.md create mode 100644 docs/js.memberrole.md create mode 100644 docs/js.memberrole.name.md create mode 100644 docs/js.method.md create mode 100644 docs/js.parsesize.md create mode 100644 docs/js.partialapioptions.md create mode 100644 docs/js.pat.created_at.md create mode 100644 docs/js.pat.id.md create mode 100644 docs/js.pat.md create mode 100644 docs/js.pat.name.md create mode 100644 docs/js.permissions.md create mode 100644 docs/js.permissionsmap.md create mode 100644 docs/js.pipe.md create mode 100644 docs/js.pipeendpoints.md create mode 100644 docs/js.project.created_at.md create mode 100644 docs/js.project.default_quotas.md create mode 100644 docs/js.project.icon.md create mode 100644 docs/js.project.id.md create mode 100644 docs/js.project.md create mode 100644 docs/js.project.name.md create mode 100644 docs/js.project.namespace.md create mode 100644 docs/js.project.quota_overrides.md create mode 100644 docs/js.project.quota_usage.md create mode 100644 docs/js.project.tier.md create mode 100644 docs/js.project.type.md create mode 100644 docs/js.project_permission.md create mode 100644 docs/js.projects.md create mode 100644 docs/js.projectsendpoints.md create mode 100644 docs/js.projecttier.md create mode 100644 docs/js.projecttoken.created_at.md create mode 100644 docs/js.projecttoken.flags.md create mode 100644 docs/js.projecttoken.id.md create mode 100644 docs/js.projecttoken.md create mode 100644 docs/js.projecttoken.token.md create mode 100644 docs/js.projecttype.md create mode 100644 docs/js.query.md create mode 100644 docs/js.quotaoverrides.md create mode 100644 docs/js.quotausage.md create mode 100644 docs/js.quotausage.ram.md create mode 100644 docs/js.quotausage.vcpu.md create mode 100644 docs/js.regions.md create mode 100644 docs/js.registry.md create mode 100644 docs/js.registryendpoints.md create mode 100644 docs/js.resources.md create mode 100644 docs/js.resources.ram.md create mode 100644 docs/js.resources.vcpu.md create mode 100644 docs/js.resources.vgpu.md create mode 100644 docs/js.restartpolicy.md create mode 100644 docs/js.roles.md create mode 100644 docs/js.rolloutstate.md create mode 100644 docs/js.room.created_at.md create mode 100644 docs/js.room.delivery_protocols.md create mode 100644 docs/js.room.id.md create mode 100644 docs/js.room.ingest_endpoint.md create mode 100644 docs/js.room.ingest_protocol.md create mode 100644 docs/js.room.ingest_region.md create mode 100644 docs/js.room.join_token.md create mode 100644 docs/js.room.md create mode 100644 docs/js.room.name.md create mode 100644 docs/js.room.state.md create mode 100644 docs/js.runtimetype.md create mode 100644 docs/js.secret.created_at.md create mode 100644 docs/js.secret.digest.md create mode 100644 docs/js.secret.id.md create mode 100644 docs/js.secret.md create mode 100644 docs/js.secret.name.md create mode 100644 docs/js.state.md create mode 100644 docs/js.successfulapiresponse.md create mode 100644 docs/js.supports_intl.md create mode 100644 docs/js.tag.md create mode 100644 docs/js.timestamp.md create mode 100644 docs/js.units.md create mode 100644 docs/js.user.email.md create mode 100644 docs/js.user.id.md create mode 100644 docs/js.user.md create mode 100644 docs/js.user.name.md create mode 100644 docs/js.user.username.md create mode 100644 docs/js.userendpoints.md create mode 100644 docs/js.users.md create mode 100644 docs/js.validateapiauthentication.md create mode 100644 docs/js.validateid.md create mode 100644 docs/js.validateidprefix.md create mode 100644 docs/js.values.md create mode 100644 docs/js.vgpu.count.md create mode 100644 docs/js.vgpu.md create mode 100644 docs/js.vgpu.type.md create mode 100644 docs/js.vgputype.md create mode 100644 docs/js.volumedefinition.fs.md create mode 100644 docs/js.volumedefinition.md create mode 100644 docs/js.volumedefinition.mount_path.md create mode 100644 docs/js.volumedefinition.size.md create mode 100644 docs/js.volumeformat.md create mode 100644 next-env.d.ts diff --git a/.gitignore b/.gitignore index b62e4494..80a4b1cb 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,5 @@ node_modules dist _workbench.ts .env -docs +.temp +.next diff --git a/api-extractor.json b/api-extractor.json index 1577b856..ccbf8401 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -13,7 +13,7 @@ "docModel": { "enabled": true, - "apiJsonFilePath": "/docs/js.api.json" + "apiJsonFilePath": "/.temp/js.api.json" }, "dtsRollup": { diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..68578b1b --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ + + +[Home](./index.md) + +## API Reference + +## Packages + +| Package | Description | +| --- | --- | +| [@onehop/js](./js.md) | | + diff --git a/docs/js.anyid.md b/docs/js.anyid.md new file mode 100644 index 00000000..1a818b72 --- /dev/null +++ b/docs/js.anyid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [AnyId](./js.anyid.md) + +## AnyId type + +Signature: + +```typescript +declare type AnyId = Id; +``` +References: [Id](./js.id.md), [IdPrefixes](./js.idprefixes.md) + diff --git a/docs/js.api.md b/docs/js.api.md new file mode 100644 index 00000000..3416e85f --- /dev/null +++ b/docs/js.api.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [API](./js.api.md) + +## API namespace + +Signature: + +```typescript +declare namespace api +``` diff --git a/docs/js.apiauthentication.md b/docs/js.apiauthentication.md new file mode 100644 index 00000000..d900aec7 --- /dev/null +++ b/docs/js.apiauthentication.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthentication](./js.apiauthentication.md) + +## APIAuthentication type + +Signature: + +```typescript +declare type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; +``` +References: [Id](./js.id.md) + diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md new file mode 100644 index 00000000..3bb3f2de --- /dev/null +++ b/docs/js.apiauthenticationprefix.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) + +## APIAuthenticationPrefix type + +Signature: + +```typescript +declare type APIAuthenticationPrefix = APIAuthentication extends Id + ? T + : never; +``` +References: [APIAuthentication](./js.apiauthentication.md), [Id](./js.id.md) + diff --git a/docs/js.apiclient._constructor_.md b/docs/js.apiclient._constructor_.md new file mode 100644 index 00000000..4d08fdcf --- /dev/null +++ b/docs/js.apiclient._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [(constructor)](./js.apiclient._constructor_.md) + +## APIClient.(constructor) + +Constructs a new instance of the `APIClient` class + +Signature: + +```typescript +constructor(options: APIClientOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [APIClientOptions](./js.apiclientoptions.md) | | + diff --git a/docs/js.apiclient.authtype.md b/docs/js.apiclient.authtype.md new file mode 100644 index 00000000..47d6edc1 --- /dev/null +++ b/docs/js.apiclient.authtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [authType](./js.apiclient.authtype.md) + +## APIClient.authType property + +Signature: + +```typescript +readonly authType: 'ptk' | 'pat' | 'bearer'; +``` diff --git a/docs/js.apiclient.delete.md b/docs/js.apiclient.delete.md new file mode 100644 index 00000000..0fd0f08e --- /dev/null +++ b/docs/js.apiclient.delete.md @@ -0,0 +1,153 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [delete](./js.apiclient.delete.md) + +## APIClient.delete() method + +Signature: + +```typescript +delete< + Path extends Extract< + Endpoints, + { + method: 'DELETE'; + } + >['path'], + >( + path: Path, + body: Extract< + Endpoints, + { + path: Path; + method: 'DELETE'; + } + >['body'], + query: Query, + init?: RequestInit, + ): Promise< + ( + | Extract< + Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', void, undefined>, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/projects/:project_id/tokens/:project_token_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/projects/@this/tokens/:project_token_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/projects/:project_id/secrets/:secret_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/projects/@this/secrets/:secret_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint<'DELETE', '/v1/channels/:channel_id', void, undefined>, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint<'DELETE', '/v1/channels/tokens/:token', void, undefined>, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint<'DELETE', '/v1/registry/images/:image', void, undefined>, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/ignite/deployments/:deployment_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint< + 'DELETE', + '/v1/ignite/containers/:container_id', + void, + undefined + >, + { + path: Path; + method: 'DELETE'; + } + > + | Extract< + Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', void, undefined>, + { + path: Path; + method: 'DELETE'; + } + > + )['res'] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; } >\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise< ( \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/users/@me/pats/:pat\_id', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/:project\_id/tokens/:project\_token\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/@this/tokens/:project\_token\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/:project\_id/secrets/:secret\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/@this/secrets/:secret\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/channels/:channel\_id', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/channels/tokens/:token', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/registry/images/:image', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/ignite/deployments/:deployment\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/ignite/containers/:container\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/pipe/rooms/:room\_id', void, undefined>, { path: Path; method: 'DELETE'; } > )\['res'\] > + diff --git a/docs/js.apiclient.get.md b/docs/js.apiclient.get.md new file mode 100644 index 00000000..8ae09a7c --- /dev/null +++ b/docs/js.apiclient.get.md @@ -0,0 +1,400 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [get](./js.apiclient.get.md) + +## APIClient.get() method + +Signature: + +```typescript +get< + Path extends Extract< + Endpoints, + { + method: 'GET'; + } + >['path'], + >( + path: Path, + query: Query, + init?: RequestInit, + ): Promise< + ( + | Extract< + Endpoint< + 'GET', + '/v1/users/@me', + { + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/users/@me/pats', + { + pats: PAT[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/:project_id/members/@me', + { + project_member: Member; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/:project_id/tokens', + { + project_tokens: ProjectToken[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/@this/tokens', + { + project_tokens: ProjectToken[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/:project_id/members', + { + members: Member[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/@this/members', + { + members: Member[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/:project_id/secrets', + { + secrets: Secret[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/projects/@this/secrets', + { + secrets: Secret[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels/:channel_id', + { + channel: Channel; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels/:channel_id/tokens', + { + tokens: ChannelToken[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels/:channel_id/state', + { + state: State; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels', + { + channels: Channel[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels/tokens/:token', + { + token: ChannelToken; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/channels/:channel_id/stats', + { + stats: { + online_count: number; + }; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/registry/images', + { + images: string[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/registry/images/:image/manifests', + { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/deployments', + { + deployments: Deployment[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id/containers', + { + containers: Container[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/containers/:container_id/logs', + { + logs: ContainerLog[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/deployments/search', + { + deployment: Deployment; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id', + { + deployment: Deployment; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/gateways/:gateway_id', + { + gateway: Gateway; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id/gateways', + { + gateways: Gateway[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + | Extract< + Endpoint< + 'GET', + '/v1/pipe/rooms', + { + rooms: Room[]; + }, + undefined + >, + { + path: Path; + method: 'GET'; + } + > + )['res'] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/users/@me', { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/users/@me/pats', { pats: [PAT](./js.pat.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/members/@me', { project\_member: [Member](./js.member.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/tokens', { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/tokens', { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/members', { members: [Member](./js.member.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/members', { members: [Member](./js.member.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/secrets', { secrets: [Secret](./js.secret.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/secrets', { secrets: [Secret](./js.secret.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id', { channel: [Channel](./js.channel.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/tokens', { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/state', { state: [State](./js.state.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels', { channels: [Channel](./js.channel.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/tokens/:token', { token: [ChannelToken](./js.channeltoken.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/stats', { stats: { online\_count: number; }; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/registry/images', { images: string\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/registry/images/:image/manifests', { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments', { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id/containers', { containers: [Container](./js.container.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/containers/:container\_id/logs', { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/search', { deployment: [Deployment](./js.deployment.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id', { deployment: [Deployment](./js.deployment.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/gateways/:gateway\_id', { gateway: [Gateway](./js.gateway.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id/gateways', { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/pipe/rooms', { rooms: [Room](./js.room.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > )\['res'\] > + diff --git a/docs/js.apiclient.getauthtype.md b/docs/js.apiclient.getauthtype.md new file mode 100644 index 00000000..437c3b1e --- /dev/null +++ b/docs/js.apiclient.getauthtype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [getAuthType](./js.apiclient.getauthtype.md) + +## APIClient.getAuthType() method + +Signature: + +```typescript +static getAuthType(auth: APIAuthentication): 'ptk' | 'pat' | 'bearer'; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | [APIAuthentication](./js.apiauthentication.md) | | + +Returns: + +'ptk' \| 'pat' \| 'bearer' + diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md new file mode 100644 index 00000000..2f5a6583 --- /dev/null +++ b/docs/js.apiclient.md @@ -0,0 +1,37 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) + +## APIClient class + +Signature: + +```typescript +declare class APIClient +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./js.apiclient._constructor_.md) | | Constructs a new instance of the APIClient class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [authType](./js.apiclient.authtype.md) | readonly | 'ptk' \| 'pat' \| 'bearer' | | +| [url](./js.apiclient.url.md) | readonly | <Path extends string>(path: Path, query: [Query](./js.query.md)<Path>) => string | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [delete(path, body, query, init)](./js.apiclient.delete.md) | | | +| [get(path, query, init)](./js.apiclient.get.md) | | | +| [getAuthType(auth)](./js.apiclient.getauthtype.md) | static | | +| [patch(path, body, query, init)](./js.apiclient.patch.md) | | | +| [post(path, body, query, init)](./js.apiclient.post.md) | | | +| [put(path, body, query, init)](./js.apiclient.put.md) | | | +| [raw(request)](./js.apiclient.raw.md) | | | + diff --git a/docs/js.apiclient.patch.md b/docs/js.apiclient.patch.md new file mode 100644 index 00000000..50a4f446 --- /dev/null +++ b/docs/js.apiclient.patch.md @@ -0,0 +1,84 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [patch](./js.apiclient.patch.md) + +## APIClient.patch() method + +Signature: + +```typescript +patch< + Path extends Extract< + Endpoints, + { + method: 'PATCH'; + } + >['path'], + >( + path: Path, + body: Extract< + Endpoints, + { + path: Path; + method: 'PATCH'; + } + >['body'], + query: Query, + init?: RequestInit, + ): Promise< + ( + | Extract< + Endpoint<'PATCH', '/v1/channels/:channel_id/state', void, State>, + { + path: Path; + method: 'PATCH'; + } + > + | Extract< + Endpoint< + 'PATCH', + '/v1/channels/tokens/:token', + { + token: ChannelToken; + }, + { + expiresAt?: Timestamp | null | undefined; + state: State; + } + >, + { + path: Path; + method: 'PATCH'; + } + > + | Extract< + Endpoint< + 'PATCH', + '/v1/ignite/deployments/:deployment_id', + { + deployment: Deployment; + }, + DeploymentConfig + >, + { + path: Path; + method: 'PATCH'; + } + > + )['res'] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; } >\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise< ( \| Extract< [Endpoint](./js.endpoint.md)<'PATCH', '/v1/channels/:channel\_id/state', void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PATCH', '/v1/channels/tokens/:token', { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); } >, { path: Path; method: 'PATCH'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PATCH', '/v1/ignite/deployments/:deployment\_id', { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md) >, { path: Path; method: 'PATCH'; } > )\['res'\] > + diff --git a/docs/js.apiclient.post.md b/docs/js.apiclient.post.md new file mode 100644 index 00000000..33a722c8 --- /dev/null +++ b/docs/js.apiclient.post.md @@ -0,0 +1,263 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [post](./js.apiclient.post.md) + +## APIClient.post() method + +Signature: + +```typescript +post< + Path extends Extract< + Endpoints, + { + method: 'POST'; + } + >['path'], + >( + path: Path, + body: Extract< + Endpoints, + { + path: Path; + method: 'POST'; + } + >['body'], + query: Query, + init?: RequestInit, + ): Promise< + ( + | Extract< + Endpoint< + 'POST', + '/v1/users/@me/pats', + { + pat: PAT; + }, + { + name: string; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/projects/:project_id/tokens', + { + project_token: ProjectToken & { + project: Project; + }; + }, + { + flags: number; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/projects/@this/tokens', + { + project_token: ProjectToken & { + project: Project; + }; + }, + { + flags: number; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/channels', + { + channel: Channel; + }, + { + type: ChannelType; + state: Record | null; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/channels/tokens', + { + token: ChannelToken; + }, + { + state: State; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/channels/tokens/:token/messages', + void, + { + e: string; + d: unknown; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/channels/:channel_id/messages', + void, + { + e: string; + d: unknown; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/containers', + { + container: Container; + }, + undefined + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/containers/:container_id', + never, + { + deployment_id: `deployment_${string}`; + container_id: `container_${string}`; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/ignite/deployments', + { + deployment: Deployment; + }, + DeploymentConfig + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/ignite/gateways/:gateway_id/domains', + void, + { + domain: string; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/gateways', + { + gateway: Gateway; + }, + { + type: GatewayType; + target_port: number; + protocol: 'http' | null; + } + >, + { + path: Path; + method: 'POST'; + } + > + | Extract< + Endpoint< + 'POST', + '/v1/pipe/rooms', + { + room: Room; + }, + { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: + | { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } + | undefined; + } + >, + { + path: Path; + method: 'POST'; + } + > + )['res'] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; } >\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/users/@me/pats', { pat: [PAT](./js.pat.md); }, { name: string; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/projects/:project\_id/tokens', { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/projects/@this/tokens', { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels', { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/tokens', { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/tokens/:token/messages', void, { e: string; d: unknown; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/:channel\_id/messages', void, { e: string; d: unknown; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/containers', { container: [Container](./js.container.md); }, undefined >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/containers/:container\_id', never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments', { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md) >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/gateways/:gateway\_id/domains', void, { domain: string; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/gateways', { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: 'http' \| null; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/pipe/rooms', { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: 'rtmp' \| 'rtp'; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: \| { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; } >, { path: Path; method: 'POST'; } > )\['res'\] > + diff --git a/docs/js.apiclient.put.md b/docs/js.apiclient.put.md new file mode 100644 index 00000000..7b9d32ab --- /dev/null +++ b/docs/js.apiclient.put.md @@ -0,0 +1,124 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [put](./js.apiclient.put.md) + +## APIClient.put() method + +Signature: + +```typescript +put< + Path extends Extract< + Endpoints, + { + method: 'PUT'; + } + >['path'], + >( + path: Path, + body: Extract< + Endpoints, + { + path: Path; + method: 'PUT'; + } + >['body'], + query: Query, + init?: RequestInit, + ): Promise< + ( + | Extract< + Endpoint< + 'PUT', + '/v1/projects/:project_id/secrets/:name', + { + secret: Secret; + }, + string + >, + { + path: Path; + method: 'PUT'; + } + > + | Extract< + Endpoint< + 'PUT', + '/v1/projects/@this/secrets/:name', + { + secret: Secret; + }, + string + >, + { + path: Path; + method: 'PUT'; + } + > + | Extract< + Endpoint< + 'PUT', + '/v1/channels/:channel_id', + { + channel: Channel; + }, + { + type: ChannelType; + state: Record | null; + } + >, + { + path: Path; + method: 'PUT'; + } + > + | Extract< + Endpoint< + 'PUT', + '/v1/channels/:channel_id/subscribers/:token', + void, + undefined + >, + { + path: Path; + method: 'PUT'; + } + > + | Extract< + Endpoint<'PUT', '/v1/channels/:channel_id/state', void, State>, + { + path: Path; + method: 'PUT'; + } + > + | Extract< + Endpoint< + 'PUT', + '/v1/ignite/containers/:container_id/state', + void, + { + preferred_state: ContainerState.RUNNING | ContainerState.STOPPED; + } + >, + { + path: Path; + method: 'PUT'; + } + > + )['res'] + >; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| path | Path | | +| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; } >\['body'\] | | +| query | [Query](./js.query.md)<Path> | | +| init | RequestInit | (Optional) | + +Returns: + +Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/projects/:project\_id/secrets/:name', { secret: [Secret](./js.secret.md); }, string >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/projects/@this/secrets/:name', { secret: [Secret](./js.secret.md); }, string >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/channels/:channel\_id', { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; } >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/channels/:channel\_id/subscribers/:token', void, undefined >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)<'PUT', '/v1/channels/:channel\_id/state', void, [State](./js.state.md)>, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/ignite/containers/:container\_id/state', void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); } >, { path: Path; method: 'PUT'; } > )\['res'\] > + diff --git a/docs/js.apiclient.raw.md b/docs/js.apiclient.raw.md new file mode 100644 index 00000000..68c10574 --- /dev/null +++ b/docs/js.apiclient.raw.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [raw](./js.apiclient.raw.md) + +## APIClient.raw() method + +Signature: + +```typescript +raw(request: Request): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | Request | | + +Returns: + +Promise<T> + diff --git a/docs/js.apiclient.url.md b/docs/js.apiclient.url.md new file mode 100644 index 00000000..72b14f7d --- /dev/null +++ b/docs/js.apiclient.url.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [url](./js.apiclient.url.md) + +## APIClient.url property + +Signature: + +```typescript +readonly url: (path: Path, query: Query) => string; +``` diff --git a/docs/js.apiclientoptions.authentication.md b/docs/js.apiclientoptions.authentication.md new file mode 100644 index 00000000..07b6a1e5 --- /dev/null +++ b/docs/js.apiclientoptions.authentication.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [authentication](./js.apiclientoptions.authentication.md) + +## APIClientOptions.authentication property + +Signature: + +```typescript +readonly authentication: APIAuthentication; +``` diff --git a/docs/js.apiclientoptions.baseurl.md b/docs/js.apiclientoptions.baseurl.md new file mode 100644 index 00000000..1faa1238 --- /dev/null +++ b/docs/js.apiclientoptions.baseurl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [baseUrl](./js.apiclientoptions.baseurl.md) + +## APIClientOptions.baseUrl property + +Signature: + +```typescript +readonly baseUrl: string; +``` diff --git a/docs/js.apiclientoptions.md b/docs/js.apiclientoptions.md new file mode 100644 index 00000000..708447b2 --- /dev/null +++ b/docs/js.apiclientoptions.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) + +## APIClientOptions interface + +Signature: + +```typescript +interface APIClientOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [authentication](./js.apiclientoptions.authentication.md) | readonly | [APIAuthentication](./js.apiauthentication.md) | | +| [baseUrl](./js.apiclientoptions.baseurl.md) | readonly | string | | + diff --git a/docs/js.apiresponse.md b/docs/js.apiresponse.md new file mode 100644 index 00000000..4cb4fbde --- /dev/null +++ b/docs/js.apiresponse.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [APIResponse](./js.apiresponse.md) + +## APIResponse type + +Signature: + +```typescript +declare type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; +``` +References: [SuccessfulAPIResponse](./js.successfulapiresponse.md), [ErroredAPIResponse](./js.erroredapiresponse.md) + diff --git a/docs/js.assertid.md b/docs/js.assertid.md new file mode 100644 index 00000000..9f9954de --- /dev/null +++ b/docs/js.assertid.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [assertId](./js.assertid.md) + +## assertId() function + +Asserts that a string is a valid ID + +Signature: + +```typescript +declare function assertId( + maybeId?: string, + prefix?: T | T[], + message?: string, +): asserts maybeId is Id; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| maybeId | string | (Optional) A string that is possibly an ID | +| prefix | T \| T\[\] | (Optional) A prefix or array of prefixes to check against | +| message | string | (Optional) An error message to throw if the ID is invalid | + +Returns: + +asserts maybeId is [Id](./js.id.md)<T> + diff --git a/docs/js.auth.md b/docs/js.auth.md new file mode 100644 index 00000000..b839dd9f --- /dev/null +++ b/docs/js.auth.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) + +## Auth interface + +Docker image registry authorization + +Signature: + +```typescript +interface Auth +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [password](./js.auth.password.md) | | string | | +| [username](./js.auth.username.md) | | string | | + diff --git a/docs/js.auth.password.md b/docs/js.auth.password.md new file mode 100644 index 00000000..3856a18d --- /dev/null +++ b/docs/js.auth.password.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [password](./js.auth.password.md) + +## Auth.password property + +Signature: + +```typescript +password: string; +``` diff --git a/docs/js.auth.username.md b/docs/js.auth.username.md new file mode 100644 index 00000000..f837a54e --- /dev/null +++ b/docs/js.auth.username.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [username](./js.auth.username.md) + +## Auth.username property + +Signature: + +```typescript +username: string; +``` diff --git a/docs/js.broad_permissions_map.md b/docs/js.broad_permissions_map.md new file mode 100644 index 00000000..5192bc3b --- /dev/null +++ b/docs/js.broad_permissions_map.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) + +## BROAD\_PERMISSIONS\_MAP variable + +Signature: + +```typescript +BROAD_PERMISSIONS_MAP: { + MANAGE_MEMBERS: bigint; + MANAGE_PROJECT_TOKENS: bigint; + MANAGE_DEPLOYMENTS: bigint; + MANAGE_PIPE: bigint; + MANAGE_SECRETS: bigint; + MANAGE_CHANNELS: bigint; + MANAGE_REGISTRY: bigint; + READ_ONLY: bigint; + MANAGE_QUOTAS: bigint; + MANAGE_ROLLOUTS: bigint; + MANAGE_BILLING: bigint; +} +``` diff --git a/docs/js.build.deployment_id.md b/docs/js.build.deployment_id.md new file mode 100644 index 00000000..05320027 --- /dev/null +++ b/docs/js.build.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [deployment\_id](./js.build.deployment_id.md) + +## Build.deployment\_id property + +Deployment ID for build + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.build.digest.md b/docs/js.build.digest.md new file mode 100644 index 00000000..265b829b --- /dev/null +++ b/docs/js.build.digest.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [digest](./js.build.digest.md) + +## Build.digest property + +Digest for image + +Signature: + +```typescript +digest: string | null; +``` diff --git a/docs/js.build.finished_at.md b/docs/js.build.finished_at.md new file mode 100644 index 00000000..264bcbc3 --- /dev/null +++ b/docs/js.build.finished_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [finished\_at](./js.build.finished_at.md) + +## Build.finished\_at property + +Timestamp of when the build has finished + +Signature: + +```typescript +finished_at: Timestamp | null; +``` diff --git a/docs/js.build.id.md b/docs/js.build.id.md new file mode 100644 index 00000000..ce741698 --- /dev/null +++ b/docs/js.build.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [id](./js.build.id.md) + +## Build.id property + +ID of the build + +Signature: + +```typescript +id: Id<'build'>; +``` diff --git a/docs/js.build.md b/docs/js.build.md new file mode 100644 index 00000000..96489fe6 --- /dev/null +++ b/docs/js.build.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) + +## Build interface + +Signature: + +```typescript +interface Build +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [deployment\_id](./js.build.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | Deployment ID for build | +| [digest](./js.build.digest.md) | | string \| null | Digest for image | +| [finished\_at](./js.build.finished_at.md) | | [Timestamp](./js.timestamp.md) \| null | Timestamp of when the build has finished | +| [id](./js.build.id.md) | | [Id](./js.id.md)<'build'> | ID of the build | +| [metadata](./js.build.metadata.md) | | [BuildMetaData](./js.buildmetadata.md) \| null | Metadata pertaining to build (mostly for GitHub) | +| [method](./js.build.method.md) | | [BuildMethod](./js.buildmethod.md) | Build method (GitHub or CLI) | +| [started\_at](./js.build.started_at.md) | | [Timestamp](./js.timestamp.md) | Timestamp of when the build has started | +| [state](./js.build.state.md) | | [BuildState](./js.buildstate.md) | State of the build | + diff --git a/docs/js.build.metadata.md b/docs/js.build.metadata.md new file mode 100644 index 00000000..c41c702c --- /dev/null +++ b/docs/js.build.metadata.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [metadata](./js.build.metadata.md) + +## Build.metadata property + +Metadata pertaining to build (mostly for GitHub) + +Signature: + +```typescript +metadata: BuildMetaData | null; +``` diff --git a/docs/js.build.method.md b/docs/js.build.method.md new file mode 100644 index 00000000..549e9cf5 --- /dev/null +++ b/docs/js.build.method.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [method](./js.build.method.md) + +## Build.method property + +Build method (GitHub or CLI) + +Signature: + +```typescript +method: BuildMethod; +``` diff --git a/docs/js.build.started_at.md b/docs/js.build.started_at.md new file mode 100644 index 00000000..3d633757 --- /dev/null +++ b/docs/js.build.started_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [started\_at](./js.build.started_at.md) + +## Build.started\_at property + +Timestamp of when the build has started + +Signature: + +```typescript +started_at: Timestamp; +``` diff --git a/docs/js.build.state.md b/docs/js.build.state.md new file mode 100644 index 00000000..93ed8148 --- /dev/null +++ b/docs/js.build.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [state](./js.build.state.md) + +## Build.state property + +State of the build + +Signature: + +```typescript +state: BuildState; +``` diff --git a/docs/js.buildmetadata.account_type.md b/docs/js.buildmetadata.account_type.md new file mode 100644 index 00000000..a54d88f1 --- /dev/null +++ b/docs/js.buildmetadata.account_type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [account\_type](./js.buildmetadata.account_type.md) + +## BuildMetaData.account\_type property + +Account type of repo owner + +Signature: + +```typescript +account_type?: 'user' | 'organization'; +``` diff --git a/docs/js.buildmetadata.author.md b/docs/js.buildmetadata.author.md new file mode 100644 index 00000000..1832a02a --- /dev/null +++ b/docs/js.buildmetadata.author.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [author](./js.buildmetadata.author.md) + +## BuildMetaData.author property + +Author information about build + +Signature: + +```typescript +author?: { + avatar_url: string; + username: string; + }; +``` diff --git a/docs/js.buildmetadata.branch.md b/docs/js.buildmetadata.branch.md new file mode 100644 index 00000000..894d86c8 --- /dev/null +++ b/docs/js.buildmetadata.branch.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [branch](./js.buildmetadata.branch.md) + +## BuildMetaData.branch property + +Repo branch for build + +Signature: + +```typescript +branch: string; +``` diff --git a/docs/js.buildmetadata.commit_msg.md b/docs/js.buildmetadata.commit_msg.md new file mode 100644 index 00000000..82e95cdd --- /dev/null +++ b/docs/js.buildmetadata.commit_msg.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_msg](./js.buildmetadata.commit_msg.md) + +## BuildMetaData.commit\_msg property + +commit message for build + +Signature: + +```typescript +commit_msg: string; +``` diff --git a/docs/js.buildmetadata.commit_sha.md b/docs/js.buildmetadata.commit_sha.md new file mode 100644 index 00000000..b4d5896d --- /dev/null +++ b/docs/js.buildmetadata.commit_sha.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_sha](./js.buildmetadata.commit_sha.md) + +## BuildMetaData.commit\_sha property + +commit SHA for build + +Signature: + +```typescript +commit_sha: string; +``` diff --git a/docs/js.buildmetadata.commit_url.md b/docs/js.buildmetadata.commit_url.md new file mode 100644 index 00000000..fcbbe4fc --- /dev/null +++ b/docs/js.buildmetadata.commit_url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_url](./js.buildmetadata.commit_url.md) + +## BuildMetaData.commit\_url property + +commit URL for build + +Signature: + +```typescript +commit_url?: string; +``` diff --git a/docs/js.buildmetadata.md b/docs/js.buildmetadata.md new file mode 100644 index 00000000..5dd3c2f5 --- /dev/null +++ b/docs/js.buildmetadata.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) + +## BuildMetaData interface + +Signature: + +```typescript +interface BuildMetaData +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [account\_type?](./js.buildmetadata.account_type.md) | | 'user' \| 'organization' | (Optional) Account type of repo owner | +| [author?](./js.buildmetadata.author.md) | | { avatar\_url: string; username: string; } | (Optional) Author information about build | +| [branch](./js.buildmetadata.branch.md) | | string | Repo branch for build | +| [commit\_msg](./js.buildmetadata.commit_msg.md) | | string | commit message for build | +| [commit\_sha](./js.buildmetadata.commit_sha.md) | | string | commit SHA for build | +| [commit\_url?](./js.buildmetadata.commit_url.md) | | string | (Optional) commit URL for build | +| [repo\_id](./js.buildmetadata.repo_id.md) | | number | Repo ID for build | +| [repo\_name](./js.buildmetadata.repo_name.md) | | string | Repo name for build | + diff --git a/docs/js.buildmetadata.repo_id.md b/docs/js.buildmetadata.repo_id.md new file mode 100644 index 00000000..d75d34e8 --- /dev/null +++ b/docs/js.buildmetadata.repo_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_id](./js.buildmetadata.repo_id.md) + +## BuildMetaData.repo\_id property + +Repo ID for build + +Signature: + +```typescript +repo_id: number; +``` diff --git a/docs/js.buildmetadata.repo_name.md b/docs/js.buildmetadata.repo_name.md new file mode 100644 index 00000000..975f39cd --- /dev/null +++ b/docs/js.buildmetadata.repo_name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_name](./js.buildmetadata.repo_name.md) + +## BuildMetaData.repo\_name property + +Repo name for build + +Signature: + +```typescript +repo_name: string; +``` diff --git a/docs/js.buildmethod.md b/docs/js.buildmethod.md new file mode 100644 index 00000000..df02ff6d --- /dev/null +++ b/docs/js.buildmethod.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildMethod](./js.buildmethod.md) + +## BuildMethod enum + +Types of build methods supported by Hop + +Signature: + +```typescript +declare enum BuildMethod +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CLI | 'cli' | | +| GITHUB | 'github' | | + diff --git a/docs/js.buildstate.md b/docs/js.buildstate.md new file mode 100644 index 00000000..20cc3bbf --- /dev/null +++ b/docs/js.buildstate.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [BuildState](./js.buildstate.md) + +## BuildState enum + +Signature: + +```typescript +declare enum BuildState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| CANCELLED | 'cancelled' | | +| FAILED | 'failed' | | +| PENDING | 'pending' | | +| SUCCEEDED | 'succeeded' | | + diff --git a/docs/js.bytesizestring.md b/docs/js.bytesizestring.md new file mode 100644 index 00000000..1242e0aa --- /dev/null +++ b/docs/js.bytesizestring.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteSizeString](./js.bytesizestring.md) + +## ByteSizeString type + +Signature: + +```typescript +declare type ByteSizeString = `${number}${ByteUnit}`; +``` +References: [ByteUnit](./js.byteunit.md) + diff --git a/docs/js.bytestring.md b/docs/js.bytestring.md new file mode 100644 index 00000000..58797fc6 --- /dev/null +++ b/docs/js.bytestring.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteString](./js.bytestring.md) + +## ByteString type + +> Warning: This API is now obsolete. +> +> + +Signature: + +```typescript +declare type ByteString = ByteSizeString; +``` +References: [ByteSizeString](./js.bytesizestring.md) + diff --git a/docs/js.byteunit.md b/docs/js.byteunit.md new file mode 100644 index 00000000..0055bfce --- /dev/null +++ b/docs/js.byteunit.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ByteUnit](./js.byteunit.md) + +## ByteUnit type + +Signature: + +```typescript +declare type ByteUnit = + | typeof byteUnits[number] + | Uppercase; +``` +References: [byteUnits](./js.byteunits.md) + diff --git a/docs/js.byteunits.md b/docs/js.byteunits.md new file mode 100644 index 00000000..abc4309f --- /dev/null +++ b/docs/js.byteunits.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [byteUnits](./js.byteunits.md) + +## byteUnits variable + +Signature: + +```typescript +byteUnits: readonly ['GB', 'MB', 'KB', 'B'] +``` diff --git a/docs/js.channel.capabilities.md b/docs/js.channel.capabilities.md new file mode 100644 index 00000000..b3ea3beb --- /dev/null +++ b/docs/js.channel.capabilities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [capabilities](./js.channel.capabilities.md) + +## Channel.capabilities property + +Capabilities of the channel + +Signature: + +```typescript +capabilities: number; +``` diff --git a/docs/js.channel.created_at.md b/docs/js.channel.created_at.md new file mode 100644 index 00000000..79b26d9b --- /dev/null +++ b/docs/js.channel.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [created\_at](./js.channel.created_at.md) + +## Channel.created\_at property + +When this channel was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.channel.id.md b/docs/js.channel.id.md new file mode 100644 index 00000000..e5171cc3 --- /dev/null +++ b/docs/js.channel.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [id](./js.channel.id.md) + +## Channel.id property + +The ID of the channel + +Signature: + +```typescript +id: string; +``` diff --git a/docs/js.channel.md b/docs/js.channel.md new file mode 100644 index 00000000..5c6b2553 --- /dev/null +++ b/docs/js.channel.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) + +## Channel interface + +Signature: + +```typescript +interface Channel +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [capabilities](./js.channel.capabilities.md) | | number | Capabilities of the channel | +| [created\_at](./js.channel.created_at.md) | | [Timestamp](./js.timestamp.md) | When this channel was created | +| [id](./js.channel.id.md) | | string | The ID of the channel | +| [project](./js.channel.project.md) | | [Project](./js.project.md) | The project it is associated with | +| [state](./js.channel.state.md) | | [State](./js.state.md) | State metadata | +| [type](./js.channel.type.md) | | [ChannelType](./js.channeltype.md) | The type of this channel | + diff --git a/docs/js.channel.project.md b/docs/js.channel.project.md new file mode 100644 index 00000000..24a252b1 --- /dev/null +++ b/docs/js.channel.project.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [project](./js.channel.project.md) + +## Channel.project property + +The project it is associated with + +Signature: + +```typescript +project: Project; +``` diff --git a/docs/js.channel.state.md b/docs/js.channel.state.md new file mode 100644 index 00000000..82c4daa1 --- /dev/null +++ b/docs/js.channel.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [state](./js.channel.state.md) + +## Channel.state property + +State metadata + +Signature: + +```typescript +state: State; +``` diff --git a/docs/js.channel.type.md b/docs/js.channel.type.md new file mode 100644 index 00000000..10abf46b --- /dev/null +++ b/docs/js.channel.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [type](./js.channel.type.md) + +## Channel.type property + +The type of this channel + +Signature: + +```typescript +type: ChannelType; +``` diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md new file mode 100644 index 00000000..ca422079 --- /dev/null +++ b/docs/js.channelendpoints.md @@ -0,0 +1,123 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelEndpoints](./js.channelendpoints.md) + +## ChannelEndpoints type + +Signature: + +```typescript +declare type ChannelEndpoints = + | Endpoint< + 'POST', + '/v1/channels', + { + channel: Channel; + }, + { + type: ChannelType; + state: Record | null; + } + > + | Endpoint< + 'PUT', + '/v1/channels/:channel_id', + { + channel: Channel; + }, + { + type: ChannelType; + state: Record | null; + } + > + | Endpoint< + 'POST', + '/v1/channels/tokens', + { + token: ChannelToken; + }, + { + state: State; + } + > + | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> + | Endpoint< + 'GET', + '/v1/channels/:channel_id', + { + channel: Channel; + } + > + | Endpoint< + 'GET', + '/v1/channels/:channel_id/tokens', + { + tokens: ChannelToken[]; + } + > + | Endpoint< + 'POST', + '/v1/channels/tokens/:token/messages', + Empty, + { + e: string; + d: unknown; + } + > + | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> + | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> + | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> + | Endpoint< + 'GET', + '/v1/channels/:channel_id/state', + { + state: State; + } + > + | Endpoint< + 'POST', + '/v1/channels/:channel_id/messages', + Empty, + { + e: string; + d: unknown; + } + > + | Endpoint< + 'GET', + '/v1/channels', + { + channels: Channel[]; + } + > + | Endpoint< + 'GET', + '/v1/channels/tokens/:token', + { + token: ChannelToken; + } + > + | Endpoint< + 'PATCH', + '/v1/channels/tokens/:token', + { + token: ChannelToken; + }, + { + expiresAt?: Timestamp | null; + state: ChannelToken['state']; + } + > + | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> + | Endpoint< + 'GET', + '/v1/channels/:channel_id/stats', + { + stats: { + online_count: number; + }; + } + >; +``` +References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) + diff --git a/docs/js.channels.md b/docs/js.channels.md new file mode 100644 index 00000000..f2cb6af5 --- /dev/null +++ b/docs/js.channels.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Channels](./js.channels.md) + +## Channels namespace + +Signature: + +```typescript +declare namespace channels +``` diff --git a/docs/js.channeltoken.id.md b/docs/js.channeltoken.id.md new file mode 100644 index 00000000..0ea11a85 --- /dev/null +++ b/docs/js.channeltoken.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [id](./js.channeltoken.id.md) + +## ChannelToken.id property + +The ID for the token + +Signature: + +```typescript +id: Id<'leap_token'>; +``` diff --git a/docs/js.channeltoken.is_online.md b/docs/js.channeltoken.is_online.md new file mode 100644 index 00000000..0a64c0ae --- /dev/null +++ b/docs/js.channeltoken.is_online.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [is\_online](./js.channeltoken.is_online.md) + +## ChannelToken.is\_online property + +If this token is currently online (e.g. active heartbeat and connected to leap) + +Signature: + +```typescript +is_online: boolean; +``` diff --git a/docs/js.channeltoken.md b/docs/js.channeltoken.md new file mode 100644 index 00000000..e22b6fc8 --- /dev/null +++ b/docs/js.channeltoken.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) + +## ChannelToken interface + +Signature: + +```typescript +interface ChannelToken +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [id](./js.channeltoken.id.md) | | [Id](./js.id.md)<'leap\_token'> | The ID for the token | +| [is\_online](./js.channeltoken.is_online.md) | | boolean | If this token is currently online (e.g. active heartbeat and connected to leap) | +| [project\_id](./js.channeltoken.project_id.md) | | [Id](./js.id.md)<'project'> | The project this channel token is associated with | +| [state](./js.channeltoken.state.md) | | [State](./js.state.md) | State for this token | + diff --git a/docs/js.channeltoken.project_id.md b/docs/js.channeltoken.project_id.md new file mode 100644 index 00000000..07a80b63 --- /dev/null +++ b/docs/js.channeltoken.project_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [project\_id](./js.channeltoken.project_id.md) + +## ChannelToken.project\_id property + +The project this channel token is associated with + +Signature: + +```typescript +project_id: Id<'project'>; +``` diff --git a/docs/js.channeltoken.state.md b/docs/js.channeltoken.state.md new file mode 100644 index 00000000..4dfab383 --- /dev/null +++ b/docs/js.channeltoken.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [state](./js.channeltoken.state.md) + +## ChannelToken.state property + +State for this token + +Signature: + +```typescript +state: State; +``` diff --git a/docs/js.channeltype.md b/docs/js.channeltype.md new file mode 100644 index 00000000..7139cef5 --- /dev/null +++ b/docs/js.channeltype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ChannelType](./js.channeltype.md) + +## ChannelType enum + +Signature: + +```typescript +declare enum ChannelType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PRIVATE | 'private' | | +| PUBLIC | 'public' | | +| UNPROTECTED | 'unprotected' | | + diff --git a/docs/js.container.created_at.md b/docs/js.container.created_at.md new file mode 100644 index 00000000..ea0fb999 --- /dev/null +++ b/docs/js.container.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [created\_at](./js.container.created_at.md) + +## Container.created\_at property + +The time this container was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.container.deployment_id.md b/docs/js.container.deployment_id.md new file mode 100644 index 00000000..b3484036 --- /dev/null +++ b/docs/js.container.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [deployment\_id](./js.container.deployment_id.md) + +## Container.deployment\_id property + +The ID of the deployment this container is associated with + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.container.id.md b/docs/js.container.id.md new file mode 100644 index 00000000..9bc7359f --- /dev/null +++ b/docs/js.container.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [id](./js.container.id.md) + +## Container.id property + +The ID of the container + +Signature: + +```typescript +id: Id<'container'>; +``` diff --git a/docs/js.container.internal_ip.md b/docs/js.container.internal_ip.md new file mode 100644 index 00000000..a41a7c6f --- /dev/null +++ b/docs/js.container.internal_ip.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [internal\_ip](./js.container.internal_ip.md) + +## Container.internal\_ip property + +The internal IP of the container + +Signature: + +```typescript +internal_ip: string; +``` diff --git a/docs/js.container.md b/docs/js.container.md new file mode 100644 index 00000000..a06f1f56 --- /dev/null +++ b/docs/js.container.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) + +## Container interface + +Signature: + +```typescript +interface Container +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.container.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this container was created | +| [deployment\_id](./js.container.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment this container is associated with | +| [id](./js.container.id.md) | | [Id](./js.id.md)<'container'> | The ID of the container | +| [internal\_ip](./js.container.internal_ip.md) | | string | The internal IP of the container | +| [metadata](./js.container.metadata.md) | | { last\_exit\_code?: number; } | Information about the container | +| [region](./js.container.region.md) | | [Regions](./js.regions.md) | The region this container runs in | +| [state](./js.container.state.md) | | [ContainerState](./js.containerstate.md) | The state this container is in | +| [type](./js.container.type.md) | | [RuntimeType](./js.runtimetype.md) | The type of this container | +| [uptime](./js.container.uptime.md) | | { last\_start: [Timestamp](./js.timestamp.md); } | Information about uptime/downtime for this container | +| [volume](./js.container.volume.md) | | [VolumeDefinition](./js.volumedefinition.md) \| null | The volume definition for this container | + diff --git a/docs/js.container.metadata.md b/docs/js.container.metadata.md new file mode 100644 index 00000000..64601eff --- /dev/null +++ b/docs/js.container.metadata.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [metadata](./js.container.metadata.md) + +## Container.metadata property + +Information about the container + +Signature: + +```typescript +metadata: { + last_exit_code?: number; + }; +``` diff --git a/docs/js.container.region.md b/docs/js.container.region.md new file mode 100644 index 00000000..1e6dacc8 --- /dev/null +++ b/docs/js.container.region.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [region](./js.container.region.md) + +## Container.region property + +The region this container runs in + +Signature: + +```typescript +region: Regions; +``` diff --git a/docs/js.container.state.md b/docs/js.container.state.md new file mode 100644 index 00000000..be7ce2ec --- /dev/null +++ b/docs/js.container.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [state](./js.container.state.md) + +## Container.state property + +The state this container is in + +Signature: + +```typescript +state: ContainerState; +``` diff --git a/docs/js.container.type.md b/docs/js.container.type.md new file mode 100644 index 00000000..aa89d51b --- /dev/null +++ b/docs/js.container.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [type](./js.container.type.md) + +## Container.type property + +The type of this container + +Signature: + +```typescript +type: RuntimeType; +``` diff --git a/docs/js.container.uptime.md b/docs/js.container.uptime.md new file mode 100644 index 00000000..b1474c2d --- /dev/null +++ b/docs/js.container.uptime.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [uptime](./js.container.uptime.md) + +## Container.uptime property + +Information about uptime/downtime for this container + +Signature: + +```typescript +uptime: { + last_start: Timestamp; + }; +``` diff --git a/docs/js.container.volume.md b/docs/js.container.volume.md new file mode 100644 index 00000000..e1aa34a5 --- /dev/null +++ b/docs/js.container.volume.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [volume](./js.container.volume.md) + +## Container.volume property + +The volume definition for this container + +Signature: + +```typescript +volume: VolumeDefinition | null; +``` diff --git a/docs/js.containerlog.level.md b/docs/js.containerlog.level.md new file mode 100644 index 00000000..10fdce77 --- /dev/null +++ b/docs/js.containerlog.level.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [level](./js.containerlog.level.md) + +## ContainerLog.level property + +The level of the log. stdout becomes `info` + +Signature: + +```typescript +level: 'info' | 'error'; +``` diff --git a/docs/js.containerlog.md b/docs/js.containerlog.md new file mode 100644 index 00000000..16e7237c --- /dev/null +++ b/docs/js.containerlog.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) + +## ContainerLog interface + +Logs from a container + +Signature: + +```typescript +interface ContainerLog +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [level](./js.containerlog.level.md) | | 'info' \| 'error' | The level of the log. stdout becomes info | +| [message](./js.containerlog.message.md) | | string | The log message | +| [nonce](./js.containerlog.nonce.md) | | string | The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. | +| [timestamp](./js.containerlog.timestamp.md) | | [Timestamp](./js.timestamp.md) | The timestamp of the log | + diff --git a/docs/js.containerlog.message.md b/docs/js.containerlog.message.md new file mode 100644 index 00000000..b3334c65 --- /dev/null +++ b/docs/js.containerlog.message.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [message](./js.containerlog.message.md) + +## ContainerLog.message property + +The log message + +Signature: + +```typescript +message: string; +``` diff --git a/docs/js.containerlog.nonce.md b/docs/js.containerlog.nonce.md new file mode 100644 index 00000000..ea3b06a4 --- /dev/null +++ b/docs/js.containerlog.nonce.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [nonce](./js.containerlog.nonce.md) + +## ContainerLog.nonce property + +The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. + +Signature: + +```typescript +nonce: string; +``` diff --git a/docs/js.containerlog.timestamp.md b/docs/js.containerlog.timestamp.md new file mode 100644 index 00000000..d415f14e --- /dev/null +++ b/docs/js.containerlog.timestamp.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [timestamp](./js.containerlog.timestamp.md) + +## ContainerLog.timestamp property + +The timestamp of the log + +Signature: + +```typescript +timestamp: Timestamp; +``` diff --git a/docs/js.containerstate.md b/docs/js.containerstate.md new file mode 100644 index 00000000..9a08d3ea --- /dev/null +++ b/docs/js.containerstate.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ContainerState](./js.containerstate.md) + +## ContainerState enum + +Container state is relatively self-explanatory. It describes what the container is currently doing. + +Signature: + +```typescript +declare enum ContainerState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXITED | 'exited' | The container exited (e.g. with a zero exit code) | +| FAILED | 'failed' | The container's entrypoint failed (e.g. exited with a non-zero exit code) | +| PENDING | 'pending' | The container is pending creation | +| RUNNING | 'running' | The container is running | +| STOPPED | 'stopped' | The container is stopped | +| TERMINATING | 'terminating' | The container is being deleted | + diff --git a/docs/js.default_base_url.md b/docs/js.default_base_url.md new file mode 100644 index 00000000..6ac137e6 --- /dev/null +++ b/docs/js.default_base_url.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DEFAULT\_BASE\_URL](./js.default_base_url.md) + +## DEFAULT\_BASE\_URL variable + +The default base URL for Hop's API. + +Signature: + +```typescript +DEFAULT_BASE_URL = 'https://api.hop.io' +``` diff --git a/docs/js.defaultquotas.md b/docs/js.defaultquotas.md new file mode 100644 index 00000000..7c88bdd0 --- /dev/null +++ b/docs/js.defaultquotas.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) + +## DefaultQuotas interface + +Signature: + +```typescript +interface DefaultQuotas +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.defaultquotas.ram.md) | | number | | +| [vcpu](./js.defaultquotas.vcpu.md) | | number | | + diff --git a/docs/js.defaultquotas.ram.md b/docs/js.defaultquotas.ram.md new file mode 100644 index 00000000..0b1bc129 --- /dev/null +++ b/docs/js.defaultquotas.ram.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [ram](./js.defaultquotas.ram.md) + +## DefaultQuotas.ram property + +Signature: + +```typescript +ram: number; +``` diff --git a/docs/js.defaultquotas.vcpu.md b/docs/js.defaultquotas.vcpu.md new file mode 100644 index 00000000..7386459d --- /dev/null +++ b/docs/js.defaultquotas.vcpu.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [vcpu](./js.defaultquotas.vcpu.md) + +## DefaultQuotas.vcpu property + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.deliveryprotocol.md b/docs/js.deliveryprotocol.md new file mode 100644 index 00000000..d96e760d --- /dev/null +++ b/docs/js.deliveryprotocol.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeliveryProtocol](./js.deliveryprotocol.md) + +## DeliveryProtocol type + +Signature: + +```typescript +declare type DeliveryProtocol = 'webrtc' | 'hls'; +``` diff --git a/docs/js.deployment.active_build.md b/docs/js.deployment.active_build.md new file mode 100644 index 00000000..13170351 --- /dev/null +++ b/docs/js.deployment.active_build.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_build](./js.deployment.active_build.md) + +## Deployment.active\_build property + +Current active build for deployment + +Signature: + +```typescript +active_build: Build | null; +``` diff --git a/docs/js.deployment.active_rollout.md b/docs/js.deployment.active_rollout.md new file mode 100644 index 00000000..8cb6418b --- /dev/null +++ b/docs/js.deployment.active_rollout.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_rollout](./js.deployment.active_rollout.md) + +## Deployment.active\_rollout property + +Current active rollout for deployment + +Signature: + +```typescript +active_rollout: DeploymentRollout | null; +``` diff --git a/docs/js.deployment.config.md b/docs/js.deployment.config.md new file mode 100644 index 00000000..7526bfe8 --- /dev/null +++ b/docs/js.deployment.config.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [config](./js.deployment.config.md) + +## Deployment.config property + +The config for this deployment + +Signature: + +```typescript +config: Omit; +``` diff --git a/docs/js.deployment.container_count.md b/docs/js.deployment.container_count.md new file mode 100644 index 00000000..b626b1a7 --- /dev/null +++ b/docs/js.deployment.container_count.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [container\_count](./js.deployment.container_count.md) + +## Deployment.container\_count property + +The amount of containers this deployment is currently running + +Signature: + +```typescript +container_count: number; +``` diff --git a/docs/js.deployment.created_at.md b/docs/js.deployment.created_at.md new file mode 100644 index 00000000..fdd0df48 --- /dev/null +++ b/docs/js.deployment.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [created\_at](./js.deployment.created_at.md) + +## Deployment.created\_at property + +The time this deployment was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.deployment.id.md b/docs/js.deployment.id.md new file mode 100644 index 00000000..5ff910b0 --- /dev/null +++ b/docs/js.deployment.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [id](./js.deployment.id.md) + +## Deployment.id property + +The ID of the deployment + +Signature: + +```typescript +id: Id<'deployment'>; +``` diff --git a/docs/js.deployment.md b/docs/js.deployment.md new file mode 100644 index 00000000..ac2ded0e --- /dev/null +++ b/docs/js.deployment.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) + +## Deployment interface + +Signature: + +```typescript +interface Deployment +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [active\_build](./js.deployment.active_build.md) | | [Build](./js.build.md) \| null | Current active build for deployment | +| [active\_rollout](./js.deployment.active_rollout.md) | | [DeploymentRollout](./js.deploymentrollout.md) \| null | Current active rollout for deployment | +| [config](./js.deployment.config.md) | | Omit<[DeploymentConfig](./js.deploymentconfig.md), 'volume' \| 'name'> | The config for this deployment | +| [container\_count](./js.deployment.container_count.md) | | number | The amount of containers this deployment is currently running | +| [created\_at](./js.deployment.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this deployment was created at | +| [id](./js.deployment.id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment | +| [name](./js.deployment.name.md) | | string | The name of the deployment | + diff --git a/docs/js.deployment.name.md b/docs/js.deployment.name.md new file mode 100644 index 00000000..f13f40ae --- /dev/null +++ b/docs/js.deployment.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [name](./js.deployment.name.md) + +## Deployment.name property + +The name of the deployment + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.deploymentconfig.md b/docs/js.deploymentconfig.md new file mode 100644 index 00000000..c8ca0663 --- /dev/null +++ b/docs/js.deploymentconfig.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentConfig](./js.deploymentconfig.md) + +## DeploymentConfig type + +Signature: + +```typescript +declare type DeploymentConfig = { + name: string; + container_strategy: 'manual'; + type: RuntimeType; + version: '2022-05-17'; + image: Image; + env: Record; + resources: Resources; + restart_policy: RestartPolicy; + volume?: VolumeDefinition; +}; +``` +References: [RuntimeType](./js.runtimetype.md), [Image](./js.image_2.md), [Resources](./js.resources.md), [RestartPolicy](./js.restartpolicy.md), [VolumeDefinition](./js.volumedefinition.md) + diff --git a/docs/js.deploymentrollout.md b/docs/js.deploymentrollout.md new file mode 100644 index 00000000..1cb66406 --- /dev/null +++ b/docs/js.deploymentrollout.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentRollout](./js.deploymentrollout.md) + +## DeploymentRollout type + +Signature: + +```typescript +declare type DeploymentRollout = { + count: number; + created_at: Timestamp; + deployment_id: Id<'deployment'>; + id: Id<'rollout'>; + state: RolloutState; + build: Build | null; +}; +``` +References: [Timestamp](./js.timestamp.md), [Id](./js.id.md), [RolloutState](./js.rolloutstate.md), [Build](./js.build.md) + diff --git a/docs/js.domain.created_at.md b/docs/js.domain.created_at.md new file mode 100644 index 00000000..c16c478c --- /dev/null +++ b/docs/js.domain.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [created\_at](./js.domain.created_at.md) + +## Domain.created\_at property + +The date this domain was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.domain.domain.md b/docs/js.domain.domain.md new file mode 100644 index 00000000..429325c1 --- /dev/null +++ b/docs/js.domain.domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [domain](./js.domain.domain.md) + +## Domain.domain property + +The domain name + +Signature: + +```typescript +domain: string; +``` diff --git a/docs/js.domain.id.md b/docs/js.domain.id.md new file mode 100644 index 00000000..659db5cc --- /dev/null +++ b/docs/js.domain.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [id](./js.domain.id.md) + +## Domain.id property + +The ID of the domain + +Signature: + +```typescript +id: Id<'domain'>; +``` diff --git a/docs/js.domain.md b/docs/js.domain.md new file mode 100644 index 00000000..9668e178 --- /dev/null +++ b/docs/js.domain.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) + +## Domain interface + +Signature: + +```typescript +interface Domain +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.domain.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this domain was created | +| [domain](./js.domain.domain.md) | | string | The domain name | +| [id](./js.domain.id.md) | | [Id](./js.id.md)<'domain'> | The ID of the domain | +| [state](./js.domain.state.md) | | [DomainState](./js.domainstate.md) | The domain state | + diff --git a/docs/js.domain.state.md b/docs/js.domain.state.md new file mode 100644 index 00000000..9f613f54 --- /dev/null +++ b/docs/js.domain.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [state](./js.domain.state.md) + +## Domain.state property + +The domain state + +Signature: + +```typescript +state: DomainState; +``` diff --git a/docs/js.domainstate.md b/docs/js.domainstate.md new file mode 100644 index 00000000..7bfddfd3 --- /dev/null +++ b/docs/js.domainstate.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [DomainState](./js.domainstate.md) + +## DomainState enum + +Signature: + +```typescript +declare enum DomainState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PENDING | 'pending' | | +| SSL\_ACTIVE | 'ssl_active' | | +| VALID\_CNAME | 'valid_cname' | | + diff --git a/docs/js.empty.md b/docs/js.empty.md new file mode 100644 index 00000000..534185e2 --- /dev/null +++ b/docs/js.empty.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) + +## Empty type + +Signature: + +```typescript +declare type Empty = void; +``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md new file mode 100644 index 00000000..b668b274 --- /dev/null +++ b/docs/js.endpoint.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Endpoint](./js.endpoint.md) + +## Endpoint type + +Signature: + +```typescript +declare type Endpoint< + M extends Method, + Path extends string, + Res, + Body = undefined, +> = { + method: M; + path: Path; + res: Res; + body: Body; +}; +``` +References: [Method](./js.method.md) + diff --git a/docs/js.endpoints.md b/docs/js.endpoints.md new file mode 100644 index 00000000..e453fd53 --- /dev/null +++ b/docs/js.endpoints.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Endpoints](./js.endpoints.md) + +## Endpoints type + +Signature: + +```typescript +declare type Endpoints = + | IgniteEndpoints + | RegistryEndpoints + | UserEndpoints + | ProjectsEndpoints + | PipeEndpoints + | ChannelEndpoints; +``` +References: [IgniteEndpoints](./js.igniteendpoints.md), [RegistryEndpoints](./js.registryendpoints.md), [UserEndpoints](./js.userendpoints.md), [ProjectsEndpoints](./js.projectsendpoints.md), [PipeEndpoints](./js.pipeendpoints.md), [ChannelEndpoints](./js.channelendpoints.md) + diff --git a/docs/js.erroredapiresponse.md b/docs/js.erroredapiresponse.md new file mode 100644 index 00000000..07cdf85a --- /dev/null +++ b/docs/js.erroredapiresponse.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ErroredAPIResponse](./js.erroredapiresponse.md) + +## ErroredAPIResponse type + +Signature: + +```typescript +declare type ErroredAPIResponse = { + success: false; + error: { + code: string; + message: string; + }; +}; +``` diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md new file mode 100644 index 00000000..8cc1b80a --- /dev/null +++ b/docs/js.extractrouteparams.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) + +## ExtractRouteParams type + +Signature: + +```typescript +declare type ExtractRouteParams = string extends T + ? Record + : T extends `${string}:${infer Param}/${infer Rest}` + ? { + [k in Param | keyof ExtractRouteParams]: string | number; + } + : T extends `${string}:${infer Param}` + ? { + [k in Param]: string | number; + } + : {}; +``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.gateway.created_at.md b/docs/js.gateway.created_at.md new file mode 100644 index 00000000..c6c94097 --- /dev/null +++ b/docs/js.gateway.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [created\_at](./js.gateway.created_at.md) + +## Gateway.created\_at property + +The date this gateway was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.gateway.deployment_id.md b/docs/js.gateway.deployment_id.md new file mode 100644 index 00000000..6300a5b1 --- /dev/null +++ b/docs/js.gateway.deployment_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [deployment\_id](./js.gateway.deployment_id.md) + +## Gateway.deployment\_id property + +The deployment this gateway is associated with + +Signature: + +```typescript +deployment_id: Id<'deployment'>; +``` diff --git a/docs/js.gateway.domains.md b/docs/js.gateway.domains.md new file mode 100644 index 00000000..fffb4603 --- /dev/null +++ b/docs/js.gateway.domains.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [domains](./js.gateway.domains.md) + +## Gateway.domains property + +Domains associated with this gateway + +Signature: + +```typescript +domains: Domain[]; +``` diff --git a/docs/js.gateway.hopsh_domain.md b/docs/js.gateway.hopsh_domain.md new file mode 100644 index 00000000..d7b3c930 --- /dev/null +++ b/docs/js.gateway.hopsh_domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [hopsh\_domain](./js.gateway.hopsh_domain.md) + +## Gateway.hopsh\_domain property + +Domain automatically assigned by Hop + +Signature: + +```typescript +hopsh_domain: HopShDomain | null; +``` diff --git a/docs/js.gateway.id.md b/docs/js.gateway.id.md new file mode 100644 index 00000000..68dc79d4 --- /dev/null +++ b/docs/js.gateway.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [id](./js.gateway.id.md) + +## Gateway.id property + +The ID of the gateway + +Signature: + +```typescript +id: Id<'gateway'>; +``` diff --git a/docs/js.gateway.internal_domain.md b/docs/js.gateway.internal_domain.md new file mode 100644 index 00000000..58b36080 --- /dev/null +++ b/docs/js.gateway.internal_domain.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [internal\_domain](./js.gateway.internal_domain.md) + +## Gateway.internal\_domain property + +Internal domain assigned by user upon gateway creation + +Signature: + +```typescript +internal_domain: InternalHopDomain | null; +``` diff --git a/docs/js.gateway.md b/docs/js.gateway.md new file mode 100644 index 00000000..685ce83f --- /dev/null +++ b/docs/js.gateway.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) + +## Gateway interface + +Gateways are used to connect services to the internet or a private network + +Signature: + +```typescript +interface Gateway +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.gateway.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this gateway was created | +| [deployment\_id](./js.gateway.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The deployment this gateway is associated with | +| [domains](./js.gateway.domains.md) | | [Domain](./js.domain.md)\[\] | Domains associated with this gateway | +| [hopsh\_domain](./js.gateway.hopsh_domain.md) | | [HopShDomain](./js.hopshdomain.md) \| null | Domain automatically assigned by Hop | +| [id](./js.gateway.id.md) | | [Id](./js.id.md)<'gateway'> | The ID of the gateway | +| [internal\_domain](./js.gateway.internal_domain.md) | | [InternalHopDomain](./js.internalhopdomain.md) \| null | Internal domain assigned by user upon gateway creation | +| [name](./js.gateway.name.md) | | string | The name of the gateway | +| [target\_port](./js.gateway.target_port.md) | | number \| null | Port the Gateway targets (Only for external gateways) | +| [type](./js.gateway.type.md) | | [GatewayType](./js.gatewaytype.md) | The type of the gateway | + diff --git a/docs/js.gateway.name.md b/docs/js.gateway.name.md new file mode 100644 index 00000000..8386952e --- /dev/null +++ b/docs/js.gateway.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [name](./js.gateway.name.md) + +## Gateway.name property + +The name of the gateway + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.gateway.target_port.md b/docs/js.gateway.target_port.md new file mode 100644 index 00000000..6f14c324 --- /dev/null +++ b/docs/js.gateway.target_port.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [target\_port](./js.gateway.target_port.md) + +## Gateway.target\_port property + +Port the Gateway targets (Only for external gateways) + +Signature: + +```typescript +target_port: number | null; +``` diff --git a/docs/js.gateway.type.md b/docs/js.gateway.type.md new file mode 100644 index 00000000..91a41587 --- /dev/null +++ b/docs/js.gateway.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [type](./js.gateway.type.md) + +## Gateway.type property + +The type of the gateway + +Signature: + +```typescript +type: GatewayType; +``` diff --git a/docs/js.gatewaytype.md b/docs/js.gatewaytype.md new file mode 100644 index 00000000..4c824a50 --- /dev/null +++ b/docs/js.gatewaytype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GatewayType](./js.gatewaytype.md) + +## GatewayType enum + +Types of gateways supported by Hop + +Signature: + +```typescript +declare enum GatewayType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXTERNAL | 'external' | The gateway can be accessed from the internet | +| INTERNAL | 'internal' | The gateway can only be accessed inside of a project's network | + diff --git a/docs/js.getidprefix.md b/docs/js.getidprefix.md new file mode 100644 index 00000000..6292890d --- /dev/null +++ b/docs/js.getidprefix.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [getIdPrefix](./js.getidprefix.md) + +## getIdPrefix() function + +Signature: + +```typescript +declare function getIdPrefix(id: string, expect?: T): T; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| id | string | | +| expect | T | (Optional) | + +Returns: + +T + diff --git a/docs/js.ghrepo.account_name.md b/docs/js.ghrepo.account_name.md new file mode 100644 index 00000000..17dad093 --- /dev/null +++ b/docs/js.ghrepo.account_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [account\_name](./js.ghrepo.account_name.md) + +## GHRepo.account\_name property + +Signature: + +```typescript +account_name: string; +``` diff --git a/docs/js.ghrepo.default_branch.md b/docs/js.ghrepo.default_branch.md new file mode 100644 index 00000000..bae06423 --- /dev/null +++ b/docs/js.ghrepo.default_branch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [default\_branch](./js.ghrepo.default_branch.md) + +## GHRepo.default\_branch property + +Signature: + +```typescript +default_branch: string; +``` diff --git a/docs/js.ghrepo.full_name.md b/docs/js.ghrepo.full_name.md new file mode 100644 index 00000000..8a2776bb --- /dev/null +++ b/docs/js.ghrepo.full_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [full\_name](./js.ghrepo.full_name.md) + +## GHRepo.full\_name property + +Signature: + +```typescript +full_name: string; +``` diff --git a/docs/js.ghrepo.id.md b/docs/js.ghrepo.id.md new file mode 100644 index 00000000..f9607b9b --- /dev/null +++ b/docs/js.ghrepo.id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [id](./js.ghrepo.id.md) + +## GHRepo.id property + +Signature: + +```typescript +id: number; +``` diff --git a/docs/js.ghrepo.md b/docs/js.ghrepo.md new file mode 100644 index 00000000..84df8456 --- /dev/null +++ b/docs/js.ghrepo.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) + +## GHRepo interface + +GitHub repo type sent from API (NOT USED IN IMAGES) + +Signature: + +```typescript +interface GHRepo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [account\_name](./js.ghrepo.account_name.md) | | string | | +| [default\_branch](./js.ghrepo.default_branch.md) | | string | | +| [full\_name](./js.ghrepo.full_name.md) | | string | | +| [id](./js.ghrepo.id.md) | | number | | +| [private](./js.ghrepo.private.md) | | boolean | | + diff --git a/docs/js.ghrepo.private.md b/docs/js.ghrepo.private.md new file mode 100644 index 00000000..3a4e994b --- /dev/null +++ b/docs/js.ghrepo.private.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [private](./js.ghrepo.private.md) + +## GHRepo.private property + +Signature: + +```typescript +private: boolean; +``` diff --git a/docs/js.hop._constructor_.md b/docs/js.hop._constructor_.md new file mode 100644 index 00000000..cd3f058d --- /dev/null +++ b/docs/js.hop._constructor_.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor_.md) + +## Hop.(constructor) + +Constructs a new instance of the `Hop` class + +Signature: + +```typescript +constructor(options: PartialAPIOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | [PartialAPIOptions](./js.partialapioptions.md) | | + diff --git a/docs/js.hop._constructor__1.md b/docs/js.hop._constructor__1.md new file mode 100644 index 00000000..b426e3df --- /dev/null +++ b/docs/js.hop._constructor__1.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor__1.md) + +## Hop.(constructor) + +Constructs a new instance of the `Hop` class + +Signature: + +```typescript +constructor(authentication: APIAuthentication, baseurl?: string); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| authentication | [APIAuthentication](./js.apiauthentication.md) | | +| baseurl | string | (Optional) | + diff --git a/docs/js.hop.channels.md b/docs/js.hop.channels.md new file mode 100644 index 00000000..3200e2d0 --- /dev/null +++ b/docs/js.hop.channels.md @@ -0,0 +1,104 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [channels](./js.hop.channels.md) + +## Hop.channels property + +Signature: + +```typescript +readonly channels: { + create( + type: ChannelType, + id?: string | null | undefined, + options?: + | { + state?: T | undefined; + } + | null + | undefined, + project?: `project_${string}` | undefined, + ): Promise< + Channel & { + setState(state: SetStateAction): Promise; + patchState( + state: SetStateAction, + ): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens( + tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, + ): Promise; + publishMessage(name: string, data: unknown): Promise; + } + >; + get(id: string): Promise< + Channel & { + setState(state: SetStateAction): Promise; + patchState( + state: SetStateAction, + ): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens( + tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, + ): Promise; + publishMessage(name: string, data: unknown): Promise; + } + >; + getAll(project?: `project_${string}` | undefined): Promise< + (Channel & { + setState(state: SetStateAction): Promise; + patchState( + state: SetStateAction, + ): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens( + tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, + ): Promise; + publishMessage(name: string, data: unknown): Promise; + })[] + >; + subscribeToken( + channel: string | Channel, + token: `leap_token_${string}`, + ): Promise; + subscribeTokens( + channel: string | Channel, + tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, + ): Promise; + getAllTokens(channel: string | Channel): Promise; + setState( + channel: string | Channel, + state: SetStateAction, + ): Promise; + patchState( + channel: string | Channel, + state: SetStateAction, + ): Promise; + publishMessage( + channel: string | Channel, + event: string, + data: T_5, + ): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: `leap_token_${string}`): Promise; + create( + state?: State, + project?: `project_${string}` | undefined, + ): Promise; + setState(id: `leap_token_${string}`, state: State): Promise; + get(id: `leap_token_${string}`): Promise; + isOnline( + idOrToken: `leap_token_${string}` | ChannelToken, + ): Promise; + publishDirectMessage( + token: `leap_token_${string}`, + event: string, + data: T_6, + ): Promise; + }; + }; +``` diff --git a/docs/js.hop.client.md b/docs/js.hop.client.md new file mode 100644 index 00000000..c23e7fa5 --- /dev/null +++ b/docs/js.hop.client.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [client](./js.hop.client.md) + +## Hop.client property + +Signature: + +```typescript +readonly client: APIClient; +``` diff --git a/docs/js.hop.ignite.md b/docs/js.hop.ignite.md new file mode 100644 index 00000000..029ae0a8 --- /dev/null +++ b/docs/js.hop.ignite.md @@ -0,0 +1,146 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [ignite](./js.hop.ignite.md) + +## Hop.ignite property + +Signature: + +```typescript +readonly ignite: { + gateways: { + addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; + get(gatewayId: `gateway_${string}`): Promise; + }; + deployments: { + create: { + ( + configOrProject: `project_${string}`, + bearerOrPatConfig: DeploymentConfig, + ): Promise< + Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway( + type: GatewayType, + protocol: 'http' | null, + port: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + } + >; + (configOrProject: DeploymentConfig): Promise< + Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway( + type: GatewayType, + protocol: 'http' | null, + port: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + } + >; + }; + get: { + (name: string, projectId?: `project_${string}` | undefined): Promise< + Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway( + type: GatewayType, + protocol: 'http' | null, + port: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + } + >; + ( + id: `deployment_${string}`, + projectId?: `project_${string}` | undefined, + ): Promise< + Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway( + type: GatewayType, + protocol: 'http' | null, + port: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + } + >; + }; + update( + deploymentId: `deployment_${string}`, + config: DeploymentConfig, + ): Promise; + getContainers(deployment: `deployment_${string}`): Promise; + getAll(projectId?: `project_${string}` | undefined): Promise< + (Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway( + type: GatewayType, + protocol: 'http' | null, + port: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + })[] + >; + delete(deployment: `deployment_${string}`): Promise; + gateways: { + getAll(deploymentId: `deployment_${string}`): Promise< + (Gateway & { + addDomain(domain: string): Promise; + })[] + >; + create( + deployment: `deployment_${string}` | Deployment, + type: GatewayType, + protocol: 'http' | null, + targetPort: number, + ): Promise< + Gateway & { + addDomain(domain: string): Promise; + } + >; + }; + }; + containers: { + delete(container: `container_${string}`): Promise; + getLogs( + container: `container_${string}`, + options?: Partial<{ + sortBy: 'timestamp'; + orderBy: 'desc' | 'asc'; + limit: number; + offset: number; + }>, + ): Promise; + stop(container: `container_${string}`): Promise; + start(container: `container_${string}`): Promise; + create(deployment: `deployment_${string}`): Promise; + }; + }; +``` diff --git a/docs/js.hop.md b/docs/js.hop.md new file mode 100644 index 00000000..6a44c718 --- /dev/null +++ b/docs/js.hop.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) + +## Hop class + +Constructs a new instance of Hop and all of its SDKs. + +Signature: + +```typescript +declare class Hop +``` + +## Example + + +```ts +const hop = new Hop(bearerTokenOrPATOrProjectToken); +await hop.ignite.containers.create(deploymentId); +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(options)](./js.hop._constructor_.md) | | Constructs a new instance of the Hop class | +| [(constructor)(authentication, baseurl)](./js.hop._constructor__1.md) | | Constructs a new instance of the Hop class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>( type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: \| { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined, ): Promise< [Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; } >; get(id: string): Promise< [Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; } >; getAll(project?: \`project\_${string}\` \| undefined): Promise< ([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\] >; subscribeToken( channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`, ): Promise<void>; subscribeTokens( channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>( channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_3>, ): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>( channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_4>, ): Promise<void>; publishMessage<T\_5>( channel: string \| [Channel](./js.channel.md), event: string, data: T\_5, ): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create( state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined, ): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline( idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md), ): Promise<boolean>; publishDirectMessage<T\_6>( token: \`leap\_token\_${string}\`, event: string, data: T\_6, ): Promise<void>; }; } | | +| [client](./js.hop.client.md) | readonly | [APIClient](./js.apiclient.md) | | +| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { ( configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md), ): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; ( id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined, ): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; }; update( deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md), ): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise< ([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; })\[\] >; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise< ([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\] >; create( deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, targetPort: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs( container: \`container\_${string}\`, options?: Partial<{ sortBy: 'timestamp'; orderBy: 'desc' \| 'asc'; limit: number; offset: number; }>, ): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | +| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise< ([Room](./js.room.md) & { delete(): Promise<void>; })\[\] >; create( name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: 'rtmp' \| 'rtp'; hlsConfig?: \| { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }, ): Promise< [Room](./js.room.md) & { delete(): Promise<void>; } >; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | +| [projects](./js.hop.projects.md) | readonly | { getAllMembers( projectId?: \`project\_${string}\` \| undefined, ): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete( projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined, ): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create( flags: number, projectId?: \`project\_${string}\` \| undefined, ): Promise< [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); } >; }; tokens: { delete( projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined, ): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create( flags: number, projectId?: \`project\_${string}\` \| undefined, ): Promise< [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); } >; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create( name: string, value: string, projectId?: \`project\_${string}\` \| undefined, ): Promise<[Secret](./js.secret.md)>; delete( id: string, projectId?: \`project\_${string}\` \| undefined, ): Promise<void>; }; } | | +| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise< { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\] >; delete(image: string): Promise<void>; }; } | | +| [users](./js.hop.users.md) | readonly | { me: { get(): Promise<{ projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }>; pats: { create(name: string): Promise<[PAT](./js.pat.md)>; getAll(): Promise<[PAT](./js.pat.md)\[\]>; delete(id: \`pat\_${string}\`): Promise<void>; }; }; } | | + diff --git a/docs/js.hop.pipe.md b/docs/js.hop.pipe.md new file mode 100644 index 00000000..f18408ef --- /dev/null +++ b/docs/js.hop.pipe.md @@ -0,0 +1,39 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [pipe](./js.hop.pipe.md) + +## Hop.pipe property + +Signature: + +```typescript +readonly pipe: { + rooms: { + getAll(project?: `project_${string}` | undefined): Promise< + (Room & { + delete(): Promise; + })[] + >; + create( + name: string, + options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean | undefined; + ingestProtocol: 'rtmp' | 'rtp'; + hlsConfig?: + | { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } + | undefined; + }, + ): Promise< + Room & { + delete(): Promise; + } + >; + delete(room: `pipe_room_${string}`): Promise; + }; + }; +``` diff --git a/docs/js.hop.projects.md b/docs/js.hop.projects.md new file mode 100644 index 00000000..d7597221 --- /dev/null +++ b/docs/js.hop.projects.md @@ -0,0 +1,58 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [projects](./js.hop.projects.md) + +## Hop.projects property + +Signature: + +```typescript +readonly projects: { + getAllMembers( + projectId?: `project_${string}` | undefined, + ): Promise; + getCurrentMember(projectId: `project_${string}`): Promise; + projectTokens: { + delete( + projectTokenId: `ptkid_${string}`, + project?: `project_${string}` | undefined, + ): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create( + flags: number, + projectId?: `project_${string}` | undefined, + ): Promise< + ProjectToken & { + project: Project; + } + >; + }; + tokens: { + delete( + projectTokenId: `ptkid_${string}`, + project?: `project_${string}` | undefined, + ): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create( + flags: number, + projectId?: `project_${string}` | undefined, + ): Promise< + ProjectToken & { + project: Project; + } + >; + }; + secrets: { + getAll(projectId?: `project_${string}` | undefined): Promise; + create( + name: string, + value: string, + projectId?: `project_${string}` | undefined, + ): Promise; + delete( + id: string, + projectId?: `project_${string}` | undefined, + ): Promise; + }; + }; +``` diff --git a/docs/js.hop.registry.md b/docs/js.hop.registry.md new file mode 100644 index 00000000..d8d835bb --- /dev/null +++ b/docs/js.hop.registry.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [registry](./js.hop.registry.md) + +## Hop.registry property + +Signature: + +```typescript +readonly registry: { + images: { + getAll(project?: `project_${string}` | undefined): Promise; + getManifest(image: string): Promise< + { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[] + >; + delete(image: string): Promise; + }; + }; +``` diff --git a/docs/js.hop.users.md b/docs/js.hop.users.md new file mode 100644 index 00000000..6d5bffb5 --- /dev/null +++ b/docs/js.hop.users.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [users](./js.hop.users.md) + +## Hop.users property + +Signature: + +```typescript +readonly users: { + me: { + get(): Promise<{ + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: `pat_${string}`): Promise; + }; + }; + }; +``` diff --git a/docs/js.hopapierror._constructor_.md b/docs/js.hopapierror._constructor_.md new file mode 100644 index 00000000..3f22086e --- /dev/null +++ b/docs/js.hopapierror._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [(constructor)](./js.hopapierror._constructor_.md) + +## HopAPIError.(constructor) + +Constructs a new instance of the `HopAPIError` class + +Signature: + +```typescript +constructor(request: Request, response: Response, data: ErroredAPIResponse); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | Request | | +| response | Response | | +| data | [ErroredAPIResponse](./js.erroredapiresponse.md) | | + diff --git a/docs/js.hopapierror.data.md b/docs/js.hopapierror.data.md new file mode 100644 index 00000000..a73cfc20 --- /dev/null +++ b/docs/js.hopapierror.data.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [data](./js.hopapierror.data.md) + +## HopAPIError.data property + +Signature: + +```typescript +readonly data: ErroredAPIResponse; +``` diff --git a/docs/js.hopapierror.md b/docs/js.hopapierror.md new file mode 100644 index 00000000..fe8da293 --- /dev/null +++ b/docs/js.hopapierror.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) + +## HopAPIError class + +Signature: + +```typescript +declare class HopAPIError extends Error +``` +Extends: Error + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(request, response, data)](./js.hopapierror._constructor_.md) | | Constructs a new instance of the HopAPIError class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./js.hopapierror.data.md) | readonly | [ErroredAPIResponse](./js.erroredapiresponse.md) | | +| [request](./js.hopapierror.request.md) | readonly | Request | | +| [response](./js.hopapierror.response.md) | readonly | Response | | +| [status](./js.hopapierror.status.md) | readonly | number | | + diff --git a/docs/js.hopapierror.request.md b/docs/js.hopapierror.request.md new file mode 100644 index 00000000..8d307953 --- /dev/null +++ b/docs/js.hopapierror.request.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [request](./js.hopapierror.request.md) + +## HopAPIError.request property + +Signature: + +```typescript +readonly request: Request; +``` diff --git a/docs/js.hopapierror.response.md b/docs/js.hopapierror.response.md new file mode 100644 index 00000000..50d62913 --- /dev/null +++ b/docs/js.hopapierror.response.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [response](./js.hopapierror.response.md) + +## HopAPIError.response property + +Signature: + +```typescript +readonly response: Response; +``` diff --git a/docs/js.hopapierror.status.md b/docs/js.hopapierror.status.md new file mode 100644 index 00000000..3fd9681c --- /dev/null +++ b/docs/js.hopapierror.status.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [status](./js.hopapierror.status.md) + +## HopAPIError.status property + +Signature: + +```typescript +readonly status: number; +``` diff --git a/docs/js.hopshdomain.md b/docs/js.hopshdomain.md new file mode 100644 index 00000000..9e1292f6 --- /dev/null +++ b/docs/js.hopshdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [HopShDomain](./js.hopshdomain.md) + +## HopShDomain type + +Signature: + +```typescript +declare type HopShDomain = `${string}.hop.sh`; +``` diff --git a/docs/js.id.md b/docs/js.id.md new file mode 100644 index 00000000..cfb88226 --- /dev/null +++ b/docs/js.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Id](./js.id.md) + +## Id type + +Signature: + +```typescript +declare type Id = `${T}_${string}`; +``` +References: [IdPrefixes](./js.idprefixes.md) + diff --git a/docs/js.id_prefixes.md b/docs/js.id_prefixes.md new file mode 100644 index 00000000..77fc4ffa --- /dev/null +++ b/docs/js.id_prefixes.md @@ -0,0 +1,84 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ID\_PREFIXES](./js.id_prefixes.md) + +## ID\_PREFIXES variable + +Signature: + +```typescript +ID_PREFIXES: readonly [ + { + readonly prefix: 'user'; + readonly description: 'Users'; + }, + { + readonly prefix: 'project'; + readonly description: 'Project'; + }, + { + readonly prefix: 'pm'; + readonly description: 'Project Members'; + }, + { + readonly prefix: 'role'; + readonly description: 'Roles'; + }, + { + readonly prefix: 'pi'; + readonly description: 'Project Invite'; + }, + { + readonly prefix: 'ptk'; + readonly description: 'Project token'; + }, + { + readonly prefix: 'pat'; + readonly description: 'User personal access token'; + }, + { + readonly prefix: 'container'; + readonly description: 'Ignite container'; + }, + { + readonly prefix: 'pipe_room'; + readonly description: 'Pipe room'; + }, + { + readonly prefix: 'deployment'; + readonly description: 'Ignite deployment'; + }, + { + readonly prefix: 'bearer'; + readonly description: 'Users bearer token'; + }, + { + readonly prefix: 'ptkid'; + readonly description: 'Project token ID'; + }, + { + readonly prefix: 'secret'; + readonly description: 'Project secret ID'; + }, + { + readonly prefix: 'gateway'; + readonly description: 'Gateway'; + }, + { + readonly prefix: 'domain'; + readonly description: 'Domain for a gateway'; + }, + { + readonly prefix: 'leap_token'; + readonly description: 'Token for connecting to leap as a client'; + }, + { + readonly prefix: 'build'; + readonly description: 'Build ID for build logs'; + }, + { + readonly prefix: 'rollout'; + readonly description: 'Rollout ID for rollouts.'; + }, +] +``` diff --git a/docs/js.idprefixes.md b/docs/js.idprefixes.md new file mode 100644 index 00000000..565ed27c --- /dev/null +++ b/docs/js.idprefixes.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IdPrefixes](./js.idprefixes.md) + +## IdPrefixes type + +Signature: + +```typescript +declare type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; +``` +References: [ID\_PREFIXES](./js.id_prefixes.md) + diff --git a/docs/js.ignite.md b/docs/js.ignite.md new file mode 100644 index 00000000..02f64de6 --- /dev/null +++ b/docs/js.ignite.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Ignite](./js.ignite.md) + +## Ignite namespace + +Signature: + +```typescript +declare namespace ignite +``` diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md new file mode 100644 index 00000000..63331db4 --- /dev/null +++ b/docs/js.igniteendpoints.md @@ -0,0 +1,124 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IgniteEndpoints](./js.igniteendpoints.md) + +## IgniteEndpoints type + +Signature: + +```typescript +declare type IgniteEndpoints = + | Endpoint< + 'GET', + '/v1/ignite/deployments', + { + deployments: Deployment[]; + } + > + | Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id/containers', + { + containers: Container[]; + } + > + | Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/containers', + { + container: Container; + } + > + | Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/containers/:container_id', + never, + { + deployment_id: Id<'deployment'>; + container_id: Id<'container'>; + } + > + | Endpoint< + 'POST', + '/v1/ignite/deployments', + { + deployment: Deployment; + }, + DeploymentConfig + > + | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> + | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> + | Endpoint< + 'GET', + '/v1/ignite/containers/:container_id/logs', + { + logs: ContainerLog[]; + } + > + | Endpoint< + 'GET', + '/v1/ignite/deployments/search', + { + deployment: Deployment; + } + > + | Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id', + { + deployment: Deployment; + } + > + | Endpoint< + 'PUT', + '/v1/ignite/containers/:container_id/state', + Empty, + { + preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; + } + > + | Endpoint< + 'POST', + '/v1/ignite/gateways/:gateway_id/domains', + Empty, + { + domain: string; + } + > + | Endpoint< + 'GET', + '/v1/ignite/gateways/:gateway_id', + { + gateway: Gateway; + } + > + | Endpoint< + 'GET', + '/v1/ignite/deployments/:deployment_id/gateways', + { + gateways: Gateway[]; + } + > + | Endpoint< + 'POST', + '/v1/ignite/deployments/:deployment_id/gateways', + { + gateway: Gateway; + }, + { + type: GatewayType; + target_port: number; + protocol: Gateway['protocol']; + } + > + | Endpoint< + 'PATCH', + '/v1/ignite/deployments/:deployment_id', + { + deployment: Deployment; + }, + DeploymentConfig + >; +``` +References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) + diff --git a/docs/js.image_2.auth.md b/docs/js.image_2.auth.md new file mode 100644 index 00000000..95a908e5 --- /dev/null +++ b/docs/js.image_2.auth.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [auth](./js.image_2.auth.md) + +## Image\_2.auth property + +Authorization required for the registry to access this image This is not required if you use Hop's own registry. + +Signature: + +```typescript +auth: Auth | null; +``` diff --git a/docs/js.image_2.gh_repo.md b/docs/js.image_2.gh_repo.md new file mode 100644 index 00000000..a9bb16be --- /dev/null +++ b/docs/js.image_2.gh_repo.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [gh\_repo](./js.image_2.gh_repo.md) + +## Image\_2.gh\_repo property + +GitHub repo information (if applicable) + +Signature: + +```typescript +gh_repo: ImageGHRepo | null; +``` diff --git a/docs/js.image_2.md b/docs/js.image_2.md new file mode 100644 index 00000000..0a81cf6f --- /dev/null +++ b/docs/js.image_2.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) + +## Image\_2 interface + +Docker image config + +Signature: + +```typescript +interface Image +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [auth](./js.image_2.auth.md) | | [Auth](./js.auth.md) \| null | Authorization required for the registry to access this image This is not required if you use Hop's own registry. | +| [gh\_repo](./js.image_2.gh_repo.md) | | [ImageGHRepo](./js.imageghrepo.md) \| null | GitHub repo information (if applicable) | +| [name](./js.image_2.name.md) | | string \| null | The name of the docker image | + diff --git a/docs/js.image_2.name.md b/docs/js.image_2.name.md new file mode 100644 index 00000000..8ab4559d --- /dev/null +++ b/docs/js.image_2.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [name](./js.image_2.name.md) + +## Image\_2.name property + +The name of the docker image + +Signature: + +```typescript +name: string | null; +``` diff --git a/docs/js.imageghrepo.branch.md b/docs/js.imageghrepo.branch.md new file mode 100644 index 00000000..479d9e9a --- /dev/null +++ b/docs/js.imageghrepo.branch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [branch](./js.imageghrepo.branch.md) + +## ImageGHRepo.branch property + +Signature: + +```typescript +branch: string; +``` diff --git a/docs/js.imageghrepo.full_name.md b/docs/js.imageghrepo.full_name.md new file mode 100644 index 00000000..40c3657a --- /dev/null +++ b/docs/js.imageghrepo.full_name.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [full\_name](./js.imageghrepo.full_name.md) + +## ImageGHRepo.full\_name property + +Signature: + +```typescript +full_name: string; +``` diff --git a/docs/js.imageghrepo.md b/docs/js.imageghrepo.md new file mode 100644 index 00000000..8503ddd1 --- /dev/null +++ b/docs/js.imageghrepo.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) + +## ImageGHRepo interface + +GitHub repo partial used for images + +Signature: + +```typescript +interface ImageGHRepo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [branch](./js.imageghrepo.branch.md) | | string | | +| [full\_name](./js.imageghrepo.full_name.md) | | string | | +| [repo\_id](./js.imageghrepo.repo_id.md) | | number | | + diff --git a/docs/js.imageghrepo.repo_id.md b/docs/js.imageghrepo.repo_id.md new file mode 100644 index 00000000..4e2439d4 --- /dev/null +++ b/docs/js.imageghrepo.repo_id.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [repo\_id](./js.imageghrepo.repo_id.md) + +## ImageGHRepo.repo\_id property + +Signature: + +```typescript +repo_id: number; +``` diff --git a/docs/js.internalhopdomain.md b/docs/js.internalhopdomain.md new file mode 100644 index 00000000..8ee254c8 --- /dev/null +++ b/docs/js.internalhopdomain.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [InternalHopDomain](./js.internalhopdomain.md) + +## InternalHopDomain type + +Signature: + +```typescript +declare type InternalHopDomain = `${string}.hop`; +``` diff --git a/docs/js.is_browser.md b/docs/js.is_browser.md new file mode 100644 index 00000000..a071fafc --- /dev/null +++ b/docs/js.is_browser.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [IS\_BROWSER](./js.is_browser.md) + +## IS\_BROWSER variable + +If we are in the browser. + +Signature: + +```typescript +IS_BROWSER: boolean +``` diff --git a/docs/js.isvalidbytestring.md b/docs/js.isvalidbytestring.md new file mode 100644 index 00000000..556da828 --- /dev/null +++ b/docs/js.isvalidbytestring.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [isValidByteString](./js.isvalidbytestring.md) + +## isValidByteString() function + +Signature: + +```typescript +declare function isValidByteString(value: string): value is ByteSizeString; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | string | | + +Returns: + +value is [ByteSizeString](./js.bytesizestring.md) + diff --git a/docs/js.md b/docs/js.md new file mode 100644 index 00000000..af94a8fe --- /dev/null +++ b/docs/js.md @@ -0,0 +1,145 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) + +## js package + +## Classes + +| Class | Description | +| --- | --- | +| [APIClient](./js.apiclient.md) | | +| [Hop](./js.hop.md) | Constructs a new instance of Hop and all of its SDKs. | +| [HopAPIError](./js.hopapierror.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [BuildMethod](./js.buildmethod.md) | Types of build methods supported by Hop | +| [BuildState](./js.buildstate.md) | | +| [ChannelType](./js.channeltype.md) | | +| [ContainerState](./js.containerstate.md) | Container state is relatively self-explanatory. It describes what the container is currently doing. | +| [DomainState](./js.domainstate.md) | | +| [GatewayType](./js.gatewaytype.md) | Types of gateways supported by Hop | +| [PROJECT\_PERMISSION](./js.project_permission.md) | | +| [ProjectTier](./js.projecttier.md) | | +| [ProjectType](./js.projecttype.md) | Type of a project | +| [Regions](./js.regions.md) | | +| [RestartPolicy](./js.restartpolicy.md) | Restart policy for deployments | +| [RolloutState](./js.rolloutstate.md) | Rollout state for deployments | +| [RuntimeType](./js.runtimetype.md) | Runtime types are used to describe the type of a deployment or container | +| [VgpuType](./js.vgputype.md) | Types for supported GPU | +| [VolumeFormat](./js.volumeformat.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [assertId(maybeId, prefix, message)](./js.assertid.md) | Asserts that a string is a valid ID | +| [getIdPrefix(id, expect)](./js.getidprefix.md) | | +| [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | +| [isValidByteString(value)](./js.isvalidbytestring.md) | | +| [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | +| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | | +| [validateId(maybeId, prefix)](./js.validateid.md) | Validates that a string is a valid ID | +| [validateIdPrefix(prefix, expect)](./js.validateidprefix.md) | Checks if a string is a valid Hop ID prefix | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [APIClientOptions](./js.apiclientoptions.md) | | +| [Auth](./js.auth.md) | Docker image registry authorization | +| [Build](./js.build.md) | | +| [BuildMetaData](./js.buildmetadata.md) | | +| [Channel](./js.channel.md) | | +| [ChannelToken](./js.channeltoken.md) | | +| [Container](./js.container.md) | | +| [ContainerLog](./js.containerlog.md) | Logs from a container | +| [DefaultQuotas](./js.defaultquotas.md) | | +| [Deployment](./js.deployment.md) | | +| [Domain](./js.domain.md) | | +| [Gateway](./js.gateway.md) | Gateways are used to connect services to the internet or a private network | +| [GHRepo](./js.ghrepo.md) | GitHub repo type sent from API (NOT USED IN IMAGES) | +| [Image\_2](./js.image_2.md) | Docker image config | +| [ImageGHRepo](./js.imageghrepo.md) | GitHub repo partial used for images | +| [MemberRole](./js.memberrole.md) | | +| [PAT](./js.pat.md) | | +| [Project](./js.project.md) | | +| [ProjectToken](./js.projecttoken.md) | A project token for a project | +| [QuotaOverrides](./js.quotaoverrides.md) | | +| [QuotaUsage](./js.quotausage.md) | | +| [Resources](./js.resources.md) | Resources allocated to a deployment | +| [Room](./js.room.md) | | +| [Secret](./js.secret.md) | | +| [User](./js.user.md) | A user objct | +| [Vgpu](./js.vgpu.md) | Virtual GPU config | +| [VolumeDefinition](./js.volumedefinition.md) | | + +## Namespaces + +| Namespace | Description | +| --- | --- | +| [API](./js.api.md) | | +| [Channels](./js.channels.md) | | +| [Ignite](./js.ignite.md) | | +| [Pipe](./js.pipe.md) | | +| [Projects](./js.projects.md) | | +| [Registry](./js.registry.md) | | +| [Users](./js.users.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | | +| [byteUnits](./js.byteunits.md) | | +| [DEFAULT\_BASE\_URL](./js.default_base_url.md) | The default base URL for Hop's API. | +| [ID\_PREFIXES](./js.id_prefixes.md) | | +| [IS\_BROWSER](./js.is_browser.md) | If we are in the browser. | +| [permissions](./js.permissions.md) | | +| [permissionsMap](./js.permissionsmap.md) | | +| [roles](./js.roles.md) | | +| [SUPPORTS\_INTL](./js.supports_intl.md) | | +| [units](./js.units.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [AnyId](./js.anyid.md) | | +| [APIAuthentication](./js.apiauthentication.md) | | +| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | | +| [APIResponse](./js.apiresponse.md) | | +| [ByteSizeString](./js.bytesizestring.md) | | +| [ByteString](./js.bytestring.md) | | +| [ByteUnit](./js.byteunit.md) | | +| [ChannelEndpoints](./js.channelendpoints.md) | | +| [DeliveryProtocol](./js.deliveryprotocol.md) | | +| [DeploymentConfig](./js.deploymentconfig.md) | | +| [DeploymentRollout](./js.deploymentrollout.md) | | +| [Empty](./js.empty.md) | | +| [Endpoint](./js.endpoint.md) | | +| [Endpoints](./js.endpoints.md) | | +| [ErroredAPIResponse](./js.erroredapiresponse.md) | | +| [ExtractRouteParams](./js.extractrouteparams.md) | | +| [HopShDomain](./js.hopshdomain.md) | | +| [Id](./js.id.md) | | +| [IdPrefixes](./js.idprefixes.md) | | +| [IgniteEndpoints](./js.igniteendpoints.md) | | +| [InternalHopDomain](./js.internalhopdomain.md) | | +| [Member](./js.member.md) | | +| [Method](./js.method.md) | | +| [PartialAPIOptions](./js.partialapioptions.md) | | +| [PipeEndpoints](./js.pipeendpoints.md) | | +| [ProjectsEndpoints](./js.projectsendpoints.md) | | +| [Query](./js.query.md) | | +| [RegistryEndpoints](./js.registryendpoints.md) | | +| [State](./js.state.md) | | +| [SuccessfulAPIResponse](./js.successfulapiresponse.md) | | +| [Tag](./js.tag.md) | | +| [Timestamp](./js.timestamp.md) | Hop's API uses ISO 8601 date strings | +| [UserEndpoints](./js.userendpoints.md) | | +| [Values](./js.values.md) | | + diff --git a/docs/js.member.md b/docs/js.member.md new file mode 100644 index 00000000..8cb20d8a --- /dev/null +++ b/docs/js.member.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Member](./js.member.md) + +## Member type + +Signature: + +```typescript +declare type Member = Omit & { + id: Id<'pm'>; + role: MemberRole; + joined_at: Timestamp; +}; +``` +References: [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [Timestamp](./js.timestamp.md) + diff --git a/docs/js.memberrole.flags.md b/docs/js.memberrole.flags.md new file mode 100644 index 00000000..2e0c80d2 --- /dev/null +++ b/docs/js.memberrole.flags.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [flags](./js.memberrole.flags.md) + +## MemberRole.flags property + +The flags for this role + +Signature: + +```typescript +flags: number; +``` diff --git a/docs/js.memberrole.id.md b/docs/js.memberrole.id.md new file mode 100644 index 00000000..f270fc72 --- /dev/null +++ b/docs/js.memberrole.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [id](./js.memberrole.id.md) + +## MemberRole.id property + +The ID of the role + +Signature: + +```typescript +id: Id<'role'>; +``` diff --git a/docs/js.memberrole.md b/docs/js.memberrole.md new file mode 100644 index 00000000..25369fad --- /dev/null +++ b/docs/js.memberrole.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) + +## MemberRole interface + +Signature: + +```typescript +interface MemberRole +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [flags](./js.memberrole.flags.md) | | number | The flags for this role | +| [id](./js.memberrole.id.md) | | [Id](./js.id.md)<'role'> | The ID of the role | +| [name](./js.memberrole.name.md) | | string | The name of the role | + diff --git a/docs/js.memberrole.name.md b/docs/js.memberrole.name.md new file mode 100644 index 00000000..ecdd270d --- /dev/null +++ b/docs/js.memberrole.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [name](./js.memberrole.name.md) + +## MemberRole.name property + +The name of the role + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.method.md b/docs/js.method.md new file mode 100644 index 00000000..a7e55a41 --- /dev/null +++ b/docs/js.method.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) + +## Method type + +Signature: + +```typescript +declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +``` diff --git a/docs/js.parsesize.md b/docs/js.parsesize.md new file mode 100644 index 00000000..322ce2fa --- /dev/null +++ b/docs/js.parsesize.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [parseSize](./js.parsesize.md) + +## parseSize() function + +Parses a byte size string into bytes + +Signature: + +```typescript +declare function parseSize(size: string): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| size | string | The size of anything in gigabytes, megabytes, kilobytes or bytes | + +Returns: + +number + diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md new file mode 100644 index 00000000..29182df9 --- /dev/null +++ b/docs/js.partialapioptions.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PartialAPIOptions](./js.partialapioptions.md) + +## PartialAPIOptions type + +Signature: + +```typescript +declare type PartialAPIOptions = Partial< + Omit +> & + Pick; +``` +References: [APIClientOptions](./js.apiclientoptions.md) + diff --git a/docs/js.pat.created_at.md b/docs/js.pat.created_at.md new file mode 100644 index 00000000..06e61761 --- /dev/null +++ b/docs/js.pat.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [created\_at](./js.pat.created_at.md) + +## PAT.created\_at property + +The date the pat was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.pat.id.md b/docs/js.pat.id.md new file mode 100644 index 00000000..2931e3ae --- /dev/null +++ b/docs/js.pat.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [id](./js.pat.id.md) + +## PAT.id property + +The ID of the pat + +Signature: + +```typescript +id: Id<'pat'>; +``` diff --git a/docs/js.pat.md b/docs/js.pat.md new file mode 100644 index 00000000..ebd93103 --- /dev/null +++ b/docs/js.pat.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) + +## PAT interface + +Signature: + +```typescript +interface PAT +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.pat.created_at.md) | | [Timestamp](./js.timestamp.md) | The date the pat was created | +| [id](./js.pat.id.md) | | [Id](./js.id.md)<'pat'> | The ID of the pat | +| [name](./js.pat.name.md) | | string \| null | The name of the pat | + diff --git a/docs/js.pat.name.md b/docs/js.pat.name.md new file mode 100644 index 00000000..1312d7b5 --- /dev/null +++ b/docs/js.pat.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [name](./js.pat.name.md) + +## PAT.name property + +The name of the pat + +Signature: + +```typescript +name: string | null; +``` diff --git a/docs/js.permissions.md b/docs/js.permissions.md new file mode 100644 index 00000000..1d1bcc7b --- /dev/null +++ b/docs/js.permissions.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [permissions](./js.permissions.md) + +## permissions variable + +Signature: + +```typescript +permissions: { + add(value: bigint, flag: bigint): bigint; + test(value: bigint, flag: bigint): boolean; + subtract(value: bigint, flag: bigint): bigint; +} +``` diff --git a/docs/js.permissionsmap.md b/docs/js.permissionsmap.md new file mode 100644 index 00000000..8e9de96e --- /dev/null +++ b/docs/js.permissionsmap.md @@ -0,0 +1,56 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [permissionsMap](./js.permissionsmap.md) + +## permissionsMap variable + +Signature: + +```typescript +permissionsMap: { + add_member: bigint; + remove_member: bigint; + get_project_members: bigint; + delete_project: bigint; + delete_deployment: bigint; + delete_container: bigint; + update_container_state: bigint; + read_deployments: bigint; + create_deployment: bigint; + create_container: bigint; + update_container_config: bigint; + create_room: bigint; + read_room: bigint; + delete_room: bigint; + create_room_producer: bigint; + create_project_token: bigint; + delete_project_token: bigint; + read_project_tokens: bigint; + read_container_logs: bigint; + create_project_secret: bigint; + read_project_secrets: bigint; + delete_project_secret: bigint; + get_registry_images: bigint; + create_channel_token: bigint; + create_gateway: bigint; + add_domain: bigint; + delete_channels: bigint; + update_channel_state: bigint; + read_channels: bigint; + publish_channel_messages: bigint; + manage_channel_subscribers: bigint; + delete_domain: bigint; + delete_gateway: bigint; + get_internal_domain: bigint; + create_leap_token: bigint; + read_leap_tokens: bigint; + update_leap_token: bigint; + message_token: bigint; + create_channel: bigint; + rollout: bigint; + request_quota_increase: bigint; + read_billing: bigint; + read_gateways: bigint; + delete_registry_images: bigint; +} +``` diff --git a/docs/js.pipe.md b/docs/js.pipe.md new file mode 100644 index 00000000..09432b46 --- /dev/null +++ b/docs/js.pipe.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Pipe](./js.pipe.md) + +## Pipe namespace + +Signature: + +```typescript +declare namespace pipe +``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md new file mode 100644 index 00000000..ca9cf39d --- /dev/null +++ b/docs/js.pipeendpoints.md @@ -0,0 +1,40 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PipeEndpoints](./js.pipeendpoints.md) + +## PipeEndpoints type + +Signature: + +```typescript +declare type PipeEndpoints = + | Endpoint< + 'GET', + '/v1/pipe/rooms', + { + rooms: Room[]; + } + > + | Endpoint< + 'POST', + '/v1/pipe/rooms', + { + room: Room; + }, + { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; + } + > + | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) + diff --git a/docs/js.project.created_at.md b/docs/js.project.created_at.md new file mode 100644 index 00000000..0b1cbd9f --- /dev/null +++ b/docs/js.project.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [created\_at](./js.project.created_at.md) + +## Project.created\_at property + +The time this project was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.project.default_quotas.md b/docs/js.project.default_quotas.md new file mode 100644 index 00000000..3c67e09b --- /dev/null +++ b/docs/js.project.default_quotas.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [default\_quotas](./js.project.default_quotas.md) + +## Project.default\_quotas property + +Signature: + +```typescript +default_quotas: DefaultQuotas; +``` diff --git a/docs/js.project.icon.md b/docs/js.project.icon.md new file mode 100644 index 00000000..50950ecf --- /dev/null +++ b/docs/js.project.icon.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [icon](./js.project.icon.md) + +## Project.icon property + +An icon for this project + +Signature: + +```typescript +icon: string | null; +``` diff --git a/docs/js.project.id.md b/docs/js.project.id.md new file mode 100644 index 00000000..1e88e80b --- /dev/null +++ b/docs/js.project.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [id](./js.project.id.md) + +## Project.id property + +The ID of the project + +Signature: + +```typescript +id: Id<'project'>; +``` diff --git a/docs/js.project.md b/docs/js.project.md new file mode 100644 index 00000000..447623d1 --- /dev/null +++ b/docs/js.project.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) + +## Project interface + +Signature: + +```typescript +interface Project +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.project.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project was created at | +| [default\_quotas](./js.project.default_quotas.md) | | [DefaultQuotas](./js.defaultquotas.md) | | +| [icon](./js.project.icon.md) | | string \| null | An icon for this project | +| [id](./js.project.id.md) | | [Id](./js.id.md)<'project'> | The ID of the project | +| [name](./js.project.name.md) | | string | The name of the project | +| [namespace](./js.project.namespace.md) | | string | The registry namespace for this project | +| [quota\_overrides](./js.project.quota_overrides.md) | | [QuotaOverrides](./js.quotaoverrides.md) | | +| [quota\_usage](./js.project.quota_usage.md) | | [QuotaUsage](./js.quotausage.md) | | +| [tier](./js.project.tier.md) | | [ProjectTier](./js.projecttier.md) | The tier this project is | +| [type](./js.project.type.md) | | [ProjectType](./js.projecttype.md) | The type of this project. Either regular or personal | + diff --git a/docs/js.project.name.md b/docs/js.project.name.md new file mode 100644 index 00000000..b138c95c --- /dev/null +++ b/docs/js.project.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [name](./js.project.name.md) + +## Project.name property + +The name of the project + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.project.namespace.md b/docs/js.project.namespace.md new file mode 100644 index 00000000..aaa8fdc8 --- /dev/null +++ b/docs/js.project.namespace.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [namespace](./js.project.namespace.md) + +## Project.namespace property + +The registry namespace for this project + +Signature: + +```typescript +namespace: string; +``` diff --git a/docs/js.project.quota_overrides.md b/docs/js.project.quota_overrides.md new file mode 100644 index 00000000..1d16a7da --- /dev/null +++ b/docs/js.project.quota_overrides.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_overrides](./js.project.quota_overrides.md) + +## Project.quota\_overrides property + +Signature: + +```typescript +quota_overrides: QuotaOverrides; +``` diff --git a/docs/js.project.quota_usage.md b/docs/js.project.quota_usage.md new file mode 100644 index 00000000..0ba5afce --- /dev/null +++ b/docs/js.project.quota_usage.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_usage](./js.project.quota_usage.md) + +## Project.quota\_usage property + +Signature: + +```typescript +quota_usage: QuotaUsage; +``` diff --git a/docs/js.project.tier.md b/docs/js.project.tier.md new file mode 100644 index 00000000..684e6f73 --- /dev/null +++ b/docs/js.project.tier.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [tier](./js.project.tier.md) + +## Project.tier property + +The tier this project is + +Signature: + +```typescript +tier: ProjectTier; +``` diff --git a/docs/js.project.type.md b/docs/js.project.type.md new file mode 100644 index 00000000..66f2c248 --- /dev/null +++ b/docs/js.project.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [type](./js.project.type.md) + +## Project.type property + +The type of this project. Either regular or personal + +Signature: + +```typescript +type: ProjectType; +``` diff --git a/docs/js.project_permission.md b/docs/js.project_permission.md new file mode 100644 index 00000000..69604129 --- /dev/null +++ b/docs/js.project_permission.md @@ -0,0 +1,61 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [PROJECT\_PERMISSION](./js.project_permission.md) + +## PROJECT\_PERMISSION enum + +Signature: + +```typescript +declare enum PROJECT_PERMISSION +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ADD\_DOMAIN | 'add_domain' | | +| ADD\_MEMBER | 'add_member' | | +| CREATE\_CHANNEL | 'create_channel' | | +| CREATE\_CHANNEL\_TOKEN | 'create_channel_token' | | +| CREATE\_CONTAINER | 'create_container' | | +| CREATE\_DEPLOYMENT | 'create_deployment' | | +| CREATE\_GATEWAY | 'create_gateway' | | +| CREATE\_LEAP\_TOKEN | 'create_leap_token' | | +| CREATE\_PROJECT\_SECRET | 'create_project_secret' | | +| CREATE\_PROJECT\_TOKEN | 'create_project_token' | | +| CREATE\_ROOM | 'create_room' | | +| CREATE\_ROOM\_PRODUCER | 'create_room_producer' | | +| DELETE\_CHANNELS | 'delete_channels' | | +| DELETE\_CONTAINER | 'delete_container' | | +| DELETE\_DEPLOYMENT | 'delete_deployment' | | +| DELETE\_DOMAIN | 'delete_domain' | | +| DELETE\_GATEWAY | 'delete_gateway' | | +| DELETE\_PROJECT | 'delete_project' | | +| DELETE\_PROJECT\_SECRET | 'delete_project_secret' | | +| DELETE\_PROJECT\_TOKEN | 'delete_project_token' | | +| DELETE\_REGISTRY\_IMAGES | 'delete_registry_images' | | +| DELETE\_ROOM | 'delete_room' | | +| GET\_INTERNAL\_DOMAIN | 'get_internal_domain' | | +| GET\_PROJECT\_MEMBERS | 'get_project_members' | | +| GET\_REGISTRY\_IMAGES | 'get_registry_images' | | +| MANAGE\_CHANNEL\_SUBSCRIBERS | 'manage_channel_subscribers' | | +| MESSAGE\_TOKEN | 'message_token' | | +| PUBLISH\_CHANNEL\_MESSAGES | 'publish_channel_messages' | | +| READ\_BILLING | 'read_billing' | | +| READ\_CHANNELS | 'read_channels' | | +| READ\_CONTAINER\_LOGS | 'read_container_logs' | | +| READ\_DEPLOYMENTS | 'read_deployments' | | +| READ\_GATEWAYS | 'read_gateways' | | +| READ\_LEAP\_TOKENS | 'read_leap_tokens' | | +| READ\_PROJECT\_SECRETS | 'read_project_secrets' | | +| READ\_PROJECT\_TOKENS | 'read_project_tokens' | | +| READ\_ROOM | 'read_room' | | +| REMOVE\_MEMBER | 'remove_member' | | +| REQUEST\_QUOTA\_INCREASE | 'request_quota_increase' | | +| ROLLOUT | 'rollout' | | +| UPDATE\_CHANNEL\_STATE | 'update_channel_state' | | +| UPDATE\_CONTAINER\_CONFIG | 'update_container_config' | | +| UPDATE\_CONTAINER\_STATE | 'update_container_state' | | +| UPDATE\_LEAP\_TOKEN | 'update_leap_token' | | + diff --git a/docs/js.projects.md b/docs/js.projects.md new file mode 100644 index 00000000..6cadb993 --- /dev/null +++ b/docs/js.projects.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Projects](./js.projects.md) + +## Projects namespace + +Signature: + +```typescript +declare namespace projects +``` diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md new file mode 100644 index 00000000..1f9abd15 --- /dev/null +++ b/docs/js.projectsendpoints.md @@ -0,0 +1,110 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectsEndpoints](./js.projectsendpoints.md) + +## ProjectsEndpoints type + +Signature: + +```typescript +declare type ProjectsEndpoints = + | Endpoint< + 'DELETE', + '/v1/projects/:project_id/tokens/:project_token_id', + Empty + > + | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> + | Endpoint< + 'GET', + '/v1/projects/:project_id/members/@me', + { + project_member: Member; + } + > + | Endpoint< + 'GET', + '/v1/projects/:project_id/tokens', + { + project_tokens: ProjectToken[]; + } + > + | Endpoint< + 'GET', + '/v1/projects/@this/tokens', + { + project_tokens: ProjectToken[]; + } + > + | Endpoint< + 'GET', + '/v1/projects/:project_id/members', + { + members: Member[]; + } + > + | Endpoint< + 'GET', + '/v1/projects/@this/members', + { + members: Member[]; + } + > + | Endpoint< + 'POST', + '/v1/projects/:project_id/tokens', + { + project_token: ProjectToken & { + project: Project; + }; + }, + { + flags: number; + } + > + | Endpoint< + 'POST', + '/v1/projects/@this/tokens', + { + project_token: ProjectToken & { + project: Project; + }; + }, + { + flags: number; + } + > + | Endpoint< + 'PUT', + '/v1/projects/:project_id/secrets/:name', + { + secret: Secret; + }, + string + > + | Endpoint< + 'PUT', + '/v1/projects/@this/secrets/:name', + { + secret: Secret; + }, + string + > + | Endpoint< + 'GET', + '/v1/projects/:project_id/secrets', + { + secrets: Secret[]; + } + > + | Endpoint< + 'GET', + '/v1/projects/@this/secrets', + { + secrets: Secret[]; + } + > + | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> + | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) + diff --git a/docs/js.projecttier.md b/docs/js.projecttier.md new file mode 100644 index 00000000..ddf175c0 --- /dev/null +++ b/docs/js.projecttier.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectTier](./js.projecttier.md) + +## ProjectTier enum + +Signature: + +```typescript +declare enum ProjectTier +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| FREE | 'free' | | +| PAID | 'paid' | | + diff --git a/docs/js.projecttoken.created_at.md b/docs/js.projecttoken.created_at.md new file mode 100644 index 00000000..4ff2416f --- /dev/null +++ b/docs/js.projecttoken.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [created\_at](./js.projecttoken.created_at.md) + +## ProjectToken.created\_at property + +The time this project token was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.projecttoken.flags.md b/docs/js.projecttoken.flags.md new file mode 100644 index 00000000..af2769a6 --- /dev/null +++ b/docs/js.projecttoken.flags.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [flags](./js.projecttoken.flags.md) + +## ProjectToken.flags property + +Permissions and flags that this project token can perform + +Signature: + +```typescript +flags: number; +``` diff --git a/docs/js.projecttoken.id.md b/docs/js.projecttoken.id.md new file mode 100644 index 00000000..1b4ef352 --- /dev/null +++ b/docs/js.projecttoken.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [id](./js.projecttoken.id.md) + +## ProjectToken.id property + +The Id of the project token + +Signature: + +```typescript +id: Id<'ptkid'>; +``` diff --git a/docs/js.projecttoken.md b/docs/js.projecttoken.md new file mode 100644 index 00000000..b35917ad --- /dev/null +++ b/docs/js.projecttoken.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) + +## ProjectToken interface + +A project token for a project + +Signature: + +```typescript +interface ProjectToken +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.projecttoken.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project token was created | +| [flags](./js.projecttoken.flags.md) | | number | Permissions and flags that this project token can perform | +| [id](./js.projecttoken.id.md) | | [Id](./js.id.md)<'ptkid'> | The Id of the project token | +| [token](./js.projecttoken.token.md) | | [Id](./js.id.md)<'ptk'> | The key value. This will likely have half of the key obfuscated | + diff --git a/docs/js.projecttoken.token.md b/docs/js.projecttoken.token.md new file mode 100644 index 00000000..5a4ac224 --- /dev/null +++ b/docs/js.projecttoken.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [token](./js.projecttoken.token.md) + +## ProjectToken.token property + +The key value. This will likely have half of the key obfuscated + +Signature: + +```typescript +token: Id<'ptk'>; +``` diff --git a/docs/js.projecttype.md b/docs/js.projecttype.md new file mode 100644 index 00000000..7f2c7f47 --- /dev/null +++ b/docs/js.projecttype.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ProjectType](./js.projecttype.md) + +## ProjectType enum + +Type of a project + +Signature: + +```typescript +declare enum ProjectType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| PERSONAL | 'personal' | A personal project are created when you register an account | +| REGULAR | 'regular' | A standard project type | + diff --git a/docs/js.query.md b/docs/js.query.md new file mode 100644 index 00000000..a48133b3 --- /dev/null +++ b/docs/js.query.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Query](./js.query.md) + +## Query type + +Signature: + +```typescript +declare type Query = ExtractRouteParams & + Record; +``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.quotaoverrides.md b/docs/js.quotaoverrides.md new file mode 100644 index 00000000..b621ac8b --- /dev/null +++ b/docs/js.quotaoverrides.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaOverrides](./js.quotaoverrides.md) + +## QuotaOverrides interface + +Signature: + +```typescript +interface QuotaOverrides +``` diff --git a/docs/js.quotausage.md b/docs/js.quotausage.md new file mode 100644 index 00000000..343de5a0 --- /dev/null +++ b/docs/js.quotausage.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) + +## QuotaUsage interface + +Signature: + +```typescript +interface QuotaUsage +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.quotausage.ram.md) | | number | | +| [vcpu](./js.quotausage.vcpu.md) | | number | | + diff --git a/docs/js.quotausage.ram.md b/docs/js.quotausage.ram.md new file mode 100644 index 00000000..2f0bc2e4 --- /dev/null +++ b/docs/js.quotausage.ram.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [ram](./js.quotausage.ram.md) + +## QuotaUsage.ram property + +Signature: + +```typescript +ram: number; +``` diff --git a/docs/js.quotausage.vcpu.md b/docs/js.quotausage.vcpu.md new file mode 100644 index 00000000..a4609646 --- /dev/null +++ b/docs/js.quotausage.vcpu.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [vcpu](./js.quotausage.vcpu.md) + +## QuotaUsage.vcpu property + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.regions.md b/docs/js.regions.md new file mode 100644 index 00000000..db9c1f4b --- /dev/null +++ b/docs/js.regions.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Regions](./js.regions.md) + +## Regions enum + +Signature: + +```typescript +declare enum Regions +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| US\_EAST\_1 | 'us-east-1' | | + diff --git a/docs/js.registry.md b/docs/js.registry.md new file mode 100644 index 00000000..3df4f856 --- /dev/null +++ b/docs/js.registry.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Registry](./js.registry.md) + +## Registry namespace + +Signature: + +```typescript +declare namespace registry +``` diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md new file mode 100644 index 00000000..be45347b --- /dev/null +++ b/docs/js.registryendpoints.md @@ -0,0 +1,35 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RegistryEndpoints](./js.registryendpoints.md) + +## RegistryEndpoints type + +Signature: + +```typescript +declare type RegistryEndpoints = + | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> + | Endpoint< + 'GET', + '/v1/registry/images', + { + images: string[]; + } + > + | Endpoint< + 'GET', + '/v1/registry/images/:image/manifests', + { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; + } + >; +``` +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) + diff --git a/docs/js.resources.md b/docs/js.resources.md new file mode 100644 index 00000000..70132304 --- /dev/null +++ b/docs/js.resources.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) + +## Resources interface + +Resources allocated to a deployment + +Signature: + +```typescript +interface Resources +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [ram](./js.resources.ram.md) | | [ByteSizeString](./js.bytesizestring.md) | Amount of memory to allocate in a readible format You can use the parseSize function to convert this to bytes. | +| [vcpu](./js.resources.vcpu.md) | | number | Amount of vCPU to allocate | +| [vgpu](./js.resources.vgpu.md) | | [Vgpu](./js.vgpu.md)\[\] | vGPUs to allocate | + diff --git a/docs/js.resources.ram.md b/docs/js.resources.ram.md new file mode 100644 index 00000000..f4d6207d --- /dev/null +++ b/docs/js.resources.ram.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [ram](./js.resources.ram.md) + +## Resources.ram property + +Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes. + +Signature: + +```typescript +ram: ByteSizeString; +``` diff --git a/docs/js.resources.vcpu.md b/docs/js.resources.vcpu.md new file mode 100644 index 00000000..ebcb3493 --- /dev/null +++ b/docs/js.resources.vcpu.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vcpu](./js.resources.vcpu.md) + +## Resources.vcpu property + +Amount of vCPU to allocate + +Signature: + +```typescript +vcpu: number; +``` diff --git a/docs/js.resources.vgpu.md b/docs/js.resources.vgpu.md new file mode 100644 index 00000000..cac4f7bf --- /dev/null +++ b/docs/js.resources.vgpu.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vgpu](./js.resources.vgpu.md) + +## Resources.vgpu property + +vGPUs to allocate + +Signature: + +```typescript +vgpu: Vgpu[]; +``` diff --git a/docs/js.restartpolicy.md b/docs/js.restartpolicy.md new file mode 100644 index 00000000..a8e0249e --- /dev/null +++ b/docs/js.restartpolicy.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RestartPolicy](./js.restartpolicy.md) + +## RestartPolicy enum + +Restart policy for deployments + +Signature: + +```typescript +declare enum RestartPolicy +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| ALWAYS | 'always' | | +| NEVER | 'never' | | +| ON\_FAILURE | 'on-failure' | | + diff --git a/docs/js.roles.md b/docs/js.roles.md new file mode 100644 index 00000000..be230eef --- /dev/null +++ b/docs/js.roles.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [roles](./js.roles.md) + +## roles variable + +Signature: + +```typescript +roles: { + viewer: bigint; + editor: bigint; + admin: bigint; + owner: bigint; +} +``` diff --git a/docs/js.rolloutstate.md b/docs/js.rolloutstate.md new file mode 100644 index 00000000..b74ca88b --- /dev/null +++ b/docs/js.rolloutstate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RolloutState](./js.rolloutstate.md) + +## RolloutState enum + +Rollout state for deployments + +Signature: + +```typescript +declare enum RolloutState +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| FAILED | 'failed' | | +| FINISHED | 'finished' | | +| PENDING | 'pending' | | + diff --git a/docs/js.room.created_at.md b/docs/js.room.created_at.md new file mode 100644 index 00000000..433be446 --- /dev/null +++ b/docs/js.room.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [created\_at](./js.room.created_at.md) + +## Room.created\_at property + +The unix timestamp of when this stream was created + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.room.delivery_protocols.md b/docs/js.room.delivery_protocols.md new file mode 100644 index 00000000..197896db --- /dev/null +++ b/docs/js.room.delivery_protocols.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [delivery\_protocols](./js.room.delivery_protocols.md) + +## Room.delivery\_protocols property + +Protocols that are supported by this room to the client + +Signature: + +```typescript +delivery_protocols: DeliveryProtocol[]; +``` diff --git a/docs/js.room.id.md b/docs/js.room.id.md new file mode 100644 index 00000000..2ec7f4f4 --- /dev/null +++ b/docs/js.room.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [id](./js.room.id.md) + +## Room.id property + +The ID of this stream + +Signature: + +```typescript +id: Id<'pipe_room'>; +``` diff --git a/docs/js.room.ingest_endpoint.md b/docs/js.room.ingest_endpoint.md new file mode 100644 index 00000000..8abeaa5d --- /dev/null +++ b/docs/js.room.ingest_endpoint.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_endpoint](./js.room.ingest_endpoint.md) + +## Room.ingest\_endpoint property + +The URL that you can stream to + +Signature: + +```typescript +ingest_endpoint: string; +``` diff --git a/docs/js.room.ingest_protocol.md b/docs/js.room.ingest_protocol.md new file mode 100644 index 00000000..672c9a50 --- /dev/null +++ b/docs/js.room.ingest_protocol.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_protocol](./js.room.ingest_protocol.md) + +## Room.ingest\_protocol property + +Protocol you can stream with + +Signature: + +```typescript +ingest_protocol: 'rtmp'; +``` diff --git a/docs/js.room.ingest_region.md b/docs/js.room.ingest_region.md new file mode 100644 index 00000000..1ac0ab09 --- /dev/null +++ b/docs/js.room.ingest_region.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_region](./js.room.ingest_region.md) + +## Room.ingest\_region property + +The region that the stream url is located in + +Signature: + +```typescript +ingest_region: Regions; +``` diff --git a/docs/js.room.join_token.md b/docs/js.room.join_token.md new file mode 100644 index 00000000..f701d3db --- /dev/null +++ b/docs/js.room.join_token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [join\_token](./js.room.join_token.md) + +## Room.join\_token property + +A join token to subscribe into this room + +Signature: + +```typescript +join_token: string; +``` diff --git a/docs/js.room.md b/docs/js.room.md new file mode 100644 index 00000000..438ec36e --- /dev/null +++ b/docs/js.room.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) + +## Room interface + +Signature: + +```typescript +interface Room +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.room.created_at.md) | | [Timestamp](./js.timestamp.md) | The unix timestamp of when this stream was created | +| [delivery\_protocols](./js.room.delivery_protocols.md) | | [DeliveryProtocol](./js.deliveryprotocol.md)\[\] | Protocols that are supported by this room to the client | +| [id](./js.room.id.md) | | [Id](./js.id.md)<'pipe\_room'> | The ID of this stream | +| [ingest\_endpoint](./js.room.ingest_endpoint.md) | | string | The URL that you can stream to | +| [ingest\_protocol](./js.room.ingest_protocol.md) | | 'rtmp' | Protocol you can stream with | +| [ingest\_region](./js.room.ingest_region.md) | | [Regions](./js.regions.md) | The region that the stream url is located in | +| [join\_token](./js.room.join_token.md) | | string | A join token to subscribe into this room | +| [name](./js.room.name.md) | | string | The name of this room | +| [state](./js.room.state.md) | | 'live' \| 'offline' | The state of the stream currently | + diff --git a/docs/js.room.name.md b/docs/js.room.name.md new file mode 100644 index 00000000..705a6e13 --- /dev/null +++ b/docs/js.room.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [name](./js.room.name.md) + +## Room.name property + +The name of this room + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.room.state.md b/docs/js.room.state.md new file mode 100644 index 00000000..bfa47804 --- /dev/null +++ b/docs/js.room.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [state](./js.room.state.md) + +## Room.state property + +The state of the stream currently + +Signature: + +```typescript +state: 'live' | 'offline'; +``` diff --git a/docs/js.runtimetype.md b/docs/js.runtimetype.md new file mode 100644 index 00000000..2739f040 --- /dev/null +++ b/docs/js.runtimetype.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [RuntimeType](./js.runtimetype.md) + +## RuntimeType enum + +Runtime types are used to describe the type of a deployment or container + +Signature: + +```typescript +declare enum RuntimeType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EPHEMERAL | 'ephemeral' | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | +| PERSISTENT | 'persistent' | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | +| STATEFUL | 'stateful' | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | + diff --git a/docs/js.secret.created_at.md b/docs/js.secret.created_at.md new file mode 100644 index 00000000..b28a9883 --- /dev/null +++ b/docs/js.secret.created_at.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [created\_at](./js.secret.created_at.md) + +## Secret.created\_at property + +The time this secret was created at + +Signature: + +```typescript +created_at: Timestamp; +``` diff --git a/docs/js.secret.digest.md b/docs/js.secret.digest.md new file mode 100644 index 00000000..93e79489 --- /dev/null +++ b/docs/js.secret.digest.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [digest](./js.secret.digest.md) + +## Secret.digest property + +A digest hash of the secret + +Signature: + +```typescript +digest: string; +``` diff --git a/docs/js.secret.id.md b/docs/js.secret.id.md new file mode 100644 index 00000000..6a9d0d47 --- /dev/null +++ b/docs/js.secret.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [id](./js.secret.id.md) + +## Secret.id property + +The ID of the secret + +Signature: + +```typescript +id: Id<'secret'>; +``` diff --git a/docs/js.secret.md b/docs/js.secret.md new file mode 100644 index 00000000..75cd9fb3 --- /dev/null +++ b/docs/js.secret.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) + +## Secret interface + +Signature: + +```typescript +interface Secret +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [created\_at](./js.secret.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this secret was created at | +| [digest](./js.secret.digest.md) | | string | A digest hash of the secret | +| [id](./js.secret.id.md) | | [Id](./js.id.md)<'secret'> | The ID of the secret | +| [name](./js.secret.name.md) | | string | The name of the secret | + diff --git a/docs/js.secret.name.md b/docs/js.secret.name.md new file mode 100644 index 00000000..653530e7 --- /dev/null +++ b/docs/js.secret.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [name](./js.secret.name.md) + +## Secret.name property + +The name of the secret + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.state.md b/docs/js.state.md new file mode 100644 index 00000000..91570529 --- /dev/null +++ b/docs/js.state.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [State](./js.state.md) + +## State type + +Signature: + +```typescript +declare type State = Record; +``` diff --git a/docs/js.successfulapiresponse.md b/docs/js.successfulapiresponse.md new file mode 100644 index 00000000..9790e255 --- /dev/null +++ b/docs/js.successfulapiresponse.md @@ -0,0 +1,14 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [SuccessfulAPIResponse](./js.successfulapiresponse.md) + +## SuccessfulAPIResponse type + +Signature: + +```typescript +declare type SuccessfulAPIResponse = { + success: true; + data: T; +}; +``` diff --git a/docs/js.supports_intl.md b/docs/js.supports_intl.md new file mode 100644 index 00000000..abcbc5d0 --- /dev/null +++ b/docs/js.supports_intl.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [SUPPORTS\_INTL](./js.supports_intl.md) + +## SUPPORTS\_INTL variable + +Signature: + +```typescript +SUPPORTS_INTL: boolean +``` diff --git a/docs/js.tag.md b/docs/js.tag.md new file mode 100644 index 00000000..541371d7 --- /dev/null +++ b/docs/js.tag.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Tag](./js.tag.md) + +## Tag type + +Signature: + +```typescript +declare type Tag = T & { + ___tag: Name; +}; +``` diff --git a/docs/js.timestamp.md b/docs/js.timestamp.md new file mode 100644 index 00000000..bd3efe15 --- /dev/null +++ b/docs/js.timestamp.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Timestamp](./js.timestamp.md) + +## Timestamp type + +Hop's API uses ISO 8601 date strings + +Signature: + +```typescript +declare type Timestamp = Tag; +``` +References: [Tag](./js.tag.md) + diff --git a/docs/js.units.md b/docs/js.units.md new file mode 100644 index 00000000..689bd7cb --- /dev/null +++ b/docs/js.units.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [units](./js.units.md) + +## units variable + +> Warning: This API is now obsolete. +> +> use `byteUnits` instead +> + +Signature: + +```typescript +units: readonly ['GB', 'MB', 'KB', 'B'] +``` diff --git a/docs/js.user.email.md b/docs/js.user.email.md new file mode 100644 index 00000000..6c90f052 --- /dev/null +++ b/docs/js.user.email.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [email](./js.user.email.md) + +## User.email property + +The email of the user + +Signature: + +```typescript +email: string; +``` diff --git a/docs/js.user.id.md b/docs/js.user.id.md new file mode 100644 index 00000000..404e7ca0 --- /dev/null +++ b/docs/js.user.id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [id](./js.user.id.md) + +## User.id property + +The ID of the user + +Signature: + +```typescript +id: Id<'user'>; +``` diff --git a/docs/js.user.md b/docs/js.user.md new file mode 100644 index 00000000..4382cd49 --- /dev/null +++ b/docs/js.user.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) + +## User interface + +A user objct + +Signature: + +```typescript +interface User +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [email](./js.user.email.md) | | string | The email of the user | +| [id](./js.user.id.md) | | [Id](./js.id.md)<'user'> | The ID of the user | +| [name](./js.user.name.md) | | string | The name of the user. Think of this as a display name | +| [username](./js.user.username.md) | | string | A unqiue username for the user | + diff --git a/docs/js.user.name.md b/docs/js.user.name.md new file mode 100644 index 00000000..36394000 --- /dev/null +++ b/docs/js.user.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [name](./js.user.name.md) + +## User.name property + +The name of the user. Think of this as a display name + +Signature: + +```typescript +name: string; +``` diff --git a/docs/js.user.username.md b/docs/js.user.username.md new file mode 100644 index 00000000..1b929208 --- /dev/null +++ b/docs/js.user.username.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [username](./js.user.username.md) + +## User.username property + +A unqiue username for the user + +Signature: + +```typescript +username: string; +``` diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md new file mode 100644 index 00000000..56fc4a34 --- /dev/null +++ b/docs/js.userendpoints.md @@ -0,0 +1,41 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [UserEndpoints](./js.userendpoints.md) + +## UserEndpoints type + +Signature: + +```typescript +declare type UserEndpoints = + | Endpoint< + 'GET', + '/v1/users/@me', + { + projects: Project[]; + user: User; + project_member_role_map: Record, MemberRole>; + leap_token: string | null; + } + > + | Endpoint< + 'POST', + '/v1/users/@me/pats', + { + pat: PAT; + }, + { + name: string; + } + > + | Endpoint< + 'GET', + '/v1/users/@me/pats', + { + pats: PAT[]; + } + > + | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; +``` +References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) + diff --git a/docs/js.users.md b/docs/js.users.md new file mode 100644 index 00000000..3c959755 --- /dev/null +++ b/docs/js.users.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Users](./js.users.md) + +## Users namespace + +Signature: + +```typescript +declare namespace users +``` diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md new file mode 100644 index 00000000..9ea07fd3 --- /dev/null +++ b/docs/js.validateapiauthentication.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateAPIAuthentication](./js.validateapiauthentication.md) + +## validateAPIAuthentication() function + +Signature: + +```typescript +declare function validateAPIAuthentication( + auth: string, +): auth is APIAuthenticationPrefix; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| auth | string | | + +Returns: + +auth is [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) + diff --git a/docs/js.validateid.md b/docs/js.validateid.md new file mode 100644 index 00000000..d98493bb --- /dev/null +++ b/docs/js.validateid.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateId](./js.validateid.md) + +## validateId() function + +Validates that a string is a valid ID + +Signature: + +```typescript +declare function validateId( + maybeId: string, + prefix?: T | T[], +): maybeId is Id; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| maybeId | string | A string that might be an id | +| prefix | T \| T\[\] | (Optional) Optionally an id prefix to check against | + +Returns: + +maybeId is [Id](./js.id.md)<T> + +- true if the string is an id + diff --git a/docs/js.validateidprefix.md b/docs/js.validateidprefix.md new file mode 100644 index 00000000..1de947ad --- /dev/null +++ b/docs/js.validateidprefix.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [validateIdPrefix](./js.validateidprefix.md) + +## validateIdPrefix() function + +Checks if a string is a valid Hop ID prefix + +Signature: + +```typescript +declare function validateIdPrefix( + prefix: string, + expect?: T, +): prefix is T; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| prefix | string | A string that is a potential prefix | +| expect | T | (Optional) An expected prefix to check against | + +Returns: + +prefix is T + +- Whether the prefix is valid + diff --git a/docs/js.values.md b/docs/js.values.md new file mode 100644 index 00000000..b8dbb26f --- /dev/null +++ b/docs/js.values.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Values](./js.values.md) + +## Values type + +Signature: + +```typescript +declare type Values = T[keyof T]; +``` diff --git a/docs/js.vgpu.count.md b/docs/js.vgpu.count.md new file mode 100644 index 00000000..7ffa7aa5 --- /dev/null +++ b/docs/js.vgpu.count.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [count](./js.vgpu.count.md) + +## Vgpu.count property + +The amount of vGPUs to allocate + +Signature: + +```typescript +count: number; +``` diff --git a/docs/js.vgpu.md b/docs/js.vgpu.md new file mode 100644 index 00000000..3897532d --- /dev/null +++ b/docs/js.vgpu.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) + +## Vgpu interface + +Virtual GPU config + +Signature: + +```typescript +interface Vgpu +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [count](./js.vgpu.count.md) | | number | The amount of vGPUs to allocate | +| [type](./js.vgpu.type.md) | | [VgpuType](./js.vgputype.md) | The type of vGPU to allocate | + diff --git a/docs/js.vgpu.type.md b/docs/js.vgpu.type.md new file mode 100644 index 00000000..9d3e5d20 --- /dev/null +++ b/docs/js.vgpu.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [type](./js.vgpu.type.md) + +## Vgpu.type property + +The type of vGPU to allocate + +Signature: + +```typescript +type: VgpuType; +``` diff --git a/docs/js.vgputype.md b/docs/js.vgputype.md new file mode 100644 index 00000000..12a64f39 --- /dev/null +++ b/docs/js.vgputype.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VgpuType](./js.vgputype.md) + +## VgpuType enum + +Types for supported GPU + +Signature: + +```typescript +declare enum VgpuType +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| A400 | 'a400' | | + diff --git a/docs/js.volumedefinition.fs.md b/docs/js.volumedefinition.fs.md new file mode 100644 index 00000000..13e0bde3 --- /dev/null +++ b/docs/js.volumedefinition.fs.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [fs](./js.volumedefinition.fs.md) + +## VolumeDefinition.fs property + +The format of the volume + +Signature: + +```typescript +fs: VolumeFormat; +``` diff --git a/docs/js.volumedefinition.md b/docs/js.volumedefinition.md new file mode 100644 index 00000000..0a63f366 --- /dev/null +++ b/docs/js.volumedefinition.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) + +## VolumeDefinition interface + +Signature: + +```typescript +interface VolumeDefinition +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [fs](./js.volumedefinition.fs.md) | | [VolumeFormat](./js.volumeformat.md) | The format of the volume | +| [mount\_path](./js.volumedefinition.mount_path.md) | | string | The mount point of the volume | +| [size](./js.volumedefinition.size.md) | | [ByteSizeString](./js.bytesizestring.md) | The size of the volume in bytes | + diff --git a/docs/js.volumedefinition.mount_path.md b/docs/js.volumedefinition.mount_path.md new file mode 100644 index 00000000..b089b026 --- /dev/null +++ b/docs/js.volumedefinition.mount_path.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [mount\_path](./js.volumedefinition.mount_path.md) + +## VolumeDefinition.mount\_path property + +The mount point of the volume + +Signature: + +```typescript +mount_path: string; +``` diff --git a/docs/js.volumedefinition.size.md b/docs/js.volumedefinition.size.md new file mode 100644 index 00000000..493b250e --- /dev/null +++ b/docs/js.volumedefinition.size.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [size](./js.volumedefinition.size.md) + +## VolumeDefinition.size property + +The size of the volume in bytes + +Signature: + +```typescript +size: ByteSizeString; +``` diff --git a/docs/js.volumeformat.md b/docs/js.volumeformat.md new file mode 100644 index 00000000..60ee3644 --- /dev/null +++ b/docs/js.volumeformat.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [VolumeFormat](./js.volumeformat.md) + +## VolumeFormat enum + +Signature: + +```typescript +declare enum VolumeFormat +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| EXT4 | 'ext4' | | +| XFS | 'xfs' | | + diff --git a/next-env.d.ts b/next-env.d.ts new file mode 100644 index 00000000..4f11a03d --- /dev/null +++ b/next-env.d.ts @@ -0,0 +1,5 @@ +/// +/// + +// NOTE: This file should not be edited +// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/package.json b/package.json index 80a8eb8e..7bfd9da0 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "vercel-build": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./docs --output-folder ./docs", + "vercel-build": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", "test": "tsx tests/index.ts" }, "devDependencies": { @@ -51,17 +51,18 @@ "@microsoft/api-documenter": "^7.19.20", "@microsoft/api-extractor": "^7.33.2", "@types/glob": "8.0.0", - "@types/node": "18.11.0", + "@types/node": "^18.11.0", "dotenv": "16.0.3", "glob": "8.0.3", "prettier": "2.7.1", "tsup": "6.2.3", "tsx": "3.10.1", - "typescript": "4.8.4" + "typescript": "^4.8.4" }, "dependencies": { "@onehop/json-methods": "^1.2.0", "cross-fetch": "^3.1.5", + "es-urlcat": "^1.0.0", "zod": "^3.19.1" } } diff --git a/renovate.json b/renovate.json index 39a2b6e9..7ec37f6f 100644 --- a/renovate.json +++ b/renovate.json @@ -1,6 +1,4 @@ { - "$schema": "https://docs.renovatebot.com/renovate-schema.json", - "extends": [ - "config:base" - ] + "$schema": "https://docs.renovatebot.com/renovate-schema.json", + "extends": ["config:base"] } diff --git a/tsconfig.json b/tsconfig.json index 40a14b82..3ed54adc 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -11,7 +11,6 @@ "moduleResolution": "NodeNext", "resolveJsonModule": true, "isolatedModules": true, - "jsx": "react", "noFallthroughCasesInSwitch": true, "declaration": true, "declarationMap": true diff --git a/yarn.lock b/yarn.lock index 23558b85..26bb2dc5 100644 --- a/yarn.lock +++ b/yarn.lock @@ -492,14 +492,15 @@ __metadata: "@microsoft/api-extractor": ^7.33.2 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.0.0 - "@types/node": 18.11.0 + "@types/node": ^18.11.0 cross-fetch: ^3.1.5 dotenv: 16.0.3 + es-urlcat: ^1.0.0 glob: 8.0.3 prettier: 2.7.1 tsup: 6.2.3 tsx: 3.10.1 - typescript: 4.8.4 + typescript: ^4.8.4 zod: ^3.19.1 languageName: unknown linkType: soft @@ -610,13 +611,6 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:18.11.0": - version: 18.11.0 - resolution: "@types/node@npm:18.11.0" - checksum: f27f899ab428e5732f04fadadc9203f44bdf3abf56474540ee27da90e4f2ba133faf87263cada4d2271955f92ee6a142bd50683c86290fe5070c19aac44fd654 - languageName: node - linkType: hard - "@types/node@npm:^12.7.1": version: 12.20.55 resolution: "@types/node@npm:12.20.55" @@ -624,6 +618,13 @@ __metadata: languageName: node linkType: hard +"@types/node@npm:^18.11.0": + version: 18.11.0 + resolution: "@types/node@npm:18.11.0" + checksum: f27f899ab428e5732f04fadadc9203f44bdf3abf56474540ee27da90e4f2ba133faf87263cada4d2271955f92ee6a142bd50683c86290fe5070c19aac44fd654 + languageName: node + linkType: hard + "@types/normalize-package-data@npm:^2.4.0": version: 2.4.1 resolution: "@types/normalize-package-data@npm:2.4.1" @@ -1348,6 +1349,15 @@ __metadata: languageName: node linkType: hard +"es-urlcat@npm:^1.0.0": + version: 1.0.0 + resolution: "es-urlcat@npm:1.0.0" + dependencies: + qs: ^6.9.4 + checksum: e646f8510f80e11951602178168d2348fcbc39ed12cc80b0c93d592224a4692c155250e136c05cae4f9a4325ba5f991554d94623b2ebbb431d6064119a2acacf + languageName: node + linkType: hard + "esbuild-android-64@npm:0.15.11": version: 0.15.11 resolution: "esbuild-android-64@npm:0.15.11" @@ -3358,6 +3368,15 @@ __metadata: languageName: node linkType: hard +"qs@npm:^6.9.4": + version: 6.11.0 + resolution: "qs@npm:6.11.0" + dependencies: + side-channel: ^1.0.4 + checksum: 6e1f29dd5385f7488ec74ac7b6c92f4d09a90408882d0c208414a34dd33badc1a621019d4c799a3df15ab9b1d0292f97c1dd71dc7c045e69f81a8064e5af7297 + languageName: node + linkType: hard + "queue-microtask@npm:^1.2.2": version: 1.2.3 resolution: "queue-microtask@npm:1.2.3" @@ -4153,7 +4172,7 @@ __metadata: languageName: node linkType: hard -"typescript@npm:4.8.4, typescript@npm:~4.8.4": +"typescript@npm:^4.8.4, typescript@npm:~4.8.4": version: 4.8.4 resolution: "typescript@npm:4.8.4" bin: @@ -4163,7 +4182,7 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@4.8.4#~builtin, typescript@patch:typescript@~4.8.4#~builtin": +"typescript@patch:typescript@^4.8.4#~builtin, typescript@patch:typescript@~4.8.4#~builtin": version: 4.8.4 resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=a1c5e5" bin: From 6aea9a65343f21ff35041d167b748b7bd507e2bf Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 12:32:10 +0100 Subject: [PATCH 05/33] more doc --- docs/js.anyid.md | 2 + docs/js.apiauthenticationprefix.md | 4 +- docs/js.apiclient.authtype.md | 2 +- docs/js.apiclient.delete.md | 172 +++------ docs/js.apiclient.get.md | 519 ++++++++------------------- docs/js.apiclient.getauthtype.md | 4 +- docs/js.apiclient.md | 2 +- docs/js.apiclient.patch.md | 86 ++--- docs/js.apiclient.post.md | 347 ++++++------------ docs/js.apiclient.put.md | 139 ++----- docs/js.assertid.md | 8 +- docs/js.broad_permissions_map.md | 24 +- docs/js.build.md | 2 + docs/js.buildmetadata.author.md | 6 +- docs/js.buildmetadata.md | 2 + docs/js.buildmethod.md | 4 +- docs/js.buildstate.md | 8 +- docs/js.byteunit.md | 4 +- docs/js.byteunits.md | 2 +- docs/js.channelendpoints.md | 153 +++----- docs/js.channels.md | 50 ++- docs/js.channeltype.md | 6 +- docs/js.container.metadata.md | 4 +- docs/js.container.uptime.md | 4 +- docs/js.containerstate.md | 12 +- docs/js.default_base_url.md | 2 +- docs/js.deploymentconfig.md | 20 +- docs/js.deploymentrollout.md | 14 +- docs/js.domainstate.md | 6 +- docs/js.empty.md | 11 - docs/js.endpoint.md | 17 +- docs/js.endpoints.md | 8 +- docs/js.erroredapiresponse.md | 10 +- docs/js.extractrouteparams.md | 23 -- docs/js.gatewaytype.md | 4 +- docs/js.getidprefix.md | 8 +- docs/js.hop.channels.md | 135 +++---- docs/js.hop.ignite.md | 209 ++++------- docs/js.hop.md | 10 +- docs/js.hop.pipe.md | 47 +-- docs/js.hop.projects.md | 69 ++-- docs/js.hop.registry.md | 28 +- docs/js.hop.users.md | 28 +- docs/js.hopshdomain.md | 2 + docs/js.id.md | 2 + docs/js.id_prefixes.md | 131 +++---- docs/js.idprefixes.md | 2 + docs/js.ignite.md | 82 ++++- docs/js.igniteendpoints.md | 148 ++------ docs/js.internalhopdomain.md | 2 + docs/js.md | 47 +-- docs/js.member.md | 6 +- docs/js.method.md | 11 - docs/js.partialapioptions.md | 5 +- docs/js.permissions.md | 8 +- docs/js.permissionsmap.md | 90 ++--- docs/js.pipe.md | 27 +- docs/js.pipeendpoints.md | 46 +-- docs/js.project_permission.md | 90 ++--- docs/js.projects.md | 30 +- docs/js.projectsendpoints.md | 131 ++----- docs/js.projecttier.md | 4 +- docs/js.projecttype.md | 4 +- docs/js.query.md | 5 +- docs/js.regions.md | 2 +- docs/js.registry.md | 21 +- docs/js.registryendpoints.md | 37 +- docs/js.restartpolicy.md | 6 +- docs/js.roles.md | 10 +- docs/js.rolloutstate.md | 6 +- docs/js.runtimetype.md | 6 +- docs/js.setstateaction.md | 15 + docs/js.successfulapiresponse.md | 4 +- docs/js.tag.md | 4 +- docs/js.timestamp.md | 2 +- docs/js.units.md | 2 +- docs/js.userendpoints.md | 43 +-- docs/js.users.md | 22 +- docs/js.validateapiauthentication.md | 4 +- docs/js.validateid.md | 9 +- docs/js.validateidprefix.md | 5 +- docs/js.values.md | 11 - docs/js.vgputype.md | 2 +- docs/js.volumeformat.md | 4 +- package.json | 2 +- src/index.ts | 2 + src/permissions.ts | 20 ++ src/rest/client.ts | 8 +- src/rest/endpoints.ts | 4 +- src/rest/types/channels.ts | 16 +- src/rest/types/ignite.ts | 24 +- src/rest/types/pipe.ts | 4 +- src/rest/types/projects.ts | 10 +- src/rest/types/registry.ts | 4 +- src/rest/types/users.ts | 4 +- src/sdks/channels.ts | 28 +- src/sdks/ignite.ts | 54 +-- src/sdks/index.ts | 2 +- src/sdks/pipe.ts | 6 +- src/sdks/projects.ts | 26 +- src/sdks/registry.ts | 4 + src/sdks/users.ts | 6 +- src/util/size.ts | 2 +- src/util/types.ts | 93 ++++- src/util/urls.ts | 7 +- src/utils/zod/ids.ts | 3 +- 106 files changed, 1464 insertions(+), 2168 deletions(-) delete mode 100644 docs/js.empty.md delete mode 100644 docs/js.extractrouteparams.md delete mode 100644 docs/js.method.md create mode 100644 docs/js.setstateaction.md delete mode 100644 docs/js.values.md diff --git a/docs/js.anyid.md b/docs/js.anyid.md index 1a818b72..c6817324 100644 --- a/docs/js.anyid.md +++ b/docs/js.anyid.md @@ -4,6 +4,8 @@ ## AnyId type +Any/all IDs that are used within the API + Signature: ```typescript diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md index 3bb3f2de..4c37a0f7 100644 --- a/docs/js.apiauthenticationprefix.md +++ b/docs/js.apiauthenticationprefix.md @@ -7,9 +7,7 @@ Signature: ```typescript -declare type APIAuthenticationPrefix = APIAuthentication extends Id - ? T - : never; +declare type APIAuthenticationPrefix = APIAuthentication extends Id ? T : never; ``` References: [APIAuthentication](./js.apiauthentication.md), [Id](./js.id.md) diff --git a/docs/js.apiclient.authtype.md b/docs/js.apiclient.authtype.md index 47d6edc1..f315c069 100644 --- a/docs/js.apiclient.authtype.md +++ b/docs/js.apiclient.authtype.md @@ -7,5 +7,5 @@ Signature: ```typescript -readonly authType: 'ptk' | 'pat' | 'bearer'; +readonly authType: "ptk" | "pat" | "bearer"; ``` diff --git a/docs/js.apiclient.delete.md b/docs/js.apiclient.delete.md index 0fd0f08e..1c3d9b4a 100644 --- a/docs/js.apiclient.delete.md +++ b/docs/js.apiclient.delete.md @@ -7,135 +7,45 @@ Signature: ```typescript -delete< - Path extends Extract< - Endpoints, - { - method: 'DELETE'; - } - >['path'], - >( - path: Path, - body: Extract< - Endpoints, - { - path: Path; - method: 'DELETE'; - } - >['body'], - query: Query, - init?: RequestInit, - ): Promise< - ( - | Extract< - Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', void, undefined>, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/projects/:project_id/tokens/:project_token_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/projects/@this/tokens/:project_token_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/projects/:project_id/secrets/:secret_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/projects/@this/secrets/:secret_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint<'DELETE', '/v1/channels/:channel_id', void, undefined>, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint<'DELETE', '/v1/channels/tokens/:token', void, undefined>, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint<'DELETE', '/v1/registry/images/:image', void, undefined>, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/ignite/deployments/:deployment_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint< - 'DELETE', - '/v1/ignite/containers/:container_id', - void, - undefined - >, - { - path: Path; - method: 'DELETE'; - } - > - | Extract< - Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', void, undefined>, - { - path: Path; - method: 'DELETE'; - } - > - )['res'] - >; +delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }>)["res"]>; ``` ## Parameters @@ -143,11 +53,11 @@ delete< | Parameter | Type | Description | | --- | --- | --- | | path | Path | | -| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; } >\['body'\] | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; }>\['body'\] | | | query | [Query](./js.query.md)<Path> | | | init | RequestInit | (Optional) | Returns: -Promise< ( \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/users/@me/pats/:pat\_id', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/:project\_id/tokens/:project\_token\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/@this/tokens/:project\_token\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/:project\_id/secrets/:secret\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/projects/@this/secrets/:secret\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/channels/:channel\_id', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/channels/tokens/:token', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/registry/images/:image', void, undefined>, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/ignite/deployments/:deployment\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'DELETE', '/v1/ignite/containers/:container\_id', void, undefined >, { path: Path; method: 'DELETE'; } > \| Extract< [Endpoint](./js.endpoint.md)<'DELETE', '/v1/pipe/rooms/:room\_id', void, undefined>, { path: Path; method: 'DELETE'; } > )\['res'\] > +Promise<(Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/users/@me/pats/:pat\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/:channel\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/tokens/:token", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/registry/images/:image", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/deployments/:deployment\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/containers/:container\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/pipe/rooms/:room\_id", void, undefined>, { path: Path; method: 'DELETE'; }>)\["res"\]> diff --git a/docs/js.apiclient.get.md b/docs/js.apiclient.get.md index 8ae09a7c..abe7d784 100644 --- a/docs/js.apiclient.get.md +++ b/docs/js.apiclient.get.md @@ -7,383 +7,146 @@ Signature: ```typescript -get< - Path extends Extract< - Endpoints, - { - method: 'GET'; - } - >['path'], - >( - path: Path, - query: Query, - init?: RequestInit, - ): Promise< - ( - | Extract< - Endpoint< - 'GET', - '/v1/users/@me', - { - projects: Project[]; - user: User; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/users/@me/pats', - { - pats: PAT[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/:project_id/members/@me', - { - project_member: Member; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/:project_id/tokens', - { - project_tokens: ProjectToken[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/@this/tokens', - { - project_tokens: ProjectToken[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/:project_id/members', - { - members: Member[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/@this/members', - { - members: Member[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/:project_id/secrets', - { - secrets: Secret[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/projects/@this/secrets', - { - secrets: Secret[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels/:channel_id', - { - channel: Channel; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels/:channel_id/tokens', - { - tokens: ChannelToken[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels/:channel_id/state', - { - state: State; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels', - { - channels: Channel[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels/tokens/:token', - { - token: ChannelToken; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/channels/:channel_id/stats', - { - stats: { - online_count: number; - }; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/registry/images', - { - images: string[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/registry/images/:image/manifests', - { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/deployments', - { - deployments: Deployment[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id/containers', - { - containers: Container[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/containers/:container_id/logs', - { - logs: ContainerLog[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/deployments/search', - { - deployment: Deployment; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id', - { - deployment: Deployment; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/gateways/:gateway_id', - { - gateway: Gateway; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id/gateways', - { - gateways: Gateway[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - | Extract< - Endpoint< - 'GET', - '/v1/pipe/rooms', - { - rooms: Room[]; - }, - undefined - >, - { - path: Path; - method: 'GET'; - } - > - )['res'] - >; +get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; + leap_token: string | null; + }, undefined>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }>)["res"]>; ``` ## Parameters @@ -396,5 +159,5 @@ get< Returns: -Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/users/@me', { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/users/@me/pats', { pats: [PAT](./js.pat.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/members/@me', { project\_member: [Member](./js.member.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/tokens', { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/tokens', { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/members', { members: [Member](./js.member.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/members', { members: [Member](./js.member.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/:project\_id/secrets', { secrets: [Secret](./js.secret.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/projects/@this/secrets', { secrets: [Secret](./js.secret.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id', { channel: [Channel](./js.channel.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/tokens', { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/state', { state: [State](./js.state.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels', { channels: [Channel](./js.channel.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/tokens/:token', { token: [ChannelToken](./js.channeltoken.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/channels/:channel\_id/stats', { stats: { online\_count: number; }; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/registry/images', { images: string\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/registry/images/:image/manifests', { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments', { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id/containers', { containers: [Container](./js.container.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/containers/:container\_id/logs', { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/search', { deployment: [Deployment](./js.deployment.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id', { deployment: [Deployment](./js.deployment.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/gateways/:gateway\_id', { gateway: [Gateway](./js.gateway.md); }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/ignite/deployments/:deployment\_id/gateways', { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'GET', '/v1/pipe/rooms', { rooms: [Room](./js.room.md)\[\]; }, undefined >, { path: Path; method: 'GET'; } > )\['res'\] > +Promise<(Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me", { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me/pats", { pats: [PAT](./js.pat.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members/@me", { project\_member: [Member](./js.member.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/tokens", { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/state", { state: [State](./js.state.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels", { channels: [Channel](./js.channel.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/stats", { stats: { online\_count: number; }; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images", { images: string\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images/:image/manifests", { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments", { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/containers", { containers: [Container](./js.container.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/containers/:container\_id/logs", { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/search", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/gateways/:gateway\_id", { gateway: [Gateway](./js.gateway.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/gateways", { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/pipe/rooms", { rooms: [Room](./js.room.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }>)\["res"\]> diff --git a/docs/js.apiclient.getauthtype.md b/docs/js.apiclient.getauthtype.md index 437c3b1e..0323dab7 100644 --- a/docs/js.apiclient.getauthtype.md +++ b/docs/js.apiclient.getauthtype.md @@ -7,7 +7,7 @@ Signature: ```typescript -static getAuthType(auth: APIAuthentication): 'ptk' | 'pat' | 'bearer'; +static getAuthType(auth: APIAuthentication): "ptk" | "pat" | "bearer"; ``` ## Parameters @@ -18,5 +18,5 @@ static getAuthType(auth: APIAuthentication): 'ptk' | 'pat' | 'bearer'; Returns: -'ptk' \| 'pat' \| 'bearer' +"ptk" \| "pat" \| "bearer" diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md index 2f5a6583..ae2b398d 100644 --- a/docs/js.apiclient.md +++ b/docs/js.apiclient.md @@ -20,7 +20,7 @@ declare class APIClient | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [authType](./js.apiclient.authtype.md) | readonly | 'ptk' \| 'pat' \| 'bearer' | | +| [authType](./js.apiclient.authtype.md) | readonly | "ptk" \| "pat" \| "bearer" | | | [url](./js.apiclient.url.md) | readonly | <Path extends string>(path: Path, query: [Query](./js.query.md)<Path>) => string | | ## Methods diff --git a/docs/js.apiclient.patch.md b/docs/js.apiclient.patch.md index 50a4f446..dc0439ff 100644 --- a/docs/js.apiclient.patch.md +++ b/docs/js.apiclient.patch.md @@ -7,66 +7,28 @@ Signature: ```typescript -patch< - Path extends Extract< - Endpoints, - { - method: 'PATCH'; - } - >['path'], - >( - path: Path, - body: Extract< - Endpoints, - { - path: Path; - method: 'PATCH'; - } - >['body'], - query: Query, - init?: RequestInit, - ): Promise< - ( - | Extract< - Endpoint<'PATCH', '/v1/channels/:channel_id/state', void, State>, - { - path: Path; - method: 'PATCH'; - } - > - | Extract< - Endpoint< - 'PATCH', - '/v1/channels/tokens/:token', - { - token: ChannelToken; - }, - { - expiresAt?: Timestamp | null | undefined; - state: State; - } - >, - { - path: Path; - method: 'PATCH'; - } - > - | Extract< - Endpoint< - 'PATCH', - '/v1/ignite/deployments/:deployment_id', - { - deployment: Deployment; - }, - DeploymentConfig - >, - { - path: Path; - method: 'PATCH'; - } - > - )['res'] - >; +patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }>)["res"]>; ``` ## Parameters @@ -74,11 +36,11 @@ patch< | Parameter | Type | Description | | --- | --- | --- | | path | Path | | -| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; } >\['body'\] | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; }>\['body'\] | | | query | [Query](./js.query.md)<Path> | | | init | RequestInit | (Optional) | Returns: -Promise< ( \| Extract< [Endpoint](./js.endpoint.md)<'PATCH', '/v1/channels/:channel\_id/state', void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PATCH', '/v1/channels/tokens/:token', { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); } >, { path: Path; method: 'PATCH'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PATCH', '/v1/ignite/deployments/:deployment\_id', { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md) >, { path: Path; method: 'PATCH'; } > )\['res'\] > +Promise<(Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); }>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'PATCH'; }>)\["res"\]> diff --git a/docs/js.apiclient.post.md b/docs/js.apiclient.post.md index 33a722c8..24f385e0 100644 --- a/docs/js.apiclient.post.md +++ b/docs/js.apiclient.post.md @@ -7,245 +7,110 @@ Signature: ```typescript -post< - Path extends Extract< - Endpoints, - { - method: 'POST'; - } - >['path'], - >( - path: Path, - body: Extract< - Endpoints, - { - path: Path; - method: 'POST'; - } - >['body'], - query: Query, - init?: RequestInit, - ): Promise< - ( - | Extract< - Endpoint< - 'POST', - '/v1/users/@me/pats', - { - pat: PAT; - }, - { - name: string; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/projects/:project_id/tokens', - { - project_token: ProjectToken & { - project: Project; - }; - }, - { - flags: number; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/projects/@this/tokens', - { - project_token: ProjectToken & { - project: Project; - }; - }, - { - flags: number; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/channels', - { - channel: Channel; - }, - { - type: ChannelType; - state: Record | null; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/channels/tokens', - { - token: ChannelToken; - }, - { - state: State; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/channels/tokens/:token/messages', - void, - { - e: string; - d: unknown; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/channels/:channel_id/messages', - void, - { - e: string; - d: unknown; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/containers', - { - container: Container; - }, - undefined - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/containers/:container_id', - never, - { - deployment_id: `deployment_${string}`; - container_id: `container_${string}`; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/ignite/deployments', - { - deployment: Deployment; - }, - DeploymentConfig - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/ignite/gateways/:gateway_id/domains', - void, - { - domain: string; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/gateways', - { - gateway: Gateway; - }, - { - type: GatewayType; - target_port: number; - protocol: 'http' | null; - } - >, - { - path: Path; - method: 'POST'; - } - > - | Extract< - Endpoint< - 'POST', - '/v1/pipe/rooms', - { - room: Room; - }, - { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: - | { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } - | undefined; - } - >, - { - path: Path; - method: 'POST'; - } - > - )['res'] - >; +post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract | null; + }>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }>)["res"]>; ``` ## Parameters @@ -253,11 +118,11 @@ post< | Parameter | Type | Description | | --- | --- | --- | | path | Path | | -| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; } >\['body'\] | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; }>\['body'\] | | | query | [Query](./js.query.md)<Path> | | | init | RequestInit | (Optional) | Returns: -Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/users/@me/pats', { pat: [PAT](./js.pat.md); }, { name: string; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/projects/:project\_id/tokens', { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/projects/@this/tokens', { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels', { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/tokens', { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/tokens/:token/messages', void, { e: string; d: unknown; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/channels/:channel\_id/messages', void, { e: string; d: unknown; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/containers', { container: [Container](./js.container.md); }, undefined >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/containers/:container\_id', never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments', { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md) >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/gateways/:gateway\_id/domains', void, { domain: string; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/ignite/deployments/:deployment\_id/gateways', { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: 'http' \| null; } >, { path: Path; method: 'POST'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'POST', '/v1/pipe/rooms', { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: 'rtmp' \| 'rtp'; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: \| { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; } >, { path: Path; method: 'POST'; } > )\['res'\] > +Promise<(Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/users/@me/pats", { pat: [PAT](./js.pat.md); }, { name: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/:project\_id/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/@this/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens", { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens/:token/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/:channel\_id/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers", { container: [Container](./js.container.md); }, undefined>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers/:container\_id", never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/gateways/:gateway\_id/domains", void, { domain: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/gateways", { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: "http" \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/pipe/rooms", { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: "rtmp" \| "rtp"; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }>, { path: Path; method: 'POST'; }>)\["res"\]> diff --git a/docs/js.apiclient.put.md b/docs/js.apiclient.put.md index 7b9d32ab..df948bae 100644 --- a/docs/js.apiclient.put.md +++ b/docs/js.apiclient.put.md @@ -7,106 +7,41 @@ Signature: ```typescript -put< - Path extends Extract< - Endpoints, - { - method: 'PUT'; - } - >['path'], - >( - path: Path, - body: Extract< - Endpoints, - { - path: Path; - method: 'PUT'; - } - >['body'], - query: Query, - init?: RequestInit, - ): Promise< - ( - | Extract< - Endpoint< - 'PUT', - '/v1/projects/:project_id/secrets/:name', - { - secret: Secret; - }, - string - >, - { - path: Path; - method: 'PUT'; - } - > - | Extract< - Endpoint< - 'PUT', - '/v1/projects/@this/secrets/:name', - { - secret: Secret; - }, - string - >, - { - path: Path; - method: 'PUT'; - } - > - | Extract< - Endpoint< - 'PUT', - '/v1/channels/:channel_id', - { - channel: Channel; - }, - { - type: ChannelType; - state: Record | null; - } - >, - { - path: Path; - method: 'PUT'; - } - > - | Extract< - Endpoint< - 'PUT', - '/v1/channels/:channel_id/subscribers/:token', - void, - undefined - >, - { - path: Path; - method: 'PUT'; - } - > - | Extract< - Endpoint<'PUT', '/v1/channels/:channel_id/state', void, State>, - { - path: Path; - method: 'PUT'; - } - > - | Extract< - Endpoint< - 'PUT', - '/v1/ignite/containers/:container_id/state', - void, - { - preferred_state: ContainerState.RUNNING | ContainerState.STOPPED; - } - >, - { - path: Path; - method: 'PUT'; - } - > - )['res'] - >; +put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract | null; + }>, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }>)["res"]>; ``` ## Parameters @@ -114,11 +49,11 @@ put< | Parameter | Type | Description | | --- | --- | --- | | path | Path | | -| body | Extract< [Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; } >\['body'\] | | +| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; }>\['body'\] | | | query | [Query](./js.query.md)<Path> | | | init | RequestInit | (Optional) | Returns: -Promise< ( \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/projects/:project\_id/secrets/:name', { secret: [Secret](./js.secret.md); }, string >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/projects/@this/secrets/:name', { secret: [Secret](./js.secret.md); }, string >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/channels/:channel\_id', { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; } >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/channels/:channel\_id/subscribers/:token', void, undefined >, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)<'PUT', '/v1/channels/:channel\_id/state', void, [State](./js.state.md)>, { path: Path; method: 'PUT'; } > \| Extract< [Endpoint](./js.endpoint.md)< 'PUT', '/v1/ignite/containers/:container\_id/state', void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); } >, { path: Path; method: 'PUT'; } > )\['res'\] > +Promise<(Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/:project\_id/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/@this/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/subscribers/:token", void, undefined>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/ignite/containers/:container\_id/state", void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); }>, { path: Path; method: 'PUT'; }>)\["res"\]> diff --git a/docs/js.assertid.md b/docs/js.assertid.md index 9f9954de..d24607fe 100644 --- a/docs/js.assertid.md +++ b/docs/js.assertid.md @@ -9,18 +9,14 @@ Asserts that a string is a valid ID Signature: ```typescript -declare function assertId( - maybeId?: string, - prefix?: T | T[], - message?: string, -): asserts maybeId is Id; +declare function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| maybeId | string | (Optional) A string that is possibly an ID | +| maybeId | string \| undefined \| null | A string that is possibly an ID | | prefix | T \| T\[\] | (Optional) A prefix or array of prefixes to check against | | message | string | (Optional) An error message to throw if the ID is invalid | diff --git a/docs/js.broad_permissions_map.md b/docs/js.broad_permissions_map.md index 5192bc3b..3b9c82d6 100644 --- a/docs/js.broad_permissions_map.md +++ b/docs/js.broad_permissions_map.md @@ -4,20 +4,22 @@ ## BROAD\_PERMISSIONS\_MAP variable +Broader permission map + Signature: ```typescript BROAD_PERMISSIONS_MAP: { - MANAGE_MEMBERS: bigint; - MANAGE_PROJECT_TOKENS: bigint; - MANAGE_DEPLOYMENTS: bigint; - MANAGE_PIPE: bigint; - MANAGE_SECRETS: bigint; - MANAGE_CHANNELS: bigint; - MANAGE_REGISTRY: bigint; - READ_ONLY: bigint; - MANAGE_QUOTAS: bigint; - MANAGE_ROLLOUTS: bigint; - MANAGE_BILLING: bigint; + MANAGE_MEMBERS: bigint; + MANAGE_PROJECT_TOKENS: bigint; + MANAGE_DEPLOYMENTS: bigint; + MANAGE_PIPE: bigint; + MANAGE_SECRETS: bigint; + MANAGE_CHANNELS: bigint; + MANAGE_REGISTRY: bigint; + READ_ONLY: bigint; + MANAGE_QUOTAS: bigint; + MANAGE_ROLLOUTS: bigint; + MANAGE_BILLING: bigint; } ``` diff --git a/docs/js.build.md b/docs/js.build.md index 96489fe6..a23f6cba 100644 --- a/docs/js.build.md +++ b/docs/js.build.md @@ -4,6 +4,8 @@ ## Build interface +A build entity + Signature: ```typescript diff --git a/docs/js.buildmetadata.author.md b/docs/js.buildmetadata.author.md index 1832a02a..0ef445f1 100644 --- a/docs/js.buildmetadata.author.md +++ b/docs/js.buildmetadata.author.md @@ -10,7 +10,7 @@ Author information about build ```typescript author?: { - avatar_url: string; - username: string; - }; + avatar_url: string; + username: string; + }; ``` diff --git a/docs/js.buildmetadata.md b/docs/js.buildmetadata.md index 5dd3c2f5..cad4a2bd 100644 --- a/docs/js.buildmetadata.md +++ b/docs/js.buildmetadata.md @@ -4,6 +4,8 @@ ## BuildMetaData interface +Metadata attached to a build + Signature: ```typescript diff --git a/docs/js.buildmethod.md b/docs/js.buildmethod.md index df02ff6d..c7523589 100644 --- a/docs/js.buildmethod.md +++ b/docs/js.buildmethod.md @@ -16,6 +16,6 @@ declare enum BuildMethod | Member | Value | Description | | --- | --- | --- | -| CLI | 'cli' | | -| GITHUB | 'github' | | +| CLI | "cli" | | +| GITHUB | "github" | | diff --git a/docs/js.buildstate.md b/docs/js.buildstate.md index 20cc3bbf..709f397f 100644 --- a/docs/js.buildstate.md +++ b/docs/js.buildstate.md @@ -14,8 +14,8 @@ declare enum BuildState | Member | Value | Description | | --- | --- | --- | -| CANCELLED | 'cancelled' | | -| FAILED | 'failed' | | -| PENDING | 'pending' | | -| SUCCEEDED | 'succeeded' | | +| CANCELLED | "cancelled" | | +| FAILED | "failed" | | +| PENDING | "pending" | | +| SUCCEEDED | "succeeded" | | diff --git a/docs/js.byteunit.md b/docs/js.byteunit.md index 0055bfce..12ed8a07 100644 --- a/docs/js.byteunit.md +++ b/docs/js.byteunit.md @@ -7,9 +7,7 @@ Signature: ```typescript -declare type ByteUnit = - | typeof byteUnits[number] - | Uppercase; +declare type ByteUnit = typeof byteUnits[number] | Uppercase; ``` References: [byteUnits](./js.byteunits.md) diff --git a/docs/js.byteunits.md b/docs/js.byteunits.md index abc4309f..d4228c14 100644 --- a/docs/js.byteunits.md +++ b/docs/js.byteunits.md @@ -7,5 +7,5 @@ Signature: ```typescript -byteUnits: readonly ['GB', 'MB', 'KB', 'B'] +byteUnits: readonly ["GB", "MB", "KB", "B"] ``` diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md index ca422079..cb2ffde1 100644 --- a/docs/js.channelendpoints.md +++ b/docs/js.channelendpoints.md @@ -7,117 +7,46 @@ Signature: ```typescript -declare type ChannelEndpoints = - | Endpoint< - 'POST', - '/v1/channels', - { - channel: Channel; - }, - { - type: ChannelType; - state: Record | null; - } - > - | Endpoint< - 'PUT', - '/v1/channels/:channel_id', - { - channel: Channel; - }, - { - type: ChannelType; - state: Record | null; - } - > - | Endpoint< - 'POST', - '/v1/channels/tokens', - { - token: ChannelToken; - }, - { - state: State; - } - > - | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> - | Endpoint< - 'GET', - '/v1/channels/:channel_id', - { - channel: Channel; - } - > - | Endpoint< - 'GET', - '/v1/channels/:channel_id/tokens', - { - tokens: ChannelToken[]; - } - > - | Endpoint< - 'POST', - '/v1/channels/tokens/:token/messages', - Empty, - { - e: string; - d: unknown; - } - > - | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> - | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> - | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> - | Endpoint< - 'GET', - '/v1/channels/:channel_id/state', - { - state: State; - } - > - | Endpoint< - 'POST', - '/v1/channels/:channel_id/messages', - Empty, - { - e: string; - d: unknown; - } - > - | Endpoint< - 'GET', - '/v1/channels', - { - channels: Channel[]; - } - > - | Endpoint< - 'GET', - '/v1/channels/tokens/:token', - { - token: ChannelToken; - } - > - | Endpoint< - 'PATCH', - '/v1/channels/tokens/:token', - { - token: ChannelToken; - }, - { - expiresAt?: Timestamp | null; - state: ChannelToken['state']; - } - > - | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> - | Endpoint< - 'GET', - '/v1/channels/:channel_id/stats', - { - stats: { - online_count: number; - }; - } - >; +declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'PUT', '/v1/channels/:channel_id', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'POST', '/v1/channels/tokens', { + token: ChannelToken; +}, { + state: State; +}> | Endpoint<'DELETE', '/v1/channels/:channel_id', _Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { + channel: Channel; +}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { + tokens: ChannelToken[]; +}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', _Empty, { + e: string; + d: unknown; +}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', _Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', _Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', _Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { + state: State; +}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', _Empty, { + e: string; + d: unknown; +}> | Endpoint<'GET', '/v1/channels', { + channels: Channel[]; +}> | Endpoint<'GET', '/v1/channels/tokens/:token', { + token: ChannelToken; +}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { + token: ChannelToken; +}, { + expiresAt?: Timestamp | null; + state: ChannelToken['state']; +}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', _Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { + stats: { + online_count: number; + }; +}>; ``` -References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) +References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Timestamp](./js.timestamp.md) diff --git a/docs/js.channels.md b/docs/js.channels.md index f2cb6af5..cd90aaf0 100644 --- a/docs/js.channels.md +++ b/docs/js.channels.md @@ -1,11 +1,55 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Channels](./js.channels.md) +[Home](./index.md) > [@onehop/js](./js.md) > [channels](./js.channels.md) -## Channels namespace +## channels variable + +Channels SDK client Signature: ```typescript -declare namespace channels +channels: (client: APIClient) => { + create(type: ChannelType, id?: string | null, options?: { + state?: T | undefined; + } | null | undefined, project?: Id<'project'>): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: Token): Promise; + subscribeTokens(tokens: Token[] | Set): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + get(id: string): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: Token): Promise; + subscribeTokens(tokens: Token[] | Set): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + getAll(project?: Id<'project'>): Promise<(Channel & { + setState(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: Token): Promise; + subscribeTokens(tokens: Token[] | Set): Promise; + publishMessage(name: string, data: unknown): Promise; + })[]>; + subscribeToken(channel: string | Channel, token: Token): Promise; + subscribeTokens(channel: string | Channel, tokens: Token[] | Set): Promise; + getAllTokens(channel: string | Channel): Promise; + setState(channel: string | Channel, state: SetStateAction): Promise; + patchState(channel: string | Channel, state: SetStateAction): Promise; + publishMessage(channel: string | Channel, event: string, data: T_5): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: Id<'leap_token'>): Promise; + create(state?: State, project?: Id<'project'>): Promise; + setState(id: Id<'leap_token'>, state: State): Promise; + get(id: Id<'leap_token'>): Promise; + isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; + publishDirectMessage(token: Id<'leap_token'>, event: string, data: T_6): Promise; + }; +} ``` diff --git a/docs/js.channeltype.md b/docs/js.channeltype.md index 7139cef5..f1fa66df 100644 --- a/docs/js.channeltype.md +++ b/docs/js.channeltype.md @@ -14,7 +14,7 @@ declare enum ChannelType | Member | Value | Description | | --- | --- | --- | -| PRIVATE | 'private' | | -| PUBLIC | 'public' | | -| UNPROTECTED | 'unprotected' | | +| PRIVATE | "private" | | +| PUBLIC | "public" | | +| UNPROTECTED | "unprotected" | | diff --git a/docs/js.container.metadata.md b/docs/js.container.metadata.md index 64601eff..b8ef4353 100644 --- a/docs/js.container.metadata.md +++ b/docs/js.container.metadata.md @@ -10,6 +10,6 @@ Information about the container ```typescript metadata: { - last_exit_code?: number; - }; + last_exit_code?: number; + }; ``` diff --git a/docs/js.container.uptime.md b/docs/js.container.uptime.md index b1474c2d..b801f1a4 100644 --- a/docs/js.container.uptime.md +++ b/docs/js.container.uptime.md @@ -10,6 +10,6 @@ Information about uptime/downtime for this container ```typescript uptime: { - last_start: Timestamp; - }; + last_start: Timestamp; + }; ``` diff --git a/docs/js.containerstate.md b/docs/js.containerstate.md index 9a08d3ea..b916dd94 100644 --- a/docs/js.containerstate.md +++ b/docs/js.containerstate.md @@ -16,10 +16,10 @@ declare enum ContainerState | Member | Value | Description | | --- | --- | --- | -| EXITED | 'exited' | The container exited (e.g. with a zero exit code) | -| FAILED | 'failed' | The container's entrypoint failed (e.g. exited with a non-zero exit code) | -| PENDING | 'pending' | The container is pending creation | -| RUNNING | 'running' | The container is running | -| STOPPED | 'stopped' | The container is stopped | -| TERMINATING | 'terminating' | The container is being deleted | +| EXITED | "exited" | The container exited (e.g. with a zero exit code) | +| FAILED | "failed" | The container's entrypoint failed (e.g. exited with a non-zero exit code) | +| PENDING | "pending" | The container is pending creation | +| RUNNING | "running" | The container is running | +| STOPPED | "stopped" | The container is stopped | +| TERMINATING | "terminating" | The container is being deleted | diff --git a/docs/js.default_base_url.md b/docs/js.default_base_url.md index 6ac137e6..d364d83a 100644 --- a/docs/js.default_base_url.md +++ b/docs/js.default_base_url.md @@ -9,5 +9,5 @@ The default base URL for Hop's API. Signature: ```typescript -DEFAULT_BASE_URL = 'https://api.hop.io' +DEFAULT_BASE_URL = "https://api.hop.io" ``` diff --git a/docs/js.deploymentconfig.md b/docs/js.deploymentconfig.md index c8ca0663..56e7cc1f 100644 --- a/docs/js.deploymentconfig.md +++ b/docs/js.deploymentconfig.md @@ -4,19 +4,21 @@ ## DeploymentConfig type +A config for creating a deployment + Signature: ```typescript declare type DeploymentConfig = { - name: string; - container_strategy: 'manual'; - type: RuntimeType; - version: '2022-05-17'; - image: Image; - env: Record; - resources: Resources; - restart_policy: RestartPolicy; - volume?: VolumeDefinition; + name: string; + container_strategy: 'manual'; + type: RuntimeType; + version: '2022-05-17'; + image: Image; + env: Record; + resources: Resources; + restart_policy: RestartPolicy; + volume?: VolumeDefinition; }; ``` References: [RuntimeType](./js.runtimetype.md), [Image](./js.image_2.md), [Resources](./js.resources.md), [RestartPolicy](./js.restartpolicy.md), [VolumeDefinition](./js.volumedefinition.md) diff --git a/docs/js.deploymentrollout.md b/docs/js.deploymentrollout.md index 1cb66406..288aca3b 100644 --- a/docs/js.deploymentrollout.md +++ b/docs/js.deploymentrollout.md @@ -4,16 +4,18 @@ ## DeploymentRollout type +A deployment rollout + Signature: ```typescript declare type DeploymentRollout = { - count: number; - created_at: Timestamp; - deployment_id: Id<'deployment'>; - id: Id<'rollout'>; - state: RolloutState; - build: Build | null; + count: number; + created_at: Timestamp; + deployment_id: Id<'deployment'>; + id: Id<'rollout'>; + state: RolloutState; + build: Build | null; }; ``` References: [Timestamp](./js.timestamp.md), [Id](./js.id.md), [RolloutState](./js.rolloutstate.md), [Build](./js.build.md) diff --git a/docs/js.domainstate.md b/docs/js.domainstate.md index 7bfddfd3..df9bf6f1 100644 --- a/docs/js.domainstate.md +++ b/docs/js.domainstate.md @@ -14,7 +14,7 @@ declare enum DomainState | Member | Value | Description | | --- | --- | --- | -| PENDING | 'pending' | | -| SSL\_ACTIVE | 'ssl_active' | | -| VALID\_CNAME | 'valid_cname' | | +| PENDING | "pending" | | +| SSL\_ACTIVE | "ssl_active" | | +| VALID\_CNAME | "valid_cname" | | diff --git a/docs/js.empty.md b/docs/js.empty.md deleted file mode 100644 index 534185e2..00000000 --- a/docs/js.empty.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) - -## Empty type - -Signature: - -```typescript -declare type Empty = void; -``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md index b668b274..f90a0df2 100644 --- a/docs/js.endpoint.md +++ b/docs/js.endpoint.md @@ -7,17 +7,10 @@ Signature: ```typescript -declare type Endpoint< - M extends Method, - Path extends string, - Res, - Body = undefined, -> = { - method: M; - path: Path; - res: Res; - body: Body; +declare type Endpoint = { + method: M; + path: Path; + res: Res; + body: Body; }; ``` -References: [Method](./js.method.md) - diff --git a/docs/js.endpoints.md b/docs/js.endpoints.md index e453fd53..278f448b 100644 --- a/docs/js.endpoints.md +++ b/docs/js.endpoints.md @@ -7,13 +7,7 @@ Signature: ```typescript -declare type Endpoints = - | IgniteEndpoints - | RegistryEndpoints - | UserEndpoints - | ProjectsEndpoints - | PipeEndpoints - | ChannelEndpoints; +declare type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; ``` References: [IgniteEndpoints](./js.igniteendpoints.md), [RegistryEndpoints](./js.registryendpoints.md), [UserEndpoints](./js.userendpoints.md), [ProjectsEndpoints](./js.projectsendpoints.md), [PipeEndpoints](./js.pipeendpoints.md), [ChannelEndpoints](./js.channelendpoints.md) diff --git a/docs/js.erroredapiresponse.md b/docs/js.erroredapiresponse.md index 07cdf85a..35a4aadc 100644 --- a/docs/js.erroredapiresponse.md +++ b/docs/js.erroredapiresponse.md @@ -8,10 +8,10 @@ ```typescript declare type ErroredAPIResponse = { - success: false; - error: { - code: string; - message: string; - }; + success: false; + error: { + code: string; + message: string; + }; }; ``` diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md deleted file mode 100644 index 8cc1b80a..00000000 --- a/docs/js.extractrouteparams.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) - -## ExtractRouteParams type - -Signature: - -```typescript -declare type ExtractRouteParams = string extends T - ? Record - : T extends `${string}:${infer Param}/${infer Rest}` - ? { - [k in Param | keyof ExtractRouteParams]: string | number; - } - : T extends `${string}:${infer Param}` - ? { - [k in Param]: string | number; - } - : {}; -``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.gatewaytype.md b/docs/js.gatewaytype.md index 4c824a50..3df5ce11 100644 --- a/docs/js.gatewaytype.md +++ b/docs/js.gatewaytype.md @@ -16,6 +16,6 @@ declare enum GatewayType | Member | Value | Description | | --- | --- | --- | -| EXTERNAL | 'external' | The gateway can be accessed from the internet | -| INTERNAL | 'internal' | The gateway can only be accessed inside of a project's network | +| EXTERNAL | "external" | The gateway can be accessed from the internet | +| INTERNAL | "internal" | The gateway can only be accessed inside of a project's network | diff --git a/docs/js.getidprefix.md b/docs/js.getidprefix.md index 6292890d..93f81441 100644 --- a/docs/js.getidprefix.md +++ b/docs/js.getidprefix.md @@ -4,6 +4,8 @@ ## getIdPrefix() function +Gets the prefix of an ID + Signature: ```typescript @@ -14,10 +16,12 @@ declare function getIdPrefix(id: string, expect?: T): T; | Parameter | Type | Description | | --- | --- | --- | -| id | string | | -| expect | T | (Optional) | +| id | string | A full ID to extract the prefix from | +| expect | T | (Optional) An expected prefix to check against | Returns: T +- The prefix of the ID + diff --git a/docs/js.hop.channels.md b/docs/js.hop.channels.md index 3200e2d0..59b9dbc0 100644 --- a/docs/js.hop.channels.md +++ b/docs/js.hop.channels.md @@ -8,97 +8,46 @@ ```typescript readonly channels: { - create( - type: ChannelType, - id?: string | null | undefined, - options?: - | { - state?: T | undefined; - } - | null - | undefined, - project?: `project_${string}` | undefined, - ): Promise< - Channel & { - setState(state: SetStateAction): Promise; - patchState( - state: SetStateAction, - ): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens( - tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, - ): Promise; - publishMessage(name: string, data: unknown): Promise; - } - >; - get(id: string): Promise< - Channel & { - setState(state: SetStateAction): Promise; - patchState( - state: SetStateAction, - ): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens( - tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, - ): Promise; - publishMessage(name: string, data: unknown): Promise; - } - >; - getAll(project?: `project_${string}` | undefined): Promise< - (Channel & { - setState(state: SetStateAction): Promise; - patchState( - state: SetStateAction, - ): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens( - tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, - ): Promise; - publishMessage(name: string, data: unknown): Promise; - })[] - >; - subscribeToken( - channel: string | Channel, - token: `leap_token_${string}`, - ): Promise; - subscribeTokens( - channel: string | Channel, - tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>, - ): Promise; - getAllTokens(channel: string | Channel): Promise; - setState( - channel: string | Channel, - state: SetStateAction, - ): Promise; - patchState( - channel: string | Channel, - state: SetStateAction, - ): Promise; - publishMessage( - channel: string | Channel, - event: string, - data: T_5, - ): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: `leap_token_${string}`): Promise; - create( - state?: State, - project?: `project_${string}` | undefined, - ): Promise; - setState(id: `leap_token_${string}`, state: State): Promise; - get(id: `leap_token_${string}`): Promise; - isOnline( - idOrToken: `leap_token_${string}` | ChannelToken, - ): Promise; - publishDirectMessage( - token: `leap_token_${string}`, - event: string, - data: T_6, - ): Promise; - }; - }; + create(type: ChannelType, id?: string | null | undefined, options?: { + state?: T | undefined; + } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + get(id: string): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + getAll(project?: `project_${string}` | undefined): Promise<(Channel & { + setState(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + })[]>; + subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; + subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + getAllTokens(channel: string | Channel): Promise; + setState(channel: string | Channel, state: SetStateAction): Promise; + patchState(channel: string | Channel, state: SetStateAction): Promise; + publishMessage(channel: string | Channel, event: string, data: T_5): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: `leap_token_${string}`): Promise; + create(state?: State, project?: `project_${string}` | undefined): Promise; + setState(id: `leap_token_${string}`, state: State): Promise; + get(id: `leap_token_${string}`): Promise; + isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; + publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; + }; + }; ``` diff --git a/docs/js.hop.ignite.md b/docs/js.hop.ignite.md index 029ae0a8..1afad47b 100644 --- a/docs/js.hop.ignite.md +++ b/docs/js.hop.ignite.md @@ -8,139 +8,78 @@ ```typescript readonly ignite: { - gateways: { - addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; - get(gatewayId: `gateway_${string}`): Promise; - }; - deployments: { - create: { - ( - configOrProject: `project_${string}`, - bearerOrPatConfig: DeploymentConfig, - ): Promise< - Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway( - type: GatewayType, - protocol: 'http' | null, - port: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - } - >; - (configOrProject: DeploymentConfig): Promise< - Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway( - type: GatewayType, - protocol: 'http' | null, - port: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - } - >; - }; - get: { - (name: string, projectId?: `project_${string}` | undefined): Promise< - Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway( - type: GatewayType, - protocol: 'http' | null, - port: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - } - >; - ( - id: `deployment_${string}`, - projectId?: `project_${string}` | undefined, - ): Promise< - Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway( - type: GatewayType, - protocol: 'http' | null, - port: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - } - >; - }; - update( - deploymentId: `deployment_${string}`, - config: DeploymentConfig, - ): Promise; - getContainers(deployment: `deployment_${string}`): Promise; - getAll(projectId?: `project_${string}` | undefined): Promise< - (Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway( - type: GatewayType, - protocol: 'http' | null, - port: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - })[] - >; - delete(deployment: `deployment_${string}`): Promise; - gateways: { - getAll(deploymentId: `deployment_${string}`): Promise< - (Gateway & { - addDomain(domain: string): Promise; - })[] - >; - create( - deployment: `deployment_${string}` | Deployment, - type: GatewayType, - protocol: 'http' | null, - targetPort: number, - ): Promise< - Gateway & { - addDomain(domain: string): Promise; - } - >; - }; - }; - containers: { - delete(container: `container_${string}`): Promise; - getLogs( - container: `container_${string}`, - options?: Partial<{ - sortBy: 'timestamp'; - orderBy: 'desc' | 'asc'; - limit: number; - offset: number; - }>, - ): Promise; - stop(container: `container_${string}`): Promise; - start(container: `container_${string}`): Promise; - create(deployment: `deployment_${string}`): Promise; - }; - }; + gateways: { + addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; + get(gatewayId: `gateway_${string}`): Promise; + }; + deployments: { + create: { + (configOrProject: `project_${string}`, bearerOrPatConfig: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + (configOrProject: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + }; + get: { + (name: string, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + }>; + }; + update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; + getContainers(deployment: `deployment_${string}`): Promise; + getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; + }>; + })[]>; + delete(deployment: `deployment_${string}`): Promise; + gateways: { + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, type: GatewayType, protocol: "http" | null, targetPort: number): Promise; + }>; + }; + }; + containers: { + delete(container: `container_${string}`): Promise; + getLogs(container: `container_${string}`, options?: Partial<{ + sortBy: "timestamp"; + orderBy: "desc" | "asc"; + limit: number; + offset: number; + }>): Promise; + stop(container: `container_${string}`): Promise; + start(container: `container_${string}`): Promise; + create(deployment: `deployment_${string}`): Promise; + }; + }; ``` diff --git a/docs/js.hop.md b/docs/js.hop.md index 6a44c718..aaa79671 100644 --- a/docs/js.hop.md +++ b/docs/js.hop.md @@ -31,11 +31,11 @@ await hop.ignite.containers.create(deploymentId); | Property | Modifiers | Type | Description | | --- | --- | --- | --- | -| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>( type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: \| { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined, ): Promise< [Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; } >; get(id: string): Promise< [Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; } >; getAll(project?: \`project\_${string}\` \| undefined): Promise< ([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: SetStateAction<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>( state: SetStateAction<T\_2>, ): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens( tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\] >; subscribeToken( channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`, ): Promise<void>; subscribeTokens( channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>, ): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>( channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_3>, ): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>( channel: string \| [Channel](./js.channel.md), state: SetStateAction<T\_4>, ): Promise<void>; publishMessage<T\_5>( channel: string \| [Channel](./js.channel.md), event: string, data: T\_5, ): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create( state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined, ): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline( idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md), ): Promise<boolean>; publishDirectMessage<T\_6>( token: \`leap\_token\_${string}\`, event: string, data: T\_6, ): Promise<void>; }; } | | +| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>(type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; get(id: string): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; getAll(project?: \`project\_${string}\` \| undefined): Promise<([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\]>; subscribeToken(channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: [SetStateAction](./js.setstateaction.md)<T\_3>): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: [SetStateAction](./js.setstateaction.md)<T\_4>): Promise<void>; publishMessage<T\_5>(channel: string \| [Channel](./js.channel.md), event: string, data: T\_5): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create(state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline(idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md)): Promise<boolean>; publishDirectMessage<T\_6>(token: \`leap\_token\_${string}\`, event: string, data: T\_6): Promise<void>; }; } | | | [client](./js.hop.client.md) | readonly | [APIClient](./js.apiclient.md) | | -| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { ( configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md), ): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; ( id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined, ): Promise< [Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; } >; }; update( deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md), ): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise< ([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway( type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, port: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; })\[\] >; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise< ([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\] >; create( deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: 'http' \| null, targetPort: number, ): Promise< [Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; } >; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs( container: \`container\_${string}\`, options?: Partial<{ sortBy: 'timestamp'; orderBy: 'desc' \| 'asc'; limit: number; offset: number; }>, ): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | -| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise< ([Room](./js.room.md) & { delete(): Promise<void>; })\[\] >; create( name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: 'rtmp' \| 'rtp'; hlsConfig?: \| { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }, ): Promise< [Room](./js.room.md) & { delete(): Promise<void>; } >; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | -| [projects](./js.hop.projects.md) | readonly | { getAllMembers( projectId?: \`project\_${string}\` \| undefined, ): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete( projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined, ): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create( flags: number, projectId?: \`project\_${string}\` \| undefined, ): Promise< [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); } >; }; tokens: { delete( projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined, ): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create( flags: number, projectId?: \`project\_${string}\` \| undefined, ): Promise< [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); } >; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create( name: string, value: string, projectId?: \`project\_${string}\` \| undefined, ): Promise<[Secret](./js.secret.md)>; delete( id: string, projectId?: \`project\_${string}\` \| undefined, ): Promise<void>; }; } | | -| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise< { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\] >; delete(image: string): Promise<void>; }; } | | +| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { (configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; update(deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise<([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; })\[\]>; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise<([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\]>; create(deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, targetPort: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs(container: \`container\_${string}\`, options?: Partial<{ sortBy: "timestamp"; orderBy: "desc" \| "asc"; limit: number; offset: number; }>): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | +| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise<([Room](./js.room.md) & { delete(): Promise<void>; })\[\]>; create(name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: "rtmp" \| "rtp"; hlsConfig?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }): Promise<[Room](./js.room.md) & { delete(): Promise<void>; }>; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | +| [projects](./js.hop.projects.md) | readonly | { getAllMembers(projectId?: \`project\_${string}\` \| undefined): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; tokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create(name: string, value: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)>; delete(id: string, projectId?: \`project\_${string}\` \| undefined): Promise<void>; }; } | | +| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise<{ digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]>; delete(image: string): Promise<void>; }; } | | | [users](./js.hop.users.md) | readonly | { me: { get(): Promise<{ projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }>; pats: { create(name: string): Promise<[PAT](./js.pat.md)>; getAll(): Promise<[PAT](./js.pat.md)\[\]>; delete(id: \`pat\_${string}\`): Promise<void>; }; }; } | | diff --git a/docs/js.hop.pipe.md b/docs/js.hop.pipe.md index f18408ef..8aeff3ff 100644 --- a/docs/js.hop.pipe.md +++ b/docs/js.hop.pipe.md @@ -8,32 +8,23 @@ ```typescript readonly pipe: { - rooms: { - getAll(project?: `project_${string}` | undefined): Promise< - (Room & { - delete(): Promise; - })[] - >; - create( - name: string, - options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean | undefined; - ingestProtocol: 'rtmp' | 'rtp'; - hlsConfig?: - | { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } - | undefined; - }, - ): Promise< - Room & { - delete(): Promise; - } - >; - delete(room: `pipe_room_${string}`): Promise; - }; - }; + rooms: { + getAll(project?: `project_${string}` | undefined): Promise<(Room & { + delete(): Promise; + })[]>; + create(name: string, options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean | undefined; + ingestProtocol: "rtmp" | "rtp"; + hlsConfig?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } | undefined; + }): Promise; + }>; + delete(room: `pipe_room_${string}`): Promise; + }; + }; ``` diff --git a/docs/js.hop.projects.md b/docs/js.hop.projects.md index d7597221..3d6a89ee 100644 --- a/docs/js.hop.projects.md +++ b/docs/js.hop.projects.md @@ -8,51 +8,26 @@ ```typescript readonly projects: { - getAllMembers( - projectId?: `project_${string}` | undefined, - ): Promise; - getCurrentMember(projectId: `project_${string}`): Promise; - projectTokens: { - delete( - projectTokenId: `ptkid_${string}`, - project?: `project_${string}` | undefined, - ): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create( - flags: number, - projectId?: `project_${string}` | undefined, - ): Promise< - ProjectToken & { - project: Project; - } - >; - }; - tokens: { - delete( - projectTokenId: `ptkid_${string}`, - project?: `project_${string}` | undefined, - ): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create( - flags: number, - projectId?: `project_${string}` | undefined, - ): Promise< - ProjectToken & { - project: Project; - } - >; - }; - secrets: { - getAll(projectId?: `project_${string}` | undefined): Promise; - create( - name: string, - value: string, - projectId?: `project_${string}` | undefined, - ): Promise; - delete( - id: string, - projectId?: `project_${string}` | undefined, - ): Promise; - }; - }; + getAllMembers(projectId?: `project_${string}` | undefined): Promise; + getCurrentMember(projectId: `project_${string}`): Promise; + projectTokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + tokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + secrets: { + getAll(projectId?: `project_${string}` | undefined): Promise; + create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; + delete(id: string, projectId?: `project_${string}` | undefined): Promise; + }; + }; ``` diff --git a/docs/js.hop.registry.md b/docs/js.hop.registry.md index d8d835bb..66413e43 100644 --- a/docs/js.hop.registry.md +++ b/docs/js.hop.registry.md @@ -8,19 +8,17 @@ ```typescript readonly registry: { - images: { - getAll(project?: `project_${string}` | undefined): Promise; - getManifest(image: string): Promise< - { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[] - >; - delete(image: string): Promise; - }; - }; + images: { + getAll(project?: `project_${string}` | undefined): Promise; + getManifest(image: string): Promise<{ + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]>; + delete(image: string): Promise; + }; + }; ``` diff --git a/docs/js.hop.users.md b/docs/js.hop.users.md index 6d5bffb5..751a0e80 100644 --- a/docs/js.hop.users.md +++ b/docs/js.hop.users.md @@ -8,18 +8,18 @@ ```typescript readonly users: { - me: { - get(): Promise<{ - projects: Project[]; - user: User; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: `pat_${string}`): Promise; - }; - }; - }; + me: { + get(): Promise<{ + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: `pat_${string}`): Promise; + }; + }; + }; ``` diff --git a/docs/js.hopshdomain.md b/docs/js.hopshdomain.md index 9e1292f6..6fd870e3 100644 --- a/docs/js.hopshdomain.md +++ b/docs/js.hopshdomain.md @@ -4,6 +4,8 @@ ## HopShDomain type +A hop.sh domain (\*.hop.sh) + Signature: ```typescript diff --git a/docs/js.id.md b/docs/js.id.md index cfb88226..00774837 100644 --- a/docs/js.id.md +++ b/docs/js.id.md @@ -4,6 +4,8 @@ ## Id type +A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika + Signature: ```typescript diff --git a/docs/js.id_prefixes.md b/docs/js.id_prefixes.md index 77fc4ffa..6040fb1c 100644 --- a/docs/js.id_prefixes.md +++ b/docs/js.id_prefixes.md @@ -4,81 +4,64 @@ ## ID\_PREFIXES variable +An array of all IDs that can be used in the API + Signature: ```typescript -ID_PREFIXES: readonly [ - { - readonly prefix: 'user'; - readonly description: 'Users'; - }, - { - readonly prefix: 'project'; - readonly description: 'Project'; - }, - { - readonly prefix: 'pm'; - readonly description: 'Project Members'; - }, - { - readonly prefix: 'role'; - readonly description: 'Roles'; - }, - { - readonly prefix: 'pi'; - readonly description: 'Project Invite'; - }, - { - readonly prefix: 'ptk'; - readonly description: 'Project token'; - }, - { - readonly prefix: 'pat'; - readonly description: 'User personal access token'; - }, - { - readonly prefix: 'container'; - readonly description: 'Ignite container'; - }, - { - readonly prefix: 'pipe_room'; - readonly description: 'Pipe room'; - }, - { - readonly prefix: 'deployment'; - readonly description: 'Ignite deployment'; - }, - { - readonly prefix: 'bearer'; - readonly description: 'Users bearer token'; - }, - { - readonly prefix: 'ptkid'; - readonly description: 'Project token ID'; - }, - { - readonly prefix: 'secret'; - readonly description: 'Project secret ID'; - }, - { - readonly prefix: 'gateway'; - readonly description: 'Gateway'; - }, - { - readonly prefix: 'domain'; - readonly description: 'Domain for a gateway'; - }, - { - readonly prefix: 'leap_token'; - readonly description: 'Token for connecting to leap as a client'; - }, - { - readonly prefix: 'build'; - readonly description: 'Build ID for build logs'; - }, - { - readonly prefix: 'rollout'; - readonly description: 'Rollout ID for rollouts.'; - }, -] +ID_PREFIXES: readonly [{ + readonly prefix: "user"; + readonly description: "Users"; +}, { + readonly prefix: "project"; + readonly description: "Project"; +}, { + readonly prefix: "pm"; + readonly description: "Project Members"; +}, { + readonly prefix: "role"; + readonly description: "Roles"; +}, { + readonly prefix: "pi"; + readonly description: "Project Invite"; +}, { + readonly prefix: "ptk"; + readonly description: "Project token"; +}, { + readonly prefix: "pat"; + readonly description: "User personal access token"; +}, { + readonly prefix: "container"; + readonly description: "Ignite container"; +}, { + readonly prefix: "pipe_room"; + readonly description: "Pipe room"; +}, { + readonly prefix: "deployment"; + readonly description: "Ignite deployment"; +}, { + readonly prefix: "bearer"; + readonly description: "Users bearer token"; +}, { + readonly prefix: "ptkid"; + readonly description: "Project token ID"; +}, { + readonly prefix: "secret"; + readonly description: "Project secret ID"; +}, { + readonly prefix: "gateway"; + readonly description: "Gateway"; +}, { + readonly prefix: "domain"; + readonly description: "Domain for a gateway"; +}, { + readonly prefix: "leap_token"; + readonly description: "Token for connecting to leap as a client"; +}, { + readonly prefix: "build"; + readonly description: "Build ID for build logs"; +}, { + readonly prefix: "rollout"; + readonly description: "Rollout ID for rollouts."; +}] ``` diff --git a/docs/js.idprefixes.md b/docs/js.idprefixes.md index 565ed27c..9ec6b269 100644 --- a/docs/js.idprefixes.md +++ b/docs/js.idprefixes.md @@ -4,6 +4,8 @@ ## IdPrefixes type +A union of all ID prefixes used within the API + Signature: ```typescript diff --git a/docs/js.ignite.md b/docs/js.ignite.md index 02f64de6..2443e535 100644 --- a/docs/js.ignite.md +++ b/docs/js.ignite.md @@ -1,11 +1,87 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Ignite](./js.ignite.md) +[Home](./index.md) > [@onehop/js](./js.md) > [ignite](./js.ignite.md) -## Ignite namespace +## ignite variable + +Ignite SDK client Signature: ```typescript -declare namespace ignite +ignite: (client: APIClient) => { + gateways: { + addDomain(gatewayId: Id<'gateway'>, domain: string): Promise; + get(gatewayId: Id<'gateway'>): Promise; + }; + deployments: { + create: { + (configOrProject: Id<'project'>, bearerOrPatConfig: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; + }>; + }>; + (configOrProject: DeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; + }>; + }>; + }; + get: { + (name: string, projectId?: Id<'project'>): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; + }>; + }>; + (id: Id<'deployment'>, projectId?: Id<'project'>): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; + }>; + }>; + }; + update(deploymentId: Id<'deployment'>, config: DeploymentConfig): Promise; + getContainers(deployment: Id<'deployment'>): Promise; + getAll(projectId?: Id<'project'>): Promise<(Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; + }>; + })[]>; + delete(deployment: Id<'deployment'>): Promise; + gateways: { + getAll(deploymentId: Id<'deployment'>): Promise<(Gateway & { + addDomain(domain: string): Promise; + })[]>; + create(deployment: Deployment | Deployment['id'], type: GatewayType, protocol: Gateway['protocol'], targetPort: number): Promise; + }>; + }; + }; + containers: { + delete(container: Id<'container'>): Promise; + getLogs(container: Id<'container'>, options?: Partial<{ + sortBy: 'timestamp'; + orderBy: 'desc' | 'asc'; + limit: number; + offset: number; + }>): Promise; + stop(container: Id<'container'>): Promise; + start(container: Id<'container'>): Promise; + create(deployment: Id<'deployment'>): Promise; + }; +} ``` diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md index 63331db4..392ba8f7 100644 --- a/docs/js.igniteendpoints.md +++ b/docs/js.igniteendpoints.md @@ -7,118 +7,40 @@ Signature: ```typescript -declare type IgniteEndpoints = - | Endpoint< - 'GET', - '/v1/ignite/deployments', - { - deployments: Deployment[]; - } - > - | Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id/containers', - { - containers: Container[]; - } - > - | Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/containers', - { - container: Container; - } - > - | Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/containers/:container_id', - never, - { - deployment_id: Id<'deployment'>; - container_id: Id<'container'>; - } - > - | Endpoint< - 'POST', - '/v1/ignite/deployments', - { - deployment: Deployment; - }, - DeploymentConfig - > - | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> - | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> - | Endpoint< - 'GET', - '/v1/ignite/containers/:container_id/logs', - { - logs: ContainerLog[]; - } - > - | Endpoint< - 'GET', - '/v1/ignite/deployments/search', - { - deployment: Deployment; - } - > - | Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id', - { - deployment: Deployment; - } - > - | Endpoint< - 'PUT', - '/v1/ignite/containers/:container_id/state', - Empty, - { - preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; - } - > - | Endpoint< - 'POST', - '/v1/ignite/gateways/:gateway_id/domains', - Empty, - { - domain: string; - } - > - | Endpoint< - 'GET', - '/v1/ignite/gateways/:gateway_id', - { - gateway: Gateway; - } - > - | Endpoint< - 'GET', - '/v1/ignite/deployments/:deployment_id/gateways', - { - gateways: Gateway[]; - } - > - | Endpoint< - 'POST', - '/v1/ignite/deployments/:deployment_id/gateways', - { - gateway: Gateway; - }, - { - type: GatewayType; - target_port: number; - protocol: Gateway['protocol']; - } - > - | Endpoint< - 'PATCH', - '/v1/ignite/deployments/:deployment_id', - { - deployment: Deployment; - }, - DeploymentConfig - >; +declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { + deployments: Deployment[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { + containers: Container[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { + container: Container; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { + deployment_id: Id<'deployment'>; + container_id: Id<'container'>; +}> | Endpoint<'POST', '/v1/ignite/deployments', { + deployment: Deployment; +}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', _Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', _Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { + logs: ContainerLog[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/search', { + deployment: Deployment; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', _Empty, { + preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; +}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', _Empty, { + domain: string; +}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { + gateway: Gateway; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { + gateways: Gateway[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { + gateway: Gateway; +}, { + type: GatewayType; + target_port: number; + protocol: Gateway['protocol']; +}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}, DeploymentConfig>; ``` -References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) +References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) diff --git a/docs/js.internalhopdomain.md b/docs/js.internalhopdomain.md index 8ee254c8..266c47ea 100644 --- a/docs/js.internalhopdomain.md +++ b/docs/js.internalhopdomain.md @@ -4,6 +4,8 @@ ## InternalHopDomain type +A domain used with internal gateways (\*.hop.sh) + Signature: ```typescript diff --git a/docs/js.md b/docs/js.md index af94a8fe..44107b02 100644 --- a/docs/js.md +++ b/docs/js.md @@ -22,7 +22,7 @@ | [ContainerState](./js.containerstate.md) | Container state is relatively self-explanatory. It describes what the container is currently doing. | | [DomainState](./js.domainstate.md) | | | [GatewayType](./js.gatewaytype.md) | Types of gateways supported by Hop | -| [PROJECT\_PERMISSION](./js.project_permission.md) | | +| [PROJECT\_PERMISSION](./js.project_permission.md) | A list of all permissions and their representative names | | [ProjectTier](./js.projecttier.md) | | | [ProjectType](./js.projecttype.md) | Type of a project | | [Regions](./js.regions.md) | | @@ -37,7 +37,7 @@ | Function | Description | | --- | --- | | [assertId(maybeId, prefix, message)](./js.assertid.md) | Asserts that a string is a valid ID | -| [getIdPrefix(id, expect)](./js.getidprefix.md) | | +| [getIdPrefix(id, expect)](./js.getidprefix.md) | Gets the prefix of an ID | | [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | | [isValidByteString(value)](./js.isvalidbytestring.md) | | | [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | @@ -51,8 +51,8 @@ | --- | --- | | [APIClientOptions](./js.apiclientoptions.md) | | | [Auth](./js.auth.md) | Docker image registry authorization | -| [Build](./js.build.md) | | -| [BuildMetaData](./js.buildmetadata.md) | | +| [Build](./js.build.md) | A build entity | +| [BuildMetaData](./js.buildmetadata.md) | Metadata attached to a build | | [Channel](./js.channel.md) | | | [ChannelToken](./js.channeltoken.md) | | | [Container](./js.container.md) | | @@ -93,22 +93,28 @@ | Variable | Description | | --- | --- | -| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | | +| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | Broader permission map | | [byteUnits](./js.byteunits.md) | | +| [channels](./js.channels.md) | Channels SDK client | | [DEFAULT\_BASE\_URL](./js.default_base_url.md) | The default base URL for Hop's API. | -| [ID\_PREFIXES](./js.id_prefixes.md) | | +| [ID\_PREFIXES](./js.id_prefixes.md) | An array of all IDs that can be used in the API | +| [ignite](./js.ignite.md) | Ignite SDK client | | [IS\_BROWSER](./js.is_browser.md) | If we are in the browser. | -| [permissions](./js.permissions.md) | | -| [permissionsMap](./js.permissionsmap.md) | | -| [roles](./js.roles.md) | | +| [permissions](./js.permissions.md) | Permission utility functions | +| [permissionsMap](./js.permissionsmap.md) | Individual bitwise permissions | +| [pipe](./js.pipe.md) | Pipe SDK client | +| [projects](./js.projects.md) | Projects SDK client | +| [registry](./js.registry.md) | Registry SDK client | +| [roles](./js.roles.md) | Bitwise role flags that a user can be as part of a project | | [SUPPORTS\_INTL](./js.supports_intl.md) | | | [units](./js.units.md) | | +| [users](./js.users.md) | Users SDK client | ## Type Aliases | Type Alias | Description | | --- | --- | -| [AnyId](./js.anyid.md) | | +| [AnyId](./js.anyid.md) | Any/all IDs that are used within the API | | [APIAuthentication](./js.apiauthentication.md) | | | [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | | | [APIResponse](./js.apiresponse.md) | | @@ -117,29 +123,26 @@ | [ByteUnit](./js.byteunit.md) | | | [ChannelEndpoints](./js.channelendpoints.md) | | | [DeliveryProtocol](./js.deliveryprotocol.md) | | -| [DeploymentConfig](./js.deploymentconfig.md) | | -| [DeploymentRollout](./js.deploymentrollout.md) | | -| [Empty](./js.empty.md) | | +| [DeploymentConfig](./js.deploymentconfig.md) | A config for creating a deployment | +| [DeploymentRollout](./js.deploymentrollout.md) | A deployment rollout | | [Endpoint](./js.endpoint.md) | | | [Endpoints](./js.endpoints.md) | | | [ErroredAPIResponse](./js.erroredapiresponse.md) | | -| [ExtractRouteParams](./js.extractrouteparams.md) | | -| [HopShDomain](./js.hopshdomain.md) | | -| [Id](./js.id.md) | | -| [IdPrefixes](./js.idprefixes.md) | | +| [HopShDomain](./js.hopshdomain.md) | A hop.sh domain (\*.hop.sh) | +| [Id](./js.id.md) | A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika | +| [IdPrefixes](./js.idprefixes.md) | A union of all ID prefixes used within the API | | [IgniteEndpoints](./js.igniteendpoints.md) | | -| [InternalHopDomain](./js.internalhopdomain.md) | | +| [InternalHopDomain](./js.internalhopdomain.md) | A domain used with internal gateways (\*.hop.sh) | | [Member](./js.member.md) | | -| [Method](./js.method.md) | | | [PartialAPIOptions](./js.partialapioptions.md) | | | [PipeEndpoints](./js.pipeendpoints.md) | | | [ProjectsEndpoints](./js.projectsendpoints.md) | | | [Query](./js.query.md) | | | [RegistryEndpoints](./js.registryendpoints.md) | | +| [SetStateAction](./js.setstateaction.md) | New state to set to a channel, or a callback function that will produce the new state | | [State](./js.state.md) | | | [SuccessfulAPIResponse](./js.successfulapiresponse.md) | | -| [Tag](./js.tag.md) | | -| [Timestamp](./js.timestamp.md) | Hop's API uses ISO 8601 date strings | +| [Tag](./js.tag.md) | Tag a type to make it unique | +| [Timestamp](./js.timestamp.md) | An ISO 8601 date strings | | [UserEndpoints](./js.userendpoints.md) | | -| [Values](./js.values.md) | | diff --git a/docs/js.member.md b/docs/js.member.md index 8cb20d8a..0ee4a3b3 100644 --- a/docs/js.member.md +++ b/docs/js.member.md @@ -8,9 +8,9 @@ ```typescript declare type Member = Omit & { - id: Id<'pm'>; - role: MemberRole; - joined_at: Timestamp; + id: Id<'pm'>; + role: MemberRole; + joined_at: Timestamp; }; ``` References: [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [Timestamp](./js.timestamp.md) diff --git a/docs/js.method.md b/docs/js.method.md deleted file mode 100644 index a7e55a41..00000000 --- a/docs/js.method.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) - -## Method type - -Signature: - -```typescript -declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; -``` diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md index 29182df9..27242ba4 100644 --- a/docs/js.partialapioptions.md +++ b/docs/js.partialapioptions.md @@ -7,10 +7,7 @@ Signature: ```typescript -declare type PartialAPIOptions = Partial< - Omit -> & - Pick; +declare type PartialAPIOptions = Partial> & Pick; ``` References: [APIClientOptions](./js.apiclientoptions.md) diff --git a/docs/js.permissions.md b/docs/js.permissions.md index 1d1bcc7b..6d3129d6 100644 --- a/docs/js.permissions.md +++ b/docs/js.permissions.md @@ -4,12 +4,14 @@ ## permissions variable +Permission utility functions + Signature: ```typescript permissions: { - add(value: bigint, flag: bigint): bigint; - test(value: bigint, flag: bigint): boolean; - subtract(value: bigint, flag: bigint): bigint; + add(value: bigint, flag: bigint): bigint; + test(value: bigint, flag: bigint): boolean; + subtract(value: bigint, flag: bigint): bigint; } ``` diff --git a/docs/js.permissionsmap.md b/docs/js.permissionsmap.md index 8e9de96e..07ae4c4a 100644 --- a/docs/js.permissionsmap.md +++ b/docs/js.permissionsmap.md @@ -4,53 +4,55 @@ ## permissionsMap variable +Individual bitwise permissions + Signature: ```typescript permissionsMap: { - add_member: bigint; - remove_member: bigint; - get_project_members: bigint; - delete_project: bigint; - delete_deployment: bigint; - delete_container: bigint; - update_container_state: bigint; - read_deployments: bigint; - create_deployment: bigint; - create_container: bigint; - update_container_config: bigint; - create_room: bigint; - read_room: bigint; - delete_room: bigint; - create_room_producer: bigint; - create_project_token: bigint; - delete_project_token: bigint; - read_project_tokens: bigint; - read_container_logs: bigint; - create_project_secret: bigint; - read_project_secrets: bigint; - delete_project_secret: bigint; - get_registry_images: bigint; - create_channel_token: bigint; - create_gateway: bigint; - add_domain: bigint; - delete_channels: bigint; - update_channel_state: bigint; - read_channels: bigint; - publish_channel_messages: bigint; - manage_channel_subscribers: bigint; - delete_domain: bigint; - delete_gateway: bigint; - get_internal_domain: bigint; - create_leap_token: bigint; - read_leap_tokens: bigint; - update_leap_token: bigint; - message_token: bigint; - create_channel: bigint; - rollout: bigint; - request_quota_increase: bigint; - read_billing: bigint; - read_gateways: bigint; - delete_registry_images: bigint; + add_member: bigint; + remove_member: bigint; + get_project_members: bigint; + delete_project: bigint; + delete_deployment: bigint; + delete_container: bigint; + update_container_state: bigint; + read_deployments: bigint; + create_deployment: bigint; + create_container: bigint; + update_container_config: bigint; + create_room: bigint; + read_room: bigint; + delete_room: bigint; + create_room_producer: bigint; + create_project_token: bigint; + delete_project_token: bigint; + read_project_tokens: bigint; + read_container_logs: bigint; + create_project_secret: bigint; + read_project_secrets: bigint; + delete_project_secret: bigint; + get_registry_images: bigint; + create_channel_token: bigint; + create_gateway: bigint; + add_domain: bigint; + delete_channels: bigint; + update_channel_state: bigint; + read_channels: bigint; + publish_channel_messages: bigint; + manage_channel_subscribers: bigint; + delete_domain: bigint; + delete_gateway: bigint; + get_internal_domain: bigint; + create_leap_token: bigint; + read_leap_tokens: bigint; + update_leap_token: bigint; + message_token: bigint; + create_channel: bigint; + rollout: bigint; + request_quota_increase: bigint; + read_billing: bigint; + read_gateways: bigint; + delete_registry_images: bigint; } ``` diff --git a/docs/js.pipe.md b/docs/js.pipe.md index 09432b46..4467389a 100644 --- a/docs/js.pipe.md +++ b/docs/js.pipe.md @@ -1,11 +1,32 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Pipe](./js.pipe.md) +[Home](./index.md) > [@onehop/js](./js.md) > [pipe](./js.pipe.md) -## Pipe namespace +## pipe variable + +Pipe SDK client Signature: ```typescript -declare namespace pipe +pipe: (client: APIClient) => { + rooms: { + getAll(project?: Id<'project'>): Promise<(Room & { + delete(): Promise; + })[]>; + create(name: string, options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean; + ingestProtocol: 'rtmp' | 'rtp'; + hlsConfig?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; + }): Promise; + }>; + delete(room: Id<'pipe_room'>): Promise; + }; +} ``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md index ca9cf39d..50eb01b9 100644 --- a/docs/js.pipeendpoints.md +++ b/docs/js.pipeendpoints.md @@ -7,34 +7,22 @@ Signature: ```typescript -declare type PipeEndpoints = - | Endpoint< - 'GET', - '/v1/pipe/rooms', - { - rooms: Room[]; - } - > - | Endpoint< - 'POST', - '/v1/pipe/rooms', - { - room: Room; - }, - { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; - } - > - | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; +declare type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { + rooms: Room[]; +}> | Endpoint<'POST', '/v1/pipe/rooms', { + room: Room; +}, { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; +}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', _Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) +References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md) diff --git a/docs/js.project_permission.md b/docs/js.project_permission.md index 69604129..ba407493 100644 --- a/docs/js.project_permission.md +++ b/docs/js.project_permission.md @@ -4,6 +4,8 @@ ## PROJECT\_PERMISSION enum +A list of all permissions and their representative names + Signature: ```typescript @@ -14,48 +16,48 @@ declare enum PROJECT_PERMISSION | Member | Value | Description | | --- | --- | --- | -| ADD\_DOMAIN | 'add_domain' | | -| ADD\_MEMBER | 'add_member' | | -| CREATE\_CHANNEL | 'create_channel' | | -| CREATE\_CHANNEL\_TOKEN | 'create_channel_token' | | -| CREATE\_CONTAINER | 'create_container' | | -| CREATE\_DEPLOYMENT | 'create_deployment' | | -| CREATE\_GATEWAY | 'create_gateway' | | -| CREATE\_LEAP\_TOKEN | 'create_leap_token' | | -| CREATE\_PROJECT\_SECRET | 'create_project_secret' | | -| CREATE\_PROJECT\_TOKEN | 'create_project_token' | | -| CREATE\_ROOM | 'create_room' | | -| CREATE\_ROOM\_PRODUCER | 'create_room_producer' | | -| DELETE\_CHANNELS | 'delete_channels' | | -| DELETE\_CONTAINER | 'delete_container' | | -| DELETE\_DEPLOYMENT | 'delete_deployment' | | -| DELETE\_DOMAIN | 'delete_domain' | | -| DELETE\_GATEWAY | 'delete_gateway' | | -| DELETE\_PROJECT | 'delete_project' | | -| DELETE\_PROJECT\_SECRET | 'delete_project_secret' | | -| DELETE\_PROJECT\_TOKEN | 'delete_project_token' | | -| DELETE\_REGISTRY\_IMAGES | 'delete_registry_images' | | -| DELETE\_ROOM | 'delete_room' | | -| GET\_INTERNAL\_DOMAIN | 'get_internal_domain' | | -| GET\_PROJECT\_MEMBERS | 'get_project_members' | | -| GET\_REGISTRY\_IMAGES | 'get_registry_images' | | -| MANAGE\_CHANNEL\_SUBSCRIBERS | 'manage_channel_subscribers' | | -| MESSAGE\_TOKEN | 'message_token' | | -| PUBLISH\_CHANNEL\_MESSAGES | 'publish_channel_messages' | | -| READ\_BILLING | 'read_billing' | | -| READ\_CHANNELS | 'read_channels' | | -| READ\_CONTAINER\_LOGS | 'read_container_logs' | | -| READ\_DEPLOYMENTS | 'read_deployments' | | -| READ\_GATEWAYS | 'read_gateways' | | -| READ\_LEAP\_TOKENS | 'read_leap_tokens' | | -| READ\_PROJECT\_SECRETS | 'read_project_secrets' | | -| READ\_PROJECT\_TOKENS | 'read_project_tokens' | | -| READ\_ROOM | 'read_room' | | -| REMOVE\_MEMBER | 'remove_member' | | -| REQUEST\_QUOTA\_INCREASE | 'request_quota_increase' | | -| ROLLOUT | 'rollout' | | -| UPDATE\_CHANNEL\_STATE | 'update_channel_state' | | -| UPDATE\_CONTAINER\_CONFIG | 'update_container_config' | | -| UPDATE\_CONTAINER\_STATE | 'update_container_state' | | -| UPDATE\_LEAP\_TOKEN | 'update_leap_token' | | +| ADD\_DOMAIN | "add_domain" | | +| ADD\_MEMBER | "add_member" | | +| CREATE\_CHANNEL | "create_channel" | | +| CREATE\_CHANNEL\_TOKEN | "create_channel_token" | | +| CREATE\_CONTAINER | "create_container" | | +| CREATE\_DEPLOYMENT | "create_deployment" | | +| CREATE\_GATEWAY | "create_gateway" | | +| CREATE\_LEAP\_TOKEN | "create_leap_token" | | +| CREATE\_PROJECT\_SECRET | "create_project_secret" | | +| CREATE\_PROJECT\_TOKEN | "create_project_token" | | +| CREATE\_ROOM | "create_room" | | +| CREATE\_ROOM\_PRODUCER | "create_room_producer" | | +| DELETE\_CHANNELS | "delete_channels" | | +| DELETE\_CONTAINER | "delete_container" | | +| DELETE\_DEPLOYMENT | "delete_deployment" | | +| DELETE\_DOMAIN | "delete_domain" | | +| DELETE\_GATEWAY | "delete_gateway" | | +| DELETE\_PROJECT | "delete_project" | | +| DELETE\_PROJECT\_SECRET | "delete_project_secret" | | +| DELETE\_PROJECT\_TOKEN | "delete_project_token" | | +| DELETE\_REGISTRY\_IMAGES | "delete_registry_images" | | +| DELETE\_ROOM | "delete_room" | | +| GET\_INTERNAL\_DOMAIN | "get_internal_domain" | | +| GET\_PROJECT\_MEMBERS | "get_project_members" | | +| GET\_REGISTRY\_IMAGES | "get_registry_images" | | +| MANAGE\_CHANNEL\_SUBSCRIBERS | "manage_channel_subscribers" | | +| MESSAGE\_TOKEN | "message_token" | | +| PUBLISH\_CHANNEL\_MESSAGES | "publish_channel_messages" | | +| READ\_BILLING | "read_billing" | | +| READ\_CHANNELS | "read_channels" | | +| READ\_CONTAINER\_LOGS | "read_container_logs" | | +| READ\_DEPLOYMENTS | "read_deployments" | | +| READ\_GATEWAYS | "read_gateways" | | +| READ\_LEAP\_TOKENS | "read_leap_tokens" | | +| READ\_PROJECT\_SECRETS | "read_project_secrets" | | +| READ\_PROJECT\_TOKENS | "read_project_tokens" | | +| READ\_ROOM | "read_room" | | +| REMOVE\_MEMBER | "remove_member" | | +| REQUEST\_QUOTA\_INCREASE | "request_quota_increase" | | +| ROLLOUT | "rollout" | | +| UPDATE\_CHANNEL\_STATE | "update_channel_state" | | +| UPDATE\_CONTAINER\_CONFIG | "update_container_config" | | +| UPDATE\_CONTAINER\_STATE | "update_container_state" | | +| UPDATE\_LEAP\_TOKEN | "update_leap_token" | | diff --git a/docs/js.projects.md b/docs/js.projects.md index 6cadb993..2ed89fc8 100644 --- a/docs/js.projects.md +++ b/docs/js.projects.md @@ -1,11 +1,35 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Projects](./js.projects.md) +[Home](./index.md) > [@onehop/js](./js.md) > [projects](./js.projects.md) -## Projects namespace +## projects variable + +Projects SDK client Signature: ```typescript -declare namespace projects +projects: (client: APIClient) => { + getAllMembers(projectId?: Id<'project'>): Promise; + getCurrentMember(projectId: Id<'project'>): Promise; + projectTokens: { + delete(projectTokenId: Id<'ptkid'>, project?: Id<'project'>): Promise; + get(projectId?: Id<'project'>): Promise; + create(flags: number, projectId?: Id<'project'>): Promise; + }; + tokens: { + delete(projectTokenId: Id<'ptkid'>, project?: Id<'project'>): Promise; + get(projectId?: Id<'project'>): Promise; + create(flags: number, projectId?: Id<'project'>): Promise; + }; + secrets: { + getAll(projectId?: Id<'project'>): Promise; + create(name: string, value: string, projectId?: Id<'project'>): Promise; + delete(id: Id<'secret'> | Secret['name'], projectId?: Id<'project'>): Promise; + }; +} ``` diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md index 1f9abd15..12e88038 100644 --- a/docs/js.projectsendpoints.md +++ b/docs/js.projectsendpoints.md @@ -7,104 +7,37 @@ Signature: ```typescript -declare type ProjectsEndpoints = - | Endpoint< - 'DELETE', - '/v1/projects/:project_id/tokens/:project_token_id', - Empty - > - | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> - | Endpoint< - 'GET', - '/v1/projects/:project_id/members/@me', - { - project_member: Member; - } - > - | Endpoint< - 'GET', - '/v1/projects/:project_id/tokens', - { - project_tokens: ProjectToken[]; - } - > - | Endpoint< - 'GET', - '/v1/projects/@this/tokens', - { - project_tokens: ProjectToken[]; - } - > - | Endpoint< - 'GET', - '/v1/projects/:project_id/members', - { - members: Member[]; - } - > - | Endpoint< - 'GET', - '/v1/projects/@this/members', - { - members: Member[]; - } - > - | Endpoint< - 'POST', - '/v1/projects/:project_id/tokens', - { - project_token: ProjectToken & { - project: Project; - }; - }, - { - flags: number; - } - > - | Endpoint< - 'POST', - '/v1/projects/@this/tokens', - { - project_token: ProjectToken & { - project: Project; - }; - }, - { - flags: number; - } - > - | Endpoint< - 'PUT', - '/v1/projects/:project_id/secrets/:name', - { - secret: Secret; - }, - string - > - | Endpoint< - 'PUT', - '/v1/projects/@this/secrets/:name', - { - secret: Secret; - }, - string - > - | Endpoint< - 'GET', - '/v1/projects/:project_id/secrets', - { - secrets: Secret[]; - } - > - | Endpoint< - 'GET', - '/v1/projects/@this/secrets', - { - secrets: Secret[]; - } - > - | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> - | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; +declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', _Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', _Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { + project_member: Member; +}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/@this/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/:project_id/members', { + members: Member[]; +}> | Endpoint<'GET', '/v1/projects/@this/members', { + members: Member[]; +}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'POST', '/v1/projects/@this/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { + secrets: Secret[]; +}> | Endpoint<'GET', '/v1/projects/@this/secrets', { + secrets: Secret[]; +}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', _Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', _Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) +References: [Endpoint](./js.endpoint.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) diff --git a/docs/js.projecttier.md b/docs/js.projecttier.md index ddf175c0..0693bcce 100644 --- a/docs/js.projecttier.md +++ b/docs/js.projecttier.md @@ -14,6 +14,6 @@ declare enum ProjectTier | Member | Value | Description | | --- | --- | --- | -| FREE | 'free' | | -| PAID | 'paid' | | +| FREE | "free" | | +| PAID | "paid" | | diff --git a/docs/js.projecttype.md b/docs/js.projecttype.md index 7f2c7f47..abf51c1e 100644 --- a/docs/js.projecttype.md +++ b/docs/js.projecttype.md @@ -16,6 +16,6 @@ declare enum ProjectType | Member | Value | Description | | --- | --- | --- | -| PERSONAL | 'personal' | A personal project are created when you register an account | -| REGULAR | 'regular' | A standard project type | +| PERSONAL | "personal" | A personal project are created when you register an account | +| REGULAR | "regular" | A standard project type | diff --git a/docs/js.query.md b/docs/js.query.md index a48133b3..a53856a3 100644 --- a/docs/js.query.md +++ b/docs/js.query.md @@ -7,8 +7,5 @@ Signature: ```typescript -declare type Query = ExtractRouteParams & - Record; +declare type Query = _ExtractRouteParams & Record; ``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.regions.md b/docs/js.regions.md index db9c1f4b..a1cbc0e7 100644 --- a/docs/js.regions.md +++ b/docs/js.regions.md @@ -14,5 +14,5 @@ declare enum Regions | Member | Value | Description | | --- | --- | --- | -| US\_EAST\_1 | 'us-east-1' | | +| US\_EAST\_1 | "us-east-1" | | diff --git a/docs/js.registry.md b/docs/js.registry.md index 3df4f856..29343b1d 100644 --- a/docs/js.registry.md +++ b/docs/js.registry.md @@ -1,11 +1,26 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Registry](./js.registry.md) +[Home](./index.md) > [@onehop/js](./js.md) > [registry](./js.registry.md) -## Registry namespace +## registry variable + +Registry SDK client Signature: ```typescript -declare namespace registry +registry: (client: APIClient) => { + images: { + getAll(project?: Id<'project'>): Promise; + getManifest(image: string): Promise<{ + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]>; + delete(image: string): Promise; + }; +} ``` diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md index be45347b..96e2e7aa 100644 --- a/docs/js.registryendpoints.md +++ b/docs/js.registryendpoints.md @@ -7,29 +7,18 @@ Signature: ```typescript -declare type RegistryEndpoints = - | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> - | Endpoint< - 'GET', - '/v1/registry/images', - { - images: string[]; - } - > - | Endpoint< - 'GET', - '/v1/registry/images/:image/manifests', - { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; - } - >; +declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', _Empty> | Endpoint<'GET', '/v1/registry/images', { + images: string[]; +}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; +}>; ``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) +References: [Endpoint](./js.endpoint.md) diff --git a/docs/js.restartpolicy.md b/docs/js.restartpolicy.md index a8e0249e..fcfb286e 100644 --- a/docs/js.restartpolicy.md +++ b/docs/js.restartpolicy.md @@ -16,7 +16,7 @@ declare enum RestartPolicy | Member | Value | Description | | --- | --- | --- | -| ALWAYS | 'always' | | -| NEVER | 'never' | | -| ON\_FAILURE | 'on-failure' | | +| ALWAYS | "always" | | +| NEVER | "never" | | +| ON\_FAILURE | "on-failure" | | diff --git a/docs/js.roles.md b/docs/js.roles.md index be230eef..0e333d1c 100644 --- a/docs/js.roles.md +++ b/docs/js.roles.md @@ -4,13 +4,15 @@ ## roles variable +Bitwise role flags that a user can be as part of a project + Signature: ```typescript roles: { - viewer: bigint; - editor: bigint; - admin: bigint; - owner: bigint; + viewer: bigint; + editor: bigint; + admin: bigint; + owner: bigint; } ``` diff --git a/docs/js.rolloutstate.md b/docs/js.rolloutstate.md index b74ca88b..53d6720f 100644 --- a/docs/js.rolloutstate.md +++ b/docs/js.rolloutstate.md @@ -16,7 +16,7 @@ declare enum RolloutState | Member | Value | Description | | --- | --- | --- | -| FAILED | 'failed' | | -| FINISHED | 'finished' | | -| PENDING | 'pending' | | +| FAILED | "failed" | | +| FINISHED | "finished" | | +| PENDING | "pending" | | diff --git a/docs/js.runtimetype.md b/docs/js.runtimetype.md index 2739f040..d980ef63 100644 --- a/docs/js.runtimetype.md +++ b/docs/js.runtimetype.md @@ -16,7 +16,7 @@ declare enum RuntimeType | Member | Value | Description | | --- | --- | --- | -| EPHEMERAL | 'ephemeral' | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | -| PERSISTENT | 'persistent' | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | -| STATEFUL | 'stateful' | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | +| EPHEMERAL | "ephemeral" | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | +| PERSISTENT | "persistent" | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | +| STATEFUL | "stateful" | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | diff --git a/docs/js.setstateaction.md b/docs/js.setstateaction.md new file mode 100644 index 00000000..c55baf97 --- /dev/null +++ b/docs/js.setstateaction.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [SetStateAction](./js.setstateaction.md) + +## SetStateAction type + +New state to set to a channel, or a callback function that will produce the new state + +Signature: + +```typescript +declare type SetStateAction = T | ((oldState: T) => T | Promise); +``` +References: [State](./js.state.md) + diff --git a/docs/js.successfulapiresponse.md b/docs/js.successfulapiresponse.md index 9790e255..da2e0365 100644 --- a/docs/js.successfulapiresponse.md +++ b/docs/js.successfulapiresponse.md @@ -8,7 +8,7 @@ ```typescript declare type SuccessfulAPIResponse = { - success: true; - data: T; + success: true; + data: T; }; ``` diff --git a/docs/js.tag.md b/docs/js.tag.md index 541371d7..d2b1c96e 100644 --- a/docs/js.tag.md +++ b/docs/js.tag.md @@ -4,10 +4,12 @@ ## Tag type +Tag a type to make it unique + Signature: ```typescript declare type Tag = T & { - ___tag: Name; + ___tag: Name; }; ``` diff --git a/docs/js.timestamp.md b/docs/js.timestamp.md index bd3efe15..b9c0f9b8 100644 --- a/docs/js.timestamp.md +++ b/docs/js.timestamp.md @@ -4,7 +4,7 @@ ## Timestamp type -Hop's API uses ISO 8601 date strings +An ISO 8601 date strings Signature: diff --git a/docs/js.units.md b/docs/js.units.md index 689bd7cb..fed751ae 100644 --- a/docs/js.units.md +++ b/docs/js.units.md @@ -12,5 +12,5 @@ Signature: ```typescript -units: readonly ['GB', 'MB', 'KB', 'B'] +units: readonly ["GB", "MB", "KB", "B"] ``` diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md index 56fc4a34..15fb47a5 100644 --- a/docs/js.userendpoints.md +++ b/docs/js.userendpoints.md @@ -7,35 +7,18 @@ Signature: ```typescript -declare type UserEndpoints = - | Endpoint< - 'GET', - '/v1/users/@me', - { - projects: Project[]; - user: User; - project_member_role_map: Record, MemberRole>; - leap_token: string | null; - } - > - | Endpoint< - 'POST', - '/v1/users/@me/pats', - { - pat: PAT; - }, - { - name: string; - } - > - | Endpoint< - 'GET', - '/v1/users/@me/pats', - { - pats: PAT[]; - } - > - | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; +declare type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { + projects: Project[]; + user: User; + project_member_role_map: Record, MemberRole>; + leap_token: string | null; +}> | Endpoint<'POST', '/v1/users/@me/pats', { + pat: PAT; +}, { + name: string; +}> | Endpoint<'GET', '/v1/users/@me/pats', { + pats: PAT[]; +}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', _Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) +References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md) diff --git a/docs/js.users.md b/docs/js.users.md index 3c959755..46545e51 100644 --- a/docs/js.users.md +++ b/docs/js.users.md @@ -1,11 +1,27 @@ -[Home](./index.md) > [@onehop/js](./js.md) > [Users](./js.users.md) +[Home](./index.md) > [@onehop/js](./js.md) > [users](./js.users.md) -## Users namespace +## users variable + +Users SDK client Signature: ```typescript -declare namespace users +users: (client: APIClient) => { + me: { + get(): Promise<{ + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: Id<'pat'>): Promise; + }; + }; +} ``` diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md index 9ea07fd3..590180e5 100644 --- a/docs/js.validateapiauthentication.md +++ b/docs/js.validateapiauthentication.md @@ -7,9 +7,7 @@ Signature: ```typescript -declare function validateAPIAuthentication( - auth: string, -): auth is APIAuthenticationPrefix; +declare function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; ``` ## Parameters diff --git a/docs/js.validateid.md b/docs/js.validateid.md index d98493bb..96f355c5 100644 --- a/docs/js.validateid.md +++ b/docs/js.validateid.md @@ -9,22 +9,19 @@ Validates that a string is a valid ID Signature: ```typescript -declare function validateId( - maybeId: string, - prefix?: T | T[], -): maybeId is Id; +declare function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| maybeId | string | A string that might be an id | +| maybeId | string \| undefined \| null | A string that might be an id | | prefix | T \| T\[\] | (Optional) Optionally an id prefix to check against | Returns: maybeId is [Id](./js.id.md)<T> -- true if the string is an id +true if the string is an id diff --git a/docs/js.validateidprefix.md b/docs/js.validateidprefix.md index 1de947ad..59c6d9a0 100644 --- a/docs/js.validateidprefix.md +++ b/docs/js.validateidprefix.md @@ -9,10 +9,7 @@ Checks if a string is a valid Hop ID prefix Signature: ```typescript -declare function validateIdPrefix( - prefix: string, - expect?: T, -): prefix is T; +declare function validateIdPrefix(prefix: string, expect?: T): prefix is T; ``` ## Parameters diff --git a/docs/js.values.md b/docs/js.values.md deleted file mode 100644 index b8dbb26f..00000000 --- a/docs/js.values.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Values](./js.values.md) - -## Values type - -Signature: - -```typescript -declare type Values = T[keyof T]; -``` diff --git a/docs/js.vgputype.md b/docs/js.vgputype.md index 12a64f39..72d39dd5 100644 --- a/docs/js.vgputype.md +++ b/docs/js.vgputype.md @@ -16,5 +16,5 @@ declare enum VgpuType | Member | Value | Description | | --- | --- | --- | -| A400 | 'a400' | | +| A400 | "a400" | | diff --git a/docs/js.volumeformat.md b/docs/js.volumeformat.md index 60ee3644..829d1752 100644 --- a/docs/js.volumeformat.md +++ b/docs/js.volumeformat.md @@ -14,6 +14,6 @@ declare enum VolumeFormat | Member | Value | Description | | --- | --- | --- | -| EXT4 | 'ext4' | | -| XFS | 'xfs' | | +| EXT4 | "ext4" | | +| XFS | "xfs" | | diff --git a/package.json b/package.json index 7bfd9da0..8c12b795 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "vercel-build": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "docs": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", "test": "tsx tests/index.ts" }, "devDependencies": { diff --git a/src/index.ts b/src/index.ts index c23c55d6..04ebaf90 100644 --- a/src/index.ts +++ b/src/index.ts @@ -22,3 +22,5 @@ export type { GatewayType, DeliveryProtocol, } from './rest/index.js'; + +export * from './sdks/index.js'; diff --git a/src/permissions.ts b/src/permissions.ts index 28e8b4dd..6283c2fc 100644 --- a/src/permissions.ts +++ b/src/permissions.ts @@ -1,3 +1,7 @@ +/** + * A list of all permissions and their representative names + * @public + */ export enum PROJECT_PERMISSION { ADD_MEMBER = 'add_member', REMOVE_MEMBER = 'remove_member', @@ -45,6 +49,10 @@ export enum PROJECT_PERMISSION { DELETE_REGISTRY_IMAGES = 'delete_registry_images', } +/** + * Individual bitwise permissions + * @public + */ export const permissionsMap = { [PROJECT_PERMISSION.ADD_MEMBER]: 1n << 0n, [PROJECT_PERMISSION.REMOVE_MEMBER]: 1n << 1n, @@ -92,6 +100,10 @@ export const permissionsMap = { [PROJECT_PERMISSION.DELETE_REGISTRY_IMAGES]: 1n << 44n, }; +/** + * Broader permission map + * @public + */ export const BROAD_PERMISSIONS_MAP = { MANAGE_MEMBERS: permissionsMap.add_member | @@ -153,6 +165,10 @@ export const BROAD_PERMISSIONS_MAP = { MANAGE_BILLING: permissionsMap.read_billing, }; +/** + * Bitwise role flags that a user can be as part of a project + * @public + */ export const roles = { viewer: BROAD_PERMISSIONS_MAP.READ_ONLY, editor: @@ -185,6 +201,10 @@ export const roles = { BROAD_PERMISSIONS_MAP.MANAGE_BILLING, }; +/** + * Permission utility functions + * @public + */ export const permissions = { add(value: bigint, flag: bigint) { return BigInt(value) | BigInt(flag); diff --git a/src/rest/client.ts b/src/rest/client.ts index d41ea688..169ce183 100644 --- a/src/rest/client.ts +++ b/src/rest/client.ts @@ -1,9 +1,9 @@ import {fetch, Headers, Request} from '../util/fetch.js'; -import {ExtractRouteParams} from '../util/index.js'; +import {_ExtractRouteParams} from '../util/index.js'; import {IS_BROWSER} from '../util/constants.js'; import {createURLBuilder} from '../util/urls.js'; import {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.js'; -import {getIdPrefix, Id, Method} from './types/index.js'; +import {getIdPrefix, Id, _Method} from './types/index.js'; export type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; @@ -36,7 +36,7 @@ export class HopAPIError extends Error { } } -export type Query = ExtractRouteParams & +export type Query = _ExtractRouteParams & Record; export class APIClient { @@ -180,7 +180,7 @@ export class APIClient { } private async request( - method: Method, + method: _Method, path: string, body: unknown, query: Record = {}, diff --git a/src/rest/endpoints.ts b/src/rest/endpoints.ts index 0c21c90b..18152c0a 100644 --- a/src/rest/endpoints.ts +++ b/src/rest/endpoints.ts @@ -1,4 +1,4 @@ -import {Method} from './types/index.js'; +import {_Method} from './types/index.js'; import {ChannelEndpoints} from './types/channels.js'; import {IgniteEndpoints} from './types/ignite.js'; import {PipeEndpoints} from './types/pipe.js'; @@ -22,7 +22,7 @@ export type ErroredAPIResponse = { export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; export type Endpoint< - M extends Method, + M extends _Method, Path extends string, Res, Body = undefined, diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index eb106ffd..e040408a 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {Project} from './projects.js'; -import {Empty, Id, Timestamp} from '../../util/types.js'; +import {_Empty, Id, Timestamp} from '../../util/types.js'; export enum ChannelType { PRIVATE = 'private', @@ -83,23 +83,23 @@ export type ChannelEndpoints = {token: ChannelToken}, {state: State} > - | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> + | Endpoint<'DELETE', '/v1/channels/:channel_id', _Empty> | Endpoint<'GET', '/v1/channels/:channel_id', {channel: Channel}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', {tokens: ChannelToken[]}> | Endpoint< 'POST', '/v1/channels/tokens/:token/messages', - Empty, + _Empty, {e: string; d: unknown} > - | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> - | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> - | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> + | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', _Empty> + | Endpoint<'PATCH', '/v1/channels/:channel_id/state', _Empty, State> + | Endpoint<'PUT', '/v1/channels/:channel_id/state', _Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', {state: State}> | Endpoint< 'POST', '/v1/channels/:channel_id/messages', - Empty, + _Empty, {e: string; d: unknown} > | Endpoint<'GET', '/v1/channels', {channels: Channel[]}> @@ -110,7 +110,7 @@ export type ChannelEndpoints = {token: ChannelToken}, {expiresAt?: Timestamp | null; state: ChannelToken['state']} > - | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> + | Endpoint<'DELETE', '/v1/channels/tokens/:token', _Empty> | Endpoint< 'GET', '/v1/channels/:channel_id/stats', diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 4d45970d..e26e561e 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -1,7 +1,7 @@ import {ByteSizeString} from '../../util/index.js'; import {Endpoint} from '../endpoints.js'; import { - Empty, + _Empty, HopShDomain, Id, InternalHopDomain, @@ -213,6 +213,9 @@ export interface Deployment { active_build: Build | null; } +/** + * Metadata attached to a build + */ export interface BuildMetaData { /** * Account type of repo owner @@ -265,6 +268,9 @@ export interface BuildMetaData { commit_url?: string; } +/** + * A build entity + */ export interface Build { /** * ID of the build @@ -307,6 +313,9 @@ export interface Build { state: BuildState; } +/** + * A deployment rollout + */ export type DeploymentRollout = { /** * How many containers are being recreated @@ -339,8 +348,9 @@ export type DeploymentRollout = { build: Build | null; }; -// This is a type not an interface so we can make a union -// when future versions of deployment configs come out +/** + * A config for creating a deployment + */ export type DeploymentConfig = { /** * The name of the deployment @@ -654,8 +664,8 @@ export type IgniteEndpoints = {deployment: Deployment}, DeploymentConfig > - | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> - | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> + | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', _Empty> + | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', _Empty> | Endpoint< 'GET', '/v1/ignite/containers/:container_id/logs', @@ -670,7 +680,7 @@ export type IgniteEndpoints = | Endpoint< 'PUT', '/v1/ignite/containers/:container_id/state', - Empty, + _Empty, { /** * The state to update the container to @@ -681,7 +691,7 @@ export type IgniteEndpoints = | Endpoint< 'POST', '/v1/ignite/gateways/:gateway_id/domains', - Empty, + _Empty, {domain: string} > | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', {gateway: Gateway}> diff --git a/src/rest/types/pipe.ts b/src/rest/types/pipe.ts index 53ce3e27..4ea32025 100644 --- a/src/rest/types/pipe.ts +++ b/src/rest/types/pipe.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {Regions} from './ignite.js'; -import {Empty, Id, Timestamp} from '../../util/types.js'; +import {_Empty, Id, Timestamp} from '../../util/types.js'; export type DeliveryProtocol = 'webrtc' | 'hls'; @@ -78,4 +78,4 @@ export type PipeEndpoints = }; } > - | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; + | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', _Empty>; diff --git a/src/rest/types/projects.ts b/src/rest/types/projects.ts index b83295ef..7c6a4c14 100644 --- a/src/rest/types/projects.ts +++ b/src/rest/types/projects.ts @@ -1,5 +1,5 @@ import {Endpoint} from '../endpoints.js'; -import {Empty, Id, Timestamp} from '../../util/types.js'; +import {_Empty, Id, Timestamp} from '../../util/types.js'; import {User} from './users.js'; export type Member = Omit & { @@ -162,9 +162,9 @@ export type ProjectsEndpoints = | Endpoint< 'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', - Empty + _Empty > - | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> + | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', _Empty> | Endpoint< 'GET', '/v1/projects/:project_id/members/@me', @@ -208,5 +208,5 @@ export type ProjectsEndpoints = > | Endpoint<'GET', '/v1/projects/:project_id/secrets', {secrets: Secret[]}> | Endpoint<'GET', '/v1/projects/@this/secrets', {secrets: Secret[]}> - | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> - | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; + | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', _Empty> + | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', _Empty>; diff --git a/src/rest/types/registry.ts b/src/rest/types/registry.ts index ac4037ad..87822382 100644 --- a/src/rest/types/registry.ts +++ b/src/rest/types/registry.ts @@ -1,8 +1,8 @@ import {Endpoint} from '../endpoints.js'; -import {Empty} from '../../util/types.js'; +import {_Empty} from '../../util/types.js'; export type RegistryEndpoints = - | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> + | Endpoint<'DELETE', '/v1/registry/images/:image', _Empty> | Endpoint<'GET', '/v1/registry/images', {images: string[]}> | Endpoint< 'GET', diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index 31bcd5c4..cd894b51 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {MemberRole, Project} from './projects.js'; -import {Empty, Id, Timestamp} from '../../util/types.js'; +import {_Empty, Id, Timestamp} from '../../util/types.js'; /** * A user objct @@ -64,4 +64,4 @@ export type UserEndpoints = > | Endpoint<'POST', '/v1/users/@me/pats', {pat: PAT}, {name: string}> | Endpoint<'GET', '/v1/users/@me/pats', {pats: PAT[]}> - | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; + | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', _Empty>; diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index aa6fa40c..0b72fbf9 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -11,6 +11,10 @@ export type SetStateAction = | T | ((oldState: T) => T | Promise); +/** + * Channels SDK client + * @public + */ export const channels = sdk(client => { const Channels = create().methods({ async setState(state: SetStateAction) { @@ -67,9 +71,9 @@ export const channels = sdk(client => { /** * Creates a new channel * - * @param type The type of the channel to create - * @param id An ID to assign to the channel (optional, set this to `undefined` or `null` if you do not want to specify an ID) - * @param project A project ID (if necessary) to assign this to + * @param type - The type of the channel to create + * @param id - An ID to assign to the channel (optional, set this to `undefined` or `null` if you do not want to specify an ID) + * @param project - A project ID (if necessary) to assign this to */ async create( type: API.Channels.ChannelType, @@ -109,7 +113,7 @@ export const channels = sdk(client => { /** * Get all channels for a project * - * @param project An optional project ID if authenticating with a PAT or Bearer + * @param project - An optional project ID if authenticating with a PAT or Bearer */ async getAll(project?: Id<'project'>) { const {channels} = await client.get('/v1/channels', {project}); @@ -173,9 +177,9 @@ export const channels = sdk(client => { /** * Publishes a new event to a channel * - * @param channel The channel to publish to - * @param event The event name - * @param data The data for this event + * @param channel - The channel to publish to + * @param event - The event name + * @param data - The data for this event */ async publishMessage( channel: API.Channels.Channel | API.Channels.Channel['id'], @@ -215,8 +219,8 @@ export const channels = sdk(client => { /** * Creates a new channel token for a project * - * @param state The state to set on the token - * @param project The project to attach this token to + * @param state - The state to set on the token + * @param project - The project to attach this token to */ async create(state: API.Channels.State = {}, project?: Id<'project'>) { if (!project && client.authType !== 'ptk') { @@ -269,9 +273,9 @@ export const channels = sdk(client => { /** * Publishes a direct message to a single token - * @param token The token to publish a direct message to - * @param event The event name - * @param data The data for this event + * @param token - The token to publish a direct message to + * @param event - The event name + * @param data - The data for this event */ async publishDirectMessage( token: Id<'leap_token'>, diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 1c1648da..d4ea7bf1 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -1,4 +1,4 @@ -import {create, Infer} from '@onehop/json-methods'; +import {create, type Infer} from '@onehop/json-methods'; import {API, assertId, Id} from '../rest/index.js'; import { Deployment, @@ -12,6 +12,10 @@ import {sdk} from './create.js'; const SIX_MB_IN_BYTES = 6 * 1024 * 1024; +/** + * Ignite SDK client + * @public + */ export const ignite = sdk(client => { const Gateways = create().methods({ async addDomain(domain: string) { @@ -54,8 +58,8 @@ export const ignite = sdk(client => { * Creates a new deployment. * You should use this overload if you are authorizing with a bearer or pat. * - * @param configOrProject The project ID to create the deployment in. - * @param bearerOrPatConfig The deployment config to create. + * @param configOrProject - The project ID to create the deployment in. + * @param bearerOrPatConfig - The deployment config to create. */ async function createDeployment( configOrProject: Id<'project'>, @@ -66,7 +70,7 @@ export const ignite = sdk(client => { * Create a new deployment. You should use this overload if you are authorizing with a project token and * not with a bearer or pat. * - * @param configOrProject The config for this deployment. + * @param configOrProject - The config for this deployment. */ async function createDeployment( configOrProject: API.Ignite.DeploymentConfig, @@ -141,8 +145,8 @@ export const ignite = sdk(client => { /** * Gets a deployment by name * - * @param projectId The project ID. You only need to provide this if you are getting by name. - * @param name The deployment name to get + * @param projectId - The project ID. You only need to provide this if you are getting by name. + * @param name - The deployment name to get */ async function getDeployment( name: string, @@ -152,7 +156,7 @@ export const ignite = sdk(client => { /** * Gets a deployment by id * - * @param id The deployment ID + * @param id - The deployment ID */ async function getDeployment( id: Id<'deployment'>, @@ -190,8 +194,8 @@ export const ignite = sdk(client => { /** * Adds a domain to a gateway * - * @param gatewayId The ID of the gateway - * @param domain The full name of the domain + * @param gatewayId - The ID of the gateway + * @param domain - The full name of the domain */ async addDomain(gatewayId: Id<'gateway'>, domain: string) { await client.post( @@ -204,7 +208,7 @@ export const ignite = sdk(client => { /** * Fetches a gateway by ID * - * @param gatewayId The ID of the gateway to retrieve + * @param gatewayId - The ID of the gateway to retrieve */ async get(gatewayId: Id<'gateway'>) { const {gateway} = await client.get('/v1/ignite/gateways/:gateway_id', { @@ -234,7 +238,7 @@ export const ignite = sdk(client => { /** * Get all containers for a deployment * - * @param deployment The ID of the deployment to get + * @param deployment - The ID of the deployment to get * @returns A list of all containers for that project */ async getContainers(deployment: Id<'deployment'>) { @@ -249,7 +253,7 @@ export const ignite = sdk(client => { /** * Gets all deployments for a project * - * @param projectId The project ID to list deployments for. You only need to provide this if you are using bearer or PAT authentication. + * @param projectId - The project ID to list deployments for. You only need to provide this if you are using bearer or PAT authentication. * @returns A list of deployments for the given project. */ async getAll(projectId?: Id<'project'>) { @@ -276,7 +280,7 @@ export const ignite = sdk(client => { /** * Deletes a deployment * - * @param deployment The ID of the deployment + * @param deployment - The ID of the deployment */ async delete(deployment: Id<'deployment'>) { await client.delete( @@ -290,7 +294,7 @@ export const ignite = sdk(client => { /** * Fecthes all gateways attached to a deployment * - * @param deploymentId The ID of the deployment to fetch gateways for + * @param deploymentId - The ID of the deployment to fetch gateways for */ async getAll(deploymentId: Id<'deployment'>) { const {gateways} = await client.get( @@ -304,10 +308,10 @@ export const ignite = sdk(client => { /** * Creates and attaches a gateway to a deployment * - * @param deployment The deployment to create a gateway on - * @param type The type of the gatway to create, either internal or external - * @param protocol The protocol that the gateway will listen for - * @param targetPort The port to listen on + * @param deployment - The deployment to create a gateway on + * @param type - The type of the gatway to create, either internal or external + * @param protocol - The protocol that the gateway will listen for + * @param targetPort - The port to listen on */ async create( deployment: Deployment | Deployment['id'], @@ -333,7 +337,7 @@ export const ignite = sdk(client => { /** * Deletes a container * - * @param container The ID of the container to delete. + * @param container - The ID of the container to delete. */ async delete(container: Id<'container'>) { await client.delete('/v1/ignite/containers/:container_id', undefined, { @@ -344,7 +348,7 @@ export const ignite = sdk(client => { /** * Get the logs for a container * - * @param container The ID of the container + * @param container - The ID of the container * @returns */ async getLogs( @@ -364,6 +368,10 @@ export const ignite = sdk(client => { return logs; }, + /** + * Stop a container + * @param container - The ID of the container + */ async stop(container: Id<'container'>) { await updateContainerState( container, @@ -371,6 +379,10 @@ export const ignite = sdk(client => { ); }, + /** + * Start a container + * @param container - The ID of the container + */ async start(container: Id<'container'>) { await updateContainerState( container, @@ -381,7 +393,7 @@ export const ignite = sdk(client => { /** * Creates a container * - * @param deployment The ID of a deployment to create a container in. + * @param deployment - The ID of a deployment to create a container in. * @returns The newly created container. */ async create(deployment: Id<'deployment'>) { diff --git a/src/sdks/index.ts b/src/sdks/index.ts index b64868ce..732a02e5 100644 --- a/src/sdks/index.ts +++ b/src/sdks/index.ts @@ -1,4 +1,4 @@ -export {channels} from './channels.js'; +export {channels, type SetStateAction} from './channels.js'; export {ignite} from './ignite.js'; export {pipe} from './pipe.js'; export {projects} from './projects.js'; diff --git a/src/sdks/pipe.ts b/src/sdks/pipe.ts index 882052e4..53177798 100644 --- a/src/sdks/pipe.ts +++ b/src/sdks/pipe.ts @@ -4,6 +4,10 @@ import {Regions} from '../rest/types/ignite.js'; import {DeliveryProtocol} from '../rest/types/pipe.js'; import {sdk} from './create.js'; +/** + * Pipe SDK client + * @public + */ export const pipe = sdk(client => { const Rooms = create().methods({ async delete() { @@ -60,7 +64,7 @@ export const pipe = sdk(client => { /** * Deletes a Pipe room * - * @param room The ID of the Pipe room to delete. + * @param room - The ID of the Pipe room to delete. */ async delete(room: Id<'pipe_room'>) { await client.delete('/v1/pipe/rooms/:room_id', undefined, { diff --git a/src/sdks/projects.ts b/src/sdks/projects.ts index 97acca79..9087d908 100644 --- a/src/sdks/projects.ts +++ b/src/sdks/projects.ts @@ -2,12 +2,16 @@ import {API, Endpoints, Id} from '../rest/index.js'; import {sdk} from './create.js'; import {Request} from '../util/fetch.js'; +/** + * Projects SDK client + * @public + */ export const projects = sdk(client => { const tokens = { /** * Deletes a project token by its ID * - * @param projectTokenId The ID of the project token to delete + * @param projectTokenId - The ID of the project token to delete */ async delete(projectTokenId: Id<'ptkid'>, project?: Id<'project'>) { if (client.authType !== 'ptk' && !project) { @@ -30,7 +34,7 @@ export const projects = sdk(client => { /** * Get all project tokens for a project * - * @param projectId The project to fetch secrets for + * @param projectId - The project to fetch secrets for * @returns An array of all secrets for the project */ async get(projectId?: Id<'project'>) { @@ -60,8 +64,8 @@ export const projects = sdk(client => { /** * Creates a new project token * - * @param projectId The project to create a key for - * @param flags Permissions for this flag + * @param projectId - The project to create a key for + * @param flags - Permissions for this flag * @returns A newly created project token */ async create(flags: number, projectId?: Id<'project'>) { @@ -116,7 +120,7 @@ export const projects = sdk(client => { * Fetch the currently authorized member from a project. * You cannot use this route if you are authorizing with a project token as there is no user attached to it. * - * @param projectId The project ID to fetch a member from + * @param projectId - The project ID to fetch a member from * @returns The member authorized by the SDK */ async getCurrentMember(projectId: Id<'project'>) { @@ -145,7 +149,7 @@ export const projects = sdk(client => { /** * Gets all secrets in a project * - * @param projectId The project to fetch secrets for + * @param projectId - The project to fetch secrets for */ async getAll(projectId?: Id<'project'>) { if (client.authType !== 'ptk' && !projectId) { @@ -170,9 +174,9 @@ export const projects = sdk(client => { /** * Creates a new project secret * - * @param name The name of the secret - * @param value The value of the secret - * @param projectId The project to create the secret in + * @param name - The name of the secret + * @param value - The value of the secret + * @param projectId - The project to create the secret in */ async create(name: string, value: string, projectId?: Id<'project'>) { if (client.authType !== 'ptk' && !projectId) { @@ -207,8 +211,8 @@ export const projects = sdk(client => { /** * Deletes a secret from a project * - * @param id The secret ID to delete - * @param projectId The project to delete the secret from + * @param id - The secret ID to delete + * @param projectId - The project to delete the secret from */ async delete( id: Id<'secret'> | API.Projects.Secret['name'], diff --git a/src/sdks/registry.ts b/src/sdks/registry.ts index e0c55dd2..5780783e 100644 --- a/src/sdks/registry.ts +++ b/src/sdks/registry.ts @@ -1,6 +1,10 @@ import {Id} from '../rest/index.js'; import {sdk} from './create.js'; +/** + * Registry SDK client + * @public + */ export const registry = sdk(client => { return { images: { diff --git a/src/sdks/users.ts b/src/sdks/users.ts index 5559d458..e45fb96c 100644 --- a/src/sdks/users.ts +++ b/src/sdks/users.ts @@ -1,6 +1,10 @@ import {Id} from '../util/types.js'; import {sdk} from './create.js'; +/** + * Users SDK client + * @public + */ export const users = sdk(client => ({ me: { /** @@ -58,7 +62,7 @@ export const users = sdk(client => ({ /** * Deletes a pat * - * @param id The ID of the pat to delete + * @param id - The ID of the pat to delete */ async delete(id: Id<'pat'>) { if (client.authType === 'ptk') { diff --git a/src/util/size.ts b/src/util/size.ts index 74b02f89..9728ec51 100644 --- a/src/util/size.ts +++ b/src/util/size.ts @@ -28,7 +28,7 @@ const multipliers: Record = { /** * Parses a byte size string into bytes - * @param size The size of anything in gigabytes, megabytes, kilobytes or bytes + * @param size - The size of anything in gigabytes, megabytes, kilobytes or bytes */ export function parseSize(size: string) { size = size.toUpperCase(); diff --git a/src/util/types.ts b/src/util/types.ts index 288b394a..e0a49e86 100644 --- a/src/util/types.ts +++ b/src/util/types.ts @@ -1,9 +1,21 @@ import {formatList} from './lists.js'; -export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +/** + * All methods the Hop API accepts + * @internal + */ +export type _Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; -export type Empty = void; +/** + * An empty response type + * @internal + */ +export type _Empty = void; +/** + * Tag a type to make it unique + * @public + */ export type Tag = T & { /** * Mark a type as having a specific name in the API @@ -13,20 +25,36 @@ export type Tag = T & { }; /** - * Hop's API uses ISO 8601 date strings + * An ISO 8601 date strings + * @public */ export type Timestamp = Tag; -export type ExtractRouteParams = string extends T +/** + * Creates a record of params required for a given URL/path + * @internal + */ +export type _ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` - ? {[k in Param | keyof ExtractRouteParams]: string | number} + ? {[k in Param | keyof _ExtractRouteParams]: string | number} : T extends `${string}:${infer Param}` ? {[k in Param]: string | number} : {}; -export type Values = T[keyof T]; +/** + * Pull values of an object + * @internal + */ +export type _Values = T[keyof T]; +// Technically, `channel`, it should be here, but channel IDs can also +// be any random string if a developer decides to set it. For this reason, +// channel is not included as a valid ID in this list +/** + * An array of all IDs that can be used in the API + * @public + */ export const ID_PREFIXES = [ { prefix: 'user', @@ -76,13 +104,6 @@ export const ID_PREFIXES = [ prefix: 'ptkid', description: 'Project token ID', }, - // Technically, yes, it should be here, but channel IDs can also - // be any random string if a developer decides to set it - // themselves. So I'll leave it commented for now.. - // { - // prefix: 'channel', - // description: 'Channel', - // }, { prefix: 'secret', description: 'Project secret ID', @@ -109,15 +130,41 @@ export const ID_PREFIXES = [ }, ] as const; +/** + * A union of all ID prefixes used within the API + * @public + */ export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; + +/** + * A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. + * It is a Pika ID — https://github.com/hopinc/pika + * @public + */ export type Id = `${T}_${string}`; + +/** + * A hop.sh domain (*.hop.sh) + * @public + */ export type HopShDomain = `${string}.hop.sh`; + +/** + * A domain used with internal gateways (*.hop.sh) + * @public + */ export type InternalHopDomain = `${string}.hop`; + +/** + * Any/all IDs that are used within the API + * @public + */ export type AnyId = Id; /** * Checks if a string is a valid Hop ID prefix * + * @public * @param prefix - A string that is a potential prefix * @param expect - An expected prefix to check against * @returns - Whether the prefix is valid @@ -139,16 +186,20 @@ export function validateIdPrefix( * @public * @param maybeId - A string that might be an id * @param prefix - Optionally an id prefix to check against - * @returns - true if the string is an id + * @returns true if the string is an id */ export function validateId( - maybeId: string, + maybeId: string | undefined | null, prefix?: T | T[], ): maybeId is Id { if (Array.isArray(prefix)) { return prefix.some(p => validateId(maybeId, p)); } + if (!maybeId) { + return false; + } + if (!prefix) { return ID_PREFIXES.some(({prefix}) => maybeId.startsWith(`${prefix}_`)); } @@ -156,6 +207,14 @@ export function validateId( return maybeId.startsWith(`${prefix}_`); } +/** + * Gets the prefix of an ID + * + * @public + * @param id - A full ID to extract the prefix from + * @param expect - An expected prefix to check against + * @returns - The prefix of the ID + */ export function getIdPrefix(id: string, expect?: T) { if (expect && !validateId(id, expect)) { throw new Error(`Expected ${id} to be an id of type ${expect}`); @@ -184,7 +243,7 @@ export function getIdPrefix(id: string, expect?: T) { * @returns - The ID cast to the correct type */ export function id( - maybeId?: string, + maybeId: string | undefined | null, prefix?: T | T[], ): Id { assertId(maybeId, prefix); @@ -199,7 +258,7 @@ export function id( * @param message - An error message to throw if the ID is invalid */ export function assertId( - maybeId?: string, + maybeId: string | undefined | null, prefix?: T | T[], message?: string, ): asserts maybeId is Id { diff --git a/src/util/urls.ts b/src/util/urls.ts index 2ec5e362..3b9c6995 100644 --- a/src/util/urls.ts +++ b/src/util/urls.ts @@ -1,4 +1,4 @@ -import {ExtractRouteParams, Query} from '../rest/index.js'; +import {_ExtractRouteParams, Query} from '../rest/index.js'; export function lead(x: string) { return x.charCodeAt(0) === 47 ? x : '/' + x; @@ -18,7 +18,8 @@ export function join(a: string, b: string) { /** * Generates a querystring to append to a URL. This function will include the ? character. - * @param query An object of query params to be encoded + * @param query - An object of query params to be encoded + * @public * @returns A string of query params */ export function querystring(query: Query): string { @@ -62,7 +63,7 @@ export function createURLBuilder(base: string) { if (param in query) { const {[param]: value, ...rest} = query; - query = rest as ExtractRouteParams; + query = rest as _ExtractRouteParams; if (value === undefined) { throw new Error(`URL param ${param} is undefined`); diff --git a/src/utils/zod/ids.ts b/src/utils/zod/ids.ts index b11d00b7..38e77f6d 100644 --- a/src/utils/zod/ids.ts +++ b/src/utils/zod/ids.ts @@ -3,8 +3,9 @@ import {Id, IdPrefixes, validateId} from '../../rest/index.js'; /** * Generate a Zod schema for an ID prefix - * @param prefix Prefix of the ID + * @param prefix - Prefix of the ID * @returns A Zod schema that resolve to a valid ID + * @public * * @example * ```ts From cc03d987c687681b7455c2432f2beb5524a53aec Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 12:35:09 +0100 Subject: [PATCH 06/33] checkpoint --- docs/js.channels.md | 16 ++++++++-------- docs/js.hop.md | 2 +- docs/js.md | 4 ++-- docs/js.partialapioptions.md | 2 ++ package.json | 2 +- src/hop.ts | 9 ++++++++- src/sdks/channels.ts | 10 ++++------ tsconfig.json | 4 +++- 8 files changed, 29 insertions(+), 20 deletions(-) diff --git a/docs/js.channels.md b/docs/js.channels.md index cd90aaf0..70a68342 100644 --- a/docs/js.channels.md +++ b/docs/js.channels.md @@ -15,26 +15,26 @@ channels: (client: APIClient) => { } | null | undefined, project?: Id<'project'>): Promise(state: SetStateAction): Promise; patchState(state: SetStateAction): Promise; - subscribeToken(token: Token): Promise; - subscribeTokens(tokens: Token[] | Set): Promise; + subscribeToken(token: Id<'leap_token'>): Promise; + subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; publishMessage(name: string, data: unknown): Promise; }>; get(id: string): Promise(state: SetStateAction): Promise; patchState(state: SetStateAction): Promise; - subscribeToken(token: Token): Promise; - subscribeTokens(tokens: Token[] | Set): Promise; + subscribeToken(token: Id<'leap_token'>): Promise; + subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; publishMessage(name: string, data: unknown): Promise; }>; getAll(project?: Id<'project'>): Promise<(Channel & { setState(state: SetStateAction): Promise; patchState(state: SetStateAction): Promise; - subscribeToken(token: Token): Promise; - subscribeTokens(tokens: Token[] | Set): Promise; + subscribeToken(token: Id<'leap_token'>): Promise; + subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; publishMessage(name: string, data: unknown): Promise; })[]>; - subscribeToken(channel: string | Channel, token: Token): Promise; - subscribeTokens(channel: string | Channel, tokens: Token[] | Set): Promise; + subscribeToken(channel: string | Channel, token: Id<'leap_token'>): Promise; + subscribeTokens(channel: string | Channel, tokens: Id<'leap_token'>[] | Set>): Promise; getAllTokens(channel: string | Channel): Promise; setState(channel: string | Channel, state: SetStateAction): Promise; patchState(channel: string | Channel, state: SetStateAction): Promise; diff --git a/docs/js.hop.md b/docs/js.hop.md index aaa79671..67a5554b 100644 --- a/docs/js.hop.md +++ b/docs/js.hop.md @@ -4,7 +4,7 @@ ## Hop class -Constructs a new instance of Hop and all of its SDKs. +Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK. Signature: diff --git a/docs/js.md b/docs/js.md index 44107b02..bb6c71ba 100644 --- a/docs/js.md +++ b/docs/js.md @@ -9,7 +9,7 @@ | Class | Description | | --- | --- | | [APIClient](./js.apiclient.md) | | -| [Hop](./js.hop.md) | Constructs a new instance of Hop and all of its SDKs. | +| [Hop](./js.hop.md) | Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK. | | [HopAPIError](./js.hopapierror.md) | | ## Enumerations @@ -134,7 +134,7 @@ | [IgniteEndpoints](./js.igniteendpoints.md) | | | [InternalHopDomain](./js.internalhopdomain.md) | A domain used with internal gateways (\*.hop.sh) | | [Member](./js.member.md) | | -| [PartialAPIOptions](./js.partialapioptions.md) | | +| [PartialAPIOptions](./js.partialapioptions.md) | Partial options for the Hop client | | [PipeEndpoints](./js.pipeendpoints.md) | | | [ProjectsEndpoints](./js.projectsendpoints.md) | | | [Query](./js.query.md) | | diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md index 27242ba4..d4a2f249 100644 --- a/docs/js.partialapioptions.md +++ b/docs/js.partialapioptions.md @@ -4,6 +4,8 @@ ## PartialAPIOptions type +Partial options for the Hop client + Signature: ```typescript diff --git a/package.json b/package.json index 8c12b795..5e20b583 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "docs": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "docs": "yarn tsc && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", "test": "tsx tests/index.ts" }, "devDependencies": { diff --git a/src/hop.ts b/src/hop.ts index 22da4f7d..75c012ab 100644 --- a/src/hop.ts +++ b/src/hop.ts @@ -9,13 +9,20 @@ import { } from './sdks/index.js'; import {DEFAULT_BASE_URL} from './util/constants.js'; +/** + * Partial options for the Hop client + * @public + */ export type PartialAPIOptions = Partial< Omit > & Pick; /** - * Constructs a new instance of Hop and all of its SDKs. + * Root class containing all methods and types for interacting with the Hop platform. + * This will be the entrypoint for most users of the Hop SDK. + * + * @public * * @example * ```ts diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index 0b72fbf9..522f824d 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -2,8 +2,6 @@ import {create} from '@onehop/json-methods'; import {API, Id} from '../rest/index.js'; import {sdk} from './create.js'; -type Token = Id<'leap_token'>; - /** * New state to set to a channel, or a callback function that will produce the new state */ @@ -25,11 +23,11 @@ export const channels = sdk(client => { await updateState(this.id, state, 'patch'); }, - async subscribeToken(token: Token) { + async subscribeToken(token: Id<'leap_token'>) { await channelsSDK.subscribeToken(this.id, token); }, - async subscribeTokens(tokens: Token[] | Set) { + async subscribeTokens(tokens: Id<'leap_token'>[] | Set>) { await channelsSDK.subscribeTokens(this.id, tokens); }, @@ -122,7 +120,7 @@ export const channels = sdk(client => { async subscribeToken( channel: API.Channels.Channel | API.Channels.Channel['id'], - token: Token, + token: Id<'leap_token'>, ) { const id = typeof channel === 'object' ? channel.id : channel; @@ -135,7 +133,7 @@ export const channels = sdk(client => { async subscribeTokens( channel: API.Channels.Channel | API.Channels.Channel['id'], - tokens: Token[] | Set, + tokens: Id<'leap_token'>[] | Set>, ) { const promises: Array> = []; diff --git a/tsconfig.json b/tsconfig.json index 3ed54adc..6d51ec18 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,7 +13,9 @@ "isolatedModules": true, "noFallthroughCasesInSwitch": true, "declaration": true, - "declarationMap": true + "declarationMap": true, + "noEmit": true, + "rootDir": ".temp" }, "exclude": ["node_modules", "dist"], "include": ["./**/*.ts", "./**/*.tsx", "gen-docs.mts"] From e68e8e39621dedd02beb37c42ba6fc83f1c2ae3b Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 17 Oct 2022 18:25:30 +0100 Subject: [PATCH 07/33] add more package api jsdocs --- docs/js.apiauthentication.md | 2 ++ docs/js.apiauthenticationprefix.md | 2 ++ docs/js.apiclient.md | 2 ++ docs/js.apiclientoptions.md | 2 ++ docs/js.channelendpoints.md | 12 ++++----- docs/js.empty.md | 13 +++++++++ docs/js.endpoint.md | 4 ++- docs/js.extractrouteparams.md | 19 +++++++++++++ docs/js.hopapierror.md | 2 ++ docs/js.igniteendpoints.md | 8 +++--- docs/js.md | 19 +++++++------ docs/js.method.md | 13 +++++++++ docs/js.pipeendpoints.md | 4 +-- docs/js.projectsendpoints.md | 6 ++--- docs/js.query.md | 6 ++++- docs/js.registryendpoints.md | 4 +-- docs/js.supports_intl.md | 2 ++ docs/js.userendpoints.md | 4 +-- docs/js.validateapiauthentication.md | 6 ++++- package.json | 2 +- src/rest/client.ts | 40 +++++++++++++++++++++++++--- src/rest/endpoints.ts | 4 +-- src/rest/types/channels.ts | 16 +++++------ src/rest/types/ignite.ts | 10 +++---- src/rest/types/index.ts | 5 ++++ src/rest/types/pipe.ts | 4 +-- src/rest/types/projects.ts | 10 +++---- src/rest/types/registry.ts | 4 +-- src/rest/types/users.ts | 4 +-- src/sdks/channels.ts | 1 + src/util/constants.ts | 6 +++++ src/util/types.ts | 14 +++++----- src/util/urls.ts | 4 +-- tsconfig.json | 4 +-- 34 files changed, 185 insertions(+), 73 deletions(-) create mode 100644 docs/js.empty.md create mode 100644 docs/js.extractrouteparams.md create mode 100644 docs/js.method.md diff --git a/docs/js.apiauthentication.md b/docs/js.apiauthentication.md index d900aec7..a146ff9c 100644 --- a/docs/js.apiauthentication.md +++ b/docs/js.apiauthentication.md @@ -4,6 +4,8 @@ ## APIAuthentication type +All possible authentication ID types + Signature: ```typescript diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md index 4c37a0f7..e0fa9370 100644 --- a/docs/js.apiauthenticationprefix.md +++ b/docs/js.apiauthenticationprefix.md @@ -4,6 +4,8 @@ ## APIAuthenticationPrefix type +A valid ID prefix supported by the Hop API for authetication + Signature: ```typescript diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md index ae2b398d..8af0e5a4 100644 --- a/docs/js.apiclient.md +++ b/docs/js.apiclient.md @@ -4,6 +4,8 @@ ## APIClient class +API Client that is responsible for handling all requests + Signature: ```typescript diff --git a/docs/js.apiclientoptions.md b/docs/js.apiclientoptions.md index 708447b2..16e9f3fa 100644 --- a/docs/js.apiclientoptions.md +++ b/docs/js.apiclientoptions.md @@ -4,6 +4,8 @@ ## APIClientOptions interface +Options passed to the API client. This will usually come from Hop\#constructor in most cases + Signature: ```typescript diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md index cb2ffde1..a8b9f4b7 100644 --- a/docs/js.channelendpoints.md +++ b/docs/js.channelendpoints.md @@ -21,16 +21,16 @@ declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { token: ChannelToken; }, { state: State; -}> | Endpoint<'DELETE', '/v1/channels/:channel_id', _Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { +}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { channel: Channel; }> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { tokens: ChannelToken[]; -}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', _Empty, { +}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { e: string; d: unknown; -}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', _Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', _Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', _Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { +}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { state: State; -}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', _Empty, { +}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { e: string; d: unknown; }> | Endpoint<'GET', '/v1/channels', { @@ -42,11 +42,11 @@ declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { }, { expiresAt?: Timestamp | null; state: ChannelToken['state']; -}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', _Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { +}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { stats: { online_count: number; }; }>; ``` -References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Timestamp](./js.timestamp.md) +References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) diff --git a/docs/js.empty.md b/docs/js.empty.md new file mode 100644 index 00000000..3750e6f8 --- /dev/null +++ b/docs/js.empty.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) + +## Empty type + +An empty response type + +Signature: + +```typescript +declare type Empty = void; +``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md index f90a0df2..1e66a431 100644 --- a/docs/js.endpoint.md +++ b/docs/js.endpoint.md @@ -7,10 +7,12 @@ Signature: ```typescript -declare type Endpoint = { +declare type Endpoint = { method: M; path: Path; res: Res; body: Body; }; ``` +References: [Method](./js.method.md) + diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md new file mode 100644 index 00000000..22d8b537 --- /dev/null +++ b/docs/js.extractrouteparams.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) + +## ExtractRouteParams type + +Creates a record of params required for a given URL/path + +Signature: + +```typescript +declare type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { + [k in Param | keyof ExtractRouteParams]: string | number; +} : T extends `${string}:${infer Param}` ? { + [k in Param]: string | number; +} : {}; +``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.hopapierror.md b/docs/js.hopapierror.md index fe8da293..dc5c6389 100644 --- a/docs/js.hopapierror.md +++ b/docs/js.hopapierror.md @@ -4,6 +4,8 @@ ## HopAPIError class +An error that occurred as a response from the Hop API. + Signature: ```typescript diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md index 392ba8f7..bc5d4138 100644 --- a/docs/js.igniteendpoints.md +++ b/docs/js.igniteendpoints.md @@ -18,15 +18,15 @@ declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { container_id: Id<'container'>; }> | Endpoint<'POST', '/v1/ignite/deployments', { deployment: Deployment; -}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', _Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', _Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { +}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { logs: ContainerLog[]; }> | Endpoint<'GET', '/v1/ignite/deployments/search', { deployment: Deployment; }> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { deployment: Deployment; -}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', _Empty, { +}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; -}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', _Empty, { +}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { domain: string; }> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { gateway: Gateway; @@ -42,5 +42,5 @@ declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { deployment: Deployment; }, DeploymentConfig>; ``` -References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) +References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) diff --git a/docs/js.md b/docs/js.md index bb6c71ba..5cd8749a 100644 --- a/docs/js.md +++ b/docs/js.md @@ -8,9 +8,9 @@ | Class | Description | | --- | --- | -| [APIClient](./js.apiclient.md) | | +| [APIClient](./js.apiclient.md) | API Client that is responsible for handling all requests | | [Hop](./js.hop.md) | Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK. | -| [HopAPIError](./js.hopapierror.md) | | +| [HopAPIError](./js.hopapierror.md) | An error that occurred as a response from the Hop API. | ## Enumerations @@ -41,7 +41,7 @@ | [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | | [isValidByteString(value)](./js.isvalidbytestring.md) | | | [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | -| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | | +| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | Validates that an authentication prefix is valid | | [validateId(maybeId, prefix)](./js.validateid.md) | Validates that a string is a valid ID | | [validateIdPrefix(prefix, expect)](./js.validateidprefix.md) | Checks if a string is a valid Hop ID prefix | @@ -49,7 +49,7 @@ | Interface | Description | | --- | --- | -| [APIClientOptions](./js.apiclientoptions.md) | | +| [APIClientOptions](./js.apiclientoptions.md) | Options passed to the API client. This will usually come from Hop\#constructor in most cases | | [Auth](./js.auth.md) | Docker image registry authorization | | [Build](./js.build.md) | A build entity | | [BuildMetaData](./js.buildmetadata.md) | Metadata attached to a build | @@ -106,7 +106,7 @@ | [projects](./js.projects.md) | Projects SDK client | | [registry](./js.registry.md) | Registry SDK client | | [roles](./js.roles.md) | Bitwise role flags that a user can be as part of a project | -| [SUPPORTS\_INTL](./js.supports_intl.md) | | +| [SUPPORTS\_INTL](./js.supports_intl.md) | If this runtiem supports the Intl API | | [units](./js.units.md) | | | [users](./js.users.md) | Users SDK client | @@ -115,8 +115,8 @@ | Type Alias | Description | | --- | --- | | [AnyId](./js.anyid.md) | Any/all IDs that are used within the API | -| [APIAuthentication](./js.apiauthentication.md) | | -| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | | +| [APIAuthentication](./js.apiauthentication.md) | All possible authentication ID types | +| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | A valid ID prefix supported by the Hop API for authetication | | [APIResponse](./js.apiresponse.md) | | | [ByteSizeString](./js.bytesizestring.md) | | | [ByteString](./js.bytestring.md) | | @@ -125,19 +125,22 @@ | [DeliveryProtocol](./js.deliveryprotocol.md) | | | [DeploymentConfig](./js.deploymentconfig.md) | A config for creating a deployment | | [DeploymentRollout](./js.deploymentrollout.md) | A deployment rollout | +| [Empty](./js.empty.md) | An empty response type | | [Endpoint](./js.endpoint.md) | | | [Endpoints](./js.endpoints.md) | | | [ErroredAPIResponse](./js.erroredapiresponse.md) | | +| [ExtractRouteParams](./js.extractrouteparams.md) | Creates a record of params required for a given URL/path | | [HopShDomain](./js.hopshdomain.md) | A hop.sh domain (\*.hop.sh) | | [Id](./js.id.md) | A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika | | [IdPrefixes](./js.idprefixes.md) | A union of all ID prefixes used within the API | | [IgniteEndpoints](./js.igniteendpoints.md) | | | [InternalHopDomain](./js.internalhopdomain.md) | A domain used with internal gateways (\*.hop.sh) | | [Member](./js.member.md) | | +| [Method](./js.method.md) | All methods the Hop API accepts | | [PartialAPIOptions](./js.partialapioptions.md) | Partial options for the Hop client | | [PipeEndpoints](./js.pipeendpoints.md) | | | [ProjectsEndpoints](./js.projectsendpoints.md) | | -| [Query](./js.query.md) | | +| [Query](./js.query.md) | Generate a query object that includes typed URL params | | [RegistryEndpoints](./js.registryendpoints.md) | | | [SetStateAction](./js.setstateaction.md) | New state to set to a channel, or a callback function that will produce the new state | | [State](./js.state.md) | | diff --git a/docs/js.method.md b/docs/js.method.md new file mode 100644 index 00000000..f49cb65b --- /dev/null +++ b/docs/js.method.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) + +## Method type + +All methods the Hop API accepts + +Signature: + +```typescript +declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md index 50eb01b9..5d8178ef 100644 --- a/docs/js.pipeendpoints.md +++ b/docs/js.pipeendpoints.md @@ -22,7 +22,7 @@ declare type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { artificial_delay: number; max_playout_bitrate_preset: string; }; -}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', _Empty>; +}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md) +References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md index 12e88038..e666e15c 100644 --- a/docs/js.projectsendpoints.md +++ b/docs/js.projectsendpoints.md @@ -7,7 +7,7 @@ Signature: ```typescript -declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', _Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', _Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { +declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { project_member: Member; }> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { project_tokens: ProjectToken[]; @@ -37,7 +37,7 @@ declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/to secrets: Secret[]; }> | Endpoint<'GET', '/v1/projects/@this/secrets', { secrets: Secret[]; -}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', _Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', _Empty>; +}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) diff --git a/docs/js.query.md b/docs/js.query.md index a53856a3..56b258ce 100644 --- a/docs/js.query.md +++ b/docs/js.query.md @@ -4,8 +4,12 @@ ## Query type +Generate a query object that includes typed URL params + Signature: ```typescript -declare type Query = _ExtractRouteParams & Record; +declare type Query = ExtractRouteParams & Record; ``` +References: [ExtractRouteParams](./js.extractrouteparams.md) + diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md index 96e2e7aa..b924f713 100644 --- a/docs/js.registryendpoints.md +++ b/docs/js.registryendpoints.md @@ -7,7 +7,7 @@ Signature: ```typescript -declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', _Empty> | Endpoint<'GET', '/v1/registry/images', { +declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { images: string[]; }> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { manifests: { @@ -20,5 +20,5 @@ declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image' }[]; }>; ``` -References: [Endpoint](./js.endpoint.md) +References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) diff --git a/docs/js.supports_intl.md b/docs/js.supports_intl.md index abcbc5d0..38e7325b 100644 --- a/docs/js.supports_intl.md +++ b/docs/js.supports_intl.md @@ -4,6 +4,8 @@ ## SUPPORTS\_INTL variable +If this runtiem supports the Intl API + Signature: ```typescript diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md index 15fb47a5..c9a3effc 100644 --- a/docs/js.userendpoints.md +++ b/docs/js.userendpoints.md @@ -18,7 +18,7 @@ declare type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { name: string; }> | Endpoint<'GET', '/v1/users/@me/pats', { pats: PAT[]; -}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', _Empty>; +}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; ``` -References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md) +References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md index 590180e5..cfbf7dc1 100644 --- a/docs/js.validateapiauthentication.md +++ b/docs/js.validateapiauthentication.md @@ -4,6 +4,8 @@ ## validateAPIAuthentication() function +Validates that an authentication prefix is valid + Signature: ```typescript @@ -14,9 +16,11 @@ declare function validateAPIAuthentication(auth: string): auth is APIAuthenticat | Parameter | Type | Description | | --- | --- | --- | -| auth | string | | +| auth | string | The prefix to validate | Returns: auth is [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) +`true` if the prefix is valid, `false` otherwise + diff --git a/package.json b/package.json index 5e20b583..8c12b795 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,7 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "docs": "yarn tsc && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "docs": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", "test": "tsx tests/index.ts" }, "devDependencies": { diff --git a/src/rest/client.ts b/src/rest/client.ts index 169ce183..98f81e6e 100644 --- a/src/rest/client.ts +++ b/src/rest/client.ts @@ -1,27 +1,51 @@ import {fetch, Headers, Request} from '../util/fetch.js'; -import {_ExtractRouteParams} from '../util/index.js'; +import {ExtractRouteParams} from '../util/index.js'; import {IS_BROWSER} from '../util/constants.js'; import {createURLBuilder} from '../util/urls.js'; import {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.js'; -import {getIdPrefix, Id, _Method} from './types/index.js'; +import {getIdPrefix, Id, Method} from './types/index.js'; +/** + * All possible authentication ID types + * @public + */ export type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; +/** + * A valid ID prefix supported by the Hop API for authetication + * @public + */ export type APIAuthenticationPrefix = APIAuthentication extends Id ? T : never; +/** + * Validates that an authentication prefix is valid + * @param auth - The prefix to validate + * @returns `true` if the prefix is valid, `false` otherwise + * @public + */ export function validateAPIAuthentication( auth: string, ): auth is APIAuthenticationPrefix { return auth === 'bearer' || auth === 'pat' || auth === 'ptk'; } +/** + * Options passed to the API client. + * This will usually come from Hop#constructor in most cases + * + * @public + */ export interface APIClientOptions { readonly baseUrl: string; readonly authentication: APIAuthentication; } +/** + * An error that occurred as a response from the Hop API. + * @public + */ export class HopAPIError extends Error { public readonly status: number; @@ -36,9 +60,17 @@ export class HopAPIError extends Error { } } -export type Query = _ExtractRouteParams & +/** + * Generate a query object that includes typed URL params + * @public + */ +export type Query = ExtractRouteParams & Record; +/** + * API Client that is responsible for handling all requests + * @public + */ export class APIClient { public static getAuthType(auth: APIAuthentication) { const prefix = getIdPrefix(auth); @@ -180,7 +212,7 @@ export class APIClient { } private async request( - method: _Method, + method: Method, path: string, body: unknown, query: Record = {}, diff --git a/src/rest/endpoints.ts b/src/rest/endpoints.ts index 18152c0a..0c21c90b 100644 --- a/src/rest/endpoints.ts +++ b/src/rest/endpoints.ts @@ -1,4 +1,4 @@ -import {_Method} from './types/index.js'; +import {Method} from './types/index.js'; import {ChannelEndpoints} from './types/channels.js'; import {IgniteEndpoints} from './types/ignite.js'; import {PipeEndpoints} from './types/pipe.js'; @@ -22,7 +22,7 @@ export type ErroredAPIResponse = { export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; export type Endpoint< - M extends _Method, + M extends Method, Path extends string, Res, Body = undefined, diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index e040408a..eb106ffd 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {Project} from './projects.js'; -import {_Empty, Id, Timestamp} from '../../util/types.js'; +import {Empty, Id, Timestamp} from '../../util/types.js'; export enum ChannelType { PRIVATE = 'private', @@ -83,23 +83,23 @@ export type ChannelEndpoints = {token: ChannelToken}, {state: State} > - | Endpoint<'DELETE', '/v1/channels/:channel_id', _Empty> + | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', {channel: Channel}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', {tokens: ChannelToken[]}> | Endpoint< 'POST', '/v1/channels/tokens/:token/messages', - _Empty, + Empty, {e: string; d: unknown} > - | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', _Empty> - | Endpoint<'PATCH', '/v1/channels/:channel_id/state', _Empty, State> - | Endpoint<'PUT', '/v1/channels/:channel_id/state', _Empty, State> + | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> + | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> + | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', {state: State}> | Endpoint< 'POST', '/v1/channels/:channel_id/messages', - _Empty, + Empty, {e: string; d: unknown} > | Endpoint<'GET', '/v1/channels', {channels: Channel[]}> @@ -110,7 +110,7 @@ export type ChannelEndpoints = {token: ChannelToken}, {expiresAt?: Timestamp | null; state: ChannelToken['state']} > - | Endpoint<'DELETE', '/v1/channels/tokens/:token', _Empty> + | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint< 'GET', '/v1/channels/:channel_id/stats', diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index e26e561e..36ff7e99 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -1,7 +1,7 @@ import {ByteSizeString} from '../../util/index.js'; import {Endpoint} from '../endpoints.js'; import { - _Empty, + Empty, HopShDomain, Id, InternalHopDomain, @@ -664,8 +664,8 @@ export type IgniteEndpoints = {deployment: Deployment}, DeploymentConfig > - | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', _Empty> - | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', _Empty> + | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> + | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint< 'GET', '/v1/ignite/containers/:container_id/logs', @@ -680,7 +680,7 @@ export type IgniteEndpoints = | Endpoint< 'PUT', '/v1/ignite/containers/:container_id/state', - _Empty, + Empty, { /** * The state to update the container to @@ -691,7 +691,7 @@ export type IgniteEndpoints = | Endpoint< 'POST', '/v1/ignite/gateways/:gateway_id/domains', - _Empty, + Empty, {domain: string} > | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', {gateway: Gateway}> diff --git a/src/rest/types/index.ts b/src/rest/types/index.ts index f09202c5..62115885 100644 --- a/src/rest/types/index.ts +++ b/src/rest/types/index.ts @@ -1,3 +1,8 @@ +/** + * API defines all types for the Hop API + * @public + */ import * as API from './api.js'; export * from '../../util/types.js'; + export {API}; diff --git a/src/rest/types/pipe.ts b/src/rest/types/pipe.ts index 4ea32025..53ce3e27 100644 --- a/src/rest/types/pipe.ts +++ b/src/rest/types/pipe.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {Regions} from './ignite.js'; -import {_Empty, Id, Timestamp} from '../../util/types.js'; +import {Empty, Id, Timestamp} from '../../util/types.js'; export type DeliveryProtocol = 'webrtc' | 'hls'; @@ -78,4 +78,4 @@ export type PipeEndpoints = }; } > - | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', _Empty>; + | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; diff --git a/src/rest/types/projects.ts b/src/rest/types/projects.ts index 7c6a4c14..b83295ef 100644 --- a/src/rest/types/projects.ts +++ b/src/rest/types/projects.ts @@ -1,5 +1,5 @@ import {Endpoint} from '../endpoints.js'; -import {_Empty, Id, Timestamp} from '../../util/types.js'; +import {Empty, Id, Timestamp} from '../../util/types.js'; import {User} from './users.js'; export type Member = Omit & { @@ -162,9 +162,9 @@ export type ProjectsEndpoints = | Endpoint< 'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', - _Empty + Empty > - | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', _Empty> + | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint< 'GET', '/v1/projects/:project_id/members/@me', @@ -208,5 +208,5 @@ export type ProjectsEndpoints = > | Endpoint<'GET', '/v1/projects/:project_id/secrets', {secrets: Secret[]}> | Endpoint<'GET', '/v1/projects/@this/secrets', {secrets: Secret[]}> - | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', _Empty> - | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', _Empty>; + | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> + | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; diff --git a/src/rest/types/registry.ts b/src/rest/types/registry.ts index 87822382..ac4037ad 100644 --- a/src/rest/types/registry.ts +++ b/src/rest/types/registry.ts @@ -1,8 +1,8 @@ import {Endpoint} from '../endpoints.js'; -import {_Empty} from '../../util/types.js'; +import {Empty} from '../../util/types.js'; export type RegistryEndpoints = - | Endpoint<'DELETE', '/v1/registry/images/:image', _Empty> + | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', {images: string[]}> | Endpoint< 'GET', diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index cd894b51..31bcd5c4 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -1,6 +1,6 @@ import {Endpoint} from '../endpoints.js'; import {MemberRole, Project} from './projects.js'; -import {_Empty, Id, Timestamp} from '../../util/types.js'; +import {Empty, Id, Timestamp} from '../../util/types.js'; /** * A user objct @@ -64,4 +64,4 @@ export type UserEndpoints = > | Endpoint<'POST', '/v1/users/@me/pats', {pat: PAT}, {name: string}> | Endpoint<'GET', '/v1/users/@me/pats', {pats: PAT[]}> - | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', _Empty>; + | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index 522f824d..2475605c 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -4,6 +4,7 @@ import {sdk} from './create.js'; /** * New state to set to a channel, or a callback function that will produce the new state + * @public */ export type SetStateAction = | T diff --git a/src/util/constants.ts b/src/util/constants.ts index 041fb405..c1ad8a86 100644 --- a/src/util/constants.ts +++ b/src/util/constants.ts @@ -5,12 +5,18 @@ declare const Deno: object | undefined; /** * The default base URL for Hop's API. + * @public */ export const DEFAULT_BASE_URL = 'https://api.hop.io'; /** * If we are in the browser. + * @public */ export const IS_BROWSER = typeof window !== 'undefined'; +/** + * If this runtiem supports the Intl API + * @public + */ export const SUPPORTS_INTL = typeof Intl !== 'undefined'; diff --git a/src/util/types.ts b/src/util/types.ts index e0a49e86..895d352b 100644 --- a/src/util/types.ts +++ b/src/util/types.ts @@ -2,15 +2,15 @@ import {formatList} from './lists.js'; /** * All methods the Hop API accepts - * @internal + * @public */ -export type _Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; /** * An empty response type - * @internal + * @public */ -export type _Empty = void; +export type Empty = void; /** * Tag a type to make it unique @@ -32,12 +32,12 @@ export type Timestamp = Tag; /** * Creates a record of params required for a given URL/path - * @internal + * @public */ -export type _ExtractRouteParams = string extends T +export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` - ? {[k in Param | keyof _ExtractRouteParams]: string | number} + ? {[k in Param | keyof ExtractRouteParams]: string | number} : T extends `${string}:${infer Param}` ? {[k in Param]: string | number} : {}; diff --git a/src/util/urls.ts b/src/util/urls.ts index 3b9c6995..5004d2b1 100644 --- a/src/util/urls.ts +++ b/src/util/urls.ts @@ -1,4 +1,4 @@ -import {_ExtractRouteParams, Query} from '../rest/index.js'; +import {ExtractRouteParams, Query} from '../rest/index.js'; export function lead(x: string) { return x.charCodeAt(0) === 47 ? x : '/' + x; @@ -63,7 +63,7 @@ export function createURLBuilder(base: string) { if (param in query) { const {[param]: value, ...rest} = query; - query = rest as _ExtractRouteParams; + query = rest as ExtractRouteParams; if (value === undefined) { throw new Error(`URL param ${param} is undefined`); diff --git a/tsconfig.json b/tsconfig.json index 6d51ec18..3ed54adc 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -13,9 +13,7 @@ "isolatedModules": true, "noFallthroughCasesInSwitch": true, "declaration": true, - "declarationMap": true, - "noEmit": true, - "rootDir": ".temp" + "declarationMap": true }, "exclude": ["node_modules", "dist"], "include": ["./**/*.ts", "./**/*.tsx", "gen-docs.mts"] From 1c8e13df24936112950c5d7d70b5c2780c185669 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 13:55:57 +0000 Subject: [PATCH 08/33] feat: ts@next --- package.json | 16 +- src/hop.ts | 6 +- src/index.ts | 14 +- src/rest/client.ts | 12 +- src/rest/endpoints.ts | 14 +- src/rest/index.ts | 6 +- src/rest/types/api.ts | 12 +- src/rest/types/channels.ts | 6 +- src/rest/types/ignite.ts | 6 +- src/rest/types/index.ts | 4 +- src/rest/types/pipe.ts | 6 +- src/rest/types/projects.ts | 6 +- src/rest/types/registry.ts | 4 +- src/rest/types/users.ts | 6 +- src/sdks/channels.ts | 4 +- src/sdks/create.ts | 2 +- src/sdks/ignite.ts | 8 +- src/sdks/index.ts | 12 +- src/sdks/pipe.ts | 8 +- src/sdks/projects.ts | 6 +- src/sdks/registry.ts | 4 +- src/sdks/users.ts | 4 +- src/util/index.ts | 6 +- src/util/lists.ts | 2 +- src/util/types.ts | 2 +- src/util/urls.ts | 2 +- src/utils/zod/ids.ts | 2 +- src/utils/zod/index.ts | 2 +- tests/index.ts | 2 +- tsconfig.json | 5 +- yarn.lock | 360 ++++++++++++++++++++----------------- 31 files changed, 288 insertions(+), 261 deletions(-) diff --git a/package.json b/package.json index a49fc90f..619ab220 100644 --- a/package.json +++ b/package.json @@ -47,22 +47,22 @@ "test": "tsx tests/index.ts" }, "devDependencies": { - "@changesets/cli": "2.25.2", + "@changesets/cli": "2.26.0", "@types/glob": "8.0.0", - "@types/node": "18.11.9", + "@types/node": "18.11.18", "dotenv": "16.0.3", "glob": "8.0.3", - "prettier": "2.8.0", + "prettier": "2.8.2", "tsup": "6.5.0", - "tsx": "3.12.1", - "typedoc": "0.23.21", - "typedoc-plugin-markdown": "3.13.6", + "tsx": "3.12.2", + "typedoc": "0.23.24", + "typedoc-plugin-markdown": "3.14.0", "typedoc-plugin-missing-exports": "1.0.0", - "typescript": "^4.9.3" + "typescript": "next" }, "dependencies": { "@onehop/json-methods": "^1.2.0", "cross-fetch": "^3.1.5", - "zod": "^3.19.1" + "zod": "^3.20.2" } } diff --git a/src/hop.ts b/src/hop.ts index 22da4f7d..84dd186c 100644 --- a/src/hop.ts +++ b/src/hop.ts @@ -1,4 +1,4 @@ -import {APIAuthentication, APIClient, APIClientOptions} from './rest/client.js'; +import {APIAuthentication, APIClient, APIClientOptions} from './rest/client.ts'; import { channels, ignite, @@ -6,8 +6,8 @@ import { projects, registry, users, -} from './sdks/index.js'; -import {DEFAULT_BASE_URL} from './util/constants.js'; +} from './sdks/index.ts'; +import {DEFAULT_BASE_URL} from './util/constants.ts'; export type PartialAPIOptions = Partial< Omit diff --git a/src/index.ts b/src/index.ts index d09d1c79..3b8ef656 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,13 +1,13 @@ -export * from './hop.js'; -export * from './permissions.js'; -export * from './rest/index.js'; +export * from './hop.ts'; +export * from './permissions.ts'; +export * from './rest/index.ts'; // Commonly used in the API, so nice to export in two place -export {type APIAuthentication} from './rest/index.js'; -export {ChannelType} from './rest/types/channels.js'; +export {type APIAuthentication} from './rest/index.ts'; +export {ChannelType} from './rest/types/channels.ts'; export { ContainerState, RestartPolicy, RolloutState, RuntimeType, -} from './rest/types/ignite.js'; -export * from './util/index.js'; +} from './rest/types/ignite.ts'; +export * from './util/index.ts'; diff --git a/src/rest/client.ts b/src/rest/client.ts index 3e38093b..fede5b5f 100644 --- a/src/rest/client.ts +++ b/src/rest/client.ts @@ -1,9 +1,9 @@ -import {IS_BROWSER} from '../util/constants.js'; -import {fetch, Headers, Request} from '../util/fetch.js'; -import {ExtractRouteParams} from '../util/index.js'; -import {createURLBuilder} from '../util/urls.js'; -import {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.js'; -import {getIdPrefix, Id, Method} from './types/index.js'; +import {IS_BROWSER} from '../util/constants.ts'; +import {fetch, Headers, Request} from '../util/fetch.ts'; +import {ExtractRouteParams} from '../util/index.ts'; +import {createURLBuilder} from '../util/urls.ts'; +import {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.ts'; +import {getIdPrefix, Id, Method} from './types/index.ts'; export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; export type APIAuthentication = Id; diff --git a/src/rest/endpoints.ts b/src/rest/endpoints.ts index 06ee98d6..646ac699 100644 --- a/src/rest/endpoints.ts +++ b/src/rest/endpoints.ts @@ -1,10 +1,10 @@ -import {ChannelEndpoints} from './types/channels.js'; -import {IgniteEndpoints} from './types/ignite.js'; -import {Method} from './types/index.js'; -import {PipeEndpoints} from './types/pipe.js'; -import {ProjectsEndpoints} from './types/projects.js'; -import {RegistryEndpoints} from './types/registry.js'; -import {UserEndpoints} from './types/users.js'; +import {ChannelEndpoints} from './types/channels.ts'; +import {IgniteEndpoints} from './types/ignite.ts'; +import {Method} from './types/index.ts'; +import {PipeEndpoints} from './types/pipe.ts'; +import {ProjectsEndpoints} from './types/projects.ts'; +import {RegistryEndpoints} from './types/registry.ts'; +import {UserEndpoints} from './types/users.ts'; export type SuccessfulAPIResponse = { success: true; diff --git a/src/rest/index.ts b/src/rest/index.ts index 0bcbfe61..cf2741ba 100644 --- a/src/rest/index.ts +++ b/src/rest/index.ts @@ -1,3 +1,3 @@ -export * from './client.js'; -export * from './endpoints.js'; -export * from './types/index.js'; +export * from './client.ts'; +export * from './endpoints.ts'; +export * from './types/index.ts'; diff --git a/src/rest/types/api.ts b/src/rest/types/api.ts index 946be275..11931454 100644 --- a/src/rest/types/api.ts +++ b/src/rest/types/api.ts @@ -1,6 +1,6 @@ -export * as Channels from './channels.js'; -export * as Ignite from './ignite.js'; -export * as Pipe from './pipe.js'; -export * as Projects from './projects.js'; -export * as Registry from './registry.js'; -export * as Users from './users.js'; +export * as Channels from './channels.ts'; +export * as Ignite from './ignite.ts'; +export * as Pipe from './pipe.ts'; +export * as Projects from './projects.ts'; +export * as Registry from './registry.ts'; +export * as Users from './users.ts'; diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index 627106f8..a32ed7a9 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; -import {Project} from './projects.js'; +import {Empty, Id, Timestamp} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; +import {Project} from './projects.ts'; export enum ChannelType { PRIVATE = 'private', diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index b788d190..a4589a0c 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -1,4 +1,4 @@ -import {ByteSizeString} from '../../util/index.js'; +import {ByteSizeString} from '../../util/index.ts'; import { Empty, HopShDomain, @@ -6,8 +6,8 @@ import { InternalHopDomain, MakeOptional, Timestamp, -} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; +} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; export enum Regions { US_EAST_1 = 'us-east-1', diff --git a/src/rest/types/index.ts b/src/rest/types/index.ts index f09202c5..863b3b6f 100644 --- a/src/rest/types/index.ts +++ b/src/rest/types/index.ts @@ -1,3 +1,3 @@ -import * as API from './api.js'; -export * from '../../util/types.js'; +import * as API from './api.ts'; +export * from '../../util/types.ts'; export {API}; diff --git a/src/rest/types/pipe.ts b/src/rest/types/pipe.ts index e0ccaa52..87be8f82 100644 --- a/src/rest/types/pipe.ts +++ b/src/rest/types/pipe.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; -import {Regions} from './ignite.js'; +import {Empty, Id, Timestamp} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; +import {Regions} from './ignite.ts'; export type DeliveryProtocol = 'webrtc' | 'hls'; diff --git a/src/rest/types/projects.ts b/src/rest/types/projects.ts index edfe87ba..c7c92810 100644 --- a/src/rest/types/projects.ts +++ b/src/rest/types/projects.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; -import {User} from './users.js'; +import {Empty, Id, Timestamp} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; +import {User} from './users.ts'; export type Member = Omit & { /** diff --git a/src/rest/types/registry.ts b/src/rest/types/registry.ts index 78937306..4809b581 100644 --- a/src/rest/types/registry.ts +++ b/src/rest/types/registry.ts @@ -1,5 +1,5 @@ -import {Empty} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; +import {Empty} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; export type RegistryEndpoints = | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index 1639a38a..f32cabb5 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.js'; -import {Endpoint} from '../endpoints.js'; -import {MemberRole, Project} from './projects.js'; +import {Empty, Id, Timestamp} from '../../util/types.ts'; +import {Endpoint} from '../endpoints.ts'; +import {MemberRole, Project} from './projects.ts'; /** * A user objct diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index e480d15d..9c8335b4 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -1,6 +1,6 @@ import {create} from '@onehop/json-methods'; -import {API, Id} from '../rest/index.js'; -import {sdk} from './create.js'; +import {API, Id} from '../rest/index.ts'; +import {sdk} from './create.ts'; /** * New state to set to a channel, or a callback function that will produce the new state diff --git a/src/sdks/create.ts b/src/sdks/create.ts index a21f60b9..c9c2082e 100644 --- a/src/sdks/create.ts +++ b/src/sdks/create.ts @@ -1,4 +1,4 @@ -import {APIClient} from '../rest/index.js'; +import {APIClient} from '../rest/index.ts'; export function sdk(builder: (client: APIClient) => T) { return builder; diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index fa5afd61..f1b1a8f6 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -1,14 +1,14 @@ import {create, Infer} from '@onehop/json-methods'; -import {API, assertId, Id} from '../rest/index.js'; +import {API, assertId, Id} from '../rest/index.ts'; import { Deployment, DeploymentConfig, Gateway, GatewayType, RuntimeType, -} from '../rest/types/ignite.js'; -import {parseSize, validateId} from '../util/index.js'; -import {sdk} from './create.js'; +} from '../rest/types/ignite.ts'; +import {parseSize, validateId} from '../util/index.ts'; +import {sdk} from './create.ts'; const SIX_MB_IN_BYTES = 6 * 1024 * 1024; diff --git a/src/sdks/index.ts b/src/sdks/index.ts index b64868ce..8074bf50 100644 --- a/src/sdks/index.ts +++ b/src/sdks/index.ts @@ -1,6 +1,6 @@ -export {channels} from './channels.js'; -export {ignite} from './ignite.js'; -export {pipe} from './pipe.js'; -export {projects} from './projects.js'; -export {registry} from './registry.js'; -export {users} from './users.js'; +export {channels} from './channels.ts'; +export {ignite} from './ignite.ts'; +export {pipe} from './pipe.ts'; +export {projects} from './projects.ts'; +export {registry} from './registry.ts'; +export {users} from './users.ts'; diff --git a/src/sdks/pipe.ts b/src/sdks/pipe.ts index 882052e4..9b96ff11 100644 --- a/src/sdks/pipe.ts +++ b/src/sdks/pipe.ts @@ -1,8 +1,8 @@ import {create} from '@onehop/json-methods'; -import {API, Id} from '../rest/index.js'; -import {Regions} from '../rest/types/ignite.js'; -import {DeliveryProtocol} from '../rest/types/pipe.js'; -import {sdk} from './create.js'; +import {API, Id} from '../rest/index.ts'; +import {Regions} from '../rest/types/ignite.ts'; +import {DeliveryProtocol} from '../rest/types/pipe.ts'; +import {sdk} from './create.ts'; export const pipe = sdk(client => { const Rooms = create().methods({ diff --git a/src/sdks/projects.ts b/src/sdks/projects.ts index 361e6a00..77d7f19f 100644 --- a/src/sdks/projects.ts +++ b/src/sdks/projects.ts @@ -1,6 +1,6 @@ -import {API, Endpoints, Id} from '../rest/index.js'; -import {Request} from '../util/fetch.js'; -import {sdk} from './create.js'; +import {API, Endpoints, Id} from '../rest/index.ts'; +import {Request} from '../util/fetch.ts'; +import {sdk} from './create.ts'; export const projects = sdk(client => { const tokens = { diff --git a/src/sdks/registry.ts b/src/sdks/registry.ts index e0c55dd2..494ebaaf 100644 --- a/src/sdks/registry.ts +++ b/src/sdks/registry.ts @@ -1,5 +1,5 @@ -import {Id} from '../rest/index.js'; -import {sdk} from './create.js'; +import {Id} from '../rest/index.ts'; +import {sdk} from './create.ts'; export const registry = sdk(client => { return { diff --git a/src/sdks/users.ts b/src/sdks/users.ts index 5559d458..94621652 100644 --- a/src/sdks/users.ts +++ b/src/sdks/users.ts @@ -1,5 +1,5 @@ -import {Id} from '../util/types.js'; -import {sdk} from './create.js'; +import {Id} from '../util/types.ts'; +import {sdk} from './create.ts'; export const users = sdk(client => ({ me: { diff --git a/src/util/index.ts b/src/util/index.ts index c57a3234..7988ae1e 100644 --- a/src/util/index.ts +++ b/src/util/index.ts @@ -1,3 +1,3 @@ -export * from './constants.js'; -export * from './size.js'; -export * from './types.js'; +export * from './constants.ts'; +export * from './size.ts'; +export * from './types.ts'; diff --git a/src/util/lists.ts b/src/util/lists.ts index 49eec6fa..013e4d21 100644 --- a/src/util/lists.ts +++ b/src/util/lists.ts @@ -1,4 +1,4 @@ -import {SUPPORTS_INTL} from './constants.js'; +import {SUPPORTS_INTL} from './constants.ts'; export function formatList(list: string[], type: Intl.ListFormatType): string { if (SUPPORTS_INTL) { diff --git a/src/util/types.ts b/src/util/types.ts index c998b009..22c19748 100644 --- a/src/util/types.ts +++ b/src/util/types.ts @@ -1,4 +1,4 @@ -import {formatList} from './lists.js'; +import {formatList} from './lists.ts'; export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; diff --git a/src/util/urls.ts b/src/util/urls.ts index 2ec5e362..242adb97 100644 --- a/src/util/urls.ts +++ b/src/util/urls.ts @@ -1,4 +1,4 @@ -import {ExtractRouteParams, Query} from '../rest/index.js'; +import {ExtractRouteParams, Query} from '../rest/index.ts'; export function lead(x: string) { return x.charCodeAt(0) === 47 ? x : '/' + x; diff --git a/src/utils/zod/ids.ts b/src/utils/zod/ids.ts index b11d00b7..d83990cc 100644 --- a/src/utils/zod/ids.ts +++ b/src/utils/zod/ids.ts @@ -1,5 +1,5 @@ import {z} from 'zod'; -import {Id, IdPrefixes, validateId} from '../../rest/index.js'; +import {Id, IdPrefixes, validateId} from '../../rest/index.ts'; /** * Generate a Zod schema for an ID prefix diff --git a/src/utils/zod/index.ts b/src/utils/zod/index.ts index 54e2e6aa..2b16854e 100644 --- a/src/utils/zod/index.ts +++ b/src/utils/zod/index.ts @@ -1 +1 @@ -export * from './ids.js'; +export * from './ids.ts'; diff --git a/tests/index.ts b/tests/index.ts index c03816b8..a752f0c4 100644 --- a/tests/index.ts +++ b/tests/index.ts @@ -6,7 +6,7 @@ import {test} from 'node:test'; // @ts-expect-error This is usually injected by tsup globalThis.TSUP_IS_NODE = true; -import {id, Hop, validateId} from '../src/index.js'; +import {id, Hop, validateId} from '../src/index.ts'; const BASE_URL = process.env.TEST_HOP_API_BASE_URL ?? 'https://api-staging.hop.io'; diff --git a/tsconfig.json b/tsconfig.json index 040ad11a..8073f868 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -7,7 +7,7 @@ "esModuleInterop": true, "forceConsistentCasingInFileNames": true, "module": "NodeNext", - "moduleResolution": "NodeNext", + "moduleResolution": "bundler", "resolveJsonModule": true, "isolatedModules": true, "jsx": "react", @@ -18,7 +18,8 @@ "noUnusedLocals": true, "noUnusedParameters": true, "noImplicitReturns": true, - "noUncheckedIndexedAccess": true + "noUncheckedIndexedAccess": true, + "allowImportingTsExtensions": true }, "exclude": ["node_modules", "dist"], "include": ["./**/*.ts", "./**/*.tsx", "gen-docs.mts"] diff --git a/yarn.lock b/yarn.lock index b7df91f5..761589c1 100644 --- a/yarn.lock +++ b/yarn.lock @@ -32,7 +32,16 @@ __metadata: languageName: node linkType: hard -"@babel/runtime@npm:^7.10.4, @babel/runtime@npm:^7.5.5": +"@babel/runtime@npm:^7.20.1": + version: 7.20.7 + resolution: "@babel/runtime@npm:7.20.7" + dependencies: + regenerator-runtime: ^0.13.11 + checksum: 4629ce5c46f06cca9cfb9b7fc00d48003335a809888e2b91ec2069a2dcfbfef738480cff32ba81e0b7c290f8918e5c22ddcf2b710001464ee84ba62c7e32a3a3 + languageName: node + linkType: hard + +"@babel/runtime@npm:^7.5.5": version: 7.19.0 resolution: "@babel/runtime@npm:7.19.0" dependencies: @@ -41,15 +50,15 @@ __metadata: languageName: node linkType: hard -"@changesets/apply-release-plan@npm:^6.1.2": - version: 6.1.2 - resolution: "@changesets/apply-release-plan@npm:6.1.2" +"@changesets/apply-release-plan@npm:^6.1.3": + version: 6.1.3 + resolution: "@changesets/apply-release-plan@npm:6.1.3" dependencies: - "@babel/runtime": ^7.10.4 - "@changesets/config": ^2.2.0 + "@babel/runtime": ^7.20.1 + "@changesets/config": ^2.3.0 "@changesets/get-version-range-type": ^0.3.2 - "@changesets/git": ^1.5.0 - "@changesets/types": ^5.2.0 + "@changesets/git": ^2.0.0 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 detect-indent: ^6.0.0 fs-extra: ^7.0.1 @@ -58,51 +67,51 @@ __metadata: prettier: ^2.7.1 resolve-from: ^5.0.0 semver: ^5.4.1 - checksum: efe2cdc493cb2182140b73ff76e34ee7c90887bfa2f42b4ec07db0107ec94b9c0e95519912dafcf9eb530ad2414487fbd61ca6e6d5f853fe383db93856d0d362 + checksum: 3772a6e0ede33abdac6fcc52359307f770d5fafa53295c83e0a11b81e5802b2fe5e74e4d672c0a082f5d73dc1a9ef56509870b81824111396f74de99ada9526b languageName: node linkType: hard -"@changesets/assemble-release-plan@npm:^5.2.2": - version: 5.2.2 - resolution: "@changesets/assemble-release-plan@npm:5.2.2" +"@changesets/assemble-release-plan@npm:^5.2.3": + version: 5.2.3 + resolution: "@changesets/assemble-release-plan@npm:5.2.3" dependencies: - "@babel/runtime": ^7.10.4 + "@babel/runtime": ^7.20.1 "@changesets/errors": ^0.1.4 - "@changesets/get-dependents-graph": ^1.3.4 - "@changesets/types": ^5.2.0 + "@changesets/get-dependents-graph": ^1.3.5 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 semver: ^5.4.1 - checksum: 4f4a2108537ecbfbf9a554e441f4899f9c6d7e2b933deddd186d6f670ea1e52ebbbef3da01bc61b5cb735470536258b94d7bbac1035fe98dc277615d5017c61a + checksum: 2c61894414736b12e9a26903d73c387b65f4caba398e280488b885f4d0f4bb307aaa6bae140dfd754c85de6557bd07645accda2af6b8794837ab43823ba6215c languageName: node linkType: hard -"@changesets/changelog-git@npm:^0.1.13": - version: 0.1.13 - resolution: "@changesets/changelog-git@npm:0.1.13" +"@changesets/changelog-git@npm:^0.1.14": + version: 0.1.14 + resolution: "@changesets/changelog-git@npm:0.1.14" dependencies: - "@changesets/types": ^5.2.0 - checksum: c0e3b11a0a63794304e064ef01444503a864a1fbfc4c592bd3aec91ba6aa5c24fac91a47f7f0159f449cd6ce99c334290b465d84b1c98b6577937ff55974cc7e + "@changesets/types": ^5.2.1 + checksum: 60b45bb899e66cec669ab3884d5d18550cd30bf5a8b06f335eb72aa6c9e018dd3e0187e4df61c91a22076153e346b735b792f0e9c6186e6245b1b7aec2fc42d4 languageName: node linkType: hard -"@changesets/cli@npm:2.25.2": - version: 2.25.2 - resolution: "@changesets/cli@npm:2.25.2" +"@changesets/cli@npm:2.26.0": + version: 2.26.0 + resolution: "@changesets/cli@npm:2.26.0" dependencies: - "@babel/runtime": ^7.10.4 - "@changesets/apply-release-plan": ^6.1.2 - "@changesets/assemble-release-plan": ^5.2.2 - "@changesets/changelog-git": ^0.1.13 - "@changesets/config": ^2.2.0 + "@babel/runtime": ^7.20.1 + "@changesets/apply-release-plan": ^6.1.3 + "@changesets/assemble-release-plan": ^5.2.3 + "@changesets/changelog-git": ^0.1.14 + "@changesets/config": ^2.3.0 "@changesets/errors": ^0.1.4 - "@changesets/get-dependents-graph": ^1.3.4 - "@changesets/get-release-plan": ^3.0.15 - "@changesets/git": ^1.5.0 + "@changesets/get-dependents-graph": ^1.3.5 + "@changesets/get-release-plan": ^3.0.16 + "@changesets/git": ^2.0.0 "@changesets/logger": ^0.0.5 - "@changesets/pre": ^1.0.13 - "@changesets/read": ^0.5.8 - "@changesets/types": ^5.2.0 - "@changesets/write": ^0.2.2 + "@changesets/pre": ^1.0.14 + "@changesets/read": ^0.5.9 + "@changesets/types": ^5.2.1 + "@changesets/write": ^0.2.3 "@manypkg/get-packages": ^1.1.3 "@types/is-ci": ^3.0.0 "@types/semver": ^6.0.0 @@ -124,22 +133,22 @@ __metadata: tty-table: ^4.1.5 bin: changeset: bin.js - checksum: 815c69cb6cee75ede88361582581d94a860d96335e7bab179481cd5e2bb1e60cc39662dccd2b2b87818e9c63a84ff9eb469ed27f13b6adf4401a699e49beb79c + checksum: 12a911b4196ff390ce114e27b475e59f5f5e1fdc7049d1ab04effe73d4811d99db47a030de6abe332300b4b2c43cffc537cec4883476b59b69bc23aee07cd5c5 languageName: node linkType: hard -"@changesets/config@npm:^2.2.0": - version: 2.2.0 - resolution: "@changesets/config@npm:2.2.0" +"@changesets/config@npm:^2.3.0": + version: 2.3.0 + resolution: "@changesets/config@npm:2.3.0" dependencies: "@changesets/errors": ^0.1.4 - "@changesets/get-dependents-graph": ^1.3.4 + "@changesets/get-dependents-graph": ^1.3.5 "@changesets/logger": ^0.0.5 - "@changesets/types": ^5.2.0 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 fs-extra: ^7.0.1 micromatch: ^4.0.2 - checksum: 18a6ae52150a7426bcaeb4018f7eb4e330dec69a448b093d604f1cd73d89b689eb791777cee5af57f9e572403ccbf196a572b33dbb702bae4bccfbbbd3be5ffc + checksum: 68a61437ffeda219f22f6d4d32bf8d428e6f284d7e0e191c0629f64f035a051b4068222b1ea3ff1866e5944a153004735dab82205404919f6806c97c546700b1 languageName: node linkType: hard @@ -152,31 +161,31 @@ __metadata: languageName: node linkType: hard -"@changesets/get-dependents-graph@npm:^1.3.4": - version: 1.3.4 - resolution: "@changesets/get-dependents-graph@npm:1.3.4" +"@changesets/get-dependents-graph@npm:^1.3.5": + version: 1.3.5 + resolution: "@changesets/get-dependents-graph@npm:1.3.5" dependencies: - "@changesets/types": ^5.2.0 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 chalk: ^2.1.0 fs-extra: ^7.0.1 semver: ^5.4.1 - checksum: 584852e17fd102271dea520f851c85130605f232f7f52126d202b0041269af12d5681744bfa7fecf41048e5fd62a71da726be471207832060408d9cfb35ec3fb + checksum: d7abb1da21804fd66b1458e46be2f2aec741145a43500b0463a5acfbb420ac5ce776a7328fa660ad4e6e811f933bd6f36e7bbaf00fb3f591d46f0b8e7108fdcd languageName: node linkType: hard -"@changesets/get-release-plan@npm:^3.0.15": - version: 3.0.15 - resolution: "@changesets/get-release-plan@npm:3.0.15" +"@changesets/get-release-plan@npm:^3.0.16": + version: 3.0.16 + resolution: "@changesets/get-release-plan@npm:3.0.16" dependencies: - "@babel/runtime": ^7.10.4 - "@changesets/assemble-release-plan": ^5.2.2 - "@changesets/config": ^2.2.0 - "@changesets/pre": ^1.0.13 - "@changesets/read": ^0.5.8 - "@changesets/types": ^5.2.0 + "@babel/runtime": ^7.20.1 + "@changesets/assemble-release-plan": ^5.2.3 + "@changesets/config": ^2.3.0 + "@changesets/pre": ^1.0.14 + "@changesets/read": ^0.5.9 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 - checksum: f2d33982dfeabe12e0eba976a3cc68e05bdd834b4dd6283f42464d028852e46f90cb14b84f0b5425813c787494d0490dc12df5d25d63559d07f47f9a7cb87c12 + checksum: ab8360c17f69437ad51edfd8910a2609ab8dc1e8cf006994b3938b2551b1eb08b7ab8043b8bf1e94916cbadd89e357a0c1148e20eab8bb5e3ae284384d239942 languageName: node linkType: hard @@ -187,17 +196,18 @@ __metadata: languageName: node linkType: hard -"@changesets/git@npm:^1.5.0": - version: 1.5.0 - resolution: "@changesets/git@npm:1.5.0" +"@changesets/git@npm:^2.0.0": + version: 2.0.0 + resolution: "@changesets/git@npm:2.0.0" dependencies: - "@babel/runtime": ^7.10.4 + "@babel/runtime": ^7.20.1 "@changesets/errors": ^0.1.4 - "@changesets/types": ^5.2.0 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 is-subdir: ^1.1.1 + micromatch: ^4.0.2 spawndamnit: ^2.0.0 - checksum: 7208d5bff9c584aa752ca6f647ba5e97356213d00c88cce65c24c6bab1b3837c14f8977c2384a7fecb81e20a0586d4cc1fddb408a38e7dd818ef18377d01ee54 + checksum: 3820b7b689bbe8dfb93222c766bee214e68a45f07b2b5c8056891f9ffe6f1e369c0f84388246a9eea5317b496ae80ffd1508319190f79c359f060ebf8ccb7b13 languageName: node linkType: hard @@ -210,42 +220,42 @@ __metadata: languageName: node linkType: hard -"@changesets/parse@npm:^0.3.15": - version: 0.3.15 - resolution: "@changesets/parse@npm:0.3.15" +"@changesets/parse@npm:^0.3.16": + version: 0.3.16 + resolution: "@changesets/parse@npm:0.3.16" dependencies: - "@changesets/types": ^5.2.0 + "@changesets/types": ^5.2.1 js-yaml: ^3.13.1 - checksum: 1e17f494954140d7885f4be76ac7708c19930f08ecf0b58bcee09160ad6e59223da8899df0709a78e5b5fa419f0d60eccbb34bf0c11d564e24f766c4654e3384 + checksum: 475f808ac8d33ec90af3914d55af1da8eeb9336d6cab7dd9e5be74af844f0ec04f4a67d5237a1d3284a468e0c9198e2be01d0e5870a1b28e63bc240f5f1ffea9 languageName: node linkType: hard -"@changesets/pre@npm:^1.0.13": - version: 1.0.13 - resolution: "@changesets/pre@npm:1.0.13" +"@changesets/pre@npm:^1.0.14": + version: 1.0.14 + resolution: "@changesets/pre@npm:1.0.14" dependencies: - "@babel/runtime": ^7.10.4 + "@babel/runtime": ^7.20.1 "@changesets/errors": ^0.1.4 - "@changesets/types": ^5.2.0 + "@changesets/types": ^5.2.1 "@manypkg/get-packages": ^1.1.3 fs-extra: ^7.0.1 - checksum: f1cc5721546c66977a2fc62428aae9d62f78a04aefac224ac7014172807afa9d07f6da1e326d0a14b1ff12840b0379a7ec24e7984839deb337cd203b63c24b1d + checksum: 6b849bd6f916476a5b5664bc4286020bee506985c82f723a757fa4e681b0b7129db81751f16072ac55a980ffd83a4b234d6b8d0f8b6bc889aa0c0fd5377431e8 languageName: node linkType: hard -"@changesets/read@npm:^0.5.8": - version: 0.5.8 - resolution: "@changesets/read@npm:0.5.8" +"@changesets/read@npm:^0.5.9": + version: 0.5.9 + resolution: "@changesets/read@npm:0.5.9" dependencies: - "@babel/runtime": ^7.10.4 - "@changesets/git": ^1.5.0 + "@babel/runtime": ^7.20.1 + "@changesets/git": ^2.0.0 "@changesets/logger": ^0.0.5 - "@changesets/parse": ^0.3.15 - "@changesets/types": ^5.2.0 + "@changesets/parse": ^0.3.16 + "@changesets/types": ^5.2.1 chalk: ^2.1.0 fs-extra: ^7.0.1 p-filter: ^2.1.0 - checksum: cc32c5a3366be58c5b00988940eb6677898814de7ce60a3c4785d064e0df7563627f8dcfa0620f3ef9cea6f328ce538b2ba7d430c35c883f212b71a94026b2d8 + checksum: 0875a80829186de2da55bc0347601cc31b269d54fb6967a5093abacbbd9f949e352907b8340b61348a304228fdade670ded151327f16eea3424b5b4b2bb9888c languageName: node linkType: hard @@ -256,33 +266,33 @@ __metadata: languageName: node linkType: hard -"@changesets/types@npm:^5.2.0": - version: 5.2.0 - resolution: "@changesets/types@npm:5.2.0" - checksum: 579cf8bd2d3a03f293871976d8641531667527f248dc29310a70928d6400cef5df3d09e75beeb2ccf5d384fa1f294f0a2db243c6ebf53913d1f67e283e826f91 +"@changesets/types@npm:^5.2.1": + version: 5.2.1 + resolution: "@changesets/types@npm:5.2.1" + checksum: 527dc1aa41b040fe35bcd55f7d07bec710320b179b000c429723e25b87aac18be487daf5047d4fecf2781aad78f73abff111e76e411b652f7a2e812a464c69f2 languageName: node linkType: hard -"@changesets/write@npm:^0.2.2": - version: 0.2.2 - resolution: "@changesets/write@npm:0.2.2" +"@changesets/write@npm:^0.2.3": + version: 0.2.3 + resolution: "@changesets/write@npm:0.2.3" dependencies: - "@babel/runtime": ^7.10.4 - "@changesets/types": ^5.2.0 + "@babel/runtime": ^7.20.1 + "@changesets/types": ^5.2.1 fs-extra: ^7.0.1 human-id: ^1.0.2 prettier: ^2.7.1 - checksum: e23fb4a88e12af32db59d2f1866380ec4a50e7fa55cb55d860619f0735c5078ed170f832125672bb007b7a0cced67d9304a1b81260a7224af6afe0e3957dc999 + checksum: 40ad8069f9adc565b78a5f25992e31b41a12e551d94c29e1b4def49ce98871a1e358feda6536be8b363a6dba18b1226a22ecfc60fdd7bc1e74bfcf46b07f91be languageName: node linkType: hard -"@esbuild-kit/cjs-loader@npm:^2.4.0": - version: 2.4.0 - resolution: "@esbuild-kit/cjs-loader@npm:2.4.0" +"@esbuild-kit/cjs-loader@npm:^2.4.1": + version: 2.4.1 + resolution: "@esbuild-kit/cjs-loader@npm:2.4.1" dependencies: "@esbuild-kit/core-utils": ^3.0.0 get-tsconfig: ^4.2.0 - checksum: 267aef1c921317daa40345d2a58fb5482bf69cf32949458af2d78dbeeaf527860928111c550fbaa30f0c710314f9c2e1cec703f8104a6b5464c35e9692ba7cdf + checksum: a516065907be0ead76ac2199ccb08ff92659ba5e2edb4bb8772b6a63afe4faed7eb45a3b4d87266a68c7c135c3dba971cd087bc6f16c382356e835c7dd3440f5 languageName: node linkType: hard @@ -296,13 +306,13 @@ __metadata: languageName: node linkType: hard -"@esbuild-kit/esm-loader@npm:^2.5.0": - version: 2.5.0 - resolution: "@esbuild-kit/esm-loader@npm:2.5.0" +"@esbuild-kit/esm-loader@npm:^2.5.4": + version: 2.5.4 + resolution: "@esbuild-kit/esm-loader@npm:2.5.4" dependencies: "@esbuild-kit/core-utils": ^3.0.0 get-tsconfig: ^4.2.0 - checksum: 49611646f8b02ff7b41e6aacae797c4aae9edbf7c73f2c8a5ea43208e317473005930b8751749b607089110e5b93a52059b6cab4fff8e32b6acdb1811529a8d8 + checksum: 8f4b4b6470f7afeb58ddc15ddcc4e35a6d25910133f2b21a82a793918c6f8e28768d5cd77b1c90a003f2f1c83cb476b68354580a4e04e83e2da3312afe5b5895 languageName: node linkType: hard @@ -411,21 +421,21 @@ __metadata: version: 0.0.0-use.local resolution: "@onehop/js@workspace:." dependencies: - "@changesets/cli": 2.25.2 + "@changesets/cli": 2.26.0 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.0.0 - "@types/node": 18.11.9 + "@types/node": 18.11.18 cross-fetch: ^3.1.5 dotenv: 16.0.3 glob: 8.0.3 - prettier: 2.8.0 + prettier: 2.8.2 tsup: 6.5.0 - tsx: 3.12.1 - typedoc: 0.23.21 - typedoc-plugin-markdown: 3.13.6 + tsx: 3.12.2 + typedoc: 0.23.24 + typedoc-plugin-markdown: 3.14.0 typedoc-plugin-missing-exports: 1.0.0 - typescript: ^4.9.3 - zod: ^3.19.1 + typescript: next + zod: ^3.20.2 languageName: unknown linkType: soft @@ -483,10 +493,10 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:18.11.9": - version: 18.11.9 - resolution: "@types/node@npm:18.11.9" - checksum: cc0aae109e9b7adefc32eecb838d6fad931663bb06484b5e9cbbbf74865c721b03d16fd8d74ad90e31dbe093d956a7c2c306ba5429ba0c00f3f7505103d7a496 +"@types/node@npm:18.11.18": + version: 18.11.18 + resolution: "@types/node@npm:18.11.18" + checksum: 03f17f9480f8d775c8a72da5ea7e9383db5f6d85aa5fefde90dd953a1449bd5e4ffde376f139da4f3744b4c83942166d2a7603969a6f8ea826edfb16e6e3b49d languageName: node linkType: hard @@ -2431,7 +2441,7 @@ __metadata: languageName: node linkType: hard -"jsonc-parser@npm:^3.0.0": +"jsonc-parser@npm:^3.2.0": version: 3.2.0 resolution: "jsonc-parser@npm:3.2.0" checksum: 946dd9a5f326b745aa326d48a7257e3f4a4b62c5e98ec8e49fa2bdd8d96cef7e6febf1399f5c7016114fd1f68a1c62c6138826d5d90bc650448e3cf0951c53c7 @@ -2600,12 +2610,12 @@ __metadata: languageName: node linkType: hard -"marked@npm:^4.0.19": - version: 4.1.0 - resolution: "marked@npm:4.1.0" +"marked@npm:^4.2.5": + version: 4.2.5 + resolution: "marked@npm:4.2.5" bin: marked: bin/marked.js - checksum: f0b3732a9d6208c933541342e60eb78029bd046c143a6ade0e76ed80b6174f92b186205a9dfe805e435070806ec475b0e87e62d04348eafd2f761c24281b192a + checksum: dd7da20a3983c66b516463fad5dc8d15dc70e137d20b6dc491e134f671e84bd2ed5f859e2c35f21e56830a122e4356b9e574bcde49b72b7ad6bc121a215a1a98 languageName: node linkType: hard @@ -2675,7 +2685,7 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:^5.0.1, minimatch@npm:^5.1.0": +"minimatch@npm:^5.0.1": version: 5.1.0 resolution: "minimatch@npm:5.1.0" dependencies: @@ -2684,6 +2694,15 @@ __metadata: languageName: node linkType: hard +"minimatch@npm:^5.1.2": + version: 5.1.2 + resolution: "minimatch@npm:5.1.2" + dependencies: + brace-expansion: ^2.0.1 + checksum: 32ffda25b9fb8270a1c1beafdb7489dc0e411af553495136509a945691f63c9b6b000eeeaaf8bffe3efa609c1d6d3bc0f5a106f6c3443b5c05da649100ded964 + languageName: node + linkType: hard + "minimist-options@npm:^4.0.2": version: 4.1.0 resolution: "minimist-options@npm:4.1.0" @@ -3152,12 +3171,12 @@ __metadata: languageName: node linkType: hard -"prettier@npm:2.8.0": - version: 2.8.0 - resolution: "prettier@npm:2.8.0" +"prettier@npm:2.8.2": + version: 2.8.2 + resolution: "prettier@npm:2.8.2" bin: prettier: bin-prettier.js - checksum: 72004ce0cc9bb097daf3e3833f62495768724392c1d5b178dd47372337616e9e50ecbb0804f236596223f7b5eb1bbe69cefc8957dca21112c5777e77ef73a564 + checksum: 740c56c2128d587d656ea1dde9bc9c3503dfc94db4f3ac387259215eeb2e216680bdad9d18a0c9feecc6b42cfa188d6fa777df4c36c1d00cedd4199074fbfbd2 languageName: node linkType: hard @@ -3280,6 +3299,13 @@ __metadata: languageName: node linkType: hard +"regenerator-runtime@npm:^0.13.11": + version: 0.13.11 + resolution: "regenerator-runtime@npm:0.13.11" + checksum: 27481628d22a1c4e3ff551096a683b424242a216fee44685467307f14d58020af1e19660bf2e26064de946bad7eff28950eae9f8209d55723e2d9351e632bbb4 + languageName: node + linkType: hard + "regenerator-runtime@npm:^0.13.4": version: 0.13.9 resolution: "regenerator-runtime@npm:0.13.9" @@ -3466,14 +3492,14 @@ __metadata: languageName: node linkType: hard -"shiki@npm:^0.11.1": - version: 0.11.1 - resolution: "shiki@npm:0.11.1" +"shiki@npm:^0.12.1": + version: 0.12.1 + resolution: "shiki@npm:0.12.1" dependencies: - jsonc-parser: ^3.0.0 - vscode-oniguruma: ^1.6.1 - vscode-textmate: ^6.0.0 - checksum: 2a4ebc3b466816263fc244ae4f67a4ff96aa74d863b9c5e7e4affc50f37fd6d1a781405de0dbf763b777bc33e49a0d441de7ff3fededb8b01e3b8dbb37e2927d + jsonc-parser: ^3.2.0 + vscode-oniguruma: ^1.7.0 + vscode-textmate: ^8.0.0 + checksum: a5d78a79d282f5c5168786980c66e82f075e91fa015097456486624fc5775688d685ad9b1972b0617d7f1ef50927d21b61dca476247a6f6c6b7042046e89a979 languageName: node linkType: hard @@ -3889,20 +3915,20 @@ __metadata: languageName: node linkType: hard -"tsx@npm:3.12.1": - version: 3.12.1 - resolution: "tsx@npm:3.12.1" +"tsx@npm:3.12.2": + version: 3.12.2 + resolution: "tsx@npm:3.12.2" dependencies: - "@esbuild-kit/cjs-loader": ^2.4.0 + "@esbuild-kit/cjs-loader": ^2.4.1 "@esbuild-kit/core-utils": ^3.0.0 - "@esbuild-kit/esm-loader": ^2.5.0 + "@esbuild-kit/esm-loader": ^2.5.4 fsevents: ~2.3.2 dependenciesMeta: fsevents: optional: true bin: tsx: dist/cli.js - checksum: 7251ad550b82cc95716599b5f4fc8825d3896722f30ee6abfff5e5dd63b9ba8ad1c41fefbf27657ff5375f71bb69fb2b001dfe87f1f81e5d017b55616e1691cb + checksum: c227512ed7b480bd295c5420c560ec8311a4827b92e8040b7ca519627c7e1d35d48c25b26b4b11277cc437bba98696149f5148a9a06334f37b48bbaa870bff64 languageName: node linkType: hard @@ -3944,14 +3970,14 @@ __metadata: languageName: node linkType: hard -"typedoc-plugin-markdown@npm:3.13.6": - version: 3.13.6 - resolution: "typedoc-plugin-markdown@npm:3.13.6" +"typedoc-plugin-markdown@npm:3.14.0": + version: 3.14.0 + resolution: "typedoc-plugin-markdown@npm:3.14.0" dependencies: handlebars: ^4.7.7 peerDependencies: typedoc: ">=0.23.0" - checksum: eae59997759f485b2a6f2c306dc6de47dc0b008acc4651d66a24b8ba31fc7fd7729b69ba0b1235aaab268931701510ef5af88588f9b3ea124166a2ca7b63f954 + checksum: 6205600052185b4b193ab8a253d9df5ccbc95002c948a07f9024bcd26f0f23fbcc089fda4d6b4c8f4172f4eaca2bf9c32129989f6baaace7261cf4a0e41c976b languageName: node linkType: hard @@ -3964,39 +3990,39 @@ __metadata: languageName: node linkType: hard -"typedoc@npm:0.23.21": - version: 0.23.21 - resolution: "typedoc@npm:0.23.21" +"typedoc@npm:0.23.24": + version: 0.23.24 + resolution: "typedoc@npm:0.23.24" dependencies: lunr: ^2.3.9 - marked: ^4.0.19 - minimatch: ^5.1.0 - shiki: ^0.11.1 + marked: ^4.2.5 + minimatch: ^5.1.2 + shiki: ^0.12.1 peerDependencies: typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x bin: typedoc: bin/typedoc - checksum: 931520b21ae25ba8ea86111ea7c66f474468bb83cbe1d04c0ea19490f130ea44ba58b7ee4d12f7f02368cfe053ed1fa291c8843c466c8af383ef956de177360d + checksum: b04f9afcba9a38d35631b08ca345f52700f9138f59b9729d7bfecf127c2a75dd6a053594db68f3141e4d7e63b701ffa5421cbdeb95f86b254257e05e240f4da0 languageName: node linkType: hard -"typescript@npm:^4.9.3": - version: 4.9.3 - resolution: "typescript@npm:4.9.3" +"typescript@npm:next": + version: 5.0.0-dev.20230109 + resolution: "typescript@npm:5.0.0-dev.20230109" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: 17b8f816050b412403e38d48eef0e893deb6be522d6dc7caf105e54a72e34daf6835c447735fd2b28b66784e72bfbf87f627abb4818a8e43d1fa8106396128dc + checksum: 9068d5a62d844c5283f74cd3ef7c574f5250e7993e4703034ff49117d67764ff7ce87110a8127061e3a03e3f1b2dff21d743b2f90f86c12655b3f007d0bca8b2 languageName: node linkType: hard -"typescript@patch:typescript@^4.9.3#~builtin": - version: 4.9.3 - resolution: "typescript@patch:typescript@npm%3A4.9.3#~builtin::version=4.9.3&hash=a1c5e5" +"typescript@patch:typescript@next#~builtin": + version: 5.0.0-dev.20230109 + resolution: "typescript@patch:typescript@npm%3A5.0.0-dev.20230109#~builtin::version=5.0.0-dev.20230109&hash=a1c5e5" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: ef65c22622d864497d0a0c5db693523329b3284c15fe632e93ad9aa059e8dc38ef3bd767d6f26b1e5ecf9446f49bd0f6c4e5714a2eeaf352805dc002479843d1 + checksum: d4f24bb2f20dc783db94375fa25cd25947f0904e7d36bf2c040c4c99ad75af1b418e3542e399bcabd59a59f482852e4fe839642ea5900d434ef2cefcf0b6f465 languageName: node linkType: hard @@ -4063,17 +4089,17 @@ __metadata: languageName: node linkType: hard -"vscode-oniguruma@npm:^1.6.1": - version: 1.6.2 - resolution: "vscode-oniguruma@npm:1.6.2" - checksum: 6b754acdafd5b68242ea5938bb00a32effc16c77f471d4f0f337d879d0e8e592622998e2441f42d9a7ff799c1593f31c11f26ca8d9bf9917e3ca881d3c1f3e19 +"vscode-oniguruma@npm:^1.7.0": + version: 1.7.0 + resolution: "vscode-oniguruma@npm:1.7.0" + checksum: 53519d91d90593e6fb080260892e87d447e9b200c4964d766772b5053f5699066539d92100f77f1302c91e8fc5d9c772fbe40fe4c90f3d411a96d5a9b1e63f42 languageName: node linkType: hard -"vscode-textmate@npm:^6.0.0": - version: 6.0.0 - resolution: "vscode-textmate@npm:6.0.0" - checksum: ff6f17a406c2906586afc14ef01cb122e33acd35312e815abb5c924347a777c6783ce3fe7db8b83f1760ebf843c669843b9390f905b69c433b3395af28e4b483 +"vscode-textmate@npm:^8.0.0": + version: 8.0.0 + resolution: "vscode-textmate@npm:8.0.0" + checksum: 127780dfea89559d70b8326df6ec344cfd701312dd7f3f591a718693812b7852c30b6715e3cfc8b3200a4e2515b4c96f0843c0eacc0a3020969b5de262c2a4bb languageName: node linkType: hard @@ -4311,9 +4337,9 @@ __metadata: languageName: node linkType: hard -"zod@npm:^3.19.1": - version: 3.19.1 - resolution: "zod@npm:3.19.1" - checksum: 56e420ea5845912324a8fc61833714a2aec84954e418b52660d76502183c6e62fef9447cbfa64349640c5ce190cf2c24267e006bb80f066183e2f3fa9fe11864 +"zod@npm:^3.20.2": + version: 3.20.2 + resolution: "zod@npm:3.20.2" + checksum: 04172f7e9350372684ccd298d4716908edc9113751295b6c4e1b3ea84e2af8997e504b33ba36f4741417bb2a5dc90bfd40501f6b0e7389df10e42a63d6d8366c languageName: node linkType: hard From 4b6e66820aafab1bd5be3f0be80e226a8f0a916b Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 14:02:28 +0000 Subject: [PATCH 09/33] docs(changeset): Converted to .ts imports, added some byte helper fns (from hop-go) --- .changeset/empty-planes-rhyme.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/empty-planes-rhyme.md diff --git a/.changeset/empty-planes-rhyme.md b/.changeset/empty-planes-rhyme.md new file mode 100644 index 00000000..f119364f --- /dev/null +++ b/.changeset/empty-planes-rhyme.md @@ -0,0 +1,5 @@ +--- +'@onehop/js': patch +--- + +Converted to .ts imports, added some byte helper fns (from hop-go) From 5a1da2bb55c42abee3022ab910e6693d4cb22597 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 14:02:37 +0000 Subject: [PATCH 10/33] small changes --- src/sdks/create.ts | 2 +- src/util/size.ts | 21 +++++++++++++++++---- src/utils/zod/ids.ts | 2 +- tsconfig.json | 2 +- 4 files changed, 20 insertions(+), 7 deletions(-) diff --git a/src/sdks/create.ts b/src/sdks/create.ts index c9c2082e..1fd21269 100644 --- a/src/sdks/create.ts +++ b/src/sdks/create.ts @@ -1,5 +1,5 @@ import {APIClient} from '../rest/index.ts'; -export function sdk(builder: (client: APIClient) => T) { +export function sdk(builder: (client: APIClient) => T) { return builder; } diff --git a/src/util/size.ts b/src/util/size.ts index 74b02f89..3b5dd5d7 100644 --- a/src/util/size.ts +++ b/src/util/size.ts @@ -1,8 +1,5 @@ export const byteUnits = ['GB', 'MB', 'KB', 'B'] as const; - -export type ByteUnit = - | typeof byteUnits[number] - | Uppercase; +export type ByteUnit = typeof byteUnits[number]; export type ByteSizeString = `${number}${ByteUnit}`; @@ -26,6 +23,22 @@ const multipliers: Record = { GB: 1024 * 1024 * 1024, }; +export function bytes(size: number, unit: ByteUnit = 'B'): ByteSizeString { + return `${size}${unit}`; +} + +export function kilobytes(size: number): ByteSizeString { + return bytes(size, 'KB'); +} + +export function megabytes(size: number): ByteSizeString { + return bytes(size, 'MB'); +} + +export function gigabytes(size: number): ByteSizeString { + return bytes(size, 'GB'); +} + /** * Parses a byte size string into bytes * @param size The size of anything in gigabytes, megabytes, kilobytes or bytes diff --git a/src/utils/zod/ids.ts b/src/utils/zod/ids.ts index d83990cc..2d881ee4 100644 --- a/src/utils/zod/ids.ts +++ b/src/utils/zod/ids.ts @@ -20,6 +20,6 @@ export function hopId(prefix: Prefix) { .string() .refine( (value): value is Id => validateId(value, prefix), - `Id must be a valid ${prefix} id`, + `Id must be a valid \`${prefix}\` id`, ); } diff --git a/tsconfig.json b/tsconfig.json index 8073f868..0d8215cc 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -22,5 +22,5 @@ "allowImportingTsExtensions": true }, "exclude": ["node_modules", "dist"], - "include": ["./**/*.ts", "./**/*.tsx", "gen-docs.mts"] + "include": ["./**/*.ts", "./**/*.tsx"] } From 863f0aa16560e24a08173e78b71df365a873569f Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 14:56:11 +0000 Subject: [PATCH 11/33] gitignoer --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 80a4b1cb..bbb70d52 100644 --- a/.gitignore +++ b/.gitignore @@ -9,3 +9,5 @@ _workbench.ts .env .temp .next +docs + From 1d125d7722a1bcb80400e2fbdac9661b38259ca4 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 14:56:20 +0000 Subject: [PATCH 12/33] rm docs --- docs/index.md | 12 -- docs/js.anyid.md | 15 -- docs/js.api.md | 11 -- docs/js.apiauthentication.md | 15 -- docs/js.apiauthenticationprefix.md | 15 -- docs/js.apiclient._constructor_.md | 20 --- docs/js.apiclient.authtype.md | 11 -- docs/js.apiclient.delete.md | 63 -------- docs/js.apiclient.get.md | 163 --------------------- docs/js.apiclient.getauthtype.md | 22 --- docs/js.apiclient.md | 39 ----- docs/js.apiclient.patch.md | 46 ------ docs/js.apiclient.post.md | 128 ---------------- docs/js.apiclient.put.md | 59 -------- docs/js.apiclient.raw.md | 22 --- docs/js.apiclient.url.md | 11 -- docs/js.apiclientoptions.authentication.md | 11 -- docs/js.apiclientoptions.baseurl.md | 11 -- docs/js.apiclientoptions.md | 21 --- docs/js.apiresponse.md | 13 -- docs/js.assertid.md | 26 ---- docs/js.auth.md | 21 --- docs/js.auth.password.md | 11 -- docs/js.auth.username.md | 11 -- docs/js.broad_permissions_map.md | 25 ---- docs/js.build.deployment_id.md | 13 -- docs/js.build.digest.md | 13 -- docs/js.build.finished_at.md | 13 -- docs/js.build.id.md | 13 -- docs/js.build.md | 27 ---- docs/js.build.metadata.md | 13 -- docs/js.build.method.md | 13 -- docs/js.build.started_at.md | 13 -- docs/js.build.state.md | 13 -- docs/js.buildmetadata.account_type.md | 13 -- docs/js.buildmetadata.author.md | 16 -- docs/js.buildmetadata.branch.md | 13 -- docs/js.buildmetadata.commit_msg.md | 13 -- docs/js.buildmetadata.commit_sha.md | 13 -- docs/js.buildmetadata.commit_url.md | 13 -- docs/js.buildmetadata.md | 27 ---- docs/js.buildmetadata.repo_id.md | 13 -- docs/js.buildmetadata.repo_name.md | 13 -- docs/js.buildmethod.md | 21 --- docs/js.buildstate.md | 21 --- docs/js.bytesizestring.md | 13 -- docs/js.bytestring.md | 17 --- docs/js.byteunit.md | 13 -- docs/js.byteunits.md | 11 -- docs/js.channel.capabilities.md | 13 -- docs/js.channel.created_at.md | 13 -- docs/js.channel.id.md | 13 -- docs/js.channel.md | 23 --- docs/js.channel.project.md | 13 -- docs/js.channel.state.md | 13 -- docs/js.channel.type.md | 13 -- docs/js.channelendpoints.md | 52 ------- docs/js.channels.md | 55 ------- docs/js.channeltoken.id.md | 13 -- docs/js.channeltoken.is_online.md | 13 -- docs/js.channeltoken.md | 21 --- docs/js.channeltoken.project_id.md | 13 -- docs/js.channeltoken.state.md | 13 -- docs/js.channeltype.md | 20 --- docs/js.container.created_at.md | 13 -- docs/js.container.deployment_id.md | 13 -- docs/js.container.id.md | 13 -- docs/js.container.internal_ip.md | 13 -- docs/js.container.md | 27 ---- docs/js.container.metadata.md | 15 -- docs/js.container.region.md | 13 -- docs/js.container.state.md | 13 -- docs/js.container.type.md | 13 -- docs/js.container.uptime.md | 15 -- docs/js.container.volume.md | 13 -- docs/js.containerlog.level.md | 13 -- docs/js.containerlog.md | 23 --- docs/js.containerlog.message.md | 13 -- docs/js.containerlog.nonce.md | 13 -- docs/js.containerlog.timestamp.md | 13 -- docs/js.containerstate.md | 25 ---- docs/js.default_base_url.md | 13 -- docs/js.defaultquotas.md | 19 --- docs/js.defaultquotas.ram.md | 11 -- docs/js.defaultquotas.vcpu.md | 11 -- docs/js.deliveryprotocol.md | 11 -- docs/js.deployment.active_build.md | 13 -- docs/js.deployment.active_rollout.md | 13 -- docs/js.deployment.config.md | 13 -- docs/js.deployment.container_count.md | 13 -- docs/js.deployment.created_at.md | 13 -- docs/js.deployment.id.md | 13 -- docs/js.deployment.md | 24 --- docs/js.deployment.name.md | 13 -- docs/js.deploymentconfig.md | 25 ---- docs/js.deploymentrollout.md | 22 --- docs/js.domain.created_at.md | 13 -- docs/js.domain.domain.md | 13 -- docs/js.domain.id.md | 13 -- docs/js.domain.md | 21 --- docs/js.domain.state.md | 13 -- docs/js.domainstate.md | 20 --- docs/js.empty.md | 13 -- docs/js.endpoint.md | 18 --- docs/js.endpoints.md | 13 -- docs/js.erroredapiresponse.md | 17 --- docs/js.extractrouteparams.md | 19 --- docs/js.gateway.created_at.md | 13 -- docs/js.gateway.deployment_id.md | 13 -- docs/js.gateway.domains.md | 13 -- docs/js.gateway.hopsh_domain.md | 13 -- docs/js.gateway.id.md | 13 -- docs/js.gateway.internal_domain.md | 13 -- docs/js.gateway.md | 28 ---- docs/js.gateway.name.md | 13 -- docs/js.gateway.target_port.md | 13 -- docs/js.gateway.type.md | 13 -- docs/js.gatewaytype.md | 21 --- docs/js.getidprefix.md | 27 ---- docs/js.ghrepo.account_name.md | 11 -- docs/js.ghrepo.default_branch.md | 11 -- docs/js.ghrepo.full_name.md | 11 -- docs/js.ghrepo.id.md | 11 -- docs/js.ghrepo.md | 24 --- docs/js.ghrepo.private.md | 11 -- docs/js.hop._constructor_.md | 20 --- docs/js.hop._constructor__1.md | 21 --- docs/js.hop.channels.md | 53 ------- docs/js.hop.client.md | 11 -- docs/js.hop.ignite.md | 85 ----------- docs/js.hop.md | 41 ------ docs/js.hop.pipe.md | 30 ---- docs/js.hop.projects.md | 33 ----- docs/js.hop.registry.md | 24 --- docs/js.hop.users.md | 25 ---- docs/js.hopapierror._constructor_.md | 22 --- docs/js.hopapierror.data.md | 11 -- docs/js.hopapierror.md | 30 ---- docs/js.hopapierror.request.md | 11 -- docs/js.hopapierror.response.md | 11 -- docs/js.hopapierror.status.md | 11 -- docs/js.hopshdomain.md | 13 -- docs/js.id.md | 15 -- docs/js.id_prefixes.md | 67 --------- docs/js.idprefixes.md | 15 -- docs/js.ignite.md | 87 ----------- docs/js.igniteendpoints.md | 46 ------ docs/js.image_2.auth.md | 13 -- docs/js.image_2.gh_repo.md | 13 -- docs/js.image_2.md | 22 --- docs/js.image_2.name.md | 13 -- docs/js.imageghrepo.branch.md | 11 -- docs/js.imageghrepo.full_name.md | 11 -- docs/js.imageghrepo.md | 22 --- docs/js.imageghrepo.repo_id.md | 11 -- docs/js.internalhopdomain.md | 13 -- docs/js.is_browser.md | 13 -- docs/js.isvalidbytestring.md | 22 --- docs/js.md | 151 ------------------- docs/js.member.md | 17 --- docs/js.memberrole.flags.md | 13 -- docs/js.memberrole.id.md | 13 -- docs/js.memberrole.md | 20 --- docs/js.memberrole.name.md | 13 -- docs/js.method.md | 13 -- docs/js.parsesize.md | 24 --- docs/js.partialapioptions.md | 15 -- docs/js.pat.created_at.md | 13 -- docs/js.pat.id.md | 13 -- docs/js.pat.md | 20 --- docs/js.pat.name.md | 13 -- docs/js.permissions.md | 17 --- docs/js.permissionsmap.md | 58 -------- docs/js.pipe.md | 32 ---- docs/js.pipeendpoints.md | 28 ---- docs/js.project.created_at.md | 13 -- docs/js.project.default_quotas.md | 11 -- docs/js.project.icon.md | 13 -- docs/js.project.id.md | 13 -- docs/js.project.md | 27 ---- docs/js.project.name.md | 13 -- docs/js.project.namespace.md | 13 -- docs/js.project.quota_overrides.md | 11 -- docs/js.project.quota_usage.md | 11 -- docs/js.project.tier.md | 13 -- docs/js.project.type.md | 13 -- docs/js.project_permission.md | 63 -------- docs/js.projects.md | 35 ----- docs/js.projectsendpoints.md | 43 ------ docs/js.projecttier.md | 19 --- docs/js.projecttoken.created_at.md | 13 -- docs/js.projecttoken.flags.md | 13 -- docs/js.projecttoken.id.md | 13 -- docs/js.projecttoken.md | 23 --- docs/js.projecttoken.token.md | 13 -- docs/js.projecttype.md | 21 --- docs/js.query.md | 15 -- docs/js.quotaoverrides.md | 11 -- docs/js.quotausage.md | 19 --- docs/js.quotausage.ram.md | 11 -- docs/js.quotausage.vcpu.md | 11 -- docs/js.regions.md | 18 --- docs/js.registry.md | 26 ---- docs/js.registryendpoints.md | 24 --- docs/js.resources.md | 22 --- docs/js.resources.ram.md | 13 -- docs/js.resources.vcpu.md | 13 -- docs/js.resources.vgpu.md | 13 -- docs/js.restartpolicy.md | 22 --- docs/js.roles.md | 18 --- docs/js.rolloutstate.md | 22 --- docs/js.room.created_at.md | 13 -- docs/js.room.delivery_protocols.md | 13 -- docs/js.room.id.md | 13 -- docs/js.room.ingest_endpoint.md | 13 -- docs/js.room.ingest_protocol.md | 13 -- docs/js.room.ingest_region.md | 13 -- docs/js.room.join_token.md | 13 -- docs/js.room.md | 26 ---- docs/js.room.name.md | 13 -- docs/js.room.state.md | 13 -- docs/js.runtimetype.md | 22 --- docs/js.secret.created_at.md | 13 -- docs/js.secret.digest.md | 13 -- docs/js.secret.id.md | 13 -- docs/js.secret.md | 21 --- docs/js.secret.name.md | 13 -- docs/js.setstateaction.md | 15 -- docs/js.state.md | 11 -- docs/js.successfulapiresponse.md | 14 -- docs/js.supports_intl.md | 13 -- docs/js.tag.md | 15 -- docs/js.timestamp.md | 15 -- docs/js.units.md | 16 -- docs/js.user.email.md | 13 -- docs/js.user.id.md | 13 -- docs/js.user.md | 23 --- docs/js.user.name.md | 13 -- docs/js.user.username.md | 13 -- docs/js.userendpoints.md | 24 --- docs/js.users.md | 27 ---- docs/js.validateapiauthentication.md | 26 ---- docs/js.validateid.md | 27 ---- docs/js.validateidprefix.md | 27 ---- docs/js.vgpu.count.md | 13 -- docs/js.vgpu.md | 21 --- docs/js.vgpu.type.md | 13 -- docs/js.vgputype.md | 20 --- docs/js.volumedefinition.fs.md | 13 -- docs/js.volumedefinition.md | 20 --- docs/js.volumedefinition.mount_path.md | 13 -- docs/js.volumedefinition.size.md | 13 -- docs/js.volumeformat.md | 19 --- 253 files changed, 5069 deletions(-) delete mode 100644 docs/index.md delete mode 100644 docs/js.anyid.md delete mode 100644 docs/js.api.md delete mode 100644 docs/js.apiauthentication.md delete mode 100644 docs/js.apiauthenticationprefix.md delete mode 100644 docs/js.apiclient._constructor_.md delete mode 100644 docs/js.apiclient.authtype.md delete mode 100644 docs/js.apiclient.delete.md delete mode 100644 docs/js.apiclient.get.md delete mode 100644 docs/js.apiclient.getauthtype.md delete mode 100644 docs/js.apiclient.md delete mode 100644 docs/js.apiclient.patch.md delete mode 100644 docs/js.apiclient.post.md delete mode 100644 docs/js.apiclient.put.md delete mode 100644 docs/js.apiclient.raw.md delete mode 100644 docs/js.apiclient.url.md delete mode 100644 docs/js.apiclientoptions.authentication.md delete mode 100644 docs/js.apiclientoptions.baseurl.md delete mode 100644 docs/js.apiclientoptions.md delete mode 100644 docs/js.apiresponse.md delete mode 100644 docs/js.assertid.md delete mode 100644 docs/js.auth.md delete mode 100644 docs/js.auth.password.md delete mode 100644 docs/js.auth.username.md delete mode 100644 docs/js.broad_permissions_map.md delete mode 100644 docs/js.build.deployment_id.md delete mode 100644 docs/js.build.digest.md delete mode 100644 docs/js.build.finished_at.md delete mode 100644 docs/js.build.id.md delete mode 100644 docs/js.build.md delete mode 100644 docs/js.build.metadata.md delete mode 100644 docs/js.build.method.md delete mode 100644 docs/js.build.started_at.md delete mode 100644 docs/js.build.state.md delete mode 100644 docs/js.buildmetadata.account_type.md delete mode 100644 docs/js.buildmetadata.author.md delete mode 100644 docs/js.buildmetadata.branch.md delete mode 100644 docs/js.buildmetadata.commit_msg.md delete mode 100644 docs/js.buildmetadata.commit_sha.md delete mode 100644 docs/js.buildmetadata.commit_url.md delete mode 100644 docs/js.buildmetadata.md delete mode 100644 docs/js.buildmetadata.repo_id.md delete mode 100644 docs/js.buildmetadata.repo_name.md delete mode 100644 docs/js.buildmethod.md delete mode 100644 docs/js.buildstate.md delete mode 100644 docs/js.bytesizestring.md delete mode 100644 docs/js.bytestring.md delete mode 100644 docs/js.byteunit.md delete mode 100644 docs/js.byteunits.md delete mode 100644 docs/js.channel.capabilities.md delete mode 100644 docs/js.channel.created_at.md delete mode 100644 docs/js.channel.id.md delete mode 100644 docs/js.channel.md delete mode 100644 docs/js.channel.project.md delete mode 100644 docs/js.channel.state.md delete mode 100644 docs/js.channel.type.md delete mode 100644 docs/js.channelendpoints.md delete mode 100644 docs/js.channels.md delete mode 100644 docs/js.channeltoken.id.md delete mode 100644 docs/js.channeltoken.is_online.md delete mode 100644 docs/js.channeltoken.md delete mode 100644 docs/js.channeltoken.project_id.md delete mode 100644 docs/js.channeltoken.state.md delete mode 100644 docs/js.channeltype.md delete mode 100644 docs/js.container.created_at.md delete mode 100644 docs/js.container.deployment_id.md delete mode 100644 docs/js.container.id.md delete mode 100644 docs/js.container.internal_ip.md delete mode 100644 docs/js.container.md delete mode 100644 docs/js.container.metadata.md delete mode 100644 docs/js.container.region.md delete mode 100644 docs/js.container.state.md delete mode 100644 docs/js.container.type.md delete mode 100644 docs/js.container.uptime.md delete mode 100644 docs/js.container.volume.md delete mode 100644 docs/js.containerlog.level.md delete mode 100644 docs/js.containerlog.md delete mode 100644 docs/js.containerlog.message.md delete mode 100644 docs/js.containerlog.nonce.md delete mode 100644 docs/js.containerlog.timestamp.md delete mode 100644 docs/js.containerstate.md delete mode 100644 docs/js.default_base_url.md delete mode 100644 docs/js.defaultquotas.md delete mode 100644 docs/js.defaultquotas.ram.md delete mode 100644 docs/js.defaultquotas.vcpu.md delete mode 100644 docs/js.deliveryprotocol.md delete mode 100644 docs/js.deployment.active_build.md delete mode 100644 docs/js.deployment.active_rollout.md delete mode 100644 docs/js.deployment.config.md delete mode 100644 docs/js.deployment.container_count.md delete mode 100644 docs/js.deployment.created_at.md delete mode 100644 docs/js.deployment.id.md delete mode 100644 docs/js.deployment.md delete mode 100644 docs/js.deployment.name.md delete mode 100644 docs/js.deploymentconfig.md delete mode 100644 docs/js.deploymentrollout.md delete mode 100644 docs/js.domain.created_at.md delete mode 100644 docs/js.domain.domain.md delete mode 100644 docs/js.domain.id.md delete mode 100644 docs/js.domain.md delete mode 100644 docs/js.domain.state.md delete mode 100644 docs/js.domainstate.md delete mode 100644 docs/js.empty.md delete mode 100644 docs/js.endpoint.md delete mode 100644 docs/js.endpoints.md delete mode 100644 docs/js.erroredapiresponse.md delete mode 100644 docs/js.extractrouteparams.md delete mode 100644 docs/js.gateway.created_at.md delete mode 100644 docs/js.gateway.deployment_id.md delete mode 100644 docs/js.gateway.domains.md delete mode 100644 docs/js.gateway.hopsh_domain.md delete mode 100644 docs/js.gateway.id.md delete mode 100644 docs/js.gateway.internal_domain.md delete mode 100644 docs/js.gateway.md delete mode 100644 docs/js.gateway.name.md delete mode 100644 docs/js.gateway.target_port.md delete mode 100644 docs/js.gateway.type.md delete mode 100644 docs/js.gatewaytype.md delete mode 100644 docs/js.getidprefix.md delete mode 100644 docs/js.ghrepo.account_name.md delete mode 100644 docs/js.ghrepo.default_branch.md delete mode 100644 docs/js.ghrepo.full_name.md delete mode 100644 docs/js.ghrepo.id.md delete mode 100644 docs/js.ghrepo.md delete mode 100644 docs/js.ghrepo.private.md delete mode 100644 docs/js.hop._constructor_.md delete mode 100644 docs/js.hop._constructor__1.md delete mode 100644 docs/js.hop.channels.md delete mode 100644 docs/js.hop.client.md delete mode 100644 docs/js.hop.ignite.md delete mode 100644 docs/js.hop.md delete mode 100644 docs/js.hop.pipe.md delete mode 100644 docs/js.hop.projects.md delete mode 100644 docs/js.hop.registry.md delete mode 100644 docs/js.hop.users.md delete mode 100644 docs/js.hopapierror._constructor_.md delete mode 100644 docs/js.hopapierror.data.md delete mode 100644 docs/js.hopapierror.md delete mode 100644 docs/js.hopapierror.request.md delete mode 100644 docs/js.hopapierror.response.md delete mode 100644 docs/js.hopapierror.status.md delete mode 100644 docs/js.hopshdomain.md delete mode 100644 docs/js.id.md delete mode 100644 docs/js.id_prefixes.md delete mode 100644 docs/js.idprefixes.md delete mode 100644 docs/js.ignite.md delete mode 100644 docs/js.igniteendpoints.md delete mode 100644 docs/js.image_2.auth.md delete mode 100644 docs/js.image_2.gh_repo.md delete mode 100644 docs/js.image_2.md delete mode 100644 docs/js.image_2.name.md delete mode 100644 docs/js.imageghrepo.branch.md delete mode 100644 docs/js.imageghrepo.full_name.md delete mode 100644 docs/js.imageghrepo.md delete mode 100644 docs/js.imageghrepo.repo_id.md delete mode 100644 docs/js.internalhopdomain.md delete mode 100644 docs/js.is_browser.md delete mode 100644 docs/js.isvalidbytestring.md delete mode 100644 docs/js.md delete mode 100644 docs/js.member.md delete mode 100644 docs/js.memberrole.flags.md delete mode 100644 docs/js.memberrole.id.md delete mode 100644 docs/js.memberrole.md delete mode 100644 docs/js.memberrole.name.md delete mode 100644 docs/js.method.md delete mode 100644 docs/js.parsesize.md delete mode 100644 docs/js.partialapioptions.md delete mode 100644 docs/js.pat.created_at.md delete mode 100644 docs/js.pat.id.md delete mode 100644 docs/js.pat.md delete mode 100644 docs/js.pat.name.md delete mode 100644 docs/js.permissions.md delete mode 100644 docs/js.permissionsmap.md delete mode 100644 docs/js.pipe.md delete mode 100644 docs/js.pipeendpoints.md delete mode 100644 docs/js.project.created_at.md delete mode 100644 docs/js.project.default_quotas.md delete mode 100644 docs/js.project.icon.md delete mode 100644 docs/js.project.id.md delete mode 100644 docs/js.project.md delete mode 100644 docs/js.project.name.md delete mode 100644 docs/js.project.namespace.md delete mode 100644 docs/js.project.quota_overrides.md delete mode 100644 docs/js.project.quota_usage.md delete mode 100644 docs/js.project.tier.md delete mode 100644 docs/js.project.type.md delete mode 100644 docs/js.project_permission.md delete mode 100644 docs/js.projects.md delete mode 100644 docs/js.projectsendpoints.md delete mode 100644 docs/js.projecttier.md delete mode 100644 docs/js.projecttoken.created_at.md delete mode 100644 docs/js.projecttoken.flags.md delete mode 100644 docs/js.projecttoken.id.md delete mode 100644 docs/js.projecttoken.md delete mode 100644 docs/js.projecttoken.token.md delete mode 100644 docs/js.projecttype.md delete mode 100644 docs/js.query.md delete mode 100644 docs/js.quotaoverrides.md delete mode 100644 docs/js.quotausage.md delete mode 100644 docs/js.quotausage.ram.md delete mode 100644 docs/js.quotausage.vcpu.md delete mode 100644 docs/js.regions.md delete mode 100644 docs/js.registry.md delete mode 100644 docs/js.registryendpoints.md delete mode 100644 docs/js.resources.md delete mode 100644 docs/js.resources.ram.md delete mode 100644 docs/js.resources.vcpu.md delete mode 100644 docs/js.resources.vgpu.md delete mode 100644 docs/js.restartpolicy.md delete mode 100644 docs/js.roles.md delete mode 100644 docs/js.rolloutstate.md delete mode 100644 docs/js.room.created_at.md delete mode 100644 docs/js.room.delivery_protocols.md delete mode 100644 docs/js.room.id.md delete mode 100644 docs/js.room.ingest_endpoint.md delete mode 100644 docs/js.room.ingest_protocol.md delete mode 100644 docs/js.room.ingest_region.md delete mode 100644 docs/js.room.join_token.md delete mode 100644 docs/js.room.md delete mode 100644 docs/js.room.name.md delete mode 100644 docs/js.room.state.md delete mode 100644 docs/js.runtimetype.md delete mode 100644 docs/js.secret.created_at.md delete mode 100644 docs/js.secret.digest.md delete mode 100644 docs/js.secret.id.md delete mode 100644 docs/js.secret.md delete mode 100644 docs/js.secret.name.md delete mode 100644 docs/js.setstateaction.md delete mode 100644 docs/js.state.md delete mode 100644 docs/js.successfulapiresponse.md delete mode 100644 docs/js.supports_intl.md delete mode 100644 docs/js.tag.md delete mode 100644 docs/js.timestamp.md delete mode 100644 docs/js.units.md delete mode 100644 docs/js.user.email.md delete mode 100644 docs/js.user.id.md delete mode 100644 docs/js.user.md delete mode 100644 docs/js.user.name.md delete mode 100644 docs/js.user.username.md delete mode 100644 docs/js.userendpoints.md delete mode 100644 docs/js.users.md delete mode 100644 docs/js.validateapiauthentication.md delete mode 100644 docs/js.validateid.md delete mode 100644 docs/js.validateidprefix.md delete mode 100644 docs/js.vgpu.count.md delete mode 100644 docs/js.vgpu.md delete mode 100644 docs/js.vgpu.type.md delete mode 100644 docs/js.vgputype.md delete mode 100644 docs/js.volumedefinition.fs.md delete mode 100644 docs/js.volumedefinition.md delete mode 100644 docs/js.volumedefinition.mount_path.md delete mode 100644 docs/js.volumedefinition.size.md delete mode 100644 docs/js.volumeformat.md diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 68578b1b..00000000 --- a/docs/index.md +++ /dev/null @@ -1,12 +0,0 @@ - - -[Home](./index.md) - -## API Reference - -## Packages - -| Package | Description | -| --- | --- | -| [@onehop/js](./js.md) | | - diff --git a/docs/js.anyid.md b/docs/js.anyid.md deleted file mode 100644 index c6817324..00000000 --- a/docs/js.anyid.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [AnyId](./js.anyid.md) - -## AnyId type - -Any/all IDs that are used within the API - -Signature: - -```typescript -declare type AnyId = Id; -``` -References: [Id](./js.id.md), [IdPrefixes](./js.idprefixes.md) - diff --git a/docs/js.api.md b/docs/js.api.md deleted file mode 100644 index 3416e85f..00000000 --- a/docs/js.api.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [API](./js.api.md) - -## API namespace - -Signature: - -```typescript -declare namespace api -``` diff --git a/docs/js.apiauthentication.md b/docs/js.apiauthentication.md deleted file mode 100644 index a146ff9c..00000000 --- a/docs/js.apiauthentication.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthentication](./js.apiauthentication.md) - -## APIAuthentication type - -All possible authentication ID types - -Signature: - -```typescript -declare type APIAuthentication = Id<'ptk'> | Id<'bearer'> | Id<'pat'>; -``` -References: [Id](./js.id.md) - diff --git a/docs/js.apiauthenticationprefix.md b/docs/js.apiauthenticationprefix.md deleted file mode 100644 index e0fa9370..00000000 --- a/docs/js.apiauthenticationprefix.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) - -## APIAuthenticationPrefix type - -A valid ID prefix supported by the Hop API for authetication - -Signature: - -```typescript -declare type APIAuthenticationPrefix = APIAuthentication extends Id ? T : never; -``` -References: [APIAuthentication](./js.apiauthentication.md), [Id](./js.id.md) - diff --git a/docs/js.apiclient._constructor_.md b/docs/js.apiclient._constructor_.md deleted file mode 100644 index 4d08fdcf..00000000 --- a/docs/js.apiclient._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [(constructor)](./js.apiclient._constructor_.md) - -## APIClient.(constructor) - -Constructs a new instance of the `APIClient` class - -Signature: - -```typescript -constructor(options: APIClientOptions); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [APIClientOptions](./js.apiclientoptions.md) | | - diff --git a/docs/js.apiclient.authtype.md b/docs/js.apiclient.authtype.md deleted file mode 100644 index f315c069..00000000 --- a/docs/js.apiclient.authtype.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [authType](./js.apiclient.authtype.md) - -## APIClient.authType property - -Signature: - -```typescript -readonly authType: "ptk" | "pat" | "bearer"; -``` diff --git a/docs/js.apiclient.delete.md b/docs/js.apiclient.delete.md deleted file mode 100644 index 1c3d9b4a..00000000 --- a/docs/js.apiclient.delete.md +++ /dev/null @@ -1,63 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [delete](./js.apiclient.delete.md) - -## APIClient.delete() method - -Signature: - -```typescript -delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'DELETE'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/users/@me/pats/:pat\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/tokens/:project\_token\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/:project\_id/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/projects/@this/secrets/:secret\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/:channel\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/channels/tokens/:token", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/registry/images/:image", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/deployments/:deployment\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/ignite/containers/:container\_id", void, undefined>, { path: Path; method: 'DELETE'; }> \| Extract<[Endpoint](./js.endpoint.md)<"DELETE", "/v1/pipe/rooms/:room\_id", void, undefined>, { path: Path; method: 'DELETE'; }>)\["res"\]> - diff --git a/docs/js.apiclient.get.md b/docs/js.apiclient.get.md deleted file mode 100644 index abe7d784..00000000 --- a/docs/js.apiclient.get.md +++ /dev/null @@ -1,163 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [get](./js.apiclient.get.md) - -## APIClient.get() method - -Signature: - -```typescript -get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; - leap_token: string | null; - }, undefined>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me", { projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/users/@me/pats", { pats: [PAT](./js.pat.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members/@me", { project\_member: [Member](./js.member.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/tokens", { project\_tokens: [ProjectToken](./js.projecttoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/members", { members: [Member](./js.member.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/:project\_id/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/projects/@this/secrets", { secrets: [Secret](./js.secret.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/tokens", { tokens: [ChannelToken](./js.channeltoken.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/state", { state: [State](./js.state.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels", { channels: [Channel](./js.channel.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/channels/:channel\_id/stats", { stats: { online\_count: number; }; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images", { images: string\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/registry/images/:image/manifests", { manifests: { digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments", { deployments: [Deployment](./js.deployment.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/containers", { containers: [Container](./js.container.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/containers/:container\_id/logs", { logs: [ContainerLog](./js.containerlog.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/search", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/gateways/:gateway\_id", { gateway: [Gateway](./js.gateway.md); }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/ignite/deployments/:deployment\_id/gateways", { gateways: [Gateway](./js.gateway.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }> \| Extract<[Endpoint](./js.endpoint.md)<"GET", "/v1/pipe/rooms", { rooms: [Room](./js.room.md)\[\]; }, undefined>, { path: Path; method: 'GET'; }>)\["res"\]> - diff --git a/docs/js.apiclient.getauthtype.md b/docs/js.apiclient.getauthtype.md deleted file mode 100644 index 0323dab7..00000000 --- a/docs/js.apiclient.getauthtype.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [getAuthType](./js.apiclient.getauthtype.md) - -## APIClient.getAuthType() method - -Signature: - -```typescript -static getAuthType(auth: APIAuthentication): "ptk" | "pat" | "bearer"; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | [APIAuthentication](./js.apiauthentication.md) | | - -Returns: - -"ptk" \| "pat" \| "bearer" - diff --git a/docs/js.apiclient.md b/docs/js.apiclient.md deleted file mode 100644 index 8af0e5a4..00000000 --- a/docs/js.apiclient.md +++ /dev/null @@ -1,39 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) - -## APIClient class - -API Client that is responsible for handling all requests - -Signature: - -```typescript -declare class APIClient -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./js.apiclient._constructor_.md) | | Constructs a new instance of the APIClient class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [authType](./js.apiclient.authtype.md) | readonly | "ptk" \| "pat" \| "bearer" | | -| [url](./js.apiclient.url.md) | readonly | <Path extends string>(path: Path, query: [Query](./js.query.md)<Path>) => string | | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [delete(path, body, query, init)](./js.apiclient.delete.md) | | | -| [get(path, query, init)](./js.apiclient.get.md) | | | -| [getAuthType(auth)](./js.apiclient.getauthtype.md) | static | | -| [patch(path, body, query, init)](./js.apiclient.patch.md) | | | -| [post(path, body, query, init)](./js.apiclient.post.md) | | | -| [put(path, body, query, init)](./js.apiclient.put.md) | | | -| [raw(request)](./js.apiclient.raw.md) | | | - diff --git a/docs/js.apiclient.patch.md b/docs/js.apiclient.patch.md deleted file mode 100644 index dc0439ff..00000000 --- a/docs/js.apiclient.patch.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [patch](./js.apiclient.patch.md) - -## APIClient.patch() method - -Signature: - -```typescript -patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PATCH'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/channels/tokens/:token", { token: [ChannelToken](./js.channeltoken.md); }, { expiresAt?: [Timestamp](./js.timestamp.md) \| null \| undefined; state: [State](./js.state.md); }>, { path: Path; method: 'PATCH'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PATCH", "/v1/ignite/deployments/:deployment\_id", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'PATCH'; }>)\["res"\]> - diff --git a/docs/js.apiclient.post.md b/docs/js.apiclient.post.md deleted file mode 100644 index 24f385e0..00000000 --- a/docs/js.apiclient.post.md +++ /dev/null @@ -1,128 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [post](./js.apiclient.post.md) - -## APIClient.post() method - -Signature: - -```typescript -post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract | null; - }>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'POST'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/users/@me/pats", { pat: [PAT](./js.pat.md); }, { name: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/:project\_id/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/projects/@this/tokens", { project\_token: [ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }; }, { flags: number; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens", { token: [ChannelToken](./js.channeltoken.md); }, { state: [State](./js.state.md); }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/tokens/:token/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/channels/:channel\_id/messages", void, { e: string; d: unknown; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers", { container: [Container](./js.container.md); }, undefined>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/containers/:container\_id", never, { deployment\_id: \`deployment\_${string}\`; container\_id: \`container\_${string}\`; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments", { deployment: [Deployment](./js.deployment.md); }, [DeploymentConfig](./js.deploymentconfig.md)>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/gateways/:gateway\_id/domains", void, { domain: string; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/ignite/deployments/:deployment\_id/gateways", { gateway: [Gateway](./js.gateway.md); }, { type: [GatewayType](./js.gatewaytype.md); target\_port: number; protocol: "http" \| null; }>, { path: Path; method: 'POST'; }> \| Extract<[Endpoint](./js.endpoint.md)<"POST", "/v1/pipe/rooms", { room: [Room](./js.room.md); }, { name: string; ingest\_protocol: "rtmp" \| "rtp"; delivery\_protocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; region: [Regions](./js.regions.md); ephemeral: boolean; llhls\_config?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }>, { path: Path; method: 'POST'; }>)\["res"\]> - diff --git a/docs/js.apiclient.put.md b/docs/js.apiclient.put.md deleted file mode 100644 index df948bae..00000000 --- a/docs/js.apiclient.put.md +++ /dev/null @@ -1,59 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [put](./js.apiclient.put.md) - -## APIClient.put() method - -Signature: - -```typescript -put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract | null; - }>, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }>)["res"]>; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| path | Path | | -| body | Extract<[Endpoints](./js.endpoints.md), { path: Path; method: 'PUT'; }>\['body'\] | | -| query | [Query](./js.query.md)<Path> | | -| init | RequestInit | (Optional) | - -Returns: - -Promise<(Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/:project\_id/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/projects/@this/secrets/:name", { secret: [Secret](./js.secret.md); }, string>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id", { channel: [Channel](./js.channel.md); }, { type: [ChannelType](./js.channeltype.md); state: Record<string, any> \| null; }>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/subscribers/:token", void, undefined>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/channels/:channel\_id/state", void, [State](./js.state.md)>, { path: Path; method: 'PUT'; }> \| Extract<[Endpoint](./js.endpoint.md)<"PUT", "/v1/ignite/containers/:container\_id/state", void, { preferred\_state: [ContainerState.RUNNING](./js.containerstate.md) \| [ContainerState.STOPPED](./js.containerstate.md); }>, { path: Path; method: 'PUT'; }>)\["res"\]> - diff --git a/docs/js.apiclient.raw.md b/docs/js.apiclient.raw.md deleted file mode 100644 index 68c10574..00000000 --- a/docs/js.apiclient.raw.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [raw](./js.apiclient.raw.md) - -## APIClient.raw() method - -Signature: - -```typescript -raw(request: Request): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | - -Returns: - -Promise<T> - diff --git a/docs/js.apiclient.url.md b/docs/js.apiclient.url.md deleted file mode 100644 index 72b14f7d..00000000 --- a/docs/js.apiclient.url.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClient](./js.apiclient.md) > [url](./js.apiclient.url.md) - -## APIClient.url property - -Signature: - -```typescript -readonly url: (path: Path, query: Query) => string; -``` diff --git a/docs/js.apiclientoptions.authentication.md b/docs/js.apiclientoptions.authentication.md deleted file mode 100644 index 07b6a1e5..00000000 --- a/docs/js.apiclientoptions.authentication.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [authentication](./js.apiclientoptions.authentication.md) - -## APIClientOptions.authentication property - -Signature: - -```typescript -readonly authentication: APIAuthentication; -``` diff --git a/docs/js.apiclientoptions.baseurl.md b/docs/js.apiclientoptions.baseurl.md deleted file mode 100644 index 1faa1238..00000000 --- a/docs/js.apiclientoptions.baseurl.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) > [baseUrl](./js.apiclientoptions.baseurl.md) - -## APIClientOptions.baseUrl property - -Signature: - -```typescript -readonly baseUrl: string; -``` diff --git a/docs/js.apiclientoptions.md b/docs/js.apiclientoptions.md deleted file mode 100644 index 16e9f3fa..00000000 --- a/docs/js.apiclientoptions.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIClientOptions](./js.apiclientoptions.md) - -## APIClientOptions interface - -Options passed to the API client. This will usually come from Hop\#constructor in most cases - -Signature: - -```typescript -interface APIClientOptions -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [authentication](./js.apiclientoptions.authentication.md) | readonly | [APIAuthentication](./js.apiauthentication.md) | | -| [baseUrl](./js.apiclientoptions.baseurl.md) | readonly | string | | - diff --git a/docs/js.apiresponse.md b/docs/js.apiresponse.md deleted file mode 100644 index 4cb4fbde..00000000 --- a/docs/js.apiresponse.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [APIResponse](./js.apiresponse.md) - -## APIResponse type - -Signature: - -```typescript -declare type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; -``` -References: [SuccessfulAPIResponse](./js.successfulapiresponse.md), [ErroredAPIResponse](./js.erroredapiresponse.md) - diff --git a/docs/js.assertid.md b/docs/js.assertid.md deleted file mode 100644 index d24607fe..00000000 --- a/docs/js.assertid.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [assertId](./js.assertid.md) - -## assertId() function - -Asserts that a string is a valid ID - -Signature: - -```typescript -declare function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| maybeId | string \| undefined \| null | A string that is possibly an ID | -| prefix | T \| T\[\] | (Optional) A prefix or array of prefixes to check against | -| message | string | (Optional) An error message to throw if the ID is invalid | - -Returns: - -asserts maybeId is [Id](./js.id.md)<T> - diff --git a/docs/js.auth.md b/docs/js.auth.md deleted file mode 100644 index b839dd9f..00000000 --- a/docs/js.auth.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) - -## Auth interface - -Docker image registry authorization - -Signature: - -```typescript -interface Auth -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [password](./js.auth.password.md) | | string | | -| [username](./js.auth.username.md) | | string | | - diff --git a/docs/js.auth.password.md b/docs/js.auth.password.md deleted file mode 100644 index 3856a18d..00000000 --- a/docs/js.auth.password.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [password](./js.auth.password.md) - -## Auth.password property - -Signature: - -```typescript -password: string; -``` diff --git a/docs/js.auth.username.md b/docs/js.auth.username.md deleted file mode 100644 index f837a54e..00000000 --- a/docs/js.auth.username.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Auth](./js.auth.md) > [username](./js.auth.username.md) - -## Auth.username property - -Signature: - -```typescript -username: string; -``` diff --git a/docs/js.broad_permissions_map.md b/docs/js.broad_permissions_map.md deleted file mode 100644 index 3b9c82d6..00000000 --- a/docs/js.broad_permissions_map.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) - -## BROAD\_PERMISSIONS\_MAP variable - -Broader permission map - -Signature: - -```typescript -BROAD_PERMISSIONS_MAP: { - MANAGE_MEMBERS: bigint; - MANAGE_PROJECT_TOKENS: bigint; - MANAGE_DEPLOYMENTS: bigint; - MANAGE_PIPE: bigint; - MANAGE_SECRETS: bigint; - MANAGE_CHANNELS: bigint; - MANAGE_REGISTRY: bigint; - READ_ONLY: bigint; - MANAGE_QUOTAS: bigint; - MANAGE_ROLLOUTS: bigint; - MANAGE_BILLING: bigint; -} -``` diff --git a/docs/js.build.deployment_id.md b/docs/js.build.deployment_id.md deleted file mode 100644 index 05320027..00000000 --- a/docs/js.build.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [deployment\_id](./js.build.deployment_id.md) - -## Build.deployment\_id property - -Deployment ID for build - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.build.digest.md b/docs/js.build.digest.md deleted file mode 100644 index 265b829b..00000000 --- a/docs/js.build.digest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [digest](./js.build.digest.md) - -## Build.digest property - -Digest for image - -Signature: - -```typescript -digest: string | null; -``` diff --git a/docs/js.build.finished_at.md b/docs/js.build.finished_at.md deleted file mode 100644 index 264bcbc3..00000000 --- a/docs/js.build.finished_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [finished\_at](./js.build.finished_at.md) - -## Build.finished\_at property - -Timestamp of when the build has finished - -Signature: - -```typescript -finished_at: Timestamp | null; -``` diff --git a/docs/js.build.id.md b/docs/js.build.id.md deleted file mode 100644 index ce741698..00000000 --- a/docs/js.build.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [id](./js.build.id.md) - -## Build.id property - -ID of the build - -Signature: - -```typescript -id: Id<'build'>; -``` diff --git a/docs/js.build.md b/docs/js.build.md deleted file mode 100644 index a23f6cba..00000000 --- a/docs/js.build.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) - -## Build interface - -A build entity - -Signature: - -```typescript -interface Build -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [deployment\_id](./js.build.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | Deployment ID for build | -| [digest](./js.build.digest.md) | | string \| null | Digest for image | -| [finished\_at](./js.build.finished_at.md) | | [Timestamp](./js.timestamp.md) \| null | Timestamp of when the build has finished | -| [id](./js.build.id.md) | | [Id](./js.id.md)<'build'> | ID of the build | -| [metadata](./js.build.metadata.md) | | [BuildMetaData](./js.buildmetadata.md) \| null | Metadata pertaining to build (mostly for GitHub) | -| [method](./js.build.method.md) | | [BuildMethod](./js.buildmethod.md) | Build method (GitHub or CLI) | -| [started\_at](./js.build.started_at.md) | | [Timestamp](./js.timestamp.md) | Timestamp of when the build has started | -| [state](./js.build.state.md) | | [BuildState](./js.buildstate.md) | State of the build | - diff --git a/docs/js.build.metadata.md b/docs/js.build.metadata.md deleted file mode 100644 index c41c702c..00000000 --- a/docs/js.build.metadata.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [metadata](./js.build.metadata.md) - -## Build.metadata property - -Metadata pertaining to build (mostly for GitHub) - -Signature: - -```typescript -metadata: BuildMetaData | null; -``` diff --git a/docs/js.build.method.md b/docs/js.build.method.md deleted file mode 100644 index 549e9cf5..00000000 --- a/docs/js.build.method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [method](./js.build.method.md) - -## Build.method property - -Build method (GitHub or CLI) - -Signature: - -```typescript -method: BuildMethod; -``` diff --git a/docs/js.build.started_at.md b/docs/js.build.started_at.md deleted file mode 100644 index 3d633757..00000000 --- a/docs/js.build.started_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [started\_at](./js.build.started_at.md) - -## Build.started\_at property - -Timestamp of when the build has started - -Signature: - -```typescript -started_at: Timestamp; -``` diff --git a/docs/js.build.state.md b/docs/js.build.state.md deleted file mode 100644 index 93ed8148..00000000 --- a/docs/js.build.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Build](./js.build.md) > [state](./js.build.state.md) - -## Build.state property - -State of the build - -Signature: - -```typescript -state: BuildState; -``` diff --git a/docs/js.buildmetadata.account_type.md b/docs/js.buildmetadata.account_type.md deleted file mode 100644 index a54d88f1..00000000 --- a/docs/js.buildmetadata.account_type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [account\_type](./js.buildmetadata.account_type.md) - -## BuildMetaData.account\_type property - -Account type of repo owner - -Signature: - -```typescript -account_type?: 'user' | 'organization'; -``` diff --git a/docs/js.buildmetadata.author.md b/docs/js.buildmetadata.author.md deleted file mode 100644 index 0ef445f1..00000000 --- a/docs/js.buildmetadata.author.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [author](./js.buildmetadata.author.md) - -## BuildMetaData.author property - -Author information about build - -Signature: - -```typescript -author?: { - avatar_url: string; - username: string; - }; -``` diff --git a/docs/js.buildmetadata.branch.md b/docs/js.buildmetadata.branch.md deleted file mode 100644 index 894d86c8..00000000 --- a/docs/js.buildmetadata.branch.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [branch](./js.buildmetadata.branch.md) - -## BuildMetaData.branch property - -Repo branch for build - -Signature: - -```typescript -branch: string; -``` diff --git a/docs/js.buildmetadata.commit_msg.md b/docs/js.buildmetadata.commit_msg.md deleted file mode 100644 index 82e95cdd..00000000 --- a/docs/js.buildmetadata.commit_msg.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_msg](./js.buildmetadata.commit_msg.md) - -## BuildMetaData.commit\_msg property - -commit message for build - -Signature: - -```typescript -commit_msg: string; -``` diff --git a/docs/js.buildmetadata.commit_sha.md b/docs/js.buildmetadata.commit_sha.md deleted file mode 100644 index b4d5896d..00000000 --- a/docs/js.buildmetadata.commit_sha.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_sha](./js.buildmetadata.commit_sha.md) - -## BuildMetaData.commit\_sha property - -commit SHA for build - -Signature: - -```typescript -commit_sha: string; -``` diff --git a/docs/js.buildmetadata.commit_url.md b/docs/js.buildmetadata.commit_url.md deleted file mode 100644 index fcbbe4fc..00000000 --- a/docs/js.buildmetadata.commit_url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [commit\_url](./js.buildmetadata.commit_url.md) - -## BuildMetaData.commit\_url property - -commit URL for build - -Signature: - -```typescript -commit_url?: string; -``` diff --git a/docs/js.buildmetadata.md b/docs/js.buildmetadata.md deleted file mode 100644 index cad4a2bd..00000000 --- a/docs/js.buildmetadata.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) - -## BuildMetaData interface - -Metadata attached to a build - -Signature: - -```typescript -interface BuildMetaData -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [account\_type?](./js.buildmetadata.account_type.md) | | 'user' \| 'organization' | (Optional) Account type of repo owner | -| [author?](./js.buildmetadata.author.md) | | { avatar\_url: string; username: string; } | (Optional) Author information about build | -| [branch](./js.buildmetadata.branch.md) | | string | Repo branch for build | -| [commit\_msg](./js.buildmetadata.commit_msg.md) | | string | commit message for build | -| [commit\_sha](./js.buildmetadata.commit_sha.md) | | string | commit SHA for build | -| [commit\_url?](./js.buildmetadata.commit_url.md) | | string | (Optional) commit URL for build | -| [repo\_id](./js.buildmetadata.repo_id.md) | | number | Repo ID for build | -| [repo\_name](./js.buildmetadata.repo_name.md) | | string | Repo name for build | - diff --git a/docs/js.buildmetadata.repo_id.md b/docs/js.buildmetadata.repo_id.md deleted file mode 100644 index d75d34e8..00000000 --- a/docs/js.buildmetadata.repo_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_id](./js.buildmetadata.repo_id.md) - -## BuildMetaData.repo\_id property - -Repo ID for build - -Signature: - -```typescript -repo_id: number; -``` diff --git a/docs/js.buildmetadata.repo_name.md b/docs/js.buildmetadata.repo_name.md deleted file mode 100644 index 975f39cd..00000000 --- a/docs/js.buildmetadata.repo_name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMetaData](./js.buildmetadata.md) > [repo\_name](./js.buildmetadata.repo_name.md) - -## BuildMetaData.repo\_name property - -Repo name for build - -Signature: - -```typescript -repo_name: string; -``` diff --git a/docs/js.buildmethod.md b/docs/js.buildmethod.md deleted file mode 100644 index c7523589..00000000 --- a/docs/js.buildmethod.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildMethod](./js.buildmethod.md) - -## BuildMethod enum - -Types of build methods supported by Hop - -Signature: - -```typescript -declare enum BuildMethod -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| CLI | "cli" | | -| GITHUB | "github" | | - diff --git a/docs/js.buildstate.md b/docs/js.buildstate.md deleted file mode 100644 index 709f397f..00000000 --- a/docs/js.buildstate.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [BuildState](./js.buildstate.md) - -## BuildState enum - -Signature: - -```typescript -declare enum BuildState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| CANCELLED | "cancelled" | | -| FAILED | "failed" | | -| PENDING | "pending" | | -| SUCCEEDED | "succeeded" | | - diff --git a/docs/js.bytesizestring.md b/docs/js.bytesizestring.md deleted file mode 100644 index 1242e0aa..00000000 --- a/docs/js.bytesizestring.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteSizeString](./js.bytesizestring.md) - -## ByteSizeString type - -Signature: - -```typescript -declare type ByteSizeString = `${number}${ByteUnit}`; -``` -References: [ByteUnit](./js.byteunit.md) - diff --git a/docs/js.bytestring.md b/docs/js.bytestring.md deleted file mode 100644 index 58797fc6..00000000 --- a/docs/js.bytestring.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteString](./js.bytestring.md) - -## ByteString type - -> Warning: This API is now obsolete. -> -> - -Signature: - -```typescript -declare type ByteString = ByteSizeString; -``` -References: [ByteSizeString](./js.bytesizestring.md) - diff --git a/docs/js.byteunit.md b/docs/js.byteunit.md deleted file mode 100644 index 12ed8a07..00000000 --- a/docs/js.byteunit.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ByteUnit](./js.byteunit.md) - -## ByteUnit type - -Signature: - -```typescript -declare type ByteUnit = typeof byteUnits[number] | Uppercase; -``` -References: [byteUnits](./js.byteunits.md) - diff --git a/docs/js.byteunits.md b/docs/js.byteunits.md deleted file mode 100644 index d4228c14..00000000 --- a/docs/js.byteunits.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [byteUnits](./js.byteunits.md) - -## byteUnits variable - -Signature: - -```typescript -byteUnits: readonly ["GB", "MB", "KB", "B"] -``` diff --git a/docs/js.channel.capabilities.md b/docs/js.channel.capabilities.md deleted file mode 100644 index b3ea3beb..00000000 --- a/docs/js.channel.capabilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [capabilities](./js.channel.capabilities.md) - -## Channel.capabilities property - -Capabilities of the channel - -Signature: - -```typescript -capabilities: number; -``` diff --git a/docs/js.channel.created_at.md b/docs/js.channel.created_at.md deleted file mode 100644 index 79b26d9b..00000000 --- a/docs/js.channel.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [created\_at](./js.channel.created_at.md) - -## Channel.created\_at property - -When this channel was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.channel.id.md b/docs/js.channel.id.md deleted file mode 100644 index e5171cc3..00000000 --- a/docs/js.channel.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [id](./js.channel.id.md) - -## Channel.id property - -The ID of the channel - -Signature: - -```typescript -id: string; -``` diff --git a/docs/js.channel.md b/docs/js.channel.md deleted file mode 100644 index 5c6b2553..00000000 --- a/docs/js.channel.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) - -## Channel interface - -Signature: - -```typescript -interface Channel -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [capabilities](./js.channel.capabilities.md) | | number | Capabilities of the channel | -| [created\_at](./js.channel.created_at.md) | | [Timestamp](./js.timestamp.md) | When this channel was created | -| [id](./js.channel.id.md) | | string | The ID of the channel | -| [project](./js.channel.project.md) | | [Project](./js.project.md) | The project it is associated with | -| [state](./js.channel.state.md) | | [State](./js.state.md) | State metadata | -| [type](./js.channel.type.md) | | [ChannelType](./js.channeltype.md) | The type of this channel | - diff --git a/docs/js.channel.project.md b/docs/js.channel.project.md deleted file mode 100644 index 24a252b1..00000000 --- a/docs/js.channel.project.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [project](./js.channel.project.md) - -## Channel.project property - -The project it is associated with - -Signature: - -```typescript -project: Project; -``` diff --git a/docs/js.channel.state.md b/docs/js.channel.state.md deleted file mode 100644 index 82c4daa1..00000000 --- a/docs/js.channel.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [state](./js.channel.state.md) - -## Channel.state property - -State metadata - -Signature: - -```typescript -state: State; -``` diff --git a/docs/js.channel.type.md b/docs/js.channel.type.md deleted file mode 100644 index 10abf46b..00000000 --- a/docs/js.channel.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Channel](./js.channel.md) > [type](./js.channel.type.md) - -## Channel.type property - -The type of this channel - -Signature: - -```typescript -type: ChannelType; -``` diff --git a/docs/js.channelendpoints.md b/docs/js.channelendpoints.md deleted file mode 100644 index a8b9f4b7..00000000 --- a/docs/js.channelendpoints.md +++ /dev/null @@ -1,52 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelEndpoints](./js.channelendpoints.md) - -## ChannelEndpoints type - -Signature: - -```typescript -declare type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'PUT', '/v1/channels/:channel_id', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'POST', '/v1/channels/tokens', { - token: ChannelToken; -}, { - state: State; -}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { - channel: Channel; -}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { - tokens: ChannelToken[]; -}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { - state: State; -}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'GET', '/v1/channels', { - channels: Channel[]; -}> | Endpoint<'GET', '/v1/channels/tokens/:token', { - token: ChannelToken; -}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { - token: ChannelToken; -}, { - expiresAt?: Timestamp | null; - state: ChannelToken['state']; -}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { - stats: { - online_count: number; - }; -}>; -``` -References: [Endpoint](./js.endpoint.md), [Channel](./js.channel.md), [ChannelType](./js.channeltype.md), [ChannelToken](./js.channeltoken.md), [State](./js.state.md), [Empty](./js.empty.md), [Timestamp](./js.timestamp.md) - diff --git a/docs/js.channels.md b/docs/js.channels.md deleted file mode 100644 index 70a68342..00000000 --- a/docs/js.channels.md +++ /dev/null @@ -1,55 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [channels](./js.channels.md) - -## channels variable - -Channels SDK client - -Signature: - -```typescript -channels: (client: APIClient) => { - create(type: ChannelType, id?: string | null, options?: { - state?: T | undefined; - } | null | undefined, project?: Id<'project'>): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: Id<'leap_token'>): Promise; - subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - get(id: string): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: Id<'leap_token'>): Promise; - subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - getAll(project?: Id<'project'>): Promise<(Channel & { - setState(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: Id<'leap_token'>): Promise; - subscribeTokens(tokens: Id<'leap_token'>[] | Set>): Promise; - publishMessage(name: string, data: unknown): Promise; - })[]>; - subscribeToken(channel: string | Channel, token: Id<'leap_token'>): Promise; - subscribeTokens(channel: string | Channel, tokens: Id<'leap_token'>[] | Set>): Promise; - getAllTokens(channel: string | Channel): Promise; - setState(channel: string | Channel, state: SetStateAction): Promise; - patchState(channel: string | Channel, state: SetStateAction): Promise; - publishMessage(channel: string | Channel, event: string, data: T_5): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: Id<'leap_token'>): Promise; - create(state?: State, project?: Id<'project'>): Promise; - setState(id: Id<'leap_token'>, state: State): Promise; - get(id: Id<'leap_token'>): Promise; - isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; - publishDirectMessage(token: Id<'leap_token'>, event: string, data: T_6): Promise; - }; -} -``` diff --git a/docs/js.channeltoken.id.md b/docs/js.channeltoken.id.md deleted file mode 100644 index 0ea11a85..00000000 --- a/docs/js.channeltoken.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [id](./js.channeltoken.id.md) - -## ChannelToken.id property - -The ID for the token - -Signature: - -```typescript -id: Id<'leap_token'>; -``` diff --git a/docs/js.channeltoken.is_online.md b/docs/js.channeltoken.is_online.md deleted file mode 100644 index 0a64c0ae..00000000 --- a/docs/js.channeltoken.is_online.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [is\_online](./js.channeltoken.is_online.md) - -## ChannelToken.is\_online property - -If this token is currently online (e.g. active heartbeat and connected to leap) - -Signature: - -```typescript -is_online: boolean; -``` diff --git a/docs/js.channeltoken.md b/docs/js.channeltoken.md deleted file mode 100644 index e22b6fc8..00000000 --- a/docs/js.channeltoken.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) - -## ChannelToken interface - -Signature: - -```typescript -interface ChannelToken -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [id](./js.channeltoken.id.md) | | [Id](./js.id.md)<'leap\_token'> | The ID for the token | -| [is\_online](./js.channeltoken.is_online.md) | | boolean | If this token is currently online (e.g. active heartbeat and connected to leap) | -| [project\_id](./js.channeltoken.project_id.md) | | [Id](./js.id.md)<'project'> | The project this channel token is associated with | -| [state](./js.channeltoken.state.md) | | [State](./js.state.md) | State for this token | - diff --git a/docs/js.channeltoken.project_id.md b/docs/js.channeltoken.project_id.md deleted file mode 100644 index 07a80b63..00000000 --- a/docs/js.channeltoken.project_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [project\_id](./js.channeltoken.project_id.md) - -## ChannelToken.project\_id property - -The project this channel token is associated with - -Signature: - -```typescript -project_id: Id<'project'>; -``` diff --git a/docs/js.channeltoken.state.md b/docs/js.channeltoken.state.md deleted file mode 100644 index 4dfab383..00000000 --- a/docs/js.channeltoken.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelToken](./js.channeltoken.md) > [state](./js.channeltoken.state.md) - -## ChannelToken.state property - -State for this token - -Signature: - -```typescript -state: State; -``` diff --git a/docs/js.channeltype.md b/docs/js.channeltype.md deleted file mode 100644 index f1fa66df..00000000 --- a/docs/js.channeltype.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ChannelType](./js.channeltype.md) - -## ChannelType enum - -Signature: - -```typescript -declare enum ChannelType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PRIVATE | "private" | | -| PUBLIC | "public" | | -| UNPROTECTED | "unprotected" | | - diff --git a/docs/js.container.created_at.md b/docs/js.container.created_at.md deleted file mode 100644 index ea0fb999..00000000 --- a/docs/js.container.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [created\_at](./js.container.created_at.md) - -## Container.created\_at property - -The time this container was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.container.deployment_id.md b/docs/js.container.deployment_id.md deleted file mode 100644 index b3484036..00000000 --- a/docs/js.container.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [deployment\_id](./js.container.deployment_id.md) - -## Container.deployment\_id property - -The ID of the deployment this container is associated with - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.container.id.md b/docs/js.container.id.md deleted file mode 100644 index 9bc7359f..00000000 --- a/docs/js.container.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [id](./js.container.id.md) - -## Container.id property - -The ID of the container - -Signature: - -```typescript -id: Id<'container'>; -``` diff --git a/docs/js.container.internal_ip.md b/docs/js.container.internal_ip.md deleted file mode 100644 index a41a7c6f..00000000 --- a/docs/js.container.internal_ip.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [internal\_ip](./js.container.internal_ip.md) - -## Container.internal\_ip property - -The internal IP of the container - -Signature: - -```typescript -internal_ip: string; -``` diff --git a/docs/js.container.md b/docs/js.container.md deleted file mode 100644 index a06f1f56..00000000 --- a/docs/js.container.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) - -## Container interface - -Signature: - -```typescript -interface Container -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.container.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this container was created | -| [deployment\_id](./js.container.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment this container is associated with | -| [id](./js.container.id.md) | | [Id](./js.id.md)<'container'> | The ID of the container | -| [internal\_ip](./js.container.internal_ip.md) | | string | The internal IP of the container | -| [metadata](./js.container.metadata.md) | | { last\_exit\_code?: number; } | Information about the container | -| [region](./js.container.region.md) | | [Regions](./js.regions.md) | The region this container runs in | -| [state](./js.container.state.md) | | [ContainerState](./js.containerstate.md) | The state this container is in | -| [type](./js.container.type.md) | | [RuntimeType](./js.runtimetype.md) | The type of this container | -| [uptime](./js.container.uptime.md) | | { last\_start: [Timestamp](./js.timestamp.md); } | Information about uptime/downtime for this container | -| [volume](./js.container.volume.md) | | [VolumeDefinition](./js.volumedefinition.md) \| null | The volume definition for this container | - diff --git a/docs/js.container.metadata.md b/docs/js.container.metadata.md deleted file mode 100644 index b8ef4353..00000000 --- a/docs/js.container.metadata.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [metadata](./js.container.metadata.md) - -## Container.metadata property - -Information about the container - -Signature: - -```typescript -metadata: { - last_exit_code?: number; - }; -``` diff --git a/docs/js.container.region.md b/docs/js.container.region.md deleted file mode 100644 index 1e6dacc8..00000000 --- a/docs/js.container.region.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [region](./js.container.region.md) - -## Container.region property - -The region this container runs in - -Signature: - -```typescript -region: Regions; -``` diff --git a/docs/js.container.state.md b/docs/js.container.state.md deleted file mode 100644 index be7ce2ec..00000000 --- a/docs/js.container.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [state](./js.container.state.md) - -## Container.state property - -The state this container is in - -Signature: - -```typescript -state: ContainerState; -``` diff --git a/docs/js.container.type.md b/docs/js.container.type.md deleted file mode 100644 index aa89d51b..00000000 --- a/docs/js.container.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [type](./js.container.type.md) - -## Container.type property - -The type of this container - -Signature: - -```typescript -type: RuntimeType; -``` diff --git a/docs/js.container.uptime.md b/docs/js.container.uptime.md deleted file mode 100644 index b801f1a4..00000000 --- a/docs/js.container.uptime.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [uptime](./js.container.uptime.md) - -## Container.uptime property - -Information about uptime/downtime for this container - -Signature: - -```typescript -uptime: { - last_start: Timestamp; - }; -``` diff --git a/docs/js.container.volume.md b/docs/js.container.volume.md deleted file mode 100644 index e1aa34a5..00000000 --- a/docs/js.container.volume.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Container](./js.container.md) > [volume](./js.container.volume.md) - -## Container.volume property - -The volume definition for this container - -Signature: - -```typescript -volume: VolumeDefinition | null; -``` diff --git a/docs/js.containerlog.level.md b/docs/js.containerlog.level.md deleted file mode 100644 index 10fdce77..00000000 --- a/docs/js.containerlog.level.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [level](./js.containerlog.level.md) - -## ContainerLog.level property - -The level of the log. stdout becomes `info` - -Signature: - -```typescript -level: 'info' | 'error'; -``` diff --git a/docs/js.containerlog.md b/docs/js.containerlog.md deleted file mode 100644 index 16e7237c..00000000 --- a/docs/js.containerlog.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) - -## ContainerLog interface - -Logs from a container - -Signature: - -```typescript -interface ContainerLog -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [level](./js.containerlog.level.md) | | 'info' \| 'error' | The level of the log. stdout becomes info | -| [message](./js.containerlog.message.md) | | string | The log message | -| [nonce](./js.containerlog.nonce.md) | | string | The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. | -| [timestamp](./js.containerlog.timestamp.md) | | [Timestamp](./js.timestamp.md) | The timestamp of the log | - diff --git a/docs/js.containerlog.message.md b/docs/js.containerlog.message.md deleted file mode 100644 index b3334c65..00000000 --- a/docs/js.containerlog.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [message](./js.containerlog.message.md) - -## ContainerLog.message property - -The log message - -Signature: - -```typescript -message: string; -``` diff --git a/docs/js.containerlog.nonce.md b/docs/js.containerlog.nonce.md deleted file mode 100644 index ea3b06a4..00000000 --- a/docs/js.containerlog.nonce.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [nonce](./js.containerlog.nonce.md) - -## ContainerLog.nonce property - -The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique. - -Signature: - -```typescript -nonce: string; -``` diff --git a/docs/js.containerlog.timestamp.md b/docs/js.containerlog.timestamp.md deleted file mode 100644 index d415f14e..00000000 --- a/docs/js.containerlog.timestamp.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerLog](./js.containerlog.md) > [timestamp](./js.containerlog.timestamp.md) - -## ContainerLog.timestamp property - -The timestamp of the log - -Signature: - -```typescript -timestamp: Timestamp; -``` diff --git a/docs/js.containerstate.md b/docs/js.containerstate.md deleted file mode 100644 index b916dd94..00000000 --- a/docs/js.containerstate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ContainerState](./js.containerstate.md) - -## ContainerState enum - -Container state is relatively self-explanatory. It describes what the container is currently doing. - -Signature: - -```typescript -declare enum ContainerState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXITED | "exited" | The container exited (e.g. with a zero exit code) | -| FAILED | "failed" | The container's entrypoint failed (e.g. exited with a non-zero exit code) | -| PENDING | "pending" | The container is pending creation | -| RUNNING | "running" | The container is running | -| STOPPED | "stopped" | The container is stopped | -| TERMINATING | "terminating" | The container is being deleted | - diff --git a/docs/js.default_base_url.md b/docs/js.default_base_url.md deleted file mode 100644 index d364d83a..00000000 --- a/docs/js.default_base_url.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DEFAULT\_BASE\_URL](./js.default_base_url.md) - -## DEFAULT\_BASE\_URL variable - -The default base URL for Hop's API. - -Signature: - -```typescript -DEFAULT_BASE_URL = "https://api.hop.io" -``` diff --git a/docs/js.defaultquotas.md b/docs/js.defaultquotas.md deleted file mode 100644 index 7c88bdd0..00000000 --- a/docs/js.defaultquotas.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) - -## DefaultQuotas interface - -Signature: - -```typescript -interface DefaultQuotas -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.defaultquotas.ram.md) | | number | | -| [vcpu](./js.defaultquotas.vcpu.md) | | number | | - diff --git a/docs/js.defaultquotas.ram.md b/docs/js.defaultquotas.ram.md deleted file mode 100644 index 0b1bc129..00000000 --- a/docs/js.defaultquotas.ram.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [ram](./js.defaultquotas.ram.md) - -## DefaultQuotas.ram property - -Signature: - -```typescript -ram: number; -``` diff --git a/docs/js.defaultquotas.vcpu.md b/docs/js.defaultquotas.vcpu.md deleted file mode 100644 index 7386459d..00000000 --- a/docs/js.defaultquotas.vcpu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DefaultQuotas](./js.defaultquotas.md) > [vcpu](./js.defaultquotas.vcpu.md) - -## DefaultQuotas.vcpu property - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.deliveryprotocol.md b/docs/js.deliveryprotocol.md deleted file mode 100644 index d96e760d..00000000 --- a/docs/js.deliveryprotocol.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeliveryProtocol](./js.deliveryprotocol.md) - -## DeliveryProtocol type - -Signature: - -```typescript -declare type DeliveryProtocol = 'webrtc' | 'hls'; -``` diff --git a/docs/js.deployment.active_build.md b/docs/js.deployment.active_build.md deleted file mode 100644 index 13170351..00000000 --- a/docs/js.deployment.active_build.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_build](./js.deployment.active_build.md) - -## Deployment.active\_build property - -Current active build for deployment - -Signature: - -```typescript -active_build: Build | null; -``` diff --git a/docs/js.deployment.active_rollout.md b/docs/js.deployment.active_rollout.md deleted file mode 100644 index 8cb6418b..00000000 --- a/docs/js.deployment.active_rollout.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [active\_rollout](./js.deployment.active_rollout.md) - -## Deployment.active\_rollout property - -Current active rollout for deployment - -Signature: - -```typescript -active_rollout: DeploymentRollout | null; -``` diff --git a/docs/js.deployment.config.md b/docs/js.deployment.config.md deleted file mode 100644 index 7526bfe8..00000000 --- a/docs/js.deployment.config.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [config](./js.deployment.config.md) - -## Deployment.config property - -The config for this deployment - -Signature: - -```typescript -config: Omit; -``` diff --git a/docs/js.deployment.container_count.md b/docs/js.deployment.container_count.md deleted file mode 100644 index b626b1a7..00000000 --- a/docs/js.deployment.container_count.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [container\_count](./js.deployment.container_count.md) - -## Deployment.container\_count property - -The amount of containers this deployment is currently running - -Signature: - -```typescript -container_count: number; -``` diff --git a/docs/js.deployment.created_at.md b/docs/js.deployment.created_at.md deleted file mode 100644 index fdd0df48..00000000 --- a/docs/js.deployment.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [created\_at](./js.deployment.created_at.md) - -## Deployment.created\_at property - -The time this deployment was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.deployment.id.md b/docs/js.deployment.id.md deleted file mode 100644 index 5ff910b0..00000000 --- a/docs/js.deployment.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [id](./js.deployment.id.md) - -## Deployment.id property - -The ID of the deployment - -Signature: - -```typescript -id: Id<'deployment'>; -``` diff --git a/docs/js.deployment.md b/docs/js.deployment.md deleted file mode 100644 index ac2ded0e..00000000 --- a/docs/js.deployment.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) - -## Deployment interface - -Signature: - -```typescript -interface Deployment -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [active\_build](./js.deployment.active_build.md) | | [Build](./js.build.md) \| null | Current active build for deployment | -| [active\_rollout](./js.deployment.active_rollout.md) | | [DeploymentRollout](./js.deploymentrollout.md) \| null | Current active rollout for deployment | -| [config](./js.deployment.config.md) | | Omit<[DeploymentConfig](./js.deploymentconfig.md), 'volume' \| 'name'> | The config for this deployment | -| [container\_count](./js.deployment.container_count.md) | | number | The amount of containers this deployment is currently running | -| [created\_at](./js.deployment.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this deployment was created at | -| [id](./js.deployment.id.md) | | [Id](./js.id.md)<'deployment'> | The ID of the deployment | -| [name](./js.deployment.name.md) | | string | The name of the deployment | - diff --git a/docs/js.deployment.name.md b/docs/js.deployment.name.md deleted file mode 100644 index f13f40ae..00000000 --- a/docs/js.deployment.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Deployment](./js.deployment.md) > [name](./js.deployment.name.md) - -## Deployment.name property - -The name of the deployment - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.deploymentconfig.md b/docs/js.deploymentconfig.md deleted file mode 100644 index 56e7cc1f..00000000 --- a/docs/js.deploymentconfig.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentConfig](./js.deploymentconfig.md) - -## DeploymentConfig type - -A config for creating a deployment - -Signature: - -```typescript -declare type DeploymentConfig = { - name: string; - container_strategy: 'manual'; - type: RuntimeType; - version: '2022-05-17'; - image: Image; - env: Record; - resources: Resources; - restart_policy: RestartPolicy; - volume?: VolumeDefinition; -}; -``` -References: [RuntimeType](./js.runtimetype.md), [Image](./js.image_2.md), [Resources](./js.resources.md), [RestartPolicy](./js.restartpolicy.md), [VolumeDefinition](./js.volumedefinition.md) - diff --git a/docs/js.deploymentrollout.md b/docs/js.deploymentrollout.md deleted file mode 100644 index 288aca3b..00000000 --- a/docs/js.deploymentrollout.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DeploymentRollout](./js.deploymentrollout.md) - -## DeploymentRollout type - -A deployment rollout - -Signature: - -```typescript -declare type DeploymentRollout = { - count: number; - created_at: Timestamp; - deployment_id: Id<'deployment'>; - id: Id<'rollout'>; - state: RolloutState; - build: Build | null; -}; -``` -References: [Timestamp](./js.timestamp.md), [Id](./js.id.md), [RolloutState](./js.rolloutstate.md), [Build](./js.build.md) - diff --git a/docs/js.domain.created_at.md b/docs/js.domain.created_at.md deleted file mode 100644 index c16c478c..00000000 --- a/docs/js.domain.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [created\_at](./js.domain.created_at.md) - -## Domain.created\_at property - -The date this domain was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.domain.domain.md b/docs/js.domain.domain.md deleted file mode 100644 index 429325c1..00000000 --- a/docs/js.domain.domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [domain](./js.domain.domain.md) - -## Domain.domain property - -The domain name - -Signature: - -```typescript -domain: string; -``` diff --git a/docs/js.domain.id.md b/docs/js.domain.id.md deleted file mode 100644 index 659db5cc..00000000 --- a/docs/js.domain.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [id](./js.domain.id.md) - -## Domain.id property - -The ID of the domain - -Signature: - -```typescript -id: Id<'domain'>; -``` diff --git a/docs/js.domain.md b/docs/js.domain.md deleted file mode 100644 index 9668e178..00000000 --- a/docs/js.domain.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) - -## Domain interface - -Signature: - -```typescript -interface Domain -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.domain.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this domain was created | -| [domain](./js.domain.domain.md) | | string | The domain name | -| [id](./js.domain.id.md) | | [Id](./js.id.md)<'domain'> | The ID of the domain | -| [state](./js.domain.state.md) | | [DomainState](./js.domainstate.md) | The domain state | - diff --git a/docs/js.domain.state.md b/docs/js.domain.state.md deleted file mode 100644 index 9f613f54..00000000 --- a/docs/js.domain.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Domain](./js.domain.md) > [state](./js.domain.state.md) - -## Domain.state property - -The domain state - -Signature: - -```typescript -state: DomainState; -``` diff --git a/docs/js.domainstate.md b/docs/js.domainstate.md deleted file mode 100644 index df9bf6f1..00000000 --- a/docs/js.domainstate.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [DomainState](./js.domainstate.md) - -## DomainState enum - -Signature: - -```typescript -declare enum DomainState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PENDING | "pending" | | -| SSL\_ACTIVE | "ssl_active" | | -| VALID\_CNAME | "valid_cname" | | - diff --git a/docs/js.empty.md b/docs/js.empty.md deleted file mode 100644 index 3750e6f8..00000000 --- a/docs/js.empty.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Empty](./js.empty.md) - -## Empty type - -An empty response type - -Signature: - -```typescript -declare type Empty = void; -``` diff --git a/docs/js.endpoint.md b/docs/js.endpoint.md deleted file mode 100644 index 1e66a431..00000000 --- a/docs/js.endpoint.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Endpoint](./js.endpoint.md) - -## Endpoint type - -Signature: - -```typescript -declare type Endpoint = { - method: M; - path: Path; - res: Res; - body: Body; -}; -``` -References: [Method](./js.method.md) - diff --git a/docs/js.endpoints.md b/docs/js.endpoints.md deleted file mode 100644 index 278f448b..00000000 --- a/docs/js.endpoints.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Endpoints](./js.endpoints.md) - -## Endpoints type - -Signature: - -```typescript -declare type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; -``` -References: [IgniteEndpoints](./js.igniteendpoints.md), [RegistryEndpoints](./js.registryendpoints.md), [UserEndpoints](./js.userendpoints.md), [ProjectsEndpoints](./js.projectsendpoints.md), [PipeEndpoints](./js.pipeendpoints.md), [ChannelEndpoints](./js.channelendpoints.md) - diff --git a/docs/js.erroredapiresponse.md b/docs/js.erroredapiresponse.md deleted file mode 100644 index 35a4aadc..00000000 --- a/docs/js.erroredapiresponse.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ErroredAPIResponse](./js.erroredapiresponse.md) - -## ErroredAPIResponse type - -Signature: - -```typescript -declare type ErroredAPIResponse = { - success: false; - error: { - code: string; - message: string; - }; -}; -``` diff --git a/docs/js.extractrouteparams.md b/docs/js.extractrouteparams.md deleted file mode 100644 index 22d8b537..00000000 --- a/docs/js.extractrouteparams.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ExtractRouteParams](./js.extractrouteparams.md) - -## ExtractRouteParams type - -Creates a record of params required for a given URL/path - -Signature: - -```typescript -declare type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { - [k in Param | keyof ExtractRouteParams]: string | number; -} : T extends `${string}:${infer Param}` ? { - [k in Param]: string | number; -} : {}; -``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.gateway.created_at.md b/docs/js.gateway.created_at.md deleted file mode 100644 index c6c94097..00000000 --- a/docs/js.gateway.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [created\_at](./js.gateway.created_at.md) - -## Gateway.created\_at property - -The date this gateway was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.gateway.deployment_id.md b/docs/js.gateway.deployment_id.md deleted file mode 100644 index 6300a5b1..00000000 --- a/docs/js.gateway.deployment_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [deployment\_id](./js.gateway.deployment_id.md) - -## Gateway.deployment\_id property - -The deployment this gateway is associated with - -Signature: - -```typescript -deployment_id: Id<'deployment'>; -``` diff --git a/docs/js.gateway.domains.md b/docs/js.gateway.domains.md deleted file mode 100644 index fffb4603..00000000 --- a/docs/js.gateway.domains.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [domains](./js.gateway.domains.md) - -## Gateway.domains property - -Domains associated with this gateway - -Signature: - -```typescript -domains: Domain[]; -``` diff --git a/docs/js.gateway.hopsh_domain.md b/docs/js.gateway.hopsh_domain.md deleted file mode 100644 index d7b3c930..00000000 --- a/docs/js.gateway.hopsh_domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [hopsh\_domain](./js.gateway.hopsh_domain.md) - -## Gateway.hopsh\_domain property - -Domain automatically assigned by Hop - -Signature: - -```typescript -hopsh_domain: HopShDomain | null; -``` diff --git a/docs/js.gateway.id.md b/docs/js.gateway.id.md deleted file mode 100644 index 68dc79d4..00000000 --- a/docs/js.gateway.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [id](./js.gateway.id.md) - -## Gateway.id property - -The ID of the gateway - -Signature: - -```typescript -id: Id<'gateway'>; -``` diff --git a/docs/js.gateway.internal_domain.md b/docs/js.gateway.internal_domain.md deleted file mode 100644 index 58b36080..00000000 --- a/docs/js.gateway.internal_domain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [internal\_domain](./js.gateway.internal_domain.md) - -## Gateway.internal\_domain property - -Internal domain assigned by user upon gateway creation - -Signature: - -```typescript -internal_domain: InternalHopDomain | null; -``` diff --git a/docs/js.gateway.md b/docs/js.gateway.md deleted file mode 100644 index 685ce83f..00000000 --- a/docs/js.gateway.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) - -## Gateway interface - -Gateways are used to connect services to the internet or a private network - -Signature: - -```typescript -interface Gateway -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.gateway.created_at.md) | | [Timestamp](./js.timestamp.md) | The date this gateway was created | -| [deployment\_id](./js.gateway.deployment_id.md) | | [Id](./js.id.md)<'deployment'> | The deployment this gateway is associated with | -| [domains](./js.gateway.domains.md) | | [Domain](./js.domain.md)\[\] | Domains associated with this gateway | -| [hopsh\_domain](./js.gateway.hopsh_domain.md) | | [HopShDomain](./js.hopshdomain.md) \| null | Domain automatically assigned by Hop | -| [id](./js.gateway.id.md) | | [Id](./js.id.md)<'gateway'> | The ID of the gateway | -| [internal\_domain](./js.gateway.internal_domain.md) | | [InternalHopDomain](./js.internalhopdomain.md) \| null | Internal domain assigned by user upon gateway creation | -| [name](./js.gateway.name.md) | | string | The name of the gateway | -| [target\_port](./js.gateway.target_port.md) | | number \| null | Port the Gateway targets (Only for external gateways) | -| [type](./js.gateway.type.md) | | [GatewayType](./js.gatewaytype.md) | The type of the gateway | - diff --git a/docs/js.gateway.name.md b/docs/js.gateway.name.md deleted file mode 100644 index 8386952e..00000000 --- a/docs/js.gateway.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [name](./js.gateway.name.md) - -## Gateway.name property - -The name of the gateway - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.gateway.target_port.md b/docs/js.gateway.target_port.md deleted file mode 100644 index 6f14c324..00000000 --- a/docs/js.gateway.target_port.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [target\_port](./js.gateway.target_port.md) - -## Gateway.target\_port property - -Port the Gateway targets (Only for external gateways) - -Signature: - -```typescript -target_port: number | null; -``` diff --git a/docs/js.gateway.type.md b/docs/js.gateway.type.md deleted file mode 100644 index 91a41587..00000000 --- a/docs/js.gateway.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Gateway](./js.gateway.md) > [type](./js.gateway.type.md) - -## Gateway.type property - -The type of the gateway - -Signature: - -```typescript -type: GatewayType; -``` diff --git a/docs/js.gatewaytype.md b/docs/js.gatewaytype.md deleted file mode 100644 index 3df5ce11..00000000 --- a/docs/js.gatewaytype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GatewayType](./js.gatewaytype.md) - -## GatewayType enum - -Types of gateways supported by Hop - -Signature: - -```typescript -declare enum GatewayType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXTERNAL | "external" | The gateway can be accessed from the internet | -| INTERNAL | "internal" | The gateway can only be accessed inside of a project's network | - diff --git a/docs/js.getidprefix.md b/docs/js.getidprefix.md deleted file mode 100644 index 93f81441..00000000 --- a/docs/js.getidprefix.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [getIdPrefix](./js.getidprefix.md) - -## getIdPrefix() function - -Gets the prefix of an ID - -Signature: - -```typescript -declare function getIdPrefix(id: string, expect?: T): T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| id | string | A full ID to extract the prefix from | -| expect | T | (Optional) An expected prefix to check against | - -Returns: - -T - -- The prefix of the ID - diff --git a/docs/js.ghrepo.account_name.md b/docs/js.ghrepo.account_name.md deleted file mode 100644 index 17dad093..00000000 --- a/docs/js.ghrepo.account_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [account\_name](./js.ghrepo.account_name.md) - -## GHRepo.account\_name property - -Signature: - -```typescript -account_name: string; -``` diff --git a/docs/js.ghrepo.default_branch.md b/docs/js.ghrepo.default_branch.md deleted file mode 100644 index bae06423..00000000 --- a/docs/js.ghrepo.default_branch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [default\_branch](./js.ghrepo.default_branch.md) - -## GHRepo.default\_branch property - -Signature: - -```typescript -default_branch: string; -``` diff --git a/docs/js.ghrepo.full_name.md b/docs/js.ghrepo.full_name.md deleted file mode 100644 index 8a2776bb..00000000 --- a/docs/js.ghrepo.full_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [full\_name](./js.ghrepo.full_name.md) - -## GHRepo.full\_name property - -Signature: - -```typescript -full_name: string; -``` diff --git a/docs/js.ghrepo.id.md b/docs/js.ghrepo.id.md deleted file mode 100644 index f9607b9b..00000000 --- a/docs/js.ghrepo.id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [id](./js.ghrepo.id.md) - -## GHRepo.id property - -Signature: - -```typescript -id: number; -``` diff --git a/docs/js.ghrepo.md b/docs/js.ghrepo.md deleted file mode 100644 index 84df8456..00000000 --- a/docs/js.ghrepo.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) - -## GHRepo interface - -GitHub repo type sent from API (NOT USED IN IMAGES) - -Signature: - -```typescript -interface GHRepo -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [account\_name](./js.ghrepo.account_name.md) | | string | | -| [default\_branch](./js.ghrepo.default_branch.md) | | string | | -| [full\_name](./js.ghrepo.full_name.md) | | string | | -| [id](./js.ghrepo.id.md) | | number | | -| [private](./js.ghrepo.private.md) | | boolean | | - diff --git a/docs/js.ghrepo.private.md b/docs/js.ghrepo.private.md deleted file mode 100644 index 3a4e994b..00000000 --- a/docs/js.ghrepo.private.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [GHRepo](./js.ghrepo.md) > [private](./js.ghrepo.private.md) - -## GHRepo.private property - -Signature: - -```typescript -private: boolean; -``` diff --git a/docs/js.hop._constructor_.md b/docs/js.hop._constructor_.md deleted file mode 100644 index cd3f058d..00000000 --- a/docs/js.hop._constructor_.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor_.md) - -## Hop.(constructor) - -Constructs a new instance of the `Hop` class - -Signature: - -```typescript -constructor(options: PartialAPIOptions); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| options | [PartialAPIOptions](./js.partialapioptions.md) | | - diff --git a/docs/js.hop._constructor__1.md b/docs/js.hop._constructor__1.md deleted file mode 100644 index b426e3df..00000000 --- a/docs/js.hop._constructor__1.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [(constructor)](./js.hop._constructor__1.md) - -## Hop.(constructor) - -Constructs a new instance of the `Hop` class - -Signature: - -```typescript -constructor(authentication: APIAuthentication, baseurl?: string); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| authentication | [APIAuthentication](./js.apiauthentication.md) | | -| baseurl | string | (Optional) | - diff --git a/docs/js.hop.channels.md b/docs/js.hop.channels.md deleted file mode 100644 index 59b9dbc0..00000000 --- a/docs/js.hop.channels.md +++ /dev/null @@ -1,53 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [channels](./js.hop.channels.md) - -## Hop.channels property - -Signature: - -```typescript -readonly channels: { - create(type: ChannelType, id?: string | null | undefined, options?: { - state?: T | undefined; - } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - get(id: string): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - getAll(project?: `project_${string}` | undefined): Promise<(Channel & { - setState(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - })[]>; - subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; - subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - getAllTokens(channel: string | Channel): Promise; - setState(channel: string | Channel, state: SetStateAction): Promise; - patchState(channel: string | Channel, state: SetStateAction): Promise; - publishMessage(channel: string | Channel, event: string, data: T_5): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: `leap_token_${string}`): Promise; - create(state?: State, project?: `project_${string}` | undefined): Promise; - setState(id: `leap_token_${string}`, state: State): Promise; - get(id: `leap_token_${string}`): Promise; - isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; - publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; - }; - }; -``` diff --git a/docs/js.hop.client.md b/docs/js.hop.client.md deleted file mode 100644 index c23e7fa5..00000000 --- a/docs/js.hop.client.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [client](./js.hop.client.md) - -## Hop.client property - -Signature: - -```typescript -readonly client: APIClient; -``` diff --git a/docs/js.hop.ignite.md b/docs/js.hop.ignite.md deleted file mode 100644 index 1afad47b..00000000 --- a/docs/js.hop.ignite.md +++ /dev/null @@ -1,85 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [ignite](./js.hop.ignite.md) - -## Hop.ignite property - -Signature: - -```typescript -readonly ignite: { - gateways: { - addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; - get(gatewayId: `gateway_${string}`): Promise; - }; - deployments: { - create: { - (configOrProject: `project_${string}`, bearerOrPatConfig: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - (configOrProject: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - }; - get: { - (name: string, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - }>; - }; - update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; - getContainers(deployment: `deployment_${string}`): Promise; - getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: "http" | null, port: number): Promise; - }>; - })[]>; - delete(deployment: `deployment_${string}`): Promise; - gateways: { - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, type: GatewayType, protocol: "http" | null, targetPort: number): Promise; - }>; - }; - }; - containers: { - delete(container: `container_${string}`): Promise; - getLogs(container: `container_${string}`, options?: Partial<{ - sortBy: "timestamp"; - orderBy: "desc" | "asc"; - limit: number; - offset: number; - }>): Promise; - stop(container: `container_${string}`): Promise; - start(container: `container_${string}`): Promise; - create(deployment: `deployment_${string}`): Promise; - }; - }; -``` diff --git a/docs/js.hop.md b/docs/js.hop.md deleted file mode 100644 index 67a5554b..00000000 --- a/docs/js.hop.md +++ /dev/null @@ -1,41 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) - -## Hop class - -Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK. - -Signature: - -```typescript -declare class Hop -``` - -## Example - - -```ts -const hop = new Hop(bearerTokenOrPATOrProjectToken); -await hop.ignite.containers.create(deploymentId); -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(options)](./js.hop._constructor_.md) | | Constructs a new instance of the Hop class | -| [(constructor)(authentication, baseurl)](./js.hop._constructor__1.md) | | Constructs a new instance of the Hop class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [channels](./js.hop.channels.md) | readonly | { create<T extends [State](./js.state.md)>(type: [ChannelType](./js.channeltype.md), id?: string \| null \| undefined, options?: { state?: T \| undefined; } \| null \| undefined, project?: \`project\_${string}\` \| undefined): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; get(id: string): Promise<[Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; }>; getAll(project?: \`project\_${string}\` \| undefined): Promise<([Channel](./js.channel.md) & { setState<T\_1 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_1>): Promise<void>; patchState<T\_2 extends [State](./js.state.md)>(state: [SetStateAction](./js.setstateaction.md)<T\_2>): Promise<void>; subscribeToken(token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; publishMessage(name: string, data: unknown): Promise<void>; })\[\]>; subscribeToken(channel: string \| [Channel](./js.channel.md), token: \`leap\_token\_${string}\`): Promise<void>; subscribeTokens(channel: string \| [Channel](./js.channel.md), tokens: \`leap\_token\_${string}\`\[\] \| Set<\`leap\_token\_${string}\`>): Promise<void>; getAllTokens(channel: string \| [Channel](./js.channel.md)): Promise<[ChannelToken](./js.channeltoken.md)\[\]>; setState<T\_3 extends [State](./js.state.md) = [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: [SetStateAction](./js.setstateaction.md)<T\_3>): Promise<void>; patchState<T\_4 extends [State](./js.state.md)>(channel: string \| [Channel](./js.channel.md), state: [SetStateAction](./js.setstateaction.md)<T\_4>): Promise<void>; publishMessage<T\_5>(channel: string \| [Channel](./js.channel.md), event: string, data: T\_5): Promise<void>; delete(id: string): Promise<void>; getStats(id: string): Promise<{ online\_count: number; }>; tokens: { delete(token: \`leap\_token\_${string}\`): Promise<void>; create(state?: [State](./js.state.md), project?: \`project\_${string}\` \| undefined): Promise<[ChannelToken](./js.channeltoken.md)>; setState(id: \`leap\_token\_${string}\`, state: [State](./js.state.md)): Promise<[ChannelToken](./js.channeltoken.md)>; get(id: \`leap\_token\_${string}\`): Promise<[ChannelToken](./js.channeltoken.md)>; isOnline(idOrToken: \`leap\_token\_${string}\` \| [ChannelToken](./js.channeltoken.md)): Promise<boolean>; publishDirectMessage<T\_6>(token: \`leap\_token\_${string}\`, event: string, data: T\_6): Promise<void>; }; } | | -| [client](./js.hop.client.md) | readonly | [APIClient](./js.apiclient.md) | | -| [ignite](./js.hop.ignite.md) | readonly | { gateways: { addDomain(gatewayId: \`gateway\_${string}\`, domain: string): Promise<void>; get(gatewayId: \`gateway\_${string}\`): Promise<[Gateway](./js.gateway.md)>; }; deployments: { create: { (configOrProject: \`project\_${string}\`, bearerOrPatConfig: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (configOrProject: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; get: { (name: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; (id: \`deployment\_${string}\`, projectId?: \`project\_${string}\` \| undefined): Promise<[Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }>; }; update(deploymentId: \`deployment\_${string}\`, config: [DeploymentConfig](./js.deploymentconfig.md)): Promise<[Deployment](./js.deployment.md)>; getContainers(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)\[\]>; getAll(projectId?: \`project\_${string}\` \| undefined): Promise<([Deployment](./js.deployment.md) & { getContainers(): Promise<[Container](./js.container.md)\[\]>; delete(): Promise<void>; createContainer(): Promise<[Container](./js.container.md)>; createGateway(type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, port: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; })\[\]>; delete(deployment: \`deployment\_${string}\`): Promise<void>; gateways: { getAll(deploymentId: \`deployment\_${string}\`): Promise<([Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; })\[\]>; create(deployment: \`deployment\_${string}\` \| [Deployment](./js.deployment.md), type: [GatewayType](./js.gatewaytype.md), protocol: "http" \| null, targetPort: number): Promise<[Gateway](./js.gateway.md) & { addDomain(domain: string): Promise<void>; }>; }; }; containers: { delete(container: \`container\_${string}\`): Promise<void>; getLogs(container: \`container\_${string}\`, options?: Partial<{ sortBy: "timestamp"; orderBy: "desc" \| "asc"; limit: number; offset: number; }>): Promise<[ContainerLog](./js.containerlog.md)\[\]>; stop(container: \`container\_${string}\`): Promise<void>; start(container: \`container\_${string}\`): Promise<void>; create(deployment: \`deployment\_${string}\`): Promise<[Container](./js.container.md)>; }; } | | -| [pipe](./js.hop.pipe.md) | readonly | { rooms: { getAll(project?: \`project\_${string}\` \| undefined): Promise<([Room](./js.room.md) & { delete(): Promise<void>; })\[\]>; create(name: string, options: { deliveryProtocols: [DeliveryProtocol](./js.deliveryprotocol.md)\[\]; ephemeral?: boolean \| undefined; ingestProtocol: "rtmp" \| "rtp"; hlsConfig?: { wcl\_delay: number; artificial\_delay: number; max\_playout\_bitrate\_preset: string; } \| undefined; }): Promise<[Room](./js.room.md) & { delete(): Promise<void>; }>; delete(room: \`pipe\_room\_${string}\`): Promise<void>; }; } | | -| [projects](./js.hop.projects.md) | readonly | { getAllMembers(projectId?: \`project\_${string}\` \| undefined): Promise<[Member](./js.member.md)\[\]>; getCurrentMember(projectId: \`project\_${string}\`): Promise<[Member](./js.member.md)>; projectTokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; tokens: { delete(projectTokenId: \`ptkid\_${string}\`, project?: \`project\_${string}\` \| undefined): Promise<void>; get(projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md)\[\]>; create(flags: number, projectId?: \`project\_${string}\` \| undefined): Promise<[ProjectToken](./js.projecttoken.md) & { project: [Project](./js.project.md); }>; }; secrets: { getAll(projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)\[\]>; create(name: string, value: string, projectId?: \`project\_${string}\` \| undefined): Promise<[Secret](./js.secret.md)>; delete(id: string, projectId?: \`project\_${string}\` \| undefined): Promise<void>; }; } | | -| [registry](./js.hop.registry.md) | readonly | { images: { getAll(project?: \`project\_${string}\` \| undefined): Promise<string\[\]>; getManifest(image: string): Promise<{ digest: { digest: string; size: number; uploaded: string; }; tag: string \| null; }\[\]>; delete(image: string): Promise<void>; }; } | | -| [users](./js.hop.users.md) | readonly | { me: { get(): Promise<{ projects: [Project](./js.project.md)\[\]; user: [User](./js.user.md); project\_member\_role\_map: Record<\`project\_${string}\`, [MemberRole](./js.memberrole.md)>; leap\_token: string \| null; }>; pats: { create(name: string): Promise<[PAT](./js.pat.md)>; getAll(): Promise<[PAT](./js.pat.md)\[\]>; delete(id: \`pat\_${string}\`): Promise<void>; }; }; } | | - diff --git a/docs/js.hop.pipe.md b/docs/js.hop.pipe.md deleted file mode 100644 index 8aeff3ff..00000000 --- a/docs/js.hop.pipe.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [pipe](./js.hop.pipe.md) - -## Hop.pipe property - -Signature: - -```typescript -readonly pipe: { - rooms: { - getAll(project?: `project_${string}` | undefined): Promise<(Room & { - delete(): Promise; - })[]>; - create(name: string, options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean | undefined; - ingestProtocol: "rtmp" | "rtp"; - hlsConfig?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } | undefined; - }): Promise; - }>; - delete(room: `pipe_room_${string}`): Promise; - }; - }; -``` diff --git a/docs/js.hop.projects.md b/docs/js.hop.projects.md deleted file mode 100644 index 3d6a89ee..00000000 --- a/docs/js.hop.projects.md +++ /dev/null @@ -1,33 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [projects](./js.hop.projects.md) - -## Hop.projects property - -Signature: - -```typescript -readonly projects: { - getAllMembers(projectId?: `project_${string}` | undefined): Promise; - getCurrentMember(projectId: `project_${string}`): Promise; - projectTokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - tokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - secrets: { - getAll(projectId?: `project_${string}` | undefined): Promise; - create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; - delete(id: string, projectId?: `project_${string}` | undefined): Promise; - }; - }; -``` diff --git a/docs/js.hop.registry.md b/docs/js.hop.registry.md deleted file mode 100644 index 66413e43..00000000 --- a/docs/js.hop.registry.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [registry](./js.hop.registry.md) - -## Hop.registry property - -Signature: - -```typescript -readonly registry: { - images: { - getAll(project?: `project_${string}` | undefined): Promise; - getManifest(image: string): Promise<{ - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]>; - delete(image: string): Promise; - }; - }; -``` diff --git a/docs/js.hop.users.md b/docs/js.hop.users.md deleted file mode 100644 index 751a0e80..00000000 --- a/docs/js.hop.users.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Hop](./js.hop.md) > [users](./js.hop.users.md) - -## Hop.users property - -Signature: - -```typescript -readonly users: { - me: { - get(): Promise<{ - projects: Project[]; - user: User; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: `pat_${string}`): Promise; - }; - }; - }; -``` diff --git a/docs/js.hopapierror._constructor_.md b/docs/js.hopapierror._constructor_.md deleted file mode 100644 index 3f22086e..00000000 --- a/docs/js.hopapierror._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [(constructor)](./js.hopapierror._constructor_.md) - -## HopAPIError.(constructor) - -Constructs a new instance of the `HopAPIError` class - -Signature: - -```typescript -constructor(request: Request, response: Response, data: ErroredAPIResponse); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Request | | -| response | Response | | -| data | [ErroredAPIResponse](./js.erroredapiresponse.md) | | - diff --git a/docs/js.hopapierror.data.md b/docs/js.hopapierror.data.md deleted file mode 100644 index a73cfc20..00000000 --- a/docs/js.hopapierror.data.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [data](./js.hopapierror.data.md) - -## HopAPIError.data property - -Signature: - -```typescript -readonly data: ErroredAPIResponse; -``` diff --git a/docs/js.hopapierror.md b/docs/js.hopapierror.md deleted file mode 100644 index dc5c6389..00000000 --- a/docs/js.hopapierror.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) - -## HopAPIError class - -An error that occurred as a response from the Hop API. - -Signature: - -```typescript -declare class HopAPIError extends Error -``` -Extends: Error - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(request, response, data)](./js.hopapierror._constructor_.md) | | Constructs a new instance of the HopAPIError class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [data](./js.hopapierror.data.md) | readonly | [ErroredAPIResponse](./js.erroredapiresponse.md) | | -| [request](./js.hopapierror.request.md) | readonly | Request | | -| [response](./js.hopapierror.response.md) | readonly | Response | | -| [status](./js.hopapierror.status.md) | readonly | number | | - diff --git a/docs/js.hopapierror.request.md b/docs/js.hopapierror.request.md deleted file mode 100644 index 8d307953..00000000 --- a/docs/js.hopapierror.request.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [request](./js.hopapierror.request.md) - -## HopAPIError.request property - -Signature: - -```typescript -readonly request: Request; -``` diff --git a/docs/js.hopapierror.response.md b/docs/js.hopapierror.response.md deleted file mode 100644 index 50d62913..00000000 --- a/docs/js.hopapierror.response.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [response](./js.hopapierror.response.md) - -## HopAPIError.response property - -Signature: - -```typescript -readonly response: Response; -``` diff --git a/docs/js.hopapierror.status.md b/docs/js.hopapierror.status.md deleted file mode 100644 index 3fd9681c..00000000 --- a/docs/js.hopapierror.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopAPIError](./js.hopapierror.md) > [status](./js.hopapierror.status.md) - -## HopAPIError.status property - -Signature: - -```typescript -readonly status: number; -``` diff --git a/docs/js.hopshdomain.md b/docs/js.hopshdomain.md deleted file mode 100644 index 6fd870e3..00000000 --- a/docs/js.hopshdomain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [HopShDomain](./js.hopshdomain.md) - -## HopShDomain type - -A hop.sh domain (\*.hop.sh) - -Signature: - -```typescript -declare type HopShDomain = `${string}.hop.sh`; -``` diff --git a/docs/js.id.md b/docs/js.id.md deleted file mode 100644 index 00774837..00000000 --- a/docs/js.id.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Id](./js.id.md) - -## Id type - -A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika - -Signature: - -```typescript -declare type Id = `${T}_${string}`; -``` -References: [IdPrefixes](./js.idprefixes.md) - diff --git a/docs/js.id_prefixes.md b/docs/js.id_prefixes.md deleted file mode 100644 index 6040fb1c..00000000 --- a/docs/js.id_prefixes.md +++ /dev/null @@ -1,67 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ID\_PREFIXES](./js.id_prefixes.md) - -## ID\_PREFIXES variable - -An array of all IDs that can be used in the API - -Signature: - -```typescript -ID_PREFIXES: readonly [{ - readonly prefix: "user"; - readonly description: "Users"; -}, { - readonly prefix: "project"; - readonly description: "Project"; -}, { - readonly prefix: "pm"; - readonly description: "Project Members"; -}, { - readonly prefix: "role"; - readonly description: "Roles"; -}, { - readonly prefix: "pi"; - readonly description: "Project Invite"; -}, { - readonly prefix: "ptk"; - readonly description: "Project token"; -}, { - readonly prefix: "pat"; - readonly description: "User personal access token"; -}, { - readonly prefix: "container"; - readonly description: "Ignite container"; -}, { - readonly prefix: "pipe_room"; - readonly description: "Pipe room"; -}, { - readonly prefix: "deployment"; - readonly description: "Ignite deployment"; -}, { - readonly prefix: "bearer"; - readonly description: "Users bearer token"; -}, { - readonly prefix: "ptkid"; - readonly description: "Project token ID"; -}, { - readonly prefix: "secret"; - readonly description: "Project secret ID"; -}, { - readonly prefix: "gateway"; - readonly description: "Gateway"; -}, { - readonly prefix: "domain"; - readonly description: "Domain for a gateway"; -}, { - readonly prefix: "leap_token"; - readonly description: "Token for connecting to leap as a client"; -}, { - readonly prefix: "build"; - readonly description: "Build ID for build logs"; -}, { - readonly prefix: "rollout"; - readonly description: "Rollout ID for rollouts."; -}] -``` diff --git a/docs/js.idprefixes.md b/docs/js.idprefixes.md deleted file mode 100644 index 9ec6b269..00000000 --- a/docs/js.idprefixes.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IdPrefixes](./js.idprefixes.md) - -## IdPrefixes type - -A union of all ID prefixes used within the API - -Signature: - -```typescript -declare type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; -``` -References: [ID\_PREFIXES](./js.id_prefixes.md) - diff --git a/docs/js.ignite.md b/docs/js.ignite.md deleted file mode 100644 index 2443e535..00000000 --- a/docs/js.ignite.md +++ /dev/null @@ -1,87 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ignite](./js.ignite.md) - -## ignite variable - -Ignite SDK client - -Signature: - -```typescript -ignite: (client: APIClient) => { - gateways: { - addDomain(gatewayId: Id<'gateway'>, domain: string): Promise; - get(gatewayId: Id<'gateway'>): Promise; - }; - deployments: { - create: { - (configOrProject: Id<'project'>, bearerOrPatConfig: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; - }>; - }>; - (configOrProject: DeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; - }>; - }>; - }; - get: { - (name: string, projectId?: Id<'project'>): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; - }>; - }>; - (id: Id<'deployment'>, projectId?: Id<'project'>): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; - }>; - }>; - }; - update(deploymentId: Id<'deployment'>, config: DeploymentConfig): Promise; - getContainers(deployment: Id<'deployment'>): Promise; - getAll(projectId?: Id<'project'>): Promise<(Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(type: GatewayType, protocol: Gateway['protocol'], port: number): Promise; - }>; - })[]>; - delete(deployment: Id<'deployment'>): Promise; - gateways: { - getAll(deploymentId: Id<'deployment'>): Promise<(Gateway & { - addDomain(domain: string): Promise; - })[]>; - create(deployment: Deployment | Deployment['id'], type: GatewayType, protocol: Gateway['protocol'], targetPort: number): Promise; - }>; - }; - }; - containers: { - delete(container: Id<'container'>): Promise; - getLogs(container: Id<'container'>, options?: Partial<{ - sortBy: 'timestamp'; - orderBy: 'desc' | 'asc'; - limit: number; - offset: number; - }>): Promise; - stop(container: Id<'container'>): Promise; - start(container: Id<'container'>): Promise; - create(deployment: Id<'deployment'>): Promise; - }; -} -``` diff --git a/docs/js.igniteendpoints.md b/docs/js.igniteendpoints.md deleted file mode 100644 index bc5d4138..00000000 --- a/docs/js.igniteendpoints.md +++ /dev/null @@ -1,46 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IgniteEndpoints](./js.igniteendpoints.md) - -## IgniteEndpoints type - -Signature: - -```typescript -declare type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { - deployments: Deployment[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { - containers: Container[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { - container: Container; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { - deployment_id: Id<'deployment'>; - container_id: Id<'container'>; -}> | Endpoint<'POST', '/v1/ignite/deployments', { - deployment: Deployment; -}, DeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { - logs: ContainerLog[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/search', { - deployment: Deployment; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { - preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; -}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { - domain: string; -}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { - gateway: Gateway; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { - gateways: Gateway[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { - gateway: Gateway; -}, { - type: GatewayType; - target_port: number; - protocol: Gateway['protocol']; -}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}, DeploymentConfig>; -``` -References: [Endpoint](./js.endpoint.md), [Deployment](./js.deployment.md), [Container](./js.container.md), [Id](./js.id.md), [DeploymentConfig](./js.deploymentconfig.md), [Empty](./js.empty.md), [ContainerLog](./js.containerlog.md), [ContainerState.STOPPED](./js.containerstate.md), [ContainerState.RUNNING](./js.containerstate.md), [Gateway](./js.gateway.md), [GatewayType](./js.gatewaytype.md) - diff --git a/docs/js.image_2.auth.md b/docs/js.image_2.auth.md deleted file mode 100644 index 95a908e5..00000000 --- a/docs/js.image_2.auth.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [auth](./js.image_2.auth.md) - -## Image\_2.auth property - -Authorization required for the registry to access this image This is not required if you use Hop's own registry. - -Signature: - -```typescript -auth: Auth | null; -``` diff --git a/docs/js.image_2.gh_repo.md b/docs/js.image_2.gh_repo.md deleted file mode 100644 index a9bb16be..00000000 --- a/docs/js.image_2.gh_repo.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [gh\_repo](./js.image_2.gh_repo.md) - -## Image\_2.gh\_repo property - -GitHub repo information (if applicable) - -Signature: - -```typescript -gh_repo: ImageGHRepo | null; -``` diff --git a/docs/js.image_2.md b/docs/js.image_2.md deleted file mode 100644 index 0a81cf6f..00000000 --- a/docs/js.image_2.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) - -## Image\_2 interface - -Docker image config - -Signature: - -```typescript -interface Image -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [auth](./js.image_2.auth.md) | | [Auth](./js.auth.md) \| null | Authorization required for the registry to access this image This is not required if you use Hop's own registry. | -| [gh\_repo](./js.image_2.gh_repo.md) | | [ImageGHRepo](./js.imageghrepo.md) \| null | GitHub repo information (if applicable) | -| [name](./js.image_2.name.md) | | string \| null | The name of the docker image | - diff --git a/docs/js.image_2.name.md b/docs/js.image_2.name.md deleted file mode 100644 index 8ab4559d..00000000 --- a/docs/js.image_2.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Image\_2](./js.image_2.md) > [name](./js.image_2.name.md) - -## Image\_2.name property - -The name of the docker image - -Signature: - -```typescript -name: string | null; -``` diff --git a/docs/js.imageghrepo.branch.md b/docs/js.imageghrepo.branch.md deleted file mode 100644 index 479d9e9a..00000000 --- a/docs/js.imageghrepo.branch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [branch](./js.imageghrepo.branch.md) - -## ImageGHRepo.branch property - -Signature: - -```typescript -branch: string; -``` diff --git a/docs/js.imageghrepo.full_name.md b/docs/js.imageghrepo.full_name.md deleted file mode 100644 index 40c3657a..00000000 --- a/docs/js.imageghrepo.full_name.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [full\_name](./js.imageghrepo.full_name.md) - -## ImageGHRepo.full\_name property - -Signature: - -```typescript -full_name: string; -``` diff --git a/docs/js.imageghrepo.md b/docs/js.imageghrepo.md deleted file mode 100644 index 8503ddd1..00000000 --- a/docs/js.imageghrepo.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) - -## ImageGHRepo interface - -GitHub repo partial used for images - -Signature: - -```typescript -interface ImageGHRepo -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [branch](./js.imageghrepo.branch.md) | | string | | -| [full\_name](./js.imageghrepo.full_name.md) | | string | | -| [repo\_id](./js.imageghrepo.repo_id.md) | | number | | - diff --git a/docs/js.imageghrepo.repo_id.md b/docs/js.imageghrepo.repo_id.md deleted file mode 100644 index 4e2439d4..00000000 --- a/docs/js.imageghrepo.repo_id.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ImageGHRepo](./js.imageghrepo.md) > [repo\_id](./js.imageghrepo.repo_id.md) - -## ImageGHRepo.repo\_id property - -Signature: - -```typescript -repo_id: number; -``` diff --git a/docs/js.internalhopdomain.md b/docs/js.internalhopdomain.md deleted file mode 100644 index 266c47ea..00000000 --- a/docs/js.internalhopdomain.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [InternalHopDomain](./js.internalhopdomain.md) - -## InternalHopDomain type - -A domain used with internal gateways (\*.hop.sh) - -Signature: - -```typescript -declare type InternalHopDomain = `${string}.hop`; -``` diff --git a/docs/js.is_browser.md b/docs/js.is_browser.md deleted file mode 100644 index a071fafc..00000000 --- a/docs/js.is_browser.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [IS\_BROWSER](./js.is_browser.md) - -## IS\_BROWSER variable - -If we are in the browser. - -Signature: - -```typescript -IS_BROWSER: boolean -``` diff --git a/docs/js.isvalidbytestring.md b/docs/js.isvalidbytestring.md deleted file mode 100644 index 556da828..00000000 --- a/docs/js.isvalidbytestring.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [isValidByteString](./js.isvalidbytestring.md) - -## isValidByteString() function - -Signature: - -```typescript -declare function isValidByteString(value: string): value is ByteSizeString; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | | - -Returns: - -value is [ByteSizeString](./js.bytesizestring.md) - diff --git a/docs/js.md b/docs/js.md deleted file mode 100644 index 5cd8749a..00000000 --- a/docs/js.md +++ /dev/null @@ -1,151 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) - -## js package - -## Classes - -| Class | Description | -| --- | --- | -| [APIClient](./js.apiclient.md) | API Client that is responsible for handling all requests | -| [Hop](./js.hop.md) | Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK. | -| [HopAPIError](./js.hopapierror.md) | An error that occurred as a response from the Hop API. | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [BuildMethod](./js.buildmethod.md) | Types of build methods supported by Hop | -| [BuildState](./js.buildstate.md) | | -| [ChannelType](./js.channeltype.md) | | -| [ContainerState](./js.containerstate.md) | Container state is relatively self-explanatory. It describes what the container is currently doing. | -| [DomainState](./js.domainstate.md) | | -| [GatewayType](./js.gatewaytype.md) | Types of gateways supported by Hop | -| [PROJECT\_PERMISSION](./js.project_permission.md) | A list of all permissions and their representative names | -| [ProjectTier](./js.projecttier.md) | | -| [ProjectType](./js.projecttype.md) | Type of a project | -| [Regions](./js.regions.md) | | -| [RestartPolicy](./js.restartpolicy.md) | Restart policy for deployments | -| [RolloutState](./js.rolloutstate.md) | Rollout state for deployments | -| [RuntimeType](./js.runtimetype.md) | Runtime types are used to describe the type of a deployment or container | -| [VgpuType](./js.vgputype.md) | Types for supported GPU | -| [VolumeFormat](./js.volumeformat.md) | | - -## Functions - -| Function | Description | -| --- | --- | -| [assertId(maybeId, prefix, message)](./js.assertid.md) | Asserts that a string is a valid ID | -| [getIdPrefix(id, expect)](./js.getidprefix.md) | Gets the prefix of an ID | -| [id(maybeId, prefix)](./js.id.md) | Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID. | -| [isValidByteString(value)](./js.isvalidbytestring.md) | | -| [parseSize(size)](./js.parsesize.md) | Parses a byte size string into bytes | -| [validateAPIAuthentication(auth)](./js.validateapiauthentication.md) | Validates that an authentication prefix is valid | -| [validateId(maybeId, prefix)](./js.validateid.md) | Validates that a string is a valid ID | -| [validateIdPrefix(prefix, expect)](./js.validateidprefix.md) | Checks if a string is a valid Hop ID prefix | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [APIClientOptions](./js.apiclientoptions.md) | Options passed to the API client. This will usually come from Hop\#constructor in most cases | -| [Auth](./js.auth.md) | Docker image registry authorization | -| [Build](./js.build.md) | A build entity | -| [BuildMetaData](./js.buildmetadata.md) | Metadata attached to a build | -| [Channel](./js.channel.md) | | -| [ChannelToken](./js.channeltoken.md) | | -| [Container](./js.container.md) | | -| [ContainerLog](./js.containerlog.md) | Logs from a container | -| [DefaultQuotas](./js.defaultquotas.md) | | -| [Deployment](./js.deployment.md) | | -| [Domain](./js.domain.md) | | -| [Gateway](./js.gateway.md) | Gateways are used to connect services to the internet or a private network | -| [GHRepo](./js.ghrepo.md) | GitHub repo type sent from API (NOT USED IN IMAGES) | -| [Image\_2](./js.image_2.md) | Docker image config | -| [ImageGHRepo](./js.imageghrepo.md) | GitHub repo partial used for images | -| [MemberRole](./js.memberrole.md) | | -| [PAT](./js.pat.md) | | -| [Project](./js.project.md) | | -| [ProjectToken](./js.projecttoken.md) | A project token for a project | -| [QuotaOverrides](./js.quotaoverrides.md) | | -| [QuotaUsage](./js.quotausage.md) | | -| [Resources](./js.resources.md) | Resources allocated to a deployment | -| [Room](./js.room.md) | | -| [Secret](./js.secret.md) | | -| [User](./js.user.md) | A user objct | -| [Vgpu](./js.vgpu.md) | Virtual GPU config | -| [VolumeDefinition](./js.volumedefinition.md) | | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [API](./js.api.md) | | -| [Channels](./js.channels.md) | | -| [Ignite](./js.ignite.md) | | -| [Pipe](./js.pipe.md) | | -| [Projects](./js.projects.md) | | -| [Registry](./js.registry.md) | | -| [Users](./js.users.md) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [BROAD\_PERMISSIONS\_MAP](./js.broad_permissions_map.md) | Broader permission map | -| [byteUnits](./js.byteunits.md) | | -| [channels](./js.channels.md) | Channels SDK client | -| [DEFAULT\_BASE\_URL](./js.default_base_url.md) | The default base URL for Hop's API. | -| [ID\_PREFIXES](./js.id_prefixes.md) | An array of all IDs that can be used in the API | -| [ignite](./js.ignite.md) | Ignite SDK client | -| [IS\_BROWSER](./js.is_browser.md) | If we are in the browser. | -| [permissions](./js.permissions.md) | Permission utility functions | -| [permissionsMap](./js.permissionsmap.md) | Individual bitwise permissions | -| [pipe](./js.pipe.md) | Pipe SDK client | -| [projects](./js.projects.md) | Projects SDK client | -| [registry](./js.registry.md) | Registry SDK client | -| [roles](./js.roles.md) | Bitwise role flags that a user can be as part of a project | -| [SUPPORTS\_INTL](./js.supports_intl.md) | If this runtiem supports the Intl API | -| [units](./js.units.md) | | -| [users](./js.users.md) | Users SDK client | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnyId](./js.anyid.md) | Any/all IDs that are used within the API | -| [APIAuthentication](./js.apiauthentication.md) | All possible authentication ID types | -| [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) | A valid ID prefix supported by the Hop API for authetication | -| [APIResponse](./js.apiresponse.md) | | -| [ByteSizeString](./js.bytesizestring.md) | | -| [ByteString](./js.bytestring.md) | | -| [ByteUnit](./js.byteunit.md) | | -| [ChannelEndpoints](./js.channelendpoints.md) | | -| [DeliveryProtocol](./js.deliveryprotocol.md) | | -| [DeploymentConfig](./js.deploymentconfig.md) | A config for creating a deployment | -| [DeploymentRollout](./js.deploymentrollout.md) | A deployment rollout | -| [Empty](./js.empty.md) | An empty response type | -| [Endpoint](./js.endpoint.md) | | -| [Endpoints](./js.endpoints.md) | | -| [ErroredAPIResponse](./js.erroredapiresponse.md) | | -| [ExtractRouteParams](./js.extractrouteparams.md) | Creates a record of params required for a given URL/path | -| [HopShDomain](./js.hopshdomain.md) | A hop.sh domain (\*.hop.sh) | -| [Id](./js.id.md) | A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika | -| [IdPrefixes](./js.idprefixes.md) | A union of all ID prefixes used within the API | -| [IgniteEndpoints](./js.igniteendpoints.md) | | -| [InternalHopDomain](./js.internalhopdomain.md) | A domain used with internal gateways (\*.hop.sh) | -| [Member](./js.member.md) | | -| [Method](./js.method.md) | All methods the Hop API accepts | -| [PartialAPIOptions](./js.partialapioptions.md) | Partial options for the Hop client | -| [PipeEndpoints](./js.pipeendpoints.md) | | -| [ProjectsEndpoints](./js.projectsendpoints.md) | | -| [Query](./js.query.md) | Generate a query object that includes typed URL params | -| [RegistryEndpoints](./js.registryendpoints.md) | | -| [SetStateAction](./js.setstateaction.md) | New state to set to a channel, or a callback function that will produce the new state | -| [State](./js.state.md) | | -| [SuccessfulAPIResponse](./js.successfulapiresponse.md) | | -| [Tag](./js.tag.md) | Tag a type to make it unique | -| [Timestamp](./js.timestamp.md) | An ISO 8601 date strings | -| [UserEndpoints](./js.userendpoints.md) | | - diff --git a/docs/js.member.md b/docs/js.member.md deleted file mode 100644 index 0ee4a3b3..00000000 --- a/docs/js.member.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Member](./js.member.md) - -## Member type - -Signature: - -```typescript -declare type Member = Omit & { - id: Id<'pm'>; - role: MemberRole; - joined_at: Timestamp; -}; -``` -References: [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [Timestamp](./js.timestamp.md) - diff --git a/docs/js.memberrole.flags.md b/docs/js.memberrole.flags.md deleted file mode 100644 index 2e0c80d2..00000000 --- a/docs/js.memberrole.flags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [flags](./js.memberrole.flags.md) - -## MemberRole.flags property - -The flags for this role - -Signature: - -```typescript -flags: number; -``` diff --git a/docs/js.memberrole.id.md b/docs/js.memberrole.id.md deleted file mode 100644 index f270fc72..00000000 --- a/docs/js.memberrole.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [id](./js.memberrole.id.md) - -## MemberRole.id property - -The ID of the role - -Signature: - -```typescript -id: Id<'role'>; -``` diff --git a/docs/js.memberrole.md b/docs/js.memberrole.md deleted file mode 100644 index 25369fad..00000000 --- a/docs/js.memberrole.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) - -## MemberRole interface - -Signature: - -```typescript -interface MemberRole -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [flags](./js.memberrole.flags.md) | | number | The flags for this role | -| [id](./js.memberrole.id.md) | | [Id](./js.id.md)<'role'> | The ID of the role | -| [name](./js.memberrole.name.md) | | string | The name of the role | - diff --git a/docs/js.memberrole.name.md b/docs/js.memberrole.name.md deleted file mode 100644 index ecdd270d..00000000 --- a/docs/js.memberrole.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [MemberRole](./js.memberrole.md) > [name](./js.memberrole.name.md) - -## MemberRole.name property - -The name of the role - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.method.md b/docs/js.method.md deleted file mode 100644 index f49cb65b..00000000 --- a/docs/js.method.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Method](./js.method.md) - -## Method type - -All methods the Hop API accepts - -Signature: - -```typescript -declare type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; -``` diff --git a/docs/js.parsesize.md b/docs/js.parsesize.md deleted file mode 100644 index 322ce2fa..00000000 --- a/docs/js.parsesize.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [parseSize](./js.parsesize.md) - -## parseSize() function - -Parses a byte size string into bytes - -Signature: - -```typescript -declare function parseSize(size: string): number; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| size | string | The size of anything in gigabytes, megabytes, kilobytes or bytes | - -Returns: - -number - diff --git a/docs/js.partialapioptions.md b/docs/js.partialapioptions.md deleted file mode 100644 index d4a2f249..00000000 --- a/docs/js.partialapioptions.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PartialAPIOptions](./js.partialapioptions.md) - -## PartialAPIOptions type - -Partial options for the Hop client - -Signature: - -```typescript -declare type PartialAPIOptions = Partial> & Pick; -``` -References: [APIClientOptions](./js.apiclientoptions.md) - diff --git a/docs/js.pat.created_at.md b/docs/js.pat.created_at.md deleted file mode 100644 index 06e61761..00000000 --- a/docs/js.pat.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [created\_at](./js.pat.created_at.md) - -## PAT.created\_at property - -The date the pat was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.pat.id.md b/docs/js.pat.id.md deleted file mode 100644 index 2931e3ae..00000000 --- a/docs/js.pat.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [id](./js.pat.id.md) - -## PAT.id property - -The ID of the pat - -Signature: - -```typescript -id: Id<'pat'>; -``` diff --git a/docs/js.pat.md b/docs/js.pat.md deleted file mode 100644 index ebd93103..00000000 --- a/docs/js.pat.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) - -## PAT interface - -Signature: - -```typescript -interface PAT -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.pat.created_at.md) | | [Timestamp](./js.timestamp.md) | The date the pat was created | -| [id](./js.pat.id.md) | | [Id](./js.id.md)<'pat'> | The ID of the pat | -| [name](./js.pat.name.md) | | string \| null | The name of the pat | - diff --git a/docs/js.pat.name.md b/docs/js.pat.name.md deleted file mode 100644 index 1312d7b5..00000000 --- a/docs/js.pat.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PAT](./js.pat.md) > [name](./js.pat.name.md) - -## PAT.name property - -The name of the pat - -Signature: - -```typescript -name: string | null; -``` diff --git a/docs/js.permissions.md b/docs/js.permissions.md deleted file mode 100644 index 6d3129d6..00000000 --- a/docs/js.permissions.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [permissions](./js.permissions.md) - -## permissions variable - -Permission utility functions - -Signature: - -```typescript -permissions: { - add(value: bigint, flag: bigint): bigint; - test(value: bigint, flag: bigint): boolean; - subtract(value: bigint, flag: bigint): bigint; -} -``` diff --git a/docs/js.permissionsmap.md b/docs/js.permissionsmap.md deleted file mode 100644 index 07ae4c4a..00000000 --- a/docs/js.permissionsmap.md +++ /dev/null @@ -1,58 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [permissionsMap](./js.permissionsmap.md) - -## permissionsMap variable - -Individual bitwise permissions - -Signature: - -```typescript -permissionsMap: { - add_member: bigint; - remove_member: bigint; - get_project_members: bigint; - delete_project: bigint; - delete_deployment: bigint; - delete_container: bigint; - update_container_state: bigint; - read_deployments: bigint; - create_deployment: bigint; - create_container: bigint; - update_container_config: bigint; - create_room: bigint; - read_room: bigint; - delete_room: bigint; - create_room_producer: bigint; - create_project_token: bigint; - delete_project_token: bigint; - read_project_tokens: bigint; - read_container_logs: bigint; - create_project_secret: bigint; - read_project_secrets: bigint; - delete_project_secret: bigint; - get_registry_images: bigint; - create_channel_token: bigint; - create_gateway: bigint; - add_domain: bigint; - delete_channels: bigint; - update_channel_state: bigint; - read_channels: bigint; - publish_channel_messages: bigint; - manage_channel_subscribers: bigint; - delete_domain: bigint; - delete_gateway: bigint; - get_internal_domain: bigint; - create_leap_token: bigint; - read_leap_tokens: bigint; - update_leap_token: bigint; - message_token: bigint; - create_channel: bigint; - rollout: bigint; - request_quota_increase: bigint; - read_billing: bigint; - read_gateways: bigint; - delete_registry_images: bigint; -} -``` diff --git a/docs/js.pipe.md b/docs/js.pipe.md deleted file mode 100644 index 4467389a..00000000 --- a/docs/js.pipe.md +++ /dev/null @@ -1,32 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [pipe](./js.pipe.md) - -## pipe variable - -Pipe SDK client - -Signature: - -```typescript -pipe: (client: APIClient) => { - rooms: { - getAll(project?: Id<'project'>): Promise<(Room & { - delete(): Promise; - })[]>; - create(name: string, options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean; - ingestProtocol: 'rtmp' | 'rtp'; - hlsConfig?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; - }): Promise; - }>; - delete(room: Id<'pipe_room'>): Promise; - }; -} -``` diff --git a/docs/js.pipeendpoints.md b/docs/js.pipeendpoints.md deleted file mode 100644 index 5d8178ef..00000000 --- a/docs/js.pipeendpoints.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PipeEndpoints](./js.pipeendpoints.md) - -## PipeEndpoints type - -Signature: - -```typescript -declare type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { - rooms: Room[]; -}> | Endpoint<'POST', '/v1/pipe/rooms', { - room: Room; -}, { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; -}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Room](./js.room.md), [DeliveryProtocol](./js.deliveryprotocol.md), [Regions](./js.regions.md), [Empty](./js.empty.md) - diff --git a/docs/js.project.created_at.md b/docs/js.project.created_at.md deleted file mode 100644 index 0b1cbd9f..00000000 --- a/docs/js.project.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [created\_at](./js.project.created_at.md) - -## Project.created\_at property - -The time this project was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.project.default_quotas.md b/docs/js.project.default_quotas.md deleted file mode 100644 index 3c67e09b..00000000 --- a/docs/js.project.default_quotas.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [default\_quotas](./js.project.default_quotas.md) - -## Project.default\_quotas property - -Signature: - -```typescript -default_quotas: DefaultQuotas; -``` diff --git a/docs/js.project.icon.md b/docs/js.project.icon.md deleted file mode 100644 index 50950ecf..00000000 --- a/docs/js.project.icon.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [icon](./js.project.icon.md) - -## Project.icon property - -An icon for this project - -Signature: - -```typescript -icon: string | null; -``` diff --git a/docs/js.project.id.md b/docs/js.project.id.md deleted file mode 100644 index 1e88e80b..00000000 --- a/docs/js.project.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [id](./js.project.id.md) - -## Project.id property - -The ID of the project - -Signature: - -```typescript -id: Id<'project'>; -``` diff --git a/docs/js.project.md b/docs/js.project.md deleted file mode 100644 index 447623d1..00000000 --- a/docs/js.project.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) - -## Project interface - -Signature: - -```typescript -interface Project -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.project.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project was created at | -| [default\_quotas](./js.project.default_quotas.md) | | [DefaultQuotas](./js.defaultquotas.md) | | -| [icon](./js.project.icon.md) | | string \| null | An icon for this project | -| [id](./js.project.id.md) | | [Id](./js.id.md)<'project'> | The ID of the project | -| [name](./js.project.name.md) | | string | The name of the project | -| [namespace](./js.project.namespace.md) | | string | The registry namespace for this project | -| [quota\_overrides](./js.project.quota_overrides.md) | | [QuotaOverrides](./js.quotaoverrides.md) | | -| [quota\_usage](./js.project.quota_usage.md) | | [QuotaUsage](./js.quotausage.md) | | -| [tier](./js.project.tier.md) | | [ProjectTier](./js.projecttier.md) | The tier this project is | -| [type](./js.project.type.md) | | [ProjectType](./js.projecttype.md) | The type of this project. Either regular or personal | - diff --git a/docs/js.project.name.md b/docs/js.project.name.md deleted file mode 100644 index b138c95c..00000000 --- a/docs/js.project.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [name](./js.project.name.md) - -## Project.name property - -The name of the project - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.project.namespace.md b/docs/js.project.namespace.md deleted file mode 100644 index aaa8fdc8..00000000 --- a/docs/js.project.namespace.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [namespace](./js.project.namespace.md) - -## Project.namespace property - -The registry namespace for this project - -Signature: - -```typescript -namespace: string; -``` diff --git a/docs/js.project.quota_overrides.md b/docs/js.project.quota_overrides.md deleted file mode 100644 index 1d16a7da..00000000 --- a/docs/js.project.quota_overrides.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_overrides](./js.project.quota_overrides.md) - -## Project.quota\_overrides property - -Signature: - -```typescript -quota_overrides: QuotaOverrides; -``` diff --git a/docs/js.project.quota_usage.md b/docs/js.project.quota_usage.md deleted file mode 100644 index 0ba5afce..00000000 --- a/docs/js.project.quota_usage.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [quota\_usage](./js.project.quota_usage.md) - -## Project.quota\_usage property - -Signature: - -```typescript -quota_usage: QuotaUsage; -``` diff --git a/docs/js.project.tier.md b/docs/js.project.tier.md deleted file mode 100644 index 684e6f73..00000000 --- a/docs/js.project.tier.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [tier](./js.project.tier.md) - -## Project.tier property - -The tier this project is - -Signature: - -```typescript -tier: ProjectTier; -``` diff --git a/docs/js.project.type.md b/docs/js.project.type.md deleted file mode 100644 index 66f2c248..00000000 --- a/docs/js.project.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Project](./js.project.md) > [type](./js.project.type.md) - -## Project.type property - -The type of this project. Either regular or personal - -Signature: - -```typescript -type: ProjectType; -``` diff --git a/docs/js.project_permission.md b/docs/js.project_permission.md deleted file mode 100644 index ba407493..00000000 --- a/docs/js.project_permission.md +++ /dev/null @@ -1,63 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [PROJECT\_PERMISSION](./js.project_permission.md) - -## PROJECT\_PERMISSION enum - -A list of all permissions and their representative names - -Signature: - -```typescript -declare enum PROJECT_PERMISSION -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ADD\_DOMAIN | "add_domain" | | -| ADD\_MEMBER | "add_member" | | -| CREATE\_CHANNEL | "create_channel" | | -| CREATE\_CHANNEL\_TOKEN | "create_channel_token" | | -| CREATE\_CONTAINER | "create_container" | | -| CREATE\_DEPLOYMENT | "create_deployment" | | -| CREATE\_GATEWAY | "create_gateway" | | -| CREATE\_LEAP\_TOKEN | "create_leap_token" | | -| CREATE\_PROJECT\_SECRET | "create_project_secret" | | -| CREATE\_PROJECT\_TOKEN | "create_project_token" | | -| CREATE\_ROOM | "create_room" | | -| CREATE\_ROOM\_PRODUCER | "create_room_producer" | | -| DELETE\_CHANNELS | "delete_channels" | | -| DELETE\_CONTAINER | "delete_container" | | -| DELETE\_DEPLOYMENT | "delete_deployment" | | -| DELETE\_DOMAIN | "delete_domain" | | -| DELETE\_GATEWAY | "delete_gateway" | | -| DELETE\_PROJECT | "delete_project" | | -| DELETE\_PROJECT\_SECRET | "delete_project_secret" | | -| DELETE\_PROJECT\_TOKEN | "delete_project_token" | | -| DELETE\_REGISTRY\_IMAGES | "delete_registry_images" | | -| DELETE\_ROOM | "delete_room" | | -| GET\_INTERNAL\_DOMAIN | "get_internal_domain" | | -| GET\_PROJECT\_MEMBERS | "get_project_members" | | -| GET\_REGISTRY\_IMAGES | "get_registry_images" | | -| MANAGE\_CHANNEL\_SUBSCRIBERS | "manage_channel_subscribers" | | -| MESSAGE\_TOKEN | "message_token" | | -| PUBLISH\_CHANNEL\_MESSAGES | "publish_channel_messages" | | -| READ\_BILLING | "read_billing" | | -| READ\_CHANNELS | "read_channels" | | -| READ\_CONTAINER\_LOGS | "read_container_logs" | | -| READ\_DEPLOYMENTS | "read_deployments" | | -| READ\_GATEWAYS | "read_gateways" | | -| READ\_LEAP\_TOKENS | "read_leap_tokens" | | -| READ\_PROJECT\_SECRETS | "read_project_secrets" | | -| READ\_PROJECT\_TOKENS | "read_project_tokens" | | -| READ\_ROOM | "read_room" | | -| REMOVE\_MEMBER | "remove_member" | | -| REQUEST\_QUOTA\_INCREASE | "request_quota_increase" | | -| ROLLOUT | "rollout" | | -| UPDATE\_CHANNEL\_STATE | "update_channel_state" | | -| UPDATE\_CONTAINER\_CONFIG | "update_container_config" | | -| UPDATE\_CONTAINER\_STATE | "update_container_state" | | -| UPDATE\_LEAP\_TOKEN | "update_leap_token" | | - diff --git a/docs/js.projects.md b/docs/js.projects.md deleted file mode 100644 index 2ed89fc8..00000000 --- a/docs/js.projects.md +++ /dev/null @@ -1,35 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [projects](./js.projects.md) - -## projects variable - -Projects SDK client - -Signature: - -```typescript -projects: (client: APIClient) => { - getAllMembers(projectId?: Id<'project'>): Promise; - getCurrentMember(projectId: Id<'project'>): Promise; - projectTokens: { - delete(projectTokenId: Id<'ptkid'>, project?: Id<'project'>): Promise; - get(projectId?: Id<'project'>): Promise; - create(flags: number, projectId?: Id<'project'>): Promise; - }; - tokens: { - delete(projectTokenId: Id<'ptkid'>, project?: Id<'project'>): Promise; - get(projectId?: Id<'project'>): Promise; - create(flags: number, projectId?: Id<'project'>): Promise; - }; - secrets: { - getAll(projectId?: Id<'project'>): Promise; - create(name: string, value: string, projectId?: Id<'project'>): Promise; - delete(id: Id<'secret'> | Secret['name'], projectId?: Id<'project'>): Promise; - }; -} -``` diff --git a/docs/js.projectsendpoints.md b/docs/js.projectsendpoints.md deleted file mode 100644 index e666e15c..00000000 --- a/docs/js.projectsendpoints.md +++ /dev/null @@ -1,43 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectsEndpoints](./js.projectsendpoints.md) - -## ProjectsEndpoints type - -Signature: - -```typescript -declare type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { - project_member: Member; -}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/@this/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/:project_id/members', { - members: Member[]; -}> | Endpoint<'GET', '/v1/projects/@this/members', { - members: Member[]; -}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'POST', '/v1/projects/@this/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { - secrets: Secret[]; -}> | Endpoint<'GET', '/v1/projects/@this/secrets', { - secrets: Secret[]; -}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md), [Member](./js.member.md), [ProjectToken](./js.projecttoken.md), [Project](./js.project.md), [Secret](./js.secret.md) - diff --git a/docs/js.projecttier.md b/docs/js.projecttier.md deleted file mode 100644 index 0693bcce..00000000 --- a/docs/js.projecttier.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectTier](./js.projecttier.md) - -## ProjectTier enum - -Signature: - -```typescript -declare enum ProjectTier -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| FREE | "free" | | -| PAID | "paid" | | - diff --git a/docs/js.projecttoken.created_at.md b/docs/js.projecttoken.created_at.md deleted file mode 100644 index 4ff2416f..00000000 --- a/docs/js.projecttoken.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [created\_at](./js.projecttoken.created_at.md) - -## ProjectToken.created\_at property - -The time this project token was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.projecttoken.flags.md b/docs/js.projecttoken.flags.md deleted file mode 100644 index af2769a6..00000000 --- a/docs/js.projecttoken.flags.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [flags](./js.projecttoken.flags.md) - -## ProjectToken.flags property - -Permissions and flags that this project token can perform - -Signature: - -```typescript -flags: number; -``` diff --git a/docs/js.projecttoken.id.md b/docs/js.projecttoken.id.md deleted file mode 100644 index 1b4ef352..00000000 --- a/docs/js.projecttoken.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [id](./js.projecttoken.id.md) - -## ProjectToken.id property - -The Id of the project token - -Signature: - -```typescript -id: Id<'ptkid'>; -``` diff --git a/docs/js.projecttoken.md b/docs/js.projecttoken.md deleted file mode 100644 index b35917ad..00000000 --- a/docs/js.projecttoken.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) - -## ProjectToken interface - -A project token for a project - -Signature: - -```typescript -interface ProjectToken -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.projecttoken.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this project token was created | -| [flags](./js.projecttoken.flags.md) | | number | Permissions and flags that this project token can perform | -| [id](./js.projecttoken.id.md) | | [Id](./js.id.md)<'ptkid'> | The Id of the project token | -| [token](./js.projecttoken.token.md) | | [Id](./js.id.md)<'ptk'> | The key value. This will likely have half of the key obfuscated | - diff --git a/docs/js.projecttoken.token.md b/docs/js.projecttoken.token.md deleted file mode 100644 index 5a4ac224..00000000 --- a/docs/js.projecttoken.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectToken](./js.projecttoken.md) > [token](./js.projecttoken.token.md) - -## ProjectToken.token property - -The key value. This will likely have half of the key obfuscated - -Signature: - -```typescript -token: Id<'ptk'>; -``` diff --git a/docs/js.projecttype.md b/docs/js.projecttype.md deleted file mode 100644 index abf51c1e..00000000 --- a/docs/js.projecttype.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [ProjectType](./js.projecttype.md) - -## ProjectType enum - -Type of a project - -Signature: - -```typescript -declare enum ProjectType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| PERSONAL | "personal" | A personal project are created when you register an account | -| REGULAR | "regular" | A standard project type | - diff --git a/docs/js.query.md b/docs/js.query.md deleted file mode 100644 index 56b258ce..00000000 --- a/docs/js.query.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Query](./js.query.md) - -## Query type - -Generate a query object that includes typed URL params - -Signature: - -```typescript -declare type Query = ExtractRouteParams & Record; -``` -References: [ExtractRouteParams](./js.extractrouteparams.md) - diff --git a/docs/js.quotaoverrides.md b/docs/js.quotaoverrides.md deleted file mode 100644 index b621ac8b..00000000 --- a/docs/js.quotaoverrides.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaOverrides](./js.quotaoverrides.md) - -## QuotaOverrides interface - -Signature: - -```typescript -interface QuotaOverrides -``` diff --git a/docs/js.quotausage.md b/docs/js.quotausage.md deleted file mode 100644 index 343de5a0..00000000 --- a/docs/js.quotausage.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) - -## QuotaUsage interface - -Signature: - -```typescript -interface QuotaUsage -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.quotausage.ram.md) | | number | | -| [vcpu](./js.quotausage.vcpu.md) | | number | | - diff --git a/docs/js.quotausage.ram.md b/docs/js.quotausage.ram.md deleted file mode 100644 index 2f0bc2e4..00000000 --- a/docs/js.quotausage.ram.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [ram](./js.quotausage.ram.md) - -## QuotaUsage.ram property - -Signature: - -```typescript -ram: number; -``` diff --git a/docs/js.quotausage.vcpu.md b/docs/js.quotausage.vcpu.md deleted file mode 100644 index a4609646..00000000 --- a/docs/js.quotausage.vcpu.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [QuotaUsage](./js.quotausage.md) > [vcpu](./js.quotausage.vcpu.md) - -## QuotaUsage.vcpu property - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.regions.md b/docs/js.regions.md deleted file mode 100644 index a1cbc0e7..00000000 --- a/docs/js.regions.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Regions](./js.regions.md) - -## Regions enum - -Signature: - -```typescript -declare enum Regions -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| US\_EAST\_1 | "us-east-1" | | - diff --git a/docs/js.registry.md b/docs/js.registry.md deleted file mode 100644 index 29343b1d..00000000 --- a/docs/js.registry.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [registry](./js.registry.md) - -## registry variable - -Registry SDK client - -Signature: - -```typescript -registry: (client: APIClient) => { - images: { - getAll(project?: Id<'project'>): Promise; - getManifest(image: string): Promise<{ - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]>; - delete(image: string): Promise; - }; -} -``` diff --git a/docs/js.registryendpoints.md b/docs/js.registryendpoints.md deleted file mode 100644 index b924f713..00000000 --- a/docs/js.registryendpoints.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RegistryEndpoints](./js.registryendpoints.md) - -## RegistryEndpoints type - -Signature: - -```typescript -declare type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { - images: string[]; -}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; -}>; -``` -References: [Endpoint](./js.endpoint.md), [Empty](./js.empty.md) - diff --git a/docs/js.resources.md b/docs/js.resources.md deleted file mode 100644 index 70132304..00000000 --- a/docs/js.resources.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) - -## Resources interface - -Resources allocated to a deployment - -Signature: - -```typescript -interface Resources -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [ram](./js.resources.ram.md) | | [ByteSizeString](./js.bytesizestring.md) | Amount of memory to allocate in a readible format You can use the parseSize function to convert this to bytes. | -| [vcpu](./js.resources.vcpu.md) | | number | Amount of vCPU to allocate | -| [vgpu](./js.resources.vgpu.md) | | [Vgpu](./js.vgpu.md)\[\] | vGPUs to allocate | - diff --git a/docs/js.resources.ram.md b/docs/js.resources.ram.md deleted file mode 100644 index f4d6207d..00000000 --- a/docs/js.resources.ram.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [ram](./js.resources.ram.md) - -## Resources.ram property - -Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes. - -Signature: - -```typescript -ram: ByteSizeString; -``` diff --git a/docs/js.resources.vcpu.md b/docs/js.resources.vcpu.md deleted file mode 100644 index ebcb3493..00000000 --- a/docs/js.resources.vcpu.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vcpu](./js.resources.vcpu.md) - -## Resources.vcpu property - -Amount of vCPU to allocate - -Signature: - -```typescript -vcpu: number; -``` diff --git a/docs/js.resources.vgpu.md b/docs/js.resources.vgpu.md deleted file mode 100644 index cac4f7bf..00000000 --- a/docs/js.resources.vgpu.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Resources](./js.resources.md) > [vgpu](./js.resources.vgpu.md) - -## Resources.vgpu property - -vGPUs to allocate - -Signature: - -```typescript -vgpu: Vgpu[]; -``` diff --git a/docs/js.restartpolicy.md b/docs/js.restartpolicy.md deleted file mode 100644 index fcfb286e..00000000 --- a/docs/js.restartpolicy.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RestartPolicy](./js.restartpolicy.md) - -## RestartPolicy enum - -Restart policy for deployments - -Signature: - -```typescript -declare enum RestartPolicy -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| ALWAYS | "always" | | -| NEVER | "never" | | -| ON\_FAILURE | "on-failure" | | - diff --git a/docs/js.roles.md b/docs/js.roles.md deleted file mode 100644 index 0e333d1c..00000000 --- a/docs/js.roles.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [roles](./js.roles.md) - -## roles variable - -Bitwise role flags that a user can be as part of a project - -Signature: - -```typescript -roles: { - viewer: bigint; - editor: bigint; - admin: bigint; - owner: bigint; -} -``` diff --git a/docs/js.rolloutstate.md b/docs/js.rolloutstate.md deleted file mode 100644 index 53d6720f..00000000 --- a/docs/js.rolloutstate.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RolloutState](./js.rolloutstate.md) - -## RolloutState enum - -Rollout state for deployments - -Signature: - -```typescript -declare enum RolloutState -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| FAILED | "failed" | | -| FINISHED | "finished" | | -| PENDING | "pending" | | - diff --git a/docs/js.room.created_at.md b/docs/js.room.created_at.md deleted file mode 100644 index 433be446..00000000 --- a/docs/js.room.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [created\_at](./js.room.created_at.md) - -## Room.created\_at property - -The unix timestamp of when this stream was created - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.room.delivery_protocols.md b/docs/js.room.delivery_protocols.md deleted file mode 100644 index 197896db..00000000 --- a/docs/js.room.delivery_protocols.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [delivery\_protocols](./js.room.delivery_protocols.md) - -## Room.delivery\_protocols property - -Protocols that are supported by this room to the client - -Signature: - -```typescript -delivery_protocols: DeliveryProtocol[]; -``` diff --git a/docs/js.room.id.md b/docs/js.room.id.md deleted file mode 100644 index 2ec7f4f4..00000000 --- a/docs/js.room.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [id](./js.room.id.md) - -## Room.id property - -The ID of this stream - -Signature: - -```typescript -id: Id<'pipe_room'>; -``` diff --git a/docs/js.room.ingest_endpoint.md b/docs/js.room.ingest_endpoint.md deleted file mode 100644 index 8abeaa5d..00000000 --- a/docs/js.room.ingest_endpoint.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_endpoint](./js.room.ingest_endpoint.md) - -## Room.ingest\_endpoint property - -The URL that you can stream to - -Signature: - -```typescript -ingest_endpoint: string; -``` diff --git a/docs/js.room.ingest_protocol.md b/docs/js.room.ingest_protocol.md deleted file mode 100644 index 672c9a50..00000000 --- a/docs/js.room.ingest_protocol.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_protocol](./js.room.ingest_protocol.md) - -## Room.ingest\_protocol property - -Protocol you can stream with - -Signature: - -```typescript -ingest_protocol: 'rtmp'; -``` diff --git a/docs/js.room.ingest_region.md b/docs/js.room.ingest_region.md deleted file mode 100644 index 1ac0ab09..00000000 --- a/docs/js.room.ingest_region.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [ingest\_region](./js.room.ingest_region.md) - -## Room.ingest\_region property - -The region that the stream url is located in - -Signature: - -```typescript -ingest_region: Regions; -``` diff --git a/docs/js.room.join_token.md b/docs/js.room.join_token.md deleted file mode 100644 index f701d3db..00000000 --- a/docs/js.room.join_token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [join\_token](./js.room.join_token.md) - -## Room.join\_token property - -A join token to subscribe into this room - -Signature: - -```typescript -join_token: string; -``` diff --git a/docs/js.room.md b/docs/js.room.md deleted file mode 100644 index 438ec36e..00000000 --- a/docs/js.room.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) - -## Room interface - -Signature: - -```typescript -interface Room -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.room.created_at.md) | | [Timestamp](./js.timestamp.md) | The unix timestamp of when this stream was created | -| [delivery\_protocols](./js.room.delivery_protocols.md) | | [DeliveryProtocol](./js.deliveryprotocol.md)\[\] | Protocols that are supported by this room to the client | -| [id](./js.room.id.md) | | [Id](./js.id.md)<'pipe\_room'> | The ID of this stream | -| [ingest\_endpoint](./js.room.ingest_endpoint.md) | | string | The URL that you can stream to | -| [ingest\_protocol](./js.room.ingest_protocol.md) | | 'rtmp' | Protocol you can stream with | -| [ingest\_region](./js.room.ingest_region.md) | | [Regions](./js.regions.md) | The region that the stream url is located in | -| [join\_token](./js.room.join_token.md) | | string | A join token to subscribe into this room | -| [name](./js.room.name.md) | | string | The name of this room | -| [state](./js.room.state.md) | | 'live' \| 'offline' | The state of the stream currently | - diff --git a/docs/js.room.name.md b/docs/js.room.name.md deleted file mode 100644 index 705a6e13..00000000 --- a/docs/js.room.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [name](./js.room.name.md) - -## Room.name property - -The name of this room - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.room.state.md b/docs/js.room.state.md deleted file mode 100644 index bfa47804..00000000 --- a/docs/js.room.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Room](./js.room.md) > [state](./js.room.state.md) - -## Room.state property - -The state of the stream currently - -Signature: - -```typescript -state: 'live' | 'offline'; -``` diff --git a/docs/js.runtimetype.md b/docs/js.runtimetype.md deleted file mode 100644 index d980ef63..00000000 --- a/docs/js.runtimetype.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [RuntimeType](./js.runtimetype.md) - -## RuntimeType enum - -Runtime types are used to describe the type of a deployment or container - -Signature: - -```typescript -declare enum RuntimeType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EPHEMERAL | "ephemeral" | Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically. | -| PERSISTENT | "persistent" | Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically. | -| STATEFUL | "stateful" | Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached. | - diff --git a/docs/js.secret.created_at.md b/docs/js.secret.created_at.md deleted file mode 100644 index b28a9883..00000000 --- a/docs/js.secret.created_at.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [created\_at](./js.secret.created_at.md) - -## Secret.created\_at property - -The time this secret was created at - -Signature: - -```typescript -created_at: Timestamp; -``` diff --git a/docs/js.secret.digest.md b/docs/js.secret.digest.md deleted file mode 100644 index 93e79489..00000000 --- a/docs/js.secret.digest.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [digest](./js.secret.digest.md) - -## Secret.digest property - -A digest hash of the secret - -Signature: - -```typescript -digest: string; -``` diff --git a/docs/js.secret.id.md b/docs/js.secret.id.md deleted file mode 100644 index 6a9d0d47..00000000 --- a/docs/js.secret.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [id](./js.secret.id.md) - -## Secret.id property - -The ID of the secret - -Signature: - -```typescript -id: Id<'secret'>; -``` diff --git a/docs/js.secret.md b/docs/js.secret.md deleted file mode 100644 index 75cd9fb3..00000000 --- a/docs/js.secret.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) - -## Secret interface - -Signature: - -```typescript -interface Secret -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [created\_at](./js.secret.created_at.md) | | [Timestamp](./js.timestamp.md) | The time this secret was created at | -| [digest](./js.secret.digest.md) | | string | A digest hash of the secret | -| [id](./js.secret.id.md) | | [Id](./js.id.md)<'secret'> | The ID of the secret | -| [name](./js.secret.name.md) | | string | The name of the secret | - diff --git a/docs/js.secret.name.md b/docs/js.secret.name.md deleted file mode 100644 index 653530e7..00000000 --- a/docs/js.secret.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Secret](./js.secret.md) > [name](./js.secret.name.md) - -## Secret.name property - -The name of the secret - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.setstateaction.md b/docs/js.setstateaction.md deleted file mode 100644 index c55baf97..00000000 --- a/docs/js.setstateaction.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [SetStateAction](./js.setstateaction.md) - -## SetStateAction type - -New state to set to a channel, or a callback function that will produce the new state - -Signature: - -```typescript -declare type SetStateAction = T | ((oldState: T) => T | Promise); -``` -References: [State](./js.state.md) - diff --git a/docs/js.state.md b/docs/js.state.md deleted file mode 100644 index 91570529..00000000 --- a/docs/js.state.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [State](./js.state.md) - -## State type - -Signature: - -```typescript -declare type State = Record; -``` diff --git a/docs/js.successfulapiresponse.md b/docs/js.successfulapiresponse.md deleted file mode 100644 index da2e0365..00000000 --- a/docs/js.successfulapiresponse.md +++ /dev/null @@ -1,14 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [SuccessfulAPIResponse](./js.successfulapiresponse.md) - -## SuccessfulAPIResponse type - -Signature: - -```typescript -declare type SuccessfulAPIResponse = { - success: true; - data: T; -}; -``` diff --git a/docs/js.supports_intl.md b/docs/js.supports_intl.md deleted file mode 100644 index 38e7325b..00000000 --- a/docs/js.supports_intl.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [SUPPORTS\_INTL](./js.supports_intl.md) - -## SUPPORTS\_INTL variable - -If this runtiem supports the Intl API - -Signature: - -```typescript -SUPPORTS_INTL: boolean -``` diff --git a/docs/js.tag.md b/docs/js.tag.md deleted file mode 100644 index d2b1c96e..00000000 --- a/docs/js.tag.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Tag](./js.tag.md) - -## Tag type - -Tag a type to make it unique - -Signature: - -```typescript -declare type Tag = T & { - ___tag: Name; -}; -``` diff --git a/docs/js.timestamp.md b/docs/js.timestamp.md deleted file mode 100644 index b9c0f9b8..00000000 --- a/docs/js.timestamp.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Timestamp](./js.timestamp.md) - -## Timestamp type - -An ISO 8601 date strings - -Signature: - -```typescript -declare type Timestamp = Tag; -``` -References: [Tag](./js.tag.md) - diff --git a/docs/js.units.md b/docs/js.units.md deleted file mode 100644 index fed751ae..00000000 --- a/docs/js.units.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [units](./js.units.md) - -## units variable - -> Warning: This API is now obsolete. -> -> use `byteUnits` instead -> - -Signature: - -```typescript -units: readonly ["GB", "MB", "KB", "B"] -``` diff --git a/docs/js.user.email.md b/docs/js.user.email.md deleted file mode 100644 index 6c90f052..00000000 --- a/docs/js.user.email.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [email](./js.user.email.md) - -## User.email property - -The email of the user - -Signature: - -```typescript -email: string; -``` diff --git a/docs/js.user.id.md b/docs/js.user.id.md deleted file mode 100644 index 404e7ca0..00000000 --- a/docs/js.user.id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [id](./js.user.id.md) - -## User.id property - -The ID of the user - -Signature: - -```typescript -id: Id<'user'>; -``` diff --git a/docs/js.user.md b/docs/js.user.md deleted file mode 100644 index 4382cd49..00000000 --- a/docs/js.user.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) - -## User interface - -A user objct - -Signature: - -```typescript -interface User -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [email](./js.user.email.md) | | string | The email of the user | -| [id](./js.user.id.md) | | [Id](./js.id.md)<'user'> | The ID of the user | -| [name](./js.user.name.md) | | string | The name of the user. Think of this as a display name | -| [username](./js.user.username.md) | | string | A unqiue username for the user | - diff --git a/docs/js.user.name.md b/docs/js.user.name.md deleted file mode 100644 index 36394000..00000000 --- a/docs/js.user.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [name](./js.user.name.md) - -## User.name property - -The name of the user. Think of this as a display name - -Signature: - -```typescript -name: string; -``` diff --git a/docs/js.user.username.md b/docs/js.user.username.md deleted file mode 100644 index 1b929208..00000000 --- a/docs/js.user.username.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [User](./js.user.md) > [username](./js.user.username.md) - -## User.username property - -A unqiue username for the user - -Signature: - -```typescript -username: string; -``` diff --git a/docs/js.userendpoints.md b/docs/js.userendpoints.md deleted file mode 100644 index c9a3effc..00000000 --- a/docs/js.userendpoints.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [UserEndpoints](./js.userendpoints.md) - -## UserEndpoints type - -Signature: - -```typescript -declare type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { - projects: Project[]; - user: User; - project_member_role_map: Record, MemberRole>; - leap_token: string | null; -}> | Endpoint<'POST', '/v1/users/@me/pats', { - pat: PAT; -}, { - name: string; -}> | Endpoint<'GET', '/v1/users/@me/pats', { - pats: PAT[]; -}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; -``` -References: [Endpoint](./js.endpoint.md), [Project](./js.project.md), [User](./js.user.md), [Id](./js.id.md), [MemberRole](./js.memberrole.md), [PAT](./js.pat.md), [Empty](./js.empty.md) - diff --git a/docs/js.users.md b/docs/js.users.md deleted file mode 100644 index 46545e51..00000000 --- a/docs/js.users.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [users](./js.users.md) - -## users variable - -Users SDK client - -Signature: - -```typescript -users: (client: APIClient) => { - me: { - get(): Promise<{ - projects: Project[]; - user: User; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: Id<'pat'>): Promise; - }; - }; -} -``` diff --git a/docs/js.validateapiauthentication.md b/docs/js.validateapiauthentication.md deleted file mode 100644 index cfbf7dc1..00000000 --- a/docs/js.validateapiauthentication.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateAPIAuthentication](./js.validateapiauthentication.md) - -## validateAPIAuthentication() function - -Validates that an authentication prefix is valid - -Signature: - -```typescript -declare function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| auth | string | The prefix to validate | - -Returns: - -auth is [APIAuthenticationPrefix](./js.apiauthenticationprefix.md) - -`true` if the prefix is valid, `false` otherwise - diff --git a/docs/js.validateid.md b/docs/js.validateid.md deleted file mode 100644 index 96f355c5..00000000 --- a/docs/js.validateid.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateId](./js.validateid.md) - -## validateId() function - -Validates that a string is a valid ID - -Signature: - -```typescript -declare function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| maybeId | string \| undefined \| null | A string that might be an id | -| prefix | T \| T\[\] | (Optional) Optionally an id prefix to check against | - -Returns: - -maybeId is [Id](./js.id.md)<T> - -true if the string is an id - diff --git a/docs/js.validateidprefix.md b/docs/js.validateidprefix.md deleted file mode 100644 index 59c6d9a0..00000000 --- a/docs/js.validateidprefix.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [validateIdPrefix](./js.validateidprefix.md) - -## validateIdPrefix() function - -Checks if a string is a valid Hop ID prefix - -Signature: - -```typescript -declare function validateIdPrefix(prefix: string, expect?: T): prefix is T; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| prefix | string | A string that is a potential prefix | -| expect | T | (Optional) An expected prefix to check against | - -Returns: - -prefix is T - -- Whether the prefix is valid - diff --git a/docs/js.vgpu.count.md b/docs/js.vgpu.count.md deleted file mode 100644 index 7ffa7aa5..00000000 --- a/docs/js.vgpu.count.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [count](./js.vgpu.count.md) - -## Vgpu.count property - -The amount of vGPUs to allocate - -Signature: - -```typescript -count: number; -``` diff --git a/docs/js.vgpu.md b/docs/js.vgpu.md deleted file mode 100644 index 3897532d..00000000 --- a/docs/js.vgpu.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) - -## Vgpu interface - -Virtual GPU config - -Signature: - -```typescript -interface Vgpu -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [count](./js.vgpu.count.md) | | number | The amount of vGPUs to allocate | -| [type](./js.vgpu.type.md) | | [VgpuType](./js.vgputype.md) | The type of vGPU to allocate | - diff --git a/docs/js.vgpu.type.md b/docs/js.vgpu.type.md deleted file mode 100644 index 9d3e5d20..00000000 --- a/docs/js.vgpu.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [Vgpu](./js.vgpu.md) > [type](./js.vgpu.type.md) - -## Vgpu.type property - -The type of vGPU to allocate - -Signature: - -```typescript -type: VgpuType; -``` diff --git a/docs/js.vgputype.md b/docs/js.vgputype.md deleted file mode 100644 index 72d39dd5..00000000 --- a/docs/js.vgputype.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VgpuType](./js.vgputype.md) - -## VgpuType enum - -Types for supported GPU - -Signature: - -```typescript -declare enum VgpuType -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| A400 | "a400" | | - diff --git a/docs/js.volumedefinition.fs.md b/docs/js.volumedefinition.fs.md deleted file mode 100644 index 13e0bde3..00000000 --- a/docs/js.volumedefinition.fs.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [fs](./js.volumedefinition.fs.md) - -## VolumeDefinition.fs property - -The format of the volume - -Signature: - -```typescript -fs: VolumeFormat; -``` diff --git a/docs/js.volumedefinition.md b/docs/js.volumedefinition.md deleted file mode 100644 index 0a63f366..00000000 --- a/docs/js.volumedefinition.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) - -## VolumeDefinition interface - -Signature: - -```typescript -interface VolumeDefinition -``` - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [fs](./js.volumedefinition.fs.md) | | [VolumeFormat](./js.volumeformat.md) | The format of the volume | -| [mount\_path](./js.volumedefinition.mount_path.md) | | string | The mount point of the volume | -| [size](./js.volumedefinition.size.md) | | [ByteSizeString](./js.bytesizestring.md) | The size of the volume in bytes | - diff --git a/docs/js.volumedefinition.mount_path.md b/docs/js.volumedefinition.mount_path.md deleted file mode 100644 index b089b026..00000000 --- a/docs/js.volumedefinition.mount_path.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [mount\_path](./js.volumedefinition.mount_path.md) - -## VolumeDefinition.mount\_path property - -The mount point of the volume - -Signature: - -```typescript -mount_path: string; -``` diff --git a/docs/js.volumedefinition.size.md b/docs/js.volumedefinition.size.md deleted file mode 100644 index 493b250e..00000000 --- a/docs/js.volumedefinition.size.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeDefinition](./js.volumedefinition.md) > [size](./js.volumedefinition.size.md) - -## VolumeDefinition.size property - -The size of the volume in bytes - -Signature: - -```typescript -size: ByteSizeString; -``` diff --git a/docs/js.volumeformat.md b/docs/js.volumeformat.md deleted file mode 100644 index 829d1752..00000000 --- a/docs/js.volumeformat.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@onehop/js](./js.md) > [VolumeFormat](./js.volumeformat.md) - -## VolumeFormat enum - -Signature: - -```typescript -declare enum VolumeFormat -``` - -## Enumeration Members - -| Member | Value | Description | -| --- | --- | --- | -| EXT4 | "ext4" | | -| XFS | "xfs" | | - From 15e4b2f655cc24afb11be845d97fbbbd1d084488 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 9 Jan 2023 22:40:25 +0000 Subject: [PATCH 13/33] feat: more work w/ api extractor docs --- api-extractor.json | 10 +- next-env.d.ts | 5 - package.json | 7 +- src/index.ts | 46 +- src/rest/index.ts | 17 +- src/rest/types/api.ts | 2 +- src/rest/types/index.ts | 16 +- src/sdks/create.ts | 3 +- src/sdks/ignite.ts | 2 +- src/util/size.ts | 52 +- temp/js.api.md | 1814 +++++++++++++++++++++++++++++++++++++++ yarn.lock | 1152 +++++++++++-------------- 12 files changed, 2431 insertions(+), 695 deletions(-) delete mode 100644 next-env.d.ts create mode 100644 temp/js.api.md diff --git a/api-extractor.json b/api-extractor.json index ccbf8401..06d3251e 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -5,10 +5,15 @@ "bundledPackages": [], - "compiler": {}, + "compiler": { + "overrideTsconfig": { + "moduleResolution": "NodeNext" + } + }, "apiReport": { - "enabled": false + "enabled": true, + "reportFolder": "/.temp" }, "docModel": { @@ -34,6 +39,7 @@ "logLevel": "warning" } }, + "tsdocMessageReporting": { "default": { "logLevel": "warning" diff --git a/next-env.d.ts b/next-env.d.ts deleted file mode 100644 index 4f11a03d..00000000 --- a/next-env.d.ts +++ /dev/null @@ -1,5 +0,0 @@ -/// -/// - -// NOTE: This file should not be edited -// see https://nextjs.org/docs/basic-features/typescript for more information. diff --git a/package.json b/package.json index b579f9ec..0ff1825f 100644 --- a/package.json +++ b/package.json @@ -43,13 +43,14 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "docs": "yarn build && api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "docs": "api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "fullbuild": "yarn build && yarn docs", "test": "tsx tests/index.ts" }, "devDependencies": { "@changesets/cli": "2.26.0", - "@microsoft/api-documenter": "^7.19.20", - "@microsoft/api-extractor": "^7.33.2", + "@microsoft/api-documenter": "^7.19.27", + "@microsoft/api-extractor": "^7.33.7", "@types/glob": "8.0.0", "@types/node": "18.11.18", "dotenv": "16.0.3", diff --git a/src/index.ts b/src/index.ts index 60c48efe..c021b60f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -3,6 +3,25 @@ export * from './permissions.ts'; export * from './rest/index.ts'; // Commonly used in the API, so nice to export in two place export {type APIAuthentication} from './rest/index.ts'; +export type { + Channel, + ChannelToken, + Container, + ContainerLog, + DeliveryProtocol, + Deployment, + Gateway, + GatewayType, + Member, + MemberRole, + PAT, + Project, + ProjectToken, + Room, + Secret, + State, + User, +} from './rest/index.ts'; export {ChannelType} from './rest/types/channels.ts'; export { ContainerState, @@ -10,30 +29,5 @@ export { RolloutState, RuntimeType, } from './rest/types/ignite.ts'; +export * as sdks from './sdks/index.ts'; export * from './util/index.ts'; -export * from './hop.js'; -export * from './permissions.js'; -export * from './rest/index.js'; -export * from './util/index.js'; - -export type { - Project, - User, - MemberRole, - PAT, - Member, - ProjectToken, - Secret, - Channel, - ChannelToken, - State, - Deployment, - Container, - ContainerLog, - Gateway, - Room, - GatewayType, - DeliveryProtocol, -} from './rest/index.js'; - -export * from './sdks/index.js'; diff --git a/src/rest/index.ts b/src/rest/index.ts index 7708cbb3..130fef87 100644 --- a/src/rest/index.ts +++ b/src/rest/index.ts @@ -1,13 +1,10 @@ -export * from './client.js'; export * from './client.ts'; -export * from './endpoints.js'; export * from './endpoints.ts'; -export * from './types/api.js'; -export * from './types/channels.js'; -export * from './types/ignite.js'; -export * from './types/index.js'; +export * from './types/api.ts'; +export * from './types/channels.ts'; +export * from './types/ignite.ts'; export * from './types/index.ts'; -export * from './types/pipe.js'; -export * from './types/projects.js'; -export * from './types/registry.js'; -export * from './types/users.js'; +export * from './types/pipe.ts'; +export * from './types/projects.ts'; +export * from './types/registry.ts'; +export * from './types/users.ts'; diff --git a/src/rest/types/api.ts b/src/rest/types/api.ts index 11931454..098cd02a 100644 --- a/src/rest/types/api.ts +++ b/src/rest/types/api.ts @@ -3,4 +3,4 @@ export * as Ignite from './ignite.ts'; export * as Pipe from './pipe.ts'; export * as Projects from './projects.ts'; export * as Registry from './registry.ts'; -export * as Users from './users.ts'; +export * as users from './users.ts'; diff --git a/src/rest/types/index.ts b/src/rest/types/index.ts index c6520d1b..05b1bcdd 100644 --- a/src/rest/types/index.ts +++ b/src/rest/types/index.ts @@ -1,10 +1,10 @@ export * from '../../util/types.ts'; +export { + /** + * All types defined in the Hop API + * @public + */ + API, +}; -/** - * API defines all types for the Hop API - * @public - */ -import * as API from './api.js'; -export * from '../../util/types.js'; - -export {API}; +import * as API from './api.ts'; diff --git a/src/sdks/create.ts b/src/sdks/create.ts index 1fd21269..60d24e43 100644 --- a/src/sdks/create.ts +++ b/src/sdks/create.ts @@ -1,5 +1,6 @@ import {APIClient} from '../rest/index.ts'; -export function sdk(builder: (client: APIClient) => T) { +// TODO: Add `const T` here when esbuild supports it +export function sdk(builder: (client: APIClient) => T) { return builder; } diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 4f31bab5..d19689c3 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -1,4 +1,4 @@ -import {type Infer, create} from '@onehop/json-methods'; +import {Infer, create} from '@onehop/json-methods'; import {API, Id, assertId} from '../rest/index.ts'; import { Deployment, diff --git a/src/util/size.ts b/src/util/size.ts index 0f925726..b5f5aebe 100644 --- a/src/util/size.ts +++ b/src/util/size.ts @@ -1,11 +1,34 @@ +/** + * API parsable byte size units strings + * @public + */ export const byteUnits = ['GB', 'MB', 'KB', 'B'] as const; + +/** + * Byte size unit type + * @public + */ export type ByteUnit = typeof byteUnits[number]; +/** + * A string representing a byte size + * @public + */ export type ByteSizeString = `${number}${ByteUnit}`; -/** @deprecated */ +/** + * A string representing a byte size + * @public + * @deprecated use `ByteSizeString` instead + */ export type ByteString = ByteSizeString; +/** + * Validates if a string is a valid byte size string + * @param value A string to validate if it is a valid byte size string + * @returns If the string is a valid byte size string + * @public + */ export function isValidByteString(value: string): value is ByteSizeString { return byteUnits.some(unit => { if (!value.endsWith(unit)) { @@ -23,18 +46,43 @@ const multipliers: Record = { GB: 1024 * 1024 * 1024, }; +/** + * Helper function to converts a numerical size to a valid byte size string + * @param size A size to convert to a valid byte size string + * @param unit An optional unit to as the size unit. Defaults to B + * @returns a byte size string + * @public + */ export function bytes(size: number, unit: ByteUnit = 'B'): ByteSizeString { return `${size}${unit}`; } +/** + * Converts a kilobyte size to a byte size string + * @param size Kilobytes to convert to a byte size string + * @returns a byte size string + * @public + */ export function kilobytes(size: number): ByteSizeString { return bytes(size, 'KB'); } +/** + * Converts a megabyte size to a byte size string + * @param size Megabytes to convert to a byte size string + * @returns a byte size string + * @public + */ export function megabytes(size: number): ByteSizeString { return bytes(size, 'MB'); } +/** + * Converts a gigabyte size to a byte size string + * @param size Gigabytes to convert to a byte size string + * @returns a byte size string + * @public + */ export function gigabytes(size: number): ByteSizeString { return bytes(size, 'GB'); } @@ -42,6 +90,7 @@ export function gigabytes(size: number): ByteSizeString { /** * Parses a byte size string into bytes * @param size - The size of anything in gigabytes, megabytes, kilobytes or bytes + * @public */ export function parseSize(size: string) { size = size.toUpperCase(); @@ -61,5 +110,6 @@ export function parseSize(size: string) { /** * @deprecated use `byteUnits` instead + * @public */ export const units = byteUnits; diff --git a/temp/js.api.md b/temp/js.api.md new file mode 100644 index 00000000..c7d82e20 --- /dev/null +++ b/temp/js.api.md @@ -0,0 +1,1814 @@ +## API Report File for "@onehop/js" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +// @public +export type AnyId = Id; + +// @public (undocumented) +export namespace API { + { + channels$1 as Channels, + ignite$1 as Ignite, + pipe$1 as Pipe, + projects$1 as Projects, + registry$1 as Registry, + users$1 as users, + }; +} + +// @public +export type APIAuthentication = Id; + +// @public +export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; + +// @public +export class APIClient { + constructor(options: APIClientOptions); + // (undocumented) + readonly authType: APIAuthenticationPrefix; + // (undocumented) + delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }>)["res"]>; + // (undocumented) + get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; + leap_token: string | null; + }>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract | null>>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }>)["res"]>; + // (undocumented) + static getAuthType(auth: APIAuthentication): APIAuthenticationPrefix; + // (undocumented) + patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }> | Extract>>, { + path: Path; + method: 'PATCH'; + }>)["res"]>; + // (undocumented) + post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract | null; + }>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }>)["res"]>; + // (undocumented) + put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract | null; + }>, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }>)["res"]>; + // (undocumented) + raw(request: Request): Promise; + // (undocumented) + readonly url: (path: Path, query: Query) => string; +} + +// @public +export interface APIClientOptions { + // (undocumented) + readonly authentication: APIAuthentication; + // (undocumented) + readonly baseUrl: string; +} + +// @public (undocumented) +export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; + +// @public +export function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; + +// @public +export interface Auth { + // (undocumented) + password: string; + // (undocumented) + username: string; +} + +// @public +export const BROAD_PERMISSIONS_MAP: { + MANAGE_MEMBERS: bigint; + MANAGE_PROJECT_TOKENS: bigint; + MANAGE_DEPLOYMENTS: bigint; + MANAGE_PIPE: bigint; + MANAGE_SECRETS: bigint; + MANAGE_CHANNELS: bigint; + MANAGE_REGISTRY: bigint; + READ_ONLY: bigint; + MANAGE_QUOTAS: bigint; + MANAGE_ROLLOUTS: bigint; + MANAGE_BILLING: bigint; +}; + +// @public +export interface Build { + deployment_id: Id<'deployment'>; + digest: string | null; + finished_at: Timestamp | null; + id: Id<'build'>; + metadata: BuildMetaData | null; + method: BuildMethod; + started_at: Timestamp; + state: BuildState; +} + +// @public +export interface BuildMetaData { + account_type?: 'user' | 'organization'; + author?: { + avatar_url: string; + username: string; + }; + branch: string; + commit_msg: string; + commit_sha: string; + commit_url?: string; + repo_id: number; + repo_name: string; +} + +// @public +export enum BuildMethod { + // (undocumented) + CLI = "cli", + // (undocumented) + GITHUB = "github" +} + +// @public (undocumented) +export enum BuildState { + // (undocumented) + CANCELLED = "cancelled", + // (undocumented) + FAILED = "failed", + // (undocumented) + PENDING = "pending", + // (undocumented) + SUCCEEDED = "succeeded" +} + +// @public +export function bytes(size: number, unit?: ByteUnit): ByteSizeString; + +// @public +export type ByteSizeString = `${number}${ByteUnit}`; + +// @public @deprecated +export type ByteString = ByteSizeString; + +// @public +export type ByteUnit = typeof byteUnits[number]; + +// @public +export const byteUnits: readonly ["GB", "MB", "KB", "B"]; + +// @public (undocumented) +export interface Channel { + capabilities: number; + created_at: Timestamp; + id: string; + project: Project; + state: State; + type: ChannelType; +} + +// @public (undocumented) +export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'PUT', '/v1/channels/:channel_id', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'POST', '/v1/channels/tokens', { + token: ChannelToken; +}, { + state: State; +}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { + channel: Channel; +}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { + tokens: ChannelToken[]; +}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { + state: State; +}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'GET', '/v1/channels', { + channels: Channel[]; +}> | Endpoint<'GET', '/v1/channels/tokens/:token', { + token: ChannelToken; +}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { + token: ChannelToken; +}, { + expiresAt?: Timestamp | null; + state: ChannelToken['state']; +}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { + stats: { + online_count: number; + }; +}>; + +// @public (undocumented) +export namespace Channels { + { + channels$1_Channel as Channel, + channels$1_ChannelEndpoints as ChannelEndpoints, + channels$1_ChannelToken as ChannelToken, + channels$1_ChannelType as ChannelType, + channels$1_State as State, + }; +} + +// @public (undocumented) +export interface ChannelToken { + id: Id<'leap_token'>; + is_online: boolean; + project_id: Id<'project'>; + state: State; +} + +// @public (undocumented) +export enum ChannelType { + // (undocumented) + PRIVATE = "private", + // (undocumented) + PUBLIC = "public", + // (undocumented) + UNPROTECTED = "unprotected" +} + +// @public (undocumented) +export interface Container { + created_at: Timestamp; + deployment_id: Id<'deployment'>; + id: Id<'container'>; + internal_ip: string; + metadata: { + last_exit_code?: number; + }; + metrics: { + cpu_usage_percent: number; + memory_usage_percent: number; + } | null; + region: Regions; + state: ContainerState; + type: RuntimeType; + uptime: { + last_start: Timestamp; + }; + volume: VolumeDefinition | null; +} + +// @public +export interface ContainerLog { + level: 'info' | 'error'; + message: string; + nonce: string; + timestamp: Timestamp; +} + +// @public +export enum ContainerState { + EXITED = "exited", + FAILED = "failed", + PENDING = "pending", + RUNNING = "running", + STOPPED = "stopped", + TERMINATING = "terminating" +} + +// @public (undocumented) +export type CreateDeploymentConfig = MakeOptional; + +// @public +export const DEFAULT_BASE_URL = "https://api.hop.io"; + +// @public (undocumented) +export interface DefaultQuotas { + // (undocumented) + ram: number; + // (undocumented) + vcpu: number; + // (undocumented) + volume: number; +} + +// @public (undocumented) +export type DeliveryProtocol = 'webrtc' | 'hls'; + +// @public (undocumented) +export interface Deployment { + active_build: Build | null; + // @deprecated + active_rollout: DeploymentRollout | null; + build_id: Build['id'] | null; + config: Omit; + container_count: number; + created_at: Timestamp; + id: Id<'deployment'>; + latest_rollout: DeploymentRollout | null; + metadata: DeploymentMetaData | null; + name: string; + running_container_count: number; + target_container_count: number; +} + +// @public +export type DeploymentConfig = { + name: string; + container_strategy: 'manual'; + type: RuntimeType; + version: '12-12-2022'; + cmd: string[]; + image: Image_2; + env: Record; + resources: Resources; + restart_policy: RestartPolicy; + volume?: VolumeDefinition; + entrypoint?: string[]; +}; + +// @public (undocumented) +export interface DeploymentMetaData { + // (undocumented) + container_port_mappings: Record, string[]>; +} + +// @public +export type DeploymentRollout = { + id: Id<'rollout'>; + deployment_id: Id<'deployment'>; + count: number; + created_at: Timestamp; + state: RolloutState; + build: Build | null; + init_container_id: string | null; + health_check_failed: boolean; + last_updated_at: Timestamp; + acknowledged: boolean; +}; + +// @public (undocumented) +export interface Domain { + created_at: Timestamp; + domain: string; + id: Id<'domain'>; + redirect: DomainRedirect | null; + state: DomainState; +} + +// @public (undocumented) +export interface DomainRedirect { + // (undocumented) + status_code: 301 | 302 | 307 | 308; + // (undocumented) + url: string; +} + +// @public (undocumented) +export enum DomainState { + // (undocumented) + PENDING = "pending", + // (undocumented) + SSL_ACTIVE = "ssl_active", + // (undocumented) + VALID_CNAME = "valid_cname" +} + +// @public +export type Empty = void; + +// @public (undocumented) +export type Endpoint = { + method: M; + path: Path; + res: Res; + body: Body; +}; + +// @public (undocumented) +export type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; + +// @public (undocumented) +export type ErroredAPIResponse = { + success: false; + error: { + code: string; + message: string; + }; +}; + +// @public +export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { + [k in Param | keyof ExtractRouteParams]: string | number; +} : T extends `${string}:${infer Param}` ? { + [k in Param]: string | number; +} : {}; + +// @public +export interface Gateway { + created_at: Timestamp; + deployment_id: Id<'deployment'>; + domains: Domain[]; + hopsh_domain: HopShDomain | null; + hopsh_domain_enabled: boolean; + id: Id<'gateway'>; + internal_domain: InternalHopDomain | null; + name: string; + // @alpha + protocol: 'http' | null; + target_port: number | null; + type: GatewayType; +} + +// @public +export enum GatewayType { + EXTERNAL = "external", + INTERNAL = "internal" +} + +// @public +export function getIdPrefix(id: string, expect?: T): T; + +// @public +export interface GHRepo { + // (undocumented) + account_name: string; + // (undocumented) + default_branch: string; + // (undocumented) + full_name: string; + // (undocumented) + id: number; + // (undocumented) + private: boolean; +} + +// @public +export function gigabytes(size: number): ByteSizeString; + +// @public (undocumented) +export type HealthCheck = { + id: Id<'health_check'>; + protocol: 'http'; + path: string; + port: number; + interval: number; + timeout: number; + initial_delay: number; + max_retries: number; +}; + +// @public +export class Hop { + constructor(options: PartialAPIOptions); + constructor(authentication: APIAuthentication, baseurl?: string); + // (undocumented) + readonly channels: { + create(type: ChannelType, id?: string | null | undefined, options?: { + state?: T | undefined; + } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + get(id: string): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + getAll(project?: `project_${string}` | undefined): Promise<(Channel & { + setState(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + })[]>; + subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; + subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + getAllTokens(channel: string | Channel): Promise; + setState(channel: string | Channel, state: SetStateAction): Promise; + patchState(channel: string | Channel, state: SetStateAction): Promise; + publishMessage(channel: string | Channel, event: string, data: T_5): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: `leap_token_${string}`): Promise; + create(state?: State, project?: `project_${string}` | undefined): Promise; + setState(id: `leap_token_${string}`, state: State): Promise; + get(id: `leap_token_${string}`): Promise; + isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; + publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; + }; + }; + // (undocumented) + readonly client: APIClient; + // (undocumented) + readonly ignite: { + domains: { + delete: (id: `domain_${string}`) => Promise; + get: (id: `domain_${string}`) => Promise; + }; + gateways: { + addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; + get(gatewayId: `gateway_${string}`): Promise; + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, config: { + type: GatewayType; + protocol: "http" | null; + targetPort: number; + name: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + }; + healthChecks: { + create: (deployment: `deployment_${string}`, config: Omit) => Promise; + update: (deployment: `deployment_${string}`, config: Partial>) => Promise; + }; + deployments: { + create: { + (configOrProject: `project_${string}`, bearerOrPatConfig: CreateDeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType; + protocol: "http" | null; + port: number; + name: string; + targetPort: number; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + (configOrProject: CreateDeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType; + protocol: "http" | null; + port: number; + name: string; + targetPort: number; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + }; + get: { + (name: string, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType; + protocol: "http" | null; + port: number; + name: string; + targetPort: number; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType; + protocol: "http" | null; + port: number; + name: string; + targetPort: number; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + }; + rollout(id: `deployment_${string}`): Promise; + getStorageStats(id: `deployment_${string}`): Promise | null>>; + update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; + getContainers(deployment: `deployment_${string}`): Promise; + getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType; + protocol: "http" | null; + port: number; + name: string; + targetPort: number; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + })[]>; + delete(deployment: `deployment_${string}`): Promise; + gateways: { + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, config: { + type: GatewayType; + protocol: "http" | null; + targetPort: number; + name: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + }; + }; + containers: { + delete(container: `container_${string}`): Promise; + getLogs(container: `container_${string}`, options?: Partial<{ + sortBy: "timestamp"; + orderBy: "desc" | "asc"; + limit: number; + offset: number; + }>): Promise; + stop(container: `container_${string}`): Promise; + start(container: `container_${string}`): Promise; + create(deployment: `deployment_${string}`): Promise; + }; + }; + // (undocumented) + readonly pipe: { + rooms: { + getAll(project?: `project_${string}` | undefined): Promise<(Room & { + delete(): Promise; + })[]>; + create(name: string, options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean | undefined; + ingestProtocol: "rtmp" | "rtp"; + hlsConfig?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } | undefined; + }): Promise; + }>; + delete(room: `pipe_room_${string}`): Promise; + }; + }; + // (undocumented) + readonly projects: { + getAllMembers(projectId?: `project_${string}` | undefined): Promise; + getCurrentMember(projectId: `project_${string}`): Promise; + projectTokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + tokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + secrets: { + getAll(projectId?: `project_${string}` | undefined): Promise; + create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; + delete(id: string, projectId?: `project_${string}` | undefined): Promise; + }; + }; + // (undocumented) + readonly registry: { + images: { + getAll(project?: `project_${string}` | undefined): Promise; + getManifest(image: string): Promise<{ + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]>; + delete(image: string): Promise; + }; + }; + // (undocumented) + readonly users: { + me: { + get(): Promise<{ + projects: Project[]; + user: User; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: `pat_${string}`): Promise; + }; + }; + }; +} + +// @public +export class HopAPIError extends Error { + constructor(request: Request, response: Response, data: ErroredAPIResponse); + // (undocumented) + readonly data: ErroredAPIResponse; + // (undocumented) + readonly request: Request; + // (undocumented) + readonly response: Response; + // (undocumented) + readonly status: number; +} + +// @public +export type HopShDomain = `${string}.hop.sh`; + +// @public +export type Id = `${T}_${string}`; + +// @public +export function id(maybeId: string | undefined | null, prefix?: T | T[]): Id; + +// @public +export const ID_PREFIXES: readonly [{ + readonly prefix: "user"; + readonly description: "Users"; +}, { + readonly prefix: "project"; + readonly description: "Project"; +}, { + readonly prefix: "pm"; + readonly description: "Project Members"; +}, { + readonly prefix: "role"; + readonly description: "Roles"; +}, { + readonly prefix: "pi"; + readonly description: "Project Invite"; +}, { + readonly prefix: "ptk"; + readonly description: "Project token"; +}, { + readonly prefix: "pat"; + readonly description: "User personal access token"; +}, { + readonly prefix: "container"; + readonly description: "Ignite container"; +}, { + readonly prefix: "pipe_room"; + readonly description: "Pipe room"; +}, { + readonly prefix: "deployment"; + readonly description: "Ignite deployment"; +}, { + readonly prefix: "bearer"; + readonly description: "Users bearer token"; +}, { + readonly prefix: "ptkid"; + readonly description: "Project token ID"; +}, { + readonly prefix: "secret"; + readonly description: "Project secret ID"; +}, { + readonly prefix: "gateway"; + readonly description: "Gateway"; +}, { + readonly prefix: "domain"; + readonly description: "Domain for a gateway"; +}, { + readonly prefix: "leap_token"; + readonly description: "Token for connecting to leap as a client"; +}, { + readonly prefix: "build"; + readonly description: "Build ID for build logs"; +}, { + readonly prefix: "rollout"; + readonly description: "Rollout ID for rollouts."; +}, { + readonly prefix: "health_check"; + readonly description: "Health check ID for health checks."; +}]; + +// @public +export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; + +// @public (undocumented) +export namespace Ignite { + { + ignite$1_Auth as Auth, + ignite$1_Build as Build, + ignite$1_BuildMetaData as BuildMetaData, + ignite$1_BuildMethod as BuildMethod, + ignite$1_BuildState as BuildState, + ignite$1_Container as Container, + ignite$1_ContainerLog as ContainerLog, + ignite$1_ContainerState as ContainerState, + ignite$1_CreateDeploymentConfig as CreateDeploymentConfig, + ignite$1_Deployment as Deployment, + ignite$1_DeploymentConfig as DeploymentConfig, + ignite$1_DeploymentMetaData as DeploymentMetaData, + ignite$1_DeploymentRollout as DeploymentRollout, + ignite$1_Domain as Domain, + ignite$1_DomainRedirect as DomainRedirect, + ignite$1_DomainState as DomainState, + ignite$1_GHRepo as GHRepo, + ignite$1_Gateway as Gateway, + ignite$1_GatewayType as GatewayType, + ignite$1_HealthCheck as HealthCheck, + ignite$1_IgniteEndpoints as IgniteEndpoints, + ignite$1_Image as Image, + ignite$1_ImageGHRepo as ImageGHRepo, + ignite$1_Regions as Regions, + ignite$1_Resources as Resources, + ignite$1_RestartPolicy as RestartPolicy, + ignite$1_RolloutState as RolloutState, + ignite$1_RuntimeType as RuntimeType, + ignite$1_Vgpu as Vgpu, + ignite$1_VgpuType as VgpuType, + ignite$1_VolumeDefinition as VolumeDefinition, + ignite$1_VolumeFormat as VolumeFormat, + }; +} + +// @public (undocumented) +export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { + deployments: Deployment[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { + containers: Container[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { + container: Container; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { + deployment_id: Id<'deployment'>; + container_id: Id<'container'>; +}> | Endpoint<'POST', '/v1/ignite/deployments', { + deployment: Deployment; +}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { + logs: ContainerLog[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/search', { + deployment: Deployment; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { + preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; +}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { + domain: string; +}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { + gateway: Gateway; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { + gateways: Gateway[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { + gateway: Gateway; +}, { + type: GatewayType; + target_port: number; + protocol: Gateway['protocol']; + name: string; +}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}, DeploymentConfig> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { + rollout: DeploymentRollout; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/health-check', { + health_check: HealthCheck; +}, Omit> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/storage', Record<'volume' | 'build_cache', Record<'provisioned_size' | 'used_size', number> | null>> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', { + health_check: HealthCheck; +}, Partial>> | Endpoint<'DELETE', '/v1/ignite/domains/:domain_id', Empty> | Endpoint<'GET', '/v1/ignite/domains/:domain_id', { + domain: Domain; +}>; + +// @public +interface Image_2 { + auth: Auth | null; + gh_repo: ImageGHRepo | null; + name: string | null; +} +export { Image_2 as Image } + +// @public +export interface ImageGHRepo { + // (undocumented) + branch: string; + // (undocumented) + full_name: string; + // (undocumented) + repo_id: number; +} + +// @public +export type InternalHopDomain = `${string}.hop`; + +// @public +export const IS_BROWSER: boolean; + +// @public +export function isValidByteString(value: string): value is ByteSizeString; + +// @public +export function kilobytes(size: number): ByteSizeString; + +// @public +export type MakeOptional = Omit & Partial>; + +// @public +export function megabytes(size: number): ByteSizeString; + +// @public (undocumented) +export type Member = Omit & { + id: Id<'pm'>; + role: MemberRole; + mfa_enabled: boolean; + joined_at: Timestamp; +}; + +// @public (undocumented) +export interface MemberRole { + flags: number; + id: Id<'role'>; + name: string; +} + +// @public +export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; + +// @public +export function parseSize(size: string): number; + +// @public +export type PartialAPIOptions = Partial> & Pick; + +// @public (undocumented) +export interface PAT { + created_at: Timestamp; + id: Id<'pat'>; + name: string | null; + // @alpha + pat: string; +} + +// @public +export const permissions: { + add(value: bigint, flag: bigint): bigint; + test(value: bigint, flag: bigint): boolean; + subtract(value: bigint, flag: bigint): bigint; +}; + +// @public +export const permissionsMap: { + add_member: bigint; + remove_member: bigint; + get_project_members: bigint; + delete_project: bigint; + delete_deployment: bigint; + delete_container: bigint; + update_container_state: bigint; + read_deployments: bigint; + create_deployment: bigint; + create_container: bigint; + update_container_config: bigint; + create_room: bigint; + read_room: bigint; + delete_room: bigint; + create_room_producer: bigint; + create_project_token: bigint; + delete_project_token: bigint; + read_project_tokens: bigint; + read_container_logs: bigint; + create_project_secret: bigint; + read_project_secrets: bigint; + delete_project_secret: bigint; + get_registry_images: bigint; + create_channel_token: bigint; + create_gateway: bigint; + add_domain: bigint; + delete_channels: bigint; + update_channel_state: bigint; + read_channels: bigint; + publish_channel_messages: bigint; + manage_channel_subscribers: bigint; + delete_domain: bigint; + delete_gateway: bigint; + get_internal_domain: bigint; + create_leap_token: bigint; + read_leap_tokens: bigint; + update_leap_token: bigint; + message_token: bigint; + create_channel: bigint; + rollout: bigint; + request_quota_increase: bigint; + read_billing: bigint; + read_gateways: bigint; + delete_registry_images: bigint; + container_ssh: bigint; + tunnel_deployment: bigint; +}; + +// @public (undocumented) +export namespace Pipe { + { + pipe$1_DeliveryProtocol as DeliveryProtocol, + pipe$1_PipeEndpoints as PipeEndpoints, + pipe$1_Room as Room, + }; +} + +// @public (undocumented) +export type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { + rooms: Room[]; +}> | Endpoint<'POST', '/v1/pipe/rooms', { + room: Room; +}, { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; +}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; + +// @public (undocumented) +export interface Project { + created_at: Timestamp; + // (undocumented) + default_quotas: DefaultQuotas; + icon: string | null; + id: Id<'project'>; + name: string; + namespace: string; + // (undocumented) + quota_overrides: QuotaOverrides; + // (undocumented) + quota_usage: QuotaUsage; + tier: ProjectTier; + type: ProjectType; +} + +// @public +export enum PROJECT_PERMISSION { + // (undocumented) + ADD_DOMAIN = "add_domain", + // (undocumented) + ADD_MEMBER = "add_member", + // (undocumented) + CONTAINER_SSH = "container_ssh", + // (undocumented) + CREATE_CHANNEL = "create_channel", + // (undocumented) + CREATE_CHANNEL_TOKEN = "create_channel_token", + // (undocumented) + CREATE_CONTAINER = "create_container", + // (undocumented) + CREATE_DEPLOYMENT = "create_deployment", + // (undocumented) + CREATE_GATEWAY = "create_gateway", + // (undocumented) + CREATE_LEAP_TOKEN = "create_leap_token", + // (undocumented) + CREATE_PROJECT_SECRET = "create_project_secret", + // (undocumented) + CREATE_PROJECT_TOKEN = "create_project_token", + // (undocumented) + CREATE_ROOM = "create_room", + // (undocumented) + CREATE_ROOM_PRODUCER = "create_room_producer", + // (undocumented) + DELETE_CHANNELS = "delete_channels", + // (undocumented) + DELETE_CONTAINER = "delete_container", + // (undocumented) + DELETE_DEPLOYMENT = "delete_deployment", + // (undocumented) + DELETE_DOMAIN = "delete_domain", + // (undocumented) + DELETE_GATEWAY = "delete_gateway", + // (undocumented) + DELETE_PROJECT = "delete_project", + // (undocumented) + DELETE_PROJECT_SECRET = "delete_project_secret", + // (undocumented) + DELETE_PROJECT_TOKEN = "delete_project_token", + // (undocumented) + DELETE_REGISTRY_IMAGES = "delete_registry_images", + // (undocumented) + DELETE_ROOM = "delete_room", + // (undocumented) + GET_INTERNAL_DOMAIN = "get_internal_domain", + // (undocumented) + GET_PROJECT_MEMBERS = "get_project_members", + // (undocumented) + GET_REGISTRY_IMAGES = "get_registry_images", + // (undocumented) + MANAGE_CHANNEL_SUBSCRIBERS = "manage_channel_subscribers", + // (undocumented) + MESSAGE_TOKEN = "message_token", + // (undocumented) + PUBLISH_CHANNEL_MESSAGES = "publish_channel_messages", + // (undocumented) + READ_BILLING = "read_billing", + // (undocumented) + READ_CHANNELS = "read_channels", + // (undocumented) + READ_CONTAINER_LOGS = "read_container_logs", + // (undocumented) + READ_DEPLOYMENTS = "read_deployments", + // (undocumented) + READ_GATEWAYS = "read_gateways", + // (undocumented) + READ_LEAP_TOKENS = "read_leap_tokens", + // (undocumented) + READ_PROJECT_SECRETS = "read_project_secrets", + // (undocumented) + READ_PROJECT_TOKENS = "read_project_tokens", + // (undocumented) + READ_ROOM = "read_room", + // (undocumented) + REMOVE_MEMBER = "remove_member", + // (undocumented) + REQUEST_QUOTA_INCREASE = "request_quota_increase", + // (undocumented) + ROLLOUT = "rollout", + // (undocumented) + TUNNEL_DEPLOYMENT = "tunnel_deployment", + // (undocumented) + UPDATE_CHANNEL_STATE = "update_channel_state", + // (undocumented) + UPDATE_CONTAINER_CONFIG = "update_container_config", + // (undocumented) + UPDATE_CONTAINER_STATE = "update_container_state", + // (undocumented) + UPDATE_LEAP_TOKEN = "update_leap_token" +} + +// @public (undocumented) +export namespace Projects { + { + projects$1_DefaultQuotas as DefaultQuotas, + projects$1_Member as Member, + projects$1_MemberRole as MemberRole, + projects$1_Project as Project, + projects$1_ProjectTier as ProjectTier, + projects$1_ProjectToken as ProjectToken, + projects$1_ProjectType as ProjectType, + projects$1_ProjectsEndpoints as ProjectsEndpoints, + projects$1_QuotaOverrides as QuotaOverrides, + projects$1_QuotaUsage as QuotaUsage, + projects$1_Secret as Secret, + }; +} + +// @public (undocumented) +export type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { + project_member: Member; +}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/@this/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/:project_id/members', { + members: Member[]; +}> | Endpoint<'GET', '/v1/projects/@this/members', { + members: Member[]; +}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'POST', '/v1/projects/@this/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { + secrets: Secret[]; +}> | Endpoint<'GET', '/v1/projects/@this/secrets', { + secrets: Secret[]; +}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; + +// @public (undocumented) +export enum ProjectTier { + // (undocumented) + FREE = "free", + // (undocumented) + PAID = "paid" +} + +// @public +export interface ProjectToken { + created_at: Timestamp; + flags: number; + id: Id<'ptkid'>; + token: Id<'ptk'>; +} + +// @public +export enum ProjectType { + PERSONAL = "personal", + REGULAR = "regular" +} + +// @public +export type Query = ExtractRouteParams & Record; + +// @public (undocumented) +export interface QuotaOverrides { +} + +// @public (undocumented) +export interface QuotaUsage { + // (undocumented) + ram: number; + // (undocumented) + vcpu: number; + // (undocumented) + volume: number; +} + +// @public (undocumented) +export enum Regions { + // (undocumented) + US_EAST_1 = "us-east-1" +} + +// @public (undocumented) +export namespace Registry { + { + registry$1_RegistryEndpoints as RegistryEndpoints, + }; +} + +// @public (undocumented) +export type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { + images: string[]; +}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; +}>; + +// @public +export interface Resources { + ram: ByteSizeString; + vcpu: number; + vgpu: Vgpu[]; +} + +// @public +export enum RestartPolicy { + // (undocumented) + ALWAYS = "always", + // (undocumented) + NEVER = "never", + // (undocumented) + ON_FAILURE = "on-failure" +} + +// @public +export const roles: { + viewer: bigint; + editor: bigint; + admin: bigint; + owner: bigint; +}; + +// @public +export enum RolloutState { + // (undocumented) + FAILED = "failed", + // (undocumented) + FINISHED = "finished", + // (undocumented) + PENDING = "pending" +} + +// @public (undocumented) +export interface Room { + created_at: Timestamp; + delivery_protocols: DeliveryProtocol[]; + id: Id<'pipe_room'>; + ingest_endpoint: string; + ingest_protocol: 'rtmp'; + ingest_region: Regions; + join_token: string; + name: string; + state: 'live' | 'offline'; +} + +// @public +export enum RuntimeType { + EPHEMERAL = "ephemeral", + PERSISTENT = "persistent", + STATEFUL = "stateful" +} + +// @public (undocumented) +export namespace sdks { + { + index_channels as channels, + index_ignite as ignite, + index_pipe as pipe, + index_projects as projects, + index_registry as registry, + index_users as users, + }; +} + +// @public (undocumented) +export interface Secret { + created_at: Timestamp; + digest: string; + id: Id<'secret'>; + in_use_by: Id<'deployment'>[]; + name: string; +} + +// @public +export type State = Record; + +// @public (undocumented) +export type SuccessfulAPIResponse = { + success: true; + data: T; +}; + +// @public +export const SUPPORTS_INTL: boolean; + +// @public +export type Tag = T & { + ___tag: Name; +}; + +// @public +export type Timestamp = Tag; + +// @public @deprecated (undocumented) +export const units: readonly ["GB", "MB", "KB", "B"]; + +// @public +export interface User { + email: string; + id: Id<'user'>; + name: string; + username: string; +} + +// @public (undocumented) +export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { + projects: Project[]; + user: User; + project_member_role_map: Record, MemberRole>; + leap_token: string | null; +}> | Endpoint<'POST', '/v1/users/@me/pats', { + pat: PAT; +}, { + name: string; +}> | Endpoint<'GET', '/v1/users/@me/pats', { + pats: PAT[]; +}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; + +// @public (undocumented) +export namespace users { + { + users$1_PAT as PAT, + users$1_User as User, + users$1_UserEndpoints as UserEndpoints, + }; +} + +// @public +export function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; + +// @public +export function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; + +// @public +export function validateIdPrefix(prefix: string, expect?: T): prefix is T; + +// @internal +export type _Values = T[keyof T]; + +// @public +export interface Vgpu { + count: number; + type: VgpuType; +} + +// @public +export enum VgpuType { + // (undocumented) + A400 = "a400" +} + +// @public (undocumented) +export interface VolumeDefinition { + fs: VolumeFormat; + mount_path: string; + size: ByteSizeString; +} + +// @public (undocumented) +export enum VolumeFormat { + // (undocumented) + EXT4 = "ext4", + // (undocumented) + XFS = "xfs" +} + +// Warnings were encountered during analysis: +// +// dist/index.d.ts:2103:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/yarn.lock b/yarn.lock index c51f19a5..0f6d6057 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1,3 +1,6 @@ +# This file is generated by running "yarn install" inside your project. +# Manual changes might be lost - proceed with caution! + __metadata: version: 6 cacheKey: 8 @@ -12,9 +15,9 @@ __metadata: linkType: hard "@babel/helper-validator-identifier@npm:^7.18.6": - version: 7.18.6 - resolution: "@babel/helper-validator-identifier@npm:7.18.6" - checksum: e295254d616bbe26e48c196a198476ab4d42a73b90478c9842536cf910ead887f5af6b5c4df544d3052a25ccb3614866fa808dc1e3a5a4291acd444e243c0648 + version: 7.19.1 + resolution: "@babel/helper-validator-identifier@npm:7.19.1" + checksum: 0eca5e86a729162af569b46c6c41a63e18b43dbe09fda1d2a3c8924f7d617116af39cac5e4cd5d431bb760b4dca3c0970e0c444789b1db42bcf1fa41fbad0a3a languageName: node linkType: hard @@ -29,7 +32,7 @@ __metadata: languageName: node linkType: hard -"@babel/runtime@npm:^7.20.1": +"@babel/runtime@npm:^7.20.1, @babel/runtime@npm:^7.5.5": version: 7.20.7 resolution: "@babel/runtime@npm:7.20.7" dependencies: @@ -38,15 +41,6 @@ __metadata: languageName: node linkType: hard -"@babel/runtime@npm:^7.5.5": - version: 7.19.0 - resolution: "@babel/runtime@npm:7.19.0" - dependencies: - regenerator-runtime: ^0.13.4 - checksum: fa69c351bb05e1db3ceb9a02fdcf620c234180af68cdda02152d3561015f6d55277265d3109815992f96d910f3db709458cae4f8df1c3def66f32e0867d82294 - languageName: node - linkType: hard - "@changesets/apply-release-plan@npm:^6.1.3": version: 6.1.3 resolution: "@changesets/apply-release-plan@npm:6.1.3" @@ -313,23 +307,16 @@ __metadata: languageName: node linkType: hard -"@esbuild/android-arm@npm:0.15.11": - version: 0.15.11 - resolution: "@esbuild/android-arm@npm:0.15.11" +"@esbuild/android-arm@npm:0.15.18": + version: 0.15.18 + resolution: "@esbuild/android-arm@npm:0.15.18" conditions: os=android & cpu=arm languageName: node linkType: hard -"@esbuild/linux-loong64@npm:0.15.11": - version: 0.15.11 - resolution: "@esbuild/linux-loong64@npm:0.15.11" - conditions: os=linux & cpu=loong64 - languageName: node - linkType: hard - -"@esbuild/linux-loong64@npm:0.15.3": - version: 0.15.3 - resolution: "@esbuild/linux-loong64@npm:0.15.3" +"@esbuild/linux-loong64@npm:0.15.18": + version: 0.15.18 + resolution: "@esbuild/linux-loong64@npm:0.15.18" conditions: os=linux & cpu=loong64 languageName: node linkType: hard @@ -367,44 +354,44 @@ __metadata: languageName: node linkType: hard -"@microsoft/api-documenter@npm:^7.19.20": - version: 7.19.20 - resolution: "@microsoft/api-documenter@npm:7.19.20" +"@microsoft/api-documenter@npm:^7.19.27": + version: 7.19.27 + resolution: "@microsoft/api-documenter@npm:7.19.27" dependencies: - "@microsoft/api-extractor-model": 7.25.1 - "@microsoft/tsdoc": 0.14.1 - "@rushstack/node-core-library": 3.53.2 - "@rushstack/ts-command-line": 4.12.5 + "@microsoft/api-extractor-model": 7.25.3 + "@microsoft/tsdoc": 0.14.2 + "@rushstack/node-core-library": 3.53.3 + "@rushstack/ts-command-line": 4.13.1 colors: ~1.2.1 js-yaml: ~3.13.1 - resolve: ~1.17.0 + resolve: ~1.22.1 bin: api-documenter: bin/api-documenter - checksum: 31bc23c4a5971a97c509d3eabc09e5fc1522bf50ea61e7373ebbd572cb2c31129bdc34070cc7ff9ca85f683236260684f93565edb2c83c7418cd33a65304bd6d + checksum: f243f473e1fe58e1cd6e32aad223724b6b621f569276415380abc4845859bf5c23fbe0e370be2a218f362a6c85b01b44b5427336f55800f2ea8bf3f398b0ee41 languageName: node linkType: hard -"@microsoft/api-extractor-model@npm:7.25.1": - version: 7.25.1 - resolution: "@microsoft/api-extractor-model@npm:7.25.1" +"@microsoft/api-extractor-model@npm:7.25.3": + version: 7.25.3 + resolution: "@microsoft/api-extractor-model@npm:7.25.3" dependencies: - "@microsoft/tsdoc": 0.14.1 + "@microsoft/tsdoc": 0.14.2 "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.53.2 - checksum: fd63f794358b92de84dda95c545ad8147ebd0c71bb4aff63d2ef4f727243d5de7251aa3301f3f917dda1e84248683d9a569a5aa884124fc1f1f6e40444ba8633 + "@rushstack/node-core-library": 3.53.3 + checksum: 532ca30606b5649e90035ef70ff46868f6ccc63181e10b783bc5092e580bcb133112b300799b8f71a19da2b79f685a55f7ddbe84c8fe7ad93d71359c1763c521 languageName: node linkType: hard -"@microsoft/api-extractor@npm:^7.33.2": - version: 7.33.2 - resolution: "@microsoft/api-extractor@npm:7.33.2" +"@microsoft/api-extractor@npm:^7.33.7": + version: 7.33.7 + resolution: "@microsoft/api-extractor@npm:7.33.7" dependencies: - "@microsoft/api-extractor-model": 7.25.1 - "@microsoft/tsdoc": 0.14.1 + "@microsoft/api-extractor-model": 7.25.3 + "@microsoft/tsdoc": 0.14.2 "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.53.2 + "@rushstack/node-core-library": 3.53.3 "@rushstack/rig-package": 0.3.17 - "@rushstack/ts-command-line": 4.12.5 + "@rushstack/ts-command-line": 4.13.1 colors: ~1.2.1 lodash: ~4.17.15 resolve: ~1.17.0 @@ -413,7 +400,7 @@ __metadata: typescript: ~4.8.4 bin: api-extractor: bin/api-extractor - checksum: c08135537b864339c8f562fdf51a2375f5892f3a229153b14908395212d80718ee62e187ddee792f3973a338f4e6dc10914503a33e486af4bd8a1dca503850c3 + checksum: 3f9034ca8e7bc7a6622cb8ac1f53f7f265ebca529e17f4abb2bef0ca297011cfa0927c0703a819607d974ca79b8f5307371491cfb192788e723cfd316250f9a6 languageName: node linkType: hard @@ -429,13 +416,6 @@ __metadata: languageName: node linkType: hard -"@microsoft/tsdoc@npm:0.14.1": - version: 0.14.1 - resolution: "@microsoft/tsdoc@npm:0.14.1" - checksum: e4ad038ccff2cd96e0d53ee42e2136f0f5a925b16cfda14261f1c2eb55ba0088a0e3b08ff819b476ddc69b2242a391925fab7f6ae2afabb19b96f87e19c114fc - languageName: node - linkType: hard - "@microsoft/tsdoc@npm:0.14.2": version: 0.14.2 resolution: "@microsoft/tsdoc@npm:0.14.2" @@ -471,22 +451,22 @@ __metadata: linkType: hard "@npmcli/fs@npm:^2.1.0": - version: 2.1.0 - resolution: "@npmcli/fs@npm:2.1.0" + version: 2.1.2 + resolution: "@npmcli/fs@npm:2.1.2" dependencies: "@gar/promisify": ^1.1.3 semver: ^7.3.5 - checksum: 6ec6d678af6da49f9dac50cd882d7f661934dd278972ffbaacde40d9eaa2871292d634000a0cca9510f6fc29855fbd4af433e1adbff90a524ec3eaf140f1219b + checksum: 405074965e72d4c9d728931b64d2d38e6ea12066d4fad651ac253d175e413c06fe4350970c783db0d749181da8fe49c42d3880bd1cbc12cd68e3a7964d820225 languageName: node linkType: hard "@npmcli/move-file@npm:^2.0.0": - version: 2.0.0 - resolution: "@npmcli/move-file@npm:2.0.0" + version: 2.0.1 + resolution: "@npmcli/move-file@npm:2.0.1" dependencies: mkdirp: ^1.0.4 rimraf: ^3.0.2 - checksum: 1388777b507b0c592d53f41b9d182e1a8de7763bc625fc07999b8edbc22325f074e5b3ec90af79c89d6987fdb2325bc66d59f483258543c14a43661621f841b0 + checksum: 52dc02259d98da517fae4cb3a0a3850227bdae4939dda1980b788a7670636ca2b4a01b58df03dd5f65c1e3cb70c50fa8ce5762b582b3f499ec30ee5ce1fd9380 languageName: node linkType: hard @@ -494,21 +474,23 @@ __metadata: version: 0.0.0-use.local resolution: "@onehop/js@workspace:." dependencies: - "@changesets/cli": 2.25.0 - "@microsoft/api-documenter": ^7.19.20 - "@microsoft/api-extractor": ^7.33.2 + "@changesets/cli": 2.26.0 + "@microsoft/api-documenter": ^7.19.27 + "@microsoft/api-extractor": ^7.33.7 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.0.0 - "@types/node": ^18.11.0 + "@types/node": 18.11.18 cross-fetch: ^3.1.5 dotenv: 16.0.3 - es-urlcat: ^1.0.0 glob: 8.0.3 - prettier: 2.7.1 - tsup: 6.2.3 - tsx: 3.10.1 - typescript: ^4.8.4 - zod: ^3.19.1 + prettier: 2.8.2 + tsup: 6.5.0 + tsx: 3.12.2 + typedoc: 0.23.24 + typedoc-plugin-markdown: 3.14.0 + typedoc-plugin-missing-exports: 1.0.0 + typescript: next + zod: ^3.20.2 languageName: unknown linkType: soft @@ -519,9 +501,9 @@ __metadata: languageName: node linkType: hard -"@rushstack/node-core-library@npm:3.53.2": - version: 3.53.2 - resolution: "@rushstack/node-core-library@npm:3.53.2" +"@rushstack/node-core-library@npm:3.53.3": + version: 3.53.3 + resolution: "@rushstack/node-core-library@npm:3.53.3" dependencies: "@types/node": 12.20.24 colors: ~1.2.1 @@ -531,7 +513,7 @@ __metadata: resolve: ~1.17.0 semver: ~7.3.0 z-schema: ~5.0.2 - checksum: eca9ef5dd099649c7e54ac7c6f1019c831e9405ce66210f76d6a597d83341bcd8de197d69539042029ea8aa9862e0515b8102e16a4980c66812f599f7c63479d + checksum: 265d18e176079b8e90cd507e5d4d45f3afb1f811efdf491ea26f25f0397b77c0e9d42065166bf79a04503426c844ea92034cd3f8d5961b2a116de82e45cf6d6a languageName: node linkType: hard @@ -545,15 +527,15 @@ __metadata: languageName: node linkType: hard -"@rushstack/ts-command-line@npm:4.12.5": - version: 4.12.5 - resolution: "@rushstack/ts-command-line@npm:4.12.5" +"@rushstack/ts-command-line@npm:4.13.1": + version: 4.13.1 + resolution: "@rushstack/ts-command-line@npm:4.13.1" dependencies: "@types/argparse": 1.0.38 argparse: ~1.0.9 colors: ~1.2.1 string-argv: ~0.3.1 - checksum: 4da741e10382b119d46e3fcdbc2daf0747c63f98c97d44c354b45da1f7e31e7ccf45753668fe636f515663930340e4ac2c0535f2178130e04ce1714d4b8dd688 + checksum: fea24b2549ecb7d3409b6b485d7c58bf8af8f8d1dd19c43a6b3532c45579ffc546bc4533b5db29c91ae1716581fdee4cb725f6a81ecb300e902ef06600e59f1d languageName: node linkType: hard @@ -591,9 +573,9 @@ __metadata: linkType: hard "@types/minimatch@npm:*": - version: 3.0.5 - resolution: "@types/minimatch@npm:3.0.5" - checksum: c41d136f67231c3131cf1d4ca0b06687f4a322918a3a5adddc87ce90ed9dbd175a3610adee36b106ae68c0b92c637c35e02b58c8a56c424f71d30993ea220b92 + version: 5.1.2 + resolution: "@types/minimatch@npm:5.1.2" + checksum: 0391a282860c7cb6fe262c12b99564732401bdaa5e395bee9ca323c312c1a0f45efbf34dce974682036e857db59a5c9b1da522f3d6055aeead7097264c8705a8 languageName: node linkType: hard @@ -604,10 +586,10 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:*": - version: 17.0.35 - resolution: "@types/node@npm:17.0.35" - checksum: 7a24946ae7fd20267ed92466384f594e448bfb151081158d565cc635d406ecb29ea8fb85fcd2a1f71efccf26fb5bd3c6f509bde56077eb8b832b847a6664bc62 +"@types/node@npm:*, @types/node@npm:18.11.18": + version: 18.11.18 + resolution: "@types/node@npm:18.11.18" + checksum: 03f17f9480f8d775c8a72da5ea7e9383db5f6d85aa5fefde90dd953a1449bd5e4ffde376f139da4f3744b4c83942166d2a7603969a6f8ea826edfb16e6e3b49d languageName: node linkType: hard @@ -618,13 +600,6 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:18.11.18": - version: 18.11.18 - resolution: "@types/node@npm:18.11.18" - checksum: 03f17f9480f8d775c8a72da5ea7e9383db5f6d85aa5fefde90dd953a1449bd5e4ffde376f139da4f3744b4c83942166d2a7603969a6f8ea826edfb16e6e3b49d - languageName: node - linkType: hard - "@types/node@npm:^12.7.1": version: 12.20.55 resolution: "@types/node@npm:12.20.55" @@ -632,13 +607,6 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:^18.11.0": - version: 18.11.0 - resolution: "@types/node@npm:18.11.0" - checksum: f27f899ab428e5732f04fadadc9203f44bdf3abf56474540ee27da90e4f2ba133faf87263cada4d2271955f92ee6a142bd50683c86290fe5070c19aac44fd654 - languageName: node - linkType: hard - "@types/normalize-package-data@npm:^2.4.0": version: 2.4.1 resolution: "@types/normalize-package-data@npm:2.4.1" @@ -653,7 +621,7 @@ __metadata: languageName: node linkType: hard -"abbrev@npm:1": +"abbrev@npm:^1.0.0": version: 1.1.1 resolution: "abbrev@npm:1.1.1" checksum: a4a97ec07d7ea112c517036882b2ac22f3109b7b19077dc656316d07d308438aac28e4d9746dc4d84bf6b1e75b4a7b0a5f3cb30592419f128ca9a8cee3bcfa17 @@ -742,12 +710,12 @@ __metadata: linkType: hard "anymatch@npm:~3.1.2": - version: 3.1.2 - resolution: "anymatch@npm:3.1.2" + version: 3.1.3 + resolution: "anymatch@npm:3.1.3" dependencies: normalize-path: ^3.0.0 picomatch: ^2.0.4 - checksum: 985163db2292fac9e5a1e072bf99f1b5baccf196e4de25a0b0b81865ebddeb3b3eb4480734ef0a2ac8c002845396b91aa89121f5b84f93981a4658164a9ec6e9 + checksum: 3e044fd6d1d26545f235a9fe4d7a534e2029d8e59fa7fd9f2a6eb21230f6b5380ea1eaf55136e60cbf8e613544b3b766e7a6fa2102e2a3a117505466e3025dc2 languageName: node linkType: hard @@ -759,12 +727,12 @@ __metadata: linkType: hard "are-we-there-yet@npm:^3.0.0": - version: 3.0.0 - resolution: "are-we-there-yet@npm:3.0.0" + version: 3.0.1 + resolution: "are-we-there-yet@npm:3.0.1" dependencies: delegates: ^1.0.0 readable-stream: ^3.6.0 - checksum: 348edfdd931b0b50868b55402c01c3f64df1d4c229ab6f063539a5025fd6c5f5bb8a0cab409bbed8d75d34762d22aa91b7c20b4204eb8177063158d9ba792981 + checksum: 52590c24860fa7173bedeb69a4c05fb573473e860197f618b9a28432ee4379049336727ae3a1f9c4cb083114601c1140cee578376164d0e651217a9843f9fe83 languageName: node linkType: hard @@ -785,14 +753,14 @@ __metadata: linkType: hard "array.prototype.flat@npm:^1.2.3": - version: 1.3.0 - resolution: "array.prototype.flat@npm:1.3.0" + version: 1.3.1 + resolution: "array.prototype.flat@npm:1.3.1" dependencies: call-bind: ^1.0.2 - define-properties: ^1.1.3 - es-abstract: ^1.19.2 + define-properties: ^1.1.4 + es-abstract: ^1.20.4 es-shim-unscopables: ^1.0.0 - checksum: 2a652b3e8dc0bebb6117e42a5ab5738af0203a14c27341d7bb2431467bdb4b348e2c5dc555dfcda8af0a5e4075c400b85311ded73861c87290a71a17c3e0a257 + checksum: 5a8415949df79bf6e01afd7e8839bbde5a3581300e8ad5d8449dea52639e9e59b26a467665622783697917b43bf39940a6e621877c7dd9b3d1c1f97484b9b88b languageName: node linkType: hard @@ -803,6 +771,13 @@ __metadata: languageName: node linkType: hard +"available-typed-arrays@npm:^1.0.5": + version: 1.0.5 + resolution: "available-typed-arrays@npm:1.0.5" + checksum: 20eb47b3cefd7db027b9bbb993c658abd36d4edd3fe1060e83699a03ee275b0c9b216cc076ff3f2db29073225fb70e7613987af14269ac1fe2a19803ccc97f1a + languageName: node + linkType: hard + "balanced-match@npm:^1.0.0": version: 1.0.2 resolution: "balanced-match@npm:1.0.2" @@ -882,15 +857,15 @@ __metadata: linkType: hard "cac@npm:^6.7.12": - version: 6.7.12 - resolution: "cac@npm:6.7.12" - checksum: c0d4129eb30fc43449e9078ac37bb3b837aab6261236a6642a6fb9d839bb6a41e191e1f2776f87569535db07dcbf4937680419126215b4c17c9dba4351d1bd5e + version: 6.7.14 + resolution: "cac@npm:6.7.14" + checksum: 45a2496a9443abbe7f52a49b22fbe51b1905eff46e03fd5e6c98e3f85077be3f8949685a1849b1a9cd2bc3e5567dfebcf64f01ce01847baf918f1b37c839791a languageName: node linkType: hard -"cacache@npm:^16.0.2": - version: 16.0.7 - resolution: "cacache@npm:16.0.7" +"cacache@npm:^16.1.0": + version: 16.1.3 + resolution: "cacache@npm:16.1.3" dependencies: "@npmcli/fs": ^2.1.0 "@npmcli/move-file": ^2.0.0 @@ -909,8 +884,8 @@ __metadata: rimraf: ^3.0.2 ssri: ^9.0.0 tar: ^6.1.11 - unique-filename: ^1.1.1 - checksum: 2155b099b7e0f0369fb1155ca4673532ca7efe2ebdbec63acca8743580b8446b5d4fd7184626b1cb059001af77b981cdc67035c7855544d365d4f048eafca2ca + unique-filename: ^2.0.0 + checksum: d91409e6e57d7d9a3a25e5dcc589c84e75b178ae8ea7de05cbf6b783f77a5fae938f6e8fda6f5257ed70000be27a681e1e44829251bfffe4c10216002f8f14e6 languageName: node linkType: hard @@ -997,9 +972,9 @@ __metadata: linkType: hard "ci-info@npm:^3.1.0, ci-info@npm:^3.2.0": - version: 3.4.0 - resolution: "ci-info@npm:3.4.0" - checksum: 7f660730170a6ce248e173b670587a0c583e31526d21afcd21f77c811c1aaeb8926999081542d1f30e12cce1df582d4c88709fa45f44c00498b46bdf21d4d21a + version: 3.7.1 + resolution: "ci-info@npm:3.7.1" + checksum: 72d93d5101ea1c186511277fbd8d06ae8a6e028cc2fb94361e92bf735b39c5ebd192e8d15a66ff8c4e3ed569f87c2f844e96f90e141b2de5c649f77ec34ff601 languageName: node linkType: hard @@ -1021,14 +996,14 @@ __metadata: languageName: node linkType: hard -"cliui@npm:^7.0.2": - version: 7.0.4 - resolution: "cliui@npm:7.0.4" +"cliui@npm:^8.0.1": + version: 8.0.1 + resolution: "cliui@npm:8.0.1" dependencies: string-width: ^4.2.0 - strip-ansi: ^6.0.0 + strip-ansi: ^6.0.1 wrap-ansi: ^7.0.0 - checksum: ce2e8f578a4813806788ac399b9e866297740eecd4ad1823c27fd344d78b22c5f8597d548adbcc46f0573e43e21e751f39446c5a5e804a12aace402b7a315d7f + checksum: 79648b3b0045f2e285b76fb2e24e207c6db44323581e421c3acbd0e86454cba1b37aea976ab50195a49e7384b871e6dfb2247ad7dec53c02454ac6497394cb56 languageName: node linkType: hard @@ -1087,13 +1062,6 @@ __metadata: languageName: node linkType: hard -"commander@npm:^2.20.3": - version: 2.20.3 - resolution: "commander@npm:2.20.3" - checksum: ab8c07884e42c3a8dbc5dd9592c606176c7eb5c1ca5ff274bcf907039b2c41de3626f684ea75ccf4d361ba004bbaff1f577d5384c155f3871e456bdf27becf9e - languageName: node - linkType: hard - "commander@npm:^4.0.0": version: 4.1.1 resolution: "commander@npm:4.1.1" @@ -1101,6 +1069,13 @@ __metadata: languageName: node linkType: hard +"commander@npm:^9.4.1": + version: 9.5.0 + resolution: "commander@npm:9.5.0" + checksum: c7a3e27aa59e913b54a1bafd366b88650bc41d6651f0cbe258d4ff09d43d6a7394232a4dadd0bf518b3e696fdf595db1028a0d82c785b88bd61f8a440cecfade + languageName: node + linkType: hard + "concat-map@npm:0.0.1": version: 0.0.1 resolution: "concat-map@npm:0.0.1" @@ -1192,12 +1167,12 @@ __metadata: linkType: hard "decamelize-keys@npm:^1.1.0": - version: 1.1.0 - resolution: "decamelize-keys@npm:1.1.0" + version: 1.1.1 + resolution: "decamelize-keys@npm:1.1.1" dependencies: decamelize: ^1.1.0 map-obj: ^1.0.0 - checksum: 8bc5d32e035a072f5dffc1f1f3d26ca7ab1fb44a9cade34c97ab6cd1e62c81a87e718101e96de07d78cecda20a3fdb955df958e46671ccad01bb8dcf0de2e298 + checksum: fc645fe20b7bda2680bbf9481a3477257a7f9304b1691036092b97ab04c0ab53e3bf9fcc2d2ae382536568e402ec41fb11e1d4c3836a9abe2d813dd9ef4311e0 languageName: node linkType: hard @@ -1209,11 +1184,11 @@ __metadata: linkType: hard "defaults@npm:^1.0.3": - version: 1.0.3 - resolution: "defaults@npm:1.0.3" + version: 1.0.4 + resolution: "defaults@npm:1.0.4" dependencies: clone: ^1.0.2 - checksum: 96e2112da6553d376afd5265ea7cbdb2a3b45535965d71ab8bb1da10c8126d168fdd5268799625324b368356d21ba2a7b3d4ec50961f11a47b7feb9de3d4413e + checksum: 3a88b7a587fc076b84e60affad8b85245c01f60f38fc1d259e7ac1d89eb9ce6abb19e27215de46b98568dd5bc48471730b327637e6f20b0f1bc85cf00440c80a languageName: node linkType: hard @@ -1312,34 +1287,54 @@ __metadata: languageName: node linkType: hard -"es-abstract@npm:^1.19.0, es-abstract@npm:^1.19.2, es-abstract@npm:^1.19.5": - version: 1.20.2 - resolution: "es-abstract@npm:1.20.2" +"es-abstract@npm:^1.19.0, es-abstract@npm:^1.20.4": + version: 1.21.0 + resolution: "es-abstract@npm:1.21.0" dependencies: call-bind: ^1.0.2 + es-set-tostringtag: ^2.0.0 es-to-primitive: ^1.2.1 function-bind: ^1.1.1 function.prototype.name: ^1.1.5 - get-intrinsic: ^1.1.2 + get-intrinsic: ^1.1.3 get-symbol-description: ^1.0.0 + globalthis: ^1.0.3 + gopd: ^1.0.1 has: ^1.0.3 has-property-descriptors: ^1.0.0 + has-proto: ^1.0.1 has-symbols: ^1.0.3 - internal-slot: ^1.0.3 - is-callable: ^1.2.4 + internal-slot: ^1.0.4 + is-array-buffer: ^3.0.0 + is-callable: ^1.2.7 is-negative-zero: ^2.0.2 is-regex: ^1.1.4 is-shared-array-buffer: ^1.0.2 is-string: ^1.0.7 + is-typed-array: ^1.1.10 is-weakref: ^1.0.2 object-inspect: ^1.12.2 object-keys: ^1.1.1 object.assign: ^4.1.4 regexp.prototype.flags: ^1.4.3 - string.prototype.trimend: ^1.0.5 - string.prototype.trimstart: ^1.0.5 + safe-regex-test: ^1.0.0 + string.prototype.trimend: ^1.0.6 + string.prototype.trimstart: ^1.0.6 + typed-array-length: ^1.0.4 unbox-primitive: ^1.0.2 - checksum: ab893dd1f849250f5a2da82656b4e21b511f76429b25a4aea5c8b2a3007ff01cb8e112987d0dd7693b9ad9e6399f8f7be133285d6196a5ebd1b13a4ee2258f70 + which-typed-array: ^1.1.9 + checksum: 52305b52aff6505c9d8cebfa727835dd8871af76de151868d1db7baf6d21f13a81586316ac513601eec9b46e2947cab044fc2a131db68bfa05daf37aa153dbd9 + languageName: node + linkType: hard + +"es-set-tostringtag@npm:^2.0.0": + version: 2.0.1 + resolution: "es-set-tostringtag@npm:2.0.1" + dependencies: + get-intrinsic: ^1.1.3 + has: ^1.0.3 + has-tostringtag: ^1.0.0 + checksum: ec416a12948cefb4b2a5932e62093a7cf36ddc3efd58d6c58ca7ae7064475ace556434b869b0bbeb0c365f1032a8ccd577211101234b69837ad83ad204fff884 languageName: node linkType: hard @@ -1363,395 +1358,172 @@ __metadata: languageName: node linkType: hard -"es-urlcat@npm:^1.0.0": - version: 1.0.0 - resolution: "es-urlcat@npm:1.0.0" - dependencies: - qs: ^6.9.4 - checksum: e646f8510f80e11951602178168d2348fcbc39ed12cc80b0c93d592224a4692c155250e136c05cae4f9a4325ba5f991554d94623b2ebbb431d6064119a2acacf - languageName: node - linkType: hard - -"esbuild-android-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-android-64@npm:0.15.11" +"esbuild-android-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-android-64@npm:0.15.18" conditions: os=android & cpu=x64 languageName: node linkType: hard -"esbuild-android-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-android-64@npm:0.15.3" - conditions: os=android & cpu=x64 - languageName: node - linkType: hard - -"esbuild-android-arm64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-android-arm64@npm:0.15.11" - conditions: os=android & cpu=arm64 - languageName: node - linkType: hard - -"esbuild-android-arm64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-android-arm64@npm:0.15.3" +"esbuild-android-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-android-arm64@npm:0.15.18" conditions: os=android & cpu=arm64 languageName: node linkType: hard -"esbuild-darwin-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-darwin-64@npm:0.15.11" - conditions: os=darwin & cpu=x64 - languageName: node - linkType: hard - -"esbuild-darwin-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-darwin-64@npm:0.15.3" +"esbuild-darwin-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-darwin-64@npm:0.15.18" conditions: os=darwin & cpu=x64 languageName: node linkType: hard -"esbuild-darwin-arm64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-darwin-arm64@npm:0.15.11" +"esbuild-darwin-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-darwin-arm64@npm:0.15.18" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard -"esbuild-darwin-arm64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-darwin-arm64@npm:0.15.3" - conditions: os=darwin & cpu=arm64 - languageName: node - linkType: hard - -"esbuild-freebsd-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-freebsd-64@npm:0.15.11" - conditions: os=freebsd & cpu=x64 - languageName: node - linkType: hard - -"esbuild-freebsd-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-freebsd-64@npm:0.15.3" +"esbuild-freebsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-freebsd-64@npm:0.15.18" conditions: os=freebsd & cpu=x64 languageName: node linkType: hard -"esbuild-freebsd-arm64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-freebsd-arm64@npm:0.15.11" - conditions: os=freebsd & cpu=arm64 - languageName: node - linkType: hard - -"esbuild-freebsd-arm64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-freebsd-arm64@npm:0.15.3" +"esbuild-freebsd-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-freebsd-arm64@npm:0.15.18" conditions: os=freebsd & cpu=arm64 languageName: node linkType: hard -"esbuild-linux-32@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-32@npm:0.15.11" +"esbuild-linux-32@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-32@npm:0.15.18" conditions: os=linux & cpu=ia32 languageName: node linkType: hard -"esbuild-linux-32@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-32@npm:0.15.3" - conditions: os=linux & cpu=ia32 - languageName: node - linkType: hard - -"esbuild-linux-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-64@npm:0.15.11" - conditions: os=linux & cpu=x64 - languageName: node - linkType: hard - -"esbuild-linux-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-64@npm:0.15.3" +"esbuild-linux-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-64@npm:0.15.18" conditions: os=linux & cpu=x64 languageName: node linkType: hard -"esbuild-linux-arm64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-arm64@npm:0.15.11" +"esbuild-linux-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-arm64@npm:0.15.18" conditions: os=linux & cpu=arm64 languageName: node linkType: hard -"esbuild-linux-arm64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-arm64@npm:0.15.3" - conditions: os=linux & cpu=arm64 - languageName: node - linkType: hard - -"esbuild-linux-arm@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-arm@npm:0.15.11" - conditions: os=linux & cpu=arm - languageName: node - linkType: hard - -"esbuild-linux-arm@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-arm@npm:0.15.3" +"esbuild-linux-arm@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-arm@npm:0.15.18" conditions: os=linux & cpu=arm languageName: node linkType: hard -"esbuild-linux-mips64le@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-mips64le@npm:0.15.11" +"esbuild-linux-mips64le@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-mips64le@npm:0.15.18" conditions: os=linux & cpu=mips64el languageName: node linkType: hard -"esbuild-linux-mips64le@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-mips64le@npm:0.15.3" - conditions: os=linux & cpu=mips64el - languageName: node - linkType: hard - -"esbuild-linux-ppc64le@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-ppc64le@npm:0.15.11" +"esbuild-linux-ppc64le@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-ppc64le@npm:0.15.18" conditions: os=linux & cpu=ppc64 languageName: node linkType: hard -"esbuild-linux-ppc64le@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-ppc64le@npm:0.15.3" - conditions: os=linux & cpu=ppc64 - languageName: node - linkType: hard - -"esbuild-linux-riscv64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-riscv64@npm:0.15.11" - conditions: os=linux & cpu=riscv64 - languageName: node - linkType: hard - -"esbuild-linux-riscv64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-riscv64@npm:0.15.3" +"esbuild-linux-riscv64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-riscv64@npm:0.15.18" conditions: os=linux & cpu=riscv64 languageName: node linkType: hard -"esbuild-linux-s390x@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-linux-s390x@npm:0.15.11" - conditions: os=linux & cpu=s390x - languageName: node - linkType: hard - -"esbuild-linux-s390x@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-linux-s390x@npm:0.15.3" +"esbuild-linux-s390x@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-linux-s390x@npm:0.15.18" conditions: os=linux & cpu=s390x languageName: node linkType: hard -"esbuild-netbsd-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-netbsd-64@npm:0.15.11" +"esbuild-netbsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-netbsd-64@npm:0.15.18" conditions: os=netbsd & cpu=x64 languageName: node linkType: hard -"esbuild-netbsd-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-netbsd-64@npm:0.15.3" - conditions: os=netbsd & cpu=x64 - languageName: node - linkType: hard - -"esbuild-openbsd-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-openbsd-64@npm:0.15.11" - conditions: os=openbsd & cpu=x64 - languageName: node - linkType: hard - -"esbuild-openbsd-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-openbsd-64@npm:0.15.3" +"esbuild-openbsd-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-openbsd-64@npm:0.15.18" conditions: os=openbsd & cpu=x64 languageName: node linkType: hard -"esbuild-sunos-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-sunos-64@npm:0.15.11" - conditions: os=sunos & cpu=x64 - languageName: node - linkType: hard - -"esbuild-sunos-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-sunos-64@npm:0.15.3" +"esbuild-sunos-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-sunos-64@npm:0.15.18" conditions: os=sunos & cpu=x64 languageName: node linkType: hard -"esbuild-windows-32@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-windows-32@npm:0.15.11" +"esbuild-windows-32@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-32@npm:0.15.18" conditions: os=win32 & cpu=ia32 languageName: node linkType: hard -"esbuild-windows-32@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-windows-32@npm:0.15.3" - conditions: os=win32 & cpu=ia32 - languageName: node - linkType: hard - -"esbuild-windows-64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-windows-64@npm:0.15.11" - conditions: os=win32 & cpu=x64 - languageName: node - linkType: hard - -"esbuild-windows-64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-windows-64@npm:0.15.3" +"esbuild-windows-64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-64@npm:0.15.18" conditions: os=win32 & cpu=x64 languageName: node linkType: hard -"esbuild-windows-arm64@npm:0.15.11": - version: 0.15.11 - resolution: "esbuild-windows-arm64@npm:0.15.11" +"esbuild-windows-arm64@npm:0.15.18": + version: 0.15.18 + resolution: "esbuild-windows-arm64@npm:0.15.18" conditions: os=win32 & cpu=arm64 languageName: node linkType: hard -"esbuild-windows-arm64@npm:0.15.3": - version: 0.15.3 - resolution: "esbuild-windows-arm64@npm:0.15.3" - conditions: os=win32 & cpu=arm64 - languageName: node - linkType: hard - -"esbuild@npm:^0.15.1": - version: 0.15.3 - resolution: "esbuild@npm:0.15.3" - dependencies: - "@esbuild/linux-loong64": 0.15.3 - esbuild-android-64: 0.15.3 - esbuild-android-arm64: 0.15.3 - esbuild-darwin-64: 0.15.3 - esbuild-darwin-arm64: 0.15.3 - esbuild-freebsd-64: 0.15.3 - esbuild-freebsd-arm64: 0.15.3 - esbuild-linux-32: 0.15.3 - esbuild-linux-64: 0.15.3 - esbuild-linux-arm: 0.15.3 - esbuild-linux-arm64: 0.15.3 - esbuild-linux-mips64le: 0.15.3 - esbuild-linux-ppc64le: 0.15.3 - esbuild-linux-riscv64: 0.15.3 - esbuild-linux-s390x: 0.15.3 - esbuild-netbsd-64: 0.15.3 - esbuild-openbsd-64: 0.15.3 - esbuild-sunos-64: 0.15.3 - esbuild-windows-32: 0.15.3 - esbuild-windows-64: 0.15.3 - esbuild-windows-arm64: 0.15.3 - dependenciesMeta: - "@esbuild/linux-loong64": - optional: true - esbuild-android-64: - optional: true - esbuild-android-arm64: - optional: true - esbuild-darwin-64: - optional: true - esbuild-darwin-arm64: - optional: true - esbuild-freebsd-64: - optional: true - esbuild-freebsd-arm64: - optional: true - esbuild-linux-32: - optional: true - esbuild-linux-64: - optional: true - esbuild-linux-arm: - optional: true - esbuild-linux-arm64: - optional: true - esbuild-linux-mips64le: - optional: true - esbuild-linux-ppc64le: - optional: true - esbuild-linux-riscv64: - optional: true - esbuild-linux-s390x: - optional: true - esbuild-netbsd-64: - optional: true - esbuild-openbsd-64: - optional: true - esbuild-sunos-64: - optional: true - esbuild-windows-32: - optional: true - esbuild-windows-64: - optional: true - esbuild-windows-arm64: - optional: true - bin: - esbuild: bin/esbuild - checksum: d41f9c2d38fd265c3de106b9cf5d720ad20138d57669d74751b5f466c866f2d82cea39c146b100186c82b96725fd09faa88759b706ed6d8cee507d07eda35a66 - languageName: node - linkType: hard - -"esbuild@npm:~0.15.10": - version: 0.15.11 - resolution: "esbuild@npm:0.15.11" - dependencies: - "@esbuild/android-arm": 0.15.11 - "@esbuild/linux-loong64": 0.15.11 - esbuild-android-64: 0.15.11 - esbuild-android-arm64: 0.15.11 - esbuild-darwin-64: 0.15.11 - esbuild-darwin-arm64: 0.15.11 - esbuild-freebsd-64: 0.15.11 - esbuild-freebsd-arm64: 0.15.11 - esbuild-linux-32: 0.15.11 - esbuild-linux-64: 0.15.11 - esbuild-linux-arm: 0.15.11 - esbuild-linux-arm64: 0.15.11 - esbuild-linux-mips64le: 0.15.11 - esbuild-linux-ppc64le: 0.15.11 - esbuild-linux-riscv64: 0.15.11 - esbuild-linux-s390x: 0.15.11 - esbuild-netbsd-64: 0.15.11 - esbuild-openbsd-64: 0.15.11 - esbuild-sunos-64: 0.15.11 - esbuild-windows-32: 0.15.11 - esbuild-windows-64: 0.15.11 - esbuild-windows-arm64: 0.15.11 +"esbuild@npm:^0.15.1, esbuild@npm:~0.15.10": + version: 0.15.18 + resolution: "esbuild@npm:0.15.18" + dependencies: + "@esbuild/android-arm": 0.15.18 + "@esbuild/linux-loong64": 0.15.18 + esbuild-android-64: 0.15.18 + esbuild-android-arm64: 0.15.18 + esbuild-darwin-64: 0.15.18 + esbuild-darwin-arm64: 0.15.18 + esbuild-freebsd-64: 0.15.18 + esbuild-freebsd-arm64: 0.15.18 + esbuild-linux-32: 0.15.18 + esbuild-linux-64: 0.15.18 + esbuild-linux-arm: 0.15.18 + esbuild-linux-arm64: 0.15.18 + esbuild-linux-mips64le: 0.15.18 + esbuild-linux-ppc64le: 0.15.18 + esbuild-linux-riscv64: 0.15.18 + esbuild-linux-s390x: 0.15.18 + esbuild-netbsd-64: 0.15.18 + esbuild-openbsd-64: 0.15.18 + esbuild-sunos-64: 0.15.18 + esbuild-windows-32: 0.15.18 + esbuild-windows-64: 0.15.18 + esbuild-windows-arm64: 0.15.18 dependenciesMeta: "@esbuild/android-arm": optional: true @@ -1799,7 +1571,7 @@ __metadata: optional: true bin: esbuild: bin/esbuild - checksum: afe5f2e6fb4013760fd12f0662569778317d2d0ba0f96c97e4cc01d38551427b7e7110ac6ab1ab6491f5fbfeb7b97fafa2652ab470251667a5d3b4a7ce68a881 + checksum: ec12682b2cb2d4f0669d0e555028b87a9284ca7f6a1b26e35e69a8697165b35cc682ad598abc70f0bbcfdc12ca84ef888caf5ceee389237862e8f8c17da85f89 languageName: node linkType: hard @@ -1870,15 +1642,15 @@ __metadata: linkType: hard "fast-glob@npm:^3.2.9": - version: 3.2.11 - resolution: "fast-glob@npm:3.2.11" + version: 3.2.12 + resolution: "fast-glob@npm:3.2.12" dependencies: "@nodelib/fs.stat": ^2.0.2 "@nodelib/fs.walk": ^1.2.3 glob-parent: ^5.1.2 merge2: ^1.3.0 micromatch: ^4.0.4 - checksum: f473105324a7780a20c06de842e15ddbb41d3cb7e71d1e4fe6e8373204f22245d54f5ab9e2061e6a1c613047345954d29b022e0e76f5c28b1df9858179a0e6d7 + checksum: 0b1990f6ce831c7e28c4d505edcdaad8e27e88ab9fa65eedadb730438cfc7cde4910d6c975d6b7b8dc8a73da4773702ebcfcd6e3518e73938bb1383badfe01c2 languageName: node linkType: hard @@ -1890,11 +1662,11 @@ __metadata: linkType: hard "fastq@npm:^1.6.0": - version: 1.13.0 - resolution: "fastq@npm:1.13.0" + version: 1.15.0 + resolution: "fastq@npm:1.15.0" dependencies: reusify: ^1.0.4 - checksum: 32cf15c29afe622af187d12fc9cd93e160a0cb7c31a3bb6ace86b7dea3b28e7b72acde89c882663f307b2184e14782c6c664fa315973c03626c7d4bff070bb0b + checksum: 0170e6bfcd5d57a70412440b8ef600da6de3b2a6c5966aeaf0a852d542daff506a0ee92d6de7679d1de82e644bce69d7a574a6c93f0b03964b5337eed75ada1a languageName: node linkType: hard @@ -1937,6 +1709,15 @@ __metadata: languageName: node linkType: hard +"for-each@npm:^0.3.3": + version: 0.3.3 + resolution: "for-each@npm:0.3.3" + dependencies: + is-callable: ^1.1.3 + checksum: 6c48ff2bc63362319c65e2edca4a8e1e3483a2fabc72fbe7feaf8c73db94fc7861bd53bc02c8a66a0c1dd709da6b04eec42e0abdd6b40ce47305ae92a25e5d28 + languageName: node + linkType: hard + "fs-extra@npm:^7.0.1, fs-extra@npm:~7.0.1": version: 7.0.1 resolution: "fs-extra@npm:7.0.1" @@ -2043,7 +1824,7 @@ __metadata: languageName: node linkType: hard -"get-intrinsic@npm:^1.0.2, get-intrinsic@npm:^1.1.0, get-intrinsic@npm:^1.1.1, get-intrinsic@npm:^1.1.2": +"get-intrinsic@npm:^1.0.2, get-intrinsic@npm:^1.1.1, get-intrinsic@npm:^1.1.3": version: 1.1.3 resolution: "get-intrinsic@npm:1.1.3" dependencies: @@ -2072,9 +1853,9 @@ __metadata: linkType: hard "get-tsconfig@npm:^4.2.0": - version: 4.2.0 - resolution: "get-tsconfig@npm:4.2.0" - checksum: dfae3520bee20b71a651fdc93fd29901013dfc4df9fb41a423cf3efb4468c79087ef9d3bc3d0625b6486397730991d2a749eed4985d8ab411f481319c3e931e5 + version: 4.3.0 + resolution: "get-tsconfig@npm:4.3.0" + checksum: 2597aab99aa3a24db209e192a3e5874ac47fc5abc71703ee26346e0c5816cb346ca09fc813c739db5862d3a2905d89aeca1b0cbc46c2b272398d672309aaf414 languageName: node linkType: hard @@ -2128,6 +1909,15 @@ __metadata: languageName: node linkType: hard +"globalthis@npm:^1.0.3": + version: 1.0.3 + resolution: "globalthis@npm:1.0.3" + dependencies: + define-properties: ^1.1.3 + checksum: fbd7d760dc464c886d0196166d92e5ffb4c84d0730846d6621a39fbbc068aeeb9c8d1421ad330e94b7bca4bb4ea092f5f21f3d36077812af5d098b4dc006c998 + languageName: node + linkType: hard + "globby@npm:^11.0.0, globby@npm:^11.0.3": version: 11.1.0 resolution: "globby@npm:11.1.0" @@ -2142,6 +1932,15 @@ __metadata: languageName: node linkType: hard +"gopd@npm:^1.0.1": + version: 1.0.1 + resolution: "gopd@npm:1.0.1" + dependencies: + get-intrinsic: ^1.1.3 + checksum: a5ccfb8806e0917a94e0b3de2af2ea4979c1da920bc381667c260e00e7cafdbe844e2cb9c5bcfef4e5412e8bf73bab837285bc35c7ba73aaaf0134d4583393a6 + languageName: node + linkType: hard + "graceful-fs@npm:^4.1.2, graceful-fs@npm:^4.1.5, graceful-fs@npm:^4.1.6, graceful-fs@npm:^4.2.0, graceful-fs@npm:^4.2.6": version: 4.2.10 resolution: "graceful-fs@npm:4.2.10" @@ -2156,6 +1955,24 @@ __metadata: languageName: node linkType: hard +"handlebars@npm:^4.7.7": + version: 4.7.7 + resolution: "handlebars@npm:4.7.7" + dependencies: + minimist: ^1.2.5 + neo-async: ^2.6.0 + source-map: ^0.6.1 + uglify-js: ^3.1.4 + wordwrap: ^1.0.0 + dependenciesMeta: + uglify-js: + optional: true + bin: + handlebars: bin/handlebars + checksum: 1e79a43f5e18d15742977cb987923eab3e2a8f44f2d9d340982bcb69e1735ed049226e534d7c1074eaddaf37e4fb4f471a8adb71cddd5bc8cf3f894241df5cee + languageName: node + linkType: hard + "hard-rejection@npm:^2.1.0": version: 2.1.0 resolution: "hard-rejection@npm:2.1.0" @@ -2193,6 +2010,13 @@ __metadata: languageName: node linkType: hard +"has-proto@npm:^1.0.1": + version: 1.0.1 + resolution: "has-proto@npm:1.0.1" + checksum: febc5b5b531de8022806ad7407935e2135f1cc9e64636c3916c6842bd7995994ca3b29871ecd7954bd35f9e2986c17b3b227880484d22259e2f8e6ce63fd383e + languageName: node + linkType: hard + "has-symbols@npm:^1.0.2, has-symbols@npm:^1.0.3": version: 1.0.3 resolution: "has-symbols@npm:1.0.3" @@ -2302,9 +2126,9 @@ __metadata: linkType: hard "ignore@npm:^5.2.0": - version: 5.2.0 - resolution: "ignore@npm:5.2.0" - checksum: 6b1f926792d614f64c6c83da3a1f9c83f6196c2839aa41e1e32dd7b8d174cef2e329d75caabb62cb61ce9dc432f75e67d07d122a037312db7caa73166a1bdb77 + version: 5.2.4 + resolution: "ignore@npm:5.2.4" + checksum: 3d4c309c6006e2621659311783eaea7ebcd41fe4ca1d78c91c473157ad6666a57a2df790fe0d07a12300d9aac2888204d7be8d59f9aaf665b1c7fcdb432517ef languageName: node linkType: hard @@ -2353,21 +2177,32 @@ __metadata: languageName: node linkType: hard -"internal-slot@npm:^1.0.3": - version: 1.0.3 - resolution: "internal-slot@npm:1.0.3" +"internal-slot@npm:^1.0.4": + version: 1.0.4 + resolution: "internal-slot@npm:1.0.4" dependencies: - get-intrinsic: ^1.1.0 + get-intrinsic: ^1.1.3 has: ^1.0.3 side-channel: ^1.0.4 - checksum: 1944f92e981e47aebc98a88ff0db579fd90543d937806104d0b96557b10c1f170c51fb777b97740a8b6ddeec585fca8c39ae99fd08a8e058dfc8ab70937238bf + checksum: 8974588d06bab4f675573a3b52975370facf6486df51bc0567a982c7024fa29495f10b76c0d4dc742dd951d1b72024fdc1e31bb0bedf1678dc7aacacaf5a4f73 languageName: node linkType: hard -"ip@npm:^1.1.5": - version: 1.1.8 - resolution: "ip@npm:1.1.8" - checksum: a2ade53eb339fb0cbe9e69a44caab10d6e3784662285eb5d2677117ee4facc33a64679051c35e0dfdb1a3983a51ce2f5d2cb36446d52e10d01881789b76e28fb +"ip@npm:^2.0.0": + version: 2.0.0 + resolution: "ip@npm:2.0.0" + checksum: cfcfac6b873b701996d71ec82a7dd27ba92450afdb421e356f44044ed688df04567344c36cbacea7d01b1c39a4c732dc012570ebe9bebfb06f27314bca625349 + languageName: node + linkType: hard + +"is-array-buffer@npm:^3.0.0": + version: 3.0.1 + resolution: "is-array-buffer@npm:3.0.1" + dependencies: + call-bind: ^1.0.2 + get-intrinsic: ^1.1.3 + is-typed-array: ^1.1.10 + checksum: f26ab87448e698285daf707e52a533920449f7abf63714140ffab9d5571aa5a71ac2fa2677e8b793ad0d5d3e40078d4d2c8a0ab39c957e3cfc6513bb6c9dfdc9 languageName: node linkType: hard @@ -2406,10 +2241,10 @@ __metadata: languageName: node linkType: hard -"is-callable@npm:^1.1.4, is-callable@npm:^1.2.4": - version: 1.2.5 - resolution: "is-callable@npm:1.2.5" - checksum: 308ec9787dddff8ac6d3cf706ace87c31707df627e322e50882f6d76a4d80f5844bc220fee79142fe97b53c7c421d0bc72c2106358e183f85b71a874d479f8c4 +"is-callable@npm:^1.1.3, is-callable@npm:^1.1.4, is-callable@npm:^1.2.7": + version: 1.2.7 + resolution: "is-callable@npm:1.2.7" + checksum: 61fd57d03b0d984e2ed3720fb1c7a897827ea174bd44402878e059542ea8c4aeedee0ea0985998aa5cc2736b2fa6e271c08587addb5b3959ac52cf665173d1ac languageName: node linkType: hard @@ -2425,11 +2260,11 @@ __metadata: linkType: hard "is-core-module@npm:^2.1.0, is-core-module@npm:^2.9.0": - version: 2.10.0 - resolution: "is-core-module@npm:2.10.0" + version: 2.11.0 + resolution: "is-core-module@npm:2.11.0" dependencies: has: ^1.0.3 - checksum: 0f3f77811f430af3256fa7bbc806f9639534b140f8ee69476f632c3e1eb4e28a38be0b9d1b8ecf596179c841b53576129279df95e7051d694dac4ceb6f967593 + checksum: f96fd490c6b48eb4f6d10ba815c6ef13f410b0ba6f7eb8577af51697de523e5f2cd9de1c441b51d27251bf0e4aebc936545e33a5d26d5d51f28d25698d4a8bab languageName: node linkType: hard @@ -2555,6 +2390,19 @@ __metadata: languageName: node linkType: hard +"is-typed-array@npm:^1.1.10, is-typed-array@npm:^1.1.9": + version: 1.1.10 + resolution: "is-typed-array@npm:1.1.10" + dependencies: + available-typed-arrays: ^1.0.5 + call-bind: ^1.0.2 + for-each: ^0.3.3 + gopd: ^1.0.1 + has-tostringtag: ^1.0.0 + checksum: aac6ecb59d4c56a1cdeb69b1f129154ef462bbffe434cb8a8235ca89b42f258b7ae94073c41b3cb7bce37f6a1733ad4499f07882d5d5093a7ba84dfc4ebb8017 + languageName: node + linkType: hard + "is-weakref@npm:^1.0.2": version: 1.0.2 resolution: "is-weakref@npm:1.0.2" @@ -2671,9 +2519,9 @@ __metadata: linkType: hard "lilconfig@npm:^2.0.5": - version: 2.0.5 - resolution: "lilconfig@npm:2.0.5" - checksum: f7bb9e42656f06930ad04e583026f087508ae408d3526b8b54895e934eb2a966b7aafae569656f2c79a29fe6d779b3ec44ba577e80814734c8655d6f71cdf2d1 + version: 2.0.6 + resolution: "lilconfig@npm:2.0.6" + checksum: 40a3cd72f103b1be5975f2ac1850810b61d4053e20ab09be8d3aeddfe042187e1ba70b4651a7e70f95efa1642e7dc8b2ae395b317b7d7753b241b43cef7c0f7d languageName: node linkType: hard @@ -2776,18 +2624,25 @@ __metadata: linkType: hard "lru-cache@npm:^7.7.1": - version: 7.10.1 - resolution: "lru-cache@npm:7.10.1" - checksum: e8b190d71ed0fcd7b29c71a3e9b01f851c92d1ef8865ff06b5581ca991db1e5e006920ed4da8b56da1910664ed51abfd76c46fb55e82ac252ff6c970ff910d72 + version: 7.14.1 + resolution: "lru-cache@npm:7.14.1" + checksum: d72c6713c6a6d86836a7a6523b3f1ac6764768cca47ec99341c3e76db06aacd4764620e5e2cda719a36848785a52a70e531822dc2b33fb071fa709683746c104 + languageName: node + linkType: hard + +"lunr@npm:^2.3.9": + version: 2.3.9 + resolution: "lunr@npm:2.3.9" + checksum: 176719e24fcce7d3cf1baccce9dd5633cd8bdc1f41ebe6a180112e5ee99d80373fe2454f5d4624d437e5a8319698ca6837b9950566e15d2cae5f2a543a3db4b8 languageName: node linkType: hard "make-fetch-happen@npm:^10.0.3": - version: 10.1.3 - resolution: "make-fetch-happen@npm:10.1.3" + version: 10.2.1 + resolution: "make-fetch-happen@npm:10.2.1" dependencies: agentkeepalive: ^4.2.1 - cacache: ^16.0.2 + cacache: ^16.1.0 http-cache-semantics: ^4.1.0 http-proxy-agent: ^5.0.0 https-proxy-agent: ^5.0.0 @@ -2800,9 +2655,9 @@ __metadata: minipass-pipeline: ^1.2.4 negotiator: ^0.6.3 promise-retry: ^2.0.1 - socks-proxy-agent: ^6.1.1 + socks-proxy-agent: ^7.0.0 ssri: ^9.0.0 - checksum: 14b9bc5fb65a1a1f53b4579c947d1ebdb18db71eb0b35a2eab612e9642a14127917528fe4ffb2c37aaa0d27dfd7507e4044e6e2e47b43985e8fa18722f535b8f + checksum: 2332eb9a8ec96f1ffeeea56ccefabcb4193693597b132cd110734d50f2928842e22b84cfa1508e921b8385cdfd06dda9ad68645fed62b50fff629a580f5fb72c languageName: node linkType: hard @@ -2895,16 +2750,7 @@ __metadata: languageName: node linkType: hard -"minimatch@npm:^5.0.1": - version: 5.1.0 - resolution: "minimatch@npm:5.1.0" - dependencies: - brace-expansion: ^2.0.1 - checksum: 15ce53d31a06361e8b7a629501b5c75491bc2b59712d53e802b1987121d91b433d73fcc5be92974fde66b2b51d8fb28d75a9ae900d249feb792bb1ba2a4f0a90 - languageName: node - linkType: hard - -"minimatch@npm:^5.1.2": +"minimatch@npm:^5.0.1, minimatch@npm:^5.1.2": version: 5.1.2 resolution: "minimatch@npm:5.1.2" dependencies: @@ -2924,6 +2770,13 @@ __metadata: languageName: node linkType: hard +"minimist@npm:^1.2.5": + version: 1.2.7 + resolution: "minimist@npm:1.2.7" + checksum: 7346574a1038ca23c32e02252f603801f09384dd1d78b69a943a4e8c2c28730b80e96193882d3d3b22a063445f460e48316b29b8a25addca2d7e5e8f75478bec + languageName: node + linkType: hard + "minipass-collect@npm:^1.0.2": version: 1.0.2 resolution: "minipass-collect@npm:1.0.2" @@ -2934,8 +2787,8 @@ __metadata: linkType: hard "minipass-fetch@npm:^2.0.3": - version: 2.1.0 - resolution: "minipass-fetch@npm:2.1.0" + version: 2.1.2 + resolution: "minipass-fetch@npm:2.1.2" dependencies: encoding: ^0.1.13 minipass: ^3.1.6 @@ -2944,7 +2797,7 @@ __metadata: dependenciesMeta: encoding: optional: true - checksum: 1334732859a3f7959ed22589bafd9c40384b885aebb5932328071c33f86b3eb181d54c86919675d1825ab5f1c8e4f328878c863873258d113c29d79a4b0c9c9f + checksum: 3f216be79164e915fc91210cea1850e488793c740534985da017a4cbc7a5ff50506956d0f73bb0cb60e4fe91be08b6b61ef35101706d3ef5da2c8709b5f08f91 languageName: node linkType: hard @@ -2976,11 +2829,20 @@ __metadata: linkType: hard "minipass@npm:^3.0.0, minipass@npm:^3.1.1, minipass@npm:^3.1.6": - version: 3.1.6 - resolution: "minipass@npm:3.1.6" + version: 3.3.6 + resolution: "minipass@npm:3.3.6" dependencies: yallist: ^4.0.0 - checksum: 57a04041413a3531a65062452cb5175f93383ef245d6f4a2961d34386eb9aa8ac11ac7f16f791f5e8bbaf1dfb1ef01596870c88e8822215db57aa591a5bb0a77 + checksum: a30d083c8054cee83cdcdc97f97e4641a3f58ae743970457b1489ce38ee1167b3aaf7d815cd39ec7a99b9c40397fd4f686e83750e73e652b21cb516f6d845e48 + languageName: node + linkType: hard + +"minipass@npm:^4.0.0": + version: 4.0.0 + resolution: "minipass@npm:4.0.0" + dependencies: + yallist: ^4.0.0 + checksum: 7a609afbf394abfcf9c48e6c90226f471676c8f2a67f07f6838871afb03215ede431d1433feffe1b855455bcb13ef0eb89162841b9796109d6fed8d89790f381 languageName: node linkType: hard @@ -3042,6 +2904,13 @@ __metadata: languageName: node linkType: hard +"neo-async@npm:^2.6.0": + version: 2.6.2 + resolution: "neo-async@npm:2.6.2" + checksum: deac9f8d00eda7b2e5cd1b2549e26e10a0faa70adaa6fdadca701cc55f49ee9018e427f424bac0c790b7c7e2d3068db97f3093f1093975f2acb8f8818b936ed9 + languageName: node + linkType: hard + "node-fetch@npm:2.6.7": version: 2.6.7 resolution: "node-fetch@npm:2.6.7" @@ -3057,14 +2926,14 @@ __metadata: linkType: hard "node-gyp@npm:latest": - version: 9.0.0 - resolution: "node-gyp@npm:9.0.0" + version: 9.3.1 + resolution: "node-gyp@npm:9.3.1" dependencies: env-paths: ^2.2.0 glob: ^7.1.4 graceful-fs: ^4.2.6 make-fetch-happen: ^10.0.3 - nopt: ^5.0.0 + nopt: ^6.0.0 npmlog: ^6.0.0 rimraf: ^3.0.2 semver: ^7.3.5 @@ -3072,18 +2941,18 @@ __metadata: which: ^2.0.2 bin: node-gyp: bin/node-gyp.js - checksum: 4d8ef8860f7e4f4d86c91db3f519d26ed5cc23b48fe54543e2afd86162b4acbd14f21de42a5db344525efb69a991e021b96a68c70c6e2d5f4a5cb770793da6d3 + checksum: b860e9976fa645ca0789c69e25387401b4396b93c8375489b5151a6c55cf2640a3b6183c212b38625ef7c508994930b72198338e3d09b9d7ade5acc4aaf51ea7 languageName: node linkType: hard -"nopt@npm:^5.0.0": - version: 5.0.0 - resolution: "nopt@npm:5.0.0" +"nopt@npm:^6.0.0": + version: 6.0.0 + resolution: "nopt@npm:6.0.0" dependencies: - abbrev: 1 + abbrev: ^1.0.0 bin: nopt: bin/nopt.js - checksum: d35fdec187269503843924e0114c0c6533fb54bbf1620d0f28b4b60ba01712d6687f62565c55cc20a504eff0fbe5c63e22340c3fad549ad40469ffb611b04f2f + checksum: 82149371f8be0c4b9ec2f863cc6509a7fd0fa729929c009f3a58e4eb0c9e4cae9920e8f1f8eb46e7d032fec8fb01bede7f0f41a67eb3553b7b8e14fa53de1dac languageName: node linkType: hard @@ -3367,7 +3236,7 @@ __metadata: languageName: node linkType: hard -"prettier@npm:2.8.2": +"prettier@npm:2.8.2, prettier@npm:^2.7.1": version: 2.8.2 resolution: "prettier@npm:2.8.2" bin: @@ -3376,15 +3245,6 @@ __metadata: languageName: node linkType: hard -"prettier@npm:^2.7.1": - version: 2.7.1 - resolution: "prettier@npm:2.7.1" - bin: - prettier: bin-prettier.js - checksum: 55a4409182260866ab31284d929b3cb961e5fdb91fe0d2e099dac92eaecec890f36e524b4c19e6ceae839c99c6d7195817579cdffc8e2c80da0cb794463a748b - languageName: node - linkType: hard - "promise-inflight@npm:^1.0.1": version: 1.0.1 resolution: "promise-inflight@npm:1.0.1" @@ -3416,15 +3276,6 @@ __metadata: languageName: node linkType: hard -"qs@npm:^6.9.4": - version: 6.11.0 - resolution: "qs@npm:6.11.0" - dependencies: - side-channel: ^1.0.4 - checksum: 6e1f29dd5385f7488ec74ac7b6c92f4d09a90408882d0c208414a34dd33badc1a621019d4c799a3df15ab9b1d0292f97c1dd71dc7c045e69f81a8064e5af7297 - languageName: node - linkType: hard - "queue-microtask@npm:^1.2.2": version: 1.2.3 resolution: "queue-microtask@npm:1.2.3" @@ -3511,13 +3362,6 @@ __metadata: languageName: node linkType: hard -"regenerator-runtime@npm:^0.13.4": - version: 0.13.9 - resolution: "regenerator-runtime@npm:0.13.9" - checksum: 65ed455fe5afd799e2897baf691ca21c2772e1a969d19bb0c4695757c2d96249eb74ee3553ea34a91062b2a676beedf630b4c1551cc6299afb937be1426ec55e - languageName: node - linkType: hard - "regexp.prototype.flags@npm:^1.4.3": version: 1.4.3 resolution: "regexp.prototype.flags@npm:1.4.3" @@ -3550,7 +3394,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.10.0": +"resolve@npm:^1.10.0, resolve@npm:~1.22.1": version: 1.22.1 resolution: "resolve@npm:1.22.1" dependencies: @@ -3582,7 +3426,7 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@^1.10.0#~builtin": +"resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@~1.22.1#~builtin": version: 1.22.1 resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=07638b" dependencies: @@ -3640,8 +3484,8 @@ __metadata: linkType: hard "rollup@npm:^3.2.5": - version: 3.5.0 - resolution: "rollup@npm:3.5.0" + version: 3.9.1 + resolution: "rollup@npm:3.9.1" dependencies: fsevents: ~2.3.2 dependenciesMeta: @@ -3649,7 +3493,7 @@ __metadata: optional: true bin: rollup: dist/bin/rollup - checksum: 57aa8e17c7a8d5b80b7a26c8acd52779369826049dbc370b929d73a6015fb69161f5aca699e8c54f7ea410d4ce5b5a45b26b07d5c99724becd555eef0ffe35be + checksum: 929cfab6b8bb2e20c28d7a4c3909b53729f4a63d8cc14f3b1a217d5f8e550737ee0903124ba58a1f2e7efd45c596e044a968aa379411731d0e76c910621d7d3f languageName: node linkType: hard @@ -3669,6 +3513,17 @@ __metadata: languageName: node linkType: hard +"safe-regex-test@npm:^1.0.0": + version: 1.0.0 + resolution: "safe-regex-test@npm:1.0.0" + dependencies: + call-bind: ^1.0.2 + get-intrinsic: ^1.1.3 + is-regex: ^1.1.4 + checksum: bc566d8beb8b43c01b94e67de3f070fd2781685e835959bbbaaec91cc53381145ca91f69bd837ce6ec244817afa0a5e974fc4e40a2957f0aca68ac3add1ddd34 + languageName: node + linkType: hard + "safer-buffer@npm:>= 2.1.2 < 3, safer-buffer@npm:>= 2.1.2 < 3.0.0": version: 2.1.2 resolution: "safer-buffer@npm:2.1.2" @@ -3685,18 +3540,7 @@ __metadata: languageName: node linkType: hard -"semver@npm:^7.3.5": - version: 7.3.7 - resolution: "semver@npm:7.3.7" - dependencies: - lru-cache: ^6.0.0 - bin: - semver: bin/semver.js - checksum: 2fa3e877568cd6ce769c75c211beaed1f9fce80b28338cadd9d0b6c40f2e2862bafd62c19a6cff42f3d54292b7c623277bcab8816a2b5521cf15210d43e75232 - languageName: node - linkType: hard - -"semver@npm:~7.3.0": +"semver@npm:^7.3.5, semver@npm:~7.3.0": version: 7.3.8 resolution: "semver@npm:7.3.8" dependencies: @@ -3805,24 +3649,24 @@ __metadata: languageName: node linkType: hard -"socks-proxy-agent@npm:^6.1.1": - version: 6.2.0 - resolution: "socks-proxy-agent@npm:6.2.0" +"socks-proxy-agent@npm:^7.0.0": + version: 7.0.0 + resolution: "socks-proxy-agent@npm:7.0.0" dependencies: agent-base: ^6.0.2 debug: ^4.3.3 socks: ^2.6.2 - checksum: 6723fd64fb50334e2b340fd0a80fd8488ffc5bc43d85b7cf1d25612044f814dd7d6ea417fd47602159941236f7f4bd15669fa5d7e1f852598a31288e1a43967b + checksum: 720554370154cbc979e2e9ce6a6ec6ced205d02757d8f5d93fe95adae454fc187a5cbfc6b022afab850a5ce9b4c7d73e0f98e381879cf45f66317a4895953846 languageName: node linkType: hard "socks@npm:^2.6.2": - version: 2.6.2 - resolution: "socks@npm:2.6.2" + version: 2.7.1 + resolution: "socks@npm:2.7.1" dependencies: - ip: ^1.1.5 + ip: ^2.0.0 smart-buffer: ^4.2.0 - checksum: dd9194293059d737759d5c69273850ad4149f448426249325c4bea0e340d1cf3d266c3b022694b0dcf5d31f759de23657244c481fc1e8322add80b7985c36b5e + checksum: 259d9e3e8e1c9809a7f5c32238c3d4d2a36b39b83851d0f573bfde5f21c4b1288417ce1af06af1452569cd1eb0841169afd4998f0e04ba04656f6b7f0e46d748 languageName: node linkType: hard @@ -3845,7 +3689,7 @@ __metadata: languageName: node linkType: hard -"source-map@npm:^0.6.0, source-map@npm:~0.6.1": +"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1": version: 0.6.1 resolution: "source-map@npm:0.6.1" checksum: 59ce8640cf3f3124f64ac289012c2b8bd377c238e316fb323ea22fbfe83da07d81e000071d7242cad7a23cd91c7de98e4df8830ec3f133cb6133a5f6e9f67bc2 @@ -3904,11 +3748,11 @@ __metadata: linkType: hard "ssri@npm:^9.0.0": - version: 9.0.0 - resolution: "ssri@npm:9.0.0" + version: 9.0.1 + resolution: "ssri@npm:9.0.1" dependencies: minipass: ^3.1.1 - checksum: bf33174232d07cc64e77ab1c51b55d28352273380c503d35642a19627e88a2c5f160039bb0a28608a353485075dda084dbf0390c7070f9f284559eb71d01b84b + checksum: fb58f5e46b6923ae67b87ad5ef1c5ab6d427a17db0bead84570c2df3cd50b4ceb880ebdba2d60726588272890bae842a744e1ecce5bd2a2a582fccd5068309eb languageName: node linkType: hard @@ -3939,25 +3783,25 @@ __metadata: languageName: node linkType: hard -"string.prototype.trimend@npm:^1.0.5": - version: 1.0.5 - resolution: "string.prototype.trimend@npm:1.0.5" +"string.prototype.trimend@npm:^1.0.6": + version: 1.0.6 + resolution: "string.prototype.trimend@npm:1.0.6" dependencies: call-bind: ^1.0.2 define-properties: ^1.1.4 - es-abstract: ^1.19.5 - checksum: d44f543833112f57224e79182debadc9f4f3bf9d48a0414d6f0cbd2a86f2b3e8c0ca1f95c3f8e5b32ae83e91554d79d932fc746b411895f03f93d89ed3dfb6bc + es-abstract: ^1.20.4 + checksum: 0fdc34645a639bd35179b5a08227a353b88dc089adf438f46be8a7c197fc3f22f8514c1c9be4629b3cd29c281582730a8cbbad6466c60f76b5f99cf2addb132e languageName: node linkType: hard -"string.prototype.trimstart@npm:^1.0.5": - version: 1.0.5 - resolution: "string.prototype.trimstart@npm:1.0.5" +"string.prototype.trimstart@npm:^1.0.6": + version: 1.0.6 + resolution: "string.prototype.trimstart@npm:1.0.6" dependencies: call-bind: ^1.0.2 define-properties: ^1.1.4 - es-abstract: ^1.19.5 - checksum: a4857c5399ad709d159a77371eeaa8f9cc284469a0b5e1bfe405de16f1fd4166a8ea6f4180e55032f348d1b679b1599fd4301fbc7a8b72bdb3e795e43f7b1048 + es-abstract: ^1.20.4 + checksum: 89080feef416621e6ef1279588994305477a7a91648d9436490d56010a1f7adc39167cddac7ce0b9884b8cdbef086987c4dcb2960209f2af8bac0d23ceff4f41 languageName: node linkType: hard @@ -4010,8 +3854,8 @@ __metadata: linkType: hard "sucrase@npm:^3.20.3": - version: 3.21.0 - resolution: "sucrase@npm:3.21.0" + version: 3.29.0 + resolution: "sucrase@npm:3.29.0" dependencies: commander: ^4.0.0 glob: 7.1.6 @@ -4022,7 +3866,7 @@ __metadata: bin: sucrase: bin/sucrase sucrase-node: bin/sucrase-node - checksum: d686f255af65bab2cb4e685287a7a4fe00f241a891a2ddea8c6218ff8f412780339d4d544e4a582e93e3994d1ebbe2fbce6a555474e80641958319a2b249e836 + checksum: fc8f04c34f29c0e9ca63109815df138182d62663dbe9565fcd94161b77a88a639f40c46559d0bb84d7acf9346ce23ea102476fd9168ec279330c7faecefb81eb languageName: node linkType: hard @@ -4052,16 +3896,16 @@ __metadata: linkType: hard "tar@npm:^6.1.11, tar@npm:^6.1.2": - version: 6.1.11 - resolution: "tar@npm:6.1.11" + version: 6.1.13 + resolution: "tar@npm:6.1.13" dependencies: chownr: ^2.0.0 fs-minipass: ^2.0.0 - minipass: ^3.0.0 + minipass: ^4.0.0 minizlib: ^2.1.1 mkdirp: ^1.0.3 yallist: ^4.0.0 - checksum: a04c07bb9e2d8f46776517d4618f2406fb977a74d914ad98b264fc3db0fe8224da5bec11e5f8902c5b9bcb8ace22d95fbe3c7b36b8593b7dfc8391a25898f32f + checksum: 8a278bed123aa9f53549b256a36b719e317c8b96fe86a63406f3c62887f78267cea9b22dc6f7007009738509800d4a4dccc444abd71d762287c90f35b002eb1c languageName: node linkType: hard @@ -4238,6 +4082,17 @@ __metadata: languageName: node linkType: hard +"typed-array-length@npm:^1.0.4": + version: 1.0.4 + resolution: "typed-array-length@npm:1.0.4" + dependencies: + call-bind: ^1.0.2 + for-each: ^0.3.3 + is-typed-array: ^1.1.9 + checksum: 2228febc93c7feff142b8c96a58d4a0d7623ecde6c7a24b2b98eb3170e99f7c7eff8c114f9b283085cd59dcd2bd43aadf20e25bba4b034a53c5bb292f71f8956 + languageName: node + linkType: hard + "typedoc-plugin-markdown@npm:3.14.0": version: 3.14.0 resolution: "typedoc-plugin-markdown@npm:3.14.0" @@ -4274,16 +4129,6 @@ __metadata: languageName: node linkType: hard -"typescript@npm:^4.8.4, typescript@npm:~4.8.4": - version: 4.8.4 - resolution: "typescript@npm:4.8.4" - bin: - tsc: bin/tsc - tsserver: bin/tsserver - checksum: 9068d5a62d844c5283f74cd3ef7c574f5250e7993e4703034ff49117d67764ff7ce87110a8127061e3a03e3f1b2dff21d743b2f90f86c12655b3f007d0bca8b2 - languageName: node - linkType: hard - "typescript@npm:next": version: 5.0.0-dev.20230109 resolution: "typescript@npm:5.0.0-dev.20230109" @@ -4294,13 +4139,13 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@^4.8.4#~builtin, typescript@patch:typescript@~4.8.4#~builtin": +"typescript@npm:~4.8.4": version: 4.8.4 - resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=a1c5e5" + resolution: "typescript@npm:4.8.4" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: d4f24bb2f20dc783db94375fa25cd25947f0904e7d36bf2c040c4c99ad75af1b418e3542e399bcabd59a59f482852e4fe839642ea5900d434ef2cefcf0b6f465 + checksum: 3e4f061658e0c8f36c820802fa809e0fd812b85687a9a2f5430bc3d0368e37d1c9605c3ce9b39df9a05af2ece67b1d844f9f6ea8ff42819f13bcb80f85629af0 languageName: node linkType: hard @@ -4314,6 +4159,25 @@ __metadata: languageName: node linkType: hard +"typescript@patch:typescript@~4.8.4#~builtin": + version: 4.8.4 + resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=a1c5e5" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 563a0ef47abae6df27a9a3ab38f75fc681f633ccf1a3502b1108e252e187787893de689220f4544aaf95a371a4eb3141e4a337deb9895de5ac3c1ca76430e5f0 + languageName: node + linkType: hard + +"uglify-js@npm:^3.1.4": + version: 3.17.4 + resolution: "uglify-js@npm:3.17.4" + bin: + uglifyjs: bin/uglifyjs + checksum: 7b3897df38b6fc7d7d9f4dcd658599d81aa2b1fb0d074829dd4e5290f7318dbca1f4af2f45acb833b95b1fe0ed4698662ab61b87e94328eb4c0a0d3435baf924 + languageName: node + linkType: hard + "unbox-primitive@npm:^1.0.2": version: 1.0.2 resolution: "unbox-primitive@npm:1.0.2" @@ -4326,21 +4190,21 @@ __metadata: languageName: node linkType: hard -"unique-filename@npm:^1.1.1": - version: 1.1.1 - resolution: "unique-filename@npm:1.1.1" +"unique-filename@npm:^2.0.0": + version: 2.0.1 + resolution: "unique-filename@npm:2.0.1" dependencies: - unique-slug: ^2.0.0 - checksum: cf4998c9228cc7647ba7814e255dec51be43673903897b1786eff2ac2d670f54d4d733357eb08dea969aa5e6875d0e1bd391d668fbdb5a179744e7c7551a6f80 + unique-slug: ^3.0.0 + checksum: 807acf3381aff319086b64dc7125a9a37c09c44af7620bd4f7f3247fcd5565660ac12d8b80534dcbfd067e6fe88a67e621386dd796a8af828d1337a8420a255f languageName: node linkType: hard -"unique-slug@npm:^2.0.0": - version: 2.0.2 - resolution: "unique-slug@npm:2.0.2" +"unique-slug@npm:^3.0.0": + version: 3.0.0 + resolution: "unique-slug@npm:3.0.0" dependencies: imurmurhash: ^0.1.4 - checksum: 5b6876a645da08d505dedb970d1571f6cebdf87044cb6b740c8dbb24f0d6e1dc8bdbf46825fd09f994d7cf50760e6f6e063cfa197d51c5902c00a861702eb75a + checksum: 49f8d915ba7f0101801b922062ee46b7953256c93ceca74303bd8e6413ae10aa7e8216556b54dc5382895e8221d04f1efaf75f945c2e4a515b4139f77aa6640c languageName: node linkType: hard @@ -4472,6 +4336,20 @@ __metadata: languageName: node linkType: hard +"which-typed-array@npm:^1.1.9": + version: 1.1.9 + resolution: "which-typed-array@npm:1.1.9" + dependencies: + available-typed-arrays: ^1.0.5 + call-bind: ^1.0.2 + for-each: ^0.3.3 + gopd: ^1.0.1 + has-tostringtag: ^1.0.0 + is-typed-array: ^1.1.10 + checksum: fe0178ca44c57699ca2c0e657b64eaa8d2db2372a4e2851184f568f98c478ae3dc3fdb5f7e46c384487046b0cf9e23241423242b277e03e8ba3dabc7c84c98ef + languageName: node + linkType: hard + "which@npm:^1.2.9": version: 1.3.1 resolution: "which@npm:1.3.1" @@ -4503,6 +4381,13 @@ __metadata: languageName: node linkType: hard +"wordwrap@npm:^1.0.0": + version: 1.0.0 + resolution: "wordwrap@npm:1.0.0" + checksum: 2a44b2788165d0a3de71fd517d4880a8e20ea3a82c080ce46e294f0b68b69a2e49cff5f99c600e275c698a90d12c5ea32aff06c311f0db2eb3f1201f3e7b2a04 + languageName: node + linkType: hard + "wrap-ansi@npm:^6.2.0": version: 6.2.0 resolution: "wrap-ansi@npm:6.2.0" @@ -4577,7 +4462,7 @@ __metadata: languageName: node linkType: hard -"yargs-parser@npm:^21.0.0": +"yargs-parser@npm:^21.1.1": version: 21.1.1 resolution: "yargs-parser@npm:21.1.1" checksum: ed2d96a616a9e3e1cc7d204c62ecc61f7aaab633dcbfab2c6df50f7f87b393993fe6640d017759fe112d0cb1e0119f2b4150a87305cc873fd90831c6a58ccf1c @@ -4604,17 +4489,17 @@ __metadata: linkType: hard "yargs@npm:^17.1.1": - version: 17.5.1 - resolution: "yargs@npm:17.5.1" + version: 17.6.2 + resolution: "yargs@npm:17.6.2" dependencies: - cliui: ^7.0.2 + cliui: ^8.0.1 escalade: ^3.1.1 get-caller-file: ^2.0.5 require-directory: ^2.1.1 string-width: ^4.2.3 y18n: ^5.0.5 - yargs-parser: ^21.0.0 - checksum: 00d58a2c052937fa044834313f07910fd0a115dec5ee35919e857eeee3736b21a4eafa8264535800ba8bac312991ce785ecb8a51f4d2cc8c4676d865af1cfbde + yargs-parser: ^21.1.1 + checksum: 47da1b0d854fa16d45a3ded57b716b013b2179022352a5f7467409da5a04a1eef5b3b3d97a2dfc13e8bbe5f2ffc0afe3bc6a4a72f8254e60f5a4bd7947138643 languageName: node linkType: hard @@ -4626,10 +4511,10 @@ __metadata: linkType: hard "z-schema@npm:~5.0.2": - version: 5.0.4 - resolution: "z-schema@npm:5.0.4" + version: 5.0.5 + resolution: "z-schema@npm:5.0.5" dependencies: - commander: ^2.20.3 + commander: ^9.4.1 lodash.get: ^4.4.2 lodash.isequal: ^4.5.0 validator: ^13.7.0 @@ -4638,14 +4523,7 @@ __metadata: optional: true bin: z-schema: bin/z-schema - checksum: afa4e0039a104a53eeb6977bf754ef44e32042aecbf3b5eb18b82649763abd5c2608e47d6d6902291359b41e76130594d7f2b6132316d819c3529f17d4d3464d - languageName: node - linkType: hard - -"zod@npm:^3.19.1": - version: 3.19.1 - resolution: "zod@npm:3.19.1" - checksum: 56e420ea5845912324a8fc61833714a2aec84954e418b52660d76502183c6e62fef9447cbfa64349640c5ce190cf2c24267e006bb80f066183e2f3fa9fe11864 + checksum: 8a1d66817ae4384dc3f63311f0cccaadd95cc9640eaade5fd3fbf91aa80d6bb82fb95d9b9171fa82ac371a0155b32b7f5f77bbe84dabaca611b66f74c628f0b8 languageName: node linkType: hard From 3c5e6987466ec7946f0487c87f4398f3f483d0ad Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Tue, 10 Jan 2023 02:48:11 +0000 Subject: [PATCH 14/33] more api extractor documentation --- src/index.ts | 12 +++++++++++- src/rest/types/channels.ts | 5 +++++ 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/src/index.ts b/src/index.ts index c021b60f..ddf132ef 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,3 +1,5 @@ +import * as sdks from './sdks/index.ts'; + export * from './hop.ts'; export * from './permissions.ts'; export * from './rest/index.ts'; @@ -29,5 +31,13 @@ export { RolloutState, RuntimeType, } from './rest/types/ignite.ts'; -export * as sdks from './sdks/index.ts'; export * from './util/index.ts'; +export { + /** + * SDKs for interacting with Hop's API. You can use these, but it's + * recommended to use the `Hop` class directly, which wraps + * these SDKs and provides a more convenient interface. + * @public + */ + sdks, +}; diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index a32ed7a9..ee317e97 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -2,6 +2,10 @@ import {Empty, Id, Timestamp} from '../../util/types.ts'; import {Endpoint} from '../endpoints.ts'; import {Project} from './projects.ts'; +/** + * Types that a channel can be + * @public + */ export enum ChannelType { PRIVATE = 'private', PUBLIC = 'public', @@ -15,6 +19,7 @@ export enum ChannelType { export type State = Record; /** + * Definition of a channel * @public */ export interface Channel { From 737700ed9c897cb536f1500fe0e05431ddb66226 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Tue, 10 Jan 2023 03:15:25 +0000 Subject: [PATCH 15/33] strict ts opts --- src/rest/client.ts | 21 +++++++++++++++------ src/rest/endpoints.ts | 14 +++++++------- src/rest/types/channels.ts | 6 +++--- src/rest/types/ignite.ts | 6 +++--- src/rest/types/pipe.ts | 18 ++++++++++-------- src/rest/types/projects.ts | 6 +++--- src/rest/types/registry.ts | 4 ++-- src/rest/types/users.ts | 6 +++--- src/sdks/channels.ts | 2 +- src/sdks/pipe.ts | 4 ++-- src/sdks/projects.ts | 2 +- src/sdks/registry.ts | 2 +- src/sdks/users.ts | 2 +- tsconfig.json | 4 +++- 14 files changed, 55 insertions(+), 42 deletions(-) diff --git a/src/rest/client.ts b/src/rest/client.ts index a5b62006..32105d3a 100644 --- a/src/rest/client.ts +++ b/src/rest/client.ts @@ -1,8 +1,8 @@ import {IS_BROWSER} from '../util/constants.ts'; import {fetch, Headers, Request} from '../util/fetch.ts'; -import {ExtractRouteParams} from '../util/index.ts'; +import type {ExtractRouteParams} from '../util/index.ts'; import {createURLBuilder} from '../util/urls.ts'; -import {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.ts'; +import type {APIResponse, Endpoints, ErroredAPIResponse} from './endpoints.ts'; import {getIdPrefix, Id, Method} from './types/index.ts'; /** @@ -11,6 +11,16 @@ import {getIdPrefix, Id, Method} from './types/index.ts'; */ export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; +export type ExtractEndpoint< + Method extends string, + Path extends string, +> = Extract; + +export type PathsFor = Extract< + Endpoints, + {method: M} +>['path']; + /** * All possible authentication ID types * @public @@ -32,7 +42,6 @@ export function validateAPIAuthentication( /** * Options passed to the API client. * This will usually come from Hop#constructor in most cases - * * @public */ export interface APIClientOptions { @@ -81,7 +90,7 @@ export class APIClient { } private readonly options; - private agent: unknown; + private agent: import('node:https').Agent | null; public readonly authType; public readonly url; @@ -97,7 +106,7 @@ export class APIClient { this.agent = null; } - async get['path']>( + async get>( path: Path, query: Query, init?: RequestInit, @@ -243,7 +252,7 @@ export class APIClient { const request = new Request(url, { method, - body: body ? JSON.stringify(body) : undefined, + body: body ? JSON.stringify(body) : null, headers, ...init, }); diff --git a/src/rest/endpoints.ts b/src/rest/endpoints.ts index 646ac699..4023d3b8 100644 --- a/src/rest/endpoints.ts +++ b/src/rest/endpoints.ts @@ -1,10 +1,10 @@ -import {ChannelEndpoints} from './types/channels.ts'; -import {IgniteEndpoints} from './types/ignite.ts'; -import {Method} from './types/index.ts'; -import {PipeEndpoints} from './types/pipe.ts'; -import {ProjectsEndpoints} from './types/projects.ts'; -import {RegistryEndpoints} from './types/registry.ts'; -import {UserEndpoints} from './types/users.ts'; +import type {ChannelEndpoints} from './types/channels.ts'; +import type {IgniteEndpoints} from './types/ignite.ts'; +import type {Method} from './types/index.ts'; +import type {PipeEndpoints} from './types/pipe.ts'; +import type {ProjectsEndpoints} from './types/projects.ts'; +import type {RegistryEndpoints} from './types/registry.ts'; +import type {UserEndpoints} from './types/users.ts'; export type SuccessfulAPIResponse = { success: true; diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index ee317e97..ca60500e 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; -import {Project} from './projects.ts'; +import type {Empty, Id, Timestamp} from '../../util/types.ts'; +import type {Endpoint} from '../endpoints.ts'; +import type {Project} from './projects.ts'; /** * Types that a channel can be diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index db4414fe..c288fa8b 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -1,5 +1,5 @@ -import {ByteSizeString} from '../../util/index.ts'; -import { +import type {ByteSizeString} from '../../util/index.ts'; +import type { Empty, HopShDomain, Id, @@ -7,7 +7,7 @@ import { MakeOptional, Timestamp, } from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; +import type {Endpoint} from '../endpoints.ts'; export enum Regions { US_EAST_1 = 'us-east-1', diff --git a/src/rest/types/pipe.ts b/src/rest/types/pipe.ts index 87be8f82..02a1dc75 100644 --- a/src/rest/types/pipe.ts +++ b/src/rest/types/pipe.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; -import {Regions} from './ignite.ts'; +import type {Empty, Id, Timestamp} from '../../util/types.ts'; +import type {Endpoint} from '../endpoints.ts'; +import type {Regions} from './ignite.ts'; export type DeliveryProtocol = 'webrtc' | 'hls'; @@ -71,11 +71,13 @@ export type PipeEndpoints = ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; + llhls_config?: + | { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } + | undefined; } > | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; diff --git a/src/rest/types/projects.ts b/src/rest/types/projects.ts index c7c92810..38195763 100644 --- a/src/rest/types/projects.ts +++ b/src/rest/types/projects.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; -import {User} from './users.ts'; +import type {Empty, Id, Timestamp} from '../../util/types.ts'; +import type {Endpoint} from '../endpoints.ts'; +import type {User} from './users.ts'; export type Member = Omit & { /** diff --git a/src/rest/types/registry.ts b/src/rest/types/registry.ts index 4809b581..bfbf8c8d 100644 --- a/src/rest/types/registry.ts +++ b/src/rest/types/registry.ts @@ -1,5 +1,5 @@ -import {Empty} from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; +import type {Empty} from '../../util/types.ts'; +import type {Endpoint} from '../endpoints.ts'; export type RegistryEndpoints = | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index 05f0dde5..111c6090 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -1,6 +1,6 @@ -import {Empty, Id, Timestamp} from '../../util/types.ts'; -import {Endpoint} from '../endpoints.ts'; -import {MemberRole, Project} from './projects.ts'; +import type {Empty, Id, Timestamp} from '../../util/types.ts'; +import type {Endpoint} from '../endpoints.ts'; +import type {MemberRole, Project} from './projects.ts'; /** * A user objct diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index 990d653e..f735423b 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -1,5 +1,5 @@ import {create} from '@onehop/json-methods'; -import {API, Id} from '../rest/index.ts'; +import type {API, Id} from '../rest/index.ts'; import {sdk} from './create.ts'; /** diff --git a/src/sdks/pipe.ts b/src/sdks/pipe.ts index a7c4fab2..d02fc88c 100644 --- a/src/sdks/pipe.ts +++ b/src/sdks/pipe.ts @@ -1,7 +1,7 @@ import {create} from '@onehop/json-methods'; -import {API, Id} from '../rest/index.ts'; +import type {API, Id} from '../rest/index.ts'; import {Regions} from '../rest/types/ignite.ts'; -import {DeliveryProtocol} from '../rest/types/pipe.ts'; +import type {DeliveryProtocol} from '../rest/types/pipe.ts'; import {sdk} from './create.ts'; /** diff --git a/src/sdks/projects.ts b/src/sdks/projects.ts index 9eeca705..9996ba9c 100644 --- a/src/sdks/projects.ts +++ b/src/sdks/projects.ts @@ -1,4 +1,4 @@ -import {API, Endpoints, Id} from '../rest/index.ts'; +import type {API, Endpoints, Id} from '../rest/index.ts'; import {Request} from '../util/fetch.ts'; import {sdk} from './create.ts'; diff --git a/src/sdks/registry.ts b/src/sdks/registry.ts index 91c9a509..659464a1 100644 --- a/src/sdks/registry.ts +++ b/src/sdks/registry.ts @@ -1,4 +1,4 @@ -import {Id} from '../rest/index.ts'; +import type {Id} from '../rest/index.ts'; import {sdk} from './create.ts'; /** diff --git a/src/sdks/users.ts b/src/sdks/users.ts index 8bde0a3f..6ae13973 100644 --- a/src/sdks/users.ts +++ b/src/sdks/users.ts @@ -1,4 +1,4 @@ -import {Id} from '../util/types.ts'; +import type {Id} from '../util/types.ts'; import {sdk} from './create.ts'; /** diff --git a/tsconfig.json b/tsconfig.json index f159c441..483e2a59 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -21,7 +21,9 @@ "noUncheckedIndexedAccess": true, "allowImportingTsExtensions": true, "declaration": true, - "declarationMap": true + "declarationMap": true, + "exactOptionalPropertyTypes": true, + "importsNotUsedAsValues": "error" }, "exclude": ["node_modules", "dist"], "include": ["./**/*.ts", "./**/*.tsx"] From 14fa8880a3443c71dece45cacc6bbe0ea8f883e2 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Tue, 10 Jan 2023 16:26:23 +0000 Subject: [PATCH 16/33] fix: patch deployment shld be partial --- src/rest/types/ignite.ts | 2 +- src/sdks/ignite.ts | 5 ++++- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index c288fa8b..7f832ba2 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -837,7 +837,7 @@ export type IgniteEndpoints = 'PATCH', '/v1/ignite/deployments/:deployment_id', {deployment: Deployment}, - DeploymentConfig + Partial > | Endpoint< 'POST', diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index d19689c3..8a17a7ff 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -337,7 +337,10 @@ export const ignite = sdk(client => { }); }, - async update(deploymentId: Id<'deployment'>, config: DeploymentConfig) { + async update( + deploymentId: Id<'deployment'>, + config: Partial, + ) { const {deployment} = await client.patch( '/v1/ignite/deployments/:deployment_id', config, From b1b26238a04d89cf00e301d157f355ab7400db7a Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Thu, 26 Jan 2023 10:43:53 +0000 Subject: [PATCH 17/33] feat: overload hop.ignite.containers.delete --- src/sdks/ignite.ts | 77 +++++++++++++++++++++++++++++++--------------- 1 file changed, 52 insertions(+), 25 deletions(-) diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 276d078d..0a808ca1 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -7,7 +7,7 @@ import { GatewayType, RuntimeType, } from '../rest/types/ignite.ts'; -import {parseSize, validateId} from '../util/index.ts'; +import {Empty, parseSize, validateId} from '../util/index.ts'; import {sdk} from './create.ts'; const SIX_MB_IN_BYTES = 6 * 1024 * 1024; @@ -196,6 +196,56 @@ export const ignite = sdk(client => { return Deployments.from(deployment); } + /** + * Deletes a container and recreates it after deletion + * + * @param container_id The ID of the container to delete + * @param options - Options object + */ + async function deleteContainer( + container_id: Id<'container'>, + options: {recreate: true}, + ): Promise; + + /** + * Deletes a container. This will not recreate the container. + * + * @param container - The ID of the container to delete + * @param options - Options object + */ + async function deleteContainer( + container_id: Id<'container'>, + options?: {recreate?: false}, + ): Promise; + + /** + * Deletes a container, and optionally recreates it after deletion + * + * @param container - The ID of the container to delete + * @param options - Options object + */ + async function deleteContainer( + container_id: Id<'container'>, + options: { + recreate?: boolean; + } = {}, + ) { + const d = await client.delete( + '/v1/ignite/containers/:container_id', + undefined, + { + container_id, + recreate: options.recreate ? 'true' : undefined, + }, + ); + + if (!d) { + return; + } + + return d.container; + } + const deploymentGateways = { /** * Fecthes all gateways attached to a deployment @@ -412,30 +462,7 @@ export const ignite = sdk(client => { }, containers: { - /** - * Deletes a container - * - * @param container - The ID of the container to delete. - */ - async delete( - container_id: Id<'container'>, - options: Partial<{ - recreate: boolean; - }> = {}, - ) { - const d = await client.delete( - '/v1/ignite/containers/:container_id', - undefined, - { - container_id, - recreate: options.recreate ? 'true' : undefined, - }, - ); - - if (!d) return; - - return d; - }, + delete: deleteContainer, /** * Get the logs for a container From 576a8f1b6aaf0555336043cb03aeff84349378ae Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Thu, 26 Jan 2023 21:59:55 +0000 Subject: [PATCH 18/33] organize imports --- src/sdks/ignite.ts | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 0a808ca1..897bb989 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -7,7 +7,7 @@ import { GatewayType, RuntimeType, } from '../rest/types/ignite.ts'; -import {Empty, parseSize, validateId} from '../util/index.ts'; +import {parseSize, validateId} from '../util/index.ts'; import {sdk} from './create.ts'; const SIX_MB_IN_BYTES = 6 * 1024 * 1024; @@ -233,10 +233,7 @@ export const ignite = sdk(client => { const d = await client.delete( '/v1/ignite/containers/:container_id', undefined, - { - container_id, - recreate: options.recreate ? 'true' : undefined, - }, + {container_id, recreate: options.recreate ? 'true' : undefined}, ); if (!d) { From efbab2506d59dc3c44f8e9647c992669541f6a23 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sat, 11 Mar 2023 19:06:16 +0000 Subject: [PATCH 19/33] updates --- .gitignore | 2 +- .temp/js.api.json | 17784 +++++++++++++++++++++++++++++++++++ .temp/js.api.md | 1953 ++++ api-extractor.json | 4 +- package.json | 3 +- src/rest/endpoints.ts | 20 + src/rest/types/api.ts | 50 +- src/rest/types/channels.ts | 4 + src/rest/types/ignite.ts | 58 + src/rest/types/index.ts | 4 +- src/rest/types/users.ts | 10 + temp/js.api.md | 395 +- yarn.lock | 287 +- 13 files changed, 20426 insertions(+), 148 deletions(-) create mode 100644 .temp/js.api.json create mode 100644 .temp/js.api.md diff --git a/.gitignore b/.gitignore index bbb70d52..1b696c47 100644 --- a/.gitignore +++ b/.gitignore @@ -7,7 +7,7 @@ node_modules dist _workbench.ts .env -.temp +temp .next docs diff --git a/.temp/js.api.json b/.temp/js.api.json new file mode 100644 index 00000000..9c541b36 --- /dev/null +++ b/.temp/js.api.json @@ -0,0 +1,17784 @@ +{ + "metadata": { + "toolPackage": "@microsoft/api-extractor", + "toolVersion": "7.34.4", + "schemaVersion": 1011, + "oldestForwardsCompatibleVersion": 1001, + "tsdocConfig": { + "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", + "noStandardTags": true, + "tagDefinitions": [ + { + "tagName": "@alpha", + "syntaxKind": "modifier" + }, + { + "tagName": "@beta", + "syntaxKind": "modifier" + }, + { + "tagName": "@defaultValue", + "syntaxKind": "block" + }, + { + "tagName": "@decorator", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@deprecated", + "syntaxKind": "block" + }, + { + "tagName": "@eventProperty", + "syntaxKind": "modifier" + }, + { + "tagName": "@example", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@experimental", + "syntaxKind": "modifier" + }, + { + "tagName": "@inheritDoc", + "syntaxKind": "inline" + }, + { + "tagName": "@internal", + "syntaxKind": "modifier" + }, + { + "tagName": "@label", + "syntaxKind": "inline" + }, + { + "tagName": "@link", + "syntaxKind": "inline", + "allowMultiple": true + }, + { + "tagName": "@override", + "syntaxKind": "modifier" + }, + { + "tagName": "@packageDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@param", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@privateRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@public", + "syntaxKind": "modifier" + }, + { + "tagName": "@readonly", + "syntaxKind": "modifier" + }, + { + "tagName": "@remarks", + "syntaxKind": "block" + }, + { + "tagName": "@returns", + "syntaxKind": "block" + }, + { + "tagName": "@sealed", + "syntaxKind": "modifier" + }, + { + "tagName": "@see", + "syntaxKind": "block" + }, + { + "tagName": "@throws", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@typeParam", + "syntaxKind": "block", + "allowMultiple": true + }, + { + "tagName": "@virtual", + "syntaxKind": "modifier" + }, + { + "tagName": "@betaDocumentation", + "syntaxKind": "modifier" + }, + { + "tagName": "@internalRemarks", + "syntaxKind": "block" + }, + { + "tagName": "@preapproved", + "syntaxKind": "modifier" + } + ], + "supportForTags": { + "@alpha": true, + "@beta": true, + "@defaultValue": true, + "@decorator": true, + "@deprecated": true, + "@eventProperty": true, + "@example": true, + "@experimental": true, + "@inheritDoc": true, + "@internal": true, + "@label": true, + "@link": true, + "@override": true, + "@packageDocumentation": true, + "@param": true, + "@privateRemarks": true, + "@public": true, + "@readonly": true, + "@remarks": true, + "@returns": true, + "@sealed": true, + "@see": true, + "@throws": true, + "@typeParam": true, + "@virtual": true, + "@betaDocumentation": true, + "@internalRemarks": true, + "@preapproved": true + }, + "reportUnsupportedHtmlElements": false + } + }, + "kind": "Package", + "canonicalReference": "@onehop/js!", + "docComment": "", + "name": "@onehop/js", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EntryPoint", + "canonicalReference": "@onehop/js!", + "name": "", + "preserveMemberOrder": false, + "members": [ + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!AnyId:type", + "docComment": "/**\n * Any/all IDs that are used within the API\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type AnyId = " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "IdPrefixes", + "canonicalReference": "@onehop/js!IdPrefixes:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "AnyId", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!API:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace api " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "API", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!APIAuthentication:type", + "docComment": "/**\n * All possible authentication ID types\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type APIAuthentication = " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "APIAuthenticationPrefix", + "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "APIAuthentication", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type", + "docComment": "/**\n * A valid ID prefix supported by the Hop API for authetication\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type APIAuthenticationPrefix = " + }, + { + "kind": "Content", + "text": "'ptk' | 'bearer' | 'pat'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "APIAuthenticationPrefix", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Class", + "canonicalReference": "@onehop/js!APIClient:class", + "docComment": "/**\n * API Client that is responsible for handling all requests\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare class APIClient " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "APIClient", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@onehop/js!APIClient:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `APIClient` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(options: " + }, + { + "kind": "Reference", + "text": "APIClientOptions", + "canonicalReference": "@onehop/js!APIClientOptions:interface" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!APIClient#authType:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly authType: " + }, + { + "kind": "Reference", + "text": "APIAuthenticationPrefix", + "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "authType", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#delete:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "delete['path']" + }, + { + "kind": "Content", + "text": ">(path: " + }, + { + "kind": "Content", + "text": "Path" + }, + { + "kind": "Content", + "text": ", body: " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n path: Path;\n method: 'DELETE';\n }>['body']" + }, + { + "kind": "Content", + "text": ", query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", init?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/users/@me/pats/:pat_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/projects/:project_id/tokens/:project_token_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/projects/@this/tokens/:project_token_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/projects/:project_id/secrets/:secret_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/projects/@this/secrets/:secret_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/channels/:channel_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/channels/tokens/:token\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/ignite/deployments/:deployment_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/ignite/containers/:container_id\", void | {\n container: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/ignite/domains/:domain_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/pipe/rooms/:room_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"DELETE\", \"/v1/registry/images/:image\", void>, {\n path: Path;\n method: 'DELETE';\n }>)[\"res\"]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 18, + "endIndex": 70 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "isOptional": false + }, + { + "parameterName": "body", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "isOptional": false + }, + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + }, + "isOptional": false + }, + { + "parameterName": "init", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "delete" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#get:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "get" + }, + { + "kind": "Content", + "text": ">(path: " + }, + { + "kind": "Content", + "text": "Path" + }, + { + "kind": "Content", + "text": ", query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", init?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/users/@me\", {\n projects: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": "[];\n user: " + }, + { + "kind": "Reference", + "text": "SelfUser", + "canonicalReference": "@onehop/js!SelfUser:interface" + }, + { + "kind": "Content", + "text": ";\n project_member_role_map: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<`project_${string}`, " + }, + { + "kind": "Reference", + "text": "MemberRole", + "canonicalReference": "@onehop/js!MemberRole:interface" + }, + { + "kind": "Content", + "text": ">;\n leap_token: string | null;\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/users/@me/pats\", {\n pats: " + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/:project_id/members/@me\", {\n project_member: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/:project_id/tokens\", {\n project_tokens: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/@this/tokens\", {\n project_tokens: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/:project_id/members\", {\n members: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/@this/members\", {\n members: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/:project_id/secrets\", {\n secrets: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/projects/@this/secrets\", {\n secrets: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels/:channel_id\", {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels/:channel_id/tokens\", {\n tokens: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels/:channel_id/state\", {\n state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels\", {\n channels: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels/tokens/:token\", {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/channels/:channel_id/stats\", {\n stats: {\n online_count: number;\n };\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments\", {\n deployments: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/containers\", {\n containers: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/containers/:container_id/logs\", {\n logs: " + }, + { + "kind": "Reference", + "text": "ContainerLog", + "canonicalReference": "@onehop/js!ContainerLog:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments/search\", {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id\", {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/gateways/:gateway_id\", {\n gateway: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/gateways\", {\n gateways: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/storage\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/ignite/domains/:domain_id\", {\n domain: " + }, + { + "kind": "Reference", + "text": "Domain", + "canonicalReference": "@onehop/js!Domain:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/pipe/rooms\", {\n rooms: " + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/registry/images\", {\n images: string[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"GET\", \"/v1/registry/images/:image/manifests\", {\n manifests: {\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[];\n }>, {\n path: Path;\n method: 'GET';\n }>)[\"res\"]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 3 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 177 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 4, + "endIndex": 5 + }, + "isOptional": false + }, + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 8 + }, + "isOptional": false + }, + { + "parameterName": "init", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "get" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient.getAuthType:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "static getAuthType(auth: " + }, + { + "kind": "Reference", + "text": "APIAuthentication", + "canonicalReference": "@onehop/js!APIAuthentication:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "APIAuthenticationPrefix", + "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isStatic": true, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "auth", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "getAuthType" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#patch:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "patch['path']" + }, + { + "kind": "Content", + "text": ">(path: " + }, + { + "kind": "Content", + "text": "Path" + }, + { + "kind": "Content", + "text": ", body: " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n path: Path;\n method: 'PATCH';\n }>['body']" + }, + { + "kind": "Content", + "text": ", query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", init?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PATCH\", \"/v1/channels/:channel_id/state\", void, " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ">, {\n path: Path;\n method: 'PATCH';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PATCH\", \"/v1/channels/tokens/:token\", {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n expiresAt?: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": " | null;\n state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'PATCH';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id\", {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n }, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentConfig", + "canonicalReference": "@onehop/js!DeploymentConfig:interface" + }, + { + "kind": "Content", + "text": ">>, {\n path: Path;\n method: 'PATCH';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id/metadata\", {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n }, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentMetaData", + "canonicalReference": "@onehop/js!DeploymentMetaData:interface" + }, + { + "kind": "Content", + "text": ">>, {\n path: Path;\n method: 'PATCH';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id/health-check\", {\n health_check: " + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ";\n }, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", \"id\">>>, {\n path: Path;\n method: 'PATCH';\n }>)[\"res\"]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 18, + "endIndex": 68 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "isOptional": false + }, + { + "parameterName": "body", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "isOptional": false + }, + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + }, + "isOptional": false + }, + { + "parameterName": "init", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "patch" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#post:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "post['path']" + }, + { + "kind": "Content", + "text": ">(path: " + }, + { + "kind": "Content", + "text": "Path" + }, + { + "kind": "Content", + "text": ", body: " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n path: Path;\n method: 'POST';\n }>['body']" + }, + { + "kind": "Content", + "text": ", query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", init?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/users/@me/pats\", {\n pat: " + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n name: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/projects/:project_id/tokens\", {\n project_token: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }, {\n flags: number;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/projects/@this/tokens\", {\n project_token: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }, {\n flags: number;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/channels\", {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ";\n state: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": " | null;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/channels/tokens\", {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/channels/tokens/:token/messages\", void, {\n e: string;\n d: unknown;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/channels/:channel_id/messages\", void, {\n e: string;\n d: unknown;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/containers\", {\n container: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/containers/:container_id\", never, {\n deployment_id: `deployment_${string}`;\n container_id: `container_${string}`;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments\", {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n }, " + }, + { + "kind": "Reference", + "text": "CreateDeploymentConfig", + "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" + }, + { + "kind": "Content", + "text": ">, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/gateways/:gateway_id/domains\", void, {\n domain: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/gateways\", {\n gateway: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType", + "canonicalReference": "@onehop/js!GatewayType:enum" + }, + { + "kind": "Content", + "text": ";\n target_port: number;\n protocol: \"http\" | null;\n name: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/rollouts\", {\n rollout: " + }, + { + "kind": "Reference", + "text": "DeploymentRollout", + "canonicalReference": "@onehop/js!DeploymentRollout:type" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/health-check\", {\n health_check: " + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ";\n }, " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", \"id\">>, {\n path: Path;\n method: 'POST';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"POST\", \"/v1/pipe/rooms\", {\n room: " + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n name: string;\n ingest_protocol: \"rtmp\" | \"rtp\";\n delivery_protocols: " + }, + { + "kind": "Reference", + "text": "DeliveryProtocol", + "canonicalReference": "@onehop/js!DeliveryProtocol:type" + }, + { + "kind": "Content", + "text": "[];\n region: " + }, + { + "kind": "Reference", + "text": "Regions", + "canonicalReference": "@onehop/js!Regions:enum" + }, + { + "kind": "Content", + "text": ";\n ephemeral: boolean;\n llhls_config?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n } | undefined;\n }>, {\n path: Path;\n method: 'POST';\n }>)[\"res\"]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 18, + "endIndex": 124 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "isOptional": false + }, + { + "parameterName": "body", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "isOptional": false + }, + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + }, + "isOptional": false + }, + { + "parameterName": "init", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "post" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#put:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "put['path']" + }, + { + "kind": "Content", + "text": ">(path: " + }, + { + "kind": "Content", + "text": "Path" + }, + { + "kind": "Content", + "text": ", body: " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n path: Path;\n method: 'PUT';\n }>['body']" + }, + { + "kind": "Content", + "text": ", query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ", init?: " + }, + { + "kind": "Reference", + "text": "RequestInit", + "canonicalReference": "!RequestInit:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/projects/:project_id/secrets/:name\", {\n secret: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": ";\n }, string>, {\n path: Path;\n method: 'PUT';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/projects/@this/secrets/:name\", {\n secret: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": ";\n }, string>, {\n path: Path;\n method: 'PUT';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/channels/:channel_id\", {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n }, {\n type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ";\n state: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": " | null;\n }>, {\n path: Path;\n method: 'PUT';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/channels/:channel_id/subscribers/:token\", void>, {\n path: Path;\n method: 'PUT';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/channels/:channel_id/state\", void, " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ">, {\n path: Path;\n method: 'PUT';\n }> | " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<\"PUT\", \"/v1/ignite/containers/:container_id/state\", void, {\n preferred_state: " + }, + { + "kind": "Reference", + "text": "ContainerState.RUNNING", + "canonicalReference": "@onehop/js!ContainerState.RUNNING:member" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "ContainerState.STOPPED", + "canonicalReference": "@onehop/js!ContainerState.STOPPED:member" + }, + { + "kind": "Content", + "text": ";\n }>, {\n path: Path;\n method: 'PUT';\n }>)[\"res\"]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 5 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 18, + "endIndex": 60 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "path", + "parameterTypeTokenRange": { + "startIndex": 6, + "endIndex": 7 + }, + "isOptional": false + }, + { + "parameterName": "body", + "parameterTypeTokenRange": { + "startIndex": 8, + "endIndex": 12 + }, + "isOptional": false + }, + { + "parameterName": "query", + "parameterTypeTokenRange": { + "startIndex": 13, + "endIndex": 15 + }, + "isOptional": false + }, + { + "parameterName": "init", + "parameterTypeTokenRange": { + "startIndex": 16, + "endIndex": 17 + }, + "isOptional": true + } + ], + "isOptional": false, + "isAbstract": false, + "name": "put" + }, + { + "kind": "Method", + "canonicalReference": "@onehop/js!APIClient#raw:member(1)", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "raw(request: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "!Request:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "isStatic": false, + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 5 + }, + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "request", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "isOptional": false, + "isAbstract": false, + "name": "raw" + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!APIClient#url:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly url: " + }, + { + "kind": "Content", + "text": "(path: Path, query: " + }, + { + "kind": "Reference", + "text": "Query", + "canonicalReference": "@onehop/js!Query:type" + }, + { + "kind": "Content", + "text": ") => string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!APIClientOptions:interface", + "docComment": "/**\n * Options passed to the API client. This will usually come from Hop#constructor in most cases\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface APIClientOptions " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "APIClientOptions", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!APIClientOptions#authentication:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly authentication: " + }, + { + "kind": "Reference", + "text": "APIAuthentication", + "canonicalReference": "@onehop/js!APIAuthentication:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "authentication", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!APIClientOptions#baseUrl:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly baseUrl: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "baseUrl", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!APIResponse:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type APIResponse = " + }, + { + "kind": "Reference", + "text": "SuccessfulAPIResponse", + "canonicalReference": "@onehop/js!SuccessfulAPIResponse:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "ErroredAPIResponse", + "canonicalReference": "@onehop/js!ErroredAPIResponse:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "APIResponse", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!assertId:function(1)", + "docComment": "/**\n * Asserts that a string is a valid ID\n *\n * @param maybeId - A string that is possibly an ID\n *\n * @param prefix - A prefix or array of prefixes to check against\n *\n * @param message - An error message to throw if the ID is invalid\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function assertId(maybeId: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": ", prefix?: " + }, + { + "kind": "Content", + "text": "T | T[]" + }, + { + "kind": "Content", + "text": ", message?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "asserts " + }, + { + "kind": "Reference", + "text": "maybeId", + "canonicalReference": "@onehop/js!~maybeId" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 11, + "endIndex": 16 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "maybeId", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "prefix", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + }, + { + "parameterName": "message", + "parameterTypeTokenRange": { + "startIndex": 9, + "endIndex": 10 + }, + "isOptional": true + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "assertId" + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Auth:interface", + "docComment": "/**\n * Docker image registry authorization\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Auth " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Auth", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Auth#password:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "password: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "password", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Auth#username:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "username: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "username", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!BROAD_PERMISSIONS_MAP:var", + "docComment": "/**\n * Broader permission map\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "BROAD_PERMISSIONS_MAP: " + }, + { + "kind": "Content", + "text": "{\n MANAGE_MEMBERS: bigint;\n MANAGE_PROJECT_TOKENS: bigint;\n MANAGE_DEPLOYMENTS: bigint;\n MANAGE_PIPE: bigint;\n MANAGE_SECRETS: bigint;\n MANAGE_CHANNELS: bigint;\n MANAGE_REGISTRY: bigint;\n READ_ONLY: bigint;\n MANAGE_QUOTAS: bigint;\n MANAGE_ROLLOUTS: bigint;\n MANAGE_BILLING: bigint;\n}" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "BROAD_PERMISSIONS_MAP", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Build:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Build " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Build", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#created_at:member", + "docComment": "/**\n * Timestamp of when the build was created/queued\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at?: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#deployment_id:member", + "docComment": "/**\n * Deployment ID for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deployment_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "deployment_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#digest:member", + "docComment": "/**\n * Digest for image\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "digest: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "digest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#environment:member", + "docComment": "/**\n * Environment for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "environment: " + }, + { + "kind": "Reference", + "text": "BuildEnvironment", + "canonicalReference": "@onehop/js!BuildEnvironment:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "environment", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#finished_at:member", + "docComment": "/**\n * Timestamp of when the build has finished\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "finished_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "finished_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#id:member", + "docComment": "/**\n * ID of the build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'build'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#metadata:member", + "docComment": "/**\n * Metadata pertaining to build (mostly for GitHub)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata: " + }, + { + "kind": "Reference", + "text": "BuildMetaData", + "canonicalReference": "@onehop/js!BuildMetaData:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#method:member", + "docComment": "/**\n * Build method (GitHub or CLI)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "method: " + }, + { + "kind": "Reference", + "text": "BuildMethod", + "canonicalReference": "@onehop/js!BuildMethod:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "method", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#started_at:member", + "docComment": "/**\n * Timestamp of when the build has started\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "started_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "started_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#state:member", + "docComment": "/**\n * State of the build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "BuildState", + "canonicalReference": "@onehop/js!BuildState:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Build#validation_failure:member", + "docComment": "/**\n * Validation failure for build; present if build state is VALIDATION_FAILED\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "validation_failure: " + }, + { + "kind": "Reference", + "text": "ValidationFailure", + "canonicalReference": "@onehop/js!ValidationFailure:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "validation_failure", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!BuildEnvironment:interface", + "docComment": "/**\n * Build environment contians information about the language and build commands used to build the deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BuildEnvironment " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildEnvironment", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildEnvironment#nix_plan:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "nix_plan?: " + }, + { + "kind": "Reference", + "text": "NixPlan", + "canonicalReference": "@onehop/js!NixPlan:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "nix_plan", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildEnvironment#type:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "BuildEnvironmentType", + "canonicalReference": "@onehop/js!BuildEnvironmentType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!BuildEnvironmentType:enum", + "docComment": "/**\n * The inferred environment type of a build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum BuildEnvironmentType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildEnvironmentType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildEnvironmentType.DOCKERFILE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DOCKERFILE = " + }, + { + "kind": "Content", + "text": "\"dockerfile\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DOCKERFILE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildEnvironmentType.NIXPACKS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "NIXPACKS = " + }, + { + "kind": "Content", + "text": "\"nixpacks\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "NIXPACKS" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!BuildMetaData:interface", + "docComment": "/**\n * Metadata attached to a build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BuildMetaData " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildMetaData", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#account_type:member", + "docComment": "/**\n * Account type of repo owner\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "account_type?: " + }, + { + "kind": "Content", + "text": "'user' | 'organization'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "account_type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#author:member", + "docComment": "/**\n * Author information about build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "author?: " + }, + { + "kind": "Content", + "text": "{\n avatar_url: string;\n username: string;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "author", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#branch:member", + "docComment": "/**\n * Repo branch for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "branch: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "branch", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#commit_msg:member", + "docComment": "/**\n * commit message for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "commit_msg: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "commit_msg", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#commit_sha:member", + "docComment": "/**\n * commit SHA for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "commit_sha: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "commit_sha", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#commit_url:member", + "docComment": "/**\n * commit URL for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "commit_url?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "commit_url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#repo_id:member", + "docComment": "/**\n * Repo ID for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "repo_id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "repo_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildMetaData#repo_name:member", + "docComment": "/**\n * Repo name for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "repo_name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "repo_name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!BuildMethod:enum", + "docComment": "/**\n * Types of build methods supported by Hop\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum BuildMethod " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildMethod", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildMethod.CLI:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CLI = " + }, + { + "kind": "Content", + "text": "\"cli\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CLI" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildMethod.GITHUB:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "GITHUB = " + }, + { + "kind": "Content", + "text": "\"github\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "GITHUB" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!BuildSettings:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface BuildSettings " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildSettings", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!BuildSettings#root_directory:member", + "docComment": "/**\n * Root directory for build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "root_directory?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "root_directory", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!BuildState:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum BuildState " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "BuildState", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.CANCELLED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CANCELLED = " + }, + { + "kind": "Content", + "text": "\"cancelled\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CANCELLED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.FAILED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FAILED = " + }, + { + "kind": "Content", + "text": "\"failed\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FAILED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.PENDING:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PENDING = " + }, + { + "kind": "Content", + "text": "\"pending\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PENDING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.SUCCEEDED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "SUCCEEDED = " + }, + { + "kind": "Content", + "text": "\"succeeded\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "SUCCEEDED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.VALIDATING:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VALIDATING = " + }, + { + "kind": "Content", + "text": "\"validating\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VALIDATING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!BuildState.VALIDATION_FAILED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VALIDATION_FAILED = " + }, + { + "kind": "Content", + "text": "\"validation_failed\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VALIDATION_FAILED" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!bytes:function(1)", + "docComment": "/**\n * Helper function to converts a numerical size to a valid byte size string\n *\n * @param size - A size to convert to a valid byte size string\n *\n * @param unit - An optional unit to as the size unit. Defaults to B\n *\n * @returns a byte size string\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function bytes(size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ", unit?: " + }, + { + "kind": "Reference", + "text": "ByteUnit", + "canonicalReference": "@onehop/js!ByteUnit:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "unit", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + } + ], + "name": "bytes" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ByteSizeString:type", + "docComment": "/**\n * A string representing a byte size\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ByteSizeString = " + }, + { + "kind": "Content", + "text": "`${number}${" + }, + { + "kind": "Reference", + "text": "ByteUnit", + "canonicalReference": "@onehop/js!ByteUnit:type" + }, + { + "kind": "Content", + "text": "}`" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ByteSizeString", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ByteString:type", + "docComment": "/**\n * A string representing a byte size\n *\n * @deprecated\n *\n * use `ByteSizeString` instead\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ByteString = " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ByteString", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ByteUnit:type", + "docComment": "/**\n * Byte size unit type\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ByteUnit = " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "byteUnits", + "canonicalReference": "@onehop/js!byteUnits:var" + }, + { + "kind": "Content", + "text": "[number]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ByteUnit", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!byteUnits:var", + "docComment": "/**\n * API parsable byte size units strings\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "byteUnits: " + }, + { + "kind": "Content", + "text": "readonly [\"GB\", \"MB\", \"KB\", \"B\"]" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "byteUnits", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Channel:interface", + "docComment": "/**\n * Definition of a channel\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Channel " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Channel", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#capabilities:member", + "docComment": "/**\n * Capabilities of the channel\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "capabilities: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "capabilities", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#created_at:member", + "docComment": "/**\n * When this channel was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#id:member", + "docComment": "/**\n * The ID of the channel\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#project:member", + "docComment": "/**\n * The project it is associated with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "project", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#state:member", + "docComment": "/**\n * State metadata\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Channel#type:member", + "docComment": "/**\n * The type of this channel\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ChannelEndpoints:type", + "docComment": "/**\n * Endpoints for channels\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ChannelEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/channels', {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ";\n state: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": " | null;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/channels/:channel_id', {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ";\n state: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": " | null;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/channels/tokens', {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/channels/:channel_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels/:channel_id', {\n channel: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels/:channel_id/tokens', {\n tokens: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/channels/tokens/:token/messages', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", {\n e: string;\n d: unknown;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/channels/:channel_id/subscribers/:token', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PATCH', '/v1/channels/:channel_id/state', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/channels/:channel_id/state', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels/:channel_id/state', {\n state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/channels/:channel_id/messages', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", {\n e: string;\n d: unknown;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels', {\n channels: " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels/tokens/:token', {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PATCH', '/v1/channels/tokens/:token', {\n token: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n expiresAt?: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": " | null;\n state: " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": "['state'];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/channels/tokens/:token', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/channels/:channel_id/stats', {\n stats: {\n online_count: number;\n };\n}>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ChannelEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 85 + } + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Channels:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace channels " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Channels", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!ChannelToken:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ChannelToken " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ChannelToken", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ChannelToken#id:member", + "docComment": "/**\n * The ID for the token\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'leap_token'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ChannelToken#is_online:member", + "docComment": "/**\n * If this token is currently online (e.g. active heartbeat and connected to leap)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "is_online: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "is_online", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ChannelToken#project_id:member", + "docComment": "/**\n * The project this channel token is associated with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "project_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'project'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "project_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ChannelToken#state:member", + "docComment": "/**\n * State for this token\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!ChannelType:enum", + "docComment": "/**\n * Types that a channel can be\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum ChannelType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ChannelType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ChannelType.PRIVATE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PRIVATE = " + }, + { + "kind": "Content", + "text": "\"private\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PRIVATE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ChannelType.PUBLIC:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PUBLIC = " + }, + { + "kind": "Content", + "text": "\"public\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PUBLIC" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ChannelType.UNPROTECTED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UNPROTECTED = " + }, + { + "kind": "Content", + "text": "\"unprotected\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "UNPROTECTED" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Container:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Container " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Container", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#created_at:member", + "docComment": "/**\n * The time this container was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#deployment_id:member", + "docComment": "/**\n * The ID of the deployment this container is associated with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deployment_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "deployment_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#id:member", + "docComment": "/**\n * The ID of the container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'container'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#internal_ip:member", + "docComment": "/**\n * The internal IP of the container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "internal_ip: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "internal_ip", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#metadata:member", + "docComment": "/**\n * Information about the container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata: " + }, + { + "kind": "Content", + "text": "{\n last_exit_code?: number;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#metrics:member", + "docComment": "/**\n * Metrics for this container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metrics: " + }, + { + "kind": "Content", + "text": "{\n cpu_usage_percent: number;\n memory_usage_percent: number;\n } | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "metrics", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#overrides:member", + "docComment": "/**\n * Overrides that were provided manually to the container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "overrides: " + }, + { + "kind": "Content", + "text": "{\n resources?: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Resources", + "canonicalReference": "@onehop/js!Resources:interface" + }, + { + "kind": "Content", + "text": ">;\n } | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "overrides", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#region:member", + "docComment": "/**\n * The region this container runs in\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "region: " + }, + { + "kind": "Reference", + "text": "Regions", + "canonicalReference": "@onehop/js!Regions:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "region", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#state:member", + "docComment": "/**\n * The state this container is in\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "ContainerState", + "canonicalReference": "@onehop/js!ContainerState:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#type:member", + "docComment": "/**\n * The type of this container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "RuntimeType", + "canonicalReference": "@onehop/js!RuntimeType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#uptime:member", + "docComment": "/**\n * Information about uptime/downtime for this container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "uptime: " + }, + { + "kind": "Content", + "text": "{\n last_start: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "uptime", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Container#volume:member", + "docComment": "/**\n * The volume definition for this container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "volume: " + }, + { + "kind": "Reference", + "text": "VolumeDefinition", + "canonicalReference": "@onehop/js!VolumeDefinition:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "volume", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!ContainerLog:interface", + "docComment": "/**\n * Logs from a container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ContainerLog " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ContainerLog", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ContainerLog#level:member", + "docComment": "/**\n * The level of the log. stdout becomes `info`\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "level: " + }, + { + "kind": "Content", + "text": "'info' | 'error'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "level", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ContainerLog#message:member", + "docComment": "/**\n * The log message\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "message: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "message", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ContainerLog#nonce:member", + "docComment": "/**\n * The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "nonce: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "nonce", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ContainerLog#timestamp:member", + "docComment": "/**\n * The timestamp of the log\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "timestamp: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "timestamp", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!ContainerState:enum", + "docComment": "/**\n * Container state is relatively self-explanatory. It describes what the container is currently doing.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum ContainerState " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ContainerState", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.EXITED:member", + "docComment": "/**\n * The container exited (e.g. with a zero exit code)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "EXITED = " + }, + { + "kind": "Content", + "text": "\"exited\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "EXITED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.FAILED:member", + "docComment": "/**\n * The container's entrypoint failed (e.g. exited with a non-zero exit code)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "FAILED = " + }, + { + "kind": "Content", + "text": "\"failed\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FAILED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.PENDING:member", + "docComment": "/**\n * The container is pending creation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PENDING = " + }, + { + "kind": "Content", + "text": "\"pending\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PENDING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.RUNNING:member", + "docComment": "/**\n * The container is running\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "RUNNING = " + }, + { + "kind": "Content", + "text": "\"running\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "RUNNING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.STOPPED:member", + "docComment": "/**\n * The container is stopped\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "STOPPED = " + }, + { + "kind": "Content", + "text": "\"stopped\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "STOPPED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerState.TERMINATING:member", + "docComment": "/**\n * The container is being deleted\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "TERMINATING = " + }, + { + "kind": "Content", + "text": "\"terminating\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "TERMINATING" + } + ] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!ContainerStrategy:enum", + "docComment": "/**\n * The strategy for scaling multiple containers. @warning This property is not yet fully complete\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum ContainerStrategy " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ContainerStrategy", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ContainerStrategy.MANUAL:member", + "docComment": "/**\n * Add containers yourself with the API or Console\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "MANUAL = " + }, + { + "kind": "Content", + "text": "\"manual\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "MANUAL" + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!CreateDeploymentConfig:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type CreateDeploymentConfig = " + }, + { + "kind": "Reference", + "text": "MakeOptional", + "canonicalReference": "@onehop/js!MakeOptional:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentConfig", + "canonicalReference": "@onehop/js!DeploymentConfig:interface" + }, + { + "kind": "Content", + "text": ", 'cmd'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "CreateDeploymentConfig", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!DEFAULT_BASE_URL:var", + "docComment": "/**\n * The default base URL for Hop's API.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "DEFAULT_BASE_URL = " + }, + { + "kind": "Content", + "text": "\"https://api.hop.io\"" + } + ], + "fileUrlPath": "dist/index.d.ts", + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isReadonly": true, + "releaseTag": "Public", + "name": "DEFAULT_BASE_URL", + "variableTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!DefaultQuotas:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface DefaultQuotas " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DefaultQuotas", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DefaultQuotas#ram:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ram", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DefaultQuotas#vcpu:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "vcpu: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "vcpu", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DefaultQuotas#volume:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "volume: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "volume", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!DeliveryProtocol:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type DeliveryProtocol = " + }, + { + "kind": "Content", + "text": "'webrtc' | 'hls'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DeliveryProtocol", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Deployment:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Deployment " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Deployment", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#active_build:member", + "docComment": "/**\n * Current active build for deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "active_build: " + }, + { + "kind": "Reference", + "text": "Build", + "canonicalReference": "@onehop/js!Build:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "active_build", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#active_rollout:member", + "docComment": "/**\n * Current active rollout for deployment\n *\n * @deprecated\n *\n * Use latest_rollout\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "active_rollout: " + }, + { + "kind": "Reference", + "text": "DeploymentRollout", + "canonicalReference": "@onehop/js!DeploymentRollout:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "active_rollout", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#build_cache_enabled:member", + "docComment": "/**\n * Build cache settings for deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "build_cache_enabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "build_cache_enabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#build_id:member", + "docComment": "/**\n * The ID of the build currently being used in production by this deployment. This will change if another build has been promoted to production.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "build_id: " + }, + { + "kind": "Reference", + "text": "Build", + "canonicalReference": "@onehop/js!Build:interface" + }, + { + "kind": "Content", + "text": "['id'] | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "build_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#build_settings:member", + "docComment": "/**\n * Build settings for deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "build_settings?: " + }, + { + "kind": "Reference", + "text": "BuildSettings", + "canonicalReference": "@onehop/js!BuildSettings:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "build_settings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#config:member", + "docComment": "/**\n * The config for this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "config: " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentConfig", + "canonicalReference": "@onehop/js!DeploymentConfig:interface" + }, + { + "kind": "Content", + "text": ", 'name'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "config", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#container_count:member", + "docComment": "/**\n * The amount of containers this deployment is currently running\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "container_count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "container_count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#created_at:member", + "docComment": "/**\n * The time this deployment was created at\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#id:member", + "docComment": "/**\n * The ID of the deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#latest_rollout:member", + "docComment": "/**\n * Current active rollout for deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "latest_rollout: " + }, + { + "kind": "Reference", + "text": "DeploymentRollout", + "canonicalReference": "@onehop/js!DeploymentRollout:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "latest_rollout", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#metadata:member", + "docComment": "/**\n * Metadata for deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "metadata: " + }, + { + "kind": "Reference", + "text": "DeploymentMetaData", + "canonicalReference": "@onehop/js!DeploymentMetaData:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "metadata", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#name:member", + "docComment": "/**\n * The name of the deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#running_container_count:member", + "docComment": "/**\n * The amount of containers in the running state\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "running_container_count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "running_container_count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Deployment#target_container_count:member", + "docComment": "/**\n * The target amount of containers a deployment should run\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "target_container_count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "target_container_count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!DeploymentConfig:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface DeploymentConfig " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DeploymentConfig", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#cmd:member", + "docComment": "/**\n * Entrypoint command for the image\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "cmd?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "cmd", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#container_strategy:member", + "docComment": "/**\n * The strategy for scaling multiple containers.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "container_strategy: " + }, + { + "kind": "Reference", + "text": "ContainerStrategy", + "canonicalReference": "@onehop/js!ContainerStrategy:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "container_strategy", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#entrypoint:member", + "docComment": "/**\n * Entrypoint for this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "entrypoint?: " + }, + { + "kind": "Content", + "text": "string[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "entrypoint", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#env:member", + "docComment": "/**\n * Environment variables for this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "env: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "env", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#image:member", + "docComment": "/**\n * The docker image config for this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "image: " + }, + { + "kind": "Reference", + "text": "Image", + "canonicalReference": "@onehop/js!Image_2:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "image", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#name:member", + "docComment": "/**\n * The name of the deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#resources:member", + "docComment": "/**\n * Resources allocated to this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "resources: " + }, + { + "kind": "Reference", + "text": "Resources", + "canonicalReference": "@onehop/js!Resources:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "resources", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#restart_policy:member", + "docComment": "/**\n * Restart policy for this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "restart_policy: " + }, + { + "kind": "Reference", + "text": "RestartPolicy", + "canonicalReference": "@onehop/js!RestartPolicy:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "restart_policy", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#type:member", + "docComment": "/**\n * The type of this deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "RuntimeType", + "canonicalReference": "@onehop/js!RuntimeType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#version:member", + "docComment": "/**\n * The version of this config\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "version: " + }, + { + "kind": "Content", + "text": "'12-12-2022'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "version", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentConfig#volume:member", + "docComment": "/**\n * The volume definition for this deployment\n *\n * This can only be used when .type is 'stateful'\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "volume?: " + }, + { + "kind": "Reference", + "text": "VolumeDefinition", + "canonicalReference": "@onehop/js!VolumeDefinition:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "volume", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!DeploymentMetaData:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface DeploymentMetaData " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DeploymentMetaData", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentMetaData#container_port_mappings:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "container_port_mappings: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'container'>, string[]>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "container_port_mappings", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 5 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentMetaData#created_first_gateway:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_first_gateway?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "created_first_gateway", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentMetaData#created_from_preset:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_from_preset?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "created_from_preset", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DeploymentMetaData#ignored_boarding:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ignored_boarding?: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": true, + "releaseTag": "Public", + "name": "ignored_boarding", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!DeploymentRollout:type", + "docComment": "/**\n * A deployment rollout\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type DeploymentRollout = " + }, + { + "kind": "Content", + "text": "{\n id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'rollout'>;\n deployment_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>;\n count: number;\n created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";\n state: " + }, + { + "kind": "Reference", + "text": "RolloutState", + "canonicalReference": "@onehop/js!RolloutState:enum" + }, + { + "kind": "Content", + "text": ";\n build: " + }, + { + "kind": "Reference", + "text": "Build", + "canonicalReference": "@onehop/js!Build:interface" + }, + { + "kind": "Content", + "text": " | null;\n init_container_id: string | null;\n health_check_failed: boolean;\n last_updated_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";\n acknowledged: boolean;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DeploymentRollout", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 14 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Domain:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Domain " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Domain", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Domain#created_at:member", + "docComment": "/**\n * The date this domain was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Domain#domain:member", + "docComment": "/**\n * The domain name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "domain: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "domain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Domain#id:member", + "docComment": "/**\n * The ID of the domain\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'domain'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Domain#redirect:member", + "docComment": "/**\n * Where the domain redirects to and its status code, null if N/A\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "redirect: " + }, + { + "kind": "Reference", + "text": "DomainRedirect", + "canonicalReference": "@onehop/js!DomainRedirect:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "redirect", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Domain#state:member", + "docComment": "/**\n * The domain state\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Reference", + "text": "DomainState", + "canonicalReference": "@onehop/js!DomainState:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!DomainRedirect:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface DomainRedirect " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DomainRedirect", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DomainRedirect#status_code:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "status_code: " + }, + { + "kind": "Content", + "text": "301 | 302 | 307 | 308" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "status_code", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!DomainRedirect#url:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "url: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "url", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!DomainState:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum DomainState " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "DomainState", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!DomainState.PENDING:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PENDING = " + }, + { + "kind": "Content", + "text": "\"pending\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PENDING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!DomainState.SSL_ACTIVE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "SSL_ACTIVE = " + }, + { + "kind": "Content", + "text": "\"ssl_active\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "SSL_ACTIVE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!DomainState.VALID_CNAME:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "VALID_CNAME = " + }, + { + "kind": "Content", + "text": "\"valid_cname\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "VALID_CNAME" + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Empty:type", + "docComment": "/**\n * An empty response type\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Empty = " + }, + { + "kind": "Content", + "text": "void" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Empty", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Endpoint:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Endpoint = " + }, + { + "kind": "Content", + "text": "{\n method: M;\n path: Path;\n res: Res;\n body: Body;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Endpoint", + "typeParameters": [ + { + "typeParameterName": "M", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Res", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Body", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + } + } + ], + "typeTokenRange": { + "startIndex": 7, + "endIndex": 8 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Endpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Endpoints = " + }, + { + "kind": "Reference", + "text": "IgniteEndpoints", + "canonicalReference": "@onehop/js!IgniteEndpoints:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "RegistryEndpoints", + "canonicalReference": "@onehop/js!RegistryEndpoints:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "UserEndpoints", + "canonicalReference": "@onehop/js!UserEndpoints:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "ProjectsEndpoints", + "canonicalReference": "@onehop/js!ProjectsEndpoints:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "PipeEndpoints", + "canonicalReference": "@onehop/js!PipeEndpoints:type" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "ChannelEndpoints", + "canonicalReference": "@onehop/js!ChannelEndpoints:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Endpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 12 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ErroredAPIResponse:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ErroredAPIResponse = " + }, + { + "kind": "Content", + "text": "{\n success: false;\n error: {\n code: string;\n message: string;\n };\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ErroredAPIResponse", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ExtractEndpoint:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ExtractEndpoint = " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n path: Path;\n method: Method;\n}>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "ExtractEndpoint", + "typeParameters": [ + { + "typeParameterName": "Method", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 5, + "endIndex": 9 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ExtractRouteParams:type", + "docComment": "/**\n * Creates a record of params required for a given URL/path\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ExtractRouteParams = " + }, + { + "kind": "Content", + "text": "string extends T ? " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": " : T extends `${string}:${infer Param}/${infer Rest}` ? {\n [k in Param | keyof " + }, + { + "kind": "Reference", + "text": "ExtractRouteParams", + "canonicalReference": "@onehop/js!ExtractRouteParams:type" + }, + { + "kind": "Content", + "text": "]: string | number;\n} : T extends `${string}:${infer Param}` ? {\n [k in Param]: string | number;\n} : {}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ExtractRouteParams", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 8 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Gateway:interface", + "docComment": "/**\n * Gateways are used to connect services to the internet or a private network\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Gateway " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Gateway", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#created_at:member", + "docComment": "/**\n * The date this gateway was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#deployment_id:member", + "docComment": "/**\n * The deployment this gateway is associated with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "deployment_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "deployment_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#domains:member", + "docComment": "/**\n * Domains associated with this gateway\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "domains: " + }, + { + "kind": "Reference", + "text": "Domain", + "canonicalReference": "@onehop/js!Domain:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "domains", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#hopsh_domain_enabled:member", + "docComment": "/**\n * Determines if the hop.sh domain is current active.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hopsh_domain_enabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "hopsh_domain_enabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#hopsh_domain:member", + "docComment": "/**\n * Domain automatically assigned by Hop\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "hopsh_domain: " + }, + { + "kind": "Reference", + "text": "HopShDomain", + "canonicalReference": "@onehop/js!HopShDomain:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "hopsh_domain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#id:member", + "docComment": "/**\n * The ID of the gateway\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'gateway'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#internal_domain:member", + "docComment": "/**\n * Internal domain assigned by user upon gateway creation\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "internal_domain: " + }, + { + "kind": "Reference", + "text": "InternalHopDomain", + "canonicalReference": "@onehop/js!InternalHopDomain:type" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "internal_domain", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#name:member", + "docComment": "/**\n * The name of the gateway\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#target_port:member", + "docComment": "/**\n * Port the Gateway targets (Only for external gateways)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "target_port: " + }, + { + "kind": "Content", + "text": "number | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "target_port", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Gateway#type:member", + "docComment": "/**\n * The type of the gateway\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "GatewayType", + "canonicalReference": "@onehop/js!GatewayType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!GatewayType:enum", + "docComment": "/**\n * Types of gateways supported by Hop\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum GatewayType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "GatewayType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member", + "docComment": "/**\n * The gateway can be accessed from the internet\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "EXTERNAL = " + }, + { + "kind": "Content", + "text": "\"external\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "EXTERNAL" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member", + "docComment": "/**\n * The gateway can only be accessed inside of a project's network\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "INTERNAL = " + }, + { + "kind": "Content", + "text": "\"internal\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "INTERNAL" + } + ] + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!getIdPrefix:function(1)", + "docComment": "/**\n * Gets the prefix of an ID\n *\n * @param id - A full ID to extract the prefix from\n *\n * @param expect - An expected prefix to check against\n *\n * @returns - The prefix of the ID\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function getIdPrefix(id: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", expect?: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "id", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "expect", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": true + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "name": "getIdPrefix" + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!GHRepo:interface", + "docComment": "/**\n * GitHub repo type sent from API (NOT USED IN IMAGES)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface GHRepo " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "GHRepo", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!GHRepo#account_name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "account_name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "account_name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!GHRepo#default_branch:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "default_branch: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "default_branch", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!GHRepo#full_name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "full_name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "full_name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!GHRepo#id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!GHRepo#private:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "private: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "private", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!gigabytes:function(1)", + "docComment": "/**\n * Converts a gigabyte size to a byte size string\n *\n * @param size - Gigabytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function gigabytes(size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "gigabytes" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!HealthCheck:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type HealthCheck = " + }, + { + "kind": "Content", + "text": "{\n id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'health_check'>;\n protocol: 'http';\n path: string;\n port: number;\n interval: number;\n timeout: number;\n initial_delay: number;\n max_retries: number;\n created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "HealthCheck", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 6 + } + }, + { + "kind": "Class", + "canonicalReference": "@onehop/js!Hop:class", + "docComment": "/**\n * Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK.\n *\n * @example\n * ```ts\n * const hop = new Hop(bearerTokenOrPATOrProjectToken);\n * await hop.ignite.containers.create(deploymentId);\n * ```\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare class Hop " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "Hop", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@onehop/js!Hop:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `Hop` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(options: " + }, + { + "kind": "Reference", + "text": "PartialAPIOptions", + "canonicalReference": "@onehop/js!PartialAPIOptions:type" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "options", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ] + }, + { + "kind": "Constructor", + "canonicalReference": "@onehop/js!Hop:constructor(2)", + "docComment": "/**\n * Constructs a new instance of the `Hop` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(authentication: " + }, + { + "kind": "Reference", + "text": "APIAuthentication", + "canonicalReference": "@onehop/js!APIAuthentication:type" + }, + { + "kind": "Content", + "text": ", baseurl?: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 2, + "parameters": [ + { + "parameterName": "authentication", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "baseurl", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": true + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#channels:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly channels: " + }, + { + "kind": "Content", + "text": "{\n create(type: " + }, + { + "kind": "Reference", + "text": "ChannelType", + "canonicalReference": "@onehop/js!ChannelType:enum" + }, + { + "kind": "Content", + "text": ", id?: string | null | undefined, options?: {\n state?: T;\n } | null | undefined, project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": " & {\n setState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n patchState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeToken(token: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " + }, + { + "kind": "Reference", + "text": "Set", + "canonicalReference": "!Set:interface" + }, + { + "kind": "Content", + "text": "<`leap_token_${string}`>): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n publishMessage(name: string, data: unknown): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n get(id: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": " & {\n setState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n patchState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeToken(token: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " + }, + { + "kind": "Reference", + "text": "Set", + "canonicalReference": "!Set:interface" + }, + { + "kind": "Content", + "text": "<`leap_token_${string}`>): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n publishMessage(name: string, data: unknown): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getAll(project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": " & {\n setState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n patchState(state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeToken(token: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " + }, + { + "kind": "Reference", + "text": "Set", + "canonicalReference": "!Set:interface" + }, + { + "kind": "Content", + "text": "<`leap_token_${string}`>): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n publishMessage(name: string, data: unknown): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n })[]>;\n subscribeToken(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ", token: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n subscribeTokens(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ", tokens: `leap_token_${string}`[] | " + }, + { + "kind": "Reference", + "text": "Set", + "canonicalReference": "!Set:interface" + }, + { + "kind": "Content", + "text": "<`leap_token_${string}`>): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n getAllTokens(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": "[]>;\n setState(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ", state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n patchState(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ", state: " + }, + { + "kind": "Reference", + "text": "SetStateAction", + "canonicalReference": "@onehop/js!~SetStateAction:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n publishMessage(channel: string | " + }, + { + "kind": "Reference", + "text": "Channel", + "canonicalReference": "@onehop/js!Channel:interface" + }, + { + "kind": "Content", + "text": ", event: string, data: T_5): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n delete(id: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n getStats(id: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<{\n online_count: number;\n }>;\n tokens: {\n delete(token: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n create(state?: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": ", project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ">;\n setState(id: `leap_token_${string}`, state: " + }, + { + "kind": "Reference", + "text": "State", + "canonicalReference": "@onehop/js!State:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ">;\n get(id: `leap_token_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": ">;\n isOnline(idOrToken: `leap_token_${string}` | " + }, + { + "kind": "Reference", + "text": "ChannelToken", + "canonicalReference": "@onehop/js!ChannelToken:interface" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "channels", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 144 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#client:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly client: " + }, + { + "kind": "Reference", + "text": "APIClient", + "canonicalReference": "@onehop/js!APIClient:class" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "client", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#ignite:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly ignite: " + }, + { + "kind": "Content", + "text": "{\n domains: {\n delete: (id: `domain_${string}`) => " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n get: (id: `domain_${string}`) => " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Domain", + "canonicalReference": "@onehop/js!Domain:interface" + }, + { + "kind": "Content", + "text": ">;\n };\n gateways: {\n addDomain(gatewayId: `gateway_${string}`, domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n get(gatewayId: `gateway_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": ">;\n getAll(deploymentId: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n })[]>;\n create(deployment: `deployment_${string}` | " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ", config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n };\n healthChecks: {\n create: (deployment: `deployment_${string}`, config: " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", \"id\">) => " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ">;\n update: (deployment: `deployment_${string}`, config: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", \"id\">>) => " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n deployments: {\n create: {\n (configOrProject: `project_${string}`, bearerOrPatConfig: " + }, + { + "kind": "Reference", + "text": "CreateDeploymentConfig", + "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": " & {\n getContainers(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n createContainer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n createGateway(config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getStorageStats(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n (configOrProject: " + }, + { + "kind": "Reference", + "text": "CreateDeploymentConfig", + "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": " & {\n getContainers(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n createContainer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n createGateway(config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getStorageStats(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n };\n get: {\n (name: string, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": " & {\n getContainers(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n createContainer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n createGateway(config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getStorageStats(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": " & {\n getContainers(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n createContainer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n createGateway(config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getStorageStats(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n };\n rollout(id: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentRollout", + "canonicalReference": "@onehop/js!DeploymentRollout:type" + }, + { + "kind": "Content", + "text": ">;\n getStorageStats(id: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n update(deploymentId: `deployment_${string}`, config: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentConfig", + "canonicalReference": "@onehop/js!DeploymentConfig:interface" + }, + { + "kind": "Content", + "text": ">): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ">;\n getContainers(deployment: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n getAll(projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": " & {\n getContainers(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n createContainer(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n createGateway(config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n getStorageStats(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"volume\" | \"build_cache\", " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n })[]>;\n delete(deployment: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n patchMetadata(deploymentId: `deployment_${string}`, metadata: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentMetaData", + "canonicalReference": "@onehop/js!DeploymentMetaData:interface" + }, + { + "kind": "Content", + "text": ">): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ">;\n gateways: {\n getAll(deploymentId: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n })[]>;\n create(deployment: `deployment_${string}` | " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ", config: {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.EXTERNAL", + "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n } | {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType.INTERNAL", + "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" + }, + { + "kind": "Content", + "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n internalDomain: string;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": " & {\n addDomain(domain: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n deleteDomain(domainId: `domain_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n };\n };\n containers: {\n delete: {\n (container_id: `container_${string}`, options: {\n recreate: true;\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n (container_id: `container_${string}`, options?: {\n recreate?: false;\n } | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n getLogs(container: `container_${string}`, options?: " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<{\n sortBy: \"timestamp\";\n orderBy: \"desc\" | \"asc\";\n limit: number;\n offset: number;\n }>): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ContainerLog", + "canonicalReference": "@onehop/js!ContainerLog:interface" + }, + { + "kind": "Content", + "text": "[]>;\n stop(container: `container_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n start(container: `container_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n create(deployment: `deployment_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ">;\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "ignite", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 290 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#pipe:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly pipe: " + }, + { + "kind": "Content", + "text": "{\n rooms: {\n getAll(project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<(" + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": " & {\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n })[]>;\n create(name: string, options: {\n deliveryProtocols: " + }, + { + "kind": "Reference", + "text": "DeliveryProtocol", + "canonicalReference": "@onehop/js!DeliveryProtocol:type" + }, + { + "kind": "Content", + "text": "[];\n ephemeral?: boolean;\n ingestProtocol: \"rtmp\" | \"rtp\";\n hlsConfig?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n };\n }): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": " & {\n delete(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n delete(room: `pipe_room_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "pipe", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 18 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#projects:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly projects: " + }, + { + "kind": "Content", + "text": "{\n getAllMembers(projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": "[]>;\n getCurrentMember(projectId: `project_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": ">;\n projectTokens: {\n delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n get(projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[]>;\n create(flags: number, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n };\n tokens: {\n delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n get(projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[]>;\n create(flags: number, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n }>;\n };\n secrets: {\n getAll(projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": "[]>;\n create(name: string, value: string, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": ">;\n delete(id: string, projectId?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "projects", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 44 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#registry:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly registry: " + }, + { + "kind": "Content", + "text": "{\n images: {\n getAll(project?: `project_${string}` | undefined): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n getManifest(image: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<{\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[]>;\n delete(image: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "registry", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 8 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!Hop#users:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly users: " + }, + { + "kind": "Content", + "text": "{\n me: {\n get(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<{\n projects: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": "[];\n user: " + }, + { + "kind": "Reference", + "text": "SelfUser", + "canonicalReference": "@onehop/js!SelfUser:interface" + }, + { + "kind": "Content", + "text": ";\n project_member_role_map: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<`project_${string}`, " + }, + { + "kind": "Reference", + "text": "MemberRole", + "canonicalReference": "@onehop/js!MemberRole:interface" + }, + { + "kind": "Content", + "text": ">;\n leap_token: string | null;\n }>;\n pats: {\n create(name: string): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": ">;\n getAll(): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": "[]>;\n delete(id: `pat_${string}`): " + }, + { + "kind": "Reference", + "text": "Promise", + "canonicalReference": "!Promise:interface" + }, + { + "kind": "Content", + "text": ";\n };\n };\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "users", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 22 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "implementsTokenRanges": [] + }, + { + "kind": "Class", + "canonicalReference": "@onehop/js!HopAPIError:class", + "docComment": "/**\n * An error that occurred as a response from the Hop API.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare class HopAPIError extends " + }, + { + "kind": "Reference", + "text": "Error", + "canonicalReference": "!Error:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "isAbstract": false, + "name": "HopAPIError", + "preserveMemberOrder": false, + "members": [ + { + "kind": "Constructor", + "canonicalReference": "@onehop/js!HopAPIError:constructor(1)", + "docComment": "/**\n * Constructs a new instance of the `HopAPIError` class\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "constructor(request: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "!Request:interface" + }, + { + "kind": "Content", + "text": ", response: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ", data: " + }, + { + "kind": "Reference", + "text": "ErroredAPIResponse", + "canonicalReference": "@onehop/js!ErroredAPIResponse:type" + }, + { + "kind": "Content", + "text": ");" + } + ], + "releaseTag": "Public", + "isProtected": false, + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "request", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + }, + { + "parameterName": "response", + "parameterTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "isOptional": false + }, + { + "parameterName": "data", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + } + ] + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!HopAPIError#data:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly data: " + }, + { + "kind": "Reference", + "text": "ErroredAPIResponse", + "canonicalReference": "@onehop/js!ErroredAPIResponse:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "data", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!HopAPIError#request:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly request: " + }, + { + "kind": "Reference", + "text": "Request", + "canonicalReference": "!Request:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "request", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!HopAPIError#response:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly response: " + }, + { + "kind": "Reference", + "text": "Response", + "canonicalReference": "!Response:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "response", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + }, + { + "kind": "Property", + "canonicalReference": "@onehop/js!HopAPIError#status:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "readonly status: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": true, + "isOptional": false, + "releaseTag": "Public", + "name": "status", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isStatic": false, + "isProtected": false, + "isAbstract": false + } + ], + "extendsTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "implementsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!HopShDomain:type", + "docComment": "/**\n * A hop.sh domain (*.hop.sh)\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type HopShDomain = " + }, + { + "kind": "Content", + "text": "`${string}.hop.sh`" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "HopShDomain", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!ID_PREFIXES:var", + "docComment": "/**\n * An array of all IDs that can be used in the API\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ID_PREFIXES: " + }, + { + "kind": "Content", + "text": "readonly [{\n readonly prefix: \"user\";\n readonly description: \"Users\";\n}, {\n readonly prefix: \"project\";\n readonly description: \"Project\";\n}, {\n readonly prefix: \"pm\";\n readonly description: \"Project Members\";\n}, {\n readonly prefix: \"role\";\n readonly description: \"Roles\";\n}, {\n readonly prefix: \"pi\";\n readonly description: \"Project Invite\";\n}, {\n readonly prefix: \"ptk\";\n readonly description: \"Project token\";\n}, {\n readonly prefix: \"pat\";\n readonly description: \"User personal access token\";\n}, {\n readonly prefix: \"container\";\n readonly description: \"Ignite container\";\n}, {\n readonly prefix: \"pipe_room\";\n readonly description: \"Pipe room\";\n}, {\n readonly prefix: \"deployment\";\n readonly description: \"Ignite deployment\";\n}, {\n readonly prefix: \"bearer\";\n readonly description: \"Users bearer token\";\n}, {\n readonly prefix: \"ptkid\";\n readonly description: \"Project token ID\";\n}, {\n readonly prefix: \"secret\";\n readonly description: \"Project secret ID\";\n}, {\n readonly prefix: \"gateway\";\n readonly description: \"Gateway\";\n}, {\n readonly prefix: \"domain\";\n readonly description: \"Domain for a gateway\";\n}, {\n readonly prefix: \"leap_token\";\n readonly description: \"Token for connecting to leap as a client\";\n}, {\n readonly prefix: \"build\";\n readonly description: \"Build ID for build logs\";\n}, {\n readonly prefix: \"rollout\";\n readonly description: \"Rollout ID for rollouts.\";\n}, {\n readonly prefix: \"health_check\";\n readonly description: \"Health check ID for health checks.\";\n}, {\n readonly prefix: \"session\";\n readonly description: \"Session ID for sessions on your account.\";\n}]" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "ID_PREFIXES", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!id:function(1)", + "docComment": "/**\n * Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID.\n *\n * @param maybeId - Cast and assert that a string is an id\n *\n * @param prefix - Optionally an prefix or array of prefixes to check against\n *\n * @returns - The ID cast to the correct type\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function id(maybeId: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": ", prefix?: " + }, + { + "kind": "Content", + "text": "T | T[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "maybeId", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "prefix", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "id" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Id:type", + "docComment": "/**\n * A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Id = " + }, + { + "kind": "Content", + "text": "`${T}_${string}`" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Id", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!IdPrefixes:type", + "docComment": "/**\n * A union of all ID prefixes used within the API\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type IdPrefixes = " + }, + { + "kind": "Content", + "text": "typeof " + }, + { + "kind": "Reference", + "text": "ID_PREFIXES", + "canonicalReference": "@onehop/js!ID_PREFIXES:var" + }, + { + "kind": "Content", + "text": "[number]['prefix']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "IdPrefixes", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 4 + } + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Ignite:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace ignite " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Ignite", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!IgniteEndpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type IgniteEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments', {\n deployments: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments/:deployment_id/containers', {\n containers: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments/:deployment_id/containers', {\n container: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, {\n deployment_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>;\n container_id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'container'>;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments', {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n}, " + }, + { + "kind": "Reference", + "text": "CreateDeploymentConfig", + "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/ignite/deployments/:deployment_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/ignite/containers/:container_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": " | {\n container: " + }, + { + "kind": "Reference", + "text": "Container", + "canonicalReference": "@onehop/js!Container:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/containers/:container_id/logs', {\n logs: " + }, + { + "kind": "Reference", + "text": "ContainerLog", + "canonicalReference": "@onehop/js!ContainerLog:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments/search', {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments/:deployment_id', {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/ignite/containers/:container_id/state', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", {\n preferred_state: " + }, + { + "kind": "Reference", + "text": "ContainerState.STOPPED", + "canonicalReference": "@onehop/js!ContainerState.STOPPED:member" + }, + { + "kind": "Content", + "text": " | " + }, + { + "kind": "Reference", + "text": "ContainerState.RUNNING", + "canonicalReference": "@onehop/js!ContainerState.RUNNING:member" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/gateways/:gateway_id/domains', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ", {\n domain: string;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/gateways/:gateway_id', {\n gateway: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments/:deployment_id/gateways', {\n gateways: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments/:deployment_id/gateways', {\n gateway: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n type: " + }, + { + "kind": "Reference", + "text": "GatewayType", + "canonicalReference": "@onehop/js!GatewayType:enum" + }, + { + "kind": "Content", + "text": ";\n target_port: number;\n protocol: " + }, + { + "kind": "Reference", + "text": "Gateway", + "canonicalReference": "@onehop/js!Gateway:interface" + }, + { + "kind": "Content", + "text": "['protocol'];\n name: string;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id', {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n}, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentConfig", + "canonicalReference": "@onehop/js!DeploymentConfig:interface" + }, + { + "kind": "Content", + "text": ">> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', {\n deployment: " + }, + { + "kind": "Reference", + "text": "Deployment", + "canonicalReference": "@onehop/js!Deployment:interface" + }, + { + "kind": "Content", + "text": ";\n}, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "DeploymentMetaData", + "canonicalReference": "@onehop/js!DeploymentMetaData:interface" + }, + { + "kind": "Content", + "text": ">> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', {\n rollout: " + }, + { + "kind": "Reference", + "text": "DeploymentRollout", + "canonicalReference": "@onehop/js!DeploymentRollout:type" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/ignite/deployments/:deployment_id/health-check', {\n health_check: " + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ";\n}, " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", 'id'>> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/deployments/:deployment_id/storage', " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<'volume' | 'build_cache', " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<'provisioned_size' | 'used_size', number> | null>> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', {\n health_check: " + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ";\n}, " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "HealthCheck", + "canonicalReference": "@onehop/js!HealthCheck:type" + }, + { + "kind": "Content", + "text": ", 'id'>>> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/ignite/domains/:domain_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/ignite/domains/:domain_id', {\n domain: " + }, + { + "kind": "Reference", + "text": "Domain", + "canonicalReference": "@onehop/js!Domain:interface" + }, + { + "kind": "Content", + "text": ";\n}>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "IgniteEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 127 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Image_2:interface", + "docComment": "/**\n * Docker image config\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Image " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Image_2", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Image_2#auth:member", + "docComment": "/**\n * Authorization required for the registry to access this image This is not required if you use Hop's own registry.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "auth: " + }, + { + "kind": "Reference", + "text": "Auth", + "canonicalReference": "@onehop/js!Auth:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "auth", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Image_2#gh_repo:member", + "docComment": "/**\n * GitHub repo information (if applicable)\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "gh_repo: " + }, + { + "kind": "Reference", + "text": "ImageGHRepo", + "canonicalReference": "@onehop/js!ImageGHRepo:interface" + }, + { + "kind": "Content", + "text": " | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "gh_repo", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Image_2#name:member", + "docComment": "/**\n * The name of the docker image\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!ImageGHRepo:interface", + "docComment": "/**\n * GitHub repo partial used for images\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ImageGHRepo " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ImageGHRepo", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ImageGHRepo#branch:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "branch: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "branch", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ImageGHRepo#full_name:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "full_name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "full_name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ImageGHRepo#repo_id:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "repo_id: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "repo_id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!InternalHopDomain:type", + "docComment": "/**\n * A domain used with internal gateways (*.hop.sh)\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type InternalHopDomain = " + }, + { + "kind": "Content", + "text": "`${string}.hop`" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "InternalHopDomain", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!IS_BROWSER:var", + "docComment": "/**\n * If we are in the browser.\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "IS_BROWSER: " + }, + { + "kind": "Content", + "text": "boolean" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "IS_BROWSER", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!isValidByteString:function(1)", + "docComment": "/**\n * Validates if a string is a valid byte size string\n *\n * @param value - A string to validate if it is a valid byte size string\n *\n * @returns If the string is a valid byte size string\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function isValidByteString(value: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "value", + "canonicalReference": "@onehop/js!~value" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "value", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "isValidByteString" + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!kilobytes:function(1)", + "docComment": "/**\n * Converts a kilobyte size to a byte size string\n *\n * @param size - Kilobytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function kilobytes(size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "kilobytes" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!MakeOptional:type", + "docComment": "/**\n * Makes individual properties optional in a type\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type MakeOptional = " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Pick", + "canonicalReference": "!Pick:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "MakeOptional", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "K", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 9 + } + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!megabytes:function(1)", + "docComment": "/**\n * Converts a megabyte size to a byte size string\n *\n * @param size - Megabytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function megabytes(size: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "megabytes" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Member:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Member = " + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@onehop/js!User:interface" + }, + { + "kind": "Content", + "text": ", 'email' | 'id'> & {\n id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'pm'>;\n role: " + }, + { + "kind": "Reference", + "text": "MemberRole", + "canonicalReference": "@onehop/js!MemberRole:interface" + }, + { + "kind": "Content", + "text": ";\n mfa_enabled: boolean;\n joined_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Member", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 11 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!MemberRole:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface MemberRole " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "MemberRole", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!MemberRole#flags:member", + "docComment": "/**\n * The flags for this role\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "flags: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!MemberRole#id:member", + "docComment": "/**\n * The ID of the role\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'role'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!MemberRole#name:member", + "docComment": "/**\n * The name of the role\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Method:type", + "docComment": "/**\n * All methods the Hop API accepts\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Method = " + }, + { + "kind": "Content", + "text": "'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Method", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!NixPlan:interface", + "docComment": "/**\n * The validated nixpacks plan for this build\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface NixPlan " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "NixPlan", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!NixPlan#cmds:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "cmds: " + }, + { + "kind": "Content", + "text": "{\n build: string | null;\n start: string | null;\n install: string | null;\n }" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "cmds", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!NixPlan#language:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "language: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "language", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!NixPlan#pkgs:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "pkgs: " + }, + { + "kind": "Content", + "text": "string[] | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "pkgs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!parseSize:function(1)", + "docComment": "/**\n * Parses a byte size string into bytes\n *\n * @param size - The size of anything in gigabytes, megabytes, kilobytes or bytes\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function parseSize(size: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "size", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "parseSize" + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!PartialAPIOptions:type", + "docComment": "/**\n * Partial options for the Hop client\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type PartialAPIOptions = " + }, + { + "kind": "Reference", + "text": "Partial", + "canonicalReference": "!Partial:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Omit", + "canonicalReference": "!Omit:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "APIClientOptions", + "canonicalReference": "@onehop/js!APIClientOptions:interface" + }, + { + "kind": "Content", + "text": ", 'authentication'>> & " + }, + { + "kind": "Reference", + "text": "Pick", + "canonicalReference": "!Pick:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "APIClientOptions", + "canonicalReference": "@onehop/js!APIClientOptions:interface" + }, + { + "kind": "Content", + "text": ", 'authentication'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "PartialAPIOptions", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 11 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!PAT:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface PAT " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "PAT", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!PAT#created_at:member", + "docComment": "/**\n * The date the pat was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!PAT#id:member", + "docComment": "/**\n * The ID of the pat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'pat'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!PAT#name:member", + "docComment": "/**\n * The name of the pat\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!PathsFor:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type PathsFor = " + }, + { + "kind": "Reference", + "text": "Extract", + "canonicalReference": "!Extract:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Endpoints", + "canonicalReference": "@onehop/js!Endpoints:type" + }, + { + "kind": "Content", + "text": ", {\n method: M;\n}>['path']" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "PathsFor", + "typeParameters": [ + { + "typeParameterName": "M", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!permissions:var", + "docComment": "/**\n * Permission utility functions\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "permissions: " + }, + { + "kind": "Content", + "text": "{\n add(value: bigint, flag: bigint): bigint;\n test(value: bigint, flag: bigint): boolean;\n subtract(value: bigint, flag: bigint): bigint;\n}" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "permissions", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!permissionsMap:var", + "docComment": "/**\n * Individual bitwise permissions\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "permissionsMap: " + }, + { + "kind": "Content", + "text": "{\n add_member: bigint;\n remove_member: bigint;\n get_project_members: bigint;\n delete_project: bigint;\n delete_deployment: bigint;\n delete_container: bigint;\n update_container_state: bigint;\n read_deployments: bigint;\n create_deployment: bigint;\n create_container: bigint;\n update_container_config: bigint;\n create_room: bigint;\n read_room: bigint;\n delete_room: bigint;\n create_room_producer: bigint;\n create_project_token: bigint;\n delete_project_token: bigint;\n read_project_tokens: bigint;\n read_container_logs: bigint;\n create_project_secret: bigint;\n read_project_secrets: bigint;\n delete_project_secret: bigint;\n get_registry_images: bigint;\n create_channel_token: bigint;\n create_gateway: bigint;\n add_domain: bigint;\n delete_channels: bigint;\n update_channel_state: bigint;\n read_channels: bigint;\n publish_channel_messages: bigint;\n manage_channel_subscribers: bigint;\n delete_domain: bigint;\n delete_gateway: bigint;\n get_internal_domain: bigint;\n create_leap_token: bigint;\n read_leap_tokens: bigint;\n update_leap_token: bigint;\n message_token: bigint;\n create_channel: bigint;\n rollout: bigint;\n request_quota_increase: bigint;\n read_billing: bigint;\n read_gateways: bigint;\n delete_registry_images: bigint;\n container_ssh: bigint;\n tunnel_deployment: bigint;\n}" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "permissionsMap", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Pipe:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace pipe " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Pipe", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!PipeEndpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type PipeEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/pipe/rooms', {\n rooms: " + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/pipe/rooms', {\n room: " + }, + { + "kind": "Reference", + "text": "Room", + "canonicalReference": "@onehop/js!Room:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n name: string;\n ingest_protocol: 'rtmp' | 'rtp';\n delivery_protocols: " + }, + { + "kind": "Reference", + "text": "DeliveryProtocol", + "canonicalReference": "@onehop/js!DeliveryProtocol:type" + }, + { + "kind": "Content", + "text": "[];\n region: " + }, + { + "kind": "Reference", + "text": "Regions", + "canonicalReference": "@onehop/js!Regions:enum" + }, + { + "kind": "Content", + "text": ";\n ephemeral: boolean;\n llhls_config?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n } | undefined;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/pipe/rooms/:room_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "PipeEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 17 + } + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION:enum", + "docComment": "/**\n * A list of all permissions and their representative names\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum PROJECT_PERMISSION " + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "PROJECT_PERMISSION", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ADD_DOMAIN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ADD_DOMAIN = " + }, + { + "kind": "Content", + "text": "\"add_domain\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ADD_DOMAIN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ADD_MEMBER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ADD_MEMBER = " + }, + { + "kind": "Content", + "text": "\"add_member\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ADD_MEMBER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CONTAINER_SSH:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CONTAINER_SSH = " + }, + { + "kind": "Content", + "text": "\"container_ssh\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CONTAINER_SSH" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CHANNEL:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_CHANNEL = " + }, + { + "kind": "Content", + "text": "\"create_channel\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_CHANNEL" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CHANNEL_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_CHANNEL_TOKEN = " + }, + { + "kind": "Content", + "text": "\"create_channel_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_CHANNEL_TOKEN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CONTAINER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_CONTAINER = " + }, + { + "kind": "Content", + "text": "\"create_container\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_CONTAINER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_DEPLOYMENT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_DEPLOYMENT = " + }, + { + "kind": "Content", + "text": "\"create_deployment\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_DEPLOYMENT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_GATEWAY:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_GATEWAY = " + }, + { + "kind": "Content", + "text": "\"create_gateway\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_GATEWAY" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_LEAP_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_LEAP_TOKEN = " + }, + { + "kind": "Content", + "text": "\"create_leap_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_LEAP_TOKEN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_PROJECT_SECRET:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_PROJECT_SECRET = " + }, + { + "kind": "Content", + "text": "\"create_project_secret\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_PROJECT_SECRET" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_PROJECT_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_PROJECT_TOKEN = " + }, + { + "kind": "Content", + "text": "\"create_project_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_PROJECT_TOKEN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_ROOM:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_ROOM = " + }, + { + "kind": "Content", + "text": "\"create_room\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_ROOM" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_ROOM_PRODUCER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "CREATE_ROOM_PRODUCER = " + }, + { + "kind": "Content", + "text": "\"create_room_producer\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "CREATE_ROOM_PRODUCER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_CHANNELS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_CHANNELS = " + }, + { + "kind": "Content", + "text": "\"delete_channels\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_CHANNELS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_CONTAINER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_CONTAINER = " + }, + { + "kind": "Content", + "text": "\"delete_container\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_CONTAINER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_DEPLOYMENT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_DEPLOYMENT = " + }, + { + "kind": "Content", + "text": "\"delete_deployment\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_DEPLOYMENT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_DOMAIN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_DOMAIN = " + }, + { + "kind": "Content", + "text": "\"delete_domain\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_DOMAIN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_GATEWAY:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_GATEWAY = " + }, + { + "kind": "Content", + "text": "\"delete_gateway\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_GATEWAY" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_PROJECT = " + }, + { + "kind": "Content", + "text": "\"delete_project\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_PROJECT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT_SECRET:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_PROJECT_SECRET = " + }, + { + "kind": "Content", + "text": "\"delete_project_secret\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_PROJECT_SECRET" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_PROJECT_TOKEN = " + }, + { + "kind": "Content", + "text": "\"delete_project_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_PROJECT_TOKEN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_REGISTRY_IMAGES:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_REGISTRY_IMAGES = " + }, + { + "kind": "Content", + "text": "\"delete_registry_images\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_REGISTRY_IMAGES" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_ROOM:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "DELETE_ROOM = " + }, + { + "kind": "Content", + "text": "\"delete_room\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "DELETE_ROOM" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_INTERNAL_DOMAIN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "GET_INTERNAL_DOMAIN = " + }, + { + "kind": "Content", + "text": "\"get_internal_domain\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "GET_INTERNAL_DOMAIN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_PROJECT_MEMBERS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "GET_PROJECT_MEMBERS = " + }, + { + "kind": "Content", + "text": "\"get_project_members\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "GET_PROJECT_MEMBERS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_REGISTRY_IMAGES:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "GET_REGISTRY_IMAGES = " + }, + { + "kind": "Content", + "text": "\"get_registry_images\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "GET_REGISTRY_IMAGES" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.MANAGE_CHANNEL_SUBSCRIBERS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "MANAGE_CHANNEL_SUBSCRIBERS = " + }, + { + "kind": "Content", + "text": "\"manage_channel_subscribers\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "MANAGE_CHANNEL_SUBSCRIBERS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.MESSAGE_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "MESSAGE_TOKEN = " + }, + { + "kind": "Content", + "text": "\"message_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "MESSAGE_TOKEN" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.PUBLISH_CHANNEL_MESSAGES:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PUBLISH_CHANNEL_MESSAGES = " + }, + { + "kind": "Content", + "text": "\"publish_channel_messages\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PUBLISH_CHANNEL_MESSAGES" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_BILLING:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_BILLING = " + }, + { + "kind": "Content", + "text": "\"read_billing\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_BILLING" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_CHANNELS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_CHANNELS = " + }, + { + "kind": "Content", + "text": "\"read_channels\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_CHANNELS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_CONTAINER_LOGS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_CONTAINER_LOGS = " + }, + { + "kind": "Content", + "text": "\"read_container_logs\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_CONTAINER_LOGS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_DEPLOYMENTS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_DEPLOYMENTS = " + }, + { + "kind": "Content", + "text": "\"read_deployments\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_DEPLOYMENTS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_GATEWAYS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_GATEWAYS = " + }, + { + "kind": "Content", + "text": "\"read_gateways\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_GATEWAYS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_LEAP_TOKENS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_LEAP_TOKENS = " + }, + { + "kind": "Content", + "text": "\"read_leap_tokens\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_LEAP_TOKENS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_PROJECT_SECRETS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_PROJECT_SECRETS = " + }, + { + "kind": "Content", + "text": "\"read_project_secrets\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_PROJECT_SECRETS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_PROJECT_TOKENS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_PROJECT_TOKENS = " + }, + { + "kind": "Content", + "text": "\"read_project_tokens\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_PROJECT_TOKENS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_ROOM:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "READ_ROOM = " + }, + { + "kind": "Content", + "text": "\"read_room\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "READ_ROOM" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.REMOVE_MEMBER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "REMOVE_MEMBER = " + }, + { + "kind": "Content", + "text": "\"remove_member\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "REMOVE_MEMBER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.REQUEST_QUOTA_INCREASE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "REQUEST_QUOTA_INCREASE = " + }, + { + "kind": "Content", + "text": "\"request_quota_increase\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "REQUEST_QUOTA_INCREASE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ROLLOUT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ROLLOUT = " + }, + { + "kind": "Content", + "text": "\"rollout\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ROLLOUT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.TUNNEL_DEPLOYMENT:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "TUNNEL_DEPLOYMENT = " + }, + { + "kind": "Content", + "text": "\"tunnel_deployment\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "TUNNEL_DEPLOYMENT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CHANNEL_STATE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UPDATE_CHANNEL_STATE = " + }, + { + "kind": "Content", + "text": "\"update_channel_state\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "UPDATE_CHANNEL_STATE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CONTAINER_CONFIG:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UPDATE_CONTAINER_CONFIG = " + }, + { + "kind": "Content", + "text": "\"update_container_config\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "UPDATE_CONTAINER_CONFIG" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CONTAINER_STATE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UPDATE_CONTAINER_STATE = " + }, + { + "kind": "Content", + "text": "\"update_container_state\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "UPDATE_CONTAINER_STATE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_LEAP_TOKEN:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "UPDATE_LEAP_TOKEN = " + }, + { + "kind": "Content", + "text": "\"update_leap_token\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "UPDATE_LEAP_TOKEN" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Project:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Project " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Project", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#created_at:member", + "docComment": "/**\n * The time this project was created at\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#default_quotas:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "default_quotas: " + }, + { + "kind": "Reference", + "text": "DefaultQuotas", + "canonicalReference": "@onehop/js!DefaultQuotas:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "default_quotas", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#icon:member", + "docComment": "/**\n * An icon for this project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "icon: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "icon", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#id:member", + "docComment": "/**\n * The ID of the project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'project'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#name:member", + "docComment": "/**\n * The name of the project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#namespace:member", + "docComment": "/**\n * The registry namespace for this project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "namespace: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "namespace", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#quota_overrides:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "quota_overrides: " + }, + { + "kind": "Reference", + "text": "QuotaOverrides", + "canonicalReference": "@onehop/js!QuotaOverrides:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "quota_overrides", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#quota_usage:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "quota_usage: " + }, + { + "kind": "Reference", + "text": "QuotaUsage", + "canonicalReference": "@onehop/js!QuotaUsage:interface" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "quota_usage", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#tier:member", + "docComment": "/**\n * The tier this project is\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "tier: " + }, + { + "kind": "Reference", + "text": "ProjectTier", + "canonicalReference": "@onehop/js!ProjectTier:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "tier", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Project#type:member", + "docComment": "/**\n * The type of this project. Either regular or personal\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "ProjectType", + "canonicalReference": "@onehop/js!ProjectType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Projects:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace projects " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Projects", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!ProjectsEndpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type ProjectsEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/projects/@this/tokens/:project_token_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/:project_id/members/@me', {\n project_member: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": ";\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/:project_id/tokens', {\n project_tokens: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/@this/tokens', {\n project_tokens: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/:project_id/members', {\n members: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/@this/members', {\n members: " + }, + { + "kind": "Reference", + "text": "Member", + "canonicalReference": "@onehop/js!Member:type" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/projects/:project_id/tokens', {\n project_token: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n };\n}, {\n flags: number;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/projects/@this/tokens', {\n project_token: " + }, + { + "kind": "Reference", + "text": "ProjectToken", + "canonicalReference": "@onehop/js!ProjectToken:interface" + }, + { + "kind": "Content", + "text": " & {\n project: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": ";\n };\n}, {\n flags: number;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/projects/:project_id/secrets/:name', {\n secret: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": ";\n}, string> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'PUT', '/v1/projects/@this/secrets/:name', {\n secret: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": ";\n}, string> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/:project_id/secrets', {\n secrets: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/projects/@this/secrets', {\n secrets: " + }, + { + "kind": "Reference", + "text": "Secret", + "canonicalReference": "@onehop/js!Secret:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/projects/@this/secrets/:secret_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ProjectsEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 65 + } + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!ProjectTier:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum ProjectTier " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ProjectTier", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ProjectTier.FREE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FREE = " + }, + { + "kind": "Content", + "text": "\"free\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FREE" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ProjectTier.PAID:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PAID = " + }, + { + "kind": "Content", + "text": "\"paid\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PAID" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!ProjectToken:interface", + "docComment": "/**\n * A project token for a project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ProjectToken " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ProjectToken", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ProjectToken#created_at:member", + "docComment": "/**\n * The time this project token was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ProjectToken#flags:member", + "docComment": "/**\n * Permissions and flags that this project token can perform\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "flags: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "flags", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ProjectToken#id:member", + "docComment": "/**\n * The Id of the project token\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'ptkid'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ProjectToken#token:member", + "docComment": "/**\n * The key value. This will likely have half of the key obfuscated\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "token: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'ptk'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "token", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!ProjectType:enum", + "docComment": "/**\n * Type of a project\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum ProjectType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ProjectType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ProjectType.PERSONAL:member", + "docComment": "/**\n * A personal project are created when you register an account\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PERSONAL = " + }, + { + "kind": "Content", + "text": "\"personal\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PERSONAL" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!ProjectType.REGULAR:member", + "docComment": "/**\n * A standard project type\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "REGULAR = " + }, + { + "kind": "Content", + "text": "\"regular\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "REGULAR" + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Query:type", + "docComment": "/**\n * Generate a query object that includes typed URL params\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Query = " + }, + { + "kind": "Reference", + "text": "ExtractRouteParams", + "canonicalReference": "@onehop/js!ExtractRouteParams:type" + }, + { + "kind": "Content", + "text": " & " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "releaseTag": "Public", + "name": "Query", + "typeParameters": [ + { + "typeParameterName": "Path", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 7 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!QuotaOverrides:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface QuotaOverrides " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "QuotaOverrides", + "preserveMemberOrder": false, + "members": [], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!QuotaUsage:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface QuotaUsage " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "QuotaUsage", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!QuotaUsage#ram:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ram: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ram", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!QuotaUsage#vcpu:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "vcpu: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "vcpu", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!QuotaUsage#volume:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "volume: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "volume", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!Regions:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum Regions " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Regions", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!Regions.US_EAST_1:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "US_EAST_1 = " + }, + { + "kind": "Content", + "text": "\"us-east-1\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "US_EAST_1" + } + ] + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Registry:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace registry " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Registry", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!RegistryEndpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type RegistryEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/registry/images/:image', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": "> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/registry/images', {\n images: string[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/registry/images/:image/manifests', {\n manifests: {\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[];\n}>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "RegistryEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 9 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Resources:interface", + "docComment": "/**\n * Resources allocated to a deployment\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Resources " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Resources", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Resources#ram:member", + "docComment": "/**\n * Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ram: " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ram", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Resources#vcpu:member", + "docComment": "/**\n * Amount of vCPU to allocate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vcpu: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "vcpu", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Resources#vgpu:member", + "docComment": "/**\n * vGPUs to allocate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "vgpu: " + }, + { + "kind": "Reference", + "text": "Vgpu", + "canonicalReference": "@onehop/js!Vgpu:interface" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "vgpu", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!RestartPolicy:enum", + "docComment": "/**\n * Restart policy for deployments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum RestartPolicy " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "RestartPolicy", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RestartPolicy.ALWAYS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ALWAYS = " + }, + { + "kind": "Content", + "text": "\"always\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ALWAYS" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RestartPolicy.NEVER:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "NEVER = " + }, + { + "kind": "Content", + "text": "\"never\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "NEVER" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RestartPolicy.ON_FAILURE:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "ON_FAILURE = " + }, + { + "kind": "Content", + "text": "\"on-failure\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "ON_FAILURE" + } + ] + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!roles:var", + "docComment": "/**\n * Bitwise role flags that a user can be as part of a project\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "roles: " + }, + { + "kind": "Content", + "text": "{\n viewer: bigint;\n editor: bigint;\n admin: bigint;\n owner: bigint;\n}" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "roles", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!RolloutState:enum", + "docComment": "/**\n * Rollout state for deployments\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum RolloutState " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "RolloutState", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RolloutState.FAILED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FAILED = " + }, + { + "kind": "Content", + "text": "\"failed\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FAILED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RolloutState.FINISHED:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "FINISHED = " + }, + { + "kind": "Content", + "text": "\"finished\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "FINISHED" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RolloutState.PENDING:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "PENDING = " + }, + { + "kind": "Content", + "text": "\"pending\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PENDING" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Room:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Room " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Room", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#created_at:member", + "docComment": "/**\n * The unix timestamp of when this stream was created\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#delivery_protocols:member", + "docComment": "/**\n * Protocols that are supported by this room to the client\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "delivery_protocols: " + }, + { + "kind": "Reference", + "text": "DeliveryProtocol", + "canonicalReference": "@onehop/js!DeliveryProtocol:type" + }, + { + "kind": "Content", + "text": "[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "delivery_protocols", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#id:member", + "docComment": "/**\n * The ID of this stream\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'pipe_room'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#ingest_endpoint:member", + "docComment": "/**\n * The URL that you can stream to\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ingest_endpoint: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ingest_endpoint", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#ingest_protocol:member", + "docComment": "/**\n * Protocol you can stream with\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ingest_protocol: " + }, + { + "kind": "Content", + "text": "'rtmp'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ingest_protocol", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#ingest_region:member", + "docComment": "/**\n * The region that the stream url is located in\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "ingest_region: " + }, + { + "kind": "Reference", + "text": "Regions", + "canonicalReference": "@onehop/js!Regions:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "ingest_region", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#join_token:member", + "docComment": "/**\n * A join token to subscribe into this room\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "join_token: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "join_token", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#name:member", + "docComment": "/**\n * The name of this room\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Room#state:member", + "docComment": "/**\n * The state of the stream currently\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "state: " + }, + { + "kind": "Content", + "text": "'live' | 'offline'" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "state", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!RuntimeType:enum", + "docComment": "/**\n * Runtime types are used to describe the type of a deployment or container\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum RuntimeType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "RuntimeType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RuntimeType.EPHEMERAL:member", + "docComment": "/**\n * Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "EPHEMERAL = " + }, + { + "kind": "Content", + "text": "\"ephemeral\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "EPHEMERAL" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RuntimeType.PERSISTENT:member", + "docComment": "/**\n * Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "PERSISTENT = " + }, + { + "kind": "Content", + "text": "\"persistent\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "PERSISTENT" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!RuntimeType.STATEFUL:member", + "docComment": "/**\n * Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached.\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "STATEFUL = " + }, + { + "kind": "Content", + "text": "\"stateful\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "STATEFUL" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Secret:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Secret " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Secret", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Secret#created_at:member", + "docComment": "/**\n * The time this secret was created at\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "created_at: " + }, + { + "kind": "Reference", + "text": "Timestamp", + "canonicalReference": "@onehop/js!Timestamp:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "created_at", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Secret#digest:member", + "docComment": "/**\n * A digest hash of the secret\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "digest: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "digest", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Secret#id:member", + "docComment": "/**\n * The ID of the secret\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'secret'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Secret#in_use_by:member", + "docComment": "/**\n * Deployment IDs this secret is used by\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "in_use_by: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'deployment'>[]" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "in_use_by", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Secret#name:member", + "docComment": "/**\n * The name of the secret\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!SelfUser:interface", + "docComment": "/**\n * Self User Object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface SelfUser extends " + }, + { + "kind": "Reference", + "text": "User", + "canonicalReference": "@onehop/js!User:interface" + }, + { + "kind": "Content", + "text": " " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "SelfUser", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!SelfUser#admin:member", + "docComment": "/**\n * If user is an admin\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "admin: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "admin", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!SelfUser#email_verified:member", + "docComment": "/**\n * If user has verified their email\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "email_verified: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "email_verified", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!SelfUser#mfa_enabled:member", + "docComment": "/**\n * If user has enabled mfa authentication\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mfa_enabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "mfa_enabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!SelfUser#totp_enabled:member", + "docComment": "/**\n * If user has enabled totp authentication\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "totp_enabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "totp_enabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!SelfUser#webauthn_enabled:member", + "docComment": "/**\n * If user has enabled webauthn authentication\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "webauthn_enabled: " + }, + { + "kind": "Content", + "text": "boolean" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "webauthn_enabled", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [ + { + "startIndex": 1, + "endIndex": 2 + } + ] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!State:type", + "docComment": "/**\n * Generic state type of a channel\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type State = " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "State", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!SuccessfulAPIResponse:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type SuccessfulAPIResponse = " + }, + { + "kind": "Content", + "text": "{\n success: true;\n data: T;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "SuccessfulAPIResponse", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!SUPPORTS_INTL:var", + "docComment": "/**\n * If this runtiem supports the Intl API\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "SUPPORTS_INTL: " + }, + { + "kind": "Content", + "text": "boolean" + } + ], + "fileUrlPath": "dist/index.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "SUPPORTS_INTL", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Tag:type", + "docComment": "/**\n * Tag a type to make it unique\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Tag = " + }, + { + "kind": "Content", + "text": "T & {\n ___tag: Name;\n}" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Tag", + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 0, + "endIndex": 0 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + }, + { + "typeParameterName": "Name", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 0, + "endIndex": 0 + } + } + ], + "typeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!Timestamp:type", + "docComment": "/**\n * An ISO 8601 date strings\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type Timestamp = " + }, + { + "kind": "Reference", + "text": "Tag", + "canonicalReference": "@onehop/js!Tag:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Timestamp", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "Variable", + "canonicalReference": "@onehop/js!units:var", + "docComment": "/**\n * @deprecated\n *\n * use `byteUnits` instead\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "units: " + }, + { + "kind": "Content", + "text": "readonly [\"GB\", \"MB\", \"KB\", \"B\"]" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "isReadonly": true, + "releaseTag": "Public", + "name": "units", + "variableTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!User:interface", + "docComment": "/**\n * A user object\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface User " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "User", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!User#email:member", + "docComment": "/**\n * The email of the user\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "email: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "email", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!User#id:member", + "docComment": "/**\n * The ID of the user\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "id: " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'user'>" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "id", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 3 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!User#name:member", + "docComment": "/**\n * The name of the user. Think of this as a display name\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "name: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "name", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!User#username:member", + "docComment": "/**\n * A unqiue username for the user\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "username: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "username", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "TypeAlias", + "canonicalReference": "@onehop/js!UserEndpoints:type", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "type UserEndpoints = " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/users/@me', {\n projects: " + }, + { + "kind": "Reference", + "text": "Project", + "canonicalReference": "@onehop/js!Project:interface" + }, + { + "kind": "Content", + "text": "[];\n user: " + }, + { + "kind": "Reference", + "text": "SelfUser", + "canonicalReference": "@onehop/js!SelfUser:interface" + }, + { + "kind": "Content", + "text": ";\n project_member_role_map: " + }, + { + "kind": "Reference", + "text": "Record", + "canonicalReference": "!Record:type" + }, + { + "kind": "Content", + "text": "<" + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "<'project'>, " + }, + { + "kind": "Reference", + "text": "MemberRole", + "canonicalReference": "@onehop/js!MemberRole:interface" + }, + { + "kind": "Content", + "text": ">;\n leap_token: string | null;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'POST', '/v1/users/@me/pats', {\n pat: " + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": ";\n}, {\n name: string;\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'GET', '/v1/users/@me/pats', {\n pats: " + }, + { + "kind": "Reference", + "text": "PAT", + "canonicalReference": "@onehop/js!PAT:interface" + }, + { + "kind": "Content", + "text": "[];\n}> | " + }, + { + "kind": "Reference", + "text": "Endpoint", + "canonicalReference": "@onehop/js!Endpoint:type" + }, + { + "kind": "Content", + "text": "<'DELETE', '/v1/users/@me/pats/:pat_id', " + }, + { + "kind": "Reference", + "text": "Empty", + "canonicalReference": "@onehop/js!Empty:type" + }, + { + "kind": "Content", + "text": ">" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "UserEndpoints", + "typeTokenRange": { + "startIndex": 1, + "endIndex": 25 + } + }, + { + "kind": "Namespace", + "canonicalReference": "@onehop/js!Users:namespace", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare namespace users " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Users", + "preserveMemberOrder": false, + "members": [] + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!validateAPIAuthentication:function(1)", + "docComment": "/**\n * Validates that an authentication prefix is valid\n *\n * @param auth - The prefix to validate\n *\n * @returns `true` if the prefix is valid, `false` otherwise\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function validateAPIAuthentication(auth: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "auth", + "canonicalReference": "@onehop/js!~auth" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "APIAuthenticationPrefix", + "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/index.d.ts", + "returnTypeTokenRange": { + "startIndex": 3, + "endIndex": 6 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "auth", + "parameterTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "isOptional": false + } + ], + "name": "validateAPIAuthentication" + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!validateId:function(1)", + "docComment": "/**\n * Validates that a string is a valid ID\n *\n * @param maybeId - A string that might be an id\n *\n * @param prefix - Optionally an id prefix to check against\n *\n * @returns true if the string is an id\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function validateId(maybeId: " + }, + { + "kind": "Content", + "text": "string | undefined | null" + }, + { + "kind": "Content", + "text": ", prefix?: " + }, + { + "kind": "Content", + "text": "T | T[]" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "maybeId", + "canonicalReference": "@onehop/js!~maybeId" + }, + { + "kind": "Content", + "text": " is " + }, + { + "kind": "Reference", + "text": "Id", + "canonicalReference": "@onehop/js!Id:type" + }, + { + "kind": "Content", + "text": "" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 13 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "maybeId", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "prefix", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "validateId" + }, + { + "kind": "Function", + "canonicalReference": "@onehop/js!validateIdPrefix:function(1)", + "docComment": "/**\n * Checks if a string is a valid Hop ID prefix\n *\n * @param prefix - A string that is a potential prefix\n *\n * @param expect - An expected prefix to check against\n *\n * @returns - Whether the prefix is valid\n *\n * @public\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare function validateIdPrefix(prefix: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ", expect?: " + }, + { + "kind": "Content", + "text": "T" + }, + { + "kind": "Content", + "text": "): " + }, + { + "kind": "Reference", + "text": "prefix", + "canonicalReference": "@onehop/js!~prefix" + }, + { + "kind": "Content", + "text": " is T" + }, + { + "kind": "Content", + "text": ";" + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "returnTypeTokenRange": { + "startIndex": 9, + "endIndex": 11 + }, + "releaseTag": "Public", + "overloadIndex": 1, + "parameters": [ + { + "parameterName": "prefix", + "parameterTypeTokenRange": { + "startIndex": 5, + "endIndex": 6 + }, + "isOptional": false + }, + { + "parameterName": "expect", + "parameterTypeTokenRange": { + "startIndex": 7, + "endIndex": 8 + }, + "isOptional": true + } + ], + "typeParameters": [ + { + "typeParameterName": "T", + "constraintTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "defaultTypeTokenRange": { + "startIndex": 3, + "endIndex": 4 + } + } + ], + "name": "validateIdPrefix" + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!ValidationFailure:interface", + "docComment": "/**\n * Why the uploaded build content was rejected\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface ValidationFailure " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "ValidationFailure", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ValidationFailure#help_link:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "help_link: " + }, + { + "kind": "Content", + "text": "string | null" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "help_link", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!ValidationFailure#reason:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "reason: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "reason", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!Vgpu:interface", + "docComment": "/**\n * Virtual GPU config\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface Vgpu " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "Vgpu", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Vgpu#count:member", + "docComment": "/**\n * The amount of vGPUs to allocate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "count: " + }, + { + "kind": "Content", + "text": "number" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "count", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!Vgpu#type:member", + "docComment": "/**\n * The type of vGPU to allocate\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "type: " + }, + { + "kind": "Reference", + "text": "VgpuType", + "canonicalReference": "@onehop/js!VgpuType:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "type", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!VgpuType:enum", + "docComment": "/**\n * Types for supported GPU\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum VgpuType " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "VgpuType", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!VgpuType.A400:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "A400 = " + }, + { + "kind": "Content", + "text": "\"a400\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "A400" + } + ] + }, + { + "kind": "Interface", + "canonicalReference": "@onehop/js!VolumeDefinition:interface", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "interface VolumeDefinition " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "VolumeDefinition", + "preserveMemberOrder": false, + "members": [ + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!VolumeDefinition#fs:member", + "docComment": "/**\n * The format of the volume\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "fs: " + }, + { + "kind": "Reference", + "text": "VolumeFormat", + "canonicalReference": "@onehop/js!VolumeFormat:enum" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "fs", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!VolumeDefinition#mount_path:member", + "docComment": "/**\n * The mount point of the volume\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "mount_path: " + }, + { + "kind": "Content", + "text": "string" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "mount_path", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + }, + { + "kind": "PropertySignature", + "canonicalReference": "@onehop/js!VolumeDefinition#size:member", + "docComment": "/**\n * The size of the volume in bytes\n */\n", + "excerptTokens": [ + { + "kind": "Content", + "text": "size: " + }, + { + "kind": "Reference", + "text": "ByteSizeString", + "canonicalReference": "@onehop/js!ByteSizeString:type" + }, + { + "kind": "Content", + "text": ";" + } + ], + "isReadonly": false, + "isOptional": false, + "releaseTag": "Public", + "name": "size", + "propertyTypeTokenRange": { + "startIndex": 1, + "endIndex": 2 + } + } + ], + "extendsTokenRanges": [] + }, + { + "kind": "Enum", + "canonicalReference": "@onehop/js!VolumeFormat:enum", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "declare enum VolumeFormat " + } + ], + "fileUrlPath": "dist/channels-f16e881f.d.ts", + "releaseTag": "Public", + "name": "VolumeFormat", + "preserveMemberOrder": false, + "members": [ + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!VolumeFormat.EXT4:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "EXT4 = " + }, + { + "kind": "Content", + "text": "\"ext4\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "EXT4" + }, + { + "kind": "EnumMember", + "canonicalReference": "@onehop/js!VolumeFormat.XFS:member", + "docComment": "", + "excerptTokens": [ + { + "kind": "Content", + "text": "XFS = " + }, + { + "kind": "Content", + "text": "\"xfs\"" + } + ], + "initializerTokenRange": { + "startIndex": 1, + "endIndex": 2 + }, + "releaseTag": "Public", + "name": "XFS" + } + ] + } + ] + } + ] +} diff --git a/.temp/js.api.md b/.temp/js.api.md new file mode 100644 index 00000000..c638516d --- /dev/null +++ b/.temp/js.api.md @@ -0,0 +1,1953 @@ +## API Report File for "@onehop/js" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +// @public +export type AnyId = Id; + +// @public (undocumented) +export namespace API { + { + channels as Channels, + ignite as Ignite, + pipe as Pipe, + projects as Projects, + registry as Registry, + users as Users, + }; +} + +// @public +export type APIAuthentication = Id; + +// @public +export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; + +// @public +export class APIClient { + constructor(options: APIClientOptions); + // (undocumented) + readonly authType: APIAuthenticationPrefix; + // (undocumented) + delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }> | Extract, { + path: Path; + method: 'DELETE'; + }>)["res"]>; + // (undocumented) + get>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; + leap_token: string | null; + }>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract | null>>, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }> | Extract, { + path: Path; + method: 'GET'; + }>)["res"]>; + // (undocumented) + static getAuthType(auth: APIAuthentication): APIAuthenticationPrefix; + // (undocumented) + patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PATCH'; + }> | Extract, { + path: Path; + method: 'PATCH'; + }> | Extract>, { + path: Path; + method: 'PATCH'; + }> | Extract>, { + path: Path; + method: 'PATCH'; + }> | Extract>>, { + path: Path; + method: 'PATCH'; + }>)["res"]>; + // (undocumented) + post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract | null; + }>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }> | Extract>, { + path: Path; + method: 'POST'; + }> | Extract, { + path: Path; + method: 'POST'; + }>)["res"]>; + // (undocumented) + put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract | null; + }>, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }> | Extract, { + path: Path; + method: 'PUT'; + }>)["res"]>; + // (undocumented) + raw(request: Request): Promise; + // (undocumented) + readonly url: (path: Path, query: Query) => string; +} + +// @public +export interface APIClientOptions { + // (undocumented) + readonly authentication: APIAuthentication; + // (undocumented) + readonly baseUrl: string; +} + +// @public (undocumented) +export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; + +// @public +export function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; + +// @public +export interface Auth { + // (undocumented) + password: string; + // (undocumented) + username: string; +} + +// @public +export const BROAD_PERMISSIONS_MAP: { + MANAGE_MEMBERS: bigint; + MANAGE_PROJECT_TOKENS: bigint; + MANAGE_DEPLOYMENTS: bigint; + MANAGE_PIPE: bigint; + MANAGE_SECRETS: bigint; + MANAGE_CHANNELS: bigint; + MANAGE_REGISTRY: bigint; + READ_ONLY: bigint; + MANAGE_QUOTAS: bigint; + MANAGE_ROLLOUTS: bigint; + MANAGE_BILLING: bigint; +}; + +// @public (undocumented) +export interface Build { + created_at?: Timestamp; + deployment_id: Id<'deployment'>; + digest: string | null; + environment: BuildEnvironment | null; + finished_at: Timestamp | null; + id: Id<'build'>; + metadata: BuildMetaData | null; + method: BuildMethod; + started_at: Timestamp | null; + state: BuildState; + validation_failure: ValidationFailure | null; +} + +// @public +export interface BuildEnvironment { + // (undocumented) + nix_plan?: NixPlan | null; + // (undocumented) + type: BuildEnvironmentType; +} + +// @public +export enum BuildEnvironmentType { + // (undocumented) + DOCKERFILE = "dockerfile", + // (undocumented) + NIXPACKS = "nixpacks" +} + +// @public +export interface BuildMetaData { + account_type?: 'user' | 'organization'; + author?: { + avatar_url: string; + username: string; + }; + branch: string; + commit_msg: string; + commit_sha: string; + commit_url?: string; + repo_id: number; + repo_name: string; +} + +// @public +export enum BuildMethod { + // (undocumented) + CLI = "cli", + // (undocumented) + GITHUB = "github" +} + +// @public (undocumented) +export interface BuildSettings { + root_directory?: string; +} + +// @public (undocumented) +export enum BuildState { + // (undocumented) + CANCELLED = "cancelled", + // (undocumented) + FAILED = "failed", + // (undocumented) + PENDING = "pending", + // (undocumented) + SUCCEEDED = "succeeded", + // (undocumented) + VALIDATING = "validating", + // (undocumented) + VALIDATION_FAILED = "validation_failed" +} + +// @public +export function bytes(size: number, unit?: ByteUnit): ByteSizeString; + +// @public +export type ByteSizeString = `${number}${ByteUnit}`; + +// @public @deprecated +export type ByteString = ByteSizeString; + +// @public +export type ByteUnit = typeof byteUnits[number]; + +// @public +export const byteUnits: readonly ["GB", "MB", "KB", "B"]; + +// @public +export interface Channel { + capabilities: number; + created_at: Timestamp; + id: string; + project: Project; + state: State; + type: ChannelType; +} + +// @public +export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'PUT', '/v1/channels/:channel_id', { + channel: Channel; +}, { + type: ChannelType; + state: Record | null; +}> | Endpoint<'POST', '/v1/channels/tokens', { + token: ChannelToken; +}, { + state: State; +}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { + channel: Channel; +}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { + tokens: ChannelToken[]; +}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { + state: State; +}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { + e: string; + d: unknown; +}> | Endpoint<'GET', '/v1/channels', { + channels: Channel[]; +}> | Endpoint<'GET', '/v1/channels/tokens/:token', { + token: ChannelToken; +}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { + token: ChannelToken; +}, { + expiresAt?: Timestamp | null; + state: ChannelToken['state']; +}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { + stats: { + online_count: number; + }; +}>; + +// @public (undocumented) +export namespace Channels { + { + channels_Channel as Channel, + channels_ChannelEndpoints as ChannelEndpoints, + channels_ChannelToken as ChannelToken, + channels_ChannelType as ChannelType, + channels_State as State, + }; +} + +// @public (undocumented) +export interface ChannelToken { + id: Id<'leap_token'>; + is_online: boolean; + project_id: Id<'project'>; + state: State; +} + +// @public +export enum ChannelType { + // (undocumented) + PRIVATE = "private", + // (undocumented) + PUBLIC = "public", + // (undocumented) + UNPROTECTED = "unprotected" +} + +// @public (undocumented) +export interface Container { + created_at: Timestamp; + deployment_id: Id<'deployment'>; + id: Id<'container'>; + internal_ip: string; + metadata: { + last_exit_code?: number; + }; + metrics: { + cpu_usage_percent: number; + memory_usage_percent: number; + } | null; + overrides: { + resources?: Partial; + } | null; + region: Regions; + state: ContainerState; + type: RuntimeType; + uptime: { + last_start: Timestamp; + }; + volume: VolumeDefinition | null; +} + +// @public +export interface ContainerLog { + level: 'info' | 'error'; + message: string; + nonce: string; + timestamp: Timestamp; +} + +// @public +export enum ContainerState { + EXITED = "exited", + FAILED = "failed", + PENDING = "pending", + RUNNING = "running", + STOPPED = "stopped", + TERMINATING = "terminating" +} + +// @public +export enum ContainerStrategy { + MANUAL = "manual" +} + +// @public (undocumented) +export type CreateDeploymentConfig = MakeOptional; + +// @public +export const DEFAULT_BASE_URL = "https://api.hop.io"; + +// @public (undocumented) +export interface DefaultQuotas { + // (undocumented) + ram: number; + // (undocumented) + vcpu: number; + // (undocumented) + volume: number; +} + +// @public (undocumented) +export type DeliveryProtocol = 'webrtc' | 'hls'; + +// @public (undocumented) +export interface Deployment { + active_build: Build | null; + // @deprecated + active_rollout: DeploymentRollout | null; + build_cache_enabled: boolean; + build_id: Build['id'] | null; + build_settings?: BuildSettings; + config: Omit; + container_count: number; + created_at: Timestamp; + id: Id<'deployment'>; + latest_rollout: DeploymentRollout | null; + metadata: DeploymentMetaData | null; + name: string; + running_container_count: number; + target_container_count: number; +} + +// @public (undocumented) +export interface DeploymentConfig { + cmd?: string[]; + container_strategy: ContainerStrategy; + entrypoint?: string[]; + env: Record; + image: Image_2; + name: string; + resources: Resources; + restart_policy: RestartPolicy; + type: RuntimeType; + version: '12-12-2022'; + volume?: VolumeDefinition; +} + +// @public (undocumented) +export interface DeploymentMetaData { + // (undocumented) + container_port_mappings: Record, string[]>; + // (undocumented) + created_first_gateway?: boolean; + // (undocumented) + created_from_preset?: string; + // (undocumented) + ignored_boarding?: boolean; +} + +// @public +export type DeploymentRollout = { + id: Id<'rollout'>; + deployment_id: Id<'deployment'>; + count: number; + created_at: Timestamp; + state: RolloutState; + build: Build | null; + init_container_id: string | null; + health_check_failed: boolean; + last_updated_at: Timestamp; + acknowledged: boolean; +}; + +// @public (undocumented) +export interface Domain { + created_at: Timestamp; + domain: string; + id: Id<'domain'>; + redirect: DomainRedirect | null; + state: DomainState; +} + +// @public (undocumented) +export interface DomainRedirect { + // (undocumented) + status_code: 301 | 302 | 307 | 308; + // (undocumented) + url: string; +} + +// @public (undocumented) +export enum DomainState { + // (undocumented) + PENDING = "pending", + // (undocumented) + SSL_ACTIVE = "ssl_active", + // (undocumented) + VALID_CNAME = "valid_cname" +} + +// @public +export type Empty = void; + +// @public (undocumented) +export type Endpoint = { + method: M; + path: Path; + res: Res; + body: Body; +}; + +// @public (undocumented) +export type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; + +// @public (undocumented) +export type ErroredAPIResponse = { + success: false; + error: { + code: string; + message: string; + }; +}; + +// @public (undocumented) +export type ExtractEndpoint = Extract; + +// @public +export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { + [k in Param | keyof ExtractRouteParams]: string | number; +} : T extends `${string}:${infer Param}` ? { + [k in Param]: string | number; +} : {}; + +// @public +export interface Gateway { + created_at: Timestamp; + deployment_id: Id<'deployment'>; + domains: Domain[]; + hopsh_domain: HopShDomain | null; + hopsh_domain_enabled: boolean; + id: Id<'gateway'>; + internal_domain: InternalHopDomain | null; + name: string; + // @alpha + protocol: 'http' | null; + target_port: number | null; + type: GatewayType; +} + +// @public +export enum GatewayType { + EXTERNAL = "external", + INTERNAL = "internal" +} + +// @public +export function getIdPrefix(id: string, expect?: T): T; + +// @public +export interface GHRepo { + // (undocumented) + account_name: string; + // (undocumented) + default_branch: string; + // (undocumented) + full_name: string; + // (undocumented) + id: number; + // (undocumented) + private: boolean; +} + +// @public +export function gigabytes(size: number): ByteSizeString; + +// @public (undocumented) +export type HealthCheck = { + id: Id<'health_check'>; + protocol: 'http'; + path: string; + port: number; + interval: number; + timeout: number; + initial_delay: number; + max_retries: number; + created_at: Timestamp; +}; + +// @public +export class Hop { + constructor(options: PartialAPIOptions); + constructor(authentication: APIAuthentication, baseurl?: string); + // (undocumented) + readonly channels: { + create(type: ChannelType, id?: string | null | undefined, options?: { + state?: T; + } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + get(id: string): Promise(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + }>; + getAll(project?: `project_${string}` | undefined): Promise<(Channel & { + setState(state: SetStateAction): Promise; + patchState(state: SetStateAction): Promise; + subscribeToken(token: `leap_token_${string}`): Promise; + subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + publishMessage(name: string, data: unknown): Promise; + })[]>; + subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; + subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; + getAllTokens(channel: string | Channel): Promise; + setState(channel: string | Channel, state: SetStateAction): Promise; + patchState(channel: string | Channel, state: SetStateAction): Promise; + publishMessage(channel: string | Channel, event: string, data: T_5): Promise; + delete(id: string): Promise; + getStats(id: string): Promise<{ + online_count: number; + }>; + tokens: { + delete(token: `leap_token_${string}`): Promise; + create(state?: State, project?: `project_${string}` | undefined): Promise; + setState(id: `leap_token_${string}`, state: State): Promise; + get(id: `leap_token_${string}`): Promise; + isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; + publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; + }; + }; + // (undocumented) + readonly client: APIClient; + // (undocumented) + readonly ignite: { + domains: { + delete: (id: `domain_${string}`) => Promise; + get: (id: `domain_${string}`) => Promise; + }; + gateways: { + addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; + get(gatewayId: `gateway_${string}`): Promise; + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + }; + healthChecks: { + create: (deployment: `deployment_${string}`, config: Omit) => Promise; + update: (deployment: `deployment_${string}`, config: Partial>) => Promise; + }; + deployments: { + create: { + (configOrProject: `project_${string}`, bearerOrPatConfig: CreateDeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + (configOrProject: CreateDeploymentConfig): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + }; + get: { + (name: string, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + }>; + }; + rollout(id: `deployment_${string}`): Promise; + getStorageStats(id: `deployment_${string}`): Promise | null>>; + update(deploymentId: `deployment_${string}`, config: Partial): Promise; + getContainers(deployment: `deployment_${string}`): Promise; + getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { + getContainers(): Promise; + delete(): Promise; + createContainer(): Promise; + createGateway(config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + getStorageStats(): Promise | null>>; + })[]>; + delete(deployment: `deployment_${string}`): Promise; + patchMetadata(deploymentId: `deployment_${string}`, metadata: Partial): Promise; + gateways: { + getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { + addDomain(domain: string): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + })[]>; + create(deployment: `deployment_${string}` | Deployment, config: { + type: GatewayType.EXTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + internalDomain: string; + }): Promise; + deleteDomain(domainId: `domain_${string}`): Promise; + }>; + }; + }; + containers: { + delete: { + (container_id: `container_${string}`, options: { + recreate: true; + }): Promise; + (container_id: `container_${string}`, options?: { + recreate?: false; + } | undefined): Promise; + }; + getLogs(container: `container_${string}`, options?: Partial<{ + sortBy: "timestamp"; + orderBy: "desc" | "asc"; + limit: number; + offset: number; + }>): Promise; + stop(container: `container_${string}`): Promise; + start(container: `container_${string}`): Promise; + create(deployment: `deployment_${string}`): Promise; + }; + }; + // (undocumented) + readonly pipe: { + rooms: { + getAll(project?: `project_${string}` | undefined): Promise<(Room & { + delete(): Promise; + })[]>; + create(name: string, options: { + deliveryProtocols: DeliveryProtocol[]; + ephemeral?: boolean; + ingestProtocol: "rtmp" | "rtp"; + hlsConfig?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + }; + }): Promise; + }>; + delete(room: `pipe_room_${string}`): Promise; + }; + }; + // (undocumented) + readonly projects: { + getAllMembers(projectId?: `project_${string}` | undefined): Promise; + getCurrentMember(projectId: `project_${string}`): Promise; + projectTokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + tokens: { + delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; + get(projectId?: `project_${string}` | undefined): Promise; + create(flags: number, projectId?: `project_${string}` | undefined): Promise; + }; + secrets: { + getAll(projectId?: `project_${string}` | undefined): Promise; + create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; + delete(id: string, projectId?: `project_${string}` | undefined): Promise; + }; + }; + // (undocumented) + readonly registry: { + images: { + getAll(project?: `project_${string}` | undefined): Promise; + getManifest(image: string): Promise<{ + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]>; + delete(image: string): Promise; + }; + }; + // (undocumented) + readonly users: { + me: { + get(): Promise<{ + projects: Project[]; + user: SelfUser; + project_member_role_map: Record<`project_${string}`, MemberRole>; + leap_token: string | null; + }>; + pats: { + create(name: string): Promise; + getAll(): Promise; + delete(id: `pat_${string}`): Promise; + }; + }; + }; +} + +// @public +export class HopAPIError extends Error { + constructor(request: Request, response: Response, data: ErroredAPIResponse); + // (undocumented) + readonly data: ErroredAPIResponse; + // (undocumented) + readonly request: Request; + // (undocumented) + readonly response: Response; + // (undocumented) + readonly status: number; +} + +// @public +export type HopShDomain = `${string}.hop.sh`; + +// @public +export type Id = `${T}_${string}`; + +// @public +export function id(maybeId: string | undefined | null, prefix?: T | T[]): Id; + +// @public +export const ID_PREFIXES: readonly [{ + readonly prefix: "user"; + readonly description: "Users"; +}, { + readonly prefix: "project"; + readonly description: "Project"; +}, { + readonly prefix: "pm"; + readonly description: "Project Members"; +}, { + readonly prefix: "role"; + readonly description: "Roles"; +}, { + readonly prefix: "pi"; + readonly description: "Project Invite"; +}, { + readonly prefix: "ptk"; + readonly description: "Project token"; +}, { + readonly prefix: "pat"; + readonly description: "User personal access token"; +}, { + readonly prefix: "container"; + readonly description: "Ignite container"; +}, { + readonly prefix: "pipe_room"; + readonly description: "Pipe room"; +}, { + readonly prefix: "deployment"; + readonly description: "Ignite deployment"; +}, { + readonly prefix: "bearer"; + readonly description: "Users bearer token"; +}, { + readonly prefix: "ptkid"; + readonly description: "Project token ID"; +}, { + readonly prefix: "secret"; + readonly description: "Project secret ID"; +}, { + readonly prefix: "gateway"; + readonly description: "Gateway"; +}, { + readonly prefix: "domain"; + readonly description: "Domain for a gateway"; +}, { + readonly prefix: "leap_token"; + readonly description: "Token for connecting to leap as a client"; +}, { + readonly prefix: "build"; + readonly description: "Build ID for build logs"; +}, { + readonly prefix: "rollout"; + readonly description: "Rollout ID for rollouts."; +}, { + readonly prefix: "health_check"; + readonly description: "Health check ID for health checks."; +}, { + readonly prefix: "session"; + readonly description: "Session ID for sessions on your account."; +}]; + +// @public +export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; + +// @public (undocumented) +export namespace Ignite { + { + ignite_Auth as Auth, + ignite_Build as Build, + ignite_BuildEnvironment as BuildEnvironment, + ignite_BuildEnvironmentType as BuildEnvironmentType, + ignite_BuildMetaData as BuildMetaData, + ignite_BuildMethod as BuildMethod, + ignite_BuildSettings as BuildSettings, + ignite_BuildState as BuildState, + ignite_Container as Container, + ignite_ContainerLog as ContainerLog, + ignite_ContainerState as ContainerState, + ignite_ContainerStrategy as ContainerStrategy, + ignite_CreateDeploymentConfig as CreateDeploymentConfig, + ignite_Deployment as Deployment, + ignite_DeploymentConfig as DeploymentConfig, + ignite_DeploymentMetaData as DeploymentMetaData, + ignite_DeploymentRollout as DeploymentRollout, + ignite_Domain as Domain, + ignite_DomainRedirect as DomainRedirect, + ignite_DomainState as DomainState, + ignite_GHRepo as GHRepo, + ignite_Gateway as Gateway, + ignite_GatewayType as GatewayType, + ignite_HealthCheck as HealthCheck, + ignite_IgniteEndpoints as IgniteEndpoints, + ignite_Image as Image, + ignite_ImageGHRepo as ImageGHRepo, + ignite_NixPlan as NixPlan, + ignite_Regions as Regions, + ignite_Resources as Resources, + ignite_RestartPolicy as RestartPolicy, + ignite_RolloutState as RolloutState, + ignite_RuntimeType as RuntimeType, + ignite_ValidationFailure as ValidationFailure, + ignite_Vgpu as Vgpu, + ignite_VgpuType as VgpuType, + ignite_VolumeDefinition as VolumeDefinition, + ignite_VolumeFormat as VolumeFormat, + }; +} + +// @public (undocumented) +export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { + deployments: Deployment[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { + containers: Container[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { + container: Container; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { + deployment_id: Id<'deployment'>; + container_id: Id<'container'>; +}> | Endpoint<'POST', '/v1/ignite/deployments', { + deployment: Deployment; +}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty | { + container: Container; +}> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { + logs: ContainerLog[]; +}> | Endpoint<'GET', '/v1/ignite/deployments/search', { + deployment: Deployment; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { + preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; +}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { + domain: string; +}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { + gateway: Gateway; +}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { + gateways: Gateway[]; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { + gateway: Gateway; +}, { + type: GatewayType; + target_port: number; + protocol: Gateway['protocol']; + name: string; +}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { + deployment: Deployment; +}, Partial> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', { + deployment: Deployment; +}, Partial> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { + rollout: DeploymentRollout; +}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/health-check', { + health_check: HealthCheck; +}, Omit> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/storage', Record<'volume' | 'build_cache', Record<'provisioned_size' | 'used_size', number> | null>> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', { + health_check: HealthCheck; +}, Partial>> | Endpoint<'DELETE', '/v1/ignite/domains/:domain_id', Empty> | Endpoint<'GET', '/v1/ignite/domains/:domain_id', { + domain: Domain; +}>; + +// @public +interface Image_2 { + auth: Auth | null; + gh_repo: ImageGHRepo | null; + name: string | null; +} +export { Image_2 as Image } + +// @public +export interface ImageGHRepo { + // (undocumented) + branch: string; + // (undocumented) + full_name: string; + // (undocumented) + repo_id: number; +} + +// @public +export type InternalHopDomain = `${string}.hop`; + +// @public +export const IS_BROWSER: boolean; + +// @public +export function isValidByteString(value: string): value is ByteSizeString; + +// @public +export function kilobytes(size: number): ByteSizeString; + +// @public +export type MakeOptional = Omit & Partial>; + +// @public +export function megabytes(size: number): ByteSizeString; + +// @public (undocumented) +export type Member = Omit & { + id: Id<'pm'>; + role: MemberRole; + mfa_enabled: boolean; + joined_at: Timestamp; +}; + +// @public (undocumented) +export interface MemberRole { + flags: number; + id: Id<'role'>; + name: string; +} + +// @public +export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; + +// @public +export interface NixPlan { + // (undocumented) + cmds: { + build: string | null; + start: string | null; + install: string | null; + }; + // (undocumented) + language: string | null; + // (undocumented) + pkgs: string[] | null; +} + +// @public +export function parseSize(size: string): number; + +// @public +export type PartialAPIOptions = Partial> & Pick; + +// @public (undocumented) +export interface PAT { + created_at: Timestamp; + id: Id<'pat'>; + name: string | null; + // @alpha + pat: string; +} + +// @public (undocumented) +export type PathsFor = Extract['path']; + +// @public +export const permissions: { + add(value: bigint, flag: bigint): bigint; + test(value: bigint, flag: bigint): boolean; + subtract(value: bigint, flag: bigint): bigint; +}; + +// @public +export const permissionsMap: { + add_member: bigint; + remove_member: bigint; + get_project_members: bigint; + delete_project: bigint; + delete_deployment: bigint; + delete_container: bigint; + update_container_state: bigint; + read_deployments: bigint; + create_deployment: bigint; + create_container: bigint; + update_container_config: bigint; + create_room: bigint; + read_room: bigint; + delete_room: bigint; + create_room_producer: bigint; + create_project_token: bigint; + delete_project_token: bigint; + read_project_tokens: bigint; + read_container_logs: bigint; + create_project_secret: bigint; + read_project_secrets: bigint; + delete_project_secret: bigint; + get_registry_images: bigint; + create_channel_token: bigint; + create_gateway: bigint; + add_domain: bigint; + delete_channels: bigint; + update_channel_state: bigint; + read_channels: bigint; + publish_channel_messages: bigint; + manage_channel_subscribers: bigint; + delete_domain: bigint; + delete_gateway: bigint; + get_internal_domain: bigint; + create_leap_token: bigint; + read_leap_tokens: bigint; + update_leap_token: bigint; + message_token: bigint; + create_channel: bigint; + rollout: bigint; + request_quota_increase: bigint; + read_billing: bigint; + read_gateways: bigint; + delete_registry_images: bigint; + container_ssh: bigint; + tunnel_deployment: bigint; +}; + +// @public (undocumented) +export namespace Pipe { + { + pipe_DeliveryProtocol as DeliveryProtocol, + pipe_PipeEndpoints as PipeEndpoints, + pipe_Room as Room, + }; +} + +// @public (undocumented) +export type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { + rooms: Room[]; +}> | Endpoint<'POST', '/v1/pipe/rooms', { + room: Room; +}, { + name: string; + ingest_protocol: 'rtmp' | 'rtp'; + delivery_protocols: DeliveryProtocol[]; + region: Regions; + ephemeral: boolean; + llhls_config?: { + wcl_delay: number; + artificial_delay: number; + max_playout_bitrate_preset: string; + } | undefined; +}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; + +// @public (undocumented) +export interface Project { + created_at: Timestamp; + // (undocumented) + default_quotas: DefaultQuotas; + icon: string | null; + id: Id<'project'>; + name: string; + namespace: string; + // (undocumented) + quota_overrides: QuotaOverrides; + // (undocumented) + quota_usage: QuotaUsage; + tier: ProjectTier; + type: ProjectType; +} + +// @public +export enum PROJECT_PERMISSION { + // (undocumented) + ADD_DOMAIN = "add_domain", + // (undocumented) + ADD_MEMBER = "add_member", + // (undocumented) + CONTAINER_SSH = "container_ssh", + // (undocumented) + CREATE_CHANNEL = "create_channel", + // (undocumented) + CREATE_CHANNEL_TOKEN = "create_channel_token", + // (undocumented) + CREATE_CONTAINER = "create_container", + // (undocumented) + CREATE_DEPLOYMENT = "create_deployment", + // (undocumented) + CREATE_GATEWAY = "create_gateway", + // (undocumented) + CREATE_LEAP_TOKEN = "create_leap_token", + // (undocumented) + CREATE_PROJECT_SECRET = "create_project_secret", + // (undocumented) + CREATE_PROJECT_TOKEN = "create_project_token", + // (undocumented) + CREATE_ROOM = "create_room", + // (undocumented) + CREATE_ROOM_PRODUCER = "create_room_producer", + // (undocumented) + DELETE_CHANNELS = "delete_channels", + // (undocumented) + DELETE_CONTAINER = "delete_container", + // (undocumented) + DELETE_DEPLOYMENT = "delete_deployment", + // (undocumented) + DELETE_DOMAIN = "delete_domain", + // (undocumented) + DELETE_GATEWAY = "delete_gateway", + // (undocumented) + DELETE_PROJECT = "delete_project", + // (undocumented) + DELETE_PROJECT_SECRET = "delete_project_secret", + // (undocumented) + DELETE_PROJECT_TOKEN = "delete_project_token", + // (undocumented) + DELETE_REGISTRY_IMAGES = "delete_registry_images", + // (undocumented) + DELETE_ROOM = "delete_room", + // (undocumented) + GET_INTERNAL_DOMAIN = "get_internal_domain", + // (undocumented) + GET_PROJECT_MEMBERS = "get_project_members", + // (undocumented) + GET_REGISTRY_IMAGES = "get_registry_images", + // (undocumented) + MANAGE_CHANNEL_SUBSCRIBERS = "manage_channel_subscribers", + // (undocumented) + MESSAGE_TOKEN = "message_token", + // (undocumented) + PUBLISH_CHANNEL_MESSAGES = "publish_channel_messages", + // (undocumented) + READ_BILLING = "read_billing", + // (undocumented) + READ_CHANNELS = "read_channels", + // (undocumented) + READ_CONTAINER_LOGS = "read_container_logs", + // (undocumented) + READ_DEPLOYMENTS = "read_deployments", + // (undocumented) + READ_GATEWAYS = "read_gateways", + // (undocumented) + READ_LEAP_TOKENS = "read_leap_tokens", + // (undocumented) + READ_PROJECT_SECRETS = "read_project_secrets", + // (undocumented) + READ_PROJECT_TOKENS = "read_project_tokens", + // (undocumented) + READ_ROOM = "read_room", + // (undocumented) + REMOVE_MEMBER = "remove_member", + // (undocumented) + REQUEST_QUOTA_INCREASE = "request_quota_increase", + // (undocumented) + ROLLOUT = "rollout", + // (undocumented) + TUNNEL_DEPLOYMENT = "tunnel_deployment", + // (undocumented) + UPDATE_CHANNEL_STATE = "update_channel_state", + // (undocumented) + UPDATE_CONTAINER_CONFIG = "update_container_config", + // (undocumented) + UPDATE_CONTAINER_STATE = "update_container_state", + // (undocumented) + UPDATE_LEAP_TOKEN = "update_leap_token" +} + +// @public (undocumented) +export namespace Projects { + { + projects_DefaultQuotas as DefaultQuotas, + projects_Member as Member, + projects_MemberRole as MemberRole, + projects_Project as Project, + projects_ProjectTier as ProjectTier, + projects_ProjectToken as ProjectToken, + projects_ProjectType as ProjectType, + projects_ProjectsEndpoints as ProjectsEndpoints, + projects_QuotaOverrides as QuotaOverrides, + projects_QuotaUsage as QuotaUsage, + projects_Secret as Secret, + }; +} + +// @public (undocumented) +export type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { + project_member: Member; +}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/@this/tokens', { + project_tokens: ProjectToken[]; +}> | Endpoint<'GET', '/v1/projects/:project_id/members', { + members: Member[]; +}> | Endpoint<'GET', '/v1/projects/@this/members', { + members: Member[]; +}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'POST', '/v1/projects/@this/tokens', { + project_token: ProjectToken & { + project: Project; + }; +}, { + flags: number; +}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { + secret: Secret; +}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { + secrets: Secret[]; +}> | Endpoint<'GET', '/v1/projects/@this/secrets', { + secrets: Secret[]; +}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; + +// @public (undocumented) +export enum ProjectTier { + // (undocumented) + FREE = "free", + // (undocumented) + PAID = "paid" +} + +// @public +export interface ProjectToken { + created_at: Timestamp; + flags: number; + id: Id<'ptkid'>; + token: Id<'ptk'>; +} + +// @public +export enum ProjectType { + PERSONAL = "personal", + REGULAR = "regular" +} + +// @public +export type Query = ExtractRouteParams & Record; + +// @public (undocumented) +export interface QuotaOverrides { +} + +// @public (undocumented) +export interface QuotaUsage { + // (undocumented) + ram: number; + // (undocumented) + vcpu: number; + // (undocumented) + volume: number; +} + +// @public (undocumented) +export enum Regions { + // (undocumented) + US_EAST_1 = "us-east-1" +} + +// @public (undocumented) +export namespace Registry { + { + registry_RegistryEndpoints as RegistryEndpoints, + }; +} + +// @public (undocumented) +export type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { + images: string[]; +}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { + manifests: { + digest: { + digest: string; + size: number; + uploaded: string; + }; + tag: string | null; + }[]; +}>; + +// @public +export interface Resources { + ram: ByteSizeString; + vcpu: number; + vgpu: Vgpu[]; +} + +// @public +export enum RestartPolicy { + // (undocumented) + ALWAYS = "always", + // (undocumented) + NEVER = "never", + // (undocumented) + ON_FAILURE = "on-failure" +} + +// @public +export const roles: { + viewer: bigint; + editor: bigint; + admin: bigint; + owner: bigint; +}; + +// @public +export enum RolloutState { + // (undocumented) + FAILED = "failed", + // (undocumented) + FINISHED = "finished", + // (undocumented) + PENDING = "pending" +} + +// @public (undocumented) +export interface Room { + created_at: Timestamp; + delivery_protocols: DeliveryProtocol[]; + id: Id<'pipe_room'>; + ingest_endpoint: string; + ingest_protocol: 'rtmp'; + ingest_region: Regions; + join_token: string; + name: string; + state: 'live' | 'offline'; +} + +// @public +export enum RuntimeType { + EPHEMERAL = "ephemeral", + PERSISTENT = "persistent", + STATEFUL = "stateful" +} + +// @public (undocumented) +export interface Secret { + created_at: Timestamp; + digest: string; + id: Id<'secret'>; + in_use_by: Id<'deployment'>[]; + name: string; +} + +// @public +export interface SelfUser extends User { + admin: boolean; + email_verified: boolean; + mfa_enabled: boolean; + totp_enabled: boolean; + webauthn_enabled: boolean; +} + +// @public +export type State = Record; + +// @public (undocumented) +export type SuccessfulAPIResponse = { + success: true; + data: T; +}; + +// @public +export const SUPPORTS_INTL: boolean; + +// @public +export type Tag = T & { + ___tag: Name; +}; + +// @public +export type Timestamp = Tag; + +// @public @deprecated (undocumented) +export const units: readonly ["GB", "MB", "KB", "B"]; + +// @public +export interface User { + email: string; + id: Id<'user'>; + name: string; + username: string; +} + +// @public (undocumented) +export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { + projects: Project[]; + user: SelfUser; + project_member_role_map: Record, MemberRole>; + leap_token: string | null; +}> | Endpoint<'POST', '/v1/users/@me/pats', { + pat: PAT; +}, { + name: string; +}> | Endpoint<'GET', '/v1/users/@me/pats', { + pats: PAT[]; +}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; + +// @public (undocumented) +export namespace Users { + { + users_PAT as PAT, + users_SelfUser as SelfUser, + users_User as User, + users_UserEndpoints as UserEndpoints, + }; +} + +// @public +export function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; + +// @public +export function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; + +// @public +export function validateIdPrefix(prefix: string, expect?: T): prefix is T; + +// @public +export interface ValidationFailure { + // (undocumented) + help_link: string | null; + // (undocumented) + reason: string; +} + +// @internal +export type _Values = T[keyof T]; + +// @public +export interface Vgpu { + count: number; + type: VgpuType; +} + +// @public +export enum VgpuType { + // (undocumented) + A400 = "a400" +} + +// @public (undocumented) +export interface VolumeDefinition { + fs: VolumeFormat; + mount_path: string; + size: ByteSizeString; +} + +// @public (undocumented) +export enum VolumeFormat { + // (undocumented) + EXT4 = "ext4", + // (undocumented) + XFS = "xfs" +} + +// Warnings were encountered during analysis: +// +// dist/index.d.ts:759:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts + +// (No @packageDocumentation comment for this package) + +``` diff --git a/api-extractor.json b/api-extractor.json index 06d3251e..5796b365 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -13,12 +13,12 @@ "apiReport": { "enabled": true, - "reportFolder": "/.temp" + "reportFolder": "/temp" }, "docModel": { "enabled": true, - "apiJsonFilePath": "/.temp/js.api.json" + "apiJsonFilePath": "/temp/js.api.json" }, "dtsRollup": { diff --git a/package.json b/package.json index 47628ff7..ebd744c5 100644 --- a/package.json +++ b/package.json @@ -43,12 +43,13 @@ "build": "rm -rf dist && tsup", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "docs": "api-extractor run --local --verbose && api-documenter markdown --input-folder ./.temp --output-folder ./docs", + "api": "yarn build && api-extractor run --local --verbose", "fullbuild": "yarn build && yarn docs", "test": "tsx tests/index.ts" }, "devDependencies": { "@changesets/cli": "2.26.0", + "@microsoft/api-extractor": "^7.34.4", "@types/glob": "8.1.0", "@types/node": "18.15.0", "dotenv": "16.0.3", diff --git a/src/rest/endpoints.ts b/src/rest/endpoints.ts index 4023d3b8..ae1e4a0d 100644 --- a/src/rest/endpoints.ts +++ b/src/rest/endpoints.ts @@ -6,11 +6,19 @@ import type {ProjectsEndpoints} from './types/projects.ts'; import type {RegistryEndpoints} from './types/registry.ts'; import type {UserEndpoints} from './types/users.ts'; +/** + * A successful response from an API endpoint + * @public + */ export type SuccessfulAPIResponse = { success: true; data: T; }; +/** + * An error response from an API endpoint + * @public + */ export type ErroredAPIResponse = { success: false; error: { @@ -19,8 +27,16 @@ export type ErroredAPIResponse = { }; }; +/** + * The response from an API endpoint + * @public + */ export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; +/** + * A successful response from an API endpoint + * @public + */ export type Endpoint< M extends Method, Path extends string, @@ -33,6 +49,10 @@ export type Endpoint< body: Body; }; +/** + * A successful response from an API endpoint + * @public + */ export type Endpoints = | IgniteEndpoints | RegistryEndpoints diff --git a/src/rest/types/api.ts b/src/rest/types/api.ts index 098cd02a..0c072b71 100644 --- a/src/rest/types/api.ts +++ b/src/rest/types/api.ts @@ -1,6 +1,44 @@ -export * as Channels from './channels.ts'; -export * as Ignite from './ignite.ts'; -export * as Pipe from './pipe.ts'; -export * as Projects from './projects.ts'; -export * as Registry from './registry.ts'; -export * as users from './users.ts'; +import * as Channels from './channels.ts'; +import * as Ignite from './ignite.ts'; +import * as Pipe from './pipe.ts'; +import * as Projects from './projects.ts'; +import * as Registry from './registry.ts'; +import * as Users from './users.ts'; + +export { + /** + * Namespace containing information about channels + * @public + */ + Channels, + + /** + * Namespace containing information about Ignite + * @public + */ + Ignite, + + /** + * Namespace containing information about Pipe + * @public + */ + Pipe, + + /** + * Namespace containing information about projects + * @public + */ + Projects, + + /** + * Namespace containing information about the registry + * @public + */ + Registry, + + /** + * Namespace containing information about users + * @public + */ + Users, +}; diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index ca60500e..4fa44db6 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -76,6 +76,10 @@ export interface ChannelToken { is_online: boolean; } +/** + * Endpoints for channels + * @public + */ export type ChannelEndpoints = | Endpoint< 'POST', diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 99582ef4..4b3644df 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -360,6 +360,7 @@ export interface NixPlan { /** * Build environment contians information about the * language and build commands used to build the deployment + * @public */ export interface BuildEnvironment { type: BuildEnvironmentType; @@ -368,12 +369,17 @@ export interface BuildEnvironment { /** * Why the uploaded build content was rejected + * @public */ export interface ValidationFailure { reason: string; help_link: string | null; } +/** + * A build is a single build of a deployment + * @public + */ export interface Build { /** * ID of the build @@ -431,6 +437,10 @@ export interface Build { validation_failure: ValidationFailure | null; } +/** + * Information about a deployment's health check configuration + * @public + */ export type HealthCheck = { /** * The ID of health check @@ -441,7 +451,15 @@ export type HealthCheck = { * Protocol for health check */ protocol: 'http'; + + /** + * Path for health check + */ path: string; + + /** + * Port for health check + */ port: number; /** @@ -474,6 +492,7 @@ export type HealthCheck = { /** * A deployment rollout + * @public */ export type DeploymentRollout = { /** @@ -526,11 +545,16 @@ export type DeploymentRollout = { acknowledged: boolean; }; +/** + * Data required to create a deployment + * @internal + */ export type CreateDeploymentConfig = MakeOptional; /** * The strategy for scaling multiple containers. * @warning This property is not yet fully complete + * @public */ export enum ContainerStrategy { /** @@ -545,6 +569,10 @@ export enum ContainerStrategy { // AUTOSCALE = 'autoscale', } +/** + * A deployment's config + * @public + */ export interface DeploymentConfig { /** * The name of the deployment @@ -606,6 +634,7 @@ export interface DeploymentConfig { /** * Docker image config + * @public */ export interface Image { /** @@ -627,6 +656,7 @@ export interface Image { /** * Docker image registry authorization + * @public */ export interface Auth { username: string; @@ -635,6 +665,7 @@ export interface Auth { /** * GitHub repo type sent from API (NOT USED IN IMAGES) + * @public */ export interface GHRepo { id: number; @@ -646,6 +677,7 @@ export interface GHRepo { /** * GitHub repo partial used for images + * @public */ export interface ImageGHRepo { repo_id: number; @@ -655,6 +687,7 @@ export interface ImageGHRepo { /** * Resources allocated to a deployment + * @public */ export interface Resources { /** @@ -676,6 +709,7 @@ export interface Resources { /** * Virtual GPU config + * @public */ export interface Vgpu { /** @@ -691,6 +725,7 @@ export interface Vgpu { /** * Logs from a container + * @public */ export interface ContainerLog { /** @@ -717,6 +752,7 @@ export interface ContainerLog { /** * Types of build methods supported by Hop + * @public */ export enum BuildMethod { GITHUB = 'github', @@ -725,6 +761,7 @@ export enum BuildMethod { /** * Types of gateways supported by Hop + * @public */ export enum GatewayType { /** @@ -740,6 +777,7 @@ export enum GatewayType { /** * Gateways are used to connect services to the internet or a private network + * @public */ export interface Gateway { /** @@ -800,12 +838,20 @@ export interface Gateway { domains: Domain[]; } +/** + * An enum of states a domain can be in + * @public + */ export enum DomainState { PENDING = 'pending', VALID_CNAME = 'valid_cname', SSL_ACTIVE = 'ssl_active', } +/** + * An enum of states a build can be in + * @public + */ export enum BuildState { VALIDATING = 'validating', PENDING = 'pending', @@ -815,6 +861,10 @@ export enum BuildState { VALIDATION_FAILED = 'validation_failed', } +/** + * A domain is a DNS record that points to a gateway + * @public + */ export interface Domain { /** * The ID of the domain @@ -842,11 +892,19 @@ export interface Domain { redirect: DomainRedirect | null; } +/** + * A redirect setup for a domain + * @public + */ export interface DomainRedirect { url: string; status_code: 301 | 302 | 307 | 308; } +/** + * All endpoints for the Ignite API + * @public + */ export type IgniteEndpoints = | Endpoint<'GET', '/v1/ignite/deployments', {deployments: Deployment[]}> | Endpoint< diff --git a/src/rest/types/index.ts b/src/rest/types/index.ts index 05b1bcdd..e5e17d6a 100644 --- a/src/rest/types/index.ts +++ b/src/rest/types/index.ts @@ -1,4 +1,6 @@ export * from '../../util/types.ts'; +import * as API from './api.ts'; + export { /** * All types defined in the Hop API @@ -6,5 +8,3 @@ export { */ API, }; - -import * as API from './api.ts'; diff --git a/src/rest/types/users.ts b/src/rest/types/users.ts index 9df2b224..11d66cf4 100644 --- a/src/rest/types/users.ts +++ b/src/rest/types/users.ts @@ -4,6 +4,7 @@ import type {MemberRole, Project} from './projects.ts'; /** * A user object + * @public */ export interface User { /** @@ -29,6 +30,7 @@ export interface User { /** * Self User Object + * @public */ export interface SelfUser extends User { /** @@ -57,6 +59,10 @@ export interface SelfUser extends User { admin: boolean; } +/** + * A personal access token + * @public + */ export interface PAT { /** * The ID of the pat @@ -81,6 +87,10 @@ export interface PAT { created_at: Timestamp; } +/** + * All user endpoints + * @public + */ export type UserEndpoints = | Endpoint< 'GET', diff --git a/temp/js.api.md b/temp/js.api.md index c7d82e20..9a57a99a 100644 --- a/temp/js.api.md +++ b/temp/js.api.md @@ -10,12 +10,12 @@ export type AnyId = Id; // @public (undocumented) export namespace API { { - channels$1 as Channels, - ignite$1 as Ignite, - pipe$1 as Pipe, - projects$1 as Projects, - registry$1 as Registry, - users$1 as users, + channels as Channels, + ignite as Ignite, + pipe as Pipe, + projects as Projects, + registry as Registry, + users as Users, }; } @@ -60,7 +60,9 @@ export class APIClient { }> | Extract, { path: Path; method: 'DELETE'; - }> | Extract, { + }> | Extract, { path: Path; method: 'DELETE'; }> | Extract, { @@ -74,11 +76,9 @@ export class APIClient { method: 'DELETE'; }>)["res"]>; // (undocumented) - get['path']>(path: Path, query: Query, init?: RequestInit): Promise<(Extract>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; leap_token: string | null; }>, { @@ -236,14 +236,19 @@ export class APIClient { }> | Extract, { path: Path; method: 'PATCH'; }> | Extract, { + }, Partial>, { + path: Path; + method: 'PATCH'; + }> | Extract>, { path: Path; method: 'PATCH'; }> | Extract = SuccessfulAPIResponse | ErroredAPIResponse; // @public @@ -447,16 +452,35 @@ export const BROAD_PERMISSIONS_MAP: { MANAGE_BILLING: bigint; }; -// @public +// @public (undocumented) export interface Build { + created_at?: Timestamp; deployment_id: Id<'deployment'>; digest: string | null; + environment: BuildEnvironment | null; finished_at: Timestamp | null; id: Id<'build'>; metadata: BuildMetaData | null; method: BuildMethod; - started_at: Timestamp; + started_at: Timestamp | null; state: BuildState; + validation_failure: ValidationFailure | null; +} + +// @public +export interface BuildEnvironment { + // (undocumented) + nix_plan?: NixPlan | null; + // (undocumented) + type: BuildEnvironmentType; +} + +// @public +export enum BuildEnvironmentType { + // (undocumented) + DOCKERFILE = "dockerfile", + // (undocumented) + NIXPACKS = "nixpacks" } // @public @@ -482,6 +506,11 @@ export enum BuildMethod { GITHUB = "github" } +// @public (undocumented) +export interface BuildSettings { + root_directory?: string; +} + // @public (undocumented) export enum BuildState { // (undocumented) @@ -491,7 +520,11 @@ export enum BuildState { // (undocumented) PENDING = "pending", // (undocumented) - SUCCEEDED = "succeeded" + SUCCEEDED = "succeeded", + // (undocumented) + VALIDATING = "validating", + // (undocumented) + VALIDATION_FAILED = "validation_failed" } // @public @@ -509,7 +542,7 @@ export type ByteUnit = typeof byteUnits[number]; // @public export const byteUnits: readonly ["GB", "MB", "KB", "B"]; -// @public (undocumented) +// @public export interface Channel { capabilities: number; created_at: Timestamp; @@ -519,7 +552,7 @@ export interface Channel { type: ChannelType; } -// @public (undocumented) +// @public export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { channel: Channel; }, { @@ -564,11 +597,11 @@ export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { // @public (undocumented) export namespace Channels { { - channels$1_Channel as Channel, - channels$1_ChannelEndpoints as ChannelEndpoints, - channels$1_ChannelToken as ChannelToken, - channels$1_ChannelType as ChannelType, - channels$1_State as State, + channels_Channel as Channel, + channels_ChannelEndpoints as ChannelEndpoints, + channels_ChannelToken as ChannelToken, + channels_ChannelType as ChannelType, + channels_State as State, }; } @@ -580,7 +613,7 @@ export interface ChannelToken { state: State; } -// @public (undocumented) +// @public export enum ChannelType { // (undocumented) PRIVATE = "private", @@ -603,6 +636,9 @@ export interface Container { cpu_usage_percent: number; memory_usage_percent: number; } | null; + overrides: { + resources?: Partial; + } | null; region: Regions; state: ContainerState; type: RuntimeType; @@ -630,6 +666,11 @@ export enum ContainerState { TERMINATING = "terminating" } +// @public +export enum ContainerStrategy { + MANUAL = "manual" +} + // @public (undocumented) export type CreateDeploymentConfig = MakeOptional; @@ -654,8 +695,10 @@ export interface Deployment { active_build: Build | null; // @deprecated active_rollout: DeploymentRollout | null; + build_cache_enabled: boolean; build_id: Build['id'] | null; - config: Omit; + build_settings?: BuildSettings; + config: Omit; container_count: number; created_at: Timestamp; id: Id<'deployment'>; @@ -666,25 +709,31 @@ export interface Deployment { target_container_count: number; } -// @public -export type DeploymentConfig = { - name: string; - container_strategy: 'manual'; - type: RuntimeType; - version: '12-12-2022'; - cmd: string[]; - image: Image_2; +// @public (undocumented) +export interface DeploymentConfig { + cmd?: string[]; + container_strategy: ContainerStrategy; + entrypoint?: string[]; env: Record; + image: Image_2; + name: string; resources: Resources; restart_policy: RestartPolicy; + type: RuntimeType; + version: '12-12-2022'; volume?: VolumeDefinition; - entrypoint?: string[]; -}; +} // @public (undocumented) export interface DeploymentMetaData { // (undocumented) container_port_mappings: Record, string[]>; + // (undocumented) + created_first_gateway?: boolean; + // (undocumented) + created_from_preset?: string; + // (undocumented) + ignored_boarding?: boolean; } // @public @@ -731,7 +780,7 @@ export enum DomainState { // @public export type Empty = void; -// @public (undocumented) +// @public export type Endpoint = { method: M; path: Path; @@ -739,10 +788,10 @@ export type Endpoint = Extract; + // @public export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { [k in Param | keyof ExtractRouteParams]: string | number; @@ -810,6 +865,7 @@ export type HealthCheck = { timeout: number; initial_delay: number; max_retries: number; + created_at: Timestamp; }; // @public @@ -819,7 +875,7 @@ export class Hop { // (undocumented) readonly channels: { create(type: ChannelType, id?: string | null | undefined, options?: { - state?: T | undefined; + state?: T; } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; patchState(state: SetStateAction): Promise; @@ -876,10 +932,16 @@ export class Hop { deleteDomain(domainId: `domain_${string}`): Promise; })[]>; create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType; + type: GatewayType.EXTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + } | { + type: GatewayType.INTERNAL; protocol: "http" | null; targetPort: number; name: string; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -896,11 +958,16 @@ export class Hop { delete(): Promise; createContainer(): Promise; createGateway(config: { - type: GatewayType; + type: GatewayType.EXTERNAL; protocol: "http" | null; - port: number; name: string; targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -912,11 +979,16 @@ export class Hop { delete(): Promise; createContainer(): Promise; createGateway(config: { - type: GatewayType; + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; protocol: "http" | null; - port: number; name: string; targetPort: number; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -930,11 +1002,16 @@ export class Hop { delete(): Promise; createContainer(): Promise; createGateway(config: { - type: GatewayType; + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; protocol: "http" | null; - port: number; name: string; targetPort: number; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -946,11 +1023,16 @@ export class Hop { delete(): Promise; createContainer(): Promise; createGateway(config: { - type: GatewayType; + type: GatewayType.EXTERNAL; protocol: "http" | null; - port: number; name: string; targetPort: number; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -960,18 +1042,23 @@ export class Hop { }; rollout(id: `deployment_${string}`): Promise; getStorageStats(id: `deployment_${string}`): Promise | null>>; - update(deploymentId: `deployment_${string}`, config: DeploymentConfig): Promise; + update(deploymentId: `deployment_${string}`, config: Partial): Promise; getContainers(deployment: `deployment_${string}`): Promise; getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { getContainers(): Promise; delete(): Promise; createContainer(): Promise; createGateway(config: { - type: GatewayType; + type: GatewayType.EXTERNAL; + protocol: "http" | null; + name: string; + targetPort: number; + } | { + type: GatewayType.INTERNAL; protocol: "http" | null; - port: number; name: string; targetPort: number; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -979,16 +1066,23 @@ export class Hop { getStorageStats(): Promise | null>>; })[]>; delete(deployment: `deployment_${string}`): Promise; + patchMetadata(deploymentId: `deployment_${string}`, metadata: Partial): Promise; gateways: { getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { addDomain(domain: string): Promise; deleteDomain(domainId: `domain_${string}`): Promise; })[]>; create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType; + type: GatewayType.EXTERNAL; protocol: "http" | null; targetPort: number; name: string; + } | { + type: GatewayType.INTERNAL; + protocol: "http" | null; + targetPort: number; + name: string; + internalDomain: string; }): Promise; deleteDomain(domainId: `domain_${string}`): Promise; @@ -996,7 +1090,14 @@ export class Hop { }; }; containers: { - delete(container: `container_${string}`): Promise; + delete: { + (container_id: `container_${string}`, options: { + recreate: true; + }): Promise; + (container_id: `container_${string}`, options?: { + recreate?: false; + } | undefined): Promise; + }; getLogs(container: `container_${string}`, options?: Partial<{ sortBy: "timestamp"; orderBy: "desc" | "asc"; @@ -1016,13 +1117,13 @@ export class Hop { })[]>; create(name: string, options: { deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean | undefined; + ephemeral?: boolean; ingestProtocol: "rtmp" | "rtp"; hlsConfig?: { wcl_delay: number; artificial_delay: number; max_playout_bitrate_preset: string; - } | undefined; + }; }): Promise; }>; @@ -1073,7 +1174,7 @@ export class Hop { me: { get(): Promise<{ projects: Project[]; - user: User; + user: SelfUser; project_member_role_map: Record<`project_${string}`, MemberRole>; leap_token: string | null; }>; @@ -1166,6 +1267,9 @@ export const ID_PREFIXES: readonly [{ }, { readonly prefix: "health_check"; readonly description: "Health check ID for health checks."; +}, { + readonly prefix: "session"; + readonly description: "Session ID for sessions on your account."; }]; // @public @@ -1174,38 +1278,44 @@ export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; // @public (undocumented) export namespace Ignite { { - ignite$1_Auth as Auth, - ignite$1_Build as Build, - ignite$1_BuildMetaData as BuildMetaData, - ignite$1_BuildMethod as BuildMethod, - ignite$1_BuildState as BuildState, - ignite$1_Container as Container, - ignite$1_ContainerLog as ContainerLog, - ignite$1_ContainerState as ContainerState, - ignite$1_CreateDeploymentConfig as CreateDeploymentConfig, - ignite$1_Deployment as Deployment, - ignite$1_DeploymentConfig as DeploymentConfig, - ignite$1_DeploymentMetaData as DeploymentMetaData, - ignite$1_DeploymentRollout as DeploymentRollout, - ignite$1_Domain as Domain, - ignite$1_DomainRedirect as DomainRedirect, - ignite$1_DomainState as DomainState, - ignite$1_GHRepo as GHRepo, - ignite$1_Gateway as Gateway, - ignite$1_GatewayType as GatewayType, - ignite$1_HealthCheck as HealthCheck, - ignite$1_IgniteEndpoints as IgniteEndpoints, - ignite$1_Image as Image, - ignite$1_ImageGHRepo as ImageGHRepo, - ignite$1_Regions as Regions, - ignite$1_Resources as Resources, - ignite$1_RestartPolicy as RestartPolicy, - ignite$1_RolloutState as RolloutState, - ignite$1_RuntimeType as RuntimeType, - ignite$1_Vgpu as Vgpu, - ignite$1_VgpuType as VgpuType, - ignite$1_VolumeDefinition as VolumeDefinition, - ignite$1_VolumeFormat as VolumeFormat, + ignite_Auth as Auth, + ignite_Build as Build, + ignite_BuildEnvironment as BuildEnvironment, + ignite_BuildEnvironmentType as BuildEnvironmentType, + ignite_BuildMetaData as BuildMetaData, + ignite_BuildMethod as BuildMethod, + ignite_BuildSettings as BuildSettings, + ignite_BuildState as BuildState, + ignite_Container as Container, + ignite_ContainerLog as ContainerLog, + ignite_ContainerState as ContainerState, + ignite_ContainerStrategy as ContainerStrategy, + ignite_CreateDeploymentConfig as CreateDeploymentConfig, + ignite_Deployment as Deployment, + ignite_DeploymentConfig as DeploymentConfig, + ignite_DeploymentMetaData as DeploymentMetaData, + ignite_DeploymentRollout as DeploymentRollout, + ignite_Domain as Domain, + ignite_DomainRedirect as DomainRedirect, + ignite_DomainState as DomainState, + ignite_GHRepo as GHRepo, + ignite_Gateway as Gateway, + ignite_GatewayType as GatewayType, + ignite_HealthCheck as HealthCheck, + ignite_IgniteEndpoints as IgniteEndpoints, + ignite_Image as Image, + ignite_ImageGHRepo as ImageGHRepo, + ignite_NixPlan as NixPlan, + ignite_Regions as Regions, + ignite_Resources as Resources, + ignite_RestartPolicy as RestartPolicy, + ignite_RolloutState as RolloutState, + ignite_RuntimeType as RuntimeType, + ignite_ValidationFailure as ValidationFailure, + ignite_Vgpu as Vgpu, + ignite_VgpuType as VgpuType, + ignite_VolumeDefinition as VolumeDefinition, + ignite_VolumeFormat as VolumeFormat, }; } @@ -1221,7 +1331,9 @@ export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { container_id: Id<'container'>; }> | Endpoint<'POST', '/v1/ignite/deployments', { deployment: Deployment; -}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { +}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty | { + container: Container; +}> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { logs: ContainerLog[]; }> | Endpoint<'GET', '/v1/ignite/deployments/search', { deployment: Deployment; @@ -1244,7 +1356,9 @@ export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { name: string; }> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { deployment: Deployment; -}, DeploymentConfig> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { +}, Partial> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', { + deployment: Deployment; +}, Partial> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { rollout: DeploymentRollout; }> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/health-check', { health_check: HealthCheck; @@ -1308,13 +1422,27 @@ export interface MemberRole { // @public export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; +// @public +export interface NixPlan { + // (undocumented) + cmds: { + build: string | null; + start: string | null; + install: string | null; + }; + // (undocumented) + language: string | null; + // (undocumented) + pkgs: string[] | null; +} + // @public export function parseSize(size: string): number; // @public export type PartialAPIOptions = Partial> & Pick; -// @public (undocumented) +// @public export interface PAT { created_at: Timestamp; id: Id<'pat'>; @@ -1323,6 +1451,11 @@ export interface PAT { pat: string; } +// @public (undocumented) +export type PathsFor = Extract['path']; + // @public export const permissions: { add(value: bigint, flag: bigint): bigint; @@ -1383,9 +1516,9 @@ export const permissionsMap: { // @public (undocumented) export namespace Pipe { { - pipe$1_DeliveryProtocol as DeliveryProtocol, - pipe$1_PipeEndpoints as PipeEndpoints, - pipe$1_Room as Room, + pipe_DeliveryProtocol as DeliveryProtocol, + pipe_PipeEndpoints as PipeEndpoints, + pipe_Room as Room, }; } @@ -1404,7 +1537,7 @@ export type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { wcl_delay: number; artificial_delay: number; max_playout_bitrate_preset: string; - }; + } | undefined; }> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; // @public (undocumented) @@ -1523,17 +1656,17 @@ export enum PROJECT_PERMISSION { // @public (undocumented) export namespace Projects { { - projects$1_DefaultQuotas as DefaultQuotas, - projects$1_Member as Member, - projects$1_MemberRole as MemberRole, - projects$1_Project as Project, - projects$1_ProjectTier as ProjectTier, - projects$1_ProjectToken as ProjectToken, - projects$1_ProjectType as ProjectType, - projects$1_ProjectsEndpoints as ProjectsEndpoints, - projects$1_QuotaOverrides as QuotaOverrides, - projects$1_QuotaUsage as QuotaUsage, - projects$1_Secret as Secret, + projects_DefaultQuotas as DefaultQuotas, + projects_Member as Member, + projects_MemberRole as MemberRole, + projects_Project as Project, + projects_ProjectTier as ProjectTier, + projects_ProjectToken as ProjectToken, + projects_ProjectType as ProjectType, + projects_ProjectsEndpoints as ProjectsEndpoints, + projects_QuotaOverrides as QuotaOverrides, + projects_QuotaUsage as QuotaUsage, + projects_Secret as Secret, }; } @@ -1618,7 +1751,7 @@ export enum Regions { // @public (undocumented) export namespace Registry { { - registry$1_RegistryEndpoints as RegistryEndpoints, + registry_RegistryEndpoints as RegistryEndpoints, }; } @@ -1691,18 +1824,6 @@ export enum RuntimeType { STATEFUL = "stateful" } -// @public (undocumented) -export namespace sdks { - { - index_channels as channels, - index_ignite as ignite, - index_pipe as pipe, - index_projects as projects, - index_registry as registry, - index_users as users, - }; -} - // @public (undocumented) export interface Secret { created_at: Timestamp; @@ -1712,10 +1833,19 @@ export interface Secret { name: string; } +// @public +export interface SelfUser extends User { + admin: boolean; + email_verified: boolean; + mfa_enabled: boolean; + totp_enabled: boolean; + webauthn_enabled: boolean; +} + // @public export type State = Record; -// @public (undocumented) +// @public export type SuccessfulAPIResponse = { success: true; data: T; @@ -1743,10 +1873,10 @@ export interface User { username: string; } -// @public (undocumented) +// @public export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { projects: Project[]; - user: User; + user: SelfUser; project_member_role_map: Record, MemberRole>; leap_token: string | null; }> | Endpoint<'POST', '/v1/users/@me/pats', { @@ -1758,11 +1888,12 @@ export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { }> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; // @public (undocumented) -export namespace users { +export namespace Users { { - users$1_PAT as PAT, - users$1_User as User, - users$1_UserEndpoints as UserEndpoints, + users_PAT as PAT, + users_SelfUser as SelfUser, + users_User as User, + users_UserEndpoints as UserEndpoints, }; } @@ -1775,6 +1906,14 @@ export function validateId(maybeId: string | // @public export function validateIdPrefix(prefix: string, expect?: T): prefix is T; +// @public +export interface ValidationFailure { + // (undocumented) + help_link: string | null; + // (undocumented) + reason: string; +} + // @internal export type _Values = T[keyof T]; @@ -1807,7 +1946,7 @@ export enum VolumeFormat { // Warnings were encountered during analysis: // -// dist/index.d.ts:2103:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts +// dist/index.d.ts:759:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts // (No @packageDocumentation comment for this package) diff --git a/yarn.lock b/yarn.lock index 94e0d080..9fc83dec 100644 --- a/yarn.lock +++ b/yarn.lock @@ -494,6 +494,58 @@ __metadata: languageName: node linkType: hard +"@microsoft/api-extractor-model@npm:7.26.4": + version: 7.26.4 + resolution: "@microsoft/api-extractor-model@npm:7.26.4" + dependencies: + "@microsoft/tsdoc": 0.14.2 + "@microsoft/tsdoc-config": ~0.16.1 + "@rushstack/node-core-library": 3.55.2 + checksum: 0b27f9b248396422f3044f2472d86c111a6a4d34b4fd2c67d9995e96e5b144ec41ac35dbf2a005f144766814b824518bc42b424d93e3075d3dc1b17c2f8791d6 + languageName: node + linkType: hard + +"@microsoft/api-extractor@npm:^7.34.4": + version: 7.34.4 + resolution: "@microsoft/api-extractor@npm:7.34.4" + dependencies: + "@microsoft/api-extractor-model": 7.26.4 + "@microsoft/tsdoc": 0.14.2 + "@microsoft/tsdoc-config": ~0.16.1 + "@rushstack/node-core-library": 3.55.2 + "@rushstack/rig-package": 0.3.18 + "@rushstack/ts-command-line": 4.13.2 + colors: ~1.2.1 + lodash: ~4.17.15 + resolve: ~1.22.1 + semver: ~7.3.0 + source-map: ~0.6.1 + typescript: ~4.8.4 + bin: + api-extractor: bin/api-extractor + checksum: 855a04237e30f425553aab661b77bc0cbeb493510d769691d713e5bfdf02439fa7bc2076750271d154237f8c9d4451b209f30724c9ee2a2c4ea307c5db093d42 + languageName: node + linkType: hard + +"@microsoft/tsdoc-config@npm:~0.16.1": + version: 0.16.2 + resolution: "@microsoft/tsdoc-config@npm:0.16.2" + dependencies: + "@microsoft/tsdoc": 0.14.2 + ajv: ~6.12.6 + jju: ~1.4.0 + resolve: ~1.19.0 + checksum: 12b0d703154076bcaac75ca42e804e4fc292672396441e54346d7eadd0d6b57f90980eda2b1bab89b224af86da34a2389f9054002e282011e795ca5919a4386f + languageName: node + linkType: hard + +"@microsoft/tsdoc@npm:0.14.2": + version: 0.14.2 + resolution: "@microsoft/tsdoc@npm:0.14.2" + checksum: b167c89e916ba73ee20b9c9d5dba6aa3a0de25ed3d50050e8a344dca7cd43cb2e1059bd515c820369b6e708901dd3fda476a42bc643ca74a35671ce77f724a3a + languageName: node + linkType: hard + "@nodelib/fs.scandir@npm:2.1.5": version: 2.1.5 resolution: "@nodelib/fs.scandir@npm:2.1.5" @@ -546,6 +598,7 @@ __metadata: resolution: "@onehop/js@workspace:." dependencies: "@changesets/cli": 2.26.0 + "@microsoft/api-extractor": ^7.34.4 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.1.0 "@types/node": 18.15.0 @@ -570,6 +623,48 @@ __metadata: languageName: node linkType: hard +"@rushstack/node-core-library@npm:3.55.2": + version: 3.55.2 + resolution: "@rushstack/node-core-library@npm:3.55.2" + dependencies: + colors: ~1.2.1 + fs-extra: ~7.0.1 + import-lazy: ~4.0.0 + jju: ~1.4.0 + resolve: ~1.22.1 + semver: ~7.3.0 + z-schema: ~5.0.2 + peerDependencies: + "@types/node": "*" + peerDependenciesMeta: + "@types/node": + optional: true + checksum: b6b289315cd6a3544471f534405479b7c80f3906b7506590d5eb83a605a0a5b65861bf678f3e6c2277c8db116b8e05f8e7b6864fdc75e0f1514c9ff224b83fe6 + languageName: node + linkType: hard + +"@rushstack/rig-package@npm:0.3.18": + version: 0.3.18 + resolution: "@rushstack/rig-package@npm:0.3.18" + dependencies: + resolve: ~1.22.1 + strip-json-comments: ~3.1.1 + checksum: 41e719fb14d99e0f79093523fede051dba2be5f53d63d5ae45c2ea1b8448e298e0303d8453be3f9ac5e8bb99e3dcf3ddbe4cc59d9be5eddb914286acbdd0a2f3 + languageName: node + linkType: hard + +"@rushstack/ts-command-line@npm:4.13.2": + version: 4.13.2 + resolution: "@rushstack/ts-command-line@npm:4.13.2" + dependencies: + "@types/argparse": 1.0.38 + argparse: ~1.0.9 + colors: ~1.2.1 + string-argv: ~0.3.1 + checksum: 3938e533e08d5cf4007a651d1aab658a7a60d6136a56414e2370b64434657a5d5a9eff442da4ddc260d5e6dc90f82428de64dbcfa1285e9ae176629f7fcd821d + languageName: node + linkType: hard + "@tootallnate/once@npm:2": version: 2.0.0 resolution: "@tootallnate/once@npm:2.0.0" @@ -577,6 +672,13 @@ __metadata: languageName: node linkType: hard +"@types/argparse@npm:1.0.38": + version: 1.0.38 + resolution: "@types/argparse@npm:1.0.38" + checksum: 26ed7e3f1e3595efdb883a852f5205f971b798e4c28b7e30a32c5298eee596e8b45834ce831f014d250b9730819ab05acff5b31229666d3af4ba465b4697d0eb + languageName: node + linkType: hard + "@types/glob@npm:8.1.0": version: 8.1.0 resolution: "@types/glob@npm:8.1.0" @@ -675,6 +777,18 @@ __metadata: languageName: node linkType: hard +"ajv@npm:~6.12.6": + version: 6.12.6 + resolution: "ajv@npm:6.12.6" + dependencies: + fast-deep-equal: ^3.1.1 + fast-json-stable-stringify: ^2.0.0 + json-schema-traverse: ^0.4.1 + uri-js: ^4.2.2 + checksum: 874972efe5c4202ab0a68379481fbd3d1b5d0a7bd6d3cc21d40d3536ebff3352a2a1fabb632d4fd2cc7fe4cbdcd5ed6782084c9bbf7f32a1536d18f9da5007d4 + languageName: node + linkType: hard + "ansi-colors@npm:^4.1.1, ansi-colors@npm:^4.1.3": version: 4.1.3 resolution: "ansi-colors@npm:4.1.3" @@ -748,7 +862,7 @@ __metadata: languageName: node linkType: hard -"argparse@npm:^1.0.7": +"argparse@npm:^1.0.7, argparse@npm:~1.0.9": version: 1.0.10 resolution: "argparse@npm:1.0.10" dependencies: @@ -1067,6 +1181,13 @@ __metadata: languageName: node linkType: hard +"colors@npm:~1.2.1": + version: 1.2.5 + resolution: "colors@npm:1.2.5" + checksum: b6e23de735f68b72d5cdf6fd854ca43d1b66d82dcf54bda0b788083b910164a040f2c4edf23c670d36a7a2d8f1b7d6e62e3292703e4642691e6ccaa1c62d8f74 + languageName: node + linkType: hard + "commander@npm:^4.0.0": version: 4.1.1 resolution: "commander@npm:4.1.1" @@ -1074,6 +1195,13 @@ __metadata: languageName: node linkType: hard +"commander@npm:^9.4.1": + version: 9.5.0 + resolution: "commander@npm:9.5.0" + checksum: c7a3e27aa59e913b54a1bafd366b88650bc41d6651f0cbe258d4ff09d43d6a7394232a4dadd0bf518b3e696fdf595db1028a0d82c785b88bd61f8a440cecfade + languageName: node + linkType: hard + "concat-map@npm:0.0.1": version: 0.0.1 resolution: "concat-map@npm:0.0.1" @@ -1493,6 +1621,13 @@ __metadata: languageName: node linkType: hard +"fast-deep-equal@npm:^3.1.1": + version: 3.1.3 + resolution: "fast-deep-equal@npm:3.1.3" + checksum: e21a9d8d84f53493b6aa15efc9cfd53dd5b714a1f23f67fb5dc8f574af80df889b3bce25dc081887c6d25457cce704e636395333abad896ccdec03abaf1f3f9d + languageName: node + linkType: hard + "fast-glob@npm:^3.2.9": version: 3.2.12 resolution: "fast-glob@npm:3.2.12" @@ -1506,6 +1641,13 @@ __metadata: languageName: node linkType: hard +"fast-json-stable-stringify@npm:^2.0.0": + version: 2.1.0 + resolution: "fast-json-stable-stringify@npm:2.1.0" + checksum: b191531e36c607977e5b1c47811158733c34ccb3bfde92c44798929e9b4154884378536d26ad90dfecd32e1ffc09c545d23535ad91b3161a27ddbb8ebe0cbecb + languageName: node + linkType: hard + "fastq@npm:^1.6.0": version: 1.15.0 resolution: "fastq@npm:1.15.0" @@ -1563,7 +1705,7 @@ __metadata: languageName: node linkType: hard -"fs-extra@npm:^7.0.1": +"fs-extra@npm:^7.0.1, fs-extra@npm:~7.0.1": version: 7.0.1 resolution: "fs-extra@npm:7.0.1" dependencies: @@ -1989,6 +2131,13 @@ __metadata: languageName: node linkType: hard +"import-lazy@npm:~4.0.0": + version: 4.0.0 + resolution: "import-lazy@npm:4.0.0" + checksum: 22f5e51702134aef78890156738454f620e5fe7044b204ebc057c614888a1dd6fdf2ede0fdcca44d5c173fd64f65c985f19a51775b06967ef58cc3d26898df07 + languageName: node + linkType: hard + "imurmurhash@npm:^0.1.4": version: 0.1.4 resolution: "imurmurhash@npm:0.1.4" @@ -2109,7 +2258,7 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.9.0": +"is-core-module@npm:^2.1.0, is-core-module@npm:^2.9.0": version: 2.11.0 resolution: "is-core-module@npm:2.11.0" dependencies: @@ -2276,6 +2425,13 @@ __metadata: languageName: node linkType: hard +"jju@npm:~1.4.0": + version: 1.4.0 + resolution: "jju@npm:1.4.0" + checksum: 3790481bd2b7827dd6336e6e3dc2dcc6d425679ba7ebde7b679f61dceb4457ea0cda330972494de608571f4973c6dfb5f70fab6f3c5037dbab19ac449a60424f + languageName: node + linkType: hard + "joycon@npm:^3.0.1": version: 3.1.1 resolution: "joycon@npm:3.1.1" @@ -2309,6 +2465,13 @@ __metadata: languageName: node linkType: hard +"json-schema-traverse@npm:^0.4.1": + version: 0.4.1 + resolution: "json-schema-traverse@npm:0.4.1" + checksum: 7486074d3ba247769fda17d5181b345c9fb7d12e0da98b22d1d71a5db9698d8b4bd900a3ec1a4ffdd60846fc2556274a5c894d0c48795f14cb03aeae7b55260b + languageName: node + linkType: hard + "jsonc-parser@npm:^3.2.0": version: 3.2.0 resolution: "jsonc-parser@npm:3.2.0" @@ -2393,6 +2556,20 @@ __metadata: languageName: node linkType: hard +"lodash.get@npm:^4.4.2": + version: 4.4.2 + resolution: "lodash.get@npm:4.4.2" + checksum: e403047ddb03181c9d0e92df9556570e2b67e0f0a930fcbbbd779370972368f5568e914f913e93f3b08f6d492abc71e14d4e9b7a18916c31fa04bd2306efe545 + languageName: node + linkType: hard + +"lodash.isequal@npm:^4.5.0": + version: 4.5.0 + resolution: "lodash.isequal@npm:4.5.0" + checksum: da27515dc5230eb1140ba65ff8de3613649620e8656b19a6270afe4866b7bd461d9ba2ac8a48dcc57f7adac4ee80e1de9f965d89d4d81a0ad52bb3eec2609644 + languageName: node + linkType: hard + "lodash.sortby@npm:^4.7.0": version: 4.7.0 resolution: "lodash.sortby@npm:4.7.0" @@ -2407,6 +2584,13 @@ __metadata: languageName: node linkType: hard +"lodash@npm:~4.17.15": + version: 4.17.21 + resolution: "lodash@npm:4.17.21" + checksum: eb835a2e51d381e561e508ce932ea50a8e5a68f4ebdd771ea240d3048244a8d13658acbd502cd4829768c56f2e16bdd4340b9ea141297d472517b83868e677f7 + languageName: node + linkType: hard + "lru-cache@npm:^4.0.1": version: 4.1.5 resolution: "lru-cache@npm:4.1.5" @@ -2972,7 +3156,7 @@ __metadata: languageName: node linkType: hard -"path-parse@npm:^1.0.7": +"path-parse@npm:^1.0.6, path-parse@npm:^1.0.7": version: 1.0.7 resolution: "path-parse@npm:1.0.7" checksum: 49abf3d81115642938a8700ec580da6e830dde670be21893c62f4e10bd7dd4c3742ddc603fe24f898cba7eb0c6bc1777f8d9ac14185d34540c6d4d80cd9cae8a @@ -3214,7 +3398,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.10.0": +"resolve@npm:^1.10.0, resolve@npm:~1.22.1": version: 1.22.1 resolution: "resolve@npm:1.22.1" dependencies: @@ -3227,7 +3411,17 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@^1.10.0#~builtin": +"resolve@npm:~1.19.0": + version: 1.19.0 + resolution: "resolve@npm:1.19.0" + dependencies: + is-core-module: ^2.1.0 + path-parse: ^1.0.6 + checksum: a05b356e47b85ad3613d9e2a39a824f3c27f4fcad9c9ff6c7cc71a2e314c5904a90ab37481ad0069d03cab9eaaac6eb68aca1bc3355fdb05f1045cd50e2aacea + languageName: node + linkType: hard + +"resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@~1.22.1#~builtin": version: 1.22.1 resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=c3c19d" dependencies: @@ -3240,6 +3434,16 @@ __metadata: languageName: node linkType: hard +"resolve@patch:resolve@~1.19.0#~builtin": + version: 1.19.0 + resolution: "resolve@patch:resolve@npm%3A1.19.0#~builtin::version=1.19.0&hash=c3c19d" + dependencies: + is-core-module: ^2.1.0 + path-parse: ^1.0.6 + checksum: 2443b94d347e6946c87c85faf13071f605e609e0b54784829b0ed2b917d050bfc1cbaf4ecc6453f224cfa7d0c5dcd97cbb273454cd210bee68e4af15c1a5abc9 + languageName: node + linkType: hard + "retry@npm:^0.12.0": version: 0.12.0 resolution: "retry@npm:0.12.0" @@ -3322,7 +3526,7 @@ __metadata: languageName: node linkType: hard -"semver@npm:^7.3.5": +"semver@npm:^7.3.5, semver@npm:~7.3.0": version: 7.3.8 resolution: "semver@npm:7.3.8" dependencies: @@ -3472,7 +3676,7 @@ __metadata: languageName: node linkType: hard -"source-map@npm:^0.6.0, source-map@npm:^0.6.1": +"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1": version: 0.6.1 resolution: "source-map@npm:0.6.1" checksum: 59ce8640cf3f3124f64ac289012c2b8bd377c238e316fb323ea22fbfe83da07d81e000071d7242cad7a23cd91c7de98e4df8830ec3f133cb6133a5f6e9f67bc2 @@ -3548,6 +3752,13 @@ __metadata: languageName: node linkType: hard +"string-argv@npm:~0.3.1": + version: 0.3.1 + resolution: "string-argv@npm:0.3.1" + checksum: efbd0289b599bee808ce80820dfe49c9635610715429c6b7cc50750f0437e3c2f697c81e5c390208c13b5d5d12d904a1546172a88579f6ee5cbaaaa4dc9ec5cf + languageName: node + linkType: hard + "string-width@npm:^1.0.2 || 2 || 3 || 4, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.3": version: 4.2.3 resolution: "string-width@npm:4.2.3" @@ -3622,6 +3833,13 @@ __metadata: languageName: node linkType: hard +"strip-json-comments@npm:~3.1.1": + version: 3.1.1 + resolution: "strip-json-comments@npm:3.1.1" + checksum: 492f73e27268f9b1c122733f28ecb0e7e8d8a531a6662efbd08e22cccb3f9475e90a1b82cab06a392f6afae6d2de636f977e231296400d0ec5304ba70f166443 + languageName: node + linkType: hard + "sucrase@npm:^3.20.3": version: 3.29.0 resolution: "sucrase@npm:3.29.0" @@ -3908,6 +4126,16 @@ __metadata: languageName: node linkType: hard +"typescript@npm:~4.8.4": + version: 4.8.4 + resolution: "typescript@npm:4.8.4" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: 3e4f061658e0c8f36c820802fa809e0fd812b85687a9a2f5430bc3d0368e37d1c9605c3ce9b39df9a05af2ece67b1d844f9f6ea8ff42819f13bcb80f85629af0 + languageName: node + linkType: hard + "typescript@patch:typescript@next#~builtin": version: 5.1.0-dev.20230311 resolution: "typescript@patch:typescript@npm%3A5.1.0-dev.20230311#~builtin::version=5.1.0-dev.20230311&hash=1f5320" @@ -3918,6 +4146,16 @@ __metadata: languageName: node linkType: hard +"typescript@patch:typescript@~4.8.4#~builtin": + version: 4.8.4 + resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=1a91c8" + bin: + tsc: bin/tsc + tsserver: bin/tsserver + checksum: c981e82b77a5acdcc4e69af9c56cdecf5b934a87a08e7b52120596701e389a878b8e3f860e73ffb287bf649cc47a8c741262ce058148f71de4cdd88bb9c75153 + languageName: node + linkType: hard + "uglify-js@npm:^3.1.4": version: 3.17.4 resolution: "uglify-js@npm:3.17.4" @@ -3964,6 +4202,15 @@ __metadata: languageName: node linkType: hard +"uri-js@npm:^4.2.2": + version: 4.4.1 + resolution: "uri-js@npm:4.4.1" + dependencies: + punycode: ^2.1.0 + checksum: 7167432de6817fe8e9e0c9684f1d2de2bb688c94388f7569f7dbdb1587c9f4ca2a77962f134ec90be0cc4d004c939ff0d05acc9f34a0db39a3c797dada262633 + languageName: node + linkType: hard + "util-deprecate@npm:^1.0.1": version: 1.0.2 resolution: "util-deprecate@npm:1.0.2" @@ -3981,6 +4228,13 @@ __metadata: languageName: node linkType: hard +"validator@npm:^13.7.0": + version: 13.9.0 + resolution: "validator@npm:13.9.0" + checksum: e2c936f041f61faa42bafd17c6faddf939498666cd82e88d733621c286893730b008959f4cb12ab3e236148a4f3805c30b85e3dcf5e0efd8b0cbcd36c02bfc0c + languageName: node + linkType: hard + "vscode-oniguruma@npm:^1.7.0": version: 1.7.0 resolution: "vscode-oniguruma@npm:1.7.0" @@ -4243,6 +4497,23 @@ __metadata: languageName: node linkType: hard +"z-schema@npm:~5.0.2": + version: 5.0.5 + resolution: "z-schema@npm:5.0.5" + dependencies: + commander: ^9.4.1 + lodash.get: ^4.4.2 + lodash.isequal: ^4.5.0 + validator: ^13.7.0 + dependenciesMeta: + commander: + optional: true + bin: + z-schema: bin/z-schema + checksum: 8a1d66817ae4384dc3f63311f0cccaadd95cc9640eaade5fd3fbf91aa80d6bb82fb95d9b9171fa82ac371a0155b32b7f5f77bbe84dabaca611b66f74c628f0b8 + languageName: node + linkType: hard + "zod@npm:^3.21.4": version: 3.21.4 resolution: "zod@npm:3.21.4" From e3ed0d29a71bd316b0419af835a3026a358a02c9 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sat, 11 Mar 2023 19:10:53 +0000 Subject: [PATCH 20/33] changes --- src/rest/types/ignite.ts | 60 ++++++++++++++++++++++++++++++++++++---- src/sdks/ignite.ts | 4 +-- temp/js.api.md | 26 +++++++++++------ 3 files changed, 73 insertions(+), 17 deletions(-) diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 4b3644df..8236f96e 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -9,12 +9,17 @@ import type { } from '../../util/types.ts'; import type {Endpoint} from '../endpoints.ts'; +/** + * All regions that Hop operates in + * @public + */ export enum Regions { US_EAST_1 = 'us-east-1', } /** * Runtime types are used to describe the type of a deployment or container + * @public */ export enum RuntimeType { /** @@ -34,7 +39,8 @@ export enum RuntimeType { } /** - * Container state is relatively self-explanatory. It describes what the container is currently doing. + * An enum of states a container can be in + * @public */ export enum ContainerState { /** @@ -70,6 +76,7 @@ export enum ContainerState { /** * Rollout state for deployments + * @public */ export enum RolloutState { PENDING = 'pending', @@ -79,6 +86,7 @@ export enum RolloutState { /** * Restart policy for deployments + * @public */ export enum RestartPolicy { NEVER = 'never', @@ -88,16 +96,25 @@ export enum RestartPolicy { /** * Types for supported GPU + * @public */ export enum VgpuType { A400 = 'a400', } +/** + * Formats of volumes + * @public + */ export enum VolumeFormat { EXT4 = 'ext4', XFS = 'xfs', } +/** + * A definition of a volume + * @public + */ export interface VolumeDefinition { /** * The format of the volume @@ -115,6 +132,10 @@ export interface VolumeDefinition { mount_path: string; } +/** + * The definition of a container + * @public + */ export interface Container { /** * The ID of the container @@ -193,6 +214,10 @@ export interface Container { state: ContainerState; } +/** + * A definition of a deployment + * @public + */ export interface Deployment { /** * The ID of the deployment @@ -254,7 +279,7 @@ export interface Deployment { /** * Metadata for deployment */ - metadata: DeploymentMetaData | null; + metadata: DeploymentMetadata | null; /** * Build cache settings for deployment @@ -267,6 +292,10 @@ export interface Deployment { build_settings?: BuildSettings; } +/** + * A definition of a build's settings + * @public + */ export interface BuildSettings { /** * Root directory for build @@ -274,17 +303,28 @@ export interface BuildSettings { root_directory?: string; } -export interface DeploymentMetaData { +/** + * Deployment metadata + * @public + */ +export interface DeploymentMetadata { container_port_mappings: Record, string[]>; ignored_boarding?: boolean; created_from_preset?: string; created_first_gateway?: boolean; } +/** + * Deployment metadata + * @deprecated Use DeploymentMetadata. This will be removed in a future release + */ +export type DeploymentMetaData = DeploymentMetadata; + /** * Metadata attached to a build + * @public */ -export interface BuildMetaData { +export interface BuildMetadata { /** * Account type of repo owner */ @@ -336,8 +376,15 @@ export interface BuildMetaData { commit_url?: string; } +/** + * Metadata attached to a build + * @deprecated Use BuildMetadata. This will be removed in a future release + */ +export type BuildMetaData = BuildMetadata; + /** * The inferred environment type of a build + * @public */ export enum BuildEnvironmentType { NIXPACKS = 'nixpacks', @@ -346,6 +393,7 @@ export enum BuildEnvironmentType { /** * The validated nixpacks plan for this build + * @public */ export interface NixPlan { language: string | null; @@ -394,7 +442,7 @@ export interface Build { /** * Metadata pertaining to build (mostly for GitHub) */ - metadata: BuildMetaData | null; + metadata: BuildMetadata | null; /** * Build method (GitHub or CLI) @@ -1000,7 +1048,7 @@ export type IgniteEndpoints = 'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', {deployment: Deployment}, - Partial + Partial > | Endpoint< 'POST', diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 80bcbc4b..00c583f7 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -3,7 +3,7 @@ import {API, Id, assertId} from '../rest/index.ts'; import { Deployment, DeploymentConfig, - DeploymentMetaData, + DeploymentMetadata, Gateway, GatewayType, RuntimeType, @@ -479,7 +479,7 @@ export const ignite = sdk(client => { async patchMetadata( deploymentId: Id<'deployment'>, - metadata: Partial, + metadata: Partial, ) { const {deployment} = await client.patch( '/v1/ignite/deployments/:deployment_id/metadata', diff --git a/temp/js.api.md b/temp/js.api.md index 9a57a99a..29cba799 100644 --- a/temp/js.api.md +++ b/temp/js.api.md @@ -257,6 +257,8 @@ export class APIClient { path: Path; method: 'PATCH'; }>)["res"]>; + // Warning: (ae-incompatible-release-tags) The symbol "post" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal + // // (undocumented) post; @@ -511,7 +513,7 @@ export interface BuildSettings { root_directory?: string; } -// @public (undocumented) +// @public export enum BuildState { // (undocumented) CANCELLED = "cancelled", @@ -671,7 +673,9 @@ export enum ContainerStrategy { MANUAL = "manual" } -// @public (undocumented) +// Warning: (ae-internal-missing-underscore) The name "CreateDeploymentConfig" should be prefixed with an underscore because the declaration is marked as @internal +// +// @internal export type CreateDeploymentConfig = MakeOptional; // @public @@ -709,7 +713,7 @@ export interface Deployment { target_container_count: number; } -// @public (undocumented) +// @public export interface DeploymentConfig { cmd?: string[]; container_strategy: ContainerStrategy; @@ -750,7 +754,7 @@ export type DeploymentRollout = { acknowledged: boolean; }; -// @public (undocumented) +// @public export interface Domain { created_at: Timestamp; domain: string; @@ -759,7 +763,7 @@ export interface Domain { state: DomainState; } -// @public (undocumented) +// @public export interface DomainRedirect { // (undocumented) status_code: 301 | 302 | 307 | 308; @@ -767,7 +771,7 @@ export interface DomainRedirect { url: string; } -// @public (undocumented) +// @public export enum DomainState { // (undocumented) PENDING = "pending", @@ -855,7 +859,7 @@ export interface GHRepo { // @public export function gigabytes(size: number): ByteSizeString; -// @public (undocumented) +// @public export type HealthCheck = { id: Id<'health_check'>; protocol: 'http'; @@ -1319,7 +1323,9 @@ export namespace Ignite { }; } -// @public (undocumented) +// Warning: (ae-incompatible-release-tags) The symbol "IgniteEndpoints" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal +// +// @public export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { deployments: Deployment[]; }> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { @@ -1946,6 +1952,8 @@ export enum VolumeFormat { // Warnings were encountered during analysis: // +// dist/index.d.ts:527:17 - (ae-incompatible-release-tags) The symbol "__call" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal +// dist/index.d.ts:548:17 - (ae-incompatible-release-tags) The symbol "__call" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal // dist/index.d.ts:759:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts // (No @packageDocumentation comment for this package) From e93b953c76aeceaa1236a636bf32278c6eef94e4 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sat, 11 Mar 2023 19:14:10 +0000 Subject: [PATCH 21/33] remove temp --- temp/js.api.md | 1961 ------------------------------------------------ 1 file changed, 1961 deletions(-) delete mode 100644 temp/js.api.md diff --git a/temp/js.api.md b/temp/js.api.md deleted file mode 100644 index 29cba799..00000000 --- a/temp/js.api.md +++ /dev/null @@ -1,1961 +0,0 @@ -## API Report File for "@onehop/js" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -// @public -export type AnyId = Id; - -// @public (undocumented) -export namespace API { - { - channels as Channels, - ignite as Ignite, - pipe as Pipe, - projects as Projects, - registry as Registry, - users as Users, - }; -} - -// @public -export type APIAuthentication = Id; - -// @public -export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; - -// @public -export class APIClient { - constructor(options: APIClientOptions); - // (undocumented) - readonly authType: APIAuthenticationPrefix; - // (undocumented) - delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }>)["res"]>; - // (undocumented) - get>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; - leap_token: string | null; - }>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract | null>>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }>)["res"]>; - // (undocumented) - static getAuthType(auth: APIAuthentication): APIAuthenticationPrefix; - // (undocumented) - patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }> | Extract>, { - path: Path; - method: 'PATCH'; - }> | Extract>, { - path: Path; - method: 'PATCH'; - }> | Extract>>, { - path: Path; - method: 'PATCH'; - }>)["res"]>; - // Warning: (ae-incompatible-release-tags) The symbol "post" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal - // - // (undocumented) - post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract | null; - }>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }>)["res"]>; - // (undocumented) - put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract | null; - }>, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }>)["res"]>; - // (undocumented) - raw(request: Request): Promise; - // (undocumented) - readonly url: (path: Path, query: Query) => string; -} - -// @public -export interface APIClientOptions { - // (undocumented) - readonly authentication: APIAuthentication; - // (undocumented) - readonly baseUrl: string; -} - -// @public -export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; - -// @public -export function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; - -// @public -export interface Auth { - // (undocumented) - password: string; - // (undocumented) - username: string; -} - -// @public -export const BROAD_PERMISSIONS_MAP: { - MANAGE_MEMBERS: bigint; - MANAGE_PROJECT_TOKENS: bigint; - MANAGE_DEPLOYMENTS: bigint; - MANAGE_PIPE: bigint; - MANAGE_SECRETS: bigint; - MANAGE_CHANNELS: bigint; - MANAGE_REGISTRY: bigint; - READ_ONLY: bigint; - MANAGE_QUOTAS: bigint; - MANAGE_ROLLOUTS: bigint; - MANAGE_BILLING: bigint; -}; - -// @public -export interface Build { - created_at?: Timestamp; - deployment_id: Id<'deployment'>; - digest: string | null; - environment: BuildEnvironment | null; - finished_at: Timestamp | null; - id: Id<'build'>; - metadata: BuildMetaData | null; - method: BuildMethod; - started_at: Timestamp | null; - state: BuildState; - validation_failure: ValidationFailure | null; -} - -// @public -export interface BuildEnvironment { - // (undocumented) - nix_plan?: NixPlan | null; - // (undocumented) - type: BuildEnvironmentType; -} - -// @public -export enum BuildEnvironmentType { - // (undocumented) - DOCKERFILE = "dockerfile", - // (undocumented) - NIXPACKS = "nixpacks" -} - -// @public -export interface BuildMetaData { - account_type?: 'user' | 'organization'; - author?: { - avatar_url: string; - username: string; - }; - branch: string; - commit_msg: string; - commit_sha: string; - commit_url?: string; - repo_id: number; - repo_name: string; -} - -// @public -export enum BuildMethod { - // (undocumented) - CLI = "cli", - // (undocumented) - GITHUB = "github" -} - -// @public (undocumented) -export interface BuildSettings { - root_directory?: string; -} - -// @public -export enum BuildState { - // (undocumented) - CANCELLED = "cancelled", - // (undocumented) - FAILED = "failed", - // (undocumented) - PENDING = "pending", - // (undocumented) - SUCCEEDED = "succeeded", - // (undocumented) - VALIDATING = "validating", - // (undocumented) - VALIDATION_FAILED = "validation_failed" -} - -// @public -export function bytes(size: number, unit?: ByteUnit): ByteSizeString; - -// @public -export type ByteSizeString = `${number}${ByteUnit}`; - -// @public @deprecated -export type ByteString = ByteSizeString; - -// @public -export type ByteUnit = typeof byteUnits[number]; - -// @public -export const byteUnits: readonly ["GB", "MB", "KB", "B"]; - -// @public -export interface Channel { - capabilities: number; - created_at: Timestamp; - id: string; - project: Project; - state: State; - type: ChannelType; -} - -// @public -export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'PUT', '/v1/channels/:channel_id', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'POST', '/v1/channels/tokens', { - token: ChannelToken; -}, { - state: State; -}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { - channel: Channel; -}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { - tokens: ChannelToken[]; -}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { - state: State; -}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'GET', '/v1/channels', { - channels: Channel[]; -}> | Endpoint<'GET', '/v1/channels/tokens/:token', { - token: ChannelToken; -}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { - token: ChannelToken; -}, { - expiresAt?: Timestamp | null; - state: ChannelToken['state']; -}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { - stats: { - online_count: number; - }; -}>; - -// @public (undocumented) -export namespace Channels { - { - channels_Channel as Channel, - channels_ChannelEndpoints as ChannelEndpoints, - channels_ChannelToken as ChannelToken, - channels_ChannelType as ChannelType, - channels_State as State, - }; -} - -// @public (undocumented) -export interface ChannelToken { - id: Id<'leap_token'>; - is_online: boolean; - project_id: Id<'project'>; - state: State; -} - -// @public -export enum ChannelType { - // (undocumented) - PRIVATE = "private", - // (undocumented) - PUBLIC = "public", - // (undocumented) - UNPROTECTED = "unprotected" -} - -// @public (undocumented) -export interface Container { - created_at: Timestamp; - deployment_id: Id<'deployment'>; - id: Id<'container'>; - internal_ip: string; - metadata: { - last_exit_code?: number; - }; - metrics: { - cpu_usage_percent: number; - memory_usage_percent: number; - } | null; - overrides: { - resources?: Partial; - } | null; - region: Regions; - state: ContainerState; - type: RuntimeType; - uptime: { - last_start: Timestamp; - }; - volume: VolumeDefinition | null; -} - -// @public -export interface ContainerLog { - level: 'info' | 'error'; - message: string; - nonce: string; - timestamp: Timestamp; -} - -// @public -export enum ContainerState { - EXITED = "exited", - FAILED = "failed", - PENDING = "pending", - RUNNING = "running", - STOPPED = "stopped", - TERMINATING = "terminating" -} - -// @public -export enum ContainerStrategy { - MANUAL = "manual" -} - -// Warning: (ae-internal-missing-underscore) The name "CreateDeploymentConfig" should be prefixed with an underscore because the declaration is marked as @internal -// -// @internal -export type CreateDeploymentConfig = MakeOptional; - -// @public -export const DEFAULT_BASE_URL = "https://api.hop.io"; - -// @public (undocumented) -export interface DefaultQuotas { - // (undocumented) - ram: number; - // (undocumented) - vcpu: number; - // (undocumented) - volume: number; -} - -// @public (undocumented) -export type DeliveryProtocol = 'webrtc' | 'hls'; - -// @public (undocumented) -export interface Deployment { - active_build: Build | null; - // @deprecated - active_rollout: DeploymentRollout | null; - build_cache_enabled: boolean; - build_id: Build['id'] | null; - build_settings?: BuildSettings; - config: Omit; - container_count: number; - created_at: Timestamp; - id: Id<'deployment'>; - latest_rollout: DeploymentRollout | null; - metadata: DeploymentMetaData | null; - name: string; - running_container_count: number; - target_container_count: number; -} - -// @public -export interface DeploymentConfig { - cmd?: string[]; - container_strategy: ContainerStrategy; - entrypoint?: string[]; - env: Record; - image: Image_2; - name: string; - resources: Resources; - restart_policy: RestartPolicy; - type: RuntimeType; - version: '12-12-2022'; - volume?: VolumeDefinition; -} - -// @public (undocumented) -export interface DeploymentMetaData { - // (undocumented) - container_port_mappings: Record, string[]>; - // (undocumented) - created_first_gateway?: boolean; - // (undocumented) - created_from_preset?: string; - // (undocumented) - ignored_boarding?: boolean; -} - -// @public -export type DeploymentRollout = { - id: Id<'rollout'>; - deployment_id: Id<'deployment'>; - count: number; - created_at: Timestamp; - state: RolloutState; - build: Build | null; - init_container_id: string | null; - health_check_failed: boolean; - last_updated_at: Timestamp; - acknowledged: boolean; -}; - -// @public -export interface Domain { - created_at: Timestamp; - domain: string; - id: Id<'domain'>; - redirect: DomainRedirect | null; - state: DomainState; -} - -// @public -export interface DomainRedirect { - // (undocumented) - status_code: 301 | 302 | 307 | 308; - // (undocumented) - url: string; -} - -// @public -export enum DomainState { - // (undocumented) - PENDING = "pending", - // (undocumented) - SSL_ACTIVE = "ssl_active", - // (undocumented) - VALID_CNAME = "valid_cname" -} - -// @public -export type Empty = void; - -// @public -export type Endpoint = { - method: M; - path: Path; - res: Res; - body: Body; -}; - -// @public -export type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; - -// @public -export type ErroredAPIResponse = { - success: false; - error: { - code: string; - message: string; - }; -}; - -// @public (undocumented) -export type ExtractEndpoint = Extract; - -// @public -export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { - [k in Param | keyof ExtractRouteParams]: string | number; -} : T extends `${string}:${infer Param}` ? { - [k in Param]: string | number; -} : {}; - -// @public -export interface Gateway { - created_at: Timestamp; - deployment_id: Id<'deployment'>; - domains: Domain[]; - hopsh_domain: HopShDomain | null; - hopsh_domain_enabled: boolean; - id: Id<'gateway'>; - internal_domain: InternalHopDomain | null; - name: string; - // @alpha - protocol: 'http' | null; - target_port: number | null; - type: GatewayType; -} - -// @public -export enum GatewayType { - EXTERNAL = "external", - INTERNAL = "internal" -} - -// @public -export function getIdPrefix(id: string, expect?: T): T; - -// @public -export interface GHRepo { - // (undocumented) - account_name: string; - // (undocumented) - default_branch: string; - // (undocumented) - full_name: string; - // (undocumented) - id: number; - // (undocumented) - private: boolean; -} - -// @public -export function gigabytes(size: number): ByteSizeString; - -// @public -export type HealthCheck = { - id: Id<'health_check'>; - protocol: 'http'; - path: string; - port: number; - interval: number; - timeout: number; - initial_delay: number; - max_retries: number; - created_at: Timestamp; -}; - -// @public -export class Hop { - constructor(options: PartialAPIOptions); - constructor(authentication: APIAuthentication, baseurl?: string); - // (undocumented) - readonly channels: { - create(type: ChannelType, id?: string | null | undefined, options?: { - state?: T; - } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - get(id: string): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - getAll(project?: `project_${string}` | undefined): Promise<(Channel & { - setState(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - })[]>; - subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; - subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - getAllTokens(channel: string | Channel): Promise; - setState(channel: string | Channel, state: SetStateAction): Promise; - patchState(channel: string | Channel, state: SetStateAction): Promise; - publishMessage(channel: string | Channel, event: string, data: T_5): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: `leap_token_${string}`): Promise; - create(state?: State, project?: `project_${string}` | undefined): Promise; - setState(id: `leap_token_${string}`, state: State): Promise; - get(id: `leap_token_${string}`): Promise; - isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; - publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; - }; - }; - // (undocumented) - readonly client: APIClient; - // (undocumented) - readonly ignite: { - domains: { - delete: (id: `domain_${string}`) => Promise; - get: (id: `domain_${string}`) => Promise; - }; - gateways: { - addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; - get(gatewayId: `gateway_${string}`): Promise; - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - }; - healthChecks: { - create: (deployment: `deployment_${string}`, config: Omit) => Promise; - update: (deployment: `deployment_${string}`, config: Partial>) => Promise; - }; - deployments: { - create: { - (configOrProject: `project_${string}`, bearerOrPatConfig: CreateDeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - (configOrProject: CreateDeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - }; - get: { - (name: string, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - }; - rollout(id: `deployment_${string}`): Promise; - getStorageStats(id: `deployment_${string}`): Promise | null>>; - update(deploymentId: `deployment_${string}`, config: Partial): Promise; - getContainers(deployment: `deployment_${string}`): Promise; - getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - })[]>; - delete(deployment: `deployment_${string}`): Promise; - patchMetadata(deploymentId: `deployment_${string}`, metadata: Partial): Promise; - gateways: { - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - }; - }; - containers: { - delete: { - (container_id: `container_${string}`, options: { - recreate: true; - }): Promise; - (container_id: `container_${string}`, options?: { - recreate?: false; - } | undefined): Promise; - }; - getLogs(container: `container_${string}`, options?: Partial<{ - sortBy: "timestamp"; - orderBy: "desc" | "asc"; - limit: number; - offset: number; - }>): Promise; - stop(container: `container_${string}`): Promise; - start(container: `container_${string}`): Promise; - create(deployment: `deployment_${string}`): Promise; - }; - }; - // (undocumented) - readonly pipe: { - rooms: { - getAll(project?: `project_${string}` | undefined): Promise<(Room & { - delete(): Promise; - })[]>; - create(name: string, options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean; - ingestProtocol: "rtmp" | "rtp"; - hlsConfig?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; - }): Promise; - }>; - delete(room: `pipe_room_${string}`): Promise; - }; - }; - // (undocumented) - readonly projects: { - getAllMembers(projectId?: `project_${string}` | undefined): Promise; - getCurrentMember(projectId: `project_${string}`): Promise; - projectTokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - tokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - secrets: { - getAll(projectId?: `project_${string}` | undefined): Promise; - create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; - delete(id: string, projectId?: `project_${string}` | undefined): Promise; - }; - }; - // (undocumented) - readonly registry: { - images: { - getAll(project?: `project_${string}` | undefined): Promise; - getManifest(image: string): Promise<{ - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]>; - delete(image: string): Promise; - }; - }; - // (undocumented) - readonly users: { - me: { - get(): Promise<{ - projects: Project[]; - user: SelfUser; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: `pat_${string}`): Promise; - }; - }; - }; -} - -// @public -export class HopAPIError extends Error { - constructor(request: Request, response: Response, data: ErroredAPIResponse); - // (undocumented) - readonly data: ErroredAPIResponse; - // (undocumented) - readonly request: Request; - // (undocumented) - readonly response: Response; - // (undocumented) - readonly status: number; -} - -// @public -export type HopShDomain = `${string}.hop.sh`; - -// @public -export type Id = `${T}_${string}`; - -// @public -export function id(maybeId: string | undefined | null, prefix?: T | T[]): Id; - -// @public -export const ID_PREFIXES: readonly [{ - readonly prefix: "user"; - readonly description: "Users"; -}, { - readonly prefix: "project"; - readonly description: "Project"; -}, { - readonly prefix: "pm"; - readonly description: "Project Members"; -}, { - readonly prefix: "role"; - readonly description: "Roles"; -}, { - readonly prefix: "pi"; - readonly description: "Project Invite"; -}, { - readonly prefix: "ptk"; - readonly description: "Project token"; -}, { - readonly prefix: "pat"; - readonly description: "User personal access token"; -}, { - readonly prefix: "container"; - readonly description: "Ignite container"; -}, { - readonly prefix: "pipe_room"; - readonly description: "Pipe room"; -}, { - readonly prefix: "deployment"; - readonly description: "Ignite deployment"; -}, { - readonly prefix: "bearer"; - readonly description: "Users bearer token"; -}, { - readonly prefix: "ptkid"; - readonly description: "Project token ID"; -}, { - readonly prefix: "secret"; - readonly description: "Project secret ID"; -}, { - readonly prefix: "gateway"; - readonly description: "Gateway"; -}, { - readonly prefix: "domain"; - readonly description: "Domain for a gateway"; -}, { - readonly prefix: "leap_token"; - readonly description: "Token for connecting to leap as a client"; -}, { - readonly prefix: "build"; - readonly description: "Build ID for build logs"; -}, { - readonly prefix: "rollout"; - readonly description: "Rollout ID for rollouts."; -}, { - readonly prefix: "health_check"; - readonly description: "Health check ID for health checks."; -}, { - readonly prefix: "session"; - readonly description: "Session ID for sessions on your account."; -}]; - -// @public -export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; - -// @public (undocumented) -export namespace Ignite { - { - ignite_Auth as Auth, - ignite_Build as Build, - ignite_BuildEnvironment as BuildEnvironment, - ignite_BuildEnvironmentType as BuildEnvironmentType, - ignite_BuildMetaData as BuildMetaData, - ignite_BuildMethod as BuildMethod, - ignite_BuildSettings as BuildSettings, - ignite_BuildState as BuildState, - ignite_Container as Container, - ignite_ContainerLog as ContainerLog, - ignite_ContainerState as ContainerState, - ignite_ContainerStrategy as ContainerStrategy, - ignite_CreateDeploymentConfig as CreateDeploymentConfig, - ignite_Deployment as Deployment, - ignite_DeploymentConfig as DeploymentConfig, - ignite_DeploymentMetaData as DeploymentMetaData, - ignite_DeploymentRollout as DeploymentRollout, - ignite_Domain as Domain, - ignite_DomainRedirect as DomainRedirect, - ignite_DomainState as DomainState, - ignite_GHRepo as GHRepo, - ignite_Gateway as Gateway, - ignite_GatewayType as GatewayType, - ignite_HealthCheck as HealthCheck, - ignite_IgniteEndpoints as IgniteEndpoints, - ignite_Image as Image, - ignite_ImageGHRepo as ImageGHRepo, - ignite_NixPlan as NixPlan, - ignite_Regions as Regions, - ignite_Resources as Resources, - ignite_RestartPolicy as RestartPolicy, - ignite_RolloutState as RolloutState, - ignite_RuntimeType as RuntimeType, - ignite_ValidationFailure as ValidationFailure, - ignite_Vgpu as Vgpu, - ignite_VgpuType as VgpuType, - ignite_VolumeDefinition as VolumeDefinition, - ignite_VolumeFormat as VolumeFormat, - }; -} - -// Warning: (ae-incompatible-release-tags) The symbol "IgniteEndpoints" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal -// -// @public -export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { - deployments: Deployment[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { - containers: Container[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { - container: Container; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { - deployment_id: Id<'deployment'>; - container_id: Id<'container'>; -}> | Endpoint<'POST', '/v1/ignite/deployments', { - deployment: Deployment; -}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty | { - container: Container; -}> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { - logs: ContainerLog[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/search', { - deployment: Deployment; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { - preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; -}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { - domain: string; -}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { - gateway: Gateway; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { - gateways: Gateway[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { - gateway: Gateway; -}, { - type: GatewayType; - target_port: number; - protocol: Gateway['protocol']; - name: string; -}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}, Partial> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', { - deployment: Deployment; -}, Partial> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { - rollout: DeploymentRollout; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/health-check', { - health_check: HealthCheck; -}, Omit> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/storage', Record<'volume' | 'build_cache', Record<'provisioned_size' | 'used_size', number> | null>> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', { - health_check: HealthCheck; -}, Partial>> | Endpoint<'DELETE', '/v1/ignite/domains/:domain_id', Empty> | Endpoint<'GET', '/v1/ignite/domains/:domain_id', { - domain: Domain; -}>; - -// @public -interface Image_2 { - auth: Auth | null; - gh_repo: ImageGHRepo | null; - name: string | null; -} -export { Image_2 as Image } - -// @public -export interface ImageGHRepo { - // (undocumented) - branch: string; - // (undocumented) - full_name: string; - // (undocumented) - repo_id: number; -} - -// @public -export type InternalHopDomain = `${string}.hop`; - -// @public -export const IS_BROWSER: boolean; - -// @public -export function isValidByteString(value: string): value is ByteSizeString; - -// @public -export function kilobytes(size: number): ByteSizeString; - -// @public -export type MakeOptional = Omit & Partial>; - -// @public -export function megabytes(size: number): ByteSizeString; - -// @public (undocumented) -export type Member = Omit & { - id: Id<'pm'>; - role: MemberRole; - mfa_enabled: boolean; - joined_at: Timestamp; -}; - -// @public (undocumented) -export interface MemberRole { - flags: number; - id: Id<'role'>; - name: string; -} - -// @public -export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; - -// @public -export interface NixPlan { - // (undocumented) - cmds: { - build: string | null; - start: string | null; - install: string | null; - }; - // (undocumented) - language: string | null; - // (undocumented) - pkgs: string[] | null; -} - -// @public -export function parseSize(size: string): number; - -// @public -export type PartialAPIOptions = Partial> & Pick; - -// @public -export interface PAT { - created_at: Timestamp; - id: Id<'pat'>; - name: string | null; - // @alpha - pat: string; -} - -// @public (undocumented) -export type PathsFor = Extract['path']; - -// @public -export const permissions: { - add(value: bigint, flag: bigint): bigint; - test(value: bigint, flag: bigint): boolean; - subtract(value: bigint, flag: bigint): bigint; -}; - -// @public -export const permissionsMap: { - add_member: bigint; - remove_member: bigint; - get_project_members: bigint; - delete_project: bigint; - delete_deployment: bigint; - delete_container: bigint; - update_container_state: bigint; - read_deployments: bigint; - create_deployment: bigint; - create_container: bigint; - update_container_config: bigint; - create_room: bigint; - read_room: bigint; - delete_room: bigint; - create_room_producer: bigint; - create_project_token: bigint; - delete_project_token: bigint; - read_project_tokens: bigint; - read_container_logs: bigint; - create_project_secret: bigint; - read_project_secrets: bigint; - delete_project_secret: bigint; - get_registry_images: bigint; - create_channel_token: bigint; - create_gateway: bigint; - add_domain: bigint; - delete_channels: bigint; - update_channel_state: bigint; - read_channels: bigint; - publish_channel_messages: bigint; - manage_channel_subscribers: bigint; - delete_domain: bigint; - delete_gateway: bigint; - get_internal_domain: bigint; - create_leap_token: bigint; - read_leap_tokens: bigint; - update_leap_token: bigint; - message_token: bigint; - create_channel: bigint; - rollout: bigint; - request_quota_increase: bigint; - read_billing: bigint; - read_gateways: bigint; - delete_registry_images: bigint; - container_ssh: bigint; - tunnel_deployment: bigint; -}; - -// @public (undocumented) -export namespace Pipe { - { - pipe_DeliveryProtocol as DeliveryProtocol, - pipe_PipeEndpoints as PipeEndpoints, - pipe_Room as Room, - }; -} - -// @public (undocumented) -export type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { - rooms: Room[]; -}> | Endpoint<'POST', '/v1/pipe/rooms', { - room: Room; -}, { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } | undefined; -}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; - -// @public (undocumented) -export interface Project { - created_at: Timestamp; - // (undocumented) - default_quotas: DefaultQuotas; - icon: string | null; - id: Id<'project'>; - name: string; - namespace: string; - // (undocumented) - quota_overrides: QuotaOverrides; - // (undocumented) - quota_usage: QuotaUsage; - tier: ProjectTier; - type: ProjectType; -} - -// @public -export enum PROJECT_PERMISSION { - // (undocumented) - ADD_DOMAIN = "add_domain", - // (undocumented) - ADD_MEMBER = "add_member", - // (undocumented) - CONTAINER_SSH = "container_ssh", - // (undocumented) - CREATE_CHANNEL = "create_channel", - // (undocumented) - CREATE_CHANNEL_TOKEN = "create_channel_token", - // (undocumented) - CREATE_CONTAINER = "create_container", - // (undocumented) - CREATE_DEPLOYMENT = "create_deployment", - // (undocumented) - CREATE_GATEWAY = "create_gateway", - // (undocumented) - CREATE_LEAP_TOKEN = "create_leap_token", - // (undocumented) - CREATE_PROJECT_SECRET = "create_project_secret", - // (undocumented) - CREATE_PROJECT_TOKEN = "create_project_token", - // (undocumented) - CREATE_ROOM = "create_room", - // (undocumented) - CREATE_ROOM_PRODUCER = "create_room_producer", - // (undocumented) - DELETE_CHANNELS = "delete_channels", - // (undocumented) - DELETE_CONTAINER = "delete_container", - // (undocumented) - DELETE_DEPLOYMENT = "delete_deployment", - // (undocumented) - DELETE_DOMAIN = "delete_domain", - // (undocumented) - DELETE_GATEWAY = "delete_gateway", - // (undocumented) - DELETE_PROJECT = "delete_project", - // (undocumented) - DELETE_PROJECT_SECRET = "delete_project_secret", - // (undocumented) - DELETE_PROJECT_TOKEN = "delete_project_token", - // (undocumented) - DELETE_REGISTRY_IMAGES = "delete_registry_images", - // (undocumented) - DELETE_ROOM = "delete_room", - // (undocumented) - GET_INTERNAL_DOMAIN = "get_internal_domain", - // (undocumented) - GET_PROJECT_MEMBERS = "get_project_members", - // (undocumented) - GET_REGISTRY_IMAGES = "get_registry_images", - // (undocumented) - MANAGE_CHANNEL_SUBSCRIBERS = "manage_channel_subscribers", - // (undocumented) - MESSAGE_TOKEN = "message_token", - // (undocumented) - PUBLISH_CHANNEL_MESSAGES = "publish_channel_messages", - // (undocumented) - READ_BILLING = "read_billing", - // (undocumented) - READ_CHANNELS = "read_channels", - // (undocumented) - READ_CONTAINER_LOGS = "read_container_logs", - // (undocumented) - READ_DEPLOYMENTS = "read_deployments", - // (undocumented) - READ_GATEWAYS = "read_gateways", - // (undocumented) - READ_LEAP_TOKENS = "read_leap_tokens", - // (undocumented) - READ_PROJECT_SECRETS = "read_project_secrets", - // (undocumented) - READ_PROJECT_TOKENS = "read_project_tokens", - // (undocumented) - READ_ROOM = "read_room", - // (undocumented) - REMOVE_MEMBER = "remove_member", - // (undocumented) - REQUEST_QUOTA_INCREASE = "request_quota_increase", - // (undocumented) - ROLLOUT = "rollout", - // (undocumented) - TUNNEL_DEPLOYMENT = "tunnel_deployment", - // (undocumented) - UPDATE_CHANNEL_STATE = "update_channel_state", - // (undocumented) - UPDATE_CONTAINER_CONFIG = "update_container_config", - // (undocumented) - UPDATE_CONTAINER_STATE = "update_container_state", - // (undocumented) - UPDATE_LEAP_TOKEN = "update_leap_token" -} - -// @public (undocumented) -export namespace Projects { - { - projects_DefaultQuotas as DefaultQuotas, - projects_Member as Member, - projects_MemberRole as MemberRole, - projects_Project as Project, - projects_ProjectTier as ProjectTier, - projects_ProjectToken as ProjectToken, - projects_ProjectType as ProjectType, - projects_ProjectsEndpoints as ProjectsEndpoints, - projects_QuotaOverrides as QuotaOverrides, - projects_QuotaUsage as QuotaUsage, - projects_Secret as Secret, - }; -} - -// @public (undocumented) -export type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { - project_member: Member; -}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/@this/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/:project_id/members', { - members: Member[]; -}> | Endpoint<'GET', '/v1/projects/@this/members', { - members: Member[]; -}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'POST', '/v1/projects/@this/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { - secrets: Secret[]; -}> | Endpoint<'GET', '/v1/projects/@this/secrets', { - secrets: Secret[]; -}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; - -// @public (undocumented) -export enum ProjectTier { - // (undocumented) - FREE = "free", - // (undocumented) - PAID = "paid" -} - -// @public -export interface ProjectToken { - created_at: Timestamp; - flags: number; - id: Id<'ptkid'>; - token: Id<'ptk'>; -} - -// @public -export enum ProjectType { - PERSONAL = "personal", - REGULAR = "regular" -} - -// @public -export type Query = ExtractRouteParams & Record; - -// @public (undocumented) -export interface QuotaOverrides { -} - -// @public (undocumented) -export interface QuotaUsage { - // (undocumented) - ram: number; - // (undocumented) - vcpu: number; - // (undocumented) - volume: number; -} - -// @public (undocumented) -export enum Regions { - // (undocumented) - US_EAST_1 = "us-east-1" -} - -// @public (undocumented) -export namespace Registry { - { - registry_RegistryEndpoints as RegistryEndpoints, - }; -} - -// @public (undocumented) -export type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { - images: string[]; -}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; -}>; - -// @public -export interface Resources { - ram: ByteSizeString; - vcpu: number; - vgpu: Vgpu[]; -} - -// @public -export enum RestartPolicy { - // (undocumented) - ALWAYS = "always", - // (undocumented) - NEVER = "never", - // (undocumented) - ON_FAILURE = "on-failure" -} - -// @public -export const roles: { - viewer: bigint; - editor: bigint; - admin: bigint; - owner: bigint; -}; - -// @public -export enum RolloutState { - // (undocumented) - FAILED = "failed", - // (undocumented) - FINISHED = "finished", - // (undocumented) - PENDING = "pending" -} - -// @public (undocumented) -export interface Room { - created_at: Timestamp; - delivery_protocols: DeliveryProtocol[]; - id: Id<'pipe_room'>; - ingest_endpoint: string; - ingest_protocol: 'rtmp'; - ingest_region: Regions; - join_token: string; - name: string; - state: 'live' | 'offline'; -} - -// @public -export enum RuntimeType { - EPHEMERAL = "ephemeral", - PERSISTENT = "persistent", - STATEFUL = "stateful" -} - -// @public (undocumented) -export interface Secret { - created_at: Timestamp; - digest: string; - id: Id<'secret'>; - in_use_by: Id<'deployment'>[]; - name: string; -} - -// @public -export interface SelfUser extends User { - admin: boolean; - email_verified: boolean; - mfa_enabled: boolean; - totp_enabled: boolean; - webauthn_enabled: boolean; -} - -// @public -export type State = Record; - -// @public -export type SuccessfulAPIResponse = { - success: true; - data: T; -}; - -// @public -export const SUPPORTS_INTL: boolean; - -// @public -export type Tag = T & { - ___tag: Name; -}; - -// @public -export type Timestamp = Tag; - -// @public @deprecated (undocumented) -export const units: readonly ["GB", "MB", "KB", "B"]; - -// @public -export interface User { - email: string; - id: Id<'user'>; - name: string; - username: string; -} - -// @public -export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { - projects: Project[]; - user: SelfUser; - project_member_role_map: Record, MemberRole>; - leap_token: string | null; -}> | Endpoint<'POST', '/v1/users/@me/pats', { - pat: PAT; -}, { - name: string; -}> | Endpoint<'GET', '/v1/users/@me/pats', { - pats: PAT[]; -}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; - -// @public (undocumented) -export namespace Users { - { - users_PAT as PAT, - users_SelfUser as SelfUser, - users_User as User, - users_UserEndpoints as UserEndpoints, - }; -} - -// @public -export function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; - -// @public -export function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; - -// @public -export function validateIdPrefix(prefix: string, expect?: T): prefix is T; - -// @public -export interface ValidationFailure { - // (undocumented) - help_link: string | null; - // (undocumented) - reason: string; -} - -// @internal -export type _Values = T[keyof T]; - -// @public -export interface Vgpu { - count: number; - type: VgpuType; -} - -// @public -export enum VgpuType { - // (undocumented) - A400 = "a400" -} - -// @public (undocumented) -export interface VolumeDefinition { - fs: VolumeFormat; - mount_path: string; - size: ByteSizeString; -} - -// @public (undocumented) -export enum VolumeFormat { - // (undocumented) - EXT4 = "ext4", - // (undocumented) - XFS = "xfs" -} - -// Warnings were encountered during analysis: -// -// dist/index.d.ts:527:17 - (ae-incompatible-release-tags) The symbol "__call" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal -// dist/index.d.ts:548:17 - (ae-incompatible-release-tags) The symbol "__call" is marked as @public, but its signature references "CreateDeploymentConfig" which is marked as @internal -// dist/index.d.ts:759:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) - -``` From 80163354f948727593905f2011107d6fcb8aa674 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sat, 11 Mar 2023 19:45:58 +0000 Subject: [PATCH 22/33] deprecation warnings --- src/rest/types/channels.ts | 19 ++++++++++++------- src/rest/types/ignite.ts | 6 +++--- src/rest/types/pipe.ts | 12 ++++++++++++ src/sdks/channels.ts | 27 ++++++++++++++++++--------- src/sdks/ignite.ts | 9 ++------- src/sdks/projects.ts | 2 +- src/util/size.ts | 9 +++------ 7 files changed, 51 insertions(+), 33 deletions(-) diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index 4fa44db6..d4741c8d 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -16,7 +16,12 @@ export enum ChannelType { * Generic state type of a channel * @public */ -export type State = Record; +export type AnyStateObject = Record; + +/** + * @deprecated Use {@link AnyStateObject} instead + */ +export type State = AnyStateObject; /** * Definition of a channel @@ -36,7 +41,7 @@ export interface Channel { /** * State metadata */ - state: State; + state: AnyStateObject; /** * Capabilities of the channel @@ -63,7 +68,7 @@ export interface ChannelToken { /** * State for this token */ - state: State; + state: AnyStateObject; /** * The project this channel token is associated with @@ -97,7 +102,7 @@ export type ChannelEndpoints = 'POST', '/v1/channels/tokens', {token: ChannelToken}, - {state: State} + {state: AnyStateObject} > | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', {channel: Channel}> @@ -109,9 +114,9 @@ export type ChannelEndpoints = {e: string; d: unknown} > | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> - | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> - | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> - | Endpoint<'GET', '/v1/channels/:channel_id/state', {state: State}> + | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, AnyStateObject> + | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, AnyStateObject> + | Endpoint<'GET', '/v1/channels/:channel_id/state', {state: AnyStateObject}> | Endpoint< 'POST', '/v1/channels/:channel_id/messages', diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 8236f96e..c892438e 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -246,7 +246,7 @@ export interface Deployment { /** * Current active rollout for deployment - * @deprecated Use latest_rollout + * @deprecated Use {@link Deployment.latest_rollout} instead */ active_rollout: DeploymentRollout | null; @@ -316,7 +316,7 @@ export interface DeploymentMetadata { /** * Deployment metadata - * @deprecated Use DeploymentMetadata. This will be removed in a future release + * @deprecated Use {@link DeploymentMetadata} instead */ export type DeploymentMetaData = DeploymentMetadata; @@ -378,7 +378,7 @@ export interface BuildMetadata { /** * Metadata attached to a build - * @deprecated Use BuildMetadata. This will be removed in a future release + * @deprecated Use {@see BuildMetadata} instead */ export type BuildMetaData = BuildMetadata; diff --git a/src/rest/types/pipe.ts b/src/rest/types/pipe.ts index 02a1dc75..193d094e 100644 --- a/src/rest/types/pipe.ts +++ b/src/rest/types/pipe.ts @@ -2,8 +2,16 @@ import type {Empty, Id, Timestamp} from '../../util/types.ts'; import type {Endpoint} from '../endpoints.ts'; import type {Regions} from './ignite.ts'; +/** + * A protocol that can be used to deliver a stream + * @public + */ export type DeliveryProtocol = 'webrtc' | 'hls'; +/** + * A room that you can stream to + * @public + */ export interface Room { /** * The ID of this stream @@ -51,6 +59,10 @@ export interface Room { state: 'live' | 'offline'; } +/** + * The endpoints for the pipe API + * @public + */ export type PipeEndpoints = | Endpoint<'GET', '/v1/pipe/rooms', {rooms: Room[]}> | Endpoint< diff --git a/src/sdks/channels.ts b/src/sdks/channels.ts index f735423b..97208c2b 100644 --- a/src/sdks/channels.ts +++ b/src/sdks/channels.ts @@ -6,7 +6,7 @@ import {sdk} from './create.ts'; * New state to set to a channel, or a callback function that will produce the new state * @public */ -export type SetStateAction = +export type SetStateAction = | T | ((oldState: T) => T | Promise); @@ -16,11 +16,15 @@ export type SetStateAction = */ export const channels = sdk(client => { const Channels = create().methods({ - async setState(state: SetStateAction) { + async setState( + state: SetStateAction, + ) { await updateState(this.id, state, 'set'); }, - async patchState(state: SetStateAction) { + async patchState( + state: SetStateAction, + ) { await updateState(this.id, state, 'patch'); }, @@ -37,12 +41,12 @@ export const channels = sdk(client => { }, }); - async function updateState( + async function updateState( channelId: API.Channels.Channel['id'], newState: SetStateAction, mode: 'patch' | 'set', ) { - let state: API.Channels.State; + let state: API.Channels.AnyStateObject; if (typeof newState === 'function') { const {state: oldState} = await client.get( @@ -74,7 +78,7 @@ export const channels = sdk(client => { * @param id - An ID to assign to the channel (optional, set this to `undefined` or `null` if you do not want to specify an ID) * @param project - A project ID (if necessary) to assign this to */ - async create( + async create( type: API.Channels.ChannelType, id?: string | null, options?: {state?: T} | null, @@ -157,7 +161,9 @@ export const channels = sdk(client => { return tokens; }, - async setState( + async setState< + T extends API.Channels.AnyStateObject = API.Channels.AnyStateObject, + >( channel: API.Channels.Channel | API.Channels.Channel['id'], state: SetStateAction, ) { @@ -165,7 +171,7 @@ export const channels = sdk(client => { return updateState(id, state, 'set'); }, - async patchState( + async patchState( channel: API.Channels.Channel | API.Channels.Channel['id'], state: SetStateAction, ) { @@ -221,7 +227,10 @@ export const channels = sdk(client => { * @param state - The state to set on the token * @param project - The project to attach this token to */ - async create(state: API.Channels.State = {}, project?: Id<'project'>) { + async create( + state: API.Channels.AnyStateObject = {}, + project?: Id<'project'>, + ) { if (!project && client.authType !== 'ptk') { throw new Error( 'Project must be provided when creating a channel token with bearer or PAT auth', diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 00c583f7..e4522faa 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -3,7 +3,7 @@ import {API, Id, assertId} from '../rest/index.ts'; import { Deployment, DeploymentConfig, - DeploymentMetadata, + DeploymentMetaData, Gateway, GatewayType, RuntimeType, @@ -479,7 +479,7 @@ export const ignite = sdk(client => { async patchMetadata( deploymentId: Id<'deployment'>, - metadata: Partial, + metadata: Partial, ) { const {deployment} = await client.patch( '/v1/ignite/deployments/:deployment_id/metadata', @@ -489,11 +489,6 @@ export const ignite = sdk(client => { return deployment; }, - - /** - * @deprecated This property has moved — use hop.ignite.gateways instead - */ - gateways: deploymentGateways, }, containers: { diff --git a/src/sdks/projects.ts b/src/sdks/projects.ts index 9996ba9c..ff6c7ba6 100644 --- a/src/sdks/projects.ts +++ b/src/sdks/projects.ts @@ -139,7 +139,7 @@ export const projects = sdk(client => { }, /** - * @deprecated Use .tokens instead + * @deprecated Use {@link projectsSDK.tokens} instead */ projectTokens: tokens, diff --git a/src/util/size.ts b/src/util/size.ts index b5f5aebe..ada52672 100644 --- a/src/util/size.ts +++ b/src/util/size.ts @@ -8,7 +8,7 @@ export const byteUnits = ['GB', 'MB', 'KB', 'B'] as const; * Byte size unit type * @public */ -export type ByteUnit = typeof byteUnits[number]; +export type ByteUnit = (typeof byteUnits)[number]; /** * A string representing a byte size @@ -17,9 +17,7 @@ export type ByteUnit = typeof byteUnits[number]; export type ByteSizeString = `${number}${ByteUnit}`; /** - * A string representing a byte size - * @public - * @deprecated use `ByteSizeString` instead + * @deprecated Use {@link ByteSizeString} instead */ export type ByteString = ByteSizeString; @@ -109,7 +107,6 @@ export function parseSize(size: string) { } /** - * @deprecated use `byteUnits` instead - * @public + * @deprecated Use {@link byteUnits} instead */ export const units = byteUnits; From 697686ccb5a99029050fc5d8e66b1c17acfaa7c2 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sun, 12 Mar 2023 00:57:51 +0000 Subject: [PATCH 23/33] feat: bundle esm/cjs properly --- .gitignore | 2 +- build/copy.js | 19 +++++++++++++++++++ package.json | 13 ++++--------- src/sdks/ignite.ts | 14 +++++++------- tsconfig.json | 7 ++++++- tsup.config.ts | 4 ++-- 6 files changed, 39 insertions(+), 20 deletions(-) create mode 100644 build/copy.js diff --git a/.gitignore b/.gitignore index 1b696c47..0cd2bf35 100644 --- a/.gitignore +++ b/.gitignore @@ -10,4 +10,4 @@ _workbench.ts temp .next docs - +package.tgz diff --git a/build/copy.js b/build/copy.js new file mode 100644 index 00000000..1dd80377 --- /dev/null +++ b/build/copy.js @@ -0,0 +1,19 @@ +import {copyFileSync, readdirSync} from 'node:fs'; +import {join} from 'node:path'; +import {fileURLToPath} from 'node:url'; + +const dist = join(fileURLToPath(import.meta.url), '..', '..', 'dist'); + +const utils = readdirSync(join(dist, 'utils')); + +const copy = (from, to) => { + copyFileSync(join(dist, from), join(dist, to)); +}; + +copy('index.d.ts', 'index.d.cts'); + +for (const util of utils) { + copy(`utils/${util}/index.d.ts`, `utils/${util}/index.d.cts`); +} + +copy('node/index.d.ts', 'node/index.d.cts'); diff --git a/package.json b/package.json index ebd744c5..f315d90c 100644 --- a/package.json +++ b/package.json @@ -3,24 +3,19 @@ "version": "1.28.1", "type": "module", "main": "./dist/index.cjs", - "types": "./dist/index.d.ts", "module": "./dist/index.js", "exports": { ".": { "node": { "import": "./dist/node/index.js", - "require": "./dist/node/index.cjs", - "types": "./dist/index.d.ts" + "require": "./dist/node/index.cjs" }, "import": "./dist/index.js", - "browser": "./dist/index.js", - "require": "./dist/index.cjs", - "types": "./dist/index.d.ts" + "require": "./dist/index.cjs" }, "./utils/zod": { "import": "./dist/utils/zod/index.js", - "require": "./dist/utils/zod/index.cjs", - "types": "./dist/utils/zod/index.d.ts" + "require": "./dist/utils/zod/index.cjs" } }, "repository": "https://github.com/hopinc/js.git", @@ -40,7 +35,7 @@ "utils" ], "scripts": { - "build": "rm -rf dist && tsup", + "build": "rm -rf dist && tsup && node ./build/copy.js", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", "api": "yarn build && api-extractor run --local --verbose", diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index e4522faa..6b62f0ff 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -1,10 +1,10 @@ -import {Infer, create} from '@onehop/json-methods'; -import {API, Id, assertId} from '../rest/index.ts'; +import {type Infer, create} from '@onehop/json-methods'; +import {API, type Id, assertId} from '../rest/index.ts'; import { - Deployment, - DeploymentConfig, - DeploymentMetaData, - Gateway, + type Deployment, + type DeploymentConfig, + type DeploymentMetadata, + type Gateway, GatewayType, RuntimeType, } from '../rest/types/ignite.ts'; @@ -479,7 +479,7 @@ export const ignite = sdk(client => { async patchMetadata( deploymentId: Id<'deployment'>, - metadata: Partial, + metadata: Partial, ) { const {deployment} = await client.patch( '/v1/ignite/deployments/:deployment_id/metadata', diff --git a/tsconfig.json b/tsconfig.json index 00fbbad6..dcd6acd6 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -26,5 +26,10 @@ "verbatimModuleSyntax": true }, "exclude": ["node_modules", "dist"], - "include": ["./**/*.ts", "./**/*.tsx"] + "include": [ + "./**/*.ts", + "./**/*.tsx", + "dist/index.d.cts", + "dist/utils/zod/index.d.cts" + ] } diff --git a/tsup.config.ts b/tsup.config.ts index 23798748..0312ce49 100644 --- a/tsup.config.ts +++ b/tsup.config.ts @@ -21,13 +21,13 @@ const define = ({node = false} = {}) => ({ export default defineConfig([ { ...commonBuild, - entry: ['src/index.ts', 'src/utils/*/index.ts'], + entry: ['./src/index.ts', './src/utils/*/index.ts'], define: define(), }, { ...commonBuild, entry: ['src/index.ts'], - outDir: 'dist/node', + outDir: './dist/node', define: define({ node: true, }), From e0651768feba667ef3305279238d4cca96cfb9aa Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sun, 12 Mar 2023 01:15:31 +0000 Subject: [PATCH 24/33] docs(changeset): Convert to ts 5, export more symbols, deprecate some others --- .changeset/polite-garlics-tie.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/polite-garlics-tie.md diff --git a/.changeset/polite-garlics-tie.md b/.changeset/polite-garlics-tie.md new file mode 100644 index 00000000..b79f5d43 --- /dev/null +++ b/.changeset/polite-garlics-tie.md @@ -0,0 +1,5 @@ +--- +'@onehop/js': minor +--- + +Convert to ts 5, export more symbols, deprecate some others From bfb38fcd394aad1a3cbbcbb59dc32eb2a8774cdc Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sun, 12 Mar 2023 01:15:55 +0000 Subject: [PATCH 25/33] remove .temp --- .temp/js.api.json | 17784 -------------------------------------------- .temp/js.api.md | 1953 ----- 2 files changed, 19737 deletions(-) delete mode 100644 .temp/js.api.json delete mode 100644 .temp/js.api.md diff --git a/.temp/js.api.json b/.temp/js.api.json deleted file mode 100644 index 9c541b36..00000000 --- a/.temp/js.api.json +++ /dev/null @@ -1,17784 +0,0 @@ -{ - "metadata": { - "toolPackage": "@microsoft/api-extractor", - "toolVersion": "7.34.4", - "schemaVersion": 1011, - "oldestForwardsCompatibleVersion": 1001, - "tsdocConfig": { - "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", - "noStandardTags": true, - "tagDefinitions": [ - { - "tagName": "@alpha", - "syntaxKind": "modifier" - }, - { - "tagName": "@beta", - "syntaxKind": "modifier" - }, - { - "tagName": "@defaultValue", - "syntaxKind": "block" - }, - { - "tagName": "@decorator", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@deprecated", - "syntaxKind": "block" - }, - { - "tagName": "@eventProperty", - "syntaxKind": "modifier" - }, - { - "tagName": "@example", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@experimental", - "syntaxKind": "modifier" - }, - { - "tagName": "@inheritDoc", - "syntaxKind": "inline" - }, - { - "tagName": "@internal", - "syntaxKind": "modifier" - }, - { - "tagName": "@label", - "syntaxKind": "inline" - }, - { - "tagName": "@link", - "syntaxKind": "inline", - "allowMultiple": true - }, - { - "tagName": "@override", - "syntaxKind": "modifier" - }, - { - "tagName": "@packageDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@param", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@privateRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@public", - "syntaxKind": "modifier" - }, - { - "tagName": "@readonly", - "syntaxKind": "modifier" - }, - { - "tagName": "@remarks", - "syntaxKind": "block" - }, - { - "tagName": "@returns", - "syntaxKind": "block" - }, - { - "tagName": "@sealed", - "syntaxKind": "modifier" - }, - { - "tagName": "@see", - "syntaxKind": "block" - }, - { - "tagName": "@throws", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@typeParam", - "syntaxKind": "block", - "allowMultiple": true - }, - { - "tagName": "@virtual", - "syntaxKind": "modifier" - }, - { - "tagName": "@betaDocumentation", - "syntaxKind": "modifier" - }, - { - "tagName": "@internalRemarks", - "syntaxKind": "block" - }, - { - "tagName": "@preapproved", - "syntaxKind": "modifier" - } - ], - "supportForTags": { - "@alpha": true, - "@beta": true, - "@defaultValue": true, - "@decorator": true, - "@deprecated": true, - "@eventProperty": true, - "@example": true, - "@experimental": true, - "@inheritDoc": true, - "@internal": true, - "@label": true, - "@link": true, - "@override": true, - "@packageDocumentation": true, - "@param": true, - "@privateRemarks": true, - "@public": true, - "@readonly": true, - "@remarks": true, - "@returns": true, - "@sealed": true, - "@see": true, - "@throws": true, - "@typeParam": true, - "@virtual": true, - "@betaDocumentation": true, - "@internalRemarks": true, - "@preapproved": true - }, - "reportUnsupportedHtmlElements": false - } - }, - "kind": "Package", - "canonicalReference": "@onehop/js!", - "docComment": "", - "name": "@onehop/js", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EntryPoint", - "canonicalReference": "@onehop/js!", - "name": "", - "preserveMemberOrder": false, - "members": [ - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!AnyId:type", - "docComment": "/**\n * Any/all IDs that are used within the API\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type AnyId = " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "IdPrefixes", - "canonicalReference": "@onehop/js!IdPrefixes:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "AnyId", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!API:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace api " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "API", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!APIAuthentication:type", - "docComment": "/**\n * All possible authentication ID types\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type APIAuthentication = " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "APIAuthenticationPrefix", - "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "APIAuthentication", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type", - "docComment": "/**\n * A valid ID prefix supported by the Hop API for authetication\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type APIAuthenticationPrefix = " - }, - { - "kind": "Content", - "text": "'ptk' | 'bearer' | 'pat'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "APIAuthenticationPrefix", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Class", - "canonicalReference": "@onehop/js!APIClient:class", - "docComment": "/**\n * API Client that is responsible for handling all requests\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare class APIClient " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "APIClient", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@onehop/js!APIClient:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `APIClient` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(options: " - }, - { - "kind": "Reference", - "text": "APIClientOptions", - "canonicalReference": "@onehop/js!APIClientOptions:interface" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!APIClient#authType:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly authType: " - }, - { - "kind": "Reference", - "text": "APIAuthenticationPrefix", - "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "authType", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#delete:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "delete['path']" - }, - { - "kind": "Content", - "text": ">(path: " - }, - { - "kind": "Content", - "text": "Path" - }, - { - "kind": "Content", - "text": ", body: " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n path: Path;\n method: 'DELETE';\n }>['body']" - }, - { - "kind": "Content", - "text": ", query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", init?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/users/@me/pats/:pat_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/projects/:project_id/tokens/:project_token_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/projects/@this/tokens/:project_token_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/projects/:project_id/secrets/:secret_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/projects/@this/secrets/:secret_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/channels/:channel_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/channels/tokens/:token\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/ignite/deployments/:deployment_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/ignite/containers/:container_id\", void | {\n container: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/ignite/domains/:domain_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/pipe/rooms/:room_id\", void>, {\n path: Path;\n method: 'DELETE';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"DELETE\", \"/v1/registry/images/:image\", void>, {\n path: Path;\n method: 'DELETE';\n }>)[\"res\"]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 18, - "endIndex": 70 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "isOptional": false - }, - { - "parameterName": "body", - "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "isOptional": false - }, - { - "parameterName": "query", - "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 - }, - "isOptional": false - }, - { - "parameterName": "init", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "delete" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#get:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "get" - }, - { - "kind": "Content", - "text": ">(path: " - }, - { - "kind": "Content", - "text": "Path" - }, - { - "kind": "Content", - "text": ", query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", init?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/users/@me\", {\n projects: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": "[];\n user: " - }, - { - "kind": "Reference", - "text": "SelfUser", - "canonicalReference": "@onehop/js!SelfUser:interface" - }, - { - "kind": "Content", - "text": ";\n project_member_role_map: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<`project_${string}`, " - }, - { - "kind": "Reference", - "text": "MemberRole", - "canonicalReference": "@onehop/js!MemberRole:interface" - }, - { - "kind": "Content", - "text": ">;\n leap_token: string | null;\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/users/@me/pats\", {\n pats: " - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/:project_id/members/@me\", {\n project_member: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/:project_id/tokens\", {\n project_tokens: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/@this/tokens\", {\n project_tokens: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/:project_id/members\", {\n members: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/@this/members\", {\n members: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/:project_id/secrets\", {\n secrets: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/projects/@this/secrets\", {\n secrets: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels/:channel_id\", {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels/:channel_id/tokens\", {\n tokens: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels/:channel_id/state\", {\n state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels\", {\n channels: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels/tokens/:token\", {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/channels/:channel_id/stats\", {\n stats: {\n online_count: number;\n };\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments\", {\n deployments: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/containers\", {\n containers: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/containers/:container_id/logs\", {\n logs: " - }, - { - "kind": "Reference", - "text": "ContainerLog", - "canonicalReference": "@onehop/js!ContainerLog:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments/search\", {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id\", {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/gateways/:gateway_id\", {\n gateway: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/gateways\", {\n gateways: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/deployments/:deployment_id/storage\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/ignite/domains/:domain_id\", {\n domain: " - }, - { - "kind": "Reference", - "text": "Domain", - "canonicalReference": "@onehop/js!Domain:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/pipe/rooms\", {\n rooms: " - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": "[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/registry/images\", {\n images: string[];\n }>, {\n path: Path;\n method: 'GET';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"GET\", \"/v1/registry/images/:image/manifests\", {\n manifests: {\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[];\n }>, {\n path: Path;\n method: 'GET';\n }>)[\"res\"]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 3 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 177 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 4, - "endIndex": 5 - }, - "isOptional": false - }, - { - "parameterName": "query", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 8 - }, - "isOptional": false - }, - { - "parameterName": "init", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "get" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient.getAuthType:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "static getAuthType(auth: " - }, - { - "kind": "Reference", - "text": "APIAuthentication", - "canonicalReference": "@onehop/js!APIAuthentication:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "APIAuthenticationPrefix", - "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isStatic": true, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "auth", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "getAuthType" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#patch:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "patch['path']" - }, - { - "kind": "Content", - "text": ">(path: " - }, - { - "kind": "Content", - "text": "Path" - }, - { - "kind": "Content", - "text": ", body: " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n path: Path;\n method: 'PATCH';\n }>['body']" - }, - { - "kind": "Content", - "text": ", query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", init?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PATCH\", \"/v1/channels/:channel_id/state\", void, " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ">, {\n path: Path;\n method: 'PATCH';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PATCH\", \"/v1/channels/tokens/:token\", {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n expiresAt?: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": " | null;\n state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'PATCH';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id\", {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n }, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentConfig", - "canonicalReference": "@onehop/js!DeploymentConfig:interface" - }, - { - "kind": "Content", - "text": ">>, {\n path: Path;\n method: 'PATCH';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id/metadata\", {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n }, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentMetaData", - "canonicalReference": "@onehop/js!DeploymentMetaData:interface" - }, - { - "kind": "Content", - "text": ">>, {\n path: Path;\n method: 'PATCH';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PATCH\", \"/v1/ignite/deployments/:deployment_id/health-check\", {\n health_check: " - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ";\n }, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", \"id\">>>, {\n path: Path;\n method: 'PATCH';\n }>)[\"res\"]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 18, - "endIndex": 68 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "isOptional": false - }, - { - "parameterName": "body", - "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "isOptional": false - }, - { - "parameterName": "query", - "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 - }, - "isOptional": false - }, - { - "parameterName": "init", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "patch" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#post:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "post['path']" - }, - { - "kind": "Content", - "text": ">(path: " - }, - { - "kind": "Content", - "text": "Path" - }, - { - "kind": "Content", - "text": ", body: " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n path: Path;\n method: 'POST';\n }>['body']" - }, - { - "kind": "Content", - "text": ", query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", init?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/users/@me/pats\", {\n pat: " - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n name: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/projects/:project_id/tokens\", {\n project_token: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }, {\n flags: number;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/projects/@this/tokens\", {\n project_token: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }, {\n flags: number;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/channels\", {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ";\n state: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": " | null;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/channels/tokens\", {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/channels/tokens/:token/messages\", void, {\n e: string;\n d: unknown;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/channels/:channel_id/messages\", void, {\n e: string;\n d: unknown;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/containers\", {\n container: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/containers/:container_id\", never, {\n deployment_id: `deployment_${string}`;\n container_id: `container_${string}`;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments\", {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n }, " - }, - { - "kind": "Reference", - "text": "CreateDeploymentConfig", - "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" - }, - { - "kind": "Content", - "text": ">, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/gateways/:gateway_id/domains\", void, {\n domain: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/gateways\", {\n gateway: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType", - "canonicalReference": "@onehop/js!GatewayType:enum" - }, - { - "kind": "Content", - "text": ";\n target_port: number;\n protocol: \"http\" | null;\n name: string;\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/rollouts\", {\n rollout: " - }, - { - "kind": "Reference", - "text": "DeploymentRollout", - "canonicalReference": "@onehop/js!DeploymentRollout:type" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/ignite/deployments/:deployment_id/health-check\", {\n health_check: " - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ";\n }, " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", \"id\">>, {\n path: Path;\n method: 'POST';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"POST\", \"/v1/pipe/rooms\", {\n room: " - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n name: string;\n ingest_protocol: \"rtmp\" | \"rtp\";\n delivery_protocols: " - }, - { - "kind": "Reference", - "text": "DeliveryProtocol", - "canonicalReference": "@onehop/js!DeliveryProtocol:type" - }, - { - "kind": "Content", - "text": "[];\n region: " - }, - { - "kind": "Reference", - "text": "Regions", - "canonicalReference": "@onehop/js!Regions:enum" - }, - { - "kind": "Content", - "text": ";\n ephemeral: boolean;\n llhls_config?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n } | undefined;\n }>, {\n path: Path;\n method: 'POST';\n }>)[\"res\"]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 18, - "endIndex": 124 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "isOptional": false - }, - { - "parameterName": "body", - "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "isOptional": false - }, - { - "parameterName": "query", - "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 - }, - "isOptional": false - }, - { - "parameterName": "init", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "post" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#put:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "put['path']" - }, - { - "kind": "Content", - "text": ">(path: " - }, - { - "kind": "Content", - "text": "Path" - }, - { - "kind": "Content", - "text": ", body: " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n path: Path;\n method: 'PUT';\n }>['body']" - }, - { - "kind": "Content", - "text": ", query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ", init?: " - }, - { - "kind": "Reference", - "text": "RequestInit", - "canonicalReference": "!RequestInit:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/projects/:project_id/secrets/:name\", {\n secret: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": ";\n }, string>, {\n path: Path;\n method: 'PUT';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/projects/@this/secrets/:name\", {\n secret: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": ";\n }, string>, {\n path: Path;\n method: 'PUT';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/channels/:channel_id\", {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n }, {\n type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ";\n state: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": " | null;\n }>, {\n path: Path;\n method: 'PUT';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/channels/:channel_id/subscribers/:token\", void>, {\n path: Path;\n method: 'PUT';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/channels/:channel_id/state\", void, " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ">, {\n path: Path;\n method: 'PUT';\n }> | " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<\"PUT\", \"/v1/ignite/containers/:container_id/state\", void, {\n preferred_state: " - }, - { - "kind": "Reference", - "text": "ContainerState.RUNNING", - "canonicalReference": "@onehop/js!ContainerState.RUNNING:member" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "ContainerState.STOPPED", - "canonicalReference": "@onehop/js!ContainerState.STOPPED:member" - }, - { - "kind": "Content", - "text": ";\n }>, {\n path: Path;\n method: 'PUT';\n }>)[\"res\"]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 5 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 18, - "endIndex": 60 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "path", - "parameterTypeTokenRange": { - "startIndex": 6, - "endIndex": 7 - }, - "isOptional": false - }, - { - "parameterName": "body", - "parameterTypeTokenRange": { - "startIndex": 8, - "endIndex": 12 - }, - "isOptional": false - }, - { - "parameterName": "query", - "parameterTypeTokenRange": { - "startIndex": 13, - "endIndex": 15 - }, - "isOptional": false - }, - { - "parameterName": "init", - "parameterTypeTokenRange": { - "startIndex": 16, - "endIndex": 17 - }, - "isOptional": true - } - ], - "isOptional": false, - "isAbstract": false, - "name": "put" - }, - { - "kind": "Method", - "canonicalReference": "@onehop/js!APIClient#raw:member(1)", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "raw(request: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "!Request:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "isStatic": false, - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 5 - }, - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "request", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "isOptional": false, - "isAbstract": false, - "name": "raw" - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!APIClient#url:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly url: " - }, - { - "kind": "Content", - "text": "(path: Path, query: " - }, - { - "kind": "Reference", - "text": "Query", - "canonicalReference": "@onehop/js!Query:type" - }, - { - "kind": "Content", - "text": ") => string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "url", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!APIClientOptions:interface", - "docComment": "/**\n * Options passed to the API client. This will usually come from Hop#constructor in most cases\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface APIClientOptions " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "APIClientOptions", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!APIClientOptions#authentication:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly authentication: " - }, - { - "kind": "Reference", - "text": "APIAuthentication", - "canonicalReference": "@onehop/js!APIAuthentication:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "authentication", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!APIClientOptions#baseUrl:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly baseUrl: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "baseUrl", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!APIResponse:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type APIResponse = " - }, - { - "kind": "Reference", - "text": "SuccessfulAPIResponse", - "canonicalReference": "@onehop/js!SuccessfulAPIResponse:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "ErroredAPIResponse", - "canonicalReference": "@onehop/js!ErroredAPIResponse:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "APIResponse", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!assertId:function(1)", - "docComment": "/**\n * Asserts that a string is a valid ID\n *\n * @param maybeId - A string that is possibly an ID\n *\n * @param prefix - A prefix or array of prefixes to check against\n *\n * @param message - An error message to throw if the ID is invalid\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function assertId(maybeId: " - }, - { - "kind": "Content", - "text": "string | undefined | null" - }, - { - "kind": "Content", - "text": ", prefix?: " - }, - { - "kind": "Content", - "text": "T | T[]" - }, - { - "kind": "Content", - "text": ", message?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "asserts " - }, - { - "kind": "Reference", - "text": "maybeId", - "canonicalReference": "@onehop/js!~maybeId" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 11, - "endIndex": 16 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "maybeId", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "prefix", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - }, - { - "parameterName": "message", - "parameterTypeTokenRange": { - "startIndex": 9, - "endIndex": 10 - }, - "isOptional": true - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "assertId" - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Auth:interface", - "docComment": "/**\n * Docker image registry authorization\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Auth " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Auth", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Auth#password:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "password: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "password", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Auth#username:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "username: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "username", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!BROAD_PERMISSIONS_MAP:var", - "docComment": "/**\n * Broader permission map\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "BROAD_PERMISSIONS_MAP: " - }, - { - "kind": "Content", - "text": "{\n MANAGE_MEMBERS: bigint;\n MANAGE_PROJECT_TOKENS: bigint;\n MANAGE_DEPLOYMENTS: bigint;\n MANAGE_PIPE: bigint;\n MANAGE_SECRETS: bigint;\n MANAGE_CHANNELS: bigint;\n MANAGE_REGISTRY: bigint;\n READ_ONLY: bigint;\n MANAGE_QUOTAS: bigint;\n MANAGE_ROLLOUTS: bigint;\n MANAGE_BILLING: bigint;\n}" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "BROAD_PERMISSIONS_MAP", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Build:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Build " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Build", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#created_at:member", - "docComment": "/**\n * Timestamp of when the build was created/queued\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at?: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#deployment_id:member", - "docComment": "/**\n * Deployment ID for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deployment_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "deployment_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#digest:member", - "docComment": "/**\n * Digest for image\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "digest: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "digest", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#environment:member", - "docComment": "/**\n * Environment for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "environment: " - }, - { - "kind": "Reference", - "text": "BuildEnvironment", - "canonicalReference": "@onehop/js!BuildEnvironment:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "environment", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#finished_at:member", - "docComment": "/**\n * Timestamp of when the build has finished\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "finished_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "finished_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#id:member", - "docComment": "/**\n * ID of the build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'build'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#metadata:member", - "docComment": "/**\n * Metadata pertaining to build (mostly for GitHub)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metadata: " - }, - { - "kind": "Reference", - "text": "BuildMetaData", - "canonicalReference": "@onehop/js!BuildMetaData:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "metadata", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#method:member", - "docComment": "/**\n * Build method (GitHub or CLI)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "method: " - }, - { - "kind": "Reference", - "text": "BuildMethod", - "canonicalReference": "@onehop/js!BuildMethod:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "method", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#started_at:member", - "docComment": "/**\n * Timestamp of when the build has started\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "started_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "started_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#state:member", - "docComment": "/**\n * State of the build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "BuildState", - "canonicalReference": "@onehop/js!BuildState:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Build#validation_failure:member", - "docComment": "/**\n * Validation failure for build; present if build state is VALIDATION_FAILED\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "validation_failure: " - }, - { - "kind": "Reference", - "text": "ValidationFailure", - "canonicalReference": "@onehop/js!ValidationFailure:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "validation_failure", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!BuildEnvironment:interface", - "docComment": "/**\n * Build environment contians information about the language and build commands used to build the deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface BuildEnvironment " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildEnvironment", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildEnvironment#nix_plan:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "nix_plan?: " - }, - { - "kind": "Reference", - "text": "NixPlan", - "canonicalReference": "@onehop/js!NixPlan:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "nix_plan", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildEnvironment#type:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "BuildEnvironmentType", - "canonicalReference": "@onehop/js!BuildEnvironmentType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!BuildEnvironmentType:enum", - "docComment": "/**\n * The inferred environment type of a build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum BuildEnvironmentType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildEnvironmentType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildEnvironmentType.DOCKERFILE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DOCKERFILE = " - }, - { - "kind": "Content", - "text": "\"dockerfile\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DOCKERFILE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildEnvironmentType.NIXPACKS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "NIXPACKS = " - }, - { - "kind": "Content", - "text": "\"nixpacks\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "NIXPACKS" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!BuildMetaData:interface", - "docComment": "/**\n * Metadata attached to a build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface BuildMetaData " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildMetaData", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#account_type:member", - "docComment": "/**\n * Account type of repo owner\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "account_type?: " - }, - { - "kind": "Content", - "text": "'user' | 'organization'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "account_type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#author:member", - "docComment": "/**\n * Author information about build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "author?: " - }, - { - "kind": "Content", - "text": "{\n avatar_url: string;\n username: string;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "author", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#branch:member", - "docComment": "/**\n * Repo branch for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "branch: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "branch", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#commit_msg:member", - "docComment": "/**\n * commit message for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "commit_msg: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "commit_msg", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#commit_sha:member", - "docComment": "/**\n * commit SHA for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "commit_sha: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "commit_sha", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#commit_url:member", - "docComment": "/**\n * commit URL for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "commit_url?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "commit_url", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#repo_id:member", - "docComment": "/**\n * Repo ID for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "repo_id: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "repo_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildMetaData#repo_name:member", - "docComment": "/**\n * Repo name for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "repo_name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "repo_name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!BuildMethod:enum", - "docComment": "/**\n * Types of build methods supported by Hop\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum BuildMethod " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildMethod", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildMethod.CLI:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CLI = " - }, - { - "kind": "Content", - "text": "\"cli\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CLI" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildMethod.GITHUB:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "GITHUB = " - }, - { - "kind": "Content", - "text": "\"github\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "GITHUB" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!BuildSettings:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface BuildSettings " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildSettings", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!BuildSettings#root_directory:member", - "docComment": "/**\n * Root directory for build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "root_directory?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "root_directory", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!BuildState:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum BuildState " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "BuildState", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.CANCELLED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CANCELLED = " - }, - { - "kind": "Content", - "text": "\"cancelled\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CANCELLED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.FAILED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FAILED = " - }, - { - "kind": "Content", - "text": "\"failed\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FAILED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.PENDING:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PENDING = " - }, - { - "kind": "Content", - "text": "\"pending\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PENDING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.SUCCEEDED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "SUCCEEDED = " - }, - { - "kind": "Content", - "text": "\"succeeded\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "SUCCEEDED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.VALIDATING:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VALIDATING = " - }, - { - "kind": "Content", - "text": "\"validating\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VALIDATING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!BuildState.VALIDATION_FAILED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VALIDATION_FAILED = " - }, - { - "kind": "Content", - "text": "\"validation_failed\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VALIDATION_FAILED" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!bytes:function(1)", - "docComment": "/**\n * Helper function to converts a numerical size to a valid byte size string\n *\n * @param size - A size to convert to a valid byte size string\n *\n * @param unit - An optional unit to as the size unit. Defaults to B\n *\n * @returns a byte size string\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function bytes(size: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ", unit?: " - }, - { - "kind": "Reference", - "text": "ByteUnit", - "canonicalReference": "@onehop/js!ByteUnit:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "size", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "unit", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - } - ], - "name": "bytes" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ByteSizeString:type", - "docComment": "/**\n * A string representing a byte size\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ByteSizeString = " - }, - { - "kind": "Content", - "text": "`${number}${" - }, - { - "kind": "Reference", - "text": "ByteUnit", - "canonicalReference": "@onehop/js!ByteUnit:type" - }, - { - "kind": "Content", - "text": "}`" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ByteSizeString", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ByteString:type", - "docComment": "/**\n * A string representing a byte size\n *\n * @deprecated\n *\n * use `ByteSizeString` instead\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ByteString = " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ByteString", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ByteUnit:type", - "docComment": "/**\n * Byte size unit type\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ByteUnit = " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "byteUnits", - "canonicalReference": "@onehop/js!byteUnits:var" - }, - { - "kind": "Content", - "text": "[number]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ByteUnit", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!byteUnits:var", - "docComment": "/**\n * API parsable byte size units strings\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "byteUnits: " - }, - { - "kind": "Content", - "text": "readonly [\"GB\", \"MB\", \"KB\", \"B\"]" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "byteUnits", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Channel:interface", - "docComment": "/**\n * Definition of a channel\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Channel " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Channel", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#capabilities:member", - "docComment": "/**\n * Capabilities of the channel\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "capabilities: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "capabilities", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#created_at:member", - "docComment": "/**\n * When this channel was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#id:member", - "docComment": "/**\n * The ID of the channel\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#project:member", - "docComment": "/**\n * The project it is associated with\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "project", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#state:member", - "docComment": "/**\n * State metadata\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Channel#type:member", - "docComment": "/**\n * The type of this channel\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ChannelEndpoints:type", - "docComment": "/**\n * Endpoints for channels\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ChannelEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/channels', {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ";\n state: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": " | null;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/channels/:channel_id', {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ";\n state: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": " | null;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/channels/tokens', {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/channels/:channel_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels/:channel_id', {\n channel: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels/:channel_id/tokens', {\n tokens: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/channels/tokens/:token/messages', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", {\n e: string;\n d: unknown;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/channels/:channel_id/subscribers/:token', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PATCH', '/v1/channels/:channel_id/state', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/channels/:channel_id/state', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels/:channel_id/state', {\n state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/channels/:channel_id/messages', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", {\n e: string;\n d: unknown;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels', {\n channels: " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels/tokens/:token', {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PATCH', '/v1/channels/tokens/:token', {\n token: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n expiresAt?: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": " | null;\n state: " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": "['state'];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/channels/tokens/:token', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/channels/:channel_id/stats', {\n stats: {\n online_count: number;\n };\n}>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ChannelEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 85 - } - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Channels:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace channels " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Channels", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!ChannelToken:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface ChannelToken " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ChannelToken", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ChannelToken#id:member", - "docComment": "/**\n * The ID for the token\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'leap_token'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ChannelToken#is_online:member", - "docComment": "/**\n * If this token is currently online (e.g. active heartbeat and connected to leap)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "is_online: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "is_online", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ChannelToken#project_id:member", - "docComment": "/**\n * The project this channel token is associated with\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "project_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'project'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "project_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ChannelToken#state:member", - "docComment": "/**\n * State for this token\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!ChannelType:enum", - "docComment": "/**\n * Types that a channel can be\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum ChannelType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ChannelType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ChannelType.PRIVATE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PRIVATE = " - }, - { - "kind": "Content", - "text": "\"private\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PRIVATE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ChannelType.PUBLIC:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PUBLIC = " - }, - { - "kind": "Content", - "text": "\"public\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PUBLIC" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ChannelType.UNPROTECTED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UNPROTECTED = " - }, - { - "kind": "Content", - "text": "\"unprotected\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "UNPROTECTED" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Container:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Container " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Container", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#created_at:member", - "docComment": "/**\n * The time this container was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#deployment_id:member", - "docComment": "/**\n * The ID of the deployment this container is associated with\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deployment_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "deployment_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#id:member", - "docComment": "/**\n * The ID of the container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'container'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#internal_ip:member", - "docComment": "/**\n * The internal IP of the container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "internal_ip: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "internal_ip", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#metadata:member", - "docComment": "/**\n * Information about the container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metadata: " - }, - { - "kind": "Content", - "text": "{\n last_exit_code?: number;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "metadata", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#metrics:member", - "docComment": "/**\n * Metrics for this container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metrics: " - }, - { - "kind": "Content", - "text": "{\n cpu_usage_percent: number;\n memory_usage_percent: number;\n } | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "metrics", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#overrides:member", - "docComment": "/**\n * Overrides that were provided manually to the container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "overrides: " - }, - { - "kind": "Content", - "text": "{\n resources?: " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Resources", - "canonicalReference": "@onehop/js!Resources:interface" - }, - { - "kind": "Content", - "text": ">;\n } | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "overrides", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#region:member", - "docComment": "/**\n * The region this container runs in\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "region: " - }, - { - "kind": "Reference", - "text": "Regions", - "canonicalReference": "@onehop/js!Regions:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "region", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#state:member", - "docComment": "/**\n * The state this container is in\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "ContainerState", - "canonicalReference": "@onehop/js!ContainerState:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#type:member", - "docComment": "/**\n * The type of this container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "RuntimeType", - "canonicalReference": "@onehop/js!RuntimeType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#uptime:member", - "docComment": "/**\n * Information about uptime/downtime for this container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "uptime: " - }, - { - "kind": "Content", - "text": "{\n last_start: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "uptime", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Container#volume:member", - "docComment": "/**\n * The volume definition for this container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "volume: " - }, - { - "kind": "Reference", - "text": "VolumeDefinition", - "canonicalReference": "@onehop/js!VolumeDefinition:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "volume", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!ContainerLog:interface", - "docComment": "/**\n * Logs from a container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface ContainerLog " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ContainerLog", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ContainerLog#level:member", - "docComment": "/**\n * The level of the log. stdout becomes `info`\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "level: " - }, - { - "kind": "Content", - "text": "'info' | 'error'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "level", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ContainerLog#message:member", - "docComment": "/**\n * The log message\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "message: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "message", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ContainerLog#nonce:member", - "docComment": "/**\n * The ID of the document in elasticsearch. You probably won't have to use this, but it might be useful for React keys, for example, as they are unique.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "nonce: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "nonce", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ContainerLog#timestamp:member", - "docComment": "/**\n * The timestamp of the log\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "timestamp: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "timestamp", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!ContainerState:enum", - "docComment": "/**\n * Container state is relatively self-explanatory. It describes what the container is currently doing.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum ContainerState " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ContainerState", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.EXITED:member", - "docComment": "/**\n * The container exited (e.g. with a zero exit code)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "EXITED = " - }, - { - "kind": "Content", - "text": "\"exited\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "EXITED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.FAILED:member", - "docComment": "/**\n * The container's entrypoint failed (e.g. exited with a non-zero exit code)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "FAILED = " - }, - { - "kind": "Content", - "text": "\"failed\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FAILED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.PENDING:member", - "docComment": "/**\n * The container is pending creation\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "PENDING = " - }, - { - "kind": "Content", - "text": "\"pending\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PENDING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.RUNNING:member", - "docComment": "/**\n * The container is running\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "RUNNING = " - }, - { - "kind": "Content", - "text": "\"running\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "RUNNING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.STOPPED:member", - "docComment": "/**\n * The container is stopped\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "STOPPED = " - }, - { - "kind": "Content", - "text": "\"stopped\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "STOPPED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerState.TERMINATING:member", - "docComment": "/**\n * The container is being deleted\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "TERMINATING = " - }, - { - "kind": "Content", - "text": "\"terminating\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "TERMINATING" - } - ] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!ContainerStrategy:enum", - "docComment": "/**\n * The strategy for scaling multiple containers. @warning This property is not yet fully complete\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum ContainerStrategy " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ContainerStrategy", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ContainerStrategy.MANUAL:member", - "docComment": "/**\n * Add containers yourself with the API or Console\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "MANUAL = " - }, - { - "kind": "Content", - "text": "\"manual\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "MANUAL" - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!CreateDeploymentConfig:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type CreateDeploymentConfig = " - }, - { - "kind": "Reference", - "text": "MakeOptional", - "canonicalReference": "@onehop/js!MakeOptional:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentConfig", - "canonicalReference": "@onehop/js!DeploymentConfig:interface" - }, - { - "kind": "Content", - "text": ", 'cmd'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "CreateDeploymentConfig", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!DEFAULT_BASE_URL:var", - "docComment": "/**\n * The default base URL for Hop's API.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "DEFAULT_BASE_URL = " - }, - { - "kind": "Content", - "text": "\"https://api.hop.io\"" - } - ], - "fileUrlPath": "dist/index.d.ts", - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isReadonly": true, - "releaseTag": "Public", - "name": "DEFAULT_BASE_URL", - "variableTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!DefaultQuotas:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface DefaultQuotas " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DefaultQuotas", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DefaultQuotas#ram:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ram: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ram", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DefaultQuotas#vcpu:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "vcpu: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "vcpu", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DefaultQuotas#volume:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "volume: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "volume", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!DeliveryProtocol:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type DeliveryProtocol = " - }, - { - "kind": "Content", - "text": "'webrtc' | 'hls'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DeliveryProtocol", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Deployment:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Deployment " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Deployment", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#active_build:member", - "docComment": "/**\n * Current active build for deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "active_build: " - }, - { - "kind": "Reference", - "text": "Build", - "canonicalReference": "@onehop/js!Build:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "active_build", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#active_rollout:member", - "docComment": "/**\n * Current active rollout for deployment\n *\n * @deprecated\n *\n * Use latest_rollout\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "active_rollout: " - }, - { - "kind": "Reference", - "text": "DeploymentRollout", - "canonicalReference": "@onehop/js!DeploymentRollout:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "active_rollout", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#build_cache_enabled:member", - "docComment": "/**\n * Build cache settings for deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "build_cache_enabled: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "build_cache_enabled", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#build_id:member", - "docComment": "/**\n * The ID of the build currently being used in production by this deployment. This will change if another build has been promoted to production.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "build_id: " - }, - { - "kind": "Reference", - "text": "Build", - "canonicalReference": "@onehop/js!Build:interface" - }, - { - "kind": "Content", - "text": "['id'] | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "build_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#build_settings:member", - "docComment": "/**\n * Build settings for deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "build_settings?: " - }, - { - "kind": "Reference", - "text": "BuildSettings", - "canonicalReference": "@onehop/js!BuildSettings:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "build_settings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#config:member", - "docComment": "/**\n * The config for this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "config: " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentConfig", - "canonicalReference": "@onehop/js!DeploymentConfig:interface" - }, - { - "kind": "Content", - "text": ", 'name'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "config", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#container_count:member", - "docComment": "/**\n * The amount of containers this deployment is currently running\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "container_count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "container_count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#created_at:member", - "docComment": "/**\n * The time this deployment was created at\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#id:member", - "docComment": "/**\n * The ID of the deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#latest_rollout:member", - "docComment": "/**\n * Current active rollout for deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "latest_rollout: " - }, - { - "kind": "Reference", - "text": "DeploymentRollout", - "canonicalReference": "@onehop/js!DeploymentRollout:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "latest_rollout", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#metadata:member", - "docComment": "/**\n * Metadata for deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "metadata: " - }, - { - "kind": "Reference", - "text": "DeploymentMetaData", - "canonicalReference": "@onehop/js!DeploymentMetaData:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "metadata", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#name:member", - "docComment": "/**\n * The name of the deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#running_container_count:member", - "docComment": "/**\n * The amount of containers in the running state\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "running_container_count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "running_container_count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Deployment#target_container_count:member", - "docComment": "/**\n * The target amount of containers a deployment should run\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "target_container_count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "target_container_count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!DeploymentConfig:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface DeploymentConfig " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DeploymentConfig", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#cmd:member", - "docComment": "/**\n * Entrypoint command for the image\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "cmd?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "cmd", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#container_strategy:member", - "docComment": "/**\n * The strategy for scaling multiple containers.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "container_strategy: " - }, - { - "kind": "Reference", - "text": "ContainerStrategy", - "canonicalReference": "@onehop/js!ContainerStrategy:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "container_strategy", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#entrypoint:member", - "docComment": "/**\n * Entrypoint for this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "entrypoint?: " - }, - { - "kind": "Content", - "text": "string[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "entrypoint", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#env:member", - "docComment": "/**\n * Environment variables for this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "env: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "env", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#image:member", - "docComment": "/**\n * The docker image config for this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "image: " - }, - { - "kind": "Reference", - "text": "Image", - "canonicalReference": "@onehop/js!Image_2:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "image", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#name:member", - "docComment": "/**\n * The name of the deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#resources:member", - "docComment": "/**\n * Resources allocated to this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "resources: " - }, - { - "kind": "Reference", - "text": "Resources", - "canonicalReference": "@onehop/js!Resources:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "resources", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#restart_policy:member", - "docComment": "/**\n * Restart policy for this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "restart_policy: " - }, - { - "kind": "Reference", - "text": "RestartPolicy", - "canonicalReference": "@onehop/js!RestartPolicy:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "restart_policy", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#type:member", - "docComment": "/**\n * The type of this deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "RuntimeType", - "canonicalReference": "@onehop/js!RuntimeType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#version:member", - "docComment": "/**\n * The version of this config\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "version: " - }, - { - "kind": "Content", - "text": "'12-12-2022'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "version", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentConfig#volume:member", - "docComment": "/**\n * The volume definition for this deployment\n *\n * This can only be used when .type is 'stateful'\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "volume?: " - }, - { - "kind": "Reference", - "text": "VolumeDefinition", - "canonicalReference": "@onehop/js!VolumeDefinition:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "volume", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!DeploymentMetaData:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface DeploymentMetaData " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DeploymentMetaData", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentMetaData#container_port_mappings:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "container_port_mappings: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'container'>, string[]>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "container_port_mappings", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 5 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentMetaData#created_first_gateway:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_first_gateway?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "created_first_gateway", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentMetaData#created_from_preset:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_from_preset?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "created_from_preset", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DeploymentMetaData#ignored_boarding:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ignored_boarding?: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": true, - "releaseTag": "Public", - "name": "ignored_boarding", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!DeploymentRollout:type", - "docComment": "/**\n * A deployment rollout\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type DeploymentRollout = " - }, - { - "kind": "Content", - "text": "{\n id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'rollout'>;\n deployment_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>;\n count: number;\n created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";\n state: " - }, - { - "kind": "Reference", - "text": "RolloutState", - "canonicalReference": "@onehop/js!RolloutState:enum" - }, - { - "kind": "Content", - "text": ";\n build: " - }, - { - "kind": "Reference", - "text": "Build", - "canonicalReference": "@onehop/js!Build:interface" - }, - { - "kind": "Content", - "text": " | null;\n init_container_id: string | null;\n health_check_failed: boolean;\n last_updated_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";\n acknowledged: boolean;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DeploymentRollout", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 14 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Domain:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Domain " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Domain", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Domain#created_at:member", - "docComment": "/**\n * The date this domain was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Domain#domain:member", - "docComment": "/**\n * The domain name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "domain: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "domain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Domain#id:member", - "docComment": "/**\n * The ID of the domain\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'domain'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Domain#redirect:member", - "docComment": "/**\n * Where the domain redirects to and its status code, null if N/A\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "redirect: " - }, - { - "kind": "Reference", - "text": "DomainRedirect", - "canonicalReference": "@onehop/js!DomainRedirect:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "redirect", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Domain#state:member", - "docComment": "/**\n * The domain state\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Reference", - "text": "DomainState", - "canonicalReference": "@onehop/js!DomainState:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!DomainRedirect:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface DomainRedirect " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DomainRedirect", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DomainRedirect#status_code:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "status_code: " - }, - { - "kind": "Content", - "text": "301 | 302 | 307 | 308" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "status_code", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!DomainRedirect#url:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "url: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "url", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!DomainState:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum DomainState " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "DomainState", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!DomainState.PENDING:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PENDING = " - }, - { - "kind": "Content", - "text": "\"pending\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PENDING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!DomainState.SSL_ACTIVE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "SSL_ACTIVE = " - }, - { - "kind": "Content", - "text": "\"ssl_active\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "SSL_ACTIVE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!DomainState.VALID_CNAME:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "VALID_CNAME = " - }, - { - "kind": "Content", - "text": "\"valid_cname\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "VALID_CNAME" - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Empty:type", - "docComment": "/**\n * An empty response type\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Empty = " - }, - { - "kind": "Content", - "text": "void" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Empty", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Endpoint:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Endpoint = " - }, - { - "kind": "Content", - "text": "{\n method: M;\n path: Path;\n res: Res;\n body: Body;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Endpoint", - "typeParameters": [ - { - "typeParameterName": "M", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Res", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Body", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - } - } - ], - "typeTokenRange": { - "startIndex": 7, - "endIndex": 8 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Endpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Endpoints = " - }, - { - "kind": "Reference", - "text": "IgniteEndpoints", - "canonicalReference": "@onehop/js!IgniteEndpoints:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "RegistryEndpoints", - "canonicalReference": "@onehop/js!RegistryEndpoints:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "UserEndpoints", - "canonicalReference": "@onehop/js!UserEndpoints:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "ProjectsEndpoints", - "canonicalReference": "@onehop/js!ProjectsEndpoints:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "PipeEndpoints", - "canonicalReference": "@onehop/js!PipeEndpoints:type" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "ChannelEndpoints", - "canonicalReference": "@onehop/js!ChannelEndpoints:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Endpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 12 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ErroredAPIResponse:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ErroredAPIResponse = " - }, - { - "kind": "Content", - "text": "{\n success: false;\n error: {\n code: string;\n message: string;\n };\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ErroredAPIResponse", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ExtractEndpoint:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ExtractEndpoint = " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n path: Path;\n method: Method;\n}>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "ExtractEndpoint", - "typeParameters": [ - { - "typeParameterName": "Method", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 5, - "endIndex": 9 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ExtractRouteParams:type", - "docComment": "/**\n * Creates a record of params required for a given URL/path\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ExtractRouteParams = " - }, - { - "kind": "Content", - "text": "string extends T ? " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": " : T extends `${string}:${infer Param}/${infer Rest}` ? {\n [k in Param | keyof " - }, - { - "kind": "Reference", - "text": "ExtractRouteParams", - "canonicalReference": "@onehop/js!ExtractRouteParams:type" - }, - { - "kind": "Content", - "text": "]: string | number;\n} : T extends `${string}:${infer Param}` ? {\n [k in Param]: string | number;\n} : {}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ExtractRouteParams", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 8 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Gateway:interface", - "docComment": "/**\n * Gateways are used to connect services to the internet or a private network\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Gateway " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Gateway", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#created_at:member", - "docComment": "/**\n * The date this gateway was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#deployment_id:member", - "docComment": "/**\n * The deployment this gateway is associated with\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "deployment_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "deployment_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#domains:member", - "docComment": "/**\n * Domains associated with this gateway\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "domains: " - }, - { - "kind": "Reference", - "text": "Domain", - "canonicalReference": "@onehop/js!Domain:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "domains", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#hopsh_domain_enabled:member", - "docComment": "/**\n * Determines if the hop.sh domain is current active.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hopsh_domain_enabled: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "hopsh_domain_enabled", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#hopsh_domain:member", - "docComment": "/**\n * Domain automatically assigned by Hop\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "hopsh_domain: " - }, - { - "kind": "Reference", - "text": "HopShDomain", - "canonicalReference": "@onehop/js!HopShDomain:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "hopsh_domain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#id:member", - "docComment": "/**\n * The ID of the gateway\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'gateway'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#internal_domain:member", - "docComment": "/**\n * Internal domain assigned by user upon gateway creation\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "internal_domain: " - }, - { - "kind": "Reference", - "text": "InternalHopDomain", - "canonicalReference": "@onehop/js!InternalHopDomain:type" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "internal_domain", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#name:member", - "docComment": "/**\n * The name of the gateway\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#target_port:member", - "docComment": "/**\n * Port the Gateway targets (Only for external gateways)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "target_port: " - }, - { - "kind": "Content", - "text": "number | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "target_port", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Gateway#type:member", - "docComment": "/**\n * The type of the gateway\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "GatewayType", - "canonicalReference": "@onehop/js!GatewayType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!GatewayType:enum", - "docComment": "/**\n * Types of gateways supported by Hop\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum GatewayType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "GatewayType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member", - "docComment": "/**\n * The gateway can be accessed from the internet\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "EXTERNAL = " - }, - { - "kind": "Content", - "text": "\"external\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "EXTERNAL" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member", - "docComment": "/**\n * The gateway can only be accessed inside of a project's network\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "INTERNAL = " - }, - { - "kind": "Content", - "text": "\"internal\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "INTERNAL" - } - ] - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!getIdPrefix:function(1)", - "docComment": "/**\n * Gets the prefix of an ID\n *\n * @param id - A full ID to extract the prefix from\n *\n * @param expect - An expected prefix to check against\n *\n * @returns - The prefix of the ID\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function getIdPrefix(id: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", expect?: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "id", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "expect", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": true - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "name": "getIdPrefix" - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!GHRepo:interface", - "docComment": "/**\n * GitHub repo type sent from API (NOT USED IN IMAGES)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface GHRepo " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "GHRepo", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!GHRepo#account_name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "account_name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "account_name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!GHRepo#default_branch:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "default_branch: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "default_branch", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!GHRepo#full_name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "full_name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "full_name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!GHRepo#id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!GHRepo#private:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "private: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "private", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!gigabytes:function(1)", - "docComment": "/**\n * Converts a gigabyte size to a byte size string\n *\n * @param size - Gigabytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function gigabytes(size: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "size", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "gigabytes" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!HealthCheck:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type HealthCheck = " - }, - { - "kind": "Content", - "text": "{\n id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'health_check'>;\n protocol: 'http';\n path: string;\n port: number;\n interval: number;\n timeout: number;\n initial_delay: number;\n max_retries: number;\n created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "HealthCheck", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 6 - } - }, - { - "kind": "Class", - "canonicalReference": "@onehop/js!Hop:class", - "docComment": "/**\n * Root class containing all methods and types for interacting with the Hop platform. This will be the entrypoint for most users of the Hop SDK.\n *\n * @example\n * ```ts\n * const hop = new Hop(bearerTokenOrPATOrProjectToken);\n * await hop.ignite.containers.create(deploymentId);\n * ```\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare class Hop " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "Hop", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@onehop/js!Hop:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `Hop` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(options: " - }, - { - "kind": "Reference", - "text": "PartialAPIOptions", - "canonicalReference": "@onehop/js!PartialAPIOptions:type" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "options", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ] - }, - { - "kind": "Constructor", - "canonicalReference": "@onehop/js!Hop:constructor(2)", - "docComment": "/**\n * Constructs a new instance of the `Hop` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(authentication: " - }, - { - "kind": "Reference", - "text": "APIAuthentication", - "canonicalReference": "@onehop/js!APIAuthentication:type" - }, - { - "kind": "Content", - "text": ", baseurl?: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 2, - "parameters": [ - { - "parameterName": "authentication", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "baseurl", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": true - } - ] - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#channels:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly channels: " - }, - { - "kind": "Content", - "text": "{\n create(type: " - }, - { - "kind": "Reference", - "text": "ChannelType", - "canonicalReference": "@onehop/js!ChannelType:enum" - }, - { - "kind": "Content", - "text": ", id?: string | null | undefined, options?: {\n state?: T;\n } | null | undefined, project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": " & {\n setState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n patchState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeToken(token: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " - }, - { - "kind": "Reference", - "text": "Set", - "canonicalReference": "!Set:interface" - }, - { - "kind": "Content", - "text": "<`leap_token_${string}`>): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n publishMessage(name: string, data: unknown): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n get(id: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": " & {\n setState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n patchState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeToken(token: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " - }, - { - "kind": "Reference", - "text": "Set", - "canonicalReference": "!Set:interface" - }, - { - "kind": "Content", - "text": "<`leap_token_${string}`>): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n publishMessage(name: string, data: unknown): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getAll(project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": " & {\n setState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n patchState(state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeToken(token: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeTokens(tokens: `leap_token_${string}`[] | " - }, - { - "kind": "Reference", - "text": "Set", - "canonicalReference": "!Set:interface" - }, - { - "kind": "Content", - "text": "<`leap_token_${string}`>): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n publishMessage(name: string, data: unknown): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n })[]>;\n subscribeToken(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ", token: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n subscribeTokens(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ", tokens: `leap_token_${string}`[] | " - }, - { - "kind": "Reference", - "text": "Set", - "canonicalReference": "!Set:interface" - }, - { - "kind": "Content", - "text": "<`leap_token_${string}`>): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n getAllTokens(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": "[]>;\n setState(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ", state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n patchState(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ", state: " - }, - { - "kind": "Reference", - "text": "SetStateAction", - "canonicalReference": "@onehop/js!~SetStateAction:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n publishMessage(channel: string | " - }, - { - "kind": "Reference", - "text": "Channel", - "canonicalReference": "@onehop/js!Channel:interface" - }, - { - "kind": "Content", - "text": ", event: string, data: T_5): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n delete(id: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n getStats(id: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<{\n online_count: number;\n }>;\n tokens: {\n delete(token: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n create(state?: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": ", project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ">;\n setState(id: `leap_token_${string}`, state: " - }, - { - "kind": "Reference", - "text": "State", - "canonicalReference": "@onehop/js!State:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ">;\n get(id: `leap_token_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": ">;\n isOnline(idOrToken: `leap_token_${string}` | " - }, - { - "kind": "Reference", - "text": "ChannelToken", - "canonicalReference": "@onehop/js!ChannelToken:interface" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "channels", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 144 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#client:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly client: " - }, - { - "kind": "Reference", - "text": "APIClient", - "canonicalReference": "@onehop/js!APIClient:class" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "client", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#ignite:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly ignite: " - }, - { - "kind": "Content", - "text": "{\n domains: {\n delete: (id: `domain_${string}`) => " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n get: (id: `domain_${string}`) => " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Domain", - "canonicalReference": "@onehop/js!Domain:interface" - }, - { - "kind": "Content", - "text": ">;\n };\n gateways: {\n addDomain(gatewayId: `gateway_${string}`, domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n get(gatewayId: `gateway_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": ">;\n getAll(deploymentId: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n })[]>;\n create(deployment: `deployment_${string}` | " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ", config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n };\n healthChecks: {\n create: (deployment: `deployment_${string}`, config: " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", \"id\">) => " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ">;\n update: (deployment: `deployment_${string}`, config: " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", \"id\">>) => " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n deployments: {\n create: {\n (configOrProject: `project_${string}`, bearerOrPatConfig: " - }, - { - "kind": "Reference", - "text": "CreateDeploymentConfig", - "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": " & {\n getContainers(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n createContainer(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n createGateway(config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getStorageStats(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n (configOrProject: " - }, - { - "kind": "Reference", - "text": "CreateDeploymentConfig", - "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": " & {\n getContainers(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n createContainer(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n createGateway(config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getStorageStats(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n };\n get: {\n (name: string, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": " & {\n getContainers(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n createContainer(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n createGateway(config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getStorageStats(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": " & {\n getContainers(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n createContainer(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n createGateway(config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getStorageStats(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n }>;\n };\n rollout(id: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentRollout", - "canonicalReference": "@onehop/js!DeploymentRollout:type" - }, - { - "kind": "Content", - "text": ">;\n getStorageStats(id: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n update(deploymentId: `deployment_${string}`, config: " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentConfig", - "canonicalReference": "@onehop/js!DeploymentConfig:interface" - }, - { - "kind": "Content", - "text": ">): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ">;\n getContainers(deployment: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n getAll(projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": " & {\n getContainers(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n createContainer(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n createGateway(config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n name: string;\n targetPort: number;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n getStorageStats(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"volume\" | \"build_cache\", " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<\"provisioned_size\" | \"used_size\", number> | null>>;\n })[]>;\n delete(deployment: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n patchMetadata(deploymentId: `deployment_${string}`, metadata: " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentMetaData", - "canonicalReference": "@onehop/js!DeploymentMetaData:interface" - }, - { - "kind": "Content", - "text": ">): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ">;\n gateways: {\n getAll(deploymentId: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n })[]>;\n create(deployment: `deployment_${string}` | " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ", config: {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.EXTERNAL", - "canonicalReference": "@onehop/js!GatewayType.EXTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n } | {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType.INTERNAL", - "canonicalReference": "@onehop/js!GatewayType.INTERNAL:member" - }, - { - "kind": "Content", - "text": ";\n protocol: \"http\" | null;\n targetPort: number;\n name: string;\n internalDomain: string;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": " & {\n addDomain(domain: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n deleteDomain(domainId: `domain_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n };\n };\n containers: {\n delete: {\n (container_id: `container_${string}`, options: {\n recreate: true;\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n (container_id: `container_${string}`, options?: {\n recreate?: false;\n } | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n getLogs(container: `container_${string}`, options?: " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<{\n sortBy: \"timestamp\";\n orderBy: \"desc\" | \"asc\";\n limit: number;\n offset: number;\n }>): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ContainerLog", - "canonicalReference": "@onehop/js!ContainerLog:interface" - }, - { - "kind": "Content", - "text": "[]>;\n stop(container: `container_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n start(container: `container_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n create(deployment: `deployment_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ">;\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "ignite", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 290 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#pipe:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly pipe: " - }, - { - "kind": "Content", - "text": "{\n rooms: {\n getAll(project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<(" - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": " & {\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n })[]>;\n create(name: string, options: {\n deliveryProtocols: " - }, - { - "kind": "Reference", - "text": "DeliveryProtocol", - "canonicalReference": "@onehop/js!DeliveryProtocol:type" - }, - { - "kind": "Content", - "text": "[];\n ephemeral?: boolean;\n ingestProtocol: \"rtmp\" | \"rtp\";\n hlsConfig?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n };\n }): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": " & {\n delete(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n delete(room: `pipe_room_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "pipe", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 18 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#projects:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly projects: " - }, - { - "kind": "Content", - "text": "{\n getAllMembers(projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": "[]>;\n getCurrentMember(projectId: `project_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": ">;\n projectTokens: {\n delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n get(projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[]>;\n create(flags: number, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n };\n tokens: {\n delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n get(projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[]>;\n create(flags: number, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n }>;\n };\n secrets: {\n getAll(projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": "[]>;\n create(name: string, value: string, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": ">;\n delete(id: string, projectId?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "projects", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 44 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#registry:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly registry: " - }, - { - "kind": "Content", - "text": "{\n images: {\n getAll(project?: `project_${string}` | undefined): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n getManifest(image: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<{\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[]>;\n delete(image: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "registry", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 8 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!Hop#users:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly users: " - }, - { - "kind": "Content", - "text": "{\n me: {\n get(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<{\n projects: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": "[];\n user: " - }, - { - "kind": "Reference", - "text": "SelfUser", - "canonicalReference": "@onehop/js!SelfUser:interface" - }, - { - "kind": "Content", - "text": ";\n project_member_role_map: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<`project_${string}`, " - }, - { - "kind": "Reference", - "text": "MemberRole", - "canonicalReference": "@onehop/js!MemberRole:interface" - }, - { - "kind": "Content", - "text": ">;\n leap_token: string | null;\n }>;\n pats: {\n create(name: string): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": ">;\n getAll(): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": "[]>;\n delete(id: `pat_${string}`): " - }, - { - "kind": "Reference", - "text": "Promise", - "canonicalReference": "!Promise:interface" - }, - { - "kind": "Content", - "text": ";\n };\n };\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "users", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 22 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - } - ], - "implementsTokenRanges": [] - }, - { - "kind": "Class", - "canonicalReference": "@onehop/js!HopAPIError:class", - "docComment": "/**\n * An error that occurred as a response from the Hop API.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare class HopAPIError extends " - }, - { - "kind": "Reference", - "text": "Error", - "canonicalReference": "!Error:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "isAbstract": false, - "name": "HopAPIError", - "preserveMemberOrder": false, - "members": [ - { - "kind": "Constructor", - "canonicalReference": "@onehop/js!HopAPIError:constructor(1)", - "docComment": "/**\n * Constructs a new instance of the `HopAPIError` class\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "constructor(request: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "!Request:interface" - }, - { - "kind": "Content", - "text": ", response: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "!Response:interface" - }, - { - "kind": "Content", - "text": ", data: " - }, - { - "kind": "Reference", - "text": "ErroredAPIResponse", - "canonicalReference": "@onehop/js!ErroredAPIResponse:type" - }, - { - "kind": "Content", - "text": ");" - } - ], - "releaseTag": "Public", - "isProtected": false, - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "request", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - }, - { - "parameterName": "response", - "parameterTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "isOptional": false - }, - { - "parameterName": "data", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - } - ] - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!HopAPIError#data:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly data: " - }, - { - "kind": "Reference", - "text": "ErroredAPIResponse", - "canonicalReference": "@onehop/js!ErroredAPIResponse:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "data", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!HopAPIError#request:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly request: " - }, - { - "kind": "Reference", - "text": "Request", - "canonicalReference": "!Request:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "request", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!HopAPIError#response:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly response: " - }, - { - "kind": "Reference", - "text": "Response", - "canonicalReference": "!Response:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "response", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - }, - { - "kind": "Property", - "canonicalReference": "@onehop/js!HopAPIError#status:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "readonly status: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": true, - "isOptional": false, - "releaseTag": "Public", - "name": "status", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isStatic": false, - "isProtected": false, - "isAbstract": false - } - ], - "extendsTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "implementsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!HopShDomain:type", - "docComment": "/**\n * A hop.sh domain (*.hop.sh)\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type HopShDomain = " - }, - { - "kind": "Content", - "text": "`${string}.hop.sh`" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "HopShDomain", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!ID_PREFIXES:var", - "docComment": "/**\n * An array of all IDs that can be used in the API\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ID_PREFIXES: " - }, - { - "kind": "Content", - "text": "readonly [{\n readonly prefix: \"user\";\n readonly description: \"Users\";\n}, {\n readonly prefix: \"project\";\n readonly description: \"Project\";\n}, {\n readonly prefix: \"pm\";\n readonly description: \"Project Members\";\n}, {\n readonly prefix: \"role\";\n readonly description: \"Roles\";\n}, {\n readonly prefix: \"pi\";\n readonly description: \"Project Invite\";\n}, {\n readonly prefix: \"ptk\";\n readonly description: \"Project token\";\n}, {\n readonly prefix: \"pat\";\n readonly description: \"User personal access token\";\n}, {\n readonly prefix: \"container\";\n readonly description: \"Ignite container\";\n}, {\n readonly prefix: \"pipe_room\";\n readonly description: \"Pipe room\";\n}, {\n readonly prefix: \"deployment\";\n readonly description: \"Ignite deployment\";\n}, {\n readonly prefix: \"bearer\";\n readonly description: \"Users bearer token\";\n}, {\n readonly prefix: \"ptkid\";\n readonly description: \"Project token ID\";\n}, {\n readonly prefix: \"secret\";\n readonly description: \"Project secret ID\";\n}, {\n readonly prefix: \"gateway\";\n readonly description: \"Gateway\";\n}, {\n readonly prefix: \"domain\";\n readonly description: \"Domain for a gateway\";\n}, {\n readonly prefix: \"leap_token\";\n readonly description: \"Token for connecting to leap as a client\";\n}, {\n readonly prefix: \"build\";\n readonly description: \"Build ID for build logs\";\n}, {\n readonly prefix: \"rollout\";\n readonly description: \"Rollout ID for rollouts.\";\n}, {\n readonly prefix: \"health_check\";\n readonly description: \"Health check ID for health checks.\";\n}, {\n readonly prefix: \"session\";\n readonly description: \"Session ID for sessions on your account.\";\n}]" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "ID_PREFIXES", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!id:function(1)", - "docComment": "/**\n * Casts a string to an ID and asserts that it is of the correct type. This function will throw if the string is not a valid ID.\n *\n * @param maybeId - Cast and assert that a string is an id\n *\n * @param prefix - Optionally an prefix or array of prefixes to check against\n *\n * @returns - The ID cast to the correct type\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function id(maybeId: " - }, - { - "kind": "Content", - "text": "string | undefined | null" - }, - { - "kind": "Content", - "text": ", prefix?: " - }, - { - "kind": "Content", - "text": "T | T[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "maybeId", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "prefix", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "id" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Id:type", - "docComment": "/**\n * A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. It is a Pika ID — https://github.com/hopinc/pika\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Id = " - }, - { - "kind": "Content", - "text": "`${T}_${string}`" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Id", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!IdPrefixes:type", - "docComment": "/**\n * A union of all ID prefixes used within the API\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type IdPrefixes = " - }, - { - "kind": "Content", - "text": "typeof " - }, - { - "kind": "Reference", - "text": "ID_PREFIXES", - "canonicalReference": "@onehop/js!ID_PREFIXES:var" - }, - { - "kind": "Content", - "text": "[number]['prefix']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "IdPrefixes", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 4 - } - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Ignite:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace ignite " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Ignite", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!IgniteEndpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type IgniteEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments', {\n deployments: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments/:deployment_id/containers', {\n containers: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments/:deployment_id/containers', {\n container: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, {\n deployment_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>;\n container_id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'container'>;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments', {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n}, " - }, - { - "kind": "Reference", - "text": "CreateDeploymentConfig", - "canonicalReference": "@onehop/js!CreateDeploymentConfig:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/ignite/deployments/:deployment_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/ignite/containers/:container_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": " | {\n container: " - }, - { - "kind": "Reference", - "text": "Container", - "canonicalReference": "@onehop/js!Container:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/containers/:container_id/logs', {\n logs: " - }, - { - "kind": "Reference", - "text": "ContainerLog", - "canonicalReference": "@onehop/js!ContainerLog:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments/search', {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments/:deployment_id', {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/ignite/containers/:container_id/state', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", {\n preferred_state: " - }, - { - "kind": "Reference", - "text": "ContainerState.STOPPED", - "canonicalReference": "@onehop/js!ContainerState.STOPPED:member" - }, - { - "kind": "Content", - "text": " | " - }, - { - "kind": "Reference", - "text": "ContainerState.RUNNING", - "canonicalReference": "@onehop/js!ContainerState.RUNNING:member" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/gateways/:gateway_id/domains', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ", {\n domain: string;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/gateways/:gateway_id', {\n gateway: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments/:deployment_id/gateways', {\n gateways: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments/:deployment_id/gateways', {\n gateway: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n type: " - }, - { - "kind": "Reference", - "text": "GatewayType", - "canonicalReference": "@onehop/js!GatewayType:enum" - }, - { - "kind": "Content", - "text": ";\n target_port: number;\n protocol: " - }, - { - "kind": "Reference", - "text": "Gateway", - "canonicalReference": "@onehop/js!Gateway:interface" - }, - { - "kind": "Content", - "text": "['protocol'];\n name: string;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id', {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n}, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentConfig", - "canonicalReference": "@onehop/js!DeploymentConfig:interface" - }, - { - "kind": "Content", - "text": ">> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', {\n deployment: " - }, - { - "kind": "Reference", - "text": "Deployment", - "canonicalReference": "@onehop/js!Deployment:interface" - }, - { - "kind": "Content", - "text": ";\n}, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "DeploymentMetaData", - "canonicalReference": "@onehop/js!DeploymentMetaData:interface" - }, - { - "kind": "Content", - "text": ">> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', {\n rollout: " - }, - { - "kind": "Reference", - "text": "DeploymentRollout", - "canonicalReference": "@onehop/js!DeploymentRollout:type" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/ignite/deployments/:deployment_id/health-check', {\n health_check: " - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ";\n}, " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", 'id'>> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/deployments/:deployment_id/storage', " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<'volume' | 'build_cache', " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<'provisioned_size' | 'used_size', number> | null>> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', {\n health_check: " - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ";\n}, " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "HealthCheck", - "canonicalReference": "@onehop/js!HealthCheck:type" - }, - { - "kind": "Content", - "text": ", 'id'>>> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/ignite/domains/:domain_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/ignite/domains/:domain_id', {\n domain: " - }, - { - "kind": "Reference", - "text": "Domain", - "canonicalReference": "@onehop/js!Domain:interface" - }, - { - "kind": "Content", - "text": ";\n}>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "IgniteEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 127 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Image_2:interface", - "docComment": "/**\n * Docker image config\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Image " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Image_2", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Image_2#auth:member", - "docComment": "/**\n * Authorization required for the registry to access this image This is not required if you use Hop's own registry.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "auth: " - }, - { - "kind": "Reference", - "text": "Auth", - "canonicalReference": "@onehop/js!Auth:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "auth", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Image_2#gh_repo:member", - "docComment": "/**\n * GitHub repo information (if applicable)\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "gh_repo: " - }, - { - "kind": "Reference", - "text": "ImageGHRepo", - "canonicalReference": "@onehop/js!ImageGHRepo:interface" - }, - { - "kind": "Content", - "text": " | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "gh_repo", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Image_2#name:member", - "docComment": "/**\n * The name of the docker image\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!ImageGHRepo:interface", - "docComment": "/**\n * GitHub repo partial used for images\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface ImageGHRepo " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ImageGHRepo", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ImageGHRepo#branch:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "branch: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "branch", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ImageGHRepo#full_name:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "full_name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "full_name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ImageGHRepo#repo_id:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "repo_id: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "repo_id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!InternalHopDomain:type", - "docComment": "/**\n * A domain used with internal gateways (*.hop.sh)\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type InternalHopDomain = " - }, - { - "kind": "Content", - "text": "`${string}.hop`" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "InternalHopDomain", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!IS_BROWSER:var", - "docComment": "/**\n * If we are in the browser.\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "IS_BROWSER: " - }, - { - "kind": "Content", - "text": "boolean" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "IS_BROWSER", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!isValidByteString:function(1)", - "docComment": "/**\n * Validates if a string is a valid byte size string\n *\n * @param value - A string to validate if it is a valid byte size string\n *\n * @returns If the string is a valid byte size string\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function isValidByteString(value: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "value", - "canonicalReference": "@onehop/js!~value" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "value", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "isValidByteString" - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!kilobytes:function(1)", - "docComment": "/**\n * Converts a kilobyte size to a byte size string\n *\n * @param size - Kilobytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function kilobytes(size: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "size", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "kilobytes" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!MakeOptional:type", - "docComment": "/**\n * Makes individual properties optional in a type\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type MakeOptional = " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Pick", - "canonicalReference": "!Pick:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "MakeOptional", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "K", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 9 - } - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!megabytes:function(1)", - "docComment": "/**\n * Converts a megabyte size to a byte size string\n *\n * @param size - Megabytes to convert to a byte size string\n *\n * @returns a byte size string\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function megabytes(size: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "size", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "megabytes" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Member:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Member = " - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@onehop/js!User:interface" - }, - { - "kind": "Content", - "text": ", 'email' | 'id'> & {\n id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'pm'>;\n role: " - }, - { - "kind": "Reference", - "text": "MemberRole", - "canonicalReference": "@onehop/js!MemberRole:interface" - }, - { - "kind": "Content", - "text": ";\n mfa_enabled: boolean;\n joined_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Member", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 11 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!MemberRole:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface MemberRole " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "MemberRole", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!MemberRole#flags:member", - "docComment": "/**\n * The flags for this role\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "flags: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "flags", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!MemberRole#id:member", - "docComment": "/**\n * The ID of the role\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'role'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!MemberRole#name:member", - "docComment": "/**\n * The name of the role\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Method:type", - "docComment": "/**\n * All methods the Hop API accepts\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Method = " - }, - { - "kind": "Content", - "text": "'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Method", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!NixPlan:interface", - "docComment": "/**\n * The validated nixpacks plan for this build\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface NixPlan " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "NixPlan", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!NixPlan#cmds:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "cmds: " - }, - { - "kind": "Content", - "text": "{\n build: string | null;\n start: string | null;\n install: string | null;\n }" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "cmds", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!NixPlan#language:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "language: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "language", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!NixPlan#pkgs:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "pkgs: " - }, - { - "kind": "Content", - "text": "string[] | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "pkgs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!parseSize:function(1)", - "docComment": "/**\n * Parses a byte size string into bytes\n *\n * @param size - The size of anything in gigabytes, megabytes, kilobytes or bytes\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function parseSize(size: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "size", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "parseSize" - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!PartialAPIOptions:type", - "docComment": "/**\n * Partial options for the Hop client\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type PartialAPIOptions = " - }, - { - "kind": "Reference", - "text": "Partial", - "canonicalReference": "!Partial:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Omit", - "canonicalReference": "!Omit:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "APIClientOptions", - "canonicalReference": "@onehop/js!APIClientOptions:interface" - }, - { - "kind": "Content", - "text": ", 'authentication'>> & " - }, - { - "kind": "Reference", - "text": "Pick", - "canonicalReference": "!Pick:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "APIClientOptions", - "canonicalReference": "@onehop/js!APIClientOptions:interface" - }, - { - "kind": "Content", - "text": ", 'authentication'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "PartialAPIOptions", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 11 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!PAT:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface PAT " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "PAT", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!PAT#created_at:member", - "docComment": "/**\n * The date the pat was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!PAT#id:member", - "docComment": "/**\n * The ID of the pat\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'pat'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!PAT#name:member", - "docComment": "/**\n * The name of the pat\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!PathsFor:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type PathsFor = " - }, - { - "kind": "Reference", - "text": "Extract", - "canonicalReference": "!Extract:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Endpoints", - "canonicalReference": "@onehop/js!Endpoints:type" - }, - { - "kind": "Content", - "text": ", {\n method: M;\n}>['path']" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "PathsFor", - "typeParameters": [ - { - "typeParameterName": "M", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!permissions:var", - "docComment": "/**\n * Permission utility functions\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "permissions: " - }, - { - "kind": "Content", - "text": "{\n add(value: bigint, flag: bigint): bigint;\n test(value: bigint, flag: bigint): boolean;\n subtract(value: bigint, flag: bigint): bigint;\n}" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "permissions", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!permissionsMap:var", - "docComment": "/**\n * Individual bitwise permissions\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "permissionsMap: " - }, - { - "kind": "Content", - "text": "{\n add_member: bigint;\n remove_member: bigint;\n get_project_members: bigint;\n delete_project: bigint;\n delete_deployment: bigint;\n delete_container: bigint;\n update_container_state: bigint;\n read_deployments: bigint;\n create_deployment: bigint;\n create_container: bigint;\n update_container_config: bigint;\n create_room: bigint;\n read_room: bigint;\n delete_room: bigint;\n create_room_producer: bigint;\n create_project_token: bigint;\n delete_project_token: bigint;\n read_project_tokens: bigint;\n read_container_logs: bigint;\n create_project_secret: bigint;\n read_project_secrets: bigint;\n delete_project_secret: bigint;\n get_registry_images: bigint;\n create_channel_token: bigint;\n create_gateway: bigint;\n add_domain: bigint;\n delete_channels: bigint;\n update_channel_state: bigint;\n read_channels: bigint;\n publish_channel_messages: bigint;\n manage_channel_subscribers: bigint;\n delete_domain: bigint;\n delete_gateway: bigint;\n get_internal_domain: bigint;\n create_leap_token: bigint;\n read_leap_tokens: bigint;\n update_leap_token: bigint;\n message_token: bigint;\n create_channel: bigint;\n rollout: bigint;\n request_quota_increase: bigint;\n read_billing: bigint;\n read_gateways: bigint;\n delete_registry_images: bigint;\n container_ssh: bigint;\n tunnel_deployment: bigint;\n}" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "permissionsMap", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Pipe:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace pipe " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Pipe", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!PipeEndpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type PipeEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/pipe/rooms', {\n rooms: " - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/pipe/rooms', {\n room: " - }, - { - "kind": "Reference", - "text": "Room", - "canonicalReference": "@onehop/js!Room:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n name: string;\n ingest_protocol: 'rtmp' | 'rtp';\n delivery_protocols: " - }, - { - "kind": "Reference", - "text": "DeliveryProtocol", - "canonicalReference": "@onehop/js!DeliveryProtocol:type" - }, - { - "kind": "Content", - "text": "[];\n region: " - }, - { - "kind": "Reference", - "text": "Regions", - "canonicalReference": "@onehop/js!Regions:enum" - }, - { - "kind": "Content", - "text": ";\n ephemeral: boolean;\n llhls_config?: {\n wcl_delay: number;\n artificial_delay: number;\n max_playout_bitrate_preset: string;\n } | undefined;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/pipe/rooms/:room_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "PipeEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 17 - } - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION:enum", - "docComment": "/**\n * A list of all permissions and their representative names\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum PROJECT_PERMISSION " - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "PROJECT_PERMISSION", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ADD_DOMAIN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ADD_DOMAIN = " - }, - { - "kind": "Content", - "text": "\"add_domain\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ADD_DOMAIN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ADD_MEMBER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ADD_MEMBER = " - }, - { - "kind": "Content", - "text": "\"add_member\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ADD_MEMBER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CONTAINER_SSH:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CONTAINER_SSH = " - }, - { - "kind": "Content", - "text": "\"container_ssh\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CONTAINER_SSH" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CHANNEL:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_CHANNEL = " - }, - { - "kind": "Content", - "text": "\"create_channel\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_CHANNEL" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CHANNEL_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_CHANNEL_TOKEN = " - }, - { - "kind": "Content", - "text": "\"create_channel_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_CHANNEL_TOKEN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_CONTAINER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_CONTAINER = " - }, - { - "kind": "Content", - "text": "\"create_container\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_CONTAINER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_DEPLOYMENT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_DEPLOYMENT = " - }, - { - "kind": "Content", - "text": "\"create_deployment\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_DEPLOYMENT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_GATEWAY:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_GATEWAY = " - }, - { - "kind": "Content", - "text": "\"create_gateway\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_GATEWAY" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_LEAP_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_LEAP_TOKEN = " - }, - { - "kind": "Content", - "text": "\"create_leap_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_LEAP_TOKEN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_PROJECT_SECRET:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_PROJECT_SECRET = " - }, - { - "kind": "Content", - "text": "\"create_project_secret\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_PROJECT_SECRET" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_PROJECT_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_PROJECT_TOKEN = " - }, - { - "kind": "Content", - "text": "\"create_project_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_PROJECT_TOKEN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_ROOM:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_ROOM = " - }, - { - "kind": "Content", - "text": "\"create_room\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_ROOM" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.CREATE_ROOM_PRODUCER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "CREATE_ROOM_PRODUCER = " - }, - { - "kind": "Content", - "text": "\"create_room_producer\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "CREATE_ROOM_PRODUCER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_CHANNELS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_CHANNELS = " - }, - { - "kind": "Content", - "text": "\"delete_channels\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_CHANNELS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_CONTAINER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_CONTAINER = " - }, - { - "kind": "Content", - "text": "\"delete_container\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_CONTAINER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_DEPLOYMENT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_DEPLOYMENT = " - }, - { - "kind": "Content", - "text": "\"delete_deployment\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_DEPLOYMENT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_DOMAIN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_DOMAIN = " - }, - { - "kind": "Content", - "text": "\"delete_domain\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_DOMAIN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_GATEWAY:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_GATEWAY = " - }, - { - "kind": "Content", - "text": "\"delete_gateway\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_GATEWAY" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_PROJECT = " - }, - { - "kind": "Content", - "text": "\"delete_project\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_PROJECT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT_SECRET:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_PROJECT_SECRET = " - }, - { - "kind": "Content", - "text": "\"delete_project_secret\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_PROJECT_SECRET" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_PROJECT_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_PROJECT_TOKEN = " - }, - { - "kind": "Content", - "text": "\"delete_project_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_PROJECT_TOKEN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_REGISTRY_IMAGES:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_REGISTRY_IMAGES = " - }, - { - "kind": "Content", - "text": "\"delete_registry_images\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_REGISTRY_IMAGES" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.DELETE_ROOM:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "DELETE_ROOM = " - }, - { - "kind": "Content", - "text": "\"delete_room\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "DELETE_ROOM" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_INTERNAL_DOMAIN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "GET_INTERNAL_DOMAIN = " - }, - { - "kind": "Content", - "text": "\"get_internal_domain\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "GET_INTERNAL_DOMAIN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_PROJECT_MEMBERS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "GET_PROJECT_MEMBERS = " - }, - { - "kind": "Content", - "text": "\"get_project_members\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "GET_PROJECT_MEMBERS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.GET_REGISTRY_IMAGES:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "GET_REGISTRY_IMAGES = " - }, - { - "kind": "Content", - "text": "\"get_registry_images\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "GET_REGISTRY_IMAGES" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.MANAGE_CHANNEL_SUBSCRIBERS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "MANAGE_CHANNEL_SUBSCRIBERS = " - }, - { - "kind": "Content", - "text": "\"manage_channel_subscribers\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "MANAGE_CHANNEL_SUBSCRIBERS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.MESSAGE_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "MESSAGE_TOKEN = " - }, - { - "kind": "Content", - "text": "\"message_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "MESSAGE_TOKEN" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.PUBLISH_CHANNEL_MESSAGES:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PUBLISH_CHANNEL_MESSAGES = " - }, - { - "kind": "Content", - "text": "\"publish_channel_messages\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PUBLISH_CHANNEL_MESSAGES" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_BILLING:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_BILLING = " - }, - { - "kind": "Content", - "text": "\"read_billing\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_BILLING" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_CHANNELS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_CHANNELS = " - }, - { - "kind": "Content", - "text": "\"read_channels\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_CHANNELS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_CONTAINER_LOGS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_CONTAINER_LOGS = " - }, - { - "kind": "Content", - "text": "\"read_container_logs\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_CONTAINER_LOGS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_DEPLOYMENTS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_DEPLOYMENTS = " - }, - { - "kind": "Content", - "text": "\"read_deployments\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_DEPLOYMENTS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_GATEWAYS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_GATEWAYS = " - }, - { - "kind": "Content", - "text": "\"read_gateways\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_GATEWAYS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_LEAP_TOKENS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_LEAP_TOKENS = " - }, - { - "kind": "Content", - "text": "\"read_leap_tokens\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_LEAP_TOKENS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_PROJECT_SECRETS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_PROJECT_SECRETS = " - }, - { - "kind": "Content", - "text": "\"read_project_secrets\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_PROJECT_SECRETS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_PROJECT_TOKENS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_PROJECT_TOKENS = " - }, - { - "kind": "Content", - "text": "\"read_project_tokens\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_PROJECT_TOKENS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.READ_ROOM:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "READ_ROOM = " - }, - { - "kind": "Content", - "text": "\"read_room\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "READ_ROOM" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.REMOVE_MEMBER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "REMOVE_MEMBER = " - }, - { - "kind": "Content", - "text": "\"remove_member\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "REMOVE_MEMBER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.REQUEST_QUOTA_INCREASE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "REQUEST_QUOTA_INCREASE = " - }, - { - "kind": "Content", - "text": "\"request_quota_increase\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "REQUEST_QUOTA_INCREASE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.ROLLOUT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ROLLOUT = " - }, - { - "kind": "Content", - "text": "\"rollout\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ROLLOUT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.TUNNEL_DEPLOYMENT:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "TUNNEL_DEPLOYMENT = " - }, - { - "kind": "Content", - "text": "\"tunnel_deployment\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "TUNNEL_DEPLOYMENT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CHANNEL_STATE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UPDATE_CHANNEL_STATE = " - }, - { - "kind": "Content", - "text": "\"update_channel_state\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "UPDATE_CHANNEL_STATE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CONTAINER_CONFIG:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UPDATE_CONTAINER_CONFIG = " - }, - { - "kind": "Content", - "text": "\"update_container_config\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "UPDATE_CONTAINER_CONFIG" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_CONTAINER_STATE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UPDATE_CONTAINER_STATE = " - }, - { - "kind": "Content", - "text": "\"update_container_state\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "UPDATE_CONTAINER_STATE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!PROJECT_PERMISSION.UPDATE_LEAP_TOKEN:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "UPDATE_LEAP_TOKEN = " - }, - { - "kind": "Content", - "text": "\"update_leap_token\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "UPDATE_LEAP_TOKEN" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Project:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Project " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Project", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#created_at:member", - "docComment": "/**\n * The time this project was created at\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#default_quotas:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "default_quotas: " - }, - { - "kind": "Reference", - "text": "DefaultQuotas", - "canonicalReference": "@onehop/js!DefaultQuotas:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "default_quotas", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#icon:member", - "docComment": "/**\n * An icon for this project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "icon: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "icon", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#id:member", - "docComment": "/**\n * The ID of the project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'project'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#name:member", - "docComment": "/**\n * The name of the project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#namespace:member", - "docComment": "/**\n * The registry namespace for this project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "namespace: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "namespace", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#quota_overrides:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "quota_overrides: " - }, - { - "kind": "Reference", - "text": "QuotaOverrides", - "canonicalReference": "@onehop/js!QuotaOverrides:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "quota_overrides", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#quota_usage:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "quota_usage: " - }, - { - "kind": "Reference", - "text": "QuotaUsage", - "canonicalReference": "@onehop/js!QuotaUsage:interface" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "quota_usage", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#tier:member", - "docComment": "/**\n * The tier this project is\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "tier: " - }, - { - "kind": "Reference", - "text": "ProjectTier", - "canonicalReference": "@onehop/js!ProjectTier:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "tier", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Project#type:member", - "docComment": "/**\n * The type of this project. Either regular or personal\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "ProjectType", - "canonicalReference": "@onehop/js!ProjectType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Projects:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace projects " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Projects", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!ProjectsEndpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type ProjectsEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/projects/@this/tokens/:project_token_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/:project_id/members/@me', {\n project_member: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": ";\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/:project_id/tokens', {\n project_tokens: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/@this/tokens', {\n project_tokens: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/:project_id/members', {\n members: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/@this/members', {\n members: " - }, - { - "kind": "Reference", - "text": "Member", - "canonicalReference": "@onehop/js!Member:type" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/projects/:project_id/tokens', {\n project_token: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n };\n}, {\n flags: number;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/projects/@this/tokens', {\n project_token: " - }, - { - "kind": "Reference", - "text": "ProjectToken", - "canonicalReference": "@onehop/js!ProjectToken:interface" - }, - { - "kind": "Content", - "text": " & {\n project: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": ";\n };\n}, {\n flags: number;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/projects/:project_id/secrets/:name', {\n secret: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": ";\n}, string> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'PUT', '/v1/projects/@this/secrets/:name', {\n secret: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": ";\n}, string> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/:project_id/secrets', {\n secrets: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/projects/@this/secrets', {\n secrets: " - }, - { - "kind": "Reference", - "text": "Secret", - "canonicalReference": "@onehop/js!Secret:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/projects/@this/secrets/:secret_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ProjectsEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 65 - } - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!ProjectTier:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum ProjectTier " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ProjectTier", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ProjectTier.FREE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FREE = " - }, - { - "kind": "Content", - "text": "\"free\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FREE" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ProjectTier.PAID:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PAID = " - }, - { - "kind": "Content", - "text": "\"paid\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PAID" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!ProjectToken:interface", - "docComment": "/**\n * A project token for a project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface ProjectToken " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ProjectToken", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ProjectToken#created_at:member", - "docComment": "/**\n * The time this project token was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ProjectToken#flags:member", - "docComment": "/**\n * Permissions and flags that this project token can perform\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "flags: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "flags", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ProjectToken#id:member", - "docComment": "/**\n * The Id of the project token\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'ptkid'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ProjectToken#token:member", - "docComment": "/**\n * The key value. This will likely have half of the key obfuscated\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "token: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'ptk'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "token", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!ProjectType:enum", - "docComment": "/**\n * Type of a project\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum ProjectType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ProjectType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ProjectType.PERSONAL:member", - "docComment": "/**\n * A personal project are created when you register an account\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "PERSONAL = " - }, - { - "kind": "Content", - "text": "\"personal\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PERSONAL" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!ProjectType.REGULAR:member", - "docComment": "/**\n * A standard project type\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "REGULAR = " - }, - { - "kind": "Content", - "text": "\"regular\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "REGULAR" - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Query:type", - "docComment": "/**\n * Generate a query object that includes typed URL params\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Query = " - }, - { - "kind": "Reference", - "text": "ExtractRouteParams", - "canonicalReference": "@onehop/js!ExtractRouteParams:type" - }, - { - "kind": "Content", - "text": " & " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "releaseTag": "Public", - "name": "Query", - "typeParameters": [ - { - "typeParameterName": "Path", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 7 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!QuotaOverrides:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface QuotaOverrides " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "QuotaOverrides", - "preserveMemberOrder": false, - "members": [], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!QuotaUsage:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface QuotaUsage " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "QuotaUsage", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!QuotaUsage#ram:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ram: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ram", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!QuotaUsage#vcpu:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "vcpu: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "vcpu", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!QuotaUsage#volume:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "volume: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "volume", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!Regions:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum Regions " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Regions", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!Regions.US_EAST_1:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "US_EAST_1 = " - }, - { - "kind": "Content", - "text": "\"us-east-1\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "US_EAST_1" - } - ] - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Registry:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace registry " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Registry", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!RegistryEndpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type RegistryEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/registry/images/:image', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": "> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/registry/images', {\n images: string[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/registry/images/:image/manifests', {\n manifests: {\n digest: {\n digest: string;\n size: number;\n uploaded: string;\n };\n tag: string | null;\n }[];\n}>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "RegistryEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 9 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Resources:interface", - "docComment": "/**\n * Resources allocated to a deployment\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Resources " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Resources", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Resources#ram:member", - "docComment": "/**\n * Amount of memory to allocate in a readible format You can use the `parseSize` function to convert this to bytes.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ram: " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ram", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Resources#vcpu:member", - "docComment": "/**\n * Amount of vCPU to allocate\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vcpu: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "vcpu", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Resources#vgpu:member", - "docComment": "/**\n * vGPUs to allocate\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "vgpu: " - }, - { - "kind": "Reference", - "text": "Vgpu", - "canonicalReference": "@onehop/js!Vgpu:interface" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "vgpu", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!RestartPolicy:enum", - "docComment": "/**\n * Restart policy for deployments\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum RestartPolicy " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "RestartPolicy", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RestartPolicy.ALWAYS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ALWAYS = " - }, - { - "kind": "Content", - "text": "\"always\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ALWAYS" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RestartPolicy.NEVER:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "NEVER = " - }, - { - "kind": "Content", - "text": "\"never\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "NEVER" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RestartPolicy.ON_FAILURE:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "ON_FAILURE = " - }, - { - "kind": "Content", - "text": "\"on-failure\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "ON_FAILURE" - } - ] - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!roles:var", - "docComment": "/**\n * Bitwise role flags that a user can be as part of a project\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "roles: " - }, - { - "kind": "Content", - "text": "{\n viewer: bigint;\n editor: bigint;\n admin: bigint;\n owner: bigint;\n}" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "roles", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!RolloutState:enum", - "docComment": "/**\n * Rollout state for deployments\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum RolloutState " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "RolloutState", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RolloutState.FAILED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FAILED = " - }, - { - "kind": "Content", - "text": "\"failed\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FAILED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RolloutState.FINISHED:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "FINISHED = " - }, - { - "kind": "Content", - "text": "\"finished\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "FINISHED" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RolloutState.PENDING:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "PENDING = " - }, - { - "kind": "Content", - "text": "\"pending\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PENDING" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Room:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Room " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Room", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#created_at:member", - "docComment": "/**\n * The unix timestamp of when this stream was created\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#delivery_protocols:member", - "docComment": "/**\n * Protocols that are supported by this room to the client\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "delivery_protocols: " - }, - { - "kind": "Reference", - "text": "DeliveryProtocol", - "canonicalReference": "@onehop/js!DeliveryProtocol:type" - }, - { - "kind": "Content", - "text": "[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "delivery_protocols", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#id:member", - "docComment": "/**\n * The ID of this stream\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'pipe_room'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#ingest_endpoint:member", - "docComment": "/**\n * The URL that you can stream to\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ingest_endpoint: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ingest_endpoint", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#ingest_protocol:member", - "docComment": "/**\n * Protocol you can stream with\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ingest_protocol: " - }, - { - "kind": "Content", - "text": "'rtmp'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ingest_protocol", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#ingest_region:member", - "docComment": "/**\n * The region that the stream url is located in\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "ingest_region: " - }, - { - "kind": "Reference", - "text": "Regions", - "canonicalReference": "@onehop/js!Regions:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "ingest_region", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#join_token:member", - "docComment": "/**\n * A join token to subscribe into this room\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "join_token: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "join_token", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#name:member", - "docComment": "/**\n * The name of this room\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Room#state:member", - "docComment": "/**\n * The state of the stream currently\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "state: " - }, - { - "kind": "Content", - "text": "'live' | 'offline'" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "state", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!RuntimeType:enum", - "docComment": "/**\n * Runtime types are used to describe the type of a deployment or container\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum RuntimeType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "RuntimeType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RuntimeType.EPHEMERAL:member", - "docComment": "/**\n * Ephemeral deployments/containers are sort of fire and forget. Containers won't restart if they exit but they can still be terminated programatically.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "EPHEMERAL = " - }, - { - "kind": "Content", - "text": "\"ephemeral\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "EPHEMERAL" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RuntimeType.PERSISTENT:member", - "docComment": "/**\n * Persistent deployments/containers will restart if they exit. They can also be started and stopped programmatically.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "PERSISTENT = " - }, - { - "kind": "Content", - "text": "\"persistent\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "PERSISTENT" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!RuntimeType.STATEFUL:member", - "docComment": "/**\n * Stateful deployments/containers can only run one container at a time, and will have a persistent volume attached.\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "STATEFUL = " - }, - { - "kind": "Content", - "text": "\"stateful\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "STATEFUL" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Secret:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Secret " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Secret", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Secret#created_at:member", - "docComment": "/**\n * The time this secret was created at\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "created_at: " - }, - { - "kind": "Reference", - "text": "Timestamp", - "canonicalReference": "@onehop/js!Timestamp:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "created_at", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Secret#digest:member", - "docComment": "/**\n * A digest hash of the secret\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "digest: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "digest", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Secret#id:member", - "docComment": "/**\n * The ID of the secret\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'secret'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Secret#in_use_by:member", - "docComment": "/**\n * Deployment IDs this secret is used by\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "in_use_by: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'deployment'>[]" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "in_use_by", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Secret#name:member", - "docComment": "/**\n * The name of the secret\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!SelfUser:interface", - "docComment": "/**\n * Self User Object\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface SelfUser extends " - }, - { - "kind": "Reference", - "text": "User", - "canonicalReference": "@onehop/js!User:interface" - }, - { - "kind": "Content", - "text": " " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "SelfUser", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!SelfUser#admin:member", - "docComment": "/**\n * If user is an admin\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "admin: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "admin", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!SelfUser#email_verified:member", - "docComment": "/**\n * If user has verified their email\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "email_verified: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "email_verified", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!SelfUser#mfa_enabled:member", - "docComment": "/**\n * If user has enabled mfa authentication\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mfa_enabled: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "mfa_enabled", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!SelfUser#totp_enabled:member", - "docComment": "/**\n * If user has enabled totp authentication\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "totp_enabled: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "totp_enabled", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!SelfUser#webauthn_enabled:member", - "docComment": "/**\n * If user has enabled webauthn authentication\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "webauthn_enabled: " - }, - { - "kind": "Content", - "text": "boolean" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "webauthn_enabled", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [ - { - "startIndex": 1, - "endIndex": 2 - } - ] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!State:type", - "docComment": "/**\n * Generic state type of a channel\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type State = " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "State", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!SuccessfulAPIResponse:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type SuccessfulAPIResponse = " - }, - { - "kind": "Content", - "text": "{\n success: true;\n data: T;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "SuccessfulAPIResponse", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!SUPPORTS_INTL:var", - "docComment": "/**\n * If this runtiem supports the Intl API\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "SUPPORTS_INTL: " - }, - { - "kind": "Content", - "text": "boolean" - } - ], - "fileUrlPath": "dist/index.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "SUPPORTS_INTL", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Tag:type", - "docComment": "/**\n * Tag a type to make it unique\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Tag = " - }, - { - "kind": "Content", - "text": "T & {\n ___tag: Name;\n}" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Tag", - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 0, - "endIndex": 0 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - }, - { - "typeParameterName": "Name", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 0, - "endIndex": 0 - } - } - ], - "typeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!Timestamp:type", - "docComment": "/**\n * An ISO 8601 date strings\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type Timestamp = " - }, - { - "kind": "Reference", - "text": "Tag", - "canonicalReference": "@onehop/js!Tag:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Timestamp", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "Variable", - "canonicalReference": "@onehop/js!units:var", - "docComment": "/**\n * @deprecated\n *\n * use `byteUnits` instead\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "units: " - }, - { - "kind": "Content", - "text": "readonly [\"GB\", \"MB\", \"KB\", \"B\"]" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "isReadonly": true, - "releaseTag": "Public", - "name": "units", - "variableTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!User:interface", - "docComment": "/**\n * A user object\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface User " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "User", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!User#email:member", - "docComment": "/**\n * The email of the user\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "email: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "email", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!User#id:member", - "docComment": "/**\n * The ID of the user\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "id: " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'user'>" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "id", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 3 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!User#name:member", - "docComment": "/**\n * The name of the user. Think of this as a display name\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "name: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "name", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!User#username:member", - "docComment": "/**\n * A unqiue username for the user\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "username: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "username", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "TypeAlias", - "canonicalReference": "@onehop/js!UserEndpoints:type", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "type UserEndpoints = " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/users/@me', {\n projects: " - }, - { - "kind": "Reference", - "text": "Project", - "canonicalReference": "@onehop/js!Project:interface" - }, - { - "kind": "Content", - "text": "[];\n user: " - }, - { - "kind": "Reference", - "text": "SelfUser", - "canonicalReference": "@onehop/js!SelfUser:interface" - }, - { - "kind": "Content", - "text": ";\n project_member_role_map: " - }, - { - "kind": "Reference", - "text": "Record", - "canonicalReference": "!Record:type" - }, - { - "kind": "Content", - "text": "<" - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "<'project'>, " - }, - { - "kind": "Reference", - "text": "MemberRole", - "canonicalReference": "@onehop/js!MemberRole:interface" - }, - { - "kind": "Content", - "text": ">;\n leap_token: string | null;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'POST', '/v1/users/@me/pats', {\n pat: " - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": ";\n}, {\n name: string;\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'GET', '/v1/users/@me/pats', {\n pats: " - }, - { - "kind": "Reference", - "text": "PAT", - "canonicalReference": "@onehop/js!PAT:interface" - }, - { - "kind": "Content", - "text": "[];\n}> | " - }, - { - "kind": "Reference", - "text": "Endpoint", - "canonicalReference": "@onehop/js!Endpoint:type" - }, - { - "kind": "Content", - "text": "<'DELETE', '/v1/users/@me/pats/:pat_id', " - }, - { - "kind": "Reference", - "text": "Empty", - "canonicalReference": "@onehop/js!Empty:type" - }, - { - "kind": "Content", - "text": ">" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "UserEndpoints", - "typeTokenRange": { - "startIndex": 1, - "endIndex": 25 - } - }, - { - "kind": "Namespace", - "canonicalReference": "@onehop/js!Users:namespace", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare namespace users " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Users", - "preserveMemberOrder": false, - "members": [] - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!validateAPIAuthentication:function(1)", - "docComment": "/**\n * Validates that an authentication prefix is valid\n *\n * @param auth - The prefix to validate\n *\n * @returns `true` if the prefix is valid, `false` otherwise\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function validateAPIAuthentication(auth: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "auth", - "canonicalReference": "@onehop/js!~auth" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "APIAuthenticationPrefix", - "canonicalReference": "@onehop/js!APIAuthenticationPrefix:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/index.d.ts", - "returnTypeTokenRange": { - "startIndex": 3, - "endIndex": 6 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "auth", - "parameterTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "isOptional": false - } - ], - "name": "validateAPIAuthentication" - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!validateId:function(1)", - "docComment": "/**\n * Validates that a string is a valid ID\n *\n * @param maybeId - A string that might be an id\n *\n * @param prefix - Optionally an id prefix to check against\n *\n * @returns true if the string is an id\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function validateId(maybeId: " - }, - { - "kind": "Content", - "text": "string | undefined | null" - }, - { - "kind": "Content", - "text": ", prefix?: " - }, - { - "kind": "Content", - "text": "T | T[]" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "maybeId", - "canonicalReference": "@onehop/js!~maybeId" - }, - { - "kind": "Content", - "text": " is " - }, - { - "kind": "Reference", - "text": "Id", - "canonicalReference": "@onehop/js!Id:type" - }, - { - "kind": "Content", - "text": "" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 13 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "maybeId", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "prefix", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "validateId" - }, - { - "kind": "Function", - "canonicalReference": "@onehop/js!validateIdPrefix:function(1)", - "docComment": "/**\n * Checks if a string is a valid Hop ID prefix\n *\n * @param prefix - A string that is a potential prefix\n *\n * @param expect - An expected prefix to check against\n *\n * @returns - Whether the prefix is valid\n *\n * @public\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare function validateIdPrefix(prefix: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ", expect?: " - }, - { - "kind": "Content", - "text": "T" - }, - { - "kind": "Content", - "text": "): " - }, - { - "kind": "Reference", - "text": "prefix", - "canonicalReference": "@onehop/js!~prefix" - }, - { - "kind": "Content", - "text": " is T" - }, - { - "kind": "Content", - "text": ";" - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "returnTypeTokenRange": { - "startIndex": 9, - "endIndex": 11 - }, - "releaseTag": "Public", - "overloadIndex": 1, - "parameters": [ - { - "parameterName": "prefix", - "parameterTypeTokenRange": { - "startIndex": 5, - "endIndex": 6 - }, - "isOptional": false - }, - { - "parameterName": "expect", - "parameterTypeTokenRange": { - "startIndex": 7, - "endIndex": 8 - }, - "isOptional": true - } - ], - "typeParameters": [ - { - "typeParameterName": "T", - "constraintTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "defaultTypeTokenRange": { - "startIndex": 3, - "endIndex": 4 - } - } - ], - "name": "validateIdPrefix" - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!ValidationFailure:interface", - "docComment": "/**\n * Why the uploaded build content was rejected\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface ValidationFailure " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "ValidationFailure", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ValidationFailure#help_link:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "help_link: " - }, - { - "kind": "Content", - "text": "string | null" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "help_link", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!ValidationFailure#reason:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "reason: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "reason", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!Vgpu:interface", - "docComment": "/**\n * Virtual GPU config\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface Vgpu " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "Vgpu", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Vgpu#count:member", - "docComment": "/**\n * The amount of vGPUs to allocate\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "count: " - }, - { - "kind": "Content", - "text": "number" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "count", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!Vgpu#type:member", - "docComment": "/**\n * The type of vGPU to allocate\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "type: " - }, - { - "kind": "Reference", - "text": "VgpuType", - "canonicalReference": "@onehop/js!VgpuType:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "type", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!VgpuType:enum", - "docComment": "/**\n * Types for supported GPU\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum VgpuType " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "VgpuType", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!VgpuType.A400:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "A400 = " - }, - { - "kind": "Content", - "text": "\"a400\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "A400" - } - ] - }, - { - "kind": "Interface", - "canonicalReference": "@onehop/js!VolumeDefinition:interface", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "interface VolumeDefinition " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "VolumeDefinition", - "preserveMemberOrder": false, - "members": [ - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!VolumeDefinition#fs:member", - "docComment": "/**\n * The format of the volume\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "fs: " - }, - { - "kind": "Reference", - "text": "VolumeFormat", - "canonicalReference": "@onehop/js!VolumeFormat:enum" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "fs", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!VolumeDefinition#mount_path:member", - "docComment": "/**\n * The mount point of the volume\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "mount_path: " - }, - { - "kind": "Content", - "text": "string" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "mount_path", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - }, - { - "kind": "PropertySignature", - "canonicalReference": "@onehop/js!VolumeDefinition#size:member", - "docComment": "/**\n * The size of the volume in bytes\n */\n", - "excerptTokens": [ - { - "kind": "Content", - "text": "size: " - }, - { - "kind": "Reference", - "text": "ByteSizeString", - "canonicalReference": "@onehop/js!ByteSizeString:type" - }, - { - "kind": "Content", - "text": ";" - } - ], - "isReadonly": false, - "isOptional": false, - "releaseTag": "Public", - "name": "size", - "propertyTypeTokenRange": { - "startIndex": 1, - "endIndex": 2 - } - } - ], - "extendsTokenRanges": [] - }, - { - "kind": "Enum", - "canonicalReference": "@onehop/js!VolumeFormat:enum", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "declare enum VolumeFormat " - } - ], - "fileUrlPath": "dist/channels-f16e881f.d.ts", - "releaseTag": "Public", - "name": "VolumeFormat", - "preserveMemberOrder": false, - "members": [ - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!VolumeFormat.EXT4:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "EXT4 = " - }, - { - "kind": "Content", - "text": "\"ext4\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "EXT4" - }, - { - "kind": "EnumMember", - "canonicalReference": "@onehop/js!VolumeFormat.XFS:member", - "docComment": "", - "excerptTokens": [ - { - "kind": "Content", - "text": "XFS = " - }, - { - "kind": "Content", - "text": "\"xfs\"" - } - ], - "initializerTokenRange": { - "startIndex": 1, - "endIndex": 2 - }, - "releaseTag": "Public", - "name": "XFS" - } - ] - } - ] - } - ] -} diff --git a/.temp/js.api.md b/.temp/js.api.md deleted file mode 100644 index c638516d..00000000 --- a/.temp/js.api.md +++ /dev/null @@ -1,1953 +0,0 @@ -## API Report File for "@onehop/js" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -// @public -export type AnyId = Id; - -// @public (undocumented) -export namespace API { - { - channels as Channels, - ignite as Ignite, - pipe as Pipe, - projects as Projects, - registry as Registry, - users as Users, - }; -} - -// @public -export type APIAuthentication = Id; - -// @public -export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; - -// @public -export class APIClient { - constructor(options: APIClientOptions); - // (undocumented) - readonly authType: APIAuthenticationPrefix; - // (undocumented) - delete['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }> | Extract, { - path: Path; - method: 'DELETE'; - }>)["res"]>; - // (undocumented) - get>(path: Path, query: Query, init?: RequestInit): Promise<(Extract; - leap_token: string | null; - }>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract | null>>, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }> | Extract, { - path: Path; - method: 'GET'; - }>)["res"]>; - // (undocumented) - static getAuthType(auth: APIAuthentication): APIAuthenticationPrefix; - // (undocumented) - patch['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PATCH'; - }> | Extract, { - path: Path; - method: 'PATCH'; - }> | Extract>, { - path: Path; - method: 'PATCH'; - }> | Extract>, { - path: Path; - method: 'PATCH'; - }> | Extract>>, { - path: Path; - method: 'PATCH'; - }>)["res"]>; - // (undocumented) - post['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract | null; - }>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }> | Extract>, { - path: Path; - method: 'POST'; - }> | Extract, { - path: Path; - method: 'POST'; - }>)["res"]>; - // (undocumented) - put['path']>(path: Path, body: Extract['body'], query: Query, init?: RequestInit): Promise<(Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract | null; - }>, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }> | Extract, { - path: Path; - method: 'PUT'; - }>)["res"]>; - // (undocumented) - raw(request: Request): Promise; - // (undocumented) - readonly url: (path: Path, query: Query) => string; -} - -// @public -export interface APIClientOptions { - // (undocumented) - readonly authentication: APIAuthentication; - // (undocumented) - readonly baseUrl: string; -} - -// @public (undocumented) -export type APIResponse = SuccessfulAPIResponse | ErroredAPIResponse; - -// @public -export function assertId(maybeId: string | undefined | null, prefix?: T | T[], message?: string): asserts maybeId is Id; - -// @public -export interface Auth { - // (undocumented) - password: string; - // (undocumented) - username: string; -} - -// @public -export const BROAD_PERMISSIONS_MAP: { - MANAGE_MEMBERS: bigint; - MANAGE_PROJECT_TOKENS: bigint; - MANAGE_DEPLOYMENTS: bigint; - MANAGE_PIPE: bigint; - MANAGE_SECRETS: bigint; - MANAGE_CHANNELS: bigint; - MANAGE_REGISTRY: bigint; - READ_ONLY: bigint; - MANAGE_QUOTAS: bigint; - MANAGE_ROLLOUTS: bigint; - MANAGE_BILLING: bigint; -}; - -// @public (undocumented) -export interface Build { - created_at?: Timestamp; - deployment_id: Id<'deployment'>; - digest: string | null; - environment: BuildEnvironment | null; - finished_at: Timestamp | null; - id: Id<'build'>; - metadata: BuildMetaData | null; - method: BuildMethod; - started_at: Timestamp | null; - state: BuildState; - validation_failure: ValidationFailure | null; -} - -// @public -export interface BuildEnvironment { - // (undocumented) - nix_plan?: NixPlan | null; - // (undocumented) - type: BuildEnvironmentType; -} - -// @public -export enum BuildEnvironmentType { - // (undocumented) - DOCKERFILE = "dockerfile", - // (undocumented) - NIXPACKS = "nixpacks" -} - -// @public -export interface BuildMetaData { - account_type?: 'user' | 'organization'; - author?: { - avatar_url: string; - username: string; - }; - branch: string; - commit_msg: string; - commit_sha: string; - commit_url?: string; - repo_id: number; - repo_name: string; -} - -// @public -export enum BuildMethod { - // (undocumented) - CLI = "cli", - // (undocumented) - GITHUB = "github" -} - -// @public (undocumented) -export interface BuildSettings { - root_directory?: string; -} - -// @public (undocumented) -export enum BuildState { - // (undocumented) - CANCELLED = "cancelled", - // (undocumented) - FAILED = "failed", - // (undocumented) - PENDING = "pending", - // (undocumented) - SUCCEEDED = "succeeded", - // (undocumented) - VALIDATING = "validating", - // (undocumented) - VALIDATION_FAILED = "validation_failed" -} - -// @public -export function bytes(size: number, unit?: ByteUnit): ByteSizeString; - -// @public -export type ByteSizeString = `${number}${ByteUnit}`; - -// @public @deprecated -export type ByteString = ByteSizeString; - -// @public -export type ByteUnit = typeof byteUnits[number]; - -// @public -export const byteUnits: readonly ["GB", "MB", "KB", "B"]; - -// @public -export interface Channel { - capabilities: number; - created_at: Timestamp; - id: string; - project: Project; - state: State; - type: ChannelType; -} - -// @public -export type ChannelEndpoints = Endpoint<'POST', '/v1/channels', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'PUT', '/v1/channels/:channel_id', { - channel: Channel; -}, { - type: ChannelType; - state: Record | null; -}> | Endpoint<'POST', '/v1/channels/tokens', { - token: ChannelToken; -}, { - state: State; -}> | Endpoint<'DELETE', '/v1/channels/:channel_id', Empty> | Endpoint<'GET', '/v1/channels/:channel_id', { - channel: Channel; -}> | Endpoint<'GET', '/v1/channels/:channel_id/tokens', { - tokens: ChannelToken[]; -}> | Endpoint<'POST', '/v1/channels/tokens/:token/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'PUT', '/v1/channels/:channel_id/subscribers/:token', Empty> | Endpoint<'PATCH', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'PUT', '/v1/channels/:channel_id/state', Empty, State> | Endpoint<'GET', '/v1/channels/:channel_id/state', { - state: State; -}> | Endpoint<'POST', '/v1/channels/:channel_id/messages', Empty, { - e: string; - d: unknown; -}> | Endpoint<'GET', '/v1/channels', { - channels: Channel[]; -}> | Endpoint<'GET', '/v1/channels/tokens/:token', { - token: ChannelToken; -}> | Endpoint<'PATCH', '/v1/channels/tokens/:token', { - token: ChannelToken; -}, { - expiresAt?: Timestamp | null; - state: ChannelToken['state']; -}> | Endpoint<'DELETE', '/v1/channels/tokens/:token', Empty> | Endpoint<'GET', '/v1/channels/:channel_id/stats', { - stats: { - online_count: number; - }; -}>; - -// @public (undocumented) -export namespace Channels { - { - channels_Channel as Channel, - channels_ChannelEndpoints as ChannelEndpoints, - channels_ChannelToken as ChannelToken, - channels_ChannelType as ChannelType, - channels_State as State, - }; -} - -// @public (undocumented) -export interface ChannelToken { - id: Id<'leap_token'>; - is_online: boolean; - project_id: Id<'project'>; - state: State; -} - -// @public -export enum ChannelType { - // (undocumented) - PRIVATE = "private", - // (undocumented) - PUBLIC = "public", - // (undocumented) - UNPROTECTED = "unprotected" -} - -// @public (undocumented) -export interface Container { - created_at: Timestamp; - deployment_id: Id<'deployment'>; - id: Id<'container'>; - internal_ip: string; - metadata: { - last_exit_code?: number; - }; - metrics: { - cpu_usage_percent: number; - memory_usage_percent: number; - } | null; - overrides: { - resources?: Partial; - } | null; - region: Regions; - state: ContainerState; - type: RuntimeType; - uptime: { - last_start: Timestamp; - }; - volume: VolumeDefinition | null; -} - -// @public -export interface ContainerLog { - level: 'info' | 'error'; - message: string; - nonce: string; - timestamp: Timestamp; -} - -// @public -export enum ContainerState { - EXITED = "exited", - FAILED = "failed", - PENDING = "pending", - RUNNING = "running", - STOPPED = "stopped", - TERMINATING = "terminating" -} - -// @public -export enum ContainerStrategy { - MANUAL = "manual" -} - -// @public (undocumented) -export type CreateDeploymentConfig = MakeOptional; - -// @public -export const DEFAULT_BASE_URL = "https://api.hop.io"; - -// @public (undocumented) -export interface DefaultQuotas { - // (undocumented) - ram: number; - // (undocumented) - vcpu: number; - // (undocumented) - volume: number; -} - -// @public (undocumented) -export type DeliveryProtocol = 'webrtc' | 'hls'; - -// @public (undocumented) -export interface Deployment { - active_build: Build | null; - // @deprecated - active_rollout: DeploymentRollout | null; - build_cache_enabled: boolean; - build_id: Build['id'] | null; - build_settings?: BuildSettings; - config: Omit; - container_count: number; - created_at: Timestamp; - id: Id<'deployment'>; - latest_rollout: DeploymentRollout | null; - metadata: DeploymentMetaData | null; - name: string; - running_container_count: number; - target_container_count: number; -} - -// @public (undocumented) -export interface DeploymentConfig { - cmd?: string[]; - container_strategy: ContainerStrategy; - entrypoint?: string[]; - env: Record; - image: Image_2; - name: string; - resources: Resources; - restart_policy: RestartPolicy; - type: RuntimeType; - version: '12-12-2022'; - volume?: VolumeDefinition; -} - -// @public (undocumented) -export interface DeploymentMetaData { - // (undocumented) - container_port_mappings: Record, string[]>; - // (undocumented) - created_first_gateway?: boolean; - // (undocumented) - created_from_preset?: string; - // (undocumented) - ignored_boarding?: boolean; -} - -// @public -export type DeploymentRollout = { - id: Id<'rollout'>; - deployment_id: Id<'deployment'>; - count: number; - created_at: Timestamp; - state: RolloutState; - build: Build | null; - init_container_id: string | null; - health_check_failed: boolean; - last_updated_at: Timestamp; - acknowledged: boolean; -}; - -// @public (undocumented) -export interface Domain { - created_at: Timestamp; - domain: string; - id: Id<'domain'>; - redirect: DomainRedirect | null; - state: DomainState; -} - -// @public (undocumented) -export interface DomainRedirect { - // (undocumented) - status_code: 301 | 302 | 307 | 308; - // (undocumented) - url: string; -} - -// @public (undocumented) -export enum DomainState { - // (undocumented) - PENDING = "pending", - // (undocumented) - SSL_ACTIVE = "ssl_active", - // (undocumented) - VALID_CNAME = "valid_cname" -} - -// @public -export type Empty = void; - -// @public (undocumented) -export type Endpoint = { - method: M; - path: Path; - res: Res; - body: Body; -}; - -// @public (undocumented) -export type Endpoints = IgniteEndpoints | RegistryEndpoints | UserEndpoints | ProjectsEndpoints | PipeEndpoints | ChannelEndpoints; - -// @public (undocumented) -export type ErroredAPIResponse = { - success: false; - error: { - code: string; - message: string; - }; -}; - -// @public (undocumented) -export type ExtractEndpoint = Extract; - -// @public -export type ExtractRouteParams = string extends T ? Record : T extends `${string}:${infer Param}/${infer Rest}` ? { - [k in Param | keyof ExtractRouteParams]: string | number; -} : T extends `${string}:${infer Param}` ? { - [k in Param]: string | number; -} : {}; - -// @public -export interface Gateway { - created_at: Timestamp; - deployment_id: Id<'deployment'>; - domains: Domain[]; - hopsh_domain: HopShDomain | null; - hopsh_domain_enabled: boolean; - id: Id<'gateway'>; - internal_domain: InternalHopDomain | null; - name: string; - // @alpha - protocol: 'http' | null; - target_port: number | null; - type: GatewayType; -} - -// @public -export enum GatewayType { - EXTERNAL = "external", - INTERNAL = "internal" -} - -// @public -export function getIdPrefix(id: string, expect?: T): T; - -// @public -export interface GHRepo { - // (undocumented) - account_name: string; - // (undocumented) - default_branch: string; - // (undocumented) - full_name: string; - // (undocumented) - id: number; - // (undocumented) - private: boolean; -} - -// @public -export function gigabytes(size: number): ByteSizeString; - -// @public (undocumented) -export type HealthCheck = { - id: Id<'health_check'>; - protocol: 'http'; - path: string; - port: number; - interval: number; - timeout: number; - initial_delay: number; - max_retries: number; - created_at: Timestamp; -}; - -// @public -export class Hop { - constructor(options: PartialAPIOptions); - constructor(authentication: APIAuthentication, baseurl?: string); - // (undocumented) - readonly channels: { - create(type: ChannelType, id?: string | null | undefined, options?: { - state?: T; - } | null | undefined, project?: `project_${string}` | undefined): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - get(id: string): Promise(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - }>; - getAll(project?: `project_${string}` | undefined): Promise<(Channel & { - setState(state: SetStateAction): Promise; - patchState(state: SetStateAction): Promise; - subscribeToken(token: `leap_token_${string}`): Promise; - subscribeTokens(tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - publishMessage(name: string, data: unknown): Promise; - })[]>; - subscribeToken(channel: string | Channel, token: `leap_token_${string}`): Promise; - subscribeTokens(channel: string | Channel, tokens: `leap_token_${string}`[] | Set<`leap_token_${string}`>): Promise; - getAllTokens(channel: string | Channel): Promise; - setState(channel: string | Channel, state: SetStateAction): Promise; - patchState(channel: string | Channel, state: SetStateAction): Promise; - publishMessage(channel: string | Channel, event: string, data: T_5): Promise; - delete(id: string): Promise; - getStats(id: string): Promise<{ - online_count: number; - }>; - tokens: { - delete(token: `leap_token_${string}`): Promise; - create(state?: State, project?: `project_${string}` | undefined): Promise; - setState(id: `leap_token_${string}`, state: State): Promise; - get(id: `leap_token_${string}`): Promise; - isOnline(idOrToken: `leap_token_${string}` | ChannelToken): Promise; - publishDirectMessage(token: `leap_token_${string}`, event: string, data: T_6): Promise; - }; - }; - // (undocumented) - readonly client: APIClient; - // (undocumented) - readonly ignite: { - domains: { - delete: (id: `domain_${string}`) => Promise; - get: (id: `domain_${string}`) => Promise; - }; - gateways: { - addDomain(gatewayId: `gateway_${string}`, domain: string): Promise; - get(gatewayId: `gateway_${string}`): Promise; - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - }; - healthChecks: { - create: (deployment: `deployment_${string}`, config: Omit) => Promise; - update: (deployment: `deployment_${string}`, config: Partial>) => Promise; - }; - deployments: { - create: { - (configOrProject: `project_${string}`, bearerOrPatConfig: CreateDeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - (configOrProject: CreateDeploymentConfig): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - }; - get: { - (name: string, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - (id: `deployment_${string}`, projectId?: `project_${string}` | undefined): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - }>; - }; - rollout(id: `deployment_${string}`): Promise; - getStorageStats(id: `deployment_${string}`): Promise | null>>; - update(deploymentId: `deployment_${string}`, config: Partial): Promise; - getContainers(deployment: `deployment_${string}`): Promise; - getAll(projectId?: `project_${string}` | undefined): Promise<(Deployment & { - getContainers(): Promise; - delete(): Promise; - createContainer(): Promise; - createGateway(config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - name: string; - targetPort: number; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - getStorageStats(): Promise | null>>; - })[]>; - delete(deployment: `deployment_${string}`): Promise; - patchMetadata(deploymentId: `deployment_${string}`, metadata: Partial): Promise; - gateways: { - getAll(deploymentId: `deployment_${string}`): Promise<(Gateway & { - addDomain(domain: string): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - })[]>; - create(deployment: `deployment_${string}` | Deployment, config: { - type: GatewayType.EXTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - } | { - type: GatewayType.INTERNAL; - protocol: "http" | null; - targetPort: number; - name: string; - internalDomain: string; - }): Promise; - deleteDomain(domainId: `domain_${string}`): Promise; - }>; - }; - }; - containers: { - delete: { - (container_id: `container_${string}`, options: { - recreate: true; - }): Promise; - (container_id: `container_${string}`, options?: { - recreate?: false; - } | undefined): Promise; - }; - getLogs(container: `container_${string}`, options?: Partial<{ - sortBy: "timestamp"; - orderBy: "desc" | "asc"; - limit: number; - offset: number; - }>): Promise; - stop(container: `container_${string}`): Promise; - start(container: `container_${string}`): Promise; - create(deployment: `deployment_${string}`): Promise; - }; - }; - // (undocumented) - readonly pipe: { - rooms: { - getAll(project?: `project_${string}` | undefined): Promise<(Room & { - delete(): Promise; - })[]>; - create(name: string, options: { - deliveryProtocols: DeliveryProtocol[]; - ephemeral?: boolean; - ingestProtocol: "rtmp" | "rtp"; - hlsConfig?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - }; - }): Promise; - }>; - delete(room: `pipe_room_${string}`): Promise; - }; - }; - // (undocumented) - readonly projects: { - getAllMembers(projectId?: `project_${string}` | undefined): Promise; - getCurrentMember(projectId: `project_${string}`): Promise; - projectTokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - tokens: { - delete(projectTokenId: `ptkid_${string}`, project?: `project_${string}` | undefined): Promise; - get(projectId?: `project_${string}` | undefined): Promise; - create(flags: number, projectId?: `project_${string}` | undefined): Promise; - }; - secrets: { - getAll(projectId?: `project_${string}` | undefined): Promise; - create(name: string, value: string, projectId?: `project_${string}` | undefined): Promise; - delete(id: string, projectId?: `project_${string}` | undefined): Promise; - }; - }; - // (undocumented) - readonly registry: { - images: { - getAll(project?: `project_${string}` | undefined): Promise; - getManifest(image: string): Promise<{ - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]>; - delete(image: string): Promise; - }; - }; - // (undocumented) - readonly users: { - me: { - get(): Promise<{ - projects: Project[]; - user: SelfUser; - project_member_role_map: Record<`project_${string}`, MemberRole>; - leap_token: string | null; - }>; - pats: { - create(name: string): Promise; - getAll(): Promise; - delete(id: `pat_${string}`): Promise; - }; - }; - }; -} - -// @public -export class HopAPIError extends Error { - constructor(request: Request, response: Response, data: ErroredAPIResponse); - // (undocumented) - readonly data: ErroredAPIResponse; - // (undocumented) - readonly request: Request; - // (undocumented) - readonly response: Response; - // (undocumented) - readonly status: number; -} - -// @public -export type HopShDomain = `${string}.hop.sh`; - -// @public -export type Id = `${T}_${string}`; - -// @public -export function id(maybeId: string | undefined | null, prefix?: T | T[]): Id; - -// @public -export const ID_PREFIXES: readonly [{ - readonly prefix: "user"; - readonly description: "Users"; -}, { - readonly prefix: "project"; - readonly description: "Project"; -}, { - readonly prefix: "pm"; - readonly description: "Project Members"; -}, { - readonly prefix: "role"; - readonly description: "Roles"; -}, { - readonly prefix: "pi"; - readonly description: "Project Invite"; -}, { - readonly prefix: "ptk"; - readonly description: "Project token"; -}, { - readonly prefix: "pat"; - readonly description: "User personal access token"; -}, { - readonly prefix: "container"; - readonly description: "Ignite container"; -}, { - readonly prefix: "pipe_room"; - readonly description: "Pipe room"; -}, { - readonly prefix: "deployment"; - readonly description: "Ignite deployment"; -}, { - readonly prefix: "bearer"; - readonly description: "Users bearer token"; -}, { - readonly prefix: "ptkid"; - readonly description: "Project token ID"; -}, { - readonly prefix: "secret"; - readonly description: "Project secret ID"; -}, { - readonly prefix: "gateway"; - readonly description: "Gateway"; -}, { - readonly prefix: "domain"; - readonly description: "Domain for a gateway"; -}, { - readonly prefix: "leap_token"; - readonly description: "Token for connecting to leap as a client"; -}, { - readonly prefix: "build"; - readonly description: "Build ID for build logs"; -}, { - readonly prefix: "rollout"; - readonly description: "Rollout ID for rollouts."; -}, { - readonly prefix: "health_check"; - readonly description: "Health check ID for health checks."; -}, { - readonly prefix: "session"; - readonly description: "Session ID for sessions on your account."; -}]; - -// @public -export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; - -// @public (undocumented) -export namespace Ignite { - { - ignite_Auth as Auth, - ignite_Build as Build, - ignite_BuildEnvironment as BuildEnvironment, - ignite_BuildEnvironmentType as BuildEnvironmentType, - ignite_BuildMetaData as BuildMetaData, - ignite_BuildMethod as BuildMethod, - ignite_BuildSettings as BuildSettings, - ignite_BuildState as BuildState, - ignite_Container as Container, - ignite_ContainerLog as ContainerLog, - ignite_ContainerState as ContainerState, - ignite_ContainerStrategy as ContainerStrategy, - ignite_CreateDeploymentConfig as CreateDeploymentConfig, - ignite_Deployment as Deployment, - ignite_DeploymentConfig as DeploymentConfig, - ignite_DeploymentMetaData as DeploymentMetaData, - ignite_DeploymentRollout as DeploymentRollout, - ignite_Domain as Domain, - ignite_DomainRedirect as DomainRedirect, - ignite_DomainState as DomainState, - ignite_GHRepo as GHRepo, - ignite_Gateway as Gateway, - ignite_GatewayType as GatewayType, - ignite_HealthCheck as HealthCheck, - ignite_IgniteEndpoints as IgniteEndpoints, - ignite_Image as Image, - ignite_ImageGHRepo as ImageGHRepo, - ignite_NixPlan as NixPlan, - ignite_Regions as Regions, - ignite_Resources as Resources, - ignite_RestartPolicy as RestartPolicy, - ignite_RolloutState as RolloutState, - ignite_RuntimeType as RuntimeType, - ignite_ValidationFailure as ValidationFailure, - ignite_Vgpu as Vgpu, - ignite_VgpuType as VgpuType, - ignite_VolumeDefinition as VolumeDefinition, - ignite_VolumeFormat as VolumeFormat, - }; -} - -// @public (undocumented) -export type IgniteEndpoints = Endpoint<'GET', '/v1/ignite/deployments', { - deployments: Deployment[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/containers', { - containers: Container[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers', { - container: Container; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/containers/:container_id', never, { - deployment_id: Id<'deployment'>; - container_id: Id<'container'>; -}> | Endpoint<'POST', '/v1/ignite/deployments', { - deployment: Deployment; -}, CreateDeploymentConfig> | Endpoint<'DELETE', '/v1/ignite/deployments/:deployment_id', Empty> | Endpoint<'DELETE', '/v1/ignite/containers/:container_id', Empty | { - container: Container; -}> | Endpoint<'GET', '/v1/ignite/containers/:container_id/logs', { - logs: ContainerLog[]; -}> | Endpoint<'GET', '/v1/ignite/deployments/search', { - deployment: Deployment; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}> | Endpoint<'PUT', '/v1/ignite/containers/:container_id/state', Empty, { - preferred_state: ContainerState.STOPPED | ContainerState.RUNNING; -}> | Endpoint<'POST', '/v1/ignite/gateways/:gateway_id/domains', Empty, { - domain: string; -}> | Endpoint<'GET', '/v1/ignite/gateways/:gateway_id', { - gateway: Gateway; -}> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/gateways', { - gateways: Gateway[]; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/gateways', { - gateway: Gateway; -}, { - type: GatewayType; - target_port: number; - protocol: Gateway['protocol']; - name: string; -}> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id', { - deployment: Deployment; -}, Partial> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/metadata', { - deployment: Deployment; -}, Partial> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/rollouts', { - rollout: DeploymentRollout; -}> | Endpoint<'POST', '/v1/ignite/deployments/:deployment_id/health-check', { - health_check: HealthCheck; -}, Omit> | Endpoint<'GET', '/v1/ignite/deployments/:deployment_id/storage', Record<'volume' | 'build_cache', Record<'provisioned_size' | 'used_size', number> | null>> | Endpoint<'PATCH', '/v1/ignite/deployments/:deployment_id/health-check', { - health_check: HealthCheck; -}, Partial>> | Endpoint<'DELETE', '/v1/ignite/domains/:domain_id', Empty> | Endpoint<'GET', '/v1/ignite/domains/:domain_id', { - domain: Domain; -}>; - -// @public -interface Image_2 { - auth: Auth | null; - gh_repo: ImageGHRepo | null; - name: string | null; -} -export { Image_2 as Image } - -// @public -export interface ImageGHRepo { - // (undocumented) - branch: string; - // (undocumented) - full_name: string; - // (undocumented) - repo_id: number; -} - -// @public -export type InternalHopDomain = `${string}.hop`; - -// @public -export const IS_BROWSER: boolean; - -// @public -export function isValidByteString(value: string): value is ByteSizeString; - -// @public -export function kilobytes(size: number): ByteSizeString; - -// @public -export type MakeOptional = Omit & Partial>; - -// @public -export function megabytes(size: number): ByteSizeString; - -// @public (undocumented) -export type Member = Omit & { - id: Id<'pm'>; - role: MemberRole; - mfa_enabled: boolean; - joined_at: Timestamp; -}; - -// @public (undocumented) -export interface MemberRole { - flags: number; - id: Id<'role'>; - name: string; -} - -// @public -export type Method = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE'; - -// @public -export interface NixPlan { - // (undocumented) - cmds: { - build: string | null; - start: string | null; - install: string | null; - }; - // (undocumented) - language: string | null; - // (undocumented) - pkgs: string[] | null; -} - -// @public -export function parseSize(size: string): number; - -// @public -export type PartialAPIOptions = Partial> & Pick; - -// @public (undocumented) -export interface PAT { - created_at: Timestamp; - id: Id<'pat'>; - name: string | null; - // @alpha - pat: string; -} - -// @public (undocumented) -export type PathsFor = Extract['path']; - -// @public -export const permissions: { - add(value: bigint, flag: bigint): bigint; - test(value: bigint, flag: bigint): boolean; - subtract(value: bigint, flag: bigint): bigint; -}; - -// @public -export const permissionsMap: { - add_member: bigint; - remove_member: bigint; - get_project_members: bigint; - delete_project: bigint; - delete_deployment: bigint; - delete_container: bigint; - update_container_state: bigint; - read_deployments: bigint; - create_deployment: bigint; - create_container: bigint; - update_container_config: bigint; - create_room: bigint; - read_room: bigint; - delete_room: bigint; - create_room_producer: bigint; - create_project_token: bigint; - delete_project_token: bigint; - read_project_tokens: bigint; - read_container_logs: bigint; - create_project_secret: bigint; - read_project_secrets: bigint; - delete_project_secret: bigint; - get_registry_images: bigint; - create_channel_token: bigint; - create_gateway: bigint; - add_domain: bigint; - delete_channels: bigint; - update_channel_state: bigint; - read_channels: bigint; - publish_channel_messages: bigint; - manage_channel_subscribers: bigint; - delete_domain: bigint; - delete_gateway: bigint; - get_internal_domain: bigint; - create_leap_token: bigint; - read_leap_tokens: bigint; - update_leap_token: bigint; - message_token: bigint; - create_channel: bigint; - rollout: bigint; - request_quota_increase: bigint; - read_billing: bigint; - read_gateways: bigint; - delete_registry_images: bigint; - container_ssh: bigint; - tunnel_deployment: bigint; -}; - -// @public (undocumented) -export namespace Pipe { - { - pipe_DeliveryProtocol as DeliveryProtocol, - pipe_PipeEndpoints as PipeEndpoints, - pipe_Room as Room, - }; -} - -// @public (undocumented) -export type PipeEndpoints = Endpoint<'GET', '/v1/pipe/rooms', { - rooms: Room[]; -}> | Endpoint<'POST', '/v1/pipe/rooms', { - room: Room; -}, { - name: string; - ingest_protocol: 'rtmp' | 'rtp'; - delivery_protocols: DeliveryProtocol[]; - region: Regions; - ephemeral: boolean; - llhls_config?: { - wcl_delay: number; - artificial_delay: number; - max_playout_bitrate_preset: string; - } | undefined; -}> | Endpoint<'DELETE', '/v1/pipe/rooms/:room_id', Empty>; - -// @public (undocumented) -export interface Project { - created_at: Timestamp; - // (undocumented) - default_quotas: DefaultQuotas; - icon: string | null; - id: Id<'project'>; - name: string; - namespace: string; - // (undocumented) - quota_overrides: QuotaOverrides; - // (undocumented) - quota_usage: QuotaUsage; - tier: ProjectTier; - type: ProjectType; -} - -// @public -export enum PROJECT_PERMISSION { - // (undocumented) - ADD_DOMAIN = "add_domain", - // (undocumented) - ADD_MEMBER = "add_member", - // (undocumented) - CONTAINER_SSH = "container_ssh", - // (undocumented) - CREATE_CHANNEL = "create_channel", - // (undocumented) - CREATE_CHANNEL_TOKEN = "create_channel_token", - // (undocumented) - CREATE_CONTAINER = "create_container", - // (undocumented) - CREATE_DEPLOYMENT = "create_deployment", - // (undocumented) - CREATE_GATEWAY = "create_gateway", - // (undocumented) - CREATE_LEAP_TOKEN = "create_leap_token", - // (undocumented) - CREATE_PROJECT_SECRET = "create_project_secret", - // (undocumented) - CREATE_PROJECT_TOKEN = "create_project_token", - // (undocumented) - CREATE_ROOM = "create_room", - // (undocumented) - CREATE_ROOM_PRODUCER = "create_room_producer", - // (undocumented) - DELETE_CHANNELS = "delete_channels", - // (undocumented) - DELETE_CONTAINER = "delete_container", - // (undocumented) - DELETE_DEPLOYMENT = "delete_deployment", - // (undocumented) - DELETE_DOMAIN = "delete_domain", - // (undocumented) - DELETE_GATEWAY = "delete_gateway", - // (undocumented) - DELETE_PROJECT = "delete_project", - // (undocumented) - DELETE_PROJECT_SECRET = "delete_project_secret", - // (undocumented) - DELETE_PROJECT_TOKEN = "delete_project_token", - // (undocumented) - DELETE_REGISTRY_IMAGES = "delete_registry_images", - // (undocumented) - DELETE_ROOM = "delete_room", - // (undocumented) - GET_INTERNAL_DOMAIN = "get_internal_domain", - // (undocumented) - GET_PROJECT_MEMBERS = "get_project_members", - // (undocumented) - GET_REGISTRY_IMAGES = "get_registry_images", - // (undocumented) - MANAGE_CHANNEL_SUBSCRIBERS = "manage_channel_subscribers", - // (undocumented) - MESSAGE_TOKEN = "message_token", - // (undocumented) - PUBLISH_CHANNEL_MESSAGES = "publish_channel_messages", - // (undocumented) - READ_BILLING = "read_billing", - // (undocumented) - READ_CHANNELS = "read_channels", - // (undocumented) - READ_CONTAINER_LOGS = "read_container_logs", - // (undocumented) - READ_DEPLOYMENTS = "read_deployments", - // (undocumented) - READ_GATEWAYS = "read_gateways", - // (undocumented) - READ_LEAP_TOKENS = "read_leap_tokens", - // (undocumented) - READ_PROJECT_SECRETS = "read_project_secrets", - // (undocumented) - READ_PROJECT_TOKENS = "read_project_tokens", - // (undocumented) - READ_ROOM = "read_room", - // (undocumented) - REMOVE_MEMBER = "remove_member", - // (undocumented) - REQUEST_QUOTA_INCREASE = "request_quota_increase", - // (undocumented) - ROLLOUT = "rollout", - // (undocumented) - TUNNEL_DEPLOYMENT = "tunnel_deployment", - // (undocumented) - UPDATE_CHANNEL_STATE = "update_channel_state", - // (undocumented) - UPDATE_CONTAINER_CONFIG = "update_container_config", - // (undocumented) - UPDATE_CONTAINER_STATE = "update_container_state", - // (undocumented) - UPDATE_LEAP_TOKEN = "update_leap_token" -} - -// @public (undocumented) -export namespace Projects { - { - projects_DefaultQuotas as DefaultQuotas, - projects_Member as Member, - projects_MemberRole as MemberRole, - projects_Project as Project, - projects_ProjectTier as ProjectTier, - projects_ProjectToken as ProjectToken, - projects_ProjectType as ProjectType, - projects_ProjectsEndpoints as ProjectsEndpoints, - projects_QuotaOverrides as QuotaOverrides, - projects_QuotaUsage as QuotaUsage, - projects_Secret as Secret, - }; -} - -// @public (undocumented) -export type ProjectsEndpoints = Endpoint<'DELETE', '/v1/projects/:project_id/tokens/:project_token_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/tokens/:project_token_id', Empty> | Endpoint<'GET', '/v1/projects/:project_id/members/@me', { - project_member: Member; -}> | Endpoint<'GET', '/v1/projects/:project_id/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/@this/tokens', { - project_tokens: ProjectToken[]; -}> | Endpoint<'GET', '/v1/projects/:project_id/members', { - members: Member[]; -}> | Endpoint<'GET', '/v1/projects/@this/members', { - members: Member[]; -}> | Endpoint<'POST', '/v1/projects/:project_id/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'POST', '/v1/projects/@this/tokens', { - project_token: ProjectToken & { - project: Project; - }; -}, { - flags: number; -}> | Endpoint<'PUT', '/v1/projects/:project_id/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'PUT', '/v1/projects/@this/secrets/:name', { - secret: Secret; -}, string> | Endpoint<'GET', '/v1/projects/:project_id/secrets', { - secrets: Secret[]; -}> | Endpoint<'GET', '/v1/projects/@this/secrets', { - secrets: Secret[]; -}> | Endpoint<'DELETE', '/v1/projects/:project_id/secrets/:secret_id', Empty> | Endpoint<'DELETE', '/v1/projects/@this/secrets/:secret_id', Empty>; - -// @public (undocumented) -export enum ProjectTier { - // (undocumented) - FREE = "free", - // (undocumented) - PAID = "paid" -} - -// @public -export interface ProjectToken { - created_at: Timestamp; - flags: number; - id: Id<'ptkid'>; - token: Id<'ptk'>; -} - -// @public -export enum ProjectType { - PERSONAL = "personal", - REGULAR = "regular" -} - -// @public -export type Query = ExtractRouteParams & Record; - -// @public (undocumented) -export interface QuotaOverrides { -} - -// @public (undocumented) -export interface QuotaUsage { - // (undocumented) - ram: number; - // (undocumented) - vcpu: number; - // (undocumented) - volume: number; -} - -// @public (undocumented) -export enum Regions { - // (undocumented) - US_EAST_1 = "us-east-1" -} - -// @public (undocumented) -export namespace Registry { - { - registry_RegistryEndpoints as RegistryEndpoints, - }; -} - -// @public (undocumented) -export type RegistryEndpoints = Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', { - images: string[]; -}> | Endpoint<'GET', '/v1/registry/images/:image/manifests', { - manifests: { - digest: { - digest: string; - size: number; - uploaded: string; - }; - tag: string | null; - }[]; -}>; - -// @public -export interface Resources { - ram: ByteSizeString; - vcpu: number; - vgpu: Vgpu[]; -} - -// @public -export enum RestartPolicy { - // (undocumented) - ALWAYS = "always", - // (undocumented) - NEVER = "never", - // (undocumented) - ON_FAILURE = "on-failure" -} - -// @public -export const roles: { - viewer: bigint; - editor: bigint; - admin: bigint; - owner: bigint; -}; - -// @public -export enum RolloutState { - // (undocumented) - FAILED = "failed", - // (undocumented) - FINISHED = "finished", - // (undocumented) - PENDING = "pending" -} - -// @public (undocumented) -export interface Room { - created_at: Timestamp; - delivery_protocols: DeliveryProtocol[]; - id: Id<'pipe_room'>; - ingest_endpoint: string; - ingest_protocol: 'rtmp'; - ingest_region: Regions; - join_token: string; - name: string; - state: 'live' | 'offline'; -} - -// @public -export enum RuntimeType { - EPHEMERAL = "ephemeral", - PERSISTENT = "persistent", - STATEFUL = "stateful" -} - -// @public (undocumented) -export interface Secret { - created_at: Timestamp; - digest: string; - id: Id<'secret'>; - in_use_by: Id<'deployment'>[]; - name: string; -} - -// @public -export interface SelfUser extends User { - admin: boolean; - email_verified: boolean; - mfa_enabled: boolean; - totp_enabled: boolean; - webauthn_enabled: boolean; -} - -// @public -export type State = Record; - -// @public (undocumented) -export type SuccessfulAPIResponse = { - success: true; - data: T; -}; - -// @public -export const SUPPORTS_INTL: boolean; - -// @public -export type Tag = T & { - ___tag: Name; -}; - -// @public -export type Timestamp = Tag; - -// @public @deprecated (undocumented) -export const units: readonly ["GB", "MB", "KB", "B"]; - -// @public -export interface User { - email: string; - id: Id<'user'>; - name: string; - username: string; -} - -// @public (undocumented) -export type UserEndpoints = Endpoint<'GET', '/v1/users/@me', { - projects: Project[]; - user: SelfUser; - project_member_role_map: Record, MemberRole>; - leap_token: string | null; -}> | Endpoint<'POST', '/v1/users/@me/pats', { - pat: PAT; -}, { - name: string; -}> | Endpoint<'GET', '/v1/users/@me/pats', { - pats: PAT[]; -}> | Endpoint<'DELETE', '/v1/users/@me/pats/:pat_id', Empty>; - -// @public (undocumented) -export namespace Users { - { - users_PAT as PAT, - users_SelfUser as SelfUser, - users_User as User, - users_UserEndpoints as UserEndpoints, - }; -} - -// @public -export function validateAPIAuthentication(auth: string): auth is APIAuthenticationPrefix; - -// @public -export function validateId(maybeId: string | undefined | null, prefix?: T | T[]): maybeId is Id; - -// @public -export function validateIdPrefix(prefix: string, expect?: T): prefix is T; - -// @public -export interface ValidationFailure { - // (undocumented) - help_link: string | null; - // (undocumented) - reason: string; -} - -// @internal -export type _Values = T[keyof T]; - -// @public -export interface Vgpu { - count: number; - type: VgpuType; -} - -// @public -export enum VgpuType { - // (undocumented) - A400 = "a400" -} - -// @public (undocumented) -export interface VolumeDefinition { - fs: VolumeFormat; - mount_path: string; - size: ByteSizeString; -} - -// @public (undocumented) -export enum VolumeFormat { - // (undocumented) - EXT4 = "ext4", - // (undocumented) - XFS = "xfs" -} - -// Warnings were encountered during analysis: -// -// dist/index.d.ts:759:13 - (ae-forgotten-export) The symbol "SetStateAction" needs to be exported by the entry point index.d.ts - -// (No @packageDocumentation comment for this package) - -``` From e61ca1392b59517235603c1db0213107d2b6dec9 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Sun, 12 Mar 2023 01:16:05 +0000 Subject: [PATCH 26/33] fix: node10 types --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index f315d90c..b14e6df2 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,7 @@ "type": "module", "main": "./dist/index.cjs", "module": "./dist/index.js", + "types": "./dist/index.d.ts", "exports": { ".": { "node": { From f768abce318589ac619ba8fb9f9afc275bdb430a Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Mon, 13 Mar 2023 23:25:41 +0000 Subject: [PATCH 27/33] feat: bump to nightly ts --- yarn.lock | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/yarn.lock b/yarn.lock index 9fc83dec..3b3164b2 100644 --- a/yarn.lock +++ b/yarn.lock @@ -4117,12 +4117,12 @@ __metadata: linkType: hard "typescript@npm:next": - version: 5.1.0-dev.20230311 - resolution: "typescript@npm:5.1.0-dev.20230311" + version: 5.1.0-dev.20230313 + resolution: "typescript@npm:5.1.0-dev.20230313" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: cf7b935c6c94401d126e6c2d979ec7ac449ff555e20e69d81c5d74a008a7d7d778a2a4fce3825dc58d4277405572aca8e738b1cd26052144ba626f8acca2d346 + checksum: 6b908aa13466db900d6a7ca8352441a354ca917632bf8c5da80f3de984fed2fb4ada779572957593af019443e06d2e89be0b899e21d2182db7498e69a52e185c languageName: node linkType: hard @@ -4137,12 +4137,12 @@ __metadata: linkType: hard "typescript@patch:typescript@next#~builtin": - version: 5.1.0-dev.20230311 - resolution: "typescript@patch:typescript@npm%3A5.1.0-dev.20230311#~builtin::version=5.1.0-dev.20230311&hash=1f5320" + version: 5.1.0-dev.20230313 + resolution: "typescript@patch:typescript@npm%3A5.1.0-dev.20230313#~builtin::version=5.1.0-dev.20230313&hash=1f5320" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: cc46701cd5809bf356f615694c35666c5f01d056711a5adca02d9446075f865f884d8bb5713c4cc2de1d47945e453bf41a10c8998f6cd882d71d73f2a62d7204 + checksum: 3ece0a4ba98dc947478c22df469e5ad402b2c45f4122588d09bbfa8e8da2228def17d118cc3ce8842009d6374dd73f2e6141ed6923f679e023d3aab90e1b34a7 languageName: node linkType: hard From 794905f953e6a7aeda347f69e3f295c392c5fb07 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Tue, 14 Mar 2023 14:09:55 +0000 Subject: [PATCH 28/33] package script --- package.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/package.json b/package.json index b14e6df2..c0252c10 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "release": "yarn build && yarn changeset publish", "api": "yarn build && api-extractor run --local --verbose", "fullbuild": "yarn build && yarn docs", - "test": "tsx tests/index.ts" + "test": "tsx tests/index.ts", + "package": "yarn build && yarn pack" }, "devDependencies": { "@changesets/cli": "2.26.0", From bb19264ca7b7570d09b0b92fe80348fd9cd3f9f4 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Fri, 17 Mar 2023 09:49:29 +0000 Subject: [PATCH 29/33] ts release --- .vscode/settings.json | 3 --- package.json | 2 +- yarn.lock | 18 +++++++++--------- 3 files changed, 10 insertions(+), 13 deletions(-) diff --git a/.vscode/settings.json b/.vscode/settings.json index f3347b5a..4d360cbc 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -1,6 +1,3 @@ { - "yaml.schemas": { - "https://json.schemastore.org/github-action.json": "./.github/workflows/build.yml" - }, "typescript.tsdk": "node_modules/typescript/lib" } diff --git a/package.json b/package.json index 3b57944c..4df78b54 100644 --- a/package.json +++ b/package.json @@ -57,7 +57,7 @@ "typedoc": "0.23.26", "typedoc-plugin-markdown": "3.14.0", "typedoc-plugin-missing-exports": "1.0.0", - "typescript": "next" + "typescript": "^5.0.2" }, "dependencies": { "@onehop/json-methods": "^1.2.0", diff --git a/yarn.lock b/yarn.lock index 3b3164b2..d54aad1b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -611,7 +611,7 @@ __metadata: typedoc: 0.23.26 typedoc-plugin-markdown: 3.14.0 typedoc-plugin-missing-exports: 1.0.0 - typescript: next + typescript: ^5.0.2 zod: ^3.21.4 languageName: unknown linkType: soft @@ -4116,13 +4116,13 @@ __metadata: languageName: node linkType: hard -"typescript@npm:next": - version: 5.1.0-dev.20230313 - resolution: "typescript@npm:5.1.0-dev.20230313" +"typescript@npm:^5.0.2": + version: 5.0.2 + resolution: "typescript@npm:5.0.2" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: 6b908aa13466db900d6a7ca8352441a354ca917632bf8c5da80f3de984fed2fb4ada779572957593af019443e06d2e89be0b899e21d2182db7498e69a52e185c + checksum: bef1dcd166acfc6934b2ec4d72f93edb8961a5fab36b8dd2aaf6f4f4cd5c0210f2e0850aef4724f3b4913d5aef203a94a28ded731b370880c8bcff7e4ff91fc1 languageName: node linkType: hard @@ -4136,13 +4136,13 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@next#~builtin": - version: 5.1.0-dev.20230313 - resolution: "typescript@patch:typescript@npm%3A5.1.0-dev.20230313#~builtin::version=5.1.0-dev.20230313&hash=1f5320" +"typescript@patch:typescript@^5.0.2#~builtin": + version: 5.0.2 + resolution: "typescript@patch:typescript@npm%3A5.0.2#~builtin::version=5.0.2&hash=1f5320" bin: tsc: bin/tsc tsserver: bin/tsserver - checksum: 3ece0a4ba98dc947478c22df469e5ad402b2c45f4122588d09bbfa8e8da2228def17d118cc3ce8842009d6374dd73f2e6141ed6923f679e023d3aab90e1b34a7 + checksum: bdbf3d0aac0d6cf010fbe0536753dc19f278eb4aba88140dcd25487dfe1c56ca8b33abc0dcd42078790a939b08ebc4046f3e9bb961d77d3d2c3cfa9829da4d53 languageName: node linkType: hard From dadaf23d7b579a95e31762330bf987bcd9df4a43 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Fri, 17 Mar 2023 10:58:57 +0000 Subject: [PATCH 30/33] feat: proper jsdoc of all public symbols --- package.json | 8 ++++---- src/rest/client.ts | 8 ++++++++ src/rest/types/channels.ts | 5 +++++ src/rest/types/ignite.ts | 6 +++--- src/rest/types/projects.ts | 38 +++++++++++++++++++++++++++++++++++ src/rest/types/registry.ts | 4 ++++ src/sdks/ignite.ts | 12 +++++------ src/sdks/index.ts | 13 ++++++------ src/util/size.ts | 14 +++++++------ src/util/types.ts | 10 ++-------- src/util/urls.ts | 2 +- tests/index.ts | 4 +--- yarn.lock | 41 ++++++++++++++++++++++---------------- 13 files changed, 110 insertions(+), 55 deletions(-) diff --git a/package.json b/package.json index 4df78b54..4b9e7123 100644 --- a/package.json +++ b/package.json @@ -48,13 +48,13 @@ "@changesets/cli": "2.26.0", "@microsoft/api-extractor": "^7.34.4", "@types/glob": "8.1.0", - "@types/node": "18.15.0", + "@types/node": "18.15.3", "dotenv": "16.0.3", - "glob": "9.2.1", + "glob": "9.3.0", "prettier": "2.8.4", "tsup": "6.6.3", - "tsx": "3.12.3", - "typedoc": "0.23.26", + "tsx": "3.12.5", + "typedoc": "0.23.27", "typedoc-plugin-markdown": "3.14.0", "typedoc-plugin-missing-exports": "1.0.0", "typescript": "^5.0.2" diff --git a/src/rest/client.ts b/src/rest/client.ts index abdea2c7..27e5bdac 100644 --- a/src/rest/client.ts +++ b/src/rest/client.ts @@ -11,11 +11,19 @@ import {getIdPrefix, type Id, type Method} from './types/index.ts'; */ export type APIAuthenticationPrefix = 'ptk' | 'bearer' | 'pat'; +/** + * Extract an endpoint from a given method and path + * @public + */ export type ExtractEndpoint< Method extends string, Path extends string, > = Extract; +/** + * Pull all paths for a given method + * @internal + */ export type PathsFor = Extract< Endpoints, {method: M} diff --git a/src/rest/types/channels.ts b/src/rest/types/channels.ts index d4741c8d..787f8dc5 100644 --- a/src/rest/types/channels.ts +++ b/src/rest/types/channels.ts @@ -20,6 +20,7 @@ export type AnyStateObject = Record; /** * @deprecated Use {@link AnyStateObject} instead + * @public */ export type State = AnyStateObject; @@ -59,6 +60,10 @@ export interface Channel { type: ChannelType; } +/** + * A token for a channel + * @public + */ export interface ChannelToken { /** * The ID for the token diff --git a/src/rest/types/ignite.ts b/src/rest/types/ignite.ts index 13e71342..5a37da16 100644 --- a/src/rest/types/ignite.ts +++ b/src/rest/types/ignite.ts @@ -318,6 +318,7 @@ export interface DeploymentMetadata { /** * Deployment metadata * @deprecated Use {@link DeploymentMetadata} instead + * @public */ export type DeploymentMetaData = DeploymentMetadata; @@ -379,7 +380,8 @@ export interface BuildMetadata { /** * Metadata attached to a build - * @deprecated Use {@see BuildMetadata} instead + * @deprecated Use {@link BuildMetadata} instead + * @public */ export type BuildMetaData = BuildMetadata; @@ -602,7 +604,6 @@ export type CreateDeploymentConfig = MakeOptional; /** * The strategy for scaling multiple containers. - * @warning This property is not yet fully complete * @public */ export enum ContainerStrategy { @@ -613,7 +614,6 @@ export enum ContainerStrategy { /** * Have Hop automatically scale containers based on load - * @warning This is incomplete */ // AUTOSCALE = 'autoscale', } diff --git a/src/rest/types/projects.ts b/src/rest/types/projects.ts index 38195763..058ea9ad 100644 --- a/src/rest/types/projects.ts +++ b/src/rest/types/projects.ts @@ -2,6 +2,10 @@ import type {Empty, Id, Timestamp} from '../../util/types.ts'; import type {Endpoint} from '../endpoints.ts'; import type {User} from './users.ts'; +/** + * A member is a partial user with information about their membership in a project + * @public + */ export type Member = Omit & { /** * The ID of the project member @@ -24,11 +28,19 @@ export type Member = Omit & { joined_at: Timestamp; }; +/** + * A project tier + * @public + */ export enum ProjectTier { FREE = 'free', PAID = 'paid', } +/** + * A role that a member can have in a project + * @public + */ export interface MemberRole { /** * The ID of the role @@ -48,6 +60,7 @@ export interface MemberRole { /** * A project token for a project + * @public */ export interface ProjectToken { /** @@ -73,6 +86,7 @@ export interface ProjectToken { /** * Type of a project + * @public */ export enum ProjectType { /** @@ -86,6 +100,10 @@ export enum ProjectType { PERSONAL = 'personal', } +/** + * A project on Hop + * @public + */ export interface Project { /** * The ID of the project @@ -129,20 +147,36 @@ export interface Project { quota_usage: QuotaUsage; } +/** + * Default quotas for a project + * @public + */ export interface DefaultQuotas { vcpu: number; ram: number; volume: number; } +/** + * Quota overrides for a project + * @public + */ export interface QuotaOverrides {} +/** + * Current usage of a quota for a project + * @public + */ export interface QuotaUsage { vcpu: number; ram: number; volume: number; } +/** + * A secret is a key/value pair that can be used to store sensitive information + * @public + */ export interface Secret { /** * The ID of the secret @@ -170,6 +204,10 @@ export interface Secret { in_use_by: Id<'deployment'>[]; } +/** + * The endpoints for projects + * @public + */ export type ProjectsEndpoints = | Endpoint< 'DELETE', diff --git a/src/rest/types/registry.ts b/src/rest/types/registry.ts index bfbf8c8d..6c396c32 100644 --- a/src/rest/types/registry.ts +++ b/src/rest/types/registry.ts @@ -1,6 +1,10 @@ import type {Empty} from '../../util/types.ts'; import type {Endpoint} from '../endpoints.ts'; +/** + * All endpoints for Hop's Docker registry + * @public + */ export type RegistryEndpoints = | Endpoint<'DELETE', '/v1/registry/images/:image', Empty> | Endpoint<'GET', '/v1/registry/images', {images: string[]}> diff --git a/src/sdks/ignite.ts b/src/sdks/ignite.ts index 6b62f0ff..7f0d6f0c 100644 --- a/src/sdks/ignite.ts +++ b/src/sdks/ignite.ts @@ -209,7 +209,7 @@ export const ignite = sdk(client => { /** * Deletes a container and recreates it after deletion * - * @param container_id The ID of the container to delete + * @param container_id - The ID of the container to delete * @param options - Options object */ async function deleteContainer( @@ -257,7 +257,7 @@ export const ignite = sdk(client => { /** * Fecthes all gateways attached to a deployment * - * @param deploymentId The ID of the deployment to fetch gateways for + * @param deploymentId - The ID of the deployment to fetch gateways for */ async getAll(deploymentId: Id<'deployment'>) { const {gateways} = await client.get( @@ -271,10 +271,10 @@ export const ignite = sdk(client => { /** * Creates and attaches a gateway to a deployment * - * @param deployment The deployment to create a gateway on - * @param type The type of the gatway to create, either internal or external - * @param protocol The protocol that the gateway will listen for - * @param targetPort The port to listen on + * @param deployment - The deployment to create a gateway on + * @param type - The type of the gatway to create, either internal or external + * @param protocol - The protocol that the gateway will listen for + * @param targetPort - The port to listen on */ async create( deployment: Deployment | Deployment['id'], diff --git a/src/sdks/index.ts b/src/sdks/index.ts index 74d48d85..2c92d1cd 100644 --- a/src/sdks/index.ts +++ b/src/sdks/index.ts @@ -1,7 +1,6 @@ -export {channels} from './channels.ts'; -export {ignite} from './ignite.ts'; -export {pipe} from './pipe.ts'; -export {projects} from './projects.ts'; -export {registry} from './registry.ts'; -export {users} from './users.ts'; -// +export * from './channels.ts'; +export * from './ignite.ts'; +export * from './pipe.ts'; +export * from './projects.ts'; +export * from './registry.ts'; +export * from './users.ts'; diff --git a/src/util/size.ts b/src/util/size.ts index ada52672..4a5f483c 100644 --- a/src/util/size.ts +++ b/src/util/size.ts @@ -18,12 +18,13 @@ export type ByteSizeString = `${number}${ByteUnit}`; /** * @deprecated Use {@link ByteSizeString} instead + * @public */ export type ByteString = ByteSizeString; /** * Validates if a string is a valid byte size string - * @param value A string to validate if it is a valid byte size string + * @param value - A string to validate if it is a valid byte size string * @returns If the string is a valid byte size string * @public */ @@ -46,8 +47,8 @@ const multipliers: Record = { /** * Helper function to converts a numerical size to a valid byte size string - * @param size A size to convert to a valid byte size string - * @param unit An optional unit to as the size unit. Defaults to B + * @param size - A size to convert to a valid byte size string + * @param unit - An optional unit to as the size unit. Defaults to B * @returns a byte size string * @public */ @@ -57,7 +58,7 @@ export function bytes(size: number, unit: ByteUnit = 'B'): ByteSizeString { /** * Converts a kilobyte size to a byte size string - * @param size Kilobytes to convert to a byte size string + * @param size - Kilobytes to convert to a byte size string * @returns a byte size string * @public */ @@ -67,7 +68,7 @@ export function kilobytes(size: number): ByteSizeString { /** * Converts a megabyte size to a byte size string - * @param size Megabytes to convert to a byte size string + * @param size - Megabytes to convert to a byte size string * @returns a byte size string * @public */ @@ -77,7 +78,7 @@ export function megabytes(size: number): ByteSizeString { /** * Converts a gigabyte size to a byte size string - * @param size Gigabytes to convert to a byte size string + * @param size - Gigabytes to convert to a byte size string * @returns a byte size string * @public */ @@ -108,5 +109,6 @@ export function parseSize(size: string) { /** * @deprecated Use {@link byteUnits} instead + * @public */ export const units = byteUnits; diff --git a/src/util/types.ts b/src/util/types.ts index 21317499..434b7ca5 100644 --- a/src/util/types.ts +++ b/src/util/types.ts @@ -49,12 +49,6 @@ export type ExtractRouteParams = string extends T ? {[k in Param]: string | number} : {}; -/** - * Pull values of an object - * @internal - */ -export type _Values = T[keyof T]; - // Technically, `channel`, it should be here, but channel IDs can also // be any random string if a developer decides to set it. For this reason, // channel is not included as a valid ID in this list @@ -149,7 +143,7 @@ export const ID_PREFIXES = [ * A union of all ID prefixes used within the API * @public */ -export type IdPrefixes = typeof ID_PREFIXES[number]['prefix']; +export type IdPrefixes = (typeof ID_PREFIXES)[number]['prefix']; /** * A Hop ID is a string that starts with a prefix and a underscore, followed by some unique text. @@ -279,7 +273,7 @@ export function assertId( ): asserts maybeId is Id { const expectedPrefix = prefix === undefined - ? '' + ? '' : Array.isArray(prefix) ? formatList(prefix, 'disjunction') : prefix; diff --git a/src/util/urls.ts b/src/util/urls.ts index 338670a7..0e2db237 100644 --- a/src/util/urls.ts +++ b/src/util/urls.ts @@ -1,4 +1,4 @@ -import {ExtractRouteParams, Query} from '../rest/index.ts'; +import type {ExtractRouteParams, Query} from '../rest/index.ts'; export function lead(x: string) { return x.charCodeAt(0) === 47 ? x : '/' + x; diff --git a/tests/index.ts b/tests/index.ts index a752f0c4..7b886cc3 100644 --- a/tests/index.ts +++ b/tests/index.ts @@ -16,9 +16,7 @@ const hop = new Hop( BASE_URL, ); -test('The HTTP client correctly forms URLs', t => { - t.todo('Move these tests to a describe() call'); - +test('The HTTP client correctly forms URLs', () => { assert.equal( hop.client.url('/v1/path/to/:resource', { resource: 'my-resource', diff --git a/yarn.lock b/yarn.lock index d54aad1b..6ac25e8e 100644 --- a/yarn.lock +++ b/yarn.lock @@ -601,14 +601,14 @@ __metadata: "@microsoft/api-extractor": ^7.34.4 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.1.0 - "@types/node": 18.15.0 + "@types/node": 18.15.3 cross-fetch: ^3.1.5 dotenv: 16.0.3 - glob: 9.2.1 + glob: 9.3.0 prettier: 2.8.4 tsup: 6.6.3 - tsx: 3.12.3 - typedoc: 0.23.26 + tsx: 3.12.5 + typedoc: 0.23.27 typedoc-plugin-markdown: 3.14.0 typedoc-plugin-missing-exports: 1.0.0 typescript: ^5.0.2 @@ -712,13 +712,20 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:*, @types/node@npm:18.15.0": +"@types/node@npm:*": version: 18.15.0 resolution: "@types/node@npm:18.15.0" checksum: d81372276dd5053b1743338b61a2178ff9722dc609189d01fc7d1c2acd539414039e0e4780678730514390dad3f29c366a28c29e8dbd5b0025651181f6dd6669 languageName: node linkType: hard +"@types/node@npm:18.15.3": + version: 18.15.3 + resolution: "@types/node@npm:18.15.3" + checksum: 31b1d92475a82c30de29aa6c0771b18a276552d191283b4423ba2d61b3f01159bf0d02576c0b7cc834b043997893800db6bb47f246083ed85aa45e79c80875d7 + languageName: node + linkType: hard + "@types/node@npm:^12.7.1": version: 12.20.55 resolution: "@types/node@npm:12.20.55" @@ -1869,15 +1876,15 @@ __metadata: languageName: node linkType: hard -"glob@npm:9.2.1": - version: 9.2.1 - resolution: "glob@npm:9.2.1" +"glob@npm:9.3.0": + version: 9.3.0 + resolution: "glob@npm:9.3.0" dependencies: fs.realpath: ^1.0.0 minimatch: ^7.4.1 minipass: ^4.2.4 path-scurry: ^1.6.1 - checksum: ef9b1c32491e6b532bdd0d2abcc3c9f48e83446609e11285869156982fc5a756dfbaa6f59f797712343bd1e22500ac15708692806633653fde4ef67c85e2aab7 + checksum: 9beb4f1cdc9585412efd991a9786c1ee6816dfd0537494fd552c333fa3d4b041fce5681bce21d14651e41479f60866e10a35a2ce2571fd40b7cf73842ea12192 languageName: node linkType: hard @@ -4014,9 +4021,9 @@ __metadata: languageName: node linkType: hard -"tsx@npm:3.12.3": - version: 3.12.3 - resolution: "tsx@npm:3.12.3" +"tsx@npm:3.12.5": + version: 3.12.5 + resolution: "tsx@npm:3.12.5" dependencies: "@esbuild-kit/cjs-loader": ^2.4.2 "@esbuild-kit/core-utils": ^3.0.0 @@ -4027,7 +4034,7 @@ __metadata: optional: true bin: tsx: dist/cli.js - checksum: fd04a164d543ff7df030e253280b509257f2d32f9d439d26f33beb1a7c23e91a36fd8d86f150e94187e0598ab58b12e6bc5b7c6798ef0bcc8ffcbc65a31597d2 + checksum: d8747fb9bf5c615fa8030e88a430ca573f5c77b54d633a1a64220899dca092d7d186e6403f93d9615d8aac6ddd8f80ce1f9db0e2708baad5ee5b586d5c06c480 languageName: node linkType: hard @@ -4100,9 +4107,9 @@ __metadata: languageName: node linkType: hard -"typedoc@npm:0.23.26": - version: 0.23.26 - resolution: "typedoc@npm:0.23.26" +"typedoc@npm:0.23.27": + version: 0.23.27 + resolution: "typedoc@npm:0.23.27" dependencies: lunr: ^2.3.9 marked: ^4.2.12 @@ -4112,7 +4119,7 @@ __metadata: typescript: 4.6.x || 4.7.x || 4.8.x || 4.9.x bin: typedoc: bin/typedoc - checksum: 09dbd221b5bd27a7f6c593a6aa7e4efc3c46f20761e109a76bf0ed7239011cca1261357094710c01472582060d75a7558aab5bf5b78db3aff7c52188d146ee65 + checksum: 1ddcccf0b839c708a37d18b6dc1ab57ace6e177daf8f0442ff60d6e72c23ecbd78b0e602f0e1e553c7cb0254e0c769afff7c24c58683e564a7a07a2469cf99a5 languageName: node linkType: hard From abb1326b926556daeab5d021601b051811231d5d Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Fri, 17 Mar 2023 10:59:12 +0000 Subject: [PATCH 31/33] docs(changeset): Properly JSDoc all symbols --- .changeset/funny-goats-battle.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/funny-goats-battle.md diff --git a/.changeset/funny-goats-battle.md b/.changeset/funny-goats-battle.md new file mode 100644 index 00000000..f7a61ca5 --- /dev/null +++ b/.changeset/funny-goats-battle.md @@ -0,0 +1,5 @@ +--- +'@onehop/js': patch +--- + +Properly JSDoc all symbols From b21450620f00cb86be2061656ad5984c431efdd2 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Fri, 17 Mar 2023 10:59:29 +0000 Subject: [PATCH 32/33] remove @microsoft/api-extractor --- package.json | 2 - yarn.lock | 287 ++------------------------------------------------- 2 files changed, 8 insertions(+), 281 deletions(-) diff --git a/package.json b/package.json index 4b9e7123..37c60bd4 100644 --- a/package.json +++ b/package.json @@ -39,14 +39,12 @@ "build": "rm -rf dist && tsup && node ./build/copy.js", "bench": "HOP_DEBUG=true tsx _workbench.ts", "release": "yarn build && yarn changeset publish", - "api": "yarn build && api-extractor run --local --verbose", "fullbuild": "yarn build && yarn docs", "test": "tsx tests/index.ts", "package": "yarn build && yarn pack" }, "devDependencies": { "@changesets/cli": "2.26.0", - "@microsoft/api-extractor": "^7.34.4", "@types/glob": "8.1.0", "@types/node": "18.15.3", "dotenv": "16.0.3", diff --git a/yarn.lock b/yarn.lock index 6ac25e8e..080d6c79 100644 --- a/yarn.lock +++ b/yarn.lock @@ -494,58 +494,6 @@ __metadata: languageName: node linkType: hard -"@microsoft/api-extractor-model@npm:7.26.4": - version: 7.26.4 - resolution: "@microsoft/api-extractor-model@npm:7.26.4" - dependencies: - "@microsoft/tsdoc": 0.14.2 - "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.55.2 - checksum: 0b27f9b248396422f3044f2472d86c111a6a4d34b4fd2c67d9995e96e5b144ec41ac35dbf2a005f144766814b824518bc42b424d93e3075d3dc1b17c2f8791d6 - languageName: node - linkType: hard - -"@microsoft/api-extractor@npm:^7.34.4": - version: 7.34.4 - resolution: "@microsoft/api-extractor@npm:7.34.4" - dependencies: - "@microsoft/api-extractor-model": 7.26.4 - "@microsoft/tsdoc": 0.14.2 - "@microsoft/tsdoc-config": ~0.16.1 - "@rushstack/node-core-library": 3.55.2 - "@rushstack/rig-package": 0.3.18 - "@rushstack/ts-command-line": 4.13.2 - colors: ~1.2.1 - lodash: ~4.17.15 - resolve: ~1.22.1 - semver: ~7.3.0 - source-map: ~0.6.1 - typescript: ~4.8.4 - bin: - api-extractor: bin/api-extractor - checksum: 855a04237e30f425553aab661b77bc0cbeb493510d769691d713e5bfdf02439fa7bc2076750271d154237f8c9d4451b209f30724c9ee2a2c4ea307c5db093d42 - languageName: node - linkType: hard - -"@microsoft/tsdoc-config@npm:~0.16.1": - version: 0.16.2 - resolution: "@microsoft/tsdoc-config@npm:0.16.2" - dependencies: - "@microsoft/tsdoc": 0.14.2 - ajv: ~6.12.6 - jju: ~1.4.0 - resolve: ~1.19.0 - checksum: 12b0d703154076bcaac75ca42e804e4fc292672396441e54346d7eadd0d6b57f90980eda2b1bab89b224af86da34a2389f9054002e282011e795ca5919a4386f - languageName: node - linkType: hard - -"@microsoft/tsdoc@npm:0.14.2": - version: 0.14.2 - resolution: "@microsoft/tsdoc@npm:0.14.2" - checksum: b167c89e916ba73ee20b9c9d5dba6aa3a0de25ed3d50050e8a344dca7cd43cb2e1059bd515c820369b6e708901dd3fda476a42bc643ca74a35671ce77f724a3a - languageName: node - linkType: hard - "@nodelib/fs.scandir@npm:2.1.5": version: 2.1.5 resolution: "@nodelib/fs.scandir@npm:2.1.5" @@ -598,7 +546,6 @@ __metadata: resolution: "@onehop/js@workspace:." dependencies: "@changesets/cli": 2.26.0 - "@microsoft/api-extractor": ^7.34.4 "@onehop/json-methods": ^1.2.0 "@types/glob": 8.1.0 "@types/node": 18.15.3 @@ -623,48 +570,6 @@ __metadata: languageName: node linkType: hard -"@rushstack/node-core-library@npm:3.55.2": - version: 3.55.2 - resolution: "@rushstack/node-core-library@npm:3.55.2" - dependencies: - colors: ~1.2.1 - fs-extra: ~7.0.1 - import-lazy: ~4.0.0 - jju: ~1.4.0 - resolve: ~1.22.1 - semver: ~7.3.0 - z-schema: ~5.0.2 - peerDependencies: - "@types/node": "*" - peerDependenciesMeta: - "@types/node": - optional: true - checksum: b6b289315cd6a3544471f534405479b7c80f3906b7506590d5eb83a605a0a5b65861bf678f3e6c2277c8db116b8e05f8e7b6864fdc75e0f1514c9ff224b83fe6 - languageName: node - linkType: hard - -"@rushstack/rig-package@npm:0.3.18": - version: 0.3.18 - resolution: "@rushstack/rig-package@npm:0.3.18" - dependencies: - resolve: ~1.22.1 - strip-json-comments: ~3.1.1 - checksum: 41e719fb14d99e0f79093523fede051dba2be5f53d63d5ae45c2ea1b8448e298e0303d8453be3f9ac5e8bb99e3dcf3ddbe4cc59d9be5eddb914286acbdd0a2f3 - languageName: node - linkType: hard - -"@rushstack/ts-command-line@npm:4.13.2": - version: 4.13.2 - resolution: "@rushstack/ts-command-line@npm:4.13.2" - dependencies: - "@types/argparse": 1.0.38 - argparse: ~1.0.9 - colors: ~1.2.1 - string-argv: ~0.3.1 - checksum: 3938e533e08d5cf4007a651d1aab658a7a60d6136a56414e2370b64434657a5d5a9eff442da4ddc260d5e6dc90f82428de64dbcfa1285e9ae176629f7fcd821d - languageName: node - linkType: hard - "@tootallnate/once@npm:2": version: 2.0.0 resolution: "@tootallnate/once@npm:2.0.0" @@ -672,13 +577,6 @@ __metadata: languageName: node linkType: hard -"@types/argparse@npm:1.0.38": - version: 1.0.38 - resolution: "@types/argparse@npm:1.0.38" - checksum: 26ed7e3f1e3595efdb883a852f5205f971b798e4c28b7e30a32c5298eee596e8b45834ce831f014d250b9730819ab05acff5b31229666d3af4ba465b4697d0eb - languageName: node - linkType: hard - "@types/glob@npm:8.1.0": version: 8.1.0 resolution: "@types/glob@npm:8.1.0" @@ -784,18 +682,6 @@ __metadata: languageName: node linkType: hard -"ajv@npm:~6.12.6": - version: 6.12.6 - resolution: "ajv@npm:6.12.6" - dependencies: - fast-deep-equal: ^3.1.1 - fast-json-stable-stringify: ^2.0.0 - json-schema-traverse: ^0.4.1 - uri-js: ^4.2.2 - checksum: 874972efe5c4202ab0a68379481fbd3d1b5d0a7bd6d3cc21d40d3536ebff3352a2a1fabb632d4fd2cc7fe4cbdcd5ed6782084c9bbf7f32a1536d18f9da5007d4 - languageName: node - linkType: hard - "ansi-colors@npm:^4.1.1, ansi-colors@npm:^4.1.3": version: 4.1.3 resolution: "ansi-colors@npm:4.1.3" @@ -869,7 +755,7 @@ __metadata: languageName: node linkType: hard -"argparse@npm:^1.0.7, argparse@npm:~1.0.9": +"argparse@npm:^1.0.7": version: 1.0.10 resolution: "argparse@npm:1.0.10" dependencies: @@ -1188,13 +1074,6 @@ __metadata: languageName: node linkType: hard -"colors@npm:~1.2.1": - version: 1.2.5 - resolution: "colors@npm:1.2.5" - checksum: b6e23de735f68b72d5cdf6fd854ca43d1b66d82dcf54bda0b788083b910164a040f2c4edf23c670d36a7a2d8f1b7d6e62e3292703e4642691e6ccaa1c62d8f74 - languageName: node - linkType: hard - "commander@npm:^4.0.0": version: 4.1.1 resolution: "commander@npm:4.1.1" @@ -1202,13 +1081,6 @@ __metadata: languageName: node linkType: hard -"commander@npm:^9.4.1": - version: 9.5.0 - resolution: "commander@npm:9.5.0" - checksum: c7a3e27aa59e913b54a1bafd366b88650bc41d6651f0cbe258d4ff09d43d6a7394232a4dadd0bf518b3e696fdf595db1028a0d82c785b88bd61f8a440cecfade - languageName: node - linkType: hard - "concat-map@npm:0.0.1": version: 0.0.1 resolution: "concat-map@npm:0.0.1" @@ -1628,13 +1500,6 @@ __metadata: languageName: node linkType: hard -"fast-deep-equal@npm:^3.1.1": - version: 3.1.3 - resolution: "fast-deep-equal@npm:3.1.3" - checksum: e21a9d8d84f53493b6aa15efc9cfd53dd5b714a1f23f67fb5dc8f574af80df889b3bce25dc081887c6d25457cce704e636395333abad896ccdec03abaf1f3f9d - languageName: node - linkType: hard - "fast-glob@npm:^3.2.9": version: 3.2.12 resolution: "fast-glob@npm:3.2.12" @@ -1648,13 +1513,6 @@ __metadata: languageName: node linkType: hard -"fast-json-stable-stringify@npm:^2.0.0": - version: 2.1.0 - resolution: "fast-json-stable-stringify@npm:2.1.0" - checksum: b191531e36c607977e5b1c47811158733c34ccb3bfde92c44798929e9b4154884378536d26ad90dfecd32e1ffc09c545d23535ad91b3161a27ddbb8ebe0cbecb - languageName: node - linkType: hard - "fastq@npm:^1.6.0": version: 1.15.0 resolution: "fastq@npm:1.15.0" @@ -1712,7 +1570,7 @@ __metadata: languageName: node linkType: hard -"fs-extra@npm:^7.0.1, fs-extra@npm:~7.0.1": +"fs-extra@npm:^7.0.1": version: 7.0.1 resolution: "fs-extra@npm:7.0.1" dependencies: @@ -2138,13 +1996,6 @@ __metadata: languageName: node linkType: hard -"import-lazy@npm:~4.0.0": - version: 4.0.0 - resolution: "import-lazy@npm:4.0.0" - checksum: 22f5e51702134aef78890156738454f620e5fe7044b204ebc057c614888a1dd6fdf2ede0fdcca44d5c173fd64f65c985f19a51775b06967ef58cc3d26898df07 - languageName: node - linkType: hard - "imurmurhash@npm:^0.1.4": version: 0.1.4 resolution: "imurmurhash@npm:0.1.4" @@ -2265,7 +2116,7 @@ __metadata: languageName: node linkType: hard -"is-core-module@npm:^2.1.0, is-core-module@npm:^2.9.0": +"is-core-module@npm:^2.9.0": version: 2.11.0 resolution: "is-core-module@npm:2.11.0" dependencies: @@ -2432,13 +2283,6 @@ __metadata: languageName: node linkType: hard -"jju@npm:~1.4.0": - version: 1.4.0 - resolution: "jju@npm:1.4.0" - checksum: 3790481bd2b7827dd6336e6e3dc2dcc6d425679ba7ebde7b679f61dceb4457ea0cda330972494de608571f4973c6dfb5f70fab6f3c5037dbab19ac449a60424f - languageName: node - linkType: hard - "joycon@npm:^3.0.1": version: 3.1.1 resolution: "joycon@npm:3.1.1" @@ -2472,13 +2316,6 @@ __metadata: languageName: node linkType: hard -"json-schema-traverse@npm:^0.4.1": - version: 0.4.1 - resolution: "json-schema-traverse@npm:0.4.1" - checksum: 7486074d3ba247769fda17d5181b345c9fb7d12e0da98b22d1d71a5db9698d8b4bd900a3ec1a4ffdd60846fc2556274a5c894d0c48795f14cb03aeae7b55260b - languageName: node - linkType: hard - "jsonc-parser@npm:^3.2.0": version: 3.2.0 resolution: "jsonc-parser@npm:3.2.0" @@ -2563,20 +2400,6 @@ __metadata: languageName: node linkType: hard -"lodash.get@npm:^4.4.2": - version: 4.4.2 - resolution: "lodash.get@npm:4.4.2" - checksum: e403047ddb03181c9d0e92df9556570e2b67e0f0a930fcbbbd779370972368f5568e914f913e93f3b08f6d492abc71e14d4e9b7a18916c31fa04bd2306efe545 - languageName: node - linkType: hard - -"lodash.isequal@npm:^4.5.0": - version: 4.5.0 - resolution: "lodash.isequal@npm:4.5.0" - checksum: da27515dc5230eb1140ba65ff8de3613649620e8656b19a6270afe4866b7bd461d9ba2ac8a48dcc57f7adac4ee80e1de9f965d89d4d81a0ad52bb3eec2609644 - languageName: node - linkType: hard - "lodash.sortby@npm:^4.7.0": version: 4.7.0 resolution: "lodash.sortby@npm:4.7.0" @@ -2591,13 +2414,6 @@ __metadata: languageName: node linkType: hard -"lodash@npm:~4.17.15": - version: 4.17.21 - resolution: "lodash@npm:4.17.21" - checksum: eb835a2e51d381e561e508ce932ea50a8e5a68f4ebdd771ea240d3048244a8d13658acbd502cd4829768c56f2e16bdd4340b9ea141297d472517b83868e677f7 - languageName: node - linkType: hard - "lru-cache@npm:^4.0.1": version: 4.1.5 resolution: "lru-cache@npm:4.1.5" @@ -3163,7 +2979,7 @@ __metadata: languageName: node linkType: hard -"path-parse@npm:^1.0.6, path-parse@npm:^1.0.7": +"path-parse@npm:^1.0.7": version: 1.0.7 resolution: "path-parse@npm:1.0.7" checksum: 49abf3d81115642938a8700ec580da6e830dde670be21893c62f4e10bd7dd4c3742ddc603fe24f898cba7eb0c6bc1777f8d9ac14185d34540c6d4d80cd9cae8a @@ -3405,7 +3221,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:^1.10.0, resolve@npm:~1.22.1": +"resolve@npm:^1.10.0": version: 1.22.1 resolution: "resolve@npm:1.22.1" dependencies: @@ -3418,17 +3234,7 @@ __metadata: languageName: node linkType: hard -"resolve@npm:~1.19.0": - version: 1.19.0 - resolution: "resolve@npm:1.19.0" - dependencies: - is-core-module: ^2.1.0 - path-parse: ^1.0.6 - checksum: a05b356e47b85ad3613d9e2a39a824f3c27f4fcad9c9ff6c7cc71a2e314c5904a90ab37481ad0069d03cab9eaaac6eb68aca1bc3355fdb05f1045cd50e2aacea - languageName: node - linkType: hard - -"resolve@patch:resolve@^1.10.0#~builtin, resolve@patch:resolve@~1.22.1#~builtin": +"resolve@patch:resolve@^1.10.0#~builtin": version: 1.22.1 resolution: "resolve@patch:resolve@npm%3A1.22.1#~builtin::version=1.22.1&hash=c3c19d" dependencies: @@ -3441,16 +3247,6 @@ __metadata: languageName: node linkType: hard -"resolve@patch:resolve@~1.19.0#~builtin": - version: 1.19.0 - resolution: "resolve@patch:resolve@npm%3A1.19.0#~builtin::version=1.19.0&hash=c3c19d" - dependencies: - is-core-module: ^2.1.0 - path-parse: ^1.0.6 - checksum: 2443b94d347e6946c87c85faf13071f605e609e0b54784829b0ed2b917d050bfc1cbaf4ecc6453f224cfa7d0c5dcd97cbb273454cd210bee68e4af15c1a5abc9 - languageName: node - linkType: hard - "retry@npm:^0.12.0": version: 0.12.0 resolution: "retry@npm:0.12.0" @@ -3533,7 +3329,7 @@ __metadata: languageName: node linkType: hard -"semver@npm:^7.3.5, semver@npm:~7.3.0": +"semver@npm:^7.3.5": version: 7.3.8 resolution: "semver@npm:7.3.8" dependencies: @@ -3683,7 +3479,7 @@ __metadata: languageName: node linkType: hard -"source-map@npm:^0.6.0, source-map@npm:^0.6.1, source-map@npm:~0.6.1": +"source-map@npm:^0.6.0, source-map@npm:^0.6.1": version: 0.6.1 resolution: "source-map@npm:0.6.1" checksum: 59ce8640cf3f3124f64ac289012c2b8bd377c238e316fb323ea22fbfe83da07d81e000071d7242cad7a23cd91c7de98e4df8830ec3f133cb6133a5f6e9f67bc2 @@ -3759,13 +3555,6 @@ __metadata: languageName: node linkType: hard -"string-argv@npm:~0.3.1": - version: 0.3.1 - resolution: "string-argv@npm:0.3.1" - checksum: efbd0289b599bee808ce80820dfe49c9635610715429c6b7cc50750f0437e3c2f697c81e5c390208c13b5d5d12d904a1546172a88579f6ee5cbaaaa4dc9ec5cf - languageName: node - linkType: hard - "string-width@npm:^1.0.2 || 2 || 3 || 4, string-width@npm:^4.1.0, string-width@npm:^4.2.0, string-width@npm:^4.2.3": version: 4.2.3 resolution: "string-width@npm:4.2.3" @@ -3840,13 +3629,6 @@ __metadata: languageName: node linkType: hard -"strip-json-comments@npm:~3.1.1": - version: 3.1.1 - resolution: "strip-json-comments@npm:3.1.1" - checksum: 492f73e27268f9b1c122733f28ecb0e7e8d8a531a6662efbd08e22cccb3f9475e90a1b82cab06a392f6afae6d2de636f977e231296400d0ec5304ba70f166443 - languageName: node - linkType: hard - "sucrase@npm:^3.20.3": version: 3.29.0 resolution: "sucrase@npm:3.29.0" @@ -4133,16 +3915,6 @@ __metadata: languageName: node linkType: hard -"typescript@npm:~4.8.4": - version: 4.8.4 - resolution: "typescript@npm:4.8.4" - bin: - tsc: bin/tsc - tsserver: bin/tsserver - checksum: 3e4f061658e0c8f36c820802fa809e0fd812b85687a9a2f5430bc3d0368e37d1c9605c3ce9b39df9a05af2ece67b1d844f9f6ea8ff42819f13bcb80f85629af0 - languageName: node - linkType: hard - "typescript@patch:typescript@^5.0.2#~builtin": version: 5.0.2 resolution: "typescript@patch:typescript@npm%3A5.0.2#~builtin::version=5.0.2&hash=1f5320" @@ -4153,16 +3925,6 @@ __metadata: languageName: node linkType: hard -"typescript@patch:typescript@~4.8.4#~builtin": - version: 4.8.4 - resolution: "typescript@patch:typescript@npm%3A4.8.4#~builtin::version=4.8.4&hash=1a91c8" - bin: - tsc: bin/tsc - tsserver: bin/tsserver - checksum: c981e82b77a5acdcc4e69af9c56cdecf5b934a87a08e7b52120596701e389a878b8e3f860e73ffb287bf649cc47a8c741262ce058148f71de4cdd88bb9c75153 - languageName: node - linkType: hard - "uglify-js@npm:^3.1.4": version: 3.17.4 resolution: "uglify-js@npm:3.17.4" @@ -4209,15 +3971,6 @@ __metadata: languageName: node linkType: hard -"uri-js@npm:^4.2.2": - version: 4.4.1 - resolution: "uri-js@npm:4.4.1" - dependencies: - punycode: ^2.1.0 - checksum: 7167432de6817fe8e9e0c9684f1d2de2bb688c94388f7569f7dbdb1587c9f4ca2a77962f134ec90be0cc4d004c939ff0d05acc9f34a0db39a3c797dada262633 - languageName: node - linkType: hard - "util-deprecate@npm:^1.0.1": version: 1.0.2 resolution: "util-deprecate@npm:1.0.2" @@ -4235,13 +3988,6 @@ __metadata: languageName: node linkType: hard -"validator@npm:^13.7.0": - version: 13.9.0 - resolution: "validator@npm:13.9.0" - checksum: e2c936f041f61faa42bafd17c6faddf939498666cd82e88d733621c286893730b008959f4cb12ab3e236148a4f3805c30b85e3dcf5e0efd8b0cbcd36c02bfc0c - languageName: node - linkType: hard - "vscode-oniguruma@npm:^1.7.0": version: 1.7.0 resolution: "vscode-oniguruma@npm:1.7.0" @@ -4504,23 +4250,6 @@ __metadata: languageName: node linkType: hard -"z-schema@npm:~5.0.2": - version: 5.0.5 - resolution: "z-schema@npm:5.0.5" - dependencies: - commander: ^9.4.1 - lodash.get: ^4.4.2 - lodash.isequal: ^4.5.0 - validator: ^13.7.0 - dependenciesMeta: - commander: - optional: true - bin: - z-schema: bin/z-schema - checksum: 8a1d66817ae4384dc3f63311f0cccaadd95cc9640eaade5fd3fbf91aa80d6bb82fb95d9b9171fa82ac371a0155b32b7f5f77bbe84dabaca611b66f74c628f0b8 - languageName: node - linkType: hard - "zod@npm:^3.21.4": version: 3.21.4 resolution: "zod@npm:3.21.4" From 0b4f018b4a6ff84d105d44e71b10e2de3051ea99 Mon Sep 17 00:00:00 2001 From: Alistair Smith Date: Fri, 17 Mar 2023 11:03:10 +0000 Subject: [PATCH 33/33] remove accidental include --- tsconfig.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/tsconfig.json b/tsconfig.json index dcd6acd6..00fbbad6 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -26,10 +26,5 @@ "verbatimModuleSyntax": true }, "exclude": ["node_modules", "dist"], - "include": [ - "./**/*.ts", - "./**/*.tsx", - "dist/index.d.cts", - "dist/utils/zod/index.d.cts" - ] + "include": ["./**/*.ts", "./**/*.tsx"] }