@classytic/arc 1.0.8 → 2.1.2

package/dist/types-aYB4V7uN.d.mts

@@ -0,0 +1,87 @@
+import { FastifyRequest } from "fastify";
+
+//#region src/permissions/types.d.ts
+/**
+ * User base interface - minimal shape Arc expects
+ * Your actual User can have any additional fields
+ */
+interface UserBase {
+  id?: string;
+  _id?: string;
+  roles?: string[];
+  [key: string]: unknown;
+}
+/**
+ * Context passed to permission check functions
+ */
+interface PermissionContext<TDoc = any> {
+  /** Authenticated user or null if unauthenticated */
+  user: UserBase | null;
+  /** Fastify request object */
+  request: FastifyRequest;
+  /** Resource name being accessed */
+  resource: string;
+  /** Action being performed (list, get, create, update, delete, or custom operation name) */
+  action: string;
+  /** Resource ID for single-resource operations (shortcut for params.id) */
+  resourceId?: string;
+  /** All route parameters (slug, parentId, custom params, etc.) */
+  params?: Record<string, string>;
+  /** Request body data */
+  data?: Partial<TDoc> | Record<string, unknown>;
+}
+/**
+ * Result from permission check
+ */
+interface PermissionResult {
+  /** Whether access is granted */
+  granted: boolean;
+  /** Reason for denial (for error messages) */
+  reason?: string;
+  /** Query filters to apply (for ownership patterns) */
+  filters?: Record<string, unknown>;
+}
+/**
+ * Permission Check Function
+ *
+ * THE ONLY way to define permissions in Arc.
+ * Returns boolean, PermissionResult, or Promise of either.
+ *
+ * @example
+ * ```typescript
+ * // Simple boolean return
+ * const isAdmin: PermissionCheck = (ctx) => ctx.user?.roles?.includes('admin') ?? false;
+ *
+ * // With filters for ownership
+ * const ownedByUser: PermissionCheck = (ctx) => ({
+ *   granted: true,
+ *   filters: { userId: ctx.user?.id }
+ * });
+ *
+ * // Async check
+ * const canAccessOrg: PermissionCheck = async (ctx) => {
+ *   const isMember = await checkMembership(ctx.user?.id, ctx.organizationId);
+ *   return { granted: isMember, reason: isMember ? undefined : 'Not a member' };
+ * };
+ * ```
+ */
+type PermissionCheck<TDoc = any> = ((context: PermissionContext<TDoc>) => boolean | PermissionResult | Promise<boolean | PermissionResult>) & PermissionCheckMeta;
+/**
+ * Optional metadata attached to permission check functions.
+ * Used for OpenAPI docs, introspection, and route-level auth decisions.
+ */
+interface PermissionCheckMeta {
+  /** Set by allowPublic() — marks the endpoint as publicly accessible */
+  _isPublic?: boolean;
+  /** Set by requireRoles() — the roles required for access */
+  _roles?: readonly string[];
+  /** Set by requireOrgMembership() — org-level permission type */
+  _orgPermission?: string;
+  /** Set by requireOrgRole() — the org roles required for access */
+  _orgRoles?: readonly string[];
+  /** Set by requireTeamMembership() — team-level permission type */
+  _teamPermission?: string;
+}
+//#endregion
+export { UserBase as i, PermissionContext as n, PermissionResult as r, PermissionCheck as t };
+//# sourceMappingURL=types-aYB4V7uN.d.mts.map

package/dist/types-aYB4V7uN.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-aYB4V7uN.d.mts","names":[],"sources":["../src/permissions/types.ts"],"mappings":";;;;;;;UAaiB,QAAA;EACf,EAAA;EACA,GAAA;EACA,KAAA;EAAA,CACC,GAAA;AAAA;;;;UAMc,iBAAA;EAcQ;EAZvB,IAAA,EAAM,QAAA;EAYuB;EAV7B,OAAA,EAAS,cAAA;EAFT;EAIA,QAAA;EAFA;EAIA,MAAA;EAFA;EAIA,UAAA;EAAA;EAEA,MAAA,GAAS,MAAA;EAAA;EAET,IAAA,GAAO,OAAA,CAAQ,IAAA,IAAQ,MAAA;AAAA;;;;UAMR,gBAAA;EAAA;EAEf,OAAA;;EAEA,MAAA;EAFA;EAIA,OAAA,GAAU,MAAA;AAAA;;;;AA2BZ;;;;;;;;;;;;;;;;;;;;;KAAY,eAAA,iBACV,OAAA,EAAS,iBAAA,CAAkB,IAAA,gBACd,gBAAA,GAAmB,OAAA,WAAkB,gBAAA,KAClD,mBAAA;;;;;UAMe,mBAAA;EAMf;EAJA,SAAA;EAQA;EANA,MAAA;EAMe;EAJf,cAAA;;EAEA,SAAA;;EAEA,eAAA;AAAA"}