@hexclave/shared 1.0.0

package/dist/esm/interface/crud/project-permissions.js

@@ -0,0 +1,104 @@
+import { createCrud } from "../../crud.js";
+import * as schemaFields from "../../schema-fields.js";
+import { yupMixed, yupObject } from "../../schema-fields.js";
+
+//#region src/interface/crud/project-permissions.ts
+const projectPermissionsCrudClientReadSchema = yupObject({
+	id: schemaFields.permissionDefinitionIdSchema.defined(),
+	user_id: schemaFields.userIdSchema.defined()
+}).defined();
+const projectPermissionsCrudServerCreateSchema = yupObject({}).defined();
+const projectPermissionsCrudServerDeleteSchema = yupMixed();
+const projectPermissionsCrud = createCrud({
+	clientReadSchema: projectPermissionsCrudClientReadSchema,
+	serverCreateSchema: projectPermissionsCrudServerCreateSchema,
+	serverDeleteSchema: projectPermissionsCrudServerDeleteSchema,
+	docs: {
+		clientList: {
+			summary: "List project permissions",
+			description: "List global permissions of the current user. `user_id=me` must be set for client requests. `(user_id, permission_id)` together uniquely identify a permission.",
+			tags: ["Permissions"]
+		},
+		serverList: {
+			summary: "List project permissions",
+			description: "Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission.",
+			tags: ["Permissions"]
+		},
+		serverCreate: {
+			summary: "Grant a global permission to a user",
+			description: "Grant a global permission to a user (the permission must be created first on the Stack dashboard)",
+			tags: ["Permissions"]
+		},
+		serverDelete: {
+			summary: "Revoke a global permission from a user",
+			description: "Revoke a global permission from a user",
+			tags: ["Permissions"]
+		}
+	}
+});
+const projectPermissionCreatedWebhookEvent = {
+	type: "project_permission.created",
+	schema: projectPermissionsCrud.server.readSchema,
+	metadata: {
+		summary: "Project Permission Created",
+		description: "This event is triggered when a project permission is created.",
+		tags: ["Users"]
+	}
+};
+const projectPermissionDeletedWebhookEvent = {
+	type: "project_permission.deleted",
+	schema: projectPermissionsCrud.server.readSchema,
+	metadata: {
+		summary: "Project Permission Deleted",
+		description: "This event is triggered when a project permission is deleted.",
+		tags: ["Users"]
+	}
+};
+const projectPermissionDefinitionsCrudAdminReadSchema = yupObject({
+	id: schemaFields.permissionDefinitionIdSchema.defined(),
+	description: schemaFields.teamPermissionDescriptionSchema.optional(),
+	contained_permission_ids: schemaFields.containedPermissionIdsSchema.defined()
+}).defined();
+const projectPermissionDefinitionsCrudAdminCreateSchema = yupObject({
+	id: schemaFields.customPermissionDefinitionIdSchema.defined(),
+	description: schemaFields.teamPermissionDescriptionSchema.optional(),
+	contained_permission_ids: schemaFields.containedPermissionIdsSchema.optional()
+}).defined();
+const projectPermissionDefinitionsCrudAdminUpdateSchema = yupObject({
+	id: schemaFields.customPermissionDefinitionIdSchema.optional(),
+	description: schemaFields.teamPermissionDescriptionSchema.optional(),
+	contained_permission_ids: schemaFields.containedPermissionIdsSchema.optional()
+}).defined();
+const projectPermissionDefinitionsCrudAdminDeleteSchema = yupMixed();
+const projectPermissionDefinitionsCrud = createCrud({
+	adminReadSchema: projectPermissionDefinitionsCrudAdminReadSchema,
+	adminCreateSchema: projectPermissionDefinitionsCrudAdminCreateSchema,
+	adminUpdateSchema: projectPermissionDefinitionsCrudAdminUpdateSchema,
+	adminDeleteSchema: projectPermissionDefinitionsCrudAdminDeleteSchema,
+	docs: {
+		adminList: {
+			summary: "List project permission definitions",
+			description: "Query and filter project permission definitions (the equivalent of listing permissions on the Stack dashboard)",
+			tags: ["Permissions"]
+		},
+		adminCreate: {
+			summary: "Create a new project permission definition",
+			description: "Create a new project permission definition (the equivalent of creating a new permission on the Stack dashboard)",
+			tags: ["Permissions"]
+		},
+		adminUpdate: {
+			summary: "Update a project permission definition",
+			description: "Update a project permission definition (the equivalent of updating a permission on the Stack dashboard)",
+			tags: ["Permissions"]
+		},
+		adminDelete: {
+			summary: "Delete a project permission definition",
+			description: "Delete a project permission definition (the equivalent of deleting a permission on the Stack dashboard)",
+			tags: ["Permissions"]
+		}
+	}
+});
+
+//#endregion
+export { projectPermissionCreatedWebhookEvent, projectPermissionDefinitionsCrud, projectPermissionDefinitionsCrudAdminCreateSchema, projectPermissionDefinitionsCrudAdminDeleteSchema, projectPermissionDefinitionsCrudAdminReadSchema, projectPermissionDefinitionsCrudAdminUpdateSchema, projectPermissionDeletedWebhookEvent, projectPermissionsCrud, projectPermissionsCrudClientReadSchema, projectPermissionsCrudServerCreateSchema, projectPermissionsCrudServerDeleteSchema };
+//# sourceMappingURL=project-permissions.js.map

package/dist/esm/interface/crud/project-permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project-permissions.js","names":[],"sources":["../../../../src/interface/crud/project-permissions.ts"],"sourcesContent":["import { CrudTypeOf, createCrud } from \"../../crud\";\nimport * as schemaFields from \"../../schema-fields\";\nimport { yupMixed, yupObject } from \"../../schema-fields\";\nimport { WebhookEvent } from \"../webhooks\";\n\n// =============== Project permissions =================\n\nexport const projectPermissionsCrudClientReadSchema = yupObject({\n  id: schemaFields.permissionDefinitionIdSchema.defined(),\n  user_id: schemaFields.userIdSchema.defined(),\n}).defined();\n\nexport const projectPermissionsCrudServerCreateSchema = yupObject({\n}).defined();\n\nexport const projectPermissionsCrudServerDeleteSchema = yupMixed();\n\nexport const projectPermissionsCrud = createCrud({\n  clientReadSchema: projectPermissionsCrudClientReadSchema,\n  serverCreateSchema: projectPermissionsCrudServerCreateSchema,\n  serverDeleteSchema: projectPermissionsCrudServerDeleteSchema,\n  docs: {\n    clientList: {\n      summary: \"List project permissions\",\n      description: \"List global permissions of the current user. `user_id=me` must be set for client requests. `(user_id, permission_id)` together uniquely identify a permission.\",\n      tags: [\"Permissions\"],\n    },\n    serverList: {\n      summary: \"List project permissions\",\n      description: \"Query and filter the permission with `user_id` and `permission_id`. `(user_id, permission_id)` together uniquely identify a permission.\",\n      tags: [\"Permissions\"],\n    },\n    serverCreate: {\n      summary: \"Grant a global permission to a user\",\n      description: \"Grant a global permission to a user (the permission must be created first on the Stack dashboard)\",\n      tags: [\"Permissions\"],\n    },\n    serverDelete: {\n      summary: \"Revoke a global permission from a user\",\n      description: \"Revoke a global permission from a user\",\n      tags: [\"Permissions\"],\n    },\n  },\n});\nexport type ProjectPermissionsCrud = CrudTypeOf<typeof projectPermissionsCrud>;\n\nexport const projectPermissionCreatedWebhookEvent = {\n  type: \"project_permission.created\",\n  schema: projectPermissionsCrud.server.readSchema,\n  metadata: {\n    summary: \"Project Permission Created\",\n    description: \"This event is triggered when a project permission is created.\",\n    tags: [\"Users\"],\n  },\n} satisfies WebhookEvent<typeof projectPermissionsCrud.server.readSchema>;\n\nexport const projectPermissionDeletedWebhookEvent = {\n  type: \"project_permission.deleted\",\n  schema: projectPermissionsCrud.server.readSchema,\n  metadata: {\n    summary: \"Project Permission Deleted\",\n    description: \"This event is triggered when a project permission is deleted.\",\n    tags: [\"Users\"],\n  },\n} satisfies WebhookEvent<typeof projectPermissionsCrud.server.readSchema>;\n\n// =============== Project permission definitions =================\n\nexport const projectPermissionDefinitionsCrudAdminReadSchema = yupObject({\n  id: schemaFields.permissionDefinitionIdSchema.defined(),\n  description: schemaFields.teamPermissionDescriptionSchema.optional(),\n  contained_permission_ids: schemaFields.containedPermissionIdsSchema.defined(),\n}).defined();\n\nexport const projectPermissionDefinitionsCrudAdminCreateSchema = yupObject({\n  id: schemaFields.customPermissionDefinitionIdSchema.defined(),\n  description: schemaFields.teamPermissionDescriptionSchema.optional(),\n  contained_permission_ids: schemaFields.containedPermissionIdsSchema.optional(),\n}).defined();\n\nexport const projectPermissionDefinitionsCrudAdminUpdateSchema = yupObject({\n  id: schemaFields.customPermissionDefinitionIdSchema.optional(),\n  description: schemaFields.teamPermissionDescriptionSchema.optional(),\n  contained_permission_ids: schemaFields.containedPermissionIdsSchema.optional(),\n}).defined();\n\nexport const projectPermissionDefinitionsCrudAdminDeleteSchema = yupMixed();\n\nexport const projectPermissionDefinitionsCrud = createCrud({\n  adminReadSchema: projectPermissionDefinitionsCrudAdminReadSchema,\n  adminCreateSchema: projectPermissionDefinitionsCrudAdminCreateSchema,\n  adminUpdateSchema: projectPermissionDefinitionsCrudAdminUpdateSchema,\n  adminDeleteSchema: projectPermissionDefinitionsCrudAdminDeleteSchema,\n  docs: {\n    adminList: {\n      summary: \"List project permission definitions\",\n      description: \"Query and filter project permission definitions (the equivalent of listing permissions on the Stack dashboard)\",\n      tags: [\"Permissions\"],\n    },\n    adminCreate: {\n      summary: \"Create a new project permission definition\",\n      description: \"Create a new project permission definition (the equivalent of creating a new permission on the Stack dashboard)\",\n      tags: [\"Permissions\"],\n    },\n    adminUpdate: {\n      summary: \"Update a project permission definition\",\n      description: \"Update a project permission definition (the equivalent of updating a permission on the Stack dashboard)\",\n      tags: [\"Permissions\"],\n    },\n    adminDelete: {\n      summary: \"Delete a project permission definition\",\n      description: \"Delete a project permission definition (the equivalent of deleting a permission on the Stack dashboard)\",\n      tags: [\"Permissions\"],\n    },\n  },\n});\n\nexport type ProjectPermissionDefinitionsCrud = CrudTypeOf<typeof projectPermissionDefinitionsCrud>;\n"],"mappings":";;;;;AAOA,MAAa,yCAAyC,UAAU;CAC9D,IAAI,aAAa,6BAA6B,SAAS;CACvD,SAAS,aAAa,aAAa,SAAS;CAC7C,CAAC,CAAC,SAAS;AAEZ,MAAa,2CAA2C,UAAU,EACjE,CAAC,CAAC,SAAS;AAEZ,MAAa,2CAA2C,UAAU;AAElE,MAAa,yBAAyB,WAAW;CAC/C,kBAAkB;CAClB,oBAAoB;CACpB,oBAAoB;CACpB,MAAM;EACJ,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,YAAY;GACV,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,cAAc;GACZ,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACF;CACF,CAAC;AAGF,MAAa,uCAAuC;CAClD,MAAM;CACN,QAAQ,uBAAuB,OAAO;CACtC,UAAU;EACR,SAAS;EACT,aAAa;EACb,MAAM,CAAC,QAAQ;EAChB;CACF;AAED,MAAa,uCAAuC;CAClD,MAAM;CACN,QAAQ,uBAAuB,OAAO;CACtC,UAAU;EACR,SAAS;EACT,aAAa;EACb,MAAM,CAAC,QAAQ;EAChB;CACF;AAID,MAAa,kDAAkD,UAAU;CACvE,IAAI,aAAa,6BAA6B,SAAS;CACvD,aAAa,aAAa,gCAAgC,UAAU;CACpE,0BAA0B,aAAa,6BAA6B,SAAS;CAC9E,CAAC,CAAC,SAAS;AAEZ,MAAa,oDAAoD,UAAU;CACzE,IAAI,aAAa,mCAAmC,SAAS;CAC7D,aAAa,aAAa,gCAAgC,UAAU;CACpE,0BAA0B,aAAa,6BAA6B,UAAU;CAC/E,CAAC,CAAC,SAAS;AAEZ,MAAa,oDAAoD,UAAU;CACzE,IAAI,aAAa,mCAAmC,UAAU;CAC9D,aAAa,aAAa,gCAAgC,UAAU;CACpE,0BAA0B,aAAa,6BAA6B,UAAU;CAC/E,CAAC,CAAC,SAAS;AAEZ,MAAa,oDAAoD,UAAU;AAE3E,MAAa,mCAAmC,WAAW;CACzD,iBAAiB;CACjB,mBAAmB;CACnB,mBAAmB;CACnB,mBAAmB;CACnB,MAAM;EACJ,WAAW;GACT,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,aAAa;GACX,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,aAAa;GACX,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACD,aAAa;GACX,SAAS;GACT,aAAa;GACb,MAAM,CAAC,cAAc;GACtB;EACF;CACF,CAAC"}