@kernhq/module-quire 0.2.0

package/dist/contract/permissions.d.ts

@@ -0,0 +1,51 @@
+/**
+ * `<module>.<resource>.<action>`, each at the narrowest scope that works.
+ *
+ * Almost everything here is bound at **space** scope rather than workspace scope. That scope kind has
+ * existed in the permission model since before there was anything to use it, and this is what it was
+ * for: "everyone may read the Handbook, the design team may write it, and the contractor may read one
+ * page of it". Bindings resolve nearest-first, so a binding on a page beats one on its space, which
+ * beats one on the workspace — and a deny beats an allow at the same level.
+ */
+export declare const quirePermissions: readonly [{
+    readonly key: "quire.space.view";
+    readonly label: "See a space";
+    readonly description: "Find the space and read its name, whatever its pages allow";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin", "member", "guest"];
+    readonly dangerous: false;
+}, {
+    readonly key: "quire.space.manage";
+    readonly label: "Create and configure spaces";
+    readonly description: "Rename, set the home page, change who may read it, archive it";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin"];
+    readonly dangerous: false;
+}, {
+    readonly key: "quire.page.view";
+    readonly label: "Read pages";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin", "member", "guest"];
+    readonly dangerous: false;
+}, {
+    readonly key: "quire.page.create";
+    readonly label: "Create pages";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin", "member"];
+    readonly dangerous: false;
+}, {
+    readonly key: "quire.page.edit";
+    readonly label: "Edit pages";
+    readonly description: "Write in a page, rename it, and move it in the tree";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin", "member"];
+    readonly dangerous: false;
+}, {
+    readonly key: "quire.page.delete";
+    readonly label: "Delete pages permanently";
+    readonly description: "Empty the trash. A purged page and its history cannot be recovered.";
+    readonly scope: "space";
+    readonly defaultRoles: ["owner", "admin"];
+    readonly dangerous: true;
+}];
+//# sourceMappingURL=permissions.d.ts.map

package/dist/contract/permissions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+C3B,CAAA"}

package/dist/contract/permissions.js

@@ -0,0 +1,59 @@
+import { definePermissions } from '@kernhq/contracts';
+/**
+ * `<module>.<resource>.<action>`, each at the narrowest scope that works.
+ *
+ * Almost everything here is bound at **space** scope rather than workspace scope. That scope kind has
+ * existed in the permission model since before there was anything to use it, and this is what it was
+ * for: "everyone may read the Handbook, the design team may write it, and the contractor may read one
+ * page of it". Bindings resolve nearest-first, so a binding on a page beats one on its space, which
+ * beats one on the workspace — and a deny beats an allow at the same level.
+ */
+export const quirePermissions = definePermissions([
+    {
+        key: 'quire.space.view',
+        label: 'See a space',
+        description: 'Find the space and read its name, whatever its pages allow',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin', 'member', 'guest'],
+        dangerous: false,
+    },
+    {
+        key: 'quire.space.manage',
+        label: 'Create and configure spaces',
+        description: 'Rename, set the home page, change who may read it, archive it',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin'],
+        dangerous: false,
+    },
+    {
+        key: 'quire.page.view',
+        label: 'Read pages',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin', 'member', 'guest'],
+        dangerous: false,
+    },
+    {
+        key: 'quire.page.create',
+        label: 'Create pages',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin', 'member'],
+        dangerous: false,
+    },
+    {
+        key: 'quire.page.edit',
+        label: 'Edit pages',
+        description: 'Write in a page, rename it, and move it in the tree',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin', 'member'],
+        dangerous: false,
+    },
+    {
+        key: 'quire.page.delete',
+        label: 'Delete pages permanently',
+        description: 'Empty the trash. A purged page and its history cannot be recovered.',
+        scope: 'space',
+        defaultRoles: ['owner', 'admin'],
+        dangerous: true,
+    },
+]);
+//# sourceMappingURL=permissions.js.map

package/dist/contract/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../src/contract/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAErD;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;IAChD;QACE,GAAG,EAAE,kBAAkB;QACvB,KAAK,EAAE,aAAa;QACpB,WAAW,EAAE,4DAA4D;QACzE,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACnD,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,oBAAoB;QACzB,KAAK,EAAE,6BAA6B;QACpC,WAAW,EAAE,+DAA+D;QAC5E,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;QAChC,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,iBAAiB;QACtB,KAAK,EAAE,YAAY;QACnB,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC;QACnD,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,KAAK,EAAE,cAAc;QACrB,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,iBAAiB;QACtB,KAAK,EAAE,YAAY;QACnB,WAAW,EAAE,qDAAqD;QAClE,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC;QAC1C,SAAS,EAAE,KAAK;KACjB;IACD;QACE,GAAG,EAAE,mBAAmB;QACxB,KAAK,EAAE,0BAA0B;QACjC,WAAW,EAAE,qEAAqE;QAClF,KAAK,EAAE,OAAO;QACd,YAAY,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC;QAChC,SAAS,EAAE,IAAI;KAChB;CACF,CAAC,CAAA"}