@atproto/lexicon 0.2.2 → 0.3.0

package/dist/lexicons.d.ts

@@ -2,8 +2,8 @@ import { LexiconDoc, LexUserType, ValidationResult } from './types';
 export declare class Lexicons {
     docs: Map<string, LexiconDoc>;
     defs: Map<string, LexUserType>;
-    constructor(docs?: unknown[]);
-    add(doc: unknown): void;
+    constructor(docs?: LexiconDoc[]);
+    add(doc: LexiconDoc): void;
     remove(uri: string): void;
     get(uri: string): LexiconDoc | undefined;
     getDef(uri: string): LexUserType | undefined;

package/dist/types.d.ts

@@ -17472,8 +17472,8 @@ export declare const lexiconDoc: z.ZodEffects<z.ZodObject<{
         description?: string | undefined;
     }>>;
 }, "strict", z.ZodTypeAny, {
-    lexicon: 1;
     id: string;
+    lexicon: 1;
     defs: Record<string, {
         type: "bytes";
         description?: string | undefined;
@@ -18535,8 +18535,8 @@ export declare const lexiconDoc: z.ZodEffects<z.ZodObject<{
     revision?: number | undefined;
     description?: string | undefined;
 }, {
-    lexicon: 1;
     id: string;
+    lexicon: 1;
     defs: Record<string, {
         type: "bytes";
         description?: string | undefined;
@@ -19598,8 +19598,8 @@ export declare const lexiconDoc: z.ZodEffects<z.ZodObject<{
     revision?: number | undefined;
     description?: string | undefined;
 }>, {
-    lexicon: 1;
     id: string;
+    lexicon: 1;
     defs: Record<string, {
         type: "bytes";
         description?: string | undefined;
@@ -20661,8 +20661,8 @@ export declare const lexiconDoc: z.ZodEffects<z.ZodObject<{
     revision?: number | undefined;
     description?: string | undefined;
 }, {
-    lexicon: 1;
     id: string;
+    lexicon: 1;
     defs: Record<string, {
         type: "bytes";
         description?: string | undefined;
@@ -21737,11 +21737,7 @@ export declare const discriminatedObject: z.ZodObject<{
 }>;
 export declare type DiscriminatedObject = z.infer<typeof discriminatedObject>;
 export declare function isDiscriminatedObject(value: unknown): value is DiscriminatedObject;
-export declare class LexiconDocMalformedError extends Error {
-    schemaDef: unknown;
-    issues?: z.ZodIssue[] | undefined;
-    constructor(message: string, schemaDef: unknown, issues?: z.ZodIssue[] | undefined);
-}
+export declare function parseLexiconDoc(v: unknown): LexiconDoc;
 export declare type ValidationResult = {
     success: true;
     value: unknown;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atproto/lexicon",
-  "version": "0.2.2",
+  "version": "0.3.0",
   "license": "MIT",
   "description": "atproto Lexicon schema language library",
   "keywords": [
@@ -18,8 +18,8 @@
     "iso-datestring-validator": "^2.2.2",
     "multiformats": "^9.9.0",
     "zod": "^3.21.4",
-    "@atproto/common-web": "^0.2.1",
-    "@atproto/syntax": "^0.1.2"
+    "@atproto/common-web": "^0.2.3",
+    "@atproto/syntax": "^0.1.4"
   },
   "scripts": {
     "test": "jest",

package/src/lexicons.ts

@@ -1,12 +1,9 @@
-import { ZodError } from 'zod'
 import {
   LexiconDoc,
-  lexiconDoc,
   LexRecord,
   LexXrpcProcedure,
   LexXrpcQuery,
   LexUserType,
-  LexiconDocMalformedError,
   LexiconDefNotFoundError,
   InvalidLexiconError,
   ValidationResult,
@@ -32,7 +29,7 @@ export class Lexicons {
   docs: Map<string, LexiconDoc> = new Map()
   defs: Map<string, LexUserType> = new Map()
 
-  constructor(docs?: unknown[]) {
+  constructor(docs?: LexiconDoc[]) {
     if (docs?.length) {
       for (const doc of docs) {
         this.add(doc)
@@ -43,24 +40,8 @@ export class Lexicons {
   /**
    * Add a lexicon doc.
    */
-  add(doc: unknown): void {
-    try {
-      lexiconDoc.parse(doc)
-    } catch (e) {
-      if (e instanceof ZodError) {
-        throw new LexiconDocMalformedError(
-          `Failed to parse schema definition ${
-            (doc as Record<string, string>).id
-          }`,
-          doc,
-          e.issues,
-        )
-      } else {
-        throw e
-      }
-    }
-    const validatedDoc = doc as LexiconDoc
-    const uri = toLexUri(validatedDoc.id)
+  add(doc: LexiconDoc): void {
+    const uri = toLexUri(doc.id)
     if (this.docs.has(uri)) {
       throw new Error(`${uri} has already been registered`)
     }
@@ -68,10 +49,10 @@ export class Lexicons {
     // WARNING
     // mutates the object
     // -prf
-    resolveRefUris(validatedDoc, uri)
+    resolveRefUris(doc, uri)
 
-    this.docs.set(uri, validatedDoc)
-    for (const [defUri, def] of iterDefs(validatedDoc)) {
+    this.docs.set(uri, doc)
+    for (const [defUri, def] of iterDefs(doc)) {
       this.defs.set(defUri, def)
     }
   }

package/src/types.ts

@@ -415,16 +415,9 @@ export function isDiscriminatedObject(
   return discriminatedObject.safeParse(value).success
 }
 
-export class LexiconDocMalformedError extends Error {
-  constructor(
-    message: string,
-    public schemaDef: unknown,
-    public issues?: z.ZodIssue[],
-  ) {
-    super(message)
-    this.schemaDef = schemaDef
-    this.issues = issues
-  }
+export function parseLexiconDoc(v: unknown): LexiconDoc {
+  lexiconDoc.parse(v)
+  return v as LexiconDoc
 }
 
 export type ValidationResult =

package/tests/_scaffolds/lexicons.ts

@@ -1,4 +1,6 @@
-export default [
+import { LexiconDoc } from '../../src/index'
+
+const lexicons: LexiconDoc[] = [
   {
     lexicon: 1,
     id: 'com.example.kitchenSink',
@@ -521,3 +523,5 @@ export default [
     },
   },
 ]
+
+export default lexicons

package/tests/general.test.ts

@@ -1,5 +1,5 @@
 import { CID } from 'multiformats/cid'
-import { lexiconDoc, Lexicons } from '../src/index'
+import { LexiconDoc, Lexicons, parseLexiconDoc } from '../src/index'
 import LexiconDocs from './_scaffolds/lexicons'
 
 describe('Lexicons collection', () => {
@@ -97,7 +97,7 @@ describe('General validation', () => {
       },
     }
     expect(() => {
-      lexiconDoc.parse(schema)
+      parseLexiconDoc(schema)
     }).toThrow('Required field \\"foo\\" not defined')
   })
   it('fails when unknown fields are present', () => {
@@ -113,11 +113,11 @@ describe('General validation', () => {
     }
 
     expect(() => {
-      lexiconDoc.parse(schema)
+      parseLexiconDoc(schema)
     }).toThrow("Unrecognized key(s) in object: 'foo'")
   })
   it('fails lexicon parsing when uri is invalid', () => {
-    const schema = {
+    const schema: LexiconDoc = {
       lexicon: 1,
       id: 'com.example.invalidUri',
       defs: {
@@ -135,7 +135,7 @@ describe('General validation', () => {
     }).toThrow('Uri can only have one hash segment')
   })
   it('fails validation when ref uri has multiple hash segments', () => {
-    const schema = {
+    const schema: LexiconDoc = {
       lexicon: 1,
       id: 'com.example.invalidUri',
       defs: {
@@ -168,7 +168,7 @@ describe('General validation', () => {
     }).toThrow('Uri can only have one hash segment')
   })
   it('union handles both implicit and explicit #main', () => {
-    const schemas = [
+    const schemas: LexiconDoc[] = [
       {
         lexicon: 1,
         id: 'com.example.implicitMain',

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2022-2023 Bluesky PBC
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.