Skip to content

Commit 48ded3c

Browse files
authored
Merge pull request #34 from byte5digital/development
readme: update imports
2 parents 79a8b71 + f95e55d commit 48ded3c

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

README.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
<picture>
22
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-light.png">
3-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-dark.png?raw=true">
4-
<img alt="Assist for Payload" src="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-dark.png?raw=true">
3+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-dark.png">
4+
<img alt="Assist for Payload" src="https://raw.githubusercontent.com/byte5digital/payload-assist/master/.github/assets/gh-banner-light.png">
55
</picture>
6-
76
<div align="center" style="display: flex; flex-direction: row; justify-content: center; align-items: center; gap: 12px;">
87
<a href="https://www.npmjs.com/@byte5digital/payload-assist">
98
<picture>
@@ -35,9 +34,9 @@ Utilities to add guardrails, DTO tooling, and ergonomic rules to Payload CMS pro
3534
## Installation
3635

3736
```bash
38-
yarn add payload-assist
37+
yarn add @byte5digital/payload-assist
3938
# or
40-
npm install payload-assist
39+
npm install @byte5digital/payload-assist
4140
```
4241

4342
Peer deps: Payload v3+, Next v15+. Dependencies `class-transformer` and `reflect-metadata` are included in the package.
@@ -58,7 +57,7 @@ Peer deps: Payload v3+, Next v15+. Dependencies `class-transformer` and `reflect
5857
A comprehensive type for Payload collection access control that includes all available access control methods.
5958

6059
```ts
61-
import { AccessControl } from "payload-assist";
60+
import { AccessControl } from "@byte5digital/payload-assist";
6261

6362
export const MyCollection: CollectionConfig = {
6463
slug: "my-collection",
@@ -91,7 +90,7 @@ The main `payloadAssist` function initializes the library and validates your pay
9190

9291
```ts
9392
import { buildConfig } from "payload";
94-
import payloadAssist, { defaultConfig } from "payload-assist";
93+
import payloadAssist, { defaultConfig } from "@byte5digital/payload-assist";
9594

9695
export default buildConfig({
9796
// your Payload config
@@ -117,7 +116,7 @@ Define exactly what leaves your API by modeling responses as DTOs. Only explicit
117116
It is important that all DTOs extend the `Dto` class. The example below shows the usage with the default `transformAndValidate`.
118117

119118
```ts
120-
import { Dto, Expose, Type } from "payload-assist";
119+
import { Dto, Expose, Type } from "@byte5digital/payload-assist";
121120

122121
export class MediaResponse extends Dto {
123122
@Expose() url: string;
@@ -141,7 +140,7 @@ export class MyCollectionDto extends Dto {
141140
Transform any raw Payload doc into a DTO. By default `transformAndValidate` uses `class-transformer`, but it can be configured through the payloadAssist options.
142141

143142
```ts
144-
import { transformAndValidate } from "payload-assist";
143+
import { transformAndValidate } from "@byte5digital/payload-assist";
145144

146145
const payloadDoc = await getPayloadDoc();
147146
const dto = transformAndValidate(MyCollectionDto, payloadDoc);
@@ -155,7 +154,7 @@ Use `withResponse` to guarantee your endpoints return DTOs (and nothing else). I
155154

156155
```ts
157156
import payload from "payload";
158-
import { withResponse, transformAndValidate } from "payload-assist";
157+
import { withResponse, transformAndValidate } from "@byte5digital/payload-assist";
159158
import { MyDataDto } from "path/to/dtos";
160159

161160
export const MyCollection: CollectionConfig = {
@@ -195,7 +194,7 @@ So the order of the given DTOs should be: More specific first, default last.
195194
```ts
196195
// src/collections/MyCollection.ts
197196
import { CollectionConfig } from "payload/types";
198-
import { withDtoReadHook } from "payload-assist";
197+
import { withDtoReadHook } from "@byte5digital/payload-assist";
199198
import { MyCollectionDto, MyCollectionAdminDto } from "path/to/dtos";
200199

201200
export const MyCollection: CollectionConfig = {

0 commit comments

Comments
 (0)