@ultimabase/soft-delete 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,12 @@
+# @ultimabase/soft-delete
+
+## 0.1.0
+
+### Minor Changes
+
+- 0e885c4: The first release: the kernel, its adapters, transports and plugins, the testing helpers and the starter.
+
+### Patch Changes
+
+- Updated dependencies [0e885c4]
+  - ultimabase@0.1.0

package/README.md

@@ -1,3 +1,5 @@
-# Temporary Holding Version
+# @ultimabase/soft-delete
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Soft delete for UltimaBase. A deleted row gets a `deletedAt` date and leaves every ordinary read; the model's trash still finds it, and restores it.
+
+Documentation: [Soft delete](https://ultimabase.dev/docs/soft-delete).

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import type { Field, Payload, PluginOf, PluginTypes, Queries, UseOf } from 'ultimabase';
+export interface SoftDeleteCommands<F> {
+    /** The deleted rows, under the model's read rule. */
+    readonly trash: Pick<Queries<F>, 'findMany' | 'findFirst' | 'findUnique' | 'count'>;
+    /** Brings a deleted row back, under the model's update rule. */
+    readonly restore: (this: void, args: {
+        readonly where: Unique<F>;
+    }, options?: Parameters<Queries<F>['count']>[1]) => Promise<Payload<F, {}>>;
+}
+type Unique<F> = Parameters<Queries<F>['findUnique']>[0]['where'];
+/** The soft delete plugin's types (D-57). */
+export interface SoftDelete extends PluginTypes {
+    readonly name: 'softDelete';
+    readonly addedFields: {
+        readonly deletedAt: Field<Date, {
+            readonly optional: true;
+        }>;
+    };
+    readonly commands: SoftDeleteCommands<this['fields']>;
+}
+export declare const softDelete: UseOf<SoftDelete>;
+export declare const softDeletePlugin: PluginOf<SoftDelete>;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACX,KAAK,EACL,OAAO,EACP,QAAQ,EACR,WAAW,EACX,OAAO,EACP,KAAK,EACL,MAAM,YAAY,CAAA;AAInB,MAAM,WAAW,kBAAkB,CAAC,CAAC;IACpC,qDAAqD;IACrD,QAAQ,CAAC,KAAK,EAAE,IAAI,CACnB,OAAO,CAAC,CAAC,CAAC,EACV,UAAU,GAAG,WAAW,GAAG,YAAY,GAAG,OAAO,CACjD,CAAA;IACD,gEAAgE;IAChE,QAAQ,CAAC,OAAO,EAAE,CACjB,IAAI,EAAE,IAAI,EACV,IAAI,EAAE;QAAE,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAA;KAAE,EACnC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,KACxC,OAAO,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;CAC5B;AAED,KAAK,MAAM,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAA;AAEjE,6CAA6C;AAC7C,MAAM,WAAW,UAAW,SAAQ,WAAW;IAC9C,QAAQ,CAAC,IAAI,EAAE,YAAY,CAAA;IAC3B,QAAQ,CAAC,WAAW,EAAE;QACrB,QAAQ,CAAC,SAAS,EAAE,KAAK,CAAC,IAAI,EAAE;YAAE,QAAQ,CAAC,QAAQ,EAAE,IAAI,CAAA;SAAE,CAAC,CAAA;KAC5D,CAAA;IACD,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;CACrD;AAoCD,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,UAAU,CAA4B,CAAA;AACrE,eAAO,MAAM,gBAAgB,EAAE,QAAQ,CAAC,UAAU,CACtB,CAAA"}

package/dist/index.js

@@ -0,0 +1,31 @@
+import { definePlugin, master } from 'ultimabase';
+import manifest from '../package.json' with { type: 'json' };
+const softDeleteDefinition = definePlugin({
+    name: 'softDelete',
+    manifest,
+    addedFields: (f) => ({
+        // Only Master dates a row: a caller deletes through the delete rule.
+        deletedAt: f.dateTime({ optional: true }).with({
+            access: { create: () => false, update: ({ value }) => value === null },
+        }),
+    }),
+    hooks: {
+        // A command reads the trash; every other query, the rows not deleted.
+        beforeFind: ({ where, command }) => where({ deletedAt: command === undefined ? null : { not: null } }),
+    },
+    // Runs after the `delete` access rule and the `beforeDelete` hooks.
+    redirect: {
+        delete: ({ where, queries }) => queries.update({ where, data: { deletedAt: new Date(Date.now()) } }, { as: master }),
+    },
+    commands: ({ queries }) => ({
+        trash: {
+            findMany: queries.findMany,
+            findFirst: queries.findFirst,
+            findUnique: queries.findUnique,
+            count: queries.count,
+        },
+        restore: ({ where }, options) => queries.update({ where, data: { deletedAt: null } }, options),
+    }),
+});
+export const softDelete = softDeleteDefinition.use;
+export const softDeletePlugin = softDeleteDefinition.plugin;

package/package.json

@@ -1,6 +1,42 @@
 {
   "name": "@ultimabase/soft-delete",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.0",
+  "description": "Soft delete for UltimaBase: deleted rows go to a trash and can be restored.",
+  "type": "module",
+  "license": "Apache-2.0",
+  "homepage": "https://ultimabase.dev/docs/soft-delete",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/MrEkinox/ultimabase.git",
+    "directory": "packages/soft-delete"
+  },
+  "engines": {
+    "node": ">=24.7.0"
+  },
+  "exports": {
+    ".": "./dist/index.js"
+  },
+  "files": [
+    "dist",
+    "src",
+    "!src/**/*.test.ts",
+    "!src/test"
+  ],
+  "scripts": {
+    "prepack": "rm -rf dist && yarn run -T tsc --project tsconfig.build.json"
+  },
+  "publishConfig": {
+    "exports": {
+      ".": "./dist/index.js"
+    }
+  },
+  "peerDependencies": {
+    "ultimabase": "^0.1.0"
+  },
+  "devDependencies": {
+    "@ultimabase/testing": "0.1.0",
+    "ultimabase": "0.1.0",
+    "vite": "8.3.4",
+    "vitest": "5.0.5"
+  }
 }

package/src/index.ts

@@ -0,0 +1,75 @@
+// Soft delete (D-17, D-89, D-96): a deleted row gets a `deletedAt` date and
+// leaves every ordinary read; `trash` reads it, `restore` brings it back.
+import type {
+	Field,
+	Payload,
+	PluginOf,
+	PluginTypes,
+	Queries,
+	UseOf,
+} from 'ultimabase'
+import { definePlugin, master } from 'ultimabase'
+import manifest from '../package.json' with { type: 'json' }
+
+export interface SoftDeleteCommands<F> {
+	/** The deleted rows, under the model's read rule. */
+	readonly trash: Pick<
+		Queries<F>,
+		'findMany' | 'findFirst' | 'findUnique' | 'count'
+	>
+	/** Brings a deleted row back, under the model's update rule. */
+	readonly restore: (
+		this: void,
+		args: { readonly where: Unique<F> },
+		options?: Parameters<Queries<F>['count']>[1],
+	) => Promise<Payload<F, {}>>
+}
+
+type Unique<F> = Parameters<Queries<F>['findUnique']>[0]['where']
+
+/** The soft delete plugin's types (D-57). */
+export interface SoftDelete extends PluginTypes {
+	readonly name: 'softDelete'
+	readonly addedFields: {
+		readonly deletedAt: Field<Date, { readonly optional: true }>
+	}
+	readonly commands: SoftDeleteCommands<this['fields']>
+}
+
+const softDeleteDefinition = definePlugin<SoftDelete>({
+	name: 'softDelete',
+	manifest,
+	addedFields: (f) => ({
+		// Only Master dates a row: a caller deletes through the delete rule.
+		deletedAt: f.dateTime({ optional: true }).with({
+			access: { create: () => false, update: ({ value }) => value === null },
+		}),
+	}),
+	hooks: {
+		// A command reads the trash; every other query, the rows not deleted.
+		beforeFind: ({ where, command }) =>
+			where({ deletedAt: command === undefined ? null : { not: null } }),
+	},
+	// Runs after the `delete` access rule and the `beforeDelete` hooks.
+	redirect: {
+		delete: ({ where, queries }) =>
+			queries.update(
+				{ where, data: { deletedAt: new Date(Date.now()) } },
+				{ as: master },
+			),
+	},
+	commands: ({ queries }) => ({
+		trash: {
+			findMany: queries.findMany,
+			findFirst: queries.findFirst,
+			findUnique: queries.findUnique,
+			count: queries.count,
+		},
+		restore: ({ where }, options) =>
+			queries.update({ where, data: { deletedAt: null } }, options),
+	}),
+})
+
+export const softDelete: UseOf<SoftDelete> = softDeleteDefinition.use
+export const softDeletePlugin: PluginOf<SoftDelete> =
+	softDeleteDefinition.plugin