@zap-studio/permit 0.3.2 → 0.3.4

package/dist/types.d.mts

@@ -1,143 +0,0 @@
-import { StandardSchemaV1 } from "@zap-studio/validation";
-
-//#region src/types.d.ts
-/**
-* Represents the possible outcomes of a policy decision.
-* - "allow": The action is permitted.
-* - "deny": The action is not permitted.
-*/
-type Decision = "allow" | "deny";
-/**
-* Represents the context in which a policy decision is made.
-* Can include user information, environment, or any relevant data.
-*/
-type Context<TContext = unknown> = TContext;
-/**
-* Represents a role within the system.
-*/
-type Role<TRole extends string = string> = TRole;
-/**
-* Represents a role hierarchy within the system.
-* Maps each role to an array of roles it inherits from.
-*
-* @example
-* ```ts
-* type Roles = "guest" | "user" | "admin";
-*
-* const hierarchy: RoleHierarchy<Roles> = {
-*   guest: [],
-*   user: ["guest"],
-*   admin: ["user"],
-* };
-* ```
-*/
-type RoleHierarchy<TRole extends Role = Role> = Record<TRole, TRole[]>;
-/**
-* Type helper for defining resource schemas using Standard Schema.
-* Use with `satisfies` to ensure type safety when defining resources.
-*
-* @example
-* ```ts
-* import { z } from "zod";
-* import type { Resources } from "@zap-studio/permit/types";
-*
-* const resources = {
-*   post: z.object({ id: z.string(), authorId: z.string() }),
-*   comment: z.object({ id: z.string(), postId: z.string() }),
-* } satisfies Resources;
-* ```
-*/
-type Resources<TResourceKey extends string = string> = Record<TResourceKey, StandardSchemaV1>;
-/**
-* Type helper for defining actions per resource.
-* Use with `satisfies` to ensure keys match the resource definitions.
-*
-* @example
-* ```ts
-* import type { Actions } from "@zap-studio/permit/types";
-*
-* const actions = {
-*   post: ["read", "write", "delete"],
-*   comment: ["read", "write"],
-* } as const satisfies Actions<typeof resources>;
-* ```
-*/
-type Actions<TResources extends Resources> = { [K in keyof TResources]: readonly string[] };
-/**
-* Infers the output type from a Standard Schema.
-*/
-type InferResource<TResources extends Resources, TResourceKey extends keyof TResources> = StandardSchemaV1.InferOutput<TResources[TResourceKey]>;
-/**
-* Infers the action union type for a specific resource.
-*/
-type InferAction<TActions extends Record<string, readonly string[]>, K extends keyof TActions> = TActions[K][number];
-/**
-* Infers the permission-string union for all resource/action combinations.
-*
-* @example
-* ```ts
-* type Permission = InferPermission<typeof resources, typeof actions>;
-* // "post:read" | "post:write" | "comment:read"
-* ```
-*/
-type InferPermission<TResources extends Resources, TActions extends Actions<TResources>> = { [K in keyof TResources & keyof TActions]: `${K & string}:${InferAction<TActions, K> & string}` }[keyof TResources & keyof TActions];
-/**
-* A function that determines whether a given action on a resource is allowed in a specific context.
-*/
-type PolicyFn<TContext extends Context, TAction extends string = string, TResource = unknown> = (context: TContext, action: TAction, resource: TResource) => Decision;
-/**
-* A function that evaluates a condition for a given action and resource in a specific context.
-*/
-type ConditionFn<TContext extends Context, TAction extends string = string, TResource = unknown> = (context: TContext, action: TAction, resource: TResource) => boolean;
-/**
-* Maps actions to their corresponding policy functions for a specific resource.
-*/
-type ActionPolicyMap<TContext extends Context, TAction extends string = string, TResource = unknown> = { [A in TAction]?: PolicyFn<TContext, A, TResource> };
-/**
-* Defines the rules for each resource and action combination.
-* Each resource key maps to an object where each action key maps to a policy function.
-*/
-type Rules<TContext extends Context, TResources extends Resources = Resources, TActions extends Actions<TResources> = Actions<TResources>> = { [K in keyof TResources & keyof TActions]: ActionPolicyMap<TContext, InferAction<TActions, K>, InferResource<TResources, K>> };
-/**
-* Configuration object for creating a permit policy.
-*
-* @example
-* ```ts
-* const config: PermitConfig<MyContext> = {
-*   resources,
-*   actions,
-*   rules: {
-*     post: { read: allow(), write: deny() },
-*   },
-* };
-* ```
-*/
-interface PermitConfig<TContext extends Context, TResources extends Resources = Resources, TActions extends Actions<TResources> = Actions<TResources>> {
-  actions: TActions;
-  resources: TResources;
-  rules: Rules<TContext, TResources, TActions>;
-}
-/**
-* Represents a policy object that can evaluate permissions.
-* The `can` method checks if a given action is permitted on a resource in a specific context.
-*
-* @example
-* ```ts
-* const policy: Policy<MyContext> = createPolicy({
-*   resources,
-*   actions,
-*   rules: { ... },
-* });
-*
-* await policy.can(ctx, "post:read", postData); // true or false
-* ```
-*/
-interface Policy<TContext extends Context, TResources extends Resources = Resources, TActions extends Actions<TResources> = Actions<TResources>> {
-  /**
-  * Determines if the specified action is permitted on the resource in the given context.
-  */
-  can<K extends keyof TResources & keyof TActions>(context: TContext, permission: `${K & string}:${InferAction<TActions, K> & string}`, resource: InferResource<TResources, K>): Promise<boolean>;
-}
-//#endregion
-export { ActionPolicyMap, Actions, ConditionFn, Context, Decision, InferAction, InferPermission, InferResource, PermitConfig, Policy, PolicyFn, Resources, Role, RoleHierarchy, Rules };
-//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.mts","names":[],"sources":["../src/types.ts"],"mappings":";;;;;AAOA;;;KAAY,QAAA;;AAMZ;;;KAAY,OAAA,uBAA8B,QAAA;;AAK1C;;KAAY,IAAA,kCAAsC,KAAA;;;AAiBlD;;;;;;;;;;;;;KAAY,aAAA,eAA4B,IAAA,GAAO,IAAA,IAAQ,MAAA,CAAO,KAAA,EAAO,KAAA;;;;;AAiBrE;;;;;;;;;;;KAAY,SAAA,yCAAkD,MAAA,CAC5D,YAAA,EACA,gBAAA;;;AAiBF;;;;;;;;;;AAOA;;KAPY,OAAA,oBAA2B,SAAA,kBACzB,UAAA;;;;KAMF,aAAA,oBACS,SAAA,6BACQ,UAAA,IACzB,gBAAA,CAAiB,WAAA,CAAY,UAAA,CAAW,YAAA;;;;KAKhC,WAAA,kBACO,MAAA,6CACD,QAAA,IACd,QAAA,CAAS,CAAA;;;;AAHb;;;;;;KAcY,eAAA,oBAAmC,SAAA,mBAA4B,OAAA,CAAQ,UAAA,mBACrE,UAAA,SAAmB,QAAA,MAAc,CAAA,aAAc,WAAA,CAAY,QAAA,EAAU,CAAA,qBAC3E,UAAA,SAAmB,QAAA;;;;KAKf,QAAA,kBACO,OAAA,2DAGd,OAAA,EAAS,QAAA,EAAU,MAAA,EAAQ,OAAA,EAAS,QAAA,EAAU,SAAA,KAAc,QAAA;;;;KAKrD,WAAA,kBACO,OAAA,2DAGd,OAAA,EAAS,QAAA,EAAU,MAAA,EAAQ,OAAA,EAAS,QAAA,EAAU,SAAA;;;;KAKvC,eAAA,kBACO,OAAA,kEAIX,OAAA,IAAW,QAAA,CAAS,QAAA,EAAU,CAAA,EAAG,SAAA;;;;;KAO7B,KAAA,kBACO,OAAA,qBACE,SAAA,GAAY,SAAA,mBACd,OAAA,CAAQ,UAAA,IAAc,OAAA,CAAQ,UAAA,mBAEnC,UAAA,SAAmB,QAAA,GAAW,eAAA,CACxC,QAAA,EACA,WAAA,CAAY,QAAA,EAAU,CAAA,GACtB,aAAA,CAAc,UAAA,EAAY,CAAA;;;;;;;AAtC9B;;;;;;;;UAwDiB,YAAA,kBACE,OAAA,qBACE,SAAA,GAAY,SAAA,mBACd,OAAA,CAAQ,UAAA,IAAc,OAAA,CAAQ,UAAA;EAE/C,OAAA,EAAS,QAAA;EACT,SAAA,EAAW,UAAA;EACX,KAAA,EAAO,KAAA,CAAM,QAAA,EAAU,UAAA,EAAY,QAAA;AAAA;;;;;;;AAtDrC;;;;;;;;;UAwEiB,MAAA,kBACE,OAAA,qBACE,SAAA,GAAY,SAAA,mBACd,OAAA,CAAQ,UAAA,IAAc,OAAA,CAAQ,UAAA;;;;EAK/C,GAAA,iBAAoB,UAAA,SAAmB,QAAA,EACrC,OAAA,EAAS,QAAA,EACT,UAAA,KAAe,CAAA,aAAc,WAAA,CAAY,QAAA,EAAU,CAAA,cACnD,QAAA,EAAU,aAAA,CAAc,UAAA,EAAY,CAAA,IACnC,OAAA;AAAA"}

package/dist/types.mjs

@@ -1 +0,0 @@
-export {};