@stratum-hq/core 1.5.0 → 1.5.1

package/README.md

@@ -1,6 +1,8 @@
 # @stratum-hq/core
 
-Shared foundation for all [Stratum](https://github.com/stratum-hq/Stratum) packages — TypeScript types, Zod validation schemas, error classes, utility functions, and constants. Every other Stratum package depends on it.
+Shared foundation for all [Stratum](https://github.com/stratum-hq/Stratum) packages: TypeScript types, Zod validation schemas, error classes, utility functions, and constants. Every other Stratum package depends on it.
+
+Read the documentation at [docs.stratum-hq.org/packages/core](https://docs.stratum-hq.org/packages/core/).
 
 ## Installation
 
@@ -27,7 +29,7 @@ import {
 IsolationStrategy.SHARED_RLS; // "SHARED_RLS"
 PermissionMode.LOCKED;        // "LOCKED"
 
-// Zod schemas — validate untrusted input
+// Zod schemas: validate untrusted input
 SlugSchema.parse("acme_corp"); // passes
 SlugSchema.parse("INVALID");   // throws ZodError
 
@@ -44,12 +46,12 @@ try {
 
 ## What's Exported
 
-- **Types** — `TenantNode`, `TenantContext`, `ResolvedConfigEntry`, `ResolvedPermission`, `CreateTenantInput`, `SetConfigInput`, `AuditEntry`, `ConsentRecord`, `Region`, `AbacPolicy`, and more.
-- **Enums** — `IsolationStrategy` (`SHARED_RLS`, `SCHEMA_PER_TENANT`, `DB_PER_TENANT`), `PermissionMode` (`LOCKED`, `INHERITED`, `DELEGATED`), `RevocationMode` (`CASCADE`, `SOFT`, `PERMANENT`), `TenantStatus`.
-- **Zod schemas** — `SlugSchema`, `UUIDSchema`, `PaginationSchema`, `CreateTenantInputSchema`, `SetConfigInputSchema`, `CreatePermissionInputSchema`, `AuditLogQuerySchema`, and their input types.
-- **Ancestry utilities** — `buildAncestryPath`, `parseAncestryPath`, `getDepth`, `isAncestorOf`, `isDescendantOf`, `getAncestorIds`.
-- **Errors** — `StratumError` plus `TenantNotFoundError`, `ConfigLockedError`, `PermissionRevocationDeniedError`, `IsolationViolationError`, `UnauthorizedError`, `ForbiddenError`, and others.
-- **Constants** — `MAX_SLUG_LENGTH` (63), `DEFAULT_CACHE_TTL_MS`, `DEFAULT_PAGE_SIZE`, `MAX_PAGE_SIZE`, `API_KEY_PREFIX`, `TENANT_HEADER`.
+- **Types**: `TenantNode`, `TenantContext`, `ResolvedConfigEntry`, `ResolvedPermission`, `CreateTenantInput`, `SetConfigInput`, `AuditEntry`, `ConsentRecord`, `Region`, `AbacPolicy`, and more.
+- **Enums**: `IsolationStrategy` (`SHARED_RLS`, `SCHEMA_PER_TENANT`, `DB_PER_TENANT`), `PermissionMode` (`LOCKED`, `INHERITED`, `DELEGATED`), `RevocationMode` (`CASCADE`, `SOFT`, `PERMANENT`), `TenantStatus`.
+- **Zod schemas**: `SlugSchema`, `UUIDSchema`, `PaginationSchema`, `CreateTenantInputSchema`, `SetConfigInputSchema`, `CreatePermissionInputSchema`, `AuditLogQuerySchema`, and their input types.
+- **Ancestry utilities**: `buildAncestryPath`, `parseAncestryPath`, `getDepth`, `isAncestorOf`, `isDescendantOf`, `getAncestorIds`.
+- **Errors**: `StratumError` plus `TenantNotFoundError`, `ConfigLockedError`, `PermissionRevocationDeniedError`, `IsolationViolationError`, `UnauthorizedError`, `ForbiddenError`, and others.
+- **Constants**: `MAX_SLUG_LENGTH` (63), `DEFAULT_CACHE_TTL_MS`, `DEFAULT_PAGE_SIZE`, `MAX_PAGE_SIZE`, `API_KEY_PREFIX`, `TENANT_HEADER`.
 
 ## Links
 

package/dist/types/usage.d.ts

@@ -3,7 +3,7 @@ import { z } from "zod";
  * Input to record a single usage event for a tenant.
  *
  * `quantity` defaults to 1 (one countable unit) and must be a non-negative
- * integer — metering counts up; credits / adjustments are out of scope.
+ * integer: metering counts up; credits / adjustments are out of scope.
  * `occurred_at` is when the usage happened (ISO 8601); it defaults to insert
  * time and is the timestamp aggregation windows filter on, so a back-dated
  * import still lands in the right billing window. `idempotency_key`, when

package/dist/types/usage.js

@@ -7,7 +7,7 @@ const timestamptz_js_1 = require("../utils/timestamptz.js");
  * Input to record a single usage event for a tenant.
  *
  * `quantity` defaults to 1 (one countable unit) and must be a non-negative
- * integer — metering counts up; credits / adjustments are out of scope.
+ * integer: metering counts up; credits / adjustments are out of scope.
  * `occurred_at` is when the usage happened (ISO 8601); it defaults to insert
  * time and is the timestamp aggregation windows filter on, so a back-dated
  * import still lands in the right billing window. `idempotency_key`, when

package/dist/utils/ancestry.d.ts

@@ -50,7 +50,7 @@ export declare function appendToPath(parentPath: string, childId: string): strin
  */
 export declare function getAncestorIds(path: string): string[];
 /**
- * Get the last ID in an ancestry path — the tenant's direct parent
+ * Get the last ID in an ancestry path: the tenant's direct parent
  * (ancestry paths exclude self). Returns null for a root tenant ("/").
  */
 export declare function getSelfId(path: string): string | null;

package/dist/utils/ancestry.js

@@ -92,7 +92,7 @@ function getAncestorIds(path) {
     return parseAncestryPath(path);
 }
 /**
- * Get the last ID in an ancestry path — the tenant's direct parent
+ * Get the last ID in an ancestry path: the tenant's direct parent
  * (ancestry paths exclude self). Returns null for a root tenant ("/").
  */
 function getSelfId(path) {

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@stratum-hq/core",
-  "version": "1.5.0",
-  "description": "Stratum shared types, utilities, and validation schemas",
+  "version": "1.5.1",
+  "description": "Shared types, Zod schemas, and errors for the Stratum multi-tenancy packages",
   "keywords": [
     "multi-tenancy",
+    "multitenancy",
     "multi-tenant",
     "saas",
     "tenant",
+    "tenant-isolation",
+    "zod",
     "typescript",
     "validation",
     "schemas",
@@ -45,7 +48,7 @@
   },
   "license": "MIT",
   "author": "Christian Crank",
-  "homepage": "https://github.com/stratum-hq/Stratum/tree/main/packages/core#readme",
+  "homepage": "https://docs.stratum-hq.org/packages/core/",
   "bugs": "https://github.com/stratum-hq/Stratum/issues",
   "engines": {
     "node": ">=20.0.0"