@atcute/bluemoji 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/dist/lexicons.d.ts +197 -48
  2. package/package.json +2 -2
@@ -28,14 +28,19 @@ declare module '@atcute/client/lexicons' {
28
28
  descriptionFacets?: AppBskyRichtextFacet.Main[];
29
29
  labels?: ComAtprotoLabelDefs.Label[];
30
30
  }
31
- interface ItemView {
32
- [Brand.Type]?: 'blue.moji.collection.defs#itemView';
33
- assets: BlueMojiCollectionItem.Formats_v0;
31
+ }
32
+ /** Get a single emoji from a repository. Requires auth. */
33
+ namespace BlueMojiCollectionGetItem {
34
+ interface Params {
35
+ /** The Bluemoji alias/rkey. */
34
36
  name: string;
35
- /** @default false */
36
- adultOnly?: boolean;
37
- alt?: string;
38
- createdAt?: string;
37
+ /** The handle or DID of the repo. */
38
+ repo: string;
39
+ }
40
+ type Input = undefined;
41
+ interface Output {
42
+ item: BlueMojiCollectionItem.ItemView;
43
+ uri: At.Uri;
39
44
  }
40
45
  }
41
46
  namespace BlueMojiCollectionItem {
@@ -49,6 +54,11 @@ declare module '@atcute/client/lexicons' {
49
54
  adultOnly?: boolean;
50
55
  alt?: string;
51
56
  copyOf?: At.Uri;
57
+ /**
58
+ * Maximum string length: 1
59
+ * @default "◌"
60
+ */
61
+ fallbackText?: string;
52
62
  /** Self-label values for this emoji. Effectively content warnings. */
53
63
  labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
54
64
  }
@@ -65,29 +75,95 @@ declare module '@atcute/client/lexicons' {
65
75
  png_128?: Blob_v0;
66
76
  webp_128?: Blob_v0;
67
77
  }
78
+ interface ItemView {
79
+ [Brand.Type]?: 'blue.moji.collection.item#itemView';
80
+ formats: Formats_v0;
81
+ name: string;
82
+ /** @default false */
83
+ adultOnly?: boolean;
84
+ alt?: string;
85
+ createdAt?: string;
86
+ }
68
87
  }
69
- namespace BlueMojiPackDefs {
70
- interface BluemojiPackView {
71
- [Brand.Type]?: 'blue.moji.pack.defs#bluemojiPackView';
72
- cid: At.CID;
73
- creator: AppBskyActorDefs.ProfileViewBasic;
74
- indexedAt: string;
75
- record: unknown;
88
+ /** List a range of Bluemoji in a repository, matching a specific collection. Requires auth. */
89
+ namespace BlueMojiCollectionListCollection {
90
+ interface Params {
91
+ cursor?: string;
92
+ /**
93
+ * The number of records to return. \
94
+ * Minimum: 1 \
95
+ * Maximum: 100
96
+ * @default 50
97
+ */
98
+ limit?: number;
99
+ /** Flag to reverse the order of the returned records. */
100
+ reverse?: boolean;
101
+ }
102
+ type Input = undefined;
103
+ interface Output {
104
+ items: BlueMojiCollectionItem.ItemView[];
105
+ cursor?: string;
106
+ }
107
+ interface ItemView {
108
+ [Brand.Type]?: 'blue.moji.collection.listCollection#itemView';
109
+ record: BlueMojiCollectionItem.ItemView;
76
110
  uri: At.Uri;
77
- items?: ListViewBasic;
78
- labels?: ComAtprotoLabelDefs.Label[];
79
- /** Maximum array length: 12 */
80
- listItemsSample?: ListItemView[];
81
111
  }
82
- interface ListItemView {
83
- [Brand.Type]?: 'blue.moji.pack.defs#listItemView';
84
- subject: BlueMojiCollectionDefs.ItemView;
112
+ }
113
+ /** Write a Bluemoji record, creating or updating it as needed. Requires auth, implemented by AppView. */
114
+ namespace BlueMojiCollectionPutItem {
115
+ interface Params {
116
+ }
117
+ interface Input {
118
+ item: BlueMojiCollectionItem.ItemView;
119
+ /** The handle or DID of the repo (aka, current account). */
120
+ repo: string;
121
+ /**
122
+ * Can be set to 'false' to skip Lexicon schema validation of record data.
123
+ * @default true
124
+ */
125
+ validate?: boolean;
126
+ }
127
+ interface Output {
85
128
  uri: At.Uri;
86
129
  }
87
- interface ListView {
88
- [Brand.Type]?: 'blue.moji.pack.defs#listView';
130
+ interface Errors {
131
+ }
132
+ }
133
+ /** Copy a single emoji from another repo. Requires auth. */
134
+ namespace BlueMojiCollectionSaveToCollection {
135
+ interface Params {
136
+ }
137
+ interface Input {
138
+ /**
139
+ * The source Bluemoji name/rkey. \
140
+ * Maximum string length: 15
141
+ */
142
+ name: string;
143
+ /** The handle or DID of the repo to copy from. */
144
+ source: string;
145
+ /** The alias to save the Bluemoji to in the current logged-in user's repo. */
146
+ renameTo?: string;
147
+ }
148
+ interface Output {
149
+ item: BlueMojiCollectionItem.ItemView;
150
+ uri: At.Uri;
151
+ }
152
+ interface Errors {
153
+ EmojiNotFound: {};
154
+ DestinationExists: {};
155
+ }
156
+ }
157
+ namespace BlueMojiPacksDefs {
158
+ interface PackItemView {
159
+ [Brand.Type]?: 'blue.moji.packs.defs#packItemView';
160
+ subject: BlueMojiCollectionItem.ItemView;
161
+ uri: At.Uri;
162
+ }
163
+ interface PackView {
164
+ [Brand.Type]?: 'blue.moji.packs.defs#packView';
89
165
  cid: At.CID;
90
- creator: AppBskyActorDefs.ProfileViewBasic;
166
+ creator: AppBskyActorDefs.ProfileView;
91
167
  indexedAt: string;
92
168
  /**
93
169
  * Minimum string length: 1 \
@@ -104,10 +180,11 @@ declare module '@atcute/client/lexicons' {
104
180
  descriptionFacets?: AppBskyRichtextFacet.Main[];
105
181
  labels?: ComAtprotoLabelDefs.Label[];
106
182
  /** Minimum: 0 */
107
- listItemCount?: number;
183
+ packItemCount?: number;
184
+ viewer?: PackViewerState;
108
185
  }
109
- interface ListViewBasic {
110
- [Brand.Type]?: 'blue.moji.pack.defs#listViewBasic';
186
+ interface PackViewBasic {
187
+ [Brand.Type]?: 'blue.moji.packs.defs#packViewBasic';
111
188
  cid: At.CID;
112
189
  /**
113
190
  * Minimum string length: 1 \
@@ -116,36 +193,75 @@ declare module '@atcute/client/lexicons' {
116
193
  name: string;
117
194
  uri: At.Uri;
118
195
  avatar?: string;
196
+ /**
197
+ * Maximum string length: 3000 \
198
+ * Maximum grapheme length: 300
199
+ */
200
+ description?: string;
201
+ descriptionFacets?: BlueMojiRichtextFacet.Main[];
119
202
  indexedAt?: string;
120
- labels?: ComAtprotoLabelDefs.Label[];
121
203
  /** Minimum: 0 */
122
- listItemCount?: number;
204
+ itemCount?: number;
205
+ labels?: ComAtprotoLabelDefs.Label[];
206
+ viewer?: PackViewerState;
207
+ }
208
+ interface PackViewerState {
209
+ [Brand.Type]?: 'blue.moji.packs.defs#packViewerState';
210
+ savedToCollection?: boolean;
123
211
  }
124
212
  }
125
- /** Gets a view of a Bluemoji pack */
126
- namespace BlueMojiPackGetPack {
213
+ /** Get a list of Bluemoji packs created by the actor. */
214
+ namespace BlueMojiPacksGetActorPacks {
127
215
  interface Params {
128
- /** Reference (AT-URI) of the Bluemoji pack record */
129
- bluemojiPack: At.Uri;
216
+ actor: string;
217
+ cursor?: string;
218
+ /**
219
+ * Minimum: 1 \
220
+ * Maximum: 100
221
+ * @default 50
222
+ */
223
+ limit?: number;
130
224
  }
131
225
  type Input = undefined;
132
226
  interface Output {
133
- bluemojiPack: BlueMojiPackDefs.BluemojiPackView;
227
+ packs: BlueMojiPacksDefs.PackViewBasic[];
228
+ cursor?: string;
134
229
  }
135
230
  }
136
- namespace BlueMojiPackListitem {
137
- interface Record {
138
- createdAt: string;
139
- /** Reference (AT-URI) to the pack record (blue.moji.pack) */
140
- list: At.Uri;
141
- /** The emoji which is included in the pack */
142
- subject: BlueMojiCollectionDefs.ItemView;
231
+ /** Gets a 'view' (with additional context) of a specified pack. */
232
+ namespace BlueMojiPacksGetPack {
233
+ interface Params {
234
+ /** Reference (AT-URI) of the pack record to hydrate. */
235
+ pack: At.Uri;
236
+ cursor?: string;
237
+ /**
238
+ * Minimum: 1 \
239
+ * Maximum: 100
240
+ * @default 50
241
+ */
242
+ limit?: number;
243
+ }
244
+ type Input = undefined;
245
+ interface Output {
246
+ items: BlueMojiPacksDefs.PackItemView[];
247
+ pack: BlueMojiPacksDefs.PackView;
248
+ cursor?: string;
249
+ }
250
+ }
251
+ /** Get views for a list of Bluemoji packs. */
252
+ namespace BlueMojiPacksGetPacks {
253
+ interface Params {
254
+ /** Maximum array length: 25 */
255
+ uris: At.Uri[];
256
+ }
257
+ type Input = undefined;
258
+ interface Output {
259
+ packs: BlueMojiPacksDefs.PackViewBasic[];
143
260
  }
144
261
  }
145
- namespace BlueMojiPackRecord {
262
+ namespace BlueMojiPacksPack {
146
263
  interface Record {
147
264
  createdAt: string;
148
- items: BlueMojiCollectionDefs.ItemView[];
149
265
  /**
150
266
  * Minimum string length: 1 \
151
267
  * Maximum string length: 64
@@ -164,6 +280,15 @@ declare module '@atcute/client/lexicons' {
164
280
  labels?: Brand.Union<ComAtprotoLabelDefs.SelfLabels>;
165
281
  }
166
282
  }
283
+ namespace BlueMojiPacksPackitem {
284
+ interface Record {
285
+ createdAt: string;
286
+ /** Reference (AT-URI) to the pack record (blue.moji.packs.pack). */
287
+ pack: At.Uri;
288
+ /** Reference (AT-URI) to the Bluemoji item record (blue.moji.collection.item). */
289
+ subject: At.Uri;
290
+ }
291
+ }
167
292
  namespace BlueMojiRichtextFacet {
168
293
  interface Main {
169
294
  [Brand.Type]?: 'blue.moji.richtext.facet';
@@ -192,15 +317,39 @@ declare module '@atcute/client/lexicons' {
192
317
  }
193
318
  interface Records {
194
319
  'blue.moji.collection.item': BlueMojiCollectionItem.Record;
195
- 'blue.moji.pack.listitem': BlueMojiPackListitem.Record;
196
- 'blue.moji.pack.record': BlueMojiPackRecord.Record;
320
+ 'blue.moji.packs.pack': BlueMojiPacksPack.Record;
321
+ 'blue.moji.packs.packitem': BlueMojiPacksPackitem.Record;
197
322
  }
198
323
  interface Queries {
199
- 'blue.moji.pack.getPack': {
200
- params: BlueMojiPackGetPack.Params;
201
- output: BlueMojiPackGetPack.Output;
324
+ 'blue.moji.collection.getItem': {
325
+ params: BlueMojiCollectionGetItem.Params;
326
+ output: BlueMojiCollectionGetItem.Output;
327
+ };
328
+ 'blue.moji.collection.listCollection': {
329
+ params: BlueMojiCollectionListCollection.Params;
330
+ output: BlueMojiCollectionListCollection.Output;
331
+ };
332
+ 'blue.moji.packs.getActorPacks': {
333
+ params: BlueMojiPacksGetActorPacks.Params;
334
+ output: BlueMojiPacksGetActorPacks.Output;
335
+ };
336
+ 'blue.moji.packs.getPack': {
337
+ params: BlueMojiPacksGetPack.Params;
338
+ output: BlueMojiPacksGetPack.Output;
339
+ };
340
+ 'blue.moji.packs.getPacks': {
341
+ params: BlueMojiPacksGetPacks.Params;
342
+ output: BlueMojiPacksGetPacks.Output;
202
343
  };
203
344
  }
204
345
  interface Procedures {
346
+ 'blue.moji.collection.putItem': {
347
+ input: BlueMojiCollectionPutItem.Input;
348
+ output: BlueMojiCollectionPutItem.Output;
349
+ };
350
+ 'blue.moji.collection.saveToCollection': {
351
+ input: BlueMojiCollectionSaveToCollection.Input;
352
+ output: BlueMojiCollectionSaveToCollection.Output;
353
+ };
205
354
  }
206
355
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "type": "module",
3
3
  "name": "@atcute/bluemoji",
4
- "version": "1.0.0",
4
+ "version": "1.0.1",
5
5
  "description": "Bluemoji type definitions for atcute",
6
6
  "license": "MIT",
7
7
  "repository": {
@@ -18,7 +18,7 @@
18
18
  "@atcute/client": "^1.0.0"
19
19
  },
20
20
  "devDependencies": {
21
- "@atcute/bluesky": "^1.0.0",
21
+ "@atcute/bluesky": "^1.0.2",
22
22
  "@atcute/client": "^1.0.0",
23
23
  "@atcute/lex-cli": "^1.0.0"
24
24
  },