Add ulid schema (#318)

Effect-TS · Jul 6, 2023 · 0c6cc97 · 0c6cc97
1 parent 4dc31df
commit 0c6cc97
Show file tree

Hide file tree

Showing 8 changed files with 75 additions and 7 deletions.
diff --git a/.changeset/cold-masks-sit.md b/.changeset/cold-masks-sit.md
@@ -0,0 +1,5 @@
+---
+"@effect/schema": minor
+---
+
+Add schema for [ULID](https://github.com/ulid/spec)
diff --git a/README.md b/README.md
@@ -433,6 +433,7 @@ S.never;
 
 S.json;
 S.UUID;
+S.ULID;
 ```
 
 ## Literals

diff --git a/docs/modules/Schema.ts.md b/docs/modules/Schema.ts.md
@@ -80,6 +80,7 @@ Added in v1.0.0
 - [constructors](#constructors)
   - [JsonNumber](#jsonnumber)
   - [UUID](#uuid)
+  - [ULID](#ulid)
   - [chunkFromSelf](#chunkfromself)
   - [enums](#enums)
   - [instanceOf](#instanceof)
@@ -129,7 +130,7 @@ Added in v1.0.0
   - [nonNaN](#nonnan)
   - [nonNegative](#nonnegative)
   - [nonPositive](#nonpositive)
-  - [numberFromString](#numberfromstring)
+  - [numberFromString](#numberfromstring-1)
   - [positive](#positive)
 - [option](#option-1)
   - [optionFromNullable](#optionfromnullable)
@@ -163,7 +164,7 @@ Added in v1.0.0
   - [nonEmpty](#nonempty)
   - [pattern](#pattern)
   - [startsWith](#startswith)
-  - [trim](#trim)
+  - [trim](#trim-1)
   - [trimmed](#trimmed)
 - [type id](#type-id)
   - [BetweenBigintTypeId](#betweenbiginttypeid)
@@ -202,6 +203,7 @@ Added in v1.0.0
   - [StartsWithTypeId](#startswithtypeid)
   - [TrimmedTypeId](#trimmedtypeid)
   - [UUIDTypeId](#uuidtypeid)
+  - [ULIDTypeId](#ulidtypeid)
   - [ValidDateTypeId](#validdatetypeid)
 - [utils](#utils)
   - [FromOptionalKeys (type alias)](#fromoptionalkeys-type-alias)
@@ -1078,6 +1080,16 @@ export declare const UUID: Schema<string, string>
 
 Added in v1.0.0
 
+## ULID
+
+**Signature**
+
+```ts
+export declare const ULID: Schema<string, string>
+```
+
+Added in v1.0.0
+
 ## chunkFromSelf
 
 **Signature**
@@ -2367,6 +2379,16 @@ export declare const UUIDTypeId: '@effect/schema/UUIDTypeId'
 
 Added in v1.0.0
 
+## ULIDTypeId
+
+**Signature**
+
+```ts
+export declare const ULIDTypeId: '@effect/schema/ULIDTypeId'
+```
+
+Added in v1.0.0
+
 ## ValidDateTypeId
 
 **Signature**

diff --git a/package.json b/package.json
@@ -107,6 +107,6 @@
   "dependencies": {
     "@effect/data": "^0.12.10",
     "@effect/io": "^0.29.0",
-    "fast-check": "^3.10.0"
+    "fast-check": "^3.11.0"
   }
 }
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/src/Schema.ts b/src/Schema.ts
@@ -2751,6 +2751,27 @@ export const UUID: Schema<string> = pipe(
   })
 )
 
+/**
+ * @category type id
+ * @since 1.0.0
+ */
+export const ULIDTypeId = "@effect/schema/ULIDTypeId"
+
+const ulidRegex = /^[0-7][0-9A-HJKMNP-TV-Z]{25}$/i
+
+/**
+ * @category constructors
+ * @since 1.0.0
+ */
+export const ULID: Schema<string> = pipe(
+  string,
+  pattern(ulidRegex, {
+    typeId: ULIDTypeId,
+    title: "ULID",
+    arbitrary: (): Arbitrary<string> => (fc) => fc.ulid()
+  })
+)
+
 /**
  * @category string
  * @since 1.0.0

diff --git a/test/Schema.ts b/test/Schema.ts
@@ -44,6 +44,7 @@ describe.concurrent("Schema", () => {
     expect(S.EndsWithTypeId).exist
     expect(S.IncludesTypeId).exist
     expect(S.UUIDTypeId).exist
+    expect(S.ULIDTypeId).exist
 
     expect(S.nullable).exist
 

diff --git a/test/data/filter/ULID.ts b/test/data/filter/ULID.ts
@@ -0,0 +1,18 @@
+import * as S from "@effect/schema/Schema"
+import * as Util from "@effect/schema/test/util"
+
+describe.concurrent("ULID", () => {
+  it("property tests", () => {
+    Util.roundtrip(S.ULID)
+  })
+
+  it("Decoder", async () => {
+    const schema = S.ULID
+    await Util.expectParseSuccess(schema, "01H4PGGGJVN2DKP2K1H7EH996V")
+    await Util.expectParseFailure(
+      schema,
+      "",
+      `Expected ULID, actual ""`
+    )
+  })
+})