@zap-studio/permit 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -1,5 +1,17 @@
+## @zap-studio/permit@0.3.3
+
+### Migrate to ultracite lint/format
+
+Internal formatting and lint cleanup only. No public API or behavior change.
+
 # @zap-studio/permit
 
+## 0.3.2
+
+### Dependencies
+
+- Updated dependency `@zap-studio/validation` to `0.3.4`.
+
 ## 0.3.1
 
 ### Fixed
@@ -23,11 +35,9 @@
 
 - fe60f55: Change `policy.can()` to use a single permission string plus the resource object.
 
-  `policy.can(ctx, "read", "post", post)` is replaced by
-  `policy.can(ctx, "post:read", post)`.
+  `policy.can(ctx, "read", "post", post)` is replaced by `policy.can(ctx, "post:read", post)`.
 
-  This is a breaking API change in the `0.x` line. Docs and examples now use the
-  new permission-string format consistently.
+  This is a breaking API change in the `0.x` line. Docs and examples now use the new permission-string format consistently.
 
 ## 0.2.2
 

package/README.md

@@ -126,7 +126,7 @@ Returns a condition that is true only if all conditions are true.
 ```ts
 const isOwnerAndPublished = and(
   (ctx, action, resource) => ctx.user.id === resource.authorId,
-  (ctx, action, resource) => resource.status === "published",
+  (ctx, action, resource) => resource.status === "published"
 );
 ```
 
@@ -137,7 +137,7 @@ Returns a condition that is true if any condition is true.
 ```ts
 const isOwnerOrAdmin = or(
   (ctx, action, resource) => ctx.user.id === resource.authorId,
-  (ctx, action, resource) => ctx.user.role === "admin",
+  (ctx, action, resource) => ctx.user.role === "admin"
 );
 ```
 
@@ -146,7 +146,9 @@ const isOwnerOrAdmin = or(
 Returns a condition that negates another condition.
 
 ```ts
-const isNotOwner = not((ctx, action, resource) => ctx.user.id === resource.authorId);
+const isNotOwner = not(
+  (ctx, action, resource) => ctx.user.id === resource.authorId
+);
 ```
 
 ### Context Helpers

package/dist/errors.d.mts

@@ -1,9 +1,19 @@
 //#region src/errors.d.ts
 /**
-* Represents an error that occurs during policy evaluation or enforcement.
-* Use this error to indicate issues related to policy logic, configuration, or execution.
-*/
+ * Error primitives for policy evaluation and configuration failures.
+ *
+ * @module @zap-studio/permit/errors
+ */
+/**
+ * Represents an error that occurs during policy evaluation or enforcement.
+ * Use this error to indicate issues related to policy logic, configuration, or execution.
+ */
 declare class PolicyError extends Error {
+  /**
+   * Creates a policy error with a human-readable message.
+   *
+   * @param message - Error message describing the policy failure.
+   */
   constructor(message: string);
 }
 //#endregion

package/dist/errors.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"errors.d.mts","names":[],"sources":["../src/errors.ts"],"mappings":";;AAIA;;;cAAa,WAAA,SAAoB,KAAA;EAC/B,WAAA,CAAY,OAAA;AAAA"}
+{"version":3,"file":"errors.d.mts","names":[],"sources":["../src/errors.ts"],"mappings":";;;;;;;;;;cAUa,oBAAoB;;;;;;EAM/B,YAAY"}

package/dist/errors.mjs

@@ -1,9 +1,19 @@
 //#region src/errors.ts
 /**
+* Error primitives for policy evaluation and configuration failures.
+*
+* @module @zap-studio/permit/errors
+*/
+/**
 * Represents an error that occurs during policy evaluation or enforcement.
 * Use this error to indicate issues related to policy logic, configuration, or execution.
 */
 var PolicyError = class extends Error {
+	/**
+	* Creates a policy error with a human-readable message.
+	*
+	* @param message - Error message describing the policy failure.
+	*/
 	constructor(message) {
 		super(message);
 		this.name = "PolicyError";

package/dist/errors.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"errors.mjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Represents an error that occurs during policy evaluation or enforcement.\n * Use this error to indicate issues related to policy logic, configuration, or execution.\n */\nexport class PolicyError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"PolicyError\";\n  }\n}\n"],"mappings":";;;;;AAIA,IAAa,cAAb,cAAiC,MAAM;CACrC,YAAY,SAAiB;AAC3B,QAAM,QAAQ;AACd,OAAK,OAAO"}
+{"version":3,"file":"errors.mjs","names":[],"sources":["../src/errors.ts"],"sourcesContent":["/**\n * Error primitives for policy evaluation and configuration failures.\n *\n * @module @zap-studio/permit/errors\n */\n\n/**\n * Represents an error that occurs during policy evaluation or enforcement.\n * Use this error to indicate issues related to policy logic, configuration, or execution.\n */\nexport class PolicyError extends Error {\n  /**\n   * Creates a policy error with a human-readable message.\n   *\n   * @param message - Error message describing the policy failure.\n   */\n  constructor(message: string) {\n    super(message);\n    this.name = \"PolicyError\";\n  }\n}\n"],"mappings":";;;;;;;;;;AAUA,IAAa,cAAb,cAAiC,MAAM;;;;;;CAMrC,YAAY,SAAiB;EAC3B,MAAM,OAAO;EACb,KAAK,OAAO;CACd;AACF"}

package/dist/helpers.d.mts

@@ -1,27 +1,32 @@
 //#region src/helpers.d.ts
 /**
-* Ensures that a value of type `never` is actually never encountered at runtime.
-* This is useful for exhaustive checks on discriminated unions.
-*
-* @example
-* ```ts
-* type Action = 'read' | 'write'
-*
-* function performAction(action: Action) {
-*   switch (action) {
-*     case 'read':
-*       console.log('Reading...')
-*       break
-*     case 'write':
-*       console.log('Writing...')
-*       break
-*     default:
-*       assertNever(action) // TypeScript will error if a new Action is added but not handled
-*   }
-* }
-* ```
-*/
-declare function assertNever(value: never): never;
+ * Helper utilities for permit consumers.
+ *
+ * @module @zap-studio/permit/helpers
+ */
+/**
+ * Ensures that a value of type `never` is actually never encountered at runtime.
+ * This is useful for exhaustive checks on discriminated unions.
+ *
+ * @example
+ * ```ts
+ * type Action = 'read' | 'write'
+ *
+ * function performAction(action: Action) {
+ *   switch (action) {
+ *     case 'read':
+ *       console.log('Reading...')
+ *       break
+ *     case 'write':
+ *       console.log('Writing...')
+ *       break
+ *     default:
+ *       assertNever(action) // TypeScript will error if a new Action is added but not handled
+ *   }
+ * }
+ * ```
+ */
+declare const assertNever: (value: never) => never;
 //#endregion
 export { assertNever };
 //# sourceMappingURL=helpers.d.mts.map

package/dist/helpers.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.d.mts","names":[],"sources":["../src/helpers.ts"],"mappings":";;AAsBA;;;;;;;;;;;;;;;;;;;;;iBAAgB,WAAA,CAAY,KAAA"}
+{"version":3,"file":"helpers.d.mts","names":[],"sources":["../src/helpers.ts"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;cA4Ba,cAAe"}

package/dist/helpers.mjs

@@ -1,5 +1,10 @@
 //#region src/helpers.ts
 /**
+* Helper utilities for permit consumers.
+*
+* @module @zap-studio/permit/helpers
+*/
+/**
 * Ensures that a value of type `never` is actually never encountered at runtime.
 * This is useful for exhaustive checks on discriminated unions.
 *
@@ -21,9 +26,9 @@
 * }
 * ```
 */
-function assertNever(value) {
+const assertNever = (value) => {
 	throw new Error(`Unexpected value: ${String(value)}`);
-}
+};
 //#endregion
 export { assertNever };
 

package/dist/helpers.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"helpers.mjs","names":[],"sources":["../src/helpers.ts"],"sourcesContent":["/**\n * Ensures that a value of type `never` is actually never encountered at runtime.\n * This is useful for exhaustive checks on discriminated unions.\n *\n * @example\n * ```ts\n * type Action = 'read' | 'write'\n *\n * function performAction(action: Action) {\n *   switch (action) {\n *     case 'read':\n *       console.log('Reading...')\n *       break\n *     case 'write':\n *       console.log('Writing...')\n *       break\n *     default:\n *       assertNever(action) // TypeScript will error if a new Action is added but not handled\n *   }\n * }\n * ```\n */\nexport function assertNever(value: never): never {\n  throw new Error(`Unexpected value: ${String(value)}`);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,YAAY,OAAqB;AAC/C,OAAM,IAAI,MAAM,qBAAqB,OAAO,MAAM,GAAG"}
+{"version":3,"file":"helpers.mjs","names":[],"sources":["../src/helpers.ts"],"sourcesContent":["/**\n * Helper utilities for permit consumers.\n *\n * @module @zap-studio/permit/helpers\n */\n\n/**\n * Ensures that a value of type `never` is actually never encountered at runtime.\n * This is useful for exhaustive checks on discriminated unions.\n *\n * @example\n * ```ts\n * type Action = 'read' | 'write'\n *\n * function performAction(action: Action) {\n *   switch (action) {\n *     case 'read':\n *       console.log('Reading...')\n *       break\n *     case 'write':\n *       console.log('Writing...')\n *       break\n *     default:\n *       assertNever(action) // TypeScript will error if a new Action is added but not handled\n *   }\n * }\n * ```\n */\nexport const assertNever = (value: never): never => {\n  throw new Error(`Unexpected value: ${String(value)}`);\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AA4BA,MAAa,eAAe,UAAwB;CAClD,MAAM,IAAI,MAAM,qBAAqB,OAAO,KAAK,GAAG;AACtD"}