@bhofstaetter/payloadcms-repository 0.1.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # payload-repository
 
-Opinionated repository and query object wrapper around Payload's Local API.
+Opinionated repository and operations object wrapper around Payload's Local API.
 
 ## Installation
 
@@ -12,16 +12,16 @@ npm install @bhofstaetter/payloadcms-repository
 
 Pass your generated Payload `Config` type as the first type argument to get full type safety on fields, select, and return types.
 
-### CollectionQuery
+### CollectionOperations
 
-Extend `CollectionQuery` to encapsulate domain-specific query logic for a collection:
+Extend `CollectionOperations` to encapsulate domain-specific operations logic for a collection:
 
 ```ts
 import type {BasePayload} from 'payload';
 import type {Config} from '@/payload-types';
-import {CollectionQuery} from '@bhofstaetter/payloadcms-repository';
+import {CollectionOperations} from '@bhofstaetter/payloadcms-repository';
 
-class PostsQuery extends CollectionQuery<Config, 'posts'> {
+class PostsOperations extends CollectionOperations<Config, 'posts'> {
     constructor(payload: BasePayload) {
         super(payload, 'posts');
     }
@@ -52,23 +52,23 @@ class PostsQuery extends CollectionQuery<Config, 'posts'> {
 }
 
 // Usage
-const postsQuery = new PostsQuery(payload);
+const postsOperations = new PostsOperations(payload);
 
-const post = await postsQuery.create('Hello World');
-const published = await postsQuery.findPublished();
-await postsQuery.publish(post.id);
+const post = await postsOperations.create('Hello World');
+const published = await postsOperations.findPublished();
+await postsOperations.publish(post.id);
 ```
 
-### GlobalQuery
+### GlobalOperations
 
-Extend `GlobalQuery` to encapsulate domain-specific query logic for a global:
+Extend `GlobalOperations` to encapsulate domain-specific operations logic for a global:
 
 ```ts
 import type {BasePayload} from 'payload';
 import type {Config} from '@/payload-types';
-import {GlobalQuery} from '@bhofstaetter/payloadcms-repository';
+import {GlobalOperations} from '@bhofstaetter/payloadcms-repository';
 
-class SettingsQuery extends GlobalQuery<Config, 'settings'> {
+class SettingsOperations extends GlobalOperations<Config, 'settings'> {
     constructor(payload: BasePayload) {
         super(payload, 'settings');
     }
@@ -83,10 +83,10 @@ class SettingsQuery extends GlobalQuery<Config, 'settings'> {
 }
 
 // Usage
-const settingsQuery = new SettingsQuery(payload);
+const settingsOperations = new SettingsOperations(payload);
 
-const settings = await settingsQuery.get();
-await settingsQuery.setSiteTitle('My Site');
+const settings = await settingsOperations.get();
+await settingsOperations.setSiteTitle('My Site');
 ```
 
 ## License

package/dist/collection/{CollectionQuery.d.ts → CollectionOperations.d.ts}

@@ -1,7 +1,7 @@
 import type { BasePayload, CollectionSlug } from 'payload';
-import type { AnyCollectionConfig } from '@/types';
+import type { AnyCollectionConfig } from '../types';
 import { CollectionRepository } from './CollectionRepository';
-export declare abstract class CollectionQuery<TConfig extends AnyCollectionConfig, TSlug extends CollectionSlug> {
+export declare abstract class CollectionOperations<TConfig extends AnyCollectionConfig, TSlug extends CollectionSlug> {
     protected readonly repository: CollectionRepository<TConfig, TSlug>;
     protected constructor(payload: BasePayload, collectionSlug: TSlug);
 }

package/dist/collection/{CollectionQuery.js → CollectionOperations.js}

@@ -1,5 +1,5 @@
 import { CollectionRepository } from './CollectionRepository';
-export class CollectionQuery {
+export class CollectionOperations {
     repository;
     constructor(payload, collectionSlug) {
         this.repository = new CollectionRepository(payload, collectionSlug);

package/dist/collection/CollectionRepository.d.ts

@@ -1,6 +1,6 @@
 import type { BasePayload, BulkOperationResult, CollectionSlug, DataFromCollectionSlug, PaginatedDistinctDocs, PaginatedDocs, RequiredDataFromCollectionSlug, SelectType, TransformCollectionWithSelect, TypeWithVersion, Where } from 'payload';
 import type { DeepPartial } from 'ts-essentials';
-import type { AnyCollectionConfig, DbId } from '@/types';
+import type { AnyCollectionConfig, DbId } from '../types';
 export declare class CollectionRepository<TConfig extends AnyCollectionConfig, TSlug extends CollectionSlug> {
     protected readonly payload: BasePayload;
     protected readonly collectionSlug: TSlug;

package/dist/global/{GlobalQuery.d.ts → GlobalOperations.d.ts}

@@ -1,7 +1,7 @@
 import type { BasePayload, GlobalSlug } from 'payload';
-import type { AnyGlobalConfig } from '@/types';
+import type { AnyGlobalConfig } from '../types';
 import { GlobalRepository } from './GlobalRepository';
-export declare abstract class GlobalQuery<TConfig extends AnyGlobalConfig, TSlug extends GlobalSlug> {
+export declare abstract class GlobalOperations<TConfig extends AnyGlobalConfig, TSlug extends GlobalSlug> {
     protected readonly repository: GlobalRepository<TConfig, TSlug>;
     protected constructor(payload: BasePayload, globalSlug: TSlug);
 }

package/dist/global/{GlobalQuery.js → GlobalOperations.js}

@@ -1,5 +1,5 @@
 import { GlobalRepository } from './GlobalRepository';
-export class GlobalQuery {
+export class GlobalOperations {
     repository;
     constructor(payload, globalSlug) {
         this.repository = new GlobalRepository(payload, globalSlug);

package/dist/global/GlobalRepository.d.ts

@@ -1,6 +1,6 @@
 import type { BasePayload, DataFromGlobalSlug, GlobalSlug, PaginatedDocs, SelectType, TransformGlobalWithSelect, TypeWithVersion } from 'payload';
 import type { DeepPartial } from 'ts-essentials';
-import type { AnyGlobalConfig, DbId } from '@/types';
+import type { AnyGlobalConfig, DbId } from '../types';
 export declare class GlobalRepository<TConfig extends AnyGlobalConfig, TSlug extends GlobalSlug> {
     protected readonly payload: BasePayload;
     protected readonly globalSlug: TSlug;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-export { CollectionQuery } from './collection/CollectionQuery';
+export { CollectionOperations } from './collection/CollectionOperations';
 export { CollectionRepository } from './collection/CollectionRepository';
-export { GlobalQuery } from './global/GlobalQuery';
+export { GlobalOperations } from './global/GlobalOperations';
 export { GlobalRepository } from './global/GlobalRepository';
 export type { AnyCollectionConfig, AnyGlobalConfig, DbId } from './types.js';

package/dist/index.js

@@ -1,4 +1,4 @@
-export { CollectionQuery } from './collection/CollectionQuery';
+export { CollectionOperations } from './collection/CollectionOperations';
 export { CollectionRepository } from './collection/CollectionRepository';
-export { GlobalQuery } from './global/GlobalQuery';
+export { GlobalOperations } from './global/GlobalOperations';
 export { GlobalRepository } from './global/GlobalRepository';

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@bhofstaetter/payloadcms-repository",
-    "version": "0.1.0",
-    "description": "Opinionated repository and query object wrapper around Payload's local API.",
+    "version": "1.0.1",
+    "description": "Opinionated repository and operations object wrapper around Payload's Local API.",
     "license": "MIT",
     "author": "Benedikt Hofstätter",
     "homepage": "https://github.com/bhofstaetter/payloadcms-repository",
@@ -29,23 +29,26 @@
         }
     },
     "scripts": {
-        "build": "tsc -p tsconfig.build.json",
+        "build": "rm -rf dist && tsc -p tsconfig.build.json && tsc-alias -p tsconfig.build.json",
         "typecheck": "tsc",
         "lint": "biome check",
         "lint:fix": "biome check --fix",
-        "prepublishOnly": "npm run lint && npm run typecheck && npm run build"
+        "test": "vitest run",
+        "prepublishOnly": "npm run lint && npm run typecheck && npm run test && npm run build"
     },
     "peerDependencies": {
         "payload": ">=3",
         "ts-essentials": ">=10"
     },
     "devDependencies": {
-        "payload": "^3.78.0",
+        "@bhofstaetter/payloadcms-it-helper": "^1.0.0",
+        "@biomejs/biome": "2.4.4",
         "@payloadcms/db-postgres": "^3.78.0",
+        "@testcontainers/postgresql": "^11.11.0",
+        "payload": "^3.78.0",
         "ts-essentials": "^10.0.0",
+        "tsc-alias": "^1.8.16",
         "typescript": "^5",
-        "@biomejs/biome": "2.4.4",
-        "@testcontainers/postgresql": "^11.11.0",
         "vite-tsconfig-paths": "^6.1.1",
         "vitest": "^4.0.18"
     },