@tmlmobilidade/go-types-permissions 20260828.1636.54

package/dist/scopes/users/actions.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+/* * */
+const UsersPermissionActionsValues = [
+    'create',
+    'delete',
+    'read',
+    'lock',
+    'update',
+];
+export const UsersPermissionActionsSchema = z.enum(UsersPermissionActionsValues);

package/dist/scopes/users/permission.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const UsersPermissionSchema: z.ZodObject<{
+    action: z.ZodEnum<["create", "delete", "read", "lock", "update"]>;
+    scope: z.ZodLiteral<"users">;
+}, "strip", z.ZodTypeAny, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "users";
+}, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "users";
+}>;
+export type UsersPermission = z.infer<typeof UsersPermissionSchema>;

package/dist/scopes/users/permission.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+import { UsersPermissionActionsSchema } from './actions.js';
+import { UsersPermissionScopeSchema } from './scope.js';
+/* * */
+export const UsersPermissionSchema = z.object({
+    action: UsersPermissionActionsSchema,
+    scope: UsersPermissionScopeSchema,
+});

package/dist/scopes/users/registry.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const UsersPermissionRegistrySchema: z.ZodObject<{
+    actions: z.ZodArray<z.ZodEnum<["create", "delete", "read", "lock", "update"]>, "many">;
+    scope: z.ZodLiteral<"users">;
+}, "strip", z.ZodTypeAny, {
+    scope: "users";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}, {
+    scope: "users";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}>;
+export type UsersPermissionRegistry = z.infer<typeof UsersPermissionRegistrySchema>;

package/dist/scopes/users/registry.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+import { UsersPermissionActionsSchema } from './actions.js';
+import { UsersPermissionScopeSchema } from './scope.js';
+/* * */
+export const UsersPermissionRegistrySchema = z.object({
+    actions: z.array(UsersPermissionActionsSchema),
+    scope: UsersPermissionScopeSchema,
+});

package/dist/scopes/users/scope.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const UsersPermissionScopeSchema: z.ZodLiteral<"users">;
+export type UsersPermissionScope = z.infer<typeof UsersPermissionScopeSchema>;

package/dist/scopes/users/scope.js

@@ -0,0 +1,4 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const UsersPermissionScopeSchema = z.literal('users');

package/dist/scopes/vehicles/actions.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const VehiclesPermissionActionsSchema: z.ZodEnum<["create", "delete", "read", "lock", "update"]>;
+export type VehiclesPermissionActions = z.infer<typeof VehiclesPermissionActionsSchema>;

package/dist/scopes/vehicles/actions.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+/* * */
+const VehiclesPermissionActionsValues = [
+    'create',
+    'delete',
+    'read',
+    'lock',
+    'update',
+];
+export const VehiclesPermissionActionsSchema = z.enum(VehiclesPermissionActionsValues);

package/dist/scopes/vehicles/permission.d.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+export declare const VehiclesPermissionSchema: z.ZodObject<{
+    action: z.ZodEnum<["create", "delete", "read", "lock", "update"]>;
+    resources: z.ZodDefault<z.ZodObject<{
+        agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        agency_ids: string[];
+    }, {
+        agency_ids?: string[] | undefined;
+    }>>;
+    scope: z.ZodLiteral<"vehicles">;
+}, "strip", z.ZodTypeAny, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "vehicles";
+    resources: {
+        agency_ids: string[];
+    };
+}, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "vehicles";
+    resources?: {
+        agency_ids?: string[] | undefined;
+    } | undefined;
+}>;
+export type VehiclesPermission = z.infer<typeof VehiclesPermissionSchema>;

package/dist/scopes/vehicles/permission.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+import { VehiclesPermissionActionsSchema } from './actions.js';
+import { VehiclesPermissionResourcesSchema } from './resources.js';
+import { VehiclesPermissionScopeSchema } from './scope.js';
+/* * */
+export const VehiclesPermissionSchema = z.object({
+    action: VehiclesPermissionActionsSchema,
+    resources: VehiclesPermissionResourcesSchema.default({}),
+    scope: VehiclesPermissionScopeSchema,
+});

package/dist/scopes/vehicles/registry.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const VehiclesPermissionRegistrySchema: z.ZodObject<{
+    actions: z.ZodArray<z.ZodEnum<["create", "delete", "read", "lock", "update"]>, "many">;
+    scope: z.ZodLiteral<"vehicles">;
+}, "strip", z.ZodTypeAny, {
+    scope: "vehicles";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}, {
+    scope: "vehicles";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}>;
+export type VehiclesPermissionRegistry = z.infer<typeof VehiclesPermissionRegistrySchema>;

package/dist/scopes/vehicles/registry.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+import { VehiclesPermissionActionsSchema } from './actions.js';
+import { VehiclesPermissionScopeSchema } from './scope.js';
+/* * */
+export const VehiclesPermissionRegistrySchema = z.object({
+    actions: z.array(VehiclesPermissionActionsSchema),
+    scope: VehiclesPermissionScopeSchema,
+});

package/dist/scopes/vehicles/resources.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const VehiclesPermissionResourcesSchema: z.ZodObject<{
+    agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    agency_ids: string[];
+}, {
+    agency_ids?: string[] | undefined;
+}>;
+export type VehiclesPermissionResources = z.infer<typeof VehiclesPermissionResourcesSchema>;

package/dist/scopes/vehicles/resources.js

@@ -0,0 +1,6 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const VehiclesPermissionResourcesSchema = z.object({
+    agency_ids: z.array(z.string()).default([]),
+});

package/dist/scopes/vehicles/scope.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const VehiclesPermissionScopeSchema: z.ZodLiteral<"vehicles">;
+export type VehiclesPermissionScope = z.infer<typeof VehiclesPermissionScopeSchema>;

package/dist/scopes/vehicles/scope.js

@@ -0,0 +1,4 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const VehiclesPermissionScopeSchema = z.literal('vehicles');

package/dist/scopes/year-periods/actions.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const YearPeriodsPermissionActionsSchema: z.ZodEnum<["create", "delete", "read", "lock", "update"]>;
+export type YearPeriodsPermissionActions = z.infer<typeof YearPeriodsPermissionActionsSchema>;

package/dist/scopes/year-periods/actions.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+/* * */
+const YearPeriodsPermissionActionsValues = [
+    'create',
+    'delete',
+    'read',
+    'lock',
+    'update',
+];
+export const YearPeriodsPermissionActionsSchema = z.enum(YearPeriodsPermissionActionsValues);

package/dist/scopes/year-periods/permission.d.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+export declare const YearPeriodsPermissionSchema: z.ZodObject<{
+    action: z.ZodEnum<["create", "delete", "read", "lock", "update"]>;
+    resources: z.ZodDefault<z.ZodObject<{
+        agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        agency_ids: string[];
+    }, {
+        agency_ids?: string[] | undefined;
+    }>>;
+    scope: z.ZodLiteral<"year_periods">;
+}, "strip", z.ZodTypeAny, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "year_periods";
+    resources: {
+        agency_ids: string[];
+    };
+}, {
+    action: "create" | "delete" | "read" | "lock" | "update";
+    scope: "year_periods";
+    resources?: {
+        agency_ids?: string[] | undefined;
+    } | undefined;
+}>;
+export type YearPeriodsPermission = z.infer<typeof YearPeriodsPermissionSchema>;

package/dist/scopes/year-periods/permission.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+import { YearPeriodsPermissionActionsSchema } from './actions.js';
+import { YearPeriodsPermissionResourcesSchema } from './resources.js';
+import { YearPeriodsPermissionScopeSchema } from './scope.js';
+/* * */
+export const YearPeriodsPermissionSchema = z.object({
+    action: YearPeriodsPermissionActionsSchema,
+    resources: YearPeriodsPermissionResourcesSchema.default({}),
+    scope: YearPeriodsPermissionScopeSchema,
+});

package/dist/scopes/year-periods/registry.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const YearPeriodsPermissionRegistrySchema: z.ZodObject<{
+    actions: z.ZodArray<z.ZodEnum<["create", "delete", "read", "lock", "update"]>, "many">;
+    scope: z.ZodLiteral<"year_periods">;
+}, "strip", z.ZodTypeAny, {
+    scope: "year_periods";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}, {
+    scope: "year_periods";
+    actions: ("create" | "delete" | "read" | "lock" | "update")[];
+}>;
+export type YearPeriodsPermissionRegistry = z.infer<typeof YearPeriodsPermissionRegistrySchema>;

package/dist/scopes/year-periods/registry.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+import { YearPeriodsPermissionActionsSchema } from './actions.js';
+import { YearPeriodsPermissionScopeSchema } from './scope.js';
+/* * */
+export const YearPeriodsPermissionRegistrySchema = z.object({
+    actions: z.array(YearPeriodsPermissionActionsSchema),
+    scope: YearPeriodsPermissionScopeSchema,
+});

package/dist/scopes/year-periods/resources.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const YearPeriodsPermissionResourcesSchema: z.ZodObject<{
+    agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    agency_ids: string[];
+}, {
+    agency_ids?: string[] | undefined;
+}>;
+export type YearPeriodsPermissionResources = z.infer<typeof YearPeriodsPermissionResourcesSchema>;

package/dist/scopes/year-periods/resources.js

@@ -0,0 +1,6 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const YearPeriodsPermissionResourcesSchema = z.object({
+    agency_ids: z.array(z.string()).default([]),
+});

package/dist/scopes/year-periods/scope.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const YearPeriodsPermissionScopeSchema: z.ZodLiteral<"year_periods">;
+export type YearPeriodsPermissionScope = z.infer<typeof YearPeriodsPermissionScopeSchema>;

package/dist/scopes/year-periods/scope.js

@@ -0,0 +1,4 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const YearPeriodsPermissionScopeSchema = z.literal('year_periods');

package/dist/scopes/zones/actions.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const ZonesPermissionActionsSchema: z.ZodEnum<["create", "delete", "lock", "nav", "update"]>;
+export type ZonesPermissionActions = z.infer<typeof ZonesPermissionActionsSchema>;

package/dist/scopes/zones/actions.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+/* * */
+const ZonesPermissionActionsValues = [
+    'create',
+    'delete',
+    'lock',
+    'nav',
+    'update',
+];
+export const ZonesPermissionActionsSchema = z.enum(ZonesPermissionActionsValues);

package/dist/scopes/zones/permission.d.ts

@@ -0,0 +1,25 @@
+import { z } from 'zod';
+export declare const ZonesPermissionSchema: z.ZodObject<{
+    action: z.ZodEnum<["create", "delete", "lock", "nav", "update"]>;
+    resources: z.ZodDefault<z.ZodObject<{
+        agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        agency_ids: string[];
+    }, {
+        agency_ids?: string[] | undefined;
+    }>>;
+    scope: z.ZodLiteral<"zones">;
+}, "strip", z.ZodTypeAny, {
+    action: "create" | "delete" | "lock" | "update" | "nav";
+    scope: "zones";
+    resources: {
+        agency_ids: string[];
+    };
+}, {
+    action: "create" | "delete" | "lock" | "update" | "nav";
+    scope: "zones";
+    resources?: {
+        agency_ids?: string[] | undefined;
+    } | undefined;
+}>;
+export type ZonesPermission = z.infer<typeof ZonesPermissionSchema>;

package/dist/scopes/zones/permission.js

@@ -0,0 +1,11 @@
+/* * */
+import { z } from 'zod';
+import { ZonesPermissionActionsSchema } from './actions.js';
+import { ZonesPermissionResourcesSchema } from './resources.js';
+import { ZonesPermissionScopeSchema } from './scope.js';
+/* * */
+export const ZonesPermissionSchema = z.object({
+    action: ZonesPermissionActionsSchema,
+    resources: ZonesPermissionResourcesSchema.default({}),
+    scope: ZonesPermissionScopeSchema,
+});

package/dist/scopes/zones/registry.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const ZonesPermissionRegistrySchema: z.ZodObject<{
+    actions: z.ZodArray<z.ZodEnum<["create", "delete", "lock", "nav", "update"]>, "many">;
+    scope: z.ZodLiteral<"zones">;
+}, "strip", z.ZodTypeAny, {
+    scope: "zones";
+    actions: ("create" | "delete" | "lock" | "update" | "nav")[];
+}, {
+    scope: "zones";
+    actions: ("create" | "delete" | "lock" | "update" | "nav")[];
+}>;
+export type ZonesPermissionRegistry = z.infer<typeof ZonesPermissionRegistrySchema>;

package/dist/scopes/zones/registry.js

@@ -0,0 +1,9 @@
+/* * */
+import { z } from 'zod';
+import { ZonesPermissionActionsSchema } from './actions.js';
+import { ZonesPermissionScopeSchema } from './scope.js';
+/* * */
+export const ZonesPermissionRegistrySchema = z.object({
+    actions: z.array(ZonesPermissionActionsSchema),
+    scope: ZonesPermissionScopeSchema,
+});

package/dist/scopes/zones/resources.d.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod';
+export declare const ZonesPermissionResourcesSchema: z.ZodObject<{
+    agency_ids: z.ZodDefault<z.ZodArray<z.ZodString, "many">>;
+}, "strip", z.ZodTypeAny, {
+    agency_ids: string[];
+}, {
+    agency_ids?: string[] | undefined;
+}>;
+export type ZonesPermissionResources = z.infer<typeof ZonesPermissionResourcesSchema>;

package/dist/scopes/zones/resources.js

@@ -0,0 +1,6 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const ZonesPermissionResourcesSchema = z.object({
+    agency_ids: z.array(z.string()).default([]),
+});

package/dist/scopes/zones/scope.d.ts

@@ -0,0 +1,3 @@
+import { z } from 'zod';
+export declare const ZonesPermissionScopeSchema: z.ZodLiteral<"zones">;
+export type ZonesPermissionScope = z.infer<typeof ZonesPermissionScopeSchema>;

package/dist/scopes/zones/scope.js

@@ -0,0 +1,4 @@
+/* * */
+import { z } from 'zod';
+/* * */
+export const ZonesPermissionScopeSchema = z.literal('zones');

package/dist/utils/has-permission-resource.d.ts

@@ -0,0 +1,29 @@
+import { PermissionsResources } from '../resources-registy.js';
+import { type Permission } from '../permissions.js';
+interface HasPermissionResourceRequirements {
+    /**
+     * The required permission to check.
+     */
+    requiredPermission: Omit<Permission, 'resources'>;
+    /**
+     * The required value to check.
+     */
+    requiredValue: string;
+    /**
+     * The key of the resource.
+     */
+    resourceKey: keyof PermissionsResources;
+}
+/**
+ * Check if a permission exists in a list of permissions, with additional check for a given resource value.
+ * If a `value` exists in a `resource` of a User `permissions` object that
+ * matches the given `action` and `scope`. For example, if you want to check if
+ * a user has access to a specific `agency_id`, you set `value=43` and `resource_key='agency_ids'`.
+ * If the provided `permissions` object contains the value `43` inside the `scope='plans'`,
+ * `action='create'` and `resource_key='agency_ids'` the function will return true.
+ * @param userPermissions The list of permissions (from a user or request).
+ * @param requirements The requirements to check for.
+ * @returns True if the permission is found, false otherwise.
+ */
+export declare function hasPermissionResource(userPermissions: Permission[], { requiredPermission, requiredValue, resourceKey }: HasPermissionResourceRequirements): boolean;
+export {};

package/dist/utils/has-permission-resource.js

@@ -0,0 +1,41 @@
+/* * */
+import { AllowAllFlagValue } from '../allow-all.js';
+/**
+ * Check if a permission exists in a list of permissions, with additional check for a given resource value.
+ * If a `value` exists in a `resource` of a User `permissions` object that
+ * matches the given `action` and `scope`. For example, if you want to check if
+ * a user has access to a specific `agency_id`, you set `value=43` and `resource_key='agency_ids'`.
+ * If the provided `permissions` object contains the value `43` inside the `scope='plans'`,
+ * `action='create'` and `resource_key='agency_ids'` the function will return true.
+ * @param userPermissions The list of permissions (from a user or request).
+ * @param requirements The requirements to check for.
+ * @returns True if the permission is found, false otherwise.
+ */
+export function hasPermissionResource(userPermissions, { requiredPermission, requiredValue, resourceKey }) {
+    //
+    //
+    // Return false if no permissions
+    if (!userPermissions?.length)
+        return false;
+    if (!resourceKey || !requiredValue)
+        return false;
+    //
+    // Find the permission with the given action and scope
+    const foundUserPermission = userPermissions.find(p => p.action === requiredPermission.action && p.scope === requiredPermission.scope);
+    if (!foundUserPermission)
+        return false;
+    //
+    // Exit if the found user permission does not have the resources property
+    // or if the resources property is empty
+    if (!('resources' in foundUserPermission))
+        return false;
+    const resourceValues = foundUserPermission.resources[resourceKey];
+    if (!resourceValues?.length)
+        return false;
+    //
+    // Check if the found user permission can access all values
+    // or has the required value
+    if (resourceValues.includes(AllowAllFlagValue))
+        return true;
+    return resourceValues.includes(requiredValue);
+}

package/dist/utils/has-permission.d.ts

@@ -0,0 +1,8 @@
+import { type Permission } from '../permissions.js';
+/**
+ * Check if a list of permission entries has the requested scope/action pair.
+ * @param userPermissions The list of permission entries to check against.
+ * @param requiredPermission The required permission to check.
+ * @returns True if the permission is found, false otherwise.
+ */
+export declare function hasPermission(userPermissions: Permission[], requiredPermission: Omit<Permission, 'resources'>): boolean;

package/dist/utils/has-permission.js

@@ -0,0 +1,20 @@
+/* * */
+/**
+ * Check if a list of permission entries has the requested scope/action pair.
+ * @param userPermissions The list of permission entries to check against.
+ * @param requiredPermission The required permission to check.
+ * @returns True if the permission is found, false otherwise.
+ */
+export function hasPermission(userPermissions, requiredPermission) {
+    //
+    //
+    // Return false if no permissions
+    if (!userPermissions)
+        return false;
+    //
+    // Find the permission with the given action and scope
+    const foundPermission = userPermissions.find(p => p.action === requiredPermission.action && p.scope === requiredPermission.scope);
+    if (!foundPermission)
+        return false;
+    return true;
+}

package/dist/utils/index.d.ts

@@ -0,0 +1,2 @@
+export * from './has-permission-resource.js';
+export * from './has-permission.js';

package/dist/utils/index.js

@@ -0,0 +1,2 @@
+export * from './has-permission-resource.js';
+export * from './has-permission.js';

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "@tmlmobilidade/go-types-permissions",
+	"version": "20260828.1636.54",
+	"author": {
+		"email": "iso@tmlmobilidade.pt",
+		"name": "TML-ISO"
+	},
+	"license": "AGPL-3.0-or-later",
+	"homepage": "https://go.tmlmobilidade.pt",
+	"bugs": {
+		"url": "https://github.com/tmlmobilidade/go/issues"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/tmlmobilidade/go.git"
+	},
+	"keywords": [
+		"public transit",
+		"tml",
+		"transportes metropolitanos de lisboa",
+		"go"
+	],
+	"publishConfig": {
+		"access": "public"
+	},
+	"type": "module",
+	"files": [
+		"dist"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"scripts": {
+		"build": "tsc && resolve-tspaths",
+		"lint": "eslint ./src/ && tsc --noEmit",
+		"lint:fix": "eslint ./src/ --fix",
+		"watch": "tsc-watch --onSuccess 'resolve-tspaths'"
+	},
+	"dependencies": {
+		"zod": "3.25.76"
+	},
+	"devDependencies": {
+		"@tmlmobilidade/go-utils-tsconfig": "*",
+		"@types/node": "26.1.2",
+		"resolve-tspaths": "0.8.23",
+		"tsc-watch": "7.2.1",
+		"typescript": "6.0.3"
+	}
+}