{"id":26293717,"url":"https://github.com/falcondev-oss/caps","last_synced_at":"2025-11-09T05:04:18.336Z","repository":{"id":268151621,"uuid":"903472194","full_name":"falcondev-oss/caps","owner":"falcondev-oss","description":"Simple, fully type-safe library to handle permissions/access control by defining capabilities with generators.","archived":false,"fork":false,"pushed_at":"2025-10-01T23:36:39.000Z","size":197,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-11-09T05:03:37.429Z","etag":null,"topics":["access-control","capabilities","generator","permissions","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/falcondev-oss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-12-14T17:32:44.000Z","updated_at":"2025-10-01T23:36:42.000Z","dependencies_parsed_at":"2024-12-14T18:36:49.747Z","dependency_job_id":"35eaee79-ab12-4f7b-9404-f2083cbec7d7","html_url":"https://github.com/falcondev-oss/caps","commit_stats":null,"previous_names":["falcondev-oss/caps"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/falcondev-oss/caps","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Fcaps","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Fcaps/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Fcaps/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Fcaps/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/falcondev-oss","download_url":"https://codeload.github.com/falcondev-oss/caps/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/falcondev-oss%2Fcaps/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":283459954,"owners_count":26839469,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-11-09T02:00:05.828Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["access-control","capabilities","generator","permissions","typescript"],"created_at":"2025-03-15T02:30:09.661Z","updated_at":"2025-11-09T05:04:18.320Z","avatar_url":"https://github.com/falcondev-oss.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @falcondev-oss/caps\n\n\u003ca href=\"https://npmjs.org/package/@falcondev-oss/caps\" title=\"View this project on NPM\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/@falcondev-oss/caps.svg\" alt=\"NPM version\" /\u003e\u003c/a\u003e\n\nSimple, **fully type-safe** library to handle permissions/access control by defining capabilities with generators.\n\n## Installation\n\n```bash\nnpm add @falcondev-oss/caps\n```\n\n## Example\n\n```typescript\ntype User = { userId: string; role: 'user' | 'moderator' | 'admin'; isBanned: boolean }\ntype Post = { author: User }\n\nconst useActor = createActor\u003cUser\u003e().build((cap) =\u003e ({\n  social: {\n    posts: cap.subject\u003cPost\u003e().define(\n      function* ({ actor, subject, args }) {\n        // banned users can't do anything\n        if (actor.isBanned || subject.author.isBanned) return []\n\n        // everyone can read posts\n        yield ['read']\n\n        // users can update \u0026 delete posts themselves\n        if (actor.userId === subject.author.userId) yield ['update', 'delete']\n\n        // admins can delete any post \u0026 ban users\n        if (actor.role === 'admin') {\n          yield ['delete', 'ban']\n        }\n\n        // moderators can only delete posts from users\n        if (actor.role === 'moderator' \u0026\u0026 subject.author.role === 'user') {\n          yield ['delete']\n\n          // moderators can also ban users temporarily\n          if (args.ban?.temporary) yield ['ban']\n        }\n\n        return []\n      },\n      {\n        ban: arg\u003c{ temporary: boolean }\u003e,\n      },\n    ),\n  },\n}))\n\nconst Users = {\n  user1: { userId: '1', role: 'user', isBanned: false },\n  user2: { userId: '2', role: 'user', isBanned: false },\n  moderator: { userId: '3', role: 'moderator', isBanned: false },\n  admin: { userId: '4', role: 'admin', isBanned: false },\n} as const\n\nconst user = useActor(Users.user1)\n\nuser.social.posts.subject({ author: Users.user2 }).can('read').check() // =\u003e true\nuser.social.posts.subject({ author: Users.user1 }).can('update').check() // =\u003e true\nuser.social.posts.subject({ author: Users.user2 }).can('delete').check() // =\u003e false\n\nconst moderator = useActor(Users.moderator)\n\nmoderator.social.posts.subject({ author: Users.user1 }).can('delete').check() // =\u003e true\nmoderator.social.posts.subject({ author: Users.user1 }).can('update').check() // =\u003e false\nmoderator.social.posts.subject({ author: Users.user1 }).can('ban', { temporary: false }).check() // =\u003e false\nmoderator.social.posts.subject({ author: Users.user1 }).can('ban', { temporary: true }).check() // =\u003e true\n\nconst admin = useActor(Users.admin)\n\nadmin.social.posts.subject({ author: Users.user1 }).can('ban', { temporary: false }).check() // =\u003e true\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalcondev-oss%2Fcaps","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffalcondev-oss%2Fcaps","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffalcondev-oss%2Fcaps/lists"}