@xnetjs/data 2.5.0 → 3.0.0

package/README.md

@@ -2,6 +2,11 @@
 
 Schema system, NodeStore, and Yjs CRDT engine for xNet. This is the central data package -- it defines how structured data and rich text documents are created, stored, and synced.
 
+> **Alpha software.** xNet is released but early: this package is on npm and
+> usable today, but its API can change between releases, sometimes without a
+> migration path. Pin your version. See the
+> [project README](https://github.com/crs48/xNet#readme) for what alpha means here.
+
 > **Status:** Mixed
 > Stable entrypoints: `@xnetjs/data/schema`, `@xnetjs/data/store`, `@xnetjs/data/updates`, `@xnetjs/data/awareness`
 > Experimental entrypoints: `@xnetjs/data/database`, `@xnetjs/data/auth`

package/dist/auth/index.d.ts

@@ -1,12 +1,12 @@
 import { AllowExpr, DenyExpr, AuthExpression, AndExpr, OrExpr, NotExpr, PublicExpr, AuthenticatedExpr, CreatorRoleResolver, PropertyRoleResolver, RelationRoleResolver, MembershipRoleResolver, AuthorizationDefinition, SerializedAuthorization, SerializedAuthExpression, DID } from '@xnetjs/core';
 export { AUTH_ACTIONS, AllowExpr, AndExpr, AuthAction, AuthCheckInput, AuthDecision, AuthDenyReason, AuthExpression, AuthTrace, AuthTraceStep, AuthenticatedExpr, AuthorizationDefinition, CreatorRoleResolver, DenyExpr, MembershipRoleResolver, NotExpr, OrExpr, PolicyEvaluator, PropertyRoleResolver, PublicExpr, RelationRoleResolver, RoleRefExpr, RoleResolver, SerializedAuthExpression, SerializedAuthorization, SerializedRoleResolver } from '@xnetjs/core';
-import { y as PropertyDefinition, a as Schema, h as NodeState, S as SchemaIRI } from '../types-Z9dUzbDF.js';
-export { H as DEFAULT_OFFLINE_POLICY, z as GRANT_SCHEMA_IRI, $ as Grant, x as GrantIndex, F as GrantIndexOptions, E as GrantIndexStore, _ as GrantInput, B as GrantNode, Q as GrantRateLimiter, V as GrantRateLimiterOptions, O as OfflineAuthPolicy, K as RevocationConfig, R as RevocationConsistency, W as StoreAuth, e as StoreAuthAPI, a0 as StoreAuthError, a1 as StoreAuthErrorCode, Z as StoreAuthKeyManager, X as StoreAuthOptions, Y as StoreAuthStore, A as isGrantActive, J as mergeOfflinePolicy } from '../types-Z9dUzbDF.js';
-export { A as ActionPermission, m as AuthDecisionEvent, D as DecisionCache, g as DecisionCacheOptions, c as DefaultPolicyEvaluator, j as DefaultPolicyEvaluatorOptions, a as DefaultRoleResolver, i as DefaultRoleResolverOptions, k as DefinedSchemaLike, G as GrantExpirationCleaner, o as GrantExpirationCleanerOptions, n as GrantExpirationStore, H as HubPolicy, N as NodeStoreReader, P as PermissionMatrix, l as RevalidationEvent, R as RoleSummary, S as SchemaRegistryReader, b as buildPermissionMatrix, f as createPolicyEvaluator, d as describeRoleResolver, e as evaluateExpression, h as hubActionsForSpaceRole, s as schemaToHubPolicy } from '../grant-expiration-cleaner-CTsW0hvU.js';
+import { F as PropertyDefinition, a as Schema, h as NodeState, S as SchemaIRI } from '../types-gws1tSf-.js';
+export { a_ as DEFAULT_OFFLINE_POLICY, aY as GRANT_SCHEMA_IRI, b4 as Grant, x as GrantIndex, b9 as GrantIndexOptions, b8 as GrantIndexStore, b3 as GrantInput, b7 as GrantNode, aX as GrantRateLimiter, bc as GrantRateLimiterOptions, O as OfflineAuthPolicy, bb as RevocationConfig, ba as RevocationConsistency, aW as StoreAuth, e as StoreAuthAPI, b5 as StoreAuthError, b6 as StoreAuthErrorCode, b2 as StoreAuthKeyManager, b0 as StoreAuthOptions, b1 as StoreAuthStore, aZ as isGrantActive, a$ as mergeOfflinePolicy } from '../types-gws1tSf-.js';
+export { A as ActionPermission, m as AuthDecisionEvent, b as DecisionCache, g as DecisionCacheOptions, D as DefaultPolicyEvaluator, j as DefaultPolicyEvaluatorOptions, a as DefaultRoleResolver, i as DefaultRoleResolverOptions, k as DefinedSchemaLike, G as GrantExpirationCleaner, o as GrantExpirationCleanerOptions, n as GrantExpirationStore, H as HubPolicy, N as NodeStoreReader, P as PermissionMatrix, l as RevalidationEvent, R as RoleSummary, S as SchemaRegistryReader, c as buildPermissionMatrix, f as createPolicyEvaluator, d as describeRoleResolver, e as evaluateExpression, h as hubActionsForSpaceRole, s as schemaToHubPolicy } from '../grant-expiration-cleaner-CRS9OyhV.js';
 import { PublicKeyResolver } from '@xnetjs/crypto';
 import '@xnetjs/sqlite';
 import '@xnetjs/sync';
-import '../registry-Dh4Kr3fo.js';
+import '../registry-C9IRLLeR.js';
 
 /**
  * Authorization expression builders for schema definitions.

package/dist/chunk-GJAOMEQO.js

@@ -0,0 +1,114 @@
+import {
+  spaceCascadeAuthorization
+} from "./chunk-RLRAWZJE.js";
+import {
+  checkbox,
+  created,
+  createdBy,
+  defineSchema,
+  number,
+  relation,
+  text
+} from "./chunk-NH6OLO3X.js";
+import {
+  allow,
+  role
+} from "./chunk-D4LUUZYD.js";
+
+// src/schema/schemas/course.ts
+var COURSE_SCHEMA_IRI = "xnet://xnet.fyi/Course@1.0.0";
+var LESSON_SCHEMA_IRI = "xnet://xnet.fyi/Lesson@1.0.0";
+var LESSON_PROGRESS_SCHEMA_IRI = "xnet://xnet.fyi/LessonProgress@1.0.0";
+var CourseSchema = defineSchema({
+  name: "Course",
+  namespace: "xnet://xnet.fyi/",
+  properties: {
+    title: text({ required: true, maxLength: 300 }),
+    description: text({ maxLength: 2e3 }),
+    space: relation({ target: "xnet://xnet.fyi/Space@1.0.0" }),
+    icon: text({ maxLength: 500 }),
+    /** Order among sibling courses — fractional index, code-unit compare. */
+    sortKey: text({ maxLength: 500 }),
+    /** Unpublished courses are visible to space admins only. */
+    published: checkbox({ default: false }),
+    createdAt: created(),
+    createdBy: createdBy()
+  },
+  document: void 0,
+  authorization: spaceCascadeAuthorization()
+});
+var LessonSchema = defineSchema({
+  name: "Lesson",
+  namespace: "xnet://xnet.fyi/",
+  properties: {
+    title: text({ required: true, maxLength: 300 }),
+    course: relation({ target: "xnet://xnet.fyi/Course@1.0.0", required: true }),
+    space: relation({ target: "xnet://xnet.fyi/Space@1.0.0" }),
+    /** Order within the course — fractional index. */
+    sortKey: text({ maxLength: 500 }),
+    /** Optional estimated minutes, shown as guidance, never as a timer. */
+    estimatedMinutes: number({ min: 0 }),
+    createdAt: created(),
+    createdBy: createdBy()
+  },
+  // Lesson bodies are documents, same editor surface as Page/Post.
+  document: "yjs",
+  authorization: spaceCascadeAuthorization()
+});
+var LessonProgressSchema = defineSchema({
+  name: "LessonProgress",
+  namespace: "xnet://xnet.fyi/",
+  properties: {
+    lesson: relation({ target: "xnet://xnet.fyi/Lesson@1.0.0", required: true }),
+    course: relation({ target: "xnet://xnet.fyi/Course@1.0.0" }),
+    space: relation({ target: "xnet://xnet.fyi/Space@1.0.0" }),
+    /** ms since epoch; absent = started but not finished. */
+    completedAt: number({}),
+    createdAt: created(),
+    createdBy: createdBy()
+  },
+  document: void 0,
+  // Written out rather than derived from the space cascade, because the whole
+  // point is that it does NOT cascade read to the membership.
+  authorization: {
+    roles: {
+      owner: role.creator(),
+      spaceOwner: role.relation("space", "spaceOwner"),
+      spaceAdmin: role.relation("space", "spaceAdmin"),
+      spaceMember: role.relation("space", "spaceMember")
+    },
+    actions: {
+      // Private by construction: the learner and the space's stewards, and
+      // nobody else. There is no membership-wide read of someone's progress.
+      read: allow("owner", "spaceOwner", "spaceAdmin"),
+      create: allow("spaceOwner", "spaceAdmin", "spaceMember"),
+      update: allow("owner"),
+      delete: allow("owner", "spaceOwner", "spaceAdmin"),
+      write: allow("owner"),
+      share: allow("owner")
+    }
+  }
+});
+function lessonProgressId(lessonId, learnerDid) {
+  return `lessonprogress:${lessonId}:${learnerDid}`;
+}
+var courseCompletion = (lessons, ownProgress) => {
+  const done = new Set(
+    ownProgress.filter((p) => typeof p.completedAt === "number" && p.completedAt > 0).map((p) => p.lesson)
+  );
+  return {
+    completed: lessons.filter((l) => done.has(l.id)).length,
+    total: lessons.length
+  };
+};
+
+export {
+  COURSE_SCHEMA_IRI,
+  LESSON_SCHEMA_IRI,
+  LESSON_PROGRESS_SCHEMA_IRI,
+  CourseSchema,
+  LessonSchema,
+  LessonProgressSchema,
+  lessonProgressId,
+  courseCompletion
+};

package/dist/chunk-KY62NUOI.js

@@ -0,0 +1,67 @@
+import {
+  spaceContributorAuthorization
+} from "./chunk-RLRAWZJE.js";
+import {
+  checkbox,
+  created,
+  createdBy,
+  defineSchema,
+  relation,
+  select,
+  text
+} from "./chunk-NH6OLO3X.js";
+
+// src/schema/schemas/post.ts
+var POST_SCHEMA_IRI = "xnet://xnet.fyi/Post@1.0.0";
+var PostSchema = defineSchema({
+  name: "Post",
+  namespace: "xnet://xnet.fyi/",
+  properties: {
+    /** Topic title — what the discussion is about. */
+    title: text({ required: true, maxLength: 300 }),
+    /** Canonical SECURITY home. A Post without a Space is a personal draft. */
+    space: relation({ target: "xnet://xnet.fyi/Space@1.0.0" }),
+    /**
+     * Optional grouping within a community — "Announcements", "Wins",
+     * "Questions". A plain label rather than a relation: communities rename
+     * and merge these constantly, and a Tag relation would make the common
+     * case (one host, five categories) a two-node write.
+     */
+    category: text({ maxLength: 80 }),
+    /**
+     * Pinned topics sort above the rest. This is the ONE ordering lever, and
+     * it is an explicit editorial act by a space admin — not an engagement
+     * score, and not computed from any behavioural signal.
+     */
+    pinned: checkbox({ default: false }),
+    /** Locked topics accept no new replies; existing ones stay readable. */
+    locked: checkbox({ default: false }),
+    /** Per-node visibility; `inherit` defers to the Space (exploration 0179). */
+    visibility: select({
+      options: [
+        { id: "inherit", name: "Inherit", color: "gray" },
+        { id: "private", name: "Private", color: "gray" },
+        { id: "unlisted", name: "Unlisted", color: "yellow" },
+        { id: "public", name: "Public", color: "green" }
+      ],
+      default: "inherit"
+    }),
+    createdAt: created(),
+    createdBy: createdBy()
+  },
+  // Rich body, same editor surface as Page (BlockNote over a Y.Doc).
+  document: "yjs",
+  authorization: spaceContributorAuthorization()
+});
+var comparePostsForFeed = (a, b) => {
+  const aPinned = a.pinned === true;
+  const bPinned = b.pinned === true;
+  if (aPinned !== bPinned) return aPinned ? -1 : 1;
+  return (b.createdAt ?? 0) - (a.createdAt ?? 0);
+};
+
+export {
+  POST_SCHEMA_IRI,
+  PostSchema,
+  comparePostsForFeed
+};