From deaf0d18cba2db8f23458abaffa32bc956b8da11 Mon Sep 17 00:00:00 2001 From: connyscode Date: Tue, 30 Sep 2025 11:49:43 +0200 Subject: [PATCH 1/2] readme: update imports --- README.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index f4787cb..fbe314a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ - - Assist for Payload + + Assist for Payload
@@ -35,9 +35,9 @@ Utilities to add guardrails, DTO tooling, and ergonomic rules to Payload CMS pro ## Installation ```bash -yarn add payload-assist +yarn add @byte5digital/payload-assist # or -npm install payload-assist +npm install @byte5digital/payload-assist ``` Peer deps: Payload v3+, Next v15+. Dependencies `class-transformer` and `reflect-metadata` are included in the package. @@ -58,7 +58,7 @@ Peer deps: Payload v3+, Next v15+. Dependencies `class-transformer` and `reflect A comprehensive type for Payload collection access control that includes all available access control methods. ```ts -import { AccessControl } from "payload-assist"; +import { AccessControl } from "@byte5digital/payload-assist"; export const MyCollection: CollectionConfig = { slug: "my-collection", @@ -91,7 +91,7 @@ The main `payloadAssist` function initializes the library and validates your pay ```ts import { buildConfig } from "payload"; -import payloadAssist, { defaultConfig } from "payload-assist"; +import payloadAssist, { defaultConfig } from "@byte5digital/payload-assist"; export default buildConfig({ // your Payload config @@ -117,7 +117,7 @@ Define exactly what leaves your API by modeling responses as DTOs. Only explicit It is important that all DTOs extend the `Dto` class. The example below shows the usage with the default `transformAndValidate`. ```ts -import { Dto, Expose, Type } from "payload-assist"; +import { Dto, Expose, Type } from "@byte5digital/payload-assist"; export class MediaResponse extends Dto { @Expose() url: string; @@ -141,7 +141,7 @@ export class MyCollectionDto extends Dto { Transform any raw Payload doc into a DTO. By default `transformAndValidate` uses `class-transformer`, but it can be configured through the payloadAssist options. ```ts -import { transformAndValidate } from "payload-assist"; +import { transformAndValidate } from "@byte5digital/payload-assist"; const payloadDoc = await getPayloadDoc(); const dto = transformAndValidate(MyCollectionDto, payloadDoc); @@ -155,7 +155,7 @@ Use `withResponse` to guarantee your endpoints return DTOs (and nothing else). I ```ts import payload from "payload"; -import { withResponse, transformAndValidate } from "payload-assist"; +import { withResponse, transformAndValidate } from "@byte5digital/payload-assist"; import { MyDataDto } from "path/to/dtos"; export const MyCollection: CollectionConfig = { @@ -195,7 +195,7 @@ So the order of the given DTOs should be: More specific first, default last. ```ts // src/collections/MyCollection.ts import { CollectionConfig } from "payload/types"; -import { withDtoReadHook } from "payload-assist"; +import { withDtoReadHook } from "@byte5digital/payload-assist"; import { MyCollectionDto, MyCollectionAdminDto } from "path/to/dtos"; export const MyCollection: CollectionConfig = { From f95e55d8b614686b5c6cef9e35b02d05ef059d7e Mon Sep 17 00:00:00 2001 From: connyscode Date: Tue, 30 Sep 2025 13:08:58 +0200 Subject: [PATCH 2/2] fix: readme --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index fbe314a..be306cb 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,6 @@ Assist for Payload -