@tolinax/ayoune-interfaces 2026.31.1 → 2026.32.1

package/data/modelsAndRights.d.ts

@@ -15,6 +15,27 @@ interface IModelAction {
     dangerous?: boolean;
     confirmation?: string;
 }
+/**
+ * Operations exposable to the Custom Functions `ay.db.*` sandbox SDK.
+ *
+ * Used in `IModelAndRight.sdkOperations` to narrow what customer-written
+ * code can do against a given entity. If omitted on an entry that has
+ * `availableInSDK: true`, the default follows the global `readOnly` flag:
+ *
+ *   - `readOnly: true`  → ["find", "findOne", "aggregate", "count"]
+ *   - `readOnly: false` → all six operations
+ */
+export type SDKOperation = "find" | "findOne" | "insert" | "update" | "aggregate" | "count";
+/**
+ * GDPR classification for a model — drives audit verbosity in
+ * custom-functions-worker, warnings in the user-functions-editor, and
+ * filtering in admin-v2's rights manager.
+ *
+ *   - `none` — reference data, no personal information (Countries, Taxes)
+ *   - `low`  — business data with tenant scope (Orders, Invoices, Products)
+ *   - `high` — consumer PII, user data, payment, auth (Consumers, Credentials)
+ */
+export type PIILevel = "none" | "low" | "high";
 export interface IModelAndRight {
     plural: string;
     singular: string;
@@ -28,6 +49,12 @@ export interface IModelAndRight {
     actions?: IModelAction[];
     searchable?: boolean;
     searchableFields?: string[];
+    labelKey?: string;
+    labelPluralKey?: string;
+    descriptionKey?: string;
+    piiLevel?: PIILevel;
+    availableInSDK?: boolean;
+    sdkOperations?: SDKOperation[];
 }
 declare const modelsAndRights: IModelAndRight[];
 export default modelsAndRights;

package/data/modelsAndRights.js

@@ -1271,6 +1271,12 @@ const modelsAndRights = [
         importable: true,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Consumer.label",
+        labelPluralKey: "model.Consumer.labelPlural",
+        descriptionKey: "model.Consumer.description",
+        piiLevel: "high",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['firstname', 'lastname', 'email', 'phone', 'company'],
         actions: [
@@ -1307,6 +1313,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Event.label",
+        labelPluralKey: "model.Event.labelPlural",
+        descriptionKey: "model.Event.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "Hooks",
@@ -1397,6 +1409,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.Product.label",
+        labelPluralKey: "model.Product.labelPlural",
+        descriptionKey: "model.Product.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'sku', 'ean', 'description'],
     },
@@ -1409,6 +1427,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.Project.label",
+        labelPluralKey: "model.Project.labelPlural",
+        descriptionKey: "model.Project.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['subject', 'description'],
         actions: [
@@ -1436,6 +1460,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Setting.label",
+        labelPluralKey: "model.Setting.labelPlural",
+        descriptionKey: "model.Setting.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "Sprints",
@@ -2200,6 +2230,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Company.label",
+        labelPluralKey: "model.Company.labelPlural",
+        descriptionKey: "model.Company.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'email', 'phone', 'domain'],
     },
@@ -2372,6 +2408,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.ContactPerson.label",
+        labelPluralKey: "model.ContactPerson.labelPlural",
+        descriptionKey: "model.ContactPerson.description",
+        piiLevel: "high",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "ContentCategories",
@@ -2382,6 +2424,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.ContentCategory.label",
+        labelPluralKey: "model.ContentCategory.labelPlural",
+        descriptionKey: "model.ContentCategory.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "ContentProjects",
@@ -2414,6 +2462,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Contract.label",
+        labelPluralKey: "model.Contract.labelPlural",
+        descriptionKey: "model.Contract.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'contractNumber'],
     },
@@ -2558,6 +2612,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Assignment.label",
+        labelPluralKey: "model.Assignment.labelPlural",
+        descriptionKey: "model.Assignment.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "CreditNotes",
@@ -3688,6 +3748,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Industry.label",
+        labelPluralKey: "model.Industry.labelPlural",
+        descriptionKey: "model.Industry.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "InputFeeds",
@@ -3828,6 +3894,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Invoice.label",
+        labelPluralKey: "model.Invoice.labelPlural",
+        descriptionKey: "model.Invoice.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['invoiceNumber', 'subject', 'recipientName'],
         actions: [
@@ -4035,6 +4107,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Lead.label",
+        labelPluralKey: "model.Lead.labelPlural",
+        descriptionKey: "model.Lead.description",
+        piiLevel: "high",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "LinkPortalClicks",
@@ -4375,6 +4453,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.Meeting.label",
+        labelPluralKey: "model.Meeting.labelPlural",
+        descriptionKey: "model.Meeting.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "MeetingGroups",
@@ -4575,6 +4659,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Notification.label",
+        labelPluralKey: "model.Notification.labelPlural",
+        descriptionKey: "model.Notification.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "NotificationPolicies",
@@ -4625,6 +4715,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Offer.label",
+        labelPluralKey: "model.Offer.labelPlural",
+        descriptionKey: "model.Offer.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "OMReports",
@@ -4645,6 +4741,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Opportunity.label",
+        labelPluralKey: "model.Opportunity.labelPlural",
+        descriptionKey: "model.Opportunity.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'description'],
         actions: [
@@ -4942,6 +5044,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.PriceGroup.label",
+        labelPluralKey: "model.PriceGroup.labelPlural",
+        descriptionKey: "model.PriceGroup.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "PriceRules",
@@ -4952,6 +5060,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.PriceRule.label",
+        labelPluralKey: "model.PriceRule.labelPlural",
+        descriptionKey: "model.PriceRule.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "PricingTables",
@@ -5370,6 +5484,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.Quote.label",
+        labelPluralKey: "model.Quote.labelPlural",
+        descriptionKey: "model.Quote.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
     },
     {
         plural: "Ratings",
@@ -6002,6 +6122,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Stock.label",
+        labelPluralKey: "model.Stock.labelPlural",
+        descriptionKey: "model.Stock.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "StorageAreas",
@@ -6012,6 +6138,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.StorageArea.label",
+        labelPluralKey: "model.StorageArea.labelPlural",
+        descriptionKey: "model.StorageArea.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'shortID']
     },
@@ -6193,6 +6325,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Task.label",
+        labelPluralKey: "model.Task.labelPlural",
+        descriptionKey: "model.Task.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['subject', 'description'],
         actions: [
@@ -6250,6 +6388,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: false,
         updateBy: "_id",
+        labelKey: "model.Ticket.label",
+        labelPluralKey: "model.Ticket.labelPlural",
+        descriptionKey: "model.Ticket.description",
+        piiLevel: "low",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "insert", "update", "aggregate", "count"],
         searchable: true,
         searchableFields: ['subject', 'ticketNumber'],
     },
@@ -6482,6 +6626,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.Warehouse.label",
+        labelPluralKey: "model.Warehouse.labelPlural",
+        descriptionKey: "model.Warehouse.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
     },
     {
         plural: "Watchers",
@@ -6646,6 +6796,12 @@ const modelsAndRights = [
         importable: false,
         allowDuplicate: true,
         updateBy: "_id",
+        labelKey: "model.WorkCenter.label",
+        labelPluralKey: "model.WorkCenter.labelPlural",
+        descriptionKey: "model.WorkCenter.description",
+        piiLevel: "none",
+        availableInSDK: true,
+        sdkOperations: ["find", "findOne", "aggregate", "count"],
         searchable: true,
         searchableFields: ['name', 'shortID'],
         actions: [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tolinax/ayoune-interfaces",
-  "version": "2026.31.1",
+  "version": "2026.32.1",
   "description": "Houses TypeScript interfaces for aYOUne",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",