@wordrhyme/db 0.1.0-alpha.14

package/README.md

@@ -0,0 +1,66 @@
+# @wordrhyme/db
+
+Shared database types and Zod schemas for WordRhyme.
+
+## Installation
+
+```bash
+pnpm add @wordrhyme/db
+```
+
+## Usage
+
+### Zod Schemas (for AutoCrudTable)
+
+```typescript
+import { selectI18nLanguageSchema } from '@wordrhyme/db/zod';
+import { AutoCrudTable, useAutoCrudResource } from '@wordrhyme/auto-crud';
+import { trpc } from '@/lib/trpc';
+
+function LanguagesPage() {
+  const resource = useAutoCrudResource({
+    router: trpc.i18n.languages,
+    schema: selectI18nLanguageSchema,
+  });
+
+  return (
+    <AutoCrudTable
+      schema={selectI18nLanguageSchema}
+      resource={resource}
+      fields={{
+        id: { hidden: true },
+        organizationId: { hidden: true },
+      }}
+    />
+  );
+}
+```
+
+### Types
+
+```typescript
+import type { I18nLanguage, I18nMessage } from '@wordrhyme/db';
+
+function processLanguage(lang: I18nLanguage) {
+  console.log(lang.locale, lang.name);
+}
+```
+
+## Exports
+
+| Path | Description |
+|------|-------------|
+| `@wordrhyme/db` | Types and all Zod schemas |
+| `@wordrhyme/db/zod` | Zod schemas only |
+| `@wordrhyme/db/schema` | Drizzle schemas (reserved) |
+
+## Available Schemas
+
+### i18n
+
+- `selectI18nLanguageSchema` - For displaying languages
+- `insertI18nLanguageSchema` - For creating languages (with validation)
+- `updateI18nLanguageSchema` - For updating languages
+- `selectI18nMessageSchema` - For displaying messages
+- `insertI18nMessageSchema` - For creating messages
+- `updateI18nMessageSchema` - For updating messages

package/dist/acl-policy.d.ts

@@ -0,0 +1,86 @@
+/**
+ * ACL Policy Registry
+ *
+ * Allows plugin developers to declare default ACL policies per table via `pluginTable(..., { acl })`.
+ * ScopedDb reads from this registry when inserting rows without explicit aclTags.
+ *
+ * Priority chain (highest → lowest):
+ * 1. Admin override (via Settings, cached in-memory per org+table)
+ * 2. Developer declaration (via `pluginTable(..., { acl: { defaultPolicy } })`)
+ * 3. System fallback ("creator")
+ *
+ * @example
+ * ```ts
+ * import { pluginTable } from '@wordrhyme/db/plugin';
+ *
+ * export const shopProducts = pluginTable('products', { ... }, {
+ *   acl: { defaultPolicy: ['org'] },
+ * }); // org-visible by default
+ * ```
+ */
+/**
+ * Default ACL policy for a table
+ *
+ * Principals:
+ * - 'org':         Organization-visible  → ['org:{orgId}']
+ * - 'creator':     Creator-only          → ['user:{userId}']  (system default)
+ * - 'admin':       Org admins            → ['role:owner', 'role:admin', 'role:super-admin']
+ * - 'public':      Public                → ['public:all']
+ *
+ * Policies can be composed as an array, e.g.:
+ * - ['org', 'creator']
+ * - ['admin', 'creator']
+ */
+export type DefaultAclPolicyPrincipal = "org" | "creator" | "admin" | "public";
+export type DefaultAclPolicy = DefaultAclPolicyPrincipal | readonly DefaultAclPolicyPrincipal[];
+export declare function setDeveloperAclPolicy(tableName: string, policy: DefaultAclPolicy): void;
+/**
+ * Set an admin override for a table's default ACL policy.
+ *
+ * Called by the platform's settings service when an admin configures
+ * a table-level ACL policy override via the admin UI.
+ */
+export declare function setAclPolicyOverride(tableName: string, organizationId: string, policy: DefaultAclPolicy): void;
+/**
+ * Remove an admin override.
+ */
+export declare function removeAclPolicyOverride(tableName: string, organizationId: string): void;
+/**
+ * Batch-load admin overrides (called on startup or cache refresh).
+ *
+ * @param overrides - Array of { tableName, organizationId, policy }
+ */
+export declare function loadAclPolicyOverrides(overrides: Array<{
+    tableName: string;
+    organizationId: string;
+    policy: DefaultAclPolicy;
+}>): void;
+/**
+ * Clear all admin overrides (for testing or full refresh).
+ */
+export declare function clearAclPolicyOverrides(): void;
+/**
+ * Get the effective ACL policy for a table + org combination.
+ *
+ * Priority: admin override > developer declaration > system default ('creator')
+ *
+ * This is a **sync** function — safe to call from wrapInsert's values() builder.
+ */
+export declare function getEffectiveAclPolicy(tableName: string, organizationId?: string): readonly DefaultAclPolicyPrincipal[];
+/**
+ * Resolve a policy to concrete aclTags.
+ */
+export declare function resolveAclTags(policy: DefaultAclPolicy, ctx: {
+    userId: string | undefined;
+    organizationId: string | undefined;
+}): string[];
+/**
+ * Get all registered developer policies (for admin UI / debugging).
+ */
+export declare function getRegisteredAclPolicies(): Record<string, readonly DefaultAclPolicyPrincipal[]>;
+/**
+ * Settings key pattern for admin overrides.
+ * Used by the settings router to store/retrieve overrides.
+ */
+export declare const ACL_POLICY_SETTINGS_PREFIX = "lbac.defaultAclPolicy.";
+//# sourceMappingURL=acl-policy.d.ts.map

package/dist/acl-policy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"acl-policy.d.ts","sourceRoot":"","sources":["../src/acl-policy.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAMH;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,yBAAyB,GAAG,KAAK,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,CAAC;AAC/E,MAAM,MAAM,gBAAgB,GAAG,yBAAyB,GAAG,SAAS,yBAAyB,EAAE,CAAC;AAyChG,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAEvF;AAYD;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAE9G;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,IAAI,CAEvF;AAED;;;;GAIG;AACH,wBAAgB,sBAAsB,CAClC,SAAS,EAAE,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,cAAc,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,gBAAgB,CAAA;CAAE,CAAC,GAC1F,IAAI,CAIN;AAED;;GAEG;AACH,wBAAgB,uBAAuB,IAAI,IAAI,CAE9C;AAMD;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,yBAAyB,EAAE,CAatH;AAED;;GAEG;AACH,wBAAgB,cAAc,CAC1B,MAAM,EAAE,gBAAgB,EACxB,GAAG,EAAE;IAAE,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAAC,cAAc,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GACxE,MAAM,EAAE,CAsBV;AAMD;;GAEG;AACH,wBAAgB,wBAAwB,IAAI,MAAM,CAAC,MAAM,EAAE,SAAS,yBAAyB,EAAE,CAAC,CAE/F;AAED;;;GAGG;AACH,eAAO,MAAM,0BAA0B,2BAA2B,CAAC"}