feat!: v1.0.0 (#317)

Author: kettanaito

.github/FUNDING.yml

@@ -1,2 +1,2 @@
 github: mswjs
-open_collective: mswjs
+open_collective: mswjs

.github/workflows/ci.yml

@@ -4,35 +4,38 @@ on:
   push:
     branches: [main]
   pull_request:
-    branches: [main]
-
   workflow_dispatch:
 
 jobs:
-  build:
+  test:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
+
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.14.0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: pnpm install
 
       - name: Install browsers
-        run: yarn playwright install
-
-      - name: Environment (versions)
-        run: |
-          echo "node: $(node -v)"
-          echo "npm: $(npm -v)"
-          echo "typescript: $(npm ls typescript)"
-          echo "tsc: $(tsc -v)"
+        run: pnpm exec playwright install chromium --with-deps
 
       - name: Build
-        run: yarn build
+        run: pnpm build
+
+      - name: Tests (Node.js)
+        run: pnpm test:node
 
-      - name: Tests
-        run: yarn test
+      - name: Tests (browser)
+        run: pnpm test:browser
 
-      - name: Tests (typings)
-        run: yarn test:ts

.github/workflows/release.yml

@@ -3,32 +3,46 @@ name: release
 on:
   schedule:
     - cron: '0 23 * * *'
-
   workflow_dispatch:
 
 jobs:
-  release:
+  publish:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
           token: ${{ secrets.GH_ADMIN_TOKEN }}
 
-      - name: Setup Git
-        run: |
-          git config --local user.name "kettanaito"
-          git config --local user.email "[email protected]"
+      - name: Set up pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 9.14.0
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: 'pnpm'
 
       - name: Install dependencies
-        run: yarn install --frozen-lockfile
+        run: pnpm install
 
       - name: Install browsers
-        run: yarn playwright install
+        run: pnpm exec playwright install chromium --with-deps
+
+      - name: Build
+        run: pnpm build
+
+      - name: Tests (Node.js)
+        run: pnpm test:node
+
+      - name: Tests (browser)
+        run: pnpm test:browser
 
-      - name: Release
-        run: yarn release
+      - name: Publish
+        run: pnpm publish
         env:
           GITHUB_TOKEN: ${{ secrets.GH_ADMIN_TOKEN }}
           NPM_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,3 +1,7 @@
+*.DS_Store
 node_modules
+build
 lib
-*.log
+dist
+test-results
+./tests/.tmp/**

.prettierrc renamed to .prettierrc.json

@@ -1,6 +1,6 @@
 {
   "semi": false,
-  "singleQuote": true,
   "arrowParens": "always",
-  "trailingComma": "all"
+  "trailingComma": "all",
+  "singleQuote": true
 }

.vscode/settings.json

@@ -0,0 +1,148 @@
+# Migrating
+
+## v0 → v1
+
+Version 1.0 is a huge overhaul of the library to address some of the long-standing design issues and missing features. Please take your time to read through the [updated README](./README.md) to get familiar with the new concepts and APIs.
+
+When migrating from v0.x.x, please consult the guide below regarding the breaking changes to the library.
+
+### Terminology
+
+A few changes in the terminology to consider to make this migration guide easier to parse:
+
+- Model → Collection;
+- Entry → Record;
+- Relationship → Relation.
+
+### Package name
+
+The library has been migrated to a new package name—`@msw/data`.
+
+```diff
+-npm i @mswjs/data
++npm i @msw/data
+```
+
+### Deprecated: `factory`
+
+The model factory has been deprecated in favor of granular collections of data.
+
+```diff
+-const db = factory({ user: {} })
++const users = new Collection({ schema })
+```
+
+### Describing data
+
+The proprietary syntax of describing data has been deprecated in favor of the [Standard Schema](https://standardschema.dev/) for describing your data.
+
+```diff
+-factory({
+-  firstName: () => 'John',
+-  lastName: () => 'Maverick'
+-})
++new Collection({
++  schema: z.object({
++    firstName: z.string(),
++    lastName: z.string()
++  })
++})
+```
+
+> Although the example above is using [Zod](https://zod.dev/), you can use any Standard Schema-compatible schema library.
+
+### Deprecated: `primaryKey`
+
+The concept of a primary key has been deprecated entirely. You do not have to provide primary keys when describing your collections. You can query records by any properties.
+
+### Default values
+
+You can provide default values to the properies of your collection using the respective syntax of your schema library of choice. For example, here's how you list default values in Zod:
+
+```ts
+const users = new Collection({
+  schema: z.object({
+    subscribed: z.boolean().default(false)
+  })
+})
+
+await users.create() // { subscribed: false }
+```
+
+### Deprecated: `nullable`
+
+The `nullable` utility has been deprecated. Use your schema library of choice to describe nullable properties.
+
+### Deprecated: operators
+
+Operators like `equals`, `in`, `lgt`, etc. have been deprecated in favor of _queries_. You can express conditions for your records via literal values as well as function predicates.
+
+```ts
+// Find the first user with "id" equal to 1.
+users.findFirst(q => q.where({ id: 1 }))
+
+// Find all users whose last name is longer than 5 letters.
+users.findMany(
+  q => q.where({ lastName: lastName => lastName.length > 5 })
+)
+```
+
+> Learn more about [Querying](./README.md#querying).
+
+### Relations
+
+The `oneOf` and `manyOf` utilities has been deprecated. Use the `.defineRelations()` method on your collections to define relations between collections.
+
+```ts
+const userSchema = z.object({
+  id: z.number(),
+  get posts() {
+    return z.array(postSchema)
+  }
+})
+const postSchema = z.object({
+  title: z.string(),
+  get author() {
+    return userSchema
+  }
+})
+
+const users = new Collection({ schema: userSchema })
+const posts = new Collection({ schema: postSchema })
+
+users.defineRelations(({ many }) => ({
+  posts: many(posts)
+}))
+
+posts.defineRelations(({ one }) => ({
+  author: one(users)
+}))
+```
+
+> Learn more about [Relations](./README.md#relations).
+
+### Collocated updates
+
+You can now collocate updates of owner and foreign records in a relation by simply changing the foreign record's values as a part of the owner update.
+
+```ts
+const posts = new Collection({ schema: postSchema })
+const revisions = new Collection({ schema: revisionSchema })
+
+posts.defineRelations(({ one }) => ({
+  revision: one(revisions)
+}))
+
+await posts.update(q => q.where({ id: 'post-1' }), {
+  data(post) {
+    post.title = 'Renamed post'
+    post.revision.updatedAt = Date.now()
+  }
+})
+```
+
+> The library will automatically translte the `updateAt` change of the reference revision into an implicit update.
+
+### Deprecated: `.toHandlers()`
+
+The `.toHandlers()` method has been deprecated. Generating request handlers is no longer a responsibility of this library. Instead, it should be possible via [Source](https://github.com/mswjs/source) (follow [this issue](https://github.com/mswjs/source/issues/80) for progress).