@mondaydotcomorg/monday-authorization 3.6.0-feat-shaime-support-entity-attributes-1-f58d933 → 3.6.0-feat-shaime-support-entity-attributes-3-0d092e0

package/src/resource-attributes-constants.ts

@@ -21,6 +21,7 @@ export enum ResourceType {
   Overview = 'overview',
   Document = 'document',
   Crm = 'crm',
+  Feature = 'feature',
 }
 
 // Define the array of strings and use 'as const' to make its contents literal types

package/src/types/authorization-attributes-contracts.ts

@@ -1,4 +1,3 @@
-import { Resource } from './general';
 import type { EntityType } from '../entity-attributes-constants';
 import type { ResourceType } from '../resource-attributes-constants';
 
@@ -12,6 +11,7 @@ export interface ResourceAttributeAssignment extends AttributeAssignment {
   resourceId: number;
   resourceType: ResourceType;
 }
+export type ResourceAttributeDeleteAssignment = Omit<ResourceAttributeAssignment, 'value'>;
 
 // Entity Attribute Assignment - matching API contract
 // Note: For validation, use the EntityAttributeAssignment class from '../entity-attribute-assignment'
@@ -19,34 +19,12 @@ export interface EntityAttributeAssignment extends AttributeAssignment {
   entityId: number;
   entityType: EntityType;
 }
-
-// Legacy types for backward compatibility
-export interface ResourceAttributeDelete {
-  resourceType: Resource['type'];
-  resourceId: Resource['id'];
-  key: string;
-}
-
-export interface EntityAttributeDelete {
-  entityType: EntityType;
-  entityId: number;
-  key: string;
-}
+export type EntityAttributeDeleteAssignment = Omit<EntityAttributeAssignment, 'value'>;
 
 export enum AttributeOperation {
   UPSERT = 'upsert',
   DELETE = 'delete',
 }
-
-// Response types
-export interface ResourceAttributeResponse {
-  attributes: ResourceAttributeAssignment[];
-}
-
-export interface EntityAttributeResponse {
-  attributes: EntityAttributeAssignment[];
-}
-
 export interface ResourceAttributeUpsertOperation extends ResourceAttributeAssignment {
   operationType: AttributeOperation;
 }

package/src/types/authorization-attributes-service.interface.ts

@@ -7,69 +7,57 @@ import {
 } from './authorization-attributes-contracts';
 import { Resource } from './general';
 
-/**
- * Resource type compatible with both MS and SNS services
- */
-export interface CompatibleResource {
-  resourceType?: string;
-  resourceId?: number;
-  type?: string;
-  id?: number;
-}
-
 /**
  * Interface for authorization attributes operations.
  * Both MS (direct) and SNS (async) services implement this interface.
  */
 export interface AuthorizationAttributesService {
   /**
-   * Deletes resource attributes.
-   * For MS service: returns Promise<void>
-   * For SNS service: requires appName and callerActionIdentifier, returns Promise<ResourceAttributesOperation[]>
+   * Deletes a resource attribute.
+   * Returns Promise<ResourceAttributeDeleteOperation>
    */
   deleteResourceAttributes(
     accountId: number,
-    resource: CompatibleResource | Resource,
-    attributeKeys: string[],
+    resource: Resource,
+    attributeKey: string,
     appName?: string,
     callerActionIdentifier?: string
-  ): Promise<void | ResourceAttributeDeleteOperation[]>;
+  ): Promise<ResourceAttributeDeleteOperation>;
 
   /**
-   * Deletes entity attributes.
-   * For MS service: returns Promise<void>
-   * For SNS service: requires appName and callerActionIdentifier, returns Promise<EntityAttributesOperation[]>
+   * Deletes an entity attribute.
+   * Returns Promise<EntityAttributeDeleteOperation>
    */
   deleteEntityAttributes(
     accountId: number,
     entityType: EntityType | string,
     entityId: number,
-    attributeKeys: string[],
+    attributeKey: string,
     appName?: string,
     callerActionIdentifier?: string
-  ): Promise<void | EntityAttributeDeleteOperation[]>;
+  ): Promise<EntityAttributeDeleteOperation>;
 
   /**
-   * Updates resource attributes (batch operations).
-   * For MS service: may throw error or delegate to upsert/delete
-   * For SNS service: returns Promise<ResourceAttributesOperation[]>
+   * Updates a resource attribute (single operation - upsert only).
+   * For MS service: performs upsert operation
+   * For SNS service: returns Promise<ResourceAttributeUpsertOperation>
    */
   updateResourceAttributes(
     accountId: number,
     appName: string,
     callerActionIdentifier: string,
-    resourceAttributeOperations: ResourceAttributeUpsertOperation[]
-  ): Promise<ResourceAttributeUpsertOperation[]>;
+    resourceAttributeOperation: ResourceAttributeUpsertOperation
+  ): Promise<ResourceAttributeUpsertOperation>;
 
   /**
-   * Updates entity attributes (batch operations).
-   * For MS service: may throw error or delegate to upsert/delete
-   * For SNS service: returns Promise<EntityAttributesOperation[]>
+   * Updates an entity attribute (single operation - upsert only).
+   * For MS service: performs upsert operation
+   * For SNS service: returns Promise<EntityAttributeUpsertOperation>
    */
   updateEntityAttributes(
     accountId: number,
     appName: string,
     callerActionIdentifier: string,
-    entityAttributeOperations: EntityAttributeUpsertOperation[]
-  ): Promise<EntityAttributeUpsertOperation[]>;
+    entityAttributeOperation: EntityAttributeUpsertOperation
+  ): Promise<EntityAttributeUpsertOperation>;
 }

package/src/types/general.ts

@@ -1,8 +1,9 @@
 import type { Request, Response } from 'express';
+import type { ResourceType } from '../resource-attributes-constants';
 
 export interface Resource {
-  id?: number;
-  type: string;
+  id: number;
+  type: ResourceType;
   wrapperData?: object;
 }
 export type Action = string;
@@ -12,7 +13,7 @@ export interface Context {
 }
 export interface AuthorizationObject {
   resource_id?: Resource['id'];
-  resource_type: Resource['type'];
+  resource_type: string;
   wrapper_data?: Resource['wrapperData'];
   action: Action;
 }

package/src/utils/assignment-schema.ts

@@ -0,0 +1,51 @@
+import Ajv from 'ajv';
+import { EntityType } from '../entity-attributes-constants';
+import { ResourceType } from '../resource-attributes-constants';
+
+const ajv = new Ajv({ allErrors: true });
+
+export const entityUpsertAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    entityId: { type: 'number', multipleOf: 1 },
+    entityType: { type: 'string', enum: Object.values(EntityType) },
+    key: { type: 'string', minLength: 1 },
+    value: { type: 'string', minLength: 1 },
+  },
+  required: ['entityId', 'entityType', 'key', 'value'],
+  additionalProperties: false,
+});
+
+export const entityDeleteAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    entityId: { type: 'number', multipleOf: 1 },
+    entityType: { type: 'string', enum: Object.values(EntityType) },
+    key: { type: 'string', minLength: 1 },
+  },
+  required: ['entityId', 'entityType', 'key'],
+  additionalProperties: false,
+});
+
+export const resourceDeleteAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    resourceId: { type: 'number', multipleOf: 1 },
+    resourceType: { type: 'string', enum: Object.values(ResourceType) },
+    key: { type: 'string', minLength: 1 },
+  },
+  required: ['id', 'type', 'key'],
+  additionalProperties: false,
+});
+
+export const resourceUpsertAssignmentSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    resourceId: { type: 'number', multipleOf: 1 },
+    resourceType: { type: 'string', enum: Object.values(ResourceType) },
+    key: { type: 'string', minLength: 1 },
+    value: { type: 'string', minLength: 1 },
+  },
+  required: ['resourceId', 'resourceType', 'key', 'value'],
+  additionalProperties: false,
+});

package/src/utils/resource-schema.ts

@@ -0,0 +1,16 @@
+import Ajv from 'ajv';
+import { RESOURCE_TYPES } from '../resource-attributes-constants';
+
+const ajv = new Ajv({ allErrors: true });
+
+export const resourceSchema = ajv.compile({
+  type: 'object',
+  properties: {
+    id: { type: 'number', multipleOf: 1 },
+    type: { type: 'string', enum: RESOURCE_TYPES },
+    wrapperData: { type: 'object' },
+  },
+
+  required: ['id', 'type'],
+  additionalProperties: false,
+});

package/src/utils/validation.ts

@@ -1,7 +1,19 @@
-import Ajv, { ValidateFunction } from 'ajv';
+import Ajv, { ValidateFunction, ErrorObject } from 'ajv';
 import { ArgumentError } from '../errors/argument-error';
-import { ResourceAttributeAssignment, EntityAttributeAssignment } from '../types/authorization-attributes-contracts';
-import { entityAssignmentSchema, resourceAssignmentSchema } from './assigment-schema';
+import {
+  ResourceAttributeAssignment,
+  EntityAttributeAssignment,
+  ResourceAttributeDeleteAssignment,
+  EntityAttributeDeleteAssignment,
+} from '../types/authorization-attributes-contracts';
+import { Resource } from '../types/general';
+import {
+  entityUpsertAssignmentSchema,
+  resourceUpsertAssignmentSchema,
+  entityDeleteAssignmentSchema,
+  resourceDeleteAssignmentSchema,
+} from './assignment-schema';
+import { resourceSchema } from './resource-schema';
 
 /**
  * Utility class for common validation operations using AJV
@@ -37,27 +49,76 @@ export class ValidationUtils {
     }
   }
 
+  public static validateResource(resource: Resource) {
+    const isValid = resourceSchema(resource);
+    if (!isValid) {
+      const errorMessage = this.formatValidationErrors(resourceSchema.errors);
+      throw new ArgumentError(errorMessage ? `Invalid resource: ${errorMessage}` : 'Invalid resource');
+    }
+  }
+
   /**
    * Validates an attribute assignment object using a single AJV schema.
    * Preserves legacy error messages for each field.
    */
-  static validateResourceAssignment(resource: ResourceAttributeAssignment): void {
-    const valid = resourceAssignmentSchema(resource);
+  static validatUpsertResourceAssignment(resource: ResourceAttributeAssignment): void {
+    const valid = resourceUpsertAssignmentSchema(resource);
+    if (!valid) {
+      const errorMessage = this.formatValidationErrors(resourceUpsertAssignmentSchema.errors);
+      throw new ArgumentError(
+        errorMessage
+          ? `Invalid resource attribute assignment: ${errorMessage}`
+          : 'Invalid resource attribute assignment'
+      );
+    }
+  }
+
+  static validatDeleteResourceAssignment(resource: ResourceAttributeDeleteAssignment): void {
+    const valid = resourceDeleteAssignmentSchema(resource);
+    if (!valid) {
+      const errorMessage = this.formatValidationErrors(resourceUpsertAssignmentSchema.errors);
+      throw new ArgumentError(
+        errorMessage
+          ? `Invalid resource attribute assignment: ${errorMessage}`
+          : 'Invalid resource attribute assignment'
+      );
+    }
+  }
+
+  static validatUpsertEntityAssignment(entity: EntityAttributeAssignment): void {
+    const valid = entityUpsertAssignmentSchema(entity);
     if (!valid) {
-      const errorMessages = (resourceAssignmentSchema.errors || [])
-        .map(err => err.message || 'validation failed')
-        .join(', ');
-      throw new ArgumentError(`Invalid resource attribute assignment: ${errorMessages}`);
+      const errorMessage = this.formatValidationErrors(entityUpsertAssignmentSchema.errors);
+      throw new ArgumentError(
+        errorMessage ? `Invalid entity attribute assignment: ${errorMessage}` : 'Invalid entity attribute assignment'
+      );
     }
   }
 
-  static validateEntityAssignment(entity: EntityAttributeAssignment): void {
-    const valid = entityAssignmentSchema(entity);
+  static validatDeleteEntityAssignment(entity: EntityAttributeDeleteAssignment): void {
+    const valid = entityDeleteAssignmentSchema(entity);
     if (!valid) {
-      const errorMessages = (entityAssignmentSchema.errors || [])
-        .map(err => err.message || 'validation failed')
-        .join(', ');
-      throw new ArgumentError(`Invalid entity attribute assignment: ${errorMessages}`);
+      const errorMessage = this.formatValidationErrors(entityDeleteAssignmentSchema.errors);
+      throw new ArgumentError(
+        errorMessage ? `Invalid entity attribute assignment: ${errorMessage}` : 'Invalid entity attribute assignment'
+      );
+    }
+  }
+  /**
+   * Formats AJV validation errors into a readable error message
+   */
+  private static formatValidationErrors(errors: ErrorObject[] | null | undefined): string {
+    if (!errors || errors.length === 0) {
+      return '';
     }
+
+    return errors
+      .map(err => {
+        const path =
+          err.instancePath || (err.params && 'missingProperty' in err.params ? `/${err.params.missingProperty}` : '');
+        const message = err.message || 'validation failed';
+        return path ? `${path}: ${message}` : message;
+      })
+      .join('; ');
   }
 }

package/dist/esm/utils/assigment-schema.d.ts

@@ -1,29 +0,0 @@
-export declare const entityAssignmentSchema: import("ajv").ValidateFunction<{
-    entityId: any;
-    entityType: any;
-    attributeKey: any;
-    attributeValue: any;
-} & {
-    entityId: any;
-} & {
-    entityType: any;
-} & {
-    attributeKey: any;
-} & {
-    attributeValue: any;
-}>;
-export declare const resourceAssignmentSchema: import("ajv").ValidateFunction<{
-    id: any;
-    type: any;
-    attributeKey: any;
-    attributeValue: any;
-} & {
-    id: any;
-} & {
-    type: any;
-} & {
-    attributeKey: any;
-} & {
-    attributeValue: any;
-}>;
-//# sourceMappingURL=assigment-schema.d.ts.map

package/dist/esm/utils/assigment-schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assigment-schema.d.ts","sourceRoot":"","sources":["../../../src/utils/assigment-schema.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;EAUjC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;EAUnC,CAAC"}

package/dist/esm/utils/assigment-schema.mjs

@@ -1,29 +0,0 @@
-import Ajv from 'ajv';
-import { EntityType } from '../entity-attributes-constants.mjs';
-import { ResourceType } from '../resource-attributes-constants.mjs';
-
-const ajv = new Ajv({ allErrors: true });
-const entityAssignmentSchema = ajv.compile({
-    type: 'object',
-    properties: {
-        entityId: { type: 'number', multipleOf: 1 },
-        entityType: { type: 'string', enum: Object.values(EntityType) },
-        key: { type: 'string', minLength: 1 },
-        value: { type: 'string', minLength: 1 },
-    },
-    required: ['entityId', 'entityType', 'attributeKey', 'attributeValue'],
-    additionalProperties: false,
-});
-const resourceAssignmentSchema = ajv.compile({
-    type: 'object',
-    properties: {
-        id: { type: 'number', multipleOf: 1 },
-        type: { type: 'string', enum: Object.values(ResourceType) },
-        key: { type: 'string', minLength: 1 },
-        value: { type: 'string', minLength: 1 },
-    },
-    required: ['id', 'type', 'attributeKey', 'attributeValue'],
-    additionalProperties: false,
-});
-
-export { entityAssignmentSchema, resourceAssignmentSchema };

package/dist/utils/assigment-schema.d.ts

@@ -1,29 +0,0 @@
-export declare const entityAssignmentSchema: import("ajv").ValidateFunction<{
-    entityId: any;
-    entityType: any;
-    attributeKey: any;
-    attributeValue: any;
-} & {
-    entityId: any;
-} & {
-    entityType: any;
-} & {
-    attributeKey: any;
-} & {
-    attributeValue: any;
-}>;
-export declare const resourceAssignmentSchema: import("ajv").ValidateFunction<{
-    id: any;
-    type: any;
-    attributeKey: any;
-    attributeValue: any;
-} & {
-    id: any;
-} & {
-    type: any;
-} & {
-    attributeKey: any;
-} & {
-    attributeValue: any;
-}>;
-//# sourceMappingURL=assigment-schema.d.ts.map

package/dist/utils/assigment-schema.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"assigment-schema.d.ts","sourceRoot":"","sources":["../../src/utils/assigment-schema.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;EAUjC,CAAC;AAEH,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;EAUnC,CAAC"}

package/dist/utils/assigment-schema.js

@@ -1,36 +0,0 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-
-const Ajv = require('ajv');
-const entityAttributesConstants = require('../entity-attributes-constants.js');
-const resourceAttributesConstants = require('../resource-attributes-constants.js');
-
-const _interopDefault = e => e && e.__esModule ? e : { default: e };
-
-const Ajv__default = /*#__PURE__*/_interopDefault(Ajv);
-
-const ajv = new Ajv__default.default({ allErrors: true });
-const entityAssignmentSchema = ajv.compile({
-    type: 'object',
-    properties: {
-        entityId: { type: 'number', multipleOf: 1 },
-        entityType: { type: 'string', enum: Object.values(entityAttributesConstants.EntityType) },
-        key: { type: 'string', minLength: 1 },
-        value: { type: 'string', minLength: 1 },
-    },
-    required: ['entityId', 'entityType', 'attributeKey', 'attributeValue'],
-    additionalProperties: false,
-});
-const resourceAssignmentSchema = ajv.compile({
-    type: 'object',
-    properties: {
-        id: { type: 'number', multipleOf: 1 },
-        type: { type: 'string', enum: Object.values(resourceAttributesConstants.ResourceType) },
-        key: { type: 'string', minLength: 1 },
-        value: { type: 'string', minLength: 1 },
-    },
-    required: ['id', 'type', 'attributeKey', 'attributeValue'],
-    additionalProperties: false,
-});
-
-exports.entityAssignmentSchema = entityAssignmentSchema;
-exports.resourceAssignmentSchema = resourceAssignmentSchema;

package/src/utils/assigment-schema.ts

@@ -1,29 +0,0 @@
-import Ajv from 'ajv';
-import { EntityType } from '../entity-attributes-constants';
-import { ResourceType } from '../resource-attributes-constants';
-
-const ajv = new Ajv({ allErrors: true });
-
-export const entityAssignmentSchema = ajv.compile({
-  type: 'object',
-  properties: {
-    entityId: { type: 'number', multipleOf: 1 },
-    entityType: { type: 'string', enum: Object.values(EntityType) },
-    key: { type: 'string', minLength: 1 },
-    value: { type: 'string', minLength: 1 },
-  },
-  required: ['entityId', 'entityType', 'attributeKey', 'attributeValue'],
-  additionalProperties: false,
-});
-
-export const resourceAssignmentSchema = ajv.compile({
-  type: 'object',
-  properties: {
-    id: { type: 'number', multipleOf: 1 },
-    type: { type: 'string', enum: Object.values(ResourceType) },
-    key: { type: 'string', minLength: 1 },
-    value: { type: 'string', minLength: 1 },
-  },
-  required: ['id', 'type', 'attributeKey', 'attributeValue'],
-  additionalProperties: false,
-});