@openinc/parse-server-opendash 3.19.1 → 3.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/dist/featuremap.json +1 -0
  2. package/dist/features/config/helper/isFeatureEnabled.d.ts +2 -1
  3. package/dist/features/documentation/config/defaults.d.ts +39 -0
  4. package/dist/features/documentation/config/defaults.js +142 -0
  5. package/dist/features/documentation/config/index.d.ts +1 -0
  6. package/dist/features/documentation/config/index.js +17 -0
  7. package/dist/features/documentation/core/Cleanup.d.ts +30 -0
  8. package/dist/features/documentation/core/Cleanup.js +134 -0
  9. package/dist/features/documentation/core/Converter.d.ts +9 -0
  10. package/dist/features/documentation/core/Converter.js +65 -0
  11. package/dist/features/documentation/core/Importer.d.ts +21 -0
  12. package/dist/features/documentation/core/Importer.js +133 -0
  13. package/dist/features/documentation/core/Organizer.d.ts +11 -0
  14. package/dist/features/documentation/core/Organizer.js +52 -0
  15. package/dist/features/documentation/core/index.d.ts +4 -0
  16. package/dist/features/documentation/core/index.js +20 -0
  17. package/dist/features/documentation/functions/importDocs.d.ts +2 -0
  18. package/dist/features/documentation/functions/importDocs.js +40 -0
  19. package/dist/features/documentation/index.d.ts +8 -0
  20. package/dist/features/documentation/index.js +34 -0
  21. package/dist/features/documentation/services/ConfigApplier.d.ts +11 -0
  22. package/dist/features/documentation/services/ConfigApplier.js +110 -0
  23. package/dist/features/documentation/services/ContentLoader.d.ts +6 -0
  24. package/dist/features/documentation/services/ContentLoader.js +40 -0
  25. package/dist/features/documentation/services/FeatureFilter.d.ts +34 -0
  26. package/dist/features/documentation/services/FeatureFilter.js +154 -0
  27. package/dist/features/documentation/services/GitHubClient.d.ts +43 -0
  28. package/dist/features/documentation/services/GitHubClient.js +140 -0
  29. package/dist/features/documentation/services/MetadataEnricher.d.ts +5 -0
  30. package/dist/features/documentation/services/MetadataEnricher.js +29 -0
  31. package/dist/features/documentation/services/StructureBuilder.d.ts +7 -0
  32. package/dist/features/documentation/services/StructureBuilder.js +43 -0
  33. package/dist/features/documentation/services/TreeNormalizer.d.ts +10 -0
  34. package/dist/features/documentation/services/TreeNormalizer.js +73 -0
  35. package/dist/features/documentation/services/index.d.ts +7 -0
  36. package/dist/features/documentation/services/index.js +23 -0
  37. package/dist/features/documentation/types/GitHubTypes.d.ts +25 -0
  38. package/dist/features/documentation/types/GitHubTypes.js +2 -0
  39. package/dist/features/documentation/types/StructureTypes.d.ts +114 -0
  40. package/dist/features/documentation/types/StructureTypes.js +2 -0
  41. package/dist/features/documentation/types/index.d.ts +2 -0
  42. package/dist/features/documentation/types/index.js +18 -0
  43. package/dist/features/permissions/types/Permissions.d.ts +2 -0
  44. package/dist/features/permissions/types/Permissions.js +2 -0
  45. package/dist/functions/openinc-documentation-import-docs.d.ts +1 -0
  46. package/dist/functions/openinc-documentation-import-docs.js +23 -0
  47. package/dist/hooks/Documentation_Config.d.ts +1 -0
  48. package/dist/hooks/Documentation_Config.js +17 -0
  49. package/dist/index.js +3 -0
  50. package/dist/types/Documentation_Category.d.ts +6 -0
  51. package/dist/types/Documentation_Category.js +12 -0
  52. package/dist/types/Documentation_Config.d.ts +21 -0
  53. package/dist/types/Documentation_Config.js +29 -0
  54. package/dist/types/Documentation_Document.d.ts +6 -0
  55. package/dist/types/Documentation_Document.js +12 -0
  56. package/dist/types/index.d.ts +2 -0
  57. package/dist/types/index.js +5 -3
  58. package/package.json +3 -1
  59. package/schema/Documentation_Category.json +9 -0
  60. package/schema/Documentation_Config.json +50 -0
  61. package/schema/Documentation_Document.json +9 -0
@@ -0,0 +1,21 @@
1
+ import type { _User } from "./_User";
2
+ import { Tenant } from "./Tenant";
3
+ export interface Documentation_ConfigAttributes {
4
+ id: string;
5
+ objectId: string;
6
+ createdAt: Date;
7
+ updatedAt: Date;
8
+ lastCommitSha?: string;
9
+ tenant?: Tenant;
10
+ user?: _User;
11
+ }
12
+ export declare class Documentation_Config extends Parse.Object<Documentation_ConfigAttributes> {
13
+ static className: string;
14
+ constructor(data?: Partial<Documentation_ConfigAttributes>);
15
+ get lastCommitSha(): string | undefined;
16
+ set lastCommitSha(value: string | undefined);
17
+ get tenant(): Tenant | undefined;
18
+ set tenant(value: Tenant | undefined);
19
+ get user(): _User | undefined;
20
+ set user(value: _User | undefined);
21
+ }
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.Documentation_Config = void 0;
4
+ class Documentation_Config extends Parse.Object {
5
+ constructor(data) {
6
+ super("OD3_Documentation_Config", data);
7
+ }
8
+ get lastCommitSha() {
9
+ return super.get("lastCommitSha");
10
+ }
11
+ set lastCommitSha(value) {
12
+ super.set("lastCommitSha", value);
13
+ }
14
+ get tenant() {
15
+ return super.get("tenant");
16
+ }
17
+ set tenant(value) {
18
+ super.set("tenant", value);
19
+ }
20
+ get user() {
21
+ return super.get("user");
22
+ }
23
+ set user(value) {
24
+ super.set("user", value);
25
+ }
26
+ }
27
+ exports.Documentation_Config = Documentation_Config;
28
+ Documentation_Config.className = "OD3_Documentation_Config";
29
+ Parse.Object.registerSubclass("OD3_Documentation_Config", Documentation_Config);
@@ -8,7 +8,9 @@ export interface Documentation_DocumentAttributes {
8
8
  updatedAt: Date;
9
9
  category: Documentation_Category;
10
10
  content: string;
11
+ gitPath?: string;
11
12
  icon?: string;
13
+ isDefault: boolean;
12
14
  locationPattern?: string;
13
15
  locations: any[];
14
16
  order: number;
@@ -23,8 +25,12 @@ export declare class Documentation_Document extends Parse.Object<Documentation_D
23
25
  set category(value: Documentation_Category);
24
26
  get content(): string;
25
27
  set content(value: string);
28
+ get gitPath(): string | undefined;
29
+ set gitPath(value: string | undefined);
26
30
  get icon(): string | undefined;
27
31
  set icon(value: string | undefined);
32
+ get isDefault(): boolean;
33
+ set isDefault(value: boolean);
28
34
  get locationPattern(): string | undefined;
29
35
  set locationPattern(value: string | undefined);
30
36
  get locations(): any[];
@@ -17,12 +17,24 @@ class Documentation_Document extends Parse.Object {
17
17
  set content(value) {
18
18
  super.set("content", value);
19
19
  }
20
+ get gitPath() {
21
+ return super.get("gitPath");
22
+ }
23
+ set gitPath(value) {
24
+ super.set("gitPath", value);
25
+ }
20
26
  get icon() {
21
27
  return super.get("icon");
22
28
  }
23
29
  set icon(value) {
24
30
  super.set("icon", value);
25
31
  }
32
+ get isDefault() {
33
+ return super.get("isDefault");
34
+ }
35
+ set isDefault(value) {
36
+ super.set("isDefault", value);
37
+ }
26
38
  get locationPattern() {
27
39
  return super.get("locationPattern");
28
40
  }
@@ -36,6 +36,8 @@ export { Documentation_Category } from "./Documentation_Category";
36
36
  export type { Documentation_CategoryAttributes } from "./Documentation_Category";
37
37
  export { Documentation_Document } from "./Documentation_Document";
38
38
  export type { Documentation_DocumentAttributes } from "./Documentation_Document";
39
+ export { Documentation_Config } from "./Documentation_Config";
40
+ export type { Documentation_ConfigAttributes } from "./Documentation_Config";
39
41
  export { GTFS_Agency } from "./GTFS_Agency";
40
42
  export type { GTFS_AgencyAttributes } from "./GTFS_Agency";
41
43
  export { GTFS_Bikes_Allowed } from "./GTFS_Bikes_Allowed";
@@ -1,8 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.Maintenance_Frequency = exports.Maintenance_Duedate = exports.Maintenance_Downtime = exports.MailTemplate = exports.ML_DataSelection = exports.MIAAS_MDSEndpoint = exports.MES_OrderPlan = exports.MES_Order = exports.MES_Article = exports.Log = exports.Language = exports.Knowledge_Video = exports.Knowledge_DocumentPage = exports.Knowledge_Document = exports.Knowledge_ChatMessage = exports.Knowledge_Chat = exports.Knowledge_Category = exports.Knowledge_Article = exports.GTFS_Wheelchair_Boarding = exports.GTFS_Wheelchair_Accessible = exports.GTFS_Trip = exports.GTFS_Stop_Times = exports.GTFS_Stop = exports.GTFS_Route_Type = exports.GTFS_Route = exports.GTFS_Location_Type = exports.GTFS_Level = exports.GTFS_Direction = exports.GTFS_Calendar = exports.GTFS_Bikes_Allowed = exports.GTFS_Agency = exports.Documentation_Document = exports.Documentation_Category = exports.Dashboard = exports.Core_Token = exports.Core_Email = exports.Contact = exports.Config = exports.Company = exports.BDE_Unit = exports.BDE_Result = exports.BDE_Page = exports.BDE_ListEntry = exports.BDE_List = exports.BDE_Form = exports.Attachment = exports.Assets = exports.AlarmWebhook = exports.AlarmAction = exports.Alarm = void 0;
4
- exports.WebPush = exports.VirtualKPI = exports.User_Setting = exports.UserData = exports.TenantTrustedDomain = exports.TenantMeta = exports.Tenant = exports.SourceMeta = exports.Source = exports.Share = exports.Report = exports.Push = exports.Permission = exports.OWPlcItem = exports.OWPlcDevice = exports.Notification_Setting = exports.Notification = exports.NavigationItem = exports.NavigationGroup = exports.Monitoring_Slideshow = exports.Monitoring_ReportImage = exports.Monitoring_ParseTableSensor = exports.Monitoring_Jobs = exports.Monitoring_DataHierachies = exports.Maintenance_Ticket_Title = exports.Maintenance_Ticket_Source = exports.Maintenance_Ticket_QR_Code = exports.Maintenance_Ticket_Project = exports.Maintenance_Ticket_Material = exports.Maintenance_Ticket_Kanban_State_Current = exports.Maintenance_Ticket_Kanban_State = exports.Maintenance_Ticket_Issuecategory = exports.Maintenance_Ticket_FormConfig = exports.Maintenance_Ticket_Assignment = exports.Maintenance_Ticket = exports.Maintenance_Source_File = exports.Maintenance_Schedule_Template = exports.Maintenance_Schedule_Step = exports.Maintenance_Schedule_Execution_Step = exports.Maintenance_Schedule_Execution = exports.Maintenance_Schedule = exports.Maintenance_Restriction = exports.Maintenance_Project = exports.Maintenance_Priority = exports.Maintenance_Order = exports.Maintenance_Message = exports.Maintenance_Media = exports.Maintenance_Kanban_State = exports.Maintenance_Item = exports.Maintenance_Issuecategory = void 0;
5
- exports.WidgetPreset = exports.Widget = void 0;
3
+ exports.Maintenance_Duedate = exports.Maintenance_Downtime = exports.MailTemplate = exports.ML_DataSelection = exports.MIAAS_MDSEndpoint = exports.MES_OrderPlan = exports.MES_Order = exports.MES_Article = exports.Log = exports.Language = exports.Knowledge_Video = exports.Knowledge_DocumentPage = exports.Knowledge_Document = exports.Knowledge_ChatMessage = exports.Knowledge_Chat = exports.Knowledge_Category = exports.Knowledge_Article = exports.GTFS_Wheelchair_Boarding = exports.GTFS_Wheelchair_Accessible = exports.GTFS_Trip = exports.GTFS_Stop_Times = exports.GTFS_Stop = exports.GTFS_Route_Type = exports.GTFS_Route = exports.GTFS_Location_Type = exports.GTFS_Level = exports.GTFS_Direction = exports.GTFS_Calendar = exports.GTFS_Bikes_Allowed = exports.GTFS_Agency = exports.Documentation_Config = exports.Documentation_Document = exports.Documentation_Category = exports.Dashboard = exports.Core_Token = exports.Core_Email = exports.Contact = exports.Config = exports.Company = exports.BDE_Unit = exports.BDE_Result = exports.BDE_Page = exports.BDE_ListEntry = exports.BDE_List = exports.BDE_Form = exports.Attachment = exports.Assets = exports.AlarmWebhook = exports.AlarmAction = exports.Alarm = void 0;
4
+ exports.VirtualKPI = exports.User_Setting = exports.UserData = exports.TenantTrustedDomain = exports.TenantMeta = exports.Tenant = exports.SourceMeta = exports.Source = exports.Share = exports.Report = exports.Push = exports.Permission = exports.OWPlcItem = exports.OWPlcDevice = exports.Notification_Setting = exports.Notification = exports.NavigationItem = exports.NavigationGroup = exports.Monitoring_Slideshow = exports.Monitoring_ReportImage = exports.Monitoring_ParseTableSensor = exports.Monitoring_Jobs = exports.Monitoring_DataHierachies = exports.Maintenance_Ticket_Title = exports.Maintenance_Ticket_Source = exports.Maintenance_Ticket_QR_Code = exports.Maintenance_Ticket_Project = exports.Maintenance_Ticket_Material = exports.Maintenance_Ticket_Kanban_State_Current = exports.Maintenance_Ticket_Kanban_State = exports.Maintenance_Ticket_Issuecategory = exports.Maintenance_Ticket_FormConfig = exports.Maintenance_Ticket_Assignment = exports.Maintenance_Ticket = exports.Maintenance_Source_File = exports.Maintenance_Schedule_Template = exports.Maintenance_Schedule_Step = exports.Maintenance_Schedule_Execution_Step = exports.Maintenance_Schedule_Execution = exports.Maintenance_Schedule = exports.Maintenance_Restriction = exports.Maintenance_Project = exports.Maintenance_Priority = exports.Maintenance_Order = exports.Maintenance_Message = exports.Maintenance_Media = exports.Maintenance_Kanban_State = exports.Maintenance_Item = exports.Maintenance_Issuecategory = exports.Maintenance_Frequency = void 0;
5
+ exports.WidgetPreset = exports.Widget = exports.WebPush = void 0;
6
6
  var Alarm_1 = require("./Alarm");
7
7
  Object.defineProperty(exports, "Alarm", { enumerable: true, get: function () { return Alarm_1.Alarm; } });
8
8
  var AlarmAction_1 = require("./AlarmAction");
@@ -41,6 +41,8 @@ var Documentation_Category_1 = require("./Documentation_Category");
41
41
  Object.defineProperty(exports, "Documentation_Category", { enumerable: true, get: function () { return Documentation_Category_1.Documentation_Category; } });
42
42
  var Documentation_Document_1 = require("./Documentation_Document");
43
43
  Object.defineProperty(exports, "Documentation_Document", { enumerable: true, get: function () { return Documentation_Document_1.Documentation_Document; } });
44
+ var Documentation_Config_1 = require("./Documentation_Config");
45
+ Object.defineProperty(exports, "Documentation_Config", { enumerable: true, get: function () { return Documentation_Config_1.Documentation_Config; } });
44
46
  var GTFS_Agency_1 = require("./GTFS_Agency");
45
47
  Object.defineProperty(exports, "GTFS_Agency", { enumerable: true, get: function () { return GTFS_Agency_1.GTFS_Agency; } });
46
48
  var GTFS_Bikes_Allowed_1 = require("./GTFS_Bikes_Allowed");
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openinc/parse-server-opendash",
3
- "version": "3.19.1",
3
+ "version": "3.20.0",
4
4
  "description": "Parse Server Cloud Code for open.INC Stack.",
5
5
  "packageManager": "pnpm@10.15.0",
6
6
  "keywords": [
@@ -56,6 +56,7 @@
56
56
  "devstart": "parse-server ./config.js",
57
57
  "featuremap": "node ./scripts/create-featuremap.js",
58
58
  "hooks": "node ./scripts/create-hooks.js",
59
+ "docs:fetch": "ts-node ./src/features/documentation/functions/importDocs.ts",
59
60
  "rebuild:docker": "cd ./docker-dev && powershell -NoProfile -ExecutionPolicy Bypass -File rebuild_and_restart.ps1"
60
61
  },
61
62
  "dependencies": {
@@ -99,6 +100,7 @@
99
100
  "@types/safe-timers": "^1.1.2",
100
101
  "@types/web-push": "^3.6.4",
101
102
  "semantic-release-export-data": "^1.1.1",
103
+ "ts-node": "^10.9.2",
102
104
  "typedoc": "^0.28.12",
103
105
  "typedoc-plugin-markdown": "^4.8.1",
104
106
  "typescript": "^5.9.2"
@@ -1,9 +1,18 @@
1
1
  {
2
2
  "fields": {
3
+ "gitPath": {
4
+ "type": "String",
5
+ "required": false
6
+ },
3
7
  "icon": {
4
8
  "type": "String",
5
9
  "required": false
6
10
  },
11
+ "isDefault": {
12
+ "type": "Boolean",
13
+ "required": false,
14
+ "defaultValue": false
15
+ },
7
16
  "name": {
8
17
  "type": "String",
9
18
  "required": true,
@@ -0,0 +1,50 @@
1
+ {
2
+ "fields": {
3
+ "lastCommitSha": {
4
+ "type": "String",
5
+ "required": false
6
+ },
7
+ "tenant": {
8
+ "type": "Pointer",
9
+ "targetClass": "{{PREFIX}}Tenant",
10
+ "required": false
11
+ },
12
+ "user": {
13
+ "type": "Pointer",
14
+ "targetClass": "_User",
15
+ "required": false
16
+ }
17
+ },
18
+ "classLevelPermissions": {
19
+ "find": {
20
+ "*": true
21
+ },
22
+ "count": {
23
+ "*": true
24
+ },
25
+ "get": {
26
+ "*": true
27
+ },
28
+ "create": {
29
+ "*": true
30
+ },
31
+ "update": {
32
+ "*": true
33
+ },
34
+ "delete": {
35
+ "*": true
36
+ },
37
+ "addField": {
38
+ "*": true
39
+ },
40
+ "protectedFields": {
41
+ "*": []
42
+ },
43
+ "ACL": {
44
+ "*": {
45
+ "read": true,
46
+ "write": true
47
+ }
48
+ }
49
+ }
50
+ }
@@ -9,10 +9,19 @@
9
9
  "type": "String",
10
10
  "required": true
11
11
  },
12
+ "gitPath": {
13
+ "type": "String",
14
+ "required": false
15
+ },
12
16
  "icon": {
13
17
  "type": "String",
14
18
  "required": false
15
19
  },
20
+ "isDefault": {
21
+ "type": "Boolean",
22
+ "required": false,
23
+ "defaultValue": false
24
+ },
16
25
  "locationPattern": {
17
26
  "type": "String",
18
27
  "required": false