endpoint-permissions-kit 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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 yellyoshua
+
+   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/README.md

@@ -0,0 +1,171 @@
+# Endpoint Permissions Kit
+
+Framework-agnostic endpoint authorization for TypeScript and JavaScript: an in-memory permission registry with explicit roles, typed permission identifiers, one-hop grants and validation hooks.
+
+[![npm version](https://img.shields.io/npm/v/endpoint-permissions-kit)](https://www.npmjs.com/package/endpoint-permissions-kit)
+[![license](https://img.shields.io/npm/l/endpoint-permissions-kit)](LICENSE)
+
+## Features
+
+- Permissions identified as `[role]::[module]::[name]` strings that your application persists and passes back per request.
+- Per-method (`find`, `update`, `create`, `remove`) definitions with allowed fields, or `'*'` for every field.
+- One-hop grants: holders of one permission receive a declared subset of actions on another.
+- Hooks at module, name and role scope, awaited together with `Promise.allSettled`.
+- `validate()` never throws: it always returns `{ result, errors }`.
+- Read-only permission views (`permissions.named`, `permissions.forUser`) for admin screens.
+- `pkit generate` CLI that turns your role catalog into a TypeScript declaration so unknown roles do not compile.
+- ESM, CommonJS and `.d.ts` output; runs on Node 20 or newer and on Bun.
+
+## Install
+
+```sh
+bun add endpoint-permissions-kit
+```
+
+```sh
+npm install endpoint-permissions-kit
+```
+
+## Quick start
+
+```ts
+import pkit from 'endpoint-permissions-kit';
+
+pkit.context.set('roles', ['admin', 'staff']);
+
+pkit.module('inventory').module('items').name('all').role('staff').registerActions({
+  find: { enabled: true, properties: ['id', 'name', 'stock'] },
+  update: { enabled: true, properties: ['name', 'stock'] },
+});
+
+pkit.seal();
+
+const validation = await pkit.validate({
+  action: 'inventory.items',
+  name: 'all',
+  method: 'find',
+  role: 'staff',
+  permissions: ['staff::inventory.items::all'],
+  select: ['id', 'name', 'cost'],
+});
+
+console.log(validation.result);
+console.log(validation.errors);
+```
+
+`validation.result` is `['id', 'name']`: the requested selection trimmed to the fields allowed for `staff::inventory.items::all`. `validation.errors` is an empty frozen array. `role` and `permissions` come from your session and your stored assignments, never from the request body or query string.
+
+Until you run `pkit generate`, TypeScript only knows the role `general`; the role names above compile once the generated declaration file is part of your program. See [CLI](#cli).
+
+## Concepts
+
+- **Role catalog.** `pkit.context.set('roles', [...])` declares every role before the first registration. Without that call the catalog contains only `general`. `general` is an ordinary role: it must be used explicitly with `.role('general')`, it is not added to a declared catalog, and it does not back other roles. There is no implicit role anywhere: `registerActions`, role hooks, `validate()` and `permissions.forUser()` all require an explicit role.
+- **Identifier.** A permission is `[role]::[module]::[name]`, for example `staff::marketing.portals::update-only`. The module is a dot-joined path built with chained `.module(segment)` calls, the name labels a set of actions on that module, and the role is part of the key so stored rows can be audited.
+- **Definition vs assignment vs grant.** A definition (`.name('all').role('admin').registerActions(...)`) declares what `admin::marketing.portals::all` allows; it assigns nothing. An assignment is the identifier stored among a user's permissions by your application. A grant (`.name('all').grantTo('admin::marketing.dashboard::all').registerActions(...)`) gives holders of the dashboard permission the declared actions on portals. A role alone authorizes nothing.
+- **One-hop grants.** Access received through a grant never counts as an assignment that activates another grant. Cycles between different names are allowed; only self-reference is rejected.
+- **Direct assignment precedence.** If the user holds `role::module::name` directly, that definition decides completely, even when a grant to the same target would be wider. Only when there is no direct assignment are the applicable grants combined, and their fields are unioned.
+
+## Error contract
+
+`validate()` never throws. It returns `{ result, errors }`: on success `errors` is an empty frozen array and `result` is the effective selection for `find` or the same `data` object for writes; on any failure `result` is `null` and `errors` is a frozen array of `{ code, message }` objects.
+
+| Code | Meaning |
+| --- | --- |
+| `NOT_SEALED` | `validate()` was called before `seal()` |
+| `INVALID_INPUT` | Missing `action`, `name`, `role` or `permissions`; malformed identifier; `select` outside `find`; invalid shape of `data`, `context` or `select` |
+| `UNKNOWN_ROLE` | Role outside the catalog |
+| `UNKNOWN_ACTION` | Module not registered |
+| `UNKNOWN_PERMISSION` | Name does not exist, or an assigned identifier is not assignable |
+| `PERMISSION_ROLE_MISMATCH` | An assigned identifier carries a role different from the authenticated one |
+| `PERMISSION_NOT_ASSIGNED` | No direct assignment and no active grant for the target |
+| `METHOD_DISABLED` | Method absent or disabled on the assigned definition, or not granted by any applicable grant |
+| `PROPERTIES_NOT_ALLOWED` | Write keys outside the allowed fields; `fields` lists the rejected keys |
+| `HOOK_ERROR` | One entry per failed hook; `cause` keeps the thrown value |
+| `VALIDATION_ERROR` | Unexpected failure in another phase; `cause` keeps the original error |
+
+Configuration, registration, `seal()` and the permission views throw a native `PkitError` with a `code` property (`ROLE_NOT_DECLARED`, `DUPLICATE_REGISTRATION`, `INVALID_DEFINITION`, `SEALED`, `NOT_SEALED`, `UNKNOWN_ROLE`, `INVALID_INPUT`, `PERMISSION_ROLE_MISMATCH`, `UNKNOWN_PERMISSION`). Those are programming errors raised at startup, not authorization results. The application translates every code to its transport (HTTP status, GraphQL error, RPC failure) and decides what to expose and what to log.
+
+## CLI
+
+```sh
+pkit generate
+pkit generate --check
+pkit generate --config ./config/roles.mjs --out ./src/pkit.generated.d.ts
+```
+
+`pkit generate` looks for `pkit.config.js`, `pkit.config.mjs`, `pkit.config.cjs` or `pkit.config.ts` in the working directory (or uses `--config`), runs it in an isolated child process, reads the roles declared with `pkit.context.set('roles', [...])` and writes `pkit.generated.d.ts` (or the `--out` path). The generated file augments `RoleRegistry` from `endpoint-permissions-kit/types`, so `Role` and `PermissionId` only accept declared roles. Include that file in your TypeScript program.
+
+`--check` writes nothing: it exits with 1 when the file is missing or stale. Exit codes: 0 success, 1 failure or stale file, 2 invalid command line.
+
+The config must declare roles without starting servers or opening connections. On Node 20 use a `.js`, `.mjs` or `.cjs` config; a `.ts` config needs a runtime with TypeScript support (Bun, or a Node release that accepts `--experimental-strip-types`).
+
+## ESM and CommonJS
+
+```js
+import pkit from 'endpoint-permissions-kit';
+```
+
+```js
+const { pkit } = require('endpoint-permissions-kit');
+```
+
+Public types are also available from the `endpoint-permissions-kit/types` subpath, which is the module the generated role declaration augments:
+
+```ts
+import type { PermissionId, Role, ValidateInput } from 'endpoint-permissions-kit/types';
+```
+
+The registry lives in `globalThis[Symbol.for('endpoint-permissions-kit')]`, so the ESM and CJS copies share the same state inside one process.
+
+## Project layout
+
+| Location | Responsibility |
+| --- | --- |
+| `src/index.ts` | Composes `pkit`, named exports and the published types |
+| `src/types.ts` | Public contracts: roles, methods, actions, grants, hooks, inputs, results, errors and views; published as `./types` |
+| `src/constants.ts` | Available methods, the `general` role, the global hook owner marker and the field wildcard |
+| `src/errors.ts` | Creates `PkitError` exceptions with a `code` |
+| `src/state.ts` | Creates and returns the shared registry stored on `globalThis` |
+| `src/context.ts` | Declares and reads the role catalog |
+| `src/registry.ts` | Module, name, role and grant builders; registers actions, grants and hooks |
+| `src/resolve.ts` | Access resolution shared by `validate` and `permissions.forUser` |
+| `src/seal.ts` | Checks cross-references and orphan hooks, then materializes frozen views; idempotent |
+| `src/permissions.ts` | `permissions.named` and `permissions.forUser` |
+| `src/validators.ts` | Reusable validation rules for objects, strings, catalog, roles, definitions, grants, hooks and requests |
+| `src/validate.ts` | Runs request validation and hooks; sole owner of the `{ result, errors }` format |
+| `src/cli/generate.ts` | Resolves the config, reads the catalog from the child process, renders and writes the declaration; `main` handles the CLI |
+| `src/cli/child.ts` | Imports the config and prints the role catalog on stdout |
+| `src/cli/protocol.ts` | Parent/child protocol constants and exit codes |
+| `bin/pkit.mjs` | Node executable entry that calls the compiled CLI |
+| `scripts/build.ts` | Cleans `dist`, bundles ESM and CJS with Bun and emits declarations with TypeScript |
+| `tests/` | Functional tests for registry, permissions, validation, CLI and architecture rules |
+| `tests/typecheck/` | Isolated TypeScript program with valid and invalid uses of the public types |
+
+## Scope limits
+
+- No framework adapters: you call `validate()` from your own handlers or middleware.
+- No database access: your application loads assignments from a trusted source and passes them in.
+- No route discovery: the route decides which module, name and method it protects.
+- No session management: `role` and `permissions` come from your authenticated session.
+- No hot reload: changes to a sealed registry require restarting the process.
+
+## Development
+
+```sh
+bun install
+bun run typecheck
+bun test
+bun run build
+```
+
+Bun is used for development, tests and building. The published `dist/` runs on Node 20 or newer: the core uses standard JavaScript and the CLI uses Node APIs.
+
+## Documentation
+
+- [USAGE.md](USAGE.md): model, registration, grants, request validation, hooks, errors, views and the CLI.
+- [CONTRIBUTING.md](CONTRIBUTING.md): setup, conventions and test requirements.
+- [SECURITY.md](SECURITY.md): how to report a vulnerability.
+
+## License
+
+[Apache-2.0](LICENSE)

package/bin/pkit.mjs

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { main } from '../dist/esm/cli/generate.js';
+
+await main(process.argv.slice(2));