Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change 'Typescript' to 'TypeScript', and 'Javascript' to 'JavaScript' #295

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
},
"byteSlice": {
"type": "object",
"description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
"description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like JavaScript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
"required": ["byteStart", "byteEnd"],
"properties": {
"byteStart": { "type": "integer", "minimum": 0 },
Expand Down
2 changes: 1 addition & 1 deletion atproto-openapi-types/spec/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -21206,7 +21206,7 @@
},
"app.bsky.richtext.facet.byteSlice": {
"type": "object",
"description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like Javascript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
"description": "Specifies the sub-string range a facet feature applies to. Start index is inclusive, end index is exclusive. Indices are zero-indexed, counting bytes of the UTF-8 encoded text. NOTE: some languages, like JavaScript, use UTF-16 or Unicode codepoints for string slice indexing; in these languages, convert to byte arrays before working with facets.",
"required": [
"byteStart",
"byteEnd"
Expand Down
4 changes: 2 additions & 2 deletions blog/2024-02-27-hackathon.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ Other noteworthy projects included translation bots, deep fake detectors, a frie

We prepared some starter templates for the hackathon, and want to share them below for anyone who couldn’t attend the event in person!

* [Bot Starter Repo (Typescript)](https://github.com/skygaze-ai/bot-typescript)
* [Bot Starter Repo (TypeScript)](https://github.com/skygaze-ai/bot-typescript)
* [Bot Starter Repo (Python)](https://github.com/skygaze-ai/bot-python)
* [Feed Generator Starter Repo (Typescript)](https://github.com/skygaze-ai/feed-generator-typescript)
* [Feed Generator Starter Repo (TypeScript)](https://github.com/skygaze-ai/feed-generator-typescript)
* [AT Proto 101 by Jett Hollister](https://github.com/skygaze-ai/atproto-101)

And if you’re interested in hosting your own bluesky hackathon but don’t know where to start, please feel free to copy [all of our invite copy, starter repos, and datasets](https://docs.google.com/document/d/1cMNzLm1yDMeE4P6M_ZWubz9uiHGMnthfO7v94B16ELY/edit?usp=sharing).
2 changes: 1 addition & 1 deletion blog/2024-08-12-ts-api-refactor/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
slug: ts-api-refactor
title: Typescript API Package Auth Refactor
title: TypeScript API Package Auth Refactor
tags: []
---

Expand Down
2 changes: 1 addition & 1 deletion blog/2024-09-25-oauth-atproto.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ OAuth has been deployed to several components of the atproto network over the pa

We have a a few resources for developers working with OAuth:

- The **TypeScript SDK** (`@atproto/api`) has been updated to support OAuth. READMEs are available for a [browser-specific package](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-browser) and a [Node.js-specific package](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-node). There is also a browser-based [example project](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-browser/example). You can read more about upgrading in the [Typescript API Package Auth Refactor blog post](https://docs.bsky.app/blog/ts-api-refactor).
- The **TypeScript SDK** (`@atproto/api`) has been updated to support OAuth. READMEs are available for a [browser-specific package](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-browser) and a [Node.js-specific package](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-node). There is also a browser-based [example project](https://github.com/bluesky-social/atproto/tree/main/packages/oauth/oauth-client-browser/example). You can read more about upgrading in the [TypeScript API Package Auth Refactor blog post](https://docs.bsky.app/blog/ts-api-refactor).
- [**OAuth Client Implementation Guide**](https://docs.bsky.app/docs/advanced-guides/oauth-client), a developer-oriented document.
- A [**Python (Flask) Web Service Demo**](https://github.com/bluesky-social/cookbook/blob/main/python-oauth-web-app/README.md) which shows how to implement a client "the hard way", without using a supporting SDK. A live version of the demo is running at [https://oauth-flask.demo.bsky.dev/](https://oauth-flask.demo.bsky.dev/) (it may not be operated indefinitely).
- The [**AT Protocol OAuth Specification**](https://atproto.com/specs/auth), which is the authoritative reference.
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced-guides/entryway.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Of course, a developer can always short-circuit this behavior and go directly to

We recommend this behavior, and to enable it, we return the user's DID document (which contains the user's actual PDS hostname) in all session management routes (including `createAccount`).

The [Typescript API library](https://www.npmjs.com/package/@atproto/api) published by Bluesky takes care of this dynamic routing automatically. Developers may configure it to communicate with `bsky.social`. On session creation, it will reconfigure the agent to send requests to the user's actual PDS.
The [TypeScript API library](https://www.npmjs.com/package/@atproto/api) published by Bluesky takes care of this dynamic routing automatically. Developers may configure it to communicate with `bsky.social`. On session creation, it will reconfigure the agent to send requests to the user's actual PDS.

### Engaging with Entryway as a developer

Expand All @@ -38,4 +38,4 @@ Ideally, developers should not have to engage much with the concepts surrounding
- when offering signup/login to a user, Bluesky PDSs should be communicated as `bsky.social`
- most application requests can be sent to _either_ the Entryway _or_ the PDS
- for non-session related routes, we encourage going directly to the PDS in order to avoid the extra hop
- if using the Bluesky Typescript SDK, you may configure it with `bsky.social` and the library will handle the dynamic routing for you
- if using the Bluesky TypeScript SDK, you may configure it with `bsky.social` and the library will handle the dynamic routing for you
2 changes: 1 addition & 1 deletion docs/advanced-guides/oembed.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Bluesky posts can be embedded in other websites a couple different ways. For a n

**oEmbed:** individual post pages on bsky.app have HTML metadata which points to the oEmbed API endpoint. This enables automatic oEmbed discovery when pasting bsky.app URLs in to third party applications, like blog or website composers.

HTML snippets include a basic version of the post text as a `<blockquote>`, as well as a Javascript `<script>` tag. The Javascript widget will overwrite the blockquote with an iframe which re-loads the post via API and renders it appropriately, including any media embeds, quote-posts, etc.
HTML snippets include a basic version of the post text as a `<blockquote>`, as well as a JavaScript `<script>` tag. The JavaScript widget will overwrite the blockquote with an iframe which re-loads the post via API and renders it appropriately, including any media embeds, quote-posts, etc.

The public content policy is the same as the logged-out public web interface at [https://bsky.app](https://bsky.app): adult-only content is redacted, deleted posts or accounts are redacted, and the "no unauthenticated viewers" preference on Bluesky account preferences (a self-label on the profile record) is checked and enforced.

Expand Down
4 changes: 2 additions & 2 deletions docs/advanced-guides/post-richtext.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Strings in the network are UTF-8 encoded. Facet ranges are indexed using byte of
:::warning
It's important to pay attention to this when working with facets. Incorrect indexing will produce bad data.

If you are using Typescript/Javascript, you **cannot** use `.slice()` or any of the native methods. It's suggested you use the [official atproto API's RichText library](https://npm.im/@atproto/api)
If you are using TypeScript/JavaScript, you **cannot** use `.slice()` or any of the native methods. It's suggested you use the [official atproto API's RichText library](https://npm.im/@atproto/api)
:::

To understand this fully, let's look at some of the kinds of indexing that Unicode supports:
Expand All @@ -107,7 +107,7 @@ Clients to Bluesky should produce facets using parsers. It's perfectly valid to
Here are two example parsers to help you understand this behavior, but do *not* use these. We recommend that you use one of the existing libraries in the ecosystem ([TypeScript](https://github.com/bluesky-social/atproto/tree/main/packages/api), [Python](https://atproto.blue/), [Dart](https://atprotodart.com/), [Go](https://github.com/bluesky-social/indigo/tree/main)).

<Tabs groupId="sdk">
<TabItem value="ts" label="Typescript">
<TabItem value="ts" label="TypeScript">
```ts
import TLDs from 'tlds'
import { AppBskyRichtextFacet } from '@atproto/api'
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced-guides/service-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ For more details on these service auth tokens, check out the [atproto specs](htt
To create and verify service auth tokens, you can use the `@atproto/xrpc-server` library.

<Tabs groupId="sdk">
<TabItem value="ts" label="Typescript">
<TabItem value="ts" label="TypeScript">
```ts
import { createServiceJwt, verifyServiceJwt } from '@atproto/xrpc-server'
import { IdResolver } from '@atproto/identity'
Expand Down
Loading