@objectstack/plugin-sharing 4.0.1

package/.turbo/turbo-build.log

@@ -0,0 +1,22 @@
+
+> @objectstack/plugin-sharing@4.0.1 build /home/runner/work/framework/framework/packages/plugins/plugin-sharing
+> tsup --config ../../../tsup.config.ts
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.1
+CLI Using tsup config: /home/runner/work/framework/framework/tsup.config.ts
+CLI Target: es2020
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+CJS dist/index.js     33.33 KB
+CJS dist/index.js.map 70.80 KB
+CJS ⚡️ Build success in 175ms
+ESM dist/index.mjs     31.83 KB
+ESM dist/index.mjs.map 70.78 KB
+ESM ⚡️ Build success in 189ms
+DTS Build start
+DTS ⚡️ Build success in 16945ms
+DTS dist/index.d.mts 11.90 KB
+DTS dist/index.d.ts  11.90 KB

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @objectstack/plugin-sharing
+
+## 4.0.1
+
+### Patch Changes
+
+- Updated dependencies [2108c30]
+- Updated dependencies [23db640]
+- Updated dependencies [5683206]
+- Updated dependencies [f0b3972]
+- Updated dependencies [0e63f2f]
+  - @objectstack/spec@4.1.0
+  - @objectstack/objectql@4.1.0
+  - @objectstack/core@4.1.0
+  - @objectstack/platform-objects@4.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute
+          must include a readable copy of the attribution notices
+          contained within such NOTICE file, excluding those notices
+          that do not pertain to any part of the Derivative Works,
+          in at least one of the following places: within a NOTICE
+          text file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with
+          the Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the
+          License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ObjectStack
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/index.d.mts

@@ -0,0 +1,290 @@
+export { SysRecordShare, SysSharingRule } from '@objectstack/platform-objects/security';
+export { SysDepartment, SysDepartmentMember } from '@objectstack/platform-objects/identity';
+import { ISharingService, SharingExecutionContext, GrantShareInput, RecordShare, ISharingRuleService, DefineSharingRuleInput, SharingRuleRow, SharingRuleEvaluationResult, ITeamGraphService, IDepartmentGraphService } from '@objectstack/spec/contracts';
+export { DefineSharingRuleInput, GrantShareInput, IDepartmentGraphService, ISharingRuleService, ISharingService, ITeamGraphService, RecordShare, ShareAccessLevel, ShareRecipientType, ShareSource, SharingExecutionContext, SharingRuleEvaluationResult, SharingRuleRecipientType, SharingRuleRow } from '@objectstack/spec/contracts';
+import { Plugin, PluginContext } from '@objectstack/core';
+import { EngineMiddleware } from '@objectstack/objectql';
+
+/**
+ * Shape of the data engine the service actually needs. Kept narrow so
+ * unit tests can pass an in-memory fake without depending on the full
+ * ObjectQL engine class.
+ */
+interface SharingEngine {
+    find(object: string, options?: any): Promise<any[]>;
+    findOne?(object: string, options?: any): Promise<any>;
+    insert(object: string, data: any, options?: any): Promise<any>;
+    update(object: string, idOrData: any, dataOrOptions?: any, options?: any): Promise<any>;
+    delete(object: string, options?: any): Promise<any>;
+    getSchema?(object: string): any | undefined;
+}
+interface SharingServiceOptions {
+    engine: SharingEngine;
+    /** Object names that bypass sharing — typically platform internals. */
+    bypassObjects?: string[];
+}
+/**
+ * Default `ISharingService` implementation.
+ *
+ * Stores every grant in `sys_record_share`. The plugin layer registers
+ * an engine middleware that calls `buildReadFilter` / `canEdit` so that
+ * neither this class nor its callers need to know about middleware
+ * plumbing.
+ */
+declare class SharingService implements ISharingService {
+    private readonly engine;
+    private readonly bypassObjects;
+    constructor(options: SharingServiceOptions);
+    /**
+     * Build a `FilterCondition` restricting `find` to records the caller
+     * may see. Returns `null` when no filter should be applied.
+     */
+    buildReadFilter(object: string, context: SharingExecutionContext): Promise<unknown | null>;
+    /**
+     * Return `true` if the caller may edit `(object, recordId)`. Always
+     * `true` for system context, public objects, and objects without an
+     * owner field.
+     */
+    canEdit(object: string, recordId: string, context: SharingExecutionContext): Promise<boolean>;
+    /**
+     * Upsert a share row. Returning the existing row when an identical
+     * grant already exists keeps the REST endpoint idempotent.
+     */
+    grant(input: GrantShareInput, context: SharingExecutionContext): Promise<RecordShare>;
+    /** Delete a share row by id. No-op when not found. */
+    revoke(shareId: string, _context: SharingExecutionContext): Promise<void>;
+    /** List share rows for `(object, recordId)`. */
+    listShares(object: string, recordId: string, _context: SharingExecutionContext): Promise<RecordShare[]>;
+    private shouldBypass;
+}
+
+interface SharingRuleServiceOptions {
+    engine: SharingEngine;
+    sharing: SharingService;
+    logger?: {
+        info?: Function;
+        warn?: Function;
+        error?: Function;
+        debug?: Function;
+    };
+}
+/**
+ * Default {@link ISharingRuleService} implementation.
+ *
+ * Stores rule definitions in `sys_sharing_rule` and materialises grants
+ * as `sys_record_share` rows with `source='rule'` and `source_id={ruleId}`
+ * so reconcile can diff old grants vs fresh evaluation results without
+ * touching manual / team-derived shares.
+ */
+declare class SharingRuleService implements ISharingRuleService {
+    private readonly engine;
+    private readonly sharing;
+    private readonly logger?;
+    constructor(opts: SharingRuleServiceOptions);
+    defineRule(input: DefineSharingRuleInput, context: SharingExecutionContext): Promise<SharingRuleRow>;
+    listRules(filter: {
+        object?: string;
+        activeOnly?: boolean;
+    }, context: SharingExecutionContext): Promise<SharingRuleRow[]>;
+    getRule(idOrName: string, context: SharingExecutionContext): Promise<SharingRuleRow | null>;
+    deleteRule(idOrName: string, context: SharingExecutionContext): Promise<void>;
+    evaluateRule(idOrName: string, context: SharingExecutionContext): Promise<SharingRuleEvaluationResult>;
+    evaluateAllForRecord(object: string, recordId: string, context: SharingExecutionContext): Promise<SharingRuleEvaluationResult[]>;
+    private findMatchingRecords;
+    private recordMatches;
+    private expandRecipient;
+    private reconcile;
+    private reconcileForRecord;
+    private purgeRuleGrants;
+}
+
+type Cache = {
+    expandUsers?: Map<string, string[]>;
+    expandRole?: Map<string, string[]>;
+    manager?: Map<string, string | null>;
+};
+interface TeamGraphOptions {
+    engine: SharingEngine;
+    /** Optional tenant scope; null means cross-tenant lookups. */
+    organizationId?: string | null;
+    /** Optional shared cache across one evaluator pass. */
+    cache?: Cache;
+}
+/**
+ * Default {@link ITeamGraphService} implementation backed by
+ * `sys_team` + `sys_team_member` (better-auth's flat collaboration
+ * grouping) plus `sys_member.role` for tenant role expansion.
+ *
+ * **This service does NOT walk a hierarchy.** Teams here are flat —
+ * the enterprise org chart lives in `sys_department` and is served by
+ * {@link DepartmentGraphService}.
+ *
+ * All queries elevate to {@link SYSTEM_CTX} since the graph is platform
+ * metadata; callers (sharing rule evaluator, approval engine) own their
+ * own enforcement.
+ */
+declare class TeamGraphService implements ITeamGraphService {
+    private readonly engine;
+    private readonly organizationId;
+    private readonly cache;
+    constructor(opts: TeamGraphOptions);
+    expandUsers(teamId: string): Promise<string[]>;
+    expandRoleUsers(roleName: string, organizationId?: string): Promise<string[]>;
+    managerOf(userId: string, _organizationId?: string): Promise<string | null>;
+}
+/**
+ * Convenience helper used by the sharing-rule evaluator + approval
+ * engine: expand an approver / recipient descriptor of the form
+ * `{type, value}` into a flat list of user IDs by routing to the
+ * appropriate graph service.
+ *
+ * `team` → flat team members (this service).
+ * `department` → recursive department members (delegated; requires a
+ *   {@link IDepartmentGraphService} instance passed in `opts.dept`).
+ * `role` → tenant role members.
+ * `manager` → submitter's manager via `record[value] ?? record.owner_id`.
+ * `field` → literal user id stored in `record[value]`.
+ * `user` → literal value.
+ * Anything else echoes `type:value` for back-compat with legacy
+ * substring-match approver flows.
+ */
+declare function expandPrincipal(input: {
+    type: string;
+    value: string;
+    record?: any;
+}, ctx: {
+    team: TeamGraphService;
+    dept?: {
+        expandUsers(id: string): Promise<string[]>;
+    };
+    organizationId?: string | null;
+}): Promise<string[]>;
+
+type DeptCache = {
+    descendants?: Map<string, string[]>;
+    expandUsers?: Map<string, string[]>;
+    head?: Map<string, string | null>;
+};
+interface DepartmentGraphOptions {
+    engine: SharingEngine;
+    /** Optional tenant scope; null means cross-tenant lookups. */
+    organizationId?: string | null;
+    /** Optional shared cache across one evaluator pass. */
+    cache?: DeptCache;
+    /**
+     * Optional team-graph instance to share role / manager lookups with —
+     * department graph proxies `managerOf` through so callers only need one
+     * service.
+     */
+    teamGraph?: TeamGraphService;
+}
+/**
+ * Default {@link IDepartmentGraphService} implementation.
+ *
+ * Walks `sys_department.parent_department_id` for hierarchy and
+ * `sys_department_member` for member expansion. Treats the optional
+ * `active` flag as a hard filter (inactive departments contribute no
+ * members and stop BFS descent into their subtrees).
+ *
+ * Reuses {@link TeamGraphService.managerOf} for user-level manager
+ * lookup so callers can use this single service in approval / sharing
+ * pipelines.
+ */
+declare class DepartmentGraphService implements IDepartmentGraphService {
+    private readonly engine;
+    private readonly organizationId;
+    private readonly cache;
+    private readonly teamGraph?;
+    constructor(opts: DepartmentGraphOptions);
+    descendants(departmentId: string): Promise<string[]>;
+    expandUsers(departmentId: string): Promise<string[]>;
+    headOf(departmentId: string): Promise<string | null>;
+    managerOf(userId: string, organizationId?: string): Promise<string | null>;
+    private orgScope;
+}
+
+declare const SHARING_RULE_HOOK_PACKAGE = "plugin-sharing:rules";
+interface MinimalEngine {
+    registerHook(event: string, handler: (ctx: any) => any | Promise<any>, options?: {
+        object?: string | string[];
+        priority?: number;
+        packageId?: string;
+    }): void;
+    unregisterHooksByPackage(packageId: string): number;
+}
+interface MinimalLogger {
+    info?: (msg: any, ...rest: any[]) => void;
+    warn?: (msg: any, ...rest: any[]) => void;
+}
+/**
+ * Bind afterInsert/afterUpdate hooks for every distinct object_name in
+ * `rules`. Each hook calls `service.evaluateAllForRecord(object, id, …)`
+ * with SYSTEM_CTX so the evaluator can write `sys_record_share` rows
+ * without being blocked by its own enforcement.
+ *
+ * Caller is responsible for invoking {@link unbindAllRuleHooks} before
+ * re-binding when the rule set changes.
+ */
+declare function bindRuleHooks(engine: MinimalEngine, service: SharingRuleService, rules: SharingRuleRow[], logger?: MinimalLogger): void;
+declare function unbindAllRuleHooks(engine: MinimalEngine): number;
+
+interface SharingPluginOptions {
+    /** Extra object names that bypass sharing entirely. */
+    bypassObjects?: string[];
+    /**
+     * Disable enforcement (read filter + canEdit) while still registering
+     * the schema + service. Useful in development to flip enforcement on
+     * via env var without rebuilding.
+     */
+    enforce?: boolean;
+}
+/**
+ * SharingServicePlugin — registers `sys_record_share`, the `sharing`
+ * service, and the engine middleware that enforces
+ * `object.sharingModel`.
+ *
+ * Enforcement is opt-in per object:
+ *
+ *   - `sharingModel: 'private'` → reads filtered to `(owner_id == me) OR
+ *     (record explicitly shared with me)`. Writes require ownership or
+ *     an `edit`/`full` share.
+ *   - `sharingModel: 'read'` → reads unrestricted; writes gated as
+ *     above (typical "everyone can see, only owner can edit").
+ *   - any other value (or no value) → no enforcement. This keeps
+ *     existing CRM behaviour identical until admins explicitly enable
+ *     sharing on a per-object basis.
+ *
+ * @example
+ * ```ts
+ * import { SharingServicePlugin } from '@objectstack/plugin-sharing';
+ *
+ * kernel.use(new SharingServicePlugin());
+ *
+ * // Mark an object private — middleware enforces from this point on.
+ * defineObject({
+ *   name: 'account',
+ *   sharingModel: 'private',
+ *   fields: { owner_id: Field.lookup('sys_user'), ... },
+ * });
+ * ```
+ */
+declare class SharingServicePlugin implements Plugin {
+    name: string;
+    version: string;
+    type: string;
+    dependencies: string[];
+    private readonly options;
+    private service?;
+    private ruleService?;
+    constructor(options?: SharingPluginOptions);
+    init(ctx: PluginContext): Promise<void>;
+    start(ctx: PluginContext): Promise<void>;
+}
+/**
+ * Build the engine middleware that injects read filters and gates
+ * write operations. Exported so it can be unit-tested without booting
+ * a kernel.
+ */
+declare function buildSharingMiddleware(service: SharingService): EngineMiddleware;
+
+export { type DepartmentGraphOptions, DepartmentGraphService, SHARING_RULE_HOOK_PACKAGE, type SharingEngine, type SharingPluginOptions, SharingRuleService, type SharingRuleServiceOptions, SharingService, type SharingServiceOptions, SharingServicePlugin, type TeamGraphOptions, TeamGraphService, bindRuleHooks, buildSharingMiddleware, expandPrincipal, unbindAllRuleHooks };