mary.my.id / atcute
a collection of lightweight TypeScript packages for AT Protocol, the protocol powering Bluesky
atproto bluesky typescript npm
fork atom
atcute / packages / definitions / bluemoji / CHANGELOG.md
at trunk 8.6 kB view raw view code

@atcute/bluemoji#

3.1.3#

Patch Changes#

  • 1429438: add atcute:lexicons metadata to package.json

    all lexicon definition packages now include the atcute:lexicons field with namespace mappings, enabling automatic import resolution when used with @atcute/lex-cli's imports configuration.

  • Updated dependencies [1429438]

    • @atcute/atproto@3.1.8
    • @atcute/bluesky@3.2.8

3.1.2#

Patch Changes#

  • 8f4bd4b: add JSDoc to object fields
  • Updated dependencies [8f4bd4b]
    • @atcute/atproto@3.1.7
    • @atcute/bluesky@3.2.6

3.1.1#

Patch Changes#

  • b30da0e: add declarationMap to tsconfig
  • Updated dependencies [17c6f4a]
  • Updated dependencies [b30da0e]
    • @atcute/lexicons@1.2.2
    • @atcute/atproto@3.1.6
    • @atcute/bluesky@3.2.5

3.1.0#

Minor Changes#

  • e8592d0: bring back convenient interfaces for XRPC operations

    in hindsight, it was a big mistake making substituting AppBskyFeedGetTimeline.Output for InferXRPCBodyInput<AppBskyFeedGetTimeline.mainSchema['output']>!

    the change was prompted because lexicon documents do not reserve names for the code generator's types, you could have a document defining a query and a type named output, and you'd basically wreck havoc on the codegen itself.

    but clearly these convenient interfaces are still worth having, so while it now exists, the compromise is that these interfaces now have been renamed to ensure they don't conflict with any definitions ever:

    • Params to $params, for query parameters
    • Input to $input, for request body
    • Output to $output, for response body

Patch Changes#

  • Updated dependencies [e8592d0]
    • @atcute/atproto@3.1.0
    • @atcute/bluesky@3.1.0

3.0.3#

Patch Changes#

  • 3efa702: validate default/const/known values with the given constraints
  • 30ccef3: set a minimum constraint of 1 array items for XRPC parameters
  • Updated dependencies [a2dbb16]
  • Updated dependencies [c07b5a7]
  • Updated dependencies [9ef363f]
  • Updated dependencies [30ccef3]
    • @atcute/lexicons@1.0.4
    • @atcute/bluesky@3.0.4
    • @atcute/atproto@3.0.3

3.0.2#

Patch Changes#

  • 1b1bd64: CID-formatted strings should be validated

    somehow missed this

  • Updated dependencies [e2d3d00]

  • Updated dependencies [1b1bd64]

  • Updated dependencies [61b0fd1]

    • @atcute/atproto@3.0.2
    • @atcute/bluesky@3.0.2
    • @atcute/lexicons@1.0.2

3.0.1#

Patch Changes#

  • 480e58b: missing pure annotation on constrained arrays
  • Updated dependencies [6abad75]
  • Updated dependencies [5310da3]
  • Updated dependencies [3125bf6]
  • Updated dependencies [480e58b]
  • Updated dependencies [5ec9a3c]
  • Updated dependencies [69db9c7]
  • Updated dependencies [a53b88a]
    • @atcute/lexicons@1.0.1
    • @atcute/atproto@3.0.1
    • @atcute/bluesky@3.0.1

3.0.0#

Major Changes#

  • d02554d: a major change to how types are consumed, and schema validation!

    this change is pretty big, where it used to be that @atcute/client would ship type definitions for core lexicon types (At.Did, At.ResourceUri, At.CidLink and so on) and com.atproto.* interfaces, they're now decoupled into their own packages:

    • @atcute/lexicons for core lexicon types
    • @atcute/atproto for com.atproto.* interfaces

    when upgrading @atcute/client, you must now install @atcute/lexicons. if you use any types from com.atproto.*, then you'd need to install @atcute/atproto as well.

    migration notes:

    • the At namespace is gone, you can import Did, ResourceUri and many other core types directly from @atcute/lexicons

      import type { Did } from '@atcute/lexicons';
import type { AppBskyActorDefs } from '@atcute/bluesky';

export const findAllProfiles = (did: Did): AppBskyActorDefs.ProfileView[] => {
	// ...
};

    • interfaces now use the $type field instead of a type-only symbol for branding. consequently the Brand namespace which contains utilities for dealing with branding is renamed to $type, use $type.enforce<> to enforce the existence of a $type field.

      import type { $type } from '@atcute/lexicons';
import type { AppBskyRichtextFacet } from '@atcute/bluesky';

type Facet = AppBskyRichtextFacet.Main;
type MentionFeature = $type.enforce<AppBskyRichtextFacet.Mention>;

const mention: MentionFeature = {
	$type: 'app.bsky.richtext.facet#mention',
	did: 'did:plc:z72i7hdynmk6r22z27h6tvur',
};

const facet: Facet = {
	index: {
		byteStart: 6,
		byteEnd: 15,
	},
	features: [mention],
};

    • record interfaces are renamed, they're no longer Record but rather Main

      import type { AppBskyFeedPost } from '@atcute/bluesky';

const record: AppBskyFeedPost.Main = {
	$type: 'app.bsky.feed.post',
	text: `hello world!`,
	createdAt: new Date().toISOString(),
};

    • queries and procedures no longer have exported interfaces for their parameters, input body and output body. use InferInput/InferOutput and InferXRPCBodyInput/InferXRPCBodyOutput to get them.

      import type { InferInput, InferOutput, InferXRPCBodyInput, InferXRPCBodyOutput } from '@atcute/lexicons';

import type { AppBskyActorSearchActors } from '@atcute/bluesky';

// parameters where all the default fields are marked optional
type ParamsInput = InferInput<AppBskyActorSearchActors.mainSchema['params']>;
// parameters where all the default fields are marked required (filled out)
type ParamsOutput = InferOutput<AppBskyActorSearchActors.mainSchema['params']>;

type ResponseInput = InferXRPCBodyInput<AppBskyActorSearchActors.mainSchema['output']>;
type ResponseOutput = InferXRPCBodyOutput<AppBskyActorSearchActors.mainSchema['output']>;

    this change means that downstream consumers that were only relying on @atcute/client for its type definitions no longer are pinned on the versioning of the API client.

    that said, this isn't solely about restructuring type interfaces. we now provide runtime schemas and subsequently schema validation!

    import { ComAtprotoLabelDefs } from '@atcute/atproto';
import { is } from '@atcute/lexicons';

const label: ComAtprotoLabelDefs.Label = {
	cts: '2024-11-13T04:46:40.254Z',
	neg: false,
	src: 'did:plc:wkoofae5uytcm7bjncmev6n6',
	uri: 'did:plc:ia76kvnndjutgedggx2ibrem',
	val: 'she-it',
	ver: 1,
};

is(ComAtprotoLabelDefs.labelSchema, label);
// -> true

    this is a big deal, where the reference TypeScript packages stuffed all the lexicons into a single validator instance, and relied on you to pick whether it should generate interfaces suited for either client or server. we generate code that allows for static type inference, allowing for client and servers to consume types from the same package.

    these schemas are web-friendly, they are treeshakeable by design, minimizing the impact it has on your bundle size.

    that's all! this whole plan has been almost 8 months in the making, I hope all of this change benefits the AT Protocol developer community in some way, just as AT Protocol gave me a lot of fun working with it.

Patch Changes#

  • Updated dependencies [d02554d]
  • Updated dependencies [af85dca]
    • @atcute/bluesky@3.0.0
    • @atcute/atproto@3.0.0

2.0.0#

Major Changes#

  • a47373f: add At.Identifier string type

    an alias for either At.DID or At.Handle

  • d3fbc7e: consistent casing on types and interfaces

    no more capitalized/pascalcase mixing, these following types are renamed:

    • At.CID → At.Cid
    • At.CIDLink → At.CidLink
    • At.DID → At.Did

  • c7e8573: add At.ResourceUri string type

    this is a specialized type for at-uri formatted strings, replacing the previous At.Uri string

  • 61bd8d2: add At.GenericUri string type

    this is a specialized type for uri formatted strings, where there were previously none.

Minor Changes#

  • 45cfe46: add new response field, deprecating the old output field

Patch Changes#

  • Updated dependencies [9d05dfd]
  • Updated dependencies [ecce2c6]
  • Updated dependencies [13f35e4]
  • Updated dependencies [a47373f]
  • Updated dependencies [45cc699]
  • Updated dependencies [2d10bd8]
  • Updated dependencies [8aedcc5]
  • Updated dependencies [45cfe46]
  • Updated dependencies [813679f]
  • Updated dependencies [24be9be]
  • Updated dependencies [d3fbc7e]
  • Updated dependencies [c7e8573]
  • Updated dependencies [61bd8d2]
  • Updated dependencies [87a99f1]
    • @atcute/client@3.0.0
    • @atcute/bluesky@2.0.0