@atcute/bluemoji 1.0.3 → 2.0.0

package/README.md

@@ -1,9 +1,30 @@
 # @atcute/bluemoji
 
-[Bluemoji](https://github.com/aendra-rininsland/bluemoji) type definitions for `@atcute/client`, a lightweight and cute API client for AT Protocol.
+[Bluemoji](https://github.com/aendra-rininsland/bluemoji) type definitions for `@atcute/client`, a
+lightweight and cute API client for AT Protocol.
 
-import the lexicons module to start using it.
+## usage
+
+you'd need to import `@atcute/bluemoji/lexicons` into your project, either by adding it into the
+`types` field in `tsconfig.json` or by importing it on your source code.
+
+```jsonc
+// tsconfig.json
+{
+	"compilerOptions": {
+		"types": ["@atcute/bluemoji/lexicons"],
+	},
+}
+```
 
 ```ts
+// env.d.ts
+/// <reference types="@atcute/bluemoji/lexicons" />
+```
+
+```ts
+// index.ts
 import '@atcute/bluemoji/lexicons';
 ```
+
+newly added lexicons are augmented to `@atcute/client/lexicons` module

package/dist/lexicons.d.ts

@@ -8,7 +8,7 @@ declare module '@atcute/client/lexicons' {
     namespace BlueMojiCollectionDefs {
         interface CollectionView {
             [Brand.Type]?: 'blue.moji.collection.defs#collectionView';
-            cid: At.CID;
+            cid: At.Cid;
             creator: AppBskyActorDefs.ProfileView;
             indexedAt: string;
             /**
@@ -16,8 +16,8 @@ declare module '@atcute/client/lexicons' {
              * Maximum string length: 64
              */
             name: string;
-            uri: At.Uri;
-            avatar?: string;
+            uri: At.ResourceUri;
+            avatar?: At.GenericUri;
             /** Minimum: 0 */
             collectionItemCount?: number;
             /**
@@ -35,12 +35,12 @@ declare module '@atcute/client/lexicons' {
             /** The Bluemoji alias/rkey. */
             name: string;
             /** The handle or DID of the repo. */
-            repo: string;
+            repo: At.Identifier;
         }
         type Input = undefined;
         interface Output {
             item: BlueMojiCollectionItem.ItemView;
-            uri: At.Uri;
+            uri: At.ResourceUri;
         }
     }
     namespace BlueMojiCollectionItem {
@@ -55,7 +55,7 @@ declare module '@atcute/client/lexicons' {
             /** @default false */
             adultOnly?: boolean;
             alt?: string;
-            copyOf?: At.Uri;
+            copyOf?: At.ResourceUri;
             /**
              * Maximum string length: 1
              * @default "◌"
@@ -109,7 +109,7 @@ declare module '@atcute/client/lexicons' {
         interface ItemView {
             [Brand.Type]?: 'blue.moji.collection.listCollection#itemView';
             record: BlueMojiCollectionItem.ItemView;
-            uri: At.Uri;
+            uri: At.ResourceUri;
         }
     }
     /** Write a Bluemoji record, creating or updating it as needed. Requires auth, implemented by AppView. */
@@ -119,7 +119,7 @@ declare module '@atcute/client/lexicons' {
         interface Input {
             item: BlueMojiCollectionItem.ItemView;
             /** The handle or DID of the repo (aka, current account). */
-            repo: string;
+            repo: At.Identifier;
             /**
              * Can be set to 'false' to skip Lexicon schema validation of record data.
              * @default true
@@ -127,7 +127,7 @@ declare module '@atcute/client/lexicons' {
             validate?: boolean;
         }
         interface Output {
-            uri: At.Uri;
+            uri: At.ResourceUri;
         }
         interface Errors {
         }
@@ -143,13 +143,13 @@ declare module '@atcute/client/lexicons' {
              */
             name: string;
             /** The handle or DID of the repo to copy from. */
-            source: string;
+            source: At.Identifier;
             /** The alias to save the Bluemoji to in the current logged-in user's repo. */
             renameTo?: string;
         }
         interface Output {
             item: BlueMojiCollectionItem.ItemView;
-            uri: At.Uri;
+            uri: At.ResourceUri;
         }
         interface Errors {
             EmojiNotFound: {};
@@ -160,11 +160,11 @@ declare module '@atcute/client/lexicons' {
         interface PackItemView {
             [Brand.Type]?: 'blue.moji.packs.defs#packItemView';
             subject: BlueMojiCollectionItem.ItemView;
-            uri: At.Uri;
+            uri: At.ResourceUri;
         }
         interface PackView {
             [Brand.Type]?: 'blue.moji.packs.defs#packView';
-            cid: At.CID;
+            cid: At.Cid;
             creator: AppBskyActorDefs.ProfileView;
             indexedAt: string;
             /**
@@ -172,8 +172,8 @@ declare module '@atcute/client/lexicons' {
              * Maximum string length: 64
              */
             name: string;
-            uri: At.Uri;
-            avatar?: string;
+            uri: At.ResourceUri;
+            avatar?: At.GenericUri;
             /**
              * Maximum string length: 3000 \
              * Maximum grapheme length: 300
@@ -187,14 +187,14 @@ declare module '@atcute/client/lexicons' {
         }
         interface PackViewBasic {
             [Brand.Type]?: 'blue.moji.packs.defs#packViewBasic';
-            cid: At.CID;
+            cid: At.Cid;
             /**
              * Minimum string length: 1 \
              * Maximum string length: 64
              */
             name: string;
-            uri: At.Uri;
-            avatar?: string;
+            uri: At.ResourceUri;
+            avatar?: At.GenericUri;
             /**
              * Maximum string length: 3000 \
              * Maximum grapheme length: 300
@@ -215,7 +215,7 @@ declare module '@atcute/client/lexicons' {
     /** Get a list of Bluemoji packs created by the actor. */
     namespace BlueMojiPacksGetActorPacks {
         interface Params {
-            actor: string;
+            actor: At.Identifier;
             cursor?: string;
             /**
              * Minimum: 1 \
@@ -234,7 +234,7 @@ declare module '@atcute/client/lexicons' {
     namespace BlueMojiPacksGetPack {
         interface Params {
             /** Reference (AT-URI) of the pack record to hydrate. */
-            pack: At.Uri;
+            pack: At.ResourceUri;
             cursor?: string;
             /**
              * Minimum: 1 \
@@ -254,7 +254,7 @@ declare module '@atcute/client/lexicons' {
     namespace BlueMojiPacksGetPacks {
         interface Params {
             /** Maximum array length: 25 */
-            uris: At.Uri[];
+            uris: At.ResourceUri[];
         }
         type Input = undefined;
         interface Output {
@@ -290,9 +290,9 @@ declare module '@atcute/client/lexicons' {
             $type: 'blue.moji.packs.packitem';
             createdAt: string;
             /** Reference (AT-URI) to the pack record (blue.moji.packs.pack). */
-            pack: At.Uri;
+            pack: At.ResourceUri;
             /** Reference (AT-URI) to the Bluemoji item record (blue.moji.collection.item). */
-            subject: At.Uri;
+            subject: At.ResourceUri;
         }
     }
     namespace BlueMojiRichtextFacet {
@@ -314,11 +314,11 @@ declare module '@atcute/client/lexicons' {
             [Brand.Type]?: 'blue.moji.richtext.facet#formats_v0';
             /** @default false */
             apng_128?: boolean;
-            gif_128?: At.CID;
+            gif_128?: At.Cid;
             /** @default false */
             lottie?: boolean;
-            png_128?: At.CID;
-            webp_128?: At.CID;
+            png_128?: At.Cid;
+            webp_128?: At.Cid;
         }
     }
     interface Records {
@@ -329,33 +329,61 @@ declare module '@atcute/client/lexicons' {
     interface Queries {
         'blue.moji.collection.getItem': {
             params: BlueMojiCollectionGetItem.Params;
+            /** @deprecated */
             output: BlueMojiCollectionGetItem.Output;
+            response: {
+                json: BlueMojiCollectionGetItem.Output;
+            };
         };
         'blue.moji.collection.listCollection': {
             params: BlueMojiCollectionListCollection.Params;
+            /** @deprecated */
             output: BlueMojiCollectionListCollection.Output;
+            response: {
+                json: BlueMojiCollectionListCollection.Output;
+            };
         };
         'blue.moji.packs.getActorPacks': {
             params: BlueMojiPacksGetActorPacks.Params;
+            /** @deprecated */
             output: BlueMojiPacksGetActorPacks.Output;
+            response: {
+                json: BlueMojiPacksGetActorPacks.Output;
+            };
         };
         'blue.moji.packs.getPack': {
             params: BlueMojiPacksGetPack.Params;
+            /** @deprecated */
             output: BlueMojiPacksGetPack.Output;
+            response: {
+                json: BlueMojiPacksGetPack.Output;
+            };
         };
         'blue.moji.packs.getPacks': {
             params: BlueMojiPacksGetPacks.Params;
+            /** @deprecated */
             output: BlueMojiPacksGetPacks.Output;
+            response: {
+                json: BlueMojiPacksGetPacks.Output;
+            };
         };
     }
     interface Procedures {
         'blue.moji.collection.putItem': {
             input: BlueMojiCollectionPutItem.Input;
+            /** @deprecated */
             output: BlueMojiCollectionPutItem.Output;
+            response: {
+                json: BlueMojiCollectionPutItem.Output;
+            };
         };
         'blue.moji.collection.saveToCollection': {
             input: BlueMojiCollectionSaveToCollection.Input;
+            /** @deprecated */
             output: BlueMojiCollectionSaveToCollection.Output;
+            response: {
+                json: BlueMojiCollectionSaveToCollection.Output;
+            };
         };
     }
 }

package/lib/lexicons.ts

@@ -0,0 +1,392 @@
+/* eslint-disable */
+// This file is automatically generated, do not edit!
+
+/**
+ * @module
+ * Contains type declarations for Bluemoji lexicons
+ */
+
+import '@atcute/client/lexicons';
+import '@atcute/bluesky/lexicons';
+
+declare module '@atcute/client/lexicons' {
+	namespace BlueMojiCollectionDefs {
+		interface CollectionView {
+			[Brand.Type]?: 'blue.moji.collection.defs#collectionView';
+			cid: At.Cid;
+			creator: AppBskyActorDefs.ProfileView;
+			indexedAt: string;
+			/**
+			 * Minimum string length: 1 \
+			 * Maximum string length: 64
+			 */
+			name: string;
+			uri: At.ResourceUri;
+			avatar?: At.GenericUri;
+			/** Minimum: 0 */
+			collectionItemCount?: number;
+			/**
+			 * Maximum string length: 3000 \
+			 * Maximum grapheme length: 300
+			 */
+			description?: string;
+			descriptionFacets?: AppBskyRichtextFacet.Main[];
+			labels?: ComAtprotoLabelDefs.Label[];
+		}
+	}
+
+	/** Get a single emoji from a repository. Requires auth. */
+	namespace BlueMojiCollectionGetItem {
+		interface Params {
+			/** The Bluemoji alias/rkey. */
+			name: string;
+			/** The handle or DID of the repo. */
+			repo: At.Identifier;
+		}
+		type Input = undefined;
+		interface Output {
+			item: BlueMojiCollectionItem.ItemView;
+			uri: At.ResourceUri;
+		}
+	}
+
+	namespace BlueMojiCollectionItem {
+		/** A custom emoji */
+		interface Record {
+			$type: 'blue.moji.collection.item';
+			createdAt: string;
+			/** Open union to allow for future formats */
+			formats: Brand.Union<Formats_v0>;
+			/** Should be in the format :emoji: */
+			name: string;
+			/** @default false */
+			adultOnly?: boolean;
+			alt?: string;
+			copyOf?: At.ResourceUri;
+			/**
+			 * Maximum string length: 1
+			 * @default "◌"
+			 */
+			fallbackText?: string;
+			/** Self-label values for this emoji. Effectively content warnings. */
+			labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
+		}
+		/** Limiting blobs to 256kb because there may be many on page and these get optimised by ImgProxy anyway */
+		type Blob_v0 = At.Blob;
+		/** 64kb should be enough for anybody */
+		type Bytes_v0 = At.Bytes;
+		interface Formats_v0 {
+			[Brand.Type]?: 'blue.moji.collection.item#formats_v0';
+			apng_128?: Bytes_v0;
+			gif_128?: Blob_v0;
+			lottie?: Bytes_v0;
+			original?: At.Blob;
+			png_128?: Blob_v0;
+			webp_128?: Blob_v0;
+		}
+		interface ItemView {
+			[Brand.Type]?: 'blue.moji.collection.item#itemView';
+			formats: Formats_v0;
+			name: string;
+			/** @default false */
+			adultOnly?: boolean;
+			alt?: string;
+			createdAt?: string;
+		}
+	}
+
+	/** List a range of Bluemoji in a repository, matching a specific collection. Requires auth. */
+	namespace BlueMojiCollectionListCollection {
+		interface Params {
+			cursor?: string;
+			/**
+			 * The number of records to return. \
+			 * Minimum: 1 \
+			 * Maximum: 100
+			 * @default 50
+			 */
+			limit?: number;
+			/** Flag to reverse the order of the returned records. */
+			reverse?: boolean;
+		}
+		type Input = undefined;
+		interface Output {
+			items: BlueMojiCollectionItem.ItemView[];
+			cursor?: string;
+		}
+		interface ItemView {
+			[Brand.Type]?: 'blue.moji.collection.listCollection#itemView';
+			record: BlueMojiCollectionItem.ItemView;
+			uri: At.ResourceUri;
+		}
+	}
+
+	/** Write a Bluemoji record, creating or updating it as needed. Requires auth, implemented by AppView. */
+	namespace BlueMojiCollectionPutItem {
+		interface Params {}
+		interface Input {
+			item: BlueMojiCollectionItem.ItemView;
+			/** The handle or DID of the repo (aka, current account). */
+			repo: At.Identifier;
+			/**
+			 * Can be set to 'false' to skip Lexicon schema validation of record data.
+			 * @default true
+			 */
+			validate?: boolean;
+		}
+		interface Output {
+			uri: At.ResourceUri;
+		}
+		interface Errors {}
+	}
+
+	/** Copy a single emoji from another repo. Requires auth. */
+	namespace BlueMojiCollectionSaveToCollection {
+		interface Params {}
+		interface Input {
+			/**
+			 * The source Bluemoji name/rkey. \
+			 * Maximum string length: 15
+			 */
+			name: string;
+			/** The handle or DID of the repo to copy from. */
+			source: At.Identifier;
+			/** The alias to save the Bluemoji to in the current logged-in user's repo. */
+			renameTo?: string;
+		}
+		interface Output {
+			item: BlueMojiCollectionItem.ItemView;
+			uri: At.ResourceUri;
+		}
+		interface Errors {
+			EmojiNotFound: {};
+			DestinationExists: {};
+		}
+	}
+
+	namespace BlueMojiPacksDefs {
+		interface PackItemView {
+			[Brand.Type]?: 'blue.moji.packs.defs#packItemView';
+			subject: BlueMojiCollectionItem.ItemView;
+			uri: At.ResourceUri;
+		}
+		interface PackView {
+			[Brand.Type]?: 'blue.moji.packs.defs#packView';
+			cid: At.Cid;
+			creator: AppBskyActorDefs.ProfileView;
+			indexedAt: string;
+			/**
+			 * Minimum string length: 1 \
+			 * Maximum string length: 64
+			 */
+			name: string;
+			uri: At.ResourceUri;
+			avatar?: At.GenericUri;
+			/**
+			 * Maximum string length: 3000 \
+			 * Maximum grapheme length: 300
+			 */
+			description?: string;
+			descriptionFacets?: AppBskyRichtextFacet.Main[];
+			labels?: ComAtprotoLabelDefs.Label[];
+			/** Minimum: 0 */
+			packItemCount?: number;
+			viewer?: PackViewerState;
+		}
+		interface PackViewBasic {
+			[Brand.Type]?: 'blue.moji.packs.defs#packViewBasic';
+			cid: At.Cid;
+			/**
+			 * Minimum string length: 1 \
+			 * Maximum string length: 64
+			 */
+			name: string;
+			uri: At.ResourceUri;
+			avatar?: At.GenericUri;
+			/**
+			 * Maximum string length: 3000 \
+			 * Maximum grapheme length: 300
+			 */
+			description?: string;
+			descriptionFacets?: BlueMojiRichtextFacet.Main[];
+			indexedAt?: string;
+			/** Minimum: 0 */
+			itemCount?: number;
+			labels?: ComAtprotoLabelDefs.Label[];
+			viewer?: PackViewerState;
+		}
+		interface PackViewerState {
+			[Brand.Type]?: 'blue.moji.packs.defs#packViewerState';
+			savedToCollection?: boolean;
+		}
+	}
+
+	/** Get a list of Bluemoji packs created by the actor. */
+	namespace BlueMojiPacksGetActorPacks {
+		interface Params {
+			actor: At.Identifier;
+			cursor?: string;
+			/**
+			 * Minimum: 1 \
+			 * Maximum: 100
+			 * @default 50
+			 */
+			limit?: number;
+		}
+		type Input = undefined;
+		interface Output {
+			packs: BlueMojiPacksDefs.PackViewBasic[];
+			cursor?: string;
+		}
+	}
+
+	/** Gets a 'view' (with additional context) of a specified pack. */
+	namespace BlueMojiPacksGetPack {
+		interface Params {
+			/** Reference (AT-URI) of the pack record to hydrate. */
+			pack: At.ResourceUri;
+			cursor?: string;
+			/**
+			 * Minimum: 1 \
+			 * Maximum: 100
+			 * @default 50
+			 */
+			limit?: number;
+		}
+		type Input = undefined;
+		interface Output {
+			items: BlueMojiPacksDefs.PackItemView[];
+			pack: BlueMojiPacksDefs.PackView;
+			cursor?: string;
+		}
+	}
+
+	/** Get views for a list of Bluemoji packs. */
+	namespace BlueMojiPacksGetPacks {
+		interface Params {
+			/** Maximum array length: 25 */
+			uris: At.ResourceUri[];
+		}
+		type Input = undefined;
+		interface Output {
+			packs: BlueMojiPacksDefs.PackViewBasic[];
+		}
+	}
+
+	namespace BlueMojiPacksPack {
+		/** A shareable Bluemoji pack */
+		interface Record {
+			$type: 'blue.moji.packs.pack';
+			createdAt: string;
+			/**
+			 * Minimum string length: 1 \
+			 * Maximum string length: 64
+			 */
+			name: string;
+			/** @default false */
+			adultOnly?: boolean;
+			/**
+			 * Maximum string length: 3000 \
+			 * Maximum grapheme length: 300
+			 */
+			description?: string;
+			descriptionFacets?: BlueMojiRichtextFacet.Main[];
+			icon?: At.Blob;
+			/** Self-label values for this emoji. Effectively content warnings. */
+			labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
+		}
+	}
+
+	namespace BlueMojiPacksPackitem {
+		/** Record representing a Bluemoji's inclusion in a specific pack. The AppView will ignore duplicate item records. */
+		interface Record {
+			$type: 'blue.moji.packs.packitem';
+			createdAt: string;
+			/** Reference (AT-URI) to the pack record (blue.moji.packs.pack). */
+			pack: At.ResourceUri;
+			/** Reference (AT-URI) to the Bluemoji item record (blue.moji.collection.item). */
+			subject: At.ResourceUri;
+		}
+	}
+
+	namespace BlueMojiRichtextFacet {
+		interface Main {
+			[Brand.Type]?: 'blue.moji.richtext.facet';
+			/** DID of the user posting the Bluemoji */
+			did: string;
+			formats: Brand.Union<Formats_v0>;
+			/** Name of the Bluemoji in :emoji: format */
+			name: string;
+			/** @default false */
+			adultOnly?: boolean;
+			alt?: string;
+			/** Self-label values for this emoji. Effectively content warnings. */
+			labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
+		}
+		/** On the facet, only the CID is provided as this can be combined with the DID to create CDN URLs for non-animated blobs. For APNG and dotLottie, raw Bytes are served and require a com.atproto.repo.getRecord roundtrip on render so are marked with a boolean */
+		interface Formats_v0 {
+			[Brand.Type]?: 'blue.moji.richtext.facet#formats_v0';
+			/** @default false */
+			apng_128?: boolean;
+			gif_128?: At.Cid;
+			/** @default false */
+			lottie?: boolean;
+			png_128?: At.Cid;
+			webp_128?: At.Cid;
+		}
+	}
+
+	interface Records {
+		'blue.moji.collection.item': BlueMojiCollectionItem.Record;
+		'blue.moji.packs.pack': BlueMojiPacksPack.Record;
+		'blue.moji.packs.packitem': BlueMojiPacksPackitem.Record;
+	}
+
+	interface Queries {
+		'blue.moji.collection.getItem': {
+			params: BlueMojiCollectionGetItem.Params;
+			/** @deprecated */
+			output: BlueMojiCollectionGetItem.Output;
+			response: { json: BlueMojiCollectionGetItem.Output };
+		};
+		'blue.moji.collection.listCollection': {
+			params: BlueMojiCollectionListCollection.Params;
+			/** @deprecated */
+			output: BlueMojiCollectionListCollection.Output;
+			response: { json: BlueMojiCollectionListCollection.Output };
+		};
+		'blue.moji.packs.getActorPacks': {
+			params: BlueMojiPacksGetActorPacks.Params;
+			/** @deprecated */
+			output: BlueMojiPacksGetActorPacks.Output;
+			response: { json: BlueMojiPacksGetActorPacks.Output };
+		};
+		'blue.moji.packs.getPack': {
+			params: BlueMojiPacksGetPack.Params;
+			/** @deprecated */
+			output: BlueMojiPacksGetPack.Output;
+			response: { json: BlueMojiPacksGetPack.Output };
+		};
+		'blue.moji.packs.getPacks': {
+			params: BlueMojiPacksGetPacks.Params;
+			/** @deprecated */
+			output: BlueMojiPacksGetPacks.Output;
+			response: { json: BlueMojiPacksGetPacks.Output };
+		};
+	}
+
+	interface Procedures {
+		'blue.moji.collection.putItem': {
+			input: BlueMojiCollectionPutItem.Input;
+			/** @deprecated */
+			output: BlueMojiCollectionPutItem.Output;
+			response: { json: BlueMojiCollectionPutItem.Output };
+		};
+		'blue.moji.collection.saveToCollection': {
+			input: BlueMojiCollectionSaveToCollection.Input;
+			/** @deprecated */
+			output: BlueMojiCollectionSaveToCollection.Output;
+			response: { json: BlueMojiCollectionSaveToCollection.Output };
+		};
+	}
+}

package/package.json

@@ -1,26 +1,30 @@
 {
   "type": "module",
   "name": "@atcute/bluemoji",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Bluemoji type definitions for atcute",
   "license": "MIT",
   "repository": {
-    "url": "https://codeberg.org/mary-ext/atcute"
+    "url": "https://github.com/mary-ext/atcute",
+    "directory": "packages/definitions/bluemoji"
   },
   "files": [
-    "dist/"
+    "dist/",
+    "lib/",
+    "!lib/**/*.bench.ts",
+    "!lib/**/*.test.ts"
   ],
   "exports": {
     "./lexicons": "./dist/lexicons.js"
   },
   "peerDependencies": {
-    "@atcute/bluesky": "^1.0.0",
-    "@atcute/client": "^1.0.0 || ^2.0.0"
+    "@atcute/bluesky": "^2.0.0",
+    "@atcute/client": "^3.0.0"
   },
   "devDependencies": {
-    "@atcute/bluesky": "^1.0.6",
-    "@atcute/client": "^2.0.0",
-    "@atcute/lex-cli": "^1.0.0"
+    "@atcute/client": "^3.0.0",
+    "@atcute/lex-cli": "^1.1.0",
+    "@atcute/bluesky": "^2.0.0"
   },
   "scripts": {
     "build": "tsc",