about summary refs log tree commit diff
path: root/src/types/bsky/index.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/types/bsky/index.ts')
-rw-r--r--src/types/bsky/index.ts51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/types/bsky/index.ts b/src/types/bsky/index.ts
new file mode 100644
index 000000000..d5acbdbb5
--- /dev/null
+++ b/src/types/bsky/index.ts
@@ -0,0 +1,51 @@
+import {ValidationResult} from '@atproto/lexicon'
+
+export * as post from '#/types/bsky/post'
+export * as profile from '#/types/bsky/profile'
+export * as starterPack from '#/types/bsky/starterPack'
+
+/**
+ * Fast type checking without full schema validation, for use with data we
+ * trust, or for non-critical path use cases. Why? Our SDK's `is*` identity
+ * utils do not assert the type of the entire object, only the `$type` string.
+ *
+ * For full validation of the object schema, use the `validate` export from
+ * this file.
+ *
+ * Usage:
+ * ```ts
+ * import * as bsky from '#/types/bsky'
+ *
+ * if (bsky.dangerousIsType<AppBskyFeedPost.Record>(item, AppBskyFeedPost.isRecord)) {
+ *   // `item` has type `$Typed<AppBskyFeedPost.Record>` here
+ * }
+ * ```
+ */
+export function dangerousIsType<R extends {$type?: string}>(
+  record: unknown,
+  identity: <V>(v: V) => v is V & {$type: NonNullable<R['$type']>},
+): record is R {
+  return identity(record)
+}
+
+/**
+ * Fully validates the object schema, which has a performance cost.
+ *
+ * For faster checks with data we trust, like that from our app view, use the
+ * `dangerousIsType` export from this same file.
+ *
+ * Usage:
+ * ```ts
+ * import * as bsky from '#/types/bsky'
+ *
+ * if (bsky.validate(item, AppBskyFeedPost.validateRecord)) {
+ *   // `item` has type `$Typed<AppBskyFeedPost.Record>` here
+ * }
+ * ```
+ */
+export function validate<R extends {$type?: string}>(
+  record: unknown,
+  validator: (v: unknown) => ValidationResult<R>,
+): record is R {
+  return validator(record).success
+}